Reverted r111188: backport conflict fodder
[lhc/web/wiklou.git] / includes / UserMailer.php
index 47e95b2..14fd965 100644 (file)
@@ -67,6 +67,8 @@ class MailAddress {
                        } else {
                                return $this->address;
                        }
+               } else {
+                       return "";
                }
        }
 
@@ -107,8 +109,8 @@ 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
         */
@@ -119,6 +121,24 @@ class UserMailer {
                return implode( $endl, $string );
        }
 
+       /**
+        * Create a value suitable for the MessageId Header
+        *
+        * @return String
+        */
+       static function makeMsgId() {
+               global $wgSMTP, $wgServer;
+
+               $msgid = uniqid( wfWikiID() . ".", true ); /* true required for cygwin */
+               if ( is_array($wgSMTP) && isset($wgSMTP['IDHost']) && $wgSMTP['IDHost'] ) {
+                       $domain = $wgSMTP['IDHost'];
+               } else {
+                       $url = wfParseUrl($wgServer);
+                       $domain = $url['host'];
+               }
+               return "<$msgid@$domain>";
+       }
+
        /**
         * This function will perform a direct (authenticated) login to
         * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
@@ -134,46 +154,52 @@ 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 ' . implode( ',', array( $to->toString() ) ) . "\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;
-                               }
+               foreach ( $to as $u ) {
+                       if ( $u->address ) {
+                               $dest[] = $u->address;
                        }
-               } else if( $to->address ) {
-                       $dest[] = $to->address;
+               }
+               if ( count( $dest ) == 0 ) {
+                       return Status::newFatal( 'user-mail-no-addy' );
                }
 
-               if ( $wgEnotifImpersonal ) {
+               $headers['From'] = $from->toString();
+               $headers['Return-Path'] = $from->address;
+               if ( count( $to ) == 1 ) {
+                       $headers['To'] = $to[0]->toString();
+               } else {
                        $headers['To'] = 'undisclosed-recipients:;';
                }
-               else {
-                       $headers['To'] = implode( ", ", $dest );
-               }
 
                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 ) ?
                        'text/plain; charset=UTF-8' : $contentType );
                $headers['Content-transfer-encoding'] = '8bit';
-               // @todo FIXME
-               $headers['Message-ID'] = "<$msgid@" . $wgSMTP['IDHost'] . '>';
+
+               $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();
+               } elseif ( $ret !== true ) {
+                       return Status::newFatal( 'php-mail-error', $ret );
+               }
 
                if ( is_array( $wgSMTP ) ) {
                        if ( function_exists( 'stream_resolve_include_path' ) ) {
@@ -186,11 +212,6 @@ class UserMailer {
                        }
                        require_once( 'Mail.php' );
 
-                       $msgid = str_replace( " ", "_", microtime() );
-                       if ( function_exists( 'posix_getpid' ) ) {
-                               $msgid .= '.' . posix_getpid();
-                       }
-
                        wfSuppressWarnings();
 
                        // Create the mail object using the Mail::factory method
@@ -231,11 +252,13 @@ class UserMailer {
                        ini_set( 'html_errors', '0' );
                        set_error_handler( 'UserMailer::errorHandler' );
 
-                       if ( !is_array( $to ) ) {
-                               $to = array( $to );
-                       }
-                       foreach ( $to as $recip ) {
-                               $sent = mail( $recip->toString(), self::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
+                       $safeMode = wfIniGetBool( 'safe_mode' );
+                       foreach ( $dest as $recip ) {
+                               if ( $safeMode ) {
+                                       $sent = mail( $recip, self::quotedPrintable( $subject ), $body, $headers );
+                               } else {
+                                       $sent = mail( $recip, self::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
+                               }
                        }
 
                        restore_error_handler();
@@ -277,6 +300,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
@@ -324,10 +348,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.
@@ -342,7 +376,8 @@ class EmailNotification {
         * @param $oldid (default: false)
         */
        public function notifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid = false ) {
-               global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker;
+               global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker, $wgEnotifMinorEdits,
+                       $wgUsersNotifiedOnAllChanges, $wgEnotifUserTalk;
 
                if ( $title->getNamespace() < 0 ) {
                        return;
@@ -381,6 +416,24 @@ class EmailNotification {
                        }
                }
 
+               $sendEmail = true;
+               // If nobody is watching the page, and there are no users notified on all changes
+               // don't bother creating a job/trying to send emails
+               // $watchers deals with $wgEnotifWatchlist
+               if ( !count( $watchers ) && !count( $wgUsersNotifiedOnAllChanges ) ) {
+                       $sendEmail = false;
+                       // Only send notification for non minor edits, unless $wgEnotifMinorEdits
+                       if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
+                               $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );
+                               if ( $wgEnotifUserTalk && $isUserTalkPage && $this->canSendUserTalkEmail( $editor, $title, $minorEdit ) ) {
+                                       $sendEmail = true;
+                               }
+                       }
+               }
+
+               if ( !$sendEmail ) {
+                       return;
+               }
                if ( $wgEnotifUseJobQ ) {
                        $params = array(
                                'editor' => $editor->getName(),
@@ -396,7 +449,6 @@ class EmailNotification {
                } else {
                        $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
                }
-
        }
 
        /**
@@ -437,25 +489,11 @@ class EmailNotification {
                $userTalkId = false;
 
                if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {
-                       if ( $wgEnotifUserTalk && $isUserTalkPage ) {
+
+                       if ( $wgEnotifUserTalk && $isUserTalkPage && $this->canSendUserTalkEmail( $editor, $title, $minorEdit ) ) {
                                $targetUser = User::newFromName( $title->getText() );
-                               if ( !$targetUser || $targetUser->isAnon() ) {
-                                       wfDebug( __METHOD__ . ": user talk page edited, but user does not exist\n" );
-                               } elseif ( $targetUser->getId() == $editor->getId() ) {
-                                       wfDebug( __METHOD__ . ": user edited their own talk page, no notification sent\n" );
-                               } elseif ( $targetUser->getOption( 'enotifusertalkpages' ) &&
-                                       ( !$minorEdit || $targetUser->getOption( 'enotifminoredits' ) ) )
-                               {
-                                       if ( $targetUser->isEmailConfirmed() ) {
-                                               wfDebug( __METHOD__ . ": sending talk page update notification\n" );
-                                               $this->compose( $targetUser );
-                                               $userTalkId = $targetUser->getId();
-                                       } else {
-                                               wfDebug( __METHOD__ . ": talk page owner doesn't have validated email\n" );
-                                       }
-                               } else {
-                                       wfDebug( __METHOD__ . ": talk page owner doesn't want notifications\n" );
-                               }
+                               $this->compose( $targetUser );
+                               $userTalkId = $targetUser->getId();
                        }
 
                        if ( $wgEnotifWatchlist ) {
@@ -475,6 +513,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 );
                }
@@ -483,6 +525,39 @@ class EmailNotification {
                wfProfileOut( __METHOD__ );
        }
 
+       /**
+        * @param $editor User
+        * @param $title Title bool
+        * @param $minorEdit
+        * @return bool
+        */
+       private function canSendUserTalkEmail( $editor, $title, $minorEdit ) {
+               global $wgEnotifUserTalk;
+               $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );
+
+               if ( $wgEnotifUserTalk && $isUserTalkPage ) {
+                       $targetUser = User::newFromName( $title->getText() );
+
+                       if ( !$targetUser || $targetUser->isAnon() ) {
+                               wfDebug( __METHOD__ . ": user talk page edited, but user does not exist\n" );
+                       } elseif ( $targetUser->getId() == $editor->getId() ) {
+                               wfDebug( __METHOD__ . ": user edited their own talk page, no notification sent\n" );
+                       } elseif ( $targetUser->getOption( 'enotifusertalkpages' ) &&
+                               ( !$minorEdit || $targetUser->getOption( 'enotifminoredits' ) ) )
+                       {
+                               if ( $targetUser->isEmailConfirmed() ) {
+                                       wfDebug( __METHOD__ . ": sending talk page update notification\n" );
+                                       return true;
+                               } else {
+                                       wfDebug( __METHOD__ . ": talk page owner doesn't have validated email\n" );
+                               }
+                       } else {
+                               wfDebug( __METHOD__ . ": talk page owner doesn't want notifications\n" );
+                       }
+               }
+               return false;
+       }
+
        /**
         * Generate the generic "this page has been changed" e-mail text.
         */
