shell

Documentation

Index

• Constants
• type Arg
  • func NewArg(raw string, argType ArgType) Arg
  • func (a Arg) HasValue() bool
  • func (a Arg) String() string
  • func (a Arg) Type() ArgType
  • func (a Arg) Value() string
• type ArgType
• type Args
  • func NewArgs() *Args
  • func (a *Args) AddArg(arg string, argType ArgType)
  • func (a *Args) AddArgs(args []string, argType ArgType)
  • func (a *Args) AddFlag(key, value string, argType ArgType)
  • func (a *Args) AddFlags(key string, values []string, argType ArgType)
  • func (a *Args) Clone() *Args
  • func (a *Args) Get(name string) ([]Arg, bool)
  • func (a *Args) GetAll() []string
  • func (a *Args) PromoteSecondaryToPrimary()
  • func (a *Args) SetLegacyArg(legacy bool) *Args
  • func (a *Args) ToMap() map[string][]string
  • func (a *Args) Walk(callback func(name string, arg *Arg) *Arg)
• type Command
  • func NewCommand(command string, args []string) *Command
  • func NewSignalledCommand(command string, args []string, c chan os.Signal) *Command
  • func (c *Command) Run() (progress.Summary, string, error)
  • func (c *Command) ScanStderr(r io.Reader, w1, w2 io.Writer) error
• type OutputAnalyser
  • func NewOutputAnalyser() *OutputAnalyser
  • func (a OutputAnalyser) AnalyseLines(output io.Reader) progress.OutputAnalysis
  • func (a OutputAnalyser) AnalyseStringLines(output string) progress.OutputAnalysis
  • func (a OutputAnalyser) ContainsRemoteLockFailure() bool
  • func (a OutputAnalyser) GetRemoteLockedBy() (string, bool)
  • func (a OutputAnalyser) GetRemoteLockedSince() (time.Duration, bool)
• type ResticJsonSummary
• type ScanOutput
• type SetPID

Constants

const ArgTypeCount = 4

Types

type Arg

type Arg struct {
	// contains filtered or unexported fields
}

func NewArg

func NewArg(raw string, argType ArgType) Arg

func (Arg) HasValue

func (a Arg) HasValue() bool

func (Arg) String

func (a Arg) String() string

func (Arg) Type

func (a Arg) Type() ArgType

func (Arg) Value

func (a Arg) Value() string

type ArgType

type ArgType int

const (
	ArgConfigEscape        ArgType = iota // escape each special character but don't add quotes
	ArgConfigKeepGlobQuote                // use double quotes around argument when needed so the shell doesn't resolve glob patterns
	ArgCommandLineEscape                  // same as ArgConfigEscape but argument is coming from the command line
	ArgConfigBackupSource                 // same as ArgConfigEscape but represents the folders to add at the end of a backup command
	ArgLegacyEscape
	ArgLegacyKeepGlobQuote
	ArgLegacyCommandLineEscape
	ArgLegacyConfigBackupSource
)

type Args

type Args struct {
	// contains filtered or unexported fields
}

func NewArgs

func NewArgs() *Args

func (*Args) AddArg

func (a *Args) AddArg(arg string, argType ArgType)

AddArg adds a single argument with no flag

func (*Args) AddArgs

func (a *Args) AddArgs(args []string, argType ArgType)

AddArgs adds multiple arguments not associated with a flag

func (*Args) AddFlag

func (a *Args) AddFlag(key, value string, argType ArgType)

AddFlag adds a value to a flag

func (*Args) AddFlags

func (a *Args) AddFlags(key string, values []string, argType ArgType)

AddFlags adds a slice of values for the same flag

func (*Args) Clone

func (a *Args) Clone() *Args

func (*Args) Get

func (a *Args) Get(name string) ([]Arg, bool)

func (*Args) GetAll

func (a *Args) GetAll() []string

GetAll return a clean list of arguments to send on the command line

func (*Args) PromoteSecondaryToPrimary

func (a *Args) PromoteSecondaryToPrimary()

PromoteSecondaryToPrimary removes a "2" at the end of each flag

func (*Args) SetLegacyArg

func (a *Args) SetLegacyArg(legacy bool) *Args

SetLegacyArg is used to activate the legacy (broken) mode of sending arguments on the restic command line

func (*Args) ToMap

func (a *Args) ToMap() map[string][]string

ToMap converts the arguments to a map. It is only used by unit tests.

func (*Args) Walk

func (a *Args) Walk(callback func(name string, arg *Arg) *Arg)

type Command

type Command struct {
	Command       string
	Arguments     []string
	Environ       []string
	Dir           string
	Stdin         io.Reader
	Stdout        io.Writer
	Stderr        io.Writer
	SetPID        SetPID
	ScanStdout    ScanOutput
	UsePowershell bool
	// contains filtered or unexported fields
}

Command holds the configuration to run a shell command

func NewCommand

func NewCommand(command string, args []string) *Command

NewCommand instantiate a default Command without receiving OS signals (SIGTERM, etc.)

func NewSignalledCommand

func NewSignalledCommand(command string, args []string, c chan os.Signal) *Command

NewSignalledCommand instantiate a default Command receiving OS signals (SIGTERM, etc.)

func (*Command) Run

func (c *Command) Run() (progress.Summary, string, error)

Run the command

func (*Command) ScanStderr

func (c *Command) ScanStderr(r io.Reader, w1, w2 io.Writer) error

