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 | 214 +++++++++++++++++++++++++++++++++++++++++------------
1 files changed, 166 insertions(+), 48 deletions(-)
diff --git a/program/include/html.php b/program/include/html.php
index b73c54a..305a397 100644
--- a/program/include/html.php
+++ b/program/include/html.php
@@ -5,8 +5,11 @@
| program/include/html.php |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2005-2010, Roundcube Dev, - Switzerland |
- | Licensed under the GNU GPL |
+ | 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 |
@@ -32,6 +35,7 @@
protected $allowed = array();
protected $content;
+ 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');
@@ -71,18 +75,41 @@
*/
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 '';
}
/**
@@ -130,7 +157,7 @@
$attr = array('src' => $attr);
}
return self::tag('img', $attr + array('alt' => ''), null, array_merge(self::$common_attrib,
- array('src','alt','width','height','border','usemap')));
+ array('src','alt','width','height','border','usemap','onclick')));
}
/**
@@ -147,7 +174,7 @@
$attr = array('href' => $attr);
}
return self::tag('a', $attr, $cont, array_merge(self::$common_attrib,
- array('href','target','name','onclick','onmouseover','onmouseout','onmousedown','onmouseup')));
+ array('href','target','name','rel','onclick','onmouseover','onmouseout','onmousedown','onmouseup')));
}
/**
@@ -195,7 +222,31 @@
$attr = array('src' => $attr);
}
return self::tag('iframe', $attr, $cont, array_merge(self::$common_attrib,
- array('src','name','width','height','border','frameborder')));
+ 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')));
}
/**
@@ -226,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;
}
@@ -243,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
@@ -266,9 +357,11 @@
{
protected $tagname = 'input';
protected $type = 'text';
- protected $allowed = array('type','name','value','size','tabindex',
- 'autocomplete','checked','onchange','onclick','disabled','readonly',
- 'spellcheck','results','maxlength','src');
+ protected $allowed = array(
+ 'type','name','value','size','tabindex',
+ 'autocomplete','checked','onchange','onclick','disabled','readonly',
+ 'spellcheck','results','maxlength','src','multiple','placeholder',
+ );
/**
* Object constructor
@@ -283,10 +376,6 @@
if ($attrib['type']) {
$this->type = $attrib['type'];
- }
-
- if ($attrib['newline']) {
- $this->newline = true;
}
}
@@ -330,11 +419,12 @@
* @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
@@ -469,11 +559,11 @@
}
if (!empty($value) && !preg_match('/mce_editor/', $this->attrib['class'])) {
- $value = Q($value, 'strict', false);
+ $value = self::quote($value);
}
return self::tag($this->tagname, $this->attrib, $value,
- array_merge(self::$common_attrib, $this->allowed));
+ array_merge(self::$common_attrib, $this->allowed));
}
}
@@ -501,8 +591,8 @@
protected $tagname = 'select';
protected $options = array();
protected $allowed = array('name','size','tabindex','autocomplete',
- 'multiple','onchange','disabled');
-
+ 'multiple','onchange','disabled','rel');
+
/**
* Add a new option to this drop-down
*
@@ -520,7 +610,6 @@
$this->options[] = array('text' => $names, 'value' => $values);
}
}
-
/**
* Get HTML code for this object
@@ -544,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();
}
}
@@ -560,7 +650,7 @@
{
protected $tagname = 'table';
protected $allowed = array('id','class','style','width','summary',
- 'cellpadding','cellspacing','border');
+ 'cellpadding','cellspacing','border');
private $header = array();
private $rows = array();
@@ -574,7 +664,8 @@
*/
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);
}
/**
@@ -627,24 +718,23 @@
public function remove_column($class)
{
// Remove the header
- foreach($this->header as $index=>$header){
- if($header->attrib['class'] == $class){
+ 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){
+ 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
@@ -661,16 +751,35 @@
}
/**
- * Set current row attrib
+ * Set row attributes
*
- * @param array $attr Row attributes
+ * @param array $attr Row attributes
+ * @param int $index Optional row index (default current row index)
*/
- public function set_row_attribs($attr = array())
+ public function set_row_attribs($attr = array(), $index = null)
{
if (is_string($attr))
$attr = array('class' => $attr);
- $this->rows[$this->rowindex]->attrib = $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;
}
/**
@@ -683,7 +792,7 @@
{
if (is_array($attrib))
$this->attrib = array_merge($this->attrib, $attrib);
-
+
$thead = $tbody = "";
// include <thead>
@@ -692,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) {
@@ -702,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);
}
}
@@ -716,7 +825,7 @@
unset($this->attrib['cols'], $this->attrib['rowsonly']);
return parent::show();
}
-
+
/**
* Count number of rows
*
@@ -726,5 +835,14 @@
{
return count($this->rows);
}
-}
+ /**
+ * Remove table body (all rows)
+ */
+ public function remove_body()
+ {
+ $this->rows = array();
+ $this->rowindex = 0;
+ }
+
+}
--
Gitblit v1.9.1