*
* 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>
* @package MediaWiki
*/
-require_once( 'WikiError.php' );
-
/**
* Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
*/
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 MailAddress( $address, $name=null ) {
+ if( is_object( $address ) && is_a( $address, '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() {
+ if( $this->name != '' ) {
+ $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: false).
*/
function userMailer( $to, $from, $subject, $body, $replyto=false ) {
global $wgUser, $wgSMTP, $wgOutputEncoding, $wgErrorString;
require_once( 'Mail.php' );
$timestamp = time();
+ $dest = $to->address;
- $headers['From'] = $from;
+ $headers['From'] = $from->toString();
+ $headers['To'] = $to->toString();
if ( $replyto ) {
$headers['Reply-To'] = $replyto;
}
- $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);
+ 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) {
return '';
} elseif (is_object($mailResult)) {
+ wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
return $mailResult->getMessage();
} else {
+ wfDebug( "PEAR::Mail failed, unknown error result\n" );
return 'Mail object return unknown error.';
}
} else {
"Content-type: text/plain; charset={$wgOutputEncoding}\n" .
"Content-Transfer-Encoding: 8bit\n" .
"X-Mailer: MediaWiki mailer\n".
- 'From: ' . $from . "\n";
+ 'From: ' . $from->toString() . "\n";
if ($replyto) {
$headers .= "Reply-To: $replyto\n";
}
+ $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 ) {
/**
* 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;
*
*/
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) {
if( $userCondition ) {
$dbr =& wfGetDB( DB_MASTER );
extract( $dbr->tableNames( 'watchlist' ) );
-
+
$res = $dbr->select( 'watchlist', array( 'wl_user' ),
array(
'wl_title' => $title->getDBkey(),
$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 ) {
$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') ) ||
# ... 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
}
}
);
# FIXME what do we do on failure ?
}
-
+ wfProfileOut( $fname );
} # function NotifyOnChange
/**
- * @access private
+ * @private
*/
function composeCommonMailtext() {
global $wgUser, $wgEmergencyContact, $wgNoReplyAddress;
$pagetitle = $this->title->getPrefixedText();
$keys['$PAGETITLE'] = $pagetitle;
$keys['$PAGETITLE_URL'] = $this->title->getFullUrl();
-
+
$keys['$PAGEMINOREDIT'] = $medit;
$keys['$PAGESUMMARY'] = $summary;
# 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' ) ) {
* @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