xref: /plugin/dev/cli.php (revision 57732a2deb30e37ca1da600eec8529b2e854253d)

#!/usr/bin/env php
<?php

use dokuwiki\Extension\CLIPlugin;
use dokuwiki\Extension\PluginController;
use dokuwiki\plugin\dev\LangProcessor;
use dokuwiki\plugin\dev\Skeletor;
use dokuwiki\plugin\dev\SVGIcon;
use splitbrain\phpcli\Exception as CliException;
use splitbrain\phpcli\Options;

/**
 * @license GPL2
 * @author  Andreas Gohr <andi@splitbrain.org>
 */
class cli_plugin_dev extends CLIPlugin
{
    /**
     * Register options and arguments on the given $options object
     *
     * @param Options $options
     * @return void
     */
    protected function setup(Options $options)
    {
        $options->useCompactHelp();
        $options->setHelp(
            "CLI to help with DokuWiki plugin and template development.\n\n" .
            "Run this script from within the extension's directory."
        );

        $options->registerCommand('init', 'Initialize a new plugin or template in the current directory.');
        $options->registerCommand('addTest', 'Add the testing framework files and a test. (_test/)');
        $options->registerArgument('test', 'Optional name of the new test. Defaults to the general test.', false,
            'addTest');
        $options->registerCommand('addConf', 'Add the configuration files. (conf/)');
        $options->registerCommand('addLang', 'Add the language files. (lang/)');

        $types = PluginController::PLUGIN_TYPES;
        array_walk(
            $types,
            function (&$item) {
                $item = $this->colors->wrap($item, $this->colors::C_BROWN);
            }
        );

        $options->registerCommand('addComponent', 'Add a new plugin component.');
        $options->registerArgument('type', 'Type of the component. Needs to be one of ' . join(', ', $types), true,
            'addComponent');
        $options->registerArgument('name', 'Optional name of the component. Defaults to a base component.', false,
            'addComponent');

        $options->registerCommand('deletedFiles', 'Create the list of deleted files based on the git history.');
        $options->registerCommand('rmObsolete', 'Delete obsolete files.');

        $prefixes = array_keys(SVGIcon::SOURCES);
        array_walk(
            $prefixes,
            function (&$item) {
                $item = $this->colors->wrap($item, $this->colors::C_BROWN);
            }
        );

        $options->registerCommand('downloadSvg', 'Download an SVG file from a known icon repository.');
        $options->registerArgument('prefix:name',
            'Colon-prefixed name of the icon. Available prefixes: ' . join(', ', $prefixes), true, 'downloadSvg');
        $options->registerArgument('output', 'File to save, defaults to <name>.svg in current dir', false,
            'downloadSvg');
        $options->registerOption('keep-ns', 'Keep the SVG namespace. Use when the file is not inlined into HTML.', 'k',
            false, 'downloadSvg');

        $options->registerCommand('cleanSvg', 'Clean a existing SVG files to reduce their file size.');
        $options->registerArgument('files...', 'The files to clean (will be overwritten)', true, 'cleanSvg');
        $options->registerOption('keep-ns', 'Keep the SVG namespace. Use when the file is not inlined into HTML.', 'k',
            false, 'cleanSvg');

        $options->registerCommand('cleanLang',
            'Clean language files from unused language strings. Detecting which strings are truly in use may ' .
            'not always correctly work. Use with caution.');

        $options->registerCommand(
            'test',
            'Run the unit tests for this extension. (calls phpunit using the proper config and group)'
        );
        $options->registerOption(
            'filter',
            'Filter tests to run by a given string. (passed to phpunit)',
            null,
            true,
            'test'
        );
        $options->registerArgument('files...', 'The test files to run. Defaults to all.', false, 'test');

        $options->registerCommand('check', 'Check for code style violations.');
        $options->registerArgument('files...', 'The files to check. Defaults to the whole extension.', false, 'check');

        $options->registerCommand('fix', 'Fix code style violations and refactor outdated code.');
        $options->registerArgument('files...', 'The files to check. Defaults to the whole extension.', false, 'fix');
    }

