CoreFiles by mySites.guru
MailerFactory.php145 lines, 4,971 bytes, from Joomla_6.2.0-Stable-Full_Package.zip
Raw History Compare with 6.1.4
md5
0059ac58d482a2f73c6700c35fb0783b
sha1
34c9f62574d68fbf67d64d3e0f044ae3d76cf380
sha256
27f273631d29d35cced1b0918c067b9b38947baa7bade025b807ab409d94b72e
<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Mail;

use Joomla\CMS\Log\Log;
use Joomla\Registry\Registry;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Default factory for creating mailer objects.
 *
 * @since  4.4.0
 */
class MailerFactory implements MailerFactoryInterface
{
    /**
     * The default configuration.
     *
     * @var     Registry
     * @since   4.4.0
     */
    private $defaultConfiguration;

    /**
     * @var array Cached TokenProvider
     */
    private array $oauth2TokenProvider = [];

    /**
     * The MailerFactory constructor.
     *
     * @param   Registry  $defaultConfiguration  The default configuration
     */
    public function __construct(Registry $defaultConfiguration)
    {
        $this->defaultConfiguration = $defaultConfiguration;
    }

    /**
     * Method to get an instance of a mailer. If the passed settings are null,
     * then the mailer does use the internal configuration.
     *
     * @param   ?Registry  $settings  The configuration
     *
     * @return  MailerInterface
     *
     * @since   4.4.0
     */
    public function createMailer(?Registry $settings = null): MailerInterface
    {
        $configuration = new Registry($this->defaultConfiguration);

        if ($settings) {
            $configuration->merge($settings);
        }

        $mailer = new Mail((bool) $configuration->get('throw_exceptions', true));

        $smtpauth   = (int) $configuration->get('smtpauth');
        $smtpuser   = $configuration->get('smtpuser');
        $smtppass   = $configuration->get('smtppass');
        $smtphost   = $configuration->get('smtphost');
        $smtpsecure = $configuration->get('smtpsecure');
        $smtpport   = $configuration->get('smtpport');
        $mailfrom   = $configuration->get('mailfrom');
        $fromname   = $configuration->get('fromname');
        $mailType   = $configuration->get('mailer');

        // Clean the email address
        $mailfrom = MailHelper::cleanLine($mailfrom);

        // Set default sender without Reply-to if the mailfrom is a valid address
        if (MailHelper::isEmailAddress($mailfrom)) {
            // Wrap in try/catch to catch Exception if it is throwing them
            try {
                // Check for a false return value if exception throwing is disabled
                if ($mailer->setFrom($mailfrom, MailHelper::cleanLine($fromname), false) === false) {
                    Log::add(__METHOD__ . '() could not set the sender data.', Log::WARNING, 'mail');
                }
            } catch (\Exception) {
                Log::add(__METHOD__ . '() could not set the sender data.', Log::WARNING, 'mail');
            }
        }

        // Default mailer is to use PHP's mail function
        switch ($mailType) {
            case 'smtp':
                $oauth2TokenProvider = null;

                if ($smtpauth === 2) {
                    $oauth2ClientId     = $configuration->get('smtp_oauth2_client_id');
                    $oauth2ClientSecret = $configuration->get('smtp_oauth2_client_secret');
                    $oauth2RefreshToken = $configuration->get('smtp_oauth2_refresh_token');
                    $oauth2TokenUrl     = $configuration->get('smtp_oauth2_token_url');

                    if (!$smtpuser || !$oauth2ClientId || !$oauth2ClientSecret || !$oauth2RefreshToken || !$oauth2TokenUrl) {
                        throw new \RuntimeException('OAuth2 SMTP configuration is incomplete.');
                    }

                    $tokenProviderHash = md5(
                        $oauth2TokenUrl . ':' .
                        $oauth2ClientId . ':' .
                        $oauth2ClientSecret . ':' .
                        $oauth2RefreshToken . ':' .
                        $smtpuser
                    );

                    if (empty($this->oauth2TokenProvider[$tokenProviderHash])) {
                        $this->oauth2TokenProvider[$tokenProviderHash] = new MailOAuth2TokenProvider(
                            $oauth2TokenUrl,
                            $oauth2ClientId,
                            $oauth2ClientSecret,
                            $oauth2RefreshToken,
                            $smtpuser
                        );
                    }

                    $oauth2TokenProvider = $this->oauth2TokenProvider[$tokenProviderHash];
                }

                $mailer->useSmtp($smtpauth, $smtphost, $smtpuser, $smtppass, $smtpsecure, $smtpport, $oauth2TokenProvider);
                break;

            case 'sendmail':
                $mailer->isSendmail();
                break;

            default:
                $mailer->isMail();
                break;
        }

        return $mailer;
    }
}

The same content is in 6 releases, Joomla 6.2.0-beta2 to 6.2.1-rc1. See them all, or every version of this file.