MediaWiki  1.28.3
EmailNotification.php
Go to the documentation of this file.
1 <?php
27 
29 
49 
53  const USER_TALK = 'user_talk';
57  const WATCHLIST = 'watchlist';
61  const ALL_CHANGES = 'all_changes';
62 
63  protected $subject, $body, $replyto, $from;
65  protected $mailTargets = [];
66 
70  protected $title;
71 
75  protected $editor;
76 
87  public static function updateWatchlistTimestamp(
88  User $editor,
89  LinkTarget $linkTarget,
91  ) {
92  // wfDeprecated( __METHOD__, '1.27' );
93  $config = RequestContext::getMain()->getConfig();
94  if ( !$config->get( 'EnotifWatchlist' ) && !$config->get( 'ShowUpdatedMarker' ) ) {
95  return [];
96  }
97  return MediaWikiServices::getInstance()->getWatchedItemStore()->updateNotificationTimestamp(
98  $editor,
99  $linkTarget,
100  $timestamp
101  );
102  }
103 
117  public function notifyOnPageChange( $editor, $title, $timestamp, $summary,
118  $minorEdit, $oldid = false, $pageStatus = 'changed'
119  ) {
121 
122  if ( $title->getNamespace() < 0 ) {
123  return;
124  }
125 
126  // update wl_notificationtimestamp for watchers
127  $config = RequestContext::getMain()->getConfig();
128  $watchers = [];
129  if ( $config->get( 'EnotifWatchlist' ) || $config->get( 'ShowUpdatedMarker' ) ) {
130  $watchers = MediaWikiServices::getInstance()->getWatchedItemStore()->updateNotificationTimestamp(
131  $editor,
132  $title,
133  $timestamp
134  );
135  }
136 
137  $sendEmail = true;
138  // $watchers deals with $wgEnotifWatchlist.
139  // If nobody is watching the page, and there are no users notified on all changes
140  // don't bother creating a job/trying to send emails, unless it's a
141  // talk page with an applicable notification.
142  if ( !count( $watchers ) && !count( $wgUsersNotifiedOnAllChanges ) ) {
143  $sendEmail = false;
144  // Only send notification for non minor edits, unless $wgEnotifMinorEdits
145  if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
146  $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );
147  if ( $wgEnotifUserTalk
148  && $isUserTalkPage
149  && $this->canSendUserTalkEmail( $editor, $title, $minorEdit )
150  ) {
151  $sendEmail = true;
152  }
153  }
154  }
155 
156  if ( $sendEmail ) {
157  JobQueueGroup::singleton()->lazyPush( new EnotifNotifyJob(
158  $title,
159  [
160  'editor' => $editor->getName(),
161  'editorID' => $editor->getId(),
162  'timestamp' => $timestamp,
163  'summary' => $summary,
164  'minorEdit' => $minorEdit,
165  'oldid' => $oldid,
166  'watchers' => $watchers,
167  'pageStatus' => $pageStatus
168  ]
169  ) );
170  }
171  }
172 
189  public function actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit,
190  $oldid, $watchers, $pageStatus = 'changed' ) {
191  # we use $wgPasswordSender as sender's address
193  global $wgEnotifWatchlist, $wgBlockDisablesLogin;
195 
196  # The following code is only run, if several conditions are met:
197  # 1. EmailNotification for pages (other than user_talk pages) must be enabled
198  # 2. minor edits (changes) are only regarded if the global flag indicates so
199 
200  $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );
201 
202  $this->title = $title;
203  $this->timestamp = $timestamp;
204  $this->summary = $summary;
205  $this->minorEdit = $minorEdit;
206  $this->oldid = $oldid;
207  $this->editor = $editor;
208  $this->composed_common = false;
209  $this->pageStatus = $pageStatus;
210 
211  $formattedPageStatus = [ 'deleted', 'created', 'moved', 'restored', 'changed' ];
212 
213  Hooks::run( 'UpdateUserMailerFormattedPageStatus', [ &$formattedPageStatus ] );
214  if ( !in_array( $this->pageStatus, $formattedPageStatus ) ) {
215  throw new MWException( 'Not a valid page status!' );
216  }
217 
218  $userTalkId = false;
219 
220  if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
221  if ( $wgEnotifUserTalk
222  && $isUserTalkPage
223  && $this->canSendUserTalkEmail( $editor, $title, $minorEdit )
224  ) {
225  $targetUser = User::newFromName( $title->getText() );
226  $this->compose( $targetUser, self::USER_TALK );
227  $userTalkId = $targetUser->getId();
228  }
229 
230  if ( $wgEnotifWatchlist ) {
231  // Send updates to watchers other than the current editor
232  // and don't send to watchers who are blocked and cannot login
233  $userArray = UserArray::newFromIDs( $watchers );
234  foreach ( $userArray as $watchingUser ) {
235  if ( $watchingUser->getOption( 'enotifwatchlistpages' )
236  && ( !$minorEdit || $watchingUser->getOption( 'enotifminoredits' ) )
237  && $watchingUser->isEmailConfirmed()
238  && $watchingUser->getId() != $userTalkId
239  && !in_array( $watchingUser->getName(), $wgUsersNotifiedOnAllChanges )
240  && !( $wgBlockDisablesLogin && $watchingUser->isBlocked() )
241  ) {
242  if ( Hooks::run( 'SendWatchlistEmailNotification', [ $watchingUser, $title, $this ] ) ) {
243  $this->compose( $watchingUser, self::WATCHLIST );
244  }
245  }
246  }
247  }
248  }
249 
250  foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
251  if ( $editor->getName() == $name ) {
252  // No point notifying the user that actually made the change!
253  continue;
254  }
255  $user = User::newFromName( $name );
256  $this->compose( $user, self::ALL_CHANGES );
257  }
258 
259  $this->sendMails();
260  }
261 
268  private function canSendUserTalkEmail( $editor, $title, $minorEdit ) {
269  global $wgEnotifUserTalk, $wgBlockDisablesLogin;
270  $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );
271 
272  if ( $wgEnotifUserTalk && $isUserTalkPage ) {
273  $targetUser = User::newFromName( $title->getText() );
274 
275  if ( !$targetUser || $targetUser->isAnon() ) {
276  wfDebug( __METHOD__ . ": user talk page edited, but user does not exist\n" );
277  } elseif ( $targetUser->getId() == $editor->getId() ) {
278  wfDebug( __METHOD__ . ": user edited their own talk page, no notification sent\n" );
279  } elseif ( $wgBlockDisablesLogin && $targetUser->isBlocked() ) {
280  wfDebug( __METHOD__ . ": talk page owner is blocked and cannot login, no notification sent\n" );
281  } elseif ( $targetUser->getOption( 'enotifusertalkpages' )
282  && ( !$minorEdit || $targetUser->getOption( 'enotifminoredits' ) )
283  ) {
284  if ( !$targetUser->isEmailConfirmed() ) {
285  wfDebug( __METHOD__ . ": talk page owner doesn't have validated email\n" );
286  } elseif ( !Hooks::run( 'AbortTalkPageEmailNotification', [ $targetUser, $title ] ) ) {
287  wfDebug( __METHOD__ . ": talk page update notification is aborted for this user\n" );
288  } else {
289  wfDebug( __METHOD__ . ": sending talk page update notification\n" );
290  return true;
291  }
292  } else {
293  wfDebug( __METHOD__ . ": talk page owner doesn't want notifications\n" );
294  }
295  }
296  return false;
297  }
298 
302  private function composeCommonMailtext() {
306 
307  $this->composed_common = true;
308 
309  # You as the WikiAdmin and Sysops can make use of plenty of
310  # named variables when composing your notification emails while
311  # simply editing the Meta pages
312 
313  $keys = [];
314  $postTransformKeys = [];
315  $pageTitleUrl = $this->title->getCanonicalURL();
316  $pageTitle = $this->title->getPrefixedText();
317 
318  if ( $this->oldid ) {
319  // Always show a link to the diff which triggered the mail. See bug 32210.
320  $keys['$NEWPAGE'] = "\n\n" . wfMessage( 'enotif_lastdiff',
321  $this->title->getCanonicalURL( [ 'diff' => 'next', 'oldid' => $this->oldid ] ) )
322  ->inContentLanguage()->text();
323 
324  if ( !$wgEnotifImpersonal ) {
325  // For personal mail, also show a link to the diff of all changes
326  // since last visited.
327  $keys['$NEWPAGE'] .= "\n\n" . wfMessage( 'enotif_lastvisited',
328  $this->title->getCanonicalURL( [ 'diff' => '0', 'oldid' => $this->oldid ] ) )
329  ->inContentLanguage()->text();
330  }
331  $keys['$OLDID'] = $this->oldid;
332  // Deprecated since MediaWiki 1.21, not used by default. Kept for backwards-compatibility.
333  $keys['$CHANGEDORCREATED'] = wfMessage( 'changed' )->inContentLanguage()->text();
334  } else {
335  # clear $OLDID placeholder in the message template
336  $keys['$OLDID'] = '';
337  $keys['$NEWPAGE'] = '';
338  // Deprecated since MediaWiki 1.21, not used by default. Kept for backwards-compatibility.
339  $keys['$CHANGEDORCREATED'] = wfMessage( 'created' )->inContentLanguage()->text();
340  }
341 
342  $keys['$PAGETITLE'] = $this->title->getPrefixedText();
343  $keys['$PAGETITLE_URL'] = $this->title->getCanonicalURL();
344  $keys['$PAGEMINOREDIT'] = $this->minorEdit ?
345  wfMessage( 'minoredit' )->inContentLanguage()->text() : '';
346  $keys['$UNWATCHURL'] = $this->title->getCanonicalURL( 'action=unwatch' );
347 
348  if ( $this->editor->isAnon() ) {
349  # real anon (user:xxx.xxx.xxx.xxx)
350  $keys['$PAGEEDITOR'] = wfMessage( 'enotif_anon_editor', $this->editor->getName() )
351  ->inContentLanguage()->text();
352  $keys['$PAGEEDITOR_EMAIL'] = wfMessage( 'noemailtitle' )->inContentLanguage()->text();
353 
354  } else {
355  $keys['$PAGEEDITOR'] = $wgEnotifUseRealName && $this->editor->getRealName() !== ''
356  ? $this->editor->getRealName() : $this->editor->getName();
357  $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $this->editor->getName() );
358  $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getCanonicalURL();
359  }
360 
361  $keys['$PAGEEDITOR_WIKI'] = $this->editor->getUserPage()->getCanonicalURL();
362  $keys['$HELPPAGE'] = wfExpandUrl(
363  Skin::makeInternalOrExternalUrl( wfMessage( 'helppage' )->inContentLanguage()->text() )
364  );
365 
366  # Replace this after transforming the message, bug 35019
367  $postTransformKeys['$PAGESUMMARY'] = $this->summary == '' ? ' - ' : $this->summary;
368 
369  // Now build message's subject and body
370 
371  // Messages:
372  // enotif_subject_deleted, enotif_subject_created, enotif_subject_moved,
373  // enotif_subject_restored, enotif_subject_changed
374  $this->subject = wfMessage( 'enotif_subject_' . $this->pageStatus )->inContentLanguage()
375  ->params( $pageTitle, $keys['$PAGEEDITOR'] )->text();
376 
377  // Messages:
378  // enotif_body_intro_deleted, enotif_body_intro_created, enotif_body_intro_moved,
379  // enotif_body_intro_restored, enotif_body_intro_changed
380  $keys['$PAGEINTRO'] = wfMessage( 'enotif_body_intro_' . $this->pageStatus )
381  ->inContentLanguage()->params( $pageTitle, $keys['$PAGEEDITOR'], $pageTitleUrl )
382  ->text();
383 
384  $body = wfMessage( 'enotif_body' )->inContentLanguage()->plain();
385  $body = strtr( $body, $keys );
386  $body = MessageCache::singleton()->transform( $body, false, null, $this->title );
387  $this->body = wordwrap( strtr( $body, $postTransformKeys ), 72 );
388 
389  # Reveal the page editor's address as REPLY-TO address only if
390  # the user has not opted-out and the option is enabled at the
391  # global configuration level.
392  $adminAddress = new MailAddress( $wgPasswordSender,
393  wfMessage( 'emailsender' )->inContentLanguage()->text() );
394  if ( $wgEnotifRevealEditorAddress
395  && ( $this->editor->getEmail() != '' )
396  && $this->editor->getOption( 'enotifrevealaddr' )
397  ) {
398  $editorAddress = MailAddress::newFromUser( $this->editor );
399  if ( $wgEnotifFromEditor ) {
400  $this->from = $editorAddress;
401  } else {
402  $this->from = $adminAddress;
403  $this->replyto = $editorAddress;
404  }
405  } else {
406  $this->from = $adminAddress;
407  $this->replyto = new MailAddress( $wgNoReplyAddress );
408  }
409  }
410 
419  function compose( $user, $source ) {
421 
422  if ( !$this->composed_common ) {
423  $this->composeCommonMailtext();
424  }
425 
426  if ( $wgEnotifImpersonal ) {
427  $this->mailTargets[] = MailAddress::newFromUser( $user );
428  } else {
429  $this->sendPersonalised( $user, $source );
430  }
431  }
432 
436  function sendMails() {
438  if ( $wgEnotifImpersonal ) {
439  $this->sendImpersonal( $this->mailTargets );
440  }
441  }
442 
453  function sendPersonalised( $watchingUser, $source ) {
455  // From the PHP manual:
456  // Note: The to parameter cannot be an address in the form of
457  // "Something <someone@example.com>". The mail command will not parse
458  // this properly while talking with the MTA.
459  $to = MailAddress::newFromUser( $watchingUser );
460 
461  # $PAGEEDITDATE is the time and date of the page change
462  # expressed in terms of individual local time of the notification
463  # recipient, i.e. watching user
464  $body = str_replace(
465  [ '$WATCHINGUSERNAME',
466  '$PAGEEDITDATE',
467  '$PAGEEDITTIME' ],
468  [ $wgEnotifUseRealName && $watchingUser->getRealName() !== ''
469  ? $watchingUser->getRealName() : $watchingUser->getName(),
470  $wgContLang->userDate( $this->timestamp, $watchingUser ),
471  $wgContLang->userTime( $this->timestamp, $watchingUser ) ],
472  $this->body );
473 
474  $headers = [];
475  if ( $source === self::WATCHLIST ) {
476  $headers['List-Help'] = 'https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Watchlist';
477  }
478 
479  return UserMailer::send( $to, $this->from, $this->subject, $body, [
480  'replyTo' => $this->replyto,
481  'headers' => $headers,
482  ] );
483  }
484 
491  function sendImpersonal( $addresses ) {
493 
494  if ( empty( $addresses ) ) {
495  return null;
496  }
497 
498  $body = str_replace(
499  [ '$WATCHINGUSERNAME',
500  '$PAGEEDITDATE',
501  '$PAGEEDITTIME' ],
502  [ wfMessage( 'enotif_impersonal_salutation' )->inContentLanguage()->text(),
503  $wgContLang->date( $this->timestamp, false, false ),
504  $wgContLang->time( $this->timestamp, false, false ) ],
505  $this->body );
506 
507  return UserMailer::send( $addresses, $this->from, $this->subject, $body, [
508  'replyTo' => $this->replyto,
509  ] );
510  }
511 
512 }
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
Definition: User.php:525
This module processes the email notifications when the current page is changed.
composeCommonMailtext()
Generate the generic "this page has been changed" e-mail text.
Job for email notification mails.
getText()
Get the text form (spaces not underscores) of the main part.
Definition: Title.php:880
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable from
const WATCHLIST
Notification is due to a watchlisted page being edited.
$wgEnotifUseRealName
Use real name instead of username in e-mail "from" field.
canSendUserTalkEmail($editor, $title, $minorEdit)
$source
sendMails()
Send any queued mails.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
static updateWatchlistTimestamp(User $editor, LinkTarget $linkTarget, $timestamp)
sendPersonalised($watchingUser, $source)
Does the per-user customizations to a notification e-mail (name, timestamp in proper timezone...
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
title
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2108
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static getSafeTitleFor($name, $subpage=false)
Get a localised Title object for a page name with a possibly unvalidated subpage. ...
$wgUsersNotifiedOnAllChanges
Array of usernames who will be sent a notification email for every change which occurs on a wiki...
static send($to, $from, $subject, $body, $options=[])
This function will perform a direct (authenticated) login to a SMTP Server to use for mail relaying i...
Definition: UserMailer.php:114
$wgEnotifMinorEdits
Potentially send notification mails on minor edits to pages.
$wgEnotifImpersonal
Send a generic mail instead of a personalised mail for each user.
static getMain()
Static methods.
compose($user, $source)
Compose a mail to a given user and either queue it for sending, or send it now, depending on settings...
isAllowed($action= '')
Internal mechanics of testing a permission.
Definition: User.php:3443
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
notifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid=false, $pageStatus= 'changed')
Send emails corresponding to the user $editor editing the page $title.
Stores a single person's name and email address.
Definition: MailAddress.php:32
actuallyNotifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers, $pageStatus= 'changed')
Immediate version of notifyOnPageChange().
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
getNamespace()
Get the namespace index, i.e.
Definition: Title.php:921
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
static newFromUser(User $user)
Create a new MailAddress object for the given user.
Definition: MailAddress.php:59
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:246
$wgPasswordSender
Sender email address for e-mail notifications.
static singleton($wiki=false)
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
$wgEnotifRevealEditorAddress
Set the Reply-to address in notifications to the editor's address, if user allowed this in the prefer...
$wgEnotifFromEditor
True: from page editor if s/he opted-in.
getId()
Get the user's ID.
Definition: User.php:2083
const USER_TALK
Notification is due to user's user talk being edited.
sendImpersonal($addresses)
Same as sendPersonalised but does impersonal mail suitable for bulk mailing.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
static makeInternalOrExternalUrl($name)
If url string starts with http, consider as external URL, else internal.
Definition: Skin.php:1098
static newFromIDs($ids)
Definition: UserArray.php:43
const NS_USER_TALK
Definition: Defines.php:59
$wgNoReplyAddress
Reply-To address for e-mail notifications.
$wgEnotifWatchlist
Allow users to enable email notification ("enotif") on watchlist changes.
$wgEnotifUserTalk
Allow users to enable email notification ("enotif") when someone edits their user talk page...
static singleton()
Get the signleton instance of this class.
const ALL_CHANGES
Notification because user is notified for all changes.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304