MDL-37286 improve coding style in unit tests
[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);
751         if (strpos($url, $CFG->wwwroot) !== 0) {
752             throw new coding_exception('out_as_local_url called on a non-local URL');
753         }
755         return str_replace($CFG->wwwroot, '', $url);
756     }
758     /**
759      * Returns the 'path' portion of a URL. For example, if the URL is
760      * http://www.example.org:447/my/file/is/here.txt?really=1 then this will
761      * return '/my/file/is/here.txt'.
762      *
763      * By default the path includes slash-arguments (for example,
764      * '/myfile.php/extra/arguments') so it is what you would expect from a
765      * URL path. If you don't want this behaviour, you can opt to exclude the
766      * slash arguments. (Be careful: if the $CFG variable slasharguments is
767      * disabled, these URLs will have a different format and you may need to
768      * look at the 'file' parameter too.)
769      *
770      * @param bool $includeslashargument If true, includes slash arguments
771      * @return string Path of URL
772      */
773     public function get_path($includeslashargument = true) {
774         return $this->path . ($includeslashargument ? $this->slashargument : '');
775     }
777     /**
778      * Returns a given parameter value from the URL.
779      *
780      * @param string $name Name of parameter
781      * @return string Value of parameter or null if not set
782      */
783     public function get_param($name) {
784         if (array_key_exists($name, $this->params)) {
785             return $this->params[$name];
786         } else {
787             return null;
788         }
789     }
792 /**
793  * Determine if there is data waiting to be processed from a form
794  *
795  * Used on most forms in Moodle to check for data
796  * Returns the data as an object, if it's found.
797  * This object can be used in foreach loops without
798  * casting because it's cast to (array) automatically
799  *
800  * Checks that submitted POST data exists and returns it as object.
801  *
802  * @uses $_POST
803  * @return mixed false or object
804  */
805 function data_submitted() {
807     if (empty($_POST)) {
808         return false;
809     } else {
810         return (object)fix_utf8($_POST);
811     }
814 /**
815  * Given some normal text this function will break up any
816  * long words to a given size by inserting the given character
817  *
818  * It's multibyte savvy and doesn't change anything inside html tags.
819  *
820  * @param string $string the string to be modified
821  * @param int $maxsize maximum length of the string to be returned
822  * @param string $cutchar the string used to represent word breaks
823  * @return string
824  */
825 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
827 /// First of all, save all the tags inside the text to skip them
828     $tags = array();
829     filter_save_tags($string,$tags);
831 /// Process the string adding the cut when necessary
832     $output = '';
833     $length = textlib::strlen($string);
834     $wordlength = 0;
836     for ($i=0; $i<$length; $i++) {
837         $char = textlib::substr($string, $i, 1);
838         if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
839             $wordlength = 0;
840         } else {
841             $wordlength++;
842             if ($wordlength > $maxsize) {
843                 $output .= $cutchar;
844                 $wordlength = 0;
845             }
846         }
847         $output .= $char;
848     }
850 /// Finally load the tags back again
851     if (!empty($tags)) {
852         $output = str_replace(array_keys($tags), $tags, $output);
853     }
855     return $output;
858 /**
859  * Try and close the current window using JavaScript, either immediately, or after a delay.
860  *
861  * Echo's out the resulting XHTML & javascript
862  *
863  * @global object
864  * @global object
865  * @param integer $delay a delay in seconds before closing the window. Default 0.
866  * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
867  *      to reload the parent window before this one closes.
868  */
869 function close_window($delay = 0, $reloadopener = false) {
870     global $PAGE, $OUTPUT;
872     if (!$PAGE->headerprinted) {
873         $PAGE->set_title(get_string('closewindow'));
874         echo $OUTPUT->header();
875     } else {
876         $OUTPUT->container_end_all(false);
877     }
879     if ($reloadopener) {
880         // Trigger the reload immediately, even if the reload is after a delay.
881         $PAGE->requires->js_function_call('window.opener.location.reload', array(true));
882     }
883     $OUTPUT->notification(get_string('windowclosing'), 'notifysuccess');
885     $PAGE->requires->js_function_call('close_window', array(new stdClass()), false, $delay);
887     echo $OUTPUT->footer();
888     exit;
891 /**
892  * Returns a string containing a link to the user documentation for the current
893  * page. Also contains an icon by default. Shown to teachers and admin only.
894  *
895  * @global object
896  * @global object
897  * @param string $text The text to be displayed for the link
898  * @param string $iconpath The path to the icon to be displayed
899  * @return string The link to user documentation for this current page
900  */
901 function page_doc_link($text='') {
902     global $CFG, $PAGE, $OUTPUT;
904     if (empty($CFG->docroot) || during_initial_install()) {
905         return '';
906     }
907     if (!has_capability('moodle/site:doclinks', $PAGE->context)) {
908         return '';
909     }
911     $path = $PAGE->docspath;
912     if (!$path) {
913         return '';
914     }
915     return $OUTPUT->doc_link($path, $text);
919 /**
920  * Validates an email to make sure it makes sense.
921  *
922  * @param string $address The email address to validate.
923  * @return boolean
924  */
925 function validate_email($address) {
927     return (preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
928                  '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
929                   '@'.
930                   '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
931                   '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
932                   $address));
935 /**
936  * Extracts file argument either from file parameter or PATH_INFO
937  * Note: $scriptname parameter is not needed anymore
938  *
939  * @global string
940  * @uses $_SERVER
941  * @uses PARAM_PATH
942  * @return string file path (only safe characters)
943  */
944 function get_file_argument() {
945     global $SCRIPT;
947     $relativepath = optional_param('file', FALSE, PARAM_PATH);
949     if ($relativepath !== false and $relativepath !== '') {
950         return $relativepath;
951     }
952     $relativepath = false;
954     // then try extract file from the slasharguments
955     if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
956         // NOTE: ISS tends to convert all file paths to single byte DOS encoding,
957         //       we can not use other methods because they break unicode chars,
958         //       the only way is to use URL rewriting
959         if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
960             // check that PATH_INFO works == must not contain the script name
961             if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
962                 $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
963             }
964         }
965     } else {
966         // all other apache-like servers depend on PATH_INFO
967         if (isset($_SERVER['PATH_INFO'])) {
968             if (isset($_SERVER['SCRIPT_NAME']) and strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === 0) {
969                 $relativepath = substr($_SERVER['PATH_INFO'], strlen($_SERVER['SCRIPT_NAME']));
970             } else {
971                 $relativepath = $_SERVER['PATH_INFO'];
972             }
973             $relativepath = clean_param($relativepath, PARAM_PATH);
974         }
975     }
978     return $relativepath;
981 /**
982  * Just returns an array of text formats suitable for a popup menu
983  *
984  * @uses FORMAT_MOODLE
985  * @uses FORMAT_HTML
986  * @uses FORMAT_PLAIN
987  * @uses FORMAT_MARKDOWN
988  * @return array
989  */
990 function format_text_menu() {
991     return array (FORMAT_MOODLE => get_string('formattext'),
992                   FORMAT_HTML   => get_string('formathtml'),
993                   FORMAT_PLAIN  => get_string('formatplain'),
994                   FORMAT_MARKDOWN  => get_string('formatmarkdown'));
997 /**
998  * Given text in a variety of format codings, this function returns
999  * the text as safe HTML.
1000  *
1001  * This function should mainly be used for long strings like posts,
1002  * answers, glossary items etc. For short strings @see format_string().
1003  *
1004  * <pre>
1005  * Options:
1006  *      trusted     :   If true the string won't be cleaned. Default false required noclean=true.
1007  *      noclean     :   If true the string won't be cleaned. Default false required trusted=true.
1008  *      nocache     :   If true the strign will not be cached and will be formatted every call. Default false.
1009  *      filter      :   If true the string will be run through applicable filters as well. Default true.
1010  *      para        :   If true then the returned string will be wrapped in div tags. Default true.
1011  *      newlines    :   If true then lines newline breaks will be converted to HTML newline breaks. Default true.
1012  *      context     :   The context that will be used for filtering.
1013  *      overflowdiv :   If set to true the formatted text will be encased in a div
1014  *                      with the class no-overflow before being returned. Default false.
1015  *      allowid     :   If true then id attributes will not be removed, even when
1016  *                      using htmlpurifier. Default false.
1017  * </pre>
1018  *
1019  * @todo Finish documenting this function
1020  *
1021  * @staticvar array $croncache
1022  * @param string $text The text to be formatted. This is raw text originally from user input.
1023  * @param int $format Identifier of the text format to be used
1024  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
1025  * @param object/array $options text formatting options
1026  * @param int $courseid_do_not_use deprecated course id, use context option instead
1027  * @return string
1028  */
1029 function format_text($text, $format = FORMAT_MOODLE, $options = NULL, $courseid_do_not_use = NULL) {
1030     global $CFG, $COURSE, $DB, $PAGE;
1031     static $croncache = array();
1033     if ($text === '' || is_null($text)) {
1034         return ''; // no need to do any filters and cleaning
1035     }
1037     $options = (array)$options; // detach object, we can not modify it
1039     if (!isset($options['trusted'])) {
1040         $options['trusted'] = false;
1041     }
1042     if (!isset($options['noclean'])) {
1043         if ($options['trusted'] and trusttext_active()) {
1044             // no cleaning if text trusted and noclean not specified
1045             $options['noclean'] = true;
1046         } else {
1047             $options['noclean'] = false;
1048         }
1049     }
1050     if (!isset($options['nocache'])) {
1051         $options['nocache'] = false;
1052     }
1053     if (!isset($options['filter'])) {
1054         $options['filter'] = true;
1055     }
1056     if (!isset($options['para'])) {
1057         $options['para'] = true;
1058     }
1059     if (!isset($options['newlines'])) {
1060         $options['newlines'] = true;
1061     }
1062     if (!isset($options['overflowdiv'])) {
1063         $options['overflowdiv'] = false;
1064     }
1066     // Calculate best context
1067     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
1068         // do not filter anything during installation or before upgrade completes
1069         $context = null;
1071     } else if (isset($options['context'])) { // first by explicit passed context option
1072         if (is_object($options['context'])) {
1073             $context = $options['context'];
1074         } else {
1075             $context = context::instance_by_id($options['context']);
1076         }
1077     } else if ($courseid_do_not_use) {
1078         // legacy courseid
1079         $context = context_course::instance($courseid_do_not_use);
1080     } else {
1081         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1082         $context = $PAGE->context;
1083     }
1085     if (!$context) {
1086         // either install/upgrade or something has gone really wrong because context does not exist (yet?)
1087         $options['nocache'] = true;
1088         $options['filter']  = false;
1089     }
1091     if ($options['filter']) {
1092         $filtermanager = filter_manager::instance();
1093         $filtermanager->setup_page_for_filters($PAGE, $context); // Setup global stuff filters may have.
1094     } else {
1095         $filtermanager = new null_filter_manager();
1096     }
1098     if (!empty($CFG->cachetext) and empty($options['nocache'])) {
1099         $hashstr = $text.'-'.$filtermanager->text_filtering_hash($context).'-'.$context->id.'-'.current_language().'-'.
1100                 (int)$format.(int)$options['trusted'].(int)$options['noclean'].
1101                 (int)$options['para'].(int)$options['newlines'];
1103         $time = time() - $CFG->cachetext;
1104         $md5key = md5($hashstr);
1105         if (CLI_SCRIPT) {
1106             if (isset($croncache[$md5key])) {
1107                 return $croncache[$md5key];
1108             }
1109         }
1111         if ($oldcacheitem = $DB->get_record('cache_text', array('md5key'=>$md5key), '*', IGNORE_MULTIPLE)) {
1112             if ($oldcacheitem->timemodified >= $time) {
1113                 if (CLI_SCRIPT) {
1114                     if (count($croncache) > 150) {
1115                         reset($croncache);
1116                         $key = key($croncache);
1117                         unset($croncache[$key]);
1118                     }
1119                     $croncache[$md5key] = $oldcacheitem->formattedtext;
1120                 }
1121                 return $oldcacheitem->formattedtext;
1122             }
1123         }
1124     }
1126     switch ($format) {
1127         case FORMAT_HTML:
1128             if (!$options['noclean']) {
1129                 $text = clean_text($text, FORMAT_HTML, $options);
1130             }
1131             $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_HTML, 'noclean' => $options['noclean']));
1132             break;
1134         case FORMAT_PLAIN:
1135             $text = s($text); // cleans dangerous JS
1136             $text = rebuildnolinktag($text);
1137             $text = str_replace('  ', '&nbsp; ', $text);
1138             $text = nl2br($text);
1139             break;
1141         case FORMAT_WIKI:
1142             // this format is deprecated
1143             $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle.  You should not be seeing
1144                      this message as all texts should have been converted to Markdown format instead.
1145                      Please post a bug report to http://moodle.org/bugs with information about where you
1146                      saw this message.</p>'.s($text);
1147             break;
1149         case FORMAT_MARKDOWN:
1150             $text = markdown_to_html($text);
1151             if (!$options['noclean']) {
1152                 $text = clean_text($text, FORMAT_HTML, $options);
1153             }
1154             $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_MARKDOWN, 'noclean' => $options['noclean']));
1155             break;
1157         default:  // FORMAT_MOODLE or anything else
1158             $text = text_to_html($text, null, $options['para'], $options['newlines']);
1159             if (!$options['noclean']) {
1160                 $text = clean_text($text, FORMAT_HTML, $options);
1161             }
1162             $text = $filtermanager->filter_text($text, $context, array('originalformat' => $format, 'noclean' => $options['noclean']));
1163             break;
1164     }
1165     if ($options['filter']) {
1166         // at this point there should not be any draftfile links any more,
1167         // this happens when developers forget to post process the text.
1168         // The only potential problem is that somebody might try to format
1169         // the text before storing into database which would be itself big bug.
1170         $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
1171     }
1173     // Warn people that we have removed this old mechanism, just in case they
1174     // were stupid enough to rely on it.
1175     if (isset($CFG->currenttextiscacheable)) {
1176         debugging('Once upon a time, Moodle had a truly evil use of global variables ' .
1177                 'called $CFG->currenttextiscacheable. The good news is that this no ' .
1178                 'longer exists. The bad news is that you seem to be using a filter that '.
1179                 'relies on it. Please seek out and destroy that filter code.', DEBUG_DEVELOPER);
1180     }
1182     if (!empty($options['overflowdiv'])) {
1183         $text = html_writer::tag('div', $text, array('class'=>'no-overflow'));
1184     }
1186     if (empty($options['nocache']) and !empty($CFG->cachetext)) {
1187         if (CLI_SCRIPT) {
1188             // special static cron cache - no need to store it in db if its not already there
1189             if (count($croncache) > 150) {
1190                 reset($croncache);
1191                 $key = key($croncache);
1192                 unset($croncache[$key]);
1193             }
1194             $croncache[$md5key] = $text;
1195             return $text;
1196         }
1198         $newcacheitem = new stdClass();
1199         $newcacheitem->md5key = $md5key;
1200         $newcacheitem->formattedtext = $text;
1201         $newcacheitem->timemodified = time();
1202         if ($oldcacheitem) {                               // See bug 4677 for discussion
1203             $newcacheitem->id = $oldcacheitem->id;
1204             try {
1205                 $DB->update_record('cache_text', $newcacheitem);   // Update existing record in the cache table
1206             } catch (dml_exception $e) {
1207                // It's unlikely that the cron cache cleaner could have
1208                // deleted this entry in the meantime, as it allows
1209                // some extra time to cover these cases.
1210             }
1211         } else {
1212             try {
1213                 $DB->insert_record('cache_text', $newcacheitem);   // Insert a new record in the cache table
1214             } catch (dml_exception $e) {
1215                // Again, it's possible that another user has caused this
1216                // record to be created already in the time that it took
1217                // to traverse this function.  That's OK too, as the
1218                // call above handles duplicate entries, and eventually
1219                // the cron cleaner will delete them.
1220             }
1221         }
1222     }
1224     return $text;
1227 /**
1228  * Resets all data related to filters, called during upgrade or when filter settings change.
1229  *
1230  * @param bool $phpunitreset true means called from our PHPUnit integration test reset
1231  * @return void
1232  */
1233 function reset_text_filters_cache($phpunitreset = false) {
1234     global $CFG, $DB;
1236     if (!$phpunitreset) {
1237         $DB->delete_records('cache_text');
1238     }
1240     $purifdir = $CFG->cachedir.'/htmlpurifier';
1241     remove_dir($purifdir, true);
1244 /**
1245  * Given a simple string, this function returns the string
1246  * processed by enabled string filters if $CFG->filterall is enabled
1247  *
1248  * This function should be used to print short strings (non html) that
1249  * need filter processing e.g. activity titles, post subjects,
1250  * glossary concepts.
1251  *
1252  * @staticvar bool $strcache
1253  * @param string $string The string to be filtered. Should be plain text, expect
1254  * possibly for multilang tags.
1255  * @param boolean $striplinks To strip any link in the result text.
1256                               Moodle 1.8 default changed from false to true! MDL-8713
1257  * @param array $options options array/object or courseid
1258  * @return string
1259  */
1260 function format_string($string, $striplinks = true, $options = NULL) {
1261     global $CFG, $COURSE, $PAGE;
1263     //We'll use a in-memory cache here to speed up repeated strings
1264     static $strcache = false;
1266     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
1267         // do not filter anything during installation or before upgrade completes
1268         return $string = strip_tags($string);
1269     }
1271     if ($strcache === false or count($strcache) > 2000) { // this number might need some tuning to limit memory usage in cron
1272         $strcache = array();
1273     }
1275     if (is_numeric($options)) {
1276         // legacy courseid usage
1277         $options  = array('context'=>context_course::instance($options));
1278     } else {
1279         $options = (array)$options; // detach object, we can not modify it
1280     }
1282     if (empty($options['context'])) {
1283         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1284         $options['context'] = $PAGE->context;
1285     } else if (is_numeric($options['context'])) {
1286         $options['context'] = context::instance_by_id($options['context']);
1287     }
1289     if (!$options['context']) {
1290         // we did not find any context? weird
1291         return $string = strip_tags($string);
1292     }
1294     //Calculate md5
1295     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id.'<+>'.current_language());
1297     //Fetch from cache if possible
1298     if (isset($strcache[$md5])) {
1299         return $strcache[$md5];
1300     }
1302     // First replace all ampersands not followed by html entity code
1303     // Regular expression moved to its own method for easier unit testing
1304     $string = replace_ampersands_not_followed_by_entity($string);
1306     if (!empty($CFG->filterall)) {
1307         $filtermanager = filter_manager::instance();
1308         $filtermanager->setup_page_for_filters($PAGE, $options['context']); // Setup global stuff filters may have.
1309         $string = $filtermanager->filter_string($string, $options['context']);
1310     }
1312     // If the site requires it, strip ALL tags from this string
1313     if (!empty($CFG->formatstringstriptags)) {
1314         $string = str_replace(array('<', '>'), array('&lt;', '&gt;'), strip_tags($string));
1316     } else {
1317         // Otherwise strip just links if that is required (default)
1318         if ($striplinks) {  //strip links in string
1319             $string = strip_links($string);
1320         }
1321         $string = clean_text($string);
1322     }
1324     //Store to cache
1325     $strcache[$md5] = $string;
1327     return $string;
1330 /**
1331  * Given a string, performs a negative lookahead looking for any ampersand character
1332  * that is not followed by a proper HTML entity. If any is found, it is replaced
1333  * by &amp;. The string is then returned.
1334  *
1335  * @param string $string
1336  * @return string
1337  */
1338 function replace_ampersands_not_followed_by_entity($string) {
1339     return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1342 /**
1343  * Given a string, replaces all <a>.*</a> by .* and returns the string.
1344  *
1345  * @param string $string
1346  * @return string
1347  */
1348 function strip_links($string) {
1349     return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is','$2',$string);
1352 /**
1353  * This expression turns links into something nice in a text format. (Russell Jungwirth)
1354  *
1355  * @param string $string
1356  * @return string
1357  */
1358 function wikify_links($string) {
1359     return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i','$3 [ $2 ]', $string);
1362 /**
1363  * Given text in a variety of format codings, this function returns
1364  * the text as plain text suitable for plain email.
1365  *
1366  * @uses FORMAT_MOODLE
1367  * @uses FORMAT_HTML
1368  * @uses FORMAT_PLAIN
1369  * @uses FORMAT_WIKI
1370  * @uses FORMAT_MARKDOWN
1371  * @param string $text The text to be formatted. This is raw text originally from user input.
1372  * @param int $format Identifier of the text format to be used
1373  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1374  * @return string
1375  */
1376 function format_text_email($text, $format) {
1378     switch ($format) {
1380         case FORMAT_PLAIN:
1381             return $text;
1382             break;
1384         case FORMAT_WIKI:
1385             // there should not be any of these any more!
1386             $text = wikify_links($text);
1387             return textlib::entities_to_utf8(strip_tags($text), true);
1388             break;
1390         case FORMAT_HTML:
1391             return html_to_text($text);
1392             break;
1394         case FORMAT_MOODLE:
1395         case FORMAT_MARKDOWN:
1396         default:
1397             $text = wikify_links($text);
1398             return textlib::entities_to_utf8(strip_tags($text), true);
1399             break;
1400     }
1403 /**
1404  * Formats activity intro text
1405  *
1406  * @global object
1407  * @uses CONTEXT_MODULE
1408  * @param string $module name of module
1409  * @param object $activity instance of activity
1410  * @param int $cmid course module id
1411  * @param bool $filter filter resulting html text
1412  * @return text
1413  */
1414 function format_module_intro($module, $activity, $cmid, $filter=true) {
1415     global $CFG;
1416     require_once("$CFG->libdir/filelib.php");
1417     $context = context_module::instance($cmid);
1418     $options = array('noclean'=>true, 'para'=>false, 'filter'=>$filter, 'context'=>$context, 'overflowdiv'=>true);
1419     $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, 'mod_'.$module, 'intro', null);
1420     return trim(format_text($intro, $activity->introformat, $options, null));
1423 /**
1424  * Legacy function, used for cleaning of old forum and glossary text only.
1425  *
1426  * @global object
1427  * @param string $text text that may contain legacy TRUSTTEXT marker
1428  * @return text without legacy TRUSTTEXT marker
1429  */
1430 function trusttext_strip($text) {
1431     while (true) { //removing nested TRUSTTEXT
1432         $orig = $text;
1433         $text = str_replace('#####TRUSTTEXT#####', '', $text);
1434         if (strcmp($orig, $text) === 0) {
1435             return $text;
1436         }
1437     }
1440 /**
1441  * Must be called before editing of all texts
1442  * with trust flag. Removes all XSS nasties
1443  * from texts stored in database if needed.
1444  *
1445  * @param object $object data object with xxx, xxxformat and xxxtrust fields
1446  * @param string $field name of text field
1447  * @param object $context active context
1448  * @return object updated $object
1449  */
1450 function trusttext_pre_edit($object, $field, $context) {
1451     $trustfield  = $field.'trust';
1452     $formatfield = $field.'format';
1454     if (!$object->$trustfield or !trusttext_trusted($context)) {
1455         $object->$field = clean_text($object->$field, $object->$formatfield);
1456     }
1458     return $object;
1461 /**
1462  * Is current user trusted to enter no dangerous XSS in this context?
1463  *
1464  * Please note the user must be in fact trusted everywhere on this server!!
1465  *
1466  * @param object $context
1467  * @return bool true if user trusted
1468  */
1469 function trusttext_trusted($context) {
1470     return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1473 /**
1474  * Is trusttext feature active?
1475  *
1476  * @return bool
1477  */
1478 function trusttext_active() {
1479     global $CFG;
1481     return !empty($CFG->enabletrusttext);
1484 /**
1485  * Given raw text (eg typed in by a user), this function cleans it up
1486  * and removes any nasty tags that could mess up Moodle pages through XSS attacks.
1487  *
1488  * The result must be used as a HTML text fragment, this function can not cleanup random
1489  * parts of html tags such as url or src attributes.
1490  *
1491  * NOTE: the format parameter was deprecated because we can safely clean only HTML.
1492  *
1493  * @param string $text The text to be cleaned
1494  * @param int|string $format deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
1495  * @param array $options Array of options; currently only option supported is 'allowid' (if true,
1496  *   does not remove id attributes when cleaning)
1497  * @return string The cleaned up text
1498  */
1499 function clean_text($text, $format = FORMAT_HTML, $options = array()) {
1500     $text = (string)$text;
1502     if ($format != FORMAT_HTML and $format != FORMAT_HTML) {
1503         // TODO: we need to standardise cleanup of text when loading it into editor first
1504         //debugging('clean_text() is designed to work only with html');
1505     }
1507     if ($format == FORMAT_PLAIN) {
1508         return $text;
1509     }
1511     if (is_purify_html_necessary($text)) {
1512         $text = purify_html($text, $options);
1513     }
1515     // Originally we tried to neutralise some script events here, it was a wrong approach because
1516     // it was trivial to work around that (for example using style based XSS exploits).
1517     // We must not give false sense of security here - all developers MUST understand how to use
1518     // rawurlencode(), htmlentities(), htmlspecialchars(), p(), s(), moodle_url, html_writer and friends!!!
1520     return $text;
1523 /**
1524  * Is it necessary to use HTMLPurifier?
1525  * @private
1526  * @param string $text
1527  * @return bool false means html is safe and valid, true means use HTMLPurifier
1528  */
1529 function is_purify_html_necessary($text) {
1530     if ($text === '') {
1531         return false;
1532     }
1534     if ($text === (string)((int)$text)) {
1535         return false;
1536     }
1538     if (strpos($text, '&') !== false or preg_match('|<[^pesb/]|', $text)) {
1539         // we need to normalise entities or other tags except p, em, strong and br present
1540         return true;
1541     }
1543     $altered = htmlspecialchars($text, ENT_NOQUOTES, 'UTF-8', true);
1544     if ($altered === $text) {
1545         // no < > or other special chars means this must be safe
1546         return false;
1547     }
1549     // let's try to convert back some safe html tags
1550     $altered = preg_replace('|&lt;p&gt;(.*?)&lt;/p&gt;|m', '<p>$1</p>', $altered);
1551     if ($altered === $text) {
1552         return false;
1553     }
1554     $altered = preg_replace('|&lt;em&gt;([^<>]+?)&lt;/em&gt;|m', '<em>$1</em>', $altered);
1555     if ($altered === $text) {
1556         return false;
1557     }
1558     $altered = preg_replace('|&lt;strong&gt;([^<>]+?)&lt;/strong&gt;|m', '<strong>$1</strong>', $altered);
1559     if ($altered === $text) {
1560         return false;
1561     }
1562     $altered = str_replace('&lt;br /&gt;', '<br />', $altered);
1563     if ($altered === $text) {
1564         return false;
1565     }
1567     return true;
1570 /**
1571  * KSES replacement cleaning function - uses HTML Purifier.
1572  *
1573  * @param string $text The (X)HTML string to purify
1574  * @param array $options Array of options; currently only option supported is 'allowid' (if set,
1575  *   does not remove id attributes when cleaning)
1576  * @return string
1577  */
1578 function purify_html($text, $options = array()) {
1579     global $CFG;
1581     $type = !empty($options['allowid']) ? 'allowid' : 'normal';
1582     static $purifiers = array();
1583     if (empty($purifiers[$type])) {
1585         // make sure the serializer dir exists, it should be fine if it disappears later during cache reset
1586         $cachedir = $CFG->cachedir.'/htmlpurifier';
1587         check_dir_exists($cachedir);
1589         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1590         require_once $CFG->libdir.'/htmlpurifier/locallib.php';
1591         $config = HTMLPurifier_Config::createDefault();
1593         $config->set('HTML.DefinitionID', 'moodlehtml');
1594         $config->set('HTML.DefinitionRev', 2);
1595         $config->set('Cache.SerializerPath', $cachedir);
1596         $config->set('Cache.SerializerPermissions', $CFG->directorypermissions);
1597         $config->set('Core.NormalizeNewlines', false);
1598         $config->set('Core.ConvertDocumentToFragment', true);
1599         $config->set('Core.Encoding', 'UTF-8');
1600         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1601         $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));
1602         $config->set('Attr.AllowedFrameTargets', array('_blank'));
1604         if (!empty($CFG->allowobjectembed)) {
1605             $config->set('HTML.SafeObject', true);
1606             $config->set('Output.FlashCompat', true);
1607             $config->set('HTML.SafeEmbed', true);
1608         }
1610         if ($type === 'allowid') {
1611             $config->set('Attr.EnableID', true);
1612         }
1614         if ($def = $config->maybeGetRawHTMLDefinition()) {
1615             $def->addElement('nolink', 'Block', 'Flow', array());                       // skip our filters inside
1616             $def->addElement('tex', 'Inline', 'Inline', array());                       // tex syntax, equivalent to $$xx$$
1617             $def->addElement('algebra', 'Inline', 'Inline', array());                   // algebra syntax, equivalent to @@xx@@
1618             $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // old and future style multilang - only our hacked lang attribute
1619             $def->addAttribute('span', 'xxxlang', 'CDATA');                             // current problematic multilang
1620         }
1622         $purifier = new HTMLPurifier($config);
1623         $purifiers[$type] = $purifier;
1624     } else {
1625         $purifier = $purifiers[$type];
1626     }
1628     $multilang = (strpos($text, 'class="multilang"') !== false);
1630     if ($multilang) {
1631         $text = preg_replace('/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/', '<span xxxlang="${2}">', $text);
1632     }
1633     $text = $purifier->purify($text);
1634     if ($multilang) {
1635         $text = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $text);
1636     }
1638     return $text;
1641 /**
1642  * Given plain text, makes it into HTML as nicely as possible.
1643  * May contain HTML tags already
1644  *
1645  * Do not abuse this function. It is intended as lower level formatting feature used
1646  * by {@see format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
1647  * to call format_text() in most of cases.
1648  *
1649  * @param string $text The string to convert.
1650  * @param boolean $smiley_ignored Was used to determine if smiley characters should convert to smiley images, ignored now
1651  * @param boolean $para If true then the returned string will be wrapped in div tags
1652  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1653  * @return string
1654  */
1655 function text_to_html($text, $smiley_ignored=null, $para=true, $newlines=true) {
1656 /// Remove any whitespace that may be between HTML tags
1657     $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1659 /// Remove any returns that precede or follow HTML tags
1660     $text = preg_replace("~([\n\r])<~i", " <", $text);
1661     $text = preg_replace("~>([\n\r])~i", "> ", $text);
1663 /// Make returns into HTML newlines.
1664     if ($newlines) {
1665         $text = nl2br($text);
1666     }
1668 /// Wrap the whole thing in a div if required
1669     if ($para) {
1670         //return '<p>'.$text.'</p>'; //1.9 version
1671         return '<div class="text_to_html">'.$text.'</div>';
1672     } else {
1673         return $text;
1674     }
1677 /**
1678  * Given Markdown formatted text, make it into XHTML using external function
1679  *
1680  * @global object
1681  * @param string $text The markdown formatted text to be converted.
1682  * @return string Converted text
1683  */
1684 function markdown_to_html($text) {
1685     global $CFG;
1687     if ($text === '' or $text === NULL) {
1688         return $text;
1689     }
1691     require_once($CFG->libdir .'/markdown.php');
1693     return Markdown($text);
1696 /**
1697  * Given HTML text, make it into plain text using external function
1698  *
1699  * @param string $html The text to be converted.
1700  * @param integer $width Width to wrap the text at. (optional, default 75 which
1701  *      is a good value for email. 0 means do not limit line length.)
1702  * @param boolean $dolinks By default, any links in the HTML are collected, and
1703  *      printed as a list at the end of the HTML. If you don't want that, set this
1704  *      argument to false.
1705  * @return string plain text equivalent of the HTML.
1706  */
1707 function html_to_text($html, $width = 75, $dolinks = true) {
1709     global $CFG;
1711     require_once($CFG->libdir .'/html2text.php');
1713     $h2t = new html2text($html, false, $dolinks, $width);
1714     $result = $h2t->get_text();
1716     return $result;
1719 /**
1720  * This function will highlight search words in a given string
1721  *
1722  * It cares about HTML and will not ruin links.  It's best to use
1723  * this function after performing any conversions to HTML.
1724  *
1725  * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1726  * @param string $haystack The string (HTML) within which to highlight the search terms.
1727  * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1728  * @param string $prefix the string to put before each search term found.
1729  * @param string $suffix the string to put after each search term found.
1730  * @return string The highlighted HTML.
1731  */
1732 function highlight($needle, $haystack, $matchcase = false,
1733         $prefix = '<span class="highlight">', $suffix = '</span>') {
1735 /// Quick bail-out in trivial cases.
1736     if (empty($needle) or empty($haystack)) {
1737         return $haystack;
1738     }
1740 /// Break up the search term into words, discard any -words and build a regexp.
1741     $words = preg_split('/ +/', trim($needle));
1742     foreach ($words as $index => $word) {
1743         if (strpos($word, '-') === 0) {
1744             unset($words[$index]);
1745         } else if (strpos($word, '+') === 0) {
1746             $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
1747         } else {
1748             $words[$index] = preg_quote($word, '/');
1749         }
1750     }
1751     $regexp = '/(' . implode('|', $words) . ')/u'; // u is do UTF-8 matching.
1752     if (!$matchcase) {
1753         $regexp .= 'i';
1754     }
1756 /// Another chance to bail-out if $search was only -words
1757     if (empty($words)) {
1758         return $haystack;
1759     }
1761 /// Find all the HTML tags in the input, and store them in a placeholders array.
1762     $placeholders = array();
1763     $matches = array();
1764     preg_match_all('/<[^>]*>/', $haystack, $matches);
1765     foreach (array_unique($matches[0]) as $key => $htmltag) {
1766         $placeholders['<|' . $key . '|>'] = $htmltag;
1767     }
1769 /// In $hastack, replace each HTML tag with the corresponding placeholder.
1770     $haystack = str_replace($placeholders, array_keys($placeholders), $haystack);
1772 /// In the resulting string, Do the highlighting.
1773     $haystack = preg_replace($regexp, $prefix . '$1' . $suffix, $haystack);
1775 /// Turn the placeholders back into HTML tags.
1776     $haystack = str_replace(array_keys($placeholders), $placeholders, $haystack);
1778     return $haystack;
1781 /**
1782  * This function will highlight instances of $needle in $haystack
1783  *
1784  * It's faster that the above function {@link highlight()} and doesn't care about
1785  * HTML or anything.
1786  *
1787  * @param string $needle The string to search for
1788  * @param string $haystack The string to search for $needle in
1789  * @return string The highlighted HTML
1790  */
1791 function highlightfast($needle, $haystack) {
1793     if (empty($needle) or empty($haystack)) {
1794         return $haystack;
1795     }
1797     $parts = explode(textlib::strtolower($needle), textlib::strtolower($haystack));
1799     if (count($parts) === 1) {
1800         return $haystack;
1801     }
1803     $pos = 0;
1805     foreach ($parts as $key => $part) {
1806         $parts[$key] = substr($haystack, $pos, strlen($part));
1807         $pos += strlen($part);
1809         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
1810         $pos += strlen($needle);
1811     }
1813     return str_replace('<span class="highlight"></span>', '', join('', $parts));
1816 /**
1817  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
1818  * Internationalisation, for print_header and backup/restorelib.
1819  *
1820  * @param bool $dir Default false
1821  * @return string Attributes
1822  */
1823 function get_html_lang($dir = false) {
1824     $direction = '';
1825     if ($dir) {
1826         if (right_to_left()) {
1827             $direction = ' dir="rtl"';
1828         } else {
1829             $direction = ' dir="ltr"';
1830         }
1831     }
1832     //Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
1833     $language = str_replace('_', '-', current_language());
1834     @header('Content-Language: '.$language);
1835     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
1839 /// STANDARD WEB PAGE PARTS ///////////////////////////////////////////////////
1841 /**
1842  * Send the HTTP headers that Moodle requires.
1843  *
1844  * There is a backwards compatibility hack for legacy code
1845  * that needs to add custom IE compatibility directive.
1846  *
1847  * Example:
1848  * <code>
1849  * if (!isset($CFG->additionalhtmlhead)) {
1850  *     $CFG->additionalhtmlhead = '';
1851  * }
1852  * $CFG->additionalhtmlhead .= '<meta http-equiv="X-UA-Compatible" content="IE=8" />';
1853  * header('X-UA-Compatible: IE=8');
1854  * echo $OUTPUT->header();
1855  * </code>
1856  *
1857  * Please note the $CFG->additionalhtmlhead alone might not work,
1858  * you should send the IE compatibility header() too.
1859  *
1860  * @param string $contenttype
1861  * @param bool $cacheable Can this page be cached on back?
1862  * @return void, sends HTTP headers
1863  */
1864 function send_headers($contenttype, $cacheable = true) {
1865     global $CFG;
1867     @header('Content-Type: ' . $contenttype);
1868     @header('Content-Script-Type: text/javascript');
1869     @header('Content-Style-Type: text/css');
1871     if (empty($CFG->additionalhtmlhead) or stripos($CFG->additionalhtmlhead, 'X-UA-Compatible') === false) {
1872         @header('X-UA-Compatible: IE=edge');
1873     }
1875     if ($cacheable) {
1876         // Allow caching on "back" (but not on normal clicks)
1877         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0');
1878         @header('Pragma: no-cache');
1879         @header('Expires: ');
1880     } else {
1881         // Do everything we can to always prevent clients and proxies caching
1882         @header('Cache-Control: no-store, no-cache, must-revalidate');
1883         @header('Cache-Control: post-check=0, pre-check=0', false);
1884         @header('Pragma: no-cache');
1885         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1886         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1887     }
1888     @header('Accept-Ranges: none');
1890     if (empty($CFG->allowframembedding)) {
1891         @header('X-Frame-Options: sameorigin');
1892     }
1895 /**
1896  * Return the right arrow with text ('next'), and optionally embedded in a link.
1897  *
1898  * @global object
1899  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1900  * @param string $url An optional link to use in a surrounding HTML anchor.
1901  * @param bool $accesshide True if text should be hidden (for screen readers only).
1902  * @param string $addclass Additional class names for the link, or the arrow character.
1903  * @return string HTML string.
1904  */
1905 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
1906     global $OUTPUT; //TODO: move to output renderer
1907     $arrowclass = 'arrow ';
1908     if (! $url) {
1909         $arrowclass .= $addclass;
1910     }
1911     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
1912     $htmltext = '';
1913     if ($text) {
1914         $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
1915         if ($accesshide) {
1916             $htmltext = get_accesshide($htmltext);
1917         }
1918     }
1919     if ($url) {
1920         $class = 'arrow_link';
1921         if ($addclass) {
1922             $class .= ' '.$addclass;
1923         }
1924         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$htmltext.$arrow.'</a>';
1925     }
1926     return $htmltext.$arrow;
1929 /**
1930  * Return the left arrow with text ('previous'), and optionally embedded in a link.
1931  *
1932  * @global object
1933  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1934  * @param string $url An optional link to use in a surrounding HTML anchor.
1935  * @param bool $accesshide True if text should be hidden (for screen readers only).
1936  * @param string $addclass Additional class names for the link, or the arrow character.
1937  * @return string HTML string.
1938  */
1939 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
1940     global $OUTPUT; // TODO: move to utput renderer
1941     $arrowclass = 'arrow ';
1942     if (! $url) {
1943         $arrowclass .= $addclass;
1944     }
1945     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
1946     $htmltext = '';
1947     if ($text) {
1948         $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
1949         if ($accesshide) {
1950             $htmltext = get_accesshide($htmltext);
1951         }
1952     }
1953     if ($url) {
1954         $class = 'arrow_link';
1955         if ($addclass) {
1956             $class .= ' '.$addclass;
1957         }
1958         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$arrow.$htmltext.'</a>';
1959     }
1960     return $arrow.$htmltext;
1963 /**
1964  * Return a HTML element with the class "accesshide", for accessibility.
1965  * Please use cautiously - where possible, text should be visible!
1966  *
1967  * @param string $text Plain text.
1968  * @param string $elem Lowercase element name, default "span".
1969  * @param string $class Additional classes for the element.
1970  * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
1971  * @return string HTML string.
1972  */
1973 function get_accesshide($text, $elem='span', $class='', $attrs='') {
1974     return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
1977 /**
1978  * Return the breadcrumb trail navigation separator.
1979  *
1980  * @return string HTML string.
1981  */
1982 function get_separator() {
1983     //Accessibility: the 'hidden' slash is preferred for screen readers.
1984     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
1987 /**
1988  * Print (or return) a collapsible region, that has a caption that can
1989  * be clicked to expand or collapse the region.
1990  *
1991  * If JavaScript is off, then the region will always be expanded.
1992  *
1993  * @param string $contents the contents of the box.
1994  * @param string $classes class names added to the div that is output.
1995  * @param string $id id added to the div that is output. Must not be blank.
1996  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
1997  * @param string $userpref the name of the user preference that stores the user's preferred default state.
1998  *      (May be blank if you do not wish the state to be persisted.
1999  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2000  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2001  * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
2002  */
2003 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2004     $output  = print_collapsible_region_start($classes, $id, $caption, $userpref, $default, true);
2005     $output .= $contents;
2006     $output .= print_collapsible_region_end(true);
2008     if ($return) {
2009         return $output;
2010     } else {
2011         echo $output;
2012     }
2015 /**
2016  * Print (or return) the start of a collapsible region, that has a caption that can
2017  * be clicked to expand or collapse the region. If JavaScript is off, then the region
2018  * will always be expanded.
2019  *
2020  * @param string $classes class names added to the div that is output.
2021  * @param string $id id added to the div that is output. Must not be blank.
2022  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2023  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2024  *      (May be blank if you do not wish the state to be persisted.
2025  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2026  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2027  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2028  */
2029 function print_collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2030     global $CFG, $PAGE, $OUTPUT;
2032     // Work out the initial state.
2033     if (!empty($userpref) and is_string($userpref)) {
2034         user_preference_allow_ajax_update($userpref, PARAM_BOOL);
2035         $collapsed = get_user_preferences($userpref, $default);
2036     } else {
2037         $collapsed = $default;
2038         $userpref = false;
2039     }
2041     if ($collapsed) {
2042         $classes .= ' collapsed';
2043     }
2045     $output = '';
2046     $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2047     $output .= '<div id="' . $id . '_sizer">';
2048     $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2049     $output .= $caption . ' ';
2050     $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2051     $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2053     if ($return) {
2054         return $output;
2055     } else {
2056         echo $output;
2057     }
2060 /**
2061  * Close a region started with print_collapsible_region_start.
2062  *
2063  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2064  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2065  */
2066 function print_collapsible_region_end($return = false) {
2067     $output = '</div></div></div>';
2069     if ($return) {
2070         return $output;
2071     } else {
2072         echo $output;
2073     }
2076 /**
2077  * Print a specified group's avatar.
2078  *
2079  * @global object
2080  * @uses CONTEXT_COURSE
2081  * @param array|stdClass $group A single {@link group} object OR array of groups.
2082  * @param int $courseid The course ID.
2083  * @param boolean $large Default small picture, or large.
2084  * @param boolean $return If false print picture, otherwise return the output as string
2085  * @param boolean $link Enclose image in a link to view specified course?
2086  * @return string|void Depending on the setting of $return
2087  */
2088 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2089     global $CFG;
2091     if (is_array($group)) {
2092         $output = '';
2093         foreach($group as $g) {
2094             $output .= print_group_picture($g, $courseid, $large, true, $link);
2095         }
2096         if ($return) {
2097             return $output;
2098         } else {
2099             echo $output;
2100             return;
2101         }
2102     }
2104     $context = context_course::instance($courseid);
2106     // If there is no picture, do nothing
2107     if (!$group->picture) {
2108         return '';
2109     }
2111     // If picture is hidden, only show to those with course:managegroups
2112     if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
2113         return '';
2114     }
2116     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2117         $output = '<a href="'. $CFG->wwwroot .'/user/index.php?id='. $courseid .'&amp;group='. $group->id .'">';
2118     } else {
2119         $output = '';
2120     }
2121     if ($large) {
2122         $file = 'f1';
2123     } else {
2124         $file = 'f2';
2125     }
2127     $grouppictureurl = moodle_url::make_pluginfile_url($context->id, 'group', 'icon', $group->id, '/', $file);
2128     $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2129         ' alt="'.s(get_string('group').' '.$group->name).'" title="'.s($group->name).'"/>';
2131     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2132         $output .= '</a>';
2133     }
2135     if ($return) {
2136         return $output;
2137     } else {
2138         echo $output;
2139     }
2143 /**
2144  * Display a recent activity note
2145  *
2146  * @uses CONTEXT_SYSTEM
2147  * @staticvar string $strftimerecent
2148  * @param object A time object
2149  * @param object A user object
2150  * @param string $text Text for display for the note
2151  * @param string $link The link to wrap around the text
2152  * @param bool $return If set to true the HTML is returned rather than echo'd
2153  * @param string $viewfullnames
2154  */
2155 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2156     static $strftimerecent = null;
2157     $output = '';
2159     if (is_null($viewfullnames)) {
2160         $context = context_system::instance();
2161         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2162     }
2164     if (is_null($strftimerecent)) {
2165         $strftimerecent = get_string('strftimerecent');
2166     }
2168     $output .= '<div class="head">';
2169     $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2170     $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2171     $output .= '</div>';
2172     $output .= '<div class="info"><a href="'.$link.'">'.format_string($text,true).'</a></div>';
2174     if ($return) {
2175         return $output;
2176     } else {
2177         echo $output;
2178     }
2181 /**
2182  * Returns a popup menu with course activity modules
2183  *
2184  * Given a course
2185  * This function returns a small popup menu with all the
2186  * course activity modules in it, as a navigation menu
2187  * outputs a simple list structure in XHTML
2188  * The data is taken from the serialised array stored in
2189  * the course record
2190  *
2191  * @todo Finish documenting this function
2192  *
2193  * @global object
2194  * @uses CONTEXT_COURSE
2195  * @param course $course A {@link $COURSE} object.
2196  * @param string $sections
2197  * @param string $modinfo
2198  * @param string $strsection
2199  * @param string $strjumpto
2200  * @param int $width
2201  * @param string $cmid
2202  * @return string The HTML block
2203  */
2204 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2206     global $CFG, $OUTPUT;
2208     $section = -1;
2209     $url = '';
2210     $menu = array();
2211     $doneheading = false;
2213     $courseformatoptions = course_get_format($course)->get_format_options();
2214     $coursecontext = context_course::instance($course->id);
2216     $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2217     foreach ($modinfo->cms as $mod) {
2218         if (!$mod->has_view()) {
2219             // Don't show modules which you can't link to!
2220             continue;
2221         }
2223         // For course formats using 'numsections' do not show extra sections
2224         if (isset($courseformatoptions['numsections']) && $mod->sectionnum > $courseformatoptions['numsections']) {
2225             break;
2226         }
2228         if (!$mod->uservisible) { // do not icnlude empty sections at all
2229             continue;
2230         }
2232         if ($mod->sectionnum >= 0 and $section != $mod->sectionnum) {
2233             $thissection = $sections[$mod->sectionnum];
2235             if ($thissection->visible or
2236                     (isset($courseformatoptions['hiddensections']) and !$courseformatoptions['hiddensections']) or
2237                     has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2238                 $thissection->summary = strip_tags(format_string($thissection->summary,true));
2239                 if (!$doneheading) {
2240                     $menu[] = '</ul></li>';
2241                 }
2242                 if ($course->format == 'weeks' or empty($thissection->summary)) {
2243                     $item = $strsection ." ". $mod->sectionnum;
2244                 } else {
2245                     if (textlib::strlen($thissection->summary) < ($width-3)) {
2246                         $item = $thissection->summary;
2247                     } else {
2248                         $item = textlib::substr($thissection->summary, 0, $width).'...';
2249                     }
2250                 }
2251                 $menu[] = '<li class="section"><span>'.$item.'</span>';
2252                 $menu[] = '<ul>';
2253                 $doneheading = true;
2255                 $section = $mod->sectionnum;
2256             } else {
2257                 // no activities from this hidden section shown
2258                 continue;
2259             }
2260         }
2262         $url = $mod->modname .'/view.php?id='. $mod->id;
2263         $mod->name = strip_tags(format_string($mod->name ,true));
2264         if (textlib::strlen($mod->name) > ($width+5)) {
2265             $mod->name = textlib::substr($mod->name, 0, $width).'...';
2266         }
2267         if (!$mod->visible) {
2268             $mod->name = '('.$mod->name.')';
2269         }
2270         $class = 'activity '.$mod->modname;
2271         $class .= ($cmid == $mod->id) ? ' selected' : '';
2272         $menu[] = '<li class="'.$class.'">'.
2273                   '<img src="'.$OUTPUT->pix_url('icon', $mod->modname) . '" alt="" />'.
2274                   '<a href="'.$CFG->wwwroot.'/mod/'.$url.'">'.$mod->name.'</a></li>';
2275     }
2277     if ($doneheading) {
2278         $menu[] = '</ul></li>';
2279     }
2280     $menu[] = '</ul></li></ul>';
2282     return implode("\n", $menu);
2285 /**
2286  * Prints a grade menu (as part of an existing form) with help
2287  * Showing all possible numerical grades and scales
2288  *
2289  * @todo Finish documenting this function
2290  * @todo Deprecate: this is only used in a few contrib modules
2291  *
2292  * @global object
2293  * @param int $courseid The course ID
2294  * @param string $name
2295  * @param string $current
2296  * @param boolean $includenograde Include those with no grades
2297  * @param boolean $return If set to true returns rather than echo's
2298  * @return string|bool Depending on value of $return
2299  */
2300 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2302     global $CFG, $OUTPUT;
2304     $output = '';
2305     $strscale = get_string('scale');
2306     $strscales = get_string('scales');
2308     $scales = get_scales_menu($courseid);
2309     foreach ($scales as $i => $scalename) {
2310         $grades[-$i] = $strscale .': '. $scalename;
2311     }
2312     if ($includenograde) {
2313         $grades[0] = get_string('nograde');
2314     }
2315     for ($i=100; $i>=1; $i--) {
2316         $grades[$i] = $i;
2317     }
2318     $output .= html_writer::select($grades, $name, $current, false);
2320     $linkobject = '<span class="helplink"><img class="iconhelp" alt="'.$strscales.'" src="'.$OUTPUT->pix_url('help') . '" /></span>';
2321     $link = new moodle_url('/course/scales.php', array('id'=>$courseid, 'list'=>1));
2322     $action = new popup_action('click', $link, 'ratingscales', array('height' => 400, 'width' => 500));
2323     $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title'=>$strscales));
2325     if ($return) {
2326         return $output;
2327     } else {
2328         echo $output;
2329     }
2332 /**
2333  * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2334  * Default errorcode is 1.
2335  *
2336  * Very useful for perl-like error-handling:
2337  *
2338  * do_somethting() or mdie("Something went wrong");
2339  *
2340  * @param string  $msg       Error message
2341  * @param integer $errorcode Error code to emit
2342  */
2343 function mdie($msg='', $errorcode=1) {
2344     trigger_error($msg);
2345     exit($errorcode);
2348 /**
2349  * Print a message and exit.
2350  *
2351  * @param string $message The message to print in the notice
2352  * @param string $link The link to use for the continue button
2353  * @param object $course A course object
2354  * @return void This function simply exits
2355  */
2356 function notice ($message, $link='', $course=NULL) {
2357     global $CFG, $SITE, $COURSE, $PAGE, $OUTPUT;
2359     $message = clean_text($message);   // In case nasties are in here
2361     if (CLI_SCRIPT) {
2362         echo("!!$message!!\n");
2363         exit(1); // no success
2364     }
2366     if (!$PAGE->headerprinted) {
2367         //header not yet printed
2368         $PAGE->set_title(get_string('notice'));
2369         echo $OUTPUT->header();
2370     } else {
2371         echo $OUTPUT->container_end_all(false);
2372     }
2374     echo $OUTPUT->box($message, 'generalbox', 'notice');
2375     echo $OUTPUT->continue_button($link);
2377     echo $OUTPUT->footer();
2378     exit(1); // general error code
2381 /**
2382  * Redirects the user to another page, after printing a notice
2383  *
2384  * This function calls the OUTPUT redirect method, echo's the output
2385  * and then dies to ensure nothing else happens.
2386  *
2387  * <strong>Good practice:</strong> You should call this method before starting page
2388  * output by using any of the OUTPUT methods.
2389  *
2390  * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2391  * @param string $message The message to display to the user
2392  * @param int $delay The delay before redirecting
2393  * @return void - does not return!
2394  */
2395 function redirect($url, $message='', $delay=-1) {
2396     global $OUTPUT, $PAGE, $SESSION, $CFG;
2398     if (CLI_SCRIPT or AJAX_SCRIPT) {
2399         // this is wrong - developers should not use redirect in these scripts,
2400         // but it should not be very likely
2401         throw new moodle_exception('redirecterrordetected', 'error');
2402     }
2404     // prevent debug errors - make sure context is properly initialised
2405     if ($PAGE) {
2406         $PAGE->set_context(null);
2407         $PAGE->set_pagelayout('redirect');  // No header and footer needed
2408     }
2410     if ($url instanceof moodle_url) {
2411         $url = $url->out(false);
2412     }
2414     $debugdisableredirect = false;
2415     do {
2416         if (defined('DEBUGGING_PRINTED')) {
2417             // some debugging already printed, no need to look more
2418             $debugdisableredirect = true;
2419             break;
2420         }
2422         if (empty($CFG->debugdisplay) or empty($CFG->debug)) {
2423             // no errors should be displayed
2424             break;
2425         }
2427         if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2428             break;
2429         }
2431         if (!($lasterror['type'] & $CFG->debug)) {
2432             //last error not interesting
2433             break;
2434         }
2436         // watch out here, @hidden() errors are returned from error_get_last() too
2437         if (headers_sent()) {
2438             //we already started printing something - that means errors likely printed
2439             $debugdisableredirect = true;
2440             break;
2441         }
2443         if (ob_get_level() and ob_get_contents()) {
2444             // there is something waiting to be printed, hopefully it is the errors,
2445             // but it might be some error hidden by @ too - such as the timezone mess from setup.php
2446             $debugdisableredirect = true;
2447             break;
2448         }
2449     } while (false);
2451     // Technically, HTTP/1.1 requires Location: header to contain the absolute path.
2452     // (In practice browsers accept relative paths - but still, might as well do it properly.)
2453     // This code turns relative into absolute.
2454     if (!preg_match('|^[a-z]+:|', $url)) {
2455         // Get host name http://www.wherever.com
2456         $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2457         if (preg_match('|^/|', $url)) {
2458             // URLs beginning with / are relative to web server root so we just add them in
2459             $url = $hostpart.$url;
2460         } else {
2461             // URLs not beginning with / are relative to path of current script, so add that on.
2462             $url = $hostpart.preg_replace('|\?.*$|','',me()).'/../'.$url;
2463         }
2464         // Replace all ..s
2465         while (true) {
2466             $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2467             if ($newurl == $url) {
2468                 break;
2469             }
2470             $url = $newurl;
2471         }
2472     }
2474     // Sanitise url - we can not rely on moodle_url or our URL cleaning
2475     // because they do not support all valid external URLs
2476     $url = preg_replace('/[\x00-\x1F\x7F]/', '', $url);
2477     $url = str_replace('"', '%22', $url);
2478     $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2479     $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />', FORMAT_HTML));
2480     $url = str_replace('&amp;', '&', $encodedurl);
2482     if (!empty($message)) {
2483         if ($delay === -1 || !is_numeric($delay)) {
2484             $delay = 3;
2485         }
2486         $message = clean_text($message);
2487     } else {
2488         $message = get_string('pageshouldredirect');
2489         $delay = 0;
2490     }
2492     if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
2493         if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
2494             $perf = get_performance_info();
2495             error_log("PERF: " . $perf['txt']);
2496         }
2497     }
2499     if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2500         // workaround for IIS bug http://support.microsoft.com/kb/q176113/
2501         if (session_id()) {
2502             session_get_instance()->write_close();
2503         }
2505         //302 might not work for POST requests, 303 is ignored by obsolete clients.
2506         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2507         @header('Location: '.$url);
2508         echo bootstrap_renderer::plain_redirect_message($encodedurl);
2509         exit;
2510     }
2512     // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2513     if ($PAGE) {
2514         $CFG->docroot = false; // to prevent the link to moodle docs from being displayed on redirect page.
2515         echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect);
2516         exit;
2517     } else {
2518         echo bootstrap_renderer::early_redirect_message($encodedurl, $message, $delay);
2519         exit;
2520     }
2523 /**
2524  * Given an email address, this function will return an obfuscated version of it
2525  *
2526  * @param string $email The email address to obfuscate
2527  * @return string The obfuscated email address
2528  */
2529  function obfuscate_email($email) {
2531     $i = 0;
2532     $length = strlen($email);
2533     $obfuscated = '';
2534     while ($i < $length) {
2535         if (rand(0,2) && $email{$i}!='@') { //MDL-20619 some browsers have problems unobfuscating @
2536             $obfuscated.='%'.dechex(ord($email{$i}));
2537         } else {
2538             $obfuscated.=$email{$i};
2539         }
2540         $i++;
2541     }
2542     return $obfuscated;
2545 /**
2546  * This function takes some text and replaces about half of the characters
2547  * with HTML entity equivalents.   Return string is obviously longer.
2548  *
2549  * @param string $plaintext The text to be obfuscated
2550  * @return string The obfuscated text
2551  */
2552 function obfuscate_text($plaintext) {
2554     $i=0;
2555     $length = strlen($plaintext);
2556     $obfuscated='';
2557     $prev_obfuscated = false;
2558     while ($i < $length) {
2559         $c = ord($plaintext{$i});
2560         $numerical = ($c >= ord('0')) && ($c <= ord('9'));
2561         if ($prev_obfuscated and $numerical ) {
2562             $obfuscated.='&#'.ord($plaintext{$i}).';';
2563         } else if (rand(0,2)) {
2564             $obfuscated.='&#'.ord($plaintext{$i}).';';
2565             $prev_obfuscated = true;
2566         } else {
2567             $obfuscated.=$plaintext{$i};
2568             $prev_obfuscated = false;
2569         }
2570       $i++;
2571     }
2572     return $obfuscated;
2575 /**
2576  * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2577  * to generate a fully obfuscated email link, ready to use.
2578  *
2579  * @param string $email The email address to display
2580  * @param string $label The text to displayed as hyperlink to $email
2581  * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2582  * @param string $subject The subject of the email in the mailto link
2583  * @param string $body The content of the email in the mailto link
2584  * @return string The obfuscated mailto link
2585  */
2586 function obfuscate_mailto($email, $label='', $dimmed=false, $subject = '', $body = '') {
2588     if (empty($label)) {
2589         $label = $email;
2590     }
2592     $label = obfuscate_text($label);
2593     $email = obfuscate_email($email);
2594     $mailto = obfuscate_text('mailto');
2595     $url = new moodle_url("mailto:$email");
2596     $attrs = array();
2598     if (!empty($subject)) {
2599         $url->param('subject', format_string($subject));
2600     }
2601     if (!empty($body)) {
2602         $url->param('body', format_string($body));
2603     }
2605     // Use the obfuscated mailto
2606     $url = preg_replace('/^mailto/', $mailto, $url->out());
2608     if ($dimmed) {
2609         $attrs['title'] = get_string('emaildisable');
2610         $attrs['class'] = 'dimmed';
2611     }
2613     return html_writer::link($url, $label, $attrs);
2616 /**
2617  * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2618  * will transform it to html entities
2619  *
2620  * @param string $text Text to search for nolink tag in
2621  * @return string
2622  */
2623 function rebuildnolinktag($text) {
2625     $text = preg_replace('/&lt;(\/*nolink)&gt;/i','<$1>',$text);
2627     return $text;
2630 /**
2631  * Prints a maintenance message from $CFG->maintenance_message or default if empty
2632  * @return void
2633  */
2634 function print_maintenance_message() {
2635     global $CFG, $SITE, $PAGE, $OUTPUT;
2637     $PAGE->set_pagetype('maintenance-message');
2638     $PAGE->set_pagelayout('maintenance');
2639     $PAGE->set_title(strip_tags($SITE->fullname));
2640     $PAGE->set_heading($SITE->fullname);
2641     echo $OUTPUT->header();
2642     echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2643     if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
2644         echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2645         echo $CFG->maintenance_message;
2646         echo $OUTPUT->box_end();
2647     }
2648     echo $OUTPUT->footer();
2649     die;
2652 /**
2653  * A class for tabs, Some code to print tabs
2654  *
2655  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2656  * @package moodlecore
2657  */
2658 class tabobject {
2659     /**
2660      * @var string
2661      */
2662     var $id;
2663     var $link;
2664     var $text;
2665     /**
2666      * @var bool
2667      */
2668     var $linkedwhenselected;
2670     /**
2671      * A constructor just because I like constructors
2672      *
2673      * @param string $id
2674      * @param string $link
2675      * @param string $text
2676      * @param string $title
2677      * @param bool $linkedwhenselected
2678      */
2679     function tabobject ($id, $link='', $text='', $title='', $linkedwhenselected=false) {
2680         $this->id   = $id;
2681         $this->link = $link;
2682         $this->text = $text;
2683         $this->title = $title ? $title : $text;
2684         $this->linkedwhenselected = $linkedwhenselected;
2685     }
2690 /**
2691  * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2692  *
2693  * @global object
2694  * @param array $tabrows An array of rows where each row is an array of tab objects
2695  * @param string $selected  The id of the selected tab (whatever row it's on)
2696  * @param array  $inactive  An array of ids of inactive tabs that are not selectable.
2697  * @param array  $activated An array of ids of other tabs that are currently activated
2698  * @param bool $return If true output is returned rather then echo'd
2699  **/
2700 function print_tabs($tabrows, $selected=NULL, $inactive=NULL, $activated=NULL, $return=false) {
2701     global $CFG;
2703 /// $inactive must be an array
2704     if (!is_array($inactive)) {
2705         $inactive = array();
2706     }
2708 /// $activated must be an array
2709     if (!is_array($activated)) {
2710         $activated = array();
2711     }
2713 /// Convert the tab rows into a tree that's easier to process
2714     if (!$tree = convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated)) {
2715         return false;
2716     }
2718 /// Print out the current tree of tabs (this function is recursive)
2720     $output = convert_tree_to_html($tree);
2722     $output = "\n\n".'<div class="tabtree">'.$output.'</div><div class="clearer"> </div>'."\n\n";
2724 /// We're done!
2726     if ($return) {
2727         return $output;
2728     }
2729     echo $output;
2732 /**
2733  * Converts a nested array tree into HTML ul:li [recursive]
2734  *
2735  * @param array $tree A tree array to convert
2736  * @param int $row Used in identifying the iteration level and in ul classes
2737  * @return string HTML structure
2738  */
2739 function convert_tree_to_html($tree, $row=0) {
2741     $str = "\n".'<ul class="tabrow'.$row.'">'."\n";
2743     $first = true;
2744     $count = count($tree);
2746     foreach ($tree as $tab) {
2747         $count--;   // countdown to zero
2749         $liclass = '';
2751         if ($first && ($count == 0)) {   // Just one in the row
2752             $liclass = 'first last';
2753             $first = false;
2754         } else if ($first) {
2755             $liclass = 'first';
2756             $first = false;
2757         } else if ($count == 0) {
2758             $liclass = 'last';
2759         }
2761         if ((empty($tab->subtree)) && (!empty($tab->selected))) {
2762             $liclass .= (empty($liclass)) ? 'onerow' : ' onerow';
2763         }
2765         if ($tab->inactive || $tab->active || $tab->selected) {
2766             if ($tab->selected) {
2767                 $liclass .= (empty($liclass)) ? 'here selected' : ' here selected';
2768             } else if ($tab->active) {
2769                 $liclass .= (empty($liclass)) ? 'here active' : ' here active';
2770             }
2771         }
2773         $str .= (!empty($liclass)) ? '<li class="'.$liclass.'">' : '<li>';
2775         if ($tab->inactive || $tab->active || ($tab->selected && !$tab->linkedwhenselected)) {
2776             // The a tag is used for styling
2777             $str .= '<a class="nolink"><span>'.$tab->text.'</span></a>';
2778         } else {
2779             $str .= '<a href="'.$tab->link.'" title="'.$tab->title.'"><span>'.$tab->text.'</span></a>';
2780         }
2782         if (!empty($tab->subtree)) {
2783             $str .= convert_tree_to_html($tab->subtree, $row+1);
2784         } else if ($tab->selected) {
2785             $str .= '<div class="tabrow'.($row+1).' empty">&nbsp;</div>'."\n";
2786         }
2788         $str .= ' </li>'."\n";
2789     }
2790     $str .= '</ul>'."\n";
2792     return $str;
2795 /**
2796  * Convert nested tabrows to a nested array
2797  *
2798  * @param array $tabrows A [nested] array of tab row objects
2799  * @param string $selected The tabrow to select (by id)
2800  * @param array $inactive An array of tabrow id's to make inactive
2801  * @param array $activated An array of tabrow id's to make active
2802  * @return array The nested array
2803  */
2804 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
2806 /// Work backwards through the rows (bottom to top) collecting the tree as we go.
2808     $tabrows = array_reverse($tabrows);
2810     $subtree = array();
2812     foreach ($tabrows as $row) {
2813         $tree = array();
2815         foreach ($row as $tab) {
2816             $tab->inactive = in_array((string)$tab->id, $inactive);
2817             $tab->active = in_array((string)$tab->id, $activated);
2818             $tab->selected = (string)$tab->id == $selected;
2820             if ($tab->active || $tab->selected) {
2821                 if ($subtree) {
2822                     $tab->subtree = $subtree;
2823                 }
2824             }
2825             $tree[] = $tab;
2826         }
2827         $subtree = $tree;
2828     }
2830     return $subtree;
2833 /**
2834  * Standard Debugging Function
2835  *
2836  * Returns true if the current site debugging settings are equal or above specified level.
2837  * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2838  * routing of notices is controlled by $CFG->debugdisplay
2839  * eg use like this:
2840  *
2841  * 1)  debugging('a normal debug notice');
2842  * 2)  debugging('something really picky', DEBUG_ALL);
2843  * 3)  debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
2844  * 4)  if (debugging()) { perform extra debugging operations (do not use print or echo) }
2845  *
2846  * In code blocks controlled by debugging() (such as example 4)
2847  * any output should be routed via debugging() itself, or the lower-level
2848  * trigger_error() or error_log(). Using echo or print will break XHTML
2849  * JS and HTTP headers.
2850  *
2851  * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2852  *
2853  * @uses DEBUG_NORMAL
2854  * @param string $message a message to print
2855  * @param int $level the level at which this debugging statement should show
2856  * @param array $backtrace use different backtrace
2857  * @return bool
2858  */
2859 function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
2860     global $CFG, $USER;
2862     $forcedebug = false;
2863     if (!empty($CFG->debugusers) && $USER) {
2864         $debugusers = explode(',', $CFG->debugusers);
2865         $forcedebug = in_array($USER->id, $debugusers);
2866     }
2868     if (!$forcedebug and (empty($CFG->debug) || ($CFG->debug != -1 and $CFG->debug < $level))) {
2869         return false;
2870     }
2872     if (!isset($CFG->debugdisplay)) {
2873         $CFG->debugdisplay = ini_get_bool('display_errors');
2874     }
2876     if ($message) {
2877         if (!$backtrace) {
2878             $backtrace = debug_backtrace();
2879         }
2880         $from = format_backtrace($backtrace, CLI_SCRIPT);
2881         if (PHPUNIT_TEST) {
2882             if (phpunit_util::debugging_triggered($message, $level, $from)) {
2883                 // We are inside test, the debug message was logged.
2884                 return true;
2885             }
2886         }
2888         if (NO_DEBUG_DISPLAY) {
2889             // script does not want any errors or debugging in output,
2890             // we send the info to error log instead
2891             error_log('Debugging: ' . $message . $from);
2893         } else if ($forcedebug or $CFG->debugdisplay) {
2894             if (!defined('DEBUGGING_PRINTED')) {
2895                 define('DEBUGGING_PRINTED', 1); // indicates we have printed something
2896             }
2897             if (CLI_SCRIPT) {
2898                 echo "++ $message ++\n$from";
2899             } else {
2900                 echo '<div class="notifytiny">' . $message . $from . '</div>';
2901             }
2903         } else {
2904             trigger_error($message . $from, E_USER_NOTICE);
2905         }
2906     }
2907     return true;
2910 /**
2911 * Outputs a HTML comment to the browser. This is used for those hard-to-debug
2912 * pages that use bits from many different files in very confusing ways (e.g. blocks).
2914 * <code>print_location_comment(__FILE__, __LINE__);</code>
2916 * @param string $file
2917 * @param integer $line
2918 * @param boolean $return Whether to return or print the comment
2919 * @return string|void Void unless true given as third parameter
2920 */
2921 function print_location_comment($file, $line, $return = false)
2923     if ($return) {
2924         return "<!-- $file at line $line -->\n";
2925     } else {
2926         echo "<!-- $file at line $line -->\n";
2927     }
2931 /**
2932  * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
2933  */
2934 function right_to_left() {
2935     return (get_string('thisdirection', 'langconfig') === 'rtl');
2939 /**
2940  * Returns swapped left<=>right if in RTL environment.
2941  * part of RTL support
2942  *
2943  * @param string $align align to check
2944  * @return string
2945  */
2946 function fix_align_rtl($align) {
2947     if (!right_to_left()) {
2948         return $align;
2949     }
2950     if ($align=='left')  { return 'right'; }
2951     if ($align=='right') { return 'left'; }
2952     return $align;
2956 /**
2957  * Returns true if the page is displayed in a popup window.
2958  * Gets the information from the URL parameter inpopup.
2959  *
2960  * @todo Use a central function to create the popup calls all over Moodle and
2961  * In the moment only works with resources and probably questions.
2962  *
2963  * @return boolean
2964  */
2965 function is_in_popup() {
2966     $inpopup = optional_param('inpopup', '', PARAM_BOOL);
2968     return ($inpopup);
2971 /**
2972  * To use this class.
2973  * - construct
2974  * - call create (or use the 3rd param to the constructor)
2975  * - call update or update_full() or update() repeatedly
2976  *
2977  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2978  * @package moodlecore
2979  */
2980 class progress_bar {
2981     /** @var string html id */
2982     private $html_id;
2983     /** @var int total width */
2984     private $width;
2985     /** @var int last percentage printed */
2986     private $percent = 0;
2987     /** @var int time when last printed */
2988     private $lastupdate = 0;
2989     /** @var int when did we start printing this */
2990     private $time_start = 0;
2992     /**
2993      * Constructor
2994      *
2995      * @param string $html_id
2996      * @param int $width
2997      * @param bool $autostart Default to false
2998      * @return void, prints JS code if $autostart true
2999      */
3000     public function __construct($html_id = '', $width = 500, $autostart = false) {
3001         if (!empty($html_id)) {
3002             $this->html_id  = $html_id;
3003         } else {
3004             $this->html_id  = 'pbar_'.uniqid();
3005         }
3007         $this->width = $width;
3009         if ($autostart){
3010             $this->create();
3011         }
3012     }
3014     /**
3015       * Create a new progress bar, this function will output html.
3016       *
3017       * @return void Echo's output
3018       */
3019     public function create() {
3020         $this->time_start = microtime(true);
3021         if (CLI_SCRIPT) {
3022             return; // temporary solution for cli scripts
3023         }
3024         $htmlcode = <<<EOT
3025         <div style="text-align:center;width:{$this->width}px;clear:both;padding:0;margin:0 auto;">
3026             <h2 id="status_{$this->html_id}" style="text-align: center;margin:0 auto"></h2>
3027             <p id="time_{$this->html_id}"></p>
3028             <div id="bar_{$this->html_id}" style="border-style:solid;border-width:1px;width:500px;height:50px;">
3029                 <div id="progress_{$this->html_id}"
3030                 style="text-align:center;background:#FFCC66;width:4px;border:1px
3031                 solid gray;height:38px; padding-top:10px;">&nbsp;<span id="pt_{$this->html_id}"></span>
3032                 </div>
3033             </div>
3034         </div>
3035 EOT;
3036         flush();
3037         echo $htmlcode;
3038         flush();
3039     }
3041     /**
3042      * Update the progress bar
3043      *
3044      * @param int $percent from 1-100
3045      * @param string $msg
3046      * @return void Echo's output
3047      */
3048     private function _update($percent, $msg) {
3049         if (empty($this->time_start)) {
3050             throw new coding_exception('You must call create() (or use the $autostart ' .
3051                     'argument to the constructor) before you try updating the progress bar.');
3052         }
3054         if (CLI_SCRIPT) {
3055             return; // temporary solution for cli scripts
3056         }
3058         $es = $this->estimate($percent);
3060         if ($es === null) {
3061             // always do the first and last updates
3062             $es = "?";
3063         } else if ($es == 0) {
3064             // always do the last updates
3065         } else if ($this->lastupdate + 20 < time()) {
3066             // we must update otherwise browser would time out
3067         } else if (round($this->percent, 2) === round($percent, 2)) {
3068             // no significant change, no need to update anything
3069             return;
3070         }
3072         $this->percent = $percent;
3073         $this->lastupdate = microtime(true);
3075         $w = ($this->percent/100) * $this->width;
3076         echo html_writer::script(js_writer::function_call('update_progress_bar', array($this->html_id, $w, $this->percent, $msg, $es)));
3077         flush();
3078     }
3080     /**
3081       * Estimate how much time it is going to take.
3082       *
3083       * @param int $curtime the time call this function
3084       * @param int $percent from 1-100
3085       * @return mixed Null (unknown), or int
3086       */
3087     private function estimate($pt) {
3088         if ($this->lastupdate == 0) {
3089             return null;
3090         }
3091         if ($pt < 0.00001) {
3092             return null; // we do not know yet how long it will take
3093         }
3094         if ($pt > 99.99999) {
3095             return 0; // nearly done, right?
3096         }
3097         $consumed = microtime(true) - $this->time_start;
3098         if ($consumed < 0.001) {
3099             return null;
3100         }
3102         return (100 - $pt) * ($consumed / $pt);
3103     }
3105     /**
3106       * Update progress bar according percent
3107       *
3108       * @param int $percent from 1-100
3109       * @param string $msg the message needed to be shown
3110       */
3111     public function update_full($percent, $msg) {
3112         $percent = max(min($percent, 100), 0);
3113         $this->_update($percent, $msg);
3114     }
3116     /**
3117       * Update progress bar according the number of tasks
3118       *
3119       * @param int $cur current task number
3120       * @param int $total total task number
3121       * @param string $msg message
3122       */
3123     public function update($cur, $total, $msg) {
3124         $percent = ($cur / $total) * 100;
3125         $this->update_full($percent, $msg);
3126     }
3128     /**
3129      * Restart the progress bar.
3130      */
3131     public function restart() {
3132         $this->percent    = 0;
3133         $this->lastupdate = 0;
3134         $this->time_start = 0;
3135     }
3138 /**
3139  * Use this class from long operations where you want to output occasional information about
3140  * what is going on, but don't know if, or in what format, the output should be.
3141  *
3142  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3143  * @package moodlecore
3144  */
3145 abstract class progress_trace {
3146     /**
3147      * Output an progress message in whatever format.
3148      *
3149      * @param string $message the message to output.
3150      * @param integer $depth indent depth for this message.
3151      */
3152     abstract public function output($message, $depth = 0);
3154     /**
3155      * Called when the processing is finished.
3156      */
3157     public function finished() {
3158     }
3161 /**
3162  * This subclass of progress_trace does not ouput anything.
3163  *
3164  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3165  * @package moodlecore
3166  */
3167 class null_progress_trace extends progress_trace {
3168     /**
3169      * Does Nothing
3170      *
3171      * @param string $message
3172      * @param int $depth
3173      * @return void Does Nothing
3174      */
3175     public function output($message, $depth = 0) {
3176     }
3179 /**
3180  * This subclass of progress_trace outputs to plain text.
3181  *
3182  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3183  * @package moodlecore
3184  */
3185 class text_progress_trace extends progress_trace {
3186     /**
3187      * Output the trace message.
3188      *
3189      * @param string $message
3190      * @param int $depth
3191      * @return void Output is echo'd
3192      */
3193     public function output($message, $depth = 0) {
3194         echo str_repeat('  ', $depth), $message, "\n";
3195         flush();
3196     }
3199 /**
3200  * This subclass of progress_trace outputs as HTML.
3201  *
3202  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3203  * @package moodlecore
3204  */
3205 class html_progress_trace extends progress_trace {
3206     /**
3207      * Output the trace message.
3208      *
3209      * @param string $message
3210      * @param int $depth
3211      * @return void Output is echo'd
3212      */
3213     public function output($message, $depth = 0) {
3214         echo '<p>', str_repeat('&#160;&#160;', $depth), htmlspecialchars($message), "</p>\n";
3215         flush();
3216     }
3219 /**
3220  * HTML List Progress Tree
3221  *
3222  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3223  * @package moodlecore
3224  */
3225 class html_list_progress_trace extends progress_trace {
3226     /** @var int */
3227     protected $currentdepth = -1;
3229     /**
3230      * Echo out the list
3231      *
3232      * @param string $message The message to display
3233      * @param int $depth
3234      * @return void Output is echoed
3235      */
3236     public function output($message, $depth = 0) {
3237         $samedepth = true;
3238         while ($this->currentdepth > $depth) {
3239             echo "</li>\n</ul>\n";
3240             $this->currentdepth -= 1;
3241             if ($this->currentdepth == $depth) {
3242                 echo '<li>';
3243             }
3244             $samedepth = false;
3245         }
3246         while ($this->currentdepth < $depth) {
3247             echo "<ul>\n<li>";
3248             $this->currentdepth += 1;
3249             $samedepth = false;
3250         }
3251         if ($samedepth) {
3252             echo "</li>\n<li>";
3253         }
3254         echo htmlspecialchars($message);
3255         flush();
3256     }
3258     /**
3259      * Called when the processing is finished.
3260      */
3261     public function finished() {
3262         while ($this->currentdepth >= 0) {
3263             echo "</li>\n</ul>\n";
3264             $this->currentdepth -= 1;
3265         }
3266     }
3269 /**
3270  * This subclass of progress_trace outputs to error log.
3271  *
3272  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3273  * @package moodlecore
3274  */
3275 class error_log_progress_trace extends progress_trace {
3276     /** @var string log prefix */
3277     protected $prefix;
3279     /**
3280      * Constructor.
3281      * @param string $prefix optional log prefix
3282      */
3283     public function __construct($prefix = '') {
3284         $this->prefix = $prefix;
3285     }
3287     /**
3288      * Output the trace message.
3289      *
3290      * @param string $message
3291      * @param int $depth
3292      * @return void Output is sent to error log.
3293      */
3294     public function output($message, $depth = 0) {
3295         error_log($this->prefix . str_repeat('  ', $depth) . $message);
3296     }
3299 /**
3300  * Special type of trace that can be used for catching of
3301  * output of other traces.
3302  *
3303  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3304  * @package moodlecore
3305  */
3306 class progress_trace_buffer extends progress_trace {
3307     /** @var progres_trace */
3308     protected $trace;
3309     /** @var bool do we pass output out */
3310     protected $passthrough;
3311     /** @var string output buffer */
3312     protected $buffer;
3314     /**
3315      * Constructor.
3316      *
3317      * @param progress_trace $trace
3318      * @param bool $passthrough true means output and buffer, false means just buffer and no output
3319      */
3320     public function __construct(progress_trace $trace, $passthrough = true) {
3321         $this->trace       = $trace;
3322         $this->passthrough = $passthrough;
3323         $this->buffer      = '';
3324     }
3326     /**
3327      * Output the trace message.
3328      *
3329      * @param string $message the message to output.
3330      * @param int $depth indent depth for this message.
3331      * @return void output stored in buffer
3332      */
3333     public function output($message, $depth = 0) {
3334         ob_start();
3335         $this->trace->output($message, $depth);
3336         $this->buffer .= ob_get_contents();
3337         if ($this->passthrough) {
3338             ob_end_flush();
3339         } else {
3340             ob_end_clean();
3341         }
3342     }
3344     /**
3345      * Called when the processing is finished.
3346      */
3347     public function finished() {
3348         ob_start();
3349         $this->trace->finished();
3350         $this->buffer .= ob_get_contents();
3351         if ($this->passthrough) {
3352             ob_end_flush();
3353         } else {
3354             ob_end_clean();
3355         }
3356     }
3358     /**
3359      * Reset internal text buffer.
3360      */
3361     public function reset_buffer() {
3362         $this->buffer = '';
3363     }
3365     /**
3366      * Return internal text buffer.
3367      * @return string buffered plain text
3368      */
3369     public function get_buffer() {
3370         return $this->buffer;
3371     }
3374 /**
3375  * Special type of trace that can be used for redirecting to multiple
3376  * other traces.
3377  *
3378  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3379  * @package moodlecore
3380  */
3381 class combined_progress_trace extends progress_trace {
3382     protected $traces;
3384     /**
3385      * @param array $traces multiple traces
3386      */
3387     public function __construct(array $traces) {
3388         $this->traces = $traces;
3389     }
3391     /**
3392      * Output an progress message in whatever format.
3393      *
3394      * @param string $message the message to output.
3395      * @param integer $depth indent depth for this message.
3396      */
3397     public function output($message, $depth = 0) {
3398         foreach($this->traces as $trace) {
3399             $trace->output($message, $depth);
3400         }
3401     }
3403     /**
3404      * Called when the processing is finished.
3405      */
3406     public function finished() {
3407         foreach($this->traces as $trace) {
3408             $trace->finished();
3409         }
3410     }
3413 /**
3414  * Returns a localized sentence in the current language summarizing the current password policy
3415  *
3416  * @todo this should be handled by a function/method in the language pack library once we have a support for it
3417  * @uses $CFG
3418  * @return string
3419  */
3420 function print_password_policy() {
3421     global $CFG;
3423     $message = '';
3424     if (!empty($CFG->passwordpolicy)) {
3425         $messages = array();
3426         $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength);
3427         if (!empty($CFG->minpassworddigits)) {
3428             $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits);
3429         }
3430         if (!empty($CFG->minpasswordlower)) {
3431             $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower);
3432         }
3433         if (!empty($CFG->minpasswordupper)) {
3434             $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper);
3435         }
3436         if (!empty($CFG->minpasswordnonalphanum)) {
3437             $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3438         }
3440         $messages = join(', ', $messages); // this is ugly but we do not have anything better yet...
3441         $message = get_string('informpasswordpolicy', 'auth', $messages);
3442     }
3443     return $message;