require_once('../inc/sanitize_html.inc');
/**
* This file holds options and functions relating to outputted text.
* It does things like clean out HTML, convert newlines to
tags,
* and other such niceties.
**/
class output_options {
var $bb2html; // BBCode as HTML? (on)
var $boincdoc; // Transform [[Wikiwords]] in to BoincDoc links (on)
var $images_as_links; // Images as hyperlinks? (off)
var $link_popup; // Links in new windows? (off)
var $closeTags; // Close extra HTML tags? (on)
var $nl2br; // Convert newlines to
's? (on)
var $htmlitems; // Convert special chars to HTML entities? (on)
var $htmlscrub; // Scrub "bad" HTML tags? (off)
var $stripslashes; // Strip slashes (depends)
var $highlight_terms;// Array of terms to be highlighted (off)
/**
* Constructor - set the defaults.
**/
function output_options() {
$this->bb2html = 1;
$this->boincdoc = 1;
$this->images_as_links = 0;
$this->link_popup = 0;
$this->closeTags = 1;
$this->nl2br = 1;
$this->htmlitems = 1;
$this->htmlscrub = 0;
if (get_magic_quotes_gpc()) {
$this->stripslashes = 1;
}
$this->highlight_terms = 0;
return true;
}
/**
* Define the terms to be highlighted (for use with searches
* and such)
*/
function setHighlightTerms($terms) {
if (is_array($terms)) {
$this->highlight_terms = $terms;
} else {
return false;
}
return true;
}
}
/**
* Do the actual transformation of the text.
* TODO: Make this part of the above class.
**/
function output_transform($text, $options = NULL) {
// Options is a output_options object, defined above
if (!$options) {
$options = new output_options; // Defaults in the class definition
}
if ($options->stripslashes) {
$text = stripslashes($text);
}
if ($options->htmlitems) {
//$text = htmlentities($text);
$text = htmlspecialchars($text);
}
if ($options->htmlscrub) {
$text = sanitize_html($text);
}
if ($options->nl2br) {
$text = nl2br($text);
}
if ($options->bb2html) {
$text = bb2html($text);
}
if ($options->boincdoc) {
$text = boincdoc($text);
}
if ($options->images_as_links) {
$text = image_as_link($text);
}
if ($options->link_popup) {
$text = externalize_links($text);
}
if (is_array($options->highlight_terms)) {
$text = highlight_terms($text, $options->highlight_terms);
}
return $text;
}
/**
* Take a user object and get their settings to create an output_options
* object from them.
**/
function get_transform_settings_from_user($user, $options = '') {
// $user - a user object
// $options - a output_options object (optional)
if (!$options) {
$options = new output_options; // Give defaults
}
if ($user->images_as_links==1){
$options->images_as_links = 1;
}
if ($user->link_popup==1){
$options->link_popup = 1;
}
return $options;
}
/**
* Converts bbcode to proper HTML
**/
function bb2html($text) {
$urlregex = "(?:\"?)(?:(http\:\/\/)?)([^\[\"<\ ]+)(?:\"?)";
// List of allowable tags
$bbtags = array (
"@\[b\](.*?)\[/b\]@is",
"@\[i\](.*?)\[/i\]@is",
"@\[u\](.*?)\[/u\]@is",
"@\[link=$urlregex\](.*?)\[/link\]@i",
"@\[link\]$urlregex\[/link\]@i",
"@\[url=$urlregex\](.*?)\[/url\]@i",
"@\[url\]$urlregex\[/url\]@i",
"@\[quote=(.*?)\](.*?)\[/quote\]@is",
"@\[quote\](.*?)\[/quote\]@is",
"@\[font=(.*?)\](.*?)\[/font\]@is",
"@\[list\](.*?)\[/list\]@is",
"@\[list=1\](.*?)\[/list\]@is",
"@\[pre\](.*?)\[/pre\]@is",
"@\[img\]$urlregex\[/img\]@is",
"@\[color=(?:\"?)(.{3,8})(?:\"?)\](.*?)\[/color\]@is",
"@((?:
\\2
", "
\\1
", "\\2", "
", "
", "
\\1", "", "\\2", "\\1
\\1", "\\1", "\\1" ); // Do the actual replacing - iterations for nested items $lasttext = ""; $i = 0; // $i<10 to prevent DoS while ($text != $lasttext && $i<20) { $lasttext = $text; $text = preg_replace($bbtags,$htmltags,$text); $i = $i + 1; } return $text; } /** * Converts wiki words [[Like This]] in to links to the Boinc Wiki **/ function boincdoc ($text) { $wikimatch = "@\[\[(.[a-zA-Z\@\ \_\-]+)\]\]@ise"; $wikititlematch = "@\[\[(.[a-zA-Z\@\ \_\-]+)([|])([a-zA-Z\_\-\ ]+)\]\]@ise"; $wikichange = "boincdoc_linkcreate('\\1')"; $wikititlechange = "boincdoc_linkcreate('\\1', '\\3')"; $text = preg_replace($wikititlematch, $wikititlechange, $text); $text = preg_replace($wikimatch, $wikichange, $text); return $text; } /** * Callback function for the above. **/ function boincdoc_linkcreate ($wikitext,$title = '') { /* This function is only called from boincdoc() */ $hyperlink = str_replace(' ', '_', $wikitext); // Spaces to underscores $hyperlink = urlencode($hyperlink); $hyperlink = ""; if ($title != '') { $hyperlink .= "$title"; } else { $hyperlink .= "$wikitext"; } return $hyperlink; } /** * Make links open in new windows. **/ function externalize_links($text) { // TODO: Convert this to PCRE $i=0;$linkpos=true; while (true){ //Find a link $linkpos=strpos($text,"]+)>@si'; // Gives us the URL in ${1}... $replacement = '[Image Link]'; // Turns that URL into a hyperlink $text = preg_replace($pattern, $replacement, $text); return $text; } /** * Coses open HTML tags. Not quite perfect... **/ function closeTags($str = null) { // Function from http://episteme.arstechnica.com/eve/ubb.x/a/tpc/f/6330927813/m/139006252731/r/287008552731#287008552731 // (thanks Ageless for finding it) // Edited by Rob to better fit in with boinc's needs // List of tags to check $str for // TODO: Adapt to use the pre-existing array of tags above $tags = array('b', 'i', 'a', 'p', 'font[^>]?', 'strong', 'ul', 'li', 'pre', 'blockquote', 'u'); // Note on $tags - no br or img, as they have no closing tags - can we define this above? // Maybe define two arrays, those with closing tags and those without, and combine the // two of them for the standard HTML sanitizing function? // Don't do anything if the string is too short if (strlen($str) < 3) { return $str; } else { // Loop over $str and count the opening and closing for each tag in $tags foreach ($tags as $tag) { $m = array(); $o = preg_match_all("/<(".$tag.")>/", $str, $m); $c = substr_count($str, "{$tag}>"); $open[$tag] = ($o < $c) ? $c - $o : 0; $close[$tag] = ($c < $o) ? $o - $c : 0; // Debuggin' //echo "
Tag: {$tag}\nOpen: {$o}\nClose: {$c}\nOT: {$open[$tag]}\nCT: {$close[$tag]}