import qualified Annex.SpecialRemote as SpecialRemote
import qualified Annex.Branch
import qualified Annex.BranchState
+import qualified Annex.Url as Url
import qualified Types.Remote as Remote
import qualified Logs.Remote
import qualified Remote.External
import Network.URI
import Data.Either
+import Data.Char
import qualified Data.ByteString as B
import qualified Data.ByteString.Char8 as B8
import qualified Data.Map.Strict as M
import qualified Data.Set as S
run :: [String] -> IO ()
-run (remotename:url:[]) =
- -- git strips the "annex::" prefix of the url
- -- when running this command, so add it back
- let url' = "annex::" ++ url
- in case parseSpecialRemoteNameUrl remotename url' of
- Left e -> giveup e
- Right src -> do
- repo <- getRepo
- state <- Annex.new repo
- Annex.eval state (run' src url')
+run (remotename:url:[]) = do
+ repo <- getRepo
+ state <- Annex.new repo
+ Annex.eval state $
+ resolveSpecialRemoteWebUrl url >>= \case
+ -- git strips the "annex::" prefix of the url
+ -- when running this command, so add it back
+ Nothing -> parseurl ("annex::" ++ url) pure
+ Just url' -> parseurl url' checkAllowedFromSpecialRemoteWebUrl
+ where
+ parseurl u checkallowed =
+ case parseSpecialRemoteNameUrl remotename u of
+ Right src -> checkallowed src >>= run' u
+ Left e -> giveup e
run (_remotename:[]) = giveup "remote url not configured"
run _ = giveup "expected remote name and url parameters"
-run' :: SpecialRemoteConfig -> String -> Annex ()
-run' src url = do
+run' :: String -> SpecialRemoteConfig -> Annex ()
+run' url src = do
sab <- startAnnexBranch
whenM (Annex.getRead Annex.debugenabled) $
enableDebugOutput
let (k, sv) = break (== '=') kv
v = if null sv then sv else drop 1 sv
in (Proposed (unEscapeString k), Proposed (unEscapeString v))
-
+
+-- Handles an url that contains a http address, by downloading
+-- the web page and using it as the full annex:: url.
+-- The passed url has already had "annex::" stripped off.
+resolveSpecialRemoteWebUrl :: String -> Annex (Maybe String)
+resolveSpecialRemoteWebUrl url
+ | "http://" `isPrefixOf` lcurl || "https://" `isPrefixOf` lcurl =
+ Url.withUrlOptionsPromptingCreds $ \uo ->
+ withTmpFile "git-remote-annex" $ \tmp h -> do
+ liftIO $ hClose h
+ Url.download' nullMeterUpdate Nothing url tmp uo >>= \case
+ Left err -> giveup $ url ++ " " ++ err
+ Right () -> liftIO $
+ (headMaybe . lines)
+ <$> readFileStrict tmp
+ | otherwise = return Nothing
+ where
+ lcurl = map toLower url
+
+-- Only some types of special remotes are allowed to come from
+-- resolveSpecialRemoteWebUrl. Throws an error if this one is not.
+checkAllowedFromSpecialRemoteWebUrl :: SpecialRemoteConfig -> Annex SpecialRemoteConfig
+checkAllowedFromSpecialRemoteWebUrl src@(ExistingSpecialRemote {}) = pure src
+checkAllowedFromSpecialRemoteWebUrl src@(SpecialRemoteConfig {}) =
+ case M.lookup typeField (specialRemoteConfig src) of
+ Nothing -> giveup "Web URL did not include a type field."
+ Just t
+ | t == Proposed "httpalso" -> return src
+ | otherwise -> giveup "Web URL can only be used for a httpalso special remote."
+
getSpecialRemoteUrl :: Remote -> Annex (Maybe String)
getSpecialRemoteUrl rmt = do
rcp <- Remote.configParser (Remote.remotetype rmt)
This is a git remote helper program that allows git to clone,
pull and push from a git repository that is stored in a git-annex
-special remote.
+special remote with an URL that starts with "annex::"
-The format of the remote URL is "annex::" followed by the UUID of the
-special remote, and then followed by all of the configuration parameters of
-the special remote.
+The special remote needs to have a `remote.<name>.url`
+configured to use this. That is set up automatically when git
+cloning from a special remote.
-For example, to clone from a directory special remote:
+To make [[git-annex-initremote]](1) and [[git-annex-enableremote]](1)
+configure the url, pass them the `--with-url` option.
- git clone annex::358ff77e-0bc3-11ef-bc49-872e6695c0e3?type=directory&encryption=none&directory=/mnt/foo/
+Or, to configure an existing special remote with a shorthand URL, run:
-But you don't need to generate such an url yourself. Instead, you can use
-the shorthand url of "annex::" with an existing special remote.
+ git config remote.name.url annex::
- git-annex initremote foo type=directory encryption=none directory=/mnt/foo
- git config remote.foo.url annex::
- git push foo master
+Once the URL is configured, you can use `git pull`, `git push`, etc
+with the special remote much like with any other git remote.
+But see CONFLICTING PUSHES below for some situations where it behaves
+slightly differently.
-Configuring the url like that is automatically done when cloning from a
-special remote. To make [[git-annex-initremote]](1) and
-[[git-annex-enableremote]](1) configure the url, pass them the `--with-url`
-option.
+# URL FORMAT
-When using the shorthand "annex::" url, the full url will be displayed
-each time you git pull or push, when it's possible for git-annex to
-determine it.
+This uses an URL that starts with "annex::". There are three forms of such
+URLs:
+
+* Complete URL
+
+ This contains the UUID and all configuration parameters
+ of the special remote that were passed when using
+ `git-annex initremote`.
+
+ For example, to clone from a directory special remote:
+
+ git clone annex::358ff77e-0bc3-11ef-bc49-872e6695c0e3?type=directory&encryption=none&directory=/mnt/foo/
+
+* Shorthand URL
+
+ This makes it easy to configure an existing special remote with an URL
+ without having to come up with the complete URL.
+
+ annex::
+
+ When using this shorthand URL, the full URL will be displayed each time you
+ git pull or push, when it's possible for git-annex to determine it.
+ (Although in some cases, like the directory special remote, some
+ parameters may be left off of the displayed URL.)
+
+* Web URL
+
+ This URL points at a file on the web, which contains the complete annex::
+ URL.
+
+ annex::https://example.com/foo-repo
+
+ Not all special remotes can be accessed by such an URL,
+ for security reasons. Currently, this is limited to httpalso special
+ remotes.
# CONFLICTING PUSHES
situation, the overwritten push will appear to have succeeded, but pulling
later will show the true situation.
-# HTTP ACCESS
+# HTTPALSO
If the content of a special remote is published via http, a httpalso
special remote can be initialized, and used to `git clone` and `git fetch`
over http.
-For example, if the directory special remote set up above is published
+For example, a directory special remote named "foo" is published
at `https://example.com/foo/`, set up the httpalso remote like this
to access it:
> Perhaps it could be limited to safe special remotes. httpalso is surely
> safe in this context. Would anything else be? Any external special
> remotes? --[[Joey]]
+
+>> Implemented this, but it was being a bit hard to handle a redirect to an
+>> annex:: url, and in any case with httpalso, the user has a web server
+>> they can host files on. So made the url be downloaded as a file, and
+>> the first line contains the complete annex:: url. [[done]]
projects / git-annex.git / commitdiff