AbstractAuthenticationService.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Authentication;
 
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Database\Query\QueryHelper;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪AbstractAuthenticationService implements LoggerAwareInterface
{
    use LoggerAwareTrait;
 
    public ‪$pObj;
 
    public ‪$mode;
 
    public ‪$login = [];
 
    public ‪$authInfo = [];
 
    public ‪$db_user = [];
 
    public ‪$db_groups = [];
 
    public ‪$writeAttemptLog = false;
 
    public ‪$info = [];
 
    public function ‪initAuth(‪$mode, $loginData, ‪$authInfo, ‪$pObj)
    {
        $this->pObj = ‪$pObj;
        // Sub type
        $this->mode = ‪$mode;
        $this->login = $loginData;
        $this->authInfo = ‪$authInfo;
        $this->db_user = $this->‪getServiceOption('db_user', ‪$authInfo['db_user'] ?? [], false);
        $this->db_groups = $this->‪getServiceOption('db_groups', ‪$authInfo['db_groups'] ?? [], false);
        $this->writeAttemptLog = $this->pObj->writeAttemptLog ?? true;
    }
 
    public function ‪writelog($type, $action, $error, $details_nr, $details, $data, $tablename = '', $recuid = '', $recpid = '')
    {
        if ($this->writeAttemptLog) {
            $this->pObj->writelog($type, $action, $error, $details_nr, $details, $data, $tablename, $recuid, $recpid);
        }
    }
 
    public function ‪fetchUserRecord($username, $extraWhere = '', $dbUserSetup = '')
    {
        $dbUser = is_array($dbUserSetup) ? $dbUserSetup : ‪$this->db_user;
        $user = false;
        if ($username || $extraWhere) {
            $query = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($dbUser['table']);
            $query->getRestrictions()->removeAll()
                ->add(GeneralUtility::makeInstance(DeletedRestriction::class));
            $constraints = array_filter([
                ‪QueryHelper::stripLogicalOperatorPrefix($dbUser['check_pid_clause']),
                ‪QueryHelper::stripLogicalOperatorPrefix($dbUser['enable_clause']),
                ‪QueryHelper::stripLogicalOperatorPrefix($extraWhere),
            ]);
            if (!empty($username)) {
                array_unshift(
                    $constraints,
                    $query->expr()->eq(
                        $dbUser['username_column'],
                        $query->createNamedParameter($username, \PDO::PARAM_STR)
                    )
                );
            }
            $user = $query->select('*')
                ->from($dbUser['table'])
                ->where(...$constraints)
                ->execute()
                ->fetch();
        }
        return $user;
    }
 
    public function ‪init(): bool
    {
        return true;
    }
 
    public function ‪reset()
    {
        // nothing to do
    }
 
    public function ‪getServiceKey()
    {
        return $this->info['serviceKey'];
    }
 
    public function ‪getServiceTitle()
    {
        return $this->info['title'];
    }
 
    public function ‪getServiceOption($optionName, $defaultValue = '', $includeDefaultConfig = true)
    {
        $config = null;
        $serviceType = $this->info['serviceType'] ?? '';
        $serviceKey = $this->info['serviceKey'] ?? '';
        $svOptions = ‪$GLOBALS['TYPO3_CONF_VARS']['SVCONF'][$serviceType] ?? [];
        if (isset($svOptions[$serviceKey][$optionName])) {
            $config = $svOptions[$serviceKey][$optionName];
        } elseif ($includeDefaultConfig && isset($svOptions['default'][$optionName])) {
            $config = $svOptions['default'][$optionName];
        }
        if (!isset($config)) {
            $config = $defaultValue;
        }
        return $config;
    }
 
    public function ‪getLastErrorArray(): array
    {
        return [];
    }
}