Publisher::generatePageResponse() - Code Metrics - Inspection of "SS4 Compatability" - silverstripe/silverstripe-staticpublishqueue - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#70)

by Daniel

created 2018-02-12 13:31 UTC

Publisher::generatePageResponse() B

↳ Parent: Publisher

Complexity

Conditions	8
Paths	80

Size

Total Lines	55
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	40
nc	80
nop	1
dl	0
loc	55
rs	7.4033
c	0
b	0
f	0

How to fix Long Method

<?php

namespace SilverStripe\StaticPublishQueue;

use SilverStripe\Control\Director;
use SilverStripe\Control\HTTPApplication;
use SilverStripe\Control\HTTPRequestBuilder;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Control\HTTPResponse_Exception;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\Core\CoreKernel;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\Core\Manifest\ModuleLoader;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\StaticPublishQueue\Contract\StaticPublisher;
use SilverStripe\View\ArrayData;
use SilverStripe\View\Requirements;
use SilverStripe\View\Requirements_Backend;
use SilverStripe\View\SSViewer;

abstract class Publisher implements StaticPublisher
{
    use Injectable;
    use Configurable;

    /**
     * @var array
     * @config
     */
    private static $static_publisher_themes = [];


    /**
     * @config
     *
     * @var Boolean Use domain based caching (put cache files into a domain subfolder)
     * This must be true if you are using this with the "subsites" module.
     * Please note that this form of caching requires all URLs to be provided absolute
     * (not relative to the webroot) via {@link SiteTree->AbsoluteLink()}.
     */
    private static $domain_based_caching = false;


    /**
     * @param string $url
     * @return HTTPResponse
     */
    public function generatePageResponse($url)
    {
        if (Director::is_relative_url($url)) {
            $url = Director::absoluteURL($url);
        }
        $urlParts = parse_url($url);
        if (!empty($urlParts['query'])) {
            parse_str($urlParts['query'], $getVars);
        } else {
            $getVars = [];
        }
        // back up requirements backend
        $origRequirements = Requirements::backend();
        Requirements::set_backend(Requirements_Backend::create());

        $origThemes = SSViewer::get_themes();
        $staticThemes = self::config()->get('static_publisher_themes');
        if ($staticThemes) {
            SSViewer::set_themes($staticThemes);
        } else {
            // get the themes raw from config to prevent the "running from the CMS" problem where no themes are live
            $rawThemes = SSViewer::config()->uninherited('themes');
            SSViewer::set_themes($rawThemes);
        }
        try {
            // try to add all the server vars that would be needed to create a static cache
            $request = HTTPRequestBuilder::createFromVariables(
                [
                '_SERVER' => [
                    'REQUEST_URI' => isset($urlParts['path']) ? $urlParts['path'] : '',
                    'REQUEST_METHOD' => 'GET',
                    'REMOTE_ADDR' => '127.0.0.1',
                    'HTTPS' => $urlParts['scheme'] == 'https' ? 'on' : 'off',
                    'QUERY_STRING' => isset($urlParts['query']) ? $urlParts['query'] : '',
                    'REQUEST_TIME' => DBDatetime::now()->getTimestamp(),
                    'REQUEST_TIME_FLOAT' => (float) DBDatetime::now()->getTimestamp(),
                    'HTTP_HOST' => $urlParts['host'],
                    'HTTP_USER_AGENT' => 'silverstripe/staticpublishqueue',
                ],
                '_GET' => $getVars,
                '_POST' => [],
                ],
                ''
            );
            $app = $this->getHTTPApplication();
            $response = $app->handle($request);
        } catch (HTTPResponse_Exception $e) {
            $response = $e->getResponse();
        } finally {
            // restore backends
            SSViewer::set_themes($origThemes);
            Requirements::set_backend($origRequirements);
            DataObject::singleton()->flushCache();
        }
        return $response;
    }

    /**
     * @return HTTPApplication
     */
    protected function getHTTPApplication()
    {
        $kernel = new CoreKernel(BASE_PATH);
        return new HTTPApplication($kernel);
    }

