@@ -28,10 +28,10 @@ |
||
| 28 | 28 | <?php if((int)$trustedServer['status'] === TrustedServers::STATUS_OK) { ?> |
| 29 | 29 | <span class="status success"></span> |
| 30 | 30 | <?php |
| 31 | - } elseif( |
|
| 32 | - (int)$trustedServer['status'] === TrustedServers::STATUS_PENDING || |
|
| 33 | - (int)$trustedServer['status'] === TrustedServers::STATUS_ACCESS_REVOKED |
|
| 34 | - ) { ?> |
|
| 31 | + } elseif( |
|
| 32 | + (int)$trustedServer['status'] === TrustedServers::STATUS_PENDING || |
|
| 33 | + (int)$trustedServer['status'] === TrustedServers::STATUS_ACCESS_REVOKED |
|
| 34 | + ) { ?> |
|
| 35 | 35 | <span class="status indeterminate"></span> |
| 36 | 36 | <?php } else {?> |
| 37 | 37 | <span class="status error"></span> |
@@ -11,19 +11,19 @@ |
||
| 11 | 11 | <p class="settings-hint"><?php p($l->t('Federation allows you to connect with other trusted servers to exchange the user directory. For example this will be used to auto-complete external users for federated sharing.')); ?></p> |
| 12 | 12 | |
| 13 | 13 | <p> |
| 14 | - <input id="autoAddServers" type="checkbox" class="checkbox" <?php if($_['autoAddServers']) p('checked'); ?> /> |
|
| 14 | + <input id="autoAddServers" type="checkbox" class="checkbox" <?php if ($_['autoAddServers']) p('checked'); ?> /> |
|
| 15 | 15 | <label for="autoAddServers"><?php p($l->t('Add server automatically once a federated share was created successfully')); ?></label> |
| 16 | 16 | </p> |
| 17 | 17 | |
| 18 | 18 | <ul id="listOfTrustedServers"> |
| 19 | - <?php foreach($_['trustedServers'] as $trustedServer) { ?> |
|
| 19 | + <?php foreach ($_['trustedServers'] as $trustedServer) { ?> |
|
| 20 | 20 | <li id="<?php p($trustedServer['id']); ?>"> |
| 21 | - <?php if((int)$trustedServer['status'] === TrustedServers::STATUS_OK) { ?> |
|
| 21 | + <?php if ((int) $trustedServer['status'] === TrustedServers::STATUS_OK) { ?> |
|
| 22 | 22 | <span class="status success"></span> |
| 23 | 23 | <?php |
| 24 | - } elseif( |
|
| 25 | - (int)$trustedServer['status'] === TrustedServers::STATUS_PENDING || |
|
| 26 | - (int)$trustedServer['status'] === TrustedServers::STATUS_ACCESS_REVOKED |
|
| 24 | + } elseif ( |
|
| 25 | + (int) $trustedServer['status'] === TrustedServers::STATUS_PENDING || |
|
| 26 | + (int) $trustedServer['status'] === TrustedServers::STATUS_ACCESS_REVOKED |
|
| 27 | 27 | ) { ?> |
| 28 | 28 | <span class="status indeterminate"></span> |
| 29 | 29 | <?php } else {?> |
@@ -11,7 +11,10 @@ |
||
| 11 | 11 | <p class="settings-hint"><?php p($l->t('Federation allows you to connect with other trusted servers to exchange the user directory. For example this will be used to auto-complete external users for federated sharing.')); ?></p> |
| 12 | 12 | |
| 13 | 13 | <p> |
| 14 | - <input id="autoAddServers" type="checkbox" class="checkbox" <?php if($_['autoAddServers']) p('checked'); ?> /> |
|
| 14 | + <input id="autoAddServers" type="checkbox" class="checkbox" <?php if($_['autoAddServers']) { |
|
| 15 | + p('checked'); |
|
| 16 | +} |
|
| 17 | +?> /> |
|
| 15 | 18 | <label for="autoAddServers"><?php p($l->t('Add server automatically once a federated share was created successfully')); ?></label> |
| 16 | 19 | </p> |
| 17 | 20 | |
@@ -44,7 +44,7 @@ discard block |
||
| 44 | 44 | * |
| 45 | 45 | * @package OCA\Federation\Controller |
| 46 | 46 | */ |
| 47 | -class OCSAuthAPIController extends OCSController{ |
|
| 47 | +class OCSAuthAPIController extends OCSController { |
|
| 48 | 48 | |
| 49 | 49 | /** @var ISecureRandom */ |
| 50 | 50 | private $secureRandom; |
@@ -103,7 +103,7 @@ discard block |
||
| 103 | 103 | */ |
| 104 | 104 | public function requestSharedSecret($url, $token) { |
| 105 | 105 | if ($this->trustedServers->isTrustedServer($url) === false) { |
| 106 | - $this->logger->error('remote server not trusted (' . $url . ') while requesting shared secret', ['app' => 'federation']); |
|
| 106 | + $this->logger->error('remote server not trusted ('.$url.') while requesting shared secret', ['app' => 'federation']); |
|
| 107 | 107 | throw new OCSForbiddenException(); |
| 108 | 108 | } |
| 109 | 109 | |
@@ -112,7 +112,7 @@ discard block |
||
| 112 | 112 | $localToken = $this->dbHandler->getToken($url); |
| 113 | 113 | if (strcmp($localToken, $token) > 0) { |
| 114 | 114 | $this->logger->info( |
| 115 | - 'remote server (' . $url . ') presented lower token. We will initiate the exchange of the shared secret.', |
|
| 115 | + 'remote server ('.$url.') presented lower token. We will initiate the exchange of the shared secret.', |
|
| 116 | 116 | ['app' => 'federation'] |
| 117 | 117 | ); |
| 118 | 118 | throw new OCSForbiddenException(); |
@@ -151,14 +151,14 @@ discard block |
||
| 151 | 151 | */ |
| 152 | 152 | public function getSharedSecret($url, $token) { |
| 153 | 153 | if ($this->trustedServers->isTrustedServer($url) === false) { |
| 154 | - $this->logger->error('remote server not trusted (' . $url . ') while getting shared secret', ['app' => 'federation']); |
|
| 154 | + $this->logger->error('remote server not trusted ('.$url.') while getting shared secret', ['app' => 'federation']); |
|
| 155 | 155 | throw new OCSForbiddenException(); |
| 156 | 156 | } |
| 157 | 157 | |
| 158 | 158 | if ($this->isValidToken($url, $token) === false) { |
| 159 | 159 | $expectedToken = $this->dbHandler->getToken($url); |
| 160 | 160 | $this->logger->error( |
| 161 | - 'remote server (' . $url . ') didn\'t send a valid token (got "' . $token . '" but expected "'. $expectedToken . '") while getting shared secret', |
|
| 161 | + 'remote server ('.$url.') didn\'t send a valid token (got "'.$token.'" but expected "'.$expectedToken.'") while getting shared secret', |
|
| 162 | 162 | ['app' => 'federation'] |
| 163 | 163 | ); |
| 164 | 164 | throw new OCSForbiddenException(); |
@@ -47,166 +47,166 @@ |
||
| 47 | 47 | */ |
| 48 | 48 | class OCSAuthAPIController extends OCSController{ |
| 49 | 49 | |
| 50 | - /** @var ISecureRandom */ |
|
| 51 | - private $secureRandom; |
|
| 52 | - |
|
| 53 | - /** @var IJobList */ |
|
| 54 | - private $jobList; |
|
| 55 | - |
|
| 56 | - /** @var TrustedServers */ |
|
| 57 | - private $trustedServers; |
|
| 58 | - |
|
| 59 | - /** @var DbHandler */ |
|
| 60 | - private $dbHandler; |
|
| 61 | - |
|
| 62 | - /** @var ILogger */ |
|
| 63 | - private $logger; |
|
| 64 | - |
|
| 65 | - /** @var ITimeFactory */ |
|
| 66 | - private $timeFactory; |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * OCSAuthAPI constructor. |
|
| 70 | - * |
|
| 71 | - * @param string $appName |
|
| 72 | - * @param IRequest $request |
|
| 73 | - * @param ISecureRandom $secureRandom |
|
| 74 | - * @param IJobList $jobList |
|
| 75 | - * @param TrustedServers $trustedServers |
|
| 76 | - * @param DbHandler $dbHandler |
|
| 77 | - * @param ILogger $logger |
|
| 78 | - * @param ITimeFactory $timeFactory |
|
| 79 | - */ |
|
| 80 | - public function __construct( |
|
| 81 | - $appName, |
|
| 82 | - IRequest $request, |
|
| 83 | - ISecureRandom $secureRandom, |
|
| 84 | - IJobList $jobList, |
|
| 85 | - TrustedServers $trustedServers, |
|
| 86 | - DbHandler $dbHandler, |
|
| 87 | - ILogger $logger, |
|
| 88 | - ITimeFactory $timeFactory |
|
| 89 | - ) { |
|
| 90 | - parent::__construct($appName, $request); |
|
| 91 | - |
|
| 92 | - $this->secureRandom = $secureRandom; |
|
| 93 | - $this->jobList = $jobList; |
|
| 94 | - $this->trustedServers = $trustedServers; |
|
| 95 | - $this->dbHandler = $dbHandler; |
|
| 96 | - $this->logger = $logger; |
|
| 97 | - $this->timeFactory = $timeFactory; |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - /** |
|
| 101 | - * @NoCSRFRequired |
|
| 102 | - * @PublicPage |
|
| 103 | - * |
|
| 104 | - * request received to ask remote server for a shared secret, for legacy end-points |
|
| 105 | - * |
|
| 106 | - * @param string $url |
|
| 107 | - * @param string $token |
|
| 108 | - * @return Http\DataResponse |
|
| 109 | - * @throws OCSForbiddenException |
|
| 110 | - */ |
|
| 111 | - public function requestSharedSecretLegacy($url, $token) { |
|
| 112 | - return $this->requestSharedSecret($url, $token); |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * @NoCSRFRequired |
|
| 118 | - * @PublicPage |
|
| 119 | - * |
|
| 120 | - * create shared secret and return it, for legacy end-points |
|
| 121 | - * |
|
| 122 | - * @param string $url |
|
| 123 | - * @param string $token |
|
| 124 | - * @return Http\DataResponse |
|
| 125 | - * @throws OCSForbiddenException |
|
| 126 | - */ |
|
| 127 | - public function getSharedSecretLegacy($url, $token) { |
|
| 128 | - return $this->getSharedSecret($url, $token); |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * @NoCSRFRequired |
|
| 133 | - * @PublicPage |
|
| 134 | - * |
|
| 135 | - * request received to ask remote server for a shared secret |
|
| 136 | - * |
|
| 137 | - * @param string $url |
|
| 138 | - * @param string $token |
|
| 139 | - * @return Http\DataResponse |
|
| 140 | - * @throws OCSForbiddenException |
|
| 141 | - */ |
|
| 142 | - public function requestSharedSecret($url, $token) { |
|
| 143 | - if ($this->trustedServers->isTrustedServer($url) === false) { |
|
| 144 | - $this->logger->error('remote server not trusted (' . $url . ') while requesting shared secret', ['app' => 'federation']); |
|
| 145 | - throw new OCSForbiddenException(); |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - // if both server initiated the exchange of the shared secret the greater |
|
| 149 | - // token wins |
|
| 150 | - $localToken = $this->dbHandler->getToken($url); |
|
| 151 | - if (strcmp($localToken, $token) > 0) { |
|
| 152 | - $this->logger->info( |
|
| 153 | - 'remote server (' . $url . ') presented lower token. We will initiate the exchange of the shared secret.', |
|
| 154 | - ['app' => 'federation'] |
|
| 155 | - ); |
|
| 156 | - throw new OCSForbiddenException(); |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - $this->jobList->add( |
|
| 160 | - 'OCA\Federation\BackgroundJob\GetSharedSecret', |
|
| 161 | - [ |
|
| 162 | - 'url' => $url, |
|
| 163 | - 'token' => $token, |
|
| 164 | - 'created' => $this->timeFactory->getTime() |
|
| 165 | - ] |
|
| 166 | - ); |
|
| 167 | - |
|
| 168 | - return new Http\DataResponse(); |
|
| 169 | - } |
|
| 170 | - |
|
| 171 | - /** |
|
| 172 | - * @NoCSRFRequired |
|
| 173 | - * @PublicPage |
|
| 174 | - * |
|
| 175 | - * create shared secret and return it |
|
| 176 | - * |
|
| 177 | - * @param string $url |
|
| 178 | - * @param string $token |
|
| 179 | - * @return Http\DataResponse |
|
| 180 | - * @throws OCSForbiddenException |
|
| 181 | - */ |
|
| 182 | - public function getSharedSecret($url, $token) { |
|
| 183 | - if ($this->trustedServers->isTrustedServer($url) === false) { |
|
| 184 | - $this->logger->error('remote server not trusted (' . $url . ') while getting shared secret', ['app' => 'federation']); |
|
| 185 | - throw new OCSForbiddenException(); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - if ($this->isValidToken($url, $token) === false) { |
|
| 189 | - $expectedToken = $this->dbHandler->getToken($url); |
|
| 190 | - $this->logger->error( |
|
| 191 | - 'remote server (' . $url . ') didn\'t send a valid token (got "' . $token . '" but expected "'. $expectedToken . '") while getting shared secret', |
|
| 192 | - ['app' => 'federation'] |
|
| 193 | - ); |
|
| 194 | - throw new OCSForbiddenException(); |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - $sharedSecret = $this->secureRandom->generate(32); |
|
| 198 | - |
|
| 199 | - $this->trustedServers->addSharedSecret($url, $sharedSecret); |
|
| 200 | - // reset token after the exchange of the shared secret was successful |
|
| 201 | - $this->dbHandler->addToken($url, ''); |
|
| 202 | - |
|
| 203 | - return new Http\DataResponse([ |
|
| 204 | - 'sharedSecret' => $sharedSecret |
|
| 205 | - ]); |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - protected function isValidToken($url, $token) { |
|
| 209 | - $storedToken = $this->dbHandler->getToken($url); |
|
| 210 | - return hash_equals($storedToken, $token); |
|
| 211 | - } |
|
| 50 | + /** @var ISecureRandom */ |
|
| 51 | + private $secureRandom; |
|
| 52 | + |
|
| 53 | + /** @var IJobList */ |
|
| 54 | + private $jobList; |
|
| 55 | + |
|
| 56 | + /** @var TrustedServers */ |
|
| 57 | + private $trustedServers; |
|
| 58 | + |
|
| 59 | + /** @var DbHandler */ |
|
| 60 | + private $dbHandler; |
|
| 61 | + |
|
| 62 | + /** @var ILogger */ |
|
| 63 | + private $logger; |
|
| 64 | + |
|
| 65 | + /** @var ITimeFactory */ |
|
| 66 | + private $timeFactory; |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * OCSAuthAPI constructor. |
|
| 70 | + * |
|
| 71 | + * @param string $appName |
|
| 72 | + * @param IRequest $request |
|
| 73 | + * @param ISecureRandom $secureRandom |
|
| 74 | + * @param IJobList $jobList |
|
| 75 | + * @param TrustedServers $trustedServers |
|
| 76 | + * @param DbHandler $dbHandler |
|
| 77 | + * @param ILogger $logger |
|
| 78 | + * @param ITimeFactory $timeFactory |
|
| 79 | + */ |
|
| 80 | + public function __construct( |
|
| 81 | + $appName, |
|
| 82 | + IRequest $request, |
|
| 83 | + ISecureRandom $secureRandom, |
|
| 84 | + IJobList $jobList, |
|
| 85 | + TrustedServers $trustedServers, |
|
| 86 | + DbHandler $dbHandler, |
|
| 87 | + ILogger $logger, |
|
| 88 | + ITimeFactory $timeFactory |
|
| 89 | + ) { |
|
| 90 | + parent::__construct($appName, $request); |
|
| 91 | + |
|
| 92 | + $this->secureRandom = $secureRandom; |
|
| 93 | + $this->jobList = $jobList; |
|
| 94 | + $this->trustedServers = $trustedServers; |
|
| 95 | + $this->dbHandler = $dbHandler; |
|
| 96 | + $this->logger = $logger; |
|
| 97 | + $this->timeFactory = $timeFactory; |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + /** |
|
| 101 | + * @NoCSRFRequired |
|
| 102 | + * @PublicPage |
|
| 103 | + * |
|
| 104 | + * request received to ask remote server for a shared secret, for legacy end-points |
|
| 105 | + * |
|
| 106 | + * @param string $url |
|
| 107 | + * @param string $token |
|
| 108 | + * @return Http\DataResponse |
|
| 109 | + * @throws OCSForbiddenException |
|
| 110 | + */ |
|
| 111 | + public function requestSharedSecretLegacy($url, $token) { |
|
| 112 | + return $this->requestSharedSecret($url, $token); |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * @NoCSRFRequired |
|
| 118 | + * @PublicPage |
|
| 119 | + * |
|
| 120 | + * create shared secret and return it, for legacy end-points |
|
| 121 | + * |
|
| 122 | + * @param string $url |
|
| 123 | + * @param string $token |
|
| 124 | + * @return Http\DataResponse |
|
| 125 | + * @throws OCSForbiddenException |
|
| 126 | + */ |
|
| 127 | + public function getSharedSecretLegacy($url, $token) { |
|
| 128 | + return $this->getSharedSecret($url, $token); |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * @NoCSRFRequired |
|
| 133 | + * @PublicPage |
|
| 134 | + * |
|
| 135 | + * request received to ask remote server for a shared secret |
|
| 136 | + * |
|
| 137 | + * @param string $url |
|
| 138 | + * @param string $token |
|
| 139 | + * @return Http\DataResponse |
|
| 140 | + * @throws OCSForbiddenException |
|
| 141 | + */ |
|
| 142 | + public function requestSharedSecret($url, $token) { |
|
| 143 | + if ($this->trustedServers->isTrustedServer($url) === false) { |
|
| 144 | + $this->logger->error('remote server not trusted (' . $url . ') while requesting shared secret', ['app' => 'federation']); |
|
| 145 | + throw new OCSForbiddenException(); |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + // if both server initiated the exchange of the shared secret the greater |
|
| 149 | + // token wins |
|
| 150 | + $localToken = $this->dbHandler->getToken($url); |
|
| 151 | + if (strcmp($localToken, $token) > 0) { |
|
| 152 | + $this->logger->info( |
|
| 153 | + 'remote server (' . $url . ') presented lower token. We will initiate the exchange of the shared secret.', |
|
| 154 | + ['app' => 'federation'] |
|
| 155 | + ); |
|
| 156 | + throw new OCSForbiddenException(); |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + $this->jobList->add( |
|
| 160 | + 'OCA\Federation\BackgroundJob\GetSharedSecret', |
|
| 161 | + [ |
|
| 162 | + 'url' => $url, |
|
| 163 | + 'token' => $token, |
|
| 164 | + 'created' => $this->timeFactory->getTime() |
|
| 165 | + ] |
|
| 166 | + ); |
|
| 167 | + |
|
| 168 | + return new Http\DataResponse(); |
|
| 169 | + } |
|
| 170 | + |
|
| 171 | + /** |
|
| 172 | + * @NoCSRFRequired |
|
| 173 | + * @PublicPage |
|
| 174 | + * |
|
| 175 | + * create shared secret and return it |
|
| 176 | + * |
|
| 177 | + * @param string $url |
|
| 178 | + * @param string $token |
|
| 179 | + * @return Http\DataResponse |
|
| 180 | + * @throws OCSForbiddenException |
|
| 181 | + */ |
|
| 182 | + public function getSharedSecret($url, $token) { |
|
| 183 | + if ($this->trustedServers->isTrustedServer($url) === false) { |
|
| 184 | + $this->logger->error('remote server not trusted (' . $url . ') while getting shared secret', ['app' => 'federation']); |
|
| 185 | + throw new OCSForbiddenException(); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + if ($this->isValidToken($url, $token) === false) { |
|
| 189 | + $expectedToken = $this->dbHandler->getToken($url); |
|
| 190 | + $this->logger->error( |
|
| 191 | + 'remote server (' . $url . ') didn\'t send a valid token (got "' . $token . '" but expected "'. $expectedToken . '") while getting shared secret', |
|
| 192 | + ['app' => 'federation'] |
|
| 193 | + ); |
|
| 194 | + throw new OCSForbiddenException(); |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + $sharedSecret = $this->secureRandom->generate(32); |
|
| 198 | + |
|
| 199 | + $this->trustedServers->addSharedSecret($url, $sharedSecret); |
|
| 200 | + // reset token after the exchange of the shared secret was successful |
|
| 201 | + $this->dbHandler->addToken($url, ''); |
|
| 202 | + |
|
| 203 | + return new Http\DataResponse([ |
|
| 204 | + 'sharedSecret' => $sharedSecret |
|
| 205 | + ]); |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + protected function isValidToken($url, $token) { |
|
| 209 | + $storedToken = $this->dbHandler->getToken($url); |
|
| 210 | + return hash_equals($storedToken, $token); |
|
| 211 | + } |
|
| 212 | 212 | } |
@@ -60,7 +60,7 @@ |
||
| 60 | 60 | $progress->start(); |
| 61 | 61 | $this->syncService->syncThemAll(function($url, $ex) use ($progress, $output) { |
| 62 | 62 | if ($ex instanceof \Exception) { |
| 63 | - $output->writeln("Error while syncing $url : " . $ex->getMessage()); |
|
| 63 | + $output->writeln("Error while syncing $url : ".$ex->getMessage()); |
|
| 64 | 64 | |
| 65 | 65 | } else { |
| 66 | 66 | $progress->advance(); |
@@ -30,45 +30,45 @@ |
||
| 30 | 30 | |
| 31 | 31 | class SyncFederationAddressBooks extends Command { |
| 32 | 32 | |
| 33 | - /** @var \OCA\Federation\SyncFederationAddressBooks */ |
|
| 34 | - private $syncService; |
|
| 33 | + /** @var \OCA\Federation\SyncFederationAddressBooks */ |
|
| 34 | + private $syncService; |
|
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @param \OCA\Federation\SyncFederationAddressBooks $syncService |
|
| 38 | - */ |
|
| 39 | - public function __construct(\OCA\Federation\SyncFederationAddressBooks $syncService) { |
|
| 40 | - parent::__construct(); |
|
| 36 | + /** |
|
| 37 | + * @param \OCA\Federation\SyncFederationAddressBooks $syncService |
|
| 38 | + */ |
|
| 39 | + public function __construct(\OCA\Federation\SyncFederationAddressBooks $syncService) { |
|
| 40 | + parent::__construct(); |
|
| 41 | 41 | |
| 42 | - $this->syncService = $syncService; |
|
| 43 | - } |
|
| 42 | + $this->syncService = $syncService; |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - protected function configure() { |
|
| 46 | - $this |
|
| 47 | - ->setName('federation:sync-addressbooks') |
|
| 48 | - ->setDescription('Synchronizes addressbooks of all federated clouds'); |
|
| 49 | - } |
|
| 45 | + protected function configure() { |
|
| 46 | + $this |
|
| 47 | + ->setName('federation:sync-addressbooks') |
|
| 48 | + ->setDescription('Synchronizes addressbooks of all federated clouds'); |
|
| 49 | + } |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @param InputInterface $input |
|
| 53 | - * @param OutputInterface $output |
|
| 54 | - * @return int |
|
| 55 | - */ |
|
| 56 | - protected function execute(InputInterface $input, OutputInterface $output) { |
|
| 51 | + /** |
|
| 52 | + * @param InputInterface $input |
|
| 53 | + * @param OutputInterface $output |
|
| 54 | + * @return int |
|
| 55 | + */ |
|
| 56 | + protected function execute(InputInterface $input, OutputInterface $output) { |
|
| 57 | 57 | |
| 58 | - $progress = new ProgressBar($output); |
|
| 59 | - $progress->start(); |
|
| 60 | - $this->syncService->syncThemAll(function($url, $ex) use ($progress, $output) { |
|
| 61 | - if ($ex instanceof \Exception) { |
|
| 62 | - $output->writeln("Error while syncing $url : " . $ex->getMessage()); |
|
| 58 | + $progress = new ProgressBar($output); |
|
| 59 | + $progress->start(); |
|
| 60 | + $this->syncService->syncThemAll(function($url, $ex) use ($progress, $output) { |
|
| 61 | + if ($ex instanceof \Exception) { |
|
| 62 | + $output->writeln("Error while syncing $url : " . $ex->getMessage()); |
|
| 63 | 63 | |
| 64 | - } else { |
|
| 65 | - $progress->advance(); |
|
| 66 | - } |
|
| 67 | - }); |
|
| 64 | + } else { |
|
| 65 | + $progress->advance(); |
|
| 66 | + } |
|
| 67 | + }); |
|
| 68 | 68 | |
| 69 | - $progress->finish(); |
|
| 70 | - $output->writeln(''); |
|
| 69 | + $progress->finish(); |
|
| 70 | + $output->writeln(''); |
|
| 71 | 71 | |
| 72 | - return 0; |
|
| 73 | - } |
|
| 72 | + return 0; |
|
| 73 | + } |
|
| 74 | 74 | } |
@@ -177,7 +177,7 @@ |
||
| 177 | 177 | && $status !== Http::STATUS_FORBIDDEN |
| 178 | 178 | ) { |
| 179 | 179 | $this->retainJob = true; |
| 180 | - } else { |
|
| 180 | + } else { |
|
| 181 | 181 | // reset token if we received a valid response |
| 182 | 182 | $this->dbHandler->addToken($target, ''); |
| 183 | 183 | } |
@@ -57,213 +57,213 @@ |
||
| 57 | 57 | */ |
| 58 | 58 | class GetSharedSecret extends Job { |
| 59 | 59 | |
| 60 | - /** @var IClient */ |
|
| 61 | - private $httpClient; |
|
| 62 | - |
|
| 63 | - /** @var IJobList */ |
|
| 64 | - private $jobList; |
|
| 65 | - |
|
| 66 | - /** @var IURLGenerator */ |
|
| 67 | - private $urlGenerator; |
|
| 68 | - |
|
| 69 | - /** @var TrustedServers */ |
|
| 70 | - private $trustedServers; |
|
| 71 | - |
|
| 72 | - /** @var DbHandler */ |
|
| 73 | - private $dbHandler; |
|
| 74 | - |
|
| 75 | - /** @var IDiscoveryService */ |
|
| 76 | - private $ocsDiscoveryService; |
|
| 77 | - |
|
| 78 | - /** @var ILogger */ |
|
| 79 | - private $logger; |
|
| 80 | - |
|
| 81 | - /** @var ITimeFactory */ |
|
| 82 | - private $timeFactory; |
|
| 83 | - |
|
| 84 | - /** @var bool */ |
|
| 85 | - protected $retainJob = false; |
|
| 86 | - |
|
| 87 | - private $format = '?format=json'; |
|
| 88 | - |
|
| 89 | - private $defaultEndPoint = '/ocs/v2.php/apps/federation/api/v1/shared-secret'; |
|
| 90 | - |
|
| 91 | - /** @var int 30 day = 2592000sec */ |
|
| 92 | - private $maxLifespan = 2592000; |
|
| 93 | - |
|
| 94 | - /** |
|
| 95 | - * RequestSharedSecret constructor. |
|
| 96 | - * |
|
| 97 | - * @param IClientService $httpClientService |
|
| 98 | - * @param IURLGenerator $urlGenerator |
|
| 99 | - * @param IJobList $jobList |
|
| 100 | - * @param TrustedServers $trustedServers |
|
| 101 | - * @param ILogger $logger |
|
| 102 | - * @param DbHandler $dbHandler |
|
| 103 | - * @param IDiscoveryService $ocsDiscoveryService |
|
| 104 | - * @param ITimeFactory $timeFactory |
|
| 105 | - */ |
|
| 106 | - public function __construct( |
|
| 107 | - IClientService $httpClientService, |
|
| 108 | - IURLGenerator $urlGenerator, |
|
| 109 | - IJobList $jobList, |
|
| 110 | - TrustedServers $trustedServers, |
|
| 111 | - ILogger $logger, |
|
| 112 | - DbHandler $dbHandler, |
|
| 113 | - IDiscoveryService $ocsDiscoveryService, |
|
| 114 | - ITimeFactory $timeFactory |
|
| 115 | - ) { |
|
| 116 | - $this->logger = $logger; |
|
| 117 | - $this->httpClient = $httpClientService->newClient(); |
|
| 118 | - $this->jobList = $jobList; |
|
| 119 | - $this->urlGenerator = $urlGenerator; |
|
| 120 | - $this->dbHandler = $dbHandler; |
|
| 121 | - $this->ocsDiscoveryService = $ocsDiscoveryService; |
|
| 122 | - $this->trustedServers = $trustedServers; |
|
| 123 | - $this->timeFactory = $timeFactory; |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * run the job, then remove it from the joblist |
|
| 128 | - * |
|
| 129 | - * @param JobList $jobList |
|
| 130 | - * @param ILogger|null $logger |
|
| 131 | - */ |
|
| 132 | - public function execute($jobList, ILogger $logger = null) { |
|
| 133 | - $target = $this->argument['url']; |
|
| 134 | - // only execute if target is still in the list of trusted domains |
|
| 135 | - if ($this->trustedServers->isTrustedServer($target)) { |
|
| 136 | - $this->parentExecute($jobList, $logger); |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - $jobList->remove($this, $this->argument); |
|
| 140 | - |
|
| 141 | - if ($this->retainJob) { |
|
| 142 | - $this->reAddJob($this->argument); |
|
| 143 | - } |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * call execute() method of parent |
|
| 148 | - * |
|
| 149 | - * @param JobList $jobList |
|
| 150 | - * @param ILogger $logger |
|
| 151 | - */ |
|
| 152 | - protected function parentExecute($jobList, $logger = null) { |
|
| 153 | - parent::execute($jobList, $logger); |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - protected function run($argument) { |
|
| 157 | - $target = $argument['url']; |
|
| 158 | - $created = isset($argument['created']) ? (int)$argument['created'] : $this->timeFactory->getTime(); |
|
| 159 | - $currentTime = $this->timeFactory->getTime(); |
|
| 160 | - $source = $this->urlGenerator->getAbsoluteURL('/'); |
|
| 161 | - $source = rtrim($source, '/'); |
|
| 162 | - $token = $argument['token']; |
|
| 163 | - |
|
| 164 | - // kill job after 30 days of trying |
|
| 165 | - $deadline = $currentTime - $this->maxLifespan; |
|
| 166 | - if ($created < $deadline) { |
|
| 167 | - $this->retainJob = false; |
|
| 168 | - $this->trustedServers->setServerStatus($target,TrustedServers::STATUS_FAILURE); |
|
| 169 | - return; |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - $endPoints = $this->ocsDiscoveryService->discover($target, 'FEDERATED_SHARING'); |
|
| 173 | - $endPoint = isset($endPoints['shared-secret']) ? $endPoints['shared-secret'] : $this->defaultEndPoint; |
|
| 174 | - |
|
| 175 | - // make sure that we have a well formatted url |
|
| 176 | - $url = rtrim($target, '/') . '/' . trim($endPoint, '/') . $this->format; |
|
| 177 | - |
|
| 178 | - $result = null; |
|
| 179 | - try { |
|
| 180 | - $result = $this->httpClient->get( |
|
| 181 | - $url, |
|
| 182 | - [ |
|
| 183 | - 'query' => |
|
| 184 | - [ |
|
| 185 | - 'url' => $source, |
|
| 186 | - 'token' => $token |
|
| 187 | - ], |
|
| 188 | - 'timeout' => 3, |
|
| 189 | - 'connect_timeout' => 3, |
|
| 190 | - ] |
|
| 191 | - ); |
|
| 192 | - |
|
| 193 | - $status = $result->getStatusCode(); |
|
| 194 | - |
|
| 195 | - } catch (ClientException $e) { |
|
| 196 | - $status = $e->getCode(); |
|
| 197 | - if ($status === Http::STATUS_FORBIDDEN) { |
|
| 198 | - $this->logger->info($target . ' refused to exchange a shared secret with you.', ['app' => 'federation']); |
|
| 199 | - } else { |
|
| 200 | - $this->logger->info($target . ' responded with a ' . $status . ' containing: ' . $e->getMessage(), ['app' => 'federation']); |
|
| 201 | - } |
|
| 202 | - } catch (RequestException $e) { |
|
| 203 | - $status = -1; // There is no status code if we could not connect |
|
| 204 | - $this->logger->logException($e, [ |
|
| 205 | - 'message' => 'Could not connect to ' . $target, |
|
| 206 | - 'level' => \OCP\Util::INFO, |
|
| 207 | - 'app' => 'federation', |
|
| 208 | - ]); |
|
| 209 | - } catch (RingException $e) { |
|
| 210 | - $status = -1; // There is no status code if we could not connect |
|
| 211 | - $this->logger->logException($e, [ |
|
| 212 | - 'message' => 'Could not connect to ' . $target, |
|
| 213 | - 'level' => \OCP\Util::INFO, |
|
| 214 | - 'app' => 'federation', |
|
| 215 | - ]); |
|
| 216 | - } catch (\Exception $e) { |
|
| 217 | - $status = Http::STATUS_INTERNAL_SERVER_ERROR; |
|
| 218 | - $this->logger->logException($e, ['app' => 'federation']); |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - // if we received a unexpected response we try again later |
|
| 222 | - if ( |
|
| 223 | - $status !== Http::STATUS_OK |
|
| 224 | - && $status !== Http::STATUS_FORBIDDEN |
|
| 225 | - ) { |
|
| 226 | - $this->retainJob = true; |
|
| 227 | - } else { |
|
| 228 | - // reset token if we received a valid response |
|
| 229 | - $this->dbHandler->addToken($target, ''); |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - if ($status === Http::STATUS_OK && $result instanceof IResponse) { |
|
| 233 | - $body = $result->getBody(); |
|
| 234 | - $result = json_decode($body, true); |
|
| 235 | - if (isset($result['ocs']['data']['sharedSecret'])) { |
|
| 236 | - $this->trustedServers->addSharedSecret( |
|
| 237 | - $target, |
|
| 238 | - $result['ocs']['data']['sharedSecret'] |
|
| 239 | - ); |
|
| 240 | - } else { |
|
| 241 | - $this->logger->error( |
|
| 242 | - 'remote server "' . $target . '"" does not return a valid shared secret', |
|
| 243 | - ['app' => 'federation'] |
|
| 244 | - ); |
|
| 245 | - $this->trustedServers->setServerStatus($target, TrustedServers::STATUS_FAILURE); |
|
| 246 | - } |
|
| 247 | - } |
|
| 248 | - |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - /** |
|
| 252 | - * re-add background job |
|
| 253 | - * |
|
| 254 | - * @param array $argument |
|
| 255 | - */ |
|
| 256 | - protected function reAddJob(array $argument) { |
|
| 257 | - $url = $argument['url']; |
|
| 258 | - $created = isset($argument['created']) ? (int)$argument['created'] : $this->timeFactory->getTime(); |
|
| 259 | - $token = $argument['token']; |
|
| 260 | - $this->jobList->add( |
|
| 261 | - GetSharedSecret::class, |
|
| 262 | - [ |
|
| 263 | - 'url' => $url, |
|
| 264 | - 'token' => $token, |
|
| 265 | - 'created' => $created |
|
| 266 | - ] |
|
| 267 | - ); |
|
| 268 | - } |
|
| 60 | + /** @var IClient */ |
|
| 61 | + private $httpClient; |
|
| 62 | + |
|
| 63 | + /** @var IJobList */ |
|
| 64 | + private $jobList; |
|
| 65 | + |
|
| 66 | + /** @var IURLGenerator */ |
|
| 67 | + private $urlGenerator; |
|
| 68 | + |
|
| 69 | + /** @var TrustedServers */ |
|
| 70 | + private $trustedServers; |
|
| 71 | + |
|
| 72 | + /** @var DbHandler */ |
|
| 73 | + private $dbHandler; |
|
| 74 | + |
|
| 75 | + /** @var IDiscoveryService */ |
|
| 76 | + private $ocsDiscoveryService; |
|
| 77 | + |
|
| 78 | + /** @var ILogger */ |
|
| 79 | + private $logger; |
|
| 80 | + |
|
| 81 | + /** @var ITimeFactory */ |
|
| 82 | + private $timeFactory; |
|
| 83 | + |
|
| 84 | + /** @var bool */ |
|
| 85 | + protected $retainJob = false; |
|
| 86 | + |
|
| 87 | + private $format = '?format=json'; |
|
| 88 | + |
|
| 89 | + private $defaultEndPoint = '/ocs/v2.php/apps/federation/api/v1/shared-secret'; |
|
| 90 | + |
|
| 91 | + /** @var int 30 day = 2592000sec */ |
|
| 92 | + private $maxLifespan = 2592000; |
|
| 93 | + |
|
| 94 | + /** |
|
| 95 | + * RequestSharedSecret constructor. |
|
| 96 | + * |
|
| 97 | + * @param IClientService $httpClientService |
|
| 98 | + * @param IURLGenerator $urlGenerator |
|
| 99 | + * @param IJobList $jobList |
|
| 100 | + * @param TrustedServers $trustedServers |
|
| 101 | + * @param ILogger $logger |
|
| 102 | + * @param DbHandler $dbHandler |
|
| 103 | + * @param IDiscoveryService $ocsDiscoveryService |
|
| 104 | + * @param ITimeFactory $timeFactory |
|
| 105 | + */ |
|
| 106 | + public function __construct( |
|
| 107 | + IClientService $httpClientService, |
|
| 108 | + IURLGenerator $urlGenerator, |
|
| 109 | + IJobList $jobList, |
|
| 110 | + TrustedServers $trustedServers, |
|
| 111 | + ILogger $logger, |
|
| 112 | + DbHandler $dbHandler, |
|
| 113 | + IDiscoveryService $ocsDiscoveryService, |
|
| 114 | + ITimeFactory $timeFactory |
|
| 115 | + ) { |
|
| 116 | + $this->logger = $logger; |
|
| 117 | + $this->httpClient = $httpClientService->newClient(); |
|
| 118 | + $this->jobList = $jobList; |
|
| 119 | + $this->urlGenerator = $urlGenerator; |
|
| 120 | + $this->dbHandler = $dbHandler; |
|
| 121 | + $this->ocsDiscoveryService = $ocsDiscoveryService; |
|
| 122 | + $this->trustedServers = $trustedServers; |
|
| 123 | + $this->timeFactory = $timeFactory; |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * run the job, then remove it from the joblist |
|
| 128 | + * |
|
| 129 | + * @param JobList $jobList |
|
| 130 | + * @param ILogger|null $logger |
|
| 131 | + */ |
|
| 132 | + public function execute($jobList, ILogger $logger = null) { |
|
| 133 | + $target = $this->argument['url']; |
|
| 134 | + // only execute if target is still in the list of trusted domains |
|
| 135 | + if ($this->trustedServers->isTrustedServer($target)) { |
|
| 136 | + $this->parentExecute($jobList, $logger); |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + $jobList->remove($this, $this->argument); |
|
| 140 | + |
|
| 141 | + if ($this->retainJob) { |
|
| 142 | + $this->reAddJob($this->argument); |
|
| 143 | + } |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * call execute() method of parent |
|
| 148 | + * |
|
| 149 | + * @param JobList $jobList |
|
| 150 | + * @param ILogger $logger |
|
| 151 | + */ |
|
| 152 | + protected function parentExecute($jobList, $logger = null) { |
|
| 153 | + parent::execute($jobList, $logger); |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + protected function run($argument) { |
|
| 157 | + $target = $argument['url']; |
|
| 158 | + $created = isset($argument['created']) ? (int)$argument['created'] : $this->timeFactory->getTime(); |
|
| 159 | + $currentTime = $this->timeFactory->getTime(); |
|
| 160 | + $source = $this->urlGenerator->getAbsoluteURL('/'); |
|
| 161 | + $source = rtrim($source, '/'); |
|
| 162 | + $token = $argument['token']; |
|
| 163 | + |
|
| 164 | + // kill job after 30 days of trying |
|
| 165 | + $deadline = $currentTime - $this->maxLifespan; |
|
| 166 | + if ($created < $deadline) { |
|
| 167 | + $this->retainJob = false; |
|
| 168 | + $this->trustedServers->setServerStatus($target,TrustedServers::STATUS_FAILURE); |
|
| 169 | + return; |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + $endPoints = $this->ocsDiscoveryService->discover($target, 'FEDERATED_SHARING'); |
|
| 173 | + $endPoint = isset($endPoints['shared-secret']) ? $endPoints['shared-secret'] : $this->defaultEndPoint; |
|
| 174 | + |
|
| 175 | + // make sure that we have a well formatted url |
|
| 176 | + $url = rtrim($target, '/') . '/' . trim($endPoint, '/') . $this->format; |
|
| 177 | + |
|
| 178 | + $result = null; |
|
| 179 | + try { |
|
| 180 | + $result = $this->httpClient->get( |
|
| 181 | + $url, |
|
| 182 | + [ |
|
| 183 | + 'query' => |
|
| 184 | + [ |
|
| 185 | + 'url' => $source, |
|
| 186 | + 'token' => $token |
|
| 187 | + ], |
|
| 188 | + 'timeout' => 3, |
|
| 189 | + 'connect_timeout' => 3, |
|
| 190 | + ] |
|
| 191 | + ); |
|
| 192 | + |
|
| 193 | + $status = $result->getStatusCode(); |
|
| 194 | + |
|
| 195 | + } catch (ClientException $e) { |
|
| 196 | + $status = $e->getCode(); |
|
| 197 | + if ($status === Http::STATUS_FORBIDDEN) { |
|
| 198 | + $this->logger->info($target . ' refused to exchange a shared secret with you.', ['app' => 'federation']); |
|
| 199 | + } else { |
|
| 200 | + $this->logger->info($target . ' responded with a ' . $status . ' containing: ' . $e->getMessage(), ['app' => 'federation']); |
|
| 201 | + } |
|
| 202 | + } catch (RequestException $e) { |
|
| 203 | + $status = -1; // There is no status code if we could not connect |
|
| 204 | + $this->logger->logException($e, [ |
|
| 205 | + 'message' => 'Could not connect to ' . $target, |
|
| 206 | + 'level' => \OCP\Util::INFO, |
|
| 207 | + 'app' => 'federation', |
|
| 208 | + ]); |
|
| 209 | + } catch (RingException $e) { |
|
| 210 | + $status = -1; // There is no status code if we could not connect |
|
| 211 | + $this->logger->logException($e, [ |
|
| 212 | + 'message' => 'Could not connect to ' . $target, |
|
| 213 | + 'level' => \OCP\Util::INFO, |
|
| 214 | + 'app' => 'federation', |
|
| 215 | + ]); |
|
| 216 | + } catch (\Exception $e) { |
|
| 217 | + $status = Http::STATUS_INTERNAL_SERVER_ERROR; |
|
| 218 | + $this->logger->logException($e, ['app' => 'federation']); |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + // if we received a unexpected response we try again later |
|
| 222 | + if ( |
|
| 223 | + $status !== Http::STATUS_OK |
|
| 224 | + && $status !== Http::STATUS_FORBIDDEN |
|
| 225 | + ) { |
|
| 226 | + $this->retainJob = true; |
|
| 227 | + } else { |
|
| 228 | + // reset token if we received a valid response |
|
| 229 | + $this->dbHandler->addToken($target, ''); |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + if ($status === Http::STATUS_OK && $result instanceof IResponse) { |
|
| 233 | + $body = $result->getBody(); |
|
| 234 | + $result = json_decode($body, true); |
|
| 235 | + if (isset($result['ocs']['data']['sharedSecret'])) { |
|
| 236 | + $this->trustedServers->addSharedSecret( |
|
| 237 | + $target, |
|
| 238 | + $result['ocs']['data']['sharedSecret'] |
|
| 239 | + ); |
|
| 240 | + } else { |
|
| 241 | + $this->logger->error( |
|
| 242 | + 'remote server "' . $target . '"" does not return a valid shared secret', |
|
| 243 | + ['app' => 'federation'] |
|
| 244 | + ); |
|
| 245 | + $this->trustedServers->setServerStatus($target, TrustedServers::STATUS_FAILURE); |
|
| 246 | + } |
|
| 247 | + } |
|
| 248 | + |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + /** |
|
| 252 | + * re-add background job |
|
| 253 | + * |
|
| 254 | + * @param array $argument |
|
| 255 | + */ |
|
| 256 | + protected function reAddJob(array $argument) { |
|
| 257 | + $url = $argument['url']; |
|
| 258 | + $created = isset($argument['created']) ? (int)$argument['created'] : $this->timeFactory->getTime(); |
|
| 259 | + $token = $argument['token']; |
|
| 260 | + $this->jobList->add( |
|
| 261 | + GetSharedSecret::class, |
|
| 262 | + [ |
|
| 263 | + 'url' => $url, |
|
| 264 | + 'token' => $token, |
|
| 265 | + 'created' => $created |
|
| 266 | + ] |
|
| 267 | + ); |
|
| 268 | + } |
|
| 269 | 269 | } |
@@ -155,7 +155,7 @@ discard block |
||
| 155 | 155 | |
| 156 | 156 | protected function run($argument) { |
| 157 | 157 | $target = $argument['url']; |
| 158 | - $created = isset($argument['created']) ? (int)$argument['created'] : $this->timeFactory->getTime(); |
|
| 158 | + $created = isset($argument['created']) ? (int) $argument['created'] : $this->timeFactory->getTime(); |
|
| 159 | 159 | $currentTime = $this->timeFactory->getTime(); |
| 160 | 160 | $source = $this->urlGenerator->getAbsoluteURL('/'); |
| 161 | 161 | $source = rtrim($source, '/'); |
@@ -165,7 +165,7 @@ discard block |
||
| 165 | 165 | $deadline = $currentTime - $this->maxLifespan; |
| 166 | 166 | if ($created < $deadline) { |
| 167 | 167 | $this->retainJob = false; |
| 168 | - $this->trustedServers->setServerStatus($target,TrustedServers::STATUS_FAILURE); |
|
| 168 | + $this->trustedServers->setServerStatus($target, TrustedServers::STATUS_FAILURE); |
|
| 169 | 169 | return; |
| 170 | 170 | } |
| 171 | 171 | |
@@ -173,7 +173,7 @@ discard block |
||
| 173 | 173 | $endPoint = isset($endPoints['shared-secret']) ? $endPoints['shared-secret'] : $this->defaultEndPoint; |
| 174 | 174 | |
| 175 | 175 | // make sure that we have a well formatted url |
| 176 | - $url = rtrim($target, '/') . '/' . trim($endPoint, '/') . $this->format; |
|
| 176 | + $url = rtrim($target, '/').'/'.trim($endPoint, '/').$this->format; |
|
| 177 | 177 | |
| 178 | 178 | $result = null; |
| 179 | 179 | try { |
@@ -195,21 +195,21 @@ discard block |
||
| 195 | 195 | } catch (ClientException $e) { |
| 196 | 196 | $status = $e->getCode(); |
| 197 | 197 | if ($status === Http::STATUS_FORBIDDEN) { |
| 198 | - $this->logger->info($target . ' refused to exchange a shared secret with you.', ['app' => 'federation']); |
|
| 198 | + $this->logger->info($target.' refused to exchange a shared secret with you.', ['app' => 'federation']); |
|
| 199 | 199 | } else { |
| 200 | - $this->logger->info($target . ' responded with a ' . $status . ' containing: ' . $e->getMessage(), ['app' => 'federation']); |
|
| 200 | + $this->logger->info($target.' responded with a '.$status.' containing: '.$e->getMessage(), ['app' => 'federation']); |
|
| 201 | 201 | } |
| 202 | 202 | } catch (RequestException $e) { |
| 203 | 203 | $status = -1; // There is no status code if we could not connect |
| 204 | 204 | $this->logger->logException($e, [ |
| 205 | - 'message' => 'Could not connect to ' . $target, |
|
| 205 | + 'message' => 'Could not connect to '.$target, |
|
| 206 | 206 | 'level' => \OCP\Util::INFO, |
| 207 | 207 | 'app' => 'federation', |
| 208 | 208 | ]); |
| 209 | 209 | } catch (RingException $e) { |
| 210 | 210 | $status = -1; // There is no status code if we could not connect |
| 211 | 211 | $this->logger->logException($e, [ |
| 212 | - 'message' => 'Could not connect to ' . $target, |
|
| 212 | + 'message' => 'Could not connect to '.$target, |
|
| 213 | 213 | 'level' => \OCP\Util::INFO, |
| 214 | 214 | 'app' => 'federation', |
| 215 | 215 | ]); |
@@ -224,7 +224,7 @@ discard block |
||
| 224 | 224 | && $status !== Http::STATUS_FORBIDDEN |
| 225 | 225 | ) { |
| 226 | 226 | $this->retainJob = true; |
| 227 | - } else { |
|
| 227 | + } else { |
|
| 228 | 228 | // reset token if we received a valid response |
| 229 | 229 | $this->dbHandler->addToken($target, ''); |
| 230 | 230 | } |
@@ -239,7 +239,7 @@ discard block |
||
| 239 | 239 | ); |
| 240 | 240 | } else { |
| 241 | 241 | $this->logger->error( |
| 242 | - 'remote server "' . $target . '"" does not return a valid shared secret', |
|
| 242 | + 'remote server "'.$target.'"" does not return a valid shared secret', |
|
| 243 | 243 | ['app' => 'federation'] |
| 244 | 244 | ); |
| 245 | 245 | $this->trustedServers->setServerStatus($target, TrustedServers::STATUS_FAILURE); |
@@ -255,7 +255,7 @@ discard block |
||
| 255 | 255 | */ |
| 256 | 256 | protected function reAddJob(array $argument) { |
| 257 | 257 | $url = $argument['url']; |
| 258 | - $created = isset($argument['created']) ? (int)$argument['created'] : $this->timeFactory->getTime(); |
|
| 258 | + $created = isset($argument['created']) ? (int) $argument['created'] : $this->timeFactory->getTime(); |
|
| 259 | 259 | $token = $argument['token']; |
| 260 | 260 | $this->jobList->add( |
| 261 | 261 | GetSharedSecret::class, |
@@ -29,41 +29,41 @@ |
||
| 29 | 29 | |
| 30 | 30 | class Admin implements ISettings { |
| 31 | 31 | |
| 32 | - /** @var TrustedServers */ |
|
| 33 | - private $trustedServers; |
|
| 32 | + /** @var TrustedServers */ |
|
| 33 | + private $trustedServers; |
|
| 34 | 34 | |
| 35 | - public function __construct(TrustedServers $trustedServers) { |
|
| 36 | - $this->trustedServers = $trustedServers; |
|
| 37 | - } |
|
| 35 | + public function __construct(TrustedServers $trustedServers) { |
|
| 36 | + $this->trustedServers = $trustedServers; |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @return TemplateResponse |
|
| 41 | - */ |
|
| 42 | - public function getForm() { |
|
| 43 | - $parameters = [ |
|
| 44 | - 'trustedServers' => $this->trustedServers->getServers(), |
|
| 45 | - 'autoAddServers' => $this->trustedServers->getAutoAddServers(), |
|
| 46 | - ]; |
|
| 39 | + /** |
|
| 40 | + * @return TemplateResponse |
|
| 41 | + */ |
|
| 42 | + public function getForm() { |
|
| 43 | + $parameters = [ |
|
| 44 | + 'trustedServers' => $this->trustedServers->getServers(), |
|
| 45 | + 'autoAddServers' => $this->trustedServers->getAutoAddServers(), |
|
| 46 | + ]; |
|
| 47 | 47 | |
| 48 | - return new TemplateResponse('federation', 'settings-admin', $parameters, ''); |
|
| 49 | - } |
|
| 48 | + return new TemplateResponse('federation', 'settings-admin', $parameters, ''); |
|
| 49 | + } |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @return string the section ID, e.g. 'sharing' |
|
| 53 | - */ |
|
| 54 | - public function getSection() { |
|
| 55 | - return 'sharing'; |
|
| 56 | - } |
|
| 51 | + /** |
|
| 52 | + * @return string the section ID, e.g. 'sharing' |
|
| 53 | + */ |
|
| 54 | + public function getSection() { |
|
| 55 | + return 'sharing'; |
|
| 56 | + } |
|
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * @return int whether the form should be rather on the top or bottom of |
|
| 60 | - * the admin section. The forms are arranged in ascending order of the |
|
| 61 | - * priority values. It is required to return a value between 0 and 100. |
|
| 62 | - * |
|
| 63 | - * E.g.: 70 |
|
| 64 | - */ |
|
| 65 | - public function getPriority() { |
|
| 66 | - return 30; |
|
| 67 | - } |
|
| 58 | + /** |
|
| 59 | + * @return int whether the form should be rather on the top or bottom of |
|
| 60 | + * the admin section. The forms are arranged in ascending order of the |
|
| 61 | + * priority values. It is required to return a value between 0 and 100. |
|
| 62 | + * |
|
| 63 | + * E.g.: 70 |
|
| 64 | + */ |
|
| 65 | + public function getPriority() { |
|
| 66 | + return 30; |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | 69 | } |
@@ -27,25 +27,25 @@ |
||
| 27 | 27 | |
| 28 | 28 | class Hooks { |
| 29 | 29 | |
| 30 | - /** @var TrustedServers */ |
|
| 31 | - private $trustedServers; |
|
| 32 | - |
|
| 33 | - public function __construct(TrustedServers $trustedServers) { |
|
| 34 | - $this->trustedServers = $trustedServers; |
|
| 35 | - } |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * add servers to the list of trusted servers once a federated share was established |
|
| 39 | - * |
|
| 40 | - * @param array $params |
|
| 41 | - */ |
|
| 42 | - public function addServerHook($params) { |
|
| 43 | - if ( |
|
| 44 | - $this->trustedServers->getAutoAddServers() === true && |
|
| 45 | - $this->trustedServers->isTrustedServer($params['server']) === false |
|
| 46 | - ) { |
|
| 47 | - $this->trustedServers->addServer($params['server']); |
|
| 48 | - } |
|
| 49 | - } |
|
| 30 | + /** @var TrustedServers */ |
|
| 31 | + private $trustedServers; |
|
| 32 | + |
|
| 33 | + public function __construct(TrustedServers $trustedServers) { |
|
| 34 | + $this->trustedServers = $trustedServers; |
|
| 35 | + } |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * add servers to the list of trusted servers once a federated share was established |
|
| 39 | + * |
|
| 40 | + * @param array $params |
|
| 41 | + */ |
|
| 42 | + public function addServerHook($params) { |
|
| 43 | + if ( |
|
| 44 | + $this->trustedServers->getAutoAddServers() === true && |
|
| 45 | + $this->trustedServers->isTrustedServer($params['server']) === false |
|
| 46 | + ) { |
|
| 47 | + $this->trustedServers->addServer($params['server']); |
|
| 48 | + } |
|
| 49 | + } |
|
| 50 | 50 | |
| 51 | 51 | } |
@@ -26,67 +26,67 @@ |
||
| 26 | 26 | |
| 27 | 27 | class PublicAuth implements BackendInterface { |
| 28 | 28 | |
| 29 | - /** @var string[] */ |
|
| 30 | - private $publicURLs; |
|
| 29 | + /** @var string[] */ |
|
| 30 | + private $publicURLs; |
|
| 31 | 31 | |
| 32 | - public function __construct() { |
|
| 33 | - $this->publicURLs = [ |
|
| 34 | - 'public-calendars', |
|
| 35 | - 'principals/system/public' |
|
| 36 | - ]; |
|
| 37 | - } |
|
| 32 | + public function __construct() { |
|
| 33 | + $this->publicURLs = [ |
|
| 34 | + 'public-calendars', |
|
| 35 | + 'principals/system/public' |
|
| 36 | + ]; |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * When this method is called, the backend must check if authentication was |
|
| 41 | - * successful. |
|
| 42 | - * |
|
| 43 | - * The returned value must be one of the following |
|
| 44 | - * |
|
| 45 | - * [true, "principals/username"] |
|
| 46 | - * [false, "reason for failure"] |
|
| 47 | - * |
|
| 48 | - * If authentication was successful, it's expected that the authentication |
|
| 49 | - * backend returns a so-called principal url. |
|
| 50 | - * |
|
| 51 | - * Examples of a principal url: |
|
| 52 | - * |
|
| 53 | - * principals/admin |
|
| 54 | - * principals/user1 |
|
| 55 | - * principals/users/joe |
|
| 56 | - * principals/uid/123457 |
|
| 57 | - * |
|
| 58 | - * If you don't use WebDAV ACL (RFC3744) we recommend that you simply |
|
| 59 | - * return a string such as: |
|
| 60 | - * |
|
| 61 | - * principals/users/[username] |
|
| 62 | - * |
|
| 63 | - * @param RequestInterface $request |
|
| 64 | - * @param ResponseInterface $response |
|
| 65 | - * @return array |
|
| 66 | - */ |
|
| 67 | - function check(RequestInterface $request, ResponseInterface $response) { |
|
| 39 | + /** |
|
| 40 | + * When this method is called, the backend must check if authentication was |
|
| 41 | + * successful. |
|
| 42 | + * |
|
| 43 | + * The returned value must be one of the following |
|
| 44 | + * |
|
| 45 | + * [true, "principals/username"] |
|
| 46 | + * [false, "reason for failure"] |
|
| 47 | + * |
|
| 48 | + * If authentication was successful, it's expected that the authentication |
|
| 49 | + * backend returns a so-called principal url. |
|
| 50 | + * |
|
| 51 | + * Examples of a principal url: |
|
| 52 | + * |
|
| 53 | + * principals/admin |
|
| 54 | + * principals/user1 |
|
| 55 | + * principals/users/joe |
|
| 56 | + * principals/uid/123457 |
|
| 57 | + * |
|
| 58 | + * If you don't use WebDAV ACL (RFC3744) we recommend that you simply |
|
| 59 | + * return a string such as: |
|
| 60 | + * |
|
| 61 | + * principals/users/[username] |
|
| 62 | + * |
|
| 63 | + * @param RequestInterface $request |
|
| 64 | + * @param ResponseInterface $response |
|
| 65 | + * @return array |
|
| 66 | + */ |
|
| 67 | + function check(RequestInterface $request, ResponseInterface $response) { |
|
| 68 | 68 | |
| 69 | - if ($this->isRequestPublic($request)) { |
|
| 70 | - return [true, "principals/system/public"]; |
|
| 71 | - } |
|
| 72 | - return [false, "No public access to this resource."]; |
|
| 73 | - } |
|
| 69 | + if ($this->isRequestPublic($request)) { |
|
| 70 | + return [true, "principals/system/public"]; |
|
| 71 | + } |
|
| 72 | + return [false, "No public access to this resource."]; |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * @inheritdoc |
|
| 77 | - */ |
|
| 78 | - function challenge(RequestInterface $request, ResponseInterface $response) { |
|
| 79 | - } |
|
| 75 | + /** |
|
| 76 | + * @inheritdoc |
|
| 77 | + */ |
|
| 78 | + function challenge(RequestInterface $request, ResponseInterface $response) { |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @param RequestInterface $request |
|
| 83 | - * @return bool |
|
| 84 | - */ |
|
| 85 | - private function isRequestPublic(RequestInterface $request) { |
|
| 86 | - $url = $request->getPath(); |
|
| 87 | - $matchingUrls = array_filter($this->publicURLs, function ($publicUrl) use ($url) { |
|
| 88 | - return strpos($url, $publicUrl, 0) === 0; |
|
| 89 | - }); |
|
| 90 | - return !empty($matchingUrls); |
|
| 91 | - } |
|
| 81 | + /** |
|
| 82 | + * @param RequestInterface $request |
|
| 83 | + * @return bool |
|
| 84 | + */ |
|
| 85 | + private function isRequestPublic(RequestInterface $request) { |
|
| 86 | + $url = $request->getPath(); |
|
| 87 | + $matchingUrls = array_filter($this->publicURLs, function ($publicUrl) use ($url) { |
|
| 88 | + return strpos($url, $publicUrl, 0) === 0; |
|
| 89 | + }); |
|
| 90 | + return !empty($matchingUrls); |
|
| 91 | + } |
|
| 92 | 92 | } |
@@ -84,7 +84,7 @@ |
||
| 84 | 84 | */ |
| 85 | 85 | private function isRequestPublic(RequestInterface $request) { |
| 86 | 86 | $url = $request->getPath(); |
| 87 | - $matchingUrls = array_filter($this->publicURLs, function ($publicUrl) use ($url) { |
|
| 87 | + $matchingUrls = array_filter($this->publicURLs, function($publicUrl) use ($url) { |
|
| 88 | 88 | return strpos($url, $publicUrl, 0) === 0; |
| 89 | 89 | }); |
| 90 | 90 | return !empty($matchingUrls); |
@@ -47,8 +47,8 @@ discard block |
||
| 47 | 47 | static function xmlDeserialize(Reader $reader) { |
| 48 | 48 | |
| 49 | 49 | $elements = $reader->parseInnerTree([ |
| 50 | - '{' . Plugin::NS_OWNCLOUD. '}set' => 'Sabre\\Xml\\Element\\KeyValue', |
|
| 51 | - '{' . Plugin::NS_OWNCLOUD . '}remove' => 'Sabre\\Xml\\Element\\KeyValue', |
|
| 50 | + '{'.Plugin::NS_OWNCLOUD.'}set' => 'Sabre\\Xml\\Element\\KeyValue', |
|
| 51 | + '{'.Plugin::NS_OWNCLOUD.'}remove' => 'Sabre\\Xml\\Element\\KeyValue', |
|
| 52 | 52 | ]); |
| 53 | 53 | |
| 54 | 54 | $set = []; |
@@ -57,21 +57,21 @@ discard block |
||
| 57 | 57 | foreach ($elements as $elem) { |
| 58 | 58 | switch ($elem['name']) { |
| 59 | 59 | |
| 60 | - case '{' . Plugin::NS_OWNCLOUD . '}set' : |
|
| 60 | + case '{'.Plugin::NS_OWNCLOUD.'}set' : |
|
| 61 | 61 | $sharee = $elem['value']; |
| 62 | 62 | |
| 63 | - $sumElem = '{' . Plugin::NS_OWNCLOUD . '}summary'; |
|
| 64 | - $commonName = '{' . Plugin::NS_OWNCLOUD . '}common-name'; |
|
| 63 | + $sumElem = '{'.Plugin::NS_OWNCLOUD.'}summary'; |
|
| 64 | + $commonName = '{'.Plugin::NS_OWNCLOUD.'}common-name'; |
|
| 65 | 65 | |
| 66 | 66 | $set[] = [ |
| 67 | 67 | 'href' => $sharee['{DAV:}href'], |
| 68 | 68 | 'commonName' => isset($sharee[$commonName]) ? $sharee[$commonName] : null, |
| 69 | 69 | 'summary' => isset($sharee[$sumElem]) ? $sharee[$sumElem] : null, |
| 70 | - 'readOnly' => !array_key_exists('{' . Plugin::NS_OWNCLOUD . '}read-write', $sharee), |
|
| 70 | + 'readOnly' => !array_key_exists('{'.Plugin::NS_OWNCLOUD.'}read-write', $sharee), |
|
| 71 | 71 | ]; |
| 72 | 72 | break; |
| 73 | 73 | |
| 74 | - case '{' . Plugin::NS_OWNCLOUD . '}remove' : |
|
| 74 | + case '{'.Plugin::NS_OWNCLOUD.'}remove' : |
|
| 75 | 75 | $remove[] = $elem['value']['{DAV:}href']; |
| 76 | 76 | break; |
| 77 | 77 | |
@@ -41,130 +41,130 @@ |
||
| 41 | 41 | */ |
| 42 | 42 | class Invite implements XmlSerializable { |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * The list of users a calendar has been shared to. |
|
| 46 | - * |
|
| 47 | - * @var array |
|
| 48 | - */ |
|
| 49 | - protected $users; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * The organizer contains information about the person who shared the |
|
| 53 | - * object. |
|
| 54 | - * |
|
| 55 | - * @var array|null |
|
| 56 | - */ |
|
| 57 | - protected $organizer; |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * Creates the property. |
|
| 61 | - * |
|
| 62 | - * Users is an array. Each element of the array has the following |
|
| 63 | - * properties: |
|
| 64 | - * |
|
| 65 | - * * href - Often a mailto: address |
|
| 66 | - * * commonName - Optional, for example a first and lastname for a user. |
|
| 67 | - * * status - One of the SharingPlugin::STATUS_* constants. |
|
| 68 | - * * readOnly - true or false |
|
| 69 | - * * summary - Optional, description of the share |
|
| 70 | - * |
|
| 71 | - * The organizer key is optional to specify. It's only useful when a |
|
| 72 | - * 'sharee' requests the sharing information. |
|
| 73 | - * |
|
| 74 | - * The organizer may have the following properties: |
|
| 75 | - * * href - Often a mailto: address. |
|
| 76 | - * * commonName - Optional human-readable name. |
|
| 77 | - * * firstName - Optional first name. |
|
| 78 | - * * lastName - Optional last name. |
|
| 79 | - * |
|
| 80 | - * If you wonder why these two structures are so different, I guess a |
|
| 81 | - * valid answer is that the current spec is still a draft. |
|
| 82 | - * |
|
| 83 | - * @param array $users |
|
| 84 | - */ |
|
| 85 | - function __construct(array $users, array $organizer = null) { |
|
| 86 | - |
|
| 87 | - $this->users = $users; |
|
| 88 | - $this->organizer = $organizer; |
|
| 89 | - |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * Returns the list of users, as it was passed to the constructor. |
|
| 94 | - * |
|
| 95 | - * @return array |
|
| 96 | - */ |
|
| 97 | - function getValue() { |
|
| 98 | - |
|
| 99 | - return $this->users; |
|
| 100 | - |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * The xmlSerialize metod is called during xml writing. |
|
| 105 | - * |
|
| 106 | - * Use the $writer argument to write its own xml serialization. |
|
| 107 | - * |
|
| 108 | - * An important note: do _not_ create a parent element. Any element |
|
| 109 | - * implementing XmlSerializble should only ever write what's considered |
|
| 110 | - * its 'inner xml'. |
|
| 111 | - * |
|
| 112 | - * The parent of the current element is responsible for writing a |
|
| 113 | - * containing element. |
|
| 114 | - * |
|
| 115 | - * This allows serializers to be re-used for different element names. |
|
| 116 | - * |
|
| 117 | - * If you are opening new elements, you must also close them again. |
|
| 118 | - * |
|
| 119 | - * @param Writer $writer |
|
| 120 | - * @return void |
|
| 121 | - */ |
|
| 122 | - function xmlSerialize(Writer $writer) { |
|
| 123 | - |
|
| 124 | - $cs = '{' . Plugin::NS_OWNCLOUD . '}'; |
|
| 125 | - |
|
| 126 | - if (!is_null($this->organizer)) { |
|
| 127 | - |
|
| 128 | - $writer->startElement($cs . 'organizer'); |
|
| 129 | - $writer->writeElement('{DAV:}href', $this->organizer['href']); |
|
| 130 | - |
|
| 131 | - if (isset($this->organizer['commonName']) && $this->organizer['commonName']) { |
|
| 132 | - $writer->writeElement($cs . 'common-name', $this->organizer['commonName']); |
|
| 133 | - } |
|
| 134 | - if (isset($this->organizer['firstName']) && $this->organizer['firstName']) { |
|
| 135 | - $writer->writeElement($cs . 'first-name', $this->organizer['firstName']); |
|
| 136 | - } |
|
| 137 | - if (isset($this->organizer['lastName']) && $this->organizer['lastName']) { |
|
| 138 | - $writer->writeElement($cs . 'last-name', $this->organizer['lastName']); |
|
| 139 | - } |
|
| 140 | - $writer->endElement(); // organizer |
|
| 141 | - |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - foreach ($this->users as $user) { |
|
| 145 | - |
|
| 146 | - $writer->startElement($cs . 'user'); |
|
| 147 | - $writer->writeElement('{DAV:}href', $user['href']); |
|
| 148 | - if (isset($user['commonName']) && $user['commonName']) { |
|
| 149 | - $writer->writeElement($cs . 'common-name', $user['commonName']); |
|
| 150 | - } |
|
| 151 | - $writer->writeElement($cs . 'invite-accepted'); |
|
| 152 | - |
|
| 153 | - $writer->startElement($cs . 'access'); |
|
| 154 | - if ($user['readOnly']) { |
|
| 155 | - $writer->writeElement($cs . 'read'); |
|
| 156 | - } else { |
|
| 157 | - $writer->writeElement($cs . 'read-write'); |
|
| 158 | - } |
|
| 159 | - $writer->endElement(); // access |
|
| 160 | - |
|
| 161 | - if (isset($user['summary']) && $user['summary']) { |
|
| 162 | - $writer->writeElement($cs . 'summary', $user['summary']); |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - $writer->endElement(); //user |
|
| 166 | - |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - } |
|
| 44 | + /** |
|
| 45 | + * The list of users a calendar has been shared to. |
|
| 46 | + * |
|
| 47 | + * @var array |
|
| 48 | + */ |
|
| 49 | + protected $users; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * The organizer contains information about the person who shared the |
|
| 53 | + * object. |
|
| 54 | + * |
|
| 55 | + * @var array|null |
|
| 56 | + */ |
|
| 57 | + protected $organizer; |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * Creates the property. |
|
| 61 | + * |
|
| 62 | + * Users is an array. Each element of the array has the following |
|
| 63 | + * properties: |
|
| 64 | + * |
|
| 65 | + * * href - Often a mailto: address |
|
| 66 | + * * commonName - Optional, for example a first and lastname for a user. |
|
| 67 | + * * status - One of the SharingPlugin::STATUS_* constants. |
|
| 68 | + * * readOnly - true or false |
|
| 69 | + * * summary - Optional, description of the share |
|
| 70 | + * |
|
| 71 | + * The organizer key is optional to specify. It's only useful when a |
|
| 72 | + * 'sharee' requests the sharing information. |
|
| 73 | + * |
|
| 74 | + * The organizer may have the following properties: |
|
| 75 | + * * href - Often a mailto: address. |
|
| 76 | + * * commonName - Optional human-readable name. |
|
| 77 | + * * firstName - Optional first name. |
|
| 78 | + * * lastName - Optional last name. |
|
| 79 | + * |
|
| 80 | + * If you wonder why these two structures are so different, I guess a |
|
| 81 | + * valid answer is that the current spec is still a draft. |
|
| 82 | + * |
|
| 83 | + * @param array $users |
|
| 84 | + */ |
|
| 85 | + function __construct(array $users, array $organizer = null) { |
|
| 86 | + |
|
| 87 | + $this->users = $users; |
|
| 88 | + $this->organizer = $organizer; |
|
| 89 | + |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * Returns the list of users, as it was passed to the constructor. |
|
| 94 | + * |
|
| 95 | + * @return array |
|
| 96 | + */ |
|
| 97 | + function getValue() { |
|
| 98 | + |
|
| 99 | + return $this->users; |
|
| 100 | + |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * The xmlSerialize metod is called during xml writing. |
|
| 105 | + * |
|
| 106 | + * Use the $writer argument to write its own xml serialization. |
|
| 107 | + * |
|
| 108 | + * An important note: do _not_ create a parent element. Any element |
|
| 109 | + * implementing XmlSerializble should only ever write what's considered |
|
| 110 | + * its 'inner xml'. |
|
| 111 | + * |
|
| 112 | + * The parent of the current element is responsible for writing a |
|
| 113 | + * containing element. |
|
| 114 | + * |
|
| 115 | + * This allows serializers to be re-used for different element names. |
|
| 116 | + * |
|
| 117 | + * If you are opening new elements, you must also close them again. |
|
| 118 | + * |
|
| 119 | + * @param Writer $writer |
|
| 120 | + * @return void |
|
| 121 | + */ |
|
| 122 | + function xmlSerialize(Writer $writer) { |
|
| 123 | + |
|
| 124 | + $cs = '{' . Plugin::NS_OWNCLOUD . '}'; |
|
| 125 | + |
|
| 126 | + if (!is_null($this->organizer)) { |
|
| 127 | + |
|
| 128 | + $writer->startElement($cs . 'organizer'); |
|
| 129 | + $writer->writeElement('{DAV:}href', $this->organizer['href']); |
|
| 130 | + |
|
| 131 | + if (isset($this->organizer['commonName']) && $this->organizer['commonName']) { |
|
| 132 | + $writer->writeElement($cs . 'common-name', $this->organizer['commonName']); |
|
| 133 | + } |
|
| 134 | + if (isset($this->organizer['firstName']) && $this->organizer['firstName']) { |
|
| 135 | + $writer->writeElement($cs . 'first-name', $this->organizer['firstName']); |
|
| 136 | + } |
|
| 137 | + if (isset($this->organizer['lastName']) && $this->organizer['lastName']) { |
|
| 138 | + $writer->writeElement($cs . 'last-name', $this->organizer['lastName']); |
|
| 139 | + } |
|
| 140 | + $writer->endElement(); // organizer |
|
| 141 | + |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + foreach ($this->users as $user) { |
|
| 145 | + |
|
| 146 | + $writer->startElement($cs . 'user'); |
|
| 147 | + $writer->writeElement('{DAV:}href', $user['href']); |
|
| 148 | + if (isset($user['commonName']) && $user['commonName']) { |
|
| 149 | + $writer->writeElement($cs . 'common-name', $user['commonName']); |
|
| 150 | + } |
|
| 151 | + $writer->writeElement($cs . 'invite-accepted'); |
|
| 152 | + |
|
| 153 | + $writer->startElement($cs . 'access'); |
|
| 154 | + if ($user['readOnly']) { |
|
| 155 | + $writer->writeElement($cs . 'read'); |
|
| 156 | + } else { |
|
| 157 | + $writer->writeElement($cs . 'read-write'); |
|
| 158 | + } |
|
| 159 | + $writer->endElement(); // access |
|
| 160 | + |
|
| 161 | + if (isset($user['summary']) && $user['summary']) { |
|
| 162 | + $writer->writeElement($cs . 'summary', $user['summary']); |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + $writer->endElement(); //user |
|
| 166 | + |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + } |
|
| 170 | 170 | } |
@@ -121,21 +121,21 @@ discard block |
||
| 121 | 121 | */ |
| 122 | 122 | function xmlSerialize(Writer $writer) { |
| 123 | 123 | |
| 124 | - $cs = '{' . Plugin::NS_OWNCLOUD . '}'; |
|
| 124 | + $cs = '{'.Plugin::NS_OWNCLOUD.'}'; |
|
| 125 | 125 | |
| 126 | 126 | if (!is_null($this->organizer)) { |
| 127 | 127 | |
| 128 | - $writer->startElement($cs . 'organizer'); |
|
| 128 | + $writer->startElement($cs.'organizer'); |
|
| 129 | 129 | $writer->writeElement('{DAV:}href', $this->organizer['href']); |
| 130 | 130 | |
| 131 | 131 | if (isset($this->organizer['commonName']) && $this->organizer['commonName']) { |
| 132 | - $writer->writeElement($cs . 'common-name', $this->organizer['commonName']); |
|
| 132 | + $writer->writeElement($cs.'common-name', $this->organizer['commonName']); |
|
| 133 | 133 | } |
| 134 | 134 | if (isset($this->organizer['firstName']) && $this->organizer['firstName']) { |
| 135 | - $writer->writeElement($cs . 'first-name', $this->organizer['firstName']); |
|
| 135 | + $writer->writeElement($cs.'first-name', $this->organizer['firstName']); |
|
| 136 | 136 | } |
| 137 | 137 | if (isset($this->organizer['lastName']) && $this->organizer['lastName']) { |
| 138 | - $writer->writeElement($cs . 'last-name', $this->organizer['lastName']); |
|
| 138 | + $writer->writeElement($cs.'last-name', $this->organizer['lastName']); |
|
| 139 | 139 | } |
| 140 | 140 | $writer->endElement(); // organizer |
| 141 | 141 | |
@@ -143,23 +143,23 @@ discard block |
||
| 143 | 143 | |
| 144 | 144 | foreach ($this->users as $user) { |
| 145 | 145 | |
| 146 | - $writer->startElement($cs . 'user'); |
|
| 146 | + $writer->startElement($cs.'user'); |
|
| 147 | 147 | $writer->writeElement('{DAV:}href', $user['href']); |
| 148 | 148 | if (isset($user['commonName']) && $user['commonName']) { |
| 149 | - $writer->writeElement($cs . 'common-name', $user['commonName']); |
|
| 149 | + $writer->writeElement($cs.'common-name', $user['commonName']); |
|
| 150 | 150 | } |
| 151 | - $writer->writeElement($cs . 'invite-accepted'); |
|
| 151 | + $writer->writeElement($cs.'invite-accepted'); |
|
| 152 | 152 | |
| 153 | - $writer->startElement($cs . 'access'); |
|
| 153 | + $writer->startElement($cs.'access'); |
|
| 154 | 154 | if ($user['readOnly']) { |
| 155 | - $writer->writeElement($cs . 'read'); |
|
| 155 | + $writer->writeElement($cs.'read'); |
|
| 156 | 156 | } else { |
| 157 | - $writer->writeElement($cs . 'read-write'); |
|
| 157 | + $writer->writeElement($cs.'read-write'); |
|
| 158 | 158 | } |
| 159 | 159 | $writer->endElement(); // access |
| 160 | 160 | |
| 161 | 161 | if (isset($user['summary']) && $user['summary']) { |
| 162 | - $writer->writeElement($cs . 'summary', $user['summary']); |
|
| 162 | + $writer->writeElement($cs.'summary', $user['summary']); |
|
| 163 | 163 | } |
| 164 | 164 | |
| 165 | 165 | $writer->endElement(); //user |