darcs-2.10.1: a distributed, interactive, smart revision control system

Safe HaskellNone





data FileName Source

FileName is an abstract type intended to facilitate the input and output of unicode filenames.

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"


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.


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.

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.



data SubPath Source

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.


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.

  1. Darcs only creates explicitly relative paths (beginning with "./"), so any not explicitly relative path is surely spoofed.
  2. 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'?

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 FilePaths (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.