1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563 |
- <?php
- /**
- * @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 Lukas Reschke <lukas@owncloud.com>
- * @author Michael Kuhn <suraia@ikkoku.de>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <icewind@owncloud.com>
- * @author Robin McCorkell <rmccorkell@karoshi.org.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @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>
- *
- * @copyright Copyright (c) 2015, ownCloud, Inc.
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- namespace OC\Share;
- use OCP\IUserSession;
- use OC\DB\Connection;
- use OCP\IConfig;
- /**
- * 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 {
- /** 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
- */
- 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', 'share');
- \OC_Util::addStyle('core', 'share');
- }
- return true;
- }
- \OC_Log::write('OCP\Share',
- 'Sharing backend '.$class.' not registered, '.self::$backendTypes[$itemType]['class']
- .' is already registered for '.$itemType,
- \OC_Log::WARN);
- }
- return false;
- }
- /**
- * Check if the Share API is enabled
- * @return boolean true if enabled or false
- *
- * The Share API is enabled by default if not configured
- */
- public static function isEnabled() {
- if (\OC_Appconfig::getValue('core', 'shareapi_enabled', 'yes') == 'yes') {
- 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
- * @return array
- * @note $path needs to be relative to user data dir, e.g. 'file.txt'
- * not '/admin/data/file.txt'
- */
- public static function getUsersSharingFile($path, $ownerUser, $includeOwner = false, $returnUserPaths = false) {
- $shares = $sharePaths = $fileTargets = array();
- $publicShare = false;
- $remoteShare = false;
- $source = -1;
- $cache = false;
- $view = new \OC\Files\View('/' . $ownerUser . '/files');
- if ($view->file_exists($path)) {
- $meta = $view->getFileInfo($path);
- $path = substr($meta->getPath(), strlen('/' . $ownerUser . '/files'));
- } 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
- $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));
- if (\OCP\DB::isError($result)) {
- \OCP\Util::writeLog('OCP\Share', \OC_DB::getErrorMessage(), \OC_Log::ERROR);
- } else {
- while ($row = $result->fetchRow()) {
- $shares[] = $row['share_with'];
- if ($returnUserPaths) {
- $fileTargets[(int) $row['file_source']][$row['share_with']] = $row;
- }
- }
- }
- // We also need to take group shares into account
- $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_GROUP));
- if (\OCP\DB::isError($result)) {
- \OCP\Util::writeLog('OCP\Share', \OC_DB::getErrorMessage(), \OC_Log::ERROR);
- } else {
- while ($row = $result->fetchRow()) {
- $usersInGroup = \OC_Group::usersInGroup($row['share_with']);
- $shares = array_merge($shares, $usersInGroup);
- if ($returnUserPaths) {
- foreach ($usersInGroup as $user) {
- $fileTargets[(int) $row['file_source']][$user] = $row;
- }
- }
- }
- }
- //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
- );
- $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);
- } 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;
- }
- }
- }
- // let's get the parent for the next round
- $meta = $cache->get((int)$source);
- if($meta !== false) {
- $source = (int)$meta['parent'];
- } else {
- $source = -1;
- }
- }
- // Include owner in list of users, if requested
- if ($includeOwner) {
- $shares[] = $ownerUser;
- if ($returnUserPaths) {
- $sharePaths[$ownerUser] = $path;
- }
- }
- if ($returnUserPaths) {
- $fileTargetIDs = array_keys($fileTargets);
- $fileTargetIDs = array_unique($fileTargetIDs);
- if (!empty($fileTargetIDs)) {
- $query = \OC_DB::prepare(
- 'SELECT `fileid`, `path`
- FROM `*PREFIX*filecache`
- WHERE `fileid` IN (' . implode(',', $fileTargetIDs) . ')'
- );
- $result = $query->execute();
- if (\OCP\DB::isError($result)) {
- \OCP\Util::writeLog('OCP\Share', \OC_DB::getErrorMessage(), \OC_Log::ERROR);
- } else {
- while ($row = $result->fetchRow()) {
- foreach ($fileTargets[$row['fileid']] as $uid => $shareData) {
- $sharedPath = $shareData['file_target'];
- $sharedPath .= substr($path, strlen($row['path']) -5);
- $sharePaths[$uid] = $sharedPath;
- }
- }
- }
- }
- return $sharePaths;
- }
- return array('users' => array_unique($shares), 'public' => $publicShare, 'remote' => $remoteShare);
- }
- /**
- * 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
- */
- public static function getItemsSharedWith($itemType, $format = self::FORMAT_NONE,
- $parameters = null, $limit = -1, $includeCollections = false) {
- 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)
- * @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);
- }
- /**
- * 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
- */
- public static function getItemSharedWith($itemType, $itemTarget, $format = self::FORMAT_NONE,
- $parameters = null, $includeCollections = false) {
- 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
- * @return array Return list of items with file_target, permissions and expiration
- */
- public static function getItemSharedWithUser($itemType, $itemSource, $user, $owner = null, $shareType = null) {
- $shares = array();
- $fileDependent = false;
- $where = 'WHERE';
- $fileDependentWhere = '';
- if ($itemType === 'file' || $itemType === 'folder') {
- $fileDependent = true;
- $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` ';
- } else {
- $column = 'item_source';
- }
- $select = self::createSelectStatement(self::FORMAT_NONE, $fileDependent);
- $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);
- $result = \OC_DB::executeAudited($query, $arguments);
- while ($row = $result->fetchRow()) {
- if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
- continue;
- }
- $shares[] = $row;
- }
- //if didn't found a result than let's look for a group share.
- if(empty($shares) && $user !== null) {
- $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;
- }
- // TODO: inject connection, hopefully one day in the future when this
- // class isn't static anymore...
- $conn = \OC_DB::getConnection();
- $result = $conn->executeQuery(
- 'SELECT ' . $select . ' FROM `*PREFIX*share` ' . $where,
- $arguments,
- $types
- );
- while ($row = $result->fetch()) {
- $shares[] = $row;
- }
- }
- }
- 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
- * @param string $shareWith (optional) define against which user should be checked, default: current user
- * @return array
- */
- public static function getItemSharedWithBySource($itemType, $itemSource, $format = self::FORMAT_NONE,
- $parameters = null, $includeCollections = false, $shareWith = null) {
- $shareWith = ($shareWith === null) ? \OC_User::getUser() : $shareWith;
- return self::getItems($itemType, $itemSource, self::$shareTypeUserAndGroups, $shareWith, null, $format,
- $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
- * @return array
- */
- 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
- * @return array|boolean false will be returned in case the token is unknown or unauthorized
- */
- public static function getShareByToken($token, $checkPasswordProtection = true) {
- $query = \OC_DB::prepare('SELECT * FROM `*PREFIX*share` WHERE `token` = ?', 1);
- $result = $query->execute(array($token));
- if (\OC_DB::isError($result)) {
- \OC_Log::write('OCP\Share', \OC_DB::getErrorMessage() . ', token=' . $token, \OC_Log::ERROR);
- }
- $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
- */
- 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
- */
- public static function getItemsShared($itemType, $format = self::FORMAT_NONE, $parameters = null,
- $limit = -1, $includeCollections = false) {
- 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
- */
- public static function getItemShared($itemType, $itemSource, $format = self::FORMAT_NONE,
- $parameters = null, $includeCollections = false) {
- 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
- */
- 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
- * @return boolean|string Returns true on success or false on failure, Returns token on success for links
- * @throws \Exception
- */
- public static function shareItem($itemType, $itemSource, $shareType, $shareWith, $permissions, $itemSourceName = null, \DateTime $expirationDate = 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName, $shareType), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- $uidOwner = \OC_User::getUser();
- $shareWithinGroupOnly = self::shareWithGroupMembersOnly();
- if (is_null($itemSourceName)) {
- $itemSourceName = $itemSource;
- }
- // check if file can be shared
- if ($itemType === 'file' or $itemType === 'folder') {
- $path = \OC\Files\Filesystem::getPath($itemSource);
- // 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- // verify that the user has share permission
- if (!\OC\Files\Filesystem::isSharable($path)) {
- $message = 'You are not allowed to share %s';
- $message_t = $l->t('You are not allowed to share %s', array($itemSourceName));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName), \OC_Log::ERROR);
- 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!';
- \OC_Log::write('OCP\Share', $message, \OC_Log::ERROR);
- throw new \Exception($message);
- }
- }
- }
- // single file shares should never have delete permissions
- if ($itemType === 'file') {
- $permissions = (int)$permissions & ~\OCP\Constants::PERMISSION_DELETE;
- }
- // Verify share type and sharing conditions are met
- if ($shareType === self::SHARE_TYPE_USER) {
- if ($shareWith == $uidOwner) {
- $message = 'Sharing %s failed, because the user %s is the item owner';
- $message_t = $l->t('Sharing %s failed, because the user %s is the item owner', array($itemSourceName, $shareWith));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- if ($shareWithinGroupOnly) {
- $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($itemSourceName, $shareWith, $uidOwner));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName, $shareWith, $uidOwner), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- }
- // 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- }
- } 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName, $uidOwner, $shareWith), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- // 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)) {
- // Only allow the same share to occur again if it is the same
- // owner and is not a group 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- }
- // 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;
- if (\OC_Appconfig::getValue('core', 'shareapi_allow_links', 'yes') == 'yes') {
- // when updating a link share
- // FIXME Don't delete link if we update it
- 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']);
- $updateExistingShare = true;
- }
- // Generate hash of password - same method as user passwords
- if (!empty($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'];
- }
- }
- 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');
- \OC_Log::write('OCP\Share', $message, \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- if ($updateExistingShare === false &&
- self::isDefaultExpireDateEnabled() &&
- empty($expirationDate)) {
- $expirationDate = Helper::calcExpireDate();
- }
- // Generate token
- if (isset($oldToken)) {
- $token = $oldToken;
- } else {
- $token = \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate(self::TOKEN_LENGTH,
- \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_UPPER.
- \OCP\Security\ISecureRandom::CHAR_DIGITS
- );
- }
- $result = self::put($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $permissions,
- null, $token, $itemSourceName, $expirationDate);
- 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName), \OC_Log::ERROR);
- throw new \Exception($message_t);
- } else if ($shareType === self::SHARE_TYPE_REMOTE) {
- $token = \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate(self::TOKEN_LENGTH, \OCP\Security\ISecureRandom::CHAR_LOWER . \OCP\Security\ISecureRandom::CHAR_UPPER .
- \OCP\Security\ISecureRandom::CHAR_DIGITS);
- $shareWith = Helper::fixRemoteURLInShareWith($shareWith);
- $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;
- } 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));
- \OC_Log::write('OCP\Share', sprintf($message, $shareType, $itemSource), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- // Put the item into the database
- $result = self::put($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $permissions, null, null, $itemSourceName, $expirationDate);
- return $result ? true : false;
- }
- /**
- * 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
- * @param string $owner owner of the share, if null the current user is used
- * @return boolean true on success or false on failure
- */
- public static function unshare($itemType, $itemSource, $shareType, $shareWith, $owner = null) {
- // check if it is a valid itemType
- self::getBackend($itemType);
- $items = self::getItemSharedWithUser($itemType, $itemSource, $shareWith, $owner, $shareType);
- $toDelete = array();
- $newParent = null;
- $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);
- 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
- */
- 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
- *
- * 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();
- if ($itemType === 'file' || $itemType === 'folder') {
- $statement = 'SELECT * FROM `*PREFIX*share` WHERE `item_type` = ? and `file_' . $originType . '` = ?';
- } else {
- $statement = 'SELECT * FROM `*PREFIX*share` WHERE `item_type` = ? and `item_' . $originType . '` = ?';
- }
- $query = \OCP\DB::prepare($statement);
- $result = $query->execute(array($itemType, $itemOrigin));
- $shares = $result->fetchAll();
- $listOfUnsharedItems = array();
- $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));
- $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) {
- $uniqueGroupShare = $share;
- }
- }
- if (!$itemUnshared && isset($groupShare) && !isset($uniqueGroupShare)) {
- $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 (?,?,?,?,?,?,?,?,?,?,?)');
- $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));
- $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));
- $itemUnshared = true;
- }
- if ($itemUnshared) {
- \OC_Hook::emit('OCP\Share', 'post_unshareFromSelf',
- array('unsharedItems' => $listOfUnsharedItems, 'itemType' => $itemType));
- }
- return $itemUnshared;
- }
- /**
- * 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
- */
- public static function setSendMailStatus($itemType, $itemSource, $shareType, $recipient, $status) {
- $status = $status ? 1 : 0;
- $query = \OC_DB::prepare(
- 'UPDATE `*PREFIX*share`
- SET `mail_send` = ?
- WHERE `item_type` = ? AND `item_source` = ? AND `share_type` = ? AND `share_with` = ?');
- $result = $query->execute(array($status, $itemType, $itemSource, $shareType, $recipient));
- if($result === false) {
- \OC_Log::write('OCP\Share', 'Couldn\'t set send mail status', \OC_Log::ERROR);
- }
- }
- /**
- * 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
- */
- public static function setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions) {
- $l = \OC::$server->getL10N('lib');
- if ($item = self::getItems($itemType, $itemSource, $shareType, $shareWith,
- \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($item['parent'])) {
- $query = \OC_DB::prepare('SELECT `permissions` FROM `*PREFIX*share` WHERE `id` = ?', 1);
- $result = $query->execute(array($item['parent']))->fetchRow();
- 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()));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSource, \OC_User::getUser()), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- }
- $query = \OC_DB::prepare('UPDATE `*PREFIX*share` SET `permissions` = ? WHERE `id` = ?');
- $query->execute(array($permissions, $item['id']));
- 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' => $item['path'],
- ));
- }
- // Check if permissions were removed
- if ($item['permissions'] & ~$permissions) {
- // If share permission is removed all reshares must be deleted
- if (($item['permissions'] & \OCP\Constants::PERMISSION_SHARE) && (~$permissions & \OCP\Constants::PERMISSION_SHARE)) {
- // delete all shares, keep parent and group children
- Helper::delete($item['id'], true, null, null, true);
- } else {
- $ids = array();
- $parents = array($item['id']);
- while (!empty($parents)) {
- $parents = "'".implode("','", $parents)."'";
- $query = \OC_DB::prepare('SELECT `id`, `permissions` FROM `*PREFIX*share`'
- .' WHERE `parent` IN ('.$parents.')');
- $result = $query->execute();
- // Reset parents array, only go through loop again if
- // items are found that need permissions removed
- $parents = array();
- while ($item = $result->fetchRow()) {
- // 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'];
- }
- }
- }
- // 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_Config::getValue( "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));
- }
- }
- }
- 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSource), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- /**
- * 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) {
- $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) {
- $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) {
- $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;
- }
- /**
- * 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
- */
- public static function setExpirationDate($itemType, $itemSource, $date, $shareTime = null) {
- $user = \OC_User::getUser();
- $l = \OC::$server->getL10N('lib');
- 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;
- }
- } else {
- $date = self::validateExpireDate($date, $shareTime, $itemType, $itemSource);
- }
- $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);
- $query->execute();
- \OC_Hook::emit('OCP\Share', 'post_set_expiration_date', array(
- 'itemType' => $itemType,
- 'itemSource' => $itemSource,
- 'date' => $date,
- 'uidOwner' => $user
- ));
- return true;
- }
- /**
- * Retrieve the owner of a connection
- *
- * @param Connection $connection
- * @param int $shareId
- * @throws \Exception
- * @return string uid of share owner
- */
- private static function getShareOwner(Connection $connection, $shareId) {
- $qb = $connection->createQueryBuilder();
- $qb->select('`uid_owner`')
- ->from('`*PREFIX*share`')
- ->where('`id` = :shareId')
- ->setParameter(':shareId', $shareId);
- $result = $qb->execute();
- $result = $result->fetch();
- if (empty($result)) {
- throw new \Exception('Share not found');
- }
- return $result['uid_owner'];
- }
- /**
- * Set expiration date for a share
- *
- * @param IUserSession $userSession
- * @param Connection $connection
- * @param IConfig $config
- * @param int $shareId
- * @param string $password
- * @throws \Exception
- * @return boolean
- */
- public static function setPassword(IUserSession $userSession,
- Connection $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');
- }
- $qb = $connection->createQueryBuilder();
- $qb->update('`*PREFIX*share`')
- ->set('`share_with`', ':pass')
- ->where('`id` = :shareId')
- ->setParameter(':pass', is_null($password) ? 'NULL' : \OC::$server->getHasher()->hash($password))
- ->setParameter(':shareId', $shareId);
- $qb->execute();
- return true;
- }
- /**
- * 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.
- */
- protected static function expireItem(array $item) {
- $result = false;
- // only use default expiration date for link shares
- if ((int) $item['share_type'] === self::SHARE_TYPE_LINK) {
- // calculate expiration date
- if (!empty($item['expiration'])) {
- $userDefinedExpire = new \DateTime($item['expiration']);
- $expires = $userDefinedExpire->getTimestamp();
- } else {
- $expires = null;
- }
- // get default expiration settings
- $defaultSettings = Helper::getDefaultExpireSetting();
- $expires = Helper::calculateExpireDate($defaultSettings, $item['stime'], $expires);
- if (is_int($expires)) {
- $now = time();
- if ($now > $expires) {
- self::unshareItem($item);
- $result = true;
- }
- }
- }
- return $result;
- }
- /**
- * Unshares a share given a share data array
- * @param array $item Share data (usually database row)
- * @param int $newParent parent ID
- * @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'];
- }
- // Pass all the vars we have for now, they may be useful
- $hookParams = array(
- 'id' => $item['id'],
- 'itemType' => $item['item_type'],
- 'itemSource' => $item['item_source'],
- 'shareType' => $shareType,
- 'shareWith' => $shareWith,
- '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'];
- }
- \OC_Hook::emit('OCP\Share', 'pre_unshare', $hookParams);
- $deletedShares = Helper::delete($item['id'], false, null, $newParent);
- $deletedShares[] = $hookParams;
- $hookParams['deletedShares'] = $deletedShares;
- \OC_Hook::emit('OCP\Share', 'post_unshare', $hookParams);
- if ((int)$item['share_type'] === \OCP\Share::SHARE_TYPE_REMOTE && \OC::$server->getUserSession()->getUser()) {
- $urlParts = explode('@', $item['share_with'], 2);
- self::sendRemoteUnshare($urlParts[1], $item['id'], $item['token']);
- }
- }
- /**
- * Get the backend class for the specified item type
- * @param string $itemType
- * @throws \Exception
- * @return \OCP\Share_Backend
- */
- public static function getBackend($itemType) {
- $l = \OC::$server->getL10N('lib');
- 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));
- \OC_Log::write('OCP\Share', sprintf($message, $class), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- return self::$backends[$itemType];
- } else {
- $message = 'Sharing backend %s not found';
- $message_t = $l->t('Sharing backend %s not found', array($class));
- \OC_Log::write('OCP\Share', sprintf($message, $class), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- }
- $message = 'Sharing backend for %s not found';
- $message_t = $l->t('Sharing backend for %s not found', array($itemType));
- \OC_Log::write('OCP\Share', sprintf($message, $itemType), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- /**
- * Check if resharing is allowed
- * @return boolean true if allowed or false
- *
- * Resharing is allowed by default if not configured
- */
- public static function isResharingAllowed() {
- if (!isset(self::$isResharingAllowed)) {
- if (\OC_Appconfig::getValue('core', 'shareapi_allow_resharing', 'yes') == 'yes') {
- 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
- * @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')) {
- 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;
- }
- /**
- * 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)
- * @param int $format Format to convert items to with formatItems() (optional)
- * @param mixed $parameters to pass to formatItems() (optional)
- * @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
- * @return array
- *
- * 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) {
- if (!self::isEnabled()) {
- return array();
- }
- $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` ';
- if (!isset($item)) {
- $where .= ' AND `file_target` IS NOT NULL ';
- }
- $where .= 'INNER JOIN `*PREFIX*storages` ON `numeric_id` = `*PREFIX*filecache`.`storage` ';
- $fileDependent = true;
- $queryArgs = array();
- } else {
- $fileDependent = false;
- $root = '';
- $collectionTypes = self::getCollectionItemTypes($itemType);
- if ($includeCollections && !isset($item) && $collectionTypes) {
- // 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);
- }
- }
- if (\OC_Appconfig::getValue('core', 'shareapi_allow_links', 'yes') !== 'yes') {
- $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` = ?) ';
- $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 .= ')';
- // 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;
- }
- if ($fileDependent) {
- $column = 'file_source';
- } else {
- $column = 'item_source';
- }
- } else {
- if ($fileDependent) {
- $column = 'file_target';
- } else {
- $column = 'item_target';
- }
- }
- if (isset($item)) {
- $collectionTypes = self::getCollectionItemTypes($itemType);
- if ($includeCollections && $collectionTypes && !in_array('folder', $collectionTypes)) {
- $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
- if ($fileDependent) {
- $where .= ' `file_source` = ?';
- $column = 'file_source';
- } else {
- $where .= ' `item_source` = ?';
- $column = 'item_source';
- }
- } else {
- if ($fileDependent) {
- $where .= ' `file_target` = ?';
- $item = \OC\Files\Filesystem::normalizePath($item);
- } else {
- $where .= ' `item_target` = ?';
- }
- }
- $queryArgs[] = $item;
- if ($includeCollections && $collectionTypes && !in_array('folder', $collectionTypes)) {
- $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';
- }
- 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;
- }
- $select = self::createSelectStatement($format, $fileDependent, $uidOwner);
- $root = strlen($root);
- $query = \OC_DB::prepare('SELECT '.$select.' FROM `*PREFIX*share` '.$where, $queryLimit);
- $result = $query->execute($queryArgs);
- if (\OC_DB::isError($result)) {
- \OC_Log::write('OCP\Share',
- \OC_DB::getErrorMessage() . ', select=' . $select . ' where=',
- \OC_Log::ERROR);
- }
- $items = array();
- $targets = array();
- $switchedItems = array();
- $mounts = array();
- while ($row = $result->fetchRow()) {
- self::transformDBResults($row);
- // Filter out duplicate group shares for users with unique targets
- if ($fileDependent && !self::isFileReachable($row['path'], $row['storage_id'])) {
- continue;
- }
- 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
- $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'];
- }
- // 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']])) {
- // Check if the same owner shared with the user twice
- // through a group and user share - this is allowed
- $id = $targets[$row['id']];
- 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) {
- $items[$row['id']] = $items[$id];
- $switchedItems[$id] = $row['id'];
- unset($items[$id]);
- $id = $row['id'];
- }
- $items[$id]['permissions'] |= (int)$row['permissions'];
- }
- continue;
- } elseif (!empty($row['parent'])) {
- $targets[$row['parent']] = $row['id'];
- }
- }
- // 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']));
- if (\OC_DB::isError($result)) {
- \OC_Log::write('OCP\Share', 'Can\'t select parent: ' .
- \OC_DB::getErrorMessage() . ', select=' . $select . ' where=' . $where,
- \OC_Log::ERROR);
- } else {
- $parentRow = $parentResult->fetchRow();
- $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);
- foreach (array_slice($splitPath, 2) as $pathPart) {
- $tmpPath = $tmpPath . '/' . $pathPart;
- }
- $row['path'] = $tmpPath;
- }
- } else {
- if (!isset($mounts[$row['storage']])) {
- $mountPoints = \OC\Files\Filesystem::getMountByNumericId($row['storage']);
- if (is_array($mountPoints) && !empty($mountPoints)) {
- $mounts[$row['storage']] = current($mountPoints);
- }
- }
- if (!empty($mounts[$row['storage']])) {
- $path = $mounts[$row['storage']]->getMountPoint().$row['path'];
- $relPath = substr($path, $root); // path relative to data/user
- $row['path'] = rtrim($relPath, '/');
- }
- }
- }
- if($checkExpireDate) {
- if (self::expireItem($row)) {
- continue;
- }
- }
- // Check if resharing is allowed, if not remove share permission
- if (isset($row['permissions']) && (!self::isResharingAllowed() | \OC_Util::isSharingDisabledForUser())) {
- $row['permissions'] &= ~\OCP\Constants::PERMISSION_SHARE;
- }
- // Add display names to result
- if ( isset($row['share_with']) && $row['share_with'] != '' &&
- isset($row['share_with']) && $row['share_type'] === self::SHARE_TYPE_USER) {
- $row['share_with_displayname'] = \OCP\User::getDisplayName($row['share_with']);
- } else {
- $row['share_with_displayname'] = $row['share_with'];
- }
- 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;
- }
- }
- // group items if we are looking for items shared with the current user
- if (isset($shareWith) && $shareWith === \OCP\User::getUser()) {
- $items = self::groupItems($items, $itemType);
- }
- 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
- if ($includeCollections && $collectionTypes && $row['item_type'] !== 'folder' && in_array($row['item_type'], $collectionTypes)) {
- 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'];
- } else { // TODO is this really needed if we already know that we use the file backend?
- $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]);
- } 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;
- }
- }
- }
- if (!empty($collectionItems)) {
- $items = array_merge($items, $collectionItems);
- }
- return self::formatResult($items, $column, $backend, $format, $parameters);
- } 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);
- foreach ($sharedParents as $parent) {
- $collectionItems[] = $parent;
- }
- if ($limit === 1) {
- return reset($collectionItems);
- }
- return self::formatResult($collectionItems, $column, $backend, $format, $parameters);
- }
- return array();
- }
- /**
- * 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) {
- $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'])) {
- // 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;
- }
- /**
- * 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)
- * @throws \Exception
- * @return mixed id of the new share or false
- */
- private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
- $permissions, $parentFolder = null, $token = null, $itemSourceName = null, \DateTime $expirationDate = null) {
- $queriesToExecute = array();
- $suggestedItemTarget = null;
- $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'];
- $expirationDate = $result['expirationDate'];
- }
- $isGroupShare = false;
- if ($shareType == self::SHARE_TYPE_GROUP) {
- $isGroupShare = true;
- if (isset($shareWith['users'])) {
- $users = $shareWith['users'];
- } else {
- $users = \OC_Group::usersInGroup($shareWith['group']);
- }
- // remove current user from list
- if (in_array(\OCP\User::getUser(), $users)) {
- unset($users[array_search(\OCP\User::getUser(), $users)]);
- }
- $groupItemTarget = Helper::generateTarget($itemType, $itemSource,
- $shareType, $shareWith['group'], $uidOwner, $suggestedItemTarget);
- $groupFileTarget = Helper::generateTarget($itemType, $itemSource,
- $shareType, $shareWith['group'], $uidOwner, $filePath);
- // 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,
- );
- } else {
- $users = array($shareWith);
- $itemTarget = Helper::generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
- $suggestedItemTarget);
- }
- $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);
- $userShareType = ($isGroupShare) ? self::$shareTypeGroupUserUnique : $shareType;
- if ($sourceExists) {
- $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;
- }
- } elseif(!$sourceExists && !$isGroupShare) {
- $itemTarget = Helper::generateTarget($itemType, $itemSource, $userShareType, $user,
- $uidOwner, $suggestedItemTarget, $parent);
- if (isset($fileSource)) {
- if ($parentFolder) {
- if ($parentFolder === true) {
- $fileTarget = Helper::generateTarget('file', $filePath, $userShareType, $user,
- $uidOwner, $suggestedFileTarget, $parent);
- if ($fileTarget != $groupFileTarget) {
- $parentFolders[$user]['folder'] = $fileTarget;
- }
- } else if (isset($parentFolder[$user])) {
- $fileTarget = $parentFolder[$user]['folder'].$itemSource;
- $parent = $parentFolder[$user]['id'];
- }
- } else {
- $fileTarget = Helper::generateTarget('file', $filePath, $userShareType,
- $user, $uidOwner, $suggestedFileTarget, $parent);
- }
- } else {
- $fileTarget = null;
- }
- } 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;
- }
- }
- $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,
- );
- }
- $id = false;
- if ($isGroupShare) {
- $id = self::insertShare($queriesToExecute['groupShare']);
- // Save this id, any extra rows for this group share will need to reference it
- $parent = \OC_DB::insertid('*PREFIX*share');
- unset($queriesToExecute['groupShare']);
- }
- foreach ($queriesToExecute as $shareQuery) {
- $shareQuery['parent'] = $parent;
- $id = self::insertShare($shareQuery);
- }
- $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;
- }
- private static function checkReshare($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $permissions, $itemSourceName, $expirationDate) {
- $backend = self::getBackend($itemType);
- $l = \OC::$server->getL10N('lib');
- $result = array();
- $column = ($itemType === 'file' || $itemType === 'folder') ? 'file_source' : 'item_source';
- $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';
- $message_t = $l->t('Sharing %s failed, because the user %s is the original sharer', array($itemSourceName, $shareWith));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName, $shareWith), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- }
- if ($checkReshare && $checkReshare['uid_owner'] !== \OC_User::getUser()) {
- // Check if share permissions is granted
- if (self::isResharingAllowed() && (int)$checkReshare['permissions'] & \OCP\Constants::PERMISSION_SHARE) {
- 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName, $uidOwner), \OC_Log::ERROR);
- throw new \Exception($message_t);
- } else {
- // TODO Don't check if inside folder
- $result['parent'] = $checkReshare['id'];
- $result['expirationDate'] = min($expirationDate, $checkReshare['expiration']);
- // 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;
- }
- }
- } else {
- $message = 'Sharing %s failed, because resharing is not allowed';
- $message_t = $l->t('Sharing %s failed, because resharing is not allowed', array($itemSourceName));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSourceName), \OC_Log::ERROR);
- 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSource, $itemType), \OC_Log::ERROR);
- 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));
- \OC_Log::write('OCP\Share', sprintf($message, $itemSource), \OC_Log::ERROR);
- throw new \Exception($message_t);
- }
- } else {
- $result['filePath'] = null;
- $result['fileSource'] = null;
- }
- }
- return $result;
- }
- /**
- *
- * @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();
- // Fallback, if lastInterId() doesn't work we need to perform a select
- // to get the ID (seems to happen sometimes on Oracle)
- if (!$id) {
- $getId = \OC_DB::prepare('
- SELECT `id`
- FROM`*PREFIX*share`
- WHERE `uid_owner` = ? AND `item_target` = ? AND `item_source` = ? AND `stime` = ?
- ');
- $r = $getId->execute(array($shareData['uidOwner'], $shareData['itemTarget'], $shareData['itemSource'], $shareData['shareTime']));
- if ($r) {
- $row = $r->fetchRow();
- $id = $row['id'];
- }
- }
- }
- return $id;
- }
- /**
- * 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']);
- }
- }
- /**
- * In case a password protected link is not yet authenticated this function will return false
- *
- * @param array $linkItem
- * @return boolean
- */
- 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'] ) {
- return true;
- }
- return false;
- }
- /**
- * construct select statement
- * @param int $format
- * @param boolean $fileDependent ist it a file/folder share or a generla share
- * @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`';
- } else {
- $select = '`id`, `parent`, `share_type`, `share_with`, `uid_owner`, `item_source`, `stime`, `*PREFIX*share`.`permissions`';
- }
- } 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`';
- } else {
- $select = '`id`, `item_type`, `item_source`, `parent`, `share_type`, `share_with`, `*PREFIX*share`.`permissions`,'
- . ' `stime`, `file_source`, `expiration`, `token`, `mail_send`, `uid_owner`';
- }
- } 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`';
- } 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`';
- }
- }
- }
- }
- return $select;
- }
- /**
- * transform db results
- * @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'];
- }
- }
- /**
- * format result
- * @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
- * @param int $format
- * @param array $parameters additional format parameters
- * @return array format result
- */
- 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'])) {
- $statuses[$item[$column]]['path'] = $item['path'];
- }
- }
- return $statuses;
- } else {
- return $backend->formatItems($items, $format, $parameters);
- }
- }
- /**
- * remove protocol from URL
- *
- * @param string $url
- * @return string
- */
- private 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) = explode('@', $shareWith, 2);
- if ($user && $remote) {
- $url = rtrim($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);
- return ($result['success'] && $status['ocs']['meta']['statuscode'] === 100);
- }
- 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);
- }
- /**
- * check if user can only share with group members
- * @return bool
- */
- public static function shareWithGroupMembersOnly() {
- $value = \OC_Appconfig::getValue('core', 'shareapi_only_share_with_group_members', 'no');
- return ($value === 'yes') ? true : false;
- }
- /**
- * @return bool
- */
- public static function isDefaultExpireDateEnabled() {
- $defaultExpireDateEnabled = \OCP\Config::getAppValue('core', 'shareapi_default_expire_date', 'no');
- return ($defaultExpireDateEnabled === "yes") ? true : false;
- }
- /**
- * @return bool
- */
- public static function enforceDefaultExpireDate() {
- $enforceDefaultExpireDate = \OCP\Config::getAppValue('core', 'shareapi_enforce_expire_date', 'no');
- return ($enforceDefaultExpireDate === "yes") ? true : false;
- }
- /**
- * @return int
- */
- 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::')) {
- 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();
- }
- }
|