    /** @inheritDoc */
    protected function main(Options $options)
    {
        $args = $options->getArgs();

        switch ($options->getCmd()) {
            case 'init':
                return $this->cmdInit();
            case 'addTest':
                $test = array_shift($args);
                return $this->cmdAddTest($test);
            case 'addConf':
                return $this->cmdAddConf();
            case 'addLang':
                return $this->cmdAddLang();
            case 'addComponent':
                $type = array_shift($args);
                $component = array_shift($args);
                return $this->cmdAddComponent($type, $component);
            case 'deletedFiles':
                return $this->cmdDeletedFiles();
            case 'rmObsolete':
                return $this->cmdRmObsolete();
            case 'downloadSvg':
                $ident = array_shift($args);
                $save = array_shift($args);
                $keep = $options->getOpt('keep-ns');
                return $this->cmdDownloadSVG($ident, $save, $keep);
            case 'cleanSvg':
                $keep = $options->getOpt('keep-ns');
                return $this->cmdCleanSVG($args, $keep);
            case 'cleanLang':
                return $this->cmdCleanLang();
            case 'test':
                $filter = $options->getOpt('filter');
                return $this->cmdTest($filter, $args);
            case 'check':
                return $this->cmdCheck($args);
            case 'fix':
                return $this->cmdFix();
            default:
                $this->error('Unknown command');
                echo $options->help();
                return 0;
        }
    }

    /**
     * Get the extension name from the current working directory
     *
     * @throws CliException if something's wrong
     * @param string $dir
     * @return string[] name, type
     */
    protected function getTypedNameFromDir($dir)
    {
        $pdir = fullpath(DOKU_PLUGIN);
        $tdir = fullpath(tpl_incdir() . '../');

        if (strpos($dir, $pdir) === 0) {
            $ldir = substr($dir, strlen($pdir));
            $type = 'plugin';
        } elseif (strpos($dir, $tdir) === 0) {
            $ldir = substr($dir, strlen($tdir));
            $type = 'template';
        } else {
            throw new CliException('Current directory needs to be in plugin or template directory');
        }

        $ldir = trim($ldir, '/');

        if (strpos($ldir, '/') !== false) {
            throw new CliException('Current directory has to be main extension directory');
        }

        return [$ldir, $type];
    }

    /**
     * Interactively ask for a value from the user
     *
     * @param string $prompt
     * @param bool $cache cache given value for next time?
     * @return string
     */
    protected function readLine($prompt, $cache = false)
    {
        $value = '';
        $default = '';
        $cachename = getCacheName($prompt, '.readline');
        if ($cache && file_exists($cachename)) {
            $default = file_get_contents($cachename);
        }

        while ($value === '') {
            echo $prompt;
            if ($default) echo ' [' . $default . ']';
            echo ': ';

            $fh = fopen('php://stdin', 'r');
            $value = trim(fgets($fh));
            fclose($fh);

            if ($value === '') $value = $default;
        }

        if ($cache) {
            file_put_contents($cachename, $value);
        }

        return $value;
    }

    /**
     * Create the given files with their given content
     *
     * Ignores all files that already exist
     *
     * @param array $files A File array as created by Skeletor::getFiles()
     */
    protected function createFiles($files)
    {
        foreach ($files as $path => $content) {
            if (file_exists($path)) {
                $this->error($path . ' already exists');
                continue;
            }

            io_makeFileDir($path);
            file_put_contents($path, $content);
            $this->success($path . ' created');
        }
    }

    /**
     * Delete the given file if it exists
     *
     * @param string $file
     */
    protected function deleteFile($file)
    {
        if (!file_exists($file)) return;
        if (@unlink($file)) {
            $this->success('Delete ' . $file);
        }
    }

    /**
     * Run git with the given arguments and return the output
     *
     * @throws CliException when the command can't be run
     * @param string ...$args
     * @return string[]
     */
    protected function git(...$args)
    {
        $args = array_map('escapeshellarg', $args);
        $cmd = 'git ' . join(' ', $args);
        $output = [];
        $result = 0;

        $this->info($cmd);
        $last = exec($cmd, $output, $result);
        if ($last === false || $result !== 0) {
            throw new CliException('Running git failed');
        }

        return $output;
    }

