Aoe\Restler\Controller\FeUserAuthenticationController

Complexity

Total Complexity

8

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Test Coverage

Coverage

95%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	__isAllowed()	0	10	2
A	determinePageIdFromArguments()	0	8	2
A	__getWWWAuthenticateString()	0	3	1
A	determinePageId()	0	7	2

<?php

namespace Aoe\Restler\Controller;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2021 AOE GmbH <dev@aoe.com>
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use Aoe\Restler\System\TYPO3\Loader;
use Luracast\Restler\iAuthenticate;
use Luracast\Restler\Restler;
use Luracast\Restler\Scope;

/**
 * This class checks, if client is allowed to access the requested and protected API-class
 * This class checks, if FE-user is logged in
 */
class FeUserAuthenticationController implements iAuthenticate
{
    /**
     * This property defines (when it's set), the argument-name, which contains the pageId,
     * which should be used to initialize TYPO3
     * This property will be automatically set by restler, when in
     * the API-class/controller this is configured (in PHPdoc/annotations)
     *
     * Where do we set this property?
     * When the property should be used, than it must be set inside the PHPdoc-comment of
     * the API-class-method, which handle the API-request
     *
     * Syntax:
     * The PHPdoc-comment must look like this:
     * @class [className] {@[propertyName] [propertyValue]}
     *
     * Example:
     * When this controller should use a specific pageId while initializing TYPO3 (this is needed, when we want to
     * render TYPO3-contentElements, after the user is authenticated), than the PHPdoc-comment must look like this:
     * @class Aoe\Restler\Controller\FeUserAuthenticationController {@argumentNameOfPageId pageId}
     *
     * @see \Aoe\RestlerExamples\Controller\ContentController::getContentElementByUidForLoggedInFeUser
     */
    public string $argumentNameOfPageId = '';
    /**
     * This property defines (when it's set), that this controller should check authentication
     * This property will be automatically set by restler, when in the API-class/controller this
     * is configured (in PHPdoc/annotations)
     *
     * Where do we set this property?
     * When the property should be used, than it must be set inside the PHPdoc-comment of the API-class-method,
     * which handle the API-request
     *
     * Syntax:
     * The PHPdoc-comment must look like this:
     * @class [className] {@[propertyName] [propertyValue]}
     *
     * Example:
     * When this controller should be used for authentication-checks, than the PHPdoc-comment must look like this:
     * @class Aoe\Restler\Controller\FeUserAuthenticationController {@checkAuthentication true}
     *
     * @see \Aoe\RestlerExamples\Controller\FeUserController::getDataOfLoggedInFeUser
     * @see \Aoe\RestlerExamples\Controller\ContentController::getContentElementByUidForLoggedInFeUser
     */
    public bool $checkAuthentication = false;

    /**
     * Instance of Restler class injected at runtime.
     *
     * @var Restler
     */
    public $restler;

    private Loader $typo3Loader;

    public function __construct(Loader $typo3Loader)
    {
        $this->typo3Loader = $typo3Loader;
        $this->restler = Scope::get('Restler');
    }

    /**
     * This method checks, if client is allowed to access the requested API-class
     */
    // phpcs:ignore
    public function __isAllowed(): bool
    {
        if (!$this->checkAuthentication) {
            // this controller is not responsible for the authentication
            return false;
        }

        $this->typo3Loader->initializeFrontendUser($this->determinePageId());

        return $this->typo3Loader->hasActiveFrontendUser();
    }

    /**
     * return dummy string, because we DON'T need that for our case (we use NO base-authentification via REST-API)
     *
     * @see \Luracast\Restler\iAuthenticate
     */
    // phpcs:ignore
    public function __getWWWAuthenticateString(): string
    {
        return '';
    }

    /**
     * List of page IDs (comma separated) or page ID where to look for frontend user records
     */
    private function determinePageId(): string
    {
        if (!empty($this->argumentNameOfPageId)) {
            return $this->argumentNameOfPageId;
        }

        return $this->determinePageIdFromArguments();
    }

    /**
     * determine pageId from arguments, which restler has detected
     * We need the pageId, when we want to render TYPO3-contentElements, after the user is authenticated
     */
    private function determinePageIdFromArguments(): string
    {
        if (!array_key_exists($this->argumentNameOfPageId, $this->restler->apiMethodInfo->arguments)) {
            return '0';
        }

        $index = $this->restler->apiMethodInfo->arguments[$this->argumentNameOfPageId];
        return $this->restler->apiMethodInfo->parameters[$index];
    }
}