ephemerup/api/server.go

/*
Copyright © 2023 Thomas von Dein

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package api

import (
	"errors"
	"github.com/gofiber/fiber/v2"
	"github.com/gofiber/fiber/v2/middleware/compress"
	"github.com/gofiber/fiber/v2/middleware/cors"
	"github.com/gofiber/fiber/v2/middleware/logger"
	"github.com/gofiber/fiber/v2/middleware/requestid"
	"github.com/gofiber/fiber/v2/middleware/session"
	"github.com/gofiber/keyauth/v2"
	"github.com/tlinden/ephemerup/cfg"
	"github.com/tlinden/ephemerup/common"
)

// sessions are context specific and can be global savely
var Sessionstore *session.Store

const shallExpire = true

func Runserver(conf *cfg.Config, args []string) error {
	// required for authenticated routes, used to store the api context
	Sessionstore = session.New()

	// bbolt db setup
	db, err := NewDb(conf)
	if err != nil {
		return err
	}
	defer db.Close()

	// setup authenticated endpoints
	auth := SetupAuthStore(conf, db)

	// setup api server
	router := SetupServer(conf)

	// authenticated routes
	api := router.Group(conf.ApiPrefix + ApiVersion)
	{
		// upload
		api.Post("/uploads", auth, func(c *fiber.Ctx) error {
			return UploadPost(c, conf, db)
		})

		// remove
		api.Delete("/uploads/:id", auth, func(c *fiber.Ctx) error {
			err := UploadDelete(c, conf, db)
			return SendResponse(c, "", err)
		})

		// listing
		api.Get("/uploads", auth, func(c *fiber.Ctx) error {
			return UploadsList(c, conf, db)
		})

		// info/describe
		api.Get("/uploads/:id", auth, func(c *fiber.Ctx) error {
			return UploadDescribe(c, conf, db)
		})

		// modify
		api.Put("/uploads/:id", auth, func(c *fiber.Ctx) error {
			return UploadModify(c, conf, db)
		})

		// download w/o expire
		api.Get("/uploads/:id/file", auth, func(c *fiber.Ctx) error {
			return UploadFetch(c, conf, db)
		})

		// same for forms ************
		api.Post("/forms", auth, func(c *fiber.Ctx) error {
			return FormCreate(c, conf, db)
		})

		// remove
		api.Delete("/forms/:id", auth, func(c *fiber.Ctx) error {
			err := FormDelete(c, conf, db)
			return SendResponse(c, "", err)
		})

		// listing
		api.Get("/forms", auth, func(c *fiber.Ctx) error {
			return FormsList(c, conf, db)
		})

		// info/describe
		api.Get("/forms/:id", auth, func(c *fiber.Ctx) error {
			return FormDescribe(c, conf, db)
		})

		// modify
		api.Put("/forms/:id", auth, func(c *fiber.Ctx) error {
			return FormModify(c, conf, db)
		})
	}

	// public routes
	{
		router.Get("/", func(c *fiber.Ctx) error {
			return c.Send([]byte(conf.Frontpage))
		})

		router.Get("/download/:id/:file", func(c *fiber.Ctx) error {
			return UploadFetch(c, conf, db, shallExpire)
		})

		router.Get("/download/:id", func(c *fiber.Ctx) error {
			return UploadFetch(c, conf, db, shallExpire)
		})

		router.Get("/form/:id", func(c *fiber.Ctx) error {
			return FormPage(c, conf, db, shallExpire)
		})

	}

	// setup cleaner
	quitcleaner := BackgroundCleaner(conf, db)

	router.Hooks().OnShutdown(func() error {
		Log("Shutting down cleaner")
		close(quitcleaner)
		return nil
	})

	return router.Listen(conf.Listen)
}

func SetupAuthStore(conf *cfg.Config, db *Db) func(*fiber.Ctx) error {
	AuthSetApikeys(conf.Apicontexts)

	return keyauth.New(keyauth.Config{
		Validator: func(c *fiber.Ctx, key string) (bool, error) {
			// we use a wrapper closure to be able to forward the db object
			formuser, err := AuthValidateOnetimeKey(c, key, db)

			// incoming apicontext matches a form id, accept it
			if err == nil {
				Log("Incoming API Context equals formuser: %t, id: %s", formuser, key)
				return formuser, err
			}

			// nope, we need to check against regular configured apicontexts
			return AuthValidateAPIKey(c, key)
		},
		ErrorHandler: AuthErrHandler,
	})
}

func SetupServer(conf *cfg.Config) *fiber.App {
	router := fiber.New(fiber.Config{
		CaseSensitive: true,
		StrictRouting: true,
		Immutable:     true,
		Prefork:       conf.Prefork,
		ServerHeader:  "ephemerup Server",
		AppName:       conf.AppName,
		BodyLimit:     conf.BodyLimit,
		Network:       conf.Network,
	})

	router.Use(requestid.New())

	router.Use(logger.New(logger.Config{
		Format: "${pid} ${locals:requestid} ${status} - ${method} ${path}​\n",
	}))

	router.Use(cors.New(cors.Config{
		AllowMethods:  "GET,PUT,POST,DELETE",
		ExposeHeaders: "Content-Type,Authorization,Accept",
	}))

	router.Use(compress.New(compress.Config{
		Level: compress.LevelBestSpeed,
	}))

	return router
}

/*
   Wrapper to respond with proper json status, message and code,
   shall be prepared and called by the handlers directly.
*/
func JsonStatus(c *fiber.Ctx, code int, msg string) error {
	success := true

	if code != fiber.StatusOK {
		success = false
	}

	return c.Status(code).JSON(common.Result{
		Code:    code,
		Message: msg,
		Success: success,
	})
}

/*
   Used for non json-aware handlers, called by server
*/
func SendResponse(c *fiber.Ctx, msg string, err error) error {
	if err != nil {
		code := fiber.StatusInternalServerError

		var e *fiber.Error
		if errors.As(err, &e) {
			code = e.Code
		}

		return c.Status(code).JSON(common.Result{
			Code:    code,
			Message: err.Error(),
			Success: false,
		})
	}

	return c.Status(fiber.StatusOK).JSON(common.Result{
		Code:    fiber.StatusOK,
		Message: msg,
		Success: true,
	})
}