610 lines
No EOL
16 KiB
PHP
610 lines
No EOL
16 KiB
PHP
<?php
|
|
/**
|
|
* @author Roeland Jago Douma <rullzer@owncloud.com>
|
|
*
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
* @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 OC\Share20;
|
|
|
|
use OC\Share20\Exception\InvalidShare;
|
|
use OC\Share20\Exception\ShareNotFound;
|
|
use OC\Share20\Exception\BackendError;
|
|
use OCP\Files\NotFoundException;
|
|
use OCP\IGroup;
|
|
use OCP\IUser;
|
|
use OCP\IGroupManager;
|
|
use OCP\IUserManager;
|
|
use OCP\Files\IRootFolder;
|
|
use OCP\IDBConnection;
|
|
use OCP\Files\Node;
|
|
|
|
use Doctrine\DBAL\Connection;
|
|
|
|
/**
|
|
* Class DefaultShareProvider
|
|
*
|
|
* @package OC\Share20
|
|
*/
|
|
class DefaultShareProvider implements IShareProvider {
|
|
|
|
// Special share type for user modified group shares
|
|
const SHARE_TYPE_USERGROUP = 2;
|
|
|
|
/** @var IDBConnection */
|
|
private $dbConn;
|
|
|
|
/** @var IUserManager */
|
|
private $userManager;
|
|
|
|
/** @var IGroupManager */
|
|
private $groupManager;
|
|
|
|
/** @var IRootFolder */
|
|
private $rootFolder;
|
|
|
|
/**
|
|
* DefaultShareProvider constructor.
|
|
*
|
|
* @param IDBConnection $connection
|
|
* @param IUserManager $userManager
|
|
* @param IGroupManager $groupManager
|
|
* @param IRootFolder $rootFolder
|
|
*/
|
|
public function __construct(
|
|
IDBConnection $connection,
|
|
IUserManager $userManager,
|
|
IGroupManager $groupManager,
|
|
IRootFolder $rootFolder) {
|
|
$this->dbConn = $connection;
|
|
$this->userManager = $userManager;
|
|
$this->groupManager = $groupManager;
|
|
$this->rootFolder = $rootFolder;
|
|
}
|
|
|
|
/**
|
|
* Return the identifier of this provider.
|
|
*
|
|
* @return string Containing only [a-zA-Z0-9]
|
|
*/
|
|
public function identifier() {
|
|
return 'ocinternal';
|
|
}
|
|
|
|
/**
|
|
* Share a path
|
|
*
|
|
* @param IShare $share
|
|
* @return IShare The share object
|
|
* @throws ShareNotFound
|
|
* @throws \Exception
|
|
*/
|
|
public function create(IShare $share) {
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
|
|
$qb->insert('share');
|
|
$qb->setValue('share_type', $qb->createNamedParameter($share->getShareType()));
|
|
|
|
if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) {
|
|
//Set the UID of the user we share with
|
|
/** @var IUser $sharedWith */
|
|
$sharedWith = $share->getSharedWith();
|
|
$qb->setValue('share_with', $qb->createNamedParameter($sharedWith->getUID()));
|
|
} else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) {
|
|
//Set the GID of the group we share with
|
|
/** @var IGroup $sharedWith */
|
|
$sharedWith = $share->getSharedWith();
|
|
$qb->setValue('share_with', $qb->createNamedParameter($sharedWith->getGID()));
|
|
} else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) {
|
|
//Set the token of the share
|
|
$qb->setValue('token', $qb->createNamedParameter($share->getToken()));
|
|
|
|
//If a password is set store it
|
|
if ($share->getPassword() !== null) {
|
|
$qb->setValue('share_with', $qb->createNamedParameter($share->getPassword()));
|
|
}
|
|
|
|
//If an expiration date is set store it
|
|
if ($share->getExpirationDate() !== null) {
|
|
$qb->setValue('expiration', $qb->createNamedParameter($share->getExpirationDate(), 'datetime'));
|
|
}
|
|
} else {
|
|
throw new \Exception('invalid share type!');
|
|
}
|
|
|
|
// Set what is shares
|
|
$qb->setValue('item_type', $qb->createParameter('itemType'));
|
|
if ($share->getPath() instanceof \OCP\Files\File) {
|
|
$qb->setParameter('itemType', 'file');
|
|
} else {
|
|
$qb->setParameter('itemType', 'folder');
|
|
}
|
|
|
|
// Set the file id
|
|
$qb->setValue('item_source', $qb->createNamedParameter($share->getPath()->getId()));
|
|
$qb->setValue('file_source', $qb->createNamedParameter($share->getPath()->getId()));
|
|
|
|
// set the permissions
|
|
$qb->setValue('permissions', $qb->createNamedParameter($share->getPermissions()));
|
|
|
|
// Set who created this share
|
|
$qb->setValue('uid_initiator', $qb->createNamedParameter($share->getSharedBy()->getUID()));
|
|
|
|
// Set who is the owner of this file/folder (and this the owner of the share)
|
|
$qb->setValue('uid_owner', $qb->createNamedParameter($share->getShareOwner()->getUID()));
|
|
|
|
// Set the file target
|
|
$qb->setValue('file_target', $qb->createNamedParameter($share->getTarget()));
|
|
|
|
// Set the time this share was created
|
|
$qb->setValue('stime', $qb->createNamedParameter(time()));
|
|
|
|
// insert the data and fetch the id of the share
|
|
$this->dbConn->beginTransaction();
|
|
$qb->execute();
|
|
$id = $this->dbConn->lastInsertId('*PREFIX*share');
|
|
$this->dbConn->commit();
|
|
|
|
// Now fetch the inserted share and create a complete share object
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
$qb->select('*')
|
|
->from('share')
|
|
->where($qb->expr()->eq('id', $qb->createNamedParameter($id)));
|
|
|
|
$cursor = $qb->execute();
|
|
$data = $cursor->fetch();
|
|
$cursor->closeCursor();
|
|
|
|
if ($data === false) {
|
|
throw new ShareNotFound();
|
|
}
|
|
|
|
$share = $this->createShare($data);
|
|
return $share;
|
|
}
|
|
|
|
/**
|
|
* Update a share
|
|
*
|
|
* @param IShare $share
|
|
* @return IShare The share object
|
|
*/
|
|
public function update(IShare $share) {
|
|
}
|
|
|
|
/**
|
|
* Get all children of this share
|
|
*
|
|
* @param IShare $parent
|
|
* @return IShare[]
|
|
*/
|
|
public function getChildren(IShare $parent) {
|
|
$children = [];
|
|
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
$qb->select('*')
|
|
->from('share')
|
|
->where($qb->expr()->eq('parent', $qb->createNamedParameter($parent->getId())))
|
|
->andWhere(
|
|
$qb->expr()->in(
|
|
'share_type',
|
|
[
|
|
$qb->expr()->literal(\OCP\Share::SHARE_TYPE_USER),
|
|
$qb->expr()->literal(\OCP\Share::SHARE_TYPE_GROUP),
|
|
$qb->expr()->literal(\OCP\Share::SHARE_TYPE_LINK),
|
|
$qb->expr()->literal(self::SHARE_TYPE_USERGROUP),
|
|
]
|
|
)
|
|
)
|
|
->orderBy('id');
|
|
|
|
$cursor = $qb->execute();
|
|
while($data = $cursor->fetch()) {
|
|
$children[] = $this->createShare($data);
|
|
}
|
|
$cursor->closeCursor();
|
|
|
|
return $children;
|
|
}
|
|
|
|
/**
|
|
* Delete a share
|
|
*
|
|
* @param IShare $share
|
|
* @throws BackendError
|
|
*/
|
|
public function delete(IShare $share) {
|
|
// Fetch share to make sure it exists
|
|
$share = $this->getShareById($share->getId());
|
|
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
$qb->delete('share')
|
|
->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId())));
|
|
|
|
try {
|
|
$qb->execute();
|
|
} catch (\Exception $e) {
|
|
throw new BackendError();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get all shares by the given user. Sharetype and path can be used to filter.
|
|
*
|
|
* @param IUser $user
|
|
* @param int $shareType
|
|
* @param \OCP\Files\File|\OCP\Files\Folder $node
|
|
* @param bool $reshares Also get the shares where $user is the owner instead of just the shares where $user is the initiator
|
|
* @param int $limit The maximum number of shares to be returned, -1 for all shares
|
|
* @param int $offset
|
|
* @return Share[]
|
|
*/
|
|
public function getSharesBy(IUser $user, $shareType, $node, $reshares, $limit, $offset) {
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
$qb->select('*')
|
|
->from('share');
|
|
|
|
$qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter($shareType)));
|
|
|
|
/**
|
|
* Reshares for this user are shares where they are the owner.
|
|
*/
|
|
if ($reshares === false) {
|
|
$qb->andWhere($qb->expr()->eq('uid_initiator', $qb->createNamedParameter($user->getUID())));
|
|
} else {
|
|
$qb->andWhere(
|
|
$qb->expr()->orX(
|
|
$qb->expr()->eq('uid_owner', $qb->createNamedParameter($user->getUID())),
|
|
$qb->expr()->eq('uid_initiator', $qb->createNamedParameter($user->getUID()))
|
|
)
|
|
);
|
|
}
|
|
|
|
if ($node !== null) {
|
|
$qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId())));
|
|
}
|
|
|
|
if ($limit !== -1) {
|
|
$qb->setMaxResults($limit);
|
|
}
|
|
|
|
$qb->setFirstResult($offset);
|
|
$qb->orderBy('id');
|
|
|
|
$cursor = $qb->execute();
|
|
$shares = [];
|
|
while($data = $cursor->fetch()) {
|
|
$shares[] = $this->createShare($data);
|
|
}
|
|
$cursor->closeCursor();
|
|
|
|
return $shares;
|
|
}
|
|
|
|
/**
|
|
* Get share by id
|
|
*
|
|
* @param int $id
|
|
* @return IShare
|
|
* @throws ShareNotFound
|
|
*/
|
|
public function getShareById($id) {
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
|
|
$qb->select('*')
|
|
->from('share')
|
|
->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
|
|
->andWhere(
|
|
$qb->expr()->in(
|
|
'share_type',
|
|
[
|
|
$qb->expr()->literal(\OCP\Share::SHARE_TYPE_USER),
|
|
$qb->expr()->literal(\OCP\Share::SHARE_TYPE_GROUP),
|
|
$qb->expr()->literal(\OCP\Share::SHARE_TYPE_LINK),
|
|
$qb->expr()->literal(self::SHARE_TYPE_USERGROUP),
|
|
]
|
|
)
|
|
);
|
|
|
|
$cursor = $qb->execute();
|
|
$data = $cursor->fetch();
|
|
$cursor->closeCursor();
|
|
|
|
if ($data === false) {
|
|
throw new ShareNotFound();
|
|
}
|
|
|
|
try {
|
|
$share = $this->createShare($data);
|
|
} catch (InvalidShare $e) {
|
|
throw new ShareNotFound();
|
|
}
|
|
|
|
return $share;
|
|
}
|
|
|
|
/**
|
|
* Get shares for a given path
|
|
*
|
|
* @param \OCP\Files\Node $path
|
|
* @return IShare[]
|
|
*/
|
|
public function getSharesByPath(Node $path) {
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
|
|
$cursor = $qb->select('*')
|
|
->from('share')
|
|
->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($path->getId())))
|
|
->andWhere(
|
|
$qb->expr()->orX(
|
|
$qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER)),
|
|
$qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP))
|
|
)
|
|
)->execute();
|
|
|
|
$shares = [];
|
|
while($data = $cursor->fetch()) {
|
|
$shares[] = $this->createShare($data);
|
|
}
|
|
$cursor->closeCursor();
|
|
|
|
return $shares;
|
|
}
|
|
|
|
/**
|
|
* Get shared with the given user
|
|
*
|
|
* @param IUser $user
|
|
* @param int $shareType
|
|
* @param int $limit The maximum number of shares, -1 for all
|
|
* @param int $offset
|
|
* @return IShare[]
|
|
* @throws BackendError
|
|
*/
|
|
public function getSharedWith(IUser $user, $shareType, $limit, $offset) {
|
|
/** @var Share[] $shares */
|
|
$shares = [];
|
|
|
|
if ($shareType === \OCP\Share::SHARE_TYPE_USER) {
|
|
//Get shares directly with this user
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
$qb->select('*')
|
|
->from('share');
|
|
|
|
// Order by id
|
|
$qb->orderBy('id');
|
|
|
|
// Set limit and offset
|
|
if ($limit !== -1) {
|
|
$qb->setMaxResults($limit);
|
|
}
|
|
$qb->setFirstResult($offset);
|
|
|
|
$qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER)));
|
|
$qb->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($user->getUID())));
|
|
|
|
$cursor = $qb->execute();
|
|
|
|
while($data = $cursor->fetch()) {
|
|
$shares[] = $this->createShare($data);
|
|
}
|
|
$cursor->closeCursor();
|
|
|
|
} else if ($shareType === \OCP\Share::SHARE_TYPE_GROUP) {
|
|
$allGroups = $this->groupManager->getUserGroups($user);
|
|
|
|
$start = 0;
|
|
while(true) {
|
|
$groups = array_slice($allGroups, $start, 100);
|
|
$start += 100;
|
|
|
|
if ($groups === []) {
|
|
break;
|
|
}
|
|
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
$qb->select('*')
|
|
->from('share')
|
|
->orderBy('id')
|
|
->setFirstResult(0);
|
|
|
|
if ($limit !== -1) {
|
|
$qb->setMaxResults($limit - count($shares));
|
|
}
|
|
|
|
$groups = array_map(function(IGroup $group) { return $group->getGID(); }, $groups);
|
|
|
|
$qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP)));
|
|
$qb->andWhere($qb->expr()->in('share_with', $qb->createNamedParameter(
|
|
$groups,
|
|
Connection::PARAM_STR_ARRAY
|
|
)));
|
|
|
|
$cursor = $qb->execute();
|
|
while($data = $cursor->fetch()) {
|
|
if ($offset > 0) {
|
|
$offset--;
|
|
continue;
|
|
}
|
|
$shares[] = $this->createShare($data);
|
|
}
|
|
$cursor->closeCursor();
|
|
}
|
|
|
|
/*
|
|
* Resolve all group shares to user specific shares
|
|
* TODO: Optmize this!
|
|
*/
|
|
$shares = array_map([$this, 'resolveGroupShare'], $shares);
|
|
} else {
|
|
throw new BackendError();
|
|
}
|
|
|
|
|
|
return $shares;
|
|
}
|
|
|
|
/**
|
|
* Get a share by token
|
|
*
|
|
* @param string $token
|
|
* @return IShare
|
|
* @throws ShareNotFound
|
|
*/
|
|
public function getShareByToken($token) {
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
|
|
$cursor = $qb->select('*')
|
|
->from('share')
|
|
->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_LINK)))
|
|
->andWhere($qb->expr()->eq('token', $qb->createNamedParameter($token)))
|
|
->execute();
|
|
|
|
$data = $cursor->fetch();
|
|
|
|
if ($data === false) {
|
|
throw new ShareNotFound();
|
|
}
|
|
|
|
try {
|
|
$share = $this->createShare($data);
|
|
} catch (InvalidShare $e) {
|
|
throw new ShareNotFound();
|
|
}
|
|
|
|
return $share;
|
|
}
|
|
|
|
/**
|
|
* Create a share object from an database row
|
|
*
|
|
* @param mixed[] $data
|
|
* @return Share
|
|
* @throws InvalidShare
|
|
*/
|
|
private function createShare($data) {
|
|
$share = new Share();
|
|
$share->setId((int)$data['id'])
|
|
->setShareType((int)$data['share_type'])
|
|
->setPermissions((int)$data['permissions'])
|
|
->setTarget($data['file_target'])
|
|
->setShareTime((int)$data['stime'])
|
|
->setMailSend((bool)$data['mail_send']);
|
|
|
|
if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) {
|
|
$sharedWith = $this->userManager->get($data['share_with']);
|
|
if ($sharedWith === null) {
|
|
throw new InvalidShare();
|
|
}
|
|
$share->setSharedWith($sharedWith);
|
|
} else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) {
|
|
$sharedWith = $this->groupManager->get($data['share_with']);
|
|
if ($sharedWith === null) {
|
|
throw new InvalidShare();
|
|
}
|
|
$share->setSharedWith($sharedWith);
|
|
} else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) {
|
|
$share->setPassword($data['share_with']);
|
|
$share->setToken($data['token']);
|
|
}
|
|
|
|
if ($data['uid_initiator'] === null) {
|
|
//OLD SHARE
|
|
$sharedBy = $this->userManager->get($data['uid_owner']);
|
|
if ($sharedBy === null) {
|
|
throw new InvalidShare();
|
|
}
|
|
$share->setSharedBy($sharedBy);
|
|
$path = $this->getNode($share->getSharedBy(), (int)$data['file_source']);
|
|
|
|
$owner = $path->getOwner();
|
|
$share->setShareOwner($owner);
|
|
} else {
|
|
//New share!
|
|
$sharedBy = $this->userManager->get($data['uid_initiator']);
|
|
$shareOwner = $this->userManager->get($data['uid_owner']);
|
|
if ($sharedBy === null || $shareOwner === null) {
|
|
throw new InvalidShare();
|
|
}
|
|
$share->setSharedBy($sharedBy);
|
|
$share->setShareOwner($shareOwner);
|
|
}
|
|
|
|
$path = $this->getNode($share->getShareOwner(), (int)$data['file_source']);
|
|
$share->setPath($path);
|
|
|
|
if ($data['expiration'] !== null) {
|
|
$expiration = \DateTime::createFromFormat('Y-m-d H:i:s', $data['expiration']);
|
|
$share->setExpirationDate($expiration);
|
|
}
|
|
|
|
$share->setProviderId($this->identifier());
|
|
|
|
return $share;
|
|
}
|
|
|
|
/**
|
|
* Get the node with file $id for $user
|
|
*
|
|
* @param IUser $user
|
|
* @param int $id
|
|
* @return \OCP\Files\File|\OCP\Files\Folder
|
|
* @throws InvalidShare
|
|
*/
|
|
private function getNode(IUser $user, $id) {
|
|
try {
|
|
$userFolder = $this->rootFolder->getUserFolder($user->getUID());
|
|
} catch (NotFoundException $e) {
|
|
throw new InvalidShare();
|
|
}
|
|
|
|
$nodes = $userFolder->getById($id);
|
|
|
|
if (empty($nodes)) {
|
|
throw new InvalidShare();
|
|
}
|
|
|
|
return $nodes[0];
|
|
}
|
|
|
|
/**
|
|
* Resolve a group share to a user specific share
|
|
* Thus if the user moved their group share make sure this is properly reflected here.
|
|
*
|
|
* @param Share $share
|
|
* @return Share
|
|
*/
|
|
private function resolveGroupShare(Share $share) {
|
|
$qb = $this->dbConn->getQueryBuilder();
|
|
|
|
$stmt = $qb->select('*')
|
|
->from('share')
|
|
->where($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId())))
|
|
->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP)))
|
|
->execute();
|
|
|
|
$data = $stmt->fetch();
|
|
$stmt->closeCursor();
|
|
|
|
if ($data !== false) {
|
|
$share->setPermissions($data['permissions']);
|
|
$share->setTarget($data['file_target']);
|
|
}
|
|
|
|
return $share;
|
|
}
|
|
|
|
} |