OPCache::drushInvalidate() - Code Metrics - VeggieMeat/opcache - Measure and Improve Code Quality continuously with Scrutinizer

OPCache::drushInvalidate() A
last analyzed 2016-10-12 10:40 UTC

↳ Parent: OPCache

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

namespace OPCache;

use OPCache\FCGIRequest;
use OPCache\HTTPRequest;
use OPCache\OPCacheConfiguration;
use OPCache\OPCacheStatus;

class OPCache {

  private $queryString;
  private $scripts;
  private $servers;
  private $uri;

  public function __construct() {
    $this->servers = variable_get('opcache_backends', NULL);
  }

  private function buildQueryString($params) {
    $this->buildUri($params);
    $this->queryString = 'q=' . $this->uri;
  }

  private function buildUri($params) {
    $token = $this->getToken();
    $this->uri = 'opcache/' . REQUEST_TIME . '/' . $token . '/' . $params['op'];
    if (isset($params['script'])) {
      $this->uri .= '/' . $params['script'];
    }
    if ($params['op'] == 'reset' && $params['all']) {
      $this->uri .= '/all';
    }
  }

  public function cacheClear() {
    if (!$this->servers) {
      return $this->reset();
    }

    // Multiple backends must be cleared.
    $params = [];
    $params['op'] = 'reset';
    $this->multiBackendRequest($params);
  }

  public function config() {
    $config = new OPCacheConfiguration();
    return $config->getDirectives();
  }

  private function drushBuildUrl($server, $params) {
    $this->buildQueryString($params);
    $url = "{$server}?{$this->queryString}";
    return $url;
  }

  public function drushInvalidate($script) {
    $params = array();
    $params['op'] = 'invalidate';
    $params['script'] = $script;
    $this->drushRequest($params);
  }

  public function drushReset($all) {
    $params = array();
    $params['op'] = 'reset';
    $params['all'] = $all;
    $this->drushRequest($params);
  }

  public function drushStatus() {
    $params = array();
    $params['op'] = 'status';
    return $this->drushRequest($params);
  }

  private function drushRequest($params = array()) {
    global $base_url;
    if (preg_match('/default$/', $base_url) && !$this->servers) {
      drush_log(dt("In order to properly reset the OPcache cache, please use the -l/--uri flag to specify the correct URL of this Drupal installation, or specify paths to the PHP proxy servers in the OPcache module's settings form."), 'error');
      return;
    }
    if (!$this->servers) {
      $server = url('<front>', array('absolute' => TRUE));
      $this->httpRequest($server, $params);
    }
    else {
      $this->multiBackendRequest($params);
    }
  }

  private function fcgiRequest($server, $params) {

    $fcgi = substr($server, 7);
    try {
      $command = new FCGIRequest($fcgi, $this->uri, $this->queryString);
      $command->run();
    } catch (\Exception $e) {
      watchdog('opcache', 'An error was encountered clearing OPCache on %server. Message: %error', array('%server' => $server, '%error' => $e->getMessage()), WATCHDOG_ERROR);
    }
  }

  private function getScripts() {
    $status = new OPCacheStatus(TRUE);
    $scripts = $status->getScripts();
    foreach ($scripts as $script) {
      if (strpos($script['full_path'], DRUPAL_ROOT) !== FALSE) {
        $this->scripts[] = $script['full_path'];
      }
    }
  }

  public function getToken($request_time = REQUEST_TIME) {
    return drupal_hmac_base64('opcache:' . $request_time, drupal_get_private_key() . drupal_get_hash_salt());
  }

  private function httpRequest($server, $params) {
    global $base_url;
    $urldata = @parse_url($base_url);

    $url = $this->drushBuildUrl($server, $params);
    try {
      $client = new HTTPRequest();
      $request = $client->createRequest('GET', $url);

      $request->setHeader('Host', $urldata['host']);
      $response = $client->send($request);
      $status = $response->getStatusCode();
      $this->logResponse($server, $status, $params);
    } catch (\Exception $e) {
      watchdog('opcache', 'An error was encountered clearing OPCache on %server. Message: %error', array('%server' => $server, '%error' => $e->getMessage()), WATCHDOG_ERROR);
    }
  }

  public function isEnabled() {
    $status = new OPCacheStatus();
    $info = $status->getCurrentStatus();
    if ($info['opcache_enabled']) {
      return TRUE;
    }
  }

  public function invalidate($script, $force = FALSE) {
    return opcache_invalidate($script, $force);
  }

  public function invalidateMultiple(array $scripts, $force = FALSE) {
    $invalidation_counter = 0;
    if (!empty($scripts)) {
      foreach ($scripts as $script) {
        $this->invalidate($script, $force);
        $invalidation_counter++;
      }

      watchdog('opcache', '@scripts scripts were invalidated in OPCache.', array('@scripts' => $invalidation_counter), WATCHDOG_INFO);
    }
    else {
      watchdog('opcache', 'No scripts were available for invalidation in OPCache.', array(), WATCHDOG_INFO);
    }
  }

