init

wp-content/plugins/mailpoet/lib/Util/Notices/DatabaseEngineNotice.php

@@ -0,0 +1,117 @@
+<?php declare(strict_types = 1);
+
+namespace MailPoet\Util\Notices;
+
+if (!defined('ABSPATH')) exit;
+
+
+use MailPoet\Config\Env;
+use MailPoet\Doctrine\WPDB\Connection;
+use MailPoet\Util\Helpers;
+use MailPoet\WP\Functions as WPFunctions;
+use MailPoet\WP\Notice;
+use MailPoetVendor\Doctrine\ORM\EntityManager;
+
+class DatabaseEngineNotice {
+  const OPTION_NAME = 'database-engine-notice';
+  const DISMISS_NOTICE_TIMEOUT_SECONDS = 15_552_000; // 6 months
+  const CACHE_TIMEOUT_SECONDS = 86_400; // 1 day
+  const MAX_TABLES_TO_DISPLAY = 2;
+
+  private WPFunctions $wp;
+
+  private EntityManager $entityManager;
+
+  public function __construct(
+    WPFunctions $wp,
+    EntityManager $entityManager
+  ) {
+    $this->wp = $wp;
+    $this->entityManager = $entityManager;
+  }
+
+  public function init($shouldDisplay): ?Notice {
+    if (!$shouldDisplay || Connection::isSQLite() || $this->wp->getTransient(self::OPTION_NAME)) {
+      return null;
+    }
+
+    try {
+      $tablesWithIncorrectEngine = $this->checkTableEngines();
+      if ($tablesWithIncorrectEngine === []) {
+        return null;
+      }
+
+      return $this->display($tablesWithIncorrectEngine);
+    } catch (\Exception $e) {
+        return null;
+    }
+  }
+
+  /**
+   * Returns a list of table names that are not using the InnoDB engine.
+   */
+  private function checkTableEngines(): array {
+    $cacheKey = self::OPTION_NAME . '-cache';
+    $cachedTables = $this->wp->getTransient($cacheKey);
+    if (is_array($cachedTables)) {
+      return $cachedTables;
+    }
+
+    $tables = $this->loadTablesWithIncorrectEngines();
+
+    $this->wp->setTransient($cacheKey, $tables, self::CACHE_TIMEOUT_SECONDS);
+    return $tables;
+  }
+
+  private function loadTablesWithIncorrectEngines(): array {
+    $data = $this->entityManager->getConnection()->executeQuery(
+      'SHOW TABLE STATUS WHERE Name LIKE :prefix',
+      [
+        'prefix' => Env::$dbPrefix . '_%',
+      ]
+    )->fetchAllAssociative();
+
+    return array_map(
+      fn($row) => $row['Name'],
+      array_filter(
+        $data,
+        fn($row) => isset($row['Engine']) && is_string($row['Engine']) && (strtolower($row['Engine']) !== 'innodb')
+      )
+    );
+  }
+
+  private function display(array $tablesWithIncorrectEngine): Notice {
+    // translators: %s is the list of the table names
+    $errorString = __('Some of the MailPoet plugin’s tables are not using the InnoDB engine (%s). This may cause performance and compatibility issues. Please ensure all MailPoet tables are converted to use the InnoDB engine. For more information, check out [link]this guide[/link].', 'mailpoet');
+    $tables = $this->formatTableNames($tablesWithIncorrectEngine);
+    $errorString = sprintf($errorString, $tables);
+    $error = Helpers::replaceLinkTags($errorString, 'https://kb.mailpoet.com/article/200-solving-database-connection-issues#database-configuration', [
+      'target' => '_blank',
+    ]);
+
+    $extraClasses = 'mailpoet-dismissible-notice is-dismissible';
+
+    return Notice::displayWarning($error, $extraClasses, self::OPTION_NAME);
+  }
+
+  private function formatTableNames(array $tablesWithIncorrectEngine): string {
+    sort($tablesWithIncorrectEngine);
+
+    $tables = array_map(
+      fn($table) => "“{$table}”",
+      array_slice($tablesWithIncorrectEngine, 0, self::MAX_TABLES_TO_DISPLAY)
+    );
+
+    $remainingTablesCount = count($tablesWithIncorrectEngine) - count($tables);
+    if ($remainingTablesCount > 0) {
+      // translators: %d is the number of remaining tables, the whole string will be: "table1, table2 and 3 more"
+      $tables[] = sprintf(__('and %d more', 'mailpoet'), $remainingTablesCount);
+    }
+
+    return implode(', ', $tables);
+  }
+
+  public function disable() {
+    $this->wp->setTransient(self::OPTION_NAME, true, self::DISMISS_NOTICE_TIMEOUT_SECONDS);
+  }
+}