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