2015-10-30 15:10:08 +03:00
< ? php
2019-12-03 21:57:53 +03:00
2018-04-23 21:31:57 +03:00
declare ( strict_types = 1 );
2019-12-03 21:57:53 +03:00
2015-10-30 15:10:08 +03:00
/**
2016-01-12 17:02:16 +03:00
* @ copyright Copyright ( c ) 2016 , ownCloud , Inc .
2016-07-21 17:49:16 +03:00
*
2017-11-06 17:56:42 +03:00
* @ author Bjoern Schiessle < bjoern @ schiessle . org >
2020-04-29 12:57:22 +03:00
* @ author Christoph Wurst < christoph @ winzerhof - wurst . at >
2019-12-03 21:57:53 +03:00
* @ author Daniel Calviño Sánchez < danxuliu @ gmail . com >
2020-08-24 15:54:25 +03:00
* @ author Daniel Kesselberg < mail @ danielkesselberg . de >
* @ author Gary Kim < gary @ garykim . dev >
* @ author Georg Ehrke < oc . list @ georgehrke . com >
2016-07-21 17:49:16 +03:00
* @ author Joas Schilling < coding @ schilljs . com >
2019-12-03 21:57:53 +03:00
* @ author John Molakvoæ ( skjnldsv ) < skjnldsv @ protonmail . com >
2020-01-13 16:23:49 +03:00
* @ author Julius Härtl < jus @ bitgrid . net >
2017-11-06 17:56:42 +03:00
* @ author Lukas Reschke < lukas @ statuscode . ch >
2019-12-03 21:57:53 +03:00
* @ author Maxence Lange < maxence @ artificial - owl . com >
2017-11-06 17:56:42 +03:00
* @ author Maxence Lange < maxence @ nextcloud . com >
* @ author Michael Jobst < mjobst + github @ tecratech . de >
2019-12-03 21:57:53 +03:00
* @ author Morris Jobke < hey @ morrisjobke . de >
2020-12-16 16:54:15 +03:00
* @ author Richard Steinmetz < richard @ steinmetz . cloud >
2017-11-06 17:56:42 +03:00
* @ author Robin Appelman < robin @ icewind . nl >
2016-07-21 17:49:16 +03:00
* @ author Roeland Jago Douma < roeland @ famdouma . nl >
2020-12-16 16:54:15 +03:00
* @ author Vincent Petry < vincent @ nextcloud . com >
2019-12-03 21:57:53 +03:00
* @ author waleczny < michal @ walczak . xyz >
2016-07-21 17:49:16 +03:00
*
2015-10-30 15:10:08 +03:00
* @ license AGPL - 3.0
*
* This code is free software : you can redistribute it and / or modify
* it under the terms of the GNU Affero General Public License , version 3 ,
* as published by the Free Software Foundation .
*
* This program is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
* GNU Affero General Public License for more details .
*
* You should have received a copy of the GNU Affero General Public License , version 3 ,
2019-12-03 21:57:53 +03:00
* along with this program . If not , see < http :// www . gnu . org / licenses />
2015-10-30 15:10:08 +03:00
*
*/
2019-08-06 11:22:32 +03:00
2016-10-21 21:25:07 +03:00
namespace OCA\Files_Sharing\Controller ;
2015-10-30 15:10:08 +03:00
2019-06-25 23:34:38 +03:00
use OCA\Files_Sharing\Exceptions\SharingRightsException ;
use OCA\Files_Sharing\External\Storage ;
2016-11-10 11:13:25 +03:00
use OCA\Files\Helper ;
2018-07-10 14:01:31 +03:00
use OCP\App\IAppManager ;
2016-07-20 10:55:43 +03:00
use OCP\AppFramework\Http\DataResponse ;
2016-07-20 11:41:09 +03:00
use OCP\AppFramework\OCS\OCSBadRequestException ;
use OCP\AppFramework\OCS\OCSException ;
use OCP\AppFramework\OCS\OCSForbiddenException ;
2016-07-20 10:55:43 +03:00
use OCP\AppFramework\OCS\OCSNotFoundException ;
2016-07-19 15:13:27 +03:00
use OCP\AppFramework\OCSController ;
2018-06-29 14:22:26 +03:00
use OCP\AppFramework\QueryException ;
2017-12-01 16:49:35 +03:00
use OCP\Constants ;
2019-06-25 23:34:38 +03:00
use OCP\Files\InvalidPathException ;
2019-11-22 22:52:10 +03:00
use OCP\Files\IRootFolder ;
2020-04-29 17:43:39 +03:00
use OCP\Files\Folder ;
2016-09-20 18:59:04 +03:00
use OCP\Files\Node ;
2016-02-16 18:04:17 +03:00
use OCP\Files\NotFoundException ;
2017-12-01 16:49:35 +03:00
use OCP\IConfig ;
2015-11-24 11:37:17 +03:00
use OCP\IGroupManager ;
2016-04-15 15:05:36 +03:00
use OCP\IL10N ;
2020-10-11 16:19:30 +03:00
use OCP\IPreview ;
2015-11-24 11:37:17 +03:00
use OCP\IRequest ;
2018-06-29 14:22:26 +03:00
use OCP\IServerContainer ;
2015-11-24 11:37:17 +03:00
use OCP\IURLGenerator ;
2019-11-22 22:52:10 +03:00
use OCP\IUserManager ;
use OCP\Lock\ILockingProvider ;
2016-03-09 11:11:41 +03:00
use OCP\Lock\LockedException ;
2018-06-13 15:19:59 +03:00
use OCP\Share ;
2016-02-02 16:18:59 +03:00
use OCP\Share\Exceptions\GenericShareException ;
2019-11-22 22:52:10 +03:00
use OCP\Share\Exceptions\ShareNotFound ;
use OCP\Share\IManager ;
2016-09-07 19:38:08 +03:00
use OCP\Share\IShare ;
2020-08-05 11:37:20 +03:00
use OCP\UserStatus\IManager as IUserStatusManager ;
2016-02-02 16:18:59 +03:00
2016-03-07 18:12:40 +03:00
/**
* Class Share20OCS
*
* @ package OCA\Files_Sharing\API
*/
2016-10-21 21:25:07 +03:00
class ShareAPIController extends OCSController {
2015-10-30 15:10:08 +03:00
2016-02-03 10:14:48 +03:00
/** @var IManager */
2015-10-30 15:10:08 +03:00
private $shareManager ;
2015-11-24 11:37:17 +03:00
/** @var IGroupManager */
2015-10-30 15:10:08 +03:00
private $groupManager ;
2015-11-24 11:37:17 +03:00
/** @var IUserManager */
2015-10-30 15:10:08 +03:00
private $userManager ;
2015-11-24 12:16:02 +03:00
/** @var IRootFolder */
private $rootFolder ;
2016-03-10 23:35:22 +03:00
/** @var IURLGenerator */
2015-11-24 11:37:17 +03:00
private $urlGenerator ;
2016-10-21 21:25:07 +03:00
/** @var string */
2015-11-24 11:37:17 +03:00
private $currentUser ;
2016-04-15 15:05:36 +03:00
/** @var IL10N */
private $l ;
2016-07-20 11:11:01 +03:00
/** @var \OCP\Files\Node */
private $lockedNode ;
2017-12-01 16:49:35 +03:00
/** @var IConfig */
private $config ;
2018-07-10 14:01:31 +03:00
/** @var IAppManager */
private $appManager ;
2018-06-29 14:22:26 +03:00
/** @var IServerContainer */
private $serverContainer ;
2020-08-05 11:37:20 +03:00
/** @var IUserStatusManager */
private $userStatusManager ;
2020-10-11 16:19:30 +03:00
/** @var IPreview */
private $previewManager ;
2015-11-24 11:37:17 +03:00
2016-02-03 10:14:48 +03:00
/**
* Share20OCS constructor .
*
2016-07-19 15:13:27 +03:00
* @ param string $appName
* @ param IRequest $request
2016-02-03 10:14:48 +03:00
* @ param IManager $shareManager
* @ param IGroupManager $groupManager
* @ param IUserManager $userManager
* @ param IRootFolder $rootFolder
* @ param IURLGenerator $urlGenerator
2016-10-21 21:25:07 +03:00
* @ param string $userId
2016-07-19 15:13:27 +03:00
* @ param IL10N $l10n
2017-12-01 16:49:35 +03:00
* @ param IConfig $config
2018-07-10 14:01:31 +03:00
* @ param IAppManager $appManager
2018-06-29 14:22:26 +03:00
* @ param IServerContainer $serverContainer
2020-08-05 11:37:20 +03:00
* @ param IUserStatusManager $userStatusManager
2016-02-03 10:14:48 +03:00
*/
2015-11-24 11:37:17 +03:00
public function __construct (
2018-04-23 21:31:57 +03:00
string $appName ,
2016-09-21 18:35:09 +03:00
IRequest $request ,
IManager $shareManager ,
IGroupManager $groupManager ,
IUserManager $userManager ,
IRootFolder $rootFolder ,
IURLGenerator $urlGenerator ,
2018-10-04 14:04:58 +03:00
string $userId = null ,
2017-12-01 16:49:35 +03:00
IL10N $l10n ,
2018-07-10 14:01:31 +03:00
IConfig $config ,
2018-06-29 14:22:26 +03:00
IAppManager $appManager ,
2020-08-05 11:37:20 +03:00
IServerContainer $serverContainer ,
2020-10-11 16:19:30 +03:00
IUserStatusManager $userStatusManager ,
IPreview $previewManager
2015-11-24 11:37:17 +03:00
) {
2016-07-19 15:13:27 +03:00
parent :: __construct ( $appName , $request );
2015-10-30 15:10:08 +03:00
$this -> shareManager = $shareManager ;
$this -> userManager = $userManager ;
$this -> groupManager = $groupManager ;
$this -> request = $request ;
2015-11-24 12:16:02 +03:00
$this -> rootFolder = $rootFolder ;
2015-11-06 14:05:19 +03:00
$this -> urlGenerator = $urlGenerator ;
2016-10-21 21:25:07 +03:00
$this -> currentUser = $userId ;
2016-04-15 15:05:36 +03:00
$this -> l = $l10n ;
2017-12-01 16:49:35 +03:00
$this -> config = $config ;
2018-07-10 14:01:31 +03:00
$this -> appManager = $appManager ;
2018-06-29 14:22:26 +03:00
$this -> serverContainer = $serverContainer ;
2020-08-05 11:37:20 +03:00
$this -> userStatusManager = $userStatusManager ;
2020-10-11 16:19:30 +03:00
$this -> previewManager = $previewManager ;
2015-11-06 14:05:19 +03:00
}
/**
* Convert an IShare to an array for OCS output
*
2016-01-27 14:13:53 +03:00
* @ param \OCP\Share\IShare $share
2016-09-20 18:59:04 +03:00
* @ param Node | null $recipientNode
2015-11-06 14:05:19 +03:00
* @ return array
2016-02-16 18:04:17 +03:00
* @ throws NotFoundException In case the node can ' t be resolved .
2018-07-24 12:57:52 +03:00
*
* @ suppress PhanUndeclaredClassMethod
2015-11-06 14:05:19 +03:00
*/
2020-04-29 17:43:39 +03:00
protected function formatShare ( IShare $share , Node $recipientNode = null ) : array {
2016-02-03 10:14:48 +03:00
$sharedBy = $this -> userManager -> get ( $share -> getSharedBy ());
2016-06-07 13:50:12 +03:00
$shareOwner = $this -> userManager -> get ( $share -> getShareOwner ());
2015-11-06 14:05:19 +03:00
$result = [
'id' => $share -> getId (),
'share_type' => $share -> getShareType (),
2016-02-03 10:14:48 +03:00
'uid_owner' => $share -> getSharedBy (),
2016-02-11 23:17:22 +03:00
'displayname_owner' => $sharedBy !== null ? $sharedBy -> getDisplayName () : $share -> getSharedBy (),
2019-10-24 16:51:56 +03:00
// recipient permissions
2015-11-06 14:05:19 +03:00
'permissions' => $share -> getPermissions (),
2019-10-24 16:51:56 +03:00
// current user permissions on this share
'can_edit' => $this -> canEditShare ( $share ),
'can_delete' => $this -> canDeleteShare ( $share ),
2016-01-27 22:51:26 +03:00
'stime' => $share -> getShareTime () -> getTimestamp (),
'parent' => null ,
2015-11-06 14:05:19 +03:00
'expiration' => null ,
'token' => null ,
2016-02-03 10:14:48 +03:00
'uid_file_owner' => $share -> getShareOwner (),
2018-07-13 18:53:14 +03:00
'note' => $share -> getNote (),
2018-10-16 11:31:38 +03:00
'label' => $share -> getLabel (),
2016-02-12 12:44:34 +03:00
'displayname_file_owner' => $shareOwner !== null ? $shareOwner -> getDisplayName () : $share -> getShareOwner (),
2015-11-06 14:05:19 +03:00
];
2016-10-21 21:25:07 +03:00
$userFolder = $this -> rootFolder -> getUserFolder ( $this -> currentUser );
2016-09-20 18:59:04 +03:00
if ( $recipientNode ) {
$node = $recipientNode ;
} else {
$nodes = $userFolder -> getById ( $share -> getNodeId ());
if ( empty ( $nodes )) {
2016-09-21 19:55:58 +03:00
// fallback to guessing the path
$node = $userFolder -> get ( $share -> getTarget ());
2018-04-04 12:33:05 +03:00
if ( $node === null || $share -> getTarget () === '' ) {
2016-09-21 19:55:58 +03:00
throw new NotFoundException ();
}
} else {
2019-11-19 01:33:26 +03:00
$node = reset ( $nodes );
2016-09-20 18:59:04 +03:00
}
}
2016-06-07 13:50:12 +03:00
$result [ 'path' ] = $userFolder -> getRelativePath ( $node -> getPath ());
2020-04-29 17:43:39 +03:00
if ( $node instanceof Folder ) {
2015-11-06 14:05:19 +03:00
$result [ 'item_type' ] = 'folder' ;
} else {
$result [ 'item_type' ] = 'file' ;
}
2019-08-06 11:22:32 +03:00
2016-07-19 15:13:27 +03:00
$result [ 'mimetype' ] = $node -> getMimetype ();
2020-10-11 16:19:30 +03:00
$result [ 'has_preview' ] = $this -> previewManager -> isAvailable ( $node );
2016-01-27 22:51:26 +03:00
$result [ 'storage_id' ] = $node -> getStorage () -> getId ();
$result [ 'storage' ] = $node -> getStorage () -> getCache () -> getNumericStorageId ();
$result [ 'item_source' ] = $node -> getId ();
$result [ 'file_source' ] = $node -> getId ();
$result [ 'file_parent' ] = $node -> getParent () -> getId ();
2015-11-06 14:05:19 +03:00
$result [ 'file_target' ] = $share -> getTarget ();
2017-03-29 17:50:23 +03:00
$expiration = $share -> getExpirationDate ();
if ( $expiration !== null ) {
$result [ 'expiration' ] = $expiration -> format ( 'Y-m-d 00:00:00' );
}
2020-04-29 17:43:39 +03:00
if ( $share -> getShareType () === IShare :: TYPE_USER ) {
2016-02-03 10:14:48 +03:00
$sharedWith = $this -> userManager -> get ( $share -> getSharedWith ());
2016-02-12 12:44:34 +03:00
$result [ 'share_with' ] = $share -> getSharedWith ();
$result [ 'share_with_displayname' ] = $sharedWith !== null ? $sharedWith -> getDisplayName () : $share -> getSharedWith ();
2020-10-07 13:32:16 +03:00
$result [ 'share_with_displayname_unique' ] = $sharedWith !== null ? (
$sharedWith -> getEMailAddress () !== '' ? $sharedWith -> getEMailAddress () : $sharedWith -> getUID ()
) : $share -> getSharedWith ();
2020-08-05 11:37:20 +03:00
$result [ 'status' ] = [];
$userStatuses = $this -> userStatusManager -> getUserStatuses ([ $share -> getSharedWith ()]);
$userStatus = array_shift ( $userStatuses );
if ( $userStatus ) {
$result [ 'status' ] = [
'status' => $userStatus -> getStatus (),
'message' => $userStatus -> getMessage (),
'icon' => $userStatus -> getIcon (),
'clearAt' => $userStatus -> getClearAt ()
? ( int ) $userStatus -> getClearAt () -> format ( 'U' )
: null ,
];
}
2020-04-29 17:43:39 +03:00
} elseif ( $share -> getShareType () === IShare :: TYPE_GROUP ) {
2016-11-30 22:56:10 +03:00
$group = $this -> groupManager -> get ( $share -> getSharedWith ());
2016-02-03 10:14:48 +03:00
$result [ 'share_with' ] = $share -> getSharedWith ();
2016-11-30 22:56:10 +03:00
$result [ 'share_with_displayname' ] = $group !== null ? $group -> getDisplayName () : $share -> getSharedWith ();
2020-04-10 11:35:09 +03:00
} elseif ( $share -> getShareType () === IShare :: TYPE_LINK ) {
2015-11-06 14:05:19 +03:00
2018-11-07 01:48:28 +03:00
// "share_with" and "share_with_displayname" for passwords of link
// shares was deprecated in Nextcloud 15, use "password" instead.
2015-11-06 14:05:19 +03:00
$result [ 'share_with' ] = $share -> getPassword ();
2020-01-10 12:03:08 +03:00
$result [ 'share_with_displayname' ] = '(' . $this -> l -> t ( 'Shared link' ) . ')' ;
2015-11-06 14:05:19 +03:00
2018-11-07 01:48:28 +03:00
$result [ 'password' ] = $share -> getPassword ();
2018-10-15 13:27:56 +03:00
$result [ 'send_password_by_talk' ] = $share -> getSendPasswordByTalk ();
2015-11-06 14:05:19 +03:00
$result [ 'token' ] = $share -> getToken ();
$result [ 'url' ] = $this -> urlGenerator -> linkToRouteAbsolute ( 'files_sharing.sharecontroller.showShare' , [ 'token' => $share -> getToken ()]);
2020-04-29 17:43:39 +03:00
} elseif ( $share -> getShareType () === IShare :: TYPE_REMOTE || $share -> getShareType () === IShare :: TYPE_REMOTE_GROUP ) {
2015-11-06 14:05:19 +03:00
$result [ 'share_with' ] = $share -> getSharedWith ();
2016-10-25 17:24:24 +03:00
$result [ 'share_with_displayname' ] = $this -> getDisplayNameFromAddressBook ( $share -> getSharedWith (), 'CLOUD' );
2015-11-06 14:05:19 +03:00
$result [ 'token' ] = $share -> getToken ();
2020-04-29 17:43:39 +03:00
} elseif ( $share -> getShareType () === IShare :: TYPE_EMAIL ) {
2016-07-29 16:38:31 +03:00
$result [ 'share_with' ] = $share -> getSharedWith ();
2017-03-28 16:11:07 +03:00
$result [ 'password' ] = $share -> getPassword ();
2018-07-10 14:01:31 +03:00
$result [ 'send_password_by_talk' ] = $share -> getSendPasswordByTalk ();
2016-10-25 17:24:24 +03:00
$result [ 'share_with_displayname' ] = $this -> getDisplayNameFromAddressBook ( $share -> getSharedWith (), 'EMAIL' );
2016-07-29 16:38:31 +03:00
$result [ 'token' ] = $share -> getToken ();
2020-04-29 17:43:39 +03:00
} elseif ( $share -> getShareType () === IShare :: TYPE_CIRCLE ) {
2018-03-16 06:23:46 +03:00
// getSharedWith() returns either "name (type, owner)" or
// "name (type, owner) [id]", depending on the Circles app version.
$hasCircleId = ( substr ( $share -> getSharedWith (), - 1 ) === ']' );
2017-06-06 14:21:42 +03:00
$result [ 'share_with_displayname' ] = $share -> getSharedWithDisplayName ();
if ( empty ( $result [ 'share_with_displayname' ])) {
2019-08-06 11:22:32 +03:00
$displayNameLength = ( $hasCircleId ? strrpos ( $share -> getSharedWith (), ' ' ) : strlen ( $share -> getSharedWith ()));
2017-06-06 14:21:42 +03:00
$result [ 'share_with_displayname' ] = substr ( $share -> getSharedWith (), 0 , $displayNameLength );
}
$result [ 'share_with_avatar' ] = $share -> getSharedWithAvatar ();
2018-03-16 06:23:46 +03:00
2019-08-06 11:22:32 +03:00
$shareWithStart = ( $hasCircleId ? strrpos ( $share -> getSharedWith (), '[' ) + 1 : 0 );
$shareWithLength = ( $hasCircleId ? - 1 : strpos ( $share -> getSharedWith (), ' ' ));
2018-10-30 11:58:43 +03:00
if ( is_bool ( $shareWithLength )) {
$shareWithLength = - 1 ;
}
2018-03-16 06:23:46 +03:00
$result [ 'share_with' ] = substr ( $share -> getSharedWith (), $shareWithStart , $shareWithLength );
2020-04-29 17:43:39 +03:00
} elseif ( $share -> getShareType () === IShare :: TYPE_ROOM ) {
2018-06-29 14:22:26 +03:00
$result [ 'share_with' ] = $share -> getSharedWith ();
$result [ 'share_with_displayname' ] = '' ;
try {
$result = array_merge ( $result , $this -> getRoomShareHelper () -> formatShare ( $share ));
2020-04-10 15:19:56 +03:00
} catch ( QueryException $e ) {
}
2020-12-03 18:03:35 +03:00
} elseif ( $share -> getShareType () === IShare :: TYPE_DECK ) {
$result [ 'share_with' ] = $share -> getSharedWith ();
$result [ 'share_with_displayname' ] = '' ;
try {
$result = array_merge ( $result , $this -> getDeckShareHelper () -> formatShare ( $share ));
} catch ( QueryException $e ) {
}
2015-11-06 14:05:19 +03:00
}
2017-03-17 22:48:33 +03:00
2015-11-06 14:05:19 +03:00
$result [ 'mail_send' ] = $share -> getMailSend () ? 1 : 0 ;
2018-10-18 13:38:07 +03:00
$result [ 'hide_download' ] = $share -> getHideDownload () ? 1 : 0 ;
2015-11-06 14:05:19 +03:00
return $result ;
}
2016-10-25 17:24:24 +03:00
/**
* Check if one of the users address books knows the exact property , if
* yes we return the full name .
*
* @ param string $query
* @ param string $property
* @ return string
*/
2018-04-23 21:31:57 +03:00
private function getDisplayNameFromAddressBook ( string $query , string $property ) : string {
2016-10-25 17:24:24 +03:00
// FIXME: If we inject the contacts manager it gets initialized bofore any address books are registered
$result = \OC :: $server -> getContactsManager () -> search ( $query , [ $property ]);
foreach ( $result as $r ) {
2019-08-06 11:22:32 +03:00
foreach ( $r [ $property ] as $value ) {
2020-08-24 16:15:32 +03:00
if ( $value === $query && $r [ 'FN' ]) {
2016-10-25 17:24:24 +03:00
return $r [ 'FN' ];
}
}
}
return $query ;
}
2015-11-06 14:05:19 +03:00
/**
* Get a specific share by id
*
2016-07-19 15:13:27 +03:00
* @ NoAdminRequired
*
2015-11-06 14:05:19 +03:00
* @ param string $id
2016-07-20 10:55:43 +03:00
* @ return DataResponse
* @ throws OCSNotFoundException
2015-11-06 14:05:19 +03:00
*/
2018-04-23 21:31:57 +03:00
public function getShare ( string $id ) : DataResponse {
2015-11-06 14:05:19 +03:00
try {
2016-03-07 18:10:27 +03:00
$share = $this -> getShareById ( $id );
2016-02-02 16:18:59 +03:00
} catch ( ShareNotFound $e ) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Wrong share ID, share doesn\'t exist' ));
2015-11-06 14:05:19 +03:00
}
2019-08-16 16:09:15 +03:00
try {
if ( $this -> canAccessShare ( $share )) {
2016-02-16 18:04:17 +03:00
$share = $this -> formatShare ( $share );
2016-08-09 11:04:29 +03:00
return new DataResponse ([ $share ]);
2016-02-16 18:04:17 +03:00
}
2019-08-16 16:09:15 +03:00
} catch ( NotFoundException $e ) {
// Fall trough
2015-11-24 11:37:17 +03:00
}
2016-02-16 18:04:17 +03:00
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Wrong share ID, share doesn\'t exist' ));
2015-10-30 15:10:08 +03:00
}
/**
* Delete a share
*
2016-07-19 15:13:27 +03:00
* @ NoAdminRequired
*
2015-11-06 14:05:19 +03:00
* @ param string $id
2016-07-20 11:11:01 +03:00
* @ return DataResponse
2016-07-20 10:55:43 +03:00
* @ throws OCSNotFoundException
2015-10-30 15:10:08 +03:00
*/
2018-04-23 21:31:57 +03:00
public function deleteShare ( string $id ) : DataResponse {
2015-10-30 15:10:08 +03:00
try {
2016-03-07 18:10:27 +03:00
$share = $this -> getShareById ( $id );
2016-02-02 16:18:59 +03:00
} catch ( ShareNotFound $e ) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Wrong share ID, share doesn\'t exist' ));
2015-11-02 21:49:39 +03:00
}
2016-03-09 11:11:41 +03:00
try {
2016-07-20 11:11:01 +03:00
$this -> lock ( $share -> getNode ());
2016-03-09 11:11:41 +03:00
} catch ( LockedException $e ) {
2019-08-26 14:11:09 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Could not delete share' ));
2016-03-09 11:11:41 +03:00
}
2016-10-25 11:18:42 +03:00
if ( ! $this -> canAccessShare ( $share )) {
2019-08-26 14:11:09 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Wrong share ID, share doesn\'t exist' ));
2015-11-24 11:37:17 +03:00
}
2019-08-26 14:11:09 +03:00
// if it's a group share or a room share
// we don't delete the share, but only the
// mount point. Allowing it to be restored
// from the deleted shares
if ( $this -> canDeleteShareFromSelf ( $share )) {
2016-10-25 11:18:42 +03:00
$this -> shareManager -> deleteFromSelf ( $share , $this -> currentUser );
} else {
2019-08-26 14:11:09 +03:00
if ( ! $this -> canDeleteShare ( $share )) {
throw new OCSForbiddenException ( $this -> l -> t ( 'Could not delete share' ));
}
2016-10-25 11:18:42 +03:00
$this -> shareManager -> deleteShare ( $share );
}
2015-10-30 15:10:08 +03:00
2016-07-20 11:44:52 +03:00
return new DataResponse ();
2015-10-30 15:10:08 +03:00
}
2015-11-24 11:37:17 +03:00
2015-12-15 11:54:50 +03:00
/**
2016-07-19 15:13:27 +03:00
* @ NoAdminRequired
*
2016-08-16 23:45:49 +03:00
* @ param string $path
* @ param int $permissions
* @ param int $shareType
* @ param string $shareWith
* @ param string $publicUpload
* @ param string $password
2018-10-16 11:31:38 +03:00
* @ param string $sendPasswordByTalk
2016-08-16 23:45:49 +03:00
* @ param string $expireDate
2018-10-16 11:31:38 +03:00
* @ param string $label
2016-08-16 23:45:49 +03:00
*
2016-07-20 10:55:43 +03:00
* @ return DataResponse
2018-10-16 11:31:38 +03:00
* @ throws NotFoundException
2016-07-20 11:41:09 +03:00
* @ throws OCSBadRequestException
* @ throws OCSException
2018-10-16 11:31:38 +03:00
* @ throws OCSForbiddenException
* @ throws OCSNotFoundException
2019-06-25 23:34:38 +03:00
* @ throws InvalidPathException
2017-07-18 21:38:40 +03:00
* @ suppress PhanUndeclaredClassMethod
2015-12-15 11:54:50 +03:00
*/
2016-08-16 23:45:49 +03:00
public function createShare (
2018-04-23 21:31:57 +03:00
string $path = null ,
int $permissions = null ,
int $shareType = - 1 ,
string $shareWith = null ,
string $publicUpload = 'false' ,
string $password = '' ,
2018-07-10 14:01:31 +03:00
string $sendPasswordByTalk = null ,
2018-10-16 11:31:38 +03:00
string $expireDate = '' ,
string $label = ''
2018-04-23 21:31:57 +03:00
) : DataResponse {
2015-12-15 11:54:50 +03:00
$share = $this -> shareManager -> newShare ();
2017-12-01 16:49:35 +03:00
if ( $permissions === null ) {
$permissions = $this -> config -> getAppValue ( 'core' , 'shareapi_default_permissions' , Constants :: PERMISSION_ALL );
}
2015-12-15 11:54:50 +03:00
// Verify path
if ( $path === null ) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Please specify a file or folder path' ));
2015-12-15 11:54:50 +03:00
}
2016-10-21 21:25:07 +03:00
$userFolder = $this -> rootFolder -> getUserFolder ( $this -> currentUser );
2015-12-15 11:54:50 +03:00
try {
$path = $userFolder -> get ( $path );
2016-03-17 13:09:11 +03:00
} catch ( NotFoundException $e ) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Wrong path, file/folder doesn\'t exist' ));
2015-12-15 11:54:50 +03:00
}
2016-01-27 22:51:26 +03:00
$share -> setNode ( $path );
2016-03-17 13:09:11 +03:00
try {
2016-07-20 11:11:01 +03:00
$this -> lock ( $share -> getNode ());
2016-03-17 13:09:11 +03:00
} catch ( LockedException $e ) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Could not create share' ));
2016-03-17 13:09:11 +03:00
}
2015-12-15 11:54:50 +03:00
2017-12-01 16:49:35 +03:00
if ( $permissions < 0 || $permissions > Constants :: PERMISSION_ALL ) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'invalid permissions' ));
2015-12-15 11:54:50 +03:00
}
// Shares always require read permissions
2017-12-01 16:49:35 +03:00
$permissions |= Constants :: PERMISSION_READ ;
2015-12-15 11:54:50 +03:00
if ( $path instanceof \OCP\Files\File ) {
// Single file shares should never have delete or create permissions
2017-12-01 16:49:35 +03:00
$permissions &= ~ Constants :: PERMISSION_DELETE ;
$permissions &= ~ Constants :: PERMISSION_CREATE ;
2015-12-15 11:54:50 +03:00
}
2019-08-06 11:22:32 +03:00
/**
2016-02-25 12:30:03 +03:00
* Hack for https :// github . com / owncloud / core / issues / 22587
* We check the permissions via webdav . But the permissions of the mount point
* do not equal the share permissions . Here we fix that for federated mounts .
*/
2018-04-23 21:31:57 +03:00
if ( $path -> getStorage () -> instanceOfStorage ( Storage :: class )) {
2016-02-25 12:30:03 +03:00
$permissions &= ~ ( $permissions & ~ $path -> getPermissions ());
}
2020-04-29 17:43:39 +03:00
if ( $shareType === IShare :: TYPE_USER ) {
2015-12-15 11:54:50 +03:00
// Valid user is required to share
if ( $shareWith === null || ! $this -> userManager -> userExists ( $shareWith )) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Please specify a valid user' ));
2015-12-15 11:54:50 +03:00
}
2016-02-03 10:14:48 +03:00
$share -> setSharedWith ( $shareWith );
2015-12-15 11:54:50 +03:00
$share -> setPermissions ( $permissions );
2020-04-29 17:43:39 +03:00
} elseif ( $shareType === IShare :: TYPE_GROUP ) {
2016-03-18 18:36:27 +03:00
if ( ! $this -> shareManager -> allowGroupSharing ()) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Group sharing is disabled by the administrator' ));
2016-03-18 18:36:27 +03:00
}
2015-12-15 11:54:50 +03:00
// Valid group is required to share
if ( $shareWith === null || ! $this -> groupManager -> groupExists ( $shareWith )) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Please specify a valid group' ));
2015-12-15 11:54:50 +03:00
}
2016-02-03 10:14:48 +03:00
$share -> setSharedWith ( $shareWith );
2015-12-15 11:54:50 +03:00
$share -> setPermissions ( $permissions );
2020-04-29 17:43:39 +03:00
} elseif ( $shareType === IShare :: TYPE_LINK
|| $shareType === IShare :: TYPE_EMAIL ) {
2019-08-01 14:56:35 +03:00
// Can we even share links?
2015-12-15 11:54:50 +03:00
if ( ! $this -> shareManager -> shareApiAllowLinks ()) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Public link sharing is disabled by the administrator' ));
2015-12-15 11:54:50 +03:00
}
if ( $publicUpload === 'true' ) {
// Check if public upload is allowed
if ( ! $this -> shareManager -> shareApiLinkAllowPublicUpload ()) {
2016-07-20 11:41:09 +03:00
throw new OCSForbiddenException ( $this -> l -> t ( 'Public upload disabled by the administrator' ));
2015-12-15 11:54:50 +03:00
}
// Public upload can only be set for folders
if ( $path instanceof \OCP\Files\File ) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Public upload is only possible for publicly shared folders' ));
2015-12-15 11:54:50 +03:00
}
2020-03-05 16:56:31 +03:00
$permissions = Constants :: PERMISSION_READ |
2017-12-01 16:49:35 +03:00
Constants :: PERMISSION_CREATE |
Constants :: PERMISSION_UPDATE |
2020-03-05 16:56:31 +03:00
Constants :: PERMISSION_DELETE ;
2015-12-15 11:54:50 +03:00
} else {
2020-03-05 16:56:31 +03:00
$permissions = Constants :: PERMISSION_READ ;
2015-12-15 11:54:50 +03:00
}
2020-04-29 17:43:39 +03:00
2020-05-06 22:39:49 +03:00
// TODO: It might make sense to have a dedicated setting to allow/deny converting link shares into federated ones
if (( $permissions & Constants :: PERMISSION_READ ) && $this -> shareManager -> outgoingServer2ServerSharesAllowed ()) {
$permissions |= Constants :: PERMISSION_SHARE ;
}
2020-03-05 16:56:31 +03:00
$share -> setPermissions ( $permissions );
2015-12-15 11:54:50 +03:00
// Set password
2016-01-27 17:42:11 +03:00
if ( $password !== '' ) {
$share -> setPassword ( $password );
}
2015-12-15 11:54:50 +03:00
2019-08-01 14:56:35 +03:00
// Only share by mail have a recipient
2020-04-29 17:43:39 +03:00
if ( $shareType === IShare :: TYPE_EMAIL ) {
2019-08-01 14:56:35 +03:00
$share -> setSharedWith ( $shareWith );
} else {
// Only link share have a label
if ( ! empty ( $label )) {
$share -> setLabel ( $label );
}
2018-10-16 11:31:38 +03:00
}
2018-10-15 13:27:56 +03:00
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 );
}
2015-12-15 11:54:50 +03:00
//Expire date
2016-01-27 17:42:11 +03:00
if ( $expireDate !== '' ) {
2015-12-15 11:54:50 +03:00
try {
$expireDate = $this -> parseDate ( $expireDate );
$share -> setExpirationDate ( $expireDate );
} catch ( \Exception $e ) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Invalid date, date format must be YYYY-MM-DD' ));
2015-12-15 11:54:50 +03:00
}
}
2020-04-29 17:43:39 +03:00
} elseif ( $shareType === IShare :: TYPE_REMOTE ) {
2016-02-04 13:13:06 +03:00
if ( ! $this -> shareManager -> outgoingServer2ServerSharesAllowed ()) {
2018-10-09 15:32:14 +03:00
throw new OCSForbiddenException ( $this -> l -> t ( 'Sharing %1$s failed because the back end does not allow shares from type %2$s' , [ $path -> getPath (), $shareType ]));
2016-02-04 13:13:06 +03:00
}
2016-02-04 12:01:40 +03:00
$share -> setSharedWith ( $shareWith );
$share -> setPermissions ( $permissions );
2020-04-29 17:43:39 +03:00
} elseif ( $shareType === IShare :: TYPE_REMOTE_GROUP ) {
2018-06-13 15:19:59 +03:00
if ( ! $this -> shareManager -> outgoingServer2ServerGroupSharesAllowed ()) {
2018-10-09 15:32:14 +03:00
throw new OCSForbiddenException ( $this -> l -> t ( 'Sharing %1$s failed because the back end does not allow shares from type %2$s' , [ $path -> getPath (), $shareType ]));
2018-06-13 15:19:59 +03:00
}
$share -> setSharedWith ( $shareWith );
$share -> setPermissions ( $permissions );
2020-04-29 17:43:39 +03:00
} elseif ( $shareType === IShare :: TYPE_CIRCLE ) {
2017-07-11 14:21:24 +03:00
if ( ! \OC :: $server -> getAppManager () -> isEnabledForUser ( 'circles' ) || ! class_exists ( '\OCA\Circles\ShareByCircleProvider' )) {
2017-03-17 22:48:33 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'You cannot share to a Circle if the app is not enabled' ));
}
2017-07-11 14:21:24 +03:00
$circle = \OCA\Circles\Api\v1\Circles :: detailsCircle ( $shareWith );
2017-03-17 22:48:33 +03:00
// Valid circle is required to share
if ( $circle === null ) {
throw new OCSNotFoundException ( $this -> l -> t ( 'Please specify a valid circle' ));
}
$share -> setSharedWith ( $shareWith );
$share -> setPermissions ( $permissions );
2020-04-29 17:43:39 +03:00
} elseif ( $shareType === IShare :: TYPE_ROOM ) {
2018-06-29 14:22:26 +03:00
try {
$this -> getRoomShareHelper () -> createShare ( $share , $shareWith , $permissions , $expireDate );
} catch ( QueryException $e ) {
throw new OCSForbiddenException ( $this -> l -> t ( 'Sharing %s failed because the back end does not support room shares' , [ $path -> getPath ()]));
}
2020-12-03 18:03:35 +03:00
} elseif ( $shareType === IShare :: TYPE_DECK ) {
try {
$this -> getDeckShareHelper () -> createShare ( $share , $shareWith , $permissions , $expireDate );
} catch ( QueryException $e ) {
throw new OCSForbiddenException ( $this -> l -> t ( 'Sharing %s failed because the back end does not support room shares' , [ $path -> getPath ()]));
}
2015-12-15 11:54:50 +03:00
} else {
2016-07-20 11:44:52 +03:00
throw new OCSBadRequestException ( $this -> l -> t ( 'Unknown share type' ));
2015-12-15 11:54:50 +03:00
}
$share -> setShareType ( $shareType );
2016-10-21 21:25:07 +03:00
$share -> setSharedBy ( $this -> currentUser );
2015-12-15 11:54:50 +03:00
try {
$share = $this -> shareManager -> createShare ( $share );
2016-02-02 16:18:59 +03:00
} catch ( GenericShareException $e ) {
2021-03-15 14:00:41 +03:00
\OC :: $server -> getLogger () -> logException ( $e );
2016-01-05 14:50:00 +03:00
$code = $e -> getCode () === 0 ? 403 : $e -> getCode ();
2016-07-20 11:41:09 +03:00
throw new OCSException ( $e -> getHint (), $code );
2016-09-20 12:29:12 +03:00
} catch ( \Exception $e ) {
2021-03-15 14:00:41 +03:00
\OC :: $server -> getLogger () -> logException ( $e );
2018-01-17 17:21:56 +03:00
throw new OCSForbiddenException ( $e -> getMessage (), $e );
2015-12-15 11:54:50 +03:00
}
2016-09-21 19:55:58 +03:00
$output = $this -> formatShare ( $share );
2016-03-09 11:11:41 +03:00
2016-08-09 11:04:29 +03:00
return new DataResponse ( $output );
2015-12-15 11:54:50 +03:00
}
2016-01-29 17:26:04 +03:00
/**
2019-06-25 23:34:38 +03:00
* @ param null | Node $node
2016-11-10 11:13:25 +03:00
* @ param boolean $includeTags
2019-06-25 23:34:38 +03:00
*
* @ return array
2016-01-29 17:26:04 +03:00
*/
2019-06-25 23:34:38 +03:00
private function getSharedWithMe ( $node , bool $includeTags ) : array {
2020-04-29 17:43:39 +03:00
$userShares = $this -> shareManager -> getSharedWith ( $this -> currentUser , IShare :: TYPE_USER , $node , - 1 , 0 );
$groupShares = $this -> shareManager -> getSharedWith ( $this -> currentUser , IShare :: TYPE_GROUP , $node , - 1 , 0 );
$circleShares = $this -> shareManager -> getSharedWith ( $this -> currentUser , IShare :: TYPE_CIRCLE , $node , - 1 , 0 );
$roomShares = $this -> shareManager -> getSharedWith ( $this -> currentUser , IShare :: TYPE_ROOM , $node , - 1 , 0 );
2020-12-03 18:03:35 +03:00
$deckShares = $this -> shareManager -> getSharedWith ( $this -> currentUser , IShare :: TYPE_DECK , $node , - 1 , 0 );
2015-12-03 12:51:41 +03:00
2020-12-03 18:03:35 +03:00
$shares = array_merge ( $userShares , $groupShares , $circleShares , $roomShares , $deckShares );
2015-12-03 12:51:41 +03:00
2020-05-05 19:46:24 +03:00
$filteredShares = array_filter ( $shares , function ( IShare $share ) {
2016-10-21 21:25:07 +03:00
return $share -> getShareOwner () !== $this -> currentUser ;
2016-09-07 19:38:08 +03:00
});
2015-12-03 12:51:41 +03:00
$formatted = [];
2020-05-05 19:46:24 +03:00
foreach ( $filteredShares as $share ) {
2016-01-27 11:02:12 +03:00
if ( $this -> canAccessShare ( $share )) {
2016-02-16 18:04:17 +03:00
try {
$formatted [] = $this -> formatShare ( $share );
} catch ( NotFoundException $e ) {
// Ignore this share
}
2016-01-27 11:02:12 +03:00
}
2015-12-03 12:51:41 +03:00
}
2016-11-10 11:13:25 +03:00
if ( $includeTags ) {
2017-08-22 19:46:47 +03:00
$formatted = Helper :: populateTags ( $formatted , 'file_source' , \OC :: $server -> getTagManager ());
2016-11-10 11:13:25 +03:00
}
2019-06-25 23:34:38 +03:00
return $formatted ;
2015-12-03 12:51:41 +03:00
}
2016-01-19 16:35:16 +03:00
/**
2019-06-25 23:34:38 +03:00
* @ param \OCP\Files\Node $folder
*
2019-08-19 11:53:29 +03:00
* @ return array
2016-07-20 11:41:09 +03:00
* @ throws OCSBadRequestException
2019-06-25 23:34:38 +03:00
* @ throws NotFoundException
2016-01-19 16:35:16 +03:00
*/
2019-08-19 11:53:29 +03:00
private function getSharesInDir ( Node $folder ) : array {
2016-01-19 16:35:16 +03:00
if ( ! ( $folder instanceof \OCP\Files\Folder )) {
2016-07-20 11:41:09 +03:00
throw new OCSBadRequestException ( $this -> l -> t ( 'Not a directory' ));
2016-01-19 16:35:16 +03:00
}
$nodes = $folder -> getDirectoryListing ();
2019-10-25 11:45:49 +03:00
2016-01-27 14:13:53 +03:00
/** @var \OCP\Share\IShare[] $shares */
2020-04-09 14:53:40 +03:00
$shares = array_reduce ( $nodes , function ( $carry , $node ) {
2019-10-25 11:45:49 +03:00
$carry = array_merge ( $carry , $this -> getAllShares ( $node , true ));
return $carry ;
}, []);
2016-01-19 16:35:16 +03:00
2019-08-19 11:53:29 +03:00
// filter out duplicate shares
$known = [];
2019-11-26 22:28:08 +03:00
$formatted = $miniFormatted = [];
$resharingRight = false ;
$known = [];
foreach ( $shares as $share ) {
if ( in_array ( $share -> getId (), $known ) || $share -> getSharedWith () === $this -> currentUser ) {
continue ;
2019-08-19 11:53:29 +03:00
}
2019-06-25 23:34:38 +03:00
try {
$format = $this -> formatShare ( $share );
$known [] = $share -> getId ();
$formatted [] = $format ;
if ( $share -> getSharedBy () === $this -> currentUser ) {
$miniFormatted [] = $format ;
}
if ( ! $resharingRight && $this -> shareProviderResharingRights ( $this -> currentUser , $share , $folder )) {
$resharingRight = true ;
}
} catch ( \Exception $e ) {
//Ignore this share
}
}
if ( ! $resharingRight ) {
$formatted = $miniFormatted ;
}
return $formatted ;
2016-01-19 16:35:16 +03:00
}
/**
* The getShares function .
*
2016-07-19 15:13:27 +03:00
* @ NoAdminRequired
*
2016-08-17 11:05:09 +03:00
* @ param string $shared_with_me
* @ param string $reshares
* @ param string $subfiles
* @ param string $path
*
2016-01-19 16:35:16 +03:00
* - Get shares by the current user
* - Get shares by the current user and reshares ( ? reshares = true )
* - Get shares with the current user ( ? shared_with_me = true )
* - Get shares for a specific path ( ? path =... )
* - Get all shares in a folder ( ? subfiles = true & path =.. )
*
2019-06-25 23:34:38 +03:00
* @ param string $include_tags
*
2016-07-20 10:55:43 +03:00
* @ return DataResponse
2019-06-25 23:34:38 +03:00
* @ throws NotFoundException
* @ throws OCSBadRequestException
2016-07-20 10:55:43 +03:00
* @ throws OCSNotFoundException
2016-01-19 16:35:16 +03:00
*/
2016-08-17 11:05:09 +03:00
public function getShares (
2018-04-23 21:31:57 +03:00
string $shared_with_me = 'false' ,
string $reshares = 'false' ,
string $subfiles = 'false' ,
2019-06-25 23:34:38 +03:00
string $path = '' ,
2018-04-23 21:31:57 +03:00
string $include_tags = 'false'
) : DataResponse {
2019-06-25 23:34:38 +03:00
$node = null ;
if ( $path !== '' ) {
2016-10-21 21:25:07 +03:00
$userFolder = $this -> rootFolder -> getUserFolder ( $this -> currentUser );
2015-12-03 12:51:41 +03:00
try {
2019-06-25 23:34:38 +03:00
$node = $userFolder -> get ( $path );
$this -> lock ( $node );
} catch ( NotFoundException $e ) {
throw new OCSNotFoundException (
$this -> l -> t ( 'Wrong path, file/folder doesn\'t exist' )
);
2016-03-17 13:09:11 +03:00
} catch ( LockedException $e ) {
2019-06-25 23:34:38 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Could not lock node' ));
2015-12-03 12:51:41 +03:00
}
}
2019-06-25 23:34:38 +03:00
$shares = $this -> getFormattedShares (
$this -> currentUser ,
$node ,
( $shared_with_me === 'true' ),
( $reshares === 'true' ),
( $subfiles === 'true' ),
( $include_tags === 'true' )
);
2018-04-24 09:07:25 +03:00
2019-06-25 23:34:38 +03:00
return new DataResponse ( $shares );
}
2016-01-29 17:26:04 +03:00
2019-06-25 23:34:38 +03:00
/**
* @ param string $viewer
* @ param Node $node
* @ param bool $sharedWithMe
* @ param bool $reShares
* @ param bool $subFiles
* @ param bool $includeTags
*
* @ return array
* @ throws NotFoundException
* @ throws OCSBadRequestException
*/
private function getFormattedShares (
2020-04-29 17:43:39 +03:00
string $viewer ,
$node = null ,
bool $sharedWithMe = false ,
bool $reShares = false ,
bool $subFiles = false ,
bool $includeTags = false
2019-06-25 23:34:38 +03:00
) : array {
if ( $sharedWithMe ) {
return $this -> getSharedWithMe ( $node , $includeTags );
2015-12-03 12:51:41 +03:00
}
2019-06-25 23:34:38 +03:00
if ( $subFiles ) {
return $this -> getSharesInDir ( $node );
2019-08-19 11:53:29 +03:00
}
2015-12-03 12:51:41 +03:00
2019-06-25 23:34:38 +03:00
$shares = $this -> getSharesFromNode ( $viewer , $node , $reShares );
2019-12-02 22:16:33 +03:00
$known = $formatted = $miniFormatted = [];
2018-10-29 12:03:52 +03:00
$resharingRight = false ;
2015-12-03 12:51:41 +03:00
foreach ( $shares as $share ) {
2020-03-02 11:18:04 +03:00
try {
$share -> getNode ();
} catch ( NotFoundException $e ) {
/*
* Ignore shares where we can ' t get the node
2020-04-29 17:43:39 +03:00
* For example deleted shares
2020-03-02 11:18:04 +03:00
*/
continue ;
}
2020-05-05 19:46:24 +03:00
if ( in_array ( $share -> getId (), $known )
|| ( $share -> getSharedWith () === $this -> currentUser && $share -> getShareType () === IShare :: TYPE_USER )) {
2019-12-02 22:16:33 +03:00
continue ;
}
$known [] = $share -> getId ();
2016-02-16 18:04:17 +03:00
try {
2019-06-25 23:34:38 +03:00
/** @var IShare $share */
$format = $this -> formatShare ( $share , $node );
2019-12-02 22:16:33 +03:00
$formatted [] = $format ;
2019-08-19 11:53:29 +03:00
// let's also build a list of shares created
// by the current user only, in case
// there is no resharing rights
2018-11-01 17:01:01 +03:00
if ( $share -> getSharedBy () === $this -> currentUser ) {
$miniFormatted [] = $format ;
}
2019-08-19 11:53:29 +03:00
// check if one of those share is shared with me
// and if I have resharing rights on it
2019-11-26 22:28:08 +03:00
if ( ! $resharingRight && $this -> shareProviderResharingRights ( $this -> currentUser , $share , $node )) {
2018-10-29 12:03:52 +03:00
$resharingRight = true ;
}
2019-06-25 23:34:38 +03:00
} catch ( InvalidPathException | NotFoundException $e ) {
2016-02-16 18:04:17 +03:00
}
2015-12-03 12:51:41 +03:00
}
2018-10-29 12:03:52 +03:00
if ( ! $resharingRight ) {
2018-11-01 17:01:01 +03:00
$formatted = $miniFormatted ;
2018-10-29 12:03:52 +03:00
}
2019-06-25 23:34:38 +03:00
if ( $includeTags ) {
$formatted =
Helper :: populateTags ( $formatted , 'file_source' , \OC :: $server -> getTagManager ());
2016-11-10 11:13:25 +03:00
}
2019-06-25 23:34:38 +03:00
return $formatted ;
2015-12-03 12:51:41 +03:00
}
2019-06-25 23:34:38 +03:00
/**
* The getInheritedShares function .
* returns all shares relative to a file , including parent folders shares rights .
*
* @ NoAdminRequired
*
* @ param string $path
*
* - Get shares by the current user
* - Get shares by the current user and reshares ( ? reshares = true )
* - Get shares with the current user ( ? shared_with_me = true )
* - Get shares for a specific path ( ? path =... )
* - Get all shares in a folder ( ? subfiles = true & path =.. )
*
* @ return DataResponse
* @ throws InvalidPathException
* @ throws NotFoundException
* @ throws OCSNotFoundException
* @ throws OCSBadRequestException
* @ throws SharingRightsException
*/
public function getInheritedShares ( string $path ) : DataResponse {
// get Node from (string) path.
$userFolder = $this -> rootFolder -> getUserFolder ( $this -> currentUser );
try {
$node = $userFolder -> get ( $path );
$this -> lock ( $node );
} catch ( \OCP\Files\NotFoundException $e ) {
throw new OCSNotFoundException ( $this -> l -> t ( 'Wrong path, file/folder doesn\'t exist' ));
} catch ( LockedException $e ) {
throw new OCSNotFoundException ( $this -> l -> t ( 'Could not lock path' ));
}
2020-04-01 16:07:35 +03:00
if ( ! ( $node -> getPermissions () & Constants :: PERMISSION_SHARE )) {
throw new SharingRightsException ( 'no sharing rights on this item' );
}
// The current top parent we have access to
$parent = $node ;
2019-06-25 23:34:38 +03:00
// initiate real owner.
$owner = $node -> getOwner ()
-> getUID ();
if ( ! $this -> userManager -> userExists ( $owner )) {
return new DataResponse ([]);
}
// get node based on the owner, fix owner in case of external storage
$userFolder = $this -> rootFolder -> getUserFolder ( $owner );
if ( $node -> getId () !== $userFolder -> getId () && ! $userFolder -> isSubNode ( $node )) {
$owner = $node -> getOwner ()
-> getUID ();
$userFolder = $this -> rootFolder -> getUserFolder ( $owner );
$nodes = $userFolder -> getById ( $node -> getId ());
$node = array_shift ( $nodes );
}
$basePath = $userFolder -> getPath ();
// generate node list for each parent folders
/** @var Node[] $nodes */
$nodes = [];
while ( $node -> getPath () !== $basePath ) {
$node = $node -> getParent ();
2020-01-08 12:56:14 +03:00
$nodes [] = $node ;
2019-06-25 23:34:38 +03:00
}
2020-04-01 16:07:35 +03:00
// The user that is requesting this list
$currentUserFolder = $this -> rootFolder -> getUserFolder ( $this -> currentUser );
2019-06-25 23:34:38 +03:00
// for each nodes, retrieve shares.
$shares = [];
2020-04-01 16:07:35 +03:00
2019-06-25 23:34:38 +03:00
foreach ( $nodes as $node ) {
$getShares = $this -> getFormattedShares ( $owner , $node , false , true );
2020-04-01 16:07:35 +03:00
$currentUserNodes = $currentUserFolder -> getById ( $node -> getId ());
if ( ! empty ( $currentUserNodes )) {
$parent = array_pop ( $currentUserNodes );
}
$subPath = $currentUserFolder -> getRelativePath ( $parent -> getPath ());
foreach ( $getShares as & $share ) {
$share [ 'via_fileid' ] = $parent -> getId ();
$share [ 'via_path' ] = $subPath ;
}
2019-06-25 23:34:38 +03:00
$this -> mergeFormattedShares ( $shares , $getShares );
}
return new DataResponse ( array_values ( $shares ));
}
2016-01-22 16:52:20 +03:00
/**
2016-07-19 15:13:27 +03:00
* @ NoAdminRequired
*
2018-04-23 21:31:57 +03:00
* @ param string $id
2016-08-17 11:05:09 +03:00
* @ param int $permissions
* @ param string $password
2018-07-10 14:01:31 +03:00
* @ param string $sendPasswordByTalk
2016-08-17 11:05:09 +03:00
* @ param string $publicUpload
* @ param string $expireDate
2018-07-12 15:55:50 +03:00
* @ param string $note
2018-10-17 11:50:58 +03:00
* @ param string $label
2018-10-18 13:38:07 +03:00
* @ param string $hideDownload
2016-07-20 10:55:43 +03:00
* @ return DataResponse
2018-07-12 15:55:50 +03:00
* @ throws LockedException
* @ throws NotFoundException
2016-07-20 11:41:09 +03:00
* @ throws OCSBadRequestException
* @ throws OCSForbiddenException
2018-07-12 15:55:50 +03:00
* @ throws OCSNotFoundException
2016-01-22 16:52:20 +03:00
*/
2016-08-17 11:05:09 +03:00
public function updateShare (
2018-04-23 21:31:57 +03:00
string $id ,
int $permissions = null ,
string $password = null ,
2018-07-10 14:01:31 +03:00
string $sendPasswordByTalk = null ,
2018-04-23 21:31:57 +03:00
string $publicUpload = null ,
2018-07-12 15:55:50 +03:00
string $expireDate = null ,
2018-10-18 13:38:07 +03:00
string $note = null ,
2018-10-17 11:50:58 +03:00
string $label = null ,
2018-10-18 13:38:07 +03:00
string $hideDownload = null
2018-04-23 21:31:57 +03:00
) : DataResponse {
2016-01-22 16:52:20 +03:00
try {
2016-03-07 18:10:27 +03:00
$share = $this -> getShareById ( $id );
2016-02-02 16:18:59 +03:00
} catch ( ShareNotFound $e ) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Wrong share ID, share doesn\'t exist' ));
2016-01-22 16:52:20 +03:00
}
2016-07-20 11:11:01 +03:00
$this -> lock ( $share -> getNode ());
2016-03-09 11:11:41 +03:00
2016-07-28 17:52:00 +03:00
if ( ! $this -> canAccessShare ( $share , false )) {
2016-07-20 10:55:43 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Wrong share ID, share doesn\'t exist' ));
2016-01-22 16:52:20 +03:00
}
2019-08-26 14:11:09 +03:00
if ( ! $this -> canEditShare ( $share )) {
2018-12-05 13:27:38 +03:00
throw new OCSForbiddenException ( 'You are not allowed to edit incoming shares' );
2018-11-20 11:42:01 +03:00
}
2019-08-06 11:22:32 +03:00
if (
$permissions === null &&
2018-10-17 11:50:58 +03:00
$password === null &&
$sendPasswordByTalk === null &&
$publicUpload === null &&
$expireDate === null &&
$note === null &&
$label === null &&
$hideDownload === null
) {
2017-03-30 18:03:04 +03:00
throw new OCSBadRequestException ( $this -> l -> t ( 'Wrong or no update parameter given' ));
}
2019-08-06 11:22:32 +03:00
if ( $note !== null ) {
2018-07-12 15:55:50 +03:00
$share -> setNote ( $note );
}
2019-08-06 11:22:32 +03:00
/**
2016-01-27 18:46:48 +03:00
* expirationdate , password and publicUpload only make sense for link shares
*/
2020-04-29 17:43:39 +03:00
if ( $share -> getShareType () === IShare :: TYPE_LINK
|| $share -> getShareType () === IShare :: TYPE_EMAIL ) {
2019-08-06 11:22:32 +03:00
/**
* We do not allow editing link shares that the current user
* doesn ' t own . This is confusing and lead to errors when
* someone else edit a password or expiration date without
* the share owner knowing about it .
* We only allow deletion
*/
if ( $share -> getSharedBy () !== $this -> currentUser ) {
throw new OCSForbiddenException ( 'You are not allowed to edit link shares that you don\'t own' );
}
2016-01-22 16:52:20 +03:00
2018-10-18 13:38:07 +03:00
// Update hide download state
if ( $hideDownload === 'true' ) {
$share -> setHideDownload ( true );
2020-04-10 11:35:09 +03:00
} elseif ( $hideDownload === 'false' ) {
2018-10-18 13:38:07 +03:00
$share -> setHideDownload ( false );
}
2016-01-27 22:32:04 +03:00
$newPermissions = null ;
if ( $publicUpload === 'true' ) {
2017-12-01 16:49:35 +03:00
$newPermissions = Constants :: PERMISSION_READ | Constants :: PERMISSION_CREATE | Constants :: PERMISSION_UPDATE | Constants :: PERMISSION_DELETE ;
2020-04-10 11:35:09 +03:00
} elseif ( $publicUpload === 'false' ) {
2017-12-01 16:49:35 +03:00
$newPermissions = Constants :: PERMISSION_READ ;
2016-01-22 16:52:20 +03:00
}
2016-01-27 22:32:04 +03:00
if ( $permissions !== null ) {
2021-01-11 14:57:03 +03:00
$newPermissions = $permissions ;
2017-12-01 16:49:35 +03:00
$newPermissions = $newPermissions & ~ Constants :: PERMISSION_SHARE ;
2016-01-27 22:32:04 +03:00
}
2016-01-22 16:52:20 +03:00
2016-01-27 22:32:04 +03:00
if ( $newPermissions !== null &&
2016-07-14 11:27:29 +03:00
! in_array ( $newPermissions , [
2017-12-01 16:49:35 +03:00
Constants :: PERMISSION_READ ,
Constants :: PERMISSION_READ | Constants :: PERMISSION_CREATE | Constants :: PERMISSION_UPDATE , // legacy
Constants :: PERMISSION_READ | Constants :: PERMISSION_CREATE | Constants :: PERMISSION_UPDATE | Constants :: PERMISSION_DELETE , // correct
Constants :: PERMISSION_CREATE , // hidden file list
Constants :: PERMISSION_READ | Constants :: PERMISSION_UPDATE , // allow to edit single files
2018-04-23 21:31:57 +03:00
], true )
2016-06-23 16:43:21 +03:00
) {
2016-07-20 11:41:09 +03:00
throw new OCSBadRequestException ( $this -> l -> t ( 'Can\'t change permissions for public share links' ));
2016-01-27 22:32:04 +03:00
}
2016-06-23 16:43:21 +03:00
if (
// legacy
2017-12-01 16:49:35 +03:00
$newPermissions === ( Constants :: PERMISSION_READ | Constants :: PERMISSION_CREATE | Constants :: PERMISSION_UPDATE ) ||
2016-06-23 16:43:21 +03:00
// correct
2017-12-01 16:49:35 +03:00
$newPermissions === ( Constants :: PERMISSION_READ | Constants :: PERMISSION_CREATE | Constants :: PERMISSION_UPDATE | Constants :: PERMISSION_DELETE )
2016-06-23 16:43:21 +03:00
) {
2016-01-27 22:32:04 +03:00
if ( ! $this -> shareManager -> shareApiLinkAllowPublicUpload ()) {
2016-07-20 11:41:09 +03:00
throw new OCSForbiddenException ( $this -> l -> t ( 'Public upload disabled by the administrator' ));
2016-01-27 22:32:04 +03:00
}
2016-01-28 15:17:16 +03:00
if ( ! ( $share -> getNode () instanceof \OCP\Files\Folder )) {
2016-07-20 11:41:09 +03:00
throw new OCSBadRequestException ( $this -> l -> t ( 'Public upload is only possible for publicly shared folders' ));
2016-01-27 22:32:04 +03:00
}
2016-06-23 16:43:21 +03:00
// normalize to correct public upload permissions
2017-12-01 16:49:35 +03:00
$newPermissions = Constants :: PERMISSION_READ | Constants :: PERMISSION_CREATE | Constants :: PERMISSION_UPDATE | Constants :: PERMISSION_DELETE ;
2016-01-27 22:32:04 +03:00
}
if ( $newPermissions !== null ) {
2020-05-06 22:39:49 +03:00
// TODO: It might make sense to have a dedicated setting to allow/deny converting link shares into federated ones
if (( $newPermissions & Constants :: PERMISSION_READ ) && $this -> shareManager -> outgoingServer2ServerSharesAllowed ()) {
$newPermissions |= Constants :: PERMISSION_SHARE ;
}
2016-01-27 22:32:04 +03:00
$share -> setPermissions ( $newPermissions );
2016-11-13 22:29:34 +03:00
$permissions = $newPermissions ;
2016-01-27 22:32:04 +03:00
}
2016-01-22 16:52:20 +03:00
2016-01-27 18:46:48 +03:00
if ( $expireDate === '' ) {
$share -> setExpirationDate ( null );
2020-04-10 11:35:09 +03:00
} elseif ( $expireDate !== null ) {
2016-01-27 18:46:48 +03:00
try {
$expireDate = $this -> parseDate ( $expireDate );
} catch ( \Exception $e ) {
2018-01-17 17:21:56 +03:00
throw new OCSBadRequestException ( $e -> getMessage (), $e );
2016-01-27 18:46:48 +03:00
}
$share -> setExpirationDate ( $expireDate );
}
2016-01-22 16:52:20 +03:00
2016-01-27 18:46:48 +03:00
if ( $password === '' ) {
$share -> setPassword ( null );
2020-04-10 11:35:09 +03:00
} elseif ( $password !== null ) {
2016-01-27 18:46:48 +03:00
$share -> setPassword ( $password );
2016-01-22 16:52:20 +03:00
}
2019-08-06 11:22:32 +03:00
// only link shares have labels
2020-04-29 17:43:39 +03:00
if ( $share -> getShareType () === IShare :: TYPE_LINK && $label !== null ) {
2020-06-12 15:29:36 +03:00
if ( strlen ( $label ) > 255 ) {
throw new OCSBadRequestException ( " Maxmimum label length is 255 " );
}
2018-10-17 11:50:58 +03:00
$share -> setLabel ( $label );
}
2018-10-15 13:27:56 +03:00
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 );
2020-04-10 11:35:09 +03:00
} elseif ( $sendPasswordByTalk !== null ) {
2018-10-15 13:27:56 +03:00
$share -> setSendPasswordByTalk ( false );
}
2019-08-06 11:22:32 +03:00
}
// NOT A LINK SHARE
else {
2017-03-29 17:50:23 +03:00
if ( $permissions !== null ) {
2016-01-27 18:46:48 +03:00
$share -> setPermissions ( $permissions );
}
2017-03-28 15:39:38 +03:00
2017-03-29 17:50:23 +03:00
if ( $expireDate === '' ) {
$share -> setExpirationDate ( null );
2020-04-10 11:35:09 +03:00
} elseif ( $expireDate !== null ) {
2017-03-29 17:50:23 +03:00
try {
$expireDate = $this -> parseDate ( $expireDate );
} catch ( \Exception $e ) {
2018-01-17 17:21:56 +03:00
throw new OCSBadRequestException ( $e -> getMessage (), $e );
2017-03-29 17:50:23 +03:00
}
$share -> setExpirationDate ( $expireDate );
}
2016-01-22 16:52:20 +03:00
}
try {
$share = $this -> shareManager -> updateShare ( $share );
2019-07-03 17:32:45 +03:00
} catch ( GenericShareException $e ) {
$code = $e -> getCode () === 0 ? 403 : $e -> getCode ();
throw new OCSException ( $e -> getHint (), $code );
2016-01-22 16:52:20 +03:00
} catch ( \Exception $e ) {
2018-01-17 17:21:56 +03:00
throw new OCSBadRequestException ( $e -> getMessage (), $e );
2016-01-22 16:52:20 +03:00
}
2016-08-09 11:04:29 +03:00
return new DataResponse ( $this -> formatShare ( $share ));
2016-01-22 16:52:20 +03:00
}
2020-01-07 10:53:33 +03:00
/**
* @ NoAdminRequired
*/
public function pendingShares () : DataResponse {
$pendingShares = [];
$shareTypes = [
IShare :: TYPE_USER ,
IShare :: TYPE_GROUP
];
foreach ( $shareTypes as $shareType ) {
$shares = $this -> shareManager -> getSharedWith ( $this -> currentUser , $shareType , null , - 1 , 0 );
foreach ( $shares as $share ) {
if ( $share -> getStatus () === IShare :: STATUS_PENDING || $share -> getStatus () === IShare :: STATUS_REJECTED ) {
$pendingShares [] = $share ;
}
}
}
2020-01-07 14:57:57 +03:00
$result = array_filter ( array_map ( function ( IShare $share ) {
$userFolder = $this -> rootFolder -> getUserFolder ( $share -> getSharedBy ());
$nodes = $userFolder -> getById ( $share -> getNodeId ());
if ( empty ( $nodes )) {
// fallback to guessing the path
$node = $userFolder -> get ( $share -> getTarget ());
if ( $node === null || $share -> getTarget () === '' ) {
return null ;
}
} else {
$node = $nodes [ 0 ];
}
try {
$formattedShare = $this -> formatShare ( $share , $node );
$formattedShare [ 'status' ] = $share -> getStatus ();
$formattedShare [ 'path' ] = $share -> getNode () -> getName ();
$formattedShare [ 'permissions' ] = 0 ;
return $formattedShare ;
} catch ( NotFoundException $e ) {
return null ;
}
}, $pendingShares ), function ( $entry ) {
return $entry !== null ;
});
2020-01-07 10:53:33 +03:00
return new DataResponse ( $result );
}
2019-08-22 04:17:17 +03:00
/**
* @ NoAdminRequired
*
* @ param string $id
* @ return DataResponse
* @ throws OCSNotFoundException
* @ throws OCSException
* @ throws OCSBadRequestException
*/
public function acceptShare ( string $id ) : DataResponse {
try {
$share = $this -> getShareById ( $id );
} catch ( ShareNotFound $e ) {
throw new OCSNotFoundException ( $this -> l -> t ( 'Wrong share ID, share doesn\'t exist' ));
}
2019-09-04 17:50:52 +03:00
if ( ! $this -> canAccessShare ( $share )) {
2019-08-22 04:17:17 +03:00
throw new OCSNotFoundException ( $this -> l -> t ( 'Wrong share ID, share doesn\'t exist' ));
}
try {
2019-09-04 17:50:52 +03:00
$this -> shareManager -> acceptShare ( $share , $this -> currentUser );
2019-08-22 04:17:17 +03:00
} catch ( GenericShareException $e ) {
$code = $e -> getCode () === 0 ? 403 : $e -> getCode ();
throw new OCSException ( $e -> getHint (), $code );
} catch ( \Exception $e ) {
throw new OCSBadRequestException ( $e -> getMessage (), $e );
}
return new DataResponse ();
}
2018-07-24 12:57:52 +03:00
/**
2019-08-16 16:09:15 +03:00
* Does the user have read permission on the share
*
* @ param \OCP\Share\IShare $share the share to check
* @ param boolean $checkGroups check groups as well ?
* @ return boolean
* @ throws NotFoundException
*
2018-07-24 12:57:52 +03:00
* @ suppress PhanUndeclaredClassMethod
*/
2018-04-23 21:31:57 +03:00
protected function canAccessShare ( \OCP\Share\IShare $share , bool $checkGroups = true ) : bool {
2016-01-27 11:02:12 +03:00
// A file with permissions 0 can't be accessed by us. So Don't show it
if ( $share -> getPermissions () === 0 ) {
return false ;
}
2015-11-24 11:37:17 +03:00
// Owner of the file and the sharer of the file can always get share
2019-08-06 11:22:32 +03:00
if ( $share -> getShareOwner () === $this -> currentUser
|| $share -> getSharedBy () === $this -> currentUser ) {
2015-11-24 11:37:17 +03:00
return true ;
}
2019-08-16 16:09:15 +03:00
// If the share is shared with you, you can access it!
2020-04-29 17:43:39 +03:00
if ( $share -> getShareType () === IShare :: TYPE_USER
2019-08-06 11:22:32 +03:00
&& $share -> getSharedWith () === $this -> currentUser ) {
2015-11-24 11:37:17 +03:00
return true ;
}
2019-08-16 16:09:15 +03:00
// Have reshare rights on the shared file/folder ?
// Does the currentUser have access to the shared file?
$userFolder = $this -> rootFolder -> getUserFolder ( $this -> currentUser );
$files = $userFolder -> getById ( $share -> getNodeId ());
if ( ! empty ( $files ) && $this -> shareProviderResharingRights ( $this -> currentUser , $share , $files [ 0 ])) {
return true ;
}
// If in the recipient group, you can see the share
2020-04-29 17:43:39 +03:00
if ( $checkGroups && $share -> getShareType () === IShare :: TYPE_GROUP ) {
2016-02-03 10:14:48 +03:00
$sharedWith = $this -> groupManager -> get ( $share -> getSharedWith ());
2016-10-21 21:25:07 +03:00
$user = $this -> userManager -> get ( $this -> currentUser );
2017-01-19 17:02:46 +03:00
if ( $user !== null && $sharedWith !== null && $sharedWith -> inGroup ( $user )) {
2016-02-03 10:14:48 +03:00
return true ;
}
2015-11-24 11:37:17 +03:00
}
2020-04-29 17:43:39 +03:00
if ( $share -> getShareType () === IShare :: TYPE_CIRCLE ) {
2017-03-17 22:48:33 +03:00
// TODO: have a sanity check like above?
return true ;
}
2020-04-29 17:43:39 +03:00
if ( $share -> getShareType () === IShare :: TYPE_ROOM ) {
2018-06-29 14:22:26 +03:00
try {
return $this -> getRoomShareHelper () -> canAccessShare ( $share , $this -> currentUser );
} catch ( QueryException $e ) {
return false ;
}
}
2020-12-03 18:03:35 +03:00
if ( $share -> getShareType () === IShare :: TYPE_DECK ) {
try {
return $this -> getDeckShareHelper () -> canAccessShare ( $share , $this -> currentUser );
} catch ( QueryException $e ) {
return false ;
}
}
2015-11-24 11:37:17 +03:00
return false ;
}
2015-12-15 11:54:50 +03:00
2019-08-26 14:11:09 +03:00
/**
* Does the user have edit permission on the share
*
* @ param \OCP\Share\IShare $share the share to check
* @ return boolean
*/
protected function canEditShare ( \OCP\Share\IShare $share ) : bool {
// A file with permissions 0 can't be accessed by us. So Don't show it
if ( $share -> getPermissions () === 0 ) {
return false ;
}
// The owner of the file and the creator of the share
// can always edit the share
if ( $share -> getShareOwner () === $this -> currentUser ||
$share -> getSharedBy () === $this -> currentUser
) {
return true ;
}
//! we do NOT support some kind of `admin` in groups.
//! You cannot edit shares shared to a group you're
//! a member of if you're not the share owner or the file owner!
return false ;
}
2019-08-26 14:11:09 +03:00
/**
* Does the user have delete permission on the share
*
* @ param \OCP\Share\IShare $share the share to check
* @ return boolean
*/
protected function canDeleteShare ( \OCP\Share\IShare $share ) : bool {
// A file with permissions 0 can't be accessed by us. So Don't show it
if ( $share -> getPermissions () === 0 ) {
return false ;
}
// if the user is the recipient, i can unshare
// the share with self
2020-04-29 17:43:39 +03:00
if ( $share -> getShareType () === IShare :: TYPE_USER &&
2019-08-26 14:11:09 +03:00
$share -> getSharedWith () === $this -> currentUser
) {
return true ;
}
// The owner of the file and the creator of the share
// can always delete the share
if ( $share -> getShareOwner () === $this -> currentUser ||
$share -> getSharedBy () === $this -> currentUser
) {
return true ;
}
return false ;
}
/**
* Does the user have delete permission on the share
* This differs from the canDeleteShare function as it only
* remove the share for the current user . It does NOT
* completely delete the share but only the mount point .
* It can then be restored from the deleted shares section .
*
* @ param \OCP\Share\IShare $share the share to check
* @ return boolean
*
* @ suppress PhanUndeclaredClassMethod
*/
protected function canDeleteShareFromSelf ( \OCP\Share\IShare $share ) : bool {
2019-09-04 17:50:52 +03:00
if ( $share -> getShareType () !== IShare :: TYPE_GROUP &&
2020-12-03 18:03:35 +03:00
$share -> getShareType () !== IShare :: TYPE_ROOM &&
$share -> getShareType () !== IShare :: TYPE_DECK
2019-08-26 14:11:09 +03:00
) {
return false ;
}
if ( $share -> getShareOwner () === $this -> currentUser ||
$share -> getSharedBy () === $this -> currentUser
) {
// Delete the whole share, not just for self
return false ;
}
// If in the recipient group, you can delete the share from self
2020-04-29 17:43:39 +03:00
if ( $share -> getShareType () === IShare :: TYPE_GROUP ) {
2019-08-26 14:11:09 +03:00
$sharedWith = $this -> groupManager -> get ( $share -> getSharedWith ());
$user = $this -> userManager -> get ( $this -> currentUser );
if ( $user !== null && $sharedWith !== null && $sharedWith -> inGroup ( $user )) {
return true ;
}
}
2020-04-29 17:43:39 +03:00
if ( $share -> getShareType () === IShare :: TYPE_ROOM ) {
2019-08-26 14:11:09 +03:00
try {
return $this -> getRoomShareHelper () -> canAccessShare ( $share , $this -> currentUser );
} catch ( QueryException $e ) {
return false ;
}
}
2020-12-03 18:03:35 +03:00
if ( $share -> getShareType () === IShare :: TYPE_DECK ) {
try {
return $this -> getDeckShareHelper () -> canAccessShare ( $share , $this -> currentUser );
} catch ( QueryException $e ) {
return false ;
}
}
2019-08-26 14:11:09 +03:00
return false ;
}
2015-12-15 11:54:50 +03:00
/**
* Make sure that the passed date is valid ISO 8601
* So YYYY - MM - DD
* If not throw an exception
*
* @ param string $expireDate
*
* @ throws \Exception
* @ return \DateTime
*/
2018-04-23 21:31:57 +03:00
private function parseDate ( string $expireDate ) : \DateTime {
2015-12-15 11:54:50 +03:00
try {
$date = new \DateTime ( $expireDate );
} catch ( \Exception $e ) {
throw new \Exception ( 'Invalid date. Format must be YYYY-MM-DD' );
}
2016-09-21 18:35:09 +03:00
$date -> setTime ( 0 , 0 , 0 );
2015-12-15 11:54:50 +03:00
return $date ;
}
2016-03-07 18:10:27 +03:00
/**
* Since we have multiple providers but the OCS Share API v1 does
* not support this we need to check all backends .
*
* @ param string $id
* @ return \OCP\Share\IShare
* @ throws ShareNotFound
*/
2018-04-23 21:31:57 +03:00
private function getShareById ( string $id ) : IShare {
2016-03-07 18:10:27 +03:00
$share = null ;
// First check if it is an internal share.
try {
Fix getting the information of group share as a sharee
When the receiver of a group share modifies it (for example, by moving
it to a different folder) the original share is not modified, but a
"ghost" share that keeps track of the changes made by that specific user
is used instead.
By default, the method "getShareById" in the share provider returns the
share from the point of view of the sharer, but it can be used too to
get the share from the point of view of a sharee by providing the
"recipient" parameter (and if the sharee is not found then the share is
returned from the point of view of the sharer).
The "ShareAPIController" always formats the share from the point of view
of the current user, but when getting the information of a specific
share the "recipient" parameter was not given, so it was always returned
from the point of view of the sharer, even if the current user was a
sharee. Now the "recipient" parameter is set to the current user, and
thus the information of the share is returned from the point of view of
the current user, be it the sharer or a sharee.
Note that this special behaviour of "getShareById" happens only with
group shares; with other types of shares the share is the same for the
sharer and the sharee, and thus the parameter is ignored; it was added
for them too just for consistency.
Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
2018-06-28 13:34:04 +03:00
$share = $this -> shareManager -> getShareById ( 'ocinternal:' . $id , $this -> currentUser );
2016-07-29 16:38:31 +03:00
return $share ;
} catch ( ShareNotFound $e ) {
// Do nothing, just try the other share type
}
2017-03-17 22:48:33 +03:00
try {
2020-04-29 17:43:39 +03:00
if ( $this -> shareManager -> shareProviderExists ( IShare :: TYPE_CIRCLE )) {
Fix getting the information of group share as a sharee
When the receiver of a group share modifies it (for example, by moving
it to a different folder) the original share is not modified, but a
"ghost" share that keeps track of the changes made by that specific user
is used instead.
By default, the method "getShareById" in the share provider returns the
share from the point of view of the sharer, but it can be used too to
get the share from the point of view of a sharee by providing the
"recipient" parameter (and if the sharee is not found then the share is
returned from the point of view of the sharer).
The "ShareAPIController" always formats the share from the point of view
of the current user, but when getting the information of a specific
share the "recipient" parameter was not given, so it was always returned
from the point of view of the sharer, even if the current user was a
sharee. Now the "recipient" parameter is set to the current user, and
thus the information of the share is returned from the point of view of
the current user, be it the sharer or a sharee.
Note that this special behaviour of "getShareById" happens only with
group shares; with other types of shares the share is the same for the
sharer and the sharee, and thus the parameter is ignored; it was added
for them too just for consistency.
Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
2018-06-28 13:34:04 +03:00
$share = $this -> shareManager -> getShareById ( 'ocCircleShare:' . $id , $this -> currentUser );
2017-03-17 22:48:33 +03:00
return $share ;
}
} catch ( ShareNotFound $e ) {
// Do nothing, just try the other share type
}
2016-07-29 16:38:31 +03:00
try {
2020-04-29 17:43:39 +03:00
if ( $this -> shareManager -> shareProviderExists ( IShare :: TYPE_EMAIL )) {
Fix getting the information of group share as a sharee
When the receiver of a group share modifies it (for example, by moving
it to a different folder) the original share is not modified, but a
"ghost" share that keeps track of the changes made by that specific user
is used instead.
By default, the method "getShareById" in the share provider returns the
share from the point of view of the sharer, but it can be used too to
get the share from the point of view of a sharee by providing the
"recipient" parameter (and if the sharee is not found then the share is
returned from the point of view of the sharer).
The "ShareAPIController" always formats the share from the point of view
of the current user, but when getting the information of a specific
share the "recipient" parameter was not given, so it was always returned
from the point of view of the sharer, even if the current user was a
sharee. Now the "recipient" parameter is set to the current user, and
thus the information of the share is returned from the point of view of
the current user, be it the sharer or a sharee.
Note that this special behaviour of "getShareById" happens only with
group shares; with other types of shares the share is the same for the
sharer and the sharee, and thus the parameter is ignored; it was added
for them too just for consistency.
Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
2018-06-28 13:34:04 +03:00
$share = $this -> shareManager -> getShareById ( 'ocMailShare:' . $id , $this -> currentUser );
2016-10-27 13:27:09 +03:00
return $share ;
2016-03-07 18:10:27 +03:00
}
2016-10-27 13:27:09 +03:00
} catch ( ShareNotFound $e ) {
// Do nothing, just try the other share type
}
2016-03-07 18:10:27 +03:00
2018-06-29 14:22:26 +03:00
try {
$share = $this -> shareManager -> getShareById ( 'ocRoomShare:' . $id , $this -> currentUser );
return $share ;
} catch ( ShareNotFound $e ) {
// Do nothing, just try the other share type
}
2020-12-03 18:03:35 +03:00
try {
if ( $this -> shareManager -> shareProviderExists ( IShare :: TYPE_DECK )) {
$share = $this -> shareManager -> getShareById ( 'deck:' . $id , $this -> currentUser );
return $share ;
}
} catch ( ShareNotFound $e ) {
// Do nothing, just try the other share type
}
2016-10-27 13:27:09 +03:00
if ( ! $this -> shareManager -> outgoingServer2ServerSharesAllowed ()) {
throw new ShareNotFound ();
2016-03-07 18:10:27 +03:00
}
Fix getting the information of group share as a sharee
When the receiver of a group share modifies it (for example, by moving
it to a different folder) the original share is not modified, but a
"ghost" share that keeps track of the changes made by that specific user
is used instead.
By default, the method "getShareById" in the share provider returns the
share from the point of view of the sharer, but it can be used too to
get the share from the point of view of a sharee by providing the
"recipient" parameter (and if the sharee is not found then the share is
returned from the point of view of the sharer).
The "ShareAPIController" always formats the share from the point of view
of the current user, but when getting the information of a specific
share the "recipient" parameter was not given, so it was always returned
from the point of view of the sharer, even if the current user was a
sharee. Now the "recipient" parameter is set to the current user, and
thus the information of the share is returned from the point of view of
the current user, be it the sharer or a sharee.
Note that this special behaviour of "getShareById" happens only with
group shares; with other types of shares the share is the same for the
sharer and the sharee, and thus the parameter is ignored; it was added
for them too just for consistency.
Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
2018-06-28 13:34:04 +03:00
$share = $this -> shareManager -> getShareById ( 'ocFederatedSharing:' . $id , $this -> currentUser );
2016-03-07 18:10:27 +03:00
return $share ;
}
2016-07-20 11:11:01 +03:00
/**
* Lock a Node
2016-09-21 18:35:09 +03:00
*
2016-07-20 11:11:01 +03:00
* @ param \OCP\Files\Node $node
2018-04-23 21:31:57 +03:00
* @ throws LockedException
2016-07-20 11:11:01 +03:00
*/
private function lock ( \OCP\Files\Node $node ) {
$node -> lock ( ILockingProvider :: LOCK_SHARED );
$this -> lockedNode = $node ;
}
/**
* Cleanup the remaining locks
2020-08-14 16:10:48 +03:00
* @ throws LockedException
2016-07-20 11:11:01 +03:00
*/
public function cleanup () {
if ( $this -> lockedNode !== null ) {
$this -> lockedNode -> unlock ( ILockingProvider :: LOCK_SHARED );
}
}
2018-06-29 14:22:26 +03:00
/**
* Returns the helper of ShareAPIController for room shares .
*
* If the Talk application is not enabled or the helper is not available
* a QueryException is thrown instead .
*
2019-09-05 16:32:58 +03:00
* @ return \OCA\Talk\Share\Helper\ShareAPIController
2018-06-29 14:22:26 +03:00
* @ throws QueryException
*/
private function getRoomShareHelper () {
if ( ! $this -> appManager -> isEnabledForUser ( 'spreed' )) {
throw new QueryException ();
}
2020-12-09 15:19:14 +03:00
return $this -> serverContainer -> get ( '\OCA\Talk\Share\Helper\ShareAPIController' );
2018-06-29 14:22:26 +03:00
}
2018-10-29 12:03:52 +03:00
2020-12-03 18:03:35 +03:00
/**
* Returns the helper of ShareAPIHelper for deck shares .
*
* If the Deck application is not enabled or the helper is not available
* a QueryException is thrown instead .
*
* @ return \OCA\Deck\Sharing\ShareAPIHelper
* @ throws QueryException
*/
private function getDeckShareHelper () {
if ( ! $this -> appManager -> isEnabledForUser ( 'deck' )) {
throw new QueryException ();
}
2020-12-09 15:19:14 +03:00
return $this -> serverContainer -> get ( '\OCA\Deck\Sharing\ShareAPIHelper' );
2020-12-03 18:03:35 +03:00
}
2018-10-29 12:03:52 +03:00
2019-06-25 23:34:38 +03:00
/**
* @ param string $viewer
* @ param Node $node
* @ param bool $reShares
*
* @ return IShare []
*/
private function getSharesFromNode ( string $viewer , $node , bool $reShares ) : array {
$providers = [
2020-04-29 17:43:39 +03:00
IShare :: TYPE_USER ,
IShare :: TYPE_GROUP ,
IShare :: TYPE_LINK ,
IShare :: TYPE_EMAIL ,
IShare :: TYPE_EMAIL ,
IShare :: TYPE_CIRCLE ,
2020-12-03 18:03:35 +03:00
IShare :: TYPE_ROOM ,
IShare :: TYPE_DECK
2019-06-25 23:34:38 +03:00
];
// Should we assume that the (currentUser) viewer is the owner of the node !?
$shares = [];
foreach ( $providers as $provider ) {
if ( ! $this -> shareManager -> shareProviderExists ( $provider )) {
continue ;
}
$providerShares =
$this -> shareManager -> getSharesBy ( $viewer , $provider , $node , $reShares , - 1 , 0 );
$shares = array_merge ( $shares , $providerShares );
}
if ( $this -> shareManager -> outgoingServer2ServerSharesAllowed ()) {
$federatedShares = $this -> shareManager -> getSharesBy (
2020-04-29 17:43:39 +03:00
$this -> currentUser , IShare :: TYPE_REMOTE , $node , $reShares , - 1 , 0
2019-06-25 23:34:38 +03:00
);
$shares = array_merge ( $shares , $federatedShares );
}
if ( $this -> shareManager -> outgoingServer2ServerGroupSharesAllowed ()) {
$federatedShares = $this -> shareManager -> getSharesBy (
2020-04-29 17:43:39 +03:00
$this -> currentUser , IShare :: TYPE_REMOTE_GROUP , $node , $reShares , - 1 , 0
2019-06-25 23:34:38 +03:00
);
$shares = array_merge ( $shares , $federatedShares );
}
return $shares ;
}
/**
* @ param Node $node
*
* @ throws SharingRightsException
*/
private function confirmSharingRights ( Node $node ) : void {
if ( ! $this -> hasResharingRights ( $this -> currentUser , $node )) {
throw new SharingRightsException ( 'no sharing rights on this item' );
}
}
/**
* @ param string $viewer
* @ param Node $node
*
* @ return bool
*/
private function hasResharingRights ( $viewer , $node ) : bool {
2020-01-02 15:33:27 +03:00
if ( $viewer === $node -> getOwner () -> getUID ()) {
return true ;
}
2019-06-25 23:34:38 +03:00
foreach ([ $node , $node -> getParent ()] as $node ) {
$shares = $this -> getSharesFromNode ( $viewer , $node , true );
foreach ( $shares as $share ) {
try {
if ( $this -> shareProviderResharingRights ( $viewer , $share , $node )) {
return true ;
}
} catch ( InvalidPathException | NotFoundException $e ) {
}
}
}
return false ;
}
2018-10-29 12:03:52 +03:00
/**
* Returns if we can find resharing rights in an IShare object for a specific user .
*
2018-11-01 15:41:19 +03:00
* @ suppress PhanUndeclaredClassMethod
*
2018-10-29 12:03:52 +03:00
* @ param string $userId
* @ param IShare $share
2018-11-01 15:41:19 +03:00
* @ param Node $node
2019-06-25 23:34:38 +03:00
*
2018-10-29 12:03:52 +03:00
* @ return bool
2018-11-01 15:41:19 +03:00
* @ throws NotFoundException
2019-06-25 23:34:38 +03:00
* @ throws InvalidPathException
2018-10-29 12:03:52 +03:00
*/
2018-11-01 17:01:01 +03:00
private function shareProviderResharingRights ( string $userId , IShare $share , $node ) : bool {
2018-10-29 12:03:52 +03:00
if ( $share -> getShareOwner () === $userId ) {
return true ;
}
2018-11-01 15:41:19 +03:00
// we check that current user have parent resharing rights on the current file
2019-06-25 23:34:38 +03:00
if ( $node !== null && ( $node -> getPermissions () & Constants :: PERMISSION_SHARE ) !== 0 ) {
2018-11-01 15:41:19 +03:00
return true ;
}
2018-10-29 12:03:52 +03:00
if (( \OCP\Constants :: PERMISSION_SHARE & $share -> getPermissions ()) === 0 ) {
return false ;
}
2020-05-29 02:41:06 +03:00
if ( $share -> getShareType () === IShare :: TYPE_USER && $share -> getSharedWith () === $userId ) {
2018-10-29 12:03:52 +03:00
return true ;
}
2020-05-29 02:41:06 +03:00
if ( $share -> getShareType () === IShare :: TYPE_GROUP && $this -> groupManager -> isInGroup ( $userId , $share -> getSharedWith ())) {
2018-10-29 12:03:52 +03:00
return true ;
}
2020-05-29 02:41:06 +03:00
if ( $share -> getShareType () === IShare :: TYPE_CIRCLE && \OC :: $server -> getAppManager () -> isEnabledForUser ( 'circles' )
2019-08-06 11:22:32 +03:00
&& class_exists ( '\OCA\Circles\Api\v1\Circles' )) {
2018-10-30 11:58:43 +03:00
$hasCircleId = ( substr ( $share -> getSharedWith (), - 1 ) === ']' );
$shareWithStart = ( $hasCircleId ? strrpos ( $share -> getSharedWith (), '[' ) + 1 : 0 );
$shareWithLength = ( $hasCircleId ? - 1 : strpos ( $share -> getSharedWith (), ' ' ));
2020-11-13 12:58:54 +03:00
if ( $shareWithLength === false ) {
$sharedWith = substr ( $share -> getSharedWith (), $shareWithStart );
} else {
$sharedWith = substr ( $share -> getSharedWith (), $shareWithStart , $shareWithLength );
2018-10-30 11:58:43 +03:00
}
try {
$member = \OCA\Circles\Api\v1\Circles :: getMember ( $sharedWith , $userId , 1 );
2018-10-30 12:02:38 +03:00
if ( $member -> getLevel () >= 4 ) {
2018-10-30 11:58:43 +03:00
return true ;
}
2018-10-30 12:02:38 +03:00
return false ;
2018-10-30 11:58:43 +03:00
} catch ( QueryException $e ) {
return false ;
}
}
2018-10-29 12:03:52 +03:00
return false ;
}
2019-08-26 14:11:09 +03:00
2019-10-25 11:45:49 +03:00
/**
* Get all the shares for the current user
*
* @ param Node | null $path
* @ param boolean $reshares
2020-08-14 16:10:48 +03:00
* @ return IShare []
2019-10-25 11:45:49 +03:00
*/
private function getAllShares ( ? Node $path = null , bool $reshares = false ) {
// Get all shares
2020-04-29 17:43:39 +03:00
$userShares = $this -> shareManager -> getSharesBy ( $this -> currentUser , IShare :: TYPE_USER , $path , $reshares , - 1 , 0 );
$groupShares = $this -> shareManager -> getSharesBy ( $this -> currentUser , IShare :: TYPE_GROUP , $path , $reshares , - 1 , 0 );
$linkShares = $this -> shareManager -> getSharesBy ( $this -> currentUser , IShare :: TYPE_LINK , $path , $reshares , - 1 , 0 );
2019-10-25 11:45:49 +03:00
// EMAIL SHARES
2020-04-29 17:43:39 +03:00
$mailShares = $this -> shareManager -> getSharesBy ( $this -> currentUser , IShare :: TYPE_EMAIL , $path , $reshares , - 1 , 0 );
2019-10-25 11:45:49 +03:00
// CIRCLE SHARES
2020-04-29 17:43:39 +03:00
$circleShares = $this -> shareManager -> getSharesBy ( $this -> currentUser , IShare :: TYPE_CIRCLE , $path , $reshares , - 1 , 0 );
2019-10-25 11:45:49 +03:00
// TALK SHARES
2020-04-29 17:43:39 +03:00
$roomShares = $this -> shareManager -> getSharesBy ( $this -> currentUser , IShare :: TYPE_ROOM , $path , $reshares , - 1 , 0 );
2019-10-25 11:45:49 +03:00
2020-12-03 18:03:35 +03:00
$deckShares = $this -> shareManager -> getSharesBy ( $this -> currentUser , IShare :: TYPE_DECK , $path , $reshares , - 1 , 0 );
2019-10-25 11:45:49 +03:00
// FEDERATION
if ( $this -> shareManager -> outgoingServer2ServerSharesAllowed ()) {
2020-04-29 17:43:39 +03:00
$federatedShares = $this -> shareManager -> getSharesBy ( $this -> currentUser , IShare :: TYPE_REMOTE , $path , $reshares , - 1 , 0 );
2019-10-25 11:45:49 +03:00
} else {
$federatedShares = [];
}
if ( $this -> shareManager -> outgoingServer2ServerGroupSharesAllowed ()) {
2020-04-29 17:43:39 +03:00
$federatedGroupShares = $this -> shareManager -> getSharesBy ( $this -> currentUser , IShare :: TYPE_REMOTE_GROUP , $path , $reshares , - 1 , 0 );
2019-10-25 11:45:49 +03:00
} else {
$federatedGroupShares = [];
}
2020-12-03 18:03:35 +03:00
return array_merge ( $userShares , $groupShares , $linkShares , $mailShares , $circleShares , $roomShares , $deckShares , $federatedShares , $federatedGroupShares );
2019-10-25 11:45:49 +03:00
}
2019-06-25 23:34:38 +03:00
/**
* merging already formatted shares .
* We ' ll make an associative array to easily detect duplicate Ids .
* Keys _needs_ to be removed after all shares are retrieved and merged .
*
* @ param array $shares
* @ param array $newShares
*/
private function mergeFormattedShares ( array & $shares , array $newShares ) {
foreach ( $newShares as $newShare ) {
if ( ! array_key_exists ( $newShare [ 'id' ], $shares )) {
$shares [ $newShare [ 'id' ]] = $newShare ;
}
}
}
2015-10-30 15:10:08 +03:00
}