29a246600874848cf8abb8f69ac6b7cd59837ff6
[moodle.git] / lib / weblib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of functions for web output
20  *
21  * Library of all general-purpose Moodle PHP functions and constants
22  * that produce HTML output
23  *
24  * Other main libraries:
25  * - datalib.php - functions that access the database.
26  * - moodlelib.php - general-purpose Moodle functions.
27  *
28  * @package    core
29  * @subpackage lib
30  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
31  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32  */
34 defined('MOODLE_INTERNAL') || die();
36 /// Constants
38 /// Define text formatting types ... eventually we can add Wiki, BBcode etc
40 /**
41  * Does all sorts of transformations and filtering
42  */
43 define('FORMAT_MOODLE',   '0');   // Does all sorts of transformations and filtering
45 /**
46  * Plain HTML (with some tags stripped)
47  */
48 define('FORMAT_HTML',     '1');   // Plain HTML (with some tags stripped)
50 /**
51  * Plain text (even tags are printed in full)
52  */
53 define('FORMAT_PLAIN',    '2');   // Plain text (even tags are printed in full)
55 /**
56  * Wiki-formatted text
57  * Deprecated: left here just to note that '3' is not used (at the moment)
58  * and to catch any latent wiki-like text (which generates an error)
59  */
60 define('FORMAT_WIKI',     '3');   // Wiki-formatted text
62 /**
63  * Markdown-formatted text http://daringfireball.net/projects/markdown/
64  */
65 define('FORMAT_MARKDOWN', '4');   // Markdown-formatted text http://daringfireball.net/projects/markdown/
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);
71 /**
72  * A moodle_url comparison using this flag will return true if the base URLs match and the params of url1 are part of url2
73  */
74 define('URL_MATCH_PARAMS', 1);
75 /**
76  * A moodle_url comparison using this flag will return true if the two URLs are identical, except for the order of the params
77  */
78 define('URL_MATCH_EXACT', 2);
80 /**
81  * Allowed tags - string of html tags that can be tested against for safe html tags
82  * @global string $ALLOWED_TAGS
83  * @name $ALLOWED_TAGS
84  */
85 global $ALLOWED_TAGS;
86 $ALLOWED_TAGS =
87 '<p><br><b><i><u><font><table><tbody><thead><tfoot><span><div><tr><td><th><ol><ul><dl><li><dt><dd><h1><h2><h3><h4><h5><h6><hr><img><a><strong><emphasis><em><sup><sub><address><cite><blockquote><pre><strike><param><acronym><nolink><lang><tex><algebra><math><mi><mn><mo><mtext><mspace><ms><mrow><mfrac><msqrt><mroot><mstyle><merror><mpadded><mphantom><mfenced><msub><msup><msubsup><munder><mover><munderover><mmultiscripts><mtable><mtr><mtd><maligngroup><malignmark><maction><cn><ci><apply><reln><fn><interval><inverse><sep><condition><declare><lambda><compose><ident><quotient><exp><factorial><divide><max><min><minus><plus><power><rem><times><root><gcd><and><or><xor><not><implies><forall><exists><abs><conjugate><eq><neq><gt><lt><geq><leq><ln><log><int><diff><partialdiff><lowlimit><uplimit><bvar><degree><set><list><union><intersect><in><notin><subset><prsubset><notsubset><notprsubset><setdiff><sum><product><limit><tendsto><mean><sdev><variance><median><mode><moment><vector><matrix><matrixrow><determinant><transpose><selector><annotation><semantics><annotation-xml><tt><code>';
89 /**
90  * Allowed protocols - array of protocols that are safe to use in links and so on
91  * @global string $ALLOWED_PROTOCOLS
92  */
93 $ALLOWED_PROTOCOLS = array('http', 'https', 'ftp', 'news', 'mailto', 'rtsp', 'teamspeak', 'gopher', 'mms',
94                            'color', 'callto', 'cursor', 'text-align', 'font-size', 'font-weight', 'font-style', 'font-family',
95                            'border', 'border-bottom', 'border-left', 'border-top', 'border-right', 'margin', 'margin-bottom', 'margin-left', 'margin-top', 'margin-right',
96                            'padding', 'padding-bottom', 'padding-left', 'padding-top', 'padding-right', 'vertical-align',
97                            'background', 'background-color', 'text-decoration');   // CSS as well to get through kses
100 /// Functions
102 /**
103  * Add quotes to HTML characters
104  *
105  * Returns $var with HTML characters (like "<", ">", etc.) properly quoted.
106  * This function is very similar to {@link p()}
107  *
108  * @todo Remove obsolete param $obsolete if not used anywhere
109  *
110  * @param string $var the string potentially containing HTML characters
111  * @param boolean $obsolete no longer used.
112  * @return string
113  */
114 function s($var, $obsolete = false) {
116     if ($var === '0' or $var === false or $var === 0) {
117         return '0';
118     }
120     return preg_replace("/&amp;#(\d+|x[0-7a-fA-F]+);/i", "&#$1;", htmlspecialchars($var, ENT_QUOTES, 'UTF-8', true));
123 /**
124  * Add quotes to HTML characters
125  *
126  * Prints $var with HTML characters (like "<", ">", etc.) properly quoted.
127  * This function simply calls {@link s()}
128  * @see s()
129  *
130  * @todo Remove obsolete param $obsolete if not used anywhere
131  *
132  * @param string $var the string potentially containing HTML characters
133  * @param boolean $obsolete no longer used.
134  * @return string
135  */
136 function p($var, $obsolete = false) {
137     echo s($var, $obsolete);
140 /**
141  * Does proper javascript quoting.
142  *
143  * Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
144  *
145  * @param mixed $var String, Array, or Object to add slashes to
146  * @return mixed quoted result
147  */
148 function addslashes_js($var) {
149     if (is_string($var)) {
150         $var = str_replace('\\', '\\\\', $var);
151         $var = str_replace(array('\'', '"', "\n", "\r", "\0"), array('\\\'', '\\"', '\\n', '\\r', '\\0'), $var);
152         $var = str_replace('</', '<\/', $var);   // XHTML compliance
153     } else if (is_array($var)) {
154         $var = array_map('addslashes_js', $var);
155     } else if (is_object($var)) {
156         $a = get_object_vars($var);
157         foreach ($a as $key=>$value) {
158           $a[$key] = addslashes_js($value);
159         }
160         $var = (object)$a;
161     }
162     return $var;
165 /**
166  * Remove query string from url
167  *
168  * Takes in a URL and returns it without the querystring portion
169  *
170  * @param string $url the url which may have a query string attached
171  * @return string The remaining URL
172  */
173  function strip_querystring($url) {
175     if ($commapos = strpos($url, '?')) {
176         return substr($url, 0, $commapos);
177     } else {
178         return $url;
179     }
182 /**
183  * Returns the URL of the HTTP_REFERER, less the querystring portion if required
184  *
185  * @uses $_SERVER
186  * @param boolean $stripquery if true, also removes the query part of the url.
187  * @return string The resulting referer or empty string
188  */
189 function get_referer($stripquery=true) {
190     if (isset($_SERVER['HTTP_REFERER'])) {
191         if ($stripquery) {
192             return strip_querystring($_SERVER['HTTP_REFERER']);
193         } else {
194             return $_SERVER['HTTP_REFERER'];
195         }
196     } else {
197         return '';
198     }
202 /**
203  * Returns the name of the current script, WITH the querystring portion.
204  *
205  * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
206  * return different things depending on a lot of things like your OS, Web
207  * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
208  * <b>NOTE:</b> This function returns false if the global variables needed are not set.
209  *
210  * @global string
211  * @return mixed String, or false if the global variables needed are not set
212  */
213 function me() {
214     global $ME;
215     return $ME;
218 /**
219  * Returns the name of the current script, WITH the full URL.
220  *
221  * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
222  * return different things depending on a lot of things like your OS, Web
223  * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.
224  * <b>NOTE:</b> This function returns false if the global variables needed are not set.
225  *
226  * Like {@link me()} but returns a full URL
227  * @see me()
228  *
229  * @global string
230  * @return mixed String, or false if the global variables needed are not set
231  */
232 function qualified_me() {
233     global $FULLME;
234     return $FULLME;
237 /**
238  * Class for creating and manipulating urls.
239  *
240  * It can be used in moodle pages where config.php has been included without any further includes.
241  *
242  * It is useful for manipulating urls with long lists of params.
243  * One situation where it will be useful is a page which links to itself to perform various actions
244  * and / or to process form data. A moodle_url object :
245  * can be created for a page to refer to itself with all the proper get params being passed from page call to
246  * page call and methods can be used to output a url including all the params, optionally adding and overriding
247  * params and can also be used to
248  *     - output the url without any get params
249  *     - and output the params as hidden fields to be output within a form
250  *
251  * @link http://docs.moodle.org/en/Development:lib/weblib.php_moodle_url See short write up here
252  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
253  * @package moodlecore
254  */
255 class moodle_url {
256     /**
257      * Scheme, ex.: http, https
258      * @var string
259      */
260     protected $scheme = '';
261     /**
262      * hostname
263      * @var string
264      */
265     protected $host = '';
266     /**
267      * Port number, empty means default 80 or 443 in case of http
268      * @var unknown_type
269      */
270     protected $port = '';
271     /**
272      * Username for http auth
273      * @var string
274      */
275     protected $user = '';
276     /**
277      * Password for http auth
278      * @var string
279      */
280     protected $pass = '';
281     /**
282      * Script path
283      * @var string
284      */
285     protected $path = '';
286     /**
287      * Optional slash argument value
288      * @var string
289      */
290     protected $slashargument = '';
291     /**
292      * Anchor, may be also empty, null means none
293      * @var string
294      */
295     protected $anchor = null;
296     /**
297      * Url parameters as associative array
298      * @var array
299      */
300     protected $params = array(); // Associative array of query string params
302     /**
303      * Create new instance of moodle_url.
304      *
305      * @param moodle_url|string $url - moodle_url means make a copy of another
306      *      moodle_url and change parameters, string means full url or shortened
307      *      form (ex.: '/course/view.php'). It is strongly encouraged to not include
308      *      query string because it may result in double encoded values
309      * @param array $params these params override current params or add new
310      */
311     public function __construct($url, array $params = null) {
312         global $CFG;
314         if ($url instanceof moodle_url) {
315             $this->scheme = $url->scheme;
316             $this->host = $url->host;
317             $this->port = $url->port;
318             $this->user = $url->user;
319             $this->pass = $url->pass;
320             $this->path = $url->path;
321             $this->slashargument = $url->slashargument;
322             $this->params = $url->params;
323             $this->anchor = $url->anchor;
325         } else {
326             // detect if anchor used
327             $apos = strpos($url, '#');
328             if ($apos !== false) {
329                 $anchor = substr($url, $apos);
330                 $anchor = ltrim($anchor, '#');
331                 $this->set_anchor($anchor);
332                 $url = substr($url, 0, $apos);
333             }
335             // normalise shortened form of our url ex.: '/course/view.php'
336             if (strpos($url, '/') === 0) {
337                 // we must not use httpswwwroot here, because it might be url of other page,
338                 // devs have to use httpswwwroot explicitly when creating new moodle_url
339                 $url = $CFG->wwwroot.$url;
340             }
342             // now fix the admin links if needed, no need to mess with httpswwwroot
343             if ($CFG->admin !== 'admin') {
344                 if (strpos($url, "$CFG->wwwroot/admin/") === 0) {
345                     $url = str_replace("$CFG->wwwroot/admin/", "$CFG->wwwroot/$CFG->admin/", $url);
346                 }
347             }
349             // parse the $url
350             $parts = parse_url($url);
351             if ($parts === false) {
352                 throw new moodle_exception('invalidurl');
353             }
354             if (isset($parts['query'])) {
355                 // note: the values may not be correctly decoded,
356                 //       url parameters should be always passed as array
357                 parse_str(str_replace('&amp;', '&', $parts['query']), $this->params);
358             }
359             unset($parts['query']);
360             foreach ($parts as $key => $value) {
361                 $this->$key = $value;
362             }
364             // detect slashargument value from path - we do not support directory names ending with .php
365             $pos = strpos($this->path, '.php/');
366             if ($pos !== false) {
367                 $this->slashargument = substr($this->path, $pos + 4);
368                 $this->path = substr($this->path, 0, $pos + 4);
369             }
370         }
372         $this->params($params);
373     }
375     /**
376      * Add an array of params to the params for this url.
377      *
378      * The added params override existing ones if they have the same name.
379      *
380      * @param array $params Defaults to null. If null then returns all params.
381      * @return array Array of Params for url.
382      */
383     public function params(array $params = null) {
384         $params = (array)$params;
386         foreach ($params as $key=>$value) {
387             if (is_int($key)) {
388                 throw new coding_exception('Url parameters can not have numeric keys!');
389             }
390             if (is_array($value)) {
391                 throw new coding_exception('Url parameters values can not be arrays!');
392             }
393             if (is_object($value) and !method_exists($value, '__toString')) {
394                 throw new coding_exception('Url parameters values can not be objects, unless __toString() is defined!');
395             }
396             $this->params[$key] = (string)$value;
397         }
398         return $this->params;
399     }
401     /**
402      * Remove all params if no arguments passed.
403      * Remove selected params if arguments are passed.
404      *
405      * Can be called as either remove_params('param1', 'param2')
406      * or remove_params(array('param1', 'param2')).
407      *
408      * @param mixed $params either an array of param names, or a string param name,
409      * @param string $params,... any number of additional param names.
410      * @return array url parameters
411      */
412     public function remove_params($params = null) {
413         if (!is_array($params)) {
414             $params = func_get_args();
415         }
416         foreach ($params as $param) {
417             unset($this->params[$param]);
418         }
419         return $this->params;
420     }
422     /**
423      * Remove all url parameters
424      * @param $params
425      * @return void
426      */
427     public function remove_all_params($params = null) {
428         $this->params = array();
429         $this->slashargument = '';
430     }
432     /**
433      * Add a param to the params for this url.
434      *
435      * The added param overrides existing one if they have the same name.
436      *
437      * @param string $paramname name
438      * @param string $newvalue Param value. If new value specified current value is overriden or parameter is added
439      * @return mixed string parameter value, null if parameter does not exist
440      */
441     public function param($paramname, $newvalue = '') {
442         if (func_num_args() > 1) {
443             // set new value
444             $this->params(array($paramname=>$newvalue));
445         }
446         if (isset($this->params[$paramname])) {
447             return $this->params[$paramname];
448         } else {
449             return null;
450         }
451     }
453     /**
454      * Merges parameters and validates them
455      * @param array $overrideparams
456      * @return array merged parameters
457      */
458     protected function merge_overrideparams(array $overrideparams = null) {
459         $overrideparams = (array)$overrideparams;
460         $params = $this->params;
461         foreach ($overrideparams as $key=>$value) {
462             if (is_int($key)) {
463                 throw new coding_exception('Overridden parameters can not have numeric keys!');
464             }
465             if (is_array($value)) {
466                 throw new coding_exception('Overridden parameters values can not be arrays!');
467             }
468             if (is_object($value) and !method_exists($value, '__toString')) {
469                 throw new coding_exception('Overridden parameters values can not be objects, unless __toString() is defined!');
470             }
471             $params[$key] = (string)$value;
472         }
473         return $params;
474     }
476     /**
477      * Get the params as as a query string.
478      * This method should not be used outside of this method.
479      *
480      * @param boolean $escaped Use &amp; as params separator instead of plain &
481      * @param array $overrideparams params to add to the output params, these
482      *      override existing ones with the same name.
483      * @return string query string that can be added to a url.
484      */
485     public function get_query_string($escaped = true, array $overrideparams = null) {
486         $arr = array();
487         $params = $this->merge_overrideparams($overrideparams);
488         foreach ($params as $key => $val) {
489            $arr[] = rawurlencode($key)."=".rawurlencode($val);
490         }
491         if ($escaped) {
492             return implode('&amp;', $arr);
493         } else {
494             return implode('&', $arr);
495         }
496     }
498     /**
499      * Shortcut for printing of encoded URL.
500      * @return string
501      */
502     public function __toString() {
503         return $this->out(true);
504     }
506     /**
507      * Output url
508      *
509      * If you use the returned URL in HTML code, you want the escaped ampersands. If you use
510      * the returned URL in HTTP headers, you want $escaped=false.
511      *
512      * @param boolean $escaped Use &amp; as params separator instead of plain &
513      * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
514      * @return string Resulting URL
515      */
516     public function out($escaped = true, array $overrideparams = null) {
517         if (!is_bool($escaped)) {
518             debugging('Escape parameter must be of type boolean, '.gettype($escaped).' given instead.');
519         }
521         $uri = $this->out_omit_querystring().$this->slashargument;
523         $querystring = $this->get_query_string($escaped, $overrideparams);
524         if ($querystring !== '') {
525             $uri .= '?' . $querystring;
526         }
527         if (!is_null($this->anchor)) {
528             $uri .= '#'.$this->anchor;
529         }
531         return $uri;
532     }
534     /**
535      * Returns url without parameters, everything before '?'.
536      * @return string
537      */
538     public function out_omit_querystring() {
539         $uri = $this->scheme ? $this->scheme.':'.((strtolower($this->scheme) == 'mailto') ? '':'//'): '';
540         $uri .= $this->user ? $this->user.($this->pass? ':'.$this->pass:'').'@':'';
541         $uri .= $this->host ? $this->host : '';
542         $uri .= $this->port ? ':'.$this->port : '';
543         $uri .= $this->path ? $this->path : '';
544         return $uri;
545     }
547     /**
548      * Compares this moodle_url with another
549      * See documentation of constants for an explanation of the comparison flags.
550      * @param moodle_url $url The moodle_url object to compare
551      * @param int $matchtype The type of comparison (URL_MATCH_BASE, URL_MATCH_PARAMS, URL_MATCH_EXACT)
552      * @return boolean
553      */
554     public function compare(moodle_url $url, $matchtype = URL_MATCH_EXACT) {
556         $baseself = $this->out_omit_querystring();
557         $baseother = $url->out_omit_querystring();
559         // Append index.php if there is no specific file
560         if (substr($baseself,-1)=='/') {
561             $baseself .= 'index.php';
562         }
563         if (substr($baseother,-1)=='/') {
564             $baseother .= 'index.php';
565         }
567         // Compare the two base URLs
568         if ($baseself != $baseother) {
569             return false;
570         }
572         if ($matchtype == URL_MATCH_BASE) {
573             return true;
574         }
576         $urlparams = $url->params();
577         foreach ($this->params() as $param => $value) {
578             if ($param == 'sesskey') {
579                 continue;
580             }
581             if (!array_key_exists($param, $urlparams) || $urlparams[$param] != $value) {
582                 return false;
583             }
584         }
586         if ($matchtype == URL_MATCH_PARAMS) {
587             return true;
588         }
590         foreach ($urlparams as $param => $value) {
591             if ($param == 'sesskey') {
592                 continue;
593             }
594             if (!array_key_exists($param, $this->params()) || $this->param($param) != $value) {
595                 return false;
596             }
597         }
599         return true;
600     }
602     /**
603      * Sets the anchor for the URI (the bit after the hash)
604      * @param string $anchor null means remove previous
605      */
606     public function set_anchor($anchor) {
607         if (is_null($anchor)) {
608             // remove
609             $this->anchor = null;
610         } else if ($anchor === '') {
611             // special case, used as empty link
612             $this->anchor = '';
613         } else if (preg_match('|[a-zA-Z\_\:][a-zA-Z0-9\_\-\.\:]*|', $anchor)) {
614             // Match the anchor against the NMTOKEN spec
615             $this->anchor = $anchor;
616         } else {
617             // bad luck, no valid anchor found
618             $this->anchor = null;
619         }
620     }
622     /**
623      * Sets the url slashargument value
624      * @param string $path usually file path
625      * @param string $parameter name of page parameter if slasharguments not supported
626      * @param bool $supported usually null, then it depends on $CFG->slasharguments, use true or false for other servers
627      * @return void
628      */
629     public function set_slashargument($path, $parameter = 'file', $supported = NULL) {
630         global $CFG;
631         if (is_null($supported)) {
632             $supported = $CFG->slasharguments;
633         }
635         if ($supported) {
636             $parts = explode('/', $path);
637             $parts = array_map('rawurlencode', $parts);
638             $path  = implode('/', $parts);
639             $this->slashargument = $path;
640             unset($this->params[$parameter]);
642         } else {
643             $this->slashargument = '';
644             $this->params[$parameter] = $path;
645         }
646     }
648     // == static factory methods ==
650     /**
651      * General moodle file url.
652      * @param string $urlbase the script serving the file
653      * @param string $path
654      * @param bool $forcedownload
655      * @return moodle_url
656      */
657     public static function make_file_url($urlbase, $path, $forcedownload = false) {
658         global $CFG;
660         $params = array();
661         if ($forcedownload) {
662             $params['forcedownload'] = 1;
663         }
665         $url = new moodle_url($urlbase, $params);
666         $url->set_slashargument($path);
668         return $url;
669     }
671     /**
672      * Factory method for creation of url pointing to plugin file.
673      * Please note this method can be used only from the plugins to
674      * create urls of own files, it must not be used outside of plugins!
675      * @param int $contextid
676      * @param string $component
677      * @param string $area
678      * @param int $itemid
679      * @param string $pathname
680      * @param string $filename
681      * @param bool $forcedownload
682      * @return moodle_url
683      */
684     public static function make_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename, $forcedownload = false) {
685         global $CFG;
686         $urlbase = "$CFG->httpswwwroot/pluginfile.php";
687         if ($itemid === NULL) {
688             return self::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
689         } else {
690             return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
691         }
692     }
694     /**
695      * Factory method for creation of url pointing to draft
696      * file of current user.
697      * @param int $draftid draft item id
698      * @param string $pathname
699      * @param string $filename
700      * @param bool $forcedownload
701      * @return moodle_url
702      */
703     public static function make_draftfile_url($draftid, $pathname, $filename, $forcedownload = false) {
704         global $CFG, $USER;
705         $urlbase = "$CFG->httpswwwroot/draftfile.php";
706         $context = get_context_instance(CONTEXT_USER, $USER->id);
708         return self::make_file_url($urlbase, "/$context->id/user/draft/$draftid".$pathname.$filename, $forcedownload);
709     }
711     /**
712      * Factory method for creating of links to legacy
713      * course files.
714      * @param int $courseid
715      * @param string $filepath
716      * @param bool $forcedownload
717      * @return moodle_url
718      */
719     public static function make_legacyfile_url($courseid, $filepath, $forcedownload = false) {
720         global $CFG;
722         $urlbase = "$CFG->wwwroot/file.php";
723         return self::make_file_url($urlbase, '/'.$courseid.'/'.$filepath, $forcedownload);
724     }
727 /**
728  * Determine if there is data waiting to be processed from a form
729  *
730  * Used on most forms in Moodle to check for data
731  * Returns the data as an object, if it's found.
732  * This object can be used in foreach loops without
733  * casting because it's cast to (array) automatically
734  *
735  * Checks that submitted POST data exists and returns it as object.
736  *
737  * @uses $_POST
738  * @return mixed false or object
739  */
740 function data_submitted() {
742     if (empty($_POST)) {
743         return false;
744     } else {
745         return (object)$_POST;
746     }
749 /**
750  * Given some normal text this function will break up any
751  * long words to a given size by inserting the given character
752  *
753  * It's multibyte savvy and doesn't change anything inside html tags.
754  *
755  * @param string $string the string to be modified
756  * @param int $maxsize maximum length of the string to be returned
757  * @param string $cutchar the string used to represent word breaks
758  * @return string
759  */
760 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
762 /// Loading the textlib singleton instance. We are going to need it.
763     $textlib = textlib_get_instance();
765 /// First of all, save all the tags inside the text to skip them
766     $tags = array();
767     filter_save_tags($string,$tags);
769 /// Process the string adding the cut when necessary
770     $output = '';
771     $length = $textlib->strlen($string);
772     $wordlength = 0;
774     for ($i=0; $i<$length; $i++) {
775         $char = $textlib->substr($string, $i, 1);
776         if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
777             $wordlength = 0;
778         } else {
779             $wordlength++;
780             if ($wordlength > $maxsize) {
781                 $output .= $cutchar;
782                 $wordlength = 0;
783             }
784         }
785         $output .= $char;
786     }
788 /// Finally load the tags back again
789     if (!empty($tags)) {
790         $output = str_replace(array_keys($tags), $tags, $output);
791     }
793     return $output;
796 /**
797  * Try and close the current window using JavaScript, either immediately, or after a delay.
798  *
799  * Echo's out the resulting XHTML & javascript
800  *
801  * @global object
802  * @global object
803  * @param integer $delay a delay in seconds before closing the window. Default 0.
804  * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
805  *      to reload the parent window before this one closes.
806  */
807 function close_window($delay = 0, $reloadopener = false) {
808     global $PAGE, $OUTPUT;
810     if (!$PAGE->headerprinted) {
811         $PAGE->set_title(get_string('closewindow'));
812         echo $OUTPUT->header();
813     } else {
814         $OUTPUT->container_end_all(false);
815     }
817     if ($reloadopener) {
818         $function = 'close_window_reloading_opener';
819     } else {
820         $function = 'close_window';
821     }
822     echo '<p class="centerpara">' . get_string('windowclosing') . '</p>';
824     $PAGE->requires->js_function_call($function, null, false, $delay);
826     echo $OUTPUT->footer();
827     exit;
830 /**
831  * Returns a string containing a link to the user documentation for the current
832  * page. Also contains an icon by default. Shown to teachers and admin only.
833  *
834  * @global object
835  * @global object
836  * @param string $text The text to be displayed for the link
837  * @param string $iconpath The path to the icon to be displayed
838  * @return string The link to user documentation for this current page
839  */
840 function page_doc_link($text='') {
841     global $CFG, $PAGE, $OUTPUT;
843     if (empty($CFG->docroot) || during_initial_install()) {
844         return '';
845     }
846     if (!has_capability('moodle/site:doclinks', $PAGE->context)) {
847         return '';
848     }
850     $path = $PAGE->docspath;
851     if (!$path) {
852         return '';
853     }
854     return $OUTPUT->doc_link($path, $text);
858 /**
859  * Validates an email to make sure it makes sense.
860  *
861  * @param string $address The email address to validate.
862  * @return boolean
863  */
864 function validate_email($address) {
866     return (preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
867                  '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
868                   '@'.
869                   '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
870                   '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
871                   $address));
874 /**
875  * Extracts file argument either from file parameter or PATH_INFO
876  * Note: $scriptname parameter is not needed anymore
877  *
878  * @global string
879  * @uses $_SERVER
880  * @uses PARAM_PATH
881  * @return string file path (only safe characters)
882  */
883 function get_file_argument() {
884     global $SCRIPT;
886     $relativepath = optional_param('file', FALSE, PARAM_PATH);
888     // then try extract file from PATH_INFO (slasharguments method)
889     if ($relativepath === false and isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
890         // check that PATH_INFO works == must not contain the script name
891         if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
892             $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
893         }
894     }
896     // note: we are not using any other way because they are not compatible with unicode file names ;-)
898     return $relativepath;
901 /**
902  * Just returns an array of text formats suitable for a popup menu
903  *
904  * @uses FORMAT_MOODLE
905  * @uses FORMAT_HTML
906  * @uses FORMAT_PLAIN
907  * @uses FORMAT_MARKDOWN
908  * @return array
909  */
910 function format_text_menu() {
911     return array (FORMAT_MOODLE => get_string('formattext'),
912                   FORMAT_HTML   => get_string('formathtml'),
913                   FORMAT_PLAIN  => get_string('formatplain'),
914                   FORMAT_MARKDOWN  => get_string('formatmarkdown'));
917 /**
918  * Given text in a variety of format codings, this function returns
919  * the text as safe HTML.
920  *
921  * This function should mainly be used for long strings like posts,
922  * answers, glossary items etc. For short strings @see format_string().
923  *
924  * @todo Finish documenting this function
925  *
926  * @staticvar array $croncache
927  * @param string $text The text to be formatted. This is raw text originally from user input.
928  * @param int $format Identifier of the text format to be used
929  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
930  * @param object/array $options text formatting options
931  * @param int $courseid_do_not_use deprecated course id, use context option instead
932  * @return string
933  */
934 function format_text($text, $format = FORMAT_MOODLE, $options = NULL, $courseid_do_not_use = NULL) {
935     global $CFG, $COURSE, $DB, $PAGE;
937     static $croncache = array();
939     if ($text === '') {
940         return ''; // no need to do any filters and cleaning
941     }
943     $options = (array)$options; // detach object, we can not modify it
946     if (!isset($options['trusted'])) {
947         $options['trusted'] = false;
948     }
949     if (!isset($options['noclean'])) {
950         if ($options['trusted'] and trusttext_active()) {
951             // no cleaning if text trusted and noclean not specified
952             $options['noclean'] = true;
953         } else {
954             $options['noclean'] = false;
955         }
956     }
957     if (!isset($options['nocache'])) {
958         $options['nocache'] = false;
959     }
960     if (!isset($options['filter'])) {
961         $options['filter'] = true;
962     }
963     if (!isset($options['para'])) {
964         $options['para'] = true;
965     }
966     if (!isset($options['newlines'])) {
967         $options['newlines'] = true;
968     }
970     // Calculate best context
971     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
972         // do not filter anything during installation or before upgrade completes
973         $context = null;
975     } else if (isset($options['context'])) { // first by explicit passed context option
976         if (is_object($options['context'])) {
977             $context = $options['context'];
978         } else {
979             $context = get_context_instance_by_id($context);
980         }
981     } else if ($courseid_do_not_use) {
982         // legacy courseid
983         $context = get_context_instance(CONTEXT_COURSE, $courseid_do_not_use);
984     } else {
985         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
986         $context = $PAGE->context;
987     }
989     if (!$context) {
990         // either install/upgrade or something has gone really wrong because context does not exist (yet?)
991         $options['nocache'] = true;
992         $options['filter']  = false;
993     }
995     if ($options['filter']) {
996         $filtermanager = filter_manager::instance();
997     } else {
998         $filtermanager = new null_filter_manager();
999     }
1001     if (!empty($CFG->cachetext) and empty($options['nocache'])) {
1002         $hashstr = $text.'-'.$filtermanager->text_filtering_hash($context).'-'.$context->id.'-'.current_language().'-'.
1003                 (int)$format.(int)$options['trusted'].(int)$options['noclean'].
1004                 (int)$options['para'].(int)$options['newlines'];
1006         $time = time() - $CFG->cachetext;
1007         $md5key = md5($hashstr);
1008         if (CLI_SCRIPT) {
1009             if (isset($croncache[$md5key])) {
1010                 return $croncache[$md5key];
1011             }
1012         }
1014         if ($oldcacheitem = $DB->get_record('cache_text', array('md5key'=>$md5key), '*', IGNORE_MULTIPLE)) {
1015             if ($oldcacheitem->timemodified >= $time) {
1016                 if (CLI_SCRIPT) {
1017                     if (count($croncache) > 150) {
1018                         reset($croncache);
1019                         $key = key($croncache);
1020                         unset($croncache[$key]);
1021                     }
1022                     $croncache[$md5key] = $oldcacheitem->formattedtext;
1023                 }
1024                 return $oldcacheitem->formattedtext;
1025             }
1026         }
1027     }
1029     switch ($format) {
1030         case FORMAT_HTML:
1031             if (!$options['noclean']) {
1032                 $text = clean_text($text, FORMAT_HTML);
1033             }
1034             $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_HTML));
1035             break;
1037         case FORMAT_PLAIN:
1038             $text = s($text); // cleans dangerous JS
1039             $text = rebuildnolinktag($text);
1040             $text = str_replace('  ', '&nbsp; ', $text);
1041             $text = nl2br($text);
1042             break;
1044         case FORMAT_WIKI:
1045             // this format is deprecated
1046             $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle.  You should not be seeing
1047                      this message as all texts should have been converted to Markdown format instead.
1048                      Please post a bug report to http://moodle.org/bugs with information about where you
1049                      saw this message.</p>'.s($text);
1050             break;
1052         case FORMAT_MARKDOWN:
1053             $text = markdown_to_html($text);
1054             if (!$options['noclean']) {
1055                 $text = clean_text($text, FORMAT_HTML);
1056             }
1057             $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_MARKDOWN));
1058             break;
1060         default:  // FORMAT_MOODLE or anything else
1061             $text = text_to_html($text, null, $options['para'], $options['newlines']);
1062             if (!$options['noclean']) {
1063                 $text = clean_text($text, FORMAT_HTML);
1064             }
1065             $text = $filtermanager->filter_text($text, $context, array('originalformat' => $format));
1066             break;
1067     }
1069     // Warn people that we have removed this old mechanism, just in case they
1070     // were stupid enough to rely on it.
1071     if (isset($CFG->currenttextiscacheable)) {
1072         debugging('Once upon a time, Moodle had a truly evil use of global variables ' .
1073                 'called $CFG->currenttextiscacheable. The good news is that this no ' .
1074                 'longer exists. The bad news is that you seem to be using a filter that '.
1075                 'relies on it. Please seek out and destroy that filter code.', DEBUG_DEVELOPER);
1076     }
1078     if (empty($options['nocache']) and !empty($CFG->cachetext)) {
1079         if (CLI_SCRIPT) {
1080             // special static cron cache - no need to store it in db if its not already there
1081             if (count($croncache) > 150) {
1082                 reset($croncache);
1083                 $key = key($croncache);
1084                 unset($croncache[$key]);
1085             }
1086             $croncache[$md5key] = $text;
1087             return $text;
1088         }
1090         $newcacheitem = new stdClass();
1091         $newcacheitem->md5key = $md5key;
1092         $newcacheitem->formattedtext = $text;
1093         $newcacheitem->timemodified = time();
1094         if ($oldcacheitem) {                               // See bug 4677 for discussion
1095             $newcacheitem->id = $oldcacheitem->id;
1096             try {
1097                 $DB->update_record('cache_text', $newcacheitem);   // Update existing record in the cache table
1098             } catch (dml_exception $e) {
1099                // It's unlikely that the cron cache cleaner could have
1100                // deleted this entry in the meantime, as it allows
1101                // some extra time to cover these cases.
1102             }
1103         } else {
1104             try {
1105                 $DB->insert_record('cache_text', $newcacheitem);   // Insert a new record in the cache table
1106             } catch (dml_exception $e) {
1107                // Again, it's possible that another user has caused this
1108                // record to be created already in the time that it took
1109                // to traverse this function.  That's OK too, as the
1110                // call above handles duplicate entries, and eventually
1111                // the cron cleaner will delete them.
1112             }
1113         }
1114     }
1116     return $text;
1119 /**
1120  * Converts the text format from the value to the 'internal'
1121  * name or vice versa.
1122  *
1123  * $key can either be the value or the name and you get the other back.
1124  *
1125  * @uses FORMAT_MOODLE
1126  * @uses FORMAT_HTML
1127  * @uses FORMAT_PLAIN
1128  * @uses FORMAT_MARKDOWN
1129  * @param mixed $key int 0-4 or string one of 'moodle','html','plain','markdown'
1130  * @return mixed as above but the other way around!
1131  */
1132 function text_format_name($key) {
1133   $lookup = array();
1134   $lookup[FORMAT_MOODLE] = 'moodle';
1135   $lookup[FORMAT_HTML] = 'html';
1136   $lookup[FORMAT_PLAIN] = 'plain';
1137   $lookup[FORMAT_MARKDOWN] = 'markdown';
1138   $value = "error";
1139   if (!is_numeric($key)) {
1140     $key = strtolower( $key );
1141     $value = array_search( $key, $lookup );
1142   }
1143   else {
1144     if (isset( $lookup[$key] )) {
1145       $value =  $lookup[ $key ];
1146     }
1147   }
1148   return $value;
1151 /**
1152  * Resets all data related to filters, called during upgrade or when filter settings change.
1153  *
1154  * @global object
1155  * @global object
1156  * @return void
1157  */
1158 function reset_text_filters_cache() {
1159     global $CFG, $DB;
1161     $DB->delete_records('cache_text');
1162     $purifdir = $CFG->dataroot.'/cache/htmlpurifier';
1163     remove_dir($purifdir, true);
1166 /**
1167  * Given a simple string, this function returns the string
1168  * processed by enabled string filters if $CFG->filterall is enabled
1169  *
1170  * This function should be used to print short strings (non html) that
1171  * need filter processing e.g. activity titles, post subjects,
1172  * glossary concepts.
1173  *
1174  * @global object
1175  * @global object
1176  * @global object
1177  * @staticvar bool $strcache
1178  * @param string $string The string to be filtered.
1179  * @param boolean $striplinks To strip any link in the result text.
1180                               Moodle 1.8 default changed from false to true! MDL-8713
1181  * @param array $options options array/object or courseid
1182  * @return string
1183  */
1184 function format_string($string, $striplinks = true, $options = NULL) {
1185     global $CFG, $COURSE, $PAGE;
1187     //We'll use a in-memory cache here to speed up repeated strings
1188     static $strcache = false;
1190     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
1191         // do not filter anything during installation or before upgrade completes
1192         return $string = strip_tags($string);
1193     }
1195     if ($strcache === false or count($strcache) > 2000) { // this number might need some tuning to limit memory usage in cron
1196         $strcache = array();
1197     }
1199     if (is_numeric($options)) {
1200         // legacy courseid usage
1201         $options  = array('context'=>get_context_instance(CONTEXT_COURSE, $options));
1202     } else {
1203         $options = (array)$options; // detach object, we can not modify it
1204     }
1206     if (empty($options['context'])) {
1207         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1208         $options['context'] = $PAGE->context;
1209     } else if (is_numeric($options['context'])) {
1210         $options['context'] = get_context_instance_by_id($options['context']);
1211     }
1213     if (!$options['context']) {
1214         // we did not find any context? weird
1215         return $string = strip_tags($string);
1216     }
1218     //Calculate md5
1219     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id.'<+>'.current_language());
1221     //Fetch from cache if possible
1222     if (isset($strcache[$md5])) {
1223         return $strcache[$md5];
1224     }
1226     // First replace all ampersands not followed by html entity code
1227     // Regular expression moved to its own method for easier unit testing
1228     $string = replace_ampersands_not_followed_by_entity($string);
1230     if (!empty($CFG->filterall)) {
1231         $string = filter_manager::instance()->filter_string($string, $options['context']);
1232     }
1234     // If the site requires it, strip ALL tags from this string
1235     if (!empty($CFG->formatstringstriptags)) {
1236         $string = strip_tags($string);
1238     } else {
1239         // Otherwise strip just links if that is required (default)
1240         if ($striplinks) {  //strip links in string
1241             $string = strip_links($string);
1242         }
1243         $string = clean_text($string);
1244     }
1246     //Store to cache
1247     $strcache[$md5] = $string;
1249     return $string;
1252 /**
1253  * Given a string, performs a negative lookahead looking for any ampersand character
1254  * that is not followed by a proper HTML entity. If any is found, it is replaced
1255  * by &amp;. The string is then returned.
1256  *
1257  * @param string $string
1258  * @return string
1259  */
1260 function replace_ampersands_not_followed_by_entity($string) {
1261     return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1264 /**
1265  * Given a string, replaces all <a>.*</a> by .* and returns the string.
1266  *
1267  * @param string $string
1268  * @return string
1269  */
1270 function strip_links($string) {
1271     return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is','$2',$string);
1274 /**
1275  * This expression turns links into something nice in a text format. (Russell Jungwirth)
1276  *
1277  * @param string $string
1278  * @return string
1279  */
1280 function wikify_links($string) {
1281     return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i','$3 [ $2 ]', $string);
1284 /**
1285  * Replaces non-standard HTML entities
1286  *
1287  * @param string $string
1288  * @return string
1289  */
1290 function fix_non_standard_entities($string) {
1291     $text = preg_replace('/&#0*([0-9]+);?/', '&#$1;', $string);
1292     $text = preg_replace('/&#x0*([0-9a-fA-F]+);?/', '&#x$1;', $text);
1293     $text = preg_replace('[\x00-\x08\x0b-\x0c\x0e-\x1f]', '', $text);
1294     return $text;
1297 /**
1298  * Given text in a variety of format codings, this function returns
1299  * the text as plain text suitable for plain email.
1300  *
1301  * @uses FORMAT_MOODLE
1302  * @uses FORMAT_HTML
1303  * @uses FORMAT_PLAIN
1304  * @uses FORMAT_WIKI
1305  * @uses FORMAT_MARKDOWN
1306  * @param string $text The text to be formatted. This is raw text originally from user input.
1307  * @param int $format Identifier of the text format to be used
1308  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1309  * @return string
1310  */
1311 function format_text_email($text, $format) {
1313     switch ($format) {
1315         case FORMAT_PLAIN:
1316             return $text;
1317             break;
1319         case FORMAT_WIKI:
1320             // there should not be any of these any more!
1321             $text = wikify_links($text);
1322             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1323             break;
1325         case FORMAT_HTML:
1326             return html_to_text($text);
1327             break;
1329         case FORMAT_MOODLE:
1330         case FORMAT_MARKDOWN:
1331         default:
1332             $text = wikify_links($text);
1333             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1334             break;
1335     }
1338 /**
1339  * Formats activity intro text
1340  *
1341  * @global object
1342  * @uses CONTEXT_MODULE
1343  * @param string $module name of module
1344  * @param object $activity instance of activity
1345  * @param int $cmid course module id
1346  * @param bool $filter filter resulting html text
1347  * @return text
1348  */
1349 function format_module_intro($module, $activity, $cmid, $filter=true) {
1350     global $CFG;
1351     require_once("$CFG->libdir/filelib.php");
1352     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1353     $options = (object)array('noclean'=>true, 'para'=>false, 'filter'=>$filter, 'context'=>$context);
1354     $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, 'mod_'.$module, 'intro', null);
1355     return trim(format_text($intro, $activity->introformat, $options, null));
1358 /**
1359  * Legacy function, used for cleaning of old forum and glossary text only.
1360  *
1361  * @global object
1362  * @param string $text text that may contain legacy TRUSTTEXT marker
1363  * @return text without legacy TRUSTTEXT marker
1364  */
1365 function trusttext_strip($text) {
1366     while (true) { //removing nested TRUSTTEXT
1367         $orig = $text;
1368         $text = str_replace('#####TRUSTTEXT#####', '', $text);
1369         if (strcmp($orig, $text) === 0) {
1370             return $text;
1371         }
1372     }
1375 /**
1376  * Must be called before editing of all texts
1377  * with trust flag. Removes all XSS nasties
1378  * from texts stored in database if needed.
1379  *
1380  * @param object $object data object with xxx, xxxformat and xxxtrust fields
1381  * @param string $field name of text field
1382  * @param object $context active context
1383  * @return object updated $object
1384  */
1385 function trusttext_pre_edit($object, $field, $context) {
1386     $trustfield  = $field.'trust';
1387     $formatfield = $field.'format';
1389     if (!$object->$trustfield or !trusttext_trusted($context)) {
1390         $object->$field = clean_text($object->$field, $object->$formatfield);
1391     }
1393     return $object;
1396 /**
1397  * Is current user trusted to enter no dangerous XSS in this context?
1398  *
1399  * Please note the user must be in fact trusted everywhere on this server!!
1400  *
1401  * @param object $context
1402  * @return bool true if user trusted
1403  */
1404 function trusttext_trusted($context) {
1405     return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1408 /**
1409  * Is trusttext feature active?
1410  *
1411  * @global object
1412  * @param object $context
1413  * @return bool
1414  */
1415 function trusttext_active() {
1416     global $CFG;
1418     return !empty($CFG->enabletrusttext);
1421 /**
1422  * Given raw text (eg typed in by a user), this function cleans it up
1423  * and removes any nasty tags that could mess up Moodle pages.
1424  *
1425  * @global string
1426  * @global object
1427  * @param string $text The text to be cleaned
1428  * @param int $format Identifier of the text format to be used
1429  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1430  * @return string The cleaned up text
1431  */
1432 function clean_text($text, $format = FORMAT_MOODLE) {
1433     global $ALLOWED_TAGS, $CFG;
1435     if (empty($text) or is_numeric($text)) {
1436        return (string)$text;
1437     }
1439     switch ($format) {
1440         case FORMAT_PLAIN:
1441             return $text;
1443         default:
1445             if (!empty($CFG->enablehtmlpurifier)) {
1446                 $text = purify_html($text);
1447             } else {
1448             /// Fix non standard entity notations
1449                 $text = fix_non_standard_entities($text);
1451             /// Remove tags that are not allowed
1452                 $text = strip_tags($text, $ALLOWED_TAGS);
1454             /// Clean up embedded scripts and , using kses
1455                 $text = cleanAttributes($text);
1457             /// Again remove tags that are not allowed
1458                 $text = strip_tags($text, $ALLOWED_TAGS);
1460             }
1462         /// Remove potential script events - some extra protection for undiscovered bugs in our code
1463             $text = preg_replace("~([^a-z])language([[:space:]]*)=~i", "$1Xlanguage=", $text);
1464             $text = preg_replace("~([^a-z])on([a-z]+)([[:space:]]*)=~i", "$1Xon$2=", $text);
1466             return $text;
1467     }
1470 /**
1471  * KSES replacement cleaning function - uses HTML Purifier.
1472  *
1473  * @global object
1474  * @param string $text The (X)HTML string to purify
1475  */
1476 function purify_html($text) {
1477     global $CFG;
1479     // this can not be done only once because we sometimes need to reset the cache
1480     $cachedir = $CFG->dataroot.'/cache/htmlpurifier';
1481     check_dir_exists($cachedir);
1483     static $purifier = false;
1484     if ($purifier === false) {
1485         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1486         $config = HTMLPurifier_Config::createDefault();
1488         $config->set('HTML.DefinitionID', 'moodlehtml');
1489         $config->set('HTML.DefinitionRev', 1);
1490         $config->set('Cache.SerializerPath', $cachedir);
1491         //$config->set('Cache.SerializerPermission', $CFG->directorypermissions); // it would be nice to get this upstream
1492         $config->set('Core.NormalizeNewlines', false);
1493         $config->set('Core.ConvertDocumentToFragment', true);
1494         $config->set('Core.Encoding', 'UTF-8');
1495         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1496         $config->set('URI.AllowedSchemes', array('http'=>true, 'https'=>true, 'ftp'=>true, 'irc'=>true, 'nntp'=>true, 'news'=>true, 'rtsp'=>true, 'teamspeak'=>true, 'gopher'=>true, 'mms'=>true));
1497         $config->set('Attr.AllowedFrameTargets', array('_blank'));
1499         if (!empty($CFG->allowobjectembed)) {
1500             $config->set('HTML.SafeObject', true);
1501             $config->set('Output.FlashCompat', true);
1502             $config->set('HTML.SafeEmbed', true);
1503         }
1505         $def = $config->getHTMLDefinition(true);
1506         $def->addElement('nolink', 'Block', 'Flow', array());                       // skip our filters inside
1507         $def->addElement('tex', 'Inline', 'Inline', array());                       // tex syntax, equivalent to $$xx$$
1508         $def->addElement('algebra', 'Inline', 'Inline', array());                   // algebra syntax, equivalent to @@xx@@
1509         $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // old anf future style multilang - only our hacked lang attribute
1510         $def->addAttribute('span', 'xxxlang', 'CDATA');                             // current problematic multilang
1512         $purifier = new HTMLPurifier($config);
1513     }
1515     $multilang = (strpos($text, 'class="multilang"') !== false);
1517     if ($multilang) {
1518         $text = preg_replace('/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/', '<span xxxlang="${2}">', $text);
1519     }
1520     $text = $purifier->purify($text);
1521     if ($multilang) {
1522         $text = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $text);
1523     }
1525     return $text;
1528 /**
1529  * This function takes a string and examines it for HTML tags.
1530  *
1531  * If tags are detected it passes the string to a helper function {@link cleanAttributes2()}
1532  * which checks for attributes and filters them for malicious content
1533  *
1534  * @param string $str The string to be examined for html tags
1535  * @return string
1536  */
1537 function cleanAttributes($str){
1538     $result = preg_replace_callback(
1539             '%(<[^>]*(>|$)|>)%m', #search for html tags
1540             "cleanAttributes2",
1541             $str
1542             );
1543     return  $result;
1546 /**
1547  * This function takes a string with an html tag and strips out any unallowed
1548  * protocols e.g. javascript:
1549  *
1550  * It calls ancillary functions in kses which are prefixed by kses
1551  *
1552  * @global object
1553  * @global string
1554  * @param array $htmlArray An array from {@link cleanAttributes()}, containing in its 1st
1555  *              element the html to be cleared
1556  * @return string
1557  */
1558 function cleanAttributes2($htmlArray){
1560     global $CFG, $ALLOWED_PROTOCOLS;
1561     require_once($CFG->libdir .'/kses.php');
1563     $htmlTag = $htmlArray[1];
1564     if (substr($htmlTag, 0, 1) != '<') {
1565         return '&gt;';  //a single character ">" detected
1566     }
1567     if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $htmlTag, $matches)) {
1568         return ''; // It's seriously malformed
1569     }
1570     $slash = trim($matches[1]); //trailing xhtml slash
1571     $elem = $matches[2];    //the element name
1572     $attrlist = $matches[3]; // the list of attributes as a string
1574     $attrArray = kses_hair($attrlist, $ALLOWED_PROTOCOLS);
1576     $attStr = '';
1577     foreach ($attrArray as $arreach) {
1578         $arreach['name'] = strtolower($arreach['name']);
1579         if ($arreach['name'] == 'style') {
1580             $value = $arreach['value'];
1581             while (true) {
1582                 $prevvalue = $value;
1583                 $value = kses_no_null($value);
1584                 $value = preg_replace("/\/\*.*\*\//Us", '', $value);
1585                 $value = kses_decode_entities($value);
1586                 $value = preg_replace('/(&#[0-9]+)(;?)/', "\\1;", $value);
1587                 $value = preg_replace('/(&#x[0-9a-fA-F]+)(;?)/', "\\1;", $value);
1588                 if ($value === $prevvalue) {
1589                     $arreach['value'] = $value;
1590                     break;
1591                 }
1592             }
1593             $arreach['value'] = preg_replace("/j\s*a\s*v\s*a\s*s\s*c\s*r\s*i\s*p\s*t/i", "Xjavascript", $arreach['value']);
1594             $arreach['value'] = preg_replace("/v\s*b\s*s\s*c\s*r\s*i\s*p\s*t/i", "Xvbscript", $arreach['value']);
1595             $arreach['value'] = preg_replace("/e\s*x\s*p\s*r\s*e\s*s\s*s\s*i\s*o\s*n/i", "Xexpression", $arreach['value']);
1596             $arreach['value'] = preg_replace("/b\s*i\s*n\s*d\s*i\s*n\s*g/i", "Xbinding", $arreach['value']);
1597         } else if ($arreach['name'] == 'href') {
1598             //Adobe Acrobat Reader XSS protection
1599             $arreach['value'] = preg_replace('/(\.(pdf|fdf|xfdf|xdp|xfd)[^#]*)#.*$/i', '$1', $arreach['value']);
1600         }
1601         $attStr .=  ' '.$arreach['name'].'="'.$arreach['value'].'"';
1602     }
1604     $xhtml_slash = '';
1605     if (preg_match('%/\s*$%', $attrlist)) {
1606         $xhtml_slash = ' /';
1607     }
1608     return '<'. $slash . $elem . $attStr . $xhtml_slash .'>';
1611 /**
1612  * Replaces all known smileys in the text with image equivalents
1613  *
1614  * @global object
1615  * @staticvar array $e
1616  * @staticvar array $img
1617  * @staticvar array $emoticons
1618  * @param string $text Passed by reference. The string to search for smiley strings.
1619  * @return string
1620  */
1621 function replace_smilies(&$text) {
1622     global $CFG, $OUTPUT;
1623     static $emoticons = null;
1624     static $e = array();    // array of emoticon texts like ':-)'
1625     static $img = array();  // array of HTML to replace emoticon text with
1627     $manager = get_emoticon_manager();
1629     if (is_null($emoticons)) {
1630         $emoticons = $manager->get_emoticons();
1631     }
1633     if (empty($emoticons)) { /// No emoticons defined, nothing to process here
1634         return;
1635     }
1637     $lang = current_language();
1639     if (empty($img[$lang])) {  /// After the first time this is not run again
1640         $e[$lang] = array();
1641         $img[$lang] = array();
1642         foreach ($emoticons as $emoticon) {
1643             $e[$lang][] = $emoticon->text;
1644             $img[$lang][] = $OUTPUT->render($manager->prepare_renderable_emoticon($emoticon));
1645         }
1646     }
1648     // Exclude from transformations all the code inside <script> tags
1649     // Needed to solve Bug 1185. Thanks to jouse 2001 detecting it. :-)
1650     // Based on code from glossary filter by Williams Castillo.
1651     //       - Eloy
1653     // Detect all the <script> zones to take out
1654     $excludes = array();
1655     preg_match_all('/<script language(.+?)<\/script>/is',$text,$list_of_excludes);
1657     // Take out all the <script> zones from text
1658     foreach (array_unique($list_of_excludes[0]) as $key=>$value) {
1659         $excludes['<+'.$key.'+>'] = $value;
1660     }
1661     if ($excludes) {
1662         $text = str_replace($excludes,array_keys($excludes),$text);
1663     }
1665 /// this is the meat of the code - this is run every time
1666     $text = str_replace($e[$lang], $img[$lang], $text);
1668     // Recover all the <script> zones to text
1669     if ($excludes) {
1670         $text = str_replace(array_keys($excludes),$excludes,$text);
1671     }
1674 /**
1675  * Given plain text, makes it into HTML as nicely as possible.
1676  * May contain HTML tags already
1677  *
1678  * Do not abuse this function. It is intended as lower level formatting feature used
1679  * by {@see format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
1680  * to call format_text() in most of cases.
1681  *
1682  * @global object
1683  * @param string $text The string to convert.
1684  * @param boolean $smiley_ignored Was used to determine if smiley characters should convert to smiley images, ignored now
1685  * @param boolean $para If true then the returned string will be wrapped in div tags
1686  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1687  * @return string
1688  */
1690 function text_to_html($text, $smiley_ignored=null, $para=true, $newlines=true) {
1691     global $CFG;
1693 /// Remove any whitespace that may be between HTML tags
1694     $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1696 /// Remove any returns that precede or follow HTML tags
1697     $text = preg_replace("~([\n\r])<~i", " <", $text);
1698     $text = preg_replace("~>([\n\r])~i", "> ", $text);
1700 /// Make returns into HTML newlines.
1701     if ($newlines) {
1702         $text = nl2br($text);
1703     }
1705 /// Wrap the whole thing in a div if required
1706     if ($para) {
1707         //return '<p>'.$text.'</p>'; //1.9 version
1708         return '<div class="text_to_html">'.$text.'</div>';
1709     } else {
1710         return $text;
1711     }
1714 /**
1715  * Given Markdown formatted text, make it into XHTML using external function
1716  *
1717  * @global object
1718  * @param string $text The markdown formatted text to be converted.
1719  * @return string Converted text
1720  */
1721 function markdown_to_html($text) {
1722     global $CFG;
1724     if ($text === '' or $text === NULL) {
1725         return $text;
1726     }
1728     require_once($CFG->libdir .'/markdown.php');
1730     return Markdown($text);
1733 /**
1734  * Given HTML text, make it into plain text using external function
1735  *
1736  * @param string $html The text to be converted.
1737  * @param integer $width Width to wrap the text at. (optional, default 75 which
1738  *      is a good value for email. 0 means do not limit line length.)
1739  * @param boolean $dolinks By default, any links in the HTML are collected, and
1740  *      printed as a list at the end of the HTML. If you don't want that, set this
1741  *      argument to false.
1742  * @return string plain text equivalent of the HTML.
1743  */
1744 function html_to_text($html, $width = 75, $dolinks = true) {
1746     global $CFG;
1748     require_once($CFG->libdir .'/html2text.php');
1750     $h2t = new html2text($html, false, $dolinks, $width);
1751     $result = $h2t->get_text();
1753     return $result;
1756 /**
1757  * This function will highlight search words in a given string
1758  *
1759  * It cares about HTML and will not ruin links.  It's best to use
1760  * this function after performing any conversions to HTML.
1761  *
1762  * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1763  * @param string $haystack The string (HTML) within which to highlight the search terms.
1764  * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1765  * @param string $prefix the string to put before each search term found.
1766  * @param string $suffix the string to put after each search term found.
1767  * @return string The highlighted HTML.
1768  */
1769 function highlight($needle, $haystack, $matchcase = false,
1770         $prefix = '<span class="highlight">', $suffix = '</span>') {
1772 /// Quick bail-out in trivial cases.
1773     if (empty($needle) or empty($haystack)) {
1774         return $haystack;
1775     }
1777 /// Break up the search term into words, discard any -words and build a regexp.
1778     $words = preg_split('/ +/', trim($needle));
1779     foreach ($words as $index => $word) {
1780         if (strpos($word, '-') === 0) {
1781             unset($words[$index]);
1782         } else if (strpos($word, '+') === 0) {
1783             $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
1784         } else {
1785             $words[$index] = preg_quote($word, '/');
1786         }
1787     }
1788     $regexp = '/(' . implode('|', $words) . ')/u'; // u is do UTF-8 matching.
1789     if (!$matchcase) {
1790         $regexp .= 'i';
1791     }
1793 /// Another chance to bail-out if $search was only -words
1794     if (empty($words)) {
1795         return $haystack;
1796     }
1798 /// Find all the HTML tags in the input, and store them in a placeholders array.
1799     $placeholders = array();
1800     $matches = array();
1801     preg_match_all('/<[^>]*>/', $haystack, $matches);
1802     foreach (array_unique($matches[0]) as $key => $htmltag) {
1803         $placeholders['<|' . $key . '|>'] = $htmltag;
1804     }
1806 /// In $hastack, replace each HTML tag with the corresponding placeholder.
1807     $haystack = str_replace($placeholders, array_keys($placeholders), $haystack);
1809 /// In the resulting string, Do the highlighting.
1810     $haystack = preg_replace($regexp, $prefix . '$1' . $suffix, $haystack);
1812 /// Turn the placeholders back into HTML tags.
1813     $haystack = str_replace(array_keys($placeholders), $placeholders, $haystack);
1815     return $haystack;
1818 /**
1819  * This function will highlight instances of $needle in $haystack
1820  *
1821  * It's faster that the above function {@link highlight()} and doesn't care about
1822  * HTML or anything.
1823  *
1824  * @param string $needle The string to search for
1825  * @param string $haystack The string to search for $needle in
1826  * @return string The highlighted HTML
1827  */
1828 function highlightfast($needle, $haystack) {
1830     if (empty($needle) or empty($haystack)) {
1831         return $haystack;
1832     }
1834     $parts = explode(moodle_strtolower($needle), moodle_strtolower($haystack));
1836     if (count($parts) === 1) {
1837         return $haystack;
1838     }
1840     $pos = 0;
1842     foreach ($parts as $key => $part) {
1843         $parts[$key] = substr($haystack, $pos, strlen($part));
1844         $pos += strlen($part);
1846         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
1847         $pos += strlen($needle);
1848     }
1850     return str_replace('<span class="highlight"></span>', '', join('', $parts));
1853 /**
1854  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
1855  * Internationalisation, for print_header and backup/restorelib.
1856  *
1857  * @param bool $dir Default false
1858  * @return string Attributes
1859  */
1860 function get_html_lang($dir = false) {
1861     $direction = '';
1862     if ($dir) {
1863         if (right_to_left()) {
1864             $direction = ' dir="rtl"';
1865         } else {
1866             $direction = ' dir="ltr"';
1867         }
1868     }
1869     //Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
1870     $language = str_replace('_', '-', current_language());
1871     @header('Content-Language: '.$language);
1872     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
1876 /// STANDARD WEB PAGE PARTS ///////////////////////////////////////////////////
1878 /**
1879  * Send the HTTP headers that Moodle requires.
1880  * @param $cacheable Can this page be cached on back?
1881  */
1882 function send_headers($contenttype, $cacheable = true) {
1883     @header('Content-Type: ' . $contenttype);
1884     @header('Content-Script-Type: text/javascript');
1885     @header('Content-Style-Type: text/css');
1887     if ($cacheable) {
1888         // Allow caching on "back" (but not on normal clicks)
1889         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0');
1890         @header('Pragma: no-cache');
1891         @header('Expires: ');
1892     } else {
1893         // Do everything we can to always prevent clients and proxies caching
1894         @header('Cache-Control: no-store, no-cache, must-revalidate');
1895         @header('Cache-Control: post-check=0, pre-check=0', false);
1896         @header('Pragma: no-cache');
1897         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1898         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1899     }
1900     @header('Accept-Ranges: none');
1903 /**
1904  * Return the right arrow with text ('next'), and optionally embedded in a link.
1905  *
1906  * @global object
1907  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1908  * @param string $url An optional link to use in a surrounding HTML anchor.
1909  * @param bool $accesshide True if text should be hidden (for screen readers only).
1910  * @param string $addclass Additional class names for the link, or the arrow character.
1911  * @return string HTML string.
1912  */
1913 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
1914     global $OUTPUT; //TODO: move to output renderer
1915     $arrowclass = 'arrow ';
1916     if (! $url) {
1917         $arrowclass .= $addclass;
1918     }
1919     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
1920     $htmltext = '';
1921     if ($text) {
1922         $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
1923         if ($accesshide) {
1924             $htmltext = get_accesshide($htmltext);
1925         }
1926     }
1927     if ($url) {
1928         $class = 'arrow_link';
1929         if ($addclass) {
1930             $class .= ' '.$addclass;
1931         }
1932         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$htmltext.$arrow.'</a>';
1933     }
1934     return $htmltext.$arrow;
1937 /**
1938  * Return the left arrow with text ('previous'), and optionally embedded in a link.
1939  *
1940  * @global object
1941  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1942  * @param string $url An optional link to use in a surrounding HTML anchor.
1943  * @param bool $accesshide True if text should be hidden (for screen readers only).
1944  * @param string $addclass Additional class names for the link, or the arrow character.
1945  * @return string HTML string.
1946  */
1947 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
1948     global $OUTPUT; // TODO: move to utput renderer
1949     $arrowclass = 'arrow ';
1950     if (! $url) {
1951         $arrowclass .= $addclass;
1952     }
1953     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
1954     $htmltext = '';
1955     if ($text) {
1956         $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
1957         if ($accesshide) {
1958             $htmltext = get_accesshide($htmltext);
1959         }
1960     }
1961     if ($url) {
1962         $class = 'arrow_link';
1963         if ($addclass) {
1964             $class .= ' '.$addclass;
1965         }
1966         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$arrow.$htmltext.'</a>';
1967     }
1968     return $arrow.$htmltext;
1971 /**
1972  * Return a HTML element with the class "accesshide", for accessibility.
1973  * Please use cautiously - where possible, text should be visible!
1974  *
1975  * @param string $text Plain text.
1976  * @param string $elem Lowercase element name, default "span".
1977  * @param string $class Additional classes for the element.
1978  * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
1979  * @return string HTML string.
1980  */
1981 function get_accesshide($text, $elem='span', $class='', $attrs='') {
1982     return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
1985 /**
1986  * Return the breadcrumb trail navigation separator.
1987  *
1988  * @return string HTML string.
1989  */
1990 function get_separator() {
1991     //Accessibility: the 'hidden' slash is preferred for screen readers.
1992     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
1995 /**
1996  * Print (or return) a collapsible region, that has a caption that can
1997  * be clicked to expand or collapse the region.
1998  *
1999  * If JavaScript is off, then the region will always be expanded.
2000  *
2001  * @param string $contents the contents of the box.
2002  * @param string $classes class names added to the div that is output.
2003  * @param string $id id added to the div that is output. Must not be blank.
2004  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2005  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2006  *      (May be blank if you do not wish the state to be persisted.
2007  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2008  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2009  * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
2010  */
2011 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2012     $output  = print_collapsible_region_start($classes, $id, $caption, $userpref, true, true);
2013     $output .= $contents;
2014     $output .= print_collapsible_region_end(true);
2016     if ($return) {
2017         return $output;
2018     } else {
2019         echo $output;
2020     }
2023 /**
2024  * Print (or return) the start of a collapsible region, that has a caption that can
2025  * be clicked to expand or collapse the region. If JavaScript is off, then the region
2026  * will always be expanded.
2027  *
2028  * @global object
2029  * @param string $classes class names added to the div that is output.
2030  * @param string $id id added to the div that is output. Must not be blank.
2031  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2032  * @param boolean $userpref the name of the user preference that stores the user's preferred default state.
2033  *      (May be blank if you do not wish the state to be persisted.
2034  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2035  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2036  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2037  */
2038 function print_collapsible_region_start($classes, $id, $caption, $userpref = false, $default = false, $return = false) {
2039     global $CFG, $PAGE, $OUTPUT;
2041     // Work out the initial state.
2042     if (is_string($userpref)) {
2043         user_preference_allow_ajax_update($userpref, PARAM_BOOL);
2044         $collapsed = get_user_preferences($userpref, $default);
2045     } else {
2046         $collapsed = $default;
2047         $userpref = false;
2048     }
2050     if ($collapsed) {
2051         $classes .= ' collapsed';
2052     }
2054     $output = '';
2055     $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2056     $output .= '<div id="' . $id . '_sizer">';
2057     $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2058     $output .= $caption . ' ';
2059     $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2060     $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2062     if ($return) {
2063         return $output;
2064     } else {
2065         echo $output;
2066     }
2069 /**
2070  * Close a region started with print_collapsible_region_start.
2071  *
2072  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2073  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2074  */
2075 function print_collapsible_region_end($return = false) {
2076     $output = '</div></div></div>';
2078     if ($return) {
2079         return $output;
2080     } else {
2081         echo $output;
2082     }
2085 /**
2086  * Print a specified group's avatar.
2087  *
2088  * @global object
2089  * @uses CONTEXT_COURSE
2090  * @param array|stdClass $group A single {@link group} object OR array of groups.
2091  * @param int $courseid The course ID.
2092  * @param boolean $large Default small picture, or large.
2093  * @param boolean $return If false print picture, otherwise return the output as string
2094  * @param boolean $link Enclose image in a link to view specified course?
2095  * @return string|void Depending on the setting of $return
2096  */
2097 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2098     global $CFG;
2100     if (is_array($group)) {
2101         $output = '';
2102         foreach($group as $g) {
2103             $output .= print_group_picture($g, $courseid, $large, true, $link);
2104         }
2105         if ($return) {
2106             return $output;
2107         } else {
2108             echo $output;
2109             return;
2110         }
2111     }
2113     $context = get_context_instance(CONTEXT_COURSE, $courseid);
2115     // If there is no picture, do nothing
2116     if (!$group->picture) {
2117         return '';
2118     }
2120     // If picture is hidden, only show to those with course:managegroups
2121     if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
2122         return '';
2123     }
2125     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2126         $output = '<a href="'. $CFG->wwwroot .'/user/index.php?id='. $courseid .'&amp;group='. $group->id .'">';
2127     } else {
2128         $output = '';
2129     }
2130     if ($large) {
2131         $file = 'f1';
2132     } else {
2133         $file = 'f2';
2134     }
2136     $grouppictureurl = moodle_url::make_pluginfile_url($context->id, 'group', 'icon', $group->id, '/', $file);
2137     $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2138         ' alt="'.s(get_string('group').' '.$group->name).'" title="'.s($group->name).'"/>';
2140     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2141         $output .= '</a>';
2142     }
2144     if ($return) {
2145         return $output;
2146     } else {
2147         echo $output;
2148     }
2152 /**
2153  * Display a recent activity note
2154  *
2155  * @uses CONTEXT_SYSTEM
2156  * @staticvar string $strftimerecent
2157  * @param object A time object
2158  * @param object A user object
2159  * @param string $text Text for display for the note
2160  * @param string $link The link to wrap around the text
2161  * @param bool $return If set to true the HTML is returned rather than echo'd
2162  * @param string $viewfullnames
2163  */
2164 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2165     static $strftimerecent = null;
2166     $output = '';
2168     if (is_null($viewfullnames)) {
2169         $context = get_context_instance(CONTEXT_SYSTEM);
2170         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2171     }
2173     if (is_null($strftimerecent)) {
2174         $strftimerecent = get_string('strftimerecent');
2175     }
2177     $output .= '<div class="head">';
2178     $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2179     $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2180     $output .= '</div>';
2181     $output .= '<div class="info"><a href="'.$link.'">'.format_string($text,true).'</a></div>';
2183     if ($return) {
2184         return $output;
2185     } else {
2186         echo $output;
2187     }
2190 /**
2191  * Returns a popup menu with course activity modules
2192  *
2193  * Given a course
2194  * This function returns a small popup menu with all the
2195  * course activity modules in it, as a navigation menu
2196  * outputs a simple list structure in XHTML
2197  * The data is taken from the serialised array stored in
2198  * the course record
2199  *
2200  * @todo Finish documenting this function
2201  *
2202  * @global object
2203  * @uses CONTEXT_COURSE
2204  * @param course $course A {@link $COURSE} object.
2205  * @param string $sections
2206  * @param string $modinfo
2207  * @param string $strsection
2208  * @param string $strjumpto
2209  * @param int $width
2210  * @param string $cmid
2211  * @return string The HTML block
2212  */
2213 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2215     global $CFG, $OUTPUT;
2217     $section = -1;
2218     $url = '';
2219     $menu = array();
2220     $doneheading = false;
2222     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2224     $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2225     foreach ($modinfo->cms as $mod) {
2226         if ($mod->modname == 'label') {
2227             continue;
2228         }
2230         if ($mod->sectionnum > $course->numsections) {   /// Don't show excess hidden sections
2231             break;
2232         }
2234         if (!$mod->uservisible) { // do not icnlude empty sections at all
2235             continue;
2236         }
2238         if ($mod->sectionnum >= 0 and $section != $mod->sectionnum) {
2239             $thissection = $sections[$mod->sectionnum];
2241             if ($thissection->visible or !$course->hiddensections or
2242                       has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2243                 $thissection->summary = strip_tags(format_string($thissection->summary,true));
2244                 if (!$doneheading) {
2245                     $menu[] = '</ul></li>';
2246                 }
2247                 if ($course->format == 'weeks' or empty($thissection->summary)) {
2248                     $item = $strsection ." ". $mod->sectionnum;
2249                 } else {
2250                     if (strlen($thissection->summary) < ($width-3)) {
2251                         $item = $thissection->summary;
2252                     } else {
2253                         $item = substr($thissection->summary, 0, $width).'...';
2254                     }
2255                 }
2256                 $menu[] = '<li class="section"><span>'.$item.'</span>';
2257                 $menu[] = '<ul>';
2258                 $doneheading = true;
2260                 $section = $mod->sectionnum;
2261             } else {
2262                 // no activities from this hidden section shown
2263                 continue;
2264             }
2265         }
2267         $url = $mod->modname .'/view.php?id='. $mod->id;
2268         $mod->name = strip_tags(format_string($mod->name ,true));
2269         if (strlen($mod->name) > ($width+5)) {
2270             $mod->name = substr($mod->name, 0, $width).'...';
2271         }
2272         if (!$mod->visible) {
2273             $mod->name = '('.$mod->name.')';
2274         }
2275         $class = 'activity '.$mod->modname;
2276         $class .= ($cmid == $mod->id) ? ' selected' : '';
2277         $menu[] = '<li class="'.$class.'">'.
2278                   '<img src="'.$OUTPUT->pix_url('icon', $mod->modname) . '" alt="" />'.
2279                   '<a href="'.$CFG->wwwroot.'/mod/'.$url.'">'.$mod->name.'</a></li>';
2280     }
2282     if ($doneheading) {
2283         $menu[] = '</ul></li>';
2284     }
2285     $menu[] = '</ul></li></ul>';
2287     return implode("\n", $menu);
2290 /**
2291  * Prints a grade menu (as part of an existing form) with help
2292  * Showing all possible numerical grades and scales
2293  *
2294  * @todo Finish documenting this function
2295  * @todo Deprecate: this is only used in a few contrib modules
2296  *
2297  * @global object
2298  * @param int $courseid The course ID
2299  * @param string $name
2300  * @param string $current
2301  * @param boolean $includenograde Include those with no grades
2302  * @param boolean $return If set to true returns rather than echo's
2303  * @return string|bool Depending on value of $return
2304  */
2305 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2307     global $CFG, $OUTPUT;
2309     $output = '';
2310     $strscale = get_string('scale');
2311     $strscales = get_string('scales');
2313     $scales = get_scales_menu($courseid);
2314     foreach ($scales as $i => $scalename) {
2315         $grades[-$i] = $strscale .': '. $scalename;
2316     }
2317     if ($includenograde) {
2318         $grades[0] = get_string('nograde');
2319     }
2320     for ($i=100; $i>=1; $i--) {
2321         $grades[$i] = $i;
2322     }
2323     $output .= html_writer::select($grades, $name, $current, false);
2325     $linkobject = '<span class="helplink"><img class="iconhelp" alt="'.$strscales.'" src="'.$OUTPUT->pix_url('help') . '" /></span>';
2326     $link = new moodle_url('/course/scales.php', array('id'=>$courseid, 'list'=>1));
2327     $action = new popup_action('click', $link->url, 'ratingscales', array('height' => 400, 'width' => 500));
2328     $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title'=>$strscales));
2330     if ($return) {
2331         return $output;
2332     } else {
2333         echo $output;
2334     }
2337 /**
2338  * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2339  * Default errorcode is 1.
2340  *
2341  * Very useful for perl-like error-handling:
2342  *
2343  * do_somethting() or mdie("Something went wrong");
2344  *
2345  * @param string  $msg       Error message
2346  * @param integer $errorcode Error code to emit
2347  */
2348 function mdie($msg='', $errorcode=1) {
2349     trigger_error($msg);
2350     exit($errorcode);
2353 /**
2354  * Print a message and exit.
2355  *
2356  * @param string $message The message to print in the notice
2357  * @param string $link The link to use for the continue button
2358  * @param object $course A course object
2359  * @return void This function simply exits
2360  */
2361 function notice ($message, $link='', $course=NULL) {
2362     global $CFG, $SITE, $COURSE, $PAGE, $OUTPUT;
2364     $message = clean_text($message);   // In case nasties are in here
2366     if (CLI_SCRIPT) {
2367         echo("!!$message!!\n");
2368         exit(1); // no success
2369     }
2371     if (!$PAGE->headerprinted) {
2372         //header not yet printed
2373         $PAGE->set_title(get_string('notice'));
2374         echo $OUTPUT->header();
2375     } else {
2376         echo $OUTPUT->container_end_all(false);
2377     }
2379     echo $OUTPUT->box($message, 'generalbox', 'notice');
2380     echo $OUTPUT->continue_button($link);
2382     echo $OUTPUT->footer();
2383     exit(1); // general error code
2386 /**
2387  * Redirects the user to another page, after printing a notice
2388  *
2389  * This function calls the OUTPUT redirect method, echo's the output
2390  * and then dies to ensure nothing else happens.
2391  *
2392  * <strong>Good practice:</strong> You should call this method before starting page
2393  * output by using any of the OUTPUT methods.
2394  *
2395  * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2396  * @param string $message The message to display to the user
2397  * @param int $delay The delay before redirecting
2398  * @return void - does not return!
2399  */
2400 function redirect($url, $message='', $delay=-1) {
2401     global $OUTPUT, $PAGE, $SESSION, $CFG;
2403     if (CLI_SCRIPT or AJAX_SCRIPT) {
2404         // this is wrong - developers should not use redirect in these scripts,
2405         // but it should not be very likely
2406         throw new moodle_exception('redirecterrordetected', 'error');
2407     }
2409     // prevent debug errors - make sure context is properly initialised
2410     if ($PAGE) {
2411         $PAGE->set_context(null);
2412     }
2414     if ($url instanceof moodle_url) {
2415         $url = $url->out(false);
2416     }
2418     if (!empty($CFG->usesid) && !isset($_COOKIE[session_name()])) {
2419        $url = $SESSION->sid_process_url($url);
2420     }
2422     $debugdisableredirect = false;
2423     do {
2424         if (defined('DEBUGGING_PRINTED')) {
2425             // some debugging already printed, no need to look more
2426             $debugdisableredirect = true;
2427             break;
2428         }
2430         if (empty($CFG->debugdisplay) or empty($CFG->debug)) {
2431             // no errors should be displayed
2432             break;
2433         }
2435         if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2436             break;
2437         }
2439         if (!($lasterror['type'] & $CFG->debug)) {
2440             //last error not interesting
2441             break;
2442         }
2444         // watch out here, @hidden() errors are returned from error_get_last() too
2445         if (headers_sent()) {
2446             //we already started printing something - that means errors likely printed
2447             $debugdisableredirect = true;
2448             break;
2449         }
2451         if (ob_get_level() and ob_get_contents()) {
2452             // there is something waiting to be printed, hopefully it is the errors,
2453             // but it might be some error hidden by @ too - such as the timezone mess from setup.php
2454             $debugdisableredirect = true;
2455             break;
2456         }
2457     } while (false);
2459     if (!empty($message)) {
2460         if ($delay === -1 || !is_numeric($delay)) {
2461             $delay = 3;
2462         }
2463         $message = clean_text($message);
2464     } else {
2465         $message = get_string('pageshouldredirect');
2466         $delay = 0;
2467         // We are going to try to use a HTTP redirect, so we need a full URL.
2468         if (!preg_match('|^[a-z]+:|', $url)) {
2469             // Get host name http://www.wherever.com
2470             $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2471             if (preg_match('|^/|', $url)) {
2472                 // URLs beginning with / are relative to web server root so we just add them in
2473                 $url = $hostpart.$url;
2474             } else {
2475                 // URLs not beginning with / are relative to path of current script, so add that on.
2476                 $url = $hostpart.preg_replace('|\?.*$|','',me()).'/../'.$url;
2477             }
2478             // Replace all ..s
2479             while (true) {
2480                 $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2481                 if ($newurl == $url) {
2482                     break;
2483                 }
2484                 $url = $newurl;
2485             }
2486         }
2487     }
2489     if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
2490         if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
2491             $perf = get_performance_info();
2492             error_log("PERF: " . $perf['txt']);
2493         }
2494     }
2496     $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2497     $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />'));
2499     if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2500         //302 might not work for POST requests, 303 is ignored by obsolete clients.
2501         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2502         @header('Location: '.$url);
2503         echo bootstrap_renderer::plain_redirect_message($encodedurl);
2504         exit;
2505     }
2507     // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2508     $PAGE->set_pagelayout('embedded');  // No header and footer needed
2509     $CFG->docroot = false; // to prevent the link to moodle docs from being displayed on redirect page.
2510     echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect);
2511     exit;
2514 /**
2515  * Given an email address, this function will return an obfuscated version of it
2516  *
2517  * @param string $email The email address to obfuscate
2518  * @return string The obfuscated email address
2519  */
2520  function obfuscate_email($email) {
2522     $i = 0;
2523     $length = strlen($email);
2524     $obfuscated = '';
2525     while ($i < $length) {
2526         if (rand(0,2) && $email{$i}!='@') { //MDL-20619 some browsers have problems unobfuscating @
2527             $obfuscated.='%'.dechex(ord($email{$i}));
2528         } else {
2529             $obfuscated.=$email{$i};
2530         }
2531         $i++;
2532     }
2533     return $obfuscated;
2536 /**
2537  * This function takes some text and replaces about half of the characters
2538  * with HTML entity equivalents.   Return string is obviously longer.
2539  *
2540  * @param string $plaintext The text to be obfuscated
2541  * @return string The obfuscated text
2542  */
2543 function obfuscate_text($plaintext) {
2545     $i=0;
2546     $length = strlen($plaintext);
2547     $obfuscated='';
2548     $prev_obfuscated = false;
2549     while ($i < $length) {
2550         $c = ord($plaintext{$i});
2551         $numerical = ($c >= ord('0')) && ($c <= ord('9'));
2552         if ($prev_obfuscated and $numerical ) {
2553             $obfuscated.='&#'.ord($plaintext{$i}).';';
2554         } else if (rand(0,2)) {
2555             $obfuscated.='&#'.ord($plaintext{$i}).';';
2556             $prev_obfuscated = true;
2557         } else {
2558             $obfuscated.=$plaintext{$i};
2559             $prev_obfuscated = false;
2560         }
2561       $i++;
2562     }
2563     return $obfuscated;
2566 /**
2567  * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2568  * to generate a fully obfuscated email link, ready to use.
2569  *
2570  * @param string $email The email address to display
2571  * @param string $label The text to displayed as hyperlink to $email
2572  * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2573  * @return string The obfuscated mailto link
2574  */
2575 function obfuscate_mailto($email, $label='', $dimmed=false) {
2577     if (empty($label)) {
2578         $label = $email;
2579     }
2580     if ($dimmed) {
2581         $title = get_string('emaildisable');
2582         $dimmed = ' class="dimmed"';
2583     } else {
2584         $title = '';
2585         $dimmed = '';
2586     }
2587     return sprintf("<a href=\"%s:%s\" $dimmed title=\"$title\">%s</a>",
2588                     obfuscate_text('mailto'), obfuscate_email($email),
2589                     obfuscate_text($label));
2592 /**
2593  * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2594  * will transform it to html entities
2595  *
2596  * @param string $text Text to search for nolink tag in
2597  * @return string
2598  */
2599 function rebuildnolinktag($text) {
2601     $text = preg_replace('/&lt;(\/*nolink)&gt;/i','<$1>',$text);
2603     return $text;
2606 /**
2607  * Prints a maintenance message from $CFG->maintenance_message or default if empty
2608  * @return void
2609  */
2610 function print_maintenance_message() {
2611     global $CFG, $SITE, $PAGE, $OUTPUT;
2613     $PAGE->set_pagetype('maintenance-message');
2614     $PAGE->set_pagelayout('maintenance');
2615     $PAGE->set_title(strip_tags($SITE->fullname));
2616     $PAGE->set_heading($SITE->fullname);
2617     echo $OUTPUT->header();
2618     echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2619     if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
2620         echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2621         echo $CFG->maintenance_message;
2622         echo $OUTPUT->box_end();
2623     }
2624     echo $OUTPUT->footer();
2625     die;
2628 /**
2629  * Adjust the list of allowed tags based on $CFG->allowobjectembed and user roles (admin)
2630  *
2631  * @global object
2632  * @global string
2633  * @return void
2634  */
2635 function adjust_allowed_tags() {
2637     global $CFG, $ALLOWED_TAGS;
2639     if (!empty($CFG->allowobjectembed)) {
2640         $ALLOWED_TAGS .= '<embed><object>';
2641     }
2644 /**
2645  * A class for tabs, Some code to print tabs
2646  *
2647  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2648  * @package moodlecore
2649  */
2650 class tabobject {
2651     /**
2652      * @var string
2653      */
2654     var $id;
2655     var $link;
2656     var $text;
2657     /**
2658      * @var bool
2659      */
2660     var $linkedwhenselected;
2662     /**
2663      * A constructor just because I like constructors
2664      *
2665      * @param string $id
2666      * @param string $link
2667      * @param string $text
2668      * @param string $title
2669      * @param bool $linkedwhenselected
2670      */
2671     function tabobject ($id, $link='', $text='', $title='', $linkedwhenselected=false) {
2672         $this->id   = $id;
2673         $this->link = $link;
2674         $this->text = $text;
2675         $this->title = $title ? $title : $text;
2676         $this->linkedwhenselected = $linkedwhenselected;
2677     }
2682 /**
2683  * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2684  *
2685  * @global object
2686  * @param array $tabrows An array of rows where each row is an array of tab objects
2687  * @param string $selected  The id of the selected tab (whatever row it's on)
2688  * @param array  $inactive  An array of ids of inactive tabs that are not selectable.
2689  * @param array  $activated An array of ids of other tabs that are currently activated
2690  * @param bool $return If true output is returned rather then echo'd
2691  **/
2692 function print_tabs($tabrows, $selected=NULL, $inactive=NULL, $activated=NULL, $return=false) {
2693     global $CFG;
2695 /// $inactive must be an array
2696     if (!is_array($inactive)) {
2697         $inactive = array();
2698     }
2700 /// $activated must be an array
2701     if (!is_array($activated)) {
2702         $activated = array();
2703     }
2705 /// Convert the tab rows into a tree that's easier to process
2706     if (!$tree = convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated)) {
2707         return false;
2708     }
2710 /// Print out the current tree of tabs (this function is recursive)
2712     $output = convert_tree_to_html($tree);
2714     $output = "\n\n".'<div class="tabtree">'.$output.'</div><div class="clearer"> </div>'."\n\n";
2716 /// We're done!
2718     if ($return) {
2719         return $output;
2720     }
2721     echo $output;
2724 /**
2725  * Converts a nested array tree into HTML ul:li [recursive]
2726  *
2727  * @param array $tree A tree array to convert
2728  * @param int $row Used in identifying the iteration level and in ul classes
2729  * @return string HTML structure
2730  */
2731 function convert_tree_to_html($tree, $row=0) {
2733     $str = "\n".'<ul class="tabrow'.$row.'">'."\n";
2735     $first = true;
2736     $count = count($tree);
2738     foreach ($tree as $tab) {
2739         $count--;   // countdown to zero
2741         $liclass = '';
2743         if ($first && ($count == 0)) {   // Just one in the row
2744             $liclass = 'first last';
2745             $first = false;
2746         } else if ($first) {
2747             $liclass = 'first';
2748             $first = false;
2749         } else if ($count == 0) {
2750             $liclass = 'last';
2751         }
2753         if ((empty($tab->subtree)) && (!empty($tab->selected))) {
2754             $liclass .= (empty($liclass)) ? 'onerow' : ' onerow';
2755         }
2757         if ($tab->inactive || $tab->active || $tab->selected) {
2758             if ($tab->selected) {
2759                 $liclass .= (empty($liclass)) ? 'here selected' : ' here selected';
2760             } else if ($tab->active) {
2761                 $liclass .= (empty($liclass)) ? 'here active' : ' here active';
2762             }
2763         }
2765         $str .= (!empty($liclass)) ? '<li class="'.$liclass.'">' : '<li>';
2767         if ($tab->inactive || $tab->active || ($tab->selected && !$tab->linkedwhenselected)) {
2768             // The a tag is used for styling
2769             $str .= '<a class="nolink"><span>'.$tab->text.'</span></a>';
2770         } else {
2771             $str .= '<a href="'.$tab->link.'" title="'.$tab->title.'"><span>'.$tab->text.'</span></a>';
2772         }
2774         if (!empty($tab->subtree)) {
2775             $str .= convert_tree_to_html($tab->subtree, $row+1);
2776         } else if ($tab->selected) {
2777             $str .= '<div class="tabrow'.($row+1).' empty">&nbsp;</div>'."\n";
2778         }
2780         $str .= ' </li>'."\n";
2781     }
2782     $str .= '</ul>'."\n";
2784     return $str;
2787 /**
2788  * Convert nested tabrows to a nested array
2789  *
2790  * @param array $tabrows A [nested] array of tab row objects
2791  * @param string $selected The tabrow to select (by id)
2792  * @param array $inactive An array of tabrow id's to make inactive
2793  * @param array $activated An array of tabrow id's to make active
2794  * @return array The nested array
2795  */
2796 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
2798 /// Work backwards through the rows (bottom to top) collecting the tree as we go.
2800     $tabrows = array_reverse($tabrows);
2802     $subtree = array();
2804     foreach ($tabrows as $row) {
2805         $tree = array();
2807         foreach ($row as $tab) {
2808             $tab->inactive = in_array((string)$tab->id, $inactive);
2809             $tab->active = in_array((string)$tab->id, $activated);
2810             $tab->selected = (string)$tab->id == $selected;
2812             if ($tab->active || $tab->selected) {
2813                 if ($subtree) {
2814                     $tab->subtree = $subtree;
2815                 }
2816             }
2817             $tree[] = $tab;
2818         }
2819         $subtree = $tree;
2820     }
2822     return $subtree;
2825 /**
2826  * Returns the Moodle Docs URL in the users language
2827  *
2828  * @global object
2829  * @param string $path the end of the URL.
2830  * @return string The MoodleDocs URL in the user's language. for example {@link http://docs.moodle.org/en/ http://docs.moodle.org/en/$path}
2831  */
2832 function get_docs_url($path) {
2833     global $CFG;
2834     return $CFG->docroot . '/' . current_language() . '/' . $path;
2838 /**
2839  * Standard Debugging Function
2840  *
2841  * Returns true if the current site debugging settings are equal or above specified level.
2842  * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2843  * routing of notices is controlled by $CFG->debugdisplay
2844  * eg use like this:
2845  *
2846  * 1)  debugging('a normal debug notice');
2847  * 2)  debugging('something really picky', DEBUG_ALL);
2848  * 3)  debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
2849  * 4)  if (debugging()) { perform extra debugging operations (do not use print or echo) }
2850  *
2851  * In code blocks controlled by debugging() (such as example 4)
2852  * any output should be routed via debugging() itself, or the lower-level
2853  * trigger_error() or error_log(). Using echo or print will break XHTML
2854  * JS and HTTP headers.
2855  *
2856  * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2857  *
2858  * @uses DEBUG_NORMAL
2859  * @param string $message a message to print
2860  * @param int $level the level at which this debugging statement should show
2861  * @param array $backtrace use different backtrace
2862  * @return bool
2863  */
2864 function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
2865     global $CFG, $UNITTEST;
2867     if (empty($CFG->debug) || $CFG->debug < $level) {
2868         return false;
2869     }
2871     if (!isset($CFG->debugdisplay)) {
2872         $CFG->debugdisplay = ini_get_bool('display_errors');
2873     }
2875     if ($message) {
2876         if (!$backtrace) {
2877             $backtrace = debug_backtrace();
2878         }
2879         $from = format_backtrace($backtrace, CLI_SCRIPT);
2880         if (!empty($UNITTEST->running)) {
2881             // When the unit tests are running, any call to trigger_error
2882             // is intercepted by the test framework and reported as an exception.
2883             // Therefore, we cannot use trigger_error during unit tests.
2884             // At the same time I do not think we should just discard those messages,
2885             // so displaying them on-screen seems like the only option. (MDL-20398)
2886             echo '<div class="notifytiny">' . $message . $from . '</div>';
2888         } else if (NO_DEBUG_DISPLAY) {
2889             // script does not want any errors or debugging in output,
2890             // we send the info to error log instead
2891             error_log('Debugging: ' . $message . $from);
2893         } else if ($CFG->debugdisplay) {
2894             if (!defined('DEBUGGING_PRINTED')) {
2895                 define('DEBUGGING_PRINTED', 1); // indicates we have printed something
2896             }
2897             echo '<div class="notifytiny">' . $message . $from . '</div>';
2899         } else {
2900             trigger_error($message . $from, E_USER_NOTICE);
2901         }
2902     }
2903     return true;
2906 /**
2907 * Outputs a HTML comment to the browser. This is used for those hard-to-debug
2908 * pages that use bits from many different files in very confusing ways (e.g. blocks).
2910 * <code>print_location_comment(__FILE__, __LINE__);</code>
2912 * @param string $file
2913 * @param integer $line
2914 * @param boolean $return Whether to return or print the comment
2915 * @return string|void Void unless true given as third parameter
2916 */
2917 function print_location_comment($file, $line, $return = false)
2919     if ($return) {
2920         return "<!-- $file at line $line -->\n";
2921     } else {
2922         echo "<!-- $file at line $line -->\n";
2923     }
2927 /**
2928  * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
2929  */
2930 function right_to_left() {
2931     return (get_string('thisdirection', 'langconfig') === 'rtl');
2935 /**
2936  * Returns swapped left<=>right if in RTL environment.
2937  * part of RTL support
2938  *
2939  * @param string $align align to check
2940  * @return string
2941  */
2942 function fix_align_rtl($align) {
2943     if (!right_to_left()) {
2944         return $align;
2945     }
2946     if ($align=='left')  { return 'right'; }
2947     if ($align=='right') { return 'left'; }
2948     return $align;
2952 /**
2953  * Returns true if the page is displayed in a popup window.
2954  * Gets the information from the URL parameter inpopup.
2955  *
2956  * @todo Use a central function to create the popup calls all over Moodle and
2957  * In the moment only works with resources and probably questions.
2958  *
2959  * @return boolean
2960  */
2961 function is_in_popup() {
2962     $inpopup = optional_param('inpopup', '', PARAM_BOOL);
2964     return ($inpopup);
2967 /**
2968  * To use this class.
2969  * - construct
2970  * - call create (or use the 3rd param to the constructor)
2971  * - call update or update_full repeatedly
2972  *
2973  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2974  * @package moodlecore
2975  */
2976 class progress_bar {
2977     /** @var string html id */
2978     private $html_id;
2979     /** @var int */
2980     private $percent;
2981     /** @var int */
2982     private $width;
2983     /** @var int */
2984     private $lastcall;
2985     /** @var int */
2986     private $time_start;
2987     private $minimum_time = 2; //min time between updates.
2988     /**
2989      * Constructor
2990      *
2991      * @param string $html_id
2992      * @param int $width
2993      * @param bool $autostart Default to false
2994      */
2995     public function __construct($html_id = '', $width = 500, $autostart = false){
2996         if (!empty($html_id)) {
2997             $this->html_id  = $html_id;
2998         } else {
2999             $this->html_id  = uniqid();
3000         }
3001         $this->width = $width;
3002         $this->restart();
3003         if($autostart){
3004             $this->create();
3005         }
3006     }
3007     /**
3008       * Create a new progress bar, this function will output html.
3009       *
3010       * @return void Echo's output
3011       */
3012     public function create(){
3013             flush();
3014             $this->lastcall->pt = 0;
3015             $this->lastcall->time = microtime(true);
3016             if (CLI_SCRIPT) {
3017                 return; // temporary solution for cli scripts
3018             }
3019             $htmlcode = <<<EOT
3020             <div style="text-align:center;width:{$this->width}px;clear:both;padding:0;margin:0 auto;">
3021                 <h2 id="status_{$this->html_id}" style="text-align: center;margin:0 auto"></h2>
3022                 <p id="time_{$this->html_id}"></p>
3023                 <div id="bar_{$this->html_id}" style="border-style:solid;border-width:1px;width:500px;height:50px;">
3024                     <div id="progress_{$this->html_id}"
3025                     style="text-align:center;background:#FFCC66;width:4px;border:1px
3026                     solid gray;height:38px; padding-top:10px;">&nbsp;<span id="pt_{$this->html_id}"></span>
3027                     </div>
3028                 </div>
3029             </div>
3030 EOT;
3031             echo $htmlcode;
3032             flush();
3033     }
3034     /**
3035      * Update the progress bar
3036      *
3037      * @param int $percent from 1-100
3038      * @param string $msg
3039      * @param mixed $es
3040      * @return void Echo's output
3041      */
3042     private function _update($percent, $msg, $es){
3043         global $PAGE;
3044         if(empty($this->time_start)){
3045             $this->time_start = microtime(true);
3046         }
3047         $this->percent = $percent;
3048         $this->lastcall->time = microtime(true);
3049         $this->lastcall->pt   = $percent;
3050         $w = $this->percent * $this->width;
3051         if (CLI_SCRIPT) {
3052             return; // temporary solution for cli scripts
3053         }
3054         if ($es === null){
3055             $es = "Infinity";
3056         }
3057         echo html_writer::script(js_writer::function_call('update_progress_bar', Array($this->html_id, $w, $this->percent, $msg, $es)));
3058         flush();
3059     }
3060     /**
3061       * estimate time
3062       *
3063       * @param int $curtime the time call this function
3064       * @param int $percent from 1-100
3065       * @return mixed Null, or int
3066       */
3067     private function estimate($curtime, $pt){
3068         $consume = $curtime - $this->time_start;
3069         $one = $curtime - $this->lastcall->time;
3070         $this->percent = $pt;
3071         $percent = $pt - $this->lastcall->pt;
3072         if ($percent != 0) {
3073             $left = ($one / $percent) - $consume;
3074         } else {
3075             return null;
3076         }
3077         if($left < 0) {
3078             return 0;
3079         } else {
3080             return $left;
3081         }
3082     }
3083     /**
3084       * Update progress bar according percent
3085       *
3086       * @param int $percent from 1-100
3087       * @param string $msg the message needed to be shown
3088       */
3089     public function update_full($percent, $msg){
3090         $percent = max(min($percent, 100), 0);
3091         if ($percent != 100 && ($this->lastcall->time + $this->minimum_time) > microtime(true)){
3092             return;
3093         }
3094         $this->_update($percent, 100, $msg);
3095     }
3096     /**
3097       * Update progress bar according the number of tasks
3098       *
3099       * @param int $cur current task number
3100       * @param int $total total task number
3101       * @param string $msg message
3102       */
3103     public function update($cur, $total, $msg){
3104         $cur = max($cur, 0);
3105         if ($cur >= $total){
3106             $percent = 1;
3107         } else {
3108             $percent = $cur / $total;
3109         }
3110         /**
3111         if ($percent != 1 && ($this->lastcall->time + $this->minimum_time) > microtime(true)){
3112             return;
3113         }
3114         */
3115         $es = $this->estimate(microtime(true), $percent);
3116         $this->_update($percent, $msg, $es);
3117     }
3118     /**
3119      * Restart the progress bar.
3120      */
3121     public function restart(){
3122         $this->percent  = 0;
3123         $this->lastcall = new stdClass;
3124         $this->lastcall->pt = 0;
3125         $this->lastcall->time = microtime(true);
3126         $this->time_start  = 0;
3127     }
3130 /**
3131  * Use this class from long operations where you want to output occasional information about
3132  * what is going on, but don't know if, or in what format, the output should be.
3133  *
3134  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3135  * @package moodlecore
3136  */
3137 abstract class progress_trace {
3138     /**
3139      * Ouput an progress message in whatever format.
3140      * @param string $message the message to output.
3141      * @param integer $depth indent depth for this message.
3142      */
3143     abstract public function output($message, $depth = 0);
3145     /**
3146      * Called when the processing is finished.
3147      */
3148     public function finished() {
3149     }
3152 /**
3153  * This subclass of progress_trace does not ouput anything.
3154  *
3155  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3156  * @package moodlecore
3157  */
3158 class null_progress_trace extends progress_trace {
3159     /**
3160      * Does Nothing
3161      *
3162      * @param string $message
3163      * @param int $depth
3164      * @return void Does Nothing
3165      */
3166     public function output($message, $depth = 0) {
3167     }
3170 /**
3171  * This subclass of progress_trace outputs to plain text.
3172  *
3173  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3174  * @package moodlecore
3175  */
3176 class text_progress_trace extends progress_trace {
3177     /**
3178      * Output the trace message
3179      *
3180      * @param string $message
3181      * @param int $depth
3182      * @return void Output is echo'd
3183      */
3184     public function output($message, $depth = 0) {
3185         echo str_repeat('  ', $depth), $message, "\n";
3186         flush();
3187     }
3190 /**
3191  * This subclass of progress_trace outputs as HTML.
3192  *
3193  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3194  * @package moodlecore
3195  */
3196 class html_progress_trace extends progress_trace {
3197     /**
3198      * Output the trace message
3199      *
3200      * @param string $message
3201      * @param int $depth
3202      * @return void Output is echo'd
3203      */
3204     public function output($message, $depth = 0) {
3205         echo '<p>', str_repeat('&#160;&#160;', $depth), htmlspecialchars($message), "</p>\n";
3206         flush();
3207     }
3210 /**
3211  * HTML List Progress Tree
3212  *
3213  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3214  * @package moodlecore
3215  */
3216 class html_list_progress_trace extends progress_trace {
3217     /** @var int */
3218     protected $currentdepth = -1;
3220     /**
3221      * Echo out the list
3222      *
3223      * @param string $message The message to display
3224      * @param int $depth
3225      * @return void Output is echoed
3226      */
3227     public function output($message, $depth = 0) {
3228         $samedepth = true;
3229         while ($this->currentdepth > $depth) {
3230             echo "</li>\n</ul>\n";
3231             $this->currentdepth -= 1;
3232             if ($this->currentdepth == $depth) {
3233                 echo '<li>';
3234             }
3235             $samedepth = false;
3236         }
3237         while ($this->currentdepth < $depth) {
3238             echo "<ul>\n<li>";
3239             $this->currentdepth += 1;
3240             $samedepth = false;
3241         }
3242         if ($samedepth) {
3243             echo "</li>\n<li>";
3244         }
3245         echo htmlspecialchars($message);
3246         flush();
3247     }
3249     /**
3250      * Called when the processing is finished.
3251      */
3252     public function finished() {
3253         while ($this->currentdepth >= 0) {
3254             echo "</li>\n</ul>\n";
3255             $this->currentdepth -= 1;
3256         }
3257     }
3260 /**
3261  * Returns a localized sentence in the current language summarizing the current password policy
3262  *
3263  * @todo this should be handled by a function/method in the language pack library once we have a support for it
3264  * @uses $CFG
3265  * @return string
3266  */
3267 function print_password_policy() {
3268     global $CFG;
3270     $message = '';
3271     if (!empty($CFG->passwordpolicy)) {
3272         $messages = array();
3273         $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength);
3274         if (!empty($CFG->minpassworddigits)) {
3275             $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits);
3276         }
3277         if (!empty($CFG->minpasswordlower)) {
3278             $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower);
3279         }
3280         if (!empty($CFG->minpasswordupper)) {
3281             $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper);
3282         }
3283         if (!empty($CFG->minpasswordnonalphanum)) {
3284             $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3285         }
3287         $messages = join(', ', $messages); // this is ugly but we do not have anything better yet...
3288         $message = get_string('informpasswordpolicy', 'auth', $messages);
3289     }
3290     return $message;
3293 function create_ufo_inline($id, $args) {
3294     global $CFG;
3295     // must not use $PAGE, $THEME, $COURSE etc. because the result is cached!
3296     // unfortunately this ufo.js can not be cached properly because we do not have access to current $CFG either
3297     $jsoutput = html_writer::script('', $CFG->wwwroot.'/lib/ufo.js');
3298     $jsoutput .= html_writer::script(js_writer::function_call('M.util.create_UFO_object', array($id, $args)));
3299     return $jsoutput;
3302 function create_flowplayer($id, $fileurl, $type='flv', $color='#000000') {
3303     global $CFG;
3305     $playerpath = $CFG->wwwroot.'/filter/mediaplugin/'.$type.'player.swf';
3306     $jsoutput = html_writer::script('', $CFG->wwwroot.'/lib/flowplayer.js');
3308     if ($type == 'flv') {
3309         $jsoutput .= html_writer::script(js_writer::function_call('M.util.init_flvflowplayer', array($id, $playerpath, $fileurl)));
3310     } else if ($type == 'mp3') {
3311         $audioplayerpath = $CFG->wwwroot .'/filter/mediaplugin/flowplayer.audio.swf';
3312         $jsoutput .= html_writer::script(js_writer::function_call('M.util.init_mp3flowplayerplugin', array($id, $playerpath, $audioplayerpath, $fileurl, $color)));
3313     }
3315     return $jsoutput;