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 Mixed: 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->name
!= '' && !wfIsWindows() ) {
59 global $wgEnotifUseRealName;
60 $name = ( $wgEnotifUseRealName && $this->realName
) ?
$this->realName
: $this->name
;
61 $quoted = wfQuotedPrintable( $name );
62 if( strpos( $quoted, '.' ) !== false ||
strpos( $quoted, ',' ) !== false ) {
63 $quoted = '"' . $quoted . '"';
65 return "$quoted <{$this->address}>";
67 return $this->address
;
71 function __toString() {
72 return $this->toString();
78 * Collection of static functions for sending mail
84 * Send mail using a PEAR mailer
86 protected static function sendWithPear($mailer, $dest, $headers, $body)
88 $mailResult = $mailer->send($dest, $headers, $body);
90 # Based on the result return an error string,
91 if( PEAR
::isError( $mailResult ) ) {
92 wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
93 return Status
::newFatal( 'pear-mail-error', $mailResult->getMessage() );
95 return Status
::newGood();
100 * This function will perform a direct (authenticated) login to
101 * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
102 * array of parameters. It requires PEAR:Mail to do that.
103 * Otherwise it just uses the standard PHP 'mail' function.
105 * @param $to MailAddress: recipient's email (or an array of them)
106 * @param $from MailAddress: sender's email
107 * @param $subject String: email's subject.
108 * @param $body String: email's text.
109 * @param $replyto MailAddress: optional reply-to email (default: null).
110 * @param $contentType String: optional custom Content-Type
111 * @return Status object
113 static function send( $to, $from, $subject, $body, $replyto=null, $contentType=null ) {
114 global $wgSMTP, $wgOutputEncoding, $wgEnotifImpersonal;
115 global $wgEnotifMaxRecips, $wgAdditionalMailParams;
117 if ( is_array( $to ) ) {
118 // This wouldn't be necessary if implode() worked on arrays of
119 // objects using __toString(). http://bugs.php.net/bug.php?id=36612
120 foreach( $to as $t ) {
121 $emails .= $t->toString() . ",";
123 $emails = rtrim( $emails, ',' );
124 wfDebug( __METHOD__
.': sending mail to ' . $emails . "\n" );
126 wfDebug( __METHOD__
.': sending mail to ' . implode( ',', array( $to->toString() ) ) . "\n" );
129 if (is_array( $wgSMTP )) {
131 $pathArray = explode( PATH_SEPARATOR
, get_include_path() );
132 foreach ( $pathArray as $path ) {
133 if ( file_exists( $path . DIRECTORY_SEPARATOR
. 'Mail.php' ) ) {
139 throw new MWException( 'PEAR mail package is not installed' );
141 require_once( 'Mail.php' );
143 $msgid = str_replace(" ", "_", microtime());
144 if (function_exists('posix_getpid'))
145 $msgid .= '.' . posix_getpid();
150 $dest[] = $u->address
;
152 $dest = $to->address
;
154 $headers['From'] = $from->toString();
156 if ($wgEnotifImpersonal) {
157 $headers['To'] = 'undisclosed-recipients:;';
160 $headers['To'] = implode( ", ", (array )$dest );
164 $headers['Reply-To'] = $replyto->toString();
166 $headers['Subject'] = wfQuotedPrintable( $subject );
167 $headers['Date'] = date( 'r' );
168 $headers['MIME-Version'] = '1.0';
169 $headers['Content-type'] = (is_null($contentType) ?
170 'text/plain; charset='.$wgOutputEncoding : $contentType);
171 $headers['Content-transfer-encoding'] = '8bit';
172 $headers['Message-ID'] = "<$msgid@" . $wgSMTP['IDHost'] . '>'; // FIXME
173 $headers['X-Mailer'] = 'MediaWiki mailer';
175 wfSuppressWarnings();
177 // Create the mail object using the Mail::factory method
178 $mail_object =& Mail
::factory('smtp', $wgSMTP);
179 if( PEAR
::isError( $mail_object ) ) {
180 wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
182 return Status
::newFatal( 'pear-mail-error', $mail_object->getMessage() );
185 wfDebug( "Sending mail via PEAR::Mail to $dest\n" );
186 $chunks = array_chunk( (array)$dest, $wgEnotifMaxRecips );
187 foreach ($chunks as $chunk) {
188 $status = self
::sendWithPear($mail_object, $chunk, $headers, $body);
189 if( !$status->isOK() ) {
195 return Status
::newGood();
197 # In the following $headers = expression we removed "Reply-To: {$from}\r\n" , because it is treated differently
198 # (fifth parameter of the PHP mail function, see some lines below)
200 # Line endings need to be different on Unix and Windows due to
201 # the bug described at http://trac.wordpress.org/ticket/2603
202 if ( wfIsWindows() ) {
203 $body = str_replace( "\n", "\r\n", $body );
208 $ctype = (is_null($contentType) ?
209 'text/plain; charset='.$wgOutputEncoding : $contentType);
211 "MIME-Version: 1.0$endl" .
212 "Content-type: $ctype$endl" .
213 "Content-Transfer-Encoding: 8bit$endl" .
214 "X-Mailer: MediaWiki mailer$endl".
215 'From: ' . $from->toString();
217 $headers .= "{$endl}Reply-To: " . $replyto->toString();
220 wfDebug( "Sending mail via internal mail() function\n" );
222 self
::$mErrorString = '';
223 $html_errors = ini_get( 'html_errors' );
224 ini_set( 'html_errors', '0' );
225 set_error_handler( array( 'UserMailer', 'errorHandler' ) );
228 foreach ($to as $recip) {
229 $sent = mail( $recip->toString(), wfQuotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
232 $sent = mail( $to->toString(), wfQuotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
235 restore_error_handler();
236 ini_set( 'html_errors', $html_errors );
238 if ( self
::$mErrorString ) {
239 wfDebug( "Error sending mail: " . self
::$mErrorString . "\n" );
240 return Status
::newFatal( 'php-mail-error', self
::$mErrorString );
241 } elseif (! $sent ) {
242 //mail function only tells if there's an error
243 wfDebug( "Error sending mail\n" );
244 return Status
::newFatal( 'php-mail-error-unknown' );
246 return Status
::newGood();
252 * Set the mail error message in self::$mErrorString
254 * @param $code Integer: error number
255 * @param $string String: error message
257 static function errorHandler( $code, $string ) {
258 self
::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
262 * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
264 static function rfc822Phrase( $phrase ) {
265 $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
266 return '"' . $phrase . '"';
271 * This module processes the email notifications when the current page is
272 * changed. It looks up the table watchlist to find out which users are watching
275 * The current implementation sends independent emails to each watching user for
276 * the following reason:
278 * - Each watching user will be notified about the page edit time expressed in
279 * his/her local time (UTC is shown additionally). To achieve this, we need to
280 * find the individual timeoffset of each watching user from the preferences..
282 * Suggested improvement to slack down the number of sent emails: We could think
283 * of sending out bulk mails (bcc:user1,user2...) for all these users having the
284 * same timeoffset in their preferences.
286 * Visit the documentation pages under http://meta.wikipedia.com/Enotif
290 class EmailNotification
{
291 protected $to, $subject, $body, $replyto, $from;
292 protected $user, $title, $timestamp, $summary, $minorEdit, $oldid, $composed_common, $editor;
293 protected $mailTargets = array();
296 * Send emails corresponding to the user $editor editing the page $title.
297 * Also updates wl_notificationtimestamp.
299 * May be deferred via the job queue.
301 * @param $editor User object
302 * @param $title Title object
306 * @param $oldid (default: false)
308 function notifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid = false) {
309 global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker;
311 if ($title->getNamespace() < 0)
314 // Build a list of users to notfiy
316 if ($wgEnotifWatchlist ||
$wgShowUpdatedMarker) {
317 $dbw = wfGetDB( DB_MASTER
);
318 $res = $dbw->select( array( 'watchlist' ),
321 'wl_title' => $title->getDBkey(),
322 'wl_namespace' => $title->getNamespace(),
323 'wl_user != ' . intval( $editor->getID() ),
324 'wl_notificationtimestamp IS NULL',
327 foreach ( $res as $row ) {
328 $watchers[] = intval( $row->wl_user
);
331 // Update wl_notificationtimestamp for all watching users except
334 $dbw->update( 'watchlist',
336 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
337 ), array( /* WHERE */
338 'wl_title' => $title->getDBkey(),
339 'wl_namespace' => $title->getNamespace(),
340 'wl_user' => $watchers
347 if ($wgEnotifUseJobQ) {
349 "editor" => $editor->getName(),
350 "editorID" => $editor->getID(),
351 "timestamp" => $timestamp,
352 "summary" => $summary,
353 "minorEdit" => $minorEdit,
355 "watchers" => $watchers);
356 $job = new EnotifNotifyJob( $title, $params );
359 $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
365 * Immediate version of notifyOnPageChange().
367 * Send emails corresponding to the user $editor editing the page $title.
368 * Also updates wl_notificationtimestamp.
370 * @param $editor User object
371 * @param $title Title object
372 * @param $timestamp string Edit timestamp
373 * @param $summary string Edit summary
374 * @param $minorEdit bool
375 * @param $oldid int Revision ID
376 * @param $watchers array of user IDs
378 function actuallyNotifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers) {
379 # we use $wgPasswordSender as sender's address
380 global $wgEnotifWatchlist;
381 global $wgEnotifMinorEdits, $wgEnotifUserTalk;
383 wfProfileIn( __METHOD__
);
385 # The following code is only run, if several conditions are met:
386 # 1. EmailNotification for pages (other than user_talk pages) must be enabled
387 # 2. minor edits (changes) are only regarded if the global flag indicates so
389 $isUserTalkPage = ($title->getNamespace() == NS_USER_TALK
);
391 $this->title
= $title;
392 $this->timestamp
= $timestamp;
393 $this->summary
= $summary;
394 $this->minorEdit
= $minorEdit;
395 $this->oldid
= $oldid;
396 $this->editor
= $editor;
397 $this->composed_common
= false;
401 if ( !$minorEdit ||
($wgEnotifMinorEdits && !$editor->isAllowed('nominornewtalk') ) ) {
402 if ( $wgEnotifUserTalk && $isUserTalkPage ) {
403 $targetUser = User
::newFromName( $title->getText() );
404 if ( !$targetUser ||
$targetUser->isAnon() ) {
405 wfDebug( __METHOD__
.": user talk page edited, but user does not exist\n" );
406 } elseif ( $targetUser->getId() == $editor->getId() ) {
407 wfDebug( __METHOD__
.": user edited their own talk page, no notification sent\n" );
408 } elseif( $targetUser->getOption( 'enotifusertalkpages' ) ) {
409 if( $targetUser->isEmailConfirmed() ) {
410 wfDebug( __METHOD__
.": sending talk page update notification\n" );
411 $this->compose( $targetUser );
412 $userTalkId = $targetUser->getId();
414 wfDebug( __METHOD__
.": talk page owner doesn't have validated email\n" );
417 wfDebug( __METHOD__
.": talk page owner doesn't want notifications\n" );
421 if ( $wgEnotifWatchlist ) {
422 // Send updates to watchers other than the current editor
423 $userArray = UserArray
::newFromIDs( $watchers );
424 foreach ( $userArray as $watchingUser ) {
425 if ( $watchingUser->getOption( 'enotifwatchlistpages' ) &&
426 ( !$minorEdit ||
$watchingUser->getOption('enotifminoredits') ) &&
427 $watchingUser->isEmailConfirmed() &&
428 $watchingUser->getID() != $userTalkId )
430 $this->compose( $watchingUser );
436 global $wgUsersNotifiedOnAllChanges;
437 foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
438 $user = User
::newFromName( $name );
439 $this->compose( $user );
443 wfProfileOut( __METHOD__
);
449 function composeCommonMailtext() {
450 global $wgPasswordSender, $wgPasswordSenderName, $wgNoReplyAddress;
451 global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
452 global $wgEnotifImpersonal, $wgEnotifUseRealName;
454 $this->composed_common
= true;
456 $summary = ($this->summary
== '') ?
' - ' : $this->summary
;
457 $medit = ($this->minorEdit
) ?
wfMsgForContent( 'minoredit' ) : '';
459 # You as the WikiAdmin and Sysops can make use of plenty of
460 # named variables when composing your notification emails while
461 # simply editing the Meta pages
463 $subject = wfMsgForContent( 'enotif_subject' );
464 $body = wfMsgForContent( 'enotif_body' );
465 $from = ''; /* fail safe */
466 $replyto = ''; /* fail safe */
470 $difflink = $this->title
->getFullUrl( 'diff=0&oldid=' . $this->oldid
);
471 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited', $difflink );
472 $keys['$OLDID'] = $this->oldid
;
473 $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
475 $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
476 # clear $OLDID placeholder in the message template
477 $keys['$OLDID'] = '';
478 $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
481 if ($wgEnotifImpersonal && $this->oldid
) {
483 * For impersonal mail, show a diff link to the last
486 $keys['$NEWPAGE'] = wfMsgForContent('enotif_lastdiff',
487 $this->title
->getFullURL("oldid={$this->oldid}&diff=next"));
490 $body = strtr( $body, $keys );
491 $pagetitle = $this->title
->getPrefixedText();
492 $keys['$PAGETITLE'] = $pagetitle;
493 $keys['$PAGETITLE_URL'] = $this->title
->getFullUrl();
495 $keys['$PAGEMINOREDIT'] = $medit;
496 $keys['$PAGESUMMARY'] = $summary;
497 $keys['$UNWATCHURL'] = $this->title
->getFullUrl( 'action=unwatch' );
499 $subject = strtr( $subject, $keys );
501 # Reveal the page editor's address as REPLY-TO address only if
502 # the user has not opted-out and the option is enabled at the
503 # global configuration level.
504 $editor = $this->editor
;
505 $name = $wgEnotifUseRealName ?
$editor->getRealName() : $editor->getName();
506 $adminAddress = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
507 $editorAddress = new MailAddress( $editor );
508 if( $wgEnotifRevealEditorAddress
509 && ( $editor->getEmail() != '' )
510 && $editor->getOption( 'enotifrevealaddr' ) ) {
511 if( $wgEnotifFromEditor ) {
512 $from = $editorAddress;
514 $from = $adminAddress;
515 $replyto = $editorAddress;
518 $from = $adminAddress;
519 $replyto = new MailAddress( $wgNoReplyAddress );
522 if( $editor->isIP( $name ) ) {
523 #real anon (user:xxx.xxx.xxx.xxx)
524 $utext = wfMsgForContent('enotif_anon_editor', $name);
525 $subject = str_replace('$PAGEEDITOR', $utext, $subject);
526 $keys['$PAGEEDITOR'] = $utext;
527 $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
529 $subject = str_replace('$PAGEEDITOR', $name, $subject);
530 $keys['$PAGEEDITOR'] = $name;
531 $emailPage = SpecialPage
::getSafeTitleFor( 'Emailuser', $name );
532 $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getFullUrl();
534 $userPage = $editor->getUserPage();
535 $keys['$PAGEEDITOR_WIKI'] = $userPage->getFullUrl();
536 $body = strtr( $body, $keys );
537 $body = wordwrap( $body, 72 );
539 # now save this as the constant user-independent part of the message
541 $this->replyto
= $replyto;
542 $this->subject
= $subject;
547 * Compose a mail to a given user and either queue it for sending, or send it now,
548 * depending on settings.
550 * Call sendMails() to send any mails that were queued.
552 function compose( $user ) {
553 global $wgEnotifImpersonal;
555 if ( !$this->composed_common
)
556 $this->composeCommonMailtext();
558 if ( $wgEnotifImpersonal ) {
559 $this->mailTargets
[] = new MailAddress( $user );
561 $this->sendPersonalised( $user );
566 * Send any queued mails
568 function sendMails() {
569 global $wgEnotifImpersonal;
570 if ( $wgEnotifImpersonal ) {
571 $this->sendImpersonal( $this->mailTargets
);
576 * Does the per-user customizations to a notification e-mail (name,
577 * timestamp in proper timezone, etc) and sends it out.
578 * Returns true if the mail was sent successfully.
580 * @param $watchingUser User object
584 function sendPersonalised( $watchingUser ) {
585 global $wgContLang, $wgEnotifUseRealName;
586 // From the PHP manual:
587 // Note: The to parameter cannot be an address in the form of "Something <someone@example.com>".
588 // The mail command will not parse this properly while talking with the MTA.
589 $to = new MailAddress( $watchingUser );
590 $name = $wgEnotifUseRealName ?
$watchingUser->getRealName() : $watchingUser->getName();
591 $body = str_replace( '$WATCHINGUSERNAME', $name , $this->body
);
593 $timecorrection = $watchingUser->getOption( 'timecorrection' );
595 # $PAGEEDITDATE is the time and date of the page change
596 # expressed in terms of individual local time of the notification
597 # recipient, i.e. watching user
599 array( '$PAGEEDITDATEANDTIME',
602 array( $wgContLang->timeanddate( $this->timestamp
, true, false, $timecorrection ),
603 $wgContLang->date( $this->timestamp
, true, false, $timecorrection ),
604 $wgContLang->time( $this->timestamp
, true, false, $timecorrection ) ),
607 return UserMailer
::send($to, $this->from
, $this->subject
, $body, $this->replyto
);
611 * Same as sendPersonalised but does impersonal mail suitable for bulk
612 * mailing. Takes an array of MailAddress objects.
614 function sendImpersonal( $addresses ) {
617 if (empty($addresses))
621 array( '$WATCHINGUSERNAME',
623 array( wfMsgForContent('enotif_impersonal_salutation'),
624 $wgContLang->timeanddate($this->timestamp
, true, false, false)),
627 return UserMailer
::send($addresses, $this->from
, $this->subject
, $body, $this->replyto
);
630 } # end of class EmailNotification
633 * Backwards compatibility functions
635 * @deprecated Use UserMailer methods; will be removed in 1.19
637 function wfRFC822Phrase( $s ) {
638 wfDeprecated( __FUNCTION__
);
639 return UserMailer
::rfc822Phrase( $s );
642 function userMailer( $to, $from, $subject, $body, $replyto=null ) {
643 wfDeprecated( __FUNCTION__
);
644 return UserMailer
::send( $to, $from, $subject, $body, $replyto );