// Copyright © 2013 Steve Francia <spf@spf13.com>.

//

// 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 cobra is a commander providing a simple interface to create powerful modern CLI interfaces.

// In addition to providing an interface, Cobra simultaneously provides a controller to organize your application code.

package cobra

import (

	"bytes"

	"context"

	"fmt"

	"io"

	"os"

	"path/filepath"

	"sort"

	"strings"

	flag "github.com/spf13/pflag"

)

// FParseErrWhitelist configures Flag parse errors to be ignored

type FParseErrWhitelist flag.ParseErrorsWhitelist

// Command is just that, a command for your application.

// E.g.  'go run ...' - 'run' is the command. Cobra requires

// you to define the usage and description as part of your command

// definition to ensure usability.

type Command struct {

	// Use is the one-line usage message.

	// Recommended syntax is as follow:

	//   [ ] identifies an optional argument. Arguments that are not enclosed in brackets are required.

	//   ... indicates that you can specify multiple values for the previous argument.

	//   |   indicates mutually exclusive information. You can use the argument to the left of the separator or the

	//       argument to the right of the separator. You cannot use both arguments in a single use of the command.

	//   { } delimits a set of mutually exclusive arguments when one of the arguments is required. If the arguments are

	//       optional, they are enclosed in brackets ([ ]).

	// Example: add [-F file | -D dir]... [-f format] profile

	Use string

	// Aliases is an array of aliases that can be used instead of the first word in Use.

	Aliases []string

	// SuggestFor is an array of command names for which this command will be suggested -

	// similar to aliases but only suggests.

	SuggestFor []string

	// Short is the short description shown in the 'help' output.

	Short string

	// Long is the long message shown in the 'help <this-command>' output.

	Long string

	// Example is examples of how to use the command.

	Example string

	// ValidArgs is list of all valid non-flag arguments that are accepted in shell completions

	ValidArgs []string

	// ValidArgsFunction is an optional function that provides valid non-flag arguments for shell completion.

	// It is a dynamic version of using ValidArgs.

	// Only one of ValidArgs and ValidArgsFunction can be used for a command.

	ValidArgsFunction func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective)

	// Expected arguments

	Args PositionalArgs

	// ArgAliases is List of aliases for ValidArgs.

	// These are not suggested to the user in the shell completion,

	// but accepted if entered manually.

	ArgAliases []string

	// BashCompletionFunction is custom bash functions used by the legacy bash autocompletion generator.

	// For portability with other shells, it is recommended to instead use ValidArgsFunction

	BashCompletionFunction string

	// Deprecated defines, if this command is deprecated and should print this string when used.

	Deprecated string

	// Annotations are key/value pairs that can be used by applications to identify or

	// group commands.

	Annotations map[string]string

	// Version defines the version for this command. If this value is non-empty and the command does not

	// define a "version" flag, a "version" boolean flag will be added to the command and, if specified,

	// will print content of the "Version" variable. A shorthand "v" flag will also be added if the

	// command does not define one.

	Version string

	// The *Run functions are executed in the following order:

	//   * PersistentPreRun()

	//   * PreRun()

	//   * Run()

	//   * PostRun()

	//   * PersistentPostRun()

	// All functions get the same args, the arguments after the command name.

	//

	// PersistentPreRun: children of this command will inherit and execute.

	PersistentPreRun func(cmd *Command, args []string)

	// PersistentPreRunE: PersistentPreRun but returns an error.

	PersistentPreRunE func(cmd *Command, args []string) error

	// PreRun: children of this command will not inherit.

	PreRun func(cmd *Command, args []string)

	// PreRunE: PreRun but returns an error.

	PreRunE func(cmd *Command, args []string) error

	// Run: Typically the actual work function. Most commands will only implement this.

	Run func(cmd *Command, args []string)

	// RunE: Run but returns an error.

	RunE func(cmd *Command, args []string) error

	// PostRun: run after the Run command.

	PostRun func(cmd *Command, args []string)

	// PostRunE: PostRun but returns an error.

	PostRunE func(cmd *Command, args []string) error

	// PersistentPostRun: children of this command will inherit and execute after PostRun.

	PersistentPostRun func(cmd *Command, args []string)

	// PersistentPostRunE: PersistentPostRun but returns an error.

	PersistentPostRunE func(cmd *Command, args []string) error

	// args is actual args parsed from flags.

	args []string

	// flagErrorBuf contains all error messages from pflag.

	flagErrorBuf *bytes.Buffer

	// flags is full set of flags.

	flags *flag.FlagSet

	// pflags contains persistent flags.

	pflags *flag.FlagSet

	// lflags contains local flags.

	lflags *flag.FlagSet

	// iflags contains inherited flags.

	iflags *flag.FlagSet

	// parentsPflags is all persistent flags of cmd's parents.

	parentsPflags *flag.FlagSet

	// globNormFunc is the global normalization function

	// that we can use on every pflag set and children commands

	globNormFunc func(f *flag.FlagSet, name string) flag.NormalizedName

	// usageFunc is usage func defined by user.

	usageFunc func(*Command) error

	// usageTemplate is usage template defined by user.

	usageTemplate string

	// flagErrorFunc is func defined by user and it's called when the parsing of

	// flags returns an error.

	flagErrorFunc func(*Command, error) error

	// helpTemplate is help template defined by user.

	helpTemplate string

	// helpFunc is help func defined by user.

	helpFunc func(*Command, []string)

	// helpCommand is command with usage 'help'. If it's not defined by user,

	// cobra uses default help command.

	helpCommand *Command

	// versionTemplate is the version template defined by user.

	versionTemplate string

	// inReader is a reader defined by the user that replaces stdin

	inReader io.Reader

	// outWriter is a writer defined by the user that replaces stdout

	outWriter io.Writer

	// errWriter is a writer defined by the user that replaces stderr

	errWriter io.Writer

	FParseErrWhitelist FParseErrWhitelist

	// CompletionOptions is a set of options to control the handling of shell completion

	CompletionOptions CompletionOptions

	// commandsAreSorted defines, if command slice are sorted or not.

	commandsAreSorted bool

	// commandCalledAs is the name or alias value used to call this command.

	commandCalledAs struct {

		name   string

		called bool

	}

	ctx context.Context

	// commands is the list of commands supported by this program.

	commands []*Command

	// parent is a parent command for this command.

	parent *Command

	// Max lengths of commands' string lengths for use in padding.

	commandsMaxUseLen         int

	commandsMaxCommandPathLen int

	commandsMaxNameLen        int

	// TraverseChildren parses flags on all parents before executing child command.

	TraverseChildren bool

	// Hidden defines, if this command is hidden and should NOT show up in the list of available commands.

	Hidden bool

	// SilenceErrors is an option to quiet errors down stream.

	SilenceErrors bool

	// SilenceUsage is an option to silence usage when an error occurs.

	SilenceUsage bool

	// DisableFlagParsing disables the flag parsing.

	// If this is true all flags will be passed to the command as arguments.

	DisableFlagParsing bool

	// DisableAutoGenTag defines, if gen tag ("Auto generated by spf13/cobra...")

	// will be printed by generating docs for this command.

	DisableAutoGenTag bool

	// DisableFlagsInUseLine will disable the addition of [flags] to the usage

	// line of a command when printing help or generating docs

	DisableFlagsInUseLine bool

	// DisableSuggestions disables the suggestions based on Levenshtein distance

	// that go along with 'unknown command' messages.

	DisableSuggestions bool

	// SuggestionsMinimumDistance defines minimum levenshtein distance to display suggestions.

	// Must be > 0.

	SuggestionsMinimumDistance int

}

