mangoprovider

README

ManGO Provider

Warning

The API is not stable and may change at any time.

Provider for libmangal written in go.

Most of the code/functionality is based heavily on implementations from Belphemur/mangal (which in turn comes from metafates/mangal) adapted to work with libmangal's mangal.

Credits

Mango logo: Mango icons created by max.icons - Flaticon

Documentation

Index

• Constants
• Variables
• func Log(msg string)
• type Chapter
  • func (c Chapter) Info() libmangal.ChapterInfo
  • func (c Chapter) MarshalJSON() ([]byte, error)
  • func (c Chapter) String() string
  • func (c Chapter) Volume() libmangal.Volume
• type Filter
  • func (f *Filter) String() string
• type Functions
• type Headless
• type Loader
  • func (l Loader) Info() libmangal.ProviderInfo
  • func (l Loader) Load(ctx context.Context) (libmangal.Provider, error)
  • func (l Loader) String() string
• type Manga
  • func (m Manga) Info() libmangal.MangaInfo
  • func (m Manga) MarshalJSON() ([]byte, error)
  • func (m Manga) String() string
• type Options
• type Page
  • func (p Page) Chapter() libmangal.Chapter
  • func (p Page) GetExtension() string
  • func (p Page) String() string
• type Provider
  • func (p *Provider) ChapterPages(ctx context.Context, chapter libmangal.Chapter) ([]libmangal.Page, error)
  • func (p *Provider) Close() error
  • func (p *Provider) GenericGetPageImage(ctx context.Context, page Page) ([]byte, error)
  • func (p *Provider) GetPageImage(ctx context.Context, page libmangal.Page) ([]byte, error)
  • func (p *Provider) Info() libmangal.ProviderInfo
  • func (p *Provider) MangaVolumes(ctx context.Context, manga libmangal.Manga) ([]libmangal.Volume, error)
  • func (p *Provider) SearchMangas(ctx context.Context, query string) ([]libmangal.Manga, error)
  • func (p *Provider) SetLogger(_logger *libmangal.Logger)
  • func (p *Provider) String() string
  • func (p *Provider) VolumeChapters(ctx context.Context, volume libmangal.Volume) ([]libmangal.Chapter, error)
• type Volume
  • func (v Volume) Info() libmangal.VolumeInfo
  • func (v Volume) Manga() libmangal.Manga
  • func (v Volume) MarshalJSON() ([]byte, error)
  • func (v Volume) String() string

Constants

const (
	BundleID  = "mango"
	UserAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36"
)

Variables

var ImageExtensionRegex = regexp.MustCompile(`^\.[a-zA-Z0-9][a-zA-Z0-9.]*[a-zA-Z0-9]$`)

Functions

func Log

func Log(msg string)

Log calls (*libmangal.Logger).Log() which is set by libmangal via Provider.SetLogger.

It is the logger created by libmangal and used internally. Mangal also plugs into the logger (via (*libmangal.Client).Logger()) and uses it for info display.

It can also be set anywhere else, but usually it's something libmangal manages and since the Provider implementation handles the "setup" we can intercept it and use externally (like here in mangoprovider).

The logger is set once the provider is loaded, meaning that it will not be available for scraper/scraper.go for example, but it will for scraper/search_mangas.go as by that point the provider has been loaded.

TODO: provider mangal zerologger and use it when the *libmangal.Logger isn't available?

Types

type Chapter

type Chapter struct {
	Title           string         `json:"title"`
	ID              string         `json:"id"`
	URL             string         `json:"url"`
	Number          float32        `json:"number"`
	Date            libmangal.Date `json:"date"`
	ScanlationGroup string         `json:"scanlation_group"`

	Volume_ *Volume `json:"-"`
}

func (Chapter) Info

func (c Chapter) Info() libmangal.ChapterInfo

func (Chapter) MarshalJSON

func (c Chapter) MarshalJSON() ([]byte, error)

func (Chapter) String

func (c Chapter) String() string

func (Chapter) Volume

func (c Chapter) Volume() libmangal.Volume

type Filter

type Filter struct {
	NSFW                    bool
	Language                string
	MangaDexDataSaver       bool
	TitleChapterNumber      bool
	AvoidDuplicateChapters  bool
	ShowUnavailableChapters bool
}

