MediaWiki 1.30.2

[autoinstalls/mediawiki.git] / includes / api / ApiEmailUser.php

diff --git a/includes/api/ApiEmailUser.php b/includes/api/ApiEmailUser.php
index 66f2dff5a66ba7008b7bbf48bd04d2969df04d7b..edea2661a20921e9a54d68a2dac3b6df714fe250 100644 (file)
--- a/includes/api/ApiEmailUser.php
+++ b/includes/api/ApiEmailUser.php
@@ -1,10 +1,10 @@
 <?php
-
-/*
+/**
+ *
+ *
  * Created on June 1, 2008
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2008 Bryan Tong Minh <Bryan.TongMinh@Gmail.com>
+ * Copyright © 2008 Bryan Tong Minh <Bryan.TongMinh@Gmail.com>
  *
  * 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
@@ -18,58 +18,67 @@
  *
  * 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.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once ( "ApiBase.php" );
-}
-
 /**
+ * API Module to facilitate sending of emails to users
  * @ingroup API
  */
 class ApiEmailUser extends ApiBase {
 
-       public function __construct( $main, $action ) {
-               parent :: __construct( $main, $action );
-       }
-
        public function execute() {
-               global $wgUser;
-               // Check whether email is enabled
-               if ( !EmailUserForm::userEmailEnabled() )
-                       $this->dieUsageMsg( array( 'usermaildisabled' ) );
-
                $params = $this->extractRequestParams();
-               // Check required parameters
-               if ( !isset( $params['target'] ) )
-                       $this->dieUsageMsg( array( 'missingparam', 'target' ) );
-               if ( !isset( $params['text'] ) )
-                       $this->dieUsageMsg( array( 'missingparam', 'text' ) );
-               
-               // Validate target 
-               $targetUser = EmailUserForm::validateEmailTarget( $params['target'] );
-               if ( !( $targetUser instanceof User ) )
-                       $this->dieUsageMsg( array( $targetUser ) );
-               
-               // Check permissions
-               $error = EmailUserForm::getPermissionsError( $wgUser, $params['token'] );
-               if ( $error )
-                       $this->dieUsageMsg( array( $error ) );
 
-               $form = new EmailUserForm( $targetUser, $params['text'], $params['subject'], $params['ccme'] );
-               $retval = $form->doSubmit();
-               if ( is_null( $retval ) )
-                       $result = array( 'result' => 'Success' );
-               else
-                       $result = array( 'result' => 'Failure',
-                                'message' => $retval->getMessage() );
-               
+               // Validate target
+               $targetUser = SpecialEmailUser::getTarget( $params['target'], $this->getUser() );
+               if ( !( $targetUser instanceof User ) ) {
+                       switch ( $targetUser ) {
+                               case 'notarget':
+                                       $this->dieWithError( 'apierror-notarget' );
+                               case 'noemail':
+                                       $this->dieWithError( [ 'noemail', $params['target'] ] );
+                               case 'nowikiemail':
+                                       $this->dieWithError( 'nowikiemailtext', 'nowikiemail' );
+                               default:
+                                       $this->dieWithError( [ 'apierror-unknownerror', $targetUser ] );
+                       }
+               }
+
+               // Check permissions and errors
+               $error = SpecialEmailUser::getPermissionsError(
+                       $this->getUser(),
+                       $params['token'],
+                       $this->getConfig()
+               );
+               if ( $error ) {
+                       $this->dieWithError( $error );
+               }
+
+               $data = [
+                       'Target' => $targetUser->getName(),
+                       'Text' => $params['text'],
+                       'Subject' => $params['subject'],
+                       'CCMe' => $params['ccme'],
+               ];
+               $retval = SpecialEmailUser::submit( $data, $this->getContext() );
+               if ( !$retval instanceof Status ) {
+                       // This is probably the reason
+                       $retval = Status::newFatal( 'hookaborted' );
+               }
+
+               $result = array_filter( [
+                       'result' => $retval->isGood() ? 'Success' : ( $retval->isOk() ? 'Warnings' : 'Failure' ),
+                       'warnings' => $this->getErrorFormatter()->arrayFromStatus( $retval, 'warning' ),
+                       'errors' => $this->getErrorFormatter()->arrayFromStatus( $retval, 'error' ),
+               ] );
+
                $this->getResult()->addValue( null, $this->getModuleName(), $result );
        }
-       
+
        public function mustBePosted() {
                return true;
        }
@@ -79,55 +88,32 @@ class ApiEmailUser extends ApiBase {
        }
 
        public function getAllowedParams() {
-               return array (
-                       'target' => null,
+               return [
+                       'target' => [
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ],
                        'subject' => null,
-                       'text' => null,
-                       'token' => null,
+                       'text' => [
+                               ApiBase::PARAM_TYPE => 'text',
+                               ApiBase::PARAM_REQUIRED => true
+                       ],
                        'ccme' => false,
-               );
+               ];
        }
 
-       public function getParamDescription() {
-               return array (
-                       'target' => 'User to send email to',
-                       'subject' => 'Subject header',
-                       'text' => 'Mail body',
-                       'token' => 'A token previously acquired via prop=info',
-                       'ccme' => 'Send a copy of this mail to me',
-               );
-       }
-
-       public function getDescription() {
-               return array(
-                       'Email a user.'
-               );
-       }
-       
-    public function getPossibleErrors() {
-               return array_merge( parent::getPossibleErrors(), array(
-                       array( 'usermaildisabled' ),
-                       array( 'missingparam', 'target' ),
-                       array( 'missingparam', 'text' ),
-        ) );
-       }
-       
        public function needsToken() {
-               return true;
+               return 'csrf';
        }
 
-       public function getTokenSalt() {
-               return '';
-       }
-
-       protected function getExamples() {
-               return array (
-                       'api.php?action=emailuser&target=WikiSysop&text=Content'
-               );
+       protected function getExamplesMessages() {
+               return [
+                       'action=emailuser&target=WikiSysop&text=Content&token=123ABC'
+                               => 'apihelp-emailuser-example-email',
+               ];
        }
 
-       public function getVersion() {
-               return __CLASS__ . ': $Id: ApiEmailUser.php 74217 2010-10-03 15:53:07Z reedy $';
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Email';
        }
 }
-       
\ No newline at end of file