MDL-24848 prevent undefined docs url problems in install
[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     if ($relativepath !== false and $relativepath !== '') {
889         return $relativepath;
890     }
891     $relativepath = false;
893     // then try extract file from the slasharguments
894     if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
895         // NOTE: ISS tends to convert all file paths to single byte DOS encoding,
896         //       we can not use other methods because they break unicode chars,
897         //       the only way is to use URL rewriting
898         if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
899             // check that PATH_INFO works == must not contain the script name
900             if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
901                 $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
902             }
903         }
904     } else {
905         // all other apache-like servers depend on PATH_INFO
906         if (isset($_SERVER['PATH_INFO'])) {
907             if (isset($_SERVER['SCRIPT_NAME']) and strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === 0) {
908                 $relativepath = substr($_SERVER['PATH_INFO'], strlen($_SERVER['SCRIPT_NAME']));
909             } else {
910                 $relativepath = $_SERVER['PATH_INFO'];
911             }
912             $relativepath = clean_param($relativepath, PARAM_PATH);
913         }
914     }
917     return $relativepath;
920 /**
921  * Just returns an array of text formats suitable for a popup menu
922  *
923  * @uses FORMAT_MOODLE
924  * @uses FORMAT_HTML
925  * @uses FORMAT_PLAIN
926  * @uses FORMAT_MARKDOWN
927  * @return array
928  */
929 function format_text_menu() {
930     return array (FORMAT_MOODLE => get_string('formattext'),
931                   FORMAT_HTML   => get_string('formathtml'),
932                   FORMAT_PLAIN  => get_string('formatplain'),
933                   FORMAT_MARKDOWN  => get_string('formatmarkdown'));
936 /**
937  * Given text in a variety of format codings, this function returns
938  * the text as safe HTML.
939  *
940  * This function should mainly be used for long strings like posts,
941  * answers, glossary items etc. For short strings @see format_string().
942  *
943  * @todo Finish documenting this function
944  *
945  * @staticvar array $croncache
946  * @param string $text The text to be formatted. This is raw text originally from user input.
947  * @param int $format Identifier of the text format to be used
948  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
949  * @param object/array $options text formatting options
950  * @param int $courseid_do_not_use deprecated course id, use context option instead
951  * @return string
952  */
953 function format_text($text, $format = FORMAT_MOODLE, $options = NULL, $courseid_do_not_use = NULL) {
954     global $CFG, $COURSE, $DB, $PAGE;
955     static $croncache = array();
957     if ($text === '') {
958         return ''; // no need to do any filters and cleaning
959     }
961     $options = (array)$options; // detach object, we can not modify it
963     if (!isset($options['trusted'])) {
964         $options['trusted'] = false;
965     }
966     if (!isset($options['noclean'])) {
967         if ($options['trusted'] and trusttext_active()) {
968             // no cleaning if text trusted and noclean not specified
969             $options['noclean'] = true;
970         } else {
971             $options['noclean'] = false;
972         }
973     }
974     if (!isset($options['nocache'])) {
975         $options['nocache'] = false;
976     }
977     if (!isset($options['filter'])) {
978         $options['filter'] = true;
979     }
980     if (!isset($options['para'])) {
981         $options['para'] = true;
982     }
983     if (!isset($options['newlines'])) {
984         $options['newlines'] = true;
985     }
987     // Calculate best context
988     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
989         // do not filter anything during installation or before upgrade completes
990         $context = null;
992     } else if (isset($options['context'])) { // first by explicit passed context option
993         if (is_object($options['context'])) {
994             $context = $options['context'];
995         } else {
996             $context = get_context_instance_by_id($context);
997         }
998     } else if ($courseid_do_not_use) {
999         // legacy courseid
1000         $context = get_context_instance(CONTEXT_COURSE, $courseid_do_not_use);
1001     } else {
1002         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1003         $context = $PAGE->context;
1004     }
1006     if (!$context) {
1007         // either install/upgrade or something has gone really wrong because context does not exist (yet?)
1008         $options['nocache'] = true;
1009         $options['filter']  = false;
1010     }
1012     if ($options['filter']) {
1013         $filtermanager = filter_manager::instance();
1014     } else {
1015         $filtermanager = new null_filter_manager();
1016     }
1018     if (!empty($CFG->cachetext) and empty($options['nocache'])) {
1019         $hashstr = $text.'-'.$filtermanager->text_filtering_hash($context).'-'.$context->id.'-'.current_language().'-'.
1020                 (int)$format.(int)$options['trusted'].(int)$options['noclean'].
1021                 (int)$options['para'].(int)$options['newlines'];
1023         $time = time() - $CFG->cachetext;
1024         $md5key = md5($hashstr);
1025         if (CLI_SCRIPT) {
1026             if (isset($croncache[$md5key])) {
1027                 return $croncache[$md5key];
1028             }
1029         }
1031         if ($oldcacheitem = $DB->get_record('cache_text', array('md5key'=>$md5key), '*', IGNORE_MULTIPLE)) {
1032             if ($oldcacheitem->timemodified >= $time) {
1033                 if (CLI_SCRIPT) {
1034                     if (count($croncache) > 150) {
1035                         reset($croncache);
1036                         $key = key($croncache);
1037                         unset($croncache[$key]);
1038                     }
1039                     $croncache[$md5key] = $oldcacheitem->formattedtext;
1040                 }
1041                 return $oldcacheitem->formattedtext;
1042             }
1043         }
1044     }
1046     switch ($format) {
1047         case FORMAT_HTML:
1048             if (!$options['noclean']) {
1049                 $text = clean_text($text, FORMAT_HTML);
1050             }
1051             $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_HTML));
1052             break;
1054         case FORMAT_PLAIN:
1055             $text = s($text); // cleans dangerous JS
1056             $text = rebuildnolinktag($text);
1057             $text = str_replace('  ', '&nbsp; ', $text);
1058             $text = nl2br($text);
1059             break;
1061         case FORMAT_WIKI:
1062             // this format is deprecated
1063             $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle.  You should not be seeing
1064                      this message as all texts should have been converted to Markdown format instead.
1065                      Please post a bug report to http://moodle.org/bugs with information about where you
1066                      saw this message.</p>'.s($text);
1067             break;
1069         case FORMAT_MARKDOWN:
1070             $text = markdown_to_html($text);
1071             if (!$options['noclean']) {
1072                 $text = clean_text($text, FORMAT_HTML);
1073             }
1074             $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_MARKDOWN));
1075             break;
1077         default:  // FORMAT_MOODLE or anything else
1078             $text = text_to_html($text, null, $options['para'], $options['newlines']);
1079             if (!$options['noclean']) {
1080                 $text = clean_text($text, FORMAT_HTML);
1081             }
1082             $text = $filtermanager->filter_text($text, $context, array('originalformat' => $format));
1083             break;
1084     }
1086     // Warn people that we have removed this old mechanism, just in case they
1087     // were stupid enough to rely on it.
1088     if (isset($CFG->currenttextiscacheable)) {
1089         debugging('Once upon a time, Moodle had a truly evil use of global variables ' .
1090                 'called $CFG->currenttextiscacheable. The good news is that this no ' .
1091                 'longer exists. The bad news is that you seem to be using a filter that '.
1092                 'relies on it. Please seek out and destroy that filter code.', DEBUG_DEVELOPER);
1093     }
1095     if (empty($options['nocache']) and !empty($CFG->cachetext)) {
1096         if (CLI_SCRIPT) {
1097             // special static cron cache - no need to store it in db if its not already there
1098             if (count($croncache) > 150) {
1099                 reset($croncache);
1100                 $key = key($croncache);
1101                 unset($croncache[$key]);
1102             }
1103             $croncache[$md5key] = $text;
1104             return $text;
1105         }
1107         $newcacheitem = new stdClass();
1108         $newcacheitem->md5key = $md5key;
1109         $newcacheitem->formattedtext = $text;
1110         $newcacheitem->timemodified = time();
1111         if ($oldcacheitem) {                               // See bug 4677 for discussion
1112             $newcacheitem->id = $oldcacheitem->id;
1113             try {
1114                 $DB->update_record('cache_text', $newcacheitem);   // Update existing record in the cache table
1115             } catch (dml_exception $e) {
1116                // It's unlikely that the cron cache cleaner could have
1117                // deleted this entry in the meantime, as it allows
1118                // some extra time to cover these cases.
1119             }
1120         } else {
1121             try {
1122                 $DB->insert_record('cache_text', $newcacheitem);   // Insert a new record in the cache table
1123             } catch (dml_exception $e) {
1124                // Again, it's possible that another user has caused this
1125                // record to be created already in the time that it took
1126                // to traverse this function.  That's OK too, as the
1127                // call above handles duplicate entries, and eventually
1128                // the cron cleaner will delete them.
1129             }
1130         }
1131     }
1133     return $text;
1136 /**
1137  * Converts the text format from the value to the 'internal'
1138  * name or vice versa.
1139  *
1140  * $key can either be the value or the name and you get the other back.
1141  *
1142  * @uses FORMAT_MOODLE
1143  * @uses FORMAT_HTML
1144  * @uses FORMAT_PLAIN
1145  * @uses FORMAT_MARKDOWN
1146  * @param mixed $key int 0-4 or string one of 'moodle','html','plain','markdown'
1147  * @return mixed as above but the other way around!
1148  */
1149 function text_format_name($key) {
1150   $lookup = array();
1151   $lookup[FORMAT_MOODLE] = 'moodle';
1152   $lookup[FORMAT_HTML] = 'html';
1153   $lookup[FORMAT_PLAIN] = 'plain';
1154   $lookup[FORMAT_MARKDOWN] = 'markdown';
1155   $value = "error";
1156   if (!is_numeric($key)) {
1157     $key = strtolower( $key );
1158     $value = array_search( $key, $lookup );
1159   }
1160   else {
1161     if (isset( $lookup[$key] )) {
1162       $value =  $lookup[ $key ];
1163     }
1164   }
1165   return $value;
1168 /**
1169  * Resets all data related to filters, called during upgrade or when filter settings change.
1170  *
1171  * @global object
1172  * @global object
1173  * @return void
1174  */
1175 function reset_text_filters_cache() {
1176     global $CFG, $DB;
1178     $DB->delete_records('cache_text');
1179     $purifdir = $CFG->dataroot.'/cache/htmlpurifier';
1180     remove_dir($purifdir, true);
1183 /**
1184  * Given a simple string, this function returns the string
1185  * processed by enabled string filters if $CFG->filterall is enabled
1186  *
1187  * This function should be used to print short strings (non html) that
1188  * need filter processing e.g. activity titles, post subjects,
1189  * glossary concepts.
1190  *
1191  * @global object
1192  * @global object
1193  * @global object
1194  * @staticvar bool $strcache
1195  * @param string $string The string to be filtered.
1196  * @param boolean $striplinks To strip any link in the result text.
1197                               Moodle 1.8 default changed from false to true! MDL-8713
1198  * @param array $options options array/object or courseid
1199  * @return string
1200  */
1201 function format_string($string, $striplinks = true, $options = NULL) {
1202     global $CFG, $COURSE, $PAGE;
1204     //We'll use a in-memory cache here to speed up repeated strings
1205     static $strcache = false;
1207     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
1208         // do not filter anything during installation or before upgrade completes
1209         return $string = strip_tags($string);
1210     }
1212     if ($strcache === false or count($strcache) > 2000) { // this number might need some tuning to limit memory usage in cron
1213         $strcache = array();
1214     }
1216     if (is_numeric($options)) {
1217         // legacy courseid usage
1218         $options  = array('context'=>get_context_instance(CONTEXT_COURSE, $options));
1219     } else {
1220         $options = (array)$options; // detach object, we can not modify it
1221     }
1223     if (empty($options['context'])) {
1224         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1225         $options['context'] = $PAGE->context;
1226     } else if (is_numeric($options['context'])) {
1227         $options['context'] = get_context_instance_by_id($options['context']);
1228     }
1230     if (!$options['context']) {
1231         // we did not find any context? weird
1232         return $string = strip_tags($string);
1233     }
1235     //Calculate md5
1236     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id.'<+>'.current_language());
1238     //Fetch from cache if possible
1239     if (isset($strcache[$md5])) {
1240         return $strcache[$md5];
1241     }
1243     // First replace all ampersands not followed by html entity code
1244     // Regular expression moved to its own method for easier unit testing
1245     $string = replace_ampersands_not_followed_by_entity($string);
1247     if (!empty($CFG->filterall)) {
1248         $string = filter_manager::instance()->filter_string($string, $options['context']);
1249     }
1251     // If the site requires it, strip ALL tags from this string
1252     if (!empty($CFG->formatstringstriptags)) {
1253         $string = strip_tags($string);
1255     } else {
1256         // Otherwise strip just links if that is required (default)
1257         if ($striplinks) {  //strip links in string
1258             $string = strip_links($string);
1259         }
1260         $string = clean_text($string);
1261     }
1263     //Store to cache
1264     $strcache[$md5] = $string;
1266     return $string;
1269 /**
1270  * Given a string, performs a negative lookahead looking for any ampersand character
1271  * that is not followed by a proper HTML entity. If any is found, it is replaced
1272  * by &amp;. The string is then returned.
1273  *
1274  * @param string $string
1275  * @return string
1276  */
1277 function replace_ampersands_not_followed_by_entity($string) {
1278     return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1281 /**
1282  * Given a string, replaces all <a>.*</a> by .* and returns the string.
1283  *
1284  * @param string $string
1285  * @return string
1286  */
1287 function strip_links($string) {
1288     return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is','$2',$string);
1291 /**
1292  * This expression turns links into something nice in a text format. (Russell Jungwirth)
1293  *
1294  * @param string $string
1295  * @return string
1296  */
1297 function wikify_links($string) {
1298     return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i','$3 [ $2 ]', $string);
1301 /**
1302  * Replaces non-standard HTML entities
1303  *
1304  * @param string $string
1305  * @return string
1306  */
1307 function fix_non_standard_entities($string) {
1308     $text = preg_replace('/&#0*([0-9]+);?/', '&#$1;', $string);
1309     $text = preg_replace('/&#x0*([0-9a-fA-F]+);?/', '&#x$1;', $text);
1310     $text = preg_replace('[\x00-\x08\x0b-\x0c\x0e-\x1f]', '', $text);
1311     return $text;
1314 /**
1315  * Given text in a variety of format codings, this function returns
1316  * the text as plain text suitable for plain email.
1317  *
1318  * @uses FORMAT_MOODLE
1319  * @uses FORMAT_HTML
1320  * @uses FORMAT_PLAIN
1321  * @uses FORMAT_WIKI
1322  * @uses FORMAT_MARKDOWN
1323  * @param string $text The text to be formatted. This is raw text originally from user input.
1324  * @param int $format Identifier of the text format to be used
1325  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1326  * @return string
1327  */
1328 function format_text_email($text, $format) {
1330     switch ($format) {
1332         case FORMAT_PLAIN:
1333             return $text;
1334             break;
1336         case FORMAT_WIKI:
1337             // there should not be any of these any more!
1338             $text = wikify_links($text);
1339             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1340             break;
1342         case FORMAT_HTML:
1343             return html_to_text($text);
1344             break;
1346         case FORMAT_MOODLE:
1347         case FORMAT_MARKDOWN:
1348         default:
1349             $text = wikify_links($text);
1350             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1351             break;
1352     }
1355 /**
1356  * Formats activity intro text
1357  *
1358  * @global object
1359  * @uses CONTEXT_MODULE
1360  * @param string $module name of module
1361  * @param object $activity instance of activity
1362  * @param int $cmid course module id
1363  * @param bool $filter filter resulting html text
1364  * @return text
1365  */
1366 function format_module_intro($module, $activity, $cmid, $filter=true) {
1367     global $CFG;
1368     require_once("$CFG->libdir/filelib.php");
1369     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1370     $options = (object)array('noclean'=>true, 'para'=>false, 'filter'=>$filter, 'context'=>$context);
1371     $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, 'mod_'.$module, 'intro', null);
1372     return trim(format_text($intro, $activity->introformat, $options, null));
1375 /**
1376  * Legacy function, used for cleaning of old forum and glossary text only.
1377  *
1378  * @global object
1379  * @param string $text text that may contain legacy TRUSTTEXT marker
1380  * @return text without legacy TRUSTTEXT marker
1381  */
1382 function trusttext_strip($text) {
1383     while (true) { //removing nested TRUSTTEXT
1384         $orig = $text;
1385         $text = str_replace('#####TRUSTTEXT#####', '', $text);
1386         if (strcmp($orig, $text) === 0) {
1387             return $text;
1388         }
1389     }
1392 /**
1393  * Must be called before editing of all texts
1394  * with trust flag. Removes all XSS nasties
1395  * from texts stored in database if needed.
1396  *
1397  * @param object $object data object with xxx, xxxformat and xxxtrust fields
1398  * @param string $field name of text field
1399  * @param object $context active context
1400  * @return object updated $object
1401  */
1402 function trusttext_pre_edit($object, $field, $context) {
1403     $trustfield  = $field.'trust';
1404     $formatfield = $field.'format';
1406     if (!$object->$trustfield or !trusttext_trusted($context)) {
1407         $object->$field = clean_text($object->$field, $object->$formatfield);
1408     }
1410     return $object;
1413 /**
1414  * Is current user trusted to enter no dangerous XSS in this context?
1415  *
1416  * Please note the user must be in fact trusted everywhere on this server!!
1417  *
1418  * @param object $context
1419  * @return bool true if user trusted
1420  */
1421 function trusttext_trusted($context) {
1422     return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1425 /**
1426  * Is trusttext feature active?
1427  *
1428  * @global object
1429  * @param object $context
1430  * @return bool
1431  */
1432 function trusttext_active() {
1433     global $CFG;
1435     return !empty($CFG->enabletrusttext);
1438 /**
1439  * Given raw text (eg typed in by a user), this function cleans it up
1440  * and removes any nasty tags that could mess up Moodle pages.
1441  *
1442  * NOTE: the format parameter was deprecated because we can safely clean only HTML.
1443  *
1444  * @param string $text The text to be cleaned
1445  * @param int $format deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
1446  * @return string The cleaned up text
1447  */
1448 function clean_text($text, $format = FORMAT_HTML) {
1449     global $ALLOWED_TAGS, $CFG;
1451     if (empty($text) or is_numeric($text)) {
1452        return (string)$text;
1453     }
1455     if ($format != FORMAT_HTML and $format != FORMAT_HTML) {
1456         // TODO: we need to standardise cleanup of text when loading it into editor first
1457         //debugging('clean_text() is designed to work only with html');
1458     }
1460     if ($format == FORMAT_PLAIN) {
1461         return $text;
1462     }
1464     if (!empty($CFG->enablehtmlpurifier)) {
1465         $text = purify_html($text);
1466     } else {
1467     /// Fix non standard entity notations
1468         $text = fix_non_standard_entities($text);
1470     /// Remove tags that are not allowed
1471         $text = strip_tags($text, $ALLOWED_TAGS);
1473     /// Clean up embedded scripts and , using kses
1474         $text = cleanAttributes($text);
1476     /// Again remove tags that are not allowed
1477         $text = strip_tags($text, $ALLOWED_TAGS);
1479     }
1481     // Remove potential script events - some extra protection for undiscovered bugs in our code
1482     $text = preg_replace("~([^a-z])language([[:space:]]*)=~i", "$1Xlanguage=", $text);
1483     $text = preg_replace("~([^a-z])on([a-z]+)([[:space:]]*)=~i", "$1Xon$2=", $text);
1485     return $text;
1488 /**
1489  * KSES replacement cleaning function - uses HTML Purifier.
1490  *
1491  * @global object
1492  * @param string $text The (X)HTML string to purify
1493  */
1494 function purify_html($text) {
1495     global $CFG;
1497     // this can not be done only once because we sometimes need to reset the cache
1498     $cachedir = $CFG->dataroot.'/cache/htmlpurifier';
1499     check_dir_exists($cachedir);
1501     static $purifier = false;
1502     if ($purifier === false) {
1503         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1504         $config = HTMLPurifier_Config::createDefault();
1506         $config->set('HTML.DefinitionID', 'moodlehtml');
1507         $config->set('HTML.DefinitionRev', 1);
1508         $config->set('Cache.SerializerPath', $cachedir);
1509         //$config->set('Cache.SerializerPermission', $CFG->directorypermissions); // it would be nice to get this upstream
1510         $config->set('Core.NormalizeNewlines', false);
1511         $config->set('Core.ConvertDocumentToFragment', true);
1512         $config->set('Core.Encoding', 'UTF-8');
1513         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1514         $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));
1515         $config->set('Attr.AllowedFrameTargets', array('_blank'));
1517         if (!empty($CFG->allowobjectembed)) {
1518             $config->set('HTML.SafeObject', true);
1519             $config->set('Output.FlashCompat', true);
1520             $config->set('HTML.SafeEmbed', true);
1521         }
1523         $def = $config->getHTMLDefinition(true);
1524         $def->addElement('nolink', 'Block', 'Flow', array());                       // skip our filters inside
1525         $def->addElement('tex', 'Inline', 'Inline', array());                       // tex syntax, equivalent to $$xx$$
1526         $def->addElement('algebra', 'Inline', 'Inline', array());                   // algebra syntax, equivalent to @@xx@@
1527         $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // old anf future style multilang - only our hacked lang attribute
1528         $def->addAttribute('span', 'xxxlang', 'CDATA');                             // current problematic multilang
1530         $purifier = new HTMLPurifier($config);
1531     }
1533     $multilang = (strpos($text, 'class="multilang"') !== false);
1535     if ($multilang) {
1536         $text = preg_replace('/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/', '<span xxxlang="${2}">', $text);
1537     }
1538     $text = $purifier->purify($text);
1539     if ($multilang) {
1540         $text = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $text);
1541     }
1543     return $text;
1546 /**
1547  * This function takes a string and examines it for HTML tags.
1548  *
1549  * If tags are detected it passes the string to a helper function {@link cleanAttributes2()}
1550  * which checks for attributes and filters them for malicious content
1551  *
1552  * @param string $str The string to be examined for html tags
1553  * @return string
1554  */
1555 function cleanAttributes($str){
1556     $result = preg_replace_callback(
1557             '%(<[^>]*(>|$)|>)%m', #search for html tags
1558             "cleanAttributes2",
1559             $str
1560             );
1561     return  $result;
1564 /**
1565  * This function takes a string with an html tag and strips out any unallowed
1566  * protocols e.g. javascript:
1567  *
1568  * It calls ancillary functions in kses which are prefixed by kses
1569  *
1570  * @global object
1571  * @global string
1572  * @param array $htmlArray An array from {@link cleanAttributes()}, containing in its 1st
1573  *              element the html to be cleared
1574  * @return string
1575  */
1576 function cleanAttributes2($htmlArray){
1578     global $CFG, $ALLOWED_PROTOCOLS;
1579     require_once($CFG->libdir .'/kses.php');
1581     $htmlTag = $htmlArray[1];
1582     if (substr($htmlTag, 0, 1) != '<') {
1583         return '&gt;';  //a single character ">" detected
1584     }
1585     if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $htmlTag, $matches)) {
1586         return ''; // It's seriously malformed
1587     }
1588     $slash = trim($matches[1]); //trailing xhtml slash
1589     $elem = $matches[2];    //the element name
1590     $attrlist = $matches[3]; // the list of attributes as a string
1592     $attrArray = kses_hair($attrlist, $ALLOWED_PROTOCOLS);
1594     $attStr = '';
1595     foreach ($attrArray as $arreach) {
1596         $arreach['name'] = strtolower($arreach['name']);
1597         if ($arreach['name'] == 'style') {
1598             $value = $arreach['value'];
1599             while (true) {
1600                 $prevvalue = $value;
1601                 $value = kses_no_null($value);
1602                 $value = preg_replace("/\/\*.*\*\//Us", '', $value);
1603                 $value = kses_decode_entities($value);
1604                 $value = preg_replace('/(&#[0-9]+)(;?)/', "\\1;", $value);
1605                 $value = preg_replace('/(&#x[0-9a-fA-F]+)(;?)/', "\\1;", $value);
1606                 if ($value === $prevvalue) {
1607                     $arreach['value'] = $value;
1608                     break;
1609                 }
1610             }
1611             $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']);
1612             $arreach['value'] = preg_replace("/v\s*b\s*s\s*c\s*r\s*i\s*p\s*t/i", "Xvbscript", $arreach['value']);
1613             $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']);
1614             $arreach['value'] = preg_replace("/b\s*i\s*n\s*d\s*i\s*n\s*g/i", "Xbinding", $arreach['value']);
1615         } else if ($arreach['name'] == 'href') {
1616             //Adobe Acrobat Reader XSS protection
1617             $arreach['value'] = preg_replace('/(\.(pdf|fdf|xfdf|xdp|xfd)[^#]*)#.*$/i', '$1', $arreach['value']);
1618         }
1619         $attStr .=  ' '.$arreach['name'].'="'.$arreach['value'].'"';
1620     }
1622     $xhtml_slash = '';
1623     if (preg_match('%/\s*$%', $attrlist)) {
1624         $xhtml_slash = ' /';
1625     }
1626     return '<'. $slash . $elem . $attStr . $xhtml_slash .'>';
1629 /**
1630  * Given plain text, makes it into HTML as nicely as possible.
1631  * May contain HTML tags already
1632  *
1633  * Do not abuse this function. It is intended as lower level formatting feature used
1634  * by {@see format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
1635  * to call format_text() in most of cases.
1636  *
1637  * @global object
1638  * @param string $text The string to convert.
1639  * @param boolean $smiley_ignored Was used to determine if smiley characters should convert to smiley images, ignored now
1640  * @param boolean $para If true then the returned string will be wrapped in div tags
1641  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1642  * @return string
1643  */
1645 function text_to_html($text, $smiley_ignored=null, $para=true, $newlines=true) {
1646     global $CFG;
1648 /// Remove any whitespace that may be between HTML tags
1649     $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1651 /// Remove any returns that precede or follow HTML tags
1652     $text = preg_replace("~([\n\r])<~i", " <", $text);
1653     $text = preg_replace("~>([\n\r])~i", "> ", $text);
1655 /// Make returns into HTML newlines.
1656     if ($newlines) {
1657         $text = nl2br($text);
1658     }
1660 /// Wrap the whole thing in a div if required
1661     if ($para) {
1662         //return '<p>'.$text.'</p>'; //1.9 version
1663         return '<div class="text_to_html">'.$text.'</div>';
1664     } else {
1665         return $text;
1666     }
1669 /**
1670  * Given Markdown formatted text, make it into XHTML using external function
1671  *
1672  * @global object
1673  * @param string $text The markdown formatted text to be converted.
1674  * @return string Converted text
1675  */
1676 function markdown_to_html($text) {
1677     global $CFG;
1679     if ($text === '' or $text === NULL) {
1680         return $text;
1681     }
1683     require_once($CFG->libdir .'/markdown.php');
1685     return Markdown($text);
1688 /**
1689  * Given HTML text, make it into plain text using external function
1690  *
1691  * @param string $html The text to be converted.
1692  * @param integer $width Width to wrap the text at. (optional, default 75 which
1693  *      is a good value for email. 0 means do not limit line length.)
1694  * @param boolean $dolinks By default, any links in the HTML are collected, and
1695  *      printed as a list at the end of the HTML. If you don't want that, set this
1696  *      argument to false.
1697  * @return string plain text equivalent of the HTML.
1698  */
1699 function html_to_text($html, $width = 75, $dolinks = true) {
1701     global $CFG;
1703     require_once($CFG->libdir .'/html2text.php');
1705     $h2t = new html2text($html, false, $dolinks, $width);
1706     $result = $h2t->get_text();
1708     return $result;
1711 /**
1712  * This function will highlight search words in a given string
1713  *
1714  * It cares about HTML and will not ruin links.  It's best to use
1715  * this function after performing any conversions to HTML.
1716  *
1717  * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1718  * @param string $haystack The string (HTML) within which to highlight the search terms.
1719  * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1720  * @param string $prefix the string to put before each search term found.
1721  * @param string $suffix the string to put after each search term found.
1722  * @return string The highlighted HTML.
1723  */
1724 function highlight($needle, $haystack, $matchcase = false,
1725         $prefix = '<span class="highlight">', $suffix = '</span>') {
1727 /// Quick bail-out in trivial cases.
1728     if (empty($needle) or empty($haystack)) {
1729         return $haystack;
1730     }
1732 /// Break up the search term into words, discard any -words and build a regexp.
1733     $words = preg_split('/ +/', trim($needle));
1734     foreach ($words as $index => $word) {
1735         if (strpos($word, '-') === 0) {
1736             unset($words[$index]);
1737         } else if (strpos($word, '+') === 0) {
1738             $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
1739         } else {
1740             $words[$index] = preg_quote($word, '/');
1741         }
1742     }
1743     $regexp = '/(' . implode('|', $words) . ')/u'; // u is do UTF-8 matching.
1744     if (!$matchcase) {
1745         $regexp .= 'i';
1746     }
1748 /// Another chance to bail-out if $search was only -words
1749     if (empty($words)) {
1750         return $haystack;
1751     }
1753 /// Find all the HTML tags in the input, and store them in a placeholders array.
1754     $placeholders = array();
1755     $matches = array();
1756     preg_match_all('/<[^>]*>/', $haystack, $matches);
1757     foreach (array_unique($matches[0]) as $key => $htmltag) {
1758         $placeholders['<|' . $key . '|>'] = $htmltag;
1759     }
1761 /// In $hastack, replace each HTML tag with the corresponding placeholder.
1762     $haystack = str_replace($placeholders, array_keys($placeholders), $haystack);
1764 /// In the resulting string, Do the highlighting.
1765     $haystack = preg_replace($regexp, $prefix . '$1' . $suffix, $haystack);
1767 /// Turn the placeholders back into HTML tags.
1768     $haystack = str_replace(array_keys($placeholders), $placeholders, $haystack);
1770     return $haystack;
1773 /**
1774  * This function will highlight instances of $needle in $haystack
1775  *
1776  * It's faster that the above function {@link highlight()} and doesn't care about
1777  * HTML or anything.
1778  *
1779  * @param string $needle The string to search for
1780  * @param string $haystack The string to search for $needle in
1781  * @return string The highlighted HTML
1782  */
1783 function highlightfast($needle, $haystack) {
1785     if (empty($needle) or empty($haystack)) {
1786         return $haystack;
1787     }
1789     $parts = explode(moodle_strtolower($needle), moodle_strtolower($haystack));
1791     if (count($parts) === 1) {
1792         return $haystack;
1793     }
1795     $pos = 0;
1797     foreach ($parts as $key => $part) {
1798         $parts[$key] = substr($haystack, $pos, strlen($part));
1799         $pos += strlen($part);
1801         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
1802         $pos += strlen($needle);
1803     }
1805     return str_replace('<span class="highlight"></span>', '', join('', $parts));
1808 /**
1809  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
1810  * Internationalisation, for print_header and backup/restorelib.
1811  *
1812  * @param bool $dir Default false
1813  * @return string Attributes
1814  */
1815 function get_html_lang($dir = false) {
1816     $direction = '';
1817     if ($dir) {
1818         if (right_to_left()) {
1819             $direction = ' dir="rtl"';
1820         } else {
1821             $direction = ' dir="ltr"';
1822         }
1823     }
1824     //Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
1825     $language = str_replace('_', '-', current_language());
1826     @header('Content-Language: '.$language);
1827     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
1831 /// STANDARD WEB PAGE PARTS ///////////////////////////////////////////////////
1833 /**
1834  * Send the HTTP headers that Moodle requires.
1835  * @param $cacheable Can this page be cached on back?
1836  */
1837 function send_headers($contenttype, $cacheable = true) {
1838     @header('Content-Type: ' . $contenttype);
1839     @header('Content-Script-Type: text/javascript');
1840     @header('Content-Style-Type: text/css');
1842     if ($cacheable) {
1843         // Allow caching on "back" (but not on normal clicks)
1844         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0');
1845         @header('Pragma: no-cache');
1846         @header('Expires: ');
1847     } else {
1848         // Do everything we can to always prevent clients and proxies caching
1849         @header('Cache-Control: no-store, no-cache, must-revalidate');
1850         @header('Cache-Control: post-check=0, pre-check=0', false);
1851         @header('Pragma: no-cache');
1852         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1853         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1854     }
1855     @header('Accept-Ranges: none');
1858 /**
1859  * Return the right arrow with text ('next'), and optionally embedded in a link.
1860  *
1861  * @global object
1862  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1863  * @param string $url An optional link to use in a surrounding HTML anchor.
1864  * @param bool $accesshide True if text should be hidden (for screen readers only).
1865  * @param string $addclass Additional class names for the link, or the arrow character.
1866  * @return string HTML string.
1867  */
1868 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
1869     global $OUTPUT; //TODO: move to output renderer
1870     $arrowclass = 'arrow ';
1871     if (! $url) {
1872         $arrowclass .= $addclass;
1873     }
1874     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
1875     $htmltext = '';
1876     if ($text) {
1877         $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
1878         if ($accesshide) {
1879             $htmltext = get_accesshide($htmltext);
1880         }
1881     }
1882     if ($url) {
1883         $class = 'arrow_link';
1884         if ($addclass) {
1885             $class .= ' '.$addclass;
1886         }
1887         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$htmltext.$arrow.'</a>';
1888     }
1889     return $htmltext.$arrow;
1892 /**
1893  * Return the left arrow with text ('previous'), and optionally embedded in a link.
1894  *
1895  * @global object
1896  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1897  * @param string $url An optional link to use in a surrounding HTML anchor.
1898  * @param bool $accesshide True if text should be hidden (for screen readers only).
1899  * @param string $addclass Additional class names for the link, or the arrow character.
1900  * @return string HTML string.
1901  */
1902 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
1903     global $OUTPUT; // TODO: move to utput renderer
1904     $arrowclass = 'arrow ';
1905     if (! $url) {
1906         $arrowclass .= $addclass;
1907     }
1908     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
1909     $htmltext = '';
1910     if ($text) {
1911         $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
1912         if ($accesshide) {
1913             $htmltext = get_accesshide($htmltext);
1914         }
1915     }
1916     if ($url) {
1917         $class = 'arrow_link';
1918         if ($addclass) {
1919             $class .= ' '.$addclass;
1920         }
1921         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$arrow.$htmltext.'</a>';
1922     }
1923     return $arrow.$htmltext;
1926 /**
1927  * Return a HTML element with the class "accesshide", for accessibility.
1928  * Please use cautiously - where possible, text should be visible!
1929  *
1930  * @param string $text Plain text.
1931  * @param string $elem Lowercase element name, default "span".
1932  * @param string $class Additional classes for the element.
1933  * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
1934  * @return string HTML string.
1935  */
1936 function get_accesshide($text, $elem='span', $class='', $attrs='') {
1937     return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
1940 /**
1941  * Return the breadcrumb trail navigation separator.
1942  *
1943  * @return string HTML string.
1944  */
1945 function get_separator() {
1946     //Accessibility: the 'hidden' slash is preferred for screen readers.
1947     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
1950 /**
1951  * Print (or return) a collapsible region, that has a caption that can
1952  * be clicked to expand or collapse the region.
1953  *
1954  * If JavaScript is off, then the region will always be expanded.
1955  *
1956  * @param string $contents the contents of the box.
1957  * @param string $classes class names added to the div that is output.
1958  * @param string $id id added to the div that is output. Must not be blank.
1959  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
1960  * @param string $userpref the name of the user preference that stores the user's preferred default state.
1961  *      (May be blank if you do not wish the state to be persisted.
1962  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
1963  * @param boolean $return if true, return the HTML as a string, rather than printing it.
1964  * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
1965  */
1966 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
1967     $output  = print_collapsible_region_start($classes, $id, $caption, $userpref, true, true);
1968     $output .= $contents;
1969     $output .= print_collapsible_region_end(true);
1971     if ($return) {
1972         return $output;
1973     } else {
1974         echo $output;
1975     }
1978 /**
1979  * Print (or return) the start of a collapsible region, that has a caption that can
1980  * be clicked to expand or collapse the region. If JavaScript is off, then the region
1981  * will always be expanded.
1982  *
1983  * @global object
1984  * @param string $classes class names added to the div that is output.
1985  * @param string $id id added to the div that is output. Must not be blank.
1986  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
1987  * @param boolean $userpref the name of the user preference that stores the user's preferred default state.
1988  *      (May be blank if you do not wish the state to be persisted.
1989  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
1990  * @param boolean $return if true, return the HTML as a string, rather than printing it.
1991  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
1992  */
1993 function print_collapsible_region_start($classes, $id, $caption, $userpref = false, $default = false, $return = false) {
1994     global $CFG, $PAGE, $OUTPUT;
1996     // Work out the initial state.
1997     if (is_string($userpref)) {
1998         user_preference_allow_ajax_update($userpref, PARAM_BOOL);
1999         $collapsed = get_user_preferences($userpref, $default);
2000     } else {
2001         $collapsed = $default;
2002         $userpref = false;
2003     }
2005     if ($collapsed) {
2006         $classes .= ' collapsed';
2007     }
2009     $output = '';
2010     $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2011     $output .= '<div id="' . $id . '_sizer">';
2012     $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2013     $output .= $caption . ' ';
2014     $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2015     $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2017     if ($return) {
2018         return $output;
2019     } else {
2020         echo $output;
2021     }
2024 /**
2025  * Close a region started with print_collapsible_region_start.
2026  *
2027  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2028  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2029  */
2030 function print_collapsible_region_end($return = false) {
2031     $output = '</div></div></div>';
2033     if ($return) {
2034         return $output;
2035     } else {
2036         echo $output;
2037     }
2040 /**
2041  * Print a specified group's avatar.
2042  *
2043  * @global object
2044  * @uses CONTEXT_COURSE
2045  * @param array|stdClass $group A single {@link group} object OR array of groups.
2046  * @param int $courseid The course ID.
2047  * @param boolean $large Default small picture, or large.
2048  * @param boolean $return If false print picture, otherwise return the output as string
2049  * @param boolean $link Enclose image in a link to view specified course?
2050  * @return string|void Depending on the setting of $return
2051  */
2052 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2053     global $CFG;
2055     if (is_array($group)) {
2056         $output = '';
2057         foreach($group as $g) {
2058             $output .= print_group_picture($g, $courseid, $large, true, $link);
2059         }
2060         if ($return) {
2061             return $output;
2062         } else {
2063             echo $output;
2064             return;
2065         }
2066     }
2068     $context = get_context_instance(CONTEXT_COURSE, $courseid);
2070     // If there is no picture, do nothing
2071     if (!$group->picture) {
2072         return '';
2073     }
2075     // If picture is hidden, only show to those with course:managegroups
2076     if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
2077         return '';
2078     }
2080     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2081         $output = '<a href="'. $CFG->wwwroot .'/user/index.php?id='. $courseid .'&amp;group='. $group->id .'">';
2082     } else {
2083         $output = '';
2084     }
2085     if ($large) {
2086         $file = 'f1';
2087     } else {
2088         $file = 'f2';
2089     }
2091     $grouppictureurl = moodle_url::make_pluginfile_url($context->id, 'group', 'icon', $group->id, '/', $file);
2092     $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2093         ' alt="'.s(get_string('group').' '.$group->name).'" title="'.s($group->name).'"/>';
2095     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2096         $output .= '</a>';
2097     }
2099     if ($return) {
2100         return $output;
2101     } else {
2102         echo $output;
2103     }
2107 /**
2108  * Display a recent activity note
2109  *
2110  * @uses CONTEXT_SYSTEM
2111  * @staticvar string $strftimerecent
2112  * @param object A time object
2113  * @param object A user object
2114  * @param string $text Text for display for the note
2115  * @param string $link The link to wrap around the text
2116  * @param bool $return If set to true the HTML is returned rather than echo'd
2117  * @param string $viewfullnames
2118  */
2119 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2120     static $strftimerecent = null;
2121     $output = '';
2123     if (is_null($viewfullnames)) {
2124         $context = get_context_instance(CONTEXT_SYSTEM);
2125         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2126     }
2128     if (is_null($strftimerecent)) {
2129         $strftimerecent = get_string('strftimerecent');
2130     }
2132     $output .= '<div class="head">';
2133     $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2134     $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2135     $output .= '</div>';
2136     $output .= '<div class="info"><a href="'.$link.'">'.format_string($text,true).'</a></div>';
2138     if ($return) {
2139         return $output;
2140     } else {
2141         echo $output;
2142     }
2145 /**
2146  * Returns a popup menu with course activity modules
2147  *
2148  * Given a course
2149  * This function returns a small popup menu with all the
2150  * course activity modules in it, as a navigation menu
2151  * outputs a simple list structure in XHTML
2152  * The data is taken from the serialised array stored in
2153  * the course record
2154  *
2155  * @todo Finish documenting this function
2156  *
2157  * @global object
2158  * @uses CONTEXT_COURSE
2159  * @param course $course A {@link $COURSE} object.
2160  * @param string $sections
2161  * @param string $modinfo
2162  * @param string $strsection
2163  * @param string $strjumpto
2164  * @param int $width
2165  * @param string $cmid
2166  * @return string The HTML block
2167  */
2168 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2170     global $CFG, $OUTPUT;
2172     $section = -1;
2173     $url = '';
2174     $menu = array();
2175     $doneheading = false;
2177     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2179     $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2180     foreach ($modinfo->cms as $mod) {
2181         if ($mod->modname == 'label') {
2182             continue;
2183         }
2185         if ($mod->sectionnum > $course->numsections) {   /// Don't show excess hidden sections
2186             break;
2187         }
2189         if (!$mod->uservisible) { // do not icnlude empty sections at all
2190             continue;
2191         }
2193         if ($mod->sectionnum >= 0 and $section != $mod->sectionnum) {
2194             $thissection = $sections[$mod->sectionnum];
2196             if ($thissection->visible or !$course->hiddensections or
2197                       has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2198                 $thissection->summary = strip_tags(format_string($thissection->summary,true));
2199                 if (!$doneheading) {
2200                     $menu[] = '</ul></li>';
2201                 }
2202                 if ($course->format == 'weeks' or empty($thissection->summary)) {
2203                     $item = $strsection ." ". $mod->sectionnum;
2204                 } else {
2205                     if (strlen($thissection->summary) < ($width-3)) {
2206                         $item = $thissection->summary;
2207                     } else {
2208                         $item = substr($thissection->summary, 0, $width).'...';
2209                     }
2210                 }
2211                 $menu[] = '<li class="section"><span>'.$item.'</span>';
2212                 $menu[] = '<ul>';
2213                 $doneheading = true;
2215                 $section = $mod->sectionnum;
2216             } else {
2217                 // no activities from this hidden section shown
2218                 continue;
2219             }
2220         }
2222         $url = $mod->modname .'/view.php?id='. $mod->id;
2223         $mod->name = strip_tags(format_string($mod->name ,true));
2224         if (strlen($mod->name) > ($width+5)) {
2225             $mod->name = substr($mod->name, 0, $width).'...';
2226         }
2227         if (!$mod->visible) {
2228             $mod->name = '('.$mod->name.')';
2229         }
2230         $class = 'activity '.$mod->modname;
2231         $class .= ($cmid == $mod->id) ? ' selected' : '';
2232         $menu[] = '<li class="'.$class.'">'.
2233                   '<img src="'.$OUTPUT->pix_url('icon', $mod->modname) . '" alt="" />'.
2234                   '<a href="'.$CFG->wwwroot.'/mod/'.$url.'">'.$mod->name.'</a></li>';
2235     }
2237     if ($doneheading) {
2238         $menu[] = '</ul></li>';
2239     }
2240     $menu[] = '</ul></li></ul>';
2242     return implode("\n", $menu);
2245 /**
2246  * Prints a grade menu (as part of an existing form) with help
2247  * Showing all possible numerical grades and scales
2248  *
2249  * @todo Finish documenting this function
2250  * @todo Deprecate: this is only used in a few contrib modules
2251  *
2252  * @global object
2253  * @param int $courseid The course ID
2254  * @param string $name
2255  * @param string $current
2256  * @param boolean $includenograde Include those with no grades
2257  * @param boolean $return If set to true returns rather than echo's
2258  * @return string|bool Depending on value of $return
2259  */
2260 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2262     global $CFG, $OUTPUT;
2264     $output = '';
2265     $strscale = get_string('scale');
2266     $strscales = get_string('scales');
2268     $scales = get_scales_menu($courseid);
2269     foreach ($scales as $i => $scalename) {
2270         $grades[-$i] = $strscale .': '. $scalename;
2271     }
2272     if ($includenograde) {
2273         $grades[0] = get_string('nograde');
2274     }
2275     for ($i=100; $i>=1; $i--) {
2276         $grades[$i] = $i;
2277     }
2278     $output .= html_writer::select($grades, $name, $current, false);
2280     $linkobject = '<span class="helplink"><img class="iconhelp" alt="'.$strscales.'" src="'.$OUTPUT->pix_url('help') . '" /></span>';
2281     $link = new moodle_url('/course/scales.php', array('id'=>$courseid, 'list'=>1));
2282     $action = new popup_action('click', $link->url, 'ratingscales', array('height' => 400, 'width' => 500));
2283     $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title'=>$strscales));
2285     if ($return) {
2286         return $output;
2287     } else {
2288         echo $output;
2289     }
2292 /**
2293  * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2294  * Default errorcode is 1.
2295  *
2296  * Very useful for perl-like error-handling:
2297  *
2298  * do_somethting() or mdie("Something went wrong");
2299  *
2300  * @param string  $msg       Error message
2301  * @param integer $errorcode Error code to emit
2302  */
2303 function mdie($msg='', $errorcode=1) {
2304     trigger_error($msg);
2305     exit($errorcode);
2308 /**
2309  * Print a message and exit.
2310  *
2311  * @param string $message The message to print in the notice
2312  * @param string $link The link to use for the continue button
2313  * @param object $course A course object
2314  * @return void This function simply exits
2315  */
2316 function notice ($message, $link='', $course=NULL) {
2317     global $CFG, $SITE, $COURSE, $PAGE, $OUTPUT;
2319     $message = clean_text($message);   // In case nasties are in here
2321     if (CLI_SCRIPT) {
2322         echo("!!$message!!\n");
2323         exit(1); // no success
2324     }
2326     if (!$PAGE->headerprinted) {
2327         //header not yet printed
2328         $PAGE->set_title(get_string('notice'));
2329         echo $OUTPUT->header();
2330     } else {
2331         echo $OUTPUT->container_end_all(false);
2332     }
2334     echo $OUTPUT->box($message, 'generalbox', 'notice');
2335     echo $OUTPUT->continue_button($link);
2337     echo $OUTPUT->footer();
2338     exit(1); // general error code
2341 /**
2342  * Redirects the user to another page, after printing a notice
2343  *
2344  * This function calls the OUTPUT redirect method, echo's the output
2345  * and then dies to ensure nothing else happens.
2346  *
2347  * <strong>Good practice:</strong> You should call this method before starting page
2348  * output by using any of the OUTPUT methods.
2349  *
2350  * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2351  * @param string $message The message to display to the user
2352  * @param int $delay The delay before redirecting
2353  * @return void - does not return!
2354  */
2355 function redirect($url, $message='', $delay=-1) {
2356     global $OUTPUT, $PAGE, $SESSION, $CFG;
2358     if (CLI_SCRIPT or AJAX_SCRIPT) {
2359         // this is wrong - developers should not use redirect in these scripts,
2360         // but it should not be very likely
2361         throw new moodle_exception('redirecterrordetected', 'error');
2362     }
2364     // prevent debug errors - make sure context is properly initialised
2365     if ($PAGE) {
2366         $PAGE->set_context(null);
2367     }
2369     if ($url instanceof moodle_url) {
2370         $url = $url->out(false);
2371     }
2373     if (!empty($CFG->usesid) && !isset($_COOKIE[session_name()])) {
2374        $url = $SESSION->sid_process_url($url);
2375     }
2377     $debugdisableredirect = false;
2378     do {
2379         if (defined('DEBUGGING_PRINTED')) {
2380             // some debugging already printed, no need to look more
2381             $debugdisableredirect = true;
2382             break;
2383         }
2385         if (empty($CFG->debugdisplay) or empty($CFG->debug)) {
2386             // no errors should be displayed
2387             break;
2388         }
2390         if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2391             break;
2392         }
2394         if (!($lasterror['type'] & $CFG->debug)) {
2395             //last error not interesting
2396             break;
2397         }
2399         // watch out here, @hidden() errors are returned from error_get_last() too
2400         if (headers_sent()) {
2401             //we already started printing something - that means errors likely printed
2402             $debugdisableredirect = true;
2403             break;
2404         }
2406         if (ob_get_level() and ob_get_contents()) {
2407             // there is something waiting to be printed, hopefully it is the errors,
2408             // but it might be some error hidden by @ too - such as the timezone mess from setup.php
2409             $debugdisableredirect = true;
2410             break;
2411         }
2412     } while (false);
2414     if (!empty($message)) {
2415         if ($delay === -1 || !is_numeric($delay)) {
2416             $delay = 3;
2417         }
2418         $message = clean_text($message);
2419     } else {
2420         $message = get_string('pageshouldredirect');
2421         $delay = 0;
2422         // We are going to try to use a HTTP redirect, so we need a full URL.
2423         if (!preg_match('|^[a-z]+:|', $url)) {
2424             // Get host name http://www.wherever.com
2425             $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2426             if (preg_match('|^/|', $url)) {
2427                 // URLs beginning with / are relative to web server root so we just add them in
2428                 $url = $hostpart.$url;
2429             } else {
2430                 // URLs not beginning with / are relative to path of current script, so add that on.
2431                 $url = $hostpart.preg_replace('|\?.*$|','',me()).'/../'.$url;
2432             }
2433             // Replace all ..s
2434             while (true) {
2435                 $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2436                 if ($newurl == $url) {
2437                     break;
2438                 }
2439                 $url = $newurl;
2440             }
2441         }
2442     }
2444     if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
2445         if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
2446             $perf = get_performance_info();
2447             error_log("PERF: " . $perf['txt']);
2448         }
2449     }
2451     $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2452     $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />'));
2454     if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2455         //302 might not work for POST requests, 303 is ignored by obsolete clients.
2456         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2457         @header('Location: '.$url);
2458         echo bootstrap_renderer::plain_redirect_message($encodedurl);
2459         exit;
2460     }
2462     // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2463     $PAGE->set_pagelayout('redirect');  // No header and footer needed
2464     $CFG->docroot = false; // to prevent the link to moodle docs from being displayed on redirect page.
2465     echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect);
2466     exit;
2469 /**
2470  * Given an email address, this function will return an obfuscated version of it
2471  *
2472  * @param string $email The email address to obfuscate
2473  * @return string The obfuscated email address
2474  */
2475  function obfuscate_email($email) {
2477     $i = 0;
2478     $length = strlen($email);
2479     $obfuscated = '';
2480     while ($i < $length) {
2481         if (rand(0,2) && $email{$i}!='@') { //MDL-20619 some browsers have problems unobfuscating @
2482             $obfuscated.='%'.dechex(ord($email{$i}));
2483         } else {
2484             $obfuscated.=$email{$i};
2485         }
2486         $i++;
2487     }
2488     return $obfuscated;
2491 /**
2492  * This function takes some text and replaces about half of the characters
2493  * with HTML entity equivalents.   Return string is obviously longer.
2494  *
2495  * @param string $plaintext The text to be obfuscated
2496  * @return string The obfuscated text
2497  */
2498 function obfuscate_text($plaintext) {
2500     $i=0;
2501     $length = strlen($plaintext);
2502     $obfuscated='';
2503     $prev_obfuscated = false;
2504     while ($i < $length) {
2505         $c = ord($plaintext{$i});
2506         $numerical = ($c >= ord('0')) && ($c <= ord('9'));
2507         if ($prev_obfuscated and $numerical ) {
2508             $obfuscated.='&#'.ord($plaintext{$i}).';';
2509         } else if (rand(0,2)) {
2510             $obfuscated.='&#'.ord($plaintext{$i}).';';
2511             $prev_obfuscated = true;
2512         } else {
2513             $obfuscated.=$plaintext{$i};
2514             $prev_obfuscated = false;
2515         }
2516       $i++;
2517     }
2518     return $obfuscated;
2521 /**
2522  * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2523  * to generate a fully obfuscated email link, ready to use.
2524  *
2525  * @param string $email The email address to display
2526  * @param string $label The text to displayed as hyperlink to $email
2527  * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2528  * @return string The obfuscated mailto link
2529  */
2530 function obfuscate_mailto($email, $label='', $dimmed=false) {
2532     if (empty($label)) {
2533         $label = $email;
2534     }
2535     if ($dimmed) {
2536         $title = get_string('emaildisable');
2537         $dimmed = ' class="dimmed"';
2538     } else {
2539         $title = '';
2540         $dimmed = '';
2541     }
2542     return sprintf("<a href=\"%s:%s\" $dimmed title=\"$title\">%s</a>",
2543                     obfuscate_text('mailto'), obfuscate_email($email),
2544                     obfuscate_text($label));
2547 /**
2548  * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2549  * will transform it to html entities
2550  *
2551  * @param string $text Text to search for nolink tag in
2552  * @return string
2553  */
2554 function rebuildnolinktag($text) {
2556     $text = preg_replace('/&lt;(\/*nolink)&gt;/i','<$1>',$text);
2558     return $text;
2561 /**
2562  * Prints a maintenance message from $CFG->maintenance_message or default if empty
2563  * @return void
2564  */
2565 function print_maintenance_message() {
2566     global $CFG, $SITE, $PAGE, $OUTPUT;
2568     $PAGE->set_pagetype('maintenance-message');
2569     $PAGE->set_pagelayout('maintenance');
2570     $PAGE->set_title(strip_tags($SITE->fullname));
2571     $PAGE->set_heading($SITE->fullname);
2572     echo $OUTPUT->header();
2573     echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2574     if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
2575         echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2576         echo $CFG->maintenance_message;
2577         echo $OUTPUT->box_end();
2578     }
2579     echo $OUTPUT->footer();
2580     die;
2583 /**
2584  * Adjust the list of allowed tags based on $CFG->allowobjectembed and user roles (admin)
2585  *
2586  * @global object
2587  * @global string
2588  * @return void
2589  */
2590 function adjust_allowed_tags() {
2592     global $CFG, $ALLOWED_TAGS;
2594     if (!empty($CFG->allowobjectembed)) {
2595         $ALLOWED_TAGS .= '<embed><object>';
2596     }
2599 /**
2600  * A class for tabs, Some code to print tabs
2601  *
2602  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2603  * @package moodlecore
2604  */
2605 class tabobject {
2606     /**
2607      * @var string
2608      */
2609     var $id;
2610     var $link;
2611     var $text;
2612     /**
2613      * @var bool
2614      */
2615     var $linkedwhenselected;
2617     /**
2618      * A constructor just because I like constructors
2619      *
2620      * @param string $id
2621      * @param string $link
2622      * @param string $text
2623      * @param string $title
2624      * @param bool $linkedwhenselected
2625      */
2626     function tabobject ($id, $link='', $text='', $title='', $linkedwhenselected=false) {
2627         $this->id   = $id;
2628         $this->link = $link;
2629         $this->text = $text;
2630         $this->title = $title ? $title : $text;
2631         $this->linkedwhenselected = $linkedwhenselected;
2632     }
2637 /**
2638  * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2639  *
2640  * @global object
2641  * @param array $tabrows An array of rows where each row is an array of tab objects
2642  * @param string $selected  The id of the selected tab (whatever row it's on)
2643  * @param array  $inactive  An array of ids of inactive tabs that are not selectable.
2644  * @param array  $activated An array of ids of other tabs that are currently activated
2645  * @param bool $return If true output is returned rather then echo'd
2646  **/
2647 function print_tabs($tabrows, $selected=NULL, $inactive=NULL, $activated=NULL, $return=false) {
2648     global $CFG;
2650 /// $inactive must be an array
2651     if (!is_array($inactive)) {
2652         $inactive = array();
2653     }
2655 /// $activated must be an array
2656     if (!is_array($activated)) {
2657         $activated = array();
2658     }
2660 /// Convert the tab rows into a tree that's easier to process
2661     if (!$tree = convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated)) {
2662         return false;
2663     }
2665 /// Print out the current tree of tabs (this function is recursive)
2667     $output = convert_tree_to_html($tree);
2669     $output = "\n\n".'<div class="tabtree">'.$output.'</div><div class="clearer"> </div>'."\n\n";
2671 /// We're done!
2673     if ($return) {
2674         return $output;
2675     }
2676     echo $output;
2679 /**
2680  * Converts a nested array tree into HTML ul:li [recursive]
2681  *
2682  * @param array $tree A tree array to convert
2683  * @param int $row Used in identifying the iteration level and in ul classes
2684  * @return string HTML structure
2685  */
2686 function convert_tree_to_html($tree, $row=0) {
2688     $str = "\n".'<ul class="tabrow'.$row.'">'."\n";
2690     $first = true;
2691     $count = count($tree);
2693     foreach ($tree as $tab) {
2694         $count--;   // countdown to zero
2696         $liclass = '';
2698         if ($first && ($count == 0)) {   // Just one in the row
2699             $liclass = 'first last';
2700             $first = false;
2701         } else if ($first) {
2702             $liclass = 'first';
2703             $first = false;
2704         } else if ($count == 0) {
2705             $liclass = 'last';
2706         }
2708         if ((empty($tab->subtree)) && (!empty($tab->selected))) {
2709             $liclass .= (empty($liclass)) ? 'onerow' : ' onerow';
2710         }
2712         if ($tab->inactive || $tab->active || $tab->selected) {
2713             if ($tab->selected) {
2714                 $liclass .= (empty($liclass)) ? 'here selected' : ' here selected';
2715             } else if ($tab->active) {
2716                 $liclass .= (empty($liclass)) ? 'here active' : ' here active';
2717             }
2718         }
2720         $str .= (!empty($liclass)) ? '<li class="'.$liclass.'">' : '<li>';
2722         if ($tab->inactive || $tab->active || ($tab->selected && !$tab->linkedwhenselected)) {
2723             // The a tag is used for styling
2724             $str .= '<a class="nolink"><span>'.$tab->text.'</span></a>';
2725         } else {
2726             $str .= '<a href="'.$tab->link.'" title="'.$tab->title.'"><span>'.$tab->text.'</span></a>';
2727         }
2729         if (!empty($tab->subtree)) {
2730             $str .= convert_tree_to_html($tab->subtree, $row+1);
2731         } else if ($tab->selected) {
2732             $str .= '<div class="tabrow'.($row+1).' empty">&nbsp;</div>'."\n";
2733         }
2735         $str .= ' </li>'."\n";
2736     }
2737     $str .= '</ul>'."\n";
2739     return $str;
2742 /**
2743  * Convert nested tabrows to a nested array
2744  *
2745  * @param array $tabrows A [nested] array of tab row objects
2746  * @param string $selected The tabrow to select (by id)
2747  * @param array $inactive An array of tabrow id's to make inactive
2748  * @param array $activated An array of tabrow id's to make active
2749  * @return array The nested array
2750  */
2751 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
2753 /// Work backwards through the rows (bottom to top) collecting the tree as we go.
2755     $tabrows = array_reverse($tabrows);
2757     $subtree = array();
2759     foreach ($tabrows as $row) {
2760         $tree = array();
2762         foreach ($row as $tab) {
2763             $tab->inactive = in_array((string)$tab->id, $inactive);
2764             $tab->active = in_array((string)$tab->id, $activated);
2765             $tab->selected = (string)$tab->id == $selected;
2767             if ($tab->active || $tab->selected) {
2768                 if ($subtree) {
2769                     $tab->subtree = $subtree;
2770                 }
2771             }
2772             $tree[] = $tab;
2773         }
2774         $subtree = $tree;
2775     }
2777     return $subtree;
2780 /**
2781  * Returns the Moodle Docs URL in the users language
2782  *
2783  * @global object
2784  * @param string $path the end of the URL.
2785  * @return string The MoodleDocs URL in the user's language. for example {@link http://docs.moodle.org/en/ http://docs.moodle.org/en/$path}
2786  */
2787 function get_docs_url($path) {
2788     global $CFG;
2789     if (!empty($CFG->docroot)) {
2790         return $CFG->docroot . '/' . current_language() . '/' . $path;
2791     } else {
2792         return 'http://docs.moodle.org/en/'.$path;
2793     }
2797 /**
2798  * Standard Debugging Function
2799  *
2800  * Returns true if the current site debugging settings are equal or above specified level.
2801  * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2802  * routing of notices is controlled by $CFG->debugdisplay
2803  * eg use like this:
2804  *
2805  * 1)  debugging('a normal debug notice');
2806  * 2)  debugging('something really picky', DEBUG_ALL);
2807  * 3)  debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
2808  * 4)  if (debugging()) { perform extra debugging operations (do not use print or echo) }
2809  *
2810  * In code blocks controlled by debugging() (such as example 4)
2811  * any output should be routed via debugging() itself, or the lower-level
2812  * trigger_error() or error_log(). Using echo or print will break XHTML
2813  * JS and HTTP headers.
2814  *
2815  * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2816  *
2817  * @uses DEBUG_NORMAL
2818  * @param string $message a message to print
2819  * @param int $level the level at which this debugging statement should show
2820  * @param array $backtrace use different backtrace
2821  * @return bool
2822  */
2823 function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
2824     global $CFG, $UNITTEST;
2826     if (empty($CFG->debug) || $CFG->debug < $level) {
2827         return false;
2828     }
2830     if (!isset($CFG->debugdisplay)) {
2831         $CFG->debugdisplay = ini_get_bool('display_errors');
2832     }
2834     if ($message) {
2835         if (!$backtrace) {
2836             $backtrace = debug_backtrace();
2837         }
2838         $from = format_backtrace($backtrace, CLI_SCRIPT);
2839         if (!empty($UNITTEST->running)) {
2840             // When the unit tests are running, any call to trigger_error
2841             // is intercepted by the test framework and reported as an exception.
2842             // Therefore, we cannot use trigger_error during unit tests.
2843             // At the same time I do not think we should just discard those messages,
2844             // so displaying them on-screen seems like the only option. (MDL-20398)
2845             echo '<div class="notifytiny">' . $message . $from . '</div>';
2847         } else if (NO_DEBUG_DISPLAY) {
2848             // script does not want any errors or debugging in output,
2849             // we send the info to error log instead
2850             error_log('Debugging: ' . $message . $from);
2852         } else if ($CFG->debugdisplay) {
2853             if (!defined('DEBUGGING_PRINTED')) {
2854                 define('DEBUGGING_PRINTED', 1); // indicates we have printed something
2855             }
2856             echo '<div class="notifytiny">' . $message . $from . '</div>';
2858         } else {
2859             trigger_error($message . $from, E_USER_NOTICE);
2860         }
2861     }
2862     return true;
2865 /**
2866 * Outputs a HTML comment to the browser. This is used for those hard-to-debug
2867 * pages that use bits from many different files in very confusing ways (e.g. blocks).
2869 * <code>print_location_comment(__FILE__, __LINE__);</code>
2871 * @param string $file
2872 * @param integer $line
2873 * @param boolean $return Whether to return or print the comment
2874 * @return string|void Void unless true given as third parameter
2875 */
2876 function print_location_comment($file, $line, $return = false)
2878     if ($return) {
2879         return "<!-- $file at line $line -->\n";
2880     } else {
2881         echo "<!-- $file at line $line -->\n";
2882     }
2886 /**
2887  * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
2888  */
2889 function right_to_left() {
2890     return (get_string('thisdirection', 'langconfig') === 'rtl');
2894 /**
2895  * Returns swapped left<=>right if in RTL environment.
2896  * part of RTL support
2897  *
2898  * @param string $align align to check
2899  * @return string
2900  */
2901 function fix_align_rtl($align) {
2902     if (!right_to_left()) {
2903         return $align;
2904     }
2905     if ($align=='left')  { return 'right'; }
2906     if ($align=='right') { return 'left'; }
2907     return $align;
2911 /**
2912  * Returns true if the page is displayed in a popup window.
2913  * Gets the information from the URL parameter inpopup.
2914  *
2915  * @todo Use a central function to create the popup calls all over Moodle and
2916  * In the moment only works with resources and probably questions.
2917  *
2918  * @return boolean
2919  */
2920 function is_in_popup() {
2921     $inpopup = optional_param('inpopup', '', PARAM_BOOL);
2923     return ($inpopup);
2926 /**
2927  * To use this class.
2928  * - construct
2929  * - call create (or use the 3rd param to the constructor)
2930  * - call update or update_full repeatedly
2931  *
2932  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2933  * @package moodlecore
2934  */
2935 class progress_bar {
2936     /** @var string html id */
2937     private $html_id;
2938     /** @var int */
2939     private $percent;
2940     /** @var int */
2941     private $width;
2942     /** @var int */
2943     private $lastcall;
2944     /** @var int */
2945     private $time_start;
2946     private $minimum_time = 2; //min time between updates.
2947     /**
2948      * Constructor
2949      *
2950      * @param string $html_id
2951      * @param int $width
2952      * @param bool $autostart Default to false
2953      */
2954     public function __construct($html_id = '', $width = 500, $autostart = false){
2955         if (!empty($html_id)) {
2956             $this->html_id  = $html_id;
2957         } else {
2958             $this->html_id  = uniqid();
2959         }
2960         $this->width = $width;
2961         $this->restart();
2962         if($autostart){
2963             $this->create();
2964         }
2965     }
2966     /**
2967       * Create a new progress bar, this function will output html.
2968       *
2969       * @return void Echo's output
2970       */
2971     public function create(){
2972             flush();
2973             $this->lastcall->pt = 0;
2974             $this->lastcall->time = microtime(true);
2975             if (CLI_SCRIPT) {
2976                 return; // temporary solution for cli scripts
2977             }
2978             $htmlcode = <<<EOT
2979             <div style="text-align:center;width:{$this->width}px;clear:both;padding:0;margin:0 auto;">
2980                 <h2 id="status_{$this->html_id}" style="text-align: center;margin:0 auto"></h2>
2981                 <p id="time_{$this->html_id}"></p>
2982                 <div id="bar_{$this->html_id}" style="border-style:solid;border-width:1px;width:500px;height:50px;">
2983                     <div id="progress_{$this->html_id}"
2984                     style="text-align:center;background:#FFCC66;width:4px;border:1px
2985                     solid gray;height:38px; padding-top:10px;">&nbsp;<span id="pt_{$this->html_id}"></span>
2986                     </div>
2987                 </div>
2988             </div>
2989 EOT;
2990             echo $htmlcode;
2991             flush();
2992     }
2993     /**
2994      * Update the progress bar
2995      *
2996      * @param int $percent from 1-100
2997      * @param string $msg
2998      * @param mixed $es
2999      * @return void Echo's output
3000      */
3001     private function _update($percent, $msg, $es){
3002         global $PAGE;
3003         if(empty($this->time_start)){
3004             $this->time_start = microtime(true);
3005         }
3006         $this->percent = $percent;
3007         $this->lastcall->time = microtime(true);
3008         $this->lastcall->pt   = $percent;
3009         $w = $this->percent * $this->width;
3010         if (CLI_SCRIPT) {
3011             return; // temporary solution for cli scripts
3012         }
3013         if ($es === null){
3014             $es = "Infinity";
3015         }
3016         echo html_writer::script(js_writer::function_call('update_progress_bar', Array($this->html_id, $w, $this->percent, $msg, $es)));
3017         flush();
3018     }
3019     /**
3020       * estimate time
3021       *
3022       * @param int $curtime the time call this function
3023       * @param int $percent from 1-100
3024       * @return mixed Null, or int
3025       */
3026     private function estimate($curtime, $pt){
3027         $consume = $curtime - $this->time_start;
3028         $one = $curtime - $this->lastcall->time;
3029         $this->percent = $pt;
3030         $percent = $pt - $this->lastcall->pt;
3031         if ($percent != 0) {
3032             $left = ($one / $percent) - $consume;
3033         } else {
3034             return null;
3035         }
3036         if($left < 0) {
3037             return 0;
3038         } else {
3039             return $left;
3040         }
3041     }
3042     /**
3043       * Update progress bar according percent
3044       *
3045       * @param int $percent from 1-100
3046       * @param string $msg the message needed to be shown
3047       */
3048     public function update_full($percent, $msg){
3049         $percent = max(min($percent, 100), 0);
3050         if ($percent != 100 && ($this->lastcall->time + $this->minimum_time) > microtime(true)){
3051             return;
3052         }
3053         $this->_update($percent, 100, $msg);
3054     }
3055     /**
3056       * Update progress bar according the number of tasks
3057       *
3058       * @param int $cur current task number
3059       * @param int $total total task number
3060       * @param string $msg message
3061       */
3062     public function update($cur, $total, $msg){
3063         $cur = max($cur, 0);
3064         if ($cur >= $total){
3065             $percent = 1;
3066         } else {
3067             $percent = $cur / $total;
3068         }
3069         /**
3070         if ($percent != 1 && ($this->lastcall->time + $this->minimum_time) > microtime(true)){
3071             return;
3072         }
3073         */
3074         $es = $this->estimate(microtime(true), $percent);
3075         $this->_update($percent, $msg, $es);
3076     }
3077     /**
3078      * Restart the progress bar.
3079      */
3080     public function restart(){
3081         $this->percent  = 0;
3082         $this->lastcall = new stdClass;
3083         $this->lastcall->pt = 0;
3084         $this->lastcall->time = microtime(true);
3085         $this->time_start  = 0;
3086     }
3089 /**
3090  * Use this class from long operations where you want to output occasional information about
3091  * what is going on, but don't know if, or in what format, the output should be.
3092  *
3093  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3094  * @package moodlecore
3095  */
3096 abstract class progress_trace {
3097     /**
3098      * Ouput an progress message in whatever format.
3099      * @param string $message the message to output.
3100      * @param integer $depth indent depth for this message.
3101      */
3102     abstract public function output($message, $depth = 0);
3104     /**
3105      * Called when the processing is finished.
3106      */
3107     public function finished() {
3108     }
3111 /**
3112  * This subclass of progress_trace does not ouput anything.
3113  *
3114  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3115  * @package moodlecore
3116  */
3117 class null_progress_trace extends progress_trace {
3118     /**
3119      * Does Nothing
3120      *
3121      * @param string $message
3122      * @param int $depth
3123      * @return void Does Nothing
3124      */
3125     public function output($message, $depth = 0) {
3126     }
3129 /**
3130  * This subclass of progress_trace outputs to plain text.
3131  *
3132  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3133  * @package moodlecore
3134  */
3135 class text_progress_trace extends progress_trace {
3136     /**
3137      * Output the trace message
3138      *
3139      * @param string $message
3140      * @param int $depth
3141      * @return void Output is echo'd
3142      */
3143     public function output($message, $depth = 0) {
3144         echo str_repeat('  ', $depth), $message, "\n";
3145         flush();
3146     }
3149 /**
3150  * This subclass of progress_trace outputs as HTML.
3151  *
3152  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3153  * @package moodlecore
3154  */
3155 class html_progress_trace extends progress_trace {
3156     /**
3157      * Output the trace message
3158      *
3159      * @param string $message
3160      * @param int $depth
3161      * @return void Output is echo'd
3162      */
3163     public function output($message, $depth = 0) {
3164         echo '<p>', str_repeat('&#160;&#160;', $depth), htmlspecialchars($message), "</p>\n";
3165         flush();
3166     }
3169 /**
3170  * HTML List Progress Tree
3171  *
3172  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3173  * @package moodlecore
3174  */
3175 class html_list_progress_trace extends progress_trace {
3176     /** @var int */
3177     protected $currentdepth = -1;
3179     /**
3180      * Echo out the list
3181      *
3182      * @param string $message The message to display
3183      * @param int $depth
3184      * @return void Output is echoed
3185      */
3186     public function output($message, $depth = 0) {
3187         $samedepth = true;
3188         while ($this->currentdepth > $depth) {
3189             echo "</li>\n</ul>\n";
3190             $this->currentdepth -= 1;
3191             if ($this->currentdepth == $depth) {
3192                 echo '<li>';
3193             }
3194             $samedepth = false;
3195         }
3196         while ($this->currentdepth < $depth) {
3197             echo "<ul>\n<li>";
3198             $this->currentdepth += 1;
3199             $samedepth = false;
3200         }
3201         if ($samedepth) {
3202             echo "</li>\n<li>";
3203         }
3204         echo htmlspecialchars($message);
3205         flush();
3206     }
3208     /**
3209      * Called when the processing is finished.
3210      */
3211     public function finished() {
3212         while ($this->currentdepth >= 0) {
3213             echo "</li>\n</ul>\n";
3214             $this->currentdepth -= 1;
3215         }
3216     }
3219 /**
3220  * Returns a localized sentence in the current language summarizing the current password policy
3221  *
3222  * @todo this should be handled by a function/method in the language pack library once we have a support for it
3223  * @uses $CFG
3224  * @return string
3225  */
3226 function print_password_policy() {
3227     global $CFG;
3229     $message = '';
3230     if (!empty($CFG->passwordpolicy)) {
3231         $messages = array();
3232         $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength);
3233         if (!empty($CFG->minpassworddigits)) {
3234             $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits);
3235         }
3236         if (!empty($CFG->minpasswordlower)) {
3237             $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower);
3238         }
3239         if (!empty($CFG->minpasswordupper)) {
3240             $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper);
3241         }
3242         if (!empty($CFG->minpasswordnonalphanum)) {
3243             $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3244         }
3246         $messages = join(', ', $messages); // this is ugly but we do not have anything better yet...
3247         $message = get_string('informpasswordpolicy', 'auth', $messages);
3248     }
3249     return $message;
3252 function create_ufo_inline($id, $args) {
3253     global $CFG;
3254     // must not use $PAGE, $THEME, $COURSE etc. because the result is cached!
3255     // unfortunately this ufo.js can not be cached properly because we do not have access to current $CFG either
3256     $jsoutput = html_writer::script('', $CFG->wwwroot.'/lib/ufo.js');
3257     $jsoutput .= html_writer::script(js_writer::function_call('M.util.create_UFO_object', array($id, $args)));
3258     return $jsoutput;
3261 function create_flowplayer($id, $fileurl, $type='flv', $color='#000000') {
3262     global $CFG;
3264     $playerpath = $CFG->wwwroot.'/filter/mediaplugin/'.$type.'player.swf';
3265     $jsoutput = html_writer::script('', $CFG->wwwroot.'/lib/flowplayer.js');
3267     if ($type == 'flv') {
3268         $jsoutput .= html_writer::script(js_writer::function_call('M.util.init_flvflowplayer', array($id, $playerpath, $fileurl)));
3269     } else if ($type == 'mp3') {
3270         $audioplayerpath = $CFG->wwwroot .'/filter/mediaplugin/flowplayer.audio.swf';
3271         $jsoutput .= html_writer::script(js_writer::function_call('M.util.init_mp3flowplayerplugin', array($id, $playerpath, $audioplayerpath, $fileurl, $color)));
3272     }
3274     return $jsoutput;