-
Notifications
You must be signed in to change notification settings - Fork 216
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enable translation of maps into directory trees #2448
Open
nikita-volkov
wants to merge
8
commits into
dhall-lang:main
Choose a base branch
from
nikita-volkov:master
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
01e6f97
Enable translation of maps into directory trees
nikita-volkov 42ccf58
Remove redundant import
nikita-volkov d055379
Add safety checks for paths
nikita-volkov 5c5d149
Conform to project's formatting
nikita-volkov 840bcd3
Add detection of Windows absolute paths
nikita-volkov 39bf0bd
Extend the docs
nikita-volkov e24e93f
Adapt to the latest changes in master
nikita-volkov 2924742
Restore the accidentally deleted docs
nikita-volkov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -20,7 +20,7 @@ module Dhall.DirectoryTree | |||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
import Control.Applicative (empty) | ||||||||||||||||||||||||||||||||||||||||||||||||||
import Control.Exception (Exception) | ||||||||||||||||||||||||||||||||||||||||||||||||||
import Control.Monad (unless, when) | ||||||||||||||||||||||||||||||||||||||||||||||||||
import Control.Monad (unless) | ||||||||||||||||||||||||||||||||||||||||||||||||||
import Data.Either.Validation (Validation (..)) | ||||||||||||||||||||||||||||||||||||||||||||||||||
import Data.Functor.Identity (Identity (..)) | ||||||||||||||||||||||||||||||||||||||||||||||||||
import Data.Maybe (fromMaybe) | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
@@ -52,23 +52,22 @@ import qualified Dhall.TypeCheck as TypeCheck | |||||||||||||||||||||||||||||||||||||||||||||||||
import qualified Dhall.Util as Util | ||||||||||||||||||||||||||||||||||||||||||||||||||
import qualified Prettyprinter.Render.String as Pretty | ||||||||||||||||||||||||||||||||||||||||||||||||||
import qualified System.Directory as Directory | ||||||||||||||||||||||||||||||||||||||||||||||||||
import qualified System.FilePath as FilePath | ||||||||||||||||||||||||||||||||||||||||||||||||||
import qualified System.PosixCompat.Files as Posix | ||||||||||||||||||||||||||||||||||||||||||||||||||
import qualified System.PosixCompat.User as Posix | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
{-| Attempt to transform a Dhall record into a directory tree where: | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
* Records are translated into directories | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
* @Map@s are also translated into directories | ||||||||||||||||||||||||||||||||||||||||||||||||||
* @Map@s are translated into directory trees, if allowSeparators option is enabled | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
* @Text@ values or fields are translated into files | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
* @Optional@ values are omitted if @None@ | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
* There is a more advanced way to construct directory trees using a fixpoint | ||||||||||||||||||||||||||||||||||||||||||||||||||
encoding. See the documentation below on that. | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
For example, the following Dhall record: | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
> { dir = { `hello.txt` = "Hello\n" } | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
@@ -112,6 +111,14 @@ import qualified System.PosixCompat.User as Posix | |||||||||||||||||||||||||||||||||||||||||||||||||
> ! "bar": null | ||||||||||||||||||||||||||||||||||||||||||||||||||
> ! "foo": "Hello" | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
/Construction of directory trees from maps/ | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
In @Map@s, the keys specify paths relative to the work dir. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Only forward slashes (@/@) must be used as directory separators. | ||||||||||||||||||||||||||||||||||||||||||||||||||
They will be automatically transformed on Windows. | ||||||||||||||||||||||||||||||||||||||||||||||||||
Absolute paths (starting with @/@) and parent directory segments (@..@) | ||||||||||||||||||||||||||||||||||||||||||||||||||
are prohibited for security concerns. | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
/Advanced construction of directory trees/ | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
In addition to the ways described above using "simple" Dhall values to | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
@@ -215,12 +222,39 @@ toDirectoryTree allowSeparators path expression = case expression of | |||||||||||||||||||||||||||||||||||||||||||||||||
empty | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
process key value = do | ||||||||||||||||||||||||||||||||||||||||||||||||||
when (not allowSeparators && Text.isInfixOf (Text.pack [ FilePath.pathSeparator ]) key) $ | ||||||||||||||||||||||||||||||||||||||||||||||||||
die | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
Directory.createDirectoryIfMissing allowSeparators path | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
toDirectoryTree allowSeparators (path </> Text.unpack key) value | ||||||||||||||||||||||||||||||||||||||||||||||||||
case keyPathSegments of | ||||||||||||||||||||||||||||||||||||||||||||||||||
-- Fail if path is absolute, which is a security risk. | ||||||||||||||||||||||||||||||||||||||||||||||||||
"" : _ -> | ||||||||||||||||||||||||||||||||||||||||||||||||||
die | ||||||||||||||||||||||||||||||||||||||||||||||||||
-- Detect Windows absolute paths like "C:". | ||||||||||||||||||||||||||||||||||||||||||||||||||
[_ , ':'] : _ -> | ||||||||||||||||||||||||||||||||||||||||||||||||||
die | ||||||||||||||||||||||||||||||||||||||||||||||||||
-- Fail if separators are not allowed by the option. | ||||||||||||||||||||||||||||||||||||||||||||||||||
_ : _ | not allowSeparators -> | ||||||||||||||||||||||||||||||||||||||||||||||||||
die | ||||||||||||||||||||||||||||||||||||||||||||||||||
_ -> | ||||||||||||||||||||||||||||||||||||||||||||||||||
return () | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
-- Fail if path contains attempts to go to container directory, | ||||||||||||||||||||||||||||||||||||||||||||||||||
-- which is a security risk. | ||||||||||||||||||||||||||||||||||||||||||||||||||
if elem ".." keyPathSegments | ||||||||||||||||||||||||||||||||||||||||||||||||||
then die | ||||||||||||||||||||||||||||||||||||||||||||||||||
else return () | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
(dirPath, fileName) <- case reverse keyPathSegments of | ||||||||||||||||||||||||||||||||||||||||||||||||||
h : t -> | ||||||||||||||||||||||||||||||||||||||||||||||||||
return | ||||||||||||||||||||||||||||||||||||||||||||||||||
( Foldable.foldl' (</>) path (reverse t) | ||||||||||||||||||||||||||||||||||||||||||||||||||
, h ) | ||||||||||||||||||||||||||||||||||||||||||||||||||
_ -> | ||||||||||||||||||||||||||||||||||||||||||||||||||
die | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
Directory.createDirectoryIfMissing True dirPath | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
toDirectoryTree allowSeparators (dirPath </> fileName) value | ||||||||||||||||||||||||||||||||||||||||||||||||||
Comment on lines
+244
to
+254
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you want something like this:
Suggested change
In other words, Note that nikita-volkov#1 fixes this, too |
||||||||||||||||||||||||||||||||||||||||||||||||||
where | ||||||||||||||||||||||||||||||||||||||||||||||||||
keyPathSegments = | ||||||||||||||||||||||||||||||||||||||||||||||||||
fmap Text.unpack $ Text.splitOn "/" key | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||
die = Exception.throwIO FilesystemError{..} | ||||||||||||||||||||||||||||||||||||||||||||||||||
where | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps use
System.FilePath.isRelative
?