Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Minor cleanups in HttpCache, especially centralize Date header fixup #22033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Minor cleanups in HttpCache, especially centralize Date header fixup #22033

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0bee8a2
Extract method
mpdude Mar 17, 2017
994eec4
Improve docblock
mpdude Mar 17, 2017
488f42c
Move code out of method to make intentions clearer / simplify executi…
mpdude Mar 17, 2017
26ef44f
Improve docblock
mpdude Mar 17, 2017
003dce2
Place response date fixup in the forward() method
mpdude Mar 17, 2017
c36b804
Fix CS / docblock
mpdude Mar 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 38 additions & 21 deletions src/Symfony/Component/HttpKernel/HttpCache/HttpCache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,24 +196,25 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ
}
}

$path = $request->getPathInfo();
if ($qs = $request->getQueryString()) {
$path .= '?'.$qs;
}
$this->traces[$request->getMethod().' '.$path] = array();
$this->traces[$this->getTraceKey($request)] = array();

if (!$request->isMethodSafe(false)) {
$response = $this->invalidate($request, $catch);
} elseif ($request->headers->has('expect') || !$request->isMethodCacheable()) {
$response = $this->pass($request, $catch);
} elseif ($this->options['allow_reload'] && $request->isNoCache()) {
/*
If allow_reload is configured and the client requests "Cache-Control: no-cache",
reload the cache by fetching a fresh response and caching it (if possible).
*/
$this->record($request, 'reload');
$response = $this->fetch($request, $catch);
} else {
$response = $this->lookup($request, $catch);
}

$this->restoreResponseBody($request, $response);

$response->setDate(\DateTime::createFromFormat('U', time(), new \DateTimeZone('UTC')));

if (HttpKernelInterface::MASTER_REQUEST === $type && $this->options['debug']) {
$response->headers->set('X-Symfony-Cache', $this->getLog());
}
Expand Down Expand Up @@ -319,13 +320,6 @@ protected function invalidate(Request $request, $catch = false)
*/
protected function lookup(Request $request, $catch = false)
{
// if allow_reload and no-cache Cache-Control, allow a cache reload
if ($this->options['allow_reload'] && $request->isNoCache()) {
$this->record($request, 'reload');

return $this->fetch($request, $catch);
}

try {
$entry = $this->store->lookup($request);
} catch (\Exception $e) {
Expand Down Expand Up @@ -423,9 +417,8 @@ protected function validate(Request $request, Response $entry, $catch = false)
}

/**
* Forwards the Request to the backend and determines whether the response should be stored.
*
* This methods is triggered when the cache missed or a reload is required.
* Unconditionally fetches a fresh response from the backend and
* stores it in the cache if is cacheable.
*
* @param Request $request A Request instance
* @param bool $catch whether to process exceptions
Expand Down Expand Up @@ -457,6 +450,9 @@ protected function fetch(Request $request, $catch = false)
/**
* Forwards the Request to the backend and returns the Response.
*
* All backend requests (cache passes, fetches, cache validations)
* run through this method.
*
* @param Request $request A Request instance
* @param bool $catch Whether to catch exceptions or not
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
Expand Down Expand Up @@ -504,6 +500,17 @@ protected function forward(Request $request, $catch = false, Response $entry = n
}
}

/*
RFC 7231 Sect. 7.1.1.2 says that a server that does not have a reasonably accurate
clock MUST NOT send a "Date" header, although it MUST send one in most other cases
except for 1xx or 5xx responses where it MAY do so.

Anyway, a client that received a message without a "Date" header MUST add it.
*/
if (!$response->headers->has('Date')) {
$response->setDate(\DateTime::createFromFormat('U', time()));
}

$this->processResponseBody($request, $response);

if ($this->isPrivateRequest($request) && !$response->headers->hasCacheControlDirective('public')) {
Expand Down Expand Up @@ -604,9 +611,6 @@ protected function lock(Request $request, Response $entry)
*/
protected function store(Request $request, Response $response)
{
if (!$response->headers->has('Date')) {
$response->setDate(\DateTime::createFromFormat('U', time()));
}
try {
$this->store->write($request, $response);

Expand Down Expand Up @@ -703,11 +707,24 @@ private function isPrivateRequest(Request $request)
* @param string $event The event name
*/
private function record(Request $request, $event)
{
$this->traces[$this->getTraceKey($request)][] = $event;
}

/**
* Calculates the key we use in the "trace" array for a given request.
*
* @param Request $request
*
* @return string
*/
private function getTraceKey(Request $request)
{
$path = $request->getPathInfo();
if ($qs = $request->getQueryString()) {
$path .= '?'.$qs;
}
$this->traces[$request->getMethod().' '.$path][] = $event;

return $request->getMethod().' '.$path;
}
}