LinkAnalyzer.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Linkvalidator;

/*
 * 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!
 */

use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Html\HtmlParser;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Lang\LanguageService;

class LinkAnalyzer
{
    protected $searchFields = array();

    protected $pidList = '';

    protected $linkCounts = array();

    protected $brokenLinkCounts = array();

    protected $recordsWithBrokenLinks = array();

    protected $hookObjectsArr = array();

    protected $extPageInTreeInfo = array();

    protected $recordReference = '';

    protected $pageWithAnchor = '';

    protected $tsConfig = array();

    public function __construct()
    {
        $this->getLanguageService()->includeLLFile('EXT:linkvalidator/Resources/Private/Language/Module/locallang.xlf');
        // Hook to handle own checks
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['linkvalidator']['checkLinks'])) {
            foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['linkvalidator']['checkLinks'] as $key => $classRef) {
                $this->hookObjectsArr[$key] = GeneralUtility::getUserObj($classRef);
            }
        }
    }

    public function init(array $searchField, $pid, $tsConfig)
    {
        $this->searchFields = $searchField;
        $this->pidList = $pid;
        $this->tsConfig = $tsConfig;
    }

    public function getLinkStatistics($checkOptions = array(), $considerHidden = false)
    {
        $results = array();
        if (!empty($checkOptions)) {
            $checkKeys = array_keys($checkOptions);
            $checkLinkTypeCondition = ' AND link_type IN (\'' . implode('\',\'', $checkKeys) . '\')';
            $this->getDatabaseConnection()->exec_DELETEquery(
                'tx_linkvalidator_link',
                '(record_pid IN (' . $this->pidList . ')' .
                    ' OR ( record_uid IN (' . $this->pidList . ') AND table_name like \'pages\'))' .
                    $checkLinkTypeCondition
            );
            // Traverse all configured tables
            foreach ($this->searchFields as $table => $fields) {
                if ($table === 'pages') {
                    $where = 'deleted = 0 AND uid IN (' . $this->pidList . ')';
                } else {
                    $where = 'deleted = 0 AND pid IN (' . $this->pidList . ')';
                }
                if (!$considerHidden) {
                    $where .= BackendUtility::BEenableFields($table);
                }
                // If table is not configured, assume the extension is not installed
                // and therefore no need to check it
                if (!is_array($GLOBALS['TCA'][$table])) {
                    continue;
                }
                // Re-init selectFields for table
                $selectFields = 'uid, pid';
                $selectFields .= ', ' . $GLOBALS['TCA'][$table]['ctrl']['label'] . ', ' . implode(', ', $fields);

                // @todo #64091: only select rows that have content in at least one of the relevant fields (via OR)
                $rows = $this->getDatabaseConnection()->exec_SELECTgetRows($selectFields, $table, $where);
                if (!empty($rows)) {
                    foreach ($rows as $row) {
                        $this->analyzeRecord($results, $table, $fields, $row);
                    }
                }
            }
            foreach ($this->hookObjectsArr as $key => $hookObj) {
                if (is_array($results[$key]) && empty($checkOptions) || is_array($results[$key]) && $checkOptions[$key]) {
                    //  Check them
                    foreach ($results[$key] as $entryKey => $entryValue) {
                        $table = $entryValue['table'];
                        $record = array();
                        $record['headline'] = BackendUtility::getRecordTitle($table, $entryValue['row']);
                        $record['record_pid'] = $entryValue['row']['pid'];
                        $record['record_uid'] = $entryValue['uid'];
                        $record['table_name'] = $table;
                        $record['link_title'] = $entryValue['link_title'];
                        $record['field'] = $entryValue['field'];
                        $record['last_check'] = time();
                        $this->recordReference = $entryValue['substr']['recordRef'];
                        $this->pageWithAnchor = $entryValue['pageAndAnchor'];
                        if (!empty($this->pageWithAnchor)) {
                            // Page with anchor, e.g. 18#1580
                            $url = $this->pageWithAnchor;
                        } else {
                            $url = $entryValue['substr']['tokenValue'];
                        }
                        $this->linkCounts[$table]++;
                        $checkUrl = $hookObj->checkLink($url, $entryValue, $this);
                        // Broken link found
                        if (!$checkUrl) {
                            $response = array();
                            $response['valid'] = false;
                            $response['errorParams'] = $hookObj->getErrorParams();
                            $this->brokenLinkCounts[$table]++;
                            $record['link_type'] = $key;
                            $record['url'] = $url;
                            $record['url_response'] = serialize($response);
                            $this->getDatabaseConnection()->exec_INSERTquery('tx_linkvalidator_link', $record);
                        } elseif (GeneralUtility::_GP('showalllinks')) {
                            $response = array();
                            $response['valid'] = true;
                            $this->brokenLinkCounts[$table]++;
                            $record['url'] = $url;
                            $record['link_type'] = $key;
                            $record['url_response'] = serialize($response);
                            $this->getDatabaseConnection()->exec_INSERTquery('tx_linkvalidator_link', $record);
                        }
                    }
                }
            }
        }
    }

    public function analyzeRecord(array &$results, $table, array $fields, array $record)
    {
        list($results, $record) = $this->emitBeforeAnalyzeRecordSignal($results, $record, $table, $fields);

        // Put together content of all relevant fields
        $haystack = '';
        $htmlParser = GeneralUtility::makeInstance(HtmlParser::class);
        $idRecord = $record['uid'];
        // Get all references
        foreach ($fields as $field) {
            $haystack .= $record[$field] . ' --- ';
            $conf = $GLOBALS['TCA'][$table]['columns'][$field]['config'];
            $valueField = $record[$field];
            // Check if a TCA configured field has soft references defined (see TYPO3 Core API document)
            if ($conf['softref'] && (string)$valueField !== '') {
                // Explode the list of soft references/parameters
                $softRefs = BackendUtility::explodeSoftRefParserList($conf['softref']);
                if ($softRefs !== false) {
                    // Traverse soft references
                    foreach ($softRefs as $spKey => $spParams) {
                        $softRefObj = BackendUtility::softRefParserObj($spKey);
                        // If there is an object returned...
                        if (is_object($softRefObj)) {
                            // Do processing
                            $resultArray = $softRefObj->findRef($table, $field, $idRecord, $valueField, $spKey, $spParams);
                            if (!empty($resultArray['elements'])) {
                                if ($spKey == 'typolink_tag') {
                                    $this->analyseTypoLinks($resultArray, $results, $htmlParser, $record, $field, $table);
                                } else {
                                    $this->analyseLinks($resultArray, $results, $record, $field, $table);
                                }
                            }
                        }
                    }
                }
            }
        }
    }

    public function getTSConfig()
    {
        return $this->tsConfig;
    }

    protected function analyseLinks(array $resultArray, array &$results, array $record, $field, $table)
    {
        foreach ($resultArray['elements'] as $element) {
            $r = $element['subst'];
            $type = '';
            $idRecord = $record['uid'];
            if (!empty($r)) {
                foreach ($this->hookObjectsArr as $keyArr => $hookObj) {
                    $type = $hookObj->fetchType($r, $type, $keyArr);
                    // Store the type that was found
                    // This prevents overriding by internal validator
                    if (!empty($type)) {
                        $r['type'] = $type;
                    }
                }
                $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $r['tokenID']]['substr'] = $r;
                $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $r['tokenID']]['row'] = $record;
                $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $r['tokenID']]['table'] = $table;
                $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $r['tokenID']]['field'] = $field;
                $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $r['tokenID']]['uid'] = $idRecord;
            }
        }
    }

    protected function analyseTypoLinks(array $resultArray, array &$results, $htmlParser, array $record, $field, $table)
    {
        $currentR = array();
        $linkTags = $htmlParser->splitIntoBlock('link', $resultArray['content']);
        $idRecord = $record['uid'];
        $type = '';
        $title = '';
        $countLinkTags = count($linkTags);
        for ($i = 1; $i < $countLinkTags; $i += 2) {
            $referencedRecordType = '';
            foreach ($resultArray['elements'] as $element) {
                $type = '';
                $r = $element['subst'];
                if (!empty($r['tokenID'])) {
                    if (substr_count($linkTags[$i], $r['tokenID'])) {
                        // Type of referenced record
                        if (strpos($r['recordRef'], 'pages') !== false) {
                            $currentR = $r;
                            // Contains number of the page
                            $referencedRecordType = $r['tokenValue'];
                            $wasPage = true;
                        } elseif (strpos($r['recordRef'], 'tt_content') !== false && (isset($wasPage) && $wasPage === true)) {
                            $referencedRecordType = $referencedRecordType . '#c' . $r['tokenValue'];
                            $wasPage = false;
                        } else {
                            $currentR = $r;
                        }
                        $title = strip_tags($linkTags[$i]);
                    }
                }
            }
            foreach ($this->hookObjectsArr as $keyArr => $hookObj) {
                $type = $hookObj->fetchType($currentR, $type, $keyArr);
                // Store the type that was found
                // This prevents overriding by internal validator
                if (!empty($type)) {
                    $currentR['type'] = $type;
                }
            }
            $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $currentR['tokenID']]['substr'] = $currentR;
            $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $currentR['tokenID']]['row'] = $record;
            $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $currentR['tokenID']]['table'] = $table;
            $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $currentR['tokenID']]['field'] = $field;
            $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $currentR['tokenID']]['uid'] = $idRecord;
            $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $currentR['tokenID']]['link_title'] = $title;
            $results[$type][$table . ':' . $field . ':' . $idRecord . ':' . $currentR['tokenID']]['pageAndAnchor'] = $referencedRecordType;
        }
    }

    public function getLinkCounts($curPage)
    {
        $markerArray = array();
        if (empty($this->pidList)) {
            $this->pidList = $curPage;
        }
        $this->pidList = rtrim($this->pidList, ',');

        $rows = $this->getDatabaseConnection()->exec_SELECTgetRows(
            'count(uid) as nbBrokenLinks,link_type',
            'tx_linkvalidator_link',
            'record_pid in (' . $this->pidList . ')',
            'link_type'
        );
        if (!empty($rows)) {
            foreach ($rows as $row) {
                $markerArray[$row['link_type']] = $row['nbBrokenLinks'];
                $markerArray['brokenlinkCount'] += $row['nbBrokenLinks'];
            }
        }
        return $markerArray;
    }

    public function extGetTreeList($id, $depth, $begin = 0, $permsClause, $considerHidden = false)
    {
        $depth = (int)$depth;
        $begin = (int)$begin;
        $id = (int)$id;
        $theList = '';
        if ($depth > 0) {
            $rows = $this->getDatabaseConnection()->exec_SELECTgetRows(
                'uid,title,hidden,extendToSubpages',
                'pages',
                'pid=' . $id . ' AND deleted=0 AND ' . $permsClause
            );
            if (!empty($rows)) {
                foreach ($rows as $row) {
                    if ($begin <= 0 && ($row['hidden'] == 0 || $considerHidden)) {
                        $theList .= $row['uid'] . ',';
                        $this->extPageInTreeInfo[] = array($row['uid'], htmlspecialchars($row['title'], $depth));
                    }
                    if ($depth > 1 && (!($row['hidden'] == 1 && $row['extendToSubpages'] == 1) || $considerHidden)) {
                        $theList .= $this->extGetTreeList($row['uid'], $depth - 1, $begin - 1, $permsClause, $considerHidden);
                    }
                }
            }
        }
        return $theList;
    }

    public function getRootLineIsHidden(array $pageInfo)
    {
        $hidden = false;
        if ($pageInfo['extendToSubpages'] == 1 && $pageInfo['hidden'] == 1) {
            $hidden = true;
        } else {
            if ($pageInfo['pid'] > 0) {
                $rows = $this->getDatabaseConnection()->exec_SELECTgetRows(
                    'uid,title,hidden,extendToSubpages',
                    'pages',
                    'uid=' . $pageInfo['pid']
                );
                if (!empty($rows)) {
                    foreach ($rows as $row) {
                        $hidden = $this->getRootLineIsHidden($row);
                    }
                }
            }
        }
        return $hidden;
    }

    protected function emitBeforeAnalyzeRecordSignal($results, $record, $table, $fields)
    {
        return $this->getSignalSlotDispatcher()->dispatch(
            self::class,
            'beforeAnalyzeRecord',
            array($results, $record, $table, $fields, $this)
        );
    }

    protected function getSignalSlotDispatcher()
    {
        return $this->getObjectManager()->get(\TYPO3\CMS\Extbase\SignalSlot\Dispatcher::class);
    }

    protected function getObjectManager()
    {
        return GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
    }

    protected function getDatabaseConnection()
    {
        return $GLOBALS['TYPO3_DB'];
    }

    protected function getLanguageService()
    {
        return $GLOBALS['LANG'];
    }
}