.
/**
* 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 ::s
*/
public function test_s(): void {
// 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 " Strict'));
// 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: &.', s('An entity: &.'));
$this->assertSame('Not an entity: &#x09ff;.', s('Not an entity: ৿.'));
// 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_string
* @dataProvider format_string_illegal_options_provider
*/
public function test_format_string_illegal_options(
string $input,
string $result,
mixed $options,
string $pattern,
): void {
$this->assertEquals(
$result,
format_string($input, false, $options),
);
$messages = $this->getDebuggingMessages();
$this->assertdebuggingcalledcount(1);
$this->assertMatchesRegularExpression(
"/{$pattern}/",
$messages[0]->message,
);
}
/**
* Data provider for test_format_string_illegal_options.
* @return array
*/
public static function format_string_illegal_options_provider(): array {
return [
[
'Example',
'Example',
\core\context\system::instance(),
preg_quote('The options argument should not be a context object directly.'),
],
[
'Example',
'Example',
true,
preg_quote('The options argument should be an Array, or stdclass. boolean passed.'),
],
[
'Example',
'Example',
false,
preg_quote('The options argument should be an Array, or stdclass. boolean passed.'),
],
];
}
/**
* Ensure that if format_string is called with a context as the third param, that a debugging notice is emitted.
*
* @covers ::format_string
*/
public function test_format_string_context(): void {
global $CFG;
$this->resetAfterTest(true);
// Disable the formatstringstriptags option to ensure that the HTML tags are not stripped.
$CFG->stringfilters = 'multilang';
// Enable filters.
$CFG->filterall = true;
$course = $this->getDataGenerator()->create_course();
$coursecontext = \core\context\course::instance($course->id);
// Set up the multilang filter at the system context, but disable it at the course.
filter_set_global_state('multilang', TEXTFILTER_ON);
filter_set_local_state('multilang', $coursecontext->id, TEXTFILTER_OFF);
// Previously, if a context was passed, it was converted into an Array, and ignored.
// The PAGE context was used instead -- often this is the system context.
$input = 'I really do not do not like this!';
$result = format_string(
$input,
true,
$coursecontext,
);
// 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.
$this->assertEquals(
// Tags are stripped out due to striptags.
"I really do not do not like this!",
$result,
);
// But it should be filtered if called with the system context.
$result = format_string(
$input,
true,
['context' => \core\context\system::instance()],
);
$this->assertEquals(
'I really do not like this!',
$result,
);
}
/**
* @covers ::format_text_email
*/
public function test_format_text_email(): void {
$this->assertSame("This is a TEST\n",
format_text_email('This is a test
', FORMAT_HTML));
$this->assertSame("This is a TEST\n",
format_text_email('This is a test
', FORMAT_HTML));
$this->assertSame('& so is this',
format_text_email('& so is this', FORMAT_HTML));
$this->assertSame('Two bullets: ' . core_text::code2utf8(8226) . ' ' . core_text::code2utf8(8226),
format_text_email('Two bullets: • •', FORMAT_HTML));
$this->assertSame(core_text::code2utf8(0x7fd2).core_text::code2utf8(0x7fd2),
format_text_email('習習', FORMAT_HTML));
}
/**
* @covers ::obfuscate_email
*/
public function test_obfuscate_email(): void {
$email = 'some.user@example.com';
$obfuscated = obfuscate_email($email);
$this->assertNotSame($email, $obfuscated);
$back = core_text::entities_to_utf8(urldecode($email), true);
$this->assertSame($email, $back);
}
/**
* @covers ::obfuscate_text
*/
public function test_obfuscate_text(): void {
$text = 'Žluťoučký koníček 32131';
$obfuscated = obfuscate_text($text);
$this->assertNotSame($text, $obfuscated);
$back = core_text::entities_to_utf8($obfuscated, true);
$this->assertSame($text, $back);
}
/**
* @covers ::highlight
*/
public function test_highlight(): void {
$this->assertSame('This is good',
highlight('good', 'This is good'));
$this->assertSame('span',
highlight('SpaN', 'span'));
$this->assertSame('SpaN',
highlight('span', 'SpaN'));
$this->assertSame('span',
highlight('span', 'span'));
$this->assertSame('He is good',
highlight('good is', 'He is good'));
$this->assertSame('This is good',
highlight('+good', 'This is good'));
$this->assertSame('This is good',
highlight('-good', 'This is good'));
$this->assertSame('This is goodness',
highlight('+good', 'This is goodness'));
$this->assertSame('This is goodness',
highlight('good', 'This is goodness'));
$this->assertSame('test 1
1
',
highlight('test 1', 'test 1
1
', false, '', ''));
$this->assertSame('test 1
1
',
highlight('test +1', 'test 1
1
', false, '', ''));
$this->assertSame('test 1
1
',
highlight('test -1', 'test 1
1
', false, '', ''));
}
/**
* @covers ::replace_ampersands_not_followed_by_entity
*/
public function test_replace_ampersands(): void {
$this->assertSame("This & that ", replace_ampersands_not_followed_by_entity("This & that "));
$this->assertSame("This   that ", replace_ampersands_not_followed_by_entity("This that "));
}
/**
* @covers ::strip_links
*/
public function test_strip_links(): void {
$this->assertSame('this is a link', strip_links('this is a link'));
}
/**
* @covers ::wikify_links
*/
public function test_wikify_links(): void {
$this->assertSame('this is a link [ http://someaddress.com/query ]', wikify_links('this is a link'));
}
/**
* @covers ::clean_text
*/
public function test_clean_text(): void {
$text = "lala ";
$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 ::trusttext_active
*/
public function test_trusttext_active(): void {
global $CFG;
$this->resetAfterTest();
$this->assertFalse(trusttext_active());
$CFG->enabletrusttext = '1';
$this->assertTrue(trusttext_active());
}
/**
* Test trusttext detection.
*
* @covers ::trusttext_trusted
*/
public function test_trusttext_trusted(): void {
global $CFG;
$this->resetAfterTest();
$syscontext = context_system::instance();
$course = $this->getDataGenerator()->create_course();
$coursecontext = context_course::instance($course->id);
$user1 = $this->getDataGenerator()->create_user();
$user2 = $this->getDataGenerator()->create_user();
$this->getDataGenerator()->enrol_user($user2->id, $course->id, 'editingteacher');
$this->setAdminUser();
$CFG->enabletrusttext = '0';
$this->assertFalse(trusttext_trusted($syscontext));
$this->assertFalse(trusttext_trusted($coursecontext));
$CFG->enabletrusttext = '1';
$this->assertTrue(trusttext_trusted($syscontext));
$this->assertTrue(trusttext_trusted($coursecontext));
$this->setUser($user1);
$CFG->enabletrusttext = '0';
$this->assertFalse(trusttext_trusted($syscontext));
$this->assertFalse(trusttext_trusted($coursecontext));
$CFG->enabletrusttext = '1';
$this->assertFalse(trusttext_trusted($syscontext));
$this->assertFalse(trusttext_trusted($coursecontext));
$this->setUser($user2);
$CFG->enabletrusttext = '0';
$this->assertFalse(trusttext_trusted($syscontext));
$this->assertFalse(trusttext_trusted($coursecontext));
$CFG->enabletrusttext = '1';
$this->assertFalse(trusttext_trusted($syscontext));
$this->assertTrue(trusttext_trusted($coursecontext));
}
/**
* Data provider for trusttext_pre_edit() tests.
*/
public function trusttext_pre_edit_provider(): array {
return [
[true, 0, 'editingteacher', FORMAT_HTML, 1],
[true, 0, 'editingteacher', FORMAT_MOODLE, 1],
[false, 0, 'editingteacher', FORMAT_MARKDOWN, 1],
[false, 0, 'editingteacher', FORMAT_PLAIN, 1],
[false, 1, 'editingteacher', FORMAT_HTML, 1],
[false, 1, 'editingteacher', FORMAT_MOODLE, 1],
[false, 1, 'editingteacher', FORMAT_MARKDOWN, 1],
[false, 1, 'editingteacher', FORMAT_PLAIN, 1],
[true, 0, 'student', FORMAT_HTML, 1],
[true, 0, 'student', FORMAT_MOODLE, 1],
[false, 0, 'student', FORMAT_MARKDOWN, 1],
[false, 0, 'student', FORMAT_PLAIN, 1],
[true, 1, 'student', FORMAT_HTML, 1],
[true, 1, 'student', FORMAT_MOODLE, 1],
[false, 1, 'student', FORMAT_MARKDOWN, 1],
[false, 1, 'student', FORMAT_PLAIN, 1],
];
}
/**
* Test text cleaning before editing.
*
* @dataProvider trusttext_pre_edit_provider
* @covers ::trusttext_pre_edit
*
* @param bool $expectedsanitised
* @param int $enabled
* @param string $rolename
* @param string $format
* @param int $trust
*/
public function test_trusttext_pre_edit(bool $expectedsanitised, int $enabled, string $rolename,
string $format, int $trust): void {
global $CFG, $DB;
$this->resetAfterTest();
$exploit = "abc < > &";
$sanitised = purify_html($exploit);
$course = $this->getDataGenerator()->create_course();
$context = context_course::instance($course->id);
$user = $this->getDataGenerator()->create_user();
$this->getDataGenerator()->enrol_user($user->id, $course->id, $rolename);
$this->setUser($user);
$CFG->enabletrusttext = (string)$enabled;
$object = new stdClass();
$object->some = $exploit;
$object->someformat = $format;
$object->sometrust = (string)$trust;
$result = trusttext_pre_edit(clone($object), 'some', $context);
if ($expectedsanitised) {
$message = "sanitisation is expected for: $enabled, $rolename, $format, $trust";
$this->assertSame($sanitised, $result->some, $message);
} else {
$message = "sanitisation is not expected for: $enabled, $rolename, $format, $trust";
$this->assertSame($exploit, $result->some, $message);
}
}
/**
* Test removal of legacy trusttext flag.
* @covers ::trusttext_strip
*/
public function test_trusttext_strip(): void {
$this->assertSame('abc', trusttext_strip('abc'));
$this->assertSame('abc', trusttext_strip('ab#####TRUSTTEXT#####c'));
}
/**
* Test trust option of format_text().
* @covers ::format_text
*/
public function test_format_text_trusted(): void {
global $CFG;
$this->resetAfterTest();
$text = "lala ";
$CFG->enabletrusttext = 0;
$this->assertSame(s($text),
format_text($text, FORMAT_PLAIN, ['trusted' => true]));
$this->assertSame("lala xx
\n",
format_text($text, FORMAT_MARKDOWN, ['trusted' => true]));
$this->assertSame('lala xx
',
format_text($text, FORMAT_MOODLE, ['trusted' => true]));
$this->assertSame('lala xx',
format_text($text, FORMAT_HTML, ['trusted' => true]));
$this->assertSame(s($text),
format_text($text, FORMAT_PLAIN, ['trusted' => false]));
$this->assertSame("lala xx
\n",
format_text($text, FORMAT_MARKDOWN, ['trusted' => false]));
$this->assertSame('lala xx
',
format_text($text, FORMAT_MOODLE, ['trusted' => false]));
$this->assertSame('lala xx',
format_text($text, FORMAT_HTML, ['trusted' => false]));
$CFG->enabletrusttext = 1;
$this->assertSame(s($text),
format_text($text, FORMAT_PLAIN, ['trusted' => true]));
$this->assertSame("lala xx
\n",
format_text($text, FORMAT_MARKDOWN, ['trusted' => true]));
$this->assertSame('lala
',
format_text($text, FORMAT_MOODLE, ['trusted' => true]));
$this->assertSame('lala ',
format_text($text, FORMAT_HTML, ['trusted' => true]));
$this->assertSame(s($text),
format_text($text, FORMAT_PLAIN, ['trusted' => false]));
$this->assertSame("lala xx
\n",
format_text($text, FORMAT_MARKDOWN, ['trusted' => false]));
$this->assertSame('lala xx
',
format_text($text, FORMAT_MOODLE, ['trusted' => false]));
$this->assertSame('lala xx',
format_text($text, FORMAT_HTML, ['trusted' => false]));
$this->assertSame("lala
\n",
format_text($text, FORMAT_MARKDOWN, ['trusted' => true, 'noclean' => true]));
$this->assertSame("lala
\n",
format_text($text, FORMAT_MARKDOWN, ['trusted' => false, 'noclean' => true]));
}
/**
* @covers ::qualified_me
*/
public function test_qualified_me(): void {
global $PAGE, $FULLME, $CFG;
$this->resetAfterTest();
$PAGE = new moodle_page();
$FULLME = $CFG->wwwroot.'/course/view.php?id=1&xx=yy';
$this->assertSame($FULLME, qualified_me());
$PAGE->set_url('/course/view.php', array('id'=>1));
$this->assertSame($CFG->wwwroot.'/course/view.php?id=1', qualified_me());
}
/**
* @covers ::set_debugging
*/
public function test_set_debugging(): void {
global $CFG;
$this->resetAfterTest();
$this->assertEquals(DEBUG_DEVELOPER, $CFG->debug);
$this->assertTrue($CFG->debugdeveloper);
$this->assertNotEmpty($CFG->debugdisplay);
set_debugging(DEBUG_DEVELOPER, true);
$this->assertEquals(DEBUG_DEVELOPER, $CFG->debug);
$this->assertTrue($CFG->debugdeveloper);
$this->assertNotEmpty($CFG->debugdisplay);
set_debugging(DEBUG_DEVELOPER, false);
$this->assertEquals(DEBUG_DEVELOPER, $CFG->debug);
$this->assertTrue($CFG->debugdeveloper);
$this->assertEmpty($CFG->debugdisplay);
set_debugging(-1);
$this->assertEquals(-1, $CFG->debug);
$this->assertTrue($CFG->debugdeveloper);
set_debugging(DEBUG_ALL);
$this->assertEquals(DEBUG_ALL, $CFG->debug);
$this->assertFalse($CFG->debugdeveloper);
set_debugging(DEBUG_NORMAL);
$this->assertEquals(DEBUG_NORMAL, $CFG->debug);
$this->assertFalse($CFG->debugdeveloper);
set_debugging(DEBUG_MINIMAL);
$this->assertEquals(DEBUG_MINIMAL, $CFG->debug);
$this->assertFalse($CFG->debugdeveloper);
set_debugging(DEBUG_NONE);
$this->assertEquals(DEBUG_NONE, $CFG->debug);
$this->assertFalse($CFG->debugdeveloper);
}
/**
* @covers ::strip_pluginfile_content
*/
public function test_strip_pluginfile_content(): void {
$source = <<
External link 2:
Internal link 1:
Internal link 2:
Anchor link 1:Link text
Anchor link 2:Link text
Anchor + ext. img:
Ext. anchor + img:
SOURCE;
$expected = <<
External link 2:
Internal link 1:
Internal link 2:
Anchor link 1:Link text
Anchor link 2:Link text
Anchor + ext. img:
Ext. anchor + img:
EXPECTED;
$this->assertSame($expected, strip_pluginfile_content($source));
}
/**
* @covers \purify_html
*/
public function test_purify_html_ruby(): void {
$this->resetAfterTest();
$ruby =
"京都は" .
"日本の" .
"都です。
";
$illegal = '';
$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): void {
$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('京都 -> hehe', FORMAT_HTML, '京都 -> hehe'),
array('京都 -> 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('This is a test
', FORMAT_HTML, 'This is a TEST'),
array("english
català
español
français", 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: false
],
[
'email' => 'greater>than@example.com',
'result' => false
],
[
'email' => 'less false
],
[
'email' => '"thisvalidbutwerejectit"@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;gi[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): void {
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): void {
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(): void {
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 = "This is a test.
![\"\"](\"{$url1}\")
Test content.![\"\"](\"{$url2}\")
";
$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(): void {
$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));
}
/**
* 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));
}
}
