UserManagement::newIdPFromExternal() - Code Metrics - GEANT/CAT - Measure and Improve Code Quality continuously with Scrutinizer

UserManagement::newIdPFromExternal() A
last analyzed 2025-08-12 13:28 UTC

↳ Parent: UserManagement
Complexity

Conditions	3
Paths	4
Size

Total Lines	16
Code Lines	11
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	11
c	0
b	0
f	0
dl	0
loc	16
rs	9.9
cc	3
nc	4
nop	5
<?php

/*
 * *****************************************************************************
 * Contributions to this work were made on behalf of the GÉANT project, a 
 * project that has received funding from the European Union’s Framework 
 * Programme 7 under Grant Agreements No. 238875 (GN3) and No. 605243 (GN3plus),
 * Horizon 2020 research and innovation programme under Grant Agreements No. 
 * 691567 (GN4-1) and No. 731122 (GN4-2).
 * On behalf of the aforementioned projects, GEANT Association is the sole owner
 * of the copyright in all material which was developed by a member of the GÉANT
 * project. GÉANT Vereniging (Association) is registered with the Chamber of 
 * Commerce in Amsterdam with registration number 40535155 and operates in the 
 * UK as a branch of GÉANT Vereniging.
 * 
 * Registered office: Hoekenrode 3, 1102BR Amsterdam, The Netherlands. 
 * UK branch address: City House, 126-130 Hills Road, Cambridge CB2 1PQ, UK
 *
 * License: see the web/copyright.inc.php file in the file structure or
 *          <base_url>/copyright.php after deploying the software
 */

/**
 * This file contains the UserManagement class.
 *
 * @author Stefan Winter <[email protected]>
 * @author Tomasz Wolniewicz <[email protected]>
 * 
 * @license see LICENSE file in root directory
 * 
 * @package Developer
 */
/**
 * necessary includes
 */

namespace core;

use \Exception;
filter:
    dependency_paths: ["lib/*"]

/**
 * This class manages user privileges and bindings to institutions
 *
 * @author Stefan Winter <[email protected]>
 * @author Tomasz Wolniewicz <[email protected]>
 * 
 * @package Developer
 */
class UserManagement extends \core\common\Entity
{

    /**
     * our handle to the INST database
     * 
     * @var DBConnection
     */
    private $databaseHandle;
    public $currentInstitutions;
    public $newUser = false;
    public $hasPotenialNewInst = false;

    /**
     * Class constructor. Nothing special to be done when constructing.
     * 
     * @throws Exception
     */
    public function __construct()
    {
        parent::__construct();
        $handle = DBConnection::handle(self::$databaseType);
        if ($handle instanceof DBConnection) {
            $this->databaseHandle = $handle;
        } else {
            throw new Exception("This database type is never an array!");
        }
    }

    /**
     * database which this class queries by default
     * 
     * @var string
     */
    private static $databaseType = "INST";

    const TOKENSTATUS_OK_NEW = 1;
    const TOKENSTATUS_OK_EXISTING = 2;
    const TOKENSTATUS_FAIL_ALREADYCONSUMED = -1;
    const TOKENSTATUS_FAIL_EXPIRED = -2;
    const TOKENSTATUS_FAIL_NONEXISTING = -3;

