translator\classes\PoFileManager

Complexity

Total Complexity

166

Size/Duplication

Total Lines	794
Duplicated Lines	9.07 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	setError()	0	5	2
A	getErrors()	0	3	1
A	setSaasUrl()	0	7	2
B	exchangeTranslation()	5	29	7
B	prepareDomain()	19	39	10
A	getDomainType()	0	11	3
A	getPoFileUrl()	0	20	5
F	prepareSettingsArray()	15	45	19
A	makePoFileSettings()	0	36	5
B	create()	0	23	7
A	getModules()	0	16	5
B	saas_update_one()	0	24	6
B	update()	0	37	11
F	prepareUpdateSettings()	3	81	22
A	save()	0	33	5
B	preparePoFileData()	0	18	9
B	makePoFileData()	0	33	9
A	convertToMO()	0	9	2
C	toArray()	14	69	17
C	prepareSettingsValues()	16	42	12
B	searchPoFileAutocomplete()	0	28	6

<?php

namespace translator\classes;

use Gettext\Translations;

class PoFileManager
{

    /**
     * Templates folder path
     * @var string
     */
    const TEMPLATES_PATH = './templates/';

    /**
     * Main lang folder path
     * @var string
     */
    const MAIN_PATH = './application/language/main/';

    /**
     * Errors holder array
     * @var array
     */
    private static $ERRORS = [];

    /**
     * Po-file settings array
     * @var array
     */
    private $po_settings = [];

    /**
     * Po-file settings keys
     * @var array
     */
    private $po_settings_keys = [
                                 'Project-Id-Version',
                                 'Last-Translator',
                                 'Language-Team',
                                 'Basepath',
                                 'X-Poedit-Language',
                                 'X-Poedit-Country',
                                 'SearchPath',
                                ];

    /**
     * @var string
     */
    private static $SAAS_URL = '';

    /**
     * @var array
     */
    private static $CURRENT_TEMPLATE_PATHS = [];

    /**
     * PoFileManager constructor.
     */
    public function __construct() {

    }

    /**
     * Set error message
     * @param string $error - error message
     */
    private function setError($error) {
        if ($error) {
            self::$ERRORS[] = $error;
        }
    }

    /**
     * Get errors
     * @return array
     */
    public function getErrors() {
        return self::$ERRORS;
    }

    /**
     * Set saas url
     * @param string $url - url value
     */
    public function setSaasUrl($url) {
        if ($url) {
            self::$SAAS_URL = $url;
        } else {
            self::$SAAS_URL = '';
        }
    }

    public function exchangeTranslation($data) {
        $langExchanger = $data['langExchanger'];
        $langReceiver = $data['langReceiver'];

        $typeExchanger = $data['typeExchanger'];
        $typeReceiver = $data['typeReceiver'];

        $modules_templatesExchanger = $data['modules_templatesExchanger'];
        $modules_templatesReceiver = $data['modules_templatesReceiver'];

        if ($langExchanger && $langReceiver && $typeExchanger && $typeReceiver) {
            $resultExchanger = $this->toArray($modules_templatesExchanger, $typeExchanger, $langExchanger);
            $exchangerPoArray = $resultExchanger['po_array'];

            $resultReceiver = $this->toArray($modules_templatesReceiver, $typeReceiver, $langReceiver);
            $receiverPoArray = $resultReceiver['po_array'];

            foreach ($exchangerPoArray as $origin => $value) {
                if ($receiverPoArray[$origin]) {
                    $receiverPoArray[$origin]['translation'] = $value['translation'];
                }
            }

            $receiverPoArray['po_array'] = $receiverPoArray;
            $receiverPoArray['settings'] = $this->prepareUpdateSettings($resultExchanger['settings']);
            return $this->save($modules_templatesReceiver, $typeReceiver, $langReceiver, $receiverPoArray);
        }
        return FALSE;
    }

