SimpleCloudNotifier/scnserver/api/router.go

package api

import (
	"blackforestbytes.com/simplecloudnotifier/api/handler"
	"blackforestbytes.com/simplecloudnotifier/logic"
	"blackforestbytes.com/simplecloudnotifier/models"
	"blackforestbytes.com/simplecloudnotifier/swagger"
	"errors"
	"github.com/gin-gonic/gin/binding"
	"github.com/go-playground/validator/v10"
	"gogs.mikescher.com/BlackForestBytes/goext/ginext"
)

type Router struct {
	app *logic.Application

	commonHandler   handler.CommonHandler
	compatHandler   handler.CompatHandler
	websiteHandler  handler.WebsiteHandler
	apiHandler      handler.APIHandler
	messageHandler  handler.MessageHandler
	externalHandler handler.ExternalHandler
}

func NewRouter(app *logic.Application) *Router {
	return &Router{
		app: app,

		commonHandler:   handler.NewCommonHandler(app),
		compatHandler:   handler.NewCompatHandler(app),
		websiteHandler:  handler.NewWebsiteHandler(app),
		apiHandler:      handler.NewAPIHandler(app),
		messageHandler:  handler.NewMessageHandler(app),
		externalHandler: handler.NewExternalHandler(app),
	}
}

// Init swaggerdocs
//
//	@title			SimpleCloudNotifier API
//	@version		2.0
//	@description	API for SCN
//	@host			simplecloudnotifier.de
//
//	@tag.name		External
//	@tag.name		API-v1
//	@tag.name		API-v2
//	@tag.name		Common
//
//	@BasePath		/
func (r *Router) Init(e *ginext.GinWrapper) error {

	if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
		err := v.RegisterValidation("entityid", models.ValidateEntityID, true)
		if err != nil {
			return err
		}
	} else {
		return errors.New("failed to add validators - wrong engine")
	}

	// ================ General (unversioned) ================

	commonAPI := e.Routes().Group("/api")
	{
		commonAPI.Any("/ping").Handle(r.commonHandler.Ping)
		commonAPI.POST("/db-test").Handle(r.commonHandler.DatabaseTest)
		commonAPI.GET("/health").Handle(r.commonHandler.Health)
		commonAPI.POST("/sleep/:secs").Handle(r.commonHandler.Sleep)
	}

	// ================ Swagger ================

	docs := e.Routes().Group("/documentation")
	{
		docs.GET("/swagger").Handle(ginext.RedirectTemporary("/documentation/swagger/"))
		docs.GET("/swagger/*sub").Handle(swagger.Handle)
	}

	// ================ Website ================

	frontend := e.Routes().Group("")
	{
		frontend.GET("/").Handle(r.websiteHandler.Index)
		frontend.GET("/index.php").Handle(r.websiteHandler.Index)
		frontend.GET("/index.html").Handle(r.websiteHandler.Index)
		frontend.GET("/index").Handle(r.websiteHandler.Index)

		frontend.GET("/api").Handle(r.websiteHandler.APIDocs)
		frontend.GET("/api.php").Handle(r.websiteHandler.APIDocs)
		frontend.GET("/api.html").Handle(r.websiteHandler.APIDocs)

		frontend.GET("/api_more").Handle(r.websiteHandler.APIDocsMore)
		frontend.GET("/api_more.php").Handle(r.websiteHandler.APIDocsMore)
		frontend.GET("/api_more.html").Handle(r.websiteHandler.APIDocsMore)

		frontend.GET("/message_sent").Handle(r.websiteHandler.MessageSent)
		frontend.GET("/message_sent.php").Handle(r.websiteHandler.MessageSent)
		frontend.GET("/message_sent.html").Handle(r.websiteHandler.MessageSent)

		frontend.GET("/favicon.ico").Handle(r.websiteHandler.FaviconIco)
		frontend.GET("/favicon.png").Handle(r.websiteHandler.FaviconPNG)

		frontend.GET("/js/:fn").Handle(r.websiteHandler.Javascript)
		frontend.GET("/css/:fn").Handle(r.websiteHandler.CSS)
	}

	// ================ Compat (v1) ================

	compat := e.Routes().Group("/api")
	{
		compat.GET("/register.php").Handle(r.compatHandler.Register)
		compat.GET("/info.php").Handle(r.compatHandler.Info)
		compat.GET("/ack.php").Handle(r.compatHandler.Ack)
		compat.GET("/requery.php").Handle(r.compatHandler.Requery)
		compat.GET("/update.php").Handle(r.compatHandler.Update)
		compat.GET("/expand.php").Handle(r.compatHandler.Expand)
		compat.GET("/upgrade.php").Handle(r.compatHandler.Upgrade)
	}

	// ================ Manage API (v2) ================

	apiv2 := e.Routes().Group("/api/v2/")
	{
		apiv2.POST("/users").Handle(r.apiHandler.CreateUser)
		apiv2.GET("/users/:uid").Handle(r.apiHandler.GetUser)
		apiv2.PATCH("/users/:uid").Handle(r.apiHandler.UpdateUser)

		apiv2.GET("/users/:uid/keys").Handle(r.apiHandler.ListUserKeys)
		apiv2.POST("/users/:uid/keys").Handle(r.apiHandler.CreateUserKey)
		apiv2.GET("/users/:uid/keys/current").Handle(r.apiHandler.GetCurrentUserKey)
		apiv2.GET("/users/:uid/keys/:kid").Handle(r.apiHandler.GetUserKey)
		apiv2.PATCH("/users/:uid/keys/:kid").Handle(r.apiHandler.UpdateUserKey)
		apiv2.DELETE("/users/:uid/keys/:kid").Handle(r.apiHandler.DeleteUserKey)

		apiv2.GET("/users/:uid/clients").Handle(r.apiHandler.ListClients)
		apiv2.GET("/users/:uid/clients/:cid").Handle(r.apiHandler.GetClient)
		apiv2.PATCH("/users/:uid/clients/:cid").Handle(r.apiHandler.UpdateClient)
		apiv2.POST("/users/:uid/clients").Handle(r.apiHandler.AddClient)
		apiv2.DELETE("/users/:uid/clients/:cid").Handle(r.apiHandler.DeleteClient)

		apiv2.GET("/users/:uid/channels").Handle(r.apiHandler.ListChannels)
		apiv2.POST("/users/:uid/channels").Handle(r.apiHandler.CreateChannel)
		apiv2.GET("/users/:uid/channels/:cid").Handle(r.apiHandler.GetChannel)
		apiv2.PATCH("/users/:uid/channels/:cid").Handle(r.apiHandler.UpdateChannel)
		apiv2.GET("/users/:uid/channels/:cid/messages").Handle(r.apiHandler.ListChannelMessages)
		apiv2.GET("/users/:uid/channels/:cid/subscriptions").Handle(r.apiHandler.ListChannelSubscriptions)

		apiv2.GET("/users/:uid/subscriptions").Handle(r.apiHandler.ListUserSubscriptions)
		apiv2.POST("/users/:uid/subscriptions").Handle(r.apiHandler.CreateSubscription)
		apiv2.GET("/users/:uid/subscriptions/:sid").Handle(r.apiHandler.GetSubscription)
		apiv2.DELETE("/users/:uid/subscriptions/:sid").Handle(r.apiHandler.CancelSubscription)
		apiv2.PATCH("/users/:uid/subscriptions/:sid").Handle(r.apiHandler.UpdateSubscription)

		apiv2.GET("/users/:uid/sender-names").Handle(r.apiHandler.ListUserSenderNames)

		apiv2.GET("/messages").Handle(r.apiHandler.ListMessages)
		apiv2.GET("/messages/:mid").Handle(r.apiHandler.GetMessage)
		apiv2.DELETE("/messages/:mid").Handle(r.apiHandler.DeleteMessage)

		apiv2.GET("/sender-names").Handle(r.apiHandler.ListSenderNames)

		apiv2.GET("/preview/users/:uid").Handle(r.apiHandler.GetUserPreview)
		apiv2.GET("/preview/keys/:kid").Handle(r.apiHandler.GetUserKeyPreview)
		apiv2.GET("/preview/channels/:cid").Handle(r.apiHandler.GetChannelPreview)
	}

	// ================ Send API (unversioned) ================

	sendAPI := e.Routes().Group("")
	{
		sendAPI.POST("/").Handle(r.messageHandler.SendMessage)
		sendAPI.POST("/send").Handle(r.messageHandler.SendMessage)
		sendAPI.POST("/send.php").Handle(r.compatHandler.SendMessage)

		sendAPI.POST("/external/v1/uptime-kuma").Handle(r.externalHandler.UptimeKuma)

	}

	// ================

	if r.app.Config.ReturnRawErrors {
		e.NoRoute(r.commonHandler.NoRoute)
	}

	// ================

	return nil
}