cms

Documentation

Index

• Variables
• func DefaultGetRoutePath(r *http.Request) string
• func DefaultSetDirectory(ctx context.Context, dir Directory) context.Context
• func DefaultSetResource(ctx context.Context, res Resource) context.Context
• type CreatableResource
• type DeletableResource
• type Directory
  • func DefaultGetDirectory(ctx context.Context) Directory
• type PeekableResource
• type Resource
  • func DefaultGetResource(ctx context.Context) Resource
• type Server
• type SubmitableResource
• type User
  • func DefaultGetUser(ctx context.Context) User
• type UserCapability
• type View
• type ViewConfig
  • func (c *ViewConfig) SetDefaults() error
  • func (c *ViewConfig) SetEditHandler(path string, handler web.HandlerFunc) error
  • func (c *ViewConfig) SetErrorHandler(f web.ErrorHandlerFunc) error
  • func (c *ViewConfig) SetFilesHandler(path string, handler web.HandlerFunc) error
  • func (c *ViewConfig) SetGetDirectory(f func(ctx context.Context) Directory) error
  • func (c *ViewConfig) SetGetResource(f func(ctx context.Context) Resource) error
  • func (c *ViewConfig) SetGetRoutePath(f func(*http.Request) string) error
  • func (c *ViewConfig) SetGetUser(f func(ctx context.Context) User) error
  • func (c *ViewConfig) SetIndexPage(index string) error
  • func (c *ViewConfig) SetPingHandler(path string, handler web.HandlerFunc) error
  • func (c *ViewConfig) SetSetDirectory(f func(ctx context.Context, res Directory) context.Context) error
  • func (c *ViewConfig) SetSetResource(f func(ctx context.Context, res Resource) context.Context) error
  • func (c *ViewConfig) SetSitemapHandler(path string, handler web.HandlerFunc) error

Variables

var (
	ResourceCtxKey  = &contextKey{"Resource"}
	DirectoryCtxKey = &contextKey{"Directory"}
)

Functions

func DefaultGetRoutePath

func DefaultGetRoutePath(r *http.Request) string

func DefaultSetDirectory

func DefaultSetDirectory(ctx context.Context, dir Directory) context.Context

func DefaultSetResource

func DefaultSetResource(ctx context.Context, res Resource) context.Context

Types

type CreatableResource

type CreatableResource interface {
	Resource
	Put(http.ResponseWriter, *http.Request) error
}

PUT

type DeletableResource

type DeletableResource interface {
	Resource
	Delete(http.ResponseWriter, *http.Request) error
}

DELETE

type Directory

type Directory interface {
	fs.DirEntry
	fs.FileInfo

	Path() string

	Chdir(string) (Directory, error)
	MkdirAll(string) (Directory, error)

	Open(string) (Resource, error)
}

func DefaultGetDirectory

func DefaultGetDirectory(ctx context.Context) Directory

type PeekableResource

type PeekableResource interface {
	Resource
	Head(w http.ResponseWriter, r *http.Request) error
}

HEAD

type Resource

type Resource interface {
	MimeTypes() []string
	Get(http.ResponseWriter, *http.Request) error
}

GET

func DefaultGetResource

func DefaultGetResource(ctx context.Context) Resource

type Server

type Server interface {
	View(path string) View

	Chdir(string) (Directory, error)
	MkdirAll(string) (Directory, error)
	Chroot(string) (Directory, error)
}

type SubmitableResource

type SubmitableResource interface {
	Resource
	Post(http.ResponseWriter, *http.Request) error
}

POST

type User

type User interface {
	Username() string
	CanDo(c UserCapability, r Resource) bool
	CanDoPath(c UserCapability, path string) bool
}

func DefaultGetUser

func DefaultGetUser(ctx context.Context) User

type UserCapability

type UserCapability int

const (
	CanRead UserCapability = iota
	CanWrite
	CanPurge
)

type View

type View interface {
	http.Handler
	web.Handler
	web.RouterPageInfo

	Middleware(prefix string) func(next http.Handler) http.Handler

	Config() *ViewConfig
}

type ViewConfig

type ViewConfig struct {
	GetRoutePath func(r *http.Request) string
	GetUser      func(ctx context.Context) User
	SetResource  func(ctx context.Context, res Resource) context.Context
	GetResource  func(ctx context.Context) Resource
	SetDirectory func(ctx context.Context, res Directory) context.Context
	GetDirectory func(ctx context.Context) Directory

	Edit           string // per resource
	EditHandler    web.HandlerFunc
	Files          string // per directory
	FilesHandler   web.HandlerFunc
	Ping           string // optional per view
	PingHandler    web.HandlerFunc
	Sitemap        string // optional per view
	SitemapHandler web.HandlerFunc

	ErrorHandler web.ErrorHandlerFunc

	Index    string // default page
	ReadOnly bool   // storage can't be modified through this View
}

func (*ViewConfig) SetDefaults

func (c *ViewConfig) SetDefaults() error

Defaults

func (*ViewConfig) SetEditHandler

func (c *ViewConfig) SetEditHandler(path string, handler web.HandlerFunc) error

Set View's File Editor

func (*ViewConfig) SetErrorHandler

func (c *ViewConfig) SetErrorHandler(f web.ErrorHandlerFunc) error

func (*ViewConfig) SetFilesHandler

func (c *ViewConfig) SetFilesHandler(path string, handler web.HandlerFunc) error

Set View's File Manager

func (*ViewConfig) SetGetDirectory

func (c *ViewConfig) SetGetDirectory(f func(ctx context.Context) Directory) error

Get Directory from context.Context

func (*ViewConfig) SetGetResource

func (c *ViewConfig) SetGetResource(f func(ctx context.Context) Resource) error

Get Resource from context.Context

func (*ViewConfig) SetGetRoutePath

func (c *ViewConfig) SetGetRoutePath(f func(*http.Request) string) error

func (*ViewConfig) SetGetUser

func (c *ViewConfig) SetGetUser(f func(ctx context.Context) User) error

func (*ViewConfig) SetIndexPage

func (c *ViewConfig) SetIndexPage(index string) error

func (*ViewConfig) SetPingHandler

func (c *ViewConfig) SetPingHandler(path string, handler web.HandlerFunc) error

Set View's Ping Handler

func (*ViewConfig) SetSetDirectory

func (c *ViewConfig) SetSetDirectory(f func(ctx context.Context, res Directory) context.Context) error

Put Directory into context.Context

func (*ViewConfig) SetSetResource

func (c *ViewConfig) SetSetResource(f func(ctx context.Context, res Resource) context.Context) error

Put Resource into context.Context

func (*ViewConfig) SetSitemapHandler

func (c *ViewConfig) SetSitemapHandler(path string, handler web.HandlerFunc) error

Set View's Sitemap Handler