sitemap

Documentation

Overview

Package sitemap generates a complete list of pages available on the website. The generated list is formatted as an XML document and can be saved to a file stored in webroot of the site for search engine bot parsing.

Index

• Constants
• Variables
• func AbsPaths(base string) ([28]string, error)
• func AbsPathsH3(db *sql.DB, base string) ([]string, error)
• func Color404(i int) string
• func ColorCode(i int) string
• func Create(db *sql.DB, w io.Writer, dir string) 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(db *sql.DB) ([]string, error)
• func Sections(db *sql.DB) ([]string, error)
• func Sorts() []string
• type IDs
  • func GetBlocked(db *sql.DB) (IDs, error)
  • func GetKeys(db *sql.DB) (IDs, error)
  • func GetSoftDeleteKeys(db *sql.DB) (IDs, error)
  • func RandBlocked(db *sql.DB, count int) (int, IDs, error)
  • func RandDeleted(db *sql.DB, count int) (int, IDs, error)
  • func RandIDs(db *sql.DB, count int) (int, IDs, error)
  • func (ids *IDs) Contains(x int) bool
  • func (ids IDs) JoinPaths(base string, r Root) []string
  • func (ids IDs) Randomize(x int) (IDs, error)
• type Options
• type Root
  • func (r Root) String() string
• type Style
  • func (p Style) Range(w io.Writer, urls []string)
  • func (p Style) RangeFiles(w io.Writer, urls []string)

Constants

const (
	// Location is the URL of the website.
	Location = "https://defacto2.net"

	// DockerLoc is the URL for the developer hosted on a Docker container.
	DockerLoc = "http://localhost:8560"

	// Namespace is the XML name space.
	Namespace = "http://www.sitemaps.org/schemas/sitemap/0.9"

	// 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")

var ErrPointer = errors.New("pointer value cannot be nil")

Functions

func AbsPaths

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

AbsPaths returns all the static URLs used by the sitemap.

func AbsPathsH3

func AbsPathsH3(db *sql.DB, 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(db *sql.DB, w io.Writer, dir string) 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(db *sql.DB) ([]string, error)

Platforms lists the operating systems required by the files.

func Sections

func Sections(db *sql.DB) ([]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(db *sql.DB) (IDs, error)

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

func GetKeys

func GetKeys(db *sql.DB) (IDs, error)

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

func GetSoftDeleteKeys

func GetSoftDeleteKeys(db *sql.DB) (IDs, error)

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

func RandBlocked

func RandBlocked(db *sql.DB, count int) (int, IDs, error)

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

func RandDeleted

func RandDeleted(db *sql.DB, count int) (int, IDs, error)

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

func RandIDs

func RandIDs(db *sql.DB, count int) (int, IDs, error)

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

func (*IDs) Contains

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

Contains returns true whenever IDs contains x.

func (IDs) JoinPaths

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

JoinPaths return the URL strings of the IDs.

func (IDs) Randomize

func (ids 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(w io.Writer, urls []string)

Range over the file URLs.

func (Style) RangeFiles

func (p Style) RangeFiles(w io.Writer, urls []string)

RangeFiles ranges over the file download URLs.