server.go

package main

// server module
//
// Copyright (c) 2023 - Valentin Kuznetsov <vkuznet@gmail.com>
//
// The OAuth parts are based on
// https://github.com/dghubble/gologin
// package where we explid github authentication, see
// https://github.com/dghubble/gologin/blob/main/examples/github

import (
	"embed"
	"log"

	beamlines "github.com/CHESSComputing/golib/beamlines"
	srvConfig "github.com/CHESSComputing/golib/config"
	server "github.com/CHESSComputing/golib/server"
	services "github.com/CHESSComputing/golib/services"
	utils "github.com/CHESSComputing/golib/utils"
	"github.com/gin-gonic/gin"
)

// content is our static web server content.
//
//go:embed static
var StaticFs embed.FS

// global variables
var _beamlines []string
var _smgr beamlines.SchemaManager
var _spec_schema beamlines.SchemaManager
var _httpReadRequest, _httpWriteRequest, _httpDeleteRequest *services.HttpRequest
var _header, _footer, _footerEmpty string
var _foxdenUser services.UserAttributes
var _foxdenAttrs []string
var Verbose int

// helper function to define our header
func header() string {
	return server.Header(StaticFs, srvConfig.Config.Frontend.WebServer.Base)
}

// helper function to define our footer
func footer() string {
	return server.Footer(StaticFs, srvConfig.Config.Frontend.WebServer.Base)
}

// helper function to define our footer
func footerEmpty() string {
	return server.FooterEmpty(StaticFs, srvConfig.Config.Frontend.WebServer.Base)
}

// helper function to handle base path of URL requests
func base(api string) string {
	b := srvConfig.Config.Frontend.WebServer.Base
	return utils.BasePath(b, api)
}

// helper function to initialize our router
func setupRouter() *gin.Engine {
	routes := []server.Route{
		{Method: "GET", Path: "/", Handler: MainHandler, Authorized: false},
		{Method: "GET", Path: "/docs", Handler: DocsHandler, Authorized: false},
		{Method: "GET", Path: "/docs/:page", Handler: DocsHandler, Authorized: false},
		{Method: "GET", Path: "/login", Handler: LoginHandler, Authorized: false},
		{Method: "GET", Path: "/logout", Handler: LogoutHandler, Authorized: false},
		{Method: "GET", Path: "/services", Handler: ServicesHandler, Authorized: false},
		{Method: "GET", Path: "/search", Handler: SearchHandler, Authorized: false},
		{Method: "GET", Path: "/advancedsearch", Handler: AdvancedSearchHandler, Authorized: false},
		{Method: "GET", Path: "/schemas", Handler: SchemasHandler, Authorized: false},
		{Method: "GET", Path: "/record", Handler: RecordHandler, Authorized: false},
		{Method: "GET", Path: "/tools", Handler: ToolsHandler, Authorized: false},
		{Method: "GET", Path: "/token", Handler: TokenHandler, Authorized: false},
		{Method: "GET", Path: "/users", Handler: UsersHandler, Authorized: false},
		{Method: "GET", Path: "/meta", Handler: MetaDataHandler, Authorized: false},
		{Method: "GET", Path: "/dids", Handler: DidsHandler, Authorized: false},
		{Method: "GET", Path: "/specscans", Handler: SpecScansHandler, Authorized: false},
		{Method: "GET", Path: "/specscans/data", Handler: SpecScansDataHandler, Authorized: false},
		{Method: "GET", Path: "/notebook", Handler: NotebookHandler, Authorized: false},
		{Method: "GET", Path: "/publish", Handler: PublishSrvHandler, Authorized: false},
		{Method: "GET", Path: "/aiml", Handler: AIMLHandler, Authorized: false},
		{Method: "GET", Path: "/analysis", Handler: AnalysisHandler, Authorized: false},
		{Method: "GET", Path: "/visualization", Handler: VisualizationHandler, Authorized: false},
		{Method: "GET", Path: "/data", Handler: DataHandler, Authorized: false},
		{Method: "GET", Path: "/datasets", Handler: DatasetsHandler, Authorized: false},
		{Method: "GET", Path: "/dstable", Handler: DatasetsTableHandler, Authorized: false},
		{Method: "GET", Path: "/info/provenance", Handler: ProvInfoHandler, Authorized: false},
		{Method: "GET", Path: "/info/specscans", Handler: SpecScansInfoHandler, Authorized: false},
		{Method: "GET", Path: "/info/datamanagement", Handler: DataManagementInfoHandler, Authorized: false},
		{Method: "GET", Path: "/provenance", Handler: ProvenanceHandler, Authorized: false},
		{Method: "GET", Path: "/parents", Handler: ParentsHandler, Authorized: false},
		{Method: "GET", Path: "/dm", Handler: DataManagementHandler, Authorized: false},
		{Method: "GET", Path: "/datahub", Handler: DataHubHandler, Authorized: false},
		{Method: "GET", Path: "/amend", Handler: AmendFormHandler, Authorized: false},
		{Method: "GET", Path: "/sync", Handler: SyncHandler, Authorized: false},
		{Method: "GET", Path: "/sync/status/:uuid", Handler: SyncStatusHandler, Authorized: false},
		{Method: "GET", Path: "/notesform", Handler: NotesFormHandler, Authorized: false},
		{Method: "DELETE", Path: "/sync/delete/:uuid", Handler: SyncDeleteHandler, Authorized: false},
		{Method: "POST", Path: "/notes", Handler: NotesHandler, Authorized: false},
		{Method: "POST", Path: "/sync", Handler: SyncFormHandler, Authorized: false},
		{Method: "POST", Path: "/amendrecord", Handler: AmendRecordHandler, Authorized: false},
		{Method: "POST", Path: "/addauxdata", Handler: AddAuxDataHandler, Authorized: false},
		{Method: "POST", Path: "/record", Handler: PostRecordHandler, Authorized: false},
		{Method: "POST", Path: "/dmfiles", Handler: DMFilesHandler, Authorized: false},
		{Method: "POST", Path: "/login", Handler: KAuthHandler, Authorized: false},
		{Method: "POST", Path: "/search", Handler: SearchHandler, Authorized: false},
		{Method: "POST", Path: "/notesform", Handler: NotesFormHandler, Authorized: false},
		{Method: "POST", Path: "/provenance", Handler: PostProvenanceHandler, Authorized: false},
		{Method: "POST", Path: "/meta/form/upload", Handler: MetaFormUploadHandler, Authorized: false},
		{Method: "POST", Path: "/meta/file/upload", Handler: MetaFileUploadHandler, Authorized: false},
		{Method: "POST", Path: "/publish", Handler: PublishHandler, Authorized: false},
		{Method: "POST", Path: "/publishform", Handler: PublishFormHandler, Authorized: false},
		{Method: "POST", Path: "/populateform", Handler: UploadJSONHandler, Authorized: false},
		{Method: "POST", Path: "/doipublic", Handler: DoiPublicHandler, Authorized: false},
		{Method: "POST", Path: "/aichat", Handler: AIChatHandler, Authorized: false},
	}
	r := server.Router(routes, StaticFs, "static", srvConfig.Config.Frontend.WebServer)

	// OAuth routes
	for _, arec := range srvConfig.Config.Frontend.OAuth {
		if arec.Provider == "github" {
			r.GET("/github/login", GithubOauthLoginHandler)
			r.GET("/github/callback", GithubCallBackHandler)
			log.Println("github oauth is enabled")
		} else if arec.Provider == "google" {
			r.GET("/google/login", GoogleOauthLoginHandler)
			r.GET("/google/callback", GoogleCallBackHandler)
			log.Println("google oauth is enabled")
		} else if arec.Provider == "facebook" {
			r.GET("/facebook/login", FacebookOauthLoginHandler)
			r.GET("/facebook/callback", FacebookCallBackHandler)
			log.Println("facebook oauth is enabled")
		}
	}
	return r
}

