ConsentController::getconsent() - Code Metrics - Inspection of "Add controller" - simplesamlphp/simplesamlphp-module-consent - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#14)

by Tim
created 2020-08-08 13:13 UTC
ConsentController::getconsent() F

↳ Parent: ConsentController
Complexity

Conditions	31
Paths	> 20000
Size

Total Lines	166
Code Lines	109
Duplication

Lines	0
Ratio	0 %
Importance

Changes	4
Bugs	0	Features	0
Metric	Value
cc	31
eloc	109
c	4
b	0
f	0
nc	101089
nop	2
dl	0
loc	166
rs	0
How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\consent\Controller;

use Exception;
use SimpleSAML\Auth;
use SimpleSAML\Configuration;
use SimpleSAML\Error;
use SimpleSAML\HTTP\RunnableResponse;
use SimpleSAML\IdP;
use SimpleSAML\Locale\Translate;
use SimpleSAML\Logger;
use SimpleSAML\Module;
use SimpleSAML\Session;
use SimpleSAML\Stats;
use SimpleSAML\Utils;
use SimpleSAML\XHTML\Template;
use Symfony\Component\HttpFoundation\Request;

/**
 * Controller class for the consent module.
 *
 * This class serves the consent views available in the module.
 *
 * @package SimpleSAML\Module\consent
 */
class ConsentController
{
    /** @var \SimpleSAML\Configuration */
    protected $config;

    /** @var \SimpleSAML\Session */
    protected $session;


    /**
     * ConsentController constructor.
     *
     * @param \SimpleSAML\Configuration $config The configuration to use.
     * @param \SimpleSAML\Session $session The current user session.
     */
    public function __construct(Configuration $config, Session $session)
    {
        $this->config = $config;
        $this->session = $session;
    }



    /**
     * Display consent form.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request The current request.
     * @param string $id The StateId
     *
     * @return \SimpleSAML\XHTML\Template
     */
    public function getconsent(Request $request, string $id): Template
    public function getconsent(/** @scrutinizer ignore-unused */ Request $request, string $id): Template
    {
        session_cache_limiter('nocache');

        Logger::info('Consent - getconsent: Accessing consent interface');

        $state = Auth\State::loadState($id, 'consent:request');

        if (is_null($state)) {
            throw new Error\NoState();
        } elseif (array_key_exists('core:SP', $state)) {
            $spentityid = $state['core:SP'];
        } elseif (array_key_exists('saml:sp:State', $state)) {
            $spentityid = $state['saml:sp:State']['core:SP'];
        } else {
            $spentityid = 'UNKNOWN';
        }

        // The user has pressed the yes-button
        if (array_key_exists('yes', $_REQUEST)) {
            if (array_key_exists('saveconsent', $_REQUEST)) {
                Logger::stats('consentResponse remember');
            } else {
                Logger::stats('consentResponse rememberNot');
            }

            $statsInfo = [
                'remember' => array_key_exists('saveconsent', $_REQUEST),
            ];
            if (isset($state['Destination']['entityid'])) {
                $statsInfo['spEntityID'] = $state['Destination']['entityid'];
            }
            Stats::log('consent:accept', $statsInfo);

            if (
                array_key_exists('consent:store', $state)
                && array_key_exists('saveconsent', $_REQUEST)
                && $_REQUEST['saveconsent'] === '1'
            ) {
                // Save consent
                $store = $state['consent:store'];
                $userId = $state['consent:store.userId'];
                $targetedId = $state['consent:store.destination'];
                $attributeSet = $state['consent:store.attributeSet'];

                Logger::debug(
                    'Consent - saveConsent() : [' . $userId . '|' . $targetedId . '|' . $attributeSet . ']'
                );
                try {
                    $store->saveConsent($userId, $targetedId, $attributeSet);
                } catch (Exception $e) {
                    Logger::error('Consent: Error writing to storage: ' . $e->getMessage());
                }
            }

            Auth\ProcessingChain::resumeProcessing($state);
        }

        // Prepare attributes for presentation
        $attributes = $state['Attributes'];
        $noconsentattributes = $state['consent:noconsentattributes'];

        // Remove attributes that do not require consent
        foreach ($attributes as $attrkey => $attrval) {
            if (in_array($attrkey, $noconsentattributes, true)) {
                unset($attributes[$attrkey]);
            }
        }
        $para = [
            'attributes' => &$attributes
        ];

        // Reorder attributes according to attributepresentation hooks
        Module::callHooks('attributepresentation', $para);

        // Parse parameters
        if (array_key_exists('name', $state['Source'])) {
            $srcName = $state['Source']['name'];
        } elseif (array_key_exists('OrganizationDisplayName', $state['Source'])) {
            $srcName = $state['Source']['OrganizationDisplayName'];
        } else {
            $srcName = $state['Source']['entityid'];
        }

        if (array_key_exists('name', $state['Destination'])) {
            $dstName = $state['Destination']['name'];
        } elseif (array_key_exists('OrganizationDisplayName', $state['Destination'])) {
            $dstName = $state['Destination']['OrganizationDisplayName'];
        } else {
            $dstName = $state['Destination']['entityid'];
        }

        // Make, populate and layout consent form
        $t = new Template($this->config, 'consent:consentform.twig');
        $translator = $t->getTranslator();
        $t->data['srcMetadata'] = $state['Source'];
        $t->data['dstMetadata'] = $state['Destination'];
        $t->data['yesTarget'] = Module::getModuleURL('consent/getconsent');
        $t->data['yesData'] = ['StateId' => $id];
        $t->data['noTarget'] = Module::getModuleURL('consent/noconsent');
        $t->data['noData'] = ['StateId' => $id];
        $t->data['attributes'] = $attributes;
        $t->data['checked'] = $state['consent:checked'];
        $t->data['stateId'] = $id;

        $t->data['srcName'] = htmlspecialchars(is_array($srcName) ? $translator->getPreferredTranslation($srcName) : $srcName);
        $t->data['dstName'] = htmlspecialchars(is_array($dstName) ? $translator->getPreferredTranslation($dstName) : $dstName);

        if (array_key_exists('descr_purpose', $state['Destination'])) {
            $t->data['dstDesc'] = $translator->getPreferredTranslation(
                Utils\Arrays::arrayize(
                    $state['Destination']['descr_purpose'],
                    'en'
                )
            );
        }

        // Fetch privacypolicy
        if (
            array_key_exists('UIInfo', $state['Destination']) &&
            array_key_exists('PrivacyStatementURL', $state['Destination']['UIInfo']) &&
            (!empty($state['Destination']['UIInfo']['PrivacyStatementURL']))
        ) {
            $privacypolicy = reset($state['Destination']['UIInfo']['PrivacyStatementURL']);
        } elseif (
            array_key_exists('UIInfo', $state['Source']) &&
            array_key_exists('PrivacyStatementURL', $state['Source']['UIInfo']) &&
            (!empty($state['Source']['UIInfo']['PrivacyStatementURL']))
        ) {
            $privacypolicy = reset($state['Source']['UIInfo']['PrivacyStatementURL']);
        } else {
            $privacypolicy = false;
        }
        if ($privacypolicy !== false) {
            $privacypolicy = str_replace(
                '%SPENTITYID%',
                urlencode($spentityid),
                $privacypolicy
            );
        }
        $t->data['sppp'] = $privacypolicy;

        // Set focus element
        switch ($state['consent:focus']) {
            case 'yes':
                $t->data['autofocus'] = 'yesbutton';
                break;
            case 'no':
                $t->data['autofocus'] = 'nobutton';
                break;
            case null:
            default:
                break;
        }

        $t->data['usestorage'] = array_key_exists('consent:store', $state);

        if (array_key_exists('consent:hiddenAttributes', $state)) {
            $t->data['hiddenAttributes'] = $state['consent:hiddenAttributes'];
        } else {
            $t->data['hiddenAttributes'] = [];
        }

        $t->data['attributes_html'] = $this->presentAttributes($t, $attributes, '');

        return $t;
    }


