SpecialEmailUser.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use MediaWiki\Preferences\MultiUsernameFilter;
 
class SpecialEmailUser extends UnlistedSpecialPage {
    protected $mTarget;
 
    protected $mTargetObj;
 
    public function __construct() {
        parent::__construct( 'Emailuser' );
    }
 
    public function doesWrites() {
        return true;
    }
 
    public function getDescription() {
        $target = self::getTarget( $this->mTarget, $this->getUser() );
        if ( !$target instanceof User ) {
            return $this->msg( 'emailuser-title-notarget' )->text();
        }
 
        return $this->msg( 'emailuser-title-target', $target->getName() )->text();
    }
 
    protected function getFormFields() {
        $linkRenderer = $this->getLinkRenderer();
        return [
            'From' => [
                'type' => 'info',
                'raw' => 1,
                'default' => $linkRenderer->makeLink(
                    $this->getUser()->getUserPage(),
                    $this->getUser()->getName()
                ),
                'label-message' => 'emailfrom',
                'id' => 'mw-emailuser-sender',
            ],
            'To' => [
                'type' => 'info',
                'raw' => 1,
                'default' => $linkRenderer->makeLink(
                    $this->mTargetObj->getUserPage(),
                    $this->mTargetObj->getName()
                ),
                'label-message' => 'emailto',
                'id' => 'mw-emailuser-recipient',
            ],
            'Target' => [
                'type' => 'hidden',
                'default' => $this->mTargetObj->getName(),
            ],
            'Subject' => [
                'type' => 'text',
                'default' => $this->msg( 'defemailsubject',
                    $this->getUser()->getName() )->inContentLanguage()->text(),
                'label-message' => 'emailsubject',
                'maxlength' => 200,
                'size' => 60,
                'required' => true,
            ],
            'Text' => [
                'type' => 'textarea',
                'rows' => 20,
                'label-message' => 'emailmessage',
                'required' => true,
            ],
            'CCMe' => [
                'type' => 'check',
                'label-message' => 'emailccme',
                'default' => $this->getUser()->getBoolOption( 'ccmeonemails' ),
            ],
        ];
    }
 
    public function execute( $par ) {
        $out = $this->getOutput();
        $request = $this->getRequest();
        $out->addModuleStyles( 'mediawiki.special' );
 
        $this->mTarget = $par ?? $request->getVal( 'wpTarget', $request->getVal( 'target', '' ) );
 
        // Make sure, that HTMLForm uses the correct target.
        $request->setVal( 'wpTarget', $this->mTarget );
 
        // This needs to be below assignment of $this->mTarget because
        // getDescription() needs it to determine the correct page title.
        $this->setHeaders();
        $this->outputHeader();
 
        // error out if sending user cannot do this
        $error = self::getPermissionsError(
            $this->getUser(),
            $this->getRequest()->getVal( 'wpEditToken' ),
            $this->getConfig()
        );
 
        switch ( $error ) {
            case null:
                # Wahey!
                break;
            case 'badaccess':
                throw new PermissionsError( 'sendemail' );
            case 'blockedemailuser':
                throw new UserBlockedError( $this->getUser()->getBlock() );
            case 'actionthrottledtext':
                throw new ThrottledError;
            case 'mailnologin':
            case 'usermaildisabled':
                throw new ErrorPageError( $error, "{$error}text" );
            default:
                # It's a hook error
                list( $title, $msg, $params ) = $error;
                throw new ErrorPageError( $title, $msg, $params );
        }
 
        // Make sure, that a submitted form isn't submitted to a subpage (which could be
        // a non-existing username)
        $context = new DerivativeContext( $this->getContext() );
        $context->setTitle( $this->getPageTitle() ); // Remove subpage
        $this->setContext( $context );
 
        // A little hack: HTMLForm will check $this->mTarget only, if the form was posted, not
        // if the user opens Special:EmailUser/Florian (e.g.). So check, if the user did that
        // and show the "Send email to user" form directly, if so. Show the "enter username"
        // form, otherwise.
        $this->mTargetObj = self::getTarget( $this->mTarget, $this->getUser() );
        if ( !$this->mTargetObj instanceof User ) {
            $this->userForm( $this->mTarget );
        } else {
            $this->sendEmailForm();
        }
    }
 
    public static function getTarget( $target, User $sender ) {
        if ( $target == '' ) {
            wfDebug( "Target is empty." );
 
            return 'notarget';
        }
 
        $nu = User::newFromName( $target );
        $error = self::validateTarget( $nu, $sender );
 
        return $error ?: $nu;
    }
 
