├── docs ├── exampleform.png ├── uitranslate.png └── translationform.png ├── styles.css ├── lib.php ├── version.php ├── classes ├── privacy │ └── provider.php ├── output │ ├── renderer.php │ └── translate.php ├── local │ ├── controller.php │ └── lib.php ├── external │ ├── delete.php │ └── translate.php └── forms │ └── filters.php ├── db ├── access.php ├── services.php └── install.xml ├── settings.php ├── lang └── en │ └── local_uitranslate.php ├── templates └── translate.mustache ├── amd ├── build │ ├── manage.min.js │ └── manage.min.js.map └── src │ └── manage.js ├── translate.php ├── README.md ├── .github └── workflows │ └── gha.yml └── LICENSE /docs/exampleform.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/davidherney/moodle-local_uitranslate/main/docs/exampleform.png -------------------------------------------------------------------------------- /docs/uitranslate.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/davidherney/moodle-local_uitranslate/main/docs/uitranslate.png -------------------------------------------------------------------------------- /docs/translationform.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/davidherney/moodle-local_uitranslate/main/docs/translationform.png -------------------------------------------------------------------------------- /styles.css: -------------------------------------------------------------------------------- 1 | #local_uitranslate-translate-container > .container-fluid { 2 | max-width: 1024px; 3 | margin: auto; 4 | } 5 | 6 | #local_uitranslate-translate-container .heading { 7 | font-weight: bold; 8 | } 9 | 10 | #local_uitranslate-translate-container .heading > div, 11 | #local_uitranslate-translate-container .item > div { 12 | border-bottom: 1px solid #eee; 13 | padding: 8px 0; 14 | } 15 | 16 | #local_uitranslate-translate-container .item textarea { 17 | width: 90%; 18 | } 19 | 20 | #local_uitranslate-translate-container .item textarea.translated { 21 | background-color: var(--teal); 22 | } 23 | 24 | #local_uitranslate-translate-container .item .icon { 25 | margin: 0; 26 | } 27 | -------------------------------------------------------------------------------- /lib.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Callback implementations for UI translate 19 | * 20 | * @package local_uitranslate 21 | * @copyright 2025 David Herney @ BambuCo 22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 | */ 24 | -------------------------------------------------------------------------------- /version.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Version information for UI translate 19 | * 20 | * @package local_uitranslate 21 | * @copyright 2025 David Herney @ BambuCo 22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 | */ 24 | 25 | defined('MOODLE_INTERNAL') || die(); 26 | 27 | $plugin->component = 'local_uitranslate'; 28 | $plugin->release = '1.0'; 29 | $plugin->version = 2025082900.02; 30 | $plugin->requires = 2024100700; 31 | $plugin->supported = [405, 500]; 32 | $plugin->maturity = MATURITY_ALPHA; 33 | -------------------------------------------------------------------------------- /classes/privacy/provider.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | namespace local_uitranslate\privacy; 18 | 19 | use core_privacy\local\metadata\null_provider; 20 | 21 | /** 22 | * Privacy Subsystem for local_uitranslate implementing null_provider. 23 | * 24 | * @package local_uitranslate 25 | * @copyright 2025 David Herney @ BambuCo 26 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 27 | */ 28 | class provider implements null_provider { 29 | 30 | /** 31 | * Get the language string identifier with the component's language 32 | * file to explain why this plugin stores no data. 33 | * 34 | * @return string 35 | */ 36 | public static function get_reason(): string { 37 | return 'privacy:metadata'; 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /classes/output/renderer.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | namespace local_uitranslate\output; 18 | 19 | use plugin_renderer_base; 20 | 21 | /** 22 | * Renderer for UI translate 23 | * 24 | * @package local_uitranslate 25 | * @copyright 2025 David Herney @ BambuCo 26 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 27 | */ 28 | class renderer extends plugin_renderer_base { 29 | 30 | /** 31 | * Return the template content for the translation page. 32 | * 33 | * @param translate $translate The translate renderable 34 | * @return string HTML string 35 | */ 36 | public function render_contents(translate $translate): string { 37 | return $this->render_from_template('local_uitranslate/translate', $translate->export_for_template($this)); 38 | } 39 | 40 | } 41 | -------------------------------------------------------------------------------- /classes/local/controller.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | namespace local_uitranslate\local; 18 | 19 | /** 20 | * Class controller 21 | * 22 | * @package local_uitranslate 23 | * @copyright 2025 David Herney @ BambuCo 24 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 25 | */ 26 | class controller { 27 | 28 | /** 29 | * Get a list of all used plugins. 30 | * 31 | * @return array 32 | */ 33 | public static function get_used_plugins(): array { 34 | global $DB; 35 | 36 | $sql = "SELECT DISTINCT plugin FROM {local_uitranslate_uses}"; 37 | $list = $DB->get_records_sql($sql); 38 | 39 | $plugins = []; 40 | foreach ($list as $item) { 41 | $plugins[$item->plugin] = get_string('pluginname', $item->plugin); 42 | } 43 | return $plugins; 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /db/access.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Capability definitions for UI translate 19 | * 20 | * Documentation: {@link https://moodledev.io/docs/apis/subsystems/access} 21 | * 22 | * @package local_uitranslate 23 | * @category access 24 | * @copyright 2025 David Herney @ BambuCo 25 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 26 | */ 27 | 28 | defined('MOODLE_INTERNAL') || die(); 29 | 30 | $capabilities = [ 31 | 'local/uitranslate:translate' => [ 32 | 'captype' => 'write', 33 | 'contextlevel' => CONTEXT_SYSTEM, 34 | 'archetypes' => [ 35 | 'user' => CAP_ALLOW, 36 | ], 37 | ], 38 | 39 | 'local/uitranslate:translateall' => [ 40 | 'captype' => 'write', 41 | 'contextlevel' => CONTEXT_SYSTEM, 42 | 'archetypes' => [ 43 | 'manager' => CAP_ALLOW, 44 | ], 45 | ], 46 | ]; 47 | -------------------------------------------------------------------------------- /db/services.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * External functions and service declaration for UI translate 19 | * 20 | * Documentation: {@link https://moodledev.io/docs/apis/subsystems/external/description} 21 | * 22 | * @package local_uitranslate 23 | * @category webservice 24 | * @copyright 2025 David Herney @ BambuCo 25 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 26 | */ 27 | 28 | defined('MOODLE_INTERNAL') || die(); 29 | 30 | $functions = [ 31 | 'local_uitranslate_translate' => [ 32 | 'classname' => 'local_uitranslate\external\translate', 33 | 'description' => 'Translate a string', 34 | 'type' => 'write', 35 | 'capabilities' => 'local/uitranslate:translate', 36 | 'ajax' => true, 37 | ], 38 | 39 | 'local_uitranslate_delete' => [ 40 | 'classname' => 'local_uitranslate\external\delete', 41 | 'description' => 'Delete a translation', 42 | 'type' => 'write', 43 | 'capabilities' => 'local/uitranslate:translate', 44 | 'ajax' => true, 45 | ], 46 | ]; 47 | -------------------------------------------------------------------------------- /settings.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Plugin settings 19 | * 20 | * @package local_uitranslate 21 | * @copyright 2025 David Herney @ BambuCo 22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 | */ 24 | 25 | use core\lang_string; 26 | 27 | defined('MOODLE_INTERNAL') || die; 28 | 29 | if ($hassiteconfig) { 30 | 31 | $settings = new admin_settingpage('local_uitranslate_settings', 32 | new lang_string('pluginname', 'local_uitranslate') 33 | ); 34 | $ADMIN->add('localplugins', $settings); 35 | $settings->add(new admin_setting_configcheckbox('local_uitranslate/harvestmode', 36 | new lang_string('harvestmode', 'local_uitranslate'), 37 | new lang_string('harvestmode_desc', 'local_uitranslate'), 38 | 0, PARAM_INT)); 39 | 40 | $settings = new admin_externalpage('local_uitranslate', 41 | new lang_string('pluginname', 'local_uitranslate'), 42 | new moodle_url('/local/uitranslate/translate.php') 43 | ); 44 | $ADMIN->add('language', $settings); 45 | } 46 | -------------------------------------------------------------------------------- /classes/output/translate.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | namespace local_uitranslate\output; 18 | 19 | use renderable; 20 | use renderer_base; 21 | use templatable; 22 | 23 | /** 24 | * Class translate 25 | * 26 | * @package local_uitranslate 27 | * @copyright 2025 David Herney @ BambuCo 28 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 29 | */ 30 | class translate implements renderable, templatable { 31 | 32 | /** 33 | * Data with records to translate. 34 | * 35 | * @var array 36 | */ 37 | private $_data; 38 | 39 | /** 40 | * Constructor. 41 | * 42 | * @param array $data Data with records to translate. 43 | */ 44 | public function __construct(array $data) { 45 | $this->_data = $data; 46 | } 47 | 48 | /** 49 | * Return the template context for the translation page. 50 | * 51 | * @param renderer_base $output 52 | * @return array 53 | */ 54 | public function export_for_template(renderer_base $output): array { 55 | 56 | return [ 57 | 'haslimit' => count($this->_data) >= 100, 58 | 'items' => array_values($this->_data), 59 | 'sesskey' => sesskey(), 60 | ]; 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /db/install.xml: -------------------------------------------------------------------------------- 1 | 2 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 |
25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 |
40 | 41 | 42 | -------------------------------------------------------------------------------- /lang/en/local_uitranslate.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * English language pack for UI translate 19 | * 20 | * @package local_uitranslate 21 | * @category string 22 | * @copyright 2025 David Herney @ BambuCo 23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | defined('MOODLE_INTERNAL') || die(); 27 | 28 | $string['errordeletetranslation'] = 'Error deleting translation'; 29 | $string['errortranslation'] = 'Error saving translation'; 30 | $string['harvestmode'] = 'Harvest mode'; 31 | $string['harvestmode_desc'] = 'If enabled, every time a new string is detected, it will be saved in the database automatically. 32 | The new strings are not associated with the original plugin, but with the local_uitranslate. 33 | This feature can be very heavy on the database, so be careful.'; 34 | $string['haslimit'] = 'Only the first 100 records are shown. Please use the filters to narrow down your search.'; 35 | $string['keyword'] = 'Keyword'; 36 | $string['lang1equallang2'] = 'Source and target languages must be different.'; 37 | $string['language_source'] = 'Source'; 38 | $string['language_target'] = 'Target'; 39 | $string['notranslationsfound'] = 'No translations found.'; 40 | $string['pluginname'] = 'UI translate'; 41 | $string['privacy:metadata'] = 'The UI translate plugin doesn\'t store any personal data.'; 42 | $string['select_plugin'] = 'All plugins'; 43 | $string['translate_warning'] = 'Deleting a translation deletes the main string, not just the translation itself. Perform this operation only if you know the string is no longer used in the system.'; 44 | $string['translationsfound'] = 'Translations found: {$a}'; 45 | $string['uitranslate:translate'] = 'Translate own strings'; 46 | $string['uitranslate:translateall'] = 'Translate all strings'; 47 | $string['untranslated'] = 'Only untranslated strings'; 48 | -------------------------------------------------------------------------------- /classes/external/delete.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | namespace local_uitranslate\external; 18 | 19 | use core_external\external_function_parameters; 20 | use core_external\external_single_structure; 21 | use core_external\external_value; 22 | 23 | /** 24 | * Class delete 25 | * 26 | * @package local_uitranslate 27 | * @copyright 2025 David Herney @ BambuCo 28 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 29 | */ 30 | class delete extends \core_external\external_api { 31 | 32 | /** 33 | * Define the parameters for the execute function. 34 | * 35 | * @return external_function_parameters 36 | */ 37 | public static function execute_parameters(): external_function_parameters { 38 | return new external_function_parameters([ 39 | 'hash' => new external_value(PARAM_TEXT, 'The string hash'), 40 | ]); 41 | } 42 | 43 | /** 44 | * Execute the translation. 45 | * 46 | * @param string $hash The string hash. 47 | * @return bool 48 | */ 49 | public static function execute(string $hash): bool { 50 | // Validate all of the parameters. 51 | [ 52 | 'hash' => $hash, 53 | ] = self::validate_parameters(self::execute_parameters(), [ 54 | 'hash' => $hash, 55 | ]); 56 | 57 | // Perform security checks. 58 | $context = \context_system::instance(); 59 | self::validate_context($context); 60 | require_capability('local/uitranslate:translate', $context); 61 | 62 | return \local_uitranslate\local\lib::delete($hash); 63 | 64 | } 65 | 66 | /** 67 | * Returns the result structure for the execute function. 68 | * 69 | * @return external_value 70 | */ 71 | public static function execute_returns(): external_value { 72 | return new external_value(PARAM_BOOL, 'Indicates if the operation was successful'); 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /templates/translate.mustache: -------------------------------------------------------------------------------- 1 | {{! 2 | This file is part of Moodle - http://moodle.org/ 3 | 4 | Moodle is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | Moodle is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with Moodle. If not, see . 16 | }} 17 | {{! 18 | @template local_uitranslate/translate 19 | 20 | Template for translating UI strings. 21 | 22 | Example context (json): 23 | { 24 | "items": [ 25 | { 26 | "textsource": "Hello", 27 | "control": "title", 28 | "texttarget": "Hola" 29 | } 30 | ] 31 | } 32 | }} 33 | 34 | {{#haslimit}} 35 |

{{#str}}haslimit, local_uitranslate{{/str}}

36 | {{/haslimit}} 37 |
38 |
39 | {{#str}}translate_warning, local_uitranslate{{/str}} 40 |
41 |
42 |
43 |
{{#str}}language_source, local_uitranslate{{/str}}
44 |
{{#str}}language_target, local_uitranslate{{/str}}
45 |
46 |
47 | {{#items}} 48 |
49 |
{{valuesource}}
50 |
51 | 52 |
53 |
54 | 55 | 56 |
57 |
58 | {{/items}} 59 |
60 |
-------------------------------------------------------------------------------- /amd/build/manage.min.js: -------------------------------------------------------------------------------- 1 | define("local_uitranslate/manage",["exports","jquery","core/ajax","core/notification","core/str","core/log"],(function(_exports,_jquery,_ajax,_notification,_str,_log){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} 2 | /** 3 | * TODO describe module manage 4 | * 5 | * @module local_uitranslate/manage 6 | * @copyright 2025 David Herney @ BambuCo 7 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 8 | */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_jquery=_interopRequireDefault(_jquery),_ajax=_interopRequireDefault(_ajax),_notification=_interopRequireDefault(_notification),_log=_interopRequireDefault(_log);var targetlang="",strings=[{key:"errortranslation",component:"local_uitranslate"},{key:"errordeletetranslation",component:"local_uitranslate"}],s=[];_exports.init=()=>{strings.forEach((one=>{s[one.key]=one.key})),(0,_str.get_strings)(strings).then((function(results){var pos=0;return strings.forEach((one=>{s[one.key]=results[pos],pos++})),!0})).fail((function(e){_log.default.debug("Error loading strings"),_log.default.debug(e)})),targetlang=(0,_jquery.default)("#id_lang2").val(),(0,_jquery.default)('.translate-operations [data-action="save"]').on("click",(function(){const $this=(0,_jquery.default)(this),$translatecontrol=$this.closest(".item").find("textarea"),data={hash:$this.data("hash"),value:$translatecontrol.val(),lang:targetlang};_ajax.default.call([{methodname:"local_uitranslate_translate",args:data,done:function(response){response?($this.prop("disabled",!0),$translatecontrol.addClass("translated")):_notification.default.alert({title:"",message:response.error||s.errortranslation})},fail:function(response){_notification.default.exception(response),_log.default.debug("Error saving translation"),_log.default.debug(response)}}])})),(0,_jquery.default)('.translate-operations [data-action="delete"]').on("click",(function(){const $this=(0,_jquery.default)(this),data={hash:$this.data("hash")};_ajax.default.call([{methodname:"local_uitranslate_delete",args:data,done:function(response){response?$this.closest(".item").remove():_notification.default.alert({title:"",message:response.error||s.errordeletetranslation})},fail:function(response){_notification.default.exception(response),_log.default.debug("Error deleting translation"),_log.default.debug(response)}}])})),(0,_jquery.default)("#local_uitranslate-translate-container textarea").on("change keyup paste",(function(){const $this=(0,_jquery.default)(this);$this.closest(".item").find('.translate-operations [data-action="save"]').prop("disabled",!$this.val().trim()),(0,_jquery.default)(this).removeClass("translated")}))}})); 9 | 10 | //# sourceMappingURL=manage.min.js.map -------------------------------------------------------------------------------- /classes/forms/filters.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | namespace local_uitranslate\forms; 18 | defined('MOODLE_INTERNAL') || die(); 19 | require_once($CFG->libdir.'/formslib.php'); 20 | 21 | use moodleform; 22 | 23 | /** 24 | * The filters form 25 | * 26 | * @package local_uitranslate 27 | * @copyright 2025 David Herney @ BambuCo 28 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 29 | */ 30 | class filters extends moodleform { 31 | 32 | /** 33 | * Form definition. 34 | */ 35 | public function definition() { 36 | 37 | $mform = $this->_form; 38 | 39 | $usedplugins = \local_uitranslate\local\controller::get_used_plugins(); 40 | $plugins = ['' => get_string('select_plugin', 'local_uitranslate')] + $usedplugins; 41 | $mform->addElement('select', 'plugin', get_string('plugin'), $plugins); 42 | 43 | $langs = get_string_manager()->get_list_of_translations(); 44 | 45 | $mform->addElement('select', 'lang1', get_string('language_source', 'local_uitranslate'), $langs); 46 | 47 | $mform->addElement('select', 'lang2', get_string('language_target', 'local_uitranslate'), $langs); 48 | 49 | $mform->addElement('text', 'keyword', get_string('keyword', 'local_uitranslate')); 50 | $mform->setType('keyword', PARAM_TEXT); 51 | 52 | $mform->addElement('checkbox', 'untranslated', get_string('untranslated', 'local_uitranslate'), 0); 53 | 54 | $this->add_action_buttons(false); 55 | 56 | } 57 | 58 | /** 59 | * Form validation. 60 | * 61 | * @param array $data The form data 62 | * @param array $files The uploaded files 63 | * @return array An array of validation errors 64 | */ 65 | public function validation($data, $files) { 66 | $errors = parent::validation($data, $files); 67 | 68 | if (empty($data['lang1'])) { 69 | $errors['lang1'] = get_string('required'); 70 | } 71 | 72 | if (empty($data['lang2'])) { 73 | $errors['lang2'] = get_string('required'); 74 | } 75 | 76 | if ($data['lang1'] === $data['lang2']) { 77 | $errors['lang2'] = get_string('lang1equallang2', 'local_uitranslate'); 78 | } 79 | 80 | return $errors; 81 | } 82 | 83 | } 84 | -------------------------------------------------------------------------------- /classes/external/translate.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | namespace local_uitranslate\external; 18 | 19 | use core_external\external_function_parameters; 20 | use core_external\external_single_structure; 21 | use core_external\external_value; 22 | 23 | /** 24 | * Class translate 25 | * 26 | * @package local_uitranslate 27 | * @copyright 2025 David Herney @ BambuCo 28 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 29 | */ 30 | class translate extends \core_external\external_api { 31 | 32 | /** 33 | * Define the parameters for the execute function. 34 | * 35 | * @return external_function_parameters 36 | */ 37 | public static function execute_parameters(): external_function_parameters { 38 | return new external_function_parameters([ 39 | 'hash' => new external_value(PARAM_TEXT, 'The string hash'), 40 | 'value' => new external_value(PARAM_TEXT, 'The string translation'), 41 | 'lang' => new external_value(PARAM_TEXT, 'The target language', VALUE_DEFAULT, ''), 42 | ]); 43 | } 44 | 45 | /** 46 | * Execute the translation. 47 | * 48 | * @param string $hash The string hash. 49 | * @param string $value The string translation. 50 | * @param string|null $lang (optional) The target language. 51 | * @return bool 52 | */ 53 | public static function execute(string $hash, string $value, ?string $lang = ''): bool { 54 | // Validate all of the parameters. 55 | [ 56 | 'hash' => $hash, 57 | 'value' => $value, 58 | 'lang' => $lang, 59 | ] = self::validate_parameters(self::execute_parameters(), [ 60 | 'hash' => $hash, 61 | 'value' => $value, 62 | 'lang' => $lang, 63 | ]); 64 | 65 | // Perform security checks. 66 | $context = \context_system::instance(); 67 | self::validate_context($context); 68 | require_capability('local/uitranslate:translate', $context); 69 | 70 | return \local_uitranslate\local\lib::translate($hash, $value, $lang); 71 | 72 | } 73 | 74 | /** 75 | * Returns the result structure for the execute function. 76 | * 77 | * @return external_value 78 | */ 79 | public static function execute_returns(): external_value { 80 | return new external_value(PARAM_BOOL, 'Indicates if the translation was successful'); 81 | } 82 | } 83 | -------------------------------------------------------------------------------- /translate.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * TODO describe file translate 19 | * 20 | * @package local_uitranslate 21 | * @copyright 2025 David Herney @ BambuCo 22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 | */ 24 | 25 | require('../../config.php'); 26 | 27 | require_login(); 28 | 29 | $systemcontext = context_system::instance(); 30 | require_capability('local/uitranslate:translate', $systemcontext); 31 | 32 | $url = new moodle_url('/local/uitranslate/translate.php', []); 33 | $PAGE->set_url($url); 34 | $PAGE->set_context($systemcontext); 35 | $PAGE->set_heading($SITE->fullname); 36 | 37 | $filterform = new \local_uitranslate\forms\filters(null, []); 38 | $records = null; 39 | 40 | if ($data = $filterform->get_data()) { 41 | $params = [ 42 | 'type' => \local_uitranslate\local\lib::TYPE_ORIGINAL, 43 | ]; 44 | $where = ''; 45 | 46 | $joinuses = ''; 47 | if ($data->plugin) { 48 | $params['plugin'] = trim($data->plugin); 49 | $where .= " AND us.plugin = :plugin "; 50 | $joinuses = 'INNER JOIN {local_uitranslate_uses} us ON s1.hash = us.hash'; 51 | } 52 | 53 | $params['lang1'] = $data->lang1; 54 | $params['lang2'] = $data->lang2; 55 | 56 | $keyword = trim($data->keyword); 57 | 58 | if (!empty($keyword)) { 59 | $params['keyword1'] = "%$keyword%"; 60 | $params['keyword2'] = "%$keyword%"; 61 | $where .= " AND (" . $DB->sql_like('s1.value', ':keyword1') . " OR " . $DB->sql_like('s2.value', ':keyword2') . ") "; 62 | } 63 | 64 | if (!has_capability('local/uitranslate:translateall', $systemcontext)) { 65 | $where .= " AND s1.userid = :owner "; 66 | $params['owner'] = $USER->id; 67 | } 68 | 69 | $untranslated = !empty($data->untranslated); 70 | if ($untranslated) { 71 | $where .= " AND s2.id IS NULL "; 72 | } 73 | 74 | $sql = "SELECT s1.id, s2.id AS targetid, s1.hash, s1.value AS valuesource, COALESCE(s2.value, '') AS valuetarget 75 | FROM {local_uitranslate_strings} s1 76 | $joinuses 77 | LEFT JOIN {local_uitranslate_strings} s2 ON s1.hash = s2.hash AND s1.lang <> s2.lang 78 | WHERE s1.type = :type AND s1.lang = :lang1 AND (s2.lang = :lang2 || s2.lang IS NULL) $where 79 | ORDER BY s1.value"; 80 | 81 | // For now, only up to 100 records are returned while pagination is being implemented. 82 | $records = $DB->get_records_sql($sql, $params, 0, 100); 83 | 84 | } 85 | 86 | echo $OUTPUT->header(); 87 | 88 | $filterform->display(); 89 | 90 | if ($records !== null) { 91 | if (count($records) > 0) { 92 | echo $OUTPUT->heading(get_string('translationsfound', 'local_uitranslate', count($records))); 93 | 94 | $renderable = new \local_uitranslate\output\translate($records); 95 | $renderer = $PAGE->get_renderer('local_uitranslate'); 96 | echo $renderer->render($renderable); 97 | 98 | $PAGE->requires->js_call_amd('local_uitranslate/manage', 'init'); 99 | } else { 100 | echo $OUTPUT->heading(get_string('notranslationsfound', 'local_uitranslate')); 101 | } 102 | } 103 | 104 | echo $OUTPUT->footer(); 105 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # LOCAL UI translate 2 | 3 | Plugin created to assist in translating the user interface from the code of other plugins. 4 | 5 | Package tested in: moodle 4.5+. 6 | 7 | ## QUICK INSTALL 8 | Download zip package, extract the uitranslate folder and upload this folder into local/. 9 | 10 | ## ABOUT 11 | * **Developed by:** David Herney - david dot herney at gmail dot com 12 | * **GIT:** https://github.com/davidherney/moodle-local_uitranslate 13 | * **Powered by:** [BambuCo](https://bambuco.co) 14 | 15 | ## Use 16 | 17 | From code, send strings entered by users in forms or alternative inputs. The user or a higher-level role can then translate 18 | them to adapt the interface to the used language. 19 | 20 | *The same translation can be used in multiple components.* 21 | 22 | First, include the library: 23 | ```php 24 | use local_uitranslate\local\lib as uitrans; 25 | ``` 26 | 27 | Then use one of the methods to send the user strings: 28 | ```php 29 | uitrans::set(string $plugin, string $string, ?string $control = '', ?int $itemid = null, ?string $lang = ''); 30 | ``` 31 | Or 32 | ```php 33 | uitrans::setbulk(string $plugin, array $strings, ?int $itemid = null, ?string $lang = ''); 34 | ``` 35 | 36 | For example: 37 | 38 | A single string can be sent: 39 | ```php 40 | uitrans::set('block_kamaleon', 'Hellow world', 'title', 123); 41 | ``` 42 | 43 | Or you can send several at once: 44 | ```php 45 | uitrans::setbulk('block_kamaleon', [ 46 | 'shorttitle' => 'Example', 47 | 'title' => 'Code test in the block', 48 | 'linkname' => 'More...' 49 | ], 123); 50 | ``` 51 | 52 | When a string is no longer used, it can be removed with: 53 | ```php 54 | uitrans::(string $plugin, string $string, ?string $control = '', ?int $itemid = null); 55 | ``` 56 | This method doesn't remove the string immediately, but it does remove its specified usage, so it can then be deleted if it's 57 | not used in another control. 58 | 59 | For example, after updating a record, you can remove the changed strings and save the new ones: 60 | ```php 61 | $DB->update_record('block_kamaleon_contents', $content); 62 | 63 | foreach (['shorttitle', 'title', 'linkname'] as $field) { 64 | if ($oldcontent->$field !== $data->$field) { 65 | uitrans::unset('block_kamaleon', $oldcontent->$field, $field, $content->id); 66 | uitrans::set('block_kamaleon', $data->$field, $field, $content->id); 67 | } 68 | } 69 | ``` 70 | 71 | Translations are managed at: 72 | 73 | ``` 74 | https://MYMOODLE/local/uitranslate/translate.php 75 | ``` 76 | 77 | Or 78 | 79 | ``` 80 | Site administration > Language settings > UI translate 81 | ``` 82 | 83 | To use translated strings, use the 'get' method, passing the original string entered by the user: 84 | ```php 85 | uitrans::get(string $string, ?string $lang = ''); 86 | ``` 87 | 88 | For example: 89 | ```php 90 | $shorttitle = uitrans::get($contentdata->shorttitle); 91 | ``` 92 | 93 | ### Applied to a real-life case (_block_kamaleon_), it would look like this: 94 | 95 | #### The information entry form: 96 | ![UI Form](docs/exampleform.png) 97 | 98 | #### The string translation: 99 | ![Translation](docs/translationform.png) 100 | 101 | #### The interface in two different languages ​​after translation: 102 | ![Result](docs/uitranslate.png) 103 | 104 | 105 | ### Notes: 106 | - Harvest mode can be enabled so that queried strings that do not exist are stored in the database. This is useful for loading strings created prior to using this component; however, it would be best to create a task to load the strings with all the required information. 107 | - By default, it is not required to specify the language; the language of the current session will be used. 108 | 109 | ### Pending: 110 | - A task needs to be created to clean up strings when they are no longer used. 111 | - The cache needs to be improved. 112 | - Add a translation page to the user menu. 113 | - Paginate the translation page. 114 | - Create a CLI to bulk load strings for components that are already active. 115 | - Allow exporting/importing translations. 116 | - Connect with Google Translator or other platforms for automatic translation. 117 | 118 | 119 | ## IN VERSION 120 | 121 | ### 2025082900: 122 | First release: proof of concept. 123 | 124 | ## License 125 | GNU/GPL 126 | -------------------------------------------------------------------------------- /.github/workflows/gha.yml: -------------------------------------------------------------------------------- 1 | name: Moodle Plugin CI 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | test: 7 | runs-on: ubuntu-22.04 8 | 9 | services: 10 | postgres: 11 | image: postgres:15 12 | env: 13 | POSTGRES_USER: 'postgres' 14 | POSTGRES_HOST_AUTH_METHOD: 'trust' 15 | ports: 16 | - 5432:5432 17 | options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3 18 | 19 | mariadb: 20 | image: mariadb:10 21 | env: 22 | MYSQL_USER: 'root' 23 | MYSQL_ALLOW_EMPTY_PASSWORD: "true" 24 | MYSQL_CHARACTER_SET_SERVER: "utf8mb4" 25 | MYSQL_COLLATION_SERVER: "utf8mb4_unicode_ci" 26 | ports: 27 | - 3306:3306 28 | options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3 29 | 30 | strategy: 31 | fail-fast: false 32 | matrix: 33 | include: 34 | - php: '8.3' 35 | # Main job. Run all checks that do not require setup and only need to be run once. 36 | runchecks: 'all' 37 | moodle-branch: 'MOODLE_405_STABLE' 38 | database: 'pgsql' 39 | - php: '8.1' 40 | moodle-branch: 'MOODLE_405_STABLE' 41 | database: 'mariadb' 42 | - php: '8.4' 43 | moodle-branch: 'MOODLE_500_STABLE' 44 | database: 'mariadb' 45 | - php: '8.2' 46 | moodle-branch: 'MOODLE_500_STABLE' 47 | database: 'pgsql' 48 | 49 | steps: 50 | - name: Check out repository code 51 | uses: actions/checkout@v4 52 | with: 53 | path: plugin 54 | 55 | - name: Setup PHP ${{ matrix.php }} 56 | uses: shivammathur/setup-php@v2 57 | with: 58 | php-version: ${{ matrix.php }} 59 | extensions: ${{ matrix.extensions }} 60 | ini-values: max_input_vars=5000 61 | # If you are not using code coverage, keep "none". Otherwise, use "pcov" (Moodle 3.10 and up) or "xdebug". 62 | # If you try to use code coverage with "none", it will fallback to phpdbg (which has known problems). 63 | coverage: none 64 | 65 | - name: Initialise moodle-plugin-ci 66 | run: | 67 | composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4 68 | echo $(cd ci/bin; pwd) >> $GITHUB_PATH 69 | echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH 70 | sudo locale-gen en_AU.UTF-8 71 | echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV 72 | 73 | - name: Install moodle-plugin-ci 74 | run: moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1 75 | env: 76 | DB: ${{ matrix.database }} 77 | MOODLE_BRANCH: ${{ matrix.moodle-branch }} 78 | # Uncomment this to run Behat tests using the Moodle App. 79 | # MOODLE_APP: 'true' 80 | 81 | - name: PHP Lint 82 | if: ${{ !cancelled() && matrix.runchecks == 'all' }} 83 | run: moodle-plugin-ci phplint 84 | 85 | - name: PHP Mess Detector 86 | continue-on-error: true # This step will show errors but will not fail 87 | if: ${{ !cancelled() && matrix.runchecks == 'all' }} 88 | run: moodle-plugin-ci phpmd 89 | 90 | - name: Moodle Code Checker 91 | if: ${{ !cancelled() && matrix.runchecks == 'all' }} 92 | run: moodle-plugin-ci phpcs --max-warnings 0 93 | 94 | - name: Moodle PHPDoc Checker 95 | if: ${{ !cancelled() && matrix.runchecks == 'all' }} 96 | run: moodle-plugin-ci phpdoc --max-warnings 0 97 | 98 | - name: Validating 99 | if: ${{ !cancelled() }} 100 | run: moodle-plugin-ci validate 101 | 102 | - name: Check upgrade savepoints 103 | if: ${{ !cancelled() && matrix.runchecks == 'all' }} 104 | run: moodle-plugin-ci savepoints 105 | 106 | - name: Mustache Lint 107 | if: ${{ !cancelled() && matrix.runchecks == 'all' }} 108 | run: moodle-plugin-ci mustache 109 | 110 | - name: Grunt 111 | if: ${{ !cancelled() && matrix.runchecks == 'all' }} 112 | run: moodle-plugin-ci grunt --max-lint-warnings 0 113 | 114 | - name: PHPUnit tests 115 | if: ${{ !cancelled() }} 116 | run: moodle-plugin-ci phpunit --fail-on-warning 117 | 118 | - name: Behat features 119 | id: behat 120 | if: ${{ !cancelled() }} 121 | run: moodle-plugin-ci behat --profile chrome --scss-deprecations 122 | 123 | - name: Upload Behat Faildump 124 | if: ${{ failure() && steps.behat.outcome == 'failure' }} 125 | uses: actions/upload-artifact@v4 126 | with: 127 | name: Behat Faildump (${{ join(matrix.*, ', ') }}) 128 | path: ${{ github.workspace }}/moodledata/behat_dump 129 | retention-days: 7 130 | if-no-files-found: ignore 131 | 132 | - name: Mark cancelled jobs as failed. 133 | if: ${{ cancelled() }} 134 | run: exit 1 135 | -------------------------------------------------------------------------------- /amd/src/manage.js: -------------------------------------------------------------------------------- 1 | // This file is part of Moodle - http://moodle.org/ 2 | // 3 | // Moodle is free software: you can redistribute it and/or modify 4 | // it under the terms of the GNU General Public License as published by 5 | // the Free Software Foundation, either version 3 of the License, or 6 | // (at your option) any later version. 7 | // 8 | // Moodle is distributed in the hope that it will be useful, 9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | // GNU General Public License for more details. 12 | // 13 | // You should have received a copy of the GNU General Public License 14 | // along with Moodle. If not, see . 15 | 16 | /** 17 | * TODO describe module manage 18 | * 19 | * @module local_uitranslate/manage 20 | * @copyright 2025 David Herney @ BambuCo 21 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 22 | */ 23 | 24 | import $ from 'jquery'; 25 | import Ajax from 'core/ajax'; 26 | import Notification from 'core/notification'; 27 | import {get_strings as getStrings} from 'core/str'; 28 | import Log from 'core/log'; 29 | 30 | /** 31 | * Target language code. 32 | */ 33 | var targetlang = ''; 34 | 35 | // Load strings. 36 | var strings = [ 37 | {key: 'errortranslation', component: 'local_uitranslate'}, 38 | {key: 'errordeletetranslation', component: 'local_uitranslate'} 39 | ]; 40 | var s = []; 41 | 42 | /** 43 | * Load strings from server. 44 | */ 45 | function loadStrings() { 46 | 47 | strings.forEach(one => { 48 | s[one.key] = one.key; 49 | }); 50 | 51 | getStrings(strings).then(function(results) { 52 | var pos = 0; 53 | strings.forEach(one => { 54 | s[one.key] = results[pos]; 55 | pos++; 56 | }); 57 | return true; 58 | }).fail(function(e) { 59 | Log.debug('Error loading strings'); 60 | Log.debug(e); 61 | }); 62 | } 63 | // End of Load strings. 64 | 65 | /** 66 | * Component initialization. 67 | */ 68 | export const init = () => { 69 | 70 | loadStrings(); 71 | 72 | targetlang = $('#id_lang2').val(); 73 | 74 | // Action: save translation. 75 | $('.translate-operations [data-action="save"]').on('click', function() { 76 | const $this = $(this); 77 | const $parent = $this.closest('.item'); 78 | const $translatecontrol = $parent.find('textarea'); 79 | const data = { 80 | hash: $this.data('hash'), 81 | value: $translatecontrol.val(), 82 | lang: targetlang 83 | }; 84 | 85 | Ajax.call([{ 86 | methodname: 'local_uitranslate_translate', 87 | args: data, 88 | done: function(response) { 89 | if (response) { 90 | $this.prop('disabled', true); 91 | $translatecontrol.addClass('translated'); 92 | } else { 93 | // Handle translation save error. 94 | Notification.alert({ 95 | title: '', 96 | message: response.error || s.errortranslation 97 | }); 98 | } 99 | }, 100 | fail: function(response) { 101 | // Handle translation save error. 102 | Notification.exception(response); 103 | Log.debug('Error saving translation'); 104 | Log.debug(response); 105 | } 106 | }]); 107 | }); 108 | 109 | // Action: delete a string. 110 | $('.translate-operations [data-action="delete"]').on('click', function() { 111 | const $this = $(this); 112 | const data = { 113 | hash: $this.data('hash') 114 | }; 115 | Ajax.call([{ 116 | methodname: 'local_uitranslate_delete', 117 | args: data, 118 | done: function(response) { 119 | if (response) { 120 | $this.closest('.item').remove(); 121 | } else { 122 | // Handle translation delete error. 123 | Notification.alert({ 124 | title: '', 125 | message: response.error || s.errordeletetranslation 126 | }); 127 | } 128 | }, 129 | fail: function(response) { 130 | // Handle translation delete error. 131 | Notification.exception(response); 132 | Log.debug('Error deleting translation'); 133 | Log.debug(response); 134 | } 135 | }]); 136 | }); 137 | 138 | // Enable save button when a translation is made. 139 | $('#local_uitranslate-translate-container textarea').on('change keyup paste', function() { 140 | const $this = $(this); 141 | const $parent = $this.closest('.item'); 142 | const $saveButton = $parent.find('.translate-operations [data-action="save"]'); 143 | $saveButton.prop('disabled', !$this.val().trim()); 144 | $(this).removeClass('translated'); 145 | }); 146 | }; 147 | -------------------------------------------------------------------------------- /amd/build/manage.min.js.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"manage.min.js","sources":["../src/manage.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see .\n\n/**\n * TODO describe module manage\n *\n * @module local_uitranslate/manage\n * @copyright 2025 David Herney @ BambuCo\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport $ from 'jquery';\nimport Ajax from 'core/ajax';\nimport Notification from 'core/notification';\nimport {get_strings as getStrings} from 'core/str';\nimport Log from 'core/log';\n\n/**\n * Target language code.\n */\nvar targetlang = '';\n\n// Load strings.\nvar strings = [\n {key: 'errortranslation', component: 'local_uitranslate'},\n {key: 'errordeletetranslation', component: 'local_uitranslate'}\n];\nvar s = [];\n\n/**\n * Load strings from server.\n */\nfunction loadStrings() {\n\n strings.forEach(one => {\n s[one.key] = one.key;\n });\n\n getStrings(strings).then(function(results) {\n var pos = 0;\n strings.forEach(one => {\n s[one.key] = results[pos];\n pos++;\n });\n return true;\n }).fail(function(e) {\n Log.debug('Error loading strings');\n Log.debug(e);\n });\n}\n// End of Load strings.\n\n/**\n * Component initialization.\n */\nexport const init = () => {\n\n loadStrings();\n\n targetlang = $('#id_lang2').val();\n\n // Action: save translation.\n $('.translate-operations [data-action=\"save\"]').on('click', function() {\n const $this = $(this);\n const $parent = $this.closest('.item');\n const $translatecontrol = $parent.find('textarea');\n const data = {\n hash: $this.data('hash'),\n value: $translatecontrol.val(),\n lang: targetlang\n };\n\n Ajax.call([{\n methodname: 'local_uitranslate_translate',\n args: data,\n done: function(response) {\n if (response) {\n $this.prop('disabled', true);\n $translatecontrol.addClass('translated');\n } else {\n // Handle translation save error.\n Notification.alert({\n title: '',\n message: response.error || s.errortranslation\n });\n }\n },\n fail: function(response) {\n // Handle translation save error.\n Notification.exception(response);\n Log.debug('Error saving translation');\n Log.debug(response);\n }\n }]);\n });\n\n // Action: delete a string.\n $('.translate-operations [data-action=\"delete\"]').on('click', function() {\n const $this = $(this);\n const data = {\n hash: $this.data('hash')\n };\n Ajax.call([{\n methodname: 'local_uitranslate_delete',\n args: data,\n done: function(response) {\n if (response) {\n $this.closest('.item').remove();\n } else {\n // Handle translation delete error.\n Notification.alert({\n title: '',\n message: response.error || s.errordeletetranslation\n });\n }\n },\n fail: function(response) {\n // Handle translation delete error.\n Notification.exception(response);\n Log.debug('Error deleting translation');\n Log.debug(response);\n }\n }]);\n });\n\n // Enable save button when a translation is made.\n $('#local_uitranslate-translate-container textarea').on('change keyup paste', function() {\n const $this = $(this);\n const $parent = $this.closest('.item');\n const $saveButton = $parent.find('.translate-operations [data-action=\"save\"]');\n $saveButton.prop('disabled', !$this.val().trim());\n $(this).removeClass('translated');\n });\n};\n"],"names":["targetlang","strings","key","component","s","forEach","one","then","results","pos","fail","e","debug","val","on","$this","this","$translatecontrol","closest","find","data","hash","value","lang","call","methodname","args","done","response","prop","addClass","alert","title","message","error","errortranslation","exception","remove","errordeletetranslation","trim","removeClass"],"mappings":";;;;;;;wPAgCIA,WAAa,GAGbC,QAAU,CACV,CAACC,IAAK,mBAAoBC,UAAW,qBACrC,CAACD,IAAK,yBAA0BC,UAAW,sBAE3CC,EAAI,iBA4BY,KArBhBH,QAAQI,SAAQC,MACZF,EAAEE,IAAIJ,KAAOI,IAAIJ,4BAGVD,SAASM,MAAK,SAASC,aAC1BC,IAAM,SACVR,QAAQI,SAAQC,MACZF,EAAEE,IAAIJ,KAAOM,QAAQC,KACrBA,UAEG,KACRC,MAAK,SAASC,gBACTC,MAAM,sCACNA,MAAMD,MAYdX,YAAa,mBAAE,aAAaa,0BAG1B,8CAA8CC,GAAG,SAAS,iBAClDC,OAAQ,mBAAEC,MAEVC,kBADUF,MAAMG,QAAQ,SACIC,KAAK,YACjCC,KAAO,CACTC,KAAMN,MAAMK,KAAK,QACjBE,MAAOL,kBAAkBJ,MACzBU,KAAMvB,0BAGLwB,KAAK,CAAC,CACPC,WAAY,8BACZC,KAAMN,KACNO,KAAM,SAASC,UACPA,UACAb,MAAMc,KAAK,YAAY,GACvBZ,kBAAkBa,SAAS,qCAGdC,MAAM,CACfC,MAAO,GACPC,QAASL,SAASM,OAAS9B,EAAE+B,oBAIzCzB,KAAM,SAASkB,gCAEEQ,UAAUR,uBACnBhB,MAAM,yCACNA,MAAMgB,qCAMpB,gDAAgDd,GAAG,SAAS,iBACpDC,OAAQ,mBAAEC,MACVI,KAAO,CACTC,KAAMN,MAAMK,KAAK,uBAEhBI,KAAK,CAAC,CACPC,WAAY,2BACZC,KAAMN,KACNO,KAAM,SAASC,UACPA,SACAb,MAAMG,QAAQ,SAASmB,+BAGVN,MAAM,CACfC,MAAO,GACPC,QAASL,SAASM,OAAS9B,EAAEkC,0BAIzC5B,KAAM,SAASkB,gCAEEQ,UAAUR,uBACnBhB,MAAM,2CACNA,MAAMgB,qCAMpB,mDAAmDd,GAAG,sBAAsB,iBACpEC,OAAQ,mBAAEC,MACAD,MAAMG,QAAQ,SACFC,KAAK,8CACrBU,KAAK,YAAad,MAAMF,MAAM0B,4BACxCvB,MAAMwB,YAAY"} -------------------------------------------------------------------------------- /classes/local/lib.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | namespace local_uitranslate\local; 18 | 19 | /** 20 | * Class lib 21 | * 22 | * @package local_uitranslate 23 | * @copyright 2025 David Herney @ BambuCo 24 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 25 | */ 26 | class lib { 27 | 28 | /** 29 | * Original string type. 30 | */ 31 | const TYPE_ORIGINAL = 'original'; 32 | 33 | /** 34 | * Translated string type. 35 | */ 36 | const TYPE_TRANSLATED = 'translated'; 37 | 38 | /** 39 | * Cache for translated strings. 40 | * 41 | * @var array> 42 | */ 43 | private static $cache = []; 44 | 45 | /** 46 | * Save a new UI string. 47 | * 48 | * @param string $plugin The plugin name, e.g. 'core', 'format_onetopic'. 49 | * @param string $string Original string to translate. 50 | * @param string|null $control The control element associated with the string. 51 | * @param int|null $itemid The item ID associated with the string. 52 | * @param string|null $lang If not provided, the current language will be used. 53 | * @return void 54 | */ 55 | public static function set(string $plugin, string $string, 56 | ?string $control = '', ?int $itemid = null, ?string $lang = ''): void { 57 | global $DB, $USER; 58 | 59 | $string = trim($string); 60 | if (empty($string)) { 61 | return; 62 | } 63 | 64 | if (empty($lang)) { 65 | $lang = current_language(); 66 | } 67 | 68 | $hash = md5($string); 69 | 70 | // Check if the record already exists. 71 | $exist = $DB->record_exists('local_uitranslate_strings', [ 72 | 'hash' => $hash, 73 | 'lang' => $lang, 74 | ]); 75 | 76 | $used = false; 77 | if (!$exist) { 78 | $data = new \stdClass(); 79 | $data->userid = $USER->id; 80 | $data->hash = $hash; 81 | $data->lang = $lang; 82 | $data->value = $string; 83 | $data->type = self::TYPE_ORIGINAL; 84 | $data->timecreated = time(); 85 | $DB->insert_record('local_uitranslate_strings', $data); 86 | } else { 87 | $used = $DB->record_exists('local_uitranslate_uses', [ 88 | 'hash' => $hash, 89 | 'plugin' => $plugin, 90 | 'control' => $control, 91 | 'itemid' => $itemid, 92 | ]); 93 | } 94 | 95 | // Save the relation between the string and the plugin. 96 | if (!$used) { 97 | $data = new \stdClass(); 98 | $data->hash = $hash; 99 | $data->plugin = $plugin; 100 | $data->control = $control ?? ''; 101 | $data->itemid = $itemid; 102 | $DB->insert_record('local_uitranslate_uses', $data); 103 | } 104 | 105 | } 106 | 107 | /** 108 | * Save a new UI string for multiple plugins. 109 | * 110 | * @param string $plugin The plugin name, e.g. 'core', 'format_onetopic'. 111 | * @param array $strings Strings to translate with control as keys. 112 | * @param int|null $itemid The item ID associated with the string. 113 | * @param string|null $lang If not provided, the current language will be used. 114 | * @return void 115 | */ 116 | public static function setbulk(string $plugin, array $strings, ?int $itemid = null, ?string $lang = ''): void { 117 | foreach ($strings as $control => $string) { 118 | self::set($plugin, $string, $control, $itemid, $lang); 119 | } 120 | } 121 | 122 | /** 123 | * Report a string as no longer used. 124 | * 125 | * @param string $plugin The plugin name, e.g. 'core', 'format_onetopic'. 126 | * @param string $string Original string to translate. 127 | * @param string|null $control The control element associated with the string. 128 | * @param int|null $itemid The item ID associated with the string. 129 | * @return void 130 | */ 131 | public static function unset(string $plugin, string $string, 132 | ?string $control = '', ?int $itemid = null): void { 133 | global $DB; 134 | 135 | $string = trim($string); 136 | if (empty($string)) { 137 | return; 138 | } 139 | 140 | $hash = md5($string); 141 | 142 | // Remove the relation between the string and the plugin. 143 | $DB->delete_records('local_uitranslate_uses', [ 144 | 'hash' => $hash, 145 | 'plugin' => $plugin, 146 | 'control' => $control, 147 | 'itemid' => $itemid, 148 | ]); 149 | 150 | // The string is maintained and cleaned in a massively automated process for performance and to analyze when 151 | // to delete translated strings. 152 | } 153 | 154 | /** 155 | * Save a translation. 156 | * 157 | * @param string $hash The hash of the original string. 158 | * @param string $string The translated string. 159 | * @param string|null $lang The language code. 160 | * @return bool True on success, false on failure. 161 | */ 162 | public static function translate(string $hash, string $string, ?string $lang = ''): bool { 163 | global $DB, $USER; 164 | 165 | $string = trim($string); 166 | if (empty($string)) { 167 | return false; 168 | } 169 | 170 | if (empty($lang)) { 171 | $lang = current_language(); 172 | } 173 | 174 | // Check if the original string exist. 175 | $original = $DB->get_record('local_uitranslate_strings', ['hash' => $hash, 'type' => self::TYPE_ORIGINAL]); 176 | 177 | // Check if the original string exists. 178 | if (!$original) { 179 | return false; 180 | } 181 | 182 | $systemcontext = \context_system::instance(); 183 | $cantranslateall = has_capability('local/uitranslate:translateall', $systemcontext); 184 | 185 | // Check if the user has permission to translate. 186 | if ($original->userid != $USER->id && !$cantranslateall) { 187 | return false; 188 | } 189 | 190 | // Check if the record already exists. 191 | $record = $DB->get_record('local_uitranslate_strings', ['hash' => $hash, 'lang' => $lang]); 192 | 193 | if ($record && $original->userid != $USER->id && !$cantranslateall) { 194 | return false; 195 | } 196 | 197 | $return = false; 198 | if ($record) { 199 | if ($record->value != $string) { 200 | $return = $DB->update_record('local_uitranslate_strings', ['id' => $record->id, 'value' => $string]); 201 | } else { 202 | $return = true; 203 | } 204 | } else { 205 | $data = new \stdClass(); 206 | $data->userid = $USER->id; 207 | $data->hash = $hash; 208 | $data->lang = $lang; 209 | $data->value = $string; 210 | $data->type = self::TYPE_TRANSLATED; 211 | $data->timecreated = time(); 212 | $return = $DB->insert_record('local_uitranslate_strings', $data); 213 | } 214 | 215 | return $return; 216 | 217 | } 218 | 219 | /** 220 | * Get a translation string. 221 | * 222 | * @param string $string Original string to translate. 223 | * @param string|null $lang If not provided, the current language will be used. 224 | * @return string Translated string or original if not found. 225 | */ 226 | public static function get(string $string, ?string $lang = ''): string { 227 | global $DB; 228 | 229 | if (empty($lang)) { 230 | $lang = current_language(); 231 | } 232 | 233 | $hash = md5($string); 234 | 235 | if (isset(self::$cache[$hash][$lang])) { 236 | return self::$cache[$hash][$lang]; 237 | } 238 | 239 | // Retrieve the translated string. 240 | $translated = $DB->get_field('local_uitranslate_strings', 'value', [ 241 | 'hash' => $hash, 242 | 'lang' => $lang, 243 | ]); 244 | 245 | if (!$translated) { 246 | $harvestmode = get_config('local_uitranslate', 'harvestmode'); 247 | 248 | if ($harvestmode) { 249 | $exist = $DB->record_exists('local_uitranslate_strings', ['hash' => $hash]); 250 | 251 | if (!$exist) { 252 | self::set('local_uitranslate', $string, 'harvest', null, $lang); 253 | } 254 | } 255 | } 256 | 257 | $return = $translated ? $translated : $string; 258 | 259 | self::$cache[$hash][$lang] = $return; 260 | 261 | return $return; 262 | } 263 | 264 | /** 265 | * Clear the translation cache. 266 | * 267 | * @return void 268 | */ 269 | public static function clear_cache(): void { 270 | self::$cache = []; 271 | } 272 | 273 | /** 274 | * Preload translations for a specific plugin in cache. 275 | * 276 | * Used to speed up translation retrieval by loading all relevant translations into memory. 277 | * 278 | * @param string $plugin The plugin name, e.g. 'core', 'format_onetopic'. 279 | * @param string|null $lang The language code, e.g. 'en', 'fr'. If not provided, the current language will be used. 280 | * @return void 281 | */ 282 | public static function preload_by_plugin(string $plugin, ?string $lang): void { 283 | global $DB; 284 | 285 | if (empty($lang)) { 286 | $lang = current_language(); 287 | } 288 | 289 | $sql = "SELECT * FROM {local_uitranslate_uses} lus 290 | INNER JOIN {local_uitranslate_strings} lts ON lus.hash = lts.hash 291 | WHERE lus.plugin = :plugin AND lts.lang = :lang"; 292 | 293 | $records = $DB->get_records_sql($sql, [ 294 | 'plugin' => $plugin, 295 | 'lang' => $lang, 296 | ]); 297 | 298 | foreach ($records as $record) { 299 | self::$cache[$record->hash][$record->lang] = $record->value; 300 | } 301 | } 302 | 303 | /** 304 | * Delete a translation. 305 | * 306 | * @param string $hash The hash of the original string. 307 | * @param string|null $lang The language code. 308 | * @return bool True on success, false on failure. 309 | */ 310 | public static function delete(string $hash, ?string $lang = ''): bool { 311 | global $DB, $USER; 312 | 313 | // Check if the original string exist. 314 | $original = $DB->get_record('local_uitranslate_strings', ['hash' => $hash, 'type' => self::TYPE_ORIGINAL]); 315 | 316 | // Check if the original string exists. 317 | if (!$original) { 318 | return false; 319 | } 320 | 321 | $systemcontext = \context_system::instance(); 322 | $cantranslateall = has_capability('local/uitranslate:translateall', $systemcontext); 323 | 324 | // Check if the user has permission to translate. 325 | if ($original->userid != $USER->id && !$cantranslateall) { 326 | return false; 327 | } 328 | 329 | // If not specified, delete all translations. 330 | if (empty($lang)) { 331 | $DB->delete_records('local_uitranslate_uses', ['hash' => $hash]); 332 | $DB->delete_records('local_uitranslate_strings', ['hash' => $hash]); 333 | } else { 334 | $DB->delete_records('local_uitranslate_strings', ['hash' => $hash, 'lang' => $lang]); 335 | } 336 | 337 | return true; 338 | 339 | } 340 | } 341 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | --------------------------------------------------------------------------------