-<?php\r
-\r
-/**\r
- * Module of static functions for generating XML\r
- */\r
-\r
-class Xml {\r
- /**\r
- * Format an XML element with given attributes and, optionally, text content.\r
- * Element and attribute names are assumed to be ready for literal inclusion.\r
- * Strings are assumed to not contain XML-illegal characters; special\r
- * characters (<, >, &) are escaped but illegals are not touched.\r
- *\r
- * @param $element String:\r
- * @param $attribs Array: Name=>value pairs. Values will be escaped.\r
- * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)\r
- * @return string\r
- */\r
- function element( $element, $attribs = null, $contents = '') {\r
- $out = '<' . $element;\r
- if( !is_null( $attribs ) ) {\r
- foreach( $attribs as $name => $val ) {\r
- $out .= ' ' . $name . '="' . Sanitizer::encodeAttribute( $val ) . '"';\r
- }\r
- }\r
- if( is_null( $contents ) ) {\r
- $out .= '>';\r
- } else {\r
- if( $contents === '' ) {\r
- $out .= ' />';\r
- } else {\r
- $out .= '>' . htmlspecialchars( $contents ) . "</$element>";\r
- }\r
- }\r
- return $out;\r
- }\r
-\r
- /**\r
- * Format an XML element as with self::element(), but run text through the\r
- * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8\r
- * is passed.\r
- *\r
- * @param $element String:\r
- * @param $attribs Array: Name=>value pairs. Values will be escaped.\r
- * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)\r
- * @return string\r
- */\r
- function elementClean( $element, $attribs = array(), $contents = '') {\r
- if( $attribs ) {\r
- $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );\r
- }\r
- if( $contents ) {\r
- $contents = UtfNormal::cleanUp( $contents );\r
- }\r
- return self::element( $element, $attribs, $contents );\r
- }\r
-\r
- // Shortcuts\r
- public static function openElement( $element, $attribs = null ) { return self::element( $element, $attribs, null ); }\r
- public static function closeElement( $element ) { return "</$element>"; }\r
-\r
- /**\r
- * Create a namespace selector\r
- *\r
- * @param $selected Mixed: the namespace which should be selected, default ''\r
- * @param $allnamespaces String: value of a special item denoting all namespaces. Null to not include (default)\r
- * @param $includehidden Bool: include hidden namespaces?\r
- * @return String: Html string containing the namespace selector\r
- */\r
- function &namespaceSelector($selected = '', $allnamespaces = null, $includehidden=false) {\r
- global $wgContLang;\r
- if( $selected !== '' ) {\r
- if( is_null( $selected ) ) {\r
- // No namespace selected; let exact match work without hitting Main\r
- $selected = '';\r
- } else {\r
- // Let input be numeric strings without breaking the empty match.\r
- $selected = intval( $selected );\r
- }\r
- }\r
- $s = "<select id='namespace' name='namespace' class='namespaceselector'>\n\t";\r
- $arr = $wgContLang->getFormattedNamespaces();\r
- if( !is_null($allnamespaces) ) {\r
- $arr = array($allnamespaces => wfMsg('namespacesall')) + $arr;\r
- }\r
- foreach ($arr as $index => $name) {\r
- if ($index < NS_MAIN) continue;\r
-\r
- $name = $index !== 0 ? $name : wfMsg('blanknamespace');\r
-\r
- if ($index === $selected) {\r
- $s .= self::element("option",\r
- array("value" => $index, "selected" => "selected"),\r
- $name);\r
- } else {\r
- $s .= self::element("option", array("value" => $index), $name);\r
- }\r
- }\r
- $s .= "\n</select>\n";\r
- return $s;\r
- }\r
-\r
- function span( $text, $class, $attribs=array() ) {\r
- return self::element( 'span', array( 'class' => $class ) + $attribs, $text );\r
- }\r
-\r
- /**\r
- * Convenience function to build an HTML text input field\r
- * @return string HTML\r
- */\r
- function input( $name, $size=false, $value=false, $attribs=array() ) {\r
- return self::element( 'input', array(\r
- 'name' => $name,\r
- 'size' => $size,\r
- 'value' => $value ) + $attribs );\r
- }\r
-\r
- /**\r
- * Internal function for use in checkboxes and radio buttons and such.\r
- * @return array\r
- */\r
- function attrib( $name, $present = true ) {\r
- return $present ? array( $name => $name ) : array();\r
- }\r
-\r
- /**\r
- * Convenience function to build an HTML checkbox\r
- * @return string HTML\r
- */\r
- function check( $name, $checked=false, $attribs=array() ) {\r
- return self::element( 'input', array(\r
- 'name' => $name,\r
- 'type' => 'checkbox',\r
- 'value' => 1 ) + self::attrib( 'checked', $checked ) + $attribs );\r
- }\r
-\r
- /**\r
- * Convenience function to build an HTML radio button\r
- * @return string HTML\r
- */\r
- function radio( $name, $value, $checked=false, $attribs=array() ) {\r
- return self::element( 'input', array(\r
- 'name' => $name,\r
- 'type' => 'radio',\r
- 'value' => $value ) + self::attrib( 'checked', $checked ) + $attribs );\r
- }\r
-\r
- /**\r
- * Convenience function to build an HTML form label\r
- * @return string HTML\r
- */\r
- function label( $label, $id ) {\r
- return self::element( 'label', array( 'for' => $id ), $label );\r
- }\r
-\r
- /**\r
- * Convenience function to build an HTML text input field with a label\r
- * @return string HTML\r
- */\r
- function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {\r
- return Xml::label( $label, $id ) .\r
- ' ' .\r
- self::input( $name, $size, $value, array( 'id' => $id ) + $attribs );\r
- }\r
-\r
- /**\r
- * Convenience function to build an HTML checkbox with a label\r
- * @return string HTML\r
- */\r
- function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {\r
- return self::check( $name, $checked, array( 'id' => $id ) + $attribs ) .\r
- ' ' .\r
- self::label( $label, $id );\r
- }\r
-\r
- /**\r
- * Convenience function to build an HTML radio button with a label\r
- * @return string HTML\r
- */\r
- function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {\r
- return self::radio( $name, $value, $checked, array( 'id' => $id ) + $attribs ) .\r
- ' ' .\r
- self::label( $label, $id );\r
- }\r
-\r
- /**\r
- * Convenience function to build an HTML submit button\r
- * @param $value String: label text for the button\r
- * @param $attribs Array: optional custom attributes\r
- * @return string HTML\r
- */\r
- function submitButton( $value, $attribs=array() ) {\r
- return self::element( 'input', array( 'type' => 'submit', 'value' => $value ) + $attribs );\r
- }\r
-\r
- /**\r
- * Convenience function to build an HTML hidden form field.\r
- * @todo Document $name parameter.\r
- * @param $name FIXME\r
- * @param $value String: label text for the button\r
- * @param $attribs Array: optional custom attributes\r
- * @return string HTML\r
- */\r
- function hidden( $name, $value, $attribs=array() ) {\r
- return self::element( 'input', array(\r
- 'name' => $name,\r
- 'type' => 'hidden',\r
- 'value' => $value ) + $attribs );\r
- }\r
-\r
- /**\r
- * Returns an escaped string suitable for inclusion in a string literal\r
- * for JavaScript source code.\r
- * Illegal control characters are assumed not to be present.\r
- *\r
- * @param string $string\r
- * @return string\r
- */\r
- public static function escapeJsString( $string ) {\r
- // See ECMA 262 section 7.8.4 for string literal format\r
- $pairs = array(\r
- "\\" => "\\\\",\r
- "\"" => "\\\"",\r
- '\'' => '\\\'',\r
- "\n" => "\\n",\r
- "\r" => "\\r",\r
-\r
- # To avoid closing the element or CDATA section\r
- "<" => "\\x3c",\r
- ">" => "\\x3e",\r
- );\r
- return strtr( $string, $pairs );\r
- }\r
-\r
- /**\r
- * Check if a string is well-formed XML.\r
- * Must include the surrounding tag.\r
- *\r
- * @param $text String: string to test.\r
- * @return bool\r
- *\r
- * @todo Error position reporting return\r
- */\r
- function isWellFormed( $text ) {\r
- $parser = xml_parser_create( "UTF-8" );\r
-\r
- # case folding violates XML standard, turn it off\r
- xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );\r
-\r
- if( !xml_parse( $parser, $text, true ) ) {\r
- $err = xml_error_string( xml_get_error_code( $parser ) );\r
- $position = xml_get_current_byte_index( $parser );\r
- //$fragment = $this->extractFragment( $html, $position );\r
- //$this->mXmlError = "$err at byte $position:\n$fragment";\r
- xml_parser_free( $parser );\r
- return false;\r
- }\r
- xml_parser_free( $parser );\r
- return true;\r
- }\r
-\r
- /**\r
- * Check if a string is a well-formed XML fragment.\r
- * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment\r
- * and can use HTML named entities.\r
- *\r
- * @param $text String:\r
- * @return bool\r
- */\r
- function isWellFormedXmlFragment( $text ) {\r
- $html =\r
- Sanitizer::hackDocType() .\r
- '<html>' .\r
- $text .\r
- '</html>';\r
- return Xml::isWellFormed( $html );\r
- }\r
-}\r
-?>\r
+<?php
+
+/**
+ * Module of static functions for generating XML
+ */
+
+class Xml {
+ /**
+ * Format an XML element with given attributes and, optionally, text content.
+ * Element and attribute names are assumed to be ready for literal inclusion.
+ * Strings are assumed to not contain XML-illegal characters; special
+ * characters (<, >, &) are escaped but illegals are not touched.
+ *
+ * @param $element String:
+ * @param $attribs Array: Name=>value pairs. Values will be escaped.
+ * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
+ * @return string
+ */
+ public static function element( $element, $attribs = null, $contents = '') {
+ $out = '<' . $element;
+ if( !is_null( $attribs ) ) {
+ foreach( $attribs as $name => $val ) {
+ $out .= ' ' . $name . '="' . Sanitizer::encodeAttribute( $val ) . '"';
+ }
+ }
+ if( is_null( $contents ) ) {
+ $out .= '>';
+ } else {
+ if( $contents === '' ) {
+ $out .= ' />';
+ } else {
+ $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
+ }
+ }
+ return $out;
+ }
+
+ /**
+ * Format an XML element as with self::element(), but run text through the
+ * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
+ * is passed.
+ *
+ * @param $element String:
+ * @param $attribs Array: Name=>value pairs. Values will be escaped.
+ * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
+ * @return string
+ */
+ public static function elementClean( $element, $attribs = array(), $contents = '') {
+ if( $attribs ) {
+ $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
+ }
+ if( $contents ) {
+ wfProfileIn( __METHOD__ . '-norm' );
+ $contents = UtfNormal::cleanUp( $contents );
+ wfProfileOut( __METHOD__ . '-norm' );
+ }
+ return self::element( $element, $attribs, $contents );
+ }
+
+ // Shortcuts
+ public static function openElement( $element, $attribs = null ) { return self::element( $element, $attribs, null ); }
+ public static function closeElement( $element ) { return "</$element>"; }
+
+ /**
+ * Same as <link>element</link>, but does not escape contents. Handy when the
+ * content you have is already valid xml.
+ */
+ public static function tags( $element, $attribs = null, $contents ) {
+ return self::element( $element, $attribs, null ) . $contents . "</$element>";
+ }
+
+ /**
+ * Create a namespace selector
+ *
+ * @param $selected Mixed: the namespace which should be selected, default ''
+ * @param $allnamespaces String: value of a special item denoting all namespaces. Null to not include (default)
+ * @param $includehidden Bool: include hidden namespaces?
+ * @return String: Html string containing the namespace selector
+ */
+ public static function namespaceSelector($selected = '', $allnamespaces = null, $includehidden=false) {
+ global $wgContLang;
+ if( $selected !== '' ) {
+ if( is_null( $selected ) ) {
+ // No namespace selected; let exact match work without hitting Main
+ $selected = '';
+ } else {
+ // Let input be numeric strings without breaking the empty match.
+ $selected = intval( $selected );
+ }
+ }
+ $s = "\n<select id='namespace' name='namespace' class='namespaceselector'>\n";
+ $arr = $wgContLang->getFormattedNamespaces();
+ if( !is_null($allnamespaces) ) {
+ $arr = array($allnamespaces => wfMsg('namespacesall')) + $arr;
+ }
+ foreach ($arr as $index => $name) {
+ if ($index < NS_MAIN) continue;
+
+ $name = $index !== 0 ? $name : wfMsg('blanknamespace');
+
+ if ($index === $selected) {
+ $s .= "\t" . self::element("option",
+ array("value" => $index, "selected" => "selected"),
+ $name) . "\n";
+ } else {
+ $s .= "\t" . self::element("option", array("value" => $index), $name) . "\n";
+ }
+ }
+ $s .= "</select>\n";
+ return $s;
+ }
+
+ /**
+ *
+ * @param $language The language code of the selected language
+ * @param $customisedOnly If true only languages which have some content are listed
+ * @return array of label and select
+ */
+ public static function languageSelector( $selected, $customisedOnly = true ) {
+ global $wgContLanguageCode;
+ /**
+ * Make sure the site language is in the list; a custom language code
+ * might not have a defined name...
+ */
+ $languages = Language::getLanguageNames( $customisedOnly );
+ if( !array_key_exists( $wgContLanguageCode, $languages ) ) {
+ $languages[$wgContLanguageCode] = $wgContLanguageCode;
+ }
+ ksort( $languages );
+
+ /**
+ * If a bogus value is set, default to the content language.
+ * Otherwise, no default is selected and the user ends up
+ * with an Afrikaans interface since it's first in the list.
+ */
+ $selected = isset( $languages[$selected] ) ? $selected : $wgContLanguageCode;
+ $options = "\n";
+ foreach( $languages as $code => $name ) {
+ $options .= Xml::option( "$code - $name", $code, ($code == $selected) ) . "\n";
+ }
+
+ return array(
+ Xml::label( wfMsg('yourlanguage'), 'wpUserLanguage' ),
+ Xml::tags( 'select',
+ array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ),
+ $options
+ )
+ );
+
+ }
+
+ public static function span( $text, $class, $attribs=array() ) {
+ return self::element( 'span', array( 'class' => $class ) + $attribs, $text );
+ }
+
+ /**
+ * Convenience function to build an HTML text input field
+ * @return string HTML
+ */
+ public static function input( $name, $size=false, $value=false, $attribs=array() ) {
+ return self::element( 'input', array(
+ 'name' => $name,
+ 'size' => $size,
+ 'value' => $value ) + $attribs );
+ }
+
+ /**
+ * Internal function for use in checkboxes and radio buttons and such.
+ * @return array
+ */
+ public static function attrib( $name, $present = true ) {
+ return $present ? array( $name => $name ) : array();
+ }
+
+ /**
+ * Convenience function to build an HTML checkbox
+ * @return string HTML
+ */
+ public static function check( $name, $checked=false, $attribs=array() ) {
+ return self::element( 'input', array_merge(
+ array(
+ 'name' => $name,
+ 'type' => 'checkbox',
+ 'value' => 1 ),
+ self::attrib( 'checked', $checked ),
+ $attribs ) );
+ }
+
+ /**
+ * Convenience function to build an HTML radio button
+ * @return string HTML
+ */
+ public static function radio( $name, $value, $checked=false, $attribs=array() ) {
+ return self::element( 'input', array(
+ 'name' => $name,
+ 'type' => 'radio',
+ 'value' => $value ) + self::attrib( 'checked', $checked ) + $attribs );
+ }
+
+ /**
+ * Convenience function to build an HTML form label
+ * @return string HTML
+ */
+ public static function label( $label, $id ) {
+ return self::element( 'label', array( 'for' => $id ), $label );
+ }
+
+ /**
+ * Convenience function to build an HTML text input field with a label
+ * @return string HTML
+ */
+ public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
+ return Xml::label( $label, $id ) .
+ ' ' .
+ self::input( $name, $size, $value, array( 'id' => $id ) + $attribs );
+ }
+
+ /**
+ * Convenience function to build an HTML checkbox with a label
+ * @return string HTML
+ */
+ public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {
+ return self::check( $name, $checked, array( 'id' => $id ) + $attribs ) .
+ ' ' .
+ self::label( $label, $id );
+ }
+
+ /**
+ * Convenience function to build an HTML radio button with a label
+ * @return string HTML
+ */
+ public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {
+ return self::radio( $name, $value, $checked, array( 'id' => $id ) + $attribs ) .
+ ' ' .
+ self::label( $label, $id );
+ }
+
+ /**
+ * Convenience function to build an HTML submit button
+ * @param $value String: label text for the button
+ * @param $attribs Array: optional custom attributes
+ * @return string HTML
+ */
+ public static function submitButton( $value, $attribs=array() ) {
+ return self::element( 'input', array( 'type' => 'submit', 'value' => $value ) + $attribs );
+ }
+
+ /**
+ * Convenience function to build an HTML hidden form field.
+ * @todo Document $name parameter.
+ * @param $name FIXME
+ * @param $value String: label text for the button
+ * @param $attribs Array: optional custom attributes
+ * @return string HTML
+ */
+ public static function hidden( $name, $value, $attribs=array() ) {
+ return self::element( 'input', array(
+ 'name' => $name,
+ 'type' => 'hidden',
+ 'value' => $value ) + $attribs );
+ }
+
+ /**
+ * Convenience function to build an HTML drop-down list item.
+ * @param $text String: text for this item
+ * @param $value String: form submission value; if empty, use text
+ * @param $selected boolean: if true, will be the default selected item
+ * @param $attribs array: optional additional HTML attributes
+ * @return string HTML
+ */
+ public static function option( $text, $value=null, $selected=false,
+ $attribs=array() ) {
+ if( !is_null( $value ) ) {
+ $attribs['value'] = $value;
+ }
+ if( $selected ) {
+ $attribs['selected'] = 'selected';
+ }
+ return self::element( 'option', $attribs, $text );
+ }
+
+ /**
+ * Returns an escaped string suitable for inclusion in a string literal
+ * for JavaScript source code.
+ * Illegal control characters are assumed not to be present.
+ *
+ * @param string $string
+ * @return string
+ */
+ public static function escapeJsString( $string ) {
+ // See ECMA 262 section 7.8.4 for string literal format
+ $pairs = array(
+ "\\" => "\\\\",
+ "\"" => "\\\"",
+ '\'' => '\\\'',
+ "\n" => "\\n",
+ "\r" => "\\r",
+
+ # To avoid closing the element or CDATA section
+ "<" => "\\x3c",
+ ">" => "\\x3e",
+
+ # To avoid any complaints about bad entity refs
+ "&" => "\\x26",
+ );
+ return strtr( $string, $pairs );
+ }
+
+ /**
+ * Encode a variable of unknown type to JavaScript.
+ * Doesn't support hashtables just yet.
+ */
+ public static function encodeJsVar( $value ) {
+ if ( is_bool( $value ) ) {
+ $s = $value ? 'true' : 'false';
+ } elseif ( is_null( $value ) ) {
+ $s = 'null';
+ } elseif ( is_int( $value ) ) {
+ $s = $value;
+ } elseif ( is_array( $value ) ) {
+ $s = '[';
+ foreach ( $value as $name => $elt ) {
+ if ( $s != '[' ) {
+ $s .= ', ';
+ }
+ $s .= self::encodeJsVar( $elt );
+ }
+ $s .= ']';
+ } else {
+ $s = '"' . self::escapeJsString( $value ) . '"';
+ }
+ return $s;
+ }
+
+
+ /**
+ * Check if a string is well-formed XML.
+ * Must include the surrounding tag.
+ *
+ * @param $text String: string to test.
+ * @return bool
+ *
+ * @todo Error position reporting return
+ */
+ public static function isWellFormed( $text ) {
+ $parser = xml_parser_create( "UTF-8" );
+
+ # case folding violates XML standard, turn it off
+ xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
+
+ if( !xml_parse( $parser, $text, true ) ) {
+ //$err = xml_error_string( xml_get_error_code( $parser ) );
+ //$position = xml_get_current_byte_index( $parser );
+ //$fragment = $this->extractFragment( $html, $position );
+ //$this->mXmlError = "$err at byte $position:\n$fragment";
+ xml_parser_free( $parser );
+ return false;
+ }
+ xml_parser_free( $parser );
+ return true;
+ }
+
+ /**
+ * Check if a string is a well-formed XML fragment.
+ * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
+ * and can use HTML named entities.
+ *
+ * @param $text String:
+ * @return bool
+ */
+ public static function isWellFormedXmlFragment( $text ) {
+ $html =
+ Sanitizer::hackDocType() .
+ '<html>' .
+ $text .
+ '</html>';
+ return Xml::isWellFormed( $html );
+ }
+
+ /**
+ * Replace " > and < with their respective HTML entities ( ",
+ * >, <)
+ *
+ * @param $in String: text that might contain HTML tags.
+ * @return string Escaped string
+ */
+ public static function escapeTagsOnly( $in ) {
+ return str_replace(
+ array( '"', '>', '<' ),
+ array( '"', '>', '<' ),
+ $in );
+ }
+}
+?>
dépôts / lhc / web / wiklou.git / blobdiff