Add start api command

cmd/api.go

@@ -0,0 +1,96 @@
+package cmd
+
+import (
+	//"io"
+	"fmt"
+	"strings"
+	"net/http"
+	
+	"github.com/gin-gonic/gin"
+	"github.com/gin-contrib/cors"
+)
+
+func printJails(jails []string, fields []string) ([]byte, error) {
+	var res []byte
+	
+	res = append(res, []byte("[")...)
+	
+	// Build a filtered jail list
+	var filteredJails []Jail
+	if (len(jails) >= 1 && len(jails[0]) > 0) {
+		for _, j := range gJails {
+			if isStringInArray(jails, j.Name) {
+				filteredJails = append(filteredJails, j)
+			}
+		}
+	} else {
+		filteredJails = gJails
+	}
+	
+	for i, j := range filteredJails {
+		out, err := j.PrintJSON(fields)
+		if err != nil {
+			return res, err
+		}
+		res = append(res, out...)
+		if i < len(filteredJails) - 1 {
+			res = append(res, []byte(",")...)
+		}
+	}
+	res = append(res, []byte("]")...)
+	return res, nil
+}
+
+func startApi(address string, port int) {
+	// Initialize gJails. 
+	// FIXME: How to update this at running time without doubling the same jails?
+	// core will do this for us in add and delete functions
+	ListJails([]string{""}, false)
+
+	r := gin.Default()
+	
+	// Cross Origin Request Support
+	config := cors.DefaultConfig()
+	// DANGER !
+	config.AllowOrigins = []string{"*"}
+	r.Use(cors.New(config))
+
+	r.GET("/jail/list", func(c *gin.Context) {
+		jailstr := c.Query("jail")
+		fields := c.Query("fields")
+		if len(fields) == 0 {
+			// TODO : Put this default value in (user?) configuration
+			fields = "Name,Running,Config.Release,Config.Ip4_addr"
+		}
+		jsout, err := printJails(strings.Split(jailstr, ","), strings.Split(fields, ","))
+		if err != nil {
+			c.JSON(http.StatusInternalServerError, gin.H{"status": 1, "error": err.Error()})
+		} else {
+			c.Data(http.StatusOK, "application/json", jsout)
+		}
+	})
+	
+	r.POST("/jail/start/:jail", func(c *gin.Context) {
+		jailstr := c.Params.ByName("jail")
+		// TODO : Capture or redirect output so we can know if jail was started or not
+		StartJail(strings.Split(jailstr, ","))
+		c.JSON(http.StatusOK, gin.H{"status": 0, "error": ""})
+	})
+	r.POST("/jail/stop/:jail", func(c *gin.Context) {
+		jailstr := c.Params.ByName("jail")
+		// TODO : Capture or redirect output so we can know if jail was started or not
+		StopJail(strings.Split(jailstr, ","))
+		c.JSON(http.StatusOK, gin.H{"status": 0, "error": ""})
+	})
+	
+	r.GET("/jail/properties", func(c *gin.Context) {
+		props, err := ListJailsProps("json")
+		if err != nil {
+			c.JSON(http.StatusInternalServerError, gin.H{"status": 1, "error": err.Error()})
+		} else {
+			c.Data(http.StatusOK, "application/json", []byte(props))
+		}
+	})
+	
+	r.Run(fmt.Sprintf("%s:%d", address, port))
+}

cmd/list.go

