<?php
/**
+ * 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
* 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
- *
*/
/**
* @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 ) {
+ 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->reaName = strval( $realName );
+ $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() ) {
+ if ( $this->name != '' && !wfIsWindows() ) {
global $wgEnotifUseRealName;
$name = ( $wgEnotifUseRealName && $this->realName ) ? $this->realName : $this->name;
- $quoted = wfQuotedPrintable( $name );
- if( strpos( $quoted, '.' ) !== false || strpos( $quoted, ',' ) !== false ) {
+ $quoted = UserMailer::quotedPrintable( $name );
+ if ( strpos( $quoted, '.' ) !== false || strpos( $quoted, ',' ) !== false ) {
$quoted = '"' . $quoted . '"';
}
return "$quoted <{$this->address}>";
* Collection of static functions for sending mail
*/
class UserMailer {
+ static $mErrorString;
+
/**
* Send mail using a PEAR mailer
*/
- protected static function sendWithPear($mailer, $dest, $headers, $body)
- {
- $mailResult = $mailer->send($dest, $headers, $body);
+ 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 ) ) {
+ if ( PEAR::isError( $mailResult ) ) {
wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
- return new WikiError( $mailResult->getMessage() );
+ return Status::newFatal( 'pear-mail-error', $mailResult->getMessage() );
} else {
- return true;
+ return Status::newGood();
}
}
* 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 $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 String: optional reply-to email (default: null).
+ * @param $replyto MailAddress: optional reply-to email (default: null).
* @param $contentType String: optional custom Content-Type
- * @return mixed True on success, a WikiError object on failure.
+ * @return Status object
*/
- static function send( $to, $from, $subject, $body, $replyto=null, $contentType=null ) {
- global $wgSMTP, $wgOutputEncoding, $wgErrorString, $wgEnotifImpersonal;
- global $wgEnotifMaxRecips;
+ public static function send( $to, $from, $subject, $body, $replyto = null, $contentType = null ) {
+ global $wgSMTP, $wgOutputEncoding, $wgEnotifImpersonal;
+ global $wgEnotifMaxRecips, $wgAdditionalMailParams;
if ( is_array( $to ) ) {
- wfDebug( __METHOD__.': sending mail to ' . implode( ',', $to ) . "\n" );
+ // 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" );
+ wfDebug( __METHOD__ . ': sending mail to ' . implode( ',', array( $to->toString() ) ) . "\n" );
}
- if (is_array( $wgSMTP )) {
+ 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 = str_replace( " ", "_", microtime() );
+ if ( function_exists( 'posix_getpid' ) )
$msgid .= '.' . posix_getpid();
- if (is_array($to)) {
+ if ( is_array( $to ) ) {
$dest = array();
- foreach ($to as $u)
+ foreach ( $to as $u )
$dest[] = $u->address;
} else
$dest = $to->address;
$headers['From'] = $from->toString();
- if ($wgEnotifImpersonal) {
+ if ( $wgEnotifImpersonal ) {
$headers['To'] = 'undisclosed-recipients:;';
}
else {
if ( $replyto ) {
$headers['Reply-To'] = $replyto->toString();
}
- $headers['Subject'] = wfQuotedPrintable( $subject );
+ $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-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 ) ) {
+ $mail_object =& Mail::factory( 'smtp', $wgSMTP );
+ if ( PEAR::isError( $mail_object ) ) {
wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
- return new WikiError( $mail_object->getMessage() );
+ 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) {
- $e = self::sendWithPear($mail_object, $chunk, $headers, $body);
- if( WikiError::isError( $e ) )
- return $e;
+ 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)
} else {
$endl = "\n";
}
- $ctype = (is_null($contentType) ?
- 'text/plain; charset='.$wgOutputEncoding : $contentType);
+ $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".
+ "X-Mailer: MediaWiki mailer$endl" .
'From: ' . $from->toString();
- if ($replyto) {
+ if ( $replyto ) {
$headers .= "{$endl}Reply-To: " . $replyto->toString();
}
- $wgErrorString = '';
+ 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' ) );
- wfDebug( "Sending mail via internal mail() function\n" );
- if (function_exists('mail')) {
- if (is_array($to)) {
- foreach ($to as $recip) {
- $sent = mail( $recip->toString(), wfQuotedPrintable( $subject ), $body, $headers );
- }
+ // 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( $to->toString(), wfQuotedPrintable( $subject ), $body, $headers );
+ $sent = mail( $recip->toString(), self::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
}
- } else {
- $wgErrorString = 'PHP is not configured to send mail';
}
restore_error_handler();
ini_set( 'html_errors', $html_errors );
- if ( $wgErrorString ) {
- wfDebug( "Error sending mail: $wgErrorString\n" );
- return new WikiError( $wgErrorString );
- } elseif (! $sent) {
- //mail function only tells if there's an error
+ 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 new WikiError( 'mailer error' );
+ return Status::newFatal( 'php-mail-error-unknown' );
} else {
- return true;
+ return Status::newGood();
}
}
}
/**
- * Get the mail error message in global $wgErrorString
+ * Set the mail error message in self::$mErrorString
*
* @param $code Integer: error number
* @param $string String: error message
*/
static function errorHandler( $code, $string ) {
- global $wgErrorString;
- $wgErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $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
*/
- static function rfc822Phrase( $phrase ) {
+ public static function rfc822Phrase( $phrase ) {
$phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
return '"' . $phrase . '"';
}
-}
-
-class EmailNotification {
-
- /*
- * Send users an email.
- *
- * @param $editor User whose action precipitated the notification.
- * @param $timestamp of the event.
- * @param Callback that returns an an array of Users who will recieve the notification.
- * @param Callback that returns an array($keys, $body, $subject) where
- * * $keys is a dictionary whose keys will be replaced with the corresponding
- * values within the subject and body of the message.
- * * $body is the name of the message that will be used for the email body.
- * * $subject is the name of the message that will be used for the subject.
- * Both messages are resolved using the content language.
- * The messageCompositionFunction is invoked for each recipient user;
- * The keys returned are merged with those given by EmailNotification::commonMessageKeys().
- * The recipient is appended to the arguments given to messageCompositionFunction.
- * Both callbacks are to be given in the same formats accepted by the hook system.
+ /**
+ * Converts a string into quoted-printable format
+ * @since 1.17
*/
- static function notify( $editor, $timestamp, $userListFunction, $messageCompositionFunction ) {
- global $wgEnotifUseRealName, $wgEnotifImpersonal;
- global $wgLang;
-
- $users = wfInvoke( 'userList', $userListFunction );
- if( !count( $users ) )
- return;
-
- $common_keys = self::commonMessageKeys( $editor );
- foreach( $users as $u ) {
- list( $user_keys, $body_msg_name, $subj_msg_name ) =
- wfInvoke( 'message', $messageCompositionFunction, array( $u ) );
- $keys = array_merge( $common_keys, $user_keys );
-
- if( $wgEnotifImpersonal ) {
- $keys['$WATCHINGUSERNAME'] = wfMsgForContent( 'enotif_impersonal_salutation' );
- $keys['$PAGEEDITDATE'] = $wgLang->timeanddate( $timestamp, true, false, false );
- } else {
- $keys['$WATCHINGUSERNAME'] = $wgEnotifUseRealName ? $u->getRealName() : $u->getName();
- $keys['$PAGEEDITDATE'] = $wgLang->timeAndDate( $timestamp, true, false,
- $u->getOption( 'timecorrection' ) );
- }
-
- $subject = strtr( wfMsgForContent( $subj_msg_name ), $keys );
- $body = wordwrap( strtr( wfMsgForContent( $body_msg_name ), $keys ), 72 );
-
- $to = new MailAddress( $u );
- $from = $keys['$FROM_HEADER'];
- $replyto = $keys['$REPLYTO_HEADER'];
- UserMailer::send( $to, $from, $subject, $body, $replyto );
- }
- }
-
-
- static function commonMessageKeys( $editor ) {
- global $wgEnotifUseRealName, $wgEnotifRevealEditorAddress;
- global $wgNoReplyAddress, $wgPasswordSender;
-
- $keys = array();
-
- $name = $wgEnotifUseRealName ? $editor->getRealName() : $editor->getName();
-
- $adminAddress = new MailAddress( $wgPasswordSender, 'WikiAdmin' );
- $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 );
+ public static function quotedPrintable( $string, $charset = '' ) {
+ # Probably incomplete; see RFC 2045
+ if( empty( $charset ) ) {
+ global $wgInputEncoding;
+ $charset = $wgInputEncoding;
}
- $keys['$FROM_HEADER'] = $from;
- $keys['$REPLYTO_HEADER'] = $replyto;
+ $charset = strtoupper( $charset );
+ $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
- if( $editor->isAnon() ) {
- $keys['$PAGEEDITOR'] = wfMsgForContent( 'enotif_anon_editor', $name );
- $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
- } else{
- $keys['$PAGEEDITOR'] = $name;
- $keys['$PAGEEDITOR_EMAIL'] = SpecialPage::getSafeTitleFor( 'Emailuser', $name )->getFullUrl();
+ $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
+ $replace = $illegal . '\t ?_';
+ if( !preg_match( "/[$illegal]/", $string ) ) {
+ return $string;
}
- $keys['$PAGEEDITOR_WIKI'] = $editor->getUserPage()->getFullUrl();
-
- return $keys;
- }
-
-
-
- /*
- * @deprecated
- * Use PageChangeNotification::notifyOnPageChange instead.
- */
- function notifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid = false) {
- PageChangeNotification::notifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid);
+ $out = "=?$charset?Q?";
+ $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string );
+ $out .= '?=';
+ return $out;
}
}
-class PageChangeNotification {
-
+/**
+ * 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
+ *
+ *
+ */
+class EmailNotification {
+ 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.
* @param $minorEdit
* @param $oldid (default: false)
*/
- static function notifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid = false ) {
- global $wgEnotifUseJobQ;
+ 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' => $dbw->timestamp( $timestamp )
+ ), array( /* WHERE */
+ 'wl_title' => $title->getDBkey(),
+ 'wl_namespace' => $title->getNamespace(),
+ 'wl_user' => $watchers
+ ), __METHOD__
+ );
+ $dbw->commit();
+ }
+ }
+
if ( $wgEnotifUseJobQ ) {
$params = array(
"editor" => $editor->getName(),
"timestamp" => $timestamp,
"summary" => $summary,
"minorEdit" => $minorEdit,
- "oldid" => $oldid);
+ "oldid" => $oldid,
+ "watchers" => $watchers );
$job = new EnotifNotifyJob( $title, $params );
$job->insert();
} else {
- self::actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid );
+ $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
}
}
*
* @param $editor User object
* @param $title Title object
- * @param $timestamp
- * @param $summary
- * @param $minorEdit
- * @param $oldid (default: false)
+ * @param $timestamp string Edit timestamp
+ * @param $summary string Edit summary
+ * @param $minorEdit bool
+ * @param $oldid int Revision ID
+ * @param $watchers array of user IDs
*/
- static function actuallyNotifyOnPageChange( $editor, $title, $timestamp,
- $summary, $minorEdit, $oldid = false ) {
- global $wgShowUpdatedMarker, $wgEnotifWatchlist;
-
+ public function actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers ) {
+ # we use $wgPasswordSender as sender's address
+ global $wgEnotifWatchlist;
+ global $wgEnotifMinorEdits, $wgEnotifUserTalk;
+
wfProfileIn( __METHOD__ );
-
- EmailNotification::notify( $editor, $timestamp,
- array( 'PageChangeNotification::usersList', array( $editor, $title, $minorEdit ) ),
- array( 'PageChangeNotification::message', array( $oldid, $minorEdit, $summary, $title, $editor ) ) );
-
- $latestTimestamp = Revision::getTimestampFromId( $title, $title->getLatestRevID() );
- // Do not update watchlists if something else already did.
- if ( $timestamp >= $latestTimestamp && ($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. Do
- # not do this to users for their own edits.
- $dbw = wfGetDB( DB_MASTER );
- $dbw->update( 'watchlist',
- array( /* SET */
- 'wl_notificationtimestamp' => $dbw->timestamp($timestamp)
- ), array( /* WHERE */
- 'wl_title' => $title->getDBkey(),
- 'wl_namespace' => $title->getNamespace(),
- 'wl_notificationtimestamp IS NULL',
- 'wl_user != ' . $editor->getID()
- ), __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__ );
}
-
-
- static function message( $stuff ) {
- global $wgEnotifImpersonal;
- list( $oldid, $medit, $summary, $title, $user ) = $stuff;
- $keys = array();
+ /**
+ * 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
- # 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( $oldid ) {
- $difflink = $title->getFullUrl( 'diff=0&oldid=' . $oldid );
+ $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'] = $oldid;
+ $keys['$OLDID'] = $this->oldid;
$keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
} else {
$keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
$keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
}
- if ($wgEnotifImpersonal && $oldid) {
- # For impersonal mail, show a diff link to the last revision.
+ if ( $wgEnotifImpersonal && $this->oldid ) {
+ /*
+ * For impersonal mail, show a diff link to the last
+ * revision.
+ */
$keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastdiff',
- $title->getFullURL( "oldid={$oldid}&diff=prev" ) );
+ $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 );
}
- $keys['$PAGETITLE'] = $title->getPrefixedText();
- $keys['$PAGETITLE_URL'] = $title->getFullUrl();
- $keys['$PAGEMINOREDIT'] = $medit ? wfMsg( 'minoredit' ) : '';
- $keys['$PAGESUMMARY'] = ( $summary == '' ) ? ' - ' : $summary;
-
- return array( $keys, 'enotif_body', 'enotif_subject' );
+ 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;
}
- static function usersList( $stuff ) {
- global $wgEnotifWatchlist, $wgEnotifMinorEdits, $wgUsersNotifiedOnAllChanges;
-
- list( $editor, $title, $minorEdit ) = $stuff;
- $recipients = array();
-
- # User talk pages:
- $userTalkId = false;
- if( $title->getNamespace() == NS_USER_TALK && ( !$minorEdit || $wgEnotifMinorEdits ) ) {
- $targetUser = User::newFromName( $title->getText() );
-
- if ( !$targetUser || $targetUser->isAnon() )
- $msg = "user talk page edited, but user does not exist";
-
- else if ( $targetUser->getId() == $editor->getId() )
- $msg = "user edited their own talk page, no notification sent";
-
- else if ( !$targetUser->getOption( 'enotifusertalkpages' ) )
- $msg = "talk page owner doesn't want notifications";
+ /**
+ * 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;
- else if ( !$targetUser->isEmailConfirmed() )
- $msg = "talk page owner doesn't have validated email";
+ if ( !$this->composed_common )
+ $this->composeCommonMailtext();
- else {
- $msg = "sending talk page update notification";
- $recipients[] = $targetUser;
- $userTalkId = $targetUser->getId(); # won't be included in watchlist, below.
- }
- wfDebug( __METHOD__ . ': ' . $msg . "\n" );
+ if ( $wgEnotifImpersonal ) {
+ $this->mailTargets[] = new MailAddress( $user );
+ } else {
+ $this->sendPersonalised( $user );
}
- wfDebug( "Did not send a user-talk notification.\n" );
+ }
- if( $wgEnotifWatchlist && ( !$minorEdit || $wgEnotifMinorEdits ) ) {
- // Send updates to watchers other than the current editor
- $userCondition = 'wl_user != ' . $editor->getID();
+ /**
+ * Send any queued mails
+ */
+ function sendMails() {
+ global $wgEnotifImpersonal;
+ if ( $wgEnotifImpersonal ) {
+ $this->sendImpersonal( $this->mailTargets );
+ }
+ }
- if ( $userTalkId !== false ) {
- // Already sent an email to this person
- $userCondition .= ' AND wl_user != ' . intval( $userTalkId );
- }
- $dbr = wfGetDB( DB_SLAVE );
+ /**
+ * 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 );
+ }
- list( $user ) = $dbr->tableNamesN( 'user' );
+ /**
+ * Same as sendPersonalised but does impersonal mail suitable for bulk
+ * mailing. Takes an array of MailAddress objects.
+ */
+ function sendImpersonal( $addresses ) {
+ global $wgContLang;
- $res = $dbr->select( array( 'watchlist', 'user' ),
- array( "$user.*" ),
- array(
- 'wl_user=user_id',
- 'wl_title' => $title->getDBkey(),
- 'wl_namespace' => $title->getNamespace(),
- $userCondition,
- 'wl_notificationtimestamp IS NULL',
- ), __METHOD__ );
- $userArray = UserArray::newFromResult( $res );
-
- foreach ( $userArray as $watchingUser ) {
- if ( $watchingUser->getOption( 'enotifwatchlistpages' ) &&
- ( !$minorEdit || $watchingUser->getOption('enotifminoredits') ) &&
- $watchingUser->isEmailConfirmed() ) {
- $recipients[] = $watchingUser;
- }
- }
- }
+ if ( empty( $addresses ) )
+ return;
- foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
- $recipients[] = User::newFromName( $name );
- }
+ $body = str_replace(
+ array( '$WATCHINGUSERNAME',
+ '$PAGEEDITDATE' ),
+ array( wfMsgForContent( 'enotif_impersonal_salutation' ),
+ $wgContLang->timeanddate( $this->timestamp, true, false, false ) ),
+ $this->body );
- return $recipients;
+ 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 );
}
-function userMailer( $to, $from, $subject, $body, $replyto=null ) {
+/**
+ * @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