✨ Create the registry related command

This commit adds the commands related to the registry (add, delete, refresh, list)
Moreover, it fixes a few issues:
	- If the output struct has a non-default format, it is now respected (previously, the struct would default to pretty when InferFlag was called)
	- A plugin download is now done in a sub folder with a randomly generated ID. This allows multiple instances of anyquery to cohabit with different versions of plugins

Author: julien040

cmd/helper.go

@@ -4,16 +4,38 @@ import "github.com/spf13/cobra"
 
 // This file defines a few functions that avoid code repetition for the commands declaration
 
+// Set the flags for a command that modifies the configuration
 func addFlag_commandModifiesConfiguration(cmd *cobra.Command) {
 	cmd.Flags().StringP("config", "c", "", "Path to the configuration database")
 }
 
+// Same as addFlag_commandModifiesConfiguration but flags will be applied
+// to all subcommands
+func addPersistentFlag_commandModifiesConfiguration(cmd *cobra.Command) {
+	cmd.PersistentFlags().StringP("config", "c", "", "Path to the configuration database")
+}
+
 // Set the flags for a command that prints data
 //
 // It helps specify the output format
 func addFlag_commandPrintsData(cmd *cobra.Command) {
-	cmd.Flags().String("format", "pretty", "Output format (pretty, json, csv, plain)")
+	// We don't add a default value to the format flag
+	// because cmd wouldn't be able to overwrite the default format
+	cmd.Flags().String("format", "", "Output format (pretty, json, csv, plain)")
 	cmd.Flags().Bool("json", false, "Output format as JSON")
 	cmd.Flags().Bool("csv", false, "Output format as CSV")
 	cmd.Flags().Bool("plain", false, "Output format as plain text")
 }
+
+// Same as addFlag_commandPrintsData but flags will be applied
+// to all subcommands
+func addPersistentFlag_commandPrintsData(cmd *cobra.Command) {
+	cmd.PersistentFlags().String("format", "", "Output format (pretty, json, csv, plain)")
+	cmd.PersistentFlags().Bool("json", false, "Output format as JSON")
+	cmd.PersistentFlags().Bool("csv", false, "Output format as CSV")
+	cmd.PersistentFlags().Bool("plain", false, "Output format as plain text")
+}
+
+func addFlag_commandCanBeInteractive(cmd *cobra.Command) {
+	cmd.Flags().Bool("no-input", false, "Do not ask for input")
+}

cmd/registry.go

@@ -0,0 +1,69 @@
+package cmd
+
+import (
+	"github.com/julien040/anyquery/controller"
+	"github.com/spf13/cobra"
+)
+
+var registryCmd = &cobra.Command{
+	Use:        "registry",
+	Short:      "List the registries where plugins can be downloaded",
+	RunE:       controller.RegistryList,
+	Aliases:    []string{"registries"},
+	SuggestFor: []string{"store"},
+	Args:       cobra.NoArgs,
+}
+
+var registryListCmd = &cobra.Command{
+	Use:     "list",
+	Short:   "List the registries where plugins can be downloaded",
+	RunE:    controller.RegistryList,
+	Aliases: []string{"ls"},
+}
+
+var registryAddCmd = &cobra.Command{
+	Use:     "add [name] [url]",
+	Short:   "Add a new registry",
+	Args:    cobra.MaximumNArgs(2),
+	RunE:    controller.RegistryAdd,
+	Aliases: []string{"new", "create", "register", "install"},
+}
+
+var registryRemoveCmd = &cobra.Command{
+	Use:     "remove",
+	Short:   "Remove a registry",
+	RunE:    controller.RegistryRemove,
+	Aliases: []string{"rm", "delete"},
+}
+
+var registryGetCmd = &cobra.Command{
+	Use:     "get [name]",
+	Short:   "Print informations about a registry",
+	Args:    cobra.ExactArgs(1),
+	RunE:    controller.RegistryGet,
+	Aliases: []string{"info", "show", "inspect"},
+}
+
+var registryRefreshCmd = &cobra.Command{
+	Use:   "refresh [name]",
+	Short: "Keep the registry up to date with the server",
+	Long: `This command will fetch the registry and save the available plugins for download in the configuration database.
+If a name is provided, only this registry will be refreshed. Otherwise, all registries will be refreshed.`,
+	Args:    cobra.MaximumNArgs(1),
+	RunE:    controller.RegistryRefresh,
+	Aliases: []string{"update", "sync", "fetch", "pull"},
+}
+
+func init() {
+	rootCmd.AddCommand(registryCmd)
+	addFlag_commandPrintsData(registryCmd)
+	// Set the --config flag for all subcommands and the command itself
+	addPersistentFlag_commandModifiesConfiguration(registryCmd)
+	registryCmd.AddCommand(registryListCmd)
+	addFlag_commandPrintsData(registryListCmd)
+	registryCmd.AddCommand(registryAddCmd)
+	registryCmd.AddCommand(registryRemoveCmd)
+	registryCmd.AddCommand(registryGetCmd)
+	addFlag_commandPrintsData(registryGetCmd)
+	registryCmd.AddCommand(registryRefreshCmd)
+}

cmd/store.go

