lib/tests/weblib_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/>.
  16
  17 /**
  18  * These tests rely on the rsstest.xml file on download.moodle.org,
  19  * from eloys listing:
  20  *   rsstest.xml: One valid rss feed.
  21  *   md5:  8fd047914863bf9b3a4b1514ec51c32c
  22  *   size: 32188
  23  *
  24  * If networking/proxy configuration is wrong these tests will fail..
  25  *
  26  * @package    core
  27  * @category   phpunit
  28  * @copyright  &copy; 2006 The Open University
  29  * @author     T.J.Hunt@open.ac.uk
  30  * @license    http://www.gnu.org/copyleft/gpl.html GNU Public License
  31  */
  32
  33 defined('MOODLE_INTERNAL') || die();
  34
  35
  36 class core_weblib_testcase extends advanced_testcase {
  37
  38     public function test_format_string() {
  39         global $CFG;
  40
  41         // Ampersands.
  42         $this->assertSame("&amp; &amp;&amp;&amp;&amp;&amp; &amp;&amp;", format_string("& &&&&& &&"));
  43         $this->assertSame("ANother &amp; &amp;&amp;&amp;&amp;&amp; Category", format_string("ANother & &&&&& Category"));
  44         $this->assertSame("ANother &amp; &amp;&amp;&amp;&amp;&amp; Category", format_string("ANother & &&&&& Category", true));
  45         $this->assertSame("Nick's Test Site &amp; Other things", format_string("Nick's Test Site & Other things", true));
  46
  47         // String entities.
  48         $this->assertSame("&quot;", format_string("&quot;"));
  49
  50         // Digital entities.
  51         $this->assertSame("&11234;", format_string("&11234;"));
  52
  53         // Unicode entities.
  54         $this->assertSame("&#4475;", format_string("&#4475;"));
  55
  56         // < and > signs.
  57         $originalformatstringstriptags = $CFG->formatstringstriptags;
  58
  59         $CFG->formatstringstriptags = false;
  60         $this->assertSame('x &lt; 1', format_string('x < 1'));
  61         $this->assertSame('x &gt; 1', format_string('x > 1'));
  62         $this->assertSame('x &lt; 1 and x &gt; 0', format_string('x < 1 and x > 0'));
  63
  64         $CFG->formatstringstriptags = true;
  65         $this->assertSame('x &lt; 1', format_string('x < 1'));
  66         $this->assertSame('x &gt; 1', format_string('x > 1'));
  67         $this->assertSame('x &lt; 1 and x &gt; 0', format_string('x < 1 and x > 0'));
  68
  69         $CFG->formatstringstriptags = $originalformatstringstriptags;
  70     }
  71
  72     public function test_s() {
  73         // Special cases.
  74         $this->assertSame('0', s(0));
  75         $this->assertSame('0', s('0'));
  76         $this->assertSame('0', s(false));
  77         $this->assertSame('', s(null));
  78
  79         // Normal cases.
  80         $this->assertSame('This Breaks &quot; Strict', s('This Breaks " Strict'));
  81         $this->assertSame('This Breaks &lt;a&gt;&quot; Strict&lt;/a&gt;', s('This Breaks <a>" Strict</a>'));
  82
  83         // Unicode characters.
  84         $this->assertSame('Café', s('Café'));
  85         $this->assertSame('一, 二, 三', s('一, 二, 三'));
  86
  87         // Don't escape already-escaped numeric entities. (Note, this behaviour
  88         // may not be desirable. Perhaps we should remove these tests and that
  89         // functionality, but we can only do that if we understand why it was added.)
  90         $this->assertSame('An entity: &#x09ff;.', s('An entity: &#x09ff;.'));
  91         $this->assertSame('An entity: &#1073;.', s('An entity: &#1073;.'));
  92         $this->assertSame('An entity: &amp;amp;.', s('An entity: &amp;.'));
  93         $this->assertSame('Not an entity: &amp;amp;#x09ff;.', s('Not an entity: &amp;#x09ff;.'));
  94     }
  95
  96     public function test_format_text_email() {
  97         $this->assertSame("This is a TEST",
  98             format_text_email('<p>This is a <strong>test</strong></p>', FORMAT_HTML));
  99         $this->assertSame("This is a TEST",
 100             format_text_email('<p class="frogs">This is a <strong class=\'fishes\'>test</strong></p>', FORMAT_HTML));
 101         $this->assertSame('& so is this',
 102             format_text_email('&amp; so is this', FORMAT_HTML));
 103         $this->assertSame('Two bullets: '.core_text::code2utf8(8226).' *',
 104             format_text_email('Two bullets: &#x2022; &#8226;', FORMAT_HTML));
 105         $this->assertSame(core_text::code2utf8(0x7fd2).core_text::code2utf8(0x7fd2),
 106             format_text_email('&#x7fd2;&#x7FD2;', FORMAT_HTML));
 107     }
 108
 109     public function test_obfuscate_email() {
 110         $email = 'some.user@example.com';
 111         $obfuscated = obfuscate_email($email);
 112         $this->assertNotSame($email, $obfuscated);
 113         $back = core_text::entities_to_utf8(urldecode($email), true);
 114         $this->assertSame($email, $back);
 115     }
 116
 117     public function test_obfuscate_text() {
 118         $text = 'Žluťoučký koníček 32131';
 119         $obfuscated = obfuscate_text($text);
 120         $this->assertNotSame($text, $obfuscated);
 121         $back = core_text::entities_to_utf8($obfuscated, true);
 122         $this->assertSame($text, $back);
 123     }
 124
 125     public function test_highlight() {
 126         $this->assertSame('This is <span class="highlight">good</span>', highlight('good', 'This is good'));
 127         $this->assertSame('<span class="highlight">span</span>', highlight('SpaN', 'span'));
 128         $this->assertSame('<span class="highlight">SpaN</span>', highlight('span', 'SpaN'));
 129         $this->assertSame('<span><span class="highlight">span</span></span>', highlight('span', '<span>span</span>'));
 130         $this->assertSame('He <span class="highlight">is</span> <span class="highlight">good</span>', highlight('good is', 'He is good'));
 131         $this->assertSame('This is <span class="highlight">good</span>', highlight('+good', 'This is good'));
 132         $this->assertSame('This is good', highlight('-good', 'This is good'));
 133         $this->assertSame('This is goodness', highlight('+good', 'This is goodness'));
 134         $this->assertSame('This is <span class="highlight">good</span>ness', highlight('good', 'This is goodness'));
 135     }
 136
 137     public function test_replace_ampersands() {
 138         $this->assertSame("This &amp; that &nbsp;", replace_ampersands_not_followed_by_entity("This & that &nbsp;"));
 139         $this->assertSame("This &amp;nbsp that &nbsp;", replace_ampersands_not_followed_by_entity("This &nbsp that &nbsp;"));
 140     }
 141
 142     public function test_strip_links() {
 143         $this->assertSame('this is a link', strip_links('this is a <a href="http://someaddress.com/query">link</a>'));
 144     }
 145
 146     public function test_wikify_links() {
 147         $this->assertSame('this is a link [ http://someaddress.com/query ]', wikify_links('this is a <a href="http://someaddress.com/query">link</a>'));
 148     }
 149
 150     /**
 151      * Test basic moodle_url construction.
 152      */
 153     public function test_moodle_url_constructor() {
 154         global $CFG;
 155
 156         $url = new moodle_url('/index.php');
 157         $this->assertSame($CFG->wwwroot.'/index.php', $url->out());
 158
 159         $url = new moodle_url('/index.php', array());
 160         $this->assertSame($CFG->wwwroot.'/index.php', $url->out());
 161
 162         $url = new moodle_url('/index.php', array('id' => 2));
 163         $this->assertSame($CFG->wwwroot.'/index.php?id=2', $url->out());
 164
 165         $url = new moodle_url('/index.php', array('id' => 'two'));
 166         $this->assertSame($CFG->wwwroot.'/index.php?id=two', $url->out());
 167
 168         $url = new moodle_url('/index.php', array('id' => 1, 'cid' => '2'));
 169         $this->assertSame($CFG->wwwroot.'/index.php?id=1&amp;cid=2', $url->out());
 170         $this->assertSame($CFG->wwwroot.'/index.php?id=1&cid=2', $url->out(false));
 171
 172         $url = new moodle_url('/index.php', null, 'test');
 173         $this->assertSame($CFG->wwwroot.'/index.php#test', $url->out());
 174
 175         $url = new moodle_url('/index.php', array('id' => 2), 'test');
 176         $this->assertSame($CFG->wwwroot.'/index.php?id=2#test', $url->out());
 177     }
 178
 179     /**
 180      * Tests moodle_url::get_path().
 181      */
 182     public function test_moodle_url_get_path() {
 183         $url = new moodle_url('http://www.example.org:447/my/file/is/here.txt?really=1');
 184         $this->assertSame('/my/file/is/here.txt', $url->get_path());
 185
 186         $url = new moodle_url('http://www.example.org/');
 187         $this->assertSame('/', $url->get_path());
 188
 189         $url = new moodle_url('http://www.example.org/pluginfile.php/slash/arguments');
 190         $this->assertSame('/pluginfile.php/slash/arguments', $url->get_path());
 191         $this->assertSame('/pluginfile.php', $url->get_path(false));
 192     }
 193
 194     public function test_moodle_url_round_trip() {
 195         $strurl = 'http://moodle.org/course/view.php?id=5';
 196         $url = new moodle_url($strurl);
 197         $this->assertSame($strurl, $url->out(false));
 198
 199         $strurl = 'http://moodle.org/user/index.php?contextid=53&sifirst=M&silast=D';
 200         $url = new moodle_url($strurl);
 201         $this->assertSame($strurl, $url->out(false));
 202     }
 203
 204     /**
 205      * Test Moodle URL objects created with a param with empty value.
 206      */
 207     public function test_moodle_url_empty_param_values() {
 208         $strurl = 'http://moodle.org/course/view.php?id=0';
 209         $url = new moodle_url($strurl, array('id' => 0));
 210         $this->assertSame($strurl, $url->out(false));
 211
 212         $strurl = 'http://moodle.org/course/view.php?id';
 213         $url = new moodle_url($strurl, array('id' => false));
 214         $this->assertSame($strurl, $url->out(false));
 215
 216         $strurl = 'http://moodle.org/course/view.php?id';
 217         $url = new moodle_url($strurl, array('id' => null));
 218         $this->assertSame($strurl, $url->out(false));
 219
 220         $strurl = 'http://moodle.org/course/view.php?id';
 221         $url = new moodle_url($strurl, array('id' => ''));
 222         $this->assertSame($strurl, $url->out(false));
 223
 224         $strurl = 'http://moodle.org/course/view.php?id';
 225         $url = new moodle_url($strurl);
 226         $this->assertSame($strurl, $url->out(false));
 227     }
 228
 229     public function test_moodle_url_round_trip_array_params() {
 230         $strurl = 'http://example.com/?a%5B1%5D=1&a%5B2%5D=2';
 231         $url = new moodle_url($strurl);
 232         $this->assertSame($strurl, $url->out(false));
 233
 234         $url = new moodle_url('http://example.com/?a[1]=1&a[2]=2');
 235         $this->assertSame($strurl, $url->out(false));
 236
 237         // For un-keyed array params, we expect 0..n keys to be returned.
 238         $strurl = 'http://example.com/?a%5B0%5D=0&a%5B1%5D=1';
 239         $url = new moodle_url('http://example.com/?a[]=0&a[]=1');
 240         $this->assertSame($strurl, $url->out(false));
 241     }
 242
 243     public function test_compare_url() {
 244         $url1 = new moodle_url('index.php', array('var1' => 1, 'var2' => 2));
 245         $url2 = new moodle_url('index2.php', array('var1' => 1, 'var2' => 2, 'var3' => 3));
 246
 247         $this->assertFalse($url1->compare($url2, URL_MATCH_BASE));
 248         $this->assertFalse($url1->compare($url2, URL_MATCH_PARAMS));
 249         $this->assertFalse($url1->compare($url2, URL_MATCH_EXACT));
 250
 251         $url2 = new moodle_url('index.php', array('var1' => 1, 'var3' => 3));
 252
 253         $this->assertTrue($url1->compare($url2, URL_MATCH_BASE));
 254         $this->assertFalse($url1->compare($url2, URL_MATCH_PARAMS));
 255         $this->assertFalse($url1->compare($url2, URL_MATCH_EXACT));
 256
 257         $url2 = new moodle_url('index.php', array('var1' => 1, 'var2' => 2, 'var3' => 3));
 258
 259         $this->assertTrue($url1->compare($url2, URL_MATCH_BASE));
 260         $this->assertTrue($url1->compare($url2, URL_MATCH_PARAMS));
 261         $this->assertFalse($url1->compare($url2, URL_MATCH_EXACT));
 262
 263         $url2 = new moodle_url('index.php', array('var2' => 2, 'var1' => 1));
 264
 265         $this->assertTrue($url1->compare($url2, URL_MATCH_BASE));
 266         $this->assertTrue($url1->compare($url2, URL_MATCH_PARAMS));
 267         $this->assertTrue($url1->compare($url2, URL_MATCH_EXACT));
 268     }
 269
 270     public function test_out_as_local_url() {
 271         global $CFG;
 272         // Test http url.
 273         $url1 = new moodle_url('/lib/tests/weblib_test.php');
 274         $this->assertSame('/lib/tests/weblib_test.php', $url1->out_as_local_url());
 275
 276         // Test https url.
 277         $httpswwwroot = str_replace("http://", "https://", $CFG->wwwroot);
 278         $url2 = new moodle_url($httpswwwroot.'/login/profile.php');
 279         $this->assertSame('/login/profile.php', $url2->out_as_local_url());
 280
 281         // Test http url matching wwwroot.
 282         $url3 = new moodle_url($CFG->wwwroot);
 283         $this->assertSame('', $url3->out_as_local_url());
 284
 285         // Test http url matching wwwroot ending with slash (/).
 286         $url3 = new moodle_url($CFG->wwwroot.'/');
 287         $this->assertSame('/', $url3->out_as_local_url());
 288     }
 289
 290     /**
 291      * @expectedException coding_exception
 292      * @return void
 293      */
 294     public function test_out_as_local_url_error() {
 295         $url2 = new moodle_url('http://www.google.com/lib/tests/weblib_test.php');
 296         $url2->out_as_local_url();
 297     }
 298
 299     /**
 300      * You should get error with modified url
 301      *
 302      * @expectedException coding_exception
 303      * @return void
 304      */
 305     public function test_modified_url_out_as_local_url_error() {
 306         global $CFG;
 307
 308         $modifiedurl = $CFG->wwwroot.'1';
 309         $url3 = new moodle_url($modifiedurl.'/login/profile.php');
 310         $url3->out_as_local_url();
 311     }
 312
 313     /**
 314      * Try get local url from external https url and you should get error
 315      *
 316      * @expectedException coding_exception
 317      */
 318     public function test_https_out_as_local_url_error() {
 319         $url4 = new moodle_url('https://www.google.com/lib/tests/weblib_test.php');
 320         $url4->out_as_local_url();
 321     }
 322
 323     public function test_clean_text() {
 324         $text = "lala <applet>xx</applet>";
 325         $this->assertSame($text, clean_text($text, FORMAT_PLAIN));
 326         $this->assertSame('lala xx', clean_text($text, FORMAT_MARKDOWN));
 327         $this->assertSame('lala xx', clean_text($text, FORMAT_MOODLE));
 328         $this->assertSame('lala xx', clean_text($text, FORMAT_HTML));
 329     }
 330
 331     public function test_qualified_me() {
 332         global $PAGE, $FULLME, $CFG;
 333         $this->resetAfterTest();
 334
 335         $PAGE = new moodle_page();
 336
 337         $FULLME = $CFG->wwwroot.'/course/view.php?id=1&xx=yy';
 338         $this->assertSame($FULLME, qualified_me());
 339
 340         $PAGE->set_url('/course/view.php', array('id'=>1));
 341         $this->assertSame($CFG->wwwroot.'/course/view.php?id=1', qualified_me());
 342     }
 343
 344     public function test_null_progres_trace() {
 345         $this->resetAfterTest(false);
 346
 347         $trace = new null_progress_trace();
 348         $trace->output('do');
 349         $trace->output('re', 1);
 350         $trace->output('mi', 2);
 351         $trace->finished();
 352         $output = ob_get_contents();
 353         $this->assertSame('', $output);
 354         $this->expectOutputString('');
 355     }
 356
 357     public function test_text_progres_trace() {
 358         $this->resetAfterTest(false);
 359
 360         $trace = new text_progress_trace();
 361         $trace->output('do');
 362         $trace->output('re', 1);
 363         $trace->output('mi', 2);
 364         $trace->finished();
 365         $this->expectOutputString("do\n  re\n    mi\n");
 366     }
 367
 368     public function test_html_progres_trace() {
 369         $this->resetAfterTest(false);
 370
 371         $trace = new html_progress_trace();
 372         $trace->output('do');
 373         $trace->output('re', 1);
 374         $trace->output('mi', 2);
 375         $trace->finished();
 376         $this->expectOutputString("<p>do</p>\n<p>&#160;&#160;re</p>\n<p>&#160;&#160;&#160;&#160;mi</p>\n");
 377     }
 378
 379     public function test_html_list_progress_trace() {
 380         $this->resetAfterTest(false);
 381
 382         $trace = new html_list_progress_trace();
 383         $trace->output('do');
 384         $trace->output('re', 1);
 385         $trace->output('mi', 2);
 386         $trace->finished();
 387         $this->expectOutputString("<ul>\n<li>do<ul>\n<li>re<ul>\n<li>mi</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n");
 388     }
 389
 390     public function test_progres_trace_buffer() {
 391         $this->resetAfterTest(false);
 392
 393         $trace = new progress_trace_buffer(new html_progress_trace());
 394         ob_start();
 395         $trace->output('do');
 396         $trace->output('re', 1);
 397         $trace->output('mi', 2);
 398         $trace->finished();
 399         $output = ob_get_contents();
 400         ob_end_clean();
 401         $this->assertSame("<p>do</p>\n<p>&#160;&#160;re</p>\n<p>&#160;&#160;&#160;&#160;mi</p>\n", $output);
 402         $this->assertSame($output, $trace->get_buffer());
 403
 404         $trace = new progress_trace_buffer(new html_progress_trace(), false);
 405         $trace->output('do');
 406         $trace->output('re', 1);
 407         $trace->output('mi', 2);
 408         $trace->finished();
 409         $this->assertSame("<p>do</p>\n<p>&#160;&#160;re</p>\n<p>&#160;&#160;&#160;&#160;mi</p>\n", $trace->get_buffer());
 410         $this->assertSame("<p>do</p>\n<p>&#160;&#160;re</p>\n<p>&#160;&#160;&#160;&#160;mi</p>\n", $trace->get_buffer());
 411         $trace->reset_buffer();
 412         $this->assertSame('', $trace->get_buffer());
 413         $this->expectOutputString('');
 414     }
 415
 416     public function test_combined_progres_trace() {
 417         $this->resetAfterTest(false);
 418
 419         $trace1 = new progress_trace_buffer(new html_progress_trace(), false);
 420         $trace2 = new progress_trace_buffer(new text_progress_trace(), false);
 421
 422         $trace = new combined_progress_trace(array($trace1, $trace2));
 423         $trace->output('do');
 424         $trace->output('re', 1);
 425         $trace->output('mi', 2);
 426         $trace->finished();
 427         $this->assertSame("<p>do</p>\n<p>&#160;&#160;re</p>\n<p>&#160;&#160;&#160;&#160;mi</p>\n", $trace1->get_buffer());
 428         $this->assertSame("do\n  re\n    mi\n", $trace2->get_buffer());
 429         $this->expectOutputString('');
 430     }
 431
 432     public function test_set_debugging() {
 433         global $CFG;
 434
 435         $this->resetAfterTest();
 436
 437         $this->assertEquals(DEBUG_DEVELOPER, $CFG->debug);
 438         $this->assertTrue($CFG->debugdeveloper);
 439         $this->assertNotEmpty($CFG->debugdisplay);
 440
 441         set_debugging(DEBUG_DEVELOPER, true);
 442         $this->assertEquals(DEBUG_DEVELOPER, $CFG->debug);
 443         $this->assertTrue($CFG->debugdeveloper);
 444         $this->assertNotEmpty($CFG->debugdisplay);
 445
 446         set_debugging(DEBUG_DEVELOPER, false);
 447         $this->assertEquals(DEBUG_DEVELOPER, $CFG->debug);
 448         $this->assertTrue($CFG->debugdeveloper);
 449         $this->assertEmpty($CFG->debugdisplay);
 450
 451         set_debugging(-1);
 452         $this->assertEquals(-1, $CFG->debug);
 453         $this->assertTrue($CFG->debugdeveloper);
 454
 455         set_debugging(DEBUG_ALL);
 456         $this->assertEquals(DEBUG_ALL, $CFG->debug);
 457         $this->assertFalse($CFG->debugdeveloper);
 458
 459         set_debugging(DEBUG_NORMAL);
 460         $this->assertEquals(DEBUG_NORMAL, $CFG->debug);
 461         $this->assertFalse($CFG->debugdeveloper);
 462
 463         set_debugging(DEBUG_MINIMAL);
 464         $this->assertEquals(DEBUG_MINIMAL, $CFG->debug);
 465         $this->assertFalse($CFG->debugdeveloper);
 466
 467         set_debugging(DEBUG_NONE);
 468         $this->assertEquals(DEBUG_NONE, $CFG->debug);
 469         $this->assertFalse($CFG->debugdeveloper);
 470     }
 471 }