SectionIO::performFlush() - Code Metrics - Inspection of "add support for DMS module" - xini/silverstripe-section-io - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9378c1...c4fd91 )

by Florian

created 2017-01-23 07:18 UTC

SectionIO::performFlush() B

↳ Parent: SectionIO

Complexity

Conditions	6
Paths	3

Size

Total Lines	35
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	42

Importance

Changes

Metric	Value
dl	0
loc	35
ccs	0
cts	20
cp	0
rs	8.439
c	0
b	0
f	0
cc	6
eloc	18
nc	3
nop	1
crap	42

<?php

class SectionIO extends Object implements Flushable
namespace YourVendor;

class YourClass { }
{
    private static $flush_on_dev_build = true;


    private static $sitetree_flush_strategy = 'single';


    private static $api_url = 'https://aperture.section.io/api/v1';

    private static $account_id = '';

    private static $application_id = '';

    private static $environment_name = '';

    private static $proxy_name = '';

    private static $username = '';

    private static $password = '';


    /**
     * Implementation of Flushable::flush()
     * Is triggered on dev/build and ?flush=1.
     */
    public static function flush()
    {
        if (Config::inst()->get('SectionIO', 'flush_on_dev_build')) {
            return static::flushAll();
        }

        return;
    }

    public static function flushAll()
    {
        $exp = 'obj.http.x-url ~ /';

        return static::performFlush($exp);
    }

    public static function flushImage($imageID)
    {
        $image = Image::get()->byID($imageID);
        if ($image && $image->exists()) {
            $exp = 'obj.http.x-url ~ "^/'.preg_quote($image->getFilename()).'$"'; // image itself
            $exp    .= ' || obj.http.x-url ~ "^/'.preg_quote($image->Parent()->getFilename())

                    .'_resampled/(.*)\-'.preg_quote($image->Name).'$"'; // resampled versions
            return static::performFlush($exp);
        }

        return false;
    }

    public static function flushFile($fileID)
    {
        $file = File::get()->byID($fileID);
        if ($file && $file->exists()) {
            $exp = 'obj.http.x-url ~ "^/'.preg_quote($file->getFilename()).'$"';
            return static::performFlush($exp);
        }

        return false;
    }

    public static function flushSiteTree($sitetreeID)
    {
        $sitetree = SiteTree::get()->byID($sitetreeID);
        if ($sitetree && $sitetree->exists()) {
            $strategy = Config::inst()->get('SectionIO', 'sitetree_flush_strategy');
            switch ($strategy) {

                case 'single':
                    $exp = 'obj.http.content-type ~ "'.preg_quote('text/html').'"';
                    $exp .= ' && obj.http.x-url ~ "^'.preg_quote($sitetree->Link()).'$"';
                    break;

                case 'parents':
                    $exp = 'obj.http.content-type ~ "'.preg_quote('text/html').'"';
                    $exp .= ' && (obj.http.x-url ~ "^'.preg_quote($sitetree->Link()).'$"';
                    $parent = $sitetree->getParent();
                    while ($parent && $parent->exists()) {
                        $exp .= ' || obj.http.x-url ~ "^'.preg_quote($parent->Link()).'$"';
                        $parent = $parent->getParent();
                    }
                    $exp .= ')';
                    break;

                case 'all':
                    $exp = 'obj.http.content-type ~ "'.preg_quote('text/html').'"';
                    break;

                case 'everyting':
                default:
                    $exp = 'obj.http.x-url ~ /';
                    break;

            }

            return static::performFlush($exp);
        }

        return false;
    }
    
    public static function flushURL($url) {
        if ($url) {
            $exp = 'obj.http.x-url ~ "^/'.preg_quote($url).'$"';
            return static::performFlush($exp);
        }
        return false;
    }

