1

# Logging output

     2

     3

log_GETOPTS="qvDV"

     4

     5

LOG=y

     6

LOG_ERROR=y

     7

LOG_WARN=y

     8

LOG_FORCE=y

     9

LOG_APPLY=y

    10

LOG_CHECK=

    11

LOG_NOOP=y

    12

LOG_SKIP=

    13

LOG_DEBUG=

    14

LOG_CMD=

    15

LOG_DIFF=y

    16

    17

# use color output?

    18

IS_TTY=

    19

    20

function log_help {

    21

    cat <<END

    22

Logging:    

    23

    -q      quiet

    24

    -v      verbose

    25

    -D      debug

    26

    -V      debug commands

    27

END

    28

}

    29

    30

function log_opt {

    31

    local opt=$1

    32

    local optarg="$2"

    33

    34

    case $opt in

    35

        q)  

    36

            LOG= 

    37

            LOG_WARN=

    38

            LOG_APPLY=

    39

            LOG_FORCE=

    40

            LOG_NOOP=

    41

            LOG_DIFF=

    42

            ;;

    43

        v)  

    44

            LOG_CHECK=y

    45

            LOG_SKIP=y

    46

            ;;

    47

        D)  

    48

            LOG_DEBUG=y

    49

            LOG_INFO=y

    50

            ;;

    51

        V)  LOG_CMD=y ;;

    52

    53

        n)  LOG_NOOP=y ;;

    54

        *)  return 1

    55

    esac

    56

}

    57

    58

function log_init {

    62

}

    63

    64

# Output message to stderr.

    65

function log_msg {

    66

    echo "$*" >&2

    67

}

    68

    69

# Output message to stderr, optionally with given color, if TTY.

    70

function log_color {

    71

    local code=$1; shift

    72

    73

    if [ $IS_TTY ]; then

    74

        echo $'\e['${code}'m'"$*"$'\e[00m' >&2

    75

    else

    76

        echo "$*" >&2

    77

    fi

    78

}

    79

    80

## Log at various log-levels

    81

# plain

    82

function log {

    83

    [ $LOG          ] && log_msg            "$*"            || true

    84

}

    85

    86

function log_error {

    87

    [ $LOG_ERROR    ] && log_color '31'     "$*"            || true

    88

}

    89

    90

function log_warn {

    91

    [ $LOG_WARN     ] && log_color '33'     "$*"            || true

    92

}

    93

    94

function log_force {

    95

    [ $LOG_FORCE    ] && log_color '2;33'   "  $*"          || true

    96

}

    97

    98

function log_apply {

    99

    [ $LOG_APPLY    ] && log_color '36'     "  $*"          || true

   100

}

   101

   102

function log_check {

   103

    [ $LOG_CHECK    ] && log_color '32'     "  $*"          || true

   104

}

   105

   106

function log_noop {

   107

    [ $LOG_NOOP     ] && log_color '2;34'   "  $*"          || true

   108

}

   109

   110

function log_skip {

   111

    [ $LOG_SKIP     ] && log_color '1;34'   "  $*"          || true

   112

}

   113

   114

function log_debug {

   115

    [ $LOG_DEBUG    ] && log_color '34'     "    $*"        || true

   116

}

   117

   118

function log_cmd {

   119

    [ $LOG_CMD      ] && log_color '35'     "        \$ $*" || true

   120

}

   121

   122

# Output stacktrace, broken.

   123

function log_stack {

   124

    local level=1

   125

   126

    while info=$(caller $level); do

   127

        echo $info | read line sub file

   128

   129

        log_msg "$file:$lineno $sub()"

   130

   131

        level=$(($level + 1))

   132

    done

   133

}

   134

   135

### High-level logging output

   136

# Log with func_caller at log_debug

   137

function debug {

   138

    printf -v prefix "%s" $(func_caller)

   139

   140

    log_debug "$prefix: $*"

   141

}

   142

   143

function warn {

   144

    log_warn "$(func_caller): $*"

   145

}

   146

   147

function error {

   148

    log_error "$(func_caller): $*"

   149

}

   150

   151

# Log with func_caller at log_error and exit, intended for internal errors...

   152

function fail {

   153

    log_error "$(func_caller): $*"

   154

   155

    exit 2

   156

}

   157

   158

# Log at log_error and exit

   159

function die {

   160

    log_error "$*"

   161

    exit 1

   162

}