internal

Documentation

Index

• func AddDefaultHeaders(h http.Header)
• func AddDefaultHeadersWithCache(h http.Header)
• func CreateHttpServer(shutdown chan<- error) *http.Server
• func NotFoundHandler(w http.ResponseWriter, pr *ParsedRequest)
• func OnExit(messages ...string)
• func OptionsHandler(w http.ResponseWriter)
• func RedirectInfoHandler(w http.ResponseWriter, pr *ParsedRequest)
• func Run(ctx context.Context) error
• func ServerHandler(w http.ResponseWriter, r *http.Request)
• func Setup(appContext context.Context)
• func SetupEnvironment()
• func SetupLogging()
• func StartBackgroundUpdates(targetChannel chan<- state.RedirectMap, lastErrorChannel chan<- error, ...)
• func StatusHealthHandler(w http.ResponseWriter, r *http.Request)
• func StatusInfoHandler(w http.ResponseWriter, r *http.Request)
• func UpdateRedirectMapping(target chan<- state.RedirectMap, lastError chan<- error, force bool)
• type AdminCredentials
• type AppConfig
  • func CreateAppConfig() *AppConfig
  • func (ac *AppConfig) UseFallbackFile() bool
• type FallbackFileEntry
• type NotFoundTemplateData
• type ParsedRequest
  • func RedirectTargetForRequest(r *http.Request) *ParsedRequest
• type RedirectInfoTemplateData
• type StatusHealthcheck
• type StatusInfo

Functions

func AddDefaultHeaders

func AddDefaultHeaders(h http.Header)

func AddDefaultHeadersWithCache

func AddDefaultHeadersWithCache(h http.Header)

func CreateHttpServer

func CreateHttpServer(shutdown chan<- error) *http.Server

func NotFoundHandler

func NotFoundHandler(w http.ResponseWriter, pr *ParsedRequest)

func OnExit

func OnExit(messages ...string)

func OptionsHandler

func OptionsHandler(w http.ResponseWriter)

func RedirectInfoHandler

func RedirectInfoHandler(w http.ResponseWriter, pr *ParsedRequest)

func Run

func Run(ctx context.Context) error

func ServerHandler

func ServerHandler(w http.ResponseWriter, r *http.Request)

func Setup

func Setup(appContext context.Context)

func SetupEnvironment

func SetupEnvironment()

func SetupLogging

func SetupLogging()

func StartBackgroundUpdates

func StartBackgroundUpdates(targetChannel chan<- state.RedirectMap, lastErrorChannel chan<- error, ctx context.Context)

func StatusHealthHandler

func StatusHealthHandler(w http.ResponseWriter, r *http.Request)

func StatusInfoHandler

func StatusInfoHandler(w http.ResponseWriter, r *http.Request)

func UpdateRedirectMapping

func UpdateRedirectMapping(target chan<- state.RedirectMap, lastError chan<- error, force bool)

Types

type AdminCredentials

type AdminCredentials struct {
	UserHash []byte
	PassHash []byte
}

type AppConfig

type AppConfig struct {
	IgnoreCaseInPath      bool
	ShowServerHeader      bool
	Port                  uint16
	UpdatePeriod          time.Duration
	HttpCacheMaxAge       uint32
	CacheControlHeader    string
	StatusEndpointEnabled bool
	UseETag               bool
	UseRedirectBody       bool
	AdminCredentials      *AdminCredentials
	Favicon               string
	AllowRootRedirect     bool
	FallbackFile          string
	ShowRepositoryLink    bool
}

func CreateAppConfig

func CreateAppConfig() *AppConfig

func (*AppConfig) UseFallbackFile

func (ac *AppConfig) UseFallbackFile() bool

type FallbackFileEntry

type FallbackFileEntry struct {
	Key    string `json:"key"`
	Target string `json:"target"`
}

type NotFoundTemplateData

type NotFoundTemplateData struct {
	RedirectName string
}

type ParsedRequest

type ParsedRequest struct {
	Original       *http.Request
	Target         string
	NormalizedPath string
	Found          bool
	InfoRequest    bool
	NoBodyRequest  bool
}

func RedirectTargetForRequest

func RedirectTargetForRequest(r *http.Request) *ParsedRequest

type RedirectInfoTemplateData

type RedirectInfoTemplateData struct {
	RedirectName string
	Target       string
}

type StatusHealthcheck

type StatusHealthcheck struct {
	MappingSize int        `json:"mappingSize"`
	Running     bool       `json:"running"`
	Healthy     bool       `json:"healthy"`
	LastUpdate  *time.Time `json:"lastUpdate"`
}

type StatusInfo

type StatusInfo struct {
	Mapping       state.RedirectMap `json:"mapping"`
	SpreadsheetId string            `json:"spreadsheetId"`
	LastUpdate    *time.Time        `json:"lastUpdate"`
	LastModified  *time.Time        `json:"lastModified"`
	LastError     string            `json:"lastError,omitempty"`
}