8000 Move duplicated logic from Esi/Ssi to an AbstractSurrogate · symfony/symfony@c5dc50d · GitHub
[go: up one dir, main page]
Skip to content
8000

Commit c5dc50d

Browse files
chalasrchalasr
committed
Move duplicated logic from Esi/Ssi to an AbstractSurrogate
Fabbot fixes Move duplicated logic from Esi/Ssi::process in AbstractSurrogate::removeFromControl Fabbot fixes Fix comment
1 parent 4c5464c commit c5dc50d

File tree

3 files changed

+145
-237
lines changed

3 files changed

+145
-237
lines changed

‎src/Symfony/Component/HttpKernel/HttpCache/AbstractSurrogate.php

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\HttpKernel\HttpCache;
13+
14+
use Symfony\Component\HttpFoundation\Request;
15+
use Symfony\Component\HttpFoundation\Response;
16+
use Symfony\Component\HttpKernel\HttpKernelInterface;
17+
18+
/**
19+
* Abstract class implementing Surrogate capabilities to Request and Response instances.
20+
*
21+
* @author Fabien Potencier <fabien@symfony.com>
22+
* @author Robin Chalas <robin.chalas@gmail.com>
23+
*/
24+
abstract class AbstractSurrogate implements SurrogateInterface
25+
{
26+
protected $contentTypes;
27+
protected $phpEscapeMap = array(
28+
array('<?', '<%', '<s', '<S'),
29+
array('<?php echo "<?"; ?>', '<?php echo "<%"; ?>', '<?php echo "<s"; ?>', '<?php echo "<S"; ?>'),
30+
);
31+
32+
/**
33+
* Constructor.
34+
*
35+
* @param array $contentTypes An array of content-type that should be parsed for Surrogate information.
36+
* (default: text/html, text/xml, application/xhtml+xml, and application/xml)
37+
*/
38+
public function __construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'))
39+
{
40+
$this->contentTypes = $contentTypes;
41+
}
42+
43+
/**
44+
* Returns a new cache strategy instance.
45+
*
46+
* @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance
47+
*/
48+
public function createCacheStrategy()
49+
{
50+
return new ResponseCacheStrategy();
51+
}
52+
53+
/**
54+
* {@inheritdoc}
55+
*/
56+
public function hasSurrogateCapability(Request $request)
57+
{
58+
if (null === $value = $request->headers->get('Surrogate-Capability')) {
59+
return false;
60+
}
61+
62+
return false !== strpos($value, sprintf('%s/1.0', strtoupper($this->getName())));
63+
}
64+
65+
/**
66+
* {@inheritdoc}
67+
*/
68+
public function addSurrogateCapability(Request $request)
69+
{
70+
$current = $request->headers->get('Surrogate-Capability');
71+
$new = sprintf('symfony2="%s/1.0"', strtoupper($this->getName()));
72+
73+
$request->headers->set('Surrogate-Capability', $current ? $current.', '.$new : $new);
74+
}
75+
76+
/**
77+
* {@inheritdoc}
78+
*/
79+
public function needsParsing(Response $response)
80+
{
81+
if (!$control = $response->headers->get('Surrogate-Control')) {
82+
return false;
83+
}
84+
85+
$pattern = sprintf('#content="[^"]*%s/1.0[^"]*"#', strtoupper($this->getName()));
86+
87+
return (bool) preg_match($pattern, $control);
88+
}
89+
90+
/**
91+
* {@inheritdoc}
92+
*/
93+
public function handle(HttpCache $cache, $uri, $alt, $ignoreErrors)
94+
{
95+
$subRequest = Request::create($uri, Request::METHOD_GET, array(), $cache->getRequest()->cookies->all(), array(), $cache->getRequest()->server->all());
96+
97+
try {
98+
$response = $cache->handle($subRequest, HttpKernelInterface::SUB_REQUEST, true);
99+
100+
if (!$response->isSuccessful()) {
101+
throw new \RuntimeException(sprintf('Error when rendering "%s" (Status code is %s).', $subRequest->getUri(), $response->getStatusCode()));
102+
}
103+
104+
return $response->getContent();
105+
} catch (\Exception $e) {
106+
if ($alt) {
107+
return $this->handle($cache, $alt, '', $ignoreErrors);
108+
}
109+
110+
if (!$ignoreErrors) {
111+
throw $e;
112+
}
113+
}
114+
}
115+
116+
/**
117+
* Remove the Surrogate from the Surrogate-Control header.
118+
*
119+
* @param Response $response
120+
*/
121+ 10000
protected function removeFromControl(Response $response)
122+
{
123+
if (!$response->headers->has('Surrogate-Control')) {
124+
return;
125+
}
126+
127+
$value = $response->headers->get('Surrogate-Control');
128+
$upperName = strtoupper($this->getName());
129+
130+
if (sprintf('content="%s/1.0"', $upperName) == $value) {
131+
$response->headers->remove('Surrogate-Control');
132+
} elseif (preg_match(sprintf('#,\s*content="%s/1.0"#', $upperName), $value)) {
133+
$response->headers->set('Surrogate-Control', preg_replace(sprintf('#,\s*content="%s/1.0"#', $upperName), '', $value));
134+
} elseif (preg_match(sprintf('#content="%s/1.0",\s*#', $upperName), $value)) {
135+
$response->headers->set('Surrogate-Control', preg_replace(sprintf('#content="%s/1.0",\s*#', $upperName), '', $value));
136+
}
137+
}
138+
}