    /**
     * @param \Symfony\Component\HttpFoundation\Request $request The current request.
     * @param string $id The StateId
     *
     * @return \SimpleSAML\XHTML\Template
     */
    public function noconsent(Request $request, string $id): Template
    public function noconsent(/** @scrutinizer ignore-unused */ Request $request, string $id): Template
    {
        /** @psalm-var array $state */
        $state = Auth\State::loadState($id, 'consent:request');

        $resumeFrom = Module::getModuleURL(
            'consent/getconsent',
            ['StateId' => $id]
        );

        $logoutLink = Module::getModuleURL(
            'consent/logout',
            ['StateId' => $id]
        );

        $aboutService = null;
        if (!isset($state['consent:showNoConsentAboutService']) || $state['consent:showNoConsentAboutService']) {
            if (isset($state['Destination']['url.about'])) {
                $aboutService = $state['Destination']['url.about'];
            }
        }

        $statsInfo = [];
        if (isset($state['Destination']['entityid'])) {
            $statsInfo['spEntityID'] = $state['Destination']['entityid'];
        }
        Stats::log('consent:reject', $statsInfo);

        if (array_key_exists('name', $state['Destination'])) {
            $dstName = $state['Destination']['name'];
        } elseif (array_key_exists('OrganizationDisplayName', $state['Destination'])) {
            $dstName = $state['Destination']['OrganizationDisplayName'];
        } else {
            $dstName = $state['Destination']['entityid'];
        }

        $t = new Template($this->config, 'consent:noconsent.twig');
        $translator = $t->getTranslator();
        $t->data['dstMetadata'] = $state['Destination'];
        $t->data['resumeFrom'] = $resumeFrom;
        $t->data['aboutService'] = $aboutService;
        $t->data['logoutLink'] = $logoutLink;
        $t->data['dstName'] = htmlspecialchars(is_array($dstName) ? $translator->getPreferredTranslation($dstName) : $dstName);
        return $t;
    }


