fileslice

package

v1.14.0 Latest Latest Go to latest Published: Oct 5, 2026 License: GPL-3.0 Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Defacto2/server

Links

Open Source Insights

Documentation ¶

Overview ¶

Package fileslice provides functions that return model FileSlices, which are multiple artifact records.

Index ¶

Constants
Variables
func FileInfo(uri string) (logo, h1sub, lead string)
func Records(ctx context.Context, exec boil.ContextExecutor, uri string, page, limit int) (models.FileSlice, error)
func RecordsSub(uri string) string
func Valid(path string) bool
type Era
type Item
type Stats
- func Counter(ctx context.Context, sl *slog.Logger, db *sql.DB) (Stats, error)
- func Statistics() Stats
type URI
- func Match(path string) URI
- func (u URI) String() string

Constants ¶

View Source

const LastURI = _maxURI - 1

View Source

const StatsTTL = 10 * time.Minute // Stats time to live

Variables ¶

View Source

var (
	ErrCategory = errors.New("fileslice: unknown artifacts categories")
	ErrPagi     = errors.New("fileslice: pagination page and limit cannot be less than 1")
)

Functions ¶

func FileInfo ¶

func FileInfo(uri string) (logo, h1sub, lead string)

FileInfo is a helper function for Files that returns the page title, h1 title and lead text.

func Records ¶

func Records(ctx context.Context, exec boil.ContextExecutor, uri string, page, limit int) (models.FileSlice, error)

Records returns the records for the artifacts category URI. Note that the record statistics and counts get cached.

func RecordsSub ¶

func RecordsSub(uri string) string

RecordsSub returns the records for the artifacts category URI.

func Valid ¶

func Valid(path string) bool

Valid returns true if path is a valid URI for the list of files.

Types ¶

type Era ¶

type Era struct {
	Name    string
	MinYear int // MinYear is the earliest or founding year
	MaxYear int // MaxYear is the most recent or final year
}

Era is used to provide sorted statistics for artifact categories.

type Item ¶

type Item struct {
	Name  string
	Bytes int
	Count int
}

Item is used to provided sorted statistics for artifact categories.

type Stats ¶

type Stats struct {
	Record    model.Artifacts
	Ansi      model.Ansi
	AnsiBBS   model.AnsiBBS
	BBS       model.BBS
	BBSText   model.BBSText
	BBStro    model.BBStro
	Console   model.Console
	Demoscene model.Demoscene
	MsDos     model.MsDos
	Intro     model.Intro
	IntroD    model.IntroMsDos
	IntroW    model.IntroWindows
	Installer model.Installer
	Java      model.Java
	Linux     model.Linux
	Magazine  model.Magazine
	Macos     model.Macos
	Nfo       model.Nfo
	NfoTool   model.NfoTool
	Proof     model.Proof
	Script    model.Script
	Text      model.Text
	Windows   model.Windows
}

Stats are the database statistics for the artifacts categories.

func Counter ¶

func Counter(ctx context.Context, sl *slog.Logger, db *sql.DB) (Stats, error)

Counter returns the statistics for the artifacts categories, cached for 10 minutes.

func Statistics ¶

func Statistics() Stats

Statistics returns the empty database statistics for the artifacts categories.

func (*Stats) Get ¶

func (s *Stats) Get(ctx context.Context, sl *slog.Logger, exec boil.ContextExecutor) error

Get and store the database statistics for the artifacts categories.

func (*Stats) SortByte ¶

func (s *Stats) SortByte() [21]Item

SortByte returns the Items sorted from highest to lowest bytes.

func (*Stats) SortCount ¶

func (s *Stats) SortCount() [21]Item

SortCount returns the Items sorted by highest to lowest counts.

func (*Stats) SortName ¶

func (s *Stats) SortName() [21]Item

SortName returns the Items sorted alphabetically by their name.

func (*Stats) SortYear ¶

func (s *Stats) SortYear() [20]Era

SortYear returns the Eras sorted from oldest to newest. If multiple Era share the same year, then the shortest to longest time span is used.

For example:

1. 1980 - 1982
2. 1980 - 1990
3. 1981 - 1985

type URI ¶

type URI int

URI is a type for the files URI path.

const (
	Deletions URI

	ForApproval

	Newest

	NewUpdates
	NewUploads

	Oldest

	Sensenstahl

	Unwanted
)

func Match ¶

func Match(path string) URI

Match path to a URI type or return -1 if not found.

func (URI) String ¶

func (u URI) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL