[HttpFoundation] Add HeaderUtils class #24699

c960657 · 2017-10-26T18:59:47Z

Q	A
Branch?	master
Bug fix?	yes
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets
License	MIT
Doc PR

In several places in HttpFoundation we parse HTTP header values using a variety of regular expressions. Some of them fail in various corner cases.

Parsing HTTP headers is not entirely trivial. We must be able to parse quoted strings with backslash escaping properly and ignore white-space in certain places.

In practice, our limitations in this respect may not be a big problem. We only care about a few different HTTP request headers, and they are usually restricted to a simple values without quoted strings etc. However, this is no excuse for not doing it right :-)

This PR introduces a new utility class for parsing headers. This allows Symfony itself and third-party code to parse HTTP headers in a robust way without using complex regular expressions that are difficult to write and error prone.

nicolas-grekas · 2017-10-28T16:19:51Z

This is the kind of change that should be really fine, but is risky until proven right. I'm not sure this can be merged in 3.4 as this is a new feature, even if it fixes edge cases.
About these edge-cases, are they solvable, testable, important to fix now?

c960657 · 2017-10-28T23:08:24Z

At least some of the edge cases are easy to fix, e.g. those dealing with missing case-insensitivity.

I don't think these problems are particularly important to fix in 3.x. They hardly occur in practice. So I wouldn't mind postponing this to 4.x.

c960657 · 2017-11-18T14:24:53Z

Rebased to master.

hhamon · 2017-11-23T21:12:07Z

src/Symfony/Component/HttpFoundation/HeaderUtils.php

+ *
+ * @author Christian Schmidt <github@chsc.dk>
+ */
+class HeaderUtils


Shall this class be marked @internal?

I don't think so. It is generally useful when parsing HTTP headers, including those not supported directly by HttpFoundation. It may even be used in other contexts than parsing incoming HTTP request headers.

c960657 · 2018-03-06T18:02:58Z

Rebased to master.

ro0NL · 2018-04-19T11:00:10Z

src/Symfony/Component/HttpFoundation/CHANGELOG.md

@@ -15,6 +15,7 @@ CHANGELOG
 * added `CannotWriteFileException`, `ExtensionFileException`, `FormSizeFileException`,
   `IniSizeFileException`, `NoFileException`, `NoTmpDirFileException`, `PartialFileException` to
   handle failed `UploadedFile`.
+ * added `HeaderUtility`.


HeaderUtils :)

ro0NL · 2018-04-19T11:03:31Z

src/Symfony/Component/HttpFoundation/HeaderUtils.php

+        $assoc = array();
+        foreach ($parts as $part) {
+            $name = strtolower($part[0]);
+            $value = isset($part[1]) ? $part[1] : true;


$part[1] ?? true

ro0NL · 2018-04-19T11:05:00Z

src/Symfony/Component/HttpFoundation/HeaderUtils.php

+     * @return array Nested array with as many levels as there are characters in
+     *               $separators
+     */
+    public static function split($header, $separators)


in general type declarations / return types are missing

ro0NL · 2018-04-19T11:06:02Z

src/Symfony/Component/HttpFoundation/Tests/HeaderUtilsTest.php

+
+    public function testQuote()
+    {
+        $this->assertEquals('foo', HeaderUtils::quote('foo'));


also assertSame as of here..

c960657 · 2018-04-20T05:37:35Z

@ro0NL I have addresses your comments. Thanks!

nicolas-grekas · 2018-04-20T12:34:48Z

src/Symfony/Component/HttpFoundation/HeaderUtils.php

+     *
+     * @param array $parts Array of arrays
+     *
+     * @return array Associative array


I think many docblocks here could be removed. We prefer not adding them when they are of low added value.
While doing so, could you please squash your commits also?

I assume you mean the individual @param and @return lines, not the entire docblock, right?

That's correct.

Sure I can squash, but doesn't Github offer to do this automatically? I'm just trying to understand why it is relevant :-)

we don't use github to merge
and the squashing feature of the tool we're using is broken right now :)

Ok, cool :-) I have removed the unnecessary docblock lines and squashed my commits (it took a few attempts to get it right).

nicolas-grekas

(with minor comment)

xabbuh · 2018-04-20T13:06:20Z

src/Symfony/Component/HttpFoundation/HeaderUtils.php

+        return self::groupParts($matches, $separators);
+    }
+
+    private static function groupParts(array $matches, string $separators): array


private methods should be after public ones

fabpot · 2018-04-22T06:30:21Z

Thank you @c960657.

This PR was merged into the 4.1-dev branch. Discussion ---------- [HttpFoundation] Add HeaderUtils class | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | In several places in HttpFoundation we parse HTTP header values using a variety of regular expressions. Some of them fail in various corner cases. Parsing HTTP headers is not entirely trivial. We must be able to parse quoted strings with backslash escaping properly and ignore white-space in certain places. In practice, our limitations in this respect may not be a big problem. We only care about a few different HTTP request headers, and they are usually restricted to a simple values without quoted strings etc. However, this is no excuse for not doing it right :-) This PR introduces a new utility class for parsing headers. This allows Symfony itself and third-party code to parse HTTP headers in a robust way without using complex regular expressions that are difficult to write and error prone. Commits ------- b435e80 [HttpFoundation] Add HeaderUtility class

stof · 2018-04-23T14:08:55Z

src/Symfony/Component/HttpFoundation/HeaderUtils.php