@@ -493,22 +568,22 @@ class EmailNotification {
 
                $this->composed_common = true;
 
-               $summary = ( $this->summary == '' ) ? ' - ' : $this->summary;
-               $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
                # simply editing the Meta pages
 
-               $subject = wfMsgForContent( 'enotif_subject' );
-               $body    = wfMsgForContent( 'enotif_body' );
-               $from    = ''; /* fail safe */
-               $replyto = ''; /* fail safe */
-               $keys    = array();
+               $keys = array();
 
                if ( $this->oldid ) {
-                       $difflink = $this->title->getFullUrl( 'diff=0&oldid=' . $this->oldid );
-                       $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited', $difflink );
+                       // Always show a link to the diff which triggered the mail. See bug 32210.
+                       $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastdiff',
+                               $this->title->getCanonicalUrl( 'diff=next&oldid=' . $this->oldid ) );
+                       if ( !$wgEnotifImpersonal ) {
+                               // For personal mail, also show a link to the diff of all changes
+                               // since last visited.
+                               $keys['$NEWPAGE'] .= " \n" . wfMsgForContent( 'enotif_lastvisited',
+                                       $this->title->getCanonicalUrl( 'diff=0&oldid=' . $this->oldid ) );
+                       }
                        $keys['$OLDID']   = $this->oldid;
                        $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
                } else {
@@ -518,69 +593,54 @@ class EmailNotification {
                        $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
                }
 
-               if ( $wgEnotifImpersonal && $this->oldid ) {
-                       /**
-                        * For impersonal mail, show a diff link to the last
-                        * revision.
-                        */
-                       $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastdiff',
-                                       $this->title->getFullURL( "oldid={$this->oldid}&diff=next" ) );
+               $keys['$PAGETITLE'] = $this->title->getPrefixedText();
+               $keys['$PAGETITLE_URL'] = $this->title->getCanonicalUrl();
+               $keys['$PAGEMINOREDIT'] = $this->minorEdit ? wfMsgForContent( 'minoredit' ) : '';
+               $keys['$PAGESUMMARY'] = $this->summary == '' ? ' - ' : $this->summary;
+               $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' );
+               } else {
+                       $keys['$PAGEEDITOR'] = $wgEnotifUseRealName ? $this->editor->getRealName() : $this->editor->getName();
+                       $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $this->editor->getName() );
+                       $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getCanonicalUrl();
                }
 
