MediaWiki 1.30.2

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

diff --git a/includes/auth/ButtonAuthenticationRequest.php b/includes/auth/ButtonAuthenticationRequest.php
new file mode 100644 (file)
index 0000000..d274e18
--- /dev/null
+++ b/includes/auth/ButtonAuthenticationRequest.php
@@ -0,0 +1,108 @@
+<?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;
+
+use Message;
+
+/**
+ * This is an authentication request that just implements a simple button.
+ * @ingroup Auth
+ * @since 1.27
+ */
+class ButtonAuthenticationRequest extends AuthenticationRequest {
+       /** @var string */
+       protected $name;
+
+       /** @var Message */
+       protected $label;
+
+       /** @var Message */
+       protected $help;
+
+       /**
+        * @param string $name Button name
+        * @param Message $label Button label
+        * @param Message $help Button help
+        * @param bool $required The button is required for authentication to proceed.
+        */
+       public function __construct( $name, Message $label, Message $help, $required = false ) {
+               $this->name = $name;
+               $this->label = $label;
+               $this->help = $help;
+               $this->required = $required ? self::REQUIRED : self::OPTIONAL;
+       }
+
+       public function getUniqueId() {
+               return parent::getUniqueId() . ':' . $this->name;
+       }
+
+       public function getFieldInfo() {
+               return [
+                       $this->name => [
+                               'type' => 'button',
+                               'label' => $this->label,
+                               'help' => $this->help,
+                       ]
+               ];
+       }
+
+       /**
+        * Fetch a ButtonAuthenticationRequest or subclass by name
+        * @param AuthenticationRequest[] $reqs Requests to search
+        * @param string $name Name to look for
+        * @return ButtonAuthenticationRequest|null Returns null if there is not
+        *  exactly one matching request.
+        */
+       public static function getRequestByName( array $reqs, $name ) {
+               $requests = array_filter( $reqs, function ( $req ) use ( $name ) {
+                       return $req instanceof ButtonAuthenticationRequest && $req->name === $name;
+               } );
+               return count( $requests ) === 1 ? reset( $requests ) : null;
+       }
+
+       /**
+        * @codeCoverageIgnore
+        * @param array $data
+        * @return AuthenticationRequest|static
+        */
+       public static function __set_state( $data ) {
+               if ( !isset( $data['label'] ) ) {
+                       $data['label'] = new \RawMessage( '$1', $data['name'] );
+               } elseif ( is_string( $data['label'] ) ) {
+                       $data['label'] = new \Message( $data['label'] );
+               } elseif ( is_array( $data['label'] ) ) {
+                       $data['label'] = call_user_func_array( 'Message::newFromKey', $data['label'] );
+               }
+               if ( !isset( $data['help'] ) ) {
+                       $data['help'] = new \RawMessage( '$1', $data['name'] );
+               } elseif ( is_string( $data['help'] ) ) {
+                       $data['help'] = new \Message( $data['help'] );
+               } elseif ( is_array( $data['help'] ) ) {
+                       $data['help'] = call_user_func_array( 'Message::newFromKey', $data['help'] );
+               }
+               $ret = new static( $data['name'], $data['label'], $data['help'] );
+               foreach ( $data as $k => $v ) {
+                       $ret->$k = $v;
+               }
+               return $ret;
+       }
+}