demozoo

Documentation

Overview

Package demozoo interacts with the demozoo.org API for data scraping and fetching user file downloads.

Index

• Variables
• func Counter(db *sql.DB, w io.Writer, r request) error
• func Fix(db *sql.DB, w io.Writer) error
• func InsertProds(db *sql.DB, w io.Writer, p *releases.Productions) error
• func RefreshMeta(db *sql.DB, w io.Writer) error
• func RefreshPouet(db *sql.DB, w io.Writer) error
• type Category
  • func (c Category) String() string
• type MsDosProducts
  • func (m *MsDosProducts) Get(db *sql.DB, w io.Writer) error
• type Product
  • func (p *Product) Get(id uint) error
• type Record
  • func NewRecord(count int, values []sql.RawBytes) (Record, error)
  • func (r *Record) DoseeMeta(db *sql.DB, w io.Writer, cfg conf.Config) error
  • func (r *Record) Download(w io.Writer, api *prods.ProductionsAPIv1, st Stat, overwrite bool) error
  • func (r *Record) FileMeta() error
  • func (r *Record) Save(db *sql.DB) error
  • func (r *Record) Stmt() (string, []any)
  • func (r *Record) String() string
  • func (r *Record) ZipContent(w io.Writer) (bool, error)
• type Records
• type Releaser
  • func (r *Releaser) Get(id uint) error
• type ReleaserProducts
  • func (r *ReleaserProducts) Get(id uint) error
• type Request
  • func (r Request) Queries(db *sql.DB, w io.Writer) error
  • func (r *Request) Query(db *sql.DB, w io.Writer, id string) error
• type Stat
  • func (st *Stat) FileExist(r *Record) (bool, error)
  • func (st *Stat) NextPouet(db *sql.DB, w io.Writer, rec Records) error
  • func (st *Stat) NextRefresh(db *sql.DB, w io.Writer, rec Records) error
• type WindowsProducts
  • func (m *WindowsProducts) Get(db *sql.DB, w io.Writer) error

Variables

var (
	ErrRequest = errors.New("unknown request value")
	ErrValues  = errors.New("too few record values")
)

var (
	ErrDir       = errors.New("filepath points to a directory")
	ErrOverwrite = errors.New("overwrite is false, but an existing download exists and cannot be overwritten")
	ErrDownload  = errors.New("no suitable downloads found")
	ErrProdAPI   = errors.New("productions api pointer cannot be nil")
	ErrRecord    = errors.New("pointer to the record cannot be nil")
	ErrRecords   = errors.New("pointer to the rows of records cannot be nil")
	ErrUUID      = errors.New("uuid is empty and cannot be used")
)

var (
	ErrAuthors  = errors.New("pointer to the author cannot be nil")
	ErrFile     = errors.New("file requirement cannot be empty")
	ErrHead     = errors.New("http header cannot be empty")
	ErrNoRel    = errors.New("no productions exist for this releaser")
	ErrParseAPI = errors.New("parse api has skipped")
	ErrProds    = errors.New("pointer to the productions cannot be nil")
)

var ErrLogger = errors.New("zap logger cannot be nil")

Functions

func Counter

func Counter(db *sql.DB, w io.Writer, r request) error

Counter prints to the writer the number of records with links to the request.

func Fix

func Fix(db *sql.DB, w io.Writer) error

Fix any Demozoo data import conflicts.

func InsertProds

func InsertProds(db *sql.DB, w io.Writer, p *releases.Productions) error

InsertProds adds the collection of Demozoo productions to the file database.

func RefreshMeta

func RefreshMeta(db *sql.DB, w io.Writer) error

RefreshMeta synchronises missing file entries with Demozoo sourced metadata.

func RefreshPouet

func RefreshPouet(db *sql.DB, w io.Writer) error

RefreshPouet synchronises missing file entries with Demozoo sourced metadata.

Types

type Category

type Category int

Category are tags for production imports.

const (
	Text     Category = iota // Text based files.
	Code                     // Code are binary files.
	Graphics                 // Graphics are images.
	Music                    // Music is audio.
	Magazine                 // Magazine are publications.
)

func (Category) String

func (c Category) String() string

type MsDosProducts

type MsDosProducts struct {
	Code   int                     // Code is the HTTP status.
	Status string                  // Status is the HTTP status.
	API    []releases.ProductionV1 // API v1 for a Demozoo production.
	Count  int                     // Count the total productions.
	Finds  int                     // Finds are the number of usable productions.
}

MsDosProducts are Demozoo productions that match platforms id 4, MS-DOS. Productions with the tag "lost" are skipped. Productions created on or newer than 1 Jan. 2000 are skipped.

func (*MsDosProducts) Get

func (m *MsDosProducts) Get(db *sql.DB, w io.Writer) error

Get all the productions on Demozoo that are for the MS-DOS platform.

type Product

type Product struct {
	Code   int                    // Code is the HTTP status.
	Status string                 // Status is the HTTP status.
	API    prods.ProductionsAPIv1 // API v1 for a Demozoo production.
}

Product is a Demozoo production item.

func (*Product) Get

func (p *Product) Get(id uint) error

