147816f6f6f692f4fc9dee762aefbdb18a61f091
[moodle.git] / lib / weblib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
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/>.
17 /**
18  * Library of functions for web output
19  *
20  * Library of all general-purpose Moodle PHP functions and constants
21  * that produce HTML output
22  *
23  * Other main libraries:
24  * - datalib.php - functions that access the database.
25  * - moodlelib.php - general-purpose Moodle functions.
26  *
27  * @package    core
28  * @subpackage lib
29  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
30  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
31  */
33 defined('MOODLE_INTERNAL') || die();
35 // Constants.
37 // Define text formatting types ... eventually we can add Wiki, BBcode etc.
39 /**
40  * Does all sorts of transformations and filtering.
41  */
42 define('FORMAT_MOODLE',   '0');
44 /**
45  * Plain HTML (with some tags stripped).
46  */
47 define('FORMAT_HTML',     '1');
49 /**
50  * Plain text (even tags are printed in full).
51  */
52 define('FORMAT_PLAIN',    '2');
54 /**
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!
59  */
60 define('FORMAT_WIKI',     '3');
62 /**
63  * Markdown-formatted text http://daringfireball.net/projects/markdown/
64  */
65 define('FORMAT_MARKDOWN', '4');
67 /**
68  * A moodle_url comparison using this flag will return true if the base URLs match, params are ignored.
69  */
70 define('URL_MATCH_BASE', 0);
72 /**
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.
74  */
75 define('URL_MATCH_PARAMS', 1);
77 /**
78  * A moodle_url comparison using this flag will return true if the two URLs are identical, except for the order of the params.
79  */
80 define('URL_MATCH_EXACT', 2);
82 // Functions.
84 /**
85  * Add quotes to HTML characters.
86  *
87  * Returns $var with HTML characters (like "<", ">", etc.) properly quoted.
88  * Related function {@link p()} simply prints the output of this function.
89  *
90  * @param string $var the string potentially containing HTML characters
91  * @return string
92  */
93 function s($var) {
95     if ($var === false) {
96         return '0';
97     }
99     return preg_replace('/&amp;#(\d+|x[0-9a-f]+);/i', '&#$1;',
100             htmlspecialchars($var, ENT_QUOTES | ENT_HTML401 | ENT_SUBSTITUTE));
103 /**
104  * Add quotes to HTML characters.
105  *
106  * Prints $var with HTML characters (like "<", ">", etc.) properly quoted.
107  * This function simply calls & displays {@link s()}.
108  * @see s()
109  *
110  * @param string $var the string potentially containing HTML characters
111  * @return string
112  */
113 function p($var) {
114     echo s($var);
117 /**
118  * Does proper javascript quoting.
119  *
120  * Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
121  *
122  * @param mixed $var String, Array, or Object to add slashes to
123  * @return mixed quoted result
124  */
125 function addslashes_js($var) {
126     if (is_string($var)) {
127         $var = str_replace('\\', '\\\\', $var);
128         $var = str_replace(array('\'', '"', "\n", "\r", "\0"), array('\\\'', '\\"', '\\n', '\\r', '\\0'), $var);
129         $var = str_replace('</', '<\/', $var);   // XHTML compliance.
130     } else if (is_array($var)) {
131         $var = array_map('addslashes_js', $var);
132     } else if (is_object($var)) {
133         $a = get_object_vars($var);
134         foreach ($a as $key => $value) {
135             $a[$key] = addslashes_js($value);
136         }
137         $var = (object)$a;
138     }
139     return $var;
142 /**
143  * Remove query string from url.
144  *
145  * Takes in a URL and returns it without the querystring portion.
146  *
147  * @param string $url the url which may have a query string attached.
148  * @return string The remaining URL.
149  */
150 function strip_querystring($url) {
152     if ($commapos = strpos($url, '?')) {
153         return substr($url, 0, $commapos);
154     } else {
155         return $url;
156     }
159 /**
160  * Returns the name of the current script, WITH the querystring portion.
161  *
162  * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
163  * return different things depending on a lot of things like your OS, Web
164  * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
165  * <b>NOTE:</b> This function returns false if the global variables needed are not set.
166  *
167  * @return mixed String or false if the global variables needed are not set.
168  */
169 function me() {
170     global $ME;
171     return $ME;
174 /**
175  * Guesses the full URL of the current script.
176  *
177  * This function is using $PAGE->url, but may fall back to $FULLME which
178  * is constructed from  PHP_SELF and REQUEST_URI or SCRIPT_NAME
179  *
180  * @return mixed full page URL string or false if unknown
181  */
182 function qualified_me() {
183     global $FULLME, $PAGE, $CFG;
185     if (isset($PAGE) and $PAGE->has_set_url()) {
186         // This is the only recommended way to find out current page.
187         return $PAGE->url->out(false);
189     } else {
190         if ($FULLME === null) {
191             // CLI script most probably.
192             return false;
193         }
194         if (!empty($CFG->sslproxy)) {
195             // Return only https links when using SSL proxy.
196             return preg_replace('/^http:/', 'https:', $FULLME, 1);
197         } else {
198             return $FULLME;
199         }
200     }
203 /**
204  * Determines whether or not the Moodle site is being served over HTTPS.
205  *
206  * This is done simply by checking the value of $CFG->httpswwwroot, which seems
207  * to be the only reliable method.
208  *
209  * @return boolean True if site is served over HTTPS, false otherwise.
210  */
211 function is_https() {
212     global $CFG;
214     return (strpos($CFG->httpswwwroot, 'https://') === 0);
217 /**
218  * Returns the cleaned local URL of the HTTP_REFERER less the URL query string parameters if required.
219  *
220  * @param bool $stripquery if true, also removes the query part of the url.
221  * @return string The resulting referer or empty string.
222  */
223 function get_local_referer($stripquery = true) {
224     if (isset($_SERVER['HTTP_REFERER'])) {
225         $referer = clean_param($_SERVER['HTTP_REFERER'], PARAM_LOCALURL);
226         if ($stripquery) {
227             return strip_querystring($referer);
228         } else {
229             return $referer;
230         }
231     } else {
232         return '';
233     }
236 /**
237  * Class for creating and manipulating urls.
238  *
239  * It can be used in moodle pages where config.php has been included without any further includes.
240  *
241  * It is useful for manipulating urls with long lists of params.
242  * One situation where it will be useful is a page which links to itself to perform various actions
243  * and / or to process form data. A moodle_url object :
244  * can be created for a page to refer to itself with all the proper get params being passed from page call to
245  * page call and methods can be used to output a url including all the params, optionally adding and overriding
246  * params and can also be used to
247  *     - output the url without any get params
248  *     - and output the params as hidden fields to be output within a form
249  *
250  * @copyright 2007 jamiesensei
251  * @link http://docs.moodle.org/dev/lib/weblib.php_moodle_url See short write up here
252  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
253  * @package core
254  */
255 class moodle_url {
257     /**
258      * Scheme, ex.: http, https
259      * @var string
260      */
261     protected $scheme = '';
263     /**
264      * Hostname.
265      * @var string
266      */
267     protected $host = '';
269     /**
270      * Port number, empty means default 80 or 443 in case of http.
271      * @var int
272      */
273     protected $port = '';
275     /**
276      * Username for http auth.
277      * @var string
278      */
279     protected $user = '';
281     /**
282      * Password for http auth.
283      * @var string
284      */
285     protected $pass = '';
287     /**
288      * Script path.
289      * @var string
290      */
291     protected $path = '';
293     /**
294      * Optional slash argument value.
295      * @var string
296      */
297     protected $slashargument = '';
299     /**
300      * Anchor, may be also empty, null means none.
301      * @var string
302      */
303     protected $anchor = null;
305     /**
306      * Url parameters as associative array.
307      * @var array
308      */
309     protected $params = array();
311     /**
312      * Create new instance of moodle_url.
313      *
314      * @param moodle_url|string $url - moodle_url means make a copy of another
315      *      moodle_url and change parameters, string means full url or shortened
316      *      form (ex.: '/course/view.php'). It is strongly encouraged to not include
317      *      query string because it may result in double encoded values. Use the
318      *      $params instead. For admin URLs, just use /admin/script.php, this
319      *      class takes care of the $CFG->admin issue.
320      * @param array $params these params override current params or add new
321      * @param string $anchor The anchor to use as part of the URL if there is one.
322      * @throws moodle_exception
323      */
324     public function __construct($url, array $params = null, $anchor = null) {
325         global $CFG;
327         if ($url instanceof moodle_url) {
328             $this->scheme = $url->scheme;
329             $this->host = $url->host;
330             $this->port = $url->port;
331             $this->user = $url->user;
332             $this->pass = $url->pass;
333             $this->path = $url->path;
334             $this->slashargument = $url->slashargument;
335             $this->params = $url->params;
336             $this->anchor = $url->anchor;
338         } else {
339             // Detect if anchor used.
340             $apos = strpos($url, '#');
341             if ($apos !== false) {
342                 $anchor = substr($url, $apos);
343                 $anchor = ltrim($anchor, '#');
344                 $this->set_anchor($anchor);
345                 $url = substr($url, 0, $apos);
346             }
348             // Normalise shortened form of our url ex.: '/course/view.php'.
349             if (strpos($url, '/') === 0) {
350                 // We must not use httpswwwroot here, because it might be url of other page,
351                 // devs have to use httpswwwroot explicitly when creating new moodle_url.
352                 $url = $CFG->wwwroot.$url;
353             }
355             // Now fix the admin links if needed, no need to mess with httpswwwroot.
356             if ($CFG->admin !== 'admin') {
357                 if (strpos($url, "$CFG->wwwroot/admin/") === 0) {
358                     $url = str_replace("$CFG->wwwroot/admin/", "$CFG->wwwroot/$CFG->admin/", $url);
359                 }
360             }
362             // Parse the $url.
363             $parts = parse_url($url);
364             if ($parts === false) {
365                 throw new moodle_exception('invalidurl');
366             }
367             if (isset($parts['query'])) {
368                 // Note: the values may not be correctly decoded, url parameters should be always passed as array.
369                 parse_str(str_replace('&amp;', '&', $parts['query']), $this->params);
370             }
371             unset($parts['query']);
372             foreach ($parts as $key => $value) {
373                 $this->$key = $value;
374             }
376             // Detect slashargument value from path - we do not support directory names ending with .php.
377             $pos = strpos($this->path, '.php/');
378             if ($pos !== false) {
379                 $this->slashargument = substr($this->path, $pos + 4);
380                 $this->path = substr($this->path, 0, $pos + 4);
381             }
382         }
384         $this->params($params);
385         if ($anchor !== null) {
386             $this->anchor = (string)$anchor;
387         }
388     }
390     /**
391      * Add an array of params to the params for this url.
392      *
393      * The added params override existing ones if they have the same name.
394      *
395      * @param array $params Defaults to null. If null then returns all params.
396      * @return array Array of Params for url.
397      * @throws coding_exception
398      */
399     public function params(array $params = null) {
400         $params = (array)$params;
402         foreach ($params as $key => $value) {
403             if (is_int($key)) {
404                 throw new coding_exception('Url parameters can not have numeric keys!');
405             }
406             if (!is_string($value)) {
407                 if (is_array($value)) {
408                     throw new coding_exception('Url parameters values can not be arrays!');
409                 }
410                 if (is_object($value) and !method_exists($value, '__toString')) {
411                     throw new coding_exception('Url parameters values can not be objects, unless __toString() is defined!');
412                 }
413             }
414             $this->params[$key] = (string)$value;
415         }
416         return $this->params;
417     }
419     /**
420      * Remove all params if no arguments passed.
421      * Remove selected params if arguments are passed.
422      *
423      * Can be called as either remove_params('param1', 'param2')
424      * or remove_params(array('param1', 'param2')).
425      *
426      * @param string[]|string $params,... either an array of param names, or 1..n string params to remove as args.
427      * @return array url parameters
428      */
429     public function remove_params($params = null) {
430         if (!is_array($params)) {
431             $params = func_get_args();
432         }
433         foreach ($params as $param) {
434             unset($this->params[$param]);
435         }
436         return $this->params;
437     }
439     /**
440      * Remove all url parameters.
441      *
442      * @todo remove the unused param.
443      * @param array $params Unused param
444      * @return void
445      */
446     public function remove_all_params($params = null) {
447         $this->params = array();
448         $this->slashargument = '';
449     }
451     /**
452      * Add a param to the params for this url.
453      *
454      * The added param overrides existing one if they have the same name.
455      *
456      * @param string $paramname name
457      * @param string $newvalue Param value. If new value specified current value is overriden or parameter is added
458      * @return mixed string parameter value, null if parameter does not exist
459      */
460     public function param($paramname, $newvalue = '') {
461         if (func_num_args() > 1) {
462             // Set new value.
463             $this->params(array($paramname => $newvalue));
464         }
465         if (isset($this->params[$paramname])) {
466             return $this->params[$paramname];
467         } else {
468             return null;
469         }
470     }
472     /**
473      * Merges parameters and validates them
474      *
475      * @param array $overrideparams
476      * @return array merged parameters
477      * @throws coding_exception
478      */
479     protected function merge_overrideparams(array $overrideparams = null) {
480         $overrideparams = (array)$overrideparams;
481         $params = $this->params;
482         foreach ($overrideparams as $key => $value) {
483             if (is_int($key)) {
484                 throw new coding_exception('Overridden parameters can not have numeric keys!');
485             }
486             if (is_array($value)) {
487                 throw new coding_exception('Overridden parameters values can not be arrays!');
488             }
489             if (is_object($value) and !method_exists($value, '__toString')) {
490                 throw new coding_exception('Overridden parameters values can not be objects, unless __toString() is defined!');
491             }
492             $params[$key] = (string)$value;
493         }
494         return $params;
495     }
497     /**
498      * Get the params as as a query string.
499      *
500      * This method should not be used outside of this method.
501      *
502      * @param bool $escaped Use &amp; as params separator instead of plain &
503      * @param array $overrideparams params to add to the output params, these
504      *      override existing ones with the same name.
505      * @return string query string that can be added to a url.
506      */
507     public function get_query_string($escaped = true, array $overrideparams = null) {
508         $arr = array();
509         if ($overrideparams !== null) {
510             $params = $this->merge_overrideparams($overrideparams);
511         } else {
512             $params = $this->params;
513         }
514         foreach ($params as $key => $val) {
515             if (is_array($val)) {
516                 foreach ($val as $index => $value) {
517                     $arr[] = rawurlencode($key.'['.$index.']')."=".rawurlencode($value);
518                 }
519             } else {
520                 if (isset($val) && $val !== '') {
521                     $arr[] = rawurlencode($key)."=".rawurlencode($val);
522                 } else {
523                     $arr[] = rawurlencode($key);
524                 }
525             }
526         }
527         if ($escaped) {
528             return implode('&amp;', $arr);
529         } else {
530             return implode('&', $arr);
531         }
532     }
534     /**
535      * Shortcut for printing of encoded URL.
536      *
537      * @return string
538      */
539     public function __toString() {
540         return $this->out(true);
541     }
543     /**
544      * Output url.
545      *
546      * If you use the returned URL in HTML code, you want the escaped ampersands. If you use
547      * the returned URL in HTTP headers, you want $escaped=false.
548      *
549      * @param bool $escaped Use &amp; as params separator instead of plain &
550      * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
551      * @return string Resulting URL
552      */
553     public function out($escaped = true, array $overrideparams = null) {
555         global $CFG;
557         if (!is_bool($escaped)) {
558             debugging('Escape parameter must be of type boolean, '.gettype($escaped).' given instead.');
559         }
561         $url = $this;
563         // Allow url's to be rewritten by a plugin.
564         if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
565             $class = $CFG->urlrewriteclass;
566             $pluginurl = $class::url_rewrite($url);
567             if ($pluginurl instanceof moodle_url) {
568                 $url = $pluginurl;
569             }
570         }
572         return $url->raw_out($escaped, $overrideparams);
574     }
576     /**
577      * Output url without any rewrites
578      *
579      * This is identical in signature and use to out() but doesn't call the rewrite handler.
580      *
581      * @param bool $escaped Use &amp; as params separator instead of plain &
582      * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
583      * @return string Resulting URL
584      */
585     public function raw_out($escaped = true, array $overrideparams = null) {
586         if (!is_bool($escaped)) {
587             debugging('Escape parameter must be of type boolean, '.gettype($escaped).' given instead.');
588         }
590         $uri = $this->out_omit_querystring().$this->slashargument;
592         $querystring = $this->get_query_string($escaped, $overrideparams);
593         if ($querystring !== '') {
594             $uri .= '?' . $querystring;
595         }
596         if (!is_null($this->anchor)) {
597             $uri .= '#'.$this->anchor;
598         }
600         return $uri;
601     }
603     /**
604      * Returns url without parameters, everything before '?'.
605      *
606      * @param bool $includeanchor if {@link self::anchor} is defined, should it be returned?
607      * @return string
608      */
609     public function out_omit_querystring($includeanchor = false) {
611         $uri = $this->scheme ? $this->scheme.':'.((strtolower($this->scheme) == 'mailto') ? '':'//'): '';
612         $uri .= $this->user ? $this->user.($this->pass? ':'.$this->pass:'').'@':'';
613         $uri .= $this->host ? $this->host : '';
614         $uri .= $this->port ? ':'.$this->port : '';
615         $uri .= $this->path ? $this->path : '';
616         if ($includeanchor and !is_null($this->anchor)) {
617             $uri .= '#' . $this->anchor;
618         }
620         return $uri;
621     }
623     /**
624      * Compares this moodle_url with another.
625      *
626      * See documentation of constants for an explanation of the comparison flags.
627      *
628      * @param moodle_url $url The moodle_url object to compare
629      * @param int $matchtype The type of comparison (URL_MATCH_BASE, URL_MATCH_PARAMS, URL_MATCH_EXACT)
630      * @return bool
631      */
632     public function compare(moodle_url $url, $matchtype = URL_MATCH_EXACT) {
634         $baseself = $this->out_omit_querystring();
635         $baseother = $url->out_omit_querystring();
637         // Append index.php if there is no specific file.
638         if (substr($baseself, -1) == '/') {
639             $baseself .= 'index.php';
640         }
641         if (substr($baseother, -1) == '/') {
642             $baseother .= 'index.php';
643         }
645         // Compare the two base URLs.
646         if ($baseself != $baseother) {
647             return false;
648         }
650         if ($matchtype == URL_MATCH_BASE) {
651             return true;
652         }
654         $urlparams = $url->params();
655         foreach ($this->params() as $param => $value) {
656             if ($param == 'sesskey') {
657                 continue;
658             }
659             if (!array_key_exists($param, $urlparams) || $urlparams[$param] != $value) {
660                 return false;
661             }
662         }
664         if ($matchtype == URL_MATCH_PARAMS) {
665             return true;
666         }
668         foreach ($urlparams as $param => $value) {
669             if ($param == 'sesskey') {
670                 continue;
671             }
672             if (!array_key_exists($param, $this->params()) || $this->param($param) != $value) {
673                 return false;
674             }
675         }
677         if ($url->anchor !== $this->anchor) {
678             return false;
679         }
681         return true;
682     }
684     /**
685      * Sets the anchor for the URI (the bit after the hash)
686      *
687      * @param string $anchor null means remove previous
688      */
689     public function set_anchor($anchor) {
690         if (is_null($anchor)) {
691             // Remove.
692             $this->anchor = null;
693         } else if ($anchor === '') {
694             // Special case, used as empty link.
695             $this->anchor = '';
696         } else if (preg_match('|[a-zA-Z\_\:][a-zA-Z0-9\_\-\.\:]*|', $anchor)) {
697             // Match the anchor against the NMTOKEN spec.
698             $this->anchor = $anchor;
699         } else {
700             // Bad luck, no valid anchor found.
701             $this->anchor = null;
702         }
703     }
705     /**
706      * Sets the scheme for the URI (the bit before ://)
707      *
708      * @param string $scheme
709      */
710     public function set_scheme($scheme) {
711         // See http://www.ietf.org/rfc/rfc3986.txt part 3.1.
712         if (preg_match('/^[a-zA-Z][a-zA-Z0-9+.-]*$/', $scheme)) {
713             $this->scheme = $scheme;
714         } else {
715             throw new coding_exception('Bad URL scheme.');
716         }
717     }
719     /**
720      * Sets the url slashargument value.
721      *
722      * @param string $path usually file path
723      * @param string $parameter name of page parameter if slasharguments not supported
724      * @param bool $supported usually null, then it depends on $CFG->slasharguments, use true or false for other servers
725      * @return void
726      */
727     public function set_slashargument($path, $parameter = 'file', $supported = null) {
728         global $CFG;
729         if (is_null($supported)) {
730             $supported = !empty($CFG->slasharguments);
731         }
733         if ($supported) {
734             $parts = explode('/', $path);
735             $parts = array_map('rawurlencode', $parts);
736             $path  = implode('/', $parts);
737             $this->slashargument = $path;
738             unset($this->params[$parameter]);
740         } else {
741             $this->slashargument = '';
742             $this->params[$parameter] = $path;
743         }
744     }
746     // Static factory methods.
748     /**
749      * General moodle file url.
750      *
751      * @param string $urlbase the script serving the file
752      * @param string $path
753      * @param bool $forcedownload
754      * @return moodle_url
755      */
756     public static function make_file_url($urlbase, $path, $forcedownload = false) {
757         $params = array();
758         if ($forcedownload) {
759             $params['forcedownload'] = 1;
760         }
761         $url = new moodle_url($urlbase, $params);
762         $url->set_slashargument($path);
763         return $url;
764     }
766     /**
767      * Factory method for creation of url pointing to plugin file.
768      *
769      * Please note this method can be used only from the plugins to
770      * create urls of own files, it must not be used outside of plugins!
771      *
772      * @param int $contextid
773      * @param string $component
774      * @param string $area
775      * @param int $itemid
776      * @param string $pathname
777      * @param string $filename
778      * @param bool $forcedownload
779      * @return moodle_url
780      */
781     public static function make_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename,
782                                                $forcedownload = false) {
783         global $CFG;
784         $urlbase = "$CFG->httpswwwroot/pluginfile.php";
785         if ($itemid === null) {
786             return self::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
787         } else {
788             return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
789         }
790     }
792     /**
793      * Factory method for creation of url pointing to plugin file.
794      * This method is the same that make_pluginfile_url but pointing to the webservice pluginfile.php script.
795      * It should be used only in external functions.
796      *
797      * @since  2.8
798      * @param int $contextid
799      * @param string $component
800      * @param string $area
801      * @param int $itemid
802      * @param string $pathname
803      * @param string $filename
804      * @param bool $forcedownload
805      * @return moodle_url
806      */
807     public static function make_webservice_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename,
808                                                $forcedownload = false) {
809         global $CFG;
810         $urlbase = "$CFG->httpswwwroot/webservice/pluginfile.php";
811         if ($itemid === null) {
812             return self::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
813         } else {
814             return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
815         }
816     }
818     /**
819      * Factory method for creation of url pointing to draft file of current user.
820      *
821      * @param int $draftid draft item id
822      * @param string $pathname
823      * @param string $filename
824      * @param bool $forcedownload
825      * @return moodle_url
826      */
827     public static function make_draftfile_url($draftid, $pathname, $filename, $forcedownload = false) {
828         global $CFG, $USER;
829         $urlbase = "$CFG->httpswwwroot/draftfile.php";
830         $context = context_user::instance($USER->id);
832         return self::make_file_url($urlbase, "/$context->id/user/draft/$draftid".$pathname.$filename, $forcedownload);
833     }
835     /**
836      * Factory method for creating of links to legacy course files.
837      *
838      * @param int $courseid
839      * @param string $filepath
840      * @param bool $forcedownload
841      * @return moodle_url
842      */
843     public static function make_legacyfile_url($courseid, $filepath, $forcedownload = false) {
844         global $CFG;
846         $urlbase = "$CFG->wwwroot/file.php";
847         return self::make_file_url($urlbase, '/'.$courseid.'/'.$filepath, $forcedownload);
848     }
850     /**
851      * Returns URL a relative path from $CFG->wwwroot
852      *
853      * Can be used for passing around urls with the wwwroot stripped
854      *
855      * @param boolean $escaped Use &amp; as params separator instead of plain &
856      * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
857      * @return string Resulting URL
858      * @throws coding_exception if called on a non-local url
859      */
860     public function out_as_local_url($escaped = true, array $overrideparams = null) {
861         global $CFG;
863         $url = $this->out($escaped, $overrideparams);
864         $httpswwwroot = str_replace("http://", "https://", $CFG->wwwroot);
866         // Url should be equal to wwwroot or httpswwwroot. If not then throw exception.
867         if (($url === $CFG->wwwroot) || (strpos($url, $CFG->wwwroot.'/') === 0)) {
868             $localurl = substr($url, strlen($CFG->wwwroot));
869             return !empty($localurl) ? $localurl : '';
870         } else if (($url === $httpswwwroot) || (strpos($url, $httpswwwroot.'/') === 0)) {
871             $localurl = substr($url, strlen($httpswwwroot));
872             return !empty($localurl) ? $localurl : '';
873         } else {
874             throw new coding_exception('out_as_local_url called on a non-local URL');
875         }
876     }
878     /**
879      * Returns the 'path' portion of a URL. For example, if the URL is
880      * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
881      * return '/my/file/is/here.txt'.
882      *
883      * By default the path includes slash-arguments (for example,
884      * '/myfile.php/extra/arguments') so it is what you would expect from a
885      * URL path. If you don't want this behaviour, you can opt to exclude the
886      * slash arguments. (Be careful: if the $CFG variable slasharguments is
887      * disabled, these URLs will have a different format and you may need to
888      * look at the 'file' parameter too.)
889      *
890      * @param bool $includeslashargument If true, includes slash arguments
891      * @return string Path of URL
892      */
893     public function get_path($includeslashargument = true) {
894         return $this->path . ($includeslashargument ? $this->slashargument : '');
895     }
897     /**
898      * Returns a given parameter value from the URL.
899      *
900      * @param string $name Name of parameter
901      * @return string Value of parameter or null if not set
902      */
903     public function get_param($name) {
904         if (array_key_exists($name, $this->params)) {
905             return $this->params[$name];
906         } else {
907             return null;
908         }
909     }
911     /**
912      * Returns the 'scheme' portion of a URL. For example, if the URL is
913      * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
914      * return 'http' (without the colon).
915      *
916      * @return string Scheme of the URL.
917      */
918     public function get_scheme() {
919         return $this->scheme;
920     }
922     /**
923      * Returns the 'host' portion of a URL. For example, if the URL is
924      * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
925      * return 'www.example.org'.
926      *
927      * @return string Host of the URL.
928      */
929     public function get_host() {
930         return $this->host;
931     }
933     /**
934      * Returns the 'port' portion of a URL. For example, if the URL is
935      * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
936      * return '447'.
937      *
938      * @return string Port of the URL.
939      */
940     public function get_port() {
941         return $this->port;
942     }
945 /**
946  * Determine if there is data waiting to be processed from a form
947  *
948  * Used on most forms in Moodle to check for data
949  * Returns the data as an object, if it's found.
950  * This object can be used in foreach loops without
951  * casting because it's cast to (array) automatically
952  *
953  * Checks that submitted POST data exists and returns it as object.
954  *
955  * @return mixed false or object
956  */
957 function data_submitted() {
959     if (empty($_POST)) {
960         return false;
961     } else {
962         return (object)fix_utf8($_POST);
963     }
966 /**
967  * Given some normal text this function will break up any
968  * long words to a given size by inserting the given character
969  *
970  * It's multibyte savvy and doesn't change anything inside html tags.
971  *
972  * @param string $string the string to be modified
973  * @param int $maxsize maximum length of the string to be returned
974  * @param string $cutchar the string used to represent word breaks
975  * @return string
976  */
977 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
979     // First of all, save all the tags inside the text to skip them.
980     $tags = array();
981     filter_save_tags($string, $tags);
983     // Process the string adding the cut when necessary.
984     $output = '';
985     $length = core_text::strlen($string);
986     $wordlength = 0;
988     for ($i=0; $i<$length; $i++) {
989         $char = core_text::substr($string, $i, 1);
990         if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
991             $wordlength = 0;
992         } else {
993             $wordlength++;
994             if ($wordlength > $maxsize) {
995                 $output .= $cutchar;
996                 $wordlength = 0;
997             }
998         }
999         $output .= $char;
1000     }
1002     // Finally load the tags back again.
1003     if (!empty($tags)) {
1004         $output = str_replace(array_keys($tags), $tags, $output);
1005     }
1007     return $output;
1010 /**
1011  * Try and close the current window using JavaScript, either immediately, or after a delay.
1012  *
1013  * Echo's out the resulting XHTML & javascript
1014  *
1015  * @param integer $delay a delay in seconds before closing the window. Default 0.
1016  * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
1017  *      to reload the parent window before this one closes.
1018  */
1019 function close_window($delay = 0, $reloadopener = false) {
1020     global $PAGE, $OUTPUT;
1022     if (!$PAGE->headerprinted) {
1023         $PAGE->set_title(get_string('closewindow'));
1024         echo $OUTPUT->header();
1025     } else {
1026         $OUTPUT->container_end_all(false);
1027     }
1029     if ($reloadopener) {
1030         // Trigger the reload immediately, even if the reload is after a delay.
1031         $PAGE->requires->js_function_call('window.opener.location.reload', array(true));
1032     }
1033     $OUTPUT->notification(get_string('windowclosing'), 'notifysuccess');
1035     $PAGE->requires->js_function_call('close_window', array(new stdClass()), false, $delay);
1037     echo $OUTPUT->footer();
1038     exit;
1041 /**
1042  * Returns a string containing a link to the user documentation for the current page.
1043  *
1044  * Also contains an icon by default. Shown to teachers and admin only.
1045  *
1046  * @param string $text The text to be displayed for the link
1047  * @return string The link to user documentation for this current page
1048  */
1049 function page_doc_link($text='') {
1050     global $OUTPUT, $PAGE;
1051     $path = page_get_doc_link_path($PAGE);
1052     if (!$path) {
1053         return '';
1054     }
1055     return $OUTPUT->doc_link($path, $text);
1058 /**
1059  * Returns the path to use when constructing a link to the docs.
1060  *
1061  * @since Moodle 2.5.1 2.6
1062  * @param moodle_page $page
1063  * @return string
1064  */
1065 function page_get_doc_link_path(moodle_page $page) {
1066     global $CFG;
1068     if (empty($CFG->docroot) || during_initial_install()) {
1069         return '';
1070     }
1071     if (!has_capability('moodle/site:doclinks', $page->context)) {
1072         return '';
1073     }
1075     $path = $page->docspath;
1076     if (!$path) {
1077         return '';
1078     }
1079     return $path;
1083 /**
1084  * Validates an email to make sure it makes sense.
1085  *
1086  * @param string $address The email address to validate.
1087  * @return boolean
1088  */
1089 function validate_email($address) {
1091     return (bool)preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
1092                  '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
1093                   '@'.
1094                   '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
1095                   '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
1096                   $address);
1099 /**
1100  * Extracts file argument either from file parameter or PATH_INFO
1101  *
1102  * Note: $scriptname parameter is not needed anymore
1103  *
1104  * @return string file path (only safe characters)
1105  */
1106 function get_file_argument() {
1107     global $SCRIPT;
1109     $relativepath = false;
1110     $hasforcedslashargs = false;
1112     if (isset($_SERVER['REQUEST_URI']) && !empty($_SERVER['REQUEST_URI'])) {
1113         // Checks whether $_SERVER['REQUEST_URI'] contains '/pluginfile.php/'
1114         // instead of '/pluginfile.php?', when serving a file from e.g. mod_imscp or mod_scorm.
1115         if ((strpos($_SERVER['REQUEST_URI'], '/pluginfile.php/') !== false)
1116                 && isset($_SERVER['PATH_INFO']) && !empty($_SERVER['PATH_INFO'])) {
1117             // Exclude edge cases like '/pluginfile.php/?file='.
1118             $args = explode('/', ltrim($_SERVER['PATH_INFO'], '/'));
1119             $hasforcedslashargs = (count($args) > 2); // Always at least: context, component and filearea.
1120         }
1121     }
1122     if (!$hasforcedslashargs) {
1123         $relativepath = optional_param('file', false, PARAM_PATH);
1124     }
1126     if ($relativepath !== false and $relativepath !== '') {
1127         return $relativepath;
1128     }
1129     $relativepath = false;
1131     // Then try extract file from the slasharguments.
1132     if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
1133         // NOTE: IIS tends to convert all file paths to single byte DOS encoding,
1134         //       we can not use other methods because they break unicode chars,
1135         //       the only ways are to use URL rewriting
1136         //       OR
1137         //       to properly set the 'FastCGIUtf8ServerVariables' registry key.
1138         if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
1139             // Check that PATH_INFO works == must not contain the script name.
1140             if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
1141                 $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
1142             }
1143         }
1144     } else {
1145         // All other apache-like servers depend on PATH_INFO.
1146         if (isset($_SERVER['PATH_INFO'])) {
1147             if (isset($_SERVER['SCRIPT_NAME']) and strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === 0) {
1148                 $relativepath = substr($_SERVER['PATH_INFO'], strlen($_SERVER['SCRIPT_NAME']));
1149             } else {
1150                 $relativepath = $_SERVER['PATH_INFO'];
1151             }
1152             $relativepath = clean_param($relativepath, PARAM_PATH);
1153         }
1154     }
1156     return $relativepath;
1159 /**
1160  * Just returns an array of text formats suitable for a popup menu
1161  *
1162  * @return array
1163  */
1164 function format_text_menu() {
1165     return array (FORMAT_MOODLE => get_string('formattext'),
1166                   FORMAT_HTML => get_string('formathtml'),
1167                   FORMAT_PLAIN => get_string('formatplain'),
1168                   FORMAT_MARKDOWN => get_string('formatmarkdown'));
1171 /**
1172  * Given text in a variety of format codings, this function returns the text as safe HTML.
1173  *
1174  * This function should mainly be used for long strings like posts,
1175  * answers, glossary items etc. For short strings {@link format_string()}.
1176  *
1177  * <pre>
1178  * Options:
1179  *      trusted     :   If true the string won't be cleaned. Default false required noclean=true.
1180  *      noclean     :   If true the string won't be cleaned. Default false required trusted=true.
1181  *      nocache     :   If true the strign will not be cached and will be formatted every call. Default false.
1182  *      filter      :   If true the string will be run through applicable filters as well. Default true.
1183  *      para        :   If true then the returned string will be wrapped in div tags. Default true.
1184  *      newlines    :   If true then lines newline breaks will be converted to HTML newline breaks. Default true.
1185  *      context     :   The context that will be used for filtering.
1186  *      overflowdiv :   If set to true the formatted text will be encased in a div
1187  *                      with the class no-overflow before being returned. Default false.
1188  *      allowid     :   If true then id attributes will not be removed, even when
1189  *                      using htmlpurifier. Default false.
1190  *      blanktarget :   If true all <a> tags will have target="_blank" added unless target is explicitly specified.
1191  * </pre>
1192  *
1193  * @staticvar array $croncache
1194  * @param string $text The text to be formatted. This is raw text originally from user input.
1195  * @param int $format Identifier of the text format to be used
1196  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
1197  * @param object/array $options text formatting options
1198  * @param int $courseiddonotuse deprecated course id, use context option instead
1199  * @return string
1200  */
1201 function format_text($text, $format = FORMAT_MOODLE, $options = null, $courseiddonotuse = null) {
1202     global $CFG, $DB, $PAGE;
1204     if ($text === '' || is_null($text)) {
1205         // No need to do any filters and cleaning.
1206         return '';
1207     }
1209     // Detach object, we can not modify it.
1210     $options = (array)$options;
1212     if (!isset($options['trusted'])) {
1213         $options['trusted'] = false;
1214     }
1215     if (!isset($options['noclean'])) {
1216         if ($options['trusted'] and trusttext_active()) {
1217             // No cleaning if text trusted and noclean not specified.
1218             $options['noclean'] = true;
1219         } else {
1220             $options['noclean'] = false;
1221         }
1222     }
1223     if (!isset($options['nocache'])) {
1224         $options['nocache'] = false;
1225     }
1226     if (!isset($options['filter'])) {
1227         $options['filter'] = true;
1228     }
1229     if (!isset($options['para'])) {
1230         $options['para'] = true;
1231     }
1232     if (!isset($options['newlines'])) {
1233         $options['newlines'] = true;
1234     }
1235     if (!isset($options['overflowdiv'])) {
1236         $options['overflowdiv'] = false;
1237     }
1238     $options['blanktarget'] = !empty($options['blanktarget']);
1240     // Calculate best context.
1241     if (empty($CFG->version) or $CFG->version < 2013051400 or during_initial_install()) {
1242         // Do not filter anything during installation or before upgrade completes.
1243         $context = null;
1245     } else if (isset($options['context'])) { // First by explicit passed context option.
1246         if (is_object($options['context'])) {
1247             $context = $options['context'];
1248         } else {
1249             $context = context::instance_by_id($options['context']);
1250         }
1251     } else if ($courseiddonotuse) {
1252         // Legacy courseid.
1253         $context = context_course::instance($courseiddonotuse);
1254     } else {
1255         // Fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(.
1256         $context = $PAGE->context;
1257     }
1259     if (!$context) {
1260         // Either install/upgrade or something has gone really wrong because context does not exist (yet?).
1261         $options['nocache'] = true;
1262         $options['filter']  = false;
1263     }
1265     if ($options['filter']) {
1266         $filtermanager = filter_manager::instance();
1267         $filtermanager->setup_page_for_filters($PAGE, $context); // Setup global stuff filters may have.
1268         $filteroptions = array(
1269             'originalformat' => $format,
1270             'noclean' => $options['noclean'],
1271         );
1272     } else {
1273         $filtermanager = new null_filter_manager();
1274         $filteroptions = array();
1275     }
1277     switch ($format) {
1278         case FORMAT_HTML:
1279             if (!$options['noclean']) {
1280                 $text = clean_text($text, FORMAT_HTML, $options);
1281             }
1282             $text = $filtermanager->filter_text($text, $context, $filteroptions);
1283             break;
1285         case FORMAT_PLAIN:
1286             $text = s($text); // Cleans dangerous JS.
1287             $text = rebuildnolinktag($text);
1288             $text = str_replace('  ', '&nbsp; ', $text);
1289             $text = nl2br($text);
1290             break;
1292         case FORMAT_WIKI:
1293             // This format is deprecated.
1294             $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle.  You should not be seeing
1295                      this message as all texts should have been converted to Markdown format instead.
1296                      Please post a bug report to http://moodle.org/bugs with information about where you
1297                      saw this message.</p>'.s($text);
1298             break;
1300         case FORMAT_MARKDOWN:
1301             $text = markdown_to_html($text);
1302             if (!$options['noclean']) {
1303                 $text = clean_text($text, FORMAT_HTML, $options);
1304             }
1305             $text = $filtermanager->filter_text($text, $context, $filteroptions);
1306             break;
1308         default:  // FORMAT_MOODLE or anything else.
1309             $text = text_to_html($text, null, $options['para'], $options['newlines']);
1310             if (!$options['noclean']) {
1311                 $text = clean_text($text, FORMAT_HTML, $options);
1312             }
1313             $text = $filtermanager->filter_text($text, $context, $filteroptions);
1314             break;
1315     }
1316     if ($options['filter']) {
1317         // At this point there should not be any draftfile links any more,
1318         // this happens when developers forget to post process the text.
1319         // The only potential problem is that somebody might try to format
1320         // the text before storing into database which would be itself big bug..
1321         $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
1323         if ($CFG->debugdeveloper) {
1324             if (strpos($text, '@@PLUGINFILE@@/') !== false) {
1325                 debugging('Before calling format_text(), the content must be processed with file_rewrite_pluginfile_urls()',
1326                     DEBUG_DEVELOPER);
1327             }
1328         }
1329     }
1331     if (!empty($options['overflowdiv'])) {
1332         $text = html_writer::tag('div', $text, array('class' => 'no-overflow'));
1333     }
1335     if ($options['blanktarget']) {
1336         $domdoc = new DOMDocument();
1337         libxml_use_internal_errors(true);
1338         $domdoc->loadHTML('<?xml version="1.0" encoding="UTF-8" ?>' . $text);
1339         libxml_clear_errors();
1340         foreach ($domdoc->getElementsByTagName('a') as $link) {
1341             if ($link->hasAttribute('target') && strpos($link->getAttribute('target'), '_blank') === false) {
1342                 continue;
1343             }
1344             $link->setAttribute('target', '_blank');
1345             if (strpos($link->getAttribute('rel'), 'noreferrer') === false) {
1346                 $link->setAttribute('rel', trim($link->getAttribute('rel') . ' noreferrer'));
1347             }
1348         }
1350         // This regex is nasty and I don't like it. The correct way to solve this is by loading the HTML like so:
1351         // $domdoc->loadHTML($text, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD); however it seems like the libxml
1352         // version that travis uses doesn't work properly and ends up leaving <html><body>, so I'm forced to use
1353         // this regex to remove those tags.
1354         $text = trim(preg_replace('~<(?:!DOCTYPE|/?(?:html|body))[^>]*>\s*~i', '', $domdoc->saveHTML($domdoc->documentElement)));
1355     }
1357     return $text;
1360 /**
1361  * Resets some data related to filters, called during upgrade or when general filter settings change.
1362  *
1363  * @param bool $phpunitreset true means called from our PHPUnit integration test reset
1364  * @return void
1365  */
1366 function reset_text_filters_cache($phpunitreset = false) {
1367     global $CFG, $DB;
1369     if ($phpunitreset) {
1370         // HTMLPurifier does not change, DB is already reset to defaults,
1371         // nothing to do here, the dataroot was cleared too.
1372         return;
1373     }
1375     // The purge_all_caches() deals with cachedir and localcachedir purging,
1376     // the individual filter caches are invalidated as necessary elsewhere.
1378     // Update $CFG->filterall cache flag.
1379     if (empty($CFG->stringfilters)) {
1380         set_config('filterall', 0);
1381         return;
1382     }
1383     $installedfilters = core_component::get_plugin_list('filter');
1384     $filters = explode(',', $CFG->stringfilters);
1385     foreach ($filters as $filter) {
1386         if (isset($installedfilters[$filter])) {
1387             set_config('filterall', 1);
1388             return;
1389         }
1390     }
1391     set_config('filterall', 0);
1394 /**
1395  * Given a simple string, this function returns the string
1396  * processed by enabled string filters if $CFG->filterall is enabled
1397  *
1398  * This function should be used to print short strings (non html) that
1399  * need filter processing e.g. activity titles, post subjects,
1400  * glossary concepts.
1401  *
1402  * @staticvar bool $strcache
1403  * @param string $string The string to be filtered. Should be plain text, expect
1404  * possibly for multilang tags.
1405  * @param boolean $striplinks To strip any link in the result text. Moodle 1.8 default changed from false to true! MDL-8713
1406  * @param array $options options array/object or courseid
1407  * @return string
1408  */
1409 function format_string($string, $striplinks = true, $options = null) {
1410     global $CFG, $PAGE;
1412     // We'll use a in-memory cache here to speed up repeated strings.
1413     static $strcache = false;
1415     if (empty($CFG->version) or $CFG->version < 2013051400 or during_initial_install()) {
1416         // Do not filter anything during installation or before upgrade completes.
1417         return $string = strip_tags($string);
1418     }
1420     if ($strcache === false or count($strcache) > 2000) {
1421         // This number might need some tuning to limit memory usage in cron.
1422         $strcache = array();
1423     }
1425     if (is_numeric($options)) {
1426         // Legacy courseid usage.
1427         $options  = array('context' => context_course::instance($options));
1428     } else {
1429         // Detach object, we can not modify it.
1430         $options = (array)$options;
1431     }
1433     if (empty($options['context'])) {
1434         // Fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(.
1435         $options['context'] = $PAGE->context;
1436     } else if (is_numeric($options['context'])) {
1437         $options['context'] = context::instance_by_id($options['context']);
1438     }
1439     if (!isset($options['filter'])) {
1440         $options['filter'] = true;
1441     }
1443     $options['escape'] = !isset($options['escape']) || $options['escape'];
1445     if (!$options['context']) {
1446         // We did not find any context? weird.
1447         return $string = strip_tags($string);
1448     }
1450     // Calculate md5.
1451     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id.'<+>'.$options['escape'].'<+>'.current_language());
1453     // Fetch from cache if possible.
1454     if (isset($strcache[$md5])) {
1455         return $strcache[$md5];
1456     }
1458     // First replace all ampersands not followed by html entity code
1459     // Regular expression moved to its own method for easier unit testing.
1460     $string = $options['escape'] ? replace_ampersands_not_followed_by_entity($string) : $string;
1462     if (!empty($CFG->filterall) && $options['filter']) {
1463         $filtermanager = filter_manager::instance();
1464         $filtermanager->setup_page_for_filters($PAGE, $options['context']); // Setup global stuff filters may have.
1465         $string = $filtermanager->filter_string($string, $options['context']);
1466     }
1468     // If the site requires it, strip ALL tags from this string.
1469     if (!empty($CFG->formatstringstriptags)) {
1470         if ($options['escape']) {
1471             $string = str_replace(array('<', '>'), array('&lt;', '&gt;'), strip_tags($string));
1472         } else {
1473             $string = strip_tags($string);
1474         }
1475     } else {
1476         // Otherwise strip just links if that is required (default).
1477         if ($striplinks) {
1478             // Strip links in string.
1479             $string = strip_links($string);
1480         }
1481         $string = clean_text($string);
1482     }
1484     // Store to cache.
1485     $strcache[$md5] = $string;
1487     return $string;
1490 /**
1491  * Given a string, performs a negative lookahead looking for any ampersand character
1492  * that is not followed by a proper HTML entity. If any is found, it is replaced
1493  * by &amp;. The string is then returned.
1494  *
1495  * @param string $string
1496  * @return string
1497  */
1498 function replace_ampersands_not_followed_by_entity($string) {
1499     return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1502 /**
1503  * Given a string, replaces all <a>.*</a> by .* and returns the string.
1504  *
1505  * @param string $string
1506  * @return string
1507  */
1508 function strip_links($string) {
1509     return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is', '$2', $string);
1512 /**
1513  * This expression turns links into something nice in a text format. (Russell Jungwirth)
1514  *
1515  * @param string $string
1516  * @return string
1517  */
1518 function wikify_links($string) {
1519     return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i', '$3 [ $2 ]', $string);
1522 /**
1523  * Given text in a variety of format codings, this function returns the text as plain text suitable for plain email.
1524  *
1525  * @param string $text The text to be formatted. This is raw text originally from user input.
1526  * @param int $format Identifier of the text format to be used
1527  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1528  * @return string
1529  */
1530 function format_text_email($text, $format) {
1532     switch ($format) {
1534         case FORMAT_PLAIN:
1535             return $text;
1536             break;
1538         case FORMAT_WIKI:
1539             // There should not be any of these any more!
1540             $text = wikify_links($text);
1541             return core_text::entities_to_utf8(strip_tags($text), true);
1542             break;
1544         case FORMAT_HTML:
1545             return html_to_text($text);
1546             break;
1548         case FORMAT_MOODLE:
1549         case FORMAT_MARKDOWN:
1550         default:
1551             $text = wikify_links($text);
1552             return core_text::entities_to_utf8(strip_tags($text), true);
1553             break;
1554     }
1557 /**
1558  * Formats activity intro text
1559  *
1560  * @param string $module name of module
1561  * @param object $activity instance of activity
1562  * @param int $cmid course module id
1563  * @param bool $filter filter resulting html text
1564  * @return string
1565  */
1566 function format_module_intro($module, $activity, $cmid, $filter=true) {
1567     global $CFG;
1568     require_once("$CFG->libdir/filelib.php");
1569     $context = context_module::instance($cmid);
1570     $options = array('noclean' => true, 'para' => false, 'filter' => $filter, 'context' => $context, 'overflowdiv' => true);
1571     $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, 'mod_'.$module, 'intro', null);
1572     return trim(format_text($intro, $activity->introformat, $options, null));
1575 /**
1576  * Removes the usage of Moodle files from a text.
1577  *
1578  * In some rare cases we need to re-use a text that already has embedded links
1579  * to some files hosted within Moodle. But the new area in which we will push
1580  * this content does not support files... therefore we need to remove those files.
1581  *
1582  * @param string $source The text
1583  * @return string The stripped text
1584  */
1585 function strip_pluginfile_content($source) {
1586     $baseurl = '@@PLUGINFILE@@';
1587     // Looking for something like < .* "@@pluginfile@@.*" .* >
1588     $pattern = '$<[^<>]+["\']' . $baseurl . '[^"\']*["\'][^<>]*>$';
1589     $stripped = preg_replace($pattern, '', $source);
1590     // Use purify html to rebalence potentially mismatched tags and generally cleanup.
1591     return purify_html($stripped);
1594 /**
1595  * Legacy function, used for cleaning of old forum and glossary text only.
1596  *
1597  * @param string $text text that may contain legacy TRUSTTEXT marker
1598  * @return string text without legacy TRUSTTEXT marker
1599  */
1600 function trusttext_strip($text) {
1601     if (!is_string($text)) {
1602         // This avoids the potential for an endless loop below.
1603         throw new coding_exception('trusttext_strip parameter must be a string');
1604     }
1605     while (true) { // Removing nested TRUSTTEXT.
1606         $orig = $text;
1607         $text = str_replace('#####TRUSTTEXT#####', '', $text);
1608         if (strcmp($orig, $text) === 0) {
1609             return $text;
1610         }
1611     }
1614 /**
1615  * Must be called before editing of all texts with trust flag. Removes all XSS nasties from texts stored in database if needed.
1616  *
1617  * @param stdClass $object data object with xxx, xxxformat and xxxtrust fields
1618  * @param string $field name of text field
1619  * @param context $context active context
1620  * @return stdClass updated $object
1621  */
1622 function trusttext_pre_edit($object, $field, $context) {
1623     $trustfield  = $field.'trust';
1624     $formatfield = $field.'format';
1626     if (!$object->$trustfield or !trusttext_trusted($context)) {
1627         $object->$field = clean_text($object->$field, $object->$formatfield);
1628     }
1630     return $object;
1633 /**
1634  * Is current user trusted to enter no dangerous XSS in this context?
1635  *
1636  * Please note the user must be in fact trusted everywhere on this server!!
1637  *
1638  * @param context $context
1639  * @return bool true if user trusted
1640  */
1641 function trusttext_trusted($context) {
1642     return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1645 /**
1646  * Is trusttext feature active?
1647  *
1648  * @return bool
1649  */
1650 function trusttext_active() {
1651     global $CFG;
1653     return !empty($CFG->enabletrusttext);
1656 /**
1657  * Cleans raw text removing nasties.
1658  *
1659  * Given raw text (eg typed in by a user) this function cleans it up and removes any nasty tags that could mess up
1660  * Moodle pages through XSS attacks.
1661  *
1662  * The result must be used as a HTML text fragment, this function can not cleanup random
1663  * parts of html tags such as url or src attributes.
1664  *
1665  * NOTE: the format parameter was deprecated because we can safely clean only HTML.
1666  *
1667  * @param string $text The text to be cleaned
1668  * @param int|string $format deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
1669  * @param array $options Array of options; currently only option supported is 'allowid' (if true,
1670  *   does not remove id attributes when cleaning)
1671  * @return string The cleaned up text
1672  */
1673 function clean_text($text, $format = FORMAT_HTML, $options = array()) {
1674     $text = (string)$text;
1676     if ($format != FORMAT_HTML and $format != FORMAT_HTML) {
1677         // TODO: we need to standardise cleanup of text when loading it into editor first.
1678         // debugging('clean_text() is designed to work only with html');.
1679     }
1681     if ($format == FORMAT_PLAIN) {
1682         return $text;
1683     }
1685     if (is_purify_html_necessary($text)) {
1686         $text = purify_html($text, $options);
1687     }
1689     // Originally we tried to neutralise some script events here, it was a wrong approach because
1690     // it was trivial to work around that (for example using style based XSS exploits).
1691     // We must not give false sense of security here - all developers MUST understand how to use
1692     // rawurlencode(), htmlentities(), htmlspecialchars(), p(), s(), moodle_url, html_writer and friends!!!
1694     return $text;
1697 /**
1698  * Is it necessary to use HTMLPurifier?
1699  *
1700  * @private
1701  * @param string $text
1702  * @return bool false means html is safe and valid, true means use HTMLPurifier
1703  */
1704 function is_purify_html_necessary($text) {
1705     if ($text === '') {
1706         return false;
1707     }
1709     if ($text === (string)((int)$text)) {
1710         return false;
1711     }
1713     if (strpos($text, '&') !== false or preg_match('|<[^pesb/]|', $text)) {
1714         // We need to normalise entities or other tags except p, em, strong and br present.
1715         return true;
1716     }
1718     $altered = htmlspecialchars($text, ENT_NOQUOTES, 'UTF-8', true);
1719     if ($altered === $text) {
1720         // No < > or other special chars means this must be safe.
1721         return false;
1722     }
1724     // Let's try to convert back some safe html tags.
1725     $altered = preg_replace('|&lt;p&gt;(.*?)&lt;/p&gt;|m', '<p>$1</p>', $altered);
1726     if ($altered === $text) {
1727         return false;
1728     }
1729     $altered = preg_replace('|&lt;em&gt;([^<>]+?)&lt;/em&gt;|m', '<em>$1</em>', $altered);
1730     if ($altered === $text) {
1731         return false;
1732     }
1733     $altered = preg_replace('|&lt;strong&gt;([^<>]+?)&lt;/strong&gt;|m', '<strong>$1</strong>', $altered);
1734     if ($altered === $text) {
1735         return false;
1736     }
1737     $altered = str_replace('&lt;br /&gt;', '<br />', $altered);
1738     if ($altered === $text) {
1739         return false;
1740     }
1742     return true;
1745 /**
1746  * KSES replacement cleaning function - uses HTML Purifier.
1747  *
1748  * @param string $text The (X)HTML string to purify
1749  * @param array $options Array of options; currently only option supported is 'allowid' (if set,
1750  *   does not remove id attributes when cleaning)
1751  * @return string
1752  */
1753 function purify_html($text, $options = array()) {
1754     global $CFG;
1756     $text = (string)$text;
1758     static $purifiers = array();
1759     static $caches = array();
1761     // Purifier code can change only during major version upgrade.
1762     $version = empty($CFG->version) ? 0 : $CFG->version;
1763     $cachedir = "$CFG->localcachedir/htmlpurifier/$version";
1764     if (!file_exists($cachedir)) {
1765         // Purging of caches may remove the cache dir at any time,
1766         // luckily file_exists() results should be cached for all existing directories.
1767         $purifiers = array();
1768         $caches = array();
1769         gc_collect_cycles();
1771         make_localcache_directory('htmlpurifier', false);
1772         check_dir_exists($cachedir);
1773     }
1775     $allowid = empty($options['allowid']) ? 0 : 1;
1776     $allowobjectembed = empty($CFG->allowobjectembed) ? 0 : 1;
1778     $type = 'type_'.$allowid.'_'.$allowobjectembed;
1780     if (!array_key_exists($type, $caches)) {
1781         $caches[$type] = cache::make('core', 'htmlpurifier', array('type' => $type));
1782     }
1783     $cache = $caches[$type];
1785     // Add revision number and all options to the text key so that it is compatible with local cluster node caches.
1786     $key = "|$version|$allowobjectembed|$allowid|$text";
1787     $filteredtext = $cache->get($key);
1789     if ($filteredtext === true) {
1790         // The filtering did not change the text last time, no need to filter anything again.
1791         return $text;
1792     } else if ($filteredtext !== false) {
1793         return $filteredtext;
1794     }
1796     if (empty($purifiers[$type])) {
1797         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1798         require_once $CFG->libdir.'/htmlpurifier/locallib.php';
1799         $config = HTMLPurifier_Config::createDefault();
1801         $config->set('HTML.DefinitionID', 'moodlehtml');
1802         $config->set('HTML.DefinitionRev', 6);
1803         $config->set('Cache.SerializerPath', $cachedir);
1804         $config->set('Cache.SerializerPermissions', $CFG->directorypermissions);
1805         $config->set('Core.NormalizeNewlines', false);
1806         $config->set('Core.ConvertDocumentToFragment', true);
1807         $config->set('Core.Encoding', 'UTF-8');
1808         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1809         $config->set('URI.AllowedSchemes', array(
1810             'http' => true,
1811             'https' => true,
1812             'ftp' => true,
1813             'irc' => true,
1814             'nntp' => true,
1815             'news' => true,
1816             'rtsp' => true,
1817             'rtmp' => true,
1818             'teamspeak' => true,
1819             'gopher' => true,
1820             'mms' => true,
1821             'mailto' => true
1822         ));
1823         $config->set('Attr.AllowedFrameTargets', array('_blank'));
1825         if ($allowobjectembed) {
1826             $config->set('HTML.SafeObject', true);
1827             $config->set('Output.FlashCompat', true);
1828             $config->set('HTML.SafeEmbed', true);
1829         }
1831         if ($allowid) {
1832             $config->set('Attr.EnableID', true);
1833         }
1835         if ($def = $config->maybeGetRawHTMLDefinition()) {
1836             $def->addElement('nolink', 'Block', 'Flow', array());                       // Skip our filters inside.
1837             $def->addElement('tex', 'Inline', 'Inline', array());                       // Tex syntax, equivalent to $$xx$$.
1838             $def->addElement('algebra', 'Inline', 'Inline', array());                   // Algebra syntax, equivalent to @@xx@@.
1839             $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // Original multilang style - only our hacked lang attribute.
1840             $def->addAttribute('span', 'xxxlang', 'CDATA');                             // Current very problematic multilang.
1842             // Media elements.
1843             // https://html.spec.whatwg.org/#the-video-element
1844             $def->addElement('video', 'Block', 'Optional: #PCDATA | Flow | source | track', 'Common', [
1845                 'src' => 'URI',
1846                 'crossorigin' => 'Enum#anonymous,use-credentials',
1847                 'poster' => 'URI',
1848                 'preload' => 'Enum#auto,metadata,none',
1849                 'autoplay' => 'Bool',
1850                 'playsinline' => 'Bool',
1851                 'loop' => 'Bool',
1852                 'muted' => 'Bool',
1853                 'controls' => 'Bool',
1854                 'width' => 'Length',
1855                 'height' => 'Length',
1856             ]);
1857             // https://html.spec.whatwg.org/#the-audio-element
1858             $def->addElement('audio', 'Block', 'Optional: #PCDATA | Flow | source | track', 'Common', [
1859                 'src' => 'URI',
1860                 'crossorigin' => 'Enum#anonymous,use-credentials',
1861                 'preload' => 'Enum#auto,metadata,none',
1862                 'autoplay' => 'Bool',
1863                 'loop' => 'Bool',
1864                 'muted' => 'Bool',
1865                 'controls' => 'Bool'
1866             ]);
1867             // https://html.spec.whatwg.org/#the-source-element
1868             $def->addElement('source', false, 'Empty', null, [
1869                 'src' => 'URI',
1870                 'type' => 'Text'
1871             ]);
1872             // https://html.spec.whatwg.org/#the-track-element
1873             $def->addElement('track', false, 'Empty', null, [
1874                 'src' => 'URI',
1875                 'kind' => 'Enum#subtitles,captions,descriptions,chapters,metadata',
1876                 'srclang' => 'Text',
1877                 'label' => 'Text',
1878                 'default' => 'Bool',
1879             ]);
1881             // Use the built-in Ruby module to add annotation support.
1882             $def->manager->addModule(new HTMLPurifier_HTMLModule_Ruby());
1883         }
1885         $purifier = new HTMLPurifier($config);
1886         $purifiers[$type] = $purifier;
1887     } else {
1888         $purifier = $purifiers[$type];
1889     }
1891     $multilang = (strpos($text, 'class="multilang"') !== false);
1893     $filteredtext = $text;
1894     if ($multilang) {
1895         $filteredtextregex = '/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/';
1896         $filteredtext = preg_replace($filteredtextregex, '<span xxxlang="${2}">', $filteredtext);
1897     }
1898     $filteredtext = (string)$purifier->purify($filteredtext);
1899     if ($multilang) {
1900         $filteredtext = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $filteredtext);
1901     }
1903     if ($text === $filteredtext) {
1904         // No need to store the filtered text, next time we will just return unfiltered text
1905         // because it was not changed by purifying.
1906         $cache->set($key, true);
1907     } else {
1908         $cache->set($key, $filteredtext);
1909     }
1911     return $filteredtext;
1914 /**
1915  * Given plain text, makes it into HTML as nicely as possible.
1916  *
1917  * May contain HTML tags already.
1918  *
1919  * Do not abuse this function. It is intended as lower level formatting feature used
1920  * by {@link format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
1921  * to call format_text() in most of cases.
1922  *
1923  * @param string $text The string to convert.
1924  * @param boolean $smileyignored Was used to determine if smiley characters should convert to smiley images, ignored now
1925  * @param boolean $para If true then the returned string will be wrapped in div tags
1926  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1927  * @return string
1928  */
1929 function text_to_html($text, $smileyignored = null, $para = true, $newlines = true) {
1930     // Remove any whitespace that may be between HTML tags.
1931     $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1933     // Remove any returns that precede or follow HTML tags.
1934     $text = preg_replace("~([\n\r])<~i", " <", $text);
1935     $text = preg_replace("~>([\n\r])~i", "> ", $text);
1937     // Make returns into HTML newlines.
1938     if ($newlines) {
1939         $text = nl2br($text);
1940     }
1942     // Wrap the whole thing in a div if required.
1943     if ($para) {
1944         // In 1.9 this was changed from a p => div.
1945         return '<div class="text_to_html">'.$text.'</div>';
1946     } else {
1947         return $text;
1948     }
1951 /**
1952  * Given Markdown formatted text, make it into XHTML using external function
1953  *
1954  * @param string $text The markdown formatted text to be converted.
1955  * @return string Converted text
1956  */
1957 function markdown_to_html($text) {
1958     global $CFG;
1960     if ($text === '' or $text === null) {
1961         return $text;
1962     }
1964     require_once($CFG->libdir .'/markdown/MarkdownInterface.php');
1965     require_once($CFG->libdir .'/markdown/Markdown.php');
1966     require_once($CFG->libdir .'/markdown/MarkdownExtra.php');
1968     return \Michelf\MarkdownExtra::defaultTransform($text);
1971 /**
1972  * Given HTML text, make it into plain text using external function
1973  *
1974  * @param string $html The text to be converted.
1975  * @param integer $width Width to wrap the text at. (optional, default 75 which
1976  *      is a good value for email. 0 means do not limit line length.)
1977  * @param boolean $dolinks By default, any links in the HTML are collected, and
1978  *      printed as a list at the end of the HTML. If you don't want that, set this
1979  *      argument to false.
1980  * @return string plain text equivalent of the HTML.
1981  */
1982 function html_to_text($html, $width = 75, $dolinks = true) {
1983     global $CFG;
1985     require_once($CFG->libdir .'/html2text/lib.php');
1987     $options = array(
1988         'width'     => $width,
1989         'do_links'  => 'table',
1990     );
1992     if (empty($dolinks)) {
1993         $options['do_links'] = 'none';
1994     }
1995     $h2t = new core_html2text($html, $options);
1996     $result = $h2t->getText();
1998     return $result;
2001 /**
2002  * Converts texts or strings to plain text.
2003  *
2004  * - When used to convert user input introduced in an editor the text format needs to be passed in $contentformat like we usually
2005  *   do in format_text.
2006  * - When this function is used for strings that are usually passed through format_string before displaying them
2007  *   we need to set $contentformat to false. This will execute html_to_text as these strings can contain multilang tags if
2008  *   multilang filter is applied to headings.
2009  *
2010  * @param string $content The text as entered by the user
2011  * @param int|false $contentformat False for strings or the text format: FORMAT_MOODLE/FORMAT_HTML/FORMAT_PLAIN/FORMAT_MARKDOWN
2012  * @return string Plain text.
2013  */
2014 function content_to_text($content, $contentformat) {
2016     switch ($contentformat) {
2017         case FORMAT_PLAIN:
2018             // Nothing here.
2019             break;
2020         case FORMAT_MARKDOWN:
2021             $content = markdown_to_html($content);
2022             $content = html_to_text($content, 75, false);
2023             break;
2024         default:
2025             // FORMAT_HTML, FORMAT_MOODLE and $contentformat = false, the later one are strings usually formatted through
2026             // format_string, we need to convert them from html because they can contain HTML (multilang filter).
2027             $content = html_to_text($content, 75, false);
2028     }
2030     return trim($content, "\r\n ");
2033 /**
2034  * This function will highlight search words in a given string
2035  *
2036  * It cares about HTML and will not ruin links.  It's best to use
2037  * this function after performing any conversions to HTML.
2038  *
2039  * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
2040  * @param string $haystack The string (HTML) within which to highlight the search terms.
2041  * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
2042  * @param string $prefix the string to put before each search term found.
2043  * @param string $suffix the string to put after each search term found.
2044  * @return string The highlighted HTML.
2045  */
2046 function highlight($needle, $haystack, $matchcase = false,
2047         $prefix = '<span class="highlight">', $suffix = '</span>') {
2049     // Quick bail-out in trivial cases.
2050     if (empty($needle) or empty($haystack)) {
2051         return $haystack;
2052     }
2054     // Break up the search term into words, discard any -words and build a regexp.
2055     $words = preg_split('/ +/', trim($needle));
2056     foreach ($words as $index => $word) {
2057         if (strpos($word, '-') === 0) {
2058             unset($words[$index]);
2059         } else if (strpos($word, '+') === 0) {
2060             $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
2061         } else {
2062             $words[$index] = preg_quote($word, '/');
2063         }
2064     }
2065     $regexp = '/(' . implode('|', $words) . ')/u'; // Char u is to do UTF-8 matching.
2066     if (!$matchcase) {
2067         $regexp .= 'i';
2068     }
2070     // Another chance to bail-out if $search was only -words.
2071     if (empty($words)) {
2072         return $haystack;
2073     }
2075     // Split the string into HTML tags and real content.
2076     $chunks = preg_split('/((?:<[^>]*>)+)/', $haystack, -1, PREG_SPLIT_DELIM_CAPTURE);
2078     // We have an array of alternating blocks of text, then HTML tags, then text, ...
2079     // Loop through replacing search terms in the text, and leaving the HTML unchanged.
2080     $ishtmlchunk = false;
2081     $result = '';
2082     foreach ($chunks as $chunk) {
2083         if ($ishtmlchunk) {
2084             $result .= $chunk;
2085         } else {
2086             $result .= preg_replace($regexp, $prefix . '$1' . $suffix, $chunk);
2087         }
2088         $ishtmlchunk = !$ishtmlchunk;
2089     }
2091     return $result;
2094 /**
2095  * This function will highlight instances of $needle in $haystack
2096  *
2097  * It's faster that the above function {@link highlight()} and doesn't care about
2098  * HTML or anything.
2099  *
2100  * @param string $needle The string to search for
2101  * @param string $haystack The string to search for $needle in
2102  * @return string The highlighted HTML
2103  */
2104 function highlightfast($needle, $haystack) {
2106     if (empty($needle) or empty($haystack)) {
2107         return $haystack;
2108     }
2110     $parts = explode(core_text::strtolower($needle), core_text::strtolower($haystack));
2112     if (count($parts) === 1) {
2113         return $haystack;
2114     }
2116     $pos = 0;
2118     foreach ($parts as $key => $part) {
2119         $parts[$key] = substr($haystack, $pos, strlen($part));
2120         $pos += strlen($part);
2122         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
2123         $pos += strlen($needle);
2124     }
2126     return str_replace('<span class="highlight"></span>', '', join('', $parts));
2129 /**
2130  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
2131  *
2132  * Internationalisation, for print_header and backup/restorelib.
2133  *
2134  * @param bool $dir Default false
2135  * @return string Attributes
2136  */
2137 function get_html_lang($dir = false) {
2138     $direction = '';
2139     if ($dir) {
2140         if (right_to_left()) {
2141             $direction = ' dir="rtl"';
2142         } else {
2143             $direction = ' dir="ltr"';
2144         }
2145     }
2146     // Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
2147     $language = str_replace('_', '-', current_language());
2148     @header('Content-Language: '.$language);
2149     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
2153 // STANDARD WEB PAGE PARTS.
2155 /**
2156  * Send the HTTP headers that Moodle requires.
2157  *
2158  * There is a backwards compatibility hack for legacy code
2159  * that needs to add custom IE compatibility directive.
2160  *
2161  * Example:
2162  * <code>
2163  * if (!isset($CFG->additionalhtmlhead)) {
2164  *     $CFG->additionalhtmlhead = '';
2165  * }
2166  * $CFG->additionalhtmlhead .= '<meta http-equiv="X-UA-Compatible" content="IE=8" />';
2167  * header('X-UA-Compatible: IE=8');
2168  * echo $OUTPUT->header();
2169  * </code>
2170  *
2171  * Please note the $CFG->additionalhtmlhead alone might not work,
2172  * you should send the IE compatibility header() too.
2173  *
2174  * @param string $contenttype
2175  * @param bool $cacheable Can this page be cached on back?
2176  * @return void, sends HTTP headers
2177  */
2178 function send_headers($contenttype, $cacheable = true) {
2179     global $CFG;
2181     @header('Content-Type: ' . $contenttype);
2182     @header('Content-Script-Type: text/javascript');
2183     @header('Content-Style-Type: text/css');
2185     if (empty($CFG->additionalhtmlhead) or stripos($CFG->additionalhtmlhead, 'X-UA-Compatible') === false) {
2186         @header('X-UA-Compatible: IE=edge');
2187     }
2189     if ($cacheable) {
2190         // Allow caching on "back" (but not on normal clicks).
2191         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0, no-transform');
2192         @header('Pragma: no-cache');
2193         @header('Expires: ');
2194     } else {
2195         // Do everything we can to always prevent clients and proxies caching.
2196         @header('Cache-Control: no-store, no-cache, must-revalidate');
2197         @header('Cache-Control: post-check=0, pre-check=0, no-transform', false);
2198         @header('Pragma: no-cache');
2199         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2200         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2201     }
2202     @header('Accept-Ranges: none');
2204     if (empty($CFG->allowframembedding)) {
2205         @header('X-Frame-Options: sameorigin');
2206     }
2209 /**
2210  * Return the right arrow with text ('next'), and optionally embedded in a link.
2211  *
2212  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2213  * @param string $url An optional link to use in a surrounding HTML anchor.
2214  * @param bool $accesshide True if text should be hidden (for screen readers only).
2215  * @param string $addclass Additional class names for the link, or the arrow character.
2216  * @return string HTML string.
2217  */
2218 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
2219     global $OUTPUT; // TODO: move to output renderer.
2220     $arrowclass = 'arrow ';
2221     if (!$url) {
2222         $arrowclass .= $addclass;
2223     }
2224     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
2225     $htmltext = '';
2226     if ($text) {
2227         $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
2228         if ($accesshide) {
2229             $htmltext = get_accesshide($htmltext);
2230         }
2231     }
2232     if ($url) {
2233         $class = 'arrow_link';
2234         if ($addclass) {
2235             $class .= ' '.$addclass;
2236         }
2237         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/', '', $text).'">'.$htmltext.$arrow.'</a>';
2238     }
2239     return $htmltext.$arrow;
2242 /**
2243  * Return the left arrow with text ('previous'), and optionally embedded in a link.
2244  *
2245  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2246  * @param string $url An optional link to use in a surrounding HTML anchor.
2247  * @param bool $accesshide True if text should be hidden (for screen readers only).
2248  * @param string $addclass Additional class names for the link, or the arrow character.
2249  * @return string HTML string.
2250  */
2251 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
2252     global $OUTPUT; // TODO: move to utput renderer.
2253     $arrowclass = 'arrow ';
2254     if (! $url) {
2255         $arrowclass .= $addclass;
2256     }
2257     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
2258     $htmltext = '';
2259     if ($text) {
2260         $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
2261         if ($accesshide) {
2262             $htmltext = get_accesshide($htmltext);
2263         }
2264     }
2265     if ($url) {
2266         $class = 'arrow_link';
2267         if ($addclass) {
2268             $class .= ' '.$addclass;
2269         }
2270         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/', '', $text).'">'.$arrow.$htmltext.'</a>';
2271     }
2272     return $arrow.$htmltext;
2275 /**
2276  * Return a HTML element with the class "accesshide", for accessibility.
2277  *
2278  * Please use cautiously - where possible, text should be visible!
2279  *
2280  * @param string $text Plain text.
2281  * @param string $elem Lowercase element name, default "span".
2282  * @param string $class Additional classes for the element.
2283  * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
2284  * @return string HTML string.
2285  */
2286 function get_accesshide($text, $elem='span', $class='', $attrs='') {
2287     return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
2290 /**
2291  * Return the breadcrumb trail navigation separator.
2292  *
2293  * @return string HTML string.
2294  */
2295 function get_separator() {
2296     // Accessibility: the 'hidden' slash is preferred for screen readers.
2297     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
2300 /**
2301  * Print (or return) a collapsible region, that has a caption that can be clicked to expand or collapse the region.
2302  *
2303  * If JavaScript is off, then the region will always be expanded.
2304  *
2305  * @param string $contents the contents of the box.
2306  * @param string $classes class names added to the div that is output.
2307  * @param string $id id added to the div that is output. Must not be blank.
2308  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2309  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2310  *      (May be blank if you do not wish the state to be persisted.
2311  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2312  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2313  * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
2314  */
2315 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2316     $output  = print_collapsible_region_start($classes, $id, $caption, $userpref, $default, true);
2317     $output .= $contents;
2318     $output .= print_collapsible_region_end(true);
2320     if ($return) {
2321         return $output;
2322     } else {
2323         echo $output;
2324     }
2327 /**
2328  * Print (or return) the start of a collapsible region
2329  *
2330  * The collapsibleregion has a caption that can be clicked to expand or collapse the region. If JavaScript is off, then the region
2331  * will always be expanded.
2332  *
2333  * @param string $classes class names added to the div that is output.
2334  * @param string $id id added to the div that is output. Must not be blank.
2335  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2336  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2337  *      (May be blank if you do not wish the state to be persisted.
2338  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2339  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2340  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2341  */
2342 function print_collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2343     global $PAGE;
2345     // Work out the initial state.
2346     if (!empty($userpref) and is_string($userpref)) {
2347         user_preference_allow_ajax_update($userpref, PARAM_BOOL);
2348         $collapsed = get_user_preferences($userpref, $default);
2349     } else {
2350         $collapsed = $default;
2351         $userpref = false;
2352     }
2354     if ($collapsed) {
2355         $classes .= ' collapsed';
2356     }
2358     $output = '';
2359     $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2360     $output .= '<div id="' . $id . '_sizer">';
2361     $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2362     $output .= $caption . ' ';
2363     $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2364     $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2366     if ($return) {
2367         return $output;
2368     } else {
2369         echo $output;
2370     }
2373 /**
2374  * Close a region started with print_collapsible_region_start.
2375  *
2376  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2377  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2378  */
2379 function print_collapsible_region_end($return = false) {
2380     $output = '</div></div></div>';
2382     if ($return) {
2383         return $output;
2384     } else {
2385         echo $output;
2386     }
2389 /**
2390  * Print a specified group's avatar.
2391  *
2392  * @param array|stdClass $group A single {@link group} object OR array of groups.
2393  * @param int $courseid The course ID.
2394  * @param boolean $large Default small picture, or large.
2395  * @param boolean $return If false print picture, otherwise return the output as string
2396  * @param boolean $link Enclose image in a link to view specified course?
2397  * @return string|void Depending on the setting of $return
2398  */
2399 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2400     global $CFG;
2402     if (is_array($group)) {
2403         $output = '';
2404         foreach ($group as $g) {
2405             $output .= print_group_picture($g, $courseid, $large, true, $link);
2406         }
2407         if ($return) {
2408             return $output;
2409         } else {
2410             echo $output;
2411             return;
2412         }
2413     }
2415     $context = context_course::instance($courseid);
2417     // If there is no picture, do nothing.
2418     if (!$group->picture) {
2419         return '';
2420     }
2422     // If picture is hidden, only show to those with course:managegroups.
2423     if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
2424         return '';
2425     }
2427     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2428         $output = '<a href="'. $CFG->wwwroot .'/user/index.php?id='. $courseid .'&amp;group='. $group->id .'">';
2429     } else {
2430         $output = '';
2431     }
2432     if ($large) {
2433         $file = 'f1';
2434     } else {
2435         $file = 'f2';
2436     }
2438     $grouppictureurl = moodle_url::make_pluginfile_url($context->id, 'group', 'icon', $group->id, '/', $file);
2439     $grouppictureurl->param('rev', $group->picture);
2440     $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2441         ' alt="'.s(get_string('group').' '.$group->name).'" title="'.s($group->name).'"/>';
2443     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2444         $output .= '</a>';
2445     }
2447     if ($return) {
2448         return $output;
2449     } else {
2450         echo $output;
2451     }
2455 /**
2456  * Display a recent activity note
2457  *
2458  * @staticvar string $strftimerecent
2459  * @param int $time A timestamp int.
2460  * @param stdClass $user A user object from the database.
2461  * @param string $text Text for display for the note
2462  * @param string $link The link to wrap around the text
2463  * @param bool $return If set to true the HTML is returned rather than echo'd
2464  * @param string $viewfullnames
2465  * @return string If $retrun was true returns HTML for a recent activity notice.
2466  */
2467 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2468     static $strftimerecent = null;
2469     $output = '';
2471     if (is_null($viewfullnames)) {
2472         $context = context_system::instance();
2473         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2474     }
2476     if (is_null($strftimerecent)) {
2477         $strftimerecent = get_string('strftimerecent');
2478     }
2480     $output .= '<div class="head">';
2481     $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2482     $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2483     $output .= '</div>';
2484     $output .= '<div class="info"><a href="'.$link.'">'.format_string($text, true).'</a></div>';
2486     if ($return) {
2487         return $output;
2488     } else {
2489         echo $output;
2490     }
2493 /**
2494  * Returns a popup menu with course activity modules
2495  *
2496  * Given a course this function returns a small popup menu with all the course activity modules in it, as a navigation menu
2497  * outputs a simple list structure in XHTML.
2498  * The data is taken from the serialised array stored in the course record.
2499  *
2500  * @param course $course A {@link $COURSE} object.
2501  * @param array $sections
2502  * @param course_modinfo $modinfo
2503  * @param string $strsection
2504  * @param string $strjumpto
2505  * @param int $width
2506  * @param string $cmid
2507  * @return string The HTML block
2508  */
2509 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2511     global $CFG, $OUTPUT;
2513     $section = -1;
2514     $menu = array();
2515     $doneheading = false;
2517     $courseformatoptions = course_get_format($course)->get_format_options();
2518     $coursecontext = context_course::instance($course->id);
2520     $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2521     foreach ($modinfo->cms as $mod) {
2522         if (!$mod->has_view()) {
2523             // Don't show modules which you can't link to!
2524             continue;
2525         }
2527         // For course formats using 'numsections' do not show extra sections.
2528         if (isset($courseformatoptions['numsections']) && $mod->sectionnum > $courseformatoptions['numsections']) {
2529             break;
2530         }
2532         if (!$mod->uservisible) { // Do not icnlude empty sections at all.
2533             continue;
2534         }
2536         if ($mod->sectionnum >= 0 and $section != $mod->sectionnum) {
2537             $thissection = $sections[$mod->sectionnum];
2539             if ($thissection->visible or
2540                     (isset($courseformatoptions['hiddensections']) and !$courseformatoptions['hiddensections']) or
2541                     has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2542                 $thissection->summary = strip_tags(format_string($thissection->summary, true));
2543                 if (!$doneheading) {
2544                     $menu[] = '</ul></li>';
2545                 }
2546                 if ($course->format == 'weeks' or empty($thissection->summary)) {
2547                     $item = $strsection ." ". $mod->sectionnum;
2548                 } else {
2549                     if (core_text::strlen($thissection->summary) < ($width-3)) {
2550                         $item = $thissection->summary;
2551                     } else {
2552                         $item = core_text::substr($thissection->summary, 0, $width).'...';
2553                     }
2554                 }
2555                 $menu[] = '<li class="section"><span>'.$item.'</span>';
2556                 $menu[] = '<ul>';
2557                 $doneheading = true;
2559                 $section = $mod->sectionnum;
2560             } else {
2561                 // No activities from this hidden section shown.
2562                 continue;
2563             }
2564         }
2566         $url = $mod->modname .'/view.php?id='. $mod->id;
2567         $mod->name = strip_tags(format_string($mod->name ,true));
2568         if (core_text::strlen($mod->name) > ($width+5)) {
2569             $mod->name = core_text::substr($mod->name, 0, $width).'...';
2570         }
2571         if (!$mod->visible) {
2572             $mod->name = '('.$mod->name.')';
2573         }
2574         $class = 'activity '.$mod->modname;
2575         $class .= ($cmid == $mod->id) ? ' selected' : '';
2576         $menu[] = '<li class="'.$class.'">'.
2577                   $OUTPUT->image_icon('icon', '', $mod->modname).
2578                   '<a href="'.$CFG->wwwroot.'/mod/'.$url.'">'.$mod->name.'</a></li>';
2579     }
2581     if ($doneheading) {
2582         $menu[] = '</ul></li>';
2583     }
2584     $menu[] = '</ul></li></ul>';
2586     return implode("\n", $menu);
2589 /**
2590  * Prints a grade menu (as part of an existing form) with help showing all possible numerical grades and scales.
2591  *
2592  * @todo Finish documenting this function
2593  * @todo Deprecate: this is only used in a few contrib modules
2594  *
2595  * @param int $courseid The course ID
2596  * @param string $name
2597  * @param string $current
2598  * @param boolean $includenograde Include those with no grades
2599  * @param boolean $return If set to true returns rather than echo's
2600  * @return string|bool Depending on value of $return
2601  */
2602 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2603     global $OUTPUT;
2605     $output = '';
2606     $strscale = get_string('scale');
2607     $strscales = get_string('scales');
2609     $scales = get_scales_menu($courseid);
2610     foreach ($scales as $i => $scalename) {
2611         $grades[-$i] = $strscale .': '. $scalename;
2612     }
2613     if ($includenograde) {
2614         $grades[0] = get_string('nograde');
2615     }
2616     for ($i=100; $i>=1; $i--) {
2617         $grades[$i] = $i;
2618     }
2619     $output .= html_writer::select($grades, $name, $current, false);
2621     $linkobject = '<span class="helplink">' . $OUTPUT->pix_icon('help', $strscales) . '</span>';
2622     $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => 1));
2623     $action = new popup_action('click', $link, 'ratingscales', array('height' => 400, 'width' => 500));
2624     $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title' => $strscales));
2626     if ($return) {
2627         return $output;
2628     } else {
2629         echo $output;
2630     }
2633 /**
2634  * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2635  *
2636  * Default errorcode is 1.
2637  *
2638  * Very useful for perl-like error-handling:
2639  * do_somethting() or mdie("Something went wrong");
2640  *
2641  * @param string  $msg       Error message
2642  * @param integer $errorcode Error code to emit
2643  */
2644 function mdie($msg='', $errorcode=1) {
2645     trigger_error($msg);
2646     exit($errorcode);
2649 /**
2650  * Print a message and exit.
2651  *
2652  * @param string $message The message to print in the notice
2653  * @param string $link The link to use for the continue button
2654  * @param object $course A course object. Unused.
2655  * @return void This function simply exits
2656  */
2657 function notice ($message, $link='', $course=null) {
2658     global $PAGE, $OUTPUT;
2660     $message = clean_text($message);   // In case nasties are in here.
2662     if (CLI_SCRIPT) {
2663         echo("!!$message!!\n");
2664         exit(1); // No success.
2665     }
2667     if (!$PAGE->headerprinted) {
2668         // Header not yet printed.
2669         $PAGE->set_title(get_string('notice'));
2670         echo $OUTPUT->header();
2671     } else {
2672         echo $OUTPUT->container_end_all(false);
2673     }
2675     echo $OUTPUT->box($message, 'generalbox', 'notice');
2676     echo $OUTPUT->continue_button($link);
2678     echo $OUTPUT->footer();
2679     exit(1); // General error code.
2682 /**
2683  * Redirects the user to another page, after printing a notice.
2684  *
2685  * This function calls the OUTPUT redirect method, echo's the output and then dies to ensure nothing else happens.
2686  *
2687  * <strong>Good practice:</strong> You should call this method before starting page
2688  * output by using any of the OUTPUT methods.
2689  *
2690  * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2691  * @param string $message The message to display to the user
2692  * @param int $delay The delay before redirecting
2693  * @param string $messagetype The type of notification to show the message in. See constants on \core\output\notification.
2694  * @throws moodle_exception
2695  */
2696 function redirect($url, $message='', $delay=null, $messagetype = \core\output\notification::NOTIFY_INFO) {
2697     global $OUTPUT, $PAGE, $CFG;
2699     if (CLI_SCRIPT or AJAX_SCRIPT) {
2700         // This is wrong - developers should not use redirect in these scripts but it should not be very likely.
2701         throw new moodle_exception('redirecterrordetected', 'error');
2702     }
2704     if ($delay === null) {
2705         $delay = -1;
2706     }
2708     // Prevent debug errors - make sure context is properly initialised.
2709     if ($PAGE) {
2710         $PAGE->set_context(null);
2711         $PAGE->set_pagelayout('redirect');  // No header and footer needed.
2712         $PAGE->set_title(get_string('pageshouldredirect', 'moodle'));
2713     }
2715     if ($url instanceof moodle_url) {
2716         $url = $url->out(false);
2717     }
2719     $debugdisableredirect = false;
2720     do {
2721         if (defined('DEBUGGING_PRINTED')) {
2722             // Some debugging already printed, no need to look more.
2723             $debugdisableredirect = true;
2724             break;
2725         }
2727         if (core_useragent::is_msword()) {
2728             // Clicking a URL from MS Word sends a request to the server without cookies. If that
2729             // causes a redirect Word will open a browser pointing the new URL. If not, the URL that
2730             // was clicked is opened. Because the request from Word is without cookies, it almost
2731             // always results in a redirect to the login page, even if the user is logged in in their
2732             // browser. This is not what we want, so prevent the redirect for requests from Word.
2733             $debugdisableredirect = true;
2734             break;
2735         }
2737         if (empty($CFG->debugdisplay) or empty($CFG->debug)) {
2738             // No errors should be displayed.
2739             break;
2740         }
2742         if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2743             break;
2744         }
2746         if (!($lasterror['type'] & $CFG->debug)) {
2747             // Last error not interesting.
2748             break;
2749         }
2751         // Watch out here, @hidden() errors are returned from error_get_last() too.
2752         if (headers_sent()) {
2753             // We already started printing something - that means errors likely printed.
2754             $debugdisableredirect = true;
2755             break;
2756         }
2758         if (ob_get_level() and ob_get_contents()) {
2759             // There is something waiting to be printed, hopefully it is the errors,
2760             // but it might be some error hidden by @ too - such as the timezone mess from setup.php.
2761             $debugdisableredirect = true;
2762             break;
2763         }
2764     } while (false);
2766     // Technically, HTTP/1.1 requires Location: header to contain the absolute path.
2767     // (In practice browsers accept relative paths - but still, might as well do it properly.)
2768     // This code turns relative into absolute.
2769     if (!preg_match('|^[a-z]+:|i', $url)) {
2770         // Get host name http://www.wherever.com.
2771         $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2772         if (preg_match('|^/|', $url)) {
2773             // URLs beginning with / are relative to web server root so we just add them in.
2774             $url = $hostpart.$url;
2775         } else {
2776             // URLs not beginning with / are relative to path of current script, so add that on.
2777             $url = $hostpart.preg_replace('|\?.*$|', '', me()).'/../'.$url;
2778         }
2779         // Replace all ..s.
2780         while (true) {
2781             $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2782             if ($newurl == $url) {
2783                 break;
2784             }
2785             $url = $newurl;
2786         }
2787     }
2789     // Sanitise url - we can not rely on moodle_url or our URL cleaning
2790     // because they do not support all valid external URLs.
2791     $url = preg_replace('/[\x00-\x1F\x7F]/', '', $url);
2792     $url = str_replace('"', '%22', $url);
2793     $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2794     $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />', FORMAT_HTML));
2795     $url = str_replace('&amp;', '&', $encodedurl);
2797     if (!empty($message)) {
2798         if (!$debugdisableredirect && !headers_sent()) {
2799             // A message has been provided, and the headers have not yet been sent.
2800             // Display the message as a notification on the subsequent page.
2801             \core\notification::add($message, $messagetype);
2802             $message = null;
2803             $delay = 0;
2804         } else {
2805             if ($delay === -1 || !is_numeric($delay)) {
2806                 $delay = 3;
2807             }
2808             $message = clean_text($message);
2809         }
2810     } else {
2811         $message = get_string('pageshouldredirect');
2812         $delay = 0;
2813     }
2815     // Make sure the session is closed properly, this prevents problems in IIS
2816     // and also some potential PHP shutdown issues.
2817     \core\session\manager::write_close();
2819     if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2820         // 302 might not work for POST requests, 303 is ignored by obsolete clients.
2821         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2822         @header('Location: '.$url);
2823         echo bootstrap_renderer::plain_redirect_message($encodedurl);
2824         exit;
2825     }
2827     // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2828     if ($PAGE) {
2829         $CFG->docroot = false; // To prevent the link to moodle docs from being displayed on redirect page.
2830         echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect, $messagetype);
2831         exit;
2832     } else {
2833         echo bootstrap_renderer::early_redirect_message($encodedurl, $message, $delay);
2834         exit;
2835     }
2838 /**
2839  * Given an email address, this function will return an obfuscated version of it.
2840  *
2841  * @param string $email The email address to obfuscate
2842  * @return string The obfuscated email address
2843  */
2844 function obfuscate_email($email) {
2845     $i = 0;
2846     $length = strlen($email);
2847     $obfuscated = '';
2848     while ($i < $length) {
2849         if (rand(0, 2) && $email{$i}!='@') { // MDL-20619 some browsers have problems unobfuscating @.
2850             $obfuscated.='%'.dechex(ord($email{$i}));
2851         } else {
2852             $obfuscated.=$email{$i};
2853         }
2854         $i++;
2855     }
2856     return $obfuscated;
2859 /**
2860  * This function takes some text and replaces about half of the characters
2861  * with HTML entity equivalents.   Return string is obviously longer.
2862  *
2863  * @param string $plaintext The text to be obfuscated
2864  * @return string The obfuscated text
2865  */
2866 function obfuscate_text($plaintext) {
2867     $i=0;
2868     $length = core_text::strlen($plaintext);
2869     $obfuscated='';
2870     $prevobfuscated = false;
2871     while ($i < $length) {
2872         $char = core_text::substr($plaintext, $i, 1);
2873         $ord = core_text::utf8ord($char);
2874         $numerical = ($ord >= ord('0')) && ($ord <= ord('9'));
2875         if ($prevobfuscated and $numerical ) {
2876             $obfuscated.='&#'.$ord.';';
2877         } else if (rand(0, 2)) {
2878             $obfuscated.='&#'.$ord.';';
2879             $prevobfuscated = true;
2880         } else {
2881             $obfuscated.=$char;
2882             $prevobfuscated = false;
2883         }
2884         $i++;
2885     }
2886     return $obfuscated;
2889 /**
2890  * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2891  * to generate a fully obfuscated email link, ready to use.
2892  *
2893  * @param string $email The email address to display
2894  * @param string $label The text to displayed as hyperlink to $email
2895  * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2896  * @param string $subject The subject of the email in the mailto link
2897  * @param string $body The content of the email in the mailto link
2898  * @return string The obfuscated mailto link
2899  */
2900 function obfuscate_mailto($email, $label='', $dimmed=false, $subject = '', $body = '') {
2902     if (empty($label)) {
2903         $label = $email;
2904     }
2906     $label = obfuscate_text($label);
2907     $email = obfuscate_email($email);
2908     $mailto = obfuscate_text('mailto');
2909     $url = new moodle_url("mailto:$email");
2910     $attrs = array();
2912     if (!empty($subject)) {
2913         $url->param('subject', format_string($subject));
2914     }
2915     if (!empty($body)) {
2916         $url->param('body', format_string($body));
2917     }
2919     // Use the obfuscated mailto.
2920     $url = preg_replace('/^mailto/', $mailto, $url->out());
2922     if ($dimmed) {
2923         $attrs['title'] = get_string('emaildisable');
2924         $attrs['class'] = 'dimmed';
2925     }
2927     return html_writer::link($url, $label, $attrs);
2930 /**
2931  * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2932  * will transform it to html entities
2933  *
2934  * @param string $text Text to search for nolink tag in
2935  * @return string
2936  */
2937 function rebuildnolinktag($text) {
2939     $text = preg_replace('/&lt;(\/*nolink)&gt;/i', '<$1>', $text);
2941     return $text;
2944 /**
2945  * Prints a maintenance message from $CFG->maintenance_message or default if empty.
2946  */
2947 function print_maintenance_message() {
2948     global $CFG, $SITE, $PAGE, $OUTPUT;
2950     header($_SERVER['SERVER_PROTOCOL'] . ' 503 Moodle under maintenance');
2951     header('Status: 503 Moodle under maintenance');
2952     header('Retry-After: 300');
2954     $PAGE->set_pagetype('maintenance-message');
2955     $PAGE->set_pagelayout('maintenance');
2956     $PAGE->set_title(strip_tags($SITE->fullname));
2957     $PAGE->set_heading($SITE->fullname);
2958     echo $OUTPUT->header();
2959     echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2960     if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
2961         echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2962         echo $CFG->maintenance_message;
2963         echo $OUTPUT->box_end();
2964     }
2965     echo $OUTPUT->footer();
2966     die;
2969 /**
2970  * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2971  *
2972  * It is not recommended to use this function in Moodle 2.5 but it is left for backward
2973  * compartibility.
2974  *
2975  * Example how to print a single line tabs:
2976  * $rows = array(
2977  *    new tabobject(...),
2978  *    new tabobject(...)
2979  * );
2980  * echo $OUTPUT->tabtree($rows, $selectedid);
2981  *
2982  * Multiple row tabs may not look good on some devices but if you want to use them
2983  * you can specify ->subtree for the active tabobject.
2984  *
2985  * @param array $tabrows An array of rows where each row is an array of tab objects
2986  * @param string $selected  The id of the selected tab (whatever row it's on)
2987  * @param array  $inactive  An array of ids of inactive tabs that are not selectable.
2988  * @param array  $activated An array of ids of other tabs that are currently activated
2989  * @param bool $return If true output is returned rather then echo'd
2990  * @return string HTML output if $return was set to true.
2991  */
2992 function print_tabs($tabrows, $selected = null, $inactive = null, $activated = null, $return = false) {
2993     global $OUTPUT;
2995     $tabrows = array_reverse($tabrows);
2996     $subtree = array();
2997     foreach ($tabrows as $row) {
2998         $tree = array();
3000         foreach ($row as $tab) {
3001             $tab->inactive = is_array($inactive) && in_array((string)$tab->id, $inactive);
3002             $tab->activated = is_array($activated) && in_array((string)$tab->id, $activated);
3003             $tab->selected = (string)$tab->id == $selected;
3005             if ($tab->activated || $tab->selected) {
3006                 $tab->subtree = $subtree;
3007             }
3008             $tree[] = $tab;
3009         }
3010         $subtree = $tree;
3011     }
3012     $output = $OUTPUT->tabtree($subtree);
3013     if ($return) {
3014         return $output;
3015     } else {
3016         print $output;
3017         return !empty($output);
3018     }
3021 /**
3022  * Alter debugging level for the current request,
3023  * the change is not saved in database.
3024  *
3025  * @param int $level one of the DEBUG_* constants
3026  * @param bool $debugdisplay
3027  */
3028 function set_debugging($level, $debugdisplay = null) {
3029     global $CFG;
3031     $CFG->debug = (int)$level;
3032     $CFG->debugdeveloper = (($CFG->debug & DEBUG_DEVELOPER) === DEBUG_DEVELOPER);
3034     if ($debugdisplay !== null) {
3035         $CFG->debugdisplay = (bool)$debugdisplay;
3036     }
3039 /**
3040  * Standard Debugging Function
3041  *
3042  * Returns true if the current site debugging settings are equal or above specified level.
3043  * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
3044  * routing of notices is controlled by $CFG->debugdisplay
3045  * eg use like this:
3046  *
3047  * 1)  debugging('a normal debug notice');
3048  * 2)  debugging('something really picky', DEBUG_ALL);
3049  * 3)  debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
3050  * 4)  if (debugging()) { perform extra debugging operations (do not use print or echo) }
3051  *
3052  * In code blocks controlled by debugging() (such as example 4)
3053  * any output should be routed via debugging() itself, or the lower-level
3054  * trigger_error() or error_log(). Using echo or print will break XHTML
3055  * JS and HTTP headers.
3056  *
3057  * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
3058  *
3059  * @param string $message a message to print
3060  * @param int $level the level at which this debugging statement should show
3061  * @param array $backtrace use different backtrace
3062  * @return bool
3063  */
3064 function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
3065     global $CFG, $USER;
3067     $forcedebug = false;
3068     if (!empty($CFG->debugusers) && $USER) {
3069         $debugusers = explode(',', $CFG->debugusers);
3070         $forcedebug = in_array($USER->id, $debugusers);
3071     }
3073     if (!$forcedebug and (empty($CFG->debug) || ($CFG->debug != -1 and $CFG->debug < $level))) {
3074         return false;
3075     }
3077     if (!isset($CFG->debugdisplay)) {
3078         $CFG->debugdisplay = ini_get_bool('display_errors');
3079     }
3081     if ($message) {
3082         if (!$backtrace) {
3083             $backtrace = debug_backtrace();
3084         }
3085         $from = format_backtrace($backtrace, CLI_SCRIPT || NO_DEBUG_DISPLAY);
3086         if (PHPUNIT_TEST) {
3087             if (phpunit_util::debugging_triggered($message, $level, $from)) {
3088                 // We are inside test, the debug message was logged.
3089                 return true;
3090             }
3091         }
3093         if (NO_DEBUG_DISPLAY) {
3094             // Script does not want any errors or debugging in output,
3095             // we send the info to error log instead.
3096             error_log('Debugging: ' . $message . ' in '. PHP_EOL . $from);
3098         } else if ($forcedebug or $CFG->debugdisplay) {
3099             if (!defined('DEBUGGING_PRINTED')) {
3100                 define('DEBUGGING_PRINTED', 1); // Indicates we have printed something.
3101             }
3102             if (CLI_SCRIPT) {
3103                 echo "++ $message ++\n$from";
3104             } else {
3105                 echo '<div class="notifytiny debuggingmessage" data-rel="debugging">' , $message , $from , '</div>';
3106             }
3108         } else {
3109             trigger_error($message . $from, E_USER_NOTICE);
3110         }
3111     }
3112     return true;
3115 /**
3116  * Outputs a HTML comment to the browser.
3117  *
3118  * This is used for those hard-to-debug pages that use bits from many different files in very confusing ways (e.g. blocks).
3119  *
3120  * <code>print_location_comment(__FILE__, __LINE__);</code>
3121  *
3122  * @param string $file
3123  * @param integer $line
3124  * @param boolean $return Whether to return or print the comment
3125  * @return string|void Void unless true given as third parameter
3126  */
3127 function print_location_comment($file, $line, $return = false) {
3128     if ($return) {
3129         return "<!-- $file at line $line -->\n";
3130     } else {
3131         echo "<!-- $file at line $line -->\n";
3132     }
3136 /**
3137  * Returns true if the user is using a right-to-left language.
3138  *
3139  * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
3140  */
3141 function right_to_left() {
3142     return (get_string('thisdirection', 'langconfig') === 'rtl');
3146 /**
3147  * Returns swapped left<=> right if in RTL environment.
3148  *
3149  * Part of RTL Moodles support.
3150  *
3151  * @param string $align align to check
3152  * @return string
3153  */
3154 function fix_align_rtl($align) {
3155     if (!right_to_left()) {
3156         return $align;
3157     }
3158     if ($align == 'left') {
3159         return 'right';
3160     }
3161     if ($align == 'right') {
3162         return 'left';
3163     }
3164     return $align;
3168 /**
3169  * Returns true if the page is displayed in a popup window.
3170  *
3171  * Gets the information from the URL parameter inpopup.
3172  *
3173  * @todo Use a central function to create the popup calls all over Moodle and
3174  * In the moment only works with resources and probably questions.
3175  *
3176  * @return boolean
3177  */
3178 function is_in_popup() {
3179     $inpopup = optional_param('inpopup', '', PARAM_BOOL);
3181     return ($inpopup);
3184 /**
3185  * Progress trace class.
3186  *
3187  * Use this class from long operations where you want to output occasional information about
3188  * what is going on, but don't know if, or in what format, the output should be.
3189  *
3190  * @copyright 2009 Tim Hunt
3191  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3192  * @package core
3193  */
3194 abstract class progress_trace {
3195     /**
3196      * Output an progress message in whatever format.
3197      *
3198      * @param string $message the message to output.
3199      * @param integer $depth indent depth for this message.
3200      */
3201     abstract public function output($message, $depth = 0);
3203     /**
3204      * Called when the processing is finished.
3205      */
3206     public function finished() {
3207     }
3210 /**
3211  * This subclass of progress_trace does not ouput anything.
3212  *
3213  * @copyright 2009 Tim Hunt
3214  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3215  * @package core
3216  */
3217 class null_progress_trace extends progress_trace {
3218     /**
3219      * Does Nothing
3220      *
3221      * @param string $message
3222      * @param int $depth
3223      * @return void Does Nothing
3224      */
3225     public function output($message, $depth = 0) {
3226     }
3229 /**
3230  * This subclass of progress_trace outputs to plain text.
3231  *
3232  * @copyright 2009 Tim Hunt
3233  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3234  * @package core
3235  */
3236 class text_progress_trace extends progress_trace {
3237     /**
3238      * Output the trace message.
3239      *
3240      * @param string $message
3241      * @param int $depth
3242      * @return void Output is echo'd
3243      */
3244     public function output($message, $depth = 0) {
3245         echo str_repeat('  ', $depth), $message, "\n";
3246         flush();
3247     }
3250 /**
3251  * This subclass of progress_trace outputs as HTML.
3252  *
3253  * @copyright 2009 Tim Hunt
3254  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3255  * @package core
3256  */
3257 class html_progress_trace extends progress_trace {
3258     /**
3259      * Output the trace message.
3260      *
3261      * @param string $message
3262      * @param int $depth
3263      * @return void Output is echo'd
3264      */
3265     public function output($message, $depth = 0) {
3266         echo '<p>', str_repeat('&#160;&#160;', $depth), htmlspecialchars($message), "</p>\n";
3267         flush();
3268     }
3271 /**
3272  * HTML List Progress Tree
3273  *
3274  * @copyright 2009 Tim Hunt
3275  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3276  * @package core
3277  */
3278 class html_list_progress_trace extends progress_trace {
3279     /** @var int */
3280     protected $currentdepth = -1;
3282     /**
3283      * Echo out the list
3284      *
3285      * @param string $message The message to display
3286      * @param int $depth
3287      * @return void Output is echoed
3288      */
3289     public function output($message, $depth = 0) {
3290         $samedepth = true;
3291         while ($this->currentdepth > $depth) {
3292             echo "</li>\n</ul>\n";
3293             $this->currentdepth -= 1;
3294             if ($this->currentdepth == $depth) {
3295                 echo '<li>';
3296             }
3297             $samedepth = false;
3298         }
3299         while ($this->currentdepth < $depth) {
3300             echo "<ul>\n<li>";
3301             $this->currentdepth += 1;
3302             $samedepth = false;
3303         }
3304         if ($samedepth) {
3305             echo "</li>\n<li>";
3306         }
3307         echo htmlspecialchars($message);
3308         flush();
3309     }
3311     /**
3312      * Called when the processing is finished.
3313      */
3314     public function finished() {
3315         while ($this->currentdepth >= 0) {
3316             echo "</li>\n</ul>\n";
3317             $this->currentdepth -= 1;
3318         }
3319     }
3322 /**
3323  * This subclass of progress_trace outputs to error log.
3324  *
3325  * @copyright Petr Skoda {@link http://skodak.org}
3326  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3327  * @package core
3328  */
3329 class error_log_progress_trace extends progress_trace {
3330     /** @var string log prefix */
3331     protected $prefix;
3333     /**
3334      * Constructor.
3335      * @param string $prefix optional log prefix
3336      */
3337     public function __construct($prefix = '') {
3338         $this->prefix = $prefix;
3339     }
3341     /**
3342      * Output the trace message.
3343      *
3344      * @param string $message
3345      * @param int $depth
3346      * @return void Output is sent to error log.
3347      */
3348     public function output($message, $depth = 0) {
3349         error_log($this->prefix . str_repeat('  ', $depth) . $message);
3350     }
3353 /**
3354  * Special type of trace that can be used for catching of output of other traces.
3355  *
3356  * @copyright Petr Skoda {@link http://skodak.org}
3357  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3358  * @package core
3359  */
3360 class progress_trace_buffer extends progress_trace {
3361     /** @var progres_trace */
3362     protected $trace;
3363     /** @var bool do we pass output out */
3364     protected $passthrough;
3365     /** @var string output buffer */
3366     protected $buffer;
3368     /**
3369      * Constructor.
3370      *
3371      * @param progress_trace $trace
3372      * @param bool $passthrough true means output and buffer, false means just buffer and no output
3373      */
3374     public function __construct(progress_trace $trace, $passthrough = true) {
3375         $this->trace       = $trace;
3376         $this->passthrough = $passthrough;
3377         $this->buffer      = '';
3378     }
3380     /**
3381      * Output the trace message.
3382      *
3383      * @param string $message the message to output.
3384      * @param int $depth indent depth for this message.
3385      * @return void output stored in buffer
3386      */
3387     public function output($message, $depth = 0) {
3388         ob_start();
3389         $this->trace->output($message, $depth);
3390         $this->buffer .= ob_get_contents();
3391         if ($this->passthrough) {
3392             ob_end_flush();
3393         } else {
3394             ob_end_clean();
3395         }
3396     }
3398     /**
3399      * Called when the processing is finished.
3400      */
3401     public function finished() {
3402         ob_start();
3403         $this->trace->finished();
3404         $this->buffer .= ob_get_contents();
3405         if ($this->passthrough) {
3406             ob_end_flush();
3407         } else {
3408             ob_end_clean();
3409         }
3410     }
3412     /**
3413      * Reset internal text buffer.
3414      */
3415     public function reset_buffer() {
3416         $this->buffer = '';
3417     }
3419     /**
3420      * Return internal text buffer.
3421      * @return string buffered plain text
3422      */
3423     public function get_buffer() {
3424         return $this->buffer;
3425     }
3428 /**
3429  * Special type of trace that can be used for redirecting to multiple other traces.
3430  *
3431  * @copyright Petr Skoda {@link http://skodak.org}
3432  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3433  * @package core
3434  */
3435 class combined_progress_trace extends progress_trace {
3437     /**
3438      * An array of traces.
3439      * @var array
3440      */
3441     protected $traces;
3443     /**
3444      * Constructs a new instance.
3445      *
3446      * @param array $traces multiple traces
3447      */
3448     public function __construct(array $traces) {
3449         $this->traces = $traces;
3450     }
3452     /**
3453      * Output an progress message in whatever format.
3454      *
3455      * @param string $message the message to output.
3456      * @param integer $depth indent depth for this message.
3457      */
3458     public function output($message, $depth = 0) {
3459         foreach ($this->traces as $trace) {
3460             $trace->output($message, $depth);
3461         }
3462     }
3464     /**
3465      * Called when the processing is finished.
3466      */
3467     public function finished() {
3468         foreach ($this->traces as $trace) {
3469             $trace->finished();
3470         }
3471     }
3474 /**
3475  * Returns a localized sentence in the current language summarizing the current password policy
3476  *
3477  * @todo this should be handled by a function/method in the language pack library once we have a support for it
3478  * @uses $CFG
3479  * @return string
3480  */
3481 function print_password_policy() {
3482     global $CFG;
3484     $message = '';
3485     if (!empty($CFG->passwordpolicy)) {
3486         $messages = array();
3487         $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength);
3488         if (!empty($CFG->minpassworddigits)) {
3489             $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits);
3490         }
3491         if (!empty($CFG->minpasswordlower)) {
3492             $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower);
3493         }
3494         if (!empty($CFG->minpasswordupper)) {
3495             $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper);
3496         }
3497         if (!empty($CFG->minpasswordnonalphanum)) {
3498             $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3499         }
3501         $messages = join(', ', $messages); // This is ugly but we do not have anything better yet...
3502         $message = get_string('informpasswordpolicy', 'auth', $messages);
3503     }
3504     return $message;
3507 /**
3508  * Get the value of a help string fully prepared for display in the current language.
3509  *
3510  * @param string $identifier The identifier of the string to search for.
3511  * @param string $component The module the string is associated with.
3512  * @param boolean $ajax Whether this help is called from an AJAX script.
3513  *                This is used to influence text formatting and determines
3514  *                which format to output the doclink in.
3515  * @param string|object|array $a An object, string or number that can be used
3516  *      within translation strings
3517  * @return Object An object containing:
3518  * - heading: Any heading that there may be for this help string.
3519  * - text: The wiki-formatted help string.
3520  * - doclink: An object containing a link, the linktext, and any additional
3521  *            CSS classes to apply to that link. Only present if $ajax = false.
3522  * - completedoclink: A text representation of the doclink. Only present if $ajax = true.
3523  */
3524 function get_formatted_help_string($identifier, $component, $ajax = false, $a = null) {
3525     global $CFG, $OUTPUT;
3526     $sm = get_string_manager();
3528     // Do not rebuild caches here!
3529     // Devs need to learn to purge all caches after any change or disable $CFG->langstringcache.
3531     $data = new stdClass();
3533     if ($sm->string_exists($identifier, $component)) {
3534         $data->heading = format_string(get_string($identifier, $component));
3535     } else {
3536         // Gracefully fall back to an empty string.
3537         $data->heading = '';
3538     }
3540     if ($sm->string_exists($identifier . '_help', $component)) {
3541         $options = new stdClass();
3542         $options->trusted = false;
3543         $options->noclean = false;
3544         $options->smiley = false;
3545         $options->filter = false;
3546         $options->para = true;
3547         $options->newlines = false;
3548         $options->overflowdiv = !$ajax;
3550         // Should be simple wiki only MDL-21695.
3551         $data->text = format_text(get_string($identifier.'_help', $component, $a), FORMAT_MARKDOWN, $options);
3553         $helplink = $identifier . '_link';
3554         if ($sm->string_exists($helplink, $component)) {  // Link to further info in Moodle docs.
3555             $link = get_string($helplink, $component);
3556             $linktext = get_string('morehelp');
3558             $data->doclink = new stdClass();
3559             $url = new moodle_url(get_docs_url($link));
3560             if ($ajax) {
3561                 $data->doclink->link = $url->out();
3562                 $data->doclink->linktext = $linktext;
3563                 $data->doclink->class = ($CFG->doctonewwindow) ? 'helplinkpopup' : '';
3564             } else {
3565                 $data->completedoclink = html_writer::tag('div', $OUTPUT->doc_link($link, $linktext),
3566                     array('class' => 'helpdoclink'));
3567             }
3568         }
3569     } else {
3570         $data->text = html_writer::tag('p',
3571             html_writer::tag('strong', 'TODO') . ": missing help string [{$identifier}_help, {$component}]");
3572     }
3573     return $data;