Another fix.
[lhc/web/wiklou.git] / includes / UserMailer.php
index 67c7176..b2d1a4f 100644 (file)
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
  * @author <brion@pobox.com>
  * @author <mail@tgries.de>
  *
- * @package MediaWiki
  */
 
-require_once( 'WikiError.php' );
-
 /**
  * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
  */
@@ -35,43 +32,84 @@ function wfRFC822Phrase( $phrase ) {
        return '"' . $phrase . '"';
 }
 
+class MailAddress {
+       /**
+        * @param mixed $address String with an email address, or a User object
+        * @param string $name Human-readable name if a string address is given
+        */
+       function __construct( $address, $name=null ) {
+               if( is_object( $address ) && $address instanceof User ) {
+                       $this->address = $address->getEmail();
+                       $this->name = $address->getName();
+               } else {
+                       $this->address = strval( $address );
+                       $this->name = strval( $name );
+               }
+       }
+
+       /**
+        * Return formatted and quoted address to insert into SMTP headers
+        * @return string
+        */
+       function toString() {
+               # PHP's mail() implementation under Windows is somewhat shite, and
+               # can't handle "Joe Bloggs <joe@bloggs.com>" format email addresses,
+               # so don't bother generating them
+               if( $this->name != '' && !wfIsWindows() ) {
+                       $quoted = wfQuotedPrintable( $this->name );
+                       if( strpos( $quoted, '.' ) !== false ) {
+                               $quoted = '"' . $quoted . '"';
+                       }
+                       return "$quoted <{$this->address}>";
+               } else {
+                       return $this->address;
+               }
+       }
+}
+
 /**
  * This function will perform a direct (authenticated) login to
  * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
  * array of parameters. It requires PEAR:Mail to do that.
  * Otherwise it just uses the standard PHP 'mail' function.
  *
- * @param string $to recipient's email
- * @param string $from sender's email
- * @param string $subject email's subject
- * @param string $body email's text
- * @param string $replyto optional reply-to email (default : false)
+ * @param $to MailAddress: recipient's email
+ * @param $from MailAddress: sender's email
+ * @param $subject String: email's subject.
+ * @param $body String: email's text.
+ * @param $replyto String: optional reply-to email (default: null).
  */
