aboutsummaryrefslogtreecommitdiffhomepage
path: root/http/client/client.go
diff options
context:
space:
mode:
Diffstat (limited to 'http/client/client.go')
-rw-r--r--http/client/client.go223
1 files changed, 223 insertions, 0 deletions
diff --git a/http/client/client.go b/http/client/client.go
new file mode 100644
index 0000000..7663064
--- /dev/null
+++ b/http/client/client.go
@@ -0,0 +1,223 @@
+// Copyright 2018 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the Apache 2.0
+// license that can be found in the LICENSE file.
+
+package client
+
+import (
+ "bytes"
+ "crypto/tls"
+ "crypto/x509"
+ "encoding/json"
+ "fmt"
+ "io"
+ "net"
+ "net/http"
+ "net/url"
+ "strings"
+ "time"
+
+ "github.com/miniflux/miniflux/errors"
+ "github.com/miniflux/miniflux/logger"
+ "github.com/miniflux/miniflux/timer"
+ "github.com/miniflux/miniflux/version"
+)
+
+const (
+ // 20 seconds max.
+ requestTimeout = 20
+
+ // 15MB max.
+ maxBodySize = 1024 * 1024 * 15
+)
+
+var (
+ errInvalidCertificate = "Invalid SSL certificate (original error: %q)"
+ errTemporaryNetworkOperation = "This website is temporarily unreachable (original error: %q)"
+ errPermanentNetworkOperation = "This website is permanently unreachable (original error: %q)"
+ errRequestTimeout = "Website unreachable, the request timed out after %d seconds"
+)
+
+// Client is a HTTP Client :)
+type Client struct {
+ url string
+ etagHeader string
+ lastModifiedHeader string
+ authorizationHeader string
+ username string
+ password string
+ Insecure bool
+}
+
+// WithCredentials defines the username/password for HTTP Basic authentication.
+func (c *Client) WithCredentials(username, password string) *Client {
+ c.username = username
+ c.password = password
+ return c
+}
+
+// WithAuthorization defines authorization header value.
+func (c *Client) WithAuthorization(authorization string) *Client {
+ c.authorizationHeader = authorization
+ return c
+}
+
+// WithCacheHeaders defines caching headers.
+func (c *Client) WithCacheHeaders(etagHeader, lastModifiedHeader string) *Client {
+ c.etagHeader = etagHeader
+ c.lastModifiedHeader = lastModifiedHeader
+ return c
+}
+
+// Get execute a GET HTTP request.
+func (c *Client) Get() (*Response, error) {
+ request, err := c.buildRequest(http.MethodGet, nil)
+ if err != nil {
+ return nil, err
+ }
+
+ return c.executeRequest(request)
+}
+
+// PostForm execute a POST HTTP request with form values.
+func (c *Client) PostForm(values url.Values) (*Response, error) {
+ request, err := c.buildRequest(http.MethodPost, strings.NewReader(values.Encode()))
+ if err != nil {
+ return nil, err
+ }
+
+ request.Header.Add("Content-Type", "application/x-www-form-urlencoded")
+ return c.executeRequest(request)
+}
+
+// PostJSON execute a POST HTTP request with JSON payload.
+func (c *Client) PostJSON(data interface{}) (*Response, error) {
+ b, err := json.Marshal(data)
+ if err != nil {
+ return nil, err
+ }
+
+ request, err := c.buildRequest(http.MethodPost, bytes.NewReader(b))
+ if err != nil {
+ return nil, err
+ }
+
+ request.Header.Add("Content-Type", "application/json")
+ return c.executeRequest(request)
+}
+
+func (c *Client) executeRequest(request *http.Request) (*Response, error) {
+ defer timer.ExecutionTime(time.Now(), fmt.Sprintf("[HttpClient] url=%s", c.url))
+
+ client := c.buildClient()
+ resp, err := client.Do(request)
+ if err != nil {
+ if uerr, ok := err.(*url.Error); ok {
+ switch uerr.Err.(type) {
+ case x509.CertificateInvalidError, x509.HostnameError:
+ err = errors.NewLocalizedError(errInvalidCertificate, uerr.Err)
+ case *net.OpError:
+ if uerr.Err.(*net.OpError).Temporary() {
+ err = errors.NewLocalizedError(errTemporaryNetworkOperation, uerr.Err)
+ } else {
+ err = errors.NewLocalizedError(errPermanentNetworkOperation, uerr.Err)
+ }
+ case net.Error:
+ nerr := uerr.Err.(net.Error)
+ if nerr.Timeout() {
+ err = errors.NewLocalizedError(errRequestTimeout, requestTimeout)
+ } else if nerr.Temporary() {
+ err = errors.NewLocalizedError(errTemporaryNetworkOperation, nerr)
+ }
+ }
+ }
+
+ return nil, err
+ }
+
+ if resp.ContentLength > maxBodySize {
+ return nil, fmt.Errorf("client: response too large (%d bytes)", resp.ContentLength)
+ }
+
+ response := &Response{
+ Body: resp.Body,
+ StatusCode: resp.StatusCode,
+ EffectiveURL: resp.Request.URL.String(),
+ LastModified: resp.Header.Get("Last-Modified"),
+ ETag: resp.Header.Get("ETag"),
+ ContentType: resp.Header.Get("Content-Type"),
+ ContentLength: resp.ContentLength,
+ }
+
+ logger.Debug("[HttpClient:%s] URL=%s, EffectiveURL=%s, Code=%d, Length=%d, Type=%s, ETag=%s, LastMod=%s, Expires=%s",
+ request.Method,
+ c.url,
+ response.EffectiveURL,
+ response.StatusCode,
+ resp.ContentLength,
+ response.ContentType,
+ response.ETag,
+ response.LastModified,
+ resp.Header.Get("Expires"),
+ )
+
+ // Ignore caching headers for feeds that do not want any cache.
+ if resp.Header.Get("Expires") == "0" {
+ logger.Debug("[HttpClient] Ignore caching headers for %q", response.EffectiveURL)
+ response.ETag = ""
+ response.LastModified = ""
+ }
+
+ return response, err
+}
+
+func (c *Client) buildRequest(method string, body io.Reader) (*http.Request, error) {
+ request, err := http.NewRequest(method, c.url, body)
+ if err != nil {
+ return nil, err
+ }
+
+ request.Header = c.buildHeaders()
+
+ if c.username != "" && c.password != "" {
+ request.SetBasicAuth(c.username, c.password)
+ }
+
+ return request, nil
+}
+
+func (c *Client) buildClient() http.Client {
+ client := http.Client{Timeout: time.Duration(requestTimeout * time.Second)}
+ if c.Insecure {
+ client.Transport = &http.Transport{
+ TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
+ }
+ }
+
+ return client
+}
+
+func (c *Client) buildHeaders() http.Header {
+ headers := make(http.Header)
+ headers.Add("User-Agent", "Mozilla/5.0 (compatible; Miniflux/"+version.Version+"; +https://miniflux.net)")
+ headers.Add("Accept", "*/*")
+
+ if c.etagHeader != "" {
+ headers.Add("If-None-Match", c.etagHeader)
+ }
+
+ if c.lastModifiedHeader != "" {
+ headers.Add("If-Modified-Since", c.lastModifiedHeader)
+ }
+
+ if c.authorizationHeader != "" {
+ headers.Add("Authorization", c.authorizationHeader)
+ }
+
+ return headers
+}
+
+// New returns a new HTTP client.
+func New(url string) *Client {
+ return &Client{url: url, Insecure: false}
+}