    /**
     * Prepare correct domain name
     * @param string $domain - domain name
     * @return string
     */
    public function prepareDomain($domain) {
        $CI = &get_instance();
        $template = $CI->config->item('template');

        if ($template != 'administrator') {
            if (file_exists($this->getPoFileUrl($template, 'templates', CUR_LOCALE))) {
                if (!self::$CURRENT_TEMPLATE_PATHS) {
                    $po_array = $this->toArray($template, 'templates', CUR_LOCALE, FALSE);
                    self::$CURRENT_TEMPLATE_PATHS = $po_array['settings']['SearchPath'];
                }

                switch ($this->getDomainType($domain)) {
                    case 'modules':
                        $contains = array_filter(
                            self::$CURRENT_TEMPLATE_PATHS,
                            function ($path, $domain) {
                                return strstr($path, 'modules/' . $domain) ? TRUE : FALSE;
                            }
                        );

                        return (!empty($contains)) ? $template : $domain;
                    case 'main':
                        $contains = array_filter(
                            self::$CURRENT_TEMPLATE_PATHS,
                            function ($path) {
                                $main_path = 'system/language/form_validation';
                                return strstr($path, $main_path) ? TRUE : FALSE;
                            }
                        );

                        return (!empty($contains)) ? $template : $domain;
                    default :
                        return $domain;
                }
            }
        }

        return $domain;
    }

    /**
     * Get domain type name
     * @param string $domain - domain name
     * @return string
     */
    public function getDomainType($domain) {
        if (moduleExists($domain)) {
            return 'modules';
        }

        if (is_dir(self::TEMPLATES_PATH . $domain)) {
            return 'templates';
        }

        return 'main';
    }

    /**
     * Prepare po-file url
     * @param string $name - module or template name
     * @param string $type - type of po-file(modules, templates, main)
     * @param string $lang - language locale
     * @return string
     */
    public function getPoFileUrl($name, $type, $lang) {
        switch ($type) {
            case 'modules':
                $url = getModulePathForTranslator($name) . 'language/' . $lang . '/LC_MESSAGES/' . $name . '.po';
                break;
            case 'templates':
                $url = self::TEMPLATES_PATH . $name . '/language/' . $name . '/' . $lang . '/LC_MESSAGES/' . $name . '.po';
                break;
            case 'main':
                $url = self::MAIN_PATH . $lang . '/LC_MESSAGES/' . $type . '.po';
                break;
            default :
                $url = '';
        }

        if (self::$SAAS_URL) {
            $url = str_replace('./', self::$SAAS_URL . '/', $url);
        }
        return $url;
    }

    /**
     * Prepare settings array
     * @param array $data - settings array
     * @return string

Should the return type not be array?

     */
    private function prepareSettingsArray($data = []) {
        if (!isset($data['projectName']) || !$data['projectName']) {
            $data['projectName'] = '';
        }

        if (!isset($data['translatorName']) || !$data['translatorName']) {
            $data['translatorName'] = '';
        }

        if (!isset($data['translatorEmail']) || !$data['translatorEmail']) {
            $data['translatorEmail'] = '';
        } else {
            str_replace('<', '', $data['translatorEmail']);
            str_replace('>', '', $data['translatorEmail']);
        }

        if (!isset($data['langaugeTeamName']) || !$data['langaugeTeamName']) {
            $data['langaugeTeamName'] = '';
        }

        if (!isset($data['langaugeTeamEmail']) || !$data['langaugeTeamEmail']) {
            $data['langaugeTeamEmail'] = '';
        } else {
            str_replace('<', '', $data['langaugeTeamEmail']);
            str_replace('>', '', $data['langaugeTeamEmail']);
        }

        if (!isset($data['lang']) || !$data['lang']) {
            $data['lang'] = '';
        }

        if (!isset($data['basepath']) || !$data['basepath']) {
            $data['basepath'] = '';
        }

        if (!isset($data['language']) || !$data['language']) {
            $data['language'] = '';
        }

        if (!isset($data['country']) || !$data['country']) {
            $data['country'] = '';
        }

        return $data;
    }

