Xml.php

Go to the documentation of this file.

<?php

class Xml {
        public static function element( $element, $attribs = null, $contents = '', $allowShortTag = true ) {
                $out = '<' . $element;
                if( !is_null( $attribs ) ) {
                        $out .=  self::expandAttributes( $attribs );
                }
                if( is_null( $contents ) ) {
                        $out .= '>';
                } else {
                        if( $allowShortTag && $contents === '' ) {
                                $out .= ' />';
                        } else {
                                $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
                        }
                }
                return $out;
        }

        public static function expandAttributes( $attribs ) {
                $out = '';
                if( is_null( $attribs ) ) {
                        return null;
                } elseif( is_array( $attribs ) ) {
                        foreach( $attribs as $name => $val ) {
                                $out .= " {$name}=\"" . Sanitizer::encodeAttribute( $val ) . '"';
                        }
                        return $out;
                } else {
                        throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__ );
                }
        }

        public static function elementClean( $element, $attribs = array(), $contents = '') {
                global $wgContLang;
                if( $attribs ) {
                        $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
                }
                if( $contents ) {
                        wfProfileIn( __METHOD__ . '-norm' );
                        $contents = $wgContLang->normalize( $contents );
                        wfProfileOut( __METHOD__ . '-norm' );
                }
                return self::element( $element, $attribs, $contents );
        }

        public static function openElement( $element, $attribs = null ) {
                return '<' . $element . self::expandAttributes( $attribs ) . '>';
        }

        public static function closeElement( $element ) { return "</$element>"; }

        public static function tags( $element, $attribs = null, $contents ) {
                return self::openElement( $element, $attribs ) . $contents . "</$element>";
        }

        public static function namespaceSelector( $selected = '', $all = null, $element_name = 'namespace', $label = null ) {
                wfDeprecated( __METHOD__, '1.19' );
                return Html::namespaceSelector( array(
                        'selected' => $selected,
                        'all'      => $all,
                        'label'    => $label,
                ), array(
                        'name'  => $element_name,
                        'id'    => 'namespace',
                        'class' => 'namespaceselector',
                ) );
        }

        public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
                global $wgLang;
                $options = array();
                if( is_null( $selected ) )
                        $selected = '';
                if( !is_null( $allmonths ) )
                        $options[] = self::option( wfMsg( 'monthsall' ), $allmonths, $selected === $allmonths );
                for( $i = 1; $i < 13; $i++ )
                        $options[] = self::option( $wgLang->getMonthName( $i ), $i, $selected === $i );
                return self::openElement( 'select', array( 'id' => $id, 'name' => 'month', 'class' => 'mw-month-selector' ) )
                        . implode( "\n", $options )
                        . self::closeElement( 'select' );
        }

        public static function dateMenu( $year, $month ) {
                # Offset overrides year/month selection
                if( $month && $month !== -1 ) {
                        $encMonth = intval( $month );
                } else {
                        $encMonth = '';
                }
                if( $year ) {
                        $encYear = intval( $year );
                } elseif( $encMonth ) {
                        $thisMonth = intval( gmdate( 'n' ) );
                        $thisYear = intval( gmdate( 'Y' ) );
                        if( intval($encMonth) > $thisMonth ) {
                                $thisYear--;
                        }
                        $encYear = $thisYear;
                } else {
                        $encYear = '';
                }
                return Xml::label( wfMsg( 'year' ), 'year' ) . ' '.
                        Xml::input( 'year', 4, $encYear, array('id' => 'year', 'maxlength' => 4) ) . ' '.
                        Xml::label( wfMsg( 'month' ), 'month' ) . ' '.
                        Xml::monthSelector( $encMonth, -1 );
        }

        public static function languageSelector( $selected, $customisedOnly = true, $language = null ) {
                global $wgLanguageCode;

                // If a specific language was requested and CLDR is installed, use it
                if ( $language && is_callable( array( 'LanguageNames', 'getNames' ) ) ) {
                        if ( $customisedOnly ) {
                                $listType = LanguageNames::LIST_MW_SUPPORTED; // Only pull names that have localisation in MediaWiki
                        } else {
                                $listType = LanguageNames::LIST_MW; // Pull all languages that are in Names.php
                        }
                        // Retrieve the list of languages in the requested language (via CLDR)
                        $languages = LanguageNames::getNames(
                                $language, // Code of the requested language
                                LanguageNames::FALLBACK_NORMAL, // Use fallback chain
                                $listType
                        );
                } else {
                        $languages = Language::getLanguageNames( $customisedOnly );
                }
                
                // Make sure the site language is in the list; a custom language code might not have a
                // defined name...
                if( !array_key_exists( $wgLanguageCode, $languages ) ) {
                        $languages[$wgLanguageCode] = $wgLanguageCode;
                }
                
                ksort( $languages );

                $selected = isset( $languages[$selected] ) ? $selected : $wgLanguageCode;
                $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 );
        }

        public static function wrapClass( $text, $class, $tag = 'span', $attribs = array() ) {
                return self::tags( $tag, array( 'class' => $class ) + $attribs, $text );
        }

        public static function input( $name, $size = false, $value = false, $attribs = array() ) {
                $attributes = array( 'name' => $name );

                if( $size ) {
                        $attributes['size'] = $size;
                }

                if( $value !== false ) { // maybe 0
                        $attributes['value'] = $value;
                }

                return self::element( 'input', $attributes + $attribs );
        }

        public static function password( $name, $size = false, $value = false, $attribs = array() ) {
                return self::input( $name, $size, $value, array_merge( $attribs, array( 'type' => 'password' ) ) );
        }

        public static function attrib( $name, $present = true ) {
                return $present ? array( $name => $name ) : array();
        }

        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 ) );
        }

        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 );
        }

        public static function label( $label, $id, $attribs = array() ) {
                $a = array( 'for' => $id );

                # FIXME avoid copy pasting below:
                if( isset( $attribs['class'] ) ){
                                $a['class'] = $attribs['class'];
                }
                if( isset( $attribs['title'] ) ){
                                $a['title'] = $attribs['title'];
                }

                return self::element( 'label', $a, $label );
        }

        public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs = array() ) {
                list( $label, $input ) = self::inputLabelSep( $label, $name, $id, $size, $value, $attribs );
                return $label . '&#160;' . $input;
        }

        public static function inputLabelSep( $label, $name, $id, $size = false, $value = false, $attribs = array() ) {
                return array(
                        Xml::label( $label, $id, $attribs ),
                        self::input( $name, $size, $value, array( 'id' => $id ) + $attribs )
                );
        }

        public static function checkLabel( $label, $name, $id, $checked = false, $attribs = array() ) {
                return self::check( $name, $checked, array( 'id' => $id ) + $attribs ) .
                        '&#160;' .
                        self::label( $label, $id, $attribs );
        }

        public static function radioLabel( $label, $name, $value, $id, $checked = false, $attribs = array() ) {
                return self::radio( $name, $value, $checked, array( 'id' => $id ) + $attribs ) .
                        '&#160;' .
                        self::label( $label, $id, $attribs );
        }

        public static function submitButton( $value, $attribs = array() ) {
                return Html::element( 'input', array( 'type' => 'submit', 'value' => $value ) + $attribs );
        }

        public static function option( $text, $value=null, $selected = false,
                        $attribs = array() ) {
                if( !is_null( $value ) ) {
                        $attribs['value'] = $value;
                }
                if( $selected ) {
                        $attribs['selected'] = 'selected';
                }
                return Html::element( 'option', $attribs, $text );
        }

        public static function listDropDown( $name= '', $list = '', $other = '', $selected = '', $class = '', $tabindex = null ) {
                $optgroup = false;

                $options = self::option( $other, 'other', $selected === 'other' );

                foreach ( explode( "\n", $list ) as $option) {
                                $value = trim( $option );
                                if ( $value == '' ) {
                                        continue;
                                } elseif ( substr( $value, 0, 1) == '*' && substr( $value, 1, 1) != '*' ) {
                                        // A new group is starting ...
                                        $value = trim( substr( $value, 1 ) );
                                        if( $optgroup ) $options .= self::closeElement('optgroup');
                                        $options .= self::openElement( 'optgroup', array( 'label' => $value ) );
                                        $optgroup = true;
                                } elseif ( substr( $value, 0, 2) == '**' ) {
                                        // groupmember
                                        $value = trim( substr( $value, 2 ) );
                                        $options .= self::option( $value, $value, $selected === $value );
                                } else {
                                        // groupless reason list
                                        if( $optgroup ) $options .= self::closeElement('optgroup');
                                        $options .= self::option( $value, $value, $selected === $value );
                                        $optgroup = false;
                                }
                        }

                        if( $optgroup ) $options .= self::closeElement('optgroup');

                $attribs = array();

                if( $name ) {
                        $attribs['id'] = $name;
                        $attribs['name'] = $name;
                }

                if( $class ) {
                        $attribs['class'] = $class;
                }

                if( $tabindex ) {
                        $attribs['tabindex'] = $tabindex;
                }

                return Xml::openElement( 'select', $attribs )
                        . "\n"
                        . $options
                        . "\n"
                        . Xml::closeElement( 'select' );
        }

        public static function fieldset( $legend = false, $content = false, $attribs = array() ) {
                $s = Xml::openElement( 'fieldset', $attribs ) . "\n";

                if ( $legend ) {
                        $s .= Xml::element( 'legend', null, $legend ) . "\n";
                }

                if ( $content !== false ) {
                        $s .= $content . "\n";
                        $s .= Xml::closeElement( 'fieldset' ) . "\n";
                }

                return $s;
        }

        public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = array() ) {
                return self::element( 'textarea',
                                        array(  'name' => $name,
                                                'id' => $name,
                                                'cols' => $cols,
                                                'rows' => $rows
                                        ) + $attribs,
                                        $content, false );
        }

        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",

                        # Work around https://bugzilla.mozilla.org/show_bug.cgi?id=274152
                        # Encode certain Unicode formatting chars so affected
                        # versions of Gecko don't misinterpret our strings;
                        # this is a common problem with Farsi text.
                        "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
                        "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
                );

                return strtr( $string, $pairs );
        }

        public static function encodeJsVar( $value ) {
                if ( is_bool( $value ) ) {
                        $s = $value ? 'true' : 'false';
                } elseif ( is_null( $value ) ) {
                        $s = 'null';
                } elseif ( is_int( $value ) || is_float( $value ) ) {
                        $s = strval($value);
                } elseif ( is_array( $value ) && // Make sure it's not associative.
                                        array_keys($value) === range( 0, count($value) - 1 ) ||
                                        count($value) == 0
                                ) {
                        $s = '[';
                        foreach ( $value as $elt ) {
                                if ( $s != '[' ) {
                                        $s .= ',';
                                }
                                $s .= self::encodeJsVar( $elt );
                        }
                        $s .= ']';
                } elseif ( $value instanceof XmlJsCode ) {
                        $s = $value->value;
                } elseif ( is_object( $value ) || is_array( $value ) ) {
                        // Objects and associative arrays
                        $s = '{';
                        foreach ( (array)$value as $name => $elt ) {
                                if ( $s != '{' ) {
                                        $s .= ',';
                                }

                                $s .= '"' . self::escapeJsString( $name ) . '":' .
                                        self::encodeJsVar( $elt );
                        }
                        $s .= '}';
                } else {
                        $s = '"' . self::escapeJsString( $value ) . '"';
                }
                return $s;
        }

        public static function encodeJsCall( $name, $args ) {
                $s = "$name(";
                $first = true;

                foreach ( $args as $arg ) {
                        if ( $first ) {
                                $first = false;
                        } else {
                                $s .= ', ';
                        }

                        $s .= Xml::encodeJsVar( $arg );
                }

                $s .= ");\n";

                return $s;
        }

        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;
        }

        public static function isWellFormedXmlFragment( $text ) {
                $html =
                        Sanitizer::hackDocType() .
                        '<html>' .
                        $text .
                        '</html>';

                return Xml::isWellFormed( $html );
        }

        public static function escapeTagsOnly( $in ) {
                return str_replace(
                        array( '"', '>', '<' ),
                        array( '&quot;', '&gt;', '&lt;' ),
                        $in );
        }

        public static function buildForm( $fields, $submitLabel = null ) {
                $form = '';
                $form .= "<table><tbody>";

                foreach( $fields as $labelmsg => $input ) {
                        $id = "mw-$labelmsg";
                        $form .= Xml::openElement( 'tr', array( 'id' => $id ) );
                        $form .= Xml::tags( 'td', array('class' => 'mw-label'), wfMsgExt( $labelmsg, array('parseinline') ) );
                        $form .= Xml::openElement( 'td', array( 'class' => 'mw-input' ) ) . $input . Xml::closeElement( 'td' );
                        $form .= Xml::closeElement( 'tr' );
                }

                if( $submitLabel ) {
                        $form .= Xml::openElement( 'tr' );
                        $form .= Xml::tags( 'td', array(), '' );
                        $form .= Xml::openElement( 'td', array( 'class' => 'mw-submit' ) ) . Xml::submitButton( wfMsg( $submitLabel ) ) . Xml::closeElement( 'td' );
                        $form .= Xml::closeElement( 'tr' );
                }

                $form .= "</tbody></table>";

                return $form;
        }

        public static function buildTable( $rows, $attribs = array(), $headers = null ) {
                $s = Xml::openElement( 'table', $attribs );

                if ( is_array( $headers ) ) {
                        $s .= Xml::openElement( 'thead', $attribs );

                        foreach( $headers as $id => $header ) {
                                $attribs = array();

                                if ( is_string( $id ) ) {
                                        $attribs['id'] = $id;
                                }

                                $s .= Xml::element( 'th', $attribs, $header );
                        }
                        $s .= Xml::closeElement( 'thead' );
                }

                foreach( $rows as $id => $row ) {
                        $attribs = array();

                        if ( is_string( $id ) ) {
                                $attribs['id'] = $id;
                        }

                        $s .= Xml::buildTableRow( $attribs, $row );
                }

                $s .= Xml::closeElement( 'table' );

                return $s;
        }

        public static function buildTableRow( $attribs, $cells ) {
                $s = Xml::openElement( 'tr', $attribs );

                foreach( $cells as $id => $cell ) {

                        $attribs = array();

                        if ( is_string( $id ) ) {
                                $attribs['id'] = $id;
                        }

                        $s .= Xml::element( 'td', $attribs, $cell );
                }

                $s .= Xml::closeElement( 'tr' );

                return $s;
        }
}

