client

Documentation

Index

• Variables
• func ParseAPIResult(r io.Reader) (ret gjson.Result, err error)
• func With(ctx context.Context, v *Client) context.Context
• type BypassSNIBlockingTransport
  • func (t *BypassSNIBlockingTransport) RoundTrip(req *http.Request) (resp *http.Response, err error)
• type Client
  • func For(ctx context.Context) *Client
  • func NewDefaultClient() *Client
  • func (c *Client) ApplyDefault()
  • func (c *Client) BypassSNIBlocking()
  • func (c Client) EndpointURL(path string, values *url.Values) *url.URL
  • func (c *Client) GetWithContext(ctx context.Context, url string) (resp *http.Response, err error)
  • func (c Client) IsLoggedIn() (ret bool, err error)
  • func (c *Client) Login(username string, password string) (err error)
  • func (c *Client) SetDefaultHeader(key, value string)
  • func (c *Client) SetPHPSESSID(v string)
  • func (c *Client) SetRequestOptions(options ...RequestOption)
• type RequestOption
• type RequestOptionsTransport
  • func (t *RequestOptionsTransport) RoundTrip(req *http.Request) (resp *http.Response, err error)

Variables

var BlockedHostnames = map[string]struct{}{
	"www.pixiv.net": {},
	"i.pximg.net":   {},
}

BlockedHostnames constains hosts that blocked by sni detect.

var DefaultBypassSNIBlocking = os.Getenv("PIXIV_BYPASS_SNI_BLOCKING") != ""

var DefaultDNSQueryURL = os.Getenv("PIXIV_DNS_QUERY_URL")

DNSQueryURL is DNS over HTTPS service url that act like google public dns json api https://developers.google.com/speed/public-dns/docs/doh/json

var DefaultPHPSESSID = os.Getenv("PIXIV_PHPSESSID")

var DefaultUserAgent = os.Getenv("PIXIV_USER_AGENT")

DefaultUserAgent for new clients

Functions

func ParseAPIResult

func ParseAPIResult(r io.Reader) (ret gjson.Result, err error)

ParseAPIResult parses error from json api response, and returns body part.

func With

func With(ctx context.Context, v *Client) context.Context

With set client to context.

Types

type BypassSNIBlockingTransport

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

BypassSNIBlockingTransport bypass sni bloking when host in BlockedHostnames

func (*BypassSNIBlockingTransport) RoundTrip

func (t *BypassSNIBlockingTransport) RoundTrip(req *http.Request) (resp *http.Response, err error)

RoundTrip implements http.RoundTripper

type Client

type Client struct {
	ServerURL   string
	DNSResolver dns.Resolver
	http.Client
}

Client to send request to pixiv server.

var Default *Client

Default client auto login with PIXIV_PHPSESSID env var.

func For

func For(ctx context.Context) *Client

For get client from context.

func NewDefaultClient

func NewDefaultClient() *Client

func (*Client) ApplyDefault

func (c *Client) ApplyDefault()

func (*Client) BypassSNIBlocking

func (c *Client) BypassSNIBlocking()

BypassSNIBlocking wrap current transport with bypass sni blocking support. must set before other settings, because it use a new http.Transport for blocked host

func (Client) EndpointURL

func (c Client) EndpointURL(path string, values *url.Values) *url.URL

EndpointURL returns url for server endpint.

func (*Client) GetWithContext

func (c *Client) GetWithContext(ctx context.Context, url string) (resp *http.Response, err error)

GetWithContext create get request with context and do it.

func (Client) IsLoggedIn

func (c Client) IsLoggedIn() (ret bool, err error)

IsLoggedIn checks login status base on `HEAD https://www.pixiv.net/setting_user.php` response status.

func (*Client) Login

func (c *Client) Login(username string, password string) (err error)

Login with username and password

func (*Client) SetDefaultHeader

func (c *Client) SetDefaultHeader(key, value string)

SetDefaultHeader for all requests

func (*Client) SetPHPSESSID

func (c *Client) SetPHPSESSID(v string)

SetPHPSESSID set client cookie to skip login.

func (*Client) SetRequestOptions

func (c *Client) SetRequestOptions(options ...RequestOption)

SetRequestOptions for all requests

type RequestOption

type RequestOption = func(req *http.Request)

RequestOption can mutate request before actual send it.

type RequestOptionsTransport

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

RequestOptionsTransport allow change request before do it.

func (*RequestOptionsTransport) RoundTrip

func (t *RequestOptionsTransport) RoundTrip(req *http.Request) (resp *http.Response, err error)

RoundTrip implements http.RoundTripper