GettextShell::getPoName() - Code Metrics - Inspection of "Add phpstan/phpstan 1.5 + fix php workflow (#52)" - bedita/i18n - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( f35666...49b7e7 )

by Stefano
created 2022-03-28 16:22 UTC
GettextShell::getPoName() A

↳ Parent: GettextShell
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0
<?php
declare(strict_types=1);

/**
 * BEdita, API-first content management framework
 * Copyright 2019 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */

namespace BEdita\I18n\Shell;

use Cake\Console\ConsoleOptionParser;
use Cake\Console\Shell;
use Cake\Core\Configure;
use Cake\Filesystem\File;
use Cake\Filesystem\Folder;
use Cake\Utility\Hash;

/**
 * Gettext shell
 */
class GettextShell extends Shell
class GettextShell extends /** @scrutinizer ignore-deprecated */ Shell
{
    /**
     * Get the option parser for this shell.
     *
     * @return \Cake\Console\ConsoleOptionParser
     * @codeCoverageIgnore
     */
    public function getOptionParser(): ConsoleOptionParser
    {
        $parser = parent::getOptionParser();
        $parser->addSubcommand('update', [
            'help' => 'Update po and pot files',
            'parser' => [
                'description' => [
                    'Create or update i18n po/pot files',
                    '',
                    '`cake gettext update`: update files for current app',
                    '`cake gettext update -app <app path>`: update files for the app',
                    '`cake gettext update -plugin <plugin name>`: update files for the plugin',
                ],
                'options' => [
                    'app' => [
                        'help' => 'The app path, for i18n update.',
                        'short' => 'a',
                        'required' => false,
                    ],
                    'plugin' => [
                        'help' => 'The plugin name, for i18n update.',
                        'short' => 'p',
                        'required' => false,
                    ],
                ],
            ],
        ]);

        return $parser;
    }

    /**
     * The Po results
     *
     * @var array
     */
    protected $poResult = [];

    /**
     * The template paths
     *
     * @var array
     */
    protected $templatePaths = [];

    /**
     * The locale path
     *
     * @var string
     */
    protected $localePath = null;

    /**
     * PO file name
     *
     * @var string
     */
    protected $poName = 'default.po';

    /**
     * Get po result
     */
    public function getPoResult(): array
    {
        return $this->poResult;
    }

    /**
     * Get templatePaths
     */
    public function getTemplatePaths(): array
    {
        return $this->templatePaths;
    }

    /**
     * Get localePath
     */
    public function getLocalePath(): string
    {
        return $this->localePath;
    }

    /**
     * Get po name
     */
    public function getPoName(): string
    {
        return $this->poName;
    }

    /**
     * Update gettext po files
     *
     * @return void
     */
    public function update(): void
    {
        $resCmd = [];
        exec('which msgmerge 2>&1', $resCmd);
        if (empty($resCmd[0])) {
            $this->out('ERROR: msgmerge not available. Please install gettext utilities.');

            return;
        }

        $this->out('Updating .pot and .po files...');

        $this->setupPaths();
        foreach ($this->templatePaths as $path) {
            $this->out(sprintf('Search in: %s', $path));
            $this->parseDir($path);
        }

        $this->out('Creating master .pot file');
        $this->writeMasterPot();
        $this->ttagExtract();

        $this->hr();
        $this->out('Merging master .pot with current .po files');
        $this->hr();

        $this->writePoFiles();

        $this->out('Done');
    }

    /**
     * Setup template paths and locale path
     *
     * @return void
     */
    private function setupPaths(): void
    {
        $appTemplates = (array)Configure::read('App.paths.templates');
        if (isset($this->params['plugin'])) {
            $f = new Folder(sprintf('%s%s', (string)Configure::read('App.paths.plugins.0'), $this->params['plugin']));
            $f = /** @scrutinizer ignore-deprecated */ new Folder(sprintf('%s%s', (string)Configure::read('App.paths.plugins.0'), $this->params['plugin']));
            $basePath = $f->path;
            $this->poName = $this->params['plugin'] . '.po';
            $this->templatePaths = [$basePath . '/src', $basePath . '/config'];
            $appTemplatePath = (string)Hash::get($appTemplates, '1');
            if (strpos($appTemplatePath, $basePath . '/src') === false) {
                $this->templatePaths[] = $appTemplatePath;
            }
            $this->localePath = (string)Configure::read('App.paths.locales.1');

            return;
        }
        $app = $this->params['app'] ?? getcwd();
        $f = new Folder($app);
        $f = /** @scrutinizer ignore-deprecated */ new Folder($app);
        $basePath = $f->path;
        $this->templatePaths = [$basePath . '/src', $basePath . '/config'];
        $appTemplatePath = (string)Hash::get($appTemplates, '0');
        if (strpos($appTemplatePath, $basePath . '/src') === false) {
            $this->templatePaths[] = $appTemplatePath;
        }
        $this->localePath = (string)Configure::read('App.paths.locales.0');
    }