-               $body = strtr( $body, $keys );
-               $pagetitle = $this->title->getPrefixedText();
-               $keys['$PAGETITLE']          = $pagetitle;
-               $keys['$PAGETITLE_URL']      = $this->title->getFullUrl();
+               $keys['$PAGEEDITOR_WIKI'] = $this->editor->getUserPage()->getCanonicalUrl();
 
-               $keys['$PAGEMINOREDIT']      = $medit;
-               $keys['$PAGESUMMARY']        = $summary;
-               $keys['$UNWATCHURL']         = $this->title->getFullUrl( 'action=unwatch' );
+               # Now build message's subject and body
 
+               $subject = wfMsgExt( 'enotif_subject', 'content' );
                $subject = strtr( $subject, $keys );
+               $this->subject = MessageCache::singleton()->transform( $subject, false, null, $this->title );
+
+               $body = wfMsgExt( 'enotif_body', 'content' );
+               $body = strtr( $body, $keys );
+               $body = MessageCache::singleton()->transform( $body, false, null, $this->title );
+               $this->body = wordwrap( $body, 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
                # global configuration level.
-               $editor = $this->editor;
-               $name    = $wgEnotifUseRealName ? $editor->getRealName() : $editor->getName();
                $adminAddress = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
-               $editorAddress = new MailAddress( $editor );
                if ( $wgEnotifRevealEditorAddress
-                       && ( $editor->getEmail() != '' )
-                       && $editor->getOption( 'enotifrevealaddr' ) ) {
+                       && ( $this->editor->getEmail() != '' )
+                       && $this->editor->getOption( 'enotifrevealaddr' ) )
+               {
+                       $editorAddress = new MailAddress( $this->editor );
                        if ( $wgEnotifFromEditor ) {
-                               $from    = $editorAddress;
+                               $this->from    = $editorAddress;
                        } else {
-                               $from    = $adminAddress;
-                               $replyto = $editorAddress;
+                               $this->from    = $adminAddress;
+                               $this->replyto = $editorAddress;
                        }
                } else {
-                       $from    = $adminAddress;
-                       $replyto = new MailAddress( $wgNoReplyAddress );
-               }
-
-               if ( $editor->isAnon() ) {
-                       # real anon (user:xxx.xxx.xxx.xxx)
-                       $utext = wfMsgForContent( 'enotif_anon_editor', $name );
-                       $subject = str_replace( '$PAGEEDITOR', $utext, $subject );
-                       $keys['$PAGEEDITOR']       = $utext;
-                       $keys['$PAGEEDITOR_EMAIL'] = wfMsgForContent( 'noemailtitle' );
-               } else {
-                       $subject = str_replace( '$PAGEEDITOR', $name, $subject );
-                       $keys['$PAGEEDITOR']          = $name;
-                       $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $name );
-                       $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getFullUrl();
+                       $this->from    = $adminAddress;
+                       $this->replyto = new MailAddress( $wgNoReplyAddress );
                }
