github.com/vchain-us/vcn@v0.9.11-0.20210921212052-a2484d23c0b3/pkg/cmd/cmd.go

/*
 * Copyright (c) 2018-2020 vChain, Inc. All Rights Reserved.
 * This software is released under GPL3.
 * The full license information can be found under:
 * https://www.gnu.org/licenses/gpl-3.0.en.html
 *
 */

package cmd

import (
	"fmt"
	"os"
	"strings"
	"syscall"

	"github.com/vchain-us/vcn/pkg/cmd/alert"

	"golang.org/x/crypto/ssh/terminal"

	"github.com/vchain-us/vcn/pkg/cmd/bom"
	"github.com/vchain-us/vcn/pkg/cmd/dashboard"
	"github.com/vchain-us/vcn/pkg/cmd/info"
	"github.com/vchain-us/vcn/pkg/cmd/inspect"
	"github.com/vchain-us/vcn/pkg/cmd/internal/cli"
	"github.com/vchain-us/vcn/pkg/cmd/internal/types"
	"github.com/vchain-us/vcn/pkg/cmd/list"
	"github.com/vchain-us/vcn/pkg/cmd/login"
	"github.com/vchain-us/vcn/pkg/cmd/logout"
	"github.com/vchain-us/vcn/pkg/cmd/serve"
	"github.com/vchain-us/vcn/pkg/cmd/set"
	"github.com/vchain-us/vcn/pkg/cmd/sign"
	"github.com/vchain-us/vcn/pkg/cmd/verify"
	"github.com/vchain-us/vcn/pkg/meta"
	"github.com/vchain-us/vcn/pkg/store"

	"github.com/inconshreveable/mousetrap"
	"github.com/spf13/cobra"
	"github.com/spf13/viper"
)

var cfgFile string

// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
	Use:     "vcn",
	Version: meta.Version(),
	Short:   "vChain CodeNotary - Notarize and authenticate, from code to production",
	Long:    ``,
}

// Root returns the root &cobra.Command
func Root() *cobra.Command {
	return rootCmd
}

// Execute adds all child commands to the root command and sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute() {
	var err error
	var cmd *cobra.Command
	var output string
	if cmd, err = rootCmd.ExecuteC(); err != nil {
		if !viper.IsSet("exit-code") {
			viper.Set("exit-code", 1)
		}
		output, _ = rootCmd.PersistentFlags().GetString("output")
		if output != "" && !cmd.SilenceErrors {
			cli.PrintError(output, types.NewError(err))
		}
	}
	// disable version check on lc context
	var versionCheck = false
	if store.Config() != nil && store.Config().CurrentContext.Email != "" {
		versionCheck = true
	}
	preExitHook(rootCmd, versionCheck)

	exitCode := meta.VcnDefaultExitCode
	if viper.IsSet("exit-code") {
		exitCode = viper.GetInt("exit-code")
	}
	os.Exit(exitCode)
}

func init() {

	// Read in environment variables that match
	viper.SetEnvPrefix(strings.ToUpper(meta.VcnPrefix))
	viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
	viper.AutomaticEnv()

	// Set config files directory based on os.TempDir method ( Linux: /temp/.vcn, Windows: c:\temp, c:\windows\temp )
	if err := store.SetDefaultDir(); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	// Disable default behavior when started through explorer.exe
	cobra.MousetrapHelpText = ""

	cobra.OnInitialize(initConfig)

	// Here you will define your flags and configuration settings.
	// Cobra supports persistent flags, which, if defined here,
	// will be global for your application.
	rootCmd.PersistentFlags().StringVar(&cfgFile, "vcnpath", "", "config files (default is /tmp/.vcn/config.json on linux, c:\\temp\\config.json or c:\\windows\\temp\\config.json on Windows)")
	rootCmd.PersistentFlags().StringP("output", "o", "", "output format, one of: --output=json|--output=yaml|--output=''. In Codenotary Cloud authenticate command is possible to specify also --output=attachments. It permits to download all items attached to an artifact.")
	rootCmd.PersistentFlags().BoolP("silent", "S", false, "silent mode, don't show progress spinner, but it will still output the result")
	rootCmd.PersistentFlags().BoolP("quit", "q", true, "if false, ask for confirmation before quitting")
	rootCmd.PersistentFlags().Bool("verbose", false, "if true, print additional information")
	//rootCmd.PersistentFlags().String("vcnpath", "", "if false, ask for confirmation before quitting")

	rootCmd.PersistentFlags().MarkHidden("quit")

	// Root command flags
	rootCmd.Flags().BoolP("version", "v", false, "version for vcn") // needed for -v shorthand

	// Verification group
	rootCmd.AddCommand(verify.NewCommand())
	rootCmd.AddCommand(inspect.NewCommand())
	rootCmd.AddCommand(list.NewCommand())

	// Signing group
	rootCmd.AddCommand(sign.NewCommand())
	rootCmd.AddCommand(sign.NewUntrustCommand())
	rootCmd.AddCommand(sign.NewUnsupportCommand())

	// User group
	rootCmd.AddCommand(login.NewCommand())
	rootCmd.AddCommand(logout.NewCommand())
	rootCmd.AddCommand(dashboard.NewCommand())
	rootCmd.AddCommand(info.NewCommand())

	// Set command
	rootCmd.AddCommand(set.NewCommand())

	// Serve command
	rootCmd.AddCommand(serve.NewCommand())

	// Alert comand
	rootCmd.AddCommand(alert.NewCommand())

	// BoM
	rootCmd.AddCommand(bom.NewCommand())
}

func preExitHook(cmd *cobra.Command, versionCheck bool) {
	if output, _ := rootCmd.PersistentFlags().GetString("output"); output == "" && versionCheck {
		cli.CheckVersion()
	}

	if quit, _ := cmd.PersistentFlags().GetBool("quit"); !quit || mousetrap.StartedByExplorer() {
		fmt.Println()
		fmt.Println("Press 'Enter' to continue...")
		terminal.ReadPassword(int(syscall.Stdin))
	}
}