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 {

    59

    [ -t 1 ] && IS_TTY=y

    60

}

    61

    62

# Output message to stderr.

    63

function log_msg {

    64

    echo "$*" >&2

    65

}

    66

    67

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

    68

function log_color {

    69

    local code=$1; shift

    70

    71

    if [ $IS_TTY ]; then

    72

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

    73

    else

    74

        echo "$*" >&2

    75

    fi

    76

}

    77

    78

## Log at various log-levels

    79

# plain

    80

function log {

    81

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

    82

}

    83

    84

function log_error {

    85

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

    86

}

    87

    88

function log_warn {

    89

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

    90

}

    91

    92

function log_force {

    93

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

    94

}

    95

    96

function log_apply {

    97

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

    98

}

    99

   100

function log_check {

   101

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

   102

}

   103

   104

function log_noop {

   105

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

   106

}

   107

   108

function log_skip {

   109

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

   110

}

   111

   112

function log_debug {

   113

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

   114

}

   115

   116

function log_cmd {

   117

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

   118

}

   119

   120

# Output stacktrace, broken.

   121

function log_stack {

   122

    local level=1

   123

   124

    while info=$(caller $level); do

   125

        echo $info | read line sub file

   126

   127

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

   128

   129

        level=$(($level + 1))

   130

    done

   131

}

   132

   133

### High-level logging output

   134

# Log with func_caller at log_debug

   135

function debug {

   136

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

   137

   138

    log_debug "$prefix: $*"

   139

}

   140

   141

function warn {

   142

    log_warn "$(func_caller): $*"

   143

}

   144

   145

function error {

   146

    log_error "$(func_caller): $*"

   147

}

   148

   149

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

   150

function fail {

   151

    log_error "$(func_caller): $*"

   152

   153

    exit 2

   154

}

   155

   156

# Log at log_error and exit

   157

function die {

   158

    log_error "$*"

   159

    exit 1

   160

}