crawlerdetect

Documentation

Index

• Constants
• type MiddlewareBuilder
  • func InitMiddlewareBuilder() *MiddlewareBuilder
  • func (b *MiddlewareBuilder) AddUserAgent(userAgents map[string][]string) *MiddlewareBuilder
  • func (b *MiddlewareBuilder) Build() mist.Middleware
  • func (b *MiddlewareBuilder) RemoveUserAgent(userAgents ...string) *MiddlewareBuilder

Constants

const Baidu = crawlerdetect.Baidu

Baidu Initialize constants for crawler identification strings as provided by the crawlerdetect package.

const Bing = crawlerdetect.Bing

const Google = crawlerdetect.Google

const SoGou = crawlerdetect.SoGou

Types

type MiddlewareBuilder

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

MiddlewareBuilder struct to configure middleware for detecting web crawlers.

func InitMiddlewareBuilder

func InitMiddlewareBuilder() *MiddlewareBuilder

InitMiddlewareBuilder initializes and returns an instance of MiddlewareBuilder. It sets the default mappings between user agent strings of crawlers and their respective names from the crawlerdetect package.

func (*MiddlewareBuilder) AddUserAgent

func (b *MiddlewareBuilder) AddUserAgent(userAgents map[string][]string) *MiddlewareBuilder

AddUserAgent takes a map of crawlers to their corresponding user agents (as slices of strings) and updates the MiddlewareBuilder's crawlersMap to include these associations. Parameters:

• userAgents: a map where the key is a string representing the crawler's name, and the value is a slice of strings representing the user agent strings associated with that crawler.

Returns: - a pointer to the updated MiddlewareBuilder for method chaining.

func (*MiddlewareBuilder) Build

func (b *MiddlewareBuilder) Build() mist.Middleware

Build creates a new middleware function that intercepts HTTP requests to perform crawler detection based on the user agent and client IP address. Returns: - a middleware function that fits the mist.Middleware function signature.

func (*MiddlewareBuilder) RemoveUserAgent

func (b *MiddlewareBuilder) RemoveUserAgent(userAgents ...string) *MiddlewareBuilder

RemoveUserAgent takes a variadic parameter of user agent strings and removes them from the MiddlewareBuilder's crawlersMap if they exist. Parameters:

• userAgents: a variadic parameter where each argument is a string representing a user agent to be removed from the MiddlewareBuilder's crawlersMap.

Returns: - a pointer to the updated MiddlewareBuilder for method chaining.