server

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

type AnalyticsData struct {
	Layout
	Totals          AnalyticsTotals
	Donut           DonutView
	EnrichmentStats EnrichmentStatsView
	Ecosystems      []EcosystemRow
	Metadata        MetadataCacheView
	Runtime         RuntimeView
	// StatsFailed records that the per-ecosystem query errored, so the page
	// can say the figures are unavailable instead of claiming an empty cache.
	StatsFailed bool
	// StatsStale is set when the query errored but a previous snapshot was
	// retained and is being shown. Without it a database that has been down
	// for an hour renders hour-old figures as current, with the failure
	// visible only in the logs.
	StatsStale bool
	// StatsAge is when the retained snapshot was read, phrased for display.
	StatsAge string
}

type AnalyticsTotals struct {
	DownloadedBytes  int64
	Downloaded       string
	Downloads        string
	CacheSize        string
	CachedArtifacts  string
	Packages         string
	Versions         string
	Ecosystems       int
	ActiveEcosystems int
	// Amplification is accumulated download volume divided by the bytes
	// currently held in cache: how many times over the cache has served
	// what it stores. Empty when nothing is cached.
	Amplification string
}

type BreakerRow struct {
	Registry string
	State    string
	Open     bool
}

type BrowseFileInfo struct {
	Path    string `json:"path"`
	Name    string `json:"name"`
	Size    int64  `json:"size"`
	IsDir   bool   `json:"is_dir"`
	ModTime string `json:"mod_time,omitempty"`
}

type BrowseListResponse struct {
	Path  string           `json:"path"`
	Files []BrowseFileInfo `json:"files"`
}

type BrowseSourceData struct {
	Layout
	Ecosystem      string
	PackageName    string
	Version        string
	EscapedVersion string
}

type BuildInfo struct {
	Version string
	Commit  string
}

type BulkRequest struct {
	PURLs []string `json:"purls"`
}

type BulkResponse struct {
	Packages map[string]*PackageResponse `json:"packages"`
}

type CacheDeleteResponse struct {
	PURL    string   `json:"purl"`
	Deleted []string `json:"deleted"`
}

type CacheLookups struct {
	Hits       string
	Misses     string
	HitRatio   string
	HasTraffic bool
}

type ClientRow struct {
	Client   string
	Requests string
	Bytes    string
}

type ComparePageData struct {
	Layout
	Ecosystem          string
	PackageName        string
	FromVersion        string
	ToVersion          string
	EscapedFromVersion string
	EscapedToVersion   string
}

type CooldownOverride struct {
	Ecosystem   string
	Duration    string
	Unsupported bool
}

type CooldownSummary struct {
	Enabled          bool
	Default          string
	Ecosystems       []CooldownOverride
	PackageOverrides int
	PackagePatterns  int
}

type DBSearcher interface {
	SearchPackages(query string, ecosystem string, limit int, offset int) ([]database.SearchResult, error)
	CountSearchResults(query string, ecosystem string) (int64, error)
	ListCachedPackages(ecosystem string, sortBy string, limit int, offset int) ([]database.PackageListItem, error)
	CountCachedPackages(ecosystem string) (int64, error)
}

type DashboardData struct {
	Layout
	Stats           DashboardStats
	EnrichmentStats EnrichmentStatsView
	Cooldown        CooldownSummary
	RecentPackages  []PackageInfo
	PopularPackages []PackageInfo
}

type DashboardStats struct {
	CachedArtifacts int64
	TotalSize       string
	TotalPackages   int64
	TotalVersions   int64
}

type DonutSlice struct {
	// Index selects the fixed categorical slot. The hues themselves live in
	// the .donut-slot-N and .swatch-N rules in the analytics template, so the
	// validated palette has exactly one definition; slots are assigned here in
	// sequence and never cycled.
	Index     int
	Label     string
	Value     string
	SharePct  string
	Downloads string
	CacheSize string
	Dash      string
	Gap       string
	Offset    string
	// IsOther marks the folded tail, which has no single ecosystem behind it.
	IsOther bool
	// Members lists what was folded in, for the tooltip.
	Members string
}

