includes/mail/EmailNotification.php

   1 <?php
   2 /**
   3  * Classes used to send e-mails
   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  * @author <brion@pobox.com>
  22  * @author <mail@tgries.de>
  23  * @author Tim Starling
  24  * @author Luke Welling lwelling@wikimedia.org
  25  */
  26
  27 /**
  28  * This module processes the email notifications when the current page is
  29  * changed. It looks up the table watchlist to find out which users are watching
  30  * that page.
  31  *
  32  * The current implementation sends independent emails to each watching user for
  33  * the following reason:
  34  *
  35  * - Each watching user will be notified about the page edit time expressed in
  36  * his/her local time (UTC is shown additionally). To achieve this, we need to
  37  * find the individual timeoffset of each watching user from the preferences..
  38  *
  39  * Suggested improvement to slack down the number of sent emails: We could think
  40  * of sending out bulk mails (bcc:user1,user2...) for all these users having the
  41  * same timeoffset in their preferences.
  42  *
  43  * Visit the documentation pages under http://meta.wikipedia.com/Enotif
  44  */
  45 class EmailNotification {
  46
  47         /**
  48          * Notification is due to user's user talk being edited
  49          */
  50         const USER_TALK = 'user_talk';
  51         /**
  52          * Notification is due to a watchlisted page being edited
  53          */
  54         const WATCHLIST = 'watchlist';
  55         /**
  56          * Notification because user is notified for all changes
  57          */
  58         const ALL_CHANGES = 'all_changes';
  59
  60         protected $subject, $body, $replyto, $from;
  61         protected $timestamp, $summary, $minorEdit, $oldid, $composed_common, $pageStatus;
  62         protected $mailTargets = array();
  63
  64         /**
  65          * @var Title
  66          */
  67         protected $title;
  68
  69         /**
  70          * @var User
  71          */
  72         protected $editor;
  73
  74         /**
  75          * @param User $editor The editor that triggered the update.  Their notification
  76          *  timestamp will not be updated(they have already seen it)
  77          * @param Title $title The title to update timestamps for
  78          * @param string $timestamp Set the update timestamp to this value
  79          * @return int[] Array of user IDs
  80          */
  81         public static function updateWatchlistTimestamp( User $editor, Title $title, $timestamp ) {
  82                 global $wgEnotifWatchlist, $wgShowUpdatedMarker;
  83
  84                 if ( !$wgEnotifWatchlist && !$wgShowUpdatedMarker ) {
  85                         return array();
  86                 }
  87
  88                 $dbw = wfGetDB( DB_MASTER );
  89                 $res = $dbw->select( array( 'watchlist' ),
  90                         array( 'wl_user' ),
  91                         array(
  92                                 'wl_user != ' . intval( $editor->getID() ),
  93                                 'wl_namespace' => $title->getNamespace(),
  94                                 'wl_title' => $title->getDBkey(),
  95                                 'wl_notificationtimestamp IS NULL',
  96                         ), __METHOD__
  97                 );
  98
  99                 $watchers = array();
 100                 foreach ( $res as $row ) {
 101                         $watchers[] = intval( $row->wl_user );
 102                 }
 103
 104                 if ( $watchers ) {
 105                         // Update wl_notificationtimestamp for all watching users except the editor
 106                         $fname = __METHOD__;
 107                         $dbw->onTransactionIdle(
 108                                 function () use ( $dbw, $timestamp, $watchers, $title, $fname ) {
 109                                         $dbw->update( 'watchlist',
 110                                                 array( /* SET */
 111                                                         'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
 112                                                 ), array( /* WHERE */
 113                                                         'wl_user' => $watchers,
 114                                                         'wl_namespace' => $title->getNamespace(),
 115                                                         'wl_title' => $title->getDBkey(),
 116                                                 ), $fname
 117                                         );
 118                                 }
 119                         );
 120                 }
 121
 122                 return $watchers;
 123         }
 124
 125         /**
 126          * Send emails corresponding to the user $editor editing the page $title.
 127          *
 128          * May be deferred via the job queue.
 129          *
 130          * @param User $editor
 131          * @param Title $title
 132          * @param string $timestamp
 133          * @param string $summary
 134          * @param bool $minorEdit
 135          * @param bool $oldid (default: false)
 136          * @param string $pageStatus (default: 'changed')
 137          */
 138         public function notifyOnPageChange( $editor, $title, $timestamp, $summary,
 139                 $minorEdit, $oldid = false, $pageStatus = 'changed'
 140         ) {
 141                 global $wgEnotifUseJobQ, $wgEnotifMinorEdits, $wgUsersNotifiedOnAllChanges, $wgEnotifUserTalk;
 142
 143                 if ( $title->getNamespace() < 0 ) {
 144                         return;
 145                 }
 146
 147                 // update wl_notificationtimestamp for watchers
 148                 $watchers = self::updateWatchlistTimestamp( $editor, $title, $timestamp );
 149
 150                 $sendEmail = true;
 151                 // $watchers deals with $wgEnotifWatchlist.
 152                 // If nobody is watching the page, and there are no users notified on all changes
 153                 // don't bother creating a job/trying to send emails, unless it's a
 154                 // talk page with an applicable notification.
 155                 if ( !count( $watchers ) && !count( $wgUsersNotifiedOnAllChanges ) ) {
 156                         $sendEmail = false;
 157                         // Only send notification for non minor edits, unless $wgEnotifMinorEdits
 158                         if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
 159                                 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );
 160                                 if ( $wgEnotifUserTalk
 161                                         && $isUserTalkPage
 162                                         && $this->canSendUserTalkEmail( $editor, $title, $minorEdit )
 163                                 ) {
 164                                         $sendEmail = true;
 165                                 }
 166                         }
 167                 }
 168
 169                 if ( !$sendEmail ) {
 170                         return;
 171                 }
 172
 173                 if ( $wgEnotifUseJobQ ) {
 174                         $params = array(
 175                                 'editor' => $editor->getName(),
 176                                 'editorID' => $editor->getID(),
 177                                 'timestamp' => $timestamp,
 178                                 'summary' => $summary,
 179                                 'minorEdit' => $minorEdit,
 180                                 'oldid' => $oldid,
 181                                 'watchers' => $watchers,
 182                                 'pageStatus' => $pageStatus
 183                         );
 184                         $job = new EnotifNotifyJob( $title, $params );
 185                         JobQueueGroup::singleton()->lazyPush( $job );
 186                 } else {
 187                         $this->actuallyNotifyOnPageChange(
 188                                 $editor,
 189                                 $title,
 190                                 $timestamp,
 191                                 $summary,
 192                                 $minorEdit,
 193                                 $oldid,
 194                                 $watchers,
 195                                 $pageStatus
 196                         );
 197                 }
 198         }
 199
 200         /**
 201          * Immediate version of notifyOnPageChange().
 202          *
 203          * Send emails corresponding to the user $editor editing the page $title.
 204          *
 205          * @note Do not call directly. Use notifyOnPageChange so that wl_notificationtimestamp is updated.
 206          * @param User $editor
 207          * @param Title $title
 208          * @param string $timestamp Edit timestamp
 209          * @param string $summary Edit summary
 210          * @param bool $minorEdit
 211          * @param int $oldid Revision ID
 212          * @param array $watchers Array of user IDs
 213          * @param string $pageStatus
 214          * @throws MWException
 215          */
 216         public function actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit,
 217                 $oldid, $watchers, $pageStatus = 'changed' ) {
 218                 # we use $wgPasswordSender as sender's address
 219                 global $wgEnotifWatchlist, $wgBlockDisablesLogin;
 220                 global $wgEnotifMinorEdits, $wgEnotifUserTalk;
 221
 222                 # The following code is only run, if several conditions are met:
 223                 # 1. EmailNotification for pages (other than user_talk pages) must be enabled
 224                 # 2. minor edits (changes) are only regarded if the global flag indicates so
 225
 226                 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );
 227
 228                 $this->title = $title;
 229                 $this->timestamp = $timestamp;
 230                 $this->summary = $summary;
 231                 $this->minorEdit = $minorEdit;
 232                 $this->oldid = $oldid;
 233                 $this->editor = $editor;
 234                 $this->composed_common = false;
 235                 $this->pageStatus = $pageStatus;
 236
 237                 $formattedPageStatus = array( 'deleted', 'created', 'moved', 'restored', 'changed' );
 238
 239                 Hooks::run( 'UpdateUserMailerFormattedPageStatus', array( &$formattedPageStatus ) );
 240                 if ( !in_array( $this->pageStatus, $formattedPageStatus ) ) {
 241                         throw new MWException( 'Not a valid page status!' );
 242                 }
 243
 244                 $userTalkId = false;
 245
 246                 if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
 247                         if ( $wgEnotifUserTalk
 248                                 && $isUserTalkPage
 249                                 && $this->canSendUserTalkEmail( $editor, $title, $minorEdit )
 250                         ) {
 251                                 $targetUser = User::newFromName( $title->getText() );
 252                                 $this->compose( $targetUser, self::USER_TALK );
 253                                 $userTalkId = $targetUser->getId();
 254                         }
 255
 256                         if ( $wgEnotifWatchlist ) {
 257                                 // Send updates to watchers other than the current editor
 258                                 // and don't send to watchers who are blocked and cannot login
 259                                 $userArray = UserArray::newFromIDs( $watchers );
 260                                 foreach ( $userArray as $watchingUser ) {
 261                                         if ( $watchingUser->getOption( 'enotifwatchlistpages' )
 262                                                 && ( !$minorEdit || $watchingUser->getOption( 'enotifminoredits' ) )
 263                                                 && $watchingUser->isEmailConfirmed()
 264                                                 && $watchingUser->getID() != $userTalkId
 265                                                 && !( $wgBlockDisablesLogin && $watchingUser->isBlocked() )
 266                                         ) {
 267                                                 if ( Hooks::run( 'SendWatchlistEmailNotification', array( $watchingUser, $title, $this ) ) ) {
 268                                                         $this->compose( $watchingUser, self::WATCHLIST );
 269                                                 }
 270                                         }
 271                                 }
 272                         }
 273                 }
 274
 275                 global $wgUsersNotifiedOnAllChanges;
 276                 foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
 277                         if ( $editor->getName() == $name ) {
 278                                 // No point notifying the user that actually made the change!
 279                                 continue;
 280                         }
 281                         $user = User::newFromName( $name );
 282                         $this->compose( $user, self::ALL_CHANGES );
 283                 }
 284
 285                 $this->sendMails();
 286         }
 287
 288         /**
 289          * @param User $editor
 290          * @param Title $title
 291          * @param bool $minorEdit
 292          * @return bool
 293          */
 294         private function canSendUserTalkEmail( $editor, $title, $minorEdit ) {
 295                 global $wgEnotifUserTalk, $wgBlockDisablesLogin;
 296                 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );
 297
 298                 if ( $wgEnotifUserTalk && $isUserTalkPage ) {
 299                         $targetUser = User::newFromName( $title->getText() );
 300
 301                         if ( !$targetUser || $targetUser->isAnon() ) {
 302                                 wfDebug( __METHOD__ . ": user talk page edited, but user does not exist\n" );
 303                         } elseif ( $targetUser->getId() == $editor->getId() ) {
 304                                 wfDebug( __METHOD__ . ": user edited their own talk page, no notification sent\n" );
 305                         } elseif ( $wgBlockDisablesLogin && $targetUser->isBlocked() ) {
 306                                 wfDebug( __METHOD__ . ": talk page owner is blocked and cannot login, no notification sent\n" );
 307                         } elseif ( $targetUser->getOption( 'enotifusertalkpages' )
 308                                 && ( !$minorEdit || $targetUser->getOption( 'enotifminoredits' ) )
 309                         ) {
 310                                 if ( !$targetUser->isEmailConfirmed() ) {
 311                                         wfDebug( __METHOD__ . ": talk page owner doesn't have validated email\n" );
 312                                 } elseif ( !Hooks::run( 'AbortTalkPageEmailNotification', array( $targetUser, $title ) ) ) {
 313                                         wfDebug( __METHOD__ . ": talk page update notification is aborted for this user\n" );
 314                                 } else {
 315                                         wfDebug( __METHOD__ . ": sending talk page update notification\n" );
 316                                         return true;
 317                                 }
 318                         } else {
 319                                 wfDebug( __METHOD__ . ": talk page owner doesn't want notifications\n" );
 320                         }
 321                 }
 322                 return false;
 323         }
 324
 325         /**
 326          * Generate the generic "this page has been changed" e-mail text.
 327          */
 328         private function composeCommonMailtext() {
 329                 global $wgPasswordSender, $wgNoReplyAddress;
 330                 global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
 331                 global $wgEnotifImpersonal, $wgEnotifUseRealName;
 332
 333                 $this->composed_common = true;
 334
 335                 # You as the WikiAdmin and Sysops can make use of plenty of
 336                 # named variables when composing your notification emails while
 337                 # simply editing the Meta pages
 338
 339                 $keys = array();
 340                 $postTransformKeys = array();
 341                 $pageTitleUrl = $this->title->getCanonicalURL();
 342                 $pageTitle = $this->title->getPrefixedText();
 343
 344                 if ( $this->oldid ) {
 345                         // Always show a link to the diff which triggered the mail. See bug 32210.
 346                         $keys['$NEWPAGE'] = "\n\n" . wfMessage( 'enotif_lastdiff',
 347                                         $this->title->getCanonicalURL( array( 'diff' => 'next', 'oldid' => $this->oldid ) ) )
 348                                         ->inContentLanguage()->text();
 349
 350                         if ( !$wgEnotifImpersonal ) {
 351                                 // For personal mail, also show a link to the diff of all changes
 352                                 // since last visited.
 353                                 $keys['$NEWPAGE'] .= "\n\n" . wfMessage( 'enotif_lastvisited',
 354                                                 $this->title->getCanonicalURL( array( 'diff' => '0', 'oldid' => $this->oldid ) ) )
 355                                                 ->inContentLanguage()->text();
 356                         }
 357                         $keys['$OLDID'] = $this->oldid;
 358                         // Deprecated since MediaWiki 1.21, not used by default. Kept for backwards-compatibility.
 359                         $keys['$CHANGEDORCREATED'] = wfMessage( 'changed' )->inContentLanguage()->text();
 360                 } else {
 361                         # clear $OLDID placeholder in the message template
 362                         $keys['$OLDID'] = '';
 363                         $keys['$NEWPAGE'] = '';
 364                         // Deprecated since MediaWiki 1.21, not used by default. Kept for backwards-compatibility.
 365                         $keys['$CHANGEDORCREATED'] = wfMessage( 'created' )->inContentLanguage()->text();
 366                 }
 367
 368                 $keys['$PAGETITLE'] = $this->title->getPrefixedText();
 369                 $keys['$PAGETITLE_URL'] = $this->title->getCanonicalURL();
 370                 $keys['$PAGEMINOREDIT'] = $this->minorEdit ?
 371                         wfMessage( 'minoredit' )->inContentLanguage()->text() : '';
 372                 $keys['$UNWATCHURL'] = $this->title->getCanonicalURL( 'action=unwatch' );
 373
 374                 if ( $this->editor->isAnon() ) {
 375                         # real anon (user:xxx.xxx.xxx.xxx)
 376                         $keys['$PAGEEDITOR'] = wfMessage( 'enotif_anon_editor', $this->editor->getName() )
 377                                 ->inContentLanguage()->text();
 378                         $keys['$PAGEEDITOR_EMAIL'] = wfMessage( 'noemailtitle' )->inContentLanguage()->text();
 379
 380                 } else {
 381                         $keys['$PAGEEDITOR'] = $wgEnotifUseRealName && $this->editor->getRealName() !== ''
 382                                 ? $this->editor->getRealName() : $this->editor->getName();
 383                         $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $this->editor->getName() );
 384                         $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getCanonicalURL();
 385                 }
 386
 387                 $keys['$PAGEEDITOR_WIKI'] = $this->editor->getUserPage()->getCanonicalURL();
 388                 $keys['$HELPPAGE'] = wfExpandUrl(
 389                         Skin::makeInternalOrExternalUrl( wfMessage( 'helppage' )->inContentLanguage()->text() )
 390                 );
 391
 392                 # Replace this after transforming the message, bug 35019
 393                 $postTransformKeys['$PAGESUMMARY'] = $this->summary == '' ? ' - ' : $this->summary;
 394
 395                 // Now build message's subject and body
 396
 397                 // Messages:
 398                 // enotif_subject_deleted, enotif_subject_created, enotif_subject_moved,
 399                 // enotif_subject_restored, enotif_subject_changed
 400                 $this->subject = wfMessage( 'enotif_subject_' . $this->pageStatus )->inContentLanguage()
 401                         ->params( $pageTitle, $keys['$PAGEEDITOR'] )->text();
 402
 403                 // Messages:
 404                 // enotif_body_intro_deleted, enotif_body_intro_created, enotif_body_intro_moved,
 405                 // enotif_body_intro_restored, enotif_body_intro_changed
 406                 $keys['$PAGEINTRO'] = wfMessage( 'enotif_body_intro_' . $this->pageStatus )
 407                         ->inContentLanguage()->params( $pageTitle, $keys['$PAGEEDITOR'], $pageTitleUrl )
 408                         ->text();
 409
 410                 $body = wfMessage( 'enotif_body' )->inContentLanguage()->plain();
 411                 $body = strtr( $body, $keys );
 412                 $body = MessageCache::singleton()->transform( $body, false, null, $this->title );
 413                 $this->body = wordwrap( strtr( $body, $postTransformKeys ), 72 );
 414
 415                 # Reveal the page editor's address as REPLY-TO address only if
 416                 # the user has not opted-out and the option is enabled at the
 417                 # global configuration level.
 418                 $adminAddress = new MailAddress( $wgPasswordSender,
 419                         wfMessage( 'emailsender' )->inContentLanguage()->text() );
 420                 if ( $wgEnotifRevealEditorAddress
 421                         && ( $this->editor->getEmail() != '' )
 422                         && $this->editor->getOption( 'enotifrevealaddr' )
 423                 ) {
 424                         $editorAddress = MailAddress::newFromUser( $this->editor );
 425                         if ( $wgEnotifFromEditor ) {
 426                                 $this->from = $editorAddress;
 427                         } else {
 428                                 $this->from = $adminAddress;
 429                                 $this->replyto = $editorAddress;
 430                         }
 431                 } else {
 432                         $this->from = $adminAddress;
 433                         $this->replyto = new MailAddress( $wgNoReplyAddress );
 434                 }
 435         }
 436
 437         /**
 438          * Compose a mail to a given user and either queue it for sending, or send it now,
 439          * depending on settings.
 440          *
 441          * Call sendMails() to send any mails that were queued.
 442          * @param User $user
 443          * @param string $source
 444          */
 445         function compose( $user, $source ) {
 446                 global $wgEnotifImpersonal;
 447
 448                 if ( !$this->composed_common ) {
 449                         $this->composeCommonMailtext();
 450                 }
 451
 452                 if ( $wgEnotifImpersonal ) {
 453                         $this->mailTargets[] = MailAddress::newFromUser( $user );
 454                 } else {
 455                         $this->sendPersonalised( $user, $source );
 456                 }
 457         }
 458
 459         /**
 460          * Send any queued mails
 461          */
 462         function sendMails() {
 463                 global $wgEnotifImpersonal;
 464                 if ( $wgEnotifImpersonal ) {
 465                         $this->sendImpersonal( $this->mailTargets );
 466                 }
 467         }
 468
 469         /**
 470          * Does the per-user customizations to a notification e-mail (name,
 471          * timestamp in proper timezone, etc) and sends it out.
 472          * Returns true if the mail was sent successfully.
 473          *
 474          * @param User $watchingUser
 475          * @param string $source
 476          * @return bool
 477          * @private
 478          */
 479         function sendPersonalised( $watchingUser, $source ) {
 480                 global $wgContLang, $wgEnotifUseRealName;
 481                 // From the PHP manual:
 482                 //   Note: The to parameter cannot be an address in the form of
 483                 //   "Something <someone@example.com>". The mail command will not parse
 484                 //   this properly while talking with the MTA.
 485                 $to = MailAddress::newFromUser( $watchingUser );
 486
 487                 # $PAGEEDITDATE is the time and date of the page change
 488                 # expressed in terms of individual local time of the notification
 489                 # recipient, i.e. watching user
 490                 $body = str_replace(
 491                         array( '$WATCHINGUSERNAME',
 492                                 '$PAGEEDITDATE',
 493                                 '$PAGEEDITTIME' ),
 494                         array( $wgEnotifUseRealName && $watchingUser->getRealName() !== ''
 495                                 ? $watchingUser->getRealName() : $watchingUser->getName(),
 496                                 $wgContLang->userDate( $this->timestamp, $watchingUser ),
 497                                 $wgContLang->userTime( $this->timestamp, $watchingUser ) ),
 498                         $this->body );
 499
 500                 $headers = array();
 501                 if ( $source === self::WATCHLIST ) {
 502                         $headers['List-Help'] = 'https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Watchlist';
 503                 }
 504
 505                 return UserMailer::send( $to, $this->from, $this->subject, $body, array(
 506                         'replyTo' => $this->replyto,
 507                         'headers' => $headers,
 508                 ) );
 509         }
 510
 511         /**
 512          * Same as sendPersonalised but does impersonal mail suitable for bulk
 513          * mailing.  Takes an array of MailAddress objects.
 514          * @param MailAddress[] $addresses
 515          * @return Status|null
 516          */
 517         function sendImpersonal( $addresses ) {
 518                 global $wgContLang;
 519
 520                 if ( empty( $addresses ) ) {
 521                         return null;
 522                 }
 523
 524                 $body = str_replace(
 525                         array( '$WATCHINGUSERNAME',
 526                                 '$PAGEEDITDATE',
 527                                 '$PAGEEDITTIME' ),
 528                         array( wfMessage( 'enotif_impersonal_salutation' )->inContentLanguage()->text(),
 529                                 $wgContLang->date( $this->timestamp, false, false ),
 530                                 $wgContLang->time( $this->timestamp, false, false ) ),
 531                         $this->body );
 532
 533                 return UserMailer::send( $addresses, $this->from, $this->subject, $body, array(
 534                         'replyTo' => $this->replyto,
 535                 ) );
 536         }
 537
 538 }