Add support for staging and purging

cmds/updatemgr/.gitignore

@@ -0,0 +1,2 @@
+updatemgr
+updatemgr.exe

cmds/updatemgr/confirm.go

@@ -0,0 +1,20 @@
+package main
+
+import (
+	"bufio"
+	"fmt"
+	"os"
+	"strings"
+)
+
+func confirm(msg string) bool {
+	fmt.Printf("%s: [y|n] ", msg)
+
+	scanner := bufio.NewScanner(os.Stdin)
+	ok := scanner.Scan()
+	if ok && strings.TrimSpace(scanner.Text()) == "y" {
+		return true
+	}
+
+	return false
+}

cmds/updatemgr/main.go

@@ -0,0 +1,34 @@
+package main
+
+import (
+	"os"
+	"path/filepath"
+
+	"github.com/safing/portbase/updater"
+	"github.com/safing/portbase/utils"
+	"github.com/spf13/cobra"
+)
+
+var registry *updater.ResourceRegistry
+
+var rootCmd = &cobra.Command{
+	Use:   "updatemgr",
+	Short: "A simple tool to assist in the update and release process",
+	Args:  cobra.ExactArgs(1),
+	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
+		absPath, err := filepath.Abs(args[0])
+		if err != nil {
+			return err
+		}
+
+		registry = &updater.ResourceRegistry{}
+		return registry.Initialize(utils.NewDirStructure(absPath, 0o755))
+	},
+	SilenceUsage: true,
+}
+
+func main() {
+	if err := rootCmd.Execute(); err != nil {
+		os.Exit(1)
+	}
+}

cmds/updatemgr/purge.go

@@ -0,0 +1,58 @@
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/spf13/cobra"
+
+	"github.com/safing/portbase/log"
+	"github.com/safing/portbase/updater"
+)
+
+func init() {
+	rootCmd.AddCommand(purgeCmd)
+}
+
+var purgeCmd = &cobra.Command{
+	Use:   "purge",
+	Short: "Remove old resource versions that are superseded by at least three versions",
+	Args:  cobra.ExactArgs(1),
+	RunE:  purge,
+}
+
+func purge(cmd *cobra.Command, args []string) error {
+	log.SetLogLevel(log.TraceLevel)
+	err := log.Start()
+	if err != nil {
+		fmt.Printf("failed to start logging: %s\n", err)
+	}
+	defer log.Shutdown()
+
+	registry.AddIndex(updater.Index{
+		Path:   "stable.json",
+		Stable: true,
+		Beta:   false,
+	})
+
+	registry.AddIndex(updater.Index{
+		Path:   "beta.json",
+		Stable: false,
+		Beta:   true,
+	})
+
+	err = registry.LoadIndexes(context.TODO())
+	if err != nil {
+		return err
+	}
+
+	err = scanStorage()
+	if err != nil {
+		return err
+	}
+
+	registry.SelectVersions()
+	registry.Purge(3)
+
+	return nil
+}

cmds/updatemgr/scan.go

@@ -0,0 +1,80 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"path/filepath"
+	"strings"
+
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	rootCmd.AddCommand(scanCmd)
+}
+
+var scanCmd = &cobra.Command{
+	Use:   "scan",
+	Short: "Scan the specified directory and print the result",
+	Args:  cobra.ExactArgs(1),
+	RunE:  scan,
+}
+
+func scan(cmd *cobra.Command, args []string) error {
+	err := scanStorage()
+	if err != nil {
+		return err
+	}
+
+	// export beta
+	data, err := json.MarshalIndent(exportSelected(true), "", " ")
+	if err != nil {
+		return err
+	}
+	// print
+	fmt.Println("beta:")
+	fmt.Println(string(data))
+
+	// export stable
+	data, err = json.MarshalIndent(exportSelected(false), "", " ")
+	if err != nil {
+		return err
+	}
+	// print
+	fmt.Println("\nstable:")
+	fmt.Println(string(data))
+
+	return nil
+}
+
+func scanStorage() error {
+	files, err := ioutil.ReadDir(registry.StorageDir().Path)
+	if err != nil {
+		return err
+	}
+
+	// scan "all" and all "os_platform" dirs
+	for _, file := range files {
+		if file.IsDir() && (file.Name() == "all" || strings.Contains(file.Name(), "_")) {
+			err := registry.ScanStorage(filepath.Join(registry.StorageDir().Path, file.Name()))
+			if err != nil {
+				return err
+			}
+		}
+	}
+
+	return nil
+}
+
+func exportSelected(beta bool) map[string]string {
+	registry.SetBeta(beta)
+	registry.SelectVersions()
+	export := registry.Export()
+
+	versions := make(map[string]string)
+	for _, rv := range export {
+		versions[rv.Identifier] = rv.SelectedVersion.VersionNumber
+	}
+	return versions
+}

cmds/updatemgr/staging.go