    // region Commands

    /**
     * Intialize the current directory as a plugin or template
     *
     * @return int
     */
    protected function cmdInit()
    {
        $dir = fullpath(getcwd());
        if ((new FilesystemIterator($dir))->valid()) {
            // existing directory, initialize from info file
            $skeletor = Skeletor::fromDir($dir);
        } else {
            // new directory, ask for info
            [$base, $type] = $this->getTypedNameFromDir($dir);
            $user = $this->readLine('Your Name', true);
            $mail = $this->readLine('Your E-Mail', true);
            $desc = $this->readLine('Short description');
            $skeletor = new Skeletor($type, $base, $desc, $user, $mail);
        }
        $skeletor->addBasics();
        $this->createFiles($skeletor->getFiles());

        if (!is_dir("$dir/.git")) {
            try {
                $this->git('init');
            } catch (CliException $e) {
                $this->error($e->getMessage());
            }
        }

        return 0;
    }

    /**
     * Add test framework
     *
     * @param string $test Name of the Test to add
     * @return int
     */
    protected function cmdAddTest($test = '')
    {
        $skeletor = Skeletor::fromDir(getcwd());
        $skeletor->addTest($test);
        $this->createFiles($skeletor->getFiles());
        return 0;
    }

    /**
     * Add configuration
     *
     * @return int
     */
    protected function cmdAddConf()
    {
        $skeletor = Skeletor::fromDir(getcwd());
        $skeletor->addConf(is_dir('lang'));
        $this->createFiles($skeletor->getFiles());
        return 0;
    }

    /**
     * Add language
     *
     * @return int
     */
    protected function cmdAddLang()
    {
        $skeletor = Skeletor::fromDir(getcwd());
        $skeletor->addLang(is_dir('conf'));
        $this->createFiles($skeletor->getFiles());
        return 0;
    }

    /**
     * Add another component to the plugin
     *
     * @param string $type
     * @param string $component
     */
    protected function cmdAddComponent($type, $component = '')
    {
        $skeletor = Skeletor::fromDir(getcwd());
        $skeletor->addComponent($type, $component);
        $this->createFiles($skeletor->getFiles());
        return 0;
    }

    /**
     * Generate a list of deleted files from git
     *
     * @link https://stackoverflow.com/a/6018049/172068
     */
    protected function cmdDeletedFiles()
    {
        if (!is_dir('.git')) throw new CliException('This extension seems not to be managed by git');

        $output = $this->git('log', '--no-renames', '--pretty=format:', '--name-only', '--diff-filter=D');
        $output = array_map('trim', $output);
        $output = array_filter($output);
        $output = array_unique($output);
        $output = array_filter($output, function ($item) {
            return !file_exists($item);
        });
        sort($output);

        if (!count($output)) {
            $this->info('No deleted files found');
            return 0;
        }

        $content = "# This is a list of files that were present in previous releases\n" .
            "# but were removed later. They should not exist in your installation.\n" .
            join("\n", $output) . "\n";

        file_put_contents('deleted.files', $content);
        $this->success('written deleted.files');
        return 0;
    }

    /**
     * Remove files that shouldn't be here anymore
     */
    protected function cmdRmObsolete()
    {
        $this->deleteFile('_test/general.test.php');
        $this->deleteFile('.travis.yml');
        $this->deleteFile('.github/workflows/phpTestLinux.yml');

        return 0;
    }

    /**
     * Download a remote icon
     *
     * @param string $ident
     * @param string $save
     * @param bool $keep
     * @return int
     * @throws Exception
     */
    protected function cmdDownloadSVG($ident, $save = '', $keep = false)
    {
        $svg = new SVGIcon($this);
        $svg->keepNamespace($keep);
        return (int)$svg->downloadRemoteIcon($ident, $save);
    }

