src/log.c

   1 /* -*- mode: c; c-file-style: "openbsd" -*- */
   2 /*      $OpenBSD: log.c,v 1.11 2007/12/07 17:17:00 reyk Exp $   */
   3
   4 /*
   5  * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
   6  *
   7  * Permission to use, copy, modify, and/or distribute this software for any
   8  * purpose with or without fee is hereby granted, provided that the above
   9  * copyright notice and this permission notice appear in all copies.
  10  *
  11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15  * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
  16  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  17  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18  */
  19
  20 #define _GNU_SOURCE
  21 #include <unistd.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <stdarg.h>
  25 #include <syslog.h>
  26 #include <sys/types.h>
  27 #include <string.h>
  28 #include <errno.h>
  29 #include <time.h>
  30
  31 /* By default, logging is done on stderr. */
  32 static int       debug = 1;
  33
  34 /* Logging can be modified by providing an appropriate log handler. */
  35 static void (*logh)(int severity, const char *msg) = NULL;
  36
  37 static void      vlog(int, const char *, const char *, va_list);
  38 static void      logit(int, const char *, ...);
  39
  40 void
  41 log_init(int n_debug, const char *progname)
  42 {
  43         debug = n_debug;
  44
  45         if (!debug)
  46                 openlog(progname, LOG_PID | LOG_NDELAY, LOG_DAEMON);
  47
  48         tzset();
  49 }
  50
  51 void
  52 log_register(void (*cb)(int, const char*))
  53 {
  54         logh = cb;
  55 }
  56
  57
  58 static void
  59 logit(int pri, const char *fmt, ...)
  60 {
  61         va_list ap;
  62
  63         va_start(ap, fmt);
  64         vlog(pri, NULL, fmt, ap);
  65         va_end(ap);
  66 }
  67
  68 static char *
  69 date()
  70 {
  71         /* Return the current date as incomplete ISO 8601 (2012-12-12T16:13:30) */
  72         static char date[] = "2012-12-12T16:13:30";
  73         time_t t = time(NULL);
  74         struct tm *tmp = localtime(&t);
  75         strftime(date, sizeof(date), "%Y-%m-%dT%H:%M:%S", tmp);
  76         return date;
  77 }
  78
  79 static const char *
  80 translate(int fd, int priority)
  81 {
  82         /* Translate a syslog priority to a string. With colors if the output is a terminal. */
  83         int tty = isatty(fd);
  84         switch (tty) {
  85         case 1:
  86                 switch (priority) {
  87                 case LOG_EMERG:   return "\033[1;37;41m[EMRG";
  88                 case LOG_ALERT:   return "\033[1;37;41m[ALRT";
  89                 case LOG_CRIT:    return "\033[1;37;41m[CRIT";
  90                 case LOG_ERR:     return "\033[1;31m[ ERR";
  91                 case LOG_WARNING: return "\033[1;33m[WARN";
  92                 case LOG_NOTICE:  return "\033[1;34m[NOTI";
  93                 case LOG_INFO:    return "\033[1;34m[INFO";
  94                 case LOG_DEBUG:   return "\033[1;30m[ DBG";
  95                 }
  96                 break;
  97         default:
  98                 switch (priority) {
  99                 case LOG_EMERG:   return "[EMRG";
 100                 case LOG_ALERT:   return "[ALRT";
 101                 case LOG_CRIT:    return "[CRIT";
 102                 case LOG_ERR:     return "[ ERR";
 103                 case LOG_WARNING: return "[WARN";
 104                 case LOG_NOTICE:  return "[NOTI";
 105                 case LOG_INFO:    return "[INFO";
 106                 case LOG_DEBUG:   return "[ DBG";
 107                 }
 108         }
 109         return "[UNKN]";
 110 }
 111
 112 static void
 113 vlog(int pri, const char *token, const char *fmt, va_list ap)
 114 {
 115         if (logh) {
 116                 char *result;
 117                 if (vasprintf(&result, fmt, ap) != -1) {
 118                         logh(pri, result);
 119                         return;
 120                 }
 121                 /* Otherwise, fallback to output on stderr. */
 122         }
 123         if (debug || logh) {
 124                 char *nfmt;
 125                 /* best effort in out of mem situations */
 126                 if (asprintf(&nfmt, "%s %s%s%s]%s %s\n",
 127                         date(),
 128                         translate(STDERR_FILENO, pri),
 129                         token ? "/" : "", token ? token : "",
 130                         isatty(STDERR_FILENO) ? "\033[0m" : "",
 131                         fmt) == -1) {
 132                         vfprintf(stderr, fmt, ap);
 133                         fprintf(stderr, "\n");
 134                 } else {
 135                         vfprintf(stderr, nfmt, ap);
 136                         free(nfmt);
 137                 }
 138                 fflush(stderr);
 139         } else
 140                 vsyslog(pri, fmt, ap);
 141 }
 142
 143
 144 void
 145 log_warn(const char *token, const char *emsg, ...)
 146 {
 147         char    *nfmt;
 148         va_list  ap;
 149
 150         /* best effort to even work in out of memory situations */
 151         if (emsg == NULL)
 152                 logit(LOG_WARNING, "%s", strerror(errno));
 153         else {
 154                 va_start(ap, emsg);
 155
 156                 if (asprintf(&nfmt, "%s: %s", emsg, strerror(errno)) == -1) {
 157                         /* we tried it... */
 158                         vlog(LOG_WARNING, token, emsg, ap);
 159                         logit(LOG_WARNING, "%s", strerror(errno));
 160                 } else {
 161                         vlog(LOG_WARNING, token, nfmt, ap);
 162                         free(nfmt);
 163                 }
 164                 va_end(ap);
 165         }
 166 }
 167
 168 void
 169 log_warnx(const char *token, const char *emsg, ...)
 170 {
 171         va_list  ap;
 172
 173         va_start(ap, emsg);
 174         vlog(LOG_WARNING, token, emsg, ap);
 175         va_end(ap);
 176 }
 177
 178 void
 179 log_info(const char *token, const char *emsg, ...)
 180 {
 181         va_list  ap;
 182
 183         if (debug > 1 || logh) {
 184                 va_start(ap, emsg);
 185                 vlog(LOG_INFO, token, emsg, ap);
 186                 va_end(ap);
 187         }
 188 }
 189
 190 void
 191 log_debug(const char *token, const char *emsg, ...)
 192 {
 193         va_list  ap;
 194
 195         if (debug > 2 || logh) {
 196                 va_start(ap, emsg);
 197                 vlog(LOG_DEBUG, token, emsg, ap);
 198                 va_end(ap);
 199         }
 200 }
 201
 202 void
 203 fatal(const char *emsg)
 204 {
 205         if (emsg == NULL)
 206                 logit(LOG_CRIT, "fatal: %s", strerror(errno));
 207         else
 208                 if (errno)
 209                         logit(LOG_CRIT, "fatal: %s: %s",
 210                             emsg, strerror(errno));
 211                 else
 212                         logit(LOG_CRIT, "fatal: %s", emsg);
 213
 214         exit(1);
 215 }
 216
 217 void
 218 fatalx(const char *emsg)
 219 {
 220         errno = 0;
 221         fatal(emsg);
 222 }