    /**
     * Make po-file settings formated string
     * @param array $data - settings array
     * @return string|false
     */
    private function makePoFileSettings($data = []) {
        if (!empty($data)) {
            $data = $this->prepareSettingsArray($data);
            $settings = [
                         'msgid ""',
                         'msgstr ""',
                         '"Project-Id-Version: ' . $data['projectName'] . '\n"',
                         '"Report-Msgid-Bugs-To: \n"',
                         '"POT-Creation-Date: ' . date('Y-m-d h:iO', time()) . '\n"',
                         '"PO-Revision-Date: ' . date('Y-m-d h:iO', time()) . '\n"',
                         '"Last-Translator: ' . $data['translatorName'] . ' <' . $data['translatorEmail'] . '>\n"',
                         '"Language-Team: ' . $data['langaugeTeamName'] . ' <' . $data['langaugeTeamEmail'] . '>\n"',
                         '"Language: ' . $data['lang'] . '\n"',
                         '"MIME-Version: 1.0\n"',
                         '"Content-Type: text/plain; charset=UTF-8\n"',
                         '"Content-Transfer-Encoding: 8bit\n"',
                         '"X-Poedit-KeywordsList: _;gettext;gettext_noop;lang\n"',
                         '"X-Poedit-Basepath: ' . $data['basepath'] . '\n"',
                         '"X-Poedit-SourceCharset: utf-8\n"',
                         '"X-Generator: Poedit 1.5.7\n"',
                         '"X-Poedit-Language: ' . $data['language'] . '\n"',
                         '"X-Poedit-Country: ' . $data['country'] . '\n"',
                        ];

            if (isset($data['paths']) && count($data['paths']) > 0) {
                foreach ($data['paths'] as $number => $path) {
                    $settings[] = '"X-Poedit-SearchPath-' . $number . ': ' . $path . '\n"';
                }
            }

            return implode("\n", $settings);
        } else {
            self::$ERRORS[] = lang('Settings array is empty', 'translator');
            return FALSE;
        }
    }

    /**
     * Create po-file
     * @param string $name - module or template name
     * @param string $type - type of po-file(modules, templates, main)
     * @param string $lang - language locale
     * @param array $settings - settings array
     * @return boolean|null
     */
    public function create($name, $type, $lang, $settings) {
        if ($name && $type && $lang) {
            $url = $this->getPoFileUrl($name, $type, $lang);

            if (file_exists($url)) {
                $this->setError(lang('File is already exists.', 'translator'));
                return FALSE;
            }

            if (!@fopen($url, 'wb')) {
                $this->setError(lang('Can not create file. Check if path to the file is correct - ', 'translator') . $url);
                return FALSE;
            }

            $settings = $this->makePoFileSettings($settings);
            if (file_put_contents($url, b"\xEF\xBB\xBF" . $settings)) {
                return TRUE;
            } else {
                $this->setError(lang('Can not create file. Check if path to the file is correct - ', 'translator') . $url);
                return FALSE;
            }
        }
    }

    public function getModules() {
        $modules = getModulesPaths();
        $data = [];
        foreach ($modules as $moduleName => $modulePath) {
            if ($moduleName != 'admin' && $moduleName != 'shop') {
                $lang = new \MY_Lang();
                $lang->load($moduleName);

                include $modulePath . 'module_info.php';
                $name = isset($com_info['menu_name']) ? $com_info['menu_name'] : $moduleName;
                $data[$moduleName] = $name;
            }
        }

        return $data;
    }

    /**
     * @param string $name
     * @param string $type
     * @param string $lang
     * @param string $domain_path
     * @return bool
     */
    public function saas_update_one($name, $type, $lang, $domain_path) {
        $this->setSaasUrl('/var/www/saas_data/mainsaas');
        $saas_file = $this->toArray($name, $type, $lang);

        if (isset($saas_file['po_array'])) {
            $this->setSaasUrl($domain_path);
            $user_file = $this->toArray($name, $type, $lang);

            if ($user_file) {
                $updation = [];
                foreach ($saas_file['po_array'] as $origin => $value) {
                    if (!isset($user_file['po_array'][$origin])) {
                        $updation[$origin] = $value;
                    }
                }

                if ($updation) {
                    $this->update($name, $type, $lang, $updation);
                }
            }
            $this->setSaasUrl('');
        }
        return TRUE;
    }

