Handling of suggestion links with single quotes (and other special symbols) #860
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
Codecov ReportBase: 71.41% // Head: 71.41% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## master #860 +/- ##
=======================================
Coverage 71.41% 71.41%
=======================================
Files 53 53
Lines 3740 3740
Branches 2089 2077 -12
=======================================
Hits 2671 2671
Misses 1067 1067
Partials 2 2 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
veloman-yunkan
changed the title
This change fixes two issues:
1. Presence of URL-specific special symbols (such as ? or #) in the book
and/or article name resulted in a wrong suggestion link. This is
fixed by URI-encoding the book name and the path, too.
2. Presence of a single quote symbol in the book and/or article name
resulted in invalid javascript code in the href attribute of the
suggestion link.
The single quote (') symbol is not URL-encoded (unlike its double quote
counterpart). As a result, enclosing a URL-encoded string in single
quotes may result in invalid javascript. Using double quotes instead is
safe, since both double quote (") and backslash (\) symbols (which are
the only special symbols for such quoting) undergo URL-encoding.
veloman-yunkan
force-pushed
the
handling_of_suggestion_links_with_single_quotes
branch
from
fdbb4d0
to
f3d2f47
Compare
mgautierfr
approved these changes
Dec 21, 2022
mgautierfr
deleted the
handling_of_suggestion_links_with_single_quotes
branch
This pull request was closed.
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.
This is a follow-up of #859.
Should fix kiwix/kiwix-tools#589
This PR fixes suggestion links in the presence of special symbols such as
'(a single quote),?(a question mark), and/or#(hash) in the root location (value of the--urlRootLocationoption ofkiwix-serve), book name or article name.