    protected static function performFlush($banExpression)
    {
        $success = true;
        $urls = static::getUrls();
        // config loaded successfully
		if (static::checkConfig()) {
			if (count($urls) > 0) {
				foreach ($urls as $url) {

					// get restful service object
					$service = static::getService($url, $banExpression);

					// prepare headers
					$headers = static::getHeaders();

					// prepare curl options
					$options = static::getOptions();

					// call API
					$conn = $service->request(null, 'POST', null, $headers, $options);

					if ($conn->isError()) {
						SS_Log::log('SectionIO::performFlush :: '.$conn->getStatusCode().' : '.$conn->getStatusDescription().' : '.$url, SS_Log::ERR);
						$success = $success && false;
					} else {
						SS_Log::log('SectionIO::performFlush :: ban successful. url: '.$url."; ban expression: '".$banExpression."'", SS_Log::NOTICE);
					}
				}
			} else {
				SS_Log::log('SectionIO::performFlush :: no URLs loaded for ban.', SS_Log::ERR);
			}
		}
		
        return $success;
    }

    protected static function getService($url, $banExpression)
    {
        // prepare API call
        $service = new RestfulService(
            $url,
            0 // expiry time 0: do not cache the API call
        );
        // set basic auth
        $username = Config::inst()->get('SectionIO', 'username');
        $password = Config::inst()->get('SectionIO', 'password');
        $service->basicAuth($username, $password);
        // set query string (ban expression)
        $service->setQueryString(array(
            'banExpression' => $banExpression,
        ));

        return $service;
    }

    protected static function getOptions()
    {
        // prepare curl options for ssl verification
        $cert = static::getCertificates();
        $options = array(
            CURLOPT_SSL_VERIFYPEER => 1,
            CURLOPT_SSL_VERIFYHOST => 2,
            CURLOPT_CAINFO => $cert,
        );

        return $options;
    }

    protected static function getCertificates()
    {
        $cert = ini_get('curl.cainfo');
        if (!$cert) {
            $cert = BASE_PATH.'/'.SECTIONIO_BASE.'/cert/cacert.pem';
        }

        return $cert;
    }

    protected static function getHeaders()
    {
        $headers = array(
            'Content-Type: application/json',
            'Accept: application/json',
        );

        return $headers;
    }

    protected static function getUrls()
    {
        $urls = array();

        if (static::checkConfig()) {
            $api_url = Config::inst()->get('SectionIO', 'api_url');
            $account_id = Config::inst()->get('SectionIO', 'account_id');
            $application_id = Config::inst()->get('SectionIO', 'application_id');
            $application_ids = array();
            if (is_string($application_id)) {
                $application_ids = preg_split("/[\s,]+/", $application_id);
            } elseif (is_array($application_id)) {
                $application_ids = $application_id;
            }
            $environment_name = Config::inst()->get('SectionIO', 'environment_name');
            $proxy_name = Config::inst()->get('SectionIO', 'proxy_name');

            foreach ($application_ids as $appid) {
                // build API URL: /account/{accountId}/application/{applicationId}/environment/{environmentName}/proxy/{proxyName}/state
                $urls[] = Controller::join_links(
                    $api_url,
                    'account',
                    $account_id,
                    'application',
                    $appid,
                    'environment',
                    $environment_name,
                    'proxy',
                    $proxy_name,
                    'state'
                );
            }
        }

        return $urls;
    }

