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 (function_exists('mail'))
 184                         if (is_array($to))
 185                                 foreach ($to as $recip)
 186                                         $sent = mail( $recip->toString(), wfQuotedPrintable( $subject ), $body, $headers );
 187                         else
 188                                 $sent = mail( $to->toString(), wfQuotedPrintable( $subject ), $body, $headers );
 189                 else
 190                         $wgErrorString = 'PHP is not configured to send mail';
 191
 192
 193                 restore_error_handler();
 194
 195                 if ( $wgErrorString ) {
 196                         wfDebug( "Error sending mail: $wgErrorString\n" );
 197                         return $wgErrorString;
 198                 } elseif (! $sent) {
 199                         //mail function only tells if there's an error
 200                         wfDebug( "Error sending mail\n" );
 201                         return 'mailer error';
 202                 } else {
 203                         return '';
 204                 }
 205         }
 206 }
 207
 208
 209
 210 /**
 211  * Get the mail error message in global $wgErrorString
 212  *
 213  * @param $code Integer: error number
 214  * @param $string String: error message
 215  */
 216 function mailErrorHandler( $code, $string ) {
 217         global $wgErrorString;
 218         $wgErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
 219 }
 220
 221
 222 /**
 223  * This module processes the email notifications when the current page is
 224  * changed. It looks up the table watchlist to find out which users are watching
 225  * that page.
 226  *
 227  * The current implementation sends independent emails to each watching user for
 228  * the following reason:
 229  *
 230  * - Each watching user will be notified about the page edit time expressed in
 231  * his/her local time (UTC is shown additionally). To achieve this, we need to
 232  * find the individual timeoffset of each watching user from the preferences..
 233  *
 234  * Suggested improvement to slack down the number of sent emails: We could think
 235  * of sending out bulk mails (bcc:user1,user2...) for all these users having the
 236  * same timeoffset in their preferences.
 237  *
 238  * Visit the documentation pages under http://meta.wikipedia.com/Enotif
 239  *
 240  *
 241  */
 242 class EmailNotification {
 243         /**@{{
 244          * @private
 245          */
 246         var $to, $subject, $body, $replyto, $from;
 247         var $user, $title, $timestamp, $summary, $minorEdit, $oldid;
 248
 249         /**@}}*/
 250
 251         function notifyOnPageChange($editor, &$title, $timestamp, $summary, $minorEdit, $oldid = false) {
 252                 global $wgEnotifUseJobQ;
 253
 254                 if( $title->getNamespace() < 0 )
 255                         return;
 256
 257                 if ($wgEnotifUseJobQ) {
 258                         $params = array(
 259                                 "editor" => $editor->getName(),
 260                                 "timestamp" => $timestamp,
 261                                 "summary" => $summary,
 262                                 "minorEdit" => $minorEdit,
 263                                 "oldid" => $oldid);
 264                         $job = new EnotifNotifyJob( $title, $params );
 265                         $job->insert();
 266                 } else {
 267                         $this->actuallyNotifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid);
 268                 }
 269
 270         }
 271
 272         /**
 273          * @todo document
 274          * @param $title Title object
 275          * @param $timestamp
 276          * @param $summary
 277          * @param $minorEdit
 278          * @param $oldid (default: false)
 279          */
 280         function actuallyNotifyOnPageChange($editor, &$title, $timestamp, $summary, $minorEdit, $oldid=false) {
 281
 282                 # we use $wgEmergencyContact as sender's address
 283                 global $wgEnotifWatchlist;
 284                 global $wgEnotifMinorEdits, $wgEnotifUserTalk, $wgShowUpdatedMarker;
 285                 global $wgEnotifImpersonal;
 286
 287                 $fname = 'UserMailer::notifyOnPageChange';
 288                 wfProfileIn( $fname );
 289
 290                 # The following code is only run, if several conditions are met:
 291                 # 1. EmailNotification for pages (other than user_talk pages) must be enabled
 292                 # 2. minor edits (changes) are only regarded if the global flag indicates so
 293
 294                 $isUserTalkPage = ($title->getNamespace() == NS_USER_TALK);
 295                 $enotifusertalkpage = ($isUserTalkPage && $wgEnotifUserTalk);
 296                 $enotifwatchlistpage = $wgEnotifWatchlist;
 297
 298                 $this->title =& $title;
 299                 $this->timestamp = $timestamp;
 300                 $this->summary = $summary;
 301                 $this->minorEdit = $minorEdit;
 302                 $this->oldid = $oldid;
 303                 $this->composeCommonMailtext($editor);
 304
 305                 $impersonals = array();
 306
 307                 if ( (!$minorEdit || $wgEnotifMinorEdits) ) {
 308                         if( $wgEnotifWatchlist ) {
 309                                 // Send updates to watchers other than the current editor
 310                                 $userCondition = 'wl_user <> ' . intval( $editor->getId() );
 311                         } elseif( $wgEnotifUserTalk && $title->getNamespace() == NS_USER_TALK ) {
 312                                 $targetUser = User::newFromName( $title->getText() );
 313                                 if( is_null( $targetUser ) ) {
 314                                         wfDebug( "$fname: user-talk-only mode; no such user\n" );
 315                                         $userCondition = false;
 316                                 } elseif( $targetUser->getId() == $editor->getId() ) {
 317                                         wfDebug( "$fname: user-talk-only mode; editor is target user\n" );
 318                                         $userCondition = false;
 319                                 } else {
 320                                         // Don't notify anyone other than the owner of the talk page
 321                                         $userCondition = 'wl_user = ' . intval( $targetUser->getId() );
 322                                 }
 323                         } else {
 324                                 // Notifications disabled
 325                                 $userCondition = false;
 326                         }
 327                         if( $userCondition ) {
 328                                 $dbr = wfGetDB( DB_MASTER );
 329
 330                                 $res = $dbr->select( 'watchlist', array( 'wl_user' ),
 331                                         array(
 332                                                 'wl_title' => $title->getDBkey(),
 333                                                 'wl_namespace' => $title->getNamespace(),
 334                                                 $userCondition,
 335                                                 'wl_notificationtimestamp IS NULL',
 336                                         ), $fname );
 337
 338                                 # if anyone is watching ... set up the email message text which is
 339                                 # common for all receipients ...
 340                                 if ( $dbr->numRows( $res ) > 0 ) {
 341
 342                                         $watchingUser = new User();
 343
 344                                         # ... now do for all watching users ... if the options fit
 345                                         for ($i = 1; $i <= $dbr->numRows( $res ); $i++) {
 346
 347                                                 $wuser = $dbr->fetchObject( $res );
 348                                                 $watchingUser->setID($wuser->wl_user);
 349
 350                                                 if ( ( $enotifwatchlistpage && $watchingUser->getOption('enotifwatchlistpages') ) ||
 351                                                         ( $enotifusertalkpage
 352                                                                 && $watchingUser->getOption('enotifusertalkpages')
 353                                                                 && $title->equals( $watchingUser->getTalkPage() ) )
 354                                                 && (!$minorEdit || ($wgEnotifMinorEdits && $watchingUser->getOption('enotifminoredits') ) )
 355                                                 && ($watchingUser->isEmailConfirmed() ) ) {
 356                                                         # ... adjust remaining text and page edit time placeholders
 357                                                         # which needs to be personalized for each user
 358                                                         if ($wgEnotifImpersonal)
 359                                                                 $impersonals[] = $watchingUser;
 360                                                         else
 361                                                                 $this->composeAndSendPersonalisedMail( $watchingUser );
 362
 363                                                 } # if the watching user has an email address in the preferences
 364                                         }
 365                                 }
 366                         } # if anyone is watching
 367                 } # if $wgEnotifWatchlist = true
 368
 369                 global $wgUsersNotifedOnAllChanges;
 370                 foreach ( $wgUsersNotifedOnAllChanges as $name ) {
 371                         $user = User::newFromName( $name );
 372                         if ($wgEnotifImpersonal)
 373                                 $impersonals[] = $user;
 374                         else
 375                                 $this->composeAndSendPersonalisedMail( $user );
 376                 }
 377
 378                 $this->composeAndSendImpersonalMail($impersonals);
 379
 380                 if ( $wgShowUpdatedMarker || $wgEnotifWatchlist ) {
 381                         # mark the changed watch-listed page with a timestamp, so that the page is
 382                         # listed with an "updated since your last visit" icon in the watch list, ...
 383                         $dbw = wfGetDB( DB_MASTER );
 384                         $success = $dbw->update( 'watchlist',
 385                                 array( /* SET */
 386                                         'wl_notificationtimestamp' => $dbw->timestamp($timestamp)
 387                                 ), array( /* WHERE */
 388                                         'wl_title' => $title->getDBkey(),
 389                                         'wl_namespace' => $title->getNamespace(),
 390                                         'wl_notificationtimestamp IS NULL'
 391                                 ), 'UserMailer::NotifyOnChange'
 392                         );
 393                         # FIXME what do we do on failure ?
 394                 }
 395
 396                 wfProfileOut( $fname );
 397         } # function NotifyOnChange
 398
 399         /**
 400          * @private
 401          */
 402         function composeCommonMailtext($editor) {
 403                 global $wgEmergencyContact, $wgNoReplyAddress;
 404                 global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
 405                 global $wgEnotifImpersonal;
 406
 407                 $summary = ($this->summary == '') ? ' - ' : $this->summary;
 408                 $medit   = ($this->minorEdit) ? wfMsg( 'minoredit' ) : '';
 409
 410                 # You as the WikiAdmin and Sysops can make use of plenty of
 411                 # named variables when composing your notification emails while
 412                 # simply editing the Meta pages
 413
 414                 $subject = wfMsgForContent( 'enotif_subject' );
 415                 $body    = wfMsgForContent( 'enotif_body' );
 416                 $from    = ''; /* fail safe */
 417                 $replyto = ''; /* fail safe */
 418                 $keys    = array();
 419
 420                 # regarding the use of oldid as an indicator for the last visited version, see also
 421                 # http://bugzilla.wikipeda.org/show_bug.cgi?id=603 "Delete + undelete cycle doesn't preserve old_id"
 422                 # However, in the case of a new page which is already watched, we have no previous version to compare
 423                 if( $this->oldid ) {
 424                         $difflink = $this->title->getFullUrl( 'diff=0&oldid=' . $this->oldid );
 425                         $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited', $difflink );
 426                         $keys['$OLDID']   = $this->oldid;
 427                         $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
 428                 } else {
 429                         $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
 430                         # clear $OLDID placeholder in the message template
 431                         $keys['$OLDID']   = '';
 432                         $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
 433                 }
 434
 435                 if ($wgEnotifImpersonal && $this->oldid)
 436                         /*
 437                          * For impersonal mail, show a diff link to the last
 438                          * revision.
 439                          */
 440                         $keys['$NEWPAGE'] = wfMsgForContent('enotif_lastdiff',
 441                                         $this->title->getFullURL("oldid={$this->oldid}&diff=prev"));
 442
 443                 $body = strtr( $body, $keys );
 444                 $pagetitle = $this->title->getPrefixedText();
 445                 $keys['$PAGETITLE']          = $pagetitle;
 446                 $keys['$PAGETITLE_URL']      = $this->title->getFullUrl();
 447
 448                 $keys['$PAGEMINOREDIT']      = $medit;
 449                 $keys['$PAGESUMMARY']        = $summary;
 450
 451                 $subject = strtr( $subject, $keys );
 452
 453                 # Reveal the page editor's address as REPLY-TO address only if
 454                 # the user has not opted-out and the option is enabled at the
 455                 # global configuration level.
 456                 $name    = $editor->getName();
 457                 $adminAddress = new MailAddress( $wgEmergencyContact, 'WikiAdmin' );
 458                 $editorAddress = new MailAddress( $editor );
 459                 if( $wgEnotifRevealEditorAddress
 460                     && ( $editor->getEmail() != '' )
 461                     && $editor->getOption( 'enotifrevealaddr' ) ) {
 462                         if( $wgEnotifFromEditor ) {
 463                                 $from    = $editorAddress;
 464                         } else {
 465                                 $from    = $adminAddress;
 466                                 $replyto = $editorAddress;
 467                         }
 468                 } else {
 469                         $from    = $adminAddress;
 470                         $replyto = new MailAddress( $wgNoReplyAddress );
 471                 }
 472
 473                 if( $editor->isIP( $name ) ) {
 474                         #real anon (user:xxx.xxx.xxx.xxx)
 475                         $utext = wfMsgForContent('enotif_anon_editor', $name);
 476                         $subject = str_replace('$PAGEEDITOR', $utext, $subject);
 477                         $keys['$PAGEEDITOR']       = $utext;
 478                         $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
 479                 } else {
 480                         $subject = str_replace('$PAGEEDITOR', $name, $subject);
 481                         $keys['$PAGEEDITOR']          = $name;
 482                         $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $name );
 483                         $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getFullUrl();
 484                 }
 485                 $userPage = $editor->getUserPage();
 486                 $keys['$PAGEEDITOR_WIKI'] = $userPage->getFullUrl();
 487                 $body = strtr( $body, $keys );
 488                 $body = wordwrap( $body, 72 );
 489
 490                 # now save this as the constant user-independent part of the message
 491                 $this->from    = $from;
 492                 $this->replyto = $replyto;
 493                 $this->subject = $subject;
 494                 $this->body    = $body;
 495         }
 496
 497         /**
 498          * Does the per-user customizations to a notification e-mail (name,
 499          * timestamp in proper timezone, etc) and sends it out.
 500          * Returns true if the mail was sent successfully.
 501          *
 502          * @param User $watchingUser
 503          * @param object $mail
 504          * @return bool
 505          * @private
 506          */
 507         function composeAndSendPersonalisedMail( $watchingUser ) {
 508                 global $wgLang;
 509                 // From the PHP manual:
 510                 //     Note:  The to parameter cannot be an address in the form of "Something <someone@example.com>".
 511                 //     The mail command will not parse this properly while talking with the MTA.
 512                 $to = new MailAddress( $watchingUser );
 513                 $body = str_replace( '$WATCHINGUSERNAME', $watchingUser->getName() , $this->body );
 514
 515                 $timecorrection = $watchingUser->getOption( 'timecorrection' );
 516
 517                 # $PAGEEDITDATE is the time and date of the page change
 518                 # expressed in terms of individual local time of the notification
 519                 # recipient, i.e. watching user
 520                 $body = str_replace('$PAGEEDITDATE',
 521                         $wgLang->timeanddate( $this->timestamp, true, false, $timecorrection ),
 522                         $body);
 523
 524                 return userMailer($to, $this->from, $this->subject, $body, $this->replyto);
 525         }
 526
 527         /**
 528          * Same as composeAndSendPersonalisedMail but does impersonal mail
 529          * suitable for bulk mailing.  Takes an array of users.
 530          */
 531         function composeAndSendImpersonalMail($users) {
 532                 global $wgLang;
 533
 534                 if (empty($users))
 535                         return;
 536
 537                 $to = array();
 538                 foreach ($users as $user)
 539                         $to[] = new MailAddress($user);
 540
 541                 $body = str_replace(
 542                                 array(  '$WATCHINGUSERNAME',
 543                                         '$PAGEEDITDATE'),
 544                                 array(  wfMsgForContent('enotif_impersonal_salutation'),
 545                                         $wgLang->timeanddate($this->timestamp, true, false, false)),
 546                                 $this->body);
 547
 548                 return userMailer($to, $this->from, $this->subject, $body, $this->replyto);
 549         }
 550
 551 } # end of class EmailNotification
 552