MDL-7077, MDL-10181, adding notes for students
[moodle.git] / lib / weblib.php
1 <?php // $Id$
3 ///////////////////////////////////////////////////////////////////////////
4 //                                                                       //
5 // NOTICE OF COPYRIGHT                                                   //
6 //                                                                       //
7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
8 //          http://moodle.com                                            //
9 //                                                                       //
10 // Copyright (C) 2001-2003  Martin Dougiamas  http://dougiamas.com       //
11 //                                                                       //
12 // This program is free software; you can redistribute it and/or modify  //
13 // it under the terms of the GNU General Public License as published by  //
14 // the Free Software Foundation; either version 2 of the License, or     //
15 // (at your option) any later version.                                   //
16 //                                                                       //
17 // This program is distributed in the hope that it will be useful,       //
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
20 // GNU General Public License for more details:                          //
21 //                                                                       //
22 //          http://www.gnu.org/copyleft/gpl.html                         //
23 //                                                                       //
24 ///////////////////////////////////////////////////////////////////////////
26 /**
27  * Library of functions for web output
28  *
29  * Library of all general-purpose Moodle PHP functions and constants
30  * that produce HTML output
31  *
32  * Other main libraries:
33  * - datalib.php - functions that access the database.
34  * - moodlelib.php - general-purpose Moodle functions.
35  * @author Martin Dougiamas
36  * @version  $Id$
37  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
38  * @package moodlecore
39  */
41 /// We are going to uses filterlib functions here
42 require_once("$CFG->libdir/filterlib.php");
44 require_once("$CFG->libdir/ajax/ajaxlib.php");
46 /// Constants
48 /// Define text formatting types ... eventually we can add Wiki, BBcode etc
50 /**
51  * Does all sorts of transformations and filtering
52  */
53 define('FORMAT_MOODLE',   '0');   // Does all sorts of transformations and filtering
55 /**
56  * Plain HTML (with some tags stripped)
57  */
58 define('FORMAT_HTML',     '1');   // Plain HTML (with some tags stripped)
60 /**
61  * Plain text (even tags are printed in full)
62  */
63 define('FORMAT_PLAIN',    '2');   // Plain text (even tags are printed in full)
65 /**
66  * Wiki-formatted text
67  * Deprecated: left here just to note that '3' is not used (at the moment)
68  * and to catch any latent wiki-like text (which generates an error)
69  */
70 define('FORMAT_WIKI',     '3');   // Wiki-formatted text
72 /**
73  * Markdown-formatted text http://daringfireball.net/projects/markdown/
74  */
75 define('FORMAT_MARKDOWN', '4');   // Markdown-formatted text http://daringfireball.net/projects/markdown/
77 /**
78  * TRUSTTEXT marker - if present in text, text cleaning should be bypassed
79  */
80 define('TRUSTTEXT', '#####TRUSTTEXT#####');
83 /**
84  * Allowed tags - string of html tags that can be tested against for safe html tags
85  * @global string $ALLOWED_TAGS
86  */
87 global $ALLOWED_TAGS;
88 $ALLOWED_TAGS =
89 '<p><br><b><i><u><font><table><tbody><span><div><tr><td><th><ol><ul><dl><li><dt><dd><h1><h2><h3><h4><h5><h6><hr><img><a><strong><emphasis><em><sup><sub><address><cite><blockquote><pre><strike><param><acronym><nolink><lang><tex><algebra><math><mi><mn><mo><mtext><mspace><ms><mrow><mfrac><msqrt><mroot><mstyle><merror><mpadded><mphantom><mfenced><msub><msup><msubsup><munder><mover><munderover><mmultiscripts><mtable><mtr><mtd><maligngroup><malignmark><maction><cn><ci><apply><reln><fn><interval><inverse><sep><condition><declare><lambda><compose><ident><quotient><exp><factorial><divide><max><min><minus><plus><power><rem><times><root><gcd><and><or><xor><not><implies><forall><exists><abs><conjugate><eq><neq><gt><lt><geq><leq><ln><log><int><diff><partialdiff><lowlimit><uplimit><bvar><degree><set><list><union><intersect><in><notin><subset><prsubset><notsubset><notprsubset><setdiff><sum><product><limit><tendsto><mean><sdev><variance><median><mode><moment><vector><matrix><matrixrow><determinant><transpose><selector><annotation><semantics><annotation-xml><tt><code>';
91 /**
92  * Allowed protocols - array of protocols that are safe to use in links and so on
93  * @global string $ALLOWED_PROTOCOLS
94  */
95 $ALLOWED_PROTOCOLS = array('http', 'https', 'ftp', 'news', 'mailto', 'rtsp', 'teamspeak', 'gopher', 'mms',
96                            'color', 'callto', 'cursor', 'text-align', 'font-size', 'font-weight', 'font-style',
97                            'border', 'margin', 'padding', 'background');   // CSS as well to get through kses
100 /// Functions
102 /**
103  * Add quotes to HTML characters
104  *
105  * Returns $var with HTML characters (like "<", ">", etc.) properly quoted.
106  * This function is very similar to {@link p()}
107  *
108  * @param string $var the string potentially containing HTML characters
109  * @param boolean $strip to decide if we want to strip slashes or no. Default to false.
110  *                true should be used to print data from forms and false for data from DB.
111  * @return string
112  */
113 function s($var, $strip=false) {
115     if ($var == '0') {  // for integer 0, boolean false, string '0'
116         return '0';
117     }
119     if ($strip) {
120         return preg_replace("/&amp;(#\d+);/i", "&$1;", htmlspecialchars(stripslashes_safe($var)));
121     } else {
122         return preg_replace("/&amp;(#\d+);/i", "&$1;", htmlspecialchars($var));
123     }
126 /**
127  * Add quotes to HTML characters
128  *
129  * Prints $var with HTML characters (like "<", ">", etc.) properly quoted.
130  * This function is very similar to {@link s()}
131  *
132  * @param string $var the string potentially containing HTML characters
133  * @param boolean $strip to decide if we want to strip slashes or no. Default to false.
134  *                true should be used to print data from forms and false for data from DB.
135  * @return string
136  */
137 function p($var, $strip=false) {
138     echo s($var, $strip);
141 /**
142  * Does proper javascript quoting.
143  * Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
144  *
145  * @since 1.8 - 22/02/2007
146  * @param mixed value
147  * @return mixed quoted result
148  */
149 function addslashes_js($var) {
150     if (is_string($var)) {
151         $var = str_replace('\\', '\\\\', $var);
152         $var = str_replace(array('\'', '"', "\n", "\r", "\0"), array('\\\'', '\\"', '\\n', '\\r', '\\0'), $var);
153         $var = str_replace('</', '<\/', $var);   // XHTML compliance
154     } else if (is_array($var)) {
155         $var = array_map('addslashes_js', $var);
156     } else if (is_object($var)) {
157         $a = get_object_vars($var);
158         foreach ($a as $key=>$value) {
159           $a[$key] = addslashes_js($value);
160         }
161         $var = (object)$a;
162     }
163     return $var;
166 /**
167  * Remove query string from url
168  *
169  * Takes in a URL and returns it without the querystring portion
170  *
171  * @param string $url the url which may have a query string attached
172  * @return string
173  */
174  function strip_querystring($url) {
176     if ($commapos = strpos($url, '?')) {
177         return substr($url, 0, $commapos);
178     } else {
179         return $url;
180     }
183 /**
184  * Returns the URL of the HTTP_REFERER, less the querystring portion if required
185  * @return string
186  */
187 function get_referer($stripquery=true) {
188     if (isset($_SERVER['HTTP_REFERER'])) {
189         if ($stripquery) {
190             return strip_querystring($_SERVER['HTTP_REFERER']);
191         } else {
192             return $_SERVER['HTTP_REFERER'];
193         }
194     } else {
195         return '';
196     }
200 /**
201  * Returns the name of the current script, WITH the querystring portion.
202  * this function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
203  * return different things depending on a lot of things like your OS, Web
204  * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
205  * <b>NOTE:</b> This function returns false if the global variables needed are not set.
206  *
207  * @return string
208  */
209  function me() {
211     if (!empty($_SERVER['REQUEST_URI'])) {
212         return $_SERVER['REQUEST_URI'];
214     } else if (!empty($_SERVER['PHP_SELF'])) {
215         if (!empty($_SERVER['QUERY_STRING'])) {
216             return $_SERVER['PHP_SELF'] .'?'. $_SERVER['QUERY_STRING'];
217         }
218         return $_SERVER['PHP_SELF'];
220     } else if (!empty($_SERVER['SCRIPT_NAME'])) {
221         if (!empty($_SERVER['QUERY_STRING'])) {
222             return $_SERVER['SCRIPT_NAME'] .'?'. $_SERVER['QUERY_STRING'];
223         }
224         return $_SERVER['SCRIPT_NAME'];
226     } else if (!empty($_SERVER['URL'])) {     // May help IIS (not well tested)
227         if (!empty($_SERVER['QUERY_STRING'])) {
228             return $_SERVER['URL'] .'?'. $_SERVER['QUERY_STRING'];
229         }
230         return $_SERVER['URL'];
232     } else {
233         notify('Warning: Could not find any of these web server variables: $REQUEST_URI, $PHP_SELF, $SCRIPT_NAME or $URL');
234         return false;
235     }
238 /**
239  * Like {@link me()} but returns a full URL
240  * @see me()
241  * @return string
242  */
243 function qualified_me() {
245     global $CFG;
247     if (!empty($CFG->wwwroot)) {
248         $url = parse_url($CFG->wwwroot);
249     }
251     if (!empty($url['host'])) {
252         $hostname = $url['host'];
253     } else if (!empty($_SERVER['SERVER_NAME'])) {
254         $hostname = $_SERVER['SERVER_NAME'];
255     } else if (!empty($_ENV['SERVER_NAME'])) {
256         $hostname = $_ENV['SERVER_NAME'];
257     } else if (!empty($_SERVER['HTTP_HOST'])) {
258         $hostname = $_SERVER['HTTP_HOST'];
259     } else if (!empty($_ENV['HTTP_HOST'])) {
260         $hostname = $_ENV['HTTP_HOST'];
261     } else {
262         notify('Warning: could not find the name of this server!');
263         return false;
264     }
266     if (!empty($url['port'])) {
267         $hostname .= ':'.$url['port'];
268     } else if (!empty($_SERVER['SERVER_PORT'])) {
269         if ($_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
270             $hostname .= ':'.$_SERVER['SERVER_PORT'];
271         }
272     }
274     if (isset($_SERVER['HTTPS'])) {
275         $protocol = ($_SERVER['HTTPS'] == 'on') ? 'https://' : 'http://';
276     } else if (isset($_SERVER['SERVER_PORT'])) { # Apache2 does not export $_SERVER['HTTPS']
277         $protocol = ($_SERVER['SERVER_PORT'] == '443') ? 'https://' : 'http://';
278     } else {
279         $protocol = 'http://';
280     }
282     $url_prefix = $protocol.$hostname;
283     return $url_prefix . me();
287 /**
288  * Class for creating and manipulating urls.
289  *
290  * See short write up here http://docs.moodle.org/en/Development:lib/weblib.php_moodle_url
291  */
292 class moodle_url {
293     var $scheme = '';// e.g. http
294     var $host = '';
295     var $port = '';
296     var $user = '';
297     var $pass = '';
298     var $path = '';
299     var $fragment = '';
300     var $params = array(); //associative array of query string params
302     /**
303      * Pass no arguments to create a url that refers to this page. Use empty string to create empty url.
304      *
305      * @param string $url url default null means use this page url with no query string
306      *                      empty string means empty url.
307      *                      if you pass any other type of url it will be parsed into it's bits, including query string
308      * @param array $params these params override anything in the query string where params have the same name.
309      */
310     function moodle_url($url = null, $params = array()){
311         global $FULLME;
312         if ($url !== ''){
313             if ($url === null){
314                 $url = strip_querystring($FULLME);
315             }
316             $parts = parse_url($url);
317             if ($parts === FALSE){
318                 error('invalidurl');
319             }
320             if (isset($parts['query'])){
321                 parse_str(str_replace('&amp;', '&', $parts['query']), $this->params);
322             }
323             unset($parts['query']);
324             foreach ($parts as $key => $value){
325                 $this->$key = $value;
326             }
327             $this->params($params);
328         }
329     }
330     /**
331      * Add an array of params to the params for this page. The added params override existing ones if they
332      * have the same name.
333      *
334      * @param array $params
335      */
336     function params($params){
337         $this->params = $params + $this->params;
338     }
340     /**
341      * Remove all params if no arguments passed. Or else remove param $arg1, $arg2, etc.
342      *
343      * @param string $arg1
344      * @param string $arg2
345      * @param string $arg3
346      */
347     function remove_params(){
348         if ($thisargs = func_get_args()){
349             foreach ($thisargs as $arg){
350                 if (isset($this->params->$arg)){
351                     unset($this->params->$arg);
352                 }
353             }
354         } else { // no args
355             $this->params = array();
356         }
357     }
359     /**
360      * Add a param to the params for this page. The added param overrides existing one if they
361      * have the same name.
362      *
363      * @param string $paramname name
364      * @param string $param value
365      */
366     function param($paramname, $param){
367         $this->params = array($paramname => $param) + $this->params;
368     }
371     function get_query_string($overrideparams = array()){
372         $arr = array();
373         $params = $overrideparams + $this->params;
374         foreach ($params as $key => $val){
375            $arr[] = urlencode($key)."=".urlencode($val);
376         }
377         return implode($arr, "&amp;");
378     }
379     /**
380      * Outputs params as hidden form elements.
381      *
382      * @param  array $exclude params to ignore
383      * @param integer $indent indentation
384      * @return string html for form elements.
385      */
386     function hidden_params_out($exclude = array(), $indent = 0){
387         $tabindent = str_repeat("\t", $indent);
388         $str = '';
389         foreach ($this->params as $key => $val){
390             if (FALSE === array_search($key, $exclude)) {
391                 $val = s($val);
392                 $str.= "$tabindent<input type=\"hidden\" name=\"$key\" value=\"$val\" />\n";
393             }
394         }
395         return $str;
396     }
397     /**
398      * Output url
399      *
400      * @param boolean $noquerystring whether to output page params as a query string in the url.
401      * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
402      * @return string url
403      */
404     function out($noquerystring = false, $overrideparams = array()) {
405         $uri = $this->scheme ? $this->scheme.':'.((strtolower($this->scheme) == 'mailto') ? '':'//'): '';
406         $uri .= $this->user ? $this->user.($this->pass? ':'.$this->pass:'').'@':'';
407         $uri .= $this->host ? $this->host : '';
408         $uri .= $this->port ? ':'.$this->port : '';
409         $uri .= $this->path ? $this->path : '';
410         if (!$noquerystring){
411             $uri .= (count($this->params)||count($overrideparams)) ? '?'.$this->get_query_string($overrideparams) : '';
412         }
413         $uri .= $this->fragment ? '#'.$this->fragment : '';
414         return $uri;
415     }
416     /**
417      * Output action url with sesskey
418      *
419      * @param boolean $noquerystring whether to output page params as a query string in the url.
420      * @return string url
421      */
422     function out_action($overrideparams = array()) {
423         $overrideparams = array('sesskey'=> sesskey()) + $overrideparams;
424         return $this->out(false, $overrideparams);
425     }
428 /**
429  * Determine if there is data waiting to be processed from a form
430  *
431  * Used on most forms in Moodle to check for data
432  * Returns the data as an object, if it's found.
433  * This object can be used in foreach loops without
434  * casting because it's cast to (array) automatically
435  *
436  * Checks that submitted POST data exists and returns it as object.
437  *
438  * @param string $url not used anymore
439  * @return mixed false or object
440  */
441 function data_submitted($url='') {
443     if (empty($_POST)) {
444         return false;
445     } else {
446         return (object)$_POST;
447     }
450 /**
451  * Moodle replacement for php stripslashes() function,
452  * works also for objects and arrays.
453  *
454  * The standard php stripslashes() removes ALL backslashes
455  * even from strings - so  C:\temp becomes C:temp - this isn't good.
456  * This function should work as a fairly safe replacement
457  * to be called on quoted AND unquoted strings (to be sure)
458  *
459  * @param mixed something to remove unsafe slashes from
460  * @return mixed
461  */
462 function stripslashes_safe($mixed) {
463     // there is no need to remove slashes from int, float and bool types
464     if (empty($mixed)) {
465         //nothing to do...
466     } else if (is_string($mixed)) {
467         if (ini_get_bool('magic_quotes_sybase')) { //only unescape single quotes
468             $mixed = str_replace("''", "'", $mixed);
469         } else { //the rest, simple and double quotes and backslashes
470             $mixed = str_replace("\\'", "'", $mixed);
471             $mixed = str_replace('\\"', '"', $mixed);
472             $mixed = str_replace('\\\\', '\\', $mixed);
473         }
474     } else if (is_array($mixed)) {
475         foreach ($mixed as $key => $value) {
476             $mixed[$key] = stripslashes_safe($value);
477         }
478     } else if (is_object($mixed)) {
479         $vars = get_object_vars($mixed);
480         foreach ($vars as $key => $value) {
481             $mixed->$key = stripslashes_safe($value);
482         }
483     }
485     return $mixed;
488 /**
489  * Recursive implementation of stripslashes()
490  *
491  * This function will allow you to strip the slashes from a variable.
492  * If the variable is an array or object, slashes will be stripped
493  * from the items (or properties) it contains, even if they are arrays
494  * or objects themselves.
495  *
496  * @param mixed the variable to remove slashes from
497  * @return mixed
498  */
499 function stripslashes_recursive($var) {
500     if (is_object($var)) {
501         $new_var = new object();
502         $properties = get_object_vars($var);
503         foreach($properties as $property => $value) {
504             $new_var->$property = stripslashes_recursive($value);
505         }
507     } else if(is_array($var)) {
508         $new_var = array();
509         foreach($var as $property => $value) {
510             $new_var[$property] = stripslashes_recursive($value);
511         }
513     } else if(is_string($var)) {
514         $new_var = stripslashes($var);
516     } else {
517         $new_var = $var;
518     }
520     return $new_var;
523 /**
524  * Recursive implementation of addslashes()
525  *
526  * This function will allow you to add the slashes from a variable.
527  * If the variable is an array or object, slashes will be added
528  * to the items (or properties) it contains, even if they are arrays
529  * or objects themselves.
530  *
531  * @param mixed the variable to add slashes from
532  * @return mixed
533  */
534 function addslashes_recursive($var) {
535     if (is_object($var)) {
536         $new_var = new object();
537         $properties = get_object_vars($var);
538         foreach($properties as $property => $value) {
539             $new_var->$property = addslashes_recursive($value);
540         }
542     } else if (is_array($var)) {
543         $new_var = array();
544         foreach($var as $property => $value) {
545             $new_var[$property] = addslashes_recursive($value);
546         }
548     } else if (is_string($var)) {
549         $new_var = addslashes($var);
551     } else {
552         $new_var = $var;
553     }
555     return $new_var;
558 /**
559  * Given some normal text this function will break up any
560  * long words to a given size by inserting the given character
561  *
562  * It's multibyte savvy and doesn't change anything inside html tags.
563  *
564  * @param string $string the string to be modified
565  * @param int $maxsize maximum length of the string to be returned
566  * @param string $cutchar the string used to represent word breaks
567  * @return string
568  */
569 function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
571 /// Loading the textlib singleton instance. We are going to need it.
572     $textlib = textlib_get_instance();
574 /// First of all, save all the tags inside the text to skip them
575     $tags = array();
576     filter_save_tags($string,$tags);
578 /// Process the string adding the cut when necessary
579     $output = '';
580     $length = $textlib->strlen($string);
581     $wordlength = 0;
583     for ($i=0; $i<$length; $i++) {
584         $char = $textlib->substr($string, $i, 1);
585         if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
586             $wordlength = 0;
587         } else {
588             $wordlength++;
589             if ($wordlength > $maxsize) {
590                 $output .= $cutchar;
591                 $wordlength = 0;
592             }
593         }
594         $output .= $char;
595     }
597 /// Finally load the tags back again
598     if (!empty($tags)) {
599         $output = str_replace(array_keys($tags), $tags, $output);
600     }
602     return $output;
605 /**
606  * This does a search and replace, ignoring case
607  * This function is only used for versions of PHP older than version 5
608  * which do not have a native version of this function.
609  * Taken from the PHP manual, by bradhuizenga @ softhome.net
610  *
611  * @param string $find the string to search for
612  * @param string $replace the string to replace $find with
613  * @param string $string the string to search through
614  * return string
615  */
616 if (!function_exists('str_ireplace')) {    /// Only exists in PHP 5
617     function str_ireplace($find, $replace, $string) {
619         if (!is_array($find)) {
620             $find = array($find);
621         }
623         if(!is_array($replace)) {
624             if (!is_array($find)) {
625                 $replace = array($replace);
626             } else {
627                 // this will duplicate the string into an array the size of $find
628                 $c = count($find);
629                 $rString = $replace;
630                 unset($replace);
631                 for ($i = 0; $i < $c; $i++) {
632                     $replace[$i] = $rString;
633                 }
634             }
635         }
637         foreach ($find as $fKey => $fItem) {
638             $between = explode(strtolower($fItem),strtolower($string));
639             $pos = 0;
640             foreach($between as $bKey => $bItem) {
641                 $between[$bKey] = substr($string,$pos,strlen($bItem));
642                 $pos += strlen($bItem) + strlen($fItem);
643             }
644             $string = implode($replace[$fKey],$between);
645         }
646         return ($string);
647     }
650 /**
651  * Locate the position of a string in another string
652  *
653  * This function is only used for versions of PHP older than version 5
654  * which do not have a native version of this function.
655  * Taken from the PHP manual, by dmarsh @ spscc.ctc.edu
656  *
657  * @param string $haystack The string to be searched
658  * @param string $needle The string to search for
659  * @param int $offset The position in $haystack where the search should begin.
660  */
661 if (!function_exists('stripos')) {    /// Only exists in PHP 5
662     function stripos($haystack, $needle, $offset=0) {
664         return strpos(strtoupper($haystack), strtoupper($needle), $offset);
665     }
668 /**
669  * This function will create a HTML link that will work on both
670  * Javascript and non-javascript browsers.
671  * Relies on the Javascript function openpopup in javascript.php
672  *
673  * $url must be relative to home page  eg /mod/survey/stuff.php
674  * @param string $url Web link relative to home page
675  * @param string $name Name to be assigned to the popup window
676  * @param string $linkname Text to be displayed as web link
677  * @param int $height Height to assign to popup window
678  * @param int $width Height to assign to popup window
679  * @param string $title Text to be displayed as popup page title
680  * @param string $options List of additional options for popup window
681  * @todo Add code examples and list of some options that might be used.
682  * @param boolean $return Should the link to the popup window be returned as a string (true) or printed immediately (false)?
683  * @return string
684  * @uses $CFG
685  */
686 function link_to_popup_window ($url, $name='popup', $linkname='click here',
687                                $height=400, $width=500, $title='Popup window',
688                                $options='none', $return=false) {
690     global $CFG;
692     if ($options == 'none') {
693         $options = 'menubar=0,location=0,scrollbars,resizable,width='. $width .',height='. $height;
694     }
695     $fullscreen = 0;
697     if (!(strpos($url,$CFG->wwwroot) === false)) { // some log url entries contain _SERVER[HTTP_REFERRER] in which case wwwroot is already there.
698         $url = substr($url, strlen($CFG->wwwroot));
699     }
701     $link = '<a title="'. s(strip_tags($title)) .'" href="'. $CFG->wwwroot . $url .'" '.
702            "onclick=\"this.target='$name'; return openpopup('$url', '$name', '$options', $fullscreen);\">$linkname</a>";
703     if ($return) {
704         return $link;
705     } else {
706         echo $link;
707     }
710 /**
711  * This function will print a button submit form element
712  * that will work on both Javascript and non-javascript browsers.
713  * Relies on the Javascript function openpopup in javascript.php
714  *
715  * $url must be relative to home page  eg /mod/survey/stuff.php
716  * @param string $url Web link relative to home page
717  * @param string $name Name to be assigned to the popup window
718  * @param string $linkname Text to be displayed as web link
719  * @param int $height Height to assign to popup window
720  * @param int $width Height to assign to popup window
721  * @param string $title Text to be displayed as popup page title
722  * @param string $options List of additional options for popup window
723  * @param string $return If true, return as a string, otherwise print
724  * @return string
725  * @uses $CFG
726  */
727 function button_to_popup_window ($url, $name='popup', $linkname='click here',
728                                  $height=400, $width=500, $title='Popup window', $options='none', $return=false,
729                                  $id='', $class='') {
731     global $CFG;
733     if ($options == 'none') {
734         $options = 'menubar=0,location=0,scrollbars,resizable,width='. $width .',height='. $height;
735     }
737     if ($id) {
738         $id = ' id="'.$id.'" ';
739     }
740     if ($class) {
741         $class = ' class="'.$class.'" ';
742     }
743     $fullscreen = 0;
745     $button = '<input type="button" name="'.$name.'" title="'. $title .'" value="'. $linkname .' ..." '.$id.$class.
746               "onclick=\"return openpopup('$url', '$name', '$options', $fullscreen);\" />\n";
747     if ($return) {
748         return $button;
749     } else {
750         echo $button;
751     }
755 /**
756  * Prints a simple button to close a window
757  */
758 function close_window_button($name='closewindow', $return=false) {
759     global $CFG;
761     $output = '';
763     $output .= '<div class="closewindow">' . "\n";
764     $output .= '<form action="'.$CFG->wwwroot.'"><div>';   // We don't use this
765     $output .= '<input type="button" onclick="self.close();" value="'.get_string($name).'" />';
766     $output .= '</div></form>';
767     $output .= '</div>' . "\n";
769     if ($return) {
770         return $output;
771     } else {
772         echo $output;
773     }
776 /*
777  * Try and close the current window immediately using Javascript
778  */
779 function close_window($delay=0) {
780 ?>
781 <script type="text/javascript">
782 //<![CDATA[
783     function close_this_window() {
784         self.close();
785     }
786     setTimeout("close_this_window()", <?php echo $delay * 1000 ?>);
787 //]]>
788 </script>
789 <noscript><center>
790 <?php print_string('pleaseclose') ?>
791 </center></noscript>
792 <?php
793     die;
797 /**
798  * Given an array of value, creates a popup menu to be part of a form
799  * $options["value"]["label"]
800  *
801  * @param    type description
802  * @todo Finish documenting this function
803  */
804 function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
805                            $nothingvalue='0', $return=false, $disabled=false, $tabindex=0, $id='') {
807     if ($nothing == 'choose') {
808         $nothing = get_string('choose') .'...';
809     }
811     $attributes = ($script) ? 'onchange="'. $script .'"' : '';
812     if ($disabled) {
813         $attributes .= ' disabled="disabled"';
814     }
816     if ($tabindex) {
817         $attributes .= ' tabindex="'.$tabindex.'"';
818     }
820     if ($id ==='') {
821         $id = 'menu'.$name;
822          // name may contaion [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading
823         $id = str_replace('[', '', $id);
824         $id = str_replace(']', '', $id);
825     }
827     $output = '<select id="'.$id.'" name="'. $name .'" '. $attributes .'>' . "\n";
828     if ($nothing) {
829         $output .= '   <option value="'. s($nothingvalue) .'"'. "\n";
830         if ($nothingvalue === $selected) {
831             $output .= ' selected="selected"';
832         }
833         $output .= '>'. $nothing .'</option>' . "\n";
834     }
835     if (!empty($options)) {
836         foreach ($options as $value => $label) {
837             $output .= '   <option value="'. s($value) .'"';
838             if ((string)$value == (string)$selected) {
839                 $output .= ' selected="selected"';
840             }
841             if ($label === '') {
842                 $output .= '>'. $value .'</option>' . "\n";
843             } else {
844                 $output .= '>'. $label .'</option>' . "\n";
845             }
846         }
847     }
848     $output .= '</select>' . "\n";
850     if ($return) {
851         return $output;
852     } else {
853         echo $output;
854     }
857 /**
858  * Choose value 0 or 1 from a menu with options 'No' and 'Yes'.
859  * Other options like choose_from_menu.
860  */
861 function choose_from_menu_yesno($name, $selected, $script = '',
862         $return = false, $disabled = false, $tabindex = 0) {
863     return choose_from_menu(array(get_string('no'), get_string('yes')), $name,
864             $selected, '', $script, '0', $return, $disabled, $tabindex);
867 /**
868  * Just like choose_from_menu, but takes a nested array (2 levels) and makes a dropdown menu
869  * including option headings with the first level.
870  */
871 function choose_from_menu_nested($options,$name,$selected='',$nothing='choose',$script = '',
872                                  $nothingvalue=0,$return=false,$disabled=false,$tabindex=0) {
874    if ($nothing == 'choose') {
875         $nothing = get_string('choose') .'...';
876     }
878     $attributes = ($script) ? 'onchange="'. $script .'"' : '';
879     if ($disabled) {
880         $attributes .= ' disabled="disabled"';
881     }
883     if ($tabindex) {
884         $attributes .= ' tabindex="'.$tabindex.'"';
885     }
887     $output = '<select id="menu'.$name.'" name="'. $name .'" '. $attributes .'>' . "\n";
888     if ($nothing) {
889         $output .= '   <option value="'. $nothingvalue .'"'. "\n";
890         if ($nothingvalue === $selected) {
891             $output .= ' selected="selected"';
892         }
893         $output .= '>'. $nothing .'</option>' . "\n";
894     }
895     if (!empty($options)) {
896         foreach ($options as $section => $values) {
898             $output .= '   <optgroup label="'. s(format_string($section)) .'">'."\n";
899             foreach ($values as $value => $label) {
900                 $output .= '   <option value="'. format_string($value) .'"';
901                 if ((string)$value == (string)$selected) {
902                     $output .= ' selected="selected"';
903                 }
904                 if ($label === '') {
905                     $output .= '>'. $value .'</option>' . "\n";
906                 } else {
907                     $output .= '>'. $label .'</option>' . "\n";
908                 }
909             }
910             $output .= '   </optgroup>'."\n";
911         }
912     }
913     $output .= '</select>' . "\n";
915     if ($return) {
916         return $output;
917     } else {
918         echo $output;
919     }
923 /**
924  * Given an array of values, creates a group of radio buttons to be part of a form
925  *
926  * @param array  $options  An array of value-label pairs for the radio group (values as keys)
927  * @param string $name     Name of the radiogroup (unique in the form)
928  * @param string $checked  The value that is already checked
929  */
930 function choose_from_radio ($options, $name, $checked='', $return=false) {
932     static $idcounter = 0;
934     if (!$name) {
935         $name = 'unnamed';
936     }
938     $output = '<span class="radiogroup '.$name."\">\n";
940     if (!empty($options)) {
941         $currentradio = 0;
942         foreach ($options as $value => $label) {
943             $htmlid = 'auto-rb'.sprintf('%04d', ++$idcounter);
944             $output .= ' <span class="radioelement '.$name.' rb'.$currentradio."\">";
945             $output .= '<input name="'.$name.'" id="'.$htmlid.'" type="radio" value="'.$value.'"';
946             if ($value == $checked) {
947                 $output .= ' checked="checked"';
948             }
949             if ($label === '') {
950                 $output .= ' /> <label for="'.$htmlid.'">'.  $value .'</label></span>' .  "\n";
951             } else {
952                 $output .= ' /> <label for="'.$htmlid.'">'.  $label .'</label></span>' .  "\n";
953             }
954             $currentradio = ($currentradio + 1) % 2;
955         }
956     }
958     $output .= '</span>' .  "\n";
960     if ($return) {
961         return $output;
962     } else {
963         echo $output;
964     }
967 /** Display an standard html checkbox with an optional label
968  *
969  * @param string  $name    The name of the checkbox
970  * @param string  $value   The valus that the checkbox will pass when checked
971  * @param boolean $checked The flag to tell the checkbox initial state
972  * @param string  $label   The label to be showed near the checkbox
973  * @param string  $alt     The info to be inserted in the alt tag
974  */
975 function print_checkbox ($name, $value, $checked = true, $label = '', $alt = '', $script='',$return=false) {
977     static $idcounter = 0;
979     if (!$name) {
980         $name = 'unnamed';
981     }
983     if ($alt) {
984         $alt = strip_tags($alt);
985     } else {
986         $alt = 'checkbox';
987     }
989     if ($checked) {
990         $strchecked = ' checked="checked"';
991     } else {
992         $strchecked = '';
993     }
995     $htmlid = 'auto-cb'.sprintf('%04d', ++$idcounter);
996     $output  = '<span class="checkbox '.$name."\">";
997     $output .= '<input name="'.$name.'" id="'.$htmlid.'" type="checkbox" value="'.$value.'" alt="'.$alt.'"'.$strchecked.' '.((!empty($script)) ? ' onclick="'.$script.'" ' : '').' />';
998     if(!empty($label)) {
999         $output .= ' <label for="'.$htmlid.'">'.$label.'</label>';
1000     }
1001     $output .= '</span>'."\n";
1003     if (empty($return)) {
1004         echo $output;
1005     } else {
1006         return $output;
1007     }
1011 /** Display an standard html text field with an optional label
1012  *
1013  * @param string  $name    The name of the text field
1014  * @param string  $value   The value of the text field
1015  * @param string  $label   The label to be showed near the text field
1016  * @param string  $alt     The info to be inserted in the alt tag
1017  */
1018 function print_textfield ($name, $value, $alt = '',$size=50,$maxlength=0, $return=false) {
1020     static $idcounter = 0;
1022     if (empty($name)) {
1023         $name = 'unnamed';
1024     }
1026     if (empty($alt)) {
1027         $alt = 'textfield';
1028     }
1030     if (!empty($maxlength)) {
1031         $maxlength = ' maxlength="'.$maxlength.'" ';
1032     }
1034     $htmlid = 'auto-tf'.sprintf('%04d', ++$idcounter);
1035     $output  = '<span class="textfield '.$name."\">";
1036     $output .= '<input name="'.$name.'" id="'.$htmlid.'" type="text" value="'.$value.'" size="'.$size.'" '.$maxlength.' alt="'.$alt.'" />';
1038     $output .= '</span>'."\n";
1040     if (empty($return)) {
1041         echo $output;
1042     } else {
1043         return $output;
1044     }
1049 /**
1050  * Implements a complete little popup form
1051  *
1052  * @uses $CFG
1053  * @param string $common  The URL up to the point of the variable that changes
1054  * @param array $options  Alist of value-label pairs for the popup list
1055  * @param string $formid Id must be unique on the page (originaly $formname)
1056  * @param string $selected The option that is already selected
1057  * @param string $nothing The label for the "no choice" option
1058  * @param string $help The name of a help page if help is required
1059  * @param string $helptext The name of the label for the help button
1060  * @param boolean $return Indicates whether the function should return the text
1061  *         as a string or echo it directly to the page being rendered
1062  * @param string $targetwindow The name of the target page to open the linked page in.
1063  * @return string If $return is true then the entire form is returned as a string.
1064  * @todo Finish documenting this function<br>
1065  */
1066 function popup_form($common, $options, $formid, $selected='', $nothing='choose', $help='', $helptext='', $return=false,
1067 $targetwindow='self', $selectlabel='', $optionsextra=NULL) {
1069     global $CFG;
1070     static $go, $choose;   /// Locally cached, in case there's lots on a page
1072     if (empty($options)) {
1073         return '';
1074     }
1076     if (!isset($go)) {
1077         $go = get_string('go');
1078     }
1080     if ($nothing == 'choose') {
1081         if (!isset($choose)) {
1082             $choose = get_string('choose');
1083         }
1084         $nothing = $choose.'...';
1085     }
1087     // changed reference to document.getElementById('id_abc') instead of document.abc
1088     // MDL-7861
1089     $output = '<form action="'.$CFG->wwwroot.'/course/jumpto.php"'.
1090                         ' method="get" '.
1091                          $CFG->frametarget.
1092                         ' id="'.$formid.'"'.
1093                         ' class="popupform">';
1094     if ($help) {
1095         $button = helpbutton($help, $helptext, 'moodle', true, false, '', true);
1096     } else {
1097         $button = '';
1098     }
1100     if ($selectlabel) {
1101         $selectlabel = '<label for="'.$formid.'_jump">'.$selectlabel.'</label>';
1102     }
1104     $output .= '<div>'.$selectlabel.$button.'<select id="'.$formid.'_jump" name="jump" onchange="'.$targetwindow.'.location=document.getElementById(\''.$formid.'\').jump.options[document.getElementById(\''.$formid.'\').jump.selectedIndex].value;">'."\n";
1106     if ($nothing != '') {
1107         $output .= "   <option value=\"javascript:void(0)\">$nothing</option>\n";
1108     }
1110     $inoptgroup = false;
1112     foreach ($options as $value => $label) {
1114         if ($label == '--') { /// we are ending previous optgroup
1115             /// Check to see if we already have a valid open optgroup
1116             /// XHTML demands that there be at least 1 option within an optgroup
1117             if ($inoptgroup and (count($optgr) > 1) ) {
1118                 $output .= implode('', $optgr);
1119                 $output .= '   </optgroup>';
1120             }
1121             $optgr = array();
1122             $inoptgroup = false;
1123             continue;
1124         } else if (substr($label,0,2) == '--') { /// we are starting a new optgroup
1126             /// Check to see if we already have a valid open optgroup
1127             /// XHTML demands that there be at least 1 option within an optgroup
1128             if ($inoptgroup and (count($optgr) > 1) ) {
1129                 $output .= implode('', $optgr);
1130                 $output .= '   </optgroup>';
1131             }
1133             unset($optgr);
1134             $optgr = array();
1136             $optgr[]  = '   <optgroup label="'. s(format_string(substr($label,2))) .'">';   // Plain labels
1138             $inoptgroup = true; /// everything following will be in an optgroup
1139             continue;
1141         } else {
1142            if (!empty($CFG->usesid) && !isset($_COOKIE[session_name()]))
1143             {
1144                 $url=sid_process_url( $common . $value );
1145             } else
1146             {
1147                 $url=$common . $value;
1148             }
1149             $optstr = '   <option value="' . $url . '"';
1151             if ($value == $selected) {
1152                 $optstr .= ' selected="selected"';
1153             }
1155             if (!empty($optionsextra[$value])) {
1156                 $optstr .= ' '.$optionsextra[$value];
1157             }
1159             if ($label) {
1160                 $optstr .= '>'. $label .'</option>' . "\n";
1161             } else {
1162                 $optstr .= '>'. $value .'</option>' . "\n";
1163             }
1165             if ($inoptgroup) {
1166                 $optgr[] = $optstr;
1167             } else {
1168                 $output .= $optstr;
1169             }
1170         }
1172     }
1174     /// catch the final group if not closed
1175     if ($inoptgroup and count($optgr) > 1) {
1176         $output .= implode('', $optgr);
1177         $output .= '    </optgroup>';
1178     }
1180     $output .= '</select>';
1181     $output .= '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
1182     $output .= '<div id="noscript'.$formid.'" style="display: inline;">';
1183     $output .= '<input type="submit" value="'.$go.'" /></div>';
1184     $output .= '<script type="text/javascript">'.
1185                "\n//<![CDATA[\n".
1186                'document.getElementById("noscript'.$formid.'").style.display = "none";'.
1187                "\n//]]>\n".'</script>';
1188     $output .= '</div>';
1189     $output .= '</form>';
1191     if ($return) {
1192         return $output;
1193     } else {
1194         echo $output;
1195     }
1199 /**
1200  * Prints some red text
1201  *
1202  * @param string $error The text to be displayed in red
1203  */
1204 function formerr($error) {
1206     if (!empty($error)) {
1207         echo '<span class="error">'. $error .'</span>';
1208     }
1211 /**
1212  * Validates an email to make sure it makes sense.
1213  *
1214  * @param string $address The email address to validate.
1215  * @return boolean
1216  */
1217 function validate_email($address) {
1219     return (ereg('^[-!#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
1220                  '(\.[-!#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
1221                   '@'.
1222                   '[-!#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
1223                   '[-!#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$',
1224                   $address));
1227 /**
1228  * Extracts file argument either from file parameter or PATH_INFO
1229  *
1230  * @param string $scriptname name of the calling script
1231  * @return string file path (only safe characters)
1232  */
1233 function get_file_argument($scriptname) {
1234     global $_SERVER;
1236     $relativepath = FALSE;
1238     // first try normal parameter (compatible method == no relative links!)
1239     $relativepath = optional_param('file', FALSE, PARAM_PATH);
1240     if ($relativepath === '/testslasharguments') {
1241         echo 'test -1      : Incorrect use - try "file.php/testslasharguments" instead'; //indicate fopen/fread works for health center
1242         die;
1243     }
1245     // then try extract file from PATH_INFO (slasharguments method)
1246     if (!$relativepath and !empty($_SERVER['PATH_INFO'])) {
1247         $path_info = $_SERVER['PATH_INFO'];
1248         // check that PATH_INFO works == must not contain the script name
1249         if (!strpos($path_info, $scriptname)) {
1250             $relativepath = clean_param(rawurldecode($path_info), PARAM_PATH);
1251             if ($relativepath === '/testslasharguments') {
1252                 echo 'test 1      : Slasharguments test passed. Server confguration is compatible with file.php/1/pic.jpg slashargument setting.'; //indicate ok for health center
1253                 die;
1254             }
1255         }
1256     }
1258     // now if both fail try the old way
1259     // (for compatibility with misconfigured or older buggy php implementations)
1260     if (!$relativepath) {
1261         $arr = explode($scriptname, me());
1262         if (!empty($arr[1])) {
1263             $path_info = strip_querystring($arr[1]);
1264             $relativepath = clean_param(rawurldecode($path_info), PARAM_PATH);
1265             if ($relativepath === '/testslasharguments') {
1266                 echo 'test 2      : Slasharguments test passed (compatibility hack). Server confguration may be compatible with file.php/1/pic.jpg slashargument setting'; //indicate ok for health center
1267                 die;
1268             }
1269         }
1270     }
1272     return $relativepath;
1275 /**
1276  * Searches the current environment variables for some slash arguments
1277  *
1278  * @param string $file ?
1279  * @todo Finish documenting this function
1280  */
1281 function get_slash_arguments($file='file.php') {
1283     if (!$string = me()) {
1284         return false;
1285     }
1287     $pathinfo = explode($file, $string);
1289     if (!empty($pathinfo[1])) {
1290         return addslashes($pathinfo[1]);
1291     } else {
1292         return false;
1293     }
1296 /**
1297  * Extracts arguments from "/foo/bar/something"
1298  * eg http://mysite.com/script.php/foo/bar/something
1299  *
1300  * @param string $string ?
1301  * @param int $i ?
1302  * @return array|string
1303  * @todo Finish documenting this function
1304  */
1305 function parse_slash_arguments($string, $i=0) {
1307     if (detect_munged_arguments($string)) {
1308         return false;
1309     }
1310     $args = explode('/', $string);
1312     if ($i) {     // return just the required argument
1313         return $args[$i];
1315     } else {      // return the whole array
1316         array_shift($args);  // get rid of the empty first one
1317         return $args;
1318     }
1321 /**
1322  * Just returns an array of text formats suitable for a popup menu
1323  *
1324  * @uses FORMAT_MOODLE
1325  * @uses FORMAT_HTML
1326  * @uses FORMAT_PLAIN
1327  * @uses FORMAT_MARKDOWN
1328  * @return array
1329  */
1330 function format_text_menu() {
1332     return array (FORMAT_MOODLE => get_string('formattext'),
1333                   FORMAT_HTML   => get_string('formathtml'),
1334                   FORMAT_PLAIN  => get_string('formatplain'),
1335                   FORMAT_MARKDOWN  => get_string('formatmarkdown'));
1338 /**
1339  * Given text in a variety of format codings, this function returns
1340  * the text as safe HTML.
1341  *
1342  * @uses $CFG
1343  * @uses FORMAT_MOODLE
1344  * @uses FORMAT_HTML
1345  * @uses FORMAT_PLAIN
1346  * @uses FORMAT_WIKI
1347  * @uses FORMAT_MARKDOWN
1348  * @param string $text The text to be formatted. This is raw text originally from user input.
1349  * @param int $format Identifier of the text format to be used
1350  *            (FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN)
1351  * @param  array $options ?
1352  * @param int $courseid ?
1353  * @return string
1354  * @todo Finish documenting this function
1355  */
1356 function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL) {
1358     global $CFG, $COURSE;
1360     if ($text === '') {
1361         return ''; // no need to do any filters and cleaning
1362     }
1364     if (!isset($options->trusttext)) {
1365         $options->trusttext = false;
1366     }
1368     if (!isset($options->noclean)) {
1369         $options->noclean=false;
1370     }
1371     if (!isset($options->nocache)) {
1372         $options->nocache=false;
1373     }
1374     if (!isset($options->smiley)) {
1375         $options->smiley=true;
1376     }
1377     if (!isset($options->filter)) {
1378         $options->filter=true;
1379     }
1380     if (!isset($options->para)) {
1381         $options->para=true;
1382     }
1383     if (!isset($options->newlines)) {
1384         $options->newlines=true;
1385     }
1387     if (empty($courseid)) {
1388         $courseid = $COURSE->id;
1389     }
1391     if (!empty($CFG->cachetext) and empty($options->nocache)) {
1392         $time = time() - $CFG->cachetext;
1393         $md5key = md5($text.'-'.(int)$courseid.'-'.current_language().'-'.(int)$format.(int)$options->trusttext.(int)$options->noclean.(int)$options->smiley.(int)$options->filter.(int)$options->para.(int)$options->newlines);
1394         if ($oldcacheitem = get_record_sql('SELECT * FROM '.$CFG->prefix.'cache_text WHERE md5key = \''.$md5key.'\'', true)) {
1395             if ($oldcacheitem->timemodified >= $time) {
1396                 return $oldcacheitem->formattedtext;
1397             }
1398         }
1399     }
1401     // trusttext overrides the noclean option!
1402     if ($options->trusttext) {
1403         if (trusttext_present($text)) {
1404             $text = trusttext_strip($text);
1405             if (!empty($CFG->enabletrusttext)) {
1406                 $options->noclean = true;
1407             } else {
1408                 $options->noclean = false;
1409             }
1410         } else {
1411             $options->noclean = false;
1412         }
1413     } else if (!debugging('', DEBUG_DEVELOPER)) {
1414         // strip any forgotten trusttext in non-developer mode
1415         // do not forget to disable text cache when debugging trusttext!!
1416         $text = trusttext_strip($text);
1417     }
1419     $CFG->currenttextiscacheable = true;   // Default status - can be changed by any filter
1421     switch ($format) {
1422         case FORMAT_HTML:
1423             if ($options->smiley) {
1424                 replace_smilies($text);
1425             }
1426             if (!$options->noclean) {
1427                 $text = clean_text($text, FORMAT_HTML);
1428             }
1429             if ($options->filter) {
1430                 $text = filter_text($text, $courseid);
1431             }
1432             break;
1434         case FORMAT_PLAIN:
1435             $text = s($text); // cleans dangerous JS
1436             $text = rebuildnolinktag($text);
1437             $text = str_replace('  ', '&nbsp; ', $text);
1438             $text = nl2br($text);
1439             break;
1441         case FORMAT_WIKI:
1442             // this format is deprecated
1443             $text = '<p>NOTICE: Wiki-like formatting has been removed from Moodle.  You should not be seeing
1444                      this message as all texts should have been converted to Markdown format instead.
1445                      Please post a bug report to http://moodle.org/bugs with information about where you
1446                      saw this message.</p>'.s($text);
1447             break;
1449         case FORMAT_MARKDOWN:
1450             $text = markdown_to_html($text);
1451             if ($options->smiley) {
1452                 replace_smilies($text);
1453             }
1454             if (!$options->noclean) {
1455                 $text = clean_text($text, FORMAT_HTML);
1456             }
1458             if ($options->filter) {
1459                 $text = filter_text($text, $courseid);
1460             }
1461             break;
1463         default:  // FORMAT_MOODLE or anything else
1464             $text = text_to_html($text, $options->smiley, $options->para, $options->newlines);
1465             if (!$options->noclean) {
1466                 $text = clean_text($text, FORMAT_HTML);
1467             }
1469             if ($options->filter) {
1470                 $text = filter_text($text, $courseid);
1471             }
1472             break;
1473     }
1475     if (empty($options->nocache) and !empty($CFG->cachetext) and $CFG->currenttextiscacheable) {
1476         $newcacheitem = new object();
1477         $newcacheitem->md5key = $md5key;
1478         $newcacheitem->formattedtext = addslashes($text);
1479         $newcacheitem->timemodified = time();
1480         if ($oldcacheitem) {                               // See bug 4677 for discussion
1481             $newcacheitem->id = $oldcacheitem->id;
1482             @update_record('cache_text', $newcacheitem);   // Update existing record in the cache table
1483                                                            // It's unlikely that the cron cache cleaner could have
1484                                                            // deleted this entry in the meantime, as it allows
1485                                                            // some extra time to cover these cases.
1486         } else {
1487             @insert_record('cache_text', $newcacheitem);   // Insert a new record in the cache table
1488                                                            // Again, it's possible that another user has caused this
1489                                                            // record to be created already in the time that it took
1490                                                            // to traverse this function.  That's OK too, as the
1491                                                            // call above handles duplicate entries, and eventually
1492                                                            // the cron cleaner will delete them.
1493         }
1494     }
1496     return $text;
1499 /** Converts the text format from the value to the 'internal'
1500  *  name or vice versa. $key can either be the value or the name
1501  *  and you get the other back.
1502  *
1503  *  @param mixed int 0-4 or string one of 'moodle','html','plain','markdown'
1504  *  @return mixed as above but the other way around!
1505  */
1506 function text_format_name( $key ) {
1507   $lookup = array();
1508   $lookup[FORMAT_MOODLE] = 'moodle';
1509   $lookup[FORMAT_HTML] = 'html';
1510   $lookup[FORMAT_PLAIN] = 'plain';
1511   $lookup[FORMAT_MARKDOWN] = 'markdown';
1512   $value = "error";
1513   if (!is_numeric($key)) {
1514     $key = strtolower( $key );
1515     $value = array_search( $key, $lookup );
1516   }
1517   else {
1518     if (isset( $lookup[$key] )) {
1519       $value =  $lookup[ $key ];
1520     }
1521   }
1522   return $value;
1526 /** Given a simple string, this function returns the string
1527  *  processed by enabled filters if $CFG->filterall is enabled
1528  *
1529  *  @param string  $string     The string to be filtered.
1530  *  @param boolean $striplinks To strip any link in the result text (Moodle 1.8 default changed from false to true! MDL-8713)
1531  *  @param int     $courseid   Current course as filters can, potentially, use it
1532  *  @return string
1533  */
1534 function format_string ($string, $striplinks=true, $courseid=NULL ) {
1536     global $CFG, $COURSE;
1538     //We'll use a in-memory cache here to speed up repeated strings
1539     static $strcache = false;
1541     if ($strcache === false or count($strcache) > 2000 ) { // this number might need some tuning to limit memory usage in cron
1542         $strcache = array();
1543     }
1545     //init course id
1546     if (empty($courseid)) {
1547         $courseid = $COURSE->id;
1548     }
1550     //Calculate md5
1551     $md5 = md5($string.'<+>'.$striplinks.'<+>'.$courseid.'<+>'.current_language());
1553     //Fetch from cache if possible
1554     if (isset($strcache[$md5])) {
1555         return $strcache[$md5];
1556     }
1558     // First replace all ampersands not followed by html entity code
1559     $string = preg_replace("/\&(?![a-zA-Z0-9#]{1,8};)/", "&amp;", $string);
1561     if (!empty($CFG->filterall)) {
1562         $string = filter_string($string, $courseid);
1563     }
1565     // If the site requires it, strip ALL tags from this string
1566     if (!empty($CFG->formatstringstriptags)) {
1567         $string = strip_tags($string);
1569     // Otherwise strip just links if that is required (default)
1570     } else if ($striplinks) {  //strip links in string
1571         $string = preg_replace('/(<a[^>]+?>)(.+?)(<\/a>)/is','$2',$string);
1572     }
1574     //Store to cache
1575     $strcache[$md5] = $string;
1577     return $string;
1580 /**
1581  * Given text in a variety of format codings, this function returns
1582  * the text as plain text suitable for plain email.
1583  *
1584  * @uses FORMAT_MOODLE
1585  * @uses FORMAT_HTML
1586  * @uses FORMAT_PLAIN
1587  * @uses FORMAT_WIKI
1588  * @uses FORMAT_MARKDOWN
1589  * @param string $text The text to be formatted. This is raw text originally from user input.
1590  * @param int $format Identifier of the text format to be used
1591  *            (FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN)
1592  * @return string
1593  */
1594 function format_text_email($text, $format) {
1596     switch ($format) {
1598         case FORMAT_PLAIN:
1599             return $text;
1600             break;
1602         case FORMAT_WIKI:
1603             $text = wiki_to_html($text);
1604         /// This expression turns links into something nice in a text format. (Russell Jungwirth)
1605         /// From: http://php.net/manual/en/function.eregi-replace.php and simplified
1606             $text = eregi_replace('(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)','\\3 [ \\2 ]', $text);
1607             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1608             break;
1610         case FORMAT_HTML:
1611             return html_to_text($text);
1612             break;
1614         case FORMAT_MOODLE:
1615         case FORMAT_MARKDOWN:
1616         default:
1617             $text = eregi_replace('(<a [^<]*href=["|\']?([^ "\']*)["|\']?[^>]*>([^<]*)</a>)','\\3 [ \\2 ]', $text);
1618             return strtr(strip_tags($text), array_flip(get_html_translation_table(HTML_ENTITIES)));
1619             break;
1620     }
1623 /**
1624  * Given some text in HTML format, this function will pass it
1625  * through any filters that have been defined in $CFG->textfilterx
1626  * The variable defines a filepath to a file containing the
1627  * filter function.  The file must contain a variable called
1628  * $textfilter_function which contains the name of the function
1629  * with $courseid and $text parameters
1630  *
1631  * @param string $text The text to be passed through format filters
1632  * @param int $courseid ?
1633  * @return string
1634  * @todo Finish documenting this function
1635  */
1636 function filter_text($text, $courseid=NULL) {
1637     global $CFG, $COURSE;
1639     if (empty($courseid)) {
1640         $courseid = $COURSE->id;       // (copied from format_text)
1641     }
1643     if (!empty($CFG->textfilters)) {
1644         require_once($CFG->libdir.'/filterlib.php');
1645         $textfilters = explode(',', $CFG->textfilters);
1646         foreach ($textfilters as $textfilter) {
1647             if (is_readable($CFG->dirroot .'/'. $textfilter .'/filter.php')) {
1648                 include_once($CFG->dirroot .'/'. $textfilter .'/filter.php');
1649                 $functionname = basename($textfilter).'_filter';
1650                 if (function_exists($functionname)) {
1651                     $text = $functionname($courseid, $text);
1652                 }
1653             }
1654         }
1655     }
1657     /// <nolink> tags removed for XHTML compatibility
1658     $text = str_replace('<nolink>', '', $text);
1659     $text = str_replace('</nolink>', '', $text);
1661     return $text;
1665 /**
1666  * Given a string (short text) in HTML format, this function will pass it
1667  * through any filters that have been defined in $CFG->stringfilters
1668  * The variable defines a filepath to a file containing the
1669  * filter function.  The file must contain a variable called
1670  * $textfilter_function which contains the name of the function
1671  * with $courseid and $text parameters
1672  *
1673  * @param string $string The text to be passed through format filters
1674  * @param int $courseid The id of a course
1675  * @return string
1676  */
1677 function filter_string($string, $courseid=NULL) {
1678     global $CFG, $COURSE;
1680     if (empty($CFG->textfilters)) {             // All filters are disabled anyway so quit
1681         return $string;
1682     }
1684     if (empty($courseid)) {
1685         $courseid = $COURSE->id;
1686     }
1688     require_once($CFG->libdir.'/filterlib.php');
1690     if (isset($CFG->stringfilters)) {               // We have a predefined list to use, great!
1691         if (empty($CFG->stringfilters)) {                    // but it's blank, so finish now
1692             return $string;
1693         }
1694         $stringfilters = explode(',', $CFG->stringfilters);  // ..use the list we have
1696     } else {                                        // Otherwise try to derive a list from textfilters
1697         if (strpos($CFG->textfilters, 'filter/multilang') !== false) {  // Multilang is here
1698             $stringfilters = array('filter/multilang');       // Let's use just that
1699             $CFG->stringfilters = 'filter/multilang';         // Save it for next time through
1700         } else {
1701             $CFG->stringfilters = '';                         // Save the result and return
1702             return $string;
1703         }
1704     }
1707     foreach ($stringfilters as $stringfilter) {
1708         if (is_readable($CFG->dirroot .'/'. $stringfilter .'/filter.php')) {
1709             include_once($CFG->dirroot .'/'. $stringfilter .'/filter.php');
1710             $functionname = basename($stringfilter).'_filter';
1711             if (function_exists($functionname)) {
1712                 $string = $functionname($courseid, $string);
1713             }
1714         }
1715     }
1717     /// <nolink> tags removed for XHTML compatibility
1718     $string = str_replace('<nolink>', '', $string);
1719     $string = str_replace('</nolink>', '', $string);
1721     return $string;
1724 /**
1725  * Is the text marked as trusted?
1726  *
1727  * @param string $text text to be searched for TRUSTTEXT marker
1728  * @return boolean
1729  */
1730 function trusttext_present($text) {
1731     if (strpos($text, TRUSTTEXT) !== FALSE) {
1732         return true;
1733     } else {
1734         return false;
1735     }
1738 /**
1739  * This funtion MUST be called before the cleaning or any other
1740  * function that modifies the data! We do not know the origin of trusttext
1741  * in database, if it gets there in tweaked form we must not convert it
1742  * to supported form!!!
1743  *
1744  * Please be carefull not to use stripslashes on data from database
1745  * or twice stripslashes when processing data recieved from user.
1746  *
1747  * @param string $text text that may contain TRUSTTEXT marker
1748  * @return text without any TRUSTTEXT marker
1749  */
1750 function trusttext_strip($text) {
1751     global $CFG;
1753     while (true) { //removing nested TRUSTTEXT
1754         $orig = $text;
1755         $text = str_replace(TRUSTTEXT, '', $text);
1756         if (strcmp($orig, $text) === 0) {
1757             return $text;
1758         }
1759     }
1762 /**
1763  * Mark text as trusted, such text may contain any HTML tags because the
1764  * normal text cleaning will be bypassed.
1765  * Please make sure that the text comes from trusted user before storing
1766  * it into database!
1767  */
1768 function trusttext_mark($text) {
1769     global $CFG;
1770     if (!empty($CFG->enabletrusttext) and (strpos($text, TRUSTTEXT) === FALSE)) {
1771         return TRUSTTEXT.$text;
1772     } else {
1773         return $text;
1774     }
1776 function trusttext_after_edit(&$text, $context) {
1777     if (has_capability('moodle/site:trustcontent', $context)) {
1778         $text = trusttext_strip($text);
1779         $text = trusttext_mark($text);
1780     } else {
1781         $text = trusttext_strip($text);
1782     }
1785 function trusttext_prepare_edit(&$text, &$format, $usehtmleditor, $context) {
1786     global $CFG;
1788     $options = new object();
1789     $options->smiley = false;
1790     $options->filter = false;
1791     if (!empty($CFG->enabletrusttext)
1792          and has_capability('moodle/site:trustcontent', $context)
1793          and trusttext_present($text)) {
1794         $options->noclean = true;
1795     } else {
1796         $options->noclean = false;
1797     }
1798     $text = trusttext_strip($text);
1799     if ($usehtmleditor) {
1800         $text = format_text($text, $format, $options);
1801         $format = FORMAT_HTML;
1802     } else if (!$options->noclean){
1803         $text = clean_text($text, $format);
1804     }
1807 /**
1808  * Given raw text (eg typed in by a user), this function cleans it up
1809  * and removes any nasty tags that could mess up Moodle pages.
1810  *
1811  * @uses FORMAT_MOODLE
1812  * @uses FORMAT_PLAIN
1813  * @uses ALLOWED_TAGS
1814  * @param string $text The text to be cleaned
1815  * @param int $format Identifier of the text format to be used
1816  *            (FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN)
1817  * @return string The cleaned up text
1818  */
1819 function clean_text($text, $format=FORMAT_MOODLE) {
1821     global $ALLOWED_TAGS, $CFG;
1823     if (empty($text) or is_numeric($text)) {
1824        return (string)$text;
1825     }
1827     switch ($format) {
1828         case FORMAT_PLAIN:
1829         case FORMAT_MARKDOWN:
1830             return $text;
1832         default:
1834             if (!empty($CFG->enablehtmlpurifier)) {
1835                 $text = purify_html($text);
1836             } else {
1837             /// Fix non standard entity notations
1838                 $text = preg_replace('/(&#[0-9]+)(;?)/', "\\1;", $text);
1839                 $text = preg_replace('/(&#x[0-9a-fA-F]+)(;?)/', "\\1;", $text);
1841             /// Remove tags that are not allowed
1842                 $text = strip_tags($text, $ALLOWED_TAGS);
1844             /// Clean up embedded scripts and , using kses
1845                 $text = cleanAttributes($text);
1847             /// Again remove tags that are not allowed
1848                 $text = strip_tags($text, $ALLOWED_TAGS);
1850             }
1852         /// Remove potential script events - some extra protection for undiscovered bugs in our code
1853             $text = eregi_replace("([^a-z])language([[:space:]]*)=", "\\1Xlanguage=", $text);
1854             $text = eregi_replace("([^a-z])on([a-z]+)([[:space:]]*)=", "\\1Xon\\2=", $text);
1856             return $text;
1857     }
1860 /**
1861  * KSES replacement cleaning function - uses HTML Purifier.
1862  */
1863 function purify_html($text) {
1864     global $CFG;
1866     static $purifier = false;
1867     if (!$purifier) {
1868         require_once $CFG->libdir.'/htmlpurifier/HTMLPurifier.auto.php';
1869         $config = HTMLPurifier_Config::createDefault();
1870         $config->set('Core', 'AcceptFullDocuments', false);
1871         //$config->set('HTML', 'Strict', true);
1872         $config->set('URI', 'AllowedSchemes', array('http'=>1, 'https'=>1, 'ftp'=>1, 'irc'=>1, 'nntp'=>1, 'news'=>1, 'rtsp'=>1, 'teamspeak'=>1, 'gopher'=>1, 'mms'=>1));
1873         $purifier = new HTMLPurifier($config);
1874     }
1875     return $purifier->purify($text);
1878 /**
1879  * This function takes a string and examines it for HTML tags.
1880  * If tags are detected it passes the string to a helper function {@link cleanAttributes2()}
1881  *  which checks for attributes and filters them for malicious content
1882  *         17/08/2004              ::          Eamon DOT Costello AT dcu DOT ie
1883  *
1884  * @param string $str The string to be examined for html tags
1885  * @return string
1886  */
1887 function cleanAttributes($str){
1888     $result = preg_replace_callback(
1889             '%(<[^>]*(>|$)|>)%m', #search for html tags
1890             "cleanAttributes2",
1891             $str
1892             );
1893     return  $result;
1896 /**
1897  * This function takes a string with an html tag and strips out any unallowed
1898  * protocols e.g. javascript:
1899  * It calls ancillary functions in kses which are prefixed by kses
1900 *        17/08/2004              ::          Eamon DOT Costello AT dcu DOT ie
1901  *
1902  * @param array $htmlArray An array from {@link cleanAttributes()}, containing in its 1st
1903  *              element the html to be cleared
1904  * @return string
1905  */
1906 function cleanAttributes2($htmlArray){
1908     global $CFG, $ALLOWED_PROTOCOLS;
1909     require_once($CFG->libdir .'/kses.php');
1911     $htmlTag = $htmlArray[1];
1912     if (substr($htmlTag, 0, 1) != '<') {
1913         return '&gt;';  //a single character ">" detected
1914     }
1915     if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $htmlTag, $matches)) {
1916         return ''; // It's seriously malformed
1917     }
1918     $slash = trim($matches[1]); //trailing xhtml slash
1919     $elem = $matches[2];    //the element name
1920     $attrlist = $matches[3]; // the list of attributes as a string
1922     $attrArray = kses_hair($attrlist, $ALLOWED_PROTOCOLS);
1924     $attStr = '';
1925     foreach ($attrArray as $arreach) {
1926         $arreach['name'] = strtolower($arreach['name']);
1927         if ($arreach['name'] == 'style') {
1928             $value = $arreach['value'];
1929             while (true) {
1930                 $prevvalue = $value;
1931                 $value = kses_no_null($value);
1932                 $value = preg_replace("/\/\*.*\*\//Us", '', $value);
1933                 $value = kses_decode_entities($value);
1934                 $value = preg_replace('/(&#[0-9]+)(;?)/', "\\1;", $value);
1935                 $value = preg_replace('/(&#x[0-9a-fA-F]+)(;?)/', "\\1;", $value);
1936                 if ($value === $prevvalue) {
1937                     $arreach['value'] = $value;
1938                     break;
1939                 }
1940             }
1941             $arreach['value'] = preg_replace("/j\s*a\s*v\s*a\s*s\s*c\s*r\s*i\s*p\s*t/i", "Xjavascript", $arreach['value']);
1942             $arreach['value'] = preg_replace("/e\s*x\s*p\s*r\s*e\s*s\s*s\s*i\s*o\s*n/i", "Xexpression", $arreach['value']);
1943         } else if ($arreach['name'] == 'href') {
1944             //Adobe Acrobat Reader XSS protection
1945             $arreach['value'] = preg_replace('/(\.(pdf|fdf|xfdf|xdp|xfd))[^a-z0-9_\.\-].*$/i', '$1', $arreach['value']);
1946         }
1947         $attStr .=  ' '.$arreach['name'].'="'.$arreach['value'].'"';
1948     }
1950     $xhtml_slash = '';
1951     if (preg_match('%/\s*$%', $attrlist)) {
1952         $xhtml_slash = ' /';
1953     }
1954     return '<'. $slash . $elem . $attStr . $xhtml_slash .'>';
1957 /**
1958  * Replaces all known smileys in the text with image equivalents
1959  *
1960  * @uses $CFG
1961  * @param string $text Passed by reference. The string to search for smily strings.
1962  * @return string
1963  */
1964 function replace_smilies(&$text) {
1965 ///
1966     global $CFG;
1968     $lang = current_language();
1970 /// this builds the mapping array only once
1971     static $e = array();
1972     static $img = array();
1973     static $emoticons = array(
1974         ':-)'  => 'smiley',
1975         ':)'   => 'smiley',
1976         ':-D'  => 'biggrin',
1977         ';-)'  => 'wink',
1978         ':-/'  => 'mixed',
1979         'V-.'  => 'thoughtful',
1980         ':-P'  => 'tongueout',
1981         'B-)'  => 'cool',
1982         '^-)'  => 'approve',
1983         '8-)'  => 'wideeyes',
1984         ':o)'  => 'clown',
1985         ':-('  => 'sad',
1986         ':('   => 'sad',
1987         '8-.'  => 'shy',
1988         ':-I'  => 'blush',
1989         ':-X'  => 'kiss',
1990         '8-o'  => 'surprise',
1991         'P-|'  => 'blackeye',
1992         '8-['  => 'angry',
1993         'xx-P' => 'dead',
1994         '|-.'  => 'sleepy',
1995         '}-]'  => 'evil',
1996         '(h)'  => 'heart',
1997         '(heart)'  => 'heart',
1998         '(y)'  => 'yes',
1999         '(n)'  => 'no',
2000         '(martin)'  => 'martin',
2001         '( )'  => 'egg'
2002         );
2004     if (empty($img[$lang])) {  /// After the first time this is not run again
2005         $e[$lang] = array();
2006         $img[$lang] = array();
2007         foreach ($emoticons as $emoticon => $image){
2008             $alttext = get_string($image, 'pix');
2010             $e[$lang][] = $emoticon;
2011             $img[$lang][] = '<img alt="'. $alttext .'" width="15" height="15" src="'. $CFG->pixpath .'/s/'. $image .'.gif" />';
2012         }
2013     }
2015     // Exclude from transformations all the code inside <script> tags
2016     // Needed to solve Bug 1185. Thanks to jouse 2001 detecting it. :-)
2017     // Based on code from glossary fiter by Williams Castillo.
2018     //       - Eloy
2020     // Detect all the <script> zones to take out
2021     $excludes = array();
2022     preg_match_all('/<script language(.+?)<\/script>/is',$text,$list_of_excludes);
2024     // Take out all the <script> zones from text
2025     foreach (array_unique($list_of_excludes[0]) as $key=>$value) {
2026         $excludes['<+'.$key.'+>'] = $value;
2027     }
2028     if ($excludes) {
2029         $text = str_replace($excludes,array_keys($excludes),$text);
2030     }
2032 /// this is the meat of the code - this is run every time
2033     $text = str_replace($e[$lang], $img[$lang], $text);
2035     // Recover all the <script> zones to text
2036     if ($excludes) {
2037         $text = str_replace(array_keys($excludes),$excludes,$text);
2038     }
2041 /**
2042  * Given plain text, makes it into HTML as nicely as possible.
2043  * May contain HTML tags already
2044  *
2045  * @uses $CFG
2046  * @param string $text The string to convert.
2047  * @param boolean $smiley Convert any smiley characters to smiley images?
2048  * @param boolean $para If true then the returned string will be wrapped in paragraph tags
2049  * @param boolean $newlines If true then lines newline breaks will be converted to HTML newline breaks.
2050  * @return string
2051  */
2053 function text_to_html($text, $smiley=true, $para=true, $newlines=true) {
2054 ///
2056     global $CFG;
2058 /// Remove any whitespace that may be between HTML tags
2059     $text = eregi_replace(">([[:space:]]+)<", "><", $text);
2061 /// Remove any returns that precede or follow HTML tags
2062     $text = eregi_replace("([\n\r])<", " <", $text);
2063     $text = eregi_replace(">([\n\r])", "> ", $text);
2065     convert_urls_into_links($text);
2067 /// Make returns into HTML newlines.
2068     if ($newlines) {
2069         $text = nl2br($text);
2070     }
2072 /// Turn smileys into images.
2073     if ($smiley) {
2074         replace_smilies($text);
2075     }
2077 /// Wrap the whole thing in a paragraph tag if required
2078     if ($para) {
2079         return '<p>'.$text.'</p>';
2080     } else {
2081         return $text;
2082     }
2085 /**
2086  * Given Markdown formatted text, make it into XHTML using external function
2087  *
2088  * @uses $CFG
2089  * @param string $text The markdown formatted text to be converted.
2090  * @return string Converted text
2091  */
2092 function markdown_to_html($text) {
2093     global $CFG;
2095     require_once($CFG->libdir .'/markdown.php');
2097     return Markdown($text);
2100 /**
2101  * Given HTML text, make it into plain text using external function
2102  *
2103  * @uses $CFG
2104  * @param string $html The text to be converted.
2105  * @return string
2106  */
2107 function html_to_text($html) {
2109     global $CFG;
2111     require_once($CFG->libdir .'/html2text.php');
2113     return html2text($html);
2116 /**
2117  * Given some text this function converts any URLs it finds into HTML links
2118  *
2119  * @param string $text Passed in by reference. The string to be searched for urls.
2120  */
2121 function convert_urls_into_links(&$text) {
2122 /// Make lone URLs into links.   eg http://moodle.com/
2123     $text = eregi_replace("([[:space:]]|^|\(|\[)([[:alnum:]]+)://([^[:space:]]*)([[:alnum:]#?/&=])",
2124                           "\\1<a href=\"\\2://\\3\\4\" target=\"_blank\">\\2://\\3\\4</a>", $text);
2126 /// eg www.moodle.com
2127     $text = eregi_replace("([[:space:]]|^|\(|\[)www\.([^[:space:]]*)([[:alnum:]#?/&=])",
2128                           "\\1<a href=\"http://www.\\2\\3\" target=\"_blank\">www.\\2\\3</a>", $text);
2131 /**
2132  * This function will highlight search words in a given string
2133  * It cares about HTML and will not ruin links.  It's best to use
2134  * this function after performing any conversions to HTML.
2135  * Function found here: http://forums.devshed.com/t67822/scdaa2d1c3d4bacb4671d075ad41f0854.html
2136  *
2137  * @param string $needle The string to search for
2138  * @param string $haystack The string to search for $needle in
2139  * @param int $case ?
2140  * @return string
2141  * @todo Finish documenting this function
2142  */
2143 function highlight($needle, $haystack, $case=0,
2144                     $left_string='<span class="highlight">', $right_string='</span>') {
2145     if (empty($needle)) {
2146         return $haystack;
2147     }
2149     //$list_of_words = eregi_replace("[^-a-zA-Z0-9&.']", " ", $needle);  // bug 3101
2150     $list_of_words = $needle;
2151     $list_array = explode(' ', $list_of_words);
2152     for ($i=0; $i<sizeof($list_array); $i++) {
2153         if (strlen($list_array[$i]) == 1) {
2154             $list_array[$i] = '';
2155         }
2156     }
2157     $list_of_words = implode(' ', $list_array);
2158     $list_of_words_cp = $list_of_words;
2159     $final = array();
2160     preg_match_all('/<(.+?)>/is',$haystack,$list_of_words);
2162     foreach (array_unique($list_of_words[0]) as $key=>$value) {
2163         $final['<|'.$key.'|>'] = $value;
2164     }
2166     $haystack = str_replace($final,array_keys($final),$haystack);
2167     $list_of_words_cp = eregi_replace(' +', '|', $list_of_words_cp);
2169     if ($list_of_words_cp{0}=='|') {
2170         $list_of_words_cp{0} = '';
2171     }
2172     if ($list_of_words_cp{strlen($list_of_words_cp)-1}=='|') {
2173         $list_of_words_cp{strlen($list_of_words_cp)-1}='';
2174     }
2176     $list_of_words_cp = trim($list_of_words_cp);
2178     if ($list_of_words_cp) {
2180       $list_of_words_cp = "(". $list_of_words_cp .")";
2182       if (!$case){
2183         $haystack = eregi_replace("$list_of_words_cp", "$left_string"."\\1"."$right_string", $haystack);
2184       } else {
2185         $haystack = ereg_replace("$list_of_words_cp", "$left_string"."\\1"."$right_string", $haystack);
2186       }
2187     }
2188     $haystack = str_replace(array_keys($final),$final,$haystack);
2190     return $haystack;
2193 /**
2194  * This function will highlight instances of $needle in $haystack
2195  * It's faster that the above function and doesn't care about
2196  * HTML or anything.
2197  *
2198  * @param string $needle The string to search for
2199  * @param string $haystack The string to search for $needle in
2200  * @return string
2201  */
2202 function highlightfast($needle, $haystack) {
2204     $parts = explode(moodle_strtolower($needle), moodle_strtolower($haystack));
2206     $pos = 0;
2208     foreach ($parts as $key => $part) {
2209         $parts[$key] = substr($haystack, $pos, strlen($part));
2210         $pos += strlen($part);
2212         $parts[$key] .= '<span class="highlight">'.substr($haystack, $pos, strlen($needle)).'</span>';
2213         $pos += strlen($needle);
2214     }
2216     return (join('', $parts));
2219 /**
2220  * Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.
2221  * Internationalisation, for print_header and backup/restorelib.
2222  * @param $dir Default false.
2223  * @return string Attributes.
2224  */
2225 function get_html_lang($dir = false) {
2226     $direction = '';
2227     if ($dir) {
2228         if (get_string('thisdirection') == 'rtl') {
2229             $direction = ' dir="rtl"';
2230         } else {
2231             $direction = ' dir="ltr"';
2232         }
2233     }
2234     //Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
2235     $language = str_replace('_', '-', str_replace('_utf8', '', current_language()));
2236     @header('Content-Language: '.$language);
2237     return ($direction.' lang="'.$language.'" xml:lang="'.$language.'"');
2241 /// STANDARD WEB PAGE PARTS ///////////////////////////////////////////////////
2243 /**
2244  * Print a standard header
2245  *
2246  * @uses $USER
2247  * @uses $CFG
2248  * @uses $SESSION
2249  * @param string $title Appears at the top of the window
2250  * @param string $heading Appears at the top of the page
2251  * @param string $navigation Premade navigation string (for use as breadcrumbs links)
2252  * @param string $focus Indicates form element to get cursor focus on load eg  inputform.password
2253  * @param string $meta Meta tags to be added to the header
2254  * @param boolean $cache Should this page be cacheable?
2255  * @param string $button HTML code for a button (usually for module editing)
2256  * @param string $menu HTML code for a popup menu
2257  * @param boolean $usexml use XML for this page
2258  * @param string $bodytags This text will be included verbatim in the <body> tag (useful for onload() etc)
2259  * @param bool   $return If true, return the visible elements of the header instead of echoing them.
2260  */
2261 function print_header ($title='', $heading='', $navigation='', $focus='',
2262                        $meta='', $cache=true, $button='&nbsp;', $menu='',
2263                        $usexml=false, $bodytags='', $return=false) {
2265     global $USER, $CFG, $THEME, $SESSION, $ME, $SITE, $COURSE;
2267     $heading = format_string($heading); // Fix for MDL-8582
2269 /// This makes sure that the header is never repeated twice on a page
2270     if (defined('HEADER_PRINTED')) {
2271         debugging('print_header() was called more than once - this should not happen.  Please check the code for this page closely. Note: error() and redirect() are now safe to call after print_header().');
2272         return;
2273     }
2274     define('HEADER_PRINTED', 'true');
2277 /// Add the required stylesheets
2278     $stylesheetshtml = '';
2279     foreach ($CFG->stylesheets as $stylesheet) {
2280         $stylesheetshtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
2281     }
2282     $meta = $stylesheetshtml.$meta;
2285 /// Add the meta page from the themes if any were requested
2287     $metapage = '';
2289     if (!isset($THEME->standardmetainclude) || $THEME->standardmetainclude) {
2290         ob_start();
2291         include_once($CFG->dirroot.'/theme/standard/meta.php');
2292         $metapage .= ob_get_contents();
2293         ob_end_clean();
2294     }
2296     if ($THEME->parent && (!isset($THEME->parentmetainclude) || $THEME->parentmetainclude)) {
2297         if (file_exists($CFG->dirroot.'/theme/'.$THEME->parent.'/meta.php')) {
2298             ob_start();
2299             include_once($CFG->dirroot.'/theme/'.$THEME->parent.'/meta.php');
2300             $metapage .= ob_get_contents();
2301             ob_end_clean();
2302         }
2303     }
2305     if (!isset($THEME->metainclude) || $THEME->metainclude) {
2306         if (file_exists($CFG->dirroot.'/theme/'.current_theme().'/meta.php')) {
2307             ob_start();
2308             include_once($CFG->dirroot.'/theme/'.current_theme().'/meta.php');
2309             $metapage .= ob_get_contents();
2310             ob_end_clean();
2311         }
2312     }
2314     $meta = $meta."\n".$metapage;
2317 /// Add the required JavaScript Libraries
2318     $meta .= "\n".require_js();
2320     if(is_newnav($navigation)){
2321         $home = false;
2322     } else {
2323         if ($navigation == 'home') {
2324             $home = true;
2325             $navigation = '';
2326         } else {
2327             $home = false;
2328         }
2329     }
2331 /// This is another ugly hack to make navigation elements available to print_footer later
2332     $THEME->title      = $title;
2333     $THEME->heading    = $heading;
2334     $THEME->navigation = $navigation;
2335     $THEME->button     = $button;
2336     $THEME->menu       = $menu;
2337     $navmenulist = isset($THEME->navmenulist) ? $THEME->navmenulist : '';
2339     if ($button == '') {
2340         $button = '&nbsp;';
2341     }
2343     if (!$menu and $navigation) {
2344         if (empty($CFG->loginhttps)) {
2345             $wwwroot = $CFG->wwwroot;
2346         } else {
2347             $wwwroot = str_replace('http:','https:',$CFG->wwwroot);
2348         }
2349         $menu = user_login_string($COURSE);
2350     }
2352     if (isset($SESSION->justloggedin)) {
2353         unset($SESSION->justloggedin);
2354         if (!empty($CFG->displayloginfailures)) {
2355             if (!empty($USER->username) and $USER->username != 'guest') {
2356                 if ($count = count_login_failures($CFG->displayloginfailures, $USER->username, $USER->lastlogin)) {
2357                     $menu .= '&nbsp;<font size="1">';
2358                     if (empty($count->accounts)) {
2359                         $menu .= get_string('failedloginattempts', '', $count);
2360                     } else {
2361                         $menu .= get_string('failedloginattemptsall', '', $count);
2362                     }
2363                     if (has_capability('moodle/site:viewreports', get_context_instance(CONTEXT_SYSTEM, SITEID))) {
2364                         $menu .= ' (<a href="'.$CFG->wwwroot.'/course/report/log/index.php'.
2365                                              '?chooselog=1&amp;id=1&amp;modid=site_errors">'.get_string('logs').'</a>)';
2366                     }
2367                     $menu .= '</font>';
2368                 }
2369             }
2370         }
2371     }
2374     $meta = '<meta http-equiv="content-type" content="text/html; charset=utf-8" />'. "\n". $meta ."\n";
2375     if (!$usexml) {
2376         @header('Content-type: text/html; charset=utf-8');
2377     }
2379     //Accessibility: added the 'lang' attribute to $direction, used in theme <html> tag.
2380     $direction = get_html_lang($dir=true);
2382     if ($cache) {  // Allow caching on "back" (but not on normal clicks)
2383         @header('Cache-Control: private, pre-check=0, post-check=0, max-age=0');
2384         @header('Pragma: no-cache');
2385         @header('Expires: ');
2386     } else {       // Do everything we can to always prevent clients and proxies caching
2387         @header('Cache-Control: no-store, no-cache, must-revalidate');
2388         @header('Cache-Control: post-check=0, pre-check=0', false);
2389         @header('Pragma: no-cache');
2390         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2391         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2393         $meta .= "\n<meta http-equiv=\"pragma\" content=\"no-cache\" />";
2394         $meta .= "\n<meta http-equiv=\"expires\" content=\"0\" />";
2395     }
2396     @header('Accept-Ranges: none');
2398     $currentlanguage = current_language();
2400     if (empty($usexml)) {
2401         $direction =  ' xmlns="http://www.w3.org/1999/xhtml"'. $direction;  // See debug_header
2402     } else {
2403         $mathplayer = preg_match("/MathPlayer/i", $_SERVER['HTTP_USER_AGENT']);
2404         if(!$mathplayer) {
2405             header('Content-Type: application/xhtml+xml');
2406         }
2407         echo '<?xml version="1.0" ?>'."\n";
2408         if (!empty($CFG->xml_stylesheets)) {
2409             $stylesheets = explode(';', $CFG->xml_stylesheets);
2410             foreach ($stylesheets as $stylesheet) {
2411                 echo '<?xml-stylesheet type="text/xsl" href="'. $CFG->wwwroot .'/'. $stylesheet .'" ?>' . "\n";
2412             }
2413         }
2414         echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1';
2415         if (!empty($CFG->xml_doctype_extra)) {
2416             echo ' plus '. $CFG->xml_doctype_extra;
2417         }
2418         echo '//' . strtoupper($currentlanguage) . '" "'. $CFG->xml_dtd .'">'."\n";
2419         $direction = " xmlns=\"http://www.w3.org/1999/xhtml\"
2420                        xmlns:math=\"http://www.w3.org/1998/Math/MathML\"
2421                        xmlns:xlink=\"http://www.w3.org/1999/xlink\"
2422                        $direction";
2423         if($mathplayer) {
2424             $meta .= '<object id="mathplayer" classid="clsid:32F66A20-7614-11D4-BD11-00104BD3F987">' . "\n";
2425             $meta .= '<!--comment required to prevent this becoming an empty tag-->'."\n";
2426             $meta .= '</object>'."\n";
2427             $meta .= '<?import namespace="math" implementation="#mathplayer" ?>' . "\n";
2428         }
2429     }
2431     // Clean up the title
2433     $title = format_string($title);    // fix for MDL-8582
2434     $title = str_replace('"', '&quot;', $title);
2436     // Create class and id for this page
2438     page_id_and_class($pageid, $pageclass);
2440     $pageclass .= ' course-'.$COURSE->id;
2442     if (($pageid != 'site-index') && ($pageid != 'course-view') &&
2443         (strstr($pageid, 'admin') === FALSE)) {
2444         $pageclass .= ' nocoursepage';
2445     }
2447     if (!isloggedin()) {
2448         $pageclass .= ' notloggedin';
2449     }
2451     if (!empty($USER->editing)) {
2452         $pageclass .= ' editing';
2453     }
2455     if (!empty($CFG->blocksdrag)) {
2456         $pageclass .= ' drag';
2457     }
2459     if (!empty($CFG->langdirection)) {
2460         $pageclass .= ' ' . $CFG->langdirection;
2461     }
2463     $pageclass .= ' lang-'.$currentlanguage;
2465     $bodytags .= ' class="'.$pageclass.'" id="'.$pageid.'"';
2467     ob_start();
2468     include($CFG->header);
2469     $output = ob_get_contents();
2470     ob_end_clean();
2472     $output = force_strict_header($output);
2474     if (!empty($CFG->messaging)) {
2475         $output .= message_popup_window();
2476     }
2478     if ($return) {
2479         return $output;
2480     } else {
2481         echo $output;
2482     }
2485 /**
2486  * Debugging aid: serve page as 'application/xhtml+xml' where possible,
2487  *     and substitute the XHTML strict document type.
2488  *     Note, requires the 'xmlns' fix in function print_header above.
2489  *     See:  http://tracker.moodle.org/browse/MDL-7883
2490  * TODO:
2491  */
2492 function force_strict_header($output) {
2493     global $CFG;
2494     $strict = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
2495     $xsl = '/lib/xhtml.xsl';
2497     if (!headers_sent() && debugging(NULL, DEBUG_DEVELOPER)) {   // In developer debugging, the browser will barf
2498         $ctype = 'Content-Type: ';
2499         $prolog= "<?xml version='1.0' encoding='utf-8'?>\n";
2501         if (isset($_SERVER['HTTP_ACCEPT'])
2502             && false !== strpos($_SERVER['HTTP_ACCEPT'], 'application/xhtml+xml')) {
2503             //|| false !== strpos($_SERVER['HTTP_USER_AGENT'], 'Safari') //Safari "Entity 'copy' not defined".
2504             // Firefox et al.
2505             $ctype .= 'application/xhtml+xml';
2506             $prolog .= "<!--\n  DEBUG: $ctype \n-->\n";
2508         } else if (file_exists($CFG->dirroot.$xsl)
2509             && preg_match('/MSIE.*Windows NT/', $_SERVER['HTTP_USER_AGENT'])) {
2510             // XSL hack for IE 5+ on Windows.
2511             //$www_xsl = preg_replace('/(http:\/\/.+?\/).*/', '', $CFG->wwwroot) .$xsl;
2512             $www_xsl = $CFG->wwwroot .$xsl;
2513             $ctype .= 'application/xml';
2514             $prolog .= "<?xml-stylesheet type='text/xsl' href='$www_xsl'?>\n";
2515             $prolog .= "<!--\n  DEBUG: $ctype \n-->\n";
2517         } else {
2518             //ELSE: Mac/IE, old/non-XML browsers.
2519             $ctype .= 'text/html';
2520             $prolog = '';
2521         }
2522         @header($ctype.'; charset=utf-8');
2523         $output = $prolog . $output;
2525         // Test parser error-handling.
2526         if (isset($_GET['error'])) {
2527             $output .= "__ TEST: XML well-formed error < __\n";
2528         }
2529     }
2531     $output = preg_replace('/(<!DOCTYPE.+?>)/s', $strict, $output);   // Always change the DOCTYPE to Strict 1.0
2533     return $output;
2538 /**
2539  * This version of print_header is simpler because the course name does not have to be
2540  * provided explicitly in the strings. It can be used on the site page as in courses
2541  * Eventually all print_header could be replaced by print_header_simple
2542  *
2543  * @param string $title Appears at the top of the window
2544  * @param string $heading Appears at the top of the page
2545  * @param string $navigation Premade navigation string (for use as breadcrumbs links)
2546  * @param string $focus Indicates form element to get cursor focus on load eg  inputform.password
2547  * @param string $meta Meta tags to be added to the header
2548  * @param boolean $cache Should this page be cacheable?
2549  * @param string $button HTML code for a button (usually for module editing)
2550  * @param string $menu HTML code for a popup menu
2551  * @param boolean $usexml use XML for this page
2552  * @param string $bodytags This text will be included verbatim in the <body> tag (useful for onload() etc)
2553  * @param bool   $return If true, return the visible elements of the header instead of echoing them.
2554  */
2555 function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
2556                        $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
2558     global $COURSE, $CFG;
2560     $shortname ='';
2561     if ($COURSE->id != SITEID) {
2562         $shortname = '<a href="'.$CFG->wwwroot.'/course/view.php?id='. $COURSE->id .'">'. $COURSE->shortname .'</a> ->';
2563     }
2565     // If old style nav prepend course short name otherwise leave $navigation object alone
2566     if (!is_newnav($navigation)) {
2567         $navigation = $shortname.' '.$navigation;
2568     }
2570     $output = print_header($COURSE->shortname .': '. $title, $COURSE->fullname .' '. $heading, $navigation, $focus, $meta,
2571                            $cache, $button, $menu, $usexml, $bodytags, true);
2573     if ($return) {
2574         return $output;
2575     } else {
2576         echo $output;
2577     }
2581 /**
2582  * Can provide a course object to make the footer contain a link to
2583  * to the course home page, otherwise the link will go to the site home
2584  *
2585  * @uses $CFG
2586  * @uses $USER
2587  * @param course $course {@link $COURSE} object containing course information
2588  * @param ? $usercourse ?
2589  * @todo Finish documenting this function
2590  */
2591 function print_footer($course=NULL, $usercourse=NULL, $return=false) {
2592     global $USER, $CFG, $THEME, $COURSE;
2594     if (defined('ADMIN_EXT_HEADER_PRINTED') and !defined('ADMIN_EXT_FOOTER_PRINTED')) {
2595         admin_externalpage_print_footer();
2596         return;
2597     }
2599 /// Course links
2600     if ($course) {
2601         if (is_string($course) && $course == 'none') {          // Don't print any links etc
2602             $homelink = '';
2603             $loggedinas = '';
2604             $home  = false;
2605         } else if (is_string($course) && $course == 'home') {   // special case for site home page - please do not remove
2606             $course = get_site();
2607             $homelink  = '<div class="sitelink">'.
2608                '<a title="moodle '. $CFG->release .' ('. $CFG->version .')" href="http://moodle.org/">'.
2609                '<br /><img style="width:100px;height:30px" src="pix/moodlelogo.gif" alt="moodlelogo" /></a></div>';
2610             $home  = true;
2611         } else {
2612             $homelink = '<div class="homelink"><a '.$CFG->frametarget.' href="'.$CFG->wwwroot.
2613                         '/course/view.php?id='.$course->id.'">'.format_string($course->shortname).'</a></div>';
2614             $home  = false;
2615         }
2616     } else {
2617         $course = get_site();  // Set course as site course by default
2618         $homelink = '<div class="homelink"><a '.$CFG->frametarget.' href="'.$CFG->wwwroot.'/">'.get_string('home').'</a></div>';
2619         $home  = false;
2620     }
2622 /// Set up some other navigation links (passed from print_header by ugly hack)
2623     $menu        = isset($THEME->menu) ? str_replace('navmenu', 'navmenufooter', $THEME->menu) : '';
2624     $title       = isset($THEME->title) ? $THEME->title : '';
2625     $button      = isset($THEME->button) ? $THEME->button : '';
2626     $heading     = isset($THEME->heading) ? $THEME->heading : '';
2627     $navigation  = isset($THEME->navigation) ? $THEME->navigation : '';
2628     $navmenulist = isset($THEME->navmenulist) ? $THEME->navmenulist : '';
2631 /// Set the user link if necessary
2632     if (!$usercourse and is_object($course)) {
2633         $usercourse = $course;
2634     }
2636     if (!isset($loggedinas)) {
2637         $loggedinas = user_login_string($usercourse, $USER);
2638     }
2640     if ($loggedinas == $menu) {
2641         $menu = '';
2642     }
2644 /// Provide some performance info if required
2645     $performanceinfo = '';
2646     if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
2647         $perf = get_performance_info();
2648         if (defined('MDL_PERFTOLOG')) {
2649             error_log("PERF: " . $perf['txt']);
2650         }
2651         if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
2652             $performanceinfo = $perf['html'];
2653         }
2654     }
2657 /// Include the actual footer file
2659     ob_start();
2660     include($CFG->footer);
2661     $output = ob_get_contents();
2662     ob_end_clean();
2664     if ($return) {
2665         return $output;
2666     } else {
2667         echo $output;
2668     }
2671 /**
2672  * Returns the name of the current theme
2673  *
2674  * @uses $CFG
2675  * @uses $USER
2676  * @uses $SESSION
2677  * @uses $COURSE
2678  * @uses $FULLME
2679  * @return string
2680  */
2681 function current_theme() {
2682     global $CFG, $USER, $SESSION, $COURSE, $FULLME;
2684     if (empty($CFG->themeorder)) {
2685         $themeorder = array('page', 'course', 'category', 'session', 'user', 'site');
2686     } else {
2687         $themeorder = $CFG->themeorder;
2688     }
2690     $theme = '';
2691     foreach ($themeorder as $themetype) {
2693         if (!empty($theme)) continue;
2695         switch ($themetype) {
2696             case 'page': // Page theme is for special page-only themes set by code
2697                 if (!empty($CFG->pagetheme)) {
2698                     $theme = $CFG->pagetheme;
2699                 }
2700                 break;
2701             case 'course':
2702                 if (!empty($CFG->allowcoursethemes) and !empty($COURSE->theme)) {
2703                     $theme = $COURSE->theme;
2704                 }
2705                 break;
2706             case 'category':
2707                 if (!empty($CFG->allowcategorythemes)) {
2708                 /// Nasty hack to check if we're in a category page
2709                     if (stripos($FULLME, 'course/category.php') !== false) {
2710                         global $id;
2711                         if (!empty($id)) {
2712                             $theme = current_category_theme($id);
2713                         }
2714                 /// Otherwise check if we're in a course that has a category theme set
2715                     } else if (!empty($COURSE->category)) {
2716                         $theme = current_category_theme($COURSE->category);
2717                     }
2718                 }
2719                 break;
2720             case 'session':
2721                 if (!empty($SESSION->theme)) {
2722                     $theme = $SESSION->theme;
2723                 }
2724                 break;
2725             case 'user':
2726                 if (!empty($CFG->allowuserthemes) and !empty($USER->theme)) {
2727                     $theme = $USER->theme;
2728                 }
2729                 break;
2730             case 'site':
2731                 $theme = $CFG->theme;
2732                 break;
2733             default:
2734                 /// do nothing
2735         }
2736     }
2738 /// A final check in case 'site' was not included in $CFG->themeorder
2739     if (empty($theme)) {
2740         $theme = $CFG->theme;
2741     }
2743     return $theme;
2746 /**
2747  * Retrieves the category theme if one exists, otherwise checks the parent categories.
2748  * Recursive function.
2749  *
2750  * @uses $COURSE
2751  * @param   integer   $categoryid   id of the category to check
2752  * @return  string    theme name
2753  */
2754 function current_category_theme($categoryid=0) {
2755     global $COURSE;
2757 /// Use the COURSE global if the categoryid not set
2758     if (empty($categoryid)) {
2759         if (!empty($COURSE->category)) {
2760             $categoryid = $COURSE->category;
2761         } else {
2762             return false;
2763         }
2764     }
2766 /// Retrieve the current category
2767     if ($category = get_record('course_categories', 'id', $categoryid)) {
2769     /// Return the category theme if it exists
2770         if (!empty($category->theme)) {
2771             return $category->theme;
2773     /// Otherwise try the parent category if one exists
2774         } else if (!empty($category->parent)) {
2775             return current_category_theme($category->parent);
2776         }
2778 /// Return false if we can't find the category record
2779     } else {
2780         return false;
2781     }
2784 /**
2785  * This function is called by stylesheets to set up the header
2786  * approriately as well as the current path
2787  *
2788  * @uses $CFG
2789  * @param int $lastmodified ?
2790  * @param int $lifetime ?
2791  * @param string $thename ?
2792  */
2793 function style_sheet_setup($lastmodified=0, $lifetime=300, $themename='', $forceconfig='', $lang='') {
2795     global $CFG, $THEME;
2797     // Fix for IE6 caching - we don't want the filemtime('styles.php'), instead use now.
2798     $lastmodified = time();
2800     header('Last-Modified: ' . gmdate("D, d M Y H:i:s", $lastmodified) . ' GMT');
2801     header('Expires: ' . gmdate("D, d M Y H:i:s", time() + $lifetime) . ' GMT');
2802     header('Cache-Control: max-age='. $lifetime);
2803     header('Pragma: ');
2804     header('Content-type: text/css');  // Correct MIME type
2806     $DEFAULT_SHEET_LIST = array('styles_layout', 'styles_fonts', 'styles_color');
2808     if (empty($themename)) {
2809         $themename = current_theme();  // So we have something.  Normally not needed.
2810     } else {
2811         $themename = clean_param($themename, PARAM_SAFEDIR);
2812     }
2814     if (!empty($forceconfig)) {        // Page wants to use the config from this theme instead
2815         unset($THEME);
2816         include($CFG->themedir.'/'.$forceconfig.'/'.'config.php');
2817     }
2819 /// If this is the standard theme calling us, then find out what sheets we need
2821     if ($themename == 'standard') {
2822         if (!isset($THEME->standardsheets) or $THEME->standardsheets === true) { // Use all the sheets we have
2823             $THEME->sheets = $DEFAULT_SHEET_LIST;
2824         } else if (empty($THEME->standardsheets)) {                              // We can stop right now!
2825             echo "/***** Nothing required from this stylesheet by main theme *****/\n\n";
2826             exit;
2827         } else {                                                                 // Use the provided subset only
2828             $THEME->sheets = $THEME->standardsheets;
2829         }
2831 /// If we are a parent theme, then check for parent definitions
2833     } else if (!empty($THEME->parent) && $themename == $THEME->parent) {
2834         if (!isset($THEME->parentsheets) or $THEME->parentsheets === true) {     // Use all the sheets we have
2835             $THEME->sheets = $DEFAULT_SHEET_LIST;
2836         } else if (empty($THEME->parentsheets)) {                                // We can stop right now!
2837             echo "/***** Nothing required from this stylesheet by main theme *****/\n\n";
2838             exit;
2839         } else {                                                                 // Use the provided subset only
2840             $THEME->sheets = $THEME->parentsheets;
2841         }
2842     }
2844 /// Work out the last modified date for this theme
2846     foreach ($THEME->sheets as $sheet) {
2847         if (file_exists($CFG->themedir.'/'.$themename.'/'.$sheet.'.css')) {
2848             $sheetmodified = filemtime($CFG->themedir.'/'.$themename.'/'.$sheet.'.css');
2849             if ($sheetmodified > $lastmodified) {
2850                 $lastmodified = $sheetmodified;
2851             }
2852         }
2853     }
2856 /// Get a list of all the files we want to include
2857     $files = array();
2859     foreach ($THEME->sheets as $sheet) {
2860         $files[] = array($CFG->themedir, $themename.'/'.$sheet.'.css');
2861     }
2863     if ($themename == 'standard') {          // Add any standard styles included in any modules
2864         if (!empty($THEME->modsheets)) {     // Search for styles.php within activity modules
2865             if ($mods = get_list_of_plugins('mod')) {
2866                 foreach ($mods as $mod) {
2867                     if (file_exists($CFG->dirroot.'/mod/'.$mod.'/styles.php')) {
2868                         $files[] = array($CFG->dirroot, '/mod/'.$mod.'/styles.php');
2869                     }
2870                 }
2871             }
2872         }
2874         if (!empty($THEME->blocksheets)) {     // Search for styles.php within block modules
2875             if ($mods = get_list_of_plugins('blocks')) {
2876                 foreach ($mods as $mod) {
2877                     if (file_exists($CFG->dirroot.'/blocks/'.$mod.'/styles.php')) {
2878                         $files[] = array($CFG->dirroot, '/blocks/'.$mod.'/styles.php');
2879                     }
2880                 }
2881             }
2882         }
2884         if (!isset($THEME->courseformatsheets) || $THEME->courseformatsheets) { // Search for styles.php in course formats
2885             if ($mods = get_list_of_plugins('format','',$CFG->dirroot.'/course')) {
2886                 foreach ($mods as $mod) {
2887                     if (file_exists($CFG->dirroot.'/course/format/'.$mod.'/styles.php')) {
2888                         $files[] = array($CFG->dirroot, '/course/format/'.$mod.'/styles.php');
2889                     }
2890                 }
2891             }
2892         }
2894         if (!empty($THEME->langsheets)) {     // Search for styles.php within the current language
2895             if (file_exists($CFG->dirroot.'/lang/'.$lang.'/styles.php')) {
2896                 $files[] = array($CFG->dirroot, '/lang/'.$lang.'/styles.php');
2897             }
2898         }
2899     }
2902     if ($files) {
2903     /// Produce a list of all the files first
2904         echo '/**************************************'."\n";
2905         echo ' * THEME NAME: '.$themename."\n *\n";
2906         echo ' * Files included in this sheet:'."\n *\n";
2907         foreach ($files as $file) {
2908             echo ' *   '.$file[1]."\n";
2909         }
2910         echo ' **************************************/'."\n\n";
2913         /// check if csscobstants is set
2914         if (!empty($THEME->cssconstants)) {
2915             require_once("$CFG->libdir/cssconstants.php");
2916             /// Actually collect all the files in order.
2917             $css = '';
2918             foreach ($files as $file) {
2919                 $css .= '/***** '.$file[1].' start *****/'."\n\n";
2920                 $css .= file_get_contents($file[0].'/'.$file[1]);
2921                 $ccs .= '/***** '.$file[1].' end *****/'."\n\n";
2922             }
2923             /// replace css_constants with their values
2924             echo replace_cssconstants($css);
2925         } else {
2926         /// Actually output all the files in order.
2927             if (empty($CFG->CSSEdit) && empty($THEME->CSSEdit)) {
2928                 foreach ($files as $file) {
2929                     echo '/***** '.$file[1].' start *****/'."\n\n";
2930                     @include_once($file[0].'/'.$file[1]);
2931                     echo '/***** '.$file[1].' end *****/'."\n\n";
2932                 }
2933             } else {
2934                 foreach ($files as $file) {
2935                     echo '/* @group '.$file[1].' */'."\n\n";
2936                     if (strstr($file[1], '.css') !== FALSE) {
2937                         echo '@import url("'.$CFG->themewww.'/'.$file[1].'");'."\n\n";
2938                     } else {
2939                         @include_once($file[0].'/'.$file[1]);
2940                     }
2941                     echo '/* @end */'."\n\n";
2942                 }
2943             }
2944         }
2945     }
2947     return $CFG->themewww.'/'.$themename;   // Only to help old themes (1.4 and earlier)
2951 function theme_setup($theme = '', $params=NULL) {
2952 /// Sets up global variables related to themes
2954     global $CFG, $THEME, $SESSION, $USER, $HTTPSPAGEREQUIRED;
2956     if (empty($theme)) {
2957         $theme = current_theme();
2958     }
2960 /// If the theme doesn't exist for some reason then revert to standardwhite
2961     if (!file_exists($CFG->themedir .'/'. $theme .'/config.php')) {
2962         $CFG->theme = $theme = 'standardwhite';
2963     }
2965 /// Load up the theme config
2966     $THEME = NULL;   // Just to be sure
2967     include($CFG->themedir .'/'. $theme .'/config.php');  // Main config for current theme
2969 /// Put together the parameters
2970     if (!$params) {
2971         $params = array();
2972     }
2973     if ($theme != $CFG->theme) {
2974         $params[] = 'forceconfig='.$theme;
2975     }
2977 /// Force language too if required
2978     if (!empty($THEME->langsheets)) {
2979         $params[] = 'lang='.current_language();
2980     }
2982 /// Convert params to string
2983     if ($params) {
2984         $paramstring = '?'.implode('&', $params);
2985     } else {
2986         $paramstring = '';
2987     }
2989 /// Set up image paths
2990     if(isset($CFG->smartpix) && $CFG->smartpix==1) {
2991         if($CFG->slasharguments) {        // Use this method if possible for better caching
2992             $extra='';
2993         } else {
2994             $extra='?file=';
2995         }
2997         $CFG->pixpath = $CFG->wwwroot. '/pix/smartpix.php'.$extra.'/'.$theme;
2998         $CFG->modpixpath = $CFG->wwwroot .'/pix/smartpix.php'.$extra.'/'.$theme.'/mod';
2999     } else if (empty($THEME->custompix)) {    // Could be set in the above file
3000         $CFG->pixpath = $CFG->wwwroot .'/pix';
3001         $CFG->modpixpath = $CFG->wwwroot .'/mod';
3002     } else {
3003         $CFG->pixpath = $CFG->themewww .'/'. $theme .'/pix';
3004         $CFG->modpixpath = $CFG->themewww .'/'. $theme .'/pix/mod';
3005     }
3007 /// Header and footer paths
3008     $CFG->header = $CFG->themedir .'/'. $theme .'/header.html';
3009     $CFG->footer = $CFG->themedir .'/'. $theme .'/footer.html';
3011 /// Define stylesheet loading order
3012     $CFG->stylesheets = array();
3013     if ($theme != 'standard') {    /// The standard sheet is always loaded first
3014         $CFG->stylesheets[] = $CFG->themewww.'/standard/styles.php'.$paramstring;
3015     }
3016     if (!empty($THEME->parent)) {  /// Parent stylesheets are loaded next
3017         $CFG->stylesheets[] = $CFG->themewww.'/'.$THEME->parent.'/styles.php'.$paramstring;
3018     }
3019     $CFG->stylesheets[] = $CFG->themewww.'/'.$theme.'/styles.php'.$paramstring;
3021 /// We have to change some URLs in styles if we are in a $HTTPSPAGEREQUIRED page
3022     if (!empty($HTTPSPAGEREQUIRED)) {
3023         $CFG->themewww = str_replace('http:', 'https:', $CFG->themewww);
3024         $CFG->pixpath = str_replace('http:', 'https:', $CFG->pixpath);
3025         $CFG->modpixpath = str_replace('http:', 'https:', $CFG->modpixpath);
3026         foreach ($CFG->stylesheets as $key => $stylesheet) {
3027             $CFG->stylesheets[$key] = str_replace('http:', 'https:', $stylesheet);
3028         }
3029     }
3034 /**
3035  * Returns text to be displayed to the user which reflects their login status
3036  *
3037  * @uses $CFG
3038  * @uses $USER
3039  * @param course $course {@link $COURSE} object containing course information
3040  * @param user $user {@link $USER} object containing user information
3041  * @return string
3042  */
3043 function user_login_string($course=NULL, $user=NULL) {
3044     global $USER, $CFG, $SITE;
3046     if (empty($user) and !empty($USER->id)) {
3047         $user = $USER;
3048     }
3050     if (empty($course)) {
3051         $course = $SITE;
3052     }
3054     if (!empty($user->realuser)) {
3055         if ($realuser = get_record('user', 'id', $user->realuser)) {
3056             $fullname = fullname($realuser, true);
3057             $realuserinfo = " [<a $CFG->frametarget
3058             href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;return=1&amp;sesskey=".sesskey()."\">$fullname</a>] ";
3059         }
3060     } else {
3061         $realuserinfo = '';
3062     }
3064     if (empty($CFG->loginhttps)) {
3065         $wwwroot = $CFG->wwwroot;
3066     } else {
3067         $wwwroot = str_replace('http:','https:',$CFG->wwwroot);
3068     }
3070     if (empty($course->id)) {
3071         // $course->id is not defined during installation
3072         return '';
3073     } else if (!empty($user->id)) {
3074         $context = get_context_instance(CONTEXT_COURSE, $course->id);
3076         $fullname = fullname($user, true);
3077         $username = "<a $CFG->frametarget href=\"$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a>";
3078         if (is_mnet_remote_user($user) and $idprovider = get_record('mnet_host', 'id', $user->mnethostid)) {
3079             $username .= " from <a $CFG->frametarget href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
3080         }
3081         if (isset($user->username) && $user->username == 'guest') {
3082             $loggedinas = $realuserinfo.get_string('loggedinasguest').
3083                       " (<a $CFG->frametarget href=\"$wwwroot/login/index.php\">".get_string('login').'</a>)';
3084         } else if (!empty($user->switchrole[$context->id])) {
3085             $rolename = '';
3086             if ($role = get_record('role', 'id', $user->switchrole[$context->id])) {
3087                 $rolename = ': '.format_string($role->name);
3088             }
3089             $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename.
3090                       " (<a $CFG->frametarget
3091                       href=\"$CFG->wwwroot/course/view.php?id=$course->id&amp;switchrole=0&amp;sesskey=".sesskey()."\">".get_string('switchrolereturn').'</a>)';
3092         } else {
3093             $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username).' '.
3094                       " (<a $CFG->frametarget href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
3095         }
3096     } else {
3097         $loggedinas = get_string('loggedinnot', 'moodle').
3098                       " (<a $CFG->frametarget href=\"$wwwroot/login/index.php\">".get_string('login').'</a>)';
3099     }
3100     return '<div class="logininfo">'.$loggedinas.'</div>';
3103 /**
3104  * Tests whether $THEME->rarrow, $THEME->larrow have been set (theme/-/config.php).
3105  * If not it applies sensible defaults.
3106  *
3107  * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
3108  * search forum block, etc. Important: these are 'silent' in a screen-reader
3109  * (unlike &gt; &raquo;), and must be accompanied by text.
3110  * @uses $THEME
3111  */
3112 function check_theme_arrows() {
3113     global $THEME;
3115     if (!isset($THEME->rarrow) and !isset($THEME->larrow)) {
3116         // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
3117         // Also OK in Win 9x/2K/IE 5.x
3118         $THEME->rarrow = '&#x25BA;';
3119         $THEME->larrow = '&#x25C4;';
3120         $uagent = $_SERVER['HTTP_USER_AGENT'];
3121         if (false !== strpos($uagent, 'Opera')
3122             || false !== strpos($uagent, 'Mac')) {
3123             // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
3124             // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
3125             $THEME->rarrow = '&#x25B6;';
3126             $THEME->larrow = '&#x25C0;';
3127         }
3128         elseif (false !== strpos($uagent, 'Konqueror')) {
3129             $THEME->rarrow = '&rarr;';
3130             $THEME->larrow = '&larr;';
3131         }
3132         elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
3133             && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
3134             // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
3135             // To be safe, non-Unicode browsers!
3136             $THEME->rarrow = '&gt;';
3137             $THEME->larrow = '&lt;';
3138         }
3139     }
3142 /**
3143  * Return the right arrow with text ('next'), and optionally embedded in a link.
3144  * See function above, check_theme_arrows.
3145  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
3146  * @param string $url An optional link to use in a surrounding HTML anchor.
3147  * @param bool $accesshide True if text should be hidden (for screen readers only).
3148  * @param string $addclass Additional class names for the link, or the arrow character.
3149  * @return string HTML string.
3150  */
3151 function link_arrow_right($text, $url='', $accesshide=false, $addclass='') {
3152     global $THEME;
3153     check_theme_arrows();
3154     $arrowclass = 'arrow ';
3155     if (! $url) {
3156         $arrowclass .= $addclass;
3157     }
3158     $arrow = '<span class="'.$arrowclass.'">'.$THEME->rarrow.'</span>';
3159     $htmltext = '';
3160     if ($text) {
3161         $htmltext = $text.'&nbsp;';
3162         if ($accesshide) {
3163             $htmltext = '<span class="accesshide">'.$htmltext.'</span>';
3164         }
3165     }
3166     if ($url) {
3167         $class = '';
3168         if ($addclass) {
3169             $class =" class=\"$addclass\"";
3170         }
3171         return '<a'.$class.' href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$htmltext.$arrow.'</a>';
3172     }
3173     return $htmltext.$arrow;
3176 /**
3177  * Return the left arrow with text ('previous'), and optionally embedded in a link.
3178  * See function above, check_theme_arrows.
3179  * @param string $text HTML/plain text label (set to blank only for breadcrumb separator cases).
3180  * @param string $url An optional link to use in a surrounding HTML anchor.
3181  * @param bool $accesshide True if text should be hidden (for screen readers only).
3182  * @param string $addclass Additional class names for the link, or the arrow character.
3183  * @return string HTML string.
3184  */
3185 function link_arrow_left($text, $url='', $accesshide=false, $addclass='') {
3186     global $THEME;
3187     check_theme_arrows();
3188     $arrowclass = 'arrow ';
3189     if (! $url) {
3190         $arrowclass .= $addclass;
3191     }
3192     $arrow = '<span class="'.$arrowclass.'">'.$THEME->larrow.'</span>';
3193     $htmltext = '';
3194     if ($text) {
3195         $htmltext = '&nbsp;'.$text;
3196         if ($accesshide) {
3197             $htmltext = '<span class="accesshide">'.$htmltext.'</span>';
3198         }
3199     }
3200     if ($url) {
3201         $class = '';
3202         if ($addclass) {
3203             $class =" class=\"$addclass\"";
3204         }
3205         return '<a'.$class.' href="'.$url.'" title="'.preg_replace('/<.*?>/','',$text).'">'.$arrow.$htmltext.'</a>';
3206     }
3207     return $arrow.$htmltext;
3210 /**
3211  * Return the breadcrumb trail navigation separator.
3212  * @return string HTML string.
3213  */
3214 function get_separator() {
3215     //Accessibility: the 'hidden' slash is preferred for screen readers.
3216     return ' '.link_arrow_right($text='/', $url='', $accesshide=true, 'sep').' ';
3221 /**
3222  * Prints breadcrumb trail of links, called in theme/-/header.html
3223  *
3224  * @uses $CFG
3225  * @param mixed $navigation The breadcrumb navigation string to be printed
3226  * @param string $separator The breadcrumb trail separator. The default 0 leads to the use
3227  *  of $THEME->rarrow, themes could use '&rarr;', '/', or '' for a style-sheet solution.
3228  * @param boolean $return False to echo the breadcrumb string (default), true to return it.
3229  */
3230 function print_navigation ($navigation, $separator=0, $return=false) {
3231     global $CFG, $THEME;
3232     $output = '';
3234     if (0 === $separator) {
3235         $separator = get_separator();
3236     }
3237     else {
3238         $separator = '<span class="sep">'. $separator .'</span>';
3239     }
3241     if ($navigation) {
3243         if (is_newnav($navigation)) {
3244             if ($return) {
3245                 return($navigation['navlinks']);
3246             } else {
3247                 echo $navigation['navlinks'];
3248                 return;
3249             }
3250         } else {
3251             debugging('Navigation needs to be updated to use build_navigation()', DEBUG_DEVELOPER);
3252         }
3254         if (!is_array($navigation)) {
3255             $ar = explode('->', $navigation);
3256             $navigation = array();
3258             foreach ($ar as $a) {
3259                 if (strpos($a, '</a>') === false) {
3260                     $navigation[] = array('title' => $a, 'url' => '');
3261                 } else {
3262                     if (preg_match('/<a.*href="([^"]*)">(.*)<\/a>/', $a, $matches)) {
3263                         $navigation[] = array('title' => $matches[2], 'url' => $matches[1]);
3264                     }
3265                 }
3266             }
3267         }
3269         if (! $site = get_site()) {
3270             $site = new object();
3271             $site->shortname = get_string('home');
3272         }
3274         //Accessibility: breadcrumb links now in a list, &raquo; replaced with a 'silent' character.
3275         $nav_text = get_string('youarehere','access');
3276         $output .= '<h2 class="accesshide">'.$nav_text."</h2><ul>\n";
3278         $output .= '<li class="first">'."\n".'<a '.$CFG->frametarget.' onclick="this.target=\''.$CFG->framename.'\'" href="'
3279                .$CFG->wwwroot.((!has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))
3280                                  && !empty($USER->id) && !empty($CFG->mymoodleredirect) && !isguest())
3281                                  ? '/my' : '') .'/">'. format_string($site->shortname) ."</a>\n</li>\n";
3284         foreach ($navigation as $navitem) {
3285             $title = trim(strip_tags(format_string($navitem['title'], false)));
3286             $url   = $navitem['url'];
3288             if (empty($url)) {
3289                 $output .= '<li class="first">'."$separator $title</li>\n";
3290             } else {
3291                 $output .= '<li class="first">'."$separator\n<a ".$CFG->frametarget.' onclick="this.target=\''.$CFG->framename.'\'" href="'
3292                            .$url.'">'."$title</a>\n</li>\n";
3293             }
3294         }
3296         $output .= "</ul>\n";
3297     }
3299     if ($return) {
3300         return $output;
3301     } else {
3302         echo $output;
3303     }
3306 /**
3307  * Prints a string in a specified size  (retained for backward compatibility)
3308  *
3309  * @param string $text The text to be displayed
3310  * @param int $size The size to set the font for text display.
3311  */
3312 function print_headline($text, $size=2, $return=false) {
3313     $output = print_heading($text, '', $size, true);
3314     if ($return) {
3315         return $output;
3316     } else {
3317         echo $output;
3318     }
3321 /**
3322  * Prints text in a format for use in headings.
3323  *
3324  * @param string $text The text to be displayed
3325  * @param string $align The alignment of the printed paragraph of text
3326  * @param int $size The size to set the font for text display.
3327  */
3328 function print_heading($text, $align='', $size=2, $class='main', $return=false) {
3329     if ($align) {
3330         $align = ' style="text-align:'.$align.';"';
3331     }
3332     if ($class) {
3333         $class = ' class="'.$class.'"';
3334     }
3335     $output = "<h$size $align $class>".stripslashes_safe($text)."</h$size>";
3337     if ($return) {
3338         return $output;
3339     } else {
3340         echo $output;
3341     }
3344 /**
3345  * Centered heading with attached help button (same title text)
3346  * and optional icon attached
3347  *
3348  * @param string $text The text to be displayed
3349  * @param string $helppage The help page to link to
3350  * @param string $module The module whose help should be linked to
3351  * @param string $icon Image to display if needed
3352  */
3353 function print_heading_with_help($text, $helppage, $module='moodle', $icon='', $return=false) {
3354     $output = '';
3355     $output .= '<h2 class="main help">'.$icon.stripslashes_safe($text);
3356     $output .= helpbutton($helppage, $text, $module, true, false, '', true);
3357     $output .= '</h2>';
3359     if ($return) {
3360         return $output;
3361     } else {
3362         echo $output;
3363     }
3367 function print_heading_block($heading, $class='', $return=false) {
3368     //Accessibility: 'headingblock' is now H1, see theme/standard/styles_*.css: ??
3369     $output = '<h2 class="headingblock header '.$class.'">'.stripslashes($heading).'</h2>';
3371     if ($return) {
3372         return $output;
3373     } else {
3374         echo $output;
3375     }
3379 /**
3380  * Print a link to continue on to another page.
3381  *
3382  * @uses $CFG
3383  * @param string $link The url to create a link to.
3384  */
3385 function print_continue($link, $return=false) {
3387     global $CFG;
3389     // in case we are logging upgrade in admin/index.php stop it
3390     if (function_exists('upgrade_log_finish')) {
3391         upgrade_log_finish();
3392     }
3394     $output = '';
3396     if ($link == '') {
3397         if (!empty($_SERVER['HTTP_REFERER'])) {
3398             $link = $_SERVER['HTTP_REFERER'];
3399             $link = str_replace('&', '&amp;', $link); // make it valid XHTML
3400         } else {
3401             $link = $CFG->wwwroot .'/';
3402         }
3403     }
3405     $output .= '<div class="continuebutton">';
3407     $output .= print_single_button($link, NULL, get_string('continue'), 'post', $CFG->framename, true);
3408     $output .= '</div>'."\n";
3410     if ($return) {
3411         return $output;
3412     } else {
3413         echo $output;
3414     }
3418 /**
3419  * Print a message in a standard themed box.
3420  * Replaces print_simple_box (see deprecatedlib.php)
3421  *
3422  * @param string $message, the content of the box
3423  * @param string $classes, space-separated class names.
3424  * @param string $ids, space-separated id names.
3425  * @param boolean $return, return as string or just print it
3426  */
3427 function print_box($message, $classes='generalbox', $ids='', $return=false) {
3429     $output  = print_box_start($classes, $ids, true);
3430     $output .= stripslashes_safe($message);
3431     $output .= print_box_end(true);
3433     if ($return) {
3434         return $output;
3435     } else {
3436         echo $output;
3437     }
3440 /**
3441  * Starts a box using divs
3442  * Replaces print_simple_box_start (see deprecatedlib.php)
3443  *
3444  * @param string $classes, space-separated class names.
3445  * @param string $ids, space-separated id names.
3446  * @param boolean $return, return as string or just print it
3447  */
3448 function print_box_start($classes='generalbox', $ids='', $return=false) {
3449     $output = '';
3451     if ($ids) {
3452         $ids = ' id="'.$ids.'"';
3453     }
3455     $output .= '<div'.$ids.' class="box '.$classes.'">';
3457     if ($return) {
3458         return $output;
3459     } else {
3460         echo $output;
3461     }
3465 /**
3466  * Simple function to end a box (see above)
3467  * Replaces print_simple_box_end (see deprecatedlib.php)
3468  *
3469  * @param boolean $return, return as string or just print it
3470  */
3471 function print_box_end($return=false) {
3472     $output = '</div>';
3473     if ($return) {
3474         return $output;
3475     } else {
3476         echo $output;
3477     }
3481 /**
3482  * Print a self contained form with a single submit button.
3483  *
3484  * @param string $link ?
3485  * @param array $options ?
3486  * @param string $label ?
3487  * @param string $method ?
3488  * @todo Finish documenting this function
3489  */
3490 function print_single_button($link, $options, $label='OK', $method='get', $target='_self', $return=false) {
3491     $output = '';
3492     $link = str_replace('"', '&quot;', $link); //basic XSS protection
3493     $output .= '<div class="singlebutton">';
3494     // taking target out, will need to add later target="'.$target.'"
3495     $output .= '<form action="'. $link .'" method="'. $method .'">';
3496     $output .= '<div>';
3497     if ($options) {
3498         foreach ($options as $name => $value) {
3499             $output .= '<input type="hidden" name="'. $name .'" value="'. s($value) .'" />';
3500         }
3501     }
3502     $output .= '<input type="submit" value="'. s($label) .'" /></div></form></div>';
3504     if ($return) {
3505         return $output;
3506     } else {
3507         echo $output;
3508     }
3512 /**
3513  * Print a spacer image with the option of including a line break.
3514  *
3515  * @param int $height ?
3516  * @param int $width ?
3517  * @param boolean $br ?
3518  * @todo Finish documenting this function
3519  */
3520 function print_spacer($height=1, $width=1, $br=true, $return=false) {
3521     global $CFG;
3522     $output = '';
3524     $output .= '<img class="spacer" height="'. $height .'" width="'. $width .'" src="'. $CFG->wwwroot .'/pix/spacer.gif" alt="" />';
3525     if ($br) {
3526         $output .= '<br />'."\n";
3527     }
3529     if ($return) {
3530         return $output;
3531     } else {
3532         echo $output;
3533     }
3536 /**
3537  * Given the path to a picture file in a course, or a URL,
3538  * this function includes the picture in the page.
3539  *
3540  * @param string $path ?
3541  * @param int $courseid ?
3542  * @param int $height ?
3543  * @param int $width ?
3544  * @param string $link ?
3545  * @todo Finish documenting this function
3546  */
3547 function print_file_picture($path, $courseid=0, $height='', $width='', $link='', $return=false) {
3548     global $CFG;
3549     $output = '';
3551     if ($height) {
3552         $height = 'height="'. $height .'"';
3553     }
3554     if ($width) {
3555         $width = 'width="'. $width .'"';
3556     }
3557     if ($link) {
3558         $output .= '<a href="'. $link .'">';
3559     }
3560     if (substr(strtolower($path), 0, 7) == 'http://') {
3561         $output .= '<img style="height:'.$height.'px;width:'.$width.'px;" src="'. $path .'" />';
3563     } else if ($courseid) {
3564         $output .= '<img style="height:'.$height.'px;width:'.$width.'px;" src="';
3565         if ($CFG->slasharguments) {        // Use this method if possible for better caching
3566             $output .= $CFG->wwwroot .'/file.php/'. $courseid .'/'. $path;
3567         } else {
3568             $output .= $CFG->wwwroot .'/file.php?file=/'. $courseid .'/'. $path;
3569         }
3570         $output .= '" />';
3571     } else {
3572         $output .= 'Error: must pass URL or course';
3573     }
3574     if ($link) {
3575         $output .= '</a>';
3576     }
3578     if ($return) {
3579         return $output;
3580     } else {
3581         echo $output;
3582     }
3585 /**
3586  * Print the specified user's avatar.
3587  *
3588  * @param int $userid ?
3589  * @param int $courseid ?
3590  * @param boolean $picture Print the user picture?
3591  * @param int $size Size in pixels.  Special values are (true/1 = 100px) and (false/0 = 35px) for backward compatability
3592  * @param boolean $return If false print picture to current page, otherwise return the output as string
3593  * @param boolean $link Enclose printed image in a link to view specified course?
3594  * @param string $target link target attribute
3595  * @param boolean $alttext use username or userspecified text in image alt attribute
3596  * return string
3597  * @todo Finish documenting this function
3598  */
3599 function print_user_picture($userid, $courseid, $picture, $size=0, $return=false, $link=true, $target='', $alttext=true) {
3600     global $CFG;
3602     if ($link) {
3603         if ($target) {
3604             $target=' target="_blank"';
3605         }
3606         $output = '<a '.$target.' href="'. $CFG->wwwroot .'/user/view.php?id='. $userid .'&amp;course='. $courseid .'">';
3607     } else {
3608         $output = '';
3609     }
3610     if (empty($size)) {
3611         $file = 'f2';
3612         $size = 35;
3613     } else if ($size === true or $size == 1) {
3614         $file = 'f1';
3615         $size = 100;
3616     } else if ($size >= 50) {
3617         $file = 'f1';
3618     } else {
3619         $file = 'f2';
3620     }
3621     $class = "userpicture";
3622     if ($picture) {  // Print custom user picture
3623         if ($CFG->slasharguments) {        // Use this method if possible for better caching
3624             $src =  $CFG->wwwroot .'/user/pix.php/'. $userid .'/'. $file .'.jpg';
3625         } else {
3626             $src =  $CFG->wwwroot .'/user/pix.php?file=/'. $userid .'/'. $file .'.jpg';
3627         }
3628     } else {         // Print default user pictures (use theme version if available)
3629         $class .= " defaultuserpic";
3630         $src =  "$CFG->pixpath/u/$file.png";
3631     }
3632     $imagealt = '';
3633     if ($alttext and $user = get_record('user','id',$userid)) {
3634         if (!empty($user->imagealt)) {
3635             $imagealt = $user->imagealt;
3636         } else {
3637             $imagealt = get_string('pictureof','',fullname($user));
3638         }
3639     }
3641     $output .= '<img class="'.$class.'" src="'.$src.'" alt="'.s($imagealt).'" />';
3642     if ($link) {
3643         $output .= '</a>';
3644     }
3646     if ($return) {
3647         return $output;
3648     } else {
3649         echo $output;
3650     }
3653 /**
3654  * Prints a summary of a user in a nice little box.
3655  *
3656  * @uses $CFG
3657  * @uses $USER
3658  * @param user $user A {@link $USER} object representing a user
3659  * @param course $course A {@link $COURSE} object representing a course
3660  */
3661 function print_user($user, $course, $messageselect=false, $return=false) {
3663     global $CFG, $USER;
3665     $output = '';
3667     static $string;
3668     static $datestring;
3669     static $countries;
3671     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3673     if (empty($string)) {     // Cache all the strings for the rest of the page
3675         $string->email       = get_string('email');
3676         $string->location    = get_string('location');
3677         $string->lastaccess  = get_string('lastaccess');
3678         $string->activity    = get_string('activity');
3679         $string->unenrol     = get_string('unenrol');
3680         $string->loginas     = get_string('loginas');
3681         $string->fullprofile = get_string('fullprofile');
3682         $string->role        = get_string('role');
3683         $string->name        = get_string('name');
3684         $string->never       = get_string('never');
3686         $datestring->day     = get_string('day');
3687         $datestring->days    = get_string('days');
3688         $datestring->hour    = get_string('hour');
3689         $datestring->hours   = get_string(