    /**
     * Generate the templated content for a PHP script that can serve up the
     * given piece of content with the given age and expiry.
     *
     * @param HTTPResponse $response
     *
     * @return string
     */
    protected function generatePHPCacheFile($response)
    {
        $cacheConfig = [
            'responseCode' => $response->getStatusCode(),
            'headers' => [],
        ];

        foreach ($response->getHeaders() as $header => $value) {
            if (!in_array($header, [ 'cache-control' ])) {
                $cacheConfig['headers'][] = sprintf('%s: %s', $header, $value);
            }
        }

        return "<?php\n\nreturn " . var_export($cacheConfig, true) . ';';
    }

    /**
     * Generate the templated content for a PHP script that can serve up a 301
     * redirect to the given destination.
     *
     * @param string $destination
     *
     * @return string
     */
    protected function generatePHPCacheRedirection($destination, $statusCode)
    {
        $templateResource = ModuleLoader::getModule('silverstripe/staticpublishqueue')
            ->getResource('templates/CachedPHPRedirection.tmpl');
        $template = file_get_contents($templateResource->getPath());

        return str_replace(
            array('**DESTINATION**', '**STATUS_CODE**'),
            array($destination, $statusCode),
            $template
        );
    }

    /**
     * @param string $destination
     * @return string
     */
    protected function generateHTMLCacheRedirection($destination)
    {
        return SSViewer::execute_template(
            'SilverStripe\\StaticPublishQueue\\HTMLRedirection',
            ArrayData::create([
                'URL' => DBField::create_field('Varchar', $destination),
            ])
        );
    }
}


