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, $wgEnotifMaxRecips, $wgAdditionalMailParams;
159 if ( !is_array( $to ) ) {
163 wfDebug( __METHOD__
. ': sending mail to ' . implode( ', ', $to ) . "\n" );
166 foreach ( $to as $u ) {
168 $dest[] = $u->address
;
171 if ( count( $dest ) == 0 ) {
172 return Status
::newFatal( 'user-mail-no-addy' );
175 $headers['From'] = $from->toString();
176 $headers['Return-Path'] = $from->address
;
177 if ( count( $to ) == 1 ) {
178 $headers['To'] = $to[0]->toString();
180 $headers['To'] = 'undisclosed-recipients:;';
184 $headers['Reply-To'] = $replyto->toString();
187 $headers['Subject'] = self
::quotedPrintable( $subject );
188 $headers['Date'] = date( 'r' );
189 $headers['MIME-Version'] = '1.0';
190 $headers['Content-type'] = ( is_null( $contentType ) ?
191 'text/plain; charset=UTF-8' : $contentType );
192 $headers['Content-transfer-encoding'] = '8bit';
194 $headers['Message-ID'] = self
::makeMsgId();
195 $headers['X-Mailer'] = 'MediaWiki mailer';
197 $ret = wfRunHooks( 'AlternateUserMailer', array( $headers, $to, $from, $subject, $body ) );
198 if ( $ret === false ) {
199 return Status
::newGood();
200 } else if ( $ret !== true ) {
201 return Status
::newFatal( 'php-mail-error', $ret );
204 if ( is_array( $wgSMTP ) ) {
205 if ( function_exists( 'stream_resolve_include_path' ) ) {
206 $found = stream_resolve_include_path( 'Mail.php' );
208 $found = Fallback
::stream_resolve_include_path( 'Mail.php' );
211 throw new MWException( 'PEAR mail package is not installed' );
213 require_once( 'Mail.php' );
215 wfSuppressWarnings();
217 // Create the mail object using the Mail::factory method
218 $mail_object =& Mail
::factory( 'smtp', $wgSMTP );
219 if ( PEAR
::isError( $mail_object ) ) {
220 wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
222 return Status
::newFatal( 'pear-mail-error', $mail_object->getMessage() );
225 wfDebug( "Sending mail via PEAR::Mail\n" );
226 $chunks = array_chunk( $dest, $wgEnotifMaxRecips );
227 foreach ( $chunks as $chunk ) {
228 $status = self
::sendWithPear( $mail_object, $chunk, $headers, $body );
229 if ( !$status->isOK() ) {
235 return Status
::newGood();
237 # Line endings need to be different on Unix and Windows due to
238 # the bug described at http://trac.wordpress.org/ticket/2603
239 if ( wfIsWindows() ) {
240 $body = str_replace( "\n", "\r\n", $body );
246 $headers = self
::arrayToHeaderString( $headers, $endl );
248 wfDebug( "Sending mail via internal mail() function\n" );
250 self
::$mErrorString = '';
251 $html_errors = ini_get( 'html_errors' );
252 ini_set( 'html_errors', '0' );
253 set_error_handler( 'UserMailer::errorHandler' );
255 $safeMode = wfIniGetBool( 'safe_mode' );
256 foreach ( $dest as $recip ) {
258 $sent = mail( $recip, self
::quotedPrintable( $subject ), $body, $headers );
260 $sent = mail( $recip, self
::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
264 restore_error_handler();
265 ini_set( 'html_errors', $html_errors );
267 if ( self
::$mErrorString ) {
268 wfDebug( "Error sending mail: " . self
::$mErrorString . "\n" );
269 return Status
::newFatal( 'php-mail-error', self
::$mErrorString );
270 } elseif ( ! $sent ) {
271 // mail function only tells if there's an error
272 wfDebug( "Unknown error sending mail\n" );
273 return Status
::newFatal( 'php-mail-error-unknown' );
275 return Status
::newGood();
281 * Set the mail error message in self::$mErrorString
283 * @param $code Integer: error number
284 * @param $string String: error message
286 static function errorHandler( $code, $string ) {
287 self
::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
291 * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
292 * @param $phrase string
295 public static function rfc822Phrase( $phrase ) {
296 $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
297 return '"' . $phrase . '"';
301 * Converts a string into quoted-printable format
304 public static function quotedPrintable( $string, $charset = '' ) {
305 # Probably incomplete; see RFC 2045
306 if( empty( $charset ) ) {
309 $charset = strtoupper( $charset );
310 $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
312 $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
313 $replace = $illegal . '\t ?_';
314 if( !preg_match( "/[$illegal]/", $string ) ) {
317 $out = "=?$charset?Q?";
318 $out .= preg_replace_callback( "/([$replace])/",
319 array( __CLASS__
, 'quotedPrintableCallback' ), $string );
324 protected static function quotedPrintableCallback( $matches ) {
325 return sprintf( "=%02X", ord( $matches[1] ) );
330 * This module processes the email notifications when the current page is
331 * changed. It looks up the table watchlist to find out which users are watching
334 * The current implementation sends independent emails to each watching user for
335 * the following reason:
337 * - Each watching user will be notified about the page edit time expressed in
338 * his/her local time (UTC is shown additionally). To achieve this, we need to
339 * find the individual timeoffset of each watching user from the preferences..
341 * Suggested improvement to slack down the number of sent emails: We could think
342 * of sending out bulk mails (bcc:user1,user2...) for all these users having the
343 * same timeoffset in their preferences.
345 * Visit the documentation pages under http://meta.wikipedia.com/Enotif
349 class EmailNotification
{
350 protected $to, $subject, $body, $replyto, $from;
351 protected $user, $title, $timestamp, $summary, $minorEdit, $oldid, $composed_common, $editor;
352 protected $mailTargets = array();
355 * Send emails corresponding to the user $editor editing the page $title.
356 * Also updates wl_notificationtimestamp.
358 * May be deferred via the job queue.
360 * @param $editor User object
361 * @param $title Title object
365 * @param $oldid (default: false)
367 public function notifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid = false ) {
368 global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker, $wgEnotifMinorEdits,
369 $wgUsersNotifiedOnAllChanges, $wgEnotifUserTalk;
371 if ( $title->getNamespace() < 0 ) {
375 // Build a list of users to notfiy
377 if ( $wgEnotifWatchlist ||
$wgShowUpdatedMarker ) {
378 $dbw = wfGetDB( DB_MASTER
);
379 $res = $dbw->select( array( 'watchlist' ),
382 'wl_title' => $title->getDBkey(),
383 'wl_namespace' => $title->getNamespace(),
384 'wl_user != ' . intval( $editor->getID() ),
385 'wl_notificationtimestamp IS NULL',
388 foreach ( $res as $row ) {
389 $watchers[] = intval( $row->wl_user
);
392 // Update wl_notificationtimestamp for all watching users except
395 $dbw->update( 'watchlist',
397 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
398 ), array( /* WHERE */
399 'wl_title' => $title->getDBkey(),
400 'wl_namespace' => $title->getNamespace(),
401 'wl_user' => $watchers
409 // If nobody is watching the page, and there are no users notified on all changes
410 // don't bother creating a job/trying to send emails
411 // $watchers deals with $wgEnotifWatchlist
412 if ( !count( $watchers ) && !count( $wgUsersNotifiedOnAllChanges ) ) {
414 // Only send notification for non minor edits, unless $wgEnotifMinorEdits
415 if ( !$minorEdit ||
( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
416 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK
);
417 if ( $wgEnotifUserTalk && $isUserTalkPage && $this->canSendUserTalkEmail( $editor, $title, $minorEdit ) ) {
426 if ( $wgEnotifUseJobQ ) {
428 'editor' => $editor->getName(),
429 'editorID' => $editor->getID(),
430 'timestamp' => $timestamp,
431 'summary' => $summary,
432 'minorEdit' => $minorEdit,
434 'watchers' => $watchers
436 $job = new EnotifNotifyJob( $title, $params );
439 $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
444 * Immediate version of notifyOnPageChange().
446 * Send emails corresponding to the user $editor editing the page $title.
447 * Also updates wl_notificationtimestamp.
449 * @param $editor User object
450 * @param $title Title object
451 * @param $timestamp string Edit timestamp
452 * @param $summary string Edit summary
453 * @param $minorEdit bool
454 * @param $oldid int Revision ID
455 * @param $watchers array of user IDs
457 public function actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers ) {
458 # we use $wgPasswordSender as sender's address
459 global $wgEnotifWatchlist;
460 global $wgEnotifMinorEdits, $wgEnotifUserTalk;
462 wfProfileIn( __METHOD__
);
464 # The following code is only run, if several conditions are met:
465 # 1. EmailNotification for pages (other than user_talk pages) must be enabled
466 # 2. minor edits (changes) are only regarded if the global flag indicates so
468 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK
);
470 $this->title
= $title;
471 $this->timestamp
= $timestamp;
472 $this->summary
= $summary;
473 $this->minorEdit
= $minorEdit;
474 $this->oldid
= $oldid;
475 $this->editor
= $editor;
476 $this->composed_common
= false;
480 if ( !$minorEdit ||
( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
482 if ( $wgEnotifUserTalk && $isUserTalkPage && $this->canSendUserTalkEmail( $editor, $title, $minorEdit ) ) {
483 $targetUser = User
::newFromName( $title->getText() );
484 $this->compose( $targetUser );
485 $userTalkId = $targetUser->getId();
488 if ( $wgEnotifWatchlist ) {
489 // Send updates to watchers other than the current editor
490 $userArray = UserArray
::newFromIDs( $watchers );
491 foreach ( $userArray as $watchingUser ) {
492 if ( $watchingUser->getOption( 'enotifwatchlistpages' ) &&
493 ( !$minorEdit ||
$watchingUser->getOption( 'enotifminoredits' ) ) &&
494 $watchingUser->isEmailConfirmed() &&
495 $watchingUser->getID() != $userTalkId )
497 $this->compose( $watchingUser );
503 global $wgUsersNotifiedOnAllChanges;
504 foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
505 $user = User
::newFromName( $name );
506 $this->compose( $user );
510 wfProfileOut( __METHOD__
);
514 * @param $editor User
515 * @param $title Title bool
519 private function canSendUserTalkEmail( $editor, $title, $minorEdit ) {
520 global $wgEnotifUserTalk;
521 $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK
);
523 if ( $wgEnotifUserTalk && $isUserTalkPage ) {
524 $targetUser = User
::newFromName( $title->getText() );
526 if ( !$targetUser ||
$targetUser->isAnon() ) {
527 wfDebug( __METHOD__
. ": user talk page edited, but user does not exist\n" );
528 } elseif ( $targetUser->getId() == $editor->getId() ) {
529 wfDebug( __METHOD__
. ": user edited their own talk page, no notification sent\n" );
530 } elseif ( $targetUser->getOption( 'enotifusertalkpages' ) &&
531 ( !$minorEdit ||
$targetUser->getOption( 'enotifminoredits' ) ) )
533 if ( $targetUser->isEmailConfirmed() ) {
534 wfDebug( __METHOD__
. ": sending talk page update notification\n" );
537 wfDebug( __METHOD__
. ": talk page owner doesn't have validated email\n" );
540 wfDebug( __METHOD__
. ": talk page owner doesn't want notifications\n" );
547 * Generate the generic "this page has been changed" e-mail text.
549 private function composeCommonMailtext() {
550 global $wgPasswordSender, $wgPasswordSenderName, $wgNoReplyAddress;
551 global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
552 global $wgEnotifImpersonal, $wgEnotifUseRealName;
554 $this->composed_common
= true;
556 # You as the WikiAdmin and Sysops can make use of plenty of
557 # named variables when composing your notification emails while
558 # simply editing the Meta pages
562 if ( $this->oldid
) {
563 if ( $wgEnotifImpersonal ) {
564 // For impersonal mail, show a diff link to the last revision.
565 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastdiff',
566 $this->title
->getCanonicalUrl( 'diff=next&oldid=' . $this->oldid
) );
568 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited',
569 $this->title
->getCanonicalUrl( 'diff=0&oldid=' . $this->oldid
) );
571 $keys['$OLDID'] = $this->oldid
;
572 $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
574 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
575 # clear $OLDID placeholder in the message template
576 $keys['$OLDID'] = '';
577 $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
580 $keys['$PAGETITLE'] = $this->title
->getPrefixedText();
581 $keys['$PAGETITLE_URL'] = $this->title
->getCanonicalUrl();
582 $keys['$PAGEMINOREDIT'] = $this->minorEdit ?
wfMsgForContent( 'minoredit' ) : '';
583 $keys['$PAGESUMMARY'] = $this->summary
== '' ?
' - ' : $this->summary
;
584 $keys['$UNWATCHURL'] = $this->title
->getCanonicalUrl( 'action=unwatch' );
586 if ( $this->editor
->isAnon() ) {
587 # real anon (user:xxx.xxx.xxx.xxx)
588 $keys['$PAGEEDITOR'] = wfMsgForContent( 'enotif_anon_editor', $this->editor
->getName() );
589 $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
591 $keys['$PAGEEDITOR'] = $wgEnotifUseRealName ?
$this->editor
->getRealName() : $this->editor
->getName();
592 $emailPage = SpecialPage
::getSafeTitleFor( 'Emailuser', $this->editor
->getName() );
593 $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getCanonicalUrl();
596 $keys['$PAGEEDITOR_WIKI'] = $this->editor
->getUserPage()->getCanonicalUrl();
598 # Now build message's subject and body
600 $subject = wfMsgExt( 'enotif_subject', 'content' );
601 $subject = strtr( $subject, $keys );
602 $this->subject
= MessageCache
::singleton()->transform( $subject, false, null, $this->title
);
604 $body = wfMsgExt( 'enotif_body', 'content' );
605 $body = strtr( $body, $keys );
606 $body = MessageCache
::singleton()->transform( $body, false, null, $this->title
);
607 $this->body
= wordwrap( $body, 72 );
609 # Reveal the page editor's address as REPLY-TO address only if
610 # the user has not opted-out and the option is enabled at the
611 # global configuration level.
612 $adminAddress = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
613 if ( $wgEnotifRevealEditorAddress
614 && ( $this->editor
->getEmail() != '' )
615 && $this->editor
->getOption( 'enotifrevealaddr' ) )
617 $editorAddress = new MailAddress( $this->editor
);
618 if ( $wgEnotifFromEditor ) {
619 $this->from
= $editorAddress;
621 $this->from
= $adminAddress;
622 $this->replyto
= $editorAddress;
625 $this->from
= $adminAddress;
626 $this->replyto
= new MailAddress( $wgNoReplyAddress );
631 * Compose a mail to a given user and either queue it for sending, or send it now,
632 * depending on settings.
634 * Call sendMails() to send any mails that were queued.
636 function compose( $user ) {
637 global $wgEnotifImpersonal;
639 if ( !$this->composed_common
)
640 $this->composeCommonMailtext();
642 if ( $wgEnotifImpersonal ) {
643 $this->mailTargets
[] = new MailAddress( $user );
645 $this->sendPersonalised( $user );
650 * Send any queued mails
652 function sendMails() {
653 global $wgEnotifImpersonal;
654 if ( $wgEnotifImpersonal ) {
655 $this->sendImpersonal( $this->mailTargets
);
660 * Does the per-user customizations to a notification e-mail (name,
661 * timestamp in proper timezone, etc) and sends it out.
662 * Returns true if the mail was sent successfully.
664 * @param $watchingUser User object
668 function sendPersonalised( $watchingUser ) {
669 global $wgContLang, $wgEnotifUseRealName;
670 // From the PHP manual:
671 // Note: The to parameter cannot be an address in the form of "Something <someone@example.com>".
672 // The mail command will not parse this properly while talking with the MTA.
673 $to = new MailAddress( $watchingUser );
675 # $PAGEEDITDATE is the time and date of the page change
676 # expressed in terms of individual local time of the notification
677 # recipient, i.e. watching user
679 array( '$WATCHINGUSERNAME',
682 array( $wgEnotifUseRealName ?
$watchingUser->getRealName() : $watchingUser->getName(),
683 $wgContLang->userDate( $this->timestamp
, $watchingUser ),
684 $wgContLang->userTime( $this->timestamp
, $watchingUser ) ),
687 return UserMailer
::send( $to, $this->from
, $this->subject
, $body, $this->replyto
);
691 * Same as sendPersonalised but does impersonal mail suitable for bulk
692 * mailing. Takes an array of MailAddress objects.
694 function sendImpersonal( $addresses ) {
697 if ( empty( $addresses ) )
701 array( '$WATCHINGUSERNAME',
704 array( wfMsgForContent( 'enotif_impersonal_salutation' ),
705 $wgContLang->date( $this->timestamp
, false, false ),
706 $wgContLang->time( $this->timestamp
, false, false ) ),
709 return UserMailer
::send( $addresses, $this->from
, $this->subject
, $body, $this->replyto
);
712 } # end of class EmailNotification