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