UserMailer.php

Go to the documentation of this file.

<?php
class MailAddress {
        function __construct( $address, $name = null, $realName = null ) {
                if ( is_object( $address ) && $address instanceof User ) {
                        $this->address = $address->getEmail();
                        $this->name = $address->getName();
                        $this->realName = $address->getRealName();
                } else {
                        $this->address = strval( $address );
                        $this->name = strval( $name );
                        $this->realName = strval( $realName );
                }
        }

        function toString() {
                # PHP's mail() implementation under Windows is somewhat shite, and
                # can't handle "Joe Bloggs <[email protected]>" format email addresses,
                # so don't bother generating them
                if ( $this->address ) {
                        if ( $this->name != '' && !wfIsWindows() ) {
                                global $wgEnotifUseRealName;
                                $name = ( $wgEnotifUseRealName && $this->realName ) ? $this->realName : $this->name;
                                $quoted = UserMailer::quotedPrintable( $name );
                                if ( strpos( $quoted, '.' ) !== false || strpos( $quoted, ',' ) !== false ) {
                                        $quoted = '"' . $quoted . '"';
                                }
                                return "$quoted <{$this->address}>";
                        } else {
                                return $this->address;
                        }
                } else {
                        return "";
                }
        }

        function __toString() {
                return $this->toString();
        }
}


class UserMailer {
        static $mErrorString;

        protected static function sendWithPear( $mailer, $dest, $headers, $body ) {
                $mailResult = $mailer->send( $dest, $headers, $body );

                # Based on the result return an error string,
                if ( PEAR::isError( $mailResult ) ) {
                        wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
                        return Status::newFatal( 'pear-mail-error', $mailResult->getMessage() );
                } else {
                        return Status::newGood();
                }
        }

        static function arrayToHeaderString( $headers, $endl = "\n" ) {
                foreach( $headers as $name => $value ) {
                        $string[] = "$name: $value";
                }
                return implode( $endl, $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>";
        }

        public static function send( $to, $from, $subject, $body, $replyto = null, $contentType = 'text/plain; charset=UTF-8' ) {
                global $wgSMTP, $wgEnotifMaxRecips, $wgAdditionalMailParams;

                if ( !is_array( $to ) ) {
                        $to = array( $to );
                }

                wfDebug( __METHOD__ . ': sending mail to ' . implode( ', ', $to ) . "\n" );

                # Make sure we have at least one address
                $has_address = false;
                foreach ( $to as $u ) {
                        if ( $u->address ) {
                                $has_address = true;
                                break;
                        }
                }
                if ( !$has_address ) {
                        return Status::newFatal( 'user-mail-no-addy' );
                }

                # 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['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';

                $headers['Message-ID'] = self::makeMsgId();
                $headers['X-Mailer'] = 'MediaWiki mailer';

                $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 ) ) {
                        #
                        # PEAR MAILER
                        # 

                        if ( function_exists( 'stream_resolve_include_path' ) ) {
                                $found = stream_resolve_include_path( 'Mail.php' );
                        } else {
                                $found = Fallback::stream_resolve_include_path( 'Mail.php' );
                        }
                        if ( !$found ) {
                                throw new MWException( 'PEAR mail package is not installed' );
                        }
                        require_once( 'Mail.php' );

                        wfSuppressWarnings();

                        // Create the mail object using the Mail::factory method
                        $mail_object =& Mail::factory( 'smtp', $wgSMTP );
                        if ( PEAR::isError( $mail_object ) ) {
                                wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
                                wfRestoreWarnings();
                                return Status::newFatal( 'pear-mail-error', $mail_object->getMessage() );
                        }

                        wfDebug( "Sending mail via PEAR::Mail\n" );

                        $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;
                                }
                        }
                        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() ) {
                                $body = str_replace( "\n", "\r\n", $body );
                                $endl = "\r\n";
                        } else {
                                $endl = "\n";
                        }

                        if( count($to) > 1 ) {
                                $headers['To'] = 'undisclosed-recipients:;';
                        }
                        $headers = self::arrayToHeaderString( $headers, $endl );

                        wfDebug( "Sending mail via internal mail() function\n" );

                        self::$mErrorString = '';
                        $html_errors = ini_get( 'html_errors' );
                        ini_set( 'html_errors', '0' );
                        set_error_handler( 'UserMailer::errorHandler' );

                        $safeMode = wfIniGetBool( 'safe_mode' );
                        foreach ( $to 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();
                        ini_set( 'html_errors', $html_errors );

                        if ( self::$mErrorString ) {
                                wfDebug( "Error sending mail: " . self::$mErrorString . "\n" );
                                return Status::newFatal( 'php-mail-error', self::$mErrorString );
                        } elseif ( ! $sent ) {
                                // mail function only tells if there's an error
                                wfDebug( "Unknown error sending mail\n" );
                                return Status::newFatal( 'php-mail-error-unknown' );
                        } else {
                                return Status::newGood();
                        }
                }
        }

        static function errorHandler( $code, $string ) {
                self::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
        }

        public static function rfc822Phrase( $phrase ) {
                $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
                return '"' . $phrase . '"';
        }

        public static function quotedPrintable( $string, $charset = '' ) {
                # Probably incomplete; see RFC 2045
                if( empty( $charset ) ) {
                        $charset = 'UTF-8';
                }
                $charset = strtoupper( $charset );
                $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?

                $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
                $replace = $illegal . '\t ?_';
                if( !preg_match( "/[$illegal]/", $string ) ) {
                        return $string;
                }
                $out = "=?$charset?Q?";
                $out .= preg_replace_callback( "/([$replace])/",
                        array( __CLASS__, 'quotedPrintableCallback' ), $string );
                $out .= '?=';
                return $out;
        }

        protected static function quotedPrintableCallback( $matches ) {
                return sprintf( "=%02X", ord( $matches[1] ) );
        }
}

