Refactor packages to have more idiomatic code base

http/handler/context.go

@@ -0,0 +1,160 @@
+// Copyright 2017 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 handler
+
+import (
+	"net/http"
+
+	"github.com/miniflux/miniflux/crypto"
+	"github.com/miniflux/miniflux/http/middleware"
+	"github.com/miniflux/miniflux/http/route"
+	"github.com/miniflux/miniflux/locale"
+	"github.com/miniflux/miniflux/logger"
+	"github.com/miniflux/miniflux/model"
+	"github.com/miniflux/miniflux/storage"
+
+	"github.com/gorilla/mux"
+)
+
+// Context contains helper functions related to the current request.
+type Context struct {
+	writer     http.ResponseWriter
+	request    *http.Request
+	store      *storage.Storage
+	router     *mux.Router
+	user       *model.User
+	translator *locale.Translator
+}
+
+// IsAdminUser checks if the logged user is administrator.
+func (c *Context) IsAdminUser() bool {
+	if v := c.request.Context().Value(middleware.IsAdminUserContextKey); v != nil {
+		return v.(bool)
+	}
+	return false
+}
+
+// UserTimezone returns the timezone used by the logged user.
+func (c *Context) UserTimezone() string {
+	value := c.getContextStringValue(middleware.UserTimezoneContextKey)
+	if value == "" {
+		value = "UTC"
+	}
+	return value
+}
+
+// IsAuthenticated returns a boolean if the user is authenticated.
+func (c *Context) IsAuthenticated() bool {
+	if v := c.request.Context().Value(middleware.IsAuthenticatedContextKey); v != nil {
+		return v.(bool)
+	}
+	return false
+}
+
+// UserID returns the UserID of the logged user.
+func (c *Context) UserID() int64 {
+	if v := c.request.Context().Value(middleware.UserIDContextKey); v != nil {
+		return v.(int64)
+	}
+	return 0
+}
+
+// LoggedUser returns all properties related to the logged user.
+func (c *Context) LoggedUser() *model.User {
+	if c.user == nil {
+		var err error
+		c.user, err = c.store.UserByID(c.UserID())
+		if err != nil {
+			logger.Fatal("[Context] %v", err)
+		}
+
+		if c.user == nil {
+			logger.Fatal("Unable to find user from context")
+		}
+	}
+
+	return c.user
+}
+
+// UserLanguage get the locale used by the current logged user.
+func (c *Context) UserLanguage() string {
+	user := c.LoggedUser()
+	return user.Language
+}
+
+// Translate translates a message in the current language.
+func (c *Context) Translate(message string, args ...interface{}) string {
+	return c.translator.GetLanguage(c.UserLanguage()).Get(message, args...)
+}
+
+// CSRF returns the current CSRF token.
+func (c *Context) CSRF() string {
+	return c.getContextStringValue(middleware.CSRFContextKey)
+}
+
+// SessionID returns the current session ID.
+func (c *Context) SessionID() string {
+	return c.getContextStringValue(middleware.SessionIDContextKey)
+}
+
+// UserSessionToken returns the current user session token.
+func (c *Context) UserSessionToken() string {
+	return c.getContextStringValue(middleware.UserSessionTokenContextKey)
+}
+
+// OAuth2State returns the current OAuth2 state.
+func (c *Context) OAuth2State() string {
+	return c.getContextStringValue(middleware.OAuth2StateContextKey)
+}
+
+// GenerateOAuth2State generate a new OAuth2 state.
+func (c *Context) GenerateOAuth2State() string {
+	state := crypto.GenerateRandomString(32)
+	c.store.UpdateSessionField(c.SessionID(), "oauth2_state", state)
+	return state
+}
+
+// SetFlashMessage defines a new flash message.
+func (c *Context) SetFlashMessage(message string) {
+	c.store.UpdateSessionField(c.SessionID(), "flash_message", message)
+}
+
+// FlashMessage returns the flash message and remove it.
+func (c *Context) FlashMessage() string {
+	message := c.getContextStringValue(middleware.FlashMessageContextKey)
+	c.store.UpdateSessionField(c.SessionID(), "flash_message", "")
+	return message
+}
+
+// SetFlashErrorMessage defines a new flash error message.
+func (c *Context) SetFlashErrorMessage(message string) {
+	c.store.UpdateSessionField(c.SessionID(), "flash_error_message", message)
+}
+
+// FlashErrorMessage returns the error flash message and remove it.
+func (c *Context) FlashErrorMessage() string {
+	message := c.getContextStringValue(middleware.FlashErrorMessageContextKey)
+	c.store.UpdateSessionField(c.SessionID(), "flash_error_message", "")
+	return message
+}
+
+func (c *Context) getContextStringValue(key *middleware.ContextKey) string {
+	if v := c.request.Context().Value(key); v != nil {
+		return v.(string)
+	}
+
+	logger.Error("[Core:Context] Missing key: %s", key)
+	return ""
+}
+
+// Route returns the path for the given arguments.
+func (c *Context) Route(name string, args ...interface{}) string {
+	return route.Path(c.router, name, args...)
+}
+
+// NewContext creates a new Context.
+func NewContext(r *http.Request, store *storage.Storage, router *mux.Router, translator *locale.Translator) *Context {
+	return &Context{request: r, store: store, router: router, translator: translator}
+}

