Comodojo\Dispatcher\Response\Model

Complexity

Total Complexity

38

Size/Duplication

Total Lines	228
Duplicated Lines	0 %

Test Coverage

Coverage

67.33%

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	getStatus()	0	3	1
A	__construct()	0	11	1
A	getLocation()	0	3	1
B	consolidate()	0	29	8
B	import()	0	10	8
A	setContent()	0	5	1
A	unserialize()	0	3	1
A	setLocation()	0	5	1
A	setClientCache()	0	25	6
A	getPreprocessor()	0	3	1
A	getHeaders()	0	3	1
A	setPreprocessor()	0	5	1
A	export()	0	8	1
A	getContent()	0	3	1
A	getCookies()	0	3	1
A	setHeaders()	0	5	1
A	setCookies()	0	5	1
A	serialize()	0	3	1
A	setStatus()	0	5	1

<?php namespace Comodojo\Dispatcher\Response;

use \Comodojo\Dispatcher\Components\AbstractModel;
use \Comodojo\Dispatcher\Request\Model as Request;
use \Comodojo\Dispatcher\Router\Route;
use \Comodojo\Foundation\Timing\TimingTrait;
use \Comodojo\Foundation\Base\Configuration;
use \Comodojo\Cookies\CookieManager;
use \Psr\Log\LoggerInterface;
use \Serializable;

/**
 * @package     Comodojo Dispatcher
 * @author      Marco Giovinazzi <marco.giovinazzi@comodojo.org>
 * @author      Marco Castiello <marco.castiello@gmail.com>
 * @license     MIT
 *
 * LICENSE:
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

class Model extends AbstractModel implements Serializable {

    use TimingTrait;

    protected static $no_content_statuses = [100, 101, 102, 204, 304];

    protected static $cacheable_methods = ['GET', 'HEAD', 'POST', 'PUT'];

    protected static $cacheable_statuses = [200, 203, 300, 301, 302, 404, 410];

    protected $headers;

    protected $cookies;

    protected $status;

    protected $content;

    protected $location;

    protected $preprocessor;

    public function __construct(Configuration $configuration, LoggerInterface $logger) {

        parent::__construct($configuration, $logger);

        $this->setHeaders(new Headers())
            ->setCookies(new CookieManager())
            ->setStatus(new Status())
            ->setContent(new Content())
            ->setLocation(new Location())
            ->setPreprocessor(new Preprocessor())
            ->setTiming();

    }

    public function getHeaders() {

        return $this->headers;

    }

    public function setHeaders(Headers $headers) {

        $this->headers = $headers;

        return $this;

    }

    public function getCookies() {

        return $this->cookies;

    }

    public function setCookies(CookieManager $cookies) {

        $this->cookies = $cookies;

        return $this;

    }

    public function getStatus() {

        return $this->status;

    }

    public function setStatus(Status $status) {

        $this->status = $status;

        return $this;

    }

    public function getContent() {

        return $this->content;

    }

    public function setContent(Content $content) {

        $this->content = $content;

        return $this;

    }

    public function getLocation() {

        return $this->location;

    }

    public function setLocation(Location $location) {

        $this->location = $location;

        return $this;

    }

    /**
     * Get the current preprocessor
     *
     * @return Preprocessor
     */
    public function getPreprocessor() {

        return $this->preprocessor;

    }

    /**
     * Set the current preprocessor
     *
     * @param Preprocessor $preprocessor
     *  The preprocessor to use
     * @return Model
     */
    public function setPreprocessor(Preprocessor $preprocessor) {

        $this->preprocessor = $preprocessor;

        return $this;

    }

    public function serialize() {

        return serialize($this->export());

    }

    public function unserialize($data) {

        $this->import(unserialize($data));

    }

    public function export() {

        return (object)[
            'headers' => $this->getHeaders(),
            'cookies' => $this->getCookies()->getAll(),
            'status' => $this->getStatus(),
            'content' => $this->getContent(),
            'location' => $this->getLocation()
        ];

    }

    public function import($data) {

        if (isset($data->headers)) $this->setHeaders($data->headers);
        if (isset($data->status)) $this->setStatus($data->status);
        if (isset($data->content)) $this->setContent($data->content);
        if (isset($data->location)) $this->setLocation($data->location);

        if (isset($data->cookies) && is_array($data->cookies)) {
            $cookies = $this->getCookies();
            foreach ($data->cookies as $name => $cookie) $cookies->add($cookie);
        }

    }

    public function consolidate(Request $request, Route $route=null) {

        $status = $this->getStatus()->get();
        $preprocessor = $this->getPreprocessor()->get($status);
        $preprocessor->consolidate($this);

        if ($route != null) {

Operator != prohibited; use !== instead

            $this->setClientCache($request, $route);
        }

        // extra checks
        $content = $this->getContent();
        $headers = $this->getHeaders();

        if ((string)$request->getMethod() == 'HEAD' && !in_array($status, self::$no_content_statuses)) {

Operator == prohibited; use === instead

            $length = $content->length();
            $content->set(null);
            if ($length) {
                $headers->set('Content-Length', $length);
            }
        }

        if ($headers->get('Transfer-Encoding') != null) {

Operator != prohibited; use !== instead

It seems like you are loosely comparing $headers->get('Transfer-Encoding') of type array|null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.

            $headers->delete('Content-Length');
        }

        if ((string)$request->getVersion() == '1.0' && false !== strpos($headers->get('Cache-Control'), 'no-cache')) {

Operator == prohibited; use === instead

It seems like $headers->get('Cache-Control') can also be of type array; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check?

            $headers->set('pragma', 'no-cache');
            $headers->set('expires', -1);
        }

    }

    private function setClientCache(Request $request, Route $route) {

        $cache = strtoupper($route->getParameter('cache'));
        $ttl = (int)$route->getParameter('ttl');

        if (
            ($cache == 'CLIENT' || $cache == 'BOTH') &&

Operator == prohibited; use === instead

            in_array((string)$request->getMethod(), self::$cacheable_methods) &&
            in_array($this->getStatus()->get(), self::$cacheable_statuses)
            // @TODO: here we should also check for Cache-Control no-store or private;
            //        the cache layer will be improoved in future versions.
        ) {

            $headers = $this->getHeaders();
            $timestamp = (int) $this->getTime()->format('U')+$ttl;

            if ($ttl > 0) {

                $headers->set("Cache-Control", "max-age=".$ttl.", must-revalidate");

The string literal Cache-Control does not require double quotes, as per coding-style, please use single quotes.

The string literal max-age= does not require double quotes, as per coding-style, please use single quotes.

The string literal , must-revalidate does not require double quotes, as per coding-style, please use single quotes.

                $headers->set("Expires", gmdate("D, d M Y H:i:s", $timestamp)." GMT");

The string literal Expires does not require double quotes, as per coding-style, please use single quotes.

The string literal D, d M Y H:i:s does not require double quotes, as per coding-style, please use single quotes.

The string literal GMT does not require double quotes, as per coding-style, please use single quotes.

            } else {

                $headers->set("Cache-Control", "no-cache, must-revalidate");

The string literal Cache-Control does not require double quotes, as per coding-style, please use single quotes.

The string literal no-cache, must-revalidate does not require double quotes, as per coding-style, please use single quotes.

                $headers->set("Expires", "Mon, 26 Jul 1997 05:00:00 GMT");

The string literal Expires does not require double quotes, as per coding-style, please use single quotes.

The string literal Mon, 26 Jul 1997 05:00:00 GMT does not require double quotes, as per coding-style, please use single quotes.

            }

        }

    }

}