@@ -31,52 +31,52 @@ |
||
| 31 | 31 | * Scanner for SharedStorage |
| 32 | 32 | */ |
| 33 | 33 | class Scanner extends \OC\Files\Cache\Scanner { |
| 34 | - /** |
|
| 35 | - * @var \OCA\Files_Sharing\SharedStorage $storage |
|
| 36 | - */ |
|
| 37 | - protected $storage; |
|
| 34 | + /** |
|
| 35 | + * @var \OCA\Files_Sharing\SharedStorage $storage |
|
| 36 | + */ |
|
| 37 | + protected $storage; |
|
| 38 | 38 | |
| 39 | - private $sourceScanner; |
|
| 39 | + private $sourceScanner; |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Returns metadata from the shared storage, but |
|
| 43 | - * with permissions from the source storage. |
|
| 44 | - * |
|
| 45 | - * @param string $path path of the file for which to retrieve metadata |
|
| 46 | - * |
|
| 47 | - * @return array an array of metadata of the file |
|
| 48 | - */ |
|
| 49 | - public function getData($path) { |
|
| 50 | - $data = parent::getData($path); |
|
| 51 | - if ($data === null) { |
|
| 52 | - return null; |
|
| 53 | - } |
|
| 54 | - $internalPath = $this->storage->getUnjailedPath($path); |
|
| 55 | - $data['permissions'] = $this->storage->getSourceStorage()->getPermissions($internalPath); |
|
| 56 | - return $data; |
|
| 57 | - } |
|
| 41 | + /** |
|
| 42 | + * Returns metadata from the shared storage, but |
|
| 43 | + * with permissions from the source storage. |
|
| 44 | + * |
|
| 45 | + * @param string $path path of the file for which to retrieve metadata |
|
| 46 | + * |
|
| 47 | + * @return array an array of metadata of the file |
|
| 48 | + */ |
|
| 49 | + public function getData($path) { |
|
| 50 | + $data = parent::getData($path); |
|
| 51 | + if ($data === null) { |
|
| 52 | + return null; |
|
| 53 | + } |
|
| 54 | + $internalPath = $this->storage->getUnjailedPath($path); |
|
| 55 | + $data['permissions'] = $this->storage->getSourceStorage()->getPermissions($internalPath); |
|
| 56 | + return $data; |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - private function getSourceScanner() { |
|
| 60 | - if ($this->sourceScanner) { |
|
| 61 | - return $this->sourceScanner; |
|
| 62 | - } |
|
| 63 | - if ($this->storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) { |
|
| 64 | - /** @var \OC\Files\Storage\Storage $storage */ |
|
| 65 | - list($storage) = $this->storage->resolvePath(''); |
|
| 66 | - $this->sourceScanner = $storage->getScanner(); |
|
| 67 | - return $this->sourceScanner; |
|
| 68 | - } else { |
|
| 69 | - return null; |
|
| 70 | - } |
|
| 71 | - } |
|
| 59 | + private function getSourceScanner() { |
|
| 60 | + if ($this->sourceScanner) { |
|
| 61 | + return $this->sourceScanner; |
|
| 62 | + } |
|
| 63 | + if ($this->storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) { |
|
| 64 | + /** @var \OC\Files\Storage\Storage $storage */ |
|
| 65 | + list($storage) = $this->storage->resolvePath(''); |
|
| 66 | + $this->sourceScanner = $storage->getScanner(); |
|
| 67 | + return $this->sourceScanner; |
|
| 68 | + } else { |
|
| 69 | + return null; |
|
| 70 | + } |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true) { |
|
| 74 | - $sourceScanner = $this->getSourceScanner(); |
|
| 75 | - if ($sourceScanner instanceof NoopScanner) { |
|
| 76 | - return []; |
|
| 77 | - } else { |
|
| 78 | - return parent::scanFile($file, $reuseExisting, $parentId, $cacheData, $lock); |
|
| 79 | - } |
|
| 80 | - } |
|
| 73 | + public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true) { |
|
| 74 | + $sourceScanner = $this->getSourceScanner(); |
|
| 75 | + if ($sourceScanner instanceof NoopScanner) { |
|
| 76 | + return []; |
|
| 77 | + } else { |
|
| 78 | + return parent::scanFile($file, $reuseExisting, $parentId, $cacheData, $lock); |
|
| 79 | + } |
|
| 80 | + } |
|
| 81 | 81 | } |
| 82 | 82 | |
@@ -25,28 +25,28 @@ |
||
| 25 | 25 | use OCP\AppFramework\Http\JSONResponse; |
| 26 | 26 | |
| 27 | 27 | class RateLimitTestController extends Controller { |
| 28 | - /** |
|
| 29 | - * @PublicPage |
|
| 30 | - * @NoCSRFRequired |
|
| 31 | - * |
|
| 32 | - * @UserRateThrottle(limit=5, period=100) |
|
| 33 | - * @AnonRateThrottle(limit=1, period=100) |
|
| 34 | - * |
|
| 35 | - * @return JSONResponse |
|
| 36 | - */ |
|
| 37 | - public function userAndAnonProtected() { |
|
| 38 | - return new JSONResponse(); |
|
| 39 | - } |
|
| 28 | + /** |
|
| 29 | + * @PublicPage |
|
| 30 | + * @NoCSRFRequired |
|
| 31 | + * |
|
| 32 | + * @UserRateThrottle(limit=5, period=100) |
|
| 33 | + * @AnonRateThrottle(limit=1, period=100) |
|
| 34 | + * |
|
| 35 | + * @return JSONResponse |
|
| 36 | + */ |
|
| 37 | + public function userAndAnonProtected() { |
|
| 38 | + return new JSONResponse(); |
|
| 39 | + } |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @PublicPage |
|
| 43 | - * @NoCSRFRequired |
|
| 44 | - * |
|
| 45 | - * @AnonRateThrottle(limit=1, period=10) |
|
| 46 | - * |
|
| 47 | - * @return JSONResponse |
|
| 48 | - */ |
|
| 49 | - public function onlyAnonProtected() { |
|
| 50 | - return new JSONResponse(); |
|
| 51 | - } |
|
| 41 | + /** |
|
| 42 | + * @PublicPage |
|
| 43 | + * @NoCSRFRequired |
|
| 44 | + * |
|
| 45 | + * @AnonRateThrottle(limit=1, period=10) |
|
| 46 | + * |
|
| 47 | + * @return JSONResponse |
|
| 48 | + */ |
|
| 49 | + public function onlyAnonProtected() { |
|
| 50 | + return new JSONResponse(); |
|
| 51 | + } |
|
| 52 | 52 | } |
@@ -25,7 +25,7 @@ |
||
| 25 | 25 | use OCP\AppFramework\Http; |
| 26 | 26 | |
| 27 | 27 | class RateLimitExceededException extends SecurityException { |
| 28 | - public function __construct() { |
|
| 29 | - parent::__construct('Rate limit exceeded', Http::STATUS_TOO_MANY_REQUESTS); |
|
| 30 | - } |
|
| 28 | + public function __construct() { |
|
| 29 | + parent::__construct('Rate limit exceeded', Http::STATUS_TOO_MANY_REQUESTS); |
|
| 30 | + } |
|
| 31 | 31 | } |
@@ -48,87 +48,87 @@ |
||
| 48 | 48 | * @package OC\AppFramework\Middleware\Security |
| 49 | 49 | */ |
| 50 | 50 | class RateLimitingMiddleware extends Middleware { |
| 51 | - /** @var IRequest $request */ |
|
| 52 | - private $request; |
|
| 53 | - /** @var IUserSession */ |
|
| 54 | - private $userSession; |
|
| 55 | - /** @var ControllerMethodReflector */ |
|
| 56 | - private $reflector; |
|
| 57 | - /** @var Limiter */ |
|
| 58 | - private $limiter; |
|
| 51 | + /** @var IRequest $request */ |
|
| 52 | + private $request; |
|
| 53 | + /** @var IUserSession */ |
|
| 54 | + private $userSession; |
|
| 55 | + /** @var ControllerMethodReflector */ |
|
| 56 | + private $reflector; |
|
| 57 | + /** @var Limiter */ |
|
| 58 | + private $limiter; |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * @param IRequest $request |
|
| 62 | - * @param IUserSession $userSession |
|
| 63 | - * @param ControllerMethodReflector $reflector |
|
| 64 | - * @param Limiter $limiter |
|
| 65 | - */ |
|
| 66 | - public function __construct(IRequest $request, |
|
| 67 | - IUserSession $userSession, |
|
| 68 | - ControllerMethodReflector $reflector, |
|
| 69 | - Limiter $limiter) { |
|
| 70 | - $this->request = $request; |
|
| 71 | - $this->userSession = $userSession; |
|
| 72 | - $this->reflector = $reflector; |
|
| 73 | - $this->limiter = $limiter; |
|
| 74 | - } |
|
| 60 | + /** |
|
| 61 | + * @param IRequest $request |
|
| 62 | + * @param IUserSession $userSession |
|
| 63 | + * @param ControllerMethodReflector $reflector |
|
| 64 | + * @param Limiter $limiter |
|
| 65 | + */ |
|
| 66 | + public function __construct(IRequest $request, |
|
| 67 | + IUserSession $userSession, |
|
| 68 | + ControllerMethodReflector $reflector, |
|
| 69 | + Limiter $limiter) { |
|
| 70 | + $this->request = $request; |
|
| 71 | + $this->userSession = $userSession; |
|
| 72 | + $this->reflector = $reflector; |
|
| 73 | + $this->limiter = $limiter; |
|
| 74 | + } |
|
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * {@inheritDoc} |
|
| 78 | - * @throws RateLimitExceededException |
|
| 79 | - */ |
|
| 80 | - public function beforeController($controller, $methodName) { |
|
| 81 | - parent::beforeController($controller, $methodName); |
|
| 76 | + /** |
|
| 77 | + * {@inheritDoc} |
|
| 78 | + * @throws RateLimitExceededException |
|
| 79 | + */ |
|
| 80 | + public function beforeController($controller, $methodName) { |
|
| 81 | + parent::beforeController($controller, $methodName); |
|
| 82 | 82 | |
| 83 | - $anonLimit = $this->reflector->getAnnotationParameter('AnonRateThrottle', 'limit'); |
|
| 84 | - $anonPeriod = $this->reflector->getAnnotationParameter('AnonRateThrottle', 'period'); |
|
| 85 | - $userLimit = $this->reflector->getAnnotationParameter('UserRateThrottle', 'limit'); |
|
| 86 | - $userPeriod = $this->reflector->getAnnotationParameter('UserRateThrottle', 'period'); |
|
| 87 | - $rateLimitIdentifier = get_class($controller) . '::' . $methodName; |
|
| 88 | - if($userLimit !== '' && $userPeriod !== '' && $this->userSession->isLoggedIn()) { |
|
| 89 | - $this->limiter->registerUserRequest( |
|
| 90 | - $rateLimitIdentifier, |
|
| 91 | - $userLimit, |
|
| 92 | - $userPeriod, |
|
| 93 | - $this->userSession->getUser() |
|
| 94 | - ); |
|
| 95 | - } elseif ($anonLimit !== '' && $anonPeriod !== '') { |
|
| 96 | - $this->limiter->registerAnonRequest( |
|
| 97 | - $rateLimitIdentifier, |
|
| 98 | - $anonLimit, |
|
| 99 | - $anonPeriod, |
|
| 100 | - $this->request->getRemoteAddress() |
|
| 101 | - ); |
|
| 102 | - } |
|
| 103 | - } |
|
| 83 | + $anonLimit = $this->reflector->getAnnotationParameter('AnonRateThrottle', 'limit'); |
|
| 84 | + $anonPeriod = $this->reflector->getAnnotationParameter('AnonRateThrottle', 'period'); |
|
| 85 | + $userLimit = $this->reflector->getAnnotationParameter('UserRateThrottle', 'limit'); |
|
| 86 | + $userPeriod = $this->reflector->getAnnotationParameter('UserRateThrottle', 'period'); |
|
| 87 | + $rateLimitIdentifier = get_class($controller) . '::' . $methodName; |
|
| 88 | + if($userLimit !== '' && $userPeriod !== '' && $this->userSession->isLoggedIn()) { |
|
| 89 | + $this->limiter->registerUserRequest( |
|
| 90 | + $rateLimitIdentifier, |
|
| 91 | + $userLimit, |
|
| 92 | + $userPeriod, |
|
| 93 | + $this->userSession->getUser() |
|
| 94 | + ); |
|
| 95 | + } elseif ($anonLimit !== '' && $anonPeriod !== '') { |
|
| 96 | + $this->limiter->registerAnonRequest( |
|
| 97 | + $rateLimitIdentifier, |
|
| 98 | + $anonLimit, |
|
| 99 | + $anonPeriod, |
|
| 100 | + $this->request->getRemoteAddress() |
|
| 101 | + ); |
|
| 102 | + } |
|
| 103 | + } |
|
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * {@inheritDoc} |
|
| 107 | - */ |
|
| 108 | - public function afterException($controller, $methodName, \Exception $exception) { |
|
| 109 | - if($exception instanceof RateLimitExceededException) { |
|
| 110 | - if (stripos($this->request->getHeader('Accept'),'html') === false) { |
|
| 111 | - $response = new JSONResponse( |
|
| 112 | - [ |
|
| 113 | - 'message' => $exception->getMessage(), |
|
| 114 | - ], |
|
| 115 | - $exception->getCode() |
|
| 116 | - ); |
|
| 117 | - } else { |
|
| 118 | - $response = new TemplateResponse( |
|
| 119 | - 'core', |
|
| 120 | - '403', |
|
| 121 | - [ |
|
| 122 | - 'file' => $exception->getMessage() |
|
| 123 | - ], |
|
| 124 | - 'guest' |
|
| 125 | - ); |
|
| 126 | - $response->setStatus($exception->getCode()); |
|
| 127 | - } |
|
| 105 | + /** |
|
| 106 | + * {@inheritDoc} |
|
| 107 | + */ |
|
| 108 | + public function afterException($controller, $methodName, \Exception $exception) { |
|
| 109 | + if($exception instanceof RateLimitExceededException) { |
|
| 110 | + if (stripos($this->request->getHeader('Accept'),'html') === false) { |
|
| 111 | + $response = new JSONResponse( |
|
| 112 | + [ |
|
| 113 | + 'message' => $exception->getMessage(), |
|
| 114 | + ], |
|
| 115 | + $exception->getCode() |
|
| 116 | + ); |
|
| 117 | + } else { |
|
| 118 | + $response = new TemplateResponse( |
|
| 119 | + 'core', |
|
| 120 | + '403', |
|
| 121 | + [ |
|
| 122 | + 'file' => $exception->getMessage() |
|
| 123 | + ], |
|
| 124 | + 'guest' |
|
| 125 | + ); |
|
| 126 | + $response->setStatus($exception->getCode()); |
|
| 127 | + } |
|
| 128 | 128 | |
| 129 | - return $response; |
|
| 130 | - } |
|
| 129 | + return $response; |
|
| 130 | + } |
|
| 131 | 131 | |
| 132 | - throw $exception; |
|
| 133 | - } |
|
| 132 | + throw $exception; |
|
| 133 | + } |
|
| 134 | 134 | } |
@@ -26,71 +26,71 @@ |
||
| 26 | 26 | |
| 27 | 27 | class Setting implements ISetting { |
| 28 | 28 | |
| 29 | - /** @var IL10N */ |
|
| 30 | - protected $l; |
|
| 29 | + /** @var IL10N */ |
|
| 30 | + protected $l; |
|
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @param IL10N $l10n |
|
| 34 | - */ |
|
| 35 | - public function __construct(IL10N $l10n) { |
|
| 36 | - $this->l = $l10n; |
|
| 37 | - } |
|
| 32 | + /** |
|
| 33 | + * @param IL10N $l10n |
|
| 34 | + */ |
|
| 35 | + public function __construct(IL10N $l10n) { |
|
| 36 | + $this->l = $l10n; |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @return string Lowercase a-z and underscore only identifier |
|
| 41 | - * @since 11.0.0 |
|
| 42 | - */ |
|
| 43 | - public function getIdentifier() { |
|
| 44 | - return 'personal_settings'; |
|
| 45 | - } |
|
| 39 | + /** |
|
| 40 | + * @return string Lowercase a-z and underscore only identifier |
|
| 41 | + * @since 11.0.0 |
|
| 42 | + */ |
|
| 43 | + public function getIdentifier() { |
|
| 44 | + return 'personal_settings'; |
|
| 45 | + } |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @return string A translated string |
|
| 49 | - * @since 11.0.0 |
|
| 50 | - */ |
|
| 51 | - public function getName() { |
|
| 52 | - return $this->l->t('Your <strong>password</strong> or <strong>email</strong> was modified'); |
|
| 53 | - } |
|
| 47 | + /** |
|
| 48 | + * @return string A translated string |
|
| 49 | + * @since 11.0.0 |
|
| 50 | + */ |
|
| 51 | + public function getName() { |
|
| 52 | + return $this->l->t('Your <strong>password</strong> or <strong>email</strong> was modified'); |
|
| 53 | + } |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @return int whether the filter should be rather on the top or bottom of |
|
| 57 | - * the admin section. The filters are arranged in ascending order of the |
|
| 58 | - * priority values. It is required to return a value between 0 and 100. |
|
| 59 | - * @since 11.0.0 |
|
| 60 | - */ |
|
| 61 | - public function getPriority() { |
|
| 62 | - return 0; |
|
| 63 | - } |
|
| 55 | + /** |
|
| 56 | + * @return int whether the filter should be rather on the top or bottom of |
|
| 57 | + * the admin section. The filters are arranged in ascending order of the |
|
| 58 | + * priority values. It is required to return a value between 0 and 100. |
|
| 59 | + * @since 11.0.0 |
|
| 60 | + */ |
|
| 61 | + public function getPriority() { |
|
| 62 | + return 0; |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * @return bool True when the option can be changed for the stream |
|
| 67 | - * @since 11.0.0 |
|
| 68 | - */ |
|
| 69 | - public function canChangeStream() { |
|
| 70 | - return false; |
|
| 71 | - } |
|
| 65 | + /** |
|
| 66 | + * @return bool True when the option can be changed for the stream |
|
| 67 | + * @since 11.0.0 |
|
| 68 | + */ |
|
| 69 | + public function canChangeStream() { |
|
| 70 | + return false; |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * @return bool True when the option can be changed for the stream |
|
| 75 | - * @since 11.0.0 |
|
| 76 | - */ |
|
| 77 | - public function isDefaultEnabledStream() { |
|
| 78 | - return true; |
|
| 79 | - } |
|
| 73 | + /** |
|
| 74 | + * @return bool True when the option can be changed for the stream |
|
| 75 | + * @since 11.0.0 |
|
| 76 | + */ |
|
| 77 | + public function isDefaultEnabledStream() { |
|
| 78 | + return true; |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @return bool True when the option can be changed for the mail |
|
| 83 | - * @since 11.0.0 |
|
| 84 | - */ |
|
| 85 | - public function canChangeMail() { |
|
| 86 | - return false; |
|
| 87 | - } |
|
| 81 | + /** |
|
| 82 | + * @return bool True when the option can be changed for the mail |
|
| 83 | + * @since 11.0.0 |
|
| 84 | + */ |
|
| 85 | + public function canChangeMail() { |
|
| 86 | + return false; |
|
| 87 | + } |
|
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * @return bool True when the option can be changed for the stream |
|
| 91 | - * @since 11.0.0 |
|
| 92 | - */ |
|
| 93 | - public function isDefaultEnabledMail() { |
|
| 94 | - return false; |
|
| 95 | - } |
|
| 89 | + /** |
|
| 90 | + * @return bool True when the option can be changed for the stream |
|
| 91 | + * @since 11.0.0 |
|
| 92 | + */ |
|
| 93 | + public function isDefaultEnabledMail() { |
|
| 94 | + return false; |
|
| 95 | + } |
|
| 96 | 96 | } |
@@ -43,185 +43,185 @@ |
||
| 43 | 43 | * User storages controller |
| 44 | 44 | */ |
| 45 | 45 | class UserStoragesController extends StoragesController { |
| 46 | - /** |
|
| 47 | - * @var IUserSession |
|
| 48 | - */ |
|
| 49 | - private $userSession; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * Creates a new user storages controller. |
|
| 53 | - * |
|
| 54 | - * @param string $AppName application name |
|
| 55 | - * @param IRequest $request request object |
|
| 56 | - * @param IL10N $l10n l10n service |
|
| 57 | - * @param UserStoragesService $userStoragesService storage service |
|
| 58 | - * @param IUserSession $userSession |
|
| 59 | - * @param ILogger $logger |
|
| 60 | - */ |
|
| 61 | - public function __construct( |
|
| 62 | - $AppName, |
|
| 63 | - IRequest $request, |
|
| 64 | - IL10N $l10n, |
|
| 65 | - UserStoragesService $userStoragesService, |
|
| 66 | - IUserSession $userSession, |
|
| 67 | - ILogger $logger |
|
| 68 | - ) { |
|
| 69 | - parent::__construct( |
|
| 70 | - $AppName, |
|
| 71 | - $request, |
|
| 72 | - $l10n, |
|
| 73 | - $userStoragesService, |
|
| 74 | - $logger |
|
| 75 | - ); |
|
| 76 | - $this->userSession = $userSession; |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - protected function manipulateStorageConfig(StorageConfig $storage) { |
|
| 80 | - /** @var AuthMechanism */ |
|
| 81 | - $authMechanism = $storage->getAuthMechanism(); |
|
| 82 | - $authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 83 | - /** @var Backend */ |
|
| 84 | - $backend = $storage->getBackend(); |
|
| 85 | - $backend->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - /** |
|
| 89 | - * Get all storage entries |
|
| 90 | - * |
|
| 91 | - * @NoAdminRequired |
|
| 92 | - * |
|
| 93 | - * @return DataResponse |
|
| 94 | - */ |
|
| 95 | - public function index() { |
|
| 96 | - return parent::index(); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * Return storage |
|
| 101 | - * |
|
| 102 | - * @NoAdminRequired |
|
| 103 | - * |
|
| 104 | - * {@inheritdoc} |
|
| 105 | - */ |
|
| 106 | - public function show($id, $testOnly = true) { |
|
| 107 | - return parent::show($id, $testOnly); |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Create an external storage entry. |
|
| 112 | - * |
|
| 113 | - * @param string $mountPoint storage mount point |
|
| 114 | - * @param string $backend backend identifier |
|
| 115 | - * @param string $authMechanism authentication mechanism identifier |
|
| 116 | - * @param array $backendOptions backend-specific options |
|
| 117 | - * @param array $mountOptions backend-specific mount options |
|
| 118 | - * |
|
| 119 | - * @return DataResponse |
|
| 120 | - * |
|
| 121 | - * @NoAdminRequired |
|
| 122 | - */ |
|
| 123 | - public function create( |
|
| 124 | - $mountPoint, |
|
| 125 | - $backend, |
|
| 126 | - $authMechanism, |
|
| 127 | - $backendOptions, |
|
| 128 | - $mountOptions |
|
| 129 | - ) { |
|
| 130 | - $newStorage = $this->createStorage( |
|
| 131 | - $mountPoint, |
|
| 132 | - $backend, |
|
| 133 | - $authMechanism, |
|
| 134 | - $backendOptions, |
|
| 135 | - $mountOptions |
|
| 136 | - ); |
|
| 137 | - if ($newStorage instanceOf DataResponse) { |
|
| 138 | - return $newStorage; |
|
| 139 | - } |
|
| 140 | - |
|
| 141 | - $response = $this->validate($newStorage); |
|
| 142 | - if (!empty($response)) { |
|
| 143 | - return $response; |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - $newStorage = $this->service->addStorage($newStorage); |
|
| 147 | - $this->updateStorageStatus($newStorage); |
|
| 148 | - |
|
| 149 | - return new DataResponse( |
|
| 150 | - $newStorage, |
|
| 151 | - Http::STATUS_CREATED |
|
| 152 | - ); |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * Update an external storage entry. |
|
| 157 | - * |
|
| 158 | - * @param int $id storage id |
|
| 159 | - * @param string $mountPoint storage mount point |
|
| 160 | - * @param string $backend backend identifier |
|
| 161 | - * @param string $authMechanism authentication mechanism identifier |
|
| 162 | - * @param array $backendOptions backend-specific options |
|
| 163 | - * @param array $mountOptions backend-specific mount options |
|
| 164 | - * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 165 | - * |
|
| 166 | - * @return DataResponse |
|
| 167 | - * |
|
| 168 | - * @NoAdminRequired |
|
| 169 | - */ |
|
| 170 | - public function update( |
|
| 171 | - $id, |
|
| 172 | - $mountPoint, |
|
| 173 | - $backend, |
|
| 174 | - $authMechanism, |
|
| 175 | - $backendOptions, |
|
| 176 | - $mountOptions, |
|
| 177 | - $testOnly = true |
|
| 178 | - ) { |
|
| 179 | - $storage = $this->createStorage( |
|
| 180 | - $mountPoint, |
|
| 181 | - $backend, |
|
| 182 | - $authMechanism, |
|
| 183 | - $backendOptions, |
|
| 184 | - $mountOptions |
|
| 185 | - ); |
|
| 186 | - if ($storage instanceOf DataResponse) { |
|
| 187 | - return $storage; |
|
| 188 | - } |
|
| 189 | - $storage->setId($id); |
|
| 190 | - |
|
| 191 | - $response = $this->validate($storage); |
|
| 192 | - if (!empty($response)) { |
|
| 193 | - return $response; |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - try { |
|
| 197 | - $storage = $this->service->updateStorage($storage); |
|
| 198 | - } catch (NotFoundException $e) { |
|
| 199 | - return new DataResponse( |
|
| 200 | - [ |
|
| 201 | - 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 202 | - ], |
|
| 203 | - Http::STATUS_NOT_FOUND |
|
| 204 | - ); |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - $this->updateStorageStatus($storage, $testOnly); |
|
| 208 | - |
|
| 209 | - return new DataResponse( |
|
| 210 | - $storage, |
|
| 211 | - Http::STATUS_OK |
|
| 212 | - ); |
|
| 213 | - |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - /** |
|
| 217 | - * Delete storage |
|
| 218 | - * |
|
| 219 | - * @NoAdminRequired |
|
| 220 | - * |
|
| 221 | - * {@inheritdoc} |
|
| 222 | - */ |
|
| 223 | - public function destroy($id) { |
|
| 224 | - return parent::destroy($id); |
|
| 225 | - } |
|
| 46 | + /** |
|
| 47 | + * @var IUserSession |
|
| 48 | + */ |
|
| 49 | + private $userSession; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * Creates a new user storages controller. |
|
| 53 | + * |
|
| 54 | + * @param string $AppName application name |
|
| 55 | + * @param IRequest $request request object |
|
| 56 | + * @param IL10N $l10n l10n service |
|
| 57 | + * @param UserStoragesService $userStoragesService storage service |
|
| 58 | + * @param IUserSession $userSession |
|
| 59 | + * @param ILogger $logger |
|
| 60 | + */ |
|
| 61 | + public function __construct( |
|
| 62 | + $AppName, |
|
| 63 | + IRequest $request, |
|
| 64 | + IL10N $l10n, |
|
| 65 | + UserStoragesService $userStoragesService, |
|
| 66 | + IUserSession $userSession, |
|
| 67 | + ILogger $logger |
|
| 68 | + ) { |
|
| 69 | + parent::__construct( |
|
| 70 | + $AppName, |
|
| 71 | + $request, |
|
| 72 | + $l10n, |
|
| 73 | + $userStoragesService, |
|
| 74 | + $logger |
|
| 75 | + ); |
|
| 76 | + $this->userSession = $userSession; |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + protected function manipulateStorageConfig(StorageConfig $storage) { |
|
| 80 | + /** @var AuthMechanism */ |
|
| 81 | + $authMechanism = $storage->getAuthMechanism(); |
|
| 82 | + $authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 83 | + /** @var Backend */ |
|
| 84 | + $backend = $storage->getBackend(); |
|
| 85 | + $backend->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + /** |
|
| 89 | + * Get all storage entries |
|
| 90 | + * |
|
| 91 | + * @NoAdminRequired |
|
| 92 | + * |
|
| 93 | + * @return DataResponse |
|
| 94 | + */ |
|
| 95 | + public function index() { |
|
| 96 | + return parent::index(); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * Return storage |
|
| 101 | + * |
|
| 102 | + * @NoAdminRequired |
|
| 103 | + * |
|
| 104 | + * {@inheritdoc} |
|
| 105 | + */ |
|
| 106 | + public function show($id, $testOnly = true) { |
|
| 107 | + return parent::show($id, $testOnly); |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Create an external storage entry. |
|
| 112 | + * |
|
| 113 | + * @param string $mountPoint storage mount point |
|
| 114 | + * @param string $backend backend identifier |
|
| 115 | + * @param string $authMechanism authentication mechanism identifier |
|
| 116 | + * @param array $backendOptions backend-specific options |
|
| 117 | + * @param array $mountOptions backend-specific mount options |
|
| 118 | + * |
|
| 119 | + * @return DataResponse |
|
| 120 | + * |
|
| 121 | + * @NoAdminRequired |
|
| 122 | + */ |
|
| 123 | + public function create( |
|
| 124 | + $mountPoint, |
|
| 125 | + $backend, |
|
| 126 | + $authMechanism, |
|
| 127 | + $backendOptions, |
|
| 128 | + $mountOptions |
|
| 129 | + ) { |
|
| 130 | + $newStorage = $this->createStorage( |
|
| 131 | + $mountPoint, |
|
| 132 | + $backend, |
|
| 133 | + $authMechanism, |
|
| 134 | + $backendOptions, |
|
| 135 | + $mountOptions |
|
| 136 | + ); |
|
| 137 | + if ($newStorage instanceOf DataResponse) { |
|
| 138 | + return $newStorage; |
|
| 139 | + } |
|
| 140 | + |
|
| 141 | + $response = $this->validate($newStorage); |
|
| 142 | + if (!empty($response)) { |
|
| 143 | + return $response; |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + $newStorage = $this->service->addStorage($newStorage); |
|
| 147 | + $this->updateStorageStatus($newStorage); |
|
| 148 | + |
|
| 149 | + return new DataResponse( |
|
| 150 | + $newStorage, |
|
| 151 | + Http::STATUS_CREATED |
|
| 152 | + ); |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * Update an external storage entry. |
|
| 157 | + * |
|
| 158 | + * @param int $id storage id |
|
| 159 | + * @param string $mountPoint storage mount point |
|
| 160 | + * @param string $backend backend identifier |
|
| 161 | + * @param string $authMechanism authentication mechanism identifier |
|
| 162 | + * @param array $backendOptions backend-specific options |
|
| 163 | + * @param array $mountOptions backend-specific mount options |
|
| 164 | + * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 165 | + * |
|
| 166 | + * @return DataResponse |
|
| 167 | + * |
|
| 168 | + * @NoAdminRequired |
|
| 169 | + */ |
|
| 170 | + public function update( |
|
| 171 | + $id, |
|
| 172 | + $mountPoint, |
|
| 173 | + $backend, |
|
| 174 | + $authMechanism, |
|
| 175 | + $backendOptions, |
|
| 176 | + $mountOptions, |
|
| 177 | + $testOnly = true |
|
| 178 | + ) { |
|
| 179 | + $storage = $this->createStorage( |
|
| 180 | + $mountPoint, |
|
| 181 | + $backend, |
|
| 182 | + $authMechanism, |
|
| 183 | + $backendOptions, |
|
| 184 | + $mountOptions |
|
| 185 | + ); |
|
| 186 | + if ($storage instanceOf DataResponse) { |
|
| 187 | + return $storage; |
|
| 188 | + } |
|
| 189 | + $storage->setId($id); |
|
| 190 | + |
|
| 191 | + $response = $this->validate($storage); |
|
| 192 | + if (!empty($response)) { |
|
| 193 | + return $response; |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + try { |
|
| 197 | + $storage = $this->service->updateStorage($storage); |
|
| 198 | + } catch (NotFoundException $e) { |
|
| 199 | + return new DataResponse( |
|
| 200 | + [ |
|
| 201 | + 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 202 | + ], |
|
| 203 | + Http::STATUS_NOT_FOUND |
|
| 204 | + ); |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + $this->updateStorageStatus($storage, $testOnly); |
|
| 208 | + |
|
| 209 | + return new DataResponse( |
|
| 210 | + $storage, |
|
| 211 | + Http::STATUS_OK |
|
| 212 | + ); |
|
| 213 | + |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + /** |
|
| 217 | + * Delete storage |
|
| 218 | + * |
|
| 219 | + * @NoAdminRequired |
|
| 220 | + * |
|
| 221 | + * {@inheritdoc} |
|
| 222 | + */ |
|
| 223 | + public function destroy($id) { |
|
| 224 | + return parent::destroy($id); |
|
| 225 | + } |
|
| 226 | 226 | |
| 227 | 227 | } |
@@ -39,151 +39,151 @@ |
||
| 39 | 39 | * Global storages controller |
| 40 | 40 | */ |
| 41 | 41 | class GlobalStoragesController extends StoragesController { |
| 42 | - /** |
|
| 43 | - * Creates a new global storages controller. |
|
| 44 | - * |
|
| 45 | - * @param string $AppName application name |
|
| 46 | - * @param IRequest $request request object |
|
| 47 | - * @param IL10N $l10n l10n service |
|
| 48 | - * @param GlobalStoragesService $globalStoragesService storage service |
|
| 49 | - * @param ILogger $logger |
|
| 50 | - */ |
|
| 51 | - public function __construct( |
|
| 52 | - $AppName, |
|
| 53 | - IRequest $request, |
|
| 54 | - IL10N $l10n, |
|
| 55 | - GlobalStoragesService $globalStoragesService, |
|
| 56 | - ILogger $logger |
|
| 57 | - ) { |
|
| 58 | - parent::__construct( |
|
| 59 | - $AppName, |
|
| 60 | - $request, |
|
| 61 | - $l10n, |
|
| 62 | - $globalStoragesService, |
|
| 63 | - $logger |
|
| 64 | - ); |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * Create an external storage entry. |
|
| 69 | - * |
|
| 70 | - * @param string $mountPoint storage mount point |
|
| 71 | - * @param string $backend backend identifier |
|
| 72 | - * @param string $authMechanism authentication mechanism identifier |
|
| 73 | - * @param array $backendOptions backend-specific options |
|
| 74 | - * @param array $mountOptions mount-specific options |
|
| 75 | - * @param array $applicableUsers users for which to mount the storage |
|
| 76 | - * @param array $applicableGroups groups for which to mount the storage |
|
| 77 | - * @param int $priority priority |
|
| 78 | - * |
|
| 79 | - * @return DataResponse |
|
| 80 | - */ |
|
| 81 | - public function create( |
|
| 82 | - $mountPoint, |
|
| 83 | - $backend, |
|
| 84 | - $authMechanism, |
|
| 85 | - $backendOptions, |
|
| 86 | - $mountOptions, |
|
| 87 | - $applicableUsers, |
|
| 88 | - $applicableGroups, |
|
| 89 | - $priority |
|
| 90 | - ) { |
|
| 91 | - $newStorage = $this->createStorage( |
|
| 92 | - $mountPoint, |
|
| 93 | - $backend, |
|
| 94 | - $authMechanism, |
|
| 95 | - $backendOptions, |
|
| 96 | - $mountOptions, |
|
| 97 | - $applicableUsers, |
|
| 98 | - $applicableGroups, |
|
| 99 | - $priority |
|
| 100 | - ); |
|
| 101 | - if ($newStorage instanceof DataResponse) { |
|
| 102 | - return $newStorage; |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - $response = $this->validate($newStorage); |
|
| 106 | - if (!empty($response)) { |
|
| 107 | - return $response; |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - $newStorage = $this->service->addStorage($newStorage); |
|
| 111 | - |
|
| 112 | - $this->updateStorageStatus($newStorage); |
|
| 113 | - |
|
| 114 | - return new DataResponse( |
|
| 115 | - $newStorage, |
|
| 116 | - Http::STATUS_CREATED |
|
| 117 | - ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * Update an external storage entry. |
|
| 122 | - * |
|
| 123 | - * @param int $id storage id |
|
| 124 | - * @param string $mountPoint storage mount point |
|
| 125 | - * @param string $backend backend identifier |
|
| 126 | - * @param string $authMechanism authentication mechansim identifier |
|
| 127 | - * @param array $backendOptions backend-specific options |
|
| 128 | - * @param array $mountOptions mount-specific options |
|
| 129 | - * @param array $applicableUsers users for which to mount the storage |
|
| 130 | - * @param array $applicableGroups groups for which to mount the storage |
|
| 131 | - * @param int $priority priority |
|
| 132 | - * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 133 | - * |
|
| 134 | - * @return DataResponse |
|
| 135 | - */ |
|
| 136 | - public function update( |
|
| 137 | - $id, |
|
| 138 | - $mountPoint, |
|
| 139 | - $backend, |
|
| 140 | - $authMechanism, |
|
| 141 | - $backendOptions, |
|
| 142 | - $mountOptions, |
|
| 143 | - $applicableUsers, |
|
| 144 | - $applicableGroups, |
|
| 145 | - $priority, |
|
| 146 | - $testOnly = true |
|
| 147 | - ) { |
|
| 148 | - $storage = $this->createStorage( |
|
| 149 | - $mountPoint, |
|
| 150 | - $backend, |
|
| 151 | - $authMechanism, |
|
| 152 | - $backendOptions, |
|
| 153 | - $mountOptions, |
|
| 154 | - $applicableUsers, |
|
| 155 | - $applicableGroups, |
|
| 156 | - $priority |
|
| 157 | - ); |
|
| 158 | - if ($storage instanceof DataResponse) { |
|
| 159 | - return $storage; |
|
| 160 | - } |
|
| 161 | - $storage->setId($id); |
|
| 162 | - |
|
| 163 | - $response = $this->validate($storage); |
|
| 164 | - if (!empty($response)) { |
|
| 165 | - return $response; |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - try { |
|
| 169 | - $storage = $this->service->updateStorage($storage); |
|
| 170 | - } catch (NotFoundException $e) { |
|
| 171 | - return new DataResponse( |
|
| 172 | - [ |
|
| 173 | - 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 174 | - ], |
|
| 175 | - Http::STATUS_NOT_FOUND |
|
| 176 | - ); |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - $this->updateStorageStatus($storage, $testOnly); |
|
| 180 | - |
|
| 181 | - return new DataResponse( |
|
| 182 | - $storage, |
|
| 183 | - Http::STATUS_OK |
|
| 184 | - ); |
|
| 185 | - |
|
| 186 | - } |
|
| 42 | + /** |
|
| 43 | + * Creates a new global storages controller. |
|
| 44 | + * |
|
| 45 | + * @param string $AppName application name |
|
| 46 | + * @param IRequest $request request object |
|
| 47 | + * @param IL10N $l10n l10n service |
|
| 48 | + * @param GlobalStoragesService $globalStoragesService storage service |
|
| 49 | + * @param ILogger $logger |
|
| 50 | + */ |
|
| 51 | + public function __construct( |
|
| 52 | + $AppName, |
|
| 53 | + IRequest $request, |
|
| 54 | + IL10N $l10n, |
|
| 55 | + GlobalStoragesService $globalStoragesService, |
|
| 56 | + ILogger $logger |
|
| 57 | + ) { |
|
| 58 | + parent::__construct( |
|
| 59 | + $AppName, |
|
| 60 | + $request, |
|
| 61 | + $l10n, |
|
| 62 | + $globalStoragesService, |
|
| 63 | + $logger |
|
| 64 | + ); |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * Create an external storage entry. |
|
| 69 | + * |
|
| 70 | + * @param string $mountPoint storage mount point |
|
| 71 | + * @param string $backend backend identifier |
|
| 72 | + * @param string $authMechanism authentication mechanism identifier |
|
| 73 | + * @param array $backendOptions backend-specific options |
|
| 74 | + * @param array $mountOptions mount-specific options |
|
| 75 | + * @param array $applicableUsers users for which to mount the storage |
|
| 76 | + * @param array $applicableGroups groups for which to mount the storage |
|
| 77 | + * @param int $priority priority |
|
| 78 | + * |
|
| 79 | + * @return DataResponse |
|
| 80 | + */ |
|
| 81 | + public function create( |
|
| 82 | + $mountPoint, |
|
| 83 | + $backend, |
|
| 84 | + $authMechanism, |
|
| 85 | + $backendOptions, |
|
| 86 | + $mountOptions, |
|
| 87 | + $applicableUsers, |
|
| 88 | + $applicableGroups, |
|
| 89 | + $priority |
|
| 90 | + ) { |
|
| 91 | + $newStorage = $this->createStorage( |
|
| 92 | + $mountPoint, |
|
| 93 | + $backend, |
|
| 94 | + $authMechanism, |
|
| 95 | + $backendOptions, |
|
| 96 | + $mountOptions, |
|
| 97 | + $applicableUsers, |
|
| 98 | + $applicableGroups, |
|
| 99 | + $priority |
|
| 100 | + ); |
|
| 101 | + if ($newStorage instanceof DataResponse) { |
|
| 102 | + return $newStorage; |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + $response = $this->validate($newStorage); |
|
| 106 | + if (!empty($response)) { |
|
| 107 | + return $response; |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + $newStorage = $this->service->addStorage($newStorage); |
|
| 111 | + |
|
| 112 | + $this->updateStorageStatus($newStorage); |
|
| 113 | + |
|
| 114 | + return new DataResponse( |
|
| 115 | + $newStorage, |
|
| 116 | + Http::STATUS_CREATED |
|
| 117 | + ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * Update an external storage entry. |
|
| 122 | + * |
|
| 123 | + * @param int $id storage id |
|
| 124 | + * @param string $mountPoint storage mount point |
|
| 125 | + * @param string $backend backend identifier |
|
| 126 | + * @param string $authMechanism authentication mechansim identifier |
|
| 127 | + * @param array $backendOptions backend-specific options |
|
| 128 | + * @param array $mountOptions mount-specific options |
|
| 129 | + * @param array $applicableUsers users for which to mount the storage |
|
| 130 | + * @param array $applicableGroups groups for which to mount the storage |
|
| 131 | + * @param int $priority priority |
|
| 132 | + * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 133 | + * |
|
| 134 | + * @return DataResponse |
|
| 135 | + */ |
|
| 136 | + public function update( |
|
| 137 | + $id, |
|
| 138 | + $mountPoint, |
|
| 139 | + $backend, |
|
| 140 | + $authMechanism, |
|
| 141 | + $backendOptions, |
|
| 142 | + $mountOptions, |
|
| 143 | + $applicableUsers, |
|
| 144 | + $applicableGroups, |
|
| 145 | + $priority, |
|
| 146 | + $testOnly = true |
|
| 147 | + ) { |
|
| 148 | + $storage = $this->createStorage( |
|
| 149 | + $mountPoint, |
|
| 150 | + $backend, |
|
| 151 | + $authMechanism, |
|
| 152 | + $backendOptions, |
|
| 153 | + $mountOptions, |
|
| 154 | + $applicableUsers, |
|
| 155 | + $applicableGroups, |
|
| 156 | + $priority |
|
| 157 | + ); |
|
| 158 | + if ($storage instanceof DataResponse) { |
|
| 159 | + return $storage; |
|
| 160 | + } |
|
| 161 | + $storage->setId($id); |
|
| 162 | + |
|
| 163 | + $response = $this->validate($storage); |
|
| 164 | + if (!empty($response)) { |
|
| 165 | + return $response; |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + try { |
|
| 169 | + $storage = $this->service->updateStorage($storage); |
|
| 170 | + } catch (NotFoundException $e) { |
|
| 171 | + return new DataResponse( |
|
| 172 | + [ |
|
| 173 | + 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 174 | + ], |
|
| 175 | + Http::STATUS_NOT_FOUND |
|
| 176 | + ); |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + $this->updateStorageStatus($storage, $testOnly); |
|
| 180 | + |
|
| 181 | + return new DataResponse( |
|
| 182 | + $storage, |
|
| 183 | + Http::STATUS_OK |
|
| 184 | + ); |
|
| 185 | + |
|
| 186 | + } |
|
| 187 | 187 | |
| 188 | 188 | |
| 189 | 189 | } |
@@ -47,298 +47,298 @@ |
||
| 47 | 47 | */ |
| 48 | 48 | abstract class StoragesController extends Controller { |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * L10N service |
|
| 52 | - * |
|
| 53 | - * @var IL10N |
|
| 54 | - */ |
|
| 55 | - protected $l10n; |
|
| 50 | + /** |
|
| 51 | + * L10N service |
|
| 52 | + * |
|
| 53 | + * @var IL10N |
|
| 54 | + */ |
|
| 55 | + protected $l10n; |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Storages service |
|
| 59 | - * |
|
| 60 | - * @var StoragesService |
|
| 61 | - */ |
|
| 62 | - protected $service; |
|
| 57 | + /** |
|
| 58 | + * Storages service |
|
| 59 | + * |
|
| 60 | + * @var StoragesService |
|
| 61 | + */ |
|
| 62 | + protected $service; |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @var ILogger |
|
| 66 | - */ |
|
| 67 | - protected $logger; |
|
| 64 | + /** |
|
| 65 | + * @var ILogger |
|
| 66 | + */ |
|
| 67 | + protected $logger; |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Creates a new storages controller. |
|
| 71 | - * |
|
| 72 | - * @param string $AppName application name |
|
| 73 | - * @param IRequest $request request object |
|
| 74 | - * @param IL10N $l10n l10n service |
|
| 75 | - * @param StoragesService $storagesService storage service |
|
| 76 | - * @param ILogger $logger |
|
| 77 | - */ |
|
| 78 | - public function __construct( |
|
| 79 | - $AppName, |
|
| 80 | - IRequest $request, |
|
| 81 | - IL10N $l10n, |
|
| 82 | - StoragesService $storagesService, |
|
| 83 | - ILogger $logger |
|
| 84 | - ) { |
|
| 85 | - parent::__construct($AppName, $request); |
|
| 86 | - $this->l10n = $l10n; |
|
| 87 | - $this->service = $storagesService; |
|
| 88 | - $this->logger = $logger; |
|
| 89 | - } |
|
| 69 | + /** |
|
| 70 | + * Creates a new storages controller. |
|
| 71 | + * |
|
| 72 | + * @param string $AppName application name |
|
| 73 | + * @param IRequest $request request object |
|
| 74 | + * @param IL10N $l10n l10n service |
|
| 75 | + * @param StoragesService $storagesService storage service |
|
| 76 | + * @param ILogger $logger |
|
| 77 | + */ |
|
| 78 | + public function __construct( |
|
| 79 | + $AppName, |
|
| 80 | + IRequest $request, |
|
| 81 | + IL10N $l10n, |
|
| 82 | + StoragesService $storagesService, |
|
| 83 | + ILogger $logger |
|
| 84 | + ) { |
|
| 85 | + parent::__construct($AppName, $request); |
|
| 86 | + $this->l10n = $l10n; |
|
| 87 | + $this->service = $storagesService; |
|
| 88 | + $this->logger = $logger; |
|
| 89 | + } |
|
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Create a storage from its parameters |
|
| 93 | - * |
|
| 94 | - * @param string $mountPoint storage mount point |
|
| 95 | - * @param string $backend backend identifier |
|
| 96 | - * @param string $authMechanism authentication mechanism identifier |
|
| 97 | - * @param array $backendOptions backend-specific options |
|
| 98 | - * @param array|null $mountOptions mount-specific options |
|
| 99 | - * @param array|null $applicableUsers users for which to mount the storage |
|
| 100 | - * @param array|null $applicableGroups groups for which to mount the storage |
|
| 101 | - * @param int|null $priority priority |
|
| 102 | - * |
|
| 103 | - * @return StorageConfig|DataResponse |
|
| 104 | - */ |
|
| 105 | - protected function createStorage( |
|
| 106 | - $mountPoint, |
|
| 107 | - $backend, |
|
| 108 | - $authMechanism, |
|
| 109 | - $backendOptions, |
|
| 110 | - $mountOptions = null, |
|
| 111 | - $applicableUsers = null, |
|
| 112 | - $applicableGroups = null, |
|
| 113 | - $priority = null |
|
| 114 | - ) { |
|
| 115 | - try { |
|
| 116 | - return $this->service->createStorage( |
|
| 117 | - $mountPoint, |
|
| 118 | - $backend, |
|
| 119 | - $authMechanism, |
|
| 120 | - $backendOptions, |
|
| 121 | - $mountOptions, |
|
| 122 | - $applicableUsers, |
|
| 123 | - $applicableGroups, |
|
| 124 | - $priority |
|
| 125 | - ); |
|
| 126 | - } catch (\InvalidArgumentException $e) { |
|
| 127 | - $this->logger->logException($e); |
|
| 128 | - return new DataResponse( |
|
| 129 | - [ |
|
| 130 | - 'message' => (string)$this->l10n->t('Invalid backend or authentication mechanism class') |
|
| 131 | - ], |
|
| 132 | - Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 133 | - ); |
|
| 134 | - } |
|
| 135 | - } |
|
| 91 | + /** |
|
| 92 | + * Create a storage from its parameters |
|
| 93 | + * |
|
| 94 | + * @param string $mountPoint storage mount point |
|
| 95 | + * @param string $backend backend identifier |
|
| 96 | + * @param string $authMechanism authentication mechanism identifier |
|
| 97 | + * @param array $backendOptions backend-specific options |
|
| 98 | + * @param array|null $mountOptions mount-specific options |
|
| 99 | + * @param array|null $applicableUsers users for which to mount the storage |
|
| 100 | + * @param array|null $applicableGroups groups for which to mount the storage |
|
| 101 | + * @param int|null $priority priority |
|
| 102 | + * |
|
| 103 | + * @return StorageConfig|DataResponse |
|
| 104 | + */ |
|
| 105 | + protected function createStorage( |
|
| 106 | + $mountPoint, |
|
| 107 | + $backend, |
|
| 108 | + $authMechanism, |
|
| 109 | + $backendOptions, |
|
| 110 | + $mountOptions = null, |
|
| 111 | + $applicableUsers = null, |
|
| 112 | + $applicableGroups = null, |
|
| 113 | + $priority = null |
|
| 114 | + ) { |
|
| 115 | + try { |
|
| 116 | + return $this->service->createStorage( |
|
| 117 | + $mountPoint, |
|
| 118 | + $backend, |
|
| 119 | + $authMechanism, |
|
| 120 | + $backendOptions, |
|
| 121 | + $mountOptions, |
|
| 122 | + $applicableUsers, |
|
| 123 | + $applicableGroups, |
|
| 124 | + $priority |
|
| 125 | + ); |
|
| 126 | + } catch (\InvalidArgumentException $e) { |
|
| 127 | + $this->logger->logException($e); |
|
| 128 | + return new DataResponse( |
|
| 129 | + [ |
|
| 130 | + 'message' => (string)$this->l10n->t('Invalid backend or authentication mechanism class') |
|
| 131 | + ], |
|
| 132 | + Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 133 | + ); |
|
| 134 | + } |
|
| 135 | + } |
|
| 136 | 136 | |
| 137 | - /** |
|
| 138 | - * Validate storage config |
|
| 139 | - * |
|
| 140 | - * @param StorageConfig $storage storage config |
|
| 141 | - *1 |
|
| 142 | - * @return DataResponse|null returns response in case of validation error |
|
| 143 | - */ |
|
| 144 | - protected function validate(StorageConfig $storage) { |
|
| 145 | - $mountPoint = $storage->getMountPoint(); |
|
| 146 | - if ($mountPoint === '') { |
|
| 147 | - return new DataResponse( |
|
| 148 | - array( |
|
| 149 | - 'message' => (string)$this->l10n->t('Invalid mount point') |
|
| 150 | - ), |
|
| 151 | - Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 152 | - ); |
|
| 153 | - } |
|
| 137 | + /** |
|
| 138 | + * Validate storage config |
|
| 139 | + * |
|
| 140 | + * @param StorageConfig $storage storage config |
|
| 141 | + *1 |
|
| 142 | + * @return DataResponse|null returns response in case of validation error |
|
| 143 | + */ |
|
| 144 | + protected function validate(StorageConfig $storage) { |
|
| 145 | + $mountPoint = $storage->getMountPoint(); |
|
| 146 | + if ($mountPoint === '') { |
|
| 147 | + return new DataResponse( |
|
| 148 | + array( |
|
| 149 | + 'message' => (string)$this->l10n->t('Invalid mount point') |
|
| 150 | + ), |
|
| 151 | + Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 152 | + ); |
|
| 153 | + } |
|
| 154 | 154 | |
| 155 | - if ($storage->getBackendOption('objectstore')) { |
|
| 156 | - // objectstore must not be sent from client side |
|
| 157 | - return new DataResponse( |
|
| 158 | - array( |
|
| 159 | - 'message' => (string)$this->l10n->t('Objectstore forbidden') |
|
| 160 | - ), |
|
| 161 | - Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 162 | - ); |
|
| 163 | - } |
|
| 155 | + if ($storage->getBackendOption('objectstore')) { |
|
| 156 | + // objectstore must not be sent from client side |
|
| 157 | + return new DataResponse( |
|
| 158 | + array( |
|
| 159 | + 'message' => (string)$this->l10n->t('Objectstore forbidden') |
|
| 160 | + ), |
|
| 161 | + Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 162 | + ); |
|
| 163 | + } |
|
| 164 | 164 | |
| 165 | - /** @var Backend */ |
|
| 166 | - $backend = $storage->getBackend(); |
|
| 167 | - /** @var AuthMechanism */ |
|
| 168 | - $authMechanism = $storage->getAuthMechanism(); |
|
| 169 | - if ($backend->checkDependencies()) { |
|
| 170 | - // invalid backend |
|
| 171 | - return new DataResponse( |
|
| 172 | - array( |
|
| 173 | - 'message' => (string)$this->l10n->t('Invalid storage backend "%s"', [ |
|
| 174 | - $backend->getIdentifier() |
|
| 175 | - ]) |
|
| 176 | - ), |
|
| 177 | - Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 178 | - ); |
|
| 179 | - } |
|
| 165 | + /** @var Backend */ |
|
| 166 | + $backend = $storage->getBackend(); |
|
| 167 | + /** @var AuthMechanism */ |
|
| 168 | + $authMechanism = $storage->getAuthMechanism(); |
|
| 169 | + if ($backend->checkDependencies()) { |
|
| 170 | + // invalid backend |
|
| 171 | + return new DataResponse( |
|
| 172 | + array( |
|
| 173 | + 'message' => (string)$this->l10n->t('Invalid storage backend "%s"', [ |
|
| 174 | + $backend->getIdentifier() |
|
| 175 | + ]) |
|
| 176 | + ), |
|
| 177 | + Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 178 | + ); |
|
| 179 | + } |
|
| 180 | 180 | |
| 181 | - if (!$backend->isVisibleFor($this->service->getVisibilityType())) { |
|
| 182 | - // not permitted to use backend |
|
| 183 | - return new DataResponse( |
|
| 184 | - array( |
|
| 185 | - 'message' => (string)$this->l10n->t('Not permitted to use backend "%s"', [ |
|
| 186 | - $backend->getIdentifier() |
|
| 187 | - ]) |
|
| 188 | - ), |
|
| 189 | - Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 190 | - ); |
|
| 191 | - } |
|
| 192 | - if (!$authMechanism->isVisibleFor($this->service->getVisibilityType())) { |
|
| 193 | - // not permitted to use auth mechanism |
|
| 194 | - return new DataResponse( |
|
| 195 | - array( |
|
| 196 | - 'message' => (string)$this->l10n->t('Not permitted to use authentication mechanism "%s"', [ |
|
| 197 | - $authMechanism->getIdentifier() |
|
| 198 | - ]) |
|
| 199 | - ), |
|
| 200 | - Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 201 | - ); |
|
| 202 | - } |
|
| 181 | + if (!$backend->isVisibleFor($this->service->getVisibilityType())) { |
|
| 182 | + // not permitted to use backend |
|
| 183 | + return new DataResponse( |
|
| 184 | + array( |
|
| 185 | + 'message' => (string)$this->l10n->t('Not permitted to use backend "%s"', [ |
|
| 186 | + $backend->getIdentifier() |
|
| 187 | + ]) |
|
| 188 | + ), |
|
| 189 | + Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 190 | + ); |
|
| 191 | + } |
|
| 192 | + if (!$authMechanism->isVisibleFor($this->service->getVisibilityType())) { |
|
| 193 | + // not permitted to use auth mechanism |
|
| 194 | + return new DataResponse( |
|
| 195 | + array( |
|
| 196 | + 'message' => (string)$this->l10n->t('Not permitted to use authentication mechanism "%s"', [ |
|
| 197 | + $authMechanism->getIdentifier() |
|
| 198 | + ]) |
|
| 199 | + ), |
|
| 200 | + Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 201 | + ); |
|
| 202 | + } |
|
| 203 | 203 | |
| 204 | - if (!$backend->validateStorage($storage)) { |
|
| 205 | - // unsatisfied parameters |
|
| 206 | - return new DataResponse( |
|
| 207 | - array( |
|
| 208 | - 'message' => (string)$this->l10n->t('Unsatisfied backend parameters') |
|
| 209 | - ), |
|
| 210 | - Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 211 | - ); |
|
| 212 | - } |
|
| 213 | - if (!$authMechanism->validateStorage($storage)) { |
|
| 214 | - // unsatisfied parameters |
|
| 215 | - return new DataResponse( |
|
| 216 | - [ |
|
| 217 | - 'message' => (string)$this->l10n->t('Unsatisfied authentication mechanism parameters') |
|
| 218 | - ], |
|
| 219 | - Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 220 | - ); |
|
| 221 | - } |
|
| 204 | + if (!$backend->validateStorage($storage)) { |
|
| 205 | + // unsatisfied parameters |
|
| 206 | + return new DataResponse( |
|
| 207 | + array( |
|
| 208 | + 'message' => (string)$this->l10n->t('Unsatisfied backend parameters') |
|
| 209 | + ), |
|
| 210 | + Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 211 | + ); |
|
| 212 | + } |
|
| 213 | + if (!$authMechanism->validateStorage($storage)) { |
|
| 214 | + // unsatisfied parameters |
|
| 215 | + return new DataResponse( |
|
| 216 | + [ |
|
| 217 | + 'message' => (string)$this->l10n->t('Unsatisfied authentication mechanism parameters') |
|
| 218 | + ], |
|
| 219 | + Http::STATUS_UNPROCESSABLE_ENTITY |
|
| 220 | + ); |
|
| 221 | + } |
|
| 222 | 222 | |
| 223 | - return null; |
|
| 224 | - } |
|
| 223 | + return null; |
|
| 224 | + } |
|
| 225 | 225 | |
| 226 | - protected function manipulateStorageConfig(StorageConfig $storage) { |
|
| 227 | - /** @var AuthMechanism */ |
|
| 228 | - $authMechanism = $storage->getAuthMechanism(); |
|
| 229 | - $authMechanism->manipulateStorageConfig($storage); |
|
| 230 | - /** @var Backend */ |
|
| 231 | - $backend = $storage->getBackend(); |
|
| 232 | - $backend->manipulateStorageConfig($storage); |
|
| 233 | - } |
|
| 226 | + protected function manipulateStorageConfig(StorageConfig $storage) { |
|
| 227 | + /** @var AuthMechanism */ |
|
| 228 | + $authMechanism = $storage->getAuthMechanism(); |
|
| 229 | + $authMechanism->manipulateStorageConfig($storage); |
|
| 230 | + /** @var Backend */ |
|
| 231 | + $backend = $storage->getBackend(); |
|
| 232 | + $backend->manipulateStorageConfig($storage); |
|
| 233 | + } |
|
| 234 | 234 | |
| 235 | - /** |
|
| 236 | - * Check whether the given storage is available / valid. |
|
| 237 | - * |
|
| 238 | - * Note that this operation can be time consuming depending |
|
| 239 | - * on whether the remote storage is available or not. |
|
| 240 | - * |
|
| 241 | - * @param StorageConfig $storage storage configuration |
|
| 242 | - * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 243 | - */ |
|
| 244 | - protected function updateStorageStatus(StorageConfig &$storage, $testOnly = true) { |
|
| 245 | - try { |
|
| 246 | - $this->manipulateStorageConfig($storage); |
|
| 235 | + /** |
|
| 236 | + * Check whether the given storage is available / valid. |
|
| 237 | + * |
|
| 238 | + * Note that this operation can be time consuming depending |
|
| 239 | + * on whether the remote storage is available or not. |
|
| 240 | + * |
|
| 241 | + * @param StorageConfig $storage storage configuration |
|
| 242 | + * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 243 | + */ |
|
| 244 | + protected function updateStorageStatus(StorageConfig &$storage, $testOnly = true) { |
|
| 245 | + try { |
|
| 246 | + $this->manipulateStorageConfig($storage); |
|
| 247 | 247 | |
| 248 | - /** @var Backend */ |
|
| 249 | - $backend = $storage->getBackend(); |
|
| 250 | - // update status (can be time-consuming) |
|
| 251 | - $storage->setStatus( |
|
| 252 | - \OC_Mount_Config::getBackendStatus( |
|
| 253 | - $backend->getStorageClass(), |
|
| 254 | - $storage->getBackendOptions(), |
|
| 255 | - false, |
|
| 256 | - $testOnly |
|
| 257 | - ) |
|
| 258 | - ); |
|
| 259 | - } catch (InsufficientDataForMeaningfulAnswerException $e) { |
|
| 260 | - $status = $e->getCode() ? $e->getCode() : StorageNotAvailableException::STATUS_INDETERMINATE; |
|
| 261 | - $storage->setStatus( |
|
| 262 | - $status, |
|
| 263 | - $this->l10n->t('Insufficient data: %s', [$e->getMessage()]) |
|
| 264 | - ); |
|
| 265 | - } catch (StorageNotAvailableException $e) { |
|
| 266 | - $storage->setStatus( |
|
| 267 | - $e->getCode(), |
|
| 268 | - $this->l10n->t('%s', [$e->getMessage()]) |
|
| 269 | - ); |
|
| 270 | - } catch (\Exception $e) { |
|
| 271 | - // FIXME: convert storage exceptions to StorageNotAvailableException |
|
| 272 | - $storage->setStatus( |
|
| 273 | - StorageNotAvailableException::STATUS_ERROR, |
|
| 274 | - get_class($e).': '.$e->getMessage() |
|
| 275 | - ); |
|
| 276 | - } |
|
| 277 | - } |
|
| 248 | + /** @var Backend */ |
|
| 249 | + $backend = $storage->getBackend(); |
|
| 250 | + // update status (can be time-consuming) |
|
| 251 | + $storage->setStatus( |
|
| 252 | + \OC_Mount_Config::getBackendStatus( |
|
| 253 | + $backend->getStorageClass(), |
|
| 254 | + $storage->getBackendOptions(), |
|
| 255 | + false, |
|
| 256 | + $testOnly |
|
| 257 | + ) |
|
| 258 | + ); |
|
| 259 | + } catch (InsufficientDataForMeaningfulAnswerException $e) { |
|
| 260 | + $status = $e->getCode() ? $e->getCode() : StorageNotAvailableException::STATUS_INDETERMINATE; |
|
| 261 | + $storage->setStatus( |
|
| 262 | + $status, |
|
| 263 | + $this->l10n->t('Insufficient data: %s', [$e->getMessage()]) |
|
| 264 | + ); |
|
| 265 | + } catch (StorageNotAvailableException $e) { |
|
| 266 | + $storage->setStatus( |
|
| 267 | + $e->getCode(), |
|
| 268 | + $this->l10n->t('%s', [$e->getMessage()]) |
|
| 269 | + ); |
|
| 270 | + } catch (\Exception $e) { |
|
| 271 | + // FIXME: convert storage exceptions to StorageNotAvailableException |
|
| 272 | + $storage->setStatus( |
|
| 273 | + StorageNotAvailableException::STATUS_ERROR, |
|
| 274 | + get_class($e).': '.$e->getMessage() |
|
| 275 | + ); |
|
| 276 | + } |
|
| 277 | + } |
|
| 278 | 278 | |
| 279 | - /** |
|
| 280 | - * Get all storage entries |
|
| 281 | - * |
|
| 282 | - * @return DataResponse |
|
| 283 | - */ |
|
| 284 | - public function index() { |
|
| 285 | - $storages = $this->service->getStorages(); |
|
| 279 | + /** |
|
| 280 | + * Get all storage entries |
|
| 281 | + * |
|
| 282 | + * @return DataResponse |
|
| 283 | + */ |
|
| 284 | + public function index() { |
|
| 285 | + $storages = $this->service->getStorages(); |
|
| 286 | 286 | |
| 287 | - return new DataResponse( |
|
| 288 | - $storages, |
|
| 289 | - Http::STATUS_OK |
|
| 290 | - ); |
|
| 291 | - } |
|
| 287 | + return new DataResponse( |
|
| 288 | + $storages, |
|
| 289 | + Http::STATUS_OK |
|
| 290 | + ); |
|
| 291 | + } |
|
| 292 | 292 | |
| 293 | - /** |
|
| 294 | - * Get an external storage entry. |
|
| 295 | - * |
|
| 296 | - * @param int $id storage id |
|
| 297 | - * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 298 | - * |
|
| 299 | - * @return DataResponse |
|
| 300 | - */ |
|
| 301 | - public function show($id, $testOnly = true) { |
|
| 302 | - try { |
|
| 303 | - $storage = $this->service->getStorage($id); |
|
| 293 | + /** |
|
| 294 | + * Get an external storage entry. |
|
| 295 | + * |
|
| 296 | + * @param int $id storage id |
|
| 297 | + * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 298 | + * |
|
| 299 | + * @return DataResponse |
|
| 300 | + */ |
|
| 301 | + public function show($id, $testOnly = true) { |
|
| 302 | + try { |
|
| 303 | + $storage = $this->service->getStorage($id); |
|
| 304 | 304 | |
| 305 | - $this->updateStorageStatus($storage, $testOnly); |
|
| 306 | - } catch (NotFoundException $e) { |
|
| 307 | - return new DataResponse( |
|
| 308 | - [ |
|
| 309 | - 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 310 | - ], |
|
| 311 | - Http::STATUS_NOT_FOUND |
|
| 312 | - ); |
|
| 313 | - } |
|
| 305 | + $this->updateStorageStatus($storage, $testOnly); |
|
| 306 | + } catch (NotFoundException $e) { |
|
| 307 | + return new DataResponse( |
|
| 308 | + [ |
|
| 309 | + 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 310 | + ], |
|
| 311 | + Http::STATUS_NOT_FOUND |
|
| 312 | + ); |
|
| 313 | + } |
|
| 314 | 314 | |
| 315 | - return new DataResponse( |
|
| 316 | - $storage, |
|
| 317 | - Http::STATUS_OK |
|
| 318 | - ); |
|
| 319 | - } |
|
| 315 | + return new DataResponse( |
|
| 316 | + $storage, |
|
| 317 | + Http::STATUS_OK |
|
| 318 | + ); |
|
| 319 | + } |
|
| 320 | 320 | |
| 321 | - /** |
|
| 322 | - * Deletes the storage with the given id. |
|
| 323 | - * |
|
| 324 | - * @param int $id storage id |
|
| 325 | - * |
|
| 326 | - * @return DataResponse |
|
| 327 | - */ |
|
| 328 | - public function destroy($id) { |
|
| 329 | - try { |
|
| 330 | - $this->service->removeStorage($id); |
|
| 331 | - } catch (NotFoundException $e) { |
|
| 332 | - return new DataResponse( |
|
| 333 | - [ |
|
| 334 | - 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 335 | - ], |
|
| 336 | - Http::STATUS_NOT_FOUND |
|
| 337 | - ); |
|
| 338 | - } |
|
| 321 | + /** |
|
| 322 | + * Deletes the storage with the given id. |
|
| 323 | + * |
|
| 324 | + * @param int $id storage id |
|
| 325 | + * |
|
| 326 | + * @return DataResponse |
|
| 327 | + */ |
|
| 328 | + public function destroy($id) { |
|
| 329 | + try { |
|
| 330 | + $this->service->removeStorage($id); |
|
| 331 | + } catch (NotFoundException $e) { |
|
| 332 | + return new DataResponse( |
|
| 333 | + [ |
|
| 334 | + 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 335 | + ], |
|
| 336 | + Http::STATUS_NOT_FOUND |
|
| 337 | + ); |
|
| 338 | + } |
|
| 339 | 339 | |
| 340 | - return new DataResponse([], Http::STATUS_NO_CONTENT); |
|
| 341 | - } |
|
| 340 | + return new DataResponse([], Http::STATUS_NO_CONTENT); |
|
| 341 | + } |
|
| 342 | 342 | |
| 343 | 343 | } |
| 344 | 344 | |
@@ -43,165 +43,165 @@ |
||
| 43 | 43 | * User global storages controller |
| 44 | 44 | */ |
| 45 | 45 | class UserGlobalStoragesController extends StoragesController { |
| 46 | - /** |
|
| 47 | - * @var IUserSession |
|
| 48 | - */ |
|
| 49 | - private $userSession; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * Creates a new user global storages controller. |
|
| 53 | - * |
|
| 54 | - * @param string $AppName application name |
|
| 55 | - * @param IRequest $request request object |
|
| 56 | - * @param IL10N $l10n l10n service |
|
| 57 | - * @param UserGlobalStoragesService $userGlobalStoragesService storage service |
|
| 58 | - * @param IUserSession $userSession |
|
| 59 | - */ |
|
| 60 | - public function __construct( |
|
| 61 | - $AppName, |
|
| 62 | - IRequest $request, |
|
| 63 | - IL10N $l10n, |
|
| 64 | - UserGlobalStoragesService $userGlobalStoragesService, |
|
| 65 | - IUserSession $userSession, |
|
| 66 | - ILogger $logger |
|
| 67 | - ) { |
|
| 68 | - parent::__construct( |
|
| 69 | - $AppName, |
|
| 70 | - $request, |
|
| 71 | - $l10n, |
|
| 72 | - $userGlobalStoragesService, |
|
| 73 | - $logger |
|
| 74 | - ); |
|
| 75 | - $this->userSession = $userSession; |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * Get all storage entries |
|
| 80 | - * |
|
| 81 | - * @return DataResponse |
|
| 82 | - * |
|
| 83 | - * @NoAdminRequired |
|
| 84 | - */ |
|
| 85 | - public function index() { |
|
| 86 | - $storages = $this->service->getUniqueStorages(); |
|
| 87 | - |
|
| 88 | - // remove configuration data, this must be kept private |
|
| 89 | - foreach ($storages as $storage) { |
|
| 90 | - $this->sanitizeStorage($storage); |
|
| 91 | - } |
|
| 92 | - |
|
| 93 | - return new DataResponse( |
|
| 94 | - $storages, |
|
| 95 | - Http::STATUS_OK |
|
| 96 | - ); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - protected function manipulateStorageConfig(StorageConfig $storage) { |
|
| 100 | - /** @var AuthMechanism */ |
|
| 101 | - $authMechanism = $storage->getAuthMechanism(); |
|
| 102 | - $authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 103 | - /** @var Backend */ |
|
| 104 | - $backend = $storage->getBackend(); |
|
| 105 | - $backend->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * Get an external storage entry. |
|
| 110 | - * |
|
| 111 | - * @param int $id storage id |
|
| 112 | - * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 113 | - * @return DataResponse |
|
| 114 | - * |
|
| 115 | - * @NoAdminRequired |
|
| 116 | - */ |
|
| 117 | - public function show($id, $testOnly = true) { |
|
| 118 | - try { |
|
| 119 | - $storage = $this->service->getStorage($id); |
|
| 120 | - |
|
| 121 | - $this->updateStorageStatus($storage, $testOnly); |
|
| 122 | - } catch (NotFoundException $e) { |
|
| 123 | - return new DataResponse( |
|
| 124 | - [ |
|
| 125 | - 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 126 | - ], |
|
| 127 | - Http::STATUS_NOT_FOUND |
|
| 128 | - ); |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - $this->sanitizeStorage($storage); |
|
| 132 | - |
|
| 133 | - return new DataResponse( |
|
| 134 | - $storage, |
|
| 135 | - Http::STATUS_OK |
|
| 136 | - ); |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - /** |
|
| 140 | - * Update an external storage entry. |
|
| 141 | - * Only allows setting user provided backend fields |
|
| 142 | - * |
|
| 143 | - * @param int $id storage id |
|
| 144 | - * @param array $backendOptions backend-specific options |
|
| 145 | - * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 146 | - * |
|
| 147 | - * @return DataResponse |
|
| 148 | - * |
|
| 149 | - * @NoAdminRequired |
|
| 150 | - */ |
|
| 151 | - public function update( |
|
| 152 | - $id, |
|
| 153 | - $backendOptions, |
|
| 154 | - $testOnly = true |
|
| 155 | - ) { |
|
| 156 | - try { |
|
| 157 | - $storage = $this->service->getStorage($id); |
|
| 158 | - $authMechanism = $storage->getAuthMechanism(); |
|
| 159 | - if ($authMechanism instanceof IUserProvided) { |
|
| 160 | - $authMechanism->saveBackendOptions($this->userSession->getUser(), $id, $backendOptions); |
|
| 161 | - $authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 162 | - } else { |
|
| 163 | - return new DataResponse( |
|
| 164 | - [ |
|
| 165 | - 'message' => (string)$this->l10n->t('Storage with ID "%d" is not user editable', array($id)) |
|
| 166 | - ], |
|
| 167 | - Http::STATUS_FORBIDDEN |
|
| 168 | - ); |
|
| 169 | - } |
|
| 170 | - } catch (NotFoundException $e) { |
|
| 171 | - return new DataResponse( |
|
| 172 | - [ |
|
| 173 | - 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 174 | - ], |
|
| 175 | - Http::STATUS_NOT_FOUND |
|
| 176 | - ); |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - $this->updateStorageStatus($storage, $testOnly); |
|
| 180 | - $this->sanitizeStorage($storage); |
|
| 181 | - |
|
| 182 | - return new DataResponse( |
|
| 183 | - $storage, |
|
| 184 | - Http::STATUS_OK |
|
| 185 | - ); |
|
| 186 | - |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * Remove sensitive data from a StorageConfig before returning it to the user |
|
| 191 | - * |
|
| 192 | - * @param StorageConfig $storage |
|
| 193 | - */ |
|
| 194 | - protected function sanitizeStorage(StorageConfig $storage) { |
|
| 195 | - $storage->setBackendOptions([]); |
|
| 196 | - $storage->setMountOptions([]); |
|
| 197 | - |
|
| 198 | - if ($storage->getAuthMechanism() instanceof IUserProvided) { |
|
| 199 | - try { |
|
| 200 | - $storage->getAuthMechanism()->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 201 | - } catch (InsufficientDataForMeaningfulAnswerException $e) { |
|
| 202 | - // not configured yet |
|
| 203 | - } |
|
| 204 | - } |
|
| 205 | - } |
|
| 46 | + /** |
|
| 47 | + * @var IUserSession |
|
| 48 | + */ |
|
| 49 | + private $userSession; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * Creates a new user global storages controller. |
|
| 53 | + * |
|
| 54 | + * @param string $AppName application name |
|
| 55 | + * @param IRequest $request request object |
|
| 56 | + * @param IL10N $l10n l10n service |
|
| 57 | + * @param UserGlobalStoragesService $userGlobalStoragesService storage service |
|
| 58 | + * @param IUserSession $userSession |
|
| 59 | + */ |
|
| 60 | + public function __construct( |
|
| 61 | + $AppName, |
|
| 62 | + IRequest $request, |
|
| 63 | + IL10N $l10n, |
|
| 64 | + UserGlobalStoragesService $userGlobalStoragesService, |
|
| 65 | + IUserSession $userSession, |
|
| 66 | + ILogger $logger |
|
| 67 | + ) { |
|
| 68 | + parent::__construct( |
|
| 69 | + $AppName, |
|
| 70 | + $request, |
|
| 71 | + $l10n, |
|
| 72 | + $userGlobalStoragesService, |
|
| 73 | + $logger |
|
| 74 | + ); |
|
| 75 | + $this->userSession = $userSession; |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * Get all storage entries |
|
| 80 | + * |
|
| 81 | + * @return DataResponse |
|
| 82 | + * |
|
| 83 | + * @NoAdminRequired |
|
| 84 | + */ |
|
| 85 | + public function index() { |
|
| 86 | + $storages = $this->service->getUniqueStorages(); |
|
| 87 | + |
|
| 88 | + // remove configuration data, this must be kept private |
|
| 89 | + foreach ($storages as $storage) { |
|
| 90 | + $this->sanitizeStorage($storage); |
|
| 91 | + } |
|
| 92 | + |
|
| 93 | + return new DataResponse( |
|
| 94 | + $storages, |
|
| 95 | + Http::STATUS_OK |
|
| 96 | + ); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + protected function manipulateStorageConfig(StorageConfig $storage) { |
|
| 100 | + /** @var AuthMechanism */ |
|
| 101 | + $authMechanism = $storage->getAuthMechanism(); |
|
| 102 | + $authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 103 | + /** @var Backend */ |
|
| 104 | + $backend = $storage->getBackend(); |
|
| 105 | + $backend->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * Get an external storage entry. |
|
| 110 | + * |
|
| 111 | + * @param int $id storage id |
|
| 112 | + * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 113 | + * @return DataResponse |
|
| 114 | + * |
|
| 115 | + * @NoAdminRequired |
|
| 116 | + */ |
|
| 117 | + public function show($id, $testOnly = true) { |
|
| 118 | + try { |
|
| 119 | + $storage = $this->service->getStorage($id); |
|
| 120 | + |
|
| 121 | + $this->updateStorageStatus($storage, $testOnly); |
|
| 122 | + } catch (NotFoundException $e) { |
|
| 123 | + return new DataResponse( |
|
| 124 | + [ |
|
| 125 | + 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 126 | + ], |
|
| 127 | + Http::STATUS_NOT_FOUND |
|
| 128 | + ); |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + $this->sanitizeStorage($storage); |
|
| 132 | + |
|
| 133 | + return new DataResponse( |
|
| 134 | + $storage, |
|
| 135 | + Http::STATUS_OK |
|
| 136 | + ); |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + /** |
|
| 140 | + * Update an external storage entry. |
|
| 141 | + * Only allows setting user provided backend fields |
|
| 142 | + * |
|
| 143 | + * @param int $id storage id |
|
| 144 | + * @param array $backendOptions backend-specific options |
|
| 145 | + * @param bool $testOnly whether to storage should only test the connection or do more things |
|
| 146 | + * |
|
| 147 | + * @return DataResponse |
|
| 148 | + * |
|
| 149 | + * @NoAdminRequired |
|
| 150 | + */ |
|
| 151 | + public function update( |
|
| 152 | + $id, |
|
| 153 | + $backendOptions, |
|
| 154 | + $testOnly = true |
|
| 155 | + ) { |
|
| 156 | + try { |
|
| 157 | + $storage = $this->service->getStorage($id); |
|
| 158 | + $authMechanism = $storage->getAuthMechanism(); |
|
| 159 | + if ($authMechanism instanceof IUserProvided) { |
|
| 160 | + $authMechanism->saveBackendOptions($this->userSession->getUser(), $id, $backendOptions); |
|
| 161 | + $authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 162 | + } else { |
|
| 163 | + return new DataResponse( |
|
| 164 | + [ |
|
| 165 | + 'message' => (string)$this->l10n->t('Storage with ID "%d" is not user editable', array($id)) |
|
| 166 | + ], |
|
| 167 | + Http::STATUS_FORBIDDEN |
|
| 168 | + ); |
|
| 169 | + } |
|
| 170 | + } catch (NotFoundException $e) { |
|
| 171 | + return new DataResponse( |
|
| 172 | + [ |
|
| 173 | + 'message' => (string)$this->l10n->t('Storage with ID "%d" not found', array($id)) |
|
| 174 | + ], |
|
| 175 | + Http::STATUS_NOT_FOUND |
|
| 176 | + ); |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + $this->updateStorageStatus($storage, $testOnly); |
|
| 180 | + $this->sanitizeStorage($storage); |
|
| 181 | + |
|
| 182 | + return new DataResponse( |
|
| 183 | + $storage, |
|
| 184 | + Http::STATUS_OK |
|
| 185 | + ); |
|
| 186 | + |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * Remove sensitive data from a StorageConfig before returning it to the user |
|
| 191 | + * |
|
| 192 | + * @param StorageConfig $storage |
|
| 193 | + */ |
|
| 194 | + protected function sanitizeStorage(StorageConfig $storage) { |
|
| 195 | + $storage->setBackendOptions([]); |
|
| 196 | + $storage->setMountOptions([]); |
|
| 197 | + |
|
| 198 | + if ($storage->getAuthMechanism() instanceof IUserProvided) { |
|
| 199 | + try { |
|
| 200 | + $storage->getAuthMechanism()->manipulateStorageConfig($storage, $this->userSession->getUser()); |
|
| 201 | + } catch (InsufficientDataForMeaningfulAnswerException $e) { |
|
| 202 | + // not configured yet |
|
| 203 | + } |
|
| 204 | + } |
|
| 205 | + } |
|
| 206 | 206 | |
| 207 | 207 | } |