Safe Haskell | None |
---|---|
Language | Haskell2010 |
Synopsis
- data FileName
- fp2fn :: FilePath -> FileName
- fn2fp :: FileName -> FilePath
- fn2ps :: FileName -> ByteString
- ps2fn :: ByteString -> FileName
- breakOnDir :: FileName -> Maybe (FileName, FileName)
- normPath :: FileName -> FileName
- ownName :: FileName -> FileName
- superName :: FileName -> FileName
- movedirfilename :: FileName -> FileName -> FileName -> FileName
- encodeWhite :: FilePath -> String
- decodeWhite :: String -> FilePath
- encodeWhiteName :: Name -> ByteString
- decodeWhiteName :: ByteString -> Name
- isParentOrEqOf :: FileName -> FileName -> Bool
- data AbsolutePath
- makeAbsolute :: AbsolutePath -> FilePath -> AbsolutePath
- ioAbsolute :: FilePath -> IO AbsolutePath
- rootDirectory :: AbsolutePath
- data AbsolutePathOrStd
- makeAbsoluteOrStd :: AbsolutePath -> String -> AbsolutePathOrStd
- ioAbsoluteOrStd :: String -> IO AbsolutePathOrStd
- useAbsoluteOrStd :: (AbsolutePath -> a) -> a -> AbsolutePathOrStd -> a
- stdOut :: AbsolutePathOrStd
- data AbsoluteOrRemotePath
- ioAbsoluteOrRemote :: String -> IO AbsoluteOrRemotePath
- isRemote :: AbsoluteOrRemotePath -> Bool
- data SubPath
- makeSubPathOf :: AbsolutePath -> AbsolutePath -> Maybe SubPath
- simpleSubPath :: FilePath -> Maybe SubPath
- isSubPathOf :: SubPath -> SubPath -> Bool
- floatSubPath :: SubPath -> AnchoredPath
- sp2fn :: SubPath -> FileName
- class FilePathOrURL a where
- class FilePathOrURL a => FilePathLike a where
- toFilePath :: a -> FilePath
- getCurrentDirectory :: IO AbsolutePath
- setCurrentDirectory :: FilePathLike p => p -> IO ()
- getUniquePathName :: Bool -> (FilePath -> String) -> (Int -> FilePath) -> IO FilePath
- doesPathExist :: FilePath -> IO Bool
- isMaliciousPath :: String -> Bool
- isMaliciousSubPath :: String -> Bool
- filterFilePaths :: [FilePath] -> AnchoredPath -> t -> Bool
- filterPaths :: [AnchoredPath] -> AnchoredPath -> t -> Bool
- data Name
- unsafeMakeName :: ByteString -> Name
- eqAnycase :: Name -> Name -> Bool
- newtype AnchoredPath = AnchoredPath [Name]
- anchoredRoot :: AnchoredPath
- appendPath :: AnchoredPath -> Name -> AnchoredPath
- anchorPath :: FilePath -> AnchoredPath -> FilePath
- isPrefix :: AnchoredPath -> AnchoredPath -> Bool
- parent :: AnchoredPath -> AnchoredPath
- parents :: AnchoredPath -> [AnchoredPath]
- catPaths :: AnchoredPath -> AnchoredPath -> AnchoredPath
- flatten :: AnchoredPath -> ByteString
- makeName :: String -> Name
- appendToName :: AnchoredPath -> String -> AnchoredPath
- floatPath :: FilePath -> AnchoredPath
- replacePrefixPath :: AnchoredPath -> AnchoredPath -> AnchoredPath -> AnchoredPath
Documentation
FileName is an abstract type intended to facilitate the input and output of unicode filenames.
fn2ps :: FileName -> ByteString Source #
ps2fn :: ByteString -> FileName Source #
normPath :: FileName -> FileName Source #
convert a path string into a sequence of directories strings "/", "." and ".." are generally interpreted as expected. Behaviour with too many '..' is to leave them.
Examples: Splitting: "aabbcc" -> ["aa","bb","cc"] Ignoring "." and extra "/": "aa.bb" -> ["aa","bb"] "aa//bb" -> ["aa","bb"] "aabb/" -> ["aa","bb"] Handling "..": "aa..bb/cc" -> ["bb","cc"] "aabb....cc" -> ["cc"] "aa..bb..cc" -> ["cc"] "../cc" -> ["..","cc"]
encodeWhite :: FilePath -> String Source #
encodeWhite
translates whitespace in filenames to a darcs-specific
format (numerical representation according to ord
surrounded by
backslashes). Note that backslashes are also escaped since they are used
in the encoding.
encodeWhite "hello there" == "hello\32\there" encodeWhite "hello\there" == "hello\92\there"
decodeWhite :: String -> FilePath Source #
decodeWhite
interprets the Darcs-specific "encoded" filenames
produced by encodeWhite
decodeWhite "hello\32\there" == "hello there" decodeWhite "hello\92\there" == "hello\there" decodeWhite "hello\there" == error "malformed filename"
encodeWhiteName :: Name -> ByteString Source #
decodeWhiteName :: ByteString -> Name Source #
AbsolutePath
data AbsolutePath Source #
Instances
Eq AbsolutePath Source # | |
Defined in Darcs.Util.Path (==) :: AbsolutePath -> AbsolutePath -> Bool # (/=) :: AbsolutePath -> AbsolutePath -> Bool # | |
Ord AbsolutePath Source # | |
Defined in Darcs.Util.Path compare :: AbsolutePath -> AbsolutePath -> Ordering # (<) :: AbsolutePath -> AbsolutePath -> Bool # (<=) :: AbsolutePath -> AbsolutePath -> Bool # (>) :: AbsolutePath -> AbsolutePath -> Bool # (>=) :: AbsolutePath -> AbsolutePath -> Bool # max :: AbsolutePath -> AbsolutePath -> AbsolutePath # min :: AbsolutePath -> AbsolutePath -> AbsolutePath # | |
Show AbsolutePath Source # | |
Defined in Darcs.Util.Path showsPrec :: Int -> AbsolutePath -> ShowS # show :: AbsolutePath -> String # showList :: [AbsolutePath] -> ShowS # | |
FilePathLike AbsolutePath Source # | |
Defined in Darcs.Util.Path toFilePath :: AbsolutePath -> FilePath Source # | |
FilePathOrURL AbsolutePath Source # | |
Defined in Darcs.Util.Path toPath :: AbsolutePath -> String Source # |
makeAbsolute :: AbsolutePath -> FilePath -> AbsolutePath Source #
Take an absolute path and a string representing a (possibly relative) path and combine them into an absolute path. If the second argument is already absolute, then the first argument gets ignored. This function also takes care that the result is converted to Posix convention and normalized. Also, parent directories ("..") at the front of the string argument get canceled out against trailing directory parts of the absolute path argument.
Regarding the last point, someone more familiar with how these functions are used should verify that this is indeed necessary or at least useful.
ioAbsolute :: FilePath -> IO AbsolutePath Source #
Interpret a possibly relative path wrt the current working directory.
rootDirectory :: AbsolutePath Source #
The root directory as an absolute path.
AbsolutePathOrStd
data AbsolutePathOrStd Source #
This is for situations where a string (e.g. a command line argument) may take the value "-" to mean stdin or stdout (which one depends on context) instead of a normal file path.
Instances
Eq AbsolutePathOrStd Source # | |
Defined in Darcs.Util.Path (==) :: AbsolutePathOrStd -> AbsolutePathOrStd -> Bool # (/=) :: AbsolutePathOrStd -> AbsolutePathOrStd -> Bool # | |
Ord AbsolutePathOrStd Source # | |
Defined in Darcs.Util.Path compare :: AbsolutePathOrStd -> AbsolutePathOrStd -> Ordering # (<) :: AbsolutePathOrStd -> AbsolutePathOrStd -> Bool # (<=) :: AbsolutePathOrStd -> AbsolutePathOrStd -> Bool # (>) :: AbsolutePathOrStd -> AbsolutePathOrStd -> Bool # (>=) :: AbsolutePathOrStd -> AbsolutePathOrStd -> Bool # max :: AbsolutePathOrStd -> AbsolutePathOrStd -> AbsolutePathOrStd # min :: AbsolutePathOrStd -> AbsolutePathOrStd -> AbsolutePathOrStd # | |
Show AbsolutePathOrStd Source # | |
Defined in Darcs.Util.Path showsPrec :: Int -> AbsolutePathOrStd -> ShowS # show :: AbsolutePathOrStd -> String # showList :: [AbsolutePathOrStd] -> ShowS # |
useAbsoluteOrStd :: (AbsolutePath -> a) -> a -> AbsolutePathOrStd -> a Source #
Execute either the first or the second argument action, depending on
whether the given path is an AbsolutePath
or stdin/stdout.
AbsoluteOrRemotePath
data AbsoluteOrRemotePath Source #
Instances
isRemote :: AbsoluteOrRemotePath -> Bool Source #
SubPath
Paths which are relative to the local darcs repository and normalized. Note: These are understood not to have the dot in front.
makeSubPathOf :: AbsolutePath -> AbsolutePath -> Maybe SubPath Source #
Make the second path relative to the first, if possible
floatSubPath :: SubPath -> AnchoredPath Source #
Transform a SubPath into an AnchoredPath.
Miscellaneous
class FilePathOrURL a where Source #
Instances
FilePathOrURL AbsoluteOrRemotePath Source # | |
Defined in Darcs.Util.Path toPath :: AbsoluteOrRemotePath -> String Source # | |
FilePathOrURL AbsolutePath Source # | |
Defined in Darcs.Util.Path toPath :: AbsolutePath -> String Source # | |
FilePathOrURL SubPath Source # | |
FilePathOrURL FileName Source # | |
CharLike c => FilePathOrURL [c] Source # | |
Defined in Darcs.Util.Path |
class FilePathOrURL a => FilePathLike a where Source #
toFilePath :: a -> FilePath Source #
Instances
FilePathLike AbsolutePath Source # | |
Defined in Darcs.Util.Path toFilePath :: AbsolutePath -> FilePath Source # | |
FilePathLike SubPath Source # | |
Defined in Darcs.Util.Path toFilePath :: SubPath -> FilePath Source # | |
FilePathLike FileName Source # | |
Defined in Darcs.Util.Path toFilePath :: FileName -> FilePath Source # | |
CharLike c => FilePathLike [c] Source # | |
Defined in Darcs.Util.Path toFilePath :: [c] -> FilePath Source # |
setCurrentDirectory :: FilePathLike p => p -> IO () Source #
getUniquePathName :: Bool -> (FilePath -> String) -> (Int -> FilePath) -> IO FilePath Source #
Iteratively tries find first non-existing path generated by buildName, it feeds to buildName the number starting with -1. When it generates non-existing path and it isn't first, it displays the message created with buildMsg. Usually used for generation of the name like path_number when path already exist (e.g. darcs.net_0).
Check for malicious paths
isMaliciousPath :: String -> Bool Source #
What is a malicious path?
A spoofed path is a malicious path.
- Darcs only creates explicitly relative paths (beginning with
"./"
), so any not explicitly relative path is surely spoofed. - Darcs normalizes paths so they never contain
"/../"
, so paths with"/../"
are surely spoofed.
A path to a darcs repository's meta data can modify "trusted" patches or
change safety defaults in that repository, so we check for paths
containing "/_darcs/"
which is the entry to darcs meta data.
To do?
- How about get repositories?
- Would it be worth adding a --semi-safe-paths option for allowing changes to certain preference files (_darcs/prefs/) in sub repositories'?
TODO: Properly review the way we handle paths on Windows - it's not enough to just use the OS native concept of path separator. Windows often accepts both path separators, and repositories always use the UNIX separator anyway.
isMaliciousSubPath :: String -> Bool Source #
Warning : this is less rigorous than isMaliciousPath but it's to allow for subpath representations that don't start with ./
Tree filtering.
filterFilePaths :: [FilePath] -> AnchoredPath -> t -> Bool Source #
Same as filterPath
, but for ordinary FilePath
s (as opposed to
AnchoredPath).
filterPaths :: [AnchoredPath] -> AnchoredPath -> t -> Bool Source #
Construct a filter from a list of AnchoredPaths, that will accept any path that is either a parent or a child of any of the listed paths, and discard everything else.
AnchoredPaths: relative paths within a Tree. All paths are
unsafeMakeName :: ByteString -> Name Source #
newtype AnchoredPath Source #
This is a type of "sane" file paths. These are always canonic in the sense that there are no stray slashes, no ".." components and similar. They are usually used to refer to a location within a Tree, but a relative filesystem path works just as well. These are either constructed from individual name components (using "appendPath", "catPaths" and "makeName"), or converted from a FilePath ("floatPath" -- but take care when doing that) or .
Instances
appendPath :: AnchoredPath -> Name -> AnchoredPath Source #
Append an element to the end of a path.
anchorPath :: FilePath -> AnchoredPath -> FilePath Source #
isPrefix :: AnchoredPath -> AnchoredPath -> Bool Source #
Check whether a path is a prefix of another path.
parent :: AnchoredPath -> AnchoredPath Source #
Get parent (path) of a given path. foobarbaz -> foo/bar
parents :: AnchoredPath -> [AnchoredPath] Source #
List all parents of a given path. foobarbaz -> [foo, foo/bar]
catPaths :: AnchoredPath -> AnchoredPath -> AnchoredPath Source #
Catenate two paths together. Not very safe, but sometimes useful (e.g. when you are representing paths relative to a different point than a Tree root).
flatten :: AnchoredPath -> ByteString Source #
appendToName :: AnchoredPath -> String -> AnchoredPath Source #
Append a String to the last Name of an AnchoredPath.
Unsafe AnchoredPath functions.
floatPath :: FilePath -> AnchoredPath Source #
Take a relative FilePath and turn it into an AnchoredPath. The operation is (relatively) unsafe. Basically, by using floatPath, you are testifying that the argument is a path relative to some common root -- i.e. the root of the associated Tree object. Also, there are certain invariants about AnchoredPath that this function tries hard to preserve, but probably cannot guarantee (i.e. this is a best-effort thing). You should sanitize any FilePaths before you declare them "good" by converting into AnchoredPath (using this function).
replacePrefixPath :: AnchoredPath -> AnchoredPath -> AnchoredPath -> AnchoredPath Source #
Take a prefix path, the changed prefix path, and a path to change. Assumes the prefix path is a valid prefix. If prefix is wrong return AnchoredPath [].