http/handler/handler.go

@@ -0,0 +1,70 @@
+// Copyright 2017 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 handler
+
+import (
+	"net/http"
+	"time"
+
+	"github.com/miniflux/miniflux/config"
+	"github.com/miniflux/miniflux/http/middleware"
+	"github.com/miniflux/miniflux/locale"
+	"github.com/miniflux/miniflux/logger"
+	"github.com/miniflux/miniflux/storage"
+	"github.com/miniflux/miniflux/template"
+	"github.com/miniflux/miniflux/timer"
+
+	"github.com/gorilla/mux"
+	"github.com/tomasen/realip"
+)
+
+// ControllerFunc is an application HTTP handler.
+type ControllerFunc func(ctx *Context, request *Request, response *Response)
+
+// Handler manages HTTP handlers and middlewares.
+type Handler struct {
+	cfg        *config.Config
+	store      *storage.Storage
+	translator *locale.Translator
+	template   *template.Engine
+	router     *mux.Router
+	middleware *middleware.Chain
+}
+
+// Use is a wrapper around an HTTP handler.
+func (h *Handler) Use(f ControllerFunc) http.Handler {
+	return h.middleware.WrapFunc(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		defer timer.ExecutionTime(time.Now(), r.URL.Path)
+		logger.Debug("[HTTP] %s %s %s", realip.RealIP(r), r.Method, r.URL.Path)
+
+		if r.Header.Get("X-Forwarded-Proto") == "https" {
+			h.cfg.IsHTTPS = true
+		}
+
+		ctx := NewContext(r, h.store, h.router, h.translator)
+		request := NewRequest(r)
+		response := NewResponse(w, r, h.template)
+
+		if ctx.IsAuthenticated() {
+			h.template.SetLanguage(ctx.UserLanguage())
+		} else {
+			h.template.SetLanguage("en_US")
+		}
+
+		f(ctx, request, response)
+	}))
+}
+
+// NewHandler returns a new Handler.
+func NewHandler(cfg *config.Config, store *storage.Storage, router *mux.Router, template *template.Engine, translator *locale.Translator, middleware *middleware.Chain) *Handler {
+	return &Handler{
+		cfg:        cfg,
+		store:      store,
+		translator: translator,
+		router:     router,
+		template:   template,
+		middleware: middleware,
+	}
+}

http/handler/html_response.go

