SectionIO::performFlush() - Code Metrics - Inspection of "update changelog" - xini/silverstripe-section-io - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a743e8...453823 )

by Florian

created 2019-05-17 03:21 UTC

SectionIO::performFlush() B

↳ Parent: SectionIO

Complexity

Conditions	6
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	15.8865

Importance

Changes

Metric	Value
dl	0
loc	35
ccs	7
cts	20
cp	0.35
rs	8.7377
c	0
b	0
f	0
cc	6
nc	3
nop	1
crap	15.8865

<?php

class SectionIO extends SS_Object implements Flushable
{
    private static $flush_on_dev_build = true;

    private static $sitetree_flush_strategy = 'smart';

    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 = '';
    private static $verify_ssl = true;
    private static $async = true;
    
    const SITETREE_STRATEGY_SINGLE = 'single';
    const SITETREE_STRATEGY_PARENTS = 'parents';
    const SITETREE_STRATEGY_ALL = 'all';
    const SITETREE_STRATEGY_SMART = 'smart';
    const SITETREE_STRATEGY_EVERYTING = 'everything';
    
    /**
     * 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, $smartStrategy = null)
    {
        $sitetree = SiteTree::get()->byID($sitetreeID);
        if ($sitetree && $sitetree->exists()) {
            // get strategy config
            $strategy = Config::inst()->get('SectionIO', 'sitetree_flush_strategy');
            // set smart strategy if set
            if ($strategy == SectionIO::SITETREE_STRATEGY_SMART && $smartStrategy) {
                $strategy = $smartStrategy;
            }
            switch ($strategy) {

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

                case SectionIO::SITETREE_STRATEGY_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 SectionIO::SITETREE_STRATEGY_ALL:
                    $exp = 'obj.http.content-type ~ "'.preg_quote('text/html').'"';
                    break;

                case 'everyting': // compatibility, old typo
                case SectionIO::SITETREE_STRATEGY_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,
            'async' => Config::inst()->get('SectionIO', 'async') ? 'true' : 'false',
        ));

        return $service;
    }

    protected static function getOptions()
    {
        // prepare curl options for ssl verification
        if (Config::inst()->get('SectionIO', 'verify_ssl')) {
            return array(
                CURLOPT_SSL_VERIFYPEER => 0,
                CURLOPT_SSL_VERIFYHOST => 0,
            );
        }
        return array();
    }

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

xini / silverstripe-section-io

Push — master ( a743e8...453823 )

SectionIO::performFlush() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like