+     */
+    public static function split(string $header, string $separators): array
+    {
+        $quotedSeparators = preg_quote($separators);


this should include the regex delimiter (/ as second argument of the call, in case it is one of the separators

stof · 2018-04-23T14:12:01Z

src/Symfony/Component/HttpFoundation/HeaderUtils.php

+     * Combines an array of arrays into one associative array.
+     *
+     * Each of the nested arrays should have one or two elements. The first
+     * value will be used as the keys in the associative array, and the second


that's not what is done. The key is the associative array is the lowercased first value, not the first value.

stof · 2018-04-23T14:12:18Z

src/Symfony/Component/HttpFoundation/HeaderUtils.php

+     * Example:
+     *
+     *     HeaderUtils::split("da, en-gb;q=0.8", ",;")
+     *     // => array(array("da"), array("en-gb"), array("q", "0.8"))


Are you sure about this example ? Why is the header split on = when giving ,; as separator ?

c960657 · 2018-04-23T14:52:16Z

@stof You are right x 3 :-) I have created a follow-up PR: #27019

@stof

This PR was squashed before being merged into the 4.1-dev branch (closes #27019). Discussion ---------- [HttpFoundation] Fixes to new HeaderUtils class | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | A follow-up to #24699 with a few code and documentation fixes for post-merge review comments by @stof. Commits ------- d7c3c79 [HttpFoundation] Fixes to new HeaderUtils class

c960657 force-pushed the header-utils branch 5 times, most recently from eee2a20 to 9b08a46 Compare October 26, 2017 20:04

nicolas-grekas added this to the 4.1 milestone Oct 28, 2017

c960657 force-pushed the header-utils branch 2 times, most recently from 7b3d34c to 3674a7d Compare October 28, 2017 22:47

xabbuh changed the base branch from 3.4 to master November 15, 2017 17:23

c960657 force-pushed the header-utils branch from 3674a7d to a7a6956 Compare November 18, 2017 14:10

javiereguiluz added Bug Feature HttpFoundation labels Nov 20, 2017

hhamon reviewed Nov 23, 2017

View reviewed changes

c960657 force-pushed the header-utils branch from 233d5c0 to b8727ee Compare March 6, 2018 17:51

c960657 force-pushed the header-utils branch from b8727ee to b641717 Compare March 24, 2018 09:51

c960657 force-pushed the header-utils branch from b641717 to 56b848e Compare April 3, 2018 18:19

fabpot approved these changes Apr 6, 2018

View reviewed changes

carsonbot added the Status: Reviewed label Apr 6, 2018

ro0NL reviewed Apr 19, 2018

View reviewed changes

c960657 changed the title ~~[HttpFoundation] Add HeaderUtility class~~ [HttpFoundation] Add HeaderUtils class Apr 20, 2018

c960657 force-pushed the header-utils branch 2 times, most recently from 2bb54da to 1ef098a Compare April 20, 2018 05:28

nicolas-grekas reviewed Apr 20, 2018

View reviewed changes

nicolas-grekas approved these changes Apr 20, 2018

View reviewed changes

xabbuh reviewed Apr 20, 2018

View reviewed changes

c960657 force-pushed the header-utils branch 2 times, most recently from c92e14b to 96f7606 Compare April 20, 2018 14:29

[HttpFoundation] Add HeaderUtility class

b435e80

c960657 force-pushed the header-utils branch from 96f7606 to b435e80 Compare April 20, 2018 14:29

fabpot merged commit b435e80 into symfony:master Apr 22, 2018

javiereguiluz mentioned this pull request Apr 22, 2018

[HttpFoundation] Add HeaderUtils class symfony/symfony-docs#9655

Closed

stof reviewed Apr 23, 2018

View reviewed changes

c960657 mentioned this pull request Apr 23, 2018

[HttpFoundation] Fixes to new HeaderUtils class #27019

Merged

c960657 deleted the header-utils branch April 23, 2018 14:51

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

ro0NL mentioned this pull request Sep 29, 2018

[Http-Fundation] HeaderUtils->combine breaks X-Sendfile #28627

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HttpFoundation] Add HeaderUtils class #24699

[HttpFoundation] Add HeaderUtils class #24699

c960657 commented Oct 26, 2017 •

edited by fabpot

nicolas-grekas commented Oct 28, 2017

c960657 commented Oct 28, 2017

c960657 commented Nov 18, 2017

hhamon Nov 23, 2017

c960657 Nov 24, 2017

c960657 commented Mar 6, 2018

ro0NL Apr 19, 2018

ro0NL Apr 19, 2018 •

edited

ro0NL Apr 19, 2018

ro0NL Apr 19, 2018 •

edited

c960657 commented Apr 20, 2018

nicolas-grekas Apr 20, 2018

c960657 Apr 20, 2018

fabpot Apr 20, 2018

c960657 Apr 20, 2018

nicolas-grekas Apr 20, 2018

c960657 Apr 20, 2018

nicolas-grekas left a comment

xabbuh Apr 20, 2018

c960657 Apr 20, 2018

fabpot commented Apr 22, 2018

stof Apr 23, 2018

stof Apr 23, 2018

stof Apr 23, 2018

c960657 commented Apr 23, 2018 •

edited

[HttpFoundation] Add HeaderUtils class #24699

[HttpFoundation] Add HeaderUtils class #24699

Conversation

c960657 commented Oct 26, 2017 • edited by fabpot

nicolas-grekas commented Oct 28, 2017

c960657 commented Oct 28, 2017

c960657 commented Nov 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

c960657 commented Mar 6, 2018

Choose a reason for hiding this comment

ro0NL Apr 19, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL Apr 19, 2018 • edited

Choose a reason for hiding this comment

c960657 commented Apr 20, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Apr 22, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

c960657 commented Apr 23, 2018 • edited

c960657 commented Oct 26, 2017 •

edited by fabpot

ro0NL Apr 19, 2018 •

edited

ro0NL Apr 19, 2018 •

edited

c960657 commented Apr 23, 2018 •

edited