    /**
     * @param string $name
     * @param string $type
     * @param string $lang
     * @param array $data
     * @return bool
     */
    public function update($name, $type, $lang, $data) {
        $po_data = $this->toArray($name, $type, $lang);

        if ($po_data && array_key_exists('po_array', $po_data)) {
            foreach ($data as $origin => $values) {

                if (isset($po_data['po_array'][$origin])) {

                    if ($values['translation']) {
                        $po_data['po_array'][$origin]['translation'] = $values['translation'];
                    }

                    if ($values['comment']) {
                        $po_data['po_array'][$origin]['comment'] = $values['comment'];
                    }
                } else {

                    if ($values['translation']) {
                        $po_data['po_array'][$origin] = [
                                                         'translation' => $values['translation'],
                                                         'comment'     => $values['comment'] ? $values['comment'] : '',
                                                         'links'       => $values['links'] ? $values['links'] : ['tmpLink'],
                                                         'fuzzy'       => FALSE,
                                                        ];
                    }
                }
            }

            if (isset($po_data['settings'])) {
                $data = $po_data['po_array'];
                $data['settings'] = $this->prepareUpdateSettings($po_data['settings']);

                return $this->save($name, $type, $lang, $data);
            }
        }
        return FALSE;
    }

    /**
     * @param array $data
     * @return mixed
     */
    public function prepareUpdateSettings($data) {
        if (!isset($data['Project-Id-Version']) || !$data['Project-Id-Version']) {
            $data['projectName'] = '';
        } else {
            $data['projectName'] = $data['Project-Id-Version'];
        }

        unset($data['Project-Id-Version']);

        if (!isset($data['Last-Translator-Name']) || !$data['Last-Translator-Name']) {
            $data['translatorName'] = '';
        } else {
            $data['translatorName'] = $data['Last-Translator-Name'];
        }

        unset($data['Last-Translator-Name']);

        if (!isset($data['Last-Translator-Email']) || !$data['Last-Translator-Email']) {
            $data['translatorEmail'] = '';
        } else {
            $data['translatorEmail'] = $data['Last-Translator-Email'];
        }

        unset($data['Last-Translator-Email']);

        if (!isset($data['Language-Team-Name']) || !$data['Language-Team-Name']) {
            $data['langaugeTeamName'] = '';
        } else {
            $data['langaugeTeamName'] = $data['Language-Team-Name'];
        }

        unset($data['Language-Team-Name']);

        if (!isset($data['Language-Team-Email']) || !$data['Language-Team-Email']) {
            $data['langaugeTeamEmail'] = '';
        } else {
            $data['langaugeTeamEmail'] = $data['Language-Team-Email'];
        }

        unset($data['Language-Team-Email']);

        if (!isset($data['lang']) || !$data['lang']) {
            $data['lang'] = '';
        }

        if (!isset($data['Basepath']) || !$data['Basepath']) {
            $data['basepath'] = '';
        } else {
            $data['basepath'] = $data['Basepath'];
        }

        unset($data['Basepath']);

        if (!isset($data['SearchPath']) || !$data['SearchPath']) {
            $data['paths'][] = '.';
        } else {
            foreach ($data['SearchPath'] as $path) {
                $data['paths'][] = $path;
            }
        }

        unset($data['SearchPath']);

        if (!isset($data['X-Poedit-Language']) || !$data['X-Poedit-Language']) {
            $data['language'] = '';
        } else {
            $data['language'] = $data['X-Poedit-Language'];
        }

        unset($data['X-Poedit-Language']);

        if (!isset($data['X-Poedit-Country']) || !$data['X-Poedit-Country']) {
            $data['country'] = '';
        } else {
            $data['country'] = $data['X-Poedit-Country'];
        }

        unset($data['X-Poedit-Country']);

        return $data;
    }

