1 files changed, 116 insertions, 0 deletions
diff --git a/www/wiki/includes/htmlform/fields/HTMLUserTextField.php b/www/wiki/includes/htmlform/fields/HTMLUserTextField.php
new file mode 100644
index 00000000..e1939705
--- /dev/null
+++ b/www/wiki/includes/htmlform/fields/HTMLUserTextField.php
@@ -0,0 +1,116 @@
+<?php
+
+use MediaWiki\Widget\UserInputWidget;
+
+/**
+ * Implements a text input field for user names.
+ * Automatically auto-completes if using the OOUI display format.
+ *
+ * FIXME: Does not work for forms that support GET requests.
+ *
+ * Optional parameters:
+ * 'exists' - Whether to validate that the user already exists
+ * 'ipallowed' - Whether an IP adress is interpreted as "valid"
+ * 'iprange' - Whether an IP adress range is interpreted as "valid"
+ * 'iprangelimits' - Specifies the valid IP ranges for IPv4 and IPv6 in an array.
+ *  defaults to IPv4 => 16; IPv6 => 32.
+ *
+ * @since 1.26
+ */
+class HTMLUserTextField extends HTMLTextField {
+	public function __construct( $params ) {
+		$params = wfArrayPlus2d( $params, [
+				'exists' => false,
+				'ipallowed' => false,
+				'iprange' => false,
+				'iprangelimits' => [
+					'IPv4' => '16',
+					'IPv6' => '32',
+				],
+			]
+		);
+
+		parent::__construct( $params );
+	}
+
+	public function validate( $value, $alldata ) {
+		// check, if a user exists with the given username
+		$user = User::newFromName( $value, false );
+		$rangeError = null;
+
+		if ( !$user ) {
+			return $this->msg( 'htmlform-user-not-valid', $value );
+		} elseif (
+			// check, if the user exists, if requested
+			( $this->mParams['exists'] && $user->getId() === 0 ) &&
+			// check, if the username is a valid IP address, otherweise save the error message
+			!( $this->mParams['ipallowed'] && IP::isValid( $value ) ) &&
+			// check, if the username is a valid IP range, otherwise save the error message
+			!( $this->mParams['iprange'] && ( $rangeError = $this->isValidIPRange( $value ) ) === true )
+		) {
+			if ( is_string( $rangeError ) ) {
+				return $rangeError;
+			}
+			return $this->msg( 'htmlform-user-not-exists', $user->getName() );
+		}
+
+		return parent::validate( $value, $alldata );
+	}
+
+	protected function isValidIPRange( $value ) {
+		$cidrIPRanges = $this->mParams['iprangelimits'];
+
+		if ( !IP::isValidBlock( $value ) ) {
+			return false;
+		}
+
+		list( $ip, $range ) = explode( '/', $value, 2 );
+
+		if (
+			( IP::isIPv4( $ip ) && $cidrIPRanges['IPv4'] == 32 ) ||
+			( IP::isIPv6( $ip ) && $cidrIPRanges['IPv6'] == 128 )
+		) {
+			// Range block effectively disabled
+			return $this->msg( 'ip_range_toolow' )->parse();
+		}
+
+		if (
+			( IP::isIPv4( $ip ) && $range > 32 ) ||
+			( IP::isIPv6( $ip ) && $range > 128 )
+		) {
+			// Dodgy range
+			return $this->msg( 'ip_range_invalid' )->parse();
+		}
+
+		if ( IP::isIPv4( $ip ) && $range < $cidrIPRanges['IPv4'] ) {
+			return $this->msg( 'ip_range_exceeded', $cidrIPRanges['IPv4'] )->parse();
+		}
+
+		if ( IP::isIPv6( $ip ) && $range < $cidrIPRanges['IPv6'] ) {
+			return $this->msg( 'ip_range_exceeded', $cidrIPRanges['IPv6'] )->parse();
+		}
+
+		return true;
+	}
+
+	protected function getInputWidget( $params ) {
+		return new UserInputWidget( $params );
+	}
+
+	protected function shouldInfuseOOUI() {
+		return true;
+	}
+
+	protected function getOOUIModules() {
+		return [ 'mediawiki.widgets.UserInputWidget' ];
+	}
+
+	public function getInputHtml( $value ) {
+		// add the required module and css class for user suggestions in non-OOUI mode
+		$this->mParent->getOutput()->addModules( 'mediawiki.userSuggest' );
+		$this->mClass .= ' mw-autocomplete-user';
+
+		// return parent html
+		return parent::getInputHTML( $value );
+	}
+}