MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / auth / PasswordAuthenticationRequest.php

diff --git a/includes/auth/PasswordAuthenticationRequest.php b/includes/auth/PasswordAuthenticationRequest.php
new file mode 100644 (file)
index 0000000..8550f3e
--- /dev/null
+++ b/includes/auth/PasswordAuthenticationRequest.php
@@ -0,0 +1,85 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Auth
+ */
+
+namespace MediaWiki\Auth;
+
+/**
+ * This is a value object for authentication requests with a username and password
+ * @ingroup Auth
+ * @since 1.27
+ */
+class PasswordAuthenticationRequest extends AuthenticationRequest {
+       /** @var string Password */
+       public $password = null;
+
+       /** @var string Password, again */
+       public $retype = null;
+
+       public function getFieldInfo() {
+               if ( $this->action === AuthManager::ACTION_REMOVE ) {
+                       return [];
+               }
+
+               // for password change it's nice to make extra clear that we are asking for the new password
+               $forNewPassword = $this->action === AuthManager::ACTION_CHANGE;
+               $passwordLabel = $forNewPassword ? 'newpassword' : 'userlogin-yourpassword';
+               $retypeLabel = $forNewPassword ? 'retypenew' : 'yourpasswordagain';
+
+               $ret = [
+                       'username' => [
+                               'type' => 'string',
+                               'label' => wfMessage( 'userlogin-yourname' ),
+                               'help' => wfMessage( 'authmanager-username-help' ),
+                       ],
+                       'password' => [
+                               'type' => 'password',
+                               'label' => wfMessage( $passwordLabel ),
+                               'help' => wfMessage( 'authmanager-password-help' ),
+                               'sensitive' => true,
+                       ],
+               ];
+
+               switch ( $this->action ) {
+                       case AuthManager::ACTION_CHANGE:
+                       case AuthManager::ACTION_REMOVE:
+                               unset( $ret['username'] );
+                               break;
+               }
+
+               if ( $this->action !== AuthManager::ACTION_LOGIN ) {
+                       $ret['retype'] = [
+                               'type' => 'password',
+                               'label' => wfMessage( $retypeLabel ),
+                               'help' => wfMessage( 'authmanager-retype-help' ),
+                               'sensitive' => true,
+                       ];
+               }
+
+               return $ret;
+       }
+
+       public function describeCredentials() {
+               return [
+                       'provider' => wfMessage( 'authmanager-provider-password' ),
+                       'account' => new \RawMessage( '$1', [ $this->username ] ),
+               ];
+       }
+}