admin

type Deps struct {
	// Log receives the panel's own lines.
	Log *slog.Logger
	// Store is the database.
	Store *db.Store
	// Version is the build, shown in the footer and on the overview.
	Version string
	// StartedAt is when the process started, which is what uptime counts from.
	StartedAt time.Time
	// Settings reads the organisation's current settings. It is a function
	// rather than a value because settings change while the server runs.
	Settings func(context.Context) (config.Settings, error)
	// Now is the clock, injectable for tests.
	Now func() time.Time
	// OnLogin is called after every sign-in attempt with "accepted",
	// "rejected" or "rate_limited".
	OnLogin func(outcome string)
	// Keyring holds the data key that seals the operator's API keys. The
	// panel needs it to seal what an operator types, to show the last four
	// characters of what is stored, and to re-seal everything when the key is
	// regenerated. A nil keyring is a server with no data key, which the page
	// says rather than pretending a key could be stored safely.
	Keyring *auth.Keyring
	// SaveDataKey writes a newly minted data key into the configuration file
	// beside the binary. nil means this server cannot rewrite that file, and
	// the danger zone says so rather than offering a button that does nothing.
	SaveDataKey func(context.Context, auth.SecretKey) error
	// OnSettingsChanged is called after every saved change, so that the parts
	// of the server holding a copy of the settings re-read them. It is what
	// makes a change take effect without a restart. nil means nothing is told.
	OnSettingsChanged func()
	// Discovery renders the document as it would be served with the settings
	// given, for the preview on the settings page. nil means no preview.
	Discovery func(config.Settings) wire.Discovery
	// Clients is the prebuilt Windows client this server stamps copies of and
	// the directory the copies are kept in. The zero value is a server that
	// has not been given one, which the build page says plainly rather than
	// failing: a fresh installation has no client binary yet, and the page's
	// job then is to say what to put where.
	Clients clientbuild.Builder
	// PluginDir is where a plugin is dropped to install it by hand. It is
	// shown in the empty state, because "there are no plugins" without saying
	// where they go is a dead end.
	PluginDir string
	// Plugins is the plugin host. nil is a server running in a mode that has
	// none — setup, or a configuration that switched them off — and the page
	// says so rather than being absent, because a missing menu entry is a
	// thing an operator cannot ask a question about.
	Plugins Plugins
}

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

type Plugins interface {
	// All is every plugin this server knows about, running or not.
	All(ctx context.Context) ([]plugins.Status, error)
	// Status is one of them.
	Status(ctx context.Context, name string) (plugins.Status, error)
	// Discover re-reads the plugin directory. It is the rescan button.
	Discover(ctx context.Context) error
	// Enable, Disable and Restart are the three buttons on a row.
	Enable(ctx context.Context, name string) error
	Disable(ctx context.Context, name string) error
	Restart(ctx context.Context, name string) error
	// Remove uninstalls: it stops the process, drops the plugin's database and
	// forgets its row. It is the only one of these that destroys anything.
	Remove(ctx context.Context, name string) error
	// Spending is what this plugin may spend in a day and what it has spent.
	Spending(ctx context.Context, name string) (plugins.Spending, error)
	// SetDailyCap records what it may spend. Zero is no cap.
	SetDailyCap(ctx context.Context, name string, tokens int64) error
	// InterfaceVersion is the contract this host speaks, shown beside a plugin
	// that was built against another one.
	InterfaceVersion() int
}

type PruneProgress struct {
	// Running is whether a prune is going on right now.
	Running bool
	// StartedAt and FinishedAt bound the run. FinishedAt is zero while it is
	// still going.
	StartedAt, FinishedAt time.Time
	// Cutoff is the instant traces had to be older than.
	Cutoff time.Time
	// Actor is the administrator who started it.
	Actor string
	// Total is how many laps were going to lose their trace when it began, and
	// Done how many have. Total can be short of Done's eventual value if laps
	// aged past the cutoff while the job ran, which is why the page reads
	// "of about".
	Total, Done int64
	// Freed is how many bytes the preview said would be freed.
	Freed int64
	// Err is why it stopped early, or empty.
	Err string
}

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