Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
- Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/lib/tests/ -> weblib_test.php (source)
<?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/>. /** * Weblib tests. * * @package core * @category phpunit * @copyright © 2006 The Open University * @author T.J.Hunt@open.ac.uk * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */<class weblib_test extends advanced_testcase {</** * @covers ::format_string */ public function test_format_string() { global $CFG; // Ampersands. $this->assertSame("& &&&&& &&", format_string("& &&&&& &&")); $this->assertSame("ANother & &&&&& Category", format_string("ANother & &&&&& Category")); $this->assertSame("ANother & &&&&& Category", format_string("ANother & &&&&& Category", true)); $this->assertSame("Nick's Test Site & Other things", format_string("Nick's Test Site & Other things", true)); $this->assertSame("& < > \" '", format_string("& < > \" '", true, ['escape' => false])); // String entities. $this->assertSame(""", format_string(""")); // Digital entities. $this->assertSame("&11234;", format_string("&11234;")); // Unicode entities. $this->assertSame("ᅻ", format_string("ᅻ"));> // Nulls. // < and > signs. > $this->assertSame('', format_string(null)); $originalformatstringstriptags = $CFG->formatstringstriptags; > $this->assertSame('', format_string(null, true, ['escape' => false])); >$CFG->formatstringstriptags = false; $this->assertSame('x < 1', format_string('x < 1')); $this->assertSame('x > 1', format_string('x > 1')); $this->assertSame('x < 1 and x > 0', format_string('x < 1 and x > 0')); $CFG->formatstringstriptags = true; $this->assertSame('x < 1', format_string('x < 1')); $this->assertSame('x > 1', format_string('x > 1')); $this->assertSame('x < 1 and x > 0', format_string('x < 1 and x > 0')); $CFG->formatstringstriptags = $originalformatstringstriptags; } /** * The format string static caching should include the filters option to make * sure filters are correctly applied when requested. */ public function test_format_string_static_caching_with_filters() { global $CFG; $this->resetAfterTest(true); $this->setAdminUser(); $generator = $this->getDataGenerator(); $course = $generator->create_course(); $user = $generator->create_user(); $rawstring = '<span lang="en" class="multilang">English</span><span lang="ca" class="multilang">Catalan</span>'; $expectednofilter = strip_tags($rawstring); $expectedfilter = 'English'; $striplinks = true; $context = context_course::instance($course->id); $options = [ 'context' => $context, 'escape' => true, 'filter' => false ]; $this->setUser($user); // Format the string without filters. It should just strip the // links. $nofilterresult = format_string($rawstring, $striplinks, $options); $this->assertEquals($expectednofilter, $nofilterresult); // Add the multilang filter. Make sure it's enabled globally. $CFG->filterall = true; $CFG->stringfilters = 'multilang'; filter_set_global_state('multilang', TEXTFILTER_ON); filter_set_local_state('multilang', $context->id, TEXTFILTER_ON); // This time we want to apply the filters. $options['filter'] = true; $filterresult = format_string($rawstring, $striplinks, $options); $this->assertMatchesRegularExpression("/$expectedfilter/", $filterresult); filter_set_local_state('multilang', $context->id, TEXTFILTER_OFF); // Confirm that we get back the cached string. The result should be // the same as the filtered text above even though we've disabled the // multilang filter in between. $cachedresult = format_string($rawstring, $striplinks, $options); $this->assertMatchesRegularExpression("/$expectedfilter/", $cachedresult); } /** * @covers ::s */ public function test_s() { // Special cases. $this->assertSame('0', s(0)); $this->assertSame('0', s('0')); $this->assertSame('0', s(false)); $this->assertSame('', s(null)); // Normal cases. $this->assertSame('This Breaks " Strict', s('This Breaks " Strict')); $this->assertSame('This Breaks <a>" Strict</a>', s('This Breaks <a>" Strict</a>')); // Unicode characters. $this->assertSame('Café', s('Café')); $this->assertSame('一, 二, 三', s('一, 二, 三')); // Don't escape already-escaped numeric entities. (Note, this behaviour // may not be desirable. Perhaps we should remove these tests and that // functionality, but we can only do that if we understand why it was added.) $this->assertSame('An entity: ৿.', s('An entity: ৿.')); $this->assertSame('An entity: б.', s('An entity: б.')); $this->assertSame('An entity: &amp;.', s('An entity: &.')); $this->assertSame('Not an entity: &amp;#x09ff;.', s('Not an entity: &#x09ff;.')); // Test all ASCII characters (0-127). for ($i = 0; $i <= 127; $i++) { $character = chr($i); $result = s($character); switch ($character) { case '"' : $this->assertSame('"', $result); break; case '&' : $this->assertSame('&', $result); break; case "'" : $this->assertSame(''', $result); break; case '<' : $this->assertSame('<', $result); break; case '>' : $this->assertSame('>', $result); break; default: $this->assertSame($character, $result); break; } } } /**> * Test the format_string illegal options handling. * @covers ::format_text_email > * */ > * @covers ::format_string public function test_format_text_email() { > * @dataProvider format_string_illegal_options_provider $this->assertSame("This is a TEST\n", > */ format_text_email('<p>This is a <strong>test</strong></p>', FORMAT_HTML)); > public function test_format_string_illegal_options( $this->assertSame("This is a TEST\n", > string $input, format_text_email('<p class="frogs">This is a <strong class=\'fishes\'>test</strong></p>', FORMAT_HTML)); > string $result, $this->assertSame('& so is this', > mixed $options, format_text_email('& so is this', FORMAT_HTML)); > string $pattern, $this->assertSame('Two bullets: ' . core_text::code2utf8(8226) . ' ' . core_text::code2utf8(8226), > ): void { format_text_email('Two bullets: • •', FORMAT_HTML)); > $this->assertEquals( $this->assertSame(core_text::code2utf8(0x7fd2).core_text::code2utf8(0x7fd2), > $result, format_text_email('習習', FORMAT_HTML)); > format_string($input, false, $options), } > ); > /** > $messages = $this->getDebuggingMessages(); * @covers ::obfuscate_email > $this->assertdebuggingcalledcount(1); */ > $this->assertMatchesRegularExpression( public function test_obfuscate_email() { > "/{$pattern}/", $email = 'some.user@example.com'; > $messages[0]->message, $obfuscated = obfuscate_email($email); > ); $this->assertNotSame($email, $obfuscated); > } $back = core_text::entities_to_utf8(urldecode($email), true); > $this->assertSame($email, $back); > /** } > * Data provider for test_format_string_illegal_options. > * @return array /** > */ * @covers ::obfuscate_text > public static function format_string_illegal_options_provider(): array { */ > return [ public function test_obfuscate_text() { > [ $text = 'Žluťoučký koníček 32131'; > 'Example', $obfuscated = obfuscate_text($text); > 'Example', $this->assertNotSame($text, $obfuscated); > \core\context\system::instance(), $back = core_text::entities_to_utf8($obfuscated, true); > preg_quote('The options argument should not be a context object directly.'), $this->assertSame($text, $back); > ], } > [ > 'Example', /** > 'Example', * @covers ::highlight > true, */ > preg_quote('The options argument should be an Array, or stdclass. boolean passed.'), public function test_highlight() { > ], $this->assertSame('This is <span class="highlight">good</span>', > [ highlight('good', 'This is good')); > 'Example', > 'Example', $this->assertSame('<span class="highlight">span</span>', > false, highlight('SpaN', 'span')); > preg_quote('The options argument should be an Array, or stdclass. boolean passed.'), > ], $this->assertSame('<span class="highlight">SpaN</span>', > ]; highlight('span', 'SpaN')); > } > $this->assertSame('<span><span class="highlight">span</span></span>', > /** highlight('span', '<span>span</span>')); > * Ensure that if format_string is called with a context as the third param, that a debugging notice is emitted. > * $this->assertSame('He <span class="highlight">is</span> <span class="highlight">good</span>', > * @covers ::format_string highlight('good is', 'He is good')); > */ > public function test_format_string_context(): void { $this->assertSame('This is <span class="highlight">good</span>', > global $CFG; highlight('+good', 'This is good')); > > $this->resetAfterTest(true); $this->assertSame('This is good', > highlight('-good', 'This is good')); > // Disable the formatstringstriptags option to ensure that the HTML tags are not stripped. > $CFG->stringfilters = 'multilang'; $this->assertSame('This is goodness', > highlight('+good', 'This is goodness')); > // Enable filters. > $CFG->filterall = true; $this->assertSame('This is <span class="highlight">good</span>ness', > highlight('good', 'This is goodness')); > $course = $this->getDataGenerator()->create_course(); > $coursecontext = \core\context\course::instance($course->id); $this->assertSame('<p><b>test</b> <b>1</b></p><p><b>1</b></p>', > highlight('test 1', '<p>test 1</p><p>1</p>', false, '<b>', '</b>')); > // Set up the multilang filter at the system context, but disable it at the course. > filter_set_global_state('multilang', TEXTFILTER_ON); $this->assertSame('<p><b>test</b> <b>1</b></p><p><b>1</b></p>', > filter_set_local_state('multilang', $coursecontext->id, TEXTFILTER_OFF); highlight('test +1', '<p>test 1</p><p>1</p>', false, '<b>', '</b>')); > > // Previously, if a context was passed, it was converted into an Array, and ignored. $this->assertSame('<p><b>test</b> 1</p><p>1</p>', > // The PAGE context was used instead -- often this is the system context. highlight('test -1', '<p>test 1</p><p>1</p>', false, '<b>', '</b>')); > $input = 'I really <span lang="en" class="multilang">do not </span><span lang="de" class="multilang">do not </span>like this!'; } > > $result = format_string( /** > $input, * @covers ::replace_ampersands_not_followed_by_entity > true, */ > $coursecontext, public function test_replace_ampersands() { > ); $this->assertSame("This & that ", replace_ampersands_not_followed_by_entity("This & that ")); > $this->assertSame("This &nbsp that ", replace_ampersands_not_followed_by_entity("This   that ")); > // We emit a debugging notice to alert that the context has been moved to the options. } > $this->assertdebuggingcalledcount(1); > /** > // Check the result was _not_ filtered. * @covers ::strip_links > $this->assertEquals( */ > // Tags are stripped out due to striptags. public function test_strip_links() { > "I really do not do not like this!", $this->assertSame('this is a link', strip_links('this is a <a href="http://someaddress.com/query">link</a>')); > $result, } > ); > /** > // But it should be filtered if called with the system context. * @covers ::wikify_links > $result = format_string( */ > $input, public function test_wikify_links() { > true, $this->assertSame('this is a link [ http://someaddress.com/query ]', wikify_links('this is a <a href="http://someaddress.com/query">link</a>')); > ['context' => \core\context\system::instance()], } > ); > $this->assertEquals( /** > 'I really do not like this!', * @covers ::clean_text > $result, */ > ); public function test_clean_text() { > } $text = "lala <applet>xx</applet>"; > $this->assertSame($text, clean_text($text, FORMAT_PLAIN)); > /**$this->assertSame('lala xx', clean_text($text, FORMAT_MARKDOWN)); $this->assertSame('lala xx', clean_text($text, FORMAT_MOODLE)); $this->assertSame('lala xx', clean_text($text, FORMAT_HTML)); } /**> * Test trusttext enabling. * @covers ::qualified_me > * */ > * @covers ::trusttext_active public function test_qualified_me() { > */ global $PAGE, $FULLME, $CFG; > public function test_trusttext_active() { $this->resetAfterTest(); > global $CFG; > $this->resetAfterTest(); $PAGE = new moodle_page(); > > $this->assertFalse(trusttext_active()); $FULLME = $CFG->wwwroot.'/course/view.php?id=1&xx=yy'; > $CFG->enabletrusttext = '1'; $this->assertSame($FULLME, qualified_me()); > $this->assertTrue(trusttext_active()); > } $PAGE->set_url('/course/view.php', array('id'=>1)); > $this->assertSame($CFG->wwwroot.'/course/view.php?id=1', qualified_me()); > /** } > * Test trusttext detection. > * /** > * @covers ::trusttext_trusted * @covers \null_progress_trace > */ */ > public function test_trusttext_trusted() { public function test_null_progress_trace() { > global $CFG; $this->resetAfterTest(false); > $this->resetAfterTest(); > $trace = new null_progress_trace(); > $syscontext = context_system::instance(); $trace->output('do'); > $course = $this->getDataGenerator()->create_course(); $trace->output('re', 1); > $coursecontext = context_course::instance($course->id); $trace->output('mi', 2); > $user1 = $this->getDataGenerator()->create_user(); $trace->finished(); > $user2 = $this->getDataGenerator()->create_user(); $output = ob_get_contents(); > $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'editingteacher'); $this->assertSame('', $output); > $this->expectOutputString(''); > $this->setAdminUser(); } > > $CFG->enabletrusttext = '0'; /** > $this->assertFalse(trusttext_trusted($syscontext)); * @covers \null_progress_trace > $this->assertFalse(trusttext_trusted($coursecontext)); */ > public function test_text_progress_trace() { > $CFG->enabletrusttext = '1'; $this->resetAfterTest(false); > $this->assertTrue(trusttext_trusted($syscontext)); > $this->assertTrue(trusttext_trusted($coursecontext)); $trace = new text_progress_trace(); > $trace->output('do'); > $this->setUser($user1); $trace->output('re', 1); > $trace->output('mi', 2); > $CFG->enabletrusttext = '0'; $trace->finished(); > $this->assertFalse(trusttext_trusted($syscontext)); $this->expectOutputString("do\n re\n mi\n"); > $this->assertFalse(trusttext_trusted($coursecontext)); } > > $CFG->enabletrusttext = '1'; /** > $this->assertFalse(trusttext_trusted($syscontext)); * @covers \html_progress_trace > $this->assertFalse(trusttext_trusted($coursecontext)); */ > public function test_html_progress_trace() { > $this->setUser($user2); $this->resetAfterTest(false); > > $CFG->enabletrusttext = '0'; $trace = new html_progress_trace(); > $this->assertFalse(trusttext_trusted($syscontext)); $trace->output('do'); > $this->assertFalse(trusttext_trusted($coursecontext)); $trace->output('re', 1); > $trace->output('mi', 2); > $CFG->enabletrusttext = '1'; $trace->finished(); > $this->assertFalse(trusttext_trusted($syscontext)); $this->expectOutputString("<p>do</p>\n<p>  re</p>\n<p>    mi</p>\n"); > $this->assertTrue(trusttext_trusted($coursecontext)); } > } > /** > /** * @covers \html_list_progress_trace > * Data provider for trusttext_pre_edit() tests. */ > */ public function test_html_list_progress_trace() { > public function trusttext_pre_edit_provider(): array { $this->resetAfterTest(false); > return [ > [true, 0, 'editingteacher', FORMAT_HTML, 1], $trace = new html_list_progress_trace(); > [true, 0, 'editingteacher', FORMAT_MOODLE, 1], $trace->output('do'); > [false, 0, 'editingteacher', FORMAT_MARKDOWN, 1], $trace->output('re', 1); > [false, 0, 'editingteacher', FORMAT_PLAIN, 1], $trace->output('mi', 2); > $trace->finished(); > [false, 1, 'editingteacher', FORMAT_HTML, 1], $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"); > [false, 1, 'editingteacher', FORMAT_MOODLE, 1], } > [false, 1, 'editingteacher', FORMAT_MARKDOWN, 1], > [false, 1, 'editingteacher', FORMAT_PLAIN, 1], /** > * @covers \progress_trace_buffer > [true, 0, 'student', FORMAT_HTML, 1], */ > [true, 0, 'student', FORMAT_MOODLE, 1], public function test_progress_trace_buffer() { > [false, 0, 'student', FORMAT_MARKDOWN, 1], $this->resetAfterTest(false); > [false, 0, 'student', FORMAT_PLAIN, 1], > $trace = new progress_trace_buffer(new html_progress_trace()); > [true, 1, 'student', FORMAT_HTML, 1], ob_start(); > [true, 1, 'student', FORMAT_MOODLE, 1], $trace->output('do'); > [false, 1, 'student', FORMAT_MARKDOWN, 1], $trace->output('re', 1); > [false, 1, 'student', FORMAT_PLAIN, 1], $trace->output('mi', 2); > ]; $trace->finished(); > } $output = ob_get_contents(); > ob_end_clean(); > /** $this->assertSame("<p>do</p>\n<p>  re</p>\n<p>    mi</p>\n", $output); > * Test text cleaning before editing. $this->assertSame($output, $trace->get_buffer()); > * > * @dataProvider trusttext_pre_edit_provider $trace = new progress_trace_buffer(new html_progress_trace(), false); > * @covers ::trusttext_pre_edit $trace->output('do'); > * $trace->output('re', 1); > * @param bool $expectedsanitised $trace->output('mi', 2); > * @param int $enabled $trace->finished(); > * @param string $rolename $this->assertSame("<p>do</p>\n<p>  re</p>\n<p>    mi</p>\n", $trace->get_buffer()); > * @param string $format $this->assertSame("<p>do</p>\n<p>  re</p>\n<p>    mi</p>\n", $trace->get_buffer()); > * @param int $trust $trace->reset_buffer(); > */ $this->assertSame('', $trace->get_buffer()); > public function test_trusttext_pre_edit(bool $expectedsanitised, int $enabled, string $rolename, $this->expectOutputString(''); > string $format, int $trust) { } > global $CFG, $DB; > $this->resetAfterTest(); /** > * @covers \combined_progress_trace > $exploit = "abc<script>alert('xss')</script> < > &"; */ > $sanitised = purify_html($exploit); public function test_combined_progress_trace() { > $this->resetAfterTest(false); > $course = $this->getDataGenerator()->create_course(); > $context = context_course::instance($course->id); $trace1 = new progress_trace_buffer(new html_progress_trace(), false); > $trace2 = new progress_trace_buffer(new text_progress_trace(), false); > $user = $this->getDataGenerator()->create_user(); > $this->getDataGenerator()->enrol_user($user->id, $course->id, $rolename); $trace = new combined_progress_trace(array($trace1, $trace2)); > $trace->output('do'); > $this->setUser($user); $trace->output('re', 1); > $trace->output('mi', 2); > $CFG->enabletrusttext = (string)$enabled; $trace->finished(); > $this->assertSame("<p>do</p>\n<p>  re</p>\n<p>    mi</p>\n", $trace1->get_buffer()); > $object = new stdClass(); $this->assertSame("do\n re\n mi\n", $trace2->get_buffer()); > $object->some = $exploit; $this->expectOutputString(''); > $object->someformat = $format; } > $object->sometrust = (string)$trust; > $result = trusttext_pre_edit(clone($object), 'some', $context); /** > * @covers ::set_debugging > if ($expectedsanitised) { */ > $message = "sanitisation is expected for: $enabled, $rolename, $format, $trust"; public function test_set_debugging() { > $this->assertSame($sanitised, $result->some, $message); global $CFG; > } else { > $message = "sanitisation is not expected for: $enabled, $rolename, $format, $trust"; $this->resetAfterTest(); > $this->assertSame($exploit, $result->some, $message); > } $this->assertEquals(DEBUG_DEVELOPER, $CFG->debug); > } $this->assertTrue($CFG->debugdeveloper); > $this->assertNotEmpty($CFG->debugdisplay); > /** > * Test removal of legacy trusttext flag. set_debugging(DEBUG_DEVELOPER, true); > * @covers ::trusttext_strip $this->assertEquals(DEBUG_DEVELOPER, $CFG->debug); > */ $this->assertTrue($CFG->debugdeveloper); > public function test_trusttext_strip() { $this->assertNotEmpty($CFG->debugdisplay); > $this->assertSame('abc', trusttext_strip('abc')); > $this->assertSame('abc', trusttext_strip('ab#####TRUSTTEXT#####c')); set_debugging(DEBUG_DEVELOPER, false); > } $this->assertEquals(DEBUG_DEVELOPER, $CFG->debug); > $this->assertTrue($CFG->debugdeveloper); > /** $this->assertEmpty($CFG->debugdisplay); > * Test trust option of format_text(). > * @covers ::format_text set_debugging(-1); > */ $this->assertEquals(-1, $CFG->debug); > public function test_format_text_trusted() { $this->assertTrue($CFG->debugdeveloper); > global $CFG; > $this->resetAfterTest(); set_debugging(DEBUG_ALL); > $this->assertEquals(DEBUG_ALL, $CFG->debug); > $text = "lala <object>xx</object>"; $this->assertFalse($CFG->debugdeveloper); > > $CFG->enabletrusttext = 0; set_debugging(DEBUG_NORMAL); > $this->assertEquals(DEBUG_NORMAL, $CFG->debug); > $this->assertSame(s($text), $this->assertFalse($CFG->debugdeveloper); > format_text($text, FORMAT_PLAIN, ['trusted' => true])); > $this->assertSame("<p>lala xx</p>\n", set_debugging(DEBUG_MINIMAL); > format_text($text, FORMAT_MARKDOWN, ['trusted' => true])); $this->assertEquals(DEBUG_MINIMAL, $CFG->debug); > $this->assertSame('<div class="text_to_html">lala xx</div>', $this->assertFalse($CFG->debugdeveloper); > format_text($text, FORMAT_MOODLE, ['trusted' => true])); > $this->assertSame('lala xx', set_debugging(DEBUG_NONE); > format_text($text, FORMAT_HTML, ['trusted' => true])); $this->assertEquals(DEBUG_NONE, $CFG->debug); > $this->assertFalse($CFG->debugdeveloper); > $this->assertSame(s($text), } > format_text($text, FORMAT_PLAIN, ['trusted' => false])); > $this->assertSame("<p>lala xx</p>\n", /** > format_text($text, FORMAT_MARKDOWN, ['trusted' => false])); * @covers ::strip_pluginfile_content > $this->assertSame('<div class="text_to_html">lala xx</div>', */ > format_text($text, FORMAT_MOODLE, ['trusted' => false])); public function test_strip_pluginfile_content() { > $this->assertSame('lala xx', $source = <<<SOURCE > format_text($text, FORMAT_HTML, ['trusted' => false])); Hello! > > $CFG->enabletrusttext = 1; I'm writing to you from the Moodle Majlis in Muscat, Oman, where we just had several days of Moodle community goodness. > > $this->assertSame(s($text), URL outside a tag: https://moodle.org/logo/logo-240x60.gif > format_text($text, FORMAT_PLAIN, ['trusted' => true])); Plugin url outside a tag: @@PLUGINFILE@@/logo-240x60.gif > $this->assertSame("<p>lala xx</p>\n", > format_text($text, FORMAT_MARKDOWN, ['trusted' => true])); External link 1:<img src='https://moodle.org/logo/logo-240x60.gif' alt='Moodle'/> > $this->assertSame('<div class="text_to_html">lala <object>xx</object></div>', External link 2:<img alt="Moodle" src="https://moodle.org/logo/logo-240x60.gif"/> > format_text($text, FORMAT_MOODLE, ['trusted' => true])); Internal link 1:<img src='@@PLUGINFILE@@/logo-240x60.gif' alt='Moodle'/> > $this->assertSame('lala <object>xx</object>', Internal link 2:<img alt="Moodle" src="@@PLUGINFILE@@logo-240x60.gif"/> > format_text($text, FORMAT_HTML, ['trusted' => true])); Anchor link 1:<a href="@@PLUGINFILE@@logo-240x60.gif" alt="bananas">Link text</a> > Anchor link 2:<a title="bananas" href="../logo-240x60.gif">Link text</a> > $this->assertSame(s($text), Anchor + ext. img:<a title="bananas" href="../logo-240x60.gif"><img alt="Moodle" src="@@PLUGINFILE@@logo-240x60.gif"/></a> > format_text($text, FORMAT_PLAIN, ['trusted' => false])); Ext. anchor + img:<a href="@@PLUGINFILE@@logo-240x60.gif"><img alt="Moodle" src="https://moodle.org/logo/logo-240x60.gif"/></a> > $this->assertSame("<p>lala xx</p>\n", SOURCE; > format_text($text, FORMAT_MARKDOWN, ['trusted' => false])); $expected = <<<EXPECTED > $this->assertSame('<div class="text_to_html">lala xx</div>', Hello! > format_text($text, FORMAT_MOODLE, ['trusted' => false])); > $this->assertSame('lala xx', I'm writing to you from the Moodle Majlis in Muscat, Oman, where we just had several days of Moodle community goodness. > format_text($text, FORMAT_HTML, ['trusted' => false])); > URL outside a tag: https://moodle.org/logo/logo-240x60.gif > $this->assertSame("<p>lala <object>xx</object></p>\n", Plugin url outside a tag: @@PLUGINFILE@@/logo-240x60.gif > format_text($text, FORMAT_MARKDOWN, ['trusted' => true, 'noclean' => true])); > $this->assertSame("<p>lala <object>xx</object></p>\n", External link 1:<img src="https://moodle.org/logo/logo-240x60.gif" alt="Moodle" /> > format_text($text, FORMAT_MARKDOWN, ['trusted' => false, 'noclean' => true])); External link 2:<img alt="Moodle" src="https://moodle.org/logo/logo-240x60.gif" /> > } Internal link 1: > Internal link 2: > /**Anchor link 1:Link text Anchor link 2:<a title="bananas" href="../logo-240x60.gif">Link text</a> Anchor + ext. img:<a title="bananas" href="../logo-240x60.gif"></a> Ext. anchor + img:<img alt="Moodle" src="https://moodle.org/logo/logo-240x60.gif" /> EXPECTED; $this->assertSame($expected, strip_pluginfile_content($source)); } /** * @covers \purify_html */ public function test_purify_html_ruby() { $this->resetAfterTest(); $ruby = "<p><ruby><rb>京都</rb><rp>(</rp><rt>きょうと</rt><rp>)</rp></ruby>は" . "<ruby><rb>日本</rb><rp>(</rp><rt>にほん</rt><rp>)</rp></ruby>の" . "<ruby><rb>都</rb><rp>(</rp><rt>みやこ</rt><rp>)</rp></ruby>です。</p>"; $illegal = '<script src="//code.jquery.com/jquery-1.11.3.min.js"></script>'; $cleaned = purify_html($ruby . $illegal); $this->assertEquals($ruby, $cleaned); } /** * Tests for content_to_text. * * @param string $content The content * @param int|false $format The content format * @param string $expected Expected value * @dataProvider provider_content_to_text * @covers ::content_to_text */ public function test_content_to_text($content, $format, $expected) { $content = content_to_text($content, $format); $this->assertEquals($expected, $content); } /** * Data provider for test_content_to_text. */ public static function provider_content_to_text() { return array( array('asd', false, 'asd'), // Trim '\r\n '. array("Note that:\n\n3 > 1 ", FORMAT_PLAIN, "Note that:\n\n3 > 1"), array("Note that:\n\n3 > 1\r\n", FORMAT_PLAIN, "Note that:\n\n3 > 1"), // Multiple spaces to one. array('<span class="eheh">京都</span> -> hehe', FORMAT_HTML, '京都 -> hehe'), array('<span class="eheh">京都</span> -> hehe', false, '京都 -> hehe'), array('asd asd', false, 'asd asd'), // From markdown to html and html to text. array('asd __lera__ con la', FORMAT_MARKDOWN, 'asd LERA con la'), // HTML to text. array('<p class="frogs">This is a <strong class=\'fishes\'>test</strong></p>', FORMAT_HTML, 'This is a TEST'), array("<span lang='en' class='multilang'>english</span> <span lang='ca' class='multilang'>català</span> <span lang='es' class='multilang'>español</span> <span lang='fr' class='multilang'>français</span>", FORMAT_HTML, "english català español français") ); } /** * Data provider for validate_email() function. * * @return array Returns aray of test data for the test_validate_email function */ public function data_validate_email() { return [ // Test addresses that should pass. [ 'email' => 'moodle@example.com', 'result' => true ], [ 'email' => 'moodle@localhost.local', 'result' => true ], [ 'email' => 'verp_email+is=mighty@moodle.org', 'result' => true ], [ 'email' => "but_potentially'dangerous'too@example.org", 'result' => true ], [ 'email' => 'posts+AAAAAAAAAAIAAAAAAAAGQQAAAAABFSXz1eM/P/lR2bYyljM+@posts.moodle.org', 'result' => true ], // Test addresses that should NOT pass. [ 'email' => 'moodle@localhost', 'result' => false ], [ 'email' => '"attacker\\" -oQ/tmp/ -X/var/www/vhost/moodle/backdoor.php some"@email.com', 'result' => false ], [ 'email' => "moodle@example.com>\r\nRCPT TO:<victim@example.com", 'result' => false ], [ 'email' => 'greater>than@example.com', 'result' => false ], [ 'email' => 'less<than@example.com', 'result' => false ], [ 'email' => '"this<is>validbutwerejectit"@example.com', 'result' => false ], // Empty e-mail addresess are not valid. [ 'email' => '', 'result' => false, ], [ 'email' => null, 'result' => false, ], [ 'email' => false, 'result' => false, ], // Extra email addresses from Wikipedia page on Email Addresses. // Valid. [ 'email' => 'simple@example.com', 'result' => true ], [ 'email' => 'very.common@example.com', 'result' => true ], [ 'email' => 'disposable.style.email.with+symbol@example.com', 'result' => true ], [ 'email' => 'other.email-with-hyphen@example.com', 'result' => true ], [ 'email' => 'fully-qualified-domain@example.com', 'result' => true ], [ 'email' => 'user.name+tag+sorting@example.com', 'result' => true ], // One-letter local-part. [ 'email' => 'x@example.com', 'result' => true ], [ 'email' => 'example-indeed@strange-example.com', 'result' => true ], // See the List of Internet top-level domains. [ 'email' => 'example@s.example', 'result' => true ], // Quoted double dot. [ 'email' => '"john..doe"@example.org', 'result' => true ], // Invalid. // No @ character. [ 'email' => 'Abc.example.com', 'result' => false ], // Only one @ is allowed outside quotation marks. [ 'email' => 'A@b@c@example.com', 'result' => false ], // None of the special characters in this local-part are allowed outside quotation marks. [ 'email' => 'a"b(c)d,e:f;g<h>i[j\k]l@example.com', 'result' => false ], // Quoted strings must be dot separated or the only element making up the local-part. [ 'email' => 'just"not"right@example.com', 'result' => false ], // Spaces, quotes, and backslashes may only exist when within quoted strings and preceded by a backslash. [ 'email' => 'this is"not\allowed@example.com', 'result' => false ], // Even if escaped (preceded by a backslash), spaces, quotes, and backslashes must still be contained by quotes. [ 'email' => 'this\ still\"not\\allowed@example.com', 'result' => false ], // Local part is longer than 64 characters. [ 'email' => '1234567890123456789012345678901234567890123456789012345678901234+x@example.com', 'result' => false ], ]; } /** * Tests valid and invalid email address using the validate_email() function. * * @param string $email the email address to test * @param boolean $result Expected result (true or false) * @dataProvider data_validate_email * @covers ::validate_email */ public function test_validate_email($email, $result) { if ($result) { $this->assertTrue(validate_email($email)); } else { $this->assertFalse(validate_email($email)); } } /** * Data provider for test_get_file_argument. */ public static function provider_get_file_argument() { return array( // Serving SCORM content w/o HTTP GET params. array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php/3854/mod_scorm/content/1/swf.html', 'SCRIPT_NAME' => '/pluginfile.php', 'PATH_INFO' => '/3854/mod_scorm/content/1/swf.html', ), 0, '/3854/mod_scorm/content/1/swf.html'), array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php/3854/mod_scorm/content/1/swf.html', 'SCRIPT_NAME' => '/pluginfile.php', 'PATH_INFO' => '/3854/mod_scorm/content/1/swf.html', ), 1, '/3854/mod_scorm/content/1/swf.html'), // Serving SCORM content w/ HTTP GET 'file' as first param. array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php/3854/mod_scorm/content/1/swf.html?file=video_.swf', 'SCRIPT_NAME' => '/pluginfile.php', 'PATH_INFO' => '/3854/mod_scorm/content/1/swf.html', ), 0, '/3854/mod_scorm/content/1/swf.html'), array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php/3854/mod_scorm/content/1/swf.html?file=video_.swf', 'SCRIPT_NAME' => '/pluginfile.php', 'PATH_INFO' => '/3854/mod_scorm/content/1/swf.html', ), 1, '/3854/mod_scorm/content/1/swf.html'), // Serving SCORM content w/ HTTP GET 'file' not as first param. array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php/3854/mod_scorm/content/1/swf.html?foo=bar&file=video_.swf', 'SCRIPT_NAME' => '/pluginfile.php', 'PATH_INFO' => '/3854/mod_scorm/content/1/swf.html', ), 0, '/3854/mod_scorm/content/1/swf.html'), array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php/3854/mod_scorm/content/1/swf.html?foo=bar&file=video_.swf', 'SCRIPT_NAME' => '/pluginfile.php', 'PATH_INFO' => '/3854/mod_scorm/content/1/swf.html', ), 1, '/3854/mod_scorm/content/1/swf.html'), // Serving content from a generic activity w/ HTTP GET 'file', still forcing slash arguments. array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php/3854/whatever/content/1/swf.html?file=video_.swf', 'SCRIPT_NAME' => '/pluginfile.php', 'PATH_INFO' => '/3854/whatever/content/1/swf.html', ), 0, '/3854/whatever/content/1/swf.html'), array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php/3854/whatever/content/1/swf.html?file=video_.swf', 'SCRIPT_NAME' => '/pluginfile.php', 'PATH_INFO' => '/3854/whatever/content/1/swf.html', ), 1, '/3854/whatever/content/1/swf.html'), // Serving content from a generic activity w/ HTTP GET 'file', still forcing slash arguments (edge case). array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php/?file=video_.swf', 'SCRIPT_NAME' => '/pluginfile.php', 'PATH_INFO' => '/', ), 0, 'video_.swf'), array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php/?file=video_.swf', 'SCRIPT_NAME' => '/pluginfile.php', 'PATH_INFO' => '/', ), 1, 'video_.swf'), // Serving content from a generic activity w/ HTTP GET 'file', w/o forcing slash arguments. array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php?file=%2F3854%2Fwhatever%2Fcontent%2F1%2Fswf.html%3Ffile%3Dvideo_.swf', 'SCRIPT_NAME' => '/pluginfile.php', ), 0, '/3854/whatever/content/1/swf.html?file=video_.swf'), array(array( 'SERVER_SOFTWARE' => 'Apache', 'SERVER_PORT' => '80', 'REQUEST_METHOD' => 'GET', 'REQUEST_URI' => '/pluginfile.php?file=%2F3854%2Fwhatever%2Fcontent%2F1%2Fswf.html%3Ffile%3Dvideo_.swf', 'SCRIPT_NAME' => '/pluginfile.php', ), 1, '/3854/whatever/content/1/swf.html?file=video_.swf'), ); } /** * Tests for get_file_argument() function. * * @param array $server mockup for $_SERVER. * @param string $cfgslasharguments slasharguments setting. * @param string|false $expected Expected value. * @dataProvider provider_get_file_argument * @covers ::get_file_argument */ public function test_get_file_argument($server, $cfgslasharguments, $expected) { global $CFG; // Overwrite the related settings. $currentsetting = $CFG->slasharguments; $CFG->slasharguments = $cfgslasharguments; // Mock global $_SERVER. $currentserver = isset($_SERVER) ? $_SERVER : null; $_SERVER = $server; initialise_fullme(); if ($_SERVER['REQUEST_METHOD'] !== 'GET') { $this->fail('Only HTTP GET mocked request allowed.'); } if (empty($_SERVER['REQUEST_URI'])) { $this->fail('Invalid HTTP GET mocked request.'); } // Mock global $_GET. $currentget = isset($_GET) ? $_GET : null; $_GET = array(); $querystring = parse_url($_SERVER['REQUEST_URI'], PHP_URL_QUERY); if (!empty($querystring)) { $_SERVER['QUERY_STRING'] = $querystring; parse_str($querystring, $_GET); } $this->assertEquals($expected, get_file_argument()); // Restore the current settings and global values. $CFG->slasharguments = $currentsetting; if (is_null($currentserver)) { unset($_SERVER); } else { $_SERVER = $currentserver; } if (is_null($currentget)) { unset($_GET); } else { $_GET = $currentget; } } /** * Tests for extract_draft_file_urls_from_text() function. * * @covers ::extract_draft_file_urls_from_text */ public function test_extract_draft_file_urls_from_text() { global $CFG; $url1 = "{$CFG->wwwroot}/draftfile.php/5/user/draft/99999999/test1.jpg"; $url2 = "{$CFG->wwwroot}/draftfile.php/5/user/draft/99999998/test2.jpg";< $html = "<p>This is a test.</p><p><img src=\"${url1}\" alt=\"\" role=\"presentation\"></p>> $html = "<p>This is a test.</p><p><img src=\"{$url1}\" alt=\"\" role=\"presentation\"></p><br>Test content.<p></p><p><img src=\"{$url2}\" alt=\"\" width=\"2048\" height=\"1536\" role=\"presentation\" class=\"img-fluid atto_image_button_text-bottom\"><br></p>"; $draftareas = array( array( 'urlbase' => 'draftfile.php', 'contextid' => '5', 'component' => 'user', 'filearea' => 'draft', 'itemid' => '99999999', 'filename' => 'test1.jpg', 0 => "{$CFG->wwwroot}/draftfile.php/5/user/draft/99999999/test1.jpg", 1 => 'draftfile.php', 2 => '5', 3 => 'user', 4 => 'draft', 5 => '99999999', 6 => 'test1.jpg' ), array( 'urlbase' => 'draftfile.php', 'contextid' => '5', 'component' => 'user', 'filearea' => 'draft', 'itemid' => '99999998', 'filename' => 'test2.jpg', 0 => "{$CFG->wwwroot}/draftfile.php/5/user/draft/99999998/test2.jpg", 1 => 'draftfile.php', 2 => '5', 3 => 'user', 4 => 'draft', 5 => '99999998', 6 => 'test2.jpg' ) ); $extracteddraftareas = extract_draft_file_urls_from_text($html, false, 5, 'user', 'draft'); $this->assertEquals($draftareas, $extracteddraftareas); } /** * @covers ::print_password_policy */ public function test_print_password_policy() { $this->resetAfterTest(true); global $CFG; $policydisabled = ''; // Set password policy to disabled. $CFG->passwordpolicy = false; // Check for empty response. $this->assertEquals($policydisabled, print_password_policy()); // Now set the policy to enabled with every control disabled. $CFG->passwordpolicy = true; $CFG->minpasswordlength = 0; $CFG->minpassworddigits = 0; $CFG->minpasswordlower = 0; $CFG->minpasswordupper = 0; $CFG->minpasswordnonalphanum = 0; $CFG->maxconsecutiveidentchars = 0; // Check for empty response. $this->assertEquals($policydisabled, print_password_policy()); // Now enable some controls, and check that the policy responds with policy text. $CFG->minpasswordlength = 8; $CFG->minpassworddigits = 1; $CFG->minpasswordlower = 1; $CFG->minpasswordupper = 1; $CFG->minpasswordnonalphanum = 1; $CFG->maxconsecutiveidentchars = 1; $this->assertNotEquals($policydisabled, print_password_policy());> } } > } > /** > * Data provider for the testing get_html_lang_attribute_value(). > * > * @return string[][] > */ > public function get_html_lang_attribute_value_provider() { > return [ > 'Empty lang code' => [' ', 'en'], > 'English' => ['en', 'en'], > 'English, US' => ['en_us', 'en'], > 'Unknown' => ['xx', 'en'], > ]; > } > > /** > * Test for get_html_lang_attribute_value(). > * > * @covers ::get_html_lang_attribute_value() > * @dataProvider get_html_lang_attribute_value_provider > * @param string $langcode The language code to convert. > * @param string $expected The expected converted value. > * @return void > */ > public function test_get_html_lang_attribute_value(string $langcode, string $expected): void { > $this->assertEquals($expected, get_html_lang_attribute_value($langcode)); > } > > /** > * Test the coding exceptions when returning URL as relative path from $CFG->wwwroot. > * > * @param moodle_url $url The URL pointing to a web resource. > * @param string $exmessage The expected output URL. > * @throws coding_exception If called on a non-local URL. > * @see \moodle_url::out_as_local_url() > * @covers \moodle_url::out_as_local_url > * @dataProvider out_as_local_url_coding_exception_provider > */ > public function test_out_as_local_url_coding_exception(\moodle_url $url, string $exmessage) { > $this->expectException(\coding_exception::class); > $this->expectExceptionMessage($exmessage); > $localurl = $url->out_as_local_url(); > } > > /** > * Data provider for throwing coding exceptions in <u>\moodle_url::out_as_local_url()</u>. > * > * @return array > * @throws moodle_exception On seriously malformed URLs (<u>parse_url</u>). > * @see \moodle_url::out_as_local_url() > * @see parse_url() > */ > public function out_as_local_url_coding_exception_provider() { > return [ > 'Google Maps CDN (HTTPS)' => [ > new \moodle_url('https://maps.googleapis.com/maps/api/js', ['key' => 'googlemapkey3', 'sensor' => 'false']), > 'Coding error detected, it must be fixed by a programmer: out_as_local_url called on a non-local URL' > ], > 'Google Maps CDN (HTTP)' => [ > new \moodle_url('http://maps.googleapis.com/maps/api/js', ['key' => 'googlemapkey3', 'sensor' => 'false']), > 'Coding error detected, it must be fixed by a programmer: out_as_local_url called on a non-local URL' > ], > ]; > } > > /** > * Test URL as relative path from $CFG->wwwroot. > * > * @param moodle_url $url The URL pointing to a web resource. > * @param string $expected The expected local URL. > * @throws coding_exception If called on a non-local URL. > * @see \moodle_url::out_as_local_url() > * @covers \moodle_url::out_as_local_url > * @dataProvider out_as_local_url_provider > */ > public function test_out_as_local_url(\moodle_url $url, string $expected) { > $this->assertEquals($expected, $url->out_as_local_url(false)); > } > > /** > * Data provider for returning local paths via <u>\moodle_url::out_as_local_url()</u>. > * > * @return array > * @throws moodle_exception On seriously malformed URLs (<u>parse_url</u>). > * @see \moodle_url::out_as_local_url() > * @see parse_url() > */ > public function out_as_local_url_provider() { > global $CFG; > $wwwroot = rtrim($CFG->wwwroot, '/'); > > return [ > 'Environment XML file' => [ > new \moodle_url('/admin/environment.xml'), > '/admin/environment.xml' > ], > 'H5P JS internal resource' => [ > new \moodle_url('/h5p/js/embed.js'), > '/h5p/js/embed.js' > ], > 'A Moodle JS resource using the full path including the proper JS Handler' => [ > new \moodle_url($wwwroot . '/lib/javascript.php/1/lib/editor/tiny/js/tinymce/tinymce.js'), > '/lib/javascript.php/1/lib/editor/tiny/js/tinymce/tinymce.js' > ], > ]; > } > > /** > * Test URL as relative path from $CFG->wwwroot. > * > * @param moodle_url $url The URL pointing to a web resource. > * @param bool $expected The expected result. > * @see \moodle_url::is_local_url() > * @covers \moodle_url::is_local_url > * @dataProvider is_local_url_provider > */ > public function test_is_local_url(\moodle_url $url, bool $expected) { > $this->assertEquals($expected, $url->is_local_url(), "'{$url}' is not a local URL!"); > } > > /** > * Data provider for testing <u>\moodle_url::is_local_url()</u>. > * > * @return array > * @see \moodle_url::is_local_url() > */ > public function is_local_url_provider() { > global $CFG; > $wwwroot = rtrim($CFG->wwwroot, '/'); > > return [ > 'Google Maps CDN (HTTPS)' => [ > new \moodle_url('https://maps.googleapis.com/maps/api/js', ['key' => 'googlemapkey3', 'sensor' => 'false']), > false > ], > 'Google Maps CDN (HTTP)' => [ > new \moodle_url('http://maps.googleapis.com/maps/api/js', ['key' => 'googlemapkey3', 'sensor' => 'false']), > false > ], > 'wwwroot' => [ > new \moodle_url($wwwroot), > true > ], > 'wwwroot/' => [ > new \moodle_url($wwwroot . '/'), > true > ], > 'Environment XML file' => [ > new \moodle_url('/admin/environment.xml'), > true > ], > 'H5P JS internal resource' => [ > new \moodle_url('/h5p/js/embed.js'), > true > ], > ]; > } > > /** > * Data provider for strip_querystring tests. > * > * @return array > */ > public function strip_querystring_provider(): array { > return [ > 'Null' => [null, ''], > 'Empty string' => ['', ''], > 'No querystring' => ['https://example.com', 'https://example.com'], > 'Querystring' => ['https://example.com?foo=bar', 'https://example.com'], > 'Querystring with fragment' => ['https://example.com?foo=bar#baz', 'https://example.com'], > 'Querystring with fragment and path' => ['https://example.com/foo/bar?foo=bar#baz', 'https://example.com/foo/bar'], > ]; > } > > /** > * Test the strip_querystring function with various exampels. > * > * @dataProvider strip_querystring_provider > * @param mixed $value > * @param mixed $expected > * @covers ::strip_querystring > */ > public function test_strip_querystring($value, $expected): void { > $this->assertEquals($expected, strip_querystring($value));
