nextcloud /
notifications
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 38 | class PushController extends OCSController { |
||
| 39 | |||
| 40 | /** @var IDBConnection */ |
||
| 41 | private $db; |
||
| 42 | |||
| 43 | /** @var ISession */ |
||
| 44 | private $session; |
||
| 45 | |||
| 46 | /** @var IUserSession */ |
||
| 47 | private $userSession; |
||
| 48 | |||
| 49 | /** @var IProvider */ |
||
| 50 | private $tokenProvider; |
||
| 51 | |||
| 52 | /** @var Manager */ |
||
| 53 | private $identityProof; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * @param string $appName |
||
| 57 | * @param IRequest $request |
||
| 58 | * @param IDBConnection $db |
||
| 59 | * @param ISession $session |
||
| 60 | * @param IUserSession $userSession |
||
| 61 | * @param IProvider $tokenProvider |
||
| 62 | * @param Manager $identityProof |
||
| 63 | */ |
||
| 64 | public function __construct($appName, IRequest $request, IDBConnection $db, ISession $session, IUserSession $userSession, IProvider $tokenProvider, Manager $identityProof) { |
||
| 73 | |||
| 74 | /** |
||
| 75 | * @NoAdminRequired |
||
| 76 | * @NoCSRFRequired |
||
| 77 | * |
||
| 78 | * @param string $pushTokenHash |
||
| 79 | * @param string $devicePublicKey |
||
| 80 | * @return JSONResponse |
||
| 81 | */ |
||
| 82 | public function registerDevice($pushTokenHash, $devicePublicKey) { |
||
| 83 | $user = $this->userSession->getUser(); |
||
| 84 | if (!$user instanceof IUser) { |
||
|
|
|||
| 85 | return new JSONResponse([], Http::STATUS_UNAUTHORIZED); |
||
| 86 | } |
||
| 87 | |||
| 88 | if (!preg_match('/^([a-f0-9]{128})$/', $pushTokenHash)) { |
||
| 89 | return new JSONResponse(['message' => 'INVALID_PUSHTOKEN_HASH'], Http::STATUS_BAD_REQUEST); |
||
| 90 | } |
||
| 91 | |||
| 92 | View Code Duplication | if (strlen($devicePublicKey) !== 450 || |
|
| 93 | strpos($devicePublicKey, '-----BEGIN PUBLIC KEY-----') !== 0 || |
||
| 94 | strpos($devicePublicKey, '-----END PUBLIC KEY-----') !== 426) { |
||
| 95 | return new JSONResponse(['message' => 'INVALID_DEVICE_KEY'], Http::STATUS_BAD_REQUEST); |
||
| 96 | } |
||
| 97 | |||
| 98 | $tokenId = $this->session->get('token-id'); |
||
| 99 | try { |
||
| 100 | $token = $this->tokenProvider->getTokenById($tokenId); |
||
| 101 | } catch (InvalidTokenException $e) { |
||
| 102 | return new JSONResponse(['message' => 'INVALID_SESSION_TOKEN'], Http::STATUS_BAD_REQUEST); |
||
| 103 | } |
||
| 104 | |||
| 105 | $key = $this->identityProof->getKey($user); |
||
| 106 | |||
| 107 | try { |
||
| 108 | $created = $this->savePushToken($user, $token, $devicePublicKey, $pushTokenHash); |
||
| 109 | } catch (\BadMethodCallException $e) { |
||
| 110 | return new JSONResponse(['message' => 'INVALID_DEVICE_KEY'], Http::STATUS_BAD_REQUEST); |
||
| 111 | } |
||
| 112 | |||
| 113 | $deviceIdentifier = json_encode([$user->getCloudId(), $token->getId()]); |
||
| 114 | openssl_sign($deviceIdentifier, $signature, $key->getPrivate(), OPENSSL_ALGO_SHA512); |
||
| 115 | |||
| 116 | return new JSONResponse([ |
||
| 117 | 'publicKey' => $key->getPublic(), |
||
| 118 | 'deviceIdentifier' => base64_encode(hash('sha512', $deviceIdentifier, true)), |
||
| 119 | 'signature' => base64_encode($signature), |
||
| 120 | ], $created ? Http::STATUS_CREATED : Http::STATUS_OK); |
||
| 121 | } |
||
| 122 | |||
| 123 | /** |
||
| 124 | * @NoAdminRequired |
||
| 125 | * @NoCSRFRequired |
||
| 126 | * |
||
| 127 | * @param string $devicePublicKey |
||
| 128 | * @return JSONResponse |
||
| 129 | */ |
||
| 130 | public function removeDevice($devicePublicKey) { |
||
| 131 | $user = $this->userSession->getUser(); |
||
| 132 | if (!$user instanceof IUser) { |
||
| 133 | return new JSONResponse([], Http::STATUS_UNAUTHORIZED); |
||
| 134 | } |
||
| 135 | |||
| 136 | View Code Duplication | if (strlen($devicePublicKey) !== 450 || |
|
| 137 | strpos($devicePublicKey, '-----BEGIN PUBLIC KEY-----') !== 0 || |
||
| 138 | strpos($devicePublicKey, '-----END PUBLIC KEY-----') !== 426) { |
||
| 139 | return new JSONResponse(['message' => 'INVALID_DEVICE_KEY'], Http::STATUS_BAD_REQUEST); |
||
| 140 | } |
||
| 141 | |||
| 142 | $sessionId = $this->session->getId(); |
||
| 143 | try { |
||
| 144 | $token = $this->tokenProvider->getToken($sessionId); |
||
| 145 | } catch (InvalidTokenException $e) { |
||
| 146 | return new JSONResponse(['message' => 'INVALID_SESSION_TOKEN'], Http::STATUS_BAD_REQUEST); |
||
| 147 | } |
||
| 148 | |||
| 149 | try { |
||
| 150 | $this->deletePushToken($user, $token, $devicePublicKey); |
||
| 151 | } catch (\BadMethodCallException $e) { |
||
| 152 | return new JSONResponse(['message' => 'INVALID_DEVICE_KEY'], Http::STATUS_BAD_REQUEST); |
||
| 153 | } |
||
| 154 | |||
| 155 | return new JSONResponse([], Http::STATUS_ACCEPTED); |
||
| 156 | } |
||
| 157 | |||
| 158 | /** |
||
| 159 | * @param IUser $user |
||
| 160 | * @param IToken $token |
||
| 161 | * @param string $devicePublicKey |
||
| 162 | * @param string $pushTokenHash |
||
| 163 | * @return bool If the hash was new to the database |
||
| 164 | * @throws \BadMethodCallException |
||
| 165 | */ |
||
| 166 | protected function savePushToken(IUser $user, IToken $token, $devicePublicKey, $pushTokenHash) { |
||
| 184 | |||
| 185 | /** |
||
| 186 | * @param IUser $user |
||
| 187 | * @param IToken $token |
||
| 188 | * @param string $devicePublicKey |
||
| 189 | * @param string $pushTokenHash |
||
| 190 | * @return bool If the entry was created |
||
| 191 | */ |
||
| 192 | protected function insertPushToken(IUser $user, IToken $token, $devicePublicKey, $pushTokenHash) { |
||
| 206 | |||
| 207 | /** |
||
| 208 | * @param IUser $user |
||
| 209 | * @param IToken $token |
||
| 210 | * @param string $devicePublicKey |
||
| 211 | * @param string $pushTokenHash |
||
| 212 | * @return bool If the entry was updated |
||
| 213 | * @throws \BadMethodCallException |
||
| 214 | */ |
||
| 215 | View Code Duplication | protected function updatePushToken(IUser $user, IToken $token, $devicePublicKey, $pushTokenHash) { |
|
| 231 | |||
| 232 | /** |
||
| 233 | * @param IUser $user |
||
| 234 | * @param IToken $token |
||
| 235 | * @param string $devicePublicKey |
||
| 236 | * @return bool If the entry was deleted |
||
| 237 | * @throws \BadMethodCallException |
||
| 238 | */ |
||
| 239 | View Code Duplication | protected function deletePushToken(IUser $user, IToken $token, $devicePublicKey) { |
|
| 254 | } |
||
| 255 |
Loading history...
This error could be the result of:
1. Missing dependencies
PHP Analyzer uses your
composer.jsonfile (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects thecomposer.jsonto be in the root folder of your repository.Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the
requireorrequire-devsection?2. Missing use statement
PHP does not complain about undefined classes in
ìnstanceofchecks. For example, the following PHP code will work perfectly fine:If you have not tested against this specific condition, such errors might go unnoticed.