includes/UserMailer.php

   1 <?php
   2 /**
   3  * UserMailer.php
   4  *  Copyright (C) 2004 Thomas Gries <mail@tgries.de>
   5  * http://www.mediawiki.org/
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @author <brion@pobox.com>
  23  * @author <mail@tgries.de>
  24  *
  25  */
  26
  27 /**
  28  * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
  29  */
  30 function wfRFC822Phrase( $phrase ) {
  31         $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
  32         return '"' . $phrase . '"';
  33 }
  34
  35 /**
  36  * Stores a single person's name and email address.
  37  * These are passed in via the constructor, and will be returned in SMTP
  38  * header format when requested.
  39  */
  40 class MailAddress {
  41         /**
  42          * @param mixed $address String with an email address, or a User object
  43          * @param string $name Human-readable name if a string address is given
  44          */
  45         function __construct( $address, $name=null ) {
  46                 if( is_object( $address ) && $address instanceof User ) {
  47                         $this->address = $address->getEmail();
  48                         $this->name = $address->getName();
  49                 } else {
  50                         $this->address = strval( $address );
  51                         $this->name = strval( $name );
  52                 }
  53         }
  54
  55         /**
  56          * Return formatted and quoted address to insert into SMTP headers
  57          * @return string
  58          */
  59         function toString() {
  60                 # PHP's mail() implementation under Windows is somewhat shite, and
  61                 # can't handle "Joe Bloggs <joe@bloggs.com>" format email addresses,
  62                 # so don't bother generating them
  63                 if( $this->name != '' && !wfIsWindows() ) {
  64                         $quoted = wfQuotedPrintable( $this->name );
  65                         if( strpos( $quoted, '.' ) !== false ) {
  66                                 $quoted = '"' . $quoted . '"';
  67                         }
  68                         return "$quoted <{$this->address}>";
  69                 } else {
  70                         return $this->address;
  71                 }
  72         }
  73 }
  74
  75 function send_mail($mailer, $dest, $headers, $body)
  76 {
  77         $mailResult =& $mailer->send($dest, $headers, $body);
  78
  79         # Based on the result return an error string,
  80         if ($mailResult === true) {
  81                 return '';
  82         } elseif (is_object($mailResult)) {
  83                 wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
  84                 return $mailResult->getMessage();
  85         } else {
  86                 wfDebug( "PEAR::Mail failed, unknown error result\n" );
  87                 return 'Mail object return unknown error.';
  88         }
  89 }
  90
  91 /**
  92  * This function will perform a direct (authenticated) login to
  93  * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
  94  * array of parameters. It requires PEAR:Mail to do that.
  95  * Otherwise it just uses the standard PHP 'mail' function.
  96  *
  97  * @param $to MailAddress: recipient's email
  98  * @param $from MailAddress: sender's email
  99  * @param $subject String: email's subject.
 100  * @param $body String: email's text.
 101  * @param $replyto String: optional reply-to email (default: null).
 102  */
 103 function userMailer( $to, $from, $subject, $body, $replyto=null ) {
 104         global $wgSMTP, $wgOutputEncoding, $wgErrorString, $wgEnotifImpersonal;
 105         global $wgEnotifMaxRecips;
 106
 107         if (is_array( $wgSMTP )) {
 108                 require_once( 'Mail.php' );
 109
 110                 $msgid = str_replace(" ", "_", microtime());
 111                 if (function_exists('posix_getpid'))
 112                         $msgid .= '.' . posix_getpid();
 113
 114                 if (is_array($to)) {
 115                         $dest = array();
 116                         foreach ($to as $u)
 117                                 $dest[] = $u->address;
 118                 } else
 119                         $dest = $to->address;
 120
 121                 $headers['From'] = $from->toString();
 122
 123                 if ($wgEnotifImpersonal)
 124                         $headers['To'] = 'undisclosed-recipients:;';
 125                 else
 126                         $headers['To'] = $to->toString();
 127
 128                 if ( $replyto ) {
 129                         $headers['Reply-To'] = $replyto->toString();
 130                 }
 131                 $headers['Subject'] = wfQuotedPrintable( $subject );
 132                 $headers['Date'] = date( 'r' );
 133                 $headers['MIME-Version'] = '1.0';
 134                 $headers['Content-type'] = 'text/plain; charset='.$wgOutputEncoding;
 135                 $headers['Content-transfer-encoding'] = '8bit';
 136                 $headers['Message-ID'] = "<$msgid@" . $wgSMTP['IDHost'] . '>'; // FIXME
 137                 $headers['X-Mailer'] = 'MediaWiki mailer';
 138
 139                 // Create the mail object using the Mail::factory method
 140                 $mail_object =& Mail::factory('smtp', $wgSMTP);
 141                 if( PEAR::isError( $mail_object ) ) {
 142                         wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
 143                         return $mail_object->getMessage();
 144                 }
 145
 146                 wfDebug( "Sending mail via PEAR::Mail to $dest\n" );
 147                 if (is_array($dest)) {
 148                         $chunks = array_chunk($dest, $wgEnotifMaxRecips);
 149                         foreach ($chunks as $chunk) {
 150                                 $e = send_mail($mail_object, $chunk, $headers, $body);
 151                                 if ($e != '')
 152                                         return $e;
 153                         }
 154                 } else
 155                         return $mail_object->send($dest, $headers, $body);
 156
 157         } else  {
 158                 # In the following $headers = expression we removed "Reply-To: {$from}\r\n" , because it is treated differently
 159                 # (fifth parameter of the PHP mail function, see some lines below)
 160
 161                 # Line endings need to be different on Unix and Windows due to
 162                 # the bug described at http://trac.wordpress.org/ticket/2603
 163                 if ( wfIsWindows() ) {
 164                         $body = str_replace( "\n", "\r\n", $body );
 165                         $endl = "\r\n";
 166                 } else {
 167                         $endl = "\n";
 168                 }
 169                 $headers =
 170                         "MIME-Version: 1.0$endl" .
 171                         "Content-type: text/plain; charset={$wgOutputEncoding}$endl" .
 172                         "Content-Transfer-Encoding: 8bit$endl" .
 173                         "X-Mailer: MediaWiki mailer$endl".
 174                         'From: ' . $from->toString();
 175                 if ($replyto) {
 176                         $headers .= "{$endl}Reply-To: " . $replyto->toString();
 177                 }
 178
 179                 $wgErrorString = '';
 180                 set_error_handler( 'mailErrorHandler' );
 181                 wfDebug( "Sending mail via internal mail() function\n" );
 182
 183                 if (is_array($to))
 184                         foreach ($to as $recip)
 185                                 mail( $recip->toString(), wfQuotedPrintable( $subject ), $body, $headers );
 186                 else
 187                         mail( $to->toString(), wfQuotedPrintable( $subject ), $body, $headers );
 188
 189                 restore_error_handler();
 190
 191                 if ( $wgErrorString ) {
 192                         wfDebug( "Error sending mail: $wgErrorString\n" );
 193                 }
 194                 return $wgErrorString;
 195         }
 196 }
 197
 198 /**
 199  * Get the mail error message in global $wgErrorString
 200  *
 201  * @param $code Integer: error number
 202  * @param $string String: error message
 203  */
 204 function mailErrorHandler( $code, $string ) {
 205         global $wgErrorString;
 206         $wgErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
 207 }
 208
 209
 210 /**
 211  * This module processes the email notifications when the current page is
 212  * changed. It looks up the table watchlist to find out which users are watching
 213  * that page.
 214  *
 215  * The current implementation sends independent emails to each watching user for
 216  * the following reason:
 217  *
 218  * - Each watching user will be notified about the page edit time expressed in
 219  * his/her local time (UTC is shown additionally). To achieve this, we need to
 220  * find the individual timeoffset of each watching user from the preferences..
 221  *
 222  * Suggested improvement to slack down the number of sent emails: We could think
 223  * of sending out bulk mails (bcc:user1,user2...) for all these users having the
 224  * same timeoffset in their preferences.
 225  *
 226  * Visit the documentation pages under http://meta.wikipedia.com/Enotif
 227  *
 228  *
 229  */
 230 class EmailNotification {
 231         /**@{{
 232          * @private
 233          */
 234         var $to, $subject, $body, $replyto, $from;
 235         var $user, $title, $timestamp, $summary, $minorEdit, $oldid;
 236
 237         /**@}}*/
 238
 239         function notifyOnPageChange($editor, &$title, $timestamp, $summary, $minorEdit, $oldid = false) {
 240                 global $wgEnotifUseJobQ;
 241                 global $wgEnotifWatchlist, $wgShowUpdatedMarker;
 242
 243                 if ($wgEnotifUseJobQ) {
 244                         $params = array(
 245                                 "editor" => $editor->getName(),
 246                                 "timestamp" => $timestamp,
 247                                 "summary" => $summary,
 248                                 "minorEdit" => $minorEdit,
 249                                 "oldid" => $oldid);
 250                         $job = new EnotifNotifyJob($title, $params);
 251                         $job->insert();
 252                 } else {
 253                         $this->actuallyNotifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid);
 254                 }
 255
 256         }
 257
 258         /**
 259          * @todo document
 260          * @param $title Title object
 261          * @param $timestamp
 262          * @param $summary
 263          * @param $minorEdit
 264          * @param $oldid (default: false)
 265          */
 266         function actuallyNotifyOnPageChange($editor, &$title, $timestamp, $summary, $minorEdit, $oldid=false) {
 267
 268                 # we use $wgEmergencyContact as sender's address
 269                 global $wgEnotifWatchlist;
 270                 global $wgEnotifMinorEdits, $wgEnotifUserTalk, $wgShowUpdatedMarker;
 271                 global $wgEnotifImpersonal;
 272
 273                 $fname = 'UserMailer::notifyOnPageChange';
 274                 wfProfileIn( $fname );
 275
 276                 # The following code is only run, if several conditions are met:
 277                 # 1. EmailNotification for pages (other than user_talk pages) must be enabled
 278                 # 2. minor edits (changes) are only regarded if the global flag indicates so
 279
 280                 $isUserTalkPage = ($title->getNamespace() == NS_USER_TALK);
 281                 $enotifusertalkpage = ($isUserTalkPage && $wgEnotifUserTalk);
 282                 $enotifwatchlistpage = $wgEnotifWatchlist;
 283
 284                 $this->title =& $title;
 285                 $this->timestamp = $timestamp;
 286                 $this->summary = $summary;
 287                 $this->minorEdit = $minorEdit;
 288                 $this->oldid = $oldid;
 289                 $this->composeCommonMailtext($editor);
 290
 291                 $impersonals = array();
 292
 293                 if ( (!$minorEdit || $wgEnotifMinorEdits) ) {
 294                         if( $wgEnotifWatchlist ) {
 295                                 // Send updates to watchers other than the current editor
 296                                 $userCondition = 'wl_user <> ' . intval( $editor->getId() );
 297                         } elseif( $wgEnotifUserTalk && $title->getNamespace() == NS_USER_TALK ) {
 298                                 $targetUser = User::newFromName( $title->getText() );
 299                                 if( is_null( $targetUser ) ) {
 300                                         wfDebug( "$fname: user-talk-only mode; no such user\n" );
 301                                         $userCondition = false;
 302                                 } elseif( $targetUser->getId() == $editor->getId() ) {
 303                                         wfDebug( "$fname: user-talk-only mode; editor is target user\n" );
 304                                         $userCondition = false;
 305                                 } else {
 306                                         // Don't notify anyone other than the owner of the talk page
 307                                         $userCondition = 'wl_user = ' . intval( $targetUser->getId() );
 308                                 }
 309                         } else {
 310                                 // Notifications disabled
 311                                 $userCondition = false;
 312                         }
 313                         if( $userCondition ) {
 314                                 $dbr = wfGetDB( DB_MASTER );
 315
 316                                 $res = $dbr->select( 'watchlist', array( 'wl_user' ),
 317                                         array(
 318                                                 'wl_title' => $title->getDBkey(),
 319                                                 'wl_namespace' => $title->getNamespace(),
 320                                                 $userCondition,
 321                                                 'wl_notificationtimestamp IS NULL',
 322                                         ), $fname );
 323
 324                                 # if anyone is watching ... set up the email message text which is
 325                                 # common for all receipients ...
 326                                 if ( $dbr->numRows( $res ) > 0 ) {
 327
 328                                         $watchingUser = new User();
 329
 330                                         # ... now do for all watching users ... if the options fit
 331                                         for ($i = 1; $i <= $dbr->numRows( $res ); $i++) {
 332
 333                                                 $wuser = $dbr->fetchObject( $res );
 334                                                 $watchingUser->setID($wuser->wl_user);
 335
 336                                                 if ( ( $enotifwatchlistpage && $watchingUser->getOption('enotifwatchlistpages') ) ||
 337                                                         ( $enotifusertalkpage
 338                                                                 && $watchingUser->getOption('enotifusertalkpages')
 339                                                                 && $title->equals( $watchingUser->getTalkPage() ) )
 340                                                 && (!$minorEdit || ($wgEnotifMinorEdits && $watchingUser->getOption('enotifminoredits') ) )
 341                                                 && ($watchingUser->isEmailConfirmed() ) ) {
 342                                                         # ... adjust remaining text and page edit time placeholders
 343                                                         # which needs to be personalized for each user
 344                                                         if ($wgEnotifImpersonal)
 345                                                                 $impersonals[] = $watchingUser;
 346                                                         else
 347                                                                 $this->composeAndSendPersonalisedMail( $watchingUser );
 348
 349                                                 } # if the watching user has an email address in the preferences
 350                                         }
 351                                 }
 352                         } # if anyone is watching
 353                 } # if $wgEnotifWatchlist = true
 354
 355                 global $wgUsersNotifedOnAllChanges;
 356                 foreach ( $wgUsersNotifedOnAllChanges as $name ) {
 357                         $user = User::newFromName( $name );
 358                         if ($wgEnotifImpersonal)
 359                                 $impersonals[] = $user;
 360                         else
 361                                 $this->composeAndSendPersonalisedMail( $user );
 362                 }
 363
 364                 $this->composeAndSendImpersonalMail($impersonals);
 365
 366                 if ( $wgShowUpdatedMarker || $wgEnotifWatchlist ) {
 367                         # mark the changed watch-listed page with a timestamp, so that the page is
 368                         # listed with an "updated since your last visit" icon in the watch list, ...
 369                         $dbw = wfGetDB( DB_MASTER );
 370                         $success = $dbw->update( 'watchlist',
 371                                 array( /* SET */
 372                                         'wl_notificationtimestamp' => $dbw->timestamp($timestamp)
 373                                 ), array( /* WHERE */
 374                                         'wl_title' => $title->getDBkey(),
 375                                         'wl_namespace' => $title->getNamespace(),
 376                                 ), 'UserMailer::NotifyOnChange'
 377                         );
 378                         # FIXME what do we do on failure ?
 379                 }
 380
 381                 wfProfileOut( $fname );
 382         } # function NotifyOnChange
 383
 384         /**
 385          * @private
 386          */
 387         function composeCommonMailtext($editor) {
 388                 global $wgEmergencyContact, $wgNoReplyAddress;
 389                 global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
 390                 global $wgEnotifImpersonal;
 391
 392                 $summary = ($this->summary == '') ? ' - ' : $this->summary;
 393                 $medit   = ($this->minorEdit) ? wfMsg( 'minoredit' ) : '';
 394
 395                 # You as the WikiAdmin and Sysops can make use of plenty of
 396                 # named variables when composing your notification emails while
 397                 # simply editing the Meta pages
 398
 399                 $subject = wfMsgForContent( 'enotif_subject' );
 400                 $body    = wfMsgForContent( 'enotif_body' );
 401                 $from    = ''; /* fail safe */
 402                 $replyto = ''; /* fail safe */
 403                 $keys    = array();
 404
 405                 # regarding the use of oldid as an indicator for the last visited version, see also
 406                 # http://bugzilla.wikipeda.org/show_bug.cgi?id=603 "Delete + undelete cycle doesn't preserve old_id"
 407                 # However, in the case of a new page which is already watched, we have no previous version to compare
 408                 if( $this->oldid ) {
 409                         $difflink = $this->title->getFullUrl( 'diff=0&oldid=' . $this->oldid );
 410                         $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited', $difflink );
 411                         $keys['$OLDID']   = $this->oldid;
 412                         $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
 413                 } else {
 414                         $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
 415                         # clear $OLDID placeholder in the message template
 416                         $keys['$OLDID']   = '';
 417                         $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
 418                 }
 419
 420                 if ($wgEnotifImpersonal && $this->oldid)
 421                         /*
 422                          * For impersonal mail, show a diff link to the last
 423                          * revision.
 424                          */
 425                         $keys['$NEWPAGE'] = wfMsgForContent('enotif_lastdiff',
 426                                         $this->title->getFullURL("oldid={$this->oldid}&diff=prev"));
 427
 428                 $body = strtr( $body, $keys );
 429                 $pagetitle = $this->title->getPrefixedText();
 430                 $keys['$PAGETITLE']          = $pagetitle;
 431                 $keys['$PAGETITLE_URL']      = $this->title->getFullUrl();
 432
 433                 $keys['$PAGEMINOREDIT']      = $medit;
 434                 $keys['$PAGESUMMARY']        = $summary;
 435
 436                 $subject = strtr( $subject, $keys );
 437
 438                 # Reveal the page editor's address as REPLY-TO address only if
 439                 # the user has not opted-out and the option is enabled at the
 440                 # global configuration level.
 441                 $name    = $editor->getName();
 442                 $adminAddress = new MailAddress( $wgEmergencyContact, 'WikiAdmin' );
 443                 $editorAddress = new MailAddress( $editor );
 444                 if( $wgEnotifRevealEditorAddress
 445                     && ( $editor->getEmail() != '' )
 446                     && $editor->getOption( 'enotifrevealaddr' ) ) {
 447                         if( $wgEnotifFromEditor ) {
 448                                 $from    = $editorAddress;
 449                         } else {
 450                                 $from    = $adminAddress;
 451                                 $replyto = $editorAddress;
 452                         }
 453                 } else {
 454                         $from    = $adminAddress;
 455                         $replyto = new MailAddress( $wgNoReplyAddress );
 456                 }
 457
 458                 if( $editor->isIP( $name ) ) {
 459                         #real anon (user:xxx.xxx.xxx.xxx)
 460                         $utext = wfMsgForContent('enotif_anon_editor', $name);
 461                         $subject = str_replace('$PAGEEDITOR', $utext, $subject);
 462                         $keys['$PAGEEDITOR']       = $utext;
 463                         $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
 464                 } else {
 465                         $subject = str_replace('$PAGEEDITOR', $name, $subject);
 466                         $keys['$PAGEEDITOR']          = $name;
 467                         $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $name );
 468                         $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getFullUrl();
 469                 }
 470                 $userPage = $editor->getUserPage();
 471                 $keys['$PAGEEDITOR_WIKI'] = $userPage->getFullUrl();
 472                 $body = strtr( $body, $keys );
 473                 $body = wordwrap( $body, 72 );
 474
 475                 # now save this as the constant user-independent part of the message
 476                 $this->from    = $from;
 477                 $this->replyto = $replyto;
 478                 $this->subject = $subject;
 479                 $this->body    = $body;
 480         }
 481
 482         /**
 483          * Does the per-user customizations to a notification e-mail (name,
 484          * timestamp in proper timezone, etc) and sends it out.
 485          * Returns true if the mail was sent successfully.
 486          *
 487          * @param User $watchingUser
 488          * @param object $mail
 489          * @return bool
 490          * @private
 491          */
 492         function composeAndSendPersonalisedMail( $watchingUser ) {
 493                 global $wgLang;
 494                 // From the PHP manual:
 495                 //     Note:  The to parameter cannot be an address in the form of "Something <someone@example.com>".
 496                 //     The mail command will not parse this properly while talking with the MTA.
 497                 $to = new MailAddress( $watchingUser );
 498                 $body = str_replace( '$WATCHINGUSERNAME', $watchingUser->getName() , $this->body );
 499
 500                 $timecorrection = $watchingUser->getOption( 'timecorrection' );
 501
 502                 # $PAGEEDITDATE is the time and date of the page change
 503                 # expressed in terms of individual local time of the notification
 504                 # recipient, i.e. watching user
 505                 $body = str_replace('$PAGEEDITDATE',
 506                         $wgLang->timeanddate( $this->timestamp, true, false, $timecorrection ),
 507                         $body);
 508
 509                 return userMailer($to, $this->from, $this->subject, $body, $this->replyto);
 510         }
 511
 512         /**
 513          * Same as composeAndSendPersonalisedMail but does impersonal mail
 514          * suitable for bulk mailing.  Takes an array of users.
 515          */
 516         function composeAndSendImpersonalMail($users) {
 517                 global $wgLang;
 518
 519                 if (empty($users))
 520                         return;
 521
 522                 $to = array();
 523                 foreach ($users as $user)
 524                         $to[] = new MailAddress($user);
 525
 526                 $body = str_replace(
 527                                 array(  '$WATCHINGUSERNAME',
 528                                         '$PAGEEDITDATE'),
 529                                 array(  wfMsgForContent('enotif_impersonal_salutation'),
 530                                         $wgLang->timeanddate($this->timestamp, true, false, false)),
 531                                 $this->body);
 532
 533                 return userMailer($to, $this->from, $this->subject, $body, $this->replyto);
 534         }
 535
 536 } # end of class EmailNotification
 537 ?>