cilogon /
service
| Conditions | 23 |
| Paths | 80 |
| Total Lines | 100 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 235 | function verifyUserCodeParam() |
||
| 236 | { |
||
| 237 | $retval = false; // Assume user code & other session info is not valid |
||
| 238 | |||
| 239 | $log = new Loggit(); |
||
| 240 | |||
| 241 | // If idphint/selected_idp were previously set in the clientparams |
||
| 242 | // PHP session variable, get them this time around. |
||
| 243 | $clientparams = array_intersect_key( |
||
| 244 | json_decode(Util::getSessionVar('clientparams'), true), |
||
| 245 | ['idphint' => 1, 'selected_idp' => 1] |
||
| 246 | ); |
||
| 247 | |||
| 248 | // If a user_code was passed in, use that to get the associated |
||
| 249 | // clientparams. Otherwise, get clientparams from the PHP session. |
||
| 250 | $user_code = Util::getGetorPostVar('user_code'); |
||
| 251 | if (strlen($user_code) > 0) { |
||
| 252 | Util::unsetSessionVar('clientparams'); // Don't use any previous values |
||
| 253 | $log->info('Calling checkUserCode dbService method...'); |
||
| 254 | $dbs = new DBService(); |
||
| 255 | if ( |
||
| 256 | ($dbs->checkUserCode($user_code)) && |
||
| 257 | (!($dbs->status & 1)) |
||
| 258 | ) { // STATUS_OK codes are even |
||
| 259 | if (strlen($dbs->client_id) > 0) { |
||
| 260 | // Use the client_id associated with the user_code to get |
||
| 261 | // the rest of the OAuth2 client registration information. |
||
| 262 | $clientparams['user_code'] = $dbs->user_code; |
||
| 263 | $clientparams['client_id'] = $dbs->client_id; |
||
| 264 | $clientparams['scope'] = $dbs->scope; |
||
| 265 | // getOIDCClientParams assumes client_id is stored in the |
||
| 266 | // passed-in $clientparams variable. |
||
| 267 | Util::getOIDCClientParams($clientparams); |
||
| 268 | // If no scope was requested, then assume ALL scopes |
||
| 269 | // 'scope' is a space-separated string, while |
||
| 270 | // client_scopes is a JSON list; need to transform into |
||
| 271 | // space-separated string. |
||
| 272 | if (strlen($clientparams['scope']) == 0) { |
||
| 273 | $clientparams['scope'] = implode( |
||
| 274 | ' ', |
||
| 275 | json_decode($clientparams['client_scopes'], true) |
||
| 276 | ); |
||
| 277 | } |
||
| 278 | } else { |
||
| 279 | Util::setSessionVar('user_code_error_msg', 'Unable to find a client matching the user code.'); |
||
| 280 | } |
||
| 281 | } else { // STATUS_ERROR code returned |
||
| 282 | $errstr = 'Error checking user code.'; // Generic error message |
||
| 283 | if (!is_null($dbs->status)) { |
||
| 284 | $errstr = array_search($dbs->status, DBService::$STATUS); |
||
| 285 | // Customize error messages for Device Authz Grant flow |
||
| 286 | if ($dbs->status == 0x10001) { |
||
| 287 | $errstr = 'User code not found.'; |
||
| 288 | } elseif ($db->status == 0x10003) { |
||
| 289 | $errstr = 'User code expired.'; |
||
| 290 | } |
||
| 291 | } |
||
| 292 | Util::setSessionVar('user_code_error_msg', $errstr); |
||
| 293 | } |
||
| 294 | } else { // No user_code passed in, so check the PHP session clientparams |
||
| 295 | $clientparams = json_decode(Util::getSessionVar('clientparams'), true); |
||
| 296 | } |
||
| 297 | |||
| 298 | // If no error so far, check all of the client parameters |
||
| 299 | if ( |
||
| 300 | (strlen(Util::getSessionVar('user_code_error_msg')) == 0) && |
||
| 301 | (isset($clientparams['user_code'])) && |
||
| 302 | (isset($clientparams['client_id'])) && |
||
| 303 | (isset($clientparams['scope'])) && |
||
| 304 | (isset($clientparams['client_name'])) && |
||
| 305 | (isset($clientparams['client_home_url'])) && |
||
| 306 | (isset($clientparams['client_callback_uri'])) && |
||
| 307 | (isset($clientparams['client_scopes'])) && |
||
| 308 | (isset($clientparams['clientstatus'])) && |
||
| 309 | (!($clientparams['clientstatus'] & 1)) |
||
| 310 | ) { // STATUS_OK codes are even |
||
| 311 | $retval = true; |
||
| 312 | Util::setSessionVar('clientparams', json_encode($clientparams)); |
||
| 313 | } else { |
||
| 314 | Util::unsetSessionVar('clientparams'); |
||
| 315 | } |
||
| 316 | |||
| 317 | // Save idphint/selected_idp from query parameters to PHP session |
||
| 318 | $idphint = Util::getGetVar('idphint'); |
||
| 319 | $selected_idp = Util::getGetVar('selected_idp'); |
||
| 320 | if ( |
||
| 321 | (strlen($idphint) > 0) || |
||
| 322 | (strlen($selected_idp) > 0) |
||
| 323 | ) { |
||
| 324 | if (strlen($idphint) > 0) { |
||
| 325 | $clientparams['idphint'] = $idphint; |
||
| 326 | } |
||
| 327 | if (strlen($selected_idp) > 0) { |
||
| 328 | $clientparams['selected_idp'] = $selected_idp; |
||
| 329 | } |
||
| 330 | Util::setSessionVar('clientparams', json_encode($clientparams)); |
||
| 331 | } |
||
| 332 | |||
| 333 | return $retval; |
||
| 334 | } |
||
| 335 |
Loading history...
This check looks for functions that have already been defined in other files.
Some Codebases, like WordPress, make a practice of defining functions multiple times. This may lead to problems with the detection of function parameters and types. If you really need to do this, you can mark the duplicate definition with the
@ignoreannotation.See also the PhpDoc documentation for @ignore.