updater

Documentation

Index

• Constants
• Variables
• func GetDefaultKeyring() (*crypto.KeyRing, error)
• type Channel
• type Downloader
• type File
• type FileIdentifier
  • func ParseFileIdentifier(s string) (FileIdentifier, error)
  • func (fi FileIdentifier) MarshalJSON() ([]byte, error)
  • func (fi FileIdentifier) String() string
  • func (fi *FileIdentifier) UnmarshalJSON(data []byte) (err error)
• type Installer
• type InstallerDefault
  • func NewInstaller(versioner *versioner.Versioner) *InstallerDefault
  • func (i *InstallerDefault) InstallUpdate(version *semver.Version, r io.Reader) error
  • func (i *InstallerDefault) IsAlreadyInstalled(version *semver.Version) bool
• type Release
  • func (rel Release) IsEmpty() bool
• type ReleaseCategory
  • func ParseReleaseCategory(s string) (ReleaseCategory, error)
  • func (rc ReleaseCategory) MarshalJSON() ([]byte, error)
  • func (rc ReleaseCategory) String() string
  • func (rc *ReleaseCategory) UnmarshalJSON(data []byte) (err error)
  • func (rc ReleaseCategory) UpdateEligible(channel Channel) bool
• type Updater
  • func NewUpdater(ver *versioner.Versioner, verifier *crypto.KeyRing, product, platform string) *Updater
  • func (u *Updater) GetVersionInfo(ctx context.Context, downloader Downloader) (VersionInfo, error)
  • func (u *Updater) GetVersionInfoLegacy(ctx context.Context, downloader Downloader, channel Channel) (VersionInfoLegacy, error)
  • func (u *Updater) InstallUpdate(ctx context.Context, downloader Downloader, release Release) error
  • func (u *Updater) InstallUpdateLegacy(ctx context.Context, downloader Downloader, update VersionInfoLegacy) error
  • func (u *Updater) RemoveOldUpdates() error
• type VersionInfo
• type VersionInfoLegacy
  • func (verInfo VersionInfoLegacy) IsEmpty() bool
• type VersionMap

Constants

const DefaultPublicKey = `` /* 9373-byte string literal not displayed */

DefaultPublicKey is the public key used to sign builds.

const Host = "https://proton.me/download"

Variables

var (
	ErrDownloadVerify              = errors.New("failed to download or verify the update")
	ErrInstall                     = errors.New("failed to install the update")
	ErrUpdateAlreadyInstalled      = errors.New("update is already installed")
	ErrVersionFileDownloadOrVerify = errors.New("failed to download or verify the version file")
	ErrReleaseUpdatePackageMissing = errors.New("release update package is missing")
)

var DefaultUpdateChannel = StableChannel //nolint:gochecknoglobals

DefaultUpdateChannel is the default update channel to subscribe to. It is set to the stable channel by default, unless overridden at build time.

Functions

func GetDefaultKeyring

func GetDefaultKeyring() (*crypto.KeyRing, error)

Types

type Channel

type Channel string

Channel represents an update channel users can be subscribed to.

const (
	// StableChannel is the channel all users are subscribed to by default.
	StableChannel Channel = "stable"

	// EarlyChannel is the channel users subscribe to when they enable "Early Access".
	EarlyChannel Channel = "early"
)

type Downloader

type Downloader interface {
	DownloadAndVerify(ctx context.Context, kr *crypto.KeyRing, url, sig string) ([]byte, error)
}

type File

type File struct {
	URL            string         `json:"Url"`
	Sha512CheckSum string         `json:"Sha512CheckSum,omitempty"`
	Identifier     FileIdentifier `json:"Identifier"`
}

type FileIdentifier

type FileIdentifier uint8

const (
	PackageIdentifier FileIdentifier = iota
	InstallerIdentifier
)

func ParseFileIdentifier

func ParseFileIdentifier(s string) (FileIdentifier, error)

func (FileIdentifier) MarshalJSON

func (fi FileIdentifier) MarshalJSON() ([]byte, error)