-               $userPage = $editor->getUserPage();
-               $keys['$PAGEEDITOR_WIKI'] = $userPage->getFullUrl();
-               $body = strtr( $body, $keys );
-               $body = wordwrap( $body, 72 );
-
-               # now save this as the constant user-independent part of the message
-               $this->from    = $from;
-               $this->replyto = $replyto;
-               $this->subject = $subject;
-               $this->body    = $body;
        }
 
        /**
@@ -588,6 +648,7 @@ class EmailNotification {
         * depending on settings.
         *
         * Call sendMails() to send any mails that were queued.
+        * @param $user User
         */
        function compose( $user ) {
                global $wgEnotifImpersonal;
@@ -627,22 +688,18 @@ class EmailNotification {
                //     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.
                $to = new MailAddress( $watchingUser );
-               $name = $wgEnotifUseRealName ? $watchingUser->getRealName() : $watchingUser->getName();
-               $body = str_replace( '$WATCHINGUSERNAME', $name, $this->body );
-
-               $timecorrection = $watchingUser->getOption( 'timecorrection' );
 
                # $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(
-                       array( '$PAGEEDITDATEANDTIME',
+                       array( '$WATCHINGUSERNAME',
                                '$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 );
+                       array( $wgEnotifUseRealName ? $watchingUser->getRealName() : $watchingUser->getName(),
+                               $wgContLang->userDate( $this->timestamp, $watchingUser ),
+                               $wgContLang->userTime( $this->timestamp, $watchingUser ) ),
+                       $this->body );
 
                return UserMailer::send( $to, $this->from, $this->subject, $body, $this->replyto );
        }
@@ -650,6 +707,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;
@@ -662,8 +720,8 @@ class EmailNotification {
                                        '$PAGEEDITDATE',
                                        '$PAGEEDITTIME' ),
                                array( wfMsgForContent( 'enotif_impersonal_salutation' ),
-                                       $wgContLang->date( $this->timestamp, true, false, false ),
-                                       $wgContLang->time( $this->timestamp, true, false, false ) ),
+                                       $wgContLang->date( $this->timestamp, false, false ),
+                                       $wgContLang->time( $this->timestamp, false, false ) ),
                                $this->body );
 
                return UserMailer::send( $addresses, $this->from, $this->subject, $body, $this->replyto );