DocumentationFile.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\Install\UpgradeAnalysis;
 
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;
use ‪TYPO3\CMS\Core\Registry;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
use ‪TYPO3\CMS\Core\Utility\VersionNumberUtility;
 
class ‪DocumentationFile
{
    protected ‪$registry;
 
    protected ‪$tagsTotal = [];
 
    protected ‪$changelogPath = '';
 
    public function ‪__construct(‪Registry ‪$registry = null, $changelogDir = '')
    {
        $this->registry = ‪$registry;
        if ($this->registry === null) {
            $this->registry = new ‪Registry();
        }
        $this->changelogPath = $changelogDir !== '' ? $changelogDir : (string)realpath(‪ExtensionManagementUtility::extPath('core') . 'Documentation/Changelog');
        $this->changelogPath = str_replace('\\', '/', $this->changelogPath);
    }
 
    public function ‪findDocumentationDirectories(string $path): array
    {
        if (strcasecmp($path, $this->changelogPath) < 0 || strpos($path, $this->changelogPath) === false) {
            throw new \InvalidArgumentException('the given path does not belong to the changelog dir. Aborting', 1537158043);
        }
 
        $currentVersion = (int)explode('.', ‪VersionNumberUtility::getNumericTypo3Version())[0];
        $versions = range($currentVersion, $currentVersion - 2);
        $pattern = '(master|' . implode('\.*|', $versions) . '\.*)';
        ‪$finder = new Finder();
        ‪$finder
            ->depth(0)
            ->sortByName(true)
            ->name($pattern)
            ->in($path);
 
        $directories = [];
        foreach (‪$finder->directories() as $directory) {
            $directories[] = $directory->getBasename();
        }
 
        return $directories;
    }
 
    public function ‪findDocumentationFiles(string $path): array
    {
        if (strcasecmp($path, $this->changelogPath) < 0 || strpos($path, $this->changelogPath) === false) {
            throw new \InvalidArgumentException('the given path does not belong to the changelog dir. Aborting', 1485425530);
        }
 
        $documentationFiles = $this->‪getDocumentationFilesForVersion($path);
        $this->tagsTotal = $this->‪collectTagTotal($documentationFiles);
 
        return $documentationFiles;
    }
 