    /**
     * Save po-file from array
     * @param string $name - module or template name
     * @param string $type - type of po-file(modules, templates, main)
     * @param string $lang - language locale
     * @param array $data - po-file data
     * @return boolean
     */
    public function save($name, $type, $lang, $data) {
        ksort($data, SORT_STRING | SORT_FLAG_CASE);

        $url = $this->getPoFileUrl($name, $type, $lang);

        if (!$url) {
            $this->setError(lang('Wrong po-file path', 'translator'));
            return FALSE;
        }

        if (!FileOperator::getInstatce()->checkFile($url)) {
            $errors = FileOperator::getInstatce()->getErrors();
            $this->setError($errors['error']);
            return FALSE;
        }

        $settings = $this->makePoFileSettings((array) $data['settings']);
        unset($data['settings']);

        $po_file_data = $this->makePoFileData($data);
        $po_file_content = b"\xEF\xBB\xBF" . $settings . "\n\n" . $po_file_data;
        if (file_put_contents($url, $po_file_content)) {
            if ($this->convertToMO($url)) {
                return TRUE;
            } else {
                $this->setError(lang('Operation failed. Can not convert to mo-file.', 'translator'));
                return FALSE;
            }
        } else {
            $this->setError(lang('Can not save po-file.', 'translator'));
            return FALSE;
        }
    }

    /**
     * Prepare correct po-file data
     * @param array $data
     * @return string

Should the return type not be array?

     */
    private function preparePoFileData($data) {
        if (!isset($data['comment']) || !$data['comment']) {
            $data['comment'] = '';
        }

        if (!isset($data['links']) || !$data['links']) {
            $data['links'] = '';
        }

        if (!isset($data['fuzzy']) || !$data['fuzzy']) {
            $data['fuzzy'] = '';
        }

        if (!isset($data['translation']) || !$data['translation']) {
            $data['translation'] = '';
        }
        return $data;
    }

    /**
     * Make po-file data
     * @param array $data - po-file data
     * @return string
     */
    private function makePoFileData($data = []) {
        $resultData = [];
        foreach ($data as $key => $po) {
            if ($po) {
                $po = $this->preparePoFileData((array) $po);

                if ($po['comment']) {
                    $resultData[] = '# ' . $po['comment'];
                }

                if ($po['links']) {
                    foreach ($po['links'] as $link) {
                        $resultData[] = '#: ' . $link;
                    }
                }

                if ($po['fuzzy']) {
                    $resultData[] = '#, fuzzy';
                }

                if ($key) {
                    $resultData[] = 'msgid "' . $key . '"';
                }

                if ($po['translation']) {
                    $resultData[] = 'msgstr "' . $po['translation'] . '"' . "\n";
                } else {
                    $resultData[] = 'msgstr ""' . "\n";
                }
            }
        }
        return implode("\n", $resultData);
    }

    /**
     * Convert po-file to mo-file
     * @param string $url - url to file
     * @return boolean|null
     */
    public function convertToMO($url = '') {
        if ($url) {
            $translations = Translations::fromPoFile($url);

            array_map('unlink', glob(str_replace('.po', '_*.mo', $url)));

            return $translations->toMoFile(str_replace('.po', '_' . time() . '.mo', $url));
        }
    }

