Add SAPI_HEADER_DELETE_PREFIX, make ext/session use it
#18678
Conversation
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
The session ext currently munges into the linked list of headers itself, because the delete header API is given the key for headers to delete. The session ext wants to use a prefix past the colon separator, for i.e. "Set-Cookie: PHPSESSID=", to eliminate only the specific cookie rather than all cookies. This changes the SAPI code to add a new header op to take a prefix instead. Call sites are yet unchanged. Also fix some whitespace.
Use the modern SAPI header ops API, including the remove prefix op we just added.
TimWolla
reviewed
May 28, 2025
Girgias
approved these changes
May 28, 2025
NattyNarwhal
changed the title
SAPI_HEADER_REMOVE_PREFIX, make ext/session use itSAPI_HEADER_DELETE_PREFIX, make ext/session use it
The purpose of this is clear, and after refactoring, the special case is no longer there, so it has no value.
bukka
reviewed
May 31, 2025
| while (current) { | ||
| header = (sapi_header_struct *)(current->data); | ||
| next = current->next; | ||
| if (header->header_len > len && header->header[len] == ':' |
There was a problem hiding this comment.
Think this is meant to be a micro optimization that it checks that the header is size of Set-Cookie header which might skip some strncmp calls...
There was a problem hiding this comment.
I think this optimization should still be preserved in sapi_remove_header though?
Comment on lines
+1420
to
+1422
| header_line.line = ZSTR_VAL(ncookie.s); | ||
| header_line.line_len = ZSTR_LEN(ncookie.s); | ||
| sapi_header_op(SAPI_HEADER_ADD, &header_line); |
There was a problem hiding this comment.
I don't think there's much point in this and previous version is probably better for outside SAPI usage.
There was a problem hiding this comment.
The reason why I did this was because sapi_add_header_ex was marked as deprecated in the header and to use sapi_header_op instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Refactoring this as part of triaging GH-18601 - I don't think it'll fix the issue, but it's a good idea to clean anyways. ext/session had its own copy of the remove header code, because the SAPI header op mandated it was just a name, and would remove all headers for that name. ext/session couldn't rely on this because it only wanted to remove a specific cookie, not all of them.
To simplify this, add a version of
SAPI_HEADER_DELETEthat is more flexible and allows for passing a prefix to check for, not just a name. This should work for removing a specific cookie from the headers. (Also fixes some whitespace too.)