smtp.install in SMTP Authentication Support 8

The installation instructions for the SMTP Authentication Support.

File

smtp.install

<?php

/**
 * @file
 * The installation instructions for the SMTP Authentication Support.
 */
use Drupal\Core\Url;
use PHPMailer\PHPMailer\PHPMailer;

/**
 * Implements hook_uninstall().
 */
function smtp_uninstall() {

  // Restore previous mail system.
  _disable_smtp();

  // Cleaning garbage.
  $config = \Drupal::service('config.factory');
  $smtp_config = $config
    ->getEditable('smtp.settings');
  $smtp_config
    ->delete();
}

/**
 * Add SMTP timeout configuration and change default to 30.
 */
function smtp_update_8001() {
  \Drupal::configFactory()
    ->getEditable('smtp.settings')
    ->set('smtp_timeout', 30)
    ->save(TRUE);
}

/**
 * Add SMTP keepalive configuration and set default to FALSE.
 */
function smtp_update_8002() {
  \Drupal::configFactory()
    ->getEditable('smtp.settings')
    ->set('smtp_keepalive', FALSE)
    ->save(TRUE);
}

/**
 * If mailsystem exists, disable smtp mailsystem automatically.
 */
function smtp_update_8004() {
  $mailsystem_enabled = \Drupal::moduleHandler()
    ->moduleExists('mailsystem');
  if ($mailsystem_enabled) {
    _disable_smtp();
  }
}

/**
 * Implements hook_install().
 */
function smtp_install() {
  $messenger = \Drupal::messenger();

  // @var \Drupal\Core\Routing\RouteBuilderInterface $routeBuilder $route_builder.
  $route_builder = \Drupal::service('router.builder');

  // Makes the 'smtp.config' route available here, see hook_install doc.
  $route_builder
    ->rebuild();
  $messenger
    ->addMessage(t('Thanks for installing SMTP Authentication Support'));
  $messenger
    ->addMessage(t('Server settings on <a href="@url_settings">SMTP Authentication Support</a>', [
    '@url_settings' => Url::fromRoute('smtp.config')
      ->toString(),
  ]));
}

/**
 * Disable the SMTP mailsystem if the mailsystem module is installed.
 *
 * @param $modules
 * @param $is_syncing
 */
function smtp_modules_installed($modules, $is_syncing = FALSE) {
  if (in_array('mailsystem', $modules) && !$is_syncing) {

    // If mailsystem module is enabled, make sure SMTP is disabled.
    _disable_smtp();
  }
}

/**
 * Implements hook_requirements().
 */
function smtp_requirements(string $phase) {
  $requirements = [];
  if ($phase == 'runtime') {

    // Ensure PHPMailer exists.
    if (class_exists(PHPMailer::class)) {
      $mail = new PHPMailer();
    }
    if (empty($mail)) {
      $requirements['smtp_phpmailer'] = [
        'title' => (string) t('SMTP: PHPMailer Library'),
        'value' => (string) t('Missing'),
        'severity' => REQUIREMENT_ERROR,
        'description' => t('PHPMailer is Required for SMTP to function.'),
      ];

      // If PHPMailer is not found, SMTP should not be set as the mail system.
      _disable_smtp();
      return $requirements;
    }
    else {
      $required_version = '6.1.7';
      $installed_version = $mail::VERSION;
      $reflector = new \ReflectionClass('\\PHPMailer\\PHPMailer\\PHPMailer');
      $requirements['smtp_phpmailer'] = [
        'title' => (string) t('SMTP: PHPMailer library'),
        'value' => $installed_version,
        'description' => t('PHPMailer is located at %path', [
          '%path' => $reflector
            ->getFileName(),
        ]),
      ];
      if (!version_compare($installed_version, $required_version, '>=')) {
        $requirements['smtp_phpmailer']['severity'] = REQUIREMENT_ERROR;
        $requirements['smtp_phpmailer']['description'] = (string) t("PHPMailer library @version or higher is required. Please install a newer version by executing 'composer update' in your site's root directory.", [
          '@version' => $required_version,
        ]);

        // If incorrect version, SMTP should not be set as the mail system.
        _disable_smtp();
      }
      else {
        $requirements['smtp_phpmailer']['severity'] = REQUIREMENT_INFO;

        /** @var \Drupal\smtp\ConnectionTester\ConnectionTester $tester */
        $tester = \Drupal::service('smtp.connection_tester');
        $tester
          ->testConnection();
        $requirements = array_merge($requirements, $tester
          ->hookRequirements($phase));
      }
    }
  }
  return $requirements;
}

/**
 * Helper function to disable SMTP and restore the default mailsystem.
 */
function _disable_smtp() {
  $config = \Drupal::service('config.factory');

  // Always make sure SMTP is disabled.
  $smtp_config = $config
    ->getEditable('smtp.settings');
  if (!$smtp_config
    ->get('smtp_on')) {
    return;
  }

  // Set the internal SMTP module config off.
  $smtp_config
    ->set('smtp_on', FALSE)
    ->save();

  // Set the default back to either the previous mail system or php_mail.
  $mail_config = $config
    ->getEditable('system.mail');
  $current_default = $mail_config
    ->get('interface.default');
  $system_default = 'php_mail';
  if ($current_default == 'SMTPMailSystem') {
    $default_interface = !$smtp_config
      ->get('prev_mail_system') ? $smtp_config
      ->get('prev_mail_system') : $system_default;
    $mail_config
      ->set('interface.default', $default_interface)
      ->save();
  }
}

Functions

Name	Description
smtp_install	Implements hook_install().
smtp_modules_installed	Disable the SMTP mailsystem if the mailsystem module is installed.
smtp_requirements	Implements hook_requirements().
smtp_uninstall	Implements hook_uninstall().
smtp_update_8001	Add SMTP timeout configuration and change default to 30.
smtp_update_8002	Add SMTP keepalive configuration and set default to FALSE.
smtp_update_8004	If mailsystem exists, disable smtp mailsystem automatically.
_disable_smtp	Helper function to disable SMTP and restore the default mailsystem.