7d99cedd62c33eef1f7ee1770354c8d0d6ff3c93
[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 = get_context_instance(CONTEXT_USER, $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.
767      *
768      * @param bool $includeslashargument If true, includes slash arguments
769      * @return string Path of URL
770      */
771     public function get_path($includeslashargument = true) {
772         return $this->path . ($includeslashargument ? $this->slashargument : '');
773     }
776 /**
777  * Determine if there is data waiting to be processed from a form
778  *
779  * Used on most forms in Moodle to check for data
780  * Returns the data as an object, if it's found.
781  * This object can be used in foreach loops without
782  * casting because it's cast to (array) automatically
783  *
784  * Checks that submitted POST data exists and returns it as object.
785  *
786  * @uses $_POST
787  * @return mixed false or object
788  */
789 function data_submitted() {
791     if (empty($_POST)) {
792         return false;
793     } else {
794         return (object)fix_utf8($_POST);
795     }
798 /**
799  * Given some normal text this function will break up any
800  * long words to a given size by inserting the given character
801  *
802  * It's multibyte savvy and doesn't change anything inside html tags.
803  *
804  * @param string $string the string to be modified
805  * @param int $maxsize maximum length of the string to be returned
806  * @param string $cutchar the string used to represent word breaks
807  * @return string
808  */
809 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
811 /// First of all, save all the tags inside the text to skip them
812     $tags = array();
813     filter_save_tags($string,$tags);
815 /// Process the string adding the cut when necessary
816     $output = '';
817     $length = textlib::strlen($string);
818     $wordlength = 0;
820     for ($i=0; $i<$length; $i++) {
821         $char = textlib::substr($string, $i, 1);
822         if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
823             $wordlength = 0;
824         } else {
825             $wordlength++;
826             if ($wordlength > $maxsize) {
827                 $output .= $cutchar;
828                 $wordlength = 0;
829             }
830         }
831         $output .= $char;
832     }
834 /// Finally load the tags back again
835     if (!empty($tags)) {
836         $output = str_replace(array_keys($tags), $tags, $output);
837     }
839     return $output;
842 /**
843  * Try and close the current window using JavaScript, either immediately, or after a delay.
844  *
845  * Echo's out the resulting XHTML & javascript
846  *
847  * @global object
848  * @global object
849  * @param integer $delay a delay in seconds before closing the window. Default 0.
850  * @param boolean $reloadopener if true, we will see if this window was a pop-up, and try
851  *      to reload the parent window before this one closes.
852  */
853 function close_window($delay = 0, $reloadopener = false) {
854     global $PAGE, $OUTPUT;
856     if (!$PAGE->headerprinted) {
857         $PAGE->set_title(get_string('closewindow'));
858         echo $OUTPUT->header();
859     } else {
860         $OUTPUT->container_end_all(false);
861     }
863     if ($reloadopener) {
864         // Trigger the reload immediately, even if the reload is after a delay.
865         $PAGE->requires->js_function_call('window.opener.location.reload', array(true));
866     }
867     $OUTPUT->notification(get_string('windowclosing'), 'notifysuccess');
869     $PAGE->requires->js_function_call('close_window', array(new stdClass()), false, $delay);
871     echo $OUTPUT->footer();
872     exit;
875 /**
876  * Returns a string containing a link to the user documentation for the current
877  * page. Also contains an icon by default. Shown to teachers and admin only.
878  *
879  * @global object
880  * @global object
881  * @param string $text The text to be displayed for the link
882  * @param string $iconpath The path to the icon to be displayed
883  * @return string The link to user documentation for this current page
884  */
885 function page_doc_link($text='') {
886     global $CFG, $PAGE, $OUTPUT;
888     if (empty($CFG->docroot) || during_initial_install()) {
889         return '';
890     }
891     if (!has_capability('moodle/site:doclinks', $PAGE->context)) {
892         return '';
893     }
895     $path = $PAGE->docspath;
896     if (!$path) {
897         return '';
898     }
899     return $OUTPUT->doc_link($path, $text);
903 /**
904  * Validates an email to make sure it makes sense.
905  *
906  * @param string $address The email address to validate.
907  * @return boolean
908  */
909 function validate_email($address) {
911     return (preg_match('#^[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
912                  '(\.[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
913                   '@'.
914                   '[-!\#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
915                   '[-!\#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$#',
916                   $address));
919 /**
920  * Extracts file argument either from file parameter or PATH_INFO
921  * Note: $scriptname parameter is not needed anymore
922  *
923  * @global string
924  * @uses $_SERVER
925  * @uses PARAM_PATH
926  * @return string file path (only safe characters)
927  */
928 function get_file_argument() {
929     global $SCRIPT;
931     $relativepath = optional_param('file', FALSE, PARAM_PATH);
933     if ($relativepath !== false and $relativepath !== '') {
934         return $relativepath;
935     }
936     $relativepath = false;
938     // then try extract file from the slasharguments
939     if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
940         // NOTE: ISS tends to convert all file paths to single byte DOS encoding,
941         //       we can not use other methods because they break unicode chars,
942         //       the only way is to use URL rewriting
943         if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
944             // check that PATH_INFO works == must not contain the script name
945             if (strpos($_SERVER['PATH_INFO'], $SCRIPT) === false) {
946                 $relativepath = clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
947             }
948         }
949     } else {
950         // all other apache-like servers depend on PATH_INFO
951         if (isset($_SERVER['PATH_INFO'])) {
952             if (isset($_SERVER['SCRIPT_NAME']) and strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === 0) {
953                 $relativepath = substr($_SERVER['PATH_INFO'], strlen($_SERVER['SCRIPT_NAME']));
954             } else {
955                 $relativepath = $_SERVER['PATH_INFO'];
956             }
957             $relativepath = clean_param($relativepath, PARAM_PATH);
958         }
959     }
962     return $relativepath;
965 /**
966  * Just returns an array of text formats suitable for a popup menu
967  *
968  * @uses FORMAT_MOODLE
969  * @uses FORMAT_HTML
970  * @uses FORMAT_PLAIN
971  * @uses FORMAT_MARKDOWN
972  * @return array
973  */
974 function format_text_menu() {
975     return array (FORMAT_MOODLE => get_string('formattext'),
976                   FORMAT_HTML   => get_string('formathtml'),
977                   FORMAT_PLAIN  => get_string('formatplain'),
978                   FORMAT_MARKDOWN  => get_string('formatmarkdown'));
981 /**
982  * Given text in a variety of format codings, this function returns
983  * the text as safe HTML.
984  *
985  * This function should mainly be used for long strings like posts,
986  * answers, glossary items etc. For short strings @see format_string().
987  *
988  * <pre>
989  * Options:
990  *      trusted     :   If true the string won't be cleaned. Default false required noclean=true.
991  *      noclean     :   If true the string won't be cleaned. Default false required trusted=true.
992  *      nocache     :   If true the strign will not be cached and will be formatted every call. Default false.
993  *      filter      :   If true the string will be run through applicable filters as well. Default true.
994  *      para        :   If true then the returned string will be wrapped in div tags. Default true.
995  *      newlines    :   If true then lines newline breaks will be converted to HTML newline breaks. Default true.
996  *      context     :   The context that will be used for filtering.
997  *      overflowdiv :   If set to true the formatted text will be encased in a div
998  *                      with the class no-overflow before being returned. Default false.
999  *      allowid     :   If true then id attributes will not be removed, even when
1000  *                      using htmlpurifier. Default false.
1001  * </pre>
1002  *
1003  * @todo Finish documenting this function
1004  *
1005  * @staticvar array $croncache
1006  * @param string $text The text to be formatted. This is raw text originally from user input.
1007  * @param int $format Identifier of the text format to be used
1008  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
1009  * @param object/array $options text formatting options
1010  * @param int $courseid_do_not_use deprecated course id, use context option instead
1011  * @return string
1012  */
1013 function format_text($text, $format = FORMAT_MOODLE, $options = NULL, $courseid_do_not_use = NULL) {
1014     global $CFG, $COURSE, $DB, $PAGE;
1015     static $croncache = array();
1017     if ($text === '' || is_null($text)) {
1018         return ''; // no need to do any filters and cleaning
1019     }
1021     $options = (array)$options; // detach object, we can not modify it
1023     if (!isset($options['trusted'])) {
1024         $options['trusted'] = false;
1025     }
1026     if (!isset($options['noclean'])) {
1027         if ($options['trusted'] and trusttext_active()) {
1028             // no cleaning if text trusted and noclean not specified
1029             $options['noclean'] = true;
1030         } else {
1031             $options['noclean'] = false;
1032         }
1033     }
1034     if (!isset($options['nocache'])) {
1035         $options['nocache'] = false;
1036     }
1037     if (!isset($options['filter'])) {
1038         $options['filter'] = true;
1039     }
1040     if (!isset($options['para'])) {
1041         $options['para'] = true;
1042     }
1043     if (!isset($options['newlines'])) {
1044         $options['newlines'] = true;
1045     }
1046     if (!isset($options['overflowdiv'])) {
1047         $options['overflowdiv'] = false;
1048     }
1050     // Calculate best context
1051     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
1052         // do not filter anything during installation or before upgrade completes
1053         $context = null;
1055     } else if (isset($options['context'])) { // first by explicit passed context option
1056         if (is_object($options['context'])) {
1057             $context = $options['context'];
1058         } else {
1059             $context = get_context_instance_by_id($options['context']);
1060         }
1061     } else if ($courseid_do_not_use) {
1062         // legacy courseid
1063         $context = get_context_instance(CONTEXT_COURSE, $courseid_do_not_use);
1064     } else {
1065         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1066         $context = $PAGE->context;
1067     }
1069     if (!$context) {
1070         // either install/upgrade or something has gone really wrong because context does not exist (yet?)
1071         $options['nocache'] = true;
1072         $options['filter']  = false;
1073     }
1075     if ($options['filter']) {
1076         $filtermanager = filter_manager::instance();
1077     } else {
1078         $filtermanager = new null_filter_manager();
1079     }
1081     if (!empty($CFG->cachetext) and empty($options['nocache'])) {
1082         $hashstr = $text.'-'.$filtermanager->text_filtering_hash($context).'-'.$context->id.'-'.current_language().'-'.
1083                 (int)$format.(int)$options['trusted'].(int)$options['noclean'].
1084                 (int)$options['para'].(int)$options['newlines'];
1086         $time = time() - $CFG->cachetext;
1087         $md5key = md5($hashstr);
1088         if (CLI_SCRIPT) {
1089             if (isset($croncache[$md5key])) {
1090                 return $croncache[$md5key];
1091             }
1092         }
1094         if ($oldcacheitem = $DB->get_record('cache_text', array('md5key'=>$md5key), '*', IGNORE_MULTIPLE)) {
1095             if ($oldcacheitem->timemodified >= $time) {
1096                 if (CLI_SCRIPT) {
1097                     if (count($croncache) > 150) {
1098                         reset($croncache);
1099                         $key = key($croncache);
1100                         unset($croncache[$key]);
1101                     }
1102                     $croncache[$md5key] = $oldcacheitem->formattedtext;
1103                 }
1104                 return $oldcacheitem->formattedtext;
1105             }
1106         }
1107     }
1109     switch ($format) {
1110         case FORMAT_HTML:
1111             if (!$options['noclean']) {
1112                 $text = clean_text($text, FORMAT_HTML, $options);
1113             }
1114             $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_HTML, 'noclean' => $options['noclean']));
1115             break;
1117         case FORMAT_PLAIN:
1118             $text = s($text); // cleans dangerous JS
1119             $text = rebuildnolinktag($text);
1120             $text = str_replace('  ', '&nbsp; ', $text);
1121             $text = nl2br($text);
1122             break;
1124         case FORMAT_WIKI:
1125             // this format is deprecated
1126             $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle.  You should not be seeing
1127                      this message as all texts should have been converted to Markdown format instead.
1128                      Please post a bug report to http://moodle.org/bugs with information about where you
1129                      saw this message.</p>'.s($text);
1130             break;
1132         case FORMAT_MARKDOWN:
1133             $text = markdown_to_html($text);
1134             if (!$options['noclean']) {
1135                 $text = clean_text($text, FORMAT_HTML, $options);
1136             }
1137             $text = $filtermanager->filter_text($text, $context, array('originalformat' => FORMAT_MARKDOWN, 'noclean' => $options['noclean']));
1138             break;
1140         default:  // FORMAT_MOODLE or anything else
1141             $text = text_to_html($text, null, $options['para'], $options['newlines']);
1142             if (!$options['noclean']) {
1143                 $text = clean_text($text, FORMAT_HTML, $options);
1144             }
1145             $text = $filtermanager->filter_text($text, $context, array('originalformat' => $format, 'noclean' => $options['noclean']));
1146             break;
1147     }
1148     if ($options['filter']) {
1149         // at this point there should not be any draftfile links any more,
1150         // this happens when developers forget to post process the text.
1151         // The only potential problem is that somebody might try to format
1152         // the text before storing into database which would be itself big bug.
1153         $text = str_replace("\"$CFG->httpswwwroot/draftfile.php", "\"$CFG->httpswwwroot/brokenfile.php#", $text);
1154     }
1156     // Warn people that we have removed this old mechanism, just in case they
1157     // were stupid enough to rely on it.
1158     if (isset($CFG->currenttextiscacheable)) {
1159         debugging('Once upon a time, Moodle had a truly evil use of global variables ' .
1160                 'called $CFG->currenttextiscacheable. The good news is that this no ' .
1161                 'longer exists. The bad news is that you seem to be using a filter that '.
1162                 'relies on it. Please seek out and destroy that filter code.', DEBUG_DEVELOPER);
1163     }
1165     if (!empty($options['overflowdiv'])) {
1166         $text = html_writer::tag('div', $text, array('class'=>'no-overflow'));
1167     }
1169     if (empty($options['nocache']) and !empty($CFG->cachetext)) {
1170         if (CLI_SCRIPT) {
1171             // special static cron cache - no need to store it in db if its not already there
1172             if (count($croncache) > 150) {
1173                 reset($croncache);
1174                 $key = key($croncache);
1175                 unset($croncache[$key]);
1176             }
1177             $croncache[$md5key] = $text;
1178             return $text;
1179         }
1181         $newcacheitem = new stdClass();
1182         $newcacheitem->md5key = $md5key;
1183         $newcacheitem->formattedtext = $text;
1184         $newcacheitem->timemodified = time();
1185         if ($oldcacheitem) {                               // See bug 4677 for discussion
1186             $newcacheitem->id = $oldcacheitem->id;
1187             try {
1188                 $DB->update_record('cache_text', $newcacheitem);   // Update existing record in the cache table
1189             } catch (dml_exception $e) {
1190                // It's unlikely that the cron cache cleaner could have
1191                // deleted this entry in the meantime, as it allows
1192                // some extra time to cover these cases.
1193             }
1194         } else {
1195             try {
1196                 $DB->insert_record('cache_text', $newcacheitem);   // Insert a new record in the cache table
1197             } catch (dml_exception $e) {
1198                // Again, it's possible that another user has caused this
1199                // record to be created already in the time that it took
1200                // to traverse this function.  That's OK too, as the
1201                // call above handles duplicate entries, and eventually
1202                // the cron cleaner will delete them.
1203             }
1204         }
1205     }
1207     return $text;
1210 /**
1211  * Resets all data related to filters, called during upgrade or when filter settings change.
1212  *
1213  * @global object
1214  * @global object
1215  * @return void
1216  */
1217 function reset_text_filters_cache() {
1218     global $CFG, $DB;
1220     $DB->delete_records('cache_text');
1221     $purifdir = $CFG->cachedir.'/htmlpurifier';
1222     remove_dir($purifdir, true);
1225 /**
1226  * Given a simple string, this function returns the string
1227  * processed by enabled string filters if $CFG->filterall is enabled
1228  *
1229  * This function should be used to print short strings (non html) that
1230  * need filter processing e.g. activity titles, post subjects,
1231  * glossary concepts.
1232  *
1233  * @staticvar bool $strcache
1234  * @param string $string The string to be filtered. Should be plain text, expect
1235  * possibly for multilang tags.
1236  * @param boolean $striplinks To strip any link in the result text.
1237                               Moodle 1.8 default changed from false to true! MDL-8713
1238  * @param array $options options array/object or courseid
1239  * @return string
1240  */
1241 function format_string($string, $striplinks = true, $options = NULL) {
1242     global $CFG, $COURSE, $PAGE;
1244     //We'll use a in-memory cache here to speed up repeated strings
1245     static $strcache = false;
1247     if (empty($CFG->version) or $CFG->version < 2010072800 or during_initial_install()) {
1248         // do not filter anything during installation or before upgrade completes
1249         return $string = strip_tags($string);
1250     }
1252     if ($strcache === false or count($strcache) > 2000) { // this number might need some tuning to limit memory usage in cron
1253         $strcache = array();
1254     }
1256     if (is_numeric($options)) {
1257         // legacy courseid usage
1258         $options  = array('context'=>get_context_instance(CONTEXT_COURSE, $options));
1259     } else {
1260         $options = (array)$options; // detach object, we can not modify it
1261     }
1263     if (empty($options['context'])) {
1264         // fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(
1265         $options['context'] = $PAGE->context;
1266     } else if (is_numeric($options['context'])) {
1267         $options['context'] = get_context_instance_by_id($options['context']);
1268     }
1270     if (!$options['context']) {
1271         // we did not find any context? weird
1272         return $string = strip_tags($string);
1273     }
1275     //Calculate md5
1276     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id.'<+>'.current_language());
1278     //Fetch from cache if possible
1279     if (isset($strcache[$md5])) {
1280         return $strcache[$md5];
1281     }
1283     // First replace all ampersands not followed by html entity code
1284     // Regular expression moved to its own method for easier unit testing
1285     $string = replace_ampersands_not_followed_by_entity($string);
1287     if (!empty($CFG->filterall)) {
1288         $string = filter_manager::instance()->filter_string($string, $options['context']);
1289     }
1291     // If the site requires it, strip ALL tags from this string
1292     if (!empty($CFG->formatstringstriptags)) {
1293         $string = str_replace(array('<', '>'), array('&lt;', '&gt;'), strip_tags($string));
1295     } else {
1296         // Otherwise strip just links if that is required (default)
1297         if ($striplinks) {  //strip links in string
1298             $string = strip_links($string);
1299         }
1300         $string = clean_text($string);
1301     }
1303     //Store to cache
1304     $strcache[$md5] = $string;
1306     return $string;
1309 /**
1310  * Given a string, performs a negative lookahead looking for any ampersand character
1311  * that is not followed by a proper HTML entity. If any is found, it is replaced
1312  * by &amp;. The string is then returned.
1313  *
1314  * @param string $string
1315  * @return string
1316  */
1317 function replace_ampersands_not_followed_by_entity($string) {
1318     return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1321 /**
1322  * Given a string, replaces all <a>.*</a> by .* and returns the string.
1323  *
1324  * @param string $string
1325  * @return string
1326  */
1327 function strip_links($string) {
1328     return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is','$2',$string);
1331 /**
1332  * This expression turns links into something nice in a text format. (Russell Jungwirth)
1333  *
1334  * @param string $string
1335  * @return string
1336  */
1337 function wikify_links($string) {
1338     return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i','$3 [ $2 ]', $string);
1341 /**
1342  * Given text in a variety of format codings, this function returns
1343  * the text as plain text suitable for plain email.
1344  *
1345  * @uses FORMAT_MOODLE
1346  * @uses FORMAT_HTML
1347  * @uses FORMAT_PLAIN
1348  * @uses FORMAT_WIKI
1349  * @uses FORMAT_MARKDOWN
1350  * @param string $text The text to be formatted. This is raw text originally from user input.
1351  * @param int $format Identifier of the text format to be used
1352  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1353  * @return string
1354  */
1355 function format_text_email($text, $format) {
1357     switch ($format) {
1359         case FORMAT_PLAIN:
1360             return $text;
1361             break;
1363         case FORMAT_WIKI:
1364             // there should not be any of these any more!
1365             $text = wikify_links($text);
1366             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1367             break;
1369         case FORMAT_HTML:
1370             return html_to_text($text);
1371             break;
1373         case FORMAT_MOODLE:
1374         case FORMAT_MARKDOWN:
1375         default:
1376             $text = wikify_links($text);
1377             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1378             break;
1379     }
1382 /**
1383  * Formats activity intro text
1384  *
1385  * @global object
1386  * @uses CONTEXT_MODULE
1387  * @param string $module name of module
1388  * @param object $activity instance of activity
1389  * @param int $cmid course module id
1390  * @param bool $filter filter resulting html text
1391  * @return text
1392  */
1393 function format_module_intro($module, $activity, $cmid, $filter=true) {
1394     global $CFG;
1395     require_once("$CFG->libdir/filelib.php");
1396     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1397     $options = array('noclean'=>true, 'para'=>false, 'filter'=>$filter, 'context'=>$context, 'overflowdiv'=>true);
1398     $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, 'mod_'.$module, 'intro', null);
1399     return trim(format_text($intro, $activity->introformat, $options, null));
1402 /**
1403  * Legacy function, used for cleaning of old forum and glossary text only.
1404  *
1405  * @global object
1406  * @param string $text text that may contain legacy TRUSTTEXT marker
1407  * @return text without legacy TRUSTTEXT marker
1408  */
1409 function trusttext_strip($text) {
1410     while (true) { //removing nested TRUSTTEXT
1411         $orig = $text;
1412         $text = str_replace('#####TRUSTTEXT#####', '', $text);
1413         if (strcmp($orig, $text) === 0) {
1414             return $text;
1415         }
1416     }
1419 /**
1420  * Must be called before editing of all texts
1421  * with trust flag. Removes all XSS nasties
1422  * from texts stored in database if needed.
1423  *
1424  * @param object $object data object with xxx, xxxformat and xxxtrust fields
1425  * @param string $field name of text field
1426  * @param object $context active context
1427  * @return object updated $object
1428  */
1429 function trusttext_pre_edit($object, $field, $context) {
1430     $trustfield  = $field.'trust';
1431     $formatfield = $field.'format';
1433     if (!$object->$trustfield or !trusttext_trusted($context)) {
1434         $object->$field = clean_text($object->$field, $object->$formatfield);
1435     }
1437     return $object;
1440 /**
1441  * Is current user trusted to enter no dangerous XSS in this context?
1442  *
1443  * Please note the user must be in fact trusted everywhere on this server!!
1444  *
1445  * @param object $context
1446  * @return bool true if user trusted
1447  */
1448 function trusttext_trusted($context) {
1449     return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1452 /**
1453  * Is trusttext feature active?
1454  *
1455  * @return bool
1456  */
1457 function trusttext_active() {
1458     global $CFG;
1460     return !empty($CFG->enabletrusttext);
1463 /**
1464  * Given raw text (eg typed in by a user), this function cleans it up
1465  * and removes any nasty tags that could mess up Moodle pages through XSS attacks.
1466  *
1467  * The result must be used as a HTML text fragment, this function can not cleanup random
1468  * parts of html tags such as url or src attributes.
1469  *
1470  * NOTE: the format parameter was deprecated because we can safely clean only HTML.
1471  *
1472  * @param string $text The text to be cleaned
1473  * @param int|string $format deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
1474  * @param array $options Array of options; currently only option supported is 'allowid' (if true,
1475  *   does not remove id attributes when cleaning)
1476  * @return string The cleaned up text
1477  */
1478 function clean_text($text, $format = FORMAT_HTML, $options = array()) {
1479     $text = (string)$text;
1481     if ($format != FORMAT_HTML and $format != FORMAT_HTML) {
1482         // TODO: we need to standardise cleanup of text when loading it into editor first
1483         //debugging('clean_text() is designed to work only with html');
1484     }
1486     if ($format == FORMAT_PLAIN) {
1487         return $text;
1488     }
1490     if (is_purify_html_necessary($text)) {
1491         $text = purify_html($text, $options);
1492     }
1494     // Originally we tried to neutralise some script events here, it was a wrong approach because
1495     // it was trivial to work around that (for example using style based XSS exploits).
1496     // We must not give false sense of security here - all developers MUST understand how to use
1497     // rawurlencode(), htmlentities(), htmlspecialchars(), p(), s(), moodle_url, html_writer and friends!!!
1499     return $text;
1502 /**
1503  * Is it necessary to use HTMLPurifier?
1504  * @private
1505  * @param string $text
1506  * @return bool false means html is safe and valid, true means use HTMLPurifier
1507  */
1508 function is_purify_html_necessary($text) {
1509     if ($text === '') {
1510         return false;
1511     }
1513     if ($text === (string)((int)$text)) {
1514         return false;
1515     }
1517     if (strpos($text, '&') !== false or preg_match('|<[^pesb/]|', $text)) {
1518         // we need to normalise entities or other tags except p, em, strong and br present
1519         return true;
1520     }
1522     $altered = htmlspecialchars($text, ENT_NOQUOTES, 'UTF-8', true);
1523     if ($altered === $text) {
1524         // no < > or other special chars means this must be safe
1525         return false;
1526     }
1528     // let's try to convert back some safe html tags
1529     $altered = preg_replace('|&lt;p&gt;(.*?)&lt;/p&gt;|m', '<p>$1</p>', $altered);
1530     if ($altered === $text) {
1531         return false;
1532     }
1533     $altered = preg_replace('|&lt;em&gt;([^<>]+?)&lt;/em&gt;|m', '<em>$1</em>', $altered);
1534     if ($altered === $text) {
1535         return false;
1536     }
1537     $altered = preg_replace('|&lt;strong&gt;([^<>]+?)&lt;/strong&gt;|m', '<strong>$1</strong>', $altered);
1538     if ($altered === $text) {
1539         return false;
1540     }
1541     $altered = str_replace('&lt;br /&gt;', '<br />', $altered);
1542     if ($altered === $text) {
1543         return false;
1544     }
1546     return true;
1549 /**
1550  * KSES replacement cleaning function - uses HTML Purifier.
1551  *
1552  * @param string $text The (X)HTML string to purify
1553  * @param array $options Array of options; currently only option supported is 'allowid' (if set,
1554  *   does not remove id attributes when cleaning)
1555  * @return string
1556  */
1557 function purify_html($text, $options = array()) {
1558     global $CFG;
1560     $type = !empty($options['allowid']) ? 'allowid' : 'normal';
1561     static $purifiers = array();
1562     if (empty($purifiers[$type])) {
1564         // make sure the serializer dir exists, it should be fine if it disappears later during cache reset
1565         $cachedir = $CFG->cachedir.'/htmlpurifier';
1566         check_dir_exists($cachedir);
1568         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1569         require_once $CFG->libdir.'/htmlpurifier/locallib.php';
1570         $config = HTMLPurifier_Config::createDefault();
1572         $config->set('HTML.DefinitionID', 'moodlehtml');
1573         $config->set('HTML.DefinitionRev', 2);
1574         $config->set('Cache.SerializerPath', $cachedir);
1575         $config->set('Cache.SerializerPermissions', $CFG->directorypermissions);
1576         $config->set('Core.NormalizeNewlines', false);
1577         $config->set('Core.ConvertDocumentToFragment', true);
1578         $config->set('Core.Encoding', 'UTF-8');
1579         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1580         $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));
1581         $config->set('Attr.AllowedFrameTargets', array('_blank'));
1583         if (!empty($CFG->allowobjectembed)) {
1584             $config->set('HTML.SafeObject', true);
1585             $config->set('Output.FlashCompat', true);
1586             $config->set('HTML.SafeEmbed', true);
1587         }
1589         if ($type === 'allowid') {
1590             $config->set('Attr.EnableID', true);
1591         }
1593         if ($def = $config->maybeGetRawHTMLDefinition()) {
1594             $def->addElement('nolink', 'Block', 'Flow', array());                       // skip our filters inside
1595             $def->addElement('tex', 'Inline', 'Inline', array());                       // tex syntax, equivalent to $$xx$$
1596             $def->addElement('algebra', 'Inline', 'Inline', array());                   // algebra syntax, equivalent to @@xx@@
1597             $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // old and future style multilang - only our hacked lang attribute
1598             $def->addAttribute('span', 'xxxlang', 'CDATA');                             // current problematic multilang
1599         }
1601         $purifier = new HTMLPurifier($config);
1602         $purifiers[$type] = $purifier;
1603     } else {
1604         $purifier = $purifiers[$type];
1605     }
1607     $multilang = (strpos($text, 'class="multilang"') !== false);
1609     if ($multilang) {
1610         $text = preg_replace('/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/', '<span xxxlang="${2}">', $text);
1611     }
1612     $text = $purifier->purify($text);
1613     if ($multilang) {
1614         $text = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $text);
1615     }
1617     return $text;
1620 /**
1621  * Given plain text, makes it into HTML as nicely as possible.
1622  * May contain HTML tags already
1623  *
1624  * Do not abuse this function. It is intended as lower level formatting feature used
1625  * by {@see format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
1626  * to call format_text() in most of cases.
1627  *
1628  * @param string $text The string to convert.
1629  * @param boolean $smiley_ignored Was used to determine if smiley characters should convert to smiley images, ignored now
1630  * @param boolean $para If true then the returned string will be wrapped in div tags
1631  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1632  * @return string
1633  */
1634 function text_to_html($text, $smiley_ignored=null, $para=true, $newlines=true) {
1635 /// Remove any whitespace that may be between HTML tags
1636     $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1638 /// Remove any returns that precede or follow HTML tags
1639     $text = preg_replace("~([\n\r])<~i", " <", $text);
1640     $text = preg_replace("~>([\n\r])~i", "> ", $text);
1642 /// Make returns into HTML newlines.
1643     if ($newlines) {
1644         $text = nl2br($text);
1645     }
1647 /// Wrap the whole thing in a div if required
1648     if ($para) {
1649         //return '<p>'.$text.'</p>'; //1.9 version
1650         return '<div class="text_to_html">'.$text.'</div>';
1651     } else {
1652         return $text;
1653     }
1656 /**
1657  * Given Markdown formatted text, make it into XHTML using external function
1658  *
1659  * @global object
1660  * @param string $text The markdown formatted text to be converted.
1661  * @return string Converted text
1662  */
1663 function markdown_to_html($text) {
1664     global $CFG;
1666     if ($text === '' or $text === NULL) {
1667         return $text;
1668     }
1670     require_once($CFG->libdir .'/markdown.php');
1672     return Markdown($text);
1675 /**
1676  * Given HTML text, make it into plain text using external function
1677  *
1678  * @param string $html The text to be converted.
1679  * @param integer $width Width to wrap the text at. (optional, default 75 which
1680  *      is a good value for email. 0 means do not limit line length.)
1681  * @param boolean $dolinks By default, any links in the HTML are collected, and
1682  *      printed as a list at the end of the HTML. If you don't want that, set this
1683  *      argument to false.
1684  * @return string plain text equivalent of the HTML.
1685  */
1686 function html_to_text($html, $width = 75, $dolinks = true) {
1688     global $CFG;
1690     require_once($CFG->libdir .'/html2text.php');
1692     $h2t = new html2text($html, false, $dolinks, $width);
1693     $result = $h2t->get_text();
1695     return $result;
1698 /**
1699  * This function will highlight search words in a given string
1700  *
1701  * It cares about HTML and will not ruin links.  It's best to use
1702  * this function after performing any conversions to HTML.
1703  *
1704  * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1705  * @param string $haystack The string (HTML) within which to highlight the search terms.
1706  * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1707  * @param string $prefix the string to put before each search term found.
1708  * @param string $suffix the string to put after each search term found.
1709  * @return string The highlighted HTML.
1710  */
1711 function highlight($needle, $haystack, $matchcase = false,
1712         $prefix = '<span class="highlight">', $suffix = '</span>') {
1714 /// Quick bail-out in trivial cases.
1715     if (empty($needle) or empty($haystack)) {
1716         return $haystack;
1717     }
1719 /// Break up the search term into words, discard any -words and build a regexp.
1720     $words = preg_split('/ +/', trim($needle));
1721     foreach ($words as $index => $word) {
1722         if (strpos($word, '-') === 0) {
1723             unset($words[$index]);
1724         } else if (strpos($word, '+') === 0) {
1725             $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
1726         } else {
1727             $words[$index] = preg_quote($word, '/');
1728         }
1729     }
1730     $regexp = '/(' . implode('|', $words) . ')/u'; // u is do UTF-8 matching.
1731     if (!$matchcase) {
1732         $regexp .= 'i';
1733     }
1735 /// Another chance to bail-out if $search was only -words
1736     if (empty($words)) {
1737         return $haystack;
1738     }
1740 /// Find all the HTML tags in the input, and store them in a placeholders array.
1741     $placeholders = array();
1742     $matches = array();
1743     preg_match_all('/<[^>]*>/', $haystack, $matches);
1744     foreach (array_unique($matches[0]) as $key => $htmltag) {
1745         $placeholders['<|' . $key . '|>'] = $htmltag;
1746     }
1748 /// In $hastack, replace each HTML tag with the corresponding placeholder.
1749     $haystack = str_replace($placeholders, array_keys($placeholders), $haystack);
1751 /// In the resulting string, Do the highlighting.
1752     $haystack = preg_replace($regexp, $prefix . '$1' . $suffix, $haystack);
1754 /// Turn the placeholders back into HTML tags.
1755     $haystack = str_replace(array_keys($placeholders), $placeholders, $haystack);
1757     return $haystack;
1760 /**
1761  * This function will highlight instances of $needle in $haystack
1762  *
1763  * It's faster that the above function {@link highlight()} and doesn't care about
1764  * HTML or anything.
1765  *
1766  * @param string $needle The string to search for
1767  * @param string $haystack The string to search for $needle in
1768  * @return string The highlighted HTML
1769  */
1770 function highlightfast($needle, $haystack) {
1772     if (empty($needle) or empty($haystack)) {
1773         return $haystack;
1774     }
1776     $parts = explode(textlib::strtolower($needle), textlib::strtolower($haystack));
1778     if (count($parts) === 1) {
1779         return $haystack;
1780     }
1782     $pos = 0;
1784     foreach ($parts as $key => $part) {
1785         $parts[$key] = substr($haystack, $pos, strlen($part));
1786         $pos += strlen($part);
1788         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
1789         $pos += strlen($needle);
1790     }
1792     return str_replace('<span class="highlight"></span>', '', join('', $parts));
1795 /**
1796  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
1797  * Internationalisation, for print_header and backup/restorelib.
1798  *
1799  * @param bool $dir Default false
1800  * @return string Attributes
1801  */
1802 function get_html_lang($dir = false) {
1803     $direction = '';
1804     if ($dir) {
1805         if (right_to_left()) {
1806             $direction = ' dir="rtl"';
1807         } else {
1808             $direction = ' dir="ltr"';
1809         }
1810     }
1811     //Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
1812     $language = str_replace('_', '-', current_language());
1813     @header('Content-Language: '.$language);
1814     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
1818 /// STANDARD WEB PAGE PARTS ///////////////////////////////////////////////////
1820 /**
1821  * Send the HTTP headers that Moodle requires.
1822  * @param $cacheable Can this page be cached on back?
1823  */
1824 function send_headers($contenttype, $cacheable = true) {
1825     global $CFG;
1827     @header('Content-Type: ' . $contenttype);
1828     @header('Content-Script-Type: text/javascript');
1829     @header('Content-Style-Type: text/css');
1831     if ($cacheable) {
1832         // Allow caching on "back" (but not on normal clicks)
1833         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0');
1834         @header('Pragma: no-cache');
1835         @header('Expires: ');
1836     } else {
1837         // Do everything we can to always prevent clients and proxies caching
1838         @header('Cache-Control: no-store, no-cache, must-revalidate');
1839         @header('Cache-Control: post-check=0, pre-check=0', false);
1840         @header('Pragma: no-cache');
1841         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1842         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1843     }
1844     @header('Accept-Ranges: none');
1846     if (empty($CFG->allowframembedding)) {
1847         @header('X-Frame-Options: sameorigin');
1848     }
1851 /**
1852  * Return the right arrow with text ('next'), and optionally embedded in a link.
1853  *
1854  * @global object
1855  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1856  * @param string $url An optional link to use in a surrounding HTML anchor.
1857  * @param bool $accesshide True if text should be hidden (for screen readers only).
1858  * @param string $addclass Additional class names for the link, or the arrow character.
1859  * @return string HTML string.
1860  */
1861 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
1862     global $OUTPUT; //TODO: move to output renderer
1863     $arrowclass = 'arrow ';
1864     if (! $url) {
1865         $arrowclass .= $addclass;
1866     }
1867     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
1868     $htmltext = '';
1869     if ($text) {
1870         $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
1871         if ($accesshide) {
1872             $htmltext = get_accesshide($htmltext);
1873         }
1874     }
1875     if ($url) {
1876         $class = 'arrow_link';
1877         if ($addclass) {
1878             $class .= ' '.$addclass;
1879         }
1880         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$htmltext.$arrow.'</a>';
1881     }
1882     return $htmltext.$arrow;
1885 /**
1886  * Return the left arrow with text ('previous'), and optionally embedded in a link.
1887  *
1888  * @global object
1889  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
1890  * @param string $url An optional link to use in a surrounding HTML anchor.
1891  * @param bool $accesshide True if text should be hidden (for screen readers only).
1892  * @param string $addclass Additional class names for the link, or the arrow character.
1893  * @return string HTML string.
1894  */
1895 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
1896     global $OUTPUT; // TODO: move to utput renderer
1897     $arrowclass = 'arrow ';
1898     if (! $url) {
1899         $arrowclass .= $addclass;
1900     }
1901     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
1902     $htmltext = '';
1903     if ($text) {
1904         $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
1905         if ($accesshide) {
1906             $htmltext = get_accesshide($htmltext);
1907         }
1908     }
1909     if ($url) {
1910         $class = 'arrow_link';
1911         if ($addclass) {
1912             $class .= ' '.$addclass;
1913         }
1914         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$arrow.$htmltext.'</a>';
1915     }
1916     return $arrow.$htmltext;
1919 /**
1920  * Return a HTML element with the class "accesshide", for accessibility.
1921  * Please use cautiously - where possible, text should be visible!
1922  *
1923  * @param string $text Plain text.
1924  * @param string $elem Lowercase element name, default "span".
1925  * @param string $class Additional classes for the element.
1926  * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
1927  * @return string HTML string.
1928  */
1929 function get_accesshide($text, $elem='span', $class='', $attrs='') {
1930     return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
1933 /**
1934  * Return the breadcrumb trail navigation separator.
1935  *
1936  * @return string HTML string.
1937  */
1938 function get_separator() {
1939     //Accessibility: the 'hidden' slash is preferred for screen readers.
1940     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
1943 /**
1944  * Print (or return) a collapsible region, that has a caption that can
1945  * be clicked to expand or collapse the region.
1946  *
1947  * If JavaScript is off, then the region will always be expanded.
1948  *
1949  * @param string $contents the contents of the box.
1950  * @param string $classes class names added to the div that is output.
1951  * @param string $id id added to the div that is output. Must not be blank.
1952  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
1953  * @param string $userpref the name of the user preference that stores the user's preferred default state.
1954  *      (May be blank if you do not wish the state to be persisted.
1955  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
1956  * @param boolean $return if true, return the HTML as a string, rather than printing it.
1957  * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
1958  */
1959 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
1960     $output  = print_collapsible_region_start($classes, $id, $caption, $userpref, $default, true);
1961     $output .= $contents;
1962     $output .= print_collapsible_region_end(true);
1964     if ($return) {
1965         return $output;
1966     } else {
1967         echo $output;
1968     }
1971 /**
1972  * Print (or return) the start of a collapsible region, that has a caption that can
1973  * be clicked to expand or collapse the region. If JavaScript is off, then the region
1974  * will always be expanded.
1975  *
1976  * @param string $classes class names added to the div that is output.
1977  * @param string $id id added to the div that is output. Must not be blank.
1978  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
1979  * @param string $userpref the name of the user preference that stores the user's preferred default state.
1980  *      (May be blank if you do not wish the state to be persisted.
1981  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
1982  * @param boolean $return if true, return the HTML as a string, rather than printing it.
1983  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
1984  */
1985 function print_collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false, $return = false) {
1986     global $CFG, $PAGE, $OUTPUT;
1988     // Work out the initial state.
1989     if (!empty($userpref) and is_string($userpref)) {
1990         user_preference_allow_ajax_update($userpref, PARAM_BOOL);
1991         $collapsed = get_user_preferences($userpref, $default);
1992     } else {
1993         $collapsed = $default;
1994         $userpref = false;
1995     }
1997     if ($collapsed) {
1998         $classes .= ' collapsed';
1999     }
2001     $output = '';
2002     $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2003     $output .= '<div id="' . $id . '_sizer">';
2004     $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2005     $output .= $caption . ' ';
2006     $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2007     $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2009     if ($return) {
2010         return $output;
2011     } else {
2012         echo $output;
2013     }
2016 /**
2017  * Close a region started with print_collapsible_region_start.
2018  *
2019  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2020  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2021  */
2022 function print_collapsible_region_end($return = false) {
2023     $output = '</div></div></div>';
2025     if ($return) {
2026         return $output;
2027     } else {
2028         echo $output;
2029     }
2032 /**
2033  * Print a specified group's avatar.
2034  *
2035  * @global object
2036  * @uses CONTEXT_COURSE
2037  * @param array|stdClass $group A single {@link group} object OR array of groups.
2038  * @param int $courseid The course ID.
2039  * @param boolean $large Default small picture, or large.
2040  * @param boolean $return If false print picture, otherwise return the output as string
2041  * @param boolean $link Enclose image in a link to view specified course?
2042  * @return string|void Depending on the setting of $return
2043  */
2044 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2045     global $CFG;
2047     if (is_array($group)) {
2048         $output = '';
2049         foreach($group as $g) {
2050             $output .= print_group_picture($g, $courseid, $large, true, $link);
2051         }
2052         if ($return) {
2053             return $output;
2054         } else {
2055             echo $output;
2056             return;
2057         }
2058     }
2060     $context = get_context_instance(CONTEXT_COURSE, $courseid);
2062     // If there is no picture, do nothing
2063     if (!$group->picture) {
2064         return '';
2065     }
2067     // If picture is hidden, only show to those with course:managegroups
2068     if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
2069         return '';
2070     }
2072     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2073         $output = '<a href="'. $CFG->wwwroot .'/user/index.php?id='. $courseid .'&amp;group='. $group->id .'">';
2074     } else {
2075         $output = '';
2076     }
2077     if ($large) {
2078         $file = 'f1';
2079     } else {
2080         $file = 'f2';
2081     }
2083     $grouppictureurl = moodle_url::make_pluginfile_url($context->id, 'group', 'icon', $group->id, '/', $file);
2084     $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2085         ' alt="'.s(get_string('group').' '.$group->name).'" title="'.s($group->name).'"/>';
2087     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2088         $output .= '</a>';
2089     }
2091     if ($return) {
2092         return $output;
2093     } else {
2094         echo $output;
2095     }
2099 /**
2100  * Display a recent activity note
2101  *
2102  * @uses CONTEXT_SYSTEM
2103  * @staticvar string $strftimerecent
2104  * @param object A time object
2105  * @param object A user object
2106  * @param string $text Text for display for the note
2107  * @param string $link The link to wrap around the text
2108  * @param bool $return If set to true the HTML is returned rather than echo'd
2109  * @param string $viewfullnames
2110  */
2111 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2112     static $strftimerecent = null;
2113     $output = '';
2115     if (is_null($viewfullnames)) {
2116         $context = get_context_instance(CONTEXT_SYSTEM);
2117         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2118     }
2120     if (is_null($strftimerecent)) {
2121         $strftimerecent = get_string('strftimerecent');
2122     }
2124     $output .= '<div class="head">';
2125     $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2126     $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2127     $output .= '</div>';
2128     $output .= '<div class="info"><a href="'.$link.'">'.format_string($text,true).'</a></div>';
2130     if ($return) {
2131         return $output;
2132     } else {
2133         echo $output;
2134     }
2137 /**
2138  * Returns a popup menu with course activity modules
2139  *
2140  * Given a course
2141  * This function returns a small popup menu with all the
2142  * course activity modules in it, as a navigation menu
2143  * outputs a simple list structure in XHTML
2144  * The data is taken from the serialised array stored in
2145  * the course record
2146  *
2147  * @todo Finish documenting this function
2148  *
2149  * @global object
2150  * @uses CONTEXT_COURSE
2151  * @param course $course A {@link $COURSE} object.
2152  * @param string $sections
2153  * @param string $modinfo
2154  * @param string $strsection
2155  * @param string $strjumpto
2156  * @param int $width
2157  * @param string $cmid
2158  * @return string The HTML block
2159  */
2160 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2162     global $CFG, $OUTPUT;
2164     $section = -1;
2165     $url = '';
2166     $menu = array();
2167     $doneheading = false;
2169     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2171     $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2172     foreach ($modinfo->cms as $mod) {
2173         if (!$mod->has_view()) {
2174             // Don't show modules which you can't link to!
2175             continue;
2176         }
2178         if ($mod->sectionnum > $course->numsections) {   /// Don't show excess hidden sections
2179             break;
2180         }
2182         if (!$mod->uservisible) { // do not icnlude empty sections at all
2183             continue;
2184         }
2186         if ($mod->sectionnum >= 0 and $section != $mod->sectionnum) {
2187             $thissection = $sections[$mod->sectionnum];
2189             if ($thissection->visible or !$course->hiddensections or
2190                       has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2191                 $thissection->summary = strip_tags(format_string($thissection->summary,true));
2192                 if (!$doneheading) {
2193                     $menu[] = '</ul></li>';
2194                 }
2195                 if ($course->format == 'weeks' or empty($thissection->summary)) {
2196                     $item = $strsection ." ". $mod->sectionnum;
2197                 } else {
2198                     if (textlib::strlen($thissection->summary) < ($width-3)) {
2199                         $item = $thissection->summary;
2200                     } else {
2201                         $item = textlib::substr($thissection->summary, 0, $width).'...';
2202                     }
2203                 }
2204                 $menu[] = '<li class="section"><span>'.$item.'</span>';
2205                 $menu[] = '<ul>';
2206                 $doneheading = true;
2208                 $section = $mod->sectionnum;
2209             } else {
2210                 // no activities from this hidden section shown
2211                 continue;
2212             }
2213         }
2215         $url = $mod->modname .'/view.php?id='. $mod->id;
2216         $mod->name = strip_tags(format_string($mod->name ,true));
2217         if (textlib::strlen($mod->name) > ($width+5)) {
2218             $mod->name = textlib::substr($mod->name, 0, $width).'...';
2219         }
2220         if (!$mod->visible) {
2221             $mod->name = '('.$mod->name.')';
2222         }
2223         $class = 'activity '.$mod->modname;
2224         $class .= ($cmid == $mod->id) ? ' selected' : '';
2225         $menu[] = '<li class="'.$class.'">'.
2226                   '<img src="'.$OUTPUT->pix_url('icon', $mod->modname) . '" alt="" />'.
2227                   '<a href="'.$CFG->wwwroot.'/mod/'.$url.'">'.$mod->name.'</a></li>';
2228     }
2230     if ($doneheading) {
2231         $menu[] = '</ul></li>';
2232     }
2233     $menu[] = '</ul></li></ul>';
2235     return implode("\n", $menu);
2238 /**
2239  * Prints a grade menu (as part of an existing form) with help
2240  * Showing all possible numerical grades and scales
2241  *
2242  * @todo Finish documenting this function
2243  * @todo Deprecate: this is only used in a few contrib modules
2244  *
2245  * @global object
2246  * @param int $courseid The course ID
2247  * @param string $name
2248  * @param string $current
2249  * @param boolean $includenograde Include those with no grades
2250  * @param boolean $return If set to true returns rather than echo's
2251  * @return string|bool Depending on value of $return
2252  */
2253 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2255     global $CFG, $OUTPUT;
2257     $output = '';
2258     $strscale = get_string('scale');
2259     $strscales = get_string('scales');
2261     $scales = get_scales_menu($courseid);
2262     foreach ($scales as $i => $scalename) {
2263         $grades[-$i] = $strscale .': '. $scalename;
2264     }
2265     if ($includenograde) {
2266         $grades[0] = get_string('nograde');
2267     }
2268     for ($i=100; $i>=1; $i--) {
2269         $grades[$i] = $i;
2270     }
2271     $output .= html_writer::select($grades, $name, $current, false);
2273     $linkobject = '<span class="helplink"><img class="iconhelp" alt="'.$strscales.'" src="'.$OUTPUT->pix_url('help') . '" /></span>';
2274     $link = new moodle_url('/course/scales.php', array('id'=>$courseid, 'list'=>1));
2275     $action = new popup_action('click', $link, 'ratingscales', array('height' => 400, 'width' => 500));
2276     $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title'=>$strscales));
2278     if ($return) {
2279         return $output;
2280     } else {
2281         echo $output;
2282     }
2285 /**
2286  * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2287  * Default errorcode is 1.
2288  *
2289  * Very useful for perl-like error-handling:
2290  *
2291  * do_somethting() or mdie("Something went wrong");
2292  *
2293  * @param string  $msg       Error message
2294  * @param integer $errorcode Error code to emit
2295  */
2296 function mdie($msg='', $errorcode=1) {
2297     trigger_error($msg);
2298     exit($errorcode);
2301 /**
2302  * Print a message and exit.
2303  *
2304  * @param string $message The message to print in the notice
2305  * @param string $link The link to use for the continue button
2306  * @param object $course A course object
2307  * @return void This function simply exits
2308  */
2309 function notice ($message, $link='', $course=NULL) {
2310     global $CFG, $SITE, $COURSE, $PAGE, $OUTPUT;
2312     $message = clean_text($message);   // In case nasties are in here
2314     if (CLI_SCRIPT) {
2315         echo("!!$message!!\n");
2316         exit(1); // no success
2317     }
2319     if (!$PAGE->headerprinted) {
2320         //header not yet printed
2321         $PAGE->set_title(get_string('notice'));
2322         echo $OUTPUT->header();
2323     } else {
2324         echo $OUTPUT->container_end_all(false);
2325     }
2327     echo $OUTPUT->box($message, 'generalbox', 'notice');
2328     echo $OUTPUT->continue_button($link);
2330     echo $OUTPUT->footer();
2331     exit(1); // general error code
2334 /**
2335  * Redirects the user to another page, after printing a notice
2336  *
2337  * This function calls the OUTPUT redirect method, echo's the output
2338  * and then dies to ensure nothing else happens.
2339  *
2340  * <strong>Good practice:</strong> You should call this method before starting page
2341  * output by using any of the OUTPUT methods.
2342  *
2343  * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2344  * @param string $message The message to display to the user
2345  * @param int $delay The delay before redirecting
2346  * @return void - does not return!
2347  */
2348 function redirect($url, $message='', $delay=-1) {
2349     global $OUTPUT, $PAGE, $SESSION, $CFG;
2351     if (CLI_SCRIPT or AJAX_SCRIPT) {
2352         // this is wrong - developers should not use redirect in these scripts,
2353         // but it should not be very likely
2354         throw new moodle_exception('redirecterrordetected', 'error');
2355     }
2357     // prevent debug errors - make sure context is properly initialised
2358     if ($PAGE) {
2359         $PAGE->set_context(null);
2360         $PAGE->set_pagelayout('redirect');  // No header and footer needed
2361     }
2363     if ($url instanceof moodle_url) {
2364         $url = $url->out(false);
2365     }
2367     $debugdisableredirect = false;
2368     do {
2369         if (defined('DEBUGGING_PRINTED')) {
2370             // some debugging already printed, no need to look more
2371             $debugdisableredirect = true;
2372             break;
2373         }
2375         if (empty($CFG->debugdisplay) or empty($CFG->debug)) {
2376             // no errors should be displayed
2377             break;
2378         }
2380         if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2381             break;
2382         }
2384         if (!($lasterror['type'] & $CFG->debug)) {
2385             //last error not interesting
2386             break;
2387         }
2389         // watch out here, @hidden() errors are returned from error_get_last() too
2390         if (headers_sent()) {
2391             //we already started printing something - that means errors likely printed
2392             $debugdisableredirect = true;
2393             break;
2394         }
2396         if (ob_get_level() and ob_get_contents()) {
2397             // there is something waiting to be printed, hopefully it is the errors,
2398             // but it might be some error hidden by @ too - such as the timezone mess from setup.php
2399             $debugdisableredirect = true;
2400             break;
2401         }
2402     } while (false);
2404     // Technically, HTTP/1.1 requires Location: header to contain the absolute path.
2405     // (In practice browsers accept relative paths - but still, might as well do it properly.)
2406     // This code turns relative into absolute.
2407     if (!preg_match('|^[a-z]+:|', $url)) {
2408         // Get host name http://www.wherever.com
2409         $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2410         if (preg_match('|^/|', $url)) {
2411             // URLs beginning with / are relative to web server root so we just add them in
2412             $url = $hostpart.$url;
2413         } else {
2414             // URLs not beginning with / are relative to path of current script, so add that on.
2415             $url = $hostpart.preg_replace('|\?.*$|','',me()).'/../'.$url;
2416         }
2417         // Replace all ..s
2418         while (true) {
2419             $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2420             if ($newurl == $url) {
2421                 break;
2422             }
2423             $url = $newurl;
2424         }
2425     }
2427     // Sanitise url - we can not rely on moodle_url or our URL cleaning
2428     // because they do not support all valid external URLs
2429     $url = preg_replace('/[\x00-\x1F\x7F]/', '', $url);
2430     $url = str_replace('"', '%22', $url);
2431     $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2432     $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />', FORMAT_HTML));
2433     $url = str_replace('&amp;', '&', $encodedurl);
2435     if (!empty($message)) {
2436         if ($delay === -1 || !is_numeric($delay)) {
2437             $delay = 3;
2438         }
2439         $message = clean_text($message);
2440     } else {
2441         $message = get_string('pageshouldredirect');
2442         $delay = 0;
2443     }
2445     if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
2446         if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
2447             $perf = get_performance_info();
2448             error_log("PERF: " . $perf['txt']);
2449         }
2450     }
2452     if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2453         // workaround for IIS bug http://support.microsoft.com/kb/q176113/
2454         if (session_id()) {
2455             session_get_instance()->write_close();
2456         }
2458         //302 might not work for POST requests, 303 is ignored by obsolete clients.
2459         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2460         @header('Location: '.$url);
2461         echo bootstrap_renderer::plain_redirect_message($encodedurl);
2462         exit;
2463     }
2465     // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2466     if ($PAGE) {
2467         $CFG->docroot = false; // to prevent the link to moodle docs from being displayed on redirect page.
2468         echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect);
2469         exit;
2470     } else {
2471         echo bootstrap_renderer::early_redirect_message($encodedurl, $message, $delay);
2472         exit;
2473     }
2476 /**
2477  * Given an email address, this function will return an obfuscated version of it
2478  *
2479  * @param string $email The email address to obfuscate
2480  * @return string The obfuscated email address
2481  */
2482  function obfuscate_email($email) {
2484     $i = 0;
2485     $length = strlen($email);
2486     $obfuscated = '';
2487     while ($i < $length) {
2488         if (rand(0,2) && $email{$i}!='@') { //MDL-20619 some browsers have problems unobfuscating @
2489             $obfuscated.='%'.dechex(ord($email{$i}));
2490         } else {
2491             $obfuscated.=$email{$i};
2492         }
2493         $i++;
2494     }
2495     return $obfuscated;
2498 /**
2499  * This function takes some text and replaces about half of the characters
2500  * with HTML entity equivalents.   Return string is obviously longer.
2501  *
2502  * @param string $plaintext The text to be obfuscated
2503  * @return string The obfuscated text
2504  */
2505 function obfuscate_text($plaintext) {
2507     $i=0;
2508     $length = strlen($plaintext);
2509     $obfuscated='';
2510     $prev_obfuscated = false;
2511     while ($i < $length) {
2512         $c = ord($plaintext{$i});
2513         $numerical = ($c >= ord('0')) && ($c <= ord('9'));
2514         if ($prev_obfuscated and $numerical ) {
2515             $obfuscated.='&#'.ord($plaintext{$i}).';';
2516         } else if (rand(0,2)) {
2517             $obfuscated.='&#'.ord($plaintext{$i}).';';
2518             $prev_obfuscated = true;
2519         } else {
2520             $obfuscated.=$plaintext{$i};
2521             $prev_obfuscated = false;
2522         }
2523       $i++;
2524     }
2525     return $obfuscated;
2528 /**
2529  * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2530  * to generate a fully obfuscated email link, ready to use.
2531  *
2532  * @param string $email The email address to display
2533  * @param string $label The text to displayed as hyperlink to $email
2534  * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2535  * @return string The obfuscated mailto link
2536  */
2537 function obfuscate_mailto($email, $label='', $dimmed=false) {
2539     if (empty($label)) {
2540         $label = $email;
2541     }
2542     if ($dimmed) {
2543         $title = get_string('emaildisable');
2544         $dimmed = ' class="dimmed"';
2545     } else {
2546         $title = '';
2547         $dimmed = '';
2548     }
2549     return sprintf("<a href=\"%s:%s\" $dimmed title=\"$title\">%s</a>",
2550                     obfuscate_text('mailto'), obfuscate_email($email),
2551                     obfuscate_text($label));
2554 /**
2555  * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2556  * will transform it to html entities
2557  *
2558  * @param string $text Text to search for nolink tag in
2559  * @return string
2560  */
2561 function rebuildnolinktag($text) {
2563     $text = preg_replace('/&lt;(\/*nolink)&gt;/i','<$1>',$text);
2565     return $text;
2568 /**
2569  * Prints a maintenance message from $CFG->maintenance_message or default if empty
2570  * @return void
2571  */
2572 function print_maintenance_message() {
2573     global $CFG, $SITE, $PAGE, $OUTPUT;
2575     $PAGE->set_pagetype('maintenance-message');
2576     $PAGE->set_pagelayout('maintenance');
2577     $PAGE->set_title(strip_tags($SITE->fullname));
2578     $PAGE->set_heading($SITE->fullname);
2579     echo $OUTPUT->header();
2580     echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2581     if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
2582         echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2583         echo $CFG->maintenance_message;
2584         echo $OUTPUT->box_end();
2585     }
2586     echo $OUTPUT->footer();
2587     die;
2590 /**
2591  * A class for tabs, Some code to print tabs
2592  *
2593  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2594  * @package moodlecore
2595  */
2596 class tabobject {
2597     /**
2598      * @var string
2599      */
2600     var $id;
2601     var $link;
2602     var $text;
2603     /**
2604      * @var bool
2605      */
2606     var $linkedwhenselected;
2608     /**
2609      * A constructor just because I like constructors
2610      *
2611      * @param string $id
2612      * @param string $link
2613      * @param string $text
2614      * @param string $title
2615      * @param bool $linkedwhenselected
2616      */
2617     function tabobject ($id, $link='', $text='', $title='', $linkedwhenselected=false) {
2618         $this->id   = $id;
2619         $this->link = $link;
2620         $this->text = $text;
2621         $this->title = $title ? $title : $text;
2622         $this->linkedwhenselected = $linkedwhenselected;
2623     }
2628 /**
2629  * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2630  *
2631  * @global object
2632  * @param array $tabrows An array of rows where each row is an array of tab objects
2633  * @param string $selected  The id of the selected tab (whatever row it's on)
2634  * @param array  $inactive  An array of ids of inactive tabs that are not selectable.
2635  * @param array  $activated An array of ids of other tabs that are currently activated
2636  * @param bool $return If true output is returned rather then echo'd
2637  **/
2638 function print_tabs($tabrows, $selected=NULL, $inactive=NULL, $activated=NULL, $return=false) {
2639     global $CFG;
2641 /// $inactive must be an array
2642     if (!is_array($inactive)) {
2643         $inactive = array();
2644     }
2646 /// $activated must be an array
2647     if (!is_array($activated)) {
2648         $activated = array();
2649     }
2651 /// Convert the tab rows into a tree that's easier to process
2652     if (!$tree = convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated)) {
2653         return false;
2654     }
2656 /// Print out the current tree of tabs (this function is recursive)
2658     $output = convert_tree_to_html($tree);
2660     $output = "\n\n".'<div class="tabtree">'.$output.'</div><div class="clearer"> </div>'."\n\n";
2662 /// We're done!
2664     if ($return) {
2665         return $output;
2666     }
2667     echo $output;
2670 /**
2671  * Converts a nested array tree into HTML ul:li [recursive]
2672  *
2673  * @param array $tree A tree array to convert
2674  * @param int $row Used in identifying the iteration level and in ul classes
2675  * @return string HTML structure
2676  */
2677 function convert_tree_to_html($tree, $row=0) {
2679     $str = "\n".'<ul class="tabrow'.$row.'">'."\n";
2681     $first = true;
2682     $count = count($tree);
2684     foreach ($tree as $tab) {
2685         $count--;   // countdown to zero
2687         $liclass = '';
2689         if ($first && ($count == 0)) {   // Just one in the row
2690             $liclass = 'first last';
2691             $first = false;
2692         } else if ($first) {
2693             $liclass = 'first';
2694             $first = false;
2695         } else if ($count == 0) {
2696             $liclass = 'last';
2697         }
2699         if ((empty($tab->subtree)) && (!empty($tab->selected))) {
2700             $liclass .= (empty($liclass)) ? 'onerow' : ' onerow';
2701         }
2703         if ($tab->inactive || $tab->active || $tab->selected) {
2704             if ($tab->selected) {
2705                 $liclass .= (empty($liclass)) ? 'here selected' : ' here selected';
2706             } else if ($tab->active) {
2707                 $liclass .= (empty($liclass)) ? 'here active' : ' here active';
2708             }
2709         }
2711         $str .= (!empty($liclass)) ? '<li class="'.$liclass.'">' : '<li>';
2713         if ($tab->inactive || $tab->active || ($tab->selected && !$tab->linkedwhenselected)) {
2714             // The a tag is used for styling
2715             $str .= '<a class="nolink"><span>'.$tab->text.'</span></a>';
2716         } else {
2717             $str .= '<a href="'.$tab->link.'" title="'.$tab->title.'"><span>'.$tab->text.'</span></a>';
2718         }
2720         if (!empty($tab->subtree)) {
2721             $str .= convert_tree_to_html($tab->subtree, $row+1);
2722         } else if ($tab->selected) {
2723             $str .= '<div class="tabrow'.($row+1).' empty">&nbsp;</div>'."\n";
2724         }
2726         $str .= ' </li>'."\n";
2727     }
2728     $str .= '</ul>'."\n";
2730     return $str;
2733 /**
2734  * Convert nested tabrows to a nested array
2735  *
2736  * @param array $tabrows A [nested] array of tab row objects
2737  * @param string $selected The tabrow to select (by id)
2738  * @param array $inactive An array of tabrow id's to make inactive
2739  * @param array $activated An array of tabrow id's to make active
2740  * @return array The nested array
2741  */
2742 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
2744 /// Work backwards through the rows (bottom to top) collecting the tree as we go.
2746     $tabrows = array_reverse($tabrows);
2748     $subtree = array();
2750     foreach ($tabrows as $row) {
2751         $tree = array();
2753         foreach ($row as $tab) {
2754             $tab->inactive = in_array((string)$tab->id, $inactive);
2755             $tab->active = in_array((string)$tab->id, $activated);
2756             $tab->selected = (string)$tab->id == $selected;
2758             if ($tab->active || $tab->selected) {
2759                 if ($subtree) {
2760                     $tab->subtree = $subtree;
2761                 }
2762             }
2763             $tree[] = $tab;
2764         }
2765         $subtree = $tree;
2766     }
2768     return $subtree;
2771 /**
2772  * Standard Debugging Function
2773  *
2774  * Returns true if the current site debugging settings are equal or above specified level.
2775  * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2776  * routing of notices is controlled by $CFG->debugdisplay
2777  * eg use like this:
2778  *
2779  * 1)  debugging('a normal debug notice');
2780  * 2)  debugging('something really picky', DEBUG_ALL);
2781  * 3)  debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
2782  * 4)  if (debugging()) { perform extra debugging operations (do not use print or echo) }
2783  *
2784  * In code blocks controlled by debugging() (such as example 4)
2785  * any output should be routed via debugging() itself, or the lower-level
2786  * trigger_error() or error_log(). Using echo or print will break XHTML
2787  * JS and HTTP headers.
2788  *
2789  * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2790  *
2791  * @uses DEBUG_NORMAL
2792  * @param string $message a message to print
2793  * @param int $level the level at which this debugging statement should show
2794  * @param array $backtrace use different backtrace
2795  * @return bool
2796  */
2797 function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
2798     global $CFG, $USER, $UNITTEST;
2800     $forcedebug = false;
2801     if (!empty($CFG->debugusers) && $USER) {
2802         $debugusers = explode(',', $CFG->debugusers);
2803         $forcedebug = in_array($USER->id, $debugusers);
2804     }
2806     if (!$forcedebug and (empty($CFG->debug) || ($CFG->debug != -1 and $CFG->debug < $level))) {
2807         return false;
2808     }
2810     if (!isset($CFG->debugdisplay)) {
2811         $CFG->debugdisplay = ini_get_bool('display_errors');
2812     }
2814     if ($message) {
2815         if (!$backtrace) {
2816             $backtrace = debug_backtrace();
2817         }
2818         $from = format_backtrace($backtrace, CLI_SCRIPT);
2819         if (PHPUNIT_TEST) {
2820             echo 'Debugging: ' . $message . "\n" . $from;
2822         } else if (!empty($UNITTEST->running)) {
2823             // When the unit tests are running, any call to trigger_error
2824             // is intercepted by the test framework and reported as an exception.
2825             // Therefore, we cannot use trigger_error during unit tests.
2826             // At the same time I do not think we should just discard those messages,
2827             // so displaying them on-screen seems like the only option. (MDL-20398)
2828             echo '<div class="notifytiny">' . $message . $from . '</div>';
2830         } else if (NO_DEBUG_DISPLAY) {
2831             // script does not want any errors or debugging in output,
2832             // we send the info to error log instead
2833             error_log('Debugging: ' . $message . $from);
2835         } else if ($forcedebug or $CFG->debugdisplay) {
2836             if (!defined('DEBUGGING_PRINTED')) {
2837                 define('DEBUGGING_PRINTED', 1); // indicates we have printed something
2838             }
2839             if (CLI_SCRIPT) {
2840                 echo "++ $message ++\n$from";
2841             } else {
2842                 echo '<div class="notifytiny">' . $message . $from . '</div>';
2843             }
2845         } else {
2846             trigger_error($message . $from, E_USER_NOTICE);
2847         }
2848     }
2849     return true;
2852 /**
2853 * Outputs a HTML comment to the browser. This is used for those hard-to-debug
2854 * pages that use bits from many different files in very confusing ways (e.g. blocks).
2856 * <code>print_location_comment(__FILE__, __LINE__);</code>
2858 * @param string $file
2859 * @param integer $line
2860 * @param boolean $return Whether to return or print the comment
2861 * @return string|void Void unless true given as third parameter
2862 */
2863 function print_location_comment($file, $line, $return = false)
2865     if ($return) {
2866         return "<!-- $file at line $line -->\n";
2867     } else {
2868         echo "<!-- $file at line $line -->\n";
2869     }
2873 /**
2874  * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
2875  */
2876 function right_to_left() {
2877     return (get_string('thisdirection', 'langconfig') === 'rtl');
2881 /**
2882  * Returns swapped left<=>right if in RTL environment.
2883  * part of RTL support
2884  *
2885  * @param string $align align to check
2886  * @return string
2887  */
2888 function fix_align_rtl($align) {
2889     if (!right_to_left()) {
2890         return $align;
2891     }
2892     if ($align=='left')  { return 'right'; }
2893     if ($align=='right') { return 'left'; }
2894     return $align;
2898 /**
2899  * Returns true if the page is displayed in a popup window.
2900  * Gets the information from the URL parameter inpopup.
2901  *
2902  * @todo Use a central function to create the popup calls all over Moodle and
2903  * In the moment only works with resources and probably questions.
2904  *
2905  * @return boolean
2906  */
2907 function is_in_popup() {
2908     $inpopup = optional_param('inpopup', '', PARAM_BOOL);
2910     return ($inpopup);
2913 /**
2914  * To use this class.
2915  * - construct
2916  * - call create (or use the 3rd param to the constructor)
2917  * - call update or update_full() or update() repeatedly
2918  *
2919  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2920  * @package moodlecore
2921  */
2922 class progress_bar {
2923     /** @var string html id */
2924     private $html_id;
2925     /** @var int total width */
2926     private $width;
2927     /** @var int last percentage printed */
2928     private $percent = 0;
2929     /** @var int time when last printed */
2930     private $lastupdate = 0;
2931     /** @var int when did we start printing this */
2932     private $time_start = 0;
2934     /**
2935      * Constructor
2936      *
2937      * @param string $html_id
2938      * @param int $width
2939      * @param bool $autostart Default to false
2940      * @return void, prints JS code if $autostart true
2941      */
2942     public function __construct($html_id = '', $width = 500, $autostart = false) {
2943         if (!empty($html_id)) {
2944             $this->html_id  = $html_id;
2945         } else {
2946             $this->html_id  = 'pbar_'.uniqid();
2947         }
2949         $this->width = $width;
2951         if ($autostart){
2952             $this->create();
2953         }
2954     }
2956     /**
2957       * Create a new progress bar, this function will output html.
2958       *
2959       * @return void Echo's output
2960       */
2961     public function create() {
2962         $this->time_start = microtime(true);
2963         if (CLI_SCRIPT) {
2964             return; // temporary solution for cli scripts
2965         }
2966         $htmlcode = <<<EOT
2967         <div style="text-align:center;width:{$this->width}px;clear:both;padding:0;margin:0 auto;">
2968             <h2 id="status_{$this->html_id}" style="text-align: center;margin:0 auto"></h2>
2969             <p id="time_{$this->html_id}"></p>
2970             <div id="bar_{$this->html_id}" style="border-style:solid;border-width:1px;width:500px;height:50px;">
2971                 <div id="progress_{$this->html_id}"
2972                 style="text-align:center;background:#FFCC66;width:4px;border:1px
2973                 solid gray;height:38px; padding-top:10px;">&nbsp;<span id="pt_{$this->html_id}"></span>
2974                 </div>
2975             </div>
2976         </div>
2977 EOT;
2978         flush();
2979         echo $htmlcode;
2980         flush();
2981     }
2983     /**
2984      * Update the progress bar
2985      *
2986      * @param int $percent from 1-100
2987      * @param string $msg
2988      * @return void Echo's output
2989      */
2990     private function _update($percent, $msg) {
2991         if (empty($this->time_start)) {
2992             throw new coding_exception('You must call create() (or use the $autostart ' .
2993                     'argument to the constructor) before you try updating the progress bar.');
2994         }
2996         if (CLI_SCRIPT) {
2997             return; // temporary solution for cli scripts
2998         }
3000         $es = $this->estimate($percent);
3002         if ($es === null) {
3003             // always do the first and last updates
3004             $es = "?";
3005         } else if ($es == 0) {
3006             // always do the last updates
3007         } else if ($this->lastupdate + 20 < time()) {
3008             // we must update otherwise browser would time out
3009         } else if (round($this->percent, 2) === round($percent, 2)) {
3010             // no significant change, no need to update anything
3011             return;
3012         }
3014         $this->percent = $percent;
3015         $this->lastupdate = microtime(true);
3017         $w = ($this->percent/100) * $this->width;
3018         echo html_writer::script(js_writer::function_call('update_progress_bar', array($this->html_id, $w, $this->percent, $msg, $es)));
3019         flush();
3020     }
3022     /**
3023       * Estimate how much time it is going to take.
3024       *
3025       * @param int $curtime the time call this function
3026       * @param int $percent from 1-100
3027       * @return mixed Null (unknown), or int
3028       */
3029     private function estimate($pt) {
3030         if ($this->lastupdate == 0) {
3031             return null;
3032         }
3033         if ($pt < 0.00001) {
3034             return null; // we do not know yet how long it will take
3035         }
3036         if ($pt > 99.99999) {
3037             return 0; // nearly done, right?
3038         }
3039         $consumed = microtime(true) - $this->time_start;
3040         if ($consumed < 0.001) {
3041             return null;
3042         }
3044         return (100 - $pt) * ($consumed / $pt);
3045     }
3047     /**
3048       * Update progress bar according percent
3049       *
3050       * @param int $percent from 1-100
3051       * @param string $msg the message needed to be shown
3052       */
3053     public function update_full($percent, $msg) {
3054         $percent = max(min($percent, 100), 0);
3055         $this->_update($percent, $msg);
3056     }
3058     /**
3059       * Update progress bar according the number of tasks
3060       *
3061       * @param int $cur current task number
3062       * @param int $total total task number
3063       * @param string $msg message
3064       */
3065     public function update($cur, $total, $msg) {
3066         $percent = ($cur / $total) * 100;
3067         $this->update_full($percent, $msg);
3068     }
3070     /**
3071      * Restart the progress bar.
3072      */
3073     public function restart() {
3074         $this->percent    = 0;
3075         $this->lastupdate = 0;
3076         $this->time_start = 0;
3077     }
3080 /**
3081  * Use this class from long operations where you want to output occasional information about
3082  * what is going on, but don't know if, or in what format, the output should be.
3083  *
3084  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3085  * @package moodlecore
3086  */
3087 abstract class progress_trace {
3088     /**
3089      * Ouput an progress message in whatever format.
3090      * @param string $message the message to output.
3091      * @param integer $depth indent depth for this message.
3092      */
3093     abstract public function output($message, $depth = 0);
3095     /**
3096      * Called when the processing is finished.
3097      */
3098     public function finished() {
3099     }
3102 /**
3103  * This subclass of progress_trace does not ouput anything.
3104  *
3105  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3106  * @package moodlecore
3107  */
3108 class null_progress_trace extends progress_trace {
3109     /**
3110      * Does Nothing
3111      *
3112      * @param string $message
3113      * @param int $depth
3114      * @return void Does Nothing
3115      */
3116     public function output($message, $depth = 0) {
3117     }
3120 /**
3121  * This subclass of progress_trace outputs to plain text.
3122  *
3123  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3124  * @package moodlecore
3125  */
3126 class text_progress_trace extends progress_trace {
3127     /**
3128      * Output the trace message
3129      *
3130      * @param string $message
3131      * @param int $depth
3132      * @return void Output is echo'd
3133      */
3134     public function output($message, $depth = 0) {
3135         echo str_repeat('  ', $depth), $message, "\n";
3136         flush();
3137     }
3140 /**
3141  * This subclass of progress_trace outputs as HTML.
3142  *
3143  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3144  * @package moodlecore
3145  */
3146 class html_progress_trace extends progress_trace {
3147     /**
3148      * Output the trace message
3149      *
3150      * @param string $message
3151      * @param int $depth
3152      * @return void Output is echo'd
3153      */
3154     public function output($message, $depth = 0) {
3155         echo '<p>', str_repeat('&#160;&#160;', $depth), htmlspecialchars($message), "</p>\n";
3156         flush();
3157     }
3160 /**
3161  * HTML List Progress Tree
3162  *
3163  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3164  * @package moodlecore
3165  */
3166 class html_list_progress_trace extends progress_trace {
3167     /** @var int */
3168     protected $currentdepth = -1;
3170     /**
3171      * Echo out the list
3172      *
3173      * @param string $message The message to display
3174      * @param int $depth
3175      * @return void Output is echoed
3176      */
3177     public function output($message, $depth = 0) {
3178         $samedepth = true;
3179         while ($this->currentdepth > $depth) {
3180             echo "</li>\n</ul>\n";
3181             $this->currentdepth -= 1;
3182             if ($this->currentdepth == $depth) {
3183                 echo '<li>';
3184             }
3185             $samedepth = false;
3186         }
3187         while ($this->currentdepth < $depth) {
3188             echo "<ul>\n<li>";
3189             $this->currentdepth += 1;
3190             $samedepth = false;
3191         }
3192         if ($samedepth) {
3193             echo "</li>\n<li>";
3194         }
3195         echo htmlspecialchars($message);
3196         flush();
3197     }
3199     /**
3200      * Called when the processing is finished.
3201      */
3202     public function finished() {
3203         while ($this->currentdepth >= 0) {
3204             echo "</li>\n</ul>\n";
3205             $this->currentdepth -= 1;
3206         }
3207     }
3210 /**
3211  * Returns a localized sentence in the current language summarizing the current password policy
3212  *
3213  * @todo this should be handled by a function/method in the language pack library once we have a support for it
3214  * @uses $CFG
3215  * @return string
3216  */
3217 function print_password_policy() {
3218     global $CFG;
3220     $message = '';
3221     if (!empty($CFG->passwordpolicy)) {
3222         $messages = array();
3223         $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength);
3224         if (!empty($CFG->minpassworddigits)) {
3225             $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits);
3226         }
3227         if (!empty($CFG->minpasswordlower)) {
3228             $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower);
3229         }
3230         if (!empty($CFG->minpasswordupper)) {
3231             $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper);
3232         }
3233         if (!empty($CFG->minpasswordnonalphanum)) {
3234             $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3235         }
3237         $messages = join(', ', $messages); // this is ugly but we do not have anything better yet...
3238         $message = get_string('informpasswordpolicy', 'auth', $messages);
3239     }
3240     return $message;