    protected static function checkConfig()
    {
        $missing = array();
        // check config
        $api_url = Config::inst()->get('SectionIO', 'api_url');
        if (!isset($api_url) || strlen($api_url) < 1) {
            $missing[] = 'SectionIO.api_url';
        }
        $account_id = Config::inst()->get('SectionIO', 'account_id');
        if (!isset($account_id) || strlen($account_id) < 1) {
            $missing[] = 'SectionIO.account_id';
        }
        $application_id = Config::inst()->get('SectionIO', 'application_id');
        if (!isset($application_id) || (!is_array($application_id) && strlen((string) $application_id) < 1)) {
            $missing[] = 'SectionIO.application_id';
        }
        $environment_name = Config::inst()->get('SectionIO', 'environment_name');
        if (!isset($environment_name) || strlen($environment_name) < 1) {
            $missing[] = 'SectionIO.environment_name';
        }
        $proxy_name = Config::inst()->get('SectionIO', 'proxy_name');
        if (!isset($proxy_name) || strlen($proxy_name) < 1) {
            $missing[] = 'SectionIO.proxy_name';
        }
        $username = Config::inst()->get('SectionIO', 'username');
        if (!isset($username) || strlen($username) < 1) {
            $missing[] = 'SectionIO.username';
        }
        $password = Config::inst()->get('SectionIO', 'password');
        if (!isset($password) || strlen($password) < 1) {
            $missing[] = 'SectionIO.password';
        }
        
        if (count($missing) > 0) {
			if (!Director::isDev()) {
				SS_Log::log('SectionIO:: config parameters missing: ' . implode(', ', $missing), SS_Log::WARN);
			}
            return false;
        }
        return true;
    }
}


1		<?php
2
3		class SectionIO extends Object implements Flushable
		0 ignored issues – show Coding Style Compatibility introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
