SimpleSAML\Module\expirycheck\Controller\ExpiryCheck

Complexity

Total Complexity

7

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	setAuthState()	0	3	1
A	about2expire()	0	25	3
A	expired()	0	16	2

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\expirycheck\Controller;

use SimpleSAML\Auth;
use SimpleSAML\Configuration;
use SimpleSAML\Error;
use SimpleSAML\HTTP\RunnableResponse;
use SimpleSAML\Logger;
use SimpleSAML\Module;
use SimpleSAML\Session;
use SimpleSAML\XHTML\Template;
use Symfony\Component\HttpFoundation\Request;

use function htmlspecialchars;

/**
 * Controller class for the expirycheck module.
 *
 * This class serves the different views available in the module.
 *
 * @package simplesamlphp/simplesamlphp
 */
class ExpiryCheck
{
    /** @var \SimpleSAML\Configuration */
    protected Configuration $config;

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

    /**
     * @var \SimpleSAML\Auth\State|string
     * @psalm-var \SimpleSAML\Auth\State|class-string
     */
    protected $authState = Auth\State::class;


    /**
     * Controller constructor.
     *
     * It initializes the global configuration and session for the controllers implemented here.
     *
     * @param \SimpleSAML\Configuration $config The configuration to use by the controllers.
     * @param \SimpleSAML\Session $session The session to use by the controllers.
     *
     * @throws \Exception
     */
    public function __construct(
        Configuration $config,
        Session $session,
    ) {
        $this->config = $config;
        $this->session = $session;
    }


    /**
     * Inject the \SimpleSAML\Auth\State dependency.
     *
     * @param \SimpleSAML\Auth\State $authState
     */
    public function setAuthState(Auth\State $authState): void
    {
        $this->authState = $authState;
    }


    /**
     * About to expire.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request The current request.
     *
     * @return \SimpleSAML\XHTML\Template|\SimpleSAML\HTTP\RunnableResponse
     */
    public function about2expire(Request $request): Template|RunnableResponse
    {
        Logger::info('expirycheck - User has been warned that NetID is near to expirational date.');

        $stateId = $request->query->get('StateId');
        if ($stateId === null) {
            throw new Error\BadRequest('Missing required StateId query parameter.');
        }

        $state = $this->authState::loadState($stateId, 'expirywarning:about2expire');

        if ($request->query->get('yes') !== null) {
            // The user has pressed the yes-button
            return new RunnableResponse([Auth\ProcessingChain::class, 'resumeProcessing'], [$state]);
        }

        $t = new Template($this->config, 'expirycheck:about2expire.twig');
        $t->data['autofocus'] = 'yesbutton';
        $t->data['yesTarget'] = Module::getModuleURL('expirycheck/about2expire');
        $t->data['yesData'] = ['StateId' => $stateId];
        $t->data['daysleft'] = $state['daysleft'];
        $t->data['expireOnDate'] = $state['expireOnDate'];
        $t->data['netId'] = htmlspecialchars($state['netId']);

        return $t;
    }


    /**
     * Expired.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request The current request.
     *
     * @return \SimpleSAML\XHTML\Template
     */
    public function expired(Request $request): Template
    {
        Logger::info('expirycheck - User has been warned that NetID is near to expirational date.');

        $stateId = $request->query->get('StateId');
        if ($stateId === null) {
            throw new Error\BadRequest('Missing required StateId query parameter.');
        }

        $state = $this->authState::loadState($stateId, 'expirywarning:expired');

        $t = new Template($this->config, 'expirycheck:expired.twig');
        $t->data['expireOnDate'] = $state['expireOnDate'];
        $t->data['netId'] = $state['netId'];

        return $t;
    }
}