Add sending the password by Talk for a link share to ShareAPIController

Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
2026-05-28 04:32:30 -04:00 · 2018-10-15 12:27:56 +02:00 · 2018-10-15 12:27:56 +02:00 · adf80aa8b3
commit adf80aa8b3
parent fe8a67f517
2 changed files with 324 additions and 0 deletions
--- a/apps/files_sharing/lib/Controller/ShareAPIController.php
+++ b/apps/files_sharing/lib/Controller/ShareAPIController.php
@ -212,6 +212,8 @@ class ShareAPIController extends OCSController {
 			$result['share_with'] = $share->getPassword();
 			$result['share_with_displayname'] = $share->getPassword();

+			$result['send_password_by_talk'] = $share->getSendPasswordByTalk();
+
 			$result['token'] = $share->getToken();
 			$result['url'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare', ['token' => $share->getToken()]);

@ -477,10 +479,19 @@ class ShareAPIController extends OCSController {
 				$share->setPassword($password);
 			}

+
 			if (!empty($label)) {
 				$share->setLabel($label);
 			}

+			if ($sendPasswordByTalk === 'true') {
+				if (!$this->appManager->isEnabledForUser('spreed')) {
+					throw new OCSForbiddenException($this->l->t('Sharing %s sending the password by Nextcloud Talk failed because Nextcloud Talk is not enabled', [$path->getPath()]));
+				}
+
+				$share->setSendPasswordByTalk(true);
+			}
+
 			//Expire date
 			if ($expireDate !== '') {
 				try {
@ -873,6 +884,15 @@ class ShareAPIController extends OCSController {
 				$share->setLabel($label);
 			}

+			if ($sendPasswordByTalk === 'true') {
+				if (!$this->appManager->isEnabledForUser('spreed')) {
+					throw new OCSForbiddenException($this->l->t('Sharing sending the password by Nextcloud Talk failed because Nextcloud Talk is not enabled'));
+				}
+
+				$share->setSendPasswordByTalk(true);
+			} else if ($sendPasswordByTalk !== null) {
+				$share->setSendPasswordByTalk(false);
+			}
 		} else {
 			if ($permissions !== null) {
 				$permissions = (int)$permissions;
--- a/apps/files_sharing/tests/Controller/ShareAPIControllerTest.php
+++ b/apps/files_sharing/tests/Controller/ShareAPIControllerTest.php
@ -430,6 +430,7 @@ class ShareAPIControllerTest extends TestCase {
 			'share_type' => \OCP\Share::SHARE_TYPE_LINK,
 			'share_with' => 'password',
 			'share_with_displayname' => 'password',
+			'send_password_by_talk' => false,
 			'uid_owner' => 'initiatorId',
 			'displayname_owner' => 'initiatorDisplay',
 			'item_type' => 'folder',
@ -1135,6 +1136,71 @@ class ShareAPIControllerTest extends TestCase {
 		$this->assertEquals($expected->getData(), $result->getData());
 	}

+	public function testCreateShareLinkSendPasswordByTalk() {
+		$ocs = $this->mockFormatShare();
+
+		$path = $this->getMockBuilder(Folder::class)->getMock();
+		$storage = $this->getMockBuilder(Storage::class)->getMock();
+		$storage->method('instanceOfStorage')
+			->with('OCA\Files_Sharing\External\Storage')
+			->willReturn(false);
+		$path->method('getStorage')->willReturn($storage);
+		$this->rootFolder->method('getUserFolder')->with($this->currentUser)->will($this->returnSelf());
+		$this->rootFolder->method('get')->with('valid-path')->willReturn($path);
+
+		$this->shareManager->method('newShare')->willReturn(\OC::$server->getShareManager()->newShare());
+		$this->shareManager->method('shareApiAllowLinks')->willReturn(true);
+		$this->shareManager->method('shareApiLinkAllowPublicUpload')->willReturn(true);
+
+		$this->appManager->method('isEnabledForUser')->with('spreed')->willReturn(true);
+
+		$this->shareManager->expects($this->once())->method('createShare')->with(
+			$this->callback(function (\OCP\Share\IShare $share) use ($path) {
+				return $share->getNode() === $path &&
+				$share->getShareType() === \OCP\Share::SHARE_TYPE_LINK &&
+				$share->getPermissions() === \OCP\Constants::PERMISSION_READ &&
+				$share->getSharedBy() === 'currentUser' &&
+				$share->getPassword() === 'password' &&
+				$share->getSendPasswordByTalk() === true &&
+				$share->getExpirationDate() === null;
+			})
+		)->will($this->returnArgument(0));
+
+		$expected = new DataResponse([]);
+		$result = $ocs->createShare('valid-path', \OCP\Constants::PERMISSION_ALL, \OCP\Share::SHARE_TYPE_LINK, null, 'false', 'password', 'true', '');
+
+		$this->assertInstanceOf(get_class($expected), $result);
+		$this->assertEquals($expected->getData(), $result->getData());
+	}
+
+	/**
+	 * @expectedException \OCP\AppFramework\OCS\OCSForbiddenException
+	 * @expectedExceptionMessage Sharing valid-path sending the password by Nextcloud Talk failed because Nextcloud Talk is not enabled
+     */
+	public function testCreateShareLinkSendPasswordByTalkWithTalkDisabled() {
+		$ocs = $this->mockFormatShare();
+
+		$path = $this->getMockBuilder(Folder::class)->getMock();
+		$storage = $this->getMockBuilder(Storage::class)->getMock();
+		$storage->method('instanceOfStorage')
+			->with('OCA\Files_Sharing\External\Storage')
+			->willReturn(false);
+		$path->method('getStorage')->willReturn($storage);
+		$path->method('getPath')->willReturn('valid-path');
+		$this->rootFolder->method('getUserFolder')->with($this->currentUser)->will($this->returnSelf());
+		$this->rootFolder->method('get')->with('valid-path')->willReturn($path);
+
+		$this->shareManager->method('newShare')->willReturn(\OC::$server->getShareManager()->newShare());
+		$this->shareManager->method('shareApiAllowLinks')->willReturn(true);
+		$this->shareManager->method('shareApiLinkAllowPublicUpload')->willReturn(true);
+
+		$this->appManager->method('isEnabledForUser')->with('spreed')->willReturn(false);
+
+		$this->shareManager->expects($this->never())->method('createShare');
+
+		$ocs->createShare('valid-path', \OCP\Constants::PERMISSION_ALL, \OCP\Share::SHARE_TYPE_LINK, null, 'false', 'password', 'true', '');
+	}
+
 	public function testCreateShareValidExpireDate() {
 		$ocs = $this->mockFormatShare();

@ -1711,6 +1777,7 @@ class ShareAPIControllerTest extends TestCase {
 			->setSharedBy($this->currentUser)
 			->setShareType(\OCP\Share::SHARE_TYPE_LINK)
 			->setPassword('password')
+			->setSendPasswordByTalk(true)
 			->setExpirationDate($date)
 			->setNote('note')
 			->setLabel('label')
@ -1728,6 +1795,7 @@ class ShareAPIControllerTest extends TestCase {
 			$this->callback(function (\OCP\Share\IShare $share) use ($date) {
 				return $share->getPermissions() === \OCP\Constants::PERMISSION_ALL &&
 				$share->getPassword() === 'newpassword' &&
+				$share->getSendPasswordByTalk() === true &&
 				$share->getExpirationDate() === $date &&
 				$share->getNote() === 'note' &&
 				$share->getLabel() === 'label' &&
@ -1742,6 +1810,184 @@ class ShareAPIControllerTest extends TestCase {
 		$this->assertEquals($expected->getData(), $result->getData());
 	}

+	public function testUpdateLinkShareSendPasswordByTalkDoesNotChangeOther() {
+		$ocs = $this->mockFormatShare();
+
+		$date = new \DateTime('2000-01-01');
+		$date->setTime(0,0,0);
+
+		$node = $this->getMockBuilder(File::class)->getMock();
+		$share = $this->newShare();
+		$share->setPermissions(\OCP\Constants::PERMISSION_ALL)
+			->setSharedBy($this->currentUser)
+			->setShareType(\OCP\Share::SHARE_TYPE_LINK)
+			->setPassword('password')
+			->setSendPasswordByTalk(false)
+			->setExpirationDate($date)
+			->setNote('note')
+			->setLabel('label')
+			->setHideDownload(true)
+			->setPermissions(\OCP\Constants::PERMISSION_ALL)
+			->setNode($node);
+
+		$node->expects($this->once())
+			->method('lock')
+			->with(\OCP\Lock\ILockingProvider::LOCK_SHARED);
+
+		$this->shareManager->method('getShareById')->with('ocinternal:42')->willReturn($share);
+
+		$this->appManager->method('isEnabledForUser')->with('spreed')->willReturn(true);
+
+		$this->shareManager->expects($this->once())->method('updateShare')->with(
+			$this->callback(function (\OCP\Share\IShare $share) use ($date) {
+				return $share->getPermissions() === \OCP\Constants::PERMISSION_ALL &&
+				$share->getPassword() === 'password' &&
+				$share->getSendPasswordByTalk() === true &&
+				$share->getExpirationDate() === $date &&
+				$share->getNote() === 'note' &&
+				$share->getLabel() === 'label' &&
+				$share->getHideDownload() === true;
+			})
+		)->will($this->returnArgument(0));
+
+		$expected = new DataResponse([]);
+		$result = $ocs->updateShare(42, null, null, 'true', null, null, null, null, null);
+
+		$this->assertInstanceOf(get_class($expected), $result);
+		$this->assertEquals($expected->getData(), $result->getData());
+	}
+
+	/**
+	 * @expectedException \OCP\AppFramework\OCS\OCSForbiddenException
+	 * @expectedExceptionMessage Sharing sending the password by Nextcloud Talk failed because Nextcloud Talk is not enabled
+     */
+	public function testUpdateLinkShareSendPasswordByTalkWithTalkDisabledDoesNotChangeOther() {
+		$ocs = $this->mockFormatShare();
+
+		$date = new \DateTime('2000-01-01');
+		$date->setTime(0,0,0);
+
+		$node = $this->getMockBuilder(File::class)->getMock();
+		$share = $this->newShare();
+		$share->setPermissions(\OCP\Constants::PERMISSION_ALL)
+			->setSharedBy($this->currentUser)
+			->setShareType(\OCP\Share::SHARE_TYPE_LINK)
+			->setPassword('password')
+			->setSendPasswordByTalk(false)
+			->setExpirationDate($date)
+			->setNote('note')
+			->setLabel('label')
+			->setHideDownload(true)
+			->setPermissions(\OCP\Constants::PERMISSION_ALL)
+			->setNode($node);
+
+		$node->expects($this->once())
+			->method('lock')
+			->with(\OCP\Lock\ILockingProvider::LOCK_SHARED);
+
+		$this->shareManager->method('getShareById')->with('ocinternal:42')->willReturn($share);
+
+		$this->appManager->method('isEnabledForUser')->with('spreed')->willReturn(false);
+
+		$this->shareManager->expects($this->never())->method('updateShare');
+
+		$ocs->updateShare(42, null, null, 'true', null, null, null, null, null);
+	}
+
+	public function testUpdateLinkShareDoNotSendPasswordByTalkDoesNotChangeOther() {
+		$ocs = $this->mockFormatShare();
+
+		$date = new \DateTime('2000-01-01');
+		$date->setTime(0,0,0);
+
+		$node = $this->getMockBuilder(File::class)->getMock();
+		$share = $this->newShare();
+		$share->setPermissions(\OCP\Constants::PERMISSION_ALL)
+			->setSharedBy($this->currentUser)
+			->setShareType(\OCP\Share::SHARE_TYPE_LINK)
+			->setPassword('password')
+			->setSendPasswordByTalk(true)
+			->setExpirationDate($date)
+			->setNote('note')
+			->setLabel('label')
+			->setHideDownload(true)
+			->setPermissions(\OCP\Constants::PERMISSION_ALL)
+			->setNode($node);
+
+		$node->expects($this->once())
+			->method('lock')
+			->with(\OCP\Lock\ILockingProvider::LOCK_SHARED);
+
+		$this->shareManager->method('getShareById')->with('ocinternal:42')->willReturn($share);
+
+		$this->appManager->method('isEnabledForUser')->with('spreed')->willReturn(true);
+
+		$this->shareManager->expects($this->once())->method('updateShare')->with(
+			$this->callback(function (\OCP\Share\IShare $share) use ($date) {
+				return $share->getPermissions() === \OCP\Constants::PERMISSION_ALL &&
+				$share->getPassword() === 'password' &&
+				$share->getSendPasswordByTalk() === false &&
+				$share->getExpirationDate() === $date &&
+				$share->getNote() === 'note' &&
+				$share->getLabel() === 'label' &&
+				$share->getHideDownload() === true;
+			})
+		)->will($this->returnArgument(0));
+
+		$expected = new DataResponse([]);
+		$result = $ocs->updateShare(42, null, null, 'false', null, null, null, null, null);
+
+		$this->assertInstanceOf(get_class($expected), $result);
+		$this->assertEquals($expected->getData(), $result->getData());
+	}
+
+	public function testUpdateLinkShareDoNotSendPasswordByTalkWithTalkDisabledDoesNotChangeOther() {
+		$ocs = $this->mockFormatShare();
+
+		$date = new \DateTime('2000-01-01');
+		$date->setTime(0,0,0);
+
+		$node = $this->getMockBuilder(File::class)->getMock();
+		$share = $this->newShare();
+		$share->setPermissions(\OCP\Constants::PERMISSION_ALL)
+			->setSharedBy($this->currentUser)
+			->setShareType(\OCP\Share::SHARE_TYPE_LINK)
+			->setPassword('password')
+			->setSendPasswordByTalk(true)
+			->setExpirationDate($date)
+			->setNote('note')
+			->setLabel('label')
+			->setHideDownload(true)
+			->setPermissions(\OCP\Constants::PERMISSION_ALL)
+			->setNode($node);
+
+		$node->expects($this->once())
+			->method('lock')
+			->with(\OCP\Lock\ILockingProvider::LOCK_SHARED);
+
+		$this->shareManager->method('getShareById')->with('ocinternal:42')->willReturn($share);
+
+		$this->appManager->method('isEnabledForUser')->with('spreed')->willReturn(false);
+
+		$this->shareManager->expects($this->once())->method('updateShare')->with(
+			$this->callback(function (\OCP\Share\IShare $share) use ($date) {
+				return $share->getPermissions() === \OCP\Constants::PERMISSION_ALL &&
+				$share->getPassword() === 'password' &&
+				$share->getSendPasswordByTalk() === false &&
+				$share->getExpirationDate() === $date &&
+				$share->getNote() === 'note' &&
+				$share->getLabel() === 'label' &&
+				$share->getHideDownload() === true;
+			})
+		)->will($this->returnArgument(0));
+
+		$expected = new DataResponse([]);
+		$result = $ocs->updateShare(42, null, null, 'false', null, null, null, null, null);
+
+		$this->assertInstanceOf(get_class($expected), $result);
+		$this->assertEquals($expected->getData(), $result->getData());
+	}
+
 	public function testUpdateLinkShareExpireDateDoesNotChangeOther() {
 		$ocs = $this->mockFormatShare();

@ -1751,6 +1997,7 @@ class ShareAPIControllerTest extends TestCase {
 			->setSharedBy($this->currentUser)
 			->setShareType(\OCP\Share::SHARE_TYPE_LINK)
 			->setPassword('password')
+			->setSendPasswordByTalk(true)
 			->setExpirationDate(new \DateTime())
 			->setNote('note')
 			->setLabel('label')
@ -1771,6 +2018,7 @@ class ShareAPIControllerTest extends TestCase {

 				return $share->getPermissions() === \OCP\Constants::PERMISSION_ALL &&
 				$share->getPassword() === 'password' &&
+				$share->getSendPasswordByTalk() === true &&
 				$share->getExpirationDate() == $date &&
 				$share->getNote() === 'note' &&
 				$share->getLabel() === 'label' &&
@ -1797,6 +2045,7 @@ class ShareAPIControllerTest extends TestCase {
 			->setSharedBy($this->currentUser)
 			->setShareType(\OCP\Share::SHARE_TYPE_LINK)
 			->setPassword('password')
+			->setSendPasswordByTalk(true)
 			->setExpirationDate($date)
 			->setNote('note')
 			->setLabel('label')
@ -1811,6 +2060,7 @@ class ShareAPIControllerTest extends TestCase {
 			$this->callback(function (\OCP\Share\IShare $share) use ($date) {
 				return $share->getPermissions() === (\OCP\Constants::PERMISSION_READ | \OCP\Constants::PERMISSION_CREATE | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE) &&
 				$share->getPassword() === 'password' &&
+				$share->getSendPasswordByTalk() === true &&
 				$share->getExpirationDate() === $date &&
 				$share->getNote() === 'note' &&
 				$share->getLabel() === 'label' &&
@ -1840,6 +2090,7 @@ class ShareAPIControllerTest extends TestCase {
 			->setSharedBy($this->currentUser)
 			->setShareType(\OCP\Share::SHARE_TYPE_LINK)
 			->setPassword('password')
+			->setSendPasswordByTalk(true)
 			->setExpirationDate($date)
 			->setNote('note')
 			->setLabel('label')
@ -1854,6 +2105,7 @@ class ShareAPIControllerTest extends TestCase {
 			$this->callback(function (\OCP\Share\IShare $share) use ($date) {
 				return $share->getPermissions() === (\OCP\Constants::PERMISSION_READ | \OCP\Constants::PERMISSION_CREATE | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE) &&
 				$share->getPassword() === 'password' &&
+				$share->getSendPasswordByTalk() === true &&
 				$share->getExpirationDate() === $date &&
 				$share->getNote() === 'note' &&
 				$share->getLabel() === 'label' &&
@ -1882,6 +2134,7 @@ class ShareAPIControllerTest extends TestCase {
 			->setSharedBy($this->currentUser)
 			->setShareType(\OCP\Share::SHARE_TYPE_LINK)
 			->setPassword('password')
+			->setSendPasswordByTalk(true)
 			->setExpirationDate($date)
 			->setNote('note')
 			->setLabel('label')
@ -1896,6 +2149,7 @@ class ShareAPIControllerTest extends TestCase {
 			$this->callback(function (\OCP\Share\IShare $share) use ($date) {
 				return $share->getPermissions() === (\OCP\Constants::PERMISSION_READ | \OCP\Constants::PERMISSION_CREATE | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE) &&
 					$share->getPassword() === 'password' &&
+					$share->getSendPasswordByTalk() === true &&
 					$share->getExpirationDate() === $date &&
 					$share->getNote() === 'note' &&
 					$share->getLabel() === 'label' &&
@ -2435,6 +2689,56 @@ class ShareAPIControllerTest extends TestCase {
 				'file_target' => 'myTarget',
 				'share_with' => 'mypassword',
 				'share_with_displayname' => 'mypassword',
+				'send_password_by_talk' => false,
+				'mail_send' => 0,
+				'url' => 'myLink',
+				'mimetype' => 'myMimeType',
+				'hide_download' => 0,
+			], $share, [], false
+		];
+
+		$share = \OC::$server->getShareManager()->newShare();
+		$share->setShareType(\OCP\Share::SHARE_TYPE_LINK)
+			->setSharedBy('initiator')
+			->setShareOwner('owner')
+			->setPermissions(\OCP\Constants::PERMISSION_READ)
+			->setNode($file)
+			->setShareTime(new \DateTime('2000-01-01T00:01:02'))
+			->setTarget('myTarget')
+			->setPassword('mypassword')
+			->setSendPasswordByTalk(true)
+			->setExpirationDate(new \DateTime('2001-01-02T00:00:00'))
+			->setToken('myToken')
+			->setNote('personal note')
+			->setLabel('new link share')
+			->setId(42);
+
+		$result[] = [
+			[
+				'id' => 42,
+				'share_type' => \OCP\Share::SHARE_TYPE_LINK,
+				'uid_owner' => 'initiator',
+				'displayname_owner' => 'initiator',
+				'permissions' => 1,
+				'stime' => 946684862,
+				'parent' => null,
+				'expiration' => '2001-01-02 00:00:00',
+				'token' => 'myToken',
+				'uid_file_owner' => 'owner',
+				'displayname_file_owner' => 'owner',
+				'note' => 'personal note',
+				'label' => 'new link share',
+				'path' => 'file',
+				'item_type' => 'file',
+				'storage_id' => 'storageId',
+				'storage' => 100,
+				'item_source' => 3,
+				'file_source' => 3,
+				'file_parent' => 1,
+				'file_target' => 'myTarget',
+				'share_with' => 'mypassword',
+				'share_with_displayname' => 'mypassword',
+				'send_password_by_talk' => true,
 				'mail_send' => 0,
 				'url' => 'myLink',
 				'mimetype' => 'myMimeType',