db

package

v0.2.0 Latest Latest Go to latest Published: Feb 27, 2022 License: GPL-3.0 Imports: 15 Imported by: 0

Details

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

Repository

github.com/Mangatsu/server

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ArchivePathFound(archivePath string) bool
func Clamp(value, min, max int64) int64
func DeleteGallery(galleryUUID string) bool
func DeleteSession(id string, userUUID string) error
func DeleteUser(userUUID string) error
func EnsureLatestVersion()
func GetCategories() ([]string, error)
func GetFavoriteGroups(userUUID string) ([]string, error)
func GetOnlyLibraries() ([]model.Library, error)
func GetSeries() ([]string, error)
func GetSessions(userUUID string) ([]model.Session, error)
func GetUser(name string) ([]model.User, error)
func GetUsers() ([]model.User, error)
func Initdb()
func Login(username string, password string, role Role) (*string, *int32, error)
func Logout(sessionUUID string, userUUID string) error
func MetaPathFound(metaPath string, libraryPath string) bool
func NeedsUpdate(archivePath string, updatedAt time.Time) (bool, string)
func NewGallery(archivePath string, libraryID int32, title string, series string) error
func NewGalleryPref(galleryUUID string, userUUID string) error
func NewSession(userUUID string, expiresIn *int64, sessionName *string) (string, error)
func NewTags(tags []model.Tag) ([]int32, error)
func Register(username string, password string, role int64) error
func SetFavoriteGroup(favoriteGroup string, galleryUUID string, userUUID string) error
func SetThumbnail(uuid string, thumbnail string) error
func StorePaths(givenLibraries []config.Library) error
func UpdateGallery(gallery model.Gallery, tags []model.Tag, reference model.Reference, ...) error
func UpdateProgress(progress int32, galleryUUID string, userUUID string) error
func UpdateUser(userUUID string, userForm *UserForm) error
func VerifySession(id string, userUUID string) bool
type Categories
type CombinedLibrary
- func GetLibraries() ([]CombinedLibrary, error)
type CombinedMetadata
- func GetGalleries(filters Filters, hidden bool, userUUID *string) ([]CombinedMetadata, error)
- func GetGallery(galleryUUID *string, userUUID *string) ([]CombinedMetadata, error)
type FavoriteGroups
type Filters
type MappedTags
- func GetTags(galleryUUID *string, mapped bool) (MappedTags, []model.Tag, error)
type Order
type Role
type SortBy
type UserForm

Constants ¶

View Source

const (
	Title       SortBy = "title"
	TitleNative        = "native"
	UpdatedAt          = "updated"
	Progress           = "progress"
)

View Source

const (
	Desc   Order = "desc"
	Asc          = "asc"
	Random       = "random"
)

View Source

const (
	Admin  Role = 100
	Member      = 20
	Viewer      = 10
	NoRole      = 0
)

Variables ¶

This section is empty.

Functions ¶

func ArchivePathFound ¶

func ArchivePathFound(archivePath string) bool

ArchivePathFound returns true if the given archive path is already in the database.

func Clamp ¶

func Clamp(value, min, max int64) int64

func DeleteGallery ¶

func DeleteGallery(galleryUUID string) bool

DeleteGallery removes a gallery from the database (never actually deletes the archive file).

func DeleteSession ¶

func DeleteSession(id string, userUUID string) error

DeleteSession removes a session based on the session ID and user UUID.

func DeleteUser ¶

func DeleteUser(userUUID string) error

DeleteUser removes user. Admins cannot be deleted, they have to demoted first.

func EnsureLatestVersion ¶

func EnsureLatestVersion()

EnsureLatestVersion ensures that the database is at the latest version by running all migrations.

func GetCategories ¶

func GetCategories() ([]string, error)

GetCategories returns all public categories.

func GetFavoriteGroups ¶

func GetFavoriteGroups(userUUID string) ([]string, error)

GetFavoriteGroups returns user's favorite groups.

func GetOnlyLibraries ¶

func GetOnlyLibraries() ([]model.Library, error)

func GetSeries ¶

func GetSeries() ([]string, error)

GetSeries returns all series.

func GetSessions ¶

func GetSessions(userUUID string) ([]model.Session, error)

GetSessions returns all sessions of a user.

func GetUser ¶

func GetUser(name string) ([]model.User, error)

GetUser returns a user from the database.

func GetUsers ¶

func GetUsers() ([]model.User, error)

GetUsers returns users from the database.

func Initdb ¶

func Initdb()

Initdb initializes the database

func Login(username string, password string, role Role) (*string, *int32, error)

Login logs the user in and returns the UUID of the user.

func Logout ¶

func Logout(sessionUUID string, userUUID string) error

Logout logs out a user by removing a session.

func MetaPathFound ¶

func MetaPathFound(metaPath string, libraryPath string) bool

MetaPathFound returns true if a gallery with the given meta path exists.

func NeedsUpdate ¶

func NeedsUpdate(archivePath string, updatedAt time.Time) (bool, string)

NeedsUpdate returns true if the gallery needs to be updated. Currently, only the timestamp is checked.

