php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-02 13:02:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix #19187: Fix yii\filters\PageCache to store original headers names instead of normalized ones

Browse Source
This commit is contained in:
Bizley
2022-01-26 22:52:32 +01:00
committed by GitHub
parent 0eaa71d46c
commit dbb157fd32
6 changed files with 185 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
framework/CHANGELOG.md
View File

@ -9,6 +9,7 @@ Yii Framework 2 Change Log
- Bug #19148: Fix undefined array key errors in `yii\db\ActiveRelationTrait` (stevekr)
- Bug #19041: Fix PHP 8.1 issues (longthanhtran, samdark, pamparam83, sartor, githubjeka)
- Enh #19171: Added `$pagination` and `$sort` to `\yii\rest\IndexAction` for easy configuration (rhertogh)
- Bug #19187: Fix `yii\filters\PageCache` to store original headers names instead of normalized ones (bizley)
- Bug #19191: Change `\Exception` to `\Throwable` in `BadRequestHttpException` and `HttpException` (Dmitrijlin)

13
framework/UPGRADE.md
View File

@ -51,10 +51,18 @@ if you want to upgrade from version A to version C and there is
version B between A and C, you need to follow the instructions
for both A and B.
Upgrade from Yii 2.0.44
-----------------------
* `yii\filters\PageCache::$cacheHeaders` now takes a case-sensitive list of header names since PageCache is no longer
storing the normalized (lowercase) versions of them so make sure this list is properly updated and your page cache
is recreated.
Upgrade from Yii 2.0.43
-----------------------
* `Json::encode()` can now handle zero-indexed objects in same way as `json_encode()` and keep them as objects. In order to avoid breaking backwards compatibility this behavior could be enabled by a new option flag but is disabled by default.
* `Json::encode()` can now handle zero-indexed objects in same way as `json_encode()` and keep them as objects. In order
to avoid breaking backwards compatibility this behavior could be enabled by a new option flag but is disabled by default.
* Set `yii/helpers/Json::$keepObjectType = true` anywhere in your application code
* Or configure json response formatter to enable it for all JSON responses:
```php
@ -68,7 +76,8 @@ Upgrade from Yii 2.0.43
],
],
```
* `yii\caching\Cache::multiSet()` now uses the default cache duration (`yii\caching\Cache::$defaultDuration`) when no duration is provided. A duration of 0 should be explicitly passed if items should not expire.
* `yii\caching\Cache::multiSet()` now uses the default cache duration (`yii\caching\Cache::$defaultDuration`) when no
duration is provided. A duration of 0 should be explicitly passed if items should not expire.
Upgrade from Yii 2.0.42
-----------------------

49
framework/filters/PageCache.php
View File