    public static function validateTarget( $target, User $sender ) {
        if ( !$target instanceof User || !$target->getId() ) {
            wfDebug( "Target is invalid user." );
 
            return 'notarget';
        }
 
        if ( !$target->isEmailConfirmed() ) {
            wfDebug( "User has no valid email." );
 
            return 'noemail';
        }
 
        if ( !$target->canReceiveEmail() ) {
            wfDebug( "User does not allow user emails." );
 
            return 'nowikiemail';
        }
 
        if ( !$target->getOption( 'email-allow-new-users' ) && $sender->isNewbie() ) {
            wfDebug( "User does not allow user emails from new users." );
 
            return 'nowikiemail';
        }
 
        $muteList = $target->getOption( 'email-blacklist', '' );
        if ( $muteList ) {
            $muteList = MultiUsernameFilter::splitIds( $muteList );
            $lookup = CentralIdLookup::factory();
            $senderId = $lookup->centralIdFromLocalUser( $sender );
            if ( $senderId !== 0 && in_array( $senderId, $muteList ) ) {
                wfDebug( "User does not allow user emails from this user." );
 
                return 'nowikiemail';
            }
        }
 
        return '';
    }
 
    public static function getPermissionsError( $user, $editToken, Config $config = null ) {
        if ( $config === null ) {
            wfDebug( __METHOD__ . ' called without a Config instance passed to it' );
            $config = MediaWikiServices::getInstance()->getMainConfig();
        }
        if ( !$config->get( 'EnableEmail' ) || !$config->get( 'EnableUserEmail' ) ) {
            return 'usermaildisabled';
        }
 
        // Run this before $user->isAllowed, to show appropriate message to anons (T160309)
        if ( !$user->isEmailConfirmed() ) {
            return 'mailnologin';
        }
 
        if ( !MediaWikiServices::getInstance()
                ->getPermissionManager()
                ->userHasRight( $user, 'sendemail' )
        ) {
            return 'badaccess';
        }
 
        if ( $user->isBlockedFromEmailuser() ) {
            wfDebug( "User is blocked from sending e-mail." );
 
            return "blockedemailuser";
        }
 
        // Check the ping limiter without incrementing it - we'll check it
        // again later and increment it on a successful send
        if ( $user->pingLimiter( 'emailuser', 0 ) ) {
            wfDebug( "Ping limiter triggered." );
 
            return 'actionthrottledtext';
        }
 
        $hookErr = false;
 
        Hooks::runner()->onUserCanSendEmail( $user, $hookErr );
        Hooks::runner()->onEmailUserPermissionsErrors( $user, $editToken, $hookErr );
 
        if ( $hookErr ) {
            return $hookErr;
        }
 
        return null;
    }
 
    protected function userForm( $name ) {
        $htmlForm = HTMLForm::factory( 'ooui', [
            'Target' => [
                'type' => 'user',
                'exists' => true,
                'required' => true,
                'label' => $this->msg( 'emailusername' )->text(),
                'id' => 'emailusertarget',
                'autofocus' => true,
                'value' => $name,
            ]
        ], $this->getContext() );
 
        $htmlForm
            ->setSubmitCallback( [ $this, 'sendEmailForm' ] )
            ->setFormIdentifier( 'userForm' )
            ->setId( 'askusername' )
            ->setWrapperLegendMsg( 'emailtarget' )
            ->setSubmitTextMsg( 'emailusernamesubmit' )
            ->show();
    }
 