func (c *Command) Context() context.Context {

	return c.ctx

}

// SetArgs sets arguments for the command. It is set to os.Args[1:] by default, if desired, can be overridden

// particularly useful when testing.

func (c *Command) SetArgs(a []string) {

	c.args = a

}

// SetOutput sets the destination for usage and error messages.

// If output is nil, os.Stderr is used.

// Deprecated: Use SetOut and/or SetErr instead

func (c *Command) SetOutput(output io.Writer) {

	c.outWriter = output

	c.errWriter = output

}

// SetOut sets the destination for usage messages.

// If newOut is nil, os.Stdout is used.

func (c *Command) SetOut(newOut io.Writer) {

	c.outWriter = newOut

}

// SetErr sets the destination for error messages.

// If newErr is nil, os.Stderr is used.

func (c *Command) SetErr(newErr io.Writer) {

	c.errWriter = newErr

}

// SetIn sets the source for input data

// If newIn is nil, os.Stdin is used.

func (c *Command) SetIn(newIn io.Reader) {

	c.inReader = newIn

}

// SetUsageFunc sets usage function. Usage can be defined by application.

func (c *Command) SetUsageFunc(f func(*Command) error) {

	c.usageFunc = f

}

// SetUsageTemplate sets usage template. Can be defined by Application.

