[moodle.git] / lib / weblib.php

<?PHP // $Id$

// weblib.php
//
// Library of useful PHP functions and constants related to web pages.
//
//

/// Constants

/// Define text formatting types ... eventually we can add Wiki, BBcode etc
define("FORMAT_MOODLE", "0");
define("FORMAT_HTML", "1");

$SMILEY_TEXT[]  = ":-)";
$SMILEY_IMAGE[] = "<IMG ALT=\":-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/smiley.gif\">";
$SMILEY_TEXT[]  = ":)";
$SMILEY_IMAGE[] = "<IMG ALT=\":-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/smiley.gif\">";
$SMILEY_TEXT[]  = ":-D";
$SMILEY_IMAGE[] = "<IMG ALT=\":-D\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/biggrin.gif\">";
$SMILEY_TEXT[]  = ";-)";
$SMILEY_IMAGE[] = "<IMG ALT=\";-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/wink.gif\">";
$SMILEY_TEXT[]  = ":-/";
$SMILEY_IMAGE[] = "<IMG ALT=\":-/\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/mixed.gif\">";
$SMILEY_TEXT[]  = "V-.";
$SMILEY_IMAGE[] = "<IMG ALT=\"V-.\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/thoughtful.gif\">";
$SMILEY_TEXT[]  = ":-P";
$SMILEY_IMAGE[] = "<IMG ALT=\":-P\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/tongueout.gif\">";
$SMILEY_TEXT[]  = "B-)";
$SMILEY_IMAGE[] = "<IMG ALT=\"B-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/cool.gif\">";
$SMILEY_TEXT[]  = "^-)";
$SMILEY_IMAGE[] = "<IMG ALT=\"^-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/approve.gif\">";
$SMILEY_TEXT[]  = "8-)";
$SMILEY_IMAGE[] = "<IMG ALT=\"8-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/wideeyes.gif\">";
$SMILEY_TEXT[]  = ":o)";
$SMILEY_IMAGE[] = "<IMG ALT=\":o)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/clown.gif\">";
$SMILEY_TEXT[]  = ":-(";
$SMILEY_IMAGE[] = "<IMG ALT=\":-(\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/sad.gif\">";
$SMILEY_TEXT[]  = ":(";
$SMILEY_IMAGE[] = "<IMG ALT=\":-(\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/sad.gif\">";
$SMILEY_TEXT[]  = "8-.";
$SMILEY_IMAGE[] = "<IMG ALT=\"8-.\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/shy.gif\">";
$SMILEY_TEXT[]  = ":-I";
$SMILEY_IMAGE[] = "<IMG ALT=\":-I\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/blush.gif\">";
$SMILEY_TEXT[]  = ":-X";
$SMILEY_IMAGE[] = "<IMG ALT=\":-X\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/kiss.gif\">";
$SMILEY_TEXT[]  = "8-o";
$SMILEY_IMAGE[] = "<IMG ALT=\"8-o\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/surprise.gif\">";
$SMILEY_TEXT[]  = "P-|";
$SMILEY_IMAGE[] = "<IMG ALT=\"P-|\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/blackeye.gif\">";
$SMILEY_TEXT[]  = "8-[";
$SMILEY_IMAGE[] = "<IMG ALT=\"8-[\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/angry.gif\">";
$SMILEY_TEXT[]  = "xx-P";
$SMILEY_IMAGE[] = "<IMG ALT=\"xx-P\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/dead.gif\">";
$SMILEY_TEXT[]  = "|-.";
$SMILEY_IMAGE[] = "<IMG ALT=\"|-.\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/sleepy.gif\">";
$SMILEY_TEXT[]  = "}-]";
$SMILEY_IMAGE[] = "<IMG ALT=\"}-]\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/evil.gif\">";

$JAVASCRIPT_TAGS = array("javascript:", "onclick=", "ondblclick=", "onkeydown=", "onkeypress=", "onkeyup=", 
                         "onmouseover=", "onmouseout=", "onmousedown=", "onmouseup=",
                         "onblur=", "onfocus=", "onload=", "onselect=");

$ALLOWED_TAGS = "<p><br><b><i><u><font><table><tbody><span><div><tr><td><ol><ul><dl><li><dt><dd><h1><h2><h3><h4><h5><h6><hr><img><a><strong><emphasis><sup><sub><address><cite><blockquote><pre>";


/// Functions

function s($var) {
/// returns $var with HTML characters (like "<", ">", etc.) properly quoted,
/// or if $var is empty, will return an empty string. 

	return empty($var) ? "" : htmlSpecialChars(stripslashes($var));
}

function p($var) {
/// prints $var with HTML characters (like "<", ">", etc.) properly quoted,
/// or if $var is empty, will print an empty string. 

	echo empty($var) ? "" : htmlSpecialChars(stripslashes($var));
}

function nvl(&$var, $default="") {
/// if $var is undefined, return $default, otherwise return $var 

    return isset($var) ? $var : $default;
}

function strip_querystring($url) {
/// takes a URL and returns it without the querystring portion 

	if ($commapos = strpos($url, '?')) {
		return substr($url, 0, $commapos);
	} else {
		return $url;
	}
}

