ReleaseCleaner.php

Go to the documentation of this file.

<?php
 
namespace Elgg\I18n;
 
use Elgg\Database\Plugins;
use Elgg\Includer;
use Elgg\Project\Paths;
 
class ReleaseCleaner {
 
    private $codes;
 
    public $log = [];
 
    public function __construct(array $codes = []) {
        if (empty($codes)) {
            $codes = _elgg_services()->locale->getLanguageCodes();
        }
        
        $this->codes = $codes;
    }
 
    public function cleanInstallation(string $dir): void {
        $dir = Paths::sanitize($dir, false);
        
        if (is_dir("{$dir}/install/languages")) {
            $this->cleanLanguagesDir("{$dir}/install/languages");
        }
 
        if (is_dir("{$dir}/languages")) {
            $this->cleanLanguagesDir("{$dir}/languages");
        }
 
        $mods = new \DirectoryIterator("{$dir}/mod");
 
        foreach ($mods as $mod) {
            if ($mod->isDot() || !$mod->isDir()) {
                continue;
            }
 
            if (!in_array($mod->getFilename(), Plugins::BUNDLED_PLUGINS)) {
                // not a core plugin
                continue;
            }
            
            if (is_dir("{$mod->getPathname()}/languages")) {
                // only process plugins which have translations
                $this->cleanLanguagesDir("{$mod->getPathname()}/languages");
            }
        }
    }
 
    public function cleanLanguagesDir(string $dir): void {
        $dir = Paths::sanitize($dir, false);
 
        $files = new \DirectoryIterator($dir);
        foreach ($files as $file) {
            if ($file->isDot() || !$file->isFile()) {
                continue;
            }
 
            if ($file->getExtension() !== 'php') {
                continue;
            }
 
            $code = $file->getBasename('.php');
            if (!in_array($code, $this->codes)) {
                $code = $this->normalizeLanguageCode($code);
 
                if (in_array($code, $this->codes)) {
                    // rename file to lowercase
                    rename($file->getPathname(), "{$dir}/{$code}.php");
                    $this->log[] = "Renamed {$file->getPathname()} to {$code}.php";
                } else {
                    unlink($file->getPathname());
                    $this->log[] = "Removed {$file->getPathname()}";
                }
            }
            
            if ($code !== 'en' && file_exists("{$dir}/{$code}.php")) {
//              $this->detectAdditionalKeys($dir, $code);
//              $this->detectIdenticalTranslations($dir, $code);
                $this->cleanupMissingTranslationParameters($dir, $code);
                $this->cleanupEmptyTranslations("{$dir}/{$code}.php");
                $this->cleanupTranslationsThreshold($dir, $code);
            }
        }
    }
    
    protected function cleanupMissingTranslationParameters(string $directory, string $language_code): void {
        $english = Includer::includeFile("{$directory}/en.php");
        $translation = Includer::includeFile("{$directory}/{$language_code}.php");
        
        foreach ($english as $key => $value) {
            $english_matches = preg_match_all('/%[a-zA-Z]/m', $value);
            if (!array_key_exists($key, $translation) || $english_matches === false) {
                continue;
            }
            
            $translation_matches = preg_match_all('/%[a-zA-Z]/m', $translation[$key]);
            if ($translation_matches !== false && $english_matches === $translation_matches) {
                continue;
            }
            
            $file_contents = file_get_contents("{$directory}/{$language_code}.php");
            
            $pattern = '/^\s*[\'"]' . $key . '[\'"] => [\'"]' . preg_quote($translation[$key], '/') . '[\'"],{0,1}\R/m';
            $count = 0;
            $file_contents = preg_replace($pattern, '', $file_contents, -1, $count);
            if ($count < 1) {
                // try to add slashes for quotes
                $pattern = '/^\s*[\'"]' . $key . '[\'"] => [\'"]' . preg_quote(addslashes($translation[$key]), '/') . '[\'"],{0,1}\R/m';
                $count = 0;
                $file_contents = preg_replace($pattern, '', $file_contents, -1, $count);
            }
            
            if ($count > 0) {
                file_put_contents("{$directory}/{$language_code}.php", $file_contents);
            } else {
                $this->log[] = "Unable to repair mismatch in translation argument count in {$directory}/{$language_code}.php for the key '{$key}'";
            }
        }
    }
    
    protected function cleanupEmptyTranslations(string $translation_file): void {
        $contents = file_get_contents($translation_file);
        if (empty($contents)) {
            return;
        }
        
        $pattern = '/^\s*[\'"].*[\'"] => [\'"]{2},{0,1}\R/m';
        $count = 0;
        $contents = preg_replace($pattern, '', $contents, -1, $count);
        
        if ($count > 0) {
            // something was changed
            file_put_contents($translation_file, $contents);
            
            $translations = Includer::includeFile($translation_file);
            if (!empty($translations)) {
                $this->log[] = "Cleaned empty translations from {$translation_file}";
            } else {
                unlink($translation_file);
                
                $this->log[] = "Removed empty translation file {$translation_file}";
            }
        }
    }
    
    protected function cleanupTranslationsThreshold(string $directory, string $language_code, int $min_percentage = 50): void {
        if (!file_exists("{$directory}/{$language_code}.php")) {
            // can happen if cleanupEmptyTranslations() removed the file
            return;
        }
        
        $english = Includer::includeFile("{$directory}/en.php");
        $translation = Includer::includeFile("{$directory}/{$language_code}.php");
        
        if (empty($translation)) {
            unlink("{$directory}/{$language_code}.php");
            
            $this->log[] = "Removed empty translation file {$directory}/{$language_code}.php";
            return;
        }
        
        $trans_percentage = (count($translation) / count($english)) * 100;
        if ($trans_percentage < $min_percentage) {
            unlink("{$directory}/{$language_code}.php");
            $trans_percentage = round($trans_percentage, 2);
            
            $this->log[] = "Removed translation file {$directory}/{$language_code}.php below minimal threshold ({$trans_percentage} < {$min_percentage})";
        }
    }
    
    protected function normalizeLanguageCode(string $code): string {
        $code = strtolower($code);
        return preg_replace('~[^a-z0-9]~', '_', $code);
    }
    
    protected function detectAdditionalKeys(string $directory, string $language_code): void {
        $english = Includer::includeFile("{$directory}/en.php");
        $translation = Includer::includeFile("{$directory}/{$language_code}.php");
        
        foreach ($translation as $key => $value) {
            if (array_key_exists($key, $english)) {
                continue;
            }
            
            $this->log[] = "The translation key '{$key}' exists in the '{$language_code}' translation but not in English";
        }
    }
    
    protected function detectIdenticalTranslations(string $directory, string $language_code): void {
        $english = Includer::includeFile("{$directory}/en.php");
        $translation = Includer::includeFile("{$directory}/{$language_code}.php");
        
        foreach ($translation as $key => $value) {
            if (!array_key_exists($key, $english)) {
                // shouldn't happen
                continue;
            }
            
            if (strlen($key) < 3) {
                // probably a language code
                continue;
            }
            
            if ($english[$key] !== $value) {
                continue;
            }
            
            $this->log[] = "The translation key '{$key}' in the '{$language_code}' translation is identical to the English translation";
        }
    }
}