dhall-1.40.2: src/Dhall/Import.hs
{-# LANGUAGE AllowAmbiguousTypes #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE DeriveAnyClass #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RankNTypes #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE ViewPatterns #-}
{-# OPTIONS_GHC -Wall #-}
{-| Dhall lets you import external expressions located either in local files or
hosted on network endpoints.
To import a local file as an expression, just insert the path to the file,
prepending a @./@ if the path is relative to the current directory. For
example, if you create a file named @id@ with the following contents:
> $ cat id
> λ(a : Type) → λ(x : a) → x
Then you can use the file directly within a @dhall@ program just by
referencing the file's path:
> $ dhall
> ./id Bool True
> <Ctrl-D>
> Bool
>
> True
Imported expressions may contain imports of their own, too, which will
continue to be resolved. However, Dhall will prevent cyclic imports. For
example, if you had these two files:
> $ cat foo
> ./bar
> $ cat bar
> ./foo
... Dhall would throw the following exception if you tried to import @foo@:
> $ dhall
> ./foo
> ^D
> ↳ ./foo
> ↳ ./bar
>
> Cyclic import: ./foo
You can also import expressions hosted on network endpoints. Just use the
URL
> http://host[:port]/path
The compiler expects the downloaded expressions to be in the same format
as local files, specifically UTF8-encoded source code text.
For example, if our @id@ expression were hosted at @http://example.com/id@,
then we would embed the expression within our code using:
> http://example.com/id
You can also import expressions stored within environment variables using
@env:NAME@, where @NAME@ is the name of the environment variable. For
example:
> $ export FOO=1
> $ export BAR='"Hi"'
> $ export BAZ='λ(x : Bool) → x == False'
> $ dhall <<< "{ foo = env:FOO , bar = env:BAR , baz = env:BAZ }"
> { bar : Text, baz : ∀(x : Bool) → Bool, foo : Integer }
>
> { bar = "Hi", baz = λ(x : Bool) → x == False, foo = 1 }
If you wish to import the raw contents of an impoert as @Text@ then add
@as Text@ to the end of the import:
> $ dhall <<< "http://example.com as Text"
> Text
>
> "<!doctype html>\n<html>\n<head>\n <title>Example Domain</title>\n\n <meta
> charset=\"utf-8\" />\n <meta http-equiv=\"Content-type\" content=\"text/html
> ; charset=utf-8\" />\n <meta name=\"viewport\" content=\"width=device-width,
> initial-scale=1\" />\n <style type=\"text/css\">\n body {\n backgro
> und-color: #f0f0f2;\n margin: 0;\n padding: 0;\n font-famil
> y: \"Open Sans\", \"Helvetica Neue\", Helvetica, Arial, sans-serif;\n \n
> }\n div {\n width: 600px;\n margin: 5em auto;\n paddi
> ng: 50px;\n background-color: #fff;\n border-radius: 1em;\n }\n
> a:link, a:visited {\n color: #38488f;\n text-decoration: none;
> \n }\n @media (max-width: 700px) {\n body {\n background
> -color: #fff;\n }\n div {\n width: auto;\n m
> argin: 0 auto;\n border-radius: 0;\n padding: 1em;\n
> }\n }\n </style> \n</head>\n\n<body>\n<div>\n <h1>Example Domain</
> h1>\n <p>This domain is established to be used for illustrative examples in d
> ocuments. You may use this\n domain in examples without prior coordination or
> asking for permission.</p>\n <p><a href=\"http://www.iana.org/domains/exampl
> e\">More information...</a></p>\n</div>\n</body>\n</html>\n"
-}
module Dhall.Import (
-- * Import
load
, loadWithManager
, loadRelativeTo
, loadWithStatus
, loadWith
, localToPath
, hashExpression
, hashExpressionToCode
, writeExpressionToSemanticCache
, assertNoImports
, Manager
, defaultNewManager
, CacheWarning(..)
, Status(..)
, SemanticCacheMode(..)
, Chained
, chainedImport
, chainedFromLocalHere
, chainedChangeMode
, emptyStatus
, emptyStatusWithManager
, envOriginHeaders
, makeEmptyStatus
, remoteStatus
, remoteStatusWithManager
, fetchRemote
, stack
, cache
, Depends(..)
, graph
, remote
, toHeaders
, substitutions
, normalizer
, startingContext
, chainImport
, dependencyToFile
, ImportSemantics
, HTTPHeader
, Cycle(..)
, ReferentiallyOpaque(..)
, Imported(..)
, ImportResolutionDisabled(..)
, PrettyHttpException(..)
, MissingFile(..)
, MissingEnvironmentVariable(..)
, MissingImports(..)
, HashMismatch(..)
) where
import Control.Applicative (Alternative (..))
import Control.Exception
( Exception
, IOException
, SomeException
, toException
)
import Control.Monad.Catch (MonadCatch (catch), handle, throwM)
import Control.Monad.IO.Class (MonadIO (..))
import Control.Monad.Morph (hoist)
import Control.Monad.State.Strict (MonadState, StateT)
import Data.ByteString (ByteString)
import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
import Data.Maybe (fromMaybe)
import Data.Text (Text)
import Data.Typeable (Typeable)
import Data.Void (Void, absurd)
import Dhall.TypeCheck (TypeError)
import Dhall.Syntax
( Chunks (..)
, Directory (..)
, Expr (..)
, File (..)
, FilePrefix (..)
, Import (..)
, ImportHashed (..)
, ImportMode (..)
, ImportType (..)
, URL (..)
, bindingExprs
, functionBindingExprs
, recordFieldExprs
)
import System.FilePath ((</>))
import Text.Megaparsec (SourcePos (SourcePos), mkPos)
#ifdef WITH_HTTP
import Dhall.Import.HTTP
#endif
import Dhall.Import.Headers
( normalizeHeaders
, originHeadersTypeExpr
, toHeaders
, toOriginHeaders
)
import Dhall.Import.Types
import Dhall.Parser
( ParseError (..)
, Parser (..)
, SourcedException (..)
, Src (..)
)
import Lens.Family.State.Strict (zoom)
import qualified Codec.CBOR.Write as Write
import qualified Codec.Serialise
import qualified Control.Exception as Exception
import qualified Control.Monad.State.Strict as State
import qualified Control.Monad.Trans.Maybe as Maybe
import qualified Data.ByteString
import qualified Data.ByteString.Lazy
import qualified Data.List.NonEmpty as NonEmpty
import qualified Data.Maybe as Maybe
import qualified Data.Text as Text
import qualified Data.Text.IO
import qualified Dhall.Binary
import qualified Dhall.Core as Core
import qualified Dhall.Crypto
import qualified Dhall.Map
import qualified Dhall.Parser
import qualified Dhall.Pretty.Internal
import qualified Dhall.Substitution
import qualified Dhall.Syntax as Syntax
import qualified Dhall.TypeCheck
import qualified System.AtomicWrite.Writer.ByteString.Binary as AtomicWrite.Binary
import qualified System.Directory as Directory
import qualified System.Environment
import qualified System.FilePath as FilePath
import qualified System.IO
import qualified System.Info
import qualified Text.Megaparsec
import qualified Text.Parser.Combinators
import qualified Text.Parser.Token
{- $setup
>>> import Dhall.Syntax
-}
-- | An import failed because of a cycle in the import graph
newtype Cycle = Cycle
{ cyclicImport :: Import -- ^ The offending cyclic import
}
deriving (Typeable)
instance Exception Cycle
instance Show Cycle where
show (Cycle import_) =
"\nCyclic import: " ++ Dhall.Pretty.Internal.prettyToString import_
{-| Dhall tries to ensure that all expressions hosted on network endpoints are
weakly referentially transparent, meaning roughly that any two clients will
compile the exact same result given the same URL.
To be precise, a strong interpretaton of referential transparency means that
if you compiled a URL you could replace the expression hosted at that URL
with the compiled result. Let's call this \"static linking\". Dhall (very
intentionally) does not satisfy this stronger interpretation of referential
transparency since \"statically linking\" an expression (i.e. permanently
resolving all imports) means that the expression will no longer update if
its dependencies change.
In general, either interpretation of referential transparency is not
enforceable in a networked context since one can easily violate referential
transparency with a custom DNS, but Dhall can still try to guard against
common unintentional violations. To do this, Dhall enforces that a
non-local import may not reference a local import.
Local imports are defined as:
* A file
* A URL with a host of @localhost@ or @127.0.0.1@
All other imports are defined to be non-local
-}
newtype ReferentiallyOpaque = ReferentiallyOpaque
{ opaqueImport :: Import -- ^ The offending opaque import
} deriving (Typeable)
instance Exception ReferentiallyOpaque
instance Show ReferentiallyOpaque where
show (ReferentiallyOpaque import_) =
"\nLocal imports are not permitted from remote imports: " ++ Dhall.Pretty.Internal.prettyToString import_
-- | Extend another exception with the current import stack
data Imported e = Imported
{ importStack :: NonEmpty Chained -- ^ Imports resolved so far, in reverse order
, nested :: e -- ^ The nested exception
} deriving (Typeable)
instance Exception e => Exception (Imported e)
instance Show e => Show (Imported e) where
show (Imported canonicalizedImports e) =
concat (zipWith indent [0..] toDisplay)
++ "\n"
++ show e
where
indent n import_ =
"\n" ++ replicate (2 * n) ' ' ++ "↳ " ++ Dhall.Pretty.Internal.prettyToString import_
canonical = NonEmpty.toList canonicalizedImports
-- Tthe final (outermost) import is fake to establish the base
-- directory. Also, we need outermost-first.
toDisplay = drop 1 (reverse canonical)
-- | Exception thrown when an imported file is missing
newtype MissingFile = MissingFile FilePath
deriving (Typeable)
instance Exception MissingFile
instance Show MissingFile where
show (MissingFile path) =
"\n"
<> "\ESC[1;31mError\ESC[0m: Missing file "
<> path
-- | Exception thrown when an environment variable is missing
newtype MissingEnvironmentVariable = MissingEnvironmentVariable { name :: Text }
deriving (Typeable)
instance Exception MissingEnvironmentVariable
instance Show MissingEnvironmentVariable where
show MissingEnvironmentVariable{..} =
"\n"
<> "\ESC[1;31mError\ESC[0m: Missing environment variable\n"
<> "\n"
<> "↳ " <> Text.unpack name
-- | List of Exceptions we encounter while resolving Import Alternatives
newtype MissingImports = MissingImports [SomeException]
instance Exception MissingImports
instance Show MissingImports where
show (MissingImports []) =
"\n"
<> "\ESC[1;31mError\ESC[0m: No valid imports"
show (MissingImports [e]) = show e
show (MissingImports es) =
"\n"
<> "\ESC[1;31mError\ESC[0m: Failed to resolve imports. Error list:"
<> "\n"
<> concatMap (\e -> "\n" <> show e <> "\n") es
throwMissingImport :: (MonadCatch m, Exception e) => e -> m a
throwMissingImport e = throwM (MissingImports [toException e])
-- | Exception thrown when a HTTP url is imported but dhall was built without
-- the @with-http@ Cabal flag.
data CannotImportHTTPURL =
CannotImportHTTPURL
String
(Maybe [HTTPHeader])
deriving (Typeable)
instance Exception CannotImportHTTPURL
instance Show CannotImportHTTPURL where
show (CannotImportHTTPURL url _mheaders) =
"\n"
<> "\ESC[1;31mError\ESC[0m: Cannot import HTTP URL.\n"
<> "\n"
<> "Dhall was compiled without the 'with-http' flag.\n"
<> "\n"
<> "The requested URL was: "
<> url
<> "\n"
{-|
> canonicalize . canonicalize = canonicalize
> canonicalize (a <> b) = canonicalize (canonicalize a <> canonicalize b)
-}
class Semigroup path => Canonicalize path where
canonicalize :: path -> path
-- |
-- >>> canonicalize (Directory {components = ["..",".."]})
-- Directory {components = ["..",".."]}
instance Canonicalize Directory where
canonicalize (Directory []) = Directory []
canonicalize (Directory ("." : components₀)) =
canonicalize (Directory components₀)
canonicalize (Directory (".." : components₀)) =
case canonicalize (Directory components₀) of
Directory [] ->
Directory [ ".." ]
Directory (".." : components₁) ->
Directory (".." : ".." : components₁)
Directory (_ : components₁) ->
Directory components₁
canonicalize (Directory (component : components₀)) =
Directory (component : components₁)
where
Directory components₁ = canonicalize (Directory components₀)
instance Canonicalize File where
canonicalize (File { directory, .. }) =
File { directory = canonicalize directory, .. }
instance Canonicalize ImportType where
canonicalize (Local prefix file) =
Local prefix (canonicalize file)
canonicalize (Remote (URL {..})) =
Remote (URL { path = canonicalize path, headers = fmap (fmap canonicalize) headers, ..})
canonicalize (Env name) =
Env name
canonicalize Missing =
Missing
instance Canonicalize ImportHashed where
canonicalize (ImportHashed hash importType) =
ImportHashed hash (canonicalize importType)
instance Canonicalize Import where
canonicalize (Import importHashed importMode) =
Import (canonicalize importHashed) importMode
-- | Exception thrown when an integrity check fails
data HashMismatch = HashMismatch
{ expectedHash :: Dhall.Crypto.SHA256Digest
, actualHash :: Dhall.Crypto.SHA256Digest
} deriving (Typeable)
instance Exception HashMismatch
instance Show HashMismatch where
show HashMismatch{..} =
"\n"
<> "\ESC[1;31mError\ESC[0m: " <> makeHashMismatchMessage expectedHash actualHash
makeHashMismatchMessage :: Dhall.Crypto.SHA256Digest -> Dhall.Crypto.SHA256Digest -> String
makeHashMismatchMessage expectedHash actualHash =
"Import integrity check failed\n"
<> "\n"
<> "Expected hash:\n"
<> "\n"
<> "↳ " <> show expectedHash <> "\n"
<> "\n"
<> "Actual hash:\n"
<> "\n"
<> "↳ " <> show actualHash <> "\n"
-- | Construct the file path corresponding to a local import. If the import is
-- _relative_ then the resulting path is also relative.
localToPath :: MonadIO io => FilePrefix -> File -> io FilePath
localToPath prefix file_ = liftIO $ do
let File {..} = file_
let Directory {..} = directory
prefixPath <- case prefix of
Home ->
Directory.getHomeDirectory
Absolute ->
return "/"
Parent ->
return ".."
Here ->
return "."
let cs = map Text.unpack (file : components)
let cons component dir = dir </> component
return (foldr cons prefixPath cs)
-- | Given a `Local` import construct the corresponding unhashed `Chained`
-- import (interpreting relative path as relative to the current directory).
chainedFromLocalHere :: FilePrefix -> File -> ImportMode -> Chained
chainedFromLocalHere prefix file mode = Chained $
Import (ImportHashed Nothing (Local prefix (canonicalize file))) mode
-- | Adjust the import mode of a chained import
chainedChangeMode :: ImportMode -> Chained -> Chained
chainedChangeMode mode (Chained (Import importHashed _)) =
Chained (Import importHashed mode)
-- | Chain imports, also typecheck and normalize headers if applicable.
chainImport :: Chained -> Import -> StateT Status IO Chained
chainImport (Chained parent) child@(Import importHashed@(ImportHashed _ (Remote url)) _) = do
url' <- normalizeHeadersIn url
let child' = child { importHashed = importHashed { importType = Remote url' } }
return (Chained (canonicalize (parent <> child')))
chainImport (Chained parent) child =
return (Chained (canonicalize (parent <> child)))
-- | Load an import, resulting in a fully resolved, type-checked and normalised
-- expression. @loadImport@ handles the \"hot\" cache in @Status@ and defers
-- to @loadImportWithSemanticCache@ for imports that aren't in the @Status@
-- cache already.
loadImport :: Chained -> StateT Status IO ImportSemantics
loadImport import_ = do
Status {..} <- State.get
case Dhall.Map.lookup import_ _cache of
Just importSemantics -> return importSemantics
Nothing -> do
importSemantics <- loadImportWithSemanticCache import_
zoom cache (State.modify (Dhall.Map.insert import_ importSemantics))
return importSemantics
-- | Load an import from the 'semantic cache'. Defers to
-- @loadImportWithSemisemanticCache@ for imports that aren't frozen (and
-- therefore not cached semantically), as well as those that aren't cached yet.
loadImportWithSemanticCache :: Chained -> StateT Status IO ImportSemantics
loadImportWithSemanticCache
import_@(Chained (Import (ImportHashed Nothing _) _)) =
loadImportWithSemisemanticCache import_
loadImportWithSemanticCache
import_@(Chained (Import _ Location)) =
loadImportWithSemisemanticCache import_
loadImportWithSemanticCache
import_@(Chained (Import (ImportHashed (Just semanticHash) _) _)) = do
Status { .. } <- State.get
mCached <-
case _semanticCacheMode of
UseSemanticCache ->
zoom cacheWarning (fetchFromSemanticCache semanticHash)
IgnoreSemanticCache ->
pure Nothing
case mCached of
Just bytesStrict -> do
let actualHash = Dhall.Crypto.sha256Hash bytesStrict
if semanticHash == actualHash
then do
let bytesLazy = Data.ByteString.Lazy.fromStrict bytesStrict
importSemantics <- case Dhall.Binary.decodeExpression bytesLazy of
Left err -> throwMissingImport (Imported _stack err)
Right e -> return e
return (ImportSemantics {..})
else do
printWarning $
makeHashMismatchMessage semanticHash actualHash
<> "\n"
<> "The interpreter will attempt to fix the cached import\n"
fetch
Nothing -> fetch
where
fetch = do
ImportSemantics{ importSemantics } <- loadImportWithSemisemanticCache import_
let bytes = encodeExpression (Core.alphaNormalize importSemantics)
let actualHash = Dhall.Crypto.sha256Hash bytes
let expectedHash = semanticHash
if actualHash == expectedHash
then do
zoom cacheWarning (writeToSemanticCache semanticHash bytes)
else do
Status{ _stack } <- State.get
throwMissingImport (Imported _stack HashMismatch{..})
return ImportSemantics{..}
-- Fetch encoded normal form from "semantic cache"
fetchFromSemanticCache
:: (MonadState CacheWarning m, MonadCatch m, MonadIO m)
=> Dhall.Crypto.SHA256Digest
-> m (Maybe Data.ByteString.ByteString)
fetchFromSemanticCache expectedHash = Maybe.runMaybeT $ do
cacheFile <- getCacheFile "dhall" expectedHash
True <- liftIO (Directory.doesFileExist cacheFile)
liftIO (Data.ByteString.readFile cacheFile)
-- | Ensure that the given expression is present in the semantic cache. The
-- given expression should be alpha-beta-normal.
writeExpressionToSemanticCache :: Expr Void Void -> IO ()
writeExpressionToSemanticCache expression =
-- Defaulting to not displaying the warning is for backwards compatibility
-- with the old behavior
State.evalStateT (writeToSemanticCache hash bytes) CacheWarned
where
bytes = encodeExpression expression
hash = Dhall.Crypto.sha256Hash bytes
writeToSemanticCache
:: (MonadState CacheWarning m, MonadCatch m, MonadIO m)
=> Dhall.Crypto.SHA256Digest
-> Data.ByteString.ByteString
-> m ()
writeToSemanticCache hash bytes = do
_ <- Maybe.runMaybeT $ do
cacheFile <- getCacheFile "dhall" hash
liftIO (AtomicWrite.Binary.atomicWriteFile cacheFile bytes)
return ()
-- Check the "semi-semantic" disk cache, otherwise typecheck and normalise from
-- scratch.
loadImportWithSemisemanticCache
:: Chained -> StateT Status IO ImportSemantics
loadImportWithSemisemanticCache (Chained (Import (ImportHashed _ importType) Code)) = do
text <- fetchFresh importType
Status {..} <- State.get
path <- case importType of
Local prefix file -> liftIO $ do
path <- localToPath prefix file
absolutePath <- Directory.makeAbsolute path
return absolutePath
Remote url -> do
let urlText = Core.pretty (url { headers = Nothing })
return (Text.unpack urlText)
Env env -> return $ Text.unpack env
Missing -> throwM (MissingImports [])
let parser = unParser $ do
Text.Parser.Token.whiteSpace
r <- Dhall.Parser.expr
Text.Parser.Combinators.eof
return r
parsedImport <- case Text.Megaparsec.parse parser path text of
Left errInfo ->
throwMissingImport (Imported _stack (ParseError errInfo text))
Right expr -> return expr
resolvedExpr <- loadWith parsedImport -- we load imports recursively here
-- Check the semi-semantic cache. See
-- https://github.com/dhall-lang/dhall-haskell/issues/1098 for the reasoning
-- behind semi-semantic caching.
let semisemanticHash = computeSemisemanticHash (Core.denote resolvedExpr)
mCached <- zoom cacheWarning (fetchFromSemisemanticCache semisemanticHash)
importSemantics <- case mCached of
Just bytesStrict -> do
let bytesLazy = Data.ByteString.Lazy.fromStrict bytesStrict
importSemantics <- case Dhall.Binary.decodeExpression bytesLazy of
Left err -> throwMissingImport (Imported _stack err)
Right sem -> return sem
return importSemantics
Nothing -> do
let substitutedExpr =
Dhall.Substitution.substitute resolvedExpr _substitutions
case Core.shallowDenote parsedImport of
-- If this import trivially wraps another import, we can skip
-- the type-checking and normalization step as the transitive
-- import was already type-checked and normalized
Embed _ ->
return (Core.denote substitutedExpr)
_ -> do
case Dhall.TypeCheck.typeWith _startingContext substitutedExpr of
Left err -> throwMissingImport (Imported _stack err)
Right _ -> return ()
let betaNormal =
Core.normalizeWith _normalizer substitutedExpr
let bytes = encodeExpression betaNormal
zoom cacheWarning (writeToSemisemanticCache semisemanticHash bytes)
return betaNormal
return (ImportSemantics {..})
-- `as Text` imports aren't cached since they are well-typed and normal by
-- construction
loadImportWithSemisemanticCache (Chained (Import (ImportHashed _ importType) RawText)) = do
text <- fetchFresh importType
-- importSemantics is alpha-beta-normal by construction!
let importSemantics = TextLit (Chunks [] text)
return (ImportSemantics {..})
-- `as Location` imports aren't cached since they are well-typed and normal by
-- construction
loadImportWithSemisemanticCache (Chained (Import (ImportHashed _ importType) Location)) = do
let locationType = Union $ Dhall.Map.fromList
[ ("Environment", Just Text)
, ("Remote", Just Text)
, ("Local", Just Text)
, ("Missing", Nothing)
]
-- importSemantics is alpha-beta-normal by construction!
let importSemantics = case importType of
Missing -> Field locationType $ Core.makeFieldSelection "Missing"
local@(Local _ _) ->
App (Field locationType $ Core.makeFieldSelection "Local")
(TextLit (Chunks [] (Core.pretty local)))
remote_@(Remote _) ->
App (Field locationType $ Core.makeFieldSelection "Remote")
(TextLit (Chunks [] (Core.pretty remote_)))
Env env ->
App (Field locationType $ Core.makeFieldSelection "Environment")
(TextLit (Chunks [] (Core.pretty env)))
return (ImportSemantics {..})
-- The semi-semantic hash of an expression is computed from the fully resolved
-- AST (without normalising or type-checking it first). See
-- https://github.com/dhall-lang/dhall-haskell/issues/1098 for further
-- discussion.
computeSemisemanticHash :: Expr Void Void -> Dhall.Crypto.SHA256Digest
computeSemisemanticHash resolvedExpr = hashExpression resolvedExpr
-- Fetch encoded normal form from "semi-semantic cache"
fetchFromSemisemanticCache
:: (MonadState CacheWarning m, MonadCatch m, MonadIO m)
=> Dhall.Crypto.SHA256Digest
-> m (Maybe Data.ByteString.ByteString)
fetchFromSemisemanticCache semisemanticHash = Maybe.runMaybeT $ do
cacheFile <- getCacheFile "dhall-haskell" semisemanticHash
True <- liftIO (Directory.doesFileExist cacheFile)
liftIO (Data.ByteString.readFile cacheFile)
writeToSemisemanticCache
:: (MonadState CacheWarning m, MonadCatch m, MonadIO m)
=> Dhall.Crypto.SHA256Digest
-> Data.ByteString.ByteString
-> m ()
writeToSemisemanticCache semisemanticHash bytes = do
_ <- Maybe.runMaybeT $ do
cacheFile <- getCacheFile "dhall-haskell" semisemanticHash
liftIO (AtomicWrite.Binary.atomicWriteFile cacheFile bytes)
return ()
-- Fetch source code directly from disk/network
fetchFresh :: ImportType -> StateT Status IO Text
fetchFresh (Local prefix file) = do
Status { _stack } <- State.get
path <- liftIO $ localToPath prefix file
exists <- liftIO $ Directory.doesFileExist path
if exists
then liftIO $ Data.Text.IO.readFile path
else throwMissingImport (Imported _stack (MissingFile path))
fetchFresh (Remote url) = do
Status { _remote } <- State.get
_remote url
fetchFresh (Env env) = do
Status { _stack } <- State.get
x <- liftIO $ System.Environment.lookupEnv (Text.unpack env)
case x of
Just string ->
return (Text.pack string)
Nothing ->
throwMissingImport (Imported _stack (MissingEnvironmentVariable env))
fetchFresh Missing = throwM (MissingImports [])
-- | Fetch the text contents of a URL
fetchRemote :: URL -> StateT Status IO Data.Text.Text
#ifndef WITH_HTTP
fetchRemote (url@URL { headers = maybeHeadersExpression }) = do
let maybeHeaders = fmap toHeaders maybeHeadersExpression
let urlString = Text.unpack (Core.pretty url)
Status { _stack } <- State.get
throwMissingImport (Imported _stack (CannotImportHTTPURL urlString maybeHeaders))
#else
fetchRemote url = do
zoom remote (State.put fetchFromHTTP)
fetchFromHTTP url
where
fetchFromHTTP :: URL -> StateT Status IO Data.Text.Text
fetchFromHTTP (url'@URL { headers = maybeHeadersExpression }) = do
let maybeHeaders = fmap toHeaders maybeHeadersExpression
fetchFromHttpUrl url' maybeHeaders
#endif
getCacheFile
:: (MonadCatch m, Alternative m, MonadState CacheWarning m, MonadIO m)
=> FilePath -> Dhall.Crypto.SHA256Digest -> m FilePath
getCacheFile cacheName hash = do
cacheDirectory <- getOrCreateCacheDirectory cacheName
let cacheFile = cacheDirectory </> ("1220" <> show hash)
return cacheFile
getOrCreateCacheDirectory
:: (MonadCatch m, Alternative m, MonadState CacheWarning m, MonadIO m)
=> FilePath -> m FilePath
getOrCreateCacheDirectory cacheName = do
let warn message = do
cacheWarningStatus <- State.get
case cacheWarningStatus of
CacheWarned -> printWarning message
CacheNotWarned -> return ()
State.put CacheWarned
empty
let handler action dir (ioex :: IOException) = do
let ioExMsg =
"When trying to " <> action <> ":\n"
<> "\n"
<> "↳ " <> dir <> "\n"
<> "\n"
<> "... the following exception was thrown:\n"
<> "\n"
<> "↳ " <> show ioex <> "\n"
warn ioExMsg
let setPermissions dir = do
let private = transform Directory.emptyPermissions
where
transform =
Directory.setOwnerReadable True
. Directory.setOwnerWritable True
. Directory.setOwnerSearchable True
catch
(liftIO (Directory.setPermissions dir private))
(handler "correct the permissions for" dir)
let assertPermissions dir = do
let accessible path =
Directory.readable path
&& Directory.writable path
&& Directory.searchable path
permissions <-
catch (liftIO (Directory.getPermissions dir))
(handler "get permissions of" dir)
if accessible permissions
then
return ()
else do
let render f = if f permissions then "✓" else "✗"
let message =
"The directory:\n"
<> "\n"
<> "↳ " <> dir <> "\n"
<> "\n"
<> "... does not give you permission to read, write, or search files.\n\n"
<> "\n"
<> "The directory's current permissions are:\n"
<> "\n"
<> "• " <> render Directory.readable <> " readable\n"
<> "• " <> render Directory.writable <> " writable\n"
<> "• " <> render Directory.searchable <> " searchable\n"
warn message
let existsDirectory dir =
catch (liftIO (Directory.doesDirectoryExist dir))
(handler "check the existence of" dir)
let existsFile path =
catch (liftIO (Directory.doesFileExist path))
(handler "check the existence of" path)
let createDirectory dir =
catch (liftIO (Directory.createDirectory dir))
(handler "create" dir)
let assertDirectory dir = do
existsDir <- existsDirectory dir
if existsDir
then
assertPermissions dir
else do
existsFile' <- existsFile dir
if existsFile'
then do
let message =
"The given path:\n"
<> "\n"
<> "↳ " <> dir <> "\n"
<> "\n"
<> "... already exists but is not a directory.\n"
warn message
else do
assertDirectory (FilePath.takeDirectory dir)
createDirectory dir
setPermissions dir
cacheBaseDirectory <- getCacheBaseDirectory
let directory = cacheBaseDirectory </> cacheName
let message =
"Could not get or create the default cache directory:\n"
<> "\n"
<> "↳ " <> directory <> "\n"
<> "\n"
<> "You can enable caching by creating it if needed and setting read,\n"
<> "write and search permissions on it or providing another cache base\n"
<> "directory by setting the $XDG_CACHE_HOME environment variable.\n"
<> "\n"
assertDirectory directory <|> warn message
return directory
getCacheBaseDirectory
:: (MonadState CacheWarning m, Alternative m, MonadIO m) => m FilePath
getCacheBaseDirectory = alternative₀ <|> alternative₁ <|> alternative₂
where
alternative₀ = do
maybeXDGCacheHome <-
liftIO (System.Environment.lookupEnv "XDG_CACHE_HOME")
case maybeXDGCacheHome of
Just xdgCacheHome -> return xdgCacheHome
Nothing -> empty
alternative₁
| isWindows = do
maybeLocalAppDirectory <-
liftIO (System.Environment.lookupEnv "LOCALAPPDATA")
case maybeLocalAppDirectory of
Just localAppDirectory -> return localAppDirectory
Nothing -> empty
| otherwise = do
maybeHomeDirectory <-
liftIO (System.Environment.lookupEnv "HOME")
case maybeHomeDirectory of
Just homeDirectory -> return (homeDirectory </> ".cache")
Nothing -> empty
where isWindows = System.Info.os == "mingw32"
alternative₂ = do
cacheWarningStatus <- State.get
let message =
"\n"
<> "\ESC[1;33mWarning\ESC[0m: "
<> "Could not locate a cache base directory from the environment.\n"
<> "\n"
<> "You can provide a cache base directory by pointing the $XDG_CACHE_HOME\n"
<> "environment variable to a directory with read and write permissions.\n"
case cacheWarningStatus of
CacheNotWarned ->
liftIO (System.IO.hPutStrLn System.IO.stderr message)
CacheWarned ->
return ()
State.put CacheWarned
empty
-- If the URL contains headers typecheck them and replace them with their normal
-- forms.
normalizeHeadersIn :: URL -> StateT Status IO URL
normalizeHeadersIn url@URL { headers = Just headersExpression } = do
Status { _stack } <- State.get
loadedExpr <- loadWith headersExpression
let handler (e :: SomeException) = throwMissingImport (Imported _stack e)
normalized <- liftIO $ handle handler (normalizeHeaders loadedExpr)
return url { headers = Just (fmap absurd normalized) }
normalizeHeadersIn url = return url
-- | Empty origin headers used for remote contexts
-- (and fallback when nothing is set in env or config file)
emptyOriginHeaders :: Expr Src Import
emptyOriginHeaders = ListLit (Just (fmap absurd originHeadersTypeExpr)) mempty
-- | A fake Src to annotate headers expressions with.
-- We need to wrap headers expressions in a Note for nice error reporting,
-- and because ImportAlt handling only catches SourcedExceptions
headersSrc :: Src
headersSrc = Src {
srcStart = SourcePos {
sourceName = fakeSrcName,
sourceLine = mkPos 1,
sourceColumn = mkPos 1
},
srcEnd = SourcePos {
sourceName = fakeSrcName,
sourceLine = mkPos 1,
sourceColumn = mkPos (Text.length fakeSrcText)
},
srcText = fakeSrcText
}
where
fakeSrcText = "«Origin Header Configuration»"
fakeSrcName = "[builtin]"
-- | Load headers only from the environment (used in tests)
envOriginHeaders :: Expr Src Import
envOriginHeaders = Note headersSrc (Embed (Import (ImportHashed Nothing (Env "DHALL_HEADERS")) Code))
-- | Load headers in env, falling back to config file
defaultOriginHeaders :: IO (Expr Src Import)
#ifndef WITH_HTTP
defaultOriginHeaders = return emptyOriginHeaders
#else
defaultOriginHeaders = do
fromFile <- originHeadersFileExpr
return (Note headersSrc (ImportAlt envOriginHeaders (Note headersSrc fromFile)))
#endif
-- | Given a headers expression, return an origin headers loader
originHeadersLoader :: IO (Expr Src Import) -> StateT Status IO OriginHeaders
originHeadersLoader headersExpr = do
-- Load the headers using the parent stack, which should always be a local
-- import (we only load headers for the first remote import)
status <- State.get
let parentStack = fromMaybe abortEmptyStack (nonEmpty (NonEmpty.tail (_stack status)))
let headerLoadStatus = status { _stack = parentStack }
(headers, _) <- liftIO (State.runStateT doLoad headerLoadStatus)
-- return cached headers next time
_ <- State.modify (\state -> state { _loadOriginHeaders = return headers })
return headers
where
abortEmptyStack = Core.internalError "Origin headers loaded with an empty stack"
doLoad = do
partialExpr <- liftIO headersExpr
loaded <- loadWith (Note headersSrc (ImportAlt partialExpr emptyOriginHeaders))
liftIO (toOriginHeaders loaded)
-- | Default starting `Status`, importing relative to the given directory.
emptyStatus :: FilePath -> Status
emptyStatus = makeEmptyStatus defaultNewManager defaultOriginHeaders
-- | See 'emptyStatus'
emptyStatusWithManager
:: IO Manager
-> FilePath
-> Status
emptyStatusWithManager newManager = makeEmptyStatus newManager defaultOriginHeaders
-- | See 'emptyStatus'.
makeEmptyStatus
:: IO Manager
-> IO (Expr Src Import)
-> FilePath
-> Status
makeEmptyStatus newManager headersExpr rootDirectory =
emptyStatusWith newManager (originHeadersLoader headersExpr) fetchRemote rootImport
where
prefix = if FilePath.isRelative rootDirectory
then Here
else Absolute
pathComponents =
fmap Text.pack (reverse (FilePath.splitDirectories rootDirectory))
directoryAsFile = File (Directory pathComponents) "."
rootImport = Import
{ importHashed = ImportHashed
{ hash = Nothing
, importType = Local prefix directoryAsFile
}
, importMode = Code
}
{-| Default `Status` appropriate for a server interpreting Dhall code
Using this `Status` ensures that interpreted Dhall code cannot access
server-local resources (like files or environment variables)
-}
remoteStatus
:: URL
-- ^ Public address of the server
-> Status
remoteStatus = remoteStatusWithManager defaultNewManager
-- | See `remoteStatus`
remoteStatusWithManager :: IO Manager -> URL -> Status
remoteStatusWithManager newManager url =
emptyStatusWith newManager (originHeadersLoader (pure emptyOriginHeaders)) fetchRemote rootImport
where
rootImport = Import
{ importHashed = ImportHashed
{ hash = Nothing
, importType = Remote url
}
, importMode = Code
}
{-| Generalized version of `load`
You can configure the desired behavior through the initial `Status` that you
supply
-}
loadWith :: Expr Src Import -> StateT Status IO (Expr Src Void)
loadWith expr₀ = case expr₀ of
Embed import₀ -> do
Status {..} <- State.get
let parent = NonEmpty.head _stack
child <- chainImport parent import₀
let local (Chained (Import (ImportHashed _ (Remote {})) _)) = False
local (Chained (Import (ImportHashed _ (Local {})) _)) = True
local (Chained (Import (ImportHashed _ (Env {})) _)) = True
local (Chained (Import (ImportHashed _ (Missing {})) _)) = False
let referentiallySane = not (local child) || local parent
if importMode import₀ == Location || referentiallySane
then return ()
else throwMissingImport (Imported _stack (ReferentiallyOpaque import₀))
let _stack' = NonEmpty.cons child _stack
if child `elem` _stack
then throwMissingImport (Imported _stack (Cycle import₀))
else return ()
zoom graph . State.modify $
-- Add the edge `parent -> child` to the import graph
\edges -> Depends parent child : edges
let stackWithChild = NonEmpty.cons child _stack
zoom stack (State.put stackWithChild)
ImportSemantics {..} <- loadImport child
zoom stack (State.put _stack)
return (Core.renote importSemantics)
ImportAlt a b -> loadWith a `catch` handler₀
where
is :: forall e . Exception e => SomeException -> Bool
is exception = Maybe.isJust (Exception.fromException @e exception)
isNotResolutionError exception =
is @(Imported (TypeError Src Void)) exception
|| is @(Imported Cycle ) exception
|| is @(Imported HashMismatch ) exception
|| is @(Imported ParseError ) exception
handler₀ exception₀@(SourcedException (Src begin _ text₀) (MissingImports es₀))
| any isNotResolutionError es₀ =
throwM exception₀
| otherwise = do
loadWith b `catch` handler₁
where
handler₁ exception₁@(SourcedException (Src _ end text₁) (MissingImports es₁))
| any isNotResolutionError es₁ =
throwM exception₁
| otherwise =
-- Fix the source span for the error message to encompass both
-- alternatives, since both are equally to blame for the
-- failure if neither succeeds.
throwM (SourcedException (Src begin end text₂) (MissingImports (es₀ ++ es₁)))
where
text₂ = text₀ <> " ? " <> text₁
Note a b -> do
let handler e = throwM (SourcedException a (e :: MissingImports))
(Note <$> pure a <*> loadWith b) `catch` handler
Let a b -> Let <$> bindingExprs loadWith a <*> loadWith b
Record m -> Record <$> traverse (recordFieldExprs loadWith) m
RecordLit m -> RecordLit <$> traverse (recordFieldExprs loadWith) m
Lam cs a b -> Lam cs <$> functionBindingExprs loadWith a <*> loadWith b
Field a b -> Field <$> loadWith a <*> pure b
expression -> Syntax.unsafeSubExpressions loadWith expression
-- | Resolve all imports within an expression
load :: Expr Src Import -> IO (Expr Src Void)
load = loadWithManager defaultNewManager
-- | See 'load'.
loadWithManager :: IO Manager -> Expr Src Import -> IO (Expr Src Void)
loadWithManager newManager =
loadWithStatus
(makeEmptyStatus newManager defaultOriginHeaders ".")
UseSemanticCache
printWarning :: (MonadIO m) => String -> m ()
printWarning message = do
let warning =
"\n"
<> "\ESC[1;33mWarning\ESC[0m: "
<> message
liftIO $ System.IO.hPutStrLn System.IO.stderr warning
-- | Resolve all imports within an expression, importing relative to the given
-- directory.
loadRelativeTo :: FilePath -> SemanticCacheMode -> Expr Src Import -> IO (Expr Src Void)
loadRelativeTo parentDirectory = loadWithStatus
(makeEmptyStatus defaultNewManager defaultOriginHeaders parentDirectory)
-- | See 'loadRelativeTo'.
loadWithStatus
:: Status
-> SemanticCacheMode
-> Expr Src Import
-> IO (Expr Src Void)
loadWithStatus status semanticCacheMode expression =
State.evalStateT
(loadWith expression)
status { _semanticCacheMode = semanticCacheMode }
encodeExpression :: Expr Void Void -> Data.ByteString.ByteString
encodeExpression expression = bytesStrict
where
intermediateExpression :: Expr Void Import
intermediateExpression = fmap absurd expression
encoding = Codec.Serialise.encode intermediateExpression
bytesStrict = Write.toStrictByteString encoding
-- | Hash a fully resolved expression
hashExpression :: Expr Void Void -> Dhall.Crypto.SHA256Digest
hashExpression = Dhall.Crypto.sha256Hash . encodeExpression
{-| Convenience utility to hash a fully resolved expression and return the
base-16 encoded hash with the @sha256:@ prefix
In other words, the output of this function can be pasted into Dhall
source code to add an integrity check to an import
-}
hashExpressionToCode :: Expr Void Void -> Text
hashExpressionToCode expr =
"sha256:" <> Text.pack (show (hashExpression expr))
-- | A call to `assertNoImports` failed because there was at least one import
data ImportResolutionDisabled = ImportResolutionDisabled deriving (Exception)
instance Show ImportResolutionDisabled where
show _ = "\nImport resolution is disabled"
-- | Assert than an expression is import-free
assertNoImports :: MonadIO io => Expr Src Import -> io (Expr Src Void)
assertNoImports expression =
Core.throws (traverse (\_ -> Left ImportResolutionDisabled) expression)
{-# INLINABLE assertNoImports #-}
{-| This function is used by the @--transitive@ option of the
@dhall {freeze,format,lint}@ subcommands to determine which dependencies
to descend into
#ifndef mingw32_HOST_OS
>>> dependencyToFile (emptyStatus ".") Import{ importHashed = ImportHashed{ hash = Nothing, importType = Local Here (File (Directory []) "foo") }, importMode = Code }
Just "./foo"
>>> dependencyToFile (emptyStatus "./foo") Import{ importHashed = ImportHashed{ hash = Nothing, importType = Local Here (File (Directory []) "bar") }, importMode = Code }
Just "./foo/bar"
>>> dependencyToFile (emptyStatus "./foo") Import{ importHashed = ImportHashed{ hash = Nothing, importType = Remote (URL HTTPS "example.com" (File (Directory []) "") Nothing Nothing) }, importMode = Code }
Nothing
>>> dependencyToFile (emptyStatus ".") Import{ importHashed = ImportHashed{ hash = Nothing, importType = Env "foo" }, importMode = Code }
Nothing
#endif
-}
dependencyToFile :: Status -> Import -> IO (Maybe FilePath)
dependencyToFile status import_ = flip State.evalStateT status $ do
parent :| _ <- zoom stack State.get
child <- fmap chainedImport (hoist liftIO (chainImport parent import_))
let ignore = return Nothing
-- We only need to transitively modify code imports since other import
-- types are not interpreted and therefore don't need to be modified
case importMode child of
RawText ->
ignore
Location ->
ignore
Code ->
case importType (importHashed child) of
Local filePrefix file -> do
let descend = liftIO $ do
path <- localToPath filePrefix file
return (Just path)
-- Only follow relative imports when modifying dependencies.
-- Carefully note that we check the file prefix of the
-- original import (before chaining), since the chained
-- import will inherit the file prefix of the parent import.
case importType (importHashed import_) of
Local Here _ -> descend
Local Parent _ -> descend
_ -> ignore
-- Don't transitively modify any other type of import
Remote{} ->
ignore
Missing ->
ignore
Env{} ->
ignore