3 // This file is part of Moodle - http://moodle.org/
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
19 * Library of functions for web output
21 * Library of all general-purpose Moodle PHP functions and constants
22 * that produce HTML output
24 * Other main libraries:
25 * - datalib.php - functions that access the database.
26 * - moodlelib.php - general-purpose Moodle functions.
30 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
31 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34 defined('MOODLE_INTERNAL') ||
die();
38 /// Define text formatting types ... eventually we can add Wiki, BBcode etc
41 * Does all sorts of transformations and filtering
43 define('FORMAT_MOODLE', '0'); // Does all sorts of transformations and filtering
46 * Plain HTML (with some tags stripped)
48 define('FORMAT_HTML', '1'); // Plain HTML (with some tags stripped)
51 * Plain text (even tags are printed in full)
53 define('FORMAT_PLAIN', '2'); // Plain text (even tags are printed in full)
57 * Deprecated: left here just to note that '3' is not used (at the moment)
58 * and to catch any latent wiki-like text (which generates an error)
60 define('FORMAT_WIKI', '3'); // Wiki-formatted text
63 * Markdown-formatted text http://daringfireball.net/projects/markdown/
65 define('FORMAT_MARKDOWN', '4'); // Markdown-formatted text http://daringfireball.net/projects/markdown/
68 * A moodle_url comparison using this flag will return true if the base URLs match, params are ignored
70 define('URL_MATCH_BASE', 0);
72 * A moodle_url comparison using this flag will return true if the base URLs match and the params of url1 are part of url2
74 define('URL_MATCH_PARAMS', 1);
76 * A moodle_url comparison using this flag will return true if the two URLs are identical, except for the order of the params
78 define('URL_MATCH_EXACT', 2);
81 * Allowed tags - string of html tags that can be tested against for safe html tags
82 * @global string $ALLOWED_TAGS
87 '<p><br><b><i><u><font><table><tbody><thead><tfoot><span><div><tr><td><th><ol><ul><dl><li><dt><dd><h1><h2><h3><h4><h5><h6><hr><img><a><strong><emphasis><em><sup><sub><address><cite><blockquote><pre><strike><param><acronym><nolink><lang><tex><algebra><math><mi><mn><mo><mtext><mspace><ms><mrow><mfrac><msqrt><mroot><mstyle><merror><mpadded><mphantom><mfenced><msub><msup><msubsup><munder><mover><munderover><mmultiscripts><mtable><mtr><mtd><maligngroup><malignmark><maction><cn><ci><apply><reln><fn><interval><inverse><sep><condition><declare><lambda><compose><ident><quotient><exp><factorial><divide><max><min><minus><plus><power><rem><times><root><gcd><and><or><xor><not><implies><forall><exists><abs><conjugate><eq><neq><gt><lt><geq><leq><ln><log><int><diff><partialdiff><lowlimit><uplimit><bvar><degree><set><list><union><intersect><in><notin><subset><prsubset><notsubset><notprsubset><setdiff><sum><product><limit><tendsto><mean><sdev><variance><median><mode><moment><vector><matrix><matrixrow><determinant><transpose><selector><annotation><semantics><annotation-xml><tt><code>';
90 * Allowed protocols - array of protocols that are safe to use in links and so on
91 * @global string $ALLOWED_PROTOCOLS
93 $ALLOWED_PROTOCOLS = array('http', 'https', 'ftp', 'news', 'mailto', 'rtsp', 'teamspeak', 'gopher', 'mms',
94 'color', 'callto', 'cursor', 'text-align', 'font-size', 'font-weight', 'font-style', 'font-family',
95 'border', 'border-bottom', 'border-left', 'border-top', 'border-right', 'margin', 'margin-bottom', 'margin-left', 'margin-top', 'margin-right',
96 'padding', 'padding-bottom', 'padding-left', 'padding-top', 'padding-right', 'vertical-align',
97 'background', 'background-color', 'text-decoration'); // CSS as well to get through kses
103 * Add quotes to HTML characters
105 * Returns $var with HTML characters (like "<", ">", etc.) properly quoted.
106 * This function is very similar to {@link p()}
108 * @todo Remove obsolete param $obsolete if not used anywhere
110 * @param string $var the string potentially containing HTML characters
111 * @param boolean $obsolete no longer used.
114 function s($var, $obsolete = false) {
116 if ($var === '0' or $var === false or $var === 0) {
120 return preg_replace("/&#(\d+|x[0-7a-fA-F]+);/i", "&#$1;", htmlspecialchars($var, ENT_QUOTES
, 'UTF-8', true));
124 * Add quotes to HTML characters
126 * Prints $var with HTML characters (like "<", ">", etc.) properly quoted.
127 * This function simply calls {@link s()}
130 * @todo Remove obsolete param $obsolete if not used anywhere
132 * @param string $var the string potentially containing HTML characters
133 * @param boolean $obsolete no longer used.
136 function p($var, $obsolete = false) {
137 echo s($var, $obsolete);
141 * Does proper javascript quoting.
143 * Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
145 * @param mixed $var String, Array, or Object to add slashes to
146 * @return mixed quoted result
148 function addslashes_js($var) {
149 if (is_string($var)) {
150 $var = str_replace('\\', '\\\\', $var);
151 $var = str_replace(array('\'', '"', "\n", "\r", "\0"), array('\\\'', '\\"', '\\n', '\\r', '\\0'), $var);
152 $var = str_replace('</', '<\/', $var); // XHTML compliance
153 } else if (is_array($var)) {
154 $var = array_map('addslashes_js', $var);
155 } else if (is_object($var)) {
156 $a = get_object_vars($var);
157 foreach ($a as $key=>$value) {
158 $a[$key] = addslashes_js($value);
166 * Remove query string from url
168 * Takes in a URL and returns it without the querystring portion
170 * @param string $url the url which may have a query string attached
171 * @return string The remaining URL
173 function strip_querystring($url) {
175 if ($commapos = strpos($url, '?')) {
176 return substr($url, 0, $commapos);
183 * Returns the URL of the HTTP_REFERER, less the querystring portion if required
186 * @param boolean $stripquery if true, also removes the query part of the url.
187 * @return string The resulting referer or empty string
189 function get_referer($stripquery=true) {
190 if (isset($_SERVER['HTTP_REFERER'])) {
192 return strip_querystring($_SERVER['HTTP_REFERER']);
194 return $_SERVER['HTTP_REFERER'];
203 * Returns the name of the current script, WITH the querystring portion.
205 * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
206 * return different things depending on a lot of things like your OS, Web
207 * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
208 * <b>NOTE:</b> This function returns false if the global variables needed are not set.
211 * @return mixed String, or false if the global variables needed are not set
219 * Returns the name of the current script, WITH the full URL.
221 * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
222 * return different things depending on a lot of things like your OS, Web
223 * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.
224 * <b>NOTE:</b> This function returns false if the global variables needed are not set.
226 * Like {@link me()} but returns a full URL
230 * @return mixed String, or false if the global variables needed are not set
232 function qualified_me() {
238 * Class for creating and manipulating urls.
240 * It can be used in moodle pages where config.php has been included without any further includes.
242 * It is useful for manipulating urls with long lists of params.
243 * One situation where it will be useful is a page which links to itself to perform various actions
244 * and / or to process form data. A moodle_url object :
245 * can be created for a page to refer to itself with all the proper get params being passed from page call to
246 * page call and methods can be used to output a url including all the params, optionally adding and overriding
247 * params and can also be used to
248 * - output the url without any get params
249 * - and output the params as hidden fields to be output within a form
251 * @link http://docs.moodle.org/dev/lib/weblib.php_moodle_url See short write up here
252 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
253 * @package moodlecore
257 * Scheme, ex.: http, https
260 protected $scheme = '';
265 protected $host = '';
267 * Port number, empty means default 80 or 443 in case of http
270 protected $port = '';
272 * Username for http auth
275 protected $user = '';
277 * Password for http auth
280 protected $pass = '';
285 protected $path = '';
287 * Optional slash argument value
290 protected $slashargument = '';
292 * Anchor, may be also empty, null means none
295 protected $anchor = null;
297 * Url parameters as associative array
300 protected $params = array(); // Associative array of query string params
303 * Create new instance of moodle_url.
305 * @param moodle_url|string $url - moodle_url means make a copy of another
306 * moodle_url and change parameters, string means full url or shortened
307 * form (ex.: '/course/view.php'). It is strongly encouraged to not include
308 * query string because it may result in double encoded values. Use the
309 * $params instead. For admin URLs, just use /admin/script.php, this
310 * class takes care of the $CFG->admin issue.
311 * @param array $params these params override current params or add new
313 public function __construct($url, array $params = null) {
316 if ($url instanceof moodle_url
) {
317 $this->scheme
= $url->scheme
;
318 $this->host
= $url->host
;
319 $this->port
= $url->port
;
320 $this->user
= $url->user
;
321 $this->pass
= $url->pass
;
322 $this->path
= $url->path
;
323 $this->slashargument
= $url->slashargument
;
324 $this->params
= $url->params
;
325 $this->anchor
= $url->anchor
;
328 // detect if anchor used
329 $apos = strpos($url, '#');
330 if ($apos !== false) {
331 $anchor = substr($url, $apos);
332 $anchor = ltrim($anchor, '#');
333 $this->set_anchor($anchor);
334 $url = substr($url, 0, $apos);
337 // normalise shortened form of our url ex.: '/course/view.php'
338 if (strpos($url, '/') === 0) {
339 // we must not use httpswwwroot here, because it might be url of other page,
340 // devs have to use httpswwwroot explicitly when creating new moodle_url
341 $url = $CFG->wwwroot
.$url;
344 // now fix the admin links if needed, no need to mess with httpswwwroot
345 if ($CFG->admin
!== 'admin') {
346 if (strpos($url, "$CFG->wwwroot/admin/") === 0) {
347 $url = str_replace("$CFG->wwwroot/admin/", "$CFG->wwwroot/$CFG->admin/", $url);
352 $parts = parse_url($url);
353 if ($parts === false) {
354 throw new moodle_exception('invalidurl');
356 if (isset($parts['query'])) {
357 // note: the values may not be correctly decoded,
358 // url parameters should be always passed as array
359 parse_str(str_replace('&', '&', $parts['query']), $this->params
);
361 unset($parts['query']);
362 foreach ($parts as $key => $value) {
363 $this->$key = $value;
366 // detect slashargument value from path - we do not support directory names ending with .php
367 $pos = strpos($this->path
, '.php/');
368 if ($pos !== false) {
369 $this->slashargument
= substr($this->path
, $pos +
4);
370 $this->path
= substr($this->path
, 0, $pos +
4);
374 $this->params($params);
378 * Add an array of params to the params for this url.
380 * The added params override existing ones if they have the same name.
382 * @param array $params Defaults to null. If null then returns all params.
383 * @return array Array of Params for url.
385 public function params(array $params = null) {
386 $params = (array)$params;
388 foreach ($params as $key=>$value) {
390 throw new coding_exception('Url parameters can not have numeric keys!');
392 if (!is_string($value)) {
393 if (is_array($value)) {
394 throw new coding_exception('Url parameters values can not be arrays!');
396 if (is_object($value) and !method_exists($value, '__toString')) {
397 throw new coding_exception('Url parameters values can not be objects, unless __toString() is defined!');
400 $this->params
[$key] = (string)$value;
402 return $this->params
;
406 * Remove all params if no arguments passed.
407 * Remove selected params if arguments are passed.
409 * Can be called as either remove_params('param1', 'param2')
410 * or remove_params(array('param1', 'param2')).
412 * @param mixed $params either an array of param names, or a string param name,
413 * @param string $params,... any number of additional param names.
414 * @return array url parameters
416 public function remove_params($params = null) {
417 if (!is_array($params)) {
418 $params = func_get_args();
420 foreach ($params as $param) {
421 unset($this->params
[$param]);
423 return $this->params
;
427 * Remove all url parameters
431 public function remove_all_params($params = null) {
432 $this->params
= array();
433 $this->slashargument
= '';
437 * Add a param to the params for this url.
439 * The added param overrides existing one if they have the same name.
441 * @param string $paramname name
442 * @param string $newvalue Param value. If new value specified current value is overriden or parameter is added
443 * @return mixed string parameter value, null if parameter does not exist
445 public function param($paramname, $newvalue = '') {
446 if (func_num_args() > 1) {
448 $this->params(array($paramname=>$newvalue));
450 if (isset($this->params
[$paramname])) {
451 return $this->params
[$paramname];
458 * Merges parameters and validates them
459 * @param array $overrideparams
460 * @return array merged parameters
462 protected function merge_overrideparams(array $overrideparams = null) {
463 $overrideparams = (array)$overrideparams;
464 $params = $this->params
;
465 foreach ($overrideparams as $key=>$value) {
467 throw new coding_exception('Overridden parameters can not have numeric keys!');
469 if (is_array($value)) {
470 throw new coding_exception('Overridden parameters values can not be arrays!');
472 if (is_object($value) and !method_exists($value, '__toString')) {
473 throw new coding_exception('Overridden parameters values can not be objects, unless __toString() is defined!');
475 $params[$key] = (string)$value;
481 * Get the params as as a query string.
482 * This method should not be used outside of this method.
484 * @param boolean $escaped Use & as params separator instead of plain &
485 * @param array $overrideparams params to add to the output params, these
486 * override existing ones with the same name.
487 * @return string query string that can be added to a url.
489 public function get_query_string($escaped = true, array $overrideparams = null) {
491 if ($overrideparams !== null) {
492 $params = $this->merge_overrideparams($overrideparams);
494 $params = $this->params
;
496 foreach ($params as $key => $val) {
497 $arr[] = rawurlencode($key)."=".rawurlencode($val);
500 return implode('&', $arr);
502 return implode('&', $arr);
507 * Shortcut for printing of encoded URL.
510 public function __toString() {
511 return $this->out(true);
517 * If you use the returned URL in HTML code, you want the escaped ampersands. If you use
518 * the returned URL in HTTP headers, you want $escaped=false.
520 * @param boolean $escaped Use & as params separator instead of plain &
521 * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
522 * @return string Resulting URL
524 public function out($escaped = true, array $overrideparams = null) {
525 if (!is_bool($escaped)) {
526 debugging('Escape parameter must be of type boolean, '.gettype($escaped).' given instead.');
529 $uri = $this->out_omit_querystring().$this->slashargument
;
531 $querystring = $this->get_query_string($escaped, $overrideparams);
532 if ($querystring !== '') {
533 $uri .= '?' . $querystring;
535 if (!is_null($this->anchor
)) {
536 $uri .= '#'.$this->anchor
;
543 * Returns url without parameters, everything before '?'.
545 * @param bool $includeanchor if {@link self::anchor} is defined, should it be returned?
548 public function out_omit_querystring($includeanchor = false) {
550 $uri = $this->scheme ?
$this->scheme
.':'.((strtolower($this->scheme
) == 'mailto') ?
'':'//'): '';
551 $uri .= $this->user ?
$this->user
.($this->pass?
':'.$this->pass
:'').'@':'';
552 $uri .= $this->host ?
$this->host
: '';
553 $uri .= $this->port ?
':'.$this->port
: '';
554 $uri .= $this->path ?
$this->path
: '';
555 if ($includeanchor and !is_null($this->anchor
)) {
556 $uri .= '#' . $this->anchor
;
563 * Compares this moodle_url with another
564 * See documentation of constants for an explanation of the comparison flags.
565 * @param moodle_url $url The moodle_url object to compare
566 * @param int $matchtype The type of comparison (URL_MATCH_BASE, URL_MATCH_PARAMS, URL_MATCH_EXACT)
569 public function compare(moodle_url
$url, $matchtype = URL_MATCH_EXACT
) {
571 $baseself = $this->out_omit_querystring();
572 $baseother = $url->out_omit_querystring();
574 // Append index.php if there is no specific file
575 if (substr($baseself,-1)=='/') {
576 $baseself .= 'index.php';
578 if (substr($baseother,-1)=='/') {
579 $baseother .= 'index.php';
582 // Compare the two base URLs
583 if ($baseself != $baseother) {
587 if ($matchtype == URL_MATCH_BASE
) {
591 $urlparams = $url->params();
592 foreach ($this->params() as $param => $value) {
593 if ($param == 'sesskey') {
596 if (!array_key_exists($param, $urlparams) ||
$urlparams[$param] != $value) {
601 if ($matchtype == URL_MATCH_PARAMS
) {
605 foreach ($urlparams as $param => $value) {
606 if ($param == 'sesskey') {
609 if (!array_key_exists($param, $this->params()) ||
$this->param($param) != $value) {
618 * Sets the anchor for the URI (the bit after the hash)
619 * @param string $anchor null means remove previous
621 public function set_anchor($anchor) {
622 if (is_null($anchor)) {
624 $this->anchor
= null;
625 } else if ($anchor === '') {
626 // special case, used as empty link
628 } else if (preg_match('|[a-zA-Z\_\:][a-zA-Z0-9\_\-\.\:]*|', $anchor)) {
629 // Match the anchor against the NMTOKEN spec
630 $this->anchor
= $anchor;
632 // bad luck, no valid anchor found
633 $this->anchor
= null;
638 * Sets the url slashargument value
639 * @param string $path usually file path
640 * @param string $parameter name of page parameter if slasharguments not supported
641 * @param bool $supported usually null, then it depends on $CFG->slasharguments, use true or false for other servers
644 public function set_slashargument($path, $parameter = 'file', $supported = NULL) {
646 if (is_null($supported)) {
647 $supported = $CFG->slasharguments
;
651 $parts = explode('/', $path);
652 $parts = array_map('rawurlencode', $parts);
653 $path = implode('/', $parts);
654 $this->slashargument
= $path;
655 unset($this->params
[$parameter]);
658 $this->slashargument
= '';
659 $this->params
[$parameter] = $path;
663 // == static factory methods ==
666 * General moodle file url.
667 * @param string $urlbase the script serving the file
668 * @param string $path
669 * @param bool $forcedownload
672 public static function make_file_url($urlbase, $path, $forcedownload = false) {
676 if ($forcedownload) {
677 $params['forcedownload'] = 1;
680 $url = new moodle_url($urlbase, $params);
681 $url->set_slashargument($path);
687 * Factory method for creation of url pointing to plugin file.
688 * Please note this method can be used only from the plugins to
689 * create urls of own files, it must not be used outside of plugins!
690 * @param int $contextid
691 * @param string $component
692 * @param string $area
694 * @param string $pathname
695 * @param string $filename
696 * @param bool $forcedownload
699 public static function make_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename, $forcedownload = false) {
701 $urlbase = "$CFG->httpswwwroot/pluginfile.php";
702 if ($itemid === NULL) {
703 return self
::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
705 return self
::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
710 * Factory method for creation of url pointing to draft
711 * file of current user.
712 * @param int $draftid draft item id
713 * @param string $pathname
714 * @param string $filename
715 * @param bool $forcedownload
718 public static function make_draftfile_url($draftid, $pathname, $filename, $forcedownload = false) {
720 $urlbase = "$CFG->httpswwwroot/draftfile.php";
721 $context = get_context_instance(CONTEXT_USER
, $USER->id
);
723 return self
::make_file_url($urlbase, "/$context->id/user/draft/$draftid".$pathname.$filename, $forcedownload);
727 * Factory method for creating of links to legacy
729 * @param int $courseid
730 * @param string $filepath
731 * @param bool $forcedownload
734 public static function make_legacyfile_url($courseid, $filepath, $forcedownload = false) {
737 $urlbase = "$CFG->wwwroot/file.php";
738 return self
::make_file_url($urlbase, '/'.$courseid.'/'.$filepath, $forcedownload);
743 * Determine if there is data waiting to be processed from a form
745 * Used on most forms in Moodle to check for data
746 * Returns the data as an object, if it's found.
747 * This object can be used in foreach loops without
748 * casting because it's cast to (array) automatically
750 * Checks that submitted POST data exists and returns it as object.
753 * @return mixed false or object
755 function data_submitted() {
760 return (object)$_POST;
765 * Given some normal text this function will break up any
766 * long words to a given size by inserting the given character
768 * It's multibyte savvy and doesn't change anything inside html tags.
770 * @param string $string the string to be modified
771 * @param int $maxsize maximum length of the string to be returned
772 * @param string $cutchar the string used to represent word breaks
775 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
777 /// Loading the textlib singleton instance. We are going to need it.
778 $textlib = textlib_get_instance();
780 /// First of all, save all the tags inside the text to skip them
782 filter_save_tags($string,$tags);
784 /// Process the string adding the cut when necessary
786 $length = $textlib->strlen($string);
789 for ($i=0; $i<$length; $i++
) {
790 $char = $textlib->substr($string, $i, 1);
791 if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
795 if ($wordlength > $maxsize) {
803 /// Finally load the tags back again
805 $output = str_replace(array_keys($tags), $tags, $output);
812 * Try and close the current window using JavaScript, either immediately, or after a delay.
814 * Echo's out the resulting XHTML & javascript
818 * @param integer $delay a delay in seconds before closing the window. Default 0.
819 * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
820 * to reload the parent window before this one closes.
822 function close_window($delay = 0, $reloadopener = false) {
823 global $PAGE, $OUTPUT;
825 if (!$PAGE->headerprinted
) {
826 $PAGE->set_title(get_string('closewindow'));
827 echo $OUTPUT->header();
829 $OUTPUT->container_end_all(false);
833 // Trigger the reload immediately, even if the reload is after a delay.
834 $PAGE->requires
->js_function_call('window.opener.location.reload', array(true));
836 $OUTPUT->notification(get_string('windowclosing'), 'notifysuccess');
838 $PAGE->requires
->js_function_call('close_window', array(new stdClass()), false, $delay);
840 echo $OUTPUT->footer();
845 * Returns a string containing a link to the user documentation for the current
846 * page. Also contains an icon by default. Shown to teachers and admin only.
850 * @param string $text The text to be displayed for the link
851 * @param string $iconpath The path to the icon to be displayed
852 * @return string The link to user documentation for this current page
854 function page_doc_link($text='') {
855 global $CFG, $PAGE, $OUTPUT;
857 if (empty($CFG->docroot
) ||
during_initial_install()) {
860 if (!has_capability('moodle/site:doclinks', $PAGE->context
)) {
864 $path = $PAGE->docspath
;
868 return $OUTPUT->doc_link($path, $text);
873 * Validates an email to make sure it makes sense.
875 * @param string $address The email address to validate.
878 function validate_email($address) {
880 return (preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
881 '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
883 '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
884 '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
889 * Extracts file argument either from file parameter or PATH_INFO
890 * Note: $scriptname parameter is not needed anymore
895 * @return string file path (only safe characters)
897 function get_file_argument() {
900 $relativepath = optional_param('file', FALSE, PARAM_PATH
);
902 if ($relativepath !== false and $relativepath !== '') {
903 return $relativepath;
905 $relativepath = false;
907 // then try extract file from the slasharguments
908 if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
909 // NOTE: ISS tends to convert all file paths to single byte DOS encoding,
910 // we can not use other methods because they break unicode chars,
911 // the only way is to use URL rewriting
912 if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
913 // check that PATH_INFO works == must not contain the script name
914 if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
915 $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH
);
919 // all other apache-like servers depend on PATH_INFO
920 if (isset($_SERVER['PATH_INFO'])) {
921 if (isset($_SERVER['SCRIPT_NAME']) and strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === 0) {
922 $relativepath = substr($_SERVER['PATH_INFO'], strlen($_SERVER['SCRIPT_NAME']));
924 $relativepath = $_SERVER['PATH_INFO'];
926 $relativepath = clean_param($relativepath, PARAM_PATH
);
931 return $relativepath;
935 * Just returns an array of text formats suitable for a popup menu
937 * @uses FORMAT_MOODLE
940 * @uses FORMAT_MARKDOWN
943 function format_text_menu() {
944 return array (FORMAT_MOODLE
=> get_string('formattext'),
945 FORMAT_HTML
=> get_string('formathtml'),
946 FORMAT_PLAIN
=> get_string('formatplain'),
947 FORMAT_MARKDOWN
=> get_string('formatmarkdown'));
951 * Given text in a variety of format codings, this function returns
952 * the text as safe HTML.
954 * This function should mainly be used for long strings like posts,
955 * answers, glossary items etc. For short strings @see format_string().
959 * trusted : If true the string won't be cleaned. Default false required noclean=true.
960 * noclean : If true the string won't be cleaned. Default false required trusted=true.
961 * nocache : If true the strign will not be cached and will be formatted every call. Default false.
962 * filter : If true the string will be run through applicable filters as well. Default true.
963 * para : If true then the returned string will be wrapped in div tags. Default true.
964 * newlines : If true then lines newline breaks will be converted to HTML newline breaks. Default true.
965 * context : The context that will be used for filtering.
966 * overflowdiv : If set to true the formatted text will be encased in a div
967 * with the class no-overflow before being returned. Default false.
968 * allowid : If true then id attributes will not be removed, even when
969 * using htmlpurifier. Default false.
972 * @todo Finish documenting this function
974 * @staticvar array $croncache
975 * @param string $text The text to be formatted. This is raw text originally from user input.
976 * @param int $format Identifier of the text format to be used
977 * [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
978 * @param object/array $options text formatting options
979 * @param int $courseid_do_not_use deprecated course id, use context option instead
982 function format_text($text, $format = FORMAT_MOODLE
, $options = NULL, $courseid_do_not_use = NULL) {
983 global $CFG, $COURSE, $DB, $PAGE;
984 static $croncache = array();
986 if ($text === '' ||
is_null($text)) {
987 return ''; // no need to do any filters and cleaning
990 $options = (array)$options; // detach object, we can not modify it
992 if (!isset($options['trusted'])) {
993 $options['trusted'] = false;
995 if (!isset($options['noclean'])) {
996 if ($options['trusted'] and trusttext_active()) {
997 // no cleaning if text trusted and noclean not specified
998 $options['noclean'] = true;
1000 $options['noclean'] = false;
1003 if (!isset($options['nocache'])) {
1004 $options['nocache'] = false;
1006 if (!isset($options['filter'])) {
1007 $options['filter'] = true;
1009 if (!isset($options['para'])) {
1010 $options['para'] = true;
1012 if (!isset($options['newlines'])) {
1013 $options['newlines'] = true;
1015 if (!isset($options['overflowdiv'])) {
1016 $options['overflowdiv'] = false;
1019 // Calculate best context
1020 if (empty($CFG->version
) or $CFG->version
< 2010072800 or during_initial_install()) {
1021 // do not filter anything during installation or before upgrade completes
1024 } else if (isset($options['context'])) { // first by explicit passed context option
1025 if (is_object($options['context'])) {
1026 $context = $options['context'];
1028 $context = get_context_instance_by_id($options['context']);
1030 } else if ($courseid_do_not_use) {
1032 $context = get_context_instance(CONTEXT_COURSE
, $courseid_do_not_use);
1034 // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1035 $context = $PAGE->context
;
1039 // either install/upgrade or something has gone really wrong because context does not exist (yet?)
1040 $options['nocache'] = true;
1041 $options['filter'] = false;
1044 if ($options['filter']) {
1045 $filtermanager = filter_manager
::instance();
1047 $filtermanager = new null_filter_manager();
1050 if (!empty($CFG->cachetext
) and empty($options['nocache'])) {
1051 $hashstr = $text.'-'.$filtermanager->text_filtering_hash($context).'-'.$context->id
.'-'.current_language().'-'.
1052 (int)$format.(int)$options['trusted'].(int)$options['noclean'].
1053 (int)$options['para'].(int)$options['newlines'];
1055 $time = time() - $CFG->cachetext
;
1056 $md5key = md5($hashstr);
1058 if (isset($croncache[$md5key])) {
1059 return $croncache[$md5key];
1063 if ($oldcacheitem = $DB->get_record('cache_text', array('md5key'=>$md5key), '*', IGNORE_MULTIPLE
)) {
1064 if ($oldcacheitem->timemodified
>= $time) {
1066 if (count($croncache) > 150) {
1068 $key = key($croncache);
1069 unset($croncache[$key]);
1071 $croncache[$md5key] = $oldcacheitem->formattedtext
;
1073 return $oldcacheitem->formattedtext
;
1080 if (!$options['noclean']) {
1081 $text = clean_text($text, FORMAT_HTML
, $options);
1083 $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_HTML
, 'noclean' => $options['noclean']));
1087 $text = s($text); // cleans dangerous JS
1088 $text = rebuildnolinktag($text);
1089 $text = str_replace(' ', ' ', $text);
1090 $text = nl2br($text);
1094 // this format is deprecated
1095 $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle. You should not be seeing
1096 this message as all texts should have been converted to Markdown format instead.
1097 Please post a bug report to http://moodle.org/bugs with information about where you
1098 saw this message.</p>'.s($text);
1101 case FORMAT_MARKDOWN
:
1102 $text = markdown_to_html($text);
1103 if (!$options['noclean']) {
1104 $text = clean_text($text, FORMAT_HTML
, $options);
1106 $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_MARKDOWN
, 'noclean' => $options['noclean']));
1109 default: // FORMAT_MOODLE or anything else
1110 $text = text_to_html($text, null, $options['para'], $options['newlines']);
1111 if (!$options['noclean']) {
1112 $text = clean_text($text, FORMAT_HTML
, $options);
1114 $text = $filtermanager->filter_text($text, $context, array('originalformat' => $format, 'noclean' => $options['noclean']));
1117 if ($options['filter']) {
1118 // at this point there should not be any draftfile links any more,
1119 // this happens when developers forget to post process the text.
1120 // The only potential problem is that somebody might try to format
1121 // the text before storing into database which would be itself big bug.
1122 $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
1125 // Warn people that we have removed this old mechanism, just in case they
1126 // were stupid enough to rely on it.
1127 if (isset($CFG->currenttextiscacheable
)) {
1128 debugging('Once upon a time, Moodle had a truly evil use of global variables ' .
1129 'called $CFG->currenttextiscacheable. The good news is that this no ' .
1130 'longer exists. The bad news is that you seem to be using a filter that '.
1131 'relies on it. Please seek out and destroy that filter code.', DEBUG_DEVELOPER
);
1134 if (!empty($options['overflowdiv'])) {
1135 $text = html_writer
::tag('div', $text, array('class'=>'no-overflow'));
1138 if (empty($options['nocache']) and !empty($CFG->cachetext
)) {
1140 // special static cron cache - no need to store it in db if its not already there
1141 if (count($croncache) > 150) {
1143 $key = key($croncache);
1144 unset($croncache[$key]);
1146 $croncache[$md5key] = $text;
1150 $newcacheitem = new stdClass();
1151 $newcacheitem->md5key
= $md5key;
1152 $newcacheitem->formattedtext
= $text;
1153 $newcacheitem->timemodified
= time();
1154 if ($oldcacheitem) { // See bug 4677 for discussion
1155 $newcacheitem->id
= $oldcacheitem->id
;
1157 $DB->update_record('cache_text', $newcacheitem); // Update existing record in the cache table
1158 } catch (dml_exception
$e) {
1159 // It's unlikely that the cron cache cleaner could have
1160 // deleted this entry in the meantime, as it allows
1161 // some extra time to cover these cases.
1165 $DB->insert_record('cache_text', $newcacheitem); // Insert a new record in the cache table
1166 } catch (dml_exception
$e) {
1167 // Again, it's possible that another user has caused this
1168 // record to be created already in the time that it took
1169 // to traverse this function. That's OK too, as the
1170 // call above handles duplicate entries, and eventually
1171 // the cron cleaner will delete them.
1180 * Resets all data related to filters, called during upgrade or when filter settings change.
1186 function reset_text_filters_cache() {
1189 $DB->delete_records('cache_text');
1190 $purifdir = $CFG->dataroot
.'/cache/htmlpurifier';
1191 remove_dir($purifdir, true);
1195 * Given a simple string, this function returns the string
1196 * processed by enabled string filters if $CFG->filterall is enabled
1198 * This function should be used to print short strings (non html) that
1199 * need filter processing e.g. activity titles, post subjects,
1200 * glossary concepts.
1205 * @staticvar bool $strcache
1206 * @param string $string The string to be filtered.
1207 * @param boolean $striplinks To strip any link in the result text.
1208 Moodle 1.8 default changed from false to true! MDL-8713
1209 * @param array $options options array/object or courseid
1212 function format_string($string, $striplinks = true, $options = NULL) {
1213 global $CFG, $COURSE, $PAGE;
1215 //We'll use a in-memory cache here to speed up repeated strings
1216 static $strcache = false;
1218 if (empty($CFG->version
) or $CFG->version
< 2010072800 or during_initial_install()) {
1219 // do not filter anything during installation or before upgrade completes
1220 return $string = strip_tags($string);
1223 if ($strcache === false or count($strcache) > 2000) { // this number might need some tuning to limit memory usage in cron
1224 $strcache = array();
1227 if (is_numeric($options)) {
1228 // legacy courseid usage
1229 $options = array('context'=>get_context_instance(CONTEXT_COURSE
, $options));
1231 $options = (array)$options; // detach object, we can not modify it
1234 if (empty($options['context'])) {
1235 // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1236 $options['context'] = $PAGE->context
;
1237 } else if (is_numeric($options['context'])) {
1238 $options['context'] = get_context_instance_by_id($options['context']);
1241 if (!$options['context']) {
1242 // we did not find any context? weird
1243 return $string = strip_tags($string);
1247 $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id
.'<+>'.current_language());
1249 //Fetch from cache if possible
1250 if (isset($strcache[$md5])) {
1251 return $strcache[$md5];
1254 // First replace all ampersands not followed by html entity code
1255 // Regular expression moved to its own method for easier unit testing
1256 $string = replace_ampersands_not_followed_by_entity($string);
1258 if (!empty($CFG->filterall
)) {
1259 $string = filter_manager
::instance()->filter_string($string, $options['context']);
1262 // If the site requires it, strip ALL tags from this string
1263 if (!empty($CFG->formatstringstriptags
)) {
1264 $string = strip_tags($string);
1267 // Otherwise strip just links if that is required (default)
1268 if ($striplinks) { //strip links in string
1269 $string = strip_links($string);
1271 $string = clean_text($string);
1275 $strcache[$md5] = $string;
1281 * Given a string, performs a negative lookahead looking for any ampersand character
1282 * that is not followed by a proper HTML entity. If any is found, it is replaced
1283 * by &. The string is then returned.
1285 * @param string $string
1288 function replace_ampersands_not_followed_by_entity($string) {
1289 return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&", $string);
1293 * Given a string, replaces all <a>.*</a> by .* and returns the string.
1295 * @param string $string
1298 function strip_links($string) {
1299 return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is','$2',$string);
1303 * This expression turns links into something nice in a text format. (Russell Jungwirth)
1305 * @param string $string
1308 function wikify_links($string) {
1309 return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i','$3 [ $2 ]', $string);
1313 * Replaces non-standard HTML entities
1315 * @param string $string
1318 function fix_non_standard_entities($string) {
1319 $text = preg_replace('/�*([0-9]+);?/', '&#$1;', $string);
1320 $text = preg_replace('/�*([0-9a-fA-F]+);?/', '&#x$1;', $text);
1321 $text = preg_replace('[\x00-\x08\x0b-\x0c\x0e-\x1f]', '', $text);
1326 * Given text in a variety of format codings, this function returns
1327 * the text as plain text suitable for plain email.
1329 * @uses FORMAT_MOODLE
1331 * @uses FORMAT_PLAIN
1333 * @uses FORMAT_MARKDOWN
1334 * @param string $text The text to be formatted. This is raw text originally from user input.
1335 * @param int $format Identifier of the text format to be used
1336 * [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1339 function format_text_email($text, $format) {
1348 // there should not be any of these any more!
1349 $text = wikify_links($text);
1350 return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES
)));
1354 return html_to_text($text);
1358 case FORMAT_MARKDOWN
:
1360 $text = wikify_links($text);
1361 return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES
)));
1367 * Formats activity intro text
1370 * @uses CONTEXT_MODULE
1371 * @param string $module name of module
1372 * @param object $activity instance of activity
1373 * @param int $cmid course module id
1374 * @param bool $filter filter resulting html text
1377 function format_module_intro($module, $activity, $cmid, $filter=true) {
1379 require_once("$CFG->libdir/filelib.php");
1380 $context = get_context_instance(CONTEXT_MODULE
, $cmid);
1381 $options = array('noclean'=>true, 'para'=>false, 'filter'=>$filter, 'context'=>$context, 'overflowdiv'=>true);
1382 $intro = file_rewrite_pluginfile_urls($activity->intro
, 'pluginfile.php', $context->id
, 'mod_'.$module, 'intro', null);
1383 return trim(format_text($intro, $activity->introformat
, $options, null));
1387 * Legacy function, used for cleaning of old forum and glossary text only.
1390 * @param string $text text that may contain legacy TRUSTTEXT marker
1391 * @return text without legacy TRUSTTEXT marker
1393 function trusttext_strip($text) {
1394 while (true) { //removing nested TRUSTTEXT
1396 $text = str_replace('#####TRUSTTEXT#####', '', $text);
1397 if (strcmp($orig, $text) === 0) {
1404 * Must be called before editing of all texts
1405 * with trust flag. Removes all XSS nasties
1406 * from texts stored in database if needed.
1408 * @param object $object data object with xxx, xxxformat and xxxtrust fields
1409 * @param string $field name of text field
1410 * @param object $context active context
1411 * @return object updated $object
1413 function trusttext_pre_edit($object, $field, $context) {
1414 $trustfield = $field.'trust';
1415 $formatfield = $field.'format';
1417 if (!$object->$trustfield or !trusttext_trusted($context)) {
1418 $object->$field = clean_text($object->$field, $object->$formatfield);
1425 * Is current user trusted to enter no dangerous XSS in this context?
1427 * Please note the user must be in fact trusted everywhere on this server!!
1429 * @param object $context
1430 * @return bool true if user trusted
1432 function trusttext_trusted($context) {
1433 return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1437 * Is trusttext feature active?
1440 * @param object $context
1443 function trusttext_active() {
1446 return !empty($CFG->enabletrusttext
);
1450 * Given raw text (eg typed in by a user), this function cleans it up
1451 * and removes any nasty tags that could mess up Moodle pages.
1453 * NOTE: the format parameter was deprecated because we can safely clean only HTML.
1455 * @param string $text The text to be cleaned
1456 * @param int $format deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
1457 * @param array $options Array of options; currently only option supported is 'allowid' (if true,
1458 * does not remove id attributes when cleaning)
1459 * @return string The cleaned up text
1461 function clean_text($text, $format = FORMAT_HTML
, $options = array()) {
1462 global $ALLOWED_TAGS, $CFG;
1464 if (empty($text) or is_numeric($text)) {
1465 return (string)$text;
1468 if ($format != FORMAT_HTML
and $format != FORMAT_HTML
) {
1469 // TODO: we need to standardise cleanup of text when loading it into editor first
1470 //debugging('clean_text() is designed to work only with html');
1473 if ($format == FORMAT_PLAIN
) {
1477 if (!empty($CFG->enablehtmlpurifier
)) {
1478 $text = purify_html($text, $options);
1480 /// Fix non standard entity notations
1481 $text = fix_non_standard_entities($text);
1483 /// Remove tags that are not allowed
1484 $text = strip_tags($text, $ALLOWED_TAGS);
1486 /// Clean up embedded scripts and , using kses
1487 $text = cleanAttributes($text);
1489 /// Again remove tags that are not allowed
1490 $text = strip_tags($text, $ALLOWED_TAGS);
1494 // Remove potential script events - some extra protection for undiscovered bugs in our code
1495 $text = preg_replace("~([^a-z])language([[:space:]]*)=~i", "$1Xlanguage=", $text);
1496 $text = preg_replace("~([^a-z])on([a-z]+)([[:space:]]*)=~i", "$1Xon$2=", $text);
1502 * KSES replacement cleaning function - uses HTML Purifier.
1505 * @param string $text The (X)HTML string to purify
1506 * @param array $options Array of options; currently only option supported is 'allowid' (if set,
1507 * does not remove id attributes when cleaning)
1509 function purify_html($text, $options = array()) {
1512 $type = !empty($options['allowid']) ?
'allowid' : 'normal';
1513 static $purifiers = array();
1514 if (empty($purifiers[$type])) {
1516 // make sure the serializer dir exists, it should be fine if it disappears later during cache reset
1517 $cachedir = $CFG->dataroot
.'/cache/htmlpurifier';
1518 check_dir_exists($cachedir);
1520 require_once $CFG->libdir
.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1521 $config = HTMLPurifier_Config
::createDefault();
1523 $config->set('HTML.DefinitionID', 'moodlehtml');
1524 $config->set('HTML.DefinitionRev', 2);
1525 $config->set('Cache.SerializerPath', $cachedir);
1526 $config->set('Cache.SerializerPermissions', $CFG->directorypermissions
);
1527 $config->set('Core.NormalizeNewlines', false);
1528 $config->set('Core.ConvertDocumentToFragment', true);
1529 $config->set('Core.Encoding', 'UTF-8');
1530 $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1531 $config->set('URI.AllowedSchemes', array('http'=>true, 'https'=>true, 'ftp'=>true, 'irc'=>true, 'nntp'=>true, 'news'=>true, 'rtsp'=>true, 'teamspeak'=>true, 'gopher'=>true, 'mms'=>true, 'mailto'=>true));
1532 $config->set('Attr.AllowedFrameTargets', array('_blank'));
1534 if (!empty($CFG->allowobjectembed
)) {
1535 $config->set('HTML.SafeObject', true);
1536 $config->set('Output.FlashCompat', true);
1537 $config->set('HTML.SafeEmbed', true);
1540 if ($type === 'allowid') {
1541 $config->set('Attr.EnableID', true);
1544 if ($def = $config->maybeGetRawHTMLDefinition()) {
1545 $def->addElement('nolink', 'Block', 'Flow', array()); // skip our filters inside
1546 $def->addElement('tex', 'Inline', 'Inline', array()); // tex syntax, equivalent to $$xx$$
1547 $def->addElement('algebra', 'Inline', 'Inline', array()); // algebra syntax, equivalent to @@xx@@
1548 $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // old and future style multilang - only our hacked lang attribute
1549 $def->addAttribute('span', 'xxxlang', 'CDATA'); // current problematic multilang
1552 $purifier = new HTMLPurifier($config);
1553 $purifiers[$type] = $purifier;
1555 $purifier = $purifiers[$type];
1558 $multilang = (strpos($text, 'class="multilang"') !== false);
1561 $text = preg_replace('/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/', '<span xxxlang="${2}">', $text);
1563 $text = $purifier->purify($text);
1565 $text = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $text);
1572 * This function takes a string and examines it for HTML tags.
1574 * If tags are detected it passes the string to a helper function {@link cleanAttributes2()}
1575 * which checks for attributes and filters them for malicious content
1577 * @param string $str The string to be examined for html tags
1580 function cleanAttributes($str){
1581 $result = preg_replace_callback(
1582 '%(<[^>]*(>|$)|>)%m', #search for html tags
1590 * This function takes a string with an html tag and strips out any unallowed
1591 * protocols e.g. javascript:
1593 * It calls ancillary functions in kses which are prefixed by kses
1597 * @param array $htmlArray An array from {@link cleanAttributes()}, containing in its 1st
1598 * element the html to be cleared
1601 function cleanAttributes2($htmlArray){
1603 global $CFG, $ALLOWED_PROTOCOLS;
1604 require_once($CFG->libdir
.'/kses.php');
1606 $htmlTag = $htmlArray[1];
1607 if (substr($htmlTag, 0, 1) != '<') {
1608 return '>'; //a single character ">" detected
1610 if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $htmlTag, $matches)) {
1611 return ''; // It's seriously malformed
1613 $slash = trim($matches[1]); //trailing xhtml slash
1614 $elem = $matches[2]; //the element name
1615 $attrlist = $matches[3]; // the list of attributes as a string
1617 $attrArray = kses_hair($attrlist, $ALLOWED_PROTOCOLS);
1620 foreach ($attrArray as $arreach) {
1621 $arreach['name'] = strtolower($arreach['name']);
1622 if ($arreach['name'] == 'style') {
1623 $value = $arreach['value'];
1625 $prevvalue = $value;
1626 $value = kses_no_null($value);
1627 $value = preg_replace("/\/\*.*\*\//Us", '', $value);
1628 $value = kses_decode_entities($value);
1629 $value = preg_replace('/(&#[0-9]+)(;?)/', "\\1;", $value);
1630 $value = preg_replace('/(&#x[0-9a-fA-F]+)(;?)/', "\\1;", $value);
1631 if ($value === $prevvalue) {
1632 $arreach['value'] = $value;
1636 $arreach['value'] = preg_replace("/j\s*a\s*v\s*a\s*s\s*c\s*r\s*i\s*p\s*t/i", "Xjavascript", $arreach['value']);
1637 $arreach['value'] = preg_replace("/v\s*b\s*s\s*c\s*r\s*i\s*p\s*t/i", "Xvbscript", $arreach['value']);
1638 $arreach['value'] = preg_replace("/e\s*x\s*p\s*r\s*e\s*s\s*s\s*i\s*o\s*n/i", "Xexpression", $arreach['value']);
1639 $arreach['value'] = preg_replace("/b\s*i\s*n\s*d\s*i\s*n\s*g/i", "Xbinding", $arreach['value']);
1640 } else if ($arreach['name'] == 'href') {
1641 //Adobe Acrobat Reader XSS protection
1642 $arreach['value'] = preg_replace('/(\.(pdf|fdf|xfdf|xdp|xfd)[^#]*)#.*$/i', '$1', $arreach['value']);
1644 $attStr .= ' '.$arreach['name'].'="'.$arreach['value'].'"';
1648 if (preg_match('%/\s*$%', $attrlist)) {
1649 $xhtml_slash = ' /';
1651 return '<'. $slash . $elem . $attStr . $xhtml_slash .'>';
1655 * Given plain text, makes it into HTML as nicely as possible.
1656 * May contain HTML tags already
1658 * Do not abuse this function. It is intended as lower level formatting feature used
1659 * by {@see format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
1660 * to call format_text() in most of cases.
1663 * @param string $text The string to convert.
1664 * @param boolean $smiley_ignored Was used to determine if smiley characters should convert to smiley images, ignored now
1665 * @param boolean $para If true then the returned string will be wrapped in div tags
1666 * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1670 function text_to_html($text, $smiley_ignored=null, $para=true, $newlines=true) {
1673 /// Remove any whitespace that may be between HTML tags
1674 $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1676 /// Remove any returns that precede or follow HTML tags
1677 $text = preg_replace("~([\n\r])<~i", " <", $text);
1678 $text = preg_replace("~>([\n\r])~i", "> ", $text);
1680 /// Make returns into HTML newlines.
1682 $text = nl2br($text);
1685 /// Wrap the whole thing in a div if required
1687 //return '<p>'.$text.'</p>'; //1.9 version
1688 return '<div class="text_to_html">'.$text.'</div>';
1695 * Given Markdown formatted text, make it into XHTML using external function
1698 * @param string $text The markdown formatted text to be converted.
1699 * @return string Converted text
1701 function markdown_to_html($text) {
1704 if ($text === '' or $text === NULL) {
1708 require_once($CFG->libdir
.'/markdown.php');
1710 return Markdown($text);
1714 * Given HTML text, make it into plain text using external function
1716 * @param string $html The text to be converted.
1717 * @param integer $width Width to wrap the text at. (optional, default 75 which
1718 * is a good value for email. 0 means do not limit line length.)
1719 * @param boolean $dolinks By default, any links in the HTML are collected, and
1720 * printed as a list at the end of the HTML. If you don't want that, set this
1721 * argument to false.
1722 * @return string plain text equivalent of the HTML.
1724 function html_to_text($html, $width = 75, $dolinks = true) {
1728 require_once($CFG->libdir
.'/html2text.php');
1730 $h2t = new html2text($html, false, $dolinks, $width);
1731 $result = $h2t->get_text();
1737 * This function will highlight search words in a given string
1739 * It cares about HTML and will not ruin links. It's best to use
1740 * this function after performing any conversions to HTML.
1742 * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1743 * @param string $haystack The string (HTML) within which to highlight the search terms.
1744 * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1745 * @param string $prefix the string to put before each search term found.
1746 * @param string $suffix the string to put after each search term found.
1747 * @return string The highlighted HTML.
1749 function highlight($needle, $haystack, $matchcase = false,
1750 $prefix = '<span class="highlight">', $suffix = '</span>') {
1752 /// Quick bail-out in trivial cases.
1753 if (empty($needle) or empty($haystack)) {
1757 /// Break up the search term into words, discard any -words and build a regexp.
1758 $words = preg_split('/ +/', trim($needle));
1759 foreach ($words as $index => $word) {
1760 if (strpos($word, '-') === 0) {
1761 unset($words[$index]);
1762 } else if (strpos($word, '+') === 0) {
1763 $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
1765 $words[$index] = preg_quote($word, '/');
1768 $regexp = '/(' . implode('|', $words) . ')/u'; // u is do UTF-8 matching.
1773 /// Another chance to bail-out if $search was only -words
1774 if (empty($words)) {
1778 /// Find all the HTML tags in the input, and store them in a placeholders array.
1779 $placeholders = array();
1781 preg_match_all('/<[^>]*>/', $haystack, $matches);
1782 foreach (array_unique($matches[0]) as $key => $htmltag) {
1783 $placeholders['<|' . $key . '|>'] = $htmltag;
1786 /// In $hastack, replace each HTML tag with the corresponding placeholder.
1787 $haystack = str_replace($placeholders, array_keys($placeholders), $haystack);
1789 /// In the resulting string, Do the highlighting.
1790 $haystack = preg_replace($regexp, $prefix . '$1' . $suffix, $haystack);
1792 /// Turn the placeholders back into HTML tags.
1793 $haystack = str_replace(array_keys($placeholders), $placeholders, $haystack);
1799 * This function will highlight instances of $needle in $haystack
1801 * It's faster that the above function {@link highlight()} and doesn't care about
1804 * @param string $needle The string to search for
1805 * @param string $haystack The string to search for $needle in
1806 * @return string The highlighted HTML
1808 function highlightfast($needle, $haystack) {
1810 if (empty($needle) or empty($haystack)) {
1814 $parts = explode(moodle_strtolower($needle), moodle_strtolower($haystack));
1816 if (count($parts) === 1) {
1822 foreach ($parts as $key => $part) {
1823 $parts[$key] = substr($haystack, $pos, strlen($part));
1824 $pos +
= strlen($part);
1826 $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
1827 $pos +
= strlen($needle);
1830 return str_replace('<span class="highlight"></span>', '', join('', $parts));
1834 * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
1835 * Internationalisation, for print_header and backup/restorelib.
1837 * @param bool $dir Default false
1838 * @return string Attributes
1840 function get_html_lang($dir = false) {
1843 if (right_to_left()) {
1844 $direction = ' dir="rtl"';
1846 $direction = ' dir="ltr"';
1849 //Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
1850 $language = str_replace('_', '-', current_language());
1851 @header
('Content-Language: '.$language);
1852 return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
1856 /// STANDARD WEB PAGE PARTS ///////////////////////////////////////////////////
1859 * Send the HTTP headers that Moodle requires.
1860 * @param $cacheable Can this page be cached on back?
1862 function send_headers($contenttype, $cacheable = true) {
1863 @header
('Content-Type: ' . $contenttype);
1864 @header
('Content-Script-Type: text/javascript');
1865 @header
('Content-Style-Type: text/css');
1868 // Allow caching on "back" (but not on normal clicks)
1869 @header
('Cache-Control: private, pre-check=0, post-check=0, max-age=0');
1870 @header
('Pragma: no-cache');
1871 @header
('Expires: ');
1873 // Do everything we can to always prevent clients and proxies caching
1874 @header
('Cache-Control: no-store, no-cache, must-revalidate');
1875 @header
('Cache-Control: post-check=0, pre-check=0', false);
1876 @header
('Pragma: no-cache');
1877 @header
('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1878 @header
('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1880 @header
('Accept-Ranges: none');
1884 * Return the right arrow with text ('next'), and optionally embedded in a link.
1887 * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1888 * @param string $url An optional link to use in a surrounding HTML anchor.
1889 * @param bool $accesshide True if text should be hidden (for screen readers only).
1890 * @param string $addclass Additional class names for the link, or the arrow character.
1891 * @return string HTML string.
1893 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
1894 global $OUTPUT; //TODO: move to output renderer
1895 $arrowclass = 'arrow ';
1897 $arrowclass .= $addclass;
1899 $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
1902 $htmltext = '<span class="arrow_text">'.$text.'</span> ';
1904 $htmltext = get_accesshide($htmltext);
1908 $class = 'arrow_link';
1910 $class .= ' '.$addclass;
1912 return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$htmltext.$arrow.'</a>';
1914 return $htmltext.$arrow;
1918 * Return the left arrow with text ('previous'), and optionally embedded in a link.
1921 * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1922 * @param string $url An optional link to use in a surrounding HTML anchor.
1923 * @param bool $accesshide True if text should be hidden (for screen readers only).
1924 * @param string $addclass Additional class names for the link, or the arrow character.
1925 * @return string HTML string.
1927 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
1928 global $OUTPUT; // TODO: move to utput renderer
1929 $arrowclass = 'arrow ';
1931 $arrowclass .= $addclass;
1933 $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
1936 $htmltext = ' <span class="arrow_text">'.$text.'</span>';
1938 $htmltext = get_accesshide($htmltext);
1942 $class = 'arrow_link';
1944 $class .= ' '.$addclass;
1946 return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$arrow.$htmltext.'</a>';
1948 return $arrow.$htmltext;
1952 * Return a HTML element with the class "accesshide", for accessibility.
1953 * Please use cautiously - where possible, text should be visible!
1955 * @param string $text Plain text.
1956 * @param string $elem Lowercase element name, default "span".
1957 * @param string $class Additional classes for the element.
1958 * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
1959 * @return string HTML string.
1961 function get_accesshide($text, $elem='span', $class='', $attrs='') {
1962 return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
1966 * Return the breadcrumb trail navigation separator.
1968 * @return string HTML string.
1970 function get_separator() {
1971 //Accessibility: the 'hidden' slash is preferred for screen readers.
1972 return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
1976 * Print (or return) a collapsible region, that has a caption that can
1977 * be clicked to expand or collapse the region.
1979 * If JavaScript is off, then the region will always be expanded.
1981 * @param string $contents the contents of the box.
1982 * @param string $classes class names added to the div that is output.
1983 * @param string $id id added to the div that is output. Must not be blank.
1984 * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
1985 * @param string $userpref the name of the user preference that stores the user's preferred default state.
1986 * (May be blank if you do not wish the state to be persisted.
1987 * @param boolean $default Initial collapsed state to use if the user_preference it not set.
1988 * @param boolean $return if true, return the HTML as a string, rather than printing it.
1989 * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
1991 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
1992 $output = print_collapsible_region_start($classes, $id, $caption, $userpref, $default, true);
1993 $output .= $contents;
1994 $output .= print_collapsible_region_end(true);
2004 * Print (or return) the start of a collapsible region, that has a caption that can
2005 * be clicked to expand or collapse the region. If JavaScript is off, then the region
2006 * will always be expanded.
2008 * @param string $classes class names added to the div that is output.
2009 * @param string $id id added to the div that is output. Must not be blank.
2010 * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2011 * @param string $userpref the name of the user preference that stores the user's preferred default state.
2012 * (May be blank if you do not wish the state to be persisted.
2013 * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2014 * @param boolean $return if true, return the HTML as a string, rather than printing it.
2015 * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2017 function print_collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2018 global $CFG, $PAGE, $OUTPUT;
2020 // Work out the initial state.
2021 if (!empty($userpref) and is_string($userpref)) {
2022 user_preference_allow_ajax_update($userpref, PARAM_BOOL
);
2023 $collapsed = get_user_preferences($userpref, $default);
2025 $collapsed = $default;
2030 $classes .= ' collapsed';
2034 $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2035 $output .= '<div id="' . $id . '_sizer">';
2036 $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2037 $output .= $caption . ' ';
2038 $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2039 $PAGE->requires
->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2049 * Close a region started with print_collapsible_region_start.
2051 * @param boolean $return if true, return the HTML as a string, rather than printing it.
2052 * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2054 function print_collapsible_region_end($return = false) {
2055 $output = '</div></div></div>';
2065 * Print a specified group's avatar.
2068 * @uses CONTEXT_COURSE
2069 * @param array|stdClass $group A single {@link group} object OR array of groups.
2070 * @param int $courseid The course ID.
2071 * @param boolean $large Default small picture, or large.
2072 * @param boolean $return If false print picture, otherwise return the output as string
2073 * @param boolean $link Enclose image in a link to view specified course?
2074 * @return string|void Depending on the setting of $return
2076 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2079 if (is_array($group)) {
2081 foreach($group as $g) {
2082 $output .= print_group_picture($g, $courseid, $large, true, $link);
2092 $context = get_context_instance(CONTEXT_COURSE
, $courseid);
2094 // If there is no picture, do nothing
2095 if (!$group->picture
) {
2099 // If picture is hidden, only show to those with course:managegroups
2100 if ($group->hidepicture
and !has_capability('moodle/course:managegroups', $context)) {
2104 if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2105 $output = '<a href="'. $CFG->wwwroot
.'/user/index.php?id='. $courseid .'&group='. $group->id
.'">';
2115 $grouppictureurl = moodle_url
::make_pluginfile_url($context->id
, 'group', 'icon', $group->id
, '/', $file);
2116 $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2117 ' alt="'.s(get_string('group').' '.$group->name
).'" title="'.s($group->name
).'"/>';
2119 if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2132 * Display a recent activity note
2134 * @uses CONTEXT_SYSTEM
2135 * @staticvar string $strftimerecent
2136 * @param object A time object
2137 * @param object A user object
2138 * @param string $text Text for display for the note
2139 * @param string $link The link to wrap around the text
2140 * @param bool $return If set to true the HTML is returned rather than echo'd
2141 * @param string $viewfullnames
2143 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2144 static $strftimerecent = null;
2147 if (is_null($viewfullnames)) {
2148 $context = get_context_instance(CONTEXT_SYSTEM
);
2149 $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2152 if (is_null($strftimerecent)) {
2153 $strftimerecent = get_string('strftimerecent');
2156 $output .= '<div class="head">';
2157 $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2158 $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2159 $output .= '</div>';
2160 $output .= '<div class="info"><a href="'.$link.'">'.format_string($text,true).'</a></div>';
2170 * Returns a popup menu with course activity modules
2173 * This function returns a small popup menu with all the
2174 * course activity modules in it, as a navigation menu
2175 * outputs a simple list structure in XHTML
2176 * The data is taken from the serialised array stored in
2179 * @todo Finish documenting this function
2182 * @uses CONTEXT_COURSE
2183 * @param course $course A {@link $COURSE} object.
2184 * @param string $sections
2185 * @param string $modinfo
2186 * @param string $strsection
2187 * @param string $strjumpto
2189 * @param string $cmid
2190 * @return string The HTML block
2192 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2194 global $CFG, $OUTPUT;
2199 $doneheading = false;
2201 $coursecontext = get_context_instance(CONTEXT_COURSE
, $course->id
);
2203 $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2204 foreach ($modinfo->cms
as $mod) {
2205 if (!$mod->has_view()) {
2206 // Don't show modules which you can't link to!
2210 if ($mod->sectionnum
> $course->numsections
) { /// Don't show excess hidden sections
2214 if (!$mod->uservisible
) { // do not icnlude empty sections at all
2218 if ($mod->sectionnum
>= 0 and $section != $mod->sectionnum
) {
2219 $thissection = $sections[$mod->sectionnum
];
2221 if ($thissection->visible
or !$course->hiddensections
or
2222 has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2223 $thissection->summary
= strip_tags(format_string($thissection->summary
,true));
2224 if (!$doneheading) {
2225 $menu[] = '</ul></li>';
2227 if ($course->format
== 'weeks' or empty($thissection->summary
)) {
2228 $item = $strsection ." ". $mod->sectionnum
;
2230 if (strlen($thissection->summary
) < ($width-3)) {
2231 $item = $thissection->summary
;
2233 $item = substr($thissection->summary
, 0, $width).'...';
2236 $menu[] = '<li class="section"><span>'.$item.'</span>';
2238 $doneheading = true;
2240 $section = $mod->sectionnum
;
2242 // no activities from this hidden section shown
2247 $url = $mod->modname
.'/view.php?id='. $mod->id
;
2248 $mod->name
= strip_tags(format_string($mod->name
,true));
2249 if (strlen($mod->name
) > ($width+
5)) {
2250 $mod->name
= substr($mod->name
, 0, $width).'...';
2252 if (!$mod->visible
) {
2253 $mod->name
= '('.$mod->name
.')';
2255 $class = 'activity '.$mod->modname
;
2256 $class .= ($cmid == $mod->id
) ?
' selected' : '';
2257 $menu[] = '<li class="'.$class.'">'.
2258 '<img src="'.$OUTPUT->pix_url('icon', $mod->modname
) . '" alt="" />'.
2259 '<a href="'.$CFG->wwwroot
.'/mod/'.$url.'">'.$mod->name
.'</a></li>';
2263 $menu[] = '</ul></li>';
2265 $menu[] = '</ul></li></ul>';
2267 return implode("\n", $menu);
2271 * Prints a grade menu (as part of an existing form) with help
2272 * Showing all possible numerical grades and scales
2274 * @todo Finish documenting this function
2275 * @todo Deprecate: this is only used in a few contrib modules
2278 * @param int $courseid The course ID
2279 * @param string $name
2280 * @param string $current
2281 * @param boolean $includenograde Include those with no grades
2282 * @param boolean $return If set to true returns rather than echo's
2283 * @return string|bool Depending on value of $return
2285 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2287 global $CFG, $OUTPUT;
2290 $strscale = get_string('scale');
2291 $strscales = get_string('scales');
2293 $scales = get_scales_menu($courseid);
2294 foreach ($scales as $i => $scalename) {
2295 $grades[-$i] = $strscale .': '. $scalename;
2297 if ($includenograde) {
2298 $grades[0] = get_string('nograde');
2300 for ($i=100; $i>=1; $i--) {
2303 $output .= html_writer
::select($grades, $name, $current, false);
2305 $linkobject = '<span class="helplink"><img class="iconhelp" alt="'.$strscales.'" src="'.$OUTPUT->pix_url('help') . '" /></span>';
2306 $link = new moodle_url('/course/scales.php', array('id'=>$courseid, 'list'=>1));
2307 $action = new popup_action('click', $link, 'ratingscales', array('height' => 400, 'width' => 500));
2308 $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title'=>$strscales));
2318 * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2319 * Default errorcode is 1.
2321 * Very useful for perl-like error-handling:
2323 * do_somethting() or mdie("Something went wrong");
2325 * @param string $msg Error message
2326 * @param integer $errorcode Error code to emit
2328 function mdie($msg='', $errorcode=1) {
2329 trigger_error($msg);
2334 * Print a message and exit.
2336 * @param string $message The message to print in the notice
2337 * @param string $link The link to use for the continue button
2338 * @param object $course A course object
2339 * @return void This function simply exits
2341 function notice ($message, $link='', $course=NULL) {
2342 global $CFG, $SITE, $COURSE, $PAGE, $OUTPUT;
2344 $message = clean_text($message); // In case nasties are in here
2347 echo("!!$message!!\n");
2348 exit(1); // no success
2351 if (!$PAGE->headerprinted
) {
2352 //header not yet printed
2353 $PAGE->set_title(get_string('notice'));
2354 echo $OUTPUT->header();
2356 echo $OUTPUT->container_end_all(false);
2359 echo $OUTPUT->box($message, 'generalbox', 'notice');
2360 echo $OUTPUT->continue_button($link);
2362 echo $OUTPUT->footer();
2363 exit(1); // general error code
2367 * Redirects the user to another page, after printing a notice
2369 * This function calls the OUTPUT redirect method, echo's the output
2370 * and then dies to ensure nothing else happens.
2372 * <strong>Good practice:</strong> You should call this method before starting page
2373 * output by using any of the OUTPUT methods.
2375 * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2376 * @param string $message The message to display to the user
2377 * @param int $delay The delay before redirecting
2378 * @return void - does not return!
2380 function redirect($url, $message='', $delay=-1) {
2381 global $OUTPUT, $PAGE, $SESSION, $CFG;
2383 if (CLI_SCRIPT
or AJAX_SCRIPT
) {
2384 // this is wrong - developers should not use redirect in these scripts,
2385 // but it should not be very likely
2386 throw new moodle_exception('redirecterrordetected', 'error');
2389 // prevent debug errors - make sure context is properly initialised
2391 $PAGE->set_context(null);
2394 if ($url instanceof moodle_url
) {
2395 $url = $url->out(false);
2398 if (!empty($CFG->usesid
) && !isset($_COOKIE[session_name()])) {
2399 $url = $SESSION->sid_process_url($url);
2402 $debugdisableredirect = false;
2404 if (defined('DEBUGGING_PRINTED')) {
2405 // some debugging already printed, no need to look more
2406 $debugdisableredirect = true;
2410 if (empty($CFG->debugdisplay
) or empty($CFG->debug
)) {
2411 // no errors should be displayed
2415 if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2419 if (!($lasterror['type'] & $CFG->debug
)) {
2420 //last error not interesting
2424 // watch out here, @hidden() errors are returned from error_get_last() too
2425 if (headers_sent()) {
2426 //we already started printing something - that means errors likely printed
2427 $debugdisableredirect = true;
2431 if (ob_get_level() and ob_get_contents()) {
2432 // there is something waiting to be printed, hopefully it is the errors,
2433 // but it might be some error hidden by @ too - such as the timezone mess from setup.php
2434 $debugdisableredirect = true;
2439 if (!empty($message)) {
2440 if ($delay === -1 ||
!is_numeric($delay)) {
2443 $message = clean_text($message);
2445 $message = get_string('pageshouldredirect');
2447 // We are going to try to use a HTTP redirect, so we need a full URL.
2448 if (!preg_match('|^[a-z]+:|', $url)) {
2449 // Get host name http://www.wherever.com
2450 $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot
);
2451 if (preg_match('|^/|', $url)) {
2452 // URLs beginning with / are relative to web server root so we just add them in
2453 $url = $hostpart.$url;
2455 // URLs not beginning with / are relative to path of current script, so add that on.
2456 $url = $hostpart.preg_replace('|\?.*$|','',me()).'/../'.$url;
2460 $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2461 if ($newurl == $url) {
2469 if (defined('MDL_PERF') ||
(!empty($CFG->perfdebug
) and $CFG->perfdebug
> 7)) {
2470 if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
2471 $perf = get_performance_info();
2472 error_log("PERF: " . $perf['txt']);
2476 $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&", $url);
2477 $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />'));
2479 if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2480 // workaround for IIS bug http://support.microsoft.com/kb/q176113/
2482 session_get_instance()->write_close();
2485 //302 might not work for POST requests, 303 is ignored by obsolete clients.
2486 @header
($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2487 @header
('Location: '.$url);
2488 echo bootstrap_renderer
::plain_redirect_message($encodedurl);
2492 // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2493 $PAGE->set_pagelayout('redirect'); // No header and footer needed
2494 $CFG->docroot
= false; // to prevent the link to moodle docs from being displayed on redirect page.
2495 echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect);
2500 * Given an email address, this function will return an obfuscated version of it
2502 * @param string $email The email address to obfuscate
2503 * @return string The obfuscated email address
2505 function obfuscate_email($email) {
2508 $length = strlen($email);
2510 while ($i < $length) {
2511 if (rand(0,2) && $email{$i}!='@') { //MDL-20619 some browsers have problems unobfuscating @
2512 $obfuscated.='%'.dechex(ord($email{$i}));
2514 $obfuscated.=$email{$i};
2522 * This function takes some text and replaces about half of the characters
2523 * with HTML entity equivalents. Return string is obviously longer.
2525 * @param string $plaintext The text to be obfuscated
2526 * @return string The obfuscated text
2528 function obfuscate_text($plaintext) {
2531 $length = strlen($plaintext);
2533 $prev_obfuscated = false;
2534 while ($i < $length) {
2535 $c = ord($plaintext{$i});
2536 $numerical = ($c >= ord('0')) && ($c <= ord('9'));
2537 if ($prev_obfuscated and $numerical ) {
2538 $obfuscated.='&#'.ord($plaintext{$i}).';';
2539 } else if (rand(0,2)) {
2540 $obfuscated.='&#'.ord($plaintext{$i}).';';
2541 $prev_obfuscated = true;
2543 $obfuscated.=$plaintext{$i};
2544 $prev_obfuscated = false;
2552 * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2553 * to generate a fully obfuscated email link, ready to use.
2555 * @param string $email The email address to display
2556 * @param string $label The text to displayed as hyperlink to $email
2557 * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2558 * @return string The obfuscated mailto link
2560 function obfuscate_mailto($email, $label='', $dimmed=false) {
2562 if (empty($label)) {
2566 $title = get_string('emaildisable');
2567 $dimmed = ' class="dimmed"';
2572 return sprintf("<a href=\"%s:%s\" $dimmed title=\"$title\">%s</a>",
2573 obfuscate_text('mailto'), obfuscate_email($email),
2574 obfuscate_text($label));
2578 * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2579 * will transform it to html entities
2581 * @param string $text Text to search for nolink tag in
2584 function rebuildnolinktag($text) {
2586 $text = preg_replace('/<(\/*nolink)>/i','<$1>',$text);
2592 * Prints a maintenance message from $CFG->maintenance_message or default if empty
2595 function print_maintenance_message() {
2596 global $CFG, $SITE, $PAGE, $OUTPUT;
2598 $PAGE->set_pagetype('maintenance-message');
2599 $PAGE->set_pagelayout('maintenance');
2600 $PAGE->set_title(strip_tags($SITE->fullname
));
2601 $PAGE->set_heading($SITE->fullname
);
2602 echo $OUTPUT->header();
2603 echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2604 if (isset($CFG->maintenance_message
) and !html_is_blank($CFG->maintenance_message
)) {
2605 echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2606 echo $CFG->maintenance_message
;
2607 echo $OUTPUT->box_end();
2609 echo $OUTPUT->footer();
2614 * Adjust the list of allowed tags based on $CFG->allowobjectembed and user roles (admin)
2620 function adjust_allowed_tags() {
2622 global $CFG, $ALLOWED_TAGS;
2624 if (!empty($CFG->allowobjectembed
)) {
2625 $ALLOWED_TAGS .= '<embed><object>';
2630 * A class for tabs, Some code to print tabs
2632 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2633 * @package moodlecore
2645 var $linkedwhenselected;
2648 * A constructor just because I like constructors
2651 * @param string $link
2652 * @param string $text
2653 * @param string $title
2654 * @param bool $linkedwhenselected
2656 function tabobject ($id, $link='', $text='', $title='', $linkedwhenselected=false) {
2658 $this->link
= $link;
2659 $this->text
= $text;
2660 $this->title
= $title ?
$title : $text;
2661 $this->linkedwhenselected
= $linkedwhenselected;
2668 * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2671 * @param array $tabrows An array of rows where each row is an array of tab objects
2672 * @param string $selected The id of the selected tab (whatever row it's on)
2673 * @param array $inactive An array of ids of inactive tabs that are not selectable.
2674 * @param array $activated An array of ids of other tabs that are currently activated
2675 * @param bool $return If true output is returned rather then echo'd
2677 function print_tabs($tabrows, $selected=NULL, $inactive=NULL, $activated=NULL, $return=false) {
2680 /// $inactive must be an array
2681 if (!is_array($inactive)) {
2682 $inactive = array();
2685 /// $activated must be an array
2686 if (!is_array($activated)) {
2687 $activated = array();
2690 /// Convert the tab rows into a tree that's easier to process
2691 if (!$tree = convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated)) {
2695 /// Print out the current tree of tabs (this function is recursive)
2697 $output = convert_tree_to_html($tree);
2699 $output = "\n\n".'<div class="tabtree">'.$output.'</div><div class="clearer"> </div>'."\n\n";
2710 * Converts a nested array tree into HTML ul:li [recursive]
2712 * @param array $tree A tree array to convert
2713 * @param int $row Used in identifying the iteration level and in ul classes
2714 * @return string HTML structure
2716 function convert_tree_to_html($tree, $row=0) {
2718 $str = "\n".'<ul class="tabrow'.$row.'">'."\n";
2721 $count = count($tree);
2723 foreach ($tree as $tab) {
2724 $count--; // countdown to zero
2728 if ($first && ($count == 0)) { // Just one in the row
2729 $liclass = 'first last';
2731 } else if ($first) {
2734 } else if ($count == 0) {
2738 if ((empty($tab->subtree
)) && (!empty($tab->selected
))) {
2739 $liclass .= (empty($liclass)) ?
'onerow' : ' onerow';
2742 if ($tab->inactive ||
$tab->active ||
$tab->selected
) {
2743 if ($tab->selected
) {
2744 $liclass .= (empty($liclass)) ?
'here selected' : ' here selected';
2745 } else if ($tab->active
) {
2746 $liclass .= (empty($liclass)) ?
'here active' : ' here active';
2750 $str .= (!empty($liclass)) ?
'<li class="'.$liclass.'">' : '<li>';
2752 if ($tab->inactive ||
$tab->active ||
($tab->selected
&& !$tab->linkedwhenselected
)) {
2753 // The a tag is used for styling
2754 $str .= '<a class="nolink"><span>'.$tab->text
.'</span></a>';
2756 $str .= '<a href="'.$tab->link
.'" title="'.$tab->title
.'"><span>'.$tab->text
.'</span></a>';
2759 if (!empty($tab->subtree
)) {
2760 $str .= convert_tree_to_html($tab->subtree
, $row+
1);
2761 } else if ($tab->selected
) {
2762 $str .= '<div class="tabrow'.($row+
1).' empty"> </div>'."\n";
2765 $str .= ' </li>'."\n";
2767 $str .= '</ul>'."\n";
2773 * Convert nested tabrows to a nested array
2775 * @param array $tabrows A [nested] array of tab row objects
2776 * @param string $selected The tabrow to select (by id)
2777 * @param array $inactive An array of tabrow id's to make inactive
2778 * @param array $activated An array of tabrow id's to make active
2779 * @return array The nested array
2781 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
2783 /// Work backwards through the rows (bottom to top) collecting the tree as we go.
2785 $tabrows = array_reverse($tabrows);
2789 foreach ($tabrows as $row) {
2792 foreach ($row as $tab) {
2793 $tab->inactive
= in_array((string)$tab->id
, $inactive);
2794 $tab->active
= in_array((string)$tab->id
, $activated);
2795 $tab->selected
= (string)$tab->id
== $selected;
2797 if ($tab->active ||
$tab->selected
) {
2799 $tab->subtree
= $subtree;
2811 * Standard Debugging Function
2813 * Returns true if the current site debugging settings are equal or above specified level.
2814 * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2815 * routing of notices is controlled by $CFG->debugdisplay
2818 * 1) debugging('a normal debug notice');
2819 * 2) debugging('something really picky', DEBUG_ALL);
2820 * 3) debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
2821 * 4) if (debugging()) { perform extra debugging operations (do not use print or echo) }
2823 * In code blocks controlled by debugging() (such as example 4)
2824 * any output should be routed via debugging() itself, or the lower-level
2825 * trigger_error() or error_log(). Using echo or print will break XHTML
2826 * JS and HTTP headers.
2828 * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2830 * @uses DEBUG_NORMAL
2831 * @param string $message a message to print
2832 * @param int $level the level at which this debugging statement should show
2833 * @param array $backtrace use different backtrace
2836 function debugging($message = '', $level = DEBUG_NORMAL
, $backtrace = null) {
2837 global $CFG, $USER, $UNITTEST;
2839 $forcedebug = false;
2840 if (!empty($CFG->debugusers
)) {
2841 $debugusers = explode(',', $CFG->debugusers
);
2842 $forcedebug = in_array($USER->id
, $debugusers);
2845 if (!$forcedebug and (empty($CFG->debug
) ||
$CFG->debug
< $level)) {
2849 if (!isset($CFG->debugdisplay
)) {
2850 $CFG->debugdisplay
= ini_get_bool('display_errors');
2855 $backtrace = debug_backtrace();
2857 $from = format_backtrace($backtrace, CLI_SCRIPT
);
2858 if (!empty($UNITTEST->running
)) {
2859 // When the unit tests are running, any call to trigger_error
2860 // is intercepted by the test framework and reported as an exception.
2861 // Therefore, we cannot use trigger_error during unit tests.
2862 // At the same time I do not think we should just discard those messages,
2863 // so displaying them on-screen seems like the only option. (MDL-20398)
2864 echo '<div class="notifytiny">' . $message . $from . '</div>';
2866 } else if (NO_DEBUG_DISPLAY
) {
2867 // script does not want any errors or debugging in output,
2868 // we send the info to error log instead
2869 error_log('Debugging: ' . $message . $from);
2871 } else if ($forcedebug or $CFG->debugdisplay
) {
2872 if (!defined('DEBUGGING_PRINTED')) {
2873 define('DEBUGGING_PRINTED', 1); // indicates we have printed something
2876 echo "++ $message ++\n$from";
2878 echo '<div class="notifytiny">' . $message . $from . '</div>';
2882 trigger_error($message . $from, E_USER_NOTICE
);
2889 * Outputs a HTML comment to the browser. This is used for those hard-to-debug
2890 * pages that use bits from many different files in very confusing ways (e.g. blocks).
2892 * <code>print_location_comment(__FILE__, __LINE__);</code>
2894 * @param string $file
2895 * @param integer $line
2896 * @param boolean $return Whether to return or print the comment
2897 * @return string|void Void unless true given as third parameter
2899 function print_location_comment($file, $line, $return = false)
2902 return "<!-- $file at line $line -->\n";
2904 echo "<!-- $file at line $line -->\n";
2910 * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
2912 function right_to_left() {
2913 return (get_string('thisdirection', 'langconfig') === 'rtl');
2918 * Returns swapped left<=>right if in RTL environment.
2919 * part of RTL support
2921 * @param string $align align to check
2924 function fix_align_rtl($align) {
2925 if (!right_to_left()) {
2928 if ($align=='left') { return 'right'; }
2929 if ($align=='right') { return 'left'; }
2935 * Returns true if the page is displayed in a popup window.
2936 * Gets the information from the URL parameter inpopup.
2938 * @todo Use a central function to create the popup calls all over Moodle and
2939 * In the moment only works with resources and probably questions.
2943 function is_in_popup() {
2944 $inpopup = optional_param('inpopup', '', PARAM_BOOL
);
2950 * To use this class.
2952 * - call create (or use the 3rd param to the constructor)
2953 * - call update or update_full() or update() repeatedly
2955 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2956 * @package moodlecore
2958 class progress_bar
{
2959 /** @var string html id */
2961 /** @var int total width */
2963 /** @var int last percentage printed */
2964 private $percent = 0;
2965 /** @var int time when last printed */
2966 private $lastupdate = 0;
2967 /** @var int when did we start printing this */
2968 private $time_start = 0;
2973 * @param string $html_id
2975 * @param bool $autostart Default to false
2976 * @return void, prints JS code if $autostart true
2978 public function __construct($html_id = '', $width = 500, $autostart = false) {
2979 if (!empty($html_id)) {
2980 $this->html_id
= $html_id;
2982 $this->html_id
= 'pbar_'.uniqid();
2985 $this->width
= $width;
2993 * Create a new progress bar, this function will output html.
2995 * @return void Echo's output
2997 public function create() {
2998 $this->time_start
= microtime(true);
3000 return; // temporary solution for cli scripts
3003 <div style="text-align:center;width:{$this->width}px;clear:both;padding:0;margin:0 auto;">
3004 <h2 id="status_{$this->html_id}" style="text-align: center;margin:0 auto"></h2>
3005 <p id="time_{$this->html_id}"></p>
3006 <div id="bar_{$this->html_id}" style="border-style:solid;border-width:1px;width:500px;height:50px;">
3007 <div id="progress_{$this->html_id}"
3008 style="text-align:center;background:#FFCC66;width:4px;border:1px
3009 solid gray;height:38px; padding-top:10px;"> <span id="pt_{$this->html_id}"></span>
3020 * Update the progress bar
3022 * @param int $percent from 1-100
3023 * @param string $msg
3024 * @return void Echo's output
3026 private function _update($percent, $msg) {
3027 if (empty($this->time_start
)) {
3028 throw new coding_exception('You must call create() (or use the $autostart ' .
3029 'argument to the constructor) before you try updating the progress bar.');
3033 return; // temporary solution for cli scripts
3036 $es = $this->estimate($percent);
3039 // always do the first and last updates
3041 } else if ($es == 0) {
3042 // always do the last updates
3043 } else if ($this->lastupdate +
20 < time()) {
3044 // we must update otherwise browser would time out
3045 } else if (round($this->percent
, 2) === round($percent, 2)) {
3046 // no significant change, no need to update anything
3050 $this->percent
= $percent;
3051 $this->lastupdate
= microtime(true);
3053 $w = ($this->percent
/100) * $this->width
;
3054 echo html_writer
::script(js_writer
::function_call('update_progress_bar', array($this->html_id
, $w, $this->percent
, $msg, $es)));
3059 * Estimate how much time it is going to take.
3061 * @param int $curtime the time call this function
3062 * @param int $percent from 1-100
3063 * @return mixed Null (unknown), or int
3065 private function estimate($pt) {
3066 if ($this->lastupdate
== 0) {
3069 if ($pt < 0.00001) {
3070 return null; // we do not know yet how long it will take
3072 if ($pt > 99.99999) {
3073 return 0; // nearly done, right?
3075 $consumed = microtime(true) - $this->time_start
;
3076 if ($consumed < 0.001) {
3080 return (100 - $pt) * ($consumed / $pt);
3084 * Update progress bar according percent
3086 * @param int $percent from 1-100
3087 * @param string $msg the message needed to be shown
3089 public function update_full($percent, $msg) {
3090 $percent = max(min($percent, 100), 0);
3091 $this->_update($percent, $msg);
3095 * Update progress bar according the number of tasks
3097 * @param int $cur current task number
3098 * @param int $total total task number
3099 * @param string $msg message
3101 public function update($cur, $total, $msg) {
3102 $percent = ($cur / $total) * 100;
3103 $this->update_full($percent, $msg);
3107 * Restart the progress bar.
3109 public function restart() {
3111 $this->lastupdate
= 0;
3112 $this->time_start
= 0;
3117 * Use this class from long operations where you want to output occasional information about
3118 * what is going on, but don't know if, or in what format, the output should be.
3120 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3121 * @package moodlecore
3123 abstract class progress_trace
{
3125 * Ouput an progress message in whatever format.
3126 * @param string $message the message to output.
3127 * @param integer $depth indent depth for this message.
3129 abstract public function output($message, $depth = 0);
3132 * Called when the processing is finished.
3134 public function finished() {
3139 * This subclass of progress_trace does not ouput anything.
3141 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3142 * @package moodlecore
3144 class null_progress_trace
extends progress_trace
{
3148 * @param string $message
3150 * @return void Does Nothing
3152 public function output($message, $depth = 0) {
3157 * This subclass of progress_trace outputs to plain text.
3159 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3160 * @package moodlecore
3162 class text_progress_trace
extends progress_trace
{
3164 * Output the trace message
3166 * @param string $message
3168 * @return void Output is echo'd
3170 public function output($message, $depth = 0) {
3171 echo str_repeat(' ', $depth), $message, "\n";
3177 * This subclass of progress_trace outputs as HTML.
3179 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3180 * @package moodlecore
3182 class html_progress_trace
extends progress_trace
{
3184 * Output the trace message
3186 * @param string $message
3188 * @return void Output is echo'd
3190 public function output($message, $depth = 0) {
3191 echo '<p>', str_repeat('  ', $depth), htmlspecialchars($message), "</p>\n";
3197 * HTML List Progress Tree
3199 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3200 * @package moodlecore
3202 class html_list_progress_trace
extends progress_trace
{
3204 protected $currentdepth = -1;
3209 * @param string $message The message to display
3211 * @return void Output is echoed
3213 public function output($message, $depth = 0) {
3215 while ($this->currentdepth
> $depth) {
3216 echo "</li>\n</ul>\n";
3217 $this->currentdepth
-= 1;
3218 if ($this->currentdepth
== $depth) {
3223 while ($this->currentdepth
< $depth) {
3225 $this->currentdepth +
= 1;
3231 echo htmlspecialchars($message);
3236 * Called when the processing is finished.
3238 public function finished() {
3239 while ($this->currentdepth
>= 0) {
3240 echo "</li>\n</ul>\n";
3241 $this->currentdepth
-= 1;
3247 * Returns a localized sentence in the current language summarizing the current password policy
3249 * @todo this should be handled by a function/method in the language pack library once we have a support for it
3253 function print_password_policy() {
3257 if (!empty($CFG->passwordpolicy
)) {
3258 $messages = array();
3259 $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength
);
3260 if (!empty($CFG->minpassworddigits
)) {
3261 $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits
);
3263 if (!empty($CFG->minpasswordlower
)) {
3264 $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower
);
3266 if (!empty($CFG->minpasswordupper
)) {
3267 $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper
);
3269 if (!empty($CFG->minpasswordnonalphanum
)) {
3270 $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum
);
3273 $messages = join(', ', $messages); // this is ugly but we do not have anything better yet...
3274 $message = get_string('informpasswordpolicy', 'auth', $messages);