<?php
/**
- * API for MediaWiki 1.8+
+ *
*
* Created on June 1, 2008
*
* @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;
-
$params = $this->extractRequestParams();
// Validate target
- $targetUser = SpecialEmailUser::getTarget( $params['target'] );
+ $targetUser = SpecialEmailUser::getTarget( $params['target'], $this->getUser() );
if ( !( $targetUser instanceof User ) ) {
- $this->dieUsageMsg( array( $targetUser ) );
+ 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( $wgUser, $params['token'] );
+ $error = SpecialEmailUser::getPermissionsError(
+ $this->getUser(),
+ $params['token'],
+ $this->getConfig()
+ );
if ( $error ) {
- $this->dieUsageMsg( array( $error ) );
+ $this->dieWithError( $error );
}
- $data = array(
+ $data = [
'Target' => $targetUser->getName(),
'Text' => $params['text'],
'Subject' => $params['subject'],
'CCMe' => $params['ccme'],
- );
- $retval = SpecialEmailUser::submit( $data );
-
- if ( $retval instanceof Status ) {
- // SpecialEmailUser sometimes returns a status
- // sometimes it doesn't.
- if ( $retval->isGood() ) {
- $retval = true;
- } else {
- $retval = $retval->getErrorsArray();
- }
+ ];
+ $retval = SpecialEmailUser::submit( $data, $this->getContext() );
+ if ( !$retval instanceof Status ) {
+ // This is probably the reason
+ $retval = Status::newFatal( 'hookaborted' );
}
- if ( $retval === true ) {
- $result = array( 'result' => 'Success' );
- } else {
- $result = array(
- 'result' => 'Failure',
- 'message' => $retval
- );
- }
+ $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 getAllowedParams() {
- return array(
- 'target' => array(
+ return [
+ 'target' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true
- ),
+ ],
'subject' => null,
- 'text' => array(
- ApiBase::PARAM_TYPE => 'string',
+ 'text' => [
+ ApiBase::PARAM_TYPE => 'text',
ApiBase::PARAM_REQUIRED => true
- ),
- 'token' => null,
+ ],
'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 'Email a user.';
- }
-
- public function getPossibleErrors() {
- return array_merge( parent::getPossibleErrors(), array(
- array( 'usermaildisabled' ),
- ) );
+ ];
}
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 85354 2011-04-04 18:25:31Z demon $';
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Email';
}
}