LinkValidatorController.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\Linkvalidator\Controller;
 
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Backend\Attribute\AsController;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplate;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplateFactory;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\Imaging\IconSize;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Messaging\FlashMessage;
use ‪TYPO3\CMS\Core\Messaging\FlashMessageService;
use ‪TYPO3\CMS\Core\Type\Bitmask\Permission;
use ‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Linkvalidator\LinkAnalyzer;
use ‪TYPO3\CMS\Linkvalidator\Linktype\LinktypeRegistry;
use ‪TYPO3\CMS\Linkvalidator\Repository\BrokenLinkRepository;
use ‪TYPO3\CMS\Linkvalidator\Repository\PagesRepository;
 
#[AsController]
class ‪LinkValidatorController
{
    protected array ‪$pageRecord = [];
 
    protected array ‪$modTS = [];
 
    protected array ‪$searchLevel = ['report' => 0, 'check' => 0];
 
    protected array ‪$checkOpt = ['report' => [], 'check' => []];
 
    protected array ‪$lastEditedRecord = [
        'uid'   => 0,
        'table' => '',
        'field' => '',
        'timestamp' => 0,
    ];
 
    protected int ‪$id;
    protected array ‪$searchFields = [];
 
    protected ServerRequestInterface ‪$request;
 
    public function ‪__construct(
        protected readonly ‪Context $context,
        protected readonly ‪UriBuilder $uriBuilder,
        protected readonly ‪IconFactory $iconFactory,
        protected readonly ‪PagesRepository $pagesRepository,
        protected readonly ‪BrokenLinkRepository $brokenLinkRepository,
        protected readonly ‪ModuleTemplateFactory $moduleTemplateFactory,
        protected readonly ‪LinkAnalyzer $linkAnalyzer,
        protected readonly ‪LinktypeRegistry $linktypeRegistry,
    ) {}
 
    public function ‪__invoke(ServerRequestInterface ‪$request): ResponseInterface
    {
        $backendUser = $this->‪getBackendUser();
        $languageService = $this->‪getLanguageService();
 
        $this->request = ‪$request;
        $this->id = (int)($this->request->getQueryParams()['id'] ?? 0);
        $this->modTS = BackendUtility::getPagesTSconfig($this->id)['mod.']['linkvalidator.'] ?? [];
        $this->pageRecord = BackendUtility::readPageAccess($this->id, $this->‪getBackendUser()->getPagePermsClause(‪Permission::PAGE_SHOW)) ?: [];
 
        $view = $this->moduleTemplateFactory->create($this->request);
        if ($this->pageRecord !== []) {
            $view->getDocHeaderComponent()->setMetaInformation($this->pageRecord);
        }
 
        $this->‪validateSettings($request);
        $this->‪initializeLinkAnalyzer();
 
        if ($this->request->getParsedBody()['updateLinkList'] ?? false) {
            $this->‪updateBrokenLinks();
        } elseif ($this->lastEditedRecord['uid']) {
            if (($this->modTS['actionAfterEditRecord'] ?? '') === 'recheck') {
                // recheck broken links for last edited record
                $this->linkAnalyzer->recheckLinks(
                    $this->checkOpt['check'],
                    $this->lastEditedRecord['uid'],
                    $this->lastEditedRecord['table'],
                    $this->lastEditedRecord['field'],
                    (int)$this->lastEditedRecord['timestamp']
                );
            } else {
                // mark broken links for last edited record as needing a recheck
                $this->brokenLinkRepository->setNeedsRecheckForRecord(
                    (int)$this->lastEditedRecord['uid'],
                    $this->lastEditedRecord['table']
                );
            }
        }
 
        $view->setTitle($this->‪getModuleTitle());
 
        if ($backendUser->workspace !== 0 || !(($this->id && $this->pageRecord !== []) || (!$this->id && $backendUser->isAdmin()))) {
            $view->addFlashMessage($languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:no.access'), $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:no.access.title'), ContextualFeedbackSeverity::ERROR);
            return $view->renderResponse('Backend/Empty');
        }
 
        $moduleData = ‪$request->getAttribute('moduleData');
        if (!($this->modTS['showCheckLinkTab'] ?? false)) {
            $moduleData->set('action', 'report');
            $backendUser->pushModuleData($moduleData->getModuleIdentifier(), $moduleData->toArray());
        } elseif ($moduleData->clean('action', ['report', 'check'])) {
            $backendUser->pushModuleData($moduleData->getModuleIdentifier(), $moduleData->toArray());
        }
        $action = $moduleData->get('action');
 
        $this->‪addDocHeaderShortCutButton($view, $action);
        if ($this->modTS['showCheckLinkTab'] ?? false) {
            // Add doc header drop down if user is allowed to see both 'report' and 'check'
            $this->‪addDocHeaderDropDown($view, $action);
        }
 
