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