function get_referer() {
/// returns the URL of the HTTP_REFERER, less the querystring portion 

    global $HTTP_REFERER;

    return strip_querystring(nvl($HTTP_REFERER));
}


function me() {
/// returns the name of the current script, WITH the querystring portion.
/// this function is necessary because PHP_SELF and REQUEST_URI and PATH_INFO
/// 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.) 

    global $REQUEST_URI, $PATH_INFO, $PHP_SELF;

	if ($REQUEST_URI) {
		return $REQUEST_URI;

	} else if ($PATH_INFO) {
		return $PATH_INFO;

	} else if ($PHP_SELF) {
		return $PHP_SELF;

	} else {
        notify("Error: Could not find any of these web server variables: \$REQUEST_URI, \$PATH_INFO or \$PHP_SELF");
    }
}


function qualified_me() {
/// like me() but returns a full URL 

    global $HTTPS, $HTTP_HOST;

    if (!$HTTP_HOST) {
        notify("Error: could not find web server variable: \$HTTP_HOST");
    }

	$protocol = (isset($HTTPS) && $HTTPS == "on") ? "https://" : "http://";
	$url_prefix = "$protocol$HTTP_HOST";
	return $url_prefix . me();
}


function match_referer($good_referer = "") {
/// returns true if the referer is the same as the good_referer.  If
/// good_referer is not specified, use qualified_me as the good_referer 
    global $CFG;

    if ($CFG->buggy_referer) {
        return true;
    }

	if ($good_referer == "") { 
        $good_referer = qualified_me(); 
    }
	return $good_referer == get_referer();
}


function stri_replace($find, $replace, $string ) {
/// This does a search and replace, ignoring case
/// This function is only here because one doesn't exist yet in PHP
/// Unlike str_replace(), this only works on single values (not arrays)

    $parts = explode(strtolower($find), strtolower($string));

    $pos = 0;

    foreach ($parts as $key => $part) {
        $parts[$key] = substr($string, $pos, strlen($part));
        $pos += strlen($part) + strlen($find);
    }

    return (join($replace, $parts));
}

function read_template($filename, &$var) {
/// return a (big) string containing the contents of a template file with all
/// the variables interpolated.  all the variables must be in the $var[] array or
/// object (whatever you decide to use).
///
/// WARNING: do not use this on big files!! 

	$temp = str_replace("\\", "\\\\", implode(file($filename), ""));
	$temp = str_replace('"', '\"', $temp);
	eval("\$template = \"$temp\";");
	return $template;
}

function checked(&$var, $set_value = 1, $unset_value = 0) {
/// if variable is set, set it to the set_value otherwise set it to the
/// unset_value.  used to handle checkboxes when you are expecting them from
/// a form 

	if (empty($var)) {
		$var = $unset_value;
	} else {
		$var = $set_value;
	}
}

function frmchecked(&$var, $true_value = "checked", $false_value = "") {
/// prints the word "checked" if a variable is true, otherwise prints nothing,
/// used for printing the word "checked" in a checkbox form input 

	if ($var) {
		echo $true_value;
	} else {
		echo $false_value;
	}
}


function link_to_popup_window ($url, $name="popup", $linkname="click here", $height=400, $width=500, $title="Popup window") {
/// This will create a HTML link that will work on both 
/// Javascript and non-javascript browsers.
/// Relies on the Javascript function openpopup in javascript.php
/// $url must be relative to home page  eg /mod/survey/stuff.php

    global $CFG;

	echo "\n<SCRIPT language=\"Javascript\">";
    echo "\n<!--";
	echo "\ndocument.write('<A TITLE=\"$title\" HREF=javascript:openpopup(\"$url\",\"$name\",\"$height\",\"$width\") >$linkname</A>');";
    echo "\n//-->";
   	echo "\n</SCRIPT>";
   	echo "\n<NOSCRIPT>\n<A TARGET=\"$name\" TITLE=\"$title\" HREF=\"$CFG->wwwroot/$url\">$linkname</A>\n</NOSCRIPT>\n";

}

function close_window_button() {
/// Prints a simple button to close a window

    echo "<FORM><CENTER>";
    echo "<INPUT TYPE=button onClick=\"self.close();\" VALUE=\"".get_string("closewindow")."\">";
    echo "</CENTER></FORM>";
}


function choose_from_menu ($options, $name, $selected="", $nothing="choose", $script="", $nothingvalue="0", $return=false) {
/// Given an array of value, creates a popup menu to be part of a form
/// $options["value"]["label"]
    
    if ($nothing == "choose") {
        $nothing = get_string("choose")."...";
    }

    if ($script) {
        $javascript = "onChange=\"$script\"";
    }
    $output = "<SELECT NAME=$name $javascript>\n";
    if ($nothing) {
        $output .= "   <OPTION VALUE=\"$nothingvalue\"\n";
        if ($nothingvalue == $selected) {
            $output .= " SELECTED";
        }
        $output .= ">$nothing</OPTION>\n";
    }
    foreach ($options as $value => $label) {
        $output .= "   <OPTION VALUE=\"$value\"";
        if ($value == $selected) {
            $output .= " SELECTED";
        }
        if ($label) {
            $output .= ">$label</OPTION>\n";
        } else {
            $output .= ">$value</OPTION>\n";
        }
    }
    $output .= "</SELECT>\n";

    if ($return) {
        return $output;
    } else {
        echo $output;
    }
}   

