sitemap

Documentation

Overview

Package sitemap generates an list of pages of the website. The generated XML file is stored on the site's root and can be parsed by search engine bots.

Index

• Constants
• Variables
• func AbsPaths(base string) ([28]string, error)
• func AbsPathsH3(base string) ([]string, error)
• func Color404(i int) string
• func ColorCode(i int) string
• func Create() error
• func FileList(base string) ([]string, error)
• func FindTitle(b []byte) string
• func GetTitle(trimSuffix bool, url string) (string, int, error)
• func Outputs() []string
• func Platforms() ([]string, error)
• func Sections() ([]string, error)
• func Sorts() []string
• type IDs
  • func GetBlocked() (IDs, error)
  • func GetKeys() (IDs, error)
  • func GetSoftDeleteKeys() (IDs, error)
  • func RandBlocked(count int) (int, IDs, error)
  • func RandDeleted(count int) (int, IDs, error)
  • func RandIDs(count int) (int, IDs, error)
  • func (a *IDs) Contains(x int) bool
  • func (a IDs) JoinPaths(base string, r Root) []string
  • func (a IDs) Randomize(x int) (IDs, error)
• type Options
• type Root
  • func (r Root) String() string
• type Style
  • func (p Style) Range(urls []string)
  • func (p Style) RangeFiles(urls []string)

Constants

const (
	// Base URL of the website.
	Base = "https://defacto2.net"
	// Local base URL for the websote hosted on a Docker container.
	LocalBase = "http://localhost:8560"
	// limit the number of urls as permitted by Bing and Google search engines.
	Limit = 50000
)

const (
	// TitleSuffix is the string normally appended to most browser tabs.
	TitleSuffix = " | Defacto2"
)

Variables

var ErrNoIDs = errors.New("no ids to randomise")

Functions

func AbsPaths

func AbsPaths(base string) ([28]string, error)

AbsPaths returns all the static URLs used by the sitemap.

func AbsPathsH3

func AbsPathsH3(base string) ([]string, error)

AbsPaths returns all the HTML3 static URLs used by the sitemap.

func Color404

func Color404(i int) string

Color404 applies a success checkmark and color when i matches status code 404.

func ColorCode

func ColorCode(i int) string

ColorCode applies a success checkmark and color when i matches status code 200.

func Create

func Create() error

Create generates and prints the sitemap.

func FileList

func FileList(base string) ([]string, error)

FileList returns a complete list of URL query strings for the file lists.

func FindTitle

func FindTitle(b []byte) string

FindTitle returns the string value of the HTML <title> element.

func GetTitle

func GetTitle(trimSuffix bool, url string) (string, int, error)

GetTitle returns the string value of the HTML <title> element and status code of a URL.

func Outputs

func Outputs() []string

func Platforms

func Platforms() ([]string, error)

Platforms lists the operating systems required by the files.

func Sections

func Sections() ([]string, error)

Sections lists the categories of files.

func Sorts

func Sorts() []string

Types

type IDs

type IDs []int

IDs are the primary keys of the file records.

func GetBlocked

func GetBlocked() (IDs, error)

GetBlocked returns all the primary keys of the records with blocked file downloads.

func GetKeys

func GetKeys() (IDs, error)

GetKeys returns all the primary keys of the file records that are public.

func GetSoftDeleteKeys

func GetSoftDeleteKeys() (IDs, error)

GetSoftDeleteKeys returns all the primary keys of the file records that are not public and hidden.

func RandBlocked

func RandBlocked(count int) (int, IDs, error)

RandBlocked returns a randomized count of primary keys for records with blocked file downloads.

func RandDeleted

func RandDeleted(count int) (int, IDs, error)

RandDeleted returns a randomized count of primary keys for hidden file records.

func RandIDs

func RandIDs(count int) (int, IDs, error)

RandBlocked returns a randomized count of primary keys for public file records.

func (*IDs) Contains

func (a *IDs) Contains(x int) bool

Contains returns true whenever a contains x.

func (IDs) JoinPaths

func (a IDs) JoinPaths(base string, r Root) []string

JoinPaths return the URL strings of the IDs.

func (IDs) Randomize

func (a IDs) Randomize(x int) (IDs, error)

Randomize the IDs and returns the first x results.

type Options

type Options struct {
	Output   string `url:"output"`
	Platform string `url:"platform"`
	Section  string `url:"section"`
	Sort     string `url:"sort"`
}

type Root

type Root int

Root URL element.

const (
	File     Root = iota // File URL element.
	Download             // Download URL element.
)

func (Root) String

func (r Root) String() string

type Style

type Style int

Style the result of a link and its status code.

const (
	LinkNotFound Style = iota // LinkNotFound first prints the link and expects 404 status codes.
	LinkSuccess               // LinkSuccess first prints the link and expects 200 status codes.
	NotFound                  // NotFound expects 404 status codes.
	Success                   // Success expects 200 status codes.
)

func (Style) Range

func (p Style) Range(urls []string)

Range over the file URLs.

func (Style) RangeFiles

func (p Style) RangeFiles(urls []string)

RangeFiles ranges over the file download URLs.