mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #21552 from owncloud/share2.0_register_providers 

[Share 2.0] register providers
This commit is contained in:
Thomas Müller 2016-01-13 17:36:26 +01:00
parent 3ee3d02a76 5f5951c8cf
commit 8b346ab7e7
15 changed files with 449 additions and 186 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
apps/files_sharing/api/ocssharewrapper.php
View File

@ -27,21 +27,7 @@ class OCSShareWrapper {
*/
private function getShare20OCS() {
return new Share20OCS(
new \OC\Share20\Manager(
\OC::$server->getLogger(),
\OC::$server->getConfig(),
new \OC\Share20\DefaultShareProvider(
\OC::$server->getDatabaseConnection(),
\OC::$server->getUserManager(),
\OC::$server->getGroupManager(),
\OC::$server->getRootFolder()
),
\OC::$server->getSecureRandom(),
\OC::$server->getHasher(),
\OC::$server->getMountManager(),
\OC::$server->getGroupManager(),
\OC::$server->getL10N('core')
),
\OC::$server->getShareManager(),
\OC::$server->getGroupManager(),
\OC::$server->getUserManager(),
\OC::$server->getRequest(),

31
apps/files_sharing/api/share20ocs.php
View File

@ -142,10 +142,20 @@ class Share20OCS {
* @return \OC_OCS_Result
*/
public function getShare($id) {
// Try both our default, and our federated provider..
$share = null;
// First check if it is an internal share.
try {
$share = $this->shareManager->getShareById($id);
$share = $this->shareManager->getShareById('ocinternal:'.$id);
} catch (\OC\Share20\Exception\ShareNotFound $e) {
return new \OC_OCS_Result(null, 404, 'wrong share ID, share doesn\'t exist.');
// Ignore for now
//return new \OC_OCS_Result(null, 404, 'wrong share ID, share doesn\'t exist.');
}
if ($share === null) {
//For now federated shares are handled by the old endpoint.
return \OCA\Files_Sharing\API\Local::getShare(['id' => $id]);
}
if ($this->canAccessShare($share)) {
@ -163,18 +173,19 @@ class Share20OCS {
* @return \OC_OCS_Result
*/
public function deleteShare($id) {
// Try both our default and our federated provider
$share = null;
try {
$share = $this->shareManager->getShareById($id);
$share = $this->shareManager->getShareById('ocinternal:' . $id);
} catch (\OC\Share20\Exception\ShareNotFound $e) {
return new \OC_OCS_Result(null, 404, 'wrong share ID, share doesn\'t exist.');
//Ignore for now
//return new \OC_OCS_Result(null, 404, 'wrong share ID, share doesn\'t exist.');
}
/*
* FIXME
* User the old code path for remote shares until we have our remoteshareprovider
*/
if ($share->getShareType() === \OCP\Share::SHARE_TYPE_REMOTE) {
\OCA\Files_Sharing\API\Local::deleteShare(['id' => $id]);
// Could not find the share as internal share... maybe it is a federated share
if ($share === null) {
return \OCA\Files_Sharing\API\Local::deleteShare(['id' => $id]);
}
if (!$this->canAccessShare($share)) {

20
apps/files_sharing/tests/api/share20ocstest.php
View File

@ -82,7 +82,7 @@ class Share20OCSTest extends \Test\TestCase {
$this->shareManager
->expects($this->once())
->method('getShareById')
->with(42)
->with('ocinternal:42')
->will($this->throwException(new \OC\Share20\Exception\ShareNotFound()));
$expected = new \OC_OCS_Result(null, 404, 'wrong share ID, share doesn\'t exist.');
@ -95,7 +95,7 @@ class Share20OCSTest extends \Test\TestCase {
$this->shareManager
->expects($this->once())
->method('getShareById')
->with(42)
->with('ocinternal:42')
->willReturn($share);
$this->shareManager
->expects($this->once())
@ -114,7 +114,7 @@ class Share20OCSTest extends \Test\TestCase {
$this->shareManager
->expects($this->once())
->method('getShareById')
->with(42)
->with('ocinternal:42')
->willReturn($share);
$this->shareManager
->expects($this->once())
@ -125,16 +125,20 @@ class Share20OCSTest extends \Test\TestCase {
$this->assertEquals($expected, $this->ocs->deleteShare(42));
}
/*
* FIXME: Enable once we have a federated Share Provider
public function testGetGetShareNotExists() {
$this->shareManager
->expects($this->once())
->method('getShareById')
->with(42)
->with('ocinternal:42')
->will($this->throwException(new \OC\Share20\Exception\ShareNotFound()));
$expected = new \OC_OCS_Result(null, 404, 'wrong share ID, share doesn\'t exist.');
$this->assertEquals($expected, $this->ocs->getShare(42));
}
*/
public function createShare($id, $shareType, $sharedWith, $sharedBy, $shareOwner, $path, $permissions,
$shareTime, $expiration, $parent, $target, $mail_send, $token=null,
@ -155,6 +159,12 @@ class Share20OCSTest extends \Test\TestCase {
$share->method('getToken')->willReturn($token);
$share->method('getPassword')->willReturn($password);
if ($shareType === \OCP\Share::SHARE_TYPE_USER ||
$shareType === \OCP\Share::SHARE_TYPE_GROUP ||
$shareType === \OCP\Share::SHARE_TYPE_LINK) {
$share->method('getFullId')->willReturn('ocinternal:'.$id);
}
return $share;
}
@ -345,7 +355,7 @@ class Share20OCSTest extends \Test\TestCase {
$this->shareManager
->expects($this->once())
->method('getShareById')
->with($share->getId())
->with($share->getFullId())
->willReturn($share);
$userFolder = $this->getMock('OCP\Files\Folder');

16
config/config.sample.php
View File

@ -975,6 +975,22 @@ $CONFIG = array(
),
),
/**
* Sharing
*
* Global settings for Sharing
*/
/**
* Replaces the default Share Provider Factory. This can be utilized if
* own or 3rdParty Share Providers be used that – for instance – uses the
* filesystem instead of the database to keep the share information.
*/
'sharing.managerFactory' => '\OC\Share20\ProviderFactory',
/**
* All other config options
*/

28
lib/private/server.php
View File

@ -564,6 +564,25 @@ class Server extends ServerContainer implements IServerContainer {
$request
);
});
$this->registerService('ShareManager', function(Server $c) {
$config = $c->getConfig();
$factoryClass = $config->getSystemValue('sharing.managerFactory', '\OC\Share20\ProviderFactory');
/** @var \OC\Share20\IProviderFactory $factory */
$factory = new $factoryClass();
$manager = new \OC\Share20\Manager(
$c->getLogger(),
$c->getConfig(),
$c->getSecureRandom(),
$c->getHasher(),
$c->getMountManager(),
$c->getGroupManager(),
$c->getL10N('core'),
$factory
);
return $manager;
});
}
/**
@ -1181,5 +1200,12 @@ class Server extends ServerContainer implements IServerContainer {
public function getUserStoragesService() {
return \OC_Mount_Config::$app->getContainer()->query('OCA\\Files_External\\Service\\UserStoragesService');
}
/**
* @return \OC\Share20\Manager
*/
public function getShareManager() {
return $this->query('ShareManager');
}
}

16
lib/private/share20/defaultshareprovider.php
View File

@ -29,6 +29,11 @@ use OCP\Files\IRootFolder;
use OCP\IDBConnection;
use OCP\Files\Node;
/**
* Class DefaultShareProvider
*
* @package OC\Share20
*/
class DefaultShareProvider implements IShareProvider {
/** @var IDBConnection */
@ -62,6 +67,15 @@ class DefaultShareProvider implements IShareProvider {
$this->rootFolder = $rootFolder;
}
/**
* Return the identifier of this provider.
*
* @return string Containing only [a-zA-Z0-9]
*/
public function identifier() {
return 'ocinternal';
}
/**
* Share a path
*
@ -342,6 +356,8 @@ class DefaultShareProvider implements IShareProvider {
$share->setExpirationDate($expiration);
}
$share->setProviderId($this->identifier());
return $share;
}

27
lib/private/share20/exception/providerexception.php Normal file
View File

@ -0,0 +1,27 @@
<?php
/**
* @author Roeland Jago Douma <rullzer@owncloud.com>
*
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Share20\Exception;
class ProviderException extends \Exception {
}

46
lib/private/share20/iproviderfactory.php Normal file
View File

@ -0,0 +1,46 @@
<?php
/**
* @author Roeland Jago Douma <rullzer@owncloud.com>
*
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Share20;
use OC\Share20\Exception\ProviderException;
/**
* Interface IProviderFactory
*
* @package OC\Share20
* @since 9.0.0
*/
interface IProviderFactory {
/**
* @param string $id
* @return IShareProvider
* @throws ProviderException
*/
public function getProvider($id);
/**
* @param int $shareType
* @return IShareProvider
* @throws ProviderException
*/
public function getProviderForType($shareType);
}

43
lib/private/share20/ishare.php
View File

@ -35,11 +35,34 @@ interface IShare {
*/
public function getId();
/**
* Set the id of the share
*
* @param string $id
* @return IShare The modified share object
*/
public function setId($id);
/**
* Get the full share id
*
* @return string
*/
public function getFullId();
/**
* Set the provider id
*
* @param string $id
* @return IShare The modified share object
*/
public function setProviderId($id);
/**
* Set the path of this share
*
* @param Node $path
* @return Share The modified object
* @return IShare The modified object
*/
public function setPath(Node $path);
@ -54,7 +77,7 @@ interface IShare {
* Set the shareType
*
* @param int $shareType
* @return Share The modified object
* @return IShare The modified object
*/
public function setShareType($shareType);
@ -69,7 +92,7 @@ interface IShare {
* Set the receiver of this share
*
* @param IUser|IGroup|string
* @return Share The modified object
* @return IShare The modified object
*/
public function setSharedWith($sharedWith);
@ -84,7 +107,7 @@ interface IShare {
* Set the permissions
*
* @param int $permissions
* @return Share The modified object
* @return IShare The modified object
*/
public function setPermissions($permissions);
@ -99,7 +122,7 @@ interface IShare {
* Set the expiration date
*
* @param \DateTime $expireDate
* @return Share The modified object
* @return IShare The modified object
*/
public function setExpirationDate($expireDate);
@ -114,7 +137,7 @@ interface IShare {
* Set the sharer of the path
*
* @param IUser|string $sharedBy
* @return Share The modified object
* @return IShare The modified object
*/
public function setSharedBy($sharedBy);
@ -130,7 +153,7 @@ interface IShare {
*
* @param IUser|string
*
* @return Share The modified object
* @return IShare The modified object
*/
public function setShareOwner($shareOwner);
@ -146,7 +169,7 @@ interface IShare {
*
* @param string $password
*
* @return Share The modified object
* @return IShare The modified object
*/
public function setPassword($password);
@ -161,7 +184,7 @@ interface IShare {
* Set the token
*
* @param string $token
* @return Share The modified object
* @return IShare The modified object
*/
public function setToken($token);
@ -183,7 +206,7 @@ interface IShare {
* Set the target of this share
*
* @param string $target
* @return Share The modified object
* @return IShare The modified object
*/
public function setTarget($target);

7
lib/private/share20/ishareprovider.php
View File

@ -26,6 +26,13 @@ use OCP\IUser;
interface IShareProvider {
/**
* Return the identifier of this provider.
*
* @return string Containing only [a-zA-Z0-9]
*/
public function identifier();
/**
* Share a path
*

64
lib/private/share20/manager.php
View File

@ -21,6 +21,8 @@
namespace OC\Share20;
use OC\Share20\Exception\BackendError;
use OC\Share20\Exception\ProviderException;
use OCP\IConfig;
use OCP\IL10N;
use OCP\ILogger;
@ -40,8 +42,11 @@ use OC\HintException;
*/
class Manager {
/** @var IShareProvider[] */
private $defaultProvider;
/** @var IProviderFactory */
private $factory;
/** @var array */
private $type2provider;
/** @var ILogger */
private $logger;
@ -69,23 +74,26 @@ class Manager {
*
* @param ILogger $logger
* @param IConfig $config
* @param IShareProvider $defaultProvider
* @param ISecureRandom $secureRandom
* @param IHasher $hasher
* @param IMountManager $mountManager
* @param IGroupManager $groupManager
* @param IL10N $l
* @param IProviderFactory $factory
*/
public function __construct(
ILogger $logger,
IConfig $config,
IShareProvider $defaultProvider,
ISecureRandom $secureRandom,
IHasher $hasher,
IMountManager $mountManager,
IGroupManager $groupManager,
IL10N $l
IL10N $l,
IProviderFactory $factory
) {
$this->providers = [];
$this->type2provider = [];
$this->logger = $logger;
$this->config = $config;
$this->secureRandom = $secureRandom;
@ -93,9 +101,17 @@ class Manager {
$this->mountManager = $mountManager;
$this->groupManager = $groupManager;
$this->l = $l;
$this->factory = $factory;
}
// TEMP SOLUTION JUST TO GET STARTED
$this->defaultProvider = $defaultProvider;
/**
* Convert from a full share id to a tuple (providerId, shareId)
*
* @param string $id
* @return string[]
*/
private function splitFullId($id) {
return explode(':', $id, 2);
}
/**
@ -246,9 +262,8 @@ class Manager {
return $expireDate;
}
/**
* Check for pre share requirements for use shares
* Check for pre share requirements for user shares
*
* @param IShare $share
* @throws \Exception
@ -271,7 +286,8 @@ class Manager {
*
* Also this is not what we want in the future.. then we want to squash identical shares.
*/
$existingShares = $this->defaultProvider->getSharesByPath($share->getPath());
$provider = $this->factory->getProviderForType(\OCP\Share::SHARE_TYPE_USER);
$existingShares = $provider->getSharesByPath($share->getPath());
foreach($existingShares as $existingShare) {
// Identical share already existst
if ($existingShare->getSharedWith() === $share->getSharedWith()) {
@ -306,7 +322,8 @@ class Manager {
*
* Also this is not what we want in the future.. then we want to squash identical shares.
*/
$existingShares = $this->defaultProvider->getSharesByPath($share->getPath());
$provider = $this->factory->getProviderForType(\OCP\Share::SHARE_TYPE_GROUP);
$existingShares = $provider->getSharesByPath($share->getPath());
foreach($existingShares as $existingShare) {
if ($existingShare->getSharedWith() === $share->getSharedWith()) {
throw new \Exception('Path already shared with this group');
@ -456,7 +473,9 @@ class Manager {
throw new \Exception($error);
}
$share = $this->defaultProvider->create($share);
$provider = $this->factory->getProviderForType($share->getShareType());
$share = $provider->create($share);
$share->setProviderId($provider->identifier());
// Post share hook
$postHookData = [
@ -492,11 +511,14 @@ class Manager {
*/
protected function deleteChildren(IShare $share) {
$deletedShares = [];
foreach($this->defaultProvider->getChildren($share) as $child) {
$provider = $this->factory->getProviderForType($share->getShareType());
foreach ($provider->getChildren($share) as $child) {
$deletedChildren = $this->deleteChildren($child);
$deletedShares = array_merge($deletedShares, $deletedChildren);
$this->defaultProvider->delete($child);
$provider->delete($child);
$deletedShares[] = $child;
}
@ -508,11 +530,12 @@ class Manager {
*
* @param IShare $share
* @throws ShareNotFound
* @throws \OC\Share20\Exception\BackendError
* @throws BackendError
* @throws ShareNotFound
*/
public function deleteShare(IShare $share) {
// Just to make sure we have all the info
$share = $this->getShareById($share->getId());
$share = $this->getShareById($share->getFullId());
$formatHookParams = function(IShare $share) {
// Prepare hook
@ -549,7 +572,8 @@ class Manager {
$deletedShares = $this->deleteChildren($share);
// Do the actual delete
$this->defaultProvider->delete($share);
$provider = $this->factory->getProviderForType($share->getShareType());
$provider->delete($share);
// All the deleted shares caused by this delete
$deletedShares[] = $share;
@ -588,7 +612,11 @@ class Manager {
throw new ShareNotFound();
}
$share = $this->defaultProvider->getShareById($id);
list($providerId, $id) = $this->splitFullId($id);
$provider = $this->factory->getProvider($providerId);
$share = $provider->getShareById($id);
$share->setProviderId($provider->identifier());
return $share;
}

78
lib/private/share20/providerfactory.php Normal file
View File

@ -0,0 +1,78 @@
<?php
/**
* @author Roeland Jago Douma <rullzer@owncloud.com>
*
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Share20;
use OC\Share20\Exception\ProviderException;
/**
* Class ProviderFactory
*
* @package OC\Share20
*/
class ProviderFactory implements IProviderFactory {
/** @var DefaultShareProvider */
private $defaultProvider = null;
/**
* Create the default share provider.
*
* @return DefaultShareProvider
*/
protected function defaultShareProvider() {
if ($this->defaultProvider === null) {
$this->defaultProvider = new DefaultShareProvider(
\OC::$server->getDatabaseConnection(),
\OC::$server->getUserManager(),
\OC::$server->getGroupManager(),
\OC::$server->getRootFolder()
);
}
return $this->defaultProvider;
}
/**
* @inheritdoc
*/
public function getProvider($id) {
if ($id === 'ocinternal') {
return $this->defaultShareProvider();
}
throw new ProviderException('No provider with id .' . $id . ' found.');
}
/**
* @inheritdoc
*/
public function getProviderForType($shareType) {
//FIXME we should not report type 2
if ($shareType === \OCP\Share::SHARE_TYPE_USER ||
$shareType === 2 ||
$shareType === \OCP\Share::SHARE_TYPE_GROUP ||
$shareType === \OCP\Share::SHARE_TYPE_LINK) {
return $this->defaultShareProvider();
}
throw new ProviderException('No share provider for share type ' . $shareType);
}
}

45
lib/private/share20/share.php
View File

@ -28,6 +28,8 @@ class Share implements IShare {
/** @var string */
private $id;
/** @var string */
private $providerId;
/** @var Node */
private $path;
/** @var int */
@ -59,7 +61,7 @@ class Share implements IShare {
* Set the id of the share
*
* @param string $id
* @return Share The modified object
* @return IShare The modified object
*/
public function setId($id) {
$this->id = $id;
@ -75,11 +77,26 @@ class Share implements IShare {
return $this->id;
}
/**
* @inheritdoc
*/
public function getFullId() {
return $this->providerId . ':' . $this->id;
}
/**
* @inheritdoc
*/
public function setProviderId($id) {
$this->providerId = $id;
return $this;
}
/**
* Set the path of this share
*
* @param Node $path
* @return Share The modified object
* @return IShare The modified object
*/
public function setPath(Node $path) {
$this->path = $path;
@ -99,7 +116,7 @@ class Share implements IShare {
* Set the shareType
*
* @param int $shareType
* @return Share The modified object
* @return IShare The modified object
*/
public function setShareType($shareType) {
$this->shareType = $shareType;
@ -119,7 +136,7 @@ class Share implements IShare {
* Set the receiver of this share
*
* @param IUser|IGroup|string
* @return Share The modified object
* @return IShare The modified object
*/
public function setSharedWith($sharedWith) {
$this->sharedWith = $sharedWith;
@ -139,7 +156,7 @@ class Share implements IShare {
* Set the permissions
*
* @param int $permissions
* @return Share The modified object
* @return IShare The modified object
*/
public function setPermissions($permissions) {
//TODO checkes
@ -161,7 +178,7 @@ class Share implements IShare {
* Set the expiration date
*
* @param \DateTime $expireDate
* @return Share The modified object
* @return IShare The modified object
*/
public function setExpirationDate($expireDate) {
//TODO checks
@ -183,7 +200,7 @@ class Share implements IShare {
* Set the sharer of the path
*
* @param IUser|string $sharedBy
* @return Share The modified object
* @return IShare The modified object
*/
public function setSharedBy($sharedBy) {
//TODO checks
@ -207,7 +224,7 @@ class Share implements IShare {
*
* @param IUser|string
*
* @return Share The modified object
* @return IShare The modified object
*/
public function setShareOwner($shareOwner) {
//TODO checks
@ -231,7 +248,7 @@ class Share implements IShare {
*
* @param string $password
*
* @return Share The modified object
* @return IShare The modified object
*/
public function setPassword($password) {
//TODO verify
@ -253,7 +270,7 @@ class Share implements IShare {
* Set the token
*
* @param string $token
* @return Share The modified object
* @return IShare The modified object
*/
public function setToken($token) {
$this->token = $token;
@ -273,7 +290,7 @@ class Share implements IShare {
* Set the parent id of this share
*
* @param int $parent
* @return Share The modified object
* @return IShare The modified object
*/
public function setParent($parent) {
$this->parent = $parent;
@ -293,7 +310,7 @@ class Share implements IShare {
* Set the target of this share
*
* @param string $target
* @return Share The modified object
* @return IShare The modified object
*/
public function setTarget($target) {
$this->target = $target;
@ -313,7 +330,7 @@ class Share implements IShare {
* Set the time this share was created
*
* @param int $shareTime
* @return Share The modified object
* @return IShare The modified object
*/
public function setShareTime($shareTime) {
$this->shareTime = $shareTime;
@ -333,7 +350,7 @@ class Share implements IShare {
* Set mailSend
*
* @param bool $mailSend
* @return Share The modified object
* @return IShare The modified object
*/
public function setMailSend($mailSend) {
$this->mailSend = $mailSend;

3
tests/lib/share20/defaultshareprovidertest.php
View File

@ -589,6 +589,7 @@ class DefaultShareProviderTest extends \Test\TestCase {
$share2 = $this->provider->create($share);
$this->assertNotNull($share2->getId());
$this->assertSame('ocinternal:'.$share2->getId(), $share2->getFullId());
$this->assertSame(\OCP\Share::SHARE_TYPE_USER, $share2->getShareType());
$this->assertSame($sharedWith, $share2->getSharedWith());
$this->assertSame($sharedBy, $share2->getSharedBy());
@ -651,6 +652,7 @@ class DefaultShareProviderTest extends \Test\TestCase {
$share2 = $this->provider->create($share);
$this->assertNotNull($share2->getId());
$this->assertSame('ocinternal:'.$share2->getId(), $share2->getFullId());
$this->assertSame(\OCP\Share::SHARE_TYPE_GROUP, $share2->getShareType());
$this->assertSame($sharedWith, $share2->getSharedWith());
$this->assertSame($sharedBy, $share2->getSharedBy());
@ -710,6 +712,7 @@ class DefaultShareProviderTest extends \Test\TestCase {
$share2 = $this->provider->create($share);
$this->assertNotNull($share2->getId());
$this->assertSame('ocinternal:'.$share2->getId(), $share2->getFullId());
$this->assertSame(\OCP\Share::SHARE_TYPE_LINK, $share2->getShareType());
$this->assertSame($sharedBy, $share2->getSharedBy());
$this->assertSame($shareOwner, $share2->getShareOwner());

195
tests/lib/share20/managertest.php
View File

@ -20,6 +20,7 @@
*/
namespace Test\Share20;
use OC\Share20\IProviderFactory;
use OC\Share20\Manager;
use OC\Share20\Exception;
@ -67,11 +68,13 @@ class ManagerTest extends \Test\TestCase {
/** @var IL10N */
protected $l;
/** @var DummyFactory */
protected $factory;
public function setUp() {
$this->logger = $this->getMock('\OCP\ILogger');
$this->config = $this->getMock('\OCP\IConfig');
$this->defaultProvider = $this->getMock('\OC\Share20\IShareProvider');
$this->secureRandom = $this->getMock('\OCP\Security\ISecureRandom');
$this->hasher = $this->getMock('\OCP\Security\IHasher');
$this->mountManager = $this->getMock('\OCP\Files\Mount\IMountManager');
@ -83,16 +86,41 @@ class ManagerTest extends \Test\TestCase {
return vsprintf($text, $parameters);
}));
$this->factory = new DummyFactory();
$this->manager = new Manager(
$this->logger,
$this->config,
$this->defaultProvider,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l
$this->l,
$this->factory
);
$this->defaultProvider = $this->getMock('\OC\Share20\IShareProvider');
$this->defaultProvider->method('identifier')->willReturn('default');
$this->factory->setProvider($this->defaultProvider);
}
/**
* @return \PHPUnit_Framework_MockObject_MockBuilder
*/
private function createManagerMock() {
return $this->getMockBuilder('\OC\Share20\Manager')
->setConstructorArgs([
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
$this->factory
]);
}
/**
@ -103,7 +131,7 @@ class ManagerTest extends \Test\TestCase {
$share
->expects($this->once())
->method('getId')
->method('getFullId')
->with()
->willReturn(null);
@ -129,17 +157,7 @@ class ManagerTest extends \Test\TestCase {
* @dataProvider dataTestDelete
*/
public function testDelete($shareType, $sharedWith, $sharedWith_string) {
$manager = $this->getMockBuilder('\OC\Share20\Manager')
->setConstructorArgs([
$this->logger,
$this->config,
$this->defaultProvider,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l
])
$manager = $this->createManagerMock()
->setMethods(['getShareById', 'deleteChildren'])
->getMock();
@ -151,13 +169,14 @@ class ManagerTest extends \Test\TestCase {
$share = $this->getMock('\OC\Share20\IShare');
$share->method('getId')->willReturn(42);
$share->method('getFullId')->willReturn('prov:42');
$share->method('getShareType')->willReturn($shareType);
$share->method('getSharedWith')->willReturn($sharedWith);
$share->method('getSharedBy')->willReturn($sharedBy);
$share->method('getPath')->willReturn($path);
$share->method('getTarget')->willReturn('myTarget');
$manager->expects($this->once())->method('getShareById')->with(42)->willReturn($share);
$manager->expects($this->once())->method('getShareById')->with('prov:42')->willReturn($share);
$manager->expects($this->once())->method('deleteChildren')->with($share);
$this->defaultProvider
@ -220,17 +239,7 @@ class ManagerTest extends \Test\TestCase {
}
public function testDeleteNested() {
$manager = $this->getMockBuilder('\OC\Share20\Manager')
->setConstructorArgs([
$this->logger,
$this->config,
$this->defaultProvider,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
$manager = $this->createManagerMock()
->setMethods(['getShareById'])
->getMock();
@ -251,6 +260,7 @@ class ManagerTest extends \Test\TestCase {
$share1 = $this->getMock('\OC\Share20\IShare');
$share1->method('getId')->willReturn(42);
$share1->method('getFullId')->willReturn('prov:42');
$share1->method('getShareType')->willReturn(\OCP\Share::SHARE_TYPE_USER);
$share1->method('getSharedWith')->willReturn($sharedWith1);
$share1->method('getSharedBy')->willReturn($sharedBy1);
@ -259,6 +269,7 @@ class ManagerTest extends \Test\TestCase {
$share2 = $this->getMock('\OC\Share20\IShare');
$share2->method('getId')->willReturn(43);
$share2->method('getFullId')->willReturn('prov:43');
$share2->method('getShareType')->willReturn(\OCP\Share::SHARE_TYPE_GROUP);
$share2->method('getSharedWith')->willReturn($sharedWith2);
$share2->method('getSharedBy')->willReturn($sharedBy2);
@ -268,13 +279,14 @@ class ManagerTest extends \Test\TestCase {
$share3 = $this->getMock('\OC\Share20\IShare');
$share3->method('getId')->willReturn(44);
$share3->method('getFullId')->willReturn('prov:44');
$share3->method('getShareType')->willReturn(\OCP\Share::SHARE_TYPE_LINK);
$share3->method('getSharedBy')->willReturn($sharedBy3);
$share3->method('getPath')->willReturn($path);
$share3->method('getTarget')->willReturn('myTarget3');
$share3->method('getParent')->willReturn(43);
$manager->expects($this->once())->method('getShareById')->with(42)->willReturn($share1);
$manager->expects($this->once())->method('getShareById')->with('prov:42')->willReturn($share1);
$this->defaultProvider
->method('getChildren')
@ -351,7 +363,6 @@ class ManagerTest extends \Test\TestCase {
],
];
$hookListner
->expects($this->exactly(1))
->method('pre')
@ -365,25 +376,19 @@ class ManagerTest extends \Test\TestCase {
}
public function testDeleteChildren() {
$manager = $this->getMockBuilder('\OC\Share20\Manager')
->setConstructorArgs([
$this->logger,
$this->config,
$this->defaultProvider,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
$manager = $this->createManagerMock()
->setMethods(['deleteShare'])
->getMock();
$share = $this->getMock('\OC\Share20\IShare');
$share->method('getShareType')->willReturn(\OCP\Share::SHARE_TYPE_USER);
$child1 = $this->getMock('\OC\Share20\IShare');
$child1->method('getShareType')->willReturn(\OCP\Share::SHARE_TYPE_USER);
$child2 = $this->getMock('\OC\Share20\IShare');
$child2->method('getShareType')->willReturn(\OCP\Share::SHARE_TYPE_USER);
$child3 = $this->getMock('\OC\Share20\IShare');
$child3->method('getShareType')->willReturn(\OCP\Share::SHARE_TYPE_USER);
$shares = [
$child1,
@ -419,7 +424,7 @@ class ManagerTest extends \Test\TestCase {
->with(42)
->willReturn($share);
$this->assertEquals($share, $this->manager->getShareById(42));
$this->assertEquals($share, $this->manager->getShareById('default:42'));
}
/**
@ -770,7 +775,7 @@ class ManagerTest extends \Test\TestCase {
* @expectedException Exception
* @expectedExceptionMessage Path already shared with this user
*/
public function testUserCreateChecksIdenticalPathSharedViaGroup() {
public function testUserCreateChecksIdenticalPathSharedViaGroup() {
$share = new \OC\Share20\Share();
$sharedWith = $this->getMock('\OCP\IUser');
$owner = $this->getMock('\OCP\IUser');
@ -799,7 +804,7 @@ class ManagerTest extends \Test\TestCase {
$this->invokePrivate($this->manager, 'userCreateChecks', [$share]);
}
public function testUserCreateChecksIdenticalPathNotSharedWithUser() {
public function xtestUserCreateChecksIdenticalPathNotSharedWithUser() {
$share = new \OC\Share20\Share();
$sharedWith = $this->getMock('\OCP\IUser');
$owner = $this->getMock('\OCP\IUser');
@ -828,7 +833,6 @@ class ManagerTest extends \Test\TestCase {
$this->invokePrivate($this->manager, 'userCreateChecks', [$share]);
}
/**
* @expectedException Exception
* @expectedExceptionMessage Only sharing within your own groups is allowed
@ -990,7 +994,6 @@ class ManagerTest extends \Test\TestCase {
$this->invokePrivate($this->manager, 'linkCreateChecks', [$share]);
}
public function testLinkCreateChecksPublicUpload() {
$share = new \OC\Share20\Share();
@ -1152,17 +1155,7 @@ class ManagerTest extends \Test\TestCase {
['core', 'shareapi_enabled', 'yes', $sharingEnabled],
]));
$manager = $this->getMockBuilder('\OC\Share20\Manager')
->setConstructorArgs([
$this->logger,
$this->config,
$this->defaultProvider,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
$manager = $this->createManagerMock()
->setMethods(['isSharingDisabledForUser'])
->getMock();
@ -1181,17 +1174,7 @@ class ManagerTest extends \Test\TestCase {
* @expectedExceptionMessage The Share API is disabled
*/
public function testCreateShareCantShare() {
$manager = $this->getMockBuilder('\OC\Share20\Manager')
->setConstructorArgs([
$this->logger,
$this->config,
$this->defaultProvider,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
$manager = $this->createManagerMock()
->setMethods(['canShare'])
->getMock();
@ -1201,17 +1184,7 @@ class ManagerTest extends \Test\TestCase {
}
public function testCreateShareUser() {
$manager = $this->getMockBuilder('\OC\Share20\Manager')
->setConstructorArgs([
$this->logger,
$this->config,
$this->defaultProvider,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
$manager = $this->createManagerMock()
->setMethods(['canShare', 'generalCreateChecks', 'userCreateChecks', 'pathCreateChecks'])
->getMock();
@ -1263,17 +1236,7 @@ class ManagerTest extends \Test\TestCase {
}
public function testCreateShareGroup() {
$manager = $this->getMockBuilder('\OC\Share20\Manager')
->setConstructorArgs([
$this->logger,
$this->config,
$this->defaultProvider,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
$manager = $this->createManagerMock()
->setMethods(['canShare', 'generalCreateChecks', 'groupCreateChecks', 'pathCreateChecks'])
->getMock();
@ -1325,17 +1288,7 @@ class ManagerTest extends \Test\TestCase {
}
public function testCreateShareLink() {
$manager = $this->getMockBuilder('\OC\Share20\Manager')
->setConstructorArgs([
$this->logger,
$this->config,
$this->defaultProvider,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
$manager = $this->createManagerMock()
->setMethods([
'canShare',
'generalCreateChecks',
@ -1466,17 +1419,7 @@ class ManagerTest extends \Test\TestCase {
* @expectedExceptionMessage I won't let you share
*/
public function testCreateShareHookError() {
$manager = $this->getMockBuilder('\OC\Share20\Manager')
->setConstructorArgs([
$this->logger,
$this->config,
$this->defaultProvider,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
$manager = $this->createManagerMock()
->setMethods([
'canShare',
'generalCreateChecks',
@ -1493,8 +1436,6 @@ class ManagerTest extends \Test\TestCase {
$path->method('getOwner')->willReturn($shareOwner);
$path->method('getName')->willReturn('target');
$date = new \DateTime();
$share = $this->createShare(
null,
\OCP\Share::SHARE_TYPE_USER,
@ -1546,3 +1487,31 @@ class DummyCreate {
}
}
class DummyFactory implements IProviderFactory {
/** @var IShareProvider */
private $provider;
/**
* @param IShareProvider $provider
*/
public function setProvider($provider) {
$this->provider = $provider;
}
/**
* @param string $id
* @return IShareProvider
*/
public function getProvider($id) {
return $this->provider;
}
/**
* @param int $shareType
* @return IShareProvider
*/
public function getProviderForType($shareType) {
return $this->provider;
}
}