Completed
Push — master ( 8132f0...adfb6f )
by Peter
16:19 queued 14:21
created

ResponseConfigurator::setPrivateCache()   B

Complexity

Conditions 5
Paths 4

Size

Total Lines 16
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 12
CRAP Score 5

Importance

Changes 0
Metric Value
dl 0
loc 16
ccs 12
cts 12
cp 1
rs 8.8571
c 0
b 0
f 0
cc 5
eloc 9
nc 4
nop 2
crap 5
1
<?php
2
/**
3
 * AnimeDb package.
4
 *
5
 * @author    Peter Gribanov <[email protected]>
6
 * @copyright Copyright (c) 2014, Peter Gribanov
7
 * @license   http://opensource.org/licenses/MIT
8
 */
9
10
namespace AnimeDb\Bundle\CacheTimeKeeperBundle\Service;
11
12
use Symfony\Component\HttpFoundation\Request;
13
use Symfony\Component\HttpFoundation\RequestStack;
14
use Symfony\Component\HttpFoundation\Response;
15
16
class ResponseConfigurator
17
{
18
    /**
19
     * @var CacheKeyBuilder
20
     */
21
    protected $key_builder;
22
23
    /**
24
     * @var RequestStack
25
     */
26
    protected $request_stack;
27
28
    /**
29
     * @var array
30
     */
31
    protected $private_headers = [];
32
33
    /**
34
     * @param CacheKeyBuilder $key_builder
35
     * @param RequestStack $request_stack
36
     * @param array $private_headers
37
     */
38 5
    public function __construct(CacheKeyBuilder $key_builder, RequestStack $request_stack, array $private_headers)
39
    {
40 5
        $this->key_builder = $key_builder;
41 5
        $this->request_stack = $request_stack;
42 5
        $this->private_headers = $private_headers;
43 5
    }
44
45
    /**
46
     * Configure response.
47
     *
48
     * Set $lifetime as < 0 for not set max-age
49
     *
50
     * @param Response $response
51
     * @param \DateTime $last_modified
52
     * @param int $lifetime
53
     *
54
     * @return Response
55
     */
56 5
    public function configure(Response $response, \DateTime $last_modified, $lifetime)
57
    {
58 5
        $request = $this->request_stack->getMasterRequest();
59
60 5
        if (!($request instanceof Request)) {
61 1
            return $response;
62
        }
63
64
        // order is important
65 4
        $this
66 4
            ->setPrivateCache($response, $request)
67 4
            ->setLastModified($response, $last_modified)
68 4
            ->setLifetime($response, $lifetime)
69 4
            ->setEtag($response);
70
71 4
        return $response;
72
    }
73
74
    /**
75
     * @param Response $response
76
     * @param Request $request
77
     *
78
     * @return ResponseConfigurator
79
     */
80 4
    protected function setPrivateCache(Response $response, Request $request)
81
    {
82 4
        if (!$response->headers->hasCacheControlDirective('public') &&
83 4
            !$response->headers->hasCacheControlDirective('private')
84 4
        ) {
85 3
            $response->setPublic();
86 3
            foreach ($this->private_headers as $private_header) {
87 1
                if ($request->headers->has($private_header)) {
88 1
                    $response->setPrivate();
89 1
                    break;
90
                }
91 3
            }
92 3
        }
93
94 4
        return $this;
95
    }
96
97
    /**
98
     * @param Response $response
99
     * @param \DateTime $last_modified
100
     *
101
     * @return ResponseConfigurator
102
     */
103 4
    protected function setLastModified(Response $response, \DateTime $last_modified)
104
    {
105
        $response
106 4
            ->setLastModified($last_modified)
107 4
            ->headers
108 4
            ->addCacheControlDirective('must-revalidate', true);
109
110 4
        return $this;
111
    }
112
113
    /**
114
     * Set max-age, s-maxage and expires headers.
115
     *
116
     * Set $lifetime as < 0 for not set max-age
117
     * Need set Cache-Control public/private before set lifetime
118
     *
119
     * @param Response $response
120
     * @param int $lifetime
121
     *
122
     * @return ResponseConfigurator
123
     */
124 4
    protected function setLifetime(Response $response, $lifetime)
125
    {
126 4
        if ($lifetime >= 0) {
127 3
            $date = clone $response->getDate();
128
            $response
129 3
                ->setMaxAge($lifetime)
130 3
                ->setExpires($date->modify(sprintf('now +%s seconds', $lifetime)));
131
132 3
            if (!$response->headers->hasCacheControlDirective('private')) {
133 1
                $response->setSharedMaxAge($lifetime);
134 1
            }
135 3
        }
136
137 4
        return $this;
138
    }
139
140
    /**
141
     * Set ETag.
142
     *
143
     * Need set Last-Modified before ETag
144
     *
145
     * @param Response $response
146
     *
147
     * @return ResponseConfigurator
148
     */
149 4
    protected function setEtag(Response $response)
150
    {
151 4
        if (!$response->getEtag()) {
152 3
            $response->setEtag($this->key_builder->getEtag($response));
153 3
        }
154
155 4
        return $this;
156
    }
157
}
158