@ -129,7 +129,7 @@ class PageCache extends ActionFilter implements DynamicContentAwareInterface
public $cacheCookies = false;
/**
* @var bool|array a boolean value indicating whether to cache all HTTP headers, or an array of
* HTTP header names (case-insensitive) indicating which HTTP headers can be cached.
* HTTP header names (case-sensitive) indicating which HTTP headers can be cached.
* Note if your HTTP headers contain sensitive information, you should white-list which headers can be cached.
* @since 2.0.4
*/
@ -253,40 +253,59 @@ class PageCache extends ActionFilter implements DynamicContentAwareInterface
foreach (['format', 'version', 'statusCode', 'statusText'] as $name) {
$data[$name] = $response->{$name};
}
$this->insertResponseCollectionIntoData($response, 'headers', $data);
$this->insertResponseCollectionIntoData($response, 'cookies', $data);
$this->insertResponseHeaderCollectionIntoData($response, $data);
$this->insertResponseCookieCollectionIntoData($response, $data);
$this->cache->set($this->calculateCacheKey(), $data, $this->duration, $this->dependency);
$data['content'] = $this->updateDynamicContent($data['content'], $this->getDynamicPlaceholders());
echo $data['content'];
}
/**
* Inserts (or filters/ignores according to config) response headers/cookies into a cache data array.
* Inserts (or filters/ignores according to config) response cookies into a cache data array.
* @param Response $response the response.
* @param string $collectionName currently it's `headers` or `cookies`.
* @param array $data the cache data.
*/
private function insertResponseCollectionIntoData(Response $response, $collectionName, array &$data)
private function insertResponseCookieCollectionIntoData(Response $response, array &$data)
{
$property = 'cache' . ucfirst($collectionName);
if ($this->{$property} === false) {
if ($this->cacheCookies === false) {
return;
}
$all = $response->{$collectionName}->toArray();
if (is_array($this->{$property})) {
$all = $response->cookies->toArray();
if (is_array($this->cacheCookies)) {
$filtered = [];
foreach ($this->{$property} as $name) {
if ($collectionName === 'headers') {
$name = strtolower($name);
}
foreach ($this->cacheCookies as $name) {
if (isset($all[$name])) {
$filtered[$name] = $all[$name];
}
}
$all = $filtered;
}
$data[$collectionName] = $all;
$data['cookies'] = $all;
}
/**
* Inserts (or filters/ignores according to config) response headers into a cache data array.
* @param Response $response the response.
* @param array $data the cache data.
*/
private function insertResponseHeaderCollectionIntoData(Response $response, array &$data)
{
if ($this->cacheHeaders === false) {
return;
}
$all = $response->headers->toArray(true);
if (is_array($this->cacheHeaders)) {
$filtered = [];
foreach ($this->cacheHeaders as $name) {
if (isset($all[$name])) {
$filtered[$name] = $all[$name];
}
}
$all = $filtered;
}
$data['headers'] = $all;
}
/**

60
framework/web/HeaderCollection.php
View File

@ -22,9 +22,13 @@ use yii\base\BaseObject;
class HeaderCollection extends BaseObject implements \IteratorAggregate, \ArrayAccess, \Countable
{
/**
* @var array the headers in this collection (indexed by the header names)
* @var array the headers in this collection (indexed by the normalized header names)
*/
private $_headers = [];
/**
* @var array the original names of the headers (indexed by the normalized header names)
*/
private $_originalHeaderNames = [];
/**
@ -72,9 +76,9 @@ class HeaderCollection extends BaseObject implements \IteratorAggregate, \ArrayA
*/
public function get($name, $default = null, $first = true)
{
$name = strtolower($name);
if (isset($this->_headers[$name])) {
return $first ? reset($this->_headers[$name]) : $this->_headers[$name];
$normalizedName = strtolower($name);
if (isset($this->_headers[$normalizedName])) {
return $first ? reset($this->_headers[$normalizedName]) : $this->_headers[$normalizedName];
}
return $default;
@ -89,8 +93,9 @@ class HeaderCollection extends BaseObject implements \IteratorAggregate, \ArrayA
*/
public function set($name, $value = '')
{
$name = strtolower($name);
$this->_headers[$name] = (array) $value;
$normalizedName = strtolower($name);
$this->_headers[$normalizedName] = (array) $value;
$this->_originalHeaderNames[$normalizedName] = $name;
return $this;
}
@ -105,8 +110,11 @@ class HeaderCollection extends BaseObject implements \IteratorAggregate, \ArrayA
*/
public function add($name, $value)
{
$name = strtolower($name);
$this->_headers[$name][] = $value;
$normalizedName = strtolower($name);
$this->_headers[$normalizedName][] = $value;
if (!\array_key_exists($normalizedName, $this->_originalHeaderNames)) {
$this->_originalHeaderNames[$normalizedName] = $name;
}
return $this;
}
@ -120,9 +128,10 @@ class HeaderCollection extends BaseObject implements \IteratorAggregate, \ArrayA
*/
public function setDefault($name, $value)
{
$name = strtolower($name);
if (empty($this->_headers[$name])) {
$this->_headers[$name][] = $value;
$normalizedName = strtolower($name);
if (empty($this->_headers[$normalizedName])) {
$this->_headers[$normalizedName][] = $value;
$this->_originalHeaderNames[$normalizedName] = $name;
}
return $this;
@ -135,9 +144,7 @@ class HeaderCollection extends BaseObject implements \IteratorAggregate, \ArrayA
*/
public function has($name)
{
$name = strtolower($name);
return isset($this->_headers[$name]);
return isset($this->_headers[strtolower($name)]);
}
/**
@ -147,10 +154,10 @@ class HeaderCollection extends BaseObject implements \IteratorAggregate, \ArrayA
*/
public function remove($name)
{
$name = strtolower($name);
if (isset($this->_headers[$name])) {
$value = $this->_headers[$name];
unset($this->_headers[$name]);
$normalizedName = strtolower($name);
if (isset($this->_headers[$normalizedName])) {
$value = $this->_headers[$normalizedName];
unset($this->_headers[$normalizedName], $this->_originalHeaderNames[$normalizedName]);
return $value;
}
@ -163,16 +170,25 @@ class HeaderCollection extends BaseObject implements \IteratorAggregate, \ArrayA
public function removeAll()
{
$this->_headers = [];
$this->_originalHeaderNames = [];
}
/**
* Returns the collection as a PHP array.
* @return array the array representation of the collection.
* The array keys are header names, and the array values are the corresponding header values.
* Since 2.0.45 you can pass true here to get the headers list of original header names (case-sensitive) instead of
* default normalized (case-insensitive) ones.
*/
public function toArray()
public function toArray($originalNames = false)
{
return $this->_headers;
if ($originalNames === false) {
return $this->_headers;
}
return \array_map(function ($normalizedName) {
return $this->_headers[$normalizedName];
}, \array_flip($this->_originalHeaderNames));
}
/**
@ -182,7 +198,9 @@ class HeaderCollection extends BaseObject implements \IteratorAggregate, \ArrayA
*/
public function fromArray(array $array)
{
$this->_headers = array_change_key_case($array, CASE_LOWER);
foreach ($array as $name => $value) {
$this->set($name, $value);
}
}
/**