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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @author <brion@pobox.com>
  23  * @author <mail@tgries.de>
  24  *
  25  * @package MediaWiki
  26  */
  27
  28 require_once( 'WikiError.php' );
  29
  30 /**
  31  * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
  32  */
  33 function wfRFC822Phrase( $phrase ) {
  34         $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
  35         return '"' . $phrase . '"';
  36 }
  37
  38 /**
  39  * This function will perform a direct (authenticated) login to
  40  * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
  41  * array of parameters. It requires PEAR:Mail to do that.
  42  * Otherwise it just uses the standard PHP 'mail' function.
  43  *
  44  * @param string $to recipient's email
  45  * @param string $from sender's email
  46  * @param string $subject email's subject
  47  * @param string $body email's text
  48  * @param string $replyto optional reply-to email (default : false)
  49  */
  50 function userMailer( $to, $from, $subject, $body, $replyto=false ) {
  51         global $wgUser, $wgSMTP, $wgOutputEncoding, $wgErrorString;
  52
  53         if (is_array( $wgSMTP )) {
  54                 require_once( 'Mail.php' );
  55
  56                 $timestamp = time();
  57
  58                 $headers['From'] = $from;
  59                 if ( $replyto ) {
  60                         $headers['Reply-To'] = $replyto;
  61                 }
  62                 $headers['Subject'] = $subject;
  63                 $headers['MIME-Version'] = '1.0';
  64                 $headers['Content-type'] = 'text/plain; charset='.$wgOutputEncoding;
  65                 $headers['Content-transfer-encoding'] = '8bit';
  66                 $headers['Message-ID'] = "<{$timestamp}" . $wgUser->getName() . '@' . $wgSMTP['IDHost'] . '>';
  67                 $headers['X-Mailer'] = 'MediaWiki mailer';
  68
  69                 // Create the mail object using the Mail::factory method
  70                 $mail_object =& Mail::factory('smtp', $wgSMTP);
  71                 wfDebug( "Sending mail via PEAR::Mail to $to\n" );
  72                 $mailResult =& $mail_object->send($to, $headers, $body);
  73
  74                 # Based on the result return an error string,
  75                 if ($mailResult === true) {
  76                         return '';
  77                 } elseif (is_object($mailResult)) {
  78                         return $mailResult->getMessage();
  79                 } else {
  80                         return 'Mail object return unknown error.';
  81                 }
  82         } else  {
  83                 # In the following $headers = expression we removed "Reply-To: {$from}\r\n" , because it is treated differently
  84                 # (fifth parameter of the PHP mail function, see some lines below)
  85                 $headers =
  86                         "MIME-Version: 1.0\n" .
  87                         "Content-type: text/plain; charset={$wgOutputEncoding}\n" .
  88                         "Content-Transfer-Encoding: 8bit\n" .
  89                         "X-Mailer: MediaWiki mailer\n".
  90                         'From: ' . $from . "\n";
  91                 if ($replyto) {
  92                         $headers .= "Reply-To: $replyto\n";
  93                 }
  94
  95                 $wgErrorString = '';
  96                 set_error_handler( 'mailErrorHandler' );
  97                 wfDebug( "Sending mail via internal mail() function to $to\n" );
  98                 mail( $to, $subject, $body, $headers );
  99                 restore_error_handler();
 100
 101                 if ( $wgErrorString ) {
 102                         wfDebug( "Error sending mail: $wgErrorString\n" );
 103                 }
 104                 return $wgErrorString;
 105         }
 106 }
 107
 108 /**
 109  * Get the mail error message in global $wgErrorString
 110  *
 111  * @parameter $code error number
 112  * @parameter $string error message
 113  */
 114 function mailErrorHandler( $code, $string ) {
 115         global $wgErrorString;
 116         $wgErrorString = preg_replace( "/^mail\(\): /", '', $string );
 117 }
 118
 119
 120 /**
 121  * This module processes the email notifications when the current page is
 122  * changed. It looks up the table watchlist to find out which users are watching
 123  * that page.
 124  *
 125  * The current implementation sends independent emails to each watching user for
 126  * the following reason:
 127  *
 128  * - Each watching user will be notified about the page edit time expressed in
 129  * his/her local time (UTC is shown additionally). To achieve this, we need to
 130  * find the individual timeoffset of each watching user from the preferences..
 131  *
 132  * Suggested improvement to slack down the number of sent emails: We could think
 133  * of sending out bulk mails (bcc:user1,user2...) for all these users having the
 134  * same timeoffset in their preferences.
 135  *
 136  * Visit the documentation pages under http://meta.wikipedia.com/Enotif
 137  *
 138  * @package MediaWiki
 139  *
 140  */
 141 class EmailNotification {
 142         /**#@+
 143          * @access private
 144          */
 145         var $to, $subject, $body, $replyto, $from;
 146         var $user, $title, $timestamp, $summary, $minorEdit, $oldid;
 147
 148         /**#@-*/
 149
 150         /**
 151          * @todo document
 152          * @param $currentPage
 153          * @param $currentNs
 154          * @param $timestamp
 155          * @param $currentSummary
 156          * @param $currentMinorEdit
 157          * @param $oldid (default: false)
 158          */
 159         function notifyOnPageChange(&$title, $timestamp, $summary, $minorEdit, $oldid=false) {
 160
 161                 # we use $wgEmergencyContact as sender's address
 162                 global $wgUser, $wgEnotifWatchlist;
 163                 global $wgEnotifMinorEdits, $wgEnotifUserTalk, $wgShowUpdatedMarker;
 164
 165                 $fname = 'UserMailer::notifyOnPageChange';
 166                 wfProfileIn( $fname );
 167
 168                 # The following code is only run, if several conditions are met:
 169                 # 1. EmailNotification for pages (other than user_talk pages) must be enabled
 170                 # 2. minor edits (changes) are only regarded if the global flag indicates so
 171
 172                 $isUserTalkPage = ($title->getNamespace() == NS_USER_TALK);
 173                 $enotifusertalkpage = ($isUserTalkPage && $wgEnotifUserTalk);
 174                 $enotifwatchlistpage = $wgEnotifWatchlist;
 175
 176                 if ( (!$minorEdit || $wgEnotifMinorEdits) ) {
 177                         if( $wgEnotifWatchlist ) {
 178                                 // Send updates to watchers other than the current editor
 179                                 $userCondition = 'wl_user <> ' . intval( $wgUser->getId() );
 180                         } elseif( $wgEnotifUserTalk && $title->getNamespace() == NS_USER_TALK ) {
 181                                 $targetUser = User::newFromName( $title->getText() );
 182                                 if( is_null( $targetUser ) ) {
 183                                         wfDebug( "$fname: user-talk-only mode; no such user\n" );
 184                                         $userCondition = false;
 185                                 } elseif( $targetUser->getId() == $wgUser->getId() ) {
 186                                         wfDebug( "$fname: user-talk-only mode; editor is target user\n" );
 187                                         $userCondition = false;
 188                                 } else {
 189                                         // Don't notify anyone other than the owner of the talk page
 190                                         $userCondition = 'wl_user = ' . intval( $targetUser->getId() );
 191                                 }
 192                         } else {
 193                                 // Notifications disabled
 194                                 $userCondition = false;
 195                         }
 196                         if( $userCondition ) {
 197                                 $dbr =& wfGetDB( DB_MASTER );
 198                                 extract( $dbr->tableNames( 'watchlist' ) );
 199
 200                                 $res = $dbr->select( 'watchlist', array( 'wl_user' ),
 201                                         array(
 202                                                 'wl_title' => $title->getDBkey(),
 203                                                 'wl_namespace' => $title->getNamespace(),
 204                                                 $userCondition,
 205                                                 'wl_notificationtimestamp IS NULL',
 206                                         ), $fname );
 207
 208                                 # if anyone is watching ... set up the email message text which is
 209                                 # common for all receipients ...
 210                                 if ( $dbr->numRows( $res ) > 0 ) {
 211                                         $this->title =& $title;
 212                                         $this->timestamp = $timestamp;
 213                                         $this->summary = $summary;
 214                                         $this->minorEdit = $minorEdit;
 215                                         $this->oldid = $oldid;
 216
 217                                         $this->composeCommonMailtext();
 218                                         $watchingUser = new User();
 219
 220                                         # ... now do for all watching users ... if the options fit
 221                                         for ($i = 1; $i <= $dbr->numRows( $res ); $i++) {
 222
 223                                                 $wuser = $dbr->fetchObject( $res );
 224                                                 $watchingUser->setID($wuser->wl_user);
 225                                                 if ( ( $enotifwatchlistpage && $watchingUser->getOption('enotifwatchlistpages') ) ||
 226                                                         ( $enotifusertalkpage && $watchingUser->getOption('enotifusertalkpages') )
 227                                                 && (!$minorEdit || ($wgEnotifMinorEdits && $watchingUser->getOption('enotifminoredits') ) )
 228                                                 && ($watchingUser->isEmailConfirmed() ) ) {
 229                                                         # ... adjust remaining text and page edit time placeholders
 230                                                         # which needs to be personalized for each user
 231                                                         $this->composeAndSendPersonalisedMail( $watchingUser );
 232
 233                                                 } # if the watching user has an email address in the preferences
 234                                         }
 235                                 }
 236                         } # if anyone is watching
 237                 } # if $wgEnotifWatchlist = true
 238
 239                 if ( $wgShowUpdatedMarker || $wgEnotifWatchlist ) {
 240                         # mark the changed watch-listed page with a timestamp, so that the page is
 241                         # listed with an "updated since your last visit" icon in the watch list, ...
 242                         $dbw =& wfGetDB( DB_MASTER );
 243                         $success = $dbw->update( 'watchlist',
 244                                 array( /* SET */
 245                                         'wl_notificationtimestamp' => $dbw->timestamp($timestamp)
 246                                 ), array( /* WHERE */
 247                                         'wl_title' => $title->getDBkey(),
 248                                         'wl_namespace' => $title->getNamespace(),
 249                                 ), 'UserMailer::NotifyOnChange'
 250                         );
 251                         # FIXME what do we do on failure ?
 252                 }
 253
 254         } # function NotifyOnChange
 255
 256         /**
 257          * @access private
 258          */
 259         function composeCommonMailtext() {
 260                 global $wgUser, $wgEmergencyContact, $wgNoReplyAddress;
 261                 global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
 262
 263                 $summary = ($this->summary == '') ? ' - ' : $this->summary;
 264                 $medit   = ($this->minorEdit) ? wfMsg( 'minoredit' ) : '';
 265
 266                 # You as the WikiAdmin and Sysops can make use of plenty of
 267                 # named variables when composing your notification emails while
 268                 # simply editing the Meta pages
 269
 270                 $subject = wfMsgForContent( 'enotif_subject' );
 271                 $body    = wfMsgForContent( 'enotif_body' );
 272                 $from    = ''; /* fail safe */
 273                 $replyto = ''; /* fail safe */
 274                 $keys    = array();
 275
 276                 # regarding the use of oldid as an indicator for the last visited version, see also
 277                 # http://bugzilla.wikipeda.org/show_bug.cgi?id=603 "Delete + undelete cycle doesn't preserve old_id"
 278                 # However, in the case of a new page which is already watched, we have no previous version to compare
 279                 if( $this->oldid ) {
 280                         $difflink = $this->title->getFullUrl( 'diff=0&oldid=' . $this->oldid );
 281                         $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited', $difflink );
 282                         $keys['$OLDID']   = $this->oldid;
 283                         $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
 284                 } else {
 285                         $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
 286                         # clear $OLDID placeholder in the message template
 287                         $keys['$OLDID']   = '';
 288                         $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
 289                 }
 290
 291                 $body = strtr( $body, $keys );
 292                 $pagetitle = $this->title->getPrefixedText();
 293                 $keys['$PAGETITLE']          = $pagetitle;
 294                 $keys['$PAGETITLE_URL']      = $this->title->getFullUrl();
 295
 296                 $keys['$PAGEMINOREDIT']      = $medit;
 297                 $keys['$PAGESUMMARY']        = $summary;
 298
 299                 $subject = strtr( $subject, $keys );
 300
 301                 # Reveal the page editor's address as REPLY-TO address only if
 302                 # the user has not opted-out and the option is enabled at the
 303                 # global configuration level.
 304                 $name    = $wgUser->getName();
 305                 $adminAddress = 'WikiAdmin <' . $wgEmergencyContact . '>';
 306                 $editorAddress = wfRFC822Phrase( $name ) . ' <' . $wgUser->getEmail() . '>';
 307                 if( $wgEnotifRevealEditorAddress
 308                     && ( $wgUser->getEmail() != '' )
 309                     && $wgUser->getOption( 'enotifrevealaddr' ) ) {
 310                         if( $wgEnotifFromEditor ) {
 311                                 $from    = $editorAddress;
 312                         } else {
 313                                 $from    = $adminAddress;
 314                                 $replyto = $editorAddress;
 315                         }
 316                 } else {
 317                         $from    = $adminAddress;
 318                         $replyto = $wgNoReplyAddress;
 319                 }
 320
 321                 if( $wgUser->isIP( $name ) ) {
 322                         #real anon (user:xxx.xxx.xxx.xxx)
 323                         $subject = str_replace('$PAGEEDITOR', 'anonymous user '. $name, $subject);
 324                         $keys['$PAGEEDITOR']       = 'anonymous user ' . $name;
 325                         $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
 326                 } else {
 327                         $subject = str_replace('$PAGEEDITOR', $name, $subject);
 328                         $keys['$PAGEEDITOR']          = $name;
 329                         $emailPage = Title::makeTitle( NS_SPECIAL, 'Emailuser/' . $name );
 330                         $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getFullUrl();
 331                 }
 332                 $userPage = $wgUser->getUserPage();
 333                 $keys['$PAGEEDITOR_WIKI'] = $userPage->getFullUrl();
 334                 $body = strtr( $body, $keys );
 335                 $body = wordwrap( $body, 72 );
 336
 337                 # now save this as the constant user-independent part of the message
 338                 $this->from    = $from;
 339                 $this->replyto = $replyto;
 340                 $this->subject = $subject;
 341                 $this->body    = $body;
 342         }
 343
 344
 345
 346         /**
 347          * Does the per-user customizations to a notification e-mail (name,
 348          * timestamp in proper timezone, etc) and sends it out.
 349          * Returns true if the mail was sent successfully.
 350          *
 351          * @param User $watchingUser
 352          * @param object $mail
 353          * @return bool
 354          * @access private
 355          */
 356         function composeAndSendPersonalisedMail( $watchingUser ) {
 357                 global $wgLang;
 358                 // From the PHP manual:
 359                 //     Note:  The to parameter cannot be an address in the form of "Something <someone@example.com>".
 360                 //     The mail command will not parse this properly while talking with the MTA.
 361                 $to = $watchingUser->getEmail();
 362                 $body = str_replace( '$WATCHINGUSERNAME', $watchingUser->getName() , $this->body );
 363
 364                 $timecorrection = $watchingUser->getOption( 'timecorrection' );
 365
 366                 # $PAGEEDITDATE is the time and date of the page change
 367                 # expressed in terms of individual local time of the notification
 368                 # recipient, i.e. watching user
 369                 $body = str_replace('$PAGEEDITDATE',
 370                         $wgLang->timeanddate( $this->timestamp, true, false, $timecorrection ),
 371                         $body);
 372
 373                 $error = userMailer( $to, $this->from, $this->subject, $body, $this->replyto );
 374                 return ($error == '');
 375         }
 376
 377 } # end of class EmailNotification
 378 ?>