type DonutView struct {
	Slices []DonutSlice
	// Size, Radius, Stroke and Center are handed to the template so the SVG
	// geometry has exactly one definition.
	Size   string
	Radius string
	Stroke string
	Center string
	// CenterValue is the accumulated download size across every ecosystem,
	// stated in the middle of the ring.
	CenterValue string
	CenterLabel string
	HasSlices   bool
}

type EcosystemFilter struct {
	Ecosystem string
	Count     int64
}

type EcosystemRow struct {
	Ecosystem       string
	DownloadedBytes int64
	Downloaded      string
	Downloads       string
	CacheSize       string
	AvgArtifactSize string
	Artifacts       string
	Packages        string
	Versions        string
	// SharePct is this ecosystem's share of the accumulated download total.
	SharePct string
}

type EcosystemStatsEntry struct {
	Ecosystem       string `json:"ecosystem"`
	DownloadedBytes int64  `json:"downloaded_bytes"`
	Downloaded      string `json:"downloaded"`
	Downloads       int64  `json:"downloads"`
	CacheSize       int64  `json:"cache_size_bytes"`
	Artifacts       int64  `json:"cached_artifacts"`
	Packages        int64  `json:"packages"`
	Versions        int64  `json:"versions"`
}

type EnrichmentResponse struct {
	Package         *PackageResponse `json:"package,omitempty"`
	Version         *VersionResponse `json:"version,omitempty"`
	Vulnerabilities []VulnResponse   `json:"vulnerabilities,omitempty"`
	IsOutdated      bool             `json:"is_outdated"`
	LicenseCategory string           `json:"license_category"`
}

type EnrichmentStatsView struct {
	EnrichedPackages     int64
	VulnSyncedPackages   int64
	TotalVulnerabilities int64
	CriticalVulns        int64
	HighVulns            int64
	MediumVulns          int64
	LowVulns             int64
	HasVulns             bool
}

type ErrorResponse struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type FailureRow struct {
	Age      string
	PURL     string
	Filename string
	URL      string
	Path     string
	Error    string
}

type HealthCheck struct {
	Status string `json:"status"`
	Error  string `json:"error,omitempty"`
	Step   string `json:"step,omitempty"`
}

type HealthResponse struct {
	Status string                 `json:"status"`
	Checks map[string]HealthCheck `json:"checks"`
	// CircuitBreakers reports the state ("open" or "closed") of each upstream
	// registry's artifact-fetch circuit breaker, keyed by the host fetched from
	// or, where the fetch URL has none to read, by an opaque placeholder
	// standing in for it. It is omitted when no breaker has been created yet.
	// An open breaker fails every artifact fetch it covers without contacting
	// the upstream, but says nothing about this proxy's own health, so it does
	// not change Status.
	CircuitBreakers map[string]string `json:"circuit_breakers,omitempty"`
	// UpstreamHolds lists upstream hosts that rate limited the proxy and
	// the RFC 3339 time until which it sends them nothing. A held host
	// fails cache misses without contacting it and does not change Status.
	UpstreamHolds map[string]string `json:"upstream_holds,omitempty"`
}

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

type HostedListResponse struct {
	Ecosystem string                   `json:"ecosystem"`
	Name      string                   `json:"name"`
	Artifacts []handler.HostedArtifact `json:"artifacts"`
}

type HostedPushResponse struct {
	Ecosystem string `json:"ecosystem"`
	Name      string `json:"name"`
	handler.HostedArtifact
}

type LabelledCount struct {
	Label string
	Count string
	// Bad marks a failure row, which the template tints.
	Bad bool
	// Recent lists the latest failures behind the count, newest first.
	Recent []FailureRow
	// contains filtered or unexported fields
}

type LabelledStat struct {
	Label string
	Count string
	Mean  string
}

type Layout struct {
	BuildInfo     BuildInfo
	UIBaseURL     string
	CanonicalPath string
	// CacheDelete shows the controls for deleting cached artifacts.
	CacheDelete bool
}

type MetadataCacheRow struct {
	Ecosystem string
	Entries   string
	Size      string
	SharePct  string
}

