[Share 2.0] Add share provider factory

* Add providers
* Add share manager to server container
* Use share manager from server container
* Properly get the share manager
This commit is contained in:
Roeland Jago Douma 2016-01-11 10:30:03 +01:00
parent b4de427c1e
commit 67b7ebccd1
9 changed files with 352 additions and 360 deletions

View File

@ -26,34 +26,8 @@ class OCSShareWrapper {
* @return Share20OCS * @return Share20OCS
*/ */
private function getShare20OCS() { private function getShare20OCS() {
$manager =new \OC\Share20\Manager(
\OC::$server->getLogger(),
\OC::$server->getConfig(),
\OC::$server->getSecureRandom(),
\OC::$server->getHasher(),
\OC::$server->getMountManager(),
\OC::$server->getGroupManager(),
\OC::$server->getL10N('core')
);
$manager->registerProvider('ocdefault',
[
\OCP\Share::SHARE_TYPE_USER,
\OCP\SHARE::SHARE_TYPE_GROUP,
\OCP\SHARE::SHARE_TYPE_LINK
],
function() {
return new \OC\Share20\DefaultShareProvider(
\OC::$server->getDatabaseConnection(),
\OC::$server->getUserManager(),
\OC::$server->getGroupManager(),
\OC::$server->getRootFolder()
);
}
);
return new Share20OCS( return new Share20OCS(
$manager, \OC::$server->getShareManager(),
\OC::$server->getGroupManager(), \OC::$server->getGroupManager(),
\OC::$server->getUserManager(), \OC::$server->getUserManager(),
\OC::$server->getRequest(), \OC::$server->getRequest(),

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 * All other config options
*/ */

View File

@ -564,6 +564,25 @@ class Server extends ServerContainer implements IServerContainer {
$request $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() { public function getUserStoragesService() {
return \OC_Mount_Config::$app->getContainer()->query('OCA\\Files_External\\Service\\UserStoragesService'); return \OC_Mount_Config::$app->getContainer()->query('OCA\\Files_External\\Service\\UserStoragesService');
} }
/**
* @return \OC\Share20\Manager
*/
public function getShareManager() {
return $this->query('ShareManager');
}
} }

View File

@ -62,6 +62,19 @@ class DefaultShareProvider implements IShareProvider {
$this->rootFolder = $rootFolder; $this->rootFolder = $rootFolder;
} }
/**
* Return the share types this provider handles
*
* @return int[]
*/
public function shareTypes() {
return [
\OCP\Share::SHARE_TYPE_USER,
\OCP\Share::SHARE_TYPE_GROUP,
\OCP\Share::SHARE_TYPE_LINK,
];
}
/** /**
* Share a path * Share a path
* *

View File

@ -0,0 +1,38 @@
<?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;
/**
* Interface IProviderFactory
*
* @package OC\Share20
* @since 9.0.0
*/
interface IProviderFactory {
/**
* Creates and returns the shareProviders
*
* @return IShareProvider[]
* @since 9.0.0
*/
public function getProviders();
}

View File

@ -26,6 +26,13 @@ use OCP\IUser;
interface IShareProvider { interface IShareProvider {
/**
* Return the share types this provider handles
*
* @return int[]
*/
public function shareTypes();
/** /**
* Share a path * Share a path
* *

View File

@ -41,7 +41,10 @@ use OC\HintException;
*/ */
class Manager { class Manager {
/** @var array */ /** @var IProviderFactory */
private $factory;
/** @var IShareProvider[] */
private $providers; private $providers;
/** @var array */ /** @var array */
@ -78,6 +81,7 @@ class Manager {
* @param IMountManager $mountManager * @param IMountManager $mountManager
* @param IGroupManager $groupManager * @param IGroupManager $groupManager
* @param IL10N $l * @param IL10N $l
* @param IProviderFactory $factory
*/ */
public function __construct( public function __construct(
ILogger $logger, ILogger $logger,
@ -86,7 +90,8 @@ class Manager {
IHasher $hasher, IHasher $hasher,
IMountManager $mountManager, IMountManager $mountManager,
IGroupManager $groupManager, IGroupManager $groupManager,
IL10N $l IL10N $l,
IProviderFactory $factory
) { ) {
$this->providers = []; $this->providers = [];
$this->type2provider = []; $this->type2provider = [];
@ -98,57 +103,49 @@ class Manager {
$this->mountManager = $mountManager; $this->mountManager = $mountManager;
$this->groupManager = $groupManager; $this->groupManager = $groupManager;
$this->l = $l; $this->l = $l;
$this->factory = $factory;
} }
/** /**
* Register a share provider * @param IShareProvider[] $providers
*
* @param string $id The id of the share provider
* @param int[] $shareTypes Array containing the share types this provider handles
* @param callable $callback Callback that must return an IShareProvider instance
* @throws ProviderException * @throws ProviderException
*/ */
public function registerProvider($id, $shareTypes, callable $callback) { private function addProviders(array $providers) {
// Providers must have an unique id foreach ($providers as $provider) {
if (isset($this->providers[$id])) { $name = get_class($provider);
throw new ProviderException('A share provider with the id \''. $id . '\' is already registered');
}
if ($shareTypes === []) { if (!($provider instanceof IShareProvider)) {
throw new ProviderException('shareTypes can\'t be an empty array'); throw new ProviderException($name . ' is not an instance of IShareProvider');
}
foreach($shareTypes as $shareType) {
// We only have 1 provder per share type
if (isset($this->type2provider[$shareType])) {
throw new ProviderException('The share provider ' . $this->type2provider[$shareType] . ' is already registered for share type ' . $shareType);
} }
/* if (isset($this->providers[$name])) {
* We only allow providers that provider throw new ProviderException($name . ' is already registered');
* user- / group- / link- / federated-shares }
*/
if ($shareType !== \OCP\Share::SHARE_TYPE_USER && $this->providers[$name] = $provider;
$shareType !== \OCP\Share::SHARE_TYPE_GROUP && $types = $provider->shareTypes();
$shareType !== \OCP\Share::SHARE_TYPE_LINK &&
$shareType !== \OCP\Share::SHARE_TYPE_REMOTE) { if ($types === []) {
throw new ProviderException('Cannot register provider for share type ' . $shareType); throw new ProviderException('Provider ' . $name . ' must supply share types it can handle');
//Throw exception }
foreach ($types as $type) {
if (isset($this->type2provider[$type])) {
throw new ProviderException($name . ' tried to register for share type ' . $type . ' but this type is already handled by ' . $this->type2provider[$type]);
}
$this->type2provider[$type] = $name;
} }
} }
}
// Add the provider private function runFactory() {
$this->providers[$id] = [ if (!empty($this->providers)) {
'id' => $id, return;
'callback' => $callback,
'provider' => null,
'shareTypes' => $shareTypes,
];
// Update the type mapping
foreach ($shareTypes as $shareType) {
$this->type2provider[$shareType] = $id;
} }
$this->addProviders($this->factory->getProviders());
$this->factoryDone = true;
} }
/** /**
@ -157,23 +154,13 @@ class Manager {
* @throws ProviderException * @throws ProviderException
*/ */
private function getProvider($id) { private function getProvider($id) {
$this->runFactory();
if (!isset($this->providers[$id])) { if (!isset($this->providers[$id])) {
throw new ProviderException('No provider with id ' . $id . ' found'); throw new ProviderException('No provider with id ' . $id . ' found');
} }
if ($this->providers[$id]['provider'] === null) { return $this->providers[$id];
// First time using this provider
$provider = call_user_func($this->providers[$id]['callback']);
// Make sure a proper provider is returned
if (!($provider instanceof IShareProvider)) {
throw new ProviderException('Callback does not return an IShareProvider instance for provider with id ' . $id);
}
$this->providers[$id]['provider'] = $provider;
}
return $this->providers[$id]['provider'];
} }
/** /**
@ -182,6 +169,8 @@ class Manager {
* @throws ProviderException * @throws ProviderException
*/ */
private function getProviderForType($shareType) { private function getProviderForType($shareType) {
$this->runFactory();
if (!isset($this->type2provider[$shareType])) { if (!isset($this->type2provider[$shareType])) {
throw new ProviderException('No share provider registered for share type ' . $shareType); throw new ProviderException('No share provider registered for share type ' . $shareType);
} }
@ -189,6 +178,15 @@ class Manager {
return $this->getProvider($this->type2provider[$shareType]); return $this->getProvider($this->type2provider[$shareType]);
} }
/**
* @return IShareProvider[]
*/
private function getProviders() {
$this->runFactory();
return $this->providers;
}
/** /**
* Verify if a password meets all requirements * Verify if a password meets all requirements
* *
@ -587,10 +585,9 @@ class Manager {
protected function deleteChildren(IShare $share) { protected function deleteChildren(IShare $share) {
$deletedShares = []; $deletedShares = [];
$providerIds = array_keys($this->providers); $providers = $this->getProviders();
foreach($providerIds as $providerId) { foreach($providers as $provider) {
$provider = $this->getProvider($providerId);
foreach ($provider->getChildren($share) as $child) { foreach ($provider->getChildren($share) as $child) {
$deletedChildren = $this->deleteChildren($child); $deletedChildren = $this->deleteChildren($child);
$deletedShares = array_merge($deletedShares, $deletedChildren); $deletedShares = array_merge($deletedShares, $deletedChildren);
@ -691,12 +688,10 @@ class Manager {
//FIXME ids need to become proper providerid:shareid eventually //FIXME ids need to become proper providerid:shareid eventually
$providerIds = array_keys($this->providers); $providers = $this->getProviders();
$share = null; $share = null;
foreach ($providerIds as $providerId) { foreach ($providers as $provider) {
$provider = $this->getProvider($providerId);
try { try {
$share = $provider->getShareById($id); $share = $provider->getShareById($id);
$found = true; $found = true;

View File

@ -0,0 +1,54 @@
<?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;
/**
* Class ProviderFactory
*
* @package OC\Share20
*/
class ProviderFactory implements IProviderFactory {
/**
* Create the default share provider.
*
* @return DefaultShareProvider
*/
protected function defaultShareProvider() {
return new DefaultShareProvider(
\OC::$server->getDatabaseConnection(),
\OC::$server->getUserManager(),
\OC::$server->getGroupManager(),
\OC::$server->getRootFolder()
);
}
/**
* @inheritdoc
*/
public function getProviders() {
$providers = [];
$providers[] = $this->defaultShareProvider();
return $providers;
}
}

View File

@ -20,6 +20,7 @@
*/ */
namespace Test\Share20; namespace Test\Share20;
use OC\Share20\IProviderFactory;
use OC\Share20\Manager; use OC\Share20\Manager;
use OC\Share20\Exception; use OC\Share20\Exception;
@ -67,11 +68,16 @@ class ManagerTest extends \Test\TestCase {
/** @var IL10N */ /** @var IL10N */
protected $l; protected $l;
/** @var IProviderFactory */
protected $factory;
public function setUp() { public function setUp() {
$this->logger = $this->getMock('\OCP\ILogger'); $this->logger = $this->getMock('\OCP\ILogger');
$this->config = $this->getMock('\OCP\IConfig'); $this->config = $this->getMock('\OCP\IConfig');
$this->defaultProvider = $this->getMock('\OC\Share20\IShareProvider'); $this->defaultProvider = $this->getMockBuilder('\OC\Share20\IShareProvider')
->setMockClassName('DefaultShareProvider')
->getMock();
$this->secureRandom = $this->getMock('\OCP\Security\ISecureRandom'); $this->secureRandom = $this->getMock('\OCP\Security\ISecureRandom');
$this->hasher = $this->getMock('\OCP\Security\IHasher'); $this->hasher = $this->getMock('\OCP\Security\IHasher');
$this->mountManager = $this->getMock('\OCP\Files\Mount\IMountManager'); $this->mountManager = $this->getMock('\OCP\Files\Mount\IMountManager');
@ -83,6 +89,8 @@ class ManagerTest extends \Test\TestCase {
return vsprintf($text, $parameters); return vsprintf($text, $parameters);
})); }));
$this->factory = $this->getMock('\OC\Share20\IProviderFactory');
$this->manager = new Manager( $this->manager = new Manager(
$this->logger, $this->logger,
$this->config, $this->config,
@ -90,24 +98,73 @@ class ManagerTest extends \Test\TestCase {
$this->hasher, $this->hasher,
$this->mountManager, $this->mountManager,
$this->groupManager, $this->groupManager,
$this->l $this->l,
$this->factory
); );
$this->manager->registerProvider('tmp',
[ $this->defaultProvider
\OCP\SHARE::SHARE_TYPE_USER, ->method('shareTypes')
->willReturn([
\OCP\Share::SHARE_TYPE_USER,
\OCP\Share::SHARE_TYPE_GROUP, \OCP\Share::SHARE_TYPE_GROUP,
\OCP\Share::SHARE_TYPE_LINK \OCP\Share::SHARE_TYPE_LINK,
], ]);
function() { }
return $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
]);
}
/**
* Initialise the factory. If $providers is null add the defaultProvider
* @param array $providers
*/
private function factoryProviders(array $providers = null) {
if ($providers === null) {
$this->factory->method('getProviders')->willReturn([$this->defaultProvider]);
} else {
$this->factory->method('getProviders')->willReturn($providers);
}
}
/**
* @param int[] $shareTypes Share types for this provider
* @param string|null $name The name of this provider
* @return \PHPUnit_Framework_MockObject_MockObject|IShareProvider
*/
private function createShareProvider(array $shareTypes, $name = null) {
$provider = $this->getMockBuilder('\OC\Share20\IShareProvider');
if ($name !== null) {
$provider->setMockClassName($name);
}
$provider = $provider->getMock();
$provider->method('shareTypes')->willReturn($shareTypes);
return $provider;
} }
/** /**
* @expectedException \OC\Share20\Exception\ShareNotFound * @expectedException \OC\Share20\Exception\ShareNotFound
*/ */
public function testDeleteNoShareId() { public function testDeleteNoShareId() {
$this->factoryProviders();
$share = $this->getMock('\OC\Share20\IShare'); $share = $this->getMock('\OC\Share20\IShare');
$share $share
@ -138,25 +195,17 @@ class ManagerTest extends \Test\TestCase {
* @dataProvider dataTestDelete * @dataProvider dataTestDelete
*/ */
public function testDelete($shareType, $sharedWith, $sharedWith_string) { public function testDelete($shareType, $sharedWith, $sharedWith_string) {
$manager = $this->getMockBuilder('\OC\Share20\Manager') $manager = $this->createManagerMock()
->setConstructorArgs([
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l
])
->setMethods(['getShareById', 'deleteChildren']) ->setMethods(['getShareById', 'deleteChildren'])
->getMock(); ->getMock();
$manager->registerProvider('tmp', $provider = $this->createShareProvider([
[$shareType], \OCP\Share::SHARE_TYPE_USER,
function() { \OCP\Share::SHARE_TYPE_GROUP,
return $this->defaultProvider; \OCP\Share::SHARE_TYPE_LINK,
} \OCP\Share::SHARE_TYPE_REMOTE,
); ]);
$this->factoryProviders([$provider]);
$sharedBy = $this->getMock('\OCP\IUser'); $sharedBy = $this->getMock('\OCP\IUser');
$sharedBy->method('getUID')->willReturn('sharedBy'); $sharedBy->method('getUID')->willReturn('sharedBy');
@ -175,7 +224,7 @@ class ManagerTest extends \Test\TestCase {
$manager->expects($this->once())->method('getShareById')->with(42)->willReturn($share); $manager->expects($this->once())->method('getShareById')->with(42)->willReturn($share);
$manager->expects($this->once())->method('deleteChildren')->with($share); $manager->expects($this->once())->method('deleteChildren')->with($share);
$this->defaultProvider $provider
->expects($this->once()) ->expects($this->once())
->method('delete') ->method('delete')
->with($share); ->with($share);
@ -235,27 +284,12 @@ class ManagerTest extends \Test\TestCase {
} }
public function testDeleteNested() { public function testDeleteNested() {
$manager = $this->getMockBuilder('\OC\Share20\Manager') $manager = $this->createManagerMock()
->setConstructorArgs([
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
->setMethods(['getShareById']) ->setMethods(['getShareById'])
->getMock(); ->getMock();
$manager->registerProvider('tmp', $provider = $this->createShareProvider([\OCP\Share::SHARE_TYPE_USER]);
[ $this->factoryProviders([$provider]);
\OCP\Share::SHARE_TYPE_USER
],
function() {
return $this->defaultProvider;
}
);
$sharedBy1 = $this->getMock('\OCP\IUser'); $sharedBy1 = $this->getMock('\OCP\IUser');
$sharedBy1->method('getUID')->willReturn('sharedBy1'); $sharedBy1->method('getUID')->willReturn('sharedBy1');
@ -299,7 +333,7 @@ class ManagerTest extends \Test\TestCase {
$manager->expects($this->once())->method('getShareById')->with(42)->willReturn($share1); $manager->expects($this->once())->method('getShareById')->with(42)->willReturn($share1);
$this->defaultProvider $provider
->method('getChildren') ->method('getChildren')
->will($this->returnValueMap([ ->will($this->returnValueMap([
[$share1, [$share2]], [$share1, [$share2]],
@ -388,25 +422,12 @@ class ManagerTest extends \Test\TestCase {
} }
public function testDeleteChildren() { public function testDeleteChildren() {
$manager = $this->getMockBuilder('\OC\Share20\Manager') $manager = $this->createManagerMock()
->setConstructorArgs([
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
->setMethods(['deleteShare']) ->setMethods(['deleteShare'])
->getMock(); ->getMock();
$manager->registerProvider('tmp', $provider = $this->createShareProvider([\OCP\Share::SHARE_TYPE_USER]);
[\OCP\Share::SHARE_TYPE_USER], $this->factoryProviders([$provider]);
function() {
return $this->defaultProvider;
}
);
$share = $this->getMock('\OC\Share20\IShare'); $share = $this->getMock('\OC\Share20\IShare');
@ -420,7 +441,7 @@ class ManagerTest extends \Test\TestCase {
$child3, $child3,
]; ];
$this->defaultProvider $provider
->expects($this->exactly(4)) ->expects($this->exactly(4))
->method('getChildren') ->method('getChildren')
->will($this->returnCallback(function($_share) use ($share, $shares) { ->will($this->returnCallback(function($_share) use ($share, $shares) {
@ -430,7 +451,7 @@ class ManagerTest extends \Test\TestCase {
return []; return [];
})); }));
$this->defaultProvider $provider
->expects($this->exactly(3)) ->expects($this->exactly(3))
->method('delete') ->method('delete')
->withConsecutive($child1, $child2, $child3); ->withConsecutive($child1, $child2, $child3);
@ -440,6 +461,8 @@ class ManagerTest extends \Test\TestCase {
} }
public function testGetShareById() { public function testGetShareById() {
$this->factoryProviders();
$share = $this->getMock('\OC\Share20\IShare'); $share = $this->getMock('\OC\Share20\IShare');
$this->defaultProvider $this->defaultProvider
@ -771,6 +794,8 @@ class ManagerTest extends \Test\TestCase {
->with($path) ->with($path)
->willReturn([]); ->willReturn([]);
$this->factoryProviders();
$this->invokePrivate($this->manager, 'userCreateChecks', [$share]); $this->invokePrivate($this->manager, 'userCreateChecks', [$share]);
} }
@ -792,6 +817,8 @@ class ManagerTest extends \Test\TestCase {
->with($path) ->with($path)
->willReturn([$share]); ->willReturn([$share]);
$this->factoryProviders();
$this->invokePrivate($this->manager, 'userCreateChecks', [$share]); $this->invokePrivate($this->manager, 'userCreateChecks', [$share]);
} }
@ -825,6 +852,8 @@ class ManagerTest extends \Test\TestCase {
->with($path) ->with($path)
->willReturn([$share2]); ->willReturn([$share2]);
$this->factoryProviders();
$this->invokePrivate($this->manager, 'userCreateChecks', [$share]); $this->invokePrivate($this->manager, 'userCreateChecks', [$share]);
} }
@ -854,10 +883,11 @@ class ManagerTest extends \Test\TestCase {
->with($path) ->with($path)
->willReturn([$share2]); ->willReturn([$share2]);
$this->factoryProviders();
$this->invokePrivate($this->manager, 'userCreateChecks', [$share]); $this->invokePrivate($this->manager, 'userCreateChecks', [$share]);
} }
/** /**
* @expectedException Exception * @expectedException Exception
* @expectedExceptionMessage Only sharing within your own groups is allowed * @expectedExceptionMessage Only sharing within your own groups is allowed
@ -902,6 +932,7 @@ class ManagerTest extends \Test\TestCase {
['core', 'shareapi_only_share_with_group_members', 'no', 'yes'], ['core', 'shareapi_only_share_with_group_members', 'no', 'yes'],
])); ]));
$this->factoryProviders();
$this->invokePrivate($this->manager, 'groupCreateChecks', [$share]); $this->invokePrivate($this->manager, 'groupCreateChecks', [$share]);
} }
@ -925,6 +956,7 @@ class ManagerTest extends \Test\TestCase {
->with($path) ->with($path)
->willReturn([$share2]); ->willReturn([$share2]);
$this->factoryProviders();
$this->invokePrivate($this->manager, 'groupCreateChecks', [$share]); $this->invokePrivate($this->manager, 'groupCreateChecks', [$share]);
} }
@ -945,6 +977,8 @@ class ManagerTest extends \Test\TestCase {
->with($path) ->with($path)
->willReturn([$share2]); ->willReturn([$share2]);
$this->factoryProviders();
$this->invokePrivate($this->manager, 'groupCreateChecks', [$share]); $this->invokePrivate($this->manager, 'groupCreateChecks', [$share]);
} }
@ -1019,7 +1053,6 @@ class ManagerTest extends \Test\TestCase {
$this->invokePrivate($this->manager, 'linkCreateChecks', [$share]); $this->invokePrivate($this->manager, 'linkCreateChecks', [$share]);
} }
public function testLinkCreateChecksPublicUpload() { public function testLinkCreateChecksPublicUpload() {
$share = new \OC\Share20\Share(); $share = new \OC\Share20\Share();
@ -1181,16 +1214,7 @@ class ManagerTest extends \Test\TestCase {
['core', 'shareapi_enabled', 'yes', $sharingEnabled], ['core', 'shareapi_enabled', 'yes', $sharingEnabled],
])); ]));
$manager = $this->getMockBuilder('\OC\Share20\Manager') $manager = $this->createManagerMock()
->setConstructorArgs([
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
->setMethods(['isSharingDisabledForUser']) ->setMethods(['isSharingDisabledForUser'])
->getMock(); ->getMock();
@ -1209,16 +1233,7 @@ class ManagerTest extends \Test\TestCase {
* @expectedExceptionMessage The Share API is disabled * @expectedExceptionMessage The Share API is disabled
*/ */
public function testCreateShareCantShare() { public function testCreateShareCantShare() {
$manager = $this->getMockBuilder('\OC\Share20\Manager') $manager = $this->createManagerMock()
->setConstructorArgs([
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
->setMethods(['canShare']) ->setMethods(['canShare'])
->getMock(); ->getMock();
@ -1228,25 +1243,12 @@ class ManagerTest extends \Test\TestCase {
} }
public function testCreateShareUser() { public function testCreateShareUser() {
$manager = $this->getMockBuilder('\OC\Share20\Manager') $manager = $this->createManagerMock()
->setConstructorArgs([
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
->setMethods(['canShare', 'generalCreateChecks', 'userCreateChecks', 'pathCreateChecks']) ->setMethods(['canShare', 'generalCreateChecks', 'userCreateChecks', 'pathCreateChecks'])
->getMock(); ->getMock();
$manager->registerProvider('tmp', $provider = $this->createShareProvider([\OCP\Share::SHARE_TYPE_USER]);
[\OCP\Share::SHARE_TYPE_USER], $this->factoryProviders([$provider]);
function() {
return $this->defaultProvider;
}
);
$sharedWith = $this->getMock('\OCP\IUser'); $sharedWith = $this->getMock('\OCP\IUser');
$sharedBy = $this->getMock('\OCP\IUser'); $sharedBy = $this->getMock('\OCP\IUser');
@ -1279,7 +1281,7 @@ class ManagerTest extends \Test\TestCase {
->method('pathCreateChecks') ->method('pathCreateChecks')
->with($path); ->with($path);
$this->defaultProvider $provider
->expects($this->once()) ->expects($this->once())
->method('create') ->method('create')
->with($share) ->with($share)
@ -1296,25 +1298,12 @@ class ManagerTest extends \Test\TestCase {
} }
public function testCreateShareGroup() { public function testCreateShareGroup() {
$manager = $this->getMockBuilder('\OC\Share20\Manager') $manager = $this->createManagerMock()
->setConstructorArgs([
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
->setMethods(['canShare', 'generalCreateChecks', 'groupCreateChecks', 'pathCreateChecks']) ->setMethods(['canShare', 'generalCreateChecks', 'groupCreateChecks', 'pathCreateChecks'])
->getMock(); ->getMock();
$manager->registerProvider('tmp', $provider = $this->createShareProvider([\OCP\Share::SHARE_TYPE_GROUP]);
[\OCP\Share::SHARE_TYPE_GROUP], $this->factoryProviders([$provider]);
function() {
return $this->defaultProvider;
}
);
$sharedWith = $this->getMock('\OCP\IGroup'); $sharedWith = $this->getMock('\OCP\IGroup');
$sharedBy = $this->getMock('\OCP\IUser'); $sharedBy = $this->getMock('\OCP\IUser');
@ -1347,7 +1336,7 @@ class ManagerTest extends \Test\TestCase {
->method('pathCreateChecks') ->method('pathCreateChecks')
->with($path); ->with($path);
$this->defaultProvider $provider
->expects($this->once()) ->expects($this->once())
->method('create') ->method('create')
->with($share) ->with($share)
@ -1364,17 +1353,7 @@ class ManagerTest extends \Test\TestCase {
} }
public function testCreateShareLink() { public function testCreateShareLink() {
$manager = $this->getMockBuilder('\OC\Share20\Manager') $manager = $this->createManagerMock()
->setConstructorArgs([
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
->setMethods([ ->setMethods([
'canShare', 'canShare',
'generalCreateChecks', 'generalCreateChecks',
@ -1385,12 +1364,8 @@ class ManagerTest extends \Test\TestCase {
]) ])
->getMock(); ->getMock();
$manager->registerProvider('tmp', $provider = $this->createShareProvider([\OCP\Share::SHARE_TYPE_LINK]);
[\OCP\Share::SHARE_TYPE_LINK], $this->factoryProviders([$provider]);
function() {
return $this->defaultProvider;
}
);
$sharedBy = $this->getMock('\OCP\IUser'); $sharedBy = $this->getMock('\OCP\IUser');
$sharedBy->method('getUID')->willReturn('sharedBy'); $sharedBy->method('getUID')->willReturn('sharedBy');
@ -1445,7 +1420,7 @@ class ManagerTest extends \Test\TestCase {
$this->secureRandom->method('generate') $this->secureRandom->method('generate')
->willReturn('token'); ->willReturn('token');
$this->defaultProvider $provider
->expects($this->once()) ->expects($this->once())
->method('create') ->method('create')
->with($share) ->with($share)
@ -1512,16 +1487,7 @@ class ManagerTest extends \Test\TestCase {
* @expectedExceptionMessage I won't let you share * @expectedExceptionMessage I won't let you share
*/ */
public function testCreateShareHookError() { public function testCreateShareHookError() {
$manager = $this->getMockBuilder('\OC\Share20\Manager') $manager = $this->createManagerMock()
->setConstructorArgs([
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l,
])
->setMethods([ ->setMethods([
'canShare', 'canShare',
'generalCreateChecks', 'generalCreateChecks',
@ -1530,12 +1496,8 @@ class ManagerTest extends \Test\TestCase {
]) ])
->getMock(); ->getMock();
$manager->registerProvider('tmp', $provider = $this->createShareProvider([\OCP\Share::SHARE_TYPE_USER]);
[\OCP\Share::SHARE_TYPE_USER], $this->factoryProviders([$provider]);
function() {
return $this->defaultProvider;
}
);
$sharedWith = $this->getMock('\OCP\IUser'); $sharedWith = $this->getMock('\OCP\IUser');
$sharedBy = $this->getMock('\OCP\IUser'); $sharedBy = $this->getMock('\OCP\IUser');
@ -1545,8 +1507,6 @@ class ManagerTest extends \Test\TestCase {
$path->method('getOwner')->willReturn($shareOwner); $path->method('getOwner')->willReturn($shareOwner);
$path->method('getName')->willReturn('target'); $path->method('getName')->willReturn('target');
$date = new \DateTime();
$share = $this->createShare( $share = $this->createShare(
null, null,
\OCP\Share::SHARE_TYPE_USER, \OCP\Share::SHARE_TYPE_USER,
@ -1609,94 +1569,46 @@ class ManagerTest extends \Test\TestCase {
* @param int[] $shareTypes * @param int[] $shareTypes
*/ */
public function testRegisterProvider($shareTypes) { public function testRegisterProvider($shareTypes) {
$manager = new Manager( $provider = $this->createShareProvider($shareTypes);
$this->logger, $this->factoryProviders([$provider]);
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l
);
$provider = $this->getMock('OC\Share20\IShareProvider'); $name = get_class($provider);
$manager->registerProvider('foo', $shareTypes, function() use ($provider) {
return $provider;
});
$this->assertEquals($provider, $this->invokePrivate($manager, 'getProvider', ['foo'])); $this->assertEquals($provider, $this->invokePrivate($this->manager, 'getProvider', [$name]));
foreach ($shareTypes as $shareType) { foreach ($shareTypes as $shareType) {
$this->assertEquals($provider, $this->invokePrivate($manager, 'getProviderForType', [$shareType])); $this->assertEquals($provider, $this->invokePrivate($this->manager, 'getProviderForType', [$shareType]));
} }
} }
/** /**
* @expectedException \OC\Share20\Exception\ProviderException * @expectedException \OC\Share20\Exception\ProviderException
* @expectedExceptionMessage A share provider with the id 'foo' is already registered * @expectedExceptionMessage ShareProvider is already registered
*/ */
public function testRegisterProviderDuplicateId() { public function testRegisterProviderDuplicateId() {
$manager = new Manager( $provider = $this->createShareProvider([\OCP\Share::SHARE_TYPE_USER], 'ShareProvider');
$this->logger, $this->factoryProviders([$provider, $provider]);
$this->config, $this->invokePrivate($this->manager, 'runFactory', []);
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l
);
$provider = $this->getMock('OC\Share20\IShareProvider');
$manager->registerProvider('foo', [\OCP\Share::SHARE_TYPE_USER], function() use ($provider) {
return $provider;
});
$manager->registerProvider('foo', [\OCP\Share::SHARE_TYPE_USER], function() use ($provider) {
return $provider;
});
} }
/** /**
* @expectedException \OC\Share20\Exception\ProviderException * @expectedException \OC\Share20\Exception\ProviderException
* @expectedExceptionMessage shareTypes can't be an empty array * @expectedExceptionMessage Provider ShareProvider must supply share types it can handle
*/ */
public function testRegisterProviderEmptyShareTypes() { public function testRegisterProviderEmptyShareTypes() {
$manager = new Manager( $provider = $this->createShareProvider([], 'ShareProvider');
$this->logger, $this->factoryProviders([$provider]);
$this->config, $this->invokePrivate($this->manager, 'runFactory', []);
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l
);
$provider = $this->getMock('OC\Share20\IShareProvider');
$manager->registerProvider('foo', [], function() use ($provider) {
return $provider;
});
} }
/** /**
* @expectedException \OC\Share20\Exception\ProviderException * @expectedException \OC\Share20\Exception\ProviderException
* @expectedExceptionMessage The share provider foo is already registered for share type 0 * @expectedExceptionMessage shareProvider2 tried to register for share type 0 but this type is already handled by shareProvider1
*/ */
public function testRegisterProviderSameType() { public function testRegisterProviderSameType() {
$manager = new Manager( $provider1 = $this->createShareProvider([\OCP\Share::SHARE_TYPE_USER], 'shareProvider1');
$this->logger, $provider2 = $this->createShareProvider([\OCP\Share::SHARE_TYPE_USER], 'shareProvider2');
$this->config, $this->factoryProviders([$provider1, $provider2]);
$this->secureRandom, $this->invokePrivate($this->manager, 'runFactory', []);
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l
);
$provider = $this->getMock('OC\Share20\IShareProvider');
$manager->registerProvider('foo', [\OCP\Share::SHARE_TYPE_USER], function() use ($provider) {
return $provider;
});
$manager->registerProvider('bar', [\OCP\Share::SHARE_TYPE_USER, \OCP\Share::SHARE_TYPE_GROUP], function() use ($provider) {
return $provider;
});
} }
/** /**
@ -1704,39 +1616,8 @@ class ManagerTest extends \Test\TestCase {
* @expectedExceptionMessage No provider with id foo found * @expectedExceptionMessage No provider with id foo found
*/ */
public function testGetProviderNoProviderWithId() { public function testGetProviderNoProviderWithId() {
$manager = new Manager( $this->factoryProviders([]);
$this->logger, $this->invokePrivate($this->manager, 'getProvider', ['foo']);
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l
);
$this->invokePrivate($manager, 'getProvider', ['foo']);
}
/**
* @expectedException \OC\Share20\Exception\ProviderException
* @expectedExceptionMessage Callback does not return an IShareProvider instance for provider with id foo
*/
public function testGetProviderNoIShareProvider() {
$manager = new Manager(
$this->logger,
$this->config,
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l
);
$provider = $this->getMock('OC\Share20\IShare');
$manager->registerProvider('foo', [\OCP\Share::SHARE_TYPE_USER], function() use ($provider) {
return $provider;
});
$this->invokePrivate($manager, 'getProvider', ['foo']);
} }
/** /**
@ -1744,21 +1625,9 @@ class ManagerTest extends \Test\TestCase {
* @expectedExceptionMessage No share provider registered for share type 1 * @expectedExceptionMessage No share provider registered for share type 1
*/ */
public function testGetProviderForTypeUnkownType() { public function testGetProviderForTypeUnkownType() {
$manager = new Manager( $provider = $this->createShareProvider([\OCP\Share::SHARE_TYPE_USER]);
$this->logger, $this->factoryProviders([$provider]);
$this->config, $this->invokePrivate($this->manager, 'getProviderForType', [\OCP\SHARE::SHARE_TYPE_GROUP]);
$this->secureRandom,
$this->hasher,
$this->mountManager,
$this->groupManager,
$this->l
);
$provider = $this->getMock('OC\Share20\IShareProvider');
$manager->registerProvider('foo', [\OCP\Share::SHARE_TYPE_USER], function() use ($provider) {
return $provider;
});
$this->invokePrivate($manager, 'getProviderForType', [\OCP\SHARE::SHARE_TYPE_GROUP]);
} }
} }