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         // HTMLPurifier does not change, DB is already reset to defaults,
1328         // nothing to do here.
1329         return;
1330     }
1331
1332     $DB->delete_records('cache_text');
1333
1334     $purifdir = $CFG->cachedir.'/htmlpurifier';
1335     remove_dir($purifdir, true);
1336
1337     // Update $CFG->filterall cache flag.
1338     if (empty($CFG->stringfilters)) {
1339         set_config('filterall', 0);
1340         return;
1341     }
1342     $installedfilters = core_component::get_plugin_list('filter');
1343     $filters = explode(',', $CFG->stringfilters);
1344     foreach ($filters as $filter) {
1345         if (isset($installedfilters[$filter])) {
1346             set_config('filterall', 1);
1347             return;
1348         }
1349     }
1350     set_config('filterall', 0);
1351 }
1352
1353 /**
1354  * Given a simple string, this function returns the string
1355  * processed by enabled string filters if $CFG->filterall is enabled
1356  *
1357  * This function should be used to print short strings (non html) that
1358  * need filter processing e.g. activity titles, post subjects,
1359  * glossary concepts.
1360  *
1361  * @staticvar bool $strcache
1362  * @param string $string The string to be filtered. Should be plain text, expect
1363  * possibly for multilang tags.
1364  * @param boolean $striplinks To strip any link in the result text. Moodle 1.8 default changed from false to true! MDL-8713
1365  * @param array $options options array/object or courseid
1366  * @return string
1367  */
1368 function format_string($string, $striplinks = true, $options = null) {
1369     global $CFG, $PAGE;
1370
1371     // We'll use a in-memory cache here to speed up repeated strings.
1372     static $strcache = false;
1373
1374     if (empty($CFG->version) or $CFG->version < 2013051400 or during_initial_install()) {
1375         // Do not filter anything during installation or before upgrade completes.
1376         return $string = strip_tags($string);
1377     }
1378
1379     if ($strcache === false or count($strcache) > 2000) {
1380         // This number might need some tuning to limit memory usage in cron.
1381         $strcache = array();
1382     }
1383
1384     if (is_numeric($options)) {
1385         // Legacy courseid usage.
1386         $options  = array('context' => context_course::instance($options));
1387     } else {
1388         // Detach object, we can not modify it.
1389         $options = (array)$options;
1390     }
1391
1392     if (empty($options['context'])) {
1393         // Fallback to $PAGE->context this may be problematic in CLI and other non-standard pages :-(.
1394         $options['context'] = $PAGE->context;
1395     } else if (is_numeric($options['context'])) {
1396         $options['context'] = context::instance_by_id($options['context']);
1397     }
1398
1399     if (!$options['context']) {
1400         // We did not find any context? weird.
1401         return $string = strip_tags($string);
1402     }
1403
1404     // Calculate md5.
1405     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$options['context']->id.'<+>'.current_language());
1406
1407     // Fetch from cache if possible.
1408     if (isset($strcache[$md5])) {
1409         return $strcache[$md5];
1410     }
1411
1412     // First replace all ampersands not followed by html entity code
1413     // Regular expression moved to its own method for easier unit testing.
1414     $string = replace_ampersands_not_followed_by_entity($string);
1415
1416     if (!empty($CFG->filterall)) {
1417         $filtermanager = filter_manager::instance();
1418         $filtermanager->setup_page_for_filters($PAGE, $options['context']); // Setup global stuff filters may have.
1419         $string = $filtermanager->filter_string($string, $options['context']);
1420     }
1421
1422     // If the site requires it, strip ALL tags from this string.
1423     if (!empty($CFG->formatstringstriptags)) {
1424         $string = str_replace(array('<', '>'), array('&lt;', '&gt;'), strip_tags($string));
1425
1426     } else {
1427         // Otherwise strip just links if that is required (default).
1428         if ($striplinks) {
1429             // Strip links in string.
1430             $string = strip_links($string);
1431         }
1432         $string = clean_text($string);
1433     }
1434
1435     // Store to cache.
1436     $strcache[$md5] = $string;
1437
1438     return $string;
1439 }
1440
1441 /**
1442  * Given a string, performs a negative lookahead looking for any ampersand character
1443  * that is not followed by a proper HTML entity. If any is found, it is replaced
1444  * by &amp;. The string is then returned.
1445  *
1446  * @param string $string
1447  * @return string
1448  */
1449 function replace_ampersands_not_followed_by_entity($string) {
1450     return preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1451 }
1452
1453 /**
1454  * Given a string, replaces all <a>.*</a> by .* and returns the string.
1455  *
1456  * @param string $string
1457  * @return string
1458  */
1459 function strip_links($string) {
1460     return preg_replace('/(<a\s[^>]+?>)(.+?)(<\/a>)/is', '$2', $string);
1461 }
1462
1463 /**
1464  * This expression turns links into something nice in a text format. (Russell Jungwirth)
1465  *
1466  * @param string $string
1467  * @return string
1468  */
1469 function wikify_links($string) {
1470     return preg_replace('~(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)~i', '$3 [ $2 ]', $string);
1471 }
1472
1473 /**
1474  * Given text in a variety of format codings, this function returns the text as plain text suitable for plain email.
1475  *
1476  * @param string $text The text to be formatted. This is raw text originally from user input.
1477  * @param int $format Identifier of the text format to be used
1478  *            [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]
1479  * @return string
1480  */
1481 function format_text_email($text, $format) {
1482
1483     switch ($format) {
1484
1485         case FORMAT_PLAIN:
1486             return $text;
1487             break;
1488
1489         case FORMAT_WIKI:
1490             // There should not be any of these any more!
1491             $text = wikify_links($text);
1492             return core_text::entities_to_utf8(strip_tags($text), true);
1493             break;
1494
1495         case FORMAT_HTML:
1496             return html_to_text($text);
1497             break;
1498
1499         case FORMAT_MOODLE:
1500         case FORMAT_MARKDOWN:
1501         default:
1502             $text = wikify_links($text);
1503             return core_text::entities_to_utf8(strip_tags($text), true);
1504             break;
1505     }
1506 }
1507
1508 /**
1509  * Formats activity intro text
1510  *
1511  * @param string $module name of module
1512  * @param object $activity instance of activity
1513  * @param int $cmid course module id
1514  * @param bool $filter filter resulting html text
1515  * @return string
1516  */
1517 function format_module_intro($module, $activity, $cmid, $filter=true) {
1518     global $CFG;
1519     require_once("$CFG->libdir/filelib.php");
1520     $context = context_module::instance($cmid);
1521     $options = array('noclean' => true, 'para' => false, 'filter' => $filter, 'context' => $context, 'overflowdiv' => true);
1522     $intro = file_rewrite_pluginfile_urls($activity->intro, 'pluginfile.php', $context->id, 'mod_'.$module, 'intro', null);
1523     return trim(format_text($intro, $activity->introformat, $options, null));
1524 }
1525
1526 /**
1527  * Legacy function, used for cleaning of old forum and glossary text only.
1528  *
1529  * @param string $text text that may contain legacy TRUSTTEXT marker
1530  * @return string text without legacy TRUSTTEXT marker
1531  */
1532 function trusttext_strip($text) {
1533     while (true) { // Removing nested TRUSTTEXT.
1534         $orig = $text;
1535         $text = str_replace('#####TRUSTTEXT#####', '', $text);
1536         if (strcmp($orig, $text) === 0) {
1537             return $text;
1538         }
1539     }
1540 }
1541
1542 /**
1543  * Must be called before editing of all texts with trust flag. Removes all XSS nasties from texts stored in database if needed.
1544  *
1545  * @param stdClass $object data object with xxx, xxxformat and xxxtrust fields
1546  * @param string $field name of text field
1547  * @param context $context active context
1548  * @return stdClass updated $object
1549  */
1550 function trusttext_pre_edit($object, $field, $context) {
1551     $trustfield  = $field.'trust';
1552     $formatfield = $field.'format';
1553
1554     if (!$object->$trustfield or !trusttext_trusted($context)) {
1555         $object->$field = clean_text($object->$field, $object->$formatfield);
1556     }
1557
1558     return $object;
1559 }
1560
1561 /**
1562  * Is current user trusted to enter no dangerous XSS in this context?
1563  *
1564  * Please note the user must be in fact trusted everywhere on this server!!
1565  *
1566  * @param context $context
1567  * @return bool true if user trusted
1568  */
1569 function trusttext_trusted($context) {
1570     return (trusttext_active() and has_capability('moodle/site:trustcontent', $context));
1571 }
1572
1573 /**
1574  * Is trusttext feature active?
1575  *
1576  * @return bool
1577  */
1578 function trusttext_active() {
1579     global $CFG;
1580
1581     return !empty($CFG->enabletrusttext);
1582 }
1583
1584 /**
1585  * Cleans raw text removing nasties.
1586  *
1587  * Given raw text (eg typed in by a user) this function cleans it up and removes any nasty tags that could mess up
1588  * Moodle pages through XSS attacks.
1589  *
1590  * The result must be used as a HTML text fragment, this function can not cleanup random
1591  * parts of html tags such as url or src attributes.
1592  *
1593  * NOTE: the format parameter was deprecated because we can safely clean only HTML.
1594  *
1595  * @param string $text The text to be cleaned
1596  * @param int|string $format deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
1597  * @param array $options Array of options; currently only option supported is 'allowid' (if true,
1598  *   does not remove id attributes when cleaning)
1599  * @return string The cleaned up text
1600  */
1601 function clean_text($text, $format = FORMAT_HTML, $options = array()) {
1602     $text = (string)$text;
1603
1604     if ($format != FORMAT_HTML and $format != FORMAT_HTML) {
1605         // TODO: we need to standardise cleanup of text when loading it into editor first.
1606         // debugging('clean_text() is designed to work only with html');.
1607     }
1608
1609     if ($format == FORMAT_PLAIN) {
1610         return $text;
1611     }
1612
1613     if (is_purify_html_necessary($text)) {
1614         $text = purify_html($text, $options);
1615     }
1616
1617     // Originally we tried to neutralise some script events here, it was a wrong approach because
1618     // it was trivial to work around that (for example using style based XSS exploits).
1619     // We must not give false sense of security here - all developers MUST understand how to use
1620     // rawurlencode(), htmlentities(), htmlspecialchars(), p(), s(), moodle_url, html_writer and friends!!!
1621
1622     return $text;
1623 }
1624
1625 /**
1626  * Is it necessary to use HTMLPurifier?
1627  *
1628  * @private
1629  * @param string $text
1630  * @return bool false means html is safe and valid, true means use HTMLPurifier
1631  */
1632 function is_purify_html_necessary($text) {
1633     if ($text === '') {
1634         return false;
1635     }
1636
1637     if ($text === (string)((int)$text)) {
1638         return false;
1639     }
1640
1641     if (strpos($text, '&') !== false or preg_match('|<[^pesb/]|', $text)) {
1642         // We need to normalise entities or other tags except p, em, strong and br present.
1643         return true;
1644     }
1645
1646     $altered = htmlspecialchars($text, ENT_NOQUOTES, 'UTF-8', true);
1647     if ($altered === $text) {
1648         // No < > or other special chars means this must be safe.
1649         return false;
1650     }
1651
1652     // Let's try to convert back some safe html tags.
1653     $altered = preg_replace('|&lt;p&gt;(.*?)&lt;/p&gt;|m', '<p>$1</p>', $altered);
1654     if ($altered === $text) {
1655         return false;
1656     }
1657     $altered = preg_replace('|&lt;em&gt;([^<>]+?)&lt;/em&gt;|m', '<em>$1</em>', $altered);
1658     if ($altered === $text) {
1659         return false;
1660     }
1661     $altered = preg_replace('|&lt;strong&gt;([^<>]+?)&lt;/strong&gt;|m', '<strong>$1</strong>', $altered);
1662     if ($altered === $text) {
1663         return false;
1664     }
1665     $altered = str_replace('&lt;br /&gt;', '<br />', $altered);
1666     if ($altered === $text) {
1667         return false;
1668     }
1669
1670     return true;
1671 }
1672
1673 /**
1674  * KSES replacement cleaning function - uses HTML Purifier.
1675  *
1676  * @param string $text The (X)HTML string to purify
1677  * @param array $options Array of options; currently only option supported is 'allowid' (if set,
1678  *   does not remove id attributes when cleaning)
1679  * @return string
1680  */
1681 function purify_html($text, $options = array()) {
1682     global $CFG;
1683
1684     $text = (string)$text;
1685
1686     static $purifiers = array();
1687     static $caches = array();
1688
1689     // Purifier code can change only during major version upgrade.
1690     $version = empty($CFG->version) ? 0 : $CFG->version;
1691     $cachedir = "$CFG->localcachedir/htmlpurifier/$version";
1692     if (!file_exists($cachedir)) {
1693         // Purging of caches may remove the cache dir at any time,
1694         // luckily file_exists() results should be cached for all existing directories.
1695         $purifiers = array();
1696         $caches = array();
1697         gc_collect_cycles();
1698
1699         make_localcache_directory('htmlpurifier', false);
1700         check_dir_exists($cachedir);
1701     }
1702
1703     $allowid = empty($options['allowid']) ? 0 : 1;
1704     $allowobjectembed = empty($CFG->allowobjectembed) ? 0 : 1;
1705
1706     $type = 'type_'.$allowid.'_'.$allowobjectembed;
1707
1708     if (!array_key_exists($type, $caches)) {
1709         $caches[$type] = cache::make('core', 'htmlpurifier', array('type' => $type));
1710     }
1711     $cache = $caches[$type];
1712
1713     // Add revision number and all options to the text key so that it is compatible with local cluster node caches.
1714     $key = "|$version|$allowobjectembed|$allowid|$text";
1715     $filteredtext = $cache->get($key);
1716
1717     if ($filteredtext === true) {
1718         // The filtering did not change the text last time, no need to filter anything again.
1719         return $text;
1720     } else if ($filteredtext !== false) {
1721         return $filteredtext;
1722     }
1723
1724     if (empty($purifiers[$type])) {
1725         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.safe-includes.php';
1726         require_once $CFG->libdir.'/htmlpurifier/locallib.php';
1727         $config = HTMLPurifier_Config::createDefault();
1728
1729         $config->set('HTML.DefinitionID', 'moodlehtml');
1730         $config->set('HTML.DefinitionRev', 2);
1731         $config->set('Cache.SerializerPath', $cachedir);
1732         $config->set('Cache.SerializerPermissions', $CFG->directorypermissions);
1733         $config->set('Core.NormalizeNewlines', false);
1734         $config->set('Core.ConvertDocumentToFragment', true);
1735         $config->set('Core.Encoding', 'UTF-8');
1736         $config->set('HTML.Doctype', 'XHTML 1.0 Transitional');
1737         $config->set('URI.AllowedSchemes', array(
1738             'http' => true,
1739             'https' => true,
1740             'ftp' => true,
1741             'irc' => true,
1742             'nntp' => true,
1743             'news' => true,
1744             'rtsp' => true,
1745             'teamspeak' => true,
1746             'gopher' => true,
1747             'mms' => true,
1748             'mailto' => true
1749         ));
1750         $config->set('Attr.AllowedFrameTargets', array('_blank'));
1751
1752         if ($allowobjectembed) {
1753             $config->set('HTML.SafeObject', true);
1754             $config->set('Output.FlashCompat', true);
1755             $config->set('HTML.SafeEmbed', true);
1756         }
1757
1758         if ($allowid) {
1759             $config->set('Attr.EnableID', true);
1760         }
1761
1762         if ($def = $config->maybeGetRawHTMLDefinition()) {
1763             $def->addElement('nolink', 'Block', 'Flow', array());                       // Skip our filters inside.
1764             $def->addElement('tex', 'Inline', 'Inline', array());                       // Tex syntax, equivalent to $$xx$$.
1765             $def->addElement('algebra', 'Inline', 'Inline', array());                   // Algebra syntax, equivalent to @@xx@@.
1766             $def->addElement('lang', 'Block', 'Flow', array(), array('lang'=>'CDATA')); // Original multilang style - only our hacked lang attribute.
1767             $def->addAttribute('span', 'xxxlang', 'CDATA');                             // Current very problematic multilang.
1768         }
1769
1770         $purifier = new HTMLPurifier($config);
1771         $purifiers[$type] = $purifier;
1772     } else {
1773         $purifier = $purifiers[$type];
1774     }
1775
1776     $multilang = (strpos($text, 'class="multilang"') !== false);
1777
1778     $filteredtext = $text;
1779     if ($multilang) {
1780         $filteredtextregex = '/<span(\s+lang="([a-zA-Z0-9_-]+)"|\s+class="multilang"){2}\s*>/';
1781         $filteredtext = preg_replace($filteredtextregex, '<span xxxlang="${2}">', $filteredtext);
1782     }
1783     $filteredtext = (string)$purifier->purify($filteredtext);
1784     if ($multilang) {
1785         $filteredtext = preg_replace('/<span xxxlang="([a-zA-Z0-9_-]+)">/', '<span lang="${1}" class="multilang">', $filteredtext);
1786     }
1787
1788     if ($text === $filteredtext) {
1789         // No need to store the filtered text, next time we will just return unfiltered text
1790         // because it was not changed by purifying.
1791         $cache->set($key, true);
1792     } else {
1793         $cache->set($key, $filteredtext);
1794     }
1795
1796     return $filteredtext;
1797 }
1798
1799 /**
1800  * Given plain text, makes it into HTML as nicely as possible.
1801  *
1802  * May contain HTML tags already.
1803  *
1804  * Do not abuse this function. It is intended as lower level formatting feature used
1805  * by {@link format_text()} to convert FORMAT_MOODLE to HTML. You are supposed
1806  * to call format_text() in most of cases.
1807  *
1808  * @param string $text The string to convert.
1809  * @param boolean $smileyignored Was used to determine if smiley characters should convert to smiley images, ignored now
1810  * @param boolean $para If true then the returned string will be wrapped in div tags
1811  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
1812  * @return string
1813  */
1814 function text_to_html($text, $smileyignored = null, $para = true, $newlines = true) {
1815     // Remove any whitespace that may be between HTML tags.
1816     $text = preg_replace("~>([[:space:]]+)<~i", "><", $text);
1817
1818     // Remove any returns that precede or follow HTML tags.
1819     $text = preg_replace("~([\n\r])<~i", " <", $text);
1820     $text = preg_replace("~>([\n\r])~i", "> ", $text);
1821
1822     // Make returns into HTML newlines.
1823     if ($newlines) {
1824         $text = nl2br($text);
1825     }
1826
1827     // Wrap the whole thing in a div if required.
1828     if ($para) {
1829         // In 1.9 this was changed from a p => div.
1830         return '<div class="text_to_html">'.$text.'</div>';
1831     } else {
1832         return $text;
1833     }
1834 }
1835
1836 /**
1837  * Given Markdown formatted text, make it into XHTML using external function
1838  *
1839  * @param string $text The markdown formatted text to be converted.
1840  * @return string Converted text
1841  */
1842 function markdown_to_html($text) {
1843     global $CFG;
1844
1845     if ($text === '' or $text === null) {
1846         return $text;
1847     }
1848
1849     require_once($CFG->libdir .'/markdown/Markdown.php');
1850     require_once($CFG->libdir .'/markdown/MarkdownExtra.php');
1851
1852     return \Michelf\MarkdownExtra::defaultTransform($text);
1853 }
1854
1855 /**
1856  * Given HTML text, make it into plain text using external function
1857  *
1858  * @param string $html The text to be converted.
1859  * @param integer $width Width to wrap the text at. (optional, default 75 which
1860  *      is a good value for email. 0 means do not limit line length.)
1861  * @param boolean $dolinks By default, any links in the HTML are collected, and
1862  *      printed as a list at the end of the HTML. If you don't want that, set this
1863  *      argument to false.
1864  * @return string plain text equivalent of the HTML.
1865  */
1866 function html_to_text($html, $width = 75, $dolinks = true) {
1867
1868     global $CFG;
1869
1870     require_once($CFG->libdir .'/html2text.php');
1871
1872     $h2t = new html2text($html, false, $dolinks, $width);
1873     $result = $h2t->get_text();
1874
1875     return $result;
1876 }
1877
1878 /**
1879  * This function will highlight search words in a given string
1880  *
1881  * It cares about HTML and will not ruin links.  It's best to use
1882  * this function after performing any conversions to HTML.
1883  *
1884  * @param string $needle The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
1885  * @param string $haystack The string (HTML) within which to highlight the search terms.
1886  * @param boolean $matchcase whether to do case-sensitive. Default case-insensitive.
1887  * @param string $prefix the string to put before each search term found.
1888  * @param string $suffix the string to put after each search term found.
1889  * @return string The highlighted HTML.
1890  */
1891 function highlight($needle, $haystack, $matchcase = false,
1892         $prefix = '<span class="highlight">', $suffix = '</span>') {
1893
1894     // Quick bail-out in trivial cases.
1895     if (empty($needle) or empty($haystack)) {
1896         return $haystack;
1897     }
1898
1899     // Break up the search term into words, discard any -words and build a regexp.
1900     $words = preg_split('/ +/', trim($needle));
1901     foreach ($words as $index => $word) {
1902         if (strpos($word, '-') === 0) {
1903             unset($words[$index]);
1904         } else if (strpos($word, '+') === 0) {
1905             $words[$index] = '\b' . preg_quote(ltrim($word, '+'), '/') . '\b'; // Match only as a complete word.
1906         } else {
1907             $words[$index] = preg_quote($word, '/');
1908         }
1909     }
1910     $regexp = '/(' . implode('|', $words) . ')/u'; // Char u is to do UTF-8 matching.
1911     if (!$matchcase) {
1912         $regexp .= 'i';
1913     }
1914
1915     // Another chance to bail-out if $search was only -words.
1916     if (empty($words)) {
1917         return $haystack;
1918     }
1919
1920     // Find all the HTML tags in the input, and store them in a placeholders array..
1921     $placeholders = array();
1922     $matches = array();
1923     preg_match_all('/<[^>]*>/', $haystack, $matches);
1924     foreach (array_unique($matches[0]) as $key => $htmltag) {
1925         $placeholders['<|' . $key . '|>'] = $htmltag;
1926     }
1927
1928     // In $hastack, replace each HTML tag with the corresponding placeholder.
1929     $haystack = str_replace($placeholders, array_keys($placeholders), $haystack);
1930
1931     // In the resulting string, Do the highlighting.
1932     $haystack = preg_replace($regexp, $prefix . '$1' . $suffix, $haystack);
1933
1934     // Turn the placeholders back into HTML tags.
1935     $haystack = str_replace(array_keys($placeholders), $placeholders, $haystack);
1936
1937     return $haystack;
1938 }
1939
1940 /**
1941  * This function will highlight instances of $needle in $haystack
1942  *
1943  * It's faster that the above function {@link highlight()} and doesn't care about
1944  * HTML or anything.
1945  *
1946  * @param string $needle The string to search for
1947  * @param string $haystack The string to search for $needle in
1948  * @return string The highlighted HTML
1949  */
1950 function highlightfast($needle, $haystack) {
1951
1952     if (empty($needle) or empty($haystack)) {
1953         return $haystack;
1954     }
1955
1956     $parts = explode(core_text::strtolower($needle), core_text::strtolower($haystack));
1957
1958     if (count($parts) === 1) {
1959         return $haystack;
1960     }
1961
1962     $pos = 0;
1963
1964     foreach ($parts as $key => $part) {
1965         $parts[$key] = substr($haystack, $pos, strlen($part));
1966         $pos += strlen($part);
1967
1968         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
1969         $pos += strlen($needle);
1970     }
1971
1972     return str_replace('<span class="highlight"></span>', '', join('', $parts));
1973 }
1974
1975 /**
1976  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
1977  *
1978  * Internationalisation, for print_header and backup/restorelib.
1979  *
1980  * @param bool $dir Default false
1981  * @return string Attributes
1982  */
1983 function get_html_lang($dir = false) {
1984     $direction = '';
1985     if ($dir) {
1986         if (right_to_left()) {
1987             $direction = ' dir="rtl"';
1988         } else {
1989             $direction = ' dir="ltr"';
1990         }
1991     }
1992     // Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
1993     $language = str_replace('_', '-', current_language());
1994     @header('Content-Language: '.$language);
1995     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
1996 }
1997
1998
1999 // STANDARD WEB PAGE PARTS.
2000
2001 /**
2002  * Send the HTTP headers that Moodle requires.
2003  *
2004  * There is a backwards compatibility hack for legacy code
2005  * that needs to add custom IE compatibility directive.
2006  *
2007  * Example:
2008  * <code>
2009  * if (!isset($CFG->additionalhtmlhead)) {
2010  *     $CFG->additionalhtmlhead = '';
2011  * }
2012  * $CFG->additionalhtmlhead .= '<meta http-equiv="X-UA-Compatible" content="IE=8" />';
2013  * header('X-UA-Compatible: IE=8');
2014  * echo $OUTPUT->header();
2015  * </code>
2016  *
2017  * Please note the $CFG->additionalhtmlhead alone might not work,
2018  * you should send the IE compatibility header() too.
2019  *
2020  * @param string $contenttype
2021  * @param bool $cacheable Can this page be cached on back?
2022  * @return void, sends HTTP headers
2023  */
2024 function send_headers($contenttype, $cacheable = true) {
2025     global $CFG;
2026
2027     @header('Content-Type: ' . $contenttype);
2028     @header('Content-Script-Type: text/javascript');
2029     @header('Content-Style-Type: text/css');
2030
2031     if (empty($CFG->additionalhtmlhead) or stripos($CFG->additionalhtmlhead, 'X-UA-Compatible') === false) {
2032         @header('X-UA-Compatible: IE=edge');
2033     }
2034
2035     if ($cacheable) {
2036         // Allow caching on "back" (but not on normal clicks).
2037         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0, no-transform');
2038         @header('Pragma: no-cache');
2039         @header('Expires: ');
2040     } else {
2041         // Do everything we can to always prevent clients and proxies caching.
2042         @header('Cache-Control: no-store, no-cache, must-revalidate');
2043         @header('Cache-Control: post-check=0, pre-check=0, no-transform', false);
2044         @header('Pragma: no-cache');
2045         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2046         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2047     }
2048     @header('Accept-Ranges: none');
2049
2050     if (empty($CFG->allowframembedding)) {
2051         @header('X-Frame-Options: sameorigin');
2052     }
2053 }
2054
2055 /**
2056  * Return the right arrow with text ('next'), and optionally embedded in a link.
2057  *
2058  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2059  * @param string $url An optional link to use in a surrounding HTML anchor.
2060  * @param bool $accesshide True if text should be hidden (for screen readers only).
2061  * @param string $addclass Additional class names for the link, or the arrow character.
2062  * @return string HTML string.
2063  */
2064 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
2065     global $OUTPUT; // TODO: move to output renderer.
2066     $arrowclass = 'arrow ';
2067     if (!$url) {
2068         $arrowclass .= $addclass;
2069     }
2070     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->rarrow().'</span>';
2071     $htmltext = '';
2072     if ($text) {
2073         $htmltext = '<span class="arrow_text">'.$text.'</span>&nbsp;';
2074         if ($accesshide) {
2075             $htmltext = get_accesshide($htmltext);
2076         }
2077     }
2078     if ($url) {
2079         $class = 'arrow_link';
2080         if ($addclass) {
2081             $class .= ' '.$addclass;
2082         }
2083         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/', '', $text).'">'.$htmltext.$arrow.'</a>';
2084     }
2085     return $htmltext.$arrow;
2086 }
2087
2088 /**
2089  * Return the left arrow with text ('previous'), and optionally embedded in a link.
2090  *
2091  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
2092  * @param string $url An optional link to use in a surrounding HTML anchor.
2093  * @param bool $accesshide True if text should be hidden (for screen readers only).
2094  * @param string $addclass Additional class names for the link, or the arrow character.
2095  * @return string HTML string.
2096  */
2097 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
2098     global $OUTPUT; // TODO: move to utput renderer.
2099     $arrowclass = 'arrow ';
2100     if (! $url) {
2101         $arrowclass .= $addclass;
2102     }
2103     $arrow = '<span class="'.$arrowclass.'">'.$OUTPUT->larrow().'</span>';
2104     $htmltext = '';
2105     if ($text) {
2106         $htmltext = '&nbsp;<span class="arrow_text">'.$text.'</span>';
2107         if ($accesshide) {
2108             $htmltext = get_accesshide($htmltext);
2109         }
2110     }
2111     if ($url) {
2112         $class = 'arrow_link';
2113         if ($addclass) {
2114             $class .= ' '.$addclass;
2115         }
2116         return '<a class="'.$class.'" href="'.$url.'" title="'.preg_replace('/<.*?>/', '', $text).'">'.$arrow.$htmltext.'</a>';
2117     }
2118     return $arrow.$htmltext;
2119 }
2120
2121 /**
2122  * Return a HTML element with the class "accesshide", for accessibility.
2123  *
2124  * Please use cautiously - where possible, text should be visible!
2125  *
2126  * @param string $text Plain text.
2127  * @param string $elem Lowercase element name, default "span".
2128  * @param string $class Additional classes for the element.
2129  * @param string $attrs Additional attributes string in the form, "name='value' name2='value2'"
2130  * @return string HTML string.
2131  */
2132 function get_accesshide($text, $elem='span', $class='', $attrs='') {
2133     return "<$elem class=\"accesshide $class\" $attrs>$text</$elem>";
2134 }
2135
2136 /**
2137  * Return the breadcrumb trail navigation separator.
2138  *
2139  * @return string HTML string.
2140  */
2141 function get_separator() {
2142     // Accessibility: the 'hidden' slash is preferred for screen readers.
2143     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
2144 }
2145
2146 /**
2147  * Print (or return) a collapsible region, that has a caption that can be clicked to expand or collapse the region.
2148  *
2149  * If JavaScript is off, then the region will always be expanded.
2150  *
2151  * @param string $contents the contents of the box.
2152  * @param string $classes class names added to the div that is output.
2153  * @param string $id id added to the div that is output. Must not be blank.
2154  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2155  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2156  *      (May be blank if you do not wish the state to be persisted.
2157  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2158  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2159  * @return string|void If $return is false, returns nothing, otherwise returns a string of HTML.
2160  */
2161 function print_collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2162     $output  = print_collapsible_region_start($classes, $id, $caption, $userpref, $default, true);
2163     $output .= $contents;
2164     $output .= print_collapsible_region_end(true);
2165
2166     if ($return) {
2167         return $output;
2168     } else {
2169         echo $output;
2170     }
2171 }
2172
2173 /**
2174  * Print (or return) the start of a collapsible region
2175  *
2176  * The collapsibleregion has a caption that can be clicked to expand or collapse the region. If JavaScript is off, then the region
2177  * will always be expanded.
2178  *
2179  * @param string $classes class names added to the div that is output.
2180  * @param string $id id added to the div that is output. Must not be blank.
2181  * @param string $caption text displayed at the top. Clicking on this will cause the region to expand or contract.
2182  * @param string $userpref the name of the user preference that stores the user's preferred default state.
2183  *      (May be blank if you do not wish the state to be persisted.
2184  * @param boolean $default Initial collapsed state to use if the user_preference it not set.
2185  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2186  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2187  */
2188 function print_collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false, $return = false) {
2189     global $PAGE;
2190
2191     // Work out the initial state.
2192     if (!empty($userpref) and is_string($userpref)) {
2193         user_preference_allow_ajax_update($userpref, PARAM_BOOL);
2194         $collapsed = get_user_preferences($userpref, $default);
2195     } else {
2196         $collapsed = $default;
2197         $userpref = false;
2198     }
2199
2200     if ($collapsed) {
2201         $classes .= ' collapsed';
2202     }
2203
2204     $output = '';
2205     $output .= '<div id="' . $id . '" class="collapsibleregion ' . $classes . '">';
2206     $output .= '<div id="' . $id . '_sizer">';
2207     $output .= '<div id="' . $id . '_caption" class="collapsibleregioncaption">';
2208     $output .= $caption . ' ';
2209     $output .= '</div><div id="' . $id . '_inner" class="collapsibleregioninner">';
2210     $PAGE->requires->js_init_call('M.util.init_collapsible_region', array($id, $userpref, get_string('clicktohideshow')));
2211
2212     if ($return) {
2213         return $output;
2214     } else {
2215         echo $output;
2216     }
2217 }
2218
2219 /**
2220  * Close a region started with print_collapsible_region_start.
2221  *
2222  * @param boolean $return if true, return the HTML as a string, rather than printing it.
2223  * @return string|void if $return is false, returns nothing, otherwise returns a string of HTML.
2224  */
2225 function print_collapsible_region_end($return = false) {
2226     $output = '</div></div></div>';
2227
2228     if ($return) {
2229         return $output;
2230     } else {
2231         echo $output;
2232     }
2233 }
2234
2235 /**
2236  * Print a specified group's avatar.
2237  *
2238  * @param array|stdClass $group A single {@link group} object OR array of groups.
2239  * @param int $courseid The course ID.
2240  * @param boolean $large Default small picture, or large.
2241  * @param boolean $return If false print picture, otherwise return the output as string
2242  * @param boolean $link Enclose image in a link to view specified course?
2243  * @return string|void Depending on the setting of $return
2244  */
2245 function print_group_picture($group, $courseid, $large=false, $return=false, $link=true) {
2246     global $CFG;
2247
2248     if (is_array($group)) {
2249         $output = '';
2250         foreach ($group as $g) {
2251             $output .= print_group_picture($g, $courseid, $large, true, $link);
2252         }
2253         if ($return) {
2254             return $output;
2255         } else {
2256             echo $output;
2257             return;
2258         }
2259     }
2260
2261     $context = context_course::instance($courseid);
2262
2263     // If there is no picture, do nothing.
2264     if (!$group->picture) {
2265         return '';
2266     }
2267
2268     // If picture is hidden, only show to those with course:managegroups.
2269     if ($group->hidepicture and !has_capability('moodle/course:managegroups', $context)) {
2270         return '';
2271     }
2272
2273     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2274         $output = '<a href="'. $CFG->wwwroot .'/user/index.php?id='. $courseid .'&amp;group='. $group->id .'">';
2275     } else {
2276         $output = '';
2277     }
2278     if ($large) {
2279         $file = 'f1';
2280     } else {
2281         $file = 'f2';
2282     }
2283
2284     $grouppictureurl = moodle_url::make_pluginfile_url($context->id, 'group', 'icon', $group->id, '/', $file);
2285     $output .= '<img class="grouppicture" src="'.$grouppictureurl.'"'.
2286         ' alt="'.s(get_string('group').' '.$group->name).'" title="'.s($group->name).'"/>';
2287
2288     if ($link or has_capability('moodle/site:accessallgroups', $context)) {
2289         $output .= '</a>';
2290     }
2291
2292     if ($return) {
2293         return $output;
2294     } else {
2295         echo $output;
2296     }
2297 }
2298
2299
2300 /**
2301  * Display a recent activity note
2302  *
2303  * @staticvar string $strftimerecent
2304  * @param int $time A timestamp int.
2305  * @param stdClass $user A user object from the database.
2306  * @param string $text Text for display for the note
2307  * @param string $link The link to wrap around the text
2308  * @param bool $return If set to true the HTML is returned rather than echo'd
2309  * @param string $viewfullnames
2310  * @return string If $retrun was true returns HTML for a recent activity notice.
2311  */
2312 function print_recent_activity_note($time, $user, $text, $link, $return=false, $viewfullnames=null) {
2313     static $strftimerecent = null;
2314     $output = '';
2315
2316     if (is_null($viewfullnames)) {
2317         $context = context_system::instance();
2318         $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2319     }
2320
2321     if (is_null($strftimerecent)) {
2322         $strftimerecent = get_string('strftimerecent');
2323     }
2324
2325     $output .= '<div class="head">';
2326     $output .= '<div class="date">'.userdate($time, $strftimerecent).'</div>';
2327     $output .= '<div class="name">'.fullname($user, $viewfullnames).'</div>';
2328     $output .= '</div>';
2329     $output .= '<div class="info"><a href="'.$link.'">'.format_string($text, true).'</a></div>';
2330
2331     if ($return) {
2332         return $output;
2333     } else {
2334         echo $output;
2335     }
2336 }
2337
2338 /**
2339  * Returns a popup menu with course activity modules
2340  *
2341  * Given a course this function returns a small popup menu with all the course activity modules in it, as a navigation menu
2342  * outputs a simple list structure in XHTML.
2343  * The data is taken from the serialised array stored in the course record.
2344  *
2345  * @param course $course A {@link $COURSE} object.
2346  * @param array $sections
2347  * @param course_modinfo $modinfo
2348  * @param string $strsection
2349  * @param string $strjumpto
2350  * @param int $width
2351  * @param string $cmid
2352  * @return string The HTML block
2353  */
2354 function navmenulist($course, $sections, $modinfo, $strsection, $strjumpto, $width=50, $cmid=0) {
2355
2356     global $CFG, $OUTPUT;
2357
2358     $section = -1;
2359     $menu = array();
2360     $doneheading = false;
2361
2362     $courseformatoptions = course_get_format($course)->get_format_options();
2363     $coursecontext = context_course::instance($course->id);
2364
2365     $menu[] = '<ul class="navmenulist"><li class="jumpto section"><span>'.$strjumpto.'</span><ul>';
2366     foreach ($modinfo->cms as $mod) {
2367         if (!$mod->has_view()) {
2368             // Don't show modules which you can't link to!
2369             continue;
2370         }
2371
2372         // For course formats using 'numsections' do not show extra sections.
2373         if (isset($courseformatoptions['numsections']) && $mod->sectionnum > $courseformatoptions['numsections']) {
2374             break;
2375         }
2376
2377         if (!$mod->uservisible) { // Do not icnlude empty sections at all.
2378             continue;
2379         }
2380
2381         if ($mod->sectionnum >= 0 and $section != $mod->sectionnum) {
2382             $thissection = $sections[$mod->sectionnum];
2383
2384             if ($thissection->visible or
2385                     (isset($courseformatoptions['hiddensections']) and !$courseformatoptions['hiddensections']) or
2386                     has_capability('moodle/course:viewhiddensections', $coursecontext)) {
2387                 $thissection->summary = strip_tags(format_string($thissection->summary, true));
2388                 if (!$doneheading) {
2389                     $menu[] = '</ul></li>';
2390                 }
2391                 if ($course->format == 'weeks' or empty($thissection->summary)) {
2392                     $item = $strsection ." ". $mod->sectionnum;
2393                 } else {
2394                     if (core_text::strlen($thissection->summary) < ($width-3)) {
2395                         $item = $thissection->summary;
2396                     } else {
2397                         $item = core_text::substr($thissection->summary, 0, $width).'...';
2398                     }
2399                 }
2400                 $menu[] = '<li class="section"><span>'.$item.'</span>';
2401                 $menu[] = '<ul>';
2402                 $doneheading = true;
2403
2404                 $section = $mod->sectionnum;
2405             } else {
2406                 // No activities from this hidden section shown.
2407                 continue;
2408             }
2409         }
2410
2411         $url = $mod->modname .'/view.php?id='. $mod->id;
2412         $mod->name = strip_tags(format_string($mod->name ,true));
2413         if (core_text::strlen($mod->name) > ($width+5)) {
2414             $mod->name = core_text::substr($mod->name, 0, $width).'...';
2415         }
2416         if (!$mod->visible) {
2417             $mod->name = '('.$mod->name.')';
2418         }
2419         $class = 'activity '.$mod->modname;
2420         $class .= ($cmid == $mod->id) ? ' selected' : '';
2421         $menu[] = '<li class="'.$class.'">'.
2422                   '<img src="'.$OUTPUT->pix_url('icon', $mod->modname) . '" alt="" />'.
2423                   '<a href="'.$CFG->wwwroot.'/mod/'.$url.'">'.$mod->name.'</a></li>';
2424     }
2425
2426     if ($doneheading) {
2427         $menu[] = '</ul></li>';
2428     }
2429     $menu[] = '</ul></li></ul>';
2430
2431     return implode("\n", $menu);
2432 }
2433
2434 /**
2435  * Prints a grade menu (as part of an existing form) with help showing all possible numerical grades and scales.
2436  *
2437  * @todo Finish documenting this function
2438  * @todo Deprecate: this is only used in a few contrib modules
2439  *
2440  * @param int $courseid The course ID
2441  * @param string $name
2442  * @param string $current
2443  * @param boolean $includenograde Include those with no grades
2444  * @param boolean $return If set to true returns rather than echo's
2445  * @return string|bool Depending on value of $return
2446  */
2447 function print_grade_menu($courseid, $name, $current, $includenograde=true, $return=false) {
2448     global $OUTPUT;
2449
2450     $output = '';
2451     $strscale = get_string('scale');
2452     $strscales = get_string('scales');
2453
2454     $scales = get_scales_menu($courseid);
2455     foreach ($scales as $i => $scalename) {
2456         $grades[-$i] = $strscale .': '. $scalename;
2457     }
2458     if ($includenograde) {
2459         $grades[0] = get_string('nograde');
2460     }
2461     for ($i=100; $i>=1; $i--) {
2462         $grades[$i] = $i;
2463     }
2464     $output .= html_writer::select($grades, $name, $current, false);
2465
2466     $helppix = $OUTPUT->pix_url('help');
2467     $linkobject = '<span class="helplink"><img class="iconhelp" alt="'.$strscales.'" src="'.$helppix.'" /></span>';
2468     $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => 1));
2469     $action = new popup_action('click', $link, 'ratingscales', array('height' => 400, 'width' => 500));
2470     $output .= $OUTPUT->action_link($link, $linkobject, $action, array('title' => $strscales));
2471
2472     if ($return) {
2473         return $output;
2474     } else {
2475         echo $output;
2476     }
2477 }
2478
2479 /**
2480  * Print an error to STDOUT and exit with a non-zero code. For commandline scripts.
2481  *
2482  * Default errorcode is 1.
2483  *
2484  * Very useful for perl-like error-handling:
2485  * do_somethting() or mdie("Something went wrong");
2486  *
2487  * @param string  $msg       Error message
2488  * @param integer $errorcode Error code to emit
2489  */
2490 function mdie($msg='', $errorcode=1) {
2491     trigger_error($msg);
2492     exit($errorcode);
2493 }
2494
2495 /**
2496  * Print a message and exit.
2497  *
2498  * @param string $message The message to print in the notice
2499  * @param string $link The link to use for the continue button
2500  * @param object $course A course object. Unused.
2501  * @return void This function simply exits
2502  */
2503 function notice ($message, $link='', $course=null) {
2504     global $PAGE, $OUTPUT;
2505
2506     $message = clean_text($message);   // In case nasties are in here.
2507
2508     if (CLI_SCRIPT) {
2509         echo("!!$message!!\n");
2510         exit(1); // No success.
2511     }
2512
2513     if (!$PAGE->headerprinted) {
2514         // Header not yet printed.
2515         $PAGE->set_title(get_string('notice'));
2516         echo $OUTPUT->header();
2517     } else {
2518         echo $OUTPUT->container_end_all(false);
2519     }
2520
2521     echo $OUTPUT->box($message, 'generalbox', 'notice');
2522     echo $OUTPUT->continue_button($link);
2523
2524     echo $OUTPUT->footer();
2525     exit(1); // General error code.
2526 }
2527
2528 /**
2529  * Redirects the user to another page, after printing a notice.
2530  *
2531  * This function calls the OUTPUT redirect method, echo's the output and then dies to ensure nothing else happens.
2532  *
2533  * <strong>Good practice:</strong> You should call this method before starting page
2534  * output by using any of the OUTPUT methods.
2535  *
2536  * @param moodle_url|string $url A moodle_url to redirect to. Strings are not to be trusted!
2537  * @param string $message The message to display to the user
2538  * @param int $delay The delay before redirecting
2539  * @throws moodle_exception
2540  */
2541 function redirect($url, $message='', $delay=-1) {
2542     global $OUTPUT, $PAGE, $CFG;
2543
2544     if (CLI_SCRIPT or AJAX_SCRIPT) {
2545         // This is wrong - developers should not use redirect in these scripts but it should not be very likely.
2546         throw new moodle_exception('redirecterrordetected', 'error');
2547     }
2548
2549     // Prevent debug errors - make sure context is properly initialised.
2550     if ($PAGE) {
2551         $PAGE->set_context(null);
2552         $PAGE->set_pagelayout('redirect');  // No header and footer needed.
2553     }
2554
2555     if ($url instanceof moodle_url) {
2556         $url = $url->out(false);
2557     }
2558
2559     $debugdisableredirect = false;
2560     do {
2561         if (defined('DEBUGGING_PRINTED')) {
2562             // Some debugging already printed, no need to look more.
2563             $debugdisableredirect = true;
2564             break;
2565         }
2566
2567         if (empty($CFG->debugdisplay) or empty($CFG->debug)) {
2568             // No errors should be displayed.
2569             break;
2570         }
2571
2572         if (!function_exists('error_get_last') or !$lasterror = error_get_last()) {
2573             break;
2574         }
2575
2576         if (!($lasterror['type'] & $CFG->debug)) {
2577             // Last error not interesting.
2578             break;
2579         }
2580
2581         // Watch out here, @hidden() errors are returned from error_get_last() too.
2582         if (headers_sent()) {
2583             // We already started printing something - that means errors likely printed.
2584             $debugdisableredirect = true;
2585             break;
2586         }
2587
2588         if (ob_get_level() and ob_get_contents()) {
2589             // There is something waiting to be printed, hopefully it is the errors,
2590             // but it might be some error hidden by @ too - such as the timezone mess from setup.php.
2591             $debugdisableredirect = true;
2592             break;
2593         }
2594     } while (false);
2595
2596     // Technically, HTTP/1.1 requires Location: header to contain the absolute path.
2597     // (In practice browsers accept relative paths - but still, might as well do it properly.)
2598     // This code turns relative into absolute.
2599     if (!preg_match('|^[a-z]+:|', $url)) {
2600         // Get host name http://www.wherever.com.
2601         $hostpart = preg_replace('|^(.*?[^:/])/.*$|', '$1', $CFG->wwwroot);
2602         if (preg_match('|^/|', $url)) {
2603             // URLs beginning with / are relative to web server root so we just add them in.
2604             $url = $hostpart.$url;
2605         } else {
2606             // URLs not beginning with / are relative to path of current script, so add that on.
2607             $url = $hostpart.preg_replace('|\?.*$|', '', me()).'/../'.$url;
2608         }
2609         // Replace all ..s.
2610         while (true) {
2611             $newurl = preg_replace('|/(?!\.\.)[^/]*/\.\./|', '/', $url);
2612             if ($newurl == $url) {
2613                 break;
2614             }
2615             $url = $newurl;
2616         }
2617     }
2618
2619     // Sanitise url - we can not rely on moodle_url or our URL cleaning
2620     // because they do not support all valid external URLs.
2621     $url = preg_replace('/[\x00-\x1F\x7F]/', '', $url);
2622     $url = str_replace('"', '%22', $url);
2623     $encodedurl = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $url);
2624     $encodedurl = preg_replace('/^.*href="([^"]*)".*$/', "\\1", clean_text('<a href="'.$encodedurl.'" />', FORMAT_HTML));
2625     $url = str_replace('&amp;', '&', $encodedurl);
2626
2627     if (!empty($message)) {
2628         if ($delay === -1 || !is_numeric($delay)) {
2629             $delay = 3;
2630         }
2631         $message = clean_text($message);
2632     } else {
2633         $message = get_string('pageshouldredirect');
2634         $delay = 0;
2635     }
2636
2637     // Make sure the session is closed properly, this prevents problems in IIS
2638     // and also some potential PHP shutdown issues.
2639     \core\session\manager::write_close();
2640
2641     if ($delay == 0 && !$debugdisableredirect && !headers_sent()) {
2642         // 302 might not work for POST requests, 303 is ignored by obsolete clients.
2643         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
2644         @header('Location: '.$url);
2645         echo bootstrap_renderer::plain_redirect_message($encodedurl);
2646         exit;
2647     }
2648
2649     // Include a redirect message, even with a HTTP redirect, because that is recommended practice.
2650     if ($PAGE) {
2651         $CFG->docroot = false; // To prevent the link to moodle docs from being displayed on redirect page.
2652         echo $OUTPUT->redirect_message($encodedurl, $message, $delay, $debugdisableredirect);
2653         exit;
2654     } else {
2655         echo bootstrap_renderer::early_redirect_message($encodedurl, $message, $delay);
2656         exit;
2657     }
2658 }
2659
2660 /**
2661  * Given an email address, this function will return an obfuscated version of it.
2662  *
2663  * @param string $email The email address to obfuscate
2664  * @return string The obfuscated email address
2665  */
2666 function obfuscate_email($email) {
2667     $i = 0;
2668     $length = strlen($email);
2669     $obfuscated = '';
2670     while ($i < $length) {
2671         if (rand(0, 2) && $email{$i}!='@') { // MDL-20619 some browsers have problems unobfuscating @.
2672             $obfuscated.='%'.dechex(ord($email{$i}));
2673         } else {
2674             $obfuscated.=$email{$i};
2675         }
2676         $i++;
2677     }
2678     return $obfuscated;
2679 }
2680
2681 /**
2682  * This function takes some text and replaces about half of the characters
2683  * with HTML entity equivalents.   Return string is obviously longer.
2684  *
2685  * @param string $plaintext The text to be obfuscated
2686  * @return string The obfuscated text
2687  */
2688 function obfuscate_text($plaintext) {
2689     $i=0;
2690     $length = core_text::strlen($plaintext);
2691     $obfuscated='';
2692     $prevobfuscated = false;
2693     while ($i < $length) {
2694         $char = core_text::substr($plaintext, $i, 1);
2695         $ord = core_text::utf8ord($char);
2696         $numerical = ($ord >= ord('0')) && ($ord <= ord('9'));
2697         if ($prevobfuscated and $numerical ) {
2698             $obfuscated.='&#'.$ord.';';
2699         } else if (rand(0, 2)) {
2700             $obfuscated.='&#'.$ord.';';
2701             $prevobfuscated = true;
2702         } else {
2703             $obfuscated.=$char;
2704             $prevobfuscated = false;
2705         }
2706         $i++;
2707     }
2708     return $obfuscated;
2709 }
2710
2711 /**
2712  * This function uses the {@link obfuscate_email()} and {@link obfuscate_text()}
2713  * to generate a fully obfuscated email link, ready to use.
2714  *
2715  * @param string $email The email address to display
2716  * @param string $label The text to displayed as hyperlink to $email
2717  * @param boolean $dimmed If true then use css class 'dimmed' for hyperlink
2718  * @param string $subject The subject of the email in the mailto link
2719  * @param string $body The content of the email in the mailto link
2720  * @return string The obfuscated mailto link
2721  */
2722 function obfuscate_mailto($email, $label='', $dimmed=false, $subject = '', $body = '') {
2723
2724     if (empty($label)) {
2725         $label = $email;
2726     }
2727
2728     $label = obfuscate_text($label);
2729     $email = obfuscate_email($email);
2730     $mailto = obfuscate_text('mailto');
2731     $url = new moodle_url("mailto:$email");
2732     $attrs = array();
2733
2734     if (!empty($subject)) {
2735         $url->param('subject', format_string($subject));
2736     }
2737     if (!empty($body)) {
2738         $url->param('body', format_string($body));
2739     }
2740
2741     // Use the obfuscated mailto.
2742     $url = preg_replace('/^mailto/', $mailto, $url->out());
2743
2744     if ($dimmed) {
2745         $attrs['title'] = get_string('emaildisable');
2746         $attrs['class'] = 'dimmed';
2747     }
2748
2749     return html_writer::link($url, $label, $attrs);
2750 }
2751
2752 /**
2753  * This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI)
2754  * will transform it to html entities
2755  *
2756  * @param string $text Text to search for nolink tag in
2757  * @return string
2758  */
2759 function rebuildnolinktag($text) {
2760
2761     $text = preg_replace('/&lt;(\/*nolink)&gt;/i', '<$1>', $text);
2762
2763     return $text;
2764 }
2765
2766 /**
2767  * Prints a maintenance message from $CFG->maintenance_message or default if empty.
2768  */
2769 function print_maintenance_message() {
2770     global $CFG, $SITE, $PAGE, $OUTPUT;
2771
2772     $PAGE->set_pagetype('maintenance-message');
2773     $PAGE->set_pagelayout('maintenance');
2774     $PAGE->set_title(strip_tags($SITE->fullname));
2775     $PAGE->set_heading($SITE->fullname);
2776     echo $OUTPUT->header();
2777     echo $OUTPUT->heading(get_string('sitemaintenance', 'admin'));
2778     if (isset($CFG->maintenance_message) and !html_is_blank($CFG->maintenance_message)) {
2779         echo $OUTPUT->box_start('maintenance_message generalbox boxwidthwide boxaligncenter');
2780         echo $CFG->maintenance_message;
2781         echo $OUTPUT->box_end();
2782     }
2783     echo $OUTPUT->footer();
2784     die;
2785 }
2786
2787 /**
2788  * Returns a string containing a nested list, suitable for formatting into tabs with CSS.
2789  *
2790  * It is not recommended to use this function in Moodle 2.5 but it is left for backward
2791  * compartibility.
2792  *
2793  * Example how to print a single line tabs:
2794  * $rows = array(
2795  *    new tabobject(...),
2796  *    new tabobject(...)
2797  * );
2798  * echo $OUTPUT->tabtree($rows, $selectedid);
2799  *
2800  * Multiple row tabs may not look good on some devices but if you want to use them
2801  * you can specify ->subtree for the active tabobject.
2802  *
2803  * @param array $tabrows An array of rows where each row is an array of tab objects
2804  * @param string $selected  The id of the selected tab (whatever row it's on)
2805  * @param array  $inactive  An array of ids of inactive tabs that are not selectable.
2806  * @param array  $activated An array of ids of other tabs that are currently activated
2807  * @param bool $return If true output is returned rather then echo'd
2808  * @return string HTML output if $return was set to true.
2809  */
2810 function print_tabs($tabrows, $selected = null, $inactive = null, $activated = null, $return = false) {
2811     global $OUTPUT;
2812
2813     $tabrows = array_reverse($tabrows);
2814     $subtree = array();
2815     foreach ($tabrows as $row) {
2816         $tree = array();
2817
2818         foreach ($row as $tab) {
2819             $tab->inactive = is_array($inactive) && in_array((string)$tab->id, $inactive);
2820             $tab->activated = is_array($activated) && in_array((string)$tab->id, $activated);
2821             $tab->selected = (string)$tab->id == $selected;
2822
2823             if ($tab->activated || $tab->selected) {
2824                 $tab->subtree = $subtree;
2825             }
2826             $tree[] = $tab;
2827         }
2828         $subtree = $tree;
2829     }
2830     $output = $OUTPUT->tabtree($subtree);
2831     if ($return) {
2832         return $output;
2833     } else {
2834         print $output;
2835         return !empty($output);
2836     }
2837 }
2838
2839 /**
2840  * Alter debugging level for the current request,
2841  * the change is not saved in database.
2842  *
2843  * @param int $level one of the DEBUG_* constants
2844  * @param bool $debugdisplay
2845  */
2846 function set_debugging($level, $debugdisplay = null) {
2847     global $CFG;
2848
2849     $CFG->debug = (int)$level;
2850     $CFG->debugdeveloper = (($CFG->debug & DEBUG_DEVELOPER) === DEBUG_DEVELOPER);
2851
2852     if ($debugdisplay !== null) {
2853         $CFG->debugdisplay = (bool)$debugdisplay;
2854     }
2855 }
2856
2857 /**
2858  * Standard Debugging Function
2859  *
2860  * Returns true if the current site debugging settings are equal or above specified level.
2861  * If passed a parameter it will emit a debugging notice similar to trigger_error(). The
2862  * routing of notices is controlled by $CFG->debugdisplay
2863  * eg use like this:
2864  *
2865  * 1)  debugging('a normal debug notice');
2866  * 2)  debugging('something really picky', DEBUG_ALL);
2867  * 3)  debugging('annoying debug message only for developers', DEBUG_DEVELOPER);
2868  * 4)  if (debugging()) { perform extra debugging operations (do not use print or echo) }
2869  *
2870  * In code blocks controlled by debugging() (such as example 4)
2871  * any output should be routed via debugging() itself, or the lower-level
2872  * trigger_error() or error_log(). Using echo or print will break XHTML
2873  * JS and HTTP headers.
2874  *
2875  * It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.
2876  *
2877  * @param string $message a message to print
2878  * @param int $level the level at which this debugging statement should show
2879  * @param array $backtrace use different backtrace
2880  * @return bool
2881  */
2882 function debugging($message = '', $level = DEBUG_NORMAL, $backtrace = null) {
2883     global $CFG, $USER;
2884
2885     $forcedebug = false;
2886     if (!empty($CFG->debugusers) && $USER) {
2887         $debugusers = explode(',', $CFG->debugusers);
2888         $forcedebug = in_array($USER->id, $debugusers);
2889     }
2890
2891     if (!$forcedebug and (empty($CFG->debug) || ($CFG->debug != -1 and $CFG->debug < $level))) {
2892         return false;
2893     }
2894
2895     if (!isset($CFG->debugdisplay)) {
2896         $CFG->debugdisplay = ini_get_bool('display_errors');
2897     }
2898
2899     if ($message) {
2900         if (!$backtrace) {
2901             $backtrace = debug_backtrace();
2902         }
2903         $from = format_backtrace($backtrace, CLI_SCRIPT);
2904         if (PHPUNIT_TEST) {
2905             if (phpunit_util::debugging_triggered($message, $level, $from)) {
2906                 // We are inside test, the debug message was logged.
2907                 return true;
2908             }
2909         }
2910
2911         if (NO_DEBUG_DISPLAY) {
2912             // Script does not want any errors or debugging in output,
2913             // we send the info to error log instead.
2914             error_log('Debugging: ' . $message . $from);
2915
2916         } else if ($forcedebug or $CFG->debugdisplay) {
2917             if (!defined('DEBUGGING_PRINTED')) {
2918                 define('DEBUGGING_PRINTED', 1); // Indicates we have printed something.
2919             }
2920             if (CLI_SCRIPT) {
2921                 echo "++ $message ++\n$from";
2922             } else {
2923                 echo '<div class="notifytiny debuggingmessage" data-rel="debugging">' , $message , $from , '</div>';
2924             }
2925
2926         } else {
2927             trigger_error($message . $from, E_USER_NOTICE);
2928         }
2929     }
2930     return true;
2931 }
2932
2933 /**
2934  * Outputs a HTML comment to the browser.
2935  *
2936  * This is used for those hard-to-debug pages that use bits from many different files in very confusing ways (e.g. blocks).
2937  *
2938  * <code>print_location_comment(__FILE__, __LINE__);</code>
2939  *
2940  * @param string $file
2941  * @param integer $line
2942  * @param boolean $return Whether to return or print the comment
2943  * @return string|void Void unless true given as third parameter
2944  */
2945 function print_location_comment($file, $line, $return = false) {
2946     if ($return) {
2947         return "<!-- $file at line $line -->\n";
2948     } else {
2949         echo "<!-- $file at line $line -->\n";
2950     }
2951 }
2952
2953
2954 /**
2955  * Returns true if the user is using a right-to-left language.
2956  *
2957  * @return boolean true if the current language is right-to-left (Hebrew, Arabic etc)
2958  */
2959 function right_to_left() {
2960     return (get_string('thisdirection', 'langconfig') === 'rtl');
2961 }
2962
2963
2964 /**
2965  * Returns swapped left<=> right if in RTL environment.
2966  *
2967  * Part of RTL Moodles support.
2968  *
2969  * @param string $align align to check
2970  * @return string
2971  */
2972 function fix_align_rtl($align) {
2973     if (!right_to_left()) {
2974         return $align;
2975     }
2976     if ($align == 'left') {
2977         return 'right';
2978     }
2979     if ($align == 'right') {
2980         return 'left';
2981     }
2982     return $align;
2983 }
2984
2985
2986 /**
2987  * Returns true if the page is displayed in a popup window.
2988  *
2989  * Gets the information from the URL parameter inpopup.
2990  *
2991  * @todo Use a central function to create the popup calls all over Moodle and
2992  * In the moment only works with resources and probably questions.
2993  *
2994  * @return boolean
2995  */
2996 function is_in_popup() {
2997     $inpopup = optional_param('inpopup', '', PARAM_BOOL);
2998
2999     return ($inpopup);
3000 }
3001
3002 /**
3003  * Progress bar class.
3004  *
3005  * Manages the display of a progress bar.
3006  *
3007  * To use this class.
3008  * - construct
3009  * - call create (or use the 3rd param to the constructor)
3010  * - call update or update_full() or update() repeatedly
3011  *
3012  * @copyright 2008 jamiesensei
3013  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3014  * @package core
3015  */
3016 class progress_bar {
3017     /** @var string html id */
3018     private $html_id;
3019     /** @var int total width */
3020     private $width;
3021     /** @var int last percentage printed */
3022     private $percent = 0;
3023     /** @var int time when last printed */
3024     private $lastupdate = 0;
3025     /** @var int when did we start printing this */
3026     private $time_start = 0;
3027
3028     /**
3029      * Constructor
3030      *
3031      * Prints JS code if $autostart true.
3032      *
3033      * @param string $html_id
3034      * @param int $width
3035      * @param bool $autostart Default to false
3036      */
3037     public function __construct($htmlid = '', $width = 500, $autostart = false) {
3038         if (!empty($htmlid)) {
3039             $this->html_id  = $htmlid;
3040         } else {
3041             $this->html_id  = 'pbar_'.uniqid();
3042         }
3043
3044         $this->width = $width;
3045
3046         if ($autostart) {
3047             $this->create();
3048         }
3049     }
3050
3051     /**
3052      * Create a new progress bar, this function will output html.
3053      *
3054      * @return void Echo's output
3055      */
3056     public function create() {
3057         $this->time_start = microtime(true);
3058         if (CLI_SCRIPT) {
3059             return; // Temporary solution for cli scripts.
3060         }
3061         $widthplusborder = $this->width + 2;
3062         $htmlcode = <<<EOT
3063         <div style="text-align:center;width:{$widthplusborder}px;clear:both;padding:0;margin:0 auto;">
3064             <h2 id="status_{$this->html_id}" style="text-align: center;margin:0 auto"></h2>
3065             <p id="time_{$this->html_id}"></p>
3066             <div id="bar_{$this->html_id}" style="border-style:solid;border-width:1px;width:{$this->width}px;height:50px;">
3067                 <div id="progress_{$this->html_id}"
3068                 style="text-align:center;background:#FFCC66;width:4px;border:1px
3069                 solid gray;height:38px; padding-top:10px;">&nbsp;<span id="pt_{$this->html_id}"></span>
3070                 </div>
3071             </div>
3072         </div>
3073 EOT;
3074         flush();
3075         echo $htmlcode;
3076         flush();
3077     }
3078
3079     /**
3080      * Update the progress bar
3081      *
3082      * @param int $percent from 1-100
3083      * @param string $msg
3084      * @return void Echo's output
3085      * @throws coding_exception
3086      */
3087     private function _update($percent, $msg) {
3088         if (empty($this->time_start)) {
3089             throw new coding_exception('You must call create() (or use the $autostart ' .
3090                     'argument to the constructor) before you try updating the progress bar.');
3091         }
3092
3093         if (CLI_SCRIPT) {
3094             return; // Temporary solution for cli scripts.
3095         }
3096
3097         $es = $this->estimate($percent);
3098
3099         if ($es === null) {
3100             // Always do the first and last updates.
3101             $es = "?";
3102         } else if ($es == 0) {
3103             // Always do the last updates.
3104         } else if ($this->lastupdate + 20 < time()) {
3105             // We must update otherwise browser would time out.
3106         } else if (round($this->percent, 2) === round($percent, 2)) {
3107             // No significant change, no need to update anything.
3108             return;
3109         }
3110
3111         $this->percent = $percent;
3112         $this->lastupdate = microtime(true);
3113
3114         $w = ($this->percent/100) * $this->width;
3115         echo html_writer::script(js_writer::function_call('update_progress_bar',
3116             array($this->html_id, $w, $this->percent, $msg, $es)));
3117         flush();
3118     }
3119
3120     /**
3121      * Estimate how much time it is going to take.
3122      *
3123      * @param int $pt from 1-100
3124      * @return mixed Null (unknown), or int
3125      */
3126     private function estimate($pt) {
3127         if ($this->lastupdate == 0) {
3128             return null;
3129         }
3130         if ($pt < 0.00001) {
3131             return null; // We do not know yet how long it will take.
3132         }
3133         if ($pt > 99.99999) {
3134             return 0; // Nearly done, right?
3135         }
3136         $consumed = microtime(true) - $this->time_start;
3137         if ($consumed < 0.001) {
3138             return null;
3139         }
3140
3141         return (100 - $pt) * ($consumed / $pt);
3142     }
3143
3144     /**
3145      * Update progress bar according percent
3146      *
3147      * @param int $percent from 1-100
3148      * @param string $msg the message needed to be shown
3149      */
3150     public function update_full($percent, $msg) {
3151         $percent = max(min($percent, 100), 0);
3152         $this->_update($percent, $msg);
3153     }
3154
3155     /**
3156      * Update progress bar according the number of tasks
3157      *
3158      * @param int $cur current task number
3159      * @param int $total total task number
3160      * @param string $msg message
3161      */
3162     public function update($cur, $total, $msg) {
3163         $percent = ($cur / $total) * 100;
3164         $this->update_full($percent, $msg);
3165     }
3166
3167     /**
3168      * Restart the progress bar.
3169      */
3170     public function restart() {
3171         $this->percent    = 0;
3172         $this->lastupdate = 0;
3173         $this->time_start = 0;
3174     }
3175 }
3176
3177 /**
3178  * Progress trace class.
3179  *
3180  * Use this class from long operations where you want to output occasional information about
3181  * what is going on, but don't know if, or in what format, the output should be.
3182  *
3183  * @copyright 2009 Tim Hunt
3184  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3185  * @package core
3186  */
3187 abstract class progress_trace {
3188     /**
3189      * Output an progress message in whatever format.
3190      *
3191      * @param string $message the message to output.
3192      * @param integer $depth indent depth for this message.
3193      */
3194     abstract public function output($message, $depth = 0);
3195
3196     /**
3197      * Called when the processing is finished.
3198      */
3199     public function finished() {
3200     }
3201 }
3202
3203 /**
3204  * This subclass of progress_trace does not ouput anything.
3205  *
3206  * @copyright 2009 Tim Hunt
3207  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3208  * @package core
3209  */
3210 class null_progress_trace extends progress_trace {
3211     /**
3212      * Does Nothing
3213      *
3214      * @param string $message
3215      * @param int $depth
3216      * @return void Does Nothing
3217      */
3218     public function output($message, $depth = 0) {
3219     }
3220 }
3221
3222 /**
3223  * This subclass of progress_trace outputs to plain text.
3224  *
3225  * @copyright 2009 Tim Hunt
3226  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3227  * @package core
3228  */
3229 class text_progress_trace extends progress_trace {
3230     /**
3231      * Output the trace message.
3232      *
3233      * @param string $message
3234      * @param int $depth
3235      * @return void Output is echo'd
3236      */
3237     public function output($message, $depth = 0) {
3238         echo str_repeat('  ', $depth), $message, "\n";
3239         flush();
3240     }
3241 }
3242
3243 /**
3244  * This subclass of progress_trace outputs as HTML.
3245  *
3246  * @copyright 2009 Tim Hunt
3247  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3248  * @package core
3249  */
3250 class html_progress_trace extends progress_trace {
3251     /**
3252      * Output the trace message.
3253      *
3254      * @param string $message
3255      * @param int $depth
3256      * @return void Output is echo'd
3257      */
3258     public function output($message, $depth = 0) {
3259         echo '<p>', str_repeat('&#160;&#160;', $depth), htmlspecialchars($message), "</p>\n";
3260         flush();
3261     }
3262 }
3263
3264 /**
3265  * HTML List Progress Tree
3266  *
3267  * @copyright 2009 Tim Hunt
3268  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3269  * @package core
3270  */
3271 class html_list_progress_trace extends progress_trace {
3272     /** @var int */
3273     protected $currentdepth = -1;
3274
3275     /**
3276      * Echo out the list
3277      *
3278      * @param string $message The message to display
3279      * @param int $depth
3280      * @return void Output is echoed
3281      */
3282     public function output($message, $depth = 0) {
3283         $samedepth = true;
3284         while ($this->currentdepth > $depth) {
3285             echo "</li>\n</ul>\n";
3286             $this->currentdepth -= 1;
3287             if ($this->currentdepth == $depth) {
3288                 echo '<li>';
3289             }
3290             $samedepth = false;
3291         }
3292         while ($this->currentdepth < $depth) {
3293             echo "<ul>\n<li>";
3294             $this->currentdepth += 1;
3295             $samedepth = false;
3296         }
3297         if ($samedepth) {
3298             echo "</li>\n<li>";
3299         }
3300         echo htmlspecialchars($message);
3301         flush();
3302     }
3303
3304     /**
3305      * Called when the processing is finished.
3306      */
3307     public function finished() {
3308         while ($this->currentdepth >= 0) {
3309             echo "</li>\n</ul>\n";
3310             $this->currentdepth -= 1;
3311         }
3312     }
3313 }
3314
3315 /**
3316  * This subclass of progress_trace outputs to error log.
3317  *
3318  * @copyright Petr Skoda {@link http://skodak.org}
3319  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3320  * @package core
3321  */
3322 class error_log_progress_trace extends progress_trace {
3323     /** @var string log prefix */
3324     protected $prefix;
3325
3326     /**
3327      * Constructor.
3328      * @param string $prefix optional log prefix
3329      */
3330     public function __construct($prefix = '') {
3331         $this->prefix = $prefix;
3332     }
3333
3334     /**
3335      * Output the trace message.
3336      *
3337      * @param string $message
3338      * @param int $depth
3339      * @return void Output is sent to error log.
3340      */
3341     public function output($message, $depth = 0) {
3342         error_log($this->prefix . str_repeat('  ', $depth) . $message);
3343     }
3344 }
3345
3346 /**
3347  * Special type of trace that can be used for catching of output of other traces.
3348  *
3349  * @copyright Petr Skoda {@link http://skodak.org}
3350  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3351  * @package core
3352  */
3353 class progress_trace_buffer extends progress_trace {
3354     /** @var progres_trace */
3355     protected $trace;
3356     /** @var bool do we pass output out */
3357     protected $passthrough;
3358     /** @var string output buffer */
3359     protected $buffer;
3360
3361     /**
3362      * Constructor.
3363      *
3364      * @param progress_trace $trace
3365      * @param bool $passthrough true means output and buffer, false means just buffer and no output
3366      */
3367     public function __construct(progress_trace $trace, $passthrough = true) {
3368         $this->trace       = $trace;
3369         $this->passthrough = $passthrough;
3370         $this->buffer      = '';
3371     }
3372
3373     /**
3374      * Output the trace message.
3375      *
3376      * @param string $message the message to output.
3377      * @param int $depth indent depth for this message.
3378      * @return void output stored in buffer
3379      */
3380     public function output($message, $depth = 0) {
3381         ob_start();
3382         $this->trace->output($message, $depth);
3383         $this->buffer .= ob_get_contents();
3384         if ($this->passthrough) {
3385             ob_end_flush();
3386         } else {
3387             ob_end_clean();
3388         }
3389     }
3390
3391     /**
3392      * Called when the processing is finished.
3393      */
3394     public function finished() {
3395         ob_start();
3396         $this->trace->finished();
3397         $this->buffer .= ob_get_contents();
3398         if ($this->passthrough) {
3399             ob_end_flush();
3400         } else {
3401             ob_end_clean();
3402         }
3403     }
3404
3405     /**
3406      * Reset internal text buffer.
3407      */
3408     public function reset_buffer() {
3409         $this->buffer = '';
3410     }
3411
3412     /**
3413      * Return internal text buffer.
3414      * @return string buffered plain text
3415      */
3416     public function get_buffer() {
3417         return $this->buffer;
3418     }
3419 }
3420
3421 /**
3422  * Special type of trace that can be used for redirecting to multiple other traces.
3423  *
3424  * @copyright Petr Skoda {@link http://skodak.org}
3425  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3426  * @package core
3427  */
3428 class combined_progress_trace extends progress_trace {
3429
3430     /**
3431      * An array of traces.
3432      * @var array
3433      */
3434     protected $traces;
3435
3436     /**
3437      * Constructs a new instance.
3438      *
3439      * @param array $traces multiple traces
3440      */
3441     public function __construct(array $traces) {
3442         $this->traces = $traces;
3443     }
3444
3445     /**
3446      * Output an progress message in whatever format.
3447      *
3448      * @param string $message the message to output.
3449      * @param integer $depth indent depth for this message.
3450      */
3451     public function output($message, $depth = 0) {
3452         foreach ($this->traces as $trace) {
3453             $trace->output($message, $depth);
3454         }
3455     }
3456
3457     /**
3458      * Called when the processing is finished.
3459      */
3460     public function finished() {
3461         foreach ($this->traces as $trace) {
3462             $trace->finished();
3463         }
3464     }
3465 }
3466
3467 /**
3468  * Returns a localized sentence in the current language summarizing the current password policy
3469  *
3470  * @todo this should be handled by a function/method in the language pack library once we have a support for it
3471  * @uses $CFG
3472  * @return string
3473  */
3474 function print_password_policy() {
3475     global $CFG;
3476
3477     $message = '';
3478     if (!empty($CFG->passwordpolicy)) {
3479         $messages = array();
3480         $messages[] = get_string('informminpasswordlength', 'auth', $CFG->minpasswordlength);
3481         if (!empty($CFG->minpassworddigits)) {
3482             $messages[] = get_string('informminpassworddigits', 'auth', $CFG->minpassworddigits);
3483         }
3484         if (!empty($CFG->minpasswordlower)) {
3485             $messages[] = get_string('informminpasswordlower', 'auth', $CFG->minpasswordlower);
3486         }
3487         if (!empty($CFG->minpasswordupper)) {
3488             $messages[] = get_string('informminpasswordupper', 'auth', $CFG->minpasswordupper);
3489         }
3490         if (!empty($CFG->minpasswordnonalphanum)) {
3491             $messages[] = get_string('informminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3492         }
3493
3494         $messages = join(', ', $messages); // This is ugly but we do not have anything better yet...
3495         $message = get_string('informpasswordpolicy', 'auth', $messages);
3496     }
3497     return $message;
3498 }
3499
3500 /**
3501  * Get the value of a help string fully prepared for display in the current language.
3502  *
3503  * @param string $identifier The identifier of the string to search for.
3504  * @param string $component The module the string is associated with.
3505  * @param boolean $ajax Whether this help is called from an AJAX script.
3506  *                This is used to influence text formatting and determines
3507  *                which format to output the doclink in.
3508  * @return Object An object containing:
3509  * - heading: Any heading that there may be for this help string.
3510  * - text: The wiki-formatted help string.
3511  * - doclink: An object containing a link, the linktext, and any additional
3512  *            CSS classes to apply to that link. Only present if $ajax = false.
3513  * - completedoclink: A text representation of the doclink. Only present if $ajax = true.
3514  */
3515 function get_formatted_help_string($identifier, $component, $ajax = false) {
3516     global $CFG, $OUTPUT;
3517     $sm = get_string_manager();
3518
3519     // Do not rebuild caches here!
3520     // Devs need to learn to purge all caches after any change or disable $CFG->langstringcache.
3521
3522     $data = new stdClass();
3523
3524     if ($sm->string_exists($identifier, $component)) {
3525         $data->heading = format_string(get_string($identifier, $component));
3526     } else {
3527         // Gracefully fall back to an empty string.
3528         $data->heading = '';
3529     }
3530
3531     if ($sm->string_exists($identifier . '_help', $component)) {
3532         $options = new stdClass();
3533         $options->trusted = false;
3534         $options->noclean = false;
3535         $options->smiley = false;
3536         $options->filter = false;
3537         $options->para = true;
3538         $options->newlines = false;
3539         $options->overflowdiv = !$ajax;
3540
3541         // Should be simple wiki only MDL-21695.
3542         $data->text =  format_text(get_string($identifier.'_help', $component), FORMAT_MARKDOWN, $options);
3543
3544         $helplink = $identifier . '_link';
3545         if ($sm->string_exists($helplink, $component)) {  // Link to further info in Moodle docs.
3546             $link = get_string($helplink, $component);
3547             $linktext = get_string('morehelp');
3548
3549             $data->doclink = new stdClass();
3550             $url = new moodle_url(get_docs_url($link));
3551             if ($ajax) {
3552                 $data->doclink->link = $url->out();
3553                 $data->doclink->linktext = $linktext;
3554                 $data->doclink->class = ($CFG->doctonewwindow) ? 'helplinkpopup' : '';
3555             } else {
3556                 $data->completedoclink = html_writer::tag('div', $OUTPUT->doc_link($link, $linktext),
3557                     array('class' => 'helpdoclink'));
3558             }
3559         }
3560     } else {
3561         $data->text = html_writer::tag('p',
3562             html_writer::tag('strong', 'TODO') . ": missing help string [{$identifier}_help, {$component}]");
3563     }
3564     return $data;
3565 }