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