ResponseConfigurator::setEtag()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 8
c 0
b 0
f 0
ccs 5
cts 5
cp 1
rs 9.4285
cc 2
eloc 4
nc 2
nop 1
crap 2
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 6
    public function __construct(CacheKeyBuilder $key_builder, RequestStack $request_stack, array $private_headers)
39
    {
40 6
        $this->key_builder = $key_builder;
41 6
        $this->request_stack = $request_stack;
42 6
        $this->private_headers = $private_headers;
43 6
    }
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 6
    public function configure(Response $response, \DateTime $last_modified, $lifetime)
57
    {
58 6
        $request = $this->request_stack->getMasterRequest();
59
60 6
        if (!($request instanceof Request)) {
61 1
            return $response;
62
        }
63
64
        // order is important
65 5
        $this
66 5
            ->setPrivateCache($response, $request)
67 5
            ->setLastModified($response, $last_modified)
68 5
            ->setLifetime($response, $lifetime)
69 5
            ->setEtag($response);
70
71 5
        return $response;
72
    }
73
74
    /**
75
     * @param Response $response
76
     * @param Request $request
77
     *
78
     * @return ResponseConfigurator
79
     */
80 5
    protected function setPrivateCache(Response $response, Request $request)
81
    {
82
        if (
83 5
            !$response->headers->hasCacheControlDirective('public') ||
84 1
            $response->headers->hasCacheControlDirective('private')
85 5
        ) {
86 4
            $response->setPublic();
87 4
            foreach ($this->private_headers as $private_header) {
88 1
                if ($request->headers->has($private_header)) {
89 1
                    $response->setPrivate();
90 1
                    break;
91
                }
92 4
            }
93 4
        }
94
95 5
        return $this;
96
    }
97
98
    /**
99
     * @param Response $response
100
     * @param \DateTime $last_modified
101
     *
102
     * @return ResponseConfigurator
103
     */
104 5
    protected function setLastModified(Response $response, \DateTime $last_modified)
105
    {
106
        $response
107 5
            ->setLastModified($last_modified)
108 5
            ->headers
109 5
            ->addCacheControlDirective('must-revalidate', true);
110
111 5
        return $this;
112
    }
113
114
    /**
115
     * Set max-age, s-maxage and expires headers.
116
     *
117
     * Set $lifetime as < 0 for not set max-age
118
     * Need set Cache-Control public/private before set lifetime
119
     *
120
     * @param Response $response
121
     * @param int $lifetime
122
     *
123
     * @return ResponseConfigurator
124
     */
125 5
    protected function setLifetime(Response $response, $lifetime)
126
    {
127 5
        if ($lifetime >= 0) {
128 3
            $date = clone $response->getDate();
129
            $response
130 3
                ->setMaxAge($lifetime)
131 3
                ->setExpires($date->modify(sprintf('+%s seconds', $lifetime)));
132
133 3
            if (!$response->headers->hasCacheControlDirective('private')) {
134 2
                $response->setPublic()->setSharedMaxAge($lifetime);
135 2
            }
136 3
        }
137
138 5
        return $this;
139
    }
140
141
    /**
142
     * Set ETag.
143
     *
144
     * Need set Last-Modified before ETag
145
     *
146
     * @param Response $response
147
     *
148
     * @return ResponseConfigurator
149
     */
150 5
    protected function setEtag(Response $response)
151
    {
152 5
        if (!$response->getEtag()) {
153 4
            $response->setEtag($this->key_builder->getEtag($response));
154 4
        }
155
156 5
        return $this;
157
    }
158
}
159