prereqs

Documentation

Index

• Constants
• Variables
• func Install(ctx *mansion.Context, planPath string, pipePath string) error
• func RedistHasPlatform(redist *redist.RedistEntry, platform butlerd.ItchPlatform) bool
• func Register(ctx *mansion.Context)
• func RegistryKeyExists(consumer *state.Consumer, path string) bool
• func Test(ctx *mansion.Context, prereqs []string) error
• type Library
  • func NewLibrary(credentials *butlerd.GameCredentials) (Library, error)
• type NamedPipe
  • func NewNamedPipe(pipePath string) (*NamedPipe, error)
  • func (np NamedPipe) Consumer() *state.Consumer
  • func (np NamedPipe) WriteState(taskName string, status butlerd.PrereqStatus) error
• type NamedRedistEntry
• type PrereqAssessment
• type PrereqLogEntry
• type PrereqPlan
• type PrereqState
• type PrereqTask
• type PrereqsContext
  • func (pc *PrereqsContext) AssessLinuxPrereq(name string, entry *redist.RedistEntry) (bool, error)
  • func (pc *PrereqsContext) AssessPrereqs(names []string) (*PrereqAssessment, error)
  • func (pc *PrereqsContext) AssessWindowsPrereq(name string, entry *redist.RedistEntry) (bool, error)
  • func (pc *PrereqsContext) BuildPlan(names []string) (*PrereqPlan, error)
  • func (pc *PrereqsContext) FetchPrereqs(tsc *TaskStateConsumer, names []string) error
  • func (pc *PrereqsContext) FilterPrereqs(names []string) ([]string, error)
  • func (pc *PrereqsContext) GetEntry(name string) (*redist.RedistEntry, error)
  • func (pc *PrereqsContext) GetEntryDir(name string) string
  • func (pc *PrereqsContext) GetLibrary() (Library, error)
  • func (pc *PrereqsContext) GetRegistry() (*redist.RedistRegistry, error)
  • func (pc *PrereqsContext) HasInstallMarker(name string) bool
  • func (pc *PrereqsContext) InstallPrereqs(tsc *TaskStateConsumer, plan *PrereqPlan) error
  • func (pc *PrereqsContext) MarkInstalled(name string) error
  • func (pc *PrereqsContext) MarkerPath(name string) string
  • func (pc *PrereqsContext) RunSanityCheck(name string, entry *redist.RedistEntry, sc *redist.LinuxSanityCheck) error
• type TaskStateConsumer

Constants

const RedistsBaseURL = `https://dl.itch.ovh/itch-redists`

Variables

var RedistsGame = &itchio.Game{
	ID:        222417,
	Title:     "itch-redists",
	ShortText: "Redistributables for the itch.io app",
	URL:       "https://fasterthanlime.itch.io/itch-redists",
}

Functions

func Install

func Install(ctx *mansion.Context, planPath string, pipePath string) error

func RedistHasPlatform

func RedistHasPlatform(redist *redist.RedistEntry, platform butlerd.ItchPlatform) bool

func Register

func Register(ctx *mansion.Context)

func RegistryKeyExists

func RegistryKeyExists(consumer *state.Consumer, path string) bool

func Test

func Test(ctx *mansion.Context, prereqs []string) error

Types

type Library

type Library interface {
	GetURL(name string, fileType string) (string, error)
	GetUpload(name string) *itchio.Upload
	GetCredentials() *butlerd.GameCredentials
}

func NewLibrary

func NewLibrary(credentials *butlerd.GameCredentials) (Library, error)

type NamedPipe

type NamedPipe struct {
}

func NewNamedPipe

func NewNamedPipe(pipePath string) (*NamedPipe, error)

func (NamedPipe) Consumer

func (np NamedPipe) Consumer() *state.Consumer

func (NamedPipe) WriteState

func (np NamedPipe) WriteState(taskName string, status butlerd.PrereqStatus) error

type NamedRedistEntry

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

NamedRedistEntry is used for sorting redists by names

type PrereqAssessment

type PrereqAssessment struct {
	Done []string
	Todo []string
}

type PrereqLogEntry

type PrereqLogEntry struct {
	Type    string `json:"type"`
	Message string `json:"message"`
}

PrereqLogEntry sends an information to the caller on the progress of the task

type PrereqPlan

type PrereqPlan struct {
	Tasks []*PrereqTask `json:"tasks"`
}

PrereqPlan contains a list of tasks for the prereq installer

type PrereqState

type PrereqState struct {
	Type   string               `json:"type"`
	Name   string               `json:"name"`
	Status butlerd.PrereqStatus `json:"status"`
}

PrereqState informs the caller on the current status of a prereq

type PrereqTask

type PrereqTask struct {
	Name    string              `json:"name"`
	WorkDir string              `json:"workDir"`
	Info    *redist.RedistEntry `json:"info"`
}

PrereqTask describes something the prereq installer has to do

type PrereqsContext

type PrereqsContext struct {
	RequestContext *butlerd.RequestContext
	Credentials    *butlerd.GameCredentials
	Runtime        *manager.Runtime
	Consumer       *state.Consumer
	PrereqsDir     string
	// contains filtered or unexported fields
}

func (*PrereqsContext) AssessLinuxPrereq

func (pc *PrereqsContext) AssessLinuxPrereq(name string, entry *redist.RedistEntry) (bool, error)

func (*PrereqsContext) AssessPrereqs

func (pc *PrereqsContext) AssessPrereqs(names []string) (*PrereqAssessment, error)

func (*PrereqsContext) AssessWindowsPrereq

func (pc *PrereqsContext) AssessWindowsPrereq(name string, entry *redist.RedistEntry) (bool, error)

func (*PrereqsContext) BuildPlan

func (pc *PrereqsContext) BuildPlan(names []string) (*PrereqPlan, error)

func (*PrereqsContext) FetchPrereqs

func (pc *PrereqsContext) FetchPrereqs(tsc *TaskStateConsumer, names []string) error

func (*PrereqsContext) FilterPrereqs

func (pc *PrereqsContext) FilterPrereqs(names []string) ([]string, error)

func (*PrereqsContext) GetEntry

func (pc *PrereqsContext) GetEntry(name string) (*redist.RedistEntry, error)

func (*PrereqsContext) GetEntryDir

func (pc *PrereqsContext) GetEntryDir(name string) string

func (*PrereqsContext) GetLibrary

func (pc *PrereqsContext) GetLibrary() (Library, error)

func (*PrereqsContext) GetRegistry

func (pc *PrereqsContext) GetRegistry() (*redist.RedistRegistry, error)

func (*PrereqsContext) HasInstallMarker

func (pc *PrereqsContext) HasInstallMarker(name string) bool

func (*PrereqsContext) InstallPrereqs

func (pc *PrereqsContext) InstallPrereqs(tsc *TaskStateConsumer, plan *PrereqPlan) error

func (*PrereqsContext) MarkInstalled

func (pc *PrereqsContext) MarkInstalled(name string) error

func (*PrereqsContext) MarkerPath

func (pc *PrereqsContext) MarkerPath(name string) string

func (*PrereqsContext) RunSanityCheck

func (pc *PrereqsContext) RunSanityCheck(name string, entry *redist.RedistEntry, sc *redist.LinuxSanityCheck) error

type TaskStateConsumer

type TaskStateConsumer struct {
	OnState func(state *butlerd.PrereqsTaskStateNotification)
}