-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[http-foudation] Better accept header parsing #5841
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.
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
Closed
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
44a49ab
[http-foundation] Added 'AcceptHeaderItem' class + test.
jfsimon 645b656
[http-foundation] Added 'AcceptHeader' class + test.
jfsimon a94cb11
[http-foundation] Fixed 'AcceptHeader' sorting.
jfsimon 2e73660
[http-foudation] Updated request object & tests.
jfsimon 7f22b6f
[http-foundation] Fixed reference problem.
jfsimon aea1fa8
[http-foundation] Applied advices.
jfsimon a9d6ff0
[HttpFoundation] Avoid slow merge sort by preserving the index of eve…
Seldaek 8bfff27
[HttpFoundation] Removed previously introduced BC break.
jfsimon 85e9e28
Added changelog infos, upgrade file & removed unused code.
jfsimon 1caf92d
[HttpFoundation] Fixed CS.
jfsimon 1a33082
[HttpFoundation] Fixed CS.
jfsimon 2e4a048
[HttpFoudation] Fixed error.
jfsimon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
UPGRADE FROM 2.1 to 2.2 | ||
======================= | ||
|
||
#### Deprecations | ||
|
||
* The `Request::splitHttpAcceptHeader()` is deprecated and will be removed in 2.3. | ||
|
||
You should now use the `AcceptHeader` class which give you fluent methods to | ||
parse request accept-* headers. Some examples: | ||
|
||
``` | ||
$accept = AcceptHeader::fromString($request->headers->get('Accept')); | ||
if ($accept->has('text/html') { | ||
$item = $accept->get('html'); | ||
$charset = $item->getAttribute('charset', 'utf-8'); | ||
$quality = $item->getQuality(); | ||
} | ||
|
||
// accepts items are sorted by descending quality | ||
$accepts = AcceptHeader::fromString($request->headers->get('Accept'))->all(); | ||
|
||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,172 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\HttpFoundation; | ||
|
||
/** | ||
* Represents an Accept-* header. | ||
* | ||
* An accept header is compound with a list of items, | ||
* sorted by descending quality. | ||
* | ||
* @author Jean-François Simon <contact@jfsimon.fr> | ||
*/ | ||
class AcceptHeader | ||
{ | ||
/** | ||
* @var AcceptHeaderItem[] | ||
*/ | ||
private $items = array(); | ||
|
||
/** | ||
* @var bool | ||
*/ | ||
private $sorted = true; | ||
|
||
/** | ||
* Constructor. | ||
* | ||
* @param AcceptHeaderItem[] $items | ||
*/ | ||
public function __construct(array $items) | ||
{ | ||
foreach ($items as $item) { | ||
$this->add($item); | ||
} | ||
} | ||
|
||
/** | ||
* Builds an AcceptHeader instance from a string. | ||
* | ||
* @param string $headerValue | ||
* | ||
* @return AcceptHeader | ||
*/ | ||
public static function fromString($headerValue) | ||
{ | ||
$index = 0; | ||
|
||
return new self(array_map(function ($itemValue) use (&$index) { | ||
$item = AcceptHeaderItem::fromString($itemValue); | ||
$item->setIndex($index++); | ||
|
||
return $item; | ||
}, preg_split('/\s*(?:,*("[^"]+"),*|,*(\'[^\']+\'),*|,+)\s*/', $headerValue, 0, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE))); | ||
} | ||
|
||
/** | ||
* Returns header value's string representation. | ||
* | ||
* @return string | ||
*/ | ||
public function __toString() | ||
{ | ||
return implode(',', $this->items); | ||
} | ||
|
||
/** | ||
* Tests if header has given value. | ||
* | ||
* @param string $value | ||
* | ||
* @return Boolean | ||
*/ | ||
public function has($value) | ||
{ | ||
return isset($this->items[$value]); | ||
} | ||
|
||
/** | ||
* Returns given value's item, if exists. | ||
* | ||
* @param string $value | ||
* | ||
* @return AcceptHeaderItem|null | ||
*/ | ||
public function get($value) | ||
{ | ||
return isset($this->items[$value]) ? $this->items[$value] : null; | ||
} | ||
|
||
/** | ||
* Adds an item. | ||
* | ||
* @param AcceptHeaderItem $item | ||
* | ||
* @return AcceptHeader | ||
*/ | ||
public function add(AcceptHeaderItem $item) | ||
{ | ||
$this->items[$item->getValue()] = $item; | ||
$this->sorted = false; | ||
|
||
return $this; | ||
} | ||
|
||
/** | ||
* Returns all items. | ||
* | ||
* @return AcceptHeaderItem[] | ||
*/ | ||
public function all() | ||
{ | ||
$this->sort(); | ||
|
||
return $this->items; | ||
} | ||
|
||
/** | ||
* Filters items on their value using given regex. | ||
* | ||
* @param string $pattern | ||
* | ||
* @return AcceptHeader | ||
*/ | ||
public function filter($pattern) | ||
{ | ||
return new self(array_filter($this->items, function (AcceptHeaderItem $item) use ($pattern) { | ||
return preg_match($pattern, $item->getValue()); | ||
})); | ||
} | ||
|
||
/** | ||
* Returns first item. | ||
* | ||
* @return AcceptHeaderItem|null | ||
*/ | ||
public function first() | ||
{ | ||
$this->sort(); | ||
|
||
return !empty($this->items) ? current($this->items) : null; | ||
} | ||
|
||
/** | ||
* Sorts items by descending quality | ||
*/ | ||
private function sort() | ||
{ | ||
if (!$this->sorted) { | ||
uasort($this->items, function ($a, $b) { | ||
$qA = $a->getQuality(); | ||
$qB = $b->getQuality(); | ||
|
||
if ($qA === $qB) { | ||
return $a->getIndex() > $b->getIndex() ? 1 : -1; | ||
} | ||
|
||
return $qA > $qB ? -1 : 1; | ||
}); | ||
|
||
$this->sorted = true; | ||
} | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't it set
$this->sorted = true;
after sorting?!There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed it should :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed