*
* -------------------------------------------- *
* 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. *
\**************************************************************************/
/* $Id$ */
/**
* generates html with methods representing html-tags or higher widgets
*
* @package api
* @subpackage html
* @author RalfBecker-AT-outdoor-training.de
* @license GPL
*/
class html
{
/**
* user-agent: 'mozilla','msie','konqueror', 'safari', 'opera'
* @var string
*/
var $user_agent;
/**
* version of user-agent as specified by browser
* @var string
*/
var $ua_version;
/**
* what attribute to use for the title of an image: 'title' for everything but netscape4='alt'
* @var string
*/
var $prefered_img_title;
/**
* charset used by the page, as returned by $GLOBALS['phpgw']->translation->charset()
* @var string
*/
var $charset;
/**
* URL (NOT path) of the js directory in the api
* @var string
*/
var $phpgwapi_js_url;
/**
* do we need to set the wz_tooltip class, to be included at the end of the page
* @var boolean
*/
var $wz_tooltip_included = False;
/**
* Constructor: initialised the class-vars
*/
function html()
{
// should be Ok for all HTML 4 compatible browsers
if (!eregi('(Safari)/([0-9.]+)',$_SERVER['HTTP_USER_AGENT'],$parts) &&
!eregi('compatible; ([a-z_]+)[/ ]+([0-9.]+)',$_SERVER['HTTP_USER_AGENT'],$parts))
{
eregi('^([a-z_]+)/([0-9.]+)',$_SERVER['HTTP_USER_AGENT'],$parts);
}
list(,$this->user_agent,$this->ua_version) = $parts;
$this->user_agent = strtolower($this->user_agent);
$this->netscape4 = $this->user_agent == 'mozilla' && $this->ua_version < 5;
$this->prefered_img_title = $this->netscape4 ? 'alt' : 'title';
//echo "
\n";
if ($GLOBALS['phpgw']->translation)
{
$this->charset = $GLOBALS['phpgw']->translation->charset();
}
$this->phpgwapi_js_url = $GLOBALS['phpgw_info']['server']['webserver_url'].'/phpgwapi/js';
}
/**
* Created an input-field with an attached color-picker
*
* Please note: it need to be called before the call to phpgw_header() !!!
*
* @param string $name the name of the input-field
* @param string $value the actual value for the input-field, default ''
* @param string $title tooltip/title for the picker-activation-icon
* @return string the html
*/
function inputColor($name,$value='',$title='')
{
$id = str_replace(array('[',']'),array('_',''),$name).'_colorpicker';
$onclick = "javascript:window.open('".$this->phpgwapi_js_url.'/colorpicker/select_color.html?id='.urlencode($id)."&color='+document.getElementById('$id').value,'colorPicker','width=240,height=187,scrollbars=no,resizable=no,toolbar=no');";
return ' '.
''.
'";
}
/**
* Handles tooltips via the wz_tooltip class from Walter Zorn
*
* Note: The wz_tooltip.js file gets automaticaly loaded at the end of the page
*
* @param string/boolean $text text or html for the tooltip, all chars allowed, they will be quoted approperiate
* Or if False the content (innerHTML) of the element itself is used.
* @param boolean $do_lang (default False) should the text be run though lang()
* @param array $options param/value pairs, eg. 'TITLE' => 'I am the title'. Some common parameters:
* title (string) gives extra title-row, width (int,'auto') , padding (int), above (bool), bgcolor (color), bgimg (URL)
* For a complete list and description see http://www.walterzorn.com/tooltip/tooltip_e.htm
* @return string to be included in any tag, like 'tooltip('Hello Ralf').'>Text with tooltip'
*/
function tooltip($text,$do_lang=False,$options=False)
{
if (!$this->wz_tooltip_included)
{
if (!strstr('wz_tooltip',$GLOBALS['phpgw_info']['flags']['need_footer']))
{
$GLOBALS['phpgw_info']['flags']['need_footer'] .= ''."\n";
}
$this->wz_tooltip_included = True;
}
if ($do_lang) $text = lang($text);
$opt_out = 'this.T_WIDTH = 200;';
if (is_array($options))
{
foreach($options as $option => $value)
{
$opt_out .= 'this.T_'.strtoupper($option).'='.(is_numeric($value)?$value:"'".str_replace(array("'",'"'),array("\\'",'"'),$value)."'").'; ';
}
}
if ($text === False) return ' onmouseover="'.$opt_out.'return escape(this.innerHTML);"';
return ' onmouseover="'.$opt_out.'return escape(\''.str_replace(array("\n","\r","'",'"'),array('','',"\\'",'"'),$text).'\')"';
}
/**
* activates URLs in a text, URLs get replaced by html-links
*
* @param string $content text containing URLs
* @return string html with activated links
*/
function activate_links($content)
{
// Exclude everything which is already a link
$NotAnchor = '(?\\1 AT \\2 DOT \\3',
$content);
// First match things beginning with http:// (or other protocols)
$Protocol = '(http|ftp|https):\/\/';
$Domain = '([\w]+.[\w]+)';
$Subdir = '([\w\-\.,@?^=%&;:\/~\+#]*[\w\-\@?^=%&\/~\+#])?';
$Expr = '/' . $NotAnchor . $Protocol . $Domain . $Subdir . '/i';
$result = preg_replace( $Expr, "$2$3", $result );
// Now match things beginning with www.
$NotHTTP = '(?$0", $result );
}
/**
* escapes chars with special meaning in html as entities
*
* Allows to use and char in the html-output and prefents XSS attacks.
* Some entities are allowed and get NOT escaped:
* - &# some translations (AFAIK the arabic ones) need this
* - < > for convinience
*
* @param string $str string to escape
* @return string
*/
function htmlspecialchars($str)
{
// add @ by lkneschke to supress warning about unknown charset
$str = @htmlspecialchars($str,ENT_COMPAT,$this->charset);
// we need '&#' unchanged, so we translate it back
$str = str_replace(array('&#',' ','<','>'),array('&#',' ','<','>'),$str);
return $str;
}
/**
* allows to show and select one item from an array
*
* @param string $name string with name of the submitted var which holds the key of the selected item form array
* @param string/array $key key(s) of already selected item(s) from $arr, eg. '1' or '1,2' or array with keys
* @param array $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
* @param boolean $no_lang NOT run the labels of the options through lang(), default false=use lang()
* @param string $options additional options (e.g. 'width')
* @param int $multiple number of lines for a multiselect, default 0 = no multiselect
* @return string to set for a template or to echo into html page
*/
function select($name, $key, $arr=0,$no_lang=false,$options='',$multiple=0)
{
if (!is_array($arr))
{
$arr = array('no','yes');
}
if ((int)$multiple > 0)
{
$options .= ' multiple="1" size="'.(int)$multiple.'"';
if (substr($name,-2) != '[]')
{
$name .= '[]';
}
}
$out = "\n";
return $out;
}
/**
* emulating a multiselectbox using checkboxes
*
* Unfortunaly this is not in all aspects like a multi-selectbox, eg. you cant select options via javascript
* in the same way. Therefor I made it an extra function.
*
* @param string $name string with name of the submitted var which holds the key of the selected item form array
* @param string/array $key key(s) of already selected item(s) from $arr, eg. '1' or '1,2' or array with keys
* @param array $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
* @param boolean $no_lang NOT run the labels of the options through lang(), default false=use lang()
* @param string $options additional options (e.g. 'width')
* @param int $multiple number of lines for a multiselect, default 3
* @param boolean $selected_first show the selected items before the not selected ones, default true
* @return string to set for a template or to echo into html page
*/
function checkbox_multiselect($name, $key, $arr=0,$no_lang=false,$options='',$multiple=3,$selected_first=true)
{
if (!is_array($arr))
{
$arr = array('no','yes');
}
if ((int)$multiple <= 0) $multiple = 1;
if (substr($name,-2) != '[]')
{
$name .= '[]';
}
$base_name = substr($name,0,-2);
if (!is_array($key))
{
// explode on ',' only if multiple values expected and the key contains just numbers and commas
$key = preg_match('/^[,0-9]+$/',$key) ? explode(',',$key) : array($key);
}
$html = '';
$options_no_id = preg_replace('/id="[^"]+"/i','',$options);
if ($selected_first)
{
$selected = $not_selected = array();
foreach($arr as $val => $label)
{
if (in_array($val,$key,!$val))
{
$selected[$val] = $label;
}
else
{
$not_selected[$val] = $label;
}
}
$arr = $selected + $not_selected;
}
foreach($arr as $val => $label)
{
if (is_array($label))
{
$title = $label['title'];
$label = $label['label'];
}
else
{
$title = '';
}
if ($label && !$no_lang) $label = lang($label);
if ($title && !$no_lang) $title = lang($title);
if (strlen($label) > $max_len) $max_len = strlen($label);
$html .= $this->label($this->checkbox($name,in_array($val,$key),$val,$options_no_id.
' id="'.$base_name.'['.$val.']'.'" '.($title ? 'title="'.$this->htmlspecialchars($title).'" ':'')).
$this->htmlspecialchars($label),$base_name.'['.$val.']')." \n";
}
$style = 'height: '.(1.7*$multiple).'em; width: '.(4+$max_len*($max_len < 15 ? 0.65 : 0.50)).'em; background-color: white; overflow: auto; border: lightgray 2px inset;';
return $this->div($html,$options,'',$style);
}
/**
* generates an option-tag for a selectbox
*
* @param string $value value
* @param string $label label
* @param mixed $selected value or array of values of options to mark as selected
* @param boolean $no_lang NOT running the label through lang(), default false=use lang()
* @return string html
*/
function select_option($value,$label,$selected,$no_lang=0,$title='')
{
// the following compares strict as strings, to archive: '0' == 0 != ''
// the first non-strict search via array_search, is for performance reasons, to not always search the whole array with php
if (($found = ($key = array_search($value,$selected)) !== false) && !$value)
{
if ((string) $value !== (string) $selected[$key])
{
$found = false;
foreach($selected as $sel)
{
if ($found = ((string) $value === (string) $selected[$key])) break;
}
}
}
return '\n";
}
/**
* generates a div-tag
*
* @param string $content of a div, or '' to generate only the opening tag
* @param string $options to include in the tag, default ''=none
* @param string $class css-class attribute, default ''=none
* @param string $style css-styles attribute, default ''=none
* @return string html
*/
function div($content,$options='',$class='',$style='')
{
if ($class) $options .= ' class="'.$class.'"';
if ($style) $options .= ' style="'.$style.'"';
return "
\n".($content ? "$content
\n" : '');
}
/**
* generate one or more hidden input tag(s)
*
* @param array/string $vars var-name or array with name / value pairs
* @param string $value value if $vars is no array, default ''
* @param boolean $ignore_empty if true all empty, zero (!) or unset values, plus filer=none
* @param string html
*/
function input_hidden($vars,$value='',$ignore_empty=True)
{
if (!is_array($vars))
{
$vars = array( $vars => $value );
}
foreach($vars as $name => $value)
{
if (is_array($value))
{
$value = serialize($value);
}
if (!$ignore_empty || $value && !($name == 'filter' && $value == 'none')) // dont need to send all the empty vars
{
$html .= "htmlspecialchars($value)."\" />\n";
}
}
return $html;
}
/**
* generate a textarea tag
*
* @param string $name name attr. of the tag
* @param string $value default
* @param boolean $ignore_empty if true all empty, zero (!) or unset values, plus filer=none
* @param string html
*/
function textarea($name,$value='',$options='' )
{
return "\n";
}
/**
* Checks if HTMLarea (or an other richtext editor) is availible for the used browser
*
* @return boolean
*/
function htmlarea_availible()
{
switch($this->user_agent)
{
case 'msie':
return $this->ua_version >= 5.5;
case 'mozilla':
return $this->ua_version >= 1.3;
default:
return False;
}
}
/**
* compability function for former used htmlarea. Please use function tinymce now!
*
* creates a textarea inputfield for the htmlarea js-widget (returns the necessary html and js)
*/
function htmlarea($name,$content='',$style='',$base_href='',$plugins='',$custom_toolbar='',$set_width_height_in_config=false)
{
return $this->tinymce($name,$content,$style,$plugins,$base_href);
}
/**
* init the tinymce js-widget by adding the js file in the head of the page
*
* Please note: it need to be called before the call to phpgw_header() !!!
*
*/
function init_tinymce()
{
/* do stuff once */
if (!is_object($GLOBALS['phpgw']->js))
{
$GLOBALS['phpgw']->js = CreateObject('phpgwapi.javascript');
}
if (!strstr($GLOBALS['phpgw_info']['flags']['java_script'],'tinyMCE'))
{
$GLOBALS['phpgw']->js->validate_file('tinymce','jscripts/tiny_mce/tiny_mce');
}
}
/**
* creates a textarea inputfield for the tinymce js-widget (returns the necessary html and js)
*
* Please note: if you did not run init_tinymce already you this function need to be called before the call to phpgw_header() !!!
*
* @param string $name name and id of the input-field
* @param string $content='' of the tinymce (will be run through htmlspecialchars !!!), default ''
* @param string $style='' initial css for the style attribute
* @param string $init_options='', see http://tinymce.moxiecode.com/ for all init options. mode and elements are allready set.
* to make things more easy, you also can just provide a comma seperated list here with the options you need.
* Supportet are: 'TableOperations','ContextMenu','ColorChooser'
* @return string the necessary html for the textarea
* @todo make wrapper for backwards compatibility with htmlarea
* @todo enable all features from htmlarea
*/
function tinymce($name,$content='',$style='',$init_options='',$base_href='')
{
if (!$style)
{
$style = 'width:100%; min-width:500px; height:300px;';
}
if (!$this->htmlarea_availible())
{
return $this->textarea($name,$content,'style="'.$style.'"');
}
/* do stuff once */
$this->init_tinymce();
if(strpos($init_options,':') === false)
{
$init = 'theme : "advanced", theme_advanced_toolbar_location : "top", theme_advanced_toolbar_align : "left"';
$tab1a = 'theme_advanced_buttons1_add : "';
$tab2a = 'theme_advanced_buttons2_add : "';
$tab3a = 'theme_advanced_buttons3_add : "separator,fullscreen';
$plugs = 'plugins : "paste,fullscreen,advimage,advlink';
$eve = 'extended_valid_elements : "a[name|href|target|title|onclick], img[class|src|border=0|alt|title|hspace|vspace|width|height|align|onmouseover|onmouseout|name],font[*]';
if($init_options)
{
foreach(explode(',',$init_options) as $plugin)
{
switch($plugin)
{
case 'TableOperations' :
$plugs .= ',table';
$tab3a .= ',separator,tablecontrols';
break;
case 'ContextMenu' :
$plugs .= ',contextmenu';
break;
case 'ColorChooser' :
$tab3a .= ',separator,forecolor,backcolor';
break;
case 'FontChooser' :
$tab1a .= ',fontselect,fontsizeselect';
$init .= ',theme_advanced_disable : "styleselect"';
break;
case 'FileManager' :
$plugs .= ',filemanager';
$tab3a .= ',separator,filemanager';
break;
case 'SearchReplace' :
$plugs .= ',searchreplace';
$tab1a .= ',separator,search,replace';
break;
case 'InsertDateTime' :
$plugs .= ',insertdatetime';
$tab2a .= ',separator,insertdate,inserttime';
break;
default:
// echo $plugin .' ';
}
}
}
if($base_href)
{
$init .= ',document_base_url : "'. $base_href. '", relative_urls : true';
}
$init_options = $init. ','. $tab1a. '",'. $tab2a. '",'. $tab3a. '",'. $plugs. '",'. $eve. '"';
}
/* do again and again */
return '
';
}
/**
* represents html's input tag
*
* @param string $name name
* @param string $value default value of the field
* @param string $type type, default ''=not specified = text
* @param string $options attributes for the tag, default ''=none
*/
function input($name,$value='',$type='',$options='' )
{
if ($type)
{
$type = 'type="'.$type.'"';
}
return "htmlspecialchars($value)."\" $options />\n";
}
/**
* represents html's button (input type submit or image)
*
* @param string $name name
* @param string $label label of the button
* @param string $onClick javascript to call, when button is clicked
* @param boolean $no_lang NOT running the label through lang(), default false=use lang()
* @param string $options attributes for the tag, default ''=none
* @param string $image to show instead of the label, default ''=none
* @param string $app app to search the image in
* @return string html
*/
function submit_button($name,$label,$onClick='',$no_lang=false,$options='',$image='',$app='phpgwapi')
{
// workaround for idots and IE button problem (wrong cursor-image)
if ($this->user_agent == 'msie')
{
$options .= ' style="cursor: pointer; cursor: hand;"';
}
if ($image != '')
{
$image = str_replace(array('.gif','.GIF','.png','.PNG'),'',$image);
if (!($path = $GLOBALS['phpgw']->common->image($app,$image)))
{
$path = $image; // name may already contain absolut path
}
$image = ' src="'.$path.'"';
}
if (!$no_lang)
{
$label = lang($label);
}
if (($accesskey = strstr($label,'&')) && $accesskey[1] != ' ' &&
(($pos = strpos($accesskey,';')) === False || $pos > 5))
{
$label_u = str_replace('&'.$accesskey[1],''.$accesskey[1].'',$label);
$label = str_replace('&','',$label);
$options = 'accesskey="'.$accesskey[1].'" '.$options;
}
else
{
$accesskey = '';
$label_u = $label;
}
if ($onClick) $options .= ' onclick="'.str_replace('"','\\"',$onClick).'"';
// ';
}
/**
* creates an absolut link + the query / get-variables
*
* Example link('/index.php?menuaction=infolog.uiinfolog.get_list',array('info_id' => 123))
* gives 'http://domain/phpgw-path/index.php?menuaction=infolog.uiinfolog.get_list&info_id=123'
*
* @param string $url phpgw-relative link, may include query / get-vars
* @param array/string $vars query or array ('name' => 'value', ...) with query
* @return string absolut link already run through $phpgw->link
*/
function link($url,$vars='')
{
//echo "
\n";
if (!is_array($vars))
{
parse_str($vars,$vars);
}
list($url,$v) = explode('?',$url); // url may contain additional vars
if ($v)
{
parse_str($v,$v);
$vars += $v;
}
return $GLOBALS['phpgw']->link($url,$vars);
}
/**
* represents html checkbox
*
* @param string $name name
* @param boolean $checked box checked on display
* @param string $value value the var should be set to, default 'True'
* @param string $options attributes for the tag, default ''=none
* @return string html
*/
function checkbox($name,$checked=false,$value='True',$options='')
{
return '\n";
}
/**
* represents a html form
*
* @param string $content of the form, if '' only the opening tag gets returned
* @param array $hidden_vars array with name-value pairs for hidden input fields
* @param string $url eGW relative URL, will be run through the link function, if empty the current url is used
* @param string/array $url_vars parameters for the URL, send to link function too
* @param string $name name of the form, defaul ''=none
* @param string $options attributes for the tag, default ''=none
* @param string $method method of the form, default 'POST'
* @return string html
*/
function form($content,$hidden_vars,$url,$url_vars='',$name='',$options='',$method='POST')
{
$url = $url ? $this->link($url,$url_vars) : $_SERVER['PHP_SELF'].'?'.$_SERVER['QUERY_STRING'];
$html = "\n";
}
return $html;
}
/**
* represents a html form with one button
*
* @param string $name name of the button
* @param string $label label of the button
* @param array $hidden_vars array with name-value pairs for hidden input fields
* @param string $url eGW relative URL, will be run through the link function
* @param string/array $url_vars parameters for the URL, send to link function too
* @param string $options attributes for the tag, default ''=none
* @param string $form_name name of the form, defaul ''=none
* @param string $method method of the form, default 'POST'
* @return string html
*/
function form_1button($name,$label,$hidden_vars,$url,$url_vars='',$form_name='',$method='POST')
{
return $this->form($this->submit_button($name,$label),$hidden_vars,$url,$url_vars,$form_name,'',$method);
}
/**
* creates table from array of rows
*
* abstracts the html stuff for the table creation
* Example: $rows = array (
* '1' => array(
* 1 => 'cell1', '.1' => 'colspan=3',
* 2 => 'cell2',
* 3 => 'cell3', '.3' => 'width="10%"'
* ),'.1' => 'BGCOLOR="#0000FF"' );
* table($rows,'width="100%"') = '
cell1
cell2
cell3
'
*
* @param array $rows with rows, each row is an array of the cols
* @param string $options options for the table-tag
* @param boolean $no_table_tr dont return the table- and outmost tr-tabs, default false=return table+tr
* @return string with html-code of the table
*/
function table($rows,$options = '',$no_table_tr=False)
{
$html = $no_table_tr ? '' : "
\n";
if ($no_table_tr)
{
$html = substr($html,0,-16);
}
return $html;
}
/**
* changes a selectbox to submit the form if it gets changed, to be used with the sbox-class
*
* @param string $sbox html with the select-box
* @param boolean $no_script if true generate a submit-button if javascript is off
* @return string html
*/
function sbox_submit( $sbox,$no_script=false )
{
$html = str_replace('submit_button('send','>').'';
}
return $html;
}
/**
* html-widget showing progessbar with a view div's (html4 only, textual percentage otherwise)
*
* @param mixed $percent percent-value, gets casted to int
* @param string $title title for the progressbar, default ''=the percentage itself
* @param string $options attributes for the outmost div (may include onclick="...")
* @param string $width width, default 30px
* @param string $color color, default '#D00000' (dark red)
* @param string $height height, default 5px
* @return string html
*/
function progressbar( $percent,$title='',$options='',$width='',$color='',$height='' )
{
$percent = (int) $percent;
if (!$width) $width = '30px';
if (!$height)$height= '5px';
if (!$color) $color = '#D00000';
$title = $title ? $this->htmlspecialchars($title) : $percent.'%';
if ($this->netscape4)
{
return $title;
}
return '