    /**
     * Write `master.pot` file
     *
     * @return void
     */
    private function writeMasterPot(): void
    {
        $potFilename = sprintf('%s/master.pot', $this->localePath);
        $this->out(sprintf('Writing new .pot file: %s', $potFilename));
        $pot = new File($potFilename, true);
        $pot = /** @scrutinizer ignore-deprecated */ new File($potFilename, true);
        $pot->write($this->header('pot'));
        sort($this->poResult);
        foreach ($this->poResult as $res) {
            if (!empty($res)) {
                $pot->write(sprintf('%smsgid "%s"%smsgstr ""%s', "\n", $res, "\n", "\n"));
            }
        }
        $pot->close();
    }

    /**
     * Write `.po` files
     *
     * @return void
     */
    private function writePoFiles(): void
    {
        $header = $this->header('po');
        $potFilename = sprintf('%s/master.pot', $this->localePath);
        $locales = array_keys((array)Configure::read('I18n.locales', []));
        foreach ($locales as $loc) {
            $potDir = $this->localePath . DS . $loc;
            if (!file_exists($potDir)) {
                mkdir($potDir);
            }
            $this->out(sprintf('Language: %s', $loc));
            $poFile = sprintf('%s/%s', $potDir, $this->poName);
            if (!file_exists($poFile)) {
                $newPoFile = new File($poFile, true);
                $newPoFile = /** @scrutinizer ignore-deprecated */ new File($poFile, true);
                $newPoFile->write($header);
                $newPoFile->close();
            }
            $this->out(sprintf('Merging %s', $poFile));
            $mergeCmd = sprintf('msgmerge --backup=off -N -U %s %s', $poFile, $potFilename);
            exec($mergeCmd);
            $this->analyzePoFile($poFile);
            $this->hr();
        }
    }

    /**
     * Header lines for po/pot file
     *
     * @param string $type The file type (can be 'po', 'pot')
     * @return string
     * @codeCoverageIgnore
     */
    private function header(string $type = 'po'): string
    {
        $result = sprintf('msgid ""%smsgstr ""%s', "\n", "\n");
        $contents = [
            'po' => [
                'Project-Id-Version' => 'BEdita 4',
                'POT-Creation-Date' => date('Y-m-d H:i:s'),
                'PO-Revision-Date' => '',
                'Last-Translator' => '',
                'Language-Team' => 'BEdita I18N & I10N Team',
                'Language' => '',
                'MIME-Version' => '1.0',
                'Content-Transfer-Encoding' => '8bit',
                'Plural-Forms' => 'nplurals=2; plural=(n != 1);',
                'Content-Type' => 'text/plain; charset=utf-8',
            ],
            'pot' => [
                'Project-Id-Version' => 'BEdita 4',
                'POT-Creation-Date' => date('Y-m-d H:i:s'),
                'MIME-Version' => '1.0',
                'Content-Transfer-Encoding' => '8bit',
                'Language-Team' => 'BEdita I18N & I10N Team',
                'Plural-Forms' => 'nplurals=2; plural=(n != 1);',
                'Content-Type' => 'text/plain; charset=utf-8',
            ],
        ];
        foreach ($contents[$type] as $k => $v) {
            $result .= sprintf('"%s: %s \n"', $k, $v) . "\n";
        }

        return $result;
    }

    /**
     * Analyze po file and translate it
     *
     * @param string $filename The po file name
     * @return void
     */
    private function analyzePoFile($filename): void
    {
        $lines = file($filename);
        $numItems = $numNotTranslated = 0;
        foreach ($lines as $k => $l) {
            if (strpos($l, 'msgid "') === 0) {
                $numItems++;
            }
            if (strpos($l, 'msgstr ""') === 0) {
                if (!isset($lines[$k + 1])) {
                    $numNotTranslated++;
                } elseif (strpos($lines[$k + 1], '"') !== 0) {
                    $numNotTranslated++;
                }
            }
        }
        $translated = $numItems - $numNotTranslated;
        $percent = 0;
        if ($numItems > 0) {
            $percent = number_format($translated * 100. / $numItems, 1);
        }
        $this->out(sprintf('Translated %d of %d items - %s %%', $translated, $numItems, $percent));
    }

