boar

README

boar

boar will sniff any archive, and maybe even let you extract it.

Under the hood, it uses:

• https://github.com/itchio/savior - for resumable extraction
• https://github.com/itchio/dash - for file sniffing
• https://github.com/itchio/sevenzip-go - for the files we don't have a custom decompressor for

License

boar's code itself is under MIT License, see LICENSE for details.

However:

• szextractor uses 7-zip, which is licensed under LGPL and BSD 3-clause, see https://www.7-zip.org/
• rarextractor uses dmc_unrar, which has LGPL and BSD clauses, see https://github.com/DrMcCoy/dmc_unrar

Documentation

Index

• Variables
• func CleanFileName(fileName string) string
• func SimpleExtract(params *SimpleExtractParams) (*savior.ExtractorResult, error)
• type Contents
• type EntriesLister
• type Entry
• type ExtractParams
• type Info
  • func Probe(params ProbeParams) (*Info, error)
  • func (ai *Info) GetExtractor(file eos.File, consumer *state.Consumer) (savior.Extractor, error)
  • func (ai *Info) String() string
• type LoadFunc
• type ProbeParams
• type SaveFunc
• type SimpleExtractParams
• type Strategy
  • func (as Strategy) String() string
• type ThrottledSaveFunc
  • func ThrottledSave(params *ExtractParams) ThrottledSaveFunc

Variables

var (
	ErrUnrecognizedArchiveType = errors.New("Unrecognized archive type")
)

Functions

func CleanFileName

func CleanFileName(fileName string) string

func SimpleExtract

func SimpleExtract(params *SimpleExtractParams) (*savior.ExtractorResult, error)

Types

type Contents

type Contents struct {
	Entries []*Entry
}

type EntriesLister

type EntriesLister interface {
	Entries() []*savior.Entry
}

type Entry

type Entry struct {
	Name             string
	UncompressedSize int64
}

Entry refers to a file entry in an archive

type ExtractParams

type ExtractParams struct {
	File       eos.File
	StagePath  string
	OutputPath string

	Consumer *state.Consumer

	Load LoadFunc
	Save SaveFunc
}

type Info

type Info struct {
	Strategy    Strategy
	Features    savior.ExtractorFeatures
	Format      string
	PostExtract []string
}

func Probe

func Probe(params ProbeParams) (*Info, error)

Probe attempts to determine the type of an archive Returns (nil, nil) if it is not a recognized archive type Returns (nil, non-nil) if it IS a recognized archive type, but something's wrong with it. Returns (non-nil, nil) if it is a recognized archive type and we are confident we can extract it correctly.

func (*Info) GetExtractor

func (ai *Info) GetExtractor(file eos.File, consumer *state.Consumer) (savior.Extractor, error)

func (*Info) String

func (ai *Info) String() string

type LoadFunc

type LoadFunc func(state interface{}) error

type ProbeParams

type ProbeParams struct {
	File      eos.File
	Consumer  *state.Consumer
	Candidate *dash.Candidate
	OnEntries func(entries []*savior.Entry)
}

type SaveFunc

type SaveFunc func(state interface{}) error

type SimpleExtractParams

type SimpleExtractParams struct {
	ArchivePath       string
	DestinationFolder string
	Consumer          *state.Consumer
}

type Strategy

type Strategy int

const (
	StrategyNone Strategy = 0

	StrategyZip Strategy = 100
	// linux binaries for example - they might be MojoSetup installers
	// (.zip files), or they might not be.
	StrategyZipUnsure Strategy = 101

	StrategyTar    Strategy = 200
	StrategyTarGz  Strategy = 201
	StrategyTarBz2 Strategy = 202
	StrategyTarXz  Strategy = 203

	StrategySevenZip Strategy = 300
	// .exe files for example - might be self-extracting
	// archives 7-zip can handle, or they might not.
	StrategySevenZipUnsure Strategy = 301

	// .dmg files can only be properly extracted on macOS.
	// 7-zip struggles with ISO9660 disk images for example,
	// and doesn't support APFS yet (as of 18.05)
	StrategyDmg Strategy = 400

	// .rar files we do *not* want to open while probing
	StrategyRar Strategy = 500
)

func (Strategy) String

func (as Strategy) String() string

type ThrottledSaveFunc

type ThrottledSaveFunc func(state interface{}, force bool) bool

Saves the state if force is true or the interval has passed Returns true if the state was actually saved, false if not

func ThrottledSave

func ThrottledSave(params *ExtractParams) ThrottledSaveFunc