<?php
/**
- * UserMailer.php
- * Copyright (C) 2004 Thomas Gries <mail@tgries.de>
- * http://www.mediawiki.org/
+ * 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
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
+ * @file
* @author <brion@pobox.com>
* @author <mail@tgries.de>
- *
+ * @author Tim Starling
*/
-/**
- * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
- */
-function wfRFC822Phrase( $phrase ) {
- $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
- return '"' . $phrase . '"';
-}
/**
* Stores a single person's name and email address.
*/
class MailAddress {
/**
- * @param mixed $address String with an email address, or a User object
- * @param string $name Human-readable name if a string address is given
+ * @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 ) {
- if( is_object( $address ) && $address instanceof User ) {
+ 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 );
}
}
# 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() ) {
- $quoted = wfQuotedPrintable( $this->name );
- if( strpos( $quoted, '.' ) !== false ) {
+ 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}>";
return $this->address;
}
}
-}
-function send_mail($mailer, $dest, $headers, $body)
-{
- $mailResult =& $mailer->send($dest, $headers, $body);
-
- # Based on the result return an error string,
- if ($mailResult === true) {
- return '';
- } elseif (is_object($mailResult)) {
- wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
- return $mailResult->getMessage();
- } else {
- wfDebug( "PEAR::Mail failed, unknown error result\n" );
- return 'Mail object return unknown error.';
+ 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 $to MailAddress: recipient's email
- * @param $from MailAddress: sender's email
- * @param $subject String: email's subject.
- * @param $body String: email's text.
- * @param $replyto String: optional reply-to email (default: null).
+ * Collection of static functions for sending mail
*/
-function userMailer( $to, $from, $subject, $body, $replyto=null ) {
- global $wgUser, $wgSMTP, $wgOutputEncoding, $wgErrorString, $wgEnotifImpersonal;
- global $wgEnotifMaxRecips;
+class UserMailer {
+ static $mErrorString;
- if (is_array( $wgSMTP )) {
- require_once( 'Mail.php' );
+ /**
+ * Send mail using a PEAR mailer
+ */
+ protected static function sendWithPear( $mailer, $dest, $headers, $body ) {
+ $mailResult = $mailer->send( $dest, $headers, $body );
- $timestamp = time();
+ # 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();
+ }
+ }
- if (is_array($to)) {
- $dest = array();
- foreach ($to as $u)
- $dest[] = $u->address;
- } else
- $dest = $to->address;
+ /**
+ * 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 ) ) {
+ $emails = '';
+ // 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" );
+ }
- $headers['From'] = $from->toString();
+ if ( is_array( $wgSMTP ) ) {
+ $found = false;
+ if ( function_exists( 'stream_resolve_include_path' ) ) {
+ $found = stream_resolve_include_path( 'Mail.php' );
+ } else {
+ $found = Fallback::stream_resolve_include_path( 'Mail.php' );
+ }
+ if ( !$found ) {
+ throw new MWException( 'PEAR mail package is not installed' );
+ }
+ require_once( 'Mail.php' );
- if ($wgEnotifImpersonal)
- $headers['To'] = 'undisclosed-recipients:;';
- else
- $headers['To'] = $to->toString();
+ $msgid = str_replace( " ", "_", microtime() );
+ if ( function_exists( 'posix_getpid' ) )
+ $msgid .= '.' . posix_getpid();
- if ( $replyto ) {
- $headers['Reply-To'] = $replyto->toString();
- }
- $headers['Subject'] = wfQuotedPrintable( $subject );
- $headers['Date'] = date( 'r' );
- $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'] . '>'; // FIXME
- $headers['X-Mailer'] = 'MediaWiki mailer';
-
- // 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" );
- return $mail_object->getMessage();
- }
+ if ( is_array( $to ) ) {
+ $dest = array();
+ foreach ( $to as $u )
+ $dest[] = $u->address;
+ } else
+ $dest = $to->address;
+
+ $headers['From'] = $from->toString();
- wfDebug( "Sending mail via PEAR::Mail to $dest\n" );
- if (is_array($dest)) {
- $chunks = array_chunk($dest, $wgEnotifMaxRecips);
- foreach ($chunks as $chunk) {
- $e = send_mail($mail_object, $chunk, $headers, $body);
- if ($e != '')
- return $e;
+ 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();
}
- } else
- return $mail_object->send($dest, $headers, $body);
-
- } 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";
- }
- $headers =
- "MIME-Version: 1.0$endl" .
- "Content-type: text/plain; charset={$wgOutputEncoding}$endl" .
- "Content-Transfer-Encoding: 8bit$endl" .
- "X-Mailer: MediaWiki mailer$endl".
- 'From: ' . $from->toString();
- if ($replyto) {
- $headers .= "{$endl}Reply-To: " . $replyto->toString();
- }
- $wgErrorString = '';
- set_error_handler( 'mailErrorHandler' );
- wfDebug( "Sending mail via internal mail() function\n" );
+ wfDebug( "Sending mail via internal mail() function\n" );
- if (is_array($to))
- foreach ($to as $recip)
- mail( $recip->toString(), wfQuotedPrintable( $subject ), $body, $headers );
- else
- mail( $to->toString(), wfQuotedPrintable( $subject ), $body, $headers );
+ self::$mErrorString = '';
+ $html_errors = ini_get( 'html_errors' );
+ ini_set( 'html_errors', '0' );
+ set_error_handler( array( 'UserMailer', 'errorHandler' ) );
- restore_error_handler();
+ // 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 ( $wgErrorString ) {
- wfDebug( "Error sending mail: $wgErrorString\n" );
+ 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();
+ }
}
- return $wgErrorString;
}
-}
-/**
- * Get the mail error message in global $wgErrorString
- *
- * @param $code Integer: error number
- * @param $string String: error message
- */
-function mailErrorHandler( $code, $string ) {
- global $wgErrorString;
- $wgErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
-}
+ /**
+ * 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 );
+ }
+
+ /**
+ * 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
*
*/
class EmailNotification {
- /**@{{
- * @private
- */
- var $to, $subject, $body, $replyto, $from;
- var $user, $title, $timestamp, $summary, $minorEdit, $oldid;
-
- /**@}}*/
+ protected $to, $subject, $body, $replyto, $from;
+ protected $user, $title, $timestamp, $summary, $minorEdit, $oldid, $composed_common, $editor;
+ protected $mailTargets = array();
/**
- * @todo document
+ * 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)
*/
- function notifyOnPageChange(&$title, $timestamp, $summary, $minorEdit, $oldid=false) {
+ public function notifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid = false ) {
+ global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker;
- # we use $wgEmergencyContact as sender's address
- global $wgUser, $wgEnotifWatchlist;
- global $wgEnotifMinorEdits, $wgEnotifUserTalk, $wgShowUpdatedMarker;
- global $wgEnotifImpersonal;
+ 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' => $dbw->timestamp( $timestamp )
+ ), array( /* WHERE */
+ 'wl_title' => $title->getDBkey(),
+ 'wl_namespace' => $title->getNamespace(),
+ 'wl_user' => $watchers
+ ), __METHOD__
+ );
+ $dbw->commit();
+ }
+ }
- $fname = 'UserMailer::notifyOnPageChange';
- wfProfileIn( $fname );
+ 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 {
+ $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
+ }
+
+ }
+
+ /*
+ * 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);
- $enotifusertalkpage = ($isUserTalkPage && $wgEnotifUserTalk);
- $enotifwatchlistpage = $wgEnotifWatchlist;
+ $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );
- $this->title =& $title;
+ $this->title = $title;
$this->timestamp = $timestamp;
$this->summary = $summary;
$this->minorEdit = $minorEdit;
$this->oldid = $oldid;
- $this->composeCommonMailtext();
+ $this->editor = $editor;
+ $this->composed_common = false;
- $impersonals = array();
+ $userTalkId = false;
- if ( (!$minorEdit || $wgEnotifMinorEdits) ) {
- if( $wgEnotifWatchlist ) {
- // Send updates to watchers other than the current editor
- $userCondition = 'wl_user <> ' . intval( $wgUser->getId() );
- } elseif( $wgEnotifUserTalk && $title->getNamespace() == NS_USER_TALK ) {
+ if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
+ if ( $wgEnotifUserTalk && $isUserTalkPage ) {
$targetUser = User::newFromName( $title->getText() );
- if( is_null( $targetUser ) ) {
- wfDebug( "$fname: user-talk-only mode; no such user\n" );
- $userCondition = false;
- } elseif( $targetUser->getId() == $wgUser->getId() ) {
- wfDebug( "$fname: user-talk-only mode; editor is target user\n" );
- $userCondition = false;
+ 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 {
- // Don't notify anyone other than the owner of the talk page
- $userCondition = 'wl_user = ' . intval( $targetUser->getId() );
+ wfDebug( __METHOD__ . ": talk page owner doesn't want notifications\n" );
}
- } else {
- // Notifications disabled
- $userCondition = false;
}
- if( $userCondition ) {
- $dbr = wfGetDB( DB_MASTER );
- $res = $dbr->select( 'watchlist', array( 'wl_user' ),
- array(
- 'wl_title' => $title->getDBkey(),
- 'wl_namespace' => $title->getNamespace(),
- $userCondition,
- 'wl_notificationtimestamp IS NULL',
- ), $fname );
-
- # if anyone is watching ... set up the email message text which is
- # common for all receipients ...
- if ( $dbr->numRows( $res ) > 0 ) {
-
- $watchingUser = new User();
-
- # ... now do for all watching users ... if the options fit
- for ($i = 1; $i <= $dbr->numRows( $res ); $i++) {
-
- $wuser = $dbr->fetchObject( $res );
- $watchingUser->setID($wuser->wl_user);
-
- if ( ( $enotifwatchlistpage && $watchingUser->getOption('enotifwatchlistpages') ) ||
- ( $enotifusertalkpage
- && $watchingUser->getOption('enotifusertalkpages')
- && $title->equals( $watchingUser->getTalkPage() ) )
- && (!$minorEdit || ($wgEnotifMinorEdits && $watchingUser->getOption('enotifminoredits') ) )
- && ($watchingUser->isEmailConfirmed() ) ) {
- # ... adjust remaining text and page edit time placeholders
- # which needs to be personalized for each user
- if ($wgEnotifImpersonal)
- $impersonals[] = $watchingUser;
- else
- $this->composeAndSendPersonalisedMail( $watchingUser );
-
- } # if the watching user has an email address in the preferences
+ 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 );
}
}
- } # if anyone is watching
- } # if $wgEnotifWatchlist = true
+ }
+ }
- global $wgUsersNotifedOnAllChanges;
- foreach ( $wgUsersNotifedOnAllChanges as $name ) {
+ global $wgUsersNotifiedOnAllChanges;
+ foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
$user = User::newFromName( $name );
- if ($wgEnotifImpersonal)
- $impersonals[] = $user;
- else
- $this->composeAndSendPersonalisedMail( $user );
+ $this->compose( $user );
}
- $this->composeAndSendImpersonalMail($impersonals);
-
- if ( $wgShowUpdatedMarker || $wgEnotifWatchlist ) {
- # 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, ...
- $dbw = wfGetDB( DB_MASTER );
- $success = $dbw->update( 'watchlist',
- array( /* SET */
- 'wl_notificationtimestamp' => $dbw->timestamp($timestamp)
- ), array( /* WHERE */
- 'wl_title' => $title->getDBkey(),
- 'wl_namespace' => $title->getNamespace(),
- ), 'UserMailer::NotifyOnChange'
- );
- # FIXME what do we do on failure ?
- }
- wfProfileOut( $fname );
- } # function NotifyOnChange
+ $this->sendMails();
+ wfProfileOut( __METHOD__ );
+ }
/**
- * @private
+ * Generate the generic "this page has been changed" e-mail text.
*/
- function composeCommonMailtext() {
- global $wgUser, $wgEmergencyContact, $wgNoReplyAddress;
+ private function composeCommonMailtext() {
+ global $wgPasswordSender, $wgPasswordSenderName, $wgNoReplyAddress;
global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
- global $wgEnotifImpersonal;
+ global $wgEnotifImpersonal, $wgEnotifUseRealName;
- $summary = ($this->summary == '') ? ' - ' : $this->summary;
- $medit = ($this->minorEdit) ? wfMsg( 'minoredit' ) : '';
+ $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
$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( $this->oldid ) {
+ 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( 'created' );
}
- if ($wgEnotifImpersonal && $this->oldid)
+ if ( $wgEnotifImpersonal && $this->oldid ) {
/*
- * For impersonal mail, show a diff link to the last
+ * For impersonal mail, show a diff link to the last
* revision.
*/
- $keys['$NEWPAGE'] = wfMsgForContent('enotif_lastdiff',
- $this->title->getFullURL("oldid={$this->oldid}&diff=prev"));
+ $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastdiff',
+ $this->title->getFullURL( "oldid={$this->oldid}&diff=next" ) );
+ }
$body = strtr( $body, $keys );
$pagetitle = $this->title->getPrefixedText();
$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.
- $name = $wgUser->getName();
- $adminAddress = new MailAddress( $wgEmergencyContact, 'WikiAdmin' );
- $editorAddress = new MailAddress( $wgUser );
- if( $wgEnotifRevealEditorAddress
- && ( $wgUser->getEmail() != '' )
- && $wgUser->getOption( 'enotifrevealaddr' ) ) {
- if( $wgEnotifFromEditor ) {
+ $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 = new MailAddress( $wgNoReplyAddress );
}
- if( $wgUser->isIP( $name ) ) {
- #real anon (user:xxx.xxx.xxx.xxx)
- $subject = str_replace('$PAGEEDITOR', 'anonymous user '. $name, $subject);
- $keys['$PAGEEDITOR'] = 'anonymous user ' . $name;
+ 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);
+ $subject = str_replace( '$PAGEEDITOR', $name, $subject );
$keys['$PAGEEDITOR'] = $name;
$emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $name );
$keys['$PAGEEDITOR_EMAIL'] = $emailPage->getFullUrl();
}
- $userPage = $wgUser->getUserPage();
+ $userPage = $editor->getUserPage();
$keys['$PAGEEDITOR_WIKI'] = $userPage->getFullUrl();
$body = strtr( $body, $keys );
$body = wordwrap( $body, 72 );
$this->body = $body;
}
+ /**
+ * 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;
+
+ if ( !$this->composed_common )
+ $this->composeCommonMailtext();
+
+ if ( $wgEnotifImpersonal ) {
+ $this->mailTargets[] = new MailAddress( $user );
+ } else {
+ $this->sendPersonalised( $user );
+ }
+ }
+
+ /**
+ * Send any queued mails
+ */
+ function sendMails() {
+ global $wgEnotifImpersonal;
+ if ( $wgEnotifImpersonal ) {
+ $this->sendImpersonal( $this->mailTargets );
+ }
+ }
+
/**
* 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
- * @return bool
+ * @param $watchingUser User object
+ * @return Boolean
* @private
*/
- function composeAndSendPersonalisedMail( $watchingUser ) {
- global $wgLang;
+ 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 );
- $body = str_replace( '$WATCHINGUSERNAME', $watchingUser->getName() , $this->body );
+ $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('$PAGEEDITDATE',
- $wgLang->timeanddate( $this->timestamp, true, false, $timecorrection ),
- $body);
-
- return $this->send_or_queue_mail($to, $this->from, $this->subject, $body, $this->replyto);
+ $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 );
}
/**
- * Same as composeAndSendPersonalisedMail but does impersonal mail
- * suitable for bulk mailing. Takes an array of users.
+ * Same as sendPersonalised but does impersonal mail suitable for bulk
+ * mailing. Takes an array of MailAddress objects.
*/
- function composeAndSendImpersonalMail($users) {
- global $wgLang;
+ function sendImpersonal( $addresses ) {
+ global $wgContLang;
- if (empty($users))
+ if ( empty( $addresses ) )
return;
- $to = array();
- foreach ($users as $user)
- $to[] = new MailAddress($user);
-
$body = str_replace(
- array( '$WATCHINGUSERNAME',
- '$PAGEEDITDATE'),
- array( wfMsgForContent('enotif_impersonal_salutation'),
- $wgLang->timeanddate($this->timestamp, true, false, false)),
- $this->body);
-
- return $this->send_or_queue_mail($to, $this->from, $this->subject, $body, $this->replyto);
- }
+ array( '$WATCHINGUSERNAME',
+ '$PAGEEDITDATE' ),
+ array( wfMsgForContent( 'enotif_impersonal_salutation' ),
+ $wgContLang->timeanddate( $this->timestamp, true, false, false ) ),
+ $this->body );
- /**
- * Either send an email or add it to the job queue to be sent later.
- */
- function send_or_queue_mail($to, $from, $subj, $body, $replyto) {
- global $wgEnotifUseJobQ, $wgEnotifMaxRecips;
-
- if (!$wgEnotifUseJobQ)
- return '' != userMailer($to, $from, $subj, $body, $replyto);
-
- if (!is_array($to))
- $to = array($to);
-
- $chunks = array_chunk($to, $wgEnotifMaxRecips);
- foreach ($chunks as $chunk) {
- $job = new EmaillingJob(array(
- 'to' => $chunk,
- 'from' => $from,
- 'subj' => $subj,
- 'body' => $body,
- 'replyto' => $replyto));
- $job->insert();
- }
-
- return true;
+ 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 );
+}
+
+/**@}*/