    /**
     * "fix" string - strip slashes, escape and convert new lines to \n
     *
     * @param string $str The string
     * @return string The new string
     */
    private function fixString($str): string
    {
        $str = stripslashes($str);
        $str = str_replace('"', '\"', $str);
        $str = str_replace("\n", '\n', $str);
        $str = str_replace('|||||', "'", $str); // special sequence used in parseContent to temporarily replace "\'"

        return $str;
    }

    /**
     * Parse file and rips gettext strings
     *
     * @param string $file The file name
     * @param string $extension The file extension
     * @return void
     */
    private function parseFile($file, $extension)
    {
        if (!in_array($extension, ['php', 'twig'])) {
            return;
        }
        $content = file_get_contents($file);
        if (empty($content)) {
            return;
        }

        $functions = [
            '__' => 0, // __( string $singular , ... $args )
            '__n' => 0, // __n( string $singular , string $plural , integer $count , ... $args )
            '__d' => 1, // __d( string $domain , string $msg , ... $args )
            '__dn' => 1, // __dn( string $domain , string $singular , string $plural , integer $count , ... $args )
            '__x' => 1, // __x( string $context , string $singular , ... $args )
            '__xn' => 1, // __xn( string $context , string $singular , string $plural , integer $count , ... $args )
            '__dx' => 2, // __dx( string $domain , string $context , string $msg , ... $args )
            '__dxn' => 2, // __dxn( string $domain , string $context , string $singular , string $plural , integer $count , ... $args )
        ];

        // temporarily replace "\'" with "|||||", fixString will replace "|||||" with "\'"
        // this fixes wrongly matched data in the following regexp
        $content = str_replace("\'", '|||||', $content);

        $options = [
            'open_parenthesis' => preg_quote('('),
            'quote' => preg_quote("'"),
            'double_quote' => preg_quote('"'),
        ];

        foreach ($functions as $fname => $singularPosition) {
            if ($singularPosition === 0) {
                $this->parseContent($fname, $content, $options);
            } elseif ($singularPosition === 1) {
                $this->parseContentSecondArg($fname, $content, $options);
            } elseif ($singularPosition === 2) {
                $this->parseContentThirdArg($fname, $content, $options);
            }
        }
    }

    /**
     * Parse file content and put i18n data in poResult array
     *
     * @param string $start The starting string to search for, the name of the translation method
     * @param string $content The file content
     * @param array $options The options
     * @return void
     */
    private function parseContent($start, $content, $options): void
    {
        // phpcs:disable
        $rgxp = '/' .
            "${start}\s*{$options['open_parenthesis']}\s*{$options['double_quote']}" . "([^{$options['double_quote']}]*)" . "{$options['double_quote']}" .
            '|' .
            "${start}\s*{$options['open_parenthesis']}\s*{$options['quote']}" . "([^{$options['quote']}]*)" . "{$options['quote']}" .
            '/';
        // phpcs:enable
        $matches = [];
        preg_match_all($rgxp, $content, $matches);

        $limit = count($matches[0]);
        for ($i = 0; $i < $limit; $i++) {
            $item = $this->fixString($matches[1][$i]);
            if (empty($item)) {
                $item = $this->fixString($matches[2][$i]);
            }
            if (!in_array($item, $this->poResult)) {
                $this->poResult[] = $item;
            }
        }
    }

    /**
     * Parse file content and put i18n data in poResult array
     *
     * @param string $start The starting string to search for, the name of the translation method
     * @param string $content The file content
     * @param array $options The options
     * @return void
     */
    private function parseContentSecondArg($start, $content, $options): void
    {
        // phpcs:disable
        $rgxp =
            '/' . "${start}\s*{$options['open_parenthesis']}\s*{$options['double_quote']}" . '([^{)}]*)' . "{$options['double_quote']}" .
            '|' . "${start}\s*{$options['open_parenthesis']}\s*{$options['quote']}" . '([^{)}]*)' . "{$options['quote']}" .
            '/';
        // phpcs:enable
        $matches = [];
        preg_match_all($rgxp, $content, $matches);

        $limit = count($matches[0]);
        for ($i = 0; $i < $limit; $i++) {
            $str = $matches[2][$i];
            if (substr_count($matches[2][0], ',') === 1) {
                $str = substr(trim(substr($str, strpos($str, ',') + 1)), 1);
            } elseif (substr_count($matches[2][0], ',') === 2) {
                $str = trim(substr($str, strpos($str, ',') + 1));
                $str = trim(substr($str, 0, strpos($str, ',')));
                $str = substr($str, 1, -1);
            }
            $item = $this->fixString($str);
            if (!in_array($item, $this->poResult)) {
                $this->poResult[] = $item;
            }
        }
    }

