First commit

server/core/context.go

@@ -0,0 +1,99 @@
+// 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 core
+
+import (
+	"github.com/miniflux/miniflux2/model"
+	"github.com/miniflux/miniflux2/server/route"
+	"github.com/miniflux/miniflux2/storage"
+	"log"
+	"net/http"
+
+	"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
+}
+
+// IsAdminUser checks if the logged user is administrator.
+func (c *Context) IsAdminUser() bool {
+	if v := c.request.Context().Value("IsAdminUser"); v != nil {
+		return v.(bool)
+	}
+	return false
+}
+
+// GetUserTimezone returns the timezone used by the logged user.
+func (c *Context) GetUserTimezone() string {
+	if v := c.request.Context().Value("UserTimezone"); v != nil {
+		return v.(string)
+	}
+	return "UTC"
+}
+
+// IsAuthenticated returns a boolean if the user is authenticated.
+func (c *Context) IsAuthenticated() bool {
+	if v := c.request.Context().Value("IsAuthenticated"); v != nil {
+		return v.(bool)
+	}
+	return false
+}
+
+// GetUserID returns the UserID of the logged user.
+func (c *Context) GetUserID() int64 {
+	if v := c.request.Context().Value("UserId"); v != nil {
+		return v.(int64)
+	}
+	return 0
+}
+
+// GetLoggedUser returns all properties related to the logged user.
+func (c *Context) GetLoggedUser() *model.User {
+	if c.user == nil {
+		var err error
+		c.user, err = c.store.GetUserById(c.GetUserID())
+		if err != nil {
+			log.Fatalln(err)
+		}
+
+		if c.user == nil {
+			log.Fatalln("Unable to find user from context")
+		}
+	}
+
+	return c.user
+}
+
+// GetUserLanguage get the locale used by the current logged user.
+func (c *Context) GetUserLanguage() string {
+	user := c.GetLoggedUser()
+	return user.Language
+}
+
+// GetCsrfToken returns the current CSRF token.
+func (c *Context) GetCsrfToken() string {
+	if v := c.request.Context().Value("CsrfToken"); v != nil {
+		return v.(string)
+	}
+
+	log.Println("No CSRF token in context!")
+	return ""
+}
+
+// GetRoute returns the path for the given arguments.
+func (c *Context) GetRoute(name string, args ...interface{}) string {
+	return route.GetRoute(c.router, name, args...)
+}
+
+// NewContext creates a new Context.
+func NewContext(w http.ResponseWriter, r *http.Request, store *storage.Storage, router *mux.Router) *Context {
+	return &Context{writer: w, request: r, store: store, router: router}
+}

server/core/handler.go

@@ -0,0 +1,57 @@
+// 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 core
+
+import (
+	"github.com/miniflux/miniflux2/helper"
+	"github.com/miniflux/miniflux2/locale"
+	"github.com/miniflux/miniflux2/server/middleware"
+	"github.com/miniflux/miniflux2/server/template"
+	"github.com/miniflux/miniflux2/storage"
+	"log"
+	"net/http"
+	"time"
+
+	"github.com/gorilla/mux"
+)
+
+type HandlerFunc func(ctx *Context, request *Request, response *Response)
+
+type Handler struct {
+	store      *storage.Storage
+	translator *locale.Translator
+	template   *template.TemplateEngine
+	router     *mux.Router
+	middleware *middleware.MiddlewareChain
+}
+
+func (h *Handler) Use(f HandlerFunc) http.Handler {
+	return h.middleware.WrapFunc(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		defer helper.ExecutionTime(time.Now(), r.URL.Path)
+		log.Println(r.Method, r.URL.Path)
+
+		ctx := NewContext(w, r, h.store, h.router)
+		request := NewRequest(w, r)
+		response := NewResponse(w, r, h.template)
+
+		if ctx.IsAuthenticated() {
+			h.template.SetLanguage(ctx.GetUserLanguage())
+		} else {
+			h.template.SetLanguage("en_US")
+		}
+
+		f(ctx, request, response)
+	}))
+}
+
+func NewHandler(store *storage.Storage, router *mux.Router, template *template.TemplateEngine, translator *locale.Translator, middleware *middleware.MiddlewareChain) *Handler {
+	return &Handler{
+		store:      store,
+		translator: translator,
+		router:     router,
+		template:   template,
+		middleware: middleware,
+	}
+}

