Escape double quotes in page titles in stork TOML file #15
Conversation
This file contains 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
|
This is a blocking bug that requires a user to modify plugin source code. Please merge it ASAP. |
justinmayer
approved these changes
Feb 3, 2023
maphew
added a commit
to maphew/search
that referenced
this pull request
Feb 4, 2023
This should handle any arbitrary punctuation marks which may happen to be in the Title - `",',\,*,...etc`. I don't undersand why this works, since we're not doing anything with json. I just know that everything I've thrown at it comes out safely. I left the change from pelican-plugins#15 intact, though json.dumps makes it unnecessary.
This was referenced Feb 4, 2023
justinmayer
pushed a commit
that referenced
this pull request
Feb 9, 2023
This should handle any arbitrary punctuation marks which may happen to be in the Title - `",',\,*,...etc`. I don't undersand why this works, since we're not doing anything with JSON. I just know that everything I've thrown at it comes out safely. The change from #15 performed manual title cleaning of nested quotes but did not address other potentially-problematic characters in the title, and json.dumps makes that change unnecessary and moot. Moreover, processing `title` with the manual quote handling AND using json.dumps together results in double-escaping of quotes. Ergo, that manual quotation-mark handling code has been removed here.
This was referenced Apr 12, 2023
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.
Pull Request Checklist
Resolves: #3 (comment)
Description
If a page title contains a double quote (
"), the double quote is rendered into the stork toml file verbatim, creating a syntax error and causing stork to fail.This PR escapes double quotes in titles (AFAICT this is the only place where they should appear) with
\", fixing the syntax errors.