function popup_form ($common, $options, $formname, $selected="", $nothing="choose", $help="", $helptext="", $return=false) {
///  Implements a complete little popup form
///  $common   = the URL up to the point of the variable that changes
///  $options  = A list of value-label pairs for the popup list
///  $formname = name must be unique on the page
///  $selected = the option that is already selected
///  $nothing  = The label for the "no choice" option
///  $help     = The name of a help page if help is required
///  $helptext  = The name of the label for the help button

    if ($nothing == "choose") {
        $nothing = get_string("choose")."...";
    }

    $output = "<FORM TARGET=_top NAME=$formname>";
    $output .= "<SELECT NAME=popup onChange=\"top.location=document.$formname.popup.options[document.$formname.popup.selectedIndex].value\">\n";

    if ($nothing != "") {
        $output .= "   <OPTION VALUE=\"javascript:void(0)\">$nothing</OPTION>\n";
    }

    foreach ($options as $value => $label) {
        if (substr($label,0,1) == "-") {
            $output .= "   <OPTION VALUE=\"\"";
        } else {
            $output .= "   <OPTION VALUE=\"$common$value\"";
            if ($value == $selected) {
                $output .= " SELECTED";
            }
        }
        if ($label) {
            $output .= ">$label</OPTION>\n";
        } else {
            $output .= ">$value</OPTION>\n";
        }
    }
    $output .= "</SELECT>";
    if (!$return and $help) {
        helpbutton($help, $helptext);
    }
    $output .= "</FORM>\n";

    if ($return) {
        return $output;
    } else {
        echo $output;
    }
}


function formerr($error) {
/// Prints some red text
    if (!empty($error)) {
        echo "<font color=#ff0000>$error</font>";
    }
}


function validate_email ($address) {
/// Validates an email to make it makes sense.
    return (ereg('^[-!#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+'.
                  '@'.
                  '[-!#$%&\'*+\\/0-9=?A-Z^_`a-z{|}~]+\.'.
                  '[-!#$%&\'*+\\./0-9=?A-Z^_`a-z{|}~]+$',
                  $address));
}


function get_slash_arguments($i=0) {
/// Extracts arguments from "/foo/bar/something"
/// eg http://mysite.com/script.php/foo/bar/something
/// Might only work on Apache

    global $PATH_INFO;

    if (!isset($PATH_INFO)) {
        return false;
    }

    if (strpos($PATH_INFO, "..")) { // check for parent URLs
        return false;
    }
    if (strpos($PATH_INFO, "|")) {  // check for pipes
        return false;
    }
    if (strpos($PATH_INFO, "`")) {  // check for backquotes
        return false;
    }

    $args = explode("/", $PATH_INFO);

    if ($i) {     // return just the required argument
        return $args[$i];

    } else {      // return the whole array
        array_shift($args);  // get rid of the empty first one
        return $args;
    }
}

function format_text_menu() {
/// Just returns an array of formats suitable for a popup menu
    return array (FORMAT_MOODLE => get_string("formattext"), 
                  FORMAT_HTML   => get_string("formathtml") );
}

function format_text($text, $format=FORMAT_MOODLE, $options=NULL) {
/// Given text in a variety of format codings, this function returns 
/// the text as safe HTML.
///
/// $text is raw text (originally from a user)
/// $format is one of the format constants, defined above

    switch ($format) {
        case FORMAT_MOODLE:
            if (!isset($options->smiley)) {
                $options->smiley=true;
            }
            if (!isset($options->para)) {
                $options->para=true;
            }
            return text_to_html($text, $options->smiley, $options->para);
            break;

        case FORMAT_HTML:
            $text = replace_smilies($text);
            return $text;
            break;
    }
}


function clean_text($text, $format) {
/// Given raw text (eg typed in by a user), this function cleans it up 
/// and removes any nasty tags that could mess up Moodle pages.

    global $JAVASCRIPT_TAGS, $ALLOWED_TAGS;

    switch ($format) {   // Does the same thing, currently, but it's nice to have the option
        case FORMAT_MOODLE:
            $text = strip_tags($text, $ALLOWED_TAGS);
            foreach ($JAVASCRIPT_TAGS as $tag) {
                $text = stri_replace($tag, "", $text);
            }
            return $text;

        case FORMAT_HTML:
            $text = strip_tags($text, $ALLOWED_TAGS);
            foreach ($JAVASCRIPT_TAGS as $tag) {
                $text = stri_replace($tag, "", $text);
            }
            return $text;
    }
}

function replace_smilies($text) {
/// Replaces all known smileys in the text with image equivalents

    global $CFG, $SMILEY_TEXT, $SMILEY_IMAGE;

    return str_replace($SMILEY_TEXT, $SMILEY_IMAGE, $text);
}

