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