From 47c4c4765490ad3a71436b9d052376f2fea0f391 Mon Sep 17 00:00:00 2001 From: Jean-Christian Denis Date: Tue, 9 Nov 2021 23:58:45 +0100 Subject: [PATCH] change settings mecanic, fix backup_limit, fix phpstan errors on dcTranslater --- _admin.php | 32 ++-- _config.php | 5 +- _install.php | 5 +- _prepend.php | 9 +- inc/class.dc.translater.module.php | 2 +- inc/class.dc.translater.php | 256 ++++++++++------------------- 6 files changed, 112 insertions(+), 197 deletions(-) diff --git a/_admin.php b/_admin.php index 3aa095b..31e59df 100644 --- a/_admin.php +++ b/_admin.php @@ -31,18 +31,19 @@ $_menu['Plugins']->addItem( class translaterAdminBehaviors { - /** @var dcTranlsater dcTranslater instance */ + /** @var dcTranslater dcTranslater instance */ private static $translater = null; /** * Create instance of dcTranslater once * - * @param dCore $core dcCore instance - * @return dctranslater dcTranslater instance + * @param dcCore $core dcCore instance + * + * @return dcTranslater dcTranslater instance */ - private static function translater($core) + private static function translater(dcCore $core): dcTranslater { - if (!(self::$translater instanceof dcTranslater)) { + if (!is_a(self::$translater, 'dcTranslater')) { self::$translater = new dcTranslater($core, false); } @@ -52,21 +53,22 @@ class translaterAdminBehaviors /** * Add button to go to module translation * - * @param object $list adminModulesList instance - * @param string $id Module id - * @param arrray $prop Module properties - * @return string HTML submit button + * @param adminModulesList $list adminModulesList instance + * @param string $id Module id + * @param array $prop Module properties + * + * @return string HTML submit button */ public static function adminModulesGetActions(adminModulesList $list, string $id, array $prop): ?string { if ($list->getList() != $prop['type'] . '-activate' - || !self::translater($list->core)->getSetting($prop['type'] . '_menu') + || !self::translater($list->core)->{$prop['type'] . '_menu'} || !$list->core->auth->isSuperAdmin() ) { return null; } - if (self::translater($list->core)->getSetting('hide_default') - && in_array($id, dctranslater::$default_distrib_modules[$prop['type']]) + if (self::translater($list->core)->hide_default + && in_array($id, dcTranslater::$default_distrib_modules[$prop['type']]) ) { return null; } @@ -84,10 +86,10 @@ class translaterAdminBehaviors * @param array $modules Selected modules ids * @param string $type List type (plugin|theme) */ - public static function adminModulesDoActions(adminModulesList $list, array $modules, string $type) + public static function adminModulesDoActions(adminModulesList $list, array $modules, string $type): void { if (empty($_POST['translater']) || !is_array($_POST['translater'])) { - return null; + return; } $list->core->adminurl->redirect( @@ -103,7 +105,7 @@ class translaterAdminBehaviors * @param dcCore $core dcCore instance * @param dcFavorites $favs dcFavorites instance */ - public static function adminDashboardFavorites(dcCore $core, dcFavorites$favs) + public static function adminDashboardFavorites(dcCore $core, dcFavorites$favs): void { $favs->register('translater', [ 'title' => __('Translater'), diff --git a/_config.php b/_config.php index b3b5fdb..b074eeb 100644 --- a/_config.php +++ b/_config.php @@ -18,9 +18,10 @@ $translater = new dcTranslater($core); if (!empty($_POST['save'])) { try { - foreach ($translater->getDefaultSettings() as $k => $v) { - $translater->setSetting($k, ($_POST[$k] ?? '')); + foreach ($translater->getDefaultSettings() as $key => $value) { + $translater->$key = $_POST[$key] ?? ''; } + $translater->writeSettings(); dcPage::addSuccessNotice( __('Configuration successfully updated.') ); diff --git a/_install.php b/_install.php index fe81932..a897a6b 100644 --- a/_install.php +++ b/_install.php @@ -20,10 +20,7 @@ try { return null; } $translater = new dcTranslater($core, false); - $settings = $translater->getDefaultSettings(); - foreach ($settings as $key => $setting) { - $translater->setSetting($key, $setting['value'], false); - } + $translater->writeSettings(false); $core->setVersion($id, $core->plugins->moduleInfo($id, 'version')); return true; diff --git a/_prepend.php b/_prepend.php index 5b96c01..9f41f5a 100644 --- a/_prepend.php +++ b/_prepend.php @@ -16,10 +16,11 @@ if (!defined('DC_RC_PATH')) { $d = dirname(__FILE__) . '/inc/'; -$__autoload['dcTranslater'] = $d . 'class.dc.translater.php'; -$__autoload['dcTranslaterModule'] = $d . 'class.dc.translater.module.php'; -$__autoload['dcTranslaterLang'] = $d . 'class.dc.translater.lang.php'; -$__autoload['translaterRest'] = $d . 'class.translater.rest.php'; +$__autoload['dcTranslater'] = $d . 'class.dc.translater.php'; +$__autoload['dcTranslaterDefaultSettings'] = $d . 'class.dc.translater.php'; +$__autoload['dcTranslaterModule'] = $d . 'class.dc.translater.module.php'; +$__autoload['dcTranslaterLang'] = $d . 'class.dc.translater.lang.php'; +$__autoload['translaterRest'] = $d . 'class.translater.rest.php'; if (isset($core->adminurl)) { $core->adminurl->register('translater', 'plugin.php', ['p' => 'translater']); diff --git a/inc/class.dc.translater.module.php b/inc/class.dc.translater.module.php index 6bc5cf8..f52393b 100644 --- a/inc/class.dc.translater.module.php +++ b/inc/class.dc.translater.module.php @@ -195,7 +195,7 @@ class dcTranslaterModule } if (!empty($res)) { - dcTranslater::isBackupLimit($backup, $this->translater->backup_limit, true); + dcTranslater::isBackupLimit($this->prop['id'] , $backup, $this->translater->backup_limit, true); @set_time_limit(300); $fp = fopen($backup . '/l10n-' . $this->prop['id'] . '-' . $lang . '-' . time() . '.bck.zip', 'wb'); diff --git a/inc/class.dc.translater.php b/inc/class.dc.translater.php index f4f2fc8..cc90dfc 100644 --- a/inc/class.dc.translater.php +++ b/inc/class.dc.translater.php @@ -14,120 +14,62 @@ if (!defined('DC_CONTEXT_ADMIN')) { return; } +class dcTranslaterDefaultSettings +{ + /** @var boolean Show tranlsater button on plugins list */ + public $plugin_menu = false; + /** @var boolean Show tranlsater button on themes list */ + public $theme_menu = false; + /** @var boolean Create language backup on save */ + public $backup_auto = false; + /** @var integer Backups number limit */ + public $backup_limit = 20; + /** @var string Backup main folder */ + public $backup_folder = 'module'; + /** @var string Default ui start page */ + public $start_page = '-'; + /** @var boolean Write .lang.php file (deprecated) */ + public $write_langphp = false; + /** @var boolean SCan also template files for translations */ + public $scan_tpl = true; + /** @var boolean Disable translation of know dotclear strings */ + public $parse_nodc = true; + /** @var boolean Hide official modules */ + public $hide_default = true; + /** @var boolean Add comment to translations files */ + public $parse_comment = false; + /** @var boolean Parse user info to translations files */ + public $parse_user = false; + /** @var string User infos to parse */ + public $parse_userinfo = 'displayname, email'; + /** @var boolean Overwrite existing languages on import */ + public $import_overwrite = false; + /** @var string Filename of exported lang */ + public $export_filename = 'type-module-l10n-timestamp'; + /** @var string Default service for external proposal tool */ + public $proposal_tool = 'google'; + /** @var string Default lang for external proposal tool */ + public $proposal_lang = 'en'; + + /** + * get default settings + * + * @return array Settings key/value pair + */ + public static function getDefaultSettings() + { + return get_class_vars('dcTranslaterDefaultSettings'); + } +} + /** * Translater tools. */ -class dcTranslater +class dcTranslater extends dcTranslaterDefaultSettings { - /** @var dCore dcCore instance */ + /** @var dcCore dcCore instance */ public $core; - /** @var array $default_settings Plugins default settings */ - private static $default_settings = [ - 'plugin_menu' => [ - 'id' => 'translater_plugin_menu', - 'value' => 0, - 'type' => 'boolean', - 'label' => 'Put an link in plugins page' - ], - 'theme_menu' => [ - 'id' => 'translater_theme_menu', - 'value' => 0, - 'type' => 'boolean', - 'label' => 'Put a link in themes page' - ], - 'backup_auto' => [ - 'id' => 'translater_backup_auto', - 'value' => 1, - 'type' => 'boolean', - 'label' => 'Make a backup of languages old files when there are modified' - ], - 'backup_limit' => [ - 'id' => 'translater_backup_limit', - 'value' => 20, - 'type' => 'string', - 'label' => 'Maximum backups per module' - ], - 'backup_folder' => [ - 'id' => 'translater_backup_folder', - 'value' => 'module', - 'type' => 'string', - 'label' => 'In which folder to store backups' - ], - 'start_page' => [ - 'id' => 'translater_start_page', - 'value' => '-', - 'type' => 'string', - 'label' => 'Page to start on' - ], - 'write_langphp' => [ - 'id' => 'translater_write_langphp', - 'value' => 0, - 'type' => 'boolean', - 'label' => 'Write .lang.php languages files' - ], - 'scan_tpl' => [ - 'id' => 'translater_scan_tpl', - 'value' => 1, - 'type' => 'boolean', - 'label' => 'Translate strings of templates files' - ], - 'parse_nodc' => [ - 'id' => 'translater_parse_nodc', - 'value' => 1, - 'type' => 'boolean', - 'label' => 'Translate only untranslated strings of Dotclear', - ], - 'hide_default' => [ - 'id' => 'translater_hide_default', - 'value' => 1, - 'type' => 'boolean', - 'label' => 'Hide default modules of Dotclear', - ], - 'parse_comment' => [ - 'id' => 'translater_parse_comment', - 'value' => 0, - 'type' => 'boolean', - 'label' => 'Write comments and strings informations in lang files' - ], - 'parse_user' => [ - 'id' => 'translater_parse_user', - 'value' => 0, - 'type' => 'boolean', - 'label' => 'Write inforamtions about author in lang files' - ], - 'parse_userinfo' => [ - 'id' => 'translater_parse_userinfo', - 'value' => 'displayname, email', - 'type' => 'string', - 'label' => 'Type of informations about user to write' - ], - 'import_overwrite' => [ - 'id' => 'translater_import_overwrite', - 'value' => 0, - 'type' => 'boolean', - 'label' => 'Overwrite existing languages when import packages' - ], - 'export_filename' => [ - 'id' => 'translater_export_filename', - 'value' => 'type-module-l10n-timestamp', - 'type' => 'string', - 'label' => 'Name of files of exported package' - ], - 'proposal_tool' => [ - 'id' => 'translater_proposal_tool', - 'value' => 'google', - 'type' => 'string', - 'label' => 'Id of default tool for proposed translation' - ], - 'proposal_lang' => [ - 'id' => 'translater_proposal_lang', - 'value' => 'en', - 'type' => 'string', - 'label' => 'Default source language for proposed translation' - ] - ]; - /** @var array $allowed_backup_folders List of allowed backup folder */ public static $allowed_backup_folders = []; @@ -151,13 +93,15 @@ class dcTranslater * translater instance * * @param dcCore $core dcCore instance - * @param boolean $core Also load modules + * @param boolean $full Also load modules */ public function __construct(dcCore $core, bool $full = true) { $this->core = $core; $core->blog->settings->addNamespace('translater'); + $this->loadSettings(); + if ($full) { $this->loadModules(); } @@ -178,61 +122,31 @@ class dcTranslater /// @name settings methods //@{ /** - * Get array of default settings - * - * @return array All default settings + * Load settings from db */ - public function getDefaultSettings(): array + public function loadSettings(): void { - return self::$default_settings; - } + foreach ($this->getDefaultSettings() as $key => $value) { + $this->$key = $this->core->blog->settings->translater->get('translater_' . $key); - /** - * Get a setting according to default settings list - * - * @param string $id The settings short id - * @return mixed The setting value if exists or null - */ - public function getSetting(string $id) - { - return array_key_exists($id, self::$default_settings) ? - $this->core->blog->settings->translater->get(self::$default_settings[$id]['id']) : ''; - } - - /** - * Magic getSetting - */ - public function __get($id) - { - return $this->getSetting($id); - } - - /** - * Set a setting according to default settings list - * - * @param string $id The setting short id - * @param mixed $value The setting value - * @param mixed $overwrite Overwrite settings if exists - * @return boolean Success - */ - public function setSetting(string $id, $value, $overwrite = true): bool - { - if (!array_key_exists($id, self::$default_settings)) { - return false; + try { + settype($this->$key, gettype($value)); + } catch (Exception $e) { + } } - $s = self::$default_settings[$id]; - $this->core->blog->settings->translater->drop($s['id']); - $this->core->blog->settings->translater->put($s['id'], $value, $s['type'], $s['label'], $overwrite, true); - - return true; } /** - * Magic setSetting + * Write settings to db + * + * @param boolean $overwrite Overwrite existing settings */ - public function __set($id, $value) + public function writeSettings($overwrite = true): void { - return $this->setSetting($id, $value); + foreach ($this->getDefaultSettings() as $key => $value) { + $this->core->blog->settings->translater->drop('translater_' . $key); + $this->core->blog->settings->translater->put('translater_' . $key, $this->$key, gettype($value), '', true, true); + } } //@} @@ -241,7 +155,7 @@ class dcTranslater /** * Load array of modules infos by type of modules */ - private function loadModules() + private function loadModules(): void { $this->modules['theme'] = $this->modules['plugin'] = []; @@ -268,6 +182,7 @@ class dcTranslater * Return array of modules infos by type of modules * * @param string $type The modules type + * * @return array The list of modules infos */ public function getModules(string $type = ''): array @@ -280,9 +195,10 @@ class dcTranslater /** * Return module class of a particular module for a given type of module * - * @param string $type The module type - * @param string $id The module id - * @return dcTranslaterModule The dcTranslaterModule instance + * @param string $type The module type + * @param string $id The module id + * + * @return dcTranslaterModule The dcTranslaterModule instance */ public function getModule(string $type, string $id) { @@ -290,8 +206,6 @@ class dcTranslater throw new Exception( sprintf(__('Failed to find module %s'), $id) ); - - return false; } return $this->modules[$type][$id]; @@ -300,9 +214,10 @@ class dcTranslater /** * Return module class of a particular module for a given type of module * - * @param string $module dcTranslaterModule instance - * @param string $lang The lang iso code - * @return dcTranslaterLang dcTranslaterLang instance or false + * @param dcTranslaterModule $module dcTranslaterModule instance + * @param string $lang The lang iso code + * + * @return dcTranslaterLang dcTranslaterLang instance or false */ public function getLang(dcTranslaterModule $module, string $lang) { @@ -310,8 +225,6 @@ class dcTranslater throw new Exception( sprintf(__('Failed find language %s'), $lang) ); - - return false; } return new dcTranslaterLang($module, $lang); @@ -330,8 +243,8 @@ class dcTranslater */ public static function scandir(string $path, string $dir = '', array $res = []): array { - $path = path::real($path, false); - if (!is_dir($path) || !is_readable($path)) { + $path = (string) path::real($path, false); + if (empty($path) || !is_dir($path) || !is_readable($path)) { return []; } @@ -409,12 +322,13 @@ class dcTranslater /** * Check limit number of backup for a module * + * @param string $id The module id * @param string $root The backups root - * @param string $limit The backups limit + * @param integer $limit The backups limit * @param boolean $throw Silently failed * @return boolean True if limit is riched */ - public static function isBackupLimit(string $root, int $limit = 10, bool $throw = false): bool + public static function isBackupLimit(string $id, string $root, int $limit = 10, bool $throw = false): bool { $count = 0; foreach (self::scandir($root) as $file) { @@ -429,7 +343,7 @@ class dcTranslater if ($count >= $limit) { if ($throw) { throw new Exception( - sprintf(__('Limit of %s backups for module %s exceed'), $this->backup_limit, $id) + sprintf(__('Limit of %s backups for module %s exceed'), $limit, $id) ); }