type MetadataCacheView struct {
	// Enabled reports whether cache_metadata is on. Entries can remain from
	// an earlier run with it on, so both are shown independently.
	Enabled bool
	// Failed records that the query errored, so the card can say so rather
	// than claim the cache is empty.
	Failed  bool
	Entries string
	Size    string
	Rows    []MetadataCacheRow
}

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

type OutdatedPackage struct {
	Ecosystem string `json:"ecosystem"`
	Name      string `json:"name"`
	Version   string `json:"version"`
}

type OutdatedRequest struct {
	Packages []OutdatedPackage `json:"packages"`
}

type OutdatedResponse struct {
	Results []OutdatedResult `json:"results"`
}

type OutdatedResult struct {
	Ecosystem     string `json:"ecosystem"`
	Name          string `json:"name"`
	Version       string `json:"version"`
	LatestVersion string `json:"latest_version,omitempty"`
	IsOutdated    bool   `json:"is_outdated"`
}

type PackageCooldown struct {
	Duration string
	Rule     string
}

type PackageInfo struct {
	Ecosystem       string
	Name            string
	Version         string
	Size            string
	Hits            int64
	CachedAt        string
	License         string
	LicenseCategory string
	VulnCount       int64
	LatestVersion   string
	IsOutdated      bool
}

type PackageListResult struct {
	Ecosystem       string `json:"ecosystem"`
	Name            string `json:"name"`
	LatestVersion   string `json:"latest_version,omitempty"`
	License         string `json:"license,omitempty"`
	LicenseCategory string `json:"license_category,omitempty"`
	Hits            int64  `json:"hits"`
	Size            int64  `json:"size"`
	CachedAt        string `json:"cached_at,omitempty"`
	VulnCount       int64  `json:"vuln_count"`
}

type PackageResponse struct {
	Ecosystem       string `json:"ecosystem"`
	Name            string `json:"name"`
	LatestVersion   string `json:"latest_version,omitempty"`
	License         string `json:"license,omitempty"`
	LicenseCategory string `json:"license_category,omitempty"`
	Description     string `json:"description,omitempty"`
	Homepage        string `json:"homepage,omitempty"`
	Repository      string `json:"repository,omitempty"`
	RegistryURL     string `json:"registry_url,omitempty"`
}

type PackageShowData struct {
	Layout
	Package         *database.Package
	Versions        []database.Version
	Vulnerabilities []database.Vulnerability
	LicenseCategory string
	// Cooldown is nil with cooldown off.
	Cooldown *PackageCooldown
}

type PackagesListPageData struct {
	Layout
	Ecosystem        string
	SortBy           string
	Results          []SearchResultItem
	Count            int
	TotalPackages    int64
	EcosystemFilters []EcosystemFilter
	Page             int
	PerPage          int
	TotalPages       int
}

type PackagesListResponse struct {
	Results   []PackageListResult `json:"results"`
	Count     int                 `json:"count"`
	Total     int64               `json:"total"`
	Ecosystem string              `json:"ecosystem,omitempty"`
	SortBy    string              `json:"sort_by"`
	Page      int                 `json:"page"`
	PerPage   int                 `json:"per_page"`
}

type RegistryConfig struct {
	ID           string
	Name         string
	Language     string
	Endpoint     string
	Instructions template.HTML
}

type RuntimeView struct {
	Available bool

	Requests       string
	ActiveRequests string
	RequestMean    string
	StatusClasses  []LabelledCount
	// Artifact and metadata lookups are counted apart: they are separate
	// caches. Only artifacts feed the database figures above.
	ArtifactCache  CacheLookups
	MetadataCache  CacheLookups
	MetadataServed string

	UpstreamFetches   string
	UpstreamFetchMean string
	UpstreamErrors    []LabelledCount

	StorageOps        []LabelledStat
	StorageErrors     []LabelledCount
	IntegrityFailures []LabelledCount
	ProbeFailures     []LabelledCount
	Evictions         []LabelledCount
	MetadataEvictions []LabelledCount

	Breakers     []BreakerRow
	BreakerTrips []LabelledCount

	Scans        []LabelledStat
	ScansBlocked []LabelledCount
	ScanErrors   []LabelledCount
	ScanningOn   bool

	ResponseBytes string
	Clients       []ClientRow
	Sources       []SourceRow
	SourceCount   int
	TrustsForward bool
	// SourcesOn gates the caller table. The page is unauthenticated, so the
	// addresses behind it are published only when asked for.
	SourcesOn bool
	// FailureDetailsOn gates the recent failures listed under each failure
	// row, for the same reason as SourcesOn.
	FailureDetailsOn bool
	// HasFailures is set when any failure counter has fired, which is when the
	// note about turning failure details on is worth showing.
	HasFailures bool
}