    /**
     * @param \Symfony\Component\HttpFoundation\Request $request The current request.
     * @param string $id The StateId
     *
     * @return \SimpleSAML\HTTP\RunnableResponse
     */
    public function logout(Request $request, string $id): RunnableResponse
    {
        $state = Auth\State::loadState($id, 'consent:request');

        $state['Responder'] = ['\SimpleSAML\Module\consent\Logout', 'postLogout'];

        $idp = IdP::getByState($state);
        $idp = IdP::getByState(/** @scrutinizer ignore-type */ $state);
        return new RunnableResponse([$idp, 'handleLogoutRequest'], [$state, null]);
    }


    /**
     * @param \Symfony\Component\HttpFoundation\Request $request The current request.
     *
     * @return \SimpleSAML\XHTML\Template
     */
    public function logoutcompleted(Request $request): Template
    public function logoutcompleted(/** @scrutinizer ignore-unused */ Request $request): Template
    {
        return new Template($this->config, 'consent:logout_completed.twig');
    }


    /**
     * Recursive attribute array listing function
     *
     * @param \SimpleSAML\XHTML\Template $t          Template object
     * @param array                     $attributes Attributes to be presented
     * @param string                    $nameParent Name of parent element
     *
     * @return string HTML representation of the attributes
     */
    private function presentAttributes(Template $t, array $attributes, string $nameParent): string
    {
        $translator = $t->getTranslator();

        $alternate = ['odd', 'even'];
        $i = 0;
        $summary = 'summary="' . $translator->t('List the information about you that is about to be transmitted to the service you are going to login to') . '"';
        $summary = 'summary="' . $translator->/** @scrutinizer ignore-call */ t('List the information about you that is about to be transmitted to the service you are going to login to') . '"';

        if (strlen($nameParent) > 0) {
            $parentStr = strtolower($nameParent) . '_';
            $str = '<table class="attributes" ' . $summary . '>';
        } else {
            $parentStr = '';
            $str = '<table id="table_with_attributes" class="attributes" ' . $summary . '>';
            $str .= "\n" . '<caption>' . $translator->t('User information') . '</caption>';
        }

        foreach ($attributes as $name => $value) {
            $nameraw = $name;
            $name = $translator->getAttributeTranslation($parentStr . $nameraw);

            if (preg_match('/^child_/', $nameraw)) {
                // insert child table
                $parentName = preg_replace('/^child_/', '', $nameraw);
                foreach ($value as $child) {
                    $str .= "\n" . '<tr class="odd"><td class="td_odd">' .
                        $this->presentAttributes($t, $child, $parentName) . '</td></tr>';
                }
            } else {
                // insert values directly

                $str .= "\n" . '<tr class="' . $alternate[($i++ % 2)] .
                    '"><td><span class="attrname">' . htmlspecialchars($name) . '</span></td>';

                $isHidden = in_array($nameraw, $t->data['hiddenAttributes'], true);
                if ($isHidden) {
                    $hiddenId = Utils\Random::generateID();
                    $str .= '<td><span class="attrvalue hidden" id="hidden_' . $hiddenId . '">';
                } else {
                    $hiddenId = '';
                    $str .= '<td><span class="attrvalue">';
                }

                if (sizeof($value) > 1) {
                    // we hawe several values
                    $str .= '<ul>';
                    foreach ($value as $listitem) {
                        if ($nameraw === 'jpegPhoto') {
                            $str .= '<li><img src="data:image/jpeg;base64,' .
                                htmlspecialchars($listitem) . '" alt="User photo" /></li>';
                        } else {
                            $str .= '<li>' . htmlspecialchars($listitem) . '</li>';
                        }
                    }
                    $str .= '</ul>';
                } elseif (isset($value[0])) {
                    // we hawe only one value
                    if ($nameraw === 'jpegPhoto') {
                        $str .= '<img src="data:image/jpeg;base64,' .
                            htmlspecialchars($value[0]) . '" alt="User photo" />';
                    } else {
                        $str .= htmlspecialchars($value[0]);
                    }
                } // end of if multivalue
                $str .= '</span>';

                if ($isHidden) {
                    $str .= '<div class="attrvalue consent_showattribute" id="visible_' . $hiddenId . '">';
                    $str .= '... ';
                    $str .= '<a class="consent_showattributelink" href="javascript:SimpleSAML_show(\'hidden_' . $hiddenId;
                    $str .= '\'); SimpleSAML_hide(\'visible_' . $hiddenId . '\');">';
                    $str .= $translator->t('Show attributes');
                    $str .= '</a>';
                    $str .= '</div>';
                }

                $str .= '</td></tr>';
            }       // end else: not child table
        }   // end foreach
        $str .= '</table>';
        return $str;
    }
}

simplesamlphp / simplesamlphp-module-consent

Pull Request — master (#14)

ConsentController::getconsent() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