1			<?php
2
3			namespace SilverStripe\StaticPublishQueue;
4
5			use SilverStripe\Control\Director;
6			use SilverStripe\Control\HTTPApplication;
7			use SilverStripe\Control\HTTPRequestBuilder;
8			use SilverStripe\Control\HTTPResponse;
9			use SilverStripe\Control\HTTPResponse_Exception;
10			use SilverStripe\Core\Config\Configurable;
11			use SilverStripe\Core\CoreKernel;
12			use SilverStripe\Core\Injector\Injectable;
13			use SilverStripe\Core\Manifest\ModuleLoader;
14			use SilverStripe\ORM\DataObject;
15			use SilverStripe\ORM\FieldType\DBDatetime;
16			use SilverStripe\ORM\FieldType\DBField;
17			use SilverStripe\StaticPublishQueue\Contract\StaticPublisher;
18			use SilverStripe\View\ArrayData;
19			use SilverStripe\View\Requirements;
20			use SilverStripe\View\Requirements_Backend;
21			use SilverStripe\View\SSViewer;
22
23			abstract class Publisher implements StaticPublisher
24			{
25			use Injectable;
26			use Configurable;
27
28			/**
29			* @var array
30			* @config
31			*/
32			private static $static_publisher_themes = [];
			0 ignored issues – show introduced 2018-01-16 16:52 UTC by Report Bug Copy Issue Report The private property `$static_publisher_themes` is not used, and could be removed. Loading history...
33
34			/**
35			* @config
36			*
37			* @var Boolean Use domain based caching (put cache files into a domain subfolder)
38			* This must be true if you are using this with the "subsites" module.
39			* Please note that this form of caching requires all URLs to be provided absolute
40			* (not relative to the webroot) via {@link SiteTree->AbsoluteLink()}.
41			*/
42			private static $domain_based_caching = false;
			0 ignored issues – show introduced 2018-01-16 16:52 UTC by Report Bug Copy Issue Report The private property `$domain_based_caching` is not used, and could be removed. Loading history...
43
44			/**
45			* @param string $url
46			* @return HTTPResponse
47			*/
48			public function generatePageResponse($url)
49			{
50			if (Director::is_relative_url($url)) {
51			$url = Director::absoluteURL($url);
52			}
53			$urlParts = parse_url($url);
54			if (!empty($urlParts['query'])) {
55			parse_str($urlParts['query'], $getVars);
56			} else {
57			$getVars = [];
58			}
59			// back up requirements backend
60			$origRequirements = Requirements::backend();
61			Requirements::set_backend(Requirements_Backend::create());
62
63			$origThemes = SSViewer::get_themes();
64			$staticThemes = self::config()->get('static_publisher_themes');
65			if ($staticThemes) {
66			SSViewer::set_themes($staticThemes);
67			} else {
68			// get the themes raw from config to prevent the "running from the CMS" problem where no themes are live
69			$rawThemes = SSViewer::config()->uninherited('themes');
70			SSViewer::set_themes($rawThemes);
71			}
72			try {
73			// try to add all the server vars that would be needed to create a static cache
74			$request = HTTPRequestBuilder::createFromVariables(
75			[
76			'_SERVER' => [
77			'REQUEST_URI' => isset($urlParts['path']) ? $urlParts['path'] : '',
78			'REQUEST_METHOD' => 'GET',
79			'REMOTE_ADDR' => '127.0.0.1',
80			'HTTPS' => $urlParts['scheme'] == 'https' ? 'on' : 'off',
81			'QUERY_STRING' => isset($urlParts['query']) ? $urlParts['query'] : '',
82			'REQUEST_TIME' => DBDatetime::now()->getTimestamp(),
83			'REQUEST_TIME_FLOAT' => (float) DBDatetime::now()->getTimestamp(),
84			'HTTP_HOST' => $urlParts['host'],
85			'HTTP_USER_AGENT' => 'silverstripe/staticpublishqueue',
86			],
87			'_GET' => $getVars,
88			'_POST' => [],
89			],
90			''
91			);
92			$app = $this->getHTTPApplication();
93			$response = $app->handle($request);
94			} catch (HTTPResponse_Exception $e) {
95			$response = $e->getResponse();
96			} finally {
97			// restore backends
98			SSViewer::set_themes($origThemes);
99			Requirements::set_backend($origRequirements);
100			DataObject::singleton()->flushCache();
101			}
102			return $response;
103			}
104
105			/**
106			* @return HTTPApplication
107			*/
108			protected function getHTTPApplication()
109			{
110			$kernel = new CoreKernel(BASE_PATH);
111			return new HTTPApplication($kernel);
112			}
113
114			/**
115			* Generate the templated content for a PHP script that can serve up the
116			* given piece of content with the given age and expiry.
117			*
118			* @param HTTPResponse $response
119			*
120			* @return string
121			*/
122			protected function generatePHPCacheFile($response)
123			{
124			$cacheConfig = [
125			'responseCode' => $response->getStatusCode(),
126			'headers' => [],
127			];
128
129			foreach ($response->getHeaders() as $header => $value) {
130			if (!in_array($header, [ 'cache-control' ])) {
131			$cacheConfig['headers'][] = sprintf('%s: %s', $header, $value);
132			}
133			}
134
135			return "<?php\n\nreturn " . var_export($cacheConfig, true) . ';';
136			}
137
138			/**
139			* Generate the templated content for a PHP script that can serve up a 301
140			* redirect to the given destination.
141			*
142			* @param string $destination
143			*
144			* @return string
145			*/
146			protected function generatePHPCacheRedirection($destination, $statusCode)
147			{
148			$templateResource = ModuleLoader::getModule('silverstripe/staticpublishqueue')
149			->getResource('templates/CachedPHPRedirection.tmpl');
150			$template = file_get_contents($templateResource->getPath());
151
152			return str_replace(
153			array('DESTINATION', 'STATUS_CODE'),
154			array($destination, $statusCode),
155			$template
156			);
157			}
158
159			/**
160			* @param string $destination
161			* @return string
162			*/
163			protected function generateHTMLCacheRedirection($destination)
164			{
165			return SSViewer::execute_template(
166			'SilverStripe\\StaticPublishQueue\\HTMLRedirection',
167			ArrayData::create([
168			'URL' => DBField::create_field('Varchar', $destination),
169			])
170			);
171			}
172			}
173

silverstripe / silverstripe-staticpublishqueue

Pull Request — master (#70)

Publisher::generatePageResponse() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like