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