2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Library of functions for web output
20 * Library of all general-purpose Moodle PHP functions and constants
21 * that produce HTML output
23 * Other main libraries:
24 * - datalib.php - functions that access the database.
25 * - moodlelib.php - general-purpose Moodle functions.
29 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
30 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33 defined('MOODLE_INTERNAL') ||
die();
37 // Define text formatting types ... eventually we can add Wiki, BBcode etc.
40 * Does all sorts of transformations and filtering.
42 define('FORMAT_MOODLE', '0');
45 * Plain HTML (with some tags stripped).
47 define('FORMAT_HTML', '1');
50 * Plain text (even tags are printed in full).
52 define('FORMAT_PLAIN', '2');
55 * Wiki-formatted text.
56 * Deprecated: left here just to note that '3' is not used (at the moment)
57 * and to catch any latent wiki-like text (which generates an error)
58 * @deprecated since 2005!
60 define('FORMAT_WIKI', '3');
63 * Markdown-formatted text http://daringfireball.net/projects/markdown/
65 define('FORMAT_MARKDOWN', '4');
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);
73 * A moodle_url comparison using this flag will return true if the base URLs match and the params of url1 are part of url2.
75 define('URL_MATCH_PARAMS', 1);
78 * A moodle_url comparison using this flag will return true if the two URLs are identical, except for the order of the params.
80 define('URL_MATCH_EXACT', 2);
85 * Add quotes to HTML characters.
87 * Returns $var with HTML characters (like "<", ">", etc.) properly quoted.
88 * Related function {@link p()} simply prints the output of this function.
90 * @param string $var the string potentially containing HTML characters
99 // When we move to PHP 5.4 as a minimum version, change ENT_QUOTES on the
100 // next line to ENT_QUOTES | ENT_HTML5 | ENT_SUBSTITUTE, and remove the
101 // 'UTF-8' argument. Both bring a speed-increase.
102 return preg_replace('/&#(\d+|x[0-9a-f]+);/i', '&#$1;', htmlspecialchars($var, ENT_QUOTES
, 'UTF-8'));
106 * Add quotes to HTML characters.
108 * Prints $var with HTML characters (like "<", ">", etc.) properly quoted.
109 * This function simply calls & displays {@link s()}.
112 * @param string $var the string potentially containing HTML characters
120 * Does proper javascript quoting.
122 * Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
124 * @param mixed $var String, Array, or Object to add slashes to
125 * @return mixed quoted result
127 function addslashes_js($var) {
128 if (is_string($var)) {
129 $var = str_replace('\\', '\\\\', $var);
130 $var = str_replace(array('\'', '"', "\n", "\r", "\0"), array('\\\'', '\\"', '\\n', '\\r', '\\0'), $var);
131 $var = str_replace('</', '<\/', $var); // XHTML compliance.
132 } else if (is_array($var)) {
133 $var = array_map('addslashes_js', $var);
134 } else if (is_object($var)) {
135 $a = get_object_vars($var);
136 foreach ($a as $key => $value) {
137 $a[$key] = addslashes_js($value);
145 * Remove query string from url.
147 * Takes in a URL and returns it without the querystring portion.
149 * @param string $url the url which may have a query string attached.
150 * @return string The remaining URL.
152 function strip_querystring($url) {
154 if ($commapos = strpos($url, '?')) {
155 return substr($url, 0, $commapos);
162 * Returns the name of the current script, WITH the querystring portion.
164 * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
165 * return different things depending on a lot of things like your OS, Web
166 * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
167 * <b>NOTE:</b> This function returns false if the global variables needed are not set.
169 * @return mixed String or false if the global variables needed are not set.
177 * Guesses the full URL of the current script.
179 * This function is using $PAGE->url, but may fall back to $FULLME which
180 * is constructed from PHP_SELF and REQUEST_URI or SCRIPT_NAME
182 * @return mixed full page URL string or false if unknown
184 function qualified_me() {
185 global $FULLME, $PAGE, $CFG;
187 if (isset($PAGE) and $PAGE->has_set_url()) {
188 // This is the only recommended way to find out current page.
189 return $PAGE->url
->out(false);
192 if ($FULLME === null) {
193 // CLI script most probably.
196 if (!empty($CFG->sslproxy
)) {
197 // Return only https links when using SSL proxy.
198 return preg_replace('/^http:/', 'https:', $FULLME, 1);
206 * Determines whether or not the Moodle site is being served over HTTPS.
208 * This is done simply by checking the value of $CFG->httpswwwroot, which seems
209 * to be the only reliable method.
211 * @return boolean True if site is served over HTTPS, false otherwise.
213 function is_https() {
216 return (strpos($CFG->httpswwwroot
, 'https://') === 0);
220 * Returns the cleaned local URL of the HTTP_REFERER less the URL query string parameters if required.
222 * @param bool $stripquery if true, also removes the query part of the url.
223 * @return string The resulting referer or empty string.
225 function get_local_referer($stripquery = true) {
226 if (isset($_SERVER['HTTP_REFERER'])) {
227 $referer = clean_param($_SERVER['HTTP_REFERER'], PARAM_LOCALURL
);
229 return strip_querystring($referer);
239 * Class for creating and manipulating urls.
241 * It can be used in moodle pages where config.php has been included without any further includes.
243 * It is useful for manipulating urls with long lists of params.
244 * One situation where it will be useful is a page which links to itself to perform various actions
245 * and / or to process form data. A moodle_url object :
246 * can be created for a page to refer to itself with all the proper get params being passed from page call to
247 * page call and methods can be used to output a url including all the params, optionally adding and overriding
248 * params and can also be used to
249 * - output the url without any get params
250 * - and output the params as hidden fields to be output within a form
252 * @copyright 2007 jamiesensei
253 * @link http://docs.moodle.org/dev/lib/weblib.php_moodle_url See short write up here
254 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
260 * Scheme, ex.: http, https
263 protected $scheme = '';
269 protected $host = '';
272 * Port number, empty means default 80 or 443 in case of http.
275 protected $port = '';
278 * Username for http auth.
281 protected $user = '';
284 * Password for http auth.
287 protected $pass = '';
293 protected $path = '';
296 * Optional slash argument value.
299 protected $slashargument = '';
302 * Anchor, may be also empty, null means none.
305 protected $anchor = null;
308 * Url parameters as associative array.
311 protected $params = array();
314 * Create new instance of moodle_url.
316 * @param moodle_url|string $url - moodle_url means make a copy of another
317 * moodle_url and change parameters, string means full url or shortened
318 * form (ex.: '/course/view.php'). It is strongly encouraged to not include
319 * query string because it may result in double encoded values. Use the
320 * $params instead. For admin URLs, just use /admin/script.php, this
321 * class takes care of the $CFG->admin issue.
322 * @param array $params these params override current params or add new
323 * @param string $anchor The anchor to use as part of the URL if there is one.
324 * @throws moodle_exception
326 public function __construct($url, array $params = null, $anchor = null) {
329 if ($url instanceof moodle_url
) {
330 $this->scheme
= $url->scheme
;
331 $this->host
= $url->host
;
332 $this->port
= $url->port
;
333 $this->user
= $url->user
;
334 $this->pass
= $url->pass
;
335 $this->path
= $url->path
;
336 $this->slashargument
= $url->slashargument
;
337 $this->params
= $url->params
;
338 $this->anchor
= $url->anchor
;
341 // Detect if anchor used.
342 $apos = strpos($url, '#');
343 if ($apos !== false) {
344 $anchor = substr($url, $apos);
345 $anchor = ltrim($anchor, '#');
346 $this->set_anchor($anchor);
347 $url = substr($url, 0, $apos);
350 // Normalise shortened form of our url ex.: '/course/view.php'.
351 if (strpos($url, '/') === 0) {
352 // We must not use httpswwwroot here, because it might be url of other page,
353 // devs have to use httpswwwroot explicitly when creating new moodle_url.
354 $url = $CFG->wwwroot
.$url;
357 // Now fix the admin links if needed, no need to mess with httpswwwroot.
358 if ($CFG->admin
!== 'admin') {
359 if (strpos($url, "$CFG->wwwroot/admin/") === 0) {
360 $url = str_replace("$CFG->wwwroot/admin/", "$CFG->wwwroot/$CFG->admin/", $url);
365 $parts = parse_url($url);
366 if ($parts === false) {
367 throw new moodle_exception('invalidurl');
369 if (isset($parts['query'])) {
370 // Note: the values may not be correctly decoded, url parameters should be always passed as array.
371 parse_str(str_replace('&', '&', $parts['query']), $this->params
);
373 unset($parts['query']);
374 foreach ($parts as $key => $value) {
375 $this->$key = $value;
378 // Detect slashargument value from path - we do not support directory names ending with .php.
379 $pos = strpos($this->path
, '.php/');
380 if ($pos !== false) {
381 $this->slashargument
= substr($this->path
, $pos +
4);
382 $this->path
= substr($this->path
, 0, $pos +
4);
386 $this->params($params);
387 if ($anchor !== null) {
388 $this->anchor
= (string)$anchor;
393 * Add an array of params to the params for this url.
395 * The added params override existing ones if they have the same name.
397 * @param array $params Defaults to null. If null then returns all params.
398 * @return array Array of Params for url.
399 * @throws coding_exception
401 public function params(array $params = null) {
402 $params = (array)$params;
404 foreach ($params as $key => $value) {
406 throw new coding_exception('Url parameters can not have numeric keys!');
408 if (!is_string($value)) {
409 if (is_array($value)) {
410 throw new coding_exception('Url parameters values can not be arrays!');
412 if (is_object($value) and !method_exists($value, '__toString')) {
413 throw new coding_exception('Url parameters values can not be objects, unless __toString() is defined!');
416 $this->params
[$key] = (string)$value;
418 return $this->params
;
422 * Remove all params if no arguments passed.
423 * Remove selected params if arguments are passed.
425 * Can be called as either remove_params('param1', 'param2')
426 * or remove_params(array('param1', 'param2')).
428 * @param string[]|string $params,... either an array of param names, or 1..n string params to remove as args.
429 * @return array url parameters
431 public function remove_params($params = null) {
432 if (!is_array($params)) {
433 $params = func_get_args();
435 foreach ($params as $param) {
436 unset($this->params
[$param]);
438 return $this->params
;
442 * Remove all url parameters.
444 * @todo remove the unused param.
445 * @param array $params Unused param
448 public function remove_all_params($params = null) {
449 $this->params
= array();
450 $this->slashargument
= '';
454 * Add a param to the params for this url.
456 * The added param overrides existing one if they have the same name.
458 * @param string $paramname name
459 * @param string $newvalue Param value. If new value specified current value is overriden or parameter is added
460 * @return mixed string parameter value, null if parameter does not exist
462 public function param($paramname, $newvalue = '') {
463 if (func_num_args() > 1) {
465 $this->params(array($paramname => $newvalue));
467 if (isset($this->params
[$paramname])) {
468 return $this->params
[$paramname];
475 * Merges parameters and validates them
477 * @param array $overrideparams
478 * @return array merged parameters
479 * @throws coding_exception
481 protected function merge_overrideparams(array $overrideparams = null) {
482 $overrideparams = (array)$overrideparams;
483 $params = $this->params
;
484 foreach ($overrideparams as $key => $value) {
486 throw new coding_exception('Overridden parameters can not have numeric keys!');
488 if (is_array($value)) {
489 throw new coding_exception('Overridden parameters values can not be arrays!');
491 if (is_object($value) and !method_exists($value, '__toString')) {
492 throw new coding_exception('Overridden parameters values can not be objects, unless __toString() is defined!');
494 $params[$key] = (string)$value;
500 * Get the params as as a query string.
502 * This method should not be used outside of this method.
504 * @param bool $escaped Use & as params separator instead of plain &
505 * @param array $overrideparams params to add to the output params, these
506 * override existing ones with the same name.
507 * @return string query string that can be added to a url.
509 public function get_query_string($escaped = true, array $overrideparams = null) {
511 if ($overrideparams !== null) {
512 $params = $this->merge_overrideparams($overrideparams);
514 $params = $this->params
;
516 foreach ($params as $key => $val) {
517 if (is_array($val)) {
518 foreach ($val as $index => $value) {
519 $arr[] = rawurlencode($key.'['.$index.']')."=".rawurlencode($value);
522 if (isset($val) && $val !== '') {
523 $arr[] = rawurlencode($key)."=".rawurlencode($val);
525 $arr[] = rawurlencode($key);
530 return implode('&', $arr);
532 return implode('&', $arr);
537 * Shortcut for printing of encoded URL.
541 public function __toString() {
542 return $this->out(true);
548 * If you use the returned URL in HTML code, you want the escaped ampersands. If you use
549 * the returned URL in HTTP headers, you want $escaped=false.
551 * @param bool $escaped Use & as params separator instead of plain &
552 * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
553 * @return string Resulting URL
555 public function out($escaped = true, array $overrideparams = null) {
556 if (!is_bool($escaped)) {
557 debugging('Escape parameter must be of type boolean, '.gettype($escaped).' given instead.');
560 $uri = $this->out_omit_querystring().$this->slashargument
;
562 $querystring = $this->get_query_string($escaped, $overrideparams);
563 if ($querystring !== '') {
564 $uri .= '?' . $querystring;
566 if (!is_null($this->anchor
)) {
567 $uri .= '#'.$this->anchor
;
574 * Returns url without parameters, everything before '?'.
576 * @param bool $includeanchor if {@link self::anchor} is defined, should it be returned?
579 public function out_omit_querystring($includeanchor = false) {
581 $uri = $this->scheme ?
$this->scheme
.':'.((strtolower($this->scheme
) == 'mailto') ?
'':'//'): '';
582 $uri .= $this->user ?
$this->user
.($this->pass?
':'.$this->pass
:'').'@':'';
583 $uri .= $this->host ?
$this->host
: '';
584 $uri .= $this->port ?
':'.$this->port
: '';
585 $uri .= $this->path ?
$this->path
: '';
586 if ($includeanchor and !is_null($this->anchor
)) {
587 $uri .= '#' . $this->anchor
;
594 * Compares this moodle_url with another.
596 * See documentation of constants for an explanation of the comparison flags.
598 * @param moodle_url $url The moodle_url object to compare
599 * @param int $matchtype The type of comparison (URL_MATCH_BASE, URL_MATCH_PARAMS, URL_MATCH_EXACT)
602 public function compare(moodle_url
$url, $matchtype = URL_MATCH_EXACT
) {
604 $baseself = $this->out_omit_querystring();
605 $baseother = $url->out_omit_querystring();
607 // Append index.php if there is no specific file.
608 if (substr($baseself, -1) == '/') {
609 $baseself .= 'index.php';
611 if (substr($baseother, -1) == '/') {
612 $baseother .= 'index.php';
615 // Compare the two base URLs.
616 if ($baseself != $baseother) {
620 if ($matchtype == URL_MATCH_BASE
) {
624 $urlparams = $url->params();
625 foreach ($this->params() as $param => $value) {
626 if ($param == 'sesskey') {
629 if (!array_key_exists($param, $urlparams) ||
$urlparams[$param] != $value) {
634 if ($matchtype == URL_MATCH_PARAMS
) {
638 foreach ($urlparams as $param => $value) {
639 if ($param == 'sesskey') {
642 if (!array_key_exists($param, $this->params()) ||
$this->param($param) != $value) {
647 if ($url->anchor
!== $this->anchor
) {
655 * Sets the anchor for the URI (the bit after the hash)
657 * @param string $anchor null means remove previous
659 public function set_anchor($anchor) {
660 if (is_null($anchor)) {
662 $this->anchor
= null;
663 } else if ($anchor === '') {
664 // Special case, used as empty link.
666 } else if (preg_match('|[a-zA-Z\_\:][a-zA-Z0-9\_\-\.\:]*|', $anchor)) {
667 // Match the anchor against the NMTOKEN spec.
668 $this->anchor
= $anchor;
670 // Bad luck, no valid anchor found.
671 $this->anchor
= null;
676 * Sets the url slashargument value.
678 * @param string $path usually file path
679 * @param string $parameter name of page parameter if slasharguments not supported
680 * @param bool $supported usually null, then it depends on $CFG->slasharguments, use true or false for other servers
683 public function set_slashargument($path, $parameter = 'file', $supported = null) {
685 if (is_null($supported)) {
686 $supported = !empty($CFG->slasharguments
);
690 $parts = explode('/', $path);
691 $parts = array_map('rawurlencode', $parts);
692 $path = implode('/', $parts);
693 $this->slashargument
= $path;
694 unset($this->params
[$parameter]);
697 $this->slashargument
= '';
698 $this->params
[$parameter] = $path;
702 // Static factory methods.
705 * General moodle file url.
707 * @param string $urlbase the script serving the file
708 * @param string $path
709 * @param bool $forcedownload
712 public static function make_file_url($urlbase, $path, $forcedownload = false) {
714 if ($forcedownload) {
715 $params['forcedownload'] = 1;
718 $url = new moodle_url($urlbase, $params);
719 $url->set_slashargument($path);
724 * Factory method for creation of url pointing to plugin file.
726 * Please note this method can be used only from the plugins to
727 * create urls of own files, it must not be used outside of plugins!
729 * @param int $contextid
730 * @param string $component
731 * @param string $area
733 * @param string $pathname
734 * @param string $filename
735 * @param bool $forcedownload
738 public static function make_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename,
739 $forcedownload = false) {
741 $urlbase = "$CFG->httpswwwroot/pluginfile.php";
742 if ($itemid === null) {
743 return self
::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
745 return self
::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
750 * Factory method for creation of url pointing to plugin file.
751 * This method is the same that make_pluginfile_url but pointing to the webservice pluginfile.php script.
752 * It should be used only in external functions.
755 * @param int $contextid
756 * @param string $component
757 * @param string $area
759 * @param string $pathname
760 * @param string $filename
761 * @param bool $forcedownload
764 public static function make_webservice_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename,
765 $forcedownload = false) {
767 $urlbase = "$CFG->httpswwwroot/webservice/pluginfile.php";
768 if ($itemid === null) {
769 return self
::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
771 return self
::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
776 * Factory method for creation of url pointing to draft file of current user.
778 * @param int $draftid draft item id
779 * @param string $pathname
780 * @param string $filename
781 * @param bool $forcedownload
784 public static function make_draftfile_url($draftid, $pathname, $filename, $forcedownload = false) {
786 $urlbase = "$CFG->httpswwwroot/draftfile.php";
787 $context = context_user
::instance($USER->id
);
789 return self
::make_file_url($urlbase, "/$context->id/user/draft/$draftid".$pathname.$filename, $forcedownload);
793 * Factory method for creating of links to legacy course files.
795 * @param int $courseid
796 * @param string $filepath
797 * @param bool $forcedownload
800 public static function make_legacyfile_url($courseid, $filepath, $forcedownload = false) {
803 $urlbase = "$CFG->wwwroot/file.php";
804 return self
::make_file_url($urlbase, '/'.$courseid.'/'.$filepath, $forcedownload);
808 * Returns URL a relative path from $CFG->wwwroot
810 * Can be used for passing around urls with the wwwroot stripped
812 * @param boolean $escaped Use & as params separator instead of plain &
813 * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
814 * @return string Resulting URL
815 * @throws coding_exception if called on a non-local url
817 public function out_as_local_url($escaped = true, array $overrideparams = null) {
820 $url = $this->out($escaped, $overrideparams);
821 $httpswwwroot = str_replace("http://", "https://", $CFG->wwwroot
);
823 // Url should be equal to wwwroot or httpswwwroot. If not then throw exception.
824 if (($url === $CFG->wwwroot
) ||
(strpos($url, $CFG->wwwroot
.'/') === 0)) {
825 $localurl = substr($url, strlen($CFG->wwwroot
));
826 return !empty($localurl) ?
$localurl : '';
827 } else if (($url === $httpswwwroot) ||
(strpos($url, $httpswwwroot.'/') === 0)) {
828 $localurl = substr($url, strlen($httpswwwroot));
829 return !empty($localurl) ?
$localurl : '';
831 throw new coding_exception('out_as_local_url called on a non-local URL');
836 * Returns the 'path' portion of a URL. For example, if the URL is
837 * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
838 * return '/my/file/is/here.txt'.
840 * By default the path includes slash-arguments (for example,
841 * '/myfile.php/extra/arguments') so it is what you would expect from a
842 * URL path. If you don't want this behaviour, you can opt to exclude the
843 * slash arguments. (Be careful: if the $CFG variable slasharguments is
844 * disabled, these URLs will have a different format and you may need to
845 * look at the 'file' parameter too.)
847 * @param bool $includeslashargument If true, includes slash arguments
848 * @return string Path of URL
850 public function get_path($includeslashargument = true) {
851 return $this->path
. ($includeslashargument ?
$this->slashargument
: '');
855 * Returns a given parameter value from the URL.
857 * @param string $name Name of parameter
858 * @return string Value of parameter or null if not set
860 public function get_param($name) {
861 if (array_key_exists($name, $this->params
)) {
862 return $this->params
[$name];
869 * Returns the 'scheme' portion of a URL. For example, if the URL is
870 * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
871 * return 'http' (without the colon).
873 * @return string Scheme of the URL.
875 public function get_scheme() {
876 return $this->scheme
;
880 * Returns the 'host' portion of a URL. For example, if the URL is
881 * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
882 * return 'www.example.org'.
884 * @return string Host of the URL.
886 public function get_host() {
891 * Returns the 'port' portion of a URL. For example, if the URL is
892 * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
895 * @return string Port of the URL.
897 public function get_port() {
903 * Determine if there is data waiting to be processed from a form
905 * Used on most forms in Moodle to check for data
906 * Returns the data as an object, if it's found.
907 * This object can be used in foreach loops without
908 * casting because it's cast to (array) automatically
910 * Checks that submitted POST data exists and returns it as object.
912 * @return mixed false or object
914 function data_submitted() {
919 return (object)fix_utf8($_POST);
924 * Given some normal text this function will break up any
925 * long words to a given size by inserting the given character
927 * It's multibyte savvy and doesn't change anything inside html tags.
929 * @param string $string the string to be modified
930 * @param int $maxsize maximum length of the string to be returned
931 * @param string $cutchar the string used to represent word breaks
934 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
936 // First of all, save all the tags inside the text to skip them.
938 filter_save_tags($string, $tags);
940 // Process the string adding the cut when necessary.
942 $length = core_text
::strlen($string);
945 for ($i=0; $i<$length; $i++
) {
946 $char = core_text
::substr($string, $i, 1);
947 if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
951 if ($wordlength > $maxsize) {
959 // Finally load the tags back again.
961 $output = str_replace(array_keys($tags), $tags, $output);
968 * Try and close the current window using JavaScript, either immediately, or after a delay.
970 * Echo's out the resulting XHTML & javascript
972 * @param integer $delay a delay in seconds before closing the window. Default 0.
973 * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
974 * to reload the parent window before this one closes.
976 function close_window($delay = 0, $reloadopener = false) {
977 global $PAGE, $OUTPUT;
979 if (!$PAGE->headerprinted
) {
980 $PAGE->set_title(get_string('closewindow'));
981 echo $OUTPUT->header();
983 $OUTPUT->container_end_all(false);
987 // Trigger the reload immediately, even if the reload is after a delay.
988 $PAGE->requires
->js_function_call('window.opener.location.reload', array(true));
990 $OUTPUT->notification(get_string('windowclosing'), 'notifysuccess');
992 $PAGE->requires
->js_function_call('close_window', array(new stdClass()), false, $delay);
994 echo $OUTPUT->footer();
999 * Returns a string containing a link to the user documentation for the current page.
1001 * Also contains an icon by default. Shown to teachers and admin only.
1003 * @param string $text The text to be displayed for the link
1004 * @return string The link to user documentation for this current page
1006 function page_doc_link($text='') {
1007 global $OUTPUT, $PAGE;
1008 $path = page_get_doc_link_path($PAGE);
1012 return $OUTPUT->doc_link($path, $text);
1016 * Returns the path to use when constructing a link to the docs.
1018 * @since Moodle 2.5.1 2.6
1019 * @param moodle_page $page
1022 function page_get_doc_link_path(moodle_page
$page) {
1025 if (empty($CFG->docroot
) ||
during_initial_install()) {
1028 if (!has_capability('moodle/site:doclinks', $page->context
)) {
1032 $path = $page->docspath
;
1041 * Validates an email to make sure it makes sense.
1043 * @param string $address The email address to validate.
1046 function validate_email($address) {
1048 return (preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
1049 '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
1051 '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
1052 '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
1057 * Extracts file argument either from file parameter or PATH_INFO
1059 * Note: $scriptname parameter is not needed anymore
1061 * @return string file path (only safe characters)
1063 function get_file_argument() {
1066 $relativepath = optional_param('file', false, PARAM_PATH
);
1068 if ($relativepath !== false and $relativepath !== '') {
1069 return $relativepath;
1071 $relativepath = false;
1073 // Then try extract file from the slasharguments.
1074 if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
1075 // NOTE: IIS tends to convert all file paths to single byte DOS encoding,
1076 // we can not use other methods because they break unicode chars,
1077 // the only ways are to use URL rewriting
1079 // to properly set the 'FastCGIUtf8ServerVariables' registry key.
1080 if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
1081 // Check that PATH_INFO works == must not contain the script name.
1082 if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
1083 $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH
);
1087 // All other apache-like servers depend on PATH_INFO.
1088 if (isset($_SERVER['PATH_INFO'])) {
1089 if (isset($_SERVER['SCRIPT_NAME']) and strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === 0) {
1090 $relativepath = substr($_SERVER['PATH_INFO'], strlen($_SERVER['SCRIPT_NAME']));
1092 $relativepath = $_SERVER['PATH_INFO'];
1094 $relativepath = clean_param($relativepath, PARAM_PATH
);
1098 return $relativepath;
1102 * Just returns an array of text formats suitable for a popup menu
1106 function format_text_menu() {
1107 return array (FORMAT_MOODLE
=> get_string('formattext'),
1108 FORMAT_HTML
=> get_string('formathtml'),
1109 FORMAT_PLAIN
=> get_string('formatplain'),
1110 FORMAT_MARKDOWN
=> get_string('formatmarkdown'));
1114 * Given text in a variety of format codings, this function returns the text as safe HTML.
1116 * This function should mainly be used for long strings like posts,
1117 * answers, glossary items etc. For short strings {@link format_string()}.
1121 * trusted : If true the string won't be cleaned. Default false required noclean=true.
1122 * noclean : If true the string won't be cleaned. Default false required trusted=true.
1123 * nocache : If true the strign will not be cached and will be formatted every call. Default false.
1124 * filter : If true the string will be run through applicable filters as well. Default true.
1125 * para : If true then the returned string will be wrapped in div tags. Default true.
1126 * newlines : If true then lines newline breaks will be converted to HTML newline breaks. Default true.
1127 * context : The context that will be used for filtering.
1128 * overflowdiv : If set to true the formatted text will be encased in a div
1129 * with the class no-overflow before being returned. Default false.
1130 * allowid : If true then id attributes will not be removed, even when
1131 * using htmlpurifier. Default false.
1134 * @staticvar array $croncache
1135 * @param string $text The text to be formatted. This is raw text originally from user input.
1136 * @param int $format Identifier of the text format to be used
1137 * [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
1138 * @param object/array $options text formatting options
1139 * @param int $courseiddonotuse deprecated course id, use context option instead
1142 function format_text($text, $format = FORMAT_MOODLE
, $options = null, $courseiddonotuse = null) {
1143 global $CFG, $DB, $PAGE;
1145 if ($text === '' ||
is_null($text)) {
1146 // No need to do any filters and cleaning.
1150 // Detach object, we can not modify it.
1151 $options = (array)$options;
1153 if (!isset($options['trusted'])) {
1154 $options['trusted'] = false;
1156 if (!isset($options['noclean'])) {
1157 if ($options['trusted'] and trusttext_active()) {
1158 // No cleaning if text trusted and noclean not specified.
1159 $options['noclean'] = true;
1161 $options['noclean'] = false;
1164 if (!isset($options['nocache'])) {
1165 $options['nocache'] = false;
1167 if (!isset($options['filter'])) {
1168 $options['filter'] = true;
1170 if (!isset($options['para'])) {
1171 $options['para'] = true;
1173 if (!isset($options['newlines'])) {
1174 $options['newlines'] = true;
1176 if (!isset($options['overflowdiv'])) {
1177 $options['overflowdiv'] = false;
1180 // Calculate best context.
1181 if (empty($CFG->version
) or $CFG->version
< 2013051400 or during_initial_install()) {
1182 // Do not filter anything during installation or before upgrade completes.
1185 } else if (isset($options['context'])) { // First by explicit passed context option.
1186 if (is_object($options['context'])) {
1187 $context = $options['context'];
1189 $context = context
::instance_by_id($options['context']);
1191 } else if ($courseiddonotuse) {
1193 $context = context_course
::instance($courseiddonotuse);
1195 // Fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(.
1196 $context = $PAGE->context
;
1200 // Either install/upgrade or something has gone really wrong because context does not exist (yet?).
1201 $options['nocache'] = true;
1202 $options['filter'] = false;
1205 if ($options['filter']) {
1206 $filtermanager = filter_manager
::instance();
1207 $filtermanager->setup_page_for_filters($PAGE, $context); // Setup global stuff filters may have.
1208 $filteroptions = array(
1209 'originalformat' => $format,
1210 'noclean' => $options['noclean'],
1213 $filtermanager = new null_filter_manager();
1214 $filteroptions = array();
1219 if (!$options['noclean']) {
1220 $text = clean_text($text, FORMAT_HTML
, $options);
1222 $text = $filtermanager->filter_text($text, $context, $filteroptions);
1226 $text = s($text); // Cleans dangerous JS.
1227 $text = rebuildnolinktag($text);
1228 $text = str_replace(' ', ' ', $text);
1229 $text = nl2br($text);
1233 // This format is deprecated.
1234 $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle. You should not be seeing
1235 this message as all texts should have been converted to Markdown format instead.
1236 Please post a bug report to http://moodle.org/bugs with information about where you
1237 saw this message.</p>'.s($text);
1240 case FORMAT_MARKDOWN
:
1241 $text = markdown_to_html($text);
1242 if (!$options['noclean']) {
1243 $text = clean_text($text, FORMAT_HTML
, $options);
1245 $text = $filtermanager->filter_text($text, $context, $filteroptions);
1248 default: // FORMAT_MOODLE or anything else.
1249 $text = text_to_html($text, null, $options['para'], $options['newlines']);
1250 if (!$options['noclean']) {
1251 $text = clean_text($text, FORMAT_HTML
, $options);
1253 $text = $filtermanager->filter_text($text, $context, $filteroptions);
1256 if ($options['filter']) {
1257 // At this point there should not be any draftfile links any more,
1258 // this happens when developers forget to post process the text.
1259 // The only potential problem is that somebody might try to format
1260 // the text before storing into database which would be itself big bug..
1261 $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
1263 if ($CFG->debugdeveloper
) {
1264 if (strpos($text, '@@PLUGINFILE@@/') !== false) {
1265 debugging('Before calling format_text(), the content must be processed with file_rewrite_pluginfile_urls()',
1271 if (!empty($options['overflowdiv'])) {
1272 $text = html_writer
::tag('div', $text, array('class' => 'no-overflow'));
1279 * Resets some data related to filters, called during upgrade or when general filter settings change.
1281 * @param bool $phpunitreset true means called from our PHPUnit integration test reset
1284 function reset_text_filters_cache($phpunitreset = false) {
1287 if ($phpunitreset) {
1288 // HTMLPurifier does not change, DB is already reset to defaults,
1289 // nothing to do here, the dataroot was cleared too.
1293 // The purge_all_caches() deals with cachedir and localcachedir purging,
1294 // the individual filter caches are invalidated as necessary elsewhere.
1296 // Update $CFG->filterall cache flag.
1297 if (empty($CFG->stringfilters
)) {
1298 set_config('filterall', 0);
1301 $installedfilters = core_component
::get_plugin_list('filter');
1302 $filters = explode(',', $CFG->stringfilters
);
1303 foreach ($filters as $filter) {
1304 if (isset($installedfilters[$filter])) {
1305 set_config('filterall', 1);
1309 set_config('filterall', 0);
1313 * Given a simple string, this function returns the string
1314 * processed by enabled string filters if $CFG->filterall is enabled
1316 * This function should be used to print short strings (non html) that
1317 * need filter processing e.g. activity titles, post subjects,
1318 * glossary concepts.
1320 * @staticvar bool $strcache
1321 * @param string $string The string to be filtered. Should be plain text, expect
1322 * possibly for multilang tags.
1323 * @param boolean $striplinks To strip any link in the result text. Moodle 1.8 default changed from false to true! MDL-8713
1324 * @param array $options options array/object or courseid
1327 function format_string($string, $striplinks = true, $options = null) {
1330 // We'll use a in-memory cache here to speed up repeated strings.
1331 static $strcache = false;
1333 if (empty($CFG->version
) or $CFG->version
< 2013051400 or during_initial_install()) {
1334 // Do not filter anything during installation or before upgrade completes.
1335 return $string = strip_tags($string);
1338 if ($strcache === false or count($strcache) > 2000) {
1339 // This number might need some tuning to limit memory usage in cron.
1340 $strcache = array();
1343 if (is_numeric($options)) {
1344 // Legacy courseid usage.
1345 $options = array('context' => context_course
::instance($options));
1347 // Detach object, we can not modify it.
1348 $options = (array)$options;
1351 if (empty($options['context'])) {
1352 // Fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(.
1353 $options['context'] = $PAGE->context
;
1354 } else if (is_numeric($options['context'])) {
1355 $options['context'] = context
::instance_by_id($options['context']);
1358 if (!$options['context']) {
1359 // We did not find any context? weird.
1360 return $string = strip_tags($string);
1364 $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id
.'<+>'.current_language());
1366 // Fetch from cache if possible.
1367 if (isset($strcache[$md5])) {
1368 return $strcache[$md5];
1371 // First replace all ampersands not followed by html entity code
1372 // Regular expression moved to its own method for easier unit testing.
1373 $string = replace_ampersands_not_followed_by_entity($string);
1375 if (!empty($CFG->filterall
)) {
1376 $filtermanager = filter_manager
::instance();
1377 $filtermanager->setup_page_for_filters($PAGE, $options['context']); // Setup global stuff filters may have.
1378 $string = $filtermanager->filter_string($string, $options['context']);
1381 // If the site requires it, strip ALL tags from this string.
1382 if (!empty($CFG->formatstringstriptags
)) {
1383 $string = str_replace(array('<', '>'), array('<', '>'), strip_tags($string));
1386 // Otherwise strip just links if that is required (default).
1388 // Strip links in string.
1389 $string = strip_links($string);
1391 $string = clean_text($string);
1395 $strcache[$md5] = $string;
1401 * Given a string, performs a negative lookahead looking for any ampersand character
1402 * that is not followed by a proper HTML entity. If any is found, it is replaced
1403 * by &. The string is then returned.
1405 * @param string $string
1408 function replace_ampersands_not_followed_by_entity($string) {
1409 return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&", $string);
1413 * Given a string, replaces all <a>.*</a> by .* and returns the string.
1415 * @param string $string
1418 function strip_links($string) {
1419 return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is', '$2', $string);
1423 * This expression turns links into something nice in a text format. (Russell Jungwirth)
1425 * @param string $string
1428 function wikify_links($string) {
1429 return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i', '$3 [ $2 ]', $string);
1433 * Given text in a variety of format codings, this function returns the text as plain text suitable for plain email.
1435 * @param string $text The text to be formatted. This is raw text originally from user input.
1436 * @param int $format Identifier of the text format to be used
1437 * [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1440 function format_text_email($text, $format) {
1449 // There should not be any of these any more!
1450 $text = wikify_links($text);
1451 return core_text
::entities_to_utf8(strip_tags($text), true);
1455 return html_to_text($text);
1459 case FORMAT_MARKDOWN
:
1461 $text = wikify_links($text);
1462 return core_text
::entities_to_utf8(strip_tags($text), true);
1468 * Formats activity intro text
1470 * @param string $module name of module
1471 * @param object $activity instance of activity
1472 * @param int $cmid course module id
1473 * @param bool $filter filter resulting html text
1476 function format_module_intro($module, $activity, $cmid, $filter=true) {
1478 require_once("$CFG->libdir/filelib.php");
1479 $context = context_module
::instance($cmid);
1480 $options = array('noclean' => true, 'para' => false, 'filter' => $filter, 'context' => $context, 'overflowdiv' => true);
1481 $intro = file_rewrite_pluginfile_urls($activity->intro
, 'pluginfile.php', $context->id
, 'mod_'.$module, 'intro', null);
1482 return trim(format_text($intro, $activity->introformat
, $options, null));
1486 * Removes the usage of Moodle files from a text.
1488 * In some rare cases we need to re-use a text that already has embedded links
1489 * to some files hosted within Moodle. But the new area in which we will push
1490 * this content does not support files... therefore we need to remove those files.
1492 * @param string $source The text
1493 * @return string The stripped text
1495 function strip_pluginfile_content($source) {
1496 $baseurl = '@@PLUGINFILE@@';
1497 // Looking for something like < .* "@@pluginfile@@.*" .* >
1498 $pattern = '$<[^<>]+["\']' . $baseurl . '[^"\']*["\'][^<>]*>$';
1499 $stripped = preg_replace($pattern, '', $source);
1500 // Use purify html to rebalence potentially mismatched tags and generally cleanup.
1501 return purify_html($stripped);
1505 * Legacy function, used for cleaning of old forum and glossary text only.
1507 * @param string $text text that may contain legacy TRUSTTEXT marker
1508 * @return string text without legacy TRUSTTEXT marker
1510 function trusttext_strip($text) {
1511 while (true) { // Removing nested TRUSTTEXT.
1513 $text = str_replace('#####TRUSTTEXT#####', '', $text);
1514 if (strcmp($orig, $text) === 0) {
1521 * Must be called before editing of all texts with trust flag. Removes all XSS nasties from texts stored in database if needed.
1523 * @param stdClass $object data object with xxx, xxxformat and xxxtrust fields
1524 * @param string $field name of text field
1525 * @param context $context active context
1526 * @return stdClass updated $object
1528 function trusttext_pre_edit($object, $field, $context) {
1529 $trustfield = $field.'trust';
1530 $formatfield = $field.'format';
1532 if (!$object->$trustfield or !trusttext_trusted($context)) {
1533 $object->$field = clean_text($object->$field, $object->$formatfield);
1540 * Is current user trusted to enter no dangerous XSS in this context?
1542 * Please note the user must be in fact trusted everywhere on this server!!
1544 * @param context $context
1545 * @return bool true if user trusted
1547 function trusttext_trusted($context) {
1548 return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1552 * Is trusttext feature active?
1556 function trusttext_active() {
1559 return !empty($CFG->enabletrusttext
);
1563 * Cleans raw text removing nasties.
1565 * Given raw text (eg typed in by a user) this function cleans it up and removes any nasty tags that could mess up
1566 * Moodle pages through XSS attacks.
1568 * The result must be used as a HTML text fragment, this function can not cleanup random
1569 * parts of html tags such as url or src attributes.
1571 * NOTE: the format parameter was deprecated because we can safely clean only HTML.
1573 * @param string $text The text to be cleaned
1574 * @param int|string $format deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
1575 * @param array $options Array of options; currently only option supported is 'allowid' (if true,
1576 * does not remove id attributes when cleaning)
1577 * @return string The cleaned up text
1579 function clean_text($text, $format = FORMAT_HTML
, $options = array()) {
1580 $text = (string)$text;
1582 if ($format != FORMAT_HTML
and $format != FORMAT_HTML
) {
1583 // TODO: we need to standardise cleanup of text when loading it into editor first.
1584 // debugging('clean_text() is designed to work only with html');.
1587 if ($format == FORMAT_PLAIN
) {
1591 if (is_purify_html_necessary($text)) {
1592 $text = purify_html($text, $options);
1595 // Originally we tried to neutralise some script events here, it was a wrong approach because
1596 // it was trivial to work around that (for example using style based XSS exploits).
1597 // We must not give false sense of security here - all developers MUST understand how to use
1598 // rawurlencode(), htmlentities(), htmlspecialchars(), p(), s(), moodle_url, html_writer and friends!!!
1604 * Is it necessary to use HTMLPurifier?
1607 * @param string $text
1608 * @return bool false means html is safe and valid, true means use HTMLPurifier
1610 function is_purify_html_necessary($text) {
1615 if ($text === (string)((int)$text)) {
1619 if (strpos($text, '&') !== false or preg_match('|<[^pesb/]|', $text)) {
1620 // We need to normalise entities or other tags except p, em, strong and br present.
1624 $altered = htmlspecialchars($text, ENT_NOQUOTES
, 'UTF-8', true);
1625 if ($altered === $text) {
1626 // No < > or other special chars means this must be safe.
1630 // Let's try to convert back some safe html tags.
1631 $altered = preg_replace('|<p>(.*?)</p>|m', '<p>$1</p>', $altered);
1632 if ($altered === $text) {
1635 $altered = preg_replace('|<em>([^<>]+?)</em>|m', '<em>$1</em>', $altered);
1636 if ($altered === $text) {
1639 $altered = preg_replace('|<strong>([^<>]+?)</strong>|m', '<strong>$1</strong>', $altered);
1640 if ($altered === $text) {
1643 $altered = str_replace('<br />', '<br />', $altered);
1644 if ($altered === $text) {
1652 * KSES replacement cleaning function - uses HTML Purifier.
1654 * @param string $text The (X)HTML string to purify
1655 * @param array $options Array of options; currently only option supported is 'allowid' (if set,
1656 * does not remove id attributes when cleaning)
1659 function purify_html($text, $options = array()) {
1662 $text = (string)$text;
1664 static $purifiers = array();
1665 static $caches = array();
1667 // Purifier code can change only during major version upgrade.
1668 $version = empty($CFG->version
) ?
0 : $CFG->version
;
1669 $cachedir = "$CFG->localcachedir/htmlpurifier/$version";
1670 if (!file_exists($cachedir)) {
1671 // Purging of caches may remove the cache dir at any time,
1672 // luckily file_exists() results should be cached for all existing directories.
1673 $purifiers = array();
1675 gc_collect_cycles();
1677 make_localcache_directory('htmlpurifier', false);
1678 check_dir_exists($cachedir);
1681 $allowid = empty($options['allowid']) ?
0 : 1;
1682 $allowobjectembed = empty($CFG->allowobjectembed
) ?
0 : 1;
1684 $type = 'type_'.$allowid.'_'.$allowobjectembed;
1686 if (!array_key_exists($type, $caches)) {
1687 $caches[$type] = cache
::make('core', 'htmlpurifier', array('type' => $type));
1689 $cache = $caches[$type];
1691 // Add revision number and all options to the text key so that it is compatible with local cluster node caches.
1692 $key = "|$version|$allowobjectembed|$allowid|$text";
1693 $filteredtext = $cache->get($key);
1695 if ($filteredtext === true) {
1696 // The filtering did not change the text last time, no need to filter anything again.
1698 } else if ($filteredtext !== false) {
1699 return $filteredtext;
1702 if (empty($purifiers[$type])) {
1703 require_once $CFG->libdir
.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1704 require_once $CFG->libdir
.'/htmlpurifier/locallib.php';
1705 $config = HTMLPurifier_Config
::createDefault();
1707 $config->set('HTML.DefinitionID', 'moodlehtml');
1708 $config->set('HTML.DefinitionRev', 3);
1709 $config->set('Cache.SerializerPath', $cachedir);
1710 $config->set('Cache.SerializerPermissions', $CFG->directorypermissions
);
1711 $config->set('Core.NormalizeNewlines', false);
1712 $config->set('Core.ConvertDocumentToFragment', true);
1713 $config->set('Core.Encoding', 'UTF-8');
1714 $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1715 $config->set('URI.AllowedSchemes', array(
1724 'teamspeak' => true,
1729 $config->set('Attr.AllowedFrameTargets', array('_blank'));
1731 if ($allowobjectembed) {
1732 $config->set('HTML.SafeObject', true);
1733 $config->set('Output.FlashCompat', true);
1734 $config->set('HTML.SafeEmbed', true);
1738 $config->set('Attr.EnableID', true);
1741 if ($def = $config->maybeGetRawHTMLDefinition()) {
1742 $def->addElement('nolink', 'Block', 'Flow', array()); // Skip our filters inside.
1743 $def->addElement('tex', 'Inline', 'Inline', array()); // Tex syntax, equivalent to $$xx$$.
1744 $def->addElement('algebra', 'Inline', 'Inline', array()); // Algebra syntax, equivalent to @@xx@@.
1745 $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // Original multilang style - only our hacked lang attribute.
1746 $def->addAttribute('span', 'xxxlang', 'CDATA'); // Current very problematic multilang.
1748 // Use the built-in Ruby module to add annotation support.
1749 $def->manager
->addModule(new HTMLPurifier_HTMLModule_Ruby());
1752 $purifier = new HTMLPurifier($config);
1753 $purifiers[$type] = $purifier;
1755 $purifier = $purifiers[$type];
1758 $multilang = (strpos($text, 'class="multilang"') !== false);
1760 $filteredtext = $text;
1762 $filteredtextregex = '/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/';
1763 $filteredtext = preg_replace($filteredtextregex, '<span xxxlang="${2}">', $filteredtext);
1765 $filteredtext = (string)$purifier->purify($filteredtext);
1767 $filteredtext = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $filteredtext);
1770 if ($text === $filteredtext) {
1771 // No need to store the filtered text, next time we will just return unfiltered text
1772 // because it was not changed by purifying.
1773 $cache->set($key, true);
1775 $cache->set($key, $filteredtext);
1778 return $filteredtext;
1782 * Given plain text, makes it into HTML as nicely as possible.
1784 * May contain HTML tags already.
1786 * Do not abuse this function. It is intended as lower level formatting feature used
1787 * by {@link format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
1788 * to call format_text() in most of cases.
1790 * @param string $text The string to convert.
1791 * @param boolean $smileyignored Was used to determine if smiley characters should convert to smiley images, ignored now
1792 * @param boolean $para If true then the returned string will be wrapped in div tags
1793 * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1796 function text_to_html($text, $smileyignored = null, $para = true, $newlines = true) {
1797 // Remove any whitespace that may be between HTML tags.
1798 $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1800 // Remove any returns that precede or follow HTML tags.
1801 $text = preg_replace("~([\n\r])<~i", " <", $text);
1802 $text = preg_replace("~>([\n\r])~i", "> ", $text);
1804 // Make returns into HTML newlines.
1806 $text = nl2br($text);
1809 // Wrap the whole thing in a div if required.
1811 // In 1.9 this was changed from a p => div.
1812 return '<div class="text_to_html">'.$text.'</div>';
1819 * Given Markdown formatted text, make it into XHTML using external function
1821 * @param string $text The markdown formatted text to be converted.
1822 * @return string Converted text
1824 function markdown_to_html($text) {
1827 if ($text === '' or $text === null) {
1831 require_once($CFG->libdir
.'/markdown/MarkdownInterface.php');
1832 require_once($CFG->libdir
.'/markdown/Markdown.php');
1833 require_once($CFG->libdir
.'/markdown/MarkdownExtra.php');
1835 return \Michelf\MarkdownExtra
::defaultTransform($text);
1839 * Given HTML text, make it into plain text using external function
1841 * @param string $html The text to be converted.
1842 * @param integer $width Width to wrap the text at. (optional, default 75 which
1843 * is a good value for email. 0 means do not limit line length.)
1844 * @param boolean $dolinks By default, any links in the HTML are collected, and
1845 * printed as a list at the end of the HTML. If you don't want that, set this
1846 * argument to false.
1847 * @return string plain text equivalent of the HTML.
1849 function html_to_text($html, $width = 75, $dolinks = true) {
1853 require_once($CFG->libdir
.'/html2text.php');
1855 $h2t = new html2text($html, false, $dolinks, $width);
1856 $result = $h2t->get_text();
1862 * This function will highlight search words in a given string
1864 * It cares about HTML and will not ruin links. It's best to use
1865 * this function after performing any conversions to HTML.
1867 * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1868 * @param string $haystack The string (HTML) within which to highlight the search terms.
1869 * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1870 * @param string $prefix the string to put before each search term found.
1871 * @param string $suffix the string to put after each search term found.
1872 * @return string The highlighted HTML.
1874 function highlight($needle, $haystack, $matchcase = false,
1875 $prefix = '<span class="highlight">', $suffix = '</span>') {
1877 // Quick bail-out in trivial cases.
1878 if (empty($needle) or empty($haystack)) {
1882 // Break up the search term into words, discard any -words and build a regexp.
1883 $words = preg_split('/ +/', trim($needle));
1884 foreach ($words as $index => $word) {
1885 if (strpos($word, '-') === 0) {
1886 unset($words[$index]);
1887 } else if (strpos($word, '+') === 0) {
1888 $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
1890 $words[$index] = preg_quote($word, '/');
1893 $regexp = '/(' . implode('|', $words) . ')/u'; // Char u is to do UTF-8 matching.
1898 // Another chance to bail-out if $search was only -words.
1899 if (empty($words)) {
1903 // Split the string into HTML tags and real content.
1904 $chunks = preg_split('/((?:<[^>]*>)+)/', $haystack, -1, PREG_SPLIT_DELIM_CAPTURE
);
1906 // We have an array of alternating blocks of text, then HTML tags, then text, ...
1907 // Loop through replacing search terms in the text, and leaving the HTML unchanged.
1908 $ishtmlchunk = false;
1910 foreach ($chunks as $chunk) {
1914 $result .= preg_replace($regexp, $prefix . '$1' . $suffix, $chunk);
1916 $ishtmlchunk = !$ishtmlchunk;
1923 * This function will highlight instances of $needle in $haystack
1925 * It's faster that the above function {@link highlight()} and doesn't care about
1928 * @param string $needle The string to search for
1929 * @param string $haystack The string to search for $needle in
1930 * @return string The highlighted HTML
1932 function highlightfast($needle, $haystack) {
1934 if (empty($needle) or empty($haystack)) {
1938 $parts = explode(core_text
::strtolower($needle), core_text
::strtolower($haystack));
1940 if (count($parts) === 1) {
1946 foreach ($parts as $key => $part) {
1947 $parts[$key] = substr($haystack, $pos, strlen($part));
1948 $pos +
= strlen($part);
1950 $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
1951 $pos +
= strlen($needle);
1954 return str_replace('<span class="highlight"></span>', '', join('', $parts));
1958 * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
1960 * Internationalisation, for print_header and backup/restorelib.
1962 * @param bool $dir Default false
1963 * @return string Attributes
1965 function get_html_lang($dir = false) {
1968 if (right_to_left()) {
1969 $direction = ' dir="rtl"';
1971 $direction = ' dir="ltr"';
1974 // Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
1975 $language = str_replace('_', '-', current_language());
1976 @header
('Content-Language: '.$language);
1977 return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
1981 // STANDARD WEB PAGE PARTS.
1984 * Send the HTTP headers that Moodle requires.
1986 * There is a backwards compatibility hack for legacy code
1987 * that needs to add custom IE compatibility directive.
1991 * if (!isset($CFG->additionalhtmlhead)) {
1992 * $CFG->additionalhtmlhead = '';
1994 * $CFG->additionalhtmlhead .= '<meta http-equiv="X-UA-Compatible" content="IE=8" />';
1995 * header('X-UA-Compatible: IE=8');
1996 * echo $OUTPUT->header();
1999 * Please note the $CFG->additionalhtmlhead alone might not work,
2000 * you should send the IE compatibility header() too.
2002 * @param string $contenttype
2003 * @param bool $cacheable Can this page be cached on back?
2004 * @return void, sends HTTP headers
2006 function send_headers($contenttype, $cacheable = true) {
2009 @header
('Content-Type: ' . $contenttype);
2010 @header
('Content-Script-Type: text/javascript');
2011 @header
('Content-Style-Type: text/css');
2013 if (empty($CFG->additionalhtmlhead
) or stripos($CFG->additionalhtmlhead
, 'X-UA-Compatible') === false) {
2014 @header
('X-UA-Compatible: IE=edge');
2018 // Allow caching on "back" (but not on normal clicks).
2019 @header
('Cache-Control: private, pre-check=0, post-check=0, max-age=0, no-transform');
2020 @header
('Pragma: no-cache');
2021 @header
('Expires: ');
2023 // Do everything we can to always prevent clients and proxies caching.
2024 @header
('Cache-Control: no-store, no-cache, must-revalidate');
2025 @header
('Cache-Control: post-check=0, pre-check=0, no-transform', false);
2026 @header
('Pragma: no-cache');
2027 @header
('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2028 @header
('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2030 @header
('Accept-Ranges: none');
2032 if (empty($CFG->allowframembedding
)) {
2033 @header
('X-Frame-Options: sameorigin');
2038 * Return the right arrow with text ('next'), and optionally embedded in a link.
2040 * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2041 * @param string $url An optional link to use in a surrounding HTML anchor.
2042 * @param bool $accesshide True if text should be hidden (for screen readers only).
2043 * @param string $addclass Additional class names for the link, or the arrow character.
2044 * @return string HTML string.
2046 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
2047 global $OUTPUT; // TODO: move to output renderer.
2048 $arrowclass = 'arrow ';
2050 $arrowclass .= $addclass;
2052 $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
2055 $htmltext = '<span class="arrow_text">'.$text.'</span> ';
2057 $htmltext = get_accesshide($htmltext);
2061 $class = 'arrow_link';
2063 $class .= ' '.$addclass;
2065 return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/', '', $text).'">'.$htmltext.$arrow.'</a>';
2067 return $htmltext.$arrow;
2071 * Return the left arrow with text ('previous'), and optionally embedded in a link.
2073 * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2074 * @param string $url An optional link to use in a surrounding HTML anchor.
2075 * @param bool $accesshide True if text should be hidden (for screen readers only).
2076 * @param string $addclass Additional class names for the link, or the arrow character.
2077 * @return string HTML string.
2079 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
2080 global $OUTPUT; // TODO: move to utput renderer.
2081 $arrowclass = 'arrow ';
2083 $arrowclass .= $addclass;
2085 $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
2088 $htmltext = ' <span class="arrow_text">'.$text.'</span>';
2090 $htmltext = get_accesshide($htmltext);
2094 $class = 'arrow_link';
2096 $class .= ' '.$addclass;
2098 return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/', '', $text).'">'.$arrow.$htmltext.'</a>';
2100 return $arrow.$htmltext;
2104 * Return a HTML element with the class "accesshide", for accessibility.
2106 * Please use cautiously - where possible, text should be visible!
2108 * @param string $text Plain text.
2109 * @param string $elem Lowercase element name, default "span".
2110 * @param string $class Additional classes for the element.
2111 * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
2112 * @return string HTML string.
2114 function get_accesshide($text, $elem='span', $class='', $attrs='') {
2115 return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
2119 * Return the breadcrumb trail navigation separator.
2121 * @return string HTML string.
2123 function get_separator() {
2124 // Accessibility: the 'hidden' slash is preferred for screen readers.
2125 return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
2129 * Print (or return) a collapsible region, that has a caption that can be clicked to expand or collapse the region.
2131 * If JavaScript is off, then the region will always be expanded.
2133 * @param string $contents the contents of the box.
2134 * @param string $classes class names added to the div that is output.
2135 * @param string $id id added to the div that is output. Must not be blank.
2136 * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2137 * @param string $userpref the name of the user preference that stores the user's preferred default state.
2138 * (May be blank if you do not wish the state to be persisted.
2139 * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2140 * @param boolean $return if true, return the HTML as a string, rather than printing it.
2141 * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
2143 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2144 $output = print_collapsible_region_start($classes, $id, $caption, $userpref, $default, true);
2145 $output .= $contents;
2146 $output .= print_collapsible_region_end(true);
2156 * Print (or return) the start of a collapsible region
2158 * The collapsibleregion has a caption that can be clicked to expand or collapse the region. If JavaScript is off, then the region
2159 * will always be expanded.
2161 * @param string $classes class names added to the div that is output.
2162 * @param string $id id added to the div that is output. Must not be blank.
2163 * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2164 * @param string $userpref the name of the user preference that stores the user's preferred default state.
2165 * (May be blank if you do not wish the state to be persisted.
2166 * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2167 * @param boolean $return if true, return the HTML as a string, rather than printing it.
2168 * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2170 function print_collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2173 // Work out the initial state.
2174 if (!empty($userpref) and is_string($userpref)) {
2175 user_preference_allow_ajax_update($userpref, PARAM_BOOL
);
2176 $collapsed = get_user_preferences($userpref, $default);
2178 $collapsed = $default;
2183 $classes .= ' collapsed';
2187 $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2188 $output .= '<div id="' . $id . '_sizer">';
2189 $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2190 $output .= $caption . ' ';
2191 $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2192 $PAGE->requires
->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2202 * Close a region started with print_collapsible_region_start.
2204 * @param boolean $return if true, return the HTML as a string, rather than printing it.
2205 * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2207 function print_collapsible_region_end($return = false) {
2208 $output = '</div></div></div>';
2218 * Print a specified group's avatar.
2220 * @param array|stdClass $group A single {@link group} object OR array of groups.
2221 * @param int $courseid The course ID.
2222 * @param boolean $large Default small picture, or large.
2223 * @param boolean $return If false print picture, otherwise return the output as string
2224 * @param boolean $link Enclose image in a link to view specified course?
2225 * @return string|void Depending on the setting of $return
2227 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2230 if (is_array($group)) {
2232 foreach ($group as $g) {
2233 $output .= print_group_picture($g, $courseid, $large, true, $link);
2243 $context = context_course
::instance($courseid);
2245 // If there is no picture, do nothing.
2246 if (!$group->picture
) {
2250 // If picture is hidden, only show to those with course:managegroups.
2251 if ($group->hidepicture
and !has_capability('moodle/course:managegroups', $context)) {
2255 if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2256 $output = '<a href="'. $CFG->wwwroot
.'/user/index.php?id='. $courseid .'&group='. $group->id
.'">';
2266 $grouppictureurl = moodle_url
::make_pluginfile_url($context->id
, 'group', 'icon', $group->id
, '/', $file);
2267 $grouppictureurl->param('rev', $group->picture
);
2268 $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2269 ' alt="'.s(get_string('group').' '.$group->name
).'" title="'.s($group->name
).'"/>';
2271 if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2284 * Display a recent activity note
2286 * @staticvar string $strftimerecent
2287 * @param int $time A timestamp int.
2288 * @param stdClass $user A user object from the database.
2289 * @param string $text Text for display for the note
2290 * @param string $link The link to wrap around the text
2291 * @param bool $return If set to true the HTML is returned rather than echo'd
2292 * @param string $viewfullnames
2293 * @return string If $retrun was true returns HTML for a recent activity notice.
2295 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2296 static $strftimerecent = null;
2299 if (is_null($viewfullnames)) {
2300 $context = context_system
::instance();
2301 $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2304 if (is_null($strftimerecent)) {
2305 $strftimerecent = get_string('strftimerecent');
2308 $output .= '<div class="head">';
2309 $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2310 $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2311 $output .= '</div>';
2312 $output .= '<div class="info"><a href="'.$link.'">'.format_string($text, true).'</a></div>';
2322 * Returns a popup menu with course activity modules
2324 * Given a course this function returns a small popup menu with all the course activity modules in it, as a navigation menu
2325 * outputs a simple list structure in XHTML.
2326 * The data is taken from the serialised array stored in the course record.
2328 * @param course $course A {@link $COURSE} object.
2329 * @param array $sections
2330 * @param course_modinfo $modinfo
2331 * @param string $strsection
2332 * @param string $strjumpto
2334 * @param string $cmid
2335 * @return string The HTML block
2337 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2339 global $CFG, $OUTPUT;
2343 $doneheading = false;
2345 $courseformatoptions = course_get_format($course)->get_format_options();
2346 $coursecontext = context_course
::instance($course->id
);
2348 $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2349 foreach ($modinfo->cms
as $mod) {
2350 if (!$mod->has_view()) {
2351 // Don't show modules which you can't link to!
2355 // For course formats using 'numsections' do not show extra sections.
2356 if (isset($courseformatoptions['numsections']) && $mod->sectionnum
> $courseformatoptions['numsections']) {
2360 if (!$mod->uservisible
) { // Do not icnlude empty sections at all.
2364 if ($mod->sectionnum
>= 0 and $section != $mod->sectionnum
) {
2365 $thissection = $sections[$mod->sectionnum
];
2367 if ($thissection->visible
or
2368 (isset($courseformatoptions['hiddensections']) and !$courseformatoptions['hiddensections']) or
2369 has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2370 $thissection->summary
= strip_tags(format_string($thissection->summary
, true));
2371 if (!$doneheading) {
2372 $menu[] = '</ul></li>';
2374 if ($course->format
== 'weeks' or empty($thissection->summary
)) {
2375 $item = $strsection ." ". $mod->sectionnum
;
2377 if (core_text
::strlen($thissection->summary
) < ($width-3)) {
2378 $item = $thissection->summary
;
2380 $item = core_text
::substr($thissection->summary
, 0, $width).'...';
2383 $menu[] = '<li class="section"><span>'.$item.'</span>';
2385 $doneheading = true;
2387 $section = $mod->sectionnum
;
2389 // No activities from this hidden section shown.
2394 $url = $mod->modname
.'/view.php?id='. $mod->id
;
2395 $mod->name
= strip_tags(format_string($mod->name
,true));
2396 if (core_text
::strlen($mod->name
) > ($width+
5)) {
2397 $mod->name
= core_text
::substr($mod->name
, 0, $width).'...';
2399 if (!$mod->visible
) {
2400 $mod->name
= '('.$mod->name
.')';
2402 $class = 'activity '.$mod->modname
;
2403 $class .= ($cmid == $mod->id
) ?
' selected' : '';
2404 $menu[] = '<li class="'.$class.'">'.
2405 '<img src="'.$OUTPUT->pix_url('icon', $mod->modname
) . '" alt="" />'.
2406 '<a href="'.$CFG->wwwroot
.'/mod/'.$url.'">'.$mod->name
.'</a></li>';
2410 $menu[] = '</ul></li>';
2412 $menu[] = '</ul></li></ul>';
2414 return implode("\n", $menu);
2418 * Prints a grade menu (as part of an existing form) with help showing all possible numerical grades and scales.
2420 * @todo Finish documenting this function
2421 * @todo Deprecate: this is only used in a few contrib modules
2423 * @param int $courseid The course ID
2424 * @param string $name
2425 * @param string $current
2426 * @param boolean $includenograde Include those with no grades
2427 * @param boolean $return If set to true returns rather than echo's
2428 * @return string|bool Depending on value of $return
2430 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2434 $strscale = get_string('scale');
2435 $strscales = get_string('scales');
2437 $scales = get_scales_menu($courseid);
2438 foreach ($scales as $i => $scalename) {
2439 $grades[-$i] = $strscale .': '. $scalename;
2441 if ($includenograde) {
2442 $grades[0] = get_string('nograde');
2444 for ($i=100; $i>=1; $i--) {
2447 $output .= html_writer
::select($grades, $name, $current, false);
2449 $helppix = $OUTPUT->pix_url('help');
2450 $linkobject = '<span class="helplink"><img class="iconhelp" alt="'.$strscales.'" src="'.$helppix.'" /></span>';
2451 $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => 1));
2452 $action = new popup_action('click', $link, 'ratingscales', array('height' => 400, 'width' => 500));
2453 $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title' => $strscales));
2463 * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2465 * Default errorcode is 1.
2467 * Very useful for perl-like error-handling:
2468 * do_somethting() or mdie("Something went wrong");
2470 * @param string $msg Error message
2471 * @param integer $errorcode Error code to emit
2473 function mdie($msg='', $errorcode=1) {
2474 trigger_error($msg);
2479 * Print a message and exit.
2481 * @param string $message The message to print in the notice
2482 * @param string $link The link to use for the continue button
2483 * @param object $course A course object. Unused.
2484 * @return void This function simply exits
2486 function notice ($message, $link='', $course=null) {
2487 global $PAGE, $OUTPUT;
2489 $message = clean_text($message); // In case nasties are in here.
2492 echo("!!$message!!\n");
2493 exit(1); // No success.
2496 if (!$PAGE->headerprinted
) {
2497 // Header not yet printed.
2498 $PAGE->set_title(get_string('notice'));
2499 echo $OUTPUT->header();
2501 echo $OUTPUT->container_end_all(false);
2504 echo $OUTPUT->box($message, 'generalbox', 'notice');
2505 echo $OUTPUT->continue_button($link);
2507 echo $OUTPUT->footer();
2508 exit(1); // General error code.
2512 * Redirects the user to another page, after printing a notice.
2514 * This function calls the OUTPUT redirect method, echo's the output and then dies to ensure nothing else happens.
2516 * <strong>Good practice:</strong> You should call this method before starting page
2517 * output by using any of the OUTPUT methods.
2519 * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2520 * @param string $message The message to display to the user
2521 * @param int $delay The delay before redirecting
2522 * @throws moodle_exception
2524 function redirect($url, $message='', $delay=-1) {
2525 global $OUTPUT, $PAGE, $CFG;
2527 if (CLI_SCRIPT
or AJAX_SCRIPT
) {
2528 // This is wrong - developers should not use redirect in these scripts but it should not be very likely.
2529 throw new moodle_exception('redirecterrordetected', 'error');
2532 // Prevent debug errors - make sure context is properly initialised.
2534 $PAGE->set_context(null);
2535 $PAGE->set_pagelayout('redirect'); // No header and footer needed.
2536 $PAGE->set_title(get_string('pageshouldredirect', 'moodle'));
2539 if ($url instanceof moodle_url
) {
2540 $url = $url->out(false);
2543 $debugdisableredirect = false;
2545 if (defined('DEBUGGING_PRINTED')) {
2546 // Some debugging already printed, no need to look more.
2547 $debugdisableredirect = true;
2551 if (core_useragent
::is_msword()) {
2552 // Clicking a URL from MS Word sends a request to the server without cookies. If that
2553 // causes a redirect Word will open a browser pointing the new URL. If not, the URL that
2554 // was clicked is opened. Because the request from Word is without cookies, it almost
2555 // always results in a redirect to the login page, even if the user is logged in in their
2556 // browser. This is not what we want, so prevent the redirect for requests from Word.
2557 $debugdisableredirect = true;
2561 if (empty($CFG->debugdisplay
) or empty($CFG->debug
)) {
2562 // No errors should be displayed.
2566 if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2570 if (!($lasterror['type'] & $CFG->debug
)) {
2571 // Last error not interesting.
2575 // Watch out here, @hidden() errors are returned from error_get_last() too.
2576 if (headers_sent()) {
2577 // We already started printing something - that means errors likely printed.
2578 $debugdisableredirect = true;
2582 if (ob_get_level() and ob_get_contents()) {
2583 // There is something waiting to be printed, hopefully it is the errors,
2584 // but it might be some error hidden by @ too - such as the timezone mess from setup.php.
2585 $debugdisableredirect = true;
2590 // Technically, HTTP/1.1 requires Location: header to contain the absolute path.
2591 // (In practice browsers accept relative paths - but still, might as well do it properly.)
2592 // This code turns relative into absolute.
2593 if (!preg_match('|^[a-z]+:|', $url)) {
2594 // Get host name http://www.wherever.com.
2595 $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot
);
2596 if (preg_match('|^/|', $url)) {
2597 // URLs beginning with / are relative to web server root so we just add them in.
2598 $url = $hostpart.$url;
2600 // URLs not beginning with / are relative to path of current script, so add that on.
2601 $url = $hostpart.preg_replace('|\?.*$|', '', me()).'/../'.$url;
2605 $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2606 if ($newurl == $url) {
2613 // Sanitise url - we can not rely on moodle_url or our URL cleaning
2614 // because they do not support all valid external URLs.
2615 $url = preg_replace('/[\x00-\x1F\x7F]/', '', $url);
2616 $url = str_replace('"', '%22', $url);
2617 $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&", $url);
2618 $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />', FORMAT_HTML
));
2619 $url = str_replace('&', '&', $encodedurl);
2621 if (!empty($message)) {
2622 if ($delay === -1 ||
!is_numeric($delay)) {
2625 $message = clean_text($message);
2627 $message = get_string('pageshouldredirect');
2631 // Make sure the session is closed properly, this prevents problems in IIS
2632 // and also some potential PHP shutdown issues.
2633 \core\session\manager
::write_close();
2635 if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2636 // 302 might not work for POST requests, 303 is ignored by obsolete clients.
2637 @header
($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2638 @header
('Location: '.$url);
2639 echo bootstrap_renderer
::plain_redirect_message($encodedurl);
2643 // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2645 $CFG->docroot
= false; // To prevent the link to moodle docs from being displayed on redirect page.
2646 echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect);
2649 echo bootstrap_renderer
::early_redirect_message($encodedurl, $message, $delay);
2655 * Given an email address, this function will return an obfuscated version of it.
2657 * @param string $email The email address to obfuscate
2658 * @return string The obfuscated email address
2660 function obfuscate_email($email) {
2662 $length = strlen($email);
2664 while ($i < $length) {
2665 if (rand(0, 2) && $email{$i}!='@') { // MDL-20619 some browsers have problems unobfuscating @.
2666 $obfuscated.='%'.dechex(ord($email{$i}));
2668 $obfuscated.=$email{$i};
2676 * This function takes some text and replaces about half of the characters
2677 * with HTML entity equivalents. Return string is obviously longer.
2679 * @param string $plaintext The text to be obfuscated
2680 * @return string The obfuscated text
2682 function obfuscate_text($plaintext) {
2684 $length = core_text
::strlen($plaintext);
2686 $prevobfuscated = false;
2687 while ($i < $length) {
2688 $char = core_text
::substr($plaintext, $i, 1);
2689 $ord = core_text
::utf8ord($char);
2690 $numerical = ($ord >= ord('0')) && ($ord <= ord('9'));
2691 if ($prevobfuscated and $numerical ) {
2692 $obfuscated.='&#'.$ord.';';
2693 } else if (rand(0, 2)) {
2694 $obfuscated.='&#'.$ord.';';
2695 $prevobfuscated = true;
2698 $prevobfuscated = false;
2706 * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2707 * to generate a fully obfuscated email link, ready to use.
2709 * @param string $email The email address to display
2710 * @param string $label The text to displayed as hyperlink to $email
2711 * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2712 * @param string $subject The subject of the email in the mailto link
2713 * @param string $body The content of the email in the mailto link
2714 * @return string The obfuscated mailto link
2716 function obfuscate_mailto($email, $label='', $dimmed=false, $subject = '', $body = '') {
2718 if (empty($label)) {
2722 $label = obfuscate_text($label);
2723 $email = obfuscate_email($email);
2724 $mailto = obfuscate_text('mailto');
2725 $url = new moodle_url("mailto:$email");
2728 if (!empty($subject)) {
2729 $url->param('subject', format_string($subject));
2731 if (!empty($body)) {
2732 $url->param('body', format_string($body));
2735 // Use the obfuscated mailto.
2736 $url = preg_replace('/^mailto/', $mailto, $url->out());
2739 $attrs['title'] = get_string('emaildisable');
2740 $attrs['class'] = 'dimmed';
2743 return html_writer
::link($url, $label, $attrs);
2747 * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2748 * will transform it to html entities
2750 * @param string $text Text to search for nolink tag in
2753 function rebuildnolinktag($text) {
2755 $text = preg_replace('/<(\/*nolink)>/i', '<$1>', $text);
2761 * Prints a maintenance message from $CFG->maintenance_message or default if empty.
2763 function print_maintenance_message() {
2764 global $CFG, $SITE, $PAGE, $OUTPUT;
2766 $PAGE->set_pagetype('maintenance-message');
2767 $PAGE->set_pagelayout('maintenance');
2768 $PAGE->set_title(strip_tags($SITE->fullname
));
2769 $PAGE->set_heading($SITE->fullname
);
2770 echo $OUTPUT->header();
2771 echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2772 if (isset($CFG->maintenance_message
) and !html_is_blank($CFG->maintenance_message
)) {
2773 echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2774 echo $CFG->maintenance_message
;
2775 echo $OUTPUT->box_end();
2777 echo $OUTPUT->footer();
2782 * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2784 * It is not recommended to use this function in Moodle 2.5 but it is left for backward
2787 * Example how to print a single line tabs:
2789 * new tabobject(...),
2790 * new tabobject(...)
2792 * echo $OUTPUT->tabtree($rows, $selectedid);
2794 * Multiple row tabs may not look good on some devices but if you want to use them
2795 * you can specify ->subtree for the active tabobject.
2797 * @param array $tabrows An array of rows where each row is an array of tab objects
2798 * @param string $selected The id of the selected tab (whatever row it's on)
2799 * @param array $inactive An array of ids of inactive tabs that are not selectable.
2800 * @param array $activated An array of ids of other tabs that are currently activated
2801 * @param bool $return If true output is returned rather then echo'd
2802 * @return string HTML output if $return was set to true.
2804 function print_tabs($tabrows, $selected = null, $inactive = null, $activated = null, $return = false) {
2807 $tabrows = array_reverse($tabrows);
2809 foreach ($tabrows as $row) {
2812 foreach ($row as $tab) {
2813 $tab->inactive
= is_array($inactive) && in_array((string)$tab->id
, $inactive);
2814 $tab->activated
= is_array($activated) && in_array((string)$tab->id
, $activated);
2815 $tab->selected
= (string)$tab->id
== $selected;
2817 if ($tab->activated ||
$tab->selected
) {
2818 $tab->subtree
= $subtree;
2824 $output = $OUTPUT->tabtree($subtree);
2829 return !empty($output);
2834 * Alter debugging level for the current request,
2835 * the change is not saved in database.
2837 * @param int $level one of the DEBUG_* constants
2838 * @param bool $debugdisplay
2840 function set_debugging($level, $debugdisplay = null) {
2843 $CFG->debug
= (int)$level;
2844 $CFG->debugdeveloper
= (($CFG->debug
& DEBUG_DEVELOPER
) === DEBUG_DEVELOPER
);
2846 if ($debugdisplay !== null) {
2847 $CFG->debugdisplay
= (bool)$debugdisplay;
2852 * Standard Debugging Function
2854 * Returns true if the current site debugging settings are equal or above specified level.
2855 * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2856 * routing of notices is controlled by $CFG->debugdisplay
2859 * 1) debugging('a normal debug notice');
2860 * 2) debugging('something really picky', DEBUG_ALL);
2861 * 3) debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
2862 * 4) if (debugging()) { perform extra debugging operations (do not use print or echo) }
2864 * In code blocks controlled by debugging() (such as example 4)
2865 * any output should be routed via debugging() itself, or the lower-level
2866 * trigger_error() or error_log(). Using echo or print will break XHTML
2867 * JS and HTTP headers.
2869 * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2871 * @param string $message a message to print
2872 * @param int $level the level at which this debugging statement should show
2873 * @param array $backtrace use different backtrace
2876 function debugging($message = '', $level = DEBUG_NORMAL
, $backtrace = null) {
2879 $forcedebug = false;
2880 if (!empty($CFG->debugusers
) && $USER) {
2881 $debugusers = explode(',', $CFG->debugusers
);
2882 $forcedebug = in_array($USER->id
, $debugusers);
2885 if (!$forcedebug and (empty($CFG->debug
) ||
($CFG->debug
!= -1 and $CFG->debug
< $level))) {
2889 if (!isset($CFG->debugdisplay
)) {
2890 $CFG->debugdisplay
= ini_get_bool('display_errors');
2895 $backtrace = debug_backtrace();
2897 $from = format_backtrace($backtrace, CLI_SCRIPT || NO_DEBUG_DISPLAY
);
2899 if (phpunit_util
::debugging_triggered($message, $level, $from)) {
2900 // We are inside test, the debug message was logged.
2905 if (NO_DEBUG_DISPLAY
) {
2906 // Script does not want any errors or debugging in output,
2907 // we send the info to error log instead.
2908 error_log('Debugging: ' . $message . ' in '. PHP_EOL
. $from);
2910 } else if ($forcedebug or $CFG->debugdisplay
) {
2911 if (!defined('DEBUGGING_PRINTED')) {
2912 define('DEBUGGING_PRINTED', 1); // Indicates we have printed something.
2915 echo "++ $message ++\n$from";
2917 echo '<div class="notifytiny debuggingmessage" data-rel="debugging">' , $message , $from , '</div>';
2921 trigger_error($message . $from, E_USER_NOTICE
);
2928 * Outputs a HTML comment to the browser.
2930 * This is used for those hard-to-debug pages that use bits from many different files in very confusing ways (e.g. blocks).
2932 * <code>print_location_comment(__FILE__, __LINE__);</code>
2934 * @param string $file
2935 * @param integer $line
2936 * @param boolean $return Whether to return or print the comment
2937 * @return string|void Void unless true given as third parameter
2939 function print_location_comment($file, $line, $return = false) {
2941 return "<!-- $file at line $line -->\n";
2943 echo "<!-- $file at line $line -->\n";
2949 * Returns true if the user is using a right-to-left language.
2951 * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
2953 function right_to_left() {
2954 return (get_string('thisdirection', 'langconfig') === 'rtl');
2959 * Returns swapped left<=> right if in RTL environment.
2961 * Part of RTL Moodles support.
2963 * @param string $align align to check
2966 function fix_align_rtl($align) {
2967 if (!right_to_left()) {
2970 if ($align == 'left') {
2973 if ($align == 'right') {
2981 * Returns true if the page is displayed in a popup window.
2983 * Gets the information from the URL parameter inpopup.
2985 * @todo Use a central function to create the popup calls all over Moodle and
2986 * In the moment only works with resources and probably questions.
2990 function is_in_popup() {
2991 $inpopup = optional_param('inpopup', '', PARAM_BOOL
);
2997 * Progress bar class.
2999 * Manages the display of a progress bar.
3001 * To use this class.
3003 * - call create (or use the 3rd param to the constructor)
3004 * - call update or update_full() or update() repeatedly
3006 * @copyright 2008 jamiesensei
3007 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3010 class progress_bar
{
3011 /** @var string html id */
3013 /** @var int total width */
3015 /** @var int last percentage printed */
3016 private $percent = 0;
3017 /** @var int time when last printed */
3018 private $lastupdate = 0;
3019 /** @var int when did we start printing this */
3020 private $time_start = 0;
3025 * Prints JS code if $autostart true.
3027 * @param string $html_id
3029 * @param bool $autostart Default to false
3031 public function __construct($htmlid = '', $width = 500, $autostart = false) {
3032 if (!empty($htmlid)) {
3033 $this->html_id
= $htmlid;
3035 $this->html_id
= 'pbar_'.uniqid();
3038 $this->width
= $width;
3046 * Create a new progress bar, this function will output html.
3048 * @return void Echo's output
3050 public function create() {
3053 $this->time_start
= microtime(true);
3055 return; // Temporary solution for cli scripts.
3058 $PAGE->requires
->string_for_js('secondsleft', 'moodle');
3061 <div class="progressbar_container" style="width: {$this->width}px;" id="{$this->html_id}">
3063 <div class="progress progress-striped active">
3064 <div class="bar" role="progressbar" aria-valuemin="0" aria-valuemax="100" aria-valuenow="0"> </div>
3075 * Update the progress bar
3077 * @param int $percent from 1-100
3078 * @param string $msg
3079 * @return void Echo's output
3080 * @throws coding_exception
3082 private function _update($percent, $msg) {
3083 if (empty($this->time_start
)) {
3084 throw new coding_exception('You must call create() (or use the $autostart ' .
3085 'argument to the constructor) before you try updating the progress bar.');
3089 return; // Temporary solution for cli scripts.
3092 $estimate = $this->estimate($percent);
3094 if ($estimate === null) {
3095 // Always do the first and last updates.
3096 } else if ($estimate == 0) {
3097 // Always do the last updates.
3098 } else if ($this->lastupdate +
20 < time()) {
3099 // We must update otherwise browser would time out.
3100 } else if (round($this->percent
, 2) === round($percent, 2)) {
3101 // No significant change, no need to update anything.
3104 if (is_numeric($estimate)) {
3105 $estimate = get_string('secondsleft', 'moodle', round($estimate, 2));
3108 $this->percent
= round($percent, 2);
3109 $this->lastupdate
= microtime(true);
3111 echo html_writer
::script(js_writer
::function_call('updateProgressBar',
3112 array($this->html_id
, $this->percent
, $msg, $estimate)));
3117 * Estimate how much time it is going to take.
3119 * @param int $pt from 1-100
3120 * @return mixed Null (unknown), or int
3122 private function estimate($pt) {
3123 if ($this->lastupdate
== 0) {
3126 if ($pt < 0.00001) {
3127 return null; // We do not know yet how long it will take.
3129 if ($pt > 99.99999) {
3130 return 0; // Nearly done, right?
3132 $consumed = microtime(true) - $this->time_start
;
3133 if ($consumed < 0.001) {
3137 return (100 - $pt) * ($consumed / $pt);
3141 * Update progress bar according percent
3143 * @param int $percent from 1-100
3144 * @param string $msg the message needed to be shown
3146 public function update_full($percent, $msg) {
3147 $percent = max(min($percent, 100), 0);
3148 $this->_update($percent, $msg);
3152 * Update progress bar according the number of tasks
3154 * @param int $cur current task number
3155 * @param int $total total task number
3156 * @param string $msg message
3158 public function update($cur, $total, $msg) {
3159 $percent = ($cur / $total) * 100;
3160 $this->update_full($percent, $msg);
3164 * Restart the progress bar.
3166 public function restart() {
3168 $this->lastupdate
= 0;
3169 $this->time_start
= 0;
3174 * Progress trace class.
3176 * Use this class from long operations where you want to output occasional information about
3177 * what is going on, but don't know if, or in what format, the output should be.
3179 * @copyright 2009 Tim Hunt
3180 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3183 abstract class progress_trace
{
3185 * Output an progress message in whatever format.
3187 * @param string $message the message to output.
3188 * @param integer $depth indent depth for this message.
3190 abstract public function output($message, $depth = 0);
3193 * Called when the processing is finished.
3195 public function finished() {
3200 * This subclass of progress_trace does not ouput anything.
3202 * @copyright 2009 Tim Hunt
3203 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3206 class null_progress_trace
extends progress_trace
{
3210 * @param string $message
3212 * @return void Does Nothing
3214 public function output($message, $depth = 0) {
3219 * This subclass of progress_trace outputs to plain text.
3221 * @copyright 2009 Tim Hunt
3222 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3225 class text_progress_trace
extends progress_trace
{
3227 * Output the trace message.
3229 * @param string $message
3231 * @return void Output is echo'd
3233 public function output($message, $depth = 0) {
3234 echo str_repeat(' ', $depth), $message, "\n";
3240 * This subclass of progress_trace outputs as HTML.
3242 * @copyright 2009 Tim Hunt
3243 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3246 class html_progress_trace
extends progress_trace
{
3248 * Output the trace message.
3250 * @param string $message
3252 * @return void Output is echo'd
3254 public function output($message, $depth = 0) {
3255 echo '<p>', str_repeat('  ', $depth), htmlspecialchars($message), "</p>\n";
3261 * HTML List Progress Tree
3263 * @copyright 2009 Tim Hunt
3264 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3267 class html_list_progress_trace
extends progress_trace
{
3269 protected $currentdepth = -1;
3274 * @param string $message The message to display
3276 * @return void Output is echoed
3278 public function output($message, $depth = 0) {
3280 while ($this->currentdepth
> $depth) {
3281 echo "</li>\n</ul>\n";
3282 $this->currentdepth
-= 1;
3283 if ($this->currentdepth
== $depth) {
3288 while ($this->currentdepth
< $depth) {
3290 $this->currentdepth +
= 1;
3296 echo htmlspecialchars($message);
3301 * Called when the processing is finished.
3303 public function finished() {
3304 while ($this->currentdepth
>= 0) {
3305 echo "</li>\n</ul>\n";
3306 $this->currentdepth
-= 1;
3312 * This subclass of progress_trace outputs to error log.
3314 * @copyright Petr Skoda {@link http://skodak.org}
3315 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3318 class error_log_progress_trace
extends progress_trace
{
3319 /** @var string log prefix */
3324 * @param string $prefix optional log prefix
3326 public function __construct($prefix = '') {
3327 $this->prefix
= $prefix;
3331 * Output the trace message.
3333 * @param string $message
3335 * @return void Output is sent to error log.
3337 public function output($message, $depth = 0) {
3338 error_log($this->prefix
. str_repeat(' ', $depth) . $message);
3343 * Special type of trace that can be used for catching of output of other traces.
3345 * @copyright Petr Skoda {@link http://skodak.org}
3346 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3349 class progress_trace_buffer
extends progress_trace
{
3350 /** @var progres_trace */
3352 /** @var bool do we pass output out */
3353 protected $passthrough;
3354 /** @var string output buffer */
3360 * @param progress_trace $trace
3361 * @param bool $passthrough true means output and buffer, false means just buffer and no output
3363 public function __construct(progress_trace
$trace, $passthrough = true) {
3364 $this->trace
= $trace;
3365 $this->passthrough
= $passthrough;
3370 * Output the trace message.
3372 * @param string $message the message to output.
3373 * @param int $depth indent depth for this message.
3374 * @return void output stored in buffer
3376 public function output($message, $depth = 0) {
3378 $this->trace
->output($message, $depth);
3379 $this->buffer
.= ob_get_contents();
3380 if ($this->passthrough
) {
3388 * Called when the processing is finished.
3390 public function finished() {
3392 $this->trace
->finished();
3393 $this->buffer
.= ob_get_contents();
3394 if ($this->passthrough
) {
3402 * Reset internal text buffer.
3404 public function reset_buffer() {
3409 * Return internal text buffer.
3410 * @return string buffered plain text
3412 public function get_buffer() {
3413 return $this->buffer
;
3418 * Special type of trace that can be used for redirecting to multiple other traces.
3420 * @copyright Petr Skoda {@link http://skodak.org}
3421 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3424 class combined_progress_trace
extends progress_trace
{
3427 * An array of traces.
3433 * Constructs a new instance.
3435 * @param array $traces multiple traces
3437 public function __construct(array $traces) {
3438 $this->traces
= $traces;
3442 * Output an progress message in whatever format.
3444 * @param string $message the message to output.
3445 * @param integer $depth indent depth for this message.
3447 public function output($message, $depth = 0) {
3448 foreach ($this->traces
as $trace) {
3449 $trace->output($message, $depth);
3454 * Called when the processing is finished.
3456 public function finished() {
3457 foreach ($this->traces
as $trace) {
3464 * Returns a localized sentence in the current language summarizing the current password policy
3466 * @todo this should be handled by a function/method in the language pack library once we have a support for it
3470 function print_password_policy() {
3474 if (!empty($CFG->passwordpolicy
)) {
3475 $messages = array();
3476 $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength
);
3477 if (!empty($CFG->minpassworddigits
)) {
3478 $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits
);
3480 if (!empty($CFG->minpasswordlower
)) {
3481 $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower
);
3483 if (!empty($CFG->minpasswordupper
)) {
3484 $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper
);
3486 if (!empty($CFG->minpasswordnonalphanum
)) {
3487 $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum
);
3490 $messages = join(', ', $messages); // This is ugly but we do not have anything better yet...
3491 $message = get_string('informpasswordpolicy', 'auth', $messages);
3497 * Get the value of a help string fully prepared for display in the current language.
3499 * @param string $identifier The identifier of the string to search for.
3500 * @param string $component The module the string is associated with.
3501 * @param boolean $ajax Whether this help is called from an AJAX script.
3502 * This is used to influence text formatting and determines
3503 * which format to output the doclink in.
3504 * @param string|object|array $a An object, string or number that can be used
3505 * within translation strings
3506 * @return Object An object containing:
3507 * - heading: Any heading that there may be for this help string.
3508 * - text: The wiki-formatted help string.
3509 * - doclink: An object containing a link, the linktext, and any additional
3510 * CSS classes to apply to that link. Only present if $ajax = false.
3511 * - completedoclink: A text representation of the doclink. Only present if $ajax = true.
3513 function get_formatted_help_string($identifier, $component, $ajax = false, $a = null) {
3514 global $CFG, $OUTPUT;
3515 $sm = get_string_manager();
3517 // Do not rebuild caches here!
3518 // Devs need to learn to purge all caches after any change or disable $CFG->langstringcache.
3520 $data = new stdClass();
3522 if ($sm->string_exists($identifier, $component)) {
3523 $data->heading
= format_string(get_string($identifier, $component));
3525 // Gracefully fall back to an empty string.
3526 $data->heading
= '';
3529 if ($sm->string_exists($identifier . '_help', $component)) {
3530 $options = new stdClass();
3531 $options->trusted
= false;
3532 $options->noclean
= false;
3533 $options->smiley
= false;
3534 $options->filter
= false;
3535 $options->para
= true;
3536 $options->newlines
= false;
3537 $options->overflowdiv
= !$ajax;
3539 // Should be simple wiki only MDL-21695.
3540 $data->text
= format_text(get_string($identifier.'_help', $component, $a), FORMAT_MARKDOWN
, $options);
3542 $helplink = $identifier . '_link';
3543 if ($sm->string_exists($helplink, $component)) { // Link to further info in Moodle docs.
3544 $link = get_string($helplink, $component);
3545 $linktext = get_string('morehelp');
3547 $data->doclink
= new stdClass();
3548 $url = new moodle_url(get_docs_url($link));
3550 $data->doclink
->link
= $url->out();
3551 $data->doclink
->linktext
= $linktext;
3552 $data->doclink
->class = ($CFG->doctonewwindow
) ?
'helplinkpopup' : '';
3554 $data->completedoclink
= html_writer
::tag('div', $OUTPUT->doc_link($link, $linktext),
3555 array('class' => 'helpdoclink'));
3559 $data->text
= html_writer
::tag('p',
3560 html_writer
::tag('strong', 'TODO') . ": missing help string [{$identifier}_help, {$component}]");