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_CHANGED=

    12

LOG_NOOP=y

    13

LOG_SKIP=

    14

LOG_DEBUG=

    15

LOG_CMD=

    16

LOG_DIFF=y

    17

    18

# use color output?

    19

IS_TTY=

    20

    21

function log_help {

    22

    cat <<END

    23

Logging:    

    24

    -q      quiet

    25

    -v      verbose

    26

    -D      debug

    27

    -V      debug commands

    28

END

    29

}

    30

    31

function log_opt {

    32

    local opt=$1

    33

    local optarg="$2"

    34

    35

    case $opt in

    36

        q)  

    37

            LOG= 

    38

            LOG_WARN=

    39

            LOG_APPLY=

    40

            LOG_FORCE=

    41

            LOG_NOOP=

    42

            LOG_DIFF=

    43

            ;;

    44

        v)  

    45

            LOG_CHANGED=y

    46

            LOG_CHECK=y

    47

            LOG_SKIP=y

    48

            ;;

    49

        D)  

    50

            LOG_DEBUG=y

    51

            LOG_INFO=y

    52

            ;;

    53

        V)  LOG_CMD=y ;;

    54

    55

        n)  LOG_NOOP=y ;;

    56

        *)  return 1

    57

    esac

    58

}

    59

    60

function log_init {

    61

    if [ -t 1 ]; then

    62

        IS_TTY=y

    63

    fi

    64

}

    65

    66

# Output message to stderr.

    67

function log_msg {

    68

    echo "$*" >&2

    69

}

    70

    71

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

    72

function log_color {

    73

    local code=$1; shift

    74

    75

    if [ $IS_TTY ]; then

    76

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

    77

    else

    78

        echo "$*" >&2

    79

    fi

    80

}

    81

    82

## Log at various log-levels

    83

# plain

    84

function log {

    85

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

    86

}

    87

    88

function log_error {

    89

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

    90

}

    91

    92

function log_warn {

    93

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

    94

}

    95

    96

function log_force {

    97

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

    98

}

    99

   100

function log_apply {

   101

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

   102

}

   103

   104

function log_check {

   105

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

   106

}

   107

   108

function log_changed {

   109

    [ $LOG_CHANGED  ] && log_color '1;32'   "  $*"          || true

   110

}

   111

   112

function log_noop {

   113

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

   114

}

   115

   116

function log_skip {

   117

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

   118

}

   119

   120

function log_debug {

   121

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

   122

}

   123

   124

function log_cmd {

   125

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

   126

}

   127

   128

# Output stacktrace, broken.

   129

function log_stack {

   130

    local level=1

   131

   132

    while info=$(caller $level); do

   133

        echo $info | read line sub file

   134

   135

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

   136

   137

        level=$(($level + 1))

   138

    done

   139

}

   140

   141

### High-level logging output

   142

# Log with func_caller at log_debug

   143

function debug {

   144

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

   145

   146

    log_debug "$prefix: $*"

   147

}

   148

   149

function warn {

   150

    log_warn "$(func_caller): $*"

   151

}

   152

   153

function error {

   154

    log_error "$(func_caller): $*"

   155

}

   156

   157

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

   158

function fail {

   159

    log_error "$(func_caller): $*"

   160

   161

    exit 2

   162

}

   163

   164

# Log at log_error and exit

   165

function die {

   166

    log_error "$*"

   167

    exit 1

   168

}