X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FHtml.php;h=3986a7b100c05bca66f0d697e695bb8dc6e46eba;hb=0abb52ae76adfadefdc5e37ee754eb6fc4c4c2fc;hp=76abf38c159d9e14147ddd944fb974e4ed05b374;hpb=76a543ea30f99b5ea83cc98533e31a9c681f347c;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/Html.php b/includes/Html.php
index 76abf38c15..3986a7b100 100644
--- a/includes/Html.php
+++ b/includes/Html.php
@@ -1,21 +1,27 @@
 <?php
-# Copyright © 2009 Aryeh Gregor
-# http://www.mediawiki.org/
-#
-# 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.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
+/**
+ * Collection of methods to generate HTML content
+ *
+ * Copyright © 2009 Aryeh Gregor
+ * http://www.mediawiki.org/
+ *
+ * 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.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  * This class is a collection of static functions that serve two purposes:
@@ -42,7 +48,7 @@
  * @since 1.16
  */
 class Html {
-	# List of void elements from HTML5, section 9.1.2 as of 2009-08-10
+	# List of void elements from HTML5, section 8.1.2 as of 2011-08-12
 	private static $voidElements = array(
 		'area',
 		'base',
@@ -58,16 +64,19 @@ class Html {
 		'meta',
 		'param',
 		'source',
+		'track',
+		'wbr',
 	);
 
 	# Boolean attributes, which may have the value omitted entirely.  Manually
-	# collected from the HTML5 spec as of 2010-06-07.
+	# collected from the HTML5 spec as of 2011-08-12.
 	private static $boolAttribs = array(
 		'async',
 		'autofocus',
 		'autoplay',
 		'checked',
 		'controls',
+		'default',
 		'defer',
 		'disabled',
 		'formnovalidate',
@@ -76,6 +85,7 @@ class Html {
 		'itemscope',
 		'loop',
 		'multiple',
+		'muted',
 		'novalidate',
 		'open',
 		'pubdate',
@@ -85,25 +95,40 @@ class Html {
 		'scoped',
 		'seamless',
 		'selected',
+		'truespeed',
+		'typemustmatch',
+		# HTML5 Microdata
+		'itemscope',
+	);
+
+	private static $HTMLFiveOnlyAttribs = array(
+		'autocomplete',
+		'autofocus',
+		'max',
+		'min',
+		'multiple',
+		'pattern',
+		'placeholder',
+		'required',
+		'step',
+		'spellcheck',
 	);
 
 	/**
 	 * Returns an HTML element in a string.  The major advantage here over
 	 * manually typing out the HTML is that it will escape all attribute
 	 * values.  If you're hardcoding all the attributes, or there are none, you
-	 * should probably type out the string yourself.
+	 * should probably just type out the html element yourself.
 	 *
 	 * This is quite similar to Xml::tags(), but it implements some useful
 	 * HTML-specific logic.  For instance, there is no $allowShortTag
 	 * parameter: the closing tag is magically omitted if $element has an empty
 	 * content model.  If $wgWellFormedXml is false, then a few bytes will be
-	 * shaved off the HTML output as well.  In the future, other HTML-specific
-	 * features might be added, like allowing arrays for the values of
-	 * attributes like class= and media=.
+	 * shaved off the HTML output as well.
 	 *
-	 * @param $element  string The element's name, e.g., 'a'
-	 * @param $attribs  array  Associative array of attributes, e.g., array(
-	 *   'href' => 'http://www.mediawiki.org/' ).  See expandAttributes() for
+	 * @param $element string The element's name, e.g., 'a'
+	 * @param $attribs array  Associative array of attributes, e.g., array(
+	 *   'href' => 'http://www.mediawiki.org/' ). See expandAttributes() for
 	 *   further documentation.
 	 * @param $contents string The raw HTML contents of the element: *not*
 	 *   escaped!
@@ -126,6 +151,12 @@ class Html {
 	/**
 	 * Identical to rawElement(), but HTML-escapes $contents (like
 	 * Xml::element()).
+	 *
+	 * @param $element string
+	 * @param $attribs array
+	 * @param $contents string
+	 *
+	 * @return string
 	 */
 	public static function element( $element, $attribs = array(), $contents = '' ) {
 		return self::rawElement( $element, $attribs, strtr( $contents, array(
@@ -139,6 +170,11 @@ class Html {
 	/**
 	 * Identical to rawElement(), but has no third parameter and omits the end
 	 * tag (and the self-closing '/' in XML mode for empty elements).
+	 *
+	 * @param $element string
+	 * @param $attribs array
+	 *
+	 * @return string
 	 */
 	public static function openElement( $element, $attribs = array() ) {
 		global $wgHtml5, $wgWellFormedXml;
@@ -174,15 +210,18 @@ class Html {
 				'button',
 				'search',
 			);
+
 			if ( isset( $attribs['type'] )
 			&& !in_array( $attribs['type'], $validTypes ) ) {
 				unset( $attribs['type'] );
 			}
+
 			if ( isset( $attribs['type'] ) && $attribs['type'] == 'search'
 			&& !$wgHtml5 ) {
 				unset( $attribs['type'] );
 			}
 		}
+
 		if ( !$wgHtml5 && $element == 'textarea' && isset( $attribs['maxlength'] ) ) {
 			unset( $attribs['maxlength'] );
 		}
@@ -195,6 +234,7 @@ class Html {
 	 * Returns "</$element>", except if $wgWellFormedXml is off, in which case
 	 * it returns the empty string when that's guaranteed to be safe.
 	 *
+	 * @since 1.17
 	 * @param $element string Name of the element, e.g., 'a'
 	 * @return string A closing tag, if required
 	 */
@@ -331,6 +371,28 @@ class Html {
 	 * For instance, it will omit quotation marks if $wgWellFormedXml is false,
 	 * and will treat boolean attributes specially.
 	 *
+	 * Attributes that should contain space-separated lists (such as 'class') array
+	 * values are allowed as well, which will automagically be normalized
+	 * and converted to a space-separated string. In addition to a numerical
+	 * array, the attribute value may also be an associative array. See the
+	 * example below for how that works.
+	 *
+	 * @par Numerical array
+	 * @code
+	 *     Html::element( 'em', array(
+	 *         'class' => array( 'foo', 'bar' )
+	 *     ) );
+	 *     // gives '<em class="foo bar"></em>'
+	 * @endcode
+	 *
+	 * @par Associative array
+	 * @code
+	 *     Html::element( 'em', array(
+	 *         'class' => array( 'foo', 'bar', 'foo' => false, 'quux' => true )
+	 *     ) );
+	 *     // gives '<em class="bar quux"></em>'
+	 * @endcode
+	 *
 	 * @param $attribs array Associative array of attributes, e.g., array(
 	 *   'href' => 'http://www.mediawiki.org/' ).  Values will be HTML-escaped.
 	 *   A value of false means to omit the attribute.  For boolean attributes,
@@ -345,7 +407,7 @@ class Html {
 		$ret = '';
 		$attribs = (array)$attribs;
 		foreach ( $attribs as $key => $value ) {
-			if ( $value === false ) {
+			if ( $value === false || is_null( $value ) ) {
 				continue;
 			}
 
@@ -360,6 +422,12 @@ class Html {
 			# and we'd like consistency and better compression anyway.
 			$key = strtolower( $key );
 
+			# Here we're blacklisting some HTML5-only attributes...
+			if ( !$wgHtml5 && in_array( $key, self::$HTMLFiveOnlyAttribs )
+			 ) {
+				continue;
+			}
+
 			# Bug 23769: Blacklist all form validation attributes for now.  Current
 			# (June 2010) WebKit has no UI, so the form just refuses to submit
 			# without telling the user why, which is much worse than failing
@@ -370,20 +438,53 @@ class Html {
 				continue;
 			}
 
-			# Here we're blacklisting some HTML5-only attributes...
-			if ( !$wgHtml5 && in_array( $key, array(
-					'autocomplete',
-					'autofocus',
-					'max',
-					'min',
-					'multiple',
-					'pattern',
-					'placeholder',
-					'required',
-					'step',
-					'spellcheck',
-			) ) ) {
-				continue;
+			// http://www.w3.org/TR/html401/index/attributes.html ("space-separated")
+			// http://www.w3.org/TR/html5/index.html#attributes-1 ("space-separated")
+			$spaceSeparatedListAttributes = array(
+				'class', // html4, html5
+				'accesskey', // as of html5, multiple space-separated values allowed
+				// html4-spec doesn't document rel= as space-separated
+				// but has been used like that and is now documented as such 
+				// in the html5-spec.
+				'rel',
+			);
+
+			# Specific features for attributes that allow a list of space-separated values
+			if ( in_array( $key, $spaceSeparatedListAttributes ) ) {
+				// Apply some normalization and remove duplicates
+
+				// Convert into correct array. Array can contain space-seperated
+				// values. Implode/explode to get those into the main array as well.
+				if ( is_array( $value ) ) {
+					// If input wasn't an array, we can skip this step
+					
+					$newValue = array();
+					foreach ( $value as $k => $v ) {
+						if ( is_string( $v ) ) {
+							// String values should be normal `array( 'foo' )`
+							// Just append them
+							if ( !isset( $value[$v] ) ) {
+								// As a special case don't set 'foo' if a
+								// separate 'foo' => true/false exists in the array
+								// keys should be authoritive
+								$newValue[] = $v;
+							}
+						} elseif ( $v ) {
+							// If the value is truthy but not a string this is likely
+							// an array( 'foo' => true ), falsy values don't add strings
+							$newValue[] = $k;
+						}
+					}
+					$value = implode( ' ', $newValue );
+				}
+				$value = explode( ' ', $value );
+
+				// Normalize spacing by fixing up cases where people used
+				// more than 1 space and/or a trailing/leading space
+				$value = array_diff( $value, array( '', ' ' ) );
+
+				// Remove duplicates and create the string
+				$value = implode( ' ', array_unique( $value ) );
 			}
 
 			# See the "Attributes" section in the HTML syntax part of HTML5,
@@ -419,7 +520,8 @@ class Html {
 				# Apparently we need to entity-encode \n, \r, \t, although the
 				# spec doesn't mention that.  Since we're doing strtr() anyway,
 				# and we don't need <> escaped here, we may as well not call
-				# htmlspecialchars().  FIXME: verify that we actually need to
+				# htmlspecialchars().
+				# @todo FIXME: Verify that we actually need to
 				# escape \n\r\t here, and explain why, exactly.
 				#
 				# We could call Sanitizer::encodeAttribute() for this, but we
@@ -434,10 +536,11 @@ class Html {
 				);
 				if ( $wgWellFormedXml ) {
 					# This is allowed per spec: <http://www.w3.org/TR/xml/#NT-AttValue>
-					# But reportedly it breaks some XML tools?  FIXME: is this
-					# really true?
+					# But reportedly it breaks some XML tools?
+					# @todo FIXME: Is this really true?
 					$map['<'] = '&lt;';
 				}
+				
 				$ret .= " $key=$quote" . strtr( $value, $map ) . $quote;
 			}
 		}
@@ -456,12 +559,15 @@ class Html {
 		global $wgHtml5, $wgJsMimeType, $wgWellFormedXml;
 
 		$attrs = array();
+
 		if ( !$wgHtml5 ) {
 			$attrs['type'] = $wgJsMimeType;
 		}
+
 		if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
 			$contents = "/*<![CDATA[*/$contents/*]]>*/";
 		}
+
 		return self::rawElement( 'script', $attrs, $contents );
 	}
 
@@ -476,9 +582,11 @@ class Html {
 		global $wgHtml5, $wgJsMimeType;
 
 		$attrs = array( 'src' => $url );
+
 		if ( !$wgHtml5 ) {
 			$attrs['type'] = $wgJsMimeType;
 		}
+
 		return self::element( 'script', $attrs );
 	}
 
@@ -497,6 +605,7 @@ class Html {
 		if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
 			$contents = "/*<![CDATA[*/$contents/*]]>*/";
 		}
+
 		return self::rawElement( 'style', array(
 			'type' => 'text/css',
 			'media' => $media,
@@ -541,8 +650,7 @@ class Html {
 	}
 
 	/**
-	 * Convenience function to produce an input element with type=hidden, like
-	 * Xml::hidden.
+	 * Convenience function to produce an input element with type=hidden
 	 *
 	 * @param $name    string name attribute
 	 * @param $value   string value attribute
@@ -569,14 +677,118 @@ class Html {
 	 */
 	public static function textarea( $name, $value = '', $attribs = array() ) {
 		global $wgHtml5;
+
 		$attribs['name'] = $name;
+
 		if ( !$wgHtml5 ) {
-			if ( !isset( $attribs['cols'] ) )
+			if ( !isset( $attribs['cols'] ) ) {
 				$attribs['cols'] = "";
-			if ( !isset( $attribs['rows'] ) )
+			}
+
+			if ( !isset( $attribs['rows'] ) ) {
 				$attribs['rows'] = "";
+			}
+		}
+
+		if (substr($value, 0, 1) == "\n") {
+			// Workaround for bug 12130: browsers eat the initial newline
+			// assuming that it's just for show, but they do keep the later
+			// newlines, which we may want to preserve during editing.
+			// Prepending a single newline
+			$spacedValue = "\n" . $value;
+		} else {
+			$spacedValue = $value;
+		}
+		return self::element( 'textarea', $attribs, $spacedValue );
+	}
+	/**
+	 * Build a drop-down box for selecting a namespace
+	 *
+	 * @param $params array:
+	 * - selected: [optional] Id of namespace which should be pre-selected
+	 * - all: [optional] Value of item for "all namespaces". If null or unset, no <option> is generated to select all namespaces
+	 * - label: text for label to add before the field
+	 * - exclude: [optional] Array of namespace ids to exclude
+	 * - disable: [optional] Array of namespace ids for which the option should be disabled in the selector
+	 * @param $selectAttribs array HTML attributes for the generated select element.
+	 * - id:   [optional], default: 'namespace'
+	 * - name: [optional], default: 'namespace'
+	 * @return string HTML code to select a namespace.
+	 */
+	public static function namespaceSelector( Array $params = array(), Array $selectAttribs = array() ) {
+		global $wgContLang;
+
+		ksort( $selectAttribs );
+
+		// Is a namespace selected?
+		if ( isset( $params['selected'] ) ) {
+			// If string only contains digits, convert to clean int. Selected could also
+			// be "all" or "" etc. which needs to be left untouched.
+			// PHP is_numeric() has issues with large strings, PHP ctype_digit has other issues
+			// and returns false for already clean ints. Use regex instead..
+			if ( preg_match( '/^\d+$/', $params['selected'] ) ) {
+				$params['selected'] = intval( $params['selected'] );
+			}
+			// else: leaves it untouched for later processing
+		} else {
+			$params['selected'] = '';
+		}
+
+		if ( !isset( $params['exclude'] ) || !is_array( $params['exclude'] ) ) {
+			$params['exclude'] = array();
+		}
+		if ( !isset( $params['disable'] ) || !is_array( $params['disable'] ) ) {
+			$params['disable'] = array();
+		}
+
+		// Associative array between option-values and option-labels
+		$options = array();
+
+		if ( isset( $params['all'] ) ) {
+			// add an option that would let the user select all namespaces.
+			// Value is provided by user, the name shown is localized for the user.
+			$options[$params['all']] = wfMsg( 'namespacesall' );
+		}
+		// Add all namespaces as options (in the content langauge)
+		$options += $wgContLang->getFormattedNamespaces();
+
+		// Convert $options to HTML and filter out namespaces below 0
+		$optionsHtml = array();
+		foreach ( $options as $nsId => $nsName ) {
+			if ( $nsId < NS_MAIN || in_array( $nsId, $params['exclude'] ) ) {
+				continue;
+			}
+			if ( $nsId === 0 ) {
+				// For other namespaces use use the namespace prefix as label, but for
+				// main we don't use "" but the user message descripting it (e.g. "(Main)" or "(Article)")
+				$nsName = wfMsg( 'blanknamespace' );
+			}
+			$optionsHtml[] = Html::element(
+				'option', array(
+					'disabled' => in_array( $nsId, $params['disable'] ),
+					'value' => $nsId,
+					'selected' => $nsId === $params['selected'],
+				), $nsName
+			);
 		}
-		return self::element( 'textarea', $attribs, $value );
+
+		$ret = '';
+		if ( isset( $params['label'] ) ) {
+			$ret .= Html::element(
+				'label', array(
+					'for' => isset( $selectAttribs['id'] ) ? $selectAttribs['id'] : null,
+				), $params['label']
+			) . '&#160;';
+		}
+
+		// Wrap options in a <select>
+		$ret .= Html::openElement( 'select', $selectAttribs )
+			. "\n"
+			. implode( "\n", $optionsHtml )
+			. "\n"
+			. Html::closeElement( 'select' );
+
+		return $ret;
 	}
 
 	/**
@@ -590,38 +802,39 @@ class Html {
 	public static function htmlHeader( $attribs = array() ) {
 		$ret = '';
 
-		global $wgMimeType, $wgOutputEncoding;
+		global $wgMimeType;
+
 		if ( self::isXmlMimeType( $wgMimeType ) ) {
-			$ret .= "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?" . ">\n";
+			$ret .= "<?xml version=\"1.0\" encoding=\"UTF-8\" ?" . ">\n";
 		}
 
-		global $wgHtml5, $wgHtml5Version, $wgWellFormedXml, $wgDocType, $wgDTD;
+		global $wgHtml5, $wgHtml5Version, $wgDocType, $wgDTD;
 		global $wgXhtmlNamespaces, $wgXhtmlDefaultNamespace;
+
 		if ( $wgHtml5 ) {
-			if ( $wgWellFormedXml ) {
-				# Unknown elements and attributes are okay in XML, but unknown
-				# named entities are well-formedness errors and will break XML
-				# parsers.  Thus we need a doctype that gives us appropriate
-				# entity definitions.  The HTML5 spec permits four legacy
-				# doctypes as obsolete but conforming, so let's pick one of
-				# those, although it makes our pages look like XHTML1 Strict.
-				# Isn't compatibility great?
-				$ret .= "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n";
-			} else {
-				# Much saner.
-				$ret .= "<!doctype html>\n";
-			}
+			$ret .= "<!DOCTYPE html>\n";
+
 			if ( $wgHtml5Version ) {
 				$attribs['version'] = $wgHtml5Version;
 			}
 		} else {
 			$ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\" \"$wgDTD\">\n";
 			$attribs['xmlns'] = $wgXhtmlDefaultNamespace;
+
 			foreach ( $wgXhtmlNamespaces as $tag => $ns ) {
 				$attribs["xmlns:$tag"] = $ns;
 			}
 		}
-		return $ret . Html::openElement( 'html', $attribs ) . "\n";
+
+		$html = Html::openElement( 'html', $attribs );
+
+		if ( $html ) {
+			$html .= "\n";
+		}
+
+		$ret .= $html;
+
+		return $ret;
 	}
 
 	/**
@@ -632,12 +845,53 @@ class Html {
 	 */
 	public static function isXmlMimeType( $mimetype ) {
 		switch ( $mimetype ) {
-		case 'text/xml':
-		case 'application/xhtml+xml':
-		case 'application/xml':
-			return true;
-		default:
-			return false;
+			case 'text/xml':
+			case 'application/xhtml+xml':
+			case 'application/xml':
+				return true;
+			default:
+				return false;
 		}
 	}
+
+	/**
+	 * Get HTML for an info box with an icon.
+	 *
+	 * @param $text String: wikitext, get this with wfMsgNoTrans()
+	 * @param $icon String: icon name, file in skins/common/images
+	 * @param $alt String: alternate text for the icon
+	 * @param $class String: additional class name to add to the wrapper div
+	 * @param $useStylePath
+	 *
+	 * @return string
+	 */
+	static function infoBox( $text, $icon, $alt, $class = false, $useStylePath = true ) {
+		global $wgStylePath;
+
+		if ( $useStylePath ) {
+			$icon = $wgStylePath.'/common/images/'.$icon;
+		}
+
+		$s  = Html::openElement( 'div', array( 'class' => "mw-infobox $class") );
+
+		$s .= Html::openElement( 'div', array( 'class' => 'mw-infobox-left' ) ).
+				Html::element( 'img',
+					array(
+						'src' => $icon,
+						'alt' => $alt,
+					)
+				).
+				Html::closeElement( 'div' );
+
+		$s .= Html::openElement( 'div', array( 'class' => 'mw-infobox-right' ) ).
+				$text.
+				Html::closeElement( 'div' );
+		$s .= Html::element( 'div', array( 'style' => 'clear: left;' ), ' ' );
+
+		$s .= Html::closeElement( 'div' );
+
+		$s .= Html::element( 'div', array( 'style' => 'clear: left;' ), ' ' );
+
+		return $s;
+	}
 }