$wgErrorString = preg_replace( "/^mail\(\): /", "", $string );
}
-class EmailNotification {
-
-var $to, $subject, $body, $replyto, $from;
-
-# Patch for email notification on page changes T.Gries/M.Arndt 11.09.2004
-#
-# This new module processes the email notifications when the current page is changed.
-# It looks up the table watchlist to find out which users are watching that page.
-#
-# The current implementation sends independent emails to each watching user for the following reason:
-#
-# - Each watching user will be notified about the page edit time expressed in his/her local time (UTC is shown additionally).
-# To achieve this, we need to find the individual timeoffset of each watching user from the preferences..
-#
-# Suggested improvement to slack down the number of sent emails:
-# We could think of sending out bulk mails (bcc:user1,user2...) for all these users having the same timeoffset in their preferences.
-#
-# - Visit the documentation pages under http://meta.wikipedia.com/Enotif
-
-function NotifyOnPageChange($currentUser, $currentPage, $currentNs, $timestamp, $currentSummary, $currentMinorEdit, $oldid=false) {
-
- # we use $wgEmergencyContact as sender's address
- global $wgUser, $wgLang, $wgEmergencyContact;
- global $wgEmailNotificationForWatchlistPages, $wgEmailNotificationForMinorEdits;
- global $wgEmailNotificationSystembeep, $wgEmailNotificationForUserTalkPages;
- global $wgEmailNotificationRevealPageEditorAddress;
- global $wgEmailNotificationMailsSentFromPageEditor;
- global $wgEmailAuthentication;
- global $beeped;
-
- # The following code is only run, if several conditions are met:
- # 1. EmailNotification for pages (other than user_talk pages) must be enabled
- # 2. minor edits (changes) are only regarded if the global flag indicates so
-
- $isUserTalkPage = ($currentNs == NS_USER_TALK);
- $enotifusertalkpage = ($isUserTalkPage && $wgEmailNotificationForUserTalkPages);
- $enotifwatchlistpage = (!$isUserTalkPage && $wgEmailNotificationForWatchlistPages);
-
- if ( ($enotifusertalkpage || $enotifwatchlistpage)
- && (!$currentMinorEdit || $wgEmailNotificationForMinorEdits) ) {
-
- $dbr =& wfGetDB( DB_MASTER );
- extract( $dbr->tableNames( 'watchlist' ) );
- $sql = "SELECT wl_user FROM $watchlist
- WHERE wl_title='" . $dbr->strencode($currentPage)."' AND wl_namespace = " . $currentNs .
- " AND wl_user <>" . $currentUser . " AND wl_notificationtimestamp <= 1";
- $res = $dbr->query( $sql,'UserMailer::NotifyOnChange');
-
- if ( $dbr->numRows( $res ) > 0 ) { # if anyone is watching ... set up the email message text which is common for all receipients ...
-
- # This is a switch for one beep on the server when sending notification mails
- $beeped = false;
-
- $article->mTimestamp = $timestamp;
- $article->mSummary = $currentSummary;
- $article->mMinorEdit = $currentMinorEdit;
- $article->mNamespace = $currentNs;
- $article->mTitle = $currentPage;
- $article->mOldid = $oldid;
-
- $mail = $this->ComposeCommonMailtext( $wgUser, $article );
- $watchingUser = new User();
-
- for ($i = 1; $i <= $dbr->numRows( $res ); $i++) { # ... now do for all watching users ... if the options fit
-
- $wuser = $dbr->fetchObject( $res );
- $watchingUser->setID($wuser->wl_user);
- if ( ( $enotifwatchlistpage && $watchingUser->getOption('enotifwatchlistpages') ) ||
- ( $enotifusertalkpage && $watchingUser->getOption('enotifusertalkpages') )
- && (!$currentMinorEdit || ($wgEmailNotificationForMinorEdits && $watchingUser->getOption('enotifminoredits') ) )
- && ($watchingUser->getEmail() != '')
- && (!$wgEmailAuthentication || ($watchingUser->getEmailAuthenticationtimestamp() != 0 ) ) ) {
- # ... adjust remaining text and page edit time placeholders
- # which needs to be personalized for each user
- $sent = $this->ComposeAndSendPersonalisedMail( $watchingUser, $mail, $article );
- /* the beep here beeps once when a watched-listed page is changed */
- if ($sent && !$beeped && ($wgEmailNotificationSystembeep != '') ) {
- $last_line = system($wgEmailNotificationSystembeep);
- $beeped=true;
- }
- } # if the watching user has an email address in the preferences
- # mark the changed watch-listed page with a timestamp, so that the page is listed with an "updated since your last visit" icon in the watch list, ...
- # ... no matter, if the watching user has or has not indicated an email address in his/her preferences.
- # We memorise the event of sending out a notification and use this as a flag to suppress further mails for changes on the same page for that watching user
- $dbw =& wfGetDB( DB_MASTER );
- $succes = $dbw->update( 'watchlist',
- array( /* SET */
- 'wl_notificationtimestamp' => $article->mTimestamp
- ), array( /* WHERE */
- 'wl_title' => $currentPage,
- 'wl_namespace' => $currentNs,
- 'wl_user' => $wuser->wl_user
- ), 'UserMailer::NotifyOnChange'
- );
- } # for every watching user
- } # if anyone is watching
- } # if $wgEmailNotificationForWatchlistPages = true
-} # function NotifyOnChange
-function ComposeCommonMailtext ( $pageeditorUser, $article ) {
-
- global $wgLang, $wgEmergencyContact;
- global $wgEmailNotificationRevealPageEditorAddress, $wgEmailNotificationMailsSentFromPageEditor;
- global $wgNoReplyAddress;
-
- $summary = ($article->mSummary == '') ? ' - ' : $article->mSummary;
- $medit = ($article->mMinorEdit) ? wfMsg( 'minoredit' ) : '';
-
- # You as the WikiAdmin and Sysops can make use of plenty of named variables when composing
- # your notification emails while simply editing the Meta pages
-
- $to = wfMsg( 'email_notification_to' );
- $subject = wfMsg( 'email_notification_subject' );
- $body = wfMsg( 'email_notification_body' );
- $from = ''; /* fail safe */
- $replyto = ''; /* fail safe */
-
- # regarding the use of oldid as an indicator for the last visited version, see also
- # http://bugzilla.wikipeda.org/show_bug.cgi?id=603 "Delete + undelete cycle doesn't preserve old_id"
- # However, in the case of a new page which is already watched, we have no previous version to compare
- if ($article->mOldid) {
- $body = str_replace('$NEWPAGE', wfMsg( 'email_notification_lastvisitedrevisiontext' ), $body);
- $body = str_replace('$OLDID', $article->mOldid , $body);
- } else {
- $body = str_replace('$NEWPAGE', wfMsg( 'email_notification_newpagetext' ), $body );
- $body = str_replace('$OLDID', '', $body); # clear $OLDID placeholder in the message template
- }
-
- $pagetitle = $article->mTitle;
- if ($article->mNamespace != 0) { $pagetitle = $wgLang->getNsText($article->mNamespace).':'.$pagetitle; };
- $subject = str_replace('$PAGETITLE_QP', wfQuotedPrintable(str_replace( '_', ' ', $pagetitle)), $subject);
- $body = str_replace('%24PAGETITLE_RAWURL', wfUrlencode($pagetitle), $body);
- $body = str_replace('$PAGETITLE_RAWURL', wfUrlencode($pagetitle), $body);
- $body = str_replace('%24PAGETITLE', $pagetitle, $body); # needed for the {{localurl:$PAGETITLE}} in the messagetext, "$" appears here as "%24"
- $body = str_replace('$PAGETITLE', $pagetitle, $body);
- $body = str_replace('$PAGETIMESTAMP', $article->mTimestamp, $body); # this is the raw internal timestamp - can be useful, too
- $body = str_replace('$PAGEEDITDATEUTC', $wgLang->timeanddate( $article->mTimestamp, false, false, false, true ), $body);
- $body = str_replace('$PAGEMINOREDIT', $medit,$body);
- $body = str_replace('$PAGESUMMARY', $summary, $body);
-
- $pageeditor_qp = wfQuotedPrintable($pageeditorUser->getName());
- # the user who edited is $pageeditorUser->getName():
- # reveal the page editor's address as REPLY-TO address only if the user has not opted-out
- if (($pageeditorUser->getEmail() != '')
- && $pageeditorUser->getOption('enotifrevealaddr')
- && $wgEmailNotificationRevealPageEditorAddress ) {
- if ($wgEmailNotificationMailsSentFromPageEditor) {
- $from = $pageeditorUser->getName().' <'.$pageeditorUser->getEmail().'>';
+/**
+ * Patch for email notification on page changes T.Gries/M.Arndt 11.09.2004
+ *
+ * This new module processes the email notifications when the current page is changed.
+ * It looks up the table watchlist to find out which users are watching that page.
+ *
+ * The current implementation sends independent emails to each watching user for the following reason:
+ *
+ * - Each watching user will be notified about the page edit time expressed in his/her local time (UTC is shown additionally).
+ * To achieve this, we need to find the individual timeoffset of each watching user from the preferences..
+ *
+ * Suggested improvement to slack down the number of sent emails:
+ * We could think of sending out bulk mails (bcc:user1,user2...) for all these users having the same timeoffset in their preferences.
+ *
+ * - Visit the documentation pages under http://meta.wikipedia.com/Enotif
+ */
+class EmailNotification {
+ var $to, $subject, $body, $replyto, $from;
+
+ function NotifyOnPageChange($currentUser, $currentPage, $currentNs, $timestamp, $currentSummary, $currentMinorEdit, $oldid=false) {
+
+ # we use $wgEmergencyContact as sender's address
+ global $wgUser, $wgLang, $wgEmergencyContact;
+ global $wgEmailNotificationForWatchlistPages, $wgEmailNotificationForMinorEdits;
+ global $wgEmailNotificationSystembeep, $wgEmailNotificationForUserTalkPages;
+ global $wgEmailNotificationRevealPageEditorAddress;
+ global $wgEmailNotificationMailsSentFromPageEditor;
+ global $wgEmailAuthentication;
+ global $beeped;
+
+ # The following code is only run, if several conditions are met:
+ # 1. EmailNotification for pages (other than user_talk pages) must be enabled
+ # 2. minor edits (changes) are only regarded if the global flag indicates so
+
+ $isUserTalkPage = ($currentNs == NS_USER_TALK);
+ $enotifusertalkpage = ($isUserTalkPage && $wgEmailNotificationForUserTalkPages);
+ $enotifwatchlistpage = (!$isUserTalkPage && $wgEmailNotificationForWatchlistPages);
+
+ if ( ($enotifusertalkpage || $enotifwatchlistpage)
+ && (!$currentMinorEdit || $wgEmailNotificationForMinorEdits) ) {
+
+ $dbr =& wfGetDB( DB_MASTER );
+ extract( $dbr->tableNames( 'watchlist' ) );
+ $sql = "SELECT wl_user FROM $watchlist
+ WHERE wl_title='" . $dbr->strencode($currentPage)."' AND wl_namespace = " . $currentNs .
+ " AND wl_user <>" . $currentUser . " AND wl_notificationtimestamp <= 1";
+ $res = $dbr->query( $sql,'UserMailer::NotifyOnChange');
+
+ if ( $dbr->numRows( $res ) > 0 ) { # if anyone is watching ... set up the email message text which is common for all receipients ...
+
+ # This is a switch for one beep on the server when sending notification mails
+ $beeped = false;
+
+ $article->mTimestamp = $timestamp;
+ $article->mSummary = $currentSummary;
+ $article->mMinorEdit = $currentMinorEdit;
+ $article->mNamespace = $currentNs;
+ $article->mTitle = $currentPage;
+ $article->mOldid = $oldid;
+
+ $mail = $this->composeCommonMailtext( $wgUser, $article );
+ $watchingUser = new User();
+
+ for ($i = 1; $i <= $dbr->numRows( $res ); $i++) { # ... now do for all watching users ... if the options fit
+
+ $wuser = $dbr->fetchObject( $res );
+ $watchingUser->setID($wuser->wl_user);
+ if ( ( $enotifwatchlistpage && $watchingUser->getOption('enotifwatchlistpages') ) ||
+ ( $enotifusertalkpage && $watchingUser->getOption('enotifusertalkpages') )
+ && (!$currentMinorEdit || ($wgEmailNotificationForMinorEdits && $watchingUser->getOption('enotifminoredits') ) )
+ && ($watchingUser->getEmail() != '')
+ && (!$wgEmailAuthentication || ($watchingUser->getEmailAuthenticationtimestamp() != 0 ) ) ) {
+ # ... adjust remaining text and page edit time placeholders
+ # which needs to be personalized for each user
+ $sent = $this->composeAndSendPersonalisedMail( $watchingUser, $mail, $article );
+ /* the beep here beeps once when a watched-listed page is changed */
+ if ($sent && !$beeped && ($wgEmailNotificationSystembeep != '') ) {
+ $last_line = system($wgEmailNotificationSystembeep);
+ $beeped=true;
+ }
+ } # if the watching user has an email address in the preferences
+ # mark the changed watch-listed page with a timestamp, so that the page is listed with an "updated since your last visit" icon in the watch list, ...
+ # ... no matter, if the watching user has or has not indicated an email address in his/her preferences.
+ # We memorise the event of sending out a notification and use this as a flag to suppress further mails for changes on the same page for that watching user
+ $dbw =& wfGetDB( DB_MASTER );
+ $succes = $dbw->update( 'watchlist',
+ array( /* SET */
+ 'wl_notificationtimestamp' => $article->mTimestamp
+ ), array( /* WHERE */
+ 'wl_title' => $currentPage,
+ 'wl_namespace' => $currentNs,
+ 'wl_user' => $wuser->wl_user
+ ), 'UserMailer::NotifyOnChange'
+ );
+ } # for every watching user
+ } # if anyone is watching
+ } # if $wgEmailNotificationForWatchlistPages = true
+ } # function NotifyOnChange
+
+ /**
+ * @param User $pageeditorUser
+ * @param Article $article
+ * @access private
+ */
+ function composeCommonMailtext( $pageeditorUser, $article ) {
+ global $wgLang, $wgEmergencyContact;
+ global $wgEmailNotificationRevealPageEditorAddress;
+ global $wgEmailNotificationMailsSentFromPageEditor;
+ global $wgNoReplyAddress;
+
+ $summary = ($article->mSummary == '') ? ' - ' : $article->mSummary;
+ $medit = ($article->mMinorEdit) ? wfMsg( 'minoredit' ) : '';
+
+ # You as the WikiAdmin and Sysops can make use of plenty of
+ # named variables when composing your notification emails while
+ # simply editing the Meta pages
+
+ $to = wfMsg( 'email_notification_to' );
+ $subject = wfMsg( 'email_notification_subject' );
+ $body = wfMsg( 'email_notification_body' );
+ $from = ''; /* fail safe */
+ $replyto = ''; /* fail safe */
+ $keys = array();
+
+ # regarding the use of oldid as an indicator for the last visited version, see also
+ # http://bugzilla.wikipeda.org/show_bug.cgi?id=603 "Delete + undelete cycle doesn't preserve old_id"
+ # However, in the case of a new page which is already watched, we have no previous version to compare
+ if( $article->mOldid ) {
+ $keys['$NEWPAGE'] = wfMsg( 'email_notification_lastvisitedrevisiontext' );
+ $keys['$OLDID'] = $article->mOldid;
} else {
- $from = 'WikiAdmin <'.$wgEmergencyContact.'>';
- if ($wgEmailNotificationRevealPageEditorAddress) {
- $replyto = $pageeditorUser->getName().' <'.$pageeditorUser->getEmail().'>';
- }
+ $keys['$NEWPAGE'] = wfMsg( 'email_notification_newpagetext' );
+ # clear $OLDID placeholder in the message template
+ $keys['$OLDID'] = '';
}
- $body = str_replace('$PAGEEDITORNAMEANDEMAILADDR', $pageeditorUser->getName().' <'.$pageeditorUser->getEmail().'>', $body);
- } else {
- $from = 'WikiAdmin <'.$wgEmergencyContact.'>';
- $replyto = $wgNoReplyAddress;
- $body = str_replace('$PAGEEDITORNAMEANDEMAILADDR', $replyto, $body);
- }
+
+ $pagetitle = $article->mTitle;
+ if( $article->mNamespace != NS_MAIN ) {
+ $pagetitle = $wgLang->getNsText( $article->mNamespace ) . ':' . $pagetitle;
+ }
+ $subject = str_replace( '$PAGETITLE_QP', wfQuotedPrintable( str_replace( '_', ' ', $pagetitle ) ), $subject);
+ $keys['%24PAGETITLE_RAWURL'] = wfUrlencode( $pagetitle );
+ $keys['$PAGETITLE_RAWURL'] = wfUrlencode( $pagetitle );
+ $keys['%24PAGETITLE'] = $pagetitle; # needed for the {{localurl:$PAGETITLE}} in the messagetext, "$" appears here as "%24"
+ $keys['$PAGETITLE'] = $pagetitle;
+ $keys['$PAGETIMESTAMP'] = $article->mTimestamp; # this is the raw internal timestamp - can be useful, too
+ $keys['$PAGEEDITDATEUTC'] = $wgLang->timeanddate( $article->mTimestamp, false, false, false, true );
+ $keys['$PAGEMINOREDIT'] = $medit;
+ $keys['$PAGESUMMARY'] = $summary;
+
- if ($pageeditorUser->isIP($pageeditorUser->getName())) { #real anon (user:xxx.xxx.xxx.xxx)
- $subject = str_replace('$PAGEEDITOR_QP', 'anonymous user ' . $pageeditorUser->getName(), $subject);
- $body = str_replace('$PAGEEDITOR_RAWURL', wfUrlencode($pageeditorUser->getName()) . ' (anonymous user)' , $body);
- $body = str_replace('%24PAGEEDITOR_RAWURL', wfUrlencode($pageeditorUser->getName()) . ' (anonymous user)' , $body);
- $body = str_replace('%24PAGEEDITORE', $pageeditorUser->getName() . ' (anonymous user)' , $body);
- $body = str_replace('$PAGEEDITORE', $pageeditorUser->getName() . ' (anonymous user)' , $body);
- $body = str_replace('$PAGEEDITOR', 'anonymous user ' . $pageeditorUser->getName(), $body);
- } else {
- $subject = str_replace('$PAGEEDITOR_QP', $pageeditor_qp, $subject);
- $body = str_replace('$PAGEEDITOR_RAWURL', wfUrlencode($pageeditorUser->getName()), $body);
- $body = str_replace('%24PAGEEDITOR_RAWURL', wfUrlencode($pageeditorUser->getName()), $body);
- $body = str_replace('%24PAGEEDITORE', str_replace( ' ', '_', $pageeditorUser->getName()), $body);
- $body = str_replace('$PAGEEDITORE', str_replace( ' ', '_', $pageeditorUser->getName()), $body);
- $body = str_replace('$PAGEEDITOR',$pageeditorUser->getName(), $body);
+ # Reveal the page editor's address as REPLY-TO address only if
+ # the user has not opted-out and the option is enabled at the
+ # global configuration level.
+ $pageeditor_qp = wfQuotedPrintable( $pageeditorUser->getName() );
+ $adminAddress = 'WikiAdmin <' . $wgEmergencyContact . '>';
+ $editorAddress = $pageeditorUser->getName() . ' <' . $pageeditorUser->getEmail() . '>';
+ if( $wgEmailNotificationRevealPageEditorAddress
+ && ( $pageeditorUser->getEmail() != '' )
+ && $pageeditorUser->getOption( 'enotifrevealaddr' ) ) {
+ if( $wgEmailNotificationMailsSentFromPageEditor ) {
+ $from = $editorAddress;
+ } else {
+ $from = $adminAddress;
+ $replyto = $editorAddress;
+ }
+ $keys['$PAGEEDITORNAMEANDEMAILADDR'] = $editorAddress;
+ } else {
+ $from = $adminAddress;
+ $replyto = $wgNoReplyAddress;
+ $keys['$PAGEEDITORNAMEANDEMAILADDR'] = $replyto;
+ }
+
+ if( $pageeditorUser->isIP( $pageeditorUser->getName() ) ) {
+ #real anon (user:xxx.xxx.xxx.xxx)
+ $subject = str_replace('$PAGEEDITOR_QP', 'anonymous user ' . $pageeditorUser->getName(), $subject);
+ $name = $pageeditorUser->getName();
+ $anon = $name . ' (anonymous user)';
+ $anonUrl = wfUrlencode( $name ) . ' (anonymous user)';
+
+ $keys['$PAGEEDITOR_RAWURL'] = $anonUrl;
+ $keys['%24PAGEEDITOR_RAWURL'] = $anonUrl;
+ $keys['%24PAGEEDITORE'] = $anon;
+ $keys['$PAGEEDITORE'] = $anon;
+ $keys['$PAGEEDITOR'] = 'anonymous user ' . $name;
+ } else {
+ $name = $pageeditorUser->getName();
+ $subject = str_replace('$PAGEEDITOR_QP', $pageeditor_qp, $subject);
+ $keys['$PAGEEDITOR_RAWURL'] = wfUrlencode( $name );
+ $keys['%24PAGEEDITOR_RAWURL'] = wfUrlencode( $name );
+ $keys['%24PAGEEDITORE'] = $pageeditorUser->getTitleKey();
+ $keys['$PAGEEDITORE'] = $pageeditorUser->getTitleKey();
+ $keys['$PAGEEDITOR'] = $pageeditorUser->getName();
+ }
+ $body = strtr( $body, $keys );
+
+ # now save this as the constant user-independent part of the message
+ $this->to = $to;
+ $this->from = $from;
+ $this->replyto = $replyto;
+ $this->subject = $subject;
+ $this->body = $body;
+ return $this;
}
- # now save this as the constant user-independent part of the message
- $this->to = $to;
- $this->from = $from;
- $this->replyto = $replyto;
- $this->subject = $subject;
- $this->body = $body;
- return $this;
-}
-
-
-function ComposeAndSendPersonalisedMail( $watchingUser, $mail, $article) {
- /* returns true if the mail was sent successfully */
- global $wgLang;
-
- $to = $watchingUser->getName().' <'.$watchingUser->getEmail().'>';
- $body = str_replace('$WATCHINGUSERNAME', $watchingUser->getName() , $mail->body);
- $body = str_replace('$WATCHINGUSEREMAILADDR', $watchingUser->getEmail(), $body);
-
- $timecorrection = $watchingUser->getOption('timecorrection');
- if (!$timecorrection) { $timecorrection = '00:00'; } # fail safe - I prefer it. TomGries
- # $PAGEEDITDATE is the time and date of the page change expressed in terms of individual local time of the notification recipient, i.e. watching user
- $body = str_replace('$PAGEEDITDATE', $wgLang->timeanddate($article->mTimestamp, true, false, $timecorrection, true), $body);
- return (userMailer($to, $mail->from, $mail->subject, $body, $mail->replyto) == '');
-}
+
+ /**
+ * Does the per-user customizations to a notification e-mail (name,
+ * timestamp in proper timezone, etc) and sends it out.
+ * Returns true if the mail was sent successfully.
+ *
+ * @param User $watchingUser
+ * @param object $mail
+ * @param Article $article
+ * @return bool
+ * @access private
+ */
+ function composeAndSendPersonalisedMail( $watchingUser, $mail, $article ) {
+ global $wgLang;
+
+ $to = $watchingUser->getName() . ' <' . $watchingUser->getEmail() . '>';
+ $body = str_replace( '$WATCHINGUSERNAME', $watchingUser->getName() , $mail->body );
+ $body = str_replace( '$WATCHINGUSEREMAILADDR', $watchingUser->getEmail(), $body );
+
+ $timecorrection = $watchingUser->getOption( 'timecorrection' );
+ if( !$timecorrection ) {
+ # fail safe - I prefer it. TomGries
+ $timecorrection = '00:00';
+ }
+ # $PAGEEDITDATE is the time and date of the page change
+ # expressed in terms of individual local time of the notification
+ # recipient, i.e. watching user
+ $body = str_replace('$PAGEEDITDATE',
+ $wgLang->timeanddate( $article->mTimestamp, true, false, $timecorrection, true),
+ $body);
+
+ $error = userMailer( $to, $mail->from, $mail->subject, $body, $mail->replyto );
+ return ($error == '');
+ }
} # end of class EmailNotification
?>