Data.FileStore.Utils

Utility functions for running external processes.

Documentation

runShellCommand

Arguments

:: FilePath

Working directory

-> Maybe [(String, String)]

Environment

-> String

Command

-> [String]

Arguments

-> IO (ExitCode, ByteString, ByteString)

Run shell command and return error status, standard output, and error output. Assumes UTF-8 locale. Note that this does not actually go through /bin/sh!

mergeContents

Arguments

:: (String, ByteString)

(label, contents) of edited version

-> (String, ByteString)

(label, contents) of original revision

-> (String, ByteString)

(label, contents) of latest version

-> IO (Bool, String)

(were there conflicts?, merged contents)

Do a three way merge, using either git merge-file or RCS merge. Assumes that either git or merge is in the system path. Assumes UTF-8 locale.

hashsMatch :: Eq a => [a] -> [a] -> Bool

A number of VCS systems uniquely identify a particular revision or change via a cryptographic hash of some sort. These hashs can be very long, and so systems like Git and Darcs don't require the entire hash - a *unique prefix*. Thus a definition of hash equality is ==, certainly, but also simply whether either is a prefix of the other. If both are reasonably long, then the likelihood the shorter one is not a unique prefix of the longer (that is, clashes with another hash) is small. The burden of proof is on the caller to not pass a uselessly short short-hash like '1', however.

escapeRegexSpecialChars :: String -> String

parseMatchLine :: String -> SearchMatch

A parser function. This is intended for use on strings which are output by grep programs or programs which mimic the standard grep output - which uses colons as delimiters and has 3 fields: the filename, the line number, and then the matching line itself. Note that this is for use on only strings meeting that format - if it goes file:match, this will throw a pattern-match exception.

 parseMatchLine "foo:10:bar baz quux" ~> 
 SearchMatch {matchResourceName = "foo", matchLineNumber = 10, matchLine = "bar baz quux"}

splitEmailAuthor :: String -> (Maybe String, String)

Our policy is: if the input is clearly a name <[e-mail]> input, then we return (Just Address, Name) If there is no < in the input, then it clearly can't be of that format, and so we just return (Nothing, Name)

 splitEmailAuthor "foo bar [e-mail]" ~> (Nothing,"foo bar [e-mail]")
 splitEmailAuthor "foo bar <[e-mail]>" ~> (Just "[e-mail]","foo bar")

ensureFileExists :: FilePath -> FilePath -> IO ()

If name doesn't exist in repo or is not a file, throw NotFound exception.

regSearchFiles :: FilePath -> [String] -> String -> IO [String]

Search multiple files with a single regexp. This calls out to grep, and so supports the regular expressions grep does.

regsSearchFile :: [String] -> FilePath -> [String] -> String -> IO [String]

Search a single file with multiple regexps.

withSanityCheck :: FilePath -> [FilePath] -> FilePath -> IO b -> IO b

Check that the filename/location is within the given repo, and not inside any of the (relative) paths in excludes. Create the directory if needed. If everything checks out, then perform the specified action.

grepSearchRepo :: (FilePath -> IO [String]) -> FilePath -> SearchQuery -> IO [SearchMatch]

Uses grep to search a file-based repository. Note that this calls out to grep; and so is generic over repos like git or darcs-based repos. (The git FileStore instance doesn't use this because git has builtin grep functionality.) Expected usage is to specialize this function with a particular backend's index.

withVerifyDir :: FilePath -> IO a -> IO a

we don't actually need the contents, just want to check that the directory exists and we have enough permissions

encodeArg :: String -> String

Encode argument for raw command.