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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
|
package tq
import (
"strings"
"sync"
"github.com/git-lfs/git-lfs/v3/config"
"github.com/git-lfs/git-lfs/v3/fs"
"github.com/git-lfs/git-lfs/v3/lfsapi"
"github.com/git-lfs/git-lfs/v3/ssh"
"github.com/rubyist/tracerx"
)
const (
defaultMaxRetries = 8
defaultMaxRetryDelay = 10
defaultConcurrentTransfers = 8
)
type Manifest interface {
APIClient() *lfsapi.Client
MaxRetries() int
MaxRetryDelay() int
ConcurrentTransfers() int
IsStandaloneTransfer() bool
batchClient() BatchClient
GetAdapterNames(dir Direction) []string
GetDownloadAdapterNames() []string
GetUploadAdapterNames() []string
getAdapterNames(adapters map[string]NewAdapterFunc) []string
RegisterNewAdapterFunc(name string, dir Direction, f NewAdapterFunc)
NewAdapterOrDefault(name string, dir Direction) Adapter
NewAdapter(name string, dir Direction) Adapter
NewDownloadAdapter(name string) Adapter
NewUploadAdapter(name string) Adapter
Upgrade() *concreteManifest
Upgraded() bool
}
type lazyManifest struct {
f *fs.Filesystem
apiClient *lfsapi.Client
operation string
remote string
m *concreteManifest
}
func newLazyManifest(f *fs.Filesystem, apiClient *lfsapi.Client, operation, remote string) *lazyManifest {
return &lazyManifest{
f: f,
apiClient: apiClient,
operation: operation,
remote: remote,
m: nil,
}
}
func (m *lazyManifest) APIClient() *lfsapi.Client {
return m.Upgrade().APIClient()
}
func (m *lazyManifest) MaxRetries() int {
return m.Upgrade().MaxRetries()
}
func (m *lazyManifest) MaxRetryDelay() int {
return m.Upgrade().MaxRetryDelay()
}
func (m *lazyManifest) ConcurrentTransfers() int {
return m.Upgrade().ConcurrentTransfers()
}
func (m *lazyManifest) IsStandaloneTransfer() bool {
return m.Upgrade().IsStandaloneTransfer()
}
func (m *lazyManifest) batchClient() BatchClient {
return m.Upgrade().batchClient()
}
func (m *lazyManifest) GetAdapterNames(dir Direction) []string {
return m.Upgrade().GetAdapterNames(dir)
}
func (m *lazyManifest) GetDownloadAdapterNames() []string {
return m.Upgrade().GetDownloadAdapterNames()
}
func (m *lazyManifest) GetUploadAdapterNames() []string {
return m.Upgrade().GetUploadAdapterNames()
}
func (m *lazyManifest) getAdapterNames(adapters map[string]NewAdapterFunc) []string {
return m.Upgrade().getAdapterNames(adapters)
}
func (m *lazyManifest) RegisterNewAdapterFunc(name string, dir Direction, f NewAdapterFunc) {
m.Upgrade().RegisterNewAdapterFunc(name, dir, f)
}
func (m *lazyManifest) NewAdapterOrDefault(name string, dir Direction) Adapter {
return m.Upgrade().NewAdapterOrDefault(name, dir)
}
func (m *lazyManifest) NewAdapter(name string, dir Direction) Adapter {
return m.Upgrade().NewAdapter(name, dir)
}
func (m *lazyManifest) NewDownloadAdapter(name string) Adapter {
return m.Upgrade().NewDownloadAdapter(name)
}
func (m *lazyManifest) NewUploadAdapter(name string) Adapter {
return m.Upgrade().NewUploadAdapter(name)
}
func (m *lazyManifest) Upgrade() *concreteManifest {
if m.m == nil {
m.m = newConcreteManifest(m.f, m.apiClient, m.operation, m.remote)
}
return m.m
}
func (m *lazyManifest) Upgraded() bool {
return m.m != nil
}
type concreteManifest struct {
// maxRetries is the maximum number of retries a single object can
// attempt to make before it will be dropped. maxRetryDelay is the maximum
// time in seconds to wait between retry attempts when using backoff.
maxRetries int
maxRetryDelay int
concurrentTransfers int
basicTransfersOnly bool
standaloneTransferAgent string
tusTransfersAllowed bool
downloadAdapterFuncs map[string]NewAdapterFunc
uploadAdapterFuncs map[string]NewAdapterFunc
fs *fs.Filesystem
apiClient *lfsapi.Client
sshTransfer *ssh.SSHTransfer
batchClientAdapter BatchClient
mu sync.Mutex
}
func (m *concreteManifest) APIClient() *lfsapi.Client {
return m.apiClient
}
func (m *concreteManifest) MaxRetries() int {
return m.maxRetries
}
func (m *concreteManifest) MaxRetryDelay() int {
return m.maxRetryDelay
}
func (m *concreteManifest) ConcurrentTransfers() int {
return m.concurrentTransfers
}
func (m *concreteManifest) IsStandaloneTransfer() bool {
return m.standaloneTransferAgent != ""
}
func (m *concreteManifest) batchClient() BatchClient {
if r := m.MaxRetries(); r > 0 {
m.batchClientAdapter.SetMaxRetries(r)
}
return m.batchClientAdapter
}
func (m *concreteManifest) Upgrade() *concreteManifest {
return m
}
func (m *concreteManifest) Upgraded() bool {
return true
}
func NewManifest(f *fs.Filesystem, apiClient *lfsapi.Client, operation, remote string) Manifest {
return newLazyManifest(f, apiClient, operation, remote)
}
func newConcreteManifest(f *fs.Filesystem, apiClient *lfsapi.Client, operation, remote string) *concreteManifest {
if apiClient == nil {
cli, err := lfsapi.NewClient(nil)
if err != nil {
tracerx.Printf("unable to init tq.Manifest: %s", err)
return nil
}
apiClient = cli
}
sshTransfer := apiClient.SSHTransfer(operation, remote)
useSSHMultiplexing := false
if sshTransfer != nil {
useSSHMultiplexing = sshTransfer.IsMultiplexingEnabled()
}
m := &concreteManifest{
fs: f,
apiClient: apiClient,
batchClientAdapter: &tqClient{Client: apiClient},
downloadAdapterFuncs: make(map[string]NewAdapterFunc),
uploadAdapterFuncs: make(map[string]NewAdapterFunc),
sshTransfer: sshTransfer,
}
var tusAllowed bool
if git := apiClient.GitEnv(); git != nil {
if v := git.Int("lfs.transfer.maxretries", 0); v > 0 {
m.maxRetries = v
}
if v := git.Int("lfs.transfer.maxretrydelay", -1); v > -1 {
m.maxRetryDelay = v
}
if v := git.Int("lfs.concurrenttransfers", 0); v > 0 {
m.concurrentTransfers = v
}
m.basicTransfersOnly = git.Bool("lfs.basictransfersonly", false)
m.standaloneTransferAgent = findStandaloneTransfer(
apiClient, operation, remote,
)
tusAllowed = git.Bool("lfs.tustransfers", false)
configureCustomAdapters(git, m)
}
if m.maxRetries < 1 {
m.maxRetries = defaultMaxRetries
}
if m.maxRetryDelay < 1 {
m.maxRetryDelay = defaultMaxRetryDelay
}
if m.concurrentTransfers < 1 {
m.concurrentTransfers = defaultConcurrentTransfers
}
if sshTransfer != nil {
if !useSSHMultiplexing {
m.concurrentTransfers = 1
}
// Multiple concurrent transfers are not yet supported.
m.batchClientAdapter = &SSHBatchClient{
maxRetries: m.maxRetries,
transfer: sshTransfer,
}
}
configureBasicDownloadAdapter(m)
configureBasicUploadAdapter(m)
if tusAllowed {
configureTusAdapter(m)
}
configureSSHAdapter(m)
return m
}
func findDefaultStandaloneTransfer(url string) string {
if strings.HasPrefix(url, "file://") {
return standaloneFileName
}
return ""
}
func findStandaloneTransfer(client *lfsapi.Client, operation, remote string) string {
if operation == "" || remote == "" {
v, _ := client.GitEnv().Get("lfs.standalonetransferagent")
return v
}
ep := client.Endpoints.Endpoint(operation, remote)
uc := config.NewURLConfig(client.GitEnv())
v, ok := uc.Get("lfs", ep.Url, "standalonetransferagent")
if !ok {
return findDefaultStandaloneTransfer(ep.Url)
}
return v
}
// GetAdapterNames returns a list of the names of adapters available to be created
func (m *concreteManifest) GetAdapterNames(dir Direction) []string {
switch dir {
case Upload:
return m.GetUploadAdapterNames()
case Download:
return m.GetDownloadAdapterNames()
}
return nil
}
// GetDownloadAdapterNames returns a list of the names of download adapters available to be created
func (m *concreteManifest) GetDownloadAdapterNames() []string {
return m.getAdapterNames(m.downloadAdapterFuncs)
}
// GetUploadAdapterNames returns a list of the names of upload adapters available to be created
func (m *concreteManifest) GetUploadAdapterNames() []string {
return m.getAdapterNames(m.uploadAdapterFuncs)
}
// getAdapterNames returns a list of the names of adapters available to be created
func (m *concreteManifest) getAdapterNames(adapters map[string]NewAdapterFunc) []string {
if m.basicTransfersOnly {
return []string{BasicAdapterName}
}
m.mu.Lock()
defer m.mu.Unlock()
ret := make([]string, 0, len(adapters))
for n, _ := range adapters {
ret = append(ret, n)
}
return ret
}
// RegisterNewTransferAdapterFunc registers a new function for creating upload
// or download adapters. If a function with that name & direction is already
// registered, it is overridden
func (m *concreteManifest) RegisterNewAdapterFunc(name string, dir Direction, f NewAdapterFunc) {
m.mu.Lock()
defer m.mu.Unlock()
switch dir {
case Upload:
m.uploadAdapterFuncs[name] = f
case Download:
m.downloadAdapterFuncs[name] = f
}
}
// Create a new adapter by name and direction; default to BasicAdapterName if doesn't exist
func (m *concreteManifest) NewAdapterOrDefault(name string, dir Direction) Adapter {
if len(name) == 0 {
name = BasicAdapterName
}
a := m.NewAdapter(name, dir)
if a == nil {
tracerx.Printf("Defaulting to basic transfer adapter since %q did not exist", name)
a = m.NewAdapter(BasicAdapterName, dir)
}
return a
}
// Create a new adapter by name and direction, or nil if doesn't exist
func (m *concreteManifest) NewAdapter(name string, dir Direction) Adapter {
m.mu.Lock()
defer m.mu.Unlock()
switch dir {
case Upload:
if u, ok := m.uploadAdapterFuncs[name]; ok {
return u(name, dir)
}
case Download:
if d, ok := m.downloadAdapterFuncs[name]; ok {
return d(name, dir)
}
}
return nil
}
// Create a new download adapter by name, or BasicAdapterName if doesn't exist
func (m *concreteManifest) NewDownloadAdapter(name string) Adapter {
return m.NewAdapterOrDefault(name, Download)
}
// Create a new upload adapter by name, or BasicAdapterName if doesn't exist
func (m *concreteManifest) NewUploadAdapter(name string) Adapter {
return m.NewAdapterOrDefault(name, Upload)
}
// Env is any object with a config.Environment interface.
type Env interface {
Get(key string) (val string, ok bool)
GetAll(key string) []string
Bool(key string, def bool) (val bool)
Int(key string, def int) (val int)
All() map[string][]string
}
|