/moodle/lib/weblib.php
PHP | 7102 lines | 5005 code | 725 blank | 1372 comment | 909 complexity | f692db5144ff53443dba58a43eee55fc MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1, BSD-3-Clause, LGPL-2.0
Large files files are truncated, but you can click here to view the full file
- <?php // $Id$
- ///////////////////////////////////////////////////////////////////////////
- // //
- // NOTICE OF COPYRIGHT //
- // //
- // Moodle - Modular Object-Oriented Dynamic Learning Environment //
- // http://moodle.com //
- // //
- // Copyright (C) 1999 onwards Martin Dougiamas http://dougiamas.com //
- // //
- // This program is free software; you can redistribute it and/or modify //
- // it under the terms of the GNU General Public License as published by //
- // the Free Software Foundation; either version 2 of the License, or //
- // (at your option) any later version. //
- // //
- // This program is distributed in the hope that it will be useful, //
- // but WITHOUT ANY WARRANTY; without even the implied warranty of //
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
- // GNU General Public License for more details: //
- // //
- // http://www.gnu.org/copyleft/gpl.html //
- // //
- ///////////////////////////////////////////////////////////////////////////
- /**
- * Library of functions for web output
- *
- * Library of all general-purpose Moodle PHP functions and constants
- * that produce HTML output
- *
- * Other main libraries:
- * - datalib.php - functions that access the database.
- * - moodlelib.php - general-purpose Moodle functions.
- * @author Martin Dougiamas
- * @version $Id$
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package moodlecore
- */
- /// We are going to uses filterlib functions here
- require_once("$CFG->libdir/filterlib.php");
- require_once("$CFG->libdir/ajax/ajaxlib.php");
- /// Constants
- /// Define text formatting types ... eventually we can add Wiki, BBcode etc
- /**
- * Does all sorts of transformations and filtering
- */
- define('FORMAT_MOODLE', '0'); // Does all sorts of transformations and filtering
- /**
- * Plain HTML (with some tags stripped)
- */
- define('FORMAT_HTML', '1'); // Plain HTML (with some tags stripped)
- /**
- * Plain text (even tags are printed in full)
- */
- define('FORMAT_PLAIN', '2'); // Plain text (even tags are printed in full)
- /**
- * Wiki-formatted text
- * Deprecated: left here just to note that '3' is not used (at the moment)
- * and to catch any latent wiki-like text (which generates an error)
- */
- define('FORMAT_WIKI', '3'); // Wiki-formatted text
- /**
- * Markdown-formatted text http://daringfireball.net/projects/markdown/
- */
- define('FORMAT_MARKDOWN', '4'); // Markdown-formatted text http://daringfireball.net/projects/markdown/
- /**
- * TRUSTTEXT marker - if present in text, text cleaning should be bypassed
- */
- define('TRUSTTEXT', '#####TRUSTTEXT#####');
- /**
- * Javascript related defines
- */
- define('REQUIREJS_BEFOREHEADER', 0);
- define('REQUIREJS_INHEADER', 1);
- define('REQUIREJS_AFTERHEADER', 2);
- /**
- * Allowed tags - string of html tags that can be tested against for safe html tags
- * @global string $ALLOWED_TAGS
- */
- global $ALLOWED_TAGS;
- $ALLOWED_TAGS =
- '<p><br><b><i><u><font><table><tbody><thead><tfoot><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>';
- /**
- * Allowed protocols - array of protocols that are safe to use in links and so on
- * @global string $ALLOWED_PROTOCOLS
- */
- $ALLOWED_PROTOCOLS = array('http', 'https', 'ftp', 'news', 'mailto', 'rtsp', 'teamspeak', 'gopher', 'mms',
- 'color', 'callto', 'cursor', 'text-align', 'font-size', 'font-weight', 'font-style', 'font-family',
- 'border', 'margin', 'padding', 'background', 'background-color', 'text-decoration'); // CSS as well to get through kses
- /// Functions
- /**
- * Add quotes to HTML characters
- *
- * Returns $var with HTML characters (like "<", ">", etc.) properly quoted.
- * This function is very similar to {@link p()}
- *
- * @param string $var the string potentially containing HTML characters
- * @param boolean $strip to decide if we want to strip slashes or no. Default to false.
- * true should be used to print data from forms and false for data from DB.
- * @return string
- */
- function s($var, $strip=false) {
- if ($var == '0') { // for integer 0, boolean false, string '0'
- return '0';
- }
- if ($strip) {
- return preg_replace("/&(#\d+);/i", "&$1;", htmlspecialchars(stripslashes_safe($var)));
- } else {
- return preg_replace("/&(#\d+);/i", "&$1;", htmlspecialchars($var));
- }
- }
- /**
- * Add quotes to HTML characters
- *
- * Prints $var with HTML characters (like "<", ">", etc.) properly quoted.
- * This function is very similar to {@link s()}
- *
- * @param string $var the string potentially containing HTML characters
- * @param boolean $strip to decide if we want to strip slashes or no. Default to false.
- * true should be used to print data from forms and false for data from DB.
- * @return string
- */
- function p($var, $strip=false) {
- echo s($var, $strip);
- }
- /**
- * Does proper javascript quoting.
- * Do not use addslashes anymore, because it does not work when magic_quotes_sybase is enabled.
- *
- * @since 1.8 - 22/02/2007
- * @param mixed value
- * @return mixed quoted result
- */
- function addslashes_js($var) {
- if (is_string($var)) {
- $var = str_replace('\\', '\\\\', $var);
- $var = str_replace(array('\'', '"', "\n", "\r", "\0"), array('\\\'', '\\"', '\\n', '\\r', '\\0'), $var);
- $var = str_replace('</', '<\/', $var); // XHTML compliance
- } else if (is_array($var)) {
- $var = array_map('addslashes_js', $var);
- } else if (is_object($var)) {
- $a = get_object_vars($var);
- foreach ($a as $key=>$value) {
- $a[$key] = addslashes_js($value);
- }
- $var = (object)$a;
- }
- return $var;
- }
- /**
- * Remove query string from url
- *
- * Takes in a URL and returns it without the querystring portion
- *
- * @param string $url the url which may have a query string attached
- * @return string
- */
- function strip_querystring($url) {
- if ($commapos = strpos($url, '?')) {
- return substr($url, 0, $commapos);
- } else {
- return $url;
- }
- }
- /**
- * Returns the URL of the HTTP_REFERER, less the querystring portion if required
- * @param boolean $stripquery if true, also removes the query part of the url.
- * @return string
- */
- function get_referer($stripquery=true) {
- if (isset($_SERVER['HTTP_REFERER'])) {
- if ($stripquery) {
- return strip_querystring($_SERVER['HTTP_REFERER']);
- } else {
- return $_SERVER['HTTP_REFERER'];
- }
- } else {
- return '';
- }
- }
- /**
- * Returns the name of the current script, WITH the querystring portion.
- * this function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME
- * return different things depending on a lot of things like your OS, Web
- * server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
- * <b>NOTE:</b> This function returns false if the global variables needed are not set.
- *
- * @return string
- */
- function me() {
- if (!empty($_SERVER['REQUEST_URI'])) {
- return $_SERVER['REQUEST_URI'];
- } else if (!empty($_SERVER['PHP_SELF'])) {
- if (!empty($_SERVER['QUERY_STRING'])) {
- return $_SERVER['PHP_SELF'] .'?'. $_SERVER['QUERY_STRING'];
- }
- return $_SERVER['PHP_SELF'];
- } else if (!empty($_SERVER['SCRIPT_NAME'])) {
- if (!empty($_SERVER['QUERY_STRING'])) {
- return $_SERVER['SCRIPT_NAME'] .'?'. $_SERVER['QUERY_STRING'];
- }
- return $_SERVER['SCRIPT_NAME'];
- } else if (!empty($_SERVER['URL'])) { // May help IIS (not well tested)
- if (!empty($_SERVER['QUERY_STRING'])) {
- return $_SERVER['URL'] .'?'. $_SERVER['QUERY_STRING'];
- }
- return $_SERVER['URL'];
- } else {
- notify('Warning: Could not find any of these web server variables: $REQUEST_URI, $PHP_SELF, $SCRIPT_NAME or $URL');
- return false;
- }
- }
- /**
- * Like {@link me()} but returns a full URL
- * @see me()
- * @return string
- */
- function qualified_me() {
- global $CFG;
- if (!empty($CFG->wwwroot)) {
- $url = parse_url($CFG->wwwroot);
- }
- if (!empty($url['host'])) {
- $hostname = $url['host'];
- } else if (!empty($_SERVER['SERVER_NAME'])) {
- $hostname = $_SERVER['SERVER_NAME'];
- } else if (!empty($_ENV['SERVER_NAME'])) {
- $hostname = $_ENV['SERVER_NAME'];
- } else if (!empty($_SERVER['HTTP_HOST'])) {
- $hostname = $_SERVER['HTTP_HOST'];
- } else if (!empty($_ENV['HTTP_HOST'])) {
- $hostname = $_ENV['HTTP_HOST'];
- } else {
- notify('Warning: could not find the name of this server!');
- return false;
- }
- if (!empty($url['port'])) {
- $hostname .= ':'.$url['port'];
- } else if (!empty($_SERVER['SERVER_PORT'])) {
- if ($_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
- $hostname .= ':'.$_SERVER['SERVER_PORT'];
- }
- }
- // TODO, this does not work in the situation described in MDL-11061, but
- // I don't know how to fix it. Possibly believe $CFG->wwwroot ahead of what
- // the server reports.
- if (isset($_SERVER['HTTPS'])) {
- $protocol = ($_SERVER['HTTPS'] == 'on') ? 'https://' : 'http://';
- } else if (isset($_SERVER['SERVER_PORT'])) { # Apache2 does not export $_SERVER['HTTPS']
- $protocol = ($_SERVER['SERVER_PORT'] == '443') ? 'https://' : 'http://';
- } else {
- $protocol = 'http://';
- }
- $url_prefix = $protocol.$hostname;
- return $url_prefix . me();
- }
- /**
- * Class for creating and manipulating urls.
- *
- * See short write up here http://docs.moodle.org/en/Development:lib/weblib.php_moodle_url
- */
- class moodle_url {
- var $scheme = '';// e.g. http
- var $host = '';
- var $port = '';
- var $user = '';
- var $pass = '';
- var $path = '';
- var $fragment = '';
- var $params = array(); //associative array of query string params
- /**
- * Pass no arguments to create a url that refers to this page. Use empty string to create empty url.
- *
- * @param string $url url default null means use this page url with no query string
- * empty string means empty url.
- * if you pass any other type of url it will be parsed into it's bits, including query string
- * @param array $params these params override anything in the query string where params have the same name.
- */
- function moodle_url($url = null, $params = array()){
- global $FULLME;
- if ($url !== ''){
- if ($url === null){
- $url = strip_querystring($FULLME);
- }
- $parts = parse_url($url);
- if ($parts === FALSE){
- error('invalidurl');
- }
- if (isset($parts['query'])){
- parse_str(str_replace('&', '&', $parts['query']), $this->params);
- }
- unset($parts['query']);
- foreach ($parts as $key => $value){
- $this->$key = $value;
- }
- $this->params($params);
- }
- }
- /**
- * Add an array of params to the params for this page.
- *
- * The added params override existing ones if they have the same name.
- *
- * @param array $params Defaults to null. If null then return value of param 'name'.
- * @return array Array of Params for url.
- */
- function params($params = null) {
- if (!is_null($params)) {
- return $this->params = $params + $this->params;
- } else {
- return $this->params;
- }
- }
- /**
- * Remove all params if no arguments passed. Or else remove param $arg1, $arg2, etc.
- *
- * @param string $arg1
- * @param string $arg2
- * @param string $arg3
- */
- function remove_params(){
- if ($thisargs = func_get_args()){
- foreach ($thisargs as $arg){
- if (isset($this->params[$arg])){
- unset($this->params[$arg]);
- }
- }
- } else { // no args
- $this->params = array();
- }
- }
- /**
- * Add a param to the params for this page. The added param overrides existing one if they
- * have the same name.
- *
- * @param string $paramname name
- * @param string $param value
- */
- function param($paramname, $param){
- $this->params = array($paramname => $param) + $this->params;
- }
- function get_query_string($overrideparams = array()){
- $arr = array();
- $params = $overrideparams + $this->params;
- foreach ($params as $key => $val){
- $arr[] = urlencode($key)."=".urlencode($val);
- }
- return implode($arr, "&");
- }
- /**
- * Outputs params as hidden form elements.
- *
- * @param array $exclude params to ignore
- * @param integer $indent indentation
- * @param array $overrideparams params to add to the output params, these
- * override existing ones with the same name.
- * @return string html for form elements.
- */
- function hidden_params_out($exclude = array(), $indent = 0, $overrideparams=array()){
- $tabindent = str_repeat("\t", $indent);
- $str = '';
- $params = $overrideparams + $this->params;
- foreach ($params as $key => $val){
- if (FALSE === array_search($key, $exclude)) {
- $val = s($val);
- $str.= "$tabindent<input type=\"hidden\" name=\"$key\" value=\"$val\" />\n";
- }
- }
- return $str;
- }
- /**
- * Output url
- *
- * @param boolean $noquerystring whether to output page params as a query string in the url.
- * @param array $overrideparams params to add to the output url, these override existing ones with the same name.
- * @return string url
- */
- function out($noquerystring = false, $overrideparams = array()) {
- $uri = $this->scheme ? $this->scheme.':'.((strtolower($this->scheme) == 'mailto') ? '':'//'): '';
- $uri .= $this->user ? $this->user.($this->pass? ':'.$this->pass:'').'@':'';
- $uri .= $this->host ? $this->host : '';
- $uri .= $this->port ? ':'.$this->port : '';
- $uri .= $this->path ? $this->path : '';
- if (!$noquerystring){
- $uri .= (count($this->params)||count($overrideparams)) ? '?'.$this->get_query_string($overrideparams) : '';
- }
- $uri .= $this->fragment ? '#'.$this->fragment : '';
- return $uri;
- }
- /**
- * Output action url with sesskey
- *
- * @param boolean $noquerystring whether to output page params as a query string in the url.
- * @return string url
- */
- function out_action($overrideparams = array()) {
- $overrideparams = array('sesskey'=> sesskey()) + $overrideparams;
- return $this->out(false, $overrideparams);
- }
- }
- /**
- * Determine if there is data waiting to be processed from a form
- *
- * Used on most forms in Moodle to check for data
- * Returns the data as an object, if it's found.
- * This object can be used in foreach loops without
- * casting because it's cast to (array) automatically
- *
- * Checks that submitted POST data exists and returns it as object.
- *
- * @param string $url not used anymore
- * @return mixed false or object
- */
- function data_submitted($url='') {
- if (empty($_POST)) {
- return false;
- } else {
- return (object)$_POST;
- }
- }
- /**
- * Moodle replacement for php stripslashes() function,
- * works also for objects and arrays.
- *
- * The standard php stripslashes() removes ALL backslashes
- * even from strings - so C:\temp becomes C:temp - this isn't good.
- * This function should work as a fairly safe replacement
- * to be called on quoted AND unquoted strings (to be sure)
- *
- * @param mixed something to remove unsafe slashes from
- * @return mixed
- */
- function stripslashes_safe($mixed) {
- // there is no need to remove slashes from int, float and bool types
- if (empty($mixed)) {
- //nothing to do...
- } else if (is_string($mixed)) {
- if (ini_get_bool('magic_quotes_sybase')) { //only unescape single quotes
- $mixed = str_replace("''", "'", $mixed);
- } else { //the rest, simple and double quotes and backslashes
- $mixed = str_replace("\\'", "'", $mixed);
- $mixed = str_replace('\\"', '"', $mixed);
- $mixed = str_replace('\\\\', '\\', $mixed);
- }
- } else if (is_array($mixed)) {
- foreach ($mixed as $key => $value) {
- $mixed[$key] = stripslashes_safe($value);
- }
- } else if (is_object($mixed)) {
- $vars = get_object_vars($mixed);
- foreach ($vars as $key => $value) {
- $mixed->$key = stripslashes_safe($value);
- }
- }
- return $mixed;
- }
- /**
- * Recursive implementation of stripslashes()
- *
- * This function will allow you to strip the slashes from a variable.
- * If the variable is an array or object, slashes will be stripped
- * from the items (or properties) it contains, even if they are arrays
- * or objects themselves.
- *
- * @param mixed the variable to remove slashes from
- * @return mixed
- */
- function stripslashes_recursive($var) {
- if (is_object($var)) {
- $new_var = new object();
- $properties = get_object_vars($var);
- foreach($properties as $property => $value) {
- $new_var->$property = stripslashes_recursive($value);
- }
- } else if(is_array($var)) {
- $new_var = array();
- foreach($var as $property => $value) {
- $new_var[$property] = stripslashes_recursive($value);
- }
- } else if(is_string($var)) {
- $new_var = stripslashes($var);
- } else {
- $new_var = $var;
- }
- return $new_var;
- }
- /**
- * Recursive implementation of addslashes()
- *
- * This function will allow you to add the slashes from a variable.
- * If the variable is an array or object, slashes will be added
- * to the items (or properties) it contains, even if they are arrays
- * or objects themselves.
- *
- * @param mixed the variable to add slashes from
- * @return mixed
- */
- function addslashes_recursive($var) {
- if (is_object($var)) {
- $new_var = new object();
- $properties = get_object_vars($var);
- foreach($properties as $property => $value) {
- $new_var->$property = addslashes_recursive($value);
- }
- } else if (is_array($var)) {
- $new_var = array();
- foreach($var as $property => $value) {
- $new_var[$property] = addslashes_recursive($value);
- }
- } else if (is_string($var)) {
- $new_var = addslashes($var);
- } else { // nulls, integers, etc.
- $new_var = $var;
- }
- return $new_var;
- }
- /**
- * Given some normal text this function will break up any
- * long words to a given size by inserting the given character
- *
- * It's multibyte savvy and doesn't change anything inside html tags.
- *
- * @param string $string the string to be modified
- * @param int $maxsize maximum length of the string to be returned
- * @param string $cutchar the string used to represent word breaks
- * @return string
- */
- function break_up_long_words($string, $maxsize=20, $cutchar=' ') {
- /// Loading the textlib singleton instance. We are going to need it.
- $textlib = textlib_get_instance();
- /// First of all, save all the tags inside the text to skip them
- $tags = array();
- filter_save_tags($string,$tags);
- /// Process the string adding the cut when necessary
- $output = '';
- $length = $textlib->strlen($string);
- $wordlength = 0;
- for ($i=0; $i<$length; $i++) {
- $char = $textlib->substr($string, $i, 1);
- if ($char == ' ' or $char == "\t" or $char == "\n" or $char == "\r" or $char == "<" or $char == ">") {
- $wordlength = 0;
- } else {
- $wordlength++;
- if ($wordlength > $maxsize) {
- $output .= $cutchar;
- $wordlength = 0;
- }
- }
- $output .= $char;
- }
- /// Finally load the tags back again
- if (!empty($tags)) {
- $output = str_replace(array_keys($tags), $tags, $output);
- }
- return $output;
- }
- /**
- * This does a search and replace, ignoring case
- * This function is only used for versions of PHP older than version 5
- * which do not have a native version of this function.
- * Taken from the PHP manual, by bradhuizenga @ softhome.net
- *
- * @param string $find the string to search for
- * @param string $replace the string to replace $find with
- * @param string $string the string to search through
- * return string
- */
- if (!function_exists('str_ireplace')) { /// Only exists in PHP 5
- function str_ireplace($find, $replace, $string) {
- if (!is_array($find)) {
- $find = array($find);
- }
- if(!is_array($replace)) {
- if (!is_array($find)) {
- $replace = array($replace);
- } else {
- // this will duplicate the string into an array the size of $find
- $c = count($find);
- $rString = $replace;
- unset($replace);
- for ($i = 0; $i < $c; $i++) {
- $replace[$i] = $rString;
- }
- }
- }
- foreach ($find as $fKey => $fItem) {
- $between = explode(strtolower($fItem),strtolower($string));
- $pos = 0;
- foreach($between as $bKey => $bItem) {
- $between[$bKey] = substr($string,$pos,strlen($bItem));
- $pos += strlen($bItem) + strlen($fItem);
- }
- $string = implode($replace[$fKey],$between);
- }
- return ($string);
- }
- }
- /**
- * Locate the position of a string in another string
- *
- * This function is only used for versions of PHP older than version 5
- * which do not have a native version of this function.
- * Taken from the PHP manual, by dmarsh @ spscc.ctc.edu
- *
- * @param string $haystack The string to be searched
- * @param string $needle The string to search for
- * @param int $offset The position in $haystack where the search should begin.
- */
- if (!function_exists('stripos')) { /// Only exists in PHP 5
- function stripos($haystack, $needle, $offset=0) {
- return strpos(strtoupper($haystack), strtoupper($needle), $offset);
- }
- }
- /**
- * This function will print a button/link/etc. form element
- * that will work on both Javascript and non-javascript browsers.
- * Relies on the Javascript function openpopup in javascript.php
- *
- * All parameters default to null, only $type and $url are mandatory.
- *
- * $url must be relative to home page eg /mod/survey/stuff.php
- * @param string $url Web link relative to home page
- * @param string $name Name to be assigned to the popup window (this is used by
- * client-side scripts to "talk" to the popup window)
- * @param string $linkname Text to be displayed as web link
- * @param int $height Height to assign to popup window
- * @param int $width Height to assign to popup window
- * @param string $title Text to be displayed as popup page title
- * @param string $options List of additional options for popup window
- * @param string $return If true, return as a string, otherwise print
- * @param string $id id added to the element
- * @param string $class class added to the element
- * @return string
- * @uses $CFG
- */
- function element_to_popup_window ($type=null, $url=null, $name=null, $linkname=null,
- $height=400, $width=500, $title=null,
- $options=null, $return=false, $id=null, $class=null) {
- if (is_null($url)) {
- debugging('You must give the url to display in the popup. URL is missing - can\'t create popup window.', DEBUG_DEVELOPER);
- }
- global $CFG;
- if ($options == 'none') { // 'none' is legacy, should be removed in v2.0
- $options = null;
- }
- // add some sane default options for popup windows
- if (!$options) {
- $options = 'menubar=0,location=0,scrollbars,resizable';
- }
- if ($width) {
- $options .= ',width='. $width;
- }
- if ($height) {
- $options .= ',height='. $height;
- }
- if ($id) {
- $id = ' id="'.$id.'" ';
- }
- if ($class) {
- $class = ' class="'.$class.'" ';
- }
- if ($name) {
- $_name = $name;
- if (($name = preg_replace("/\s/", '_', $name)) != $_name) {
- debugging('The $name of a popup window shouldn\'t contain spaces - string modified. '. $_name .' changed to '. $name, DEBUG_DEVELOPER);
- }
- } else {
- $name = 'popup';
- }
- // get some default string, using the localized version of legacy defaults
- if (is_null($linkname) || $linkname === '') {
- $linkname = get_string('clickhere');
- }
- if (!$title) {
- $title = get_string('popupwindowname');
- }
- $fullscreen = 0; // must be passed to openpopup
- $element = '';
- switch ($type) {
- case 'button' :
- $element = '<input type="button" name="'. $name .'" title="'. $title .'" value="'. $linkname .'" '. $id . $class .
- "onclick=\"return openpopup('$url', '$name', '$options', $fullscreen);\" />\n";
- break;
- case 'link' :
- // some log url entries contain _SERVER[HTTP_REFERRER] in which case wwwroot is already there.
- if (!(strpos($url,$CFG->wwwroot) === false)) {
- $url = substr($url, strlen($CFG->wwwroot));
- }
- $element = '<a title="'. s(strip_tags($title)) .'" href="'. $CFG->wwwroot . $url .'" '.
- "$CFG->frametarget onclick=\"this.target='$name'; return openpopup('$url', '$name', '$options', $fullscreen);\">$linkname</a>";
- break;
- default :
- error('Undefined element - can\'t create popup window.');
- break;
- }
- if ($return) {
- return $element;
- } else {
- echo $element;
- }
- }
- /**
- * Creates and displays (or returns) a link to a popup window, using element_to_popup_window function.
- *
- * @return string html code to display a link to a popup window.
- * @see element_to_popup_window()
- */
- function link_to_popup_window ($url, $name=null, $linkname=null,
- $height=400, $width=500, $title=null,
- $options=null, $return=false) {
- return element_to_popup_window('link', $url, $name, $linkname, $height, $width, $title, $options, $return, null, null);
- }
- /**
- * Creates and displays (or returns) a buttons to a popup window, using element_to_popup_window function.
- *
- * @return string html code to display a button to a popup window.
- * @see element_to_popup_window()
- */
- function button_to_popup_window ($url, $name=null, $linkname=null,
- $height=400, $width=500, $title=null, $options=null, $return=false,
- $id=null, $class=null) {
- return element_to_popup_window('button', $url, $name, $linkname, $height, $width, $title, $options, $return, $id, $class);
- }
- /**
- * Prints a simple button to close a window
- * @param string $name name of the window to close
- * @param boolean $return whether this function should return a string or output it
- * @return string if $return is true, nothing otherwise
- */
- function close_window_button($name='closewindow', $return=false) {
- global $CFG;
- $output = '';
- $output .= '<div class="closewindow">' . "\n";
- $output .= '<form action="#"><div>';
- $output .= '<input type="button" onclick="self.close();" value="'.get_string($name).'" />';
- $output .= '</div></form>';
- $output .= '</div>' . "\n";
- if ($return) {
- return $output;
- } else {
- echo $output;
- }
- }
- /*
- * Try and close the current window immediately using Javascript
- * @param int $delay the delay in seconds before closing the window
- */
- function close_window($delay=0) {
- ?>
- <script type="text/javascript">
- //<![CDATA[
- function close_this_window() {
- self.close();
- }
- setTimeout("close_this_window()", <?php echo $delay * 1000 ?>);
- //]]>
- </script>
- <noscript><center>
- <?php print_string('pleaseclose') ?>
- </center></noscript>
- <?php
- die;
- }
- /**
- * Given an array of values, output the HTML for a select element with those options.
- * Normally, you only need to use the first few parameters.
- *
- * @param array $options The options to offer. An array of the form
- * $options[{value}] = {text displayed for that option};
- * @param string $name the name of this form control, as in <select name="..." ...
- * @param string $selected the option to select initially, default none.
- * @param string $nothing The label for the 'nothing is selected' option. Defaults to get_string('choose').
- * Set this to '' if you don't want a 'nothing is selected' option.
- * @param string $script in not '', then this is added to the <select> element as an onchange handler.
- * @param string $nothingvalue The value corresponding to the $nothing option. Defaults to 0.
- * @param boolean $return if false (the default) the the output is printed directly, If true, the
- * generated HTML is returned as a string.
- * @param boolean $disabled if true, the select is generated in a disabled state. Default, false.
- * @param int $tabindex if give, sets the tabindex attribute on the <select> element. Default none.
- * @param string $id value to use for the id attribute of the <select> element. If none is given,
- * then a suitable one is constructed.
- * @param mixed $listbox if false, display as a dropdown menu. If true, display as a list box.
- * By default, the list box will have a number of rows equal to min(10, count($options)), but if
- * $listbox is an integer, that number is used for size instead.
- * @param boolean $multiple if true, enable multiple selections, else only 1 item can be selected. Used
- * when $listbox display is enabled
- * @param string $class value to use for the class attribute of the <select> element. If none is given,
- * then a suitable one is constructed.
- */
- function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
- $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
- $id='', $listbox=false, $multiple=false, $class='') {
- if ($nothing == 'choose') {
- $nothing = get_string('choose') .'...';
- }
- $attributes = ($script) ? 'onchange="'. $script .'"' : '';
- if ($disabled) {
- $attributes .= ' disabled="disabled"';
- }
- if ($tabindex) {
- $attributes .= ' tabindex="'.$tabindex.'"';
- }
- if ($id ==='') {
- $id = 'menu'.$name;
- // name may contaion [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading
- $id = str_replace('[', '', $id);
- $id = str_replace(']', '', $id);
- }
- if ($class ==='') {
- $class = 'menu'.$name;
- // name may contaion [], which would make an invalid class. e.g. numeric question type editing form, assignment quickgrading
- $class = str_replace('[', '', $class);
- $class = str_replace(']', '', $class);
- }
- $class = 'select ' . $class; /// Add 'select' selector always
- if ($listbox) {
- if (is_integer($listbox)) {
- $size = $listbox;
- } else {
- $numchoices = count($options);
- if ($nothing) {
- $numchoices += 1;
- }
- $size = min(10, $numchoices);
- }
- $attributes .= ' size="' . $size . '"';
- if ($multiple) {
- $attributes .= ' multiple="multiple"';
- }
- }
- $output = '<select id="'. $id .'" class="'. $class .'" name="'. $name .'" '. $attributes .'>' . "\n";
- if ($nothing) {
- $output .= ' <option value="'. s($nothingvalue) .'"'. "\n";
- if ($nothingvalue === $selected) {
- $output .= ' selected="selected"';
- }
- $output .= '>'. $nothing .'</option>' . "\n";
- }
- if (!empty($options)) {
- foreach ($options as $value => $label) {
- $output .= ' <option value="'. s($value) .'"';
- if ((string)$value == (string)$selected ||
- (is_array($selected) && in_array($value, $selected))) {
- $output .= ' selected="selected"';
- }
- if ($label === '') {
- $output .= '>'. $value .'</option>' . "\n";
- } else {
- $output .= '>'. $label .'</option>' . "\n";
- }
- }
- }
- $output .= '</select>' . "\n";
- if ($return) {
- return $output;
- } else {
- echo $output;
- }
- }
- /**
- * Choose value 0 or 1 from a menu with options 'No' and 'Yes'.
- * Other options like choose_from_menu.
- * @param string $name
- * @param string $selected
- * @param string $string (defaults to '')
- * @param boolean $return whether this function should return a string or output it (defaults to false)
- * @param boolean $disabled (defaults to false)
- * @param int $tabindex
- */
- function choose_from_menu_yesno($name, $selected, $script = '',
- $return = false, $disabled = false, $tabindex = 0) {
- return choose_from_menu(array(get_string('no'), get_string('yes')), $name,
- $selected, '', $script, '0', $return, $disabled, $tabindex);
- }
- /**
- * Just like choose_from_menu, but takes a nested array (2 levels) and makes a dropdown menu
- * including option headings with the first level.
- */
- function choose_from_menu_nested($options,$name,$selected='',$nothing='choose',$script = '',
- $nothingvalue=0,$return=false,$disabled=false,$tabindex=0) {
- if ($nothing == 'choose') {
- $nothing = get_string('choose') .'...';
- }
- $attributes = ($script) ? 'onchange="'. $script .'"' : '';
- if ($disabled) {
- $attributes .= ' disabled="disabled"';
- }
- if ($tabindex) {
- $attributes .= ' tabindex="'.$tabindex.'"';
- }
- $output = '<select id="menu'.$name.'" name="'. $name .'" '. $attributes .'>' . "\n";
- if ($nothing) {
- $output .= ' <option value="'. $nothingvalue .'"'. "\n";
- if ($nothingvalue === $selected) {
- $output .= ' selected="selected"';
- }
- $output .= '>'. $nothing .'</option>' . "\n";
- }
- if (!empty($options)) {
- foreach ($options as $section => $values) {
- $output .= ' <optgroup label="'. s(format_string($section)) .'">'."\n";
- foreach ($values as $value => $label) {
- $output .= ' <option value="'. format_string($value) .'"';
- if ((string)$value == (string)$selected) {
- $output .= ' selected="selected"';
- }
- if ($label === '') {
- $output .= '>'. $value .'</option>' . "\n";
- } else {
- $output .= '>'. $label .'</option>' . "\n";
- }
- }
- $output .= ' </optgroup>'."\n";
- }
- }
- $output .= '</select>' . "\n";
- if ($return) {
- return $output;
- } else {
- echo $output;
- }
- }
- /**
- * Given an array of values, creates a group of radio buttons to be part of a form
- *
- * @param array $options An array of value-label pairs for the radio group (values as keys)
- * @param string $name Name of the radiogroup (unique in the form)
- * @param string $checked The value that is already checked
- */
- function choose_from_radio ($options, $name, $checked='', $return=false) {
- static $idcounter = 0;
- if (!$name) {
- $name = 'unnamed';
- }
- $output = '<span class="radiogroup '.$name."\">\n";
- if (!empty($options)) {
- $currentradio = 0;
- foreach ($options as $value => $label) {
- $htmlid = 'auto-rb'.sprintf('%04d', ++$idcounter);
- $output .= ' <span class="radioelement '.$name.' rb'.$currentradio."\">";
- $output .= '<input name="'.$name.'" id="'.$htmlid.'" type="radio" value="'.$value.'"';
- if ($value == $checked) {
- $output .= ' checked="checked"';
- }
- if ($label === '') {
- $output .= ' /> <label for="'.$htmlid.'">'. $value .'</label></span>' . "\n";
- } else {
- $output .= ' /> <label for="'.$htmlid.'">'. $label .'</label></span>' . "\n";
- }
- $currentradio = ($currentradio + 1) % 2;
- }
- }
- $output .= '</span>' . "\n";
- if ($return) {
- return $output;
- } else {
- echo $output;
- }
- }
- /** Display an standard html checkbox with an optional label
- *
- * @param string $name The name of the checkbox
- * @param string $value The valus that the checkbox will pass when checked
- * @param boolean $checked The flag to tell the checkbox initial state
- * @param string $label The label to be showed near the checkbox
- * @param string $alt The info to be inserted in the alt tag
- */
- function print_checkbox ($name, $value, $checked = true, $label = '', $alt = '', $script='',$return=false) {
- static $idcounter = 0;
- if (!$name) {
- $name = 'unnamed';
- }
- if ($alt) {
- $alt = strip_tags($alt);
- } else {
- $alt = 'checkbox';
- }
- if ($checked) {
- $strchecked = ' checked="checked"';
- } else {
- $strchecked = '';
- }
- $htmlid = 'auto-cb'.sprintf('%04d', ++$idcounter);
- $output = '<span class="checkbox '.$name."\">";
- $output .= '<input name="'.$name.'" id="'.$htmlid.'" type="checkbox" value="'.$value.'" alt="'.$alt.'"'.$strchecked.' '.((!empty($script)) ? ' onclick="'.$script.'" ' : '').' />';
- if(!empty($label)) {
- $output .= ' <label for="'.$htmlid.'">'.$label.'</label>';
- }
- $output .= '</span>'."\n";
- if (empty($return)) {
- echo $output;
- } else {
- return $output;
- }
- }
- /** Display an standard html text field with an optional label
- *
- * @param string $name The name of the text field
- * @param string $value The value of the text field
- * @param string $label The label to be showed near the text field
- * @param string $alt The info to be inserted in the alt tag
- */
- function print_textfield ($name, $value, $alt = '',$size=50,$maxlength=0, $return=false) {
- static $idcounter = 0;
- if (empty($name)) {
- $name = 'unnamed';
- }
- if (empty($alt)) {
- $alt = 'textfield';
- }
- if (!empty($maxlength)) {
- $maxlength = ' maxlength="'.$maxlength.'" ';
- }
- $htmlid = 'auto-tf'.sprintf('%04d', ++$idcounter);
- $output = '<span class="textfield '.$name."\">";
- $output .= '<input name="'.$name.'" id="'.$htmlid.'" type="text" value="'.$value.'" size="'.$size.'" '.$maxlength.' alt="'.$alt.'" />';
- $output .= '</span>'."\n";
- if (empty($return)) {
- echo $output;
- } else {
- return $output;
- }
- }
- /**
- * Implements a complete little popup form
- *
- * @uses $CFG
- * @param string $common The URL up to the point of the variable that changes
- * @param array $options Alist of value-label pairs for the popup list
- * @param string $formid Id must be unique on the page (originaly $formname)
- * @param string $selected The option that is already selected
- * @param string $nothing The label for the "no choice" option
- * @param string $help The name of a help page if help is required
- * @param string $helptext The name of the label for the help button
- * @param boolean $return Indicates whether the function should return the text
- * as a string or echo it directly to the page being rendered
- * @param string $targetwindow The name of the target page to open the linked page in.
- * @param string $selectlabel Text to place in a [label] element - preferred for accessibility.
- * @param array $optionsextra TODO, an array?
- * @param mixed $gobutton If set, this turns off the JavaScript and uses a 'go'
- * button instead (as is always included for JS-disabled users). Set to true
- * for a literal 'Go' button, or to a string to change the name of the button.
- * @return string If $return is true then the entire form is returned as a string.
- * @todo Finish documenting this function<br>
- */
- function popup_form($common, $options, $formid, $selected='', $nothing='choose', $help='', $helptext='', $return=false,
- $targetwindow='self', $selectlabel='', $optionsextra=NULL, $gobutton=NULL) {
- global $CFG;
- static $go, $choose; /// Locally cached, in case there's lots on a page
- if (empty($options)) {
- return '';
- }
- if (!isset($go)) {
- $go = get_string('go');
- }
- if ($nothing == 'choose') {
- if (!isset($choose)) {
- $choose = get_string('choose');
- }
- $nothing = $choose.'...';
- }
- // changed reference to document.getElementById('id_abc') instead of document.abc
- // MDL-7861
- $output = '<form action="'.$CFG->wwwroot.'/course/jumpto.php"'.
- ' method="get" '.
- $CFG->frametarget.
- ' id="'.$formid.'"'.
- ' class="popupform">';
- if ($help) {
- $button = helpbutton($help, $helptext, 'moodle', true, false, '', true);
- } else {
- $button = '';
- }
- if ($selectlabel) {
- $selectlabel = '<label for="'.$formid.'_jump">'.$selectlabel.'</label>';
- }
- if ($gobutton) {
- // Using the no-JavaScript version
- $javascript = '';
- } else if (check_browser_version('MSIE') || (check_browser_version('Opera') && !check_browser_operating_system("Linux"))) {
- //IE and Opera fire the onchange when ever you move into a dropdown list with the keyboard.
- //onfocus will call a function inside dropdown.js. It fixes this IE/Opera behavior.
- //Note: There is a bug on Opera+Linux with the javascript code (first mouse selection is inactive),
- //so we do not fix the Opera behavior on Linux
- $javascript = ' onfocus="initSelect(\''.$formid.'\','.$targetwindow.')"';
- } else {
- //Other browser
- $javascript = ' onchange="'.$targetwindow.
- '.location=document.getElementById(\''.$formid.
- '\').jump.options[document.getElementById(\''.
- $formid.'\').jump.selectedIndex].value;"';
- }
- $output .= '<div>'.$selectlabel.$button.'<select id="'.$formid.'_jump" name="jump"'.$javascript.'>'."\n";
- if ($nothing != '') {
- $output .= " <option value=\"javascript:void(0)\">$nothing</option>\n";
- }
- $inoptgroup = false;
- foreach ($options as $value => $label) {
- if ($label == '--') { /// we are ending previous optgroup
- /// Check to see if we already have a valid open optgroup
- /// XHTML demands that there be at least 1 option within an optgroup
- if ($inoptgroup and (count($optgr) > 1) ) {
- $output .= implode('', $optgr);
- $output .= ' </optgroup>';
- }
- $optgr = array();
- $inoptgroup = false;
- continue;
- } else if (substr($label,0,2) == '--') { /// we are starting a new optgroup
- /// Check to see if we already have a valid open optgroup
- /// XHTML demands that there be at least 1 option within an optgroup
- if ($inoptgroup and (count($optgr) > 1) ) {
- $output .= implode('', $optgr);
- $output .= ' </optgroup>';
- }
- unset($optgr);
- $optgr = array();
- $optgr[] = ' <optgroup label="'. s(format_string(substr($label,2))) .'">'; // Plain labels
- $inoptgroup = true; /// everything following will be in an optgroup
- continue;
- } else {
- if (!empty($CFG->usesid) && !isset($_COOKIE[session_name()]))
- {
- $url=sid_process_url( $common . $value );
- } else
- {
- $url=$common . $value;
- }
- $optstr = ' <option value="' . $url . '"';
- if ($value == $selected) {
- $optstr .= ' selected="selected"';
- }
- if (!empty($optionsextra[$value])) {
- $optstr .= ' '.$optionsextra[$value];
- }
- if ($label) {
- $optstr .= '>'. $label .'</option>' . "\n";
- } else {
- $optstr .= '>'. $value .'</option>' . "\n";
- }
- if ($inoptgroup) {
- $optgr[] = $optstr;
- } else {
- $output .= $optstr;
- }
- }
- }
- /// catch the final group if not closed
- if ($inoptgroup and count($optgr) > 1) {
- $output .= implode('', $optgr);
- $output .= ' </optgroup>';
- }
- $output .= '</select>';
- $output .= '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
- if ($gobutton) {
- $output .= '<input type="submit" value="'.
- ($gobutton===true ? $go : $gobutton).'" />';
- } else {
- $output .= '<div id="noscript'.$formid.'" style="display: inline;">';
- $output .= '<input type="submit" value="'.$go.'" /></div>';
- $output .= '<script type="text/javascript">'.
- "\n//<![CDATA[\n".
- 'document.getElementById("noscript'.$formid.'").style.display = "none";'.
- "\n//]]>\n".'</script>';
- }
- $output .= '</div></form>';
- if ($return) {
- return $output;
- } else {
- echo $output;
- }
- }
- /**
- * Prints some red text
- *
- * @param string $error The text to be displayed in red
- */
- function formerr($error) {
- if (!empty($error)) {
- echo '<span class="error">'. $error .'</span>';
- }
- }
- /**
- * Validates an email to make sure it makes sense.
- *
- * @param string $address The email address to validate.
- * @return boolean
- */
- function validate_email($address) {
- return (ereg('^[-!#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+'.
- '(\.[-!#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+)*'.
- '@'.
- '[-!#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
- '[-!#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$',
- $address));
- }
- /**
- * Extracts file argument either from file parameter or PATH_INFO
- *
- * @param string $scriptname name of the calling script
- * @return string file path (only safe characters)
- */
- function get_file_argument($scriptname) {
- global $_SERVER;
- $relativepath = FALSE;
- // first try normal parameter (compatible method == no relative links!)
- $relativepath = optional_param('file', FALSE, PARAM_PATH);
- if ($relativepath === '/testslasharguments') {
- echo 'test -1 : Incorrect use - try "file.php/testslasharguments" instead'; //indicate fopen/fread works for health center
- die;
- }
- // then try extract file from PATH_INFO (slasharguments method)
- if (!$relativepath and !empty($_SERVER['PATH_INFO'])) {
- $path_info = $_SERVER['PATH_INFO'];
- // check that PATH_INFO works == must not contain the script name
- if (!strpos($path_info, $scriptname)) {
- $relativepath = clean_param(rawurldecode($path_info), PARAM_PATH);
- if ($relativepath === '/testslasharguments') {
- echo 'test 1 : Slasharguments test passed. Server confguration is compatible with file.php/1/pic.jpg slashargument setting.'; //indicate ok for health center
- die;
- }
- }
- }
- // now if both fail try the old way
- // (for compatibility with misconfigured or older buggy php implementations)
- if (!$relativepath) {
- $arr = explode($scriptname, me());
- if (!empty($arr[1])) {
- $path_info = strip_querystring($arr[1]);
- $relativepath = clean_param(rawurldecode($path_info), PARAM_PATH);
- if ($relativepath === '/testslasharguments') {
- 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
- die;
- }
- }
- }
- return $relativepath;
- }
- /**
- * Searches the current environment variables for some slash arguments
- *
- * @param string $file ?
- * @todo Finish documenting this function
- */
- function get_slash_arguments($…
Large files files are truncated, but you can click here to view the full file