function text_to_html($text, $smiley=true, $para=true) {
/// Given plain text, makes it into HTML as nicely as possible.
/// May contain HTML tags already

/// Remove any whitespace that may be between HTML tags
    $text = eregi_replace(">([[:space:]]+)<", "><", $text);

/// Remove any returns that precede or follow HTML tags
    $text = eregi_replace("([\n\r])<", " <", $text);
    $text = eregi_replace(">([\n\r])", "> ", $text);

/// Make lone URLs into links.   eg http://moodle.com/
    $text = eregi_replace("([\n\r ([])([[:alnum:]]+)://([^[:space:]]*)([[:alnum:]#?/&=])", 
                          "\\1<A HREF=\"\\2://\\3\\4\" TARGET=\"newpage\">\\2://\\3\\4</A>", $text);

/// eg www.moodle.com
    $text = eregi_replace("([[:space:]])www.([^[:space:]]*)([[:alnum:]#?/&=])", 
                          "\\1<A HREF=\"http://www.\\2\\3\" TARGET=\"newpage\">www.\\2\\3</A>", $text);

/// Make returns into HTML newlines.
    $text = nl2br($text);

/// Turn smileys into images.
    if ($smiley) {
        $text = replace_smilies($text);
    }

/// Wrap the whole thing in a paragraph tag if required
    if ($para) {
        return "<P>".$text."</P>";
    } else {
        return $text;
    }
}

function highlight($needle, $haystack) {
/// This function will highlight instances of $needle in $haystack

    $parts = explode(strtolower($needle), strtolower($haystack));

    $pos = 0;

    foreach ($parts as $key => $part) {
        $parts[$key] = substr($haystack, $pos, strlen($part));
        $pos += strlen($part);

        $parts[$key] .= "<SPAN CLASS=highlight>".substr($haystack, $pos, strlen($needle))."</SPAN>";
        $pos += strlen($needle);
    }   

    return (join('', $parts));
}


?>
Commit	Line	Data
f9903ed0	1	<?PHP // $Id$
	2
	3	// weblib.php
	4	//
0095d5cd	5	// Library of useful PHP functions and constants related to web pages.
f9903ed0	6	//
	7	//
	8
0095d5cd	9	/// Constants
0095d5cd	10
c1d57101	11	/// Define text formatting types ... eventually we can add Wiki, BBcode etc
0095d5cd	12	define("FORMAT_MOODLE", "0");
	13	define("FORMAT_HTML", "1");
	14
c9dda990	15	$SMILEY_TEXT[] = ":-)";
	16	$SMILEY_IMAGE[] = "<IMG ALT=\":-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/smiley.gif\">";
	17	$SMILEY_TEXT[] = ":)";
	18	$SMILEY_IMAGE[] = "<IMG ALT=\":-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/smiley.gif\">";
	19	$SMILEY_TEXT[] = ":-D";
	20	$SMILEY_IMAGE[] = "<IMG ALT=\":-D\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/biggrin.gif\">";
	21	$SMILEY_TEXT[] = ";-)";
	22	$SMILEY_IMAGE[] = "<IMG ALT=\";-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/wink.gif\">";
	23	$SMILEY_TEXT[] = ":-/";
	24	$SMILEY_IMAGE[] = "<IMG ALT=\":-/\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/mixed.gif\">";
	25	$SMILEY_TEXT[] = "V-.";
	26	$SMILEY_IMAGE[] = "<IMG ALT=\"V-.\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/thoughtful.gif\">";
	27	$SMILEY_TEXT[] = ":-P";
	28	$SMILEY_IMAGE[] = "<IMG ALT=\":-P\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/tongueout.gif\">";
	29	$SMILEY_TEXT[] = "B-)";
	30	$SMILEY_IMAGE[] = "<IMG ALT=\"B-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/cool.gif\">";
	31	$SMILEY_TEXT[] = "^-)";
	32	$SMILEY_IMAGE[] = "<IMG ALT=\"^-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/approve.gif\">";
	33	$SMILEY_TEXT[] = "8-)";
	34	$SMILEY_IMAGE[] = "<IMG ALT=\"8-)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/wideeyes.gif\">";
	35	$SMILEY_TEXT[] = ":o)";
	36	$SMILEY_IMAGE[] = "<IMG ALT=\":o)\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/clown.gif\">";
	37	$SMILEY_TEXT[] = ":-(";
	38	$SMILEY_IMAGE[] = "<IMG ALT=\":-(\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/sad.gif\">";
	39	$SMILEY_TEXT[] = ":(";
	40	$SMILEY_IMAGE[] = "<IMG ALT=\":-(\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/sad.gif\">";
	41	$SMILEY_TEXT[] = "8-.";
	42	$SMILEY_IMAGE[] = "<IMG ALT=\"8-.\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/shy.gif\">";
	43	$SMILEY_TEXT[] = ":-I";
	44	$SMILEY_IMAGE[] = "<IMG ALT=\":-I\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/blush.gif\">";
	45	$SMILEY_TEXT[] = ":-X";
	46	$SMILEY_IMAGE[] = "<IMG ALT=\":-X\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/kiss.gif\">";
	47	$SMILEY_TEXT[] = "8-o";
	48	$SMILEY_IMAGE[] = "<IMG ALT=\"8-o\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/surprise.gif\">";
	49	$SMILEY_TEXT[] = "P-\|";
	50	$SMILEY_IMAGE[] = "<IMG ALT=\"P-\|\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/blackeye.gif\">";
	51	$SMILEY_TEXT[] = "8-[";
	52	$SMILEY_IMAGE[] = "<IMG ALT=\"8-[\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/angry.gif\">";
	53	$SMILEY_TEXT[] = "xx-P";
	54	$SMILEY_IMAGE[] = "<IMG ALT=\"xx-P\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/dead.gif\">";
	55	$SMILEY_TEXT[] = "\|-.";
	56	$SMILEY_IMAGE[] = "<IMG ALT=\"\|-.\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/sleepy.gif\">";
	57	$SMILEY_TEXT[] = "}-]";
	58	$SMILEY_IMAGE[] = "<IMG ALT=\"}-]\" WIDTH=15 HEIGHT=15 SRC=\"$CFG->wwwroot/pix/s/evil.gif\">";
