ApiEmailUser.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\Mail\EmailUserFactory;
use MediaWiki\Status\Status;
use MediaWiki\User\UserFactory;
use Wikimedia\ParamValidator\ParamValidator;
 
class ApiEmailUser extends ApiBase {
 
    public function __construct(
        ApiMain $mainModule,
        string $moduleName,
        private readonly EmailUserFactory $emailUserFactory,
        private readonly UserFactory $userFactory
    ) {
        parent::__construct( $mainModule, $moduleName );
    }
 
    public function execute() {
        $params = $this->extractRequestParams();
 
        $emailUser = $this->emailUserFactory->newEmailUser( $this->getAuthority() );
        $targetUser = $this->userFactory->newFromName( $params['target'] );
 
        if ( $targetUser === null ) {
            $this->dieWithError(
                [ 'apierror-baduser', 'target', wfEscapeWikiText( $params['target'] ) ],
                "baduser_target"
            );
        }
 
        $status = $emailUser->validateTarget( $targetUser );
 
        if ( !$status->isOK() ) {
            $this->dieStatus( $status );
        }
 
        // Check permissions and errors
        $error = $emailUser->canSend();
 
        if ( !$error->isGood() ) {
            $this->dieStatus( $error );
        }
 
        $retval = $emailUser->sendEmailUnsafe(
            $targetUser,
            $params['subject'],
            $params['text'],
            $params['ccme'],
            $this->getLanguage()->getCode()
        );
 
        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;
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function getAllowedParams() {
        return [
            'target' => [
                ParamValidator::PARAM_TYPE => 'string',
                ParamValidator::PARAM_REQUIRED => true
            ],
            'subject' => [
                ParamValidator::PARAM_TYPE => 'string',
                ParamValidator::PARAM_REQUIRED => true
            ],
            'text' => [
                ParamValidator::PARAM_TYPE => 'text',
                ParamValidator::PARAM_REQUIRED => true
            ],
            'ccme' => false,
        ];
    }
 
    public function needsToken() {
        return 'csrf';
    }
 
    protected function getExamplesMessages() {
        return [
            'action=emailuser&target=WikiSysop&text=Content&token=123ABC'
                => 'apihelp-emailuser-example-email',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Email';
    }
}
 
class_alias( ApiEmailUser::class, 'ApiEmailUser' );