3 * Classes used to send e-mails
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author <brion@pobox.com>
22 * @author <mail@tgries.de>
23 * @author Tim Starling
28 * Stores a single person's name and email address.
29 * These are passed in via the constructor, and will be returned in SMTP
30 * header format when requested.
34 * @param $address string|User string with an email address, or a User object
35 * @param $name String: human-readable name if a string address is given
36 * @param $realName String: human-readable real name if a string address is given
38 function __construct( $address, $name = null, $realName = null ) {
39 if ( is_object( $address ) && $address instanceof User
) {
40 $this->address
= $address->getEmail();
41 $this->name
= $address->getName();
42 $this->realName
= $address->getRealName();
44 $this->address
= strval( $address );
45 $this->name
= strval( $name );
46 $this->realName
= strval( $realName );
51 * Return formatted and quoted address to insert into SMTP headers
55 # PHP's mail() implementation under Windows is somewhat shite, and
56 # can't handle "Joe Bloggs <joe@bloggs.com>" format email addresses,
57 # so don't bother generating them
58 if ( $this->address
) {
59 if ( $this->name
!= '' && !wfIsWindows() ) {
60 global $wgEnotifUseRealName;
61 $name = ( $wgEnotifUseRealName && $this->realName
) ?
$this->realName
: $this->name
;
62 $quoted = UserMailer
::quotedPrintable( $name );
63 if ( strpos( $quoted, '.' ) !== false ||
strpos( $quoted, ',' ) !== false ) {
64 $quoted = '"' . $quoted . '"';
66 return "$quoted <{$this->address}>";
68 return $this->address
;
73 function __toString() {
74 return $this->toString();
80 * Collection of static functions for sending mail
86 * Send mail using a PEAR mailer
95 protected static function sendWithPear( $mailer, $dest, $headers, $body ) {
96 $mailResult = $mailer->send( $dest, $headers, $body );
98 # Based on the result return an error string,
99 if ( PEAR
::isError( $mailResult ) ) {
100 wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
101 return Status
::newFatal( 'pear-mail-error', $mailResult->getMessage() );
103 return Status
::newGood();
108 * This function will perform a direct (authenticated) login to
109 * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
110 * array of parameters. It requires PEAR:Mail to do that.
111 * Otherwise it just uses the standard PHP 'mail' function.
113 * @param $to MailAddress: recipient's email (or an array of them)
114 * @param $from MailAddress: sender's email
115 * @param $subject String: email's subject.
116 * @param $body String: email's text.
117 * @param $replyto MailAddress: optional reply-to email (default: null).
118 * @param $contentType String: optional custom Content-Type (default: text/plain; charset=UTF-8)
119 * @return Status object
121 public static function send( $to, $from, $subject, $body, $replyto = null, $contentType = 'text/plain; charset=UTF-8') {
122 global $wgSMTP, $wgEnotifImpersonal;
123 global $wgEnotifMaxRecips, $wgAdditionalMailParams;
125 if ( is_array( $to ) ) {
127 // This wouldn't be necessary if implode() worked on arrays of
128 // objects using __toString(). http://bugs.php.net/bug.php?id=36612
129 foreach ( $to as $t ) {
130 $emails .= $t->toString() . ",";
132 $emails = rtrim( $emails, ',' );
133 wfDebug( __METHOD__
. ': sending mail to ' . $emails . "\n" );
135 wfDebug( __METHOD__
. ': sending mail to ' . implode( ',', array( $to->toString() ) ) . "\n" );
138 if ( is_array( $wgSMTP ) ) {
139 if ( function_exists( 'stream_resolve_include_path' ) ) {
140 $found = stream_resolve_include_path( 'Mail.php' );
142 $found = Fallback
::stream_resolve_include_path( 'Mail.php' );
145 throw new MWException( 'PEAR mail package is not installed' );
147 require_once( 'Mail.php' );
149 $msgid = str_replace( " ", "_", microtime() );
150 if ( function_exists( 'posix_getpid' ) ) {
151 $msgid .= '.' . posix_getpid();
154 if ( is_array( $to ) ) {
156 foreach ( $to as $u ) {
157 $dest[] = $u->address
;
160 $dest = $to->address
;
163 $headers['From'] = $from->toString();
164 $headers['Return-Path'] = $from->toString();
166 if ( $wgEnotifImpersonal ) {
167 $headers['To'] = 'undisclosed-recipients:;';
170 $headers['To'] = implode( ", ", (array )$dest );
174 $headers['Reply-To'] = $replyto->toString();
176 $headers['Subject'] = self
::quotedPrintable( $subject );
177 $headers['Date'] = date( 'r' );
178 $headers['MIME-Version'] = '1.0';
179 $headers['Content-type'] = ( is_null( $contentType ) ?
180 'text/plain; charset=UTF-8' : $contentType );
181 $headers['Content-transfer-encoding'] = '8bit';
183 $headers['Message-ID'] = "<$msgid@" . $wgSMTP['IDHost'] . '>';
184 $headers['X-Mailer'] = 'MediaWiki mailer';
186 wfSuppressWarnings();
188 // Create the mail object using the Mail::factory method
189 $mail_object =& Mail
::factory( 'smtp', $wgSMTP );
190 if ( PEAR
::isError( $mail_object ) ) {
191 wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
193 return Status
::newFatal( 'pear-mail-error', $mail_object->getMessage() );
196 wfDebug( "Sending mail via PEAR::Mail to $dest\n" );
197 $chunks = array_chunk( (array)$dest, $wgEnotifMaxRecips );
198 foreach ( $chunks as $chunk ) {
199 $status = self
::sendWithPear( $mail_object, $chunk, $headers, $body );
200 if ( !$status->isOK() ) {
206 return Status
::newGood();
208 # Line endings need to be different on Unix and Windows due to
209 # the bug described at http://trac.wordpress.org/ticket/2603
210 if ( wfIsWindows() ) {
211 $body = str_replace( "\n", "\r\n", $body );
219 "Content-type: $contentType",
220 "Content-Transfer-Encoding: 8bit",
221 "X-Mailer: MediaWiki mailer",
222 "From: " . $from->toString(),
225 $headers[] = "Reply-To: " . $replyto->toString();
228 $headers = implode( $endl, $headers );
230 wfDebug( "Sending mail via internal mail() function\n" );
232 self
::$mErrorString = '';
233 $html_errors = ini_get( 'html_errors' );
234 ini_set( 'html_errors', '0' );
235 set_error_handler( 'UserMailer::errorHandler' );
237 if ( !is_array( $to ) ) {
240 foreach ( $to as $recip ) {
241 $sent = mail( $recip->toString(), self
::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
244 restore_error_handler();
245 ini_set( 'html_errors', $html_errors );
247 if ( self
::$mErrorString ) {
248 wfDebug( "Error sending mail: " . self
::$mErrorString . "\n" );
249 return Status
::newFatal( 'php-mail-error', self
::$mErrorString );
250 } elseif ( ! $sent ) {
251 // mail function only tells if there's an error
252 wfDebug( "Error sending mail\n" );
253 return Status
::newFatal( 'php-mail-error-unknown' );
255 return Status
::newGood();
261 * Set the mail error message in self::$mErrorString
263 * @param $code Integer: error number
264 * @param $string String: error message
266 static function errorHandler( $code, $string ) {
267 self
::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
271 * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
272 * @param $phrase string
275 public static function rfc822Phrase( $phrase ) {
276 $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
277 return '"' . $phrase . '"';
281 * Converts a string into quoted-printable format
284 public static function quotedPrintable( $string, $charset = '' ) {
285 # Probably incomplete; see RFC 2045
286 if( empty( $charset ) ) {
289 $charset = strtoupper( $charset );
290 $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
292 $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
293 $replace = $illegal . '\t ?_';
294 if( !preg_match( "/[$illegal]/", $string ) ) {
297 $out = "=?$charset?Q?";
298 $out .= preg_replace_callback( "/([$replace])/",
299 array( __CLASS__
, 'quotedPrintableCallback' ), $string );
304 protected static function quotedPrintableCallback( $matches ) {
305 return sprintf( "=%02X", ord( $matches[1] ) );
310 * This module processes the email notifications when the current page is
311 * changed. It looks up the table watchlist to find out which users are watching
314 * The current implementation sends independent emails to each watching user for
315 * the following reason:
317 * - Each watching user will be notified about the page edit time expressed in
318 * his/her local time (UTC is shown additionally). To achieve this, we need to
319 * find the individual timeoffset of each watching user from the preferences..
321 * Suggested improvement to slack down the number of sent emails: We could think
322 * of sending out bulk mails (bcc:user1,user2...) for all these users having the
323 * same timeoffset in their preferences.
325 * Visit the documentation pages under http://meta.wikipedia.com/Enotif
329 class EmailNotification
{
330 protected $to, $subject, $body, $replyto, $from;
331 protected $user, $title, $timestamp, $summary, $minorEdit, $oldid, $composed_common, $editor;
332 protected $mailTargets = array();
335 * Send emails corresponding to the user $editor editing the page $title.
336 * Also updates wl_notificationtimestamp.
338 * May be deferred via the job queue.
340 * @param $editor User object
341 * @param $title Title object
345 * @param $oldid (default: false)
347 public function notifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid = false ) {
348 global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker;
350 if ( $title->getNamespace() < 0 ) {
354 // Build a list of users to notfiy
356 if ( $wgEnotifWatchlist ||
$wgShowUpdatedMarker ) {
357 $dbw = wfGetDB( DB_MASTER
);
358 $res = $dbw->select( array( 'watchlist' ),
361 'wl_title' => $title->getDBkey(),
362 'wl_namespace' => $title->getNamespace(),
363 'wl_user != ' . intval( $editor->getID() ),
364 'wl_notificationtimestamp IS NULL',
367 foreach ( $res as $row ) {
368 $watchers[] = intval( $row->wl_user
);
371 // Update wl_notificationtimestamp for all watching users except
374 $dbw->update( 'watchlist',
376 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
377 ), array( /* WHERE */
378 'wl_title' => $title->getDBkey(),
379 'wl_namespace' => $title->getNamespace(),
380 'wl_user' => $watchers
387 if ( $wgEnotifUseJobQ ) {
389 "editor" => $editor->getName(),
390 "editorID" => $editor->getID(),
391 "timestamp" => $timestamp,
392 "summary" => $summary,
393 "minorEdit" => $minorEdit,
395 "watchers" => $watchers );
396 $job = new EnotifNotifyJob( $title, $params );
399 $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
405 * Immediate version of notifyOnPageChange().
407 * Send emails corresponding to the user $editor editing the page $title.
408 * Also updates wl_notificationtimestamp.
410 * @param $editor User object
411 * @param $title Title object
412 * @param $timestamp string Edit timestamp
413 * @param $summary string Edit summary
414 * @param $minorEdit bool
415 * @param $oldid int Revision ID
416 * @param $watchers array of user IDs
418 public function actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers ) {
419 # we use $wgPasswordSender as sender's address
420 global $wgEnotifWatchlist;
421 global $wgEnotifMinorEdits, $wgEnotifUserTalk;
423 wfProfileIn( __METHOD__
);
425 # The following code is only run, if several conditions are met:
426 # 1. EmailNotification for pages (other than user_talk pages) must be enabled
427 # 2. minor edits (changes) are only regarded if the global flag indicates so
429 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK
);
431 $this->title
= $title;
432 $this->timestamp
= $timestamp;
433 $this->summary
= $summary;
434 $this->minorEdit
= $minorEdit;
435 $this->oldid
= $oldid;
436 $this->editor
= $editor;
437 $this->composed_common
= false;
441 if ( !$minorEdit ||
( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
442 if ( $wgEnotifUserTalk && $isUserTalkPage ) {
443 $targetUser = User
::newFromName( $title->getText() );
444 if ( !$targetUser ||
$targetUser->isAnon() ) {
445 wfDebug( __METHOD__
. ": user talk page edited, but user does not exist\n" );
446 } elseif ( $targetUser->getId() == $editor->getId() ) {
447 wfDebug( __METHOD__
. ": user edited their own talk page, no notification sent\n" );
448 } elseif ( $targetUser->getOption( 'enotifusertalkpages' ) &&
449 ( !$minorEdit ||
$targetUser->getOption( 'enotifminoredits' ) ) )
451 if ( $targetUser->isEmailConfirmed() ) {
452 wfDebug( __METHOD__
. ": sending talk page update notification\n" );
453 $this->compose( $targetUser );
454 $userTalkId = $targetUser->getId();
456 wfDebug( __METHOD__
. ": talk page owner doesn't have validated email\n" );
459 wfDebug( __METHOD__
. ": talk page owner doesn't want notifications\n" );
463 if ( $wgEnotifWatchlist ) {
464 // Send updates to watchers other than the current editor
465 $userArray = UserArray
::newFromIDs( $watchers );
466 foreach ( $userArray as $watchingUser ) {
467 if ( $watchingUser->getOption( 'enotifwatchlistpages' ) &&
468 ( !$minorEdit ||
$watchingUser->getOption( 'enotifminoredits' ) ) &&
469 $watchingUser->isEmailConfirmed() &&
470 $watchingUser->getID() != $userTalkId )
472 $this->compose( $watchingUser );
478 global $wgUsersNotifiedOnAllChanges;
479 foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
480 $user = User
::newFromName( $name );
481 $this->compose( $user );
485 wfProfileOut( __METHOD__
);
489 * Generate the generic "this page has been changed" e-mail text.
491 private function composeCommonMailtext() {
492 global $wgPasswordSender, $wgPasswordSenderName, $wgNoReplyAddress;
493 global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
494 global $wgEnotifImpersonal, $wgEnotifUseRealName;
496 $this->composed_common
= true;
498 $summary = ( $this->summary
== '' ) ?
' - ' : $this->summary
;
499 $medit = ( $this->minorEdit
) ?
wfMsgForContent( 'minoredit' ) : '';
501 # You as the WikiAdmin and Sysops can make use of plenty of
502 # named variables when composing your notification emails while
503 # simply editing the Meta pages
505 $subject = wfMsgForContent( 'enotif_subject' );
506 $body = wfMsgForContent( 'enotif_body' );
507 $from = ''; /* fail safe */
508 $replyto = ''; /* fail safe */
511 if ( $this->oldid
) {
512 $difflink = $this->title
->getFullUrl( 'diff=0&oldid=' . $this->oldid
);
513 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited', $difflink );
514 $keys['$OLDID'] = $this->oldid
;
515 $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
517 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
518 # clear $OLDID placeholder in the message template
519 $keys['$OLDID'] = '';
520 $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
523 if ( $wgEnotifImpersonal && $this->oldid
) {
525 * For impersonal mail, show a diff link to the last
528 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastdiff',
529 $this->title
->getFullURL( "oldid={$this->oldid}&diff=next" ) );
532 $body = strtr( $body, $keys );
533 $pagetitle = $this->title
->getPrefixedText();
534 $keys['$PAGETITLE'] = $pagetitle;
535 $keys['$PAGETITLE_URL'] = $this->title
->getFullUrl();
537 $keys['$PAGEMINOREDIT'] = $medit;
538 $keys['$PAGESUMMARY'] = $summary;
539 $keys['$UNWATCHURL'] = $this->title
->getFullUrl( 'action=unwatch' );
541 $subject = strtr( $subject, $keys );
543 # Reveal the page editor's address as REPLY-TO address only if
544 # the user has not opted-out and the option is enabled at the
545 # global configuration level.
546 $editor = $this->editor
;
547 $name = $wgEnotifUseRealName ?
$editor->getRealName() : $editor->getName();
548 $adminAddress = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
549 $editorAddress = new MailAddress( $editor );
550 if ( $wgEnotifRevealEditorAddress
551 && ( $editor->getEmail() != '' )
552 && $editor->getOption( 'enotifrevealaddr' ) ) {
553 if ( $wgEnotifFromEditor ) {
554 $from = $editorAddress;
556 $from = $adminAddress;
557 $replyto = $editorAddress;
560 $from = $adminAddress;
561 $replyto = new MailAddress( $wgNoReplyAddress );
564 if ( $editor->isAnon() ) {
565 # real anon (user:xxx.xxx.xxx.xxx)
566 $utext = wfMsgForContent( 'enotif_anon_editor', $name );
567 $subject = str_replace( '$PAGEEDITOR', $utext, $subject );
568 $keys['$PAGEEDITOR'] = $utext;
569 $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
571 $subject = str_replace( '$PAGEEDITOR', $name, $subject );
572 $keys['$PAGEEDITOR'] = $name;
573 $emailPage = SpecialPage
::getSafeTitleFor( 'Emailuser', $name );
574 $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getFullUrl();
576 $userPage = $editor->getUserPage();
577 $keys['$PAGEEDITOR_WIKI'] = $userPage->getFullUrl();
578 $body = strtr( $body, $keys );
579 $body = wordwrap( $body, 72 );
581 # now save this as the constant user-independent part of the message
583 $this->replyto
= $replyto;
584 $this->subject
= $subject;
589 * Compose a mail to a given user and either queue it for sending, or send it now,
590 * depending on settings.
592 * Call sendMails() to send any mails that were queued.
594 function compose( $user ) {
595 global $wgEnotifImpersonal;
597 if ( !$this->composed_common
)
598 $this->composeCommonMailtext();
600 if ( $wgEnotifImpersonal ) {
601 $this->mailTargets
[] = new MailAddress( $user );
603 $this->sendPersonalised( $user );
608 * Send any queued mails
610 function sendMails() {
611 global $wgEnotifImpersonal;
612 if ( $wgEnotifImpersonal ) {
613 $this->sendImpersonal( $this->mailTargets
);
618 * Does the per-user customizations to a notification e-mail (name,
619 * timestamp in proper timezone, etc) and sends it out.
620 * Returns true if the mail was sent successfully.
622 * @param $watchingUser User object
626 function sendPersonalised( $watchingUser ) {
627 global $wgContLang, $wgEnotifUseRealName;
628 // From the PHP manual:
629 // Note: The to parameter cannot be an address in the form of "Something <someone@example.com>".
630 // The mail command will not parse this properly while talking with the MTA.
631 $to = new MailAddress( $watchingUser );
632 $name = $wgEnotifUseRealName ?
$watchingUser->getRealName() : $watchingUser->getName();
633 $body = str_replace( '$WATCHINGUSERNAME', $name, $this->body
);
635 $timecorrection = $watchingUser->getOption( 'timecorrection' );
637 # $PAGEEDITDATE is the time and date of the page change
638 # expressed in terms of individual local time of the notification
639 # recipient, i.e. watching user
641 array( '$PAGEEDITDATEANDTIME',
644 array( $wgContLang->timeanddate( $this->timestamp
, true, false, $timecorrection ),
645 $wgContLang->date( $this->timestamp
, true, false, $timecorrection ),
646 $wgContLang->time( $this->timestamp
, true, false, $timecorrection ) ),
649 return UserMailer
::send( $to, $this->from
, $this->subject
, $body, $this->replyto
);
653 * Same as sendPersonalised but does impersonal mail suitable for bulk
654 * mailing. Takes an array of MailAddress objects.
656 function sendImpersonal( $addresses ) {
659 if ( empty( $addresses ) )
663 array( '$WATCHINGUSERNAME',
666 array( wfMsgForContent( 'enotif_impersonal_salutation' ),
667 $wgContLang->date( $this->timestamp
, true, false, false ),
668 $wgContLang->time( $this->timestamp
, true, false, false ) ),
671 return UserMailer
::send( $addresses, $this->from
, $this->subject
, $body, $this->replyto
);
674 } # end of class EmailNotification