class XmlSelect {
        protected $options = array();
        protected $default = false;
        protected $attributes = array();

        public function __construct( $name = false, $id = false, $default = false ) {
                if ( $name ) {
                        $this->setAttribute( 'name', $name );
                }

                if ( $id ) {
                        $this->setAttribute( 'id', $id );
                }

                if ( $default !== false ) {
                        $this->default = $default;
                }
        }

        public function setDefault( $default ) {
                $this->default = $default;
        }

        public function setAttribute( $name, $value ) {
                $this->attributes[$name] = $value;
        }

        public function getAttribute( $name ) {
                if ( isset( $this->attributes[$name] ) ) {
                        return $this->attributes[$name];
                } else {
                        return null;
                }
        }

        public function addOption( $name, $value = false ) {
                // Stab stab stab
                $value = ($value !== false) ? $value : $name;

                $this->options[] = array( $name => $value );
        }

        public function addOptions( $options ) {
                $this->options[] = $options;
        }

        static function formatOptions( $options, $default = false ) {
                $data = '';

                foreach( $options as $label => $value ) {
                        if ( is_array( $value ) ) {
                                $contents = self::formatOptions( $value, $default );
                                $data .= Html::rawElement( 'optgroup', array( 'label' => $label ), $contents ) . "\n";
                        } else {
                                $data .= Xml::option( $label, $value, $value === $default ) . "\n";
                        }
                }

                return $data;
        }

        public function getHTML() {
                $contents = '';

                foreach ( $this->options as $options ) {
                        $contents .= self::formatOptions( $options, $this->default );
                }

                return Html::rawElement( 'select', $this->attributes, rtrim( $contents ) );
        }
}

class XmlJsCode {
        public $value;

        function __construct( $value ) {
                $this->value = $value;
        }
}