type SearchPackageResult struct {
	Ecosystem     string `json:"ecosystem"`
	Name          string `json:"name"`
	LatestVersion string `json:"latest_version,omitempty"`
	License       string `json:"license,omitempty"`
	Hits          int64  `json:"hits"`
	Size          int64  `json:"size"`
	CachedAt      string `json:"cached_at,omitempty"`
}

type SearchPageData struct {
	Layout
	Query      string
	Ecosystem  string
	Results    []SearchResultItem
	Count      int
	Page       int
	PerPage    int
	TotalPages int
}

type SearchResponse struct {
	Results []SearchPackageResult `json:"results"`
	Query   string                `json:"query"`
	Count   int                   `json:"count"`
}

type SearchResultItem struct {
	Ecosystem       string
	Name            string
	LatestVersion   string
	License         string
	LicenseCategory string
	Hits            int64
	Size            int64
	SizeFormatted   string
	CachedAt        string
	VulnCount       int64
}

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

type SourceRow struct {
	Addr     string
	Client   string
	Requests string
	Bytes    string
	LastSeen string
	// IsOverflow marks the row that stands for every caller past the limit.
	IsOverflow bool
}

type StatsResponse struct {
	CachedArtifacts int64  `json:"cached_artifacts"`
	TotalSize       int64  `json:"total_size_bytes"`
	TotalSizeHuman  string `json:"total_size"`
	StorageURL      string `json:"storage_url"`
	DatabasePath    string `json:"database_path"`
	// DownloadedBytes is the accumulated download volume across every
	// ecosystem: cache hits multiplied by the artifact size they served.
	DownloadedBytes      int64                 `json:"downloaded_bytes"`
	DownloadedBytesHuman string                `json:"downloaded"`
	Downloads            int64                 `json:"downloads"`
	Ecosystems           []EcosystemStatsEntry `json:"ecosystems"`
	// StatsUnavailable distinguishes a proxy that has served nothing from one
	// whose aggregation failed with no snapshot to fall back on. Without it
	// both report zeros and an empty array.
	StatsUnavailable bool `json:"stats_unavailable,omitempty"`
}

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

type VersionResponse struct {
	Ecosystem   string `json:"ecosystem"`
	Name        string `json:"name"`
	Version     string `json:"version"`
	License     string `json:"license,omitempty"`
	PublishedAt string `json:"published_at,omitempty"`
	Integrity   string `json:"integrity,omitempty"`
	Yanked      bool   `json:"yanked"`
	IsOutdated  bool   `json:"is_outdated"`
}

type VersionShowData struct {
	Layout
	Package           *database.Package
	Version           *database.Version
	Artifacts         []database.Artifact
	Vulnerabilities   []database.Vulnerability
	IsOutdated        bool
	LicenseCategory   string
	HasCachedArtifact bool
	// HasDeletableArtifact is true when a stored artifact was fetched from
	// the upstream rather than pushed.
	HasDeletableArtifact bool
}

type VulnResponse struct {
	ID           string   `json:"id"`
	Summary      string   `json:"summary,omitempty"`
	Severity     string   `json:"severity,omitempty"`
	CVSSScore    float64  `json:"cvss_score,omitempty"`
	FixedVersion string   `json:"fixed_version,omitempty"`
	References   []string `json:"references,omitempty"`
}

type VulnsResponse struct {
	Ecosystem       string         `json:"ecosystem"`
	Name            string         `json:"name"`
	Version         string         `json:"version,omitempty"`
	Vulnerabilities []VulnResponse `json:"vulnerabilities"`
	Count           int            `json:"count"`
}