class EmailNotification {
        protected $subject, $body, $replyto, $from;
        protected $timestamp, $summary, $minorEdit, $oldid, $composed_common;
        protected $mailTargets = array();

        protected $title;

        protected $editor;

        public function notifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid = false ) {
                global $wgEnotifUseJobQ, $wgEnotifWatchlist, $wgShowUpdatedMarker, $wgEnotifMinorEdits,
                        $wgUsersNotifiedOnAllChanges, $wgEnotifUserTalk;

                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__
                        );
                        foreach ( $res as $row ) {
                                $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();
                        }
                }

                $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(),
                                'editorID' => $editor->getID(),
                                'timestamp' => $timestamp,
                                'summary' => $summary,
                                'minorEdit' => $minorEdit,
                                'oldid' => $oldid,
                                'watchers' => $watchers
                        );
                        $job = new EnotifNotifyJob( $title, $params );
                        $job->insert();
                } else {
                        $this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
                }
        }

        public function actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers ) {
                # we use $wgPasswordSender as sender's address
                global $wgEnotifWatchlist;
                global $wgEnotifMinorEdits, $wgEnotifUserTalk;

                wfProfileIn( __METHOD__ );

                # The following code is only run, if several conditions are met:
                # 1. EmailNotification for pages (other than user_talk pages) must be enabled
                # 2. minor edits (changes) are only regarded if the global flag indicates so

                $isUserTalkPage = ( $title->getNamespace() == NS_USER_TALK );

                $this->title = $title;
                $this->timestamp = $timestamp;
                $this->summary = $summary;
                $this->minorEdit = $minorEdit;
                $this->oldid = $oldid;
                $this->editor = $editor;
                $this->composed_common = false;

                $userTalkId = false;

                if ( !$minorEdit || ( $wgEnotifMinorEdits && !$editor->isAllowed( 'nominornewtalk' ) ) ) {

                        if ( $wgEnotifUserTalk && $isUserTalkPage && $this->canSendUserTalkEmail( $editor, $title, $minorEdit ) ) {
                                $targetUser = User::newFromName( $title->getText() );
                                $this->compose( $targetUser );
                                $userTalkId = $targetUser->getId();
                        }

                        if ( $wgEnotifWatchlist ) {
                                // Send updates to watchers other than the current editor
                                $userArray = UserArray::newFromIDs( $watchers );
                                foreach ( $userArray as $watchingUser ) {
                                        if ( $watchingUser->getOption( 'enotifwatchlistpages' ) &&
                                                ( !$minorEdit || $watchingUser->getOption( 'enotifminoredits' ) ) &&
                                                $watchingUser->isEmailConfirmed() &&
                                                $watchingUser->getID() != $userTalkId )
                                        {
                                                $this->compose( $watchingUser );
                                        }
                                }
                        }
                }

                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 );
                }

                $this->sendMails();
                wfProfileOut( __METHOD__ );
        }

        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;
        }

        private function composeCommonMailtext() {
                global $wgPasswordSender, $wgPasswordSenderName, $wgNoReplyAddress;
                global $wgEnotifFromEditor, $wgEnotifRevealEditorAddress;
                global $wgEnotifImpersonal, $wgEnotifUseRealName;

                $this->composed_common = true;

                # 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

                $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 ) );
                        }
                        $keys['$OLDID']   = $this->oldid;
                        $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'changed' );
                } else {
                        $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_newpagetext' );
                        # clear $OLDID placeholder in the message template
                        $keys['$OLDID']   = '';
                        $keys['$CHANGEDORCREATED'] = wfMsgForContent( 'created' );
                }

                $keys['$PAGETITLE'] = $this->title->getPrefixedText();
                $keys['$PAGETITLE_URL'] = $this->title->getCanonicalUrl();
                $keys['$PAGEMINOREDIT'] = $this->minorEdit ? wfMsgForContent( 'minoredit' ) : '';
                $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();
                }

                $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 = strtr( $subject, $keys );
                $subject = MessageCache::singleton()->transform( $subject, false, null, $this->title );
                $this->subject = strtr( $subject, $postTransformKeys );

                $body = wfMsgExt( 'enotif_body', 'content' );
                $body = strtr( $body, $keys );
                $body = MessageCache::singleton()->transform( $body, false, null, $this->title );
                $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
                # global configuration level.
                $adminAddress = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
                if ( $wgEnotifRevealEditorAddress
                        && ( $this->editor->getEmail() != '' )
                        && $this->editor->getOption( 'enotifrevealaddr' ) )
                {
                        $editorAddress = new MailAddress( $this->editor );
                        if ( $wgEnotifFromEditor ) {
                                $this->from    = $editorAddress;
                        } else {
                                $this->from    = $adminAddress;
                                $this->replyto = $editorAddress;
                        }
                } else {
                        $this->from    = $adminAddress;
                        $this->replyto = new MailAddress( $wgNoReplyAddress );
                }
        }

        function compose( $user ) {
                global $wgEnotifImpersonal;

                if ( !$this->composed_common )
                        $this->composeCommonMailtext();

                if ( $wgEnotifImpersonal ) {
                        $this->mailTargets[] = new MailAddress( $user );
                } else {
                        $this->sendPersonalised( $user );
                }
        }

        function sendMails() {
                global $wgEnotifImpersonal;
                if ( $wgEnotifImpersonal ) {
                        $this->sendImpersonal( $this->mailTargets );
                }
        }

        function sendPersonalised( $watchingUser ) {
                global $wgContLang, $wgEnotifUseRealName;
                // From the PHP manual:
                //     Note:  The to parameter cannot be an address in the form of "Something <[email protected]>".
                //     The mail command will not parse this properly while talking with the MTA.
                $to = new MailAddress( $watchingUser );

                # $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( '$WATCHINGUSERNAME',
                                '$PAGEEDITDATE',
                                '$PAGEEDITTIME' ),
                        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 );
        }

        function sendImpersonal( $addresses ) {
                global $wgContLang;

                if ( empty( $addresses ) )
                        return;

                $body = str_replace(
                                array( '$WATCHINGUSERNAME',
                                        '$PAGEEDITDATE',
                                        '$PAGEEDITTIME' ),
                                array( wfMsgForContent( 'enotif_impersonal_salutation' ),
                                        $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 );
        }

} # end of class EmailNotification