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(
61 # Boolean attributes, which may have the value omitted entirely. Manually
62 # collected from the HTML 5 spec as of 2009-08-10.
63 private static $boolAttribs = array(
86 # A nested associative array of element => content attribute => default
87 # value. Attributes that have the default value will be omitted, since
88 # they're pointless. Currently the list hasn't been systematically
90 private static $attribDefaults = array(
98 * Returns an HTML element in a string. The major advantage here over
99 * manually typing out the HTML is that it will escape all attribute
100 * values. If you're hardcoding all the attributes, or there are none, you
101 * should probably type out the string yourself.
103 * This is quite similar to Xml::tags(), but it implements some useful
104 * HTML-specific logic. For instance, there is no $allowShortTag
105 * parameter: the closing tag is magically omitted if $element has an empty
106 * content model. If $wgWellFormedXml is false, then a few bytes will be
107 * shaved off the HTML output as well. In the future, other HTML-specific
108 * features might be added, like allowing arrays for the values of
109 * attributes like class= and media=.
111 * @param $element string The element's name, e.g., 'a'
112 * @param $attribs array Associative array of attributes, e.g., array(
113 * 'href' => 'http://www.mediawiki.org/' ). Values will be HTML-escaped.
114 * A value of false means to omit the attribute.
115 * @param $contents string The raw HTML contents of the element: *not*
117 * @return string Raw HTML
119 public static function rawElement( $element, $attribs = array(), $contents = '' ) {
120 global $wgHtml5, $wgWellFormedXml;
121 # This is not required in HTML 5, but let's do it anyway, for
122 # consistency and better compression.
123 $element = strtolower( $element );
125 # Element-specific hacks to slim down output and ensure validity
126 if ( $element == 'input' ) {
128 # With $wgHtml5 off we want to validate as XHTML 1, so we
129 # strip out any fancy HTML 5-only input types for now.
131 # Whitelist of valid types:
144 if ( isset( $attribs['type'] )
145 && !in_array( $attribs['type'], $validTypes ) ) {
146 # Fall back to type=text, the default
147 unset( $attribs['type'] );
149 # Here we're blacklisting some HTML5-only attributes...
150 $html5attribs = array(
161 foreach ( $html5attribs as $badAttr ) {
162 unset( $attribs[$badAttr] );
167 # Don't bother outputting the default values for attributes
168 foreach ( $attribs as $attrib => $value ) {
169 $lcattrib = strtolower( $attrib );
170 if ( isset( self
::$attribDefaults[$element][$lcattrib] ) &&
171 self
::$attribDefaults[$element][$lcattrib] === $value ) {
172 unset( $attribs[$attrib] );
176 $start = "<$element" . self
::expandAttributes( $attribs );
177 if ( in_array( $element, self
::$voidElements ) ) {
178 if ( $wgWellFormedXml ) {
183 return "$start>$contents</$element>";
188 * Identical to rawElement(), but HTML-escapes $contents (like
191 public static function element( $element, $attribs = array(), $contents = '' ) {
192 return self
::rawElement( $element, $attribs, strtr( $contents, array(
193 # There's no point in escaping quotes, >, etc. in the contents of
201 * Given an associative array of element attributes, generate a string
202 * to stick after the element name in HTML output. Like array( 'href' =>
203 * 'http://www.mediawiki.org/' ) becomes something like
204 * ' href="http://www.mediawiki.org"'. Again, this is like
205 * Xml::expandAttributes(), but it implements some HTML-specific logic.
206 * For instance, it will omit quotation marks if $wgWellFormedXml is false,
207 * and will treat boolean attributes specially.
209 * @param $attribs array Associative array of attributes, e.g., array(
210 * 'href' => 'http://www.mediawiki.org/' ). Values will be HTML-escaped.
211 * A value of false means to omit the attribute.
212 * @return string HTML fragment that goes between element name and '>'
213 * (starting with a space if at least one attribute is output)
215 public static function expandAttributes( $attribs ) {
216 global $wgHtml5, $wgWellFormedXml;
219 foreach ( $attribs as $key => $value ) {
220 if ( $value === false ) {
224 # For boolean attributes, support array( 'foo' ) instead of
225 # requiring array( 'foo' => 'meaningless' ).
227 && in_array( strtolower( $value ), self
::$boolAttribs ) ) {
231 # Not technically required in HTML 5, but required in XHTML 1.0,
232 # and we'd like consistency and better compression anyway.
233 $key = strtolower( $key );
235 # See the "Attributes" section in the HTML syntax part of HTML 5,
236 # 9.1.2.3 as of 2009-08-10. Most attributes can have quotation
237 # marks omitted, but not all. (Although a literal " is not
238 # permitted, we don't check for that, since it will be escaped
240 if ( $wgWellFormedXml ||
$value == ''
241 ||
preg_match( "/[ '=<>]/", $value ) ) {
247 if ( in_array( $key, self
::$boolAttribs ) ) {
248 # In XHTML 1.0 Transitional, the value needs to be equal to the
249 # key. In HTML 5, we can leave the value empty instead. If we
250 # don't need well-formed XML, we can omit the = entirely.
251 if ( !$wgWellFormedXml ) {
253 } elseif ( $wgHtml5 ) {
254 $ret .= " $key=\"\"";
256 $ret .= " $key=\"$key\"";
259 # Apparently we need to entity-encode \n, \r, \t, although the
260 # spec doesn't mention that. Since we're doing strtr() anyway,
261 # and we don't need <> escaped here, we may as well not call
262 # htmlspecialchars(). FIXME: verify that we actually need to
263 # escape \n\r\t here, and explain why, exactly.
264 $ret .= " $key=$quote" . strtr( $value, array(
277 * Output a <script> tag with the given contents. TODO: do some useful
278 * escaping as well, like if $contents contains literal '</script>' or (for
279 * XML) literal "]]>".
281 * @param $contents string JavaScript
282 * @return string Raw HTML
284 public static function inlineScript( $contents ) {
285 global $wgHtml5, $wgJsMimeType, $wgWellFormedXml;
289 $attrs['type'] = $wgJsMimeType;
291 if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
292 $contents = "/*<![CDATA[*/$contents/*]]>*/";
294 return self
::rawElement( 'script', $attrs, $contents );
298 * Output a <script> tag linking to the given URL, e.g.,
299 * <script src=foo.js></script>.
302 * @return string Raw HTML
304 public static function linkedScript( $url ) {
305 global $wgHtml5, $wgJsMimeType;
307 $attrs = array( 'src' => $url );
309 $attrs['type'] = $wgJsMimeType;
311 return self
::element( 'script', $attrs );
315 * Output a <style> tag with the given contents for the given media type
316 * (if any). TODO: do some useful escaping as well, like if $contents
317 * contains literal '</style>' (admittedly unlikely).
319 * @param $contents string CSS
320 * @param $media mixed A media type string, like 'screen', or null for all
322 * @return string Raw HTML
324 public static function inlineStyle( $contents, $media = null ) {
325 global $wgHtml5, $wgWellFormedXml;
329 $attrs['type'] = 'text/css';
331 if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
332 $contents = "/*<![CDATA[*/$contents/*]]>*/";
334 if ( $media !== null ) {
335 $attrs['media'] = $media;
337 return self
::rawElement( 'style', $attrs, $contents );
341 * Output a <link rel=stylesheet> linking to the given URL for the given
342 * media type (if any).
345 * @param $media mixed A media type string, like 'screen', or null for all
347 * @return string Raw HTML
349 public static function linkedStyle( $url, $media = null ) {
352 $attrs = array( 'rel' => 'stylesheet', 'href' => $url );
354 $attrs['type'] = 'text/css';
356 if ( $media !== null ) {
357 $attrs['media'] = $media;
359 return self
::element( 'link', $attrs );
363 * Convenience function to produce an <input> element. This supports the
364 * new HTML 5 input types and attributes, and will silently strip them if
367 * @param $name string name attribute
368 * @param $value mixed value attribute (null = omit)
369 * @param $type string type attribute
370 * @param $attribs array Associative array of miscellaneous extra
371 * attributes, passed to Html::element()
372 * @return string Raw HTML
374 public static function input( $name, $value = null, $type = 'text', $attribs = array() ) {
375 $attribs['type'] = $type;
376 if ( $value !== null ) {
377 $attribs['value'] = $value;
379 $attribs['name'] = $name;
381 return self
::element( 'input', $attribs );
385 * Convenience function to produce an input element with type=hidden, like
388 * @param $name string name attribute
389 * @param $value string value attribute
390 * @param $attribs array Associative array of miscellaneous extra
391 * attributes, passed to Html::element()
392 * @return string Raw HTML
394 public static function hidden( $name, $value, $attribs = array() ) {
395 return self
::input( $name, $value, 'hidden', $attribs );