Get a Demozoo production.

type Record

type Record struct {
	Count          int
	FilePath       string // FilePath is an absolute path to the file download.
	ID             string // ID is the database auto increment id.
	UUID           string // UUID is the record's unique id.
	Filename       string
	Filesize       string
	FileZipContent string
	CreatedAt      string
	UpdatedAt      string
	SumMD5         string // SumMD5 is the file download MD5 hash.
	Sum384         string // Sum384 is the file download SHA hash.
	Readme         string
	DOSeeBinary    string
	Platform       string
	GroupFor       string
	GroupBy        string
	Title          string
	Section        string
	CreditText     []string
	CreditCode     []string
	CreditArt      []string
	CreditAudio    []string
	WebIDDemozoo   uint      // WebIDDemozoo is a Demozoo ID associated with the record.
	WebIDPouet     uint      // WebIDPouet is a Pouet ID associated with the record.
	LastMod        time.Time // LastMod is the last modified time value of the file download.
}

Record update for an item in the "file" table of the database.

func NewRecord

func NewRecord(count int, values []sql.RawBytes) (Record, error)

NewRecord initialises a new file record.

func (*Record) DoseeMeta

func (r *Record) DoseeMeta(db *sql.DB, w io.Writer, cfg conf.Config) error

DoseeMeta generates DOSee related metadata from the file archive.

func (*Record) Download

func (r *Record) Download(w io.Writer, api *prods.ProductionsAPIv1, st Stat, overwrite bool) error

Download the first available remote file linked in the Demozoo production record.

func (*Record) FileMeta

func (r *Record) FileMeta() error

FileMeta generates metadata from the file archive.

func (*Record) Save

func (r *Record) Save(db *sql.DB) error

Save the record to the database.

func (*Record) Stmt

func (r *Record) Stmt() (string, []any)

Stmt creates the SQL prepare statement and values to update a Demozoo production.

func (*Record) String

func (r *Record) String() string

func (*Record) ZipContent

func (r *Record) ZipContent(w io.Writer) (bool, error)

ZipContent reads an archive and saves its content to the database.

type Records

type Records struct {
	Rows   *sql.Rows      // Rows is the result of a query.
	Args   []any          // Args are data types.
	Values []sql.RawBytes // Values are byte encoded values.
}

Records contain more than one Record.

type Releaser

type Releaser struct {
	Code   int                 // Code is the HTTP status.
	Status string              // Status is the HTTP status.
	API    releaser.ReleaserV1 // API v1 for a Demozoo releaser.
}

Releaser is a Demozoo scener or group.

func (*Releaser) Get

func (r *Releaser) Get(id uint) error

Get a Demozoo scener or group.

type ReleaserProducts

type ReleaserProducts struct {
	Code   int                  // Code is the HTTP status.
	Status string               // Status is the HTTP status.
	API    releases.Productions // API for the Demozoo productions.
}

ReleaserProducts are the productions of a Demozoo releaser.

func (*ReleaserProducts) Get

func (r *ReleaserProducts) Get(id uint) error

Get the productions of a Demozoo scener or group.

type Request

type Request struct {
	All       bool   // Parse all demozoo entries.
	Overwrite bool   // Overwrite any existing files.
	Refresh   bool   // Refresh all demozoo entries.
	ByID      string // Filter by ID.
	Config    conf.Config
	Logger    *zap.SugaredLogger
}

Request Demozoo entries.

func (Request) Queries

func (r Request) Queries(db *sql.DB, w io.Writer) error

Queries parses all new Demozoo submissions.

Request.Overwrite will replace existing assets such as images.

Request.All parses every Demozoo entry, not just records waiting for approval.

func (*Request) Query

func (r *Request) Query(db *sql.DB, w io.Writer, id string) error

Query parses a single Demozoo entry.

type Stat

type Stat struct {
	Count   int    // Count records.
	Fetched int    // Fetched records.
	Missing int    // Missing files.
	Total   int    // Total files.
	ByID    string // ByID filtering.
}

Stat are statistics for the remote query.

func (*Stat) FileExist

func (st *Stat) FileExist(r *Record) (bool, error)

FileExist returns false when the record FilePath points to a non-existent file.

func (*Stat) NextPouet

func (st *Stat) NextPouet(db *sql.DB, w io.Writer, rec Records) error

NextPouet iterates over the linked Demozoo records and sync any linked Pouet data to the local files table.

func (*Stat) NextRefresh

func (st *Stat) NextRefresh(db *sql.DB, w io.Writer, rec Records) error

NextRefresh iterates over the Records to update sync their Demozoo data to the database.

type WindowsProducts

type WindowsProducts struct {
	Code   int                     // Code is the HTTP status.
	Status string                  // Status is the HTTP status.
	API    []releases.ProductionV1 // API v1 for a Demozoo production.
	Count  int                     // Count the total productions.
	Finds  int                     // Finds are the number of usable productions.
}

WindowsProducts are Demozoo productions that match the Windows platform.

func (*WindowsProducts) Get

func (m *WindowsProducts) Get(db *sql.DB, w io.Writer) error

Get all the productions on Demozoo that are for the Windows platform.