‎src/Symfony/Component/HttpKernel/HttpCache/Esi.php

Lines changed: 5 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313

1414
use Symfony\Component\HttpFoundation\Request;
1515
use Symfony\Component\HttpFoundation\Response;
16-
use Symfony\Component\HttpKernel\HttpKernelInterface;
1716

1817
/**
1918
* Esi implements the ESI capabilities to Request and Response instances.
@@ -26,75 +25,15 @@
2625
*
2726
* @author Fabien Potencier <fabien@symfony.com>
2827
*/
29-
class Esi implements SurrogateInterface
28+
class Esi extends AbstractSurrogate
3029
{
31-
private $contentTypes;
32-
private $phpEscapeMap = array(
33-
array('<?', '<%', '<s', '<S'),
34-
array('<?php echo "<?"; ?>', '<?php echo "<%"; ?>', '<?php echo "<s"; ?>', '<?php echo "<S"; ?>'),
35-
);
36-
37-
/**
38-
* Constructor.
39-
*
40-
* @param array $contentTypes An array of content-type that should be parsed for ESI information.
41-
* (default: text/html, text/xml, application/xhtml+xml, and application/xml)
42-
*/
43-
public function __construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'))
44-
{
45-
$this->contentTypes = $contentTypes;
46-
}
47-
4830
public function getName()
4931
{
5032
return 'esi';
5133
}
5234

5335
/**
54-
* Returns a new cache strategy instance.
55-
*
56-
* @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance
57-
*/
58-
public function createCacheStrategy()
59-
{
60-
return new ResponseCacheStrategy();
61-
}
62-
63-
/**
64-
* Checks that at least one surrogate has ESI/1.0 capability.
65-
*
66-
* @param Request $request A Request instance
67-
*
68-
* @return bool true if one surrogate has ESI/1.0 capability, false otherwise
69-
*/
70-
public function hasSurrogateCapability(Request $request)
71-
{
72-
if (null === $value = $request->headers->get('Surrogate-Capability')) {
73-
return false;
74-
}
75-
76-
return false !== strpos($value, 'ESI/1.0');
77-
}
78-
79-
/**
80-
* Adds ESI/1.0 capability to the given Request.
81-
*
82-
* @param Request $request A Request instance
83-
*/
84-
public function addSurrogateCapability(Request $request)
85-
{
86-
$current = $request->headers->get('Surrogate-Capability');
87-
$new = 'symfony2="ESI/1.0"';
88-
89-
$request->headers->set('Surrogate-Capability', $current ? $current.', '.$new : $new);
90-
}
91-
92-
/**
93-
* Adds HTTP headers to specify that the Response needs to be parsed for ESI.
94-
*
95-
* This method only adds an ESI HTTP header if the Response has some ESI tags.
96-
*
97-
* @param Response $response A Response instance
36+
* {@inheritdoc}
9837
*/
9938
public function addSurrogateControl(Response $response)
10039
{
@@ -104,30 +43,7 @@ public function addSurrogateControl(Response $response)
10443
}
10544

10645
/**
107-
* Checks that the Response needs to be parsed for ESI tags.
108-
*
109-
* @param Response $response A Response instance
110-
*
111-
* @return bool true if the Response needs to be parsed, false otherwise
112-
*/
113-
public function needsParsing(Response $response)
114-
{
115-
if (!$control = $response->headers->get('Surrogate-Control')) {
116-
return false;
117-
}
118-
119-
return (bool) preg_match('#content="[^"]*ESI/1.0[^"]*"#', $control);
120-
}
121-
122-
/**
123-
* Renders an ESI tag.
124-
*
125-
* @param string $uri A URI
126-
* @param string $alt An alternate URI
127-
* @param bool $ignoreErrors Whether to ignore errors or not
128-
* @param string $comment A comment to add as an esi:include tag
129-
*
130-
* @return string
46+
* {@inheritdoc}
13147
*/
13248
public function renderIncludeTag($uri, $alt = null, $ignoreErrors = true, $comment = '')
13349
{
@@ -145,12 +61,7 @@ public function renderIncludeTag($uri, $alt = null, $ignoreErrors = true, $comme
14561
}
14662

14763
/**
148-
* Replaces a Response ESI tags with the included resource content.
149-
*
150-
* @param Request $request A Request instance
151-
* @param Response $response A Response instance
152-
*
153-
* @return Response
64+
* {@inheritdoc}
15465
*/
15566
public function process(Request $request, Response $response)
15667
{
@@ -199,51 +110,6 @@ public function process(Request $request, Response $response)
199110
$response->headers->set('X-Body-Eval', 'ESI');
200111

201112
// remove ESI/1.0 from the Surrogate-Control header
202-
if ($response->headers->has('Surrogate-Control')) {
203-
$value = $response->headers->get('Surrogate-Control');
204-
if ('content="ESI/1.0"' == $value) {
205-
$response->headers->remove('Surrogate-Control');
206-
} elseif (preg_match('#,\s*content="ESI/1.0"#', $value)) {
207-
$response->headers->set('Surrogate-Control', preg_replace('#,\s*content="ESI/1.0"#', '', $value));
208-
} elseif (preg_match('#content="ESI/1.0",\s*#', $value)) {
209-
$response->headers->set('Surrogate-Control', preg_replace('#content="ESI/1.0",\s*#', '', $value));
210-
}
211-
}
212-
}
213-
214-
/**
215-
* Handles an ESI from the cache.
216-
*
217-
* @param HttpCache $cache An HttpCache instance
218-
* @param string $uri The main URI
219-
* @param string $alt An alternative URI
220-
* @param bool $ignoreErrors Whether to ignore errors or not
221-
*
222-
* @return string
223-
*
224-
* @throws \RuntimeException
225-
* @throws \Exception
226-
*/
227-
public function handle(HttpCache $cache, $uri, $alt, $ignoreErrors)
228-
{
229-
$subRequest = Request::create($uri, 'get', array(), $cache->getRequest()->cookies->all(), array(), $cache->getRequest()->server->all());
230-
231-
try {
232-
$response = $cache->handle($subRequest, HttpKernelInterface::SUB_REQUEST, true);
233-
234-
if (!$response->isSuccessful()) {
235-
throw new \RuntimeException(sprintf('Error when rendering "%s" (Status code is %s).', $subRequest->getUri(), $response->getStatusCode()));
236-
}
237-
238-
return $response->getContent();
239-
} catch (\Exception $e) {
240-
if ($alt) {
241-
return $this->handle($cache, $alt, '', $ignoreErrors);
242-
}
243-
244-
if (!$ignoreErrors) {
245-
throw $e;
246-
}
247-
}
113+
$this->removeFromControl($response);
248114
}
249115
}

0 commit comments

Comments
 (0)
0