service

Documentation

Index

• Constants
• Variables
• func ContextLoggerMiddleware(rootLogger logr.Logger) func(http.Handler) http.Handler
• func MethodLoggingMiddleware(next http.Handler) http.Handler
• func RouteDownloadPattern() string
• func RouteFilterPattern() string
• func RouteRoot() string
• func RouteSingleSeriesPattern() string
• type Feed
• type FeedAuthor
• type FeedEntry
• type FeedLink
• type Service
  • func NewService(conf ServiceConfig) *Service
  • func (s *Service) AddBook(ctx context.Context, req *connect.Request[pbv1.AddBookRequest]) (*connect.Response[pbv1.AddBookResponse], error)
  • func (s *Service) AddBooksToShelf(ctx context.Context, req *connect.Request[pbv1.AddBooksToShelfRequest]) (*connect.Response[pbv1.AddBooksToShelfResponse], error)
  • func (s *Service) CreateShelf(ctx context.Context, req *connect.Request[pbv1.CreateShelfRequest]) (*connect.Response[pbv1.CreateShelfResponse], error)
  • func (s *Service) ExtractMetadata(ctx context.Context, req *connect.Request[pbv1.ExtractMetadataRequest]) (*connect.Response[pbv1.ExtractMetadataResponse], error)
  • func (s *Service) ListBooks(ctx context.Context, req *connect.Request[pbv1.ListBooksRequest]) (*connect.Response[pbv1.ListBooksResponse], error)
  • func (s *Service) ListBooksForShelf(ctx context.Context, req *connect.Request[pbv1.ListBooksForShelfRequest]) (*connect.Response[pbv1.ListBooksForShelfResponse], error)
  • func (s *Service) ListShelves(ctx context.Context, req *connect.Request[pbv1.ListShelvesRequest]) (*connect.Response[pbv1.ListShelvesResponse], error)
  • func (s *Service) OPDSDownload(w http.ResponseWriter, req *http.Request)
  • func (s *Service) OPDSFilter(w http.ResponseWriter, req *http.Request)
  • func (s *Service) OPDSRoot(w http.ResponseWriter, req *http.Request)
  • func (s *Service) OPDSSingleSeries(w http.ResponseWriter, req *http.Request)
  • func (s *Service) Purge(ctx context.Context, req *connect.Request[pbv1.PurgeRequest]) (*connect.Response[pbv1.PurgeResponse], error)
  • func (s *Service) ReadBook(ctx context.Context, req *connect.Request[pbv1.ReadBookRequest]) (*connect.Response[pbv1.ReadBookResponse], error)
  • func (s *Service) RemoveBook(ctx context.Context, req *connect.Request[pbv1.RemoveBookRequest]) (*connect.Response[pbv1.RemoveBookResponse], error)
  • func (s *Service) RemoveBooksFromShelf(ctx context.Context, req *connect.Request[pbv1.RemoveBooksFromShelfRequest]) (*connect.Response[pbv1.RemoveBooksFromShelfResponse], error)
  • func (s *Service) UpdateBook(ctx context.Context, req *connect.Request[pbv1.UpdateBookRequest]) (*connect.Response[pbv1.UpdateBookResponse], error)
• type ServiceConfig

Constants

const (
	FeedNamespace      = "http://www.w3.org/2005/Atom"
	NavigationLinkKind = "application/atom+xml;profile=opds-catalog;kind=navigation"
	CatalogLinkKind    = "application/atom+xml;profile=opds-catalog"
	EpubLinkType       = "application/epub+zip"
)

const (
	RoleAdmin        = pauth.RoleAdministrator
	RoleBookUploader = "book-uploader"
	RoleBookUpdater  = "book-updater"
	RoleShelfAdmin   = "shelf-admin"
	RoleViewOnly     = "view-only"
)

Variables

var (
	ErrEndpointDisabledError = errors.New("endpoint disabled")
)

Functions

func ContextLoggerMiddleware

func ContextLoggerMiddleware(rootLogger logr.Logger) func(http.Handler) http.Handler

func MethodLoggingMiddleware

func MethodLoggingMiddleware(next http.Handler) http.Handler

func RouteDownloadPattern

func RouteDownloadPattern() string

func RouteFilterPattern

func RouteFilterPattern() string

func RouteRoot

func RouteRoot() string

func RouteSingleSeriesPattern

func RouteSingleSeriesPattern() string

Types

type Feed

