MDL-21400 finalising JS api - removing ->on_dom_ready (now bool param in js() and...
[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 moodlecore
29  * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
30  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
31  */
33 /// Constants
35 /// Define text formatting types ... eventually we can add Wiki, BBcode etc
37 /**
38  * Does all sorts of transformations and filtering
39  */
40 define('FORMAT_MOODLE',   '0');   // Does all sorts of transformations and filtering
42 /**
43  * Plain HTML (with some tags stripped)
44  */
45 define('FORMAT_HTML',     '1');   // Plain HTML (with some tags stripped)
47 /**
48  * Plain text (even tags are printed in full)
49  */
50 define('FORMAT_PLAIN',    '2');   // Plain text (even tags are printed in full)
52 /**
53  * Wiki-formatted text
54  * Deprecated: left here just to note that '3' is not used (at the moment)
55  * and to catch any latent wiki-like text (which generates an error)
56  */
57 define('FORMAT_WIKI',     '3');   // Wiki-formatted text
59 /**
60  * Markdown-formatted text http://daringfireball.net/projects/markdown/
61  */
62 define('FORMAT_MARKDOWN', '4');   // Markdown-formatted text http://daringfireball.net/projects/markdown/
64 /**
65  * TRUSTTEXT marker - if present in text, text cleaning should be bypassed
66  */
67 define('TRUSTTEXT', '#####TRUSTTEXT#####');
69 /**
70  * A moodle_url comparison using this flag will return true if the base URLs match, params are ignored
71  */
72 define('URL_MATCH_BASE', 0);
73 /**
74  * A moodle_url comparison using this flag will return true if the base URLs match and the params of url1 are part of url2
75  */
76 define('URL_MATCH_PARAMS', 1);
77 /**
78  * A moodle_url comparison using this flag will return true if the two URLs are identical, except for the order of the params
79  */
80 define('URL_MATCH_EXACT', 2);
82 /**
83  * Allowed tags - string of html tags that can be tested against for safe html tags
84  * @global string $ALLOWED_TAGS
85  * @name $ALLOWED_TAGS
86  */
87 global $ALLOWED_TAGS;
88 $ALLOWED_TAGS =
89 '<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>';
91 /**
92  * Allowed protocols - array of protocols that are safe to use in links and so on
93  * @global string $ALLOWED_PROTOCOLS
94  * @name $ALLOWED_PROTOCOLS
95  */
96 $ALLOWED_PROTOCOLS = array('http', 'https', 'ftp', 'news', 'mailto', 'rtsp', 'teamspeak', 'gopher', 'mms',
97                            'color', 'callto', 'cursor', 'text-align', 'font-size', 'font-weight', 'font-style', 'font-family',
98                            'border', 'margin', 'padding', 'background', 'background-color', 'text-decoration');   // CSS as well to get through kses
101 /// Functions
103 /**
104  * Add quotes to HTML characters
105  *
106  * Returns $var with HTML characters (like "<", ">", etc.) properly quoted.
107  * This function is very similar to {@link p()}
108  *
109  * @todo Remove obsolete param $obsolete if not used anywhere
110  *
111  * @param string $var the string potentially containing HTML characters
112  * @param boolean $obsolete no longer used.
113  * @return string
114  */
115 function s($var, $obsolete = false) {
117     if ($var == '0') {  // for integer 0, boolean false, string '0'
118         return '0';
119     }
121     return preg_replace("/&amp;(#\d+);/i", "&$1;", htmlspecialchars($var));
124 /**
125  * Add quotes to HTML characters
126  *
127  * Prints $var with HTML characters (like "<", ">", etc.) properly quoted.
128  * This function simply calls {@link s()}
129  * @see s()
130  *
131  * @todo Remove obsolete param $obsolete if not used anywhere
132  *
133  * @param string $var the string potentially containing HTML characters
134  * @param boolean $obsolete no longer used.
135  * @return string
136  */
137 function p($var, $obsolete = false) {
138     echo s($var, $obsolete);
141 /**
142  * Does proper javascript quoting.
143  *
144  * Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
145  *
146  * @param mixed $var String, Array, or Object to add slashes to
147  * @return mixed quoted result
148  */
149 function addslashes_js($var) {
150     if (is_string($var)) {
151         $var = str_replace('\\', '\\\\', $var);
152         $var = str_replace(array('\'', '"', "\n", "\r", "\0"), array('\\\'', '\\"', '\\n', '\\r', '\\0'), $var);
153         $var = str_replace('</', '<\/', $var);   // XHTML compliance
154     } else if (is_array($var)) {
155         $var = array_map('addslashes_js', $var);
156     } else if (is_object($var)) {
157         $a = get_object_vars($var);
158         foreach ($a as $key=>$value) {
159           $a[$key] = addslashes_js($value);
160         }
161         $var = (object)$a;
162     }
163     return $var;
166 /**
167  * Remove query string from url
168  *
169  * Takes in a URL and returns it without the querystring portion
170  *
171  * @param string $url the url which may have a query string attached
172  * @return string The remaining URL
173  */
174  function strip_querystring($url) {
176     if ($commapos = strpos($url, '?')) {
177         return substr($url, 0, $commapos);
178     } else {
179         return $url;
180     }
183 /**
184  * Returns the URL of the HTTP_REFERER, less the querystring portion if required
185  *
186  * @uses $_SERVER
187  * @param boolean $stripquery if true, also removes the query part of the url.
188  * @return string The resulting referer or emtpy string
189  */
190 function get_referer($stripquery=true) {
191     if (isset($_SERVER['HTTP_REFERER'])) {
192         if ($stripquery) {
193             return strip_querystring($_SERVER['HTTP_REFERER']);
194         } else {
195             return $_SERVER['HTTP_REFERER'];
196         }
197     } else {
198         return '';
199     }
203 /**
204  * Returns the name of the current script, WITH the querystring portion.
205  *
206  * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
207  * return different things depending on a lot of things like your OS, Web
208  * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
209  * <b>NOTE:</b> This function returns false if the global variables needed are not set.
210  *
211  * @global string
212  * @return mixed String, or false if the global variables needed are not set
213  */
214 function me() {
215     global $ME;
216     return $ME;
219 /**
220  * Returns the name of the current script, WITH the full URL.
221  *
222  * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
223  * return different things depending on a lot of things like your OS, Web
224  * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.
225  * <b>NOTE:</b> This function returns false if the global variables needed are not set.
226  *
227  * Like {@link me()} but returns a full URL
228  * @see me()
229  *
230  * @global string
231  * @return mixed String, or false if the global variables needed are not set
232  */
233 function qualified_me() {
234     global $FULLME;
235     return $FULLME;
238 /**
239  * Class for creating and manipulating urls.
240  *
241  * It can be used in moodle pages where config.php has been included without any further includes.
242  *
243  * It is useful for manipulating urls with long lists of params.
244  * One situation where it will be useful is a page which links to itself to perfrom various actions
245  * and / or to process form data. A moodle_url object :
246  * can be created for a page to refer to itself with all the proper get params being passed from page call to
247  * page call and methods can be used to output a url including all the params, optionally adding and overriding
248  * params and can also be used to
249  *     - output the url without any get params
250  *     - and output the params as hidden fields to be output within a form
251  *
252  * @link http://docs.moodle.org/en/Development:lib/weblib.php_moodle_url See short write up here
253  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
254  * @package moodlecore
255  */
256 class moodle_url {
257     /**
258      * Scheme, ex.: http, https
259      * @var string
260      */
261     protected $scheme = '';
262     /**
263      * hostname
264      * @var string
265      */
266     protected $host = '';
267     /**
268      * Port number, empty means default 80 or 443 in case of http
269      * @var unknown_type
270      */
271     protected $port = '';
272     /**
273      * Username for http auth
274      * @var string
275      */
276     protected $user = '';
277     /**
278      * Password for http auth
279      * @var string
280      */
281     protected $pass = '';
282     /**
283      * Script path
284      * @var string
285      */
286     protected $path = '';
287     /**
288      * Optional slash argument value
289      * @var string
290      */
291     protected $slashargument = '';
292     /**
293      * Anchor, may be also empty, null means none
294      * @var string
295      */
296     protected $anchor = null;
297     /**
298      * Url parameters as associative array
299      * @var array
300      */
301     protected $params = array(); // Associative array of query string params
303     /**
304      * Create new instance of moodle_url.
305      *
306      * @param moodle_url|string $url - moodle_url means make a copy of another
307      *      moodle_url and change parameters, string means full url or shortened
308      *      form (ex.: '/course/view.php'). It is strongly encouraged to not include
309      *      query string because it may result in double encoded values
310      * @param array $params these params override current params or add new
311      */
312     public function __construct($url, array $params = null) {
313         global $CFG;
315         if ($url instanceof moodle_url) {
316             $this->scheme = $url->scheme;
317             $this->host = $url->host;
318             $this->port = $url->port;
319             $this->user = $url->user;
320             $this->pass = $url->pass;
321             $this->path = $url->path;
322             $this->slashargument = $url->slashargument;
323             $this->params = $url->params;
324             $this->anchor = $url->anchor;
326         } else {
327             // detect if anchor used
328             $apos = strpos($url, '#');
329             if ($apos !== false) {
330                 $anchor = substr($url, $apos);
331                 $anchor = ltrim($anchor, '#');
332                 $this->set_anchor($anchor);
333                 $url = substr($url, 0, $apos);
334             }
336             // normalise shortened form of our url ex.: '/course/view.php'
337             if (strpos($url, '/') === 0) {
338                 // we must not use httpswwwroot here, because it might be url of other page,
339                 // devs have to use httpswwwroot explicitly when creating new moodle_url
340                 $url = $CFG->wwwroot.$url;
341             }
343             // now fix the admin links if needed, no need to mess with httpswwwroot
344             if ($CFG->admin !== 'admin') {
345                 if (strpos($url, "$CFG->wwwroot/admin/") === 0) {
346                     $url = str_replace("$CFG->wwwroot/admin/", "$CFG->wwwroot/$CFG->admin/", $url);
347                 }
348             }
350             // parse the $url
351             $parts = parse_url($url);
352             if ($parts === false) {
353                 throw new moodle_exception('invalidurl');
354             }
355             if (isset($parts['query'])) {
356                 // note: the values may not be correctly decoded,
357                 //       url parameters should be always passed as array
358                 parse_str(str_replace('&amp;', '&', $parts['query']), $this->params);
359             }
360             unset($parts['query']);
361             foreach ($parts as $key => $value) {
362                 $this->$key = $value;
363             }
365             // detect slashargument value from path - we do not support directory names ending with .php
366             $pos = strpos($this->path, '.php/');
367             if ($pos !== false) {
368                 $this->slashargument = substr($this->path, $pos + 4);
369                 $this->path = substr($this->path, 0, $pos + 4);
370             }
371         }
373         $this->params($params);
374     }
376     /**
377      * Add an array of params to the params for this url.
378      *
379      * The added params override existing ones if they have the same name.
380      *
381      * @param array $params Defaults to null. If null then returns all params.
382      * @return array Array of Params for url.
383      */
384     public function params(array $params = null) {
385         $params = (array)$params;
387         foreach ($params as $key=>$value) {
388             if (is_int($key)) {
389                 throw new coding_exception('Url parameters can not have numeric keys!');
390             }
391             if (is_array($value)) {
392                 throw new coding_exception('Url parameters values can not be arrays!');
393             }
394             if (is_object($value) and !method_exists($value, '__toString')) {
395                 throw new coding_exception('Url parameters values can not be objects, unless __toString() is defined!');
396             }
397             $this->params[$key] = (string)$value;
398         }
399         return $this->params;
400     }
402     /**
403      * Remove all params if no arguments passed.
404      * Remove selected params if arguments are passed.
405      *
406      * Can be called as either remove_params('param1', 'param2')
407      * or remove_params(array('param1', 'param2')).
408      *
409      * @param mixed $params either an array of param names, or a string param name,
410      * @param string $params,... any number of additional param names.
411      * @return array url parameters
412      */
413     public function remove_params($params = null) {
414         if (!is_array($params)) {
415             $params = func_get_args();
416         }
417         foreach ($params as $param) {
418             unset($this->params[$param]);
419         }
420         return $this->params;
421     }
423     /**
424      * Remove all url parameters
425      * @param $params
426      * @return void
427      */
428     public function remove_all_params($params = null) {
429         $this->params = array();
430         $this->slashargument = '';
431     }
433     /**
434      * Add a param to the params for this url.
435      *
436      * The added param overrides existing one if they have the same name.
437      *
438      * @param string $paramname name
439      * @param string $newvalue Param value. If new value specified current value is overriden or parameter is added
440      * @return mixed string parameter value, null if parameter does not exist
441      */
442     public function param($paramname, $newvalue = '') {
443         if (func_num_args() > 1) {
444             // set new value
445             $this->params(array($paramname=>$newvalue));
446         }
447         if (isset($this->params[$paramname])) {
448             return $this->params[$paramname];
449         } else {
450             return null;
451         }
452     }
454     /**
455      * Merges parameters and validates them
456      * @param array $overrideparams
457      * @return array merged parameters
458      */
459     protected function merge_overrideparams(array $overrideparams = null) {
460         $overrideparams = (array)$overrideparams;
461         $params = $this->params;
462         foreach ($overrideparams as $key=>$value) {
463             if (is_int($key)) {
464                 throw new coding_error('Overriden parameters can not have numeric keys!');
465             }
466             if (is_array($value)) {
467                 throw new coding_error('Overriden parameters values can not be arrays!');
468             }
469             if (is_object($value) and !method_exists($value, '__toString')) {
470                 throw new coding_error('Overriden parameters values can not be objects, unless __toString() is defined!');
471             }
472             $params[$key] = (string)$value;
473         }
474         return $params;
475     }
477     /**
478      * Get the params as as a query string.
479      * This method should not be used outside of this method.
480      *
481      * @param boolean $escaped Use &amp; as params separator instead of plain &
482      * @param array $overrideparams params to add to the output params, these
483      *      override existing ones with the same name.
484      * @return string query string that can be added to a url.
485      */
486     public function get_query_string($escaped = true, array $overrideparams = null) {
487         $arr = array();
488         $params = $this->merge_overrideparams($overrideparams);
489         foreach ($params as $key => $val) {
490            $arr[] = rawurlencode($key)."=".rawurlencode($val);
491         }
492         if ($escaped) {
493             return implode('&amp;', $arr);
494         } else {
495             return implode('&', $arr);
496         }
497     }
499     /**
500      * Shortcut for printing of encoded URL.
501      * @return string
502      */
503     public function __toString() {
504         return $this->out(true);
505     }
507     /**
508      * Output url
509      *
510      * If you use the returned URL in HTML code, you want the escaped ampersands. If you use
511      * the returned URL in HTTP headers, you want $escaped=false.
512      *
513      * @param boolean $escaped Use &amp; as params separator instead of plain &
514      * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
515      * @return string Resulting URL
516      */
517     public function out($escaped = true, array $overrideparams = null) {
518         if (!is_bool($escaped)) {
519             debugging('Escape parameter must be of type boolean, '.gettype($escaped).' given instead.');
520         }
522         $uri = $this->out_omit_querystring().$this->slashargument;
524         $querystring = $this->get_query_string($escaped, $overrideparams);
525         if ($querystring !== '') {
526             $uri .= '?' . $querystring;
527         }
528         if (!is_null($this->anchor)) {
529             $uri .= '#'.$this->anchor;
530         }
532         return $uri;
533     }
535     /**
536      * Returns url without parameters, everything before '?'.
537      * @return string
538      */
539     public function out_omit_querystring() {
540         $uri = $this->scheme ? $this->scheme.':'.((strtolower($this->scheme) == 'mailto') ? '':'//'): '';
541         $uri .= $this->user ? $this->user.($this->pass? ':'.$this->pass:'').'@':'';
542         $uri .= $this->host ? $this->host : '';
543         $uri .= $this->port ? ':'.$this->port : '';
544         $uri .= $this->path ? $this->path : '';
545         return $uri;
546     }
548     /**
549      * Compares this moodle_url with another
550      * See documentation of constants for an explanation of the comparison flags.
551      * @param moodle_url $url The moodle_url object to compare
552      * @param int $matchtype The type of comparison (URL_MATCH_BASE, URL_MATCH_PARAMS, URL_MATCH_EXACT)
553      * @return boolean
554      */
555     public function compare(moodle_url $url, $matchtype = URL_MATCH_EXACT) {
557         $baseself = $this->out_omit_querystring();
558         $baseother = $url->out_omit_querystring();
560         // Append index.php if there is no specific file
561         if (substr($baseself,-1)=='/') {
562             $baseself .= 'index.php';
563         }
564         if (substr($baseother,-1)=='/') {
565             $baseother .= 'index.php';
566         }
568         // Compare the two base URLs
569         if ($baseself != $baseother) {
570             return false;
571         }
573         if ($matchtype == URL_MATCH_BASE) {
574             return true;
575         }
577         $urlparams = $url->params();
578         foreach ($this->params() as $param => $value) {
579             if ($param == 'sesskey') {
580                 continue;
581             }
582             if (!array_key_exists($param, $urlparams) || $urlparams[$param] != $value) {
583                 return false;
584             }
585         }
587         if ($matchtype == URL_MATCH_PARAMS) {
588             return true;
589         }
591         foreach ($urlparams as $param => $value) {
592             if ($param == 'sesskey') {
593                 continue;
594             }
595             if (!array_key_exists($param, $this->params()) || $this->param($param) != $value) {
596                 return false;
597             }
598         }
600         return true;
601     }
603     /**
604      * Sets the anchor for the URI (the bit after the hash)
605      * @param string $anchor null means remove previous
606      */
607     public function set_anchor($anchor) {
608         if (is_null($anchor)) {
609             // remove
610             $this->anchor = null;
611         } else if ($anchor === '') {
612             // special case, used as empty link
613             $this->anchor = '';
614         } else if (preg_match('|[a-zA-Z\_\:][a-zA-Z0-9\_\-\.\:]*|', $anchor)) {
615             // Match the anchor against the NMTOKEN spec
616             $this->anchor = $anchor;
617         } else {
618             // bad luck, no valid anchor found
619             $this->anchor = null;
620         }
621     }
623     /**
624      * Sets the url slashargument value
625      * @param string $path usually file path
626      * @param string $parameter name of page parameter if slasharguments not supported
627      * @param bool $supported usually null, then it depends on $CFG->slasharguments, use true or false for other servers
628      * @return void
629      */
630     public function set_slashargument($path, $parameter='file', $supported=null) {
631         global $CFG;
632         if (is_null($supported)) {
633             $supported = $CFG->slasharguments;
634         }
636         if ($supported) {
637             $parts = explode('/', $path);
638             $parts = array_map('rawurlencode', $parts);
639             $path  = implode('/', $parts);
640             $this->slashargument = $path;
641             unset($this->params[$parameter]);
643         } else {
644             $this->slashargument = '';
645             $this->params[$parameter] = $path;
646         }
647     }
649     // == static factory methods ==
651     /**
652      * General moodle file url.
653      * @param string $urlbase the script serving the file
654      * @param string $path
655      * @param bool $forcedownload
656      * @return moodle_url
657      */
658     public static function make_file_url($urlbase, $path, $forcedownload=false) {
659         global $CFG;
661         $params = array();
662         if ($forcedownload) {
663             $params['forcedownload'] = 1;
664         }
666         $url = new moodle_url($urlbase, $params);
667         $url->set_slashargument($path);
669         return $url;
670     }
672     /**
673      * Factory method for creation of url pointing to plugin file.
674      * Please note this method can be used only from the plugins to
675      * create urls of own files, it must not be used outside of plugins!
676      * @param int $contextid
677      * @param string $area
678      * @param int $itemid
679      * @param string $pathname
680      * @param string $filename
681      * @param bool $forcedownload
682      * @return moodle_url
683      */
684     public static function make_pluginfile_url($contextid, $area, $itemid, $pathname, $filename, $forcedownload=false) {
685         global $CFG;
686         $urlbase = "$CFG->httpswwwroot/pluginfile.php";
687         return self::make_file_url($urlbase, '/'.$contextid.'/'.$area.'/'.$itemid.$pathname.$filename, $forcedownload);
688     }
690     /**
691      * Factory method for creation of url pointing to draft
692      * file of current user.
693      * @param int $itemid draft item id
694      * @param string $pathname
695      * @param string $filename
696      * @param bool $forcedownload
697      * @return moodle_url
698      */
699     public static function make_draftfile_url($itemid, $pathname, $filename, $forcedownload=false) {
700         global $CFG, $USER;
701         $urlbase = "$CFG->httpswwwroot/draftfile.php";
702         $context = get_context_instance(CONTEXT_USER, $USER->id);
704         return self::make_file_url($urlbase, '/'.$context->id.'/user_draft/'.$itemid.$pathname.$filename, $forcedownload);
705     }
707     /**
708      * Factory method for creating of links to legacy
709      * course files.
710      * @param int $courseid
711      * @param string $filepath
712      * @param bool $forcedownload
713      * @return moodle_url
714      */
715     public static function make_legacyfile_url($courseid, $filepath, $forcedownload=false) {
716         global $CFG;
718         $urlbase = "$CFG->wwwroot/file.php";
719         return self::make_file_url($urlbase, '/'.$courseid.'/'.$filepath, $forcedownload);
720     }
723 /**
724  * Determine if there is data waiting to be processed from a form
725  *
726  * Used on most forms in Moodle to check for data
727  * Returns the data as an object, if it's found.
728  * This object can be used in foreach loops without
729  * casting because it's cast to (array) automatically
730  *
731  * Checks that submitted POST data exists and returns it as object.
732  *
733  * @uses $_POST
734  * @return mixed false or object
735  */
736 function data_submitted() {
738     if (empty($_POST)) {
739         return false;
740     } else {
741         return (object)$_POST;
742     }
745 /**
746  * Given some normal text this function will break up any
747  * long words to a given size by inserting the given character
748  *
749  * It's multibyte savvy and doesn't change anything inside html tags.
750  *
751  * @param string $string the string to be modified
752  * @param int $maxsize maximum length of the string to be returned
753  * @param string $cutchar the string used to represent word breaks
754  * @return string
755  */
756 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
758 /// Loading the textlib singleton instance. We are going to need it.
759     $textlib = textlib_get_instance();
761 /// First of all, save all the tags inside the text to skip them
762     $tags = array();
763     filter_save_tags($string,$tags);
765 /// Process the string adding the cut when necessary
766     $output = '';
767     $length = $textlib->strlen($string);
768     $wordlength = 0;
770     for ($i=0; $i<$length; $i++) {
771         $char = $textlib->substr($string, $i, 1);
772         if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
773             $wordlength = 0;
774         } else {
775             $wordlength++;
776             if ($wordlength > $maxsize) {
777                 $output .= $cutchar;
778                 $wordlength = 0;
779             }
780         }
781         $output .= $char;
782     }
784 /// Finally load the tags back again
785     if (!empty($tags)) {
786         $output = str_replace(array_keys($tags), $tags, $output);
787     }
789     return $output;
792 /**
793  * Try and close the current window using JavaScript, either immediately, or after a delay.
794  *
795  * Echo's out the resulting XHTML & javascript
796  *
797  * @global object
798  * @global object
799  * @param integer $delay a delay in seconds before closing the window. Default 0.
800  * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
801  *      to reload the parent window before this one closes.
802  */
803 function close_window($delay = 0, $reloadopener = false) {
804     global $PAGE, $OUTPUT;
806     if (!$PAGE->headerprinted) {
807         $PAGE->set_title(get_string('closewindow'));
808         echo $OUTPUT->header();
809     } else {
810         $OUTPUT->container_end_all(false);
811     }
813     if ($reloadopener) {
814         $function = 'close_window_reloading_opener';
815     } else {
816         $function = 'close_window';
817     }
818     echo '<p class="centerpara">' . get_string('windowclosing') . '</p>';
820     $PAGE->requires->js_function_call($function, null, false, $delay);
822     echo $OUTPUT->footer();
823     exit;
826 /**
827  * Returns a string containing a link to the user documentation for the current
828  * page. Also contains an icon by default. Shown to teachers and admin only.
829  *
830  * @global object
831  * @global object
832  * @param string $text The text to be displayed for the link
833  * @param string $iconpath The path to the icon to be displayed
834  * @return string The link to user documentation for this current page
835  */
836 function page_doc_link($text='') {
837     global $CFG, $PAGE, $OUTPUT;
839     if (empty($CFG->docroot) || during_initial_install()) {
840         return '';
841     }
842     if (!has_capability('moodle/site:doclinks', $PAGE->context)) {
843         return '';
844     }
846     $path = $PAGE->docspath;
847     if (!$path) {
848         return '';
849     }
850     return $OUTPUT->doc_link($path, $text);
854 /**
855  * Validates an email to make sure it makes sense.
856  *
857  * @param string $address The email address to validate.
858  * @return boolean
859  */
860 function validate_email($address) {
862     return (preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
863                  '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
864                   '@'.
865                   '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
866                   '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
867                   $address));
870 /**
871  * Extracts file argument either from file parameter or PATH_INFO
872  * Note: $scriptname parameter is not needed anymore
873  *
874  * @global string
875  * @uses $_SERVER
876  * @uses PARAM_PATH
877  * @return string file path (only safe characters)
878  */
879 function get_file_argument() {
880     global $SCRIPT;
882     $relativepath = optional_param('file', FALSE, PARAM_PATH);
884     // then try extract file from PATH_INFO (slasharguments method)
885     if ($relativepath === false and isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
886         // check that PATH_INFO works == must not contain the script name
887         if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
888             $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
889         }
890     }
892     // note: we are not using any other way because they are not compatible with unicode file names ;-)
894     return $relativepath;
897 /**
898  * Just returns an array of text formats suitable for a popup menu
899  *
900  * @uses FORMAT_MOODLE
901  * @uses FORMAT_HTML
902  * @uses FORMAT_PLAIN
903  * @uses FORMAT_MARKDOWN
904  * @return array
905  */
906 function format_text_menu() {
908     return array (FORMAT_MOODLE => get_string('formattext'),
909                   FORMAT_HTML   => get_string('formathtml'),
910                   FORMAT_PLAIN  => get_string('formatplain'),
911                   FORMAT_MARKDOWN  => get_string('formatmarkdown'));
914 /**
915  * Given text in a variety of format codings, this function returns
916  * the text as safe HTML.
917  *
918  * This function should mainly be used for long strings like posts,
919  * answers, glossary items etc. For short strings @see format_string().
920  *
921  * @todo Finish documenting this function
922  *
923  * @global object
924  * @global object
925  * @global object
926  * @global object
927  * @uses FORMAT_MOODLE
928  * @uses FORMAT_HTML
929  * @uses FORMAT_PLAIN
930  * @uses FORMAT_WIKI
931  * @uses FORMAT_MARKDOWN
932  * @uses CLI_SCRIPT
933  * @staticvar array $croncache
934  * @param string $text The text to be formatted. This is raw text originally from user input.
935  * @param int $format Identifier of the text format to be used
936  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
937  * @param object $options ?
938  * @param int $courseid The courseid to use, defaults to $COURSE->courseid
939  * @return string
940  */
941 function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL) {
942     global $CFG, $COURSE, $DB, $PAGE;
944     static $croncache = array();
946     $hashstr = '';
948     if ($text === '') {
949         return ''; // no need to do any filters and cleaning
950     }
951     if (!empty($options->comments) && !empty($CFG->usecomments)) {
952         require_once($CFG->libdir . '/commentlib.php');
953         $comment = new comment($options->comments);
954         $cmt = $comment->init(true);
955     } else {
956         $cmt = '';
957     }
960     if (!isset($options->trusted)) {
961         $options->trusted = false;
962     }
963     if (!isset($options->noclean)) {
964         if ($options->trusted and trusttext_active()) {
965             // no cleaning if text trusted and noclean not specified
966             $options->noclean=true;
967         } else {
968             $options->noclean=false;
969         }
970     }
971     if (!isset($options->nocache)) {
972         $options->nocache=false;
973     }
974     if (!isset($options->smiley)) {
975         $options->smiley=true;
976     }
977     if (!isset($options->filter)) {
978         $options->filter=true;
979     }
980     if (!isset($options->para)) {
981         $options->para=true;
982     }
983     if (!isset($options->newlines)) {
984         $options->newlines=true;
985     }
986     if (empty($courseid)) {
987         $courseid = $COURSE->id;
988     }
990     if ($options->filter) {
991         $filtermanager = filter_manager::instance();
992     } else {
993         $filtermanager = new null_filter_manager();
994     }
995     $context = $PAGE->context;
997     if (!empty($CFG->cachetext) and empty($options->nocache)) {
998         $hashstr .= $text.'-'.$filtermanager->text_filtering_hash($context, $courseid).'-'.(int)$courseid.'-'.current_language().'-'.
999                 (int)$format.(int)$options->trusted.(int)$options->noclean.(int)$options->smiley.
1000                 (int)$options->filter.(int)$options->para.(int)$options->newlines;
1002         $time = time() - $CFG->cachetext;
1003         $md5key = md5($hashstr);
1004         if (CLI_SCRIPT) {
1005             if (isset($croncache[$md5key])) {
1006                 return $croncache[$md5key].$cmt;
1007             }
1008         }
1010         if ($oldcacheitem = $DB->get_record('cache_text', array('md5key'=>$md5key), '*', IGNORE_MULTIPLE)) {
1011             if ($oldcacheitem->timemodified >= $time) {
1012                 if (CLI_SCRIPT) {
1013                     if (count($croncache) > 150) {
1014                         reset($croncache);
1015                         $key = key($croncache);
1016                         unset($croncache[$key]);
1017                     }
1018                     $croncache[$md5key] = $oldcacheitem->formattedtext;
1019                 }
1020                 return $oldcacheitem->formattedtext.$cmt;
1021             }
1022         }
1023     }
1025     switch ($format) {
1026         case FORMAT_HTML:
1027             if ($options->smiley) {
1028                 replace_smilies($text);
1029             }
1030             if (!$options->noclean) {
1031                 $text = clean_text($text, FORMAT_HTML);
1032             }
1033             $text = $filtermanager->filter_text($text, $context, $courseid);
1034             break;
1036         case FORMAT_PLAIN:
1037             $text = s($text); // cleans dangerous JS
1038             $text = rebuildnolinktag($text);
1039             $text = str_replace('  ', '&nbsp; ', $text);
1040             $text = nl2br($text);
1041             break;
1043         case FORMAT_WIKI:
1044             // this format is deprecated
1045             $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle.  You should not be seeing
1046                      this message as all texts should have been converted to Markdown format instead.
1047                      Please post a bug report to http://moodle.org/bugs with information about where you
1048                      saw this message.</p>'.s($text);
1049             break;
1051         case FORMAT_MARKDOWN:
1052             $text = markdown_to_html($text);
1053             if ($options->smiley) {
1054                 replace_smilies($text);
1055             }
1056             if (!$options->noclean) {
1057                 $text = clean_text($text, FORMAT_HTML);
1058             }
1059             $text = $filtermanager->filter_text($text, $context, $courseid);
1060             break;
1062         default:  // FORMAT_MOODLE or anything else
1063             $text = text_to_html($text, $options->smiley, $options->para, $options->newlines);
1064             if (!$options->noclean) {
1065                 $text = clean_text($text, FORMAT_HTML);
1066             }
1067             $text = $filtermanager->filter_text($text, $context, $courseid);
1068             break;
1069     }
1071     // Warn people that we have removed this old mechanism, just in case they
1072     // were stupid enough to rely on it.
1073     if (isset($CFG->currenttextiscacheable)) {
1074         debugging('Once upon a time, Moodle had a truly evil use of global variables ' .
1075                 'called $CFG->currenttextiscacheable. The good news is that this no ' .
1076                 'longer exists. The bad news is that you seem to be using a filter that '.
1077                 'relies on it. Please seek out and destroy that filter code.', DEBUG_DEVELOPER);
1078     }
1080     if (empty($options->nocache) and !empty($CFG->cachetext)) {
1081         if (CLI_SCRIPT) {
1082             // special static cron cache - no need to store it in db if its not already there
1083             if (count($croncache) > 150) {
1084                 reset($croncache);
1085                 $key = key($croncache);
1086                 unset($croncache[$key]);
1087             }
1088             $croncache[$md5key] = $text;
1089             return $text.$cmt;
1090         }
1092         $newcacheitem = new object();
1093         $newcacheitem->md5key = $md5key;
1094         $newcacheitem->formattedtext = $text;
1095         $newcacheitem->timemodified = time();
1096         if ($oldcacheitem) {                               // See bug 4677 for discussion
1097             $newcacheitem->id = $oldcacheitem->id;
1098             try {
1099                 $DB->update_record('cache_text', $newcacheitem);   // Update existing record in the cache table
1100             } catch (dml_exception $e) {
1101                // It's unlikely that the cron cache cleaner could have
1102                // deleted this entry in the meantime, as it allows
1103                // some extra time to cover these cases.
1104             }
1105         } else {
1106             try {
1107                 $DB->insert_record('cache_text', $newcacheitem);   // Insert a new record in the cache table
1108             } catch (dml_exception $e) {
1109                // Again, it's possible that another user has caused this
1110                // record to be created already in the time that it took
1111                // to traverse this function.  That's OK too, as the
1112                // call above handles duplicate entries, and eventually
1113                // the cron cleaner will delete them.
1114             }
1115         }
1116     }
1117     return $text.$cmt;
1121 /**
1122  * Converts the text format from the value to the 'internal'
1123  * name or vice versa.
1124  *
1125  * $key can either be the value or the name and you get the other back.
1126  *
1127  * @uses FORMAT_MOODLE
1128  * @uses FORMAT_HTML
1129  * @uses FORMAT_PLAIN
1130  * @uses FORMAT_MARKDOWN
1131  * @param mixed $key int 0-4 or string one of 'moodle','html','plain','markdown'
1132  * @return mixed as above but the other way around!
1133  */
1134 function text_format_name( $key ) {
1135   $lookup = array();
1136   $lookup[FORMAT_MOODLE] = 'moodle';
1137   $lookup[FORMAT_HTML] = 'html';
1138   $lookup[FORMAT_PLAIN] = 'plain';
1139   $lookup[FORMAT_MARKDOWN] = 'markdown';
1140   $value = "error";
1141   if (!is_numeric($key)) {
1142     $key = strtolower( $key );
1143     $value = array_search( $key, $lookup );
1144   }
1145   else {
1146     if (isset( $lookup[$key] )) {
1147       $value =  $lookup[ $key ];
1148     }
1149   }
1150   return $value;
1153 /**
1154  * Resets all data related to filters, called during upgrade or when filter settings change.
1155  *
1156  * @global object
1157  * @global object
1158  * @return void
1159  */
1160 function reset_text_filters_cache() {
1161     global $CFG, $DB;
1163     $DB->delete_records('cache_text');
1164     $purifdir = $CFG->dataroot.'/cache/htmlpurifier';
1165     remove_dir($purifdir, true);
1168 /**
1169  * Given a simple string, this function returns the string
1170  * processed by enabled string filters if $CFG->filterall is enabled
1171  *
1172  * This function should be used to print short strings (non html) that
1173  * need filter processing e.g. activity titles, post subjects,
1174  * glossary concepts.
1175  *
1176  * @global object
1177  * @global object
1178  * @global object
1179  * @staticvar bool $strcache
1180  * @param string $string The string to be filtered.
1181  * @param boolean $striplinks To strip any link in the result text.
1182                               Moodle 1.8 default changed from false to true! MDL-8713
1183  * @param int $courseid Current course as filters can, potentially, use it
1184  * @return string
1185  */
1186 function format_string($string, $striplinks=true, $courseid=NULL ) {
1187     global $CFG, $COURSE, $PAGE;
1189     //We'll use a in-memory cache here to speed up repeated strings
1190     static $strcache = false;
1192     if ($strcache === false or count($strcache) > 2000 ) { // this number might need some tuning to limit memory usage in cron
1193         $strcache = array();
1194     }
1196     //init course id
1197     if (empty($courseid)) {
1198         $courseid = $COURSE->id;
1199     }
1201     //Calculate md5
1202     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$courseid.'<+>'.current_language());
1204     //Fetch from cache if possible
1205     if (isset($strcache[$md5])) {
1206         return $strcache[$md5];
1207     }
1209     // First replace all ampersands not followed by html entity code
1210     // Regular expression moved to its own method for easier unit testing
1211     $string = replace_ampersands_not_followed_by_entity($string);
1213     if (!empty($CFG->filterall) && $CFG->version >= 2009040600) { // Avoid errors during the upgrade to the new system.
1214         $context = $PAGE->context;
1215         $string = filter_manager::instance()->filter_string($string, $context, $courseid);
1216     }
1218     // If the site requires it, strip ALL tags from this string
1219     if (!empty($CFG->formatstringstriptags)) {
1220         $string = strip_tags($string);
1222     } else {
1223         // Otherwise strip just links if that is required (default)
1224         if ($striplinks) {  //strip links in string
1225             $string = strip_links($string);
1226         }
1227         $string = clean_text($string);
1228     }
1230     //Store to cache
1231     $strcache[$md5] = $string;
1233     return $string;
1236 /**
1237  * Given a string, performs a negative lookahead looking for any ampersand character
1238  * that is not followed by a proper HTML entity. If any is found, it is replaced
1239  * by &amp;. The string is then returned.
1240  *
1241  * @param string $string
1242  * @return string
1243  */
1244 function replace_ampersands_not_followed_by_entity($string) {
1245     return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1248 /**
1249  * Given a string, replaces all <a>.*</a> by .* and returns the string.
1250  *
1251  * @param string $string
1252  * @return string
1253  */
1254 function strip_links($string) {
1255     return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is','$2',$string);
1258 /**
1259  * This expression turns links into something nice in a text format. (Russell Jungwirth)
1260  *
1261  * @param string $string
1262  * @return string
1263  */
1264 function wikify_links($string) {
1265     return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i','$3 [ $2 ]', $string);
1268 /**
1269  * Replaces non-standard HTML entities
1270  *
1271  * @param string $string
1272  * @return string
1273  */
1274 function fix_non_standard_entities($string) {
1275     $text = preg_replace('/&#0*([0-9]+);?/', '&#$1;', $string);
1276     $text = preg_replace('/&#x0*([0-9a-fA-F]+);?/', '&#x$1;', $text);
1277     return $text;
1280 /**
1281  * Given text in a variety of format codings, this function returns
1282  * the text as plain text suitable for plain email.
1283  *
1284  * @uses FORMAT_MOODLE
1285  * @uses FORMAT_HTML
1286  * @uses FORMAT_PLAIN
1287  * @uses FORMAT_WIKI
1288  * @uses FORMAT_MARKDOWN
1289  * @param string $text The text to be formatted. This is raw text originally from user input.
1290  * @param int $format Identifier of the text format to be used
1291  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1292  * @return string
1293  */
1294 function format_text_email($text, $format) {
1296     switch ($format) {
1298         case FORMAT_PLAIN:
1299             return $text;
1300             break;
1302         case FORMAT_WIKI:
1303             $text = wiki_to_html($text);
1304             $text = wikify_links($text);
1305             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1306             break;
1308         case FORMAT_HTML:
1309             return html_to_text($text);
1310             break;
1312         case FORMAT_MOODLE:
1313         case FORMAT_MARKDOWN:
1314         default:
1315             $text = wikify_links($text);
1316             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1317             break;
1318     }
1321 /**
1322  * Given some text in HTML format, this function will pass it
1323  * through any filters that have been configured for this context.
1324  *
1325  * @global object
1326  * @global object
1327  * @global object
1328  * @param string $text The text to be passed through format filters
1329  * @param int $courseid The current course.
1330  * @return string the filtered string.
1331  */
1332 function filter_text($text, $courseid=NULL) {
1333     global $CFG, $COURSE, $PAGE;
1335     if (empty($courseid)) {
1336         $courseid = $COURSE->id;       // (copied from format_text)
1337     }
1339     $context = $PAGE->context;
1341     return filter_manager::instance()->filter_text($text, $context, $courseid);
1343 /**
1344  * Formats activity intro text
1345  *
1346  * @global object
1347  * @uses CONTEXT_MODULE
1348  * @param string $module name of module
1349  * @param object $activity instance of activity
1350  * @param int $cmid course module id
1351  * @param bool $filter filter resulting html text
1352  * @return text
1353  */
1354 function format_module_intro($module, $activity, $cmid, $filter=true) {
1355     global $CFG;
1356     require_once("$CFG->libdir/filelib.php");
1357     $options = (object)array('noclean'=>true, 'para'=>false, 'filter'=>false);
1358     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1359     $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, $module.'_intro', null);
1360     return trim(format_text($intro, $activity->introformat, $options));
1363 /**
1364  * Legacy function, used for cleaning of old forum and glossary text only.
1365  *
1366  * @global object
1367  * @param string $text text that may contain TRUSTTEXT marker
1368  * @return text without any TRUSTTEXT marker
1369  */
1370 function trusttext_strip($text) {
1371     global $CFG;
1373     while (true) { //removing nested TRUSTTEXT
1374         $orig = $text;
1375         $text = str_replace('#####TRUSTTEXT#####', '', $text);
1376         if (strcmp($orig, $text) === 0) {
1377             return $text;
1378         }
1379     }
1382 /**
1383  * Must be called before editing of all texts
1384  * with trust flag. Removes all XSS nasties
1385  * from texts stored in database if needed.
1386  *
1387  * @param object $object data object with xxx, xxxformat and xxxtrust fields
1388  * @param string $field name of text field
1389  * @param object $context active context
1390  * @return object updated $object
1391  */
1392 function trusttext_pre_edit($object, $field, $context) {
1393     $trustfield  = $field.'trust';
1394     $formatfield = $field.'format';
1396     if (!$object->$trustfield or !trusttext_trusted($context)) {
1397         $object->$field = clean_text($object->$field, $object->$formatfield);
1398     }
1400     return $object;
1403 /**
1404  * Is current user trusted to enter no dangerous XSS in this context?
1405  *
1406  * Please note the user must be in fact trusted everywhere on this server!!
1407  *
1408  * @param object $context
1409  * @return bool true if user trusted
1410  */
1411 function trusttext_trusted($context) {
1412     return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1415 /**
1416  * Is trusttext feature active?
1417  *
1418  * @global object
1419  * @param object $context
1420  * @return bool
1421  */
1422 function trusttext_active() {
1423     global $CFG;
1425     return !empty($CFG->enabletrusttext);
1428 /**
1429  * Given raw text (eg typed in by a user), this function cleans it up
1430  * and removes any nasty tags that could mess up Moodle pages.
1431  *
1432  * @uses FORMAT_MOODLE
1433  * @uses FORMAT_PLAIN
1434  * @global string
1435  * @global object
1436  * @param string $text The text to be cleaned
1437  * @param int $format Identifier of the text format to be used
1438  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1439  * @return string The cleaned up text
1440  */
1441 function clean_text($text, $format=FORMAT_MOODLE) {
1443     global $ALLOWED_TAGS, $CFG;
1445     if (empty($text) or is_numeric($text)) {
1446        return (string)$text;
1447     }
1449     switch ($format) {
1450         case FORMAT_PLAIN:
1451         case FORMAT_MARKDOWN:
1452             return $text;
1454         default:
1456             if (!empty($CFG->enablehtmlpurifier)) {
1457                 $text = purify_html($text);
1458             } else {
1459             /// Fix non standard entity notations
1460                 $text = fix_non_standard_entities($text);
1462             /// Remove tags that are not allowed
1463                 $text = strip_tags($text, $ALLOWED_TAGS);
1465             /// Clean up embedded scripts and , using kses
1466                 $text = cleanAttributes($text);
1468             /// Again remove tags that are not allowed
1469                 $text = strip_tags($text, $ALLOWED_TAGS);
1471             }
1473         /// Remove potential script events - some extra protection for undiscovered bugs in our code
1474             $text = preg_replace("~([^a-z])language([[:space:]]*)=~i", "$1Xlanguage=", $text);
1475             $text = preg_replace("~([^a-z])on([a-z]+)([[:space:]]*)=~i", "$1Xon$2=", $text);
1477             return $text;
1478     }
1481 /**
1482  * KSES replacement cleaning function - uses HTML Purifier.
1483  *
1484  * @global object
1485  * @param string $text The (X)HTML string to purify
1486  */
1487 function purify_html($text) {
1488     global $CFG;
1490     // this can not be done only once because we sometimes need to reset the cache
1491     $cachedir = $CFG->dataroot.'/cache/htmlpurifier';
1492     $status = check_dir_exists($cachedir, true, true);
1494     static $purifier = false;
1495     static $config;
1496     if ($purifier === false) {
1497         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1498         $config = HTMLPurifier_Config::createDefault();
1499         $config->set('Core.ConvertDocumentToFragment', true);
1500         $config->set('Core.Encoding', 'UTF-8');
1501         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1502         $config->set('Cache.SerializerPath', $cachedir);
1503         $config->set('URI.AllowedSchemes', array('http'=>1, 'https'=>1, 'ftp'=>1, 'irc'=>1, 'nntp'=>1, 'news'=>1, 'rtsp'=>1, 'teamspeak'=>1, 'gopher'=>1, 'mms'=>1));
1504         $config->set('Attr.AllowedFrameTargets', array('_blank'));
1505         $purifier = new HTMLPurifier($config);
1506     }
1507     return $purifier->purify($text);
1510 /**
1511  * This function takes a string and examines it for HTML tags.
1512  *
1513  * If tags are detected it passes the string to a helper function {@link cleanAttributes2()}
1514  * which checks for attributes and filters them for malicious content
1515  *
1516  * @param string $str The string to be examined for html tags
1517  * @return string
1518  */
1519 function cleanAttributes($str){
1520     $result = preg_replace_callback(
1521             '%(<[^>]*(>|$)|>)%m', #search for html tags
1522             "cleanAttributes2",
1523             $str
1524             );
1525     return  $result;
1528 /**
1529  * This function takes a string with an html tag and strips out any unallowed
1530  * protocols e.g. javascript:
1531  *
1532  * It calls ancillary functions in kses which are prefixed by kses
1533  *
1534  * @global object
1535  * @global string
1536  * @param array $htmlArray An array from {@link cleanAttributes()}, containing in its 1st
1537  *              element the html to be cleared
1538  * @return string
1539  */
1540 function cleanAttributes2($htmlArray){
1542     global $CFG, $ALLOWED_PROTOCOLS;
1543     require_once($CFG->libdir .'/kses.php');
1545     $htmlTag = $htmlArray[1];
1546     if (substr($htmlTag, 0, 1) != '<') {
1547         return '&gt;';  //a single character ">" detected
1548     }
1549     if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $htmlTag, $matches)) {
1550         return ''; // It's seriously malformed
1551     }
1552     $slash = trim($matches[1]); //trailing xhtml slash
1553     $elem = $matches[2];    //the element name
1554     $attrlist = $matches[3]; // the list of attributes as a string
1556     $attrArray = kses_hair($attrlist, $ALLOWED_PROTOCOLS);
1558     $attStr = '';
1559     foreach ($attrArray as $arreach) {
1560         $arreach['name'] = strtolower($arreach['name']);
1561         if ($arreach['name'] == 'style') {
1562             $value = $arreach['value'];
1563             while (true) {
1564                 $prevvalue = $value;
1565                 $value = kses_no_null($value);
1566                 $value = preg_replace("/\/\*.*\*\//Us", '', $value);
1567                 $value = kses_decode_entities($value);
1568                 $value = preg_replace('/(&#[0-9]+)(;?)/', "\\1;", $value);
1569                 $value = preg_replace('/(&#x[0-9a-fA-F]+)(;?)/', "\\1;", $value);
1570                 if ($value === $prevvalue) {
1571                     $arreach['value'] = $value;
1572                     break;
1573                 }
1574             }
1575             $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']);
1576             $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']);
1577             $arreach['value'] = preg_replace("/b\s*i\s*n\s*d\s*i\s*n\s*g/i", "Xbinding", $arreach['value']);
1578         } else if ($arreach['name'] == 'href') {
1579             //Adobe Acrobat Reader XSS protection
1580             $arreach['value'] = preg_replace('/(\.(pdf|fdf|xfdf|xdp|xfd)[^#]*)#.*$/i', '$1', $arreach['value']);
1581         }
1582         $attStr .=  ' '.$arreach['name'].'="'.$arreach['value'].'"';
1583     }
1585     $xhtml_slash = '';
1586     if (preg_match('%/\s*$%', $attrlist)) {
1587         $xhtml_slash = ' /';
1588     }
1589     return '<'. $slash . $elem . $attStr . $xhtml_slash .'>';
1592 /**
1593  * Replaces all known smileys in the text with image equivalents
1594  *
1595  * @global object
1596  * @staticvar array $e
1597  * @staticvar array $img
1598  * @staticvar array $emoticons
1599  * @param string $text Passed by reference. The string to search for smily strings.
1600  * @return string
1601  */
1602 function replace_smilies(&$text) {
1603     global $CFG, $OUTPUT;
1605     if (empty($CFG->emoticons)) { /// No emoticons defined, nothing to process here
1606         return;
1607     }
1609     $lang = current_language();
1610     $emoticonstring = $CFG->emoticons;
1611     static $e = array();
1612     static $img = array();
1613     static $emoticons = null;
1615     if (is_null($emoticons)) {
1616         $emoticons = array();
1617         if ($emoticonstring) {
1618             $items = explode('{;}', $CFG->emoticons);
1619             foreach ($items as $item) {
1620                $item = explode('{:}', $item);
1621               $emoticons[$item[0]] = $item[1];
1622             }
1623         }
1624     }
1626     if (empty($img[$lang])) {  /// After the first time this is not run again
1627         $e[$lang] = array();
1628         $img[$lang] = array();
1629         foreach ($emoticons as $emoticon => $image){
1630             $alttext = get_string($image, 'pix');
1631             $alttext = preg_replace('/^\[\[(.*)\]\]$/', '$1', $alttext); /// Clean alttext in case there isn't lang string for it.
1632             $e[$lang][] = $emoticon;
1633             $img[$lang][] = '<img alt="'. $alttext .'" width="15" height="15" src="'. $OUTPUT->pix_url('s/' . $image) . '" />';
1634         }
1635     }
1637     // Exclude from transformations all the code inside <script> tags
1638     // Needed to solve Bug 1185. Thanks to jouse 2001 detecting it. :-)
1639     // Based on code from glossary fiter by Williams Castillo.
1640     //       - Eloy
1642     // Detect all the <script> zones to take out
1643     $excludes = array();
1644     preg_match_all('/<script language(.+?)<\/script>/is',$text,$list_of_excludes);
1646     // Take out all the <script> zones from text
1647     foreach (array_unique($list_of_excludes[0]) as $key=>$value) {
1648         $excludes['<+'.$key.'+>'] = $value;
1649     }
1650     if ($excludes) {
1651         $text = str_replace($excludes,array_keys($excludes),$text);
1652     }
1654 /// this is the meat of the code - this is run every time
1655     $text = str_replace($e[$lang], $img[$lang], $text);
1657     // Recover all the <script> zones to text
1658     if ($excludes) {
1659         $text = str_replace(array_keys($excludes),$excludes,$text);
1660     }
1663 /**
1664  * This code is called from help.php to inject a list of smilies into the
1665  * emoticons help file.
1666  *
1667  * @global object
1668  * @global object
1669  * @return string HTML for a list of smilies.
1670  */
1671 function get_emoticons_list_for_help_file() {
1672     global $CFG, $SESSION, $PAGE, $OUTPUT;
1673     if (empty($CFG->emoticons)) {
1674         return '';
1675     }
1677     $items = explode('{;}', $CFG->emoticons);
1678     $output = '<ul id="emoticonlist">';
1679     foreach ($items as $item) {
1680         $item = explode('{:}', $item);
1681         $output .= '<li><img src="' . $OUTPUT->pix_url('s/' . $item[1]) . '" alt="' .
1682                 $item[0] . '" /><code>' . $item[0] . '</code></li>';
1683     }
1684     $output .= '</ul>';
1685     if (!empty($SESSION->inserttextform)) {
1686         $formname = $SESSION->inserttextform;
1687         $fieldname = $SESSION->inserttextfield;
1688     } else {
1689         $formname = 'theform';
1690         $fieldname = 'message';
1691     }
1693     $PAGE->requires->yui2_lib('event');
1694     $PAGE->requires->js_function_call('emoticons_help.init', array($formname, $fieldname, 'emoticonlist'));
1695     return $output;
1699 /**
1700  * Given plain text, makes it into HTML as nicely as possible.
1701  * May contain HTML tags already
1702  *
1703  * @global object
1704  * @param string $text The string to convert.
1705  * @param boolean $smiley Convert any smiley characters to smiley images?
1706  * @param boolean $para If true then the returned string will be wrapped in div tags
1707  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1708  * @return string
1709  */
1711 function text_to_html($text, $smiley=true, $para=true, $newlines=true) {
1712 ///
1714     global $CFG;
1716 /// Remove any whitespace that may be between HTML tags
1717     $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1719 /// Remove any returns that precede or follow HTML tags
1720     $text = preg_replace("~([\n\r])<~i", " <", $text);
1721     $text = preg_replace("~>([\n\r])~i", "> ", $text);
1723     convert_urls_into_links($text);
1725 /// Make returns into HTML newlines.
1726     if ($newlines) {
1727         $text = nl2br($text);
1728     }
1730 /// Turn smileys into images.
1731     if ($smiley) {
1732         replace_smilies($text);
1733     }
1735 /// Wrap the whole thing in a div if required
1736     if ($para) {
1737         //return '<p>'.$text.'</p>'; //1.9 version
1738         return '<div class="text_to_html">'.$text.'</div>';
1739     } else {
1740         return $text;
1741     }
1744 /**
1745  * Given Markdown formatted text, make it into XHTML using external function
1746  *
1747  * @global object
1748  * @param string $text The markdown formatted text to be converted.
1749  * @return string Converted text
1750  */
1751 function markdown_to_html($text) {
1752     global $CFG;
1754     require_once($CFG->libdir .'/markdown.php');
1756     return Markdown($text);
1759 /**
1760  * Given HTML text, make it into plain text using external function
1761  *
1762  * @global object
1763  * @param string $html The text to be converted.
1764  * @return string
1765  */
1766 function html_to_text($html) {
1768     global $CFG;
1770     require_once($CFG->libdir .'/html2text.php');
1772     $h2t = new html2text($html);
1773     $result = $h2t->get_text();
1775     return $result;
1778 /**
1779  * Given some text this function converts any URLs it finds into HTML links
1780  *
1781  * @param string $text Passed in by reference. The string to be searched for urls.
1782  */
1783 function convert_urls_into_links(&$text) {
1784     //I've added img tags to this list of tags to ignore.
1785     //See MDL-21168 for more info. A better way to ignore tags whether or not
1786     //they are escaped partially or completely would be desirable. For example:
1787     //<a href="blah">
1788     //&lt;a href="blah"&gt;
1789     //&lt;a href="blah">
1790     $filterignoretagsopen  = array('<a\s[^>]+?>');
1791     $filterignoretagsclose = array('</a>');
1792     filter_save_ignore_tags($text,$filterignoretagsopen,$filterignoretagsclose,$ignoretags);
1794     // Check if we support unicode modifiers in regular expressions. Cache it.
1795     // TODO: this check should be a environment requirement in Moodle 2.0, as far as unicode
1796     // chars are going to arrive to URLs officially really soon (2010?)
1797     // Original RFC regex from: http://www.bytemycode.com/snippets/snippet/796/
1798     // Various ideas from: http://alanstorm.com/url_regex_explained
1799     // Unicode check, negative assertion and other bits from Moodle.
1800     static $unicoderegexp;
1801     if (!isset($unicoderegexp)) {
1802         $unicoderegexp = @preg_match('/\pL/u', 'a'); // This will fail silenty, returning false,
1803     }
1805     //todo: MDL-21296 - use of unicode modifiers may cause a timeout
1806     if ($unicoderegexp) { //We can use unicode modifiers
1807         $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',
1808                              '<a href="\\1" class="_blanktarget">\\1</a>', $text);
1809         $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',
1810                              '<a href="http://\\1" class="_blanktarget">\\1</a>', $text);
1811     } else { //We cannot use unicode modifiers
1812         $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',
1813                              '<a href="\\1" class="_blanktarget">\\1</a>', $text);
1814         $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',
1815                              '<a href="http://\\1" class="_blanktarget">\\1</a>', $text);
1816     }
1818     if (!empty($ignoretags)) {
1819         $ignoretags = array_reverse($ignoretags); /// Reversed so "progressive" str_replace() will solve some nesting problems.
1820         $text = str_replace(array_keys($ignoretags),$ignoretags,$text);
1821     }
1824 /**
1825  * This function will highlight search words in a given string
1826  *
1827  * It cares about HTML and will not ruin links.  It's best to use
1828  * this function after performing any conversions to HTML.
1829  *
1830  * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1831  * @param string $haystack The string (HTML) within which to highlight the search terms.
1832  * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1833  * @param string $prefix the string to put before each search term found.
1834  * @param string $suffix the string to put after each search term found.
1835  * @return string The highlighted HTML.
1836  */
1837 function highlight($needle, $haystack, $matchcase = false,
1838         $prefix = '<span class="highlight">', $suffix = '</span>') {
1840 /// Quick bail-out in trivial cases.
1841     if (empty($needle) or empty($haystack)) {
1842         return $haystack;
1843     }
1845 /// Break up the search term into words, discard any -words and build a regexp.
1846     $words = preg_split('/ +/', trim($needle));
1847     foreach ($words as $index => $word) {
1848         if (strpos($word, '-') === 0) {
1849             unset($words[$index]);
1850         } else if (strpos($word, '+') === 0) {
1851             $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
1852         } else {
1853             $words[$index] = preg_quote($word, '/');
1854         }
1855     }
1856     $regexp = '/(' . implode('|', $words) . ')/u'; // u is do UTF-8 matching.
1857     if (!$matchcase) {
1858         $regexp .= 'i';
1859     }
1861 /// Another chance to bail-out if $search was only -words
1862     if (empty($words)) {
1863         return $haystack;
1864     }
1866 /// Find all the HTML tags in the input, and store them in a placeholders array.
1867     $placeholders = array();
1868     $matches = array();
1869     preg_match_all('/<[^>]*>/', $haystack, $matches);
1870     foreach (array_unique($matches[0]) as $key => $htmltag) {
1871         $placeholders['<|' . $key . '|>'] = $htmltag;
1872     }
1874 /// In $hastack, replace each HTML tag with the corresponding placeholder.
1875     $haystack = str_replace($placeholders, array_keys($placeholders), $haystack);
1877 /// In the resulting string, Do the highlighting.
1878     $haystack = preg_replace($regexp, $prefix . '$1' . $suffix, $haystack);
1880 /// Turn the placeholders back into HTML tags.
1881     $haystack = str_replace(array_keys($placeholders), $placeholders, $haystack);
1883     return $haystack;
1886 /**
1887  * This function will highlight instances of $needle in $haystack
1888  *
1889  * It's faster that the above function {@link highlight()} and doesn't care about
1890  * HTML or anything.
1891  *
1892  * @param string $needle The string to search for
1893  * @param string $haystack The string to search for $needle in
1894  * @return string The highlighted HTML
1895  */
1896 function highlightfast($needle, $haystack) {
1898     if (empty($needle) or empty($haystack)) {
1899         return $haystack;
1900     }
1902     $parts = explode(moodle_strtolower($needle), moodle_strtolower($haystack));
1904     if (count($parts) === 1) {
1905         return $haystack;
1906     }
1908     $pos = 0;
1910     foreach ($parts as $key => $part) {
1911         $parts[$key] = substr($haystack, $pos, strlen($part));
1912         $pos += strlen($part);
1914         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
1915         $pos += strlen($needle);
1916     }
1918     return str_replace('<span class="highlight"></span>', '', join('', $parts));
1921 /**
1922  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
1923  * Internationalisation, for print_header and backup/restorelib.
1924  *
1925  * @param bool $dir Default false
1926  * @return string Attributes
1927  */
1928 function get_html_lang($dir = false) {
1929     $direction = '';
1930     if ($dir) {
1931         if (get_string('thisdirection') == 'rtl') {
1932             $direction = ' dir="rtl"';
1933         } else {
1934             $direction = ' dir="ltr"';
1935         }
1936     }
1937     //Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
1938     $language = str_replace('_', '-', str_replace('_utf8', '', current_language()));
1939     @header('Content-Language: '.$language);
1940     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
1944 /// STANDARD WEB PAGE PARTS ///////////////////////////////////////////////////
1946 /**
1947  * Send the HTTP headers that Moodle requires.
1948  * @param $cacheable Can this page be cached on back?
1949  */
1950 function send_headers($contenttype, $cacheable = true) {
1951     @header('Content-Type: ' . $contenttype);
1952     @header('Content-Script-Type: text/javascript');
1953     @header('Content-Style-Type: text/css');
1955     if ($cacheable) {
1956         // Allow caching on "back" (but not on normal clicks)
1957         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0');
1958         @header('Pragma: no-cache');
1959         @header('Expires: ');
1960     } else {
1961         // Do everything we can to always prevent clients and proxies caching
1962         @header('Cache-Control: no-store, no-cache, must-revalidate');
1963         @header('Cache-Control: post-check=0, pre-check=0', false);
1964         @header('Pragma: no-cache');
1965         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1966         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1967     }
1968     @header('Accept-Ranges: none');
1971 /**
1972  * Return the right arrow with text ('next'), and optionally embedded in a link.
1973  *
1974  * @global object
1975  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1976  * @param string $url An optional link to use in a surrounding HTML anchor.
1977  * @param bool $accesshide True if text should be hidden (for screen readers only).
1978  * @param string $addclass Additional class names for the link, or the arrow character.
1979  * @return string HTML string.
1980  */
1981 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
1982     global $OUTPUT; //TODO: move to output renderer
1983     $arrowclass = 'arrow ';
1984     if (! $url) {
1985         $arrowclass .= $addclass;
1986     }
1987     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
1988     $htmltext = '';
1989     if ($text) {
1990         $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
1991         if ($accesshide) {
1992             $htmltext = get_accesshide($htmltext);
1993         }
1994     }
1995     if ($url) {
1996         $class = 'arrow_link';
1997         if ($addclass) {
1998             $class .= ' '.$addclass;
1999         }
2000         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$htmltext.$arrow.'</a>';
2001     }
2002     return $htmltext.$arrow;
2005 /**
2006  * Return the left arrow with text ('previous'), and optionally embedded in a link.
2007  *
2008  * @global object
2009  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2010  * @param string $url An optional link to use in a surrounding HTML anchor.
2011  * @param bool $accesshide True if text should be hidden (for screen readers only).
2012  * @param string $addclass Additional class names for the link, or the arrow character.
2013  * @return string HTML string.
2014  */
2015 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
2016     global $OUTPUT; // TODO: move to utput renderer
2017     $arrowclass = 'arrow ';
2018     if (! $url) {
2019         $arrowclass .= $addclass;
2020     }
2021     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
2022     $htmltext = '';
2023     if ($text) {
2024         $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
2025         if ($accesshide) {
2026             $htmltext = get_accesshide($htmltext);
2027         }
2028     }
2029     if ($url) {
2030         $class = 'arrow_link';
2031         if ($addclass) {
2032             $class .= ' '.$addclass;
2033         }
2034         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$arrow.$htmltext.'</a>';
2035     }
2036     return $arrow.$htmltext;
2039 /**
2040  * Return a HTML element with the class "accesshide", for accessibility.
2041  * Please use cautiously - where possible, text should be visible!
2042  *
2043  * @param string $text Plain text.
2044  * @param string $elem Lowercase element name, default "span".
2045  * @param string $class Additional classes for the element.
2046  * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
2047  * @return string HTML string.
2048  */
2049 function get_accesshide($text, $elem='span', $class='', $attrs='') {
2050     return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
2053 /**
2054  * Return the breadcrumb trail navigation separator.
2055  *
2056  * @return string HTML string.
2057  */
2058 function get_separator() {
2059     //Accessibility: the 'hidden' slash is preferred for screen readers.
2060     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
2063 /**
2064  * Print (or return) a collapisble region, that has a caption that can
2065  * be clicked to expand or collapse the region.
2066  *
2067  * If JavaScript is off, then the region will always be exanded.
2068  *
2069  * @param string $contents the contents of the box.
2070  * @param string $classes class names added to the div that is output.
2071  * @param string $id id added to the div that is output. Must not be blank.
2072  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2073  * @param string $userpref the name of the user preference that stores the user's preferred deafault state.
2074  *      (May be blank if you do not wish the state to be persisted.
2075  * @param boolean $default Inital collapsed state to use if the user_preference it not set.
2076  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2077  * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
2078  */
2079 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2080     $output  = print_collapsible_region_start($classes, $id, $caption, $userpref, true);
2081     $output .= $contents;
2082     $output .= print_collapsible_region_end(true);
2084     if ($return) {
2085         return $output;
2086     } else {
2087         echo $output;
2088     }
2091 /**
2092  * Print (or return) the start of a collapisble region, that has a caption that can
2093  * be clicked to expand or collapse the region. If JavaScript is off, then the region
2094  * will always be exanded.
2095  *
2096  * @global object
2097  * @param string $classes class names added to the div that is output.
2098  * @param string $id id added to the div that is output. Must not be blank.
2099  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2100  * @param boolean $userpref the name of the user preference that stores the user's preferred deafault state.
2101  *      (May be blank if you do not wish the state to be persisted.
2102  * @param boolean $default Inital collapsed state to use if the user_preference it not set.
2103  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2104  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2105  */
2106 function print_collapsible_region_start($classes, $id, $caption, $userpref = false, $default = false, $return = false) {
2107     global $CFG, $PAGE, $OUTPUT;
2109     // Work out the initial state.
2110     if (is_string($userpref)) {
2111         user_preference_allow_ajax_update($userpref, PARAM_BOOL);
2112         $collapsed = get_user_preferences($userpref, $default);
2113     } else {
2114         $collapsed = $default;
2115         $userpref = false;
2116     }
2118     if ($collapsed) {
2119         $classes .= ' collapsed';
2120     }
2122     $output = '';
2123     $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2124     $output .= '<div id="' . $id . '_sizer">';
2125     $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2126     $output .= $caption . ' ';
2127     $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2128     $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2130     if ($return) {
2131         return $output;
2132     } else {
2133         echo $output;
2134     }
2137 /**
2138  * Close a region started with print_collapsible_region_start.
2139  *
2140  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2141  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2142  */
2143 function print_collapsible_region_end($return = false) {
2144     $output = '</div></div></div>';
2146     if ($return) {
2147         return $output;
2148     } else {
2149         echo $output;
2150     }
2153 /**
2154  * Print a specified group's avatar.
2155  *
2156  * @global object
2157  * @uses CONTEXT_COURSE
2158  * @param array $group A single {@link group} object OR array of groups.
2159  * @param int $courseid The course ID.
2160  * @param boolean $large Default small picture, or large.
2161  * @param boolean $return If false print picture, otherwise return the output as string
2162  * @param boolean $link Enclose image in a link to view specified course?
2163  * @return string|void Depending on the setting of $return
2164  */
2165 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2166     global $CFG;
2168     if (is_array($group)) {
2169         $output = '';
2170         foreach($group as $g) {
2171             $output .= print_group_picture($g, $courseid, $large, true, $link);
2172         }
2173         if ($return) {
2174             return $output;
2175         } else {
2176             echo $output;
2177             return;
2178         }
2179     }
2181     $context = get_context_instance(CONTEXT_COURSE, $courseid);
2183     if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
2184         return '';
2185     }
2187     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2188         $output = '<a href="'. $CFG->wwwroot .'/user/index.php?id='. $courseid .'&amp;group='. $group->id .'">';
2189     } else {
2190         $output = '';
2191     }
2192     if ($large) {
2193         $file = 'f1';
2194     } else {
2195         $file = 'f2';
2196     }
2197     if ($group->picture) {  // Print custom group picture
2198         require_once($CFG->libdir.'/filelib.php');
2199         $grouppictureurl = get_file_url($group->id.'/'.$file.'.jpg', null, 'usergroup');
2200         $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2201             ' alt="'.s(get_string('group').' '.$group->name).'" title="'.s($group->name).'"/>';
2202     }
2203     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2204         $output .= '</a>';
2205     }
2207     if ($return) {
2208         return $output;
2209     } else {
2210         echo $output;
2211     }
2215 /**
2216  * Display a recent activity note
2217  *
2218  * @uses CONTEXT_SYSTEM
2219  * @staticvar string $strftimerecent
2220  * @param object A time object
2221  * @param object A user object
2222  * @param string $text Text for display for the note
2223  * @param string $link The link to wrap around the text
2224  * @param bool $return If set to true the HTML is returned rather than echo'd
2225  * @param string $viewfullnames
2226  */
2227 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2228     static $strftimerecent = null;
2229     $output = '';
2231     if (is_null($viewfullnames)) {
2232         $context = get_context_instance(CONTEXT_SYSTEM);
2233         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2234     }
2236     if (is_null($strftimerecent)) {
2237         $strftimerecent = get_string('strftimerecent');
2238     }
2240     $output .= '<div class="head">';
2241     $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2242     $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2243     $output .= '</div>';
2244     $output .= '<div class="info"><a href="'.$link.'">'.format_string($text,true).'</a></div>';
2246     if ($return) {
2247         return $output;
2248     } else {
2249         echo $output;
2250     }
2253 /**
2254  * Returns a little popup menu for switching roles
2255  *
2256  * @global object
2257  * @global object
2258  * @uses CONTEXT_COURSE
2259  * @param int $courseid The course  to update by id as found in 'course' table
2260  * @return string
2261  */
2262 function switchroles_form($courseid) {
2264     global $CFG, $USER, $OUTPUT;
2267     if (!$context = get_context_instance(CONTEXT_COURSE, $courseid)) {
2268         return '';
2269     }
2271     if (!empty($USER->access['rsw'][$context->path])){  // Just a button to return to normal
2272         $options = array();
2273         $options['id'] = $courseid;
2274         $options['sesskey'] = sesskey();
2275         $options['switchrole'] = 0;
2277         return $OUTPUT->single_button(new moodle_url('/course/view.php', $options), get_string('switchrolereturn'));
2278     }
2280     if (has_capability('moodle/role:switchroles', $context)) {
2281         if (!$roles = get_switchable_roles($context)) {
2282             return '';   // Nothing to show!
2283         }
2284         // unset default user role - it would not work
2285         unset($roles[$CFG->guestroleid]);
2286         $popupurl = $CFG->wwwroot.'/course/view.php?id='.$courseid.'&sesskey='.sesskey();
2287         $select = html_select::make_popup_form($popupurl, 'switchrole', $roles, 'switchrole', '');
2288         $select->nothinglabel = get_string('switchroleto');
2289         $select->set_help_icon('switchrole', get_string('switchroleto'));
2290         return $OUTPUT->select($select);
2291     }
2293     return '';
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;
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(urldecode($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 = html_link::make('/course/scales.php?id='. $courseid .'&list=true', $linkobject);
2433     $link->add_action(new popup_action('click', $link->url, 'ratingscales', array('height' => 400, 'width' => 500)));
2434     $link->title = $strscales;
2435     $output .= $OUTPUT->link($link);
2437     if ($return) {
2438         return $output;
2439     } else {
2440         echo $output;
2441     }
2444 /**
2445  * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2446  * Default errorcode is 1.
2447  *
2448  * Very useful for perl-like error-handling:
2449  *
2450  * do_somethting() or mdie("Something went wrong");
2451  *
2452  * @param string  $msg       Error message
2453  * @param integer $errorcode Error code to emit
2454  */
2455 function mdie($msg='', $errorcode=1) {
2456     trigger_error($msg);
2457     exit($errorcode);
2460 /**
2461  * Returns html code to be used as help icon of modgrade form element
2462  *
2463  * Is used as a callback in modgrade setHelpButton()
2464  *
2465  * @param int $courseid id of the course the scales should be shown from
2466  * @return string to be echoed
2467  */
2468 function modgradehelpbutton($courseid){
2469     global $CFG, $OUTPUT;
2471     $url = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true));
2472     $link = new html_link();
2473     $link->url = $url;
2474     $link->text = '<span class="helplink"><img alt="' . get_string('scales') . '" class="iconhelp" src="' . $OUTPUT->pix_url('help') . '" /></span>';
2475     $link->add_action(new popup_action('click', $link->url, 'ratingscales', array('height' => 400, 'width' => 500)));
2476     $link->title = get_string('newwindow');
2478     return $OUTPUT->link($link);
2481 /**
2482  * Print a message and exit.
2483  *
2484  * @param string $message The message to print in the notice
2485  * @param string $link The link to use for the continue button
2486  * @param object $course A course object
2487  * @return void This function simply exits
2488  */
2489 function notice ($message, $link='', $course=NULL) {
2490     global $CFG, $SITE, $COURSE, $PAGE, $OUTPUT;
2492     $message = clean_text($message);   // In case nasties are in here
2494     if (CLI_SCRIPT) {
2495         echo("!!$message!!\n");
2496         exit(1); // no success
2497     }
2499     if (!$PAGE->headerprinted) {
2500         //header not yet printed
2501         $PAGE->set_title(get_string('notice'));
2502         echo $OUTPUT->header();
2503     } else {
2504         echo $OUTPUT->container_end_all(false);
2505     }
2507     echo $OUTPUT->box($message, 'generalbox', 'notice');
2508     echo $OUTPUT->continue_button($link);
2510     echo $OUTPUT->footer();
2511     exit(1); // general error code
2514 /**
2515  * Redirects the user to another page, after printing a notice
2516  *
2517  * This function calls the OUTPUT redirect method, echo's the output
2518  * and then dies to ensure nothing else happens.
2519  *
2520  * <strong>Good practice:</strong> You should call this method before starting page
2521  * output by using any of the OUTPUT methods.
2522  *
2523  * @param moodle_url $url A moodle_url to redirect to. Strings are not to be trusted!
2524  * @param string $message The message to display to the user
2525  * @param int $delay The delay before redirecting
2526  * @return void
2527  */
2528 function redirect($url, $message='', $delay=-1) {
2529     global $OUTPUT, $PAGE, $SESSION, $CFG;
2531     if ($url instanceof moodle_url) {
2532         $url = $url->out(false);
2533     }
2535     if (!empty($CFG->usesid) && !isset($_COOKIE[session_name()])) {
2536        $url = $SESSION->sid_process_url($url);
2537     }
2539     if (function_exists('error_get_last')) {
2540         $lasterror = error_get_last();
2541     }
2542     $debugdisableredirect = defined('DEBUGGING_PRINTED') ||
2543             (!empty($CFG->debugdisplay) && !empty($lasterror) && ($lasterror['type'] & DEBUG_DEVELOPER));
2545     $usingmsg = false;
2546     if (!empty($message)) {
2547         if ($delay === -1 || !is_numeric($delay)) {
2548             $delay = 3;
2549         }
2550         $message = clean_text($message);
2551     } else {
2552         $message = get_string('pageshouldredirect');
2553         $delay = 0;
2554         // We are going to try to use a HTTP redirect, so we need a full URL.
2555         if (!preg_match('|^[a-z]+:|', $url)) {
2556             // Get host name http://www.wherever.com
2557             $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2558             if (preg_match('|^/|', $url)) {
2559                 // URLs beginning with / are relative to web server root so we just add them in
2560                 $url = $hostpart.$url;
2561             } else {
2562                 // URLs not beginning with / are relative to path of current script, so add that on.
2563                 $url = $hostpart.preg_replace('|\?.*$|','',me()).'/../'.$url;
2564             }
2565             // Replace all ..s
2566             while (true) {
2567                 $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2568                 if ($newurl == $url) {
2569                     break;
2570                 }
2571                 $url = $newurl;
2572             }
2573         }
2574     }
2576     if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
2577         if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
2578             $perf = get_performance_info();
2579             error_log("PERF: " . $perf['txt']);
2580         }
2581     }
2583     $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2584     $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />'));
2586     if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2587         //302 might not work for POST requests, 303 is ignored by obsolete clients.
2588         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2589         @header('Location: '.$url);
2590         echo bootstrap_renderer::plain_redirect_message($encodedurl);
2591         exit;
2592     }
2594     // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2595     $PAGE->set_pagelayout('embedded');  // No header and footer needed
2596     $CFG->docroot = false; // to prevent the link to moodle docs from being displayed on redirect page.
2597     echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect);
2598     exit;
2601 /**
2602  * Given an email address, this function will return an obfuscated version of it
2603  *
2604  * @param string $email The email address to obfuscate
2605  * @return string The obfuscated email address
2606  */
2607  function obfuscate_email($email) {
2609     $i = 0;
2610     $length = strlen($email);
2611     $obfuscated = '';
2612     while ($i < $length) {
2613         if (rand(0,2)) {
2614             $obfuscated.='%'.dechex(ord($email{$i}));
2615         } else {
2616             $obfuscated.=$email{$i};
2617         }
2618         $i++;
2619     }
2620     return $obfuscated;
2623 /**
2624  * This function takes some text and replaces about half of the characters
2625  * with HTML entity equivalents.   Return string is obviously longer.
2626  *
2627  * @param string $plaintext The text to be obfuscated
2628  * @return string The obfuscated text
2629  */
2630 function obfuscate_text($plaintext) {
2632     $i=0;
2633     $length = strlen($plaintext);
2634     $obfuscated='';
2635     $prev_obfuscated = false;
2636     while ($i < $length) {
2637         $c = ord($plaintext{$i});
2638         $numerical = ($c >= ord('0')) && ($c <= ord('9'));
2639         if ($prev_obfuscated and $numerical ) {
2640             $obfuscated.='&#'.ord($plaintext{$i}).';';
2641         } else if (rand(0,2)) {
2642             $obfuscated.='&#'.ord($plaintext{$i}).';';
2643             $prev_obfuscated = true;
2644         } else {
2645             $obfuscated.=$plaintext{$i};
2646             $prev_obfuscated = false;
2647         }
2648       $i++;
2649     }
2650     return $obfuscated;
2653 /**
2654  * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2655  * to generate a fully obfuscated email link, ready to use.
2656  *
2657  * @param string $email The email address to display
2658  * @param string $label The text to dispalyed as hyperlink to $email
2659  * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2660  * @return string The obfuscated mailto link
2661  */
2662 function obfuscate_mailto($email, $label='', $dimmed=false) {
2664     if (empty($label)) {
2665         $label = $email;
2666     }
2667     if ($dimmed) {
2668         $title = get_string('emaildisable');
2669         $dimmed = ' class="dimmed"';
2670     } else {
2671         $title = '';
2672         $dimmed = '';
2673     }
2674     return sprintf("<a href=\"%s:%s\" $dimmed title=\"$title\">%s</a>",
2675                     obfuscate_text('mailto'), obfuscate_email($email),
2676                     obfuscate_text($label));
2679 /**
2680  * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2681  * will transform it to html entities
2682  *
2683  * @param string $text Text to search for nolink tag in
2684  * @return string
2685  */
2686 function rebuildnolinktag($text) {
2688     $text = preg_replace('/&lt;(\/*nolink)&gt;/i','<$1>',$text);
2690     return $text;
2693 /**
2694  * Prints a maintenance message from $CFG->maintenance_message or default if empty
2695  * @return void
2696  */
2697 function print_maintenance_message() {
2698     global $CFG, $SITE, $PAGE, $OUTPUT;
2700     $PAGE->set_pagetype('maintenance-message');
2701     $PAGE->set_pagelayout('maintenance');
2702     $PAGE->set_title(strip_tags($SITE->fullname));
2703     $PAGE->set_heading($SITE->fullname);
2704     echo $OUTPUT->header();
2705     echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2706     if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
2707         echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2708         echo $CFG->maintenance_message;
2709         echo $OUTPUT->box_end();
2710     }
2711     echo $OUTPUT->footer();
2712     die;
2715 /**
2716  * Adjust the list of allowed tags based on $CFG->allowobjectembed and user roles (admin)
2717  *
2718  * @global object
2719  * @global string
2720  * @return void
2721  */
2722 function adjust_allowed_tags() {
2724     global $CFG, $ALLOWED_TAGS;
2726     if (!empty($CFG->allowobjectembed)) {
2727         $ALLOWED_TAGS .= '<embed><object>';
2728     }
2731 /**
2732  * A class for tabs, Some code to print tabs
2733  *
2734  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2735  * @package moodlecore
2736  */
2737 class tabobject {
2738     /**
2739      * @var string
2740      */
2741     var $id;
2742     var $link;
2743     var $text;
2744     /**
2745      * @var bool
2746      */
2747     var $linkedwhenselected;
2749     /**
2750      * A constructor just because I like constructors
2751      *
2752      * @param string $id
2753      * @param string $link
2754      * @param string $text
2755      * @param string $title
2756      * @param bool $linkedwhenselected
2757      */
2758     function tabobject ($id, $link='', $text='', $title='', $linkedwhenselected=false) {
2759         $this->id   = $id;
2760         $this->link = $link;
2761         $this->text = $text;
2762         $this->title = $title ? $title : $text;
2763         $this->linkedwhenselected = $linkedwhenselected;
2764     }
2769 /**
2770  * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2771  *
2772  * @global object
2773  * @param array $tabrows An array of rows where each row is an array of tab objects
2774  * @param string $selected  The id of the selected tab (whatever row it's on)
2775  * @param array  $inactive  An array of ids of inactive tabs that are not selectable.
2776  * @param array  $activated An array of ids of other tabs that are currently activated
2777  * @param bool $return If true output is returned rather then echo'd
2778  **/
2779 function print_tabs($tabrows, $selected=NULL, $inactive=NULL, $activated=NULL, $return=false) {
2780     global $CFG;
2782 /// $inactive must be an array
2783     if (!is_array($inactive)) {
2784         $inactive = array();
2785     }
2787 /// $activated must be an array
2788     if (!is_array($activated)) {
2789         $activated = array();
2790     }
2792 /// Convert the tab rows into a tree that's easier to process
2793     if (!$tree = convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated)) {
2794         return false;
2795     }
2797 /// Print out the current tree of tabs (this function is recursive)
2799     $output = convert_tree_to_html($tree);
2801     $output = "\n\n".'<div class="tabtree">'.$output.'</div><div class="clearer"> </div>'."\n\n";
2803 /// We're done!
2805     if ($return) {
2806         return $output;
2807     }
2808     echo $output;
2811 /**
2812  * Converts a nested array tree into HTML ul:li [recursive]
2813  *
2814  * @param array $tree A tree array to convert
2815  * @param int $row Used in identifing the iteration level and in ul classes
2816  * @return string HTML structure
2817  */
2818 function convert_tree_to_html($tree, $row=0) {
2820     $str = "\n".'<ul class="tabrow'.$row.'">'."\n";
2822     $first = true;
2823     $count = count($tree);
2825     foreach ($tree as $tab) {
2826         $count--;   // countdown to zero
2828         $liclass = '';
2830         if ($first && ($count == 0)) {   // Just one in the row
2831             $liclass = 'first last';
2832             $first = false;
2833         } else if ($first) {
2834             $liclass = 'first';
2835             $first = false;
2836         } else if ($count == 0) {
2837             $liclass = 'last';
2838         }
2840         if ((empty($tab->subtree)) && (!empty($tab->selected))) {
2841             $liclass .= (empty($liclass)) ? 'onerow' : ' onerow';
2842         }
2844         if ($tab->inactive || $tab->active || $tab->selected) {
2845             if ($tab->selected) {
2846                 $liclass .= (empty($liclass)) ? 'here selected' : ' here selected';
2847             } else if ($tab->active) {
2848                 $liclass .= (empty($liclass)) ? 'here active' : ' here active';
2849             }
2850         }
2852         $str .= (!empty($liclass)) ? '<li class="'.$liclass.'">' : '<li>';
2854         if ($tab->inactive || $tab->active || ($tab->selected && !$tab->linkedwhenselected)) {
2855             // The a tag is used for styling
2856             $str .= '<a class="nolink"><span>'.$tab->text.'</span></a>';
2857         } else {
2858             $str .= '<a href="'.$tab->link.'" title="'.$tab->title.'"><span>'.$tab->text.'</span></a>';
2859         }
2861         if (!empty($tab->subtree)) {
2862             $str .= convert_tree_to_html($tab->subtree, $row+1);
2863         } else if ($tab->selected) {
2864             $str .= '<div class="tabrow'.($row+1).' empty">&nbsp;</div>'."\n";
2865         }
2867         $str .= ' </li>'."\n";
2868     }
2869     $str .= '</ul>'."\n";
2871     return $str;
2874 /**
2875  * Convert nested tabrows to a nested array
2876  *
2877  * @param array $tabrows A [nested] array of tab row objects
2878  * @param string $selected The tabrow to select (by id)
2879  * @param array $inactive An array of tabrow id's to make inactive
2880  * @param array $activated An array of tabrow id's to make active
2881  * @return array The nested array
2882  */
2883 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
2885 /// Work backwards through the rows (bottom to top) collecting the tree as we go.
2887     $tabrows = array_reverse($tabrows);
2889     $subtree = array();
2891     foreach ($tabrows as $row) {
2892         $tree = array();
2894         foreach ($row as $tab) {
2895             $tab->inactive = in_array((string)$tab->id, $inactive);
2896             $tab->active = in_array((string)$tab->id, $activated);
2897             $tab->selected = (string)$tab->id == $selected;
2899             if ($tab->active || $tab->selected) {
2900                 if ($subtree) {
2901                     $tab->subtree = $subtree;
2902                 }
2903             }
2904             $tree[] = $tab;
2905         }
2906         $subtree = $tree;
2907     }
2909     return $subtree;
2912 /**
2913  * Returns the Moodle Docs URL in the users language
2914  *
2915  * @global object
2916  * @param string $path the end of the URL.
2917  * @return string The MoodleDocs URL in the user's language. for example {@link http://docs.moodle.org/en/ http://docs.moodle.org/en/$path}
2918  */
2919 function get_docs_url($path) {
2920     global $CFG;
2921     return $CFG->docroot . '/' . str_replace('_utf8', '', current_language()) . '/' . $path;
2925 /**
2926  * Standard Debugging Function
2927  *
2928  * Returns true if the current site debugging settings are equal or above specified level.
2929  * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2930  * routing of notices is controlled by $CFG->debugdisplay
2931  * eg use like this:
2932  *
2933  * 1)  debugging('a normal debug notice');
2934  * 2)  debugging('something really picky', DEBUG_ALL);
2935  * 3)  debugging('annoying debug message only for develpers', DEBUG_DEVELOPER);
2936  * 4)  if (debugging()) { perform extra debugging operations (do not use print or echo) }
2937  *
2938  * In code blocks controlled by debugging() (such as example 4)
2939  * any output should be routed via debugging() itself, or the lower-level
2940  * trigger_error() or error_log(). Using echo or print will break XHTML
2941  * JS and HTTP headers.
2942  *
2943  * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2944  *
2945  * @uses DEBUG_NORMAL
2946  * @param string $message a message to print
2947  * @param int $level the level at which this debugging statement should show
2948  * @param array $backtrace use different backtrace
2949  * @return bool
2950  */
2951 function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
2952     global $CFG, $UNITTEST;
2954     if (empty($CFG->debug) || $CFG->debug < $level) {
2955         return false;
2956     }
2958     if (!isset($CFG->debugdisplay)) {
2959         $CFG->debugdisplay = ini_get_bool('display_errors');
2960     }
2962     if ($message) {
2963         if (!$backtrace) {
2964             $backtrace = debug_backtrace();
2965         }
2966         $from = format_backtrace($backtrace, CLI_SCRIPT);
2967         if (!empty($UNITTEST->running)) {
2968             // When the unit tests are running, any call to trigger_error
2969             // is intercepted by the test framework and reported as an exception.
2970             // Therefore, we cannot use trigger_error during unit tests.
2971             // At the same time I do not think we should just discard those messages,
2972             // so displaying them on-screen seems like the only option. (MDL-20398)
2973             echo '<div class="notifytiny">' . $message . $from . '</div>';
2975         } else if (NO_DEBUG_DISPLAY) {
2976             // script does not want any errors or debugging in output,
2977             // we send the info to error log instead
2978             error_log('Debugging: ' . $message . $from);
2980         } else if ($CFG->debugdisplay) {
2981             if (!defined('DEBUGGING_PRINTED')) {
2982                 define('DEBUGGING_PRINTED', 1); // indicates we have printed something
2983             }
2984             echo '<div class="notifytiny">' . $message . $from . '</div>';
2986         } else {
2987             trigger_error($message . $from, E_USER_NOTICE);
2988         }
2989     }
2990     return true;
2993 /**
2994  *  Returns string to add a frame attribute, if required
2995  *
2996  * @global object
2997  * @return bool
2998  */
2999 function frametarget() {
3000     global $CFG;
3002     if (empty($CFG->framename) or ($CFG->framename == '_top')) {
3003         return '';
3004     } else {
3005         return ' target="'.$CFG->framename.'" ';
3006     }
3009 /**
3010 * Outputs a HTML comment to the browser. This is used for those hard-to-debug
3011 * pages that use bits from many different files in very confusing ways (e.g. blocks).
3013 * <code>print_location_comment(__FILE__, __LINE__);</code>
3015 * @param string $file
3016 * @param integer $line
3017 * @param boolean $return Whether to return or print the comment
3018 * @return string|void Void unless true given as third parameter
3019 */
3020 function print_location_comment($file, $line, $return = false)
3022     if ($return) {
3023         return "<!-- $file at line $line -->\n";
3024     } else {
3025         echo "<!-- $file at line $line -->\n";
3026     }
3030 /**
3031  * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
3032  */
3033 function right_to_left() {
3034     static $result;
3036     if (!isset($result)) {
3037         $result = get_string('thisdirection') == 'rtl';
3038     }
3039     return $result;
3043 /**
3044  * Returns swapped left<=>right if in RTL environment.
3045  * part of RTL support
3046  *
3047  * @param string $align align to check
3048  * @return string
3049  */
3050 function fix_align_rtl($align) {
3051     if (!right_to_left()) {
3052         return $align;
3053     }
3054     if ($align=='left')  { return 'right'; }
3055     if ($align=='right') { return 'left'; }
3056     return $align;
3060 /**
3061  * Returns true if the page is displayed in a popup window.
3062  * Gets the information from the URL parameter inpopup.
3063  *
3064  * @todo Use a central function to create the popup calls allover Moodle and
3065  * In the moment only works with resources and probably questions.
3066  *
3067  * @return boolean
3068  */
3069 function is_in_popup() {
3070     $inpopup = optional_param('inpopup', '', PARAM_BOOL);
3072     return ($inpopup);
3075 /**
3076  * To use this class.
3077  * - construct
3078  * - call create (or use the 3rd param to the constructor)
3079  * - call update or update_full repeatedly
3080  *
3081  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3082  * @package moodlecore
3083  */
3084 class progress_bar {
3085     /** @var string html id */
3086     private $html_id;
3087     /** @var int */
3088     private $percent;
3089     /** @var int */
3090     private $width;
3091     /** @var int */
3092     private $lastcall;
3093     /** @var int */
3094     private $time_start;
3095     private $minimum_time = 2; //min time between updates.
3096     /**
3097      * Contructor
3098      *
3099      * @param string $html_id
3100      * @param int $width
3101      * @param bool $autostart Default to false
3102      */
3103     public function __construct($html_id = '', $width = 500, $autostart = false){
3104         if (!empty($html_id)) {
3105             $this->html_id  = $html_id;
3106         } else {
3107             $this->html_id  = uniqid();
3108         }
3109         $this->width = $width;
3110         $this->restart();
3111         if($autostart){
3112             $this->create();
3113         }
3114     }
3115     /**
3116       * Create a new progress bar, this function will output html.
3117       *
3118       * @return void Echo's output
3119       */
3120     public function create(){
3121             flush();
3122             $this->lastcall->pt = 0;
3123             $this->lastcall->time = microtime(true);
3124             if (CLI_SCRIPT) {
3125                 return; // temporary solution for cli scripts
3126             }
3127             $htmlcode = <<<EOT
3128             <div style="text-align:center;width:{$this->width}px;clear:both;padding:0;margin:0 auto;">
3129                 <h2 id="status_{$this->html_id}" style="text-align: center;margin:0 auto"></h2>
3130                 <p id="time_{$this->html_id}"></p>
3131                 <div id="bar_{$this->html_id}" style="border-style:solid;border-width:1px;width:500px;height:50px;">
3132                     <div id="progress_{$this->html_id}"
3133                     style="text-align:center;background:#FFCC66;width:4px;border:1px
3134                     solid gray;height:38px; padding-top:10px;">&nbsp;<span id="pt_{$this->html_id}"></span>
3135                     </div>
3136                 </div>
3137             </div>
3138 EOT;
3139             echo $htmlcode;
3140             flush();
3141     }
3142     /**
3143      * Update the progress bar
3144      *
3145      * @param int $percent from 1-100
3146      * @param string $msg
3147      * @param mixed $es
3148      * @return void Echo's output
3149      */
3150     private function _update($percent, $msg, $es){
3151         global $PAGE;
3152         if(empty($this->time_start)){
3153             $this->time_start = microtime(true);
3154         }
3155         $this->percent = $percent;
3156         $this->lastcall->time = microtime(true);
3157         $this->lastcall->pt   = $percent;
3158         $w = $this->percent * $this->width;
3159         if (CLI_SCRIPT) {
3160             return; // temporary solution for cli scripts
3161         }
3162         if ($es === null){
3163             $es = "Infinity";
3164         }
3165         echo html_writer::script(js_writer::function_call('update_progress_bar', Array($this->html_id, $w, $this->percent, $msg, $es)));
3166         flush();
3167     }
3168     /**
3169       * estimate time
3170       *
3171       * @param int $curtime the time call this function
3172       * @param int $percent from 1-100
3173       * @return mixed Null, or int
3174       */
3175     private function estimate($curtime, $pt){
3176         $consume = $curtime - $this->time_start;
3177         $one = $curtime - $this->lastcall->time;
3178         $this->percent = $pt;
3179         $percent = $pt - $this->lastcall->pt;
3180         if ($percent != 0) {
3181             $left = ($one / $percent) - $consume;
3182         } else {
3183             return null;
3184         }
3185         if($left < 0) {
3186             return 0;
3187         } else {
3188             return $left;
3189         }
3190     }
3191     /**
3192       * Update progress bar according percent
3193       *
3194       * @param int $percent from 1-100
3195       * @param string $msg the message needed to be shown
3196       */
3197     public function update_full($percent, $msg){
3198         $percent = max(min($percent, 100), 0);
3199         if ($percent != 100 && ($this->lastcall->time + $this->minimum_time) > microtime(true)){
3200             return;
3201         }
3202         $this->_update($percent/100, $msg);
3203     }
3204     /**
3205       * Update progress bar according the nubmer of tasks
3206       *
3207       * @param int $cur current task number
3208       * @param int $total total task number
3209       * @param string $msg message
3210       */
3211     public function update($cur, $total, $msg){
3212         $cur = max($cur, 0);
3213         if ($cur >= $total){
3214             $percent = 1;
3215         } else {
3216             $percent = $cur / $total;
3217         }
3218         /**
3219         if ($percent != 1 && ($this->lastcall->time + $this->minimum_time) > microtime(true)){
3220             return;
3221         }
3222         */
3223         $es = $this->estimate(microtime(true), $percent);
3224         $this->_update($percent, $msg, $es);
3225     }
3226     /**
3227      * Restart the progress bar.
3228      */
3229     public function restart(){
3230         $this->percent  = 0;
3231         $this->lastcall = new stdClass;
3232         $this->lastcall->pt = 0;
3233         $this->lastcall->time = microtime(true);
3234         $this->time_start  = 0;
3235     }
3238 /**
3239  * Use this class from long operations where you want to output occasional information about
3240  * what is going on, but don't know if, or in what format, the output should be.
3241  *
3242  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3243  * @package moodlecore
3244  */
3245 abstract class progress_trace {
3246     /**
3247      * Ouput an progress message in whatever format.
3248      * @param string $message the message to output.
3249      * @param integer $depth indent depth for this message.
3250      */
3251     abstract public function output($message, $depth = 0);
3253     /**
3254      * Called when the processing is finished.
3255      */
3256     public function finished() {
3257     }
3260 /**
3261  * This subclass of progress_trace does not ouput anything.
3262  *
3263  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3264  * @package moodlecore
3265  */
3266 class null_progress_trace extends progress_trace {
3267     /**
3268      * Does Nothing
3269      *
3270      * @param string $message
3271      * @param int $depth
3272      * @return void Does Nothing
3273      */
3274     public function output($message, $depth = 0) {
3275     }
3278 /**
3279  * This subclass of progress_trace outputs to plain text.
3280  *
3281  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3282  * @package moodlecore
3283  */
3284 class text_progress_trace extends progress_trace {
3285     /**
3286      * Output the trace message
3287      *
3288      * @param string $message
3289      * @param int $depth
3290      * @return void Output is echo'd
3291      */
3292     public function output($message, $depth = 0) {
3293         echo str_repeat('  ', $depth), $message, "\n";
3294         flush();
3295     }
3298 /**
3299  * This subclass of progress_trace outputs as HTML.
3300  *
3301  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3302  * @package moodlecore
3303  */
3304 class html_progress_trace extends progress_trace {
3305     /**
3306      * Output the trace message
3307      *
3308      * @param string $message
3309      * @param int $depth
3310      * @return void Output is echo'd
3311      */
3312     public function output($message, $depth = 0) {
3313         echo '<p>', str_repeat('&#160;&#160;', $depth), htmlspecialchars($message), "</p>\n";
3314         flush();
3315     }
3318 /**
3319  * HTML List Progress Tree
3320  *
3321  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3322  * @package moodlecore
3323  */
3324 class html_list_progress_trace extends progress_trace {
3325     /** @var int */
3326     protected $currentdepth = -1;
3328     /**
3329      * Echo out the list
3330      *
3331      * @param string $message The message to display
3332      * @param int $depth
3333      * @return void Output is echoed
3334      */
3335     public function output($message, $depth = 0) {
3336         $samedepth = true;
3337         while ($this->currentdepth > $depth) {
3338             echo "</li>\n</ul>\n";
3339             $this->currentdepth -= 1;
3340             if ($this->currentdepth == $depth) {
3341                 echo '<li>';
3342             }
3343             $samedepth = false;
3344         }
3345         while ($this->currentdepth < $depth) {
3346             echo "<ul>\n<li>";
3347             $this->currentdepth += 1;
3348             $samedepth = false;
3349         }
3350         if ($samedepth) {
3351             echo "</li>\n<li>";
3352         }
3353         echo htmlspecialchars($message);
3354         flush();
3355     }
3357     /**
3358      * Called when the processing is finished.
3359      */
3360     public function finished() {
3361         while ($this->currentdepth >= 0) {
3362             echo "</li>\n</ul>\n";
3363             $this->currentdepth -= 1;
3364         }
3365     }
3368 /**
3369  * Return the authentication plugin title
3370  *
3371  * @param string $authtype plugin type
3372  * @return string
3373  */
3374 function auth_get_plugin_title($authtype) {
3375     $authtitle = get_string("auth_{$authtype}title", "auth");
3376     if ($authtitle == "[[auth_{$authtype}title]]") {
3377         $authtitle = get_string("auth_{$authtype}title", "auth_{$authtype}");
3378     }
3379     return $authtitle;
3382 /**
3383  * Returns a localized sentence in the current language summarizing the current password policy
3384  *
3385  * @todo this should be handled by a function/method in the language pack library once we have a support for it
3386  * @uses $CFG
3387  * @return string
3388  */
3389 function print_password_policy() {
3390     global $CFG;
3392     $message = '';
3393     if (!empty($CFG->passwordpolicy)) {
3394         $messages = array();
3395         $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength);
3396         if (!empty($CFG->minpassworddigits)) {
3397             $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits);
3398         }
3399         if (!empty($CFG->minpasswordlower)) {
3400             $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower);
3401         }
3402         if (!empty($CFG->minpasswordupper)) {
3403             $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper);
3404         }
3405         if (!empty($CFG->minpasswordnonalphanum)) {
3406             $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3407         }
3409         $messages = join(', ', $messages); // this is ugly but we do not have anything better yet...
3410         $message = get_string('informpasswordpolicy', 'auth', $messages);
3411     }
3412     return $message;
3415 function create_ufo_inline($id, $args) {
3416     global $CFG;
3417     // must not use $PAGE, $THEME, $COURSE etc. because the result is cached!
3418     
3419     $jsoutput = html_writer::script('', $CFG->wwwroot.'/lib/ufo.js');
3420     $jsoutput .= html_writer::script(js_writer::function_call('M.util.create_UFO_object', array($id, $args)));
3421     return $jsoutput;