<?php
-/** Copyright (C) 2004 Thomas Gries <mail@tgries.de>
-# http://www.mediawiki.org/
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-# http://www.gnu.org/copyleft/gpl.html
-**/
-
/**
- * Provide mail capabilities
+ * Classes used to send e-mails
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
*
- * @package MediaWiki
+ * @file
+ * @author <brion@pobox.com>
+ * @author <mail@tgries.de>
+ * @author Tim Starling
*/
-function wfQuotedPrintable_name_and_emailaddr( $string ) {
- /* it takes formats like "name <emailaddr>" into account,
- for which the partial string "name" will be quoted-printable converted
- but not "<emailaddr>".
-
- The php mail() function does not accept the email address partial string
- to be quotedprintable, it does not accept inputs as quotedprintable("name <emailaddr>") .
-
- case 1:
- input: "name <emailaddr> rest"
- output: "quoted-printable(name) <emailaddr>"
-
- case 2: (should not happen)
- input: "<emailaddr> rest"
- output: "<emailaddr>"
- case 3: (should not happen)
- input: "name"
- output: "quoted-printable(name)"
+/**
+ * Stores a single person's name and email address.
+ * These are passed in via the constructor, and will be returned in SMTP
+ * header format when requested.
+ */
+class MailAddress {
+ /**
+ * @param $address Mixed: string with an email address, or a User object
+ * @param $name String: human-readable name if a string address is given
+ * @param $realName String: human-readable real name if a string address is given
+ */
+ function __construct( $address, $name = null, $realName = null ) {
+ if ( is_object( $address ) && $address instanceof User ) {
+ $this->address = $address->getEmail();
+ $this->name = $address->getName();
+ $this->realName = $address->getRealName();
+ } else {
+ $this->address = strval( $address );
+ $this->name = strval( $name );
+ $this->realName = strval( $realName );
+ }
+ }
- T. Gries 18.11.2004
- */
+ /**
+ * Return formatted and quoted address to insert into SMTP headers
+ * @return string
+ */
+ function toString() {
+ # PHP's mail() implementation under Windows is somewhat shite, and
+ # can't handle "Joe Bloggs <joe@bloggs.com>" format email addresses,
+ # so don't bother generating them
+ if ( $this->name != '' && !wfIsWindows() ) {
+ global $wgEnotifUseRealName;
+ $name = ( $wgEnotifUseRealName && $this->realName ) ? $this->realName : $this->name;
+ $quoted = UserMailer::quotedPrintable( $name );
+ if ( strpos( $quoted, '.' ) !== false || strpos( $quoted, ',' ) !== false ) {
+ $quoted = '"' . $quoted . '"';
+ }
+ return "$quoted <{$this->address}>";
+ } else {
+ return $this->address;
+ }
+ }
- /* do not quote printable for email address string <emailaddr>, but only for the (leading) string, usually the name */
- preg_match( '/^([^<]*)?(<([A-z0-9_.-]+([A-z0-9_.-]+)*\@[A-z0-9_-]+([A-z0-9_.-]+)*([A-z.]{2,})+)>)?$/', $string, $part );
- if ( !isset($part[1]) ) return $part[2];
- if ( !isset($part[2]) ) return wfQuotedprintable($part[1]);
- return wfQuotedprintable($part[1]) . $part[2] ;
+ function __toString() {
+ return $this->toString();
+ }
}
+
/**
- * This function will perform a direct (authenticated) login to
- * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
- * array of parameters. It requires PEAR:Mail to do that.
- * Otherwise it just uses the standard PHP 'mail' function.
- *
- * @param string $to recipient's email
- * @param string $from sender's email
- * @param string $subject email's subject
- * @param string $body email's text
+ * Collection of static functions for sending mail
*/
-function userMailer( $to, $from, $subject, $body, $replyto=false ) {
- global $wgUser, $wgSMTP, $wgOutputEncoding, $wgErrorString, $wgEmergencyContact;
-
- $qto = wfQuotedPrintable_name_and_emailaddr( $to );
-
- if (is_array( $wgSMTP )) {
- require_once( 'Mail.php' );
-
- $timestamp = time();
-
- $headers['From'] = $from;
-/* removing to: field as it should be set by the send() function below
- UNTESTED - Hashar */
-// $headers['To'] = $qto;
-/* Reply-To:
- UNTESTED - Tom Gries */
- $headers['Reply-To'] = $replyto;
- $headers['Subject'] = $subject;
- $headers['MIME-Version'] = '1.0';
- $headers['Content-type'] = 'text/plain; charset='.$wgOutputEncoding;
- $headers['Content-transfer-encoding'] = '8bit';
- $headers['Message-ID'] = "<{$timestamp}" . $wgUser->getName() . '@' . $wgSMTP['IDHost'] . '>';
- $headers['X-Mailer'] = 'MediaWiki mailer';
-
- // Create the mail object using the Mail::factory method
- $mail_object =& Mail::factory('smtp', $wgSMTP);
-
- $mailResult =& $mail_object->send($to, $headers, $body);
-
- # Based on the result return an error string,
- if ($mailResult === true)
- return '';
- else if (is_object($mailResult))
- return $mailResult->getMessage();
- else
- return 'Mail object return unknown error.';
- } else {
- # In the following $headers = expression we removed "Reply-To: {$from}\r\n" , because it is treated differently
- # (fifth parameter of the PHP mail function, see some lines below)
- $headers =
- "MIME-Version: 1.0\n" .
- "Content-type: text/plain; charset={$wgOutputEncoding}\n" .
- "Content-Transfer-Encoding: 8bit\n" .
- "X-Mailer: MediaWiki mailer\n".
- 'From:' . wfQuotedPrintable_name_and_emailaddr($from) . "\n";
- if ($replyto) {
- $headers .= 'Reply-To: '.wfQuotedPrintable_name_and_emailaddr($replyto)."\n";
+class UserMailer {
+ static $mErrorString;
+
+ /**
+ * Send mail using a PEAR mailer
+ */
+ protected static function sendWithPear( $mailer, $dest, $headers, $body ) {
+ $mailResult = $mailer->send( $dest, $headers, $body );
+
+ # Based on the result return an error string,
+ if ( PEAR::isError( $mailResult ) ) {
+ wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
+ return Status::newFatal( 'pear-mail-error', $mailResult->getMessage() );
+ } else {
+ return Status::newGood();
+ }
+ }
+
+ /**
+ * This function will perform a direct (authenticated) login to
+ * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
+ * array of parameters. It requires PEAR:Mail to do that.
+ * Otherwise it just uses the standard PHP 'mail' function.
+ *
+ * @param $to MailAddress: recipient's email (or an array of them)
+ * @param $from MailAddress: sender's email
+ * @param $subject String: email's subject.
+ * @param $body String: email's text.
+ * @param $replyto MailAddress: optional reply-to email (default: null).
+ * @param $contentType String: optional custom Content-Type
+ * @return Status object
+ */
+ public static function send( $to, $from, $subject, $body, $replyto = null, $contentType = null ) {
+ global $wgSMTP, $wgOutputEncoding, $wgEnotifImpersonal;
+ global $wgEnotifMaxRecips, $wgAdditionalMailParams;
+
+ if ( is_array( $to ) ) {
+ // This wouldn't be necessary if implode() worked on arrays of
+ // objects using __toString(). http://bugs.php.net/bug.php?id=36612
+ foreach ( $to as $t ) {
+ $emails .= $t->toString() . ",";
+ }
+ $emails = rtrim( $emails, ',' );
+ wfDebug( __METHOD__ . ': sending mail to ' . $emails . "\n" );
+ } else {
+ wfDebug( __METHOD__ . ': sending mail to ' . implode( ',', array( $to->toString() ) ) . "\n" );
+ }
+
+ if ( is_array( $wgSMTP ) ) {
+ $found = false;
+ $pathArray = explode( PATH_SEPARATOR, get_include_path() );
+ foreach ( $pathArray as $path ) {
+ if ( file_exists( $path . DIRECTORY_SEPARATOR . 'Mail.php' ) ) {
+ $found = true;
+ break;
+ }
+ }
+ if ( !$found ) {
+ throw new MWException( 'PEAR mail package is not installed' );
+ }
+ require_once( 'Mail.php' );
+
+ $msgid = str_replace( " ", "_", microtime() );
+ if ( function_exists( 'posix_getpid' ) )
+ $msgid .= '.' . posix_getpid();
+
+ if ( is_array( $to ) ) {
+ $dest = array();
+ foreach ( $to as $u )
+ $dest[] = $u->address;
+ } else
+ $dest = $to->address;
+
+ $headers['From'] = $from->toString();
+
+ if ( $wgEnotifImpersonal ) {
+ $headers['To'] = 'undisclosed-recipients:;';
+ }
+ else {
+ $headers['To'] = implode( ", ", (array )$dest );
+ }
+
+ if ( $replyto ) {
+ $headers['Reply-To'] = $replyto->toString();
+ }
+ $headers['Subject'] = self::quotedPrintable( $subject );
+ $headers['Date'] = date( 'r' );
+ $headers['MIME-Version'] = '1.0';
+ $headers['Content-type'] = ( is_null( $contentType ) ?
+ 'text/plain; charset=' . $wgOutputEncoding : $contentType );
+ $headers['Content-transfer-encoding'] = '8bit';
+ $headers['Message-ID'] = "<$msgid@" . $wgSMTP['IDHost'] . '>'; // FIXME
+ $headers['X-Mailer'] = 'MediaWiki mailer';
+
+ wfSuppressWarnings();
+
+ // Create the mail object using the Mail::factory method
+ $mail_object =& Mail::factory( 'smtp', $wgSMTP );
+ if ( PEAR::isError( $mail_object ) ) {
+ wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
+ wfRestoreWarnings();
+ return Status::newFatal( 'pear-mail-error', $mail_object->getMessage() );
+ }
+
+ wfDebug( "Sending mail via PEAR::Mail to $dest\n" );
+ $chunks = array_chunk( (array)$dest, $wgEnotifMaxRecips );
+ foreach ( $chunks as $chunk ) {
+ $status = self::sendWithPear( $mail_object, $chunk, $headers, $body );
+ if ( !$status->isOK() ) {
+ wfRestoreWarnings();
+ return $status;
+ }
+ }
+ wfRestoreWarnings();
+ return Status::newGood();
+ } else {
+ # In the following $headers = expression we removed "Reply-To: {$from}\r\n" , because it is treated differently
+ # (fifth parameter of the PHP mail function, see some lines below)
+
+ # Line endings need to be different on Unix and Windows due to
+ # the bug described at http://trac.wordpress.org/ticket/2603
+ if ( wfIsWindows() ) {
+ $body = str_replace( "\n", "\r\n", $body );
+ $endl = "\r\n";
+ } else {
+ $endl = "\n";
+ }
+ $ctype = ( is_null( $contentType ) ?
+ 'text/plain; charset=' . $wgOutputEncoding : $contentType );
+ $headers =
+ "MIME-Version: 1.0$endl" .
+ "Content-type: $ctype$endl" .
+ "Content-Transfer-Encoding: 8bit$endl" .
+ "X-Mailer: MediaWiki mailer$endl" .
+ 'From: ' . $from->toString();
+ if ( $replyto ) {
+ $headers .= "{$endl}Reply-To: " . $replyto->toString();
+ }
+
+ wfDebug( "Sending mail via internal mail() function\n" );
+
+ self::$mErrorString = '';
+ $html_errors = ini_get( 'html_errors' );
+ ini_set( 'html_errors', '0' );
+ set_error_handler( array( 'UserMailer', 'errorHandler' ) );
+
+ // We need to check for safe_mode, because mail() throws an E_NOTICE
+ // on the 5th parameter when it's turned on
+ $sm = wfIniGetBool( 'safe_mode' );
+
+ if ( !is_array( $to ) ) {
+ $to = array( $to );
+ }
+ foreach ( $to as $recip ) {
+ if( $sm ) {
+ $sent = mail( $recip->toString(), self::quotedPrintable( $subject ), $body, $headers );
+ } else {
+ $sent = mail( $recip->toString(), self::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
+ }
+ }
+
+ restore_error_handler();
+ ini_set( 'html_errors', $html_errors );
+
+ if ( self::$mErrorString ) {
+ wfDebug( "Error sending mail: " . self::$mErrorString . "\n" );
+ return Status::newFatal( 'php-mail-error', self::$mErrorString );
+ } elseif ( ! $sent ) {
+ // mail function only tells if there's an error
+ wfDebug( "Error sending mail\n" );
+ return Status::newFatal( 'php-mail-error-unknown' );
+ } else {
+ return Status::newGood();
+ }
}
+ }
- $wgErrorString = '';
- set_error_handler( 'mailErrorHandler' );
- # added -f parameter, see PHP manual for the fifth parameter when using the mail function
- mail( wfQuotedPrintable_name_and_emailaddr($to), $subject, $body, $headers, "-f{$wgEmergencyContact}\n");
- restore_error_handler();
+ /**
+ * Set the mail error message in self::$mErrorString
+ *
+ * @param $code Integer: error number
+ * @param $string String: error message
+ */
+ static function errorHandler( $code, $string ) {
+ self::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
+ }
- return $wgErrorString;
+ /**
+ * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
+ */
+ public static function rfc822Phrase( $phrase ) {
+ $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
+ return '"' . $phrase . '"';
+ }
+
+ /**
+ * Converts a string into quoted-printable format
+ * @since 1.17
+ */
+ public static function quotedPrintable( $string, $charset = '' ) {
+ # Probably incomplete; see RFC 2045
+ if( empty( $charset ) ) {
+ global $wgInputEncoding;
+ $charset = $wgInputEncoding;
+ }
+ $charset = strtoupper( $charset );
+ $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
+
+ $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
+ $replace = $illegal . '\t ?_';
+ if( !preg_match( "/[$illegal]/", $string ) ) {
+ return $string;
+ }
+ $out = "=?$charset?Q?";
+ $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
+ $out .= '?=';
+ return $out;
}
}
/**
+ * This 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 mailErrorHandler( $code, $string ) {
- global $wgErrorString;
- $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',
+ protected $to, $subject, $body, $replyto, $from;
+ protected $user, $title, $timestamp, $summary, $minorEdit, $oldid, $composed_common, $editor;
+ protected $mailTargets = array();
+
+ /**
+ * Send emails corresponding to the user $editor editing the page $title.
+ * Also updates wl_notificationtimestamp.
+ *
+ * May be deferred via the job queue.
+ *
+ * @param $editor User object
+ * @param $title Title object
+ * @param $timestamp
+ * @param $summary
+ * @param $minorEdit
+ * @param $oldid (default: false)
+ */
+ public function notifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid = false ) {
+ global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker;
+
+ if ( $title->getNamespace() < 0 )
+ return;
+
+ // Build a list of users to notfiy
+ $watchers = array();
+ if ( $wgEnotifWatchlist || $wgShowUpdatedMarker ) {
+ $dbw = wfGetDB( DB_MASTER );
+ $res = $dbw->select( array( 'watchlist' ),
+ array( 'wl_user' ),
+ array(
+ 'wl_title' => $title->getDBkey(),
+ 'wl_namespace' => $title->getNamespace(),
+ 'wl_user != ' . intval( $editor->getID() ),
+ 'wl_notificationtimestamp IS NULL',
+ ), __METHOD__
+ );
+ foreach ( $res as $row ) {
+ $watchers[] = intval( $row->wl_user );
+ }
+ if ( $watchers ) {
+ // Update wl_notificationtimestamp for all watching users except
+ // the editor
+ $dbw->begin();
+ $dbw->update( 'watchlist',
array( /* SET */
- 'wl_notificationtimestamp' => $article->mTimestamp
+ 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
), array( /* WHERE */
- 'wl_title' => $currentPage,
- 'wl_namespace' => $currentNs,
- 'wl_user' => $wuser->wl_user
- ), 'UserMailer::NotifyOnChange'
+ 'wl_title' => $title->getDBkey(),
+ 'wl_namespace' => $title->getNamespace(),
+ 'wl_user' => $watchers
+ ), __METHOD__
);
- } # 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
- }
+ $dbw->commit();
+ }
+ }
- $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().'>';
+ if ( $wgEnotifUseJobQ ) {
+ $params = array(
+ "editor" => $editor->getName(),
+ "editorID" => $editor->getID(),
+ "timestamp" => $timestamp,
+ "summary" => $summary,
+ "minorEdit" => $minorEdit,
+ "oldid" => $oldid,
+ "watchers" => $watchers );
+ $job = new EnotifNotifyJob( $title, $params );
+ $job->insert();
} else {
- $from = 'WikiAdmin <'.$wgEmergencyContact.'>';
- if ($wgEmailNotificationRevealPageEditorAddress) {
- $replyto = $pageeditorUser->getName().' <'.$pageeditorUser->getEmail().'>';
- }
+ $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
}
- $body = str_replace('$PAGEEDITORNAMEANDEMAILADDR', $pageeditorUser->getName().' <'.$pageeditorUser->getEmail().'>', $body);
- } else {
- $from = 'WikiAdmin <'.$wgEmergencyContact.'>';
- $replyto = $wgNoReplyAddress;
- $body = str_replace('$PAGEEDITORNAMEANDEMAILADDR', $replyto, $body);
+
}
- 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);
+ /*
+ * Immediate version of notifyOnPageChange().
+ *
+ * Send emails corresponding to the user $editor editing the page $title.
+ * Also updates wl_notificationtimestamp.
+ *
+ * @param $editor User object
+ * @param $title Title object
+ * @param $timestamp string Edit timestamp
+ * @param $summary string Edit summary
+ * @param $minorEdit bool
+ * @param $oldid int Revision ID
+ * @param $watchers array of user IDs
+ */
+ public function actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers ) {
+ # we use $wgPasswordSender as sender's address
+ global $wgEnotifWatchlist;
+ global $wgEnotifMinorEdits, $wgEnotifUserTalk;
+
+ wfProfileIn( __METHOD__ );
+
+ # 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 = ( $title->getNamespace() == NS_USER_TALK );
+
+ $this->title = $title;
+ $this->timestamp = $timestamp;
+ $this->summary = $summary;
+ $this->minorEdit = $minorEdit;
+ $this->oldid = $oldid;
+ $this->editor = $editor;
+ $this->composed_common = false;
+
+ $userTalkId = false;
+
+ if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
+ if ( $wgEnotifUserTalk && $isUserTalkPage ) {
+ $targetUser = User::newFromName( $title->getText() );
+ if ( !$targetUser || $targetUser->isAnon() ) {
+ wfDebug( __METHOD__ . ": user talk page edited, but user does not exist\n" );
+ } elseif ( $targetUser->getId() == $editor->getId() ) {
+ wfDebug( __METHOD__ . ": user edited their own talk page, no notification sent\n" );
+ } elseif ( $targetUser->getOption( 'enotifusertalkpages' ) ) {
+ if ( $targetUser->isEmailConfirmed() ) {
+ wfDebug( __METHOD__ . ": sending talk page update notification\n" );
+ $this->compose( $targetUser );
+ $userTalkId = $targetUser->getId();
+ } else {
+ wfDebug( __METHOD__ . ": talk page owner doesn't have validated email\n" );
+ }
+ } else {
+ wfDebug( __METHOD__ . ": talk page owner doesn't want notifications\n" );
+ }
+ }
+
+ if ( $wgEnotifWatchlist ) {
+ // Send updates to watchers other than the current editor
+ $userArray = UserArray::newFromIDs( $watchers );
+ foreach ( $userArray as $watchingUser ) {
+ if ( $watchingUser->getOption( 'enotifwatchlistpages' ) &&
+ ( !$minorEdit || $watchingUser->getOption( 'enotifminoredits' ) ) &&
+ $watchingUser->isEmailConfirmed() &&
+ $watchingUser->getID() != $userTalkId )
+ {
+ $this->compose( $watchingUser );
+ }
+ }
+ }
+ }
+
+ global $wgUsersNotifiedOnAllChanges;
+ foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
+ $user = User::newFromName( $name );
+ $this->compose( $user );
+ }
+
+ $this->sendMails();
+ wfProfileOut( __METHOD__ );
}
- # 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;
-}
+ /**
+ * Generate the generic "this page has been changed" e-mail text.
+ */
+ private function composeCommonMailtext() {
+ global $wgPasswordSender, $wgPasswordSenderName, $wgNoReplyAddress;
+ global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
+ global $wgEnotifImpersonal, $wgEnotifUseRealName;
+
+ $this->composed_common = true;
+
+ $summary = ( $this->summary == '' ) ? ' - ' : $this->summary;
+ $medit = ( $this->minorEdit ) ? wfMsgForContent( '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
+
+ $subject = wfMsgForContent( 'enotif_subject' );
+ $body = wfMsgForContent( 'enotif_body' );
+ $from = ''; /* fail safe */
+ $replyto = ''; /* fail safe */
+ $keys = array();
+
+ if ( $this->oldid ) {
+ $difflink = $this->title->getFullUrl( 'diff=0&oldid=' . $this->oldid );
+ $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited', $difflink );
+ $keys['$OLDID'] = $this->oldid;
+ $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
+ } else {
+ $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
+ # clear $OLDID placeholder in the message template
+ $keys['$OLDID'] = '';
+ $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
+ }
+ if ( $wgEnotifImpersonal && $this->oldid ) {
+ /*
+ * For impersonal mail, show a diff link to the last
+ * revision.
+ */
+ $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastdiff',
+ $this->title->getFullURL( "oldid={$this->oldid}&diff=next" ) );
+ }
+
+ $body = strtr( $body, $keys );
+ $pagetitle = $this->title->getPrefixedText();
+ $keys['$PAGETITLE'] = $pagetitle;
+ $keys['$PAGETITLE_URL'] = $this->title->getFullUrl();
+
+ $keys['$PAGEMINOREDIT'] = $medit;
+ $keys['$PAGESUMMARY'] = $summary;
+ $keys['$UNWATCHURL'] = $this->title->getFullUrl( 'action=unwatch' );
+
+ $subject = strtr( $subject, $keys );
+
+ # 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.
+ $editor = $this->editor;
+ $name = $wgEnotifUseRealName ? $editor->getRealName() : $editor->getName();
+ $adminAddress = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
+ $editorAddress = new MailAddress( $editor );
+ if ( $wgEnotifRevealEditorAddress
+ && ( $editor->getEmail() != '' )
+ && $editor->getOption( 'enotifrevealaddr' ) ) {
+ if ( $wgEnotifFromEditor ) {
+ $from = $editorAddress;
+ } else {
+ $from = $adminAddress;
+ $replyto = $editorAddress;
+ }
+ } else {
+ $from = $adminAddress;
+ $replyto = new MailAddress( $wgNoReplyAddress );
+ }
-function ComposeAndSendPersonalisedMail( $watchingUser, $mail, $article) {
+ if ( $editor->isIP( $name ) ) {
+ # real anon (user:xxx.xxx.xxx.xxx)
+ $utext = wfMsgForContent( 'enotif_anon_editor', $name );
+ $subject = str_replace( '$PAGEEDITOR', $utext, $subject );
+ $keys['$PAGEEDITOR'] = $utext;
+ $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
+ } else {
+ $subject = str_replace( '$PAGEEDITOR', $name, $subject );
+ $keys['$PAGEEDITOR'] = $name;
+ $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $name );
+ $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getFullUrl();
+ }
+ $userPage = $editor->getUserPage();
+ $keys['$PAGEEDITOR_WIKI'] = $userPage->getFullUrl();
+ $body = strtr( $body, $keys );
+ $body = wordwrap( $body, 72 );
+
+ # now save this as the constant user-independent part of the message
+ $this->from = $from;
+ $this->replyto = $replyto;
+ $this->subject = $subject;
+ $this->body = $body;
+ }
- /* returns true if the mail was sent successfully */
- global $wgLang;
+ /**
+ * Compose a mail to a given user and either queue it for sending, or send it now,
+ * depending on settings.
+ *
+ * Call sendMails() to send any mails that were queued.
+ */
+ function compose( $user ) {
+ global $wgEnotifImpersonal;
- $to = $watchingUser->getName().' <'.$watchingUser->getEmail().'>';
- $body = str_replace('$WATCHINGUSERNAME', $watchingUser->getName() , $mail->body);
- $body = str_replace('$WATCHINGUSEREMAILADDR', $watchingUser->getEmail(), $body);
+ if ( !$this->composed_common )
+ $this->composeCommonMailtext();
- $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) == '');
-}
+ if ( $wgEnotifImpersonal ) {
+ $this->mailTargets[] = new MailAddress( $user );
+ } else {
+ $this->sendPersonalised( $user );
+ }
+ }
-function Clear($currentUser, $currentPage, $currentNs) {
- $dbw =& wfGetDB( DB_MASTER );
- $success = $dbw->update( 'watchlist',
- array( /* SET */
- 'wl_notificationtimestamp' => 0
- ), array( /* WHERE */
- 'wl_title' => $currentPage,
- 'wl_namespace' => $currentNs,
- 'wl_user' => $currentUser
- ), 'UserMailer::Clear'
- );
-}
+ /**
+ * Send any queued mails
+ */
+ function sendMails() {
+ global $wgEnotifImpersonal;
+ if ( $wgEnotifImpersonal ) {
+ $this->sendImpersonal( $this->mailTargets );
+ }
+ }
-function ClearAll($currentUser) {
- global $_REQUEST;
+ /**
+ * 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 $watchingUser User object
+ * @return Boolean
+ * @private
+ */
+ function sendPersonalised( $watchingUser ) {
+ global $wgContLang, $wgEnotifUseRealName;
+ // From the PHP manual:
+ // Note: The to parameter cannot be an address in the form of "Something <someone@example.com>".
+ // The mail command will not parse this properly while talking with the MTA.
+ $to = new MailAddress( $watchingUser );
+ $name = $wgEnotifUseRealName ? $watchingUser->getRealName() : $watchingUser->getName();
+ $body = str_replace( '$WATCHINGUSERNAME', $name, $this->body );
+
+ $timecorrection = $watchingUser->getOption( 'timecorrection' );
+
+ # $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(
+ array( '$PAGEEDITDATEANDTIME',
+ '$PAGEEDITDATE',
+ '$PAGEEDITTIME' ),
+ array( $wgContLang->timeanddate( $this->timestamp, true, false, $timecorrection ),
+ $wgContLang->date( $this->timestamp, true, false, $timecorrection ),
+ $wgContLang->time( $this->timestamp, true, false, $timecorrection ) ),
+ $body );
+
+ return UserMailer::send( $to, $this->from, $this->subject, $body, $this->replyto );
+ }
- if ($currentUser != 0) {
+ /**
+ * Same as sendPersonalised but does impersonal mail suitable for bulk
+ * mailing. Takes an array of MailAddress objects.
+ */
+ function sendImpersonal( $addresses ) {
+ global $wgContLang;
- if( $_REQUEST['reset'] == 'all') {
+ if ( empty( $addresses ) )
+ return;
- $dbw =& wfGetDB( DB_MASTER );
- $success = $dbw->update( 'watchlist',
- array( /* SET */
- 'wl_notificationtimestamp' => 0
- ), array( /* WHERE */
- 'wl_user' => $currentUser
- ), 'UserMailer::ClearAll'
- );
+ $body = str_replace(
+ array( '$WATCHINGUSERNAME',
+ '$PAGEEDITDATE' ),
+ array( wfMsgForContent( 'enotif_impersonal_salutation' ),
+ $wgContLang->timeanddate( $this->timestamp, true, false, false ) ),
+ $this->body );
- # we also need to clear here the "you have new message" notification for the own user_talk page
- # This is cleared one page view later in Article::viewUpdates();
- }
+ return UserMailer::send( $addresses, $this->from, $this->subject, $body, $this->replyto );
}
-}
} # end of class EmailNotification
-?>
+
+/**@{
+ * Backwards compatibility functions
+ *
+ * @deprecated Use UserMailer method deprecated in 1.18, remove in 1.19.
+ */
+function wfRFC822Phrase( $s ) {
+ wfDeprecated( __FUNCTION__ );
+ return UserMailer::rfc822Phrase( $s );
+}
+
+/**
+ * @deprecated Use UserMailer method deprecated in 1.18, remove in 1.19.
+ */
+function userMailer( $to, $from, $subject, $body, $replyto = null ) {
+ wfDeprecated( __FUNCTION__ );
+ return UserMailer::send( $to, $from, $subject, $body, $replyto );
+}
+
+/**@}*/
dépôts / lhc / web / wiklou.git / blobdiff