@@ -36,7 +36,7 @@ |
||
| 36 | 36 | $l = \OC::$server->getL10N('federation'); |
| 37 | 37 | $this->parameterList = $missingParameters; |
| 38 | 38 | $parameterList = implode(',', $missingParameters); |
| 39 | - $message = 'Parameters missing in order to complete the request. Missing Parameters: ' . $parameterList; |
|
| 39 | + $message = 'Parameters missing in order to complete the request. Missing Parameters: '.$parameterList; |
|
| 40 | 40 | $hint = $l->t('Parameters missing in order to complete the request. Missing Parameters: "%s"', [$parameterList]); |
| 41 | 41 | parent::__construct($message, $hint); |
| 42 | 42 | } |
@@ -32,45 +32,45 @@ |
||
| 32 | 32 | * @since 14.0.0 |
| 33 | 33 | */ |
| 34 | 34 | class BadRequestException extends HintException { |
| 35 | - private $parameterList; |
|
| 35 | + private $parameterList; |
|
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * BadRequestException constructor. |
|
| 39 | - * |
|
| 40 | - * @since 14.0.0 |
|
| 41 | - * |
|
| 42 | - * @param array $missingParameters |
|
| 43 | - */ |
|
| 44 | - public function __construct(array $missingParameters) { |
|
| 45 | - $l = \OC::$server->getL10N('federation'); |
|
| 46 | - $this->parameterList = $missingParameters; |
|
| 47 | - $parameterList = implode(',', $missingParameters); |
|
| 48 | - $message = 'Parameters missing in order to complete the request. Missing Parameters: ' . $parameterList; |
|
| 49 | - $hint = $l->t('Parameters missing in order to complete the request. Missing Parameters: "%s"', [$parameterList]); |
|
| 50 | - parent::__construct($message, $hint); |
|
| 51 | - } |
|
| 37 | + /** |
|
| 38 | + * BadRequestException constructor. |
|
| 39 | + * |
|
| 40 | + * @since 14.0.0 |
|
| 41 | + * |
|
| 42 | + * @param array $missingParameters |
|
| 43 | + */ |
|
| 44 | + public function __construct(array $missingParameters) { |
|
| 45 | + $l = \OC::$server->getL10N('federation'); |
|
| 46 | + $this->parameterList = $missingParameters; |
|
| 47 | + $parameterList = implode(',', $missingParameters); |
|
| 48 | + $message = 'Parameters missing in order to complete the request. Missing Parameters: ' . $parameterList; |
|
| 49 | + $hint = $l->t('Parameters missing in order to complete the request. Missing Parameters: "%s"', [$parameterList]); |
|
| 50 | + parent::__construct($message, $hint); |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * get array with the return message as defined in the OCM API |
|
| 55 | - * |
|
| 56 | - * @since 14.0.0 |
|
| 57 | - * |
|
| 58 | - * @return array |
|
| 59 | - */ |
|
| 60 | - public function getReturnMessage() { |
|
| 61 | - $result = [ |
|
| 62 | - 'message' => 'RESOURCE_NOT_FOUND', |
|
| 63 | - 'validationErrors' => [ |
|
| 64 | - ] |
|
| 65 | - ]; |
|
| 53 | + /** |
|
| 54 | + * get array with the return message as defined in the OCM API |
|
| 55 | + * |
|
| 56 | + * @since 14.0.0 |
|
| 57 | + * |
|
| 58 | + * @return array |
|
| 59 | + */ |
|
| 60 | + public function getReturnMessage() { |
|
| 61 | + $result = [ |
|
| 62 | + 'message' => 'RESOURCE_NOT_FOUND', |
|
| 63 | + 'validationErrors' => [ |
|
| 64 | + ] |
|
| 65 | + ]; |
|
| 66 | 66 | |
| 67 | - foreach ($this->parameterList as $missingParameter) { |
|
| 68 | - $result['validationErrors'] = [ |
|
| 69 | - 'name' => $missingParameter, |
|
| 70 | - 'message' => 'NOT_FOUND' |
|
| 71 | - ]; |
|
| 72 | - } |
|
| 67 | + foreach ($this->parameterList as $missingParameter) { |
|
| 68 | + $result['validationErrors'] = [ |
|
| 69 | + 'name' => $missingParameter, |
|
| 70 | + 'message' => 'NOT_FOUND' |
|
| 71 | + ]; |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - return $result; |
|
| 75 | - } |
|
| 74 | + return $result; |
|
| 75 | + } |
|
| 76 | 76 | } |
@@ -59,9 +59,9 @@ discard block |
||
| 59 | 59 | private function getBlobClient() { |
| 60 | 60 | if (!$this->blobClient) { |
| 61 | 61 | $protocol = $this->endpoint ? substr($this->endpoint, 0, strpos($this->endpoint, ':')) : 'https'; |
| 62 | - $connectionString = "DefaultEndpointsProtocol=" . $protocol . ";AccountName=" . $this->accountName . ";AccountKey=" . $this->accountKey; |
|
| 62 | + $connectionString = "DefaultEndpointsProtocol=".$protocol.";AccountName=".$this->accountName.";AccountKey=".$this->accountKey; |
|
| 63 | 63 | if ($this->endpoint) { |
| 64 | - $connectionString .= ';BlobEndpoint=' . $this->endpoint; |
|
| 64 | + $connectionString .= ';BlobEndpoint='.$this->endpoint; |
|
| 65 | 65 | } |
| 66 | 66 | $this->blobClient = BlobRestProxy::createBlobService($connectionString); |
| 67 | 67 | |
@@ -76,7 +76,7 @@ discard block |
||
| 76 | 76 | * @return string the container or bucket name where objects are stored |
| 77 | 77 | */ |
| 78 | 78 | public function getStorageId() { |
| 79 | - return 'azure::blob::' . $this->containerName; |
|
| 79 | + return 'azure::blob::'.$this->containerName; |
|
| 80 | 80 | } |
| 81 | 81 | |
| 82 | 82 | /** |
@@ -28,110 +28,110 @@ |
||
| 28 | 28 | use OCP\Files\ObjectStore\IObjectStore; |
| 29 | 29 | |
| 30 | 30 | class Azure implements IObjectStore { |
| 31 | - /** @var string */ |
|
| 32 | - private $containerName; |
|
| 33 | - /** @var string */ |
|
| 34 | - private $accountName; |
|
| 35 | - /** @var string */ |
|
| 36 | - private $accountKey; |
|
| 37 | - /** @var BlobRestProxy|null */ |
|
| 38 | - private $blobClient = null; |
|
| 39 | - /** @var string|null */ |
|
| 40 | - private $endpoint = null; |
|
| 41 | - /** @var bool */ |
|
| 42 | - private $autoCreate = false; |
|
| 31 | + /** @var string */ |
|
| 32 | + private $containerName; |
|
| 33 | + /** @var string */ |
|
| 34 | + private $accountName; |
|
| 35 | + /** @var string */ |
|
| 36 | + private $accountKey; |
|
| 37 | + /** @var BlobRestProxy|null */ |
|
| 38 | + private $blobClient = null; |
|
| 39 | + /** @var string|null */ |
|
| 40 | + private $endpoint = null; |
|
| 41 | + /** @var bool */ |
|
| 42 | + private $autoCreate = false; |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @param array $parameters |
|
| 46 | - */ |
|
| 47 | - public function __construct($parameters) { |
|
| 48 | - $this->containerName = $parameters['container']; |
|
| 49 | - $this->accountName = $parameters['account_name']; |
|
| 50 | - $this->accountKey = $parameters['account_key']; |
|
| 51 | - if (isset($parameters['endpoint'])) { |
|
| 52 | - $this->endpoint = $parameters['endpoint']; |
|
| 53 | - } |
|
| 54 | - if (isset($parameters['autocreate'])) { |
|
| 55 | - $this->autoCreate = $parameters['autocreate']; |
|
| 56 | - } |
|
| 57 | - } |
|
| 44 | + /** |
|
| 45 | + * @param array $parameters |
|
| 46 | + */ |
|
| 47 | + public function __construct($parameters) { |
|
| 48 | + $this->containerName = $parameters['container']; |
|
| 49 | + $this->accountName = $parameters['account_name']; |
|
| 50 | + $this->accountKey = $parameters['account_key']; |
|
| 51 | + if (isset($parameters['endpoint'])) { |
|
| 52 | + $this->endpoint = $parameters['endpoint']; |
|
| 53 | + } |
|
| 54 | + if (isset($parameters['autocreate'])) { |
|
| 55 | + $this->autoCreate = $parameters['autocreate']; |
|
| 56 | + } |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * @return BlobRestProxy |
|
| 61 | - */ |
|
| 62 | - private function getBlobClient() { |
|
| 63 | - if (!$this->blobClient) { |
|
| 64 | - $protocol = $this->endpoint ? substr($this->endpoint, 0, strpos($this->endpoint, ':')) : 'https'; |
|
| 65 | - $connectionString = "DefaultEndpointsProtocol=" . $protocol . ";AccountName=" . $this->accountName . ";AccountKey=" . $this->accountKey; |
|
| 66 | - if ($this->endpoint) { |
|
| 67 | - $connectionString .= ';BlobEndpoint=' . $this->endpoint; |
|
| 68 | - } |
|
| 69 | - $this->blobClient = BlobRestProxy::createBlobService($connectionString); |
|
| 59 | + /** |
|
| 60 | + * @return BlobRestProxy |
|
| 61 | + */ |
|
| 62 | + private function getBlobClient() { |
|
| 63 | + if (!$this->blobClient) { |
|
| 64 | + $protocol = $this->endpoint ? substr($this->endpoint, 0, strpos($this->endpoint, ':')) : 'https'; |
|
| 65 | + $connectionString = "DefaultEndpointsProtocol=" . $protocol . ";AccountName=" . $this->accountName . ";AccountKey=" . $this->accountKey; |
|
| 66 | + if ($this->endpoint) { |
|
| 67 | + $connectionString .= ';BlobEndpoint=' . $this->endpoint; |
|
| 68 | + } |
|
| 69 | + $this->blobClient = BlobRestProxy::createBlobService($connectionString); |
|
| 70 | 70 | |
| 71 | - if ($this->autoCreate) { |
|
| 72 | - try { |
|
| 73 | - $this->blobClient->createContainer($this->containerName); |
|
| 74 | - } catch (ServiceException $e) { |
|
| 75 | - if ($e->getCode() === 409) { |
|
| 76 | - // already exists |
|
| 77 | - } else { |
|
| 78 | - throw $e; |
|
| 79 | - } |
|
| 80 | - } |
|
| 81 | - } |
|
| 82 | - } |
|
| 83 | - return $this->blobClient; |
|
| 84 | - } |
|
| 71 | + if ($this->autoCreate) { |
|
| 72 | + try { |
|
| 73 | + $this->blobClient->createContainer($this->containerName); |
|
| 74 | + } catch (ServiceException $e) { |
|
| 75 | + if ($e->getCode() === 409) { |
|
| 76 | + // already exists |
|
| 77 | + } else { |
|
| 78 | + throw $e; |
|
| 79 | + } |
|
| 80 | + } |
|
| 81 | + } |
|
| 82 | + } |
|
| 83 | + return $this->blobClient; |
|
| 84 | + } |
|
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * @return string the container or bucket name where objects are stored |
|
| 88 | - */ |
|
| 89 | - public function getStorageId() { |
|
| 90 | - return 'azure::blob::' . $this->containerName; |
|
| 91 | - } |
|
| 86 | + /** |
|
| 87 | + * @return string the container or bucket name where objects are stored |
|
| 88 | + */ |
|
| 89 | + public function getStorageId() { |
|
| 90 | + return 'azure::blob::' . $this->containerName; |
|
| 91 | + } |
|
| 92 | 92 | |
| 93 | - /** |
|
| 94 | - * @param string $urn the unified resource name used to identify the object |
|
| 95 | - * @return resource stream with the read data |
|
| 96 | - * @throws \Exception when something goes wrong, message will be logged |
|
| 97 | - */ |
|
| 98 | - public function readObject($urn) { |
|
| 99 | - $blob = $this->getBlobClient()->getBlob($this->containerName, $urn); |
|
| 100 | - return $blob->getContentStream(); |
|
| 101 | - } |
|
| 93 | + /** |
|
| 94 | + * @param string $urn the unified resource name used to identify the object |
|
| 95 | + * @return resource stream with the read data |
|
| 96 | + * @throws \Exception when something goes wrong, message will be logged |
|
| 97 | + */ |
|
| 98 | + public function readObject($urn) { |
|
| 99 | + $blob = $this->getBlobClient()->getBlob($this->containerName, $urn); |
|
| 100 | + return $blob->getContentStream(); |
|
| 101 | + } |
|
| 102 | 102 | |
| 103 | - /** |
|
| 104 | - * @param string $urn the unified resource name used to identify the object |
|
| 105 | - * @param resource $stream stream with the data to write |
|
| 106 | - * @throws \Exception when something goes wrong, message will be logged |
|
| 107 | - */ |
|
| 108 | - public function writeObject($urn, $stream) { |
|
| 109 | - $this->getBlobClient()->createBlockBlob($this->containerName, $urn, $stream); |
|
| 110 | - } |
|
| 103 | + /** |
|
| 104 | + * @param string $urn the unified resource name used to identify the object |
|
| 105 | + * @param resource $stream stream with the data to write |
|
| 106 | + * @throws \Exception when something goes wrong, message will be logged |
|
| 107 | + */ |
|
| 108 | + public function writeObject($urn, $stream) { |
|
| 109 | + $this->getBlobClient()->createBlockBlob($this->containerName, $urn, $stream); |
|
| 110 | + } |
|
| 111 | 111 | |
| 112 | - /** |
|
| 113 | - * @param string $urn the unified resource name used to identify the object |
|
| 114 | - * @return void |
|
| 115 | - * @throws \Exception when something goes wrong, message will be logged |
|
| 116 | - */ |
|
| 117 | - public function deleteObject($urn) { |
|
| 118 | - $this->getBlobClient()->deleteBlob($this->containerName, $urn); |
|
| 119 | - } |
|
| 112 | + /** |
|
| 113 | + * @param string $urn the unified resource name used to identify the object |
|
| 114 | + * @return void |
|
| 115 | + * @throws \Exception when something goes wrong, message will be logged |
|
| 116 | + */ |
|
| 117 | + public function deleteObject($urn) { |
|
| 118 | + $this->getBlobClient()->deleteBlob($this->containerName, $urn); |
|
| 119 | + } |
|
| 120 | 120 | |
| 121 | - public function objectExists($urn) { |
|
| 122 | - try { |
|
| 123 | - $this->getBlobClient()->getBlobMetadata($this->containerName, $urn); |
|
| 124 | - return true; |
|
| 125 | - } catch (ServiceException $e) { |
|
| 126 | - if ($e->getCode() === 404) { |
|
| 127 | - return false; |
|
| 128 | - } else { |
|
| 129 | - throw $e; |
|
| 130 | - } |
|
| 131 | - } |
|
| 132 | - } |
|
| 121 | + public function objectExists($urn) { |
|
| 122 | + try { |
|
| 123 | + $this->getBlobClient()->getBlobMetadata($this->containerName, $urn); |
|
| 124 | + return true; |
|
| 125 | + } catch (ServiceException $e) { |
|
| 126 | + if ($e->getCode() === 404) { |
|
| 127 | + return false; |
|
| 128 | + } else { |
|
| 129 | + throw $e; |
|
| 130 | + } |
|
| 131 | + } |
|
| 132 | + } |
|
| 133 | 133 | |
| 134 | - public function copyObject($from, $to) { |
|
| 135 | - $this->getBlobClient()->copyBlob($this->containerName, $to, $this->containerName, $from); |
|
| 136 | - } |
|
| 134 | + public function copyObject($from, $to) { |
|
| 135 | + $this->getBlobClient()->copyBlob($this->containerName, $to, $this->containerName, $from); |
|
| 136 | + } |
|
| 137 | 137 | } |
@@ -35,31 +35,31 @@ |
||
| 35 | 35 | */ |
| 36 | 36 | class RSAPrivateKey extends AuthMechanism { |
| 37 | 37 | |
| 38 | - /** @var IConfig */ |
|
| 39 | - private $config; |
|
| 38 | + /** @var IConfig */ |
|
| 39 | + private $config; |
|
| 40 | 40 | |
| 41 | - public function __construct(IL10N $l, IConfig $config) { |
|
| 42 | - $this->config = $config; |
|
| 41 | + public function __construct(IL10N $l, IConfig $config) { |
|
| 42 | + $this->config = $config; |
|
| 43 | 43 | |
| 44 | - $this |
|
| 45 | - ->setIdentifier('publickey::rsa_private') |
|
| 46 | - ->setScheme(self::SCHEME_PUBLICKEY) |
|
| 47 | - ->setText($l->t('RSA private key')) |
|
| 48 | - ->addParameters([ |
|
| 49 | - new DefinitionParameter('user', $l->t('Username')), |
|
| 50 | - (new DefinitionParameter('password', $l->t('Password'))) |
|
| 51 | - ->setFlag(DefinitionParameter::FLAG_OPTIONAL) |
|
| 52 | - ->setType(DefinitionParameter::VALUE_PASSWORD), |
|
| 53 | - new DefinitionParameter('private_key', $l->t('Private key')), |
|
| 54 | - ]); |
|
| 55 | - } |
|
| 44 | + $this |
|
| 45 | + ->setIdentifier('publickey::rsa_private') |
|
| 46 | + ->setScheme(self::SCHEME_PUBLICKEY) |
|
| 47 | + ->setText($l->t('RSA private key')) |
|
| 48 | + ->addParameters([ |
|
| 49 | + new DefinitionParameter('user', $l->t('Username')), |
|
| 50 | + (new DefinitionParameter('password', $l->t('Password'))) |
|
| 51 | + ->setFlag(DefinitionParameter::FLAG_OPTIONAL) |
|
| 52 | + ->setType(DefinitionParameter::VALUE_PASSWORD), |
|
| 53 | + new DefinitionParameter('private_key', $l->t('Private key')), |
|
| 54 | + ]); |
|
| 55 | + } |
|
| 56 | 56 | |
| 57 | - public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { |
|
| 58 | - $auth = new RSACrypt(); |
|
| 59 | - $auth->setPassword($this->config->getSystemValue('secret', '')); |
|
| 60 | - if (!$auth->loadKey($storage->getBackendOption('private_key'))) { |
|
| 61 | - throw new \RuntimeException('unable to load private key'); |
|
| 62 | - } |
|
| 63 | - $storage->setBackendOption('public_key_auth', $auth); |
|
| 64 | - } |
|
| 57 | + public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { |
|
| 58 | + $auth = new RSACrypt(); |
|
| 59 | + $auth->setPassword($this->config->getSystemValue('secret', '')); |
|
| 60 | + if (!$auth->loadKey($storage->getBackendOption('private_key'))) { |
|
| 61 | + throw new \RuntimeException('unable to load private key'); |
|
| 62 | + } |
|
| 63 | + $storage->setBackendOption('public_key_auth', $auth); |
|
| 64 | + } |
|
| 65 | 65 | } |
@@ -30,24 +30,24 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | interface ICloudFederationNotification { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * add a message to the notification |
|
| 35 | - * |
|
| 36 | - * @param string $notificationType (e.g. SHARE_ACCEPTED) |
|
| 37 | - * @param string $resourceType (e.g. file, calendar, contact,...) |
|
| 38 | - * @param $providerId id of the share |
|
| 39 | - * @param array $notification , payload of the notification |
|
| 40 | - * |
|
| 41 | - * @since 14.0.0 |
|
| 42 | - */ |
|
| 43 | - public function setMessage($notificationType, $resourceType, $providerId, array $notification); |
|
| 33 | + /** |
|
| 34 | + * add a message to the notification |
|
| 35 | + * |
|
| 36 | + * @param string $notificationType (e.g. SHARE_ACCEPTED) |
|
| 37 | + * @param string $resourceType (e.g. file, calendar, contact,...) |
|
| 38 | + * @param $providerId id of the share |
|
| 39 | + * @param array $notification , payload of the notification |
|
| 40 | + * |
|
| 41 | + * @since 14.0.0 |
|
| 42 | + */ |
|
| 43 | + public function setMessage($notificationType, $resourceType, $providerId, array $notification); |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * get message, ready to send out |
|
| 47 | - * |
|
| 48 | - * @return array |
|
| 49 | - * |
|
| 50 | - * @since 14.0.0 |
|
| 51 | - */ |
|
| 52 | - public function getMessage(); |
|
| 45 | + /** |
|
| 46 | + * get message, ready to send out |
|
| 47 | + * |
|
| 48 | + * @return array |
|
| 49 | + * |
|
| 50 | + * @since 14.0.0 |
|
| 51 | + */ |
|
| 52 | + public function getMessage(); |
|
| 53 | 53 | } |
@@ -30,221 +30,221 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | interface ICloudFederationShare { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * set uid of the recipient |
|
| 35 | - * |
|
| 36 | - * @param string $user |
|
| 37 | - * |
|
| 38 | - * @since 14.0.0 |
|
| 39 | - */ |
|
| 40 | - public function setShareWith($user); |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * set resource name (e.g. file, calendar, contact,...) |
|
| 44 | - * |
|
| 45 | - * @param string $name |
|
| 46 | - * |
|
| 47 | - * @since 14.0.0 |
|
| 48 | - */ |
|
| 49 | - public function setResourceName($name); |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * set resource type (e.g. file, calendar, contact,...) |
|
| 53 | - * |
|
| 54 | - * @param string $resourceType |
|
| 55 | - * |
|
| 56 | - * @since 14.0.0 |
|
| 57 | - */ |
|
| 58 | - public function setResourceType($resourceType); |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * set resource description (optional) |
|
| 62 | - * |
|
| 63 | - * @param string $description |
|
| 64 | - * |
|
| 65 | - * @since 14.0.0 |
|
| 66 | - */ |
|
| 67 | - public function setDescription($description); |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * set provider ID (e.g. file ID) |
|
| 71 | - * |
|
| 72 | - * @param string $providerId |
|
| 73 | - * |
|
| 74 | - * @since 14.0.0 |
|
| 75 | - */ |
|
| 76 | - public function setProviderId($providerId); |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * set owner UID |
|
| 80 | - * |
|
| 81 | - * @param string $owner |
|
| 82 | - * |
|
| 83 | - * @since 14.0.0 |
|
| 84 | - */ |
|
| 85 | - public function setOwner($owner); |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * set owner display name |
|
| 89 | - * |
|
| 90 | - * @param string $ownerDisplayName |
|
| 91 | - * |
|
| 92 | - * @since 14.0.0 |
|
| 93 | - */ |
|
| 94 | - public function setOwnerDisplayName($ownerDisplayName); |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * set UID of the user who sends the share |
|
| 98 | - * |
|
| 99 | - * @param string $sharedBy |
|
| 100 | - * |
|
| 101 | - * @since 14.0.0 |
|
| 102 | - */ |
|
| 103 | - public function setSharedBy($sharedBy); |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * set display name of the user who sends the share |
|
| 107 | - * |
|
| 108 | - * @param $sharedByDisplayName |
|
| 109 | - * |
|
| 110 | - * @since 14.0.0 |
|
| 111 | - */ |
|
| 112 | - public function setSharedByDisplayName($sharedByDisplayName); |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * set protocol specification |
|
| 116 | - * |
|
| 117 | - * @param array $protocol |
|
| 118 | - * |
|
| 119 | - * @since 14.0.0 |
|
| 120 | - */ |
|
| 121 | - public function setProtocol(array $protocol); |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * share type (group or user) |
|
| 125 | - * |
|
| 126 | - * @param string $shareType |
|
| 127 | - * |
|
| 128 | - * @since 14.0.0 |
|
| 129 | - */ |
|
| 130 | - public function setShareType($shareType); |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * get the whole share, ready to send out |
|
| 134 | - * |
|
| 135 | - * @return array |
|
| 136 | - * |
|
| 137 | - * @since 14.0.0 |
|
| 138 | - */ |
|
| 139 | - public function getShare(); |
|
| 140 | - |
|
| 141 | - /** |
|
| 142 | - * get uid of the recipient |
|
| 143 | - * |
|
| 144 | - * @return string |
|
| 145 | - * |
|
| 146 | - * @since 14.0.0 |
|
| 147 | - */ |
|
| 148 | - public function getShareWith(); |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * get resource name (e.g. file, calendar, contact,...) |
|
| 152 | - * |
|
| 153 | - * @return string |
|
| 154 | - * |
|
| 155 | - * @since 14.0.0 |
|
| 156 | - */ |
|
| 157 | - public function getResourceName(); |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * get resource type (e.g. file, calendar, contact,...) |
|
| 161 | - * |
|
| 162 | - * @return string |
|
| 163 | - * |
|
| 164 | - * @since 14.0.0 |
|
| 165 | - */ |
|
| 166 | - public function getResourceType(); |
|
| 167 | - |
|
| 168 | - /** |
|
| 169 | - * get resource description (optional) |
|
| 170 | - * |
|
| 171 | - * @return string |
|
| 172 | - * |
|
| 173 | - * @since 14.0.0 |
|
| 174 | - */ |
|
| 175 | - public function getDescription(); |
|
| 176 | - |
|
| 177 | - /** |
|
| 178 | - * get provider ID (e.g. file ID) |
|
| 179 | - * |
|
| 180 | - * @return string |
|
| 181 | - * |
|
| 182 | - * @since 14.0.0 |
|
| 183 | - */ |
|
| 184 | - public function getProviderId(); |
|
| 185 | - |
|
| 186 | - /** |
|
| 187 | - * get owner UID |
|
| 188 | - * |
|
| 189 | - * @return string |
|
| 190 | - * |
|
| 191 | - * @since 14.0.0 |
|
| 192 | - */ |
|
| 193 | - public function getOwner(); |
|
| 194 | - |
|
| 195 | - /** |
|
| 196 | - * get owner display name |
|
| 197 | - * |
|
| 198 | - * @return string |
|
| 199 | - * |
|
| 200 | - * @since 14.0.0 |
|
| 201 | - */ |
|
| 202 | - public function getOwnerDisplayName(); |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * get UID of the user who sends the share |
|
| 206 | - * |
|
| 207 | - * @return string |
|
| 208 | - * |
|
| 209 | - * @since 14.0.0 |
|
| 210 | - */ |
|
| 211 | - public function getSharedBy(); |
|
| 212 | - |
|
| 213 | - /** |
|
| 214 | - * get display name of the user who sends the share |
|
| 215 | - * |
|
| 216 | - * @return string |
|
| 217 | - * |
|
| 218 | - * @since 14.0.0 |
|
| 219 | - */ |
|
| 220 | - public function getSharedByDisplayName(); |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * get share type (group or user) |
|
| 224 | - * |
|
| 225 | - * @return string |
|
| 226 | - * |
|
| 227 | - * @since 14.0.0 |
|
| 228 | - */ |
|
| 229 | - public function getShareType(); |
|
| 230 | - |
|
| 231 | - /** |
|
| 232 | - * get share Secret |
|
| 233 | - * |
|
| 234 | - * @return string |
|
| 235 | - * |
|
| 236 | - * @since 14.0.0 |
|
| 237 | - */ |
|
| 238 | - public function getShareSecret(); |
|
| 239 | - |
|
| 240 | - |
|
| 241 | - /** |
|
| 242 | - * get protocol specification |
|
| 243 | - * |
|
| 244 | - * @return array |
|
| 245 | - * |
|
| 246 | - * @since 14.0.0 |
|
| 247 | - */ |
|
| 248 | - public function getProtocol(); |
|
| 33 | + /** |
|
| 34 | + * set uid of the recipient |
|
| 35 | + * |
|
| 36 | + * @param string $user |
|
| 37 | + * |
|
| 38 | + * @since 14.0.0 |
|
| 39 | + */ |
|
| 40 | + public function setShareWith($user); |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * set resource name (e.g. file, calendar, contact,...) |
|
| 44 | + * |
|
| 45 | + * @param string $name |
|
| 46 | + * |
|
| 47 | + * @since 14.0.0 |
|
| 48 | + */ |
|
| 49 | + public function setResourceName($name); |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * set resource type (e.g. file, calendar, contact,...) |
|
| 53 | + * |
|
| 54 | + * @param string $resourceType |
|
| 55 | + * |
|
| 56 | + * @since 14.0.0 |
|
| 57 | + */ |
|
| 58 | + public function setResourceType($resourceType); |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * set resource description (optional) |
|
| 62 | + * |
|
| 63 | + * @param string $description |
|
| 64 | + * |
|
| 65 | + * @since 14.0.0 |
|
| 66 | + */ |
|
| 67 | + public function setDescription($description); |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * set provider ID (e.g. file ID) |
|
| 71 | + * |
|
| 72 | + * @param string $providerId |
|
| 73 | + * |
|
| 74 | + * @since 14.0.0 |
|
| 75 | + */ |
|
| 76 | + public function setProviderId($providerId); |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * set owner UID |
|
| 80 | + * |
|
| 81 | + * @param string $owner |
|
| 82 | + * |
|
| 83 | + * @since 14.0.0 |
|
| 84 | + */ |
|
| 85 | + public function setOwner($owner); |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * set owner display name |
|
| 89 | + * |
|
| 90 | + * @param string $ownerDisplayName |
|
| 91 | + * |
|
| 92 | + * @since 14.0.0 |
|
| 93 | + */ |
|
| 94 | + public function setOwnerDisplayName($ownerDisplayName); |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * set UID of the user who sends the share |
|
| 98 | + * |
|
| 99 | + * @param string $sharedBy |
|
| 100 | + * |
|
| 101 | + * @since 14.0.0 |
|
| 102 | + */ |
|
| 103 | + public function setSharedBy($sharedBy); |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * set display name of the user who sends the share |
|
| 107 | + * |
|
| 108 | + * @param $sharedByDisplayName |
|
| 109 | + * |
|
| 110 | + * @since 14.0.0 |
|
| 111 | + */ |
|
| 112 | + public function setSharedByDisplayName($sharedByDisplayName); |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * set protocol specification |
|
| 116 | + * |
|
| 117 | + * @param array $protocol |
|
| 118 | + * |
|
| 119 | + * @since 14.0.0 |
|
| 120 | + */ |
|
| 121 | + public function setProtocol(array $protocol); |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * share type (group or user) |
|
| 125 | + * |
|
| 126 | + * @param string $shareType |
|
| 127 | + * |
|
| 128 | + * @since 14.0.0 |
|
| 129 | + */ |
|
| 130 | + public function setShareType($shareType); |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * get the whole share, ready to send out |
|
| 134 | + * |
|
| 135 | + * @return array |
|
| 136 | + * |
|
| 137 | + * @since 14.0.0 |
|
| 138 | + */ |
|
| 139 | + public function getShare(); |
|
| 140 | + |
|
| 141 | + /** |
|
| 142 | + * get uid of the recipient |
|
| 143 | + * |
|
| 144 | + * @return string |
|
| 145 | + * |
|
| 146 | + * @since 14.0.0 |
|
| 147 | + */ |
|
| 148 | + public function getShareWith(); |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * get resource name (e.g. file, calendar, contact,...) |
|
| 152 | + * |
|
| 153 | + * @return string |
|
| 154 | + * |
|
| 155 | + * @since 14.0.0 |
|
| 156 | + */ |
|
| 157 | + public function getResourceName(); |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * get resource type (e.g. file, calendar, contact,...) |
|
| 161 | + * |
|
| 162 | + * @return string |
|
| 163 | + * |
|
| 164 | + * @since 14.0.0 |
|
| 165 | + */ |
|
| 166 | + public function getResourceType(); |
|
| 167 | + |
|
| 168 | + /** |
|
| 169 | + * get resource description (optional) |
|
| 170 | + * |
|
| 171 | + * @return string |
|
| 172 | + * |
|
| 173 | + * @since 14.0.0 |
|
| 174 | + */ |
|
| 175 | + public function getDescription(); |
|
| 176 | + |
|
| 177 | + /** |
|
| 178 | + * get provider ID (e.g. file ID) |
|
| 179 | + * |
|
| 180 | + * @return string |
|
| 181 | + * |
|
| 182 | + * @since 14.0.0 |
|
| 183 | + */ |
|
| 184 | + public function getProviderId(); |
|
| 185 | + |
|
| 186 | + /** |
|
| 187 | + * get owner UID |
|
| 188 | + * |
|
| 189 | + * @return string |
|
| 190 | + * |
|
| 191 | + * @since 14.0.0 |
|
| 192 | + */ |
|
| 193 | + public function getOwner(); |
|
| 194 | + |
|
| 195 | + /** |
|
| 196 | + * get owner display name |
|
| 197 | + * |
|
| 198 | + * @return string |
|
| 199 | + * |
|
| 200 | + * @since 14.0.0 |
|
| 201 | + */ |
|
| 202 | + public function getOwnerDisplayName(); |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * get UID of the user who sends the share |
|
| 206 | + * |
|
| 207 | + * @return string |
|
| 208 | + * |
|
| 209 | + * @since 14.0.0 |
|
| 210 | + */ |
|
| 211 | + public function getSharedBy(); |
|
| 212 | + |
|
| 213 | + /** |
|
| 214 | + * get display name of the user who sends the share |
|
| 215 | + * |
|
| 216 | + * @return string |
|
| 217 | + * |
|
| 218 | + * @since 14.0.0 |
|
| 219 | + */ |
|
| 220 | + public function getSharedByDisplayName(); |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * get share type (group or user) |
|
| 224 | + * |
|
| 225 | + * @return string |
|
| 226 | + * |
|
| 227 | + * @since 14.0.0 |
|
| 228 | + */ |
|
| 229 | + public function getShareType(); |
|
| 230 | + |
|
| 231 | + /** |
|
| 232 | + * get share Secret |
|
| 233 | + * |
|
| 234 | + * @return string |
|
| 235 | + * |
|
| 236 | + * @since 14.0.0 |
|
| 237 | + */ |
|
| 238 | + public function getShareSecret(); |
|
| 239 | + |
|
| 240 | + |
|
| 241 | + /** |
|
| 242 | + * get protocol specification |
|
| 243 | + * |
|
| 244 | + * @return array |
|
| 245 | + * |
|
| 246 | + * @since 14.0.0 |
|
| 247 | + */ |
|
| 248 | + public function getProtocol(); |
|
| 249 | 249 | |
| 250 | 250 | } |
@@ -33,19 +33,19 @@ |
||
| 33 | 33 | */ |
| 34 | 34 | class ProviderCouldNotAddShareException extends HintException { |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * ProviderCouldNotAddShareException constructor. |
|
| 38 | - * |
|
| 39 | - * @since 14.0.0 |
|
| 40 | - * |
|
| 41 | - * @param string $message |
|
| 42 | - * @param string $hint |
|
| 43 | - * @param int $code |
|
| 44 | - * @param \Exception|null $previous |
|
| 45 | - */ |
|
| 46 | - public function __construct($message, $hint = '', $code = Http::STATUS_BAD_REQUEST, \Exception $previous = null) { |
|
| 47 | - parent::__construct($message, $hint, $code, $previous); |
|
| 48 | - } |
|
| 36 | + /** |
|
| 37 | + * ProviderCouldNotAddShareException constructor. |
|
| 38 | + * |
|
| 39 | + * @since 14.0.0 |
|
| 40 | + * |
|
| 41 | + * @param string $message |
|
| 42 | + * @param string $hint |
|
| 43 | + * @param int $code |
|
| 44 | + * @param \Exception|null $previous |
|
| 45 | + */ |
|
| 46 | + public function __construct($message, $hint = '', $code = Http::STATUS_BAD_REQUEST, \Exception $previous = null) { |
|
| 47 | + parent::__construct($message, $hint, $code, $previous); |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | 50 | |
| 51 | 51 | } |
@@ -30,33 +30,33 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | interface ICloudFederationFactory { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * get a CloudFederationShare Object to prepare a share you want to send |
|
| 35 | - * |
|
| 36 | - * @param string $shareWith |
|
| 37 | - * @param string $name resource name (e.g. document.odt) |
|
| 38 | - * @param string $description share description (optional) |
|
| 39 | - * @param string $providerId resource UID on the provider side |
|
| 40 | - * @param string $owner provider specific UID of the user who owns the resource |
|
| 41 | - * @param string $ownerDisplayName display name of the user who shared the item |
|
| 42 | - * @param string $sharedBy provider specific UID of the user who shared the resource |
|
| 43 | - * @param string $sharedByDisplayName display name of the user who shared the resource |
|
| 44 | - * @param string $sharedSecret used to authenticate requests across servers |
|
| 45 | - * @param string $shareType ('group' or 'user' share) |
|
| 46 | - * @param $resourceType ('file', 'calendar',...) |
|
| 47 | - * @return ICloudFederationShare |
|
| 48 | - * |
|
| 49 | - * @since 14.0.0 |
|
| 50 | - */ |
|
| 51 | - public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType); |
|
| 33 | + /** |
|
| 34 | + * get a CloudFederationShare Object to prepare a share you want to send |
|
| 35 | + * |
|
| 36 | + * @param string $shareWith |
|
| 37 | + * @param string $name resource name (e.g. document.odt) |
|
| 38 | + * @param string $description share description (optional) |
|
| 39 | + * @param string $providerId resource UID on the provider side |
|
| 40 | + * @param string $owner provider specific UID of the user who owns the resource |
|
| 41 | + * @param string $ownerDisplayName display name of the user who shared the item |
|
| 42 | + * @param string $sharedBy provider specific UID of the user who shared the resource |
|
| 43 | + * @param string $sharedByDisplayName display name of the user who shared the resource |
|
| 44 | + * @param string $sharedSecret used to authenticate requests across servers |
|
| 45 | + * @param string $shareType ('group' or 'user' share) |
|
| 46 | + * @param $resourceType ('file', 'calendar',...) |
|
| 47 | + * @return ICloudFederationShare |
|
| 48 | + * |
|
| 49 | + * @since 14.0.0 |
|
| 50 | + */ |
|
| 51 | + public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType); |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * get a Cloud FederationNotification object to prepare a notification you |
|
| 55 | - * want to send |
|
| 56 | - * |
|
| 57 | - * @return ICloudFederationNotification |
|
| 58 | - * |
|
| 59 | - * @since 14.0.0 |
|
| 60 | - */ |
|
| 61 | - public function getCloudFederationNotification(); |
|
| 53 | + /** |
|
| 54 | + * get a Cloud FederationNotification object to prepare a notification you |
|
| 55 | + * want to send |
|
| 56 | + * |
|
| 57 | + * @return ICloudFederationNotification |
|
| 58 | + * |
|
| 59 | + * @since 14.0.0 |
|
| 60 | + */ |
|
| 61 | + public function getCloudFederationNotification(); |
|
| 62 | 62 | } |
@@ -32,17 +32,17 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | class AuthenticationFailedException extends HintException { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * BadRequestException constructor. |
|
| 37 | - * |
|
| 38 | - * @since 14.0.0 |
|
| 39 | - * |
|
| 40 | - */ |
|
| 41 | - public function __construct() { |
|
| 42 | - $l = \OC::$server->getL10N('federation'); |
|
| 43 | - $message = 'Authentication failed, wrong token or provider ID given'; |
|
| 44 | - $hint = $l->t('Authentication failed, wrong token or provider ID given'); |
|
| 45 | - parent::__construct($message, $hint); |
|
| 46 | - } |
|
| 35 | + /** |
|
| 36 | + * BadRequestException constructor. |
|
| 37 | + * |
|
| 38 | + * @since 14.0.0 |
|
| 39 | + * |
|
| 40 | + */ |
|
| 41 | + public function __construct() { |
|
| 42 | + $l = \OC::$server->getL10N('federation'); |
|
| 43 | + $message = 'Authentication failed, wrong token or provider ID given'; |
|
| 44 | + $hint = $l->t('Authentication failed, wrong token or provider ID given'); |
|
| 45 | + parent::__construct($message, $hint); |
|
| 46 | + } |
|
| 47 | 47 | |
| 48 | 48 | } |
@@ -45,69 +45,69 @@ |
||
| 45 | 45 | */ |
| 46 | 46 | interface ISession { |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Set a value in the session |
|
| 50 | - * |
|
| 51 | - * @param string $key |
|
| 52 | - * @param mixed $value |
|
| 53 | - * @since 6.0.0 |
|
| 54 | - */ |
|
| 55 | - public function set(string $key, $value); |
|
| 48 | + /** |
|
| 49 | + * Set a value in the session |
|
| 50 | + * |
|
| 51 | + * @param string $key |
|
| 52 | + * @param mixed $value |
|
| 53 | + * @since 6.0.0 |
|
| 54 | + */ |
|
| 55 | + public function set(string $key, $value); |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Get a value from the session |
|
| 59 | - * |
|
| 60 | - * @param string $key |
|
| 61 | - * @return mixed should return null if $key does not exist |
|
| 62 | - * @since 6.0.0 |
|
| 63 | - */ |
|
| 64 | - public function get(string $key); |
|
| 57 | + /** |
|
| 58 | + * Get a value from the session |
|
| 59 | + * |
|
| 60 | + * @param string $key |
|
| 61 | + * @return mixed should return null if $key does not exist |
|
| 62 | + * @since 6.0.0 |
|
| 63 | + */ |
|
| 64 | + public function get(string $key); |
|
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Check if a named key exists in the session |
|
| 68 | - * |
|
| 69 | - * @param string $key |
|
| 70 | - * @return bool |
|
| 71 | - * @since 6.0.0 |
|
| 72 | - */ |
|
| 73 | - public function exists(string $key): bool; |
|
| 66 | + /** |
|
| 67 | + * Check if a named key exists in the session |
|
| 68 | + * |
|
| 69 | + * @param string $key |
|
| 70 | + * @return bool |
|
| 71 | + * @since 6.0.0 |
|
| 72 | + */ |
|
| 73 | + public function exists(string $key): bool; |
|
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * Remove a $key/$value pair from the session |
|
| 77 | - * |
|
| 78 | - * @param string $key |
|
| 79 | - * @since 6.0.0 |
|
| 80 | - */ |
|
| 81 | - public function remove(string $key); |
|
| 75 | + /** |
|
| 76 | + * Remove a $key/$value pair from the session |
|
| 77 | + * |
|
| 78 | + * @param string $key |
|
| 79 | + * @since 6.0.0 |
|
| 80 | + */ |
|
| 81 | + public function remove(string $key); |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Reset and recreate the session |
|
| 85 | - * @since 6.0.0 |
|
| 86 | - */ |
|
| 87 | - public function clear(); |
|
| 83 | + /** |
|
| 84 | + * Reset and recreate the session |
|
| 85 | + * @since 6.0.0 |
|
| 86 | + */ |
|
| 87 | + public function clear(); |
|
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Close the session and release the lock |
|
| 91 | - * @since 7.0.0 |
|
| 92 | - */ |
|
| 93 | - public function close(); |
|
| 89 | + /** |
|
| 90 | + * Close the session and release the lock |
|
| 91 | + * @since 7.0.0 |
|
| 92 | + */ |
|
| 93 | + public function close(); |
|
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * Wrapper around session_regenerate_id |
|
| 97 | - * |
|
| 98 | - * @param bool $deleteOldSession Whether to delete the old associated session file or not. |
|
| 99 | - * @param bool $updateToken Wheater to update the associated auth token |
|
| 100 | - * @return void |
|
| 101 | - * @since 9.0.0, $updateToken added in 14.0.0 |
|
| 102 | - */ |
|
| 103 | - public function regenerateId(bool $deleteOldSession = true, bool $updateToken = false); |
|
| 95 | + /** |
|
| 96 | + * Wrapper around session_regenerate_id |
|
| 97 | + * |
|
| 98 | + * @param bool $deleteOldSession Whether to delete the old associated session file or not. |
|
| 99 | + * @param bool $updateToken Wheater to update the associated auth token |
|
| 100 | + * @return void |
|
| 101 | + * @since 9.0.0, $updateToken added in 14.0.0 |
|
| 102 | + */ |
|
| 103 | + public function regenerateId(bool $deleteOldSession = true, bool $updateToken = false); |
|
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Wrapper around session_id |
|
| 107 | - * |
|
| 108 | - * @return string |
|
| 109 | - * @throws SessionNotAvailableException |
|
| 110 | - * @since 9.1.0 |
|
| 111 | - */ |
|
| 112 | - public function getId(): string; |
|
| 105 | + /** |
|
| 106 | + * Wrapper around session_id |
|
| 107 | + * |
|
| 108 | + * @return string |
|
| 109 | + * @throws SessionNotAvailableException |
|
| 110 | + * @since 9.1.0 |
|
| 111 | + */ |
|
| 112 | + public function getId(): string; |
|
| 113 | 113 | } |