2 # Copyright (C) 2009 Aryeh Gregor
3 # http://www.mediawiki.org/
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 # http://www.gnu.org/copyleft/gpl.html
21 * This class is a collection of static functions that serve two purposes:
23 * 1) Implement any algorithms specified by HTML 5, or other HTML
24 * specifications, in a convenient and self-contained way.
26 * 2) Allow HTML elements to be conveniently and safely generated, like the
27 * current Xml class but a) less confused (Xml supports HTML-specific things,
28 * but only sometimes!) and b) not necessarily confined to XML-compatible
31 * There are two important configuration options this class uses:
33 * $wgHtml5: If this is set to false, then all output should be valid XHTML 1.0
35 * $wgWellFormedXml: If this is set to true, then all output should be
36 * well-formed XML (quotes on attributes, self-closing tags, etc.).
38 * This class is meant to be confined to utility functions that are called from
39 * trusted code paths. It does not do enforcement of policy like not allowing
43 # List of void elements from HTML 5, section 9.1.2 as of 2009-08-10
44 private static $voidElements = array(
45 'area', 'base', 'br', 'col', 'command', 'embed', 'hr', 'img', 'input',
46 'keygen', 'link', 'meta', 'param', 'source'
49 # Boolean attributes, which may have the value omitted entirely. Manually
50 # collected from the HTML 5 spec as of 2009-08-10.
51 private static $boolAttribs = array( 'async', 'autobuffer', 'autofocus',
52 'autoplay', 'checked', 'controls', 'defer', 'disabled',
53 'formnovalidate', 'hidden', 'ismap', 'loop', 'multiple', 'novalidate',
54 'open', 'readonly', 'required', 'reversed', 'scoped', 'seamless'
58 * Returns an HTML element in a string. The major advantage here over
59 * manually typing out the HTML is that it will escape all attribute
60 * values. If you're hardcoding all the attributes, or there are none, you
61 * should probably type out the string yourself.
63 * This is quite similar to Xml::element(), but it implements some useful
64 * HTML-specific logic. For instance, there is no $allowShortTag
65 * parameter: the closing tag is magically omitted if $element has an empty
66 * content model. If $wgWellFormedXml is false, then a few bytes will be
67 * shaved off the HTML output as well. In the future, other HTML-specific
68 * features might be added, like allowing arrays for the values of
69 * attributes like class= and media=.
71 * One notable difference to Xml::element() is that $contents is *not*
72 * escaped. This means that Html::element() can be usefully nested, rather
73 * than using the rather clumsy Xml::openElement() and Xml::closeElement().
75 * @param $element string The element's name, e.g., 'a'
76 * @param $attribs array Associative array of attributes, e.g., array(
77 * 'href' => 'http://www.mediawiki.org/' ). Values will be HTML-escaped.
78 * @param $contents string The raw HTML contents of the element: *not*
80 * @return string Raw HTML
82 public static function element( $element, $attribs = array(), $contents = '' ) {
83 global $wgWellFormedXml;
84 $element = strtolower( $element );
85 $start = "<$element" . self
::expandAttributes( $attribs );
86 if ( in_array( $element, self
::$voidElements ) ) {
87 if ( $wgWellFormedXml ) {
92 return "$start>$contents</$element>";
97 * Given an associative array of element attributes, generate a string
98 * to stick after the element name in HTML output. Like array( 'href' =>
99 * 'http://www.mediawiki.org/' ) becomes something like
100 * ' href="http://www.mediawiki.org"'. Again, this is like
101 * Xml::expandAttributes(), but it implements some HTML-specific logic.
102 * For instance, it will omit quotation marks if $wgWellFormedXml is false,
103 * and will treat boolean attributes specially.
105 * @param $attribs array Associative array of attributes, e.g., array(
106 * 'href' => 'http://www.mediawiki.org/' ). Values will be HTML-escaped.
107 * @return string HTML fragment that goes between element name and '>'
108 * (starting with a space if at least one attribute is output)
110 public static function expandAttributes( $attribs ) {
111 global $wgHtml5, $wgWellFormedXml;
114 foreach ( $attribs as $key => $value ) {
115 # See the "Attributes" section in the HTML syntax part of HTML 5,
116 # 9.1.2.3 as of 2009-08-10. Most attributes can have quotation
117 # marks omitted, but not all. (Although a literal " is not
118 # permitted, we don't check for that, since it will be escaped
120 if ( $wgWellFormedXml ||
$value == ''
121 ||
preg_match( "/[ '=<>]/", $value ) ) {
127 if ( in_array( $key, self
::$boolAttribs ) ) {
128 # In XHTML 1.0 Transitional, the value needs to be equal to the
129 # key. In HTML 5, we can leave the value empty instead. If we
130 # don't need well-formed XML, we can omit the = entirely.
131 if ( !$wgWellFormedXml ) {
133 } elseif ( $wgHtml5 ) {
134 $ret .= " $key=\"\"";
136 $ret .= " $key=\"$key\"";
139 # Apparently we need to entity-encode \n, \r, \t, although the
140 # spec doesn't mention that. Since we're doing strtr() anyway,
141 # and we don't need <> escaped here, we may as well not call
142 # htmlspecialchars(). FIXME: verify that we actually need to
143 # escape \n\r\t here, and explain why, exactly.
144 $ret .= " $key=$quote" . strtr( $value, array(
157 * Output a <script> tag with the given contents. TODO: do some useful
158 * escaping as well, like if $contents contains literal '</script>' or (for
159 * XML) literal "]]>".
161 * @param $contents string JavaScript
162 * @return string Raw HTML
164 public static function inlineScript( $contents ) {
165 global $wgHtml5, $wgJsMimeType;
169 $attrs['type'] = $wgJsMimeType;
170 $contents = "/*<![CDATA[*/$contents/*]]>*/";
172 return self
::element( 'script', $attrs, $contents );
176 * Output a <script> tag linking to the given URL, e.g.,
177 * <script src=foo.js></script>.
180 * @return string Raw HTML
182 public static function linkedScript( $url ) {
183 global $wgHtml5, $wgJsMimeType;
185 $attrs = array( 'src' => $url );
187 $attrs['type'] = $wgJsMimeType;
189 return self
::element( 'script', $attrs );
193 * Output a <style> tag with the given contents for the given media type
194 * (if any). TODO: do some useful escaping as well, like if $contents
195 * contains literal '</style>' (admittedly unlikely).
197 * @param $contents string CSS
198 * @param $media mixed A media type string, like 'screen', or null for all
200 * @return string Raw HTML
202 public static function inlineStyle( $contents, $media = null ) {
207 # Technically we should probably add CDATA stuff here like with
208 # scripts, but in practice, stylesheets tend not to have
209 # problematic characters anyway.
210 $attrs['type'] = 'text/css';
212 if ( $media !== null ) {
213 $attrs['media'] = $media;
215 return self
::element( 'style', $attrs, $contents );
219 * Output a <link rel=stylesheet> linking to the given URL for the given
220 * media type (if any).
223 * @param $media mixed A media type string, like 'screen', or null for all
225 * @return string Raw HTML
227 public static function linkedStyle( $url, $media = null ) {
230 $attrs = array( 'rel' => 'stylesheet', 'href' => $url );
232 $attrs['type'] = 'text/css';
234 if ( $media !== null ) {
235 $attrs['media'] = $media;
237 return self
::element( 'link', $attrs );
241 * Convenience function to produce an <input> element. This supports the
242 * new HTML 5 input types and attributes, and will silently strip them if
245 * @param $name string name attribute
246 * @param $value mixed value attribute (null = omit)
247 * @param $type string type attribute
248 * @param $attribs array Assocative array of miscellaneous extra attributes,
249 * passed to Html::element()
250 * @return string Raw HTML
252 public static function input( $name, $value = null, $type = 'text', $attribs = array() ) {
256 if ( !in_array( $type, array( 'hidden', 'text', 'password',
257 'checkbox', 'radio', 'file', 'submit', 'image', 'reset', 'button'
261 foreach ( array( 'autocomplete', 'autofocus', 'max', 'min', 'multiple',
262 'pattern', 'placeholder', 'required', 'step' ) as $badAttr ) {
263 unset( $attribs[$badAttr] );
266 if ( $type != 'text' ) {
267 $attribs['type'] = $type;
269 if ( $value !== null ) {
270 $attribs['value'] = $value;
272 $attribs['name'] = $name;
274 return self
::element( 'input', $attribs );