@@ -40,7 +40,11 @@ func OpenDatabaseConnection(path string, readOnly bool) (*sql.DB, *model.Queries
 		readOnly = false
 	}
 
-	sqlitePath := "file:" + path + "?cache=shared&_cache_size=-50000&_foreign_keys=ON"
+	// We disable foreign keys because a registry can be deleted
+	// while its plugins are still in the database
+	//
+	// We add ?_loc=auto to let SQLite use the local timezone
+	sqlitePath := "file:" + path + "?cache=shared&_cache_size=-50000&_foreign_keys=OFF&_loc=auto"
 	if readOnly {
 		sqlitePath += "&mode=ro"
 	}

controller/config/database.go

@@ -4,11 +4,12 @@ INSERT INTO
         name,
         url,
         lastUpdated,
+        lastFetched,
         checksumRegistry,
         registryJSON
     )
 VALUES
-    (?, ?, ?, ?, ?);
+    (?, ?, ?, unixepoch(), ?, ?);
 
 -- name: AddPlugin :exec
 INSERT INTO
@@ -124,7 +125,25 @@ UPDATE
 SET
     url = ?,
     lastUpdated = ?,
+    lastFetched = unixepoch(),
     checksumRegistry = ?,
     registryJSON = ?
+WHERE
+    name = ?;
+
+-- name: UpdateRegistryFetched :exec
+UPDATE
+    registry
+SET
+    lastFetched = unixepoch()
+WHERE
+    name = ?;
+
+/* -------------------------------------------------------------------------- */
+/*                                   DELETE                                   */
+/* -------------------------------------------------------------------------- */
+-- name: DeleteRegistry :exec
+DELETE FROM
+    registry
 WHERE
     name = ?;

controller/config/model/models.go

@@ -5,10 +5,12 @@ import (
 	"database/sql"
 	"encoding/json"
 	"fmt"
+	"math/rand/v2"
 	urlParser "net/url"
 	"os"
 	"path"
 	"runtime"
+	"strings"
 
 	"github.com/Masterminds/semver/v3"
 	"github.com/adrg/xdg"
@@ -63,18 +65,18 @@ func FindPluginVersionCandidate(plugin Plugin) (PluginFile, PluginVersion, error
 	return *candidateFile, *candidateVersion, nil
 }
 
-func InstallPlugin(queries *model.Queries, registry string, plugin string) error {
+func InstallPlugin(queries *model.Queries, registry string, plugin string) (string, error) {
 	// Create the plugin directory
-	path := path.Join(xdg.DataHome, "anyquery", "plugins", registry, plugin)
+	path := path.Join(xdg.DataHome, "anyquery", "plugins", registry, plugin, newSmallID())
 	err := os.MkdirAll(path, 0755)
 	if err != nil {
-		return err
+		return "", err
 	}
 
 	// Get the registry
 	_, plugins, err := LoadRegistry(queries, registry)
 	if err != nil {
-		return err
+		return "", err
 	}
 
 	// Find the plugin
@@ -88,17 +90,17 @@ func InstallPlugin(queries *model.Queries, registry string, plugin string) error
 
 	// Find a compatible version
 	if pluginInfo == nil {
-		return fmt.Errorf("plugin %s not found in registry %s", plugin, registry)
+		return "", fmt.Errorf("plugin %s not found in registry %s", plugin, registry)
 	}
 
 	file, version, err := FindPluginVersionCandidate(*pluginInfo)
 	if err != nil {
-		return err
+		return "", err
 	}
 	// Download the file
 	err = downloadZipToPath(file.URL, path, file.Hash)
 	if err != nil {
-		return err
+		return "", err
 	}
 
 	// Add the plugin to the database
@@ -109,13 +111,13 @@ func InstallPlugin(queries *model.Queries, registry string, plugin string) error
 
 	configJSON, err := json.Marshal(version.UserConfig)
 	if err != nil {
-		return err
+		return "", err
 	}
 	tablesJSON, err := json.Marshal(version.Tables)
 	if err != nil {
-		return err
+		return "", err
 	}
-	return queries.AddPlugin(context.Background(), model.AddPluginParams{
+	return path, queries.AddPlugin(context.Background(), model.AddPluginParams{
 		Name:     plugin,
 		Registry: registry,
 		Description: sql.NullString{
@@ -159,3 +161,17 @@ func downloadZipToPath(url string, path string, checksum string) error {
 	}
 	return client.Get()
 }
+
+const letters = "abcdefghijklmnopqrstuvwxyz1234567890"
+
+// Create a small ID that can be used in the path of a plugin
+// It is 6 characters long and contains only letters and numbers
+// It is not meant to be unique, but it is unlikely to collide
+// We don't use uppercase letter due to the case-insensitive nature of some filesystems
+func newSmallID() string {
+	str := strings.Builder{}
+	for i := 0; i < 6; i++ {
+		str.WriteByte(letters[rand.IntN(len(letters))])
+	}
+	return str.String()
+}

controller/config/model/query.sql.go

@@ -136,7 +136,8 @@ func UpdateRegistry(queries *model.Queries, name string) error {
 
 	// Check if registry has changed
 	if checksum == registry.Checksumregistry {
-		return nil
+		// Set the last updated time
+		return queries.UpdateRegistryFetched(ctx, name)
 	}
 
 	// Update registry