func (c *Command) SetUsageTemplate(s string) {

	c.usageTemplate = s

}

// SetFlagErrorFunc sets a function to generate an error when flag parsing

// fails.

func (c *Command) SetFlagErrorFunc(f func(*Command, error) error) {

	c.flagErrorFunc = f

}

// SetHelpFunc sets help function. Can be defined by Application.

func (c *Command) SetHelpFunc(f func(*Command, []string)) {

	c.helpFunc = f

}

// SetHelpCommand sets help command.

func (c *Command) SetHelpCommand(cmd *Command) {

	c.helpCommand = cmd

}

// SetHelpTemplate sets help template to be used. Application can use it to set custom template.

func (c *Command) SetHelpTemplate(s string) {

	c.helpTemplate = s

}

// SetVersionTemplate sets version template to be used. Application can use it to set custom template.

func (c *Command) SetVersionTemplate(s string) {

	c.versionTemplate = s

}

// SetGlobalNormalizationFunc sets a normalization function to all flag sets and also to child commands.

// The user should not have a cyclic dependency on commands.

func (c *Command) SetGlobalNormalizationFunc(n func(f *flag.FlagSet, name string) flag.NormalizedName) {

	c.Flags().SetNormalizeFunc(n)

	c.PersistentFlags().SetNormalizeFunc(n)

	c.globNormFunc = n

	for _, command := range c.commands {

		command.SetGlobalNormalizationFunc(n)

	}

}

// OutOrStdout returns output to stdout.

func (c *Command) OutOrStdout() io.Writer {

	return c.getOut(os.Stdout)

}

// OutOrStderr returns output to stderr

func (c *Command) OutOrStderr() io.Writer {

	return c.getOut(os.Stderr)

}

// ErrOrStderr returns output to stderr

func (c *Command) ErrOrStderr() io.Writer {

	return c.getErr(os.Stderr)

}

// InOrStdin returns input to stdin

func (c *Command) InOrStdin() io.Reader {

	return c.getIn(os.Stdin)

}

func (c *Command) getOut(def io.Writer) io.Writer {

	if c.outWriter != nil {

		return c.outWriter

	}

	if c.HasParent() {

		return c.parent.getOut(def)

	}

	return def

}

func (c *Command) getErr(def io.Writer) io.Writer {

	if c.errWriter != nil {

		return c.errWriter

	}

	if c.HasParent() {

		return c.parent.getErr(def)

	}

	return def

}

func (c *Command) getIn(def io.Reader) io.Reader {

	if c.inReader != nil {

		return c.inReader

	}

	if c.HasParent() {

		return c.parent.getIn(def)

	}

	return def

}

// UsageFunc returns either the function set by SetUsageFunc for this command

// or a parent, or it returns a default usage function.

func (c *Command) UsageFunc() (f func(*Command) error) {

	if c.usageFunc != nil {

		return c.usageFunc

	}

	if c.HasParent() {

		return c.Parent().UsageFunc()

	}

	return func(c *Command) error {

		c.mergePersistentFlags()

		err := tmpl(c.OutOrStderr(), c.UsageTemplate(), c)

		if err != nil {

			c.PrintErrln(err)

		}

		return err

	}

}

// Usage puts out the usage for the command.

// Used when a user provides invalid input.

// Can be defined by user by overriding UsageFunc.

func (c *Command) Usage() error {

	return c.UsageFunc()(c)

}

// HelpFunc returns either the function set by SetHelpFunc for this command

// or a parent, or it returns a function with default help behavior.

func (c *Command) HelpFunc() func(*Command, []string) {

	if c.helpFunc != nil {

		return c.helpFunc

	}

	if c.HasParent() {

		return c.Parent().HelpFunc()

	}

	return func(c *Command, a []string) {

		c.mergePersistentFlags()

		// The help should be sent to stdout

		// See https://github.com/spf13/cobra/issues/1002

		err := tmpl(c.OutOrStdout(), c.HelpTemplate(), c)

		if err != nil {

			c.PrintErrln(err)

		}

	}

}

// Help puts out the help for the command.

// Used when a user calls help [command].

// Can be defined by user by overriding HelpFunc.

func (c *Command) Help() error {

	c.HelpFunc()(c, []string{})

	return nil

}

// UsageString returns usage string.