GEANT /
CAT
| Total Complexity | 67 |
| Total Lines | 420 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like IdP often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use IdP, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 49 | class IdP extends EntityWithDBProperties { |
||
| 50 | |||
| 51 | const EXTERNAL_DB_SYNCSTATE_NOT_SYNCED = 0; |
||
| 52 | const EXTERNAL_DB_SYNCSTATE_SYNCED = 1; |
||
| 53 | const EXTERNAL_DB_SYNCSTATE_NOTSUBJECTTOSYNCING = 2; |
||
| 54 | const TYPE_IDP = 'IdP'; |
||
| 55 | const TYPE_SP = 'SP'; |
||
| 56 | const TYPE_IDPSP = 'IdPSP'; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * |
||
| 60 | * @var integer synchronisation state with external database, if any |
||
| 61 | */ |
||
| 62 | private $externalDbSyncstate; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * The shortname of this IdP's federation |
||
| 66 | * @var string |
||
| 67 | */ |
||
| 68 | public $federation; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * The type of participant in DB enum notation |
||
| 72 | * @var string |
||
| 73 | */ |
||
| 74 | public $type; |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Constructs an IdP object based on its details in the database. |
||
| 78 | * Cannot be used to define a new IdP in the database! This happens via Federation::newIdP() |
||
| 79 | * |
||
| 80 | * @param int $instId the database row identifier |
||
| 81 | * @throws Exception |
||
| 82 | */ |
||
| 83 | public function __construct(int $instId) { |
||
| 84 | $this->databaseType = "INST"; |
||
| 85 | parent::__construct(); // now databaseHandle and logging is available |
||
| 86 | $this->entityOptionTable = "institution_option"; |
||
| 87 | $this->entityIdColumn = "institution_id"; |
||
| 88 | |||
| 89 | $this->identifier = $instId; |
||
| 90 | |||
| 91 | $idp = $this->databaseHandle->exec("SELECT inst_id, country,external_db_syncstate FROM institution WHERE inst_id = $this->identifier"); |
||
| 92 | // SELECT -> returns resource, not boolean |
||
| 93 | if (!$instQuery = mysqli_fetch_object(/** @scrutinizer ignore-type */ $idp)) { |
||
| 94 | throw new Exception("IdP $this->identifier not found in database!"); |
||
| 95 | } |
||
| 96 | |||
| 97 | $this->federation = $instQuery->country; |
||
| 98 | $this->externalDbSyncstate = $instQuery->external_db_syncstate; |
||
| 99 | |||
| 100 | // fetch attributes from DB; populates $this->attributes array |
||
| 101 | $this->attributes = $this->retrieveOptionsFromDatabase("SELECT DISTINCT option_name, option_lang, option_value, row |
||
| 102 | FROM $this->entityOptionTable |
||
| 103 | WHERE $this->entityIdColumn = ? |
||
| 104 | ORDER BY option_name", "IdP"); |
||
| 105 | |||
| 106 | $this->attributes[] = ["name" => "internal:country", |
||
| 107 | "lang" => NULL, |
||
| 108 | "value" => $this->federation, |
||
| 109 | "level" => "IdP", |
||
| 110 | "row" => 0, |
||
| 111 | "flag" => NULL]; |
||
| 112 | |||
| 113 | $this->name = $this->languageInstance->getLocalisedValue($this->getAttributes('general:instname')); |
||
| 114 | $eligibility = $this->eligibility(); |
||
| 115 | if (in_array(IdP::ELIGIBILITY_IDP, $eligibility) && in_array(IdP::ELIGIBILITY_SP, $eligibility)) { |
||
| 116 | $this->type = IdP::TYPE_IDPSP; |
||
| 117 | } elseif (in_array(IdP::ELIGIBILITY_IDP, $eligibility)) { |
||
| 118 | $this->type = IdP::TYPE_IDP; |
||
| 119 | } else { |
||
| 120 | $this->type = IdP::TYPE_SP; |
||
| 121 | } |
||
| 122 | $this->loggerInstance->debug(3, "--- END Constructing new IdP object ... ---\n"); |
||
| 123 | } |
||
| 124 | |||
| 125 | /** |
||
| 126 | * This function retrieves all registered profiles for this IdP from the database |
||
| 127 | * |
||
| 128 | * @param bool $activeOnly if and set to non-zero will cause listing of only those institutions which have some valid profiles defined. |
||
| 129 | * @return \core\AbstractProfile[] list of Profiles of this IdP |
||
| 130 | */ |
||
| 131 | public function listProfiles(bool $activeOnly = FALSE) { |
||
| 132 | $query = "SELECT profile_id FROM profile WHERE inst_id = $this->identifier" . ($activeOnly ? " AND showtime = 1" : ""); |
||
| 133 | $allProfiles = $this->databaseHandle->exec($query); |
||
| 134 | $returnarray = []; |
||
| 135 | // SELECT -> resource, not boolean |
||
| 136 | while ($profileQuery = mysqli_fetch_object(/** @scrutinizer ignore-type */ $allProfiles)) { |
||
| 137 | $oneProfile = ProfileFactory::instantiate($profileQuery->profile_id, $this); |
||
| 138 | $oneProfile->institution = $this->identifier; |
||
| 139 | $returnarray[] = $oneProfile; |
||
| 140 | } |
||
| 141 | |||
| 142 | $this->loggerInstance->debug(4, "listProfiles: " . print_r($returnarray, true)); |
||
| 143 | return $returnarray; |
||
| 144 | } |
||
| 145 | |||
| 146 | /** |
||
| 147 | * This function retrieves all SP deployments for this organisation from the database |
||
| 148 | * |
||
| 149 | * @param bool $activeOnly if and set to non-zero will cause listing of only those institutions which have some valid profiles defined. |
||
| 150 | * @return \core\AbstractDeployment[] list of deployments of this IdP |
||
| 151 | */ |
||
| 152 | public function listDeployments(bool $activeOnly = FALSE) { |
||
| 153 | $query = "SELECT deployment_id FROM deployment WHERE inst_id = $this->identifier" . ($activeOnly ? " AND status = " . AbstractDeployment::ACTIVE : ""); |
||
| 154 | $allDeployments = $this->databaseHandle->exec($query); |
||
| 155 | $returnarray = []; |
||
| 156 | // SELECT -> resource, not boolean |
||
| 157 | while ($deploymentQuery = mysqli_fetch_object(/** @scrutinizer ignore-type */ $allDeployments)) { |
||
| 158 | $returnarray[] = new DeploymentManaged($this, $deploymentQuery->deployment_id); |
||
| 159 | } |
||
| 160 | |||
| 161 | $this->loggerInstance->debug(4, "listDeployments: " . print_r($returnarray, true)); |
||
| 162 | return $returnarray; |
||
| 163 | } |
||
| 164 | |||
| 165 | const PROFILES_INCOMPLETE = 0; |
||
| 166 | const PROFILES_CONFIGURED = 1; |
||
| 167 | const PROFILES_SHOWTIME = 2; |
||
| 168 | |||
| 169 | /** |
||
| 170 | * looks through all the profiles of the inst and determines the highest prod-ready level among the profiles |
||
| 171 | * @return int highest level of completeness of all the profiles of the inst |
||
| 172 | */ |
||
| 173 | public function maxProfileStatus() { |
||
| 174 | $allProfiles = $this->databaseHandle->exec("SELECT sufficient_config + showtime AS maxlevel FROM profile WHERE inst_id = $this->identifier ORDER BY maxlevel DESC LIMIT 1"); |
||
| 175 | // SELECT yields a resource, not a boolean |
||
| 176 | while ($res = mysqli_fetch_object(/** @scrutinizer ignore-type */ $allProfiles)) { |
||
| 177 | return $res->maxlevel; |
||
| 178 | } |
||
| 179 | return self::PROFILES_INCOMPLETE; |
||
| 180 | } |
||
| 181 | |||
| 182 | /** This function retrieves an array of authorised users which can |
||
| 183 | * manipulate this institution. |
||
| 184 | * |
||
| 185 | * @return array owners of the institution; numbered array with members ID, MAIL and LEVEL |
||
| 186 | */ |
||
| 187 | public function listOwners() { |
||
| 195 | } |
||
| 196 | |||
| 197 | /** |
||
| 198 | * Primary owners are allowed to invite other (secondary) admins to the institution |
||
| 199 | * |
||
| 200 | * @param string $user ID of a logged-in user |
||
| 201 | * @return boolean TRUE if this user is an admin with FED-level blessing |
||
| 202 | */ |
||
| 203 | public function isPrimaryOwner($user) { |
||
| 210 | } |
||
| 211 | |||
| 212 | /** |
||
| 213 | * This function gets the profile count for a given IdP. |
||
| 214 | * |
||
| 215 | * The count could be retreived from the listProfiles method |
||
| 216 | * but this is less expensive. |
||
| 217 | * |
||
| 218 | * @return int profile count |
||
| 219 | */ |
||
| 220 | public function profileCount() { |
||
| 225 | } |
||
| 226 | |||
| 227 | /** |
||
| 228 | * This function gets the deployment count for a given IdP. |
||
| 229 | * |
||
| 230 | * @return int deployment count |
||
| 231 | */ |
||
| 232 | public function deploymentCount() { |
||
| 237 | } |
||
| 238 | |||
| 239 | const ELIGIBILITY_IDP = "IdP"; |
||
| 240 | const ELIGIBILITY_SP = "SP"; |
||
| 241 | |||
| 242 | /** |
||
| 243 | * checks whether the participant is an IdP, an SP, or both. |
||
| 244 | * |
||
| 245 | * @return array list of eligibilities |
||
| 246 | */ |
||
| 247 | public function eligibility() { |
||
| 248 | $eligibilites = $this->databaseHandle->exec("SELECT type FROM institution WHERE inst_id = $this->identifier"); |
||
| 249 | while ($iterator = mysqli_fetch_object(/** @scrutinizer ignore-type */ $eligibilites)) { |
||
| 250 | switch ($iterator->type) { |
||
| 251 | case "IdP": |
||
| 252 | return [IdP::ELIGIBILITY_IDP]; |
||
| 253 | case "SP": |
||
| 254 | return [IdP::ELIGIBILITY_SP]; |
||
| 255 | default: |
||
| 256 | return [IdP::ELIGIBILITY_IDP, IdP::ELIGIBILITY_SP]; |
||
| 257 | } |
||
| 258 | } |
||
| 259 | } |
||
| 260 | |||
| 261 | /** |
||
| 262 | * This function sets the timestamp of last modification of the child profiles to the current timestamp. |
||
| 263 | * |
||
| 264 | * This is needed for installer caching: all installers which are on disk |
||
| 265 | * must be re-created if an attribute changes. This timestamp here |
||
| 266 | * is used to determine if the installer on disk is still new enough. |
||
| 267 | * |
||
| 268 | * @return void |
||
| 269 | */ |
||
| 270 | public function updateFreshness() { |
||
| 271 | // freshness is always defined for *Profiles* |
||
| 272 | // IdP needs to update timestamp of all its profiles if an IdP-wide attribute changed |
||
| 273 | $this->databaseHandle->exec("UPDATE profile SET last_change = CURRENT_TIMESTAMP WHERE inst_id = '$this->identifier'"); |
||
| 274 | } |
||
| 275 | |||
| 276 | /** |
||
| 277 | * Adds a new profile to this IdP. |
||
| 278 | * |
||
| 279 | * Only creates the DB entry for the Profile. If you want to add attributes later, see Profile::addAttribute(). |
||
| 280 | * |
||
| 281 | * @param string $type exactly "RADIUS" or "SILVERBULLET", all other values throw an Exception |
||
| 282 | * @return AbstractProfile|NULL new Profile object if successful, or NULL if an error occured |
||
| 283 | */ |
||
|
Coding Style
Documentation
introduced
by
|
|||
| 284 | public function newProfile(string $type) { |
||
| 285 | $this->databaseHandle->exec("INSERT INTO profile (inst_id) VALUES($this->identifier)"); |
||
| 286 | $identifier = $this->databaseHandle->lastID(); |
||
| 287 | if ($identifier > 0) { |
||
| 288 | switch ($type) { |
||
| 289 | case AbstractProfile::PROFILETYPE_RADIUS: |
||
| 290 | return new ProfileRADIUS($identifier, $this); |
||
| 291 | case AbstractProfile::PROFILETYPE_SILVERBULLET: |
||
| 292 | $theProfile = new ProfileSilverbullet($identifier, $this); |
||
| 293 | $theProfile->addSupportedEapMethod(new \core\common\EAP(\core\common\EAP::EAPTYPE_SILVERBULLET), 1); |
||
| 294 | $theProfile->setRealm($this->identifier . "-" . $theProfile->identifier . "." . strtolower($this->federation) . strtolower(CONFIG_CONFASSISTANT['SILVERBULLET']['realm_suffix'])); |
||
| 295 | return $theProfile; |
||
| 296 | default: |
||
| 297 | throw new Exception("This type of profile is unknown and can not be added."); |
||
| 298 | } |
||
| 299 | } |
||
| 300 | return NULL; |
||
| 301 | } |
||
| 302 | |||
| 303 | /** |
||
| 304 | * Adds a new hotspot deployment to this IdP. |
||
| 305 | * |
||
| 306 | * Only creates the DB entry for the deployment. If you want to add attributes later, see Profile::addAttribute(). |
||
| 307 | * |
||
| 308 | * @param string $type exactly "RADIUS-SP" or "MANAGED-SP", all other values throw an Exception |
||
| 309 | * @return DeploymentManaged the newly created deployment |
||
| 310 | */ |
||
| 311 | public function newDeployment(string $type) { |
||
| 312 | switch ($type) { |
||
| 313 | case AbstractDeployment::DEPLOYMENTTYPE_CLASSIC: |
||
| 314 | // classic deployment exist in the eduroam DB. We don't do anything here. |
||
| 315 | throw new Exception("This type of deployment is handled externally and requesting it here makes no sense."); |
||
| 316 | case AbstractDeployment::DEPLOYMENTTYPE_MANAGED: |
||
| 317 | $this->databaseHandle->exec("INSERT INTO deployment (inst_id) VALUES($this->identifier)"); |
||
| 318 | $identifier = $this->databaseHandle->lastID(); |
||
| 319 | return new DeploymentManaged($this, $identifier); |
||
| 320 | default: |
||
| 321 | throw new Exception("This type of deployment is unknown and can not be added."); |
||
| 322 | } |
||
| 323 | } |
||
| 324 | |||
| 325 | /** |
||
| 326 | * deletes the IdP and all its profiles |
||
| 327 | * |
||
| 328 | * @return void |
||
| 329 | */ |
||
| 330 | public function destroy() { |
||
| 364 | } |
||
| 365 | |||
| 366 | /** |
||
| 367 | * Performs a lookup in an external database to determine matching entities to this IdP. |
||
| 368 | * |
||
| 369 | * The business logic of this function is roaming consortium specific; if no match algorithm is known for the consortium, FALSE is returned. |
||
| 370 | * |
||
| 371 | * @return mixed list of entities in external database that correspond to this IdP or FALSE if no consortium-specific matching function is defined |
||
| 372 | */ |
||
| 373 | public function getExternalDBSyncCandidates($type) { |
||
| 410 | } |
||
| 411 | |||
| 412 | /** |
||
| 413 | * returns the state of sync with the external DB. |
||
| 414 | * |
||
| 415 | * @return int |
||
| 416 | */ |
||
| 417 | public function getExternalDBSyncState() { |
||
| 418 | if (CONFIG_CONFASSISTANT['CONSORTIUM']['name'] == "eduroam" && isset(CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo']) && CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo'] == "Operations Team") { // SW: APPROVED |
||
| 419 | return $this->externalDbSyncstate; |
||
| 420 | } |
||
| 421 | return self::EXTERNAL_DB_SYNCSTATE_NOTSUBJECTTOSYNCING; |
||
| 422 | } |
||
| 423 | |||
| 424 | /** |
||
| 425 | * Retrieves the external DB identifier of this institution. Returns FALSE if no ID is known. |
||
| 426 | * |
||
| 427 | * @return string|boolean the external identifier; or FALSE if no external ID is known |
||
| 428 | */ |
||
| 429 | public function getExternalDBId() { |
||
| 430 | if (CONFIG_CONFASSISTANT['CONSORTIUM']['name'] == "eduroam" && isset(CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo']) && CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo'] == "Operations Team") { // SW: APPROVED |
||
| 431 | $idQuery = $this->databaseHandle->exec("SELECT external_db_id FROM institution WHERE inst_id = $this->identifier AND external_db_syncstate = " . self::EXTERNAL_DB_SYNCSTATE_SYNCED); |
||
| 432 | // SELECT -> it's a resource, not a boolean |
||
| 433 | if (mysqli_num_rows(/** @scrutinizer ignore-type */ $idQuery) == 0) { |
||
| 434 | return FALSE; |
||
| 435 | } |
||
| 436 | $externalIdQuery = mysqli_fetch_object(/** @scrutinizer ignore-type */ $idQuery); |
||
| 437 | return $externalIdQuery->external_db_id; |
||
| 438 | } |
||
| 439 | return FALSE; |
||
| 440 | } |
||
| 441 | |||
| 442 | /** |
||
| 443 | * Associates the external DB id with a CAT id |
||
| 444 | * |
||
| 445 | * @param string $identifier the external DB id, which can be alpha-numeric |
||
| 446 | * @return void |
||
| 447 | */ |
||
| 448 | public function setExternalDBId(string $identifier) { |
||
| 455 | } |
||
| 456 | } |
||
| 457 | } |
||
| 458 | |||
| 459 | /** |
||
| 460 | * removes the link between a CAT institution and the external DB |
||
| 461 | * |
||
| 462 | * @return void |
||
| 463 | */ |
||
| 464 | public function removeExternalDBId() { |
||
| 469 | } |
||
| 470 | } |
||
| 474 |
Loading history...