includes/Xml.php

   1 <?php
   2
   3 /**
   4  * Module of static functions for generating XML
   5  */
   6
   7 class Xml {
   8         /**
   9          * Format an XML element with given attributes and, optionally, text content.
  10          * Element and attribute names are assumed to be ready for literal inclusion.
  11          * Strings are assumed to not contain XML-illegal characters; special
  12          * characters (<, >, &) are escaped but illegals are not touched.
  13          *
  14          * @param $element String:
  15          * @param $attribs Array: Name=>value pairs. Values will be escaped.
  16          * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
  17          * @return string
  18          */
  19         public static function element( $element, $attribs = null, $contents = '') {
  20                 $out = '<' . $element;
  21                 if( !is_null( $attribs ) ) {
  22                         foreach( $attribs as $name => $val ) {
  23                                 $out .= ' ' . $name . '="' . Sanitizer::encodeAttribute( $val ) . '"';
  24                         }
  25                 }
  26                 if( is_null( $contents ) ) {
  27                         $out .= '>';
  28                 } else {
  29                         if( $contents === '' ) {
  30                                 $out .= ' />';
  31                         } else {
  32                                 $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
  33                         }
  34                 }
  35                 return $out;
  36         }
  37
  38         /**
  39          * Format an XML element as with self::element(), but run text through the
  40          * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
  41          * is passed.
  42          *
  43          * @param $element String:
  44          * @param $attribs Array: Name=>value pairs. Values will be escaped.
  45          * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
  46          * @return string
  47          */
  48         public static function elementClean( $element, $attribs = array(), $contents = '') {
  49                 if( $attribs ) {
  50                         $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
  51                 }
  52                 if( $contents ) {
  53                         wfProfileIn( __METHOD__ . '-norm' );
  54                         $contents = UtfNormal::cleanUp( $contents );
  55                         wfProfileOut( __METHOD__ . '-norm' );
  56                 }
  57                 return self::element( $element, $attribs, $contents );
  58         }
  59
  60         // Shortcuts
  61         public static function openElement( $element, $attribs = null ) { return self::element( $element, $attribs, null ); }
  62         public static function closeElement( $element ) { return "</$element>"; }
  63
  64         /**
  65          * Same as <link>element</link>, but does not escape contents. Handy when the
  66          * content you have is already valid xml.
  67          */
  68         public static function tags( $element, $attribs = null, $contents ) {
  69                 return self::element( $element, $attribs, null ) . $contents . "</$element>";
  70         }
  71
  72         /**
  73          * Create a namespace selector
  74          *
  75          * @param $selected Mixed: the namespace which should be selected, default ''
  76          * @param $allnamespaces String: value of a special item denoting all namespaces. Null to not include (default)
  77          * @param $includehidden Bool: include hidden namespaces?
  78          * @return String: Html string containing the namespace selector
  79          */
  80         public static function namespaceSelector($selected = '', $allnamespaces = null, $includehidden=false) {
  81                 global $wgContLang;
  82                 if( $selected !== '' ) {
  83                         if( is_null( $selected ) ) {
  84                                 // No namespace selected; let exact match work without hitting Main
  85                                 $selected = '';
  86                         } else {
  87                                 // Let input be numeric strings without breaking the empty match.
  88                                 $selected = intval( $selected );
  89                         }
  90                 }
  91                 $s = "\n<select id='namespace' name='namespace' class='namespaceselector'>\n";
  92                 $arr = $wgContLang->getFormattedNamespaces();
  93                 if( !is_null($allnamespaces) ) {
  94                         $arr = array($allnamespaces => wfMsg('namespacesall')) + $arr;
  95                 }
  96                 foreach ($arr as $index => $name) {
  97                         if ($index < NS_MAIN) continue;
  98
  99                         $name = $index !== 0 ? $name : wfMsg('blanknamespace');
 100
 101                         if ($index === $selected) {
 102                                 $s .= "\t" . self::element("option",
 103                                                 array("value" => $index, "selected" => "selected"),
 104                                                 $name) . "\n";
 105                         } else {
 106                                 $s .= "\t" . self::element("option", array("value" => $index), $name) . "\n";
 107                         }
 108                 }
 109                 $s .= "</select>\n";
 110                 return $s;
 111         }
 112
 113         /**
 114          *
 115          * @param $language The language code of the selected language
 116          * @param $customisedOnly If true only languages which have some content are listed
 117          * @return array of label and select
 118          */
 119         public static function languageSelector( $selected, $customisedOnly = true ) {
 120                 global $wgContLanguageCode;
 121                 /**
 122                  * Make sure the site language is in the list; a custom language code
 123                  * might not have a defined name...
 124                  */
 125                 $languages = Language::getLanguageNames( $customisedOnly );
 126                 if( !array_key_exists( $wgContLanguageCode, $languages ) ) {
 127                         $languages[$wgContLanguageCode] = $wgContLanguageCode;
 128                 }
 129                 ksort( $languages );
 130
 131                 /**
 132                  * If a bogus value is set, default to the content language.
 133                  * Otherwise, no default is selected and the user ends up
 134                  * with an Afrikaans interface since it's first in the list.
 135                  */
 136                 $selected = isset( $languages[$selected] ) ? $selected : $wgContLanguageCode;
 137                 $options = "\n";
 138                 foreach( $languages as $code => $name ) {
 139                         $options .= Xml::option( "$code - $name", $code, ($code == $selected) ) . "\n";
 140                 }
 141
 142                 return array(
 143                         Xml::label( wfMsg('yourlanguage'), 'wpUserLanguage' ),
 144                         Xml::tags( 'select',
 145                                 array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ),
 146                                 $options
 147                         )
 148                 );
 149
 150         }
 151
 152         public static function span( $text, $class, $attribs=array() ) {
 153                 return self::element( 'span', array( 'class' => $class ) + $attribs, $text );
 154         }
 155
 156         /**
 157          * Convenience function to build an HTML text input field
 158          * @return string HTML
 159          */
 160         public static function input( $name, $size=false, $value=false, $attribs=array() ) {
 161                 return self::element( 'input', array(
 162                         'name' => $name,
 163                         'size' => $size,
 164                         'value' => $value ) + $attribs );
 165         }
 166
 167         /**
 168          * Internal function for use in checkboxes and radio buttons and such.
 169          * @return array
 170          */
 171         public static function attrib( $name, $present = true ) {
 172                 return $present ? array( $name => $name ) : array();
 173         }
 174
 175         /**
 176          * Convenience function to build an HTML checkbox
 177          * @return string HTML
 178          */
 179         public static function check( $name, $checked=false, $attribs=array() ) {
 180                 return self::element( 'input', array_merge(
 181                         array(
 182                                 'name' => $name,
 183                                 'type' => 'checkbox',
 184                                 'value' => 1 ),
 185                         self::attrib( 'checked', $checked ),
 186                         $attribs ) );
 187         }
 188
 189         /**
 190          * Convenience function to build an HTML radio button
 191          * @return string HTML
 192          */
 193         public static function radio( $name, $value, $checked=false, $attribs=array() ) {
 194                 return self::element( 'input', array(
 195                         'name' => $name,
 196                         'type' => 'radio',
 197                         'value' => $value ) + self::attrib( 'checked', $checked ) + $attribs );
 198         }
 199
 200         /**
 201          * Convenience function to build an HTML form label
 202          * @return string HTML
 203          */
 204         public static function label( $label, $id ) {
 205                 return self::element( 'label', array( 'for' => $id ), $label );
 206         }
 207
 208         /**
 209          * Convenience function to build an HTML text input field with a label
 210          * @return string HTML
 211          */
 212         public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
 213                 return Xml::label( $label, $id ) .
 214                         '&nbsp;' .
 215                         self::input( $name, $size, $value, array( 'id' => $id ) + $attribs );
 216         }
 217
 218         /**
 219          * Convenience function to build an HTML checkbox with a label
 220          * @return string HTML
 221          */
 222         public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {
 223                 return self::check( $name, $checked, array( 'id' => $id ) + $attribs ) .
 224                         '&nbsp;' .
 225                         self::label( $label, $id );
 226         }
 227
 228         /**
 229          * Convenience function to build an HTML radio button with a label
 230          * @return string HTML
 231          */
 232         public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {
 233                 return self::radio( $name, $value, $checked, array( 'id' => $id ) + $attribs ) .
 234                         '&nbsp;' .
 235                         self::label( $label, $id );
 236         }
 237
 238         /**
 239          * Convenience function to build an HTML submit button
 240          * @param $value String: label text for the button
 241          * @param $attribs Array: optional custom attributes
 242          * @return string HTML
 243          */
 244         public static function submitButton( $value, $attribs=array() ) {
 245                 return self::element( 'input', array( 'type' => 'submit', 'value' => $value ) + $attribs );
 246         }
 247
 248         /**
 249          * Convenience function to build an HTML hidden form field.
 250          * @todo Document $name parameter.
 251          * @param $name FIXME
 252          * @param $value String: label text for the button
 253          * @param $attribs Array: optional custom attributes
 254          * @return string HTML
 255          */
 256         public static function hidden( $name, $value, $attribs=array() ) {
 257                 return self::element( 'input', array(
 258                         'name' => $name,
 259                         'type' => 'hidden',
 260                         'value' => $value ) + $attribs );
 261         }
 262
 263         /**
 264          * Convenience function to build an HTML drop-down list item.
 265          * @param $text String: text for this item
 266          * @param $value String: form submission value; if empty, use text
 267          * @param $selected boolean: if true, will be the default selected item
 268          * @param $attribs array: optional additional HTML attributes
 269          * @return string HTML
 270          */
 271         public static function option( $text, $value=null, $selected=false,
 272                         $attribs=array() ) {
 273                 if( !is_null( $value ) ) {
 274                         $attribs['value'] = $value;
 275                 }
 276                 if( $selected ) {
 277                         $attribs['selected'] = 'selected';
 278                 }
 279                 return self::element( 'option', $attribs, $text );
 280         }
 281
 282         /**
 283          * Returns an escaped string suitable for inclusion in a string literal
 284          * for JavaScript source code.
 285          * Illegal control characters are assumed not to be present.
 286          *
 287          * @param string $string
 288          * @return string
 289          */
 290         public static function escapeJsString( $string ) {
 291                 // See ECMA 262 section 7.8.4 for string literal format
 292                 $pairs = array(
 293                         "\\" => "\\\\",
 294                         "\"" => "\\\"",
 295                         '\'' => '\\\'',
 296                         "\n" => "\\n",
 297                         "\r" => "\\r",
 298
 299                         # To avoid closing the element or CDATA section
 300                         "<" => "\\x3c",
 301                         ">" => "\\x3e",
 302
 303                         # To avoid any complaints about bad entity refs
 304                         "&" => "\\x26",
 305                 );
 306                 return strtr( $string, $pairs );
 307         }
 308
 309         /**
 310          * Encode a variable of unknown type to JavaScript.
 311          * Doesn't support hashtables just yet.
 312          */
 313         public static function encodeJsVar( $value ) {
 314                 if ( is_bool( $value ) ) {
 315                         $s = $value ? 'true' : 'false';
 316                 } elseif ( is_null( $value ) ) {
 317                         $s = 'null';
 318                 } elseif ( is_int( $value ) ) {
 319                         $s = $value;
 320                 } elseif ( is_array( $value ) ) {
 321                         $s = '[';
 322                         foreach ( $value as $name => $elt ) {
 323                                 if ( $s != '[' ) {
 324                                         $s .= ', ';
 325                                 }
 326                                 $s .= self::encodeJsVar( $elt );
 327                         }
 328                         $s .= ']';
 329                 } else {
 330                         $s = '"' . self::escapeJsString( $value ) . '"';
 331                 }
 332                 return $s;
 333         }
 334
 335
 336         /**
 337          * Check if a string is well-formed XML.
 338          * Must include the surrounding tag.
 339          *
 340          * @param $text String: string to test.
 341          * @return bool
 342          *
 343          * @todo Error position reporting return
 344          */
 345         public static function isWellFormed( $text ) {
 346                 $parser = xml_parser_create( "UTF-8" );
 347
 348                 # case folding violates XML standard, turn it off
 349                 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
 350
 351                 if( !xml_parse( $parser, $text, true ) ) {
 352                         //$err = xml_error_string( xml_get_error_code( $parser ) );
 353                         //$position = xml_get_current_byte_index( $parser );
 354                         //$fragment = $this->extractFragment( $html, $position );
 355                         //$this->mXmlError = "$err at byte $position:\n$fragment";
 356                         xml_parser_free( $parser );
 357                         return false;
 358                 }
 359                 xml_parser_free( $parser );
 360                 return true;
 361         }
 362
 363         /**
 364          * Check if a string is a well-formed XML fragment.
 365          * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
 366          * and can use HTML named entities.
 367          *
 368          * @param $text String:
 369          * @return bool
 370          */
 371         public static function isWellFormedXmlFragment( $text ) {
 372                 $html =
 373                         Sanitizer::hackDocType() .
 374                         '<html>' .
 375                         $text .
 376                         '</html>';
 377                 return Xml::isWellFormed( $html );
 378         }
 379
 380         /**
 381          * Replace " > and < with their respective HTML entities ( &quot;,
 382          * &gt;, &lt;)
 383          *
 384          * @param $in String: text that might contain HTML tags.
 385          * @return string Escaped string
 386          */
 387         public static function escapeTagsOnly( $in ) {
 388                 return str_replace(
 389                         array( '"', '>', '<' ),
 390                         array( '&quot;', '&gt;', '&lt;' ),
 391                         $in );
 392         }
 393 }
 394 ?>