3 * Classes used to send e-mails
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.
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.
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
21 * @author <brion@pobox.com>
22 * @author <mail@tgries.de>
23 * @author Tim Starling
24 * @author Luke Welling lwelling@wikimedia.org
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
32 * The current implementation sends independent emails to each watching user for
33 * the following reason:
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..
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.
43 * Visit the documentation pages under http://meta.wikipedia.com/Enotif
45 class EmailNotification
{
46 protected $subject, $body, $replyto, $from;
47 protected $timestamp, $summary, $minorEdit, $oldid, $composed_common, $pageStatus;
48 protected $mailTargets = array();
61 * @param User $editor The editor that triggered the update. Their notification
62 * timestamp will not be updated(they have already seen it)
63 * @param Title $title The title to update timestamps for
64 * @param string $timestamp Set the update timestamp to this value
67 public static function updateWatchlistTimestamp( User
$editor, Title
$title, $timestamp ) {
68 global $wgEnotifWatchlist, $wgShowUpdatedMarker;
70 if ( !$wgEnotifWatchlist && !$wgShowUpdatedMarker ) {
74 $dbw = wfGetDB( DB_MASTER
);
75 $res = $dbw->select( array( 'watchlist' ),
78 'wl_user != ' . intval( $editor->getID() ),
79 'wl_namespace' => $title->getNamespace(),
80 'wl_title' => $title->getDBkey(),
81 'wl_notificationtimestamp IS NULL',
86 foreach ( $res as $row ) {
87 $watchers[] = intval( $row->wl_user
);
91 // Update wl_notificationtimestamp for all watching users except the editor
93 $dbw->onTransactionIdle(
94 function () use ( $dbw, $timestamp, $watchers, $title, $fname ) {
95 $dbw->update( 'watchlist',
97 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
99 'wl_user' => $watchers,
100 'wl_namespace' => $title->getNamespace(),
101 'wl_title' => $title->getDBkey(),
112 * Send emails corresponding to the user $editor editing the page $title.
114 * May be deferred via the job queue.
116 * @param User $editor
117 * @param Title $title
118 * @param string $timestamp
119 * @param string $summary
120 * @param bool $minorEdit
121 * @param bool $oldid (default: false)
122 * @param string $pageStatus (default: 'changed')
124 public function notifyOnPageChange( $editor, $title, $timestamp, $summary,
125 $minorEdit, $oldid = false, $pageStatus = 'changed'
127 global $wgEnotifUseJobQ, $wgEnotifMinorEdits, $wgUsersNotifiedOnAllChanges, $wgEnotifUserTalk;
129 if ( $title->getNamespace() < 0 ) {
133 // update wl_notificationtimestamp for watchers
134 $watchers = self
::updateWatchlistTimestamp( $editor, $title, $timestamp );
137 // If nobody is watching the page, and there are no users notified on all changes
138 // don't bother creating a job/trying to send emails
139 // $watchers deals with $wgEnotifWatchlist
140 if ( !count( $watchers ) && !count( $wgUsersNotifiedOnAllChanges ) ) {
142 // Only send notification for non minor edits, unless $wgEnotifMinorEdits
143 if ( !$minorEdit ||
( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
144 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK
);
145 if ( $wgEnotifUserTalk
147 && $this->canSendUserTalkEmail( $editor, $title, $minorEdit )
158 if ( $wgEnotifUseJobQ ) {
160 'editor' => $editor->getName(),
161 'editorID' => $editor->getID(),
162 'timestamp' => $timestamp,
163 'summary' => $summary,
164 'minorEdit' => $minorEdit,
166 'watchers' => $watchers,
167 'pageStatus' => $pageStatus
169 $job = new EnotifNotifyJob( $title, $params );
170 JobQueueGroup
::singleton()->lazyPush( $job );
172 $this->actuallyNotifyOnPageChange(
186 * Immediate version of notifyOnPageChange().
188 * Send emails corresponding to the user $editor editing the page $title.
190 * @note Do not call directly. Use notifyOnPageChange so that wl_notificationtimestamp is updated.
191 * @param User $editor
192 * @param Title $title
193 * @param string $timestamp Edit timestamp
194 * @param string $summary Edit summary
195 * @param bool $minorEdit
196 * @param int $oldid Revision ID
197 * @param array $watchers Array of user IDs
198 * @param string $pageStatus
199 * @throws MWException
201 public function actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit,
202 $oldid, $watchers, $pageStatus = 'changed' ) {
203 # we use $wgPasswordSender as sender's address
204 global $wgEnotifWatchlist, $wgBlockDisablesLogin;
205 global $wgEnotifMinorEdits, $wgEnotifUserTalk;
207 # The following code is only run, if several conditions are met:
208 # 1. EmailNotification for pages (other than user_talk pages) must be enabled
209 # 2. minor edits (changes) are only regarded if the global flag indicates so
211 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK
);
213 $this->title
= $title;
214 $this->timestamp
= $timestamp;
215 $this->summary
= $summary;
216 $this->minorEdit
= $minorEdit;
217 $this->oldid
= $oldid;
218 $this->editor
= $editor;
219 $this->composed_common
= false;
220 $this->pageStatus
= $pageStatus;
222 $formattedPageStatus = array( 'deleted', 'created', 'moved', 'restored', 'changed' );
224 Hooks
::run( 'UpdateUserMailerFormattedPageStatus', array( &$formattedPageStatus ) );
225 if ( !in_array( $this->pageStatus
, $formattedPageStatus ) ) {
226 throw new MWException( 'Not a valid page status!' );
231 if ( !$minorEdit ||
( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
232 if ( $wgEnotifUserTalk
234 && $this->canSendUserTalkEmail( $editor, $title, $minorEdit )
236 $targetUser = User
::newFromName( $title->getText() );
237 $this->compose( $targetUser );
238 $userTalkId = $targetUser->getId();
241 if ( $wgEnotifWatchlist ) {
242 // Send updates to watchers other than the current editor
243 // and don't send to watchers who are blocked and cannot login
244 $userArray = UserArray
::newFromIDs( $watchers );
245 foreach ( $userArray as $watchingUser ) {
246 if ( $watchingUser->getOption( 'enotifwatchlistpages' )
247 && ( !$minorEdit ||
$watchingUser->getOption( 'enotifminoredits' ) )
248 && $watchingUser->isEmailConfirmed()
249 && $watchingUser->getID() != $userTalkId
250 && !( $wgBlockDisablesLogin && $watchingUser->isBlocked() )
252 if ( Hooks
::run( 'SendWatchlistEmailNotification', array( $watchingUser, $title, $this ) ) ) {
253 $this->compose( $watchingUser );
260 global $wgUsersNotifiedOnAllChanges;
261 foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
262 if ( $editor->getName() == $name ) {
263 // No point notifying the user that actually made the change!
266 $user = User
::newFromName( $name );
267 $this->compose( $user );
274 * @param User $editor
275 * @param Title $title
276 * @param bool $minorEdit
279 private function canSendUserTalkEmail( $editor, $title, $minorEdit ) {
280 global $wgEnotifUserTalk, $wgBlockDisablesLogin;
281 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK
);
283 if ( $wgEnotifUserTalk && $isUserTalkPage ) {
284 $targetUser = User
::newFromName( $title->getText() );
286 if ( !$targetUser ||
$targetUser->isAnon() ) {
287 wfDebug( __METHOD__
. ": user talk page edited, but user does not exist\n" );
288 } elseif ( $targetUser->getId() == $editor->getId() ) {
289 wfDebug( __METHOD__
. ": user edited their own talk page, no notification sent\n" );
290 } elseif ( $wgBlockDisablesLogin && $targetUser->isBlocked() ) {
291 wfDebug( __METHOD__
. ": talk page owner is blocked and cannot login, no notification sent\n" );
292 } elseif ( $targetUser->getOption( 'enotifusertalkpages' )
293 && ( !$minorEdit ||
$targetUser->getOption( 'enotifminoredits' ) )
295 if ( !$targetUser->isEmailConfirmed() ) {
296 wfDebug( __METHOD__
. ": talk page owner doesn't have validated email\n" );
297 } elseif ( !Hooks
::run( 'AbortTalkPageEmailNotification', array( $targetUser, $title ) ) ) {
298 wfDebug( __METHOD__
. ": talk page update notification is aborted for this user\n" );
300 wfDebug( __METHOD__
. ": sending talk page update notification\n" );
304 wfDebug( __METHOD__
. ": talk page owner doesn't want notifications\n" );
311 * Generate the generic "this page has been changed" e-mail text.
313 private function composeCommonMailtext() {
314 global $wgPasswordSender, $wgNoReplyAddress;
315 global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
316 global $wgEnotifImpersonal, $wgEnotifUseRealName;
318 $this->composed_common
= true;
320 # You as the WikiAdmin and Sysops can make use of plenty of
321 # named variables when composing your notification emails while
322 # simply editing the Meta pages
325 $postTransformKeys = array();
326 $pageTitleUrl = $this->title
->getCanonicalURL();
327 $pageTitle = $this->title
->getPrefixedText();
329 if ( $this->oldid
) {
330 // Always show a link to the diff which triggered the mail. See bug 32210.
331 $keys['$NEWPAGE'] = "\n\n" . wfMessage( 'enotif_lastdiff',
332 $this->title
->getCanonicalURL( array( 'diff' => 'next', 'oldid' => $this->oldid
) ) )
333 ->inContentLanguage()->text();
335 if ( !$wgEnotifImpersonal ) {
336 // For personal mail, also show a link to the diff of all changes
337 // since last visited.
338 $keys['$NEWPAGE'] .= "\n\n" . wfMessage( 'enotif_lastvisited',
339 $this->title
->getCanonicalURL( array( 'diff' => '0', 'oldid' => $this->oldid
) ) )
340 ->inContentLanguage()->text();
342 $keys['$OLDID'] = $this->oldid
;
343 // Deprecated since MediaWiki 1.21, not used by default. Kept for backwards-compatibility.
344 $keys['$CHANGEDORCREATED'] = wfMessage( 'changed' )->inContentLanguage()->text();
346 # clear $OLDID placeholder in the message template
347 $keys['$OLDID'] = '';
348 $keys['$NEWPAGE'] = '';
349 // Deprecated since MediaWiki 1.21, not used by default. Kept for backwards-compatibility.
350 $keys['$CHANGEDORCREATED'] = wfMessage( 'created' )->inContentLanguage()->text();
353 $keys['$PAGETITLE'] = $this->title
->getPrefixedText();
354 $keys['$PAGETITLE_URL'] = $this->title
->getCanonicalURL();
355 $keys['$PAGEMINOREDIT'] = $this->minorEdit ?
356 wfMessage( 'minoredit' )->inContentLanguage()->text() : '';
357 $keys['$UNWATCHURL'] = $this->title
->getCanonicalURL( 'action=unwatch' );
359 if ( $this->editor
->isAnon() ) {
360 # real anon (user:xxx.xxx.xxx.xxx)
361 $keys['$PAGEEDITOR'] = wfMessage( 'enotif_anon_editor', $this->editor
->getName() )
362 ->inContentLanguage()->text();
363 $keys['$PAGEEDITOR_EMAIL'] = wfMessage( 'noemailtitle' )->inContentLanguage()->text();
366 $keys['$PAGEEDITOR'] = $wgEnotifUseRealName && $this->editor
->getRealName() !== ''
367 ?
$this->editor
->getRealName() : $this->editor
->getName();
368 $emailPage = SpecialPage
::getSafeTitleFor( 'Emailuser', $this->editor
->getName() );
369 $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getCanonicalURL();
372 $keys['$PAGEEDITOR_WIKI'] = $this->editor
->getUserPage()->getCanonicalURL();
373 $keys['$HELPPAGE'] = wfExpandUrl(
374 Skin
::makeInternalOrExternalUrl( wfMessage( 'helppage' )->inContentLanguage()->text() )
377 # Replace this after transforming the message, bug 35019
378 $postTransformKeys['$PAGESUMMARY'] = $this->summary
== '' ?
' - ' : $this->summary
;
380 // Now build message's subject and body
383 // enotif_subject_deleted, enotif_subject_created, enotif_subject_moved,
384 // enotif_subject_restored, enotif_subject_changed
385 $this->subject
= wfMessage( 'enotif_subject_' . $this->pageStatus
)->inContentLanguage()
386 ->params( $pageTitle, $keys['$PAGEEDITOR'] )->text();
389 // enotif_body_intro_deleted, enotif_body_intro_created, enotif_body_intro_moved,
390 // enotif_body_intro_restored, enotif_body_intro_changed
391 $keys['$PAGEINTRO'] = wfMessage( 'enotif_body_intro_' . $this->pageStatus
)
392 ->inContentLanguage()->params( $pageTitle, $keys['$PAGEEDITOR'], $pageTitleUrl )
395 $body = wfMessage( 'enotif_body' )->inContentLanguage()->plain();
396 $body = strtr( $body, $keys );
397 $body = MessageCache
::singleton()->transform( $body, false, null, $this->title
);
398 $this->body
= wordwrap( strtr( $body, $postTransformKeys ), 72 );
400 # Reveal the page editor's address as REPLY-TO address only if
401 # the user has not opted-out and the option is enabled at the
402 # global configuration level.
403 $adminAddress = new MailAddress( $wgPasswordSender,
404 wfMessage( 'emailsender' )->inContentLanguage()->text() );
405 if ( $wgEnotifRevealEditorAddress
406 && ( $this->editor
->getEmail() != '' )
407 && $this->editor
->getOption( 'enotifrevealaddr' )
409 $editorAddress = MailAddress
::newFromUser( $this->editor
);
410 if ( $wgEnotifFromEditor ) {
411 $this->from
= $editorAddress;
413 $this->from
= $adminAddress;
414 $this->replyto
= $editorAddress;
417 $this->from
= $adminAddress;
418 $this->replyto
= new MailAddress( $wgNoReplyAddress );
423 * Compose a mail to a given user and either queue it for sending, or send it now,
424 * depending on settings.
426 * Call sendMails() to send any mails that were queued.
429 function compose( $user ) {
430 global $wgEnotifImpersonal;
432 if ( !$this->composed_common
) {
433 $this->composeCommonMailtext();
436 if ( $wgEnotifImpersonal ) {
437 $this->mailTargets
[] = MailAddress
::newFromUser( $user );
439 $this->sendPersonalised( $user );
444 * Send any queued mails
446 function sendMails() {
447 global $wgEnotifImpersonal;
448 if ( $wgEnotifImpersonal ) {
449 $this->sendImpersonal( $this->mailTargets
);
454 * Does the per-user customizations to a notification e-mail (name,
455 * timestamp in proper timezone, etc) and sends it out.
456 * Returns true if the mail was sent successfully.
458 * @param User $watchingUser
462 function sendPersonalised( $watchingUser ) {
463 global $wgContLang, $wgEnotifUseRealName;
464 // From the PHP manual:
465 // Note: The to parameter cannot be an address in the form of
466 // "Something <someone@example.com>". The mail command will not parse
467 // this properly while talking with the MTA.
468 $to = MailAddress
::newFromUser( $watchingUser );
470 # $PAGEEDITDATE is the time and date of the page change
471 # expressed in terms of individual local time of the notification
472 # recipient, i.e. watching user
474 array( '$WATCHINGUSERNAME',
477 array( $wgEnotifUseRealName && $watchingUser->getRealName() !== ''
478 ?
$watchingUser->getRealName() : $watchingUser->getName(),
479 $wgContLang->userDate( $this->timestamp
, $watchingUser ),
480 $wgContLang->userTime( $this->timestamp
, $watchingUser ) ),
483 return UserMailer
::send( $to, $this->from
, $this->subject
, $body, $this->replyto
);
487 * Same as sendPersonalised but does impersonal mail suitable for bulk
488 * mailing. Takes an array of MailAddress objects.
489 * @param MailAddress[] $addresses
490 * @return Status|null
492 function sendImpersonal( $addresses ) {
495 if ( empty( $addresses ) ) {
500 array( '$WATCHINGUSERNAME',
503 array( wfMessage( 'enotif_impersonal_salutation' )->inContentLanguage()->text(),
504 $wgContLang->date( $this->timestamp
, false, false ),
505 $wgContLang->time( $this->timestamp
, false, false ) ),
508 return UserMailer
::send( $addresses, $this->from
, $this->subject
, $body, $this->replyto
);