99 lines
3.3 KiB
Go
99 lines
3.3 KiB
Go
// Mgmt
|
|
// Copyright (C) 2013-2024+ James Shubin and the project contributors
|
|
// Written by James Shubin <james@shubin.ca> and the project contributors
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
//
|
|
// Additional permission under GNU GPL version 3 section 7
|
|
//
|
|
// If you modify this program, or any covered work, by linking or combining it
|
|
// with embedded mcl code and modules (and that the embedded mcl code and
|
|
// modules which link with this program, contain a copy of their source code in
|
|
// the authoritative form) containing parts covered by the terms of any other
|
|
// license, the licensors of this program grant you additional permission to
|
|
// convey the resulting work. Furthermore, the licensors of this program grant
|
|
// the original author, James Shubin, additional permission to update this
|
|
// additional permission if he deems it necessary to achieve the goals of this
|
|
// additional permission.
|
|
|
|
// Package util has some CLI related utility code.
|
|
package util
|
|
|
|
import (
|
|
"log"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/purpleidea/mgmt/util/errwrap"
|
|
)
|
|
|
|
// Error is a constant error type that implements error.
|
|
type Error string
|
|
|
|
// Error fulfills the error interface of this type.
|
|
func (e Error) Error() string { return string(e) }
|
|
|
|
const (
|
|
// MissingEquals means we probably hit the parsing bug.
|
|
// XXX: see: https://github.com/alexflint/go-arg/issues/239
|
|
MissingEquals = Error("missing equals sign for list element")
|
|
)
|
|
|
|
// CliParseError returns a consistent error if we have a CLI parsing issue.
|
|
func CliParseError(err error) error {
|
|
return errwrap.Wrapf(err, "cli parse error")
|
|
}
|
|
|
|
// Flags are some constant flags which are used throughout the program.
|
|
type Flags struct {
|
|
Debug bool // add additional log messages
|
|
Logf func(format string, v ...interface{})
|
|
}
|
|
|
|
// Data is a struct of values that we usually pass to the main CLI function.
|
|
type Data struct {
|
|
Program string
|
|
Version string
|
|
Copying string
|
|
Tagline string
|
|
Flags Flags
|
|
Args []string // os.Args usually
|
|
}
|
|
|
|
// SafeProgram returns the correct program string when given a buggy variant.
|
|
func SafeProgram(program string) string {
|
|
// FIXME: in sub commands, the cli package appends a space and the sub
|
|
// command name at the end. hack around this by only using the first bit
|
|
// see: https://github.com/urfave/cli/issues/783 for more details...
|
|
split := strings.Split(program, " ")
|
|
program = split[0]
|
|
//if program == "" {
|
|
// program = "<unknown>"
|
|
//}
|
|
return program
|
|
}
|
|
|
|
// LogSetup changes some of the core logger package settings.
|
|
func LogSetup(debug bool) {
|
|
// TODO: Move these log package initialization steps to the top main.go?
|
|
logFlags := log.LstdFlags
|
|
if debug {
|
|
logFlags = logFlags + log.Lshortfile
|
|
}
|
|
logFlags = logFlags - log.Ldate // remove the date for now
|
|
log.SetFlags(logFlags)
|
|
|
|
log.SetOutput(os.Stderr)
|
|
}
|