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 = PHP_EOL ) {
  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          *              'headers' array Extra headers to set
 109          *
 110          * Previous versions of this function had $replyto as the 5th argument and $contentType
 111          * as the 6th. These are still supported for backwards compatability, but deprecated.
 112          *
 113          * @throws MWException
 114          * @throws Exception
 115          * @return Status
 116          */
 117         public static function send( $to, $from, $subject, $body, $options = array() ) {
 118                 global $wgAllowHTMLEmail;
 119                 $contentType = 'text/plain; charset=UTF-8';
 120                 if ( !is_array( $options ) ) {
 121                         // Old calling style
 122                         wfDeprecated( __METHOD__ . ' with $replyto as 5th parameter', '1.26' );
 123                         $options = array( 'replyTo' => $options );
 124                         if ( func_num_args() === 6 ) {
 125                                 $options['contentType'] = func_get_arg( 5 );
 126                         }
 127                 }
 128
 129                 if ( !is_array( $to ) ) {
 130                         $to = array( $to );
 131                 }
 132
 133                 // mail body must have some content
 134                 $minBodyLen = 10;
 135                 // arbitrary but longer than Array or Object to detect casting error
 136
 137                 // body must either be a string or an array with text and body
 138                 if (
 139                         !(
 140                                 !is_array( $body ) &&
 141                                 strlen( $body ) >= $minBodyLen
 142                         )
 143                         &&
 144                         !(
 145                                 is_array( $body ) &&
 146                                 isset( $body['text'] ) &&
 147                                 isset( $body['html'] ) &&
 148                                 strlen( $body['text'] ) >= $minBodyLen &&
 149                                 strlen( $body['html'] ) >= $minBodyLen
 150                         )
 151                 ) {
 152                         // if it is neither we have a problem
 153                         return Status::newFatal( 'user-mail-no-body' );
 154                 }
 155
 156                 if ( !$wgAllowHTMLEmail && is_array( $body ) ) {
 157                         // HTML not wanted.  Dump it.
 158                         $body = $body['text'];
 159                 }
 160
 161                 wfDebug( __METHOD__ . ': sending mail to ' . implode( ', ', $to ) . "\n" );
 162
 163                 // Make sure we have at least one address
 164                 $has_address = false;
 165                 foreach ( $to as $u ) {
 166                         if ( $u->address ) {
 167                                 $has_address = true;
 168                                 break;
 169                         }
 170                 }
 171                 if ( !$has_address ) {
 172                         return Status::newFatal( 'user-mail-no-addy' );
 173                 }
 174
 175                 // give a chance to UserMailerTransformContents subscribers who need to deal with each
 176                 // target differently to split up the address list
 177                 if ( count( $to ) > 1 ) {
 178                         $oldTo = $to;
 179                         Hooks::run( 'UserMailerSplitTo', array( &$to ) );
 180                         if ( $oldTo != $to ) {
 181                                 $splitTo = array_diff( $oldTo, $to );
 182                                 $to = array_diff( $oldTo, $splitTo ); // ignore new addresses added in the hook
 183                                 // first send to non-split address list, then to split addresses one by one
 184                                 $status = Status::newGood();
 185                                 if ( $to ) {
 186                                         $status->merge( UserMailer::sendInternal(
 187                                                 $to, $from, $subject, $body, $options ) );
 188                                 }
 189                                 foreach ( $splitTo as $newTo ) {
 190                                         $status->merge( UserMailer::sendInternal(
 191                                                 array( $newTo ), $from, $subject, $body, $options ) );
 192                                 }
 193                                 return $status;
 194                         }
 195                 }
 196
 197                 return UserMailer::sendInternal( $to, $from, $subject, $body, $options );
 198         }
 199
 200         /**
 201          * Helper function fo UserMailer::send() which does the actual sending. It expects a $to
 202          * list which the UserMailerSplitTo hook would not split further.
 203          * @param MailAddress[] $to Array of recipients' email addresses
 204          * @param MailAddress $from Sender's email
 205          * @param string $subject Email's subject.
 206          * @param string $body Email's text or Array of two strings to be the text and html bodies
 207          * @param array $options:
 208          *              'replyTo' MailAddress
 209          *              'contentType' string default 'text/plain; charset=UTF-8'
 210          *              'headers' array Extra headers to set
 211          *
 212          * @throws MWException
 213          * @throws Exception
 214          * @return Status
 215          */
 216         protected static function sendInternal(
 217                 array $to,
 218                 MailAddress $from,
 219                 $subject,
 220                 $body,
 221                 $options = array()
 222         ) {
 223                 global $wgSMTP, $wgEnotifMaxRecips, $wgAdditionalMailParams;
 224                 $mime = null;
 225
 226                 $replyto = isset( $options['replyTo'] ) ? $options['replyTo'] : null;
 227                 $contentType = isset( $options['contentType'] ) ?
 228                         $options['contentType'] : 'text/plain; charset=UTF-8';
 229                 $headers = isset( $options['headers'] ) ? $options['headers'] : array();
 230
 231                 // Allow transformation of content, such as encrypting/signing
 232                 $error = false;
 233                 if ( !Hooks::run( 'UserMailerTransformContent', array( $to, $from, &$body, &$error ) ) ) {
 234                         if ( $error ) {
 235                                 return Status::newFatal( 'php-mail-error', $error );
 236                         } else {
 237                                 return Status::newFatal( 'php-mail-error-unknown' );
 238                         }
 239                 }
 240
 241                 /**
 242                  * Forge email headers
 243                  * -------------------
 244                  *
 245                  * WARNING
 246                  *
 247                  * DO NOT add To: or Subject: headers at this step. They need to be
 248                  * handled differently depending upon the mailer we are going to use.
 249                  *
 250                  * To:
 251                  *  PHP mail() first argument is the mail receiver. The argument is
 252                  *  used as a recipient destination and as a To header.
 253                  *
 254                  *  PEAR mailer has a recipient argument which is only used to
 255                  *  send the mail. If no To header is given, PEAR will set it to
 256                  *  to 'undisclosed-recipients:'.
 257                  *
 258                  *  NOTE: To: is for presentation, the actual recipient is specified
 259                  *  by the mailer using the Rcpt-To: header.
 260                  *
 261                  * Subject:
 262                  *  PHP mail() second argument to pass the subject, passing a Subject
 263                  *  as an additional header will result in a duplicate header.
 264                  *
 265                  *  PEAR mailer should be passed a Subject header.
 266                  *
 267                  * -- hashar 20120218
 268                  */
 269
 270                 $headers['From'] = $from->toString();
 271                 $returnPath = $from->address;
 272                 $extraParams = $wgAdditionalMailParams;
 273
 274                 // Hook to generate custom VERP address for 'Return-Path'
 275                 Hooks::run( 'UserMailerChangeReturnPath', array( $to, &$returnPath ) );
 276                 // Add the envelope sender address using the -f command line option when PHP mail() is used.
 277                 // Will default to the $from->address when the UserMailerChangeReturnPath hook fails and the
 278                 // generated VERP address when the hook runs effectively.
 279                 $extraParams .= ' -f ' . $returnPath;
 280
 281                 $headers['Return-Path'] = $returnPath;
 282
 283                 if ( $replyto ) {
 284                         $headers['Reply-To'] = $replyto->toString();
 285                 }
 286
 287                 $headers['Date'] = MWTimestamp::getLocalInstance()->format( 'r' );
 288                 $headers['Message-ID'] = self::makeMsgId();
 289                 $headers['X-Mailer'] = 'MediaWiki mailer';
 290                 $headers['List-Unsubscribe'] = '<' . SpecialPage::getTitleFor( 'Preferences' )
 291                         ->getFullURL( '', false, PROTO_CANONICAL ) . '>';
 292
 293                 // Line endings need to be different on Unix and Windows due to
 294                 // the bug described at http://trac.wordpress.org/ticket/2603
 295                 $endl = PHP_EOL;
 296
 297                 if ( is_array( $body ) ) {
 298                         // we are sending a multipart message
 299                         wfDebug( "Assembling multipart mime email\n" );
 300                         if ( !stream_resolve_include_path( 'Mail/mime.php' ) ) {
 301                                 wfDebug( "PEAR Mail_Mime package is not installed. Falling back to text email.\n" );
 302                                 // remove the html body for text email fall back
 303                                 $body = $body['text'];
 304                         } else {
 305                                 // Check if pear/mail_mime is already loaded (via composer)
 306                                 if ( !class_exists( 'Mail_mime' ) ) {
 307                                         require_once 'Mail/mime.php';
 308                                 }
 309                                 if ( wfIsWindows() ) {
 310                                         $body['text'] = str_replace( "\n", "\r\n", $body['text'] );
 311                                         $body['html'] = str_replace( "\n", "\r\n", $body['html'] );
 312                                 }
 313                                 $mime = new Mail_mime( array(
 314                                         'eol' => $endl,
 315                                         'text_charset' => 'UTF-8',
 316                                         'html_charset' => 'UTF-8'
 317                                 ) );
 318                                 $mime->setTXTBody( $body['text'] );
 319                                 $mime->setHTMLBody( $body['html'] );
 320                                 $body = $mime->get(); // must call get() before headers()
 321                                 $headers = $mime->headers( $headers );
 322                         }
 323                 }
 324                 if ( $mime === null ) {
 325                         // sending text only, either deliberately or as a fallback
 326                         if ( wfIsWindows() ) {
 327                                 $body = str_replace( "\n", "\r\n", $body );
 328                         }
 329                         $headers['MIME-Version'] = '1.0';
 330                         $headers['Content-type'] = ( is_null( $contentType ) ?
 331                                 'text/plain; charset=UTF-8' : $contentType );
 332                         $headers['Content-transfer-encoding'] = '8bit';
 333                 }
 334
 335                 // allow transformation of MIME-encoded message
 336                 if ( !Hooks::run( 'UserMailerTransformMessage',
 337                         array( $to, $from, &$subject, &$headers, &$body, &$error ) )
 338                 ) {
 339                         if ( $error ) {
 340                                 return Status::newFatal( 'php-mail-error', $error );
 341                         } else {
 342                                 return Status::newFatal( 'php-mail-error-unknown' );
 343                         }
 344                 }
 345
 346                 $ret = Hooks::run( 'AlternateUserMailer', array( $headers, $to, $from, $subject, $body ) );
 347                 if ( $ret === false ) {
 348                         // the hook implementation will return false to skip regular mail sending
 349                         return Status::newGood();
 350                 } elseif ( $ret !== true ) {
 351                         // the hook implementation will return a string to pass an error message
 352                         return Status::newFatal( 'php-mail-error', $ret );
 353                 }
 354
 355                 if ( is_array( $wgSMTP ) ) {
 356                         // Check if pear/mail is already loaded (via composer)
 357                         if ( !class_exists( 'Mail' ) ) {
 358                                 // PEAR MAILER
 359                                 if ( !stream_resolve_include_path( 'Mail.php' ) ) {
 360                                         throw new MWException( 'PEAR mail package is not installed' );
 361                                 }
 362                                 require_once 'Mail.php';
 363                         }
 364
 365                         MediaWiki\suppressWarnings();
 366
 367                         // Create the mail object using the Mail::factory method
 368                         $mail_object =& Mail::factory( 'smtp', $wgSMTP );
 369                         if ( PEAR::isError( $mail_object ) ) {
 370                                 wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() . "\n" );
 371                                 MediaWiki\restoreWarnings();
 372                                 return Status::newFatal( 'pear-mail-error', $mail_object->getMessage() );
 373                         }
 374
 375                         wfDebug( "Sending mail via PEAR::Mail\n" );
 376
 377                         $headers['Subject'] = self::quotedPrintable( $subject );
 378
 379                         // When sending only to one recipient, shows it its email using To:
 380                         if ( count( $to ) == 1 ) {
 381                                 $headers['To'] = $to[0]->toString();
 382                         }
 383
 384                         // Split jobs since SMTP servers tends to limit the maximum
 385                         // number of possible recipients.
 386                         $chunks = array_chunk( $to, $wgEnotifMaxRecips );
 387                         foreach ( $chunks as $chunk ) {
 388                                 $status = self::sendWithPear( $mail_object, $chunk, $headers, $body );
 389                                 // FIXME : some chunks might be sent while others are not!
 390                                 if ( !$status->isOK() ) {
 391                                         MediaWiki\restoreWarnings();
 392                                         return $status;
 393                                 }
 394                         }
 395                         MediaWiki\restoreWarnings();
 396                         return Status::newGood();
 397                 } else {
 398                         // PHP mail()
 399                         if ( count( $to ) > 1 ) {
 400                                 $headers['To'] = 'undisclosed-recipients:;';
 401                         }
 402                         $headers = self::arrayToHeaderString( $headers, $endl );
 403
 404                         wfDebug( "Sending mail via internal mail() function\n" );
 405
 406                         self::$mErrorString = '';
 407                         $html_errors = ini_get( 'html_errors' );
 408                         ini_set( 'html_errors', '0' );
 409                         set_error_handler( 'UserMailer::errorHandler' );
 410
 411                         try {
 412                                 $safeMode = wfIniGetBool( 'safe_mode' );
 413
 414                                 foreach ( $to as $recip ) {
 415                                         if ( $safeMode ) {
 416                                                 $sent = mail( $recip, self::quotedPrintable( $subject ), $body, $headers );
 417                                         } else {
 418                                                 $sent = mail(
 419                                                         $recip,
 420                                                         self::quotedPrintable( $subject ),
 421                                                         $body,
 422                                                         $headers,
 423                                                         $extraParams
 424                                                 );
 425                                         }
 426                                 }
 427                         } catch ( Exception $e ) {
 428                                 restore_error_handler();
 429                                 throw $e;
 430                         }
 431
 432                         restore_error_handler();
 433                         ini_set( 'html_errors', $html_errors );
 434
 435                         if ( self::$mErrorString ) {
 436                                 wfDebug( "Error sending mail: " . self::$mErrorString . "\n" );
 437                                 return Status::newFatal( 'php-mail-error', self::$mErrorString );
 438                         } elseif ( !$sent ) {
 439                                 // mail function only tells if there's an error
 440                                 wfDebug( "Unknown error sending mail\n" );
 441                                 return Status::newFatal( 'php-mail-error-unknown' );
 442                         } else {
 443                                 return Status::newGood();
 444                         }
 445                 }
 446         }
 447
 448         /**
 449          * Set the mail error message in self::$mErrorString
 450          *
 451          * @param int $code Error number
 452          * @param string $string Error message
 453          */
 454         static function errorHandler( $code, $string ) {
 455                 self::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
 456         }
 457
 458         /**
 459          * Strips bad characters from a header value to prevent PHP mail header injection attacks
 460          * @param string $val String to be santizied
 461          * @return string
 462          */
 463         public static function sanitizeHeaderValue( $val ) {
 464                 return strtr( $val, array( "\r" => '', "\n" => '' ) );
 465         }
 466
 467         /**
 468          * Converts a string into a valid RFC 822 "phrase", such as is used for the sender name
 469          * @param string $phrase
 470          * @return string
 471          */
 472         public static function rfc822Phrase( $phrase ) {
 473                 // Remove line breaks
 474                 $phrase = self::sanitizeHeaderValue( $phrase );
 475                 // Remove quotes
 476                 $phrase = str_replace( '"', '', $phrase );
 477                 return '"' . $phrase . '"';
 478         }
 479
 480         /**
 481          * Converts a string into quoted-printable format
 482          * @since 1.17
 483          *
 484          * From PHP5.3 there is a built in function quoted_printable_encode()
 485          * This method does not duplicate that.
 486          * This method is doing Q encoding inside encoded-words as defined by RFC 2047
 487          * This is for email headers.
 488          * The built in quoted_printable_encode() is for email bodies
 489          * @param string $string
 490          * @param string $charset
 491          * @return string
 492          */
 493         public static function quotedPrintable( $string, $charset = '' ) {
 494                 // Probably incomplete; see RFC 2045
 495                 if ( empty( $charset ) ) {
 496                         $charset = 'UTF-8';
 497                 }
 498                 $charset = strtoupper( $charset );
 499                 $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
 500
 501                 $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
 502                 $replace = $illegal . '\t ?_';
 503                 if ( !preg_match( "/[$illegal]/", $string ) ) {
 504                         return $string;
 505                 }
 506                 $out = "=?$charset?Q?";
 507                 $out .= preg_replace_callback( "/([$replace])/",
 508                         array( __CLASS__, 'quotedPrintableCallback' ), $string );
 509                 $out .= '?=';
 510                 return $out;
 511         }
 512
 513         protected static function quotedPrintableCallback( $matches ) {
 514                 return sprintf( "=%02X", ord( $matches[1] ) );
 515         }
 516 }