    public function ‪getListEntry(string $file): array
    {
        $entry = [];
        if (strcasecmp($file, $this->changelogPath) < 0 || strpos($file, $this->changelogPath) === false) {
            throw new \InvalidArgumentException('the given file does not belong to the changelog dir. Aborting', 1485425531);
        }
        $lines = file($file, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
        $lines = is_array($lines) ? $lines : [];
        $headline = $this->‪extractHeadline($lines);
        $entry['version'] = ‪PathUtility::basename(‪PathUtility::dirname($file));
        $entry['headline'] = $headline;
        $entry['filepath'] = $file;
        $entry['filename'] = pathinfo($file)['filename'];
        $entry['tags'] = $this->‪extractTags($lines);
        $entry['class'] = 'default';
        foreach ($entry['tags'] as $key => $tag) {
            if (strpos($tag, 'cat:') === 0) {
                $substr = substr($tag, 4);
                $entry['class'] = strtolower($substr);
                $entry['tags'][$key] = $substr;
            }
        }
        $entry['tagList'] = implode(',', $entry['tags']);
        $entry['content'] = (string)file_get_contents($file);
        $entry['parsedContent'] = $this->‪parseContent($entry['content']);
        $entry['file_hash'] = md5($entry['content']);
        if ($entry['version'] !== '') {
            $entry['url']['documentation'] = sprintf(
                'https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/%s/%s.html',
                $entry['version'],
                $entry['filename']
            );
        }
        $issueId = $this->‪parseIssueId($entry['filename']);
        if ($issueId) {
            $entry['url']['issue'] = sprintf('https://forge.typo3.org/issues/%s', $issueId);
        }
 
        return [md5($file) => $entry];
    }
 
    protected function ‪isRelevantFile(array $fileInfo): bool
    {
        $isRelevantFile = $fileInfo['extension'] === 'rst' && $fileInfo['filename'] !== 'Index';
        // file might be ignored by users choice
        if ($isRelevantFile && $this->‪isFileIgnoredByUsersChoice($fileInfo['basename'])) {
            $isRelevantFile = false;
        }
 
        return $isRelevantFile;
    }
 
    protected function ‪extractTags(array $file): array
    {
        $tags = $this->‪extractTagsFromFile($file);
        // Headline starting with the category like Breaking, Important or Feature
        $tags[] = $this->‪extractCategoryFromHeadline($file);
        natcasesort($tags);
 
        return $tags;
    }
 
    protected function ‪extractTagsFromFile(array $file): array
    {
        foreach ($file as $line) {
            if (strpos($line, '.. index::') === 0) {
                $tagString = substr($line, strlen('.. index:: '));
                return ‪GeneralUtility::trimExplode(',', $tagString, true);
            }
        }
 
        return [];
    }
 
    protected function ‪extractCategoryFromHeadline(array $lines): string
    {
        $headline = $this->‪extractHeadline($lines);
        if (strpos($headline, ':') !== false) {
            return 'cat:' . substr($headline, 0, strpos($headline, ':'));
        }
 
        return '';
    }
 
    protected function ‪extractHeadline(array $lines): string
    {
        $index = 0;
        while (strpos($lines[$index], '..') === 0 || strpos($lines[$index], '==') === 0) {
            $index++;
        }
        return trim($lines[$index]);
    }
 
    protected function ‪versionHasDocumentationFiles(string $docDirectory, string $version): bool
    {
        $absolutePath = str_replace('\\', '/', $docDirectory) . '/' . $version;
        ‪$finder = $this->‪getDocumentFinder()->in($absolutePath);
 
        return ‪$finder->files()->count() > 0;
    }
 
    protected function ‪getDocumentationFilesForVersion(string $docDirectory): array
    {
        $documentationFiles = [[]];
        $absolutePath = str_replace('\\', '/', $docDirectory);
        ‪$finder = $this->‪getDocumentFinder()->in($absolutePath);
 
        foreach (‪$finder->files() as $file) {
            $documentationFiles[] = $this->‪getListEntry($file->getPathname());
        }
 
        return array_merge(...$documentationFiles);
    }
 
    protected function ‪collectTagTotal($documentationFiles): array
    {
        $tags = [[]];
        foreach ($documentationFiles as $fileArray) {
            $tags[] = $fileArray['tags'];
        }
 
        return array_unique(array_merge(...$tags));
    }
 
    public function ‪getTagsTotal(): array
    {
        return ‪$this->tagsTotal;
    }
 
    protected function ‪isFileIgnoredByUsersChoice(string $filename): bool
    {
        $isFileIgnoredByUsersChoice = false;
 
        $ignoredFiles = $this->registry->get('upgradeAnalysisIgnoreFilter', 'ignoredDocumentationFiles');
        if (is_array($ignoredFiles)) {
            foreach ($ignoredFiles as $filePath) {
                if ($filePath !== null && strlen($filePath) > 0) {
                    if (strpos($filePath, $filename) !== false) {
                        $isFileIgnoredByUsersChoice = true;
                        break;
                    }
                }
            }
        }
        return $isFileIgnoredByUsersChoice;
    }
 
    protected function ‪parseContent(string $rstContent): string
    {
        $content = htmlspecialchars($rstContent);
        $content = (string)preg_replace('/:issue:`([\d]*)`/', '<a href="https://forge.typo3.org/issues/\\1" target="_blank" rel="noreferrer">\\1</a>', $content);
        $content = (string)preg_replace('/#([\d]*)/', '#<a href="https://forge.typo3.org/issues/\\1" target="_blank" rel="noreferrer">\\1</a>', $content);
        $content = (string)preg_replace('/(\n([=]*)\n(.*)\n([=]*)\n)/', '', $content, 1);
        $content = (string)preg_replace('/.. index::(.*)/', '', $content);
        $content = (string)preg_replace('/.. include::(.*)/', '', $content);
        return trim($content);
    }
 
    protected function ‪parseIssueId(string $filename): ?string
    {
        return ‪GeneralUtility::trimExplode('-', $filename)[1] ?? null;
    }
 
    protected function ‪getDocumentFinder(): Finder
    {
        ‪$finder = new Finder();
        ‪$finder
            ->depth(0)
            ->sortByName()
            ->name('/^(Feature|Breaking|Deprecation|Important)\-\d+.+\.rst$/i');
 
        return ‪$finder;
    }
}