func NewGallery ¶

func NewGallery(archivePath string, libraryID int32, title string, series string) error

NewGallery creates a new gallery

func NewGalleryPref ¶

func NewGalleryPref(galleryUUID string, userUUID string) error

NewGalleryPref creates initializes user preferences for a gallery.

func NewSession ¶

func NewSession(userUUID string, expiresIn *int64, sessionName *string) (string, error)

NewSession creates a new session for a user.

func NewTags ¶

func NewTags(tags []model.Tag) ([]int32, error)

NewTags creates tags from the given list.

func Register ¶

func Register(username string, password string, role int64) error

Register registers a new user.

func SetFavoriteGroup ¶

func SetFavoriteGroup(favoriteGroup string, galleryUUID string, userUUID string) error

SetFavoriteGroup sets a favorite group for a gallery.

func SetThumbnail ¶

func SetThumbnail(uuid string, thumbnail string) error

SetThumbnail saves the filename of the thumbnail for the gallery.

func StorePaths ¶

func StorePaths(givenLibraries []config.Library) error

func UpdateGallery ¶

func UpdateGallery(gallery model.Gallery, tags []model.Tag, reference model.Reference, internalScan bool) error

UpdateGallery updates a gallery. It also adds tags and references if any. If internalScan is true, the gallery is matched by its archive path, not UUID.

func UpdateProgress ¶

func UpdateProgress(progress int32, galleryUUID string, userUUID string) error

UpdateProgress sets the reading progress of a gallery for a user.

func UpdateUser ¶

func UpdateUser(userUUID string, userForm *UserForm) error

UpdateUser can be used to update role, password or username of users.

func VerifySession ¶

func VerifySession(id string, userUUID string) bool

VerifySession verifies a session by checking if it exists based on the session ID and user UUID.

Types ¶

type Categories ¶

type Categories struct {
	Data []string `json:"Data"`
}

type CombinedLibrary ¶

type CombinedLibrary struct {
	model.Library
	Galleries []model.Gallery
}

func GetLibraries ¶

func GetLibraries() ([]CombinedLibrary, error)

type CombinedMetadata ¶

type CombinedMetadata struct {
	model.Gallery

	Tags []model.Tag

	Reference struct {
		ExhToken *string
		ExhGid   *int32
		Urls     *string
	} `alias:"reference.*"`

	GalleryPref *struct {
		FavoriteGroup *string
		Progress      int32
		UpdatedAt     string
	} `alias:"gallery_pref.*"`

	Library model.Library `json:"-"`
}

func GetGalleries ¶

func GetGalleries(filters Filters, hidden bool, userUUID *string) ([]CombinedMetadata, error)

GetGalleries returns galleries based on the given filters.

func GetGallery ¶

func GetGallery(galleryUUID *string, userUUID *string) ([]CombinedMetadata, error)

GetGallery returns a gallery based on the given UUID. If no UUID is given, a random gallery is returned.

type FavoriteGroups ¶

type FavoriteGroups struct {
	Data []string `json:"Data"`
}

type Filters ¶

type Filters struct {
	Order         Order
	SortBy        SortBy
	Limit         int64
	Offset        int64
	SearchTerm    string
	Series        string
	Category      string
	FavoriteGroup string
	NSFW          string
	Tags          []model.Tag
}

type MappedTags ¶

type MappedTags struct {
	Data  map[string][]string `json:"Data"`
	Count int
}

func GetTags ¶

func GetTags(galleryUUID *string, mapped bool) (MappedTags, []model.Tag, error)

GetTags returns all tags.

type Order ¶

type Order string

type Role ¶

type Role int8

type SortBy ¶

type SortBy string

type UserForm ¶

type UserForm struct {
	Password *string `json:"password"`
	Username *string `json:"username"`
	Role     *string `json:"role"`
}

Source Files ¶

View all Source files

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

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func ArchivePathFound ¶

func Clamp ¶

func DeleteGallery ¶

func DeleteSession ¶

func DeleteUser ¶

func EnsureLatestVersion ¶

func GetCategories ¶

func GetFavoriteGroups ¶

func GetOnlyLibraries ¶

func GetSeries ¶

func GetSessions ¶

func GetUser ¶

func GetUsers ¶

func Initdb ¶

func Login ¶

func Logout ¶

func MetaPathFound ¶

func NeedsUpdate ¶

func NewGallery ¶

func NewGalleryPref ¶

func NewSession ¶

func NewTags ¶

func Register ¶

func SetFavoriteGroup ¶

func SetThumbnail ¶

func StorePaths ¶

func UpdateGallery ¶

func UpdateProgress ¶

func UpdateUser ¶

func VerifySession ¶

Types ¶

type Categories ¶

type CombinedLibrary ¶

func GetLibraries ¶

type CombinedMetadata ¶

func GetGalleries ¶

func GetGallery ¶

type FavoriteGroups ¶

type Filters ¶

type MappedTags ¶

func GetTags ¶

type Order ¶

type Role ¶

type SortBy ¶

type UserForm ¶

Source Files ¶