From 9870dac30de1b8d1bdeab57af3eeb7c89b21ef76 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Sat, 14 Apr 2012 02:35:52 -0400
Subject: [PATCH] - Make some methods public (#1488428)
---
program/include/html.php | 363 ++++++++++++++++++++++++++++++++++++++++-----------
1 files changed, 282 insertions(+), 81 deletions(-)
diff --git a/program/include/html.php b/program/include/html.php
index 87c9c17..305a397 100644
--- a/program/include/html.php
+++ b/program/include/html.php
@@ -4,9 +4,12 @@
+-----------------------------------------------------------------------+
| program/include/html.php |
| |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2005-2008, RoundCube Dev, - Switzerland |
- | Licensed under the GNU GPL |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2005-2011, The Roundcube Dev Team |
+ | |
+ | Licensed under the GNU General Public License version 3 or |
+ | any later version with exceptions for skins & plugins. |
+ | See the README file for a full license statement. |
| |
| PURPOSE: |
| Helper class to create valid XHTML code |
@@ -15,7 +18,7 @@
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
- $Id: $
+ $Id$
*/
@@ -32,14 +35,15 @@
protected $allowed = array();
protected $content;
- public static $common_attrib = array('id','class','style','title','align');
- public static $containers = array('div','span','p','h1','h2','h3','form','textarea','table','tr','th','td','style');
+ public static $doctype = 'xhtml';
public static $lc_tags = true;
+ public static $common_attrib = array('id','class','style','title','align');
+ public static $containers = array('iframe','div','span','p','h1','h2','h3','form','textarea','table','thead','tbody','tr','th','td','style','script');
/**
* Constructor
*
- * @param array Hash array with tag attributes
+ * @param array $attrib Hash array with tag attributes
*/
public function __construct($attrib = array())
{
@@ -63,33 +67,56 @@
/**
* Generic method to create a HTML tag
*
- * @param string Tag name
- * @param array Tag attributes as key/value pairs
- * @param string Optinal Tag content (creates a container tag)
- * @param array List with allowed attributes, omit to allow all
+ * @param string $tagname Tag name
+ * @param array $attrib Tag attributes as key/value pairs
+ * @param string $content Optinal Tag content (creates a container tag)
+ * @param array $allowed_attrib List with allowed attributes, omit to allow all
* @return string The XHTML tag
*/
public static function tag($tagname, $attrib = array(), $content = null, $allowed_attrib = null)
{
+ if (is_string($attrib))
+ $attrib = array('class' => $attrib);
+
$inline_tags = array('a','span','img');
$suffix = $attrib['nl'] || ($content && $attrib['nl'] !== false && !in_array($tagname, $inline_tags)) ? "\n" : '';
$tagname = self::$lc_tags ? strtolower($tagname) : $tagname;
- if ($content || in_array($tagname, self::$containers)) {
- $templ = $attrib['noclose'] ? "<%s%s>%s" : "<%s%s>%s</%s>%s";
- unset($attrib['noclose']);
- return sprintf($templ, $tagname, self::attrib_string($attrib, $allowed_attrib), $content, $tagname, $suffix);
+ if (isset($content) || in_array($tagname, self::$containers)) {
+ $suffix = $attrib['noclose'] ? $suffix : '</' . $tagname . '>' . $suffix;
+ unset($attrib['noclose'], $attrib['nl']);
+ return '<' . $tagname . self::attrib_string($attrib, $allowed_attrib) . '>' . $content . $suffix;
}
else {
- return sprintf("<%s%s />%s", $tagname, self::attrib_string($attrib, $allowed_attrib), $suffix);
+ return '<' . $tagname . self::attrib_string($attrib, $allowed_attrib) . '>' . $suffix;
}
+ }
+
+ /**
+ *
+ */
+ public static function doctype($type)
+ {
+ $doctypes = array(
+ 'html5' => '<!DOCTYPE html>',
+ 'xhtml' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
+ 'xhtml-trans' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
+ 'xhtml-strict' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">',
+ );
+
+ if ($doctypes[$type]) {
+ self::$doctype = preg_replace('/-\w+$/', '', $type);
+ return $doctypes[$type];
+ }
+
+ return '';
}
/**
* Derrived method for <div> containers
*
- * @param mixed Hash array with tag attributes or string with class name
- * @param string Div content
+ * @param mixed $attr Hash array with tag attributes or string with class name
+ * @param string $cont Div content
* @return string HTML code
* @see html::tag()
*/
@@ -104,8 +131,8 @@
/**
* Derrived method for <p> blocks
*
- * @param mixed Hash array with tag attributes or string with class name
- * @param string Paragraph content
+ * @param mixed $attr Hash array with tag attributes or string with class name
+ * @param string $cont Paragraph content
* @return string HTML code
* @see html::tag()
*/
@@ -120,7 +147,7 @@
/**
* Derrived method to create <img />
*
- * @param mixed Hash array with tag attributes or string with image source (src)
+ * @param mixed $attr Hash array with tag attributes or string with image source (src)
* @return string HTML code
* @see html::tag()
*/
@@ -129,14 +156,15 @@
if (is_string($attr)) {
$attr = array('src' => $attr);
}
- return self::tag('img', $attr + array('alt' => ''), null, array_merge(self::$common_attrib, array('src','alt','width','height','border','usemap')));
+ return self::tag('img', $attr + array('alt' => ''), null, array_merge(self::$common_attrib,
+ array('src','alt','width','height','border','usemap','onclick')));
}
/**
* Derrived method for link tags
*
- * @param mixed Hash array with tag attributes or string with link location (href)
- * @param string Link content
+ * @param mixed $attr Hash array with tag attributes or string with link location (href)
+ * @param string $cont Link content
* @return string HTML code
* @see html::tag()
*/
@@ -145,14 +173,15 @@
if (is_string($attr)) {
$attr = array('href' => $attr);
}
- return self::tag('a', $attr, $cont, array_merge(self::$common_attrib, array('href','target','name','onclick','onmouseover','onmouseout','onmousedown','onmouseup')));
+ return self::tag('a', $attr, $cont, array_merge(self::$common_attrib,
+ array('href','target','name','rel','onclick','onmouseover','onmouseout','onmousedown','onmouseup')));
}
/**
* Derrived method for inline span tags
*
- * @param mixed Hash array with tag attributes or string with class name
- * @param string Tag content
+ * @param mixed $attr Hash array with tag attributes or string with class name
+ * @param string $cont Tag content
* @return string HTML code
* @see html::tag()
*/
@@ -167,8 +196,8 @@
/**
* Derrived method for form element labels
*
- * @param mixed Hash array with tag attributes or string with 'for' attrib
- * @param string Tag content
+ * @param mixed $attr Hash array with tag attributes or string with 'for' attrib
+ * @param string $cont Tag content
* @return string HTML code
* @see html::tag()
*/
@@ -178,6 +207,46 @@
$attr = array('for' => $attr);
}
return self::tag('label', $attr, $cont, array_merge(self::$common_attrib, array('for')));
+ }
+
+ /**
+ * Derrived method to create <iframe></iframe>
+ *
+ * @param mixed $attr Hash array with tag attributes or string with frame source (src)
+ * @return string HTML code
+ * @see html::tag()
+ */
+ public static function iframe($attr = null, $cont = null)
+ {
+ if (is_string($attr)) {
+ $attr = array('src' => $attr);
+ }
+ return self::tag('iframe', $attr, $cont, array_merge(self::$common_attrib,
+ array('src','name','width','height','border','frameborder')));
+ }
+
+ /**
+ * Derrived method to create <script> tags
+ *
+ * @param mixed $attr Hash array with tag attributes or string with script source (src)
+ * @param string $cont Javascript code to be placed as tag content
+ * @return string HTML code
+ * @see html::tag()
+ */
+ public static function script($attr, $cont = null)
+ {
+ if (is_string($attr)) {
+ $attr = array('src' => $attr);
+ }
+ if ($cont) {
+ if (self::$doctype == 'xhtml')
+ $cont = "\n/* <![CDATA[ */\n" . $cont . "\n/* ]]> */\n";
+ else
+ $cont = "\n" . $cont . "\n";
+ }
+
+ return self::tag('script', $attr + array('type' => 'text/javascript', 'nl' => true),
+ $cont, array_merge(self::$common_attrib, array('src','type','charset')));
}
/**
@@ -194,8 +263,8 @@
/**
* Create string with attributes
*
- * @param array Associative arry with tag attributes
- * @param array List of allowed attributes
+ * @param array $attrib Associative arry with tag attributes
+ * @param array $allowed List of allowed attributes
* @return string Valid attribute string
*/
public static function attrib_string($attrib = array(), $allowed = null)
@@ -208,7 +277,7 @@
$attrib_arr = array();
foreach ($attrib as $key => $value) {
// skip size if not numeric
- if (($key=='size' && !is_numeric($value))) {
+ if ($key == 'size' && !is_numeric($value)) {
continue;
}
@@ -225,19 +294,59 @@
// attributes with no value
if (in_array($key, array('checked', 'multiple', 'disabled', 'selected'))) {
if ($value) {
- $attrib_arr[] = sprintf('%s="%s"', $key, $key);
+ $attrib_arr[] = $key . '="' . $key . '"';
}
}
- else if ($key=='value') {
- $attrib_arr[] = sprintf('%s="%s"', $key, Q($value, 'strict', false));
- }
else {
- $attrib_arr[] = sprintf('%s="%s"', $key, Q($value));
+ $attrib_arr[] = $key . '="' . self::quote($value) . '"';
}
}
+
return count($attrib_arr) ? ' '.implode(' ', $attrib_arr) : '';
}
+
+ /**
+ * Convert a HTML attribute string attributes to an associative array (name => value)
+ *
+ * @param string Input string
+ * @return array Key-value pairs of parsed attributes
+ */
+ public static function parse_attrib_string($str)
+ {
+ $attrib = array();
+ $regexp = '/\s*([-_a-z]+)=(["\'])??(?(2)([^\2]*)\2|(\S+?))/Ui';
+
+ preg_match_all($regexp, stripslashes($str), $regs, PREG_SET_ORDER);
+
+ // convert attributes to an associative array (name => value)
+ if ($regs) {
+ foreach ($regs as $attr) {
+ $attrib[strtolower($attr[1])] = html_entity_decode($attr[3] . $attr[4]);
+ }
+ }
+
+ return $attrib;
+ }
+
+ /**
+ * Replacing specials characters in html attribute value
+ *
+ * @param string $str Input string
+ *
+ * @return string The quoted string
+ */
+ public static function quote($str)
+ {
+ $str = htmlspecialchars($str, ENT_COMPAT, RCMAIL_CHARSET);
+
+ // avoid douple quotation of &
+ // @TODO: get rid of it?
+ $str = preg_replace('/&([A-Za-z]{2,6}|#[0-9]{2,4});/', '&\\1;', $str);
+
+ return $str;
+ }
}
+
/**
* Class to create an HTML input field
@@ -248,8 +357,17 @@
{
protected $tagname = 'input';
protected $type = 'text';
- protected $allowed = array('type','name','value','size','tabindex','autocomplete','checked','onchange','onclick','disabled','readonly');
+ protected $allowed = array(
+ 'type','name','value','size','tabindex',
+ 'autocomplete','checked','onchange','onclick','disabled','readonly',
+ 'spellcheck','results','maxlength','src','multiple','placeholder',
+ );
+ /**
+ * Object constructor
+ *
+ * @param array $attrib Associative array with tag attributes
+ */
public function __construct($attrib = array())
{
if (is_array($attrib)) {
@@ -259,17 +377,13 @@
if ($attrib['type']) {
$this->type = $attrib['type'];
}
-
- if ($attrib['newline']) {
- $this->newline = true;
- }
}
/**
* Compose input tag
*
- * @param string Field value
- * @param array Additional attributes to override
+ * @param string $value Field value
+ * @param array $attrib Additional attributes to override
* @return string HTML output
*/
public function show($value = null, $attrib = null)
@@ -305,16 +419,17 @@
* @package HTML
*/
-class html_hiddenfield extends html_inputfield
+class html_hiddenfield extends html
{
+ protected $tagname = 'input';
protected $type = 'hidden';
protected $fields_arr = array();
- protected $newline = true;
+ protected $allowed = array('type','name','value','onchange','disabled','readonly');
/**
* Constructor
*
- * @param array Named tag attributes
+ * @param array $attrib Named tag attributes
*/
public function __construct($attrib = null)
{
@@ -326,7 +441,7 @@
/**
* Add a hidden field to this instance
*
- * @param array Named tag attributes
+ * @param array $attrib Named tag attributes
*/
public function add($attrib)
{
@@ -360,8 +475,8 @@
/**
* Get HTML code for this object
*
- * @param string Value of the checked field
- * @param array Additional attributes to override
+ * @param string $value Value of the checked field
+ * @param array $attrib Additional attributes to override
* @return string HTML output
*/
public function show($value = '', $attrib = null)
@@ -390,8 +505,8 @@
/**
* Get HTML code for this object
*
- * @param string Value of the checked field
- * @param array Additional attributes to override
+ * @param string $value Value of the checked field
+ * @param array $attrib Additional attributes to override
* @return string HTML output
*/
public function show($value = '', $attrib = null)
@@ -416,13 +531,14 @@
class html_textarea extends html
{
protected $tagname = 'textarea';
- protected $allowed = array('name','rows','cols','wrap','tabindex','onchange','disabled','readonly');
+ protected $allowed = array('name','rows','cols','wrap','tabindex',
+ 'onchange','disabled','readonly','spellcheck');
/**
* Get HTML code for this object
*
- * @param string Textbox value
- * @param array Additional attributes to override
+ * @param string $value Textbox value
+ * @param array $attrib Additional attributes to override
* @return string HTML output
*/
public function show($value = '', $attrib = null)
@@ -442,11 +558,12 @@
unset($this->attrib['value']);
}
- if (!empty($value) && !ereg('mce_editor', $this->attrib['class'])) {
- $value = Q($value, 'strict', false);
+ if (!empty($value) && !preg_match('/mce_editor/', $this->attrib['class'])) {
+ $value = self::quote($value);
}
- return self::tag($this->tagname, $this->attrib, $value, array_merge(self::$common_attrib, $this->allowed));
+ return self::tag($this->tagname, $this->attrib, $value,
+ array_merge(self::$common_attrib, $this->allowed));
}
}
@@ -473,13 +590,14 @@
{
protected $tagname = 'select';
protected $options = array();
- protected $allowed = array('name','size','tabindex','autocomplete','multiple','onchange','disabled');
-
+ protected $allowed = array('name','size','tabindex','autocomplete',
+ 'multiple','onchange','disabled','rel');
+
/**
* Add a new option to this drop-down
*
- * @param mixed Option name or array with option names
- * @param mixed Option value or array with option values
+ * @param mixed $names Option name or array with option names
+ * @param mixed $values Option value or array with option values
*/
public function add($names, $values = null)
{
@@ -493,12 +611,11 @@
}
}
-
/**
* Get HTML code for this object
*
- * @param string Value of the selection option
- * @param array Additional attributes to override
+ * @param string $select Value of the selection option
+ * @param array $attrib Additional attributes to override
* @return string HTML output
*/
public function show($select = array(), $attrib = null)
@@ -516,8 +633,9 @@
'selected' => (in_array($option['value'], $select, true) ||
in_array($option['text'], $select, true)) ? 1 : null);
- $this->content .= self::tag('option', $attr, Q($option['text']));
+ $this->content .= self::tag('option', $attr, self::quote($option['text']));
}
+
return parent::show();
}
}
@@ -531,23 +649,30 @@
class html_table extends html
{
protected $tagname = 'table';
- protected $allowed = array('id','class','style','width','summary','cellpadding','cellspacing','border');
+ protected $allowed = array('id','class','style','width','summary',
+ 'cellpadding','cellspacing','border');
+
private $header = array();
private $rows = array();
private $rowindex = 0;
private $colindex = 0;
-
+ /**
+ * Constructor
+ *
+ * @param array $attrib Named tag attributes
+ */
public function __construct($attrib = array())
{
- $this->attrib = array_merge($attrib, array('summary' => '', 'border' => 0));
+ $default_attrib = self::$doctype == 'xhtml' ? array('summary' => '', 'border' => 0) : array();
+ $this->attrib = array_merge($attrib, $default_attrib);
}
/**
* Add a table cell
*
- * @param array Cell attributes
- * @param string Cell content
+ * @param array $attr Cell attributes
+ * @param string $cont Cell content
*/
public function add($attr, $cont)
{
@@ -570,13 +695,13 @@
/**
* Add a table header cell
*
- * @param array Cell attributes
- * @param string Cell content
+ * @param array $attr Cell attributes
+ * @param string $cont Cell content
*/
public function add_header($attr, $cont)
{
if (is_string($attr))
- $attr = array('class' => $attr);
+ $attr = array('class' => $attr);
$cell = new stdClass;
$cell->attrib = $attr;
@@ -584,10 +709,37 @@
$this->header[] = $cell;
}
+ /**
+ * Remove a column from a table
+ * Useful for plugins making alterations
+ *
+ * @param string $class
+ */
+ public function remove_column($class)
+ {
+ // Remove the header
+ foreach ($this->header as $index=>$header){
+ if ($header->attrib['class'] == $class){
+ unset($this->header[$index]);
+ break;
+ }
+ }
+
+ // Remove cells from rows
+ foreach ($this->rows as $i=>$row){
+ foreach ($row->cells as $j=>$cell){
+ if ($cell->attrib['class'] == $class){
+ unset($this->rows[$i]->cells[$j]);
+ break;
+ }
+ }
+ }
+ }
+
/**
* Jump to next row
*
- * @param array Row attributes
+ * @param array $attr Row attributes
*/
public function add_row($attr = array())
{
@@ -598,18 +750,49 @@
$this->rows[$this->rowindex]->cells = array();
}
+ /**
+ * Set row attributes
+ *
+ * @param array $attr Row attributes
+ * @param int $index Optional row index (default current row index)
+ */
+ public function set_row_attribs($attr = array(), $index = null)
+ {
+ if (is_string($attr))
+ $attr = array('class' => $attr);
+
+ if ($index === null)
+ $index = $this->rowindex;
+
+ $this->rows[$index]->attrib = $attr;
+ }
+
+ /**
+ * Get row attributes
+ *
+ * @param int $index Row index
+ *
+ * @return array Row attributes
+ */
+ public function get_row_attribs($index = null)
+ {
+ if ($index === null)
+ $index = $this->rowindex;
+
+ return $this->rows[$index] ? $this->rows[$index]->attrib : null;
+ }
/**
* Build HTML output of the table data
*
- * @param array Table attributes
+ * @param array $attrib Table attributes
* @return string The final table HTML code
*/
public function show($attrib = null)
{
if (is_array($attrib))
$this->attrib = array_merge($this->attrib, $attrib);
-
+
$thead = $tbody = "";
// include <thead>
@@ -618,7 +801,7 @@
foreach ($this->header as $c => $col) {
$rowcontent .= self::tag('td', $col->attrib, $col->content);
}
- $thead = self::tag('thead', null, self::tag('tr', null, $rowcontent));
+ $thead = self::tag('thead', null, self::tag('tr', null, $rowcontent, parent::$common_attrib));
}
foreach ($this->rows as $r => $row) {
@@ -628,7 +811,7 @@
}
if ($r < $this->rowindex || count($row->cells)) {
- $tbody .= self::tag('tr', $row->attrib, $rowcontent);
+ $tbody .= self::tag('tr', $row->attrib, $rowcontent, parent::$common_attrib);
}
}
@@ -642,6 +825,24 @@
unset($this->attrib['cols'], $this->attrib['rowsonly']);
return parent::show();
}
-}
-?>
+ /**
+ * Count number of rows
+ *
+ * @return The number of rows
+ */
+ public function size()
+ {
+ return count($this->rows);
+ }
+
+ /**
+ * Remove table body (all rows)
+ */
+ public function remove_body()
+ {
+ $this->rows = array();
+ $this->rowindex = 0;
+ }
+
+}
--
Gitblit v1.9.1