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