server/core/html_response.go

@@ -0,0 +1,58 @@
+// 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 core
+
+import (
+	"github.com/miniflux/miniflux2/server/template"
+	"log"
+	"net/http"
+)
+
+type HtmlResponse struct {
+	writer   http.ResponseWriter
+	request  *http.Request
+	template *template.TemplateEngine
+}
+
+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)
+}
+
+func (h *HtmlResponse) ServerError(err error) {
+	h.writer.WriteHeader(http.StatusInternalServerError)
+	h.writer.Header().Set("Content-Type", "text/html; charset=utf-8")
+
+	if err != nil {
+		log.Println(err)
+		h.writer.Write([]byte("Internal Server Error: " + err.Error()))
+	} else {
+		h.writer.Write([]byte("Internal Server Error"))
+	}
+}
+
+func (h *HtmlResponse) BadRequest(err error) {
+	h.writer.WriteHeader(http.StatusBadRequest)
+	h.writer.Header().Set("Content-Type", "text/html; charset=utf-8")
+
+	if err != nil {
+		log.Println(err)
+		h.writer.Write([]byte("Bad Request: " + err.Error()))
+	} else {
+		h.writer.Write([]byte("Bad Request"))
+	}
+}
+
+func (h *HtmlResponse) NotFound() {
+	h.writer.WriteHeader(http.StatusNotFound)
+	h.writer.Header().Set("Content-Type", "text/html; charset=utf-8")
+	h.writer.Write([]byte("Page Not Found"))
+}
+
+func (h *HtmlResponse) Forbidden() {
+	h.writer.WriteHeader(http.StatusForbidden)
+	h.writer.Header().Set("Content-Type", "text/html; charset=utf-8")
+	h.writer.Write([]byte("Access Forbidden"))
+}

server/core/json_response.go

@@ -0,0 +1,94 @@
+// 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 core
+
+import (
+	"encoding/json"
+	"errors"
+	"log"
+	"net/http"
+)
+
+type JsonResponse struct {
+	writer  http.ResponseWriter
+	request *http.Request
+}
+
+func (j *JsonResponse) Standard(v interface{}) {
+	j.writer.WriteHeader(http.StatusOK)
+	j.commonHeaders()
+	j.writer.Write(j.toJSON(v))
+}
+
+func (j *JsonResponse) Created(v interface{}) {
+	j.writer.WriteHeader(http.StatusCreated)
+	j.commonHeaders()
+	j.writer.Write(j.toJSON(v))
+}
+
+func (j *JsonResponse) NoContent() {
+	j.writer.WriteHeader(http.StatusNoContent)
+	j.commonHeaders()
+}
+
+func (j *JsonResponse) BadRequest(err error) {
+	log.Println("[API:BadRequest]", err)
+	j.writer.WriteHeader(http.StatusBadRequest)
+	j.commonHeaders()
+
+	if err != nil {
+		j.writer.Write(j.encodeError(err))
+	}
+}
+
+func (j *JsonResponse) NotFound(err error) {
+	log.Println("[API:NotFound]", err)
+	j.writer.WriteHeader(http.StatusNotFound)
+	j.commonHeaders()
+	j.writer.Write(j.encodeError(err))
+}
+
+func (j *JsonResponse) ServerError(err error) {
+	log.Println("[API:ServerError]", err)
+	j.writer.WriteHeader(http.StatusInternalServerError)
+	j.commonHeaders()
+	j.writer.Write(j.encodeError(err))
+}
+
+func (j *JsonResponse) Forbidden() {
+	log.Println("[API:Forbidden]")
+	j.writer.WriteHeader(http.StatusForbidden)
+	j.commonHeaders()
+	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")
+}
+
+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 {
+		log.Println("encodeError:", err)
+	}
+
+	return data
+}
+
+func (j *JsonResponse) toJSON(v interface{}) []byte {
+	b, err := json.Marshal(v)
+	if err != nil {
+		log.Println("Unable to convert interface to JSON:", err)
+		return []byte("")
+	}
+
+	return b
+}

