diff --git a/lib/private/share/share.php b/lib/private/share/share.php index 5314e09b8d..b827b84a9b 100644 --- a/lib/private/share/share.php +++ b/lib/private/share/share.php @@ -1181,7 +1181,7 @@ class Share extends \OC\Share\Constants { } } // TODO Add option for collections to be collection of themselves, only 'folder' does it now... - if (!self::getBackend($itemType) instanceof \OCP\Share_Backend_Collection || $itemType != 'folder') { + 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 @@ -1192,6 +1192,57 @@ class Share extends \OC\Share\Constants { 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 diff --git a/lib/private/tagmanager.php b/lib/private/tagmanager.php index 7a3216de03..d5bff04acf 100644 --- a/lib/private/tagmanager.php +++ b/lib/private/tagmanager.php @@ -70,10 +70,11 @@ class TagManager implements \OCP\ITagManager { * @see \OCP\ITags * @param string $type The type identifier e.g. 'contact' or 'event'. * @param array $defaultTags An array of default tags to be used if none are stored. + * @param boolean $includeShared Whether to include tags for items shared with this user by others. * @return \OCP\ITags */ - public function load($type, $defaultTags=array()) { - return new Tags($this->mapper, $this->user, $type, $defaultTags); + public function load($type, $defaultTags=array(), $includeShared=false) { + return new Tags($this->mapper, $this->user, $type, $defaultTags, $includeShared); } } diff --git a/lib/private/tags.php b/lib/private/tags.php index aceb88355c..82a4aa4d02 100644 --- a/lib/private/tags.php +++ b/lib/private/tags.php @@ -67,6 +67,21 @@ class Tags implements \OCP\ITags { */ private $user; + /** + * Are we including tags for shared items? + * + * @var bool + */ + private $includeShared = false; + + /** + * The current user, plus any owners of the items shared with the current + * user, if $this->includeShared === true. + * + * @var array + */ + private $owners = array(); + /** * The Mapper we're using to communicate our Tag objects to the database. * @@ -74,6 +89,14 @@ class Tags implements \OCP\ITags { */ private $mapper; + /** + * The sharing backend for objects of $this->type. Required if + * $this->includeShared === true to determine ownership of items. + * + * @var \OCP\Share_Backend + */ + private $backend; + const TAG_TABLE = '*PREFIX*vcategory'; const RELATION_TABLE = '*PREFIX*vcategory_to_object'; @@ -86,11 +109,18 @@ class Tags implements \OCP\ITags { * @param string $user The user whose data the object will operate on. * @param string $type The type of items for which tags will be loaded. * @param array $defaultTags Tags that should be created at construction. + * @param boolean $includeShared Whether to include tags for items shared with this user by others. */ - public function __construct(TagMapper $mapper, $user, $type, $defaultTags = array()) { + public function __construct(TagMapper $mapper, $user, $type, $defaultTags = array(), $includeShared = false) { $this->mapper = $mapper; $this->user = $user; $this->type = $type; + $this->includeShared = $includeShared; + $this->owners = array($this->user); + if ($this->includeShared) { + $this->owners = array_merge($this->owners, \OC\Share\Share::getSharedItemsOwners($this->user, $this->type, true)); + $this->backend = \OC\Share\Share::getBackend($this->type); + } $this->loadTags($defaultTags); } @@ -99,14 +129,13 @@ class Tags implements \OCP\ITags { * */ protected function loadTags($defaultTags=array()) { - $this->tags = $this->mapper->loadTags(array($this->user), $this->type); + $this->tags = $this->mapper->loadTags($this->owners, $this->type); if(count($defaultTags) > 0 && count($this->tags) === 0) { $this->addMultiple($defaultTags, true); } \OCP\Util::writeLog('core', __METHOD__.', tags: ' . print_r($this->tags, true), \OCP\Util::DEBUG); - } /** @@ -153,6 +182,21 @@ class Tags implements \OCP\ITags { } + /** + * Return only the tags owned by the given user, omitting any tags shared + * by other users. + * + * @param string $user The user whose tags are to be checked. + * @return array An array of Tag objects. + */ + public function getTagsForUser($user) { + return array_filter($this->tags, + function($tag) use($user) { + return $tag->getOwner() === $user; + } + ); + } + /** * Get the a list if items tagged with $tag. * @@ -200,7 +244,22 @@ class Tags implements \OCP\ITags { if(!is_null($result)) { while( $row = $result->fetchRow()) { - $ids[] = (int)$row['objid']; + $id = (int)$row['objid']; + + if ($this->includeShared) { + // We have to check if we are really allowed to access the + // items that are tagged with $tag. To that end, we ask the + // corresponding sharing backend if the item identified by $id + // is owned by any of $this->owners. + foreach ($this->owners as $owner) { + if ($this->backend->isValidSource($id, $owner)) { + $ids[] = $id; + break; + } + } + } else { + $ids[] = $id; + } } } @@ -208,9 +267,22 @@ class Tags implements \OCP\ITags { } /** - * Checks whether a tag is already saved. + * Checks whether a tag is saved for the given user, + * disregarding the ones shared with him or her. * - * @param string $name The name to check for. + * @param string $name The tag name to check for. + * @param string $user The user whose tags are to be checked. + * @return bool + */ + public function userHasTag($name, $user) { + $key = $this->array_searchi($name, $this->getTagsForUser($user)); + return ($key !== false) ? $this->tags[$key]->getId() : false; + } + + /** + * Checks whether a tag is saved for or shared with the current user. + * + * @param string $name The tag name to check for. * @return bool */ public function hasTag($name) { @@ -230,7 +302,7 @@ class Tags implements \OCP\ITags { \OCP\Util::writeLog('core', __METHOD__.', Cannot add an empty tag', \OCP\Util::DEBUG); return false; } - if($this->hasTag($name)) { // FIXME + if($this->userHasTag($name, $this->user)) { \OCP\Util::writeLog('core', __METHOD__.', name: ' . $name. ' exists already', \OCP\Util::DEBUG); return false; } @@ -263,7 +335,11 @@ class Tags implements \OCP\ITags { return false; } - $key = $this->array_searchi($from, $this->tags); // FIXME: owner. or renameById() ? + if (is_numeric($from)) { + $key = $this->getTagById($from); + } else { + $key = $this->getTagByName($from); + } if($key === false) { \OCP\Util::writeLog('core', __METHOD__.', tag: ' . $from. ' does not exist', \OCP\Util::DEBUG); return false; @@ -285,7 +361,7 @@ class Tags implements \OCP\ITags { * Add a list of new tags. * * @param string[] $names A string with a name or an array of strings containing - * the name(s) of the to add. + * the name(s) of the tag(s) to add. * @param bool $sync When true, save the tags * @param int|null $id int Optional object id to add to this|these tag(s) * @return bool Returns false on error. @@ -467,7 +543,7 @@ class Tags implements \OCP\ITags { * @return boolean */ public function addToFavorites($objid) { - if(!$this->hasTag(self::TAG_FAVORITE)) { + if(!$this->userHasTag(self::TAG_FAVORITE, $this->user)) { $this->add(self::TAG_FAVORITE); } return $this->tagAs($objid, self::TAG_FAVORITE); @@ -554,7 +630,7 @@ class Tags implements \OCP\ITags { /** * Delete tags from the database. * - * @param string[] $names An array of tags to delete + * @param string[] $names An array of tags (names or IDs) to delete * @return bool Returns false on error */ public function delete($names) { @@ -570,8 +646,12 @@ class Tags implements \OCP\ITags { foreach($names as $name) { $id = null; - if($this->hasTag($name)) { - $key = $this->array_searchi($name, $this->tags); + if (is_numeric($name)) { + $key = $this->getTagById($name); + } else { + $key = $this->getTagByName($name); + } + if ($key !== false) { $tag = $this->tags[$key]; $id = $tag->getId(); unset($this->tags[$key]); @@ -618,12 +698,35 @@ class Tags implements \OCP\ITags { * Get a tag's ID. * * @param string $name The tag name to look for. - * @return string The tag's id or false if it hasn't been saved yet. + * @return string|bool The tag's id or false if no matching tag is found. */ private function getTagId($name) { - if (($key = $this->array_searchi($name, $this->tags)) === false) { - return false; + $key = $this->array_searchi($name, $this->tags); + if ($key !== false) { + return $this->tags[$key]->getId(); } - return $this->tags[$key]->getId(); + return false; + } + + /** + * Get a tag by its name. + * + * @param string $name The tag name. + * @return integer|bool The tag object's offset within the $this->tags + * array or false if it doesn't exist. + */ + private function getTagByName($name) { + return $this->array_searchi($name, $this->tags, 'getName'); + } + + /** + * Get a tag by its ID. + * + * @param string $id The tag ID to look for. + * @return integer|bool The tag object's offset within the $this->tags + * array or false if it doesn't exist. + */ + private function getTagById($id) { + return $this->array_searchi($id, $this->tags, 'getId'); } } diff --git a/lib/public/itagmanager.php b/lib/public/itagmanager.php index 40487de42b..54daa5cc1c 100644 --- a/lib/public/itagmanager.php +++ b/lib/public/itagmanager.php @@ -48,8 +48,9 @@ interface ITagManager { * @see \OCP\ITags * @param string $type The type identifier e.g. 'contact' or 'event'. * @param array $defaultTags An array of default tags to be used if none are stored. + * @param boolean $includeShared Whether to include tags for items shared with this user by others. * @return \OCP\ITags */ - public function load($type, $defaultTags=array()); + public function load($type, $defaultTags=array(), $includeShared=false); -} \ No newline at end of file +} diff --git a/lib/public/itags.php b/lib/public/itags.php index 4bfceb8d79..6076ddb4d0 100644 --- a/lib/public/itags.php +++ b/lib/public/itags.php @@ -84,6 +84,16 @@ interface ITags { */ public function hasTag($name); + /** + * Checks whether a tag is saved for the given user, + * disregarding the ones shared with him or her. + * + * @param string $name The tag name to check for. + * @param string $user The user whose tags are to be checked. + * @return bool + */ + public function userHasTag($name, $user); + /** * Add a new tag. * diff --git a/tests/lib/share/backend.php b/tests/lib/share/backend.php index 50ce24e07b..61b8f262a4 100644 --- a/tests/lib/share/backend.php +++ b/tests/lib/share/backend.php @@ -29,9 +29,10 @@ class Test_Share_Backend implements OCP\Share_Backend { private $testItem1 = 'test.txt'; private $testItem2 = 'share.txt'; + private $testId = 1; public function isValidSource($itemSource, $uidOwner) { - if ($itemSource == $this->testItem1 || $itemSource == $this->testItem2) { + if ($itemSource == $this->testItem1 || $itemSource == $this->testItem2 || $itemSource == 1) { return true; } } diff --git a/tests/lib/tags.php b/tests/lib/tags.php index 4d9b8558fd..455b99120a 100644 --- a/tests/lib/tags.php +++ b/tests/lib/tags.php @@ -195,4 +195,28 @@ class Test_Tags extends PHPUnit_Framework_TestCase { $this->assertEquals(array(), $tagger->getFavorites()); } + public function testShareTags() { + $test_tag = 'TestTag'; + OCP\Share::registerBackend('test', 'Test_Share_Backend'); + + $tagger = $this->tagMgr->load('test'); + $tagger->tagAs(1, $test_tag); + + $other_user = uniqid('user2_'); + OC_User::createUser($other_user, 'pass'); + + OC_User::setUserId($other_user); + $other_tagMgr = new OC\TagManager($this->tagMapper, $other_user); + $other_tagger = $other_tagMgr->load('test'); + $this->assertFalse($other_tagger->hasTag($test_tag)); + + OC_User::setUserId($this->user); + OCP\Share::shareItem('test', 1, OCP\Share::SHARE_TYPE_USER, $other_user, OCP\PERMISSION_READ); + + OC_User::setUserId($other_user); + $other_tagger = $other_tagMgr->load('test', array(), true); // Update tags, load shared ones. + $this->assertTrue($other_tagger->hasTag($test_tag)); + $this->assertContains(1, $other_tagger->getIdsForTag($test_tag)); + } + }