0095d5cd	59
3fe3851d	60	$JAVASCRIPT_TAGS = array("javascript:", "onclick=", "ondblclick=", "onkeydown=", "onkeypress=", "onkeyup=",
	61	"onmouseover=", "onmouseout=", "onmousedown=", "onmouseup=",
	62	"onblur=", "onfocus=", "onload=", "onselect=");
	63
840aaba1	64	$ALLOWED_TAGS = "<p><br><b><i><u><font><table><tbody><span><div><tr><td><ol><ul><dl><li><dt><dd><h1><h2><h3><h4><h5><h6><hr><img><a><strong><emphasis><sup><sub><address><cite><blockquote><pre>";
3fe3851d	65
3fe3851d	66
0095d5cd	67	/// Functions
0095d5cd	68
8553b700	69	function s($var) {
c1d57101	70	/// returns $var with HTML characters (like "<", ">", etc.) properly quoted,
c1d57101	71	/// or if $var is empty, will return an empty string.
f9903ed0	72
	73	return empty($var) ? "" : htmlSpecialChars(stripslashes($var));
	74	}
	75
	76	function p($var) {
c1d57101	77	/// prints $var with HTML characters (like "<", ">", etc.) properly quoted,
c1d57101	78	/// or if $var is empty, will print an empty string.
f9903ed0	79
	80	echo empty($var) ? "" : htmlSpecialChars(stripslashes($var));
	81	}
	82
8553b700	83	function nvl(&$var, $default="") {
c1d57101	84	/// if $var is undefined, return $default, otherwise return $var
8553b700	85
	86	return isset($var) ? $var : $default;
	87	}
f9903ed0	88
f9903ed0	89	function strip_querystring($url) {
c1d57101	90	/// takes a URL and returns it without the querystring portion
f9903ed0	91
	92	if ($commapos = strpos($url, '?')) {
	93	return substr($url, 0, $commapos);
	94	} else {
	95	return $url;
	96	}
	97	}
	98
	99	function get_referer() {
c1d57101	100	/// returns the URL of the HTTP_REFERER, less the querystring portion
f9903ed0	101
7fbd6b1c	102	global $HTTP_REFERER;
c1d57101	103
8553b700	104	return strip_querystring(nvl($HTTP_REFERER));
f9903ed0	105	}
f9903ed0	106
c1d57101	107
f9903ed0	108	function me() {
c1d57101	109	/// returns the name of the current script, WITH the querystring portion.
	110	/// this function is necessary because PHP_SELF and REQUEST_URI and PATH_INFO
	111	/// return different things depending on a lot of things like your OS, Web
	112	/// server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.)
f9903ed0	113
7fbd6b1c	114	global $REQUEST_URI, $PATH_INFO, $PHP_SELF;
f9903ed0	115
7fbd6b1c	116	if ($REQUEST_URI) {
7fbd6b1c	117	return $REQUEST_URI;
c1d57101	118
7fbd6b1c	119	} else if ($PATH_INFO) {
7fbd6b1c	120	return $PATH_INFO;
c1d57101	121
7fbd6b1c	122	} else if ($PHP_SELF) {
7fbd6b1c	123	return $PHP_SELF;
c1d57101	124
7fbd6b1c	125	} else {
c1d57101	126	notify("Error: Could not find any of these web server variables: \$REQUEST_URI, \$PATH_INFO or \$PHP_SELF");
7fbd6b1c	127	}
f9903ed0	128	}
	129
	130
