mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-14 13:02:07 +02:00
Code Issues Projects Releases Wiki Activity

Merge branch 'MDL-82445-main' of https://github.com/andrewnicols/moodle

Browse Source
This commit is contained in:
Ilya Tregubov 2024-07-18 11:37:15 +08:00
commit acbcb83a7c
6 changed files with 400 additions and 161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
admin/tool/langimport/classes/locale.php
View File

@ -57,7 +57,7 @@ class locale {
}
// Store current locale.
$currentlocale = $this->set_locale(LC_ALL, 0);
$currentlocale = $this->get_locale();
$locale = get_string_manager()->get_string($stringtofetch, 'langconfig', $a = null, $langpackcode);
@ -79,19 +79,16 @@ class locale {
* @return string|false Returns the new current locale, or FALSE on error.
*/
protected function set_locale(int $category = LC_ALL, string $locale = '0') {
if (strlen($locale) <= 255 || PHP_OS_FAMILY === 'BSD' || PHP_OS_FAMILY === 'Darwin') {
// We can set the whole locale all together.
return setlocale($category, $locale);
}
return \core\locale::set_locale($category, $locale);
}
// Too long locale with linux or windows, let's split it into known and supported categories.
$split = explode(';', $locale);
foreach ($split as $element) {
[$category, $value] = explode('=', $element);
if (defined($category)) { // Only if the category exists, there are OS differences.
setlocale(constant($category), $value);
}
}
return setlocale(LC_ALL, 0); // Finally, return the complete configured locale.
/**
* Get the current locale.
*
* @param int $category
* @return string|false
*/
protected function get_locale(int $category = LC_ALL): string|false {
return \core\locale::get_locale($category);
}
}

149
admin/tool/langimport/tests/locale_test.php
View File

