build/deleted_file_check.php - 5.4-dev - githubmirror/joomla-cms

build/deleted_file_check.php
252 строки10 KB
Richard Fath
[5.1] Add exceptions to deleted files check for JS files to be kept on update (#42936)
27 мар 2024, 21:09
27 мар 2024, 21:09d216281
<?php

/**
 * This file is used to build the list of deleted files between two reference points.
 *
 * This script requires one parameter:
 *
 * --from - The git commit reference to use as the starting point for the comparison.
 *
 * This script has one additional optional parameter:
 *
 * --to - The git commit reference to use as the ending point for the comparison.
 *
 * The reference parameters may be any valid identifier (i.e. a branch, tag, or commit SHA)
 *
 * @package    Joomla.Build
 *
 * @copyright  (C) 2017 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

/*
 * Constants
 */
const PHP_TAB = "\t";

function usage($command)
{
    echo PHP_EOL;
    echo 'Usage: php ' . $command . ' [options]' . PHP_EOL;
    echo PHP_TAB . '--from <ref>:' . PHP_TAB . 'Starting commit reference (branch/tag)' . PHP_EOL;
    echo PHP_TAB . '--to <ref>:' . PHP_TAB . 'Ending commit reference (branch/tag) [optional]' . PHP_EOL;
    echo PHP_EOL;
}

/*
 * This is where the magic happens
 */

$options = getopt('', ['from:', 'to::']);

// We need the from reference, otherwise we're doomed to fail
if (empty($options['from'])) {
    echo PHP_EOL;
    echo 'Missing starting directory' . PHP_EOL;

    usage($argv[0]);

    exit(1);
}

// Missing the to reference?  No problem, grab the current HEAD
if (empty($options['to'])) {
    echo PHP_EOL;
    echo 'Missing ending directory' . PHP_EOL;

    usage($argv[0]);

    exit(1);
}

// Directories to skip for the check (needs to include anything from J3 we want to keep)
$previousReleaseExclude = [
    $options['from'] . '/administrator/components/com_search',
    $options['from'] . '/components/com_search',
    $options['from'] . '/images/sampledata',
    $options['from'] . '/installation',
    $options['from'] . '/media/com_cpanel/js',
    $options['from'] . '/media/com_modules/js',
    $options['from'] . '/media/legacy/js',
    $options['from'] . '/media/mod_multilangstatus',
    $options['from'] . '/media/plg_quickicon_eos310',
    $options['from'] . '/media/system/images',
    $options['from'] . '/modules/mod_search',
    $options['from'] . '/plugins/captcha/recaptcha',
    $options['from'] . '/plugins/captcha/recaptcha_invisible',
    $options['from'] . '/plugins/fields/repeatable',
    $options['from'] . '/plugins/quickicon/eos310',
    $options['from'] . '/plugins/search',
    $options['from'] . '/plugins/system/compat',
    $options['from'] . '/plugins/system/logrotation',
    $options['from'] . '/plugins/system/sessiongc',
    $options['from'] . '/plugins/system/updatenotification',
    $options['from'] . '/plugins/task/demotasks',
];

/**
 * @param   SplFileInfo                      $file      The file being checked
 * @param   mixed                            $key       ?
 * @param   RecursiveCallbackFilterIterator  $iterator  The iterator being processed
 *
 * @return bool True if you need to recurse or if the item is acceptable
 */
$previousReleaseFilter = function ($file, $key, $iterator) use ($previousReleaseExclude) {
    if ($iterator->hasChildren() && !\in_array($file->getPathname(), $previousReleaseExclude)) {
        return true;
    }

    return $file->isFile();
};

// Directories to skip for the check
$newReleaseExclude = [
    $options['to'] . '/installation',
];

/**
 * @param   SplFileInfo                      $file      The file being checked
 * @param   mixed                            $key       ?
 * @param   RecursiveCallbackFilterIterator  $iterator  The iterator being processed
 *
 * @return bool True if you need to recurse or if the item is acceptable
 */
$newReleaseFilter = function ($file, $key, $iterator) use ($newReleaseExclude) {
    if ($iterator->hasChildren() && !\in_array($file->getPathname(), $newReleaseExclude)) {
        return true;
    }

    return $file->isFile();
};

$previousReleaseDirIterator = new RecursiveDirectoryIterator($options['from'], RecursiveDirectoryIterator::SKIP_DOTS);
$previousReleaseIterator    = new RecursiveIteratorIterator(
    new RecursiveCallbackFilterIterator($previousReleaseDirIterator, $previousReleaseFilter),
    RecursiveIteratorIterator::SELF_FIRST
);
$previousReleaseFiles   = [];
$previousReleaseFolders = [];

foreach ($previousReleaseIterator as $info) {
    if ($info->isDir()) {
        $previousReleaseFolders[] = "'" . str_replace($options['from'], '', $info->getPathname()) . "',";
        continue;
    }

    $previousReleaseFiles[] = "'" . str_replace($options['from'], '', $info->getPathname()) . "',";
}

$newReleaseDirIterator = new RecursiveDirectoryIterator($options['to'], RecursiveDirectoryIterator::SKIP_DOTS);
$newReleaseIterator    = new RecursiveIteratorIterator(
    new RecursiveCallbackFilterIterator($newReleaseDirIterator, $newReleaseFilter),
    RecursiveIteratorIterator::SELF_FIRST
);
$newReleaseFiles   = [];
$newReleaseFolders = [];

foreach ($newReleaseIterator as $info) {
    if ($info->isDir()) {
        $newReleaseFolders[] = "'" . str_replace($options['to'], '', $info->getPathname()) . "',";
        continue;
    }

    $newReleaseFiles[] = "'" . str_replace($options['to'], '', $info->getPathname()) . "',";
}

$filesDifference = array_diff($previousReleaseFiles, $newReleaseFiles);

$foldersDifference = array_diff($previousReleaseFolders, $newReleaseFolders);

// Specific files (e.g. language files) that we want to keep on upgrade
$filesToKeep = [
    "'/administrator/language/en-GB/en-GB.com_search.ini',",
    "'/administrator/language/en-GB/en-GB.com_search.sys.ini',",
    "'/administrator/language/en-GB/en-GB.plg_editors-xtd_weblink.ini',",
    "'/administrator/language/en-GB/en-GB.plg_editors-xtd_weblink.sys.ini',",
    "'/administrator/language/en-GB/en-GB.plg_fields_repeatable.ini',",
    "'/administrator/language/en-GB/en-GB.plg_fields_repeatable.sys.ini',",
    "'/administrator/language/en-GB/en-GB.plg_quickicon_eos310.ini',",
    "'/administrator/language/en-GB/en-GB.plg_quickicon_eos310.sys.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_categories.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_categories.sys.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_contacts.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_contacts.sys.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_content.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_content.sys.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_newsfeeds.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_newsfeeds.sys.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_tags.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_tags.sys.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_weblinks.ini',",
    "'/administrator/language/en-GB/en-GB.plg_search_weblinks.sys.ini',",
    "'/administrator/language/en-GB/en-GB.plg_system_weblinks.ini',",
    "'/administrator/language/en-GB/en-GB.plg_system_weblinks.sys.ini',",
    "'/administrator/language/en-GB/plg_captcha_recaptcha.ini',",
    "'/administrator/language/en-GB/plg_captcha_recaptcha.sys.ini',",
    "'/administrator/language/en-GB/plg_captcha_recaptcha_invisible.ini',",
    "'/administrator/language/en-GB/plg_captcha_recaptcha_invisible.sys.ini',",
    "'/administrator/language/en-GB/plg_system_compat.ini',",
    "'/administrator/language/en-GB/plg_system_compat.sys.ini',",
    "'/administrator/language/en-GB/plg_system_logrotation.ini',",
    "'/administrator/language/en-GB/plg_system_logrotation.sys.ini',",
    "'/administrator/language/en-GB/plg_system_sessiongc.ini',",
    "'/administrator/language/en-GB/plg_system_sessiongc.sys.ini',",
    "'/administrator/language/en-GB/plg_system_updatenotification.ini',",
    "'/administrator/language/en-GB/plg_system_updatenotification.sys.ini',",
    "'/administrator/language/en-GB/plg_task_demotasks.ini',",
    "'/administrator/language/en-GB/plg_task_demotasks.sys.ini',",
    "'/language/en-GB/en-GB.com_search.ini',",
    "'/language/en-GB/en-GB.mod_search.ini',",
    "'/language/en-GB/en-GB.mod_search.sys.ini',",
];

// Specific folders that we want to keep on upgrade
$foldersToKeep = [
    "'/bin',",
];

// Remove folders from the results which we want to keep on upgrade
foreach ($foldersToKeep as $folder) {
    if (($key = array_search($folder, $foldersDifference)) !== false) {
        unset($foldersDifference[$key]);
    }
}

asort($filesDifference);
rsort($foldersDifference);

$deletedFiles = [];
$renamedFiles = [];

foreach ($filesDifference as $file) {
    // Don't remove any specific files (e.g. language files) that we want to keep on upgrade
    if (array_search($file, $filesToKeep) !== false) {
        continue;
    }

    // Check for files which might have been renamed only
    $matches = preg_grep('/^' . preg_quote($file, '/') . '$/i', $newReleaseFiles);

    if ($matches !== false) {
        foreach ($matches as $match) {
            if (\dirname($match) === \dirname($file) && strtolower(basename($match)) === strtolower(basename($file))) {
                // File has been renamed only: Add to renamed files list
                $renamedFiles[] = substr($file, 0, -1) . ' => ' . $match;

                // Go on with the next file in $filesDifference
                continue 2;
            }
        }
    }

    // File has been really deleted and not just renamed
    $deletedFiles[] = $file;
}

// Write the lists to files for later reference
file_put_contents(__DIR__ . '/deleted_files.txt', implode("\n", $deletedFiles));
file_put_contents(__DIR__ . '/deleted_folders.txt', implode("\n", $foldersDifference));
file_put_contents(__DIR__ . '/renamed_files.txt', implode("\n", $renamedFiles));

echo PHP_EOL;
echo 'There are ' . \count($deletedFiles) . ' deleted files, ' . \count($foldersDifference) .  ' deleted folders and ' . \count($renamedFiles) .  ' renamed files in comparison to "' . $options['from'] . '"' . PHP_EOL;