wincachedrupal-8.0.2/src/Installer.php

<?php

namespace Drupal\wincachedrupal;

use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\Link;
use Drupal\Core\Url;

/**
 * Install requirements class.
 */
class Installer {

  use StringTranslationTrait;

  /**
   * Provides results for hook_requirements().
   */
  public function requirements($phase) {
    $requirements = [];

    // Test WinCache.
    $wincache_enabled = \Drupal\wincachedrupal\WincacheWrapper::wincachedrupal_enabled();

    $wincache_version = phpversion('wincache');

    $link = Link::fromTextAndUrl('Official WinCache Extension Documentation',
      Url::fromUri('http://php.net/manual/en/book.wincache.php'))->toString();

    $wincache_description = $this->t(
      'The wincachedrupal module needs the wincache extension<br/>see: @link.',
      ['@link' => $link]
    );

    $requirements['wincache'] = [
      'title' => $this->t('WinCache version'),
      'value' => $wincache_enabled ? $wincache_version : $this->t('Not available'),
      'severity' => $wincache_enabled ? REQUIREMENT_OK : REQUIREMENT_ERROR,
      'description' => $wincache_description,
    ];

    $comenabled = extension_loaded('com_dotnet');
    if (!$comenabled) {
      $requirements['wincache_comenabled'] = [
        'title' => $this->t('WinCache com_dotnet enabled'),
        'value' => $this->t('No'),
        'severity' => REQUIREMENT_WARNING,
        'description' => $this->t('.Net performance optimizations not available. The COM DOTNET extension is not loaded. Add extension=com_dotnet.dll to your php.ini file.'),
      ];
    }

    // The first step is to enable COM, then make the NetPhp binary available.
    if ($comenabled) {

      $netphp = \Drupal::service('netphp');

      $netphp_support = $netphp->hasNetPhpSupport();
      $netphp_version = FALSE;
      if ($netphp_support === TRUE) {
        $netphp_version = $netphp->getRuntime()->GetStringVersion() . ' | ' . $netphp->getRuntime()->GetRuntimeVersion()->GetJson();
      }
      $requirements['wincache_netphp'] = [
        'title' => $this->t('WinCache NetPhp version'),
        'value' => $netphp_support === TRUE ? $this->t('The NetPhp service is up and running.') : $this->t('.Net based performance optimizations are not available. Either the NetPhp to start or you have not deployed it yet. See the Readme.md file for setup instructions.'),
        'severity' => $netphp_support === TRUE ? REQUIREMENT_OK : REQUIREMENT_WARNING,
        'description' => $netphp_support === TRUE ? $netphp_version : $netphp_support,
      ];

      // Asset optimizations need the AjaxMin library.
      $ajaxmin_support = $netphp->hasAjaxMinSupport();
      $requirements['wincache_ajaxmin'] = [
        'title' => $this->t('Wincache AjaxMin asset optimization'),
        'value' => $ajaxmin_support === TRUE ? $this->t('Asset optimization enabled using the AjaxMin library.') : $this->t('AjaxMin assset optimizations not available.'),
        'severity' => $ajaxmin_support === TRUE ? REQUIREMENT_OK : REQUIREMENT_WARNING,
        'description' => $ajaxmin_support === TRUE ? NULL : $ajaxmin_support,
      ];
    }

    if ($wincache_enabled) {

      $formatter = \Drupal::service('date.formatter');

      $ucache_meminfo = \Drupal\wincachedrupal\WincacheWrapper::wincachedrupal_ucache_meminfo();
      $cache = \Drupal\wincachedrupal\WincacheWrapper::wincachedrupal_ucache_info();

      $requirements['wincache_ucache'] = [
        'title' => $this->t('WinCache user cache'),
        'value' => $this->t('Enabled. Memory total: @total. Used @used%.', [
          '@total' => format_size($ucache_meminfo['memory_total']),
          '@used' => round(100 - (($ucache_meminfo['memory_free'] / $ucache_meminfo['memory_total']) * 100), 2),
        ]),
        'severity' => REQUIREMENT_OK,
      ];

      $requirements['wincache_ucache']['description'] = $this->t('WinCache has been running for @duration. Currently caching @num_entries entries. Hit rate @hitrate%.',
        [
          '@duration' => $formatter->formatInterval($cache['total_cache_uptime']),
          '@num_entries' => $cache['total_item_count'],
          '@hitrate' => round(($cache['total_hit_count'] / ($cache['total_hit_count'] + $cache['total_miss_count'])) * 100, 2) ,
        ]
      );
    }

    if ($phase == 'runtime' && $wincache_enabled) {

      $options = ini_get_all('wincache', TRUE);
      /*
       * 1.3.7.2 What's new:
       * If you disable the WinCache opcache in the php.ini
       * (wincache.ocenabled=0), you should no longer see a shared memory
       * mapping for the opcache. Also, you won't be able to turn it on in
       * either a .user.ini or in a php script.
       */
      if (version_compare($wincache_version, '1.3.7.2', '<')) {
        if ($options['wincache.ocenabled']['local_value'] == 0) {
          $ocachesize = $options['wincache.ocachesize']['local_value'];
          $requirements['wincache_oc_size'] = [
            'title' => $this->t('Wincache opcode cache size'),
            'value' => $this->t('Opcode caching is disabled and current cache size is @sizeMb', ['@size' => $ocachesize]),
            'severity' => ($ocachesize > 15) ? REQUIREMENT_ERROR : REQUIREMENT_OK,
            'description' => $this->t('When opcode caching is disabled, reduce memory pressure on the server by setting wincache.ocachesize to the minimum value allowed (15Mb).'),
          ];
        }
      }
      /*
       * Zend OPCACHE is UNSTABLE on Windows and.... no one cares.
       * Is this a windows server?
       * Probably yes, because this is the WincacheDriver!
       */
      $is_windows = strncasecmp(PHP_OS, 'WIN', 3) == 0;
      if ($is_windows) {
        if (version_compare(PHP_VERSION, '7.0.0') < 0) {
          /*
           * Make sure that in versions prior to PHP 7 wincache
           * is in charge of Opcode Caching.
           */
          if (function_exists('wincache_ocache_meminfo')) {
            $opcode_ok = $options['wincache.ocenabled']['local_value'] == 1;
            $requirements['wincache_oc'] = [
              'title' => $this->t('Wincache Opcode cache'),
              'value' => $opcode_ok ? $this->t('Opcode cache is being handled by Wincache.') : $this->t('The Wincache Opcode cache should be enabled. Do not rely on ZEND_OPCACHE, it is unstable on windows platforms for PHP < 7.'),
              'severity' => $opcode_ok ? REQUIREMENT_OK : REQUIREMENT_ERROR,
            ];
          }
        }
        /*
         * Why is there a wincache.apppoolid setting?
         * A: For debugging purposes only.  It should never be explicitly set
         * in production environments.
         * Q: Has WinCache been tested with custom application pool identities?
         * e.g. NetworkService, LocalSystem, LocalService, or "Custom account"
         * in the App Pool | Advanced Settings | Application Pool Identity
         * dialog of inetmgr.exe
         * A: No, it has not.  It's very possible that it won't work for
         * anything other than ApplicationPoolIdentity.
         * Q: What happens when wincache.apppoolid is not set?
         * A: When IIS launches php-cgi.exe, it adds an environment variable
         * (APP_POOL_ID), and that's what wincache will use if the apppoolid
         * setting is not set.  The variable will contain the account name under
         * the IIS APPPOOL domain to use for the app pool.
         */
        $apppool_ok = empty($options['wincache.apppoolid']['local_value']);
        if (!$apppool_ok) {
          $requirements['wincache_apppoolid'] = [
            'title' => $this->t('Wincache wincache.apppoolid ini setting'),
            'value' => $this->t('wincache.apppoolid should never be used in production environments!'),
            'severity' => REQUIREMENT_WARNING,
          ];
        }
      }
    }

    return $requirements;
  }

}