diff options
Diffstat (limited to 'includes/UserMailer.php')
| -rw-r--r-- | includes/UserMailer.php | 334 |
1 files changed, 232 insertions, 102 deletions
diff --git a/includes/UserMailer.php b/includes/UserMailer.php index 63f5bf2e..5d98d9d2 100644 --- a/includes/UserMailer.php +++ b/includes/UserMailer.php @@ -68,7 +68,7 @@ class MailAddress { return $this->address; } } else { - return ''; + return ""; } } @@ -107,6 +107,39 @@ class UserMailer { } /** + * Creates a single string from an associative array + * + * @param $headers 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" ) { + foreach( $headers as $name => $value ) { + $string[] = "$name: $value"; + } + 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 * array of parameters. It requires PEAR:Mail to do that. @@ -120,7 +153,7 @@ class UserMailer { * @param $contentType String: optional custom Content-Type (default: text/plain; charset=UTF-8) * @return Status object */ - public static function send( $to, $from, $subject, $body, $replyto = null, $contentType = 'text/plain; charset=UTF-8') { + public static function send( $to, $from, $subject, $body, $replyto = null, $contentType = 'text/plain; charset=UTF-8' ) { global $wgSMTP, $wgEnotifMaxRecips, $wgAdditionalMailParams; if ( !is_array( $to ) ) { @@ -129,7 +162,73 @@ class UserMailer { 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 { @@ -140,43 +239,6 @@ class UserMailer { } require_once( 'Mail.php' ); - $msgid = str_replace( " ", "_", microtime() ); - if ( function_exists( 'posix_getpid' ) ) { - $msgid .= '.' . posix_getpid(); - } - - if ( is_array( $to ) ) { - $dest = array(); - foreach ( $to as $u ) { - $dest[] = $u->address; - } - } else { - $dest = $to->address; - } - - $headers['From'] = $from->toString(); - $headers['Return-Path'] = $from->address; - - if ( count( $to ) > 1 ) { - $headers['To'] = 'undisclosed-recipients:;'; - } - else { - $headers['To'] = $to[0]->toString(); - } - - 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['X-Mailer'] = 'MediaWiki mailer'; - wfSuppressWarnings(); // Create the mail object using the Mail::factory method @@ -187,10 +249,21 @@ class UserMailer { return Status::newFatal( 'pear-mail-error', $mail_object->getMessage() ); } - wfDebug( "Sending mail via PEAR::Mail to $dest\n" ); - $chunks = array_chunk( (array)$dest, $wgEnotifMaxRecips ); + 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; @@ -199,6 +272,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() ) { @@ -208,18 +285,10 @@ class UserMailer { $endl = "\n"; } - $headers = array( - "MIME-Version: 1.0", - "Content-type: $contentType", - "Content-Transfer-Encoding: 8bit", - "X-Mailer: MediaWiki mailer", - "From: " . $from->toString(), - ); - if ( $replyto ) { - $headers[] = "Reply-To: " . $replyto->toString(); + if( count($to) > 1 ) { + $headers['To'] = 'undisclosed-recipients:;'; } - - $headers = implode( $endl, $headers ); + $headers = self::arrayToHeaderString( $headers, $endl ); wfDebug( "Sending mail via internal mail() function\n" ); @@ -228,11 +297,13 @@ class UserMailer { ini_set( 'html_errors', '0' ); set_error_handler( 'UserMailer::errorHandler' ); - if ( !is_array( $to ) ) { - $to = array( $to ); - } + $safeMode = wfIniGetBool( 'safe_mode' ); foreach ( $to as $recip ) { - $sent = mail( $recip->toString(), self::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams ); + if ( $safeMode ) { + $sent = mail( $recip, self::quotedPrintable( $subject ), $body, $headers ); + } else { + $sent = mail( $recip, self::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams ); + } } restore_error_handler(); @@ -243,7 +314,7 @@ class UserMailer { return Status::newFatal( 'php-mail-error', self::$mErrorString ); } elseif ( ! $sent ) { // mail function only tells if there's an error - wfDebug( "Error sending mail\n" ); + wfDebug( "Unknown error sending mail\n" ); return Status::newFatal( 'php-mail-error-unknown' ); } else { return Status::newGood(); @@ -321,11 +392,21 @@ 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. * @@ -339,7 +420,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; @@ -378,21 +460,39 @@ 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(), - "editorID" => $editor->getID(), - "timestamp" => $timestamp, - "summary" => $summary, - "minorEdit" => $minorEdit, - "oldid" => $oldid, - "watchers" => $watchers ); + '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 ); } - } /** @@ -433,25 +533,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 ) { @@ -471,6 +557,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 ); } @@ -480,6 +570,39 @@ class EmailNotification { } /** + * @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. */ private function composeCommonMailtext() { @@ -494,10 +617,17 @@ class EmailNotification { # simply editing the Meta pages $keys = array(); + $postTransformKeys = array(); if ( $this->oldid ) { - $difflink = $this->title->getCanonicalUrl( 'diff=0&oldid=' . $this->oldid ); - $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited', $difflink ); + 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 { @@ -510,7 +640,6 @@ class EmailNotification { $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() ) { @@ -525,16 +654,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 = 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 = 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 @@ -562,6 +695,7 @@ class EmailNotification { * depending on settings. * * Call sendMails() to send any mails that were queued. + * @param $user User */ function compose( $user ) { global $wgEnotifImpersonal; @@ -601,22 +735,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 ); } @@ -636,8 +766,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 ); |