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
;
75 function __toString() {
76 return $this->toString();
82 * Collection of static functions for sending mail
88 * Send mail using a PEAR mailer
97 protected static function sendWithPear( $mailer, $dest, $headers, $body ) {
98 $mailResult = $mailer->send( $dest, $headers, $body );
100 # Based on the result return an error string,
101 if ( PEAR
::isError( $mailResult ) ) {
102 wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
103 return Status
::newFatal( 'pear-mail-error', $mailResult->getMessage() );
105 return Status
::newGood();
110 * Creates a single string from an associative array
112 * @param $header Associative Array: keys are header field names,
113 * values are ... values.
114 * @param $endl String: The end of line character. Defaults to "\n"
117 static function arrayToHeaderString( $headers, $endl = "\n" ) {
118 foreach( $headers as $name => $value ) {
119 $string[] = "$name: $value";
121 return implode( $endl, $string );
125 * Create a value suitable for the MessageId Header
129 static function makeMsgId() {
130 global $wgSMTP, $wgServer;
132 $msgid = uniqid( wfWikiID() . ".", true ); /* true required for cygwin */
133 if ( is_array($wgSMTP) && isset($wgSMTP['IDHost']) && $wgSMTP['IDHost'] ) {
134 $domain = $wgSMTP['IDHost'];
136 $url = wfParseUrl($wgServer);
137 $domain = $url['host'];
139 return "<$msgid@$domain>";
143 * This function will perform a direct (authenticated) login to
144 * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
145 * array of parameters. It requires PEAR:Mail to do that.
146 * Otherwise it just uses the standard PHP 'mail' function.
148 * @param $to MailAddress: recipient's email (or an array of them)
149 * @param $from MailAddress: sender's email
150 * @param $subject String: email's subject.
151 * @param $body String: email's text.
152 * @param $replyto MailAddress: optional reply-to email (default: null).
153 * @param $contentType String: optional custom Content-Type (default: text/plain; charset=UTF-8)
154 * @return Status object
156 public static function send( $to, $from, $subject, $body, $replyto = null, $contentType = 'text/plain; charset=UTF-8' ) {
157 global $wgSMTP, $wgEnotifImpersonal;
158 global $wgEnotifMaxRecips, $wgAdditionalMailParams;
161 wfDebug( __METHOD__
. ': sending mail to ' . implode( ',', array( $to->toString() ) ) . "\n" );
163 $headers['From'] = $from->toString();
164 $headers['Return-Path'] = $from->toString();
167 if ( is_array( $to ) ) {
168 foreach ( $to as $u ) {
170 $dest[] = $u->address
;
173 } else if( $to->address
) {
174 $dest[] = $to->address
;
176 if ( count( $dest ) == 0 ) {
177 return Status
::newFatal( 'user-mail-no-addy' );
180 if ( $wgEnotifImpersonal ) {
181 $headers['To'] = 'undisclosed-recipients:;';
184 $headers['To'] = implode( ", ", $dest );
188 $headers['Reply-To'] = $replyto->toString();
190 $headers['Subject'] = self
::quotedPrintable( $subject );
191 $headers['Date'] = date( 'r' );
192 $headers['MIME-Version'] = '1.0';
193 $headers['Content-type'] = ( is_null( $contentType ) ?
194 'text/plain; charset=UTF-8' : $contentType );
195 $headers['Content-transfer-encoding'] = '8bit';
197 $headers['Message-ID'] = self
::makeMsgId();
198 $headers['X-Mailer'] = 'MediaWiki mailer';
199 $headers['From'] = $from->toString();
201 $ret = wfRunHooks( 'AlternateUserMailer', array( $headers, $to, $from, $subject, $body ) );
202 if ( $ret === false ) {
203 return Status
::newGood();
204 } else if ( $ret !== true ) {
205 return Status
::newFatal( 'php-mail-error', $ret );
208 if ( is_array( $wgSMTP ) ) {
209 if ( function_exists( 'stream_resolve_include_path' ) ) {
210 $found = stream_resolve_include_path( 'Mail.php' );
212 $found = Fallback
::stream_resolve_include_path( 'Mail.php' );
215 throw new MWException( 'PEAR mail package is not installed' );
217 require_once( 'Mail.php' );
219 wfSuppressWarnings();
221 // Create the mail object using the Mail::factory method
222 $mail_object =& Mail
::factory( 'smtp', $wgSMTP );
223 if ( PEAR
::isError( $mail_object ) ) {
224 wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
226 return Status
::newFatal( 'pear-mail-error', $mail_object->getMessage() );
229 wfDebug( "Sending mail via PEAR::Mail\n" );
230 $chunks = array_chunk( $dest, $wgEnotifMaxRecips );
231 foreach ( $chunks as $chunk ) {
232 $status = self
::sendWithPear( $mail_object, $chunk, $headers, $body );
233 if ( !$status->isOK() ) {
239 return Status
::newGood();
241 # Line endings need to be different on Unix and Windows due to
242 # the bug described at http://trac.wordpress.org/ticket/2603
243 if ( wfIsWindows() ) {
244 $body = str_replace( "\n", "\r\n", $body );
250 $headers = self
::arrayToHeaderString( $headers, $endl );
252 wfDebug( "Sending mail via internal mail() function\n" );
254 self
::$mErrorString = '';
255 $html_errors = ini_get( 'html_errors' );
256 ini_set( 'html_errors', '0' );
257 set_error_handler( 'UserMailer::errorHandler' );
259 foreach ( $dest as $recip ) {
260 $sent = mail( $recip, self
::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
263 restore_error_handler();
264 ini_set( 'html_errors', $html_errors );
266 if ( self
::$mErrorString ) {
267 wfDebug( "Error sending mail: " . self
::$mErrorString . "\n" );
268 return Status
::newFatal( 'php-mail-error', self
::$mErrorString );
269 } elseif ( ! $sent ) {
270 // mail function only tells if there's an error
271 wfDebug( "Unknown error sending mail\n" );
272 return Status
::newFatal( 'php-mail-error-unknown' );
274 return Status
::newGood();
280 * Set the mail error message in self::$mErrorString
282 * @param $code Integer: error number
283 * @param $string String: error message
285 static function errorHandler( $code, $string ) {
286 self
::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
290 * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
291 * @param $phrase string
294 public static function rfc822Phrase( $phrase ) {
295 $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
296 return '"' . $phrase . '"';
300 * Converts a string into quoted-printable format
303 public static function quotedPrintable( $string, $charset = '' ) {
304 # Probably incomplete; see RFC 2045
305 if( empty( $charset ) ) {
308 $charset = strtoupper( $charset );
309 $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
311 $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
312 $replace = $illegal . '\t ?_';
313 if( !preg_match( "/[$illegal]/", $string ) ) {
316 $out = "=?$charset?Q?";
317 $out .= preg_replace_callback( "/([$replace])/",
318 array( __CLASS__
, 'quotedPrintableCallback' ), $string );
323 protected static function quotedPrintableCallback( $matches ) {
324 return sprintf( "=%02X", ord( $matches[1] ) );
329 * This module processes the email notifications when the current page is
330 * changed. It looks up the table watchlist to find out which users are watching
333 * The current implementation sends independent emails to each watching user for
334 * the following reason:
336 * - Each watching user will be notified about the page edit time expressed in
337 * his/her local time (UTC is shown additionally). To achieve this, we need to
338 * find the individual timeoffset of each watching user from the preferences..
340 * Suggested improvement to slack down the number of sent emails: We could think
341 * of sending out bulk mails (bcc:user1,user2...) for all these users having the
342 * same timeoffset in their preferences.
344 * Visit the documentation pages under http://meta.wikipedia.com/Enotif
348 class EmailNotification
{
349 protected $to, $subject, $body, $replyto, $from;
350 protected $user, $title, $timestamp, $summary, $minorEdit, $oldid, $composed_common, $editor;
351 protected $mailTargets = array();
354 * Send emails corresponding to the user $editor editing the page $title.
355 * Also updates wl_notificationtimestamp.
357 * May be deferred via the job queue.
359 * @param $editor User object
360 * @param $title Title object
364 * @param $oldid (default: false)
366 public function notifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid = false ) {
367 global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker;
369 if ( $title->getNamespace() < 0 ) {
373 // Build a list of users to notfiy
375 if ( $wgEnotifWatchlist ||
$wgShowUpdatedMarker ) {
376 $dbw = wfGetDB( DB_MASTER
);
377 $res = $dbw->select( array( 'watchlist' ),
380 'wl_title' => $title->getDBkey(),
381 'wl_namespace' => $title->getNamespace(),
382 'wl_user != ' . intval( $editor->getID() ),
383 'wl_notificationtimestamp IS NULL',
386 foreach ( $res as $row ) {
387 $watchers[] = intval( $row->wl_user
);
390 // Update wl_notificationtimestamp for all watching users except
393 $dbw->update( 'watchlist',
395 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
396 ), array( /* WHERE */
397 'wl_title' => $title->getDBkey(),
398 'wl_namespace' => $title->getNamespace(),
399 'wl_user' => $watchers
406 if ( $wgEnotifUseJobQ ) {
408 'editor' => $editor->getName(),
409 'editorID' => $editor->getID(),
410 'timestamp' => $timestamp,
411 'summary' => $summary,
412 'minorEdit' => $minorEdit,
414 'watchers' => $watchers
416 $job = new EnotifNotifyJob( $title, $params );
419 $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
425 * Immediate version of notifyOnPageChange().
427 * Send emails corresponding to the user $editor editing the page $title.
428 * Also updates wl_notificationtimestamp.
430 * @param $editor User object
431 * @param $title Title object
432 * @param $timestamp string Edit timestamp
433 * @param $summary string Edit summary
434 * @param $minorEdit bool
435 * @param $oldid int Revision ID
436 * @param $watchers array of user IDs
438 public function actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers ) {
439 # we use $wgPasswordSender as sender's address
440 global $wgEnotifWatchlist;
441 global $wgEnotifMinorEdits, $wgEnotifUserTalk;
443 wfProfileIn( __METHOD__
);
445 # The following code is only run, if several conditions are met:
446 # 1. EmailNotification for pages (other than user_talk pages) must be enabled
447 # 2. minor edits (changes) are only regarded if the global flag indicates so
449 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK
);
451 $this->title
= $title;
452 $this->timestamp
= $timestamp;
453 $this->summary
= $summary;
454 $this->minorEdit
= $minorEdit;
455 $this->oldid
= $oldid;
456 $this->editor
= $editor;
457 $this->composed_common
= false;
461 if ( !$minorEdit ||
( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
462 if ( $wgEnotifUserTalk && $isUserTalkPage ) {
463 $targetUser = User
::newFromName( $title->getText() );
464 if ( !$targetUser ||
$targetUser->isAnon() ) {
465 wfDebug( __METHOD__
. ": user talk page edited, but user does not exist\n" );
466 } elseif ( $targetUser->getId() == $editor->getId() ) {
467 wfDebug( __METHOD__
. ": user edited their own talk page, no notification sent\n" );
468 } elseif ( $targetUser->getOption( 'enotifusertalkpages' ) &&
469 ( !$minorEdit ||
$targetUser->getOption( 'enotifminoredits' ) ) )
471 if ( $targetUser->isEmailConfirmed() ) {
472 wfDebug( __METHOD__
. ": sending talk page update notification\n" );
473 $this->compose( $targetUser );
474 $userTalkId = $targetUser->getId();
476 wfDebug( __METHOD__
. ": talk page owner doesn't have validated email\n" );
479 wfDebug( __METHOD__
. ": talk page owner doesn't want notifications\n" );
483 if ( $wgEnotifWatchlist ) {
484 // Send updates to watchers other than the current editor
485 $userArray = UserArray
::newFromIDs( $watchers );
486 foreach ( $userArray as $watchingUser ) {
487 if ( $watchingUser->getOption( 'enotifwatchlistpages' ) &&
488 ( !$minorEdit ||
$watchingUser->getOption( 'enotifminoredits' ) ) &&
489 $watchingUser->isEmailConfirmed() &&
490 $watchingUser->getID() != $userTalkId )
492 $this->compose( $watchingUser );
498 global $wgUsersNotifiedOnAllChanges;
499 foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
500 $user = User
::newFromName( $name );
501 $this->compose( $user );
505 wfProfileOut( __METHOD__
);
509 * Generate the generic "this page has been changed" e-mail text.
511 private function composeCommonMailtext() {
512 global $wgPasswordSender, $wgPasswordSenderName, $wgNoReplyAddress;
513 global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
514 global $wgEnotifImpersonal, $wgEnotifUseRealName;
516 $this->composed_common
= true;
518 $summary = ( $this->summary
== '' ) ?
' - ' : $this->summary
;
519 $medit = ( $this->minorEdit
) ?
wfMsgForContent( 'minoredit' ) : '';
521 # You as the WikiAdmin and Sysops can make use of plenty of
522 # named variables when composing your notification emails while
523 # simply editing the Meta pages
525 $subject = wfMsgForContent( 'enotif_subject' );
526 $body = wfMsgForContent( 'enotif_body' );
527 $from = ''; /* fail safe */
528 $replyto = ''; /* fail safe */
531 if ( $this->oldid
) {
532 $difflink = $this->title
->getCanonicalUrl( 'diff=0&oldid=' . $this->oldid
);
533 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited', $difflink );
534 $keys['$OLDID'] = $this->oldid
;
535 $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
537 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
538 # clear $OLDID placeholder in the message template
539 $keys['$OLDID'] = '';
540 $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
543 if ( $wgEnotifImpersonal && $this->oldid
) {
545 * For impersonal mail, show a diff link to the last
548 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastdiff',
549 $this->title
->getCanonicalUrl( "oldid={$this->oldid}&diff=next" ) );
552 $body = strtr( $body, $keys );
553 $pagetitle = $this->title
->getPrefixedText();
554 $keys['$PAGETITLE'] = $pagetitle;
555 $keys['$PAGETITLE_URL'] = $this->title
->getCanonicalUrl();
557 $keys['$PAGEMINOREDIT'] = $medit;
558 $keys['$PAGESUMMARY'] = $summary;
559 $keys['$UNWATCHURL'] = $this->title
->getCanonicalUrl( 'action=unwatch' );
561 $subject = strtr( $subject, $keys );
563 # Reveal the page editor's address as REPLY-TO address only if
564 # the user has not opted-out and the option is enabled at the
565 # global configuration level.
566 $editor = $this->editor
;
567 $name = $wgEnotifUseRealName ?
$editor->getRealName() : $editor->getName();
568 $adminAddress = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
569 $editorAddress = new MailAddress( $editor );
570 if ( $wgEnotifRevealEditorAddress
571 && ( $editor->getEmail() != '' )
572 && $editor->getOption( 'enotifrevealaddr' ) ) {
573 if ( $wgEnotifFromEditor ) {
574 $from = $editorAddress;
576 $from = $adminAddress;
577 $replyto = $editorAddress;
580 $from = $adminAddress;
581 $replyto = new MailAddress( $wgNoReplyAddress );
584 if ( $editor->isAnon() ) {
585 # real anon (user:xxx.xxx.xxx.xxx)
586 $utext = wfMsgForContent( 'enotif_anon_editor', $name );
587 $subject = str_replace( '$PAGEEDITOR', $utext, $subject );
588 $keys['$PAGEEDITOR'] = $utext;
589 $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
591 $subject = str_replace( '$PAGEEDITOR', $name, $subject );
592 $keys['$PAGEEDITOR'] = $name;
593 $emailPage = SpecialPage
::getSafeTitleFor( 'Emailuser', $name );
594 $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getCanonicalUrl();
596 $userPage = $editor->getUserPage();
597 $keys['$PAGEEDITOR_WIKI'] = $userPage->getCanonicalUrl();
598 $body = strtr( $body, $keys );
599 $body = wordwrap( $body, 72 );
601 # now save this as the constant user-independent part of the message
603 $this->replyto
= $replyto;
604 $this->subject
= $subject;
609 * Compose a mail to a given user and either queue it for sending, or send it now,
610 * depending on settings.
612 * Call sendMails() to send any mails that were queued.
614 function compose( $user ) {
615 global $wgEnotifImpersonal;
617 if ( !$this->composed_common
)
618 $this->composeCommonMailtext();
620 if ( $wgEnotifImpersonal ) {
621 $this->mailTargets
[] = new MailAddress( $user );
623 $this->sendPersonalised( $user );
628 * Send any queued mails
630 function sendMails() {
631 global $wgEnotifImpersonal;
632 if ( $wgEnotifImpersonal ) {
633 $this->sendImpersonal( $this->mailTargets
);
638 * Does the per-user customizations to a notification e-mail (name,
639 * timestamp in proper timezone, etc) and sends it out.
640 * Returns true if the mail was sent successfully.
642 * @param $watchingUser User object
646 function sendPersonalised( $watchingUser ) {
647 global $wgContLang, $wgEnotifUseRealName;
648 // From the PHP manual:
649 // Note: The to parameter cannot be an address in the form of "Something <someone@example.com>".
650 // The mail command will not parse this properly while talking with the MTA.
651 $to = new MailAddress( $watchingUser );
652 $name = $wgEnotifUseRealName ?
$watchingUser->getRealName() : $watchingUser->getName();
653 $body = str_replace( '$WATCHINGUSERNAME', $name, $this->body
);
655 $timecorrection = $watchingUser->getOption( 'timecorrection' );
657 # $PAGEEDITDATE is the time and date of the page change
658 # expressed in terms of individual local time of the notification
659 # recipient, i.e. watching user
661 array( '$PAGEEDITDATEANDTIME',
664 array( $wgContLang->timeanddate( $this->timestamp
, true, false, $timecorrection ),
665 $wgContLang->date( $this->timestamp
, true, false, $timecorrection ),
666 $wgContLang->time( $this->timestamp
, true, false, $timecorrection ) ),
669 return UserMailer
::send( $to, $this->from
, $this->subject
, $body, $this->replyto
);
673 * Same as sendPersonalised but does impersonal mail suitable for bulk
674 * mailing. Takes an array of MailAddress objects.
676 function sendImpersonal( $addresses ) {
679 if ( empty( $addresses ) )
683 array( '$WATCHINGUSERNAME',
686 array( wfMsgForContent( 'enotif_impersonal_salutation' ),
687 $wgContLang->date( $this->timestamp
, true, false, false ),
688 $wgContLang->time( $this->timestamp
, true, false, false ) ),
691 return UserMailer
::send( $addresses, $this->from
, $this->subject
, $body, $this->replyto
);
694 } # end of class EmailNotification