<?php
+/**
+ * UserMailer.php
+ * Copyright (C) 2004 Thomas Gries <mail@tgries.de>
+ * http://www.mediawiki.org/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @author <brion@pobox.com>
+ * @author <mail@tgries.de>
+ *
+ * @package MediaWiki
+ */
-# 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.
-function userMailer( $to, $from, $subject, $body )
-{
- global $wgUser, $wgSMTP, $wgOutputEncoding, $wgErrorString;
-
- $qto = wfQuotedPrintable( $to );
+require_once( 'WikiError.php' );
+
+/**
+ * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
+ */
+function wfRFC822Phrase( $phrase ) {
+ $phrase = strtr( $phrase, array( "\r" => '', "\n" => '', '"' => '' ) );
+ return '"' . $phrase . '"';
+}
+
+/**
+ * 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)
+ */
+function userMailer( $to, $from, $subject, $body, $replyto=false ) {
+ global $wgUser, $wgSMTP, $wgOutputEncoding, $wgErrorString, $wgEmergencyContact;
- if (is_array( $wgSMTP ))
- {
+ if (is_array( $wgSMTP )) {
require_once( 'Mail.php' );
$timestamp = time();
$headers['From'] = $from;
-/* removing to: field as it should be set by the send() function below
- UNTESTED - Hashar */
-// $headers["To"] = $qto;
- $headers['Subject"] = $subject;
+ if ( $replyto ) {
+ $headers['Reply-To'] = $replyto;
+ }
+ $headers['Subject'] = $subject;
$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['X-Mailer'] = 'MediaWiki interuser e-mailer';
+ $headers['X-Mailer'] = 'MediaWiki mailer';
// Create the mail object using the Mail::factory method
$mail_object =& Mail::factory('smtp', $wgSMTP);
return $mailResult->getMessage();
else
return 'Mail object return unknown error.';
- }
-
- else
- {
+ } 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)
$headers =
"MIME-Version: 1.0\n" .
"Content-type: text/plain; charset={$wgOutputEncoding}\n" .
- "Content-transfer-encoding: 8bit\n" .
- "From: {$from}\n" .
- "X-Mailer: MediaWiki interuser e-mailer";
+ "Content-Transfer-Encoding: 8bit\n" .
+ "X-Mailer: MediaWiki mailer\n".
+ 'From: ' . $from . "\n";
+ if ($replyto) {
+ $headers .= "Reply-To: $replyto\n";
+ }
$wgErrorString = '';
set_error_handler( 'mailErrorHandler' );
- mail( $to, $subject, $body, $headers );
+ # added -f parameter, see PHP manual for the fifth parameter when using the mail function
+ mail( $to, $subject, $body, $headers, "-f{$wgEmergencyContact}\n");
restore_error_handler();
+ if ( $wgErrorString ) {
+ wfDebug( "Error sending mail: $wgErrorString\n" );
+ }
return $wgErrorString;
}
}
+/**
+ * @todo document
+ */
function mailErrorHandler( $code, $string ) {
global $wgErrorString;
$wgErrorString = preg_replace( "/^mail\(\): /", "", $string );
}
+
+/**
+ * This module processes the email notifications when the current page is
+ * changed. It looks up the table watchlist to find out which users are watching
+ * that page.
+ *
+ * The current implementation sends independent emails to each watching user for
+ * the following reason:
+ *
+ * - Each watching user will be notified about the page edit time expressed in
+ * his/her local time (UTC is shown additionally). To achieve this, we need to
+ * find the individual timeoffset of each watching user from the preferences..
+ *
+ * Suggested improvement to slack down the number of sent emails: We could think
+ * of sending out bulk mails (bcc:user1,user2...) for all these users having the
+ * same timeoffset in their preferences.
+ *
+ * Visit the documentation pages under http://meta.wikipedia.com/Enotif
+ *
+ * @package MediaWiki
+ *
+ */
+class EmailNotification {
+ /**#@+
+ * @access private
+ */
+ var $to, $subject, $body, $replyto, $from;
+ var $user, $title, $timestamp, $summary, $minorEdit, $oldid;
+
+ /**#@-*/
+
+ /**
+ * @todo document
+ * @param $currentPage
+ * @param $currentNs
+ * @param $timestamp
+ * @param $currentSummary
+ * @param $currentMinorEdit
+ * @param $oldid (default: false)
+ */
+ function notifyOnPageChange(&$title, $timestamp, $summary, $minorEdit, $oldid=false) {
+
+ # we use $wgEmergencyContact as sender's address
+ global $wgUser, $wgLang, $wgEmergencyContact;
+ global $wgEnotifWatchlist, $wgEnotifMinorEdits;
+ global $wgEnotifUserTalk;
+ global $wgEnotifRevealEditorAddress;
+ global $wgEnotifFromEditor;
+ global $wgEmailAuthentication;
+
+ # 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);
+ $enotifusertalkpage = ($isUserTalkPage && $wgEnotifUserTalk);
+ $enotifwatchlistpage = (!$isUserTalkPage && $wgEnotifWatchlist);
+
+ if ( ($enotifusertalkpage || $enotifwatchlistpage)
+ && (!$minorEdit || $wgEnotifMinorEdits) ) {
+
+ $dbr =& wfGetDB( DB_MASTER );
+ extract( $dbr->tableNames( 'watchlist' ) );
+ $sql = "SELECT wl_user FROM $watchlist
+ WHERE wl_title='" . $dbr->strencode($title->getDBkey()).
+ "' AND wl_namespace = " . $title->getNamespace() .
+ " AND wl_user <>" . $wgUser->getID() . " AND wl_notificationtimestamp <= 1";
+ $res = $dbr->query( $sql,'UserMailer::NotifyOnChange');
+
+ # if anyone is watching ... set up the email message text which is
+ # common for all receipients ...
+ if ( $dbr->numRows( $res ) > 0 ) {
+ $this->user &= $wgUser;
+ $this->title =& $title;
+ $this->timestamp = $timestamp;
+ $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') )
+ && (!$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
+ # 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, ...
+ # ... no matter, if the watching user has or has not indicated an email address in his/her preferences.
+ # We memorise the event of sending out a notification and use this as a flag to suppress further mails for changes on the same page for that watching user
+ $dbw =& wfGetDB( DB_MASTER );
+ $succes = $dbw->update( 'watchlist',
+ array( /* SET */
+ 'wl_notificationtimestamp' => $timestamp
+ ), array( /* WHERE */
+ 'wl_title' => $title->getDBkey(),
+ 'wl_namespace' => $title->getNamespace(),
+ 'wl_user' => $wuser->wl_user
+ ), 'UserMailer::NotifyOnChange'
+ );
+ } # for every watching user
+ } # if anyone is watching
+ } # if $wgEnotifWatchlist = true
+ } # function NotifyOnChange
+
+ /**
+ * @access private
+ */
+ function composeCommonMailtext() {
+ global $wgLang, $wgUser, $wgEmergencyContact;
+ global $wgEnotifRevealEditorAddress;
+ global $wgEnotifFromEditor;
+ global $wgNoReplyAddress;
+
+ $summary = ($this->summary == '') ? ' - ' : $this->summary;
+ $medit = ($this->minorEdit) ? wfMsg( '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
+
+ $to = wfMsgForContent( 'enotif_to' );
+ $subject = wfMsgForContent( 'enotif_subject' );
+ $body = wfMsgForContent( 'enotif_body' );
+ $from = ''; /* fail safe */
+ $replyto = ''; /* fail safe */
+ $keys = array();
+
+ # regarding the use of oldid as an indicator for the last visited version, see also
+ # http://bugzilla.wikipeda.org/show_bug.cgi?id=603 "Delete + undelete cycle doesn't preserve old_id"
+ # However, in the case of a new page which is already watched, we have no previous version to compare
+ if( $this->oldid ) {
+ $keys['$NEWPAGE'] = wfMsgForContent( 'enotif_lastvisited' );
+ $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' );
+ }
+
+ $body = strtr( $body, $keys );
+ $pagetitle = $this->title->getPrefixedText();
+
+ $keys['%24PAGETITLE_RAWURL'] = wfUrlencode( $pagetitle );
+ $keys['$PAGETITLE_RAWURL'] = wfUrlencode( $pagetitle );
+ $keys['%24PAGETITLE'] = $pagetitle; # needed for the {{localurl:$PAGETITLE}} in the messagetext, "$" appears here as "%24"
+ $keys['$PAGETITLE'] = $pagetitle;
+ $keys['$PAGETIMESTAMP'] = $article->mTimestamp; # this is the raw internal timestamp - can be useful, too
+ $keys['$PAGEEDITDATEUTC'] = $wgLang->timeanddate( $article->mTimestamp, false, false, false );
+ $keys['$PAGEMINOREDIT'] = $medit;
+ $keys['$PAGESUMMARY'] = $summary;
+
+ $subject = strtr( $subject, $keys );
+
+ # 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.
+ $name = $wgUser->getName();
+ $adminAddress = 'WikiAdmin <' . $wgEmergencyContact . '>';
+ $editorAddress = wfRFC822Phrase( $name ) . ' <' . $wgUser->getEmail() . '>';
+ if( $wgEnotifRevealEditorAddress
+ && ( $wgUser->getEmail() != '' )
+ && $wgUser->getOption( 'enotifrevealaddr' ) ) {
+ if( $wgEnotifFromEditor ) {
+ $from = $editorAddress;
+ } else {
+ $from = $adminAddress;
+ $replyto = $editorAddress;
+ }
+ $keys['$PAGEEDITORNAMEANDEMAILADDR'] = $editorAddress;
+ } else {
+ $from = $adminAddress;
+ $replyto = $wgNoReplyAddress;
+ $keys['$PAGEEDITORNAMEANDEMAILADDR'] = $replyto;
+ }
+
+ if( $wgUser->isIP( $name ) ) {
+ #real anon (user:xxx.xxx.xxx.xxx)
+ $anon = $name . ' (anonymous user)';
+ $anonUrl = wfUrlencode( $name ) . ' (anonymous user)';
+ $subject = str_replace('$PAGEEDITOR', 'anonymous user '. $name, $subject);
+
+ $keys['$PAGEEDITOR_RAWURL'] = $anonUrl;
+ $keys['%24PAGEEDITOR_RAWURL'] = $anonUrl;
+ $keys['%24PAGEEDITORE'] = $anon;
+ $keys['$PAGEEDITORE'] = $anon;
+ $keys['$PAGEEDITOR'] = 'anonymous user ' . $name;
+ } else {
+ $subject = str_replace('$PAGEEDITOR', $name, $subject);
+ $keys['$PAGEEDITOR_RAWURL'] = wfUrlencode( $name );
+ $keys['%24PAGEEDITOR_RAWURL'] = wfUrlencode( $name );
+ $keys['%24PAGEEDITORE'] = $wgUser->getTitleKey();
+ $keys['$PAGEEDITORE'] = $wgUser->getTitleKey();
+ $keys['$PAGEEDITOR'] = $name;
+ }
+ $body = strtr( $body, $keys );
+
+ # now save this as the constant user-independent part of the message
+ $this->to = $to;
+ $this->from = $from;
+ $this->replyto = $replyto;
+ $this->subject = $subject;
+ $this->body = $body;
+ }
+
+
+
+ /**
+ * Does the per-user customizations to a notification e-mail (name,
+ * timestamp in proper timezone, etc) and sends it out.
+ * Returns true if the mail was sent successfully.
+ *
+ * @param User $watchingUser
+ * @param object $mail
+ * @return bool
+ * @access 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();
+ $body = str_replace( '$WATCHINGUSERNAME', $watchingUser->getName() , $this->body );
+ $body = str_replace( '$WATCHINGUSEREMAILADDR', $watchingUser->getEmail(), $body );
+
+ $timecorrection = $watchingUser->getOption( 'timecorrection' );
+ if( !$timecorrection ) {
+ # fail safe - I prefer it. TomGries
+ $timecorrection = '00:00';
+ }
+ # $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('$PAGEEDITDATE',
+ $wgLang->timeanddate( $this->timestamp, true, false, $timecorrection ),
+ $body);
+
+ $error = userMailer( $to, $this->from, $this->subject, $body, $this->replyto );
+ return ($error == '');
+ }
+
+} # end of class EmailNotification
?>
dépôts / lhc / web / wiklou.git / blobdiff