@ -21,39 +21,59 @@ namespace tool_langimport;
*
* @package tool_langimport
* @category test
* @coversDefaultClass \tool_langimport\locale
* @covers \tool_langimport\locale
* @copyright 2018 Université Rennes 2 {@link https://www.univ-rennes2.fr}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class locale_test extends \advanced_testcase {
final class locale_test extends \advanced_testcase {
/** @var string Locale */
protected string $locale;
#[\Override]
public function setUp(): void {
parent::setUp();
$this->locale = \core\locale::get_locale();
}
#[\Override]
public function tearDown(): void {
parent::tearDown();
\core\locale::set_locale(LC_ALL, $this->locale);
}
/**
* Test that \tool_langimport\locale::check_locale_availability() works as expected.
*
* @covers ::check_locale_availability
* @return void
*/
public function test_check_locale_availability(): void {
// Create a mock of set_locale() method to simulate :
// - first setlocale() call which backup current locale
// - second setlocale() call which try to set new 'es' locale
// - third setlocale() call which restore locale.
// Create a mock of set_locale() method to simulate:
// - get_locale() call which backup current locale
// - first set_locale() call which try to set new 'es' locale
// - second set_locale() call which restore locale.
$mock = $this->getMockBuilder(locale::class)
->onlyMethods(['set_locale'])
->onlyMethods([
'get_locale',
'set_locale',
])
->getMock();
$mock->method('set_locale')->will($this->onConsecutiveCalls('en', 'es', 'en'));
$mock->method('get_locale')->will($this->onConsecutiveCalls('en'));
$mock->method('set_locale')->will($this->onConsecutiveCalls('es', 'en'));
// Test what happen when locale is available on system.
$result = $mock->check_locale_availability('en');
$this->assertTrue($result);
// Create a mock of set_locale() method to simulate :
// - first setlocale() call which backup current locale
// - second setlocale() call which fail to set new locale
// - third setlocale() call which restore locale.
// Create a mock of set_locale() method to simulate:
// - get_locale() call which backup current locale
// - first set_locale() call which fail to set new locale
// - second set_locale() call which restore locale.
$mock = $this->getMockBuilder(locale::class)
->onlyMethods(['set_locale'])
->onlyMethods([
'get_locale',
'set_locale',
])
->getMock();
$mock->method('set_locale')->will($this->onConsecutiveCalls('en', false, 'en'));
$mock->method('get_locale')->will($this->onConsecutiveCalls('en'));
$mock->method('set_locale')->will($this->onConsecutiveCalls(false, 'en'));
// Test what happen when locale is not available on system.
$result = $mock->check_locale_availability('en');
@ -64,99 +84,4 @@ class locale_test extends \advanced_testcase {
$this->expectException(\coding_exception::class);
$locale->check_locale_availability('');
}
/**
* Test \tool_langimport\locale::set_locale() own logic.
*
* We have to explicitly test set_locale() own logic and results,
* that effectively sets the current locale, so we need to restore
* the original locale after every test (ugly, from a purist unit test
* point of view, but needed).
*
* @dataProvider set_locale_provider
* @covers ::set_locale
*
* @param string $set locale string to be set.
* @param string $ret expected results returned after setting the locale.
*/
public function test_set_locale(string $set, string $ret): void {
// Make set_locale() public.
$loc = new locale();
$rc = new \ReflectionClass(locale::class);
$rm = $rc->getMethod('set_locale');
// Capture current locale for later restore (funnily, using the set_locale() method itself.
$originallocale = $rm->invokeArgs($loc, [LC_ALL, 0]);
// Assert we get the locale defined as expected.
$this->assertEquals($ret, $rm->invokeArgs($loc, [LC_ALL, $set]));
// We have finished, restore the original locale, so this doesn't affect other tests at distance.
// (again, funnily, using the very same set_locale() method).
$rm->invokeArgs($loc, [LC_ALL, $originallocale]);
}
/**
* Data provider for test_set_locale().
*
* Provides a locale to be set (as 'set') and a expected return value (as 'ret'). Note that
* some of the locales are OS dependent, so only the ones matching the OS will be provided.
*
* We make extensive use of the en_AU.UTF-8/English_Australia.1252 locale that is mandatory to
* be installed in any system running PHPUnit tests.
*/
public function set_locale_provider(): array {
// Let's list the allowed categories by OS.
$bsdallowed = ['LC_COLLATE', 'LC_CTYPE', 'LC_MESSAGES', 'LC_MONETARY', 'LC_NUMERIC', 'LC_TIME'];
$winallowed = ['LC_COLLATE', 'LC_CTYPE', 'LC_MONETARY', 'LC_NUMERIC', 'LC_TIME'];
$linuxallowed = [
'LC_COLLATE', 'LC_CTYPE', 'LC_MESSAGES', 'LC_MONETARY', 'LC_NUMERIC', 'LC_TIME',
'LC_PAPER', 'LC_NAME', 'LC_ADDRESS', 'LC_TELEPHONE', 'LC_MEASUREMENT', 'LC_IDENTIFICATION'
];
// The base locale name is also OS dependent.
$baselocale = get_string('locale', 'langconfig');
if (PHP_OS_FAMILY === 'Windows') {
$baselocale = get_string('localewin', 'langconfig');
}
// Here we'll go accumulating cases to be provided.
$cases = [];
// First, the simplest case, just pass a locale name, without categories.
$cases['rawlocale'] = [
'set' => $baselocale,
'ret' => $baselocale,
];
// Now, let's fill ALL LC categories, we should get back the locale name if all them are set with same value.
// Note that this case is the one that, under Linux only, covers the changes performed to the set_locale() method.
// Pick the correct categories depending on the OS.
$oscategories = $bsdallowed; // Default to BSD/Dawrwin ones because they are the standard 6 supported by PHP.
if (PHP_OS_FAMILY === 'Windows') {
$oscategories = $winallowed;
} else if (PHP_OS_FAMILY === 'Linux') {
$oscategories = $linuxallowed;
}
$localestr = '';
foreach ($oscategories as $category) {
// Format is different by OS too, so let build the string conditionally.
if (PHP_OS_FAMILY === 'BSD' || PHP_OS_FAMILY === 'Darwin') {
// BSD uses slashes (/) separated list of the 6 values in exact order.
$localestr .= '/' . $baselocale;
} else {
// Linux/Windows use semicolon (;) separated list of category=value pairs.
$localestr .= ';' . $category . '=' . $baselocale;
}
}
$cases['allcategories'] = [
'set' => trim($localestr, ';/'),
'ret' => $baselocale,
];
// Return all the built cases.
return $cases;
}
}

70
filter/tidy/filter.php
View File

@ -1,5 +1,4 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
@ -16,54 +15,55 @@
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* HTML tidy text filter.
* HTML tidy text filter.
*
* @package filter
* This class looks for text including markup and
* applies tidy's repair function to it.
* Tidy is a HTML clean and
* repair utility, which is currently available for PHP 4.3.x and PHP 5 as a
* PECL extension from http://pecl.php.net/package/tidy, in PHP 5 you need only
* to compile using the --with-tidy option.
* If you don't have the tidy extension installed or don't know, you can enable
* or disable this filter, it just won't have any effect.
* If you want to know what you can set in $tidyoptions and what their default
* values are, see http://php.net/manual/en/function.tidy-get-config.php.
*
* @package filter_tidy
* @subpackage tiny
* @copyright 2004 Hannes Gassert <hannes at mediagonal dot ch>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
// This class looks for text including markup and
// applies tidy's repair function to it.
// Tidy is a HTML clean and
// repair utility, which is currently available for PHP 4.3.x and PHP 5 as a
// PECL extension from http://pecl.php.net/package/tidy, in PHP 5 you need only
// to compile using the --with-tidy option.
// If you don't have the tidy extension installed or don't know, you can enable
// or disable this filter, it just won't have any effect.
// If you want to know what you can set in $tidyoptions and what their default
// values are, see http://php.net/manual/en/function.tidy-get-config.php.
class filter_tidy extends moodle_text_filter {
function filter($text, array $options = array()) {
#[\Override]
public function filter($text, array $options = []) {
// Configuration for tidy. Feel free to tune for your needs, e.g. to allow
// proprietary markup.
$tidyoptions = [
'output-xhtml' => true,
'show-body-only' => true,
'tidy-mark' => false,
'drop-proprietary-attributes' => true,
'drop-empty-paras' => true,
'indent' => true,
'quiet' => true,
];
/// Configuration for tidy. Feel free to tune for your needs, e.g. to allow
/// proprietary markup.
$tidyoptions = array(
'output-xhtml' => true,
'show-body-only' => true,
'tidy-mark' => false,
'drop-proprietary-attributes' => true,
'drop-empty-paras' => true,
'indent' => true,
'quiet' => true,
);
/// Do a quick check using strpos to avoid unnecessary work
// Do a quick check using strpos to avoid unnecessary work.
if (strpos($text, '<') === false) {
return $text;
}
/// If enabled: run tidy over the entire string
if (function_exists('tidy_repair_string')){
$text = tidy_repair_string($text, $tidyoptions, 'utf8');
// If enabled: run tidy over the entire string.
if (function_exists('tidy_repair_string')) {
$currentlocale = \core\locale::get_locale();
try {
$text = tidy_repair_string($text, $tidyoptions, 'utf8');
} finally {
\core\locale::set_locale(LC_ALL, $currentlocale);
}
}
return $text;
}
}

111
filter/tidy/tests/filter_tidy_test.php Normal file
View File

@ -0,0 +1,111 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
namespace filter_tidy;
/**
* Tests for HTML tidy.
*
* @package filter_tidy
* @category test
* @copyright 2024 Andrew Lyons <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @covers \filter_tidy
*/
final class filter_tidy_test extends \advanced_testcase {
/** @var string Locale */
protected string $locale;
#[\Override]
public static function setUpBeforeClass(): void {
parent::setUpBeforeClass();
require_once(__DIR__ . '/../filter.php');
}
#[\Override]
public function setUp(): void {
parent::setUp();
$this->locale = \core\locale::get_locale();
}
#[\Override]
public function tearDown(): void {
parent::tearDown();
\core\locale::set_locale(LC_ALL, $this->locale);
}
/**
* Test the filter method.
*
* @requires extension tidy
* @dataProvider filter_provider
* @param string $text The text to filter.
* @param string $expected The expected value
*/
public function test_filter(
string $text,
string $expected,
): void {
$filter = new \filter_tidy(\core\context\system::instance(), []);
$this->assertEquals($expected, $filter->filter($text));
$this->assertEquals(
\core\locale::standardise_locale($this->locale),
\core\locale::standardise_locale(\core\locale::get_locale()),
);
}
/**
* Data provider for the filter test.
*
* @return array
*/
public static function filter_provider(): array {
return [
// No HTML tags.
[
'The cat is in the hat',
'The cat is in the hat',
],
// Partial HTML.
[
'<p>The cat is in the hat',
<<<EOF
<p>
The cat is in the hat
</p>
EOF,
],
// Return only the body, repairing the closing tag.
[
<<<EOF
<html>
<head>
<title>test</title>
</head>
<body>
<p>error</i>
</body>
</html>
EOF,
<<<EOF
<p>
error
</p>
EOF,
],
];
}
}

80
lib/classes/locale.php Normal file
View File

@ -0,0 +1,80 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
namespace core;
/**
* Helper utility to interact with Locales.
*
* @package core
* @copyright 2024 Andrew Lyons <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class locale {
/**
* Wrap for the native PHP function setlocale().
*
* @param int $category Specifying the category of the functions affected by the locale setting.
* @param string $locale E.g.: en_AU.utf8, en_GB.utf8, es_ES.utf8, fr_FR.utf8, de_DE.utf8.
* @return string|false Returns the new current locale, or FALSE on error.
*/
public static function set_locale(int $category = LC_ALL, string $locale = '0'): string|false {
if (strlen($locale) <= 255 || PHP_OS_FAMILY === 'BSD' || PHP_OS_FAMILY === 'Darwin') {
// We can set the whole locale all together.
return setlocale($category, $locale);
}
// Too long locale with linux or windows, let's split it into known and supported categories.
$split = explode(';', self::standardise_locale($locale));
foreach ($split as $element) {
[$category, $value] = explode('=', $element);
if (defined($category)) { // Only if the category exists, there are OS differences.
setlocale(constant($category), $value);
}
}
// Finally, return the complete configured locale.
return self::get_locale();
}
/**
* Get the current locale.
*
* @param int $category
* @return string|false
*/
public static function get_locale(int $category = LC_ALL): string|false {
return setlocale($category, "0");
}
/**
* Standardise a string-based locale, removing any deprecated locale categories and ordering it.
*
* @param string $locale
* @return string
*/
public static function standardise_locale(string $locale): string {
$locales = array_filter(
explode(';', $locale),
function ($locale): bool {
[$category, ] = explode('=', $locale);
return defined($category);
},
);
sort($locales);
return implode(';', $locales);
}
}

126
lib/tests/locale_test.php Normal file
View File

@ -0,0 +1,126 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
namespace core;
/**
* Tests for \core\locale class.
*
* @package core
* @category test
* @copyright 2018 Université Rennes 2 {@link https://www.univ-rennes2.fr}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @covers \core\locale
*/
final class locale_test extends \advanced_testcase {
/** @var string Locale */
protected string $locale;
#[\Override]
public function setUp(): void {
parent::setUp();
$this->locale = \core\locale::get_locale();
}
#[\Override]
public function tearDown(): void {
parent::tearDown();
\core\locale::set_locale(LC_ALL, $this->locale);
}
/**
* Test \tool_langimport\locale::set_locale() own logic.
*
* We have to explicitly test set_locale() own logic and results,
* that effectively sets the current locale, so we need to restore
* the original locale after every test (ugly, from a purist unit test
* point of view, but needed).
*
* @dataProvider set_locale_provider
* @param string $set locale string to be set.
* @param string $ret expected results returned after setting the locale.
*/
public function test_set_locale(string $set, string $ret): void {
// Capture current locale for later restore (funnily, using the set_locale() method itself.
$originallocale = locale::set_locale(LC_ALL, 0);
// Assert we get the locale defined as expected.
$this->assertEquals($ret, locale::set_locale(LC_ALL, $set));
}
/**
* Data provider for test_set_locale().
*
* Provides a locale to be set (as 'set') and a expected return value (as 'ret'). Note that
* some of the locales are OS dependent, so only the ones matching the OS will be provided.
*
* We make extensive use of the en_AU.UTF-8/English_Australia.1252 locale that is mandatory to
* be installed in any system running PHPUnit tests.
*/
public static function set_locale_provider(): array {
// Let's list the allowed categories by OS.
$bsdallowed = ['LC_COLLATE', 'LC_CTYPE', 'LC_MESSAGES', 'LC_MONETARY', 'LC_NUMERIC', 'LC_TIME'];
$winallowed = ['LC_COLLATE', 'LC_CTYPE', 'LC_MONETARY', 'LC_NUMERIC', 'LC_TIME'];
$linuxallowed = [
'LC_COLLATE', 'LC_CTYPE', 'LC_MESSAGES', 'LC_MONETARY', 'LC_NUMERIC', 'LC_TIME',
'LC_PAPER', 'LC_NAME', 'LC_ADDRESS', 'LC_TELEPHONE', 'LC_MEASUREMENT', 'LC_IDENTIFICATION',
];
// The base locale name is also OS dependent.
$baselocale = get_string('locale', 'langconfig');
if (PHP_OS_FAMILY === 'Windows') {
$baselocale = get_string('localewin', 'langconfig');
}
// Here we'll go accumulating cases to be provided.
$cases = [];
// First, the simplest case, just pass a locale name, without categories.
$cases['rawlocale'] = [
'set' => $baselocale,
'ret' => $baselocale,
];
// Now, let's fill ALL LC categories, we should get back the locale name if all them are set with same value.
// Note that this case is the one that, under Linux only, covers the changes performed to the set_locale() method.
// Pick the correct categories depending on the OS.
$oscategories = $bsdallowed; // Default to BSD/Dawrwin ones because they are the standard 6 supported by PHP.
if (PHP_OS_FAMILY === 'Windows') {
$oscategories = $winallowed;
} else if (PHP_OS_FAMILY === 'Linux') {
$oscategories = $linuxallowed;
}
$localestr = '';
foreach ($oscategories as $category) {
// Format is different by OS too, so let build the string conditionally.
if (PHP_OS_FAMILY === 'BSD' || PHP_OS_FAMILY === 'Darwin') {
// BSD uses slashes (/) separated list of the 6 values in exact order.
$localestr .= '/' . $baselocale;
} else {
// Linux/Windows use semicolon (;) separated list of category=value pairs.
$localestr .= ';' . $category . '=' . $baselocale;
}
}
$cases['allcategories'] = [
'set' => trim($localestr, ';/'),
'ret' => $baselocale,
];
// Return all the built cases.
return $cases;
}
}