core

Documentation

Index

• Variables
• func InitLogger(isVerbose, isDebug bool)
• type Browser
  • func NewBrowser(opts BrowserOpts) (*Browser, error)
  • func (b *Browser) Close() error
  • func (b *Browser) IsInitialized() bool
  • func (b *Browser) Navigate(URL string) *rod.Page
• type BrowserOpts
  • func (o *BrowserOpts) Check()
• type Query
  • func (q *Query) InitFromContext(c *fiber.Ctx) error
  • func (q Query) IsEmpty() bool
• type SearchEngine
• type SearchEngineOptions
  • func (o *SearchEngineOptions) GetRatelimit() time.Duration
  • func (o *SearchEngineOptions) GetSelectorTimeout() time.Duration
  • func (o *SearchEngineOptions) Init()
• type SearchResult
• type Server
  • func NewServer(host string, port int, searchEngines ...SearchEngine) *Server
  • func (s *Server) Listen() error
  • func (s *Server) Shutdown() error

Variables

var ErrCaptcha = errors.New("Captcha detected")

var ErrSearchTimeout = errors.New("Timeout. Cannot find element on page")

Functions

func InitLogger

func InitLogger(isVerbose, isDebug bool)

Types

type Browser

type Browser struct {
	BrowserOpts
	// contains filtered or unexported fields
}

func NewBrowser

func NewBrowser(opts BrowserOpts) (*Browser, error)

func (*Browser) Close

func (b *Browser) Close() error

func (*Browser) IsInitialized

func (b *Browser) IsInitialized() bool

Check whether browser instance is already created

func (*Browser) Navigate

func (b *Browser) Navigate(URL string) *rod.Page

Open URL

type BrowserOpts

type BrowserOpts struct {
	IsHeadless    bool          // Use browser interface
	IsLeakless    bool          // Force to kill browser
	Timeout       time.Duration // Timeout
	LanguageCode  string
	WaitRequests  bool          // Wait requests to complete after navigation
	LeavePageOpen bool          // Leave pages and browser open
	WaitLoadTime  time.Duration // Time to wait till page loads
}

func (*BrowserOpts) Check

func (o *BrowserOpts) Check()

Initialize browser parameters with default values if they are not set

type Query

type Query struct {
	Text         string
	LangCode     string // eg. EN, ES, RU...
	DateInterval string // format: YYYYMMDD..YYYMMDD - 20181010..20231010
	Filetype     string // File extension to search.
	Site         string // Search site
	Limit        int    // Limit the number of results
}

func (*Query) InitFromContext

func (q *Query) InitFromContext(c *fiber.Ctx) error

func (Query) IsEmpty

func (q Query) IsEmpty() bool

type SearchEngine

type SearchEngine interface {
	Search(Query) ([]SearchResult, error)
	IsInitialized() bool
	Name() string
	GetRateLimiter() *rate.Limiter
}

type SearchEngineOptions

type SearchEngineOptions struct {
	RateRequests    int   `mapstructure:"rate_requests"`
	RateTime        int64 `mapstructure:"rate_seconds"`
	RateBurst       int   `mapstructure:"rate_burst"`
	SelectorTimeout int64 `mapstructure:"selector_timeout"` // CSS selector timeout in seconds
}

func (*SearchEngineOptions) GetRatelimit

func (o *SearchEngineOptions) GetRatelimit() time.Duration

func (*SearchEngineOptions) GetSelectorTimeout

func (o *SearchEngineOptions) GetSelectorTimeout() time.Duration

func (*SearchEngineOptions) Init

func (o *SearchEngineOptions) Init()

type SearchResult

type SearchResult struct {
	Rank        int    `json:"rank"`
	URL         string `json:"url"`
	Title       string `json:"title"`
	Description string `json:"description"`
}

type Server

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

func NewServer

func NewServer(host string, port int, searchEngines ...SearchEngine) *Server

func (*Server) Listen

func (s *Server) Listen() error

func (*Server) Shutdown

func (s *Server) Shutdown() error