path: root/lib/agent/apiv1.go

/*
 * Copyright (C) 2017-2018 "IoT.bzh"
 * Author Sebastien Douheret <sebastien@iot.bzh>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package agent

import (
	"fmt"
	"strconv"
	"strings"

	"gerrit.automotivelinux.org/gerrit/src/xds/xds-agent.git/lib/xaapiv1"
	"gerrit.automotivelinux.org/gerrit/src/xds/xds-agent.git/lib/xdsconfig"
	"gerrit.automotivelinux.org/gerrit/src/xds/xds-server.git/lib/xsapiv1"
	"github.com/gin-gonic/gin"
)

const apiBaseURL = "/api/v1"

// APIService .
type APIService struct {
	*Context
	apiRouter   *gin.RouterGroup
	serverIndex int
}

// NewAPIV1 creates a new instance of API service
func NewAPIV1(ctx *Context) *APIService {
	s := &APIService{
		Context:     ctx,
		apiRouter:   ctx.webServer.router.Group(apiBaseURL),
		serverIndex: 0,
	}

	s.apiRouter.GET("/version", s.getVersion)

	s.apiRouter.GET("/config", s.getConfig)
	s.apiRouter.POST("/config", s.setConfig)

	// s.apiRouter.GET("/browse", s.browseFS)

	s.apiRouter.GET("/projects", s.getProjects)
	s.apiRouter.GET("/projects/:id", s.getProject)
	s.apiRouter.PUT("/projects/:id", s.updateProject)
	s.apiRouter.POST("/projects", s.addProject)
	s.apiRouter.POST("/projects/sync/:id", s.syncProject)
	s.apiRouter.DELETE("/projects/:id", s.delProject)

	s.apiRouter.POST("/exec", s.execCmd)
	s.apiRouter.POST("/exec/:id", s.execCmd)
	s.apiRouter.POST("/signal", s.execSignalCmd)

	s.apiRouter.GET("/events", s.eventsList)
	s.apiRouter.POST("/events/register", s.eventsRegister)
	s.apiRouter.POST("/events/unregister", s.eventsUnRegister)

	s.apiRouter.GET("/supervisor/topo", s.getSupervisorTopo)
	s.apiRouter.POST("/supervisor/trace/start", s.startSupervisor)
	s.apiRouter.POST("/supervisor/trace/stop", s.stopSupervisor)
	return s
}

// Stop Used to stop/close created services
func (s *APIService) Stop() {
	for _, svr := range s.xdsServers {
		svr.Close()
	}
}

// AddXdsServer Add a new XDS Server to the list of a server
func (s *APIService) AddXdsServer(cfg xdsconfig.XDSServerConf) (*XdsServer, error) {
	var svr *XdsServer
	var exist, tempoID bool
	tempoID = false

	// First check if not already exist and update it
	if svr, exist = s.xdsServers[cfg.ID]; exist {

		// Update: Found, so just update some settings
		svr.ConnRetry = cfg.ConnRetry

		tempoID = svr.IsTempoID()
		if svr.Connected && !svr.Disabled && svr.BaseURL == cfg.URL && tempoID {
			return svr, nil
		}

		// URL differ or not connected, so need to reconnect
		svr.BaseURL = cfg.URL

	} else {

		// Create a new server object
		cfg.URLIndex = strconv.Itoa(s.serverIndex)
		s.serverIndex = s.serverIndex + 1
		if cfg.APIBaseURL == "" {
			cfg.APIBaseURL = apiBaseURL
		}
		if cfg.APIPartialURL == "" {
			cfg.APIPartialURL = "/servers/" + cfg.URLIndex
		}

		// Create a new XDS Server
		svr = NewXdsServer(s.Context, cfg)

		svr.SetLoggerOutput(s.Config.LogVerboseOut)

		// Define API group for this XDS Server
		grp := s.apiRouter.Group(svr.PartialURL)
		svr.SetAPIRouterGroup(grp)

		// Define servers API processed locally
		s.apiRouter.GET("/servers", s.getServersList)       // API /servers
		svr.apiRouter.GET("", s.getServer)                  // API /servers/:id
		svr.apiRouter.POST("/reconnect", s.reconnectServer) // API /servers/:id/reconnect

		// Declare passthrough API/routes
		s.sdksPassthroughInit(svr)
		s.targetsPassthroughInit(svr)

		// Register callback on Connection
		svr.ConnectOn(func(server *XdsServer) error {

			// Add server to list
			s.xdsServers[server.ID] = svr

			// Register events forwarder
			if err := s.sdksEventsForwardInit(server); err != nil {
				s.Log.Errorf("XDS Server %v - sdk events forwarding error: %v", server.ID, err)
			}
			if err := s.targetsEventsForwardInit(server); err != nil {
				s.Log.Errorf("XDS Server %v - target events forwarding error: %v", server.ID, err)
			}
			if err := s.terminalsEventsForwardInit(server); err != nil {
				s.Log.Errorf("XDS Server %v - terminal events forwarding error: %v", server.ID, err)
			}

			// Load projects
			if err := s.projects.Init(server); err != nil {
				s.Log.Errorf("XDS Server %v - project init error: %v", server.ID, err)
			}

			// Registered to all events
			if err := server.EventRegister(xsapiv1.EVTAll, ""); err != nil {
				s.Log.Errorf("XDS Server %v - register all events error: %v", server.ID, err)
			}

			return nil
		})
	}

	// Established connection
	err := svr.Connect()

	// Delete temporary ID with it has been replaced by right Server ID
	if tempoID && !svr.IsTempoID() {
		delete(s.xdsServers, cfg.ID)
	}

	return svr, err
}

// DelXdsServer Delete an XDS Server from the list of a server
func (s *APIService) DelXdsServer(id string) error {
	if _, exist := s.xdsServers[id]; !exist {
		return fmt.Errorf("Unknown Server ID %s", id)
	}
	// Don't really delete, just disable it
	s.xdsServers[id].Close()
	return nil
}

// UpdateXdsServer Update XDS Server configuration settings
func (s *APIService) UpdateXdsServer(cfg xaapiv1.ServerCfg) error {
	if _, exist := s.xdsServers[cfg.ID]; !exist {
		return fmt.Errorf("Unknown Server ID %s", cfg.ID)
	}

	svr := s.xdsServers[cfg.ID]

	// Update only some configurable fields
	svr.ConnRetry = cfg.ConnRetry

	return nil
}

// GetXdsServerFromURLIndex Retrieve XdsServer from URLIndex value
func (s *APIService) GetXdsServerFromURLIndex(urlIdx string) *XdsServer {
	for _, svr := range s.xdsServers {
		if svr.URLIndex == urlIdx {
			return svr
		}
	}
	return nil
}

// ParamGetIndex Retrieve numerical parameter in request url
func (s *APIService) ParamGetIndex(c *gin.Context) string {
	uri := c.Request.RequestURI
	for idx := strings.LastIndex(uri, "/"); idx > 0; {
		id := uri[idx+1:]
		if _, err := strconv.Atoi(id); err == nil {
			return id
		}
		uri = uri[:idx]
		idx = strings.LastIndex(uri, "/")
	}
	return ""
}