CILogon\Service\Util::saveUserToDataStore()

Complexity

Conditions	40
Paths	240

Size

Total Lines	173
Code Lines	121

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	1640

Importance

Changes	22
Bugs	0	Features	0

<?php
    public static function saveUserToDataStore(...$args)
    {
        $dbs = new DBService();

        // Save the passed-in variables to the session for later use
        // (e.g., by the error handler in handleGotUser). Then get these
        // session variables into local vars for ease of use.
        static::setUserAttributeSessionVars(...$args);

        // This bit of trickery sets local variables from the PHP session
        // that was just populated, using the names in the $user_attrs array.
        foreach (DBService::$user_attrs as $value) {
            $$value = static::getSessionVar($value);
        }

        // For the new Google OAuth 2.0 endpoint, we want to keep the
        // old Google OpenID endpoint URL in the database (so user does
        // not get a new certificate subject DN). Change the idp
        // and idp_display_name to the old Google OpenID values.
        if (
            ($idp_display_name == 'Google+') ||

The variable $idp_display_name seems to be never defined.

            ($idp == static::getAuthzUrl('Google'))

The variable $idp seems to be never defined.

        ) {
            $idp_display_name = 'Google';
            $idp = 'https://www.google.com/accounts/o8/id';
        }

        // In the database, keep a consistent ProviderId format: only
        // allow 'http' (not 'https') and remove any 'www.' prefix.
        if ($loa == 'openid') {

The variable $loa seems to be never defined.

            $idp = preg_replace('%^https://(www\.)?%', 'http://', $idp);

The variable $idp does not seem to be defined for all execution paths leading up to this point.

        }

        // Call the dbService to get the user using IdP attributes.
        $result = $dbs->getUser(
            $remote_user,

The variable $remote_user seems to be never defined.

            $idp,
            $idp_display_name,

The variable $idp_display_name does not seem to be defined for all execution paths leading up to this point.

            $first_name,

The variable $first_name seems to be never defined.

            $last_name,

The variable $last_name seems to be never defined.

            $display_name,

The variable $display_name does not exist. Did you maybe mean $idp_display_name?

            $email,

The variable $email seems to be never defined.

            $loa,
            $eppn,

The variable $eppn seems to be never defined.

            $eptid,

The variable $eptid seems to be never defined.

            $open_id,

The variable $open_id seems to be never defined.

            $oidc,

The variable $oidc seems to be never defined.

            $subject_id,

The variable $subject_id seems to be never defined.

            $pairwise_id,

The variable $pairwise_id seems to be never defined.

            $affiliation,

The variable $affiliation seems to be never defined.

            $ou,

The variable $ou seems to be never defined.

            $member_of,

The variable $member_of seems to be never defined.

            $acr,

The variable $acr seems to be never defined.

            $amr,

The variable $amr seems to be never defined.

            $entitlement,

The variable $entitlement seems to be never defined.

            $itrustuin

The variable $itrustuin seems to be never defined.

        );
        if ($result) {
            static::setSessionVar('user_uid', $dbs->user_uid);
            static::setSessionVar('distinguished_name', $dbs->distinguished_name);
            static::setSessionVar('status', $dbs->status);
        } else {
            static::sendErrorAlert(
                'dbService Error',
                'Error calling dbservice action "getUser" in ' .
                'saveUserToDatastore() method.'
            );
            static::unsetSessionVar('user_uid');
            static::unsetSessionVar('distinguished_name');
            static::setSessionVar('status', DBService::$STATUS['STATUS_INTERNAL_ERROR']);
        }

        // If 'status' is not STATUS_OK*, then send an error email
        $status = static::getSessionVar('status');
        if ($status & 1) { // Bad status codes are odd
            // For missing parameter errors, log an error message
            if (
                $status ==
                DBService::$STATUS['STATUS_MISSING_PARAMETER_ERROR']
            ) {
                $log = new Loggit();
                $log->error('STATUS_MISSING_PARAMETER_ERROR', true);
            }

            // For other dbservice errors OR for any error involving
            // LIGO (e.g., missing parameter error), send email alert.
            if (
                ($status !=
                    DBService::$STATUS['STATUS_MISSING_PARAMETER_ERROR']) ||
                (preg_match('/ligo\.org/', $idp))
            ) {
                $mailto = EMAIL_ALERTS;

The constant CILogon\Service\EMAIL_ALERTS was not found. Maybe you did not declare it correctly or list all dependencies?

                // CIL-205 - Notify LIGO about IdP login errors.
                // Set DISABLE_LIGO_ALERTS to true in the top-level
                // config.php file to stop LIGO failures
                // from being sent to EMAIL_ALERTS, but still
                // sent to 'cilogon-alerts@ligo.org'.
                if (preg_match('/ligo\.org/', $idp)) {
                    if (DISABLE_LIGO_ALERTS) {

The constant CILogon\Service\DISABLE_LIGO_ALERTS was not found. Maybe you did not declare it correctly or list all dependencies?

                        $mailto = '';
                    }
                    $mailto .= ((strlen($mailto) > 0) ? ',' : '') .
                        'cilogon-alerts@ligo.org';
                }

                static::sendErrorAlert(
                    'Failure in ' .
                        (($loa == 'openid') ? '' : '/secure') . '/getuser/',
                    'Remote_User   = ' . ((strlen($remote_user) > 0) ?
                        $remote_user : '<MISSING>') . "\n" .
                    'IdP ID        = ' . ((strlen($idp) > 0) ?
                        $idp : '<MISSING>') . "\n" .
                    'IdP Name      = ' . ((strlen($idp_display_name) > 0) ?
                        $idp_display_name : '<MISSING>') . "\n" .
                    'First Name    = ' . ((strlen($first_name) > 0) ?
                        $first_name : '<MISSING>') . "\n" .
                    'Last Name     = ' . ((strlen($last_name) > 0) ?
                        $last_name : '<MISSING>') . "\n" .
                    'Display Name  = ' . ((strlen($display_name) > 0) ?
                        $display_name : '<MISSING>') . "\n" .
                    'Email Address = ' . ((strlen($email) > 0) ?
                        $email : '<MISSING>') . "\n" .
                    'LOA           = ' . ((strlen($loa) > 0) ?
                        $loa : '<MISSING>') . "\n" .
                    'ePPN          = ' . ((strlen($eppn) > 0) ?
                        $eppn : '<MISSING>') . "\n" .
                    'ePTID         = ' . ((strlen($eptid) > 0) ?
                        $eptid : '<MISSING>') . "\n" .
                    'OpenID ID     = ' . ((strlen($open_id) > 0) ?
                        $open_id : '<MISSING>') . "\n" .
                    'OIDC ID       = ' . ((strlen($oidc) > 0) ?
                        $oidc : '<MISSING>') . "\n" .
                    'Subject ID    = ' . ((strlen($subject_id) > 0) ?
                        $subject_id : '<MISSING>') . "\n" .
                    'Pairwise ID   = ' . ((strlen($pairwise_id) > 0) ?
                        $pairwise_id : '<MISSING>') . "\n" .
                    'Affiliation   = ' . ((strlen($affiliation) > 0) ?
                        $affiliation : '<MISSING>') . "\n" .
                    'OU            = ' . ((strlen($ou) > 0) ?
                        $ou : '<MISSING>') . "\n" .
                    'MemberOf      = ' . ((strlen($member_of) > 0) ?
                        $member_of : '<MISSING>') . "\n" .
                    'ACR           = ' . ((strlen($acr) > 0) ?
                        $acr : '<MISSING>') . "\n" .
                    'AMR           = ' . ((strlen($amr) > 0) ?
                        $amr : '<MISSING>') . "\n" .
                    'Entitlement   = ' . ((strlen($entitlement) > 0) ?
                        $entitlement : '<MISSING>') . "\n" .
                    'iTrustUIN     = ' . ((strlen($itrustuin) > 0) ?
                        $itrustuin : '<MISSING>') . "\n" .
                    'User UID      = ' . ((strlen(
                        $i = static::getSessionVar('user_uid')
                    ) > 0) ?  $i : '<MISSING>') . "\n" .
                    'Status Code   = ' . ((strlen(
                        $i = array_search(
                            $status,
                            DBService::$STATUS
                        )
                    ) > 0) ?  $i : '<MISSING>'),
                    $mailto
                );
            }
            static::unsetSessionVar('authntime');
        } else {
            // Success! We need to overwrite current session vars with values
            // returned by the DBService, e.g., in case attributes were set
            // previously but not this time. Skip 'idp' since the PHP code
            // transforms 'https://' to 'http://' for database consistency.
            // Also skip 'loa' since that is not saved in the database.
            foreach (DBService::$user_attrs as $value) {
                if (($value != 'idp') && ($value != 'loa')) {
                    static::setSessionVar($value, $dbs->$value);
                }