-----------------------------------------------------------------------------
-- |
-- Module      :  System.Directory.OsPath
-- Copyright   :  (c) The University of Glasgow 2001
-- License     :  BSD-style (see the file libraries/base/LICENSE)
--
-- Maintainer  :  libraries@haskell.org
-- Stability   :  stable
-- Portability :  portable
--
-- System-independent interface to directory manipulation.
--
-- @since 1.3.8.0
--
-----------------------------------------------------------------------------

module System.Directory.OsPath
   (
    -- $intro

    -- * Actions on directories
      createDirectory
    , createDirectoryIfMissing
    , removeDirectory
    , removeDirectoryRecursive
    , removePathForcibly
    , renameDirectory
    , listDirectory
    , getDirectoryContents
    -- ** Current working directory
    , getCurrentDirectory
    , setCurrentDirectory
    , withCurrentDirectory

    -- * Pre-defined directories
    , getHomeDirectory
    , XdgDirectory(..)
    , getXdgDirectory
    , XdgDirectoryList(..)
    , getXdgDirectoryList
    , getAppUserDataDirectory
    , getUserDocumentsDirectory
    , getTemporaryDirectory

    -- * PATH
    , getExecSearchPath

    -- * Actions on files
    , removeFile
    , renameFile
    , renamePath
    , copyFile
    , copyFileWithMetadata
    , getFileSize

    , canonicalizePath
    , makeAbsolute
    , makeRelativeToCurrentDirectory

    -- * Existence tests
    , doesPathExist
    , doesFileExist
    , doesDirectoryExist

    , findExecutable
    , findExecutables
    , findExecutablesInDirectories
    , findFile
    , findFiles
    , findFileWith
    , findFilesWith
    , exeExtension

    -- * Symbolic links
    , createFileLink
    , createDirectoryLink
    , removeDirectoryLink
    , pathIsSymbolicLink
    , getSymbolicLinkTarget

    -- * Permissions

    -- $permissions

    , Permissions
    , emptyPermissions
    , readable
    , writable
    , executable
    , searchable
    , setOwnerReadable
    , setOwnerWritable
    , setOwnerExecutable
    , setOwnerSearchable

    , getPermissions
    , setPermissions
    , copyPermissions

    -- * Timestamps

    , getAccessTime
    , getModificationTime
    , setAccessTime
    , setModificationTime

   ) where
import Prelude ()
import System.Directory.Internal
import System.Directory.Internal.Prelude
import qualified System.File.OsPath as OS
import System.OsPath
  ( (<.>)
  , (</>)
  , addTrailingPathSeparator
  , dropTrailingPathSeparator
  , hasTrailingPathSeparator
  , isAbsolute
  , joinPath
  , makeRelative
  , splitDirectories
  , splitSearchPath
  , takeDirectory
  , encodeWith
  )
import qualified Data.List.NonEmpty as NE
import Data.Time (UTCTime)
import Data.Time.Clock.POSIX (utcTimeToPOSIXSeconds)
import GHC.IO.Encoding.UTF8 ( mkUTF8 )
import GHC.IO.Encoding.UTF16 ( mkUTF16le )
import GHC.IO.Encoding.Failure ( CodingFailureMode(..) )

