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, $this->getUser() );
  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, $this->getUser() );
 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          * @param User|null $sender User sending the email
 191          * @return User|string User object on success or a string on error
 192          */
 193         public static function getTarget( $target, User $sender = null ) {
 194                 if ( $sender === null ) {
 195                         wfDeprecated( __METHOD__ . ' without specifying the sending user', '1.30' );
 196                 }
 197
 198                 if ( $target == '' ) {
 199                         wfDebug( "Target is empty.\n" );
 200
 201                         return 'notarget';
 202                 }
 203
 204                 $nu = User::newFromName( $target );
 205                 $error = self::validateTarget( $nu, $sender );
 206
 207                 return $error ? $error : $nu;
 208         }
 209
 210         /**
 211          * Validate target User
 212          *
 213          * @param User $target Target user
 214          * @param User|null $sender User sending the email
 215          * @return string Error message or empty string if valid.
 216          * @since 1.30
 217          */
 218         public static function validateTarget( $target, User $sender = null ) {
 219                 if ( $sender === null ) {
 220                         wfDeprecated( __METHOD__ . ' without specifying the sending user', '1.30' );
 221                 }
 222
 223                 if ( !$target instanceof User || !$target->getId() ) {
 224                         wfDebug( "Target is invalid user.\n" );
 225
 226                         return 'notarget';
 227                 } elseif ( !$target->isEmailConfirmed() ) {
 228                         wfDebug( "User has no valid email.\n" );
 229
 230                         return 'noemail';
 231                 } elseif ( !$target->canReceiveEmail() ) {
 232                         wfDebug( "User does not allow user emails.\n" );
 233
 234                         return 'nowikiemail';
 235                 } elseif ( $sender !== null ) {
 236                         $blacklist = $target->getOption( 'email-blacklist', [] );
 237                         if ( $blacklist ) {
 238                                 $lookup = CentralIdLookup::factory();
 239                                 $senderId = $lookup->centralIdFromLocalUser( $sender );
 240                                 if ( $senderId !== 0 && in_array( $senderId, $blacklist ) ) {
 241                                         wfDebug( "User does not allow user emails from this user.\n" );
 242
 243                                         return 'nowikiemail';
 244                                 }
 245                         }
 246                 }
 247
 248                 return '';
 249         }
 250
 251         /**
 252          * Check whether a user is allowed to send email
 253          *
 254          * @param User $user
 255          * @param string $editToken Edit token
 256          * @param Config $config optional for backwards compatibility
 257          * @return string|null Null on success or string on error
 258          */
 259         public static function getPermissionsError( $user, $editToken, Config $config = null ) {
 260                 if ( $config === null ) {
 261                         wfDebug( __METHOD__ . ' called without a Config instance passed to it' );
 262                         $config = MediaWikiServices::getInstance()->getMainConfig();
 263                 }
 264                 if ( !$config->get( 'EnableEmail' ) || !$config->get( 'EnableUserEmail' ) ) {
 265                         return 'usermaildisabled';
 266                 }
 267
 268                 // Run this before $user->isAllowed, to show appropriate message to anons (T160309)
 269                 if ( !$user->isEmailConfirmed() ) {
 270                         return 'mailnologin';
 271                 }
 272
 273                 if ( !$user->isAllowed( 'sendemail' ) ) {
 274                         return 'badaccess';
 275                 }
 276
 277                 if ( $user->isBlockedFromEmailuser() ) {
 278                         wfDebug( "User is blocked from sending e-mail.\n" );
 279
 280                         return "blockedemailuser";
 281                 }
 282
 283                 if ( $user->pingLimiter( 'emailuser' ) ) {
 284                         wfDebug( "Ping limiter triggered.\n" );
 285
 286                         return 'actionthrottledtext';
 287                 }
 288
 289                 $hookErr = false;
 290
 291                 Hooks::run( 'UserCanSendEmail', [ &$user, &$hookErr ] );
 292                 Hooks::run( 'EmailUserPermissionsErrors', [ $user, $editToken, &$hookErr ] );
 293
 294                 if ( $hookErr ) {
 295                         return $hookErr;
 296                 }
 297
 298                 return null;
 299         }
 300
 301         /**
 302          * Form to ask for target user name.
 303          *
 304          * @param string $name User name submitted.
 305          * @return string Form asking for user name.
 306          */
 307         protected function userForm( $name ) {
 308                 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
 309                 $string = Html::openElement(
 310                                 'form',
 311                                 [ 'method' => 'get', 'action' => wfScript(), 'id' => 'askusername' ]
 312                         ) .
 313                         Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
 314                         Html::openElement( 'fieldset' ) .
 315                         Html::rawElement( 'legend', null, $this->msg( 'emailtarget' )->parse() ) .
 316                         Html::label(
 317                                 $this->msg( 'emailusername' )->text(),
 318                                 'emailusertarget'
 319                         ) . '&#160;' .
 320                         Html::input(
 321                                 'target',
 322                                 $name,
 323                                 'text',
 324                                 [
 325                                         'id' => 'emailusertarget',
 326                                         'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
 327                                         'autofocus' => true,
 328                                         'size' => 30,
 329                                 ]
 330                         ) .
 331                         ' ' .
 332                         Html::submitButton( $this->msg( 'emailusernamesubmit' )->text(), [] ) .
 333                         Html::closeElement( 'fieldset' ) .
 334                         Html::closeElement( 'form' ) . "\n";
 335
 336                 return $string;
 337         }
 338
 339         /**
 340          * Submit callback for an HTMLForm object, will simply call submit().
 341          *
 342          * @since 1.20
 343          * @param array $data
 344          * @param HTMLForm $form
 345          * @return Status|bool
 346          */
 347         public static function uiSubmit( array $data, HTMLForm $form ) {
 348                 return self::submit( $data, $form->getContext() );
 349         }
 350
 351         /**
 352          * Really send a mail. Permissions should have been checked using
 353          * getPermissionsError(). It is probably also a good
 354          * idea to check the edit token and ping limiter in advance.
 355          *
 356          * @param array $data
 357          * @param IContextSource $context
 358          * @return Status|bool
 359          */
 360         public static function submit( array $data, IContextSource $context ) {
 361                 $config = $context->getConfig();
 362
 363                 $target = self::getTarget( $data['Target'], $context->getUser() );
 364                 if ( !$target instanceof User ) {
 365                         // Messages used here: notargettext, noemailtext, nowikiemailtext
 366                         return Status::newFatal( $target . 'text' );
 367                 }
 368
 369                 $to = MailAddress::newFromUser( $target );
 370                 $from = MailAddress::newFromUser( $context->getUser() );
 371                 $subject = $data['Subject'];
 372                 $text = $data['Text'];
 373
 374                 // Add a standard footer and trim up trailing newlines
 375                 $text = rtrim( $text ) . "\n\n-- \n";
 376                 $text .= $context->msg( 'emailuserfooter',
 377                         $from->name, $to->name )->inContentLanguage()->text();
 378
 379                 $error = false;
 380                 if ( !Hooks::run( 'EmailUser', [ &$to, &$from, &$subject, &$text, &$error ] ) ) {
 381                         if ( $error instanceof Status ) {
 382                                 return $error;
 383                         } elseif ( $error === false || $error === '' || $error === [] ) {
 384                                 // Possibly to tell HTMLForm to pretend there was no submission?
 385                                 return false;
 386                         } elseif ( $error === true ) {
 387                                 // Hook sent the mail itself and indicates success?
 388                                 return Status::newGood();
 389                         } elseif ( is_array( $error ) ) {
 390                                 $status = Status::newGood();
 391                                 foreach ( $error as $e ) {
 392                                         $status->fatal( $e );
 393                                 }
 394                                 return $status;
 395                         } elseif ( $error instanceof MessageSpecifier ) {
 396                                 return Status::newFatal( $error );
 397                         } else {
 398                                 // Ugh. Either a raw HTML string, or something that's supposed
 399                                 // to be treated like one.
 400                                 $type = is_object( $error ) ? get_class( $error ) : gettype( $error );
 401                                 wfDeprecated( "EmailUser hook returning a $type as \$error", '1.29' );
 402                                 return Status::newFatal( new ApiRawMessage(
 403                                         [ '$1', Message::rawParam( (string)$error ) ], 'hookaborted'
 404                                 ) );
 405                         }
 406                 }
 407
 408                 if ( $config->get( 'UserEmailUseReplyTo' ) ) {
 409                         /**
 410                          * Put the generic wiki autogenerated address in the From:
 411                          * header and reserve the user for Reply-To.
 412                          *
 413                          * This is a bit ugly, but will serve to differentiate
 414                          * wiki-borne mails from direct mails and protects against
 415                          * SPF and bounce problems with some mailers (see below).
 416                          */
 417                         $mailFrom = new MailAddress( $config->get( 'PasswordSender' ),
 418                                 wfMessage( 'emailsender' )->inContentLanguage()->text() );
 419                         $replyTo = $from;
 420                 } else {
 421                         /**
 422                          * Put the sending user's e-mail address in the From: header.
 423                          *
 424                          * This is clean-looking and convenient, but has issues.
 425                          * One is that it doesn't as clearly differentiate the wiki mail
 426                          * from "directly" sent mails.
 427                          *
 428                          * Another is that some mailers (like sSMTP) will use the From
 429                          * address as the envelope sender as well. For open sites this
 430                          * can cause mails to be flunked for SPF violations (since the
 431                          * wiki server isn't an authorized sender for various users'
 432                          * domains) as well as creating a privacy issue as bounces
 433                          * containing the recipient's e-mail address may get sent to
 434                          * the sending user.
 435                          */
 436                         $mailFrom = $from;
 437                         $replyTo = null;
 438                 }
 439
 440                 $status = UserMailer::send( $to, $mailFrom, $subject, $text, [
 441                         'replyTo' => $replyTo,
 442                 ] );
 443
 444                 if ( !$status->isGood() ) {
 445                         return $status;
 446                 } else {
 447                         // if the user requested a copy of this mail, do this now,
 448                         // unless they are emailing themselves, in which case one
 449                         // copy of the message is sufficient.
 450                         if ( $data['CCMe'] && $to != $from ) {
 451                                 $ccTo = $from;
 452                                 $ccFrom = $from;
 453                                 $ccSubject = $context->msg( 'emailccsubject' )->rawParams(
 454                                         $target->getName(), $subject )->text();
 455                                 $ccText = $text;
 456
 457                                 Hooks::run( 'EmailUserCC', [ &$ccTo, &$ccFrom, &$ccSubject, &$ccText ] );
 458
 459                                 if ( $config->get( 'UserEmailUseReplyTo' ) ) {
 460                                         $mailFrom = new MailAddress(
 461                                                 $config->get( 'PasswordSender' ),
 462                                                 wfMessage( 'emailsender' )->inContentLanguage()->text()
 463                                         );
 464                                         $replyTo = $ccFrom;
 465                                 } else {
 466                                         $mailFrom = $ccFrom;
 467                                         $replyTo = null;
 468                                 }
 469
 470                                 $ccStatus = UserMailer::send(
 471                                         $ccTo, $mailFrom, $ccSubject, $ccText, [
 472                                                 'replyTo' => $replyTo,
 473                                 ] );
 474                                 $status->merge( $ccStatus );
 475                         }
 476
 477                         Hooks::run( 'EmailUserComplete', [ $to, $from, $subject, $text ] );
 478
 479                         return $status;
 480                 }
 481         }
 482
 483         /**
 484          * Return an array of subpages beginning with $search that this special page will accept.
 485          *
 486          * @param string $search Prefix to search for
 487          * @param int $limit Maximum number of results to return (usually 10)
 488          * @param int $offset Number of results to skip (usually 0)
 489          * @return string[] Matching subpages
 490          */
 491         public function prefixSearchSubpages( $search, $limit, $offset ) {
 492                 $user = User::newFromName( $search );
 493                 if ( !$user ) {
 494                         // No prefix suggestion for invalid user
 495                         return [];
 496                 }
 497                 // Autocomplete subpage as user list - public to allow caching
 498                 return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
 499         }
 500
 501         protected function getGroupName() {
 502                 return 'users';
 503         }
 504 }