dnote/pkg/server/controllers/helpers.go
Sung fd7b2a78b2
Remove email verification (#688)
* Remove email verified flag

* Fix sass deprecation warnings
2025-10-11 13:35:39 -07:00

324 lines
8 KiB
Go

/* Copyright (C) 2019, 2020, 2021, 2022, 2023, 2024, 2025 Dnote contributors
*
* This file is part of Dnote.
*
* Dnote is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Dnote is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Dnote. If not, see <https://www.gnu.org/licenses/>.
*/
package controllers
import (
"encoding/json"
"net/http"
"net/url"
"strings"
"time"
"github.com/dnote/dnote/pkg/server/app"
"github.com/dnote/dnote/pkg/server/consts"
"github.com/dnote/dnote/pkg/server/database"
"github.com/dnote/dnote/pkg/server/log"
"github.com/dnote/dnote/pkg/server/views"
"github.com/gorilla/schema"
"github.com/pkg/errors"
)
func parseRequestData(r *http.Request, dst interface{}) error {
ct := r.Header.Get("Content-Type")
if ct == consts.ContentTypeForm {
if err := parseForm(r, dst); err != nil {
return errors.Wrap(err, "parsing form")
}
return nil
}
// default to JSON
if err := parseJSON(r, dst); err != nil {
return errors.Wrap(err, "parsing JSON")
}
return nil
}
func parseForm(r *http.Request, dst interface{}) error {
if err := r.ParseForm(); err != nil {
return err
}
return parseValues(r.PostForm, dst)
}
func parseValues(values url.Values, dst interface{}) error {
dec := schema.NewDecoder()
// Ignore CSRF token field
dec.IgnoreUnknownKeys(true)
if err := dec.Decode(dst, values); err != nil {
return err
}
return nil
}
func parseJSON(r *http.Request, dst interface{}) error {
dec := json.NewDecoder(r.Body)
if err := dec.Decode(dst); err != nil {
return err
}
return nil
}
// GetCredential extracts a session key from the request from the request header. Concretely,
// it first looks at the 'Cookie' and then the 'Authorization' header. If no credential is found,
// it returns an empty string.
func GetCredential(r *http.Request) (string, error) {
ret, err := getSessionKeyFromCookie(r)
if err != nil {
return "", errors.Wrap(err, "getting session key from cookie")
}
if ret != "" {
return ret, nil
}
ret, err = getSessionKeyFromAuth(r)
if err != nil {
return "", errors.Wrap(err, "getting session key from Authorization header")
}
return ret, nil
}
// getSessionKeyFromCookie reads and returns a session key from the cookie sent by the
// request. If no session key is found, it returns an empty string
func getSessionKeyFromCookie(r *http.Request) (string, error) {
c, err := r.Cookie("id")
if err == http.ErrNoCookie {
return "", nil
} else if err != nil {
return "", errors.Wrap(err, "reading cookie")
}
return c.Value, nil
}
// getSessionKeyFromAuth reads and returns a session key from the Authorization header
func getSessionKeyFromAuth(r *http.Request) (string, error) {
h := r.Header.Get("Authorization")
if h == "" {
return "", nil
}
payload, err := parseAuthHeader(h)
if err != nil {
return "", errors.Wrap(err, "parsing the authorization header")
}
if payload.scheme != "Bearer" {
return "", errors.New("unsupported scheme")
}
return payload.credential, nil
}
func parseAuthHeader(h string) (authHeader, error) {
parts := strings.Split(h, " ")
if len(parts) != 2 {
return authHeader{}, errors.New("Invalid authorization header")
}
parsed := authHeader{
scheme: parts[0],
credential: parts[1],
}
return parsed, nil
}
type authHeader struct {
scheme string
credential string
}
const (
sessionCookieName = "id"
sessionCookiePath = "/"
)
func setSessionCookie(w http.ResponseWriter, key string, expires time.Time) {
cookie := http.Cookie{
Name: sessionCookieName,
Value: key,
Expires: expires,
Path: sessionCookiePath,
HttpOnly: true,
}
http.SetCookie(w, &cookie)
}
func unsetSessionCookie(w http.ResponseWriter) {
expires := time.Now().Add(time.Hour * -24 * 30)
cookie := http.Cookie{
Name: sessionCookieName,
Value: "",
Expires: expires,
Path: sessionCookiePath,
HttpOnly: true,
}
w.Header().Set("Cache-Control", "no-cache")
http.SetCookie(w, &cookie)
}
// SessionResponse is a response containing a session information
type SessionResponse struct {
Key string `json:"key"`
ExpiresAt int64 `json:"expires_at"`
}
func logError(err error, msg string) {
// log if internal error
// if _, ok := err.(views.PublicError); !ok {
// log.ErrorWrap(err, msg)
// }
log.ErrorWrap(err, msg)
}
func getStatusCode(err error) int {
rootErr := errors.Cause(err)
switch rootErr {
case app.ErrNotFound:
return http.StatusNotFound
case app.ErrLoginInvalid:
return http.StatusUnauthorized
case app.ErrDuplicateEmail, app.ErrEmailRequired, app.ErrPasswordTooShort:
return http.StatusBadRequest
case app.ErrLoginRequired:
return http.StatusUnauthorized
case app.ErrBookUUIDRequired:
return http.StatusBadRequest
case app.ErrEmptyUpdate:
return http.StatusBadRequest
case app.ErrInvalidUUID:
return http.StatusBadRequest
case app.ErrDuplicateBook:
return http.StatusConflict
case app.ErrInvalidToken:
return http.StatusBadRequest
case app.ErrPasswordResetTokenExpired:
return http.StatusGone
case app.ErrPasswordConfirmationMismatch:
return http.StatusBadRequest
case app.ErrInvalidPasswordChangeInput:
return http.StatusBadRequest
case app.ErrInvalidPassword:
return http.StatusUnauthorized
case app.ErrEmailTooLong:
return http.StatusBadRequest
case app.ErrMissingToken:
return http.StatusBadRequest
case app.ErrExpiredToken:
return http.StatusGone
}
return http.StatusInternalServerError
}
// handleHTMLError writes the error to the log and sets the error message in the data.
func handleHTMLError(w http.ResponseWriter, r *http.Request, err error, msg string, v *views.View, d views.Data) {
statusCode := getStatusCode(err)
logError(err, msg)
d.SetAlert(err, v.AlertInBody)
v.Render(w, r, &d, statusCode)
}
// handleJSONError logs the error and responds with the given status code with a generic status text
func handleJSONError(w http.ResponseWriter, err error, msg string) {
statusCode := getStatusCode(err)
rootErr := errors.Cause(err)
var respText string
if pErr, ok := rootErr.(views.PublicError); ok {
respText = pErr.Public()
} else {
respText = http.StatusText(statusCode)
}
logError(err, msg)
http.Error(w, respText, statusCode)
}
// respondWithSession makes a HTTP response with the session from the user with the given userID.
// It sets the HTTP-Only cookie for browser clients and also sends a JSON response for non-browser clients.
func respondWithSession(w http.ResponseWriter, statusCode int, session *database.Session) {
setSessionCookie(w, session.Key, session.ExpiresAt)
response := SessionResponse{
Key: session.Key,
ExpiresAt: session.ExpiresAt.Unix(),
}
w.Header().Set("Content-Type", "application/json")
dat, err := json.Marshal(response)
if err != nil {
handleJSONError(w, err, "encoding response")
return
}
w.WriteHeader(statusCode)
w.Write(dat)
}
// respondJSON encodes the given payload into a JSON format and writes it to the given response writer
func respondJSON(w http.ResponseWriter, statusCode int, payload interface{}) {
w.Header().Set("Content-Type", "application/json")
dat, err := json.Marshal(payload)
if err != nil {
handleJSONError(w, err, "encoding response")
return
}
w.WriteHeader(statusCode)
w.Write(dat)
}
func getClientType(r *http.Request) string {
origin := r.Header.Get("Origin")
if strings.HasPrefix(origin, "moz-extension://") {
return "firefox-extension"
}
if strings.HasPrefix(origin, "chrome-extension://") {
return "chrome-extension"
}
userAgent := r.Header.Get("User-Agent")
if strings.HasPrefix(userAgent, "Go-http-client") {
return "cli"
}
return "web"
}