Fix grammar in 'mimesearch-summary'
[lhc/web/wiklou.git] / includes / UserMailer.php
index a2d4bae..07cf57d 100644 (file)
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Classes used to send e-mails
+ *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @author <brion@pobox.com>
  * @author <mail@tgries.de>
  * @author Tim Starling
- *
  */
 
 
@@ -31,6 +33,7 @@ class MailAddress {
        /**
         * @param $address Mixed: string with an email address, or a User object
         * @param $name String: human-readable name if a string address is given
+        * @param $realName String: human-readable real name if a string address is given
         */
        function __construct( $address, $name = null, $realName = null ) {
                if( is_object( $address ) && $address instanceof User ) {
@@ -75,6 +78,8 @@ class MailAddress {
  * Collection of static functions for sending mail
  */
 class UserMailer {
+       static $mErrorString;
+       
        /**
         * Send mail using a PEAR mailer
         */
@@ -97,7 +102,7 @@ class UserMailer {
         * array of parameters. It requires PEAR:Mail to do that.
         * Otherwise it just uses the standard PHP 'mail' function.
         *
-        * @param $to MailAddress: recipient's email
+        * @param $to MailAddress: recipient's email (or an array of them)
         * @param $from MailAddress: sender's email
         * @param $subject String: email's subject.
         * @param $body String: email's text.
@@ -106,10 +111,16 @@ class UserMailer {
         * @return mixed True on success, a WikiError object on failure.
         */
        static function send( $to, $from, $subject, $body, $replyto=null, $contentType=null ) {
-               global $wgSMTP, $wgOutputEncoding, $wgErrorString, $wgEnotifImpersonal;
+               global $wgSMTP, $wgOutputEncoding, $wgEnotifImpersonal;
                global $wgEnotifMaxRecips;
 
                if ( is_array( $to ) ) {
+                       // This wouldn't be necessary if implode() worked on arrays of
+                       // objects using __toString(). http://bugs.php.net/bug.php?id=36612
+                       foreach( $to as $t ) {
+                               $emails .= $t->toString() . ",";
+                       }
+                       $emails = rtrim( $emails, ',' );
                        wfDebug( __METHOD__.': sending mail to ' . implode( ',', $to ) . "\n" );
                } else {
                        wfDebug( __METHOD__.': sending mail to ' . implode( ',', array( $to->toString() ) ) . "\n" );
@@ -188,34 +199,31 @@ class UserMailer {
                                $headers .= "{$endl}Reply-To: " . $replyto->toString();
                        }
 
-                       $wgErrorString = '';
+                       wfDebug( "Sending mail via internal mail() function\n" );
+                       
+                       self::$mErrorString = '';
                        $html_errors = ini_get( 'html_errors' );
                        ini_set( 'html_errors', '0' );
                        set_error_handler( array( 'UserMailer', 'errorHandler' ) );
-                       wfDebug( "Sending mail via internal mail() function\n" );
 
-                       if (function_exists('mail')) {
-                               if (is_array($to)) {
-                                       foreach ($to as $recip) {
-                                               $sent = mail( $recip->toString(), wfQuotedPrintable( $subject ), $body, $headers );
-                                       }
-                               } else {
-                                       $sent = mail( $to->toString(), wfQuotedPrintable( $subject ), $body, $headers );
+                       if (is_array($to)) {
+                               foreach ($to as $recip) {
+                                       $sent = mail( $recip->toString(), wfQuotedPrintable( $subject ), $body, $headers );
                                }
                        } else {
-                               $wgErrorString = 'PHP is not configured to send mail';
+                               $sent = mail( $to->toString(), wfQuotedPrintable( $subject ), $body, $headers );
                        }
 
                        restore_error_handler();
                        ini_set( 'html_errors', $html_errors );
 
-                       if ( $wgErrorString ) {
-                               wfDebug( "Error sending mail: $wgErrorString\n" );
-                               return new WikiError( $wgErrorString );
-                       } elseif (! $sent) {
+                       if ( self::$mErrorString ) {
+                               wfDebug( "Error sending mail: " . self::$mErrorString . "\n" );
+                               return new WikiError( self::$mErrorString );
+                       } elseif (! $sent ) {
                                //mail function only tells if there's an error
                                wfDebug( "Error sending mail\n" );
-                               return new WikiError( 'mailer error' );
+                               return new WikiError( 'mail() failed' );
                        } else {
                                return true;
                        }
@@ -223,14 +231,13 @@ class UserMailer {
        }
 
        /**
-        * Get the mail error message in global $wgErrorString
+        * Set the mail error message in self::$mErrorString
         *
         * @param $code Integer: error number
         * @param $string String: error message
         */
        static function errorHandler( $code, $string ) {
-               global $wgErrorString;
-               $wgErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
+               self::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
        }
 
        /**
@@ -263,9 +270,9 @@ class UserMailer {
  *
  */
 class EmailNotification {
-       private $to, $subject, $body, $replyto, $from;
-       private $user, $title, $timestamp, $summary, $minorEdit, $oldid, $composed_common, $editor;
-       private $mailTargets = array();
+       protected $to, $subject, $body, $replyto, $from;
+       protected $user, $title, $timestamp, $summary, $minorEdit, $oldid, $composed_common, $editor;
+       protected $mailTargets = array();
 
        /**
         * Send emails corresponding to the user $editor editing the page $title.
@@ -281,11 +288,44 @@ class EmailNotification {
         * @param $oldid (default: false)
         */
        function notifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid = false) {
-               global $wgEnotifUseJobQ;
+               global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker;
 
-               if( $title->getNamespace() < 0 )
+               if ($title->getNamespace() < 0)
                        return;
 
+               // Build a list of users to notfiy
+               $watchers = array();
+               if ($wgEnotifWatchlist || $wgShowUpdatedMarker) {
+                       $dbw = wfGetDB( DB_MASTER );
+                       $res = $dbw->select( array( 'watchlist' ),
+                               array( 'wl_user' ),
+                               array(
+                                       'wl_title' => $title->getDBkey(),
+                                       'wl_namespace' => $title->getNamespace(),
+                                       'wl_user != ' . intval( $editor->getID() ),
+                                       'wl_notificationtimestamp IS NULL',
+                               ), __METHOD__
+                       );
+                       while ($row = $dbw->fetchObject( $res ) ) {
+                               $watchers[] = intval( $row->wl_user );
+                       }
+                       if ($watchers) {
+                               // Update wl_notificationtimestamp for all watching users except
+                               // the editor
+                               $dbw->begin();
+                               $dbw->update( 'watchlist',
+                                       array( /* SET */
+                                               'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
+                                       ), array( /* WHERE */
+                                               'wl_title' => $title->getDBkey(),
+                                               'wl_namespace' => $title->getNamespace(),
+                                               'wl_user' => $watchers
+                                       ), __METHOD__
+                               );
+                               $dbw->commit();
+                       }
+               }
+
                if ($wgEnotifUseJobQ) {
                        $params = array(
                                "editor" => $editor->getName(),
@@ -293,11 +333,12 @@ class EmailNotification {
                                "timestamp" => $timestamp,
                                "summary" => $summary,
                                "minorEdit" => $minorEdit,
-                               "oldid" => $oldid);
+                               "oldid" => $oldid,
+                               "watchers" => $watchers);
                        $job = new EnotifNotifyJob( $title, $params );
                        $job->insert();
                } else {
-                       $this->actuallyNotifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid);
+                       $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
                }
 
        }
@@ -310,16 +351,16 @@ class EmailNotification {
         *
         * @param $editor User object
         * @param $title Title object
-        * @param $timestamp
-        * @param $summary
-        * @param $minorEdit
-        * @param $oldid (default: false)
+        * @param $timestamp string Edit timestamp
+        * @param $summary string Edit summary
+        * @param $minorEdit bool
+        * @param $oldid int Revision ID
+        * @param $watchers array of user IDs
         */
-       function actuallyNotifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid=false) {
+       function actuallyNotifyOnPageChange($editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers) {
                # we use $wgPasswordSender as sender's address
                global $wgEnotifWatchlist;
-               global $wgEnotifMinorEdits, $wgEnotifUserTalk, $wgShowUpdatedMarker;
-               global $wgEnotifImpersonal;
+               global $wgEnotifMinorEdits, $wgEnotifUserTalk;
 
                wfProfileIn( __METHOD__ );
 
@@ -328,8 +369,6 @@ class EmailNotification {
                # 2. minor edits (changes) are only regarded if the global flag indicates so
 
                $isUserTalkPage = ($title->getNamespace() == NS_USER_TALK);
-               $enotifusertalkpage = ($isUserTalkPage && $wgEnotifUserTalk);
-               $enotifwatchlistpage = $wgEnotifWatchlist;
 
                $this->title = $title;
                $this->timestamp = $timestamp;
@@ -363,30 +402,12 @@ class EmailNotification {
 
                        if ( $wgEnotifWatchlist ) {
                                // Send updates to watchers other than the current editor
-                               $userCondition = 'wl_user != ' . $editor->getID();
-                               if ( $userTalkId !== false ) {
-                                       // Already sent an email to this person
-                                       $userCondition .= ' AND wl_user != ' . intval( $userTalkId );
-                               }
-                               $dbr = wfGetDB( DB_SLAVE );
-
-                               list( $user ) = $dbr->tableNamesN( 'user' );
-                               $res = $dbr->select( array( 'watchlist', 'user' ),
-                                       array( "$user.*" ),
-                                       array(
-                                               'wl_user=user_id',
-                                               'wl_title' => $title->getDBkey(),
-                                               'wl_namespace' => $title->getNamespace(),
-                                               $userCondition,
-                                               'wl_notificationtimestamp IS NULL',
-                                       ), __METHOD__
-                               );
-                               $userArray = UserArray::newFromResult( $res );
-
+                               $userArray = UserArray::newFromIDs( $watchers );
                                foreach ( $userArray as $watchingUser ) {
                                        if ( $watchingUser->getOption( 'enotifwatchlistpages' ) &&
                                                ( !$minorEdit || $watchingUser->getOption('enotifminoredits') ) &&
-                                               $watchingUser->isEmailConfirmed() )
+                                               $watchingUser->isEmailConfirmed() &&
+                                               $watchingUser->getID() != $userTalkId )
                                        {
                                                $this->compose( $watchingUser );
                                        }
@@ -400,31 +421,9 @@ class EmailNotification {
                        $this->compose( $user );
                }
 
-               $latestTimestamp = Revision::getTimestampFromId( $title, $title->getLatestRevID(GAID_FOR_UPDATE) );
-               // Do not update watchlists if something else already did.
-               if ( $timestamp >= $latestTimestamp && ($wgShowUpdatedMarker || $wgEnotifWatchlist) ) {
-                       # Mark the changed watch-listed page with a timestamp, so that the page is
-                       # listed with an "updated since your last visit" icon in the watch list. Do
-                       # not do this to users for their own edits.
-                       $dbw = wfGetDB( DB_MASTER );
-                       $dbw->begin();
-                       $dbw->update( 'watchlist',
-                               array( /* SET */
-                                       'wl_notificationtimestamp' => $dbw->timestamp($timestamp)
-                               ), array( /* WHERE */
-                                       'wl_title' => $title->getDBkey(),
-                                       'wl_namespace' => $title->getNamespace(),
-                                       'wl_notificationtimestamp IS NULL', // store oldest unseen change time
-                                       'wl_user != ' . $editor->getID()
-                               ), __METHOD__
-                       );
-                       $dbw->commit();
-               }
-               
                $this->sendMails();
-
                wfProfileOut( __METHOD__ );
-       } # function NotifyOnChange
+       }
 
        /**
         * @private
@@ -437,7 +436,7 @@ class EmailNotification {
                $this->composed_common = true;
 
                $summary = ($this->summary == '') ? ' - ' : $this->summary;
-               $medit   = ($this->minorEdit) ? wfMsg( 'minoredit' ) : '';
+               $medit   = ($this->minorEdit) ? wfMsgForContent( 'minoredit' ) : '';
 
                # You as the WikiAdmin and Sysops can make use of plenty of
                # named variables when composing your notification emails while
@@ -467,7 +466,7 @@ class EmailNotification {
                         * revision.
                         */
                        $keys['$NEWPAGE'] = wfMsgForContent('enotif_lastdiff',
-                                       $this->title->getFullURL("oldid={$this->oldid}&diff=prev"));
+                                       $this->title->getFullURL("oldid={$this->oldid}&diff=next"));
 
                $body = strtr( $body, $keys );
                $pagetitle = $this->title->getPrefixedText();
@@ -476,6 +475,7 @@ class EmailNotification {
 
                $keys['$PAGEMINOREDIT']      = $medit;
                $keys['$PAGESUMMARY']        = $summary;
+               $keys['$UNWATCHURL']         = $this->title->getFullUrl( 'action=unwatch' );
 
                $subject = strtr( $subject, $keys );
 
@@ -558,13 +558,12 @@ class EmailNotification {
         * timestamp in proper timezone, etc) and sends it out.
         * Returns true if the mail was sent successfully.
         *
-        * @param User $watchingUser
-        * @param object $mail
-        * @return bool
+        * @param $watchingUser User object
+        * @return Boolean
         * @private
         */
        function sendPersonalised( $watchingUser ) {
-               global $wgLang, $wgEnotifUseRealName;
+               global $wgContLang, $wgEnotifUseRealName;
                // From the PHP manual:
                //     Note:  The to parameter cannot be an address in the form of "Something <someone@example.com>".
                //     The mail command will not parse this properly while talking with the MTA.
@@ -577,8 +576,13 @@ class EmailNotification {
                # $PAGEEDITDATE is the time and date of the page change
                # expressed in terms of individual local time of the notification
                # recipient, i.e. watching user
-               $body = str_replace('$PAGEEDITDATE',
-                       $wgLang->timeanddate( $this->timestamp, true, false, $timecorrection ),
+               $body = str_replace(
+                       array(  '$PAGEEDITDATEANDTIME',
+                               '$PAGEEDITDATE',
+                               '$PAGEEDITTIME' ),
+                       array(  $wgContLang->timeanddate( $this->timestamp, true, false, $timecorrection ),
+                               $wgContLang->date( $this->timestamp, true, false, $timecorrection ),
+                               $wgContLang->time( $this->timestamp, true, false, $timecorrection ) ),
                        $body);
 
                return UserMailer::send($to, $this->from, $this->subject, $body, $this->replyto);
@@ -589,7 +593,7 @@ class EmailNotification {
         * mailing.  Takes an array of MailAddress objects.
         */
        function sendImpersonal( $addresses ) {
-               global $wgLang;
+               global $wgContLang;
 
                if (empty($addresses))
                        return;
@@ -598,7 +602,7 @@ class EmailNotification {
                                array(  '$WATCHINGUSERNAME',
                                        '$PAGEEDITDATE'),
                                array(  wfMsgForContent('enotif_impersonal_salutation'),
-                                       $wgLang->timeanddate($this->timestamp, true, false, false)),
+                                       $wgContLang->timeanddate($this->timestamp, true, false, false)),
                                $this->body);
 
                return UserMailer::send($addresses, $this->from, $this->subject, $body, $this->replyto);