    /**
     * @param string[] $files
     * @param bool $keep
     * @return int
     * @throws Exception
     */
    protected function cmdCleanSVG($files, $keep = false)
    {
        $svg = new SVGIcon($this);
        $svg->keepNamespace($keep);

        $ok = true;
        foreach ($files as $file) {
            $ok = $ok && $svg->cleanSVGFile($file);
        }
        return (int)$ok;
    }

    /**
     * @return int
     */
    protected function cmdCleanLang()
    {
        $lp = new LangProcessor($this);

        $files = glob('./lang/*/lang.php');
        foreach ($files as $file) {
            $lp->processLangFile($file);
        }

        $files = glob('./lang/*/settings.php');
        foreach ($files as $file) {
            $lp->processSettingsFile($file);
        }

        return 0;
    }

    /**
     * Run the unit tests for this extension
     *
     * @param string $filter Optional filter string for phpunit
     * @param string[] $args Additional arguments to pass to phpunit (files)
     * @return int
     */
    protected function cmdTest($filter = '', $args = [])
    {
        $dir = fullpath(getcwd());
        [$base, $type] = $this->getTypedNameFromDir($dir);

        if ($this->colors->isEnabled()) {
            $colors = 'always';
        } else {
            $colors = 'never';
        }

        $bin = fullpath(__DIR__ . '/../../../_test/vendor/bin/phpunit');;
        if (!file_exists($bin)) {
            $this->error('Testing framework not found. Please run "composer install" in the _test/ directory first.');
            return 1;
        }

        $runArgs = [
            $bin,
            '--verbose',
            "--colors=$colors",
            '--configuration', fullpath(__DIR__ . '/../../../_test/phpunit.xml'),
            '--group', $type . '_' . $base,
        ];
        if ($filter) {
            $runArgs[] = '--filter';
            $runArgs[] = $filter;
        }

        $runArgs = array_merge($runArgs, $args);
        $cmd = join(' ', array_map('escapeshellarg', $runArgs));
        $this->info("Running $cmd");

        $result = 0;
        passthru($cmd, $result);
        return $result;
    }

    /**
     * @return int
     */
    protected function cmdCheck($files = [])
    {
        $dir = fullpath(getcwd());

        $args = [
            fullpath(__DIR__ . '/../../../_test/vendor/bin/phpcs'),
            '--standard=' . fullpath(__DIR__ . '/../../../_test/phpcs.xml'),
            ($this->colors->isEnabled()) ? '--colors' : '--no-colors',
            '--',
        ];

        if ($files) {
            $args = array_merge($args, $files);
        } else {
            $args[] = fullpath($dir);
        }

        $cmd = join(' ', array_map('escapeshellarg', $args));
        $this->info("Running $cmd");

        $result = 0;
        passthru($cmd, $result);
        return $result;
    }

    /**
     * @return int
     */
    protected function cmdFix($files = [])
    {
        $dir = fullpath(getcwd());

        // first run rector to refactor outdated code
        $args = [
            fullpath(__DIR__ . '/../../../_test/vendor/bin/rector'),
            ($this->colors->isEnabled()) ? '--ansi' : '--no-ansi',
            '--config=' . fullpath(__DIR__ . '/../../../_test/rector.php'),
            '--no-diffs',
            'process',
        ];

        if ($files) {
            $args = array_merge($args, $files);
        } else {
            $args[] = fullpath($dir);
        }

        $cmd = join(' ', array_map('escapeshellarg', $args));
        $this->info("Running $cmd");

        $result = 0;
        passthru($cmd, $result);
        if ($result !== 0) return $result;

        // now run phpcbf to clean up code style
        $args = [
            fullpath(__DIR__ . '/../../../_test/vendor/bin/phpcbf'),
            '--standard=' . fullpath(__DIR__ . '/../../../_test/phpcs.xml'),
            ($this->colors->isEnabled()) ? '--colors' : '--no-colors',
            '--',
        ];

        if ($files) {
            $args = array_merge($args, $files);
        } else {
            $args[] = fullpath($dir);
        }

        $cmd = join(' ', array_map('escapeshellarg', $args));
        $this->info("Running $cmd");

        $result = 0;
        passthru($cmd, $result);
        return $result;
    }

    //endregion
}