Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**

 * Customised version of phpmailer for Moodle

 *

 * @package    core

 * @author     Dan Poltawski <talktodan@gmail.com>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

defined('MOODLE_INTERNAL') || die();

// PLEASE NOTE: we use the phpmailer class _unmodified_

// through the joys of OO. Distros are free to use their stock

// version of this file.

/**

 * Moodle Customised version of the PHPMailer class

 *

 * This class extends the stock PHPMailer class

 * in order to make sensible configuration choices,

 * and behave in a way which is friendly to moodle.

 *

 * @copyright 2009 Dan Poltawski <talktodan@gmail.com>

 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 * @since     Moodle 2.0

 */

class moodle_phpmailer extends \PHPMailer\PHPMailer\PHPMailer {

    /**

     * Constructor - creates an instance of the PHPMailer class

     * with Moodle defaults.

     */

    public function __construct(){

        global $CFG;

        $this->CharSet   = 'UTF-8';

        // MDL-52637: Disable the automatic TLS encryption added in v5.2.10 (9da56fc1328a72aa124b35b738966315c41ef5c6).

        $this->SMTPAutoTLS = false;

        if (!empty($CFG->smtpauthtype)) {

            $this->AuthType = $CFG->smtpauthtype;

            if ($this->AuthType == 'XOAUTH2') {

                $this->process_oauth();

            }

        }

        // Some MTAs may do double conversion of LF if CRLF used, CRLF is required line ending in RFC 822bis.

        if (isset($CFG->mailnewline) and $CFG->mailnewline == 'CRLF') {

            parent::setLE("\r\n");

        } else {

            parent::setLE("\n");

        }

    }

    /**

     * Extended AddCustomHeader function in order to stop duplicate

     * message-ids

     * http://tracker.moodle.org/browse/MDL-3681

     */

    public function addCustomHeader($custom_header, $value = null) {

        if ($value === null and preg_match('/message-id:(.*)/i', $custom_header, $matches)) {

            $this->MessageID = trim($matches[1]);

            return true;

        } else if ($value !== null and strcasecmp($custom_header, 'message-id') === 0) {

            $this->MessageID = trim($value);

            return true;

        } else {

            return parent::addCustomHeader($custom_header, $value);

        }

    }

    /**

     * Use internal moodles own core_text to encode mimeheaders.

     * Fall back to phpmailers inbuilt functions if not

     */

    public function encodeHeader($str, $position = 'text') {

        $encoded = core_text::encode_mimeheader($str, $this->CharSet);

        if ($encoded !== false) {

            if ($position === 'phrase') {

                // Escape special symbols in each line in the encoded string, join back together and enclose in quotes.

                $chunks = preg_split("/\\n/", $encoded);

                $chunks = array_map(function($chunk) {

                    return addcslashes($chunk, "\0..\37\177\\\"");

                }, $chunks);

                return '"' . join(parent::getLE(), $chunks) . '"';

            }

            return str_replace("\n", parent::getLE(), $encoded);

        }

        return parent::encodeHeader($str, $position);

    }

    /**

     * Replaced function to fix tz bug:

     * http://tracker.moodle.org/browse/MDL-12596

     */

    public static function rfcDate() {

        $tz = date('Z');

        $tzs = ($tz < 0) ? '-' : '+';

        $tz = abs($tz);

        $tz = (($tz - ($tz%3600) )/3600)*100 + ($tz%3600)/60; // fixed tz bug

        $result = sprintf("%s %s%04d", date('D, j M Y H:i:s'), $tzs, $tz);

        return $result;

    }

    /**

     * Sends this mail.

     *

     * This function has been overridden to facilitate unit testing.

     *

     * @return bool

     */

    public function postSend() {

        // Now ask phpunit if it wants to catch this message.

        if (PHPUNIT_TEST) {

            if (!phpunit_util::is_redirecting_phpmailer()) {

                debugging('Unit tests must not send real emails! Use $this->redirectEmails()');

                return true;

            }

            $mail = new stdClass();

            $mail->header = $this->MIMEHeader;

            $mail->body = $this->MIMEBody;

            $mail->subject = $this->Subject;

            $mail->from = $this->From;

            $mail->to = $this->to[0][0];

            phpunit_util::phpmailer_sent($mail);

            return true;

        } else {

            return parent::postSend();

        }

    }

    /**

     * Config the PHPMailer to use OAUTH if necessary.

     */

    private function process_oauth(): void {

        global $CFG;

        require_once($CFG->libdir . '/phpmailer/moodle_phpmailer_oauth.php');

        if (!empty($CFG->smtpoauthservice)) {

            // Get the issuer.

            $issuer = \core\oauth2\api::get_issuer($CFG->smtpoauthservice);

            // Validate the issuer and check if it is enabled or not.

            if ($issuer && $issuer->get('enabled')) {

                // Get the OAuth Client.

                if ($oauthclient = \core\oauth2\api::get_system_oauth_client($issuer)) {

                    $oauth = new moodle_phpmailer_oauth([

                        'provider' => $oauthclient,

                        'clientId' => $oauthclient->get_clientid(),

                        'clientSecret' => $oauthclient->get_clientsecret(),

                        'refreshToken' => $oauthclient->get_refresh_token(),

                        'userName' => $CFG->smtpuser,

                    ]);

                    // Set the OAuth.

                    $this->setOAuth($oauth);

                }

            }

        }

    }

}