Merge branch 'MDL-19270_master' of https://github.com/nadavkav/moodle
[moodle.git] / lib / tests / text_test.php
1 <?php
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 <http://www.gnu.org/licenses/>.
17 /**
18  * core_text unit tests.
19  *
20  * @package    core
21  * @category   phpunit
22  * @copyright  2012 Petr Skoda {@link http://skodak.org}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Unit tests for our utf-8 aware text processing.
31  *
32  * @package    core
33  * @category   phpunit
34  * @copyright  2010 Petr Skoda (http://skodak.org)
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class core_text_testcase extends advanced_testcase {
39     /**
40      * Tests the static parse charset method.
41      */
42     public function test_parse_charset() {
43         $this->assertSame('windows-1250', core_text::parse_charset('Cp1250'));
44         // Does typo3 work? Some encoding moodle does not use.
45         $this->assertSame('windows-1252', core_text::parse_charset('ms-ansi'));
46     }
48     /**
49      * Tests the static convert method.
50      */
51     public function test_convert() {
52         $utf8 = "Žluťoučký koníček";
53         $iso2 = pack("H*", "ae6c75bb6f75e86bfd206b6f6eede8656b");
54         $win  = pack("H*", "8e6c759d6f75e86bfd206b6f6eede8656b");
55         $this->assertSame($iso2, core_text::convert($utf8, 'utf-8', 'iso-8859-2'));
56         $this->assertSame($utf8, core_text::convert($iso2, 'iso-8859-2', 'utf-8'));
57         $this->assertSame($win, core_text::convert($utf8, 'utf-8', 'win-1250'));
58         $this->assertSame($utf8, core_text::convert($win, 'win-1250', 'utf-8'));
59         $this->assertSame($iso2, core_text::convert($win, 'win-1250', 'iso-8859-2'));
60         $this->assertSame($win, core_text::convert($iso2, 'iso-8859-2', 'win-1250'));
61         $this->assertSame($iso2, core_text::convert($iso2, 'iso-8859-2', 'iso-8859-2'));
62         $this->assertSame($win, core_text::convert($win, 'win-1250', 'cp1250'));
63         $this->assertSame($utf8, core_text::convert($utf8, 'utf-8', 'utf-8'));
65         $utf8 = '言語設定';
66         $str = pack("H*", "b8c0b8ecc0dfc4ea"); // EUC-JP
67         $this->assertSame($str, core_text::convert($utf8, 'utf-8', 'EUC-JP'));
68         $this->assertSame($utf8, core_text::convert($str, 'EUC-JP', 'utf-8'));
69         $this->assertSame($utf8, core_text::convert($utf8, 'utf-8', 'utf-8'));
71         $str = pack("H*", "1b24423840386c405f446a1b2842"); // ISO-2022-JP
72         $this->assertSame($str, core_text::convert($utf8, 'utf-8', 'ISO-2022-JP'));
73         $this->assertSame($utf8, core_text::convert($str, 'ISO-2022-JP', 'utf-8'));
74         $this->assertSame($utf8, core_text::convert($utf8, 'utf-8', 'utf-8'));
76         $str = pack("H*", "8cbe8cea90dd92e8"); // SHIFT-JIS
77         $this->assertSame($str, core_text::convert($utf8, 'utf-8', 'SHIFT-JIS'));
78         $this->assertSame($utf8, core_text::convert($str, 'SHIFT-JIS', 'utf-8'));
79         $this->assertSame($utf8, core_text::convert($utf8, 'utf-8', 'utf-8'));
81         $utf8 = '简体中文';
82         $str = pack("H*", "bcf2cce5d6d0cec4"); // GB2312
83         $this->assertSame($str, core_text::convert($utf8, 'utf-8', 'GB2312'));
84         $this->assertSame($utf8, core_text::convert($str, 'GB2312', 'utf-8'));
85         $this->assertSame($utf8, core_text::convert($utf8, 'utf-8', 'utf-8'));
87         $str = pack("H*", "bcf2cce5d6d0cec4"); // GB18030
88         $this->assertSame($str, core_text::convert($utf8, 'utf-8', 'GB18030'));
89         $this->assertSame($utf8, core_text::convert($str, 'GB18030', 'utf-8'));
90         $this->assertSame($utf8, core_text::convert($utf8, 'utf-8', 'utf-8'));
92         $utf8 = "Žluťoučký koníček";
93         $this->assertSame('Zlutoucky konicek', core_text::convert($utf8, 'utf-8', 'ascii'));
94         $this->assertSame($utf8, core_text::convert($utf8.chr(130), 'utf-8', 'utf-8'));
95         $utf8 = "Der eine stößt den Speer zum Mann";
96         $this->assertSame('Der eine stoesst den Speer zum Mann', core_text::convert($utf8, 'utf-8', 'ascii'));
97         $iso1 = core_text::convert($utf8, 'utf-8', 'iso-8859-1');
98         $this->assertSame('Der eine stoesst den Speer zum Mann', core_text::convert($iso1, 'iso-8859-1', 'ascii'));
99     }
101     /**
102      * Tests the static sub string method.
103      */
104     public function test_substr() {
105         $str = "Žluťoučký koníček";
106         $this->assertSame($str, core_text::substr($str, 0));
107         $this->assertSame('luťoučký koníček', core_text::substr($str, 1));
108         $this->assertSame('luť', core_text::substr($str, 1, 3));
109         $this->assertSame($str, core_text::substr($str, 0, 100));
110         $this->assertSame('če', core_text::substr($str, -3, 2));
112         $iso2 = pack("H*", "ae6c75bb6f75e86bfd206b6f6eede8656b");
113         $this->assertSame(core_text::convert('luť', 'utf-8', 'iso-8859-2'), core_text::substr($iso2, 1, 3, 'iso-8859-2'));
114         $this->assertSame(core_text::convert($str, 'utf-8', 'iso-8859-2'), core_text::substr($iso2, 0, 100, 'iso-8859-2'));
115         $this->assertSame(core_text::convert('če', 'utf-8', 'iso-8859-2'), core_text::substr($iso2, -3, 2, 'iso-8859-2'));
117         $win  = pack("H*", "8e6c759d6f75e86bfd206b6f6eede8656b");
118         $this->assertSame(core_text::convert('luť', 'utf-8', 'cp1250'), core_text::substr($win, 1, 3, 'cp1250'));
119         $this->assertSame(core_text::convert($str, 'utf-8', 'cp1250'), core_text::substr($win, 0, 100, 'cp1250'));
120         $this->assertSame(core_text::convert('če', 'utf-8', 'cp1250'), core_text::substr($win, -3, 2, 'cp1250'));
122         $str = pack("H*", "b8c0b8ecc0dfc4ea"); // EUC-JP
123         $s = pack("H*", "b8ec"); // EUC-JP
124         $this->assertSame($s, core_text::substr($str, 1, 1, 'EUC-JP'));
126         $str = pack("H*", "1b24423840386c405f446a1b2842"); // ISO-2022-JP
127         $s = pack("H*", "1b2442386c1b2842"); // ISO-2022-JP
128         $this->assertSame($s, core_text::substr($str, 1, 1, 'ISO-2022-JP'));
130         $str = pack("H*", "8cbe8cea90dd92e8"); // SHIFT-JIS
131         $s = pack("H*", "8cea"); // SHIFT-JIS
132         $this->assertSame($s, core_text::substr($str, 1, 1, 'SHIFT-JIS'));
134         $str = pack("H*", "bcf2cce5d6d0cec4"); // GB2312
135         $s = pack("H*", "cce5"); // GB2312
136         $this->assertSame($s, core_text::substr($str, 1, 1, 'GB2312'));
138         $str = pack("H*", "bcf2cce5d6d0cec4"); // GB18030
139         $s = pack("H*", "cce5"); // GB18030
140         $this->assertSame($s, core_text::substr($str, 1, 1, 'GB18030'));
141     }
143     /**
144      * Tests the static string length method.
145      */
146     public function test_strlen() {
147         $str = "Žluťoučký koníček";
148         $this->assertSame(17, core_text::strlen($str));
150         $iso2 = pack("H*", "ae6c75bb6f75e86bfd206b6f6eede8656b");
151         $this->assertSame(17, core_text::strlen($iso2, 'iso-8859-2'));
153         $win  = pack("H*", "8e6c759d6f75e86bfd206b6f6eede8656b");
154         $this->assertSame(17, core_text::strlen($win, 'cp1250'));
156         $str = pack("H*", "b8ec"); // EUC-JP
157         $this->assertSame(1, core_text::strlen($str, 'EUC-JP'));
158         $str = pack("H*", "b8c0b8ecc0dfc4ea"); // EUC-JP
159         $this->assertSame(4, core_text::strlen($str, 'EUC-JP'));
161         $str = pack("H*", "1b2442386c1b2842"); // ISO-2022-JP
162         $this->assertSame(1, core_text::strlen($str, 'ISO-2022-JP'));
163         $str = pack("H*", "1b24423840386c405f446a1b2842"); // ISO-2022-JP
164         $this->assertSame(4, core_text::strlen($str, 'ISO-2022-JP'));
166         $str = pack("H*", "8cea"); // SHIFT-JIS
167         $this->assertSame(1, core_text::strlen($str, 'SHIFT-JIS'));
168         $str = pack("H*", "8cbe8cea90dd92e8"); // SHIFT-JIS
169         $this->assertSame(4, core_text::strlen($str, 'SHIFT-JIS'));
171         $str = pack("H*", "cce5"); // GB2312
172         $this->assertSame(1, core_text::strlen($str, 'GB2312'));
173         $str = pack("H*", "bcf2cce5d6d0cec4"); // GB2312
174         $this->assertSame(4, core_text::strlen($str, 'GB2312'));
176         $str = pack("H*", "cce5"); // GB18030
177         $this->assertSame(1, core_text::strlen($str, 'GB18030'));
178         $str = pack("H*", "bcf2cce5d6d0cec4"); // GB18030
179         $this->assertSame(4, core_text::strlen($str, 'GB18030'));
180     }
182     /**
183      * Tests the static strtolower method.
184      */
185     public function test_strtolower() {
186         $str = "Žluťoučký koníček";
187         $low = 'žluťoučký koníček';
188         $this->assertSame($low, core_text::strtolower($str));
190         $iso2 = pack("H*", "ae6c75bb6f75e86bfd206b6f6eede8656b");
191         $this->assertSame(core_text::convert($low, 'utf-8', 'iso-8859-2'), core_text::strtolower($iso2, 'iso-8859-2'));
193         $win  = pack("H*", "8e6c759d6f75e86bfd206b6f6eede8656b");
194         $this->assertSame(core_text::convert($low, 'utf-8', 'cp1250'), core_text::strtolower($win, 'cp1250'));
196         $str = '言語設定';
197         $this->assertSame($str, core_text::strtolower($str));
199         $str = '简体中文';
200         $this->assertSame($str, core_text::strtolower($str));
202         $str = pack("H*", "1b24423840386c405f446a1b2842"); // ISO-2022-JP
203         $this->assertSame($str, core_text::strtolower($str, 'ISO-2022-JP'));
205         $str = pack("H*", "8cbe8cea90dd92e8"); // SHIFT-JIS
206         $this->assertSame($str, core_text::strtolower($str, 'SHIFT-JIS'));
208         $str = pack("H*", "bcf2cce5d6d0cec4"); // GB2312
209         $this->assertSame($str, core_text::strtolower($str, 'GB2312'));
211         $str = pack("H*", "bcf2cce5d6d0cec4"); // GB18030
212         $this->assertSame($str, core_text::strtolower($str, 'GB18030'));
214         // Typo3 has problems with integers.
215         $str = 1309528800;
216         $this->assertSame((string)$str, core_text::strtolower($str));
217     }
219     /**
220      * Tests the static strtoupper.
221      */
222     public function test_strtoupper() {
223         $str = "Žluťoučký koníček";
224         $up  = 'ŽLUŤOUČKÝ KONÍČEK';
225         $this->assertSame($up, core_text::strtoupper($str));
227         $iso2 = pack("H*", "ae6c75bb6f75e86bfd206b6f6eede8656b");
228         $this->assertSame(core_text::convert($up, 'utf-8', 'iso-8859-2'), core_text::strtoupper($iso2, 'iso-8859-2'));
230         $win  = pack("H*", "8e6c759d6f75e86bfd206b6f6eede8656b");
231         $this->assertSame(core_text::convert($up, 'utf-8', 'cp1250'), core_text::strtoupper($win, 'cp1250'));
233         $str = '言語設定';
234         $this->assertSame($str, core_text::strtoupper($str));
236         $str = '简体中文';
237         $this->assertSame($str, core_text::strtoupper($str));
239         $str = pack("H*", "1b24423840386c405f446a1b2842"); // ISO-2022-JP
240         $this->assertSame($str, core_text::strtoupper($str, 'ISO-2022-JP'));
242         $str = pack("H*", "8cbe8cea90dd92e8"); // SHIFT-JIS
243         $this->assertSame($str, core_text::strtoupper($str, 'SHIFT-JIS'));
245         $str = pack("H*", "bcf2cce5d6d0cec4"); // GB2312
246         $this->assertSame($str, core_text::strtoupper($str, 'GB2312'));
248         $str = pack("H*", "bcf2cce5d6d0cec4"); // GB18030
249         $this->assertSame($str, core_text::strtoupper($str, 'GB18030'));
250     }
252     /**
253      * Tests the static strpos method.
254      */
255     public function test_strpos() {
256         $str = "Žluťoučký koníček";
257         $this->assertSame(10, core_text::strpos($str, 'koníč'));
258     }
260     /**
261      * Tests the static strrpos.
262      */
263     public function test_strrpos() {
264         $str = "Žluťoučký koníček";
265         $this->assertSame(11, core_text::strrpos($str, 'o'));
266     }
268     /**
269      * Tests the static specialtoascii method.
270      */
271     public function test_specialtoascii() {
272         $str = "Žluťoučký koníček";
273         $this->assertSame('Zlutoucky konicek', core_text::specialtoascii($str));
274     }
276     /**
277      * Tests the static encode_mimeheader method.
278      */
279     public function test_encode_mimeheader() {
280         $str = "Žluťoučký koníček";
281         $this->assertSame('=?utf-8?B?xb1sdcWlb3XEjWvDvSBrb27DrcSNZWs=?=', core_text::encode_mimeheader($str));
282     }
284     /**
285      * Tests the static entities_to_utf8 method.
286      */
287     public function test_entities_to_utf8() {
288         $str = "&#x17d;lu&#x165;ou&#x10d;k&#xfd; kon&iacute;&#269;ek&copy;&quot;&amp;&lt;&gt;&sect;&laquo;";
289         $this->assertSame("Žluťoučký koníček©\"&<>§«", core_text::entities_to_utf8($str));
290     }
292     /**
293      * Tests the static utf8_to_entities method.
294      */
295     public function test_utf8_to_entities() {
296         $str = "&#x17d;luťoučký kon&iacute;ček&copy;&quot;&amp;&lt;&gt;&sect;&laquo;";
297         $this->assertSame("&#x17d;lu&#x165;ou&#x10d;k&#xfd; kon&iacute;&#x10d;ek&copy;&quot;&amp;&lt;&gt;&sect;&laquo;", core_text::utf8_to_entities($str));
298         $this->assertSame("&#381;lu&#357;ou&#269;k&#253; kon&iacute;&#269;ek&copy;&quot;&amp;&lt;&gt;&sect;&laquo;", core_text::utf8_to_entities($str, true));
300         $str = "&#381;luťoučký kon&iacute;ček&copy;&quot;&amp;&lt;&gt;&sect;&laquo;";
301         $this->assertSame("&#x17d;lu&#x165;ou&#x10d;k&#xfd; kon&#xed;&#x10d;ek&#xa9;\"&<>&#xa7;&#xab;", core_text::utf8_to_entities($str, false, true));
302         $this->assertSame("&#381;lu&#357;ou&#269;k&#253; kon&#237;&#269;ek&#169;\"&<>&#167;&#171;", core_text::utf8_to_entities($str, true, true));
303     }
305     /**
306      * Tests the static trim_utf8_bom method.
307      */
308     public function test_trim_utf8_bom() {
309         $bom = "\xef\xbb\xbf";
310         $str = "Žluťoučký koníček";
311         $this->assertSame($str.$bom, core_text::trim_utf8_bom($bom.$str.$bom));
312     }
314     /**
315      * Tests the static get_encodings method.
316      */
317     public function test_get_encodings() {
318         $encodings = core_text::get_encodings();
319         $this->assertTrue(is_array($encodings));
320         $this->assertTrue(count($encodings) > 1);
321         $this->assertTrue(isset($encodings['UTF-8']));
322     }
324     /**
325      * Tests the static code2utf8 method.
326      */
327     public function test_code2utf8() {
328         $this->assertSame('Ž', core_text::code2utf8(381));
329     }
331     /**
332      * Tests the static utf8ord method.
333      */
334     public function test_utf8ord() {
335         $this->assertSame(ord(''), core_text::utf8ord(''));
336         $this->assertSame(ord('f'), core_text::utf8ord('f'));
337         $this->assertSame(0x03B1, core_text::utf8ord('α'));
338         $this->assertSame(0x0439, core_text::utf8ord('й'));
339         $this->assertSame(0x2FA1F, core_text::utf8ord('𯨟'));
340         $this->assertSame(381, core_text::utf8ord('Ž'));
341     }
343     /**
344      * Tests the static strtotitle method.
345      */
346     public function test_strtotitle() {
347         $str = "žluťoučký koníček";
348         $this->assertSame("Žluťoučký Koníček", core_text::strtotitle($str));
349     }
351     public function test_deprecated_textlib() {
352         $this->assertSame(textlib::strtolower('HUH'), core_text::strtolower('HUH'));
353         $this->assertDebuggingCalled(null, null, 'This fails if any other test uses the deprecated textlib class.');
354     }
356     /**
357      * Tests the deprecated method of textlib that still require an instance.
358      */
359     public function test_deprecated_textlib_get_instance() {
360         $textlib = textlib_get_instance();
361         $this->assertDebuggingCalled();
362         $this->assertSame($textlib->substr('abc', 1, 1), 'b');
363         $this->assertSame($textlib->strlen('abc'), 3);
364         $this->assertSame($textlib->strtoupper('Abc'), 'ABC');
365         $this->assertSame($textlib->strtolower('Abc'), 'abc');
366         $this->assertSame($textlib->strpos('abc', 'a'), 0);
367         $this->assertSame($textlib->strpos('abc', 'd'), false);
368         $this->assertSame($textlib->strrpos('abcabc', 'a'), 3);
369         $this->assertSame($textlib->specialtoascii('ábc'), 'abc');
370         $this->assertSame($textlib->strtotitle('abc ABC'), 'Abc Abc');
371     }
373     /**
374      * Test strrchr.
375      */
376     public function test_strrchr() {
377         $str = "Žluťoučký koníček";
378         $this->assertSame('koníček', core_text::strrchr($str, 'koní'));
379         $this->assertSame('Žluťoučký ', core_text::strrchr($str, 'koní', true));
380         $this->assertFalse(core_text::strrchr($str, 'A'));
381         $this->assertFalse(core_text::strrchr($str, 'ç', true));
382     }