// Server defines our HTTP server
func Server() {
	// set Verbose level
	Verbose = srvConfig.Config.Frontend.Verbose

	// set default end-point
	if srvConfig.Config.Frontend.DefaultEndPoint != "" {
		DEFAULT_END_POINT = srvConfig.Config.Frontend.DefaultEndPoint
	} else {
		DEFAULT_END_POINT = "/dstable"
	}

	// initialize schema manager
	beamlines.Verbose = Verbose
	_smgr = beamlines.SchemaManager{}
	for _, fname := range srvConfig.Config.CHESSMetaData.SchemaFiles {
		_, err := _smgr.Load(fname)
		if err != nil {
			log.Fatalf("unable to load %s error %v", fname, err)
		}
		_beamlines = append(_beamlines, utils.FileName(fname))
	}
	_spec_schema = beamlines.SchemaManager{}
	log.Println("Schema", _smgr.String())
	_, err := _spec_schema.Load(srvConfig.Config.SpecScans.SchemaFile)
	if err != nil {
		log.Fatalf("unable to load %s error %v", srvConfig.Config.SpecScans.SchemaFile, err)
	}

	// initialize http request
	_httpReadRequest = services.NewHttpRequest("read", Verbose)
	_httpWriteRequest = services.NewHttpRequest("write", Verbose)
	_httpDeleteRequest = services.NewHttpRequest("delete", Verbose)

	// make a choice of foxden user
	switch srvConfig.Config.CHESSMetaData.FoxdenUser.User {
	case "Maglab":
		_foxdenUser = &services.MaglabUser{}
	case "CHESS":
		_foxdenUser = &services.CHESSUser{}
	default:
		_foxdenUser = &services.CHESSUser{}
	}
	_foxdenUser.Init()

	// acquire all foxden attributes across FOXDEN schemas
	_foxdenAttrs = foxdenAttrs()

	// setup web router and start the service
	r := setupRouter()
	webServer := srvConfig.Config.Frontend.WebServer
	server.StartServer(r, webServer)
}