-function userMailer( $to, $from, $subject, $body, $replyto=false ) {
+function userMailer( $to, $from, $subject, $body, $replyto=null ) {
        global $wgUser, $wgSMTP, $wgOutputEncoding, $wgErrorString;
 
        if (is_array( $wgSMTP )) {
                require_once( 'Mail.php' );
 
                $timestamp = time();
+               $dest = $to->address;
 
-               $headers['From'] = $from;
-               $headers['To'] = $to;
+               $headers['From'] = $from->toString();
+               $headers['To'] = $to->toString();
                if ( $replyto ) {
-                       $headers['Reply-To'] = $replyto;
+                       $headers['Reply-To'] = $replyto->toString();
                }
-               $headers['Subject'] = $subject;
+               $headers['Subject'] = wfQuotedPrintable( $subject );
                $headers['Date'] = date( 'r' );
                $headers['MIME-Version'] = '1.0';
                $headers['Content-type'] = 'text/plain; charset='.$wgOutputEncoding;
                $headers['Content-transfer-encoding'] = '8bit';
-               $headers['Message-ID'] = "<{$timestamp}" . $wgUser->getName() . '@' . $wgSMTP['IDHost'] . '>';
+               $headers['Message-ID'] = "<{$timestamp}" . $wgUser->getName() . '@' . $wgSMTP['IDHost'] . '>'; // FIXME
                $headers['X-Mailer'] = 'MediaWiki mailer';
 
                // Create the mail object using the Mail::factory method
                $mail_object =& Mail::factory('smtp', $wgSMTP);
-               wfDebug( "Sending mail via PEAR::Mail to $to\n" );
-               $mailResult =& $mail_object->send($to, $headers, $body);
+               if( PEAR::isError( $mail_object ) ) {
+                       wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
+                       return $mail_object->getMessage();
+               }
+
+               wfDebug( "Sending mail via PEAR::Mail to $dest\n" );
+               $mailResult =& $mail_object->send($dest, $headers, $body);
 
                # Based on the result return an error string,
                if ($mailResult === true) {
@@ -86,20 +124,31 @@ function userMailer( $to, $from, $subject, $body, $replyto=false ) {
        } else  {
                # In the following $headers = expression we removed "Reply-To: {$from}\r\n" , because it is treated differently
                # (fifth parameter of the PHP mail function, see some lines below)
+
+               # Line endings need to be different on Unix and Windows due to 
+               # the bug described at http://trac.wordpress.org/ticket/2603
+               if ( wfIsWindows() ) {
+                       $body = str_replace( "\n", "\r\n", $body );
+                       $endl = "\r\n";
+               } else {
+                       $endl = "\n";
+               }
                $headers =
-                       "MIME-Version: 1.0\n" .
-                       "Content-type: text/plain; charset={$wgOutputEncoding}\n" .
-                       "Content-Transfer-Encoding: 8bit\n" .
-                       "X-Mailer: MediaWiki mailer\n".
-                       'From: ' . $from . "\n";
+                       "MIME-Version: 1.0$endl" .
+                       "Content-type: text/plain; charset={$wgOutputEncoding}$endl" .
+                       "Content-Transfer-Encoding: 8bit$endl" .
+                       "X-Mailer: MediaWiki mailer$endl".
+                       'From: ' . $from->toString();
                if ($replyto) {
-                       $headers .= "Reply-To: $replyto\n";
+                       $headers .= "{$endl}Reply-To: " . $replyto->toString();
                }
 
+               $dest = $to->toString();
+
                $wgErrorString = '';
                set_error_handler( 'mailErrorHandler' );
-               wfDebug( "Sending mail via internal mail() function to $to\n" );
-               mail( $to, $subject, $body, $headers );
+               wfDebug( "Sending mail via internal mail() function to $dest\n" );
+               mail( $dest, wfQuotedPrintable( $subject ), $body, $headers );
                restore_error_handler();
 
                if ( $wgErrorString ) {
@@ -112,12 +161,12 @@ function userMailer( $to, $from, $subject, $body, $replyto=false ) {
 /**
  * Get the mail error message in global $wgErrorString
  *
- * @parameter $code error number
- * @parameter $string error message
+ * @param $code Integer: error number
+ * @param $string String: error message
  */
 function mailErrorHandler( $code, $string ) {
        global $wgErrorString;
-       $wgErrorString = preg_replace( "/^mail\(\): /", '', $string );
+       $wgErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
 }
 
 
@@ -139,25 +188,23 @@ function mailErrorHandler( $code, $string ) {
  *
  * Visit the documentation pages under http://meta.wikipedia.com/Enotif
  *
- * @package MediaWiki
  *
  */
 class EmailNotification {
-       /**#@+
-        * @access private
+       /**@{{
+        * @private
         */
        var $to, $subject, $body, $replyto, $from;
        var $user, $title, $timestamp, $summary, $minorEdit, $oldid;
 
-       /**#@-*/
+       /**@}}*/
 
        /**
         * @todo document
-        * @param $currentPage
-        * @param $currentNs
+        * @param $title Title object
         * @param $timestamp
-        * @param $currentSummary
-        * @param $currentMinorEdit
+        * @param $summary
+        * @param $minorEdit
         * @param $oldid (default: false)
         */
        function notifyOnPageChange(&$title, $timestamp, $summary, $minorEdit, $oldid=false) {
@@ -198,9 +245,8 @@ class EmailNotification {
                                $userCondition = false;
                        }
                        if( $userCondition ) {
-                               $dbr =& wfGetDB( DB_MASTER );
-                               extract( $dbr->tableNames( 'watchlist' ) );
-                               
+                               $dbr = wfGetDB( DB_MASTER );
+
                                $res = $dbr->select( 'watchlist', array( 'wl_user' ),
                                        array(
                                                'wl_title' => $title->getDBkey(),
@@ -208,7 +254,7 @@ class EmailNotification {
                                                $userCondition,
                                                'wl_notificationtimestamp IS NULL',
                                        ), $fname );
-       
+
                                # if anyone is watching ... set up the email message text which is
                                # common for all receipients ...
                                if ( $dbr->numRows( $res ) > 0 ) {
@@ -217,23 +263,26 @@ class EmailNotification {
                                        $this->summary = $summary;
                                        $this->minorEdit = $minorEdit;
                                        $this->oldid = $oldid;
-       
+
                                        $this->composeCommonMailtext();
                                        $watchingUser = new User();
-       
+
                                        # ... now do for all watching users ... if the options fit
                                        for ($i = 1; $i <= $dbr->numRows( $res ); $i++) {
-       
+
                                                $wuser = $dbr->fetchObject( $res );
                                                $watchingUser->setID($wuser->wl_user);
+                                               
                                                if ( ( $enotifwatchlistpage && $watchingUser->getOption('enotifwatchlistpages') ) ||
-                                                       ( $enotifusertalkpage && $watchingUser->getOption('enotifusertalkpages') )
+                                                       ( $enotifusertalkpage
+                                                               && $watchingUser->getOption('enotifusertalkpages')
+                                                               && $title->equals( $watchingUser->getTalkPage() ) )
                                                && (!$minorEdit || ($wgEnotifMinorEdits && $watchingUser->getOption('enotifminoredits') ) )
                                                && ($watchingUser->isEmailConfirmed() ) ) {
                                                        # ... adjust remaining text and page edit time placeholders
                                                        # which needs to be personalized for each user
                                                        $this->composeAndSendPersonalisedMail( $watchingUser );
-       
+
                                                } # if the watching user has an email address in the preferences
                                        }
                                }
@@ -243,7 +292,7 @@ class EmailNotification {
                if ( $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, ...
-                       $dbw =& wfGetDB( DB_MASTER );
+                       $dbw = wfGetDB( DB_MASTER );
                        $success = $dbw->update( 'watchlist',
                                array( /* SET */
                                        'wl_notificationtimestamp' => $dbw->timestamp($timestamp)
@@ -254,11 +303,11 @@ class EmailNotification {
                        );
                        # FIXME what do we do on failure ?
                }
-
+               wfProfileOut( $fname );
        } # function NotifyOnChange
 
        /**
-        * @access private
+        * @private
         */
        function composeCommonMailtext() {
                global $wgUser, $wgEmergencyContact, $wgNoReplyAddress;
@@ -296,7 +345,7 @@ class EmailNotification {
                $pagetitle = $this->title->getPrefixedText();
                $keys['$PAGETITLE']          = $pagetitle;
                $keys['$PAGETITLE_URL']      = $this->title->getFullUrl();
-               
+
                $keys['$PAGEMINOREDIT']      = $medit;
                $keys['$PAGESUMMARY']        = $summary;
 
@@ -306,8 +355,8 @@ class EmailNotification {
                # the user has not opted-out and the option is enabled at the
                # global configuration level.
                $name    = $wgUser->getName();
-               $adminAddress = 'WikiAdmin <' . $wgEmergencyContact . '>';
-               $editorAddress = wfRFC822Phrase( $name ) . ' <' . $wgUser->getEmail() . '>';
+               $adminAddress = new MailAddress( $wgEmergencyContact, 'WikiAdmin' );
+               $editorAddress = new MailAddress( $wgUser );
                if( $wgEnotifRevealEditorAddress
                    && ( $wgUser->getEmail() != '' )
                    && $wgUser->getOption( 'enotifrevealaddr' ) ) {
@@ -319,7 +368,7 @@ class EmailNotification {
                        }
                } else {
                        $from    = $adminAddress;
-                       $replyto = $wgNoReplyAddress;
+                       $replyto = new MailAddress( $wgNoReplyAddress );
                }
 
                if( $wgUser->isIP( $name ) ) {
@@ -330,7 +379,7 @@ class EmailNotification {
                } else {
                        $subject = str_replace('$PAGEEDITOR', $name, $subject);
                        $keys['$PAGEEDITOR']          = $name;
-                       $emailPage = Title::makeTitle( NS_SPECIAL, 'Emailuser/' . $name );
+                       $emailPage = SpecialPage::getSafeTitleFor( 'Emailuser', $name );
                        $keys['$PAGEEDITOR_EMAIL'] = $emailPage->getFullUrl();
                }
                $userPage = $wgUser->getUserPage();
@@ -355,18 +404,18 @@ class EmailNotification {
         * @param User $watchingUser
         * @param object $mail
         * @return bool
-        * @access private
+        * @private
         */
        function composeAndSendPersonalisedMail( $watchingUser ) {
                global $wgLang;
                // 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.
-               $to = $watchingUser->getEmail();
+               $to = new MailAddress( $watchingUser );
                $body = str_replace( '$WATCHINGUSERNAME', $watchingUser->getName() , $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