1 files changed, 197 insertions, 0 deletions
diff --git a/www/wiki/includes/htmlform/fields/HTMLAutoCompleteSelectField.php b/www/wiki/includes/htmlform/fields/HTMLAutoCompleteSelectField.php
new file mode 100644
index 00000000..63e77cec
--- /dev/null
+++ b/www/wiki/includes/htmlform/fields/HTMLAutoCompleteSelectField.php
@@ -0,0 +1,197 @@
+<?php
+
+/**
+ * Text field for selecting a value from a large list of possible values, with
+ * auto-completion and optionally with a select dropdown for selecting common
+ * options.
+ *
+ * HTMLComboboxField implements most of the same functionality and should be
+ * used instead, if possible.
+ *
+ * If one of 'options-messages', 'options', or 'options-message' is provided
+ * and non-empty, the select dropdown will be shown. An 'other' key will be
+ * appended using message 'htmlform-selectorother-other' if not already
+ * present.
+ *
+ * Besides the parameters recognized by HTMLTextField, the following are
+ * recognized:
+ *   options-messages - As for HTMLSelectField
+ *   options - As for HTMLSelectField
+ *   options-message - As for HTMLSelectField
+ *   autocomplete-data - Associative array mapping display text to values.
+ *   autocomplete-data-messages - Like autocomplete, but keys are message names.
+ *   require-match - Boolean, if true the value must be in the options or the
+ *     autocomplete.
+ *   other-message - Message to use instead of htmlform-selectorother-other for
+ *      the 'other' message.
+ *   other - Raw text to use for the 'other' message
+ *
+ * The old name of autocomplete-data[-messages] was autocomplete[-messages] which is still
+ * recognized but deprecated since MediaWiki 1.29 since it conflicts with how autocomplete is
+ * used in HTMLTextField.
+ */
+class HTMLAutoCompleteSelectField extends HTMLTextField {
+	protected $autocompleteData = [];
+
+	public function __construct( $params ) {
+		$params += [
+			'require-match' => false,
+		];
+
+		// FIXME B/C, remove in 1.30
+		if (
+			array_key_exists( 'autocomplete', $params )
+			&& !array_key_exists( 'autocomplete-data', $params )
+		) {
+			$params['autocomplete-data'] = $params['autocomplete'];
+			unset( $params['autocomplete'] );
+		}
+		if (
+			array_key_exists( 'autocomplete-messages', $params )
+			&& !array_key_exists( 'autocomplete-data-messages', $params )
+		) {
+			$params['autocomplete-data-messages'] = $params['autocomplete-messages'];
+			unset( $params['autocomplete-messages'] );
+		}
+
+		parent::__construct( $params );
+
+		if ( array_key_exists( 'autocomplete-data-messages', $this->mParams ) ) {
+			foreach ( $this->mParams['autocomplete-data-messages'] as $key => $value ) {
+				$key = $this->msg( $key )->plain();
+				$this->autocompleteData[$key] = strval( $value );
+			}
+		} elseif ( array_key_exists( 'autocomplete-data', $this->mParams ) ) {
+			foreach ( $this->mParams['autocomplete-data'] as $key => $value ) {
+				$this->autocompleteData[$key] = strval( $value );
+			}
+		}
+		if ( !is_array( $this->autocompleteData ) || !$this->autocompleteData ) {
+			throw new MWException( 'HTMLAutoCompleteSelectField called without any autocompletions' );
+		}
+
+		$this->getOptions();
+		if ( $this->mOptions && !in_array( 'other', $this->mOptions, true ) ) {
+			if ( isset( $params['other-message'] ) ) {
+				$msg = $this->getMessage( $params['other-message'] )->text();
+			} elseif ( isset( $params['other'] ) ) {
+				$msg = $params['other'];
+			} else {
+				$msg = wfMessage( 'htmlform-selectorother-other' )->text();
+			}
+			$this->mOptions[$msg] = 'other';
+		}
+	}
+
+	public function loadDataFromRequest( $request ) {
+		if ( $request->getCheck( $this->mName ) ) {
+			$val = $request->getText( $this->mName . '-select', 'other' );
+
+			if ( $val === 'other' ) {
+				$val = $request->getText( $this->mName );
+				if ( isset( $this->autocompleteData[$val] ) ) {
+					$val = $this->autocompleteData[$val];
+				}
+			}
+
+			return $val;
+		} else {
+			return $this->getDefault();
+		}
+	}
+
+	public function validate( $value, $alldata ) {
+		$p = parent::validate( $value, $alldata );
+
+		if ( $p !== true ) {
+			return $p;
+		}
+
+		$validOptions = HTMLFormField::flattenOptions( $this->getOptions() ?: [] );
+
+		if ( in_array( strval( $value ), $validOptions, true ) ) {
+			return true;
+		} elseif ( in_array( strval( $value ), $this->autocompleteData, true ) ) {
+			return true;
+		} elseif ( $this->mParams['require-match'] ) {
+			return $this->msg( 'htmlform-select-badoption' );
+		}
+
+		return true;
+	}
+
+	// FIXME Ewww, this shouldn't be adding any attributes not requested in $list :(
+	public function getAttributes( array $list ) {
+		$attribs = [
+			'type' => 'text',
+			'data-autocomplete' => FormatJson::encode( array_keys( $this->autocompleteData ) ),
+		] + parent::getAttributes( $list );
+
+		if ( $this->getOptions() ) {
+			$attribs['data-hide-if'] = FormatJson::encode(
+				[ '!==', $this->mName . '-select', 'other' ]
+			);
+		}
+
+		return $attribs;
+	}
+
+	public function getInputHTML( $value ) {
+		$oldClass = $this->mClass;
+		$this->mClass = (array)$this->mClass;
+
+		$valInSelect = false;
+		$ret = '';
+
+		if ( $this->getOptions() ) {
+			if ( $value !== false ) {
+				$value = strval( $value );
+				$valInSelect = in_array(
+					$value, HTMLFormField::flattenOptions( $this->getOptions() ), true
+				);
+			}
+
+			$selected = $valInSelect ? $value : 'other';
+			$select = new XmlSelect( $this->mName . '-select', $this->mID . '-select', $selected );
+			$select->addOptions( $this->getOptions() );
+			$select->setAttribute( 'class', 'mw-htmlform-select-or-other' );
+
+			if ( !empty( $this->mParams['disabled'] ) ) {
+				$select->setAttribute( 'disabled', 'disabled' );
+			}
+
+			if ( isset( $this->mParams['tabindex'] ) ) {
+				$select->setAttribute( 'tabindex', $this->mParams['tabindex'] );
+			}
+
+			$ret = $select->getHTML() . "<br />\n";
+
+			$this->mClass[] = 'mw-htmlform-hide-if';
+		}
+
+		if ( $valInSelect ) {
+			$value = '';
+		} else {
+			$key = array_search( strval( $value ), $this->autocompleteData, true );
+			if ( $key !== false ) {
+				$value = $key;
+			}
+		}
+
+		$this->mClass[] = 'mw-htmlform-autocomplete';
+		$ret .= parent::getInputHTML( $valInSelect ? '' : $value );
+		$this->mClass = $oldClass;
+
+		return $ret;
+	}
+
+	/**
+	 * Get the OOUI version of this input.
+	 * @param string $value
+	 * @return false
+	 */
+	public function getInputOOUI( $value ) {
+		// To be implemented, for now override the function from HTMLTextField
+		return false;
+	}
+}