  private function logResponse($server, $status, $params) {
    switch ($status) {
      case 200:
        if ($params['op'] === 'reset') {
          watchdog('opcache', 'OPcache was reset at @server.', array('@server' => $server), WATCHDOG_INFO);
        }
        elseif ($params['op'] === 'invalidate') {
          watchdog('opcache', '@script was invalidated in OPcache at @server.', array('@script' => $params['script'], '@server' => $server), WATCHDOG_INFO);
        }
        break;
      case 404:
        watchdog('opcache', 'OPcache operation at @server failed; the reset path could not be found (404).', array('@server' => $server), WATCHDOG_ERROR);
        break;
      case 403:
        watchdog('opcache', 'OPcache operation at @server failed; access to the reset path was denied (403). This may happen if too much time elapsed during the request process. Please try again.', array('@server' => $server), WATCHDOG_ERROR);
        break;
      case 0:
        watchdog('opcache', 'OPcache operation at @server failed; server could not be reached.', array('@server' => $server), WATCHDOG_ERROR);
        break;
      default:
        watchdog('opcache', 'OPcache operation at @server failed; status code @code.', array('@server' => $server, '@code' => $status), WATCHDOG_ERROR);
    }
  }

  private function multiBackendRequest($params) {
    foreach ($this->servers as $server) {
      if (substr($server, 0, 7) == 'fcgi://') {
        $method = 'fcgiRequest';
      }
      else {
        $method = 'httpRequest';
      }

      $this->{$method}($server, $params);
    }
  }

  public function reset($all = FALSE) {
    if ($all) {
      return opcache_reset();
    }

    $this->getScripts();
    $this->invalidateMultiple($this->scripts, TRUE);
  }

  public function status() {
    $status = new OPCacheStatus();
    return $status->getStatusData();
  }

  public function verifyToken($request_time, $token) {
    return $token === $this->getToken($request_time);
  }

}


