Fixed bin & global prefixes & and module check for debug (requires devel)

Author: Geolim4

phpfastcache.module

@@ -11,10 +11,17 @@ function phpfastcache_help(
   RouteMatchInterface $route_match
 ): TranslatableMarkup {
   if ($route_name === 'phpfastcache.admin_settings_form') {
+    $help = <<<HELP
+<a href=":site_url" target="_blank">Phpfastcache</a> is a high-performance backend cache system. 
+It is intended for use in speeding up dynamic web applications by alleviating database load. 
+Check out the <a href=":github_url" target="_blank">Github support</a> for the Phpfastcache's library only.
+HELP;
+
     return t(
-      '<a href=":url" target="_blank">PhpFastCache</a> is a high-performance, distributed object caching system, generic in nature, but intended for use in speeding up dynamic web applications by alleviating database load.',
+      nl2br($help),
       [
-        ':url' => 'https://github.com/PHPSocialNetwork/phpfastcache',
+        ':site_url' => 'https://www.phpfastcache.com/',
+        ':github_url' => 'https://github.com/PHPSocialNetwork/phpfastcache',
       ]
     );
   }

phpfastcache.services.yml

@@ -1,7 +1,7 @@
 services:
     phpfastcache_event_subscriber:
         class: Drupal\phpfastcache\EventSubscriber\PhpfastcacheSubscriber
-        arguments: ['@cache.backend.phpfastcache']
+        arguments: ['@cache.backend.phpfastcache', '@module_handler']
         tags:
         - {name: event_subscriber}
     cache.backend.phpfastcache:

src/Cache/PhpfastcacheBackend.php

@@ -223,13 +223,18 @@ protected function getDrupalCacheStdObject(): PhpfastcacheStoredObject {
    *   An ASCII-encoded cache ID that is at most 255 characters long.
    * @see DatabaseBackend::normalizeCid()
    */
-  protected function normalizeCid($cid): string {
+  protected function normalizeCid(string $cid): string {
     static $maxKeyLength = 64;
 
     /**
-     * Add PhpFastCache Prefix
+     * Add Bin Prefix
      */
-    $cid = ($this->settings[ 'phpfastcache_prefix' ] ?: 'd8') . '-' . $cid;
+    $cid = $this->binPrefix . $cid;
+
+    /**
+     * Add Phpfastcache Prefix
+     */
+    $cid = ($this->settings[ 'phpfastcache_prefix' ] ?: 'D8') . '.' . $cid;
 
     /**
      * Nothing to do if the ID is a US ASCII string of 64 characters or less.
@@ -245,21 +250,23 @@ protected function normalizeCid($cid): string {
      */
     $hash = Crypt::hashBase64($cid);
 
+    $hash = '_._' . trim(substr($hash, 3), '-_.');
+
     if (!$cid_is_ascii) {
       return $this->replaceUnsupportedPsr6Characters($hash);
     }
 
     return $this->replaceUnsupportedPsr6Characters(
-      $this->binPrefix . substr($cid, 0, $maxKeyLength - \strlen($hash)) . $hash
+      substr($cid, 0, $maxKeyLength - \strlen($hash)) . $hash
     );
   }
 
   /**
-   * @param $str
+   * @param string $str
    *
-   * @return mixed
+   * @return string
    */
-  protected function replaceUnsupportedPsr6Characters($str) {
+  protected function replaceUnsupportedPsr6Characters(string $str): string {
     return str_replace(
       ['{', '}', '(', ')', '/', '\\', '@', ':'],
       '_',

src/Cache/PhpfastcacheBackendFactory.php

@@ -9,7 +9,7 @@
 
 /**
  * Class PhpFastCacheBackendFactory
- * @todo Uncamelize class name...
+ *
  */
 class PhpfastcacheBackendFactory implements CacheFactoryInterface {
 
@@ -51,15 +51,22 @@ class PhpfastcacheBackendFactory implements CacheFactoryInterface {
    */
   protected $connection;
 
+  /**
+   * @var \Drupal\Core\Cache\CacheBackendInterface[]
+   */
+  protected $cacheBins = [];
+
   /**
    * PhpFastCacheBackendFactory constructor.
    *
    * @param \Drupal\Core\Database\Connection $connection
+   *
    * @throws \Phpfastcache\Exceptions\PhpfastcacheDriverCheckException
    * @throws \Phpfastcache\Exceptions\PhpfastcacheDriverException
    * @throws \Phpfastcache\Exceptions\PhpfastcacheDriverNotFoundException
    * @throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException
    * @throws \Phpfastcache\Exceptions\PhpfastcacheInvalidConfigurationException
+   * @throws \Drupal\phpfastcache\Exceptions\CacheBackendException
    */
   public function __construct(Connection $connection) {
     $this->backendClass = PhpfastcacheBackend::class;
@@ -97,15 +104,16 @@ public function __construct(Connection $connection) {
    * @throws \Phpfastcache\Exceptions\PhpfastcacheDriverNotFoundException
    * @throws \Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException
    * @throws \Phpfastcache\Exceptions\PhpfastcacheInvalidConfigurationException
+   * @throws \Drupal\phpfastcache\Exceptions\CacheBackendException
    */
   protected function getPhpfastcacheInstance(): ExtendedCacheItemPoolInterface {
     return PhpfastcacheInstanceBuilder::buildInstance($this->settings);
   }
 
   /**
-   * Get settings from database.
-   * At this level of runtime execution
-   * settings are not available yet.
+   * Get settings straight from database.
+   * At this level of runtime execution,
+   * settings API is not yet available.
    *
    * @return array
    */
@@ -126,19 +134,24 @@ public function getSettingsFromDatabase(): array {
    * @param string $bin
    *   The cache bin for which the object is created.
    *
-   * @return \Drupal\phpfastcache\Cache\PhpfastcacheBackend|\Drupal\phpfastcache\Cache\PhpfastcacheVoidBackend
+   * @return \Drupal\Core\Cache\CacheBackendInterface
    *   The cache backend object for the specified cache bin.
    * @throws CacheBackendException
    */
   public function get($bin) {
-    try{
-      return new $this->backendClass($bin, $this->cachePool, $this->settings);
-    }catch(\Throwable $e){
-      throw new CacheBackendException(\sprintf(
-        'Failed to create a cache backend instance for "%s" cache bin, got the following error: %s',
-        $bin,
-        $e->getMessage()
-      ));
+    try {
+      if (!isset($this->cacheBins[ $bin ])) {
+        $this->cacheBins[ $bin ] = new $this->backendClass($bin, $this->cachePool, $this->settings);
+      }
+      return $this->cacheBins[ $bin ];
+    } catch (\Throwable $e) {
+      throw new CacheBackendException(
+        \sprintf(
+          'Failed to create a cache backend instance for "%s" cache bin, got the following error: %s',
+          $bin,
+          $e->getMessage()
+        )
+      );
     }
   }
 }

src/Cache/PhpfastcacheInstanceBuilder.php

@@ -14,7 +14,6 @@
 use Phpfastcache\CacheManager;
 use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
 use Phpfastcache\Exceptions\PhpfastcacheDriverCheckException;
-use Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException;
 
 class PhpfastcacheInstanceBuilder {
 
@@ -53,9 +52,11 @@ public static function buildInstance($settings): ExtendedCacheItemPoolInterface
       );
     } catch (PhpfastcacheDriverCheckException $e) {
       $error    = "The '{$driverName}' driver failed to initialize with the following error: {$e->getMessage()} line {$e->getLine()} in {$e->getFile()}.";
+      CacheManager::clearInstances();
       $instance = CacheManager::getInstance('Devnull');
     } catch (\Throwable $e) {
       $error    = "The '{$driverName}' driver encountered the following error: {$e->getMessage()} line {$e->getLine()} in {$e->getFile()}.";
+      CacheManager::clearInstances();
       $instance = CacheManager::getInstance('Devnull');
     }
 

src/EventSubscriber/PhpfastcacheSubscriber.php

@@ -4,6 +4,7 @@
 
 use Drupal\Component\Render\FormattableMarkup;
 use Drupal\Core\Cache\CacheFactoryInterface;
+use Drupal\Core\Extension\ModuleHandler;
 use Drupal\Core\Utility\Error;
 use Drupal\phpfastcache\Cache\PhpfastcacheBackendFactory;
 use Phpfastcache\Exceptions\PhpfastcacheRootException;
@@ -26,8 +27,14 @@ class PhpfastcacheSubscriber implements EventSubscriberInterface {
    */
   protected $cacheFactory;
 
-  public function __construct(CacheFactoryInterface $cacheFactory) {
+  /**
+   * @var \Drupal\Core\Extension\ModuleHandler
+   */
+  protected $moduleHandler;
+
+  public function __construct(CacheFactoryInterface $cacheFactory, ModuleHandler $moduleHandler) {
     $this->cacheFactory = $cacheFactory;
+    $this->moduleHandler = $moduleHandler;
   }
 
   /**
@@ -36,12 +43,15 @@ public function __construct(CacheFactoryInterface $cacheFactory) {
   public function onPhpfastcacheException(GetResponseForExceptionEvent $event) {
     /**
      * Make sure that we handle the exceptions
-     * that we should about
+     * that we are allowed to manage
      */
     if ($this->cacheFactory instanceof PhpfastcacheBackendFactory) {
       $settings      = $this->cacheFactory->getSettingsFromDatabase();
-      $culpritDriver = \ucfirst($settings[ 'phpfastcache_default_driver' ]);
-      if ($settings[ 'phpfastcache_env' ] === PhpfastcacheBackendFactory::ENV_DEV && $event->getException() instanceof PhpfastcacheRootException) {
+      if ($settings[ 'phpfastcache_env' ] === PhpfastcacheBackendFactory::ENV_DEV
+          && $event->getException() instanceof PhpfastcacheRootException
+          && $this->moduleHandler->moduleExists('devel')
+      ) {
+        $culpritDriver = \ucfirst($settings[ 'phpfastcache_default_driver' ]);
         /**
          * Preparing message args
          */

src/Form/PhpFastCacheAdminSettingsForm.php

@@ -3,13 +3,16 @@
 namespace Drupal\phpfastcache\Form;
 
 use Drupal\Component\Utility\Random;
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Extension\ModuleHandler;
 use Drupal\Core\Form\ConfigFormBase;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\phpfastcache\Cache\PhpfastcacheBackendFactory;
 use Drupal\phpfastcache\Form\Fields\PhpfastcacheAdminFieldClassMap;
 use Drupal\phpfastcache\CacheManager;
 use Phpfastcache\Api as PhpfastcacheApi;
 use Phpfastcache\Exceptions\PhpfastcacheDriverCheckException;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Configure phpfastcache settings for this site.
@@ -19,6 +22,32 @@ class PhpFastCacheAdminSettingsForm extends ConfigFormBase {
 
   const PREFIX_REGEXP = '^\w*$';
 
+  /**
+   * @var \Drupal\Core\Extension\ModuleHandler
+   */
+  protected $moduleHandler;
+
+  /**
+   * PhpFastCacheAdminSettingsForm constructor.
+   *
+   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+   * @param \Drupal\Core\Extension\ModuleHandler       $moduleHandler
+   */
+  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandler $moduleHandler) {
+    parent::__construct($config_factory);
+    $this->moduleHandler = $moduleHandler;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('config.factory'),
+      $container->get('module_handler')
+    );
+  }
+
   /**
    * {@inheritdoc}
    */
@@ -94,27 +123,31 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       ],
     ];
 
-    // @todo conditional if webprofiler module
-    $form[ 'general' ][ 'phpfastcache_settings_wrapper' ][ 'phpfastcache_env' ] = [
-      '#default_value' => (string) $config->get('phpfastcache_env'),
-      '#description'   => $this->t(
-        '<strong>Production</strong>: Will displays minimal information in case of failure.<br />
+    if($this->moduleHandler->moduleExists('devel')){
+      $form[ 'general' ][ 'phpfastcache_settings_wrapper' ][ 'phpfastcache_env' ] = [
+        '#default_value' => (string) $config->get('phpfastcache_env'),
+        '#description'   => $this->t(
+          '<strong>Production</strong>: Will displays minimal information in case of failure.<br />
                                     <strong>Development</strong>: Will displays very verbose information in case of failure.'
-      ),
-      '#required'      => TRUE,
-      '#options'       => [
-        PhpfastcacheBackendFactory::ENV_DEV  => t('Development'),
-        PhpfastcacheBackendFactory::ENV_PROD => t('Production'),
-      ],
-      '#title'         => $this->t('PhpFastCache environment'),
-      '#type'          => 'select',
-    ];
+        ),
+        '#required'      => TRUE,
+        '#options'       => [
+          PhpfastcacheBackendFactory::ENV_DEV  => t('Development'),
+          PhpfastcacheBackendFactory::ENV_PROD => t('Production'),
+        ],
+        '#title'         => $this->t('PhpFastCache environment'),
+        '#type'          => 'select',
+      ];
+    }else if((string) $config->get('phpfastcache_env') === PhpfastcacheBackendFactory::ENV_DEV){
+      $config->set('phpfastcache_env', PhpfastcacheBackendFactory::ENV_PROD)
+             ->save();
+    }
 
     $form[ 'general' ][ 'phpfastcache_settings_wrapper' ][ 'phpfastcache_prefix' ] = [
       '#default_value' => (string) ($config->get('phpfastcache_prefix') ?: $randomService->name(6, TRUE)),
       '#description'   => $this->t(
         'The cache keyspace prefix that will be used to identify this website. 
-                                    This value length <strong>MUST</strong> be up to 8 chars and 4 chars minimum. <br />
+                                    This value length <strong>MUST</strong> be up to 8 chars and 2 chars minimum. <br />
                                     This value <strong>MUST</strong> be unique depending your other Drupal installations on this cache backend. <br />
                                     This value <strong>MUST</strong> be alpha-numeric (' . self::PREFIX_REGEXP . ')'
       ),
@@ -205,7 +238,6 @@ public function validateForm(array &$form, FormStateInterface $form_state) {
       $form_state->setError($form, 'The driver chosen is unavailable !');
     }
 
-
     /**
      * Field Validation: phpfastcache_prefix
      */
@@ -228,11 +260,13 @@ public function validateForm(array &$form, FormStateInterface $form_state) {
   public function submitForm(array &$form, FormStateInterface $form_state) {
     $config = $this->config('phpfastcache.settings');
     $config->set('phpfastcache_enabled', (bool) $form_state->getValue('phpfastcache_enabled'))
-           ->set('phpfastcache_env', (string) $form_state->getValue('phpfastcache_env'))
            ->set('phpfastcache_prefix', (string) $form_state->getValue('phpfastcache_prefix'))
            ->set('phpfastcache_default_ttl', (int) $form_state->getValue('phpfastcache_default_ttl'))
            ->set('phpfastcache_default_driver', (string) $form_state->getValue('phpfastcache_default_driver'));
 
+    if($this->moduleHandler->moduleExists('devel')){
+      $config->set('phpfastcache_env', (string) $form_state->getValue('phpfastcache_env'));
+    }
     /*****************
      * Drivers settings
      *****************/
@@ -260,7 +294,7 @@ protected function isAvailableDriver(string $driverName): bool {
        * using memcache and memcached or
        * redis and predis together for example
        */
-      @CacheManager::getInstance($driverName);
+      $i = @CacheManager::getInstance($driverName);
       return TRUE;
     } catch (PhpfastcacheDriverCheckException $e) {
       return FALSE;