956 lines
30 KiB
PHP
956 lines
30 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
*
|
|
* @author Bjoern Schiessle <bjoern@schiessle.org>
|
|
* @author Joas Schilling <coding@schilljs.com>
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
|
* @author Maxence Lange <maxence@nextcloud.com>
|
|
* @author Michael Jobst <mjobst+github@tecratech.de>
|
|
* @author Robin Appelman <robin@icewind.nl>
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
|
*
|
|
* @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,
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*/
|
|
namespace OCA\Files_Sharing\Controller;
|
|
|
|
use OCA\Files\Helper;
|
|
use OCP\AppFramework\Http\DataResponse;
|
|
use OCP\AppFramework\OCS\OCSBadRequestException;
|
|
use OCP\AppFramework\OCS\OCSException;
|
|
use OCP\AppFramework\OCS\OCSForbiddenException;
|
|
use OCP\AppFramework\OCS\OCSNotFoundException;
|
|
use OCP\AppFramework\OCSController;
|
|
use OCP\Constants;
|
|
use OCP\Files\Node;
|
|
use OCP\Files\NotFoundException;
|
|
use OCP\IConfig;
|
|
use OCP\IGroupManager;
|
|
use OCP\IL10N;
|
|
use OCP\IUserManager;
|
|
use OCP\IRequest;
|
|
use OCP\IURLGenerator;
|
|
use OCP\Files\IRootFolder;
|
|
use OCP\Lock\LockedException;
|
|
use OCP\Share\IManager;
|
|
use OCP\Share\Exceptions\ShareNotFound;
|
|
use OCP\Share\Exceptions\GenericShareException;
|
|
use OCP\Lock\ILockingProvider;
|
|
use OCP\Share\IShare;
|
|
|
|
/**
|
|
* Class Share20OCS
|
|
*
|
|
* @package OCA\Files_Sharing\API
|
|
*/
|
|
class ShareAPIController extends OCSController {
|
|
|
|
/** @var IManager */
|
|
private $shareManager;
|
|
/** @var IGroupManager */
|
|
private $groupManager;
|
|
/** @var IUserManager */
|
|
private $userManager;
|
|
/** @var IRequest */
|
|
protected $request;
|
|
/** @var IRootFolder */
|
|
private $rootFolder;
|
|
/** @var IURLGenerator */
|
|
private $urlGenerator;
|
|
/** @var string */
|
|
private $currentUser;
|
|
/** @var IL10N */
|
|
private $l;
|
|
/** @var \OCP\Files\Node */
|
|
private $lockedNode;
|
|
/** @var IConfig */
|
|
private $config;
|
|
|
|
/**
|
|
* Share20OCS constructor.
|
|
*
|
|
* @param string $appName
|
|
* @param IRequest $request
|
|
* @param IManager $shareManager
|
|
* @param IGroupManager $groupManager
|
|
* @param IUserManager $userManager
|
|
* @param IRootFolder $rootFolder
|
|
* @param IURLGenerator $urlGenerator
|
|
* @param string $userId
|
|
* @param IL10N $l10n
|
|
* @param IConfig $config
|
|
*/
|
|
public function __construct(
|
|
$appName,
|
|
IRequest $request,
|
|
IManager $shareManager,
|
|
IGroupManager $groupManager,
|
|
IUserManager $userManager,
|
|
IRootFolder $rootFolder,
|
|
IURLGenerator $urlGenerator,
|
|
$userId,
|
|
IL10N $l10n,
|
|
IConfig $config
|
|
) {
|
|
parent::__construct($appName, $request);
|
|
|
|
$this->shareManager = $shareManager;
|
|
$this->userManager = $userManager;
|
|
$this->groupManager = $groupManager;
|
|
$this->request = $request;
|
|
$this->rootFolder = $rootFolder;
|
|
$this->urlGenerator = $urlGenerator;
|
|
$this->currentUser = $userId;
|
|
$this->l = $l10n;
|
|
$this->config = $config;
|
|
}
|
|
|
|
/**
|
|
* Convert an IShare to an array for OCS output
|
|
*
|
|
* @param \OCP\Share\IShare $share
|
|
* @param Node|null $recipientNode
|
|
* @return array
|
|
* @throws NotFoundException In case the node can't be resolved.
|
|
*/
|
|
protected function formatShare(\OCP\Share\IShare $share, Node $recipientNode = null) {
|
|
$sharedBy = $this->userManager->get($share->getSharedBy());
|
|
$shareOwner = $this->userManager->get($share->getShareOwner());
|
|
|
|
$result = [
|
|
'id' => $share->getId(),
|
|
'share_type' => $share->getShareType(),
|
|
'uid_owner' => $share->getSharedBy(),
|
|
'displayname_owner' => $sharedBy !== null ? $sharedBy->getDisplayName() : $share->getSharedBy(),
|
|
'permissions' => $share->getPermissions(),
|
|
'stime' => $share->getShareTime()->getTimestamp(),
|
|
'parent' => null,
|
|
'expiration' => null,
|
|
'token' => null,
|
|
'uid_file_owner' => $share->getShareOwner(),
|
|
'displayname_file_owner' => $shareOwner !== null ? $shareOwner->getDisplayName() : $share->getShareOwner(),
|
|
];
|
|
|
|
$userFolder = $this->rootFolder->getUserFolder($this->currentUser);
|
|
if ($recipientNode) {
|
|
$node = $recipientNode;
|
|
} else {
|
|
$nodes = $userFolder->getById($share->getNodeId());
|
|
|
|
if (empty($nodes)) {
|
|
// fallback to guessing the path
|
|
$node = $userFolder->get($share->getTarget());
|
|
if ($node === null) {
|
|
throw new NotFoundException();
|
|
}
|
|
} else {
|
|
$node = $nodes[0];
|
|
}
|
|
}
|
|
|
|
$result['path'] = $userFolder->getRelativePath($node->getPath());
|
|
if ($node instanceOf \OCP\Files\Folder) {
|
|
$result['item_type'] = 'folder';
|
|
} else {
|
|
$result['item_type'] = 'file';
|
|
}
|
|
$result['mimetype'] = $node->getMimetype();
|
|
$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();
|
|
$result['file_target'] = $share->getTarget();
|
|
|
|
$expiration = $share->getExpirationDate();
|
|
if ($expiration !== null) {
|
|
$result['expiration'] = $expiration->format('Y-m-d 00:00:00');
|
|
}
|
|
|
|
if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) {
|
|
$sharedWith = $this->userManager->get($share->getSharedWith());
|
|
$result['share_with'] = $share->getSharedWith();
|
|
$result['share_with_displayname'] = $sharedWith !== null ? $sharedWith->getDisplayName() : $share->getSharedWith();
|
|
} else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) {
|
|
$group = $this->groupManager->get($share->getSharedWith());
|
|
$result['share_with'] = $share->getSharedWith();
|
|
$result['share_with_displayname'] = $group !== null ? $group->getDisplayName() : $share->getSharedWith();
|
|
} else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) {
|
|
|
|
$result['share_with'] = $share->getPassword();
|
|
$result['share_with_displayname'] = $share->getPassword();
|
|
|
|
$result['token'] = $share->getToken();
|
|
$result['url'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare', ['token' => $share->getToken()]);
|
|
|
|
} else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_REMOTE) {
|
|
$result['share_with'] = $share->getSharedWith();
|
|
$result['share_with_displayname'] = $this->getDisplayNameFromAddressBook($share->getSharedWith(), 'CLOUD');
|
|
$result['token'] = $share->getToken();
|
|
} else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_EMAIL) {
|
|
$result['share_with'] = $share->getSharedWith();
|
|
$result['password'] = $share->getPassword();
|
|
$result['share_with_displayname'] = $this->getDisplayNameFromAddressBook($share->getSharedWith(), 'EMAIL');
|
|
$result['token'] = $share->getToken();
|
|
} else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_CIRCLE) {
|
|
$result['share_with_displayname'] = $share->getSharedWith();
|
|
$result['share_with'] = explode(' ', $share->getSharedWith(), 2)[0];
|
|
}
|
|
|
|
|
|
$result['mail_send'] = $share->getMailSend() ? 1 : 0;
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
private function getDisplayNameFromAddressBook($query, $property) {
|
|
// 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) {
|
|
foreach($r[$property] as $value) {
|
|
if ($value === $query) {
|
|
return $r['FN'];
|
|
}
|
|
}
|
|
}
|
|
|
|
return $query;
|
|
}
|
|
|
|
/**
|
|
* Get a specific share by id
|
|
*
|
|
* @NoAdminRequired
|
|
*
|
|
* @param string $id
|
|
* @return DataResponse
|
|
* @throws OCSNotFoundException
|
|
*/
|
|
public function getShare($id) {
|
|
try {
|
|
$share = $this->getShareById($id);
|
|
} catch (ShareNotFound $e) {
|
|
throw new OCSNotFoundException($this->l->t('Wrong share ID, share doesn\'t exist'));
|
|
}
|
|
|
|
if ($this->canAccessShare($share)) {
|
|
try {
|
|
$share = $this->formatShare($share);
|
|
return new DataResponse([$share]);
|
|
} catch (NotFoundException $e) {
|
|
//Fall trough
|
|
}
|
|
}
|
|
|
|
throw new OCSNotFoundException($this->l->t('Wrong share ID, share doesn\'t exist'));
|
|
}
|
|
|
|
/**
|
|
* Delete a share
|
|
*
|
|
* @NoAdminRequired
|
|
*
|
|
* @param string $id
|
|
* @return DataResponse
|
|
* @throws OCSNotFoundException
|
|
*/
|
|
public function deleteShare($id) {
|
|
try {
|
|
$share = $this->getShareById($id);
|
|
} catch (ShareNotFound $e) {
|
|
throw new OCSNotFoundException($this->l->t('Wrong share ID, share doesn\'t exist'));
|
|
}
|
|
|
|
try {
|
|
$this->lock($share->getNode());
|
|
} catch (LockedException $e) {
|
|
throw new OCSNotFoundException($this->l->t('could not delete share'));
|
|
}
|
|
|
|
if (!$this->canAccessShare($share)) {
|
|
throw new OCSNotFoundException($this->l->t('Could not delete share'));
|
|
}
|
|
|
|
if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP &&
|
|
$share->getShareOwner() !== $this->currentUser &&
|
|
$share->getSharedBy() !== $this->currentUser) {
|
|
$this->shareManager->deleteFromSelf($share, $this->currentUser);
|
|
} else {
|
|
$this->shareManager->deleteShare($share);
|
|
}
|
|
|
|
return new DataResponse();
|
|
}
|
|
|
|
/**
|
|
* @NoAdminRequired
|
|
*
|
|
* @param string $path
|
|
* @param int $permissions
|
|
* @param int $shareType
|
|
* @param string $shareWith
|
|
* @param string $publicUpload
|
|
* @param string $password
|
|
* @param string $expireDate
|
|
*
|
|
* @return DataResponse
|
|
* @throws OCSNotFoundException
|
|
* @throws OCSForbiddenException
|
|
* @throws OCSBadRequestException
|
|
* @throws OCSException
|
|
*
|
|
* @suppress PhanUndeclaredClassMethod
|
|
*/
|
|
public function createShare(
|
|
$path = null,
|
|
$permissions = null,
|
|
$shareType = -1,
|
|
$shareWith = null,
|
|
$publicUpload = 'false',
|
|
$password = '',
|
|
$expireDate = ''
|
|
) {
|
|
$share = $this->shareManager->newShare();
|
|
|
|
if ($permissions === null) {
|
|
$permissions = $this->config->getAppValue('core', 'shareapi_default_permissions', Constants::PERMISSION_ALL);
|
|
}
|
|
|
|
// Verify path
|
|
if ($path === null) {
|
|
throw new OCSNotFoundException($this->l->t('Please specify a file or folder path'));
|
|
}
|
|
|
|
$userFolder = $this->rootFolder->getUserFolder($this->currentUser);
|
|
try {
|
|
$path = $userFolder->get($path);
|
|
} catch (NotFoundException $e) {
|
|
throw new OCSNotFoundException($this->l->t('Wrong path, file/folder doesn\'t exist'));
|
|
}
|
|
|
|
$share->setNode($path);
|
|
|
|
try {
|
|
$this->lock($share->getNode());
|
|
} catch (LockedException $e) {
|
|
throw new OCSNotFoundException($this->l->t('Could not create share'));
|
|
}
|
|
|
|
if ($permissions < 0 || $permissions > Constants::PERMISSION_ALL) {
|
|
throw new OCSNotFoundException($this->l->t('invalid permissions'));
|
|
}
|
|
|
|
// Shares always require read permissions
|
|
$permissions |= Constants::PERMISSION_READ;
|
|
|
|
if ($path instanceof \OCP\Files\File) {
|
|
// Single file shares should never have delete or create permissions
|
|
$permissions &= ~Constants::PERMISSION_DELETE;
|
|
$permissions &= ~Constants::PERMISSION_CREATE;
|
|
}
|
|
|
|
/*
|
|
* 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.
|
|
*/
|
|
if ($path->getStorage()->instanceOfStorage('OCA\Files_Sharing\External\Storage')) {
|
|
$permissions &= ~($permissions & ~$path->getPermissions());
|
|
}
|
|
|
|
if ($shareType === \OCP\Share::SHARE_TYPE_USER) {
|
|
// Valid user is required to share
|
|
if ($shareWith === null || !$this->userManager->userExists($shareWith)) {
|
|
throw new OCSNotFoundException($this->l->t('Please specify a valid user'));
|
|
}
|
|
$share->setSharedWith($shareWith);
|
|
$share->setPermissions($permissions);
|
|
} else if ($shareType === \OCP\Share::SHARE_TYPE_GROUP) {
|
|
if (!$this->shareManager->allowGroupSharing()) {
|
|
throw new OCSNotFoundException($this->l->t('Group sharing is disabled by the administrator'));
|
|
}
|
|
|
|
// Valid group is required to share
|
|
if ($shareWith === null || !$this->groupManager->groupExists($shareWith)) {
|
|
throw new OCSNotFoundException($this->l->t('Please specify a valid group'));
|
|
}
|
|
$share->setSharedWith($shareWith);
|
|
$share->setPermissions($permissions);
|
|
} else if ($shareType === \OCP\Share::SHARE_TYPE_LINK) {
|
|
//Can we even share links?
|
|
if (!$this->shareManager->shareApiAllowLinks()) {
|
|
throw new OCSNotFoundException($this->l->t('Public link sharing is disabled by the administrator'));
|
|
}
|
|
|
|
/*
|
|
* For now we only allow 1 link share.
|
|
* Return the existing link share if this is a duplicate
|
|
*/
|
|
$existingShares = $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_LINK, $path, false, 1, 0);
|
|
if (!empty($existingShares)) {
|
|
return new DataResponse($this->formatShare($existingShares[0]));
|
|
}
|
|
|
|
if ($publicUpload === 'true') {
|
|
// Check if public upload is allowed
|
|
if (!$this->shareManager->shareApiLinkAllowPublicUpload()) {
|
|
throw new OCSForbiddenException($this->l->t('Public upload disabled by the administrator'));
|
|
}
|
|
|
|
// Public upload can only be set for folders
|
|
if ($path instanceof \OCP\Files\File) {
|
|
throw new OCSNotFoundException($this->l->t('Public upload is only possible for publicly shared folders'));
|
|
}
|
|
|
|
$share->setPermissions(
|
|
Constants::PERMISSION_READ |
|
|
Constants::PERMISSION_CREATE |
|
|
Constants::PERMISSION_UPDATE |
|
|
Constants::PERMISSION_DELETE
|
|
);
|
|
} else {
|
|
$share->setPermissions(Constants::PERMISSION_READ);
|
|
}
|
|
|
|
// Set password
|
|
if ($password !== '') {
|
|
$share->setPassword($password);
|
|
}
|
|
|
|
//Expire date
|
|
if ($expireDate !== '') {
|
|
try {
|
|
$expireDate = $this->parseDate($expireDate);
|
|
$share->setExpirationDate($expireDate);
|
|
} catch (\Exception $e) {
|
|
throw new OCSNotFoundException($this->l->t('Invalid date, date format must be YYYY-MM-DD'));
|
|
}
|
|
}
|
|
|
|
} else if ($shareType === \OCP\Share::SHARE_TYPE_REMOTE) {
|
|
if (!$this->shareManager->outgoingServer2ServerSharesAllowed()) {
|
|
throw new OCSForbiddenException($this->l->t('Sharing %s failed because the back end does not allow shares from type %s', [$path->getPath(), $shareType]));
|
|
}
|
|
|
|
$share->setSharedWith($shareWith);
|
|
$share->setPermissions($permissions);
|
|
} else if ($shareType === \OCP\Share::SHARE_TYPE_EMAIL) {
|
|
if ($share->getNodeType() === 'file') {
|
|
$share->setPermissions(Constants::PERMISSION_READ);
|
|
} else {
|
|
$share->setPermissions($permissions);
|
|
}
|
|
$share->setSharedWith($shareWith);
|
|
} else if ($shareType === \OCP\Share::SHARE_TYPE_CIRCLE) {
|
|
if (!\OC::$server->getAppManager()->isEnabledForUser('circles') || !class_exists('\OCA\Circles\ShareByCircleProvider')) {
|
|
throw new OCSNotFoundException($this->l->t('You cannot share to a Circle if the app is not enabled'));
|
|
}
|
|
|
|
$circle = \OCA\Circles\Api\v1\Circles::detailsCircle($shareWith);
|
|
|
|
// 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);
|
|
} else {
|
|
throw new OCSBadRequestException($this->l->t('Unknown share type'));
|
|
}
|
|
|
|
$share->setShareType($shareType);
|
|
$share->setSharedBy($this->currentUser);
|
|
|
|
try {
|
|
$share = $this->shareManager->createShare($share);
|
|
} catch (GenericShareException $e) {
|
|
$code = $e->getCode() === 0 ? 403 : $e->getCode();
|
|
throw new OCSException($e->getHint(), $code);
|
|
} catch (\Exception $e) {
|
|
throw new OCSForbiddenException($e->getMessage(), $e);
|
|
}
|
|
|
|
$output = $this->formatShare($share);
|
|
|
|
return new DataResponse($output);
|
|
}
|
|
|
|
/**
|
|
* @param \OCP\Files\File|\OCP\Files\Folder $node
|
|
* @param boolean $includeTags
|
|
* @return DataResponse
|
|
*/
|
|
private function getSharedWithMe($node = null, $includeTags) {
|
|
|
|
$userShares = $this->shareManager->getSharedWith($this->currentUser, \OCP\Share::SHARE_TYPE_USER, $node, -1, 0);
|
|
$groupShares = $this->shareManager->getSharedWith($this->currentUser, \OCP\Share::SHARE_TYPE_GROUP, $node, -1, 0);
|
|
$circleShares = $this->shareManager->getSharedWith($this->currentUser, \OCP\Share::SHARE_TYPE_CIRCLE, $node, -1, 0);
|
|
|
|
$shares = array_merge($userShares, $groupShares, $circleShares);
|
|
|
|
$shares = array_filter($shares, function (IShare $share) {
|
|
return $share->getShareOwner() !== $this->currentUser;
|
|
});
|
|
|
|
$formatted = [];
|
|
foreach ($shares as $share) {
|
|
if ($this->canAccessShare($share)) {
|
|
try {
|
|
$formatted[] = $this->formatShare($share);
|
|
} catch (NotFoundException $e) {
|
|
// Ignore this share
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($includeTags) {
|
|
$formatted = Helper::populateTags($formatted, 'file_source', \OC::$server->getTagManager());
|
|
}
|
|
|
|
return new DataResponse($formatted);
|
|
}
|
|
|
|
/**
|
|
* @param \OCP\Files\Folder $folder
|
|
* @return DataResponse
|
|
* @throws OCSBadRequestException
|
|
*/
|
|
private function getSharesInDir($folder) {
|
|
if (!($folder instanceof \OCP\Files\Folder)) {
|
|
throw new OCSBadRequestException($this->l->t('Not a directory'));
|
|
}
|
|
|
|
$nodes = $folder->getDirectoryListing();
|
|
/** @var \OCP\Share\IShare[] $shares */
|
|
$shares = [];
|
|
foreach ($nodes as $node) {
|
|
$shares = array_merge($shares, $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_USER, $node, false, -1, 0));
|
|
$shares = array_merge($shares, $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_GROUP, $node, false, -1, 0));
|
|
$shares = array_merge($shares, $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_LINK, $node, false, -1, 0));
|
|
if($this->shareManager->shareProviderExists(\OCP\Share::SHARE_TYPE_EMAIL)) {
|
|
$shares = array_merge($shares, $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_EMAIL, $node, false, -1, 0));
|
|
}
|
|
if ($this->shareManager->outgoingServer2ServerSharesAllowed()) {
|
|
$shares = array_merge($shares, $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_REMOTE, $node, false, -1, 0));
|
|
}
|
|
}
|
|
|
|
$formatted = [];
|
|
foreach ($shares as $share) {
|
|
try {
|
|
$formatted[] = $this->formatShare($share);
|
|
} catch (NotFoundException $e) {
|
|
//Ignore this share
|
|
}
|
|
}
|
|
|
|
return new DataResponse($formatted);
|
|
}
|
|
|
|
/**
|
|
* The getShares function.
|
|
*
|
|
* @NoAdminRequired
|
|
*
|
|
* @param string $shared_with_me
|
|
* @param string $reshares
|
|
* @param string $subfiles
|
|
* @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 OCSNotFoundException
|
|
*/
|
|
public function getShares(
|
|
$shared_with_me = 'false',
|
|
$reshares = 'false',
|
|
$subfiles = 'false',
|
|
$path = null,
|
|
$include_tags = 'false'
|
|
) {
|
|
|
|
if ($path !== null) {
|
|
$userFolder = $this->rootFolder->getUserFolder($this->currentUser);
|
|
try {
|
|
$path = $userFolder->get($path);
|
|
$this->lock($path);
|
|
} 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'));
|
|
}
|
|
}
|
|
|
|
if ($shared_with_me === 'true') {
|
|
$result = $this->getSharedWithMe($path, $include_tags);
|
|
return $result;
|
|
}
|
|
|
|
if ($subfiles === 'true') {
|
|
$result = $this->getSharesInDir($path);
|
|
return $result;
|
|
}
|
|
|
|
if ($reshares === 'true') {
|
|
$reshares = true;
|
|
} else {
|
|
$reshares = false;
|
|
}
|
|
|
|
// Get all shares
|
|
$userShares = $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_USER, $path, $reshares, -1, 0);
|
|
$groupShares = $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_GROUP, $path, $reshares, -1, 0);
|
|
$linkShares = $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_LINK, $path, $reshares, -1, 0);
|
|
if ($this->shareManager->shareProviderExists(\OCP\Share::SHARE_TYPE_EMAIL)) {
|
|
$mailShares = $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_EMAIL, $path, $reshares, -1, 0);
|
|
} else {
|
|
$mailShares = [];
|
|
}
|
|
if ($this->shareManager->shareProviderExists(\OCP\Share::SHARE_TYPE_CIRCLE)) {
|
|
$circleShares = $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_CIRCLE, $path, $reshares, -1, 0);
|
|
} else {
|
|
$circleShares = [];
|
|
}
|
|
|
|
$shares = array_merge($userShares, $groupShares, $linkShares, $mailShares, $circleShares);
|
|
|
|
if ($this->shareManager->outgoingServer2ServerSharesAllowed()) {
|
|
$federatedShares = $this->shareManager->getSharesBy($this->currentUser, \OCP\Share::SHARE_TYPE_REMOTE, $path, $reshares, -1, 0);
|
|
$shares = array_merge($shares, $federatedShares);
|
|
}
|
|
|
|
$formatted = [];
|
|
foreach ($shares as $share) {
|
|
try {
|
|
$formatted[] = $this->formatShare($share, $path);
|
|
} catch (NotFoundException $e) {
|
|
//Ignore share
|
|
}
|
|
}
|
|
|
|
if ($include_tags) {
|
|
$formatted = Helper::populateTags($formatted, 'file_source', \OC::$server->getTagManager());
|
|
}
|
|
|
|
return new DataResponse($formatted);
|
|
}
|
|
|
|
/**
|
|
* @NoAdminRequired
|
|
*
|
|
* @param int $id
|
|
* @param int $permissions
|
|
* @param string $password
|
|
* @param string $publicUpload
|
|
* @param string $expireDate
|
|
* @return DataResponse
|
|
* @throws OCSNotFoundException
|
|
* @throws OCSBadRequestException
|
|
* @throws OCSForbiddenException
|
|
*/
|
|
public function updateShare(
|
|
$id,
|
|
$permissions = null,
|
|
$password = null,
|
|
$publicUpload = null,
|
|
$expireDate = null
|
|
) {
|
|
try {
|
|
$share = $this->getShareById($id);
|
|
} catch (ShareNotFound $e) {
|
|
throw new OCSNotFoundException($this->l->t('Wrong share ID, share doesn\'t exist'));
|
|
}
|
|
|
|
$this->lock($share->getNode());
|
|
|
|
if (!$this->canAccessShare($share, false)) {
|
|
throw new OCSNotFoundException($this->l->t('Wrong share ID, share doesn\'t exist'));
|
|
}
|
|
|
|
if ($permissions === null && $password === null && $publicUpload === null && $expireDate === null) {
|
|
throw new OCSBadRequestException($this->l->t('Wrong or no update parameter given'));
|
|
}
|
|
|
|
/*
|
|
* expirationdate, password and publicUpload only make sense for link shares
|
|
*/
|
|
if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) {
|
|
|
|
$newPermissions = null;
|
|
if ($publicUpload === 'true') {
|
|
$newPermissions = Constants::PERMISSION_READ | Constants::PERMISSION_CREATE | Constants::PERMISSION_UPDATE | Constants::PERMISSION_DELETE;
|
|
} else if ($publicUpload === 'false') {
|
|
$newPermissions = Constants::PERMISSION_READ;
|
|
}
|
|
|
|
if ($permissions !== null) {
|
|
$newPermissions = (int)$permissions;
|
|
$newPermissions = $newPermissions & ~Constants::PERMISSION_SHARE;
|
|
}
|
|
|
|
if ($newPermissions !== null &&
|
|
!in_array($newPermissions, [
|
|
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
|
|
])
|
|
) {
|
|
throw new OCSBadRequestException($this->l->t('Can\'t change permissions for public share links'));
|
|
}
|
|
|
|
if (
|
|
// legacy
|
|
$newPermissions === (Constants::PERMISSION_READ | Constants::PERMISSION_CREATE | Constants::PERMISSION_UPDATE) ||
|
|
// correct
|
|
$newPermissions === (Constants::PERMISSION_READ | Constants::PERMISSION_CREATE | Constants::PERMISSION_UPDATE | Constants::PERMISSION_DELETE)
|
|
) {
|
|
if (!$this->shareManager->shareApiLinkAllowPublicUpload()) {
|
|
throw new OCSForbiddenException($this->l->t('Public upload disabled by the administrator'));
|
|
}
|
|
|
|
if (!($share->getNode() instanceof \OCP\Files\Folder)) {
|
|
throw new OCSBadRequestException($this->l->t('Public upload is only possible for publicly shared folders'));
|
|
}
|
|
|
|
// normalize to correct public upload permissions
|
|
$newPermissions = Constants::PERMISSION_READ | Constants::PERMISSION_CREATE | Constants::PERMISSION_UPDATE | Constants::PERMISSION_DELETE;
|
|
}
|
|
|
|
if ($newPermissions !== null) {
|
|
$share->setPermissions($newPermissions);
|
|
$permissions = $newPermissions;
|
|
}
|
|
|
|
if ($expireDate === '') {
|
|
$share->setExpirationDate(null);
|
|
} else if ($expireDate !== null) {
|
|
try {
|
|
$expireDate = $this->parseDate($expireDate);
|
|
} catch (\Exception $e) {
|
|
throw new OCSBadRequestException($e->getMessage(), $e);
|
|
}
|
|
$share->setExpirationDate($expireDate);
|
|
}
|
|
|
|
if ($password === '') {
|
|
$share->setPassword(null);
|
|
} else if ($password !== null) {
|
|
$share->setPassword($password);
|
|
}
|
|
|
|
} else {
|
|
if ($permissions !== null) {
|
|
$permissions = (int)$permissions;
|
|
$share->setPermissions($permissions);
|
|
}
|
|
|
|
if ($share->getShareType() === \OCP\Share::SHARE_TYPE_EMAIL) {
|
|
if ($password === '') {
|
|
$share->setPassword(null);
|
|
} else if ($password !== null) {
|
|
$share->setPassword($password);
|
|
}
|
|
}
|
|
|
|
if ($expireDate === '') {
|
|
$share->setExpirationDate(null);
|
|
} else if ($expireDate !== null) {
|
|
try {
|
|
$expireDate = $this->parseDate($expireDate);
|
|
} catch (\Exception $e) {
|
|
throw new OCSBadRequestException($e->getMessage(), $e);
|
|
}
|
|
$share->setExpirationDate($expireDate);
|
|
}
|
|
|
|
}
|
|
|
|
if ($permissions !== null && $share->getShareOwner() !== $this->currentUser) {
|
|
/* Check if this is an incomming share */
|
|
$incomingShares = $this->shareManager->getSharedWith($this->currentUser, \OCP\Share::SHARE_TYPE_USER, $share->getNode(), -1, 0);
|
|
$incomingShares = array_merge($incomingShares, $this->shareManager->getSharedWith($this->currentUser, \OCP\Share::SHARE_TYPE_GROUP, $share->getNode(), -1, 0));
|
|
|
|
/** @var \OCP\Share\IShare[] $incomingShares */
|
|
if (!empty($incomingShares)) {
|
|
$maxPermissions = 0;
|
|
foreach ($incomingShares as $incomingShare) {
|
|
$maxPermissions |= $incomingShare->getPermissions();
|
|
}
|
|
|
|
if ($share->getPermissions() & ~$maxPermissions) {
|
|
throw new OCSNotFoundException($this->l->t('Cannot increase permissions'));
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
try {
|
|
$share = $this->shareManager->updateShare($share);
|
|
} catch (\Exception $e) {
|
|
throw new OCSBadRequestException($e->getMessage(), $e);
|
|
}
|
|
|
|
return new DataResponse($this->formatShare($share));
|
|
}
|
|
|
|
/**
|
|
* @param \OCP\Share\IShare $share
|
|
* @return bool
|
|
*/
|
|
protected function canAccessShare(\OCP\Share\IShare $share, $checkGroups = true) {
|
|
// A file with permissions 0 can't be accessed by us. So Don't show it
|
|
if ($share->getPermissions() === 0) {
|
|
return false;
|
|
}
|
|
|
|
// Owner of the file and the sharer of the file can always get share
|
|
if ($share->getShareOwner() === $this->currentUser ||
|
|
$share->getSharedBy() === $this->currentUser
|
|
) {
|
|
return true;
|
|
}
|
|
|
|
// If the share is shared with you (or a group you are a member of)
|
|
if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER &&
|
|
$share->getSharedWith() === $this->currentUser
|
|
) {
|
|
return true;
|
|
}
|
|
|
|
if ($checkGroups && $share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) {
|
|
$sharedWith = $this->groupManager->get($share->getSharedWith());
|
|
$user = $this->userManager->get($this->currentUser);
|
|
if ($user !== null && $sharedWith !== null && $sharedWith->inGroup($user)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
if ($share->getShareType() === \OCP\Share::SHARE_TYPE_CIRCLE) {
|
|
// TODO: have a sanity check like above?
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
private function parseDate($expireDate) {
|
|
try {
|
|
$date = new \DateTime($expireDate);
|
|
} catch (\Exception $e) {
|
|
throw new \Exception('Invalid date. Format must be YYYY-MM-DD');
|
|
}
|
|
|
|
if ($date === false) {
|
|
throw new \Exception('Invalid date. Format must be YYYY-MM-DD');
|
|
}
|
|
|
|
$date->setTime(0, 0, 0);
|
|
|
|
return $date;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
private function getShareById($id) {
|
|
$share = null;
|
|
|
|
// First check if it is an internal share.
|
|
try {
|
|
$share = $this->shareManager->getShareById('ocinternal:' . $id);
|
|
return $share;
|
|
} catch (ShareNotFound $e) {
|
|
// Do nothing, just try the other share type
|
|
}
|
|
|
|
|
|
try {
|
|
if ($this->shareManager->shareProviderExists(\OCP\Share::SHARE_TYPE_CIRCLE)) {
|
|
$share = $this->shareManager->getShareById('ocCircleShare:' . $id);
|
|
return $share;
|
|
}
|
|
} catch (ShareNotFound $e) {
|
|
// Do nothing, just try the other share type
|
|
}
|
|
|
|
try {
|
|
if ($this->shareManager->shareProviderExists(\OCP\Share::SHARE_TYPE_EMAIL)) {
|
|
$share = $this->shareManager->getShareById('ocMailShare:' . $id);
|
|
return $share;
|
|
}
|
|
} catch (ShareNotFound $e) {
|
|
// Do nothing, just try the other share type
|
|
}
|
|
|
|
if (!$this->shareManager->outgoingServer2ServerSharesAllowed()) {
|
|
throw new ShareNotFound();
|
|
}
|
|
$share = $this->shareManager->getShareById('ocFederatedSharing:' . $id);
|
|
|
|
return $share;
|
|
}
|
|
|
|
/**
|
|
* Lock a Node
|
|
*
|
|
* @param \OCP\Files\Node $node
|
|
*/
|
|
private function lock(\OCP\Files\Node $node) {
|
|
$node->lock(ILockingProvider::LOCK_SHARED);
|
|
$this->lockedNode = $node;
|
|
}
|
|
|
|
/**
|
|
* Cleanup the remaining locks
|
|
*/
|
|
public function cleanup() {
|
|
if ($this->lockedNode !== null) {
|
|
$this->lockedNode->unlock(ILockingProvider::LOCK_SHARED);
|
|
}
|
|
}
|
|
}
|