Merge "Follow-up I0b781c11 (2a55449): use User::getAutomaticGroups()."
[lhc/web/wiklou.git] / includes / UserMailer.php
index 49577f7..01e7132 100644 (file)
@@ -109,16 +109,17 @@ class UserMailer {
        /**
         * Creates a single string from an associative array
         *
-        * @param $header Associative Array: keys are header field names,
-        *                values are ... values.
+        * @param $headers array Associative Array: keys are header field names,
+        *                 values are ... values.
         * @param $endl String: The end of line character.  Defaults to "\n"
         * @return String
         */
        static function arrayToHeaderString( $headers, $endl = "\n" ) {
+               $strings = array();
                foreach( $headers as $name => $value ) {
-                       $string[] = "$name: $value";
+                       $strings[] = "$name: $value";
                }
-               return implode( $endl, $string );
+               return implode( $endl, $strings );
        }
 
        /**
@@ -154,40 +155,60 @@ class UserMailer {
         * @return Status object
         */
        public static function send( $to, $from, $subject, $body, $replyto = null, $contentType = 'text/plain; charset=UTF-8' ) {
-               global $wgSMTP, $wgEnotifImpersonal;
-               global $wgEnotifMaxRecips, $wgAdditionalMailParams;
+               global $wgSMTP, $wgEnotifMaxRecips, $wgAdditionalMailParams;
 
-               $emails = '';
-               wfDebug( __METHOD__ . ': sending mail to ' . ( is_array( $to ) ? implode( ', ', $to ) : $to ) . "\n" );
+               if ( !is_array( $to ) ) {
+                       $to = array( $to );
+               }
 
-               $headers['From'] = $from->toString();
-               $headers['Return-Path'] = $from->toString();
+               wfDebug( __METHOD__ . ': sending mail to ' . implode( ', ', $to ) . "\n" );
 
-               $dest = array();
-               if ( is_array( $to ) ) {
-                       foreach ( $to as $u ) {
-                               if ( $u->address ) {
-                                       $dest[] = $u->address;
-                               }
+               # Make sure we have at least one address
+               $has_address = false;
+               foreach ( $to as $u ) {
+                       if ( $u->address ) {
+                               $has_address = true;
+                               break;
                        }
-               } else if( $to->address ) {
-                       $dest[] = $to->address;
                }
-               if ( count( $dest ) == 0 ) {
+               if ( !$has_address ) {
                        return Status::newFatal( 'user-mail-no-addy' );
                }
 
-               if ( $wgEnotifImpersonal ) {
-                       $headers['To'] = 'undisclosed-recipients:;';
-               }
-               else {
-                       $headers['To'] = implode( ", ", $dest );
-               }
+               # Forge email headers
+               # -------------------
+               #
+               # WARNING
+               #
+               # DO NOT add To: or Subject: headers at this step. They need to be
+               # handled differently depending upon the mailer we are going to use.
+               #
+               # To:
+               #  PHP mail() first argument is the mail receiver. The argument is
+               #  used as a recipient destination and as a To header.
+               #
+               #  PEAR mailer has a recipient argument which is only used to
+               #  send the mail. If no To header is given, PEAR will set it to
+               #  to 'undisclosed-recipients:'.
+               #
+               #  NOTE: To: is for presentation, the actual recipient is specified
+               #  by the mailer using the Rcpt-To: header.
+               #
+               # Subject: 
+               #  PHP mail() second argument to pass the subject, passing a Subject
+               #  as an additional header will result in a duplicate header.
+               #
+               #  PEAR mailer should be passed a Subject header.
+               #
+               # -- hashar 20120218
+
+               $headers['From'] = $from->toString();
+               $headers['Return-Path'] = $from->address;
 
                if ( $replyto ) {
                        $headers['Reply-To'] = $replyto->toString();
                }
-               $headers['Subject'] = self::quotedPrintable( $subject );
+
                $headers['Date'] = date( 'r' );
                $headers['MIME-Version'] = '1.0';
                $headers['Content-type'] = ( is_null( $contentType ) ?
@@ -196,16 +217,19 @@ class UserMailer {
 
                $headers['Message-ID'] = self::makeMsgId();
                $headers['X-Mailer'] = 'MediaWiki mailer';
-               $headers['From'] = $from->toString();
 
                $ret = wfRunHooks( 'AlternateUserMailer', array( $headers, $to, $from, $subject, $body ) );
                if ( $ret === false ) {
                        return Status::newGood();
-               } else if ( $ret !== true ) {
+               } elseif ( $ret !== true ) {
                        return Status::newFatal( 'php-mail-error', $ret );
                }
 
                if ( is_array( $wgSMTP ) ) {
+                       #
+                       # PEAR MAILER
+                       # 
+
                        if ( function_exists( 'stream_resolve_include_path' ) ) {
                                $found = stream_resolve_include_path( 'Mail.php' );
                        } else {
@@ -227,9 +251,20 @@ class UserMailer {
                        }
 
                        wfDebug( "Sending mail via PEAR::Mail\n" );
-                       $chunks = array_chunk( $dest, $wgEnotifMaxRecips );
+
+                       $headers['Subject'] = self::quotedPrintable( $subject );
+
+                       # When sending only to one recipient, shows it its email using To:
+                       if ( count( $to ) == 1 ) {
+                               $headers['To'] = $to[0]->toString();
+                       }
+
+                       # Split jobs since SMTP servers tends to limit the maximum
+                       # number of possible recipients.        
+                       $chunks = array_chunk( $to, $wgEnotifMaxRecips );
                        foreach ( $chunks as $chunk ) {
                                $status = self::sendWithPear( $mail_object, $chunk, $headers, $body );
+                               # FIXME : some chunks might be sent while others are not!
                                if ( !$status->isOK() ) {
                                        wfRestoreWarnings();
                                        return $status;
@@ -238,6 +273,10 @@ class UserMailer {
                        wfRestoreWarnings();
                        return Status::newGood();
                } else  {
+                       # 
+                       # PHP mail()
+                       #
+
                        # Line endings need to be different on Unix and Windows due to
                        # the bug described at http://trac.wordpress.org/ticket/2603
                        if ( wfIsWindows() ) {
@@ -247,6 +286,9 @@ class UserMailer {
                                $endl = "\n";
                        }
 
+                       if( count($to) > 1 ) {
+                               $headers['To'] = 'undisclosed-recipients:;';
+                       }
                        $headers = self::arrayToHeaderString( $headers, $endl );
 
                        wfDebug( "Sending mail via internal mail() function\n" );
@@ -257,7 +299,7 @@ class UserMailer {
                        set_error_handler( 'UserMailer::errorHandler' );
 
                        $safeMode = wfIniGetBool( 'safe_mode' );
-                       foreach ( $dest as $recip ) {
+                       foreach ( $to as $recip ) {
                                if ( $safeMode ) {
                                        $sent = mail( $recip, self::quotedPrintable( $subject ), $body, $headers );
                                } else {
@@ -304,6 +346,7 @@ class UserMailer {
        /**
         * Converts a string into quoted-printable format
         * @since 1.17
+        * @return string
         */
        public static function quotedPrintable( $string, $charset = '' ) {
                # Probably incomplete; see RFC 2045
@@ -351,10 +394,20 @@ class UserMailer {
  *
  */
 class EmailNotification {
-       protected $to, $subject, $body, $replyto, $from;
-       protected $user, $title, $timestamp, $summary, $minorEdit, $oldid, $composed_common, $editor;
+       protected $subject, $body, $replyto, $from;
+       protected $timestamp, $summary, $minorEdit, $oldid, $composed_common;
        protected $mailTargets = array();
 
+       /**
+        * @var Title
+        */
+       protected $title;
+
+       /**
+        * @var User
+        */
+       protected $editor;
+
        /**
         * Send emails corresponding to the user $editor editing the page $title.
         * Also updates wl_notificationtimestamp.
@@ -383,9 +436,9 @@ class EmailNotification {
                        $res = $dbw->select( array( 'watchlist' ),
                                array( 'wl_user' ),
                                array(
-                                       'wl_title' => $title->getDBkey(),
-                                       'wl_namespace' => $title->getNamespace(),
                                        'wl_user != ' . intval( $editor->getID() ),
+                                       'wl_namespace' => $title->getNamespace(),
+                                       'wl_title' => $title->getDBkey(),
                                        'wl_notificationtimestamp IS NULL',
                                ), __METHOD__
                        );
@@ -395,17 +448,17 @@ class EmailNotification {
                        if ( $watchers ) {
                                // Update wl_notificationtimestamp for all watching users except
                                // the editor
-                               $dbw->begin();
+                               $dbw->begin( __METHOD__ );
                                $dbw->update( 'watchlist',
                                        array( /* SET */
                                                'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
                                        ), array( /* WHERE */
-                                               'wl_title' => $title->getDBkey(),
+                                               'wl_user' => $watchers,
                                                'wl_namespace' => $title->getNamespace(),
-                                               'wl_user' => $watchers
+                                               'wl_title' => $title->getDBkey(),
                                        ), __METHOD__
                                );
-                               $dbw->commit();
+                               $dbw->commit( __METHOD__ );
                        }
                }
 
@@ -506,6 +559,10 @@ class EmailNotification {
 
                global $wgUsersNotifiedOnAllChanges;
                foreach ( $wgUsersNotifiedOnAllChanges as $name ) {
+                       if ( $editor->getName() == $name ) {
+                               // No point notifying the user that actually made the change!
+                               continue;
+                       }
                        $user = User::newFromName( $name );
                        $this->compose( $user );
                }
@@ -544,7 +601,7 @@ class EmailNotification {
                                wfDebug( __METHOD__ . ": talk page owner doesn't want notifications\n" );
                        }
                }
-           return false;
+               return false;
        }
 
        /**
@@ -562,35 +619,40 @@ class EmailNotification {
                # simply editing the Meta pages
 
                $keys = array();
+               $postTransformKeys = array();
 
                if ( $this->oldid ) {
-                       if ( $wgEnotifImpersonal ) {
-                               // For impersonal mail, show a diff link to the last revision.
-                               $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastdiff',
-                                       $this->title->getCanonicalUrl( 'diff=next&oldid=' . $this->oldid ) );
-                       } else {
-                               $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited',
-                                       $this->title->getCanonicalUrl( 'diff=0&oldid=' . $this->oldid ) );
+                       // Always show a link to the diff which triggered the mail. See bug 32210.
+                       $keys['$NEWPAGE'] = wfMessage( 'enotif_lastdiff',
+                               $this->title->getCanonicalUrl( 'diff=next&oldid=' . $this->oldid ) )
+                               ->inContentLanguage()->text();
+                       if ( !$wgEnotifImpersonal ) {
+                               // For personal mail, also show a link to the diff of all changes
+                               // since last visited.
+                               $keys['$NEWPAGE'] .= " \n" . wfMessage( 'enotif_lastvisited',
+                                       $this->title->getCanonicalUrl( 'diff=0&oldid=' . $this->oldid ) )
+                                       ->inContentLanguage()->text();
                        }
                        $keys['$OLDID']   = $this->oldid;
-                       $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
+                       $keys['$CHANGEDORCREATED'] = wfMessage( 'changed' )->inContentLanguage()->text();
                } else {
-                       $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
+                       $keys['$NEWPAGE'] = wfMessage( 'enotif_newpagetext' )->inContentLanguage()->text();
                        # clear $OLDID placeholder in the message template
                        $keys['$OLDID']   = '';
-                       $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
+                       $keys['$CHANGEDORCREATED'] = wfMessage( 'created' )->inContentLanguage()->text();
                }
 
                $keys['$PAGETITLE'] = $this->title->getPrefixedText();
                $keys['$PAGETITLE_URL'] = $this->title->getCanonicalUrl();
-               $keys['$PAGEMINOREDIT'] = $this->minorEdit ? wfMsgForContent( 'minoredit' ) : '';
-               $keys['$PAGESUMMARY'] = $this->summary == '' ? ' - ' : $this->summary;
+               $keys['$PAGEMINOREDIT'] = $this->minorEdit ?
+                       wfMessage( 'minoredit' )->inContentLanguage()->text() : '';
                $keys['$UNWATCHURL'] = $this->title->getCanonicalUrl( 'action=unwatch' );
 
                if ( $this->editor->isAnon() ) {
                        # real anon (user:xxx.xxx.xxx.xxx)
-                       $keys['$PAGEEDITOR'] = wfMsgForContent( 'enotif_anon_editor', $this->editor->getName() );
-                       $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
+                       $keys['$PAGEEDITOR'] = wfMessage( 'enotif_anon_editor', $this->editor->getName() )
+                               ->inContentLanguage()->text();
+                       $keys['$PAGEEDITOR_EMAIL'] = wfMessage( 'noemailtitle' )->inContentLanguage()->text();
                } else {
                        $keys['$PAGEEDITOR'] = $wgEnotifUseRealName ? $this->editor->getRealName() : $this->editor->getName();
                        $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $this->editor->getName() );
@@ -599,16 +661,20 @@ class EmailNotification {
 
                $keys['$PAGEEDITOR_WIKI'] = $this->editor->getUserPage()->getCanonicalUrl();
 
+               # Replace this after transforming the message, bug 35019
+               $postTransformKeys['$PAGESUMMARY'] = $this->summary == '' ? ' - ' : $this->summary;
+
                # Now build message's subject and body
 
-               $subject = wfMsgExt( 'enotif_subject', 'content' );
+               $subject = wfMessage( 'enotif_subject' )->inContentLanguage()->plain();
                $subject = strtr( $subject, $keys );
-               $this->subject = MessageCache::singleton()->transform( $subject, false, null, $this->title );
+               $subject = MessageCache::singleton()->transform( $subject, false, null, $this->title );
+               $this->subject = strtr( $subject, $postTransformKeys );
 
-               $body = wfMsgExt( 'enotif_body', 'content' );
+               $body = wfMessage( 'enotif_body' )->inContentLanguage()->plain();
                $body = strtr( $body, $keys );
                $body = MessageCache::singleton()->transform( $body, false, null, $this->title );
-               $this->body = wordwrap( $body, 72 );
+               $this->body = wordwrap( strtr( $body, $postTransformKeys ), 72 );
 
                # Reveal the page editor's address as REPLY-TO address only if
                # the user has not opted-out and the option is enabled at the
@@ -636,6 +702,7 @@ class EmailNotification {
         * depending on settings.
         *
         * Call sendMails() to send any mails that were queued.
+        * @param $user User
         */
        function compose( $user ) {
                global $wgEnotifImpersonal;
@@ -694,6 +761,7 @@ class EmailNotification {
        /**
         * Same as sendPersonalised but does impersonal mail suitable for bulk
         * mailing.  Takes an array of MailAddress objects.
+        * @return Status
         */
        function sendImpersonal( $addresses ) {
                global $wgContLang;
@@ -705,7 +773,7 @@ class EmailNotification {
                                array( '$WATCHINGUSERNAME',
                                        '$PAGEEDITDATE',
                                        '$PAGEEDITTIME' ),
-                               array( wfMsgForContent( 'enotif_impersonal_salutation' ),
+                               array( wfMessage( 'enotif_impersonal_salutation' )->inContentLanguage()->text(),
                                        $wgContLang->date( $this->timestamp, false, false ),
                                        $wgContLang->time( $this->timestamp, false, false ) ),
                                $this->body );