{- $intro
A directory contains a series of entries, each of which is a named
reference to a file system object (file, directory etc.).  Some
entries may be hidden, inaccessible, or have some administrative
function (e.g. @.@ or @..@ under
<http://www.opengroup.org/onlinepubs/009695399 POSIX>), but in
this standard all such entries are considered to form part of the
directory contents. Entries in sub-directories are not, however,
considered to form part of the directory contents.

Each file system object is referenced by a /path/.  There is
normally at least one absolute path to each file system object.  In
some operating systems, it may also be possible to have paths which
are relative to the current directory.

Unless otherwise documented:

* 'IO' operations in this package may throw any 'IOError'.  No other types of
  exceptions shall be thrown.

* The list of possible 'IOErrorType's in the API documentation is not
  exhaustive.  The full list may vary by platform and/or evolve over time.

-}

-----------------------------------------------------------------------------
-- Permissions

{- $permissions

directory offers a limited (and quirky) interface for reading and setting file
and directory permissions; see 'getPermissions' and 'setPermissions' for a
discussion of their limitations.  Because permissions are very difficult to
implement portably across different platforms, users who wish to do more
sophisticated things with permissions are advised to use other,
platform-specific libraries instead.  For example, if you are only interested
in permissions on POSIX-like platforms,
<https://hackage.haskell.org/package/unix/docs/System-Posix-Files.html unix>
offers much more flexibility.

 The 'Permissions' type is used to record whether certain operations are
 permissible on a file\/directory. 'getPermissions' and 'setPermissions'
 get and set these permissions, respectively. Permissions apply both to
 files and directories. For directories, the executable field will be
 'False', and for files the searchable field will be 'False'. Note that
 directories may be searchable without being readable, if permission has
 been given to use them as part of a path, but not to examine the
 directory contents.

Note that to change some, but not all permissions, a construct on the following lines must be used.

>  makeReadable f = do
>     p <- getPermissions f
>     setPermissions f (p {readable = True})

-}

emptyPermissions :: Permissions
emptyPermissions :: Permissions
emptyPermissions = Permissions {
                       readable :: Bool
readable   = Bool
False,
                       writable :: Bool
writable   = Bool
False,
                       executable :: Bool
executable = Bool
False,
                       searchable :: Bool
searchable = Bool
False
                   }

setOwnerReadable :: Bool -> Permissions -> Permissions
setOwnerReadable :: Bool -> Permissions -> Permissions
setOwnerReadable Bool
b Permissions
p = Permissions
p { readable = b }

setOwnerWritable :: Bool -> Permissions -> Permissions
setOwnerWritable :: Bool -> Permissions -> Permissions
setOwnerWritable Bool
b Permissions
p = Permissions
p { writable = b }

setOwnerExecutable :: Bool -> Permissions -> Permissions
setOwnerExecutable :: Bool -> Permissions -> Permissions
setOwnerExecutable Bool
b Permissions
p = Permissions
p { executable = b }

setOwnerSearchable :: Bool -> Permissions -> Permissions
setOwnerSearchable :: Bool -> Permissions -> Permissions
setOwnerSearchable Bool
b Permissions
p = Permissions
p { searchable = b }

-- | Get the permissions of a file or directory.
--
-- On Windows, the 'writable' permission corresponds to the "read-only"
-- attribute.  The 'executable' permission is set if the file extension is of
-- an executable file type.  The 'readable' permission is always set.
--
-- On POSIX systems, this returns the result of @access@.
--
-- The operation may fail with:
--
-- * 'isPermissionError' if the user is not permitted to access the
--   permissions, or
--
-- * 'isDoesNotExistError' if the file or directory does not exist.
getPermissions :: OsPath -> IO Permissions
getPermissions :: OsString -> IO Permissions
getPermissions OsString
path =
  (IOError -> String -> IOError
`ioeAddLocation` String
"getPermissions") (IOError -> IOError) -> IO Permissions -> IO Permissions
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> IO Permissions
getAccessPermissions (OsString -> OsString
emptyToCurDir OsString
path)

-- | Set the permissions of a file or directory.
--
-- On Windows, this is only capable of changing the 'writable' permission,
-- which corresponds to the "read-only" attribute.  Changing the other
-- permissions has no effect.
--
-- On POSIX systems, this sets the /owner/ permissions.
--
-- The operation may fail with:
--
-- * 'isPermissionError' if the user is not permitted to set the permissions,
--   or
--
-- * 'isDoesNotExistError' if the file or directory does not exist.
setPermissions :: OsPath -> Permissions -> IO ()
setPermissions :: OsString -> Permissions -> IO ()
setPermissions OsString
path Permissions
p =
  (IOError -> String -> IOError
`ioeAddLocation` String
"setPermissions") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> Permissions -> IO ()
setAccessPermissions (OsString -> OsString
emptyToCurDir OsString
path) Permissions
p

-- | Copy the permissions of one file to another.  This reproduces the
-- permissions more accurately than using 'getPermissions' followed by
-- 'setPermissions'.
--
-- On Windows, this copies only the read-only attribute.
--
-- On POSIX systems, this is equivalent to @stat@ followed by @chmod@.
copyPermissions :: OsPath -> OsPath -> IO ()
copyPermissions :: OsString -> OsString -> IO ()
copyPermissions OsString
src OsString
dst =
  (IOError -> String -> IOError
`ioeAddLocation` String
"copyPermissions") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    m <- OsString -> IO Metadata
getFileMetadata OsString
src
    copyPermissionsFromMetadata m dst

copyPermissionsFromMetadata :: Metadata -> OsPath -> IO ()
copyPermissionsFromMetadata :: Metadata -> OsString -> IO ()
copyPermissionsFromMetadata Metadata
m OsString
dst = do
  -- instead of setFileMode, setFilePermissions is used here
  -- this is to retain backward compatibility in copyPermissions
  OsString -> Mode -> IO ()
setFilePermissions OsString
dst (Metadata -> Mode
modeFromMetadata Metadata
m)

-----------------------------------------------------------------------------
-- Implementation

{- |@'createDirectory' dir@ creates a new directory @dir@ which is
initially empty, or as near to empty as the operating system
allows.

The operation may fail with:

* 'isPermissionError'
The process has insufficient privileges to perform the operation.
@[EROFS, EACCES]@

* 'isAlreadyExistsError'
The operand refers to a directory that already exists.
@ [EEXIST]@

* @HardwareFault@
A physical I\/O error has occurred.
@[EIO]@

* @InvalidArgument@
The operand is not a valid directory name.
@[ENAMETOOLONG, ELOOP]@

* 'isDoesNotExistError'
There is no path to the directory.
@[ENOENT, ENOTDIR]@

* 'System.IO.isFullError'
Insufficient resources (virtual memory, process file descriptors,
physical disk space, etc.) are available to perform the operation.
@[EDQUOT, ENOSPC, ENOMEM, EMLINK]@

* @InappropriateType@
The path refers to an existing non-directory object.
@[EEXIST]@

-}

createDirectory :: OsPath -> IO ()
createDirectory :: OsString -> IO ()
createDirectory = OsString -> IO ()
createDirectoryInternal

-- | @'createDirectoryIfMissing' parents dir@ creates a new directory
-- @dir@ if it doesn\'t exist. If the first argument is 'True'
-- the function will also create all parent directories if they are missing.
createDirectoryIfMissing :: Bool     -- ^ Create its parents too?
                         -> OsPath -- ^ The path to the directory you want to make
                         -> IO ()
createDirectoryIfMissing :: Bool -> OsString -> IO ()
createDirectoryIfMissing Bool
create_parents OsString
path0
  | Bool
create_parents = [OsString] -> IO ()
createDirs (OsString -> [OsString]
parents OsString
path0)
  | Bool
otherwise      = [OsString] -> IO ()
createDirs (Int -> [OsString] -> [OsString]
forall a. Int -> [a] -> [a]
take Int
1 (OsString -> [OsString]
parents OsString
path0))
  where
    parents :: OsString -> [OsString]
parents = [OsString] -> [OsString]
forall a. [a] -> [a]
reverse ([OsString] -> [OsString])
-> (OsString -> [OsString]) -> OsString -> [OsString]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (OsString -> OsString -> OsString) -> [OsString] -> [OsString]
forall a. (a -> a -> a) -> [a] -> [a]
scanl1 OsString -> OsString -> OsString
(</>) ([OsString] -> [OsString])
-> (OsString -> [OsString]) -> OsString -> [OsString]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. OsString -> [OsString]
splitDirectories (OsString -> [OsString])
-> (OsString -> OsString) -> OsString -> [OsString]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. OsString -> OsString
simplify

    createDirs :: [OsString] -> IO ()
createDirs []         = () -> IO ()
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure ()
    createDirs (OsString
dir:[])   = OsString -> (IOError -> IO ()) -> IO ()
createDir OsString
dir IOError -> IO ()
forall a. HasCallStack => IOError -> IO a
ioError
    createDirs (OsString
dir:[OsString]
dirs) =
      OsString -> (IOError -> IO ()) -> IO ()
createDir OsString
dir ((IOError -> IO ()) -> IO ()) -> (IOError -> IO ()) -> IO ()
forall a b. (a -> b) -> a -> b
$ \IOError
_ -> do
        [OsString] -> IO ()
createDirs [OsString]
dirs
        OsString -> (IOError -> IO ()) -> IO ()
createDir OsString
dir IOError -> IO ()
forall a. HasCallStack => IOError -> IO a
ioError

    createDir :: OsString -> (IOError -> IO ()) -> IO ()
createDir OsString
dir IOError -> IO ()
notExistHandler = do
      r <- IO () -> IO (Either IOError ())
forall a. IO a -> IO (Either IOError a)
tryIOError (OsString -> IO ()
createDirectory OsString
dir)
      case r of
        Right ()                   -> () -> IO ()
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure ()
        Left  IOError
e
          | IOError -> Bool
isDoesNotExistError  IOError
e -> IOError -> IO ()
notExistHandler IOError
e
          -- createDirectory (and indeed POSIX mkdir) does not distinguish
          -- between a dir already existing and a file already existing. So we
          -- check for it here. Unfortunately there is a slight race condition
          -- here, but we think it is benign. It could report an exception in
          -- the case that the dir did exist but another process deletes the
          -- directory and creates a file in its place before we can check
          -- that the directory did indeed exist.
          -- We also follow this path when we get a permissions error, as
          -- trying to create "." when in the root directory on Windows
          -- fails with
          --     CreateDirectory ".": permission denied (Access is denied.)
          -- This caused GHCi to crash when loading a module in the root
          -- directory.
          | IOError -> Bool
isAlreadyExistsError IOError
e
         Bool -> Bool -> Bool
|| IOError -> Bool
isPermissionError    IOError
e -> do
              canIgnore <- OsString -> IO Bool
pathIsDirectory OsString
dir
                             IO Bool -> (IOError -> IO Bool) -> IO Bool
forall a. IO a -> (IOError -> IO a) -> IO a
`catchIOError` \ IOError
_ ->
                               Bool -> IO Bool
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure (IOError -> Bool
isAlreadyExistsError IOError
e)
              unless canIgnore (ioError e)
          | Bool
otherwise              -> IOError -> IO ()
forall a. HasCallStack => IOError -> IO a
ioError IOError
e


{- | @'removeDirectory' dir@ removes an existing directory /dir/.  The
implementation may specify additional constraints which must be
satisfied before a directory can be removed (e.g. the directory has to
be empty, or may not be in use by other processes).  It is not legal
for an implementation to partially remove a directory unless the
entire directory is removed. A conformant implementation need not
support directory removal in all situations (e.g. removal of the root
directory).

The operation may fail with:

* @HardwareFault@
A physical I\/O error has occurred.
@[EIO]@

* @InvalidArgument@
The operand is not a valid directory name.
@[ENAMETOOLONG, ELOOP]@

* 'isDoesNotExistError'
The directory does not exist.
@[ENOENT, ENOTDIR]@

* 'isPermissionError'
The process has insufficient privileges to perform the operation.
@[EROFS, EACCES, EPERM]@

* @UnsatisfiedConstraints@
Implementation-dependent constraints are not satisfied.
@[EBUSY, ENOTEMPTY, EEXIST]@

* @UnsupportedOperation@
The implementation does not support removal in this situation.
@[EINVAL]@

* @InappropriateType@
The operand refers to an existing non-directory object.
@[ENOTDIR]@

-}

removeDirectory :: OsPath -> IO ()
removeDirectory :: OsString -> IO ()
removeDirectory = Bool -> OsString -> IO ()
removePathInternal Bool
True

type Preremover = Maybe RawHandle -> OsPath -> Metadata -> IO ()

noPreremover :: Preremover
noPreremover :: Preremover
noPreremover Maybe RawHandle
_ OsString
_ Metadata
_ = () -> IO ()
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure ()

forcePreremover :: Preremover
forcePreremover :: Preremover
forcePreremover Maybe RawHandle
dir OsString
path Metadata
metadata = do
  Bool -> IO () -> IO ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (FileType -> Bool
fileTypeIsDirectory (Metadata -> FileType
fileTypeFromMetadata Metadata
metadata)
        Bool -> Bool -> Bool
|| Bool -> Bool
not Bool
filesAlwaysRemovable) (IO () -> IO ()) -> IO () -> IO ()
forall a b. (a -> b) -> a -> b
$ do
    WhetherFollow -> Maybe RawHandle -> OsString -> Mode -> IO ()
setModeAt WhetherFollow
NoFollow Maybe RawHandle
dir OsString
path Mode
mode
      IO () -> (IOError -> IO ()) -> IO ()
forall a. IO a -> (IOError -> IO a) -> IO a
`catchIOError` \ IOError
_ -> () -> IO ()
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure ()
  where
    mode :: Mode
mode = Mode -> Mode
setForceRemoveMode (Metadata -> Mode
modeFromMetadata Metadata
metadata)

removeRecursivelyAt
  :: (IO () -> IO ())
  -> ([IO ()] -> IO ())
  -> Preremover
  -> Maybe RawHandle
  -> OsPath
  -> IO ()
removeRecursivelyAt :: (IO () -> IO ())
-> ([IO ()] -> IO ())
-> Preremover
-> Maybe RawHandle
-> OsString
-> IO ()
removeRecursivelyAt IO () -> IO ()
catcher [IO ()] -> IO ()
sequencer Preremover
preremover Maybe RawHandle
dir OsString
name = IO () -> IO ()
catcher (IO () -> IO ()) -> IO () -> IO ()
forall a b. (a -> b) -> a -> b
$ do
  metadata <- WhetherFollow -> Maybe RawHandle -> OsString -> IO Metadata
getMetadataAt WhetherFollow
NoFollow Maybe RawHandle
dir OsString
name
  preremover dir name metadata
  let
    fileType = Metadata -> FileType
fileTypeFromMetadata Metadata
metadata
    subremovals = do
      Bool -> IO () -> IO ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (FileType
fileType FileType -> FileType -> Bool
forall a. Eq a => a -> a -> Bool
== FileType
Directory) (IO () -> IO ()) -> IO () -> IO ()
forall a b. (a -> b) -> a -> b
$ do
        IO RawHandle
-> (RawHandle -> IO ()) -> (RawHandle -> IO ()) -> IO ()
forall a b c. IO a -> (a -> IO b) -> (a -> IO c) -> IO c
bracket (WhetherFollow -> Maybe RawHandle -> OsString -> IO RawHandle
openRaw WhetherFollow
NoFollow Maybe RawHandle
dir OsString
name) RawHandle -> IO ()
closeRaw ((RawHandle -> IO ()) -> IO ()) -> (RawHandle -> IO ()) -> IO ()
forall a b. (a -> b) -> a -> b
$ \ RawHandle
handle -> do
          -- dropSpecialDotDirs is extremely important! Otherwise it will
          -- recurse into the parent directory and wreak havoc.
          names <- [OsString] -> [OsString]
dropSpecialDotDirs ([OsString] -> [OsString]) -> IO [OsString] -> IO [OsString]
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> RawHandle -> IO [OsString]
readDirToEnd RawHandle
handle
          sequencer (recurse (Just handle) <$> names)
  sequencer [subremovals, removePathAt fileType dir name]
  where recurse :: Maybe RawHandle -> OsString -> IO ()
recurse = (IO () -> IO ())
-> ([IO ()] -> IO ())
-> Preremover
-> Maybe RawHandle
-> OsString
-> IO ()
removeRecursivelyAt IO () -> IO ()
catcher [IO ()] -> IO ()
sequencer Preremover
preremover

-- | @'removeDirectoryRecursive' dir@ removes an existing directory /dir/
-- together with its contents and subdirectories. Within this directory,
-- symbolic links are removed without affecting their targets.
--
-- On Windows, the operation fails if /dir/ is a directory symbolic link.
--
-- This operation is reported to be flaky on Windows so retry logic may
-- be advisable. See: https://github.com/haskell/directory/pull/108
removeDirectoryRecursive :: OsPath -> IO ()
removeDirectoryRecursive :: OsString -> IO ()
removeDirectoryRecursive OsString
path =
  (IOError -> String -> IOError
`ioeAddLocation` String
"removeDirectoryRecursive") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    m <- OsString -> IO Metadata
getSymbolicLinkMetadata OsString
path
    case fileTypeFromMetadata m of
      FileType
Directory ->
        (IO () -> IO ())
-> ([IO ()] -> IO ())
-> Preremover
-> Maybe RawHandle
-> OsString
-> IO ()
removeRecursivelyAt IO () -> IO ()
forall a. a -> a
id [IO ()] -> IO ()
forall (t :: * -> *) (f :: * -> *) a.
(Foldable t, Applicative f) =>
t (f a) -> f ()
sequenceA_ Preremover
noPreremover Maybe RawHandle
forall a. Maybe a
Nothing OsString
path
      FileType
DirectoryLink ->
        IOError -> IO ()
forall a. HasCallStack => IOError -> IO a
ioError (IOError
err IOError -> String -> IOError
`ioeSetErrorString` String
"is a directory symbolic link")
      FileType
_ ->
        IOError -> IO ()
forall a. HasCallStack => IOError -> IO a
ioError (IOError
err IOError -> String -> IOError
`ioeSetErrorString` String
"not a directory")
  where err :: IOError
err = IOErrorType -> String -> Maybe Handle -> Maybe String -> IOError
mkIOError IOErrorType
InappropriateType String
"" Maybe Handle
forall a. Maybe a
Nothing Maybe String
forall a. Maybe a
Nothing IOError -> OsString -> IOError
`ioeSetOsPath` OsString
path

-- | Removes a file or directory at /path/ together with its contents and
-- subdirectories. Symbolic links are removed without affecting their
-- targets. If the path does not exist, nothing happens.
--
-- Unlike other removal functions, this function will also attempt to delete
-- files marked as read-only or otherwise made unremovable due to permissions.
-- As a result, if the removal is incomplete, the permissions or attributes on
-- the remaining files may be altered.  If there are hard links in the
-- directory, then permissions on all related hard links may be altered.
--
-- If an entry within the directory vanishes while @removePathForcibly@ is
-- running, it is silently ignored.
--
-- If an exception occurs while removing an entry, @removePathForcibly@ will
-- still try to remove as many entries as it can before failing with an
-- exception.  The first exception that it encountered is re-thrown.
removePathForcibly :: OsPath -> IO ()
removePathForcibly :: OsString -> IO ()
removePathForcibly OsString
path =
  (IOError -> String -> IOError
`ioeAddLocation` String
"removePathForcibly") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    (IO () -> IO ())
-> ([IO ()] -> IO ())
-> Preremover
-> Maybe RawHandle
-> OsString
-> IO ()
removeRecursivelyAt
      IO () -> IO ()
ignoreDoesNotExistError
      [IO ()] -> IO ()
sequenceWithIOErrors_
      Preremover
forcePreremover
      Maybe RawHandle
forall a. Maybe a
Nothing
      OsString
path

  where

    ignoreDoesNotExistError :: IO () -> IO ()
    ignoreDoesNotExistError :: IO () -> IO ()
ignoreDoesNotExistError IO ()
action =
      () () -> IO (Either IOError ()) -> IO ()
forall a b. a -> IO b -> IO a
forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ (IOError -> Bool) -> IO () -> IO (Either IOError ())
forall a. (IOError -> Bool) -> IO a -> IO (Either IOError a)
tryIOErrorType IOError -> Bool
isDoesNotExistError IO ()
action

{- |'removeFile' /file/ removes the directory entry for an existing file
/file/, where /file/ is not itself a directory. The
implementation may specify additional constraints which must be
satisfied before a file can be removed (e.g. the file may not be in
use by other processes).

The operation may fail with:

* @HardwareFault@
A physical I\/O error has occurred.
@[EIO]@

* @InvalidArgument@
The operand is not a valid file name.
@[ENAMETOOLONG, ELOOP]@

* 'isDoesNotExistError'
The file does not exist.
@[ENOENT, ENOTDIR]@

* 'isPermissionError'
The process has insufficient privileges to perform the operation.
@[EROFS, EACCES, EPERM]@

* @UnsatisfiedConstraints@
Implementation-dependent constraints are not satisfied.
@[EBUSY]@

* @InappropriateType@
The operand refers to an existing directory.
@[EPERM, EINVAL]@

-}

removeFile :: OsPath -> IO ()
removeFile :: OsString -> IO ()
removeFile = Bool -> OsString -> IO ()
removePathInternal Bool
False

{- |@'renameDirectory' old new@ changes the name of an existing
directory from /old/ to /new/.  If the /new/ directory
already exists, it is atomically replaced by the /old/ directory.
If the /new/ directory is neither the /old/ directory nor an
alias of the /old/ directory, it is removed as if by
'removeDirectory'.  A conformant implementation need not support
renaming directories in all situations (e.g. renaming to an existing
directory, or across different physical devices), but the constraints
must be documented.

On Win32 platforms, @renameDirectory@ fails if the /new/ directory already
exists.

The operation may fail with:

* @HardwareFault@
A physical I\/O error has occurred.
@[EIO]@

* @InvalidArgument@
Either operand is not a valid directory name.
@[ENAMETOOLONG, ELOOP]@

* 'isDoesNotExistError'
The original directory does not exist, or there is no path to the target.
@[ENOENT, ENOTDIR]@

* 'isPermissionError'
The process has insufficient privileges to perform the operation.
@[EROFS, EACCES, EPERM]@

* 'System.IO.isFullError'
Insufficient resources are available to perform the operation.
@[EDQUOT, ENOSPC, ENOMEM, EMLINK]@

* @UnsatisfiedConstraints@
Implementation-dependent constraints are not satisfied.
@[EBUSY, ENOTEMPTY, EEXIST]@

* @UnsupportedOperation@
The implementation does not support renaming in this situation.
@[EINVAL, EXDEV]@

* @InappropriateType@
Either path refers to an existing non-directory object.
@[ENOTDIR, EISDIR]@

-}

renameDirectory :: OsPath -> OsPath -> IO ()
renameDirectory :: OsString -> OsString -> IO ()
renameDirectory OsString
opath OsString
npath =
   (IOError -> String -> IOError
`ioeAddLocation` String
"renameDirectory") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
     -- XXX this test isn't performed atomically with the following rename
     isDir <- OsString -> IO Bool
pathIsDirectory OsString
opath
     when (not isDir) . ioError $
       mkIOError InappropriateType "renameDirectory" Nothing Nothing
       `ioeSetErrorString` "not a directory"
       `ioeSetOsPath` opath
     renamePath opath npath

{- |@'renameFile' old new@ changes the name of an existing file system
object from /old/ to /new/.  If the /new/ object already exists, it is
replaced by the /old/ object.  Neither path may refer to an existing
directory.

A conformant implementation need not support renaming files in all situations
(e.g. renaming across different physical devices), but the constraints must be
documented. On Windows, this does not support renaming across different physical
devices; if you are looking to do so, consider using 'copyFileWithMetadata' and
'removeFile'.

On Windows, this calls @MoveFileEx@ with @MOVEFILE_REPLACE_EXISTING@ set,
which is not guaranteed to be atomic
(<https://github.com/haskell/directory/issues/109>).

On other platforms, this operation is atomic.

The operation may fail with:

* @HardwareFault@
A physical I\/O error has occurred.
@[EIO]@

* @InvalidArgument@
Either operand is not a valid file name.
@[ENAMETOOLONG, ELOOP]@

* 'isDoesNotExistError'
The original file does not exist, or there is no path to the target.
@[ENOENT, ENOTDIR]@

* 'isPermissionError'
The process has insufficient privileges to perform the operation.
@[EROFS, EACCES, EPERM]@

* 'System.IO.isFullError'
Insufficient resources are available to perform the operation.
@[EDQUOT, ENOSPC, ENOMEM, EMLINK]@

* @UnsatisfiedConstraints@
Implementation-dependent constraints are not satisfied.
@[EBUSY]@

* @UnsupportedOperation@
The implementation does not support renaming in this situation.
@[EXDEV]@

* @InappropriateType@
Either path refers to an existing directory.
@[ENOTDIR, EISDIR, EINVAL, EEXIST, ENOTEMPTY]@

-}

renameFile :: OsPath -> OsPath -> IO ()
renameFile :: OsString -> OsString -> IO ()
renameFile OsString
opath OsString
npath =
  (IOError -> String -> IOError
`ioeAddLocation` String
"renameFile") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    -- XXX the tests are not performed atomically with the rename
    OsString -> IO ()
checkNotDir OsString
opath
    OsString -> OsString -> IO ()
renamePath OsString
opath OsString
npath
      -- The underlying rename implementation can throw odd exceptions when the
      -- destination is a directory.  For example, Windows typically throws a
      -- permission error, while POSIX systems may throw a resource busy error
      -- if one of the paths refers to the current directory.  In these cases,
      -- we check if the destination is a directory and, if so, throw an
      -- InappropriateType error.
      IO () -> (IOError -> IO ()) -> IO ()
forall a. IO a -> (IOError -> IO a) -> IO a
`catchIOError` \ IOError
err -> do
        OsString -> IO ()
checkNotDir OsString
npath
        IOError -> IO ()
forall a. HasCallStack => IOError -> IO a
ioError IOError
err
  where checkNotDir :: OsString -> IO ()
checkNotDir OsString
path = do
          m <- IO Metadata -> IO (Either IOError Metadata)
forall a. IO a -> IO (Either IOError a)
tryIOError (OsString -> IO Metadata
getSymbolicLinkMetadata OsString
path)
          case fileTypeIsDirectory . fileTypeFromMetadata <$> m of
            Right Bool
True ->
              IOError -> IO ()
forall a. HasCallStack => IOError -> IO a
ioError (IOError -> IO ()) -> IOError -> IO ()
forall a b. (a -> b) -> a -> b
$
              IOErrorType -> String -> Maybe Handle -> Maybe String -> IOError
mkIOError IOErrorType
InappropriateType String
"" Maybe Handle
forall a. Maybe a
Nothing Maybe String
forall a. Maybe a
Nothing
              IOError -> String -> IOError
`ioeSetErrorString` String
"is a directory"
              IOError -> OsString -> IOError
`ioeSetOsPath` OsString
path
            Either IOError Bool
_          -> () -> IO ()
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure ()

-- | Rename a file or directory.  If the destination path already exists, it
-- is replaced atomically.  The destination path must not point to an existing
-- directory.  A conformant implementation need not support renaming files in
-- all situations (e.g. renaming across different physical devices), but the
-- constraints must be documented.
--
-- The operation may fail with:
--
-- * @HardwareFault@
-- A physical I\/O error has occurred.
-- @[EIO]@
--
-- * @InvalidArgument@
-- Either operand is not a valid file name.
-- @[ENAMETOOLONG, ELOOP]@
--
-- * 'isDoesNotExistError'
-- The original file does not exist, or there is no path to the target.
-- @[ENOENT, ENOTDIR]@
--
-- * 'isPermissionError'
-- The process has insufficient privileges to perform the operation.
-- @[EROFS, EACCES, EPERM]@
--
-- * 'System.IO.isFullError'
-- Insufficient resources are available to perform the operation.
-- @[EDQUOT, ENOSPC, ENOMEM, EMLINK]@
--
-- * @UnsatisfiedConstraints@
-- Implementation-dependent constraints are not satisfied.
-- @[EBUSY]@
--
-- * @UnsupportedOperation@
-- The implementation does not support renaming in this situation.
-- @[EXDEV]@
--
-- * @InappropriateType@
-- Either the destination path refers to an existing directory, or one of the
-- parent segments in the destination path is not a directory.
-- @[ENOTDIR, EISDIR, EINVAL, EEXIST, ENOTEMPTY]@
renamePath :: OsPath                  -- ^ Old path
           -> OsPath                  -- ^ New path
           -> IO ()
renamePath :: OsString -> OsString -> IO ()
renamePath OsString
opath OsString
npath =
  (IOError -> String -> IOError
`ioeAddLocation` String
"renamePath") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> OsString -> IO ()
renamePathInternal OsString
opath OsString
npath

-- | Copy a file with its permissions.  If the destination file already exists,
-- it is replaced atomically.  Neither path may refer to an existing
-- directory.  No exceptions are thrown if the permissions could not be
-- copied.
copyFile :: OsPath                    -- ^ Source filename
         -> OsPath                    -- ^ Destination filename
         -> IO ()
copyFile :: OsString -> OsString -> IO ()
copyFile OsString
fromFPath OsString
toFPath =
  (IOError -> String -> IOError
`ioeAddLocation` String
"copyFile") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> OsString -> (OsString -> IO ()) -> IO ()
atomicCopyFileContents OsString
fromFPath OsString
toFPath
      (IO () -> IO ()
ignoreIOExceptions (IO () -> IO ()) -> (OsString -> IO ()) -> OsString -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. OsString -> OsString -> IO ()
copyPermissions OsString
fromFPath)

-- | Copy all data from a file to a handle.
copyFileToHandle :: OsPath              -- ^ Source file
                 -> Handle              -- ^ Destination handle
                 -> IO ()
copyFileToHandle :: OsString -> Handle -> IO ()
copyFileToHandle OsString
fromFPath Handle
hTo =
  (IOError -> String -> IOError
`ioeAddLocation` String
"copyFileToHandle") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> IOMode -> (Handle -> IO ()) -> IO ()
forall r. OsString -> IOMode -> (Handle -> IO r) -> IO r
withBinaryFile OsString
fromFPath IOMode
ReadMode ((Handle -> IO ()) -> IO ()) -> (Handle -> IO ()) -> IO ()
forall a b. (a -> b) -> a -> b
$ \ Handle
hFrom ->
      Handle -> Handle -> IO ()
copyHandleData Handle
hFrom Handle
hTo

-- | Copy the contents of a source file to a destination file, replacing the
-- destination file atomically via @withReplacementFile@, resetting the
-- attributes of the destination file to the defaults.
atomicCopyFileContents :: OsPath            -- ^ Source filename
                       -> OsPath            -- ^ Destination filename
                       -> (OsPath -> IO ()) -- ^ Post-action
                       -> IO ()
atomicCopyFileContents :: OsString -> OsString -> (OsString -> IO ()) -> IO ()
atomicCopyFileContents OsString
fromFPath OsString
toFPath OsString -> IO ()
postAction =
  (IOError -> String -> IOError
`ioeAddLocation` String
"atomicCopyFileContents") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> (OsString -> IO ()) -> (Handle -> IO ()) -> IO ()
forall a.
OsString -> (OsString -> IO ()) -> (Handle -> IO a) -> IO a
withReplacementFile OsString
toFPath OsString -> IO ()
postAction ((Handle -> IO ()) -> IO ()) -> (Handle -> IO ()) -> IO ()
forall a b. (a -> b) -> a -> b
$ \ Handle
hTo -> do
      OsString -> Handle -> IO ()
copyFileToHandle OsString
fromFPath Handle
hTo

-- | A helper function useful for replacing files in an atomic manner.  The
-- function creates a temporary file in the directory of the destination file,
-- opens it, performs the main action with its handle, closes it, performs the
-- post-action with its path, and finally replaces the destination file with
-- the temporary file.  If an error occurs during any step of this process,
-- the temporary file is removed and the destination file remains untouched.
withReplacementFile :: OsPath            -- ^ Destination file
                    -> (OsPath -> IO ()) -- ^ Post-action
                    -> (Handle -> IO a)    -- ^ Main action
                    -> IO a
withReplacementFile :: forall a.
OsString -> (OsString -> IO ()) -> (Handle -> IO a) -> IO a
withReplacementFile OsString
path OsString -> IO ()
postAction Handle -> IO a
action =
  (IOError -> String -> IOError
`ioeAddLocation` String
"withReplacementFile") (IOError -> IOError) -> IO a -> IO a
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    ((forall a. IO a -> IO a) -> IO a) -> IO a
forall b. ((forall a. IO a -> IO a) -> IO b) -> IO b
mask (((forall a. IO a -> IO a) -> IO a) -> IO a)
-> ((forall a. IO a -> IO a) -> IO a) -> IO a
forall a b. (a -> b) -> a -> b
$ \ forall a. IO a -> IO a
restore -> do
      let tmpPath :: OsString
tmpPath = case TextEncoding
-> TextEncoding -> String -> Either EncodingException OsString
encodeWith (CodingFailureMode -> TextEncoding
mkUTF8 CodingFailureMode
ErrorOnCodingFailure)
                                    (CodingFailureMode -> TextEncoding
mkUTF16le CodingFailureMode
ErrorOnCodingFailure)
                                    String
".copyFile.tmp"
                         of
            Left EncodingException
err -> String -> OsString
forall a. HasCallStack => String -> a
error (String
"withReplacementFile: invalid encoding: " String -> String -> String
forall a. [a] -> [a] -> [a]
++ EncodingException -> String
forall a. Show a => a -> String
show EncodingException
err)
            Right OsString
p -> OsString
p
      (tmpFPath, hTmp) <- OsString -> OsString -> IO (OsString, Handle)
OS.openBinaryTempFile (OsString -> OsString
takeDirectory OsString
path) OsString
tmpPath
      (`onException` ignoreIOExceptions (removeFile tmpFPath)) $ do
        r <- (`onException` ignoreIOExceptions (hClose hTmp)) $ do
          restore (action hTmp)
        hClose hTmp
        restore (postAction tmpFPath)
        renameFile tmpFPath path
        pure r

-- | Copy a file with its associated metadata.  If the destination file
-- already exists, it is overwritten.  There is no guarantee of atomicity in
-- the replacement of the destination file.  Neither path may refer to an
-- existing directory.  If the source and/or destination are symbolic links,
-- the copy is performed on the targets of the links.
--
-- On Windows, it behaves like the Win32 function
-- <https://msdn.microsoft.com/en-us/library/windows/desktop/aa363851.aspx CopyFile>,
-- which copies various kinds of metadata including file attributes and
-- security resource properties.
--
-- On Unix-like systems, permissions, access time, and modification time are
-- preserved.  If possible, the owner and group are also preserved.  Note that
-- the very act of copying can change the access time of the source file,
-- hence the access times of the two files may differ after the operation
-- completes.
copyFileWithMetadata :: OsPath        -- ^ Source file
                     -> OsPath        -- ^ Destination file
                     -> IO ()
copyFileWithMetadata :: OsString -> OsString -> IO ()
copyFileWithMetadata OsString
src OsString
dst =
  (IOError -> String -> IOError
`ioeAddLocation` String
"copyFileWithMetadata") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError`
    (Metadata -> OsString -> IO ())
-> (Metadata -> OsString -> IO ()) -> OsString -> OsString -> IO ()
copyFileWithMetadataInternal Metadata -> OsString -> IO ()
copyPermissionsFromMetadata
                                 Metadata -> OsString -> IO ()
copyTimesFromMetadata
                                 OsString
src
                                 OsString
dst

copyTimesFromMetadata :: Metadata -> OsPath -> IO ()
copyTimesFromMetadata :: Metadata -> OsString -> IO ()
copyTimesFromMetadata Metadata
st OsString
dst = do
  let atime :: UTCTime
atime = Metadata -> UTCTime
accessTimeFromMetadata Metadata
st
  let mtime :: UTCTime
mtime = Metadata -> UTCTime
modificationTimeFromMetadata Metadata
st
  OsString -> (Maybe UTCTime, Maybe UTCTime) -> IO ()
setFileTimes OsString
dst (UTCTime -> Maybe UTCTime
forall a. a -> Maybe a
Just UTCTime
atime, UTCTime -> Maybe UTCTime
forall a. a -> Maybe a
Just UTCTime
mtime)

-- | Make a path absolute, normalize the path, and remove as many indirections
-- from it as possible.  Any trailing path separators are discarded via
-- 'dropTrailingPathSeparator'.  Additionally, on Windows the letter case of
-- the path is canonicalized.
--
-- __Note__: This function is a very big hammer.  If you only need an absolute
-- path, 'makeAbsolute' is sufficient for removing dependence on the current
-- working directory.
--
-- Indirections include the two special directories @.@ and @..@, as well as
-- any symbolic links (and junction points on Windows).  The input path need
-- not point to an existing file or directory.  Canonicalization is performed
-- on the longest prefix of the path that points to an existing file or
-- directory.  The remaining portion of the path that does not point to an
-- existing file or directory will still be normalized, but case
-- canonicalization and indirection removal are skipped as they are impossible
-- to do on a nonexistent path.
--
-- Most programs should not worry about the canonicity of a path.  In
-- particular, despite the name, the function does not truly guarantee
-- canonicity of the returned path due to the presence of hard links, mount
-- points, etc.
--
-- If the path points to an existing file or directory, then the output path
-- shall also point to the same file or directory, subject to the condition
-- that the relevant parts of the file system do not change while the function
-- is still running.  In other words, the function is definitively not atomic.
-- The results can be utterly wrong if the portions of the path change while
-- this function is running.
--
-- Since some indirections (symbolic links on all systems, @..@ on non-Windows
-- systems, and junction points on Windows) are dependent on the state of the
-- existing filesystem, the function can only make a conservative attempt by
-- removing such indirections from the longest prefix of the path that still
-- points to an existing file or directory.
--
-- Note that on Windows parent directories @..@ are always fully expanded
-- before the symbolic links, as consistent with the rest of the Windows API
-- (such as @GetFullPathName@).  In contrast, on POSIX systems parent
-- directories @..@ are expanded alongside symbolic links from left to right.
-- To put this more concretely: if @L@ is a symbolic link for @R/P@, then on
-- Windows @L\\..@ refers to @.@, whereas on other operating systems @L/..@
-- refers to @R@.
--
-- Similar to 'System.FilePath.normalise', passing an empty path is equivalent
-- to passing the current directory.
--
-- @canonicalizePath@ can resolve at least 64 indirections in a single path,
-- more than what is supported by most operating systems.  Therefore, it may
-- return the fully resolved path even though the operating system itself
-- would have long given up.
--
-- On Windows XP or earlier systems, junction expansion is not performed due
-- to their lack of @GetFinalPathNameByHandle@.
--
-- /Changes since 1.2.3.0:/ The function has been altered to be more robust
-- and has the same exception behavior as 'makeAbsolute'.
--
-- /Changes since 1.3.0.0:/ The function no longer preserves the trailing path
-- separator.  File symbolic links that appear in the middle of a path are
-- properly dereferenced.  Case canonicalization and symbolic link expansion
-- are now performed on Windows.
--
canonicalizePath :: OsPath -> IO OsPath
canonicalizePath :: OsString -> IO OsString
canonicalizePath = \ OsString
path ->
  ((IOError -> String -> IOError
`ioeAddLocation` String
"canonicalizePath") (IOError -> IOError) -> (IOError -> IOError) -> IOError -> IOError
forall b c a. (b -> c) -> (a -> b) -> a -> c
.
   (IOError -> OsString -> IOError
`ioeSetOsPath` OsString
path)) (IOError -> IOError) -> IO OsString -> IO OsString
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    -- simplify does more stuff, like upper-casing the drive letter
    OsString -> OsString
dropTrailingPathSeparator (OsString -> OsString)
-> (OsString -> OsString) -> OsString -> OsString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. OsString -> OsString
simplify (OsString -> OsString) -> IO OsString -> IO OsString
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$>
      ((OsString -> IO OsString) -> OsString -> IO OsString
attemptRealpath OsString -> IO OsString
realPath (OsString -> IO OsString) -> IO OsString -> IO OsString
forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< OsString -> IO OsString
prependCurrentDirectory OsString
path)
  where

    -- allow up to 64 cycles before giving up
    attemptRealpath :: (OsString -> IO OsString) -> OsString -> IO OsString
attemptRealpath OsString -> IO OsString
realpath =
      Int
-> Maybe OsString
-> (OsString -> IO OsString)
-> OsString
-> IO OsString
forall {a}.
(Ord a, Num a) =>
a
-> Maybe OsString
-> (OsString -> IO OsString)
-> OsString
-> IO OsString
attemptRealpathWith (Int
64 :: Int) Maybe OsString
forall a. Maybe a
Nothing OsString -> IO OsString
realpath
      (OsString -> IO OsString)
-> (OsString -> IO OsString) -> OsString -> IO OsString
forall (m :: * -> *) b c a.
Monad m =>
(b -> m c) -> (a -> m b) -> a -> m c
<=< OsString -> IO OsString
canonicalizePathSimplify

    -- n is a counter to make sure we don't run into an infinite loop; we
    -- don't try to do any cycle detection here because an adversary could DoS
    -- any arbitrarily clever algorithm
    attemptRealpathWith :: a
-> Maybe OsString
-> (OsString -> IO OsString)
-> OsString
-> IO OsString
attemptRealpathWith a
n Maybe OsString
mFallback OsString -> IO OsString
realpath OsString
path =
      case Maybe OsString
mFallback of
        -- too many indirections ... giving up.
        Just OsString
fallback | a
n a -> a -> Bool
forall a. Ord a => a -> a -> Bool
<= a
0 -> OsString -> IO OsString
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure OsString
fallback
        -- either mFallback == Nothing (first attempt)
        --     or n > 0 (still have some attempts left)
        Maybe OsString
_ -> [(OsString, OsString)] -> IO OsString
realpathPrefix ([(OsString, OsString)] -> [(OsString, OsString)]
forall a. [a] -> [a]
reverse ([OsString] -> [OsString] -> [(OsString, OsString)]
forall a b. [a] -> [b] -> [(a, b)]
zip [OsString]
prefixes [OsString]
suffixes))

      where

        segments :: [OsString]
segments = OsString -> [OsString]
splitDirectories OsString
path
        prefixes :: [OsString]
prefixes = (OsString -> OsString -> OsString) -> [OsString] -> [OsString]
forall a. (a -> a -> a) -> [a] -> [a]
scanl1 OsString -> OsString -> OsString
(</>) [OsString]
segments
        suffixes :: [OsString]
suffixes = NonEmpty OsString -> [OsString]
forall a. NonEmpty a -> [a]
NE.tail ((OsString -> OsString -> OsString)
-> OsString -> [OsString] -> NonEmpty OsString
forall (f :: * -> *) a b.
Foldable f =>
(a -> b -> b) -> b -> f a -> NonEmpty b
NE.scanr OsString -> OsString -> OsString
(</>) OsString
forall a. Monoid a => a
mempty [OsString]
segments)

        -- try to call realpath on the largest possible prefix
        realpathPrefix :: [(OsString, OsString)] -> IO OsString
realpathPrefix [(OsString, OsString)]
candidates =
          case [(OsString, OsString)]
candidates of
            [] -> OsString -> IO OsString
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure OsString
path
            (OsString
prefix, OsString
suffix) : [(OsString, OsString)]
rest -> do
              exist <- OsString -> IO Bool
doesPathExist OsString
prefix
              if not exist
                -- never call realpath on an inaccessible path
                -- (to avoid bugs in system realpath implementations)
                -- try a smaller prefix instead
                then realpathPrefix rest
                else do
                  mp <- tryIOError (realpath prefix)
                  case mp of
                    -- realpath failed: try a smaller prefix instead
                    Left IOError
_ -> [(OsString, OsString)] -> IO OsString
realpathPrefix [(OsString, OsString)]
rest
                    -- realpath succeeded: fine-tune the result
                    Right OsString
p -> OsString -> OsString -> OsString -> IO OsString
realpathFurther (OsString
p OsString -> OsString -> OsString
</> OsString
suffix) OsString
p OsString
suffix

        -- by now we have a reasonable fallback value that we can use if we
        -- run into too many indirections; the fallback value is the same
        -- result that we have been returning in versions prior to 1.3.1.0
        -- (this is essentially the fix to #64)
        realpathFurther :: OsString -> OsString -> OsString -> IO OsString
realpathFurther OsString
fallback OsString
p OsString
suffix =
          case OsString -> [OsString]
splitDirectories OsString
suffix of
            [] -> OsString -> IO OsString
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure OsString
fallback
            OsString
next : [OsString]
restSuffix -> do
              -- see if the 'next' segment is a symlink
              mTarget <- IO OsString -> IO (Either IOError OsString)
forall a. IO a -> IO (Either IOError a)
tryIOError (OsString -> IO OsString
getSymbolicLinkTarget (OsString
p OsString -> OsString -> OsString
</> OsString
next))
              case mTarget of
                Left IOError
_ -> OsString -> IO OsString
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure OsString
fallback
                Right OsString
target -> do
                  -- if so, dereference it and restart the whole cycle
                  let mFallback' :: Maybe OsString
mFallback' = OsString -> Maybe OsString
forall a. a -> Maybe a
Just (OsString -> Maybe OsString -> OsString
forall a. a -> Maybe a -> a
fromMaybe OsString
fallback Maybe OsString
mFallback)
                  path' <- OsString -> IO OsString
canonicalizePathSimplify
                             (OsString
p OsString -> OsString -> OsString
</> OsString
target OsString -> OsString -> OsString
</> [OsString] -> OsString
joinPath [OsString]
restSuffix)
                  attemptRealpathWith (n - 1) mFallback' realpath path'

-- | Convert a path into an absolute path.  If the given path is relative, the
-- current directory is prepended and then the combined result is normalized.
-- If the path is already absolute, the path is simply normalized.  The
-- function preserves the presence or absence of the trailing path separator
-- unless the path refers to the root directory @/@.
--
-- If the path is already absolute, the operation never fails.  Otherwise, the
-- operation may fail with the same exceptions as 'getCurrentDirectory'.
--
makeAbsolute :: OsPath -> IO OsPath
makeAbsolute :: OsString -> IO OsString
makeAbsolute OsString
path =
  ((IOError -> String -> IOError
`ioeAddLocation` String
"makeAbsolute") (IOError -> IOError) -> (IOError -> IOError) -> IOError -> IOError
forall b c a. (b -> c) -> (a -> b) -> a -> c
.
   (IOError -> OsString -> IOError
`ioeSetOsPath` OsString
path)) (IOError -> IOError) -> IO OsString -> IO OsString
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> OsString -> OsString
matchTrailingSeparator OsString
path (OsString -> OsString)
-> (OsString -> OsString) -> OsString -> OsString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. OsString -> OsString
simplify (OsString -> OsString) -> IO OsString -> IO OsString
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> OsString -> IO OsString
prependCurrentDirectory OsString
path

-- | Add or remove the trailing path separator in the second path so as to
-- match its presence in the first path.
--
-- (internal API)
matchTrailingSeparator :: OsPath -> OsPath -> OsPath
matchTrailingSeparator :: OsString -> OsString -> OsString
matchTrailingSeparator OsString
path
  | OsString -> Bool
hasTrailingPathSeparator OsString
path = OsString -> OsString
addTrailingPathSeparator
  | Bool
otherwise                     = OsString -> OsString
dropTrailingPathSeparator

-- | Construct a path relative to the current directory, similar to
-- 'makeRelative'.
--
-- The operation may fail with the same exceptions as 'getCurrentDirectory'.
makeRelativeToCurrentDirectory :: OsPath -> IO OsPath
makeRelativeToCurrentDirectory :: OsString -> IO OsString
makeRelativeToCurrentDirectory OsString
x = do
  (OsString -> OsString -> OsString
`makeRelative` OsString
x) (OsString -> OsString) -> IO OsString -> IO OsString
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> IO OsString
getCurrentDirectory

-- | Given the name or path of an executable file, 'findExecutable' searches
-- for such a file in a list of system-defined locations, which generally
-- includes @PATH@ and possibly more.  The full path to the executable is
-- returned if found.  For example, @(findExecutable \"ghc\")@ would normally
-- give you the path to GHC.
--
-- The path returned by @'findExecutable' name@ corresponds to the program
-- that would be executed by
-- @<http://hackage.haskell.org/package/process/docs/System-Process.html#v:createProcess createProcess>@
-- when passed the same string (as a @RawCommand@, not a @ShellCommand@),
-- provided that @name@ is not a relative path with more than one segment.
--
-- On Windows, 'findExecutable' calls the Win32 function
-- @<https://msdn.microsoft.com/en-us/library/aa365527.aspx SearchPath>@,
-- which may search other places before checking the directories in the @PATH@
-- environment variable.  Where it actually searches depends on registry
-- settings, but notably includes the directory containing the current
-- executable.
--
-- On non-Windows platforms, the behavior is equivalent to 'findFileWith'
-- using the search directories from the @PATH@ environment variable and
-- testing each file for executable permissions.  Details can be found in the
-- documentation of 'findFileWith'.
findExecutable :: OsString -> IO (Maybe OsPath)
findExecutable :: OsString -> IO (Maybe OsString)
findExecutable OsString
binary =
  ListT IO OsString -> IO (Maybe OsString)
forall (m :: * -> *) a. Functor m => ListT m a -> m (Maybe a)
listTHead
    (([OsString] -> OsString -> ListT IO OsString)
-> OsString -> ListT IO OsString
findExecutablesLazyInternal [OsString] -> OsString -> ListT IO OsString
findExecutablesInDirectoriesLazy OsString
binary)

-- | Search for executable files in a list of system-defined locations, which
-- generally includes @PATH@ and possibly more.
--
-- On Windows, this /only returns the first occurrence/, if any.  Its behavior
-- is therefore equivalent to 'findExecutable'.
--
-- On non-Windows platforms, the behavior is equivalent to
-- 'findExecutablesInDirectories' using the search directories from the @PATH@
-- environment variable.  Details can be found in the documentation of
-- 'findExecutablesInDirectories'.
findExecutables :: OsString -> IO [OsPath]
findExecutables :: OsString -> IO [OsString]
findExecutables OsString
binary =
  ListT IO OsString -> IO [OsString]
forall (m :: * -> *) a. Monad m => ListT m a -> m [a]
listTToList
    (([OsString] -> OsString -> ListT IO OsString)
-> OsString -> ListT IO OsString
findExecutablesLazyInternal [OsString] -> OsString -> ListT IO OsString
findExecutablesInDirectoriesLazy OsString
binary)

-- | Given a name or path, 'findExecutable' appends the 'exeExtension' to the
-- query and searches for executable files in the list of given search
-- directories and returns all occurrences.
--
-- The behavior is equivalent to 'findFileWith' using the given search
-- directories and testing each file for executable permissions.  Details can
-- be found in the documentation of 'findFileWith'.
--
-- Unlike other similarly named functions, 'findExecutablesInDirectories' does
-- not use @SearchPath@ from the Win32 API.  The behavior of this function on
-- Windows is therefore equivalent to those on non-Windows platforms.
findExecutablesInDirectories :: [OsPath] -> OsString -> IO [OsPath]
findExecutablesInDirectories :: [OsString] -> OsString -> IO [OsString]
findExecutablesInDirectories [OsString]
path OsString
binary =
  ListT IO OsString -> IO [OsString]
forall (m :: * -> *) a. Monad m => ListT m a -> m [a]
listTToList ([OsString] -> OsString -> ListT IO OsString
findExecutablesInDirectoriesLazy [OsString]
path OsString
binary)

findExecutablesInDirectoriesLazy :: [OsPath] -> OsString -> ListT IO OsPath
findExecutablesInDirectoriesLazy :: [OsString] -> OsString -> ListT IO OsString
findExecutablesInDirectoriesLazy [OsString]
path OsString
binary =
  (OsString -> IO Bool)
-> [OsString] -> OsString -> ListT IO OsString
findFilesWithLazy OsString -> IO Bool
isExecutable [OsString]
path (OsString
binary OsString -> OsString -> OsString
<.> OsString
exeExtension)

-- | Test whether a file has executable permissions.
isExecutable :: OsPath -> IO Bool
isExecutable :: OsString -> IO Bool
isExecutable OsString
file = Permissions -> Bool
executable (Permissions -> Bool) -> IO Permissions -> IO Bool
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> OsString -> IO Permissions
getPermissions OsString
file

-- | Search through the given list of directories for the given file.
--
-- The behavior is equivalent to 'findFileWith', returning only the first
-- occurrence.  Details can be found in the documentation of 'findFileWith'.
findFile :: [OsPath] -> OsString -> IO (Maybe OsPath)
findFile :: [OsString] -> OsString -> IO (Maybe OsString)
findFile = (OsString -> IO Bool)
-> [OsString] -> OsString -> IO (Maybe OsString)
findFileWith (\ OsString
_ -> Bool -> IO Bool
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure Bool
True)

-- | Search through the given list of directories for the given file and
-- returns all paths where the given file exists.
--
-- The behavior is equivalent to 'findFilesWith'.  Details can be found in the
-- documentation of 'findFilesWith'.
findFiles :: [OsPath] -> OsString -> IO [OsPath]
findFiles :: [OsString] -> OsString -> IO [OsString]
findFiles = (OsString -> IO Bool) -> [OsString] -> OsString -> IO [OsString]
findFilesWith (\ OsString
_ -> Bool -> IO Bool
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure Bool
True)

-- | Search through a given list of directories for a file that has the given
-- name and satisfies the given predicate and return the path of the first
-- occurrence.  The directories are checked in a left-to-right order.
--
-- This is essentially a more performant version of 'findFilesWith' that
-- always returns the first result, if any.  Details can be found in the
-- documentation of 'findFilesWith'.
findFileWith :: (OsPath -> IO Bool) -> [OsPath] -> OsString -> IO (Maybe OsPath)
findFileWith :: (OsString -> IO Bool)
-> [OsString] -> OsString -> IO (Maybe OsString)
findFileWith OsString -> IO Bool
f [OsString]
ds OsString
name = ListT IO OsString -> IO (Maybe OsString)
forall (m :: * -> *) a. Functor m => ListT m a -> m (Maybe a)
listTHead ((OsString -> IO Bool)
-> [OsString] -> OsString -> ListT IO OsString
findFilesWithLazy OsString -> IO Bool
f [OsString]
ds OsString
name)

-- | @findFilesWith predicate dirs name@ searches through the list of
-- directories (@dirs@) for files that have the given @name@ and satisfy the
-- given @predicate@ and returns the paths of those files.  The directories
-- are checked in a left-to-right order and the paths are returned in the same
-- order.
--
-- If the @name@ is a relative path, then for every search directory @dir@,
-- the function checks whether @dir '</>' name@ exists and satisfies the
-- predicate.  If so, @dir '</>' name@ is returned as one of the results.  In
-- other words, the returned paths can be either relative or absolute
-- depending on the search directories were used.  If there are no search
-- directories, no results are ever returned.
--
-- If the @name@ is an absolute path, then the function will return a single
-- result if the file exists and satisfies the predicate and no results
-- otherwise.  This is irrespective of what search directories were given.
findFilesWith :: (OsPath -> IO Bool) -> [OsPath] -> OsString -> IO [OsPath]
findFilesWith :: (OsString -> IO Bool) -> [OsString] -> OsString -> IO [OsString]
findFilesWith OsString -> IO Bool
f [OsString]
ds OsString
name = ListT IO OsString -> IO [OsString]
forall (m :: * -> *) a. Monad m => ListT m a -> m [a]
listTToList ((OsString -> IO Bool)
-> [OsString] -> OsString -> ListT IO OsString
findFilesWithLazy OsString -> IO Bool
f [OsString]
ds OsString
name)

findFilesWithLazy
  :: (OsPath -> IO Bool) -> [OsPath] -> OsString -> ListT IO OsPath
findFilesWithLazy :: (OsString -> IO Bool)
-> [OsString] -> OsString -> ListT IO OsString
findFilesWithLazy OsString -> IO Bool
f [OsString]
dirs OsString
path
  -- make sure absolute paths are handled properly irrespective of 'dirs'
  -- https://github.com/haskell/directory/issues/72
  | OsString -> Bool
isAbsolute OsString
path = IO (Maybe (OsString, ListT IO OsString)) -> ListT IO OsString
forall (m :: * -> *) a. m (Maybe (a, ListT m a)) -> ListT m a
ListT ([OsString] -> IO (Maybe (OsString, ListT IO OsString))
find [OsString
forall a. Monoid a => a
mempty])
  | Bool
otherwise       = IO (Maybe (OsString, ListT IO OsString)) -> ListT IO OsString
forall (m :: * -> *) a. m (Maybe (a, ListT m a)) -> ListT m a
ListT ([OsString] -> IO (Maybe (OsString, ListT IO OsString))
find [OsString]
dirs)

  where

    find :: [OsString] -> IO (Maybe (OsString, ListT IO OsString))
find []       = Maybe (OsString, ListT IO OsString)
-> IO (Maybe (OsString, ListT IO OsString))
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure Maybe (OsString, ListT IO OsString)
forall a. Maybe a
Nothing
    find (OsString
d : [OsString]
ds) = do
      let p :: OsString
p = OsString
d OsString -> OsString -> OsString
</> OsString
path
      found <- OsString -> IO Bool
doesFileExist OsString
p IO Bool -> IO Bool -> IO Bool
forall (m :: * -> *). Monad m => m Bool -> m Bool -> m Bool
`andM` OsString -> IO Bool
f OsString
p
      if found
        then pure (Just (p, ListT (find ds)))
        else find ds

-- | Filename extension for executable files (including the dot if any)
--   (usually @\"\"@ on POSIX systems and @\".exe\"@ on Windows or OS\/2).
exeExtension :: OsString
exeExtension :: OsString
exeExtension = OsString
exeExtensionInternal

-- | Similar to 'listDirectory', but always includes the special entries (@.@
-- and @..@).  (This applies to Windows as well.)
--
-- The operation may fail with the same exceptions as 'listDirectory'.
getDirectoryContents :: OsPath -> IO [OsPath]
getDirectoryContents :: OsString -> IO [OsString]
getDirectoryContents OsString
path =
  ((IOError -> OsString -> IOError
`ioeSetOsPath` OsString
path) (IOError -> IOError) -> (IOError -> IOError) -> IOError -> IOError
forall b c a. (b -> c) -> (a -> b) -> a -> c
.
   (IOError -> String -> IOError
`ioeAddLocation` String
"getDirectoryContents")) (IOError -> IOError) -> IO [OsString] -> IO [OsString]
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> IO [OsString]
getDirectoryContentsInternal OsString
path

-- | @'listDirectory' dir@ returns a list of /all/ entries in /dir/ without
-- the special entries (@.@ and @..@).
--
-- The operation may fail with:
--
-- * @HardwareFault@
--   A physical I\/O error has occurred.
--   @[EIO]@
--
-- * @InvalidArgument@
--   The operand is not a valid directory name.
--   @[ENAMETOOLONG, ELOOP]@
--
-- * 'isDoesNotExistError'
--   The directory does not exist.
--   @[ENOENT, ENOTDIR]@
--
-- * 'isPermissionError'
--   The process has insufficient privileges to perform the operation.
--   @[EACCES]@
--
-- * 'System.IO.isFullError'
--   Insufficient resources are available to perform the operation.
--   @[EMFILE, ENFILE]@
--
-- * @InappropriateType@
--   The path refers to an existing non-directory object.
--   @[ENOTDIR]@
--
listDirectory :: OsPath -> IO [OsPath]
listDirectory :: OsString -> IO [OsString]
listDirectory OsString
path = [OsString] -> [OsString]
dropSpecialDotDirs ([OsString] -> [OsString]) -> IO [OsString] -> IO [OsString]
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> OsString -> IO [OsString]
getDirectoryContents OsString
path

-- | Obtain the current working directory as an absolute path.
--
-- In a multithreaded program, the current working directory is a global state
-- shared among all threads of the process.  Therefore, when performing
-- filesystem operations from multiple threads, it is highly recommended to
-- use absolute rather than relative paths (see: 'makeAbsolute').
--
-- Note that 'getCurrentDirectory' is not guaranteed to return the same path
-- received by 'setCurrentDirectory'. On POSIX systems, the path returned will
-- always be fully dereferenced (not contain any symbolic links). For more
-- information, refer to the documentation of
-- <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getcwd.html getcwd>.
--
-- The operation may fail with:
--
-- * @HardwareFault@
-- A physical I\/O error has occurred.
-- @[EIO]@
--
-- * 'isDoesNotExistError'
-- There is no path referring to the working directory.
-- @[EPERM, ENOENT, ESTALE...]@
--
-- * 'isPermissionError'
-- The process has insufficient privileges to perform the operation.
-- @[EACCES]@
--
-- * 'System.IO.isFullError'
-- Insufficient resources are available to perform the operation.
--
-- * @UnsupportedOperation@
-- The operating system has no notion of current working directory.
--
getCurrentDirectory :: IO OsPath
getCurrentDirectory :: IO OsString
getCurrentDirectory =
  (IOError -> String -> IOError
`ioeAddLocation` String
"getCurrentDirectory") (IOError -> IOError) -> IO OsString -> IO OsString
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    String -> (IOError -> Bool) -> IO OsString -> IO OsString
forall a. String -> (IOError -> Bool) -> IO a -> IO a
specializeErrorString
      String
"Current working directory no longer exists"
      IOError -> Bool
isDoesNotExistError
      IO OsString
getCurrentDirectoryInternal

-- | Change the working directory to the given path.
--
-- In a multithreaded program, the current working directory is a global state
-- shared among all threads of the process.  Therefore, when performing
-- filesystem operations from multiple threads, it is highly recommended to
-- use absolute rather than relative paths (see: 'makeAbsolute').
--
-- The operation may fail with:
--
-- * @HardwareFault@
-- A physical I\/O error has occurred.
-- @[EIO]@
--
-- * @InvalidArgument@
-- The operand is not a valid directory name.
-- @[ENAMETOOLONG, ELOOP]@
--
-- * 'isDoesNotExistError'
-- The directory does not exist.
-- @[ENOENT, ENOTDIR]@
--
-- * 'isPermissionError'
-- The process has insufficient privileges to perform the operation.
-- @[EACCES]@
--
-- * @UnsupportedOperation@
-- The operating system has no notion of current working directory, or the
-- working directory cannot be dynamically changed.
--
-- * @InappropriateType@
-- The path refers to an existing non-directory object.
-- @[ENOTDIR]@
--
setCurrentDirectory :: OsPath -> IO ()
setCurrentDirectory :: OsString -> IO ()
setCurrentDirectory = OsString -> IO ()
setCurrentDirectoryInternal

-- | Run an 'IO' action with the given working directory and restore the
-- original working directory afterwards, even if the given action fails due
-- to an exception.
--
-- The operation may fail with the same exceptions as 'getCurrentDirectory'
-- and 'setCurrentDirectory'.
--
withCurrentDirectory :: OsPath    -- ^ Directory to execute in
                     -> IO a      -- ^ Action to be executed
                     -> IO a
withCurrentDirectory :: forall a. OsString -> IO a -> IO a
withCurrentDirectory OsString
dir IO a
action =
  IO OsString -> (OsString -> IO ()) -> (OsString -> IO a) -> IO a
forall a b c. IO a -> (a -> IO b) -> (a -> IO c) -> IO c
bracket IO OsString
getCurrentDirectory OsString -> IO ()
setCurrentDirectory ((OsString -> IO a) -> IO a) -> (OsString -> IO a) -> IO a
forall a b. (a -> b) -> a -> b
$ \ OsString
_ -> do
    OsString -> IO ()
setCurrentDirectory OsString
dir
    IO a
action

-- | Obtain the size of a file in bytes.
getFileSize :: OsPath -> IO Integer
getFileSize :: OsString -> IO Integer
getFileSize OsString
path =
  (IOError -> String -> IOError
`ioeAddLocation` String
"getFileSize") (IOError -> IOError) -> IO Integer -> IO Integer
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    Metadata -> Integer
fileSizeFromMetadata (Metadata -> Integer) -> IO Metadata -> IO Integer
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> OsString -> IO Metadata
getFileMetadata OsString
path

-- | Test whether the given path points to an existing filesystem object.  If
-- the user lacks necessary permissions to search the parent directories, this
-- function may return false even if the file does actually exist.  This
-- operation traverses symbolic links, so it can return either True or False
-- for them.
doesPathExist :: OsPath -> IO Bool
doesPathExist :: OsString -> IO Bool
doesPathExist OsString
path = do
  (Bool
True Bool -> IO Metadata -> IO Bool
forall a b. a -> IO b -> IO a
forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ OsString -> IO Metadata
getFileMetadata OsString
path)
    IO Bool -> (IOError -> IO Bool) -> IO Bool
forall a. IO a -> (IOError -> IO a) -> IO a
`catchIOError` \ IOError
_ ->
      Bool -> IO Bool
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure Bool
False

-- | The operation 'doesDirectoryExist' returns 'True' if the argument file
-- exists and is either a directory or a symbolic link to a directory, and
-- 'False' otherwise.  This operation traverses symbolic links, so it can
-- return either True or False for them.
doesDirectoryExist :: OsPath -> IO Bool
doesDirectoryExist :: OsString -> IO Bool
doesDirectoryExist OsString
path = do
  OsString -> IO Bool
pathIsDirectory OsString
path
    IO Bool -> (IOError -> IO Bool) -> IO Bool
forall a. IO a -> (IOError -> IO a) -> IO a
`catchIOError` \ IOError
_ ->
      Bool -> IO Bool
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure Bool
False

-- | The operation 'doesFileExist' returns 'True' if the argument file exists
-- and is not a directory, and 'False' otherwise.  This operation traverses
-- symbolic links, so it can return either True or False for them.
doesFileExist :: OsPath -> IO Bool
doesFileExist :: OsString -> IO Bool
doesFileExist OsString
path = do
  (Bool -> Bool
not (Bool -> Bool) -> IO Bool -> IO Bool
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> OsString -> IO Bool
pathIsDirectory OsString
path)
    IO Bool -> (IOError -> IO Bool) -> IO Bool
forall a. IO a -> (IOError -> IO a) -> IO a
`catchIOError` \ IOError
_ ->
      Bool -> IO Bool
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure Bool
False

pathIsDirectory :: OsPath -> IO Bool
pathIsDirectory :: OsString -> IO Bool
pathIsDirectory OsString
path =
  (IOError -> String -> IOError
`ioeAddLocation` String
"pathIsDirectory") (IOError -> IOError) -> IO Bool -> IO Bool
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    FileType -> Bool
fileTypeIsDirectory (FileType -> Bool) -> (Metadata -> FileType) -> Metadata -> Bool
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Metadata -> FileType
fileTypeFromMetadata (Metadata -> Bool) -> IO Metadata -> IO Bool
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> OsString -> IO Metadata
getFileMetadata OsString
path

-- | Create a /file/ symbolic link.  The target path can be either absolute or
-- relative and need not refer to an existing file.  The order of arguments
-- follows the POSIX convention.
--
-- To remove an existing file symbolic link, use 'removeFile'.
--
-- Although the distinction between /file/ symbolic links and /directory/
-- symbolic links does not exist on POSIX systems, on Windows this is an
-- intrinsic property of every symbolic link and cannot be changed without
-- recreating the link.  A file symbolic link that actually points to a
-- directory will fail to dereference and vice versa.  Moreover, creating
-- symbolic links on Windows may require privileges unavailable to users
-- outside the Administrators group.  Portable programs that use symbolic
-- links should take both into consideration.
--
-- On Windows, the function is implemented using @CreateSymbolicLink@.  Since
-- 1.3.3.0, the @SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE@ flag is included
-- if supported by the operating system.  On POSIX, the function uses @symlink@
-- and is therefore atomic.
--
-- Windows-specific errors: This operation may fail with 'permissionErrorType'
-- if the user lacks the privileges to create symbolic links.  It may also
-- fail with 'illegalOperationErrorType' if the file system does not support
-- symbolic links.
createFileLink
  :: OsPath                           -- ^ path to the target file
  -> OsPath                           -- ^ path of the link to be created
  -> IO ()
createFileLink :: OsString -> OsString -> IO ()
createFileLink OsString
target OsString
link =
  (IOError -> String -> IOError
`ioeAddLocation` String
"createFileLink") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    Bool -> OsString -> OsString -> IO ()
createSymbolicLink Bool
False OsString
target OsString
link

-- | Create a /directory/ symbolic link.  The target path can be either
-- absolute or relative and need not refer to an existing directory.  The
-- order of arguments follows the POSIX convention.
--
-- To remove an existing directory symbolic link, use 'removeDirectoryLink'.
--
-- Although the distinction between /file/ symbolic links and /directory/
-- symbolic links does not exist on POSIX systems, on Windows this is an
-- intrinsic property of every symbolic link and cannot be changed without
-- recreating the link.  A file symbolic link that actually points to a
-- directory will fail to dereference and vice versa.  Moreover, creating
-- symbolic links on Windows may require privileges unavailable to users
-- outside the Administrators group.  Portable programs that use symbolic
-- links should take both into consideration.
--
-- On Windows, the function is implemented using @CreateSymbolicLink@ with
-- @SYMBOLIC_LINK_FLAG_DIRECTORY@.  Since 1.3.3.0, the
-- @SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE@ flag is also included if
-- supported by the operating system.   On POSIX, this is an alias for
-- 'createFileLink' and is therefore atomic.
--
-- Windows-specific errors: This operation may fail with 'permissionErrorType'
-- if the user lacks the privileges to create symbolic links.  It may also
-- fail with 'illegalOperationErrorType' if the file system does not support
-- symbolic links.
createDirectoryLink
  :: OsPath                           -- ^ path to the target directory
  -> OsPath                           -- ^ path of the link to be created
  -> IO ()
createDirectoryLink :: OsString -> OsString -> IO ()
createDirectoryLink OsString
target OsString
link =
  (IOError -> String -> IOError
`ioeAddLocation` String
"createDirectoryLink") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    Bool -> OsString -> OsString -> IO ()
createSymbolicLink Bool
True OsString
target OsString
link

-- | Remove an existing /directory/ symbolic link.
--
-- On Windows, this is an alias for 'removeDirectory'.  On POSIX systems, this
-- is an alias for 'removeFile'.
--
-- See also: 'removeFile', which can remove an existing /file/ symbolic link.
removeDirectoryLink :: OsPath -> IO ()
removeDirectoryLink :: OsString -> IO ()
removeDirectoryLink OsString
path =
  (IOError -> String -> IOError
`ioeAddLocation` String
"removeDirectoryLink") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    Bool -> OsString -> IO ()
removePathInternal Bool
linkToDirectoryIsDirectory OsString
path

-- | Check whether an existing @path@ is a symbolic link.  If @path@ is a
-- regular file or directory, 'False' is returned.  If @path@ does not exist
-- or is otherwise inaccessible, an exception is thrown (see below).
--
-- On Windows, this checks for @FILE_ATTRIBUTE_REPARSE_POINT@.  In addition to
-- symbolic links, the function also returns true on junction points.  On
-- POSIX systems, this checks for @S_IFLNK@.
--
-- The operation may fail with:
--
-- * 'isDoesNotExistError' if the symbolic link does not exist; or
--
-- * 'isPermissionError' if the user is not permitted to read the symbolic
--   link.
pathIsSymbolicLink :: OsPath -> IO Bool
pathIsSymbolicLink :: OsString -> IO Bool
pathIsSymbolicLink OsString
path =
  ((IOError -> String -> IOError
`ioeAddLocation` String
"pathIsSymbolicLink") (IOError -> IOError) -> (IOError -> IOError) -> IOError -> IOError
forall b c a. (b -> c) -> (a -> b) -> a -> c
.
   (IOError -> OsString -> IOError
`ioeSetOsPath` OsString
path)) (IOError -> IOError) -> IO Bool -> IO Bool
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
     FileType -> Bool
fileTypeIsLink (FileType -> Bool) -> (Metadata -> FileType) -> Metadata -> Bool
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Metadata -> FileType
fileTypeFromMetadata (Metadata -> Bool) -> IO Metadata -> IO Bool
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> OsString -> IO Metadata
getSymbolicLinkMetadata OsString
path

-- | Retrieve the target path of either a file or directory symbolic link.
-- The returned path may not be absolute, may not exist, and may not even be a
-- valid path.
--
-- On Windows systems, this calls @DeviceIoControl@ with
-- @FSCTL_GET_REPARSE_POINT@.  In addition to symbolic links, the function
-- also works on junction points.  On POSIX systems, this calls @readlink@.
--
-- Windows-specific errors: This operation may fail with
-- 'illegalOperationErrorType' if the file system does not support symbolic
-- links.
getSymbolicLinkTarget :: OsPath -> IO OsPath
getSymbolicLinkTarget :: OsString -> IO OsString
getSymbolicLinkTarget OsString
path =
  (IOError -> String -> IOError
`ioeAddLocation` String
"getSymbolicLinkTarget") (IOError -> IOError) -> IO OsString -> IO OsString
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> IO OsString
readSymbolicLink OsString
path

-- | Obtain the time at which the file or directory was last accessed.
--
-- The operation may fail with:
--
-- * 'isPermissionError' if the user is not permitted to read
--   the access time; or
--
-- * 'isDoesNotExistError' if the file or directory does not exist.
--
-- Caveat for POSIX systems: This function returns a timestamp with sub-second
-- resolution only if this package is compiled against @unix-2.6.0.0@ or later
-- and the underlying filesystem supports them.
--
getAccessTime :: OsPath -> IO UTCTime
getAccessTime :: OsString -> IO UTCTime
getAccessTime OsString
path =
  (IOError -> String -> IOError
`ioeAddLocation` String
"getAccessTime") (IOError -> IOError) -> IO UTCTime -> IO UTCTime
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    Metadata -> UTCTime
accessTimeFromMetadata (Metadata -> UTCTime) -> IO Metadata -> IO UTCTime
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> OsString -> IO Metadata
getFileMetadata (OsString -> OsString
emptyToCurDir OsString
path)

-- | Obtain the time at which the file or directory was last modified.
--
-- The operation may fail with:
--
-- * 'isPermissionError' if the user is not permitted to read
--   the modification time; or
--
-- * 'isDoesNotExistError' if the file or directory does not exist.
--
-- Caveat for POSIX systems: This function returns a timestamp with sub-second
-- resolution only if this package is compiled against @unix-2.6.0.0@ or later
-- and the underlying filesystem supports them.
--
getModificationTime :: OsPath -> IO UTCTime
getModificationTime :: OsString -> IO UTCTime
getModificationTime OsString
path =
  (IOError -> String -> IOError
`ioeAddLocation` String
"getModificationTime") (IOError -> IOError) -> IO UTCTime -> IO UTCTime
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    Metadata -> UTCTime
modificationTimeFromMetadata (Metadata -> UTCTime) -> IO Metadata -> IO UTCTime
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> OsString -> IO Metadata
getFileMetadata (OsString -> OsString
emptyToCurDir OsString
path)

-- | Change the time at which the file or directory was last accessed.
--
-- The operation may fail with:
--
-- * 'isPermissionError' if the user is not permitted to alter the
--   access time; or
--
-- * 'isDoesNotExistError' if the file or directory does not exist.
--
-- Some caveats for POSIX systems:
--
-- * Not all systems support @utimensat@, in which case the function can only
--   emulate the behavior by reading the modification time and then setting
--   both the access and modification times together.  On systems where
--   @utimensat@ is supported, the access time is set atomically with
--   nanosecond precision.
--
-- * If compiled against a version of @unix@ prior to @2.7.0.0@, the function
--   would not be able to set timestamps with sub-second resolution.  In this
--   case, there would also be loss of precision in the modification time.
--
setAccessTime :: OsPath -> UTCTime -> IO ()
setAccessTime :: OsString -> UTCTime -> IO ()
setAccessTime OsString
path UTCTime
atime =
  (IOError -> String -> IOError
`ioeAddLocation` String
"setAccessTime") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> (Maybe UTCTime, Maybe UTCTime) -> IO ()
setFileTimes OsString
path (UTCTime -> Maybe UTCTime
forall a. a -> Maybe a
Just UTCTime
atime, Maybe UTCTime
forall a. Maybe a
Nothing)

-- | Change the time at which the file or directory was last modified.
--
-- The operation may fail with:
--
-- * 'isPermissionError' if the user is not permitted to alter the
--   modification time; or
--
-- * 'isDoesNotExistError' if the file or directory does not exist.
--
-- * 'InvalidArgument' on FAT32 file system if the time is before
--   DOS Epoch (1 January 1980).
--
-- Some caveats for POSIX systems:
--
-- * Not all systems support @utimensat@, in which case the function can only
--   emulate the behavior by reading the access time and then setting both the
--   access and modification times together.  On systems where @utimensat@ is
--   supported, the modification time is set atomically with nanosecond
--   precision.
--
-- * If compiled against a version of @unix@ prior to @2.7.0.0@, the function
--   would not be able to set timestamps with sub-second resolution.  In this
--   case, there would also be loss of precision in the access time.
--
setModificationTime :: OsPath -> UTCTime -> IO ()
setModificationTime :: OsString -> UTCTime -> IO ()
setModificationTime OsString
path UTCTime
mtime =
  (IOError -> String -> IOError
`ioeAddLocation` String
"setModificationTime") (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> (Maybe UTCTime, Maybe UTCTime) -> IO ()
setFileTimes OsString
path (Maybe UTCTime
forall a. Maybe a
Nothing, UTCTime -> Maybe UTCTime
forall a. a -> Maybe a
Just UTCTime
mtime)

setFileTimes :: OsPath -> (Maybe UTCTime, Maybe UTCTime) -> IO ()
setFileTimes :: OsString -> (Maybe UTCTime, Maybe UTCTime) -> IO ()
setFileTimes OsString
_ (Maybe UTCTime
Nothing, Maybe UTCTime
Nothing) = () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()
setFileTimes OsString
path (Maybe UTCTime
atime, Maybe UTCTime
mtime) =
  ((IOError -> String -> IOError
`ioeAddLocation` String
"setFileTimes") (IOError -> IOError) -> (IOError -> IOError) -> IOError -> IOError
forall b c a. (b -> c) -> (a -> b) -> a -> c
.
   (IOError -> OsString -> IOError
`ioeSetOsPath` OsString
path)) (IOError -> IOError) -> IO () -> IO ()
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> (Maybe POSIXTime, Maybe POSIXTime) -> IO ()
setTimes (OsString -> OsString
emptyToCurDir OsString
path)
             (UTCTime -> POSIXTime
utcTimeToPOSIXSeconds (UTCTime -> POSIXTime) -> Maybe UTCTime -> Maybe POSIXTime
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Maybe UTCTime
atime, UTCTime -> POSIXTime
utcTimeToPOSIXSeconds (UTCTime -> POSIXTime) -> Maybe UTCTime -> Maybe POSIXTime
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Maybe UTCTime
mtime)

{- | Returns the current user's home directory.

The directory returned is expected to be writable by the current user,
but note that it isn't generally considered good practice to store
application-specific data here; use 'getXdgDirectory' or
'getAppUserDataDirectory' instead.

On Unix, 'getHomeDirectory' behaves as follows:

* Returns $HOME env variable if set (including to an empty string).
* Otherwise uses home directory returned by `getpwuid_r` using the UID of the current proccesses user. This basically reads the /etc/passwd file. An empty home directory field is considered valid.

On Windows, the system is queried for a suitable path; a typical path might be @C:\/Users\//\<user\>/@.

The operation may fail with:

* @UnsupportedOperation@
The operating system has no notion of home directory.

* 'isDoesNotExistError'
The home directory for the current user does not exist, or
cannot be found.
-}
getHomeDirectory :: IO OsPath
getHomeDirectory :: IO OsString
getHomeDirectory =
  (IOError -> String -> IOError
`ioeAddLocation` String
"getHomeDirectory") (IOError -> IOError) -> IO OsString -> IO OsString
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    getHomeDirectoryInternal

-- | Obtain the paths to special directories for storing user-specific
--   application data, configuration, and cache files, conforming to the
--   <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html XDG Base Directory Specification>.
--   Compared with 'getAppUserDataDirectory', this function provides a more
--   fine-grained hierarchy as well as greater flexibility for the user.
--
--   On Windows, 'XdgData' and 'XdgConfig' usually map to the same directory
--   unless overridden.
--
--   Refer to the docs of 'XdgDirectory' for more details.
--
--   The second argument is usually the name of the application.  Since it
--   will be integrated into the path, it must consist of valid path
--   characters.  Note: if the second argument is an absolute path, it will
--   just return the second argument.
--
--   Note: The directory may not actually exist, in which case you would need
--   to create it with file mode @700@ (i.e. only accessible by the owner).
--
--   As of 1.3.5.0, the environment variable is ignored if set to a relative
--   path, per revised XDG Base Directory Specification.  See
--   <https://github.com/haskell/directory/issues/100 #100>.
getXdgDirectory :: XdgDirectory         -- ^ which special directory
                -> OsPath             -- ^ a relative path that is appended
                                        --   to the path; if empty, the base
                                        --   path is returned
                -> IO OsPath
getXdgDirectory :: XdgDirectory -> OsString -> IO OsString
getXdgDirectory XdgDirectory
xdgDir OsString
suffix =
  (IOError -> String -> IOError
`ioeAddLocation` String
"getXdgDirectory") (IOError -> IOError) -> IO OsString -> IO OsString
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> OsString
simplify (OsString -> OsString)
-> (OsString -> OsString) -> OsString -> OsString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (OsString -> OsString -> OsString
</> OsString
suffix) (OsString -> OsString) -> IO OsString -> IO OsString
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> do
      env <- OsString -> IO (Maybe OsString)
lookupEnvOs (OsString -> IO (Maybe OsString))
-> (String -> OsString) -> String -> IO (Maybe OsString)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> OsString
os (String -> IO (Maybe OsString)) -> String -> IO (Maybe OsString)
forall a b. (a -> b) -> a -> b
$ case XdgDirectory
xdgDir of
        XdgDirectory
XdgData   -> String
"XDG_DATA_HOME"
        XdgDirectory
XdgConfig -> String
"XDG_CONFIG_HOME"
        XdgDirectory
XdgCache  -> String
"XDG_CACHE_HOME"
        XdgDirectory
XdgState  -> String
"XDG_STATE_HOME"
      case env of
        Just OsString
path | OsString -> Bool
isAbsolute OsString
path -> OsString -> IO OsString
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure OsString
path
        Maybe OsString
_                           -> IO OsString -> XdgDirectory -> IO OsString
getXdgDirectoryFallback IO OsString
getHomeDirectory XdgDirectory
xdgDir

-- | Similar to 'getXdgDirectory' but retrieves the entire list of XDG
-- directories.
--
-- On Windows, 'XdgDataDirs' and 'XdgConfigDirs' usually map to the same list
-- of directories unless overridden.
--
-- Refer to the docs of 'XdgDirectoryList' for more details.
getXdgDirectoryList :: XdgDirectoryList -- ^ which special directory list
                    -> IO [OsPath]
getXdgDirectoryList :: XdgDirectoryList -> IO [OsString]
getXdgDirectoryList XdgDirectoryList
xdgDirs =
  (IOError -> String -> IOError
`ioeAddLocation` String
"getXdgDirectoryList") (IOError -> IOError) -> IO [OsString] -> IO [OsString]
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    env <- OsString -> IO (Maybe OsString)
lookupEnvOs (OsString -> IO (Maybe OsString))
-> (String -> OsString) -> String -> IO (Maybe OsString)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> OsString
os (String -> IO (Maybe OsString)) -> String -> IO (Maybe OsString)
forall a b. (a -> b) -> a -> b
$ case XdgDirectoryList
xdgDirs of
      XdgDirectoryList
XdgDataDirs   -> String
"XDG_DATA_DIRS"
      XdgDirectoryList
XdgConfigDirs -> String
"XDG_CONFIG_DIRS"
    case env of
      Maybe OsString
Nothing    -> XdgDirectoryList -> IO [OsString]
getXdgDirectoryListFallback XdgDirectoryList
xdgDirs
      Just OsString
paths -> [OsString] -> IO [OsString]
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure (OsString -> [OsString]
splitSearchPath OsString
paths)

-- | Obtain the path to a special directory for storing user-specific
--   application data (traditional Unix location).  Newer applications may
--   prefer the the XDG-conformant location provided by 'getXdgDirectory'
--   (<https://github.com/haskell/directory/issues/6#issuecomment-96521020 migration guide>).
--
--   The argument is usually the name of the application.  Since it will be
--   integrated into the path, it must consist of valid path characters.
--
--   * On Unix-like systems, the path is @~\/./\<app\>/@.
--   * On Windows, the path is @%APPDATA%\//\<app\>/@
--     (e.g. @C:\/Users\//\<user\>/\/AppData\/Roaming\//\<app\>/@)
--
--   Note: the directory may not actually exist, in which case you would need
--   to create it.  It is expected that the parent directory exists and is
--   writable.
--
--   The operation may fail with:
--
--   * @UnsupportedOperation@
--     The operating system has no notion of application-specific data
--     directory.
--
--   * 'isDoesNotExistError'
--     The home directory for the current user does not exist, or cannot be
--     found.
--
getAppUserDataDirectory :: OsPath     -- ^ a relative path that is appended
                                        --   to the path
                        -> IO OsPath
getAppUserDataDirectory :: OsString -> IO OsString
getAppUserDataDirectory OsString
appName = do
  (IOError -> String -> IOError
`ioeAddLocation` String
"getAppUserDataDirectory") (IOError -> IOError) -> IO OsString -> IO OsString
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    OsString -> IO OsString
getAppUserDataDirectoryInternal OsString
appName

{- | Returns the current user's document directory.

The directory returned is expected to be writable by the current user,
but note that it isn't generally considered good practice to store
application-specific data here; use 'getXdgDirectory' or
'getAppUserDataDirectory' instead.

On Unix, 'getUserDocumentsDirectory' returns the value of the @HOME@
environment variable.  On Windows, the system is queried for a
suitable path; a typical path might be @C:\/Users\//\<user\>/\/Documents@.

The operation may fail with:

* @UnsupportedOperation@
The operating system has no notion of document directory.

* 'isDoesNotExistError'
The document directory for the current user does not exist, or
cannot be found.
-}
getUserDocumentsDirectory :: IO OsPath
getUserDocumentsDirectory :: IO OsString
getUserDocumentsDirectory = do
  (IOError -> String -> IOError
`ioeAddLocation` String
"getUserDocumentsDirectory") (IOError -> IOError) -> IO OsString -> IO OsString
forall a. (IOError -> IOError) -> IO a -> IO a
`modifyIOError` do
    getUserDocumentsDirectoryInternal

{- | Returns the current directory for temporary files.

On Unix, 'getTemporaryDirectory' returns the value of the @TMPDIR@
environment variable or \"\/tmp\" if the variable isn\'t defined.
On Windows, the function checks for the existence of environment variables in
the following order and uses the first path found:

*
TMP environment variable.

*
TEMP environment variable.

*
USERPROFILE environment variable.

*
The Windows directory

The operation may fail with:

* @UnsupportedOperation@
The operating system has no notion of temporary directory.

The function doesn\'t verify whether the path exists.
-}
getTemporaryDirectory :: IO OsPath
getTemporaryDirectory :: IO OsString
getTemporaryDirectory = IO OsString
getTemporaryDirectoryInternal

-- | Get the contents of the @PATH@ environment variable.
getExecSearchPath :: IO [OsPath]
getExecSearchPath :: IO [OsString]
getExecSearchPath = IO [OsString]
getPath