    /**
     * Parse file content and put i18n data in poResult array
     *
     * @param string $start The starting string to search for, the name of the translation method
     * @param string $content The file content
     * @param array $options The options
     * @return void
     */
    private function parseContentThirdArg($start, $content, $options): void
    {
        // phpcs:disable
        $rgxp =
            '/' . "${start}\s*{$options['open_parenthesis']}\s*{$options['double_quote']}" . '([^{)}]*)' . "{$options['double_quote']}" .
            '|' . "${start}\s*{$options['open_parenthesis']}\s*{$options['quote']}" . '([^{)}]*)' . "{$options['quote']}" .
            '/';
        // phpcs:enable
        $matches = [];
        preg_match_all($rgxp, $content, $matches);

        $limit = count($matches[0]);
        for ($i = 0; $i < $limit; $i++) {
            $str = $matches[2][$i];
            $pos = $this->strposX($str, ',', 2);
            $str = trim(substr($str, $pos + 1));
            if (strpos($str, ',') > 0) {
                $str = substr($str, 1, strpos($str, ',') - 2);
            } else {
                $str = substr($str, 1);
            }
            $item = $this->fixString($str);
            if (!in_array($item, $this->poResult)) {
                $this->poResult[] = $item;
            }
        }
    }

    /**
     * Calculate nth ($number) position of $needle in $haystack.
     *
     * @param string $haystack The haystack where to search
     * @param string $needle The needle to search
     * @param int $number The nth position to retrieve
     * @return int|false
     */
    private function strposX($haystack, $needle, $number = 0)
    {
        return strpos(
            $haystack,
            $needle,
            $number > 1 ?
            $this->strposX($haystack, $needle, $number - 1) + strlen($needle) : 0
        );
    }

    /**
     * Parse a directory
     *
     * @param string $dir The directory
     * @return void
     */
    private function parseDir($dir): void
    {
        $folder = new Folder($dir);
        $folder = /** @scrutinizer ignore-deprecated */ new Folder($dir);
        $tree = $folder->tree($dir, false);
        foreach ($tree as $files) {
            foreach ($files as $file) {
                if (!is_dir($file)) {
                    $f = new File($file);
                    $f = /** @scrutinizer ignore-deprecated */ new File($file);
                    $info = $f->info();
                    if (isset($info['extension'])) {
                        $this->parseFile($file, $info['extension']);
                    }
                }
            }
        }
    }

    /**
     * Extract translations from javascript files using ttag, if available.
     *
     * @return void
     * @codeCoverageIgnore
     */
    private function ttagExtract(): void
    {
        // check ttag command exists
        $ttag = 'node_modules/ttag-cli/bin/ttag';
        if (!file_exists($ttag)) {
            $this->out(sprintf('Skip javascript parsing - %s command not found', $ttag));

            return;
        }
        // check template folder exists
        $appDir = 'src/Template';
        if (!empty($this->params['plugin'])) {
            $startPath = !empty($this->params['startPath']) ? $this->params['startPath'] : getcwd();
            $appDir = sprintf('%s/plugins/%s/src/Template', $startPath, $this->params['plugin']);
        }
        if (!file_exists($appDir)) {
            $this->out(sprintf('Skip javascript parsing - %s folder not found', $appDir));

            return;
        }

        // do extract translation strings from js files using ttag
        $this->out('Extracting translation string from javascript files using ttag');
        $masterJs = sprintf('%s/master-js.pot', $this->localePath);
        exec(sprintf('%s extract --o %s --l en %s', $ttag, $masterJs, $appDir));

        // merge master-js.pot and master.pot
        $master = sprintf('%s/master.pot', $this->localePath);
        exec(sprintf('msgcat --use-first %s %s -o %s', $master, $masterJs, $master));

        // remove master-js.pot
        unlink($masterJs);
    }
}

bedita / i18n

Push — master ( f35666...49b7e7 )

GettextShell::getPoName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