type OutputAnalyser

type OutputAnalyser struct {
	// contains filtered or unexported fields
}

func NewOutputAnalyser

func NewOutputAnalyser() *OutputAnalyser

func (OutputAnalyser) AnalyseLines

func (a OutputAnalyser) AnalyseLines(output io.Reader) progress.OutputAnalysis

func (OutputAnalyser) AnalyseStringLines

func (a OutputAnalyser) AnalyseStringLines(output string) progress.OutputAnalysis

func (OutputAnalyser) ContainsRemoteLockFailure

func (a OutputAnalyser) ContainsRemoteLockFailure() bool

func (OutputAnalyser) GetRemoteLockedBy

func (a OutputAnalyser) GetRemoteLockedBy() (string, bool)

func (OutputAnalyser) GetRemoteLockedSince

func (a OutputAnalyser) GetRemoteLockedSince() (time.Duration, bool)

type ResticJsonSummary

type ResticJsonSummary struct {
	MessageType         string  `json:"message_type"`
	FilesNew            int     `json:"files_new"`
	FilesChanged        int     `json:"files_changed"`
	FilesUnmodified     int     `json:"files_unmodified"`
	DirsNew             int     `json:"dirs_new"`
	DirsChanged         int     `json:"dirs_changed"`
	DirsUnmodified      int     `json:"dirs_unmodified"`
	DataBlobs           int     `json:"data_blobs"`
	TreeBlobs           int     `json:"tree_blobs"`
	DataAdded           uint64  `json:"data_added"`
	TotalFilesProcessed int     `json:"total_files_processed"`
	TotalBytesProcessed uint64  `json:"total_bytes_processed"`
	TotalDuration       float64 `json:"total_duration"`
	SnapshotID          string  `json:"snapshot_id"`
}

type ScanOutput

type ScanOutput func(r io.Reader, summary *progress.Summary, w io.Writer) error

ScanOutput is a callback to scan the default output of the command The implementation is expected to send everything read from the reader back to the writer

var ScanBackupJson ScanOutput = func(r io.Reader, summary *progress.Summary, w io.Writer) error {
	bogusPrefix := []byte("\r\x1b[2K")
	jsonPrefix := []byte(`{"message_type":"`)
	summaryPrefix := []byte(`{"message_type":"summary",`)
	jsonSuffix := []byte("}")
	eol := "\n"
	if runtime.GOOS == "windows" {
		eol = "\r\n"
	}
	scanner := bufio.NewScanner(r)
	for scanner.Scan() {
		line := scanner.Bytes()
		line = bytes.TrimPrefix(line, bogusPrefix)
		if bytes.HasPrefix(line, jsonPrefix) && bytes.HasSuffix(line, jsonSuffix) {
			if bytes.HasPrefix(line, summaryPrefix) {
				jsonSummary := ResticJsonSummary{}
				err := json.Unmarshal(line, &jsonSummary)
				if err != nil {
					continue
				}
				summary.FilesNew = jsonSummary.FilesNew
				summary.FilesChanged = jsonSummary.FilesChanged
				summary.FilesUnmodified = jsonSummary.FilesUnmodified
				summary.DirsNew = jsonSummary.DirsNew
				summary.DirsChanged = jsonSummary.DirsChanged
				summary.DirsUnmodified = jsonSummary.DirsUnmodified
				summary.FilesTotal = jsonSummary.TotalFilesProcessed
				summary.BytesAdded = jsonSummary.DataAdded
				summary.BytesTotal = jsonSummary.TotalBytesProcessed
			}
			continue
		}

		_, _ = w.Write(line)
		_, _ = w.Write([]byte(eol))
	}

	if err := scanner.Err(); err != nil {
		return err
	}
	return nil
}

ScanBackupJson should populate the backup summary values from the output of the --json flag

var ScanBackupPlain ScanOutput = func(r io.Reader, summary *progress.Summary, w io.Writer) error {
	eol := "\n"
	if runtime.GOOS == "windows" {
		eol = "\r\n"
	}
	rawBytes, unit, duration := 0.0, "", ""
	scanner := bufio.NewScanner(r)
	for scanner.Scan() {
		w.Write([]byte(scanner.Text() + eol))

		_, _ = fmt.Sscanf(scanner.Text(), "Files: %d new, %d changed, %d unmodified", &summary.FilesNew, &summary.FilesChanged, &summary.FilesUnmodified)
		_, _ = fmt.Sscanf(scanner.Text(), "Dirs: %d new, %d changed, %d unmodified", &summary.DirsNew, &summary.DirsChanged, &summary.DirsUnmodified)

		n, err := fmt.Sscanf(scanner.Text(), "Added to the repo: %f %3s", &rawBytes, &unit)
		if n == 2 && err == nil {
			summary.BytesAdded = unformatBytes(rawBytes, unit)
		}

		n, err = fmt.Sscanf(scanner.Text(), "processed %d files, %f %3s in %s", &summary.FilesTotal, &rawBytes, &unit, &duration)
		if n == 4 && err == nil {
			summary.BytesTotal = unformatBytes(rawBytes, unit)
		}
	}

	if err := scanner.Err(); err != nil {
		return err
	}
	return nil
}

ScanBackupPlain should populate the backup summary values from the standard output

type SetPID

type SetPID func(pid int)

SetPID is a callback to send the PID of the current child process