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