c86dc0ed240edb6e6e802a47ff0747da0828ad1a
[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         $url = new moodle_url($urlbase, $params);
764         $url->set_slashargument($path);
765         return $url;
766     }
768     /**
769      * Factory method for creation of url pointing to plugin file.
770      *
771      * Please note this method can be used only from the plugins to
772      * create urls of own files, it must not be used outside of plugins!
773      *
774      * @param int $contextid
775      * @param string $component
776      * @param string $area
777      * @param int $itemid
778      * @param string $pathname
779      * @param string $filename
780      * @param bool $forcedownload
781      * @return moodle_url
782      */
783     public static function make_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename,
784                                                $forcedownload = false) {
785         global $CFG;
786         $urlbase = "$CFG->httpswwwroot/pluginfile.php";
787         if ($itemid === null) {
788             return self::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
789         } else {
790             return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
791         }
792     }
794     /**
795      * Factory method for creation of url pointing to plugin file.
796      * This method is the same that make_pluginfile_url but pointing to the webservice pluginfile.php script.
797      * It should be used only in external functions.
798      *
799      * @since  2.8
800      * @param int $contextid
801      * @param string $component
802      * @param string $area
803      * @param int $itemid
804      * @param string $pathname
805      * @param string $filename
806      * @param bool $forcedownload
807      * @return moodle_url
808      */
809     public static function make_webservice_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename,
810                                                $forcedownload = false) {
811         global $CFG;
812         $urlbase = "$CFG->httpswwwroot/webservice/pluginfile.php";
813         if ($itemid === null) {
814             return self::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
815         } else {
816             return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
817         }
818     }
820     /**
821      * Factory method for creation of url pointing to draft file of current user.
822      *
823      * @param int $draftid draft item id
824      * @param string $pathname
825      * @param string $filename
826      * @param bool $forcedownload
827      * @return moodle_url
828      */
829     public static function make_draftfile_url($draftid, $pathname, $filename, $forcedownload = false) {
830         global $CFG, $USER;
831         $urlbase = "$CFG->httpswwwroot/draftfile.php";
832         $context = context_user::instance($USER->id);
834         return self::make_file_url($urlbase, "/$context->id/user/draft/$draftid".$pathname.$filename, $forcedownload);
835     }
837     /**
838      * Factory method for creating of links to legacy course files.
839      *
840      * @param int $courseid
841      * @param string $filepath
842      * @param bool $forcedownload
843      * @return moodle_url
844      */
845     public static function make_legacyfile_url($courseid, $filepath, $forcedownload = false) {
846         global $CFG;
848         $urlbase = "$CFG->wwwroot/file.php";
849         return self::make_file_url($urlbase, '/'.$courseid.'/'.$filepath, $forcedownload);
850     }
852     /**
853      * Returns URL a relative path from $CFG->wwwroot
854      *
855      * Can be used for passing around urls with the wwwroot stripped
856      *
857      * @param boolean $escaped Use &amp; as params separator instead of plain &
858      * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
859      * @return string Resulting URL
860      * @throws coding_exception if called on a non-local url
861      */
862     public function out_as_local_url($escaped = true, array $overrideparams = null) {
863         global $CFG;
865         $url = $this->out($escaped, $overrideparams);
866         $httpswwwroot = str_replace("http://", "https://", $CFG->wwwroot);
868         // Url should be equal to wwwroot or httpswwwroot. If not then throw exception.
869         if (($url === $CFG->wwwroot) || (strpos($url, $CFG->wwwroot.'/') === 0)) {
870             $localurl = substr($url, strlen($CFG->wwwroot));
871             return !empty($localurl) ? $localurl : '';
872         } else if (($url === $httpswwwroot) || (strpos($url, $httpswwwroot.'/') === 0)) {
873             $localurl = substr($url, strlen($httpswwwroot));
874             return !empty($localurl) ? $localurl : '';
875         } else {
876             throw new coding_exception('out_as_local_url called on a non-local URL');
877         }
878     }
880     /**
881      * Returns the 'path' portion of a URL. For example, if the URL is
882      * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
883      * return '/my/file/is/here.txt'.
884      *
885      * By default the path includes slash-arguments (for example,
886      * '/myfile.php/extra/arguments') so it is what you would expect from a
887      * URL path. If you don't want this behaviour, you can opt to exclude the
888      * slash arguments. (Be careful: if the $CFG variable slasharguments is
889      * disabled, these URLs will have a different format and you may need to
890      * look at the 'file' parameter too.)
891      *
892      * @param bool $includeslashargument If true, includes slash arguments
893      * @return string Path of URL
894      */
895     public function get_path($includeslashargument = true) {
896         return $this->path . ($includeslashargument ? $this->slashargument : '');
897     }
899     /**
900      * Returns a given parameter value from the URL.
901      *
902      * @param string $name Name of parameter
903      * @return string Value of parameter or null if not set
904      */
905     public function get_param($name) {
906         if (array_key_exists($name, $this->params)) {
907             return $this->params[$name];
908         } else {
909             return null;
910         }
911     }
913     /**
914      * Returns the 'scheme' portion of a URL. For example, if the URL is
915      * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
916      * return 'http' (without the colon).
917      *
918      * @return string Scheme of the URL.
919      */
920     public function get_scheme() {
921         return $this->scheme;
922     }
924     /**
925      * Returns the 'host' portion of a URL. For example, if the URL is
926      * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
927      * return 'www.example.org'.
928      *
929      * @return string Host of the URL.
930      */
931     public function get_host() {
932         return $this->host;
933     }
935     /**
936      * Returns the 'port' portion of a URL. For example, if the URL is
937      * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
938      * return '447'.
939      *
940      * @return string Port of the URL.
941      */
942     public function get_port() {
943         return $this->port;
944     }
947 /**
948  * Determine if there is data waiting to be processed from a form
949  *
950  * Used on most forms in Moodle to check for data
951  * Returns the data as an object, if it's found.
952  * This object can be used in foreach loops without
953  * casting because it's cast to (array) automatically
954  *
955  * Checks that submitted POST data exists and returns it as object.
956  *
957  * @return mixed false or object
958  */
959 function data_submitted() {
961     if (empty($_POST)) {
962         return false;
963     } else {
964         return (object)fix_utf8($_POST);
965     }
968 /**
969  * Given some normal text this function will break up any
970  * long words to a given size by inserting the given character
971  *
972  * It's multibyte savvy and doesn't change anything inside html tags.
973  *
974  * @param string $string the string to be modified
975  * @param int $maxsize maximum length of the string to be returned
976  * @param string $cutchar the string used to represent word breaks
977  * @return string
978  */
979 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
981     // First of all, save all the tags inside the text to skip them.
982     $tags = array();
983     filter_save_tags($string, $tags);
985     // Process the string adding the cut when necessary.
986     $output = '';
987     $length = core_text::strlen($string);
988     $wordlength = 0;
990     for ($i=0; $i<$length; $i++) {
991         $char = core_text::substr($string, $i, 1);
992         if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
993             $wordlength = 0;
994         } else {
995             $wordlength++;
996             if ($wordlength > $maxsize) {
997                 $output .= $cutchar;
998                 $wordlength = 0;
999             }
1000         }
1001         $output .= $char;
1002     }
1004     // Finally load the tags back again.
1005     if (!empty($tags)) {
1006         $output = str_replace(array_keys($tags), $tags, $output);
1007     }
1009     return $output;
1012 /**
1013  * Try and close the current window using JavaScript, either immediately, or after a delay.
1014  *
1015  * Echo's out the resulting XHTML & javascript
1016  *
1017  * @param integer $delay a delay in seconds before closing the window. Default 0.
1018  * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
1019  *      to reload the parent window before this one closes.
1020  */
1021 function close_window($delay = 0, $reloadopener = false) {
1022     global $PAGE, $OUTPUT;
1024     if (!$PAGE->headerprinted) {
1025         $PAGE->set_title(get_string('closewindow'));
1026         echo $OUTPUT->header();
1027     } else {
1028         $OUTPUT->container_end_all(false);
1029     }
1031     if ($reloadopener) {
1032         // Trigger the reload immediately, even if the reload is after a delay.
1033         $PAGE->requires->js_function_call('window.opener.location.reload', array(true));
1034     }
1035     $OUTPUT->notification(get_string('windowclosing'), 'notifysuccess');
1037     $PAGE->requires->js_function_call('close_window', array(new stdClass()), false, $delay);
1039     echo $OUTPUT->footer();
1040     exit;
1043 /**
1044  * Returns a string containing a link to the user documentation for the current page.
1045  *
1046  * Also contains an icon by default. Shown to teachers and admin only.
1047  *
1048  * @param string $text The text to be displayed for the link
1049  * @return string The link to user documentation for this current page
1050  */
1051 function page_doc_link($text='') {
1052     global $OUTPUT, $PAGE;
1053     $path = page_get_doc_link_path($PAGE);
1054     if (!$path) {
1055         return '';
1056     }
1057     return $OUTPUT->doc_link($path, $text);
1060 /**
1061  * Returns the path to use when constructing a link to the docs.
1062  *
1063  * @since Moodle 2.5.1 2.6
1064  * @param moodle_page $page
1065  * @return string
1066  */
1067 function page_get_doc_link_path(moodle_page $page) {
1068     global $CFG;
1070     if (empty($CFG->docroot) || during_initial_install()) {
1071         return '';
1072     }
1073     if (!has_capability('moodle/site:doclinks', $page->context)) {
1074         return '';
1075     }
1077     $path = $page->docspath;
1078     if (!$path) {
1079         return '';
1080     }
1081     return $path;
1085 /**
1086  * Validates an email to make sure it makes sense.
1087  *
1088  * @param string $address The email address to validate.
1089  * @return boolean
1090  */
1091 function validate_email($address) {
1093     return (preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
1094                  '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
1095                   '@'.
1096                   '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
1097                   '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
1098                   $address));
1101 /**
1102  * Extracts file argument either from file parameter or PATH_INFO
1103  *
1104  * Note: $scriptname parameter is not needed anymore
1105  *
1106  * @return string file path (only safe characters)
1107  */
1108 function get_file_argument() {
1109     global $SCRIPT;
1111     $relativepath = optional_param('file', false, PARAM_PATH);
1113     if ($relativepath !== false and $relativepath !== '') {
1114         return $relativepath;
1115     }
1116     $relativepath = false;
1118     // Then try extract file from the slasharguments.
1119     if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
1120         // NOTE: IIS tends to convert all file paths to single byte DOS encoding,
1121         //       we can not use other methods because they break unicode chars,
1122         //       the only ways are to use URL rewriting
1123         //       OR
1124         //       to properly set the 'FastCGIUtf8ServerVariables' registry key.
1125         if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
1126             // Check that PATH_INFO works == must not contain the script name.
1127             if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
1128                 $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
1129             }
1130         }
1131     } else {
1132         // All other apache-like servers depend on PATH_INFO.
1133         if (isset($_SERVER['PATH_INFO'])) {
1134             if (isset($_SERVER['SCRIPT_NAME']) and strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === 0) {
1135                 $relativepath = substr($_SERVER['PATH_INFO'], strlen($_SERVER['SCRIPT_NAME']));
1136             } else {
1137                 $relativepath = $_SERVER['PATH_INFO'];
1138             }
1139             $relativepath = clean_param($relativepath, PARAM_PATH);
1140         }
1141     }
1143     return $relativepath;
1146 /**
1147  * Just returns an array of text formats suitable for a popup menu
1148  *
1149  * @return array
1150  */
1151 function format_text_menu() {
1152     return array (FORMAT_MOODLE => get_string('formattext'),
1153                   FORMAT_HTML => get_string('formathtml'),
1154                   FORMAT_PLAIN => get_string('formatplain'),
1155                   FORMAT_MARKDOWN => get_string('formatmarkdown'));
1158 /**
1159  * Given text in a variety of format codings, this function returns the text as safe HTML.
1160  *
1161  * This function should mainly be used for long strings like posts,
1162  * answers, glossary items etc. For short strings {@link format_string()}.
1163  *
1164  * <pre>
1165  * Options:
1166  *      trusted     :   If true the string won't be cleaned. Default false required noclean=true.
1167  *      noclean     :   If true the string won't be cleaned. Default false required trusted=true.
1168  *      nocache     :   If true the strign will not be cached and will be formatted every call. Default false.
1169  *      filter      :   If true the string will be run through applicable filters as well. Default true.
1170  *      para        :   If true then the returned string will be wrapped in div tags. Default true.
1171  *      newlines    :   If true then lines newline breaks will be converted to HTML newline breaks. Default true.
1172  *      context     :   The context that will be used for filtering.
1173  *      overflowdiv :   If set to true the formatted text will be encased in a div
1174  *                      with the class no-overflow before being returned. Default false.
1175  *      allowid     :   If true then id attributes will not be removed, even when
1176  *                      using htmlpurifier. Default false.
1177  *      blanktarget :   If true all <a> tags will have target="_blank" added unless target is explicitly specified.
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     }
1225     $options['blanktarget'] = !empty($options['blanktarget']);
1227     // Calculate best context.
1228     if (empty($CFG->version) or $CFG->version < 2013051400 or during_initial_install()) {
1229         // Do not filter anything during installation or before upgrade completes.
1230         $context = null;
1232     } else if (isset($options['context'])) { // First by explicit passed context option.
1233         if (is_object($options['context'])) {
1234             $context = $options['context'];
1235         } else {
1236             $context = context::instance_by_id($options['context']);
1237         }
1238     } else if ($courseiddonotuse) {
1239         // Legacy courseid.
1240         $context = context_course::instance($courseiddonotuse);
1241     } else {
1242         // Fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(.
1243         $context = $PAGE->context;
1244     }
1246     if (!$context) {
1247         // Either install/upgrade or something has gone really wrong because context does not exist (yet?).
1248         $options['nocache'] = true;
1249         $options['filter']  = false;
1250     }
1252     if ($options['filter']) {
1253         $filtermanager = filter_manager::instance();
1254         $filtermanager->setup_page_for_filters($PAGE, $context); // Setup global stuff filters may have.
1255         $filteroptions = array(
1256             'originalformat' => $format,
1257             'noclean' => $options['noclean'],
1258         );
1259     } else {
1260         $filtermanager = new null_filter_manager();
1261         $filteroptions = array();
1262     }
1264     switch ($format) {
1265         case FORMAT_HTML:
1266             if (!$options['noclean']) {
1267                 $text = clean_text($text, FORMAT_HTML, $options);
1268             }
1269             $text = $filtermanager->filter_text($text, $context, $filteroptions);
1270             break;
1272         case FORMAT_PLAIN:
1273             $text = s($text); // Cleans dangerous JS.
1274             $text = rebuildnolinktag($text);
1275             $text = str_replace('  ', '&nbsp; ', $text);
1276             $text = nl2br($text);
1277             break;
1279         case FORMAT_WIKI:
1280             // This format is deprecated.
1281             $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle.  You should not be seeing
1282                      this message as all texts should have been converted to Markdown format instead.
1283                      Please post a bug report to http://moodle.org/bugs with information about where you
1284                      saw this message.</p>'.s($text);
1285             break;
1287         case FORMAT_MARKDOWN:
1288             $text = markdown_to_html($text);
1289             if (!$options['noclean']) {
1290                 $text = clean_text($text, FORMAT_HTML, $options);
1291             }
1292             $text = $filtermanager->filter_text($text, $context, $filteroptions);
1293             break;
1295         default:  // FORMAT_MOODLE or anything else.
1296             $text = text_to_html($text, null, $options['para'], $options['newlines']);
1297             if (!$options['noclean']) {
1298                 $text = clean_text($text, FORMAT_HTML, $options);
1299             }
1300             $text = $filtermanager->filter_text($text, $context, $filteroptions);
1301             break;
1302     }
1303     if ($options['filter']) {
1304         // At this point there should not be any draftfile links any more,
1305         // this happens when developers forget to post process the text.
1306         // The only potential problem is that somebody might try to format
1307         // the text before storing into database which would be itself big bug..
1308         $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
1310         if ($CFG->debugdeveloper) {
1311             if (strpos($text, '@@PLUGINFILE@@/') !== false) {
1312                 debugging('Before calling format_text(), the content must be processed with file_rewrite_pluginfile_urls()',
1313                     DEBUG_DEVELOPER);
1314             }
1315         }
1316     }
1318     if (!empty($options['overflowdiv'])) {
1319         $text = html_writer::tag('div', $text, array('class' => 'no-overflow'));
1320     }
1322     if ($options['blanktarget']) {
1323         $domdoc = new DOMDocument();
1324         $domdoc->loadHTML('<?xml version="1.0" encoding="UTF-8" ?>' . $text);
1325         foreach ($domdoc->getElementsByTagName('a') as $link) {
1326             if ($link->hasAttribute('target') && strpos($link->getAttribute('target'), '_blank') === false) {
1327                 continue;
1328             }
1329             $link->setAttribute('target', '_blank');
1330             if (strpos($link->getAttribute('rel'), 'noreferrer') === false) {
1331                 $link->setAttribute('rel', trim($link->getAttribute('rel') . ' noreferrer'));
1332             }
1333         }
1335         // This regex is nasty and I don't like it. The correct way to solve this is by loading the HTML like so:
1336         // $domdoc->loadHTML($text, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD); however it seems like the libxml
1337         // version that travis uses doesn't work properly and ends up leaving <html><body>, so I'm forced to use
1338         // this regex to remove those tags.
1339         $text = trim(preg_replace('~<(?:!DOCTYPE|/?(?:html|body))[^>]*>\s*~i', '', $domdoc->saveHTML($domdoc->documentElement)));
1340     }
1342     return $text;
1345 /**
1346  * Resets some data related to filters, called during upgrade or when general filter settings change.
1347  *
1348  * @param bool $phpunitreset true means called from our PHPUnit integration test reset
1349  * @return void
1350  */
1351 function reset_text_filters_cache($phpunitreset = false) {
1352     global $CFG, $DB;
1354     if ($phpunitreset) {
1355         // HTMLPurifier does not change, DB is already reset to defaults,
1356         // nothing to do here, the dataroot was cleared too.
1357         return;
1358     }
1360     // The purge_all_caches() deals with cachedir and localcachedir purging,
1361     // the individual filter caches are invalidated as necessary elsewhere.
1363     // Update $CFG->filterall cache flag.
1364     if (empty($CFG->stringfilters)) {
1365         set_config('filterall', 0);
1366         return;
1367     }
1368     $installedfilters = core_component::get_plugin_list('filter');
1369     $filters = explode(',', $CFG->stringfilters);
1370     foreach ($filters as $filter) {
1371         if (isset($installedfilters[$filter])) {
1372             set_config('filterall', 1);
1373             return;
1374         }
1375     }
1376     set_config('filterall', 0);
1379 /**
1380  * Given a simple string, this function returns the string
1381  * processed by enabled string filters if $CFG->filterall is enabled
1382  *
1383  * This function should be used to print short strings (non html) that
1384  * need filter processing e.g. activity titles, post subjects,
1385  * glossary concepts.
1386  *
1387  * @staticvar bool $strcache
1388  * @param string $string The string to be filtered. Should be plain text, expect
1389  * possibly for multilang tags.
1390  * @param boolean $striplinks To strip any link in the result text. Moodle 1.8 default changed from false to true! MDL-8713
1391  * @param array $options options array/object or courseid
1392  * @return string
1393  */
1394 function format_string($string, $striplinks = true, $options = null) {
1395     global $CFG, $PAGE;
1397     // We'll use a in-memory cache here to speed up repeated strings.
1398     static $strcache = false;
1400     if (empty($CFG->version) or $CFG->version < 2013051400 or during_initial_install()) {
1401         // Do not filter anything during installation or before upgrade completes.
1402         return $string = strip_tags($string);
1403     }
1405     if ($strcache === false or count($strcache) > 2000) {
1406         // This number might need some tuning to limit memory usage in cron.
1407         $strcache = array();
1408     }
1410     if (is_numeric($options)) {
1411         // Legacy courseid usage.
1412         $options  = array('context' => context_course::instance($options));
1413     } else {
1414         // Detach object, we can not modify it.
1415         $options = (array)$options;
1416     }
1418     if (empty($options['context'])) {
1419         // Fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(.
1420         $options['context'] = $PAGE->context;
1421     } else if (is_numeric($options['context'])) {
1422         $options['context'] = context::instance_by_id($options['context']);
1423     }
1424     if (!isset($options['filter'])) {
1425         $options['filter'] = true;
1426     }
1428     if (!$options['context']) {
1429         // We did not find any context? weird.
1430         return $string = strip_tags($string);
1431     }
1433     // Calculate md5.
1434     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id.'<+>'.current_language());
1436     // Fetch from cache if possible.
1437     if (isset($strcache[$md5])) {
1438         return $strcache[$md5];
1439     }
1441     // First replace all ampersands not followed by html entity code
1442     // Regular expression moved to its own method for easier unit testing.
1443     $string = replace_ampersands_not_followed_by_entity($string);
1445     if (!empty($CFG->filterall) && $options['filter']) {
1446         $filtermanager = filter_manager::instance();
1447         $filtermanager->setup_page_for_filters($PAGE, $options['context']); // Setup global stuff filters may have.
1448         $string = $filtermanager->filter_string($string, $options['context']);
1449     }
1451     // If the site requires it, strip ALL tags from this string.
1452     if (!empty($CFG->formatstringstriptags)) {
1453         $string = str_replace(array('<', '>'), array('&lt;', '&gt;'), strip_tags($string));
1455     } else {
1456         // Otherwise strip just links if that is required (default).
1457         if ($striplinks) {
1458             // Strip links in string.
1459             $string = strip_links($string);
1460         }
1461         $string = clean_text($string);
1462     }
1464     // Store to cache.
1465     $strcache[$md5] = $string;
1467     return $string;
1470 /**
1471  * Given a string, performs a negative lookahead looking for any ampersand character
1472  * that is not followed by a proper HTML entity. If any is found, it is replaced
1473  * by &amp;. The string is then returned.
1474  *
1475  * @param string $string
1476  * @return string
1477  */
1478 function replace_ampersands_not_followed_by_entity($string) {
1479     return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1482 /**
1483  * Given a string, replaces all <a>.*</a> by .* and returns the string.
1484  *
1485  * @param string $string
1486  * @return string
1487  */
1488 function strip_links($string) {
1489     return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is', '$2', $string);
1492 /**
1493  * This expression turns links into something nice in a text format. (Russell Jungwirth)
1494  *
1495  * @param string $string
1496  * @return string
1497  */
1498 function wikify_links($string) {
1499     return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i', '$3 [ $2 ]', $string);
1502 /**
1503  * Given text in a variety of format codings, this function returns the text as plain text suitable for plain email.
1504  *
1505  * @param string $text The text to be formatted. This is raw text originally from user input.
1506  * @param int $format Identifier of the text format to be used
1507  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1508  * @return string
1509  */
1510 function format_text_email($text, $format) {
1512     switch ($format) {
1514         case FORMAT_PLAIN:
1515             return $text;
1516             break;
1518         case FORMAT_WIKI:
1519             // There should not be any of these any more!
1520             $text = wikify_links($text);
1521             return core_text::entities_to_utf8(strip_tags($text), true);
1522             break;
1524         case FORMAT_HTML:
1525             return html_to_text($text);
1526             break;
1528         case FORMAT_MOODLE:
1529         case FORMAT_MARKDOWN:
1530         default:
1531             $text = wikify_links($text);
1532             return core_text::entities_to_utf8(strip_tags($text), true);
1533             break;
1534     }
1537 /**
1538  * Formats activity intro text
1539  *
1540  * @param string $module name of module
1541  * @param object $activity instance of activity
1542  * @param int $cmid course module id
1543  * @param bool $filter filter resulting html text
1544  * @return string
1545  */
1546 function format_module_intro($module, $activity, $cmid, $filter=true) {
1547     global $CFG;
1548     require_once("$CFG->libdir/filelib.php");
1549     $context = context_module::instance($cmid);
1550     $options = array('noclean' => true, 'para' => false, 'filter' => $filter, 'context' => $context, 'overflowdiv' => true);
1551     $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, 'mod_'.$module, 'intro', null);
1552     return trim(format_text($intro, $activity->introformat, $options, null));
1555 /**
1556  * Removes the usage of Moodle files from a text.
1557  *
1558  * In some rare cases we need to re-use a text that already has embedded links
1559  * to some files hosted within Moodle. But the new area in which we will push
1560  * this content does not support files... therefore we need to remove those files.
1561  *
1562  * @param string $source The text
1563  * @return string The stripped text
1564  */
1565 function strip_pluginfile_content($source) {
1566     $baseurl = '@@PLUGINFILE@@';
1567     // Looking for something like < .* "@@pluginfile@@.*" .* >
1568     $pattern = '$<[^<>]+["\']' . $baseurl . '[^"\']*["\'][^<>]*>$';
1569     $stripped = preg_replace($pattern, '', $source);
1570     // Use purify html to rebalence potentially mismatched tags and generally cleanup.
1571     return purify_html($stripped);
1574 /**
1575  * Legacy function, used for cleaning of old forum and glossary text only.
1576  *
1577  * @param string $text text that may contain legacy TRUSTTEXT marker
1578  * @return string text without legacy TRUSTTEXT marker
1579  */
1580 function trusttext_strip($text) {
1581     while (true) { // Removing nested TRUSTTEXT.
1582         $orig = $text;
1583         $text = str_replace('#####TRUSTTEXT#####', '', $text);
1584         if (strcmp($orig, $text) === 0) {
1585             return $text;
1586         }
1587     }
1590 /**
1591  * Must be called before editing of all texts with trust flag. Removes all XSS nasties from texts stored in database if needed.
1592  *
1593  * @param stdClass $object data object with xxx, xxxformat and xxxtrust fields
1594  * @param string $field name of text field
1595  * @param context $context active context
1596  * @return stdClass updated $object
1597  */
1598 function trusttext_pre_edit($object, $field, $context) {
1599     $trustfield  = $field.'trust';
1600     $formatfield = $field.'format';
1602     if (!$object->$trustfield or !trusttext_trusted($context)) {
1603         $object->$field = clean_text($object->$field, $object->$formatfield);
1604     }
1606     return $object;
1609 /**
1610  * Is current user trusted to enter no dangerous XSS in this context?
1611  *
1612  * Please note the user must be in fact trusted everywhere on this server!!
1613  *
1614  * @param context $context
1615  * @return bool true if user trusted
1616  */
1617 function trusttext_trusted($context) {
1618     return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1621 /**
1622  * Is trusttext feature active?
1623  *
1624  * @return bool
1625  */
1626 function trusttext_active() {
1627     global $CFG;
1629     return !empty($CFG->enabletrusttext);
1632 /**
1633  * Cleans raw text removing nasties.
1634  *
1635  * Given raw text (eg typed in by a user) this function cleans it up and removes any nasty tags that could mess up
1636  * Moodle pages through XSS attacks.
1637  *
1638  * The result must be used as a HTML text fragment, this function can not cleanup random
1639  * parts of html tags such as url or src attributes.
1640  *
1641  * NOTE: the format parameter was deprecated because we can safely clean only HTML.
1642  *
1643  * @param string $text The text to be cleaned
1644  * @param int|string $format deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
1645  * @param array $options Array of options; currently only option supported is 'allowid' (if true,
1646  *   does not remove id attributes when cleaning)
1647  * @return string The cleaned up text
1648  */
1649 function clean_text($text, $format = FORMAT_HTML, $options = array()) {
1650     $text = (string)$text;
1652     if ($format != FORMAT_HTML and $format != FORMAT_HTML) {
1653         // TODO: we need to standardise cleanup of text when loading it into editor first.
1654         // debugging('clean_text() is designed to work only with html');.
1655     }
1657     if ($format == FORMAT_PLAIN) {
1658         return $text;
1659     }
1661     if (is_purify_html_necessary($text)) {
1662         $text = purify_html($text, $options);
1663     }
1665     // Originally we tried to neutralise some script events here, it was a wrong approach because
1666     // it was trivial to work around that (for example using style based XSS exploits).
1667     // We must not give false sense of security here - all developers MUST understand how to use
1668     // rawurlencode(), htmlentities(), htmlspecialchars(), p(), s(), moodle_url, html_writer and friends!!!
1670     return $text;
1673 /**
1674  * Is it necessary to use HTMLPurifier?
1675  *
1676  * @private
1677  * @param string $text
1678  * @return bool false means html is safe and valid, true means use HTMLPurifier
1679  */
1680 function is_purify_html_necessary($text) {
1681     if ($text === '') {
1682         return false;
1683     }
1685     if ($text === (string)((int)$text)) {
1686         return false;
1687     }
1689     if (strpos($text, '&') !== false or preg_match('|<[^pesb/]|', $text)) {
1690         // We need to normalise entities or other tags except p, em, strong and br present.
1691         return true;
1692     }
1694     $altered = htmlspecialchars($text, ENT_NOQUOTES, 'UTF-8', true);
1695     if ($altered === $text) {
1696         // No < > or other special chars means this must be safe.
1697         return false;
1698     }
1700     // Let's try to convert back some safe html tags.
1701     $altered = preg_replace('|&lt;p&gt;(.*?)&lt;/p&gt;|m', '<p>$1</p>', $altered);
1702     if ($altered === $text) {
1703         return false;
1704     }
1705     $altered = preg_replace('|&lt;em&gt;([^<>]+?)&lt;/em&gt;|m', '<em>$1</em>', $altered);
1706     if ($altered === $text) {
1707         return false;
1708     }
1709     $altered = preg_replace('|&lt;strong&gt;([^<>]+?)&lt;/strong&gt;|m', '<strong>$1</strong>', $altered);
1710     if ($altered === $text) {
1711         return false;
1712     }
1713     $altered = str_replace('&lt;br /&gt;', '<br />', $altered);
1714     if ($altered === $text) {
1715         return false;
1716     }
1718     return true;
1721 /**
1722  * KSES replacement cleaning function - uses HTML Purifier.
1723  *
1724  * @param string $text The (X)HTML string to purify
1725  * @param array $options Array of options; currently only option supported is 'allowid' (if set,
1726  *   does not remove id attributes when cleaning)
1727  * @return string
1728  */
1729 function purify_html($text, $options = array()) {
1730     global $CFG;
1732     $text = (string)$text;
1734     static $purifiers = array();
1735     static $caches = array();
1737     // Purifier code can change only during major version upgrade.
1738     $version = empty($CFG->version) ? 0 : $CFG->version;
1739     $cachedir = "$CFG->localcachedir/htmlpurifier/$version";
1740     if (!file_exists($cachedir)) {
1741         // Purging of caches may remove the cache dir at any time,
1742         // luckily file_exists() results should be cached for all existing directories.
1743         $purifiers = array();
1744         $caches = array();
1745         gc_collect_cycles();
1747         make_localcache_directory('htmlpurifier', false);
1748         check_dir_exists($cachedir);
1749     }
1751     $allowid = empty($options['allowid']) ? 0 : 1;
1752     $allowobjectembed = empty($CFG->allowobjectembed) ? 0 : 1;
1754     $type = 'type_'.$allowid.'_'.$allowobjectembed;
1756     if (!array_key_exists($type, $caches)) {
1757         $caches[$type] = cache::make('core', 'htmlpurifier', array('type' => $type));
1758     }
1759     $cache = $caches[$type];
1761     // Add revision number and all options to the text key so that it is compatible with local cluster node caches.
1762     $key = "|$version|$allowobjectembed|$allowid|$text";
1763     $filteredtext = $cache->get($key);
1765     if ($filteredtext === true) {
1766         // The filtering did not change the text last time, no need to filter anything again.
1767         return $text;
1768     } else if ($filteredtext !== false) {
1769         return $filteredtext;
1770     }
1772     if (empty($purifiers[$type])) {
1773         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1774         require_once $CFG->libdir.'/htmlpurifier/locallib.php';
1775         $config = HTMLPurifier_Config::createDefault();
1777         $config->set('HTML.DefinitionID', 'moodlehtml');
1778         $config->set('HTML.DefinitionRev', 4);
1779         $config->set('Cache.SerializerPath', $cachedir);
1780         $config->set('Cache.SerializerPermissions', $CFG->directorypermissions);
1781         $config->set('Core.NormalizeNewlines', false);
1782         $config->set('Core.ConvertDocumentToFragment', true);
1783         $config->set('Core.Encoding', 'UTF-8');
1784         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1785         $config->set('URI.AllowedSchemes', array(
1786             'http' => true,
1787             'https' => true,
1788             'ftp' => true,
1789             'irc' => true,
1790             'nntp' => true,
1791             'news' => true,
1792             'rtsp' => true,
1793             'rtmp' => true,
1794             'teamspeak' => true,
1795             'gopher' => true,
1796             'mms' => true,
1797             'mailto' => true
1798         ));
1799         $config->set('Attr.AllowedFrameTargets', array('_blank'));
1801         if ($allowobjectembed) {
1802             $config->set('HTML.SafeObject', true);
1803             $config->set('Output.FlashCompat', true);
1804             $config->set('HTML.SafeEmbed', true);
1805         }
1807         if ($allowid) {
1808             $config->set('Attr.EnableID', true);
1809         }
1811         if ($def = $config->maybeGetRawHTMLDefinition()) {
1812             $def->addElement('nolink', 'Block', 'Flow', array());                       // Skip our filters inside.
1813             $def->addElement('tex', 'Inline', 'Inline', array());                       // Tex syntax, equivalent to $$xx$$.
1814             $def->addElement('algebra', 'Inline', 'Inline', array());                   // Algebra syntax, equivalent to @@xx@@.
1815             $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // Original multilang style - only our hacked lang attribute.
1816             $def->addAttribute('span', 'xxxlang', 'CDATA');                             // Current very problematic multilang.
1818             // Use the built-in Ruby module to add annotation support.
1819             $def->manager->addModule(new HTMLPurifier_HTMLModule_Ruby());
1821             // Use the custom Noreferrer module.
1822             $def->manager->addModule(new HTMLPurifier_HTMLModule_Noreferrer());
1823         }
1825         $purifier = new HTMLPurifier($config);
1826         $purifiers[$type] = $purifier;
1827     } else {
1828         $purifier = $purifiers[$type];
1829     }
1831     $multilang = (strpos($text, 'class="multilang"') !== false);
1833     $filteredtext = $text;
1834     if ($multilang) {
1835         $filteredtextregex = '/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/';
1836         $filteredtext = preg_replace($filteredtextregex, '<span xxxlang="${2}">', $filteredtext);
1837     }
1838     $filteredtext = (string)$purifier->purify($filteredtext);
1839     if ($multilang) {
1840         $filteredtext = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $filteredtext);
1841     }
1843     if ($text === $filteredtext) {
1844         // No need to store the filtered text, next time we will just return unfiltered text
1845         // because it was not changed by purifying.
1846         $cache->set($key, true);
1847     } else {
1848         $cache->set($key, $filteredtext);
1849     }
1851     return $filteredtext;
1854 /**
1855  * Given plain text, makes it into HTML as nicely as possible.
1856  *
1857  * May contain HTML tags already.
1858  *
1859  * Do not abuse this function. It is intended as lower level formatting feature used
1860  * by {@link format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
1861  * to call format_text() in most of cases.
1862  *
1863  * @param string $text The string to convert.
1864  * @param boolean $smileyignored Was used to determine if smiley characters should convert to smiley images, ignored now
1865  * @param boolean $para If true then the returned string will be wrapped in div tags
1866  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1867  * @return string
1868  */
1869 function text_to_html($text, $smileyignored = null, $para = true, $newlines = true) {
1870     // Remove any whitespace that may be between HTML tags.
1871     $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1873     // Remove any returns that precede or follow HTML tags.
1874     $text = preg_replace("~([\n\r])<~i", " <", $text);
1875     $text = preg_replace("~>([\n\r])~i", "> ", $text);
1877     // Make returns into HTML newlines.
1878     if ($newlines) {
1879         $text = nl2br($text);
1880     }
1882     // Wrap the whole thing in a div if required.
1883     if ($para) {
1884         // In 1.9 this was changed from a p => div.
1885         return '<div class="text_to_html">'.$text.'</div>';
1886     } else {
1887         return $text;
1888     }
1891 /**
1892  * Given Markdown formatted text, make it into XHTML using external function
1893  *
1894  * @param string $text The markdown formatted text to be converted.
1895  * @return string Converted text
1896  */
1897 function markdown_to_html($text) {
1898     global $CFG;
1900     if ($text === '' or $text === null) {
1901         return $text;
1902     }
1904     require_once($CFG->libdir .'/markdown/MarkdownInterface.php');
1905     require_once($CFG->libdir .'/markdown/Markdown.php');
1906     require_once($CFG->libdir .'/markdown/MarkdownExtra.php');
1908     return \Michelf\MarkdownExtra::defaultTransform($text);
1911 /**
1912  * Given HTML text, make it into plain text using external function
1913  *
1914  * @param string $html The text to be converted.
1915  * @param integer $width Width to wrap the text at. (optional, default 75 which
1916  *      is a good value for email. 0 means do not limit line length.)
1917  * @param boolean $dolinks By default, any links in the HTML are collected, and
1918  *      printed as a list at the end of the HTML. If you don't want that, set this
1919  *      argument to false.
1920  * @return string plain text equivalent of the HTML.
1921  */
1922 function html_to_text($html, $width = 75, $dolinks = true) {
1923     global $CFG;
1925     require_once($CFG->libdir .'/html2text/lib.php');
1927     $options = array(
1928         'width'     => $width,
1929         'do_links'  => 'table',
1930     );
1932     if (empty($dolinks)) {
1933         $options['do_links'] = 'none';
1934     }
1935     $h2t = new core_html2text($html, $options);
1936     $result = $h2t->getText();
1938     return $result;
1941 /**
1942  * Converts texts or strings to plain text.
1943  *
1944  * - When used to convert user input introduced in an editor the text format needs to be passed in $contentformat like we usually
1945  *   do in format_text.
1946  * - When this function is used for strings that are usually passed through format_string before displaying them
1947  *   we need to set $contentformat to false. This will execute html_to_text as these strings can contain multilang tags if
1948  *   multilang filter is applied to headings.
1949  *
1950  * @param string $content The text as entered by the user
1951  * @param int|false $contentformat False for strings or the text format: FORMAT_MOODLE/FORMAT_HTML/FORMAT_PLAIN/FORMAT_MARKDOWN
1952  * @return string Plain text.
1953  */
1954 function content_to_text($content, $contentformat) {
1956     switch ($contentformat) {
1957         case FORMAT_PLAIN:
1958             // Nothing here.
1959             break;
1960         case FORMAT_MARKDOWN:
1961             $content = markdown_to_html($content);
1962             $content = html_to_text($content, 75, false);
1963             break;
1964         default:
1965             // FORMAT_HTML, FORMAT_MOODLE and $contentformat = false, the later one are strings usually formatted through
1966             // format_string, we need to convert them from html because they can contain HTML (multilang filter).
1967             $content = html_to_text($content, 75, false);
1968     }
1970     return trim($content, "\r\n ");
1973 /**
1974  * This function will highlight search words in a given string
1975  *
1976  * It cares about HTML and will not ruin links.  It's best to use
1977  * this function after performing any conversions to HTML.
1978  *
1979  * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1980  * @param string $haystack The string (HTML) within which to highlight the search terms.
1981  * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1982  * @param string $prefix the string to put before each search term found.
1983  * @param string $suffix the string to put after each search term found.
1984  * @return string The highlighted HTML.
1985  */
1986 function highlight($needle, $haystack, $matchcase = false,
1987         $prefix = '<span class="highlight">', $suffix = '</span>') {
1989     // Quick bail-out in trivial cases.
1990     if (empty($needle) or empty($haystack)) {
1991         return $haystack;
1992     }
1994     // Break up the search term into words, discard any -words and build a regexp.
1995     $words = preg_split('/ +/', trim($needle));
1996     foreach ($words as $index => $word) {
1997         if (strpos($word, '-') === 0) {
1998             unset($words[$index]);
1999         } else if (strpos($word, '+') === 0) {
2000             $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
2001         } else {
2002             $words[$index] = preg_quote($word, '/');
2003         }
2004     }
2005     $regexp = '/(' . implode('|', $words) . ')/u'; // Char u is to do UTF-8 matching.
2006     if (!$matchcase) {
2007         $regexp .= 'i';
2008     }
2010     // Another chance to bail-out if $search was only -words.
2011     if (empty($words)) {
2012         return $haystack;
2013     }
2015     // Split the string into HTML tags and real content.
2016     $chunks = preg_split('/((?:<[^>]*>)+)/', $haystack, -1, PREG_SPLIT_DELIM_CAPTURE);
2018     // We have an array of alternating blocks of text, then HTML tags, then text, ...
2019     // Loop through replacing search terms in the text, and leaving the HTML unchanged.
2020     $ishtmlchunk = false;
2021     $result = '';
2022     foreach ($chunks as $chunk) {
2023         if ($ishtmlchunk) {
2024             $result .= $chunk;
2025         } else {
2026             $result .= preg_replace($regexp, $prefix . '$1' . $suffix, $chunk);
2027         }
2028         $ishtmlchunk = !$ishtmlchunk;
2029     }
2031     return $result;
2034 /**
2035  * This function will highlight instances of $needle in $haystack
2036  *
2037  * It's faster that the above function {@link highlight()} and doesn't care about
2038  * HTML or anything.
2039  *
2040  * @param string $needle The string to search for
2041  * @param string $haystack The string to search for $needle in
2042  * @return string The highlighted HTML
2043  */
2044 function highlightfast($needle, $haystack) {
2046     if (empty($needle) or empty($haystack)) {
2047         return $haystack;
2048     }
2050     $parts = explode(core_text::strtolower($needle), core_text::strtolower($haystack));
2052     if (count($parts) === 1) {
2053         return $haystack;
2054     }
2056     $pos = 0;
2058     foreach ($parts as $key => $part) {
2059         $parts[$key] = substr($haystack, $pos, strlen($part));
2060         $pos += strlen($part);
2062         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
2063         $pos += strlen($needle);
2064     }
2066     return str_replace('<span class="highlight"></span>', '', join('', $parts));
2069 /**
2070  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
2071  *
2072  * Internationalisation, for print_header and backup/restorelib.
2073  *
2074  * @param bool $dir Default false
2075  * @return string Attributes
2076  */
2077 function get_html_lang($dir = false) {
2078     $direction = '';
2079     if ($dir) {
2080         if (right_to_left()) {
2081             $direction = ' dir="rtl"';
2082         } else {
2083             $direction = ' dir="ltr"';
2084         }
2085     }
2086     // Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
2087     $language = str_replace('_', '-', current_language());
2088     @header('Content-Language: '.$language);
2089     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
2093 // STANDARD WEB PAGE PARTS.
2095 /**
2096  * Send the HTTP headers that Moodle requires.
2097  *
2098  * There is a backwards compatibility hack for legacy code
2099  * that needs to add custom IE compatibility directive.
2100  *
2101  * Example:
2102  * <code>
2103  * if (!isset($CFG->additionalhtmlhead)) {
2104  *     $CFG->additionalhtmlhead = '';
2105  * }
2106  * $CFG->additionalhtmlhead .= '<meta http-equiv="X-UA-Compatible" content="IE=8" />';
2107  * header('X-UA-Compatible: IE=8');
2108  * echo $OUTPUT->header();
2109  * </code>
2110  *
2111  * Please note the $CFG->additionalhtmlhead alone might not work,
2112  * you should send the IE compatibility header() too.
2113  *
2114  * @param string $contenttype
2115  * @param bool $cacheable Can this page be cached on back?
2116  * @return void, sends HTTP headers
2117  */
2118 function send_headers($contenttype, $cacheable = true) {
2119     global $CFG;
2121     @header('Content-Type: ' . $contenttype);
2122     @header('Content-Script-Type: text/javascript');
2123     @header('Content-Style-Type: text/css');
2125     if (empty($CFG->additionalhtmlhead) or stripos($CFG->additionalhtmlhead, 'X-UA-Compatible') === false) {
2126         @header('X-UA-Compatible: IE=edge');
2127     }
2129     if ($cacheable) {
2130         // Allow caching on "back" (but not on normal clicks).
2131         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0, no-transform');
2132         @header('Pragma: no-cache');
2133         @header('Expires: ');
2134     } else {
2135         // Do everything we can to always prevent clients and proxies caching.
2136         @header('Cache-Control: no-store, no-cache, must-revalidate');
2137         @header('Cache-Control: post-check=0, pre-check=0, no-transform', false);
2138         @header('Pragma: no-cache');
2139         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2140         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2141     }
2142     @header('Accept-Ranges: none');
2144     if (empty($CFG->allowframembedding)) {
2145         @header('X-Frame-Options: sameorigin');
2146     }
2149 /**
2150  * Return the right arrow with text ('next'), and optionally embedded in a link.
2151  *
2152  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2153  * @param string $url An optional link to use in a surrounding HTML anchor.
2154  * @param bool $accesshide True if text should be hidden (for screen readers only).
2155  * @param string $addclass Additional class names for the link, or the arrow character.
2156  * @return string HTML string.
2157  */
2158 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
2159     global $OUTPUT; // TODO: move to output renderer.
2160     $arrowclass = 'arrow ';
2161     if (!$url) {
2162         $arrowclass .= $addclass;
2163     }
2164     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
2165     $htmltext = '';
2166     if ($text) {
2167         $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
2168         if ($accesshide) {
2169             $htmltext = get_accesshide($htmltext);
2170         }
2171     }
2172     if ($url) {
2173         $class = 'arrow_link';
2174         if ($addclass) {
2175             $class .= ' '.$addclass;
2176         }
2177         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/', '', $text).'">'.$htmltext.$arrow.'</a>';
2178     }
2179     return $htmltext.$arrow;
2182 /**
2183  * Return the left arrow with text ('previous'), and optionally embedded in a link.
2184  *
2185  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2186  * @param string $url An optional link to use in a surrounding HTML anchor.
2187  * @param bool $accesshide True if text should be hidden (for screen readers only).
2188  * @param string $addclass Additional class names for the link, or the arrow character.
2189  * @return string HTML string.
2190  */
2191 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
2192     global $OUTPUT; // TODO: move to utput renderer.
2193     $arrowclass = 'arrow ';
2194     if (! $url) {
2195         $arrowclass .= $addclass;
2196     }
2197     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
2198     $htmltext = '';
2199     if ($text) {
2200         $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
2201         if ($accesshide) {
2202             $htmltext = get_accesshide($htmltext);
2203         }
2204     }
2205     if ($url) {
2206         $class = 'arrow_link';
2207         if ($addclass) {
2208             $class .= ' '.$addclass;
2209         }
2210         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/', '', $text).'">'.$arrow.$htmltext.'</a>';
2211     }
2212     return $arrow.$htmltext;
2215 /**
2216  * Return a HTML element with the class "accesshide", for accessibility.
2217  *
2218  * Please use cautiously - where possible, text should be visible!
2219  *
2220  * @param string $text Plain text.
2221  * @param string $elem Lowercase element name, default "span".
2222  * @param string $class Additional classes for the element.
2223  * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
2224  * @return string HTML string.
2225  */
2226 function get_accesshide($text, $elem='span', $class='', $attrs='') {
2227     return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
2230 /**
2231  * Return the breadcrumb trail navigation separator.
2232  *
2233  * @return string HTML string.
2234  */
2235 function get_separator() {
2236     // Accessibility: the 'hidden' slash is preferred for screen readers.
2237     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
2240 /**
2241  * Print (or return) a collapsible region, that has a caption that can be clicked to expand or collapse the region.
2242  *
2243  * If JavaScript is off, then the region will always be expanded.
2244  *
2245  * @param string $contents the contents of the box.
2246  * @param string $classes class names added to the div that is output.
2247  * @param string $id id added to the div that is output. Must not be blank.
2248  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2249  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2250  *      (May be blank if you do not wish the state to be persisted.
2251  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2252  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2253  * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
2254  */
2255 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2256     $output  = print_collapsible_region_start($classes, $id, $caption, $userpref, $default, true);
2257     $output .= $contents;
2258     $output .= print_collapsible_region_end(true);
2260     if ($return) {
2261         return $output;
2262     } else {
2263         echo $output;
2264     }
2267 /**
2268  * Print (or return) the start of a collapsible region
2269  *
2270  * The collapsibleregion has a caption that can be clicked to expand or collapse the region. If JavaScript is off, then the region
2271  * will always be expanded.
2272  *
2273  * @param string $classes class names added to the div that is output.
2274  * @param string $id id added to the div that is output. Must not be blank.
2275  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2276  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2277  *      (May be blank if you do not wish the state to be persisted.
2278  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2279  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2280  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2281  */
2282 function print_collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2283     global $PAGE;
2285     // Work out the initial state.
2286     if (!empty($userpref) and is_string($userpref)) {
2287         user_preference_allow_ajax_update($userpref, PARAM_BOOL);
2288         $collapsed = get_user_preferences($userpref, $default);
2289     } else {
2290         $collapsed = $default;
2291         $userpref = false;
2292     }
2294     if ($collapsed) {
2295         $classes .= ' collapsed';
2296     }
2298     $output = '';
2299     $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2300     $output .= '<div id="' . $id . '_sizer">';
2301     $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2302     $output .= $caption . ' ';
2303     $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2304     $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2306     if ($return) {
2307         return $output;
2308     } else {
2309         echo $output;
2310     }
2313 /**
2314  * Close a region started with print_collapsible_region_start.
2315  *
2316  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2317  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2318  */
2319 function print_collapsible_region_end($return = false) {
2320     $output = '</div></div></div>';
2322     if ($return) {
2323         return $output;
2324     } else {
2325         echo $output;
2326     }
2329 /**
2330  * Print a specified group's avatar.
2331  *
2332  * @param array|stdClass $group A single {@link group} object OR array of groups.
2333  * @param int $courseid The course ID.
2334  * @param boolean $large Default small picture, or large.
2335  * @param boolean $return If false print picture, otherwise return the output as string
2336  * @param boolean $link Enclose image in a link to view specified course?
2337  * @return string|void Depending on the setting of $return
2338  */
2339 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2340     global $CFG;
2342     if (is_array($group)) {
2343         $output = '';
2344         foreach ($group as $g) {
2345             $output .= print_group_picture($g, $courseid, $large, true, $link);
2346         }
2347         if ($return) {
2348             return $output;
2349         } else {
2350             echo $output;
2351             return;
2352         }
2353     }
2355     $context = context_course::instance($courseid);
2357     // If there is no picture, do nothing.
2358     if (!$group->picture) {
2359         return '';
2360     }
2362     // If picture is hidden, only show to those with course:managegroups.
2363     if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
2364         return '';
2365     }
2367     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2368         $output = '<a href="'. $CFG->wwwroot .'/user/index.php?id='. $courseid .'&amp;group='. $group->id .'">';
2369     } else {
2370         $output = '';
2371     }
2372     if ($large) {
2373         $file = 'f1';
2374     } else {
2375         $file = 'f2';
2376     }
2378     $grouppictureurl = moodle_url::make_pluginfile_url($context->id, 'group', 'icon', $group->id, '/', $file);
2379     $grouppictureurl->param('rev', $group->picture);
2380     $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2381         ' alt="'.s(get_string('group').' '.$group->name).'" title="'.s($group->name).'"/>';
2383     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2384         $output .= '</a>';
2385     }
2387     if ($return) {
2388         return $output;
2389     } else {
2390         echo $output;
2391     }
2395 /**
2396  * Display a recent activity note
2397  *
2398  * @staticvar string $strftimerecent
2399  * @param int $time A timestamp int.
2400  * @param stdClass $user A user object from the database.
2401  * @param string $text Text for display for the note
2402  * @param string $link The link to wrap around the text
2403  * @param bool $return If set to true the HTML is returned rather than echo'd
2404  * @param string $viewfullnames
2405  * @return string If $retrun was true returns HTML for a recent activity notice.
2406  */
2407 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2408     static $strftimerecent = null;
2409     $output = '';
2411     if (is_null($viewfullnames)) {
2412         $context = context_system::instance();
2413         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2414     }
2416     if (is_null($strftimerecent)) {
2417         $strftimerecent = get_string('strftimerecent');
2418     }
2420     $output .= '<div class="head">';
2421     $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2422     $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2423     $output .= '</div>';
2424     $output .= '<div class="info"><a href="'.$link.'">'.format_string($text, true).'</a></div>';
2426     if ($return) {
2427         return $output;
2428     } else {
2429         echo $output;
2430     }
2433 /**
2434  * Returns a popup menu with course activity modules
2435  *
2436  * Given a course this function returns a small popup menu with all the course activity modules in it, as a navigation menu
2437  * outputs a simple list structure in XHTML.
2438  * The data is taken from the serialised array stored in the course record.
2439  *
2440  * @param course $course A {@link $COURSE} object.
2441  * @param array $sections
2442  * @param course_modinfo $modinfo
2443  * @param string $strsection
2444  * @param string $strjumpto
2445  * @param int $width
2446  * @param string $cmid
2447  * @return string The HTML block
2448  */
2449 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2451     global $CFG, $OUTPUT;
2453     $section = -1;
2454     $menu = array();
2455     $doneheading = false;
2457     $courseformatoptions = course_get_format($course)->get_format_options();
2458     $coursecontext = context_course::instance($course->id);
2460     $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2461     foreach ($modinfo->cms as $mod) {
2462         if (!$mod->has_view()) {
2463             // Don't show modules which you can't link to!
2464             continue;
2465         }
2467         // For course formats using 'numsections' do not show extra sections.
2468         if (isset($courseformatoptions['numsections']) && $mod->sectionnum > $courseformatoptions['numsections']) {
2469             break;
2470         }
2472         if (!$mod->uservisible) { // Do not icnlude empty sections at all.
2473             continue;
2474         }
2476         if ($mod->sectionnum >= 0 and $section != $mod->sectionnum) {
2477             $thissection = $sections[$mod->sectionnum];
2479             if ($thissection->visible or
2480                     (isset($courseformatoptions['hiddensections']) and !$courseformatoptions['hiddensections']) or
2481                     has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2482                 $thissection->summary = strip_tags(format_string($thissection->summary, true));
2483                 if (!$doneheading) {
2484                     $menu[] = '</ul></li>';
2485                 }
2486                 if ($course->format == 'weeks' or empty($thissection->summary)) {
2487                     $item = $strsection ." ". $mod->sectionnum;
2488                 } else {
2489                     if (core_text::strlen($thissection->summary) < ($width-3)) {
2490                         $item = $thissection->summary;
2491                     } else {
2492                         $item = core_text::substr($thissection->summary, 0, $width).'...';
2493                     }
2494                 }
2495                 $menu[] = '<li class="section"><span>'.$item.'</span>';
2496                 $menu[] = '<ul>';
2497                 $doneheading = true;
2499                 $section = $mod->sectionnum;
2500             } else {
2501                 // No activities from this hidden section shown.
2502                 continue;
2503             }
2504         }
2506         $url = $mod->modname .'/view.php?id='. $mod->id;
2507         $mod->name = strip_tags(format_string($mod->name ,true));
2508         if (core_text::strlen($mod->name) > ($width+5)) {
2509             $mod->name = core_text::substr($mod->name, 0, $width).'...';
2510         }
2511         if (!$mod->visible) {
2512             $mod->name = '('.$mod->name.')';
2513         }
2514         $class = 'activity '.$mod->modname;
2515         $class .= ($cmid == $mod->id) ? ' selected' : '';
2516         $menu[] = '<li class="'.$class.'">'.
2517                   '<img src="'.$OUTPUT->pix_url('icon', $mod->modname) . '" alt="" />'.
2518                   '<a href="'.$CFG->wwwroot.'/mod/'.$url.'">'.$mod->name.'</a></li>';
2519     }
2521     if ($doneheading) {
2522         $menu[] = '</ul></li>';
2523     }
2524     $menu[] = '</ul></li></ul>';
2526     return implode("\n", $menu);
2529 /**
2530  * Prints a grade menu (as part of an existing form) with help showing all possible numerical grades and scales.
2531  *
2532  * @todo Finish documenting this function
2533  * @todo Deprecate: this is only used in a few contrib modules
2534  *
2535  * @param int $courseid The course ID
2536  * @param string $name
2537  * @param string $current
2538  * @param boolean $includenograde Include those with no grades
2539  * @param boolean $return If set to true returns rather than echo's
2540  * @return string|bool Depending on value of $return
2541  */
2542 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2543     global $OUTPUT;
2545     $output = '';
2546     $strscale = get_string('scale');
2547     $strscales = get_string('scales');
2549     $scales = get_scales_menu($courseid);
2550     foreach ($scales as $i => $scalename) {
2551         $grades[-$i] = $strscale .': '. $scalename;
2552     }
2553     if ($includenograde) {
2554         $grades[0] = get_string('nograde');
2555     }
2556     for ($i=100; $i>=1; $i--) {
2557         $grades[$i] = $i;
2558     }
2559     $output .= html_writer::select($grades, $name, $current, false);
2561     $helppix = $OUTPUT->pix_url('help');
2562     $linkobject = '<span class="helplink"><img class="iconhelp" alt="'.$strscales.'" src="'.$helppix.'" /></span>';
2563     $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => 1));
2564     $action = new popup_action('click', $link, 'ratingscales', array('height' => 400, 'width' => 500));
2565     $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title' => $strscales));
2567     if ($return) {
2568         return $output;
2569     } else {
2570         echo $output;
2571     }
2574 /**
2575  * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2576  *
2577  * Default errorcode is 1.
2578  *
2579  * Very useful for perl-like error-handling:
2580  * do_somethting() or mdie("Something went wrong");
2581  *
2582  * @param string  $msg       Error message
2583  * @param integer $errorcode Error code to emit
2584  */
2585 function mdie($msg='', $errorcode=1) {
2586     trigger_error($msg);
2587     exit($errorcode);
2590 /**
2591  * Print a message and exit.
2592  *
2593  * @param string $message The message to print in the notice
2594  * @param string $link The link to use for the continue button
2595  * @param object $course A course object. Unused.
2596  * @return void This function simply exits
2597  */
2598 function notice ($message, $link='', $course=null) {
2599     global $PAGE, $OUTPUT;
2601     $message = clean_text($message);   // In case nasties are in here.
2603     if (CLI_SCRIPT) {
2604         echo("!!$message!!\n");
2605         exit(1); // No success.
2606     }
2608     if (!$PAGE->headerprinted) {
2609         // Header not yet printed.
2610         $PAGE->set_title(get_string('notice'));
2611         echo $OUTPUT->header();
2612     } else {
2613         echo $OUTPUT->container_end_all(false);
2614     }
2616     echo $OUTPUT->box($message, 'generalbox', 'notice');
2617     echo $OUTPUT->continue_button($link);
2619     echo $OUTPUT->footer();
2620     exit(1); // General error code.
2623 /**
2624  * Redirects the user to another page, after printing a notice.
2625  *
2626  * This function calls the OUTPUT redirect method, echo's the output and then dies to ensure nothing else happens.
2627  *
2628  * <strong>Good practice:</strong> You should call this method before starting page
2629  * output by using any of the OUTPUT methods.
2630  *
2631  * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2632  * @param string $message The message to display to the user
2633  * @param int $delay The delay before redirecting
2634  * @param string $messagetype The type of notification to show the message in. See constants on \core\output\notification.
2635  * @throws moodle_exception
2636  */
2637 function redirect($url, $message='', $delay=null, $messagetype = \core\output\notification::NOTIFY_INFO) {
2638     global $OUTPUT, $PAGE, $CFG;
2640     if (CLI_SCRIPT or AJAX_SCRIPT) {
2641         // This is wrong - developers should not use redirect in these scripts but it should not be very likely.
2642         throw new moodle_exception('redirecterrordetected', 'error');
2643     }
2645     if ($delay === null) {
2646         $delay = -1;
2647     }
2649     // Prevent debug errors - make sure context is properly initialised.
2650     if ($PAGE) {
2651         $PAGE->set_context(null);
2652         $PAGE->set_pagelayout('redirect');  // No header and footer needed.
2653         $PAGE->set_title(get_string('pageshouldredirect', 'moodle'));
2654     }
2656     if ($url instanceof moodle_url) {
2657         $url = $url->out(false);
2658     }
2660     $debugdisableredirect = false;
2661     do {
2662         if (defined('DEBUGGING_PRINTED')) {
2663             // Some debugging already printed, no need to look more.
2664             $debugdisableredirect = true;
2665             break;
2666         }
2668         if (core_useragent::is_msword()) {
2669             // Clicking a URL from MS Word sends a request to the server without cookies. If that
2670             // causes a redirect Word will open a browser pointing the new URL. If not, the URL that
2671             // was clicked is opened. Because the request from Word is without cookies, it almost
2672             // always results in a redirect to the login page, even if the user is logged in in their
2673             // browser. This is not what we want, so prevent the redirect for requests from Word.
2674             $debugdisableredirect = true;
2675             break;
2676         }
2678         if (empty($CFG->debugdisplay) or empty($CFG->debug)) {
2679             // No errors should be displayed.
2680             break;
2681         }
2683         if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2684             break;
2685         }
2687         if (!($lasterror['type'] & $CFG->debug)) {
2688             // Last error not interesting.
2689             break;
2690         }
2692         // Watch out here, @hidden() errors are returned from error_get_last() too.
2693         if (headers_sent()) {
2694             // We already started printing something - that means errors likely printed.
2695             $debugdisableredirect = true;
2696             break;
2697         }
2699         if (ob_get_level() and ob_get_contents()) {
2700             // There is something waiting to be printed, hopefully it is the errors,
2701             // but it might be some error hidden by @ too - such as the timezone mess from setup.php.
2702             $debugdisableredirect = true;
2703             break;
2704         }
2705     } while (false);
2707     // Technically, HTTP/1.1 requires Location: header to contain the absolute path.
2708     // (In practice browsers accept relative paths - but still, might as well do it properly.)
2709     // This code turns relative into absolute.
2710     if (!preg_match('|^[a-z]+:|i', $url)) {
2711         // Get host name http://www.wherever.com.
2712         $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2713         if (preg_match('|^/|', $url)) {
2714             // URLs beginning with / are relative to web server root so we just add them in.
2715             $url = $hostpart.$url;
2716         } else {
2717             // URLs not beginning with / are relative to path of current script, so add that on.
2718             $url = $hostpart.preg_replace('|\?.*$|', '', me()).'/../'.$url;
2719         }
2720         // Replace all ..s.
2721         while (true) {
2722             $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2723             if ($newurl == $url) {
2724                 break;
2725             }
2726             $url = $newurl;
2727         }
2728     }
2730     // Sanitise url - we can not rely on moodle_url or our URL cleaning
2731     // because they do not support all valid external URLs.
2732     $url = preg_replace('/[\x00-\x1F\x7F]/', '', $url);
2733     $url = str_replace('"', '%22', $url);
2734     $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2735     $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />', FORMAT_HTML));
2736     $url = str_replace('&amp;', '&', $encodedurl);
2738     if (!empty($message)) {
2739         if (!$debugdisableredirect && !headers_sent()) {
2740             // A message has been provided, and the headers have not yet been sent.
2741             // Display the message as a notification on the subsequent page.
2742             \core\notification::add($message, $messagetype);
2743             $message = null;
2744             $delay = 0;
2745         } else {
2746             if ($delay === -1 || !is_numeric($delay)) {
2747                 $delay = 3;
2748             }
2749             $message = clean_text($message);
2750         }
2751     } else {
2752         $message = get_string('pageshouldredirect');
2753         $delay = 0;
2754     }
2756     // Make sure the session is closed properly, this prevents problems in IIS
2757     // and also some potential PHP shutdown issues.
2758     \core\session\manager::write_close();
2760     if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2761         // 302 might not work for POST requests, 303 is ignored by obsolete clients.
2762         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2763         @header('Location: '.$url);
2764         echo bootstrap_renderer::plain_redirect_message($encodedurl);
2765         exit;
2766     }
2768     // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2769     if ($PAGE) {
2770         $CFG->docroot = false; // To prevent the link to moodle docs from being displayed on redirect page.
2771         echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect, $messagetype);
2772         exit;
2773     } else {
2774         echo bootstrap_renderer::early_redirect_message($encodedurl, $message, $delay);
2775         exit;
2776     }
2779 /**
2780  * Given an email address, this function will return an obfuscated version of it.
2781  *
2782  * @param string $email The email address to obfuscate
2783  * @return string The obfuscated email address
2784  */
2785 function obfuscate_email($email) {
2786     $i = 0;
2787     $length = strlen($email);
2788     $obfuscated = '';
2789     while ($i < $length) {
2790         if (rand(0, 2) && $email{$i}!='@') { // MDL-20619 some browsers have problems unobfuscating @.
2791             $obfuscated.='%'.dechex(ord($email{$i}));
2792         } else {
2793             $obfuscated.=$email{$i};
2794         }
2795         $i++;
2796     }
2797     return $obfuscated;
2800 /**
2801  * This function takes some text and replaces about half of the characters
2802  * with HTML entity equivalents.   Return string is obviously longer.
2803  *
2804  * @param string $plaintext The text to be obfuscated
2805  * @return string The obfuscated text
2806  */
2807 function obfuscate_text($plaintext) {
2808     $i=0;
2809     $length = core_text::strlen($plaintext);
2810     $obfuscated='';
2811     $prevobfuscated = false;
2812     while ($i < $length) {
2813         $char = core_text::substr($plaintext, $i, 1);
2814         $ord = core_text::utf8ord($char);
2815         $numerical = ($ord >= ord('0')) && ($ord <= ord('9'));
2816         if ($prevobfuscated and $numerical ) {
2817             $obfuscated.='&#'.$ord.';';
2818         } else if (rand(0, 2)) {
2819             $obfuscated.='&#'.$ord.';';
2820             $prevobfuscated = true;
2821         } else {
2822             $obfuscated.=$char;
2823             $prevobfuscated = false;
2824         }
2825         $i++;
2826     }
2827     return $obfuscated;
2830 /**
2831  * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2832  * to generate a fully obfuscated email link, ready to use.
2833  *
2834  * @param string $email The email address to display
2835  * @param string $label The text to displayed as hyperlink to $email
2836  * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2837  * @param string $subject The subject of the email in the mailto link
2838  * @param string $body The content of the email in the mailto link
2839  * @return string The obfuscated mailto link
2840  */
2841 function obfuscate_mailto($email, $label='', $dimmed=false, $subject = '', $body = '') {
2843     if (empty($label)) {
2844         $label = $email;
2845     }
2847     $label = obfuscate_text($label);
2848     $email = obfuscate_email($email);
2849     $mailto = obfuscate_text('mailto');
2850     $url = new moodle_url("mailto:$email");
2851     $attrs = array();
2853     if (!empty($subject)) {
2854         $url->param('subject', format_string($subject));
2855     }
2856     if (!empty($body)) {
2857         $url->param('body', format_string($body));
2858     }
2860     // Use the obfuscated mailto.
2861     $url = preg_replace('/^mailto/', $mailto, $url->out());
2863     if ($dimmed) {
2864         $attrs['title'] = get_string('emaildisable');
2865         $attrs['class'] = 'dimmed';
2866     }
2868     return html_writer::link($url, $label, $attrs);
2871 /**
2872  * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2873  * will transform it to html entities
2874  *
2875  * @param string $text Text to search for nolink tag in
2876  * @return string
2877  */
2878 function rebuildnolinktag($text) {
2880     $text = preg_replace('/&lt;(\/*nolink)&gt;/i', '<$1>', $text);
2882     return $text;
2885 /**
2886  * Prints a maintenance message from $CFG->maintenance_message or default if empty.
2887  */
2888 function print_maintenance_message() {
2889     global $CFG, $SITE, $PAGE, $OUTPUT;
2891     $PAGE->set_pagetype('maintenance-message');
2892     $PAGE->set_pagelayout('maintenance');
2893     $PAGE->set_title(strip_tags($SITE->fullname));
2894     $PAGE->set_heading($SITE->fullname);
2895     echo $OUTPUT->header();
2896     echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2897     if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
2898         echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2899         echo $CFG->maintenance_message;
2900         echo $OUTPUT->box_end();
2901     }
2902     echo $OUTPUT->footer();
2903     die;
2906 /**
2907  * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2908  *
2909  * It is not recommended to use this function in Moodle 2.5 but it is left for backward
2910  * compartibility.
2911  *
2912  * Example how to print a single line tabs:
2913  * $rows = array(
2914  *    new tabobject(...),
2915  *    new tabobject(...)
2916  * );
2917  * echo $OUTPUT->tabtree($rows, $selectedid);
2918  *
2919  * Multiple row tabs may not look good on some devices but if you want to use them
2920  * you can specify ->subtree for the active tabobject.
2921  *
2922  * @param array $tabrows An array of rows where each row is an array of tab objects
2923  * @param string $selected  The id of the selected tab (whatever row it's on)
2924  * @param array  $inactive  An array of ids of inactive tabs that are not selectable.
2925  * @param array  $activated An array of ids of other tabs that are currently activated
2926  * @param bool $return If true output is returned rather then echo'd
2927  * @return string HTML output if $return was set to true.
2928  */
2929 function print_tabs($tabrows, $selected = null, $inactive = null, $activated = null, $return = false) {
2930     global $OUTPUT;
2932     $tabrows = array_reverse($tabrows);
2933     $subtree = array();
2934     foreach ($tabrows as $row) {
2935         $tree = array();
2937         foreach ($row as $tab) {
2938             $tab->inactive = is_array($inactive) && in_array((string)$tab->id, $inactive);
2939             $tab->activated = is_array($activated) && in_array((string)$tab->id, $activated);
2940             $tab->selected = (string)$tab->id == $selected;
2942             if ($tab->activated || $tab->selected) {
2943                 $tab->subtree = $subtree;
2944             }
2945             $tree[] = $tab;
2946         }
2947         $subtree = $tree;
2948     }
2949     $output = $OUTPUT->tabtree($subtree);
2950     if ($return) {
2951         return $output;
2952     } else {
2953         print $output;
2954         return !empty($output);
2955     }
2958 /**
2959  * Alter debugging level for the current request,
2960  * the change is not saved in database.
2961  *
2962  * @param int $level one of the DEBUG_* constants
2963  * @param bool $debugdisplay
2964  */
2965 function set_debugging($level, $debugdisplay = null) {
2966     global $CFG;
2968     $CFG->debug = (int)$level;
2969     $CFG->debugdeveloper = (($CFG->debug & DEBUG_DEVELOPER) === DEBUG_DEVELOPER);
2971     if ($debugdisplay !== null) {
2972         $CFG->debugdisplay = (bool)$debugdisplay;
2973     }
2976 /**
2977  * Standard Debugging Function
2978  *
2979  * Returns true if the current site debugging settings are equal or above specified level.
2980  * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2981  * routing of notices is controlled by $CFG->debugdisplay
2982  * eg use like this:
2983  *
2984  * 1)  debugging('a normal debug notice');
2985  * 2)  debugging('something really picky', DEBUG_ALL);
2986  * 3)  debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
2987  * 4)  if (debugging()) { perform extra debugging operations (do not use print or echo) }
2988  *
2989  * In code blocks controlled by debugging() (such as example 4)
2990  * any output should be routed via debugging() itself, or the lower-level
2991  * trigger_error() or error_log(). Using echo or print will break XHTML
2992  * JS and HTTP headers.
2993  *
2994  * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2995  *
2996  * @param string $message a message to print
2997  * @param int $level the level at which this debugging statement should show
2998  * @param array $backtrace use different backtrace
2999  * @return bool
3000  */
3001 function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
3002     global $CFG, $USER;
3004     $forcedebug = false;
3005     if (!empty($CFG->debugusers) && $USER) {
3006         $debugusers = explode(',', $CFG->debugusers);
3007         $forcedebug = in_array($USER->id, $debugusers);
3008     }
3010     if (!$forcedebug and (empty($CFG->debug) || ($CFG->debug != -1 and $CFG->debug < $level))) {
3011         return false;
3012     }
3014     if (!isset($CFG->debugdisplay)) {
3015         $CFG->debugdisplay = ini_get_bool('display_errors');
3016     }
3018     if ($message) {
3019         if (!$backtrace) {
3020             $backtrace = debug_backtrace();
3021         }
3022         $from = format_backtrace($backtrace, CLI_SCRIPT || NO_DEBUG_DISPLAY);
3023         if (PHPUNIT_TEST) {
3024             if (phpunit_util::debugging_triggered($message, $level, $from)) {
3025                 // We are inside test, the debug message was logged.
3026                 return true;
3027             }
3028         }
3030         if (NO_DEBUG_DISPLAY) {
3031             // Script does not want any errors or debugging in output,
3032             // we send the info to error log instead.
3033             error_log('Debugging: ' . $message . ' in '. PHP_EOL . $from);
3035         } else if ($forcedebug or $CFG->debugdisplay) {
3036             if (!defined('DEBUGGING_PRINTED')) {
3037                 define('DEBUGGING_PRINTED', 1); // Indicates we have printed something.
3038             }
3039             if (CLI_SCRIPT) {
3040                 echo "++ $message ++\n$from";
3041             } else {
3042                 echo '<div class="notifytiny debuggingmessage" data-rel="debugging">' , $message , $from , '</div>';
3043             }
3045         } else {
3046             trigger_error($message . $from, E_USER_NOTICE);
3047         }
3048     }
3049     return true;
3052 /**
3053  * Outputs a HTML comment to the browser.
3054  *
3055  * This is used for those hard-to-debug pages that use bits from many different files in very confusing ways (e.g. blocks).
3056  *
3057  * <code>print_location_comment(__FILE__, __LINE__);</code>
3058  *
3059  * @param string $file
3060  * @param integer $line
3061  * @param boolean $return Whether to return or print the comment
3062  * @return string|void Void unless true given as third parameter
3063  */
3064 function print_location_comment($file, $line, $return = false) {
3065     if ($return) {
3066         return "<!-- $file at line $line -->\n";
3067     } else {
3068         echo "<!-- $file at line $line -->\n";
3069     }
3073 /**
3074  * Returns true if the user is using a right-to-left language.
3075  *
3076  * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
3077  */
3078 function right_to_left() {
3079     return (get_string('thisdirection', 'langconfig') === 'rtl');
3083 /**
3084  * Returns swapped left<=> right if in RTL environment.
3085  *
3086  * Part of RTL Moodles support.
3087  *
3088  * @param string $align align to check
3089  * @return string
3090  */
3091 function fix_align_rtl($align) {
3092     if (!right_to_left()) {
3093         return $align;
3094     }
3095     if ($align == 'left') {
3096         return 'right';
3097     }
3098     if ($align == 'right') {
3099         return 'left';
3100     }
3101     return $align;
3105 /**
3106  * Returns true if the page is displayed in a popup window.
3107  *
3108  * Gets the information from the URL parameter inpopup.
3109  *
3110  * @todo Use a central function to create the popup calls all over Moodle and
3111  * In the moment only works with resources and probably questions.
3112  *
3113  * @return boolean
3114  */
3115 function is_in_popup() {
3116     $inpopup = optional_param('inpopup', '', PARAM_BOOL);
3118     return ($inpopup);
3121 /**
3122  * Progress bar class.
3123  *
3124  * Manages the display of a progress bar.
3125  *
3126  * To use this class.
3127  * - construct
3128  * - call create (or use the 3rd param to the constructor)
3129  * - call update or update_full() or update() repeatedly
3130  *
3131  * @copyright 2008 jamiesensei
3132  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3133  * @package core
3134  */
3135 class progress_bar {
3136     /** @var string html id */
3137     private $html_id;
3138     /** @var int total width */
3139     private $width;
3140     /** @var int last percentage printed */
3141     private $percent = 0;
3142     /** @var int time when last printed */
3143     private $lastupdate = 0;
3144     /** @var int when did we start printing this */
3145     private $time_start = 0;
3147     /**
3148      * Constructor
3149      *
3150      * Prints JS code if $autostart true.
3151      *
3152      * @param string $html_id
3153      * @param int $width
3154      * @param bool $autostart Default to false
3155      */
3156     public function __construct($htmlid = '', $width = 500, $autostart = false) {
3157         if (!empty($htmlid)) {
3158             $this->html_id  = $htmlid;
3159         } else {
3160             $this->html_id  = 'pbar_'.uniqid();
3161         }
3163         $this->width = $width;
3165         if ($autostart) {
3166             $this->create();
3167         }
3168     }
3170     /**
3171      * Create a new progress bar, this function will output html.
3172      *
3173      * @return void Echo's output
3174      */
3175     public function create() {
3176         global $PAGE;
3178         $this->time_start = microtime(true);
3179         if (CLI_SCRIPT) {
3180             return; // Temporary solution for cli scripts.
3181         }
3183         $PAGE->requires->string_for_js('secondsleft', 'moodle');
3185         $htmlcode = <<<EOT
3186         <div class="progressbar_container" style="width: {$this->width}px;" id="{$this->html_id}">
3187             <h2></h2>
3188             <div class="progress progress-striped active">
3189                 <div class="bar" role="progressbar" aria-valuemin="0" aria-valuemax="100" aria-valuenow="0">&nbsp;</div>
3190             </div>
3191             <p></p>
3192         </div>
3193 EOT;
3194         flush();
3195         echo $htmlcode;
3196         flush();
3197     }
3199     /**
3200      * Update the progress bar
3201      *
3202      * @param int $percent from 1-100
3203      * @param string $msg
3204      * @return void Echo's output
3205      * @throws coding_exception
3206      */
3207     private function _update($percent, $msg) {
3208         if (empty($this->time_start)) {
3209             throw new coding_exception('You must call create() (or use the $autostart ' .
3210                     'argument to the constructor) before you try updating the progress bar.');
3211         }
3213         if (CLI_SCRIPT) {
3214             return; // Temporary solution for cli scripts.
3215         }
3217         $estimate = $this->estimate($percent);
3219         if ($estimate === null) {
3220             // Always do the first and last updates.
3221         } else if ($estimate == 0) {
3222             // Always do the last updates.
3223         } else if ($this->lastupdate + 20 < time()) {
3224             // We must update otherwise browser would time out.
3225         } else if (round($this->percent, 2) === round($percent, 2)) {
3226             // No significant change, no need to update anything.
3227             return;
3228         }
3229         if (is_numeric($estimate)) {
3230             $estimate = get_string('secondsleft', 'moodle', round($estimate, 2));
3231         }
3233         $this->percent = round($percent, 2);
3234         $this->lastupdate = microtime(true);
3236         echo html_writer::script(js_writer::function_call('updateProgressBar',
3237             array($this->html_id, $this->percent, $msg, $estimate)));
3238         flush();
3239     }
3241     /**
3242      * Estimate how much time it is going to take.
3243      *
3244      * @param int $pt from 1-100
3245      * @return mixed Null (unknown), or int
3246      */
3247     private function estimate($pt) {
3248         if ($this->lastupdate == 0) {
3249             return null;
3250         }
3251         if ($pt < 0.00001) {
3252             return null; // We do not know yet how long it will take.
3253         }
3254         if ($pt > 99.99999) {
3255             return 0; // Nearly done, right?
3256         }
3257         $consumed = microtime(true) - $this->time_start;
3258         if ($consumed < 0.001) {
3259             return null;
3260         }
3262         return (100 - $pt) * ($consumed / $pt);
3263     }
3265     /**
3266      * Update progress bar according percent
3267      *
3268      * @param int $percent from 1-100
3269      * @param string $msg the message needed to be shown
3270      */
3271     public function update_full($percent, $msg) {
3272         $percent = max(min($percent, 100), 0);
3273         $this->_update($percent, $msg);
3274     }
3276     /**
3277      * Update progress bar according the number of tasks
3278      *
3279      * @param int $cur current task number
3280      * @param int $total total task number
3281      * @param string $msg message
3282      */
3283     public function update($cur, $total, $msg) {
3284         $percent = ($cur / $total) * 100;
3285         $this->update_full($percent, $msg);
3286     }
3288     /**
3289      * Restart the progress bar.
3290      */
3291     public function restart() {
3292         $this->percent    = 0;
3293         $this->lastupdate = 0;
3294         $this->time_start = 0;
3295     }
3298 /**
3299  * Progress trace class.
3300  *
3301  * Use this class from long operations where you want to output occasional information about
3302  * what is going on, but don't know if, or in what format, the output should be.
3303  *
3304  * @copyright 2009 Tim Hunt
3305  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3306  * @package core
3307  */
3308 abstract class progress_trace {
3309     /**
3310      * Output an progress message in whatever format.
3311      *
3312      * @param string $message the message to output.
3313      * @param integer $depth indent depth for this message.
3314      */
3315     abstract public function output($message, $depth = 0);
3317     /**
3318      * Called when the processing is finished.
3319      */
3320     public function finished() {
3321     }
3324 /**
3325  * This subclass of progress_trace does not ouput anything.
3326  *
3327  * @copyright 2009 Tim Hunt
3328  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3329  * @package core
3330  */
3331 class null_progress_trace extends progress_trace {
3332     /**
3333      * Does Nothing
3334      *
3335      * @param string $message
3336      * @param int $depth
3337      * @return void Does Nothing
3338      */
3339     public function output($message, $depth = 0) {
3340     }
3343 /**
3344  * This subclass of progress_trace outputs to plain text.
3345  *
3346  * @copyright 2009 Tim Hunt
3347  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3348  * @package core
3349  */
3350 class text_progress_trace extends progress_trace {
3351     /**
3352      * Output the trace message.
3353      *
3354      * @param string $message
3355      * @param int $depth
3356      * @return void Output is echo'd
3357      */
3358     public function output($message, $depth = 0) {
3359         echo str_repeat('  ', $depth), $message, "\n";
3360         flush();
3361     }
3364 /**
3365  * This subclass of progress_trace outputs as HTML.
3366  *
3367  * @copyright 2009 Tim Hunt
3368  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3369  * @package core
3370  */
3371 class html_progress_trace extends progress_trace {
3372     /**
3373      * Output the trace message.
3374      *
3375      * @param string $message
3376      * @param int $depth
3377      * @return void Output is echo'd
3378      */
3379     public function output($message, $depth = 0) {
3380         echo '<p>', str_repeat('&#160;&#160;', $depth), htmlspecialchars($message), "</p>\n";
3381         flush();
3382     }
3385 /**
3386  * HTML List Progress Tree
3387  *
3388  * @copyright 2009 Tim Hunt
3389  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3390  * @package core
3391  */
3392 class html_list_progress_trace extends progress_trace {
3393     /** @var int */
3394     protected $currentdepth = -1;
3396     /**
3397      * Echo out the list
3398      *
3399      * @param string $message The message to display
3400      * @param int $depth
3401      * @return void Output is echoed
3402      */
3403     public function output($message, $depth = 0) {
3404         $samedepth = true;
3405         while ($this->currentdepth > $depth) {
3406             echo "</li>\n</ul>\n";
3407             $this->currentdepth -= 1;
3408             if ($this->currentdepth == $depth) {
3409                 echo '<li>';
3410             }
3411             $samedepth = false;
3412         }
3413         while ($this->currentdepth < $depth) {
3414             echo "<ul>\n<li>";
3415             $this->currentdepth += 1;
3416             $samedepth = false;
3417         }
3418         if ($samedepth) {
3419             echo "</li>\n<li>";
3420         }
3421         echo htmlspecialchars($message);
3422         flush();
3423     }
3425     /**
3426      * Called when the processing is finished.
3427      */
3428     public function finished() {
3429         while ($this->currentdepth >= 0) {
3430             echo "</li>\n</ul>\n";
3431             $this->currentdepth -= 1;
3432         }
3433     }
3436 /**
3437  * This subclass of progress_trace outputs to error log.
3438  *
3439  * @copyright Petr Skoda {@link http://skodak.org}
3440  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3441  * @package core
3442  */
3443 class error_log_progress_trace extends progress_trace {
3444     /** @var string log prefix */
3445     protected $prefix;
3447     /**
3448      * Constructor.
3449      * @param string $prefix optional log prefix
3450      */
3451     public function __construct($prefix = '') {
3452         $this->prefix = $prefix;
3453     }
3455     /**
3456      * Output the trace message.
3457      *
3458      * @param string $message
3459      * @param int $depth
3460      * @return void Output is sent to error log.
3461      */
3462     public function output($message, $depth = 0) {
3463         error_log($this->prefix . str_repeat('  ', $depth) . $message);
3464     }
3467 /**
3468  * Special type of trace that can be used for catching of output of other traces.
3469  *
3470  * @copyright Petr Skoda {@link http://skodak.org}
3471  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3472  * @package core
3473  */
3474 class progress_trace_buffer extends progress_trace {
3475     /** @var progres_trace */
3476     protected $trace;
3477     /** @var bool do we pass output out */
3478     protected $passthrough;
3479     /** @var string output buffer */
3480     protected $buffer;
3482     /**
3483      * Constructor.
3484      *
3485      * @param progress_trace $trace
3486      * @param bool $passthrough true means output and buffer, false means just buffer and no output
3487      */
3488     public function __construct(progress_trace $trace, $passthrough = true) {
3489         $this->trace       = $trace;
3490         $this->passthrough = $passthrough;
3491         $this->buffer      = '';
3492     }
3494     /**
3495      * Output the trace message.
3496      *
3497      * @param string $message the message to output.
3498      * @param int $depth indent depth for this message.
3499      * @return void output stored in buffer
3500      */
3501     public function output($message, $depth = 0) {
3502         ob_start();
3503         $this->trace->output($message, $depth);
3504         $this->buffer .= ob_get_contents();
3505         if ($this->passthrough) {
3506             ob_end_flush();
3507         } else {
3508             ob_end_clean();
3509         }
3510     }
3512     /**
3513      * Called when the processing is finished.
3514      */
3515     public function finished() {
3516         ob_start();
3517         $this->trace->finished();
3518         $this->buffer .= ob_get_contents();
3519         if ($this->passthrough) {
3520             ob_end_flush();
3521         } else {
3522             ob_end_clean();
3523         }
3524     }
3526     /**
3527      * Reset internal text buffer.
3528      */
3529     public function reset_buffer() {
3530         $this->buffer = '';
3531     }
3533     /**
3534      * Return internal text buffer.
3535      * @return string buffered plain text
3536      */
3537     public function get_buffer() {
3538         return $this->buffer;
3539     }
3542 /**
3543  * Special type of trace that can be used for redirecting to multiple other traces.
3544  *
3545  * @copyright Petr Skoda {@link http://skodak.org}
3546  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3547  * @package core
3548  */
3549 class combined_progress_trace extends progress_trace {
3551     /**
3552      * An array of traces.
3553      * @var array
3554      */
3555     protected $traces;
3557     /**
3558      * Constructs a new instance.
3559      *
3560      * @param array $traces multiple traces
3561      */
3562     public function __construct(array $traces) {
3563         $this->traces = $traces;
3564     }
3566     /**
3567      * Output an progress message in whatever format.
3568      *
3569      * @param string $message the message to output.
3570      * @param integer $depth indent depth for this message.
3571      */
3572     public function output($message, $depth = 0) {
3573         foreach ($this->traces as $trace) {
3574             $trace->output($message, $depth);
3575         }
3576     }
3578     /**
3579      * Called when the processing is finished.
3580      */
3581     public function finished() {
3582         foreach ($this->traces as $trace) {
3583             $trace->finished();
3584         }
3585     }
3588 /**
3589  * Returns a localized sentence in the current language summarizing the current password policy
3590  *
3591  * @todo this should be handled by a function/method in the language pack library once we have a support for it
3592  * @uses $CFG
3593  * @return string
3594  */
3595 function print_password_policy() {
3596     global $CFG;
3598     $message = '';
3599     if (!empty($CFG->passwordpolicy)) {
3600         $messages = array();
3601         $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength);
3602         if (!empty($CFG->minpassworddigits)) {
3603             $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits);
3604         }
3605         if (!empty($CFG->minpasswordlower)) {
3606             $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower);
3607         }
3608         if (!empty($CFG->minpasswordupper)) {
3609             $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper);
3610         }
3611         if (!empty($CFG->minpasswordnonalphanum)) {
3612             $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3613         }
3615         $messages = join(', ', $messages); // This is ugly but we do not have anything better yet...
3616         $message = get_string('informpasswordpolicy', 'auth', $messages);
3617     }
3618     return $message;
3621 /**
3622  * Get the value of a help string fully prepared for display in the current language.
3623  *
3624  * @param string $identifier The identifier of the string to search for.
3625  * @param string $component The module the string is associated with.
3626  * @param boolean $ajax Whether this help is called from an AJAX script.
3627  *                This is used to influence text formatting and determines
3628  *                which format to output the doclink in.
3629  * @param string|object|array $a An object, string or number that can be used
3630  *      within translation strings
3631  * @return Object An object containing:
3632  * - heading: Any heading that there may be for this help string.
3633  * - text: The wiki-formatted help string.
3634  * - doclink: An object containing a link, the linktext, and any additional
3635  *            CSS classes to apply to that link. Only present if $ajax = false.
3636  * - completedoclink: A text representation of the doclink. Only present if $ajax = true.
3637  */
3638 function get_formatted_help_string($identifier, $component, $ajax = false, $a = null) {
3639     global $CFG, $OUTPUT;
3640     $sm = get_string_manager();
3642     // Do not rebuild caches here!
3643     // Devs need to learn to purge all caches after any change or disable $CFG->langstringcache.
3645     $data = new stdClass();
3647     if ($sm->string_exists($identifier, $component)) {
3648         $data->heading = format_string(get_string($identifier, $component));
3649     } else {
3650         // Gracefully fall back to an empty string.
3651         $data->heading = '';
3652     }
3654     if ($sm->string_exists($identifier . '_help', $component)) {
3655         $options = new stdClass();
3656         $options->trusted = false;
3657         $options->noclean = false;
3658         $options->smiley = false;
3659         $options->filter = false;
3660         $options->para = true;
3661         $options->newlines = false;
3662         $options->overflowdiv = !$ajax;
3664         // Should be simple wiki only MDL-21695.
3665         $data->text = format_text(get_string($identifier.'_help', $component, $a), FORMAT_MARKDOWN, $options);
3667         $helplink = $identifier . '_link';
3668         if ($sm->string_exists($helplink, $component)) {  // Link to further info in Moodle docs.
3669             $link = get_string($helplink, $component);
3670             $linktext = get_string('morehelp');
3672             $data->doclink = new stdClass();
3673             $url = new moodle_url(get_docs_url($link));
3674             if ($ajax) {
3675                 $data->doclink->link = $url->out();
3676                 $data->doclink->linktext = $linktext;
3677                 $data->doclink->class = ($CFG->doctonewwindow) ? 'helplinkpopup' : '';
3678             } else {
3679                 $data->completedoclink = html_writer::tag('div', $OUTPUT->doc_link($link, $linktext),
3680                     array('class' => 'helpdoclink'));
3681             }
3682         }
3683     } else {
3684         $data->text = html_writer::tag('p',
3685             html_writer::tag('strong', 'TODO') . ": missing help string [{$identifier}_help, {$component}]");
3686     }
3687     return $data;
3690 /**
3691  * Renders a hidden password field so that browsers won't incorrectly autofill password fields with the user's password.
3692  *
3693  * @since 3.0
3694  * @return string HTML to prevent password autofill
3695  */
3696 function prevent_form_autofill_password() {
3697     return '<div class="hide"><input type="text" class="ignoredirty" /><input type="password" class="ignoredirty" /></div>';