includes/api/ApiEmailUser.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on June 1, 2008
   6  *
   7  * Copyright © 2008 Bryan Tong Minh <Bryan.TongMinh@Gmail.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( "ApiBase.php" );
  30 }
  31
  32 /**
  33  * API Module to facilitate sending of emails to users
  34  * @ingroup API
  35  */
  36 class ApiEmailUser extends ApiBase {
  37
  38         public function __construct( $main, $action ) {
  39                 parent::__construct( $main, $action );
  40         }
  41
  42         public function execute() {
  43                 global $wgUser;
  44
  45                 $params = $this->extractRequestParams();
  46
  47                 // Validate target
  48                 $targetUser = SpecialEmailUser::getTarget( $params['target'] );
  49                 if ( !( $targetUser instanceof User ) ) {
  50                         $this->dieUsageMsg( array( $targetUser ) );
  51                 }
  52
  53                 // Check permissions and errors
  54                 $error = SpecialEmailUser::getPermissionsError( $wgUser, $params['token'] );
  55                 if ( $error ) {
  56                         $this->dieUsageMsg( array( $error ) );
  57                 }
  58
  59                 $data = array(
  60                         'Target' => $targetUser->getName(),
  61                         'Text' => $params['text'],
  62                         'Subject' => $params['subject'],
  63                         'CCMe' => $params['ccme'],
  64                 );
  65                 $retval = SpecialEmailUser::submit( $data );
  66
  67                 if ( $retval instanceof Status ) {
  68                         // SpecialEmailUser sometimes returns a status
  69                         // sometimes it doesn't.
  70                         if ( $retval->isGood() ) {
  71                                 $retval = true;
  72                         } else {
  73                                 $retval = $retval->getErrorsArray();
  74                         }
  75                 }
  76
  77                 if ( $retval === true ) {
  78                         $result = array( 'result' => 'Success' );
  79                 } else {
  80                         $result = array(
  81                                 'result' => 'Failure',
  82                                 'message' => $retval
  83                         );
  84                 }
  85
  86                 $this->getResult()->addValue( null, $this->getModuleName(), $result );
  87         }
  88
  89         public function mustBePosted() {
  90                 return true;
  91         }
  92
  93         public function isWriteMode() {
  94                 return true;
  95         }
  96
  97         public function getAllowedParams() {
  98                 return array(
  99                         'target' => array(
 100                                 ApiBase::PARAM_TYPE => 'string',
 101                                 ApiBase::PARAM_REQUIRED => true
 102                         ),
 103                         'subject' => null,
 104                         'text' => array(
 105                                 ApiBase::PARAM_TYPE => 'string',
 106                                 ApiBase::PARAM_REQUIRED => true
 107                         ),
 108                         'token' => null,
 109                         'ccme' => false,
 110                 );
 111         }
 112
 113         public function getParamDescription() {
 114                 return array(
 115                         'target' => 'User to send email to',
 116                         'subject' => 'Subject header',
 117                         'text' => 'Mail body',
 118                         'token' => 'A token previously acquired via prop=info',
 119                         'ccme' => 'Send a copy of this mail to me',
 120                 );
 121         }
 122
 123         public function getDescription() {
 124                 return 'Email a user.';
 125         }
 126
 127         public function getPossibleErrors() {
 128                 return array_merge( parent::getPossibleErrors(), array(
 129                         array( 'usermaildisabled' ),
 130                 ) );
 131         }
 132
 133         public function needsToken() {
 134                 return true;
 135         }
 136
 137         public function getTokenSalt() {
 138                 return '';
 139         }
 140
 141         public function getExamples() {
 142                 return array(
 143                         'api.php?action=emailuser&target=WikiSysop&text=Content'
 144                 );
 145         }
 146
 147         public function getHelpUrls() {
 148                 return 'http://www.mediawiki.org/wiki/API:E-mail';
 149         }
 150
 151         public function getVersion() {
 152                 return __CLASS__ . ': $Id$';
 153         }
 154 }