    /**
     * Checks if a given invitation token exists and is valid in the invitations database
     * returns a string with the following values:
     * 
     * OK-NEW valid token exists, and is not attached to an existing institution. When consuming the token, a new inst will be created
     * OK-EXISTING valid token exists, and is attached to an existing institution. When consuming the token, user will be added as an admin
     * FAIL-NONEXISTINGTOKEN this token does not exist at all in the database
     * FAIL-ALREADYCONSUMED the token exists, but has been used before
     * FAIL-EXPIRED the token exists, but has expired
     * 
     * @param string $token the invitation token
     * @return int
     */
    public function checkTokenValidity($token)
    {
        $check = $this->databaseHandle->exec("SELECT invite_token, cat_institution_id 
                           FROM invitations 
                           WHERE invite_token = ? AND invite_created >= TIMESTAMPADD(DAY, -1, NOW()) AND used = 0", "s", $token);
        // SELECT -> resource, not boolean
        if ($tokenCheck = mysqli_fetch_object(/** @scrutinizer ignore-type */ $check)) {
            if ($tokenCheck->cat_institution_id === NULL) {
                return self::TOKENSTATUS_OK_NEW;
            }
            return self::TOKENSTATUS_OK_EXISTING;
        }
        // if we haven't returned from the function yet, it is an invalid token... 
        // be a little verbose what's wrong with it
        $checkReason = $this->databaseHandle->exec("SELECT invite_token, used FROM invitations WHERE invite_token = ?", "s", $token);
        // SELECT -> resource, not boolean
        if ($invalidTokenCheck = mysqli_fetch_object(/** @scrutinizer ignore-type */ $checkReason)) {
            if ($invalidTokenCheck->used == 1) {
                return self::TOKENSTATUS_FAIL_ALREADYCONSUMED;
            }
            return self::TOKENSTATUS_FAIL_EXPIRED;
        }
        return self::TOKENSTATUS_FAIL_NONEXISTING;
    }

    /**
     * This function creates a new IdP in the database based on a valid invitation token - or adds a new administrator
     * to an existing one. The institution is created for the logged-in user (second argument) who presents the token (first 
     * argument). The tokens are created via createToken().
     * 
     * @param string $token The invitation token (must exist in the database and be valid). 
     * @param string $owner Persistent User ID who becomes the administrator of the institution
     * @return IdP 
     */
    public function createIdPFromToken(string $token, string $owner)
    {
        new CAT(); // be sure that Entity's static members are initialised
        common\Entity::intoThePotatoes();
        // the token either has cat_institution_id set -> new admin for existing inst
        // or contains a number of parameters from external DB -> set up new inst
        $instinfo = $this->databaseHandle->exec("SELECT cat_institution_id, country, name, invite_issuer_level, invite_dest_mail, external_db_uniquehandle, invite_fortype 
                             FROM invitations 
                             WHERE invite_token = ? AND invite_created >= TIMESTAMPADD(DAY, -1, NOW()) AND used = 0", "s", $token);
        // SELECT -> resource, no boolean
        if ($invitationDetails = mysqli_fetch_assoc(/** @scrutinizer ignore-type */ $instinfo)) {
            if ($invitationDetails['cat_institution_id'] !== NULL) { // add new admin to existing IdP
                // we can't rely on a unique key on this table (user IDs 
                // possibly too long), so run a query to find there's an
                // tuple already; and act accordingly
                $catId = $invitationDetails['cat_institution_id'];
                $level = $invitationDetails['invite_issuer_level'];
                $destMail = $invitationDetails['invite_dest_mail'];
                $existing = $this->databaseHandle->exec("SELECT user_id FROM ownership WHERE user_id = ? AND institution_id = ?", "si", $owner, $catId);
                // SELECT -> resource, not boolean
                if (mysqli_num_rows(/** @scrutinizer ignore-type */ $existing) > 0) {
                    $this->databaseHandle->exec("UPDATE ownership SET blesslevel = ?, orig_mail = ? WHERE user_id = ? AND institution_id = ?", "sssi", $level, $destMail, $owner, $catId);
                } else {
                    $this->databaseHandle->exec("INSERT INTO ownership (user_id, institution_id, blesslevel, orig_mail) VALUES(?, ?, ?, ?)", "siss", $owner, $catId, $level, $destMail);
                }
                common\Logging::writeAudit_s((string) $owner, "OWN", "IdP " . $invitationDetails['cat_institution_id'] . " - added user as owner");
                common\Entity::outOfThePotatoes();
                return new IdP($invitationDetails['cat_institution_id']);
            }
            // create new IdP
            $fed = new Federation($invitationDetails['country']);
            // find the best name for the entity: C if specified, otherwise English, otherwise whatever
            if ($invitationDetails['external_db_uniquehandle'] != NULL) {
                $idp = $this->newIdPFromExternal($invitationDetails['external_db_uniquehandle'], $fed, $invitationDetails, $owner);
            } else {
                $bestnameguess = $invitationDetails['name'];
                $idp = new IdP($fed->newIdP('TOKEN', $invitationDetails['invite_fortype'], $owner, $invitationDetails['invite_issuer_level'], $invitationDetails['invite_dest_mail'], $bestnameguess));
                $idp->addAttribute("general:instname", 'C', $bestnameguess);
            }
            common\Logging::writeAudit_s($owner, "NEW", "IdP " . $idp->identifier . " - created from invitation");

            // in case we have more admins in the queue which were invited to 
            // administer the same inst but haven't redeemed their invitations 
            // yet, then we will have to rewrite the invitations to point to the
            // newly created actual IdP rather than the placeholder entry in the
            // invitations table
            // which other pending invites do we have?

            $otherPending = $this->databaseHandle->exec("SELECT id
                             FROM invitations 
                             WHERE invite_created >= TIMESTAMPADD(DAY, -1, NOW()) AND used = 0 AND name = ? AND country = ? AND ( cat_institution_id IS NULL OR external_db_uniquehandle IS NULL ) ", "ss", $invitationDetails['name'], $invitationDetails['country']);
            // SELECT -> resource, no boolean
            while ($pendingDetail = mysqli_fetch_object(/** @scrutinizer ignore-type */ $otherPending)) {
                $this->databaseHandle->exec("UPDATE invitations SET cat_institution_id = " . $idp->identifier . " WHERE id = " . $pendingDetail->id);
            }
            common\Entity::outOfThePotatoes();
            return $idp;
        }
    }

    /**
     * create new institution based on the edxternalDB data 
     * @param string $extId - the eduroam database identifier
     * @param object $fed - the CAT federation object where the institution should be created
     * @param string $owner
     * @return type
filter:
    dependency_paths: ["lib/*"]
     */
    public function createIdPFromExternal($extId, $fed, $owner)
    {
        $cat = new CAT();
        $ROid = strtoupper($fed->tld).'01';
        $externalinfo = $cat->getExternalDBEntityDetails($extId, $ROid);
        $invitationDetails = [
            'invite_fortype' => $externalinfo['type'],
            'invite_issuer_level' => "FED",
            'invite_dest_mail' => $_SESSION['auth_email'],
        ];
        $idp = $this->newIdPFromExternal($extId, $fed, $invitationDetails, $owner, $externalinfo);
        common\Logging::writeAudit_s($owner, "NEW", "IdP " . $idp->identifier . " - created from auto-registration of $extId");
        return $idp;

    }
    
    /*
     * This is the common part of the code for createIdPFromToken and createIdPFromExternal
     */
    private function newIdPFromExternal($extId, $fed, $invitationDetails, $owner, $externalinfo = [])
    {
        // see if we had a C language, and if not, pick a good candidate 
        if ($externalinfo == []) {
            $cat = new CAT();
            $ROid = strtoupper($fed->tld).'01';
            $externalinfo = $cat->getExternalDBEntityDetails($extId, $ROid);
        }
        $bestnameguess = $externalinfo['names']['C'] ?? $externalinfo['names']['en'] ?? reset($externalinfo['names']);
        $idp = new IdP($fed->newIdP('SELF', $invitationDetails['invite_fortype'], $owner, $invitationDetails['invite_issuer_level'], $invitationDetails['invite_dest_mail'], $bestnameguess));
        foreach ($externalinfo['names'] as $instlang => $instname) {
            $idp->addAttribute("general:instname", $instlang, $instname);
        }
        $idp->setExternalDBId($extId, strtolower($fed->tld));
        $idp->addAttribute("general:instname", 'C', $bestnameguess);
        return $idp;
    }

    /**
     * Adds a new administrator to an existing IdP
     * @param IdP    $idp  institution to which the admin is to be added.
     * @param string $user persistent user ID that is to be added as an admin.
     * @return boolean This function always returns TRUE.
     */
    public function addAdminToIdp($idp, $user)
    {
        $existing = $this->databaseHandle->exec("SELECT user_id FROM ownership WHERE user_id = ? AND institution_id = ?", "si", $user, $idp->identifier);
        // SELECT -> resource, not boolean
        if (mysqli_num_rows(/** @scrutinizer ignore-type */ $existing) == 0) {
            $this->databaseHandle->exec("INSERT INTO ownership (institution_id,user_id,blesslevel,orig_mail) VALUES(?, ?, 'FED', 'SELF-APPOINTED')", "is", $idp->identifier, $user);
        }
        return TRUE;
    }

    /**
     * Deletes an administrator from the IdP. If the IdP and user combination doesn't match, nothing happens.
     * @param IdP    $idp  institution from which the admin is to be deleted.
     * @param string $user persistent user ID that is to be deleted as an admin.
     * @return boolean This function always returns TRUE.
     */
    public function removeAdminFromIdP($idp, $user)
    {
        $this->databaseHandle->exec("DELETE from ownership WHERE institution_id = $idp->identifier AND user_id = ?", "s", $user);
        return TRUE;
    }

    /**
     * Invalidates a token so that it can't be used any more. Tokens automatically expire after 24h, but can be invalidated
     * earlier, e.g. after having been used to create an institution. If the token doesn't exist in the DB or is already invalidated,
     * nothing happens.
     * 
     * @param string $token the token to invalidate
     * @return boolean This function always returns TRUE.
     */
    public function invalidateToken($token)
    {
        $this->databaseHandle->exec("UPDATE invitations SET used = 1 WHERE invite_token = ?", "s", $token);
        return TRUE;
    }

    /**
     * Creates a new invitation token. The token's main purpose is to be sent out by mail. The function either can generate a token for a new 
     * administrator of an existing institution, or for a new institution. In the latter case, the institution only actually gets 
     * created in the DB if the token is actually consumed via createIdPFromToken().
     * 
     * @param boolean $isByFedadmin   is the invitation token created for a federation admin (TRUE) or from an existing inst admin (FALSE)
     * @param array   $for            identifiers (typically email addresses) for which the invitation is created
     * @param mixed   $instIdentifier either an instance of the IdP class (for existing institutions to invite new admins) or a string (new institution - this is the inst name then)
     * @param string  $externalId     if the IdP to be created is related to an external DB entity, this parameter contains that ID
     * @param string  $country        if the institution is new (i.e. $inst is a string) this parameter needs to specify the federation of the new inst
     * @param string  $partType       the type of participant
     * @return mixed The function returns either the token (as string) or FALSE if something went wrong
     * @throws Exception
     */
    public function createTokens($isByFedadmin, $for, $instIdentifier, $externalId = 0, $country = 0, $partType = 0)
    {
        $level = ($isByFedadmin ? "FED" : "INST");
        $tokenList = [];
        foreach ($for as $oneDest) {
            $token = bin2hex(random_bytes(40));
            if ($instIdentifier instanceof IdP) {
                $this->databaseHandle->exec("INSERT INTO invitations (invite_fortype, invite_issuer_level, invite_dest_mail, invite_token,cat_institution_id) VALUES(?, ?, ?, ?, ?)", "ssssi", $instIdentifier->type, $level, $oneDest, $token, $instIdentifier->identifier);
                $tokenList[$token] = $oneDest;
            } else if (func_num_args() == 5) {
                $ROid = strtoupper($country).'01';
                $cat = new CAT();
                $extinfo = $cat->getExternalDBEntityDetails($externalId, $ROid);
                $extCountry = $extinfo['country'];
                $extType = $extinfo['type'];
                if(\config\Master::FUNCTIONALITY_FLAGS['SINGLE_SERVICE'] === 'MSP') {
                    $extType = \core\IdP::TYPE_SP;
                }
                $this->databaseHandle->exec("INSERT INTO invitations (invite_fortype, invite_issuer_level, invite_dest_mail, invite_token,name,country, external_db_uniquehandle) VALUES(?, ?, ?, ?, ?, ?, ?)", "sssssss", $extType, $level, $oneDest, $token, $instIdentifier, $extCountry, $externalId);
                $tokenList[$token] = $oneDest;
            } else if (func_num_args() == 6) { // string name, and country set - whole new IdP
                $this->databaseHandle->exec("INSERT INTO invitations (invite_fortype, invite_issuer_level, invite_dest_mail, invite_token,name,country) VALUES(?, ?, ?, ?, ?, ?)", "ssssss", $partType, $level, $oneDest, $token, $instIdentifier, $country);
                $tokenList[$token] = $oneDest;
            } else {
                throw new Exception("The invitation is somehow ... wrong.");
            }
        }
        if (count($for) != count($tokenList)) {
            throw new Exception("Creation of a new token failed!");
        }
        return $tokenList;
    }

    /**
     * Retrieves all pending invitations for an institution or for a federation.
     * 
     * @param int $idpIdentifier the identifier of the institution. If not set, returns invitations for not-yet-created insts
     * @return array if idp_identifier is set: an array of strings (mail addresses); otherwise an array of tuples (country;name;mail)
     */
    public function listPendingInvitations($idpIdentifier = 0)
    {
        $retval = [];
        $invitations = $this->databaseHandle->exec("SELECT cat_institution_id, country, name, invite_issuer_level, invite_dest_mail, invite_token , TIMESTAMPADD(DAY, 1, invite_created) as expiry
                                        FROM invitations 
                                        WHERE cat_institution_id " . ( $idpIdentifier != 0 ? "= $idpIdentifier" : "IS NULL") . " AND invite_created >= TIMESTAMPADD(DAY, -1, NOW()) AND used = 0");
        // SELECT -> resource, not boolean
        common\Logging::debug_s(4, "Retrieving pending invitations for " . ($idpIdentifier != 0 ? "IdP $idpIdentifier" : "IdPs awaiting initial creation" ) . ".\n");
        while ($invitationQuery = mysqli_fetch_object(/** @scrutinizer ignore-type */ $invitations)) {
            $retval[] = ["country" => $invitationQuery->country, "name" => $invitationQuery->name, "mail" => $invitationQuery->invite_dest_mail, "token" => $invitationQuery->invite_token, "expiry" => $invitationQuery->expiry];
        }
        return $retval;
    }

    /** Retrieves all invitations which have expired in the last hour.
     * 
     * @return array of expired invitations
     */
    public function listRecentlyExpiredInvitations()
    {
        $retval = [];
        $invitations = $this->databaseHandle->exec("SELECT cat_institution_id, country, name, invite_issuer_level, invite_dest_mail, invite_token 
                                        FROM invitations 
                                        WHERE invite_created >= TIMESTAMPADD(HOUR, -25, NOW()) AND invite_created < TIMESTAMPADD(HOUR, -24, NOW()) AND used = 0");
        // SELECT -> resource, not boolean
        while ($expInvitationQuery = mysqli_fetch_object(/** @scrutinizer ignore-type */ $invitations)) {
            common\Logging::debug_s(4, "Retrieving recently expired invitations (expired in last hour)\n");
            if ($expInvitationQuery->cat_institution_id == NULL) {
                $retval[] = ["country" => $expInvitationQuery->country, "level" => $expInvitationQuery->invite_issuer_level, "name" => $expInvitationQuery->name, "mail" => $expInvitationQuery->invite_dest_mail];
            } else {
                $retval[] = ["country" => $expInvitationQuery->country, "level" => $expInvitationQuery->invite_issuer_level, "name" => "Existing IdP", "mail" => $expInvitationQuery->invite_dest_mail];
            }
        }
        return $retval;
    }

    /**
     * For a given persistent user identifier, returns an array of institution identifiers (not the actual objects!) for which this
     * user is the/a administrator and also do comparisons to the eduroam DB results.
     * If the federation autoregister-synced flag is set if it turns out that the eduroam DB
     * lists the email of the current logged-in admin as an admin of an existing CAT institution
     * and this institution is synced to the matching external institutuin then this admin
     * will be automatically added tho the institution and the 'existing' part of $this->currentInstitutions
     * will be updated. This identifier will also be listed to $this->currentInstitutions['resynced']
     * 
     * If the federation autoregister-new-inst flag is set and there are exeternal institututions which could be
     * candidated for creating them in CAT - add the identifiers of these institutuins to this->currentInstitutions[new']
     * 
     * @param boolean $applyAutoSync controls if automatic additions if the user to the admins should be performed
     * @return array array of institution IDs
     */ 
    public function listInstitutionsByAdmin($applyAutoSync = false)
    {
        $edugain = $_SESSION['eduGAIN'];
        // get the list of local identifers of institutions managed by this user
        // it will be returned as $this->currentInstitutions
        $this->getCurrentInstitutionsByAdmin();
        if (count($this->currentInstitutions) == 0) {
            $this->newUser = true;
        }
        // check if selfservice_registration is set to eduGAIN - if not then return with the durrent list
        if (\config\ConfAssistant::CONSORTIUM['selfservice_registration'] !== 'eduGAIN') {
            common\Logging::debug_s(4, "selfservice_registration not set to eduGAIN\n");
            return $this->currentInstitutions;
        }
        // now add additional institutions based on the external DB 
        // proceed only if user has been authenticated fron an eduGAIN IdP        
        if ($edugain == false) {
            return $this->currentInstitutions;            
        }
        $email = $_SESSION['auth_email'];
        $externalDB = CAT::determineExternalConnection();
        // get the list of identifiers in the external DB with this user listed as the admin and linked to CAT institutions
        $extInstList = $externalDB->listExternalEntitiesByUserEmail($email);
        $extInstListTmp = $extInstList;
        // we begin by removing entites in $extInstList which are already managed by this user and synced -
        // these require no further checking
        foreach ($extInstListTmp as $country => $extInstCountryList) {
            $len = count($extInstCountryList);
            for($i = 0; $i < $len; ++$i) {
                $extInst = $extInstCountryList[$i];
                if ($extInst['inst_id'] != NULL && in_array($extInst['inst_id'], $this->currentInstitutions['existing'])) {
                    unset($extInstList[$country][$i]);
                }
            }
            if (count($extInstList[$country]) == 0) {
                unset($extInstList[$country]);
            }
        }
        // now verify the $extInstList separately for each federation making sure
        // that the federation allows autoregistration
        foreach ($extInstList as $country => $extInstCountryList) {
            $fed = new Federation($country);
            $this->doExternalDBAutoregister($extInstCountryList, $fed, $applyAutoSync);
            $this->doExternalDBAutoregisterNew($extInstCountryList, $fed);
        }
        // now we run tests for adding admins based on pairwise-id and entitlement
        $entitledCountries = $this->getUserEntitledFed();
        $entitlementInst = $this->listCatInstitutionsByPairwiseId();
        common\Logging::debug_s(4, $entitlementInst, "entitlementInst\n", "\n");
        foreach ($entitlementInst as $country => $instList) {
            if (!in_array($country, $entitledCountries)) {
                continue;
            }
            $fed = new Federation($country);
            $this->doEntitlementAutoregister($instList, $fed);
        }
        $_SESSION['entitledIdPs'] = array_column($this->currentInstitutions['entitlement'], 0);
        common\Logging::debug_s(4, $this->currentInstitutions, "currentInstitutions\n", "\n");
        return $this->currentInstitutions;
    }

    /**
     * Handle auto-registration of admin for CAT institutions which are synced to
     * eduroam DB institutions which have the current admin listed
     * The method verifies that the federation allows auto-registration
     * 
     * @param array $extInstCountryList - list of eduroam DB candidate institutions
     * @param object $fed - the Federation object
     * @param boolean $applyAutoSync - do we write updated to the databaes?
     */
    private function doExternalDBAutoregister($extInstCountryList, $fed, $applyAutoSync = false) {
        $userId = $_SESSION['user'];
        $email = $_SESSION['auth_email'];
        $autoSyncedFlag = $fed->getAttributes('fed:autoregister-synced');
        if ($autoSyncedFlag == []) {
            return;
        }        
        foreach ($extInstCountryList as $extInst) {
            common\Logging::debug_s(4, "Testing ".$extInst['external_db_id']."\n");
            if ($extInst['inst_id'] == null) {
                // this institution is not synced, skip
                continue;
            }
            // is institution synced, if so we add this admin if the federation allows
            common\Logging::debug_s(4, "It is synced\n");
            $this->currentInstitutions['resynced'][] = $extInst['inst_id'];
            if ($applyAutoSync) {
                common\Logging::debug_s(4, "Adding admin to ".$extInst['inst_id']."\n");
                $this->currentInstitutions['existing'][] = $extInst['inst_id'];
                $query = "INSERT INTO ownership (user_id, institution_id, blesslevel, orig_mail) VALUES (?, ?, 'FED', ?)";
                $this->databaseHandle->exec($query, 'sis', $userId, $extInst['inst_id'], $email);
            }
        }
    }
    
    /**
     * Handle auto-creation of new CAT institutions which match
     * eduroam DB institutions which have the current admin listed
     * The method verifies that the federation allows auto-cereation
     * 
     * @param array $extInstCountryList - list of eduroam DB candidate institutions
     * @param object $fed - the Federation object
     */
    private function doExternalDBAutoregisterNew($extInstCountryList, $fed) {
        $newInstFlag = $fed->getAttributes('fed:autoregister-new-inst');
        if ($newInstFlag == []) {
            return;
        }
        foreach ($extInstCountryList as $extInst) {
            common\Logging::debug_s(4, "Testing ".$extInst['external_db_id']." for potential new inst\n");
            if ($extInst['inst_id'] != null) { // there alreay exeists a CAT institution synced to this one
                continue;
            }
            $country = $fed->tld;
            // now run checks against creating dupplicates in CAT DB
            $disectedNames = ExternalEduroamDBData::dissectCollapsedInstitutionNames($extInst['name']);
            $names = $disectedNames['joint'];
            $realms = ExternalEduroamDBData::dissectCollapsedInstitutionRealms($extInst['realm']);
            $foundMatch = $this->checkForSimilarInstitutions($names, $realms);
            common\Logging::debug_s(4, $foundMatch, "checkForSimilarInstitutions returned: ","\n");
            if ($foundMatch == 0) {
                $this->currentInstitutions['new'][] = [$extInst['external_db_id'], $disectedNames['perlang'], $country];
            }
        }
    }

    /**
     * Handle auto-registration of admin for CAT institutions
     * based on data from eduGAIN login
     * The method verifies that the federation allows this type of auto-registration
     * 
     * @param boolean $applyAutoSync - do we write updated to the databaes?
     * @param object $fed - the Federation object
     */
    private function doEntitlementAutoregister($instList, $fed) {
        $useEntitlementFlag = $fed->getAttributes('fed:autoregister-entitlement');
        if ($useEntitlementFlag == []) {
            return;
        }
        $country = $fed->tld;
        foreach ($instList as $instId) {
            if (!in_array($instId, $this->currentInstitutions['existing'])) {
                $this->currentInstitutions['entitlement'][] = [$instId, $country];
            }
        }
      
    }

    /**
     * Generate a list of externalDB institutions for which the admin is entitled
     * based on the eduPersonEntitlement setting and scope from pairwise-id
     * The 
     * @return array indexed by countries
     */
    private function listCatInstitutionsByPairwiseId() {
        if (!isset(\config\ConfAssistant::CONSORTIUM['entitlement'])) {
            return [];            
        }
        // first check if pairwise-id is set
        $userId = $_SESSION['user'];
        if (substr($userId, 0, 12) !== 'pairwise-id:') {
            return [];
        }

        // next check if entitlement is setand matches our expectations
        if (!isset($_SESSION['entitlement'])) {
            return [];
        }

        // get realm from pariwise-id
        if (preg_match('/^pairwise-id:[^@]+@([^!]+)!/', $userId, $matches) == 0) {
            return [];            
        }

        $userRealm = $matches[1];
        common\Logging::debug_s(4, $userRealm, "userRealm:", "\n");
        // list CAT inst_id and country from the profile
        $query = "SELECT DISTINCT profile.inst_id,country FROM profile JOIN institution on profile.inst_id = institution.inst_id WHERE realm LIKE '%@$userRealm' OR realm LIKE '%@%.$userRealm'";
        $institutions = $this->databaseHandle->exec($query);
        $catInstList = $institutions->fetch_all();
        $returnarray = [];
        foreach ($catInstList as $inst) {
            $country = $inst[1];
            if (!isset($returnarray[$country])) {
                $returnarray[$country] = [];
            }
            $returnarray[$country][] = $inst[0];
        }
        return $returnarray;
    }
    
    /**
     * Get the list of eduroam countries that the user could potentially auto-register
     * based on eduPersonEntitlement. The list of countries is based on matching between
     * the eduGAIN federation where the eduGAIN IdP is registered and the counters that this federation serves
     * Before passing on the list it is checked if particular countries allow entitlement-based
     * autoregistration
     * 
     * @return array indexed by countries
     */
    private function getUserEntitledFed() {
        if (!isset($_SESSION['entitlement'])) {
            return [];
        }
        $entitledCountries = [];
        $countries = $this->databaseHandle->exec("SELECT country FROM edugain WHERE reg_auth = ?", 's', $_SESSION['eduGAIN']);
        $countryList = $countries->fetch_all();
        $countriesTmp = [];

        foreach ($countryList as $country) {
            $requiredEntitlement = NULL;
            $countryCode = $country[0];
            $fed = new Federation($countryCode);
            $autoreg = $fed->getAttributes('fed:autoregister-entitlement');
            $entitlementVal = $fed->getAttributes('fed:entitlement-attr');
            if (isset($autoreg[0]['value']) && $autoreg[0]['value'] == 'on') {
                $requiredEntitlement = isset($entitlementVal[0]['value']) ? $entitlementVal[0]['value'] : \config\ConfAssistant::CONSORTIUM['entitlement'];
            }
            common\Logging::debug_s(4, $requiredEntitlement, "$countryCode requiredEntitlement\n", "\n");
            if (in_array($requiredEntitlement, $_SESSION['entitlement'])) {
                $entitledCountries[] = $countryCode;
            }
        }
        common\Logging::debug_s(4, $entitledCountries, "entitledCountries:\n", "\n");
        return $entitledCountries;
    }
    
    /**
     * Tests if the institution with these identifier does not yet exist in CAT. 
     * This is done by testing the admins "new" institutions, this way we also make sure
     * that this admin is actually also allowed to create the new one
     * 
     * @return int 1 or 0. 1 means we are free to create the inst.
     */
    
    public function checkForCatMatch($extId, $ROid) {
        $this->listInstitutionsByAdmin();
        foreach ($this->currentInstitutions['new'] as $newInst) {
            if ($extId == $newInst[0] && $ROid == strtoupper($newInst[2]).'01') {
                return 0;
            }
        }
        return 1;
    }
    
    /**
     * get the list of current institutions of the given admin
     * 
     * This method does not rerurn anything but sets $this->currentInstitutions
     * it only fillsh the 'existing' block, leaving the other two for other methods
     * to deal with
     */
    private function getCurrentInstitutionsByAdmin() {
        $returnarray = [
            'existing' => [],
            'resynced' => [],
            'new' => [],
            'entitlement' => []
        ];
        $userId = $_SESSION['user'];
        // get the list of local identifers of institutions managed by this user
        $institutions = $this->databaseHandle->exec("SELECT ownership.institution_id as inst_id FROM ownership WHERE user_id = ? ORDER BY institution_id", "s", $userId);
        // SELECT -> resource, not boolean
        $catInstList = $institutions->fetch_all();
        foreach ($catInstList as $inst) {
            $returnarray['existing'][] = $inst[0];
        }
        $this->currentInstitutions = $returnarray;
    }

    /**
     * given arrays of realms and names check if there already are institutions in CAT that 
     * could be a match - this is for ellimination and against creating duplicates
     * still this is not perfect, no realms given and institutions with a slightly different
     * name will return no-match and thus open possibility for dupplicates
     * 
     * @param array $namesToTest
     * @param array $realmsToTest
     * @return int - 1 - a match was found, 0 - no match found
     */
    private function checkForSimilarInstitutions($namesToTest, $realmsToTest) {
        //generate a list of all existing realms
        $realmsList = [];
        $query = 'SELECT DISTINCT realm FROM profile';
        $realmsResult = $this->databaseHandle->exec($query);
        while ($anonId = $realmsResult->fetch_row()) {
            $realmsList[] = mb_strtolower(preg_replace('/^.*@/', '', $anonId[0]), 'UTF-8');
        }
        // now test realms
        $results = array_intersect($realmsToTest, $realmsList);
        if (count($results) !== 0) {
            return 1;
        }
        
        // generate a list of all institution names
        $query = "SELECT DISTINCT CONVERT(option_value USING utf8mb4) FROM institution_option WHERE option_name='general:instname'";
        $namesResult = $this->databaseHandle->exec($query);
        $namesList = [];
        while ($name = $namesResult->fetch_row()) {
            $namesList[] = mb_strtolower($name[0], 'UTF-8');
        }

        // now test names
        $results = array_intersect($namesToTest, $namesList);
        if (count($results) !== 0) {
            return 1;
        }
        return 0;
    }
}
GEANT / CAT

UserManagement::newIdPFromExternal() A last analyzed 2025-08-12 13:28 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

UserManagement::newIdPFromExternal() A
last analyzed 2025-08-12 13:28 UTC