        if ($action === 'report') {
            $view->assignMultiple([
                'title' => $this->pageRecord ? BackendUtility::getRecordTitle('pages', $this->pageRecord) : '',
                'prefix' => 'report',
                'selectedLevel' => $this->searchLevel['report'],
                'options' => $this->‪getCheckOptions('report'),
                'brokenLinks' => $this->‪getBrokenLinks(),
                'tableheadPath' =>        $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:list.tableHead.path'),
                'tableheadElement' =>     $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:list.tableHead.element'),
                'tableheadHeadlink' =>    $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:list.tableHead.headlink'),
                'tableheadLinktarget' =>  $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:list.tableHead.linktarget'),
                'tableheadLinkmessage' => $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:list.tableHead.linkmessage'),
                'tableheadLastcheck' =>   $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:list.tableHead.lastCheck'),
            ]);
            return $view->renderResponse('Backend/Report');
        }
        $view->assignMultiple([
            'title' => $this->pageRecord ? BackendUtility::getRecordTitle('pages', $this->pageRecord) : '',
            'prefix' => 'check',
            'selectedLevel' => $this->searchLevel['check'],
            'options' => $this->‪getCheckOptions('check'),
        ]);
        return $view->renderResponse('Backend/CheckLinks');
    }
 
    protected function ‪validateSettings(ServerRequestInterface ‪$request): void
    {
        $backendUser = $this->‪getBackendUser();
 
        $prefix = 'check';
        $other = 'report';
        if (empty($this->request->getParsedBody()['updateLinkList'] ?? false)) {
            $prefix = 'report';
            $other = 'check';
        }
 
        // get linkvalidator module data
        $moduleData = ‪$request->getAttribute('moduleData');
 
        // get information for last edited record
        $this->lastEditedRecord['uid'] = $this->request->getQueryParams()['last_edited_record_uid'] ?? 0;
        $this->lastEditedRecord['table'] = $this->request->getQueryParams()['last_edited_record_table'] ?? '';
        $this->lastEditedRecord['field'] = $this->request->getQueryParams()['last_edited_record_field'] ?? '';
        $this->lastEditedRecord['timestamp'] = $this->request->getQueryParams()['last_edited_record_timestamp'] ?? 0;
 
        // get searchLevel (number of levels of pages to check / show results)
        $this->searchLevel[$prefix] = $this->request->getQueryParams()[$prefix . '_search_levels'] ?? $this->request->getParsedBody()[$prefix . '_search_levels'] ?? null;
 
        $mainSearchLevelKey = $prefix . '_searchlevel';
        $otherSearchLevelKey = $other . '_searchlevel';
        if ($this->searchLevel[$prefix] !== null) {
            $moduleData->set($mainSearchLevelKey, $this->searchLevel[$prefix]);
        } else {
            $this->searchLevel[$prefix] = $moduleData->get($mainSearchLevelKey, 0);
        }
        if ($moduleData->has($otherSearchLevelKey)) {
            $this->searchLevel[$other] = $moduleData->get($otherSearchLevelKey);
        }
 
        // which linkTypes to check (internal, file, external, ...)
        $set = $this->request->getParsedBody()[$prefix . '_SET'] ?? [];
        $submittedValues = $this->request->getParsedBody()[$prefix . '_values'] ?? [];
 
        foreach ($this->linktypeRegistry->getIdentifiers() as $linkType) {
            // Compile list of all available types. Used for checking with button "Check Links".
            unset($this->checkOpt[$prefix][$linkType]);
            $mainLinkType = $prefix . '_' . $linkType;
            $otherLinkType = $other . '_' . $linkType;
 
            // 1) if "$prefix_values" = "1" : use POST variables
            // 2) if not set, use stored module configuration
            // 3) if not set, use default
            if (!empty($submittedValues)) {
                $this->checkOpt[$prefix][$linkType] = $set[$linkType] ?? '0';
                $moduleData->set($mainLinkType, $this->checkOpt[$prefix][$linkType]);
            } elseif ($moduleData->has($mainLinkType)) {
                $this->checkOpt[$prefix][$linkType] = $moduleData->get($mainLinkType);
            } else {
                // use default
                $this->checkOpt[$prefix][$linkType] = '0';
                $moduleData->set($mainLinkType, $this->checkOpt[$prefix][$linkType]);
            }
 
            if ($moduleData->has($otherLinkType)) {
                $this->checkOpt[$other][$linkType] = $moduleData->get($otherLinkType);
            }
        }
 
        // save settings
        $backendUser->pushModuleData($moduleData->getModuleIdentifier(), $moduleData->toArray());
    }
 
    protected function ‪initializeLinkAnalyzer(): void
    {
        // Get the searchFields from TSconfig
        foreach ($this->modTS['searchFields.'] ?? [] as $table => $fieldList) {
            ‪$fields = ‪GeneralUtility::trimExplode(',', $fieldList, true);
            foreach (‪$fields as $field) {
                if (!$this->searchFields
                    || !is_array($this->searchFields[$table] ?? null)
                    || !in_array($field, $this->searchFields[$table], true)
                ) {
                    $this->searchFields[$table][] = $field;
                }
            }
        }
        $rootLineHidden = $this->pagesRepository->doesRootLineContainHiddenPages($this->pageRecord);
        if (!$rootLineHidden || ($this->modTS['checkhidden'] ?? false)) {
            $this->linkAnalyzer->init($this->searchFields, $this->‪getPageList(), $this->modTS);
        }
    }
 
    protected function ‪updateBrokenLinks(): void
    {
        // convert ['external' => 1, 'db' => 0, ...] into ['external']
        $linkTypes = [];
        foreach ($this->checkOpt['check'] ?? [] as $linkType => $value) {
            if ($value) {
                $linkTypes[] = $linkType;
            }
        }
        $this->linkAnalyzer->getLinkStatistics($linkTypes, (bool)($this->modTS['checkhidden'] ?? false));
    }
 
    protected function ‪getBrokenLinks(): array
    {
        $items = [];
        $linkTypes = [];
        if (is_array($this->checkOpt['report'])) {
            $linkTypes = array_keys($this->checkOpt['report'], '1');
        }
        $rootLineHidden = $this->pagesRepository->doesRootLineContainHiddenPages($this->pageRecord);
        if (!empty($linkTypes) && (!$rootLineHidden || ($this->modTS['checkhidden'] ?? false))) {
            $brokenLinks = $this->brokenLinkRepository->getAllBrokenLinksForPages(
                $this->‪getPageList(),
                $linkTypes,
                $this->searchFields
            );
            foreach ($brokenLinks as $row) {
                $items[] = $this->‪generateTableRow($row);
            }
        }
        if (empty($items)) {
            $this->‪createFlashMessagesForNoBrokenLinks();
        }
        return $items;
    }
 
    protected function ‪getPageList(): array
    {
        $backendUser = $this->‪getBackendUser();
        $checkForHiddenPages = (bool)($this->modTS['checkhidden'] ?? false);
        $permsClause = $backendUser->getPagePermsClause(‪Permission::PAGE_SHOW);
        $pageList = $this->pagesRepository->getAllSubpagesForPage(
            $this->id,
            (int)$this->searchLevel['report'],
            $permsClause,
            $checkForHiddenPages
        );
        // Always add the current page, because we are just displaying the results
        $pageList[] = ‪$this->id;
        $pageTranslations = $this->pagesRepository->getTranslationForPage(
            $this->id,
            $permsClause,
            $checkForHiddenPages
        );
        return array_merge($pageList, $pageTranslations);
    }
 
    protected function ‪createFlashMessagesForNoBrokenLinks(): void
    {
        $languageService = $this->‪getLanguageService();
        $message = GeneralUtility::makeInstance(
            FlashMessage::class,
            $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:list.no.broken.links'),
            $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:list.no.broken.links.title'),
            ContextualFeedbackSeverity::OK,
            false
        );
        $flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
        $defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier('linkvalidator');
        $defaultFlashMessageQueue->enqueue($message);
    }
 
    protected function ‪generateTableRow(array $row): array
    {
        $fieldLabel = $row['field'];
        $table = $row['table_name'];
        $languageService = $this->‪getLanguageService();
        $hookObj = $this->linktypeRegistry->getLinktype($row['link_type'] ?? '');
 
        // Try to resolve the field label from TCA
        if (‪$GLOBALS['TCA'][$table]['columns'][$row['field']]['label'] ?? false) {
            $fieldLabel = $languageService->sL(‪$GLOBALS['TCA'][$table]['columns'][$row['field']]['label']);
            // Crop colon from end if present
            if (str_ends_with($fieldLabel, ':')) {
                $fieldLabel = substr($fieldLabel, 0, -1);
            }
        }
 
        return [
            'title' => $table . ':' . $row['record_uid'],
            'icon' => $this->iconFactory->getIconForRecord($table, $row, IconSize::SMALL)->render(),
            'headline' => $row['headline'],
            'label' => sprintf($languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:list.field'), $fieldLabel),
            'path' => BackendUtility::getRecordPath($row['record_pid'], $this->‪getBackendUser()->getPagePermsClause(‪Permission::PAGE_SHOW), 0),
            'linkTitle' => $row['link_title'],
            'linkTarget' => $hookObj?->getBrokenUrl($row),
            'linkStatus' => (bool)($row['url_response']['valid'] ?? false),
            'linkMessage' => $hookObj?->getErrorMessage($row['url_response']['errorParams']),
            'lastCheck' => sprintf(
                $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:list.msg.lastRun'),
                date(‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'], $row['last_check']),
                date(‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'], $row['last_check'])
            ),
            'needsRecheck' => (bool)$row['needs_recheck'],
            // Construct link to edit the record
            'editUrl' => (string)$this->uriBuilder->buildUriFromRoute('record_edit', [
                'edit' => [
                    $table => [
                        $row['record_uid'] => 'edit',
                    ],
                ],
                'columnsOnly' => $row['field'],
                'returnUrl' => $this->‪getModuleUri(
                    'report',
                    [
                        'last_edited_record_uid' => $row['record_uid'],
                        'last_edited_record_table' => $table,
                        'last_edited_record_field' => $row['field'],
                        'last_edited_record_timestamp' => $this->context->getPropertyFromAspect('date', 'timestamp'),
                    ]
                ),
            ]),
        ];
    }
 
    protected function ‪getCheckOptions(string $prefix): array
    {
        $brokenLinksInformation = $this->linkAnalyzer->getLinkCounts();
        $options = [
            'anyOptionChecked' => false,
            'totalCountLabel' => $this->‪getLanguageService()->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:overviews.nbtotal'),
            'totalCount' => $brokenLinksInformation['total'] ?: '0',
            'optionsByType' => [],
        ];
        $linkTypes = ‪GeneralUtility::trimExplode(',', $this->modTS['linktypes'] ?? '', true);
        foreach ($this->linktypeRegistry->getIdentifiers() as $type) {
            if (!in_array($type, $linkTypes, true)) {
                continue;
            }
            $isChecked = !empty($this->checkOpt[$prefix][$type]);
            if ($isChecked) {
                $options['anyOptionChecked'] = true;
            }
            $options['optionsByType'][$type] = [
                'id' => $prefix . '_SET_' . $type,
                'name' => $prefix . '_SET[' . $type . ']',
                'label' => $this->‪getLanguageService()->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:hooks.' . $type) ?: $type,
                'checked' => $isChecked,
                'count' => (!empty($brokenLinksInformation[$type]) ? $brokenLinksInformation[$type] : '0'),
            ];
        }
        $options['allOptionsChecked'] = array_filter($options['optionsByType'], static fn(array $option): bool => !$option['checked']) === [];
        return $options;
    }
 
    protected function ‪addDocHeaderShortCutButton(‪ModuleTemplate $view, string $action): void
    {
        $buttonBar = $view->‪getDocHeaderComponent()->getButtonBar();
        $shortcutButton = $buttonBar->makeShortcutButton()
            ->setRouteIdentifier('web_linkvalidator')
            ->setDisplayName($this->‪getModuleTitle())
            ->setArguments(['id' => $this->id, 'action' => $action]);
        $buttonBar->addButton($shortcutButton);
    }
 
    protected function ‪addDocHeaderDropDown(‪ModuleTemplate $view, string $currentAction): void
    {
        $languageService = $this->‪getLanguageService();
        $actionMenu = $view->‪getDocHeaderComponent()->getMenuRegistry()->makeMenu();
        $actionMenu->setIdentifier('reportLinkvalidatorSelector');
        $actionMenu->setLabel(
            $languageService->sL(
                'LLL:EXT:backend/Resources/Private/Language/locallang.xlf:moduleMenu.dropdown.label'
            )
        );
        $actionMenu->addMenuItem(
            $actionMenu->makeMenuItem()
                ->setTitle($languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:Report'))
                ->setHref($this->getModuleUri('report'))
                ->setActive($currentAction === 'report')
        );
        $actionMenu->addMenuItem(
            $actionMenu->makeMenuItem()
                ->setTitle($languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf:CheckLink'))
                ->setHref($this->getModuleUri('check'))
                ->setActive($currentAction === 'check')
        );
        $view->‪getDocHeaderComponent()->getMenuRegistry()->addMenu($actionMenu);
    }
 
    protected function ‪getModuleUri(string $action = null, array $additionalPramaters = []): string
    {
        $parameters = [
            'id' => ‪$this->id,
        ];
        if ($action !== null) {
            $parameters['action'] = $action;
        }
        return (string)$this->uriBuilder->buildUriFromRoute('web_linkvalidator', array_replace($parameters, $additionalPramaters));
    }
 
    protected function ‪getModuleTitle(): string
    {
        $languageService = $this->‪getLanguageService();
        $pageTitle = '';
        $moduleName = $languageService->sL('LLL:EXT:linkvalidator/Resources/Private/Language/Module/locallang_mod.xlf:mlang_labels_tablabel');
        if ($this->id === 0) {
            $pageTitle = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
        } elseif ($this->pageRecord !== []) {
            $pageTitle = BackendUtility::getRecordTitle('pages', $this->pageRecord, false, false);
        }
        return $moduleName . ($pageTitle !== '' ? ': ' . $pageTitle : '');
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
}