RedirectRepository.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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\Redirects\Repository;
 
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪RedirectRepository
{
    public function ‪findRedirectsByDemand(‪Demand $demand): array
    {
        return $this->‪getQueryBuilderForDemand($demand)
            ->setMaxResults($demand->‪getLimit())
            ->setFirstResult($demand->‪getOffset())
            ->executeQuery()
            ->fetchAllAssociative();
    }
 
    public function ‪countRedirectsByByDemand(‪Demand $demand): int
    {
        return (int)$this->‪getQueryBuilderForDemand($demand, true)
            ->executeQuery()
            ->fetchOne();
    }
 
    public function ‪countActiveRedirects(): int
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('sys_redirect');
        return (int)$queryBuilder
            ->count('uid')
            ->from('sys_redirect')
            ->executeQuery()
            ->fetchOne();
    }
 
    protected function ‪getQueryBuilderForDemand(‪Demand $demand, bool $createCountQuery = false): QueryBuilder
    {
        $queryBuilder = $this->‪getQueryBuilder();
 
        if ($createCountQuery) {
            $queryBuilder->count('*');
        } else {
            $queryBuilder->select('*');
        }
 
        $queryBuilder->from('sys_redirect');
 
        if (!$createCountQuery) {
            $queryBuilder->orderBy(
                $demand->‪getOrderField(),
                $demand->‪getOrderDirection()
            );
            if ($demand->‪hasSecondaryOrdering()) {
                $queryBuilder->addOrderBy($demand->‪getSecondaryOrderField());
            }
        }
 
        $constraints = [];
        if ($demand->‪hasSourceHosts()) {
            $constraints[] = $queryBuilder->expr()->in(
                'source_host',
                $queryBuilder->createNamedParameter($demand->‪getSourceHosts(), ‪Connection::PARAM_STR_ARRAY)
            );
        }
 
        if ($demand->‪hasSourcePath()) {
            $escapedLikeString = '%' . $queryBuilder->escapeLikeWildcards($demand->‪getSourcePath()) . '%';
            $constraints[] = $queryBuilder->expr()->like(
                'source_path',
                $queryBuilder->createNamedParameter($escapedLikeString)
            );
        }
 
        if ($demand->‪hasTarget()) {
            $escapedLikeString = '%' . $queryBuilder->escapeLikeWildcards($demand->‪getTarget()) . '%';
            $constraints[] = $queryBuilder->expr()->like(
                'target',
                $queryBuilder->createNamedParameter($escapedLikeString)
            );
        }
 
        if ($demand->‪hasStatusCodes()) {
            $constraints[] = $queryBuilder->expr()->in(
                'target_statuscode',
                $queryBuilder->createNamedParameter($demand->‪getStatusCodes(), ‪Connection::PARAM_INT_ARRAY)
            );
        }
 
        if ($demand->‪hasMaxHits()) {
            $constraints[] = $queryBuilder->expr()->lt(
                'hitcount',
                $queryBuilder->createNamedParameter($demand->‪getMaxHits(), ‪Connection::PARAM_INT)
            );
            // When max hits is set, exclude records which explicitly disabled the hitcount feature
            $constraints[] = $queryBuilder->expr()->eq(
                'disable_hitcount',
                $queryBuilder->createNamedParameter(0, ‪Connection::PARAM_INT)
            );
        }
 
        if ($demand->‪hasCreationType()) {
            $constraints[] = $queryBuilder->expr()->eq(
                'creation_type',
                $queryBuilder->createNamedParameter($demand->‪getCreationType(), ‪Connection::PARAM_INT)
            );
        }
 
        if ($demand->‪hasProtected()) {
            $constraints[] = $queryBuilder->expr()->eq(
                'protected',
                $queryBuilder->createNamedParameter($demand->‪getProtected(), ‪Connection::PARAM_INT)
            );
        }
 
        if ($demand->‪hasIntegrityStatus()) {
            $constraints[] = $queryBuilder->expr()->eq(
                'integrity_status',
                $queryBuilder->createNamedParameter($demand->‪getIntegrityStatus())
            );
        }
 
        if (!empty($constraints)) {
            $queryBuilder->where(...$constraints);
        }
        return $queryBuilder;
    }
 
    public function ‪findHostsOfRedirects(): array
    {
        return $this->‪getGroupedRows('source_host', 'name');
    }
 
    public function ‪findStatusCodesOfRedirects(): array
    {
        return $this->‪getGroupedRows('target_statuscode', 'code');
    }
 
    public function ‪findCreationTypes(): array
    {
        $types = [];
        $availableTypes = ‪$GLOBALS['TCA']['sys_redirect']['columns']['creation_type']['config']['items'];
        foreach ($this->‪getGroupedRows('creation_type', 'type') as $row) {
            foreach ($availableTypes as $availableType) {
                if ($availableType['value'] === $row['type']) {
                    $types[$row['type']] = $availableType['label'];
                }
            }
        }
 
        return $types;
    }
 
    public function ‪findIntegrityStatusCodes(): array
    {
        $statusCodes = [];
        $availableStatusCodes = ‪$GLOBALS['TCA']['sys_redirect']['columns']['integrity_status']['config']['items'];
        foreach ($this->‪getGroupedRows('integrity_status', 'status_code') as $row) {
            foreach ($availableStatusCodes as $availableStatusCode) {
                if ($availableStatusCode['value'] === $row['status_code']) {
                    $statusCodes[$row['status_code']] = $availableStatusCode['label'];
                }
            }
        }
 
        return $statusCodes;
    }
 
    protected function ‪getGroupedRows(string $field, string $as): array
    {
        return $this->‪getQueryBuilder()
            ->select(sprintf('%s as %s', $field, $as))
            ->from('sys_redirect')
            ->orderBy($field)
            ->groupBy($field)
            ->executeQuery()
            ->fetchAllAssociative();
    }
 
    protected function ‪getQueryBuilder(): QueryBuilder
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('sys_redirect');
        $queryBuilder->getRestrictions()
            ->removeAll()
            ->add(GeneralUtility::makeInstance(DeletedRestriction::class));
        return $queryBuilder;
    }
 
    public function ‪removeByDemand(‪Demand $demand): void
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable('sys_redirect');
        $queryBuilder
            ->delete('sys_redirect')
            ->where(
                $queryBuilder->expr()->eq('protected', $queryBuilder->createNamedParameter(0, ‪Connection::PARAM_INT))
            );
 
        if ($demand->‪hasMaxHits()) {
            $queryBuilder->andWhere(
                $queryBuilder->expr()->lt('hitcount', $queryBuilder->createNamedParameter($demand->‪getMaxHits(), ‪Connection::PARAM_INT))
            );
        }
        if ($demand->‪hasSourceHosts()) {
            $queryBuilder
                ->andWhere('source_host IN (:domains)')
                ->setParameter('domains', $demand->‪getSourceHosts(), ‪Connection::PARAM_STR_ARRAY);
        }
        if ($demand->‪hasStatusCodes()) {
            $queryBuilder
                ->andWhere('target_statuscode IN (:statusCodes)')
                ->setParameter('statusCodes', $demand->‪getStatusCodes(), ‪Connection::PARAM_INT_ARRAY);
        }
        if ($demand->‪hasOlderThan()) {
            $timeStamp = $demand->‪getOlderThan()->getTimestamp();
            $queryBuilder->andWhere(
                $queryBuilder->expr()->lt('createdon', $queryBuilder->createNamedParameter($timeStamp, ‪Connection::PARAM_INT))
            );
        }
        if ($demand->‪hasSourcePath()) {
            $queryBuilder
                ->andWhere($queryBuilder->expr()->like('source_path', ':path'))
                ->setParameter('path', $demand->‪getSourcePath());
        }
 
        if ($demand->‪hasCreationType()) {
            $queryBuilder->andWhere(
                $queryBuilder->expr()->eq('creation_type', $queryBuilder->createNamedParameter($demand->‪getCreationType(), ‪Connection::PARAM_INT))
            );
        }
 
        $queryBuilder->executeStatement();
    }
}