weekly release 3.6dev
[moodle.git] / lib / weblib.php
CommitLineData
449611af 1<?php
b868d3d9 2// This file is part of Moodle - http://moodle.org/
3//
449611af 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.
b868d3d9 13//
449611af 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/>.
f9903ed0 16
7cf1c7bd 17/**
18 * Library of functions for web output
19 *
20 * Library of all general-purpose Moodle PHP functions and constants
21 * that produce HTML output
22 *
23 * Other main libraries:
24 * - datalib.php - functions that access the database.
25 * - moodlelib.php - general-purpose Moodle functions.
449611af 26 *
78bfb562
PS
27 * @package core
28 * @subpackage lib
29 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
30 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7cf1c7bd 31 */
772e78be 32
78bfb562
PS
33defined('MOODLE_INTERNAL') || die();
34
2e1d38db 35// Constants.
0095d5cd 36
2e1d38db 37// Define text formatting types ... eventually we can add Wiki, BBcode etc.
7cf1c7bd 38
39/**
2e1d38db 40 * Does all sorts of transformations and filtering.
7cf1c7bd 41 */
2e1d38db 42define('FORMAT_MOODLE', '0');
7cf1c7bd 43
44/**
2e1d38db 45 * Plain HTML (with some tags stripped).
7cf1c7bd 46 */
2e1d38db 47define('FORMAT_HTML', '1');
7cf1c7bd 48
49/**
2e1d38db 50 * Plain text (even tags are printed in full).
7cf1c7bd 51 */
2e1d38db 52define('FORMAT_PLAIN', '2');
7cf1c7bd 53
54/**
2e1d38db 55 * Wiki-formatted text.
6a6495ff 56 * Deprecated: left here just to note that '3' is not used (at the moment)
57 * and to catch any latent wiki-like text (which generates an error)
2e1d38db 58 * @deprecated since 2005!
7cf1c7bd 59 */
2e1d38db 60define('FORMAT_WIKI', '3');
7cf1c7bd 61
62/**
63 * Markdown-formatted text http://daringfireball.net/projects/markdown/
64 */
2e1d38db 65define('FORMAT_MARKDOWN', '4');
0095d5cd 66
827b2f7a 67/**
2e1d38db 68 * A moodle_url comparison using this flag will return true if the base URLs match, params are ignored.
827b2f7a 69 */
70define('URL_MATCH_BASE', 0);
2e1d38db 71
827b2f7a 72/**
2e1d38db 73 * A moodle_url comparison using this flag will return true if the base URLs match and the params of url1 are part of url2.
827b2f7a 74 */
75define('URL_MATCH_PARAMS', 1);
2e1d38db 76
827b2f7a 77/**
2e1d38db 78 * A moodle_url comparison using this flag will return true if the two URLs are identical, except for the order of the params.
827b2f7a 79 */
80define('URL_MATCH_EXACT', 2);
7cf1c7bd 81
2e1d38db 82// Functions.
0095d5cd 83
7cf1c7bd 84/**
2e1d38db 85 * Add quotes to HTML characters.
7cf1c7bd 86 *
87 * Returns $var with HTML characters (like "<", ">", etc.) properly quoted.
88661686 88 * Related function {@link p()} simply prints the output of this function.
7cf1c7bd 89 *
90 * @param string $var the string potentially containing HTML characters
91 * @return string
92 */
328ac306 93function s($var) {
d4a42ff4 94
328ac306 95 if ($var === false) {
63e554d0 96 return '0';
3662bce5 97 }
d4a42ff4 98
b16b1f86 99 return preg_replace('/&amp;#(\d+|x[0-9a-f]+);/i', '&#$1;',
100 htmlspecialchars($var, ENT_QUOTES | ENT_HTML401 | ENT_SUBSTITUTE));
f9903ed0 101}
102
7cf1c7bd 103/**
2e1d38db 104 * Add quotes to HTML characters.
7cf1c7bd 105 *
d48b00b4 106 * Prints $var with HTML characters (like "<", ">", etc.) properly quoted.
88661686 107 * This function simply calls & displays {@link s()}.
449611af 108 * @see s()
109 *
7cf1c7bd 110 * @param string $var the string potentially containing HTML characters
111 * @return string
112 */
88661686
TM
113function p($var) {
114 echo s($var);
f9903ed0 115}
116
0d1cd0ea 117/**
118 * Does proper javascript quoting.
449611af 119 *
5ce73257 120 * Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
121 *
449611af 122 * @param mixed $var String, Array, or Object to add slashes to
0d1cd0ea 123 * @return mixed quoted result
124 */
125function addslashes_js($var) {
126 if (is_string($var)) {
127 $var = str_replace('\\', '\\\\', $var);
128 $var = str_replace(array('\'', '"', "\n", "\r", "\0"), array('\\\'', '\\"', '\\n', '\\r', '\\0'), $var);
2e1d38db 129 $var = str_replace('</', '<\/', $var); // XHTML compliance.
0d1cd0ea 130 } else if (is_array($var)) {
131 $var = array_map('addslashes_js', $var);
132 } else if (is_object($var)) {
133 $a = get_object_vars($var);
2e1d38db
SH
134 foreach ($a as $key => $value) {
135 $a[$key] = addslashes_js($value);
0d1cd0ea 136 }
137 $var = (object)$a;
138 }
139 return $var;
140}
7cf1c7bd 141
7cf1c7bd 142/**
2e1d38db 143 * Remove query string from url.
7cf1c7bd 144 *
2e1d38db 145 * Takes in a URL and returns it without the querystring portion.
7cf1c7bd 146 *
2e1d38db
SH
147 * @param string $url the url which may have a query string attached.
148 * @return string The remaining URL.
7cf1c7bd 149 */
2e1d38db 150function strip_querystring($url) {
f9903ed0 151
b9b8ab69 152 if ($commapos = strpos($url, '?')) {
153 return substr($url, 0, $commapos);
154 } else {
155 return $url;
156 }
f9903ed0 157}
158
7cf1c7bd 159/**
160 * Returns the name of the current script, WITH the querystring portion.
449611af 161 *
162 * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
7cf1c7bd 163 * return different things depending on a lot of things like your OS, Web
164 * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
d48b00b4 165 * <b>NOTE:</b> This function returns false if the global variables needed are not set.
166 *
2e1d38db 167 * @return mixed String or false if the global variables needed are not set.
7cf1c7bd 168 */
b03fc392 169function me() {
170 global $ME;
171 return $ME;
f9903ed0 172}
173
7cf1c7bd 174/**
f0202ae9 175 * Guesses the full URL of the current script.
449611af 176 *
f0202ae9
PS
177 * This function is using $PAGE->url, but may fall back to $FULLME which
178 * is constructed from PHP_SELF and REQUEST_URI or SCRIPT_NAME
449611af 179 *
f0202ae9 180 * @return mixed full page URL string or false if unknown
7cf1c7bd 181 */
f9903ed0 182function qualified_me() {
f0202ae9
PS
183 global $FULLME, $PAGE, $CFG;
184
185 if (isset($PAGE) and $PAGE->has_set_url()) {
2e1d38db 186 // This is the only recommended way to find out current page.
f0202ae9
PS
187 return $PAGE->url->out(false);
188
189 } else {
190 if ($FULLME === null) {
2e1d38db 191 // CLI script most probably.
f0202ae9
PS
192 return false;
193 }
194 if (!empty($CFG->sslproxy)) {
2e1d38db 195 // Return only https links when using SSL proxy.
f0202ae9
PS
196 return preg_replace('/^http:/', 'https:', $FULLME, 1);
197 } else {
198 return $FULLME;
199 }
200 }
f9903ed0 201}
202
1e31f118
TB
203/**
204 * Determines whether or not the Moodle site is being served over HTTPS.
205 *
672f4836 206 * This is done simply by checking the value of $CFG->wwwroot, which seems
1e31f118
TB
207 * to be the only reliable method.
208 *
209 * @return boolean True if site is served over HTTPS, false otherwise.
210 */
211function is_https() {
212 global $CFG;
213
672f4836 214 return (strpos($CFG->wwwroot, 'https://') === 0);
1e31f118
TB
215}
216
dcee0b94
SL
217/**
218 * Returns the cleaned local URL of the HTTP_REFERER less the URL query string parameters if required.
219 *
220 * @param bool $stripquery if true, also removes the query part of the url.
221 * @return string The resulting referer or empty string.
222 */
223function get_local_referer($stripquery = true) {
224 if (isset($_SERVER['HTTP_REFERER'])) {
225 $referer = clean_param($_SERVER['HTTP_REFERER'], PARAM_LOCALURL);
226 if ($stripquery) {
227 return strip_querystring($referer);
228 } else {
229 return $referer;
230 }
231 } else {
232 return '';
233 }
234}
235
360e503e 236/**
237 * Class for creating and manipulating urls.
84e3d2cc 238 *
449611af 239 * It can be used in moodle pages where config.php has been included without any further includes.
240 *
49c8c8d2 241 * It is useful for manipulating urls with long lists of params.
fa9f6bf6 242 * One situation where it will be useful is a page which links to itself to perform various actions
449611af 243 * and / or to process form data. A moodle_url object :
49c8c8d2 244 * can be created for a page to refer to itself with all the proper get params being passed from page call to
245 * page call and methods can be used to output a url including all the params, optionally adding and overriding
449611af 246 * params and can also be used to
247 * - output the url without any get params
49c8c8d2 248 * - and output the params as hidden fields to be output within a form
449611af 249 *
2e1d38db 250 * @copyright 2007 jamiesensei
728ebac7 251 * @link http://docs.moodle.org/dev/lib/weblib.php_moodle_url See short write up here
449611af 252 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2e1d38db 253 * @package core
360e503e 254 */
255class moodle_url {
2e1d38db 256
449611af 257 /**
a6855934
PS
258 * Scheme, ex.: http, https
259 * @var string
260 */
261 protected $scheme = '';
2e1d38db 262
a6855934 263 /**
2e1d38db 264 * Hostname.
449611af 265 * @var string
449611af 266 */
7ceb61d8 267 protected $host = '';
2e1d38db 268
a6855934 269 /**
2e1d38db
SH
270 * Port number, empty means default 80 or 443 in case of http.
271 * @var int
a6855934 272 */
7ceb61d8 273 protected $port = '';
2e1d38db 274
a6855934 275 /**
2e1d38db 276 * Username for http auth.
a6855934
PS
277 * @var string
278 */
7ceb61d8 279 protected $user = '';
2e1d38db 280
a6855934 281 /**
2e1d38db 282 * Password for http auth.
a6855934
PS
283 * @var string
284 */
7ceb61d8 285 protected $pass = '';
2e1d38db 286
a6855934 287 /**
2e1d38db 288 * Script path.
a6855934
PS
289 * @var string
290 */
7ceb61d8 291 protected $path = '';
2e1d38db 292
7dff555f 293 /**
2e1d38db 294 * Optional slash argument value.
7dff555f
PS
295 * @var string
296 */
297 protected $slashargument = '';
2e1d38db 298
449611af 299 /**
2e1d38db 300 * Anchor, may be also empty, null means none.
a6855934
PS
301 * @var string
302 */
303 protected $anchor = null;
2e1d38db 304
a6855934 305 /**
2e1d38db 306 * Url parameters as associative array.
49c8c8d2 307 * @var array
449611af 308 */
2e1d38db 309 protected $params = array();
84e3d2cc 310
360e503e 311 /**
a6855934 312 * Create new instance of moodle_url.
84e3d2cc 313 *
a6855934
PS
314 * @param moodle_url|string $url - moodle_url means make a copy of another
315 * moodle_url and change parameters, string means full url or shortened
316 * form (ex.: '/course/view.php'). It is strongly encouraged to not include
2284c694
TH
317 * query string because it may result in double encoded values. Use the
318 * $params instead. For admin URLs, just use /admin/script.php, this
319 * class takes care of the $CFG->admin issue.
a6855934 320 * @param array $params these params override current params or add new
61b223a6 321 * @param string $anchor The anchor to use as part of the URL if there is one.
2e1d38db 322 * @throws moodle_exception
360e503e 323 */
61b223a6 324 public function __construct($url, array $params = null, $anchor = null) {
a6855934 325 global $CFG;
2b3fcef9 326
a6855934 327 if ($url instanceof moodle_url) {
75781f87 328 $this->scheme = $url->scheme;
329 $this->host = $url->host;
330 $this->port = $url->port;
331 $this->user = $url->user;
332 $this->pass = $url->pass;
ad52c04f 333 $this->path = $url->path;
7dff555f 334 $this->slashargument = $url->slashargument;
75781f87 335 $this->params = $url->params;
a6855934 336 $this->anchor = $url->anchor;
2b3fcef9 337
75781f87 338 } else {
2e1d38db 339 // Detect if anchor used.
a6855934
PS
340 $apos = strpos($url, '#');
341 if ($apos !== false) {
342 $anchor = substr($url, $apos);
343 $anchor = ltrim($anchor, '#');
344 $this->set_anchor($anchor);
345 $url = substr($url, 0, $apos);
360e503e 346 }
a6855934 347
2e1d38db 348 // Normalise shortened form of our url ex.: '/course/view.php'.
a6855934 349 if (strpos($url, '/') === 0) {
a6855934 350 $url = $CFG->wwwroot.$url;
75781f87 351 }
a6855934 352
a6855934
PS
353 if ($CFG->admin !== 'admin') {
354 if (strpos($url, "$CFG->wwwroot/admin/") === 0) {
355 $url = str_replace("$CFG->wwwroot/admin/", "$CFG->wwwroot/$CFG->admin/", $url);
356 }
357 }
358
2e1d38db 359 // Parse the $url.
a6855934
PS
360 $parts = parse_url($url);
361 if ($parts === false) {
75781f87 362 throw new moodle_exception('invalidurl');
360e503e 363 }
7ceb61d8 364 if (isset($parts['query'])) {
2e1d38db 365 // Note: the values may not be correctly decoded, url parameters should be always passed as array.
24a905f9 366 parse_str(str_replace('&amp;', '&', $parts['query']), $this->params);
360e503e 367 }
368 unset($parts['query']);
7ceb61d8 369 foreach ($parts as $key => $value) {
360e503e 370 $this->$key = $value;
371 }
7dff555f 372
2e1d38db 373 // Detect slashargument value from path - we do not support directory names ending with .php.
7dff555f
PS
374 $pos = strpos($this->path, '.php/');
375 if ($pos !== false) {
376 $this->slashargument = substr($this->path, $pos + 4);
377 $this->path = substr($this->path, 0, $pos + 4);
378 }
360e503e 379 }
2b3fcef9 380
75781f87 381 $this->params($params);
61b223a6
SH
382 if ($anchor !== null) {
383 $this->anchor = (string)$anchor;
384 }
84e3d2cc 385 }
7ceb61d8 386
360e503e 387 /**
2b3fcef9 388 * Add an array of params to the params for this url.
449611af 389 *
390 * The added params override existing ones if they have the same name.
360e503e 391 *
f8065dd2 392 * @param array $params Defaults to null. If null then returns all params.
449611af 393 * @return array Array of Params for url.
2e1d38db 394 * @throws coding_exception
360e503e 395 */
2b3fcef9
PS
396 public function params(array $params = null) {
397 $params = (array)$params;
398
2e1d38db 399 foreach ($params as $key => $value) {
2b3fcef9 400 if (is_int($key)) {
d8ae33a9 401 throw new coding_exception('Url parameters can not have numeric keys!');
2b3fcef9 402 }
27d6ab57 403 if (!is_string($value)) {
404 if (is_array($value)) {
405 throw new coding_exception('Url parameters values can not be arrays!');
406 }
407 if (is_object($value) and !method_exists($value, '__toString')) {
408 throw new coding_exception('Url parameters values can not be objects, unless __toString() is defined!');
409 }
2b3fcef9
PS
410 }
411 $this->params[$key] = (string)$value;
c1f41c59 412 }
2b3fcef9 413 return $this->params;
360e503e 414 }
84e3d2cc 415
360e503e 416 /**
49c8c8d2 417 * Remove all params if no arguments passed.
418 * Remove selected params if arguments are passed.
449611af 419 *
420 * Can be called as either remove_params('param1', 'param2')
75781f87 421 * or remove_params(array('param1', 'param2')).
360e503e 422 *
2e1d38db 423 * @param string[]|string $params,... either an array of param names, or 1..n string params to remove as args.
2b3fcef9 424 * @return array url parameters
360e503e 425 */
2b3fcef9 426 public function remove_params($params = null) {
75781f87 427 if (!is_array($params)) {
428 $params = func_get_args();
429 }
430 foreach ($params as $param) {
2b3fcef9 431 unset($this->params[$param]);
360e503e 432 }
2b3fcef9
PS
433 return $this->params;
434 }
435
436 /**
2e1d38db
SH
437 * Remove all url parameters.
438 *
439 * @todo remove the unused param.
440 * @param array $params Unused param
2b3fcef9
PS
441 * @return void
442 */
443 public function remove_all_params($params = null) {
444 $this->params = array();
7dff555f 445 $this->slashargument = '';
360e503e 446 }
447
448 /**
2b3fcef9 449 * Add a param to the params for this url.
449611af 450 *
2b3fcef9 451 * The added param overrides existing one if they have the same name.
360e503e 452 *
453 * @param string $paramname name
2b3fcef9
PS
454 * @param string $newvalue Param value. If new value specified current value is overriden or parameter is added
455 * @return mixed string parameter value, null if parameter does not exist
360e503e 456 */
2b3fcef9
PS
457 public function param($paramname, $newvalue = '') {
458 if (func_num_args() > 1) {
2e1d38db
SH
459 // Set new value.
460 $this->params(array($paramname => $newvalue));
2b3fcef9
PS
461 }
462 if (isset($this->params[$paramname])) {
5762b36e 463 return $this->params[$paramname];
cf615522 464 } else {
465 return null;
c1f41c59 466 }
360e503e 467 }
468
2b3fcef9
PS
469 /**
470 * Merges parameters and validates them
2e1d38db 471 *
2b3fcef9
PS
472 * @param array $overrideparams
473 * @return array merged parameters
2e1d38db 474 * @throws coding_exception
2b3fcef9
PS
475 */
476 protected function merge_overrideparams(array $overrideparams = null) {
477 $overrideparams = (array)$overrideparams;
478 $params = $this->params;
2e1d38db 479 foreach ($overrideparams as $key => $value) {
2b3fcef9 480 if (is_int($key)) {
cdefaa86 481 throw new coding_exception('Overridden parameters can not have numeric keys!');
2b3fcef9
PS
482 }
483 if (is_array($value)) {
cdefaa86 484 throw new coding_exception('Overridden parameters values can not be arrays!');
2b3fcef9
PS
485 }
486 if (is_object($value) and !method_exists($value, '__toString')) {
cdefaa86 487 throw new coding_exception('Overridden parameters values can not be objects, unless __toString() is defined!');
2b3fcef9
PS
488 }
489 $params[$key] = (string)$value;
490 }
491 return $params;
492 }
493
7ceb61d8 494 /**
495 * Get the params as as a query string.
2e1d38db 496 *
8afba50b 497 * This method should not be used outside of this method.
449611af 498 *
2e1d38db 499 * @param bool $escaped Use &amp; as params separator instead of plain &
7ceb61d8 500 * @param array $overrideparams params to add to the output params, these
501 * override existing ones with the same name.
502 * @return string query string that can be added to a url.
503 */
8afba50b 504 public function get_query_string($escaped = true, array $overrideparams = null) {
360e503e 505 $arr = array();
27d6ab57 506 if ($overrideparams !== null) {
507 $params = $this->merge_overrideparams($overrideparams);
508 } else {
509 $params = $this->params;
510 }
7ceb61d8 511 foreach ($params as $key => $val) {
ab82976f
TH
512 if (is_array($val)) {
513 foreach ($val as $index => $value) {
514 $arr[] = rawurlencode($key.'['.$index.']')."=".rawurlencode($value);
515 }
516 } else {
5c8f6817
SH
517 if (isset($val) && $val !== '') {
518 $arr[] = rawurlencode($key)."=".rawurlencode($val);
519 } else {
520 $arr[] = rawurlencode($key);
521 }
ab82976f 522 }
360e503e 523 }
c7f5e16a 524 if ($escaped) {
525 return implode('&amp;', $arr);
526 } else {
527 return implode('&', $arr);
528 }
360e503e 529 }
7ceb61d8 530
2b3fcef9
PS
531 /**
532 * Shortcut for printing of encoded URL.
2e1d38db 533 *
2b3fcef9
PS
534 * @return string
535 */
536 public function __toString() {
b9bc2019 537 return $this->out(true);
2b3fcef9
PS
538 }
539
360e503e 540 /**
2e1d38db 541 * Output url.
84e3d2cc 542 *
c7f5e16a 543 * If you use the returned URL in HTML code, you want the escaped ampersands. If you use
544 * the returned URL in HTTP headers, you want $escaped=false.
545 *
2e1d38db 546 * @param bool $escaped Use &amp; as params separator instead of plain &
b9bc2019 547 * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
449611af 548 * @return string Resulting URL
360e503e 549 */
b9bc2019 550 public function out($escaped = true, array $overrideparams = null) {
2ab797c9
BH
551
552 global $CFG;
553
554 if (!is_bool($escaped)) {
555 debugging('Escape parameter must be of type boolean, '.gettype($escaped).' given instead.');
556 }
557
558 $url = $this;
559
560 // Allow url's to be rewritten by a plugin.
561 if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
562 $class = $CFG->urlrewriteclass;
563 $pluginurl = $class::url_rewrite($url);
564 if ($pluginurl instanceof moodle_url) {
565 $url = $pluginurl;
566 }
567 }
568
569 return $url->raw_out($escaped, $overrideparams);
570
571 }
572
573 /**
574 * Output url without any rewrites
575 *
576 * This is identical in signature and use to out() but doesn't call the rewrite handler.
577 *
578 * @param bool $escaped Use &amp; as params separator instead of plain &
579 * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
580 * @return string Resulting URL
581 */
582 public function raw_out($escaped = true, array $overrideparams = null) {
b9bc2019
PS
583 if (!is_bool($escaped)) {
584 debugging('Escape parameter must be of type boolean, '.gettype($escaped).' given instead.');
585 }
586
7dff555f 587 $uri = $this->out_omit_querystring().$this->slashargument;
244a32c6 588
8afba50b 589 $querystring = $this->get_query_string($escaped, $overrideparams);
7dff555f 590 if ($querystring !== '') {
eb788065
PS
591 $uri .= '?' . $querystring;
592 }
593 if (!is_null($this->anchor)) {
594 $uri .= '#'.$this->anchor;
360e503e 595 }
a6855934 596
84e3d2cc 597 return $uri;
360e503e 598 }
7ceb61d8 599
eb788065
PS
600 /**
601 * Returns url without parameters, everything before '?'.
5c6ee6ec
DM
602 *
603 * @param bool $includeanchor if {@link self::anchor} is defined, should it be returned?
eb788065
PS
604 * @return string
605 */
5c6ee6ec
DM
606 public function out_omit_querystring($includeanchor = false) {
607
eb788065
PS
608 $uri = $this->scheme ? $this->scheme.':'.((strtolower($this->scheme) == 'mailto') ? '':'//'): '';
609 $uri .= $this->user ? $this->user.($this->pass? ':'.$this->pass:'').'@':'';
610 $uri .= $this->host ? $this->host : '';
611 $uri .= $this->port ? ':'.$this->port : '';
612 $uri .= $this->path ? $this->path : '';
5c6ee6ec
DM
613 if ($includeanchor and !is_null($this->anchor)) {
614 $uri .= '#' . $this->anchor;
615 }
616
eb788065 617 return $uri;
b5d0cafc
PS
618 }
619
827b2f7a 620 /**
2e1d38db
SH
621 * Compares this moodle_url with another.
622 *
827b2f7a 623 * See documentation of constants for an explanation of the comparison flags.
2e1d38db 624 *
827b2f7a 625 * @param moodle_url $url The moodle_url object to compare
626 * @param int $matchtype The type of comparison (URL_MATCH_BASE, URL_MATCH_PARAMS, URL_MATCH_EXACT)
2e1d38db 627 * @return bool
827b2f7a 628 */
629 public function compare(moodle_url $url, $matchtype = URL_MATCH_EXACT) {
c705a24e 630
eb788065
PS
631 $baseself = $this->out_omit_querystring();
632 $baseother = $url->out_omit_querystring();
bf6c37c7 633
2e1d38db
SH
634 // Append index.php if there is no specific file.
635 if (substr($baseself, -1) == '/') {
bf6c37c7 636 $baseself .= 'index.php';
637 }
2e1d38db 638 if (substr($baseother, -1) == '/') {
bf6c37c7 639 $baseother .= 'index.php';
640 }
641
2e1d38db 642 // Compare the two base URLs.
bf6c37c7 643 if ($baseself != $baseother) {
827b2f7a 644 return false;
645 }
646
647 if ($matchtype == URL_MATCH_BASE) {
648 return true;
649 }
650
651 $urlparams = $url->params();
652 foreach ($this->params() as $param => $value) {
653 if ($param == 'sesskey') {
654 continue;
655 }
656 if (!array_key_exists($param, $urlparams) || $urlparams[$param] != $value) {
657 return false;
658 }
659 }
660
661 if ($matchtype == URL_MATCH_PARAMS) {
662 return true;
663 }
664
665 foreach ($urlparams as $param => $value) {
666 if ($param == 'sesskey') {
667 continue;
668 }
669 if (!array_key_exists($param, $this->params()) || $this->param($param) != $value) {
670 return false;
671 }
672 }
673
99151092
SH
674 if ($url->anchor !== $this->anchor) {
675 return false;
676 }
677
827b2f7a 678 return true;
679 }
13b0b271
SH
680
681 /**
682 * Sets the anchor for the URI (the bit after the hash)
2e1d38db 683 *
a6855934 684 * @param string $anchor null means remove previous
13b0b271
SH
685 */
686 public function set_anchor($anchor) {
a6855934 687 if (is_null($anchor)) {
2e1d38db 688 // Remove.
a6855934
PS
689 $this->anchor = null;
690 } else if ($anchor === '') {
2e1d38db 691 // Special case, used as empty link.
a6855934
PS
692 $this->anchor = '';
693 } else if (preg_match('|[a-zA-Z\_\:][a-zA-Z0-9\_\-\.\:]*|', $anchor)) {
2e1d38db 694 // Match the anchor against the NMTOKEN spec.
a6855934
PS
695 $this->anchor = $anchor;
696 } else {
2e1d38db 697 // Bad luck, no valid anchor found.
a6855934 698 $this->anchor = null;
13b0b271
SH
699 }
700 }
462065e8
BH
701
702 /**
703 * Sets the scheme for the URI (the bit before ://)
704 *
705 * @param string $scheme
706 */
707 public function set_scheme($scheme) {
708 // See http://www.ietf.org/rfc/rfc3986.txt part 3.1.
709 if (preg_match('/^[a-zA-Z][a-zA-Z0-9+.-]*$/', $scheme)) {
710 $this->scheme = $scheme;
711 } else {
712 throw new coding_exception('Bad URL scheme.');
713 }
714 }
7dff555f 715
4e40406d 716 /**
2e1d38db
SH
717 * Sets the url slashargument value.
718 *
4e40406d
PS
719 * @param string $path usually file path
720 * @param string $parameter name of page parameter if slasharguments not supported
721 * @param bool $supported usually null, then it depends on $CFG->slasharguments, use true or false for other servers
722 * @return void
723 */
2e1d38db 724 public function set_slashargument($path, $parameter = 'file', $supported = null) {
4e40406d
PS
725 global $CFG;
726 if (is_null($supported)) {
c95442b2 727 $supported = !empty($CFG->slasharguments);
4e40406d
PS
728 }
729
730 if ($supported) {
731 $parts = explode('/', $path);
732 $parts = array_map('rawurlencode', $parts);
733 $path = implode('/', $parts);
734 $this->slashargument = $path;
735 unset($this->params[$parameter]);
736
737 } else {
738 $this->slashargument = '';
739 $this->params[$parameter] = $path;
740 }
741 }
742
2e1d38db 743 // Static factory methods.
7dff555f
PS
744
745 /**
acdb9177 746 * General moodle file url.
2e1d38db 747 *
acdb9177
PS
748 * @param string $urlbase the script serving the file
749 * @param string $path
7dff555f
PS
750 * @param bool $forcedownload
751 * @return moodle_url
752 */
f28ee49e 753 public static function make_file_url($urlbase, $path, $forcedownload = false) {
7dff555f 754 $params = array();
7dff555f
PS
755 if ($forcedownload) {
756 $params['forcedownload'] = 1;
757 }
4e40406d
PS
758 $url = new moodle_url($urlbase, $params);
759 $url->set_slashargument($path);
4e40406d 760 return $url;
7dff555f
PS
761 }
762
763 /**
764 * Factory method for creation of url pointing to plugin file.
2e1d38db 765 *
7dff555f
PS
766 * Please note this method can be used only from the plugins to
767 * create urls of own files, it must not be used outside of plugins!
2e1d38db 768 *
7dff555f 769 * @param int $contextid
f28ee49e 770 * @param string $component
7dff555f
PS
771 * @param string $area
772 * @param int $itemid
773 * @param string $pathname
774 * @param string $filename
775 * @param bool $forcedownload
776 * @return moodle_url
777 */
2e1d38db
SH
778 public static function make_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename,
779 $forcedownload = false) {
7dff555f 780 global $CFG;
672f4836 781 $urlbase = "$CFG->wwwroot/pluginfile.php";
2e1d38db 782 if ($itemid === null) {
f28ee49e
PS
783 return self::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
784 } else {
785 return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
786 }
7dff555f
PS
787 }
788
da1be050
JL
789 /**
790 * Factory method for creation of url pointing to plugin file.
791 * This method is the same that make_pluginfile_url but pointing to the webservice pluginfile.php script.
792 * It should be used only in external functions.
793 *
794 * @since 2.8
795 * @param int $contextid
796 * @param string $component
797 * @param string $area
798 * @param int $itemid
799 * @param string $pathname
800 * @param string $filename
801 * @param bool $forcedownload
802 * @return moodle_url
803 */
804 public static function make_webservice_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename,
805 $forcedownload = false) {
806 global $CFG;
672f4836 807 $urlbase = "$CFG->wwwroot/webservice/pluginfile.php";
da1be050
JL
808 if ($itemid === null) {
809 return self::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
810 } else {
811 return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
812 }
813 }
814
7dff555f 815 /**
2e1d38db
SH
816 * Factory method for creation of url pointing to draft file of current user.
817 *
37416d5d 818 * @param int $draftid draft item id
7dff555f
PS
819 * @param string $pathname
820 * @param string $filename
821 * @param bool $forcedownload
822 * @return moodle_url
823 */
37416d5d 824 public static function make_draftfile_url($draftid, $pathname, $filename, $forcedownload = false) {
7dff555f 825 global $CFG, $USER;
672f4836 826 $urlbase = "$CFG->wwwroot/draftfile.php";
b0c6dc1c 827 $context = context_user::instance($USER->id);
7dff555f 828
37416d5d 829 return self::make_file_url($urlbase, "/$context->id/user/draft/$draftid".$pathname.$filename, $forcedownload);
7dff555f 830 }
ed77a56f
PS
831
832 /**
2e1d38db
SH
833 * Factory method for creating of links to legacy course files.
834 *
ed77a56f
PS
835 * @param int $courseid
836 * @param string $filepath
837 * @param bool $forcedownload
838 * @return moodle_url
839 */
f28ee49e 840 public static function make_legacyfile_url($courseid, $filepath, $forcedownload = false) {
ed77a56f
PS
841 global $CFG;
842
acdb9177
PS
843 $urlbase = "$CFG->wwwroot/file.php";
844 return self::make_file_url($urlbase, '/'.$courseid.'/'.$filepath, $forcedownload);
ed77a56f 845 }
48ddc9bf
DP
846
847 /**
848 * Returns URL a relative path from $CFG->wwwroot
849 *
850 * Can be used for passing around urls with the wwwroot stripped
851 *
852 * @param boolean $escaped Use &amp; as params separator instead of plain &
853 * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
854 * @return string Resulting URL
855 * @throws coding_exception if called on a non-local url
856 */
857 public function out_as_local_url($escaped = true, array $overrideparams = null) {
858 global $CFG;
859
860 $url = $this->out($escaped, $overrideparams);
72b181ba 861
672f4836 862 // Url should be equal to wwwroot. If not then throw exception.
72b181ba
RT
863 if (($url === $CFG->wwwroot) || (strpos($url, $CFG->wwwroot.'/') === 0)) {
864 $localurl = substr($url, strlen($CFG->wwwroot));
865 return !empty($localurl) ? $localurl : '';
72b181ba 866 } else {
48ddc9bf
DP
867 throw new coding_exception('out_as_local_url called on a non-local URL');
868 }
48ddc9bf 869 }
ffe4de97 870
871 /**
872 * Returns the 'path' portion of a URL. For example, if the URL is
873 * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
874 * return '/my/file/is/here.txt'.
875 *
876 * By default the path includes slash-arguments (for example,
877 * '/myfile.php/extra/arguments') so it is what you would expect from a
878 * URL path. If you don't want this behaviour, you can opt to exclude the
a3c17aed 879 * slash arguments. (Be careful: if the $CFG variable slasharguments is
880 * disabled, these URLs will have a different format and you may need to
881 * look at the 'file' parameter too.)
ffe4de97 882 *
883 * @param bool $includeslashargument If true, includes slash arguments
884 * @return string Path of URL
885 */
886 public function get_path($includeslashargument = true) {
887 return $this->path . ($includeslashargument ? $this->slashargument : '');
888 }
a3c17aed 889
890 /**
891 * Returns a given parameter value from the URL.
892 *
893 * @param string $name Name of parameter
894 * @return string Value of parameter or null if not set
895 */
896 public function get_param($name) {
897 if (array_key_exists($name, $this->params)) {
898 return $this->params[$name];
899 } else {
900 return null;
901 }
902 }
d06ffbdf
SC
903
904 /**
905 * Returns the 'scheme' portion of a URL. For example, if the URL is
906 * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
907 * return 'http' (without the colon).
908 *
909 * @return string Scheme of the URL.
910 */
911 public function get_scheme() {
912 return $this->scheme;
913 }
914
915 /**
916 * Returns the 'host' portion of a URL. For example, if the URL is
917 * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
918 * return 'www.example.org'.
919 *
920 * @return string Host of the URL.
921 */
922 public function get_host() {
923 return $this->host;
924 }
925
926 /**
927 * Returns the 'port' portion of a URL. For example, if the URL is
928 * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
929 * return '447'.
930 *
931 * @return string Port of the URL.
932 */
933 public function get_port() {
934 return $this->port;
935 }
360e503e 936}
937
7cf1c7bd 938/**
939 * Determine if there is data waiting to be processed from a form
940 *
941 * Used on most forms in Moodle to check for data
942 * Returns the data as an object, if it's found.
943 * This object can be used in foreach loops without
944 * casting because it's cast to (array) automatically
772e78be 945 *
9c0f063b 946 * Checks that submitted POST data exists and returns it as object.
d48b00b4 947 *
9c0f063b 948 * @return mixed false or object
7cf1c7bd 949 */
294ce987 950function data_submitted() {
d48b00b4 951
607809b3 952 if (empty($_POST)) {
36b4f985 953 return false;
954 } else {
78fcdb5f 955 return (object)fix_utf8($_POST);
36b4f985 956 }
957}
958
7cf1c7bd 959/**
d48b00b4 960 * Given some normal text this function will break up any
961 * long words to a given size by inserting the given character
962 *
6aaa17c7 963 * It's multibyte savvy and doesn't change anything inside html tags.
964 *
7cf1c7bd 965 * @param string $string the string to be modified
89dcb99d 966 * @param int $maxsize maximum length of the string to be returned
7cf1c7bd 967 * @param string $cutchar the string used to represent word breaks
968 * @return string
969 */
4a5644e5 970function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
a2b3f884 971
2e1d38db 972 // First of all, save all the tags inside the text to skip them.
6aaa17c7 973 $tags = array();
2e1d38db 974 filter_save_tags($string, $tags);
5b07d990 975
2e1d38db 976 // Process the string adding the cut when necessary.
4a5644e5 977 $output = '';
2f1e464a 978 $length = core_text::strlen($string);
4a5644e5 979 $wordlength = 0;
980
981 for ($i=0; $i<$length; $i++) {
2f1e464a 982 $char = core_text::substr($string, $i, 1);
6aaa17c7 983 if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
4a5644e5 984 $wordlength = 0;
985 } else {
986 $wordlength++;
987 if ($wordlength > $maxsize) {
988 $output .= $cutchar;
989 $wordlength = 0;
990 }
991 }
992 $output .= $char;
993 }
6aaa17c7 994
2e1d38db 995 // Finally load the tags back again.
6aaa17c7 996 if (!empty($tags)) {
997 $output = str_replace(array_keys($tags), $tags, $output);
998 }
999
4a5644e5 1000 return $output;
1001}
1002
de6d81e6 1003/**
b166403f 1004 * Try and close the current window using JavaScript, either immediately, or after a delay.
449611af 1005 *
1006 * Echo's out the resulting XHTML & javascript
1007 *
b166403f 1008 * @param integer $delay a delay in seconds before closing the window. Default 0.
1009 * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
1010 * to reload the parent window before this one closes.
08396bb2 1011 */
b166403f 1012function close_window($delay = 0, $reloadopener = false) {
f6794ace 1013 global $PAGE, $OUTPUT;
08396bb2 1014
c13a5e71 1015 if (!$PAGE->headerprinted) {
de6d81e6 1016 $PAGE->set_title(get_string('closewindow'));
1017 echo $OUTPUT->header();
b166403f 1018 } else {
f6794ace 1019 $OUTPUT->container_end_all(false);
b166403f 1020 }
1021
1022 if ($reloadopener) {
87113602
TH
1023 // Trigger the reload immediately, even if the reload is after a delay.
1024 $PAGE->requires->js_function_call('window.opener.location.reload', array(true));
b166403f 1025 }
87113602 1026 $OUTPUT->notification(get_string('windowclosing'), 'notifysuccess');
cf615522 1027
87113602 1028 $PAGE->requires->js_function_call('close_window', array(new stdClass()), false, $delay);
b166403f 1029
7e0d6675 1030 echo $OUTPUT->footer();
b166403f 1031 exit;
1032}
08396bb2 1033
28fbce88 1034/**
2e1d38db
SH
1035 * Returns a string containing a link to the user documentation for the current page.
1036 *
1037 * Also contains an icon by default. Shown to teachers and admin only.
28fbce88 1038 *
28fbce88 1039 * @param string $text The text to be displayed for the link
28fbce88 1040 * @return string The link to user documentation for this current page
1041 */
8ae8bf8a 1042function page_doc_link($text='') {
06a72e01
SH
1043 global $OUTPUT, $PAGE;
1044 $path = page_get_doc_link_path($PAGE);
1045 if (!$path) {
1046 return '';
1047 }
1048 return $OUTPUT->doc_link($path, $text);
1049}
1050
1051/**
1052 * Returns the path to use when constructing a link to the docs.
1053 *
5bcfd504 1054 * @since Moodle 2.5.1 2.6
06a72e01
SH
1055 * @param moodle_page $page
1056 * @return string
1057 */
1058function page_get_doc_link_path(moodle_page $page) {
1059 global $CFG;
28fbce88 1060
1061 if (empty($CFG->docroot) || during_initial_install()) {
1062 return '';
1063 }
06a72e01 1064 if (!has_capability('moodle/site:doclinks', $page->context)) {
28fbce88 1065 return '';
1066 }
1067
06a72e01 1068 $path = $page->docspath;
28fbce88 1069 if (!$path) {
1070 return '';
1071 }
06a72e01 1072 return $path;
28fbce88 1073}
1074
14040797 1075
d48b00b4 1076/**
1077 * Validates an email to make sure it makes sense.
1078 *
1079 * @param string $address The email address to validate.
1080 * @return boolean
1081 */
89dcb99d 1082function validate_email($address) {
d48b00b4 1083
7620746f 1084 return (bool)preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
69593309 1085 '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
f9903ed0 1086 '@'.
69593309
AD
1087 '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
1088 '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
7620746f 1089 $address);
f9903ed0 1090}
1091
690f358b 1092/**
1093 * Extracts file argument either from file parameter or PATH_INFO
2e1d38db 1094 *
11e7b506 1095 * Note: $scriptname parameter is not needed anymore
690f358b 1096 *
690f358b 1097 * @return string file path (only safe characters)
1098 */
11e7b506 1099function get_file_argument() {
1100 global $SCRIPT;
690f358b 1101
cdf8238b
MS
1102 $relativepath = false;
1103 $hasforcedslashargs = false;
1104
1105 if (isset($_SERVER['REQUEST_URI']) && !empty($_SERVER['REQUEST_URI'])) {
1106 // Checks whether $_SERVER['REQUEST_URI'] contains '/pluginfile.php/'
1107 // instead of '/pluginfile.php?', when serving a file from e.g. mod_imscp or mod_scorm.
1108 if ((strpos($_SERVER['REQUEST_URI'], '/pluginfile.php/') !== false)
1109 && isset($_SERVER['PATH_INFO']) && !empty($_SERVER['PATH_INFO'])) {
1110 // Exclude edge cases like '/pluginfile.php/?file='.
1111 $args = explode('/', ltrim($_SERVER['PATH_INFO'], '/'));
1112 $hasforcedslashargs = (count($args) > 2); // Always at least: context, component and filearea.
1113 }
1114 }
1115 if (!$hasforcedslashargs) {
1116 $relativepath = optional_param('file', false, PARAM_PATH);
1117 }
690f358b 1118
c281862a
PS
1119 if ($relativepath !== false and $relativepath !== '') {
1120 return $relativepath;
1121 }
1122 $relativepath = false;
1123
2e1d38db 1124 // Then try extract file from the slasharguments.
c281862a 1125 if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
ce1cc198 1126 // NOTE: IIS tends to convert all file paths to single byte DOS encoding,
c281862a 1127 // we can not use other methods because they break unicode chars,
ce1cc198
MS
1128 // the only ways are to use URL rewriting
1129 // OR
1130 // to properly set the 'FastCGIUtf8ServerVariables' registry key.
c281862a 1131 if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
2e1d38db 1132 // Check that PATH_INFO works == must not contain the script name.
c281862a
PS
1133 if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
1134 $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
1135 }
1136 }
1137 } else {
2e1d38db 1138 // All other apache-like servers depend on PATH_INFO.
c281862a
PS
1139 if (isset($_SERVER['PATH_INFO'])) {
1140 if (isset($_SERVER['SCRIPT_NAME']) and strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === 0) {
1141 $relativepath = substr($_SERVER['PATH_INFO'], strlen($_SERVER['SCRIPT_NAME']));
1142 } else {
1143 $relativepath = $_SERVER['PATH_INFO'];
1144 }
1145 $relativepath = clean_param($relativepath, PARAM_PATH);
690f358b 1146 }
1147 }
1148
690f358b 1149 return $relativepath;
1150}
1151
d48b00b4 1152/**
89dcb99d 1153 * Just returns an array of text formats suitable for a popup menu
d48b00b4 1154 *
89dcb99d 1155 * @return array
d48b00b4 1156 */
0095d5cd 1157function format_text_menu() {
b0ccd3fb 1158 return array (FORMAT_MOODLE => get_string('formattext'),
2e1d38db
SH
1159 FORMAT_HTML => get_string('formathtml'),
1160 FORMAT_PLAIN => get_string('formatplain'),
1161 FORMAT_MARKDOWN => get_string('formatmarkdown'));
0095d5cd 1162}
1163
d48b00b4 1164/**
2e1d38db 1165 * Given text in a variety of format codings, this function returns the text as safe HTML.
d48b00b4 1166 *
c5659019 1167 * This function should mainly be used for long strings like posts,
2e1d38db 1168 * answers, glossary items etc. For short strings {@link format_string()}.
e8276c10 1169 *
367a75fa
SH
1170 * <pre>
1171 * Options:
1172 * trusted : If true the string won't be cleaned. Default false required noclean=true.
4b82c15c 1173 * noclean : If true the string won't be cleaned, unless $CFG->forceclean is set. Default false required trusted=true.
367a75fa
SH
1174 * nocache : If true the strign will not be cached and will be formatted every call. Default false.
1175 * filter : If true the string will be run through applicable filters as well. Default true.
1176 * para : If true then the returned string will be wrapped in div tags. Default true.
1177 * newlines : If true then lines newline breaks will be converted to HTML newline breaks. Default true.
1178 * context : The context that will be used for filtering.
1179 * overflowdiv : If set to true the formatted text will be encased in a div
1180 * with the class no-overflow before being returned. Default false.
b031caf8 1181 * allowid : If true then id attributes will not be removed, even when
1182 * using htmlpurifier. Default false.
bf997487 1183 * blanktarget : If true all <a> tags will have target="_blank" added unless target is explicitly specified.
367a75fa
SH
1184 * </pre>
1185 *
449611af 1186 * @staticvar array $croncache
89dcb99d 1187 * @param string $text The text to be formatted. This is raw text originally from user input.
772e78be 1188 * @param int $format Identifier of the text format to be used
35716b86
PS
1189 * [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
1190 * @param object/array $options text formatting options
2e1d38db 1191 * @param int $courseiddonotuse deprecated course id, use context option instead
89dcb99d 1192 * @return string
d48b00b4 1193 */
2e1d38db
SH
1194function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseiddonotuse = null) {
1195 global $CFG, $DB, $PAGE;
795a08ad 1196
6e571603 1197 if ($text === '' || is_null($text)) {
2e1d38db
SH
1198 // No need to do any filters and cleaning.
1199 return '';
d53ca6ad 1200 }
1bcb7eb5 1201
2e1d38db
SH
1202 // Detach object, we can not modify it.
1203 $options = (array)$options;
d53ca6ad 1204
35716b86
PS
1205 if (!isset($options['trusted'])) {
1206 $options['trusted'] = false;
7d8a3cb0 1207 }
35716b86
PS
1208 if (!isset($options['noclean'])) {
1209 if ($options['trusted'] and trusttext_active()) {
2e1d38db 1210 // No cleaning if text trusted and noclean not specified.
35716b86 1211 $options['noclean'] = true;
cbc2b5df 1212 } else {
35716b86 1213 $options['noclean'] = false;
cbc2b5df 1214 }
e7a47153 1215 }
4b82c15c
DM
1216 if (!empty($CFG->forceclean)) {
1217 // Whatever the caller claims, the admin wants all content cleaned anyway.
1218 $options['noclean'] = false;
1219 }
35716b86
PS
1220 if (!isset($options['nocache'])) {
1221 $options['nocache'] = false;
a17c57b5 1222 }
35716b86
PS
1223 if (!isset($options['filter'])) {
1224 $options['filter'] = true;
e7a47153 1225 }
35716b86
PS
1226 if (!isset($options['para'])) {
1227 $options['para'] = true;
e7a47153 1228 }
35716b86
PS
1229 if (!isset($options['newlines'])) {
1230 $options['newlines'] = true;
f0aa2fed 1231 }
367a75fa
SH
1232 if (!isset($options['overflowdiv'])) {
1233 $options['overflowdiv'] = false;
1234 }
bf997487 1235 $options['blanktarget'] = !empty($options['blanktarget']);
35716b86 1236
2e1d38db 1237 // Calculate best context.
c3bc6f12 1238 if (empty($CFG->version) or $CFG->version < 2013051400 or during_initial_install()) {
2e1d38db 1239 // Do not filter anything during installation or before upgrade completes.
8d39cbb3 1240 $context = null;
8d39cbb3 1241
2e1d38db 1242 } else if (isset($options['context'])) { // First by explicit passed context option.
35716b86
PS
1243 if (is_object($options['context'])) {
1244 $context = $options['context'];
1245 } else {
d197ea43 1246 $context = context::instance_by_id($options['context']);
35716b86 1247 }
2e1d38db
SH
1248 } else if ($courseiddonotuse) {
1249 // Legacy courseid.
1250 $context = context_course::instance($courseiddonotuse);
35716b86 1251 } else {
2e1d38db 1252 // Fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(.
35716b86 1253 $context = $PAGE->context;
c4ae4fa1 1254 }
a751a4e5 1255
f22b7397 1256 if (!$context) {
2e1d38db 1257 // Either install/upgrade or something has gone really wrong because context does not exist (yet?).
f22b7397
PS
1258 $options['nocache'] = true;
1259 $options['filter'] = false;
1260 }
1261
35716b86 1262 if ($options['filter']) {
ccc161f8 1263 $filtermanager = filter_manager::instance();
6c5dbbb3 1264 $filtermanager->setup_page_for_filters($PAGE, $context); // Setup global stuff filters may have.
7d94679f
TH
1265 $filteroptions = array(
1266 'originalformat' => $format,
1267 'noclean' => $options['noclean'],
1268 );
ccc161f8 1269 } else {
1270 $filtermanager = new null_filter_manager();
7d94679f 1271 $filteroptions = array();
9e3f34d1 1272 }
ccc161f8 1273
0095d5cd 1274 switch ($format) {
73f8658c 1275 case FORMAT_HTML:
35716b86 1276 if (!$options['noclean']) {
b031caf8 1277 $text = clean_text($text, FORMAT_HTML, $options);
9d40806d 1278 }
7d94679f 1279 $text = $filtermanager->filter_text($text, $context, $filteroptions);
73f8658c 1280 break;
1281
6901fa79 1282 case FORMAT_PLAIN:
2e1d38db 1283 $text = s($text); // Cleans dangerous JS.
ab892a4f 1284 $text = rebuildnolinktag($text);
b0ccd3fb 1285 $text = str_replace(' ', '&nbsp; ', $text);
6901fa79 1286 $text = nl2br($text);
6901fa79 1287 break;
1288
d342c763 1289 case FORMAT_WIKI:
2e1d38db 1290 // This format is deprecated.
572fe9ab 1291 $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle. You should not be seeing
1292 this message as all texts should have been converted to Markdown format instead.
ce50cc70 1293 Please post a bug report to http://moodle.org/bugs with information about where you
e7a47153 1294 saw this message.</p>'.s($text);
d342c763 1295 break;
1296
e7cdcd18 1297 case FORMAT_MARKDOWN:
1298 $text = markdown_to_html($text);
35716b86 1299 if (!$options['noclean']) {
b031caf8 1300 $text = clean_text($text, FORMAT_HTML, $options);
9d40806d 1301 }
7d94679f 1302 $text = $filtermanager->filter_text($text, $context, $filteroptions);
e7cdcd18 1303 break;
1304
2e1d38db 1305 default: // FORMAT_MOODLE or anything else.
84a8bedd 1306 $text = text_to_html($text, null, $options['para'], $options['newlines']);
35716b86 1307 if (!$options['noclean']) {
b031caf8 1308 $text = clean_text($text, FORMAT_HTML, $options);
9d40806d 1309 }
7d94679f 1310 $text = $filtermanager->filter_text($text, $context, $filteroptions);
0095d5cd 1311 break;
0095d5cd 1312 }
893fe4b6 1313 if ($options['filter']) {
2e1d38db 1314 // At this point there should not be any draftfile links any more,
893fe4b6
PS
1315 // this happens when developers forget to post process the text.
1316 // The only potential problem is that somebody might try to format
2e1d38db 1317 // the text before storing into database which would be itself big bug..
672f4836 1318 $text = str_replace("\"$CFG->wwwroot/draftfile.php", "\"$CFG->wwwroot/brokenfile.php#", $text);
3633c257 1319
96f81ea3 1320 if ($CFG->debugdeveloper) {
3633c257 1321 if (strpos($text, '@@PLUGINFILE@@/') !== false) {
2e1d38db
SH
1322 debugging('Before calling format_text(), the content must be processed with file_rewrite_pluginfile_urls()',
1323 DEBUG_DEVELOPER);
3633c257
DM
1324 }
1325 }
893fe4b6 1326 }
f0aa2fed 1327
367a75fa 1328 if (!empty($options['overflowdiv'])) {
2e1d38db 1329 $text = html_writer::tag('div', $text, array('class' => 'no-overflow'));
367a75fa
SH
1330 }
1331
bf997487
CB
1332 if ($options['blanktarget']) {
1333 $domdoc = new DOMDocument();
f31e1e8b 1334 libxml_use_internal_errors(true);
2c4e6d62 1335 $domdoc->loadHTML('<?xml version="1.0" encoding="UTF-8" ?>' . $text);
f31e1e8b 1336 libxml_clear_errors();
bf997487
CB
1337 foreach ($domdoc->getElementsByTagName('a') as $link) {
1338 if ($link->hasAttribute('target') && strpos($link->getAttribute('target'), '_blank') === false) {
1339 continue;
1340 }
1341 $link->setAttribute('target', '_blank');
1342 if (strpos($link->getAttribute('rel'), 'noreferrer') === false) {
1343 $link->setAttribute('rel', trim($link->getAttribute('rel') . ' noreferrer'));
1344 }
1345 }
1346
1347 // This regex is nasty and I don't like it. The correct way to solve this is by loading the HTML like so:
1348 // $domdoc->loadHTML($text, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD); however it seems like the libxml
1349 // version that travis uses doesn't work properly and ends up leaving <html><body>, so I'm forced to use
1350 // this regex to remove those tags.
2549f46f 1351 $text = trim(preg_replace('~<(?:!DOCTYPE|/?(?:html|body))[^>]*>\s*~i', '', $domdoc->saveHTML($domdoc->documentElement)));
bf997487
CB
1352 }
1353
35716b86 1354 return $text;
0095d5cd 1355}
1356
109e3cb2 1357/**
62c80325 1358 * Resets some data related to filters, called during upgrade or when general filter settings change.
449611af 1359 *
a46e11b5 1360 * @param bool $phpunitreset true means called from our PHPUnit integration test reset
109e3cb2 1361 * @return void
1362 */
a46e11b5 1363function reset_text_filters_cache($phpunitreset = false) {
8618fd2a 1364 global $CFG, $DB;
109e3cb2 1365
b2ea1793
PS
1366 if ($phpunitreset) {
1367 // HTMLPurifier does not change, DB is already reset to defaults,
62c80325 1368 // nothing to do here, the dataroot was cleared too.
b2ea1793 1369 return;
a46e11b5
PS
1370 }
1371
62c80325
1372 // The purge_all_caches() deals with cachedir and localcachedir purging,
1373 // the individual filter caches are invalidated as necessary elsewhere.
b2ea1793
PS
1374
1375 // Update $CFG->filterall cache flag.
1376 if (empty($CFG->stringfilters)) {
1377 set_config('filterall', 0);
1378 return;
1379 }
1380 $installedfilters = core_component::get_plugin_list('filter');
1381 $filters = explode(',', $CFG->stringfilters);
1382 foreach ($filters as $filter) {
1383 if (isset($installedfilters[$filter])) {
1384 set_config('filterall', 1);
1385 return;
1386 }
1387 }
1388 set_config('filterall', 0);
109e3cb2 1389}
473d29eb 1390
49c8c8d2 1391/**
449611af 1392 * Given a simple string, this function returns the string
1393 * processed by enabled string filters if $CFG->filterall is enabled
e8276c10 1394 *
449611af 1395 * This function should be used to print short strings (non html) that
1396 * need filter processing e.g. activity titles, post subjects,
1397 * glossary concepts.
7b2c5e72 1398 *
449611af 1399 * @staticvar bool $strcache
d07f7be8
TH
1400 * @param string $string The string to be filtered. Should be plain text, expect
1401 * possibly for multilang tags.
2e1d38db 1402 * @param boolean $striplinks To strip any link in the result text. Moodle 1.8 default changed from false to true! MDL-8713
35716b86 1403 * @param array $options options array/object or courseid
449611af 1404 * @return string
7b2c5e72 1405 */
2e1d38db
SH
1406function format_string($string, $striplinks = true, $options = null) {
1407 global $CFG, $PAGE;
38701b69 1408
2e1d38db 1409 // We'll use a in-memory cache here to speed up repeated strings.
473d29eb 1410 static $strcache = false;
1411
f18c764a 1412 if (empty($CFG->version) or $CFG->version < 2013051400 or during_initial_install()) {
2e1d38db 1413 // Do not filter anything during installation or before upgrade completes.
57cddf6d
PS
1414 return $string = strip_tags($string);
1415 }
1416
2e1d38db
SH
1417 if ($strcache === false or count($strcache) > 2000) {
1418 // This number might need some tuning to limit memory usage in cron.
473d29eb 1419 $strcache = array();
1420 }
84e3d2cc 1421
35716b86 1422 if (is_numeric($options)) {
2e1d38db
SH
1423 // Legacy courseid usage.
1424 $options = array('context' => context_course::instance($options));
35716b86 1425 } else {
2e1d38db
SH
1426 // Detach object, we can not modify it.
1427 $options = (array)$options;
35716b86
PS
1428 }
1429
1430 if (empty($options['context'])) {
2e1d38db 1431 // Fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(.
35716b86
PS
1432 $options['context'] = $PAGE->context;
1433 } else if (is_numeric($options['context'])) {
d197ea43 1434 $options['context'] = context::instance_by_id($options['context']);
35716b86 1435 }
08bda175
DW
1436 if (!isset($options['filter'])) {
1437 $options['filter'] = true;
1438 }
35716b86 1439
6fb1a717
CB
1440 $options['escape'] = !isset($options['escape']) || $options['escape'];
1441
35716b86 1442 if (!$options['context']) {
2e1d38db 1443 // We did not find any context? weird.
57cddf6d 1444 return $string = strip_tags($string);
38701b69 1445 }
1446
2e1d38db 1447 // Calculate md5.
74854585
RW
1448 $cachekeys = array($string, $striplinks, $options['context']->id,
1449 $options['escape'], current_language(), $options['filter']);
1450 $md5 = md5(implode('<+>', $cachekeys));
2a3affe9 1451
2e1d38db 1452 // Fetch from cache if possible.
38701b69 1453 if (isset($strcache[$md5])) {
2a3affe9 1454 return $strcache[$md5];
1455 }
1456
dacb47c0 1457 // First replace all ampersands not followed by html entity code
2e1d38db 1458 // Regular expression moved to its own method for easier unit testing.
6fb1a717 1459 $string = $options['escape'] ? replace_ampersands_not_followed_by_entity($string) : $string;
268ddd50 1460
08bda175 1461 if (!empty($CFG->filterall) && $options['filter']) {
b4402278 1462 $filtermanager = filter_manager::instance();
6c5dbbb3 1463 $filtermanager->setup_page_for_filters($PAGE, $options['context']); // Setup global stuff filters may have.
b9647509 1464 $string = $filtermanager->filter_string($string, $options['context']);
7b2c5e72 1465 }
84e3d2cc 1466
2e1d38db 1467 // If the site requires it, strip ALL tags from this string.
9fbed9c9 1468 if (!empty($CFG->formatstringstriptags)) {
6fb1a717
CB
1469 if ($options['escape']) {
1470 $string = str_replace(array('<', '>'), array('&lt;', '&gt;'), strip_tags($string));
1471 } else {
1472 $string = strip_tags($string);
1473 }
408d5327 1474 } else {
2e1d38db
SH
1475 // Otherwise strip just links if that is required (default).
1476 if ($striplinks) {
1477 // Strip links in string.
31c2087d 1478 $string = strip_links($string);
408d5327 1479 }
1480 $string = clean_text($string);
3e6691ee 1481 }
1482
2e1d38db 1483 // Store to cache.
2a3affe9 1484 $strcache[$md5] = $string;
84e3d2cc 1485
7b2c5e72 1486 return $string;
1487}
1488
6dbcacee 1489/**
1490 * Given a string, performs a negative lookahead looking for any ampersand character
1491 * that is not followed by a proper HTML entity. If any is found, it is replaced
1492 * by &amp;. The string is then returned.
1493 *
1494 * @param string $string
1495 * @return string
1496 */
1497function replace_ampersands_not_followed_by_entity($string) {
1498 return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1499}
1500
31c2087d 1501/**
1502 * Given a string, replaces all <a>.*</a> by .* and returns the string.
49c8c8d2 1503 *
31c2087d 1504 * @param string $string
1505 * @return string
1506 */
1507function strip_links($string) {
2e1d38db 1508 return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is', '$2', $string);
31c2087d 1509}
1510
1511/**
1512 * This expression turns links into something nice in a text format. (Russell Jungwirth)
1513 *
1514 * @param string $string
1515 * @return string
1516 */
1517function wikify_links($string) {
2e1d38db 1518 return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i', '$3 [ $2 ]', $string);
31c2087d 1519}
1520
d48b00b4 1521/**
2e1d38db 1522 * Given text in a variety of format codings, this function returns the text as plain text suitable for plain email.
d48b00b4 1523 *
89dcb99d 1524 * @param string $text The text to be formatted. This is raw text originally from user input.
772e78be 1525 * @param int $format Identifier of the text format to be used
449611af 1526 * [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
89dcb99d 1527 * @return string
d48b00b4 1528 */
d342c763 1529function format_text_email($text, $format) {
d342c763 1530
1531 switch ($format) {
1532
1533 case FORMAT_PLAIN:
1534 return $text;
1535 break;
1536
1537 case FORMAT_WIKI:
2e1d38db 1538 // There should not be any of these any more!
31c2087d 1539 $text = wikify_links($text);
2f1e464a 1540 return core_text::entities_to_utf8(strip_tags($text), true);
d342c763 1541 break;
1542
6ff45b59 1543 case FORMAT_HTML:
1544 return html_to_text($text);
1545 break;
1546
e7cdcd18 1547 case FORMAT_MOODLE:
1548 case FORMAT_MARKDOWN:
67ccec43 1549 default:
31c2087d 1550 $text = wikify_links($text);
2f1e464a 1551 return core_text::entities_to_utf8(strip_tags($text), true);
d342c763 1552 break;
1553 }
1554}
0095d5cd 1555
dc5c2bd9 1556/**
1557 * Formats activity intro text
449611af 1558 *
dc5c2bd9 1559 * @param string $module name of module
1560 * @param object $activity instance of activity
1561 * @param int $cmid course module id
43b44d5e 1562 * @param bool $filter filter resulting html text
2e1d38db 1563 * @return string
dc5c2bd9 1564 */
43b44d5e 1565function format_module_intro($module, $activity, $cmid, $filter=true) {
ac3668bf 1566 global $CFG;
1567 require_once("$CFG->libdir/filelib.php");
b0c6dc1c 1568 $context = context_module::instance($cmid);
2e1d38db 1569 $options = array('noclean' => true, 'para' => false, 'filter' => $filter, 'context' => $context, 'overflowdiv' => true);
64f93798 1570 $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, 'mod_'.$module, 'intro', null);
35716b86 1571 return trim(format_text($intro, $activity->introformat, $options, null));
dc5c2bd9 1572}
cbdfb929 1573
0a8b3583
FM
1574/**
1575 * Removes the usage of Moodle files from a text.
1576 *
1577 * In some rare cases we need to re-use a text that already has embedded links
1578 * to some files hosted within Moodle. But the new area in which we will push
1579 * this content does not support files... therefore we need to remove those files.
1580 *
1581 * @param string $source The text
1582 * @return string The stripped text
1583 */
1584function strip_pluginfile_content($source) {
1585 $baseurl = '@@PLUGINFILE@@';
1586 // Looking for something like < .* "@@pluginfile@@.*" .* >
1587 $pattern = '$<[^<>]+["\']' . $baseurl . '[^"\']*["\'][^<>]*>$';
1588 $stripped = preg_replace($pattern, '', $source);
1589 // Use purify html to rebalence potentially mismatched tags and generally cleanup.
1590 return purify_html($stripped);
1591}
1592
7d8a3cb0 1593/**
cbc2b5df 1594 * Legacy function, used for cleaning of old forum and glossary text only.
449611af 1595 *
54f53184 1596 * @param string $text text that may contain legacy TRUSTTEXT marker
2e1d38db 1597 * @return string text without legacy TRUSTTEXT marker
7d8a3cb0 1598 */
1599function trusttext_strip($text) {
3bf04828 1600 if (!is_string($text)) {
1601 // This avoids the potential for an endless loop below.
1602 throw new coding_exception('trusttext_strip parameter must be a string');
1603 }
2e1d38db 1604 while (true) { // Removing nested TRUSTTEXT.
5ce73257 1605 $orig = $text;
cbc2b5df 1606 $text = str_replace('#####TRUSTTEXT#####', '', $text);
7d8a3cb0 1607 if (strcmp($orig, $text) === 0) {
1608 return $text;
1609 }
1610 }
1611}
1612
cbc2b5df 1613/**
2e1d38db 1614 * Must be called before editing of all texts with trust flag. Removes all XSS nasties from texts stored in database if needed.
449611af 1615 *
2e1d38db 1616 * @param stdClass $object data object with xxx, xxxformat and xxxtrust fields
cbc2b5df 1617 * @param string $field name of text field
2e1d38db
SH
1618 * @param context $context active context
1619 * @return stdClass updated $object
cbc2b5df 1620 */
1621function trusttext_pre_edit($object, $field, $context) {
1622 $trustfield = $field.'trust';
49c8c8d2 1623 $formatfield = $field.'format';
1624
cbc2b5df 1625 if (!$object->$trustfield or !trusttext_trusted($context)) {
1626 $object->$field = clean_text($object->$field, $object->$formatfield);
1627 }
1628
1629 return $object;
1630}
1631
1632/**
449611af 1633 * Is current user trusted to enter no dangerous XSS in this context?
1634 *
cbc2b5df 1635 * Please note the user must be in fact trusted everywhere on this server!!
449611af 1636 *
2e1d38db 1637 * @param context $context
cbc2b5df 1638 * @return bool true if user trusted
1639 */
1640function trusttext_trusted($context) {
49c8c8d2 1641 return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
cbc2b5df 1642}
1643
1644/**
1645 * Is trusttext feature active?
449611af 1646 *
cbc2b5df 1647 * @return bool
1648 */
1649function trusttext_active() {
1650 global $CFG;
1651
49c8c8d2 1652 return !empty($CFG->enabletrusttext);
cbc2b5df 1653}
1654
d48b00b4 1655/**
2e1d38db
SH
1656 * Cleans raw text removing nasties.
1657 *
1658 * Given raw text (eg typed in by a user) this function cleans it up and removes any nasty tags that could mess up
1659 * Moodle pages through XSS attacks.
4e8d084b
PS
1660 *
1661 * The result must be used as a HTML text fragment, this function can not cleanup random
1662 * parts of html tags such as url or src attributes.
d48b00b4 1663 *
e6906df2
PS
1664 * NOTE: the format parameter was deprecated because we can safely clean only HTML.
1665 *
89dcb99d 1666 * @param string $text The text to be cleaned
4e8d084b 1667 * @param int|string $format deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
b031caf8 1668 * @param array $options Array of options; currently only option supported is 'allowid' (if true,
1669 * does not remove id attributes when cleaning)
89dcb99d 1670 * @return string The cleaned up text
d48b00b4 1671 */
b031caf8 1672function clean_text($text, $format = FORMAT_HTML, $options = array()) {
986f8ea2 1673 $text = (string)$text;
3fe3851d 1674
e6906df2 1675 if ($format != FORMAT_HTML and $format != FORMAT_HTML) {
2e1d38db
SH
1676 // TODO: we need to standardise cleanup of text when loading it into editor first.
1677 // debugging('clean_text() is designed to work only with html');.
e6906df2 1678 }
e7cdcd18 1679
e6906df2
PS
1680 if ($format == FORMAT_PLAIN) {
1681 return $text;
1682 }
e7cdcd18 1683
986f8ea2
PS
1684 if (is_purify_html_necessary($text)) {
1685 $text = purify_html($text, $options);
1686 }
7789ffbf 1687
4e8d084b
PS
1688 // Originally we tried to neutralise some script events here, it was a wrong approach because
1689 // it was trivial to work around that (for example using style based XSS exploits).
1690 // We must not give false sense of security here - all developers MUST understand how to use
1691 // rawurlencode(), htmlentities(), htmlspecialchars(), p(), s(), moodle_url, html_writer and friends!!!
6901fa79 1692
e6906df2 1693 return $text;
b7a3cf49 1694}
f9903ed0 1695
986f8ea2
PS
1696/**
1697 * Is it necessary to use HTMLPurifier?
2e1d38db 1698 *
986f8ea2
PS
1699 * @private
1700 * @param string $text
1701 * @return bool false means html is safe and valid, true means use HTMLPurifier
1702 */
1703function is_purify_html_necessary($text) {
1704 if ($text === '') {
1705 return false;
1706 }
1707
1708 if ($text === (string)((int)$text)) {
1709 return false;
1710 }
1711
1712 if (strpos($text, '&') !== false or preg_match('|<[^pesb/]|', $text)) {
2e1d38db 1713 // We need to normalise entities or other tags except p, em, strong and br present.
986f8ea2
PS
1714 return true;
1715 }
1716
1717 $altered = htmlspecialchars($text, ENT_NOQUOTES, 'UTF-8', true);
1718 if ($altered === $text) {
2e1d38db 1719 // No < > or other special chars means this must be safe.
986f8ea2
PS
1720 return false;
1721 }
1722
2e1d38db 1723 // Let's try to convert back some safe html tags.
986f8ea2
PS
1724 $altered = preg_replace('|&lt;p&gt;(.*?)&lt;/p&gt;|m', '<p>$1</p>', $altered);
1725 if ($altered === $text) {
1726 return false;
1727 }
1728 $altered = preg_replace('|&lt;em&gt;([^<>]+?)&lt;/em&gt;|m', '<em>$1</em>', $altered);
1729 if ($altered === $text) {
1730 return false;
1731 }
1732 $altered = preg_replace('|&lt;strong&gt;([^<>]+?)&lt;/strong&gt;|m', '<strong>$1</strong>', $altered);
1733 if ($altered === $text) {
1734 return false;
1735 }
1736 $altered = str_replace('&lt;br /&gt;', '<br />', $altered);
1737 if ($altered === $text) {
1738 return false;
1739 }
1740
1741 return true;
1742}
1743
e0ac8448 1744/**
1745 * KSES replacement cleaning function - uses HTML Purifier.
449611af 1746 *
449611af 1747 * @param string $text The (X)HTML string to purify
b031caf8 1748 * @param array $options Array of options; currently only option supported is 'allowid' (if set,
1749 * does not remove id attributes when cleaning)
73b309e6 1750 * @return string
e0ac8448 1751 */
b031caf8 1752function purify_html($text, $options = array()) {
e0ac8448 1753 global $CFG;
1754
528a7b44
PS
1755 $text = (string)$text;
1756
b031caf8 1757 static $purifiers = array();
e85c56cc
SH
1758 static $caches = array();
1759
528a7b44
PS
1760 // Purifier code can change only during major version upgrade.
1761 $version = empty($CFG->version) ? 0 : $CFG->version;
1762 $cachedir = "$CFG->localcachedir/htmlpurifier/$version";
1763 if (!file_exists($cachedir)) {
1764 // Purging of caches may remove the cache dir at any time,
1765 // luckily file_exists() results should be cached for all existing directories.
1766 $purifiers = array();
1767 $caches = array();
1768 gc_collect_cycles();
1769
1770 make_localcache_directory('htmlpurifier', false);
1771 check_dir_exists($cachedir);
1772 }
1773
1774 $allowid = empty($options['allowid']) ? 0 : 1;
1775 $allowobjectembed = empty($CFG->allowobjectembed) ? 0 : 1;
1776
1777 $type = 'type_'.$allowid.'_'.$allowobjectembed;
e85c56cc
SH
1778
1779 if (!array_key_exists($type, $caches)) {
1780 $caches[$type] = cache::make('core', 'htmlpurifier', array('type' => $type));
1781 }
1782 $cache = $caches[$type];
1783
528a7b44
PS
1784 // Add revision number and all options to the text key so that it is compatible with local cluster node caches.
1785 $key = "|$version|$allowobjectembed|$allowid|$text";
1786 $filteredtext = $cache->get($key);
1787
1788 if ($filteredtext === true) {
1789 // The filtering did not change the text last time, no need to filter anything again.
1790 return $text;
1791 } else if ($filteredtext !== false) {
e85c56cc
SH
1792 return $filteredtext;
1793 }
1794
b031caf8 1795 if (empty($purifiers[$type])) {
eb203ee4 1796 require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
590abcf8 1797 require_once $CFG->libdir.'/htmlpurifier/locallib.php';
e0ac8448 1798 $config = HTMLPurifier_Config::createDefault();
f71c7f00
PS
1799
1800 $config->set('HTML.DefinitionID', 'moodlehtml');
f34d7af0 1801 $config->set('HTML.DefinitionRev', 6);
f71c7f00 1802 $config->set('Cache.SerializerPath', $cachedir);
7df50029 1803 $config->set('Cache.SerializerPermissions', $CFG->directorypermissions);
f71c7f00 1804 $config->set('Core.NormalizeNewlines', false);
6ec450fb 1805 $config->set('Core.ConvertDocumentToFragment', true);
1806 $config->set('Core.Encoding', 'UTF-8');
1807 $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
2e1d38db
SH
1808 $config->set('URI.AllowedSchemes', array(
1809 'http' => true,
1810 'https' => true,
1811 'ftp' => true,
1812 'irc' => true,
1813 'nntp' => true,
1814 'news' => true,
1815 'rtsp' => true,
817b2020 1816 'rtmp' => true,
2e1d38db
SH
1817 'teamspeak' => true,
1818 'gopher' => true,
1819 'mms' => true,
1820 'mailto' => true
1821 ));
6ec450fb 1822 $config->set('Attr.AllowedFrameTargets', array('_blank'));
f71c7f00 1823
528a7b44 1824 if ($allowobjectembed) {
cbe44fb2
PS
1825 $config->set('HTML.SafeObject', true);
1826 $config->set('Output.FlashCompat', true);
a0f97768 1827 $config->set('HTML.SafeEmbed', true);
cbe44fb2
PS
1828 }
1829
528a7b44 1830 if ($allowid) {
b031caf8 1831 $config->set('Attr.EnableID', true);
1832 }
1833
7df50029 1834 if ($def = $config->maybeGetRawHTMLDefinition()) {
528a7b44
PS
1835 $def->addElement('nolink', 'Block', 'Flow', array()); // Skip our filters inside.
1836 $def->addElement('tex', 'Inline', 'Inline', array()); // Tex syntax, equivalent to $$xx$$.
1837 $def->addElement('algebra', 'Inline', 'Inline', array()); // Algebra syntax, equivalent to @@xx@@.
1838 $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // Original multilang style - only our hacked lang attribute.
1839 $def->addAttribute('span', 'xxxlang', 'CDATA'); // Current very problematic multilang.
171b4563 1840
37c10287
CB
1841 // Media elements.
1842 // https://html.spec.whatwg.org/#the-video-element
28e27ac8 1843 $def->addElement('video', 'Block', 'Optional: #PCDATA | Flow | source | track', 'Common', [
37c10287
CB
1844 'src' => 'URI',
1845 'crossorigin' => 'Enum#anonymous,use-credentials',
1846 'poster' => 'URI',
1847 'preload' => 'Enum#auto,metadata,none',
1848 'autoplay' => 'Bool',
1849 'playsinline' => 'Bool',
1850 'loop' => 'Bool',
1851 'muted' => 'Bool',
1852 'controls' => 'Bool',
1853 'width' => 'Length',
1854 'height' => 'Length',
1855 ]);
1856 // https://html.spec.whatwg.org/#the-audio-element
28e27ac8 1857 $def->addElement('audio', 'Block', 'Optional: #PCDATA | Flow | source | track', 'Common', [
37c10287
CB
1858 'src' => 'URI',
1859 'crossorigin' => 'Enum#anonymous,use-credentials',
1860 'preload' => 'Enum#auto,metadata,none',
1861 'autoplay' => 'Bool',
1862 'loop' => 'Bool',
1863 'muted' => 'Bool',
1864 'controls' => 'Bool'
1865 ]);
1866 // https://html.spec.whatwg.org/#the-source-element
28e27ac8 1867 $def->addElement('source', false, 'Empty', null, [
37c10287
CB
1868 'src' => 'URI',
1869 'type' => 'Text'
1870 ]);
28e27ac8
MG
1871 // https://html.spec.whatwg.org/#the-track-element
1872 $def->addElement('track', false, 'Empty', null, [
1873 'src' => 'URI',
1874 'kind' => 'Enum#subtitles,captions,descriptions,chapters,metadata',
1875 'srclang' => 'Text',
1876 'label' => 'Text',
1877 'default' => 'Bool',
1878 ]);
37c10287 1879
171b4563
JC
1880 // Use the built-in Ruby module to add annotation support.
1881 $def->manager->addModule(new HTMLPurifier_HTMLModule_Ruby());
7df50029 1882 }
f71c7f00 1883
e0ac8448 1884 $purifier = new HTMLPurifier($config);
b031caf8 1885 $purifiers[$type] = $purifier;
1886 } else {
1887 $purifier = $purifiers[$type];
e0ac8448 1888 }
f71c7f00
PS
1889
1890 $multilang = (strpos($text, 'class="multilang"') !== false);
1891
e85c56cc 1892 $filteredtext = $text;
f71c7f00 1893 if ($multilang) {
2e1d38db
SH
1894 $filteredtextregex = '/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/';
1895 $filteredtext = preg_replace($filteredtextregex, '<span xxxlang="${2}">', $filteredtext);
f71c7f00 1896 }
528a7b44 1897 $filteredtext = (string)$purifier->purify($filteredtext);
f71c7f00 1898 if ($multilang) {
e85c56cc 1899 $filteredtext = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $filteredtext);
f71c7f00 1900 }
528a7b44
PS
1901
1902 if ($text === $filteredtext) {
1903 // No need to store the filtered text, next time we will just return unfiltered text
1904 // because it was not changed by purifying.
1905 $cache->set($key, true);
1906 } else {
1907 $cache->set($key, $filteredtext);
1908 }
f71c7f00 1909
e85c56cc 1910 return $filteredtext;
e0ac8448 1911}
1912
89dcb99d 1913/**
1914 * Given plain text, makes it into HTML as nicely as possible.
2e1d38db
SH
1915 *
1916 * May contain HTML tags already.
89dcb99d 1917 *
84a8bedd 1918 * Do not abuse this function. It is intended as lower level formatting feature used
2e1d38db 1919 * by {@link format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
84a8bedd
DM
1920 * to call format_text() in most of cases.
1921 *
89dcb99d 1922 * @param string $text The string to convert.
2e1d38db 1923 * @param boolean $smileyignored Was used to determine if smiley characters should convert to smiley images, ignored now
b075eb8e 1924 * @param boolean $para If true then the returned string will be wrapped in div tags
89dcb99d 1925 * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1926 * @return string
1927 */
2e1d38db
SH
1928function text_to_html($text, $smileyignored = null, $para = true, $newlines = true) {
1929 // Remove any whitespace that may be between HTML tags.
6dbcacee 1930 $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
7b3be1b1 1931
2e1d38db 1932 // Remove any returns that precede or follow HTML tags.
6dbcacee 1933 $text = preg_replace("~([\n\r])<~i", " <", $text);
1934 $text = preg_replace("~>([\n\r])~i", "> ", $text);
7b3be1b1 1935
2e1d38db 1936 // Make returns into HTML newlines.
b7a3d3b2 1937 if ($newlines) {
1938 $text = nl2br($text);
1939 }
f9903ed0 1940
2e1d38db 1941 // Wrap the whole thing in a div if required.
909f539d 1942 if ($para) {
2e1d38db 1943 // In 1.9 this was changed from a p => div.
b075eb8e 1944 return '<div class="text_to_html">'.$text.'</div>';
909f539d 1945 } else {
1946 return $text;
1947 }
f9903ed0 1948}
1949
d48b00b4 1950/**
1951 * Given Markdown formatted text, make it into XHTML using external function
1952 *
89dcb99d 1953 * @param string $text The markdown formatted text to be converted.
1954 * @return string Converted text
d48b00b4 1955 */
e7cdcd18 1956function markdown_to_html($text) {
e7cdcd18 1957 global $CFG;
1958
2e1d38db 1959 if ($text === '' or $text === null) {
a4a0c9d9
PS
1960 return $text;
1961 }
1962
cfc9130e 1963 require_once($CFG->libdir .'/markdown/MarkdownInterface.php');
baf3d690
PS
1964 require_once($CFG->libdir .'/markdown/Markdown.php');
1965 require_once($CFG->libdir .'/markdown/MarkdownExtra.php');
e7cdcd18 1966
baf3d690 1967 return \Michelf\MarkdownExtra::defaultTransform($text);
e7cdcd18 1968}
1969
d48b00b4 1970/**
89dcb99d 1971 * Given HTML text, make it into plain text using external function
d48b00b4 1972 *
d48b00b4 1973 * @param string $html The text to be converted.
a194c218
TH
1974 * @param integer $width Width to wrap the text at. (optional, default 75 which
1975 * is a good value for email. 0 means do not limit line length.)
dc3e95c0
TH
1976 * @param boolean $dolinks By default, any links in the HTML are collected, and
1977 * printed as a list at the end of the HTML. If you don't want that, set this
1978 * argument to false.
a194c218 1979 * @return string plain text equivalent of the HTML.
d48b00b4 1980 */
dc3e95c0 1981function html_to_text($html, $width = 75, $dolinks = true) {
428aaa29 1982 global $CFG;
6ff45b59 1983
ec2d33df
AN
1984 require_once($CFG->libdir .'/html2text/lib.php');
1985
1986 $options = array(
1987 'width' => $width,
1988 'do_links' => 'table',
1989 );
6ff45b59 1990
ec2d33df
AN
1991 if (empty($dolinks)) {
1992 $options['do_links'] = 'none';
1993 }
1994 $h2t = new core_html2text($html, $options);
1995 $result = $h2t->getText();
07e9a300 1996
977b3d31 1997 return $result;
6ff45b59 1998}
1999
69d66020 2000/**
505ce884
DM
2001 * Converts texts or strings to plain text.
2002 *
2003 * - When used to convert user input introduced in an editor the text format needs to be passed in $contentformat like we usually
2004 * do in format_text.
2005 * - When this function is used for strings that are usually passed through format_string before displaying them
2006 * we need to set $contentformat to false. This will execute html_to_text as these strings can contain multilang tags if
2007 * multilang filter is applied to headings.
69d66020
DM
2008 *
2009 * @param string $content The text as entered by the user
505ce884 2010 * @param int|false $contentformat False for strings or the text format: FORMAT_MOODLE/FORMAT_HTML/FORMAT_PLAIN/FORMAT_MARKDOWN
69d66020
DM
2011 * @return string Plain text.
2012 */
2013function content_to_text($content, $contentformat) {
2014
2015 switch ($contentformat) {
2016 case FORMAT_PLAIN:
505ce884
DM
2017 // Nothing here.
2018 break;
69d66020 2019 case FORMAT_MARKDOWN:
505ce884
DM
2020 $content = markdown_to_html($content);
2021 $content = html_to_text($content, 75, false);
2022 break;
69d66020 2023 default:
505ce884
DM
2024 // FORMAT_HTML, FORMAT_MOODLE and $contentformat = false, the later one are strings usually formatted through
2025 // format_string, we need to convert them from html because they can contain HTML (multilang filter).
2026 $content = html_to_text($content, 75, false);
69d66020 2027 }
505ce884
DM
2028
2029 return trim($content, "\r\n ");
69d66020
DM
2030}
2031
d48b00b4 2032/**
2033 * This function will highlight search words in a given string
449611af 2034 *
d48b00b4 2035 * It cares about HTML and will not ruin links. It's best to use
2036 * this function after performing any conversions to HTML.
d48b00b4 2037 *
9289e4c9 2038 * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
2039 * @param string $haystack The string (HTML) within which to highlight the search terms.
2040 * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
2041 * @param string $prefix the string to put before each search term found.
2042 * @param string $suffix the string to put after each search term found.
2043 * @return string The highlighted HTML.
d48b00b4 2044 */
9289e4c9 2045function highlight($needle, $haystack, $matchcase = false,
2046 $prefix = '<span class="highlight">', $suffix = '</span>') {
587c7040 2047
2e1d38db 2048 // Quick bail-out in trivial cases.
587c7040 2049 if (empty($needle) or empty($haystack)) {
69d51d3a 2050 return $haystack;
2051 }
2052
2e1d38db 2053 // Break up the search term into words, discard any -words and build a regexp.
9289e4c9 2054 $words = preg_split('/ +/', trim($needle));
2055 foreach ($words as $index => $word) {
2056 if (strpos($word, '-') === 0) {
2057 unset($words[$index]);
2058 } else if (strpos($word, '+') === 0) {
2059 $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
2060 } else {
2061 $words[$index] = preg_quote($word, '/');
88438a58 2062 }
2063 }
2e1d38db 2064 $regexp = '/(' . implode('|', $words) . ')/u'; // Char u is to do UTF-8 matching.
9289e4c9 2065 if (!$matchcase) {
2066 $regexp .= 'i';
88438a58 2067 }
2068
2e1d38db 2069 // Another chance to bail-out if $search was only -words.
9289e4c9 2070 if (empty($words)) {
2071 return $haystack;
88438a58 2072 }
88438a58 2073
1fa2823d
TH
2074 // Split the string into HTML tags and real content.
2075 $chunks = preg_split('/((?:<[^>]*>)+)/', $haystack, -1, PREG_SPLIT_DELIM_CAPTURE);
2076
2077 // We have an array of alternating blocks of text, then HTML tags, then text, ...
2078 // Loop through replacing search terms in the text, and leaving the HTML unchanged.
2079 $ishtmlchunk = false;
2080 $result = '';
2081 foreach ($chunks as $chunk) {
2082 if ($ishtmlchunk) {
2083 $result .= $chunk;
2084 } else {
2085 $result .= preg_replace($regexp, $prefix . '$1' . $suffix, $chunk);
2086 }
2087 $ishtmlchunk = !$ishtmlchunk;
9289e4c9 2088 }
9ccdcd97 2089
1fa2823d 2090 return $result;
88438a58 2091}
2092
d48b00b4 2093/**
2094 * This function will highlight instances of $needle in $haystack
449611af 2095 *
2096 * It's faster that the above function {@link highlight()} and doesn't care about
d48b00b4 2097 * HTML or anything.
2098 *
2099 * @param string $needle The string to search for
2100 * @param string $haystack The string to search for $needle in
449611af 2101 * @return string The highlighted HTML
d48b00b4 2102 */
88438a58 2103function highlightfast($needle, $haystack) {
5af78ed2 2104
587c7040 2105 if (empty($needle) or empty($haystack)) {
2106 return $haystack;
2107 }
2108
2f1e464a 2109 $parts = explode(core_text::strtolower($needle), core_text::strtolower($haystack));
5af78ed2 2110
587c7040 2111 if (count($parts) === 1) {
2112 return $haystack;
2113 }
2114
5af78ed2 2115 $pos = 0;
2116
2117 foreach ($parts as $key => $part) {
2118 $parts[$key] = substr($haystack, $pos, strlen($part));
2119 $pos += strlen($part);
2120
b0ccd3fb 2121 $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
5af78ed2 2122 $pos += strlen($needle);
ab9f24ad 2123 }
5af78ed2 2124
587c7040 2125 return str_replace('<span class="highlight"></span>', '', join('', $parts));
5af78ed2 2126}
2127
2ab4e4b8 2128/**
2129 * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
2e1d38db 2130 *
2ab4e4b8 2131 * Internationalisation, for print_header and backup/restorelib.
449611af 2132 *
2133 * @param bool $dir Default false
2134 * @return string Attributes
2ab4e4b8 2135 */
2136function get_html_lang($dir = false) {
2137 $direction = '';
2138 if ($dir) {
e372f4c7 2139 if (right_to_left()) {
2ab4e4b8 2140 $direction = ' dir="rtl"';
2141 } else {
2142 $direction = ' dir="ltr"';
2143 }
2144 }
2e1d38db 2145 // Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
3a915b06 2146 $language = str_replace('_', '-', current_language());
0946fff4 2147 @header('Content-Language: '.$language);
84e3d2cc 2148 return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
2ab4e4b8 2149}
2150
34a2777c 2151
2e1d38db 2152// STANDARD WEB PAGE PARTS.
34a2777c 2153
5c355019 2154/**
34a2777c 2155 * Send the HTTP headers that Moodle requires.
9172fd82
PS
2156 *
2157 * There is a backwards compatibility hack for legacy code
2158 * that needs to add custom IE compatibility directive.
2159 *
2160 * Example:
2161 * <code>
2162 * if (!isset($CFG->additionalhtmlhead)) {
2163 * $CFG->additionalhtmlhead = '';
2164 * }
2165 * $CFG->additionalhtmlhead .= '<meta http-equiv="X-UA-Compatible" content="IE=8" />';
2166 * header('X-UA-Compatible: IE=8');
2167 * echo $OUTPUT->header();
2168 * </code>
2169 *
2170 * Please note the $CFG->additionalhtmlhead alone might not work,
2171 * you should send the IE compatibility header() too.
2172 *
2173 * @param string $contenttype
2174 * @param bool $cacheable Can this page be cached on back?
2175 * @return void, sends HTTP headers
5c355019 2176 */
34a2777c 2177function send_headers($contenttype, $cacheable = true) {
5c754932
PS
2178 global $CFG;
2179
34a2777c 2180 @header('Content-Type: ' . $contenttype);
2181 @header('Content-Script-Type: text/javascript');
2182 @header('Content-Style-Type: text/css');
79192273
PS
2183
2184 if (empty($CFG->additionalhtmlhead) or stripos($CFG->additionalhtmlhead, 'X-UA-Compatible') === false) {
2185 @header('X-UA-Compatible: IE=edge');
2186 }
f9903ed0 2187
34a2777c 2188 if ($cacheable) {
2e1d38db 2189 // Allow caching on "back" (but not on normal clicks).
c3a3f540 2190 @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0, no-transform');
34a2777c 2191 @header('Pragma: no-cache');
2192 @header('Expires: ');
2193 } else {
2e1d38db 2194 // Do everything we can to always prevent clients and proxies caching.
34a2777c 2195 @header('Cache-Control: no-store, no-cache, must-revalidate');
c3a3f540 2196 @header('Cache-Control: post-check=0, pre-check=0, no-transform', false);
34a2777c 2197 @header('Pragma: no-cache');
2198 @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2199 @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2200 }
2201 @header('Accept-Ranges: none');
5c754932
PS
2202
2203 if (empty($CFG->allowframembedding)) {
2204 @header('X-Frame-Options: sameorigin');
2205 }
34a2777c 2206}
9fa49e22 2207
ce3735d4 2208/**
a84dea2c 2209 * Return the right arrow with text ('next'), and optionally embedded in a link.
449611af 2210 *
ac905235 2211 * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
a84dea2c 2212 * @param string $url An optional link to use in a surrounding HTML anchor.
2213 * @param bool $accesshide True if text should be hidden (for screen readers only).
2214 * @param string $addclass Additional class names for the link, or the arrow character.
2215 * @return string HTML string.
ce3735d4 2216 */
162f90e5 2217function link_arrow_right($text, $url='', $accesshide=false, $addclass='', $addparams = []) {
2e1d38db 2218 global $OUTPUT; // TODO: move to output renderer.
a84dea2c 2219 $arrowclass = 'arrow ';
2e1d38db 2220 if (!$url) {
a84dea2c 2221 $arrowclass .= $addclass;
2222 }
92e01ab7 2223 $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
a84dea2c 2224 $htmltext = '';
2225 if ($text) {
388794fd 2226 $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
a84dea2c 2227 if ($accesshide) {
1d75edd0 2228 $htmltext = get_accesshide($htmltext);
a84dea2c 2229 }
ce3735d4 2230 }
a84dea2c 2231 if ($url) {
388794fd 2232 $class = 'arrow_link';
a84dea2c 2233 if ($addclass) {
388794fd 2234 $class .= ' '.$addclass;
a84dea2c 2235 }
162f90e5
AN
2236
2237 $linkparams = [
2238 'class' => $class,
2239 'href' => $url,
2240 'title' => preg_replace('/<.*?>/', '', $text),
2241 ];
2242
2243 $linkparams += $addparams;
2244
2245 return html_writer::link($url, $htmltext . $arrow, $linkparams);
a84dea2c 2246 }
2247 return $htmltext.$arrow;
ce3735d4 2248}
2249
2250/**
a84dea2c 2251 * Return the left arrow with text ('previous'), and optionally embedded in a link.
449611af 2252 *
ac905235 2253 * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
a84dea2c 2254 * @param string $url An optional link to use in a surrounding HTML anchor.
2255 * @param bool $accesshide True if text should be hidden (for screen readers only).
2256 * @param string $addclass Additional class names for the link, or the arrow character.
2257 * @return string HTML string.
ce3735d4 2258 */
162f90e5 2259function link_arrow_left($text, $url='', $accesshide=false, $addclass='', $addparams = []) {
2e1d38db 2260 global $OUTPUT; // TODO: move to utput renderer.
a84dea2c 2261 $arrowclass = 'arrow ';
2262 if (! $url) {
2263 $arrowclass .= $addclass;
2264 }
92e01ab7 2265 $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
a84dea2c 2266 $htmltext = '';
2267 if ($text) {
388794fd 2268 $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
a84dea2c 2269 if ($accesshide) {
1d75edd0 2270 $htmltext = get_accesshide($htmltext);
a84dea2c 2271 }
ce3735d4 2272 }
a84dea2c 2273 if ($url) {
388794fd 2274 $class = 'arrow_link';
a84dea2c 2275 if ($addclass) {
388794fd 2276 $class .= ' '.$addclass;
a84dea2c 2277 }
162f90e5
AN
2278
2279 $linkparams = [
2280 'class' => $class,
2281 'href' => $url,
2282 'title' => preg_replace('/<.*?>/', '', $text),
2283 ];
2284
2285 $linkparams += $addparams;
2286
2287 return html_writer::link($url, $arrow . $htmltext, $linkparams);
a84dea2c 2288 }
2289 return $arrow.$htmltext;
2290}
2291
1d75edd0 2292/**
2293 * Return a HTML element with the class "accesshide", for accessibility.
2e1d38db 2294 *
449611af 2295 * Please use cautiously - where possible, text should be visible!
2296 *
1d75edd0 2297 * @param string $text Plain text.
2298 * @param string $elem Lowercase element name, default "span".
2299 * @param string $class Additional classes for the element.
2300 * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
2301 * @return string HTML string.
2302 */
2303function get_accesshide($text, $elem='span', $class='', $attrs='') {
2304 return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
2305}
2306
a84dea2c 2307/**
2308 * Return the breadcrumb trail navigation separator.
449611af 2309 *
a84dea2c 2310 * @return string HTML string.
2311 */
2312function get_separator() {
2e1d38db 2313 // Accessibility: the 'hidden' slash is preferred for screen readers.
a84dea2c 2314 return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
ce3735d4 2315}
2316
512c5901 2317/**
2e1d38db 2318 * Print (or return) a collapsible region, that has a caption that can be clicked to expand or collapse the region.
49c8c8d2 2319 *
fa9f6bf6 2320 * If JavaScript is off, then the region will always be expanded.
512c5901 2321 *
2322 * @param string $contents the contents of the box.
2323 * @param string $classes class names added to the div that is output.
2324 * @param string $id id added to the div that is output. Must not be blank.
2325 * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
fa9f6bf6 2326 * @param string $userpref the name of the user preference that stores the user's preferred default state.
512c5901 2327 * (May be blank if you do not wish the state to be persisted.
fa9f6bf6 2328 * @param boolean $default Initial collapsed state to use if the user_preference it not set.
512c5901 2329 * @param boolean $return if true, return the HTML as a string, rather than printing it.
449611af 2330 * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
512c5901 2331 */
f2eb5002 2332function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
ad9ab4df 2333 $output = print_collapsible_region_start($classes, $id, $caption, $userpref, $default, true);
f2eb5002 2334 $output .= $contents;
2335 $output .= print_collapsible_region_end(true);
2336
2337 if ($return) {
2338 return $output;
2339 } else {
2340 echo $output;
2341 }
2342}
2343
512c5901 2344/**
2e1d38db
SH
2345 * Print (or return) the start of a collapsible region
2346 *
2347 * The collapsibleregion has a caption that can be clicked to expand or collapse the region. If JavaScript is off, then the region
fa9f6bf6 2348 * will always be expanded.
512c5901 2349 *
2350 * @param string $classes class names added to the div that is output.
2351 * @param string $id id added to the div that is output. Must not be blank.
2352 * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
ad9ab4df 2353 * @param string $userpref the name of the user preference that stores the user's preferred default state.
512c5901 2354 * (May be blank if you do not wish the state to be persisted.
fa9f6bf6 2355 * @param boolean $default Initial collapsed state to use if the user_preference it not set.
512c5901 2356 * @param boolean $return if true, return the HTML as a string, rather than printing it.
449611af 2357 * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
512c5901 2358 */
ad9ab4df 2359function print_collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2e1d38db 2360 global $PAGE;
f2eb5002 2361
f2eb5002 2362 // Work out the initial state.
ad9ab4df 2363 if (!empty($userpref) and is_string($userpref)) {
f2eb5002 2364 user_preference_allow_ajax_update($userpref, PARAM_BOOL);
2365 $collapsed = get_user_preferences($userpref, $default);
2366 } else {
2367 $collapsed = $default;
2368 $userpref = false;
2369 }
2370
67c8a3e8 2371 if ($collapsed) {
2372 $classes .= ' collapsed';
2373 }
2374
f2eb5002 2375 $output = '';
2376 $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
67c8a3e8 2377 $output .= '<div id="' . $id . '_sizer">';
f2eb5002 2378 $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2379 $output .= $caption . ' ';
67c8a3e8 2380 $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
38224dcb 2381 $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
f2eb5002 2382
2383 if ($return) {
2384 return $output;
2385 } else {
2386 echo $output;
2387 }
2388}
2389
512c5901 2390/**
2391 * Close a region started with print_collapsible_region_start.
2392 *
2393 * @param boolean $return if true, return the HTML as a string, rather than printing it.
449611af 2394 * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
512c5901 2395 */
f2eb5002 2396function print_collapsible_region_end($return = false) {
904998d8 2397 $output = '</div></div></div>';
f2eb5002 2398
2399 if ($return) {
2400 return $output;
2401 } else {
2402 echo $output;
2403 }
2404}
2405
d48b00b4 2406/**
2407 * Print a specified group's avatar.
2408 *
a8ff9488 2409 * @param array|stdClass $group A single {@link group} object OR array of groups.
ce3735d4 2410 * @param int $courseid The course ID.
2411 * @param boolean $large Default small picture, or large.
2412 * @param boolean $return If false print picture, otherwise return the output as string
2413 * @param boolean $link Enclose image in a link to view specified course?
449611af 2414 * @return string|void Depending on the setting of $return
d48b00b4 2415 */
da4124be 2416function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
f374fb10 2417 global $CFG;
2418
fdcd0f05 2419 if (is_array($group)) {
2420 $output = '';
2e1d38db 2421 foreach ($group as $g) {
fdcd0f05 2422 $output .= print_group_picture($g, $courseid, $large, true, $link);
2423 }
da4124be 2424 if ($return) {
fdcd0f05 2425 return $output;
2426 } else {
2427 echo $output;
2428 return;
2429 }
2430 }
2431
c550fd0e
AG
2432 $pictureurl = get_group_picture_url($group, $courseid, $large);
2433
2434 // If there is no picture, do nothing.
2435 if (!isset($pictureurl)) {
2436 return;
2437 }
2438
2439 $context = context_course::instance($courseid);
2440
2441 $groupname = s($group->name);
2442 $pictureimage = html_writer::img($pictureurl, $groupname, ['title' => $groupname]);
2443
2444 $output = '';
2445 if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2446 $linkurl = new moodle_url('/user/index.php', ['id' => $courseid, 'group' => $group->id]);
2447 $output .= html_writer::link($linkurl, $pictureimage);
2448 } else {
2449 $output .= $pictureimage;
2450 }
2451
2452 if ($return) {
2453 return $output;
2454 } else {
2455 echo $output;
2456 }
2457}
2458
2459/**
2460 * Return the url to the group picture.
2461 *
2462 * @param stdClass $group A group object.
2463 * @param int $courseid The course ID for the group.
2464 * @param bool $large A large or small group picture? Default is small.
2465 * @return moodle_url Returns the url for the group picture.
2466 */
2467function get_group_picture_url($group, $courseid, $large = false) {
2468 global $CFG;
2469
b0c6dc1c 2470 $context = context_course::instance($courseid);
97ea4833 2471
2e1d38db 2472 // If there is no picture, do nothing.
4a9cf90e 2473 if (!$group->picture) {
c550fd0e 2474 return;
4a9cf90e
SM
2475 }
2476
2e1d38db 2477 // If picture is hidden, only show to those with course:managegroups.
ec7a8b79 2478 if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
c550fd0e 2479 return;
3c0561cf 2480 }
c3cbfe7f 2481
3c0561cf 2482 if ($large) {
b0ccd3fb 2483 $file = 'f1';
3c0561cf 2484 } else {
b0ccd3fb 2485 $file = 'f2';
3c0561cf 2486 }
4a9cf90e 2487
e88dd876 2488 $grouppictureurl = moodle_url::make_pluginfile_url($context->id, 'group', 'icon', $group->id, '/', $file);
21449d01 2489 $grouppictureurl->param('rev', $group->picture);
c550fd0e 2490 return $grouppictureurl;
f374fb10 2491}
2492
9fa49e22 2493
449611af 2494/**
2495 * Display a recent activity note
49c8c8d2 2496 *
449611af 2497 * @staticvar string $strftimerecent
2e1d38db
SH
2498 * @param int $time A timestamp int.
2499 * @param stdClass $user A user object from the database.
449611af 2500 * @param string $text Text for display for the note
2501 * @param string $link The link to wrap around the text
2502 * @param bool $return If set to true the HTML is returned rather than echo'd
2503 * @param string $viewfullnames
2e1d38db 2504 * @return string If $retrun was true returns HTML for a recent activity notice.
449611af 2505 */
dd97c328 2506function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2507 static $strftimerecent = null;
da4124be 2508 $output = '';
2509
dd97c328 2510 if (is_null($viewfullnames)) {
b0c6dc1c 2511 $context = context_system::instance();
dd97c328 2512 $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2513 }
3f8a3834 2514
dd97c328 2515 if (is_null($strftimerecent)) {
8f7dc7f1 2516 $strftimerecent = get_string('strftimerecent');
2517 }
2518
da4124be 2519 $output .= '<div class="head">';
dd97c328 2520 $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2521 $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
da4124be 2522 $output .= '</div>';
2e1d38db 2523 $output .= '<div class="info"><a href="'.$link.'">'.format_string($text, true).'</a></div>';
da4124be 2524
2525 if ($return) {
2526 return $output;
2527 } else {
2528 echo $output;
2529 }
8f7dc7f1 2530}
2531
f3a74e68 2532/**
449611af 2533 * Returns a popup menu with course activity modules
2534 *
2e1d38db
SH
2535 * Given a course this function returns a small popup menu with all the course activity modules in it, as a navigation menu
2536 * outputs a simple list structure in XHTML.
2537 * The data is taken from the serialised array stored in the course record.
449611af 2538 *
449611af 2539 * @param course $course A {@link $COURSE} object.
2e1d38db
SH
2540 * @param array $sections
2541 * @param course_modinfo $modinfo
449611af 2542 * @param string $strsection
2543 * @param string $strjumpto
2544 * @param int $width
2545 * @param string $cmid
2546 * @return string The HTML block
f3a74e68 2547 */
85489a5b 2548function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
f3a74e68 2549
4bc685df 2550 global $CFG, $OUTPUT;
f3a74e68 2551
f3a74e68 2552 $section = -1;
f3a74e68 2553 $menu = array();
dd97c328 2554 $doneheading = false;
f3a74e68 2555
850acb35 2556 $courseformatoptions = course_get_format($course)->get_format_options();
b0c6dc1c 2557 $coursecontext = context_course::instance($course->id);
85489a5b 2558
36c446cb 2559 $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
dd97c328 2560 foreach ($modinfo->cms as $mod) {
0d8b6a69 2561 if (!$mod->has_view()) {
2562 // Don't show modules which you can't link to!
f3a74e68 2563 continue;
2564 }
2565
2e1d38db 2566 // For course formats using 'numsections' do not show extra sections.
850acb35 2567 if (isset($courseformatoptions['numsections']) && $mod->sectionnum > $courseformatoptions['numsections']) {
f3a74e68 2568 break;
2569 }
2570
2e1d38db 2571 if (!$mod->uservisible) { // Do not icnlude empty sections at all.
dd97c328 2572 continue;
2573 }
2574
76cbde41 2575 if ($mod->sectionnum >= 0 and $section != $mod->sectionnum) {
2576 $thissection = $sections[$mod->sectionnum];
f3a74e68 2577
850acb35
MG
2578 if ($thissection->visible or
2579 (isset($courseformatoptions['hiddensections']) and !$courseformatoptions['hiddensections']) or
2580 has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2e1d38db 2581 $thissection->summary = strip_tags(format_string($thissection->summary, true));
dd97c328 2582 if (!$doneheading) {
dfe66174 2583 $menu[] = '</ul></li>';
f3a74e68 2584 }
2585 if ($course->format == 'weeks' or empty($thissection->summary)) {
76cbde41 2586 $item = $strsection ." ". $mod->sectionnum;
f3a74e68 2587 } else {
2f1e464a 2588 if (core_text::strlen($thissection->summary) < ($width-3)) {
b3ab80aa 2589 $item = $thissection->summary;
f3a74e68 2590 } else {
2f1e464a 2591 $item = core_text::substr($thissection->summary, 0, $width).'...';
f3a74e68 2592 }
2593 }
36c446cb 2594 $menu[] = '<li class="section"><span>'.$item.'</span>';
f3a74e68 2595 $menu[] = '<ul>';
2596 $doneheading = true;
dd97c328 2597
76cbde41 2598 $section = $mod->sectionnum;
dd97c328 2599 } else {
2e1d38db 2600 // No activities from this hidden section shown.
dd97c328 2601 continue;
f3a74e68 2602 }
2603 }
2604
dd97c328 2605 $url = $mod->modname .'/view.php?id='. $mod->id;
9a9012dc 2606 $mod->name = strip_tags(format_string($mod->name ,true));
2f1e464a
PS
2607 if (core_text::strlen($mod->name) > ($width+5)) {
2608 $mod->name = core_text::substr($mod->name, 0, $width).'...';
f3a74e68 2609 }
dd97c328 2610 if (!$mod->visible) {
2611 $mod->name = '('.$mod->name.')';
2612 }
2613 $class = 'activity '.$mod->modname;
996c1a6f 2614 $class .= ($cmid == $mod->id) ? ' selected' : '';
dd97c328 2615 $menu[] = '<li class="'.$class.'">'.
3e6adcd6 2616 $OUTPUT->image_icon('icon', '', $mod->modname).
dd97c328 2617 '<a href="'.$CFG->wwwroot.'/mod/'.$url.'">'.$mod->name.'</a></li>';
f3a74e68 2618 }
dd97c328 2619
dfe66174 2620 if ($doneheading) {
f713e270 2621 $menu[] = '</ul></li>';
dfe66174 2622 }
143211e5 2623 $menu[] = '</ul></li></ul>';
f3a74e68 2624
2625 return implode("\n", $menu);
2626}
2627
d48b00b4 2628/**
2e1d38db 2629 * Prints a grade menu (as part of an existing form) with help showing all possible numerical grades and scales.
d48b00b4 2630 *
d48b00b4 2631 * @todo Finish documenting this function
f8065dd2 2632 * @todo Deprecate: this is only used in a few contrib modules
449611af 2633 *
449611af 2634 * @param int $courseid The course ID
49c8c8d2 2635 * @param string $name
2636 * @param string $current
449611af 2637 * @param boolean $includenograde Include those with no grades
2638 * @param boolean $return If set to true returns rather than echo's
2639 * @return string|bool Depending on value of $return
d48b00b4 2640 */
da4124be 2641function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2e1d38db 2642 global $OUTPUT;
62ca135d 2643
da4124be 2644 $output = '';
b0ccd3fb 2645 $strscale = get_string('scale');
2646 $strscales = get_string('scales');
62ca135d 2647
1f7deef6 2648 $scales = get_scales_menu($courseid);
62ca135d 2649 foreach ($scales as $i => $scalename) {
b0ccd3fb 2650 $grades[-$i] = $strscale .': '. $scalename;
62ca135d 2651 }
d6bdd9d5 2652 if ($includenograde) {
b0ccd3fb 2653 $grades[0] = get_string('nograde');
d6bdd9d5 2654 }
62ca135d 2655 for ($i=100; $i>=1; $i--) {
2656 $grades[$i] = $i;
2657 }
d776d59e 2658 $output .= html_writer::select($grades, $name, $current, false);
62ca135d 2659
663640f5 2660 $linkobject = '<span class="helplink">' . $OUTPUT->pix_icon('help', $strscales) . '</span>';
2e1d38db 2661 $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => 1));
48561e1b 2662 $action = new popup_action('click', $link, 'ratingscales', array('height' => 400, 'width' => 500));
2e1d38db 2663 $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title' => $strscales));
da4124be 2664
2665 if ($return) {
2666 return $output;
2667 } else {
2668 echo $output;
2669 }
62ca135d 2670}
2671
7cfb11db 2672/**
2673 * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2e1d38db 2674 *
7cfb11db 2675 * Default errorcode is 1.
2676 *
2677 * Very useful for perl-like error-handling:
7cfb11db 2678 * do_somethting() or mdie("Something went wrong");
2679 *
2680 * @param string $msg Error message
73f7ad71 2681 * @param integer $errorcode Error code to emit
7cfb11db 2682 */
2683function mdie($msg='', $errorcode=1) {
2684 trigger_error($msg);
2685 exit($errorcode);
2686}
2687
d48b00b4 2688/**
2689 * Print a message and exit.
2690 *
449611af 2691 * @param string $message The message to print in the notice
745212bd 2692 * @param moodle_url|string $link The link to use for the continue button
2e1d38db 2693 * @param object $course A course object. Unused.
449611af 2694 * @return void This function simply exits
d48b00b4 2695 */
2e1d38db
SH
2696function notice ($message, $link='', $course=null) {
2697 global $PAGE, $OUTPUT;
9fa49e22 2698
2e1d38db 2699 $message = clean_text($message); // In case nasties are in here.
9f7f1a74 2700
a91b910e 2701 if (CLI_SCRIPT) {
258d5322 2702 echo("!!$message!!\n");
2e1d38db 2703 exit(1); // No success.
d795bfdb 2704 }
2705
c13a5e71 2706 if (!$PAGE->headerprinted) {
2e1d38db 2707 // Header not yet printed.
de6d81e6 2708 $PAGE->set_title(get_string('notice'));
2709 echo $OUTPUT->header();
d795bfdb 2710 } else {
f6794ace 2711 echo $OUTPUT->container_end_all(false);
d795bfdb 2712 }
9fa49e22 2713
ea85e1ee 2714 echo $OUTPUT->box($message, 'generalbox', 'notice');
aa9a6867 2715 echo $OUTPUT->continue_button($link);
5ce73257 2716
7e0d6675 2717 echo $OUTPUT->footer();
2e1d38db 2718 exit(1); // General error code.
9fa49e22 2719}
2720
d48b00b4 2721/**
2e1d38db 2722 * Redirects the user to another page, after printing a notice.
d48b00b4 2723 *
2e1d38db 2724 * This function calls the OUTPUT redirect method, echo's the output and then dies to ensure nothing else happens.
e8775320 2725 *
2726 * <strong>Good practice:</strong> You should call this method before starting page
2727 * output by using any of the OUTPUT methods.
449611af 2728 *
db82872e 2729 * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
e8775320 2730 * @param string $message The message to display to the user
2731 * @param int $delay The delay before redirecting
3ad96419 2732 * @param string $messagetype The type of notification to show the message in. See constants on \core\output\notification.
2e1d38db 2733 * @throws moodle_exception
d48b00b4 2734 */
372d6b92 2735function redirect($url, $message='', $delay=null, $messagetype = \core\output\notification::NOTIFY_INFO) {
2e1d38db 2736 global $OUTPUT, $PAGE, $CFG;
d3f9f1f8 2737
1adaa404 2738 if (CLI_SCRIPT or AJAX_SCRIPT) {
2e1d38db 2739 // This is wrong - developers should not use redirect in these scripts but it should not be very likely.
1adaa404
PS
2740 throw new moodle_exception('redirecterrordetected', 'error');
2741 }
2742
372d6b92
AN
2743 if ($delay === null) {
2744 $delay = -1;
2745 }
2746
2e1d38db 2747 // Prevent debug errors - make sure context is properly initialised.
9b540305
PS
2748 if ($PAGE) {
2749 $PAGE->set_context(null);
2e1d38db 2750 $PAGE->set_pagelayout('redirect'); // No header and footer needed.
e3288953 2751 $PAGE->set_title(get_string('pageshouldredirect', 'moodle'));
9b540305 2752 }
afa7cfa8 2753
366c7499 2754 if ($url instanceof moodle_url) {
b9bc2019 2755 $url = $url->out(false);
366c7499 2756 }
2757
afa7cfa8
PS
2758 $debugdisableredirect = false;
2759 do {
2760 if (defined('DEBUGGING_PRINTED')) {
2e1d38db 2761 // Some debugging already printed, no need to look more.
afa7cfa8
PS
2762 $debugdisableredirect = true;
2763 break;
2764 }
2765
f63dec4b
FM
2766 if (core_useragent::is_msword()) {
2767 // Clicking a URL from MS Word sends a request to the server without cookies. If that
2768 // causes a redirect Word will open a browser pointing the new URL. If not, the URL that
2769 // was clicked is opened. Because the request from Word is without cookies, it almost
2770 // always results in a redirect to the login page, even if the user is logged in in their
2771 // browser. This is not what we want, so prevent the redirect for requests from Word.
2772 $debugdisableredirect = true;
2773 break;
2774 }
2775
afa7cfa8 2776 if (empty($CFG->debugdisplay) or empty($CFG->debug)) {
2e1d38db 2777 // No errors should be displayed.
afa7cfa8
PS
2778 break;
2779 }
2780
2781 if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2782 break;
2783 }
2784
2785 if (!($lasterror['type'] & $CFG->debug)) {
2e1d38db 2786 // Last error not interesting.
afa7cfa8
PS
2787 break;
2788 }
2789
2e1d38db 2790 // Watch out here, @hidden() errors are returned from error_get_last() too.
afa7cfa8 2791 if (headers_sent()) {
2e1d38db 2792 // We already started printing something - that means errors likely printed.
afa7cfa8
PS
2793 $debugdisableredirect = true;
2794 break;
2795 }
2796
2797 if (ob_get_level() and ob_get_contents()) {
2e1d38db
SH
2798 // There is something waiting to be printed, hopefully it is the errors,
2799 // but it might be some error hidden by @ too - such as the timezone mess from setup.php.
afa7cfa8
PS
2800 $debugdisableredirect = true;
2801 break;
2802 }
2803 } while (false);
ae96b517 2804
581e8dba
PS
2805 // Technically, HTTP/1.1 requires Location: header to contain the absolute path.
2806 // (In practice browsers accept relative paths - but still, might as well do it properly.)
2807 // This code turns relative into absolute.
3c3d38d0 2808 if (!preg_match('|^[a-z]+:|i', $url)) {
2e1d38db 2809 // Get host name http://www.wherever.com.
581e8dba
PS
2810 $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2811 if (preg_match('|^/|', $url)) {
2e1d38db 2812 // URLs beginning with / are relative to web server root so we just add them in.
581e8dba
PS
2813 $url = $hostpart.$url;
2814 } else {
2815 // URLs not beginning with / are relative to path of current script, so add that on.
2e1d38db 2816 $url = $hostpart.preg_replace('|\?.*$|', '', me()).'/../'.$url;
581e8dba 2817 }
2e1d38db 2818 // Replace all ..s.
581e8dba
PS
2819 while (true) {
2820 $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2821 if ($newurl == $url) {
2822 break;
2823 }
2824 $url = $newurl;
2825 }
2826 }
2827
2828 // Sanitise url - we can not rely on moodle_url or our URL cleaning
2e1d38db 2829 // because they do not support all valid external URLs.
581e8dba
PS
2830 $url = preg_replace('/[\x00-\x1F\x7F]/', '', $url);
2831 $url = str_replace('"', '%22', $url);
2832 $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2833 $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />', FORMAT_HTML));
2834 $url = str_replace('&amp;', '&', $encodedurl);
2835
ae96b517 2836 if (!empty($message)) {
3ad96419
AN
2837 if (!$debugdisableredirect && !headers_sent()) {
2838 // A message has been provided, and the headers have not yet been sent.
2839 // Display the message as a notification on the subsequent page.
2840 \core\notification::add($message, $messagetype);
2841 $message = null;
2842 $delay = 0;
2843 } else {
2844 if ($delay === -1 || !is_numeric($delay)) {
2845 $delay = 3;
2846 }
2847 $message = clean_text($message);
3446daa3 2848 }
e8775320 2849 } else {
ae96b517 2850 $message = get_string('pageshouldredirect');
e8775320 2851 $delay = 0;
f231e867 2852 }
2deebecd 2853
d79d5ac2
PS
2854 // Make sure the session is closed properly, this prevents problems in IIS
2855 // and also some potential PHP shutdown issues.
2856 \core\session\manager::write_close();
b399e435 2857
d79d5ac2 2858 if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2e1d38db 2859 // 302 might not work for POST requests, 303 is ignored by obsolete clients.
ae96b517 2860 @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2861 @header('Location: '.$url);
5e39d7aa 2862 echo bootstrap_renderer::plain_redirect_message($encodedurl);
2863 exit;
ae96b517 2864 }
b7009474 2865
ae96b517 2866 // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
f0f8f9a7 2867 if ($PAGE) {
2e1d38db 2868 $CFG->docroot = false; // To prevent the link to moodle docs from being displayed on redirect page.
3ad96419 2869 echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect, $messagetype);
f0f8f9a7
PS
2870 exit;
2871 } else {
2872 echo bootstrap_renderer::early_redirect_message($encodedurl, $message, $delay);
2873 exit;
2874 }
9fa49e22 2875}
2876
d48b00b4 2877/**
2e1d38db 2878 * Given an email address, this function will return an obfuscated version of it.
d48b00b4 2879 *
89dcb99d 2880 * @param string $email The email address to obfuscate
449611af 2881 * @return string The obfuscated email address
d48b00b4 2882 */
2e1d38db 2883function obfuscate_email($email) {
43373804 2884 $i = 0;
2885 $length = strlen($email);
b0ccd3fb 2886 $obfuscated = '';
43373804 2887 while ($i < $length) {
2e1d38db 2888 if (rand(0, 2) && $email{$i}!='@') { // MDL-20619 some browsers have problems unobfuscating @.
43373804 2889 $obfuscated.='%'.dechex(ord($email{$i}));
2890 } else {
2891 $obfuscated.=$email{$i};
2892 }
2893 $i++;
2894 }
2895 return $obfuscated;
2896}
2897
d48b00b4 2898/**
2899 * This function takes some text and replaces about half of the characters
2900 * with HTML entity equivalents. Return string is obviously longer.
2901 *
89dcb99d 2902 * @param string $plaintext The text to be obfuscated
449611af 2903 * @return string The obfuscated text
d48b00b4 2904 */
43373804 2905function obfuscate_text($plaintext) {
43373804 2906 $i=0;
2f1e464a 2907 $length = core_text::strlen($plaintext);
b0ccd3fb 2908 $obfuscated='';
2e1d38db 2909 $prevobfuscated = false;
43373804 2910 while ($i < $length) {
2f1e464a
PS
2911 $char = core_text::substr($plaintext, $i, 1);
2912 $ord = core_text::utf8ord($char);
66056f99 2913 $numerical = ($ord >= ord('0')) && ($ord <= ord('9'));
2e1d38db 2914 if ($prevobfuscated and $numerical ) {
66056f99 2915 $obfuscated.='&#'.$ord.';';
2e1d38db 2916 } else if (rand(0, 2)) {
66056f99 2917 $obfuscated.='&#'.$ord.';';
2e1d38db 2918 $prevobfuscated = true;
43373804 2919 } else {
66056f99 2920 $obfuscated.=$char;
2e1d38db 2921 $prevobfuscated = false;
43373804 2922 }
2e1d38db 2923 $i++;
43373804 2924 }
2925 return $obfuscated;
2926}
2927
d48b00b4 2928/**
89dcb99d 2929 * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2930 * to generate a fully obfuscated email link, ready to use.
d48b00b4 2931 *
89dcb99d 2932 * @param string $email The email address to display
fa9f6bf6 2933 * @param string $label The text to displayed as hyperlink to $email
89dcb99d 2934 * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
c216eb20
FM
2935 * @param string $subject The subject of the email in the mailto link
2936 * @param string $body The content of the email in the mailto link
449611af 2937 * @return string The obfuscated mailto link
d48b00b4 2938 */
c216eb20 2939function obfuscate_mailto($email, $label='', $dimmed=false, $subject = '', $body = '') {
43373804 2940
2941 if (empty($label)) {
2942 $label = $email;
2943 }
c216eb20
FM
2944
2945 $label = obfuscate_text($label);
2946 $email = obfuscate_email($email);
2947 $mailto = obfuscate_text('mailto');
2948 $url = new moodle_url("mailto:$email");
2949 $attrs = array();
2950
2951 if (!empty($subject)) {
2952 $url->param('subject', format_string($subject));
2953 }
2954 if (!empty($body)) {
2955 $url->param('body', format_string($body));
2956 }
2957
2e1d38db 2958 // Use the obfuscated mailto.
c216eb20
FM
2959 $url = preg_replace('/^mailto/', $mailto, $url->out());
2960
cadb96f2 2961 if ($dimmed) {
c216eb20
FM
2962 $attrs['title'] = get_string('emaildisable');
2963 $attrs['class'] = 'dimmed';
cadb96f2 2964 }
c216eb20
FM
2965
2966 return html_writer::link($url, $label, $attrs);
43373804 2967}
2968
d48b00b4 2969/**
2970 * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2971 * will transform it to html entities
2972 *
89dcb99d 2973 * @param string $text Text to search for nolink tag in
2974 * @return string
d48b00b4 2975 */
ab892a4f 2976function rebuildnolinktag($text) {
ab9f24ad 2977
2e1d38db 2978 $text = preg_replace('/&lt;(\/*nolink)&gt;/i', '<$1>', $text);
ab892a4f 2979
2980 return $text;
2981}
2982
1695b680 2983/**
2e1d38db 2984 * Prints a maintenance message from $CFG->maintenance_message or default if empty.
1695b680 2985 */
4fe2250a 2986function print_maintenance_message() {
3c159385 2987 global $CFG, $SITE, $PAGE, $OUTPUT;
a2b3f884 2988
f1c6d647
BH
2989 header($_SERVER['SERVER_PROTOCOL'] . ' 503 Moodle under maintenance');
2990 header('Status: 503 Moodle under maintenance');
2991 header('Retry-After: 300');
2992
ad5d5997 2993 $PAGE->set_pagetype('maintenance-message');
78946b9b 2994 $PAGE->set_pagelayout('maintenance');
de6d81e6 2995 $PAGE->set_title(strip_tags($SITE->fullname));
2996 $PAGE->set_heading($SITE->fullname);
2997 echo $OUTPUT->header();
3c159385 2998 echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
4fe2250a 2999 if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
ea85e1ee 3000 echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
4fe2250a 3001 echo $CFG->maintenance_message;
ea85e1ee 3002 echo $OUTPUT->box_end();
4fe2250a 3003 }
7e0d6675 3004 echo $OUTPUT->footer();
4fe2250a 3005 die;
1695b680 3006}
3007
f88ddd67 3008/**
0b4f88a6 3009 * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
f88ddd67 3010 *
c269b9d1
MG
3011 * It is not recommended to use this function in Moodle 2.5 but it is left for backward
3012 * compartibility.
3013 *
3014 * Example how to print a single line tabs:
3015 * $rows = array(
3016 * new tabobject(...),
3017 * new tabobject(...)
3018 * );
3019 * echo $OUTPUT->tabtree($rows, $selectedid);
3020 *
3021 * Multiple row tabs may not look good on some devices but if you want to use them
3022 * you can specify ->subtree for the active tabobject.
3023 *
f88ddd67 3024 * @param array $tabrows An array of rows where each row is an array of tab objects
0b4f88a6 3025 * @param string $selected The id of the selected tab (whatever row it's on)
3026 * @param array $inactive An array of ids of inactive tabs that are not selectable.
3027 * @param array $activated An array of ids of other tabs that are currently activated
449611af 3028 * @param bool $return If true output is returned rather then echo'd
2e1d38db
SH
3029 * @return string HTML output if $return was set to true.
3030 */
c269b9d1
MG
3031function print_tabs($tabrows, $selected = null, $inactive = null, $activated = null, $return = false) {
3032 global $OUTPUT;
6b25a26e 3033
3034 $tabrows = array_reverse($tabrows);
6b25a26e 3035 $subtree = array();
6b25a26e 3036 foreach ($tabrows as $row) {
3037 $tree = array();
3038
3039 foreach ($row as $tab) {
c269b9d1
MG
3040 $tab->inactive = is_array($inactive) && in_array((string)$tab->id, $inactive);
3041 $tab->activated = is_array($activated) && in_array((string)$tab->id, $activated);
f522d310 3042 $tab->selected = (string)$tab->id == $selected;
6b25a26e 3043
c269b9d1
MG
3044 if ($tab->activated || $tab->selected) {
3045 $tab->subtree = $subtree;
6b25a26e 3046 }
3047 $tree[] = $tab;
3048 }
3049 $subtree = $tree;
027b0fe7 3050 }
c269b9d1
MG
3051 $output = $OUTPUT->tabtree($subtree);
3052 if ($return) {
3053 return $output;
3054 } else {
3055 print $output;
3056 return !empty($output);
3057 }
f88ddd67 3058}
3059
96f81ea3
PS
3060/**
3061 * Alter debugging level for the current request,
3062 * the change is not saved in database.
3063 *
3064 * @param int $level one of the DEBUG_* constants
3065 * @param bool $debugdisplay
3066 */
3067function set_debugging($level, $debugdisplay = null) {
3068 global $CFG;
3069
3070 $CFG->debug = (int)$level;
ce7b06bc 3071 $CFG->debugdeveloper = (($CFG->debug & DEBUG_DEVELOPER) === DEBUG_DEVELOPER);
96f81ea3
PS
3072
3073 if ($debugdisplay !== null) {
3074 $CFG->debugdisplay = (bool)$debugdisplay;
3075 }
3076}
3077
fa989c38 3078/**
449611af 3079 * Standard Debugging Function
3080 *
7eb0b60a 3081 * Returns true if the current site debugging settings are equal or above specified level.
4bd0ddea 3082 * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
3083 * routing of notices is controlled by $CFG->debugdisplay
fa989c38 3084 * eg use like this:
3085 *
7eb0b60a 3086 * 1) debugging('a normal debug notice');
3087 * 2) debugging('something really picky', DEBUG_ALL);
fa9f6bf6 3088 * 3) debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
4bd0ddea 3089 * 4) if (debugging()) { perform extra debugging operations (do not use print or echo) }
3090 *
3091 * In code blocks controlled by debugging() (such as example 4)
3092 * any output should be routed via debugging() itself, or the lower-level
3093 * trigger_error() or error_log(). Using echo or print will break XHTML
3094 * JS and HTTP headers.
3095 *
2e9b772f 3096 * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
fa989c38 3097 *
2fca6e0b 3098 * @param string $message a message to print
fa989c38 3099 * @param int $level the level at which this debugging statement should show
eee5d9bb 3100 * @param array $backtrace use different backtrace
fa989c38 3101 * @return bool
3102 */
34a2777c 3103function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
c8b3346c 3104 global $CFG, $USER;
fa989c38 3105
0ed26d12 3106 $forcedebug = false;
5dad4591 3107 if (!empty($CFG->debugusers) && $USER) {
0ed26d12
PS
3108 $debugusers = explode(',', $CFG->debugusers);
3109 $forcedebug = in_array($USER->id, $debugusers);
3110 }
3111
a3d5830a 3112 if (!$forcedebug and (empty($CFG->debug) || ($CFG->debug != -1 and $CFG->debug < $level))) {
fa989c38 3113 return false;
3114 }
3115