@@ -0,0 +1,65 @@
+// Copyright 2017 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 handler
+
+import (
+	"net/http"
+
+	"github.com/miniflux/miniflux/logger"
+	"github.com/miniflux/miniflux/template"
+)
+
+// HTMLResponse handles HTML responses.
+type HTMLResponse struct {
+	writer   http.ResponseWriter
+	request  *http.Request
+	template *template.Engine
+}
+
+// Render execute a template and send to the client the generated HTML.
+func (h *HTMLResponse) Render(template string, args map[string]interface{}) {
+	h.writer.Header().Set("Content-Type", "text/html; charset=utf-8")
+	h.template.Execute(h.writer, template, args)
+}
+
+// ServerError sends a 500 error to the browser.
+func (h *HTMLResponse) ServerError(err error) {
+	h.writer.Header().Set("Content-Type", "text/html; charset=utf-8")
+	h.writer.WriteHeader(http.StatusInternalServerError)
+
+	if err != nil {
+		logger.Error("[Internal Server Error] %v", err)
+		h.writer.Write([]byte("Internal Server Error: " + err.Error()))
+	} else {
+		h.writer.Write([]byte("Internal Server Error"))
+	}
+}
+
+// BadRequest sends a 400 error to the browser.
+func (h *HTMLResponse) BadRequest(err error) {
+	h.writer.Header().Set("Content-Type", "text/html; charset=utf-8")
+	h.writer.WriteHeader(http.StatusBadRequest)
+
+	if err != nil {
+		logger.Error("[Bad Request] %v", err)
+		h.writer.Write([]byte("Bad Request: " + err.Error()))
+	} else {
+		h.writer.Write([]byte("Bad Request"))
+	}
+}
+
+// NotFound sends a 404 error to the browser.
+func (h *HTMLResponse) NotFound() {
+	h.writer.Header().Set("Content-Type", "text/html; charset=utf-8")
+	h.writer.WriteHeader(http.StatusNotFound)
+	h.writer.Write([]byte("Page Not Found"))
+}
+
+// Forbidden sends a 403 error to the browser.
+func (h *HTMLResponse) Forbidden() {
+	h.writer.Header().Set("Content-Type", "text/html; charset=utf-8")
+	h.writer.WriteHeader(http.StatusForbidden)
+	h.writer.Write([]byte("Access Forbidden"))
+}

http/handler/json_response.go

@@ -0,0 +1,111 @@
+// Copyright 2017 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 handler
+
+import (
+	"encoding/json"
+	"errors"
+	"net/http"
+
+	"github.com/miniflux/miniflux/logger"
+)
+
+// JSONResponse handles JSON responses.
+type JSONResponse struct {
+	writer  http.ResponseWriter
+	request *http.Request
+}
+
+// Standard sends a JSON response with the status code 200.
+func (j *JSONResponse) Standard(v interface{}) {
+	j.commonHeaders()
+	j.writer.WriteHeader(http.StatusOK)
+	j.writer.Write(j.toJSON(v))
+}
+
+// Created sends a JSON response with the status code 201.
+func (j *JSONResponse) Created(v interface{}) {
+	j.commonHeaders()
+	j.writer.WriteHeader(http.StatusCreated)
+	j.writer.Write(j.toJSON(v))
+}
+
+// NoContent sends a JSON response with the status code 204.
+func (j *JSONResponse) NoContent() {
+	j.commonHeaders()
+	j.writer.WriteHeader(http.StatusNoContent)
+}
+
+// BadRequest sends a JSON response with the status code 400.
+func (j *JSONResponse) BadRequest(err error) {
+	logger.Error("[Bad Request] %v", err)
+	j.commonHeaders()
+	j.writer.WriteHeader(http.StatusBadRequest)
+
+	if err != nil {
+		j.writer.Write(j.encodeError(err))
+	}
+}
+
+// NotFound sends a JSON response with the status code 404.
+func (j *JSONResponse) NotFound(err error) {
+	logger.Error("[Not Found] %v", err)
+	j.commonHeaders()
+	j.writer.WriteHeader(http.StatusNotFound)
+	j.writer.Write(j.encodeError(err))
+}
+
+// ServerError sends a JSON response with the status code 500.
+func (j *JSONResponse) ServerError(err error) {
+	logger.Error("[Internal Server Error] %v", err)
+	j.commonHeaders()
+	j.writer.WriteHeader(http.StatusInternalServerError)
+
+	if err != nil {
+		j.writer.Write(j.encodeError(err))
+	}
+}
+
+// Forbidden sends a JSON response with the status code 403.
+func (j *JSONResponse) Forbidden() {
+	logger.Info("[API:Forbidden]")
+	j.commonHeaders()
+	j.writer.WriteHeader(http.StatusForbidden)
+	j.writer.Write(j.encodeError(errors.New("Access Forbidden")))
+}
+
+func (j *JSONResponse) commonHeaders() {
+	j.writer.Header().Set("Accept", "application/json")
+	j.writer.Header().Set("Content-Type", "application/json; charset=utf-8")
+}
+
+func (j *JSONResponse) encodeError(err error) []byte {
+	type errorMsg struct {
+		ErrorMessage string `json:"error_message"`
+	}
+
+	tmp := errorMsg{ErrorMessage: err.Error()}
+	data, err := json.Marshal(tmp)
+	if err != nil {
+		logger.Error("encoding error: %v", err)
+	}
+
+	return data
+}
+
+func (j *JSONResponse) toJSON(v interface{}) []byte {
+	b, err := json.Marshal(v)
+	if err != nil {
+		logger.Error("encoding error: %v", err)
+		return []byte("")
+	}
+
+	return b
+}
+
+// NewJSONResponse returns a new JSONResponse.
+func NewJSONResponse(w http.ResponseWriter, r *http.Request) *JSONResponse {
+	return &JSONResponse{request: r, writer: w}
+}