@@ -0,0 +1,122 @@
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+
+	"github.com/safing/portbase/updater"
+	"github.com/spf13/cobra"
+)
+
+var (
+	stageReset bool
+)
+
+func init() {
+	rootCmd.AddCommand(stageCmd)
+	stageCmd.Flags().BoolVar(&stageReset, "reset", false, "Reset staging assets")
+}
+
+var stageCmd = &cobra.Command{
+	Use:   "stage",
+	Short: "Stage scans the specified directory and loads the indexes - it then creates a staging index with all files newer than the stable and beta indexes",
+	Args:  cobra.ExactArgs(1),
+	RunE:  stage,
+}
+
+func stage(cmd *cobra.Command, args []string) error {
+	registry.AddIndex(updater.Index{
+		Path:   "stable.json",
+		Stable: true,
+		Beta:   false,
+	})
+
+	registry.AddIndex(updater.Index{
+		Path:   "beta.json",
+		Stable: false,
+		Beta:   true,
+	})
+
+	err := registry.LoadIndexes(context.TODO())
+	if err != nil {
+		return err
+	}
+
+	err = scanStorage()
+	if err != nil {
+		return err
+	}
+
+	// Check if we want to reset staging instead.
+	if stageReset {
+		for _, stagedPath := range exportStaging(true) {
+			err = os.Remove(stagedPath)
+			if err != nil {
+				return err
+			}
+		}
+
+		return nil
+	}
+
+	// Export all staged versions and format them.
+	stagingData, err := json.MarshalIndent(exportStaging(false), "", " ")
+	if err != nil {
+		return err
+	}
+
+	// Build destination path.
+	stagingIndexFilePath := filepath.Join(registry.StorageDir().Path, "staging.json")
+
+	// Print preview.
+	fmt.Printf("staging (%s):\n", stagingIndexFilePath)
+	fmt.Println(string(stagingData))
+
+	// Ask for confirmation.
+	if !confirm("\nDo you want to write this index?") {
+		fmt.Println("aborted...")
+		return nil
+	}
+
+	// Write new index to disk.
+	err = ioutil.WriteFile(stagingIndexFilePath, stagingData, 0o644) //nolint:gosec // 0644 is intended
+	if err != nil {
+		return err
+	}
+	fmt.Printf("written %s\n", stagingIndexFilePath)
+
+	return nil
+}
+
+func exportStaging(storagePath bool) map[string]string {
+	// Sort all versions.
+	registry.SetBeta(false)
+	registry.SelectVersions()
+	export := registry.Export()
+
+	// Go through all versions and save the highest version, if not stable or beta.
+	versions := make(map[string]string)
+	for _, rv := range export {
+		// Get highest version.
+		v := rv.Versions[0]
+
+		// Do not take stable or beta releases into account.
+		if v.StableRelease || v.BetaRelease {
+			continue
+		}
+
+		// Add highest version to staging
+		if storagePath {
+			rv.SelectedVersion = v
+			versions[rv.Identifier] = rv.GetFile().Path()
+		} else {
+			versions[rv.Identifier] = v.VersionNumber
+		}
+	}
+
+	return versions
+}

cmds/updatemgr/update.go

@@ -0,0 +1,77 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	rootCmd.AddCommand(updateCmd)
+}
+
+var updateCmd = &cobra.Command{
+	Use:   "update",
+	Short: "Update scans the specified directory and registry the index and symlink structure",
+	Args:  cobra.ExactArgs(1),
+	RunE:  update,
+}
+
+func update(cmd *cobra.Command, args []string) error {
+	err := scanStorage()
+	if err != nil {
+		return err
+	}
+
+	// Export versions.
+	betaData, err := json.MarshalIndent(exportSelected(true), "", " ")
+	if err != nil {
+		return err
+	}
+	stableData, err := json.MarshalIndent(exportSelected(false), "", " ")
+	if err != nil {
+		return err
+	}
+
+	// Build destination paths.
+	betaIndexFilePath := filepath.Join(registry.StorageDir().Path, "beta.json")
+	stableIndexFilePath := filepath.Join(registry.StorageDir().Path, "stable.json")
+
+	// Print previews.
+	fmt.Printf("beta (%s):\n", betaIndexFilePath)
+	fmt.Println(string(betaData))
+	fmt.Printf("\nstable: (%s)\n", stableIndexFilePath)
+	fmt.Println(string(stableData))
+
+	// Ask for confirmation.
+	if !confirm("\nDo you want to write these new indexes (and update latest symlinks)?") {
+		fmt.Println("aborted...")
+		return nil
+	}
+
+	// Write indexes.
+	err = ioutil.WriteFile(betaIndexFilePath, betaData, 0o644) //nolint:gosec // 0644 is intended
+	if err != nil {
+		return err
+	}
+	fmt.Printf("written %s\n", betaIndexFilePath)
+
+	err = ioutil.WriteFile(stableIndexFilePath, stableData, 0o644) //nolint:gosec // 0644 is intended
+	if err != nil {
+		return err
+	}
+	fmt.Printf("written %s\n", stableIndexFilePath)
+
+	// Create symlinks to latest stable versions.
+	symlinksDir := registry.StorageDir().ChildDir("latest", 0o755)
+	err = registry.CreateSymlinks(symlinksDir)
+	if err != nil {
+		return err
+	}
+	fmt.Printf("updated stable symlinks in %s\n", symlinksDir.Path)
+
+	return nil
+}