f9903ed0	131	function qualified_me() {
c1d57101	132	/// like me() but returns a full URL
f9903ed0	133
c1d57101	134	global $HTTPS, $HTTP_HOST;
	135
	136	if (!$HTTP_HOST) {
	137	notify("Error: could not find web server variable: \$HTTP_HOST");
	138	}
f9903ed0	139
	140	$protocol = (isset($HTTPS) && $HTTPS == "on") ? "https://" : "http://";
	141	$url_prefix = "$protocol$HTTP_HOST";
	142	return $url_prefix . me();
	143	}
	144
	145
	146	function match_referer($good_referer = "") {
c1d57101	147	/// returns true if the referer is the same as the good_referer. If
87a2fa03	148	/// good_referer is not specified, use qualified_me as the good_referer
60f18531	149	global $CFG;
	150
	151	if ($CFG->buggy_referer) {
	152	return true;
	153	}
f9903ed0	154
c1d57101	155	if ($good_referer == "") {
	156	$good_referer = qualified_me();
	157	}
f9903ed0	158	return $good_referer == get_referer();
	159	}
	160
	161
3fe3851d	162	function stri_replace($find, $replace, $string ) {
c1d57101	163	/// This does a search and replace, ignoring case
	164	/// This function is only here because one doesn't exist yet in PHP
	165	/// Unlike str_replace(), this only works on single values (not arrays)
3fe3851d	166
	167	$parts = explode(strtolower($find), strtolower($string));
	168
	169	$pos = 0;
	170
	171	foreach ($parts as $key => $part) {
	172	$parts[$key] = substr($string, $pos, strlen($part));
	173	$pos += strlen($part) + strlen($find);
	174	}
	175
	176	return (join($replace, $parts));
	177	}
	178
f9903ed0	179	function read_template($filename, &$var) {
c1d57101	180	/// return a (big) string containing the contents of a template file with all
	181	/// the variables interpolated. all the variables must be in the $var[] array or
	182	/// object (whatever you decide to use).
	183	///
	184	/// WARNING: do not use this on big files!!
f9903ed0	185
	186	$temp = str_replace("\\", "\\\\", implode(file($filename), ""));
	187	$temp = str_replace('"', '\"', $temp);
	188	eval("\$template = \"$temp\";");
	189	return $template;
	190	}
	191
	192	function checked(&$var, $set_value = 1, $unset_value = 0) {
c1d57101	193	/// if variable is set, set it to the set_value otherwise set it to the
	194	/// unset_value. used to handle checkboxes when you are expecting them from
	195	/// a form
f9903ed0	196
	197	if (empty($var)) {
	198	$var = $unset_value;
	199	} else {
	200	$var = $set_value;
	201	}
	202	}
	203
	204	function frmchecked(&$var, $true_value = "checked", $false_value = "") {
c1d57101	205	/// prints the word "checked" if a variable is true, otherwise prints nothing,
c1d57101	206	/// used for printing the word "checked" in a checkbox form input
f9903ed0	207
	208	if ($var) {
	209	echo $true_value;
	210	} else {
	211	echo $false_value;
	212	}
	213	}
	214
	215
65cf9fc3	216	function link_to_popup_window ($url, $name="popup", $linkname="click here", $height=400, $width=500, $title="Popup window") {
c1d57101	217	/// This will create a HTML link that will work on both
	218	/// Javascript and non-javascript browsers.
	219	/// Relies on the Javascript function openpopup in javascript.php
	220	/// $url must be relative to home page eg /mod/survey/stuff.php
f9903ed0	221
ff80e012	222	global $CFG;
ff80e012	223
f9903ed0	224	echo "\n<SCRIPT language=\"Javascript\">";
f9903ed0	225	echo "\n<!--";
65cf9fc3	226	echo "\ndocument.write('<A TITLE=\"$title\" HREF=javascript:openpopup(\"$url\",\"$name\",\"$height\",\"$width\") >$linkname</A>');";
f9903ed0	227	echo "\n//-->";
f9903ed0	228	echo "\n</SCRIPT>";
ff80e012	229	echo "\n<NOSCRIPT>\n<A TARGET=\"$name\" TITLE=\"$title\" HREF=\"$CFG->wwwroot/$url\">$linkname</A>\n</NOSCRIPT>\n";
f9903ed0	230
	231	}
	232
	233	function close_window_button() {
c1d57101	234	/// Prints a simple button to close a window
c1d57101	235
f9903ed0	236	echo "<FORM><CENTER>";
e5dfd0f3	237	echo "<INPUT TYPE=button onClick=\"self.close();\" VALUE=\"".get_string("closewindow")."\">";
f9903ed0	238	echo "</CENTER></FORM>";
	239	}
	240
	241
