includes/mail/UserMailer.php

   1 <?php
   2 /**
   3  * Classes used to send e-mails
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @author <brion@pobox.com>
  22  * @author <mail@tgries.de>
  23  * @author Tim Starling
  24  * @author Luke Welling lwelling@wikimedia.org
  25  */
  26
  27 /**
  28  * Collection of static functions for sending mail
  29  */
  30 class UserMailer {
  31         private static $mErrorString;
  32
  33         /**
  34          * Send mail using a PEAR mailer
  35          *
  36          * @param UserMailer $mailer
  37          * @param string $dest
  38          * @param string $headers
  39          * @param string $body
  40          *
  41          * @return Status
  42          */
  43         protected static function sendWithPear( $mailer, $dest, $headers, $body ) {
  44                 $mailResult = $mailer->send( $dest, $headers, $body );
  45
  46                 # Based on the result return an error string,
  47                 if ( PEAR::isError( $mailResult ) ) {
  48                         wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() . "\n" );
  49                         return Status::newFatal( 'pear-mail-error', $mailResult->getMessage() );
  50                 } else {
  51                         return Status::newGood();
  52                 }
  53         }
  54
  55         /**
  56          * Creates a single string from an associative array
  57          *
  58          * @param array $headers Associative Array: keys are header field names,
  59          *                 values are ... values.
  60          * @param string $endl The end of line character.  Defaults to "\n"
  61          *
  62          * Note RFC2822 says newlines must be CRLF (\r\n)
  63          * but php mail naively "corrects" it and requires \n for the "correction" to work
  64          *
  65          * @return string
  66          */
  67         static function arrayToHeaderString( $headers, $endl = "\n" ) {
  68                 $strings = array();
  69                 foreach ( $headers as $name => $value ) {
  70                         // Prevent header injection by stripping newlines from value
  71                         $value = self::sanitizeHeaderValue( $value );
  72                         $strings[] = "$name: $value";
  73                 }
  74                 return implode( $endl, $strings );
  75         }
  76
  77         /**
  78          * Create a value suitable for the MessageId Header
  79          *
  80          * @return string
  81          */
  82         static function makeMsgId() {
  83                 global $wgSMTP, $wgServer;
  84
  85                 $msgid = uniqid( wfWikiID() . ".", true ); /* true required for cygwin */
  86                 if ( is_array( $wgSMTP ) && isset( $wgSMTP['IDHost'] ) && $wgSMTP['IDHost'] ) {
  87                         $domain = $wgSMTP['IDHost'];
  88                 } else {
  89                         $url = wfParseUrl( $wgServer );
  90                         $domain = $url['host'];
  91                 }
  92                 return "<$msgid@$domain>";
  93         }
  94
  95         /**
  96          * This function will perform a direct (authenticated) login to
  97          * a SMTP Server to use for mail relaying if 'wgSMTP' specifies an
  98          * array of parameters. It requires PEAR:Mail to do that.
  99          * Otherwise it just uses the standard PHP 'mail' function.
 100          *
 101          * @param MailAddress|MailAddress[] $to Recipient's email (or an array of them)
 102          * @param MailAddress $from Sender's email
 103          * @param string $subject Email's subject.
 104          * @param string $body Email's text or Array of two strings to be the text and html bodies
 105          * @param array $options:
 106          *              'replyTo' MailAddress
 107          *              'contentType' string default 'text/plain; charset=UTF-8'
 108          *
 109          * Previous versions of this function had $replyto as the 5th argument and $contentType
 110          * as the 6th. These are still supported for backwards compatability, but deprecated.
 111          *
 112          * @throws MWException
 113          * @throws Exception
 114          * @return Status
 115          */
 116         public static function send( $to, $from, $subject, $body, $options = array() ) {
 117                 global $wgSMTP, $wgEnotifMaxRecips, $wgAdditionalMailParams, $wgAllowHTMLEmail;
 118                 $contentType = 'text/plain; charset=UTF-8';
 119                 if ( is_array( $options ) ) {
 120                         $replyto = isset( $options['replyTo'] ) ? $options['replyTo'] : null;
 121                         $contentType = isset( $options['contentType'] ) ? $options['contentType'] : $contentType;
 122                 } else {
 123                         // Old calling style
 124                         wfDeprecated( __METHOD__ . ' with $replyto as 5th parameter', '1.26' );
 125                         $replyto = $options;
 126                         if ( func_num_args() === 6 ) {
 127                                 $contentType = func_get_arg( 5 );
 128                         }
 129                 }
 130
 131                 $mime = null;
 132                 if ( !is_array( $to ) ) {
 133                         $to = array( $to );
 134                 }
 135
 136                 // mail body must have some content
 137                 $minBodyLen = 10;
 138                 // arbitrary but longer than Array or Object to detect casting error
 139
 140                 // body must either be a string or an array with text and body
 141                 if (
 142                         !(
 143                                 !is_array( $body ) &&
 144                                 strlen( $body ) >= $minBodyLen
 145                         )
 146                         &&
 147                         !(
 148                                 is_array( $body ) &&
 149                                 isset( $body['text'] ) &&
 150                                 isset( $body['html'] ) &&
 151                                 strlen( $body['text'] ) >= $minBodyLen &&
 152                                 strlen( $body['html'] ) >= $minBodyLen
 153                         )
 154                 ) {
 155                         // if it is neither we have a problem
 156                         return Status::newFatal( 'user-mail-no-body' );
 157                 }
 158
 159                 if ( !$wgAllowHTMLEmail && is_array( $body ) ) {
 160                         // HTML not wanted.  Dump it.
 161                         $body = $body['text'];
 162                 }
 163
 164                 wfDebug( __METHOD__ . ': sending mail to ' . implode( ', ', $to ) . "\n" );
 165
 166                 # Make sure we have at least one address
 167                 $has_address = false;
 168                 foreach ( $to as $u ) {
 169                         if ( $u->address ) {
 170                                 $has_address = true;
 171                                 break;
 172                         }
 173                 }
 174                 if ( !$has_address ) {
 175                         return Status::newFatal( 'user-mail-no-addy' );
 176                 }
 177
 178                 # Forge email headers
 179                 # -------------------
 180                 #
 181                 # WARNING
 182                 #
 183                 # DO NOT add To: or Subject: headers at this step. They need to be
 184                 # handled differently depending upon the mailer we are going to use.
 185                 #
 186                 # To:
 187                 #  PHP mail() first argument is the mail receiver. The argument is
 188                 #  used as a recipient destination and as a To header.
 189                 #
 190                 #  PEAR mailer has a recipient argument which is only used to
 191                 #  send the mail. If no To header is given, PEAR will set it to
 192                 #  to 'undisclosed-recipients:'.
 193                 #
 194                 #  NOTE: To: is for presentation, the actual recipient is specified
 195                 #  by the mailer using the Rcpt-To: header.
 196                 #
 197                 # Subject:
 198                 #  PHP mail() second argument to pass the subject, passing a Subject
 199                 #  as an additional header will result in a duplicate header.
 200                 #
 201                 #  PEAR mailer should be passed a Subject header.
 202                 #
 203                 # -- hashar 20120218
 204
 205                 $headers['From'] = $from->toString();
 206                 $returnPath = $from->address;
 207                 $extraParams = $wgAdditionalMailParams;
 208
 209                 // Hook to generate custom VERP address for 'Return-Path'
 210                 Hooks::run( 'UserMailerChangeReturnPath', array( $to, &$returnPath ) );
 211                 # Add the envelope sender address using the -f command line option when PHP mail() is used.
 212                 # Will default to the $from->address when the UserMailerChangeReturnPath hook fails and the
 213                 # generated VERP address when the hook runs effectively.
 214                 $extraParams .= ' -f ' . $returnPath;
 215
 216                 $headers['Return-Path'] = $returnPath;
 217
 218                 if ( $replyto ) {
 219                         $headers['Reply-To'] = $replyto->toString();
 220                 }
 221
 222                 $headers['Date'] = MWTimestamp::getLocalInstance()->format( 'r' );
 223                 $headers['Message-ID'] = self::makeMsgId();
 224                 $headers['X-Mailer'] = 'MediaWiki mailer';
 225                 $headers['List-Unsubscribe'] = '<' . SpecialPage::getTitleFor( 'Preferences' )
 226                         ->getFullURL( '', false, PROTO_CANONICAL ) . '>';
 227
 228                 # Line endings need to be different on Unix and Windows due to
 229                 # the bug described at http://trac.wordpress.org/ticket/2603
 230                 if ( wfIsWindows() ) {
 231                         $endl = "\r\n";
 232                 } else {
 233                         $endl = "\n";
 234                 }
 235
 236                 if ( is_array( $body ) ) {
 237                         // we are sending a multipart message
 238                         wfDebug( "Assembling multipart mime email\n" );
 239                         if ( !stream_resolve_include_path( 'Mail/mime.php' ) ) {
 240                                 wfDebug( "PEAR Mail_Mime package is not installed. Falling back to text email.\n" );
 241                                 // remove the html body for text email fall back
 242                                 $body = $body['text'];
 243                         } else {
 244                                 require_once 'Mail/mime.php';
 245                                 if ( wfIsWindows() ) {
 246                                         $body['text'] = str_replace( "\n", "\r\n", $body['text'] );
 247                                         $body['html'] = str_replace( "\n", "\r\n", $body['html'] );
 248                                 }
 249                                 $mime = new Mail_mime( array(
 250                                         'eol' => $endl,
 251                                         'text_charset' => 'UTF-8',
 252                                         'html_charset' => 'UTF-8'
 253                                 ) );
 254                                 $mime->setTXTBody( $body['text'] );
 255                                 $mime->setHTMLBody( $body['html'] );
 256                                 $body = $mime->get(); // must call get() before headers()
 257                                 $headers = $mime->headers( $headers );
 258                         }
 259                 }
 260                 if ( $mime === null ) {
 261                         // sending text only, either deliberately or as a fallback
 262                         if ( wfIsWindows() ) {
 263                                 $body = str_replace( "\n", "\r\n", $body );
 264                         }
 265                         $headers['MIME-Version'] = '1.0';
 266                         $headers['Content-type'] = ( is_null( $contentType ) ?
 267                                 'text/plain; charset=UTF-8' : $contentType );
 268                         $headers['Content-transfer-encoding'] = '8bit';
 269                 }
 270
 271                 $ret = Hooks::run( 'AlternateUserMailer', array( $headers, $to, $from, $subject, $body ) );
 272                 if ( $ret === false ) {
 273                         // the hook implementation will return false to skip regular mail sending
 274                         return Status::newGood();
 275                 } elseif ( $ret !== true ) {
 276                         // the hook implementation will return a string to pass an error message
 277                         return Status::newFatal( 'php-mail-error', $ret );
 278                 }
 279
 280                 if ( is_array( $wgSMTP ) ) {
 281                         #
 282                         # PEAR MAILER
 283                         #
 284
 285                         if ( !stream_resolve_include_path( 'Mail.php' ) ) {
 286                                 throw new MWException( 'PEAR mail package is not installed' );
 287                         }
 288                         require_once 'Mail.php';
 289
 290                         MediaWiki\suppressWarnings();
 291
 292                         // Create the mail object using the Mail::factory method
 293                         $mail_object =& Mail::factory( 'smtp', $wgSMTP );
 294                         if ( PEAR::isError( $mail_object ) ) {
 295                                 wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
 296                                 MediaWiki\restoreWarnings();
 297                                 return Status::newFatal( 'pear-mail-error', $mail_object->getMessage() );
 298                         }
 299
 300                         wfDebug( "Sending mail via PEAR::Mail\n" );
 301
 302                         $headers['Subject'] = self::quotedPrintable( $subject );
 303
 304                         # When sending only to one recipient, shows it its email using To:
 305                         if ( count( $to ) == 1 ) {
 306                                 $headers['To'] = $to[0]->toString();
 307                         }
 308
 309                         # Split jobs since SMTP servers tends to limit the maximum
 310                         # number of possible recipients.
 311                         $chunks = array_chunk( $to, $wgEnotifMaxRecips );
 312                         foreach ( $chunks as $chunk ) {
 313                                 $status = self::sendWithPear( $mail_object, $chunk, $headers, $body );
 314                                 # FIXME : some chunks might be sent while others are not!
 315                                 if ( !$status->isOK() ) {
 316                                         MediaWiki\restoreWarnings();
 317                                         return $status;
 318                                 }
 319                         }
 320                         MediaWiki\restoreWarnings();
 321                         return Status::newGood();
 322                 } else {
 323                         #
 324                         # PHP mail()
 325                         #
 326                         if ( count( $to ) > 1 ) {
 327                                 $headers['To'] = 'undisclosed-recipients:;';
 328                         }
 329                         $headers = self::arrayToHeaderString( $headers, $endl );
 330
 331                         wfDebug( "Sending mail via internal mail() function\n" );
 332
 333                         self::$mErrorString = '';
 334                         $html_errors = ini_get( 'html_errors' );
 335                         ini_set( 'html_errors', '0' );
 336                         set_error_handler( 'UserMailer::errorHandler' );
 337
 338                         try {
 339                                 $safeMode = wfIniGetBool( 'safe_mode' );
 340
 341                                 foreach ( $to as $recip ) {
 342                                         if ( $safeMode ) {
 343                                                 $sent = mail( $recip, self::quotedPrintable( $subject ), $body, $headers );
 344                                         } else {
 345                                                 $sent = mail(
 346                                                         $recip,
 347                                                         self::quotedPrintable( $subject ),
 348                                                         $body,
 349                                                         $headers,
 350                                                         $extraParams
 351                                                 );
 352                                         }
 353                                 }
 354                         } catch ( Exception $e ) {
 355                                 restore_error_handler();
 356                                 throw $e;
 357                         }
 358
 359                         restore_error_handler();
 360                         ini_set( 'html_errors', $html_errors );
 361
 362                         if ( self::$mErrorString ) {
 363                                 wfDebug( "Error sending mail: " . self::$mErrorString . "\n" );
 364                                 return Status::newFatal( 'php-mail-error', self::$mErrorString );
 365                         } elseif ( !$sent ) {
 366                                 // mail function only tells if there's an error
 367                                 wfDebug( "Unknown error sending mail\n" );
 368                                 return Status::newFatal( 'php-mail-error-unknown' );
 369                         } else {
 370                                 return Status::newGood();
 371                         }
 372                 }
 373         }
 374
 375         /**
 376          * Set the mail error message in self::$mErrorString
 377          *
 378          * @param int $code Error number
 379          * @param string $string Error message
 380          */
 381         static function errorHandler( $code, $string ) {
 382                 self::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
 383         }
 384
 385         /**
 386          * Strips bad characters from a header value to prevent PHP mail header injection attacks
 387          * @param string $val String to be santizied
 388          * @return string
 389          */
 390         public static function sanitizeHeaderValue( $val ) {
 391                 return strtr( $val, array( "\r" => '', "\n" => '' ) );
 392         }
 393
 394         /**
 395          * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
 396          * @param string $phrase
 397          * @return string
 398          */
 399         public static function rfc822Phrase( $phrase ) {
 400                 // Remove line breaks
 401                 $phrase = self::sanitizeHeaderValue( $phrase );
 402                 // Remove quotes
 403                 $phrase = str_replace( '"', '', $phrase );
 404                 return '"' . $phrase . '"';
 405         }
 406
 407         /**
 408          * Converts a string into quoted-printable format
 409          * @since 1.17
 410          *
 411          * From PHP5.3 there is a built in function quoted_printable_encode()
 412          * This method does not duplicate that.
 413          * This method is doing Q encoding inside encoded-words as defined by RFC 2047
 414          * This is for email headers.
 415          * The built in quoted_printable_encode() is for email bodies
 416          * @param string $string
 417          * @param string $charset
 418          * @return string
 419          */
 420         public static function quotedPrintable( $string, $charset = '' ) {
 421                 # Probably incomplete; see RFC 2045
 422                 if ( empty( $charset ) ) {
 423                         $charset = 'UTF-8';
 424                 }
 425                 $charset = strtoupper( $charset );
 426                 $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
 427
 428                 $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
 429                 $replace = $illegal . '\t ?_';
 430                 if ( !preg_match( "/[$illegal]/", $string ) ) {
 431                         return $string;
 432                 }
 433                 $out = "=?$charset?Q?";
 434                 $out .= preg_replace_callback( "/([$replace])/",
 435                         array( __CLASS__, 'quotedPrintableCallback' ), $string );
 436                 $out .= '?=';
 437                 return $out;
 438         }
 439
 440         protected static function quotedPrintableCallback( $matches ) {
 441                 return sprintf( "=%02X", ord( $matches[1] ) );
 442         }
 443 }