func (FileIdentifier) String

func (fi FileIdentifier) String() string

func (*FileIdentifier) UnmarshalJSON

func (fi *FileIdentifier) UnmarshalJSON(data []byte) (err error)

type Installer

type Installer interface {
	IsAlreadyInstalled(*semver.Version) bool
	InstallUpdate(*semver.Version, io.Reader) error
}

type InstallerDefault

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

func NewInstaller

func NewInstaller(versioner *versioner.Versioner) *InstallerDefault

func (*InstallerDefault) InstallUpdate

func (i *InstallerDefault) InstallUpdate(version *semver.Version, r io.Reader) error

func (*InstallerDefault) IsAlreadyInstalled

func (i *InstallerDefault) IsAlreadyInstalled(version *semver.Version) bool

type Release

type Release struct {
	ReleaseCategory   ReleaseCategory `json:"CategoryName"`
	Version           *semver.Version
	SystemVersion     versioncompare.SystemVersion `json:"SystemVersion,omitempty"`
	RolloutProportion float64
	MinAuto           *semver.Version `json:"MinAuto,omitempty"`
	ReleaseNotesPage  string
	LandingPage       string
	File              []File `json:"File"`
}

func (Release) IsEmpty

func (rel Release) IsEmpty() bool

type ReleaseCategory

type ReleaseCategory uint8

const (
	EarlyAccessReleaseCategory ReleaseCategory = iota
	StableReleaseCategory
)

func ParseReleaseCategory

func ParseReleaseCategory(s string) (ReleaseCategory, error)

func (ReleaseCategory) MarshalJSON

func (rc ReleaseCategory) MarshalJSON() ([]byte, error)

func (ReleaseCategory) String

func (rc ReleaseCategory) String() string

func (*ReleaseCategory) UnmarshalJSON

func (rc *ReleaseCategory) UnmarshalJSON(data []byte) (err error)

func (ReleaseCategory) UpdateEligible

func (rc ReleaseCategory) UpdateEligible(channel Channel) bool

type Updater

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

func NewUpdater

func NewUpdater(ver *versioner.Versioner, verifier *crypto.KeyRing, product, platform string) *Updater

func (*Updater) GetVersionInfo

func (u *Updater) GetVersionInfo(ctx context.Context, downloader Downloader) (VersionInfo, error)

func (*Updater) GetVersionInfoLegacy

func (u *Updater) GetVersionInfoLegacy(ctx context.Context, downloader Downloader, channel Channel) (VersionInfoLegacy, error)

func (*Updater) InstallUpdate

func (u *Updater) InstallUpdate(ctx context.Context, downloader Downloader, release Release) error

func (*Updater) InstallUpdateLegacy

func (u *Updater) InstallUpdateLegacy(ctx context.Context, downloader Downloader, update VersionInfoLegacy) error

func (*Updater) RemoveOldUpdates

func (u *Updater) RemoveOldUpdates() error

type VersionInfo

type VersionInfo struct {
	Releases []Release `json:"Releases"`
}

type VersionInfoLegacy

type VersionInfoLegacy struct {
	// Version is the semantic version of the release.
	Version *semver.Version

	// MinAuto is the earliest version that is able to autoupdate to this version.
	// Apps older than this version must run the manual installer and cannot autoupdate.
	MinAuto *semver.Version

	// Package is the location of the update package.
	Package string

	// Installers are the locations of installer files (for manual installation).
	Installers []string

	// LandingPage is the address of the app landing page on proton.me
	LandingPage string

	// ReleaseNotesPage is the address of the page containing the release notes.
	ReleaseNotesPage string

	// RolloutProportion indicates the proportion (0,1] of users that should update to this version.
	RolloutProportion float64
}

VersionInfoLegacy is information about one version of the app.

func (VersionInfoLegacy) IsEmpty

func (verInfo VersionInfoLegacy) IsEmpty() bool

type VersionMap

type VersionMap map[Channel]VersionInfoLegacy