1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
{- git-annex import types
-
- Copyright 2019-2021 Joey Hess <id@joeyh.name>
-
- Licensed under the GNU AGPL version 3 or higher.
-}
{-# LANGUAGE DeriveGeneric #-}
module Types.Import where
import qualified Data.ByteString as S
import Data.Char
import Control.DeepSeq
import GHC.Generics
import qualified System.FilePath.Posix.ByteString as Posix
import Types.Export
import Utility.QuickCheck
import Utility.FileSystemEncoding
{- Location of content on a remote that can be imported.
- This is just an alias to ExportLocation, because both are referring to a
- location on the remote. -}
type ImportLocation = ExportLocation
mkImportLocation :: RawFilePath -> ImportLocation
mkImportLocation = mkExportLocation
fromImportLocation :: ImportLocation -> RawFilePath
fromImportLocation = fromExportLocation
{- An identifier for content stored on a remote that has been imported into
- the repository. It should be reasonably short since it is stored in the
- git-annex branch.
-
- Since other things than git-annex can modify files on import remotes,
- and git-annex then be used to import those modifications, the
- ContentIdentifier needs to change when a file gets changed in such a
- way. Device, inode, and size is one example of a good content
- identifier. Or a hash if the remote's interface exposes hashes.
-}
newtype ContentIdentifier = ContentIdentifier S.ByteString
deriving (Eq, Ord, Show, Generic)
instance NFData ContentIdentifier
instance Arbitrary ContentIdentifier where
-- Avoid non-ascii ContentIdentifiers because fully arbitrary
-- strings may not be encoded using the filesystem
-- encoding, which is normally applied to all input.
arbitrary = ContentIdentifier . encodeBS
<$> arbitrary `suchThat` all isAscii
{- List of files that can be imported from a remote, each with some added
- information. -}
data ImportableContents info = ImportableContents
{ importableContents :: [(ImportLocation, info)]
, importableHistory :: [ImportableContents info]
-- ^ Used by remotes that support importing historical versions of
-- files that are stored in them. This is equivilant to a git
-- commit history.
--
-- When retrieving a historical version of a file,
-- old ImportLocations from importableHistory are not used;
-- the content is no longer expected to be present at those
-- locations. So, if a remote does not support Key/Value access,
-- it should not populate the importableHistory.
}
deriving (Show, Generic)
instance NFData info => NFData (ImportableContents info)
{- ImportableContents, but it can be chunked into subtrees to avoid
- all needing to fit in memory at the same time. -}
data ImportableContentsChunkable m info
= ImportableContentsComplete (ImportableContents info)
-- ^ Used when not chunking
| ImportableContentsChunked
{ importableContentsChunk :: ImportableContentsChunk m info
, importableHistoryComplete :: [ImportableContents info]
-- ^ Chunking the history is not supported
}
{- A chunk of ImportableContents, which is the entire content of a subtree
- of the main tree. Nested subtrees are not allowed. -}
data ImportableContentsChunk m info = ImportableContentsChunk
{ importableContentsSubDir :: ImportChunkSubDir
, importableContentsSubTree :: [(RawFilePath, info)]
-- ^ locations are relative to importableContentsSubDir
, importableContentsNextChunk :: m (Maybe (ImportableContentsChunk m info))
-- ^ Continuation to get the next chunk.
-- Returns Nothing when there are no more chunks.
}
newtype ImportChunkSubDir = ImportChunkSubDir { importChunkSubDir :: RawFilePath }
importableContentsChunkFullLocation
:: ImportChunkSubDir
-> RawFilePath
-> ImportLocation
importableContentsChunkFullLocation (ImportChunkSubDir root) loc =
mkImportLocation $ Posix.combine root loc
|
