X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/Xml.php diff --git a/includes/Xml.php b/includes/Xml.php index 970444fa..00915131 100644 --- a/includes/Xml.php +++ b/includes/Xml.php @@ -1,9 +1,28 @@ , &) are escaped but illegals are not touched. * - * @param $element String: element name - * @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) - * @param $allowShortTag Bool: whether '' in $contents will result in a contentless closed tag + * @param string $element Element name + * @param array $attribs Name=>value pairs. Values will be escaped. + * @param string $contents Null to make an open tag only; '' for a contentless closed tag (default) + * @param bool $allowShortTag Whether '' in $contents will result in a contentless closed tag * @return string */ - public static function element( $element, $attribs = null, $contents = '', $allowShortTag = true ) { + public static function element( $element, $attribs = null, $contents = '', + $allowShortTag = true + ) { $out = '<' . $element; - if( !is_null( $attribs ) ) { - $out .= self::expandAttributes( $attribs ); + if ( !is_null( $attribs ) ) { + $out .= self::expandAttributes( $attribs ); } - if( is_null( $contents ) ) { + if ( is_null( $contents ) ) { $out .= '>'; } else { - if( $allowShortTag && $contents === '' ) { + if ( $allowShortTag && $contents === '' ) { $out .= ' />'; } else { $out .= '>' . htmlspecialchars( $contents ) . ""; @@ -38,15 +59,17 @@ class Xml { * Given an array of ('attributename' => 'value'), it generates the code * to set the XML attributes : attributename="value". * The values are passed to Sanitizer::encodeAttribute. - * Return null if no attributes given. - * @param $attribs Array of attributes for an XML element + * Returns null or empty string if no attributes given. + * @param array|null $attribs Array of attributes for an XML element + * @throws MWException + * @return null|string */ public static function expandAttributes( $attribs ) { $out = ''; - if( is_null( $attribs ) ) { + if ( is_null( $attribs ) ) { return null; - } elseif( is_array( $attribs ) ) { - foreach( $attribs as $name => $val ) { + } elseif ( is_array( $attribs ) ) { + foreach ( $attribs as $name => $val ) { $out .= " {$name}=\"" . Sanitizer::encodeAttribute( $val ) . '"'; } return $out; @@ -60,20 +83,18 @@ class Xml { * $wgContLang->normalize() 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) + * @param string $element + * @param array $attribs Name=>value pairs. Values will be escaped. + * @param string $contents Null to make an open tag only; '' for a contentless closed tag (default) * @return string */ - public static function elementClean( $element, $attribs = array(), $contents = '') { + public static function elementClean( $element, $attribs = [], $contents = '' ) { global $wgContLang; - if( $attribs ) { - $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs ); + if ( $attribs ) { + $attribs = array_map( [ 'UtfNormal\Validator', 'cleanUp' ], $attribs ); } - if( $contents ) { - wfProfileIn( __METHOD__ . '-norm' ); + if ( $contents ) { $contents = $wgContLang->normalize( $contents ); - wfProfileOut( __METHOD__ . '-norm' ); } return self::element( $element, $attribs, $contents ); } @@ -81,8 +102,8 @@ class Xml { /** * This opens an XML element * - * @param $element String name of the element - * @param $attribs array of attributes, see Xml::expandAttributes() + * @param string $element Name of the element + * @param array $attribs Array of attributes, see Xml::expandAttributes() * @return string */ public static function openElement( $element, $attribs = null ) { @@ -91,429 +112,510 @@ class Xml { /** * Shortcut to close an XML element - * @param $element String element name + * @param string $element Element name * @return string */ - public static function closeElement( $element ) { return ""; } + public static function closeElement( $element ) { + return ""; + } /** * Same as Xml::element(), but does not escape contents. Handy when the * content you have is already valid xml. * - * @param $element String element name - * @param $attribs array of attributes - * @param $contents String content of the element + * @param string $element Element name + * @param array $attribs Array of attributes + * @param string $contents Content of the element * @return string */ public static function tags( $element, $attribs = null, $contents ) { return self::openElement( $element, $attribs ) . $contents . ""; } - /** - * Build a drop-down box for selecting a namespace - * - * @param $selected Mixed: Namespace which should be pre-selected - * @param $all Mixed: Value of an item denoting all namespaces, or null to omit - * @param $element_name String: value of the "name" attribute of the select tag - * @param $label String: optional label to add to the field - * @return string - */ - public static function namespaceSelector( $selected = '', $all = null, $element_name = 'namespace', $label = null ) { - global $wgContLang; - $namespaces = $wgContLang->getFormattedNamespaces(); - $options = array(); - - // Godawful hack... we'll be frequently passed selected namespaces - // as strings since PHP is such a shithole. - // But we also don't want blanks and nulls and "all"s matching 0, - // so let's convert *just* string ints to clean ints. - if( preg_match( '/^\d+$/', $selected ) ) { - $selected = intval( $selected ); - } - - if( !is_null( $all ) ) - $namespaces = array( $all => wfMsg( 'namespacesall' ) ) + $namespaces; - foreach( $namespaces as $index => $name ) { - if( $index < NS_MAIN ) { - continue; - } - if( $index === 0 ) { - $name = wfMsg( 'blanknamespace' ); - } - $options[] = self::option( $name, $index, $index === $selected ); - } - - $ret = Xml::openElement( 'select', array( 'id' => 'namespace', 'name' => $element_name, - 'class' => 'namespaceselector' ) ) - . "\n" - . implode( "\n", $options ) - . "\n" - . Xml::closeElement( 'select' ); - if ( !is_null( $label ) ) { - $ret = Xml::label( $label, $element_name ) . ' ' . $ret; - } - return $ret; - } - /** * Create a date selector * - * @param $selected Mixed: the month which should be selected, default '' - * @param $allmonths String: value of a special item denoting all month. Null to not include (default) - * @param $id String: Element identifier - * @return String: Html string containing the month selector + * @param string $selected The month which should be selected, default ''. + * @param string $allmonths Value of a special item denoting all month. + * Null to not include (default). + * @param string $id Element identifier + * @return string Html string containing the month selector */ public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) { global $wgLang; - $options = array(); - if( is_null( $selected ) ) + $options = []; + $data = new XmlSelect( 'month', $id, $selected ); + 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' ); + } + if ( !is_null( $allmonths ) ) { + $options[wfMessage( 'monthsall' )->text()] = $allmonths; + } + for ( $i = 1; $i < 13; $i++ ) { + $options[$wgLang->getMonthName( $i )] = $i; + } + $data->addOptions( $options ); + $data->setAttribute( 'class', 'mw-month-selector' ); + return $data->getHTML(); } /** - * @param $year Integer - * @param $month Integer + * @param int $year + * @param int $month * @return string Formatted HTML */ public static function dateMenu( $year, $month ) { # Offset overrides year/month selection - if( $month && $month !== -1 ) { + if ( $month && $month !== -1 ) { $encMonth = intval( $month ); } else { $encMonth = ''; } - if( $year ) { + if ( $year ) { $encYear = intval( $year ); - } else if( $encMonth ) { - $thisMonth = intval( gmdate( 'n' ) ); - $thisYear = intval( gmdate( 'Y' ) ); - if( intval($encMonth) > $thisMonth ) { + } elseif ( $encMonth ) { + $timestamp = MWTimestamp::getInstance(); + $thisMonth = intval( $timestamp->format( 'n' ) ); + $thisYear = intval( $timestamp->format( '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 ); + $inputAttribs = [ 'id' => 'year', 'maxlength' => 4, 'size' => 7 ]; + return self::label( wfMessage( 'year' )->text(), 'year' ) . ' ' . + Html::input( 'year', $encYear, 'number', $inputAttribs ) . ' ' . + self::label( wfMessage( 'month' )->text(), 'month' ) . ' ' . + self::monthSelector( $encMonth, -1 ); } /** + * Construct a language selector appropriate for use in a form or preferences * - * @param $selected 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 ) { + * @param string $selected The language code of the selected language + * @param bool $customisedOnly If true only languages which have some content are listed + * @param string $inLanguage The ISO code of the language to display the select list in (optional) + * @param array $overrideAttrs Override the attributes of the select tag (since 1.20) + * @param Message|null $msg Label message key (since 1.20) + * @return array Array containing 2 items: label HTML and select list HTML + */ + public static function languageSelector( $selected, $customisedOnly = true, + $inLanguage = null, $overrideAttrs = [], Message $msg = null + ) { global $wgLanguageCode; - /** - * 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( $wgLanguageCode, $languages ) ) { + + $include = $customisedOnly ? 'mwfile' : 'mw'; + $languages = Language::fetchLanguageNames( $inLanguage, $include ); + + // 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 ); /** * 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. + * with Afrikaans since it's first in the list. */ $selected = isset( $languages[$selected] ) ? $selected : $wgLanguageCode; $options = "\n"; - foreach( $languages as $code => $name ) { - $options .= Xml::option( "$code - $name", $code, ($code == $selected) ) . "\n"; + foreach ( $languages as $code => $name ) { + $options .= self::option( "$code - $name", $code, $code == $selected ) . "\n"; } - return array( - Xml::label( wfMsg('yourlanguage'), 'wpUserLanguage' ), - Xml::tags( 'select', - array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ), - $options - ) - ); + $attrs = [ 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ]; + $attrs = array_merge( $attrs, $overrideAttrs ); + if ( $msg === null ) { + $msg = wfMessage( 'yourlanguage' ); + } + return [ + self::label( $msg->text(), $attrs['id'] ), + self::tags( 'select', $attrs, $options ) + ]; } /** * Shortcut to make a span element - * @param $text String content of the element, will be escaped - * @param $class String class name of the span element - * @param $attribs other attributes + * @param string $text Content of the element, will be escaped + * @param string $class Class name of the span element + * @param array $attribs Other attributes * @return string */ - public static function span( $text, $class, $attribs=array() ) { - return self::element( 'span', array( 'class' => $class ) + $attribs, $text ); + public static function span( $text, $class, $attribs = [] ) { + return self::element( 'span', [ 'class' => $class ] + $attribs, $text ); } /** * Shortcut to make a specific element with a class attribute - * @param $text content of the element, will be escaped - * @param $class class name of the span element - * @param $tag element name - * @param $attribs other attributes + * @param string $text Content of the element, will be escaped + * @param string $class Class name of the span element + * @param string $tag Element name + * @param array $attribs Other attributes * @return string */ - public static function wrapClass( $text, $class, $tag='span', $attribs=array() ) { - return self::tags( $tag, array( 'class' => $class ) + $attribs, $text ); + public static function wrapClass( $text, $class, $tag = 'span', $attribs = [] ) { + return self::tags( $tag, [ 'class' => $class ] + $attribs, $text ); } /** * Convenience function to build an HTML text input field - * @param $name String value of the name attribute - * @param $size value of the size attribute - * @param $value value of the value attribute - * @param $attribs other attributes + * @param string $name Value of the name attribute + * @param int $size Value of the size attribute + * @param mixed $value Value of the value attribute + * @param array $attribs Other attributes * @return string HTML */ - public static function input( $name, $size=false, $value=false, $attribs=array() ) { - $attributes = array( 'name' => $name ); + public static function input( $name, $size = false, $value = false, $attribs = [] ) { + $attributes = [ 'name' => $name ]; - if( $size ) { + if ( $size ) { $attributes['size'] = $size; } - if( $value !== false ) { // maybe 0 + if ( $value !== false ) { // maybe 0 $attributes['value'] = $value; } - return self::element( 'input', $attributes + $attribs ); + return self::element( 'input', + Html::getTextInputAttributes( $attributes + $attribs ) ); } /** * Convenience function to build an HTML password input field - * @param $name value of the name attribute - * @param $size value of the size attribute - * @param $value value of the value attribute - * @param $attribs other attributes + * @param string $name Value of the name attribute + * @param int $size Value of the size attribute + * @param mixed $value Value of the value attribute + * @param array $attribs Other attributes * @return string HTML */ - 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 password( $name, $size = false, $value = false, + $attribs = [] + ) { + return self::input( $name, $size, $value, + array_merge( $attribs, [ 'type' => 'password' ] ) ); } /** * Internal function for use in checkboxes and radio buttons and such. + * + * @param string $name + * @param bool $present + * * @return array */ public static function attrib( $name, $present = true ) { - return $present ? array( $name => $name ) : array(); + return $present ? [ $name => $name ] : []; } /** * Convenience function to build an HTML checkbox - * @param $name String value of the name attribute - * @param $checked Bool Whether the checkbox is checked or not - * @param $attribs Array other attributes + * @param string $name Value of the name attribute + * @param bool $checked Whether the checkbox is checked or not + * @param array $attribs Array other attributes * @return string HTML */ - public static function check( $name, $checked=false, $attribs=array() ) { + public static function check( $name, $checked = false, $attribs = [] ) { return self::element( 'input', array_merge( - array( + [ 'name' => $name, 'type' => 'checkbox', - 'value' => 1 ), + 'value' => 1 ], self::attrib( 'checked', $checked ), $attribs ) ); } /** * Convenience function to build an HTML radio button - * @param $name value of the name attribute - * @param $value value of the value attribute - * @param $checked Whether the checkbox is checked or not - * @param $attribs other attributes + * @param string $name Value of the name attribute + * @param string $value Value of the value attribute + * @param bool $checked Whether the checkbox is checked or not + * @param array $attribs Other attributes * @return string HTML */ - public static function radio( $name, $value, $checked=false, $attribs=array() ) { - return self::element( 'input', array( + public static function radio( $name, $value, $checked = false, $attribs = [] ) { + return self::element( 'input', [ 'name' => $name, 'type' => 'radio', - 'value' => $value ) + self::attrib( 'checked', $checked ) + $attribs ); + 'value' => $value ] + self::attrib( 'checked', $checked ) + $attribs ); } /** * Convenience function to build an HTML form label - * @param $label String text of the label - * @param $id - * @param $attribs Array an attribute array. This will usuall be + * @param string $label Text of the label + * @param string $id + * @param array $attribs An attribute array. This will usually be * the same array as is passed to the corresponding input element, - * so this function will cherry-pick appropriate attributes to - * apply to the label as well; currently only class is applied. + * so this function will cherry-pick appropriate attributes to + * apply to the label as well; only class and title are applied. * @return string HTML */ - public static function label( $label, $id, $attribs=array() ) { - $a = array( 'for' => $id ); - if( isset( $attribs['class'] ) ){ - $a['class'] = $attribs['class']; + public static function label( $label, $id, $attribs = [] ) { + $a = [ 'for' => $id ]; + + foreach ( [ 'class', 'title' ] as $attr ) { + if ( isset( $attribs[$attr] ) ) { + $a[$attr] = $attribs[$attr]; + } } + return self::element( 'label', $a, $label ); } /** * Convenience function to build an HTML text input field with a label - * @param $label String text of the label - * @param $name String value of the name attribute - * @param $id String id of the input - * @param $size value of the size attribute - * @param $value value of the value attribute - * @param $attribs other attributes + * @param string $label Text of the label + * @param string $name Value of the name attribute + * @param string $id Id of the input + * @param int|bool $size Value of the size attribute + * @param string|bool $value Value of the value attribute + * @param array $attribs Other attributes * @return string HTML */ - public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) { + public static function inputLabel( $label, $name, $id, $size = false, + $value = false, $attribs = [] + ) { list( $label, $input ) = self::inputLabelSep( $label, $name, $id, $size, $value, $attribs ); return $label . ' ' . $input; } /** * Same as Xml::inputLabel() but return input and label in an array + * + * @param string $label + * @param string $name + * @param string $id + * @param int|bool $size + * @param string|bool $value + * @param array $attribs + * + * @return array */ - 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 inputLabelSep( $label, $name, $id, $size = false, + $value = false, $attribs = [] + ) { + return [ + self::label( $label, $id, $attribs ), + self::input( $name, $size, $value, [ 'id' => $id ] + $attribs ) + ]; } /** * Convenience function to build an HTML checkbox with a label + * + * @param string $label + * @param string $name + * @param string $id + * @param bool $checked + * @param array $attribs + * * @return string HTML */ - public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) { - return self::check( $name, $checked, array( 'id' => $id ) + $attribs ) . + public static function checkLabel( $label, $name, $id, $checked = false, $attribs = [] ) { + global $wgUseMediaWikiUIEverywhere; + $chkLabel = self::check( $name, $checked, [ 'id' => $id ] + $attribs ) . ' ' . self::label( $label, $id, $attribs ); + + if ( $wgUseMediaWikiUIEverywhere ) { + $chkLabel = self::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) . + $chkLabel . self::closeElement( 'div' ); + } + return $chkLabel; } /** * Convenience function to build an HTML radio button with a label + * + * @param string $label + * @param string $name + * @param string $value + * @param string $id + * @param bool $checked + * @param array $attribs + * * @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 ) . + public static function radioLabel( $label, $name, $value, $id, + $checked = false, $attribs = [] + ) { + return self::radio( $name, $value, $checked, [ 'id' => $id ] + $attribs ) . ' ' . self::label( $label, $id, $attribs ); } /** * Convenience function to build an HTML submit button - * @param $value String: label text for the button - * @param $attribs Array: optional custom attributes + * When $wgUseMediaWikiUIEverywhere is true it will default to a progressive button + * @param string $value Label text for the button + * @param array $attribs Optional custom attributes * @return string HTML */ - public static function submitButton( $value, $attribs=array() ) { - return Html::element( 'input', array( 'type' => 'submit', 'value' => $value ) + $attribs ); - } - - /** - * @deprecated Synonymous to Html::hidden() - */ - public static function hidden( $name, $value, $attribs = array() ) { - return Html::hidden( $name, $value, $attribs ); + public static function submitButton( $value, $attribs = [] ) { + global $wgUseMediaWikiUIEverywhere; + $baseAttrs = [ + 'type' => 'submit', + 'value' => $value, + ]; + // Done conditionally for time being as it is possible + // some submit forms + // might need to be mw-ui-destructive (e.g. delete a page) + if ( $wgUseMediaWikiUIEverywhere ) { + $baseAttrs['class'] = 'mw-ui-button mw-ui-progressive'; + } + // Any custom attributes will take precendence of anything in baseAttrs e.g. override the class + $attribs = $attribs + $baseAttrs; + return Html::element( 'input', $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 + * @param string $text Text for this item. Will be HTML escaped + * @param string $value Form submission value; if empty, use text + * @param bool $selected If true, will be the default selected item + * @param array $attribs Optional additional HTML attributes * @return string HTML */ - public static function option( $text, $value=null, $selected=false, - $attribs=array() ) { - if( !is_null( $value ) ) { + public static function option( $text, $value = null, $selected = false, + $attribs = [] ) { + if ( !is_null( $value ) ) { $attribs['value'] = $value; } - if( $selected ) { + if ( $selected ) { $attribs['selected'] = 'selected'; } - return self::element( 'option', $attribs, $text ); + return Html::element( 'option', $attribs, $text ); } /** - * Build a drop-down box from a textual list. + * Build a drop-down box from a textual list. This is a wrapper + * for Xml::listDropDownOptions() plus the XmlSelect class. * - * @param $name Mixed: Name and id for the drop-down - * @param $class Mixed: CSS classes for the drop-down - * @param $other Mixed: Text for the "Other reasons" option - * @param $list Mixed: Correctly formatted text to be used to generate the options - * @param $selected Mixed: Option which should be pre-selected - * @param $tabindex Mixed: Value of the tabindex attribute + * @param string $name Name and id for the drop-down + * @param string $list Correctly formatted text (newline delimited) to be + * used to generate the options. + * @param string $other Text for the "Other reasons" option + * @param string $selected Option which should be pre-selected + * @param string $class CSS classes for the drop-down + * @param int $tabindex Value of the tabindex attribute * @return string */ - public static function listDropDown( $name= '', $list = '', $other = '', $selected = '', $class = '', $tabindex = Null ) { - $optgroup = false; + public static function listDropDown( $name = '', $list = '', $other = '', + $selected = '', $class = '', $tabindex = null + ) { + $options = self::listDropDownOptions( $list, [ 'other' => $other ] ); + + $xmlSelect = new XmlSelect( $name, $name, $selected ); + $xmlSelect->addOptions( $options ); + + if ( $class ) { + $xmlSelect->setAttribute( 'class', $class ); + } + if ( $tabindex ) { + $xmlSelect->setAttribute( 'tabindex', $tabindex ); + } + + return $xmlSelect->getHTML(); + } + + /** + * Build options for a drop-down box from a textual list. + * + * The result of this function can be passed to XmlSelect::addOptions() + * (to render a plain `