http/handler/request.go

@@ -0,0 +1,124 @@
+// Copyright 2017 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 handler
+
+import (
+	"fmt"
+	"io"
+	"mime/multipart"
+	"net/http"
+	"strconv"
+
+	"github.com/gorilla/mux"
+	"github.com/miniflux/miniflux/logger"
+)
+
+// Request is a thin wrapper around "http.Request".
+type Request struct {
+	request *http.Request
+}
+
+// Request returns the raw Request struct.
+func (r *Request) Request() *http.Request {
+	return r.request
+}
+
+// Body returns the request body.
+func (r *Request) Body() io.ReadCloser {
+	return r.request.Body
+}
+
+// File returns uploaded file properties.
+func (r *Request) File(name string) (multipart.File, *multipart.FileHeader, error) {
+	return r.request.FormFile(name)
+}
+
+// Cookie returns the cookie value.
+func (r *Request) Cookie(name string) string {
+	cookie, err := r.request.Cookie(name)
+	if err == http.ErrNoCookie {
+		return ""
+	}
+
+	return cookie.Value
+}
+
+// FormValue returns a form value as integer.
+func (r *Request) FormValue(param string) string {
+	return r.request.FormValue(param)
+}
+
+// FormIntegerValue returns a form value as integer.
+func (r *Request) FormIntegerValue(param string) int64 {
+	value := r.request.FormValue(param)
+	integer, _ := strconv.Atoi(value)
+	return int64(integer)
+}
+
+// IntegerParam returns an URL parameter as integer.
+func (r *Request) IntegerParam(param string) (int64, error) {
+	vars := mux.Vars(r.request)
+	value, err := strconv.Atoi(vars[param])
+	if err != nil {
+		logger.Error("[IntegerParam] %v", err)
+		return 0, fmt.Errorf("%s parameter is not an integer", param)
+	}
+
+	if value < 0 {
+		return 0, nil
+	}
+
+	return int64(value), nil
+}
+
+// StringParam returns an URL parameter as string.
+func (r *Request) StringParam(param, defaultValue string) string {
+	vars := mux.Vars(r.request)
+	value := vars[param]
+	if value == "" {
+		value = defaultValue
+	}
+	return value
+}
+
+// QueryStringParam returns a querystring parameter as string.
+func (r *Request) QueryStringParam(param, defaultValue string) string {
+	value := r.request.URL.Query().Get(param)
+	if value == "" {
+		value = defaultValue
+	}
+	return value
+}
+
+// QueryIntegerParam returns a querystring parameter as string.
+func (r *Request) QueryIntegerParam(param string, defaultValue int) int {
+	value := r.request.URL.Query().Get(param)
+	if value == "" {
+		return defaultValue
+	}
+
+	val, err := strconv.Atoi(value)
+	if err != nil {
+		return defaultValue
+	}
+
+	if val < 0 {
+		return defaultValue
+	}
+
+	return val
+}
+
+// HasQueryParam checks if the query string contains the given parameter.
+func (r *Request) HasQueryParam(param string) bool {
+	values := r.request.URL.Query()
+	_, ok := values[param]
+	return ok
+}
+
+// NewRequest returns a new Request.
+func NewRequest(r *http.Request) *Request {
+	return &Request{r}
+}