    /**
     * @param string $name
     * @param string $type
     * @param string $lang
     * @param bool $langOn
     * @return array|bool

Consider making the return type a bit more specific; maybe use false|array<string,array>.

     */
    public function toArray($name, $type, $lang, $langOn = TRUE) {
        $path = $this->getPoFileUrl($name, $type, $lang);

        if (!FileOperator::getInstatce()->checkFile($path, $langOn)) {
            $error = FileOperator::getInstatce()->getErrors();
            $this->setError($error['error']);
            return FALSE;
        } else {
            $po = file($path);
        }

        $origin = null;
        $this->po_settings = [];

        foreach ($po as $key => $line) {
            if (!($key > 2 && $origin)) {
                $this->prepareSettingsValues($line);
            }

            $first2symbols = substr($line, 0, 2);
            if (substr($line, 0, 1) == '#' && $first2symbols != '#:' && $first2symbols != '#,') {
                $comment = trim(substr($line, 2, -1));
                continue;
            }
            if ($first2symbols == '#,') {
                $fuzzy = TRUE;
                continue;
            }

            if ($first2symbols == '#:') {
                $links[] = trim(substr($line, 2, -1));

$links was never initialized. Although not strictly required by PHP, it is generally a good practice to add $links = array(); before regardless.

                continue;
            }

            if (substr($line, 0, 5) == 'msgid') {
                if (preg_match('/"(.*?)"$/', trim($line), $matches)) {
                    $origin = $matches[1];
                    if (!strlen($origin)) {
                        $origin = 0;
                    }
                }

                continue;
            }

            if (substr($line, 0, 6) == 'msgstr') {
                if ($origin) {
                    preg_match('/"(.*?)"$/', trim($line), $translation);
                    $translations[$origin] = [

$translations was never initialized. Although not strictly required by PHP, it is generally a good practice to add $translations = array(); before regardless.

                                              'translation' => isset($translation[1]) ? $translation[1] : '',
                                              'comment'     => $comment,
                                              'links'       => $links,
                                              'fuzzy'       => $fuzzy,
                                             ];
                }
                $fuzzy = FALSE;
                $comment = '';
                unset($links);
            }
        }

        $translations = $translations ?: [];
        $result = [
                   'settings' => $this->po_settings,
                   'po_array' => $translations,
                  ];

        return $result;
    }

    /**
     * @param string $line
     * @return array
     */
    private function prepareSettingsValues($line) {
        foreach ($this->po_settings_keys as $key) {
            if (preg_match('/' . $key . '/', $line)) {
                $from = strpos($line, ':');

                if (substr($line, -5, -4) == '\\') {
                    $value = substr($line, $from + 2, -5);
                } else {
                    $value = substr($line, $from + 2, -4);
                }

                switch ($key) {
                    case 'SearchPath':
                        $this->po_settings['SearchPath'][] = $value;
                        break 2;
                    case 'Last-Translator':
                        $value = explode(' ', $value);
                        $this->po_settings['Last-Translator-Name'] = isset($value[0]) ? $value[0] : '';
                        $value[1] = isset($value[1]) ? $value[1] : '';
                        $value[1] = str_replace('<', '', $value[1]);
                        $value[1] = str_replace('>', '', $value[1]);
                        $this->po_settings['Last-Translator-Email'] = $value[1];
                        break 2;
                    case 'Language-Team':
                        $value = explode(' ', $value);
                        $this->po_settings['Language-Team-Name'] = isset($value[0]) ? $value[0] : '';
                        $value[1] = isset($value[1]) ? $value[1] : '';
                        $value[1] = str_replace('<', '', $value[1]);
                        $value[1] = str_replace('>', '', $value[1]);
                        $this->po_settings['Language-Team-Email'] = $value[1];
                        break 2;
                    case 'Basepath':
                        $this->po_settings['Basepath'] = $value;
                        break 2;
                    default :
                        $this->po_settings[$key] = $value;
                        break 2;
                }
            }
        }
        return $this->po_settings;
    }

    /**
     * @param string $name
     * @param string $type
     * @param string $lang
     * @param string $searchString
     * @return array
     */
    public function searchPoFileAutocomplete($name, $type, $lang, $searchString) {
        $poFile = $this->toArray($name, $type, $lang);
        $poFileData = $poFile['po_array'];
        $searchString = mb_strtolower(trim($searchString));

        $results = [];
        foreach ($poFileData as $origin => $data) {
            $translation = $data['translation'];

            $positionSearch = mb_stripos($origin, $searchString);
            if ($positionSearch !== false) {
                $results[$positionSearch][] = $origin;
            }

            $positionSearch = mb_stripos($translation, $searchString);
            if ($positionSearch !== false) {
                $results[$positionSearch][] = $translation;
            }

        }
        ksort($results);
        $resultsData = [];
        foreach ($results as $result) {
            natcasesort($result);
            $resultsData = array_merge($resultsData, $result);
        }
        return $resultsData ?: [];
    }

}