web

package

v0.0.0-...-51c2b4c Latest Latest Go to latest Published: May 21, 2025 License: GPL-3.0 Imports: 23 Imported by: 0

Details

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

Repository

github.com/directwool/ulist

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrAlreadyMember = errors.New("you are already a member of this list")

View Source

var ErrNoList = errors.New("no list or list error") // generic error so we don't reveal whether a non-public list exists

View Source

var ErrNoMember = errors.New("you are not a member of this list")

View Source

var ErrUnauthorized = errors.New("unauthorized")

Functions ¶

func ExtractIP ¶

func ExtractIP(r *http.Request) string

extracts the client's IP address from a request

Types ¶

type Context ¶

type Context struct {
	User          *mailutil.Addr
	IsSuperadmin  bool
	Notifications []Notification
	Data          interface{} // for template
	// contains filtered or unexported fields
}

func (*Context) Alertf ¶

func (ctx *Context) Alertf(format string, a ...interface{})

implement Alerter

func (*Context) Execute ¶

func (ctx *Context) Execute(t *template.Template, data interface{}) error

func (*Context) LoggedIn ¶

func (ctx *Context) LoggedIn() bool

sets the logged-in user unconditionally

func (*Context) Logout ¶

func (ctx *Context) Logout()

func (*Context) Redirect ¶

func (ctx *Context) Redirect(format string, a ...interface{})

func (*Context) ServeFile ¶

func (ctx *Context) ServeFile(name string)

func (*Context) Successf ¶

func (ctx *Context) Successf(format string, a ...interface{})

implement Alerter

type Notification ¶

type Notification struct {
	Message string
	Style   string
}

type UserRepo ¶

type UserRepo interface {
	Authenticate(userid, password string) (success bool, err error) // should not be called if Available() returns false
	Available() bool
	Name() string
}

type Web ¶

type Web struct {
	Ulist     *ulist.Ulist
	Listen    string
	URL       string
	UserRepos []UserRepo // repos are queried in the given order
}

func (Web) AskLeaveUrl ¶

func (web Web) AskLeaveUrl(list *ulist.List) string

func (Web) AuthenticationAvailable ¶

func (web Web) AuthenticationAvailable() bool

func (Web) CheckbackJoinUrl ¶

func (web Web) CheckbackJoinUrl(list *ulist.List, timestamp int64, hmac string, recipient *ulist.Addr) string

func (Web) CheckbackLeaveUrl ¶

func (web Web) CheckbackLeaveUrl(list *ulist.List, timestamp int64, hmac string, recipient *ulist.Addr) string

func (Web) FooterHTML ¶

func (web Web) FooterHTML(list *ulist.List) string

func (Web) FooterPlain ¶

func (web Web) FooterPlain(list *ulist.List) string

func (Web) ListenAndServe ¶

func (web Web) ListenAndServe() error

func (Web) ModUrl ¶

func (web Web) ModUrl(list *ulist.List) string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
auth
captcha
html
static

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