4		{
5		private static $flush_on_dev_build = true;
		0 ignored issues – show Unused Code introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report The property `$flush_on_dev_build` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
6
7		private static $sitetree_flush_strategy = 'single';
		0 ignored issues – show Unused Code introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report The property `$sitetree_flush_strategy` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
8
9		private static $api_url = 'https://aperture.section.io/api/v1';
		0 ignored issues – show Unused Code introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report The property `$api_url` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
10		private static $account_id = '';
		0 ignored issues – show Unused Code introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report The property `$account_id` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
11		private static $application_id = '';
		0 ignored issues – show Unused Code introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report The property `$application_id` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
12		private static $environment_name = '';
		0 ignored issues – show Unused Code introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report The property `$environment_name` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
13		private static $proxy_name = '';
		0 ignored issues – show Unused Code introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report The property `$proxy_name` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
14		private static $username = '';
		0 ignored issues – show Unused Code introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report The property `$username` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
15		private static $password = '';
		0 ignored issues – show Unused Code introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report The property `$password` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
16
17		/**
18		* Implementation of Flushable::flush()
19		* Is triggered on dev/build and ?flush=1.
20		*/
21	1	public static function flush()
22		{
23	1	if (Config::inst()->get('SectionIO', 'flush_on_dev_build')) {
24	1	return static::flushAll();
25		}
26
27	1	return;
28		}
29
30	3	public static function flushAll()
31		{
32	3	$exp = 'obj.http.x-url ~ /';
33
34	3	return static::performFlush($exp);
35		}
36
37	1	public static function flushImage($imageID)
38		{
39	1	$image = Image::get()->byID($imageID);
40	1	if ($image && $image->exists()) {
41	1	$exp = 'obj.http.x-url ~ "^/'.preg_quote($image->getFilename()).'$"'; // image itself
42	1	$exp .= ' \|\| obj.http.x-url ~ "^/'.preg_quote($image->Parent()->getFilename())
		0 ignored issues – show Bug introduced 2016-05-03 02:45 UTC by Report Bug Copy Issue Report The method `Parent()` does not exist on `DataObject`. Did you maybe mean `parentClass()`? 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...
43	1	.'_resampled/(.*)\-'.preg_quote($image->Name).'$"'; // resampled versions
44	1	return static::performFlush($exp);
45		}
46
47		return false;
48		}
49
50	1	public static function flushFile($fileID)
51		{
52	1	$file = File::get()->byID($fileID);
53	1	if ($file && $file->exists()) {
54	1	$exp = 'obj.http.x-url ~ "^/'.preg_quote($file->getFilename()).'$"';
55	1	return static::performFlush($exp);
56		}
57
58		return false;
59		}
60
61	1	public static function flushSiteTree($sitetreeID)
62		{
63	1	$sitetree = SiteTree::get()->byID($sitetreeID);
64	1	if ($sitetree && $sitetree->exists()) {
65	1	$strategy = Config::inst()->get('SectionIO', 'sitetree_flush_strategy');
66		switch ($strategy) {
67
68	1	case 'single':
69	1	$exp = 'obj.http.content-type ~ "'.preg_quote('text/html').'"';
70	1	$exp .= ' && obj.http.x-url ~ "^'.preg_quote($sitetree->Link()).'$"';
71	1	break;
72
73	1	case 'parents':
74	1	$exp = 'obj.http.content-type ~ "'.preg_quote('text/html').'"';
75	1	$exp .= ' && (obj.http.x-url ~ "^'.preg_quote($sitetree->Link()).'$"';
76	1	$parent = $sitetree->getParent();
77	1	while ($parent && $parent->exists()) {
78	1	$exp .= ' \|\| obj.http.x-url ~ "^'.preg_quote($parent->Link()).'$"';
79	1	$parent = $parent->getParent();
80	1	}
81	1	$exp .= ')';
82	1	break;
83
84	1	case 'all':
85	1	$exp = 'obj.http.content-type ~ "'.preg_quote('text/html').'"';
86	1	break;
87
88	1	case 'everyting':
89	1	default:
90	1	$exp = 'obj.http.x-url ~ /';
91	1	break;
92
93	1	}
94
95	1	return static::performFlush($exp);
96		}
97
98		return false;
99		}
100
101	6	public static function flushURL($url) {
102		if ($url) {
103	6	$exp = 'obj.http.x-url ~ "^/'.preg_quote($url).'$"';
104		return static::performFlush($exp);
105		}
106		return false;
107		}
108
109		protected static function performFlush($banExpression)
110		{
111		$success = true;
112		$urls = static::getUrls();
113		// config loaded successfully
114		if (static::checkConfig()) {
115		if (count($urls) > 0) {
116		foreach ($urls as $url) {
117
118		// get restful service object
119		$service = static::getService($url, $banExpression);
120
121		// prepare headers
122		$headers = static::getHeaders();
123
124		// prepare curl options
125		$options = static::getOptions();
126
127		// call API
128		$conn = $service->request(null, 'POST', null, $headers, $options);
129
130		if ($conn->isError()) {
131		SS_Log::log('SectionIO::performFlush :: '.$conn->getStatusCode().' : '.$conn->getStatusDescription().' : '.$url, SS_Log::ERR);
132		$success = $success && false;
133		} else {
134		SS_Log::log('SectionIO::performFlush :: ban successful. url: '.$url."; ban expression: '".$banExpression."'", SS_Log::NOTICE);
135		}
136		}
137		} else {
138		SS_Log::log('SectionIO::performFlush :: no URLs loaded for ban.', SS_Log::ERR);
139		}
140		}
141
142		return $success;
143		}
144
145	6	protected static function getService($url, $banExpression)
146		{
147		// prepare API call
148	6	$service = new RestfulService(
149	6	$url,
150		0 // expiry time 0: do not cache the API call
151	6	);
152		// set basic auth
153	6	$username = Config::inst()->get('SectionIO', 'username');
154	6	$password = Config::inst()->get('SectionIO', 'password');
155	6	$service->basicAuth($username, $password);
156		// set query string (ban expression)
157	6	$service->setQueryString(array(
158	6	'banExpression' => $banExpression,
159	6	));
160
161	6	return $service;
162		}
163
164	6	protected static function getOptions()
165		{
166		// prepare curl options for ssl verification
167	6	$cert = static::getCertificates();
168		$options = array(
169	6	CURLOPT_SSL_VERIFYPEER => 1,
170	6	CURLOPT_SSL_VERIFYHOST => 2,
171	6	CURLOPT_CAINFO => $cert,
172	6	);
173
174	6	return $options;
175		}
176
177	6	protected static function getCertificates()
178		{
179	6	$cert = ini_get('curl.cainfo');
180	6	if (!$cert) {
181	6	$cert = BASE_PATH.'/'.SECTIONIO_BASE.'/cert/cacert.pem';
182	6	}
183
184	6	return $cert;
185		}
186
187	6	protected static function getHeaders()
188		{
189		$headers = array(
190	6	'Content-Type: application/json',
191	6	'Accept: application/json',
192	6	);
193
194	6	return $headers;
195		}
196
197	6	protected static function getUrls()
198		{
199	6	$urls = array();
200
201	6	if (static::checkConfig()) {
202	6	$api_url = Config::inst()->get('SectionIO', 'api_url');
203	6	$account_id = Config::inst()->get('SectionIO', 'account_id');
204	6	$application_id = Config::inst()->get('SectionIO', 'application_id');
205	6	$application_ids = array();
206	6	if (is_string($application_id)) {
207	6	$application_ids = preg_split("/[\s,]+/", $application_id);
208	6	} elseif (is_array($application_id)) {
209		$application_ids = $application_id;
210		}
211	6	$environment_name = Config::inst()->get('SectionIO', 'environment_name');
212	6	$proxy_name = Config::inst()->get('SectionIO', 'proxy_name');
213
214	6	foreach ($application_ids as $appid) {
215		// build API URL: /account/{accountId}/application/{applicationId}/environment/{environmentName}/proxy/{proxyName}/state
216	6	$urls[] = Controller::join_links(
217	6	$api_url,
218	6	'account',
219	6	$account_id,
220	6	'application',
221	6	$appid,
222	6	'environment',
223	6	$environment_name,
224	6	'proxy',
225	6	$proxy_name,
226		'state'
227	6	);
228	6	}
229	6	}
230
231	6	return $urls;
232		}
233
234	6	protected static function checkConfig()
235		{
236	6	$missing = array();
237		// check config
238	6	$api_url = Config::inst()->get('SectionIO', 'api_url');
239	6	if (!isset($api_url) \|\| strlen($api_url) < 1) {
240		$missing[] = 'SectionIO.api_url';
241		}
242	6	$account_id = Config::inst()->get('SectionIO', 'account_id');
243	6	if (!isset($account_id) \|\| strlen($account_id) < 1) {
244		$missing[] = 'SectionIO.account_id';
245		}
246	6	$application_id = Config::inst()->get('SectionIO', 'application_id');
247	6	if (!isset($application_id) \|\| (!is_array($application_id) && strlen((string) $application_id) < 1)) {
248		$missing[] = 'SectionIO.application_id';
249		}
250	6	$environment_name = Config::inst()->get('SectionIO', 'environment_name');
251	6	if (!isset($environment_name) \|\| strlen($environment_name) < 1) {
252		$missing[] = 'SectionIO.environment_name';
253		}
254	6	$proxy_name = Config::inst()->get('SectionIO', 'proxy_name');
255	6	if (!isset($proxy_name) \|\| strlen($proxy_name) < 1) {
256		$missing[] = 'SectionIO.proxy_name';
257		}
258	6	$username = Config::inst()->get('SectionIO', 'username');
259	6	if (!isset($username) \|\| strlen($username) < 1) {
260		$missing[] = 'SectionIO.username';
261		}
262	6	$password = Config::inst()->get('SectionIO', 'password');
263	6	if (!isset($password) \|\| strlen($password) < 1) {
264		$missing[] = 'SectionIO.password';
265		}
266
267	6	if (count($missing) > 0) {
268		if (!Director::isDev()) {
269		SS_Log::log('SectionIO:: config parameters missing: ' . implode(', ', $missing), SS_Log::WARN);
270		}
271		return false;
272		}
273	6	return true;
274		}
275		}
276

xini / silverstripe-section-io

Push — master ( 9378c1...c4fd91 )

SectionIO::performFlush() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like