mirror

type BottleResolver interface {
	BottleImage(ctx context.Context, formula, version string) (handler.ImageRef, error)
}

type ChartMirrorer interface {
	MirrorChart(ctx context.Context, repository, chart, version string) (*handler.CacheResult, error)
}

type ImageMirrorer interface {
	MirrorImage(ctx context.Context, ref handler.ImageRef, platforms []handler.Platform) (handler.ImageResult, error)
}

type Job struct {
	ID        string    `json:"id"`
	State     JobState  `json:"state"`
	Progress  Progress  `json:"progress"`
	CreatedAt time.Time `json:"created_at"`
	Error     string    `json:"error,omitempty"`
	// contains filtered or unexported fields
}

type JobRequest struct {
	PURLs    []string        `json:"purls,omitempty"`
	SBOM     json.RawMessage `json:"sbom,omitempty"`
	Registry string          `json:"registry,omitempty"`
	// Platforms limit which platforms of container images are mirrored,
	// as os/architecture[/variant].
	Platforms []string `json:"platforms,omitempty"`
	// Latest mirrors only the newest version of PURLs without a version.
	Latest bool `json:"latest,omitempty"`
}

type JobState string

type JobStore struct {
	// contains filtered or unexported fields
}

type LatestFinder interface {
	LatestVersion(ctx context.Context, ecosystem, name string) (string, error)
}

type Mirror struct {

	// Images mirrors docker and oci items. Without it they fail like any
	// other unsupported ecosystem.
	Images ImageMirrorer

	// Charts mirrors helm charts. Without it they fail.
	Charts ChartMirrorer

	// Bottles resolves Homebrew formula versions to the images their
	// bottles are published under, which Images mirrors. Without it brew
	// PURLs fail.
	Bottles BottleResolver

	// Versions lists the versions of unversioned PURLs in mirror jobs and
	// schedules. Nil lists them from the public registries.
	Versions VersionLister

	// JuliaUpstream is the Pkg server Julia packages are fetched from. Empty
	// uses https://pkg.julialang.org.
	JuliaUpstream string

	// RefusePackages, when set, fails every item Images does not take with
	// this reason instead of fetching it, so nothing is cached.
	RefusePackages string
	// contains filtered or unexported fields
}

type MirrorError struct {
	Ecosystem string `json:"ecosystem"`
	Name      string `json:"name"`
	Version   string `json:"version"`
	Error     string `json:"error"`
}

type PURLSource struct {
	PURLs []string
	// Versions lists the versions of unversioned PURLs. Nil lists them from
	// the public registries.
	Versions VersionLister
	// Latest mirrors only the newest version of unversioned PURLs.
	Latest bool
	// Platforms limit which platforms of container images are mirrored.
	Platforms []string
}

type PackageFinder interface {
	FindPackage(ctx context.Context, ecosystem, name string) (*registries.Package, error)
}

type PackageVersion struct {
	Ecosystem string
	Name      string
	Version   string
	// Qualifiers are the PURL qualifiers. Images use repository_url, tag and
	// arch; PyPI uses file_name, and conda subdir, build and type, to select
	// which files of the version are mirrored. Julia uses uuid to identify
	// the package.
	Qualifiers map[string]string
	// Platforms limit which platforms of an image index are mirrored.
	Platforms []string
}

type Progress struct {
	Total     int64         `json:"total"`
	Completed int64         `json:"completed"`
	Skipped   int64         `json:"skipped"`
	Failed    int64         `json:"failed"`
	Bytes     int64         `json:"bytes"`
	Errors    []MirrorError `json:"errors,omitempty"`
	StartedAt time.Time     `json:"started_at"`
	Phase     string        `json:"phase"`
}

type ProgressFunc func(Progress)

type RegistryVersions struct {
	// Client makes the requests. Nil uses registries.DefaultClient.
	Client *registries.Client
	// URL returns the registry base URL to list a package from, by PURL
	// type. Nil, or an empty URL, uses the public registry.
	URL func(purlType, name string) (string, error)
}

type SBOMSource struct {
	Data []byte
	Name string
	// Versions lists the versions of unversioned PURLs. Nil lists them from
	// the public registries.
	Versions VersionLister
	// Latest mirrors only the newest version of unversioned PURLs.
	Latest bool
	// Platforms limit which platforms of container images are mirrored.
	Platforms []string
}

type Schedule struct {
	PURLs     []string
	Platforms []string
	Interval  time.Duration
}

type Scheduler struct {

	// Claim, when set, reports whether this instance should run a schedule
	// that no instance sharing the database started within minGap. Each
	// instance keeps its own timer, so without it every instance would run
	// every schedule.
	Claim func(key string, minGap time.Duration) (bool, error)
	// Release, when set, drops the claim of a run that was interrupted, so
	// the next attempt runs it rather than waiting an interval.
	Release func(key string) error
	// contains filtered or unexported fields
}

type Source interface {
	Enumerate(ctx context.Context, fn func(PackageVersion) error) error
}

type UnavailableImages struct {
	Reason string
}

type VersionFinder interface {
	FindVersion(ctx context.Context, ecosystem, name, version string) (registries.Version, error)
}

type VersionLister interface {
	ListVersions(ctx context.Context, ecosystem, name string) ([]string, error)
}