Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
49.74% covered (danger)
49.74%
96 / 193
14.29% covered (danger)
14.29%
1 / 7
CRAP
0.00% covered (danger)
0.00%
0 / 1
UserMailer
49.74% covered (danger)
49.74%
96 / 193
14.29% covered (danger)
14.29%
1 / 7
381.20
0.00% covered (danger)
0.00%
0 / 1
 sendWithPear
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
6
 makeMsgId
88.89% covered (warning)
88.89%
8 / 9
0.00% covered (danger)
0.00%
0 / 1
4.02
 send
67.44% covered (warning)
67.44%
29 / 43
0.00% covered (danger)
0.00%
0 / 1
31.46
 sendInternal
36.97% covered (danger)
36.97%
44 / 119
0.00% covered (danger)
0.00%
0 / 1
131.40
 errorHandler
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 sanitizeHeaderValue
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 quotedPrintable
100.00% covered (success)
100.00%
15 / 15
100.00% covered (success)
100.00%
1 / 1
3
1<?php
2/**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
17 *
18 * @file
19 * @author Brooke Vibber
20 * @author <mail@tgries.de>
21 * @author Tim Starling
22 * @author Luke Welling lwelling@wikimedia.org
23 */
24
25use MediaWiki\HookContainer\HookRunner;
26use MediaWiki\Logger\LoggerFactory;
27use MediaWiki\MainConfigNames;
28use MediaWiki\MediaWikiServices;
29use MediaWiki\SpecialPage\SpecialPage;
30use MediaWiki\Status\Status;
31use MediaWiki\Utils\MWTimestamp;
32use MediaWiki\WikiMap\WikiMap;
33
34/**
35 * @defgroup Mail Mail
36 */
37
38/**
39 * Collection of static functions for sending mail
40 *
41 * @since 1.12
42 * @ingroup Mail
43 */
44class UserMailer {
45    private static $mErrorString;
46
47    /**
48     * Send mail using a PEAR mailer
49     *
50     * @param Mail_smtp $mailer
51     * @param string[]|string $dest
52     * @param array $headers
53     * @param string $body
54     *
55     * @return Status
56     */
57    protected static function sendWithPear( $mailer, $dest, $headers, $body ) {
58        $mailResult = $mailer->send( $dest, $headers, $body );
59
60        // Based on the result return an error string,
61        if ( PEAR::isError( $mailResult ) ) {
62            wfDebug( "PEAR::Mail failed: " . $mailResult->getMessage() );
63            return Status::newFatal( 'pear-mail-error', $mailResult->getMessage() );
64        } else {
65            return Status::newGood();
66        }
67    }
68
69    /**
70     * Create a value suitable for the MessageId Header
71     *
72     * @return string
73     */
74    private static function makeMsgId() {
75        $services = MediaWikiServices::getInstance();
76
77        $smtp = $services->getMainConfig()->get( MainConfigNames::SMTP );
78        $server = $services->getMainConfig()->get( MainConfigNames::Server );
79        $domainId = WikiMap::getCurrentWikiDbDomain()->getId();
80        $msgid = uniqid( $domainId . ".", true /** for cygwin */ );
81
82        if ( is_array( $smtp ) && isset( $smtp['IDHost'] ) && $smtp['IDHost'] ) {
83            $domain = $smtp['IDHost'];
84        } else {
85            $domain = parse_url( $server, PHP_URL_HOST ) ?? '';
86        }
87        return "<$msgid@$domain>";
88    }
89
90    /**
91     * Send a raw email via SMTP (if $wgSMTP is set) or otherwise via PHP mail().
92     *
93     * This function perform a direct (authenticated) login to a SMTP server,
94     * to use for mail relaying, if 'wgSMTP' specifies an array of parameters.
95     * This uses the pear/mail package.
96     *
97     * Otherwise it uses the standard PHP 'mail' function, which in turn relies
98     * on the server's sendmail configuration.
99     *
100     * @since 1.12
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|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     * @return Status
110     */
111    public static function send( $to, $from, $subject, $body, $options = [] ) {
112        $services = MediaWikiServices::getInstance();
113        $allowHTMLEmail = $services->getMainConfig()->get(
114            MainConfigNames::AllowHTMLEmail );
115
116        if ( !isset( $options['contentType'] ) ) {
117            $options['contentType'] = 'text/plain; charset=UTF-8';
118        }
119
120        if ( !is_array( $to ) ) {
121            $to = [ $to ];
122        }
123
124        // mail body must have some content
125        $minBodyLen = 10;
126        // arbitrary but longer than Array or Object to detect casting error
127
128        // body must either be a string or an array with text and body
129        if (
130            !(
131                !is_array( $body ) &&
132                strlen( $body ) >= $minBodyLen
133            )
134            &&
135            !(
136                is_array( $body ) &&
137                isset( $body['text'] ) &&
138                isset( $body['html'] ) &&
139                strlen( $body['text'] ) >= $minBodyLen &&
140                strlen( $body['html'] ) >= $minBodyLen
141            )
142        ) {
143            // if it is neither we have a problem
144            return Status::newFatal( 'user-mail-no-body' );
145        }
146
147        if ( !$allowHTMLEmail && is_array( $body ) ) {
148            // HTML not wanted.  Dump it.
149            $body = $body['text'];
150        }
151
152        wfDebug( __METHOD__ . ': sending mail to ' . implode( ', ', $to ) );
153
154        // Make sure we have at least one address
155        $has_address = false;
156        foreach ( $to as $u ) {
157            if ( $u->address ) {
158                $has_address = true;
159                break;
160            }
161        }
162        if ( !$has_address ) {
163            return Status::newFatal( 'user-mail-no-addy' );
164        }
165
166        // give a chance to UserMailerTransformContents subscribers who need to deal with each
167        // target differently to split up the address list
168        if ( count( $to ) > 1 ) {
169            $oldTo = $to;
170            ( new HookRunner( $services->getHookContainer() ) )->onUserMailerSplitTo( $to );
171            if ( $oldTo != $to ) {
172                $splitTo = array_diff( $oldTo, $to );
173                $to = array_diff( $oldTo, $splitTo ); // ignore new addresses added in the hook
174                // first send to non-split address list, then to split addresses one by one
175                $status = Status::newGood();
176                if ( $to ) {
177                    $status->merge( self::sendInternal(
178                        $to, $from, $subject, $body, $options ) );
179                }
180                foreach ( $splitTo as $newTo ) {
181                    $status->merge( self::sendInternal(
182                        [ $newTo ], $from, $subject, $body, $options ) );
183                }
184                return $status;
185            }
186        }
187
188        return self::sendInternal( $to, $from, $subject, $body, $options );
189    }
190
191    /**
192     * Helper function fo UserMailer::send() which does the actual sending. It expects a $to
193     * list which the UserMailerSplitTo hook would not split further.
194     * @param MailAddress[] $to Array of recipients' email addresses
195     * @param MailAddress $from Sender's email
196     * @param string $subject Email's subject.
197     * @param string|string[] $body Email's text or Array of two strings to be the text and html bodies
198     * @param array $options Keys:
199     *     'replyTo' MailAddress
200     *     'contentType' string default 'text/plain; charset=UTF-8'
201     *     'headers' array Extra headers to set
202     * @return Status
203     */
204    protected static function sendInternal(
205        array $to,
206        MailAddress $from,
207        $subject,
208        $body,
209        $options = []
210    ) {
211        $services = MediaWikiServices::getInstance();
212        $mainConfig = $services->getMainConfig();
213        $smtp = $mainConfig->get( MainConfigNames::SMTP );
214        $enotifMaxRecips = $mainConfig->get( MainConfigNames::EnotifMaxRecips );
215        $additionalMailParams = $mainConfig->get( MainConfigNames::AdditionalMailParams );
216
217        $replyto = $options['replyTo'] ?? null;
218        $contentType = $options['contentType'] ?? 'text/plain; charset=UTF-8';
219        $headers = $options['headers'] ?? [];
220
221        $hookRunner = new HookRunner( $services->getHookContainer() );
222        // Allow transformation of content, such as encrypting/signing
223        $error = false;
224        // @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
225        if ( !$hookRunner->onUserMailerTransformContent( $to, $from, $body, $error ) ) {
226            if ( $error ) {
227                return Status::newFatal( 'php-mail-error', $error );
228            } else {
229                return Status::newFatal( 'php-mail-error-unknown' );
230            }
231        }
232
233        /**
234         * Forge email headers
235         * -------------------
236         *
237         * WARNING
238         *
239         * DO NOT add To: or Subject: headers at this step. They need to be
240         * handled differently depending upon the mailer we are going to use.
241         *
242         * To:
243         *  PHP mail() first argument is the mail receiver. The argument is
244         *  used as a recipient destination and as a To header.
245         *
246         *  PEAR mailer has a recipient argument which is only used to
247         *  send the mail. If no To header is given, PEAR will set it to
248         *  to 'undisclosed-recipients:'.
249         *
250         *  NOTE: To: is for presentation, the actual recipient is specified
251         *  by the mailer using the Rcpt-To: header.
252         *
253         * Subject:
254         *  PHP mail() second argument to pass the subject, passing a Subject
255         *  as an additional header will result in a duplicate header.
256         *
257         *  PEAR mailer should be passed a Subject header.
258         *
259         * -- hashar 20120218
260         */
261
262        $headers['From'] = $from->toString();
263        $returnPath = $from->address;
264        $extraParams = $additionalMailParams;
265
266        // Hook to generate custom VERP address for 'Return-Path'
267        $hookRunner->onUserMailerChangeReturnPath( $to, $returnPath );
268        // Add the envelope sender address using the -f command line option when PHP mail() is used.
269        // Will default to the $from->address when the UserMailerChangeReturnPath hook fails and the
270        // generated VERP address when the hook runs effectively.
271
272        // PHP runs this through escapeshellcmd(). However that's not sufficient
273        // escaping (e.g. due to spaces). MediaWiki's email sanitizer should generally
274        // be good enough, but just in case, put in double quotes, and remove any
275        // double quotes present (" is not allowed in emails, so should have no
276        // effect, although this might cause apostrophes to be double escaped)
277        $returnPathCLI = '"' . str_replace( '"', '', $returnPath ) . '"';
278        $extraParams .= ' -f ' . $returnPathCLI;
279
280        $headers['Return-Path'] = $returnPath;
281
282        if ( $replyto ) {
283            $headers['Reply-To'] = $replyto->toString();
284        }
285
286        $headers['Date'] = MWTimestamp::getLocalInstance()->format( 'r' );
287        $headers['Message-ID'] = self::makeMsgId();
288        $headers['X-Mailer'] = 'MediaWiki mailer';
289        $headers['List-Unsubscribe'] = '<' . SpecialPage::getTitleFor( 'Preferences' )
290            ->getFullURL( '', false, PROTO_CANONICAL ) . '>';
291
292        // Line endings need to be different on Unix and Windows due to
293        // the bug described at https://core.trac.wordpress.org/ticket/2603
294        $endl = PHP_EOL;
295
296        if ( is_array( $body ) ) {
297            // we are sending a multipart message
298            wfDebug( "Assembling multipart mime email" );
299            if ( wfIsWindows() ) {
300                $body['text'] = str_replace( "\n", "\r\n", $body['text'] );
301                $body['html'] = str_replace( "\n", "\r\n", $body['html'] );
302            }
303            $mime = new Mail_mime( [
304                'eol' => $endl,
305                'text_charset' => 'UTF-8',
306                'html_charset' => 'UTF-8'
307            ] );
308            $mime->setTXTBody( $body['text'] );
309            $mime->setHTMLBody( $body['html'] );
310            $body = $mime->get(); // must call get() before headers()
311            $headers = $mime->headers( $headers );
312        } else {
313            // sending text only
314            if ( wfIsWindows() ) {
315                $body = str_replace( "\n", "\r\n", $body );
316            }
317            $headers['MIME-Version'] = '1.0';
318            $headers['Content-type'] = $contentType;
319            $headers['Content-transfer-encoding'] = '8bit';
320        }
321
322        // allow transformation of MIME-encoded message
323        if ( !$hookRunner->onUserMailerTransformMessage(
324            $to, $from, $subject, $headers, $body, $error )
325        ) {
326            if ( $error ) {
327                return Status::newFatal( 'php-mail-error', $error );
328            } else {
329                return Status::newFatal( 'php-mail-error-unknown' );
330            }
331        }
332
333        $ret = $hookRunner->onAlternateUserMailer( $headers, $to, $from, $subject, $body );
334        if ( $ret === false ) {
335            // the hook implementation will return false to skip regular mail sending
336            LoggerFactory::getInstance( 'usermailer' )->info(
337                "Email to {to} from {from} with subject {subject} handled by AlternateUserMailer",
338                [
339                    'to' => $to[0]->toString(),
340                    'allto' => implode( ', ', array_map( 'strval', $to ) ),
341                    'from' => $from->toString(),
342                    'subject' => $subject,
343                ]
344            );
345            return Status::newGood();
346        } elseif ( $ret !== true ) {
347            // the hook implementation will return a string to pass an error message
348            return Status::newFatal( 'php-mail-error', $ret );
349        }
350
351        if ( is_array( $smtp ) ) {
352            $recips = array_map( 'strval', $to );
353
354            // Create the mail object using the Mail::factory method
355            $mail_object = Mail::factory( 'smtp', $smtp );
356            if ( PEAR::isError( $mail_object ) ) {
357                wfDebug( "PEAR::Mail factory failed: " . $mail_object->getMessage() );
358                return Status::newFatal( 'pear-mail-error', $mail_object->getMessage() );
359            }
360            '@phan-var Mail_smtp $mail_object';
361
362            wfDebug( "Sending mail via PEAR::Mail" );
363
364            $headers['Subject'] = self::quotedPrintable( $subject );
365
366            // When sending only to one recipient, shows it its email using To:
367            if ( count( $recips ) == 1 ) {
368                $headers['To'] = $recips[0];
369            }
370
371            // Split jobs since SMTP servers tends to limit the maximum
372            // number of possible recipients.
373            $chunks = array_chunk( $recips, $enotifMaxRecips );
374            foreach ( $chunks as $chunk ) {
375                $status = self::sendWithPear( $mail_object, $chunk, $headers, $body );
376                // FIXME : some chunks might be sent while others are not!
377                if ( !$status->isOK() ) {
378                    return $status;
379                }
380            }
381            return Status::newGood();
382        } else {
383            // PHP mail()
384            if ( count( $to ) > 1 ) {
385                $headers['To'] = 'undisclosed-recipients:;';
386            }
387
388            wfDebug( "Sending mail via internal mail() function" );
389
390            self::$mErrorString = '';
391            $html_errors = ini_get( 'html_errors' );
392            ini_set( 'html_errors', '0' );
393            set_error_handler( [ self::class, 'errorHandler' ] );
394
395            try {
396                foreach ( $to as $recip ) {
397                    $sent = mail(
398                        $recip->toString(),
399                        self::quotedPrintable( $subject ),
400                        $body,
401                        $headers,
402                        $extraParams
403                    );
404                }
405            } catch ( Exception $e ) {
406                restore_error_handler();
407                throw $e;
408            }
409
410            restore_error_handler();
411            ini_set( 'html_errors', $html_errors );
412
413            if ( self::$mErrorString ) {
414                wfDebug( "Error sending mail: " . self::$mErrorString );
415                return Status::newFatal( 'php-mail-error', self::$mErrorString );
416            } elseif ( !$sent ) {
417                // @phan-suppress-previous-line PhanPossiblyUndeclaredVariable sent set on success
418                // mail function only tells if there's an error
419                wfDebug( "Unknown error sending mail" );
420                return Status::newFatal( 'php-mail-error-unknown' );
421            } else {
422                LoggerFactory::getInstance( 'usermailer' )->info(
423                    "Email sent to {to} from {from} with subject {subject}",
424                    [
425                        'to' => $to[0]->toString(),
426                        'allto' => implode( ', ', array_map( 'strval', $to ) ),
427                        'from' => $from->toString(),
428                        'subject' => $subject,
429                    ]
430                );
431                return Status::newGood();
432            }
433        }
434    }
435
436    /**
437     * Set the mail error message in self::$mErrorString
438     *
439     * @param int $code Error number
440     * @param string $string Error message
441     */
442    private static function errorHandler( $code, $string ) {
443        self::$mErrorString = preg_replace( '/^mail\(\)(\s*\[.*?\])?: /', '', $string );
444    }
445
446    /**
447     * Strips bad characters from a header value to prevent PHP mail header injection attacks
448     * @param string $val String to be sanitized
449     * @return string
450     */
451    public static function sanitizeHeaderValue( $val ) {
452        return strtr( $val, [ "\r" => '', "\n" => '' ] );
453    }
454
455    /**
456     * Converts a string into quoted-printable format
457     * @since 1.17
458     *
459     * From PHP5.3 there is a built in function quoted_printable_encode()
460     * This method does not duplicate that.
461     * This method is doing Q encoding inside encoded-words as defined by RFC 2047
462     * This is for email headers.
463     * The built in quoted_printable_encode() is for email bodies
464     * @param string $string
465     * @param string $charset
466     * @return string
467     */
468    public static function quotedPrintable( $string, $charset = '' ) {
469        // Probably incomplete; see RFC 2045
470        if ( !$charset ) {
471            $charset = 'UTF-8';
472        }
473        $charset = strtoupper( $charset );
474        $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ?
475
476        $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff=';
477        if ( !preg_match( "/[$illegal]/", $string ) ) {
478            return $string;
479        }
480
481        // T344912: Add period '.' char
482        $replace = $illegal . '.\t ?_';
483
484        $out = "=?$charset?Q?";
485        $out .= preg_replace_callback( "/[$replace]/",
486            static fn ( $m ) => sprintf( "=%02X", ord( $m[0] ) ),
487            $string
488        );
489        $out .= '?=';
490        return $out;
491    }
492}