1			<?php
2
3			namespace OPCache;
4
5			use OPCache\FCGIRequest;
6			use OPCache\HTTPRequest;
7			use OPCache\OPCacheConfiguration;
8			use OPCache\OPCacheStatus;
9
10			class OPCache {
11
12			private $queryString;
13			private $scripts;
14			private $servers;
15			private $uri;
16
17			public function __construct() {
18			$this->servers = variable_get('opcache_backends', NULL);
19			}
20
21			private function buildQueryString($params) {
22			$this->buildUri($params);
23			$this->queryString = 'q=' . $this->uri;
24			}
25
26			private function buildUri($params) {
27			$token = $this->getToken();
28			$this->uri = 'opcache/' . REQUEST_TIME . '/' . $token . '/' . $params['op'];
29			if (isset($params['script'])) {
30			$this->uri .= '/' . $params['script'];
31			}
32			if ($params['op'] == 'reset' && $params['all']) {
33			$this->uri .= '/all';
34			}
35			}
36
37			public function cacheClear() {
38			if (!$this->servers) {
39			return $this->reset();
40			}
41
42			// Multiple backends must be cleared.
43			$params = [];
44			$params['op'] = 'reset';
45			$this->multiBackendRequest($params);
46			}
47
48			public function config() {
49			$config = new OPCacheConfiguration();
50			return $config->getDirectives();
51			}
52
53			private function drushBuildUrl($server, $params) {
54			$this->buildQueryString($params);
55			$url = "{$server}?{$this->queryString}";
56			return $url;
57			}
58
59			public function drushInvalidate($script) {
60			$params = array();
61			$params['op'] = 'invalidate';
62			$params['script'] = $script;
63			$this->drushRequest($params);
64			}
65
66			public function drushReset($all) {
67			$params = array();
68			$params['op'] = 'reset';
69			$params['all'] = $all;
70			$this->drushRequest($params);
71			}
72
73			public function drushStatus() {
74			$params = array();
75			$params['op'] = 'status';
76			return $this->drushRequest($params);
77			}
78
79			private function drushRequest($params = array()) {
80			global $base_url;
81			if (preg_match('/default$/', $base_url) && !$this->servers) {
82			drush_log(dt("In order to properly reset the OPcache cache, please use the -l/--uri flag to specify the correct URL of this Drupal installation, or specify paths to the PHP proxy servers in the OPcache module's settings form."), 'error');
83			return;
84			}
85			if (!$this->servers) {
86			$server = url('<front>', array('absolute' => TRUE));
87			$this->httpRequest($server, $params);
88			}
89			else {
90			$this->multiBackendRequest($params);
91			}
92			}
93
94			private function fcgiRequest($server, $params) {
			0 ignored issues – show Unused Code introduced 2016-10-12 10:33 UTC by Report Bug Copy Issue Report The parameter `$params` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
95			$fcgi = substr($server, 7);
96			try {
97			$command = new FCGIRequest($fcgi, $this->uri, $this->queryString);
98			$command->run();
99			} catch (\Exception $e) {
100			watchdog('opcache', 'An error was encountered clearing OPCache on %server. Message: %error', array('%server' => $server, '%error' => $e->getMessage()), WATCHDOG_ERROR);
101			}
102			}
103
104			private function getScripts() {
105			$status = new OPCacheStatus(TRUE);
106			$scripts = $status->getScripts();
107			foreach ($scripts as $script) {
108			if (strpos($script['full_path'], DRUPAL_ROOT) !== FALSE) {
109			$this->scripts[] = $script['full_path'];
110			}
111			}
112			}
113
114			public function getToken($request_time = REQUEST_TIME) {
115			return drupal_hmac_base64('opcache:' . $request_time, drupal_get_private_key() . drupal_get_hash_salt());
116			}
117
118			private function httpRequest($server, $params) {
119			global $base_url;
120			$urldata = @parse_url($base_url);
121
122			$url = $this->drushBuildUrl($server, $params);
123			try {
124			$client = new HTTPRequest();
125			$request = $client->createRequest('GET', $url);
			0 ignored issues – show Bug introduced 2016-10-12 10:40 UTC by Report Bug Copy Issue Report The method `createRequest()` does not exist on `OPCache\HTTPRequest`. Did you maybe mean `request()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
126			$request->setHeader('Host', $urldata['host']);
127			$response = $client->send($request);
128			$status = $response->getStatusCode();
129			$this->logResponse($server, $status, $params);
130			} catch (\Exception $e) {
131			watchdog('opcache', 'An error was encountered clearing OPCache on %server. Message: %error', array('%server' => $server, '%error' => $e->getMessage()), WATCHDOG_ERROR);
132			}
133			}
134
135			public function isEnabled() {
136			$status = new OPCacheStatus();
137			$info = $status->getCurrentStatus();
138			if ($info['opcache_enabled']) {
139			return TRUE;
140			}
141			}
142
143			public function invalidate($script, $force = FALSE) {
144			return opcache_invalidate($script, $force);
145			}
146
147			public function invalidateMultiple(array $scripts, $force = FALSE) {
148			$invalidation_counter = 0;
149			if (!empty($scripts)) {
150			foreach ($scripts as $script) {
151			$this->invalidate($script, $force);
152			$invalidation_counter++;
153			}
154
155			watchdog('opcache', '@scripts scripts were invalidated in OPCache.', array('@scripts' => $invalidation_counter), WATCHDOG_INFO);
156			}
157			else {
158			watchdog('opcache', 'No scripts were available for invalidation in OPCache.', array(), WATCHDOG_INFO);
159			}
160			}
161
162			private function logResponse($server, $status, $params) {
163			switch ($status) {
164			case 200:
165			if ($params['op'] === 'reset') {
166			watchdog('opcache', 'OPcache was reset at @server.', array('@server' => $server), WATCHDOG_INFO);
167			}
168			elseif ($params['op'] === 'invalidate') {
169			watchdog('opcache', '@script was invalidated in OPcache at @server.', array('@script' => $params['script'], '@server' => $server), WATCHDOG_INFO);
170			}
171			break;
172			case 404:
173			watchdog('opcache', 'OPcache operation at @server failed; the reset path could not be found (404).', array('@server' => $server), WATCHDOG_ERROR);
174			break;
175			case 403:
176			watchdog('opcache', 'OPcache operation at @server failed; access to the reset path was denied (403). This may happen if too much time elapsed during the request process. Please try again.', array('@server' => $server), WATCHDOG_ERROR);
177			break;
178			case 0:
179			watchdog('opcache', 'OPcache operation at @server failed; server could not be reached.', array('@server' => $server), WATCHDOG_ERROR);
180			break;
181			default:
182			watchdog('opcache', 'OPcache operation at @server failed; status code @code.', array('@server' => $server, '@code' => $status), WATCHDOG_ERROR);
183			}
184			}
185
186			private function multiBackendRequest($params) {
187			foreach ($this->servers as $server) {
188			if (substr($server, 0, 7) == 'fcgi://') {
189			$method = 'fcgiRequest';
190			}
191			else {
192			$method = 'httpRequest';
193			}
194
195			$this->{$method}($server, $params);
196			}
197			}
198
199			public function reset($all = FALSE) {
200			if ($all) {
201			return opcache_reset();
202			}
203
204			$this->getScripts();
205			$this->invalidateMultiple($this->scripts, TRUE);
206			}
207
208			public function status() {
209			$status = new OPCacheStatus();
210			return $status->getStatusData();
211			}
212
213			public function verifyToken($request_time, $token) {
214			return $token === $this->getToken($request_time);
215			}
216
217			}
218

VeggieMeat / opcache

OPCache::drushInvalidate() A last analyzed 2016-10-12 10:40 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

OPCache::drushInvalidate() A
last analyzed 2016-10-12 10:40 UTC