types

type AmassRangerEntry interface {
	Network() net.IPNet
	AutonomousSystem() int
	Source() *Source
}

type Asset struct {
	Session uuid.UUID `json:"sessionToken,omitempty"`
	Name    string    `json:"assetName,omitempty"`
	Data    AssetData `json:"data,omitempty"`
}

type AssetData struct {
	OAMAsset oam.Asset     `json:"asset"`
	OAMType  oam.AssetType `json:"type"`
}

type AssetPipeline struct {
	Pipeline *pipeline.Pipeline
	Queue    *PipelineQueue
}

type Association struct {
	Submission  *dbt.Entity
	ScopeChange bool
	BestMatch   *dbt.Entity
	Evidence    []*dbt.Entity
	Rationale   string
	Confidence  int
}

type Backlog interface {
	Has(e *dbt.Entity) bool

	Enqueue(e *dbt.Entity) error
	EnqueueDone(e *dbt.Entity) error

	// ClaimNext leases up to num entities of this asset type.
	// Claimed items will not be returned again until Ack/Release or lease expiry.
	ClaimNext(atype oam.AssetType, num int) ([]*dbt.Entity, error)

	// Ack marks completion (done). Call on actual completion (e.g. pipeline finished).
	Ack(e *dbt.Entity, enforceOwner bool) error

	// Release returns a leased item back to queued (e.g. backpressure/admission failure).
	Release(e *dbt.Entity, atype oam.AssetType, enforceOwner bool) error

	Counts(atype oam.AssetType) (queued, leased, done int64, err error)

	Delete(e *dbt.Entity) error
	Close() error

	// Optional knobs:
	SetOwner(owner string)
	SetLeaseTTL(ttl time.Duration)
}

type Dispatcher interface {
	DispatchEvent(e *Event) error
	Shutdown()
}

type EmailMeta struct {
	VerifyAttempted bool
	Verified        bool
}

type Event struct {
	Name       string
	Entity     *dbt.Entity
	Meta       any
	Dispatcher Dispatcher
	Session    Session
}

type EventDataElement struct {
	Event *Event
	Error error
	Exit  chan *EventDataElement
	Ref   any
}

type Handler struct {
	Plugin       Plugin
	Name         string
	Position     int
	Exclusive    bool
	MaxInstances int
	EventType    oam.AssetType
	Transforms   []string
	Callback     func(*Event) error
}

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

type Plugin interface {
	Name() string
	Start(r Registry) error
	Stop()
}

type Registry interface {
	Log() *slog.Logger
	RegisterHandler(h *Handler) error
	BuildAssetPipeline(ctx context.Context, atype oam.AssetType) (*AssetPipeline, error)
}

type Scope interface {
	// Methods for modifying and querying the scope
	Add(a oam.Asset) bool
	IsAssetInScope(a oam.Asset, conf int) (oam.Asset, int)
	AddBlacklist(name string)
	IsBlacklisted(a oam.Asset) bool

	// Methods that support detecting association
	IsAssociated(req *Association) ([]*Association, error)
	AssetsWithAssociation(asset *dbt.Entity) []*dbt.Entity

	// Methods for adding and getting FQDNs
	Domains() []string
	FQDNs() []*oamdns.FQDN
	AddDomain(d string) bool

	// Methods for adding and getting IP addresses
	Addresses() []string
	AddAddress(addr string) bool
	IPAddresses() []*oamnet.IPAddress

	// Methods for adding and getting Netblocks
	CIDRs() []string
	AddCIDR(cidr string) bool
	Netblocks() []*oamnet.Netblock

	// Methods for adding and getting autonomous systems
	ASNs() []int
	AddASN(asn int) bool
	AutonomousSystems() []*oamnet.AutonomousSystem

	// Methods for adding and getting Organizations
	AddOrgByName(o string) bool
	Organizations() []*oamorg.Organization

	// Methods for adding and getting Locations
	Locations() []*oamcon.Location
	AddLocation(loc *oamcon.Location) bool
}

type Session interface {
	ID() uuid.UUID
	Ctx() context.Context
	Log() *slog.Logger
	PubSub() *pubsub.Logger
	NetSem() SessionSemaphone
	Config() *config.Config
	Scope() Scope
	StartTime() time.Time
	DB() repository.Repository
	Backlog() Backlog
	Pipelines() SessionPipelines
	Clients() *SessionHTTPClients
	CIDRanger() cidranger.Ranger
	TmpDir() string
	Stats() *SessionStats
	Done() bool
	Kill()
}

type SessionHTTPClients struct {
	General *http.Client
	Probe   *http.Client
	Crawl   *http.Client
}

type SessionManager interface {
	NewSession(cfg *config.Config) (Session, error)
	AddSession(s Session) error
	CancelSession(id uuid.UUID)
	GetSession(id uuid.UUID) Session
	GetSessions() []Session
	Shutdown()
}

type SessionPipelines map[oam.AssetType]*AssetPipeline

type SessionSemaphone interface {
	Acquire()
	Release()
}

type SessionStats struct {
	sync.RWMutex
	WorkItemsCompleted int `json:"workItemsCompleted"`
	WorkItemsTotal     int `json:"workItemsTotal"`
}

type Source struct {
	Name       string
	Confidence int
}