lib/weblib.php

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