Skip to content
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

to-directory-tree: Do not support setting file metadata on Windows #2507

Merged
merged 1 commit into from
Apr 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 48 additions & 2 deletions dhall/src/Dhall/DirectoryTree.hs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import Control.Exception (Exception)
import Control.Monad (unless, when)
import Data.Either.Validation (Validation (..))
import Data.Functor.Identity (Identity (..))
import Data.Maybe (fromMaybe)
import Data.Maybe (fromMaybe, isJust)
import Data.Sequence (Seq)
import Data.Text (Text)
import Data.Void (Void)
Expand All @@ -50,6 +50,7 @@ import qualified Dhall.Marshal.Decode as Decode
import qualified Dhall.Pretty
import qualified Dhall.TypeCheck as TypeCheck
import qualified Dhall.Util as Util
import qualified Prettyprinter as Pretty
import qualified Prettyprinter.Render.String as Pretty
import qualified System.Directory as Directory
import qualified System.FilePath as FilePath
Expand Down Expand Up @@ -274,6 +275,8 @@ getGroup (GroupName name) = Posix.groupID <$> Posix.getGroupEntryForName name
processFilesystemEntry :: Bool -> FilePath -> FilesystemEntry -> IO ()
processFilesystemEntry allowSeparators path (DirectoryEntry entry) = do
let path' = path </> entryName entry
when (hasMetadata entry && not isMetadataSupported) $
Exception.throwIO $ MetadataUnsupportedError path'
Directory.createDirectoryIfMissing allowSeparators path'
processFilesystemEntryList allowSeparators path' $ entryContent entry
-- It is important that we write the metadata after we wrote the content of
Expand All @@ -282,6 +285,8 @@ processFilesystemEntry allowSeparators path (DirectoryEntry entry) = do
applyMetadata entry path'
processFilesystemEntry _ path (FileEntry entry) = do
let path' = path </> entryName entry
when (hasMetadata entry && not isMetadataSupported) $
Exception.throwIO $ MetadataUnsupportedError path'
Text.IO.writeFile path' $ entryContent entry
-- It is important that we write the metadata after we wrote the content of
-- the file as we might lock ourself out by changing ownership or
Expand All @@ -293,6 +298,25 @@ processFilesystemEntryList :: Bool -> FilePath -> Seq FilesystemEntry -> IO ()
processFilesystemEntryList allowSeparators path = Foldable.traverse_
(processFilesystemEntry allowSeparators path)

-- | Does this entry have some metadata set?
hasMetadata :: Entry a -> Bool
hasMetadata entry
= isJust (entryUser entry)
|| isJust (entryGroup entry)
|| maybe False hasMode (entryMode entry)
where
hasMode :: Mode Maybe -> Bool
hasMode mode
= maybe False hasAccess (modeUser mode)
|| maybe False hasAccess (modeGroup mode)
|| maybe False hasAccess (modeOther mode)

hasAccess :: Access Maybe -> Bool
hasAccess access
= isJust (accessExecute access)
|| isJust (accessRead access)
|| isJust (accessWrite access)

-- | Set the metadata of an object referenced by a path.
applyMetadata :: Entry a -> FilePath -> IO ()
applyMetadata entry fp = do
Expand Down Expand Up @@ -378,6 +402,8 @@ hasFileMode mode x = (mode `Posix.intersectFileModes` x) == x
newtype FilesystemError =
FilesystemError { unexpectedExpression :: Expr Void Void }

instance Exception FilesystemError

instance Show FilesystemError where
show FilesystemError{..} =
Pretty.renderString (Dhall.Pretty.layout message)
Expand Down Expand Up @@ -436,4 +462,24 @@ instance Show FilesystemError where
\ \n\
\... which is not an expression that can be translated to a directory tree. \n"

instance Exception FilesystemError
{- | This error indicates that you want to set some metadata for a file or
directory, but that operation is not supported on your platform.
-}
newtype MetadataUnsupportedError =
MetadataUnsupportedError { metadataForPath :: FilePath }

instance Exception MetadataUnsupportedError

instance Show MetadataUnsupportedError where
show MetadataUnsupportedError{..} =
Pretty.renderString (Dhall.Pretty.layout message)
where
message =
Util._ERROR <> ": Setting metadata is not supported on this platform. \n\
\ \n\
\Explanation: Your Dhall expression indicates that you intend to set some metadata \n\
\like ownership or permissions for the following file or directory: \n\
\ \n\
\" <> Pretty.pretty metadataForPath <> "\n\
\ \n\
\... which is not supported on your platform. \n"
10 changes: 10 additions & 0 deletions dhall/src/Dhall/DirectoryTree/Types.hs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ module Dhall.DirectoryTree.Types

, setFileMode
, prettyFileMode

, isMetadataSupported
) where

import Data.Functor.Identity (Identity (..))
Expand Down Expand Up @@ -239,3 +241,11 @@ prettyFileMode mode = userPP <> groupPP <> otherPP
isBitSet c mask = if mask `Posix.intersectFileModes` mode /= Posix.nullFileMode
then [c]
else "-"

-- | Is setting metadata supported on this platform or not.
isMetadataSupported :: Bool
#ifdef mingw32_HOST_OS
isMetadataSupported = False
#else
isMetadataSupported = True
#endif
2 changes: 1 addition & 1 deletion dhall/tests/Dhall/Test/DirectoryTree.hs
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ tests = testGroup "to-directory-tree"
, fixpointedSimple
#ifndef mingw32_HOST_OS
, fixpointedPermissions
#endif
, fixpointedUserGroup
#endif
]
]

Expand Down