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