08056730	242	function choose_from_menu ($options, $name, $selected="", $nothing="choose", $script="", $nothingvalue="0", $return=false) {
c1d57101	243	/// Given an array of value, creates a popup menu to be part of a form
c1d57101	244	/// $options["value"]["label"]
f9903ed0	245
618b22c5	246	if ($nothing == "choose") {
	247	$nothing = get_string("choose")."...";
	248	}
	249
f9903ed0	250	if ($script) {
	251	$javascript = "onChange=\"$script\"";
	252	}
08056730	253	$output = "<SELECT NAME=$name $javascript>\n";
bda8d43a	254	if ($nothing) {
08056730	255	$output .= " <OPTION VALUE=\"$nothingvalue\"\n";
bda8d43a	256	if ($nothingvalue == $selected) {
08056730	257	$output .= " SELECTED";
bda8d43a	258	}
08056730	259	$output .= ">$nothing</OPTION>\n";
873960de	260	}
f9903ed0	261	foreach ($options as $value => $label) {
08056730	262	$output .= " <OPTION VALUE=\"$value\"";
f9903ed0	263	if ($value == $selected) {
08056730	264	$output .= " SELECTED";
f9903ed0	265	}
f9903ed0	266	if ($label) {
08056730	267	$output .= ">$label</OPTION>\n";
f9903ed0	268	} else {
08056730	269	$output .= ">$value</OPTION>\n";
f9903ed0	270	}
f9903ed0	271	}
08056730	272	$output .= "</SELECT>\n";
	273
	274	if ($return) {
	275	return $output;
	276	} else {
	277	echo $output;
	278	}
f9903ed0	279	}
f9903ed0	280
d897cae4	281	function popup_form ($common, $options, $formname, $selected="", $nothing="choose", $help="", $helptext="", $return=false) {
c1d57101	282	/// Implements a complete little popup form
	283	/// $common = the URL up to the point of the variable that changes
	284	/// $options = A list of value-label pairs for the popup list
	285	/// $formname = name must be unique on the page
	286	/// $selected = the option that is already selected
	287	/// $nothing = The label for the "no choice" option
e5dfd0f3	288	/// $help = The name of a help page if help is required
e5dfd0f3	289	/// $helptext = The name of the label for the help button
f9903ed0	290
618b22c5	291	if ($nothing == "choose") {
	292	$nothing = get_string("choose")."...";
	293	}
	294
3e50a139	295	$output = "<FORM TARGET=_top NAME=$formname>";
3e50a139	296	$output .= "<SELECT NAME=popup onChange=\"top.location=document.$formname.popup.options[document.$formname.popup.selectedIndex].value\">\n";
f9903ed0	297
f9903ed0	298	if ($nothing != "") {
d897cae4	299	$output .= " <OPTION VALUE=\"javascript:void(0)\">$nothing</OPTION>\n";
f9903ed0	300	}
	301
	302	foreach ($options as $value => $label) {
d897cae4	303	if (substr($label,0,1) == "-") {
	304	$output .= " <OPTION VALUE=\"\"";
	305	} else {
	306	$output .= " <OPTION VALUE=\"$common$value\"";
	307	if ($value == $selected) {
	308	$output .= " SELECTED";
	309	}
f9903ed0	310	}
f9903ed0	311	if ($label) {
d897cae4	312	$output .= ">$label</OPTION>\n";
f9903ed0	313	} else {
d897cae4	314	$output .= ">$value</OPTION>\n";
f9903ed0	315	}
f9903ed0	316	}
d897cae4	317	$output .= "</SELECT>";
d897cae4	318	if (!$return and $help) {
e5dfd0f3	319	helpbutton($help, $helptext);
e5dfd0f3	320	}
d897cae4	321	$output .= "</FORM>\n";
	322
	323	if ($return) {
	324	return $output;
	325	} else {
	326	echo $output;
	327	}
f9903ed0	328	}
	329
	330
	331
	332	function formerr($error) {
c1d57101	333	/// Prints some red text
f9903ed0	334	if (!empty($error)) {
	335	echo "<font color=#ff0000>$error</font>";
	336	}
	337	}
	338
	339
	340	function validate_email ($address) {
c1d57101	341	/// Validates an email to make it makes sense.
f9903ed0	342	return (ereg('^[-!#$%&\'*+\\./0-9=?A-Z^_`a-z{\|}~]+'.
	343	'@'.
	344	'[-!#$%&\'*+\\/0-9=?A-Z^_`a-z{\|}~]+\.'.
	345	'[-!#$%&\'*+\\./0-9=?A-Z^_`a-z{\|}~]+$',
	346	$address));
	347	}
	348
	349
	350	function get_slash_arguments($i=0) {
c1d57101	351	/// Extracts arguments from "/foo/bar/something"
	352	/// eg http://mysite.com/script.php/foo/bar/something
	353	/// Might only work on Apache
f9903ed0	354
	355	global $PATH_INFO;
	356
	357	if (!isset($PATH_INFO)) {
	358	return false;
	359	}
	360
780db230	361	if (strpos($PATH_INFO, "..")) { // check for parent URLs
	362	return false;
	363	}
	364	if (strpos($PATH_INFO, "\|")) { // check for pipes
	365	return false;
	366	}
	367	if (strpos($PATH_INFO, "`")) { // check for backquotes
e2d89725	368	return false;
	369	}
	370
f9903ed0	371	$args = explode("/", $PATH_INFO);
	372
	373	if ($i) { // return just the required argument
	374	return $args[$i];
	375
	376	} else { // return the whole array
	377	array_shift($args); // get rid of the empty first one
	378	return $args;
	379	}
	380	}
	381
0095d5cd	382	function format_text_menu() {
c1d57101	383	/// Just returns an array of formats suitable for a popup menu
0095d5cd	384	return array (FORMAT_MOODLE => get_string("formattext"),
	385	FORMAT_HTML => get_string("formathtml") );
	386	}
	387
