mirror of
https://github.com/empayre/fleet.git
synced 2024-11-07 09:18:59 +00:00
06832697d0
- Add endpoint for deletion of label by ID - Use ID endpoint from frontend JS Fixes #1847
129 lines
4.4 KiB
Go
129 lines
4.4 KiB
Go
package kolide
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
)
|
|
|
|
type LabelStore interface {
|
|
// ApplyLabelSpecs applies a list of LabelSpecs to the datastore,
|
|
// creating and updating labels as necessary.
|
|
ApplyLabelSpecs(specs []*LabelSpec) error
|
|
// GetLabelSpecs returns all of the stored LabelSpecs.
|
|
GetLabelSpecs() ([]*LabelSpec, error)
|
|
// GetLabelSpec returns the spec for the named label.
|
|
GetLabelSpec(name string) (*LabelSpec, error)
|
|
|
|
// Label methods
|
|
NewLabel(Label *Label, opts ...OptionalArg) (*Label, error)
|
|
SaveLabel(label *Label) (*Label, error)
|
|
DeleteLabel(name string) error
|
|
Label(lid uint) (*Label, error)
|
|
ListLabels(opt ListOptions) ([]*Label, error)
|
|
|
|
// LabelQueriesForHost returns the label queries that should be executed
|
|
// for the given host. The cutoff is the minimum timestamp a query
|
|
// execution should have to be considered "fresh". Executions that are
|
|
// not fresh will be repeated. Results are returned in a map of label
|
|
// id -> query
|
|
LabelQueriesForHost(host *Host, cutoff time.Time) (map[string]string, error)
|
|
|
|
// RecordLabelQueryExecutions saves the results of label queries. The
|
|
// results map is a map of label id -> whether or not the label
|
|
// matches. The time parameter is the timestamp to save with the query
|
|
// execution.
|
|
RecordLabelQueryExecutions(host *Host, results map[uint]bool, t time.Time) error
|
|
|
|
// LabelsForHost returns the labels that the given host is in.
|
|
ListLabelsForHost(hid uint) ([]Label, error)
|
|
|
|
// ListHostsInLabel returns a slice of hosts in the label with the
|
|
// given ID.
|
|
ListHostsInLabel(lid uint) ([]Host, error)
|
|
|
|
// ListUniqueHostsInLabels returns a slice of all of the hosts in the
|
|
// given label IDs. A host will only appear once in the results even if
|
|
// it is in multiple of the provided labels.
|
|
ListUniqueHostsInLabels(labels []uint) ([]Host, error)
|
|
|
|
SearchLabels(query string, omit ...uint) ([]Label, error)
|
|
|
|
// LabelIDsByName Retrieve the IDs associated with the given labels
|
|
LabelIDsByName(labels []string) ([]uint, error)
|
|
}
|
|
|
|
type LabelService interface {
|
|
// ApplyLabelSpecs applies a list of LabelSpecs to the datastore,
|
|
// creating and updating labels as necessary.
|
|
ApplyLabelSpecs(ctx context.Context, specs []*LabelSpec) error
|
|
// GetLabelSpecs returns all of the stored LabelSpecs.
|
|
GetLabelSpecs(ctx context.Context) ([]*LabelSpec, error)
|
|
// GetLabelSpec gets the spec for the label with the given name.
|
|
GetLabelSpec(ctx context.Context, name string) (*LabelSpec, error)
|
|
|
|
NewLabel(ctx context.Context, p LabelPayload) (label *Label, err error)
|
|
ModifyLabel(ctx context.Context, id uint, payload ModifyLabelPayload) (*Label, error)
|
|
ListLabels(ctx context.Context, opt ListOptions) (labels []*Label, err error)
|
|
GetLabel(ctx context.Context, id uint) (label *Label, err error)
|
|
|
|
DeleteLabel(ctx context.Context, name string) (err error)
|
|
// DeleteLabelByID is for backwards compatibility with the UI
|
|
DeleteLabelByID(ctx context.Context, id uint) (err error)
|
|
|
|
// HostIDsForLabel returns ids of hosts that belong to the label identified
|
|
// by lid
|
|
HostIDsForLabel(lid uint) ([]uint, error)
|
|
}
|
|
|
|
// ModifyLabelPayload is used to change editable fields for a Label
|
|
type ModifyLabelPayload struct {
|
|
Name *string `json:"name"`
|
|
Description *string `json:"description"`
|
|
}
|
|
|
|
type LabelPayload struct {
|
|
Name *string `json:"name"`
|
|
Query *string `json:"query"`
|
|
Platform *string `json:"platform"`
|
|
Description *string `json:"description"`
|
|
}
|
|
|
|
// LabelType is used to catagorize the kind of label
|
|
type LabelType uint
|
|
|
|
const (
|
|
// LabelTypeRegular is for user created labels that can be modified.
|
|
LabelTypeRegular LabelType = iota
|
|
// LabelTypeBuiltIn is for labels built into Kolide that cannot be
|
|
// modified by users.
|
|
LabelTypeBuiltIn
|
|
)
|
|
|
|
type Label struct {
|
|
UpdateCreateTimestamps
|
|
DeleteFields
|
|
ID uint `json:"id"`
|
|
Name string `json:"name"`
|
|
Description string `json:"description"`
|
|
Query string `json:"query"`
|
|
Platform string `json:"platform"`
|
|
LabelType LabelType `json:"label_type" db:"label_type"`
|
|
}
|
|
|
|
type LabelQueryExecution struct {
|
|
ID uint
|
|
UpdatedAt time.Time
|
|
Matches bool
|
|
LabelID uint
|
|
HostID uint
|
|
}
|
|
|
|
type LabelSpec struct {
|
|
ID uint
|
|
Name string `json:"name"`
|
|
Description string `json:"description"`
|
|
Query string `json:"query"`
|
|
Platform string `json:"platform,omitempty"`
|
|
LabelType LabelType `json:"label_type" db:"label_type"`
|
|
}
|