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