/**
* 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 );
}
/**
* @return String
*/
static function makeMsgId() {
- global $wgServer;
+ global $wgSMTP, $wgServer;
- $msgid = uniqid( "UserMailer", true ); /* true required for cygwin */
- return "<$msgid@$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>";
}
/**
* @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;
- }
+ # 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 ) ?
$headers['Message-ID'] = self::makeMsgId();
$headers['X-Mailer'] = 'MediaWiki mailer';
- $headers['From'] = $from->toString();
- $ret = wfRunHooks( 'AlternateUserMailer', array( $headers, $to, $from, $subject, $body, $replyto, $contentType ) );
+ $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 {
}
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;
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() ) {
$endl = "\n";
}
+ if( count($to) > 1 ) {
+ $headers['To'] = 'undisclosed-recipients:;';
+ }
$headers = self::arrayToHeaderString( $headers, $endl );
wfDebug( "Sending mail via internal mail() function\n" );
ini_set( 'html_errors', '0' );
set_error_handler( 'UserMailer::errorHandler' );
- foreach ( $dest as $recip ) {
- $sent = mail( $recip, self::quotedPrintable( $subject ), $body, $headers, $wgAdditionalMailParams );
+ $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();
/**
* Converts a string into quoted-printable format
* @since 1.17
+ * @return string
*/
public static function quotedPrintable( $string, $charset = '' ) {
# Probably incomplete; see RFC 2045
*
*/
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.
* @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;
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 )
'wl_user' => $watchers
), __METHOD__
);
- $dbw->commit();
+ $dbw->commit( __METHOD__ );
}
}
+ $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(),
} else {
$this->actuallyNotifyOnPageChange( $editor, $title, $timestamp, $summary, $minorEdit, $oldid, $watchers );
}
-
}
/**
$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 ) {
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 );
}
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.
*/
$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();
+ $postTransformKeys = 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 {
$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['$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();
+
+ # Replace this after transforming the message, bug 35019
+ $postTransformKeys['$PAGESUMMARY'] = $this->summary == '' ? ' - ' : $this->summary;
- $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 );
+ $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.
- $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 );
+ $this->from = $adminAddress;
+ $this->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();
- }
- $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;
}
/**
* depending on settings.
*
* Call sendMails() to send any mails that were queued.
+ * @param $user User
*/
function compose( $user ) {
global $wgEnotifImpersonal;
// 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 );
}
/**
* Same as sendPersonalised but does impersonal mail suitable for bulk
* mailing. Takes an array of MailAddress objects.
+ * @return Status
*/
function sendImpersonal( $addresses ) {
global $wgContLang;
'$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 );
dépôts / lhc / web / wiklou.git / blobdiff