    public function sendEmailForm() {
        $out = $this->getOutput();
 
        $ret = $this->mTargetObj;
        if ( !$ret instanceof User ) {
            if ( $this->mTarget != '' ) {
                // Messages used here: notargettext, noemailtext, nowikiemailtext
                $ret = ( $ret == 'notarget' ) ? 'emailnotarget' : ( $ret . 'text' );
                return Status::newFatal( $ret );
            }
            return false;
        }
 
        $htmlForm = HTMLForm::factory( 'ooui', $this->getFormFields(), $this->getContext() );
        // By now we are supposed to be sure that $this->mTarget is a user name
        $htmlForm
            ->addPreText( $this->msg( 'emailpagetext', $this->mTarget )->parse() )
            ->setSubmitTextMsg( 'emailsend' )
            ->setSubmitCallback( [ __CLASS__, 'submit' ] )
            ->setFormIdentifier( 'sendEmailForm' )
            ->setWrapperLegendMsg( 'email-legend' )
            ->loadData();
 
        if ( !$this->getHookRunner()->onEmailUserForm( $htmlForm ) ) {
            return false;
        }
 
        $result = $htmlForm->show();
 
        if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
            $out->setPageTitle( $this->msg( 'emailsent' ) );
            $out->addWikiMsg( 'emailsenttext', $this->mTarget );
            $out->returnToMain( false, $ret->getUserPage() );
        }
        return true;
    }
 
    public static function submit( array $data, IContextSource $context ) {
        $config = $context->getConfig();
 
        $target = self::getTarget( $data['Target'], $context->getUser() );
        if ( !$target instanceof User ) {
            // Messages used here: notargettext, noemailtext, nowikiemailtext
            return Status::newFatal( $target . 'text' );
        }
 
        $to = MailAddress::newFromUser( $target );
        $from = MailAddress::newFromUser( $context->getUser() );
        $subject = $data['Subject'];
        $text = $data['Text'];
 
        // Add a standard footer and trim up trailing newlines
        $text = rtrim( $text ) . "\n\n-- \n";
        $text .= $context->msg( 'emailuserfooter',
            $from->name, $to->name )->inContentLanguage()->text();
 
        if ( $config->get( 'EnableSpecialMute' ) ) {
            $specialMutePage = SpecialPage::getTitleFor( 'Mute', $context->getUser()->getName() );
            $text .= "\n" . $context->msg(
                'specialmute-email-footer',
                $specialMutePage->getCanonicalURL(),
                $context->getUser()->getName()
            )->inContentLanguage()->text();
        }
 
        // Check and increment the rate limits
        if ( $context->getUser()->pingLimiter( 'emailuser' ) ) {
            throw new ThrottledError();
        }
 
        $error = false;
        if ( !Hooks::runner()->onEmailUser( $to, $from, $subject, $text, $error ) ) {
            if ( $error instanceof Status ) {
                return $error;
            } elseif ( $error === false || $error === '' || $error === [] ) {
                // Possibly to tell HTMLForm to pretend there was no submission?
                return false;
            } elseif ( $error === true ) {
                // Hook sent the mail itself and indicates success?
                return Status::newGood();
            } elseif ( is_array( $error ) ) {
                $status = Status::newGood();
                foreach ( $error as $e ) {
                    $status->fatal( $e );
                }
                return $status;
            } elseif ( $error instanceof MessageSpecifier ) {
                return Status::newFatal( $error );
            } else {
                // Ugh. Either a raw HTML string, or something that's supposed
                // to be treated like one.
                $type = is_object( $error ) ? get_class( $error ) : gettype( $error );
                wfDeprecatedMsg( "An EmailUser hook returned a $type as \$error, " .
                    "this is deprecated since MediaWiki 1.29",
                    '1.29', false, false );
                return Status::newFatal( new ApiRawMessage(
                    [ '$1', Message::rawParam( (string)$error ) ], 'hookaborted'
                ) );
            }
        }
 
        if ( $config->get( 'UserEmailUseReplyTo' ) ) {
            $mailFrom = new MailAddress( $config->get( 'PasswordSender' ),
                $context->msg( 'emailsender' )->inContentLanguage()->text() );
            $replyTo = $from;
        } else {
            $mailFrom = $from;
            $replyTo = null;
        }
 
        $status = UserMailer::send( $to, $mailFrom, $subject, $text, [
            'replyTo' => $replyTo,
        ] );
 
        if ( !$status->isGood() ) {
            return $status;
        } else {
            // if the user requested a copy of this mail, do this now,
            // unless they are emailing themselves, in which case one
            // copy of the message is sufficient.
            if ( $data['CCMe'] && $to != $from ) {
                $ccTo = $from;
                $ccFrom = $from;
                $ccSubject = $context->msg( 'emailccsubject' )->plaintextParams(
                    $target->getName(), $subject )->text();
                $ccText = $text;
 
                Hooks::runner()->onEmailUserCC( $ccTo, $ccFrom, $ccSubject, $ccText );
 
                if ( $config->get( 'UserEmailUseReplyTo' ) ) {
                    $mailFrom = new MailAddress(
                        $config->get( 'PasswordSender' ),
                        $context->msg( 'emailsender' )->inContentLanguage()->text()
                    );
                    $replyTo = $ccFrom;
                } else {
                    $mailFrom = $ccFrom;
                    $replyTo = null;
                }
 
                $ccStatus = UserMailer::send(
                    $ccTo, $mailFrom, $ccSubject, $ccText, [
                        'replyTo' => $replyTo,
                ] );
                $status->merge( $ccStatus );
            }
 
            Hooks::runner()->onEmailUserComplete( $to, $from, $subject, $text );
 
            return $status;
        }
    }
 
    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $user = User::newFromName( $search );
        if ( !$user ) {
            // No prefix suggestion for invalid user
            return [];
        }
        // Autocomplete subpage as user list - public to allow caching
        return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
    }
 
    protected function getGroupName() {
        return 'users';
    }
}