lib/weblib.php

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