type Feed struct {
	XMLName xml.Name    `xml:"feed"`
	NS      string      `xml:"ns,attr"`
	ID      string      `xml:"id"`
	Updated time.Time   `xml:"updated"`
	Links   []FeedLink  `xml:"link"`
	Entries []FeedEntry `xml:"entry"`
}

type FeedAuthor

type FeedAuthor struct {
	Name string `xml:"name"`
}

type FeedEntry

type FeedEntry struct {
	XMLName xml.Name    `xml:"entry"`
	ID      string      `xml:"id,omitempty"`
	Title   string      `xml:"title"`
	Links   []FeedLink  `xml:"link"`
	Author  *FeedAuthor `xml:"author,omitempty"`
}

type FeedLink

type FeedLink struct {
	XMLName xml.Name `xml:"link"`
	Rel     string   `xml:"rel,attr,omitempty"`
	Href    string   `xml:"href,attr"`
	Type    string   `xml:"type,attr"`
	Title   string   `xml:"title,attr,omitempty"`
}

type Service

type Service struct {
	pbv1connect.UnimplementedBlankPageServiceHandler
	// contains filtered or unexported fields
}

func NewService

func NewService(conf ServiceConfig) *Service

func (*Service) AddBook

func (s *Service) AddBook(ctx context.Context, req *connect.Request[pbv1.AddBookRequest]) (*connect.Response[pbv1.AddBookResponse], error)

func (*Service) AddBooksToShelf

func (s *Service) AddBooksToShelf(ctx context.Context, req *connect.Request[pbv1.AddBooksToShelfRequest]) (*connect.Response[pbv1.AddBooksToShelfResponse], error)

func (*Service) CreateShelf

func (s *Service) CreateShelf(ctx context.Context, req *connect.Request[pbv1.CreateShelfRequest]) (*connect.Response[pbv1.CreateShelfResponse], error)

func (*Service) ExtractMetadata

func (s *Service) ExtractMetadata(ctx context.Context, req *connect.Request[pbv1.ExtractMetadataRequest]) (*connect.Response[pbv1.ExtractMetadataResponse], error)

func (*Service) ListBooks

func (s *Service) ListBooks(ctx context.Context, req *connect.Request[pbv1.ListBooksRequest]) (*connect.Response[pbv1.ListBooksResponse], error)

func (*Service) ListBooksForShelf

func (s *Service) ListBooksForShelf(ctx context.Context, req *connect.Request[pbv1.ListBooksForShelfRequest]) (*connect.Response[pbv1.ListBooksForShelfResponse], error)

func (*Service) ListShelves

func (s *Service) ListShelves(ctx context.Context, req *connect.Request[pbv1.ListShelvesRequest]) (*connect.Response[pbv1.ListShelvesResponse], error)

func (*Service) OPDSDownload

func (s *Service) OPDSDownload(w http.ResponseWriter, req *http.Request)

func (*Service) OPDSFilter

func (s *Service) OPDSFilter(w http.ResponseWriter, req *http.Request)

func (*Service) OPDSRoot

func (s *Service) OPDSRoot(w http.ResponseWriter, req *http.Request)

func (*Service) OPDSSingleSeries

func (s *Service) OPDSSingleSeries(w http.ResponseWriter, req *http.Request)

func (*Service) Purge

func (s *Service) Purge(ctx context.Context, req *connect.Request[pbv1.PurgeRequest]) (*connect.Response[pbv1.PurgeResponse], error)

func (*Service) ReadBook

func (s *Service) ReadBook(ctx context.Context, req *connect.Request[pbv1.ReadBookRequest]) (*connect.Response[pbv1.ReadBookResponse], error)

func (*Service) RemoveBook

func (s *Service) RemoveBook(ctx context.Context, req *connect.Request[pbv1.RemoveBookRequest]) (*connect.Response[pbv1.RemoveBookResponse], error)

func (*Service) RemoveBooksFromShelf

func (s *Service) RemoveBooksFromShelf(ctx context.Context, req *connect.Request[pbv1.RemoveBooksFromShelfRequest]) (*connect.Response[pbv1.RemoveBooksFromShelfResponse], error)

func (*Service) UpdateBook

func (s *Service) UpdateBook(ctx context.Context, req *connect.Request[pbv1.UpdateBookRequest]) (*connect.Response[pbv1.UpdateBookResponse], error)

type ServiceConfig

type ServiceConfig struct {
	Storer storage.Storer
	// PurgeEnabled enables the purge endpoint. This endpoint should never be enabled on a non-testing deployment
	PurgeEnabled   bool
	DefaultPerPage uint32
	NowFunc        func() time.Time
}