60f18531	388	function format_text($text, $format=FORMAT_MOODLE, $options=NULL) {
c1d57101	389	/// Given text in a variety of format codings, this function returns
	390	/// the text as safe HTML.
	391	///
	392	/// $text is raw text (originally from a user)
	393	/// $format is one of the format constants, defined above
0095d5cd	394
	395	switch ($format) {
	396	case FORMAT_MOODLE:
c9dda990	397	if (!isset($options->smiley)) {
	398	$options->smiley=true;
	399	}
	400	if (!isset($options->para)) {
1a072208	401	$options->para=true;
c9dda990	402	}
0095d5cd	403	return text_to_html($text, $options->smiley, $options->para);
0095d5cd	404	break;
f9903ed0	405
0095d5cd	406	case FORMAT_HTML:
1a072208	407	$text = replace_smilies($text);
3fe3851d	408	return $text;
0095d5cd	409	break;
	410	}
	411	}
	412
	413
	414	function clean_text($text, $format) {
c1d57101	415	/// Given raw text (eg typed in by a user), this function cleans it up
c1d57101	416	/// and removes any nasty tags that could mess up Moodle pages.
b7a3cf49	417
3fe3851d	418	global $JAVASCRIPT_TAGS, $ALLOWED_TAGS;
	419
	420	switch ($format) { // Does the same thing, currently, but it's nice to have the option
0095d5cd	421	case FORMAT_MOODLE:
3fe3851d	422	$text = strip_tags($text, $ALLOWED_TAGS);
	423	foreach ($JAVASCRIPT_TAGS as $tag) {
	424	$text = stri_replace($tag, "", $text);
	425	}
	426	return $text;
0095d5cd	427
0095d5cd	428	case FORMAT_HTML:
3fe3851d	429	$text = strip_tags($text, $ALLOWED_TAGS);
	430	foreach ($JAVASCRIPT_TAGS as $tag) {
	431	$text = stri_replace($tag, "", $text);
	432	}
	433	return $text;
0095d5cd	434	}
b7a3cf49	435	}
f9903ed0	436
1a072208	437	function replace_smilies($text) {
c1d57101	438	/// Replaces all known smileys in the text with image equivalents
c1d57101	439
1a072208	440	global $CFG, $SMILEY_TEXT, $SMILEY_IMAGE;
b7a3cf49	441
1a072208	442	return str_replace($SMILEY_TEXT, $SMILEY_IMAGE, $text);
1a072208	443	}
0095d5cd	444
909f539d	445	function text_to_html($text, $smiley=true, $para=true) {
c1d57101	446	/// Given plain text, makes it into HTML as nicely as possible.
c1d57101	447	/// May contain HTML tags already
f9903ed0	448
c1d57101	449	/// Remove any whitespace that may be between HTML tags
7b3be1b1	450	$text = eregi_replace(">([[:space:]]+)<", "><", $text);
7b3be1b1	451
c1d57101	452	/// Remove any returns that precede or follow HTML tags
0eae8049	453	$text = eregi_replace("([\n\r])<", " <", $text);
0eae8049	454	$text = eregi_replace(">([\n\r])", "> ", $text);
7b3be1b1	455
c1d57101	456	/// Make lone URLs into links. eg http://moodle.com/
0be05df0	457	$text = eregi_replace("([\n\r ([])([[:alnum:]]+)://([^[:space:]]*)([[:alnum:]#?/&=])",
3fe3851d	458	"\\1<A HREF=\"\\2://\\3\\4\" TARGET=\"newpage\">\\2://\\3\\4</A>", $text);
f9903ed0	459
c1d57101	460	/// eg www.moodle.com
f9903ed0	461	$text = eregi_replace("([[:space:]])www.([^[:space:]]*)([[:alnum:]#?/&=])",
	462	"\\1<A HREF=\"http://www.\\2\\3\" TARGET=\"newpage\">www.\\2\\3</A>", $text);
	463
c1d57101	464	/// Make returns into HTML newlines.
f9903ed0	465	$text = nl2br($text);
f9903ed0	466
c1d57101	467	/// Turn smileys into images.
d69cb7f4	468	if ($smiley) {
1a072208	469	$text = replace_smilies($text);
d69cb7f4	470	}
f9903ed0	471
c1d57101	472	/// Wrap the whole thing in a paragraph tag if required
909f539d	473	if ($para) {
	474	return "<P>".$text."</P>";
	475	} else {
	476	return $text;
	477	}
f9903ed0	478	}
f9903ed0	479
5af78ed2	480	function highlight($needle, $haystack) {
c1d57101	481	/// This function will highlight instances of $needle in $haystack
5af78ed2	482
	483	$parts = explode(strtolower($needle), strtolower($haystack));
	484
	485	$pos = 0;
	486
	487	foreach ($parts as $key => $part) {
	488	$parts[$key] = substr($haystack, $pos, strlen($part));
	489	$pos += strlen($part);
	490
	491	$parts[$key] .= "<SPAN CLASS=highlight>".substr($haystack, $pos, strlen($needle))."</SPAN>";
	492	$pos += strlen($needle);
	493	}
	494
	495	return (join('', $parts));
	496	}
	497
f9903ed0	498
f9903ed0	499	?>