server/core/request.go

@@ -0,0 +1,108 @@
+// 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 core
+
+import (
+	"fmt"
+	"io"
+	"log"
+	"mime/multipart"
+	"net/http"
+	"strconv"
+
+	"github.com/gorilla/mux"
+)
+
+type Request struct {
+	writer  http.ResponseWriter
+	request *http.Request
+}
+
+func (r *Request) GetRequest() *http.Request {
+	return r.request
+}
+
+func (r *Request) GetBody() io.ReadCloser {
+	return r.request.Body
+}
+
+func (r *Request) GetHeaders() http.Header {
+	return r.request.Header
+}
+
+func (r *Request) GetScheme() string {
+	return r.request.URL.Scheme
+}
+
+func (r *Request) GetFile(name string) (multipart.File, *multipart.FileHeader, error) {
+	return r.request.FormFile(name)
+}
+
+func (r *Request) IsHTTPS() bool {
+	return r.request.URL.Scheme == "https"
+}
+
+func (r *Request) GetCookie(name string) string {
+	cookie, err := r.request.Cookie(name)
+	if err == http.ErrNoCookie {
+		return ""
+	}
+
+	return cookie.Value
+}
+
+func (r *Request) GetIntegerParam(param string) (int64, error) {
+	vars := mux.Vars(r.request)
+	value, err := strconv.Atoi(vars[param])
+	if err != nil {
+		log.Println(err)
+		return 0, fmt.Errorf("%s parameter is not an integer", param)
+	}
+
+	if value < 0 {
+		return 0, nil
+	}
+
+	return int64(value), nil
+}
+
+func (r *Request) GetStringParam(param, defaultValue string) string {
+	vars := mux.Vars(r.request)
+	value := vars[param]
+	if value == "" {
+		value = defaultValue
+	}
+	return value
+}
+
+func (r *Request) GetQueryStringParam(param, defaultValue string) string {
+	value := r.request.URL.Query().Get(param)
+	if value == "" {
+		value = defaultValue
+	}
+	return value
+}
+
+func (r *Request) GetQueryIntegerParam(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
+}
+
+func NewRequest(w http.ResponseWriter, r *http.Request) *Request {
+	return &Request{writer: w, request: r}
+}

server/core/response.go

@@ -0,0 +1,63 @@
+// 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 core
+
+import (
+	"github.com/miniflux/miniflux2/server/template"
+	"net/http"
+	"time"
+)
+
+type Response struct {
+	writer   http.ResponseWriter
+	request  *http.Request
+	template *template.TemplateEngine
+}
+
+func (r *Response) SetCookie(cookie *http.Cookie) {
+	http.SetCookie(r.writer, cookie)
+}
+
+func (r *Response) Json() *JsonResponse {
+	r.commonHeaders()
+	return &JsonResponse{writer: r.writer, request: r.request}
+}
+
+func (r *Response) Html() *HtmlResponse {
+	r.commonHeaders()
+	return &HtmlResponse{writer: r.writer, request: r.request, template: r.template}
+}
+
+func (r *Response) Xml() *XmlResponse {
+	r.commonHeaders()
+	return &XmlResponse{writer: r.writer, request: r.request}
+}
+
+func (r *Response) Redirect(path string) {
+	http.Redirect(r.writer, r.request, path, http.StatusFound)
+}
+
+func (r *Response) Cache(mime_type, etag string, content []byte, duration time.Duration) {
+	r.writer.Header().Set("Content-Type", mime_type)
+	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")
+}
+
+func NewResponse(w http.ResponseWriter, r *http.Request, template *template.TemplateEngine) *Response {
+	return &Response{writer: w, request: r, template: template}
+}

server/core/xml_response.go

@@ -0,0 +1,21 @@
+// 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 core
+
+import (
+	"fmt"
+	"net/http"
+)
+
+type XmlResponse struct {
+	writer  http.ResponseWriter
+	request *http.Request
+}
+
+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))
+}