http/handler/response.go

@@ -0,0 +1,82 @@
+// Copyright 2017 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 handler
+
+import (
+	"net/http"
+	"time"
+
+	"github.com/miniflux/miniflux/template"
+)
+
+// Response handles HTTP responses.
+type Response struct {
+	writer   http.ResponseWriter
+	request  *http.Request
+	template *template.Engine
+}
+
+// SetCookie send a cookie to the client.
+func (r *Response) SetCookie(cookie *http.Cookie) {
+	http.SetCookie(r.writer, cookie)
+}
+
+// JSON returns a JSONResponse.
+func (r *Response) JSON() *JSONResponse {
+	r.commonHeaders()
+	return NewJSONResponse(r.writer, r.request)
+}
+
+// HTML returns a HTMLResponse.
+func (r *Response) HTML() *HTMLResponse {
+	r.commonHeaders()
+	return &HTMLResponse{writer: r.writer, request: r.request, template: r.template}
+}
+
+// XML returns a XMLResponse.
+func (r *Response) XML() *XMLResponse {
+	r.commonHeaders()
+	return &XMLResponse{writer: r.writer, request: r.request}
+}
+
+// Redirect redirects the user to another location.
+func (r *Response) Redirect(path string) {
+	http.Redirect(r.writer, r.request, path, http.StatusFound)
+}
+
+// NotModified sends a response with a 304 status code.
+func (r *Response) NotModified() {
+	r.commonHeaders()
+	r.writer.WriteHeader(http.StatusNotModified)
+}
+
+// Cache returns a response with caching headers.
+func (r *Response) Cache(mimeType, etag string, content []byte, duration time.Duration) {
+	r.writer.Header().Set("Content-Type", mimeType)
+	r.writer.Header().Set("ETag", etag)
+	r.writer.Header().Set("Cache-Control", "public")
+	r.writer.Header().Set("Expires", time.Now().Add(duration).Format(time.RFC1123))
+
+	if etag == r.request.Header.Get("If-None-Match") {
+		r.writer.WriteHeader(http.StatusNotModified)
+	} else {
+		r.writer.Write(content)
+	}
+}
+
+func (r *Response) commonHeaders() {
+	r.writer.Header().Set("X-XSS-Protection", "1; mode=block")
+	r.writer.Header().Set("X-Content-Type-Options", "nosniff")
+	r.writer.Header().Set("X-Frame-Options", "DENY")
+
+	// Even if the directive "frame-src" has been deprecated in Firefox,
+	// we keep it to stay compatible with other browsers.
+	r.writer.Header().Set("Content-Security-Policy", "default-src 'self'; img-src *; media-src *; frame-src *; child-src *")
+}
+
+// NewResponse returns a new Response.
+func NewResponse(w http.ResponseWriter, r *http.Request, template *template.Engine) *Response {
+	return &Response{writer: w, request: r, template: template}
+}

http/handler/xml_response.go

@@ -0,0 +1,23 @@
+// Copyright 2017 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 handler
+
+import (
+	"fmt"
+	"net/http"
+)
+
+// XMLResponse handles XML responses.
+type XMLResponse struct {
+	writer  http.ResponseWriter
+	request *http.Request
+}
+
+// Download force the download of a XML document.
+func (x *XMLResponse) Download(filename, data string) {
+	x.writer.Header().Set("Content-Type", "text/xml")
+	x.writer.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%s", filename))
+	x.writer.Write([]byte(data))
+}