Encode filepaths to be safe for Windows #489
Merged
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
stackoverflow
approved these changes
May 10, 2024
| return sb.toString(); | ||
| } | ||
|
|
||
| /** The inverse of {@link #encodePath(String)} */ |
There was a problem hiding this comment.
Technically, this function is not really the inverse of encodePath, as it decodes anything, not only the chars that encodePath encodes. So one can decode (66)(6f)(6f).text as foo.txt which cannot be generated by encodePath. But I'm being pedantic and I think it's fine that it decodes anything.
There was a problem hiding this comment.
Good point. Although, I'm actually getting rid of this altogether; this method isn't used anywhere.
| // https://stackoverflow.com/questions/2678551/when-should-space-be-encoded-to-plus-or-20#:~:text=%20%20is%20a%20valid%20way,encodeURIComponent()%20does%20in%20JavaScript.) | ||
| return ret.replace("+", "%20") | ||
| val ret = URI(null, null, this, null) | ||
| return ret.toString().replace("/", "%2F") |
There was a problem hiding this comment.
Why the change here?
There was a problem hiding this comment.
The previous implementation was encoding parentheses in percent encoding.
bioball
force-pushed
the
windows-safe-paths
branch
from
a1a636a
to
2b56fbe
Compare
Only encode characters that are strictly necessary in URI paths. This removes encoding for parentheses, for example.
bioball
force-pushed
the
windows-safe-paths
branch
3 times, most recently
from
63d4986
to
1ee4e2a
Compare
This changes the file paths to use characters that are safe for Windows. Channges the output of the following: * Package cache directory * Generated pkl-doc files * Kotlin generated code Unsafe characters are encoded as (<hex>). For example, the colon character `:` is encoded as `(3a)`. Additionally, this changes the cache directory prefix (package-1 to package-2). Follows the design of apple/pkl-evolution#3
bioball
force-pushed
the
windows-safe-paths
branch
from
1ee4e2a
to
de4d78b
Compare
This was referenced May 13, 2024
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.
Also: don't URI-encode parentheses in pkldoc.
Implementation for SPICE-0003