nextcloud/lib/private/share/share.php

2797 lines
102 KiB
PHP
Raw Normal View History

2014-02-18 15:37:32 +04:00
<?php
/**
2015-10-05 21:54:56 +03:00
* @author Arthur Schiwon <blizzz@owncloud.com>
2015-03-26 13:44:34 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
* @author Bernhard Reiter <ockham@raz.or.at>
* @author Björn Schießle <schiessle@owncloud.com>
* @author Christopher Schäpers <kondou@ts.unde.re>
* @author Daniel Hansson <enoch85@gmail.com>
* @author Joas Schilling <nickvergessen@owncloud.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Michael Kuhn <suraia@ikkoku.de>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
2015-10-26 15:54:55 +03:00
* @author Roeland Jago Douma <rullzer@owncloud.com>
2015-03-26 13:44:34 +03:00
* @author Sebastian Döll <sebastian.doell@libasys.de>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
* @author Volkan Gezer <volkangezer@gmail.com>
2014-02-18 15:37:32 +04:00
*
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
2014-02-18 15:37:32 +04:00
*
2015-03-26 13:44:34 +03:00
* 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.
2014-02-18 15:37:32 +04:00
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
2014-02-18 15:37:32 +04:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* 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/>
2014-02-18 15:37:32 +04:00
*
*/
2014-02-18 15:37:32 +04:00
namespace OC\Share;
use OC\Files\Filesystem;
use OCP\IUserSession;
use OCP\IDBConnection;
use OCP\IConfig;
2014-02-18 15:37:32 +04:00
/**
* This class provides the ability for apps to share their content between users.
* Apps must create a backend class that implements OCP\Share_Backend and register it with this class.
*
* It provides the following hooks:
* - post_shared
*/
class Share extends Constants {
2014-02-18 15:37:32 +04:00
/** CRUDS permissions (Create, Read, Update, Delete, Share) using a bitmask
* Construct permissions for share() and setPermissions with Or (|) e.g.
* Give user read and update permissions: PERMISSION_READ | PERMISSION_UPDATE
*
* Check if permission is granted with And (&) e.g. Check if delete is
* granted: if ($permissions & PERMISSION_DELETE)
*
* Remove permissions with And (&) and Not (~) e.g. Remove the update
* permission: $permissions &= ~PERMISSION_UPDATE
*
* Apps are required to handle permissions on their own, this class only
* stores and manages the permissions of shares
* @see lib/public/constants.php
*/
/**
* Register a sharing backend class that implements OCP\Share_Backend for an item type
* @param string $itemType Item type
* @param string $class Backend class
* @param string $collectionOf (optional) Depends on item type
* @param array $supportedFileExtensions (optional) List of supported file extensions if this item type depends on files
* @return boolean true if backend is registered or false if error
2014-02-18 15:37:32 +04:00
*/
public static function registerBackend($itemType, $class, $collectionOf = null, $supportedFileExtensions = null) {
if (self::isEnabled()) {
if (!isset(self::$backendTypes[$itemType])) {
self::$backendTypes[$itemType] = array(
'class' => $class,
'collectionOf' => $collectionOf,
'supportedFileExtensions' => $supportedFileExtensions
);
if(count(self::$backendTypes) === 1) {
\OC_Util::addScript('core', 'shareconfigmodel');
\OC_Util::addScript('core', 'shareitemmodel');
\OC_Util::addScript('core', 'sharedialogresharerinfoview');
2015-08-21 16:40:50 +03:00
\OC_Util::addScript('core', 'sharedialoglinkshareview');
2015-08-21 20:35:13 +03:00
\OC_Util::addScript('core', 'sharedialogexpirationview');
\OC_Util::addScript('core', 'sharedialogshareelistview');
\OC_Util::addScript('core', 'sharedialogview');
2014-02-18 15:37:32 +04:00
\OC_Util::addScript('core', 'share');
\OC_Util::addStyle('core', 'share');
}
return true;
}
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share',
2014-02-18 15:37:32 +04:00
'Sharing backend '.$class.' not registered, '.self::$backendTypes[$itemType]['class']
.' is already registered for '.$itemType,
2015-07-03 15:06:40 +03:00
\OCP\Util::WARN);
2014-02-18 15:37:32 +04:00
}
return false;
}
/**
* Check if the Share API is enabled
* @return boolean true if enabled or false
2014-02-18 15:37:32 +04:00
*
* The Share API is enabled by default if not configured
*/
public static function isEnabled() {
2015-07-03 15:16:29 +03:00
if (\OC::$server->getAppConfig()->getValue('core', 'shareapi_enabled', 'yes') == 'yes') {
2014-02-18 15:37:32 +04:00
return true;
}
return false;
}
/**
* Find which users can access a shared item
* @param string $path to the file
* @param string $ownerUser owner of the file
* @param boolean $includeOwner include owner to the list of users with access to the file
* @param boolean $returnUserPaths Return an array with the user => path map
2015-08-17 13:53:24 +03:00
* @param boolean $recursive take all parent folders into account (default true)
2014-02-18 15:37:32 +04:00
* @return array
* @note $path needs to be relative to user data dir, e.g. 'file.txt'
* not '/admin/data/file.txt'
*/
2015-08-17 13:53:24 +03:00
public static function getUsersSharingFile($path, $ownerUser, $includeOwner = false, $returnUserPaths = false, $recursive = true) {
2014-02-18 15:37:32 +04:00
Filesystem::initMountPoints($ownerUser);
$shares = $sharePaths = $fileTargets = array();
2014-02-18 15:37:32 +04:00
$publicShare = false;
$remoteShare = false;
2014-02-18 15:37:32 +04:00
$source = -1;
$cache = false;
$view = new \OC\Files\View('/' . $ownerUser . '/files');
2015-06-22 13:40:34 +03:00
$meta = $view->getFileInfo($path);
if ($meta) {
$path = substr($meta->getPath(), strlen('/' . $ownerUser . '/files'));
2014-02-18 15:37:32 +04:00
} else {
// if the file doesn't exists yet we start with the parent folder
$meta = $view->getFileInfo(dirname($path));
}
if($meta !== false) {
$source = $meta['fileid'];
$cache = new \OC\Files\Cache\Cache($meta['storage']);
}
while ($source !== -1) {
// Fetch all shares with another user
if (!$returnUserPaths) {
$query = \OC_DB::prepare(
'SELECT `share_with`, `file_source`, `file_target`
FROM
`*PREFIX*share`
WHERE
`item_source` = ? AND `share_type` = ? AND `item_type` IN (\'file\', \'folder\')'
);
$result = $query->execute(array($source, self::SHARE_TYPE_USER));
} else {
$query = \OC_DB::prepare(
'SELECT `share_with`, `file_source`, `file_target`
2014-02-18 15:37:32 +04:00
FROM
`*PREFIX*share`
WHERE
`item_source` = ? AND `share_type` IN (?, ?) AND `item_type` IN (\'file\', \'folder\')'
);
$result = $query->execute(array($source, self::SHARE_TYPE_USER, self::$shareTypeGroupUserUnique));
}
2014-02-18 15:37:32 +04:00
if (\OCP\DB::isError($result)) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share', \OC_DB::getErrorMessage(), \OCP\Util::ERROR);
2014-02-18 15:37:32 +04:00
} else {
while ($row = $result->fetchRow()) {
$shares[] = $row['share_with'];
if ($returnUserPaths) {
$fileTargets[(int) $row['file_source']][$row['share_with']] = $row;
}
2014-02-18 15:37:32 +04:00
}
}
// We also need to take group shares into account
2014-02-18 15:37:32 +04:00
$query = \OC_DB::prepare(
'SELECT `share_with`, `file_source`, `file_target`
2014-02-18 15:37:32 +04:00
FROM
`*PREFIX*share`
WHERE
`item_source` = ? AND `share_type` = ? AND `item_type` IN (\'file\', \'folder\')'
);
$result = $query->execute(array($source, self::SHARE_TYPE_GROUP));
if (\OCP\DB::isError($result)) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share', \OC_DB::getErrorMessage(), \OCP\Util::ERROR);
2014-02-18 15:37:32 +04:00
} else {
while ($row = $result->fetchRow()) {
$usersInGroup = \OC_Group::usersInGroup($row['share_with']);
$shares = array_merge($shares, $usersInGroup);
if ($returnUserPaths) {
foreach ($usersInGroup as $user) {
if (!isset($fileTargets[(int) $row['file_source']][$user])) {
// When the user already has an entry for this file source
// the file is either shared directly with him as well, or
// he has an exception entry (because of naming conflict).
$fileTargets[(int) $row['file_source']][$user] = $row;
}
}
}
2014-02-18 15:37:32 +04:00
}
}
//check for public link shares
if (!$publicShare) {
$query = \OC_DB::prepare('
SELECT `share_with`
FROM `*PREFIX*share`
WHERE `item_source` = ? AND `share_type` = ? AND `item_type` IN (\'file\', \'folder\')', 1
2014-02-18 15:37:32 +04:00
);
$result = $query->execute(array($source, self::SHARE_TYPE_LINK));
if (\OCP\DB::isError($result)) {
\OCP\Util::writeLog('OCP\Share', \OC_DB::getErrorMessage(), \OCP\Util::ERROR);
2014-02-18 15:37:32 +04:00
} else {
if ($result->fetchRow()) {
$publicShare = true;
}
}
}
//check for remote share
if (!$remoteShare) {
$query = \OC_DB::prepare('
SELECT `share_with`
FROM `*PREFIX*share`
WHERE `item_source` = ? AND `share_type` = ? AND `item_type` IN (\'file\', \'folder\')', 1
);
$result = $query->execute(array($source, self::SHARE_TYPE_REMOTE));
if (\OCP\DB::isError($result)) {
\OCP\Util::writeLog('OCP\Share', \OC_DB::getErrorMessage(), \OCP\Util::ERROR);
} else {
if ($result->fetchRow()) {
$remoteShare = true;
}
}
}
2014-02-18 15:37:32 +04:00
// let's get the parent for the next round
$meta = $cache->get((int)$source);
2015-08-17 13:53:24 +03:00
if ($recursive === true && $meta !== false) {
2014-02-18 15:37:32 +04:00
$source = (int)$meta['parent'];
} else {
$source = -1;
}
}
2014-02-18 15:37:32 +04:00
// Include owner in list of users, if requested
if ($includeOwner) {
$shares[] = $ownerUser;
}
if ($returnUserPaths) {
$fileTargetIDs = array_keys($fileTargets);
$fileTargetIDs = array_unique($fileTargetIDs);
2014-04-09 17:01:39 +04:00
if (!empty($fileTargetIDs)) {
$query = \OC_DB::prepare(
'SELECT `fileid`, `path`
FROM `*PREFIX*filecache`
WHERE `fileid` IN (' . implode(',', $fileTargetIDs) . ')'
);
$result = $query->execute();
2014-04-09 17:01:39 +04:00
if (\OCP\DB::isError($result)) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share', \OC_DB::getErrorMessage(), \OCP\Util::ERROR);
2014-04-09 17:01:39 +04:00
} else {
while ($row = $result->fetchRow()) {
foreach ($fileTargets[$row['fileid']] as $uid => $shareData) {
2014-04-23 14:59:22 +04:00
$sharedPath = $shareData['file_target'];
2014-04-09 17:01:39 +04:00
$sharedPath .= substr($path, strlen($row['path']) -5);
$sharePaths[$uid] = $sharedPath;
}
}
}
}
if ($includeOwner) {
$sharePaths[$ownerUser] = $path;
} else {
unset($sharePaths[$ownerUser]);
}
return $sharePaths;
2014-02-18 15:37:32 +04:00
}
return array('users' => array_unique($shares), 'public' => $publicShare, 'remote' => $remoteShare);
2014-02-18 15:37:32 +04:00
}
/**
* Get the items of item type shared with the current user
* @param string $itemType
* @param int $format (optional) Format type must be defined by the backend
* @param mixed $parameters (optional)
* @param int $limit Number of items to return (optional) Returns all by default
* @param boolean $includeCollections (optional)
* @return mixed Return depends on format
2014-02-18 15:37:32 +04:00
*/
public static function getItemsSharedWith($itemType, $format = self::FORMAT_NONE,
$parameters = null, $limit = -1, $includeCollections = false) {
2014-02-18 15:37:32 +04:00
return self::getItems($itemType, null, self::$shareTypeUserAndGroups, \OC_User::getUser(), null, $format,
$parameters, $limit, $includeCollections);
}
/**
* Get the items of item type shared with a user
* @param string $itemType
* @param string $user id for which user we want the shares
* @param int $format (optional) Format type must be defined by the backend
* @param mixed $parameters (optional)
* @param int $limit Number of items to return (optional) Returns all by default
* @param boolean $includeCollections (optional)
2014-05-13 14:27:35 +04:00
* @return mixed Return depends on format
*/
public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE,
$parameters = null, $limit = -1, $includeCollections = false) {
return self::getItems($itemType, null, self::$shareTypeUserAndGroups, $user, null, $format,
$parameters, $limit, $includeCollections);
}
2014-02-18 15:37:32 +04:00
/**
* Get the item of item type shared with the current user
* @param string $itemType
* @param string $itemTarget
* @param int $format (optional) Format type must be defined by the backend
* @param mixed $parameters (optional)
* @param boolean $includeCollections (optional)
* @return mixed Return depends on format
2014-02-18 15:37:32 +04:00
*/
public static function getItemSharedWith($itemType, $itemTarget, $format = self::FORMAT_NONE,
$parameters = null, $includeCollections = false) {
2014-02-18 15:37:32 +04:00
return self::getItems($itemType, $itemTarget, self::$shareTypeUserAndGroups, \OC_User::getUser(), null, $format,
$parameters, 1, $includeCollections);
}
/**
* Get the item of item type shared with a given user by source
* @param string $itemType
* @param string $itemSource
* @param string $user User to whom the item was shared
* @param string $owner Owner of the share
* @param int $shareType only look for a specific share type
2014-02-18 15:37:32 +04:00
* @return array Return list of items with file_target, permissions and expiration
*/
public static function getItemSharedWithUser($itemType, $itemSource, $user, $owner = null, $shareType = null) {
2014-02-18 15:37:32 +04:00
$shares = array();
$fileDependent = false;
2014-02-18 15:37:32 +04:00
$where = 'WHERE';
$fileDependentWhere = '';
2014-10-01 17:13:10 +04:00
if ($itemType === 'file' || $itemType === 'folder') {
$fileDependent = true;
2014-10-01 17:13:10 +04:00
$column = 'file_source';
$fileDependentWhere = 'INNER JOIN `*PREFIX*filecache` ON `file_source` = `*PREFIX*filecache`.`fileid` ';
$fileDependentWhere .= 'INNER JOIN `*PREFIX*storages` ON `numeric_id` = `*PREFIX*filecache`.`storage` ';
2014-10-01 17:13:10 +04:00
} else {
$column = 'item_source';
}
$select = self::createSelectStatement(self::FORMAT_NONE, $fileDependent);
2014-10-01 17:13:10 +04:00
$where .= ' `' . $column . '` = ? AND `item_type` = ? ';
$arguments = array($itemSource, $itemType);
// for link shares $user === null
if ($user !== null) {
$where .= ' AND `share_with` = ? ';
$arguments[] = $user;
}
if ($shareType !== null) {
$where .= ' AND `share_type` = ? ';
$arguments[] = $shareType;
}
if ($owner !== null) {
$where .= ' AND `uid_owner` = ? ';
$arguments[] = $owner;
}
$query = \OC_DB::prepare('SELECT ' . $select . ' FROM `*PREFIX*share` '. $fileDependentWhere . $where);
2014-02-18 15:37:32 +04:00
$result = \OC_DB::executeAudited($query, $arguments);
2014-02-18 15:37:32 +04:00
while ($row = $result->fetchRow()) {
if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
continue;
}
if ($fileDependent && (int)$row['file_parent'] === -1) {
// if it is a mount point we need to get the path from the mount manager
$mountManager = \OC\Files\Filesystem::getMountManager();
$mountPoint = $mountManager->findByStorageId($row['storage_id']);
if (!empty($mountPoint)) {
$path = $mountPoint[0]->getMountPoint();
$path = trim($path, '/');
$path = substr($path, strlen($owner) + 1); //normalize path to 'files/foo.txt`
$row['path'] = $path;
} else {
\OC::$server->getLogger()->warning(
'Could not resolve mount point for ' . $row['storage_id'],
['app' => 'OCP\Share']
);
}
}
2014-02-18 15:37:32 +04:00
$shares[] = $row;
}
//if didn't found a result than let's look for a group share.
if(empty($shares) && $user !== null) {
2014-02-18 15:37:32 +04:00
$groups = \OC_Group::getUserGroups($user);
if (!empty($groups)) {
$where = $fileDependentWhere . ' WHERE `' . $column . '` = ? AND `item_type` = ? AND `share_with` in (?)';
$arguments = array($itemSource, $itemType, $groups);
$types = array(null, null, \Doctrine\DBAL\Connection::PARAM_STR_ARRAY);
if ($owner !== null) {
$where .= ' AND `uid_owner` = ?';
$arguments[] = $owner;
$types[] = null;
}
2014-02-18 15:37:32 +04:00
// TODO: inject connection, hopefully one day in the future when this
// class isn't static anymore...
2016-01-07 12:26:00 +03:00
$conn = \OC::$server->getDatabaseConnection();
$result = $conn->executeQuery(
'SELECT ' . $select . ' FROM `*PREFIX*share` ' . $where,
$arguments,
$types
);
2014-02-18 15:37:32 +04:00
while ($row = $result->fetch()) {
$shares[] = $row;
}
2014-02-18 15:37:32 +04:00
}
}
return $shares;
}
/**
* Get the item of item type shared with the current user by source
* @param string $itemType
* @param string $itemSource
* @param int $format (optional) Format type must be defined by the backend
* @param mixed $parameters
* @param boolean $includeCollections
2014-07-31 13:55:59 +04:00
* @param string $shareWith (optional) define against which user should be checked, default: current user
2014-09-25 13:29:57 +04:00
* @return array
2014-02-18 15:37:32 +04:00
*/
public static function getItemSharedWithBySource($itemType, $itemSource, $format = self::FORMAT_NONE,
$parameters = null, $includeCollections = false, $shareWith = null) {
2014-07-31 13:55:59 +04:00
$shareWith = ($shareWith === null) ? \OC_User::getUser() : $shareWith;
return self::getItems($itemType, $itemSource, self::$shareTypeUserAndGroups, $shareWith, null, $format,
2014-02-18 15:37:32 +04:00
$parameters, 1, $includeCollections, true);
}
/**
* Get the item of item type shared by a link
* @param string $itemType
* @param string $itemSource
* @param string $uidOwner Owner of link
2014-05-13 14:27:35 +04:00
* @return array
2014-02-18 15:37:32 +04:00
*/
public static function getItemSharedWithByLink($itemType, $itemSource, $uidOwner) {
return self::getItems($itemType, $itemSource, self::SHARE_TYPE_LINK, null, $uidOwner, self::FORMAT_NONE,
null, 1);
}
/**
* Based on the given token the share information will be returned - password protected shares will be verified
* @param string $token
* @param bool $checkPasswordProtection
2014-05-11 21:28:45 +04:00
* @return array|boolean false will be returned in case the token is unknown or unauthorized
2014-02-18 15:37:32 +04:00
*/
public static function getShareByToken($token, $checkPasswordProtection = true) {
$query = \OC_DB::prepare('SELECT * FROM `*PREFIX*share` WHERE `token` = ?', 1);
$result = $query->execute(array($token));
2016-01-07 12:14:05 +03:00
if ($result === false) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share', \OC_DB::getErrorMessage() . ', token=' . $token, \OCP\Util::ERROR);
2014-02-18 15:37:32 +04:00
}
$row = $result->fetchRow();
if ($row === false) {
return false;
}
if (is_array($row) and self::expireItem($row)) {
return false;
}
// password protected shares need to be authenticated
if ($checkPasswordProtection && !\OCP\Share::checkPasswordProtectedShare($row)) {
return false;
}
return $row;
}
/**
* resolves reshares down to the last real share
* @param array $linkItem
* @return array file owner
2014-02-18 15:37:32 +04:00
*/
public static function resolveReShare($linkItem)
{
if (isset($linkItem['parent'])) {
$parent = $linkItem['parent'];
while (isset($parent)) {
$query = \OC_DB::prepare('SELECT * FROM `*PREFIX*share` WHERE `id` = ?', 1);
$item = $query->execute(array($parent))->fetchRow();
if (isset($item['parent'])) {
$parent = $item['parent'];
} else {
return $item;
}
}
}
return $linkItem;
}
/**
* Get the shared items of item type owned by the current user
* @param string $itemType
* @param int $format (optional) Format type must be defined by the backend
* @param mixed $parameters
* @param int $limit Number of items to return (optional) Returns all by default
* @param boolean $includeCollections
* @return mixed Return depends on format
2014-02-18 15:37:32 +04:00
*/
public static function getItemsShared($itemType, $format = self::FORMAT_NONE, $parameters = null,
$limit = -1, $includeCollections = false) {
2014-02-18 15:37:32 +04:00
return self::getItems($itemType, null, null, null, \OC_User::getUser(), $format,
$parameters, $limit, $includeCollections);
}
/**
* Get the shared item of item type owned by the current user
* @param string $itemType
* @param string $itemSource
* @param int $format (optional) Format type must be defined by the backend
* @param mixed $parameters
* @param boolean $includeCollections
* @return mixed Return depends on format
2014-02-18 15:37:32 +04:00
*/
public static function getItemShared($itemType, $itemSource, $format = self::FORMAT_NONE,
$parameters = null, $includeCollections = false) {
2014-02-18 15:37:32 +04:00
return self::getItems($itemType, $itemSource, null, null, \OC_User::getUser(), $format,
$parameters, -1, $includeCollections);
}
/**
* Get all users an item is shared with
* @param string $itemType
* @param string $itemSource
* @param string $uidOwner
* @param boolean $includeCollections
* @param boolean $checkExpireDate
* @return array Return array of users
2014-02-18 15:37:32 +04:00
*/
public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) {
$users = array();
$items = self::getItems($itemType, $itemSource, null, null, $uidOwner, self::FORMAT_NONE, null, -1, $includeCollections, false, $checkExpireDate);
if ($items) {
foreach ($items as $item) {
if ((int)$item['share_type'] === self::SHARE_TYPE_USER) {
$users[] = $item['share_with'];
} else if ((int)$item['share_type'] === self::SHARE_TYPE_GROUP) {
$users = array_merge($users, \OC_Group::usersInGroup($item['share_with']));
}
}
}
return $users;
}
/**
* Share an item with a user, group, or via private link
* @param string $itemType
* @param string $itemSource
* @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
* @param string $shareWith User or group the item is being shared with
* @param int $permissions CRUDS
* @param string $itemSourceName
* @param \DateTime $expirationDate
* @param bool $passwordChanged
* @return boolean|string Returns true on success or false on failure, Returns token on success for links
* @throws \OC\HintException when the share type is remote and the shareWith is invalid
* @throws \Exception
2014-02-18 15:37:32 +04:00
*/
public static function shareItem($itemType, $itemSource, $shareType, $shareWith, $permissions, $itemSourceName = null, \DateTime $expirationDate = null, $passwordChanged = null) {
$backend = self::getBackend($itemType);
$l = \OC::$server->getL10N('lib');
if ($backend->isShareTypeAllowed($shareType) === false) {
$message = 'Sharing %s failed, because the backend does not allow shares from type %i';
$message_t = $l->t('Sharing %s failed, because the backend does not allow shares from type %i', array($itemSourceName, $shareType));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName, $shareType), \OCP\Util::DEBUG);
throw new \Exception($message_t);
}
2014-02-18 15:37:32 +04:00
$uidOwner = \OC_User::getUser();
2014-06-04 13:07:31 +04:00
$shareWithinGroupOnly = self::shareWithGroupMembersOnly();
2014-02-18 15:37:32 +04:00
if (is_null($itemSourceName)) {
$itemSourceName = $itemSource;
}
$itemName = $itemSourceName;
2014-02-18 15:37:32 +04:00
// check if file can be shared
if ($itemType === 'file' or $itemType === 'folder') {
$path = \OC\Files\Filesystem::getPath($itemSource);
$itemName = $path;
// verify that the file exists before we try to share it
if (!$path) {
$message = 'Sharing %s failed, because the file does not exist';
$message_t = $l->t('Sharing %s failed, because the file does not exist', array($itemSourceName));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName), \OCP\Util::DEBUG);
throw new \Exception($message_t);
}
// verify that the user has share permission
if (!\OC\Files\Filesystem::isSharable($path) || \OCP\Util::isSharingDisabledForUser()) {
$message = 'You are not allowed to share %s';
$message_t = $l->t('You are not allowed to share %s', [$path]);
\OCP\Util::writeLog('OCP\Share', sprintf($message, $path), \OCP\Util::DEBUG);
throw new \Exception($message_t);
}
}
//verify that we don't share a folder which already contains a share mount point
if ($itemType === 'folder') {
$path = '/' . $uidOwner . '/files' . \OC\Files\Filesystem::getPath($itemSource) . '/';
$mountManager = \OC\Files\Filesystem::getMountManager();
$mounts = $mountManager->findIn($path);
foreach ($mounts as $mount) {
if ($mount->getStorage()->instanceOfStorage('\OCA\Files_Sharing\ISharedStorage')) {
$message = 'Sharing "' . $itemSourceName . '" failed, because it contains files shared with you!';
\OCP\Util::writeLog('OCP\Share', $message, \OCP\Util::DEBUG);
throw new \Exception($message);
}
}
}
// single file shares should never have delete permissions
if ($itemType === 'file') {
$permissions = (int)$permissions & ~\OCP\Constants::PERMISSION_DELETE;
}
//Validate expirationDate
if ($expirationDate !== null) {
try {
/*
* Reuse the validateExpireDate.
* We have to pass time() since the second arg is the time
* the file was shared, since it is not shared yet we just use
* the current time.
*/
$expirationDate = self::validateExpireDate($expirationDate->format('Y-m-d'), time(), $itemType, $itemSource);
} catch (\Exception $e) {
throw new \OC\HintException($e->getMessage(), $e->getMessage(), 404);
}
}
2014-02-18 15:37:32 +04:00
// Verify share type and sharing conditions are met
if ($shareType === self::SHARE_TYPE_USER) {
if ($shareWith == $uidOwner) {
2015-10-16 11:00:33 +03:00
$message = 'Sharing %s failed, because you can not share with yourself';
$message_t = $l->t('Sharing %s failed, because you can not share with yourself', [$itemName]);
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName), \OCP\Util::DEBUG);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
if (!\OC_User::userExists($shareWith)) {
$message = 'Sharing %s failed, because the user %s does not exist';
$message_t = $l->t('Sharing %s failed, because the user %s does not exist', array($itemSourceName, $shareWith));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OCP\Util::DEBUG);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
2014-06-04 13:07:31 +04:00
if ($shareWithinGroupOnly) {
2014-02-18 15:37:32 +04:00
$inGroup = array_intersect(\OC_Group::getUserGroups($uidOwner), \OC_Group::getUserGroups($shareWith));
if (empty($inGroup)) {
$message = 'Sharing %s failed, because the user '
.'%s is not a member of any groups that %s is a member of';
$message_t = $l->t('Sharing %s failed, because the user %s is not a member of any groups that %s is a member of', array($itemName, $shareWith, $uidOwner));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemName, $shareWith, $uidOwner), \OCP\Util::DEBUG);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
}
// Check if the item source is already shared with the user, either from the same owner or a different user
if ($checkExists = self::getItems($itemType, $itemSource, self::$shareTypeUserAndGroups,
$shareWith, null, self::FORMAT_NONE, null, 1, true, true)) {
// Only allow the same share to occur again if it is the same
// owner and is not a user share, this use case is for increasing
// permissions for a specific user
if ($checkExists['uid_owner'] != $uidOwner || $checkExists['share_type'] == $shareType) {
$message = 'Sharing %s failed, because this item is already shared with %s';
$message_t = $l->t('Sharing %s failed, because this item is already shared with %s', array($itemSourceName, $shareWith));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OCP\Util::DEBUG);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
}
if ($checkExists = self::getItems($itemType, $itemSource, self::SHARE_TYPE_USER,
$shareWith, null, self::FORMAT_NONE, null, 1, true, true)) {
// Only allow the same share to occur again if it is the same
// owner and is not a user share, this use case is for increasing
// permissions for a specific user
if ($checkExists['uid_owner'] != $uidOwner || $checkExists['share_type'] == $shareType) {
$message = 'Sharing %s failed, because this item is already shared with user %s';
$message_t = $l->t('Sharing %s failed, because this item is already shared with user %s', array($itemSourceName, $shareWith));
2015-10-06 15:18:22 +03:00
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OCP\Util::ERROR);
throw new \Exception($message_t);
}
}
2014-02-18 15:37:32 +04:00
} else if ($shareType === self::SHARE_TYPE_GROUP) {
if (!\OC_Group::groupExists($shareWith)) {
$message = 'Sharing %s failed, because the group %s does not exist';
$message_t = $l->t('Sharing %s failed, because the group %s does not exist', array($itemSourceName, $shareWith));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OCP\Util::DEBUG);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
2014-06-04 13:07:31 +04:00
if ($shareWithinGroupOnly && !\OC_Group::inGroup($uidOwner, $shareWith)) {
$message = 'Sharing %s failed, because '
.'%s is not a member of the group %s';
$message_t = $l->t('Sharing %s failed, because %s is not a member of the group %s', array($itemSourceName, $uidOwner, $shareWith));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName, $uidOwner, $shareWith), \OCP\Util::DEBUG);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
// Check if the item source is already shared with the group, either from the same owner or a different user
// The check for each user in the group is done inside the put() function
if ($checkExists = self::getItems($itemType, $itemSource, self::SHARE_TYPE_GROUP, $shareWith,
null, self::FORMAT_NONE, null, 1, true, true)) {
if ($checkExists['share_with'] === $shareWith && $checkExists['share_type'] === \OCP\Share::SHARE_TYPE_GROUP) {
$message = 'Sharing %s failed, because this item is already shared with %s';
$message_t = $l->t('Sharing %s failed, because this item is already shared with %s', array($itemSourceName, $shareWith));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OCP\Util::DEBUG);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
}
// Convert share with into an array with the keys group and users
$group = $shareWith;
$shareWith = array();
$shareWith['group'] = $group;
$shareWith['users'] = array_diff(\OC_Group::usersInGroup($group), array($uidOwner));
} else if ($shareType === self::SHARE_TYPE_LINK) {
$updateExistingShare = false;
2015-07-03 15:16:29 +03:00
if (\OC::$server->getAppConfig()->getValue('core', 'shareapi_allow_links', 'yes') == 'yes') {
// IF the password is changed via the old ajax endpoint verify it before deleting the old share
if ($passwordChanged === true) {
self::verifyPassword($shareWith);
}
2014-02-18 15:37:32 +04:00
// when updating a link share
// FIXME Don't delete link if we update it
2014-02-18 15:37:32 +04:00
if ($checkExists = self::getItems($itemType, $itemSource, self::SHARE_TYPE_LINK, null,
$uidOwner, self::FORMAT_NONE, null, 1)) {
// remember old token
$oldToken = $checkExists['token'];
$oldPermissions = $checkExists['permissions'];
//delete the old share
Helper::delete($checkExists['id']);
2014-06-03 17:15:04 +04:00
$updateExistingShare = true;
2014-02-18 15:37:32 +04:00
}
if ($passwordChanged === null) {
// Generate hash of password - same method as user passwords
if (is_string($shareWith) && $shareWith !== '') {
self::verifyPassword($shareWith);
$shareWith = \OC::$server->getHasher()->hash($shareWith);
} else {
// reuse the already set password, but only if we change permissions
// otherwise the user disabled the password protection
if ($checkExists && (int)$permissions !== (int)$oldPermissions) {
$shareWith = $checkExists['share_with'];
}
}
2014-02-18 15:37:32 +04:00
} else {
if ($passwordChanged === true) {
if (is_string($shareWith) && $shareWith !== '') {
self::verifyPassword($shareWith);
$shareWith = \OC::$server->getHasher()->hash($shareWith);
}
} else if ($updateExistingShare) {
2014-02-18 15:37:32 +04:00
$shareWith = $checkExists['share_with'];
}
}
if (\OCP\Util::isPublicLinkPasswordRequired() && empty($shareWith)) {
$message = 'You need to provide a password to create a public link, only protected links are allowed';
$message_t = $l->t('You need to provide a password to create a public link, only protected links are allowed');
\OCP\Util::writeLog('OCP\Share', $message, \OCP\Util::DEBUG);
throw new \Exception($message_t);
}
if ($updateExistingShare === false &&
self::isDefaultExpireDateEnabled() &&
empty($expirationDate)) {
2014-06-03 17:15:04 +04:00
$expirationDate = Helper::calcExpireDate();
}
2014-02-18 15:37:32 +04:00
// Generate token
if (isset($oldToken)) {
$token = $oldToken;
} else {
$token = \OC::$server->getSecureRandom()->generate(self::TOKEN_LENGTH,
\OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_UPPER.
\OCP\Security\ISecureRandom::CHAR_DIGITS
);
2014-02-18 15:37:32 +04:00
}
$result = self::put($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $permissions,
null, $token, $itemSourceName, $expirationDate);
2014-02-18 15:37:32 +04:00
if ($result) {
return $token;
} else {
return false;
}
}
$message = 'Sharing %s failed, because sharing with links is not allowed';
$message_t = $l->t('Sharing %s failed, because sharing with links is not allowed', array($itemSourceName));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName), \OCP\Util::DEBUG);
throw new \Exception($message_t);
} else if ($shareType === self::SHARE_TYPE_REMOTE) {
/*
* Check if file is not already shared with the remote user
*/
if ($checkExists = self::getItems($itemType, $itemSource, self::SHARE_TYPE_REMOTE,
$shareWith, $uidOwner, self::FORMAT_NONE, null, 1, true, true)) {
$message = 'Sharing %s failed, because this item is already shared with %s';
$message_t = $l->t('Sharing %s failed, because this item is already shared with %s', array($itemSourceName, $shareWith));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OCP\Util::DEBUG);
throw new \Exception($message_t);
}
// don't allow federated shares if source and target server are the same
list($user, $remote) = Helper::splitUserRemote($shareWith);
$currentServer = self::removeProtocolFromUrl(\OC::$server->getURLGenerator()->getAbsoluteURL('/'));
$currentUser = \OC::$server->getUserSession()->getUser()->getUID();
if (Helper::isSameUserOnSameServer($user, $remote, $currentUser, $currentServer)) {
$message = 'Not allowed to create a federated share with the same user.';
$message_t = $l->t('Not allowed to create a federated share with the same user');
\OCP\Util::writeLog('OCP\Share', $message, \OCP\Util::DEBUG);
throw new \Exception($message_t);
}
$token = \OC::$server->getSecureRandom()->generate(self::TOKEN_LENGTH, \OCP\Security\ISecureRandom::CHAR_LOWER . \OCP\Security\ISecureRandom::CHAR_UPPER .
\OCP\Security\ISecureRandom::CHAR_DIGITS);
$shareWith = $user . '@' . $remote;
$shareId = self::put($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $permissions, null, $token, $itemSourceName);
$send = false;
if ($shareId) {
$send = self::sendRemoteShare($token, $shareWith, $itemSourceName, $shareId, $uidOwner);
}
if ($send === false) {
$currentUser = \OC::$server->getUserSession()->getUser()->getUID();
self::unshare($itemType, $itemSource, $shareType, $shareWith, $currentUser);
$message_t = $l->t('Sharing %s failed, could not find %s, maybe the server is currently unreachable.', array($itemSourceName, $shareWith));
throw new \Exception($message_t);
}
return $send;
2014-02-18 15:37:32 +04:00
} else {
// Future share types need to include their own conditions
$message = 'Share type %s is not valid for %s';
$message_t = $l->t('Share type %s is not valid for %s', array($shareType, $itemSource));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $shareType, $itemSource), \OCP\Util::DEBUG);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
// Put the item into the database
$result = self::put($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $permissions, null, null, $itemSourceName, $expirationDate);
return $result ? true : false;
2014-02-18 15:37:32 +04:00
}
/**
* Unshare an item from a user, group, or delete a private link
* @param string $itemType
* @param string $itemSource
* @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
* @param string $shareWith User or group the item is being shared with
2014-11-24 17:31:52 +03:00
* @param string $owner owner of the share, if null the current user is used
* @return boolean true on success or false on failure
2014-02-18 15:37:32 +04:00
*/
2014-11-24 17:31:52 +03:00
public static function unshare($itemType, $itemSource, $shareType, $shareWith, $owner = null) {
// check if it is a valid itemType
self::getBackend($itemType);
2014-11-24 17:31:52 +03:00
$items = self::getItemSharedWithUser($itemType, $itemSource, $shareWith, $owner, $shareType);
$toDelete = array();
$newParent = null;
2014-11-24 17:31:52 +03:00
$currentUser = $owner ? $owner : \OC_User::getUser();
foreach ($items as $item) {
// delete the item with the expected share_type and owner
if ((int)$item['share_type'] === (int)$shareType && $item['uid_owner'] === $currentUser) {
$toDelete = $item;
// if there is more then one result we don't have to delete the children
// but update their parent. For group shares the new parent should always be
// the original group share and not the db entry with the unique name
} else if ((int)$item['share_type'] === self::$shareTypeGroupUserUnique) {
$newParent = $item['parent'];
} else {
$newParent = $item['id'];
}
}
if (!empty($toDelete)) {
self::unshareItem($toDelete, $newParent);
2014-02-18 15:37:32 +04:00
return true;
}
return false;
}
/**
* Unshare an item from all users, groups, and remove all links
* @param string $itemType
* @param string $itemSource
* @return boolean true on success or false on failure
2014-02-18 15:37:32 +04:00
*/
public static function unshareAll($itemType, $itemSource) {
// Get all of the owners of shares of this item.
$query = \OC_DB::prepare( 'SELECT `uid_owner` from `*PREFIX*share` WHERE `item_type`=? AND `item_source`=?' );
$result = $query->execute(array($itemType, $itemSource));
$shares = array();
// Add each owner's shares to the array of all shares for this item.
while ($row = $result->fetchRow()) {
$shares = array_merge($shares, self::getItems($itemType, $itemSource, null, null, $row['uid_owner']));
}
if (!empty($shares)) {
// Pass all the vars we have for now, they may be useful
$hookParams = array(
'itemType' => $itemType,
'itemSource' => $itemSource,
'shares' => $shares,
);
\OC_Hook::emit('OCP\Share', 'pre_unshareAll', $hookParams);
foreach ($shares as $share) {
self::unshareItem($share);
}
\OC_Hook::emit('OCP\Share', 'post_unshareAll', $hookParams);
return true;
}
return false;
}
/**
* Unshare an item shared with the current user
* @param string $itemType
* @param string $itemOrigin Item target or source
* @param boolean $originIsSource true if $itemOrigin is the source, false if $itemOrigin is the target (optional)
* @return boolean true on success or false on failure
2014-02-18 15:37:32 +04:00
*
* Unsharing from self is not allowed for items inside collections
*/
public static function unshareFromSelf($itemType, $itemOrigin, $originIsSource = false) {
$originType = ($originIsSource) ? 'source' : 'target';
$uid = \OCP\User::getUser();
2014-06-04 20:41:47 +04:00
if ($itemType === 'file' || $itemType === 'folder') {
$statement = 'SELECT * FROM `*PREFIX*share` WHERE `item_type` = ? and `file_' . $originType . '` = ?';
2014-06-04 20:41:47 +04:00
} else {
$statement = 'SELECT * FROM `*PREFIX*share` WHERE `item_type` = ? and `item_' . $originType . '` = ?';
2014-06-04 20:41:47 +04:00
}
$query = \OCP\DB::prepare($statement);
$result = $query->execute(array($itemType, $itemOrigin));
2014-06-04 20:41:47 +04:00
$shares = $result->fetchAll();
$listOfUnsharedItems = array();
2014-06-04 20:41:47 +04:00
$itemUnshared = false;
foreach ($shares as $share) {
if ((int)$share['share_type'] === \OCP\Share::SHARE_TYPE_USER &&
$share['share_with'] === $uid) {
$deletedShares = Helper::delete($share['id']);
$shareTmp = array(
'id' => $share['id'],
'shareWith' => $share['share_with'],
'itemTarget' => $share['item_target'],
'itemType' => $share['item_type'],
'shareType' => (int)$share['share_type'],
);
if (isset($share['file_target'])) {
$shareTmp['fileTarget'] = $share['file_target'];
}
$listOfUnsharedItems = array_merge($listOfUnsharedItems, $deletedShares, array($shareTmp));
2014-06-04 20:41:47 +04:00
$itemUnshared = true;
break;
} elseif ((int)$share['share_type'] === \OCP\Share::SHARE_TYPE_GROUP) {
if (\OC_Group::inGroup($uid, $share['share_with'])) {
$groupShare = $share;
}
} elseif ((int)$share['share_type'] === self::$shareTypeGroupUserUnique &&
$share['share_with'] === $uid) {
2014-06-04 20:41:47 +04:00
$uniqueGroupShare = $share;
}
}
if (!$itemUnshared && isset($groupShare) && !isset($uniqueGroupShare)) {
2014-06-04 20:41:47 +04:00
$query = \OC_DB::prepare('INSERT INTO `*PREFIX*share`'
.' (`item_type`, `item_source`, `item_target`, `parent`, `share_type`,'
.' `share_with`, `uid_owner`, `permissions`, `stime`, `file_source`, `file_target`)'
.' VALUES (?,?,?,?,?,?,?,?,?,?,?)');
2014-06-04 20:41:47 +04:00
$query->execute(array($groupShare['item_type'], $groupShare['item_source'], $groupShare['item_target'],
$groupShare['id'], self::$shareTypeGroupUserUnique,
\OC_User::getUser(), $groupShare['uid_owner'], 0, $groupShare['stime'], $groupShare['file_source'],
$groupShare['file_target']));
$shareTmp = array(
'id' => $groupShare['id'],
'shareWith' => $groupShare['share_with'],
'itemTarget' => $groupShare['item_target'],
'itemType' => $groupShare['item_type'],
'shareType' => (int)$groupShare['share_type'],
);
if (isset($groupShare['file_target'])) {
$shareTmp['fileTarget'] = $groupShare['file_target'];
}
$listOfUnsharedItems = array_merge($listOfUnsharedItems, array($groupShare));
2014-06-04 20:41:47 +04:00
$itemUnshared = true;
} elseif (!$itemUnshared && isset($uniqueGroupShare)) {
$query = \OC_DB::prepare('UPDATE `*PREFIX*share` SET `permissions` = ? WHERE `id` = ?');
$query->execute(array(0, $uniqueGroupShare['id']));
$shareTmp = array(
'id' => $uniqueGroupShare['id'],
'shareWith' => $uniqueGroupShare['share_with'],
'itemTarget' => $uniqueGroupShare['item_target'],
'itemType' => $uniqueGroupShare['item_type'],
'shareType' => (int)$uniqueGroupShare['share_type'],
);
if (isset($uniqueGroupShare['file_target'])) {
$shareTmp['fileTarget'] = $uniqueGroupShare['file_target'];
}
$listOfUnsharedItems = array_merge($listOfUnsharedItems, array($uniqueGroupShare));
2014-06-04 20:41:47 +04:00
$itemUnshared = true;
2014-02-18 15:37:32 +04:00
}
2014-06-04 20:41:47 +04:00
if ($itemUnshared) {
\OC_Hook::emit('OCP\Share', 'post_unshareFromSelf',
array('unsharedItems' => $listOfUnsharedItems, 'itemType' => $itemType));
}
2014-06-04 20:41:47 +04:00
return $itemUnshared;
2014-02-18 15:37:32 +04:00
}
2014-02-18 15:37:32 +04:00
/**
* sent status if users got informed by mail about share
* @param string $itemType
* @param string $itemSource
* @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
* @param string $recipient with whom was the file shared
* @param boolean $status
2014-02-18 15:37:32 +04:00
*/
public static function setSendMailStatus($itemType, $itemSource, $shareType, $recipient, $status) {
2014-02-18 15:37:32 +04:00
$status = $status ? 1 : 0;
$query = \OC_DB::prepare(
'UPDATE `*PREFIX*share`
2014-02-18 15:37:32 +04:00
SET `mail_send` = ?
WHERE `item_type` = ? AND `item_source` = ? AND `share_type` = ? AND `share_with` = ?');
2014-02-18 15:37:32 +04:00
$result = $query->execute(array($status, $itemType, $itemSource, $shareType, $recipient));
2014-02-18 15:37:32 +04:00
if($result === false) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share', 'Couldn\'t set send mail status', \OCP\Util::ERROR);
2014-02-18 15:37:32 +04:00
}
}
/**
* Set the permissions of an item for a specific user or group
* @param string $itemType
* @param string $itemSource
* @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
* @param string $shareWith User or group the item is being shared with
* @param int $permissions CRUDS permissions
* @return boolean true on success or false on failure
* @throws \Exception when trying to grant more permissions then the user has himself
2014-02-18 15:37:32 +04:00
*/
public static function setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions) {
2014-08-31 12:05:59 +04:00
$l = \OC::$server->getL10N('lib');
$connection = \OC::$server->getDatabaseConnection();
$intArrayToLiteralArray = function($intArray, $eb) {
return array_map(function($int) use ($eb) {
return $eb->literal((int)$int, 'integer');
}, $intArray);
};
$sanitizeItem = function($item) {
$item['id'] = (int)$item['id'];
$item['premissions'] = (int)$item['permissions'];
return $item;
};
if ($rootItem = self::getItems($itemType, $itemSource, $shareType, $shareWith,
2014-02-18 15:37:32 +04:00
\OC_User::getUser(), self::FORMAT_NONE, null, 1, false)) {
// Check if this item is a reshare and verify that the permissions
// granted don't exceed the parent shared item
if (isset($rootItem['parent'])) {
$qb = $connection->getQueryBuilder();
$qb->select('permissions')
->from('share')
->where($qb->expr()->eq('id', $qb->createParameter('id')))
->setParameter(':id', $rootItem['parent']);
2015-10-27 12:22:59 +03:00
$dbresult = $qb->execute();
2015-10-27 12:22:59 +03:00
$result = $dbresult->fetch();
$dbresult->closeCursor();
2014-02-18 15:37:32 +04:00
if (~(int)$result['permissions'] & $permissions) {
$message = 'Setting permissions for %s failed,'
.' because the permissions exceed permissions granted to %s';
$message_t = $l->t('Setting permissions for %s failed, because the permissions exceed permissions granted to %s', array($itemSource, \OC_User::getUser()));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSource, \OC_User::getUser()), \OCP\Util::DEBUG);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
}
$qb = $connection->getQueryBuilder();
$qb->update('share')
->set('permissions', $qb->createParameter('permissions'))
->where($qb->expr()->eq('id', $qb->createParameter('id')))
->setParameter(':id', $rootItem['id'])
->setParameter(':permissions', $permissions);
$qb->execute();
2014-02-18 15:37:32 +04:00
if ($itemType === 'file' || $itemType === 'folder') {
\OC_Hook::emit('OCP\Share', 'post_update_permissions', array(
'itemType' => $itemType,
'itemSource' => $itemSource,
'shareType' => $shareType,
'shareWith' => $shareWith,
'uidOwner' => \OC_User::getUser(),
'permissions' => $permissions,
'path' => $rootItem['path'],
'share' => $rootItem
2014-02-18 15:37:32 +04:00
));
}
// Share id's to update with the new permissions
$ids = [];
$items = [];
2014-02-18 15:37:32 +04:00
// Check if permissions were removed
if ((int)$rootItem['permissions'] & ~$permissions) {
2014-02-18 15:37:32 +04:00
// If share permission is removed all reshares must be deleted
if (($rootItem['permissions'] & \OCP\Constants::PERMISSION_SHARE) && (~$permissions & \OCP\Constants::PERMISSION_SHARE)) {
// delete all shares, keep parent and group children
Helper::delete($rootItem['id'], true, null, null, true);
}
// Remove permission from all children
$parents = [$rootItem['id']];
while (!empty($parents)) {
$parents = $intArrayToLiteralArray($parents, $qb->expr());
$qb = $connection->getQueryBuilder();
$qb->select('id', 'permissions', 'item_type')
->from('share')
->where($qb->expr()->in('parent', $parents));
$result = $qb->execute();
// Reset parents array, only go through loop again if
// items are found that need permissions removed
$parents = [];
while ($item = $result->fetch()) {
$item = $sanitizeItem($item);
$items[] = $item;
// Check if permissions need to be removed
if ($item['permissions'] & ~$permissions) {
// Add to list of items that need permissions removed
$ids[] = $item['id'];
$parents[] = $item['id'];
2014-02-18 15:37:32 +04:00
}
}
2015-10-27 12:22:59 +03:00
$result->closeCursor();
}
// Remove the permissions for all reshares of this item
if (!empty($ids)) {
$ids = "'".implode("','", $ids)."'";
// TODO this should be done with Doctrine platform objects
if (\OC::$server->getConfig()->getSystemValue("dbtype") === 'oci') {
$andOp = 'BITAND(`permissions`, ?)';
} else {
$andOp = '`permissions` & ?';
}
$query = \OC_DB::prepare('UPDATE `*PREFIX*share` SET `permissions` = '.$andOp
.' WHERE `id` IN ('.$ids.')');
$query->execute(array($permissions));
2014-02-18 15:37:32 +04:00
}
}
/*
* Permissions were added
2015-10-27 12:22:59 +03:00
* Update all USERGROUP shares. (So group shares where the user moved their mountpoint).
*/
if ($permissions & ~(int)$rootItem['permissions']) {
$qb = $connection->getQueryBuilder();
$qb->select('id', 'permissions', 'item_type')
->from('share')
->where($qb->expr()->eq('parent', $qb->createParameter('parent')))
->andWhere($qb->expr()->eq('share_type', $qb->createParameter('share_type')))
->andWhere($qb->expr()->neq('permissions', $qb->createParameter('shareDeleted')))
->setParameter(':parent', (int)$rootItem['id'])
->setParameter(':share_type', 2)
->setParameter(':shareDeleted', 0);
$result = $qb->execute();
$ids = [];
while ($item = $result->fetch()) {
$item = $sanitizeItem($item);
$items[] = $item;
$ids[] = $item['id'];
}
2015-10-27 12:22:59 +03:00
$result->closeCursor();
// Add permssions for all USERGROUP shares of this item
if (!empty($ids)) {
$ids = $intArrayToLiteralArray($ids, $qb->expr());
$qb = $connection->getQueryBuilder();
$qb->update('share')
->set('permissions', $qb->createParameter('permissions'))
->where($qb->expr()->in('id', $ids))
->setParameter(':permissions', $permissions);
$qb->execute();
}
}
foreach ($items as $item) {
\OC_Hook::emit('OCP\Share', 'post_update_permissions', ['share' => $item]);
2014-02-18 15:37:32 +04:00
}
2014-02-18 15:37:32 +04:00
return true;
}
$message = 'Setting permissions for %s failed, because the item was not found';
$message_t = $l->t('Setting permissions for %s failed, because the item was not found', array($itemSource));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSource), \OCP\Util::DEBUG);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
/**
2014-08-02 06:02:39 +04:00
* validate expiration date if it meets all constraints
*
* @param string $expireDate well formate date string, e.g. "DD-MM-YYYY"
* @param string $shareTime timestamp when the file was shared
* @param string $itemType
* @param string $itemSource
* @return \DateTime validated date
* @throws \Exception when the expire date is in the past or further in the future then the enforced date
*/
private static function validateExpireDate($expireDate, $shareTime, $itemType, $itemSource) {
2014-08-31 12:05:59 +04:00
$l = \OC::$server->getL10N('lib');
$date = new \DateTime($expireDate);
$today = new \DateTime('now');
// if the user doesn't provide a share time we need to get it from the database
// fall-back mode to keep API stable, because the $shareTime parameter was added later
$defaultExpireDateEnforced = \OCP\Util::isDefaultExpireDateEnforced();
if ($defaultExpireDateEnforced && $shareTime === null) {
$items = self::getItemShared($itemType, $itemSource);
$firstItem = reset($items);
$shareTime = (int)$firstItem['stime'];
}
if ($defaultExpireDateEnforced) {
// initialize max date with share time
$maxDate = new \DateTime();
$maxDate->setTimestamp($shareTime);
$maxDays = \OCP\Config::getAppValue('core', 'shareapi_expire_after_n_days', '7');
$maxDate->add(new \DateInterval('P' . $maxDays . 'D'));
if ($date > $maxDate) {
2014-08-06 22:48:26 +04:00
$warning = 'Cannot set expiration date. Shares cannot expire later than ' . $maxDays . ' after they have been shared';
$warning_t = $l->t('Cannot set expiration date. Shares cannot expire later than %s after they have been shared', array($maxDays));
\OCP\Util::writeLog('OCP\Share', $warning, \OCP\Util::WARN);
throw new \Exception($warning_t);
}
}
if ($date < $today) {
2014-08-02 06:02:39 +04:00
$message = 'Cannot set expiration date. Expiration date is in the past';
$message_t = $l->t('Cannot set expiration date. Expiration date is in the past');
\OCP\Util::writeLog('OCP\Share', $message, \OCP\Util::WARN);
throw new \Exception($message_t);
}
return $date;
}
2014-02-18 15:37:32 +04:00
/**
* Set expiration date for a share
* @param string $itemType
* @param string $itemSource
* @param string $date expiration date
* @param int $shareTime timestamp from when the file was shared
* @return boolean
* @throws \Exception when the expire date is not set, in the past or further in the future then the enforced date
2014-02-18 15:37:32 +04:00
*/
public static function setExpirationDate($itemType, $itemSource, $date, $shareTime = null) {
$user = \OC_User::getUser();
$l = \OC::$server->getL10N('lib');
2014-06-03 17:15:04 +04:00
if ($date == '') {
if (\OCP\Util::isDefaultExpireDateEnforced()) {
$warning = 'Cannot clear expiration date. Shares are required to have an expiration date.';
$warning_t = $l->t('Cannot clear expiration date. Shares are required to have an expiration date.');
\OCP\Util::writeLog('OCP\Share', $warning, \OCP\Util::WARN);
throw new \Exception($warning_t);
} else {
$date = null;
}
2014-06-03 17:15:04 +04:00
} else {
$date = self::validateExpireDate($date, $shareTime, $itemType, $itemSource);
2014-02-18 15:37:32 +04:00
}
2014-06-03 17:15:04 +04:00
$query = \OC_DB::prepare('UPDATE `*PREFIX*share` SET `expiration` = ? WHERE `item_type` = ? AND `item_source` = ? AND `uid_owner` = ? AND `share_type` = ?');
$query->bindValue(1, $date, 'datetime');
$query->bindValue(2, $itemType);
$query->bindValue(3, $itemSource);
$query->bindValue(4, $user);
$query->bindValue(5, \OCP\Share::SHARE_TYPE_LINK);
2014-07-09 16:40:05 +04:00
$query->execute();
\OC_Hook::emit('OCP\Share', 'post_set_expiration_date', array(
'itemType' => $itemType,
'itemSource' => $itemSource,
'date' => $date,
'uidOwner' => $user
));
2014-07-09 16:40:05 +04:00
return true;
}
2014-07-09 16:40:05 +04:00
/**
* Retrieve the owner of a connection
*
* @param IDBConnection $connection
* @param int $shareId
* @throws \Exception
* @return string uid of share owner
*/
private static function getShareOwner(IDBConnection $connection, $shareId) {
$qb = $connection->getQueryBuilder();
$qb->select('uid_owner')
->from('share')
->where($qb->expr()->eq('id', $qb->createParameter('shareId')))
2015-03-30 21:07:12 +03:00
->setParameter(':shareId', $shareId);
$result = $qb->execute();
$result = $result->fetch();
if (empty($result)) {
throw new \Exception('Share not found');
}
return $result['uid_owner'];
}
/**
2015-07-23 17:09:40 +03:00
* Set password for a public link share
*
* @param IUserSession $userSession
* @param IDBConnection $connection
* @param IConfig $config
* @param int $shareId
* @param string $password
* @throws \Exception
* @return boolean
*/
public static function setPassword(IUserSession $userSession,
IDBConnection $connection,
IConfig $config,
$shareId, $password) {
$user = $userSession->getUser();
if (is_null($user)) {
throw new \Exception("User not logged in");
}
$uid = self::getShareOwner($connection, $shareId);
if ($uid !== $user->getUID()) {
throw new \Exception('Cannot update share of a different user');
}
if ($password === '') {
$password = null;
}
//If passwords are enforced the password can't be null
if (self::enforcePassword($config) && is_null($password)) {
throw new \Exception('Cannot remove password');
}
self::verifyPassword($password);
$qb = $connection->getQueryBuilder();
$qb->update('share')
->set('share_with', $qb->createParameter('pass'))
->where($qb->expr()->eq('id', $qb->createParameter('shareId')))
->setParameter(':pass', is_null($password) ? null : \OC::$server->getHasher()->hash($password))
2015-03-30 21:07:12 +03:00
->setParameter(':shareId', $shareId);
$qb->execute();
return true;
}
2014-02-18 15:37:32 +04:00
/**
* Checks whether a share has expired, calls unshareItem() if yes.
* @param array $item Share data (usually database row)
* @return boolean True if item was expired, false otherwise.
2014-02-18 15:37:32 +04:00
*/
protected static function expireItem(array $item) {
2014-04-23 14:50:24 +04:00
2014-06-03 17:15:04 +04:00
$result = false;
2014-08-02 06:02:39 +04:00
// only use default expiration date for link shares
2014-06-03 17:15:04 +04:00
if ((int) $item['share_type'] === self::SHARE_TYPE_LINK) {
2014-08-02 06:02:39 +04:00
// calculate expiration date
2014-06-03 17:15:04 +04:00
if (!empty($item['expiration'])) {
$userDefinedExpire = new \DateTime($item['expiration']);
$expires = $userDefinedExpire->getTimestamp();
} else {
$expires = null;
}
2014-08-02 06:02:39 +04:00
// get default expiration settings
$defaultSettings = Helper::getDefaultExpireSetting();
$expires = Helper::calculateExpireDate($defaultSettings, $item['stime'], $expires);
2014-04-23 14:50:24 +04:00
2014-06-03 17:15:04 +04:00
if (is_int($expires)) {
$now = time();
if ($now > $expires) {
self::unshareItem($item);
$result = true;
}
2014-02-18 15:37:32 +04:00
}
}
2014-06-03 17:15:04 +04:00
return $result;
2014-02-18 15:37:32 +04:00
}
/**
* Unshares a share given a share data array
* @param array $item Share data (usually database row)
* @param int $newParent parent ID
2014-02-18 15:37:32 +04:00
* @return null
*/
protected static function unshareItem(array $item, $newParent = null) {
$shareType = (int)$item['share_type'];
$shareWith = null;
if ($shareType !== \OCP\Share::SHARE_TYPE_LINK) {
$shareWith = $item['share_with'];
}
2014-02-18 15:37:32 +04:00
// Pass all the vars we have for now, they may be useful
$hookParams = array(
'id' => $item['id'],
2014-02-18 15:37:32 +04:00
'itemType' => $item['item_type'],
'itemSource' => $item['item_source'],
'shareType' => $shareType,
'shareWith' => $shareWith,
2014-02-18 15:37:32 +04:00
'itemParent' => $item['parent'],
'uidOwner' => $item['uid_owner'],
);
if($item['item_type'] === 'file' || $item['item_type'] === 'folder') {
$hookParams['fileSource'] = $item['file_source'];
$hookParams['fileTarget'] = $item['file_target'];
}
2014-02-18 15:37:32 +04:00
\OC_Hook::emit('OCP\Share', 'pre_unshare', $hookParams);
$deletedShares = Helper::delete($item['id'], false, null, $newParent);
$deletedShares[] = $hookParams;
$hookParams['deletedShares'] = $deletedShares;
2014-02-18 15:37:32 +04:00
\OC_Hook::emit('OCP\Share', 'post_unshare', $hookParams);
if ((int)$item['share_type'] === \OCP\Share::SHARE_TYPE_REMOTE && \OC::$server->getUserSession()->getUser()) {
list(, $remote) = Helper::splitUserRemote($item['share_with']);
self::sendRemoteUnshare($remote, $item['id'], $item['token']);
}
2014-02-18 15:37:32 +04:00
}
/**
* Get the backend class for the specified item type
* @param string $itemType
2014-05-13 14:27:35 +04:00
* @throws \Exception
2014-02-18 15:37:32 +04:00
* @return \OCP\Share_Backend
*/
public static function getBackend($itemType) {
2014-08-31 12:05:59 +04:00
$l = \OC::$server->getL10N('lib');
2014-02-18 15:37:32 +04:00
if (isset(self::$backends[$itemType])) {
return self::$backends[$itemType];
} else if (isset(self::$backendTypes[$itemType]['class'])) {
$class = self::$backendTypes[$itemType]['class'];
if (class_exists($class)) {
self::$backends[$itemType] = new $class;
if (!(self::$backends[$itemType] instanceof \OCP\Share_Backend)) {
$message = 'Sharing backend %s must implement the interface OCP\Share_Backend';
$message_t = $l->t('Sharing backend %s must implement the interface OCP\Share_Backend', array($class));
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share', sprintf($message, $class), \OCP\Util::ERROR);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
return self::$backends[$itemType];
} else {
$message = 'Sharing backend %s not found';
$message_t = $l->t('Sharing backend %s not found', array($class));
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share', sprintf($message, $class), \OCP\Util::ERROR);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
}
$message = 'Sharing backend for %s not found';
$message_t = $l->t('Sharing backend for %s not found', array($itemType));
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemType), \OCP\Util::ERROR);
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
/**
* Check if resharing is allowed
* @return boolean true if allowed or false
2014-02-18 15:37:32 +04:00
*
* Resharing is allowed by default if not configured
*/
public static function isResharingAllowed() {
2014-02-18 15:37:32 +04:00
if (!isset(self::$isResharingAllowed)) {
2015-07-03 15:16:29 +03:00
if (\OC::$server->getAppConfig()->getValue('core', 'shareapi_allow_resharing', 'yes') == 'yes') {
2014-02-18 15:37:32 +04:00
self::$isResharingAllowed = true;
} else {
self::$isResharingAllowed = false;
}
}
return self::$isResharingAllowed;
}
/**
* Get a list of collection item types for the specified item type
* @param string $itemType
2014-02-18 15:37:32 +04:00
* @return array
*/
private static function getCollectionItemTypes($itemType) {
$collectionTypes = array($itemType);
foreach (self::$backendTypes as $type => $backend) {
if (in_array($backend['collectionOf'], $collectionTypes)) {
$collectionTypes[] = $type;
}
}
// TODO Add option for collections to be collection of themselves, only 'folder' does it now...
if (isset(self::$backendTypes[$itemType]) && (!self::getBackend($itemType) instanceof \OCP\Share_Backend_Collection || $itemType != 'folder')) {
2014-02-18 15:37:32 +04:00
unset($collectionTypes[0]);
}
// Return array if collections were found or the item type is a
// collection itself - collections can be inside collections
if (count($collectionTypes) > 0) {
return $collectionTypes;
}
return false;
}
/**
* Get the owners of items shared with a user.
*
* @param string $user The user the items are shared with.
* @param string $type The type of the items shared with the user.
* @param boolean $includeCollections Include collection item types (optional)
* @param boolean $includeOwner include owner in the list of users the item is shared with (optional)
* @return array
*/
public static function getSharedItemsOwners($user, $type, $includeCollections = false, $includeOwner = false) {
// First, we find out if $type is part of a collection (and if that collection is part of
// another one and so on).
$collectionTypes = array();
if (!$includeCollections || !$collectionTypes = self::getCollectionItemTypes($type)) {
$collectionTypes[] = $type;
}
// Of these collection types, along with our original $type, we make a
// list of the ones for which a sharing backend has been registered.
// FIXME: Ideally, we wouldn't need to nest getItemsSharedWith in this loop but just call it
// with its $includeCollections parameter set to true. Unfortunately, this fails currently.
$allMaybeSharedItems = array();
foreach ($collectionTypes as $collectionType) {
if (isset(self::$backends[$collectionType])) {
$allMaybeSharedItems[$collectionType] = self::getItemsSharedWithUser(
$collectionType,
$user,
self::FORMAT_NONE
);
}
}
$owners = array();
if ($includeOwner) {
$owners[] = $user;
}
// We take a look at all shared items of the given $type (or of the collections it is part of)
// and find out their owners. Then, we gather the tags for the original $type from all owners,
// and return them as elements of a list that look like "Tag (owner)".
foreach ($allMaybeSharedItems as $collectionType => $maybeSharedItems) {
foreach ($maybeSharedItems as $sharedItem) {
if (isset($sharedItem['id'])) { //workaround for https://github.com/owncloud/core/issues/2814
$owners[] = $sharedItem['uid_owner'];
}
}
}
return $owners;
}
2014-02-18 15:37:32 +04:00
/**
* Get shared items from the database
* @param string $itemType
* @param string $item Item source or target (optional)
* @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, SHARE_TYPE_LINK, $shareTypeUserAndGroups, or $shareTypeGroupUserUnique
* @param string $shareWith User or group the item is being shared with
* @param string $uidOwner User that is the owner of shared items (optional)
2014-05-01 20:11:30 +04:00
* @param int $format Format to convert items to with formatItems() (optional)
* @param mixed $parameters to pass to formatItems() (optional)
2014-05-06 20:05:06 +04:00
* @param int $limit Number of items to return, -1 to return all matches (optional)
* @param boolean $includeCollections Include collection item types (optional)
* @param boolean $itemShareWithBySource (optional)
* @param boolean $checkExpireDate
2014-03-06 17:00:12 +04:00
* @return array
2014-02-18 15:37:32 +04:00
*
* See public functions getItem(s)... for parameter usage
*
*/
public static function getItems($itemType, $item = null, $shareType = null, $shareWith = null,
$uidOwner = null, $format = self::FORMAT_NONE, $parameters = null, $limit = -1,
$includeCollections = false, $itemShareWithBySource = false, $checkExpireDate = true) {
2014-02-18 15:37:32 +04:00
if (!self::isEnabled()) {
2014-03-06 17:00:12 +04:00
return array();
2014-02-18 15:37:32 +04:00
}
$backend = self::getBackend($itemType);
$collectionTypes = false;
// Get filesystem root to add it to the file target and remove from the
// file source, match file_source with the file cache
if ($itemType == 'file' || $itemType == 'folder') {
if(!is_null($uidOwner)) {
$root = \OC\Files\Filesystem::getRoot();
} else {
$root = '';
}
$where = 'INNER JOIN `*PREFIX*filecache` ON `file_source` = `*PREFIX*filecache`.`fileid` ';
2014-02-18 15:37:32 +04:00
if (!isset($item)) {
$where .= ' AND `file_target` IS NOT NULL ';
2014-02-18 15:37:32 +04:00
}
$where .= 'INNER JOIN `*PREFIX*storages` ON `numeric_id` = `*PREFIX*filecache`.`storage` ';
2014-02-18 15:37:32 +04:00
$fileDependent = true;
$queryArgs = array();
} else {
$fileDependent = false;
$root = '';
$collectionTypes = self::getCollectionItemTypes($itemType);
if ($includeCollections && !isset($item) && $collectionTypes) {
2014-02-18 15:37:32 +04:00
// If includeCollections is true, find collections of this item type, e.g. a music album contains songs
if (!in_array($itemType, $collectionTypes)) {
$itemTypes = array_merge(array($itemType), $collectionTypes);
} else {
$itemTypes = $collectionTypes;
}
$placeholders = join(',', array_fill(0, count($itemTypes), '?'));
$where = ' WHERE `item_type` IN ('.$placeholders.'))';
$queryArgs = $itemTypes;
} else {
$where = ' WHERE `item_type` = ?';
$queryArgs = array($itemType);
}
}
2015-07-03 15:16:29 +03:00
if (\OC::$server->getAppConfig()->getValue('core', 'shareapi_allow_links', 'yes') !== 'yes') {
2014-02-18 15:37:32 +04:00
$where .= ' AND `share_type` != ?';
$queryArgs[] = self::SHARE_TYPE_LINK;
}
if (isset($shareType)) {
// Include all user and group items
if ($shareType == self::$shareTypeUserAndGroups && isset($shareWith)) {
$where .= ' AND ((`share_type` in (?, ?) AND `share_with` = ?) ';
2014-02-18 15:37:32 +04:00
$queryArgs[] = self::SHARE_TYPE_USER;
$queryArgs[] = self::$shareTypeGroupUserUnique;
$queryArgs[] = $shareWith;
$groups = \OC_Group::getUserGroups($shareWith);
if (!empty($groups)) {
$placeholders = join(',', array_fill(0, count($groups), '?'));
$where .= ' OR (`share_type` = ? AND `share_with` IN ('.$placeholders.')) ';
$queryArgs[] = self::SHARE_TYPE_GROUP;
$queryArgs = array_merge($queryArgs, $groups);
}
$where .= ')';
2014-02-18 15:37:32 +04:00
// Don't include own group shares
$where .= ' AND `uid_owner` != ?';
$queryArgs[] = $shareWith;
} else {
$where .= ' AND `share_type` = ?';
$queryArgs[] = $shareType;
if (isset($shareWith)) {
$where .= ' AND `share_with` = ?';
$queryArgs[] = $shareWith;
}
}
}
if (isset($uidOwner)) {
$where .= ' AND `uid_owner` = ?';
$queryArgs[] = $uidOwner;
if (!isset($shareType)) {
// Prevent unique user targets for group shares from being selected
$where .= ' AND `share_type` != ?';
$queryArgs[] = self::$shareTypeGroupUserUnique;
}
2014-03-03 20:24:31 +04:00
if ($fileDependent) {
2014-02-18 15:37:32 +04:00
$column = 'file_source';
} else {
$column = 'item_source';
}
} else {
2014-03-03 20:24:31 +04:00
if ($fileDependent) {
2014-02-18 15:37:32 +04:00
$column = 'file_target';
} else {
$column = 'item_target';
}
}
if (isset($item)) {
$collectionTypes = self::getCollectionItemTypes($itemType);
2014-10-01 17:13:10 +04:00
if ($includeCollections && $collectionTypes && !in_array('folder', $collectionTypes)) {
2014-02-18 15:37:32 +04:00
$where .= ' AND (';
} else {
$where .= ' AND';
}
// If looking for own shared items, check item_source else check item_target
if (isset($uidOwner) || $itemShareWithBySource) {
// If item type is a file, file source needs to be checked in case the item was converted
2014-03-03 20:24:31 +04:00
if ($fileDependent) {
2014-02-18 15:37:32 +04:00
$where .= ' `file_source` = ?';
$column = 'file_source';
} else {
$where .= ' `item_source` = ?';
$column = 'item_source';
}
} else {
2014-03-03 20:24:31 +04:00
if ($fileDependent) {
2014-02-18 15:37:32 +04:00
$where .= ' `file_target` = ?';
$item = \OC\Files\Filesystem::normalizePath($item);
} else {
$where .= ' `item_target` = ?';
}
}
$queryArgs[] = $item;
2014-10-01 17:13:10 +04:00
if ($includeCollections && $collectionTypes && !in_array('folder', $collectionTypes)) {
2014-02-18 15:37:32 +04:00
$placeholders = join(',', array_fill(0, count($collectionTypes), '?'));
$where .= ' OR `item_type` IN ('.$placeholders.'))';
$queryArgs = array_merge($queryArgs, $collectionTypes);
}
}
if ($shareType == self::$shareTypeUserAndGroups && $limit === 1) {
// Make sure the unique user target is returned if it exists,
// unique targets should follow the group share in the database
// If the limit is not 1, the filtering can be done later
$where .= ' ORDER BY `*PREFIX*share`.`id` DESC';
} else {
$where .= ' ORDER BY `*PREFIX*share`.`id` ASC';
}
2014-02-18 15:37:32 +04:00
if ($limit != -1 && !$includeCollections) {
// The limit must be at least 3, because filtering needs to be done
if ($limit < 3) {
$queryLimit = 3;
} else {
$queryLimit = $limit;
}
} else {
$queryLimit = null;
}
2014-03-03 20:06:45 +04:00
$select = self::createSelectStatement($format, $fileDependent, $uidOwner);
2014-02-18 15:37:32 +04:00
$root = strlen($root);
$query = \OC_DB::prepare('SELECT '.$select.' FROM `*PREFIX*share` '.$where, $queryLimit);
$result = $query->execute($queryArgs);
2016-01-07 12:14:05 +03:00
if ($result === false) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share',
\OC_DB::getErrorMessage() . ', select=' . $select . ' where=',
2015-07-03 15:06:40 +03:00
\OCP\Util::ERROR);
2014-02-18 15:37:32 +04:00
}
$items = array();
$targets = array();
$switchedItems = array();
$mounts = array();
while ($row = $result->fetchRow()) {
2014-03-03 20:20:09 +04:00
self::transformDBResults($row);
2014-02-18 15:37:32 +04:00
// Filter out duplicate group shares for users with unique targets
if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
continue;
}
2014-02-18 15:37:32 +04:00
if ($row['share_type'] == self::$shareTypeGroupUserUnique && isset($items[$row['parent']])) {
$row['share_type'] = self::SHARE_TYPE_GROUP;
$row['unique_name'] = true; // remember that we use a unique name for this user
2014-02-18 15:37:32 +04:00
$row['share_with'] = $items[$row['parent']]['share_with'];
// if the group share was unshared from the user we keep the permission, otherwise
// we take the permission from the parent because this is always the up-to-date
// permission for the group share
if ($row['permissions'] > 0) {
$row['permissions'] = $items[$row['parent']]['permissions'];
}
2014-02-18 15:37:32 +04:00
// Remove the parent group share
unset($items[$row['parent']]);
if ($row['permissions'] == 0) {
continue;
}
} else if (!isset($uidOwner)) {
// Check if the same target already exists
if (isset($targets[$row['id']])) {
2014-02-18 15:37:32 +04:00
// Check if the same owner shared with the user twice
// through a group and user share - this is allowed
$id = $targets[$row['id']];
2014-02-18 15:37:32 +04:00
if (isset($items[$id]) && $items[$id]['uid_owner'] == $row['uid_owner']) {
// Switch to group share type to ensure resharing conditions aren't bypassed
if ($items[$id]['share_type'] != self::SHARE_TYPE_GROUP) {
$items[$id]['share_type'] = self::SHARE_TYPE_GROUP;
$items[$id]['share_with'] = $row['share_with'];
}
// Switch ids if sharing permission is granted on only
// one share to ensure correct parent is used if resharing
if (~(int)$items[$id]['permissions'] & \OCP\Constants::PERMISSION_SHARE
&& (int)$row['permissions'] & \OCP\Constants::PERMISSION_SHARE) {
2014-02-18 15:37:32 +04:00
$items[$row['id']] = $items[$id];
$switchedItems[$id] = $row['id'];
unset($items[$id]);
$id = $row['id'];
}
$items[$id]['permissions'] |= (int)$row['permissions'];
2014-02-18 15:37:32 +04:00
}
continue;
} elseif (!empty($row['parent'])) {
$targets[$row['parent']] = $row['id'];
2014-02-18 15:37:32 +04:00
}
}
// Remove root from file source paths if retrieving own shared items
if (isset($uidOwner) && isset($row['path'])) {
if (isset($row['parent'])) {
$query = \OC_DB::prepare('SELECT `file_target` FROM `*PREFIX*share` WHERE `id` = ?');
$parentResult = $query->execute(array($row['parent']));
2016-01-07 12:14:05 +03:00
if ($result === false) {
2015-07-03 15:06:40 +03:00
\OCP\Util::writeLog('OCP\Share', 'Can\'t select parent: ' .
\OC_DB::getErrorMessage() . ', select=' . $select . ' where=' . $where,
2015-07-03 15:06:40 +03:00
\OCP\Util::ERROR);
2014-02-18 15:37:32 +04:00
} else {
$parentRow = $parentResult->fetchRow();
2014-04-08 21:57:07 +04:00
$tmpPath = $parentRow['file_target'];
// find the right position where the row path continues from the target path
$pos = strrpos($row['path'], $parentRow['file_target']);
$subPath = substr($row['path'], $pos);
$splitPath = explode('/', $subPath);
2014-02-18 15:37:32 +04:00
foreach (array_slice($splitPath, 2) as $pathPart) {
$tmpPath = $tmpPath . '/' . $pathPart;
}
$row['path'] = $tmpPath;
2014-02-18 15:37:32 +04:00
}
} else {
if (!isset($mounts[$row['storage']])) {
$mountPoints = \OC\Files\Filesystem::getMountByNumericId($row['storage']);
if (is_array($mountPoints) && !empty($mountPoints)) {
2014-02-18 15:37:32 +04:00
$mounts[$row['storage']] = current($mountPoints);
}
}
2014-10-01 17:13:10 +04:00
if (!empty($mounts[$row['storage']])) {
2014-02-18 15:37:32 +04:00
$path = $mounts[$row['storage']]->getMountPoint().$row['path'];
2014-08-05 22:34:32 +04:00
$relPath = substr($path, $root); // path relative to data/user
$row['path'] = rtrim($relPath, '/');
2014-02-18 15:37:32 +04:00
}
}
}
2014-02-18 15:37:32 +04:00
if($checkExpireDate) {
if (self::expireItem($row)) {
continue;
}
}
// Check if resharing is allowed, if not remove share permission
if (isset($row['permissions']) && (!self::isResharingAllowed() | \OCP\Util::isSharingDisabledForUser())) {
$row['permissions'] &= ~\OCP\Constants::PERMISSION_SHARE;
2014-02-18 15:37:32 +04:00
}
// Add display names to result
$row['share_with_displayname'] = $row['share_with'];
if ( isset($row['share_with']) && $row['share_with'] != '' &&
$row['share_type'] === self::SHARE_TYPE_USER) {
2014-02-18 15:37:32 +04:00
$row['share_with_displayname'] = \OCP\User::getDisplayName($row['share_with']);
} else if(isset($row['share_with']) && $row['share_with'] != '' &&
$row['share_type'] === self::SHARE_TYPE_REMOTE) {
$addressBookEntries = \OC::$server->getContactsManager()->search($row['share_with'], ['CLOUD']);
foreach ($addressBookEntries as $entry) {
foreach ($entry['CLOUD'] as $cloudID) {
if ($cloudID === $row['share_with']) {
$row['share_with_displayname'] = $entry['FN'];
}
}
}
2014-02-18 15:37:32 +04:00
}
if ( isset($row['uid_owner']) && $row['uid_owner'] != '') {
$row['displayname_owner'] = \OCP\User::getDisplayName($row['uid_owner']);
}
if ($row['permissions'] > 0) {
$items[$row['id']] = $row;
}
2014-07-31 13:55:59 +04:00
}
// group items if we are looking for items shared with the current user
2014-07-31 13:55:59 +04:00
if (isset($shareWith) && $shareWith === \OCP\User::getUser()) {
$items = self::groupItems($items, $itemType);
2014-02-18 15:37:32 +04:00
}
2014-07-31 13:55:59 +04:00
2014-02-18 15:37:32 +04:00
if (!empty($items)) {
$collectionItems = array();
foreach ($items as &$row) {
// Return only the item instead of a 2-dimensional array
if ($limit == 1 && $row[$column] == $item && ($row['item_type'] == $itemType || $itemType == 'file')) {
if ($format == self::FORMAT_NONE) {
return $row;
} else {
break;
}
}
// Check if this is a collection of the requested item type
2014-10-01 17:13:10 +04:00
if ($includeCollections && $collectionTypes && $row['item_type'] !== 'folder' && in_array($row['item_type'], $collectionTypes)) {
2014-02-18 15:37:32 +04:00
if (($collectionBackend = self::getBackend($row['item_type']))
&& $collectionBackend instanceof \OCP\Share_Backend_Collection) {
// Collections can be inside collections, check if the item is a collection
if (isset($item) && $row['item_type'] == $itemType && $row[$column] == $item) {
$collectionItems[] = $row;
} else {
$collection = array();
$collection['item_type'] = $row['item_type'];
if ($row['item_type'] == 'file' || $row['item_type'] == 'folder') {
$collection['path'] = basename($row['path']);
}
$row['collection'] = $collection;
// Fetch all of the children sources
$children = $collectionBackend->getChildren($row[$column]);
foreach ($children as $child) {
$childItem = $row;
$childItem['item_type'] = $itemType;
if ($row['item_type'] != 'file' && $row['item_type'] != 'folder') {
$childItem['item_source'] = $child['source'];
$childItem['item_target'] = $child['target'];
}
if ($backend instanceof \OCP\Share_Backend_File_Dependent) {
if ($row['item_type'] == 'file' || $row['item_type'] == 'folder') {
$childItem['file_source'] = $child['source'];
2014-03-06 18:30:01 +04:00
} else { // TODO is this really needed if we already know that we use the file backend?
2014-02-18 15:37:32 +04:00
$meta = \OC\Files\Filesystem::getFileInfo($child['file_path']);
$childItem['file_source'] = $meta['fileid'];
}
$childItem['file_target'] =
\OC\Files\Filesystem::normalizePath($child['file_path']);
}
if (isset($item)) {
if ($childItem[$column] == $item) {
// Return only the item instead of a 2-dimensional array
if ($limit == 1) {
if ($format == self::FORMAT_NONE) {
return $childItem;
} else {
// Unset the items array and break out of both loops
$items = array();
$items[] = $childItem;
break 2;
}
} else {
$collectionItems[] = $childItem;
}
}
} else {
$collectionItems[] = $childItem;
}
}
}
}
// Remove collection item
$toRemove = $row['id'];
if (array_key_exists($toRemove, $switchedItems)) {
$toRemove = $switchedItems[$toRemove];
}
unset($items[$toRemove]);
2014-10-01 17:13:10 +04:00
} elseif ($includeCollections && $collectionTypes && in_array($row['item_type'], $collectionTypes)) {
// FIXME: Thats a dirty hack to improve file sharing performance,
// see github issue #10588 for more details
// Need to find a solution which works for all back-ends
$collectionBackend = self::getBackend($row['item_type']);
$sharedParents = $collectionBackend->getParents($row['item_source']);
foreach ($sharedParents as $parent) {
$collectionItems[] = $parent;
}
2014-02-18 15:37:32 +04:00
}
}
if (!empty($collectionItems)) {
$collectionItems = array_unique($collectionItems, SORT_REGULAR);
2014-02-18 15:37:32 +04:00
$items = array_merge($items, $collectionItems);
}
2014-03-06 17:00:12 +04:00
// filter out invalid items, these can appear when subshare entries exist
// for a group in which the requested user isn't a member any more
$items = array_filter($items, function($item) {
return $item['share_type'] !== self::$shareTypeGroupUserUnique;
});
2014-03-03 20:30:16 +04:00
return self::formatResult($items, $column, $backend, $format, $parameters);
2014-10-01 17:13:10 +04:00
} elseif ($includeCollections && $collectionTypes && in_array('folder', $collectionTypes)) {
// FIXME: Thats a dirty hack to improve file sharing performance,
// see github issue #10588 for more details
// Need to find a solution which works for all back-ends
$collectionItems = array();
$collectionBackend = self::getBackend('folder');
$sharedParents = $collectionBackend->getParents($item, $shareWith, $uidOwner);
2014-10-01 17:13:10 +04:00
foreach ($sharedParents as $parent) {
$collectionItems[] = $parent;
}
if ($limit === 1) {
return reset($collectionItems);
}
return self::formatResult($collectionItems, $column, $backend, $format, $parameters);
2014-02-18 15:37:32 +04:00
}
2014-03-06 17:00:12 +04:00
2014-02-18 15:37:32 +04:00
return array();
}
/**
2014-07-31 13:55:59 +04:00
* group items with link to the same source
*
* @param array $items
* @param string $itemType
* @return array of grouped items
*/
protected static function groupItems($items, $itemType) {
2014-07-31 13:55:59 +04:00
$fileSharing = ($itemType === 'file' || $itemType === 'folder') ? true : false;
$result = array();
foreach ($items as $item) {
$grouped = false;
foreach ($result as $key => $r) {
// for file/folder shares we need to compare file_source, otherwise we compare item_source
// only group shares if they already point to the same target, otherwise the file where shared
// before grouping of shares was added. In this case we don't group them toi avoid confusions
if (( $fileSharing && $item['file_source'] === $r['file_source'] && $item['file_target'] === $r['file_target']) ||
(!$fileSharing && $item['item_source'] === $r['item_source'] && $item['item_target'] === $r['item_target'])) {
2014-07-31 13:55:59 +04:00
// add the first item to the list of grouped shares
if (!isset($result[$key]['grouped'])) {
$result[$key]['grouped'][] = $result[$key];
}
$result[$key]['permissions'] = (int) $item['permissions'] | (int) $r['permissions'];
$result[$key]['grouped'][] = $item;
$grouped = true;
break;
}
}
if (!$grouped) {
$result[] = $item;
}
}
return $result;
}
/**
2014-02-18 15:37:32 +04:00
* Put shared item into the database
* @param string $itemType Item type
* @param string $itemSource Item source
* @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
* @param string $shareWith User or group the item is being shared with
* @param string $uidOwner User that is the owner of shared item
* @param int $permissions CRUDS permissions
* @param boolean|array $parentFolder Parent folder target (optional)
* @param string $token (optional)
* @param string $itemSourceName name of the source item (optional)
* @param \DateTime $expirationDate (optional)
2014-05-13 14:27:35 +04:00
* @throws \Exception
* @return mixed id of the new share or false
2014-02-18 15:37:32 +04:00
*/
private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
$permissions, $parentFolder = null, $token = null, $itemSourceName = null, \DateTime $expirationDate = null) {
2014-07-31 13:55:59 +04:00
$queriesToExecute = array();
$suggestedItemTarget = null;
2015-10-05 13:03:36 +03:00
$groupFileTarget = $fileTarget = $suggestedFileTarget = $filePath = '';
$groupItemTarget = $itemTarget = $fileSource = $parent = 0;
2014-07-31 13:55:59 +04:00
$result = self::checkReshare($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $permissions, $itemSourceName, $expirationDate);
if(!empty($result)) {
$parent = $result['parent'];
$itemSource = $result['itemSource'];
$fileSource = $result['fileSource'];
$suggestedItemTarget = $result['suggestedItemTarget'];
$suggestedFileTarget = $result['suggestedFileTarget'];
$filePath = $result['filePath'];
2014-02-18 15:37:32 +04:00
}
2014-07-31 13:55:59 +04:00
$isGroupShare = false;
2014-02-18 15:37:32 +04:00
if ($shareType == self::SHARE_TYPE_GROUP) {
2014-07-31 13:55:59 +04:00
$isGroupShare = true;
if (isset($shareWith['users'])) {
$users = $shareWith['users'];
} else {
$users = \OC_Group::usersInGroup($shareWith['group']);
}
2014-07-31 13:55:59 +04:00
// remove current user from list
if (in_array(\OCP\User::getUser(), $users)) {
unset($users[array_search(\OCP\User::getUser(), $users)]);
2014-02-18 15:37:32 +04:00
}
$groupItemTarget = Helper::generateTarget($itemType, $itemSource,
$shareType, $shareWith['group'], $uidOwner, $suggestedItemTarget);
$groupFileTarget = Helper::generateTarget($itemType, $itemSource,
$shareType, $shareWith['group'], $uidOwner, $filePath);
2014-02-18 15:37:32 +04:00
2014-07-31 13:55:59 +04:00
// add group share to table and remember the id as parent
$queriesToExecute['groupShare'] = array(
'itemType' => $itemType,
'itemSource' => $itemSource,
'itemTarget' => $groupItemTarget,
'shareType' => $shareType,
'shareWith' => $shareWith['group'],
'uidOwner' => $uidOwner,
'permissions' => $permissions,
'shareTime' => time(),
'fileSource' => $fileSource,
'fileTarget' => $groupFileTarget,
'token' => $token,
'parent' => $parent,
'expiration' => $expirationDate,
);
2014-07-31 13:55:59 +04:00
} else {
$users = array($shareWith);
$itemTarget = Helper::generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
$suggestedItemTarget);
2014-07-31 13:55:59 +04:00
}
$run = true;
$error = '';
$preHookData = array(
'itemType' => $itemType,
'itemSource' => $itemSource,
'shareType' => $shareType,
'uidOwner' => $uidOwner,
'permissions' => $permissions,
'fileSource' => $fileSource,
'expiration' => $expirationDate,
'token' => $token,
'run' => &$run,
'error' => &$error
);
$preHookData['itemTarget'] = ($isGroupShare) ? $groupItemTarget : $itemTarget;
$preHookData['shareWith'] = ($isGroupShare) ? $shareWith['group'] : $shareWith;
\OC_Hook::emit('OCP\Share', 'pre_shared', $preHookData);
if ($run === false) {
throw new \Exception($error);
}
foreach ($users as $user) {
$sourceId = ($itemType === 'file' || $itemType === 'folder') ? $fileSource : $itemSource;
$sourceExists = self::getItemSharedWithBySource($itemType, $sourceId, self::FORMAT_NONE, null, true, $user);
2014-07-31 13:55:59 +04:00
$userShareType = ($isGroupShare) ? self::$shareTypeGroupUserUnique : $shareType;
2014-07-31 13:55:59 +04:00
if ($sourceExists && $sourceExists['item_source'] === $itemSource) {
2014-07-31 13:55:59 +04:00
$fileTarget = $sourceExists['file_target'];
$itemTarget = $sourceExists['item_target'];
// for group shares we don't need a additional entry if the target is the same
if($isGroupShare && $groupItemTarget === $itemTarget) {
continue;
}
2014-07-31 13:55:59 +04:00
} elseif(!$sourceExists && !$isGroupShare) {
$itemTarget = Helper::generateTarget($itemType, $itemSource, $userShareType, $user,
2014-02-18 15:37:32 +04:00
$uidOwner, $suggestedItemTarget, $parent);
if (isset($fileSource)) {
if ($parentFolder) {
if ($parentFolder === true) {
$fileTarget = Helper::generateTarget('file', $filePath, $userShareType, $user,
2014-02-18 15:37:32 +04:00
$uidOwner, $suggestedFileTarget, $parent);
if ($fileTarget != $groupFileTarget) {
2014-07-31 13:55:59 +04:00
$parentFolders[$user]['folder'] = $fileTarget;
2014-02-18 15:37:32 +04:00
}
2014-07-31 13:55:59 +04:00
} else if (isset($parentFolder[$user])) {
$fileTarget = $parentFolder[$user]['folder'].$itemSource;
$parent = $parentFolder[$user]['id'];
2014-02-18 15:37:32 +04:00
}
} else {
$fileTarget = Helper::generateTarget('file', $filePath, $userShareType,
2014-07-31 13:55:59 +04:00
$user, $uidOwner, $suggestedFileTarget, $parent);
2014-02-18 15:37:32 +04:00
}
} else {
$fileTarget = null;
}
2014-07-31 13:55:59 +04:00
} else {
// group share which doesn't exists until now, check if we need a unique target for this user
$itemTarget = Helper::generateTarget($itemType, $itemSource, self::SHARE_TYPE_USER, $user,
$uidOwner, $suggestedItemTarget, $parent);
// do we also need a file target
if (isset($fileSource)) {
$fileTarget = Helper::generateTarget('file', $filePath, self::SHARE_TYPE_USER, $user,
$uidOwner, $suggestedFileTarget, $parent);
} else {
$fileTarget = null;
}
if (($itemTarget === $groupItemTarget) &&
(!isset($fileSource) || $fileTarget === $groupFileTarget)) {
continue;
}
2014-07-31 13:55:59 +04:00
}
$queriesToExecute[] = array(
'itemType' => $itemType,
'itemSource' => $itemSource,
'itemTarget' => $itemTarget,
'shareType' => $userShareType,
'shareWith' => $user,
'uidOwner' => $uidOwner,
'permissions' => $permissions,
'shareTime' => time(),
'fileSource' => $fileSource,
'fileTarget' => $fileTarget,
'token' => $token,
'parent' => $parent,
'expiration' => $expirationDate,
);
2014-07-31 13:55:59 +04:00
}
$id = false;
2014-07-31 13:55:59 +04:00
if ($isGroupShare) {
$id = self::insertShare($queriesToExecute['groupShare']);
2014-04-09 19:51:54 +04:00
// Save this id, any extra rows for this group share will need to reference it
2016-01-07 12:22:30 +03:00
$parent = \OC::$server->getDatabaseConnection()->lastInsertId('*PREFIX*share');
2014-04-09 19:51:54 +04:00
unset($queriesToExecute['groupShare']);
2014-07-31 13:55:59 +04:00
}
2014-07-31 13:55:59 +04:00
foreach ($queriesToExecute as $shareQuery) {
$shareQuery['parent'] = $parent;
$id = self::insertShare($shareQuery);
2014-07-31 13:55:59 +04:00
}
2014-04-09 19:51:54 +04:00
2014-07-31 13:55:59 +04:00
$postHookData = array(
'itemType' => $itemType,
'itemSource' => $itemSource,
'parent' => $parent,
'shareType' => $shareType,
'uidOwner' => $uidOwner,
'permissions' => $permissions,
'fileSource' => $fileSource,
'id' => $parent,
'token' => $token,
'expirationDate' => $expirationDate,
);
$postHookData['shareWith'] = ($isGroupShare) ? $shareWith['group'] : $shareWith;
$postHookData['itemTarget'] = ($isGroupShare) ? $groupItemTarget : $itemTarget;
$postHookData['fileTarget'] = ($isGroupShare) ? $groupFileTarget : $fileTarget;
\OC_Hook::emit('OCP\Share', 'post_shared', $postHookData);
return $id ? $id : false;
2014-07-31 13:55:59 +04:00
}
private static function checkReshare($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $permissions, $itemSourceName, $expirationDate) {
$backend = self::getBackend($itemType);
$l = \OC::$server->getL10N('lib');
$result = array();
2014-10-01 17:13:10 +04:00
$column = ($itemType === 'file' || $itemType === 'folder') ? 'file_source' : 'item_source';
2014-07-31 13:55:59 +04:00
$checkReshare = self::getItemSharedWithBySource($itemType, $itemSource, self::FORMAT_NONE, null, true);
if ($checkReshare) {
// Check if attempting to share back to owner
if ($checkReshare['uid_owner'] == $shareWith && $shareType == self::SHARE_TYPE_USER) {
$message = 'Sharing %s failed, because the user %s is the original sharer';
2015-10-16 11:00:33 +03:00
$message_t = $l->t('Sharing failed, because the user %s is the original sharer', [$shareWith]);
2014-07-31 13:55:59 +04:00
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OCP\Util::DEBUG);
2014-07-31 13:55:59 +04:00
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
}
}
2014-02-18 15:37:32 +04:00
if ($checkReshare && $checkReshare['uid_owner'] !== \OC_User::getUser()) {
2014-07-31 13:55:59 +04:00
// Check if share permissions is granted
if (self::isResharingAllowed() && (int)$checkReshare['permissions'] & \OCP\Constants::PERMISSION_SHARE) {
2014-07-31 13:55:59 +04:00
if (~(int)$checkReshare['permissions'] & $permissions) {
$message = 'Sharing %s failed, because the permissions exceed permissions granted to %s';
$message_t = $l->t('Sharing %s failed, because the permissions exceed permissions granted to %s', array($itemSourceName, $uidOwner));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName, $uidOwner), \OCP\Util::DEBUG);
2014-07-31 13:55:59 +04:00
throw new \Exception($message_t);
2014-02-18 15:37:32 +04:00
} else {
2014-07-31 13:55:59 +04:00
// TODO Don't check if inside folder
$result['parent'] = $checkReshare['id'];
$result['expirationDate'] = $expirationDate;
// $checkReshare['expiration'] could be null and then is always less than any value
if(isset($checkReshare['expiration']) && $checkReshare['expiration'] < $expirationDate) {
$result['expirationDate'] = $checkReshare['expiration'];
}
2014-10-01 17:13:10 +04:00
// only suggest the same name as new target if it is a reshare of the
// same file/folder and not the reshare of a child
if ($checkReshare[$column] === $itemSource) {
$result['filePath'] = $checkReshare['file_target'];
$result['itemSource'] = $checkReshare['item_source'];
$result['fileSource'] = $checkReshare['file_source'];
$result['suggestedItemTarget'] = $checkReshare['item_target'];
$result['suggestedFileTarget'] = $checkReshare['file_target'];
} else {
$result['filePath'] = ($backend instanceof \OCP\Share_Backend_File_Dependent) ? $backend->getFilePath($itemSource, $uidOwner) : null;
$result['suggestedItemTarget'] = null;
$result['suggestedFileTarget'] = null;
$result['itemSource'] = $itemSource;
$result['fileSource'] = ($backend instanceof \OCP\Share_Backend_File_Dependent) ? $itemSource : null;
}
2014-02-18 15:37:32 +04:00
}
} else {
2014-07-31 13:55:59 +04:00
$message = 'Sharing %s failed, because resharing is not allowed';
$message_t = $l->t('Sharing %s failed, because resharing is not allowed', array($itemSourceName));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSourceName), \OCP\Util::DEBUG);
2014-07-31 13:55:59 +04:00
throw new \Exception($message_t);
}
} else {
$result['parent'] = null;
$result['suggestedItemTarget'] = null;
$result['suggestedFileTarget'] = null;
$result['itemSource'] = $itemSource;
$result['expirationDate'] = $expirationDate;
if (!$backend->isValidSource($itemSource, $uidOwner)) {
$message = 'Sharing %s failed, because the sharing backend for '
.'%s could not find its source';
$message_t = $l->t('Sharing %s failed, because the sharing backend for %s could not find its source', array($itemSource, $itemType));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSource, $itemType), \OCP\Util::DEBUG);
2014-07-31 13:55:59 +04:00
throw new \Exception($message_t);
}
if ($backend instanceof \OCP\Share_Backend_File_Dependent) {
$result['filePath'] = $backend->getFilePath($itemSource, $uidOwner);
if ($itemType == 'file' || $itemType == 'folder') {
$result['fileSource'] = $itemSource;
} else {
$meta = \OC\Files\Filesystem::getFileInfo($result['filePath']);
$result['fileSource'] = $meta['fileid'];
}
if ($result['fileSource'] == -1) {
$message = 'Sharing %s failed, because the file could not be found in the file cache';
$message_t = $l->t('Sharing %s failed, because the file could not be found in the file cache', array($itemSource));
\OCP\Util::writeLog('OCP\Share', sprintf($message, $itemSource), \OCP\Util::DEBUG);
2014-07-31 13:55:59 +04:00
throw new \Exception($message_t);
}
} else {
$result['filePath'] = null;
$result['fileSource'] = null;
2014-02-18 15:37:32 +04:00
}
}
2014-07-31 13:55:59 +04:00
return $result;
2014-02-18 15:37:32 +04:00
}
/**
*
* @param array $shareData
* @return mixed false in case of a failure or the id of the new share
*/
private static function insertShare(array $shareData) {
$query = \OC_DB::prepare('INSERT INTO `*PREFIX*share` ('
.' `item_type`, `item_source`, `item_target`, `share_type`,'
.' `share_with`, `uid_owner`, `permissions`, `stime`, `file_source`,'
.' `file_target`, `token`, `parent`, `expiration`) VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?)');
$query->bindValue(1, $shareData['itemType']);
$query->bindValue(2, $shareData['itemSource']);
$query->bindValue(3, $shareData['itemTarget']);
$query->bindValue(4, $shareData['shareType']);
$query->bindValue(5, $shareData['shareWith']);
$query->bindValue(6, $shareData['uidOwner']);
$query->bindValue(7, $shareData['permissions']);
$query->bindValue(8, $shareData['shareTime']);
$query->bindValue(9, $shareData['fileSource']);
$query->bindValue(10, $shareData['fileTarget']);
$query->bindValue(11, $shareData['token']);
$query->bindValue(12, $shareData['parent']);
$query->bindValue(13, $shareData['expiration'], 'datetime');
$result = $query->execute();
$id = false;
if ($result) {
$id = \OC::$server->getDatabaseConnection()->lastInsertId('*PREFIX*share');
}
return $id;
}
2014-02-18 15:37:32 +04:00
/**
* Delete all shares with type SHARE_TYPE_LINK
*/
public static function removeAllLinkShares() {
// Delete any link shares
$query = \OC_DB::prepare('SELECT `id` FROM `*PREFIX*share` WHERE `share_type` = ?');
$result = $query->execute(array(self::SHARE_TYPE_LINK));
while ($item = $result->fetchRow()) {
Helper::delete($item['id']);
2014-02-18 15:37:32 +04:00
}
}
/**
* In case a password protected link is not yet authenticated this function will return false
*
* @param array $linkItem
* @return boolean
2014-02-18 15:37:32 +04:00
*/
public static function checkPasswordProtectedShare(array $linkItem) {
if (!isset($linkItem['share_with'])) {
return true;
}
if (!isset($linkItem['share_type'])) {
return true;
}
if (!isset($linkItem['id'])) {
return true;
}
if ($linkItem['share_type'] != \OCP\Share::SHARE_TYPE_LINK) {
return true;
}
if ( \OC::$server->getSession()->exists('public_link_authenticated')
&& \OC::$server->getSession()->get('public_link_authenticated') === $linkItem['id'] ) {
2014-02-18 15:37:32 +04:00
return true;
}
return false;
}
2014-03-03 20:06:45 +04:00
/**
* construct select statement
2014-03-03 20:06:45 +04:00
* @param int $format
* @param boolean $fileDependent ist it a file/folder share or a generla share
2014-03-03 20:06:45 +04:00
* @param string $uidOwner
* @return string select statement
*/
private static function createSelectStatement($format, $fileDependent, $uidOwner = null) {
$select = '*';
if ($format == self::FORMAT_STATUSES) {
if ($fileDependent) {
$select = '`*PREFIX*share`.`id`, `*PREFIX*share`.`parent`, `share_type`, `path`, `storage`, '
. '`share_with`, `uid_owner` , `file_source`, `stime`, `*PREFIX*share`.`permissions`, '
. '`*PREFIX*storages`.`id` AS `storage_id`, `*PREFIX*filecache`.`parent` as `file_parent`';
2014-03-03 20:06:45 +04:00
} else {
$select = '`id`, `parent`, `share_type`, `share_with`, `uid_owner`, `item_source`, `stime`, `*PREFIX*share`.`permissions`';
2014-03-03 20:06:45 +04:00
}
} else {
if (isset($uidOwner)) {
if ($fileDependent) {
$select = '`*PREFIX*share`.`id`, `item_type`, `item_source`, `*PREFIX*share`.`parent`,'
. ' `share_type`, `share_with`, `file_source`, `file_target`, `path`, `*PREFIX*share`.`permissions`, `stime`,'
. ' `expiration`, `token`, `storage`, `mail_send`, `uid_owner`, '
. '`*PREFIX*storages`.`id` AS `storage_id`, `*PREFIX*filecache`.`parent` as `file_parent`';
2014-03-03 20:06:45 +04:00
} else {
$select = '`id`, `item_type`, `item_source`, `parent`, `share_type`, `share_with`, `*PREFIX*share`.`permissions`,'
. ' `stime`, `file_source`, `expiration`, `token`, `mail_send`, `uid_owner`';
2014-03-03 20:06:45 +04:00
}
} else {
if ($fileDependent) {
if ($format == \OC_Share_Backend_File::FORMAT_GET_FOLDER_CONTENTS || $format == \OC_Share_Backend_File::FORMAT_FILE_APP_ROOT) {
$select = '`*PREFIX*share`.`id`, `item_type`, `item_source`, `*PREFIX*share`.`parent`, `uid_owner`, '
. '`share_type`, `share_with`, `file_source`, `path`, `file_target`, `stime`, '
. '`*PREFIX*share`.`permissions`, `expiration`, `storage`, `*PREFIX*filecache`.`parent` as `file_parent`, '
. '`name`, `mtime`, `mimetype`, `mimepart`, `size`, `encrypted`, `etag`, `mail_send`';
2014-03-03 20:06:45 +04:00
} else {
$select = '`*PREFIX*share`.`id`, `item_type`, `item_source`, `item_target`,'
. '`*PREFIX*share`.`parent`, `share_type`, `share_with`, `uid_owner`,'
. '`file_source`, `path`, `file_target`, `*PREFIX*share`.`permissions`,'
. '`stime`, `expiration`, `token`, `storage`, `mail_send`,'
. '`*PREFIX*storages`.`id` AS `storage_id`, `*PREFIX*filecache`.`parent` as `file_parent`';
2014-03-03 20:06:45 +04:00
}
}
}
}
return $select;
}
2014-03-03 20:20:09 +04:00
/**
* transform db results
2014-03-03 20:20:09 +04:00
* @param array $row result
*/
private static function transformDBResults(&$row) {
if (isset($row['id'])) {
$row['id'] = (int) $row['id'];
}
if (isset($row['share_type'])) {
$row['share_type'] = (int) $row['share_type'];
}
if (isset($row['parent'])) {
$row['parent'] = (int) $row['parent'];
}
if (isset($row['file_parent'])) {
$row['file_parent'] = (int) $row['file_parent'];
}
if (isset($row['file_source'])) {
$row['file_source'] = (int) $row['file_source'];
}
if (isset($row['permissions'])) {
$row['permissions'] = (int) $row['permissions'];
}
if (isset($row['storage'])) {
$row['storage'] = (int) $row['storage'];
}
if (isset($row['stime'])) {
$row['stime'] = (int) $row['stime'];
}
if (isset($row['expiration']) && $row['share_type'] !== self::SHARE_TYPE_LINK) {
// discard expiration date for non-link shares, which might have been
// set by ancient bugs
$row['expiration'] = null;
}
2014-03-03 20:20:09 +04:00
}
2014-03-03 20:30:16 +04:00
/**
* format result
2014-03-03 20:30:16 +04:00
* @param array $items result
* @param string $column is it a file share or a general share ('file_target' or 'item_target')
* @param \OCP\Share_Backend $backend sharing backend
2014-03-03 20:30:16 +04:00
* @param int $format
* @param array $parameters additional format parameters
* @return array format result
2014-03-03 20:30:16 +04:00
*/
private static function formatResult($items, $column, $backend, $format = self::FORMAT_NONE , $parameters = null) {
if ($format === self::FORMAT_NONE) {
return $items;
} else if ($format === self::FORMAT_STATUSES) {
$statuses = array();
foreach ($items as $item) {
if ($item['share_type'] === self::SHARE_TYPE_LINK) {
$statuses[$item[$column]]['link'] = true;
} else if (!isset($statuses[$item[$column]])) {
$statuses[$item[$column]]['link'] = false;
}
if (!empty($item['file_target'])) {
2014-03-03 20:30:16 +04:00
$statuses[$item[$column]]['path'] = $item['path'];
}
}
return $statuses;
} else {
return $backend->formatItems($items, $format, $parameters);
}
}
2014-06-04 13:07:31 +04:00
/**
* remove protocol from URL
*
* @param string $url
* @return string
*/
public static function removeProtocolFromUrl($url) {
if (strpos($url, 'https://') === 0) {
return substr($url, strlen('https://'));
} else if (strpos($url, 'http://') === 0) {
return substr($url, strlen('http://'));
}
return $url;
}
/**
* try http post first with https and then with http as a fallback
*
* @param string $url
* @param array $fields post parameters
* @return array
*/
private static function tryHttpPost($url, $fields) {
$protocol = 'https://';
$result = [
'success' => false,
'result' => '',
];
$try = 0;
while ($result['success'] === false && $try < 2) {
$result = \OC::$server->getHTTPHelper()->post($protocol . $url, $fields);
$try++;
$protocol = 'http://';
}
return $result;
}
/**
* send server-to-server share to remote server
*
* @param string $token
* @param string $shareWith
* @param string $name
* @param int $remote_id
* @param string $owner
* @return bool
*/
private static function sendRemoteShare($token, $shareWith, $name, $remote_id, $owner) {
list($user, $remote) = Helper::splitUserRemote($shareWith);
if ($user && $remote) {
$url = $remote . self::BASE_PATH_TO_SHARE_API . '?format=' . self::RESPONSE_FORMAT;
$local = \OC::$server->getURLGenerator()->getAbsoluteURL('/');
$fields = array(
'shareWith' => $user,
'token' => $token,
'name' => $name,
'remoteId' => $remote_id,
'owner' => $owner,
'remote' => $local,
);
$url = self::removeProtocolFromUrl($url);
$result = self::tryHttpPost($url, $fields);
$status = json_decode($result['result'], true);
if ($result['success'] && $status['ocs']['meta']['statuscode'] === 100) {
\OC_Hook::emit('OCP\Share', 'federated_share_added', ['server' => $remote]);
return true;
}
}
return false;
}
/**
* send server-to-server unshare to remote server
*
* @param string $remote url
* @param int $id share id
* @param string $token
* @return bool
*/
private static function sendRemoteUnshare($remote, $id, $token) {
$url = rtrim($remote, '/') . self::BASE_PATH_TO_SHARE_API . '/' . $id . '/unshare?format=' . self::RESPONSE_FORMAT;
$fields = array('token' => $token, 'format' => 'json');
$url = self::removeProtocolFromUrl($url);
$result = self::tryHttpPost($url, $fields);
$status = json_decode($result['result'], true);
return ($result['success'] && $status['ocs']['meta']['statuscode'] === 100);
}
2014-06-04 13:07:31 +04:00
/**
* check if user can only share with group members
* @return bool
*/
public static function shareWithGroupMembersOnly() {
2015-07-03 15:16:29 +03:00
$value = \OC::$server->getAppConfig()->getValue('core', 'shareapi_only_share_with_group_members', 'no');
2014-06-04 13:07:31 +04:00
return ($value === 'yes') ? true : false;
}
/**
* @return bool
*/
2014-06-03 17:15:04 +04:00
public static function isDefaultExpireDateEnabled() {
$defaultExpireDateEnabled = \OCP\Config::getAppValue('core', 'shareapi_default_expire_date', 'no');
return ($defaultExpireDateEnabled === "yes") ? true : false;
}
/**
* @return bool
*/
2014-06-03 17:15:04 +04:00
public static function enforceDefaultExpireDate() {
$enforceDefaultExpireDate = \OCP\Config::getAppValue('core', 'shareapi_enforce_expire_date', 'no');
return ($enforceDefaultExpireDate === "yes") ? true : false;
}
/**
* @return int
*/
2014-06-03 17:15:04 +04:00
public static function getExpireInterval() {
return (int)\OCP\Config::getAppValue('core', 'shareapi_expire_after_n_days', '7');
}
/**
* Checks whether the given path is reachable for the given owner
*
* @param string $path path relative to files
* @param string $ownerStorageId storage id of the owner
*
* @return boolean true if file is reachable, false otherwise
*/
private static function isFileReachable($path, $ownerStorageId) {
// if outside the home storage, file is always considered reachable
if (!(substr($ownerStorageId, 0, 6) === 'home::' ||
substr($ownerStorageId, 0, 13) === 'object::user:'
)) {
return true;
}
// if inside the home storage, the file has to be under "/files/"
$path = ltrim($path, '/');
if (substr($path, 0, 6) === 'files/') {
return true;
}
return false;
}
/**
* @param IConfig $config
* @return bool
*/
public static function enforcePassword(IConfig $config) {
$enforcePassword = $config->getAppValue('core', 'shareapi_enforce_links_password', 'no');
return ($enforcePassword === "yes") ? true : false;
}
/**
* Get all share entries, including non-unique group items
*
* @param string $owner
* @return array
*/
public static function getAllSharesForOwner($owner) {
$query = 'SELECT * FROM `*PREFIX*share` WHERE `uid_owner` = ?';
$result = \OC::$server->getDatabaseConnection()->executeQuery($query, [$owner]);
return $result->fetchAll();
}
/**
* Get all share entries, including non-unique group items for a file
*
* @param int $id
* @return array
*/
public static function getAllSharesForFileId($id) {
$query = 'SELECT * FROM `*PREFIX*share` WHERE `file_source` = ?';
$result = \OC::$server->getDatabaseConnection()->executeQuery($query, [$id]);
return $result->fetchAll();
}
/**
* @param string $password
* @throws \Exception
*/
private static function verifyPassword($password) {
$accepted = true;
$message = '';
\OCP\Util::emitHook('\OC\Share', 'verifyPassword', [
'password' => $password,
'accepted' => &$accepted,
'message' => &$message
]);
if (!$accepted) {
throw new \Exception($message);
}
}
2014-02-18 15:37:32 +04:00
}