includes/specials/SpecialEmailuser.php

   1 <?php
   2 /**
   3  * Implements Special:Emailuser
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23 use MediaWiki\MediaWikiServices;
  24
  25 /**
  26  * A special page that allows users to send e-mails to other users
  27  *
  28  * @ingroup SpecialPage
  29  */
  30 class SpecialEmailUser extends UnlistedSpecialPage {
  31         protected $mTarget;
  32
  33         /**
  34          * @var User|string $mTargetObj
  35          */
  36         protected $mTargetObj;
  37
  38         public function __construct() {
  39                 parent::__construct( 'Emailuser' );
  40         }
  41
  42         public function doesWrites() {
  43                 return true;
  44         }
  45
  46         public function getDescription() {
  47                 $target = self::getTarget( $this->mTarget );
  48                 if ( !$target instanceof User ) {
  49                         return $this->msg( 'emailuser-title-notarget' )->text();
  50                 }
  51
  52                 return $this->msg( 'emailuser-title-target', $target->getName() )->text();
  53         }
  54
  55         protected function getFormFields() {
  56                 $linkRenderer = $this->getLinkRenderer();
  57                 return [
  58                         'From' => [
  59                                 'type' => 'info',
  60                                 'raw' => 1,
  61                                 'default' => $linkRenderer->makeLink(
  62                                         $this->getUser()->getUserPage(),
  63                                         $this->getUser()->getName()
  64                                 ),
  65                                 'label-message' => 'emailfrom',
  66                                 'id' => 'mw-emailuser-sender',
  67                         ],
  68                         'To' => [
  69                                 'type' => 'info',
  70                                 'raw' => 1,
  71                                 'default' => $linkRenderer->makeLink(
  72                                         $this->mTargetObj->getUserPage(),
  73                                         $this->mTargetObj->getName()
  74                                 ),
  75                                 'label-message' => 'emailto',
  76                                 'id' => 'mw-emailuser-recipient',
  77                         ],
  78                         'Target' => [
  79                                 'type' => 'hidden',
  80                                 'default' => $this->mTargetObj->getName(),
  81                         ],
  82                         'Subject' => [
  83                                 'type' => 'text',
  84                                 'default' => $this->msg( 'defemailsubject',
  85                                         $this->getUser()->getName() )->inContentLanguage()->text(),
  86                                 'label-message' => 'emailsubject',
  87                                 'maxlength' => 200,
  88                                 'size' => 60,
  89                                 'required' => true,
  90                         ],
  91                         'Text' => [
  92                                 'type' => 'textarea',
  93                                 'rows' => 20,
  94                                 'cols' => 80,
  95                                 'label-message' => 'emailmessage',
  96                                 'required' => true,
  97                         ],
  98                         'CCMe' => [
  99                                 'type' => 'check',
 100                                 'label-message' => 'emailccme',
 101                                 'default' => $this->getUser()->getBoolOption( 'ccmeonemails' ),
 102                         ],
 103                 ];
 104         }
 105
 106         public function execute( $par ) {
 107                 $out = $this->getOutput();
 108                 $out->addModuleStyles( 'mediawiki.special' );
 109
 110                 $this->mTarget = is_null( $par )
 111                         ? $this->getRequest()->getVal( 'wpTarget', $this->getRequest()->getVal( 'target', '' ) )
 112                         : $par;
 113
 114                 // This needs to be below assignment of $this->mTarget because
 115                 // getDescription() needs it to determine the correct page title.
 116                 $this->setHeaders();
 117                 $this->outputHeader();
 118
 119                 // error out if sending user cannot do this
 120                 $error = self::getPermissionsError(
 121                         $this->getUser(),
 122                         $this->getRequest()->getVal( 'wpEditToken' ),
 123                         $this->getConfig()
 124                 );
 125
 126                 switch ( $error ) {
 127                         case null:
 128                                 # Wahey!
 129                                 break;
 130                         case 'badaccess':
 131                                 throw new PermissionsError( 'sendemail' );
 132                         case 'blockedemailuser':
 133                                 throw new UserBlockedError( $this->getUser()->mBlock );
 134                         case 'actionthrottledtext':
 135                                 throw new ThrottledError;
 136                         case 'mailnologin':
 137                         case 'usermaildisabled':
 138                                 throw new ErrorPageError( $error, "{$error}text" );
 139                         default:
 140                                 # It's a hook error
 141                                 list( $title, $msg, $params ) = $error;
 142                                 throw new ErrorPageError( $title, $msg, $params );
 143                 }
 144                 // Got a valid target user name? Else ask for one.
 145                 $ret = self::getTarget( $this->mTarget );
 146                 if ( !$ret instanceof User ) {
 147                         if ( $this->mTarget != '' ) {
 148                                 // Messages used here: notargettext, noemailtext, nowikiemailtext
 149                                 $ret = ( $ret == 'notarget' ) ? 'emailnotarget' : ( $ret . 'text' );
 150                                 $out->wrapWikiMsg( "<p class='error'>$1</p>", $ret );
 151                         }
 152                         $out->addHTML( $this->userForm( $this->mTarget ) );
 153
 154                         return;
 155                 }
 156
 157                 $this->mTargetObj = $ret;
 158
 159                 // Set the 'relevant user' in the skin, so it displays links like Contributions,
 160                 // User logs, UserRights, etc.
 161                 $this->getSkin()->setRelevantUser( $this->mTargetObj );
 162
 163                 $context = new DerivativeContext( $this->getContext() );
 164                 $context->setTitle( $this->getPageTitle() ); // Remove subpage
 165                 $form = new HTMLForm( $this->getFormFields(), $context );
 166                 // By now we are supposed to be sure that $this->mTarget is a user name
 167                 $form->addPreText( $this->msg( 'emailpagetext', $this->mTarget )->parse() );
 168                 $form->setSubmitTextMsg( 'emailsend' );
 169                 $form->setSubmitCallback( [ __CLASS__, 'uiSubmit' ] );
 170                 $form->setWrapperLegendMsg( 'email-legend' );
 171                 $form->loadData();
 172
 173                 if ( !Hooks::run( 'EmailUserForm', [ &$form ] ) ) {
 174                         return;
 175                 }
 176
 177                 $result = $form->show();
 178
 179                 if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
 180                         $out->setPageTitle( $this->msg( 'emailsent' ) );
 181                         $out->addWikiMsg( 'emailsenttext', $this->mTarget );
 182                         $out->returnToMain( false, $this->mTargetObj->getUserPage() );
 183                 }
 184         }
 185
 186         /**
 187          * Validate target User
 188          *
 189          * @param string $target Target user name
 190          * @return User User object on success or a string on error
 191          */
 192         public static function getTarget( $target ) {
 193                 if ( $target == '' ) {
 194                         wfDebug( "Target is empty.\n" );
 195
 196                         return 'notarget';
 197                 }
 198
 199                 $nu = User::newFromName( $target );
 200                 if ( !$nu instanceof User || !$nu->getId() ) {
 201                         wfDebug( "Target is invalid user.\n" );
 202
 203                         return 'notarget';
 204                 } elseif ( !$nu->isEmailConfirmed() ) {
 205                         wfDebug( "User has no valid email.\n" );
 206
 207                         return 'noemail';
 208                 } elseif ( !$nu->canReceiveEmail() ) {
 209                         wfDebug( "User does not allow user emails.\n" );
 210
 211                         return 'nowikiemail';
 212                 }
 213
 214                 return $nu;
 215         }
 216
 217         /**
 218          * Check whether a user is allowed to send email
 219          *
 220          * @param User $user
 221          * @param string $editToken Edit token
 222          * @param Config $config optional for backwards compatibility
 223          * @return string|null Null on success or string on error
 224          */
 225         public static function getPermissionsError( $user, $editToken, Config $config = null ) {
 226                 if ( $config === null ) {
 227                         wfDebug( __METHOD__ . ' called without a Config instance passed to it' );
 228                         $config = MediaWikiServices::getInstance()->getMainConfig();
 229                 }
 230                 if ( !$config->get( 'EnableEmail' ) || !$config->get( 'EnableUserEmail' ) ) {
 231                         return 'usermaildisabled';
 232                 }
 233
 234                 // Run this before $user->isAllowed, to show appropriate message to anons (T160309)
 235                 if ( !$user->isEmailConfirmed() ) {
 236                         return 'mailnologin';
 237                 }
 238
 239                 if ( !$user->isAllowed( 'sendemail' ) ) {
 240                         return 'badaccess';
 241                 }
 242
 243                 if ( $user->isBlockedFromEmailuser() ) {
 244                         wfDebug( "User is blocked from sending e-mail.\n" );
 245
 246                         return "blockedemailuser";
 247                 }
 248
 249                 if ( $user->pingLimiter( 'emailuser' ) ) {
 250                         wfDebug( "Ping limiter triggered.\n" );
 251
 252                         return 'actionthrottledtext';
 253                 }
 254
 255                 $hookErr = false;
 256
 257                 Hooks::run( 'UserCanSendEmail', [ &$user, &$hookErr ] );
 258                 Hooks::run( 'EmailUserPermissionsErrors', [ $user, $editToken, &$hookErr ] );
 259
 260                 if ( $hookErr ) {
 261                         return $hookErr;
 262                 }
 263
 264                 return null;
 265         }
 266
 267         /**
 268          * Form to ask for target user name.
 269          *
 270          * @param string $name User name submitted.
 271          * @return string Form asking for user name.
 272          */
 273         protected function userForm( $name ) {
 274                 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
 275                 $string = Html::openElement(
 276                                 'form',
 277                                 [ 'method' => 'get', 'action' => wfScript(), 'id' => 'askusername' ]
 278                         ) .
 279                         Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
 280                         Html::openElement( 'fieldset' ) .
 281                         Html::rawElement( 'legend', null, $this->msg( 'emailtarget' )->parse() ) .
 282                         Html::label(
 283                                 $this->msg( 'emailusername' )->text(),
 284                                 'emailusertarget'
 285                         ) . '&#160;' .
 286                         Html::input(
 287                                 'target',
 288                                 $name,
 289                                 'text',
 290                                 [
 291                                         'id' => 'emailusertarget',
 292                                         'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
 293                                         'autofocus' => true,
 294                                         'size' => 30,
 295                                 ]
 296                         ) .
 297                         ' ' .
 298                         Html::submitButton( $this->msg( 'emailusernamesubmit' )->text(), [] ) .
 299                         Html::closeElement( 'fieldset' ) .
 300                         Html::closeElement( 'form' ) . "\n";
 301
 302                 return $string;
 303         }
 304
 305         /**
 306          * Submit callback for an HTMLForm object, will simply call submit().
 307          *
 308          * @since 1.20
 309          * @param array $data
 310          * @param HTMLForm $form
 311          * @return Status|bool
 312          */
 313         public static function uiSubmit( array $data, HTMLForm $form ) {
 314                 return self::submit( $data, $form->getContext() );
 315         }
 316
 317         /**
 318          * Really send a mail. Permissions should have been checked using
 319          * getPermissionsError(). It is probably also a good
 320          * idea to check the edit token and ping limiter in advance.
 321          *
 322          * @param array $data
 323          * @param IContextSource $context
 324          * @return Status|bool
 325          */
 326         public static function submit( array $data, IContextSource $context ) {
 327                 $config = $context->getConfig();
 328
 329                 $target = self::getTarget( $data['Target'] );
 330                 if ( !$target instanceof User ) {
 331                         // Messages used here: notargettext, noemailtext, nowikiemailtext
 332                         return Status::newFatal( $target . 'text' );
 333                 }
 334
 335                 $to = MailAddress::newFromUser( $target );
 336                 $from = MailAddress::newFromUser( $context->getUser() );
 337                 $subject = $data['Subject'];
 338                 $text = $data['Text'];
 339
 340                 // Add a standard footer and trim up trailing newlines
 341                 $text = rtrim( $text ) . "\n\n-- \n";
 342                 $text .= $context->msg( 'emailuserfooter',
 343                         $from->name, $to->name )->inContentLanguage()->text();
 344
 345                 $error = false;
 346                 if ( !Hooks::run( 'EmailUser', [ &$to, &$from, &$subject, &$text, &$error ] ) ) {
 347                         if ( $error instanceof Status ) {
 348                                 return $error;
 349                         } elseif ( $error === false || $error === '' || $error === [] ) {
 350                                 // Possibly to tell HTMLForm to pretend there was no submission?
 351                                 return false;
 352                         } elseif ( $error === true ) {
 353                                 // Hook sent the mail itself and indicates success?
 354                                 return Status::newGood();
 355                         } elseif ( is_array( $error ) ) {
 356                                 $status = Status::newGood();
 357                                 foreach ( $error as $e ) {
 358                                         $status->fatal( $e );
 359                                 }
 360                                 return $status;
 361                         } elseif ( $error instanceof MessageSpecifier ) {
 362                                 return Status::newFatal( $error );
 363                         } else {
 364                                 // Ugh. Either a raw HTML string, or something that's supposed
 365                                 // to be treated like one.
 366                                 $type = is_object( $error ) ? get_class( $error ) : gettype( $error );
 367                                 wfDeprecated( "EmailUser hook returning a $type as \$error", '1.29' );
 368                                 return Status::newFatal( new ApiRawMessage(
 369                                         [ '$1', Message::rawParam( (string)$error ) ], 'hookaborted'
 370                                 ) );
 371                         }
 372                 }
 373
 374                 if ( $config->get( 'UserEmailUseReplyTo' ) ) {
 375                         /**
 376                          * Put the generic wiki autogenerated address in the From:
 377                          * header and reserve the user for Reply-To.
 378                          *
 379                          * This is a bit ugly, but will serve to differentiate
 380                          * wiki-borne mails from direct mails and protects against
 381                          * SPF and bounce problems with some mailers (see below).
 382                          */
 383                         $mailFrom = new MailAddress( $config->get( 'PasswordSender' ),
 384                                 wfMessage( 'emailsender' )->inContentLanguage()->text() );
 385                         $replyTo = $from;
 386                 } else {
 387                         /**
 388                          * Put the sending user's e-mail address in the From: header.
 389                          *
 390                          * This is clean-looking and convenient, but has issues.
 391                          * One is that it doesn't as clearly differentiate the wiki mail
 392                          * from "directly" sent mails.
 393                          *
 394                          * Another is that some mailers (like sSMTP) will use the From
 395                          * address as the envelope sender as well. For open sites this
 396                          * can cause mails to be flunked for SPF violations (since the
 397                          * wiki server isn't an authorized sender for various users'
 398                          * domains) as well as creating a privacy issue as bounces
 399                          * containing the recipient's e-mail address may get sent to
 400                          * the sending user.
 401                          */
 402                         $mailFrom = $from;
 403                         $replyTo = null;
 404                 }
 405
 406                 $status = UserMailer::send( $to, $mailFrom, $subject, $text, [
 407                         'replyTo' => $replyTo,
 408                 ] );
 409
 410                 if ( !$status->isGood() ) {
 411                         return $status;
 412                 } else {
 413                         // if the user requested a copy of this mail, do this now,
 414                         // unless they are emailing themselves, in which case one
 415                         // copy of the message is sufficient.
 416                         if ( $data['CCMe'] && $to != $from ) {
 417                                 $ccTo = $from;
 418                                 $ccFrom = $from;
 419                                 $ccSubject = $context->msg( 'emailccsubject' )->rawParams(
 420                                         $target->getName(), $subject )->text();
 421                                 $ccText = $text;
 422
 423                                 Hooks::run( 'EmailUserCC', [ &$ccTo, &$ccFrom, &$ccSubject, &$ccText ] );
 424
 425                                 if ( $config->get( 'UserEmailUseReplyTo' ) ) {
 426                                         $mailFrom = new MailAddress(
 427                                                 $config->get( 'PasswordSender' ),
 428                                                 wfMessage( 'emailsender' )->inContentLanguage()->text()
 429                                         );
 430                                         $replyTo = $ccFrom;
 431                                 } else {
 432                                         $mailFrom = $ccFrom;
 433                                         $replyTo = null;
 434                                 }
 435
 436                                 $ccStatus = UserMailer::send(
 437                                         $ccTo, $mailFrom, $ccSubject, $ccText, [
 438                                                 'replyTo' => $replyTo,
 439                                 ] );
 440                                 $status->merge( $ccStatus );
 441                         }
 442
 443                         Hooks::run( 'EmailUserComplete', [ $to, $from, $subject, $text ] );
 444
 445                         return $status;
 446                 }
 447         }
 448
 449         /**
 450          * Return an array of subpages beginning with $search that this special page will accept.
 451          *
 452          * @param string $search Prefix to search for
 453          * @param int $limit Maximum number of results to return (usually 10)
 454          * @param int $offset Number of results to skip (usually 0)
 455          * @return string[] Matching subpages
 456          */
 457         public function prefixSearchSubpages( $search, $limit, $offset ) {
 458                 $user = User::newFromName( $search );
 459                 if ( !$user ) {
 460                         // No prefix suggestion for invalid user
 461                         return [];
 462                 }
 463                 // Autocomplete subpage as user list - public to allow caching
 464                 return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
 465         }
 466
 467         protected function getGroupName() {
 468                 return 'users';
 469         }
 470 }