The highest tagged major version is v4.

controller

package

v3.8.0 Latest Latest Go to latest Published: Oct 23, 2023 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/svera/coreander

Links

Open Source Insights

Documentation ¶

Index ¶

func Cover(c *fiber.Ctx, homeDir, libraryPath string, ...) error
func Delete(c *fiber.Ctx, libraryPath string, writer IdxWriter, appFs afero.Fs) error
func DocReader(c *fiber.Ctx, libraryPath string, idx IdxReader) error
func Document(c *fiber.Ctx, libraryPath string, sender Sender, idx IdxReader, ...) error
func Download(c *fiber.Ctx, homeDir, libraryPath string, idx IdxReader) error
func Root(c *fiber.Ctx) error
func Search(c *fiber.Ctx, idx IdxReader, sender Sender, wordsPerMinute float64, ...) error
func Send(c *fiber.Ctx, libraryPath string, sender Sender, idx IdxReader) error
type Auth
- func NewAuth(repository authRepository, sender recoveryEmail, cfg AuthConfig, ...) *Auth
- func (a *Auth) EditPassword(c *fiber.Ctx) error
- func (a *Auth) Login(c *fiber.Ctx) error
- func (a *Auth) Recover(c *fiber.Ctx) error
- func (a *Auth) Request(c *fiber.Ctx) error
- func (a *Auth) SignIn(c *fiber.Ctx) error
- func (a *Auth) SignOut(c *fiber.Ctx) error
- func (a *Auth) UpdatePassword(c *fiber.Ctx) error
type AuthConfig
type Highlights
- func NewHighlights(hlRepository highlightsRepository, usrRepository usersRepository, ...) *Highlights
- func (h *Highlights) Highlight(c *fiber.Ctx) error
- func (h *Highlights) Highlights(c *fiber.Ctx) error
- func (h *Highlights) Remove(c *fiber.Ctx) error
type IdxReader
type IdxWriter
type Page
type PagesNavigator
type Sender
type Users
- func NewUsers(repository usersRepository, usersCfg UsersConfig) *Users
- func (u *Users) Create(c *fiber.Ctx) error
- func (u *Users) Delete(c *fiber.Ctx) error
- func (u *Users) Edit(c *fiber.Ctx) error
- func (u *Users) List(c *fiber.Ctx) error
- func (u *Users) New(c *fiber.Ctx) error
- func (u *Users) Update(c *fiber.Ctx) error
type UsersConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Cover ¶

func Cover(c *fiber.Ctx, homeDir, libraryPath string, metadataReaders map[string]metadata.Reader, coverMaxWidth int, idx IdxReader) error

func Delete ¶ added in v3.3.0

func Delete(c *fiber.Ctx, libraryPath string, writer IdxWriter, appFs afero.Fs) error

func DocReader ¶

func DocReader(c *fiber.Ctx, libraryPath string, idx IdxReader) error

func Document ¶ added in v3.4.0

func Document(c *fiber.Ctx, libraryPath string, sender Sender, idx IdxReader, wordsPerMinute float64, highlights model.HighlightRepository) error

func Download ¶

func Download(c *fiber.Ctx, homeDir, libraryPath string, idx IdxReader) error

func Root ¶

func Root(c *fiber.Ctx) error

func Search ¶

func Search(c *fiber.Ctx, idx IdxReader, sender Sender, wordsPerMinute float64, highlights model.HighlightRepository) error

func Send ¶

func Send(c *fiber.Ctx, libraryPath string, sender Sender, idx IdxReader) error

Types ¶

type Auth ¶

type Auth struct {
	// contains filtered or unexported fields
}

func NewAuth ¶

func NewAuth(repository authRepository, sender recoveryEmail, cfg AuthConfig, printers map[string]*message.Printer) *Auth

func (*Auth) EditPassword ¶

func (a *Auth) EditPassword(c *fiber.Ctx) error

func (a *Auth) Login(c *fiber.Ctx) error

func (*Auth) Recover ¶

func (a *Auth) Recover(c *fiber.Ctx) error

func (*Auth) Request ¶

func (a *Auth) Request(c *fiber.Ctx) error

func (a *Auth) SignIn(c *fiber.Ctx) error

Signs in a user and gives them a JWT.

func (*Auth) SignOut ¶

func (a *Auth) SignOut(c *fiber.Ctx) error

Logs out user and removes their JWT.

func (*Auth) UpdatePassword ¶

func (a *Auth) UpdatePassword(c *fiber.Ctx) error

type AuthConfig ¶

type AuthConfig struct {
	Secret            []byte
	MinPasswordLength int
	Hostname          string
	Port              int
	SessionTimeout    time.Duration
}

type Highlights ¶ added in v3.8.0

type Highlights struct {
	// contains filtered or unexported fields
}

func NewHighlights ¶ added in v3.8.0

func NewHighlights(hlRepository highlightsRepository, usrRepository usersRepository, sender Sender, wordsPerMinute float64, idx IdxReader) *Highlights

func (*Highlights) Highlight ¶ added in v3.8.0

func (h *Highlights) Highlight(c *fiber.Ctx) error

func (*Highlights) Highlights ¶ added in v3.8.0

func (h *Highlights) Highlights(c *fiber.Ctx) error

func (*Highlights) Remove ¶ added in v3.8.0

func (h *Highlights) Remove(c *fiber.Ctx) error

type IdxReader ¶ added in v3.3.0

type IdxReader interface {
	Search(keywords string, page, resultsPerPage int) (*search.PaginatedResult, error)
	Count() (uint64, error)
	Close() error
	Document(Slug string) (search.Document, error)
	Documents(IDs []string) ([]search.Document, error)
	SameSubjects(slug string, quantity int) ([]search.Document, error)
	SameAuthors(slug string, quantity int) ([]search.Document, error)
	SameSeries(slug string, quantity int) ([]search.Document, error)
}

IdxReader defines a set of reading operations over an index

type IdxWriter ¶ added in v3.3.0

type IdxWriter interface {
	Document(ID string) (search.Document, error)
	RemoveFile(file string) error
}

type Page ¶

type Page struct {
	Link      string
	IsCurrent bool
}

Page holds the URL of a results page, and if that page is the current one being shown

type PagesNavigator ¶

type PagesNavigator struct {
	Pages        map[int]Page
	PreviousLink string
	NextLink     string
}

PagesNavigator contains all pages links, as well as links to the previous and next pages from the current one

type Sender ¶

type Sender interface {
	SendDocument(address string, libraryPath string, fileName string) error
	From() string
}

type Users ¶

type Users struct {
	// contains filtered or unexported fields
}

func NewUsers ¶

func NewUsers(repository usersRepository, usersCfg UsersConfig) *Users

NewUsers returns a new instance of the users controller

func (*Users) Create ¶

func (u *Users) Create(c *fiber.Ctx) error

Create gathers information coming from the new user form and creates a new user

func (*Users) Delete ¶

func (u *Users) Delete(c *fiber.Ctx) error

Delete soft-removes a user from the database

func (*Users) Edit ¶

func (u *Users) Edit(c *fiber.Ctx) error

Edit renders the edit user form

func (*Users) List ¶

func (u *Users) List(c *fiber.Ctx) error

List list all users registered in the database

func (*Users) New ¶

func (u *Users) New(c *fiber.Ctx) error

New renders the new user form

func (*Users) Update ¶

func (u *Users) Update(c *fiber.Ctx) error

Update gathers information from the edit user form and updates user data

type UsersConfig ¶ added in v3.1.1

type UsersConfig struct {
	MinPasswordLength int
	WordsPerMinute    float64
}

Source Files ¶

View all Source files

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