@@ -15,23 +15,37 @@ import (
  * List all properties a jail have, with their internal name
  * Only print properties name. To get name & values, use GetJailProperties()
  *******************************************************************************/
-func ListJailsProps(args []string) {
+func ListJailsProps(format string) (string, error) {
 	var conf Jail
-	var result []string
+	var props []string
+	var out string
 	// Mandatory constructor to init default values
 	jailconf, err := NewJailConfig()
 	if err != nil {
 		fmt.Printf("Error allocating JailConfig: %s\n", err.Error())
-		return
+		return out, err
 	}
 
 	conf.Config = jailconf
 
-	result = getStructFieldNames(conf, result, "")
+	props = getStructFieldNames(conf, props, "")
 
-	for _, f := range result {
-		fmt.Printf("%s\n", f)
+	if format == "json" {
+		out = "{\"properties\":["
+		for i, p := range props {
+			out += fmt.Sprintf("\"%s\"", p)
+			if i < len(props) - 1 {
+				out += ","
 			}
+		}
+		out += "]}"
+	} else {
+		for _, p := range props {
+			out += fmt.Sprintf("%s\n", p)
+		}
+	}
+
+	return out, nil
 }
 
 /********************************************************************************

cmd/root.go

@@ -14,7 +14,7 @@ import (
 )
 
 const (
-	gVersion = "0.41"
+	gVersion = "0.42a"
 	
 	// TODO : Get from $jail_zpool/defaults.json
 	MIN_DYN_DEVFS_RULESET = 1000
@@ -28,6 +28,9 @@ type createArgs struct {
 }
 
 var (
+	gApiAddress string
+	gApiPort    int
+
 	gJailHost   JailHost
 	gJails      []Jail
 	gDatastores []Datastore
@@ -127,7 +130,12 @@ ex: gocage list srv-db srv-web`,
 		Short: "Print jails properties",
 		Long:  "Display jails properties. You can use properties to filter, get or set them.",
 		Run: func(cmd *cobra.Command, args []string) {
-			ListJailsProps(args)
+			out, err := ListJailsProps("text")
+			if err != nil {
+				fmt.Printf("Error listing properties : %v\n", err)
+			} else {
+				fmt.Printf("%s\n", out)
+			}
 		},
 	}
 
@@ -357,6 +365,14 @@ You can specify multiple datastores.`,
 		},
 	}
 
+	apiCmd = &cobra.Command{
+		Use:   "startapi",
+		Short: "Run docage as a daemon, exposing API",
+		Run: func(cmd *cobra.Command, args []string) {
+			startApi(gApiAddress, gApiPort)
+		},
+	}
+
 	testCmd = &cobra.Command{
 		Use:   "test",
 		Short: "temporary command to test some code snippet",
@@ -423,6 +439,9 @@ func init() {
 	createCmd.Flags().BoolVarP(&gCreateArgs.BaseJail, "basejail", "b", false, "Basejail. This will create a jail mounted read only from a release, so every up(date|grade) made to this release will immediately propagate to new jail.\n")
 	createCmd.Flags().StringVarP(&gCreateArgs.Datastore, "datastore", "d", "", "Datastore to create the jail on. Defaults to first declared in config.")
 
+	apiCmd.Flags().StringVarP(&gApiAddress, "listen-addr", "l", "127.0.0.1", "API listening address")
+	apiCmd.Flags().IntVarP(&gApiPort, "listen-port", "p", 1234, "API listening port")
+
 	// Now declare commands
 	rootCmd.AddCommand(versionCmd)
 	rootCmd.AddCommand(listCmd)
@@ -441,6 +460,7 @@ func init() {
 	rootCmd.AddCommand(updateCmd)
 	rootCmd.AddCommand(upgradeCmd)
 	rootCmd.AddCommand(createCmd)
+	rootCmd.AddCommand(apiCmd)
 	
 	rootCmd.AddCommand(testCmd)
 	

cmd/start.go

@@ -1421,6 +1421,25 @@ func StartJail(args []string) {
 			}
 		}
 
+		// Get a reference to current jail, to update its properties in RAM so API will get fresh data
+		for i, j := range gJails {
+			if strings.EqualFold(j.Name, cj.Name) && strings.EqualFold(j.Datastore, cj.Datastore) {
+				if err = setStructFieldValue(&gJails[i], "Running", "true"); err != nil {
+					fmt.Printf("ERROR: setting Running property to true: %s\n", err.Error())
+				}
+				if err = setStructFieldValue(&gJails[i], "JID", fmt.Sprintf("%d", cj.JID)); err != nil {
+					fmt.Printf("ERROR: setting JID property to %d: %s\n", cj.JID, err.Error())
+				}
+				if err = setStructFieldValue(&gJails[i], "InternalName", cj.InternalName); err != nil {
+					fmt.Printf("ERROR: Setting InternalName property: %s\n", err.Error())
+				}
+				// FIXME: this value of devfs_ruleset should not go in Config, it should reside in Jail root properties as it is volatile (only valid while jail is running)
+				/*if err = setStructFieldValue(&gJails[i], "Devfs_ruleset", "0"); err != nil {
+					fmt.Printf("ERROR: setting Devfs_ruleset property to 0: %s\n", err.Error())
+				}*/
+			}
+		}
+
 		hostInt, err := gJailHost.GetInterfaces()
 		if err != nil {
 			fmt.Printf("Error listing jail host interfaces: %v\n", err)

cmd/struct.go

@@ -1,7 +1,10 @@
 package cmd
 
 import (
+	"fmt"
+	"sort"
 	"time"
+	"strings"
 )
 
 const (
@@ -561,3 +564,90 @@ type DatastoreSort struct {
 	AvailableDec  datastoreLessFunc
 }
 
+type Field struct {
+	Name   string
+	MaxLen int
+	Value  string
+}
+
+
+func (j *Jail) PrintJSON(fields []string) ([]byte, error) {
+	return j.PrintJSONWithUpper("", fields)
+}
+
+func (j *Jail) PrintJSONWithUpper(upper string, fields []string) ([]byte, error) {
+	var res []byte
+
+	if len(fields) < 1 {
+		return res, nil
+	}
+
+	if len(upper) > 0 {
+		res = append(res, []byte(fmt.Sprintf("\"%s\": {", upper))...)
+	} else {
+		res = append(res, []byte("{")...)
+	}
+
+	// Reorder fields so we got fields of a sub-structure adjacents
+	sort.Strings(fields)
+
+	var ffname string
+	offset := 0
+	for i, _ := range fields {
+		if i + offset >= len(fields) {
+			break
+		}
+		// Is this struct in struct?
+		if strings.Contains(fields[i+offset], ".") {
+			// Count items in this struct
+			var subfields []string
+			var newUpper string
+			for _, sf := range fields[i+offset:] {
+				if strings.Split(sf, ".")[0] == strings.Split(fields[i+offset], ".")[0] {
+					newUpper = strings.Split(sf, ".")[0]
+					sub := strings.Join(strings.Split(string(sf), ".")[1:], ".")
+					subfields = append(subfields, sub)
+				}
+			}
+			out, err := j.PrintJSONWithUpper(newUpper, subfields)
+			if err != nil {
+				return []byte{}, err
+			}
+			res = append(res, out...)
+			offset += len(subfields)-1
+			if i + offset < len(fields) - 1 {
+				res = append(res, []byte(",")...)
+			}
+			continue
+		}
+
+		if len(upper) > 0 {
+			ffname = fmt.Sprintf("%s.%s", upper, fields[i+offset])
+		} else {
+			ffname = fields[i+offset]
+		}
+		val, _, err := getStructFieldValue(j, ffname)
+		if err != nil {
+			return []byte{}, fmt.Errorf("Error accessing field \"%s\" : %v\n", fields[i+offset], err)
+		}
+
+		res = append(res, []byte(fmt.Sprintf("\"%s\": ", fields[i+offset]))...)
+		switch val.Interface().(type) {
+			case string:
+				res = append(res, []byte(fmt.Sprintf("\"%s\"", val.Interface().(string)))...)
+			case int:
+				res = append(res, []byte(fmt.Sprintf("%d", val.Interface().(int)))...)
+			case bool:
+				res = append(res, []byte(fmt.Sprintf("%t", val.Interface().(bool)))...)
+			default:
+				fmt.Printf("ERREUR dans Jail.PrintJSONWithUpper() : Type inconnu : %T\n", val.Interface())
+		}
+		if i + offset < len(fields) - 1 {
+			res = append(res, []byte(",")...)
+		}
+	}
+
+	res = append(res, []byte("}")...)
+
+	return res, nil
+}

cmd/utils.go

@@ -629,9 +629,7 @@ func executeCommandInJail(jail *Jail, cmdline string) (string, error) {
 		word = word + string(c)
 	}
 
-	if gDebug {
-		fmt.Printf("DEBUG: executeCommandInJail: prepare to execute \"%s\"\n", cmd)
-	}
+	log.Debugf("executeCommandInJail: will execute \"%s\"\n", strings.Join(cmd, " "))
 
 	out, err := exec.Command(cmd[0], cmd[1:]...).CombinedOutput()
 

go.mod

@@ -1,32 +1,57 @@
 module gocage
 
-go 1.17
+go 1.21
 
 require (
 	github.com/c-robinson/iplib v1.0.3
 	github.com/c2h5oh/datasize v0.0.0-20220606134207-859f65c6625b
+	github.com/gin-contrib/cors v1.7.2
+	github.com/gin-gonic/gin v1.10.0
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
 	github.com/otiai10/copy v1.12.0
 	github.com/sirupsen/logrus v1.8.1
 	github.com/spf13/cobra v1.2.1
 	github.com/spf13/viper v1.9.0
-	golang.org/x/net v0.0.0-20210503060351-7fd8e65b6420
+	golang.org/x/net v0.25.0
 )
 
 require (
+	github.com/bytedance/sonic v1.11.6 // indirect
+	github.com/bytedance/sonic/loader v0.1.1 // indirect
+	github.com/cloudwego/base64x v0.1.4 // indirect
+	github.com/cloudwego/iasm v0.2.0 // indirect
 	github.com/fsnotify/fsnotify v1.5.1 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.3 // indirect
+	github.com/gin-contrib/sse v0.1.0 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/go-playground/validator/v10 v10.20.0 // indirect
+	github.com/goccy/go-json v0.10.2 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/cpuid/v2 v2.2.7 // indirect
+	github.com/leodido/go-urn v1.4.0 // indirect
 	github.com/magiconair/properties v1.8.5 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mitchellh/mapstructure v1.4.2 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/pelletier/go-toml v1.9.4 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
 	github.com/spf13/afero v1.6.0 // indirect
 	github.com/spf13/cast v1.4.1 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/subosito/gotenv v1.2.0 // indirect
-	golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
-	golang.org/x/text v0.3.6 // indirect
+	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
+	github.com/ugorji/go/codec v1.2.12 // indirect
+	golang.org/x/arch v0.8.0 // indirect
+	golang.org/x/crypto v0.23.0 // indirect
+	golang.org/x/sys v0.20.0 // indirect
+	golang.org/x/text v0.15.0 // indirect
+	google.golang.org/protobuf v1.34.1 // indirect
 	gopkg.in/ini.v1 v1.63.2 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )