MDL 38508 JavaScript: Split out AJAX and non-AJAX help
[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 /// Functions
82 /**
83  * Add quotes to HTML characters
84  *
85  * Returns $var with HTML characters (like "<", ">", etc.) properly quoted.
86  * This function is very similar to {@link p()}
87  *
88  * @todo Remove obsolete param $obsolete if not used anywhere
89  *
90  * @param string $var the string potentially containing HTML characters
91  * @param boolean $obsolete no longer used.
92  * @return string
93  */
94 function s($var, $obsolete = false) {
96     if ($var === '0' or $var === false or $var === 0) {
97         return '0';
98     }
100     return preg_replace("/&amp;#(\d+|x[0-7a-fA-F]+);/i", "&#$1;", htmlspecialchars($var, ENT_QUOTES, 'UTF-8', true));
103 /**
104  * Add quotes to HTML characters
105  *
106  * Prints $var with HTML characters (like "<", ">", etc.) properly quoted.
107  * This function simply calls {@link s()}
108  * @see s()
109  *
110  * @todo Remove obsolete param $obsolete if not used anywhere
111  *
112  * @param string $var the string potentially containing HTML characters
113  * @param boolean $obsolete no longer used.
114  * @return string
115  */
116 function p($var, $obsolete = false) {
117     echo s($var, $obsolete);
120 /**
121  * Does proper javascript quoting.
122  *
123  * Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
124  *
125  * @param mixed $var String, Array, or Object to add slashes to
126  * @return mixed quoted result
127  */
128 function addslashes_js($var) {
129     if (is_string($var)) {
130         $var = str_replace('\\', '\\\\', $var);
131         $var = str_replace(array('\'', '"', "\n", "\r", "\0"), array('\\\'', '\\"', '\\n', '\\r', '\\0'), $var);
132         $var = str_replace('</', '<\/', $var);   // XHTML compliance
133     } else if (is_array($var)) {
134         $var = array_map('addslashes_js', $var);
135     } else if (is_object($var)) {
136         $a = get_object_vars($var);
137         foreach ($a as $key=>$value) {
138           $a[$key] = addslashes_js($value);
139         }
140         $var = (object)$a;
141     }
142     return $var;
145 /**
146  * Remove query string from url
147  *
148  * Takes in a URL and returns it without the querystring portion
149  *
150  * @param string $url the url which may have a query string attached
151  * @return string The remaining URL
152  */
153  function strip_querystring($url) {
155     if ($commapos = strpos($url, '?')) {
156         return substr($url, 0, $commapos);
157     } else {
158         return $url;
159     }
162 /**
163  * Returns the URL of the HTTP_REFERER, less the querystring portion if required
164  *
165  * @uses $_SERVER
166  * @param boolean $stripquery if true, also removes the query part of the url.
167  * @return string The resulting referer or empty string
168  */
169 function get_referer($stripquery=true) {
170     if (isset($_SERVER['HTTP_REFERER'])) {
171         if ($stripquery) {
172             return strip_querystring($_SERVER['HTTP_REFERER']);
173         } else {
174             return $_SERVER['HTTP_REFERER'];
175         }
176     } else {
177         return '';
178     }
182 /**
183  * Returns the name of the current script, WITH the querystring portion.
184  *
185  * This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
186  * return different things depending on a lot of things like your OS, Web
187  * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
188  * <b>NOTE:</b> This function returns false if the global variables needed are not set.
189  *
190  * @return mixed String, or false if the global variables needed are not set
191  */
192 function me() {
193     global $ME;
194     return $ME;
197 /**
198  * Guesses the full URL of the current script.
199  *
200  * This function is using $PAGE->url, but may fall back to $FULLME which
201  * is constructed from  PHP_SELF and REQUEST_URI or SCRIPT_NAME
202  *
203  * @return mixed full page URL string or false if unknown
204  */
205 function qualified_me() {
206     global $FULLME, $PAGE, $CFG;
208     if (isset($PAGE) and $PAGE->has_set_url()) {
209         // this is the only recommended way to find out current page
210         return $PAGE->url->out(false);
212     } else {
213         if ($FULLME === null) {
214             // CLI script most probably
215             return false;
216         }
217         if (!empty($CFG->sslproxy)) {
218             // return only https links when using SSL proxy
219             return preg_replace('/^http:/', 'https:', $FULLME, 1);
220         } else {
221             return $FULLME;
222         }
223     }
226 /**
227  * Class for creating and manipulating urls.
228  *
229  * It can be used in moodle pages where config.php has been included without any further includes.
230  *
231  * It is useful for manipulating urls with long lists of params.
232  * One situation where it will be useful is a page which links to itself to perform various actions
233  * and / or to process form data. A moodle_url object :
234  * can be created for a page to refer to itself with all the proper get params being passed from page call to
235  * page call and methods can be used to output a url including all the params, optionally adding and overriding
236  * params and can also be used to
237  *     - output the url without any get params
238  *     - and output the params as hidden fields to be output within a form
239  *
240  * @link http://docs.moodle.org/dev/lib/weblib.php_moodle_url See short write up here
241  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
242  * @package moodlecore
243  */
244 class moodle_url {
245     /**
246      * Scheme, ex.: http, https
247      * @var string
248      */
249     protected $scheme = '';
250     /**
251      * hostname
252      * @var string
253      */
254     protected $host = '';
255     /**
256      * Port number, empty means default 80 or 443 in case of http
257      * @var unknown_type
258      */
259     protected $port = '';
260     /**
261      * Username for http auth
262      * @var string
263      */
264     protected $user = '';
265     /**
266      * Password for http auth
267      * @var string
268      */
269     protected $pass = '';
270     /**
271      * Script path
272      * @var string
273      */
274     protected $path = '';
275     /**
276      * Optional slash argument value
277      * @var string
278      */
279     protected $slashargument = '';
280     /**
281      * Anchor, may be also empty, null means none
282      * @var string
283      */
284     protected $anchor = null;
285     /**
286      * Url parameters as associative array
287      * @var array
288      */
289     protected $params = array(); // Associative array of query string params
291     /**
292      * Create new instance of moodle_url.
293      *
294      * @param moodle_url|string $url - moodle_url means make a copy of another
295      *      moodle_url and change parameters, string means full url or shortened
296      *      form (ex.: '/course/view.php'). It is strongly encouraged to not include
297      *      query string because it may result in double encoded values. Use the
298      *      $params instead. For admin URLs, just use /admin/script.php, this
299      *      class takes care of the $CFG->admin issue.
300      * @param array $params these params override current params or add new
301      */
302     public function __construct($url, array $params = null) {
303         global $CFG;
305         if ($url instanceof moodle_url) {
306             $this->scheme = $url->scheme;
307             $this->host = $url->host;
308             $this->port = $url->port;
309             $this->user = $url->user;
310             $this->pass = $url->pass;
311             $this->path = $url->path;
312             $this->slashargument = $url->slashargument;
313             $this->params = $url->params;
314             $this->anchor = $url->anchor;
316         } else {
317             // detect if anchor used
318             $apos = strpos($url, '#');
319             if ($apos !== false) {
320                 $anchor = substr($url, $apos);
321                 $anchor = ltrim($anchor, '#');
322                 $this->set_anchor($anchor);
323                 $url = substr($url, 0, $apos);
324             }
326             // normalise shortened form of our url ex.: '/course/view.php'
327             if (strpos($url, '/') === 0) {
328                 // we must not use httpswwwroot here, because it might be url of other page,
329                 // devs have to use httpswwwroot explicitly when creating new moodle_url
330                 $url = $CFG->wwwroot.$url;
331             }
333             // now fix the admin links if needed, no need to mess with httpswwwroot
334             if ($CFG->admin !== 'admin') {
335                 if (strpos($url, "$CFG->wwwroot/admin/") === 0) {
336                     $url = str_replace("$CFG->wwwroot/admin/", "$CFG->wwwroot/$CFG->admin/", $url);
337                 }
338             }
340             // parse the $url
341             $parts = parse_url($url);
342             if ($parts === false) {
343                 throw new moodle_exception('invalidurl');
344             }
345             if (isset($parts['query'])) {
346                 // note: the values may not be correctly decoded,
347                 //       url parameters should be always passed as array
348                 parse_str(str_replace('&amp;', '&', $parts['query']), $this->params);
349             }
350             unset($parts['query']);
351             foreach ($parts as $key => $value) {
352                 $this->$key = $value;
353             }
355             // detect slashargument value from path - we do not support directory names ending with .php
356             $pos = strpos($this->path, '.php/');
357             if ($pos !== false) {
358                 $this->slashargument = substr($this->path, $pos + 4);
359                 $this->path = substr($this->path, 0, $pos + 4);
360             }
361         }
363         $this->params($params);
364     }
366     /**
367      * Add an array of params to the params for this url.
368      *
369      * The added params override existing ones if they have the same name.
370      *
371      * @param array $params Defaults to null. If null then returns all params.
372      * @return array Array of Params for url.
373      */
374     public function params(array $params = null) {
375         $params = (array)$params;
377         foreach ($params as $key=>$value) {
378             if (is_int($key)) {
379                 throw new coding_exception('Url parameters can not have numeric keys!');
380             }
381             if (!is_string($value)) {
382                 if (is_array($value)) {
383                     throw new coding_exception('Url parameters values can not be arrays!');
384                 }
385                 if (is_object($value) and !method_exists($value, '__toString')) {
386                     throw new coding_exception('Url parameters values can not be objects, unless __toString() is defined!');
387                 }
388             }
389             $this->params[$key] = (string)$value;
390         }
391         return $this->params;
392     }
394     /**
395      * Remove all params if no arguments passed.
396      * Remove selected params if arguments are passed.
397      *
398      * Can be called as either remove_params('param1', 'param2')
399      * or remove_params(array('param1', 'param2')).
400      *
401      * @param mixed $params either an array of param names, or a string param name,
402      * @param string $params,... any number of additional param names.
403      * @return array url parameters
404      */
405     public function remove_params($params = null) {
406         if (!is_array($params)) {
407             $params = func_get_args();
408         }
409         foreach ($params as $param) {
410             unset($this->params[$param]);
411         }
412         return $this->params;
413     }
415     /**
416      * Remove all url parameters
417      * @param $params
418      * @return void
419      */
420     public function remove_all_params($params = null) {
421         $this->params = array();
422         $this->slashargument = '';
423     }
425     /**
426      * Add a param to the params for this url.
427      *
428      * The added param overrides existing one if they have the same name.
429      *
430      * @param string $paramname name
431      * @param string $newvalue Param value. If new value specified current value is overriden or parameter is added
432      * @return mixed string parameter value, null if parameter does not exist
433      */
434     public function param($paramname, $newvalue = '') {
435         if (func_num_args() > 1) {
436             // set new value
437             $this->params(array($paramname=>$newvalue));
438         }
439         if (isset($this->params[$paramname])) {
440             return $this->params[$paramname];
441         } else {
442             return null;
443         }
444     }
446     /**
447      * Merges parameters and validates them
448      * @param array $overrideparams
449      * @return array merged parameters
450      */
451     protected function merge_overrideparams(array $overrideparams = null) {
452         $overrideparams = (array)$overrideparams;
453         $params = $this->params;
454         foreach ($overrideparams as $key=>$value) {
455             if (is_int($key)) {
456                 throw new coding_exception('Overridden parameters can not have numeric keys!');
457             }
458             if (is_array($value)) {
459                 throw new coding_exception('Overridden parameters values can not be arrays!');
460             }
461             if (is_object($value) and !method_exists($value, '__toString')) {
462                 throw new coding_exception('Overridden parameters values can not be objects, unless __toString() is defined!');
463             }
464             $params[$key] = (string)$value;
465         }
466         return $params;
467     }
469     /**
470      * Get the params as as a query string.
471      * This method should not be used outside of this method.
472      *
473      * @param boolean $escaped Use &amp; as params separator instead of plain &
474      * @param array $overrideparams params to add to the output params, these
475      *      override existing ones with the same name.
476      * @return string query string that can be added to a url.
477      */
478     public function get_query_string($escaped = true, array $overrideparams = null) {
479         $arr = array();
480         if ($overrideparams !== null) {
481             $params = $this->merge_overrideparams($overrideparams);
482         } else {
483             $params = $this->params;
484         }
485         foreach ($params as $key => $val) {
486             if (is_array($val)) {
487                 foreach ($val as $index => $value) {
488                     $arr[] = rawurlencode($key.'['.$index.']')."=".rawurlencode($value);
489                 }
490             } else {
491                 $arr[] = rawurlencode($key)."=".rawurlencode($val);
492             }
493         }
494         if ($escaped) {
495             return implode('&amp;', $arr);
496         } else {
497             return implode('&', $arr);
498         }
499     }
501     /**
502      * Shortcut for printing of encoded URL.
503      * @return string
504      */
505     public function __toString() {
506         return $this->out(true);
507     }
509     /**
510      * Output url
511      *
512      * If you use the returned URL in HTML code, you want the escaped ampersands. If you use
513      * the returned URL in HTTP headers, you want $escaped=false.
514      *
515      * @param boolean $escaped Use &amp; as params separator instead of plain &
516      * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
517      * @return string Resulting URL
518      */
519     public function out($escaped = true, array $overrideparams = null) {
520         if (!is_bool($escaped)) {
521             debugging('Escape parameter must be of type boolean, '.gettype($escaped).' given instead.');
522         }
524         $uri = $this->out_omit_querystring().$this->slashargument;
526         $querystring = $this->get_query_string($escaped, $overrideparams);
527         if ($querystring !== '') {
528             $uri .= '?' . $querystring;
529         }
530         if (!is_null($this->anchor)) {
531             $uri .= '#'.$this->anchor;
532         }
534         return $uri;
535     }
537     /**
538      * Returns url without parameters, everything before '?'.
539      *
540      * @param bool $includeanchor if {@link self::anchor} is defined, should it be returned?
541      * @return string
542      */
543     public function out_omit_querystring($includeanchor = false) {
545         $uri = $this->scheme ? $this->scheme.':'.((strtolower($this->scheme) == 'mailto') ? '':'//'): '';
546         $uri .= $this->user ? $this->user.($this->pass? ':'.$this->pass:'').'@':'';
547         $uri .= $this->host ? $this->host : '';
548         $uri .= $this->port ? ':'.$this->port : '';
549         $uri .= $this->path ? $this->path : '';
550         if ($includeanchor and !is_null($this->anchor)) {
551             $uri .= '#' . $this->anchor;
552         }
554         return $uri;
555     }
557     /**
558      * Compares this moodle_url with another
559      * See documentation of constants for an explanation of the comparison flags.
560      * @param moodle_url $url The moodle_url object to compare
561      * @param int $matchtype The type of comparison (URL_MATCH_BASE, URL_MATCH_PARAMS, URL_MATCH_EXACT)
562      * @return boolean
563      */
564     public function compare(moodle_url $url, $matchtype = URL_MATCH_EXACT) {
566         $baseself = $this->out_omit_querystring();
567         $baseother = $url->out_omit_querystring();
569         // Append index.php if there is no specific file
570         if (substr($baseself,-1)=='/') {
571             $baseself .= 'index.php';
572         }
573         if (substr($baseother,-1)=='/') {
574             $baseother .= 'index.php';
575         }
577         // Compare the two base URLs
578         if ($baseself != $baseother) {
579             return false;
580         }
582         if ($matchtype == URL_MATCH_BASE) {
583             return true;
584         }
586         $urlparams = $url->params();
587         foreach ($this->params() as $param => $value) {
588             if ($param == 'sesskey') {
589                 continue;
590             }
591             if (!array_key_exists($param, $urlparams) || $urlparams[$param] != $value) {
592                 return false;
593             }
594         }
596         if ($matchtype == URL_MATCH_PARAMS) {
597             return true;
598         }
600         foreach ($urlparams as $param => $value) {
601             if ($param == 'sesskey') {
602                 continue;
603             }
604             if (!array_key_exists($param, $this->params()) || $this->param($param) != $value) {
605                 return false;
606             }
607         }
609         return true;
610     }
612     /**
613      * Sets the anchor for the URI (the bit after the hash)
614      * @param string $anchor null means remove previous
615      */
616     public function set_anchor($anchor) {
617         if (is_null($anchor)) {
618             // remove
619             $this->anchor = null;
620         } else if ($anchor === '') {
621             // special case, used as empty link
622             $this->anchor = '';
623         } else if (preg_match('|[a-zA-Z\_\:][a-zA-Z0-9\_\-\.\:]*|', $anchor)) {
624             // Match the anchor against the NMTOKEN spec
625             $this->anchor = $anchor;
626         } else {
627             // bad luck, no valid anchor found
628             $this->anchor = null;
629         }
630     }
632     /**
633      * Sets the url slashargument value
634      * @param string $path usually file path
635      * @param string $parameter name of page parameter if slasharguments not supported
636      * @param bool $supported usually null, then it depends on $CFG->slasharguments, use true or false for other servers
637      * @return void
638      */
639     public function set_slashargument($path, $parameter = 'file', $supported = NULL) {
640         global $CFG;
641         if (is_null($supported)) {
642             $supported = $CFG->slasharguments;
643         }
645         if ($supported) {
646             $parts = explode('/', $path);
647             $parts = array_map('rawurlencode', $parts);
648             $path  = implode('/', $parts);
649             $this->slashargument = $path;
650             unset($this->params[$parameter]);
652         } else {
653             $this->slashargument = '';
654             $this->params[$parameter] = $path;
655         }
656     }
658     // == static factory methods ==
660     /**
661      * General moodle file url.
662      * @param string $urlbase the script serving the file
663      * @param string $path
664      * @param bool $forcedownload
665      * @return moodle_url
666      */
667     public static function make_file_url($urlbase, $path, $forcedownload = false) {
668         global $CFG;
670         $params = array();
671         if ($forcedownload) {
672             $params['forcedownload'] = 1;
673         }
675         $url = new moodle_url($urlbase, $params);
676         $url->set_slashargument($path);
678         return $url;
679     }
681     /**
682      * Factory method for creation of url pointing to plugin file.
683      * Please note this method can be used only from the plugins to
684      * create urls of own files, it must not be used outside of plugins!
685      * @param int $contextid
686      * @param string $component
687      * @param string $area
688      * @param int $itemid
689      * @param string $pathname
690      * @param string $filename
691      * @param bool $forcedownload
692      * @return moodle_url
693      */
694     public static function make_pluginfile_url($contextid, $component, $area, $itemid, $pathname, $filename, $forcedownload = false) {
695         global $CFG;
696         $urlbase = "$CFG->httpswwwroot/pluginfile.php";
697         if ($itemid === NULL) {
698             return self::make_file_url($urlbase, "/$contextid/$component/$area".$pathname.$filename, $forcedownload);
699         } else {
700             return self::make_file_url($urlbase, "/$contextid/$component/$area/$itemid".$pathname.$filename, $forcedownload);
701         }
702     }
704     /**
705      * Factory method for creation of url pointing to draft
706      * file of current user.
707      * @param int $draftid draft item id
708      * @param string $pathname
709      * @param string $filename
710      * @param bool $forcedownload
711      * @return moodle_url
712      */
713     public static function make_draftfile_url($draftid, $pathname, $filename, $forcedownload = false) {
714         global $CFG, $USER;
715         $urlbase = "$CFG->httpswwwroot/draftfile.php";
716         $context = context_user::instance($USER->id);
718         return self::make_file_url($urlbase, "/$context->id/user/draft/$draftid".$pathname.$filename, $forcedownload);
719     }
721     /**
722      * Factory method for creating of links to legacy
723      * course files.
724      * @param int $courseid
725      * @param string $filepath
726      * @param bool $forcedownload
727      * @return moodle_url
728      */
729     public static function make_legacyfile_url($courseid, $filepath, $forcedownload = false) {
730         global $CFG;
732         $urlbase = "$CFG->wwwroot/file.php";
733         return self::make_file_url($urlbase, '/'.$courseid.'/'.$filepath, $forcedownload);
734     }
736     /**
737      * Returns URL a relative path from $CFG->wwwroot
738      *
739      * Can be used for passing around urls with the wwwroot stripped
740      *
741      * @param boolean $escaped Use &amp; as params separator instead of plain &
742      * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
743      * @return string Resulting URL
744      * @throws coding_exception if called on a non-local url
745      */
746     public function out_as_local_url($escaped = true, array $overrideparams = null) {
747         global $CFG;
749         $url = $this->out($escaped, $overrideparams);
750         $httpswwwroot = str_replace("http://", "https://", $CFG->wwwroot);
752         // $url should be equal to wwwroot or httpswwwroot. If not then throw exception.
753         if (($url === $CFG->wwwroot) || (strpos($url, $CFG->wwwroot.'/') === 0)) {
754             $localurl = substr($url, strlen($CFG->wwwroot));
755             return !empty($localurl) ? $localurl : '';
756         } else if (($url === $httpswwwroot) || (strpos($url, $httpswwwroot.'/') === 0)) {
757             $localurl = substr($url, strlen($httpswwwroot));
758             return !empty($localurl) ? $localurl : '';
759         } else {
760             throw new coding_exception('out_as_local_url called on a non-local URL');
761         }
762     }
764     /**
765      * Returns the 'path' portion of a URL. For example, if the URL is
766      * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
767      * return '/my/file/is/here.txt'.
768      *
769      * By default the path includes slash-arguments (for example,
770      * '/myfile.php/extra/arguments') so it is what you would expect from a
771      * URL path. If you don't want this behaviour, you can opt to exclude the
772      * slash arguments. (Be careful: if the $CFG variable slasharguments is
773      * disabled, these URLs will have a different format and you may need to
774      * look at the 'file' parameter too.)
775      *
776      * @param bool $includeslashargument If true, includes slash arguments
777      * @return string Path of URL
778      */
779     public function get_path($includeslashargument = true) {
780         return $this->path . ($includeslashargument ? $this->slashargument : '');
781     }
783     /**
784      * Returns a given parameter value from the URL.
785      *
786      * @param string $name Name of parameter
787      * @return string Value of parameter or null if not set
788      */
789     public function get_param($name) {
790         if (array_key_exists($name, $this->params)) {
791             return $this->params[$name];
792         } else {
793             return null;
794         }
795     }
798 /**
799  * Determine if there is data waiting to be processed from a form
800  *
801  * Used on most forms in Moodle to check for data
802  * Returns the data as an object, if it's found.
803  * This object can be used in foreach loops without
804  * casting because it's cast to (array) automatically
805  *
806  * Checks that submitted POST data exists and returns it as object.
807  *
808  * @uses $_POST
809  * @return mixed false or object
810  */
811 function data_submitted() {
813     if (empty($_POST)) {
814         return false;
815     } else {
816         return (object)fix_utf8($_POST);
817     }
820 /**
821  * Given some normal text this function will break up any
822  * long words to a given size by inserting the given character
823  *
824  * It's multibyte savvy and doesn't change anything inside html tags.
825  *
826  * @param string $string the string to be modified
827  * @param int $maxsize maximum length of the string to be returned
828  * @param string $cutchar the string used to represent word breaks
829  * @return string
830  */
831 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
833 /// First of all, save all the tags inside the text to skip them
834     $tags = array();
835     filter_save_tags($string,$tags);
837 /// Process the string adding the cut when necessary
838     $output = '';
839     $length = textlib::strlen($string);
840     $wordlength = 0;
842     for ($i=0; $i<$length; $i++) {
843         $char = textlib::substr($string, $i, 1);
844         if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
845             $wordlength = 0;
846         } else {
847             $wordlength++;
848             if ($wordlength > $maxsize) {
849                 $output .= $cutchar;
850                 $wordlength = 0;
851             }
852         }
853         $output .= $char;
854     }
856 /// Finally load the tags back again
857     if (!empty($tags)) {
858         $output = str_replace(array_keys($tags), $tags, $output);
859     }
861     return $output;
864 /**
865  * Try and close the current window using JavaScript, either immediately, or after a delay.
866  *
867  * Echo's out the resulting XHTML & javascript
868  *
869  * @global object
870  * @global object
871  * @param integer $delay a delay in seconds before closing the window. Default 0.
872  * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
873  *      to reload the parent window before this one closes.
874  */
875 function close_window($delay = 0, $reloadopener = false) {
876     global $PAGE, $OUTPUT;
878     if (!$PAGE->headerprinted) {
879         $PAGE->set_title(get_string('closewindow'));
880         echo $OUTPUT->header();
881     } else {
882         $OUTPUT->container_end_all(false);
883     }
885     if ($reloadopener) {
886         // Trigger the reload immediately, even if the reload is after a delay.
887         $PAGE->requires->js_function_call('window.opener.location.reload', array(true));
888     }
889     $OUTPUT->notification(get_string('windowclosing'), 'notifysuccess');
891     $PAGE->requires->js_function_call('close_window', array(new stdClass()), false, $delay);
893     echo $OUTPUT->footer();
894     exit;
897 /**
898  * Returns a string containing a link to the user documentation for the current
899  * page. Also contains an icon by default. Shown to teachers and admin only.
900  *
901  * @global object
902  * @global object
903  * @param string $text The text to be displayed for the link
904  * @param string $iconpath The path to the icon to be displayed
905  * @return string The link to user documentation for this current page
906  */
907 function page_doc_link($text='') {
908     global $CFG, $PAGE, $OUTPUT;
910     if (empty($CFG->docroot) || during_initial_install()) {
911         return '';
912     }
913     if (!has_capability('moodle/site:doclinks', $PAGE->context)) {
914         return '';
915     }
917     $path = $PAGE->docspath;
918     if (!$path) {
919         return '';
920     }
921     return $OUTPUT->doc_link($path, $text);
925 /**
926  * Validates an email to make sure it makes sense.
927  *
928  * @param string $address The email address to validate.
929  * @return boolean
930  */
931 function validate_email($address) {
933     return (preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
934                  '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
935                   '@'.
936                   '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
937                   '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
938                   $address));
941 /**
942  * Extracts file argument either from file parameter or PATH_INFO
943  * Note: $scriptname parameter is not needed anymore
944  *
945  * @global string
946  * @uses $_SERVER
947  * @uses PARAM_PATH
948  * @return string file path (only safe characters)
949  */
950 function get_file_argument() {
951     global $SCRIPT;
953     $relativepath = optional_param('file', FALSE, PARAM_PATH);
955     if ($relativepath !== false and $relativepath !== '') {
956         return $relativepath;
957     }
958     $relativepath = false;
960     // then try extract file from the slasharguments
961     if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
962         // NOTE: ISS tends to convert all file paths to single byte DOS encoding,
963         //       we can not use other methods because they break unicode chars,
964         //       the only way is to use URL rewriting
965         if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
966             // check that PATH_INFO works == must not contain the script name
967             if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
968                 $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
969             }
970         }
971     } else {
972         // all other apache-like servers depend on PATH_INFO
973         if (isset($_SERVER['PATH_INFO'])) {
974             if (isset($_SERVER['SCRIPT_NAME']) and strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === 0) {
975                 $relativepath = substr($_SERVER['PATH_INFO'], strlen($_SERVER['SCRIPT_NAME']));
976             } else {
977                 $relativepath = $_SERVER['PATH_INFO'];
978             }
979             $relativepath = clean_param($relativepath, PARAM_PATH);
980         }
981     }
984     return $relativepath;
987 /**
988  * Just returns an array of text formats suitable for a popup menu
989  *
990  * @uses FORMAT_MOODLE
991  * @uses FORMAT_HTML
992  * @uses FORMAT_PLAIN
993  * @uses FORMAT_MARKDOWN
994  * @return array
995  */
996 function format_text_menu() {
997     return array (FORMAT_MOODLE => get_string('formattext'),
998                   FORMAT_HTML   => get_string('formathtml'),
999                   FORMAT_PLAIN  => get_string('formatplain'),
1000                   FORMAT_MARKDOWN  => get_string('formatmarkdown'));
1003 /**
1004  * Given text in a variety of format codings, this function returns
1005  * the text as safe HTML.
1006  *
1007  * This function should mainly be used for long strings like posts,
1008  * answers, glossary items etc. For short strings @see format_string().
1009  *
1010  * <pre>
1011  * Options:
1012  *      trusted     :   If true the string won't be cleaned. Default false required noclean=true.
1013  *      noclean     :   If true the string won't be cleaned. Default false required trusted=true.
1014  *      nocache     :   If true the strign will not be cached and will be formatted every call. Default false.
1015  *      filter      :   If true the string will be run through applicable filters as well. Default true.
1016  *      para        :   If true then the returned string will be wrapped in div tags. Default true.
1017  *      newlines    :   If true then lines newline breaks will be converted to HTML newline breaks. Default true.
1018  *      context     :   The context that will be used for filtering.
1019  *      overflowdiv :   If set to true the formatted text will be encased in a div
1020  *                      with the class no-overflow before being returned. Default false.
1021  *      allowid     :   If true then id attributes will not be removed, even when
1022  *                      using htmlpurifier. Default false.
1023  * </pre>
1024  *
1025  * @todo Finish documenting this function
1026  *
1027  * @staticvar array $croncache
1028  * @param string $text The text to be formatted. This is raw text originally from user input.
1029  * @param int $format Identifier of the text format to be used
1030  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
1031  * @param object/array $options text formatting options
1032  * @param int $courseid_do_not_use deprecated course id, use context option instead
1033  * @return string
1034  */
1035 function format_text($text, $format = FORMAT_MOODLE, $options = NULL, $courseid_do_not_use = NULL) {
1036     global $CFG, $COURSE, $DB, $PAGE;
1037     static $croncache = array();
1039     if ($text === '' || is_null($text)) {
1040         return ''; // no need to do any filters and cleaning
1041     }
1043     $options = (array)$options; // detach object, we can not modify it
1045     if (!isset($options['trusted'])) {
1046         $options['trusted'] = false;
1047     }
1048     if (!isset($options['noclean'])) {
1049         if ($options['trusted'] and trusttext_active()) {
1050             // no cleaning if text trusted and noclean not specified
1051             $options['noclean'] = true;
1052         } else {
1053             $options['noclean'] = false;
1054         }
1055     }
1056     if (!isset($options['nocache'])) {
1057         $options['nocache'] = false;
1058     }
1059     if (!isset($options['filter'])) {
1060         $options['filter'] = true;
1061     }
1062     if (!isset($options['para'])) {
1063         $options['para'] = true;
1064     }
1065     if (!isset($options['newlines'])) {
1066         $options['newlines'] = true;
1067     }
1068     if (!isset($options['overflowdiv'])) {
1069         $options['overflowdiv'] = false;
1070     }
1072     // Calculate best context
1073     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
1074         // do not filter anything during installation or before upgrade completes
1075         $context = null;
1077     } else if (isset($options['context'])) { // first by explicit passed context option
1078         if (is_object($options['context'])) {
1079             $context = $options['context'];
1080         } else {
1081             $context = context::instance_by_id($options['context']);
1082         }
1083     } else if ($courseid_do_not_use) {
1084         // legacy courseid
1085         $context = context_course::instance($courseid_do_not_use);
1086     } else {
1087         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1088         $context = $PAGE->context;
1089     }
1091     if (!$context) {
1092         // either install/upgrade or something has gone really wrong because context does not exist (yet?)
1093         $options['nocache'] = true;
1094         $options['filter']  = false;
1095     }
1097     if ($options['filter']) {
1098         $filtermanager = filter_manager::instance();
1099         $filtermanager->setup_page_for_filters($PAGE, $context); // Setup global stuff filters may have.
1100     } else {
1101         $filtermanager = new null_filter_manager();
1102     }
1104     if (!empty($CFG->cachetext) and empty($options['nocache'])) {
1105         $hashstr = $text.'-'.$filtermanager->text_filtering_hash($context).'-'.$context->id.'-'.current_language().'-'.
1106                 (int)$format.(int)$options['trusted'].(int)$options['noclean'].
1107                 (int)$options['para'].(int)$options['newlines'];
1109         $time = time() - $CFG->cachetext;
1110         $md5key = md5($hashstr);
1111         if (CLI_SCRIPT) {
1112             if (isset($croncache[$md5key])) {
1113                 return $croncache[$md5key];
1114             }
1115         }
1117         if ($oldcacheitem = $DB->get_record('cache_text', array('md5key'=>$md5key), '*', IGNORE_MULTIPLE)) {
1118             if ($oldcacheitem->timemodified >= $time) {
1119                 if (CLI_SCRIPT) {
1120                     if (count($croncache) > 150) {
1121                         reset($croncache);
1122                         $key = key($croncache);
1123                         unset($croncache[$key]);
1124                     }
1125                     $croncache[$md5key] = $oldcacheitem->formattedtext;
1126                 }
1127                 return $oldcacheitem->formattedtext;
1128             }
1129         }
1130     }
1132     switch ($format) {
1133         case FORMAT_HTML:
1134             if (!$options['noclean']) {
1135                 $text = clean_text($text, FORMAT_HTML, $options);
1136             }
1137             $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_HTML, 'noclean' => $options['noclean']));
1138             break;
1140         case FORMAT_PLAIN:
1141             $text = s($text); // cleans dangerous JS
1142             $text = rebuildnolinktag($text);
1143             $text = str_replace('  ', '&nbsp; ', $text);
1144             $text = nl2br($text);
1145             break;
1147         case FORMAT_WIKI:
1148             // this format is deprecated
1149             $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle.  You should not be seeing
1150                      this message as all texts should have been converted to Markdown format instead.
1151                      Please post a bug report to http://moodle.org/bugs with information about where you
1152                      saw this message.</p>'.s($text);
1153             break;
1155         case FORMAT_MARKDOWN:
1156             $text = markdown_to_html($text);
1157             if (!$options['noclean']) {
1158                 $text = clean_text($text, FORMAT_HTML, $options);
1159             }
1160             $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_MARKDOWN, 'noclean' => $options['noclean']));
1161             break;
1163         default:  // FORMAT_MOODLE or anything else
1164             $text = text_to_html($text, null, $options['para'], $options['newlines']);
1165             if (!$options['noclean']) {
1166                 $text = clean_text($text, FORMAT_HTML, $options);
1167             }
1168             $text = $filtermanager->filter_text($text, $context, array('originalformat' => $format, 'noclean' => $options['noclean']));
1169             break;
1170     }
1171     if ($options['filter']) {
1172         // at this point there should not be any draftfile links any more,
1173         // this happens when developers forget to post process the text.
1174         // The only potential problem is that somebody might try to format
1175         // the text before storing into database which would be itself big bug.
1176         $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
1177     }
1179     // Warn people that we have removed this old mechanism, just in case they
1180     // were stupid enough to rely on it.
1181     if (isset($CFG->currenttextiscacheable)) {
1182         debugging('Once upon a time, Moodle had a truly evil use of global variables ' .
1183                 'called $CFG->currenttextiscacheable. The good news is that this no ' .
1184                 'longer exists. The bad news is that you seem to be using a filter that '.
1185                 'relies on it. Please seek out and destroy that filter code.', DEBUG_DEVELOPER);
1186     }
1188     if (!empty($options['overflowdiv'])) {
1189         $text = html_writer::tag('div', $text, array('class'=>'no-overflow'));
1190     }
1192     if (empty($options['nocache']) and !empty($CFG->cachetext)) {
1193         if (CLI_SCRIPT) {
1194             // special static cron cache - no need to store it in db if its not already there
1195             if (count($croncache) > 150) {
1196                 reset($croncache);
1197                 $key = key($croncache);
1198                 unset($croncache[$key]);
1199             }
1200             $croncache[$md5key] = $text;
1201             return $text;
1202         }
1204         $newcacheitem = new stdClass();
1205         $newcacheitem->md5key = $md5key;
1206         $newcacheitem->formattedtext = $text;
1207         $newcacheitem->timemodified = time();
1208         if ($oldcacheitem) {                               // See bug 4677 for discussion
1209             $newcacheitem->id = $oldcacheitem->id;
1210             try {
1211                 $DB->update_record('cache_text', $newcacheitem);   // Update existing record in the cache table
1212             } catch (dml_exception $e) {
1213                // It's unlikely that the cron cache cleaner could have
1214                // deleted this entry in the meantime, as it allows
1215                // some extra time to cover these cases.
1216             }
1217         } else {
1218             try {
1219                 $DB->insert_record('cache_text', $newcacheitem);   // Insert a new record in the cache table
1220             } catch (dml_exception $e) {
1221                // Again, it's possible that another user has caused this
1222                // record to be created already in the time that it took
1223                // to traverse this function.  That's OK too, as the
1224                // call above handles duplicate entries, and eventually
1225                // the cron cleaner will delete them.
1226             }
1227         }
1228     }
1230     return $text;
1233 /**
1234  * Resets all data related to filters, called during upgrade or when filter settings change.
1235  *
1236  * @param bool $phpunitreset true means called from our PHPUnit integration test reset
1237  * @return void
1238  */
1239 function reset_text_filters_cache($phpunitreset = false) {
1240     global $CFG, $DB;
1242     if (!$phpunitreset) {
1243         $DB->delete_records('cache_text');
1244     }
1246     $purifdir = $CFG->cachedir.'/htmlpurifier';
1247     remove_dir($purifdir, true);
1250 /**
1251  * Given a simple string, this function returns the string
1252  * processed by enabled string filters if $CFG->filterall is enabled
1253  *
1254  * This function should be used to print short strings (non html) that
1255  * need filter processing e.g. activity titles, post subjects,
1256  * glossary concepts.
1257  *
1258  * @staticvar bool $strcache
1259  * @param string $string The string to be filtered. Should be plain text, expect
1260  * possibly for multilang tags.
1261  * @param boolean $striplinks To strip any link in the result text.
1262                               Moodle 1.8 default changed from false to true! MDL-8713
1263  * @param array $options options array/object or courseid
1264  * @return string
1265  */
1266 function format_string($string, $striplinks = true, $options = NULL) {
1267     global $CFG, $COURSE, $PAGE;
1269     //We'll use a in-memory cache here to speed up repeated strings
1270     static $strcache = false;
1272     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
1273         // do not filter anything during installation or before upgrade completes
1274         return $string = strip_tags($string);
1275     }
1277     if ($strcache === false or count($strcache) > 2000) { // this number might need some tuning to limit memory usage in cron
1278         $strcache = array();
1279     }
1281     if (is_numeric($options)) {
1282         // legacy courseid usage
1283         $options  = array('context'=>context_course::instance($options));
1284     } else {
1285         $options = (array)$options; // detach object, we can not modify it
1286     }
1288     if (empty($options['context'])) {
1289         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1290         $options['context'] = $PAGE->context;
1291     } else if (is_numeric($options['context'])) {
1292         $options['context'] = context::instance_by_id($options['context']);
1293     }
1295     if (!$options['context']) {
1296         // we did not find any context? weird
1297         return $string = strip_tags($string);
1298     }
1300     //Calculate md5
1301     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id.'<+>'.current_language());
1303     //Fetch from cache if possible
1304     if (isset($strcache[$md5])) {
1305         return $strcache[$md5];
1306     }
1308     // First replace all ampersands not followed by html entity code
1309     // Regular expression moved to its own method for easier unit testing
1310     $string = replace_ampersands_not_followed_by_entity($string);
1312     if (!empty($CFG->filterall)) {
1313         $filtermanager = filter_manager::instance();
1314         $filtermanager->setup_page_for_filters($PAGE, $options['context']); // Setup global stuff filters may have.
1315         $string = $filtermanager->filter_string($string, $options['context']);
1316     }
1318     // If the site requires it, strip ALL tags from this string
1319     if (!empty($CFG->formatstringstriptags)) {
1320         $string = str_replace(array('<', '>'), array('&lt;', '&gt;'), strip_tags($string));
1322     } else {
1323         // Otherwise strip just links if that is required (default)
1324         if ($striplinks) {  //strip links in string
1325             $string = strip_links($string);
1326         }
1327         $string = clean_text($string);
1328     }
1330     //Store to cache
1331     $strcache[$md5] = $string;
1333     return $string;
1336 /**
1337  * Given a string, performs a negative lookahead looking for any ampersand character
1338  * that is not followed by a proper HTML entity. If any is found, it is replaced
1339  * by &amp;. The string is then returned.
1340  *
1341  * @param string $string
1342  * @return string
1343  */
1344 function replace_ampersands_not_followed_by_entity($string) {
1345     return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1348 /**
1349  * Given a string, replaces all <a>.*</a> by .* and returns the string.
1350  *
1351  * @param string $string
1352  * @return string
1353  */
1354 function strip_links($string) {
1355     return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is','$2',$string);
1358 /**
1359  * This expression turns links into something nice in a text format. (Russell Jungwirth)
1360  *
1361  * @param string $string
1362  * @return string
1363  */
1364 function wikify_links($string) {
1365     return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i','$3 [ $2 ]', $string);
1368 /**
1369  * Given text in a variety of format codings, this function returns
1370  * the text as plain text suitable for plain email.
1371  *
1372  * @uses FORMAT_MOODLE
1373  * @uses FORMAT_HTML
1374  * @uses FORMAT_PLAIN
1375  * @uses FORMAT_WIKI
1376  * @uses FORMAT_MARKDOWN
1377  * @param string $text The text to be formatted. This is raw text originally from user input.
1378  * @param int $format Identifier of the text format to be used
1379  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1380  * @return string
1381  */
1382 function format_text_email($text, $format) {
1384     switch ($format) {
1386         case FORMAT_PLAIN:
1387             return $text;
1388             break;
1390         case FORMAT_WIKI:
1391             // there should not be any of these any more!
1392             $text = wikify_links($text);
1393             return textlib::entities_to_utf8(strip_tags($text), true);
1394             break;
1396         case FORMAT_HTML:
1397             return html_to_text($text);
1398             break;
1400         case FORMAT_MOODLE:
1401         case FORMAT_MARKDOWN:
1402         default:
1403             $text = wikify_links($text);
1404             return textlib::entities_to_utf8(strip_tags($text), true);
1405             break;
1406     }
1409 /**
1410  * Formats activity intro text
1411  *
1412  * @global object
1413  * @uses CONTEXT_MODULE
1414  * @param string $module name of module
1415  * @param object $activity instance of activity
1416  * @param int $cmid course module id
1417  * @param bool $filter filter resulting html text
1418  * @return text
1419  */
1420 function format_module_intro($module, $activity, $cmid, $filter=true) {
1421     global $CFG;
1422     require_once("$CFG->libdir/filelib.php");
1423     $context = context_module::instance($cmid);
1424     $options = array('noclean'=>true, 'para'=>false, 'filter'=>$filter, 'context'=>$context, 'overflowdiv'=>true);
1425     $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, 'mod_'.$module, 'intro', null);
1426     return trim(format_text($intro, $activity->introformat, $options, null));
1429 /**
1430  * Legacy function, used for cleaning of old forum and glossary text only.
1431  *
1432  * @global object
1433  * @param string $text text that may contain legacy TRUSTTEXT marker
1434  * @return text without legacy TRUSTTEXT marker
1435  */
1436 function trusttext_strip($text) {
1437     while (true) { //removing nested TRUSTTEXT
1438         $orig = $text;
1439         $text = str_replace('#####TRUSTTEXT#####', '', $text);
1440         if (strcmp($orig, $text) === 0) {
1441             return $text;
1442         }
1443     }
1446 /**
1447  * Must be called before editing of all texts
1448  * with trust flag. Removes all XSS nasties
1449  * from texts stored in database if needed.
1450  *
1451  * @param object $object data object with xxx, xxxformat and xxxtrust fields
1452  * @param string $field name of text field
1453  * @param object $context active context
1454  * @return object updated $object
1455  */
1456 function trusttext_pre_edit($object, $field, $context) {
1457     $trustfield  = $field.'trust';
1458     $formatfield = $field.'format';
1460     if (!$object->$trustfield or !trusttext_trusted($context)) {
1461         $object->$field = clean_text($object->$field, $object->$formatfield);
1462     }
1464     return $object;
1467 /**
1468  * Is current user trusted to enter no dangerous XSS in this context?
1469  *
1470  * Please note the user must be in fact trusted everywhere on this server!!
1471  *
1472  * @param object $context
1473  * @return bool true if user trusted
1474  */
1475 function trusttext_trusted($context) {
1476     return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1479 /**
1480  * Is trusttext feature active?
1481  *
1482  * @return bool
1483  */
1484 function trusttext_active() {
1485     global $CFG;
1487     return !empty($CFG->enabletrusttext);
1490 /**
1491  * Given raw text (eg typed in by a user), this function cleans it up
1492  * and removes any nasty tags that could mess up Moodle pages through XSS attacks.
1493  *
1494  * The result must be used as a HTML text fragment, this function can not cleanup random
1495  * parts of html tags such as url or src attributes.
1496  *
1497  * NOTE: the format parameter was deprecated because we can safely clean only HTML.
1498  *
1499  * @param string $text The text to be cleaned
1500  * @param int|string $format deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
1501  * @param array $options Array of options; currently only option supported is 'allowid' (if true,
1502  *   does not remove id attributes when cleaning)
1503  * @return string The cleaned up text
1504  */
1505 function clean_text($text, $format = FORMAT_HTML, $options = array()) {
1506     $text = (string)$text;
1508     if ($format != FORMAT_HTML and $format != FORMAT_HTML) {
1509         // TODO: we need to standardise cleanup of text when loading it into editor first
1510         //debugging('clean_text() is designed to work only with html');
1511     }
1513     if ($format == FORMAT_PLAIN) {
1514         return $text;
1515     }
1517     if (is_purify_html_necessary($text)) {
1518         $text = purify_html($text, $options);
1519     }
1521     // Originally we tried to neutralise some script events here, it was a wrong approach because
1522     // it was trivial to work around that (for example using style based XSS exploits).
1523     // We must not give false sense of security here - all developers MUST understand how to use
1524     // rawurlencode(), htmlentities(), htmlspecialchars(), p(), s(), moodle_url, html_writer and friends!!!
1526     return $text;
1529 /**
1530  * Is it necessary to use HTMLPurifier?
1531  * @private
1532  * @param string $text
1533  * @return bool false means html is safe and valid, true means use HTMLPurifier
1534  */
1535 function is_purify_html_necessary($text) {
1536     if ($text === '') {
1537         return false;
1538     }
1540     if ($text === (string)((int)$text)) {
1541         return false;
1542     }
1544     if (strpos($text, '&') !== false or preg_match('|<[^pesb/]|', $text)) {
1545         // we need to normalise entities or other tags except p, em, strong and br present
1546         return true;
1547     }
1549     $altered = htmlspecialchars($text, ENT_NOQUOTES, 'UTF-8', true);
1550     if ($altered === $text) {
1551         // no < > or other special chars means this must be safe
1552         return false;
1553     }
1555     // let's try to convert back some safe html tags
1556     $altered = preg_replace('|&lt;p&gt;(.*?)&lt;/p&gt;|m', '<p>$1</p>', $altered);
1557     if ($altered === $text) {
1558         return false;
1559     }
1560     $altered = preg_replace('|&lt;em&gt;([^<>]+?)&lt;/em&gt;|m', '<em>$1</em>', $altered);
1561     if ($altered === $text) {
1562         return false;
1563     }
1564     $altered = preg_replace('|&lt;strong&gt;([^<>]+?)&lt;/strong&gt;|m', '<strong>$1</strong>', $altered);
1565     if ($altered === $text) {
1566         return false;
1567     }
1568     $altered = str_replace('&lt;br /&gt;', '<br />', $altered);
1569     if ($altered === $text) {
1570         return false;
1571     }
1573     return true;
1576 /**
1577  * KSES replacement cleaning function - uses HTML Purifier.
1578  *
1579  * @param string $text The (X)HTML string to purify
1580  * @param array $options Array of options; currently only option supported is 'allowid' (if set,
1581  *   does not remove id attributes when cleaning)
1582  * @return string
1583  */
1584 function purify_html($text, $options = array()) {
1585     global $CFG;
1587     static $purifiers = array();
1588     static $caches = array();
1590     $type = !empty($options['allowid']) ? 'allowid' : 'normal';
1592     if (!array_key_exists($type, $caches)) {
1593         $caches[$type] = cache::make('core', 'htmlpurifier', array('type' => $type));
1594     }
1595     $cache = $caches[$type];
1597     $filteredtext = $cache->get($text);
1598     if ($filteredtext !== false) {
1599         return $filteredtext;
1600     }
1602     if (empty($purifiers[$type])) {
1604         // make sure the serializer dir exists, it should be fine if it disappears later during cache reset
1605         $cachedir = $CFG->cachedir.'/htmlpurifier';
1606         check_dir_exists($cachedir);
1608         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1609         require_once $CFG->libdir.'/htmlpurifier/locallib.php';
1610         $config = HTMLPurifier_Config::createDefault();
1612         $config->set('HTML.DefinitionID', 'moodlehtml');
1613         $config->set('HTML.DefinitionRev', 2);
1614         $config->set('Cache.SerializerPath', $cachedir);
1615         $config->set('Cache.SerializerPermissions', $CFG->directorypermissions);
1616         $config->set('Core.NormalizeNewlines', false);
1617         $config->set('Core.ConvertDocumentToFragment', true);
1618         $config->set('Core.Encoding', 'UTF-8');
1619         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1620         $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, 'mailto'=>true));
1621         $config->set('Attr.AllowedFrameTargets', array('_blank'));
1623         if (!empty($CFG->allowobjectembed)) {
1624             $config->set('HTML.SafeObject', true);
1625             $config->set('Output.FlashCompat', true);
1626             $config->set('HTML.SafeEmbed', true);
1627         }
1629         if ($type === 'allowid') {
1630             $config->set('Attr.EnableID', true);
1631         }
1633         if ($def = $config->maybeGetRawHTMLDefinition()) {
1634             $def->addElement('nolink', 'Block', 'Flow', array());                       // skip our filters inside
1635             $def->addElement('tex', 'Inline', 'Inline', array());                       // tex syntax, equivalent to $$xx$$
1636             $def->addElement('algebra', 'Inline', 'Inline', array());                   // algebra syntax, equivalent to @@xx@@
1637             $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // old and future style multilang - only our hacked lang attribute
1638             $def->addAttribute('span', 'xxxlang', 'CDATA');                             // current problematic multilang
1639         }
1641         $purifier = new HTMLPurifier($config);
1642         $purifiers[$type] = $purifier;
1643     } else {
1644         $purifier = $purifiers[$type];
1645     }
1647     $multilang = (strpos($text, 'class="multilang"') !== false);
1649     $filteredtext = $text;
1650     if ($multilang) {
1651         $filteredtext = preg_replace('/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/', '<span xxxlang="${2}">', $filteredtext);
1652     }
1653     $filteredtext = $purifier->purify($filteredtext);
1654     if ($multilang) {
1655         $filteredtext = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $filteredtext);
1656     }
1657     $cache->set($text, $filteredtext);
1659     return $filteredtext;
1662 /**
1663  * Given plain text, makes it into HTML as nicely as possible.
1664  * May contain HTML tags already
1665  *
1666  * Do not abuse this function. It is intended as lower level formatting feature used
1667  * by {@see format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
1668  * to call format_text() in most of cases.
1669  *
1670  * @param string $text The string to convert.
1671  * @param boolean $smiley_ignored Was used to determine if smiley characters should convert to smiley images, ignored now
1672  * @param boolean $para If true then the returned string will be wrapped in div tags
1673  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1674  * @return string
1675  */
1676 function text_to_html($text, $smiley_ignored=null, $para=true, $newlines=true) {
1677 /// Remove any whitespace that may be between HTML tags
1678     $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1680 /// Remove any returns that precede or follow HTML tags
1681     $text = preg_replace("~([\n\r])<~i", " <", $text);
1682     $text = preg_replace("~>([\n\r])~i", "> ", $text);
1684 /// Make returns into HTML newlines.
1685     if ($newlines) {
1686         $text = nl2br($text);
1687     }
1689 /// Wrap the whole thing in a div if required
1690     if ($para) {
1691         //return '<p>'.$text.'</p>'; //1.9 version
1692         return '<div class="text_to_html">'.$text.'</div>';
1693     } else {
1694         return $text;
1695     }
1698 /**
1699  * Given Markdown formatted text, make it into XHTML using external function
1700  *
1701  * @global object
1702  * @param string $text The markdown formatted text to be converted.
1703  * @return string Converted text
1704  */
1705 function markdown_to_html($text) {
1706     global $CFG;
1708     if ($text === '' or $text === NULL) {
1709         return $text;
1710     }
1712     require_once($CFG->libdir .'/markdown.php');
1714     return Markdown($text);
1717 /**
1718  * Given HTML text, make it into plain text using external function
1719  *
1720  * @param string $html The text to be converted.
1721  * @param integer $width Width to wrap the text at. (optional, default 75 which
1722  *      is a good value for email. 0 means do not limit line length.)
1723  * @param boolean $dolinks By default, any links in the HTML are collected, and
1724  *      printed as a list at the end of the HTML. If you don't want that, set this
1725  *      argument to false.
1726  * @return string plain text equivalent of the HTML.
1727  */
1728 function html_to_text($html, $width = 75, $dolinks = true) {
1730     global $CFG;
1732     require_once($CFG->libdir .'/html2text.php');
1734     $h2t = new html2text($html, false, $dolinks, $width);
1735     $result = $h2t->get_text();
1737     return $result;
1740 /**
1741  * This function will highlight search words in a given string
1742  *
1743  * It cares about HTML and will not ruin links.  It's best to use
1744  * this function after performing any conversions to HTML.
1745  *
1746  * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1747  * @param string $haystack The string (HTML) within which to highlight the search terms.
1748  * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1749  * @param string $prefix the string to put before each search term found.
1750  * @param string $suffix the string to put after each search term found.
1751  * @return string The highlighted HTML.
1752  */
1753 function highlight($needle, $haystack, $matchcase = false,
1754         $prefix = '<span class="highlight">', $suffix = '</span>') {
1756 /// Quick bail-out in trivial cases.
1757     if (empty($needle) or empty($haystack)) {
1758         return $haystack;
1759     }
1761 /// Break up the search term into words, discard any -words and build a regexp.
1762     $words = preg_split('/ +/', trim($needle));
1763     foreach ($words as $index => $word) {
1764         if (strpos($word, '-') === 0) {
1765             unset($words[$index]);
1766         } else if (strpos($word, '+') === 0) {
1767             $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
1768         } else {
1769             $words[$index] = preg_quote($word, '/');
1770         }
1771     }
1772     $regexp = '/(' . implode('|', $words) . ')/u'; // u is do UTF-8 matching.
1773     if (!$matchcase) {
1774         $regexp .= 'i';
1775     }
1777 /// Another chance to bail-out if $search was only -words
1778     if (empty($words)) {
1779         return $haystack;
1780     }
1782 /// Find all the HTML tags in the input, and store them in a placeholders array.
1783     $placeholders = array();
1784     $matches = array();
1785     preg_match_all('/<[^>]*>/', $haystack, $matches);
1786     foreach (array_unique($matches[0]) as $key => $htmltag) {
1787         $placeholders['<|' . $key . '|>'] = $htmltag;
1788     }
1790 /// In $hastack, replace each HTML tag with the corresponding placeholder.
1791     $haystack = str_replace($placeholders, array_keys($placeholders), $haystack);
1793 /// In the resulting string, Do the highlighting.
1794     $haystack = preg_replace($regexp, $prefix . '$1' . $suffix, $haystack);
1796 /// Turn the placeholders back into HTML tags.
1797     $haystack = str_replace(array_keys($placeholders), $placeholders, $haystack);
1799     return $haystack;
1802 /**
1803  * This function will highlight instances of $needle in $haystack
1804  *
1805  * It's faster that the above function {@link highlight()} and doesn't care about
1806  * HTML or anything.
1807  *
1808  * @param string $needle The string to search for
1809  * @param string $haystack The string to search for $needle in
1810  * @return string The highlighted HTML
1811  */
1812 function highlightfast($needle, $haystack) {
1814     if (empty($needle) or empty($haystack)) {
1815         return $haystack;
1816     }
1818     $parts = explode(textlib::strtolower($needle), textlib::strtolower($haystack));
1820     if (count($parts) === 1) {
1821         return $haystack;
1822     }
1824     $pos = 0;
1826     foreach ($parts as $key => $part) {
1827         $parts[$key] = substr($haystack, $pos, strlen($part));
1828         $pos += strlen($part);
1830         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
1831         $pos += strlen($needle);
1832     }
1834     return str_replace('<span class="highlight"></span>', '', join('', $parts));
1837 /**
1838  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
1839  * Internationalisation, for print_header and backup/restorelib.
1840  *
1841  * @param bool $dir Default false
1842  * @return string Attributes
1843  */
1844 function get_html_lang($dir = false) {
1845     $direction = '';
1846     if ($dir) {
1847         if (right_to_left()) {
1848             $direction = ' dir="rtl"';
1849         } else {
1850             $direction = ' dir="ltr"';
1851         }
1852     }
1853     //Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
1854     $language = str_replace('_', '-', current_language());
1855     @header('Content-Language: '.$language);
1856     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
1860 /// STANDARD WEB PAGE PARTS ///////////////////////////////////////////////////
1862 /**
1863  * Send the HTTP headers that Moodle requires.
1864  *
1865  * There is a backwards compatibility hack for legacy code
1866  * that needs to add custom IE compatibility directive.
1867  *
1868  * Example:
1869  * <code>
1870  * if (!isset($CFG->additionalhtmlhead)) {
1871  *     $CFG->additionalhtmlhead = '';
1872  * }
1873  * $CFG->additionalhtmlhead .= '<meta http-equiv="X-UA-Compatible" content="IE=8" />';
1874  * header('X-UA-Compatible: IE=8');
1875  * echo $OUTPUT->header();
1876  * </code>
1877  *
1878  * Please note the $CFG->additionalhtmlhead alone might not work,
1879  * you should send the IE compatibility header() too.
1880  *
1881  * @param string $contenttype
1882  * @param bool $cacheable Can this page be cached on back?
1883  * @return void, sends HTTP headers
1884  */
1885 function send_headers($contenttype, $cacheable = true) {
1886     global $CFG;
1888     @header('Content-Type: ' . $contenttype);
1889     @header('Content-Script-Type: text/javascript');
1890     @header('Content-Style-Type: text/css');
1892     if (empty($CFG->additionalhtmlhead) or stripos($CFG->additionalhtmlhead, 'X-UA-Compatible') === false) {
1893         @header('X-UA-Compatible: IE=edge');
1894     }
1896     if ($cacheable) {
1897         // Allow caching on "back" (but not on normal clicks)
1898         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0');
1899         @header('Pragma: no-cache');
1900         @header('Expires: ');
1901     } else {
1902         // Do everything we can to always prevent clients and proxies caching
1903         @header('Cache-Control: no-store, no-cache, must-revalidate');
1904         @header('Cache-Control: post-check=0, pre-check=0', false);
1905         @header('Pragma: no-cache');
1906         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1907         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1908     }
1909     @header('Accept-Ranges: none');
1911     if (empty($CFG->allowframembedding)) {
1912         @header('X-Frame-Options: sameorigin');
1913     }
1916 /**
1917  * Return the right arrow with text ('next'), and optionally embedded in a link.
1918  *
1919  * @global object
1920  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1921  * @param string $url An optional link to use in a surrounding HTML anchor.
1922  * @param bool $accesshide True if text should be hidden (for screen readers only).
1923  * @param string $addclass Additional class names for the link, or the arrow character.
1924  * @return string HTML string.
1925  */
1926 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
1927     global $OUTPUT; //TODO: move to output renderer
1928     $arrowclass = 'arrow ';
1929     if (! $url) {
1930         $arrowclass .= $addclass;
1931     }
1932     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
1933     $htmltext = '';
1934     if ($text) {
1935         $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
1936         if ($accesshide) {
1937             $htmltext = get_accesshide($htmltext);
1938         }
1939     }
1940     if ($url) {
1941         $class = 'arrow_link';
1942         if ($addclass) {
1943             $class .= ' '.$addclass;
1944         }
1945         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$htmltext.$arrow.'</a>';
1946     }
1947     return $htmltext.$arrow;
1950 /**
1951  * Return the left arrow with text ('previous'), and optionally embedded in a link.
1952  *
1953  * @global object
1954  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1955  * @param string $url An optional link to use in a surrounding HTML anchor.
1956  * @param bool $accesshide True if text should be hidden (for screen readers only).
1957  * @param string $addclass Additional class names for the link, or the arrow character.
1958  * @return string HTML string.
1959  */
1960 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
1961     global $OUTPUT; // TODO: move to utput renderer
1962     $arrowclass = 'arrow ';
1963     if (! $url) {
1964         $arrowclass .= $addclass;
1965     }
1966     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
1967     $htmltext = '';
1968     if ($text) {
1969         $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
1970         if ($accesshide) {
1971             $htmltext = get_accesshide($htmltext);
1972         }
1973     }
1974     if ($url) {
1975         $class = 'arrow_link';
1976         if ($addclass) {
1977             $class .= ' '.$addclass;
1978         }
1979         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$arrow.$htmltext.'</a>';
1980     }
1981     return $arrow.$htmltext;
1984 /**
1985  * Return a HTML element with the class "accesshide", for accessibility.
1986  * Please use cautiously - where possible, text should be visible!
1987  *
1988  * @param string $text Plain text.
1989  * @param string $elem Lowercase element name, default "span".
1990  * @param string $class Additional classes for the element.
1991  * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
1992  * @return string HTML string.
1993  */
1994 function get_accesshide($text, $elem='span', $class='', $attrs='') {
1995     return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
1998 /**
1999  * Return the breadcrumb trail navigation separator.
2000  *
2001  * @return string HTML string.
2002  */
2003 function get_separator() {
2004     //Accessibility: the 'hidden' slash is preferred for screen readers.
2005     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
2008 /**
2009  * Print (or return) a collapsible region, that has a caption that can
2010  * be clicked to expand or collapse the region.
2011  *
2012  * If JavaScript is off, then the region will always be expanded.
2013  *
2014  * @param string $contents the contents of the box.
2015  * @param string $classes class names added to the div that is output.
2016  * @param string $id id added to the div that is output. Must not be blank.
2017  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2018  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2019  *      (May be blank if you do not wish the state to be persisted.
2020  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2021  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2022  * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
2023  */
2024 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2025     $output  = print_collapsible_region_start($classes, $id, $caption, $userpref, $default, true);
2026     $output .= $contents;
2027     $output .= print_collapsible_region_end(true);
2029     if ($return) {
2030         return $output;
2031     } else {
2032         echo $output;
2033     }
2036 /**
2037  * Print (or return) the start of a collapsible region, that has a caption that can
2038  * be clicked to expand or collapse the region. If JavaScript is off, then the region
2039  * will always be expanded.
2040  *
2041  * @param string $classes class names added to the div that is output.
2042  * @param string $id id added to the div that is output. Must not be blank.
2043  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2044  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2045  *      (May be blank if you do not wish the state to be persisted.
2046  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2047  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2048  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2049  */
2050 function print_collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2051     global $CFG, $PAGE, $OUTPUT;
2053     // Work out the initial state.
2054     if (!empty($userpref) and is_string($userpref)) {
2055         user_preference_allow_ajax_update($userpref, PARAM_BOOL);
2056         $collapsed = get_user_preferences($userpref, $default);
2057     } else {
2058         $collapsed = $default;
2059         $userpref = false;
2060     }
2062     if ($collapsed) {
2063         $classes .= ' collapsed';
2064     }
2066     $output = '';
2067     $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2068     $output .= '<div id="' . $id . '_sizer">';
2069     $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2070     $output .= $caption . ' ';
2071     $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2072     $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2074     if ($return) {
2075         return $output;
2076     } else {
2077         echo $output;
2078     }
2081 /**
2082  * Close a region started with print_collapsible_region_start.
2083  *
2084  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2085  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2086  */
2087 function print_collapsible_region_end($return = false) {
2088     $output = '</div></div></div>';
2090     if ($return) {
2091         return $output;
2092     } else {
2093         echo $output;
2094     }
2097 /**
2098  * Print a specified group's avatar.
2099  *
2100  * @global object
2101  * @uses CONTEXT_COURSE
2102  * @param array|stdClass $group A single {@link group} object OR array of groups.
2103  * @param int $courseid The course ID.
2104  * @param boolean $large Default small picture, or large.
2105  * @param boolean $return If false print picture, otherwise return the output as string
2106  * @param boolean $link Enclose image in a link to view specified course?
2107  * @return string|void Depending on the setting of $return
2108  */
2109 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2110     global $CFG;
2112     if (is_array($group)) {
2113         $output = '';
2114         foreach($group as $g) {
2115             $output .= print_group_picture($g, $courseid, $large, true, $link);
2116         }
2117         if ($return) {
2118             return $output;
2119         } else {
2120             echo $output;
2121             return;
2122         }
2123     }
2125     $context = context_course::instance($courseid);
2127     // If there is no picture, do nothing
2128     if (!$group->picture) {
2129         return '';
2130     }
2132     // If picture is hidden, only show to those with course:managegroups
2133     if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
2134         return '';
2135     }
2137     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2138         $output = '<a href="'. $CFG->wwwroot .'/user/index.php?id='. $courseid .'&amp;group='. $group->id .'">';
2139     } else {
2140         $output = '';
2141     }
2142     if ($large) {
2143         $file = 'f1';
2144     } else {
2145         $file = 'f2';
2146     }
2148     $grouppictureurl = moodle_url::make_pluginfile_url($context->id, 'group', 'icon', $group->id, '/', $file);
2149     $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2150         ' alt="'.s(get_string('group').' '.$group->name).'" title="'.s($group->name).'"/>';
2152     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2153         $output .= '</a>';
2154     }
2156     if ($return) {
2157         return $output;
2158     } else {
2159         echo $output;
2160     }
2164 /**
2165  * Display a recent activity note
2166  *
2167  * @uses CONTEXT_SYSTEM
2168  * @staticvar string $strftimerecent
2169  * @param object A time object
2170  * @param object A user object
2171  * @param string $text Text for display for the note
2172  * @param string $link The link to wrap around the text
2173  * @param bool $return If set to true the HTML is returned rather than echo'd
2174  * @param string $viewfullnames
2175  */
2176 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2177     static $strftimerecent = null;
2178     $output = '';
2180     if (is_null($viewfullnames)) {
2181         $context = context_system::instance();
2182         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2183     }
2185     if (is_null($strftimerecent)) {
2186         $strftimerecent = get_string('strftimerecent');
2187     }
2189     $output .= '<div class="head">';
2190     $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2191     $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2192     $output .= '</div>';
2193     $output .= '<div class="info"><a href="'.$link.'">'.format_string($text,true).'</a></div>';
2195     if ($return) {
2196         return $output;
2197     } else {
2198         echo $output;
2199     }
2202 /**
2203  * Returns a popup menu with course activity modules
2204  *
2205  * Given a course
2206  * This function returns a small popup menu with all the
2207  * course activity modules in it, as a navigation menu
2208  * outputs a simple list structure in XHTML
2209  * The data is taken from the serialised array stored in
2210  * the course record
2211  *
2212  * @todo Finish documenting this function
2213  *
2214  * @global object
2215  * @uses CONTEXT_COURSE
2216  * @param course $course A {@link $COURSE} object.
2217  * @param string $sections
2218  * @param string $modinfo
2219  * @param string $strsection
2220  * @param string $strjumpto
2221  * @param int $width
2222  * @param string $cmid
2223  * @return string The HTML block
2224  */
2225 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2227     global $CFG, $OUTPUT;
2229     $section = -1;
2230     $url = '';
2231     $menu = array();
2232     $doneheading = false;
2234     $courseformatoptions = course_get_format($course)->get_format_options();
2235     $coursecontext = context_course::instance($course->id);
2237     $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2238     foreach ($modinfo->cms as $mod) {
2239         if (!$mod->has_view()) {
2240             // Don't show modules which you can't link to!
2241             continue;
2242         }
2244         // For course formats using 'numsections' do not show extra sections
2245         if (isset($courseformatoptions['numsections']) && $mod->sectionnum > $courseformatoptions['numsections']) {
2246             break;
2247         }
2249         if (!$mod->uservisible) { // do not icnlude empty sections at all
2250             continue;
2251         }
2253         if ($mod->sectionnum >= 0 and $section != $mod->sectionnum) {
2254             $thissection = $sections[$mod->sectionnum];
2256             if ($thissection->visible or
2257                     (isset($courseformatoptions['hiddensections']) and !$courseformatoptions['hiddensections']) or
2258                     has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2259                 $thissection->summary = strip_tags(format_string($thissection->summary,true));
2260                 if (!$doneheading) {
2261                     $menu[] = '</ul></li>';
2262                 }
2263                 if ($course->format == 'weeks' or empty($thissection->summary)) {
2264                     $item = $strsection ." ". $mod->sectionnum;
2265                 } else {
2266                     if (textlib::strlen($thissection->summary) < ($width-3)) {
2267                         $item = $thissection->summary;
2268                     } else {
2269                         $item = textlib::substr($thissection->summary, 0, $width).'...';
2270                     }
2271                 }
2272                 $menu[] = '<li class="section"><span>'.$item.'</span>';
2273                 $menu[] = '<ul>';
2274                 $doneheading = true;
2276                 $section = $mod->sectionnum;
2277             } else {
2278                 // no activities from this hidden section shown
2279                 continue;
2280             }
2281         }
2283         $url = $mod->modname .'/view.php?id='. $mod->id;
2284         $mod->name = strip_tags(format_string($mod->name ,true));
2285         if (textlib::strlen($mod->name) > ($width+5)) {
2286             $mod->name = textlib::substr($mod->name, 0, $width).'...';
2287         }
2288         if (!$mod->visible) {
2289             $mod->name = '('.$mod->name.')';
2290         }
2291         $class = 'activity '.$mod->modname;
2292         $class .= ($cmid == $mod->id) ? ' selected' : '';
2293         $menu[] = '<li class="'.$class.'">'.
2294                   '<img src="'.$OUTPUT->pix_url('icon', $mod->modname) . '" alt="" />'.
2295                   '<a href="'.$CFG->wwwroot.'/mod/'.$url.'">'.$mod->name.'</a></li>';
2296     }
2298     if ($doneheading) {
2299         $menu[] = '</ul></li>';
2300     }
2301     $menu[] = '</ul></li></ul>';
2303     return implode("\n", $menu);
2306 /**
2307  * Prints a grade menu (as part of an existing form) with help
2308  * Showing all possible numerical grades and scales
2309  *
2310  * @todo Finish documenting this function
2311  * @todo Deprecate: this is only used in a few contrib modules
2312  *
2313  * @global object
2314  * @param int $courseid The course ID
2315  * @param string $name
2316  * @param string $current
2317  * @param boolean $includenograde Include those with no grades
2318  * @param boolean $return If set to true returns rather than echo's
2319  * @return string|bool Depending on value of $return
2320  */
2321 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2323     global $CFG, $OUTPUT;
2325     $output = '';
2326     $strscale = get_string('scale');
2327     $strscales = get_string('scales');
2329     $scales = get_scales_menu($courseid);
2330     foreach ($scales as $i => $scalename) {
2331         $grades[-$i] = $strscale .': '. $scalename;
2332     }
2333     if ($includenograde) {
2334         $grades[0] = get_string('nograde');
2335     }
2336     for ($i=100; $i>=1; $i--) {
2337         $grades[$i] = $i;
2338     }
2339     $output .= html_writer::select($grades, $name, $current, false);
2341     $linkobject = '<span class="helplink"><img class="iconhelp" alt="'.$strscales.'" src="'.$OUTPUT->pix_url('help') . '" /></span>';
2342     $link = new moodle_url('/course/scales.php', array('id'=>$courseid, 'list'=>1));
2343     $action = new popup_action('click', $link, 'ratingscales', array('height' => 400, 'width' => 500));
2344     $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title'=>$strscales));
2346     if ($return) {
2347         return $output;
2348     } else {
2349         echo $output;
2350     }
2353 /**
2354  * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2355  * Default errorcode is 1.
2356  *
2357  * Very useful for perl-like error-handling:
2358  *
2359  * do_somethting() or mdie("Something went wrong");
2360  *
2361  * @param string  $msg       Error message
2362  * @param integer $errorcode Error code to emit
2363  */
2364 function mdie($msg='', $errorcode=1) {
2365     trigger_error($msg);
2366     exit($errorcode);
2369 /**
2370  * Print a message and exit.
2371  *
2372  * @param string $message The message to print in the notice
2373  * @param string $link The link to use for the continue button
2374  * @param object $course A course object
2375  * @return void This function simply exits
2376  */
2377 function notice ($message, $link='', $course=NULL) {
2378     global $CFG, $SITE, $COURSE, $PAGE, $OUTPUT;
2380     $message = clean_text($message);   // In case nasties are in here
2382     if (CLI_SCRIPT) {
2383         echo("!!$message!!\n");
2384         exit(1); // no success
2385     }
2387     if (!$PAGE->headerprinted) {
2388         //header not yet printed
2389         $PAGE->set_title(get_string('notice'));
2390         echo $OUTPUT->header();
2391     } else {
2392         echo $OUTPUT->container_end_all(false);
2393     }
2395     echo $OUTPUT->box($message, 'generalbox', 'notice');
2396     echo $OUTPUT->continue_button($link);
2398     echo $OUTPUT->footer();
2399     exit(1); // general error code
2402 /**
2403  * Redirects the user to another page, after printing a notice
2404  *
2405  * This function calls the OUTPUT redirect method, echo's the output
2406  * and then dies to ensure nothing else happens.
2407  *
2408  * <strong>Good practice:</strong> You should call this method before starting page
2409  * output by using any of the OUTPUT methods.
2410  *
2411  * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2412  * @param string $message The message to display to the user
2413  * @param int $delay The delay before redirecting
2414  * @return void - does not return!
2415  */
2416 function redirect($url, $message='', $delay=-1) {
2417     global $OUTPUT, $PAGE, $SESSION, $CFG;
2419     if (CLI_SCRIPT or AJAX_SCRIPT) {
2420         // this is wrong - developers should not use redirect in these scripts,
2421         // but it should not be very likely
2422         throw new moodle_exception('redirecterrordetected', 'error');
2423     }
2425     // prevent debug errors - make sure context is properly initialised
2426     if ($PAGE) {
2427         $PAGE->set_context(null);
2428         $PAGE->set_pagelayout('redirect');  // No header and footer needed
2429     }
2431     if ($url instanceof moodle_url) {
2432         $url = $url->out(false);
2433     }
2435     $debugdisableredirect = false;
2436     do {
2437         if (defined('DEBUGGING_PRINTED')) {
2438             // some debugging already printed, no need to look more
2439             $debugdisableredirect = true;
2440             break;
2441         }
2443         if (empty($CFG->debugdisplay) or empty($CFG->debug)) {
2444             // no errors should be displayed
2445             break;
2446         }
2448         if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2449             break;
2450         }
2452         if (!($lasterror['type'] & $CFG->debug)) {
2453             //last error not interesting
2454             break;
2455         }
2457         // watch out here, @hidden() errors are returned from error_get_last() too
2458         if (headers_sent()) {
2459             //we already started printing something - that means errors likely printed
2460             $debugdisableredirect = true;
2461             break;
2462         }
2464         if (ob_get_level() and ob_get_contents()) {
2465             // there is something waiting to be printed, hopefully it is the errors,
2466             // but it might be some error hidden by @ too - such as the timezone mess from setup.php
2467             $debugdisableredirect = true;
2468             break;
2469         }
2470     } while (false);
2472     // Technically, HTTP/1.1 requires Location: header to contain the absolute path.
2473     // (In practice browsers accept relative paths - but still, might as well do it properly.)
2474     // This code turns relative into absolute.
2475     if (!preg_match('|^[a-z]+:|', $url)) {
2476         // Get host name http://www.wherever.com
2477         $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2478         if (preg_match('|^/|', $url)) {
2479             // URLs beginning with / are relative to web server root so we just add them in
2480             $url = $hostpart.$url;
2481         } else {
2482             // URLs not beginning with / are relative to path of current script, so add that on.
2483             $url = $hostpart.preg_replace('|\?.*$|','',me()).'/../'.$url;
2484         }
2485         // Replace all ..s
2486         while (true) {
2487             $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2488             if ($newurl == $url) {
2489                 break;
2490             }
2491             $url = $newurl;
2492         }
2493     }
2495     // Sanitise url - we can not rely on moodle_url or our URL cleaning
2496     // because they do not support all valid external URLs
2497     $url = preg_replace('/[\x00-\x1F\x7F]/', '', $url);
2498     $url = str_replace('"', '%22', $url);
2499     $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2500     $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />', FORMAT_HTML));
2501     $url = str_replace('&amp;', '&', $encodedurl);
2503     if (!empty($message)) {
2504         if ($delay === -1 || !is_numeric($delay)) {
2505             $delay = 3;
2506         }
2507         $message = clean_text($message);
2508     } else {
2509         $message = get_string('pageshouldredirect');
2510         $delay = 0;
2511     }
2513     if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
2514         if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
2515             $perf = get_performance_info();
2516             error_log("PERF: " . $perf['txt']);
2517         }
2518     }
2520     if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2521         // workaround for IIS bug http://support.microsoft.com/kb/q176113/
2522         if (session_id()) {
2523             session_get_instance()->write_close();
2524         }
2526         //302 might not work for POST requests, 303 is ignored by obsolete clients.
2527         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2528         @header('Location: '.$url);
2529         echo bootstrap_renderer::plain_redirect_message($encodedurl);
2530         exit;
2531     }
2533     // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2534     if ($PAGE) {
2535         $CFG->docroot = false; // to prevent the link to moodle docs from being displayed on redirect page.
2536         echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect);
2537         exit;
2538     } else {
2539         echo bootstrap_renderer::early_redirect_message($encodedurl, $message, $delay);
2540         exit;
2541     }
2544 /**
2545  * Given an email address, this function will return an obfuscated version of it
2546  *
2547  * @param string $email The email address to obfuscate
2548  * @return string The obfuscated email address
2549  */
2550  function obfuscate_email($email) {
2552     $i = 0;
2553     $length = strlen($email);
2554     $obfuscated = '';
2555     while ($i < $length) {
2556         if (rand(0,2) && $email{$i}!='@') { //MDL-20619 some browsers have problems unobfuscating @
2557             $obfuscated.='%'.dechex(ord($email{$i}));
2558         } else {
2559             $obfuscated.=$email{$i};
2560         }
2561         $i++;
2562     }
2563     return $obfuscated;
2566 /**
2567  * This function takes some text and replaces about half of the characters
2568  * with HTML entity equivalents.   Return string is obviously longer.
2569  *
2570  * @param string $plaintext The text to be obfuscated
2571  * @return string The obfuscated text
2572  */
2573 function obfuscate_text($plaintext) {
2575     $i=0;
2576     $length = strlen($plaintext);
2577     $obfuscated='';
2578     $prev_obfuscated = false;
2579     while ($i < $length) {
2580         $c = ord($plaintext{$i});
2581         $numerical = ($c >= ord('0')) && ($c <= ord('9'));
2582         if ($prev_obfuscated and $numerical ) {
2583             $obfuscated.='&#'.ord($plaintext{$i}).';';
2584         } else if (rand(0,2)) {
2585             $obfuscated.='&#'.ord($plaintext{$i}).';';
2586             $prev_obfuscated = true;
2587         } else {
2588             $obfuscated.=$plaintext{$i};
2589             $prev_obfuscated = false;
2590         }
2591       $i++;
2592     }
2593     return $obfuscated;
2596 /**
2597  * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2598  * to generate a fully obfuscated email link, ready to use.
2599  *
2600  * @param string $email The email address to display
2601  * @param string $label The text to displayed as hyperlink to $email
2602  * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2603  * @param string $subject The subject of the email in the mailto link
2604  * @param string $body The content of the email in the mailto link
2605  * @return string The obfuscated mailto link
2606  */
2607 function obfuscate_mailto($email, $label='', $dimmed=false, $subject = '', $body = '') {
2609     if (empty($label)) {
2610         $label = $email;
2611     }
2613     $label = obfuscate_text($label);
2614     $email = obfuscate_email($email);
2615     $mailto = obfuscate_text('mailto');
2616     $url = new moodle_url("mailto:$email");
2617     $attrs = array();
2619     if (!empty($subject)) {
2620         $url->param('subject', format_string($subject));
2621     }
2622     if (!empty($body)) {
2623         $url->param('body', format_string($body));
2624     }
2626     // Use the obfuscated mailto
2627     $url = preg_replace('/^mailto/', $mailto, $url->out());
2629     if ($dimmed) {
2630         $attrs['title'] = get_string('emaildisable');
2631         $attrs['class'] = 'dimmed';
2632     }
2634     return html_writer::link($url, $label, $attrs);
2637 /**
2638  * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2639  * will transform it to html entities
2640  *
2641  * @param string $text Text to search for nolink tag in
2642  * @return string
2643  */
2644 function rebuildnolinktag($text) {
2646     $text = preg_replace('/&lt;(\/*nolink)&gt;/i','<$1>',$text);
2648     return $text;
2651 /**
2652  * Prints a maintenance message from $CFG->maintenance_message or default if empty
2653  * @return void
2654  */
2655 function print_maintenance_message() {
2656     global $CFG, $SITE, $PAGE, $OUTPUT;
2658     $PAGE->set_pagetype('maintenance-message');
2659     $PAGE->set_pagelayout('maintenance');
2660     $PAGE->set_title(strip_tags($SITE->fullname));
2661     $PAGE->set_heading($SITE->fullname);
2662     echo $OUTPUT->header();
2663     echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2664     if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
2665         echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2666         echo $CFG->maintenance_message;
2667         echo $OUTPUT->box_end();
2668     }
2669     echo $OUTPUT->footer();
2670     die;
2673 /**
2674  * A class for tabs, Some code to print tabs
2675  *
2676  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2677  * @package moodlecore
2678  */
2679 class tabobject {
2680     /**
2681      * @var string
2682      */
2683     var $id;
2684     var $link;
2685     var $text;
2686     /**
2687      * @var bool
2688      */
2689     var $linkedwhenselected;
2691     /**
2692      * A constructor just because I like constructors
2693      *
2694      * @param string $id
2695      * @param string $link
2696      * @param string $text
2697      * @param string $title
2698      * @param bool $linkedwhenselected
2699      */
2700     function tabobject ($id, $link='', $text='', $title='', $linkedwhenselected=false) {
2701         $this->id   = $id;
2702         $this->link = $link;
2703         $this->text = $text;
2704         $this->title = $title ? $title : $text;
2705         $this->linkedwhenselected = $linkedwhenselected;
2706     }
2711 /**
2712  * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2713  *
2714  * @global object
2715  * @param array $tabrows An array of rows where each row is an array of tab objects
2716  * @param string $selected  The id of the selected tab (whatever row it's on)
2717  * @param array  $inactive  An array of ids of inactive tabs that are not selectable.
2718  * @param array  $activated An array of ids of other tabs that are currently activated
2719  * @param bool $return If true output is returned rather then echo'd
2720  **/
2721 function print_tabs($tabrows, $selected=NULL, $inactive=NULL, $activated=NULL, $return=false) {
2722     global $CFG;
2724 /// $inactive must be an array
2725     if (!is_array($inactive)) {
2726         $inactive = array();
2727     }
2729 /// $activated must be an array
2730     if (!is_array($activated)) {
2731         $activated = array();
2732     }
2734 /// Convert the tab rows into a tree that's easier to process
2735     if (!$tree = convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated)) {
2736         return false;
2737     }
2739 /// Print out the current tree of tabs (this function is recursive)
2741     $output = convert_tree_to_html($tree);
2743     $output = "\n\n".'<div class="tabtree">'.$output.'</div><div class="clearer"> </div>'."\n\n";
2745 /// We're done!
2747     if ($return) {
2748         return $output;
2749     }
2750     echo $output;
2753 /**
2754  * Converts a nested array tree into HTML ul:li [recursive]
2755  *
2756  * @param array $tree A tree array to convert
2757  * @param int $row Used in identifying the iteration level and in ul classes
2758  * @return string HTML structure
2759  */
2760 function convert_tree_to_html($tree, $row=0) {
2762     $str = "\n".'<ul class="tabrow'.$row.'">'."\n";
2764     $first = true;
2765     $count = count($tree);
2767     foreach ($tree as $tab) {
2768         $count--;   // countdown to zero
2770         $liclass = '';
2772         if ($first && ($count == 0)) {   // Just one in the row
2773             $liclass = 'first last';
2774             $first = false;
2775         } else if ($first) {
2776             $liclass = 'first';
2777             $first = false;
2778         } else if ($count == 0) {
2779             $liclass = 'last';
2780         }
2782         if ((empty($tab->subtree)) && (!empty($tab->selected))) {
2783             $liclass .= (empty($liclass)) ? 'onerow' : ' onerow';
2784         }
2786         if ($tab->inactive || $tab->active || $tab->selected) {
2787             if ($tab->selected) {
2788                 $liclass .= (empty($liclass)) ? 'here selected' : ' here selected';
2789             } else if ($tab->active) {
2790                 $liclass .= (empty($liclass)) ? 'here active' : ' here active';
2791             }
2792         }
2794         $str .= (!empty($liclass)) ? '<li class="'.$liclass.'">' : '<li>';
2796         if ($tab->inactive || $tab->active || ($tab->selected && !$tab->linkedwhenselected)) {
2797             // The a tag is used for styling
2798             $str .= '<a class="nolink"><span>'.$tab->text.'</span></a>';
2799         } else {
2800             $str .= '<a href="'.$tab->link.'" title="'.$tab->title.'"><span>'.$tab->text.'</span></a>';
2801         }
2803         if (!empty($tab->subtree)) {
2804             $str .= convert_tree_to_html($tab->subtree, $row+1);
2805         } else if ($tab->selected) {
2806             $str .= '<div class="tabrow'.($row+1).' empty">&nbsp;</div>'."\n";
2807         }
2809         $str .= ' </li>'."\n";
2810     }
2811     $str .= '</ul>'."\n";
2813     return $str;
2816 /**
2817  * Convert nested tabrows to a nested array
2818  *
2819  * @param array $tabrows A [nested] array of tab row objects
2820  * @param string $selected The tabrow to select (by id)
2821  * @param array $inactive An array of tabrow id's to make inactive
2822  * @param array $activated An array of tabrow id's to make active
2823  * @return array The nested array
2824  */
2825 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
2827 /// Work backwards through the rows (bottom to top) collecting the tree as we go.
2829     $tabrows = array_reverse($tabrows);
2831     $subtree = array();
2833     foreach ($tabrows as $row) {
2834         $tree = array();
2836         foreach ($row as $tab) {
2837             $tab->inactive = in_array((string)$tab->id, $inactive);
2838             $tab->active = in_array((string)$tab->id, $activated);
2839             $tab->selected = (string)$tab->id == $selected;
2841             if ($tab->active || $tab->selected) {
2842                 if ($subtree) {
2843                     $tab->subtree = $subtree;
2844                 }
2845             }
2846             $tree[] = $tab;
2847         }
2848         $subtree = $tree;
2849     }
2851     return $subtree;
2854 /**
2855  * Standard Debugging Function
2856  *
2857  * Returns true if the current site debugging settings are equal or above specified level.
2858  * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2859  * routing of notices is controlled by $CFG->debugdisplay
2860  * eg use like this:
2861  *
2862  * 1)  debugging('a normal debug notice');
2863  * 2)  debugging('something really picky', DEBUG_ALL);
2864  * 3)  debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
2865  * 4)  if (debugging()) { perform extra debugging operations (do not use print or echo) }
2866  *
2867  * In code blocks controlled by debugging() (such as example 4)
2868  * any output should be routed via debugging() itself, or the lower-level
2869  * trigger_error() or error_log(). Using echo or print will break XHTML
2870  * JS and HTTP headers.
2871  *
2872  * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2873  *
2874  * @uses DEBUG_NORMAL
2875  * @param string $message a message to print
2876  * @param int $level the level at which this debugging statement should show
2877  * @param array $backtrace use different backtrace
2878  * @return bool
2879  */
2880 function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
2881     global $CFG, $USER;
2883     $forcedebug = false;
2884     if (!empty($CFG->debugusers) && $USER) {
2885         $debugusers = explode(',', $CFG->debugusers);
2886         $forcedebug = in_array($USER->id, $debugusers);
2887     }
2889     if (!$forcedebug and (empty($CFG->debug) || ($CFG->debug != -1 and $CFG->debug < $level))) {
2890         return false;
2891     }
2893     if (!isset($CFG->debugdisplay)) {
2894         $CFG->debugdisplay = ini_get_bool('display_errors');
2895     }
2897     if ($message) {
2898         if (!$backtrace) {
2899             $backtrace = debug_backtrace();
2900         }
2901         $from = format_backtrace($backtrace, CLI_SCRIPT);
2902         if (PHPUNIT_TEST) {
2903             if (phpunit_util::debugging_triggered($message, $level, $from)) {
2904                 // We are inside test, the debug message was logged.
2905                 return true;
2906             }
2907         }
2909         if (NO_DEBUG_DISPLAY) {
2910             // script does not want any errors or debugging in output,
2911             // we send the info to error log instead
2912             error_log('Debugging: ' . $message . $from);
2914         } else if ($forcedebug or $CFG->debugdisplay) {
2915             if (!defined('DEBUGGING_PRINTED')) {
2916                 define('DEBUGGING_PRINTED', 1); // indicates we have printed something
2917             }
2918             if (CLI_SCRIPT) {
2919                 echo "++ $message ++\n$from";
2920             } else {
2921                 echo '<div class="notifytiny">' . $message . $from . '</div>';
2922             }
2924         } else {
2925             trigger_error($message . $from, E_USER_NOTICE);
2926         }
2927     }
2928     return true;
2931 /**
2932 * Outputs a HTML comment to the browser. This is used for those hard-to-debug
2933 * pages that use bits from many different files in very confusing ways (e.g. blocks).
2935 * <code>print_location_comment(__FILE__, __LINE__);</code>
2937 * @param string $file
2938 * @param integer $line
2939 * @param boolean $return Whether to return or print the comment
2940 * @return string|void Void unless true given as third parameter
2941 */
2942 function print_location_comment($file, $line, $return = false)
2944     if ($return) {
2945         return "<!-- $file at line $line -->\n";
2946     } else {
2947         echo "<!-- $file at line $line -->\n";
2948     }
2952 /**
2953  * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
2954  */
2955 function right_to_left() {
2956     return (get_string('thisdirection', 'langconfig') === 'rtl');
2960 /**
2961  * Returns swapped left<=>right if in RTL environment.
2962  * part of RTL support
2963  *
2964  * @param string $align align to check
2965  * @return string
2966  */
2967 function fix_align_rtl($align) {
2968     if (!right_to_left()) {
2969         return $align;
2970     }
2971     if ($align=='left')  { return 'right'; }
2972     if ($align=='right') { return 'left'; }
2973     return $align;
2977 /**
2978  * Returns true if the page is displayed in a popup window.
2979  * Gets the information from the URL parameter inpopup.
2980  *
2981  * @todo Use a central function to create the popup calls all over Moodle and
2982  * In the moment only works with resources and probably questions.
2983  *
2984  * @return boolean
2985  */
2986 function is_in_popup() {
2987     $inpopup = optional_param('inpopup', '', PARAM_BOOL);
2989     return ($inpopup);
2992 /**
2993  * To use this class.
2994  * - construct
2995  * - call create (or use the 3rd param to the constructor)
2996  * - call update or update_full() or update() repeatedly
2997  *
2998  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2999  * @package moodlecore
3000  */
3001 class progress_bar {
3002     /** @var string html id */
3003     private $html_id;
3004     /** @var int total width */
3005     private $width;
3006     /** @var int last percentage printed */
3007     private $percent = 0;
3008     /** @var int time when last printed */
3009     private $lastupdate = 0;
3010     /** @var int when did we start printing this */
3011     private $time_start = 0;
3013     /**
3014      * Constructor
3015      *
3016      * @param string $html_id
3017      * @param int $width
3018      * @param bool $autostart Default to false
3019      * @return void, prints JS code if $autostart true
3020      */
3021     public function __construct($html_id = '', $width = 500, $autostart = false) {
3022         if (!empty($html_id)) {
3023             $this->html_id  = $html_id;
3024         } else {
3025             $this->html_id  = 'pbar_'.uniqid();
3026         }
3028         $this->width = $width;
3030         if ($autostart){
3031             $this->create();
3032         }
3033     }
3035     /**
3036       * Create a new progress bar, this function will output html.
3037       *
3038       * @return void Echo's output
3039       */
3040     public function create() {
3041         $this->time_start = microtime(true);
3042         if (CLI_SCRIPT) {
3043             return; // temporary solution for cli scripts
3044         }
3045         $htmlcode = <<<EOT
3046         <div style="text-align:center;width:{$this->width}px;clear:both;padding:0;margin:0 auto;">
3047             <h2 id="status_{$this->html_id}" style="text-align: center;margin:0 auto"></h2>
3048             <p id="time_{$this->html_id}"></p>
3049             <div id="bar_{$this->html_id}" style="border-style:solid;border-width:1px;width:500px;height:50px;">
3050                 <div id="progress_{$this->html_id}"
3051                 style="text-align:center;background:#FFCC66;width:4px;border:1px
3052                 solid gray;height:38px; padding-top:10px;">&nbsp;<span id="pt_{$this->html_id}"></span>
3053                 </div>
3054             </div>
3055         </div>
3056 EOT;
3057         flush();
3058         echo $htmlcode;
3059         flush();
3060     }
3062     /**
3063      * Update the progress bar
3064      *
3065      * @param int $percent from 1-100
3066      * @param string $msg
3067      * @return void Echo's output
3068      */
3069     private function _update($percent, $msg) {
3070         if (empty($this->time_start)) {
3071             throw new coding_exception('You must call create() (or use the $autostart ' .
3072                     'argument to the constructor) before you try updating the progress bar.');
3073         }
3075         if (CLI_SCRIPT) {
3076             return; // temporary solution for cli scripts
3077         }
3079         $es = $this->estimate($percent);
3081         if ($es === null) {
3082             // always do the first and last updates
3083             $es = "?";
3084         } else if ($es == 0) {
3085             // always do the last updates
3086         } else if ($this->lastupdate + 20 < time()) {
3087             // we must update otherwise browser would time out
3088         } else if (round($this->percent, 2) === round($percent, 2)) {
3089             // no significant change, no need to update anything
3090             return;
3091         }
3093         $this->percent = $percent;
3094         $this->lastupdate = microtime(true);
3096         $w = ($this->percent/100) * $this->width;
3097         echo html_writer::script(js_writer::function_call('update_progress_bar', array($this->html_id, $w, $this->percent, $msg, $es)));
3098         flush();
3099     }
3101     /**
3102       * Estimate how much time it is going to take.
3103       *
3104       * @param int $curtime the time call this function
3105       * @param int $percent from 1-100
3106       * @return mixed Null (unknown), or int
3107       */
3108     private function estimate($pt) {
3109         if ($this->lastupdate == 0) {
3110             return null;
3111         }
3112         if ($pt < 0.00001) {
3113             return null; // we do not know yet how long it will take
3114         }
3115         if ($pt > 99.99999) {
3116             return 0; // nearly done, right?
3117         }
3118         $consumed = microtime(true) - $this->time_start;
3119         if ($consumed < 0.001) {
3120             return null;
3121         }
3123         return (100 - $pt) * ($consumed / $pt);
3124     }
3126     /**
3127       * Update progress bar according percent
3128       *
3129       * @param int $percent from 1-100
3130       * @param string $msg the message needed to be shown
3131       */
3132     public function update_full($percent, $msg) {
3133         $percent = max(min($percent, 100), 0);
3134         $this->_update($percent, $msg);
3135     }
3137     /**
3138       * Update progress bar according the number of tasks
3139       *
3140       * @param int $cur current task number
3141       * @param int $total total task number
3142       * @param string $msg message
3143       */
3144     public function update($cur, $total, $msg) {
3145         $percent = ($cur / $total) * 100;
3146         $this->update_full($percent, $msg);
3147     }
3149     /**
3150      * Restart the progress bar.
3151      */
3152     public function restart() {
3153         $this->percent    = 0;
3154         $this->lastupdate = 0;
3155         $this->time_start = 0;
3156     }
3159 /**
3160  * Use this class from long operations where you want to output occasional information about
3161  * what is going on, but don't know if, or in what format, the output should be.
3162  *
3163  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3164  * @package moodlecore
3165  */
3166 abstract class progress_trace {
3167     /**
3168      * Output an progress message in whatever format.
3169      *
3170      * @param string $message the message to output.
3171      * @param integer $depth indent depth for this message.
3172      */
3173     abstract public function output($message, $depth = 0);
3175     /**
3176      * Called when the processing is finished.
3177      */
3178     public function finished() {
3179     }
3182 /**
3183  * This subclass of progress_trace does not ouput anything.
3184  *
3185  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3186  * @package moodlecore
3187  */
3188 class null_progress_trace extends progress_trace {
3189     /**
3190      * Does Nothing
3191      *
3192      * @param string $message
3193      * @param int $depth
3194      * @return void Does Nothing
3195      */
3196     public function output($message, $depth = 0) {
3197     }
3200 /**
3201  * This subclass of progress_trace outputs to plain text.
3202  *
3203  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3204  * @package moodlecore
3205  */
3206 class text_progress_trace extends progress_trace {
3207     /**
3208      * Output the trace message.
3209      *
3210      * @param string $message
3211      * @param int $depth
3212      * @return void Output is echo'd
3213      */
3214     public function output($message, $depth = 0) {
3215         echo str_repeat('  ', $depth), $message, "\n";
3216         flush();
3217     }
3220 /**
3221  * This subclass of progress_trace outputs as HTML.
3222  *
3223  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3224  * @package moodlecore
3225  */
3226 class html_progress_trace extends progress_trace {
3227     /**
3228      * Output the trace message.
3229      *
3230      * @param string $message
3231      * @param int $depth
3232      * @return void Output is echo'd
3233      */
3234     public function output($message, $depth = 0) {
3235         echo '<p>', str_repeat('&#160;&#160;', $depth), htmlspecialchars($message), "</p>\n";
3236         flush();
3237     }
3240 /**
3241  * HTML List Progress Tree
3242  *
3243  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3244  * @package moodlecore
3245  */
3246 class html_list_progress_trace extends progress_trace {
3247     /** @var int */
3248     protected $currentdepth = -1;
3250     /**
3251      * Echo out the list
3252      *
3253      * @param string $message The message to display
3254      * @param int $depth
3255      * @return void Output is echoed
3256      */
3257     public function output($message, $depth = 0) {
3258         $samedepth = true;
3259         while ($this->currentdepth > $depth) {
3260             echo "</li>\n</ul>\n";
3261             $this->currentdepth -= 1;
3262             if ($this->currentdepth == $depth) {
3263                 echo '<li>';
3264             }
3265             $samedepth = false;
3266         }
3267         while ($this->currentdepth < $depth) {
3268             echo "<ul>\n<li>";
3269             $this->currentdepth += 1;
3270             $samedepth = false;
3271         }
3272         if ($samedepth) {
3273             echo "</li>\n<li>";
3274         }
3275         echo htmlspecialchars($message);
3276         flush();
3277     }
3279     /**
3280      * Called when the processing is finished.
3281      */
3282     public function finished() {
3283         while ($this->currentdepth >= 0) {
3284             echo "</li>\n</ul>\n";
3285             $this->currentdepth -= 1;
3286         }
3287     }
3290 /**
3291  * This subclass of progress_trace outputs to error log.
3292  *
3293  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3294  * @package moodlecore
3295  */
3296 class error_log_progress_trace extends progress_trace {
3297     /** @var string log prefix */
3298     protected $prefix;
3300     /**
3301      * Constructor.
3302      * @param string $prefix optional log prefix
3303      */
3304     public function __construct($prefix = '') {
3305         $this->prefix = $prefix;
3306     }
3308     /**
3309      * Output the trace message.
3310      *
3311      * @param string $message
3312      * @param int $depth
3313      * @return void Output is sent to error log.
3314      */
3315     public function output($message, $depth = 0) {
3316         error_log($this->prefix . str_repeat('  ', $depth) . $message);
3317     }
3320 /**
3321  * Special type of trace that can be used for catching of
3322  * output of other traces.
3323  *
3324  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3325  * @package moodlecore
3326  */
3327 class progress_trace_buffer extends progress_trace {
3328     /** @var progres_trace */
3329     protected $trace;
3330     /** @var bool do we pass output out */
3331     protected $passthrough;
3332     /** @var string output buffer */
3333     protected $buffer;
3335     /**
3336      * Constructor.
3337      *
3338      * @param progress_trace $trace
3339      * @param bool $passthrough true means output and buffer, false means just buffer and no output
3340      */
3341     public function __construct(progress_trace $trace, $passthrough = true) {
3342         $this->trace       = $trace;
3343         $this->passthrough = $passthrough;
3344         $this->buffer      = '';
3345     }
3347     /**
3348      * Output the trace message.
3349      *
3350      * @param string $message the message to output.
3351      * @param int $depth indent depth for this message.
3352      * @return void output stored in buffer
3353      */
3354     public function output($message, $depth = 0) {
3355         ob_start();
3356         $this->trace->output($message, $depth);
3357         $this->buffer .= ob_get_contents();
3358         if ($this->passthrough) {
3359             ob_end_flush();
3360         } else {
3361             ob_end_clean();
3362         }
3363     }
3365     /**
3366      * Called when the processing is finished.
3367      */
3368     public function finished() {
3369         ob_start();
3370         $this->trace->finished();
3371         $this->buffer .= ob_get_contents();
3372         if ($this->passthrough) {
3373             ob_end_flush();
3374         } else {
3375             ob_end_clean();
3376         }
3377     }
3379     /**
3380      * Reset internal text buffer.
3381      */
3382     public function reset_buffer() {
3383         $this->buffer = '';
3384     }
3386     /**
3387      * Return internal text buffer.
3388      * @return string buffered plain text
3389      */
3390     public function get_buffer() {
3391         return $this->buffer;
3392     }
3395 /**
3396  * Special type of trace that can be used for redirecting to multiple
3397  * other traces.
3398  *
3399  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3400  * @package moodlecore
3401  */
3402 class combined_progress_trace extends progress_trace {
3403     protected $traces;
3405     /**
3406      * @param array $traces multiple traces
3407      */
3408     public function __construct(array $traces) {
3409         $this->traces = $traces;
3410     }
3412     /**
3413      * Output an progress message in whatever format.
3414      *
3415      * @param string $message the message to output.
3416      * @param integer $depth indent depth for this message.
3417      */
3418     public function output($message, $depth = 0) {
3419         foreach($this->traces as $trace) {
3420             $trace->output($message, $depth);
3421         }
3422     }
3424     /**
3425      * Called when the processing is finished.
3426      */
3427     public function finished() {
3428         foreach($this->traces as $trace) {
3429             $trace->finished();
3430         }
3431     }
3434 /**
3435  * Returns a localized sentence in the current language summarizing the current password policy
3436  *
3437  * @todo this should be handled by a function/method in the language pack library once we have a support for it
3438  * @uses $CFG
3439  * @return string
3440  */
3441 function print_password_policy() {
3442     global $CFG;
3444     $message = '';
3445     if (!empty($CFG->passwordpolicy)) {
3446         $messages = array();
3447         $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength);
3448         if (!empty($CFG->minpassworddigits)) {
3449             $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits);
3450         }
3451         if (!empty($CFG->minpasswordlower)) {
3452             $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower);
3453         }
3454         if (!empty($CFG->minpasswordupper)) {
3455             $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper);
3456         }
3457         if (!empty($CFG->minpasswordnonalphanum)) {
3458             $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3459         }
3461         $messages = join(', ', $messages); // this is ugly but we do not have anything better yet...
3462         $message = get_string('informpasswordpolicy', 'auth', $messages);
3463     }
3464     return $message;
3467 /**
3468  * Get the value of a help string fully prepared for display in the current language.
3469  *
3470  * @param string $identifier The identifier of the string to search for.
3471  * @param string $component The module the string is associated with.
3472  * @param boolean $ajax Whether this help is called from an AJAX script.
3473  *                This is used to influence text formatting and determines
3474  *                which format to output the doclink in.
3475  * @return Object An object containing:
3476  * - heading: Any heading that there may be for this help string.
3477  * - text: The wiki-formatted help string.
3478  * - doclink: An object containing a link, the linktext, and any additional
3479  *            CSS classes to apply to that link. Only present if $ajax = false.
3480  * - completedoclink: A text representation of the doclink. Only present if $ajax = true.
3481  */
3482 function get_formatted_help_string($identifier, $component, $ajax = false) {
3483     global $CFG, $OUTPUT;
3484     $sm = get_string_manager();
3486     if (!$sm->string_exists($identifier, $component) ||
3487         !$sm->string_exists($identifier . '_help', $component)) {
3488         // Strings in the on-disk cache may be dirty - try to rebuild it and check again.
3489         $sm->load_component_strings($component, current_language(), true);
3490     }
3492     $data = new stdClass();
3494     if ($sm->string_exists($identifier, $component)) {
3495         $data->heading = format_string(get_string($identifier, $component));
3496     } else {
3497         // Gracefully fall back to an empty string.
3498         $data->heading = '';
3499     }
3501     if ($sm->string_exists($identifier . '_help', $component)) {
3502         $options = new stdClass();
3503         $options->trusted = false;
3504         $options->noclean = false;
3505         $options->smiley = false;
3506         $options->filter = false;
3507         $options->para = true;
3508         $options->newlines = false;
3509         $options->overflowdiv = !$ajax;
3511         // Should be simple wiki only MDL-21695.
3512         $data->text =  format_text(get_string($identifier.'_help', $component), FORMAT_MARKDOWN, $options);
3514         $helplink = $identifier . '_link';
3515         if ($sm->string_exists($helplink, $component)) {  // Link to further info in Moodle docs
3516             $link = get_string($helplink, $component);
3517             $linktext = get_string('morehelp');
3519             $data->doclink = new stdClass();
3520             $url = new moodle_url(get_docs_url($link));
3521             if ($ajax) {
3522                 $data->doclink->link = $url->out();
3523                 $data->doclink->linktext = $linktext;
3524                 $data->doclink->class = ($CFG->doctonewwindow) ? 'helplinkpopup' : '';
3525             } else {
3526                 $data->completedoclink = html_writer::tag('div', $OUTPUT->doc_link($link, $linktext), array('class' => 'helpdoclink'));
3527             }
3528         }
3529     } else {
3530         $data->text = html_writer::tag('p',
3531                 html_writer::tag('strong', 'TODO') . ": missing help string [{$identifier}_help, {$component}]");
3532     }
3533     return $data;