diff --git a/apps/files_sharing/appinfo/routes.php b/apps/files_sharing/appinfo/routes.php index dd9509575b..44ab5c0de9 100644 --- a/apps/files_sharing/appinfo/routes.php +++ b/apps/files_sharing/appinfo/routes.php @@ -56,3 +56,10 @@ $this->create('sharing_external_test_remote', '/testremote') '/apps/files_sharing/api/v1/shares/{id}', array('\OCA\Files_Sharing\API\Local', 'deleteShare'), 'files_sharing'); + +// Register with the capabilities API +\OC_API::register('get', + '/cloud/capabilities', + array('OCA\Files_Sharing\Capabilities', 'getCapabilities'), + 'files_sharing', + \OC_API::USER_AUTH); diff --git a/apps/files_sharing/lib/capabilities.php b/apps/files_sharing/lib/capabilities.php new file mode 100644 index 0000000000..ff01770719 --- /dev/null +++ b/apps/files_sharing/lib/capabilities.php @@ -0,0 +1,72 @@ + + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OCA\Files_Sharing; + + +/** + * Class Capabilities + * + * @package OCA\Files_Sharing + */ +class Capabilities { + + private $config; + + /* + * @codeCoverageIgnore + */ + public function __construct($config) { + $this->config = $config; + } + + /* + * @codeCoverageIgnore + */ + public static function getCapabilities() { + $config = \OC::$server->getConfig(); + $cap = new Capabilities($config); + return $cap->getCaps(); + } + + + /** + * @return \OC_OCS_Result + */ + public function getCaps() { + $res = array(); + + $public = false;; + if ($this->config->getAppValue('core', 'shareapi_allow_links', 'yes') === 'yes') { + $public = array(); + $public['password_enforced'] = ($this->config->getAppValue('core', 'shareapi_enforce_links_password', 'yes') === 'yes'); + + $public['expire_date'] = false; + if ($this->config->getAppValue('core', 'shareapi_default_expire_date', 'yes') === 'yes') { + $public['expire_date'] = array(); + $public['expire_date']['days'] = $this->config->getAppValue('core', 'shareapi_expire_after_n_days', false); + $public['expire_date']['enforce'] = $this->config->getAppValue('core', 'shareapi_enforce_expire_date', 'yes') === 'yes'; + } + + $public['send_mail'] = $this->config->getAppValue('core', 'shareapi_allow_public_notification', 'yes') === 'yes'; + } + $res["public"] = $public; + + $res['user']['send_mail'] = $this->config->getAppValue('core', 'shareapi_allow_mail_notification', 'yes') === 'yes'; + + $res['resharing'] = $this->config->getAppValue('core', 'shareapi_allow_resharing', 'yes') === 'yes'; + + + return new \OC_OCS_Result(array( + 'capabilities' => array( + 'files_sharing' => $res + ), + )); + } + +} diff --git a/apps/files_sharing/tests/capabilities.php b/apps/files_sharing/tests/capabilities.php new file mode 100644 index 0000000000..cafd5c4652 --- /dev/null +++ b/apps/files_sharing/tests/capabilities.php @@ -0,0 +1,201 @@ + + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +use OCA\Files\Share\Tests; +use OCA\Files_sharing\Tests\TestCase; + +/** + * Class Test_Files_Sharing_Capabilties + */ +class Test_Files_Sharing_Capabilities extends \Test\TestCase { + + /** + * Test for the general part in each return statement and assert + */ + function getFilesSharingPart($data) { + $this->assertArrayHasKey('capabilities', $data); + $this->assertArrayHasKey('files_sharing', $data['capabilities']); + return $data['capabilities']['files_sharing']; + } + + /** + * Create a mock config object and insert the values in $map tot the getAppValue + * function. Then obtain the capabilities and extract the first few + * levels in the array + */ + function getResults($map) { + $stub = $this->getMockBuilder('\OCP\IConfig')->disableOriginalConstructor()->getMock(); + $stub->method('getAppValue')->will($this->returnValueMap($map)); + $cap = new \OCA\Files_Sharing\Capabilities($stub); + $result = $this->getFilesSharingPart($cap->getCaps()->getData()); + return $result; + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_no_link_sharing() { + $map = array( + array('core', 'shareapi_allow_links', 'yes', 'no'), + ); + $result = $this->getResults($map); + $this->assertFalse($result['public']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_only_link_sharing() { + $map = array( + array('core', 'shareapi_allow_links', 'yes', 'yes'), + ); + $result = $this->getResults($map); + $this->assertInternalType('array', $result['public']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_link_password() { + $map = array( + array('core', 'shareapi_allow_links', 'yes', 'yes'), + array('core', 'shareapi_enforce_links_password', 'yes', 'yes'), + ); + $result = $this->getResults($map); + $this->assertArrayHasKey('password_enforced', $result['public']); + $this->assertTrue($result['public']['password_enforced']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_link_no_password() { + $map = array( + array('core', 'shareapi_allow_links', 'yes', 'yes'), + array('core', 'shareapi_enforce_links_password', 'yes', 'no'), + ); + $result = $this->getResults($map); + $this->assertArrayHasKey('password_enforced', $result['public']); + $this->assertFalse($result['public']['password_enforced']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_link_no_expire_date() { + $map = array( + array('core', 'shareapi_allow_links', 'yes', 'yes'), + array('core', 'shareapi_default_expire_date', 'yes', 'no'), + ); + $result = $this->getResults($map); + $this->assertArrayHasKey('expire_date', $result['public']); + $this->assertFalse($result['public']['expire_date']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_link_expire_date() { + $map = array( + array('core', 'shareapi_allow_links', 'yes', 'yes'), + array('core', 'shareapi_default_expire_date', 'yes', 'yes'), + array('core', 'shareapi_expire_after_n_days', false, 0), + array('core', 'shareapi_enforce_expire_date', 'yes', 'no'), + ); + $result = $this->getResults($map); + $this->assertArrayHasKey('expire_date', $result['public']); + $this->assertInternalType('array', $result['public']['expire_date']); + $this->assertInternalType('int', $result['public']['expire_date']['days']); + $this->assertFalse($result['public']['expire_date']['enforce']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_link_expire_date_enforced() { + $map = array( + array('core', 'shareapi_allow_links', 'yes', 'yes'), + array('core', 'shareapi_default_expire_date', 'yes', 'yes'), + array('core', 'shareapi_expire_after_n_days', false, 0), + array('core', 'shareapi_enforce_expire_date', 'yes', 'yes'), + ); + $result = $this->getResults($map); + $this->assertArrayHasKey('expire_date', $result['public']); + $this->assertInternalType('array', $result['public']['expire_date']); + $this->assertInternalType('int', $result['public']['expire_date']['days']); + $this->assertTrue($result['public']['expire_date']['enforce']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_link_send_mail() { + $map = array( + array('core', 'shareapi_allow_links', 'yes', 'yes'), + array('core', 'shareapi_allow_public_notification', 'yes', 'yes'), + ); + $result = $this->getResults($map); + $this->assertTrue($result['public']['send_mail']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_link_no_send_mail() { + $map = array( + array('core', 'shareapi_allow_links', 'yes', 'yes'), + array('core', 'shareapi_allow_public_notification', 'yes', 'no'), + ); + $result = $this->getResults($map); + $this->assertFalse($result['public']['send_mail']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_user_send_mail() { + $map = array( + array('core', 'shareapi_allow_mail_notification', 'yes', 'yes'), + ); + $result = $this->getResults($map); + $this->assertTrue($result['user']['send_mail']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_user_no_send_mail() { + $map = array( + array('core', 'shareapi_allow_mail_notification', 'yes', 'no'), + ); + $result = $this->getResults($map); + $this->assertFalse($result['user']['send_mail']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_resharing() { + $map = array( + array('core', 'shareapi_allow_resharing', 'yes', 'yes'), + ); + $result = $this->getResults($map); + $this->assertTrue($result['resharing']); + } + + /** + * @covers OCA\Files_Sharing\Capabilities::getCaps + */ + public function test_no_resharing() { + $map = array( + array('core', 'shareapi_allow_resharing', 'yes', 'no'), + ); + $result = $this->getResults($map); + $this->assertFalse($result['resharing']); + } +}