26568853aa94e2c4bbe3d195dfc5739f61d7d0b8
[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  * TRUSTTEXT marker - if present in text, text cleaning should be bypassed
69  */
70 define('TRUSTTEXT', '#####TRUSTTEXT#####');
72 /**
73  * A moodle_url comparison using this flag will return true if the base URLs match, params are ignored
74  */
75 define('URL_MATCH_BASE', 0);
76 /**
77  * A moodle_url comparison using this flag will return true if the base URLs match and the params of url1 are part of url2
78  */
79 define('URL_MATCH_PARAMS', 1);
80 /**
81  * A moodle_url comparison using this flag will return true if the two URLs are identical, except for the order of the params
82  */
83 define('URL_MATCH_EXACT', 2);
85 /**
86  * Allowed tags - string of html tags that can be tested against for safe html tags
87  * @global string $ALLOWED_TAGS
88  * @name $ALLOWED_TAGS
89  */
90 global $ALLOWED_TAGS;
91 $ALLOWED_TAGS =
92 '<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>';
94 /**
95  * Allowed protocols - array of protocols that are safe to use in links and so on
96  * @global string $ALLOWED_PROTOCOLS
97  * @name $ALLOWED_PROTOCOLS
98  */
99 $ALLOWED_PROTOCOLS = array('http', 'https', 'ftp', 'news', 'mailto', 'rtsp', 'teamspeak', 'gopher', 'mms',
100                            'color', 'callto', 'cursor', 'text-align', 'font-size', 'font-weight', 'font-style', 'font-family',
101                            'border', 'margin', 'padding', 'background', 'background-color', 'text-decoration');   // CSS as well to get through kses
104 /// Functions
106 /**
107  * Add quotes to HTML characters
108  *
109  * Returns $var with HTML characters (like "<", ">", etc.) properly quoted.
110  * This function is very similar to {@link p()}
111  *
112  * @todo Remove obsolete param $obsolete if not used anywhere
113  *
114  * @param string $var the string potentially containing HTML characters
115  * @param boolean $obsolete no longer used.
116  * @return string
117  */
118 function s($var, $obsolete = false) {
120     if ($var === '0' or $var === false or $var === 0) {
121         return '0';
122     }
124     return preg_replace("/&amp;(#\d+);/i", "&$1;", htmlspecialchars($var));
127 /**
128  * Add quotes to HTML characters
129  *
130  * Prints $var with HTML characters (like "<", ">", etc.) properly quoted.
131  * This function simply calls {@link s()}
132  * @see s()
133  *
134  * @todo Remove obsolete param $obsolete if not used anywhere
135  *
136  * @param string $var the string potentially containing HTML characters
137  * @param boolean $obsolete no longer used.
138  * @return string
139  */
140 function p($var, $obsolete = false) {
141     echo s($var, $obsolete);
144 /**
145  * Does proper javascript quoting.
146  *
147  * Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
148  *
149  * @param mixed $var String, Array, or Object to add slashes to
150  * @return mixed quoted result
151  */
152 function addslashes_js($var) {
153     if (is_string($var)) {
154         $var = str_replace('\\', '\\\\', $var);
155         $var = str_replace(array('\'', '"', "\n", "\r", "\0"), array('\\\'', '\\"', '\\n', '\\r', '\\0'), $var);
156         $var = str_replace('</', '<\/', $var);   // XHTML compliance
157     } else if (is_array($var)) {
158         $var = array_map('addslashes_js', $var);
159     } else if (is_object($var)) {
160         $a = get_object_vars($var);
161         foreach ($a as $key=>$value) {
162           $a[$key] = addslashes_js($value);
163         }
164         $var = (object)$a;
165     }
166     return $var;
169 /**
170  * Remove query string from url
171  *
172  * Takes in a URL and returns it without the querystring portion
173  *
174  * @param string $url the url which may have a query string attached
175  * @return string The remaining URL
176  */
177  function strip_querystring($url) {
179     if ($commapos = strpos($url, '?')) {
180         return substr($url, 0, $commapos);
181     } else {
182         return $url;
183     }
186 /**
187  * Returns the URL of the HTTP_REFERER, less the querystring portion if required
188  *
189  * @uses $_SERVER
190  * @param boolean $stripquery if true, also removes the query part of the url.
191  * @return string The resulting referer or empty string
192  */
193 function get_referer($stripquery=true) {
194     if (isset($_SERVER['HTTP_REFERER'])) {
195         if ($stripquery) {
196             return strip_querystring($_SERVER['HTTP_REFERER']);
197         } else {
198             return $_SERVER['HTTP_REFERER'];
199         }
200     } else {
201         return '';
202     }
206 /**
207  * Returns the name of the current script, WITH the querystring portion.
208  *
209  * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
210  * return different things depending on a lot of things like your OS, Web
211  * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
212  * <b>NOTE:</b> This function returns false if the global variables needed are not set.
213  *
214  * @global string
215  * @return mixed String, or false if the global variables needed are not set
216  */
217 function me() {
218     global $ME;
219     return $ME;
222 /**
223  * Returns the name of the current script, WITH the full URL.
224  *
225  * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
226  * return different things depending on a lot of things like your OS, Web
227  * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.
228  * <b>NOTE:</b> This function returns false if the global variables needed are not set.
229  *
230  * Like {@link me()} but returns a full URL
231  * @see me()
232  *
233  * @global string
234  * @return mixed String, or false if the global variables needed are not set
235  */
236 function qualified_me() {
237     global $FULLME;
238     return $FULLME;
241 /**
242  * Class for creating and manipulating urls.
243  *
244  * It can be used in moodle pages where config.php has been included without any further includes.
245  *
246  * It is useful for manipulating urls with long lists of params.
247  * One situation where it will be useful is a page which links to itself to perform various actions
248  * and / or to process form data. A moodle_url object :
249  * can be created for a page to refer to itself with all the proper get params being passed from page call to
250  * page call and methods can be used to output a url including all the params, optionally adding and overriding
251  * params and can also be used to
252  *     - output the url without any get params
253  *     - and output the params as hidden fields to be output within a form
254  *
255  * @link http://docs.moodle.org/en/Development:lib/weblib.php_moodle_url See short write up here
256  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
257  * @package moodlecore
258  */
259 class moodle_url {
260     /**
261      * Scheme, ex.: http, https
262      * @var string
263      */
264     protected $scheme = '';
265     /**
266      * hostname
267      * @var string
268      */
269     protected $host = '';
270     /**
271      * Port number, empty means default 80 or 443 in case of http
272      * @var unknown_type
273      */
274     protected $port = '';
275     /**
276      * Username for http auth
277      * @var string
278      */
279     protected $user = '';
280     /**
281      * Password for http auth
282      * @var string
283      */
284     protected $pass = '';
285     /**
286      * Script path
287      * @var string
288      */
289     protected $path = '';
290     /**
291      * Optional slash argument value
292      * @var string
293      */
294     protected $slashargument = '';
295     /**
296      * Anchor, may be also empty, null means none
297      * @var string
298      */
299     protected $anchor = null;
300     /**
301      * Url parameters as associative array
302      * @var array
303      */
304     protected $params = array(); // Associative array of query string params
306     /**
307      * Create new instance of moodle_url.
308      *
309      * @param moodle_url|string $url - moodle_url means make a copy of another
310      *      moodle_url and change parameters, string means full url or shortened
311      *      form (ex.: '/course/view.php'). It is strongly encouraged to not include
312      *      query string because it may result in double encoded values
313      * @param array $params these params override current params or add new
314      */
315     public function __construct($url, array $params = null) {
316         global $CFG;
318         if ($url instanceof moodle_url) {
319             $this->scheme = $url->scheme;
320             $this->host = $url->host;
321             $this->port = $url->port;
322             $this->user = $url->user;
323             $this->pass = $url->pass;
324             $this->path = $url->path;
325             $this->slashargument = $url->slashargument;
326             $this->params = $url->params;
327             $this->anchor = $url->anchor;
329         } else {
330             // detect if anchor used
331             $apos = strpos($url, '#');
332             if ($apos !== false) {
333                 $anchor = substr($url, $apos);
334                 $anchor = ltrim($anchor, '#');
335                 $this->set_anchor($anchor);
336                 $url = substr($url, 0, $apos);
337             }
339             // normalise shortened form of our url ex.: '/course/view.php'
340             if (strpos($url, '/') === 0) {
341                 // we must not use httpswwwroot here, because it might be url of other page,
342                 // devs have to use httpswwwroot explicitly when creating new moodle_url
343                 $url = $CFG->wwwroot.$url;
344             }
346             // now fix the admin links if needed, no need to mess with httpswwwroot
347             if ($CFG->admin !== 'admin') {
348                 if (strpos($url, "$CFG->wwwroot/admin/") === 0) {
349                     $url = str_replace("$CFG->wwwroot/admin/", "$CFG->wwwroot/$CFG->admin/", $url);
350                 }
351             }
353             // parse the $url
354             $parts = parse_url($url);
355             if ($parts === false) {
356                 throw new moodle_exception('invalidurl');
357             }
358             if (isset($parts['query'])) {
359                 // note: the values may not be correctly decoded,
360                 //       url parameters should be always passed as array
361                 parse_str(str_replace('&amp;', '&', $parts['query']), $this->params);
362             }
363             unset($parts['query']);
364             foreach ($parts as $key => $value) {
365                 $this->$key = $value;
366             }
368             // detect slashargument value from path - we do not support directory names ending with .php
369             $pos = strpos($this->path, '.php/');
370             if ($pos !== false) {
371                 $this->slashargument = substr($this->path, $pos + 4);
372                 $this->path = substr($this->path, 0, $pos + 4);
373             }
374         }
376         $this->params($params);
377     }
379     /**
380      * Add an array of params to the params for this url.
381      *
382      * The added params override existing ones if they have the same name.
383      *
384      * @param array $params Defaults to null. If null then returns all params.
385      * @return array Array of Params for url.
386      */
387     public function params(array $params = null) {
388         $params = (array)$params;
390         foreach ($params as $key=>$value) {
391             if (is_int($key)) {
392                 throw new coding_exception('Url parameters can not have numeric keys!');
393             }
394             if (is_array($value)) {
395                 throw new coding_exception('Url parameters values can not be arrays!');
396             }
397             if (is_object($value) and !method_exists($value, '__toString')) {
398                 throw new coding_exception('Url parameters values can not be objects, unless __toString() is defined!');
399             }
400             $this->params[$key] = (string)$value;
401         }
402         return $this->params;
403     }
405     /**
406      * Remove all params if no arguments passed.
407      * Remove selected params if arguments are passed.
408      *
409      * Can be called as either remove_params('param1', 'param2')
410      * or remove_params(array('param1', 'param2')).
411      *
412      * @param mixed $params either an array of param names, or a string param name,
413      * @param string $params,... any number of additional param names.
414      * @return array url parameters
415      */
416     public function remove_params($params = null) {
417         if (!is_array($params)) {
418             $params = func_get_args();
419         }
420         foreach ($params as $param) {
421             unset($this->params[$param]);
422         }
423         return $this->params;
424     }
426     /**
427      * Remove all url parameters
428      * @param $params
429      * @return void
430      */
431     public function remove_all_params($params = null) {
432         $this->params = array();
433         $this->slashargument = '';
434     }
436     /**
437      * Add a param to the params for this url.
438      *
439      * The added param overrides existing one if they have the same name.
440      *
441      * @param string $paramname name
442      * @param string $newvalue Param value. If new value specified current value is overriden or parameter is added
443      * @return mixed string parameter value, null if parameter does not exist
444      */
445     public function param($paramname, $newvalue = '') {
446         if (func_num_args() > 1) {
447             // set new value
448             $this->params(array($paramname=>$newvalue));
449         }
450         if (isset($this->params[$paramname])) {
451             return $this->params[$paramname];
452         } else {
453             return null;
454         }
455     }
457     /**
458      * Merges parameters and validates them
459      * @param array $overrideparams
460      * @return array merged parameters
461      */
462     protected function merge_overrideparams(array $overrideparams = null) {
463         $overrideparams = (array)$overrideparams;
464         $params = $this->params;
465         foreach ($overrideparams as $key=>$value) {
466             if (is_int($key)) {
467                 throw new coding_exception('Overridden parameters can not have numeric keys!');
468             }
469             if (is_array($value)) {
470                 throw new coding_exception('Overridden parameters values can not be arrays!');
471             }
472             if (is_object($value) and !method_exists($value, '__toString')) {
473                 throw new coding_exception('Overridden parameters values can not be objects, unless __toString() is defined!');
474             }
475             $params[$key] = (string)$value;
476         }
477         return $params;
478     }
480     /**
481      * Get the params as as a query string.
482      * This method should not be used outside of this method.
483      *
484      * @param boolean $escaped Use &amp; as params separator instead of plain &
485      * @param array $overrideparams params to add to the output params, these
486      *      override existing ones with the same name.
487      * @return string query string that can be added to a url.
488      */
489     public function get_query_string($escaped = true, array $overrideparams = null) {
490         $arr = array();
491         $params = $this->merge_overrideparams($overrideparams);
492         foreach ($params as $key => $val) {
493            $arr[] = rawurlencode($key)."=".rawurlencode($val);
494         }
495         if ($escaped) {
496             return implode('&amp;', $arr);
497         } else {
498             return implode('&', $arr);
499         }
500     }
502     /**
503      * Shortcut for printing of encoded URL.
504      * @return string
505      */
506     public function __toString() {
507         return $this->out(true);
508     }
510     /**
511      * Output url
512      *
513      * If you use the returned URL in HTML code, you want the escaped ampersands. If you use
514      * the returned URL in HTTP headers, you want $escaped=false.
515      *
516      * @param boolean $escaped Use &amp; as params separator instead of plain &
517      * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
518      * @return string Resulting URL
519      */
520     public function out($escaped = true, array $overrideparams = null) {
521         if (!is_bool($escaped)) {
522             debugging('Escape parameter must be of type boolean, '.gettype($escaped).' given instead.');
523         }
525         $uri = $this->out_omit_querystring().$this->slashargument;
527         $querystring = $this->get_query_string($escaped, $overrideparams);
528         if ($querystring !== '') {
529             $uri .= '?' . $querystring;
530         }
531         if (!is_null($this->anchor)) {
532             $uri .= '#'.$this->anchor;
533         }
535         return $uri;
536     }
538     /**
539      * Returns url without parameters, everything before '?'.
540      * @return string
541      */
542     public function out_omit_querystring() {
543         $uri = $this->scheme ? $this->scheme.':'.((strtolower($this->scheme) == 'mailto') ? '':'//'): '';
544         $uri .= $this->user ? $this->user.($this->pass? ':'.$this->pass:'').'@':'';
545         $uri .= $this->host ? $this->host : '';
546         $uri .= $this->port ? ':'.$this->port : '';
547         $uri .= $this->path ? $this->path : '';
548         return $uri;
549     }
551     /**
552      * Compares this moodle_url with another
553      * See documentation of constants for an explanation of the comparison flags.
554      * @param moodle_url $url The moodle_url object to compare
555      * @param int $matchtype The type of comparison (URL_MATCH_BASE, URL_MATCH_PARAMS, URL_MATCH_EXACT)
556      * @return boolean
557      */
558     public function compare(moodle_url $url, $matchtype = URL_MATCH_EXACT) {
560         $baseself = $this->out_omit_querystring();
561         $baseother = $url->out_omit_querystring();
563         // Append index.php if there is no specific file
564         if (substr($baseself,-1)=='/') {
565             $baseself .= 'index.php';
566         }
567         if (substr($baseother,-1)=='/') {
568             $baseother .= 'index.php';
569         }
571         // Compare the two base URLs
572         if ($baseself != $baseother) {
573             return false;
574         }
576         if ($matchtype == URL_MATCH_BASE) {
577             return true;
578         }
580         $urlparams = $url->params();
581         foreach ($this->params() as $param => $value) {
582             if ($param == 'sesskey') {
583                 continue;
584             }
585             if (!array_key_exists($param, $urlparams) || $urlparams[$param] != $value) {
586                 return false;
587             }
588         }
590         if ($matchtype == URL_MATCH_PARAMS) {
591             return true;
592         }
594         foreach ($urlparams as $param => $value) {
595             if ($param == 'sesskey') {
596                 continue;
597             }
598             if (!array_key_exists($param, $this->params()) || $this->param($param) != $value) {
599                 return false;
600             }
601         }
603         return true;
604     }
606     /**
607      * Sets the anchor for the URI (the bit after the hash)
608      * @param string $anchor null means remove previous
609      */
610     public function set_anchor($anchor) {
611         if (is_null($anchor)) {
612             // remove
613             $this->anchor = null;
614         } else if ($anchor === '') {
615             // special case, used as empty link
616             $this->anchor = '';
617         } else if (preg_match('|[a-zA-Z\_\:][a-zA-Z0-9\_\-\.\:]*|', $anchor)) {
618             // Match the anchor against the NMTOKEN spec
619             $this->anchor = $anchor;
620         } else {
621             // bad luck, no valid anchor found
622             $this->anchor = null;
623         }
624     }
626     /**
627      * Sets the url slashargument value
628      * @param string $path usually file path
629      * @param string $parameter name of page parameter if slasharguments not supported
630      * @param bool $supported usually null, then it depends on $CFG->slasharguments, use true or false for other servers
631      * @return void
632      */
633     public function set_slashargument($path, $parameter = 'file', $supported = NULL) {
634         global $CFG;
635         if (is_null($supported)) {
636             $supported = $CFG->slasharguments;
637         }
639         if ($supported) {
640             $parts = explode('/', $path);
641             $parts = array_map('rawurlencode', $parts);
642             $path  = implode('/', $parts);
643             $this->slashargument = $path;
644             unset($this->params[$parameter]);
646         } else {
647             $this->slashargument = '';
648             $this->params[$parameter] = $path;
649         }
650     }
652     // == static factory methods ==
654     /**
655      * General moodle file url.
656      * @param string $urlbase the script serving the file
657      * @param string $path
658      * @param bool $forcedownload
659      * @return moodle_url
660      */
661     public static function make_file_url($urlbase, $path, $forcedownload = false) {
662         global $CFG;
664         $params = array();
665         if ($forcedownload) {
666             $params['forcedownload'] = 1;
667         }
669         $url = new moodle_url($urlbase, $params);
670         $url->set_slashargument($path);
672         return $url;
673     }
675     /**
676      * Factory method for creation of url pointing to plugin file.
677      * Please note this method can be used only from the plugins to
678      * create urls of own files, it must not be used outside of plugins!
679      * @param int $contextid
680      * @param string $component
681      * @param string $area
682      * @param int $itemid
683      * @param string $pathname
684      * @param string $filename
685      * @param bool $forcedownload
686      * @return moodle_url
687      */
688     public static function make_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename, $forcedownload = false) {
689         global $CFG;
690         $urlbase = "$CFG->httpswwwroot/pluginfile.php";
691         if ($itemid === NULL) {
692             return self::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
693         } else {
694             return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
695         }
696     }
698     /**
699      * Factory method for creation of url pointing to draft
700      * file of current user.
701      * @param int $draftid draft item id
702      * @param string $pathname
703      * @param string $filename
704      * @param bool $forcedownload
705      * @return moodle_url
706      */
707     public static function make_draftfile_url($draftid, $pathname, $filename, $forcedownload = false) {
708         global $CFG, $USER;
709         $urlbase = "$CFG->httpswwwroot/draftfile.php";
710         $context = get_context_instance(CONTEXT_USER, $USER->id);
712         return self::make_file_url($urlbase, "/$context->id/user/draft/$draftid".$pathname.$filename, $forcedownload);
713     }
715     /**
716      * Factory method for creating of links to legacy
717      * course files.
718      * @param int $courseid
719      * @param string $filepath
720      * @param bool $forcedownload
721      * @return moodle_url
722      */
723     public static function make_legacyfile_url($courseid, $filepath, $forcedownload = false) {
724         global $CFG;
726         $urlbase = "$CFG->wwwroot/file.php";
727         return self::make_file_url($urlbase, '/'.$courseid.'/'.$filepath, $forcedownload);
728     }
731 /**
732  * Determine if there is data waiting to be processed from a form
733  *
734  * Used on most forms in Moodle to check for data
735  * Returns the data as an object, if it's found.
736  * This object can be used in foreach loops without
737  * casting because it's cast to (array) automatically
738  *
739  * Checks that submitted POST data exists and returns it as object.
740  *
741  * @uses $_POST
742  * @return mixed false or object
743  */
744 function data_submitted() {
746     if (empty($_POST)) {
747         return false;
748     } else {
749         return (object)$_POST;
750     }
753 /**
754  * Given some normal text this function will break up any
755  * long words to a given size by inserting the given character
756  *
757  * It's multibyte savvy and doesn't change anything inside html tags.
758  *
759  * @param string $string the string to be modified
760  * @param int $maxsize maximum length of the string to be returned
761  * @param string $cutchar the string used to represent word breaks
762  * @return string
763  */
764 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
766 /// Loading the textlib singleton instance. We are going to need it.
767     $textlib = textlib_get_instance();
769 /// First of all, save all the tags inside the text to skip them
770     $tags = array();
771     filter_save_tags($string,$tags);
773 /// Process the string adding the cut when necessary
774     $output = '';
775     $length = $textlib->strlen($string);
776     $wordlength = 0;
778     for ($i=0; $i<$length; $i++) {
779         $char = $textlib->substr($string, $i, 1);
780         if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
781             $wordlength = 0;
782         } else {
783             $wordlength++;
784             if ($wordlength > $maxsize) {
785                 $output .= $cutchar;
786                 $wordlength = 0;
787             }
788         }
789         $output .= $char;
790     }
792 /// Finally load the tags back again
793     if (!empty($tags)) {
794         $output = str_replace(array_keys($tags), $tags, $output);
795     }
797     return $output;
800 /**
801  * Try and close the current window using JavaScript, either immediately, or after a delay.
802  *
803  * Echo's out the resulting XHTML & javascript
804  *
805  * @global object
806  * @global object
807  * @param integer $delay a delay in seconds before closing the window. Default 0.
808  * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
809  *      to reload the parent window before this one closes.
810  */
811 function close_window($delay = 0, $reloadopener = false) {
812     global $PAGE, $OUTPUT;
814     if (!$PAGE->headerprinted) {
815         $PAGE->set_title(get_string('closewindow'));
816         echo $OUTPUT->header();
817     } else {
818         $OUTPUT->container_end_all(false);
819     }
821     if ($reloadopener) {
822         $function = 'close_window_reloading_opener';
823     } else {
824         $function = 'close_window';
825     }
826     echo '<p class="centerpara">' . get_string('windowclosing') . '</p>';
828     $PAGE->requires->js_function_call($function, null, false, $delay);
830     echo $OUTPUT->footer();
831     exit;
834 /**
835  * Returns a string containing a link to the user documentation for the current
836  * page. Also contains an icon by default. Shown to teachers and admin only.
837  *
838  * @global object
839  * @global object
840  * @param string $text The text to be displayed for the link
841  * @param string $iconpath The path to the icon to be displayed
842  * @return string The link to user documentation for this current page
843  */
844 function page_doc_link($text='') {
845     global $CFG, $PAGE, $OUTPUT;
847     if (empty($CFG->docroot) || during_initial_install()) {
848         return '';
849     }
850     if (!has_capability('moodle/site:doclinks', $PAGE->context)) {
851         return '';
852     }
854     $path = $PAGE->docspath;
855     if (!$path) {
856         return '';
857     }
858     return $OUTPUT->doc_link($path, $text);
862 /**
863  * Validates an email to make sure it makes sense.
864  *
865  * @param string $address The email address to validate.
866  * @return boolean
867  */
868 function validate_email($address) {
870     return (preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
871                  '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
872                   '@'.
873                   '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
874                   '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
875                   $address));
878 /**
879  * Extracts file argument either from file parameter or PATH_INFO
880  * Note: $scriptname parameter is not needed anymore
881  *
882  * @global string
883  * @uses $_SERVER
884  * @uses PARAM_PATH
885  * @return string file path (only safe characters)
886  */
887 function get_file_argument() {
888     global $SCRIPT;
890     $relativepath = optional_param('file', FALSE, PARAM_PATH);
892     // then try extract file from PATH_INFO (slasharguments method)
893     if ($relativepath === false and isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
894         // check that PATH_INFO works == must not contain the script name
895         if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
896             $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
897         }
898     }
900     // note: we are not using any other way because they are not compatible with unicode file names ;-)
902     return $relativepath;
905 /**
906  * Just returns an array of text formats suitable for a popup menu
907  *
908  * @uses FORMAT_MOODLE
909  * @uses FORMAT_HTML
910  * @uses FORMAT_PLAIN
911  * @uses FORMAT_MARKDOWN
912  * @return array
913  */
914 function format_text_menu() {
915     return array (FORMAT_MOODLE => get_string('formattext'),
916                   FORMAT_HTML   => get_string('formathtml'),
917                   FORMAT_PLAIN  => get_string('formatplain'),
918                   FORMAT_MARKDOWN  => get_string('formatmarkdown'));
921 /**
922  * Given text in a variety of format codings, this function returns
923  * the text as safe HTML.
924  *
925  * This function should mainly be used for long strings like posts,
926  * answers, glossary items etc. For short strings @see format_string().
927  *
928  * @todo Finish documenting this function
929  *
930  * @staticvar array $croncache
931  * @param string $text The text to be formatted. This is raw text originally from user input.
932  * @param int $format Identifier of the text format to be used
933  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
934  * @param object/array $options text formatting options
935  * @param int $courseid_do_not_use deprecated course id, use context option instead
936  * @return string
937  */
938 function format_text($text, $format = FORMAT_MOODLE, $options = NULL, $courseid_do_not_use = NULL) {
939     global $CFG, $COURSE, $DB, $PAGE;
941     static $croncache = array();
943     if ($text === '') {
944         return ''; // no need to do any filters and cleaning
945     }
947     $options = (array)$options; // detach object, we can not modify it
950     if (!isset($options['trusted'])) {
951         $options['trusted'] = false;
952     }
953     if (!isset($options['noclean'])) {
954         if ($options['trusted'] and trusttext_active()) {
955             // no cleaning if text trusted and noclean not specified
956             $options['noclean'] = true;
957         } else {
958             $options['noclean'] = false;
959         }
960     }
961     if (!isset($options['nocache'])) {
962         $options['nocache'] = false;
963     }
964     if (!isset($options['smiley'])) {
965         $options['smiley'] = true;
966     }
967     if (!isset($options['filter'])) {
968         $options['filter'] = true;
969     }
970     if (!isset($options['para'])) {
971         $options['para'] = true;
972     }
973     if (!isset($options['newlines'])) {
974         $options['newlines'] = true;
975     }
977     // Calculate best context
978     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
979         // do not filter anything during installation or before upgrade completes
980         $context = null;
982     } else if (isset($options['context'])) { // first by explicit passed context option
983         if (is_object($options['context'])) {
984             $context = $options['context'];
985         } else {
986             $context = get_context_instance_by_id($context);
987         }
988     } else if ($courseid_do_not_use) {
989         // legacy courseid
990         $context = get_context_instance(CONTEXT_COURSE, $courseid_do_not_use);
991     } else {
992         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
993         $context = $PAGE->context;
994     }
996     if (!$context) {
997         // either install/upgrade or something has gone really wrong because context does not exist (yet?)
998         $options['nocache'] = true;
999         $options['filter']  = false;
1000     }
1002     if ($options['filter']) {
1003         $filtermanager = filter_manager::instance();
1004     } else {
1005         $filtermanager = new null_filter_manager();
1006     }
1008     if (!empty($CFG->cachetext) and empty($options['nocache'])) {
1009         $hashstr = $text.'-'.$filtermanager->text_filtering_hash($context).'-'.$context->id.'-'.current_language().'-'.
1010                 (int)$format.(int)$options['trusted'].(int)$options['noclean'].(int)$options['smiley'].
1011                 (int)$options['para'].(int)$options['newlines'];
1013         $time = time() - $CFG->cachetext;
1014         $md5key = md5($hashstr);
1015         if (CLI_SCRIPT) {
1016             if (isset($croncache[$md5key])) {
1017                 return $croncache[$md5key];
1018             }
1019         }
1021         if ($oldcacheitem = $DB->get_record('cache_text', array('md5key'=>$md5key), '*', IGNORE_MULTIPLE)) {
1022             if ($oldcacheitem->timemodified >= $time) {
1023                 if (CLI_SCRIPT) {
1024                     if (count($croncache) > 150) {
1025                         reset($croncache);
1026                         $key = key($croncache);
1027                         unset($croncache[$key]);
1028                     }
1029                     $croncache[$md5key] = $oldcacheitem->formattedtext;
1030                 }
1031                 return $oldcacheitem->formattedtext;
1032             }
1033         }
1034     }
1036     switch ($format) {
1037         case FORMAT_HTML:
1038             if ($options['smiley']) {
1039                 replace_smilies($text);
1040             }
1041             if (!$options['noclean']) {
1042                 $text = clean_text($text, FORMAT_HTML);
1043             }
1044             $text = $filtermanager->filter_text($text, $context);
1045             break;
1047         case FORMAT_PLAIN:
1048             $text = s($text); // cleans dangerous JS
1049             $text = rebuildnolinktag($text);
1050             $text = str_replace('  ', '&nbsp; ', $text);
1051             $text = nl2br($text);
1052             break;
1054         case FORMAT_WIKI:
1055             // this format is deprecated
1056             $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle.  You should not be seeing
1057                      this message as all texts should have been converted to Markdown format instead.
1058                      Please post a bug report to http://moodle.org/bugs with information about where you
1059                      saw this message.</p>'.s($text);
1060             break;
1062         case FORMAT_MARKDOWN:
1063             $text = markdown_to_html($text);
1064             if ($options['smiley']) {
1065                 replace_smilies($text);
1066             }
1067             if (!$options['noclean']) {
1068                 $text = clean_text($text, FORMAT_HTML);
1069             }
1070             $text = $filtermanager->filter_text($text, $context);
1071             break;
1073         default:  // FORMAT_MOODLE or anything else
1074             $text = text_to_html($text, $options['smiley'], $options['para'], $options['newlines']);
1075             if (!$options['noclean']) {
1076                 $text = clean_text($text, FORMAT_HTML);
1077             }
1078             $text = $filtermanager->filter_text($text, $context);
1079             break;
1080     }
1082     // Warn people that we have removed this old mechanism, just in case they
1083     // were stupid enough to rely on it.
1084     if (isset($CFG->currenttextiscacheable)) {
1085         debugging('Once upon a time, Moodle had a truly evil use of global variables ' .
1086                 'called $CFG->currenttextiscacheable. The good news is that this no ' .
1087                 'longer exists. The bad news is that you seem to be using a filter that '.
1088                 'relies on it. Please seek out and destroy that filter code.', DEBUG_DEVELOPER);
1089     }
1091     if (empty($options['nocache']) and !empty($CFG->cachetext)) {
1092         if (CLI_SCRIPT) {
1093             // special static cron cache - no need to store it in db if its not already there
1094             if (count($croncache) > 150) {
1095                 reset($croncache);
1096                 $key = key($croncache);
1097                 unset($croncache[$key]);
1098             }
1099             $croncache[$md5key] = $text;
1100             return $text;
1101         }
1103         $newcacheitem = new object();
1104         $newcacheitem->md5key = $md5key;
1105         $newcacheitem->formattedtext = $text;
1106         $newcacheitem->timemodified = time();
1107         if ($oldcacheitem) {                               // See bug 4677 for discussion
1108             $newcacheitem->id = $oldcacheitem->id;
1109             try {
1110                 $DB->update_record('cache_text', $newcacheitem);   // Update existing record in the cache table
1111             } catch (dml_exception $e) {
1112                // It's unlikely that the cron cache cleaner could have
1113                // deleted this entry in the meantime, as it allows
1114                // some extra time to cover these cases.
1115             }
1116         } else {
1117             try {
1118                 $DB->insert_record('cache_text', $newcacheitem);   // Insert a new record in the cache table
1119             } catch (dml_exception $e) {
1120                // Again, it's possible that another user has caused this
1121                // record to be created already in the time that it took
1122                // to traverse this function.  That's OK too, as the
1123                // call above handles duplicate entries, and eventually
1124                // the cron cleaner will delete them.
1125             }
1126         }
1127     }
1129     return $text;
1132 /**
1133  * Converts the text format from the value to the 'internal'
1134  * name or vice versa.
1135  *
1136  * $key can either be the value or the name and you get the other back.
1137  *
1138  * @uses FORMAT_MOODLE
1139  * @uses FORMAT_HTML
1140  * @uses FORMAT_PLAIN
1141  * @uses FORMAT_MARKDOWN
1142  * @param mixed $key int 0-4 or string one of 'moodle','html','plain','markdown'
1143  * @return mixed as above but the other way around!
1144  */
1145 function text_format_name($key) {
1146   $lookup = array();
1147   $lookup[FORMAT_MOODLE] = 'moodle';
1148   $lookup[FORMAT_HTML] = 'html';
1149   $lookup[FORMAT_PLAIN] = 'plain';
1150   $lookup[FORMAT_MARKDOWN] = 'markdown';
1151   $value = "error";
1152   if (!is_numeric($key)) {
1153     $key = strtolower( $key );
1154     $value = array_search( $key, $lookup );
1155   }
1156   else {
1157     if (isset( $lookup[$key] )) {
1158       $value =  $lookup[ $key ];
1159     }
1160   }
1161   return $value;
1164 /**
1165  * Resets all data related to filters, called during upgrade or when filter settings change.
1166  *
1167  * @global object
1168  * @global object
1169  * @return void
1170  */
1171 function reset_text_filters_cache() {
1172     global $CFG, $DB;
1174     $DB->delete_records('cache_text');
1175     $purifdir = $CFG->dataroot.'/cache/htmlpurifier';
1176     remove_dir($purifdir, true);
1179 /**
1180  * Given a simple string, this function returns the string
1181  * processed by enabled string filters if $CFG->filterall is enabled
1182  *
1183  * This function should be used to print short strings (non html) that
1184  * need filter processing e.g. activity titles, post subjects,
1185  * glossary concepts.
1186  *
1187  * @global object
1188  * @global object
1189  * @global object
1190  * @staticvar bool $strcache
1191  * @param string $string The string to be filtered.
1192  * @param boolean $striplinks To strip any link in the result text.
1193                               Moodle 1.8 default changed from false to true! MDL-8713
1194  * @param array $options options array/object or courseid
1195  * @return string
1196  */
1197 function format_string($string, $striplinks = true, $options = NULL) {
1198     global $CFG, $COURSE, $PAGE;
1200     //We'll use a in-memory cache here to speed up repeated strings
1201     static $strcache = false;
1203     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
1204         // do not filter anything during installation or before upgrade completes
1205         return $string = strip_tags($string);
1206     }
1208     if ($strcache === false or count($strcache) > 2000) { // this number might need some tuning to limit memory usage in cron
1209         $strcache = array();
1210     }
1212     if (is_numeric($options)) {
1213         // legacy courseid usage
1214         $options  = array('context'=>get_context_instance(CONTEXT_COURSE, $options));
1215     } else {
1216         $options = (array)$options; // detach object, we can not modify it
1217     }
1219     if (empty($options['context'])) {
1220         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1221         $options['context'] = $PAGE->context;
1222     } else if (is_numeric($options['context'])) {
1223         $options['context'] = get_context_instance_by_id($options['context']);
1224     }
1226     if (!$options['context']) {
1227         // we did not find any context? weird
1228         return $string = strip_tags($string);
1229     }
1231     //Calculate md5
1232     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id.'<+>'.current_language());
1234     //Fetch from cache if possible
1235     if (isset($strcache[$md5])) {
1236         return $strcache[$md5];
1237     }
1239     // First replace all ampersands not followed by html entity code
1240     // Regular expression moved to its own method for easier unit testing
1241     $string = replace_ampersands_not_followed_by_entity($string);
1243     if (!empty($CFG->filterall)) {
1244         $string = filter_manager::instance()->filter_string($string, $options['context']);
1245     }
1247     // If the site requires it, strip ALL tags from this string
1248     if (!empty($CFG->formatstringstriptags)) {
1249         $string = strip_tags($string);
1251     } else {
1252         // Otherwise strip just links if that is required (default)
1253         if ($striplinks) {  //strip links in string
1254             $string = strip_links($string);
1255         }
1256         $string = clean_text($string);
1257     }
1259     //Store to cache
1260     $strcache[$md5] = $string;
1262     return $string;
1265 /**
1266  * Given a string, performs a negative lookahead looking for any ampersand character
1267  * that is not followed by a proper HTML entity. If any is found, it is replaced
1268  * by &amp;. The string is then returned.
1269  *
1270  * @param string $string
1271  * @return string
1272  */
1273 function replace_ampersands_not_followed_by_entity($string) {
1274     return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1277 /**
1278  * Given a string, replaces all <a>.*</a> by .* and returns the string.
1279  *
1280  * @param string $string
1281  * @return string
1282  */
1283 function strip_links($string) {
1284     return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is','$2',$string);
1287 /**
1288  * This expression turns links into something nice in a text format. (Russell Jungwirth)
1289  *
1290  * @param string $string
1291  * @return string
1292  */
1293 function wikify_links($string) {
1294     return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i','$3 [ $2 ]', $string);
1297 /**
1298  * Replaces non-standard HTML entities
1299  *
1300  * @param string $string
1301  * @return string
1302  */
1303 function fix_non_standard_entities($string) {
1304     $text = preg_replace('/&#0*([0-9]+);?/', '&#$1;', $string);
1305     $text = preg_replace('/&#x0*([0-9a-fA-F]+);?/', '&#x$1;', $text);
1306     return $text;
1309 /**
1310  * Given text in a variety of format codings, this function returns
1311  * the text as plain text suitable for plain email.
1312  *
1313  * @uses FORMAT_MOODLE
1314  * @uses FORMAT_HTML
1315  * @uses FORMAT_PLAIN
1316  * @uses FORMAT_WIKI
1317  * @uses FORMAT_MARKDOWN
1318  * @param string $text The text to be formatted. This is raw text originally from user input.
1319  * @param int $format Identifier of the text format to be used
1320  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1321  * @return string
1322  */
1323 function format_text_email($text, $format) {
1325     switch ($format) {
1327         case FORMAT_PLAIN:
1328             return $text;
1329             break;
1331         case FORMAT_WIKI:
1332             // there should not be any of these any more!
1333             $text = wikify_links($text);
1334             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1335             break;
1337         case FORMAT_HTML:
1338             return html_to_text($text);
1339             break;
1341         case FORMAT_MOODLE:
1342         case FORMAT_MARKDOWN:
1343         default:
1344             $text = wikify_links($text);
1345             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1346             break;
1347     }
1350 /**
1351  * Formats activity intro text
1352  *
1353  * @global object
1354  * @uses CONTEXT_MODULE
1355  * @param string $module name of module
1356  * @param object $activity instance of activity
1357  * @param int $cmid course module id
1358  * @param bool $filter filter resulting html text
1359  * @return text
1360  */
1361 function format_module_intro($module, $activity, $cmid, $filter=true) {
1362     global $CFG;
1363     require_once("$CFG->libdir/filelib.php");
1364     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1365     $options = (object)array('noclean'=>true, 'para'=>false, 'filter'=>$filter, 'context'=>$context);
1366     $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, 'mod_'.$module, 'intro', null);
1367     return trim(format_text($intro, $activity->introformat, $options, null));
1370 /**
1371  * Legacy function, used for cleaning of old forum and glossary text only.
1372  *
1373  * @global object
1374  * @param string $text text that may contain TRUSTTEXT marker
1375  * @return text without any TRUSTTEXT marker
1376  */
1377 function trusttext_strip($text) {
1378     global $CFG;
1380     while (true) { //removing nested TRUSTTEXT
1381         $orig = $text;
1382         $text = str_replace('#####TRUSTTEXT#####', '', $text);
1383         if (strcmp($orig, $text) === 0) {
1384             return $text;
1385         }
1386     }
1389 /**
1390  * Must be called before editing of all texts
1391  * with trust flag. Removes all XSS nasties
1392  * from texts stored in database if needed.
1393  *
1394  * @param object $object data object with xxx, xxxformat and xxxtrust fields
1395  * @param string $field name of text field
1396  * @param object $context active context
1397  * @return object updated $object
1398  */
1399 function trusttext_pre_edit($object, $field, $context) {
1400     $trustfield  = $field.'trust';
1401     $formatfield = $field.'format';
1403     if (!$object->$trustfield or !trusttext_trusted($context)) {
1404         $object->$field = clean_text($object->$field, $object->$formatfield);
1405     }
1407     return $object;
1410 /**
1411  * Is current user trusted to enter no dangerous XSS in this context?
1412  *
1413  * Please note the user must be in fact trusted everywhere on this server!!
1414  *
1415  * @param object $context
1416  * @return bool true if user trusted
1417  */
1418 function trusttext_trusted($context) {
1419     return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1422 /**
1423  * Is trusttext feature active?
1424  *
1425  * @global object
1426  * @param object $context
1427  * @return bool
1428  */
1429 function trusttext_active() {
1430     global $CFG;
1432     return !empty($CFG->enabletrusttext);
1435 /**
1436  * Given raw text (eg typed in by a user), this function cleans it up
1437  * and removes any nasty tags that could mess up Moodle pages.
1438  *
1439  * @global string
1440  * @global object
1441  * @param string $text The text to be cleaned
1442  * @param int $format Identifier of the text format to be used
1443  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1444  * @return string The cleaned up text
1445  */
1446 function clean_text($text, $format = FORMAT_MOODLE) {
1447     global $ALLOWED_TAGS, $CFG;
1449     if (empty($text) or is_numeric($text)) {
1450        return (string)$text;
1451     }
1453     switch ($format) {
1454         case FORMAT_PLAIN:
1455         case FORMAT_MARKDOWN:
1456             return $text;
1458         default:
1460             if (!empty($CFG->enablehtmlpurifier)) {
1461                 $text = purify_html($text);
1462             } else {
1463             /// Fix non standard entity notations
1464                 $text = fix_non_standard_entities($text);
1466             /// Remove tags that are not allowed
1467                 $text = strip_tags($text, $ALLOWED_TAGS);
1469             /// Clean up embedded scripts and , using kses
1470                 $text = cleanAttributes($text);
1472             /// Again remove tags that are not allowed
1473                 $text = strip_tags($text, $ALLOWED_TAGS);
1475             }
1477         /// Remove potential script events - some extra protection for undiscovered bugs in our code
1478             $text = preg_replace("~([^a-z])language([[:space:]]*)=~i", "$1Xlanguage=", $text);
1479             $text = preg_replace("~([^a-z])on([a-z]+)([[:space:]]*)=~i", "$1Xon$2=", $text);
1481             return $text;
1482     }
1485 /**
1486  * KSES replacement cleaning function - uses HTML Purifier.
1487  *
1488  * @global object
1489  * @param string $text The (X)HTML string to purify
1490  */
1491 function purify_html($text) {
1492     global $CFG;
1494     // this can not be done only once because we sometimes need to reset the cache
1495     $cachedir = $CFG->dataroot.'/cache/htmlpurifier';
1496     check_dir_exists($cachedir);
1498     static $purifier = false;
1499     if ($purifier === false) {
1500         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1501         $config = HTMLPurifier_Config::createDefault();
1503         $config->set('HTML.DefinitionID', 'moodlehtml');
1504         $config->set('HTML.DefinitionRev', 1);
1505         $config->set('Cache.SerializerPath', $cachedir);
1506         //$config->set('Cache.SerializerPermission', $CFG->directorypermissions); // it would be nice to get this upstream
1507         $config->set('Core.NormalizeNewlines', false);
1508         $config->set('Core.ConvertDocumentToFragment', true);
1509         $config->set('Core.Encoding', 'UTF-8');
1510         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1511         $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));
1512         $config->set('Attr.AllowedFrameTargets', array('_blank'));
1514         $def = $config->getHTMLDefinition(true);
1515         $def->addElement('nolink', 'Block', 'Flow', array());                       // skip our filters inside
1516         $def->addElement('tex', 'Inline', 'Inline', array());                       // tex syntax, equivalent to $$xx$$
1517         $def->addElement('algebra', 'Inline', 'Inline', array());                   // algebra syntax, equivalent to @@xx@@
1518         $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // old anf future style multilang - only our hacked lang attribute
1519         $def->addAttribute('span', 'xxxlang', 'CDATA');                             // current problematic multilang
1521         $purifier = new HTMLPurifier($config);
1522     }
1524     $multilang = (strpos($text, 'class="multilang"') !== false);
1526     if ($multilang) {
1527         $text = preg_replace('/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/', '<span xxxlang="${2}">', $text);
1528     }
1529     $text = $purifier->purify($text);
1530     if ($multilang) {
1531         $text = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $text);
1532     }
1534     return $text;
1537 /**
1538  * This function takes a string and examines it for HTML tags.
1539  *
1540  * If tags are detected it passes the string to a helper function {@link cleanAttributes2()}
1541  * which checks for attributes and filters them for malicious content
1542  *
1543  * @param string $str The string to be examined for html tags
1544  * @return string
1545  */
1546 function cleanAttributes($str){
1547     $result = preg_replace_callback(
1548             '%(<[^>]*(>|$)|>)%m', #search for html tags
1549             "cleanAttributes2",
1550             $str
1551             );
1552     return  $result;
1555 /**
1556  * This function takes a string with an html tag and strips out any unallowed
1557  * protocols e.g. javascript:
1558  *
1559  * It calls ancillary functions in kses which are prefixed by kses
1560  *
1561  * @global object
1562  * @global string
1563  * @param array $htmlArray An array from {@link cleanAttributes()}, containing in its 1st
1564  *              element the html to be cleared
1565  * @return string
1566  */
1567 function cleanAttributes2($htmlArray){
1569     global $CFG, $ALLOWED_PROTOCOLS;
1570     require_once($CFG->libdir .'/kses.php');
1572     $htmlTag = $htmlArray[1];
1573     if (substr($htmlTag, 0, 1) != '<') {
1574         return '&gt;';  //a single character ">" detected
1575     }
1576     if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $htmlTag, $matches)) {
1577         return ''; // It's seriously malformed
1578     }
1579     $slash = trim($matches[1]); //trailing xhtml slash
1580     $elem = $matches[2];    //the element name
1581     $attrlist = $matches[3]; // the list of attributes as a string
1583     $attrArray = kses_hair($attrlist, $ALLOWED_PROTOCOLS);
1585     $attStr = '';
1586     foreach ($attrArray as $arreach) {
1587         $arreach['name'] = strtolower($arreach['name']);
1588         if ($arreach['name'] == 'style') {
1589             $value = $arreach['value'];
1590             while (true) {
1591                 $prevvalue = $value;
1592                 $value = kses_no_null($value);
1593                 $value = preg_replace("/\/\*.*\*\//Us", '', $value);
1594                 $value = kses_decode_entities($value);
1595                 $value = preg_replace('/(&#[0-9]+)(;?)/', "\\1;", $value);
1596                 $value = preg_replace('/(&#x[0-9a-fA-F]+)(;?)/', "\\1;", $value);
1597                 if ($value === $prevvalue) {
1598                     $arreach['value'] = $value;
1599                     break;
1600                 }
1601             }
1602             $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']);
1603             $arreach['value'] = preg_replace("/v\s*b\s*s\s*c\s*r\s*i\s*p\s*t/i", "Xvbscript", $arreach['value']);
1604             $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']);
1605             $arreach['value'] = preg_replace("/b\s*i\s*n\s*d\s*i\s*n\s*g/i", "Xbinding", $arreach['value']);
1606         } else if ($arreach['name'] == 'href') {
1607             //Adobe Acrobat Reader XSS protection
1608             $arreach['value'] = preg_replace('/(\.(pdf|fdf|xfdf|xdp|xfd)[^#]*)#.*$/i', '$1', $arreach['value']);
1609         }
1610         $attStr .=  ' '.$arreach['name'].'="'.$arreach['value'].'"';
1611     }
1613     $xhtml_slash = '';
1614     if (preg_match('%/\s*$%', $attrlist)) {
1615         $xhtml_slash = ' /';
1616     }
1617     return '<'. $slash . $elem . $attStr . $xhtml_slash .'>';
1620 /**
1621  * Replaces all known smileys in the text with image equivalents
1622  *
1623  * @global object
1624  * @staticvar array $e
1625  * @staticvar array $img
1626  * @staticvar array $emoticons
1627  * @param string $text Passed by reference. The string to search for smiley strings.
1628  * @return string
1629  */
1630 function replace_smilies(&$text) {
1631     global $CFG, $OUTPUT;
1633     if (empty($CFG->emoticons)) { /// No emoticons defined, nothing to process here
1634         return;
1635     }
1637     $lang = current_language();
1638     $emoticonstring = $CFG->emoticons;
1639     static $e = array();
1640     static $img = array();
1641     static $emoticons = null;
1643     if (is_null($emoticons)) {
1644         $emoticons = array();
1645         if ($emoticonstring) {
1646             $items = explode('{;}', $CFG->emoticons);
1647             foreach ($items as $item) {
1648                $item = explode('{:}', $item);
1649               $emoticons[$item[0]] = $item[1];
1650             }
1651         }
1652     }
1654     if (empty($img[$lang])) {  /// After the first time this is not run again
1655         $e[$lang] = array();
1656         $img[$lang] = array();
1657         foreach ($emoticons as $emoticon => $image){
1658             $alttext = get_string($image, 'pix');
1659             if ($alttext === '') {
1660                 $alttext = $image;
1661             }
1662             $e[$lang][] = $emoticon;
1663             $img[$lang][] = '<img alt="'. $alttext .'" width="15" height="15" src="'. $OUTPUT->pix_url('s/' . $image) . '" />';
1664         }
1665     }
1667     // Exclude from transformations all the code inside <script> tags
1668     // Needed to solve Bug 1185. Thanks to jouse 2001 detecting it. :-)
1669     // Based on code from glossary filter by Williams Castillo.
1670     //       - Eloy
1672     // Detect all the <script> zones to take out
1673     $excludes = array();
1674     preg_match_all('/<script language(.+?)<\/script>/is',$text,$list_of_excludes);
1676     // Take out all the <script> zones from text
1677     foreach (array_unique($list_of_excludes[0]) as $key=>$value) {
1678         $excludes['<+'.$key.'+>'] = $value;
1679     }
1680     if ($excludes) {
1681         $text = str_replace($excludes,array_keys($excludes),$text);
1682     }
1684 /// this is the meat of the code - this is run every time
1685     $text = str_replace($e[$lang], $img[$lang], $text);
1687     // Recover all the <script> zones to text
1688     if ($excludes) {
1689         $text = str_replace(array_keys($excludes),$excludes,$text);
1690     }
1693 /**
1694  * This code is called from help.php to inject a list of smilies into the
1695  * emoticons help file.
1696  *
1697  * @global object
1698  * @global object
1699  * @return string HTML for a list of smilies.
1700  */
1701 function get_emoticons_list_for_help_file() {
1702     global $CFG, $SESSION, $PAGE, $OUTPUT;
1703     if (empty($CFG->emoticons)) {
1704         return '';
1705     }
1707     $items = explode('{;}', $CFG->emoticons);
1708     $output = '<ul id="emoticonlist">';
1709     foreach ($items as $item) {
1710         $item = explode('{:}', $item);
1711         $output .= '<li><img src="' . $OUTPUT->pix_url('s/' . $item[1]) . '" alt="' .
1712                 $item[0] . '" /><code>' . $item[0] . '</code></li>';
1713     }
1714     $output .= '</ul>';
1715     if (!empty($SESSION->inserttextform)) {
1716         $formname = $SESSION->inserttextform;
1717         $fieldname = $SESSION->inserttextfield;
1718     } else {
1719         $formname = 'theform';
1720         $fieldname = 'message';
1721     }
1723     $PAGE->requires->yui2_lib('event');
1724     $PAGE->requires->js_function_call('emoticons_help.init', array($formname, $fieldname, 'emoticonlist'));
1725     return $output;
1729 /**
1730  * Given plain text, makes it into HTML as nicely as possible.
1731  * May contain HTML tags already
1732  *
1733  * @global object
1734  * @param string $text The string to convert.
1735  * @param boolean $smiley Convert any smiley characters to smiley images?
1736  * @param boolean $para If true then the returned string will be wrapped in div tags
1737  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1738  * @return string
1739  */
1741 function text_to_html($text, $smiley=true, $para=true, $newlines=true) {
1742 ///
1744     global $CFG;
1746 /// Remove any whitespace that may be between HTML tags
1747     $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1749 /// Remove any returns that precede or follow HTML tags
1750     $text = preg_replace("~([\n\r])<~i", " <", $text);
1751     $text = preg_replace("~>([\n\r])~i", "> ", $text);
1753     convert_urls_into_links($text);
1755 /// Make returns into HTML newlines.
1756     if ($newlines) {
1757         $text = nl2br($text);
1758     }
1760 /// Turn smileys into images.
1761     if ($smiley) {
1762         replace_smilies($text);
1763     }
1765 /// Wrap the whole thing in a div if required
1766     if ($para) {
1767         //return '<p>'.$text.'</p>'; //1.9 version
1768         return '<div class="text_to_html">'.$text.'</div>';
1769     } else {
1770         return $text;
1771     }
1774 /**
1775  * Given Markdown formatted text, make it into XHTML using external function
1776  *
1777  * @global object
1778  * @param string $text The markdown formatted text to be converted.
1779  * @return string Converted text
1780  */
1781 function markdown_to_html($text) {
1782     global $CFG;
1784     if ($text === '' or $text === NULL) {
1785         return $text;
1786     }
1788     require_once($CFG->libdir .'/markdown.php');
1790     return Markdown($text);
1793 /**
1794  * Given HTML text, make it into plain text using external function
1795  *
1796  * @param string $html The text to be converted.
1797  * @param integer $width Width to wrap the text at. (optional, default 75 which
1798  *      is a good value for email. 0 means do not limit line length.)
1799  * @param boolean $dolinks By default, any links in the HTML are collected, and
1800  *      printed as a list at the end of the HTML. If you don't want that, set this
1801  *      argument to false.
1802  * @return string plain text equivalent of the HTML.
1803  */
1804 function html_to_text($html, $width = 75, $dolinks = true) {
1806     global $CFG;
1808     require_once($CFG->libdir .'/html2text.php');
1810     $h2t = new html2text($html, false, $dolinks, $width);
1811     $result = $h2t->get_text();
1813     return $result;
1816 /**
1817  * Given some text this function converts any URLs it finds into HTML links
1818  *
1819  * @param string $text Passed in by reference. The string to be searched for urls.
1820  */
1821 function convert_urls_into_links(&$text) {
1822     //I've added img tags to this list of tags to ignore.
1823     //See MDL-21168 for more info. A better way to ignore tags whether or not
1824     //they are escaped partially or completely would be desirable. For example:
1825     //<a href="blah">
1826     //&lt;a href="blah"&gt;
1827     //&lt;a href="blah">
1828     $filterignoretagsopen  = array('<a\s[^>]+?>');
1829     $filterignoretagsclose = array('</a>');
1830     filter_save_ignore_tags($text,$filterignoretagsopen,$filterignoretagsclose,$ignoretags);
1832     // Check if we support unicode modifiers in regular expressions. Cache it.
1833     // TODO: this check should be a environment requirement in Moodle 2.0, as far as unicode
1834     // chars are going to arrive to URLs officially really soon (2010?)
1835     // Original RFC regex from: http://www.bytemycode.com/snippets/snippet/796/
1836     // Various ideas from: http://alanstorm.com/url_regex_explained
1837     // Unicode check, negative assertion and other bits from Moodle.
1838     static $unicoderegexp;
1839     if (!isset($unicoderegexp)) {
1840         $unicoderegexp = @preg_match('/\pL/u', 'a'); // This will fail silently, returning false,
1841     }
1843     //todo: MDL-21296 - use of unicode modifiers may cause a timeout
1844     if ($unicoderegexp) { //We can use unicode modifiers
1845         $text = preg_replace('#(?<!=["\'])(((http(s?))://)(((([\pLl0-9]([\pLl0-9]|-)*[\pLl0-9]|[\pLl0-9])\.)+([\pLl]([\pLl0-9]|-)*[\pLl0-9]|[\pLl]))|(([0-9]{1,3}\.){3}[0-9]{1,3}))(:[\pL0-9]*)?(/([\pLl0-9\.!$&\'\(\)*+,;=_~:@-]|%[a-fA-F0-9]{2})*)*(\?([\pLl0-9\.!$&\'\(\)*+,;=_~:@/?-]|%[a-fA-F0-9]{2})*)?(\#[\pLl0-9\.!$&\'\(\)*+,;=_~:@/?-]*)?)(?<![,.;])#iu',
1846                              '<a href="\\1" class="_blanktarget">\\1</a>', $text);
1847         $text = preg_replace('#(?<!=["\']|//)((www\.([\pLl0-9]([\pLl0-9]|-)*[\pLl0-9]|[\pLl0-9])\.)+([\pLl]([\pLl0-9]|-)*[\pLl0-9]|[\pLl])(:[\pL0-9]*)?(/([\pLl0-9\.!$&\'\(\)*+,;=_~:@-]|%[a-fA-F0-9]{2})*)*(\?([\pLl0-9\.!$&\'\(\)*+,;=_~:@/?-]|%[a-fA-F0-9]{2})*)?(\#[\pLl0-9\.!$&\'\(\)*+,;=_~:@/?-]*)?)(?<![,.;])#iu',
1848                              '<a href="http://\\1" class="_blanktarget">\\1</a>', $text);
1849     } else { //We cannot use unicode modifiers
1850         $text = preg_replace('#(?<!=["\'])(((http(s?))://)(((([a-z0-9]([a-z0-9]|-)*[a-z0-9]|[a-z0-9])\.)+([a-z]([a-z0-9]|-)*[a-z0-9]|[a-z]))|(([0-9]{1,3}\.){3}[0-9]{1,3}))(:[a-zA-Z0-9]*)?(/([a-z0-9\.!$&\'\(\)*+,;=_~:@-]|%[a-f0-9]{2})*)*(\?([a-z0-9\.!$&\'\(\)*+,;=_~:@/?-]|%[a-fA-F0-9]{2})*)?(\#[a-z0-9\.!$&\'\(\)*+,;=_~:@/?-]*)?)(?<![,.;])#i',
1851                              '<a href="\\1" class="_blanktarget">\\1</a>', $text);
1852         $text = preg_replace('#(?<!=["\']|//)((www\.([a-z0-9]([a-z0-9]|-)*[a-z0-9]|[a-z0-9])\.)+([a-z]([a-z0-9]|-)*[a-z0-9]|[a-z])(:[a-zA-Z0-9]*)?(/([a-z0-9\.!$&\'\(\)*+,;=_~:@-]|%[a-f0-9]{2})*)*(\?([a-z0-9\.!$&\'\(\)*+,;=_~:@/?-]|%[a-fA-F0-9]{2})*)?(\#[a-z0-9\.!$&\'\(\)*+,;=_~:@/?-]*)?)(?<![,.;])#i',
1853                              '<a href="http://\\1" class="_blanktarget">\\1</a>', $text);
1854     }
1856     if (!empty($ignoretags)) {
1857         $ignoretags = array_reverse($ignoretags); /// Reversed so "progressive" str_replace() will solve some nesting problems.
1858         $text = str_replace(array_keys($ignoretags),$ignoretags,$text);
1859     }
1862 /**
1863  * This function will highlight search words in a given string
1864  *
1865  * It cares about HTML and will not ruin links.  It's best to use
1866  * this function after performing any conversions to HTML.
1867  *
1868  * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1869  * @param string $haystack The string (HTML) within which to highlight the search terms.
1870  * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1871  * @param string $prefix the string to put before each search term found.
1872  * @param string $suffix the string to put after each search term found.
1873  * @return string The highlighted HTML.
1874  */
1875 function highlight($needle, $haystack, $matchcase = false,
1876         $prefix = '<span class="highlight">', $suffix = '</span>') {
1878 /// Quick bail-out in trivial cases.
1879     if (empty($needle) or empty($haystack)) {
1880         return $haystack;
1881     }
1883 /// Break up the search term into words, discard any -words and build a regexp.
1884     $words = preg_split('/ +/', trim($needle));
1885     foreach ($words as $index => $word) {
1886         if (strpos($word, '-') === 0) {
1887             unset($words[$index]);
1888         } else if (strpos($word, '+') === 0) {
1889             $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
1890         } else {
1891             $words[$index] = preg_quote($word, '/');
1892         }
1893     }
1894     $regexp = '/(' . implode('|', $words) . ')/u'; // u is do UTF-8 matching.
1895     if (!$matchcase) {
1896         $regexp .= 'i';
1897     }
1899 /// Another chance to bail-out if $search was only -words
1900     if (empty($words)) {
1901         return $haystack;
1902     }
1904 /// Find all the HTML tags in the input, and store them in a placeholders array.
1905     $placeholders = array();
1906     $matches = array();
1907     preg_match_all('/<[^>]*>/', $haystack, $matches);
1908     foreach (array_unique($matches[0]) as $key => $htmltag) {
1909         $placeholders['<|' . $key . '|>'] = $htmltag;
1910     }
1912 /// In $hastack, replace each HTML tag with the corresponding placeholder.
1913     $haystack = str_replace($placeholders, array_keys($placeholders), $haystack);
1915 /// In the resulting string, Do the highlighting.
1916     $haystack = preg_replace($regexp, $prefix . '$1' . $suffix, $haystack);
1918 /// Turn the placeholders back into HTML tags.
1919     $haystack = str_replace(array_keys($placeholders), $placeholders, $haystack);
1921     return $haystack;
1924 /**
1925  * This function will highlight instances of $needle in $haystack
1926  *
1927  * It's faster that the above function {@link highlight()} and doesn't care about
1928  * HTML or anything.
1929  *
1930  * @param string $needle The string to search for
1931  * @param string $haystack The string to search for $needle in
1932  * @return string The highlighted HTML
1933  */
1934 function highlightfast($needle, $haystack) {
1936     if (empty($needle) or empty($haystack)) {
1937         return $haystack;
1938     }
1940     $parts = explode(moodle_strtolower($needle), moodle_strtolower($haystack));
1942     if (count($parts) === 1) {
1943         return $haystack;
1944     }
1946     $pos = 0;
1948     foreach ($parts as $key => $part) {
1949         $parts[$key] = substr($haystack, $pos, strlen($part));
1950         $pos += strlen($part);
1952         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
1953         $pos += strlen($needle);
1954     }
1956     return str_replace('<span class="highlight"></span>', '', join('', $parts));
1959 /**
1960  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
1961  * Internationalisation, for print_header and backup/restorelib.
1962  *
1963  * @param bool $dir Default false
1964  * @return string Attributes
1965  */
1966 function get_html_lang($dir = false) {
1967     $direction = '';
1968     if ($dir) {
1969         if (right_to_left()) {
1970             $direction = ' dir="rtl"';
1971         } else {
1972             $direction = ' dir="ltr"';
1973         }
1974     }
1975     //Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
1976     $language = str_replace('_', '-', current_language());
1977     @header('Content-Language: '.$language);
1978     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
1982 /// STANDARD WEB PAGE PARTS ///////////////////////////////////////////////////
1984 /**
1985  * Send the HTTP headers that Moodle requires.
1986  * @param $cacheable Can this page be cached on back?
1987  */
1988 function send_headers($contenttype, $cacheable = true) {
1989     @header('Content-Type: ' . $contenttype);
1990     @header('Content-Script-Type: text/javascript');
1991     @header('Content-Style-Type: text/css');
1993     if ($cacheable) {
1994         // Allow caching on "back" (but not on normal clicks)
1995         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0');
1996         @header('Pragma: no-cache');
1997         @header('Expires: ');
1998     } else {
1999         // Do everything we can to always prevent clients and proxies caching
2000         @header('Cache-Control: no-store, no-cache, must-revalidate');
2001         @header('Cache-Control: post-check=0, pre-check=0', false);
2002         @header('Pragma: no-cache');
2003         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2004         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2005     }
2006     @header('Accept-Ranges: none');
2009 /**
2010  * Return the right arrow with text ('next'), and optionally embedded in a link.
2011  *
2012  * @global object
2013  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2014  * @param string $url An optional link to use in a surrounding HTML anchor.
2015  * @param bool $accesshide True if text should be hidden (for screen readers only).
2016  * @param string $addclass Additional class names for the link, or the arrow character.
2017  * @return string HTML string.
2018  */
2019 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
2020     global $OUTPUT; //TODO: move to output renderer
2021     $arrowclass = 'arrow ';
2022     if (! $url) {
2023         $arrowclass .= $addclass;
2024     }
2025     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
2026     $htmltext = '';
2027     if ($text) {
2028         $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
2029         if ($accesshide) {
2030             $htmltext = get_accesshide($htmltext);
2031         }
2032     }
2033     if ($url) {
2034         $class = 'arrow_link';
2035         if ($addclass) {
2036             $class .= ' '.$addclass;
2037         }
2038         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$htmltext.$arrow.'</a>';
2039     }
2040     return $htmltext.$arrow;
2043 /**
2044  * Return the left arrow with text ('previous'), and optionally embedded in a link.
2045  *
2046  * @global object
2047  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2048  * @param string $url An optional link to use in a surrounding HTML anchor.
2049  * @param bool $accesshide True if text should be hidden (for screen readers only).
2050  * @param string $addclass Additional class names for the link, or the arrow character.
2051  * @return string HTML string.
2052  */
2053 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
2054     global $OUTPUT; // TODO: move to utput renderer
2055     $arrowclass = 'arrow ';
2056     if (! $url) {
2057         $arrowclass .= $addclass;
2058     }
2059     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
2060     $htmltext = '';
2061     if ($text) {
2062         $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
2063         if ($accesshide) {
2064             $htmltext = get_accesshide($htmltext);
2065         }
2066     }
2067     if ($url) {
2068         $class = 'arrow_link';
2069         if ($addclass) {
2070             $class .= ' '.$addclass;
2071         }
2072         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$arrow.$htmltext.'</a>';
2073     }
2074     return $arrow.$htmltext;
2077 /**
2078  * Return a HTML element with the class "accesshide", for accessibility.
2079  * Please use cautiously - where possible, text should be visible!
2080  *
2081  * @param string $text Plain text.
2082  * @param string $elem Lowercase element name, default "span".
2083  * @param string $class Additional classes for the element.
2084  * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
2085  * @return string HTML string.
2086  */
2087 function get_accesshide($text, $elem='span', $class='', $attrs='') {
2088     return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
2091 /**
2092  * Return the breadcrumb trail navigation separator.
2093  *
2094  * @return string HTML string.
2095  */
2096 function get_separator() {
2097     //Accessibility: the 'hidden' slash is preferred for screen readers.
2098     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
2101 /**
2102  * Print (or return) a collapsible region, that has a caption that can
2103  * be clicked to expand or collapse the region.
2104  *
2105  * If JavaScript is off, then the region will always be expanded.
2106  *
2107  * @param string $contents the contents of the box.
2108  * @param string $classes class names added to the div that is output.
2109  * @param string $id id added to the div that is output. Must not be blank.
2110  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2111  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2112  *      (May be blank if you do not wish the state to be persisted.
2113  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2114  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2115  * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
2116  */
2117 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2118     $output  = print_collapsible_region_start($classes, $id, $caption, $userpref, true, true);
2119     $output .= $contents;
2120     $output .= print_collapsible_region_end(true);
2122     if ($return) {
2123         return $output;
2124     } else {
2125         echo $output;
2126     }
2129 /**
2130  * Print (or return) the start of a collapsible region, that has a caption that can
2131  * be clicked to expand or collapse the region. If JavaScript is off, then the region
2132  * will always be expanded.
2133  *
2134  * @global object
2135  * @param string $classes class names added to the div that is output.
2136  * @param string $id id added to the div that is output. Must not be blank.
2137  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2138  * @param boolean $userpref the name of the user preference that stores the user's preferred default state.
2139  *      (May be blank if you do not wish the state to be persisted.
2140  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2141  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2142  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2143  */
2144 function print_collapsible_region_start($classes, $id, $caption, $userpref = false, $default = false, $return = false) {
2145     global $CFG, $PAGE, $OUTPUT;
2147     // Work out the initial state.
2148     if (is_string($userpref)) {
2149         user_preference_allow_ajax_update($userpref, PARAM_BOOL);
2150         $collapsed = get_user_preferences($userpref, $default);
2151     } else {
2152         $collapsed = $default;
2153         $userpref = false;
2154     }
2156     if ($collapsed) {
2157         $classes .= ' collapsed';
2158     }
2160     $output = '';
2161     $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2162     $output .= '<div id="' . $id . '_sizer">';
2163     $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2164     $output .= $caption . ' ';
2165     $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2166     $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2168     if ($return) {
2169         return $output;
2170     } else {
2171         echo $output;
2172     }
2175 /**
2176  * Close a region started with print_collapsible_region_start.
2177  *
2178  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2179  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2180  */
2181 function print_collapsible_region_end($return = false) {
2182     $output = '</div></div></div>';
2184     if ($return) {
2185         return $output;
2186     } else {
2187         echo $output;
2188     }
2191 /**
2192  * Print a specified group's avatar.
2193  *
2194  * @global object
2195  * @uses CONTEXT_COURSE
2196  * @param array|stdClass $group A single {@link group} object OR array of groups.
2197  * @param int $courseid The course ID.
2198  * @param boolean $large Default small picture, or large.
2199  * @param boolean $return If false print picture, otherwise return the output as string
2200  * @param boolean $link Enclose image in a link to view specified course?
2201  * @return string|void Depending on the setting of $return
2202  */
2203 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2204     global $CFG;
2206     if (is_array($group)) {
2207         $output = '';
2208         foreach($group as $g) {
2209             $output .= print_group_picture($g, $courseid, $large, true, $link);
2210         }
2211         if ($return) {
2212             return $output;
2213         } else {
2214             echo $output;
2215             return;
2216         }
2217     }
2219     $context = get_context_instance(CONTEXT_COURSE, $courseid);
2221     // If there is no picture, do nothing
2222     if (!$group->picture) {
2223         return '';
2224     }
2226     // If picture is hidden, only show to those with course:managegroups
2227     if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
2228         return '';
2229     }
2231     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2232         $output = '<a href="'. $CFG->wwwroot .'/user/index.php?id='. $courseid .'&amp;group='. $group->id .'">';
2233     } else {
2234         $output = '';
2235     }
2236     if ($large) {
2237         $file = 'f1';
2238     } else {
2239         $file = 'f2';
2240     }
2242     $grouppictureurl = moodle_url::make_pluginfile_url($context->id, 'group', 'icon', $group->id, '/', $file);
2243     $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2244         ' alt="'.s(get_string('group').' '.$group->name).'" title="'.s($group->name).'"/>';
2246     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2247         $output .= '</a>';
2248     }
2250     if ($return) {
2251         return $output;
2252     } else {
2253         echo $output;
2254     }
2258 /**
2259  * Display a recent activity note
2260  *
2261  * @uses CONTEXT_SYSTEM
2262  * @staticvar string $strftimerecent
2263  * @param object A time object
2264  * @param object A user object
2265  * @param string $text Text for display for the note
2266  * @param string $link The link to wrap around the text
2267  * @param bool $return If set to true the HTML is returned rather than echo'd
2268  * @param string $viewfullnames
2269  */
2270 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2271     static $strftimerecent = null;
2272     $output = '';
2274     if (is_null($viewfullnames)) {
2275         $context = get_context_instance(CONTEXT_SYSTEM);
2276         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2277     }
2279     if (is_null($strftimerecent)) {
2280         $strftimerecent = get_string('strftimerecent');
2281     }
2283     $output .= '<div class="head">';
2284     $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2285     $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2286     $output .= '</div>';
2287     $output .= '<div class="info"><a href="'.$link.'">'.format_string($text,true).'</a></div>';
2289     if ($return) {
2290         return $output;
2291     } else {
2292         echo $output;
2293     }
2296 /**
2297  * Returns a popup menu with course activity modules
2298  *
2299  * Given a course
2300  * This function returns a small popup menu with all the
2301  * course activity modules in it, as a navigation menu
2302  * outputs a simple list structure in XHTML
2303  * The data is taken from the serialised array stored in
2304  * the course record
2305  *
2306  * @todo Finish documenting this function
2307  *
2308  * @global object
2309  * @uses CONTEXT_COURSE
2310  * @param course $course A {@link $COURSE} object.
2311  * @param string $sections
2312  * @param string $modinfo
2313  * @param string $strsection
2314  * @param string $strjumpto
2315  * @param int $width
2316  * @param string $cmid
2317  * @return string The HTML block
2318  */
2319 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2321     global $CFG, $OUTPUT;
2323     $section = -1;
2324     $url = '';
2325     $menu = array();
2326     $doneheading = false;
2328     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2330     $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2331     foreach ($modinfo->cms as $mod) {
2332         if ($mod->modname == 'label') {
2333             continue;
2334         }
2336         if ($mod->sectionnum > $course->numsections) {   /// Don't show excess hidden sections
2337             break;
2338         }
2340         if (!$mod->uservisible) { // do not icnlude empty sections at all
2341             continue;
2342         }
2344         if ($mod->sectionnum >= 0 and $section != $mod->sectionnum) {
2345             $thissection = $sections[$mod->sectionnum];
2347             if ($thissection->visible or !$course->hiddensections or
2348                       has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2349                 $thissection->summary = strip_tags(format_string($thissection->summary,true));
2350                 if (!$doneheading) {
2351                     $menu[] = '</ul></li>';
2352                 }
2353                 if ($course->format == 'weeks' or empty($thissection->summary)) {
2354                     $item = $strsection ." ". $mod->sectionnum;
2355                 } else {
2356                     if (strlen($thissection->summary) < ($width-3)) {
2357                         $item = $thissection->summary;
2358                     } else {
2359                         $item = substr($thissection->summary, 0, $width).'...';
2360                     }
2361                 }
2362                 $menu[] = '<li class="section"><span>'.$item.'</span>';
2363                 $menu[] = '<ul>';
2364                 $doneheading = true;
2366                 $section = $mod->sectionnum;
2367             } else {
2368                 // no activities from this hidden section shown
2369                 continue;
2370             }
2371         }
2373         $url = $mod->modname .'/view.php?id='. $mod->id;
2374         $mod->name = strip_tags(format_string($mod->name ,true));
2375         if (strlen($mod->name) > ($width+5)) {
2376             $mod->name = substr($mod->name, 0, $width).'...';
2377         }
2378         if (!$mod->visible) {
2379             $mod->name = '('.$mod->name.')';
2380         }
2381         $class = 'activity '.$mod->modname;
2382         $class .= ($cmid == $mod->id) ? ' selected' : '';
2383         $menu[] = '<li class="'.$class.'">'.
2384                   '<img src="'.$OUTPUT->pix_url('icon', $mod->modname) . '" alt="" />'.
2385                   '<a href="'.$CFG->wwwroot.'/mod/'.$url.'">'.$mod->name.'</a></li>';
2386     }
2388     if ($doneheading) {
2389         $menu[] = '</ul></li>';
2390     }
2391     $menu[] = '</ul></li></ul>';
2393     return implode("\n", $menu);
2396 /**
2397  * Prints a grade menu (as part of an existing form) with help
2398  * Showing all possible numerical grades and scales
2399  *
2400  * @todo Finish documenting this function
2401  * @todo Deprecate: this is only used in a few contrib modules
2402  *
2403  * @global object
2404  * @param int $courseid The course ID
2405  * @param string $name
2406  * @param string $current
2407  * @param boolean $includenograde Include those with no grades
2408  * @param boolean $return If set to true returns rather than echo's
2409  * @return string|bool Depending on value of $return
2410  */
2411 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2413     global $CFG, $OUTPUT;
2415     $output = '';
2416     $strscale = get_string('scale');
2417     $strscales = get_string('scales');
2419     $scales = get_scales_menu($courseid);
2420     foreach ($scales as $i => $scalename) {
2421         $grades[-$i] = $strscale .': '. $scalename;
2422     }
2423     if ($includenograde) {
2424         $grades[0] = get_string('nograde');
2425     }
2426     for ($i=100; $i>=1; $i--) {
2427         $grades[$i] = $i;
2428     }
2429     $output .= html_writer::select($grades, $name, $current, false);
2431     $linkobject = '<span class="helplink"><img class="iconhelp" alt="'.$strscales.'" src="'.$OUTPUT->pix_url('help') . '" /></span>';
2432     $link = new moodle_url('/course/scales.php', array('id'=>$courseid, 'list'=>1));
2433     $action = new popup_action('click', $link->url, 'ratingscales', array('height' => 400, 'width' => 500));
2434     $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title'=>$strscales));
2436     if ($return) {
2437         return $output;
2438     } else {
2439         echo $output;
2440     }
2443 /**
2444  * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2445  * Default errorcode is 1.
2446  *
2447  * Very useful for perl-like error-handling:
2448  *
2449  * do_somethting() or mdie("Something went wrong");
2450  *
2451  * @param string  $msg       Error message
2452  * @param integer $errorcode Error code to emit
2453  */
2454 function mdie($msg='', $errorcode=1) {
2455     trigger_error($msg);
2456     exit($errorcode);
2459 /**
2460  * Print a message and exit.
2461  *
2462  * @param string $message The message to print in the notice
2463  * @param string $link The link to use for the continue button
2464  * @param object $course A course object
2465  * @return void This function simply exits
2466  */
2467 function notice ($message, $link='', $course=NULL) {
2468     global $CFG, $SITE, $COURSE, $PAGE, $OUTPUT;
2470     $message = clean_text($message);   // In case nasties are in here
2472     if (CLI_SCRIPT) {
2473         echo("!!$message!!\n");
2474         exit(1); // no success
2475     }
2477     if (!$PAGE->headerprinted) {
2478         //header not yet printed
2479         $PAGE->set_title(get_string('notice'));
2480         echo $OUTPUT->header();
2481     } else {
2482         echo $OUTPUT->container_end_all(false);
2483     }
2485     echo $OUTPUT->box($message, 'generalbox', 'notice');
2486     echo $OUTPUT->continue_button($link);
2488     echo $OUTPUT->footer();
2489     exit(1); // general error code
2492 /**
2493  * Redirects the user to another page, after printing a notice
2494  *
2495  * This function calls the OUTPUT redirect method, echo's the output
2496  * and then dies to ensure nothing else happens.
2497  *
2498  * <strong>Good practice:</strong> You should call this method before starting page
2499  * output by using any of the OUTPUT methods.
2500  *
2501  * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2502  * @param string $message The message to display to the user
2503  * @param int $delay The delay before redirecting
2504  * @return void - does not return!
2505  */
2506 function redirect($url, $message='', $delay=-1) {
2507     global $OUTPUT, $PAGE, $SESSION, $CFG;
2509     if (CLI_SCRIPT or AJAX_SCRIPT) {
2510         // this is wrong - developers should not use redirect in these scripts,
2511         // but it should not be very likely
2512         throw new moodle_exception('redirecterrordetected', 'error');
2513     }
2515     if ($url instanceof moodle_url) {
2516         $url = $url->out(false);
2517     }
2519     if (!empty($CFG->usesid) && !isset($_COOKIE[session_name()])) {
2520        $url = $SESSION->sid_process_url($url);
2521     }
2523     if (function_exists('error_get_last')) {
2524         $lasterror = error_get_last();
2525         //NOTE: problem here is that this contains error even if error hidden with @do();
2526     }
2527     $debugdisableredirect = defined('DEBUGGING_PRINTED') ||
2528             (!empty($CFG->debugdisplay) && !empty($lasterror) && ($lasterror['type'] & DEBUG_DEVELOPER));
2530     if (!empty($message)) {
2531         if ($delay === -1 || !is_numeric($delay)) {
2532             $delay = 3;
2533         }
2534         $message = clean_text($message);
2535     } else {
2536         $message = get_string('pageshouldredirect');
2537         $delay = 0;
2538         // We are going to try to use a HTTP redirect, so we need a full URL.
2539         if (!preg_match('|^[a-z]+:|', $url)) {
2540             // Get host name http://www.wherever.com
2541             $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2542             if (preg_match('|^/|', $url)) {
2543                 // URLs beginning with / are relative to web server root so we just add them in
2544                 $url = $hostpart.$url;
2545             } else {
2546                 // URLs not beginning with / are relative to path of current script, so add that on.
2547                 $url = $hostpart.preg_replace('|\?.*$|','',me()).'/../'.$url;
2548             }
2549             // Replace all ..s
2550             while (true) {
2551                 $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2552                 if ($newurl == $url) {
2553                     break;
2554                 }
2555                 $url = $newurl;
2556             }
2557         }
2558     }
2560     if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
2561         if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
2562             $perf = get_performance_info();
2563             error_log("PERF: " . $perf['txt']);
2564         }
2565     }
2567     $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2568     $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />'));
2570     if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2571         //302 might not work for POST requests, 303 is ignored by obsolete clients.
2572         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2573         @header('Location: '.$url);
2574         echo bootstrap_renderer::plain_redirect_message($encodedurl);
2575         exit;
2576     }
2578     // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2579     $PAGE->set_pagelayout('embedded');  // No header and footer needed
2580     $CFG->docroot = false; // to prevent the link to moodle docs from being displayed on redirect page.
2581     echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect);
2582     exit;
2585 /**
2586  * Given an email address, this function will return an obfuscated version of it
2587  *
2588  * @param string $email The email address to obfuscate
2589  * @return string The obfuscated email address
2590  */
2591  function obfuscate_email($email) {
2593     $i = 0;
2594     $length = strlen($email);
2595     $obfuscated = '';
2596     while ($i < $length) {
2597         if (rand(0,2) && $email{$i}!='@') { //MDL-20619 some browsers have problems unobfuscating @
2598             $obfuscated.='%'.dechex(ord($email{$i}));
2599         } else {
2600             $obfuscated.=$email{$i};
2601         }
2602         $i++;
2603     }
2604     return $obfuscated;
2607 /**
2608  * This function takes some text and replaces about half of the characters
2609  * with HTML entity equivalents.   Return string is obviously longer.
2610  *
2611  * @param string $plaintext The text to be obfuscated
2612  * @return string The obfuscated text
2613  */
2614 function obfuscate_text($plaintext) {
2616     $i=0;
2617     $length = strlen($plaintext);
2618     $obfuscated='';
2619     $prev_obfuscated = false;
2620     while ($i < $length) {
2621         $c = ord($plaintext{$i});
2622         $numerical = ($c >= ord('0')) && ($c <= ord('9'));
2623         if ($prev_obfuscated and $numerical ) {
2624             $obfuscated.='&#'.ord($plaintext{$i}).';';
2625         } else if (rand(0,2)) {
2626             $obfuscated.='&#'.ord($plaintext{$i}).';';
2627             $prev_obfuscated = true;
2628         } else {
2629             $obfuscated.=$plaintext{$i};
2630             $prev_obfuscated = false;
2631         }
2632       $i++;
2633     }
2634     return $obfuscated;
2637 /**
2638  * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2639  * to generate a fully obfuscated email link, ready to use.
2640  *
2641  * @param string $email The email address to display
2642  * @param string $label The text to displayed as hyperlink to $email
2643  * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2644  * @return string The obfuscated mailto link
2645  */
2646 function obfuscate_mailto($email, $label='', $dimmed=false) {
2648     if (empty($label)) {
2649         $label = $email;
2650     }
2651     if ($dimmed) {
2652         $title = get_string('emaildisable');
2653         $dimmed = ' class="dimmed"';
2654     } else {
2655         $title = '';
2656         $dimmed = '';
2657     }
2658     return sprintf("<a href=\"%s:%s\" $dimmed title=\"$title\">%s</a>",
2659                     obfuscate_text('mailto'), obfuscate_email($email),
2660                     obfuscate_text($label));
2663 /**
2664  * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2665  * will transform it to html entities
2666  *
2667  * @param string $text Text to search for nolink tag in
2668  * @return string
2669  */
2670 function rebuildnolinktag($text) {
2672     $text = preg_replace('/&lt;(\/*nolink)&gt;/i','<$1>',$text);
2674     return $text;
2677 /**
2678  * Prints a maintenance message from $CFG->maintenance_message or default if empty
2679  * @return void
2680  */
2681 function print_maintenance_message() {
2682     global $CFG, $SITE, $PAGE, $OUTPUT;
2684     $PAGE->set_pagetype('maintenance-message');
2685     $PAGE->set_pagelayout('maintenance');
2686     $PAGE->set_title(strip_tags($SITE->fullname));
2687     $PAGE->set_heading($SITE->fullname);
2688     echo $OUTPUT->header();
2689     echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2690     if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
2691         echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2692         echo $CFG->maintenance_message;
2693         echo $OUTPUT->box_end();
2694     }
2695     echo $OUTPUT->footer();
2696     die;
2699 /**
2700  * Adjust the list of allowed tags based on $CFG->allowobjectembed and user roles (admin)
2701  *
2702  * @global object
2703  * @global string
2704  * @return void
2705  */
2706 function adjust_allowed_tags() {
2708     global $CFG, $ALLOWED_TAGS;
2710     if (!empty($CFG->allowobjectembed)) {
2711         $ALLOWED_TAGS .= '<embed><object>';
2712     }
2715 /**
2716  * A class for tabs, Some code to print tabs
2717  *
2718  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2719  * @package moodlecore
2720  */
2721 class tabobject {
2722     /**
2723      * @var string
2724      */
2725     var $id;
2726     var $link;
2727     var $text;
2728     /**
2729      * @var bool
2730      */
2731     var $linkedwhenselected;
2733     /**
2734      * A constructor just because I like constructors
2735      *
2736      * @param string $id
2737      * @param string $link
2738      * @param string $text
2739      * @param string $title
2740      * @param bool $linkedwhenselected
2741      */
2742     function tabobject ($id, $link='', $text='', $title='', $linkedwhenselected=false) {
2743         $this->id   = $id;
2744         $this->link = $link;
2745         $this->text = $text;
2746         $this->title = $title ? $title : $text;
2747         $this->linkedwhenselected = $linkedwhenselected;
2748     }
2753 /**
2754  * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2755  *
2756  * @global object
2757  * @param array $tabrows An array of rows where each row is an array of tab objects
2758  * @param string $selected  The id of the selected tab (whatever row it's on)
2759  * @param array  $inactive  An array of ids of inactive tabs that are not selectable.
2760  * @param array  $activated An array of ids of other tabs that are currently activated
2761  * @param bool $return If true output is returned rather then echo'd
2762  **/
2763 function print_tabs($tabrows, $selected=NULL, $inactive=NULL, $activated=NULL, $return=false) {
2764     global $CFG;
2766 /// $inactive must be an array
2767     if (!is_array($inactive)) {
2768         $inactive = array();
2769     }
2771 /// $activated must be an array
2772     if (!is_array($activated)) {
2773         $activated = array();
2774     }
2776 /// Convert the tab rows into a tree that's easier to process
2777     if (!$tree = convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated)) {
2778         return false;
2779     }
2781 /// Print out the current tree of tabs (this function is recursive)
2783     $output = convert_tree_to_html($tree);
2785     $output = "\n\n".'<div class="tabtree">'.$output.'</div><div class="clearer"> </div>'."\n\n";
2787 /// We're done!
2789     if ($return) {
2790         return $output;
2791     }
2792     echo $output;
2795 /**
2796  * Converts a nested array tree into HTML ul:li [recursive]
2797  *
2798  * @param array $tree A tree array to convert
2799  * @param int $row Used in identifying the iteration level and in ul classes
2800  * @return string HTML structure
2801  */
2802 function convert_tree_to_html($tree, $row=0) {
2804     $str = "\n".'<ul class="tabrow'.$row.'">'."\n";
2806     $first = true;
2807     $count = count($tree);
2809     foreach ($tree as $tab) {
2810         $count--;   // countdown to zero
2812         $liclass = '';
2814         if ($first && ($count == 0)) {   // Just one in the row
2815             $liclass = 'first last';
2816             $first = false;
2817         } else if ($first) {
2818             $liclass = 'first';
2819             $first = false;
2820         } else if ($count == 0) {
2821             $liclass = 'last';
2822         }
2824         if ((empty($tab->subtree)) && (!empty($tab->selected))) {
2825             $liclass .= (empty($liclass)) ? 'onerow' : ' onerow';
2826         }
2828         if ($tab->inactive || $tab->active || $tab->selected) {
2829             if ($tab->selected) {
2830                 $liclass .= (empty($liclass)) ? 'here selected' : ' here selected';
2831             } else if ($tab->active) {
2832                 $liclass .= (empty($liclass)) ? 'here active' : ' here active';
2833             }
2834         }
2836         $str .= (!empty($liclass)) ? '<li class="'.$liclass.'">' : '<li>';
2838         if ($tab->inactive || $tab->active || ($tab->selected && !$tab->linkedwhenselected)) {
2839             // The a tag is used for styling
2840             $str .= '<a class="nolink"><span>'.$tab->text.'</span></a>';
2841         } else {
2842             $str .= '<a href="'.$tab->link.'" title="'.$tab->title.'"><span>'.$tab->text.'</span></a>';
2843         }
2845         if (!empty($tab->subtree)) {
2846             $str .= convert_tree_to_html($tab->subtree, $row+1);
2847         } else if ($tab->selected) {
2848             $str .= '<div class="tabrow'.($row+1).' empty">&nbsp;</div>'."\n";
2849         }
2851         $str .= ' </li>'."\n";
2852     }
2853     $str .= '</ul>'."\n";
2855     return $str;
2858 /**
2859  * Convert nested tabrows to a nested array
2860  *
2861  * @param array $tabrows A [nested] array of tab row objects
2862  * @param string $selected The tabrow to select (by id)
2863  * @param array $inactive An array of tabrow id's to make inactive
2864  * @param array $activated An array of tabrow id's to make active
2865  * @return array The nested array
2866  */
2867 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
2869 /// Work backwards through the rows (bottom to top) collecting the tree as we go.
2871     $tabrows = array_reverse($tabrows);
2873     $subtree = array();
2875     foreach ($tabrows as $row) {
2876         $tree = array();
2878         foreach ($row as $tab) {
2879             $tab->inactive = in_array((string)$tab->id, $inactive);
2880             $tab->active = in_array((string)$tab->id, $activated);
2881             $tab->selected = (string)$tab->id == $selected;
2883             if ($tab->active || $tab->selected) {
2884                 if ($subtree) {
2885                     $tab->subtree = $subtree;
2886                 }
2887             }
2888             $tree[] = $tab;
2889         }
2890         $subtree = $tree;
2891     }
2893     return $subtree;
2896 /**
2897  * Returns the Moodle Docs URL in the users language
2898  *
2899  * @global object
2900  * @param string $path the end of the URL.
2901  * @return string The MoodleDocs URL in the user's language. for example {@link http://docs.moodle.org/en/ http://docs.moodle.org/en/$path}
2902  */
2903 function get_docs_url($path) {
2904     global $CFG;
2905     return $CFG->docroot . '/' . current_language() . '/' . $path;
2909 /**
2910  * Standard Debugging Function
2911  *
2912  * Returns true if the current site debugging settings are equal or above specified level.
2913  * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2914  * routing of notices is controlled by $CFG->debugdisplay
2915  * eg use like this:
2916  *
2917  * 1)  debugging('a normal debug notice');
2918  * 2)  debugging('something really picky', DEBUG_ALL);
2919  * 3)  debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
2920  * 4)  if (debugging()) { perform extra debugging operations (do not use print or echo) }
2921  *
2922  * In code blocks controlled by debugging() (such as example 4)
2923  * any output should be routed via debugging() itself, or the lower-level
2924  * trigger_error() or error_log(). Using echo or print will break XHTML
2925  * JS and HTTP headers.
2926  *
2927  * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2928  *
2929  * @uses DEBUG_NORMAL
2930  * @param string $message a message to print
2931  * @param int $level the level at which this debugging statement should show
2932  * @param array $backtrace use different backtrace
2933  * @return bool
2934  */
2935 function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
2936     global $CFG, $UNITTEST;
2938     if (empty($CFG->debug) || $CFG->debug < $level) {
2939         return false;
2940     }
2942     if (!isset($CFG->debugdisplay)) {
2943         $CFG->debugdisplay = ini_get_bool('display_errors');
2944     }
2946     if ($message) {
2947         if (!$backtrace) {
2948             $backtrace = debug_backtrace();
2949         }
2950         $from = format_backtrace($backtrace, CLI_SCRIPT);
2951         if (!empty($UNITTEST->running)) {
2952             // When the unit tests are running, any call to trigger_error
2953             // is intercepted by the test framework and reported as an exception.
2954             // Therefore, we cannot use trigger_error during unit tests.
2955             // At the same time I do not think we should just discard those messages,
2956             // so displaying them on-screen seems like the only option. (MDL-20398)
2957             echo '<div class="notifytiny">' . $message . $from . '</div>';
2959         } else if (NO_DEBUG_DISPLAY) {
2960             // script does not want any errors or debugging in output,
2961             // we send the info to error log instead
2962             error_log('Debugging: ' . $message . $from);
2964         } else if ($CFG->debugdisplay) {
2965             if (!defined('DEBUGGING_PRINTED')) {
2966                 define('DEBUGGING_PRINTED', 1); // indicates we have printed something
2967             }
2968             echo '<div class="notifytiny">' . $message . $from . '</div>';
2970         } else {
2971             trigger_error($message . $from, E_USER_NOTICE);
2972         }
2973     }
2974     return true;
2977 /**
2978 * Outputs a HTML comment to the browser. This is used for those hard-to-debug
2979 * pages that use bits from many different files in very confusing ways (e.g. blocks).
2981 * <code>print_location_comment(__FILE__, __LINE__);</code>
2983 * @param string $file
2984 * @param integer $line
2985 * @param boolean $return Whether to return or print the comment
2986 * @return string|void Void unless true given as third parameter
2987 */
2988 function print_location_comment($file, $line, $return = false)
2990     if ($return) {
2991         return "<!-- $file at line $line -->\n";
2992     } else {
2993         echo "<!-- $file at line $line -->\n";
2994     }
2998 /**
2999  * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
3000  */
3001 function right_to_left() {
3002     return (get_string('thisdirection', 'langconfig') === 'rtl');
3006 /**
3007  * Returns swapped left<=>right if in RTL environment.
3008  * part of RTL support
3009  *
3010  * @param string $align align to check
3011  * @return string
3012  */
3013 function fix_align_rtl($align) {
3014     if (!right_to_left()) {
3015         return $align;
3016     }
3017     if ($align=='left')  { return 'right'; }
3018     if ($align=='right') { return 'left'; }
3019     return $align;
3023 /**
3024  * Returns true if the page is displayed in a popup window.
3025  * Gets the information from the URL parameter inpopup.
3026  *
3027  * @todo Use a central function to create the popup calls all over Moodle and
3028  * In the moment only works with resources and probably questions.
3029  *
3030  * @return boolean
3031  */
3032 function is_in_popup() {
3033     $inpopup = optional_param('inpopup', '', PARAM_BOOL);
3035     return ($inpopup);
3038 /**
3039  * To use this class.
3040  * - construct
3041  * - call create (or use the 3rd param to the constructor)
3042  * - call update or update_full repeatedly
3043  *
3044  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3045  * @package moodlecore
3046  */
3047 class progress_bar {
3048     /** @var string html id */
3049     private $html_id;
3050     /** @var int */
3051     private $percent;
3052     /** @var int */
3053     private $width;
3054     /** @var int */
3055     private $lastcall;
3056     /** @var int */
3057     private $time_start;
3058     private $minimum_time = 2; //min time between updates.
3059     /**
3060      * Constructor
3061      *
3062      * @param string $html_id
3063      * @param int $width
3064      * @param bool $autostart Default to false
3065      */
3066     public function __construct($html_id = '', $width = 500, $autostart = false){
3067         if (!empty($html_id)) {
3068             $this->html_id  = $html_id;
3069         } else {
3070             $this->html_id  = uniqid();
3071         }
3072         $this->width = $width;
3073         $this->restart();
3074         if($autostart){
3075             $this->create();
3076         }
3077     }
3078     /**
3079       * Create a new progress bar, this function will output html.
3080       *
3081       * @return void Echo's output
3082       */
3083     public function create(){
3084             flush();
3085             $this->lastcall->pt = 0;
3086             $this->lastcall->time = microtime(true);
3087             if (CLI_SCRIPT) {
3088                 return; // temporary solution for cli scripts
3089             }
3090             $htmlcode = <<<EOT
3091             <div style="text-align:center;width:{$this->width}px;clear:both;padding:0;margin:0 auto;">
3092                 <h2 id="status_{$this->html_id}" style="text-align: center;margin:0 auto"></h2>
3093                 <p id="time_{$this->html_id}"></p>
3094                 <div id="bar_{$this->html_id}" style="border-style:solid;border-width:1px;width:500px;height:50px;">
3095                     <div id="progress_{$this->html_id}"
3096                     style="text-align:center;background:#FFCC66;width:4px;border:1px
3097                     solid gray;height:38px; padding-top:10px;">&nbsp;<span id="pt_{$this->html_id}"></span>
3098                     </div>
3099                 </div>
3100             </div>
3101 EOT;
3102             echo $htmlcode;
3103             flush();
3104     }
3105     /**
3106      * Update the progress bar
3107      *
3108      * @param int $percent from 1-100
3109      * @param string $msg
3110      * @param mixed $es
3111      * @return void Echo's output
3112      */
3113     private function _update($percent, $msg, $es){
3114         global $PAGE;
3115         if(empty($this->time_start)){
3116             $this->time_start = microtime(true);
3117         }
3118         $this->percent = $percent;
3119         $this->lastcall->time = microtime(true);
3120         $this->lastcall->pt   = $percent;
3121         $w = $this->percent * $this->width;
3122         if (CLI_SCRIPT) {
3123             return; // temporary solution for cli scripts
3124         }
3125         if ($es === null){
3126             $es = "Infinity";
3127         }
3128         echo html_writer::script(js_writer::function_call('update_progress_bar', Array($this->html_id, $w, $this->percent, $msg, $es)));
3129         flush();
3130     }
3131     /**
3132       * estimate time
3133       *
3134       * @param int $curtime the time call this function
3135       * @param int $percent from 1-100
3136       * @return mixed Null, or int
3137       */
3138     private function estimate($curtime, $pt){
3139         $consume = $curtime - $this->time_start;
3140         $one = $curtime - $this->lastcall->time;
3141         $this->percent = $pt;
3142         $percent = $pt - $this->lastcall->pt;
3143         if ($percent != 0) {
3144             $left = ($one / $percent) - $consume;
3145         } else {
3146             return null;
3147         }
3148         if($left < 0) {
3149             return 0;
3150         } else {
3151             return $left;
3152         }
3153     }
3154     /**
3155       * Update progress bar according percent
3156       *
3157       * @param int $percent from 1-100
3158       * @param string $msg the message needed to be shown
3159       */
3160     public function update_full($percent, $msg){
3161         $percent = max(min($percent, 100), 0);
3162         if ($percent != 100 && ($this->lastcall->time + $this->minimum_time) > microtime(true)){
3163             return;
3164         }
3165         $this->_update($percent, 100, $msg);
3166     }
3167     /**
3168       * Update progress bar according the number of tasks
3169       *
3170       * @param int $cur current task number
3171       * @param int $total total task number
3172       * @param string $msg message
3173       */
3174     public function update($cur, $total, $msg){
3175         $cur = max($cur, 0);
3176         if ($cur >= $total){
3177             $percent = 1;
3178         } else {
3179             $percent = $cur / $total;
3180         }
3181         /**
3182         if ($percent != 1 && ($this->lastcall->time + $this->minimum_time) > microtime(true)){
3183             return;
3184         }
3185         */
3186         $es = $this->estimate(microtime(true), $percent);
3187         $this->_update($percent, $msg, $es);
3188     }
3189     /**
3190      * Restart the progress bar.
3191      */
3192     public function restart(){
3193         $this->percent  = 0;
3194         $this->lastcall = new stdClass;
3195         $this->lastcall->pt = 0;
3196         $this->lastcall->time = microtime(true);
3197         $this->time_start  = 0;
3198     }
3201 /**
3202  * Use this class from long operations where you want to output occasional information about
3203  * what is going on, but don't know if, or in what format, the output should be.
3204  *
3205  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3206  * @package moodlecore
3207  */
3208 abstract class progress_trace {
3209     /**
3210      * Ouput an progress message in whatever format.
3211      * @param string $message the message to output.
3212      * @param integer $depth indent depth for this message.
3213      */
3214     abstract public function output($message, $depth = 0);
3216     /**
3217      * Called when the processing is finished.
3218      */
3219     public function finished() {
3220     }
3223 /**
3224  * This subclass of progress_trace does not ouput anything.
3225  *
3226  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3227  * @package moodlecore
3228  */
3229 class null_progress_trace extends progress_trace {
3230     /**
3231      * Does Nothing
3232      *
3233      * @param string $message
3234      * @param int $depth
3235      * @return void Does Nothing
3236      */
3237     public function output($message, $depth = 0) {
3238     }
3241 /**
3242  * This subclass of progress_trace outputs to plain text.
3243  *
3244  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3245  * @package moodlecore
3246  */
3247 class text_progress_trace extends progress_trace {
3248     /**
3249      * Output the trace message
3250      *
3251      * @param string $message
3252      * @param int $depth
3253      * @return void Output is echo'd
3254      */
3255     public function output($message, $depth = 0) {
3256         echo str_repeat('  ', $depth), $message, "\n";
3257         flush();
3258     }
3261 /**
3262  * This subclass of progress_trace outputs as HTML.
3263  *
3264  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3265  * @package moodlecore
3266  */
3267 class html_progress_trace extends progress_trace {
3268     /**
3269      * Output the trace message
3270      *
3271      * @param string $message
3272      * @param int $depth
3273      * @return void Output is echo'd
3274      */
3275     public function output($message, $depth = 0) {
3276         echo '<p>', str_repeat('&#160;&#160;', $depth), htmlspecialchars($message), "</p>\n";
3277         flush();
3278     }
3281 /**
3282  * HTML List Progress Tree
3283  *
3284  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3285  * @package moodlecore
3286  */
3287 class html_list_progress_trace extends progress_trace {
3288     /** @var int */
3289     protected $currentdepth = -1;
3291     /**
3292      * Echo out the list
3293      *
3294      * @param string $message The message to display
3295      * @param int $depth
3296      * @return void Output is echoed
3297      */
3298     public function output($message, $depth = 0) {
3299         $samedepth = true;
3300         while ($this->currentdepth > $depth) {
3301             echo "</li>\n</ul>\n";
3302             $this->currentdepth -= 1;
3303             if ($this->currentdepth == $depth) {
3304                 echo '<li>';
3305             }
3306             $samedepth = false;
3307         }
3308         while ($this->currentdepth < $depth) {
3309             echo "<ul>\n<li>";
3310             $this->currentdepth += 1;
3311             $samedepth = false;
3312         }
3313         if ($samedepth) {
3314             echo "</li>\n<li>";
3315         }
3316         echo htmlspecialchars($message);
3317         flush();
3318     }
3320     /**
3321      * Called when the processing is finished.
3322      */
3323     public function finished() {
3324         while ($this->currentdepth >= 0) {
3325             echo "</li>\n</ul>\n";
3326             $this->currentdepth -= 1;
3327         }
3328     }
3331 /**
3332  * Returns a localized sentence in the current language summarizing the current password policy
3333  *
3334  * @todo this should be handled by a function/method in the language pack library once we have a support for it
3335  * @uses $CFG
3336  * @return string
3337  */
3338 function print_password_policy() {
3339     global $CFG;
3341     $message = '';
3342     if (!empty($CFG->passwordpolicy)) {
3343         $messages = array();
3344         $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength);
3345         if (!empty($CFG->minpassworddigits)) {
3346             $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits);
3347         }
3348         if (!empty($CFG->minpasswordlower)) {
3349             $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower);
3350         }
3351         if (!empty($CFG->minpasswordupper)) {
3352             $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper);
3353         }
3354         if (!empty($CFG->minpasswordnonalphanum)) {
3355             $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3356         }
3358         $messages = join(', ', $messages); // this is ugly but we do not have anything better yet...
3359         $message = get_string('informpasswordpolicy', 'auth', $messages);
3360     }
3361     return $message;
3364 function create_ufo_inline($id, $args) {
3365     global $CFG;
3366     // must not use $PAGE, $THEME, $COURSE etc. because the result is cached!
3367     // unfortunately this ufo.js can not be cached properly because we do not have access to current $CFG either
3368     $jsoutput = html_writer::script('', $CFG->wwwroot.'/lib/ufo.js');
3369     $jsoutput .= html_writer::script(js_writer::function_call('M.util.create_UFO_object', array($id, $args)));
3370     return $jsoutput;
3373 function create_flowplayer($id, $fileurl, $type='flv', $color='#000000') {
3374     global $CFG;
3376     $playerpath = $CFG->wwwroot.'/filter/mediaplugin/'.$type.'player.swf';
3377     $jsoutput = html_writer::script('', $CFG->wwwroot.'/lib/flowplayer.js');
3379     if ($type == 'flv') {
3380         $jsoutput .= html_writer::script(js_writer::function_call('M.util.init_flvflowplayer', array($id, $playerpath, $fileurl)));
3381     } else if ($type == 'mp3') {
3382         $audioplayerpath = $CFG->wwwroot .'/filter/mediaplugin/flowplayer.audio.swf';
3383         $jsoutput .= html_writer::script(js_writer::function_call('M.util.init_mp3flowplayerplugin', array($id, $playerpath, $audioplayerpath, $fileurl, $color)));
3384     }
3386     return $jsoutput;