func (*Filter) String

func (f *Filter) String() string

type Functions

type Functions struct {
	SearchMangas   func(context.Context, gokv.Store, string) ([]libmangal.Manga, error)
	MangaVolumes   func(context.Context, gokv.Store, Manga) ([]libmangal.Volume, error)
	VolumeChapters func(context.Context, gokv.Store, Volume) ([]libmangal.Chapter, error)
	ChapterPages   func(context.Context, gokv.Store, Chapter) ([]libmangal.Page, error)
	GetPageImage   func(context.Context, Page) ([]byte, error)
}

type Headless

type Headless struct {
	UseFlaresolverr bool
	FlaresolverrURL string
}

type Loader

type Loader struct {
	libmangal.ProviderInfo
	Options Options
	F       func() Functions // So that the scrapers are loaded on ProviderLoader.Load(ctx)
}

func (Loader) Info

func (l Loader) Info() libmangal.ProviderInfo

func (Loader) Load

func (l Loader) Load(ctx context.Context) (libmangal.Provider, error)

func (Loader) String

func (l Loader) String() string

type Manga

type Manga struct {
	Title         string `json:"title"`
	AnilistSearch string `json:"anilist_search"`
	URL           string `json:"url"`
	ID            string `json:"id"`
	Cover         string `json:"cover"`
	Banner        string `json:"banner"`
}

func (Manga) Info

func (m Manga) Info() libmangal.MangaInfo

func (Manga) MarshalJSON

func (m Manga) MarshalJSON() ([]byte, error)

func (Manga) String

func (m Manga) String() string

type Options

type Options struct {
	HTTPClient        *http.Client
	HTTPStoreProvider func(providerID string) (gokv.Store, error)
	Parallelism       uint8
	Headless
	Filter
}

type Page

type Page struct {
	Extension string            `json:"extension"`
	URL       string            `json:"url"`
	Headers   map[string]string `json:"headers"`
	Cookies   map[string]string `json:"cookies"`

	Chapter_ *Chapter `json:"-"`
}

func (Page) Chapter

func (p Page) Chapter() libmangal.Chapter

func (Page) GetExtension

func (p Page) GetExtension() string

func (Page) String

func (p Page) String() string

type Provider

type Provider struct {
	libmangal.ProviderInfo
	Options Options
	F       Functions
	// contains filtered or unexported fields
}

func (*Provider) ChapterPages

func (p *Provider) ChapterPages(
	ctx context.Context,
	chapter libmangal.Chapter,
) ([]libmangal.Page, error)

func (*Provider) Close

func (p *Provider) Close() error

func (*Provider) GenericGetPageImage

func (p *Provider) GenericGetPageImage(
	ctx context.Context,
	page Page,
) ([]byte, error)

func (*Provider) GetPageImage

func (p *Provider) GetPageImage(
	ctx context.Context,
	page libmangal.Page,
) ([]byte, error)

func (*Provider) Info

func (p *Provider) Info() libmangal.ProviderInfo

func (*Provider) MangaVolumes

func (p *Provider) MangaVolumes(
	ctx context.Context,
	manga libmangal.Manga,
) ([]libmangal.Volume, error)

func (*Provider) SearchMangas

func (p *Provider) SearchMangas(
	ctx context.Context,
	query string,
) ([]libmangal.Manga, error)

func (*Provider) SetLogger

func (p *Provider) SetLogger(_logger *libmangal.Logger)

func (*Provider) String

func (p *Provider) String() string

func (*Provider) VolumeChapters

func (p *Provider) VolumeChapters(
	ctx context.Context,
	volume libmangal.Volume,
) ([]libmangal.Chapter, error)

type Volume

type Volume struct {
	Number int `json:"number"`

	Manga_ *Manga `json:"-"`
}

func (Volume) Info

func (v Volume) Info() libmangal.VolumeInfo

func (Volume) Manga

func (v Volume) Manga() libmangal.Manga

func (Volume) MarshalJSON

func (v Volume) MarshalJSON() ([]byte, error)

func (Volume) String

func (v Volume) String() string