libatalk/util/logger.c

   1 #ifdef HAVE_CONFIG_H
   2 #include "config.h"
   3 #endif
   4
   5 /* =========================================================================
   6
   7        logger.c is part of the utils section in the libatalk library,
   8         which is part of the netatalk project.
   9
  10        logger.c was written by Simon Bazley (sibaz@sibaz.com)
  11
  12        I believe libatalk is released under the L/GPL licence.
  13        Just incase, it is, thats the licence I'm applying to this file.
  14        Netatalk 2001 (c)
  15
  16    ==========================================================================
  17
  18        Logger.c is intended as an alternative to syslog for logging
  19
  20    ========================================================================= */
  21
  22 #include <stdio.h>
  23 #include <limits.h>
  24 #include <stdarg.h>
  25 #include <string.h>
  26 #include <stdlib.h>
  27 #include <syslog.h>
  28 #include <sys/types.h>
  29 #include <sys/stat.h>
  30 #include <fcntl.h>
  31 #include <sys/uio.h>
  32 #include <unistd.h>
  33 #include <sys/time.h>
  34 #include <time.h>
  35 #include <ctype.h>
  36
  37 #include <atalk/boolean.h>
  38
  39 #define LOGGER_C
  40 #include <atalk/logger.h>
  41 #undef LOGGER_C
  42
  43 #define OPEN_LOGS_AS_UID 0
  44
  45 #define COUNT_ARRAY(array) (sizeof((array))/sizeof((array)[0]))
  46
  47 /* =========================================================================
  48     Config
  49    ========================================================================= */
  50
  51 /* Main log config container, must be globally visible */
  52 log_config_t log_config = {
  53   0,                              /* Initialized ? 0 = no */
  54   0,                              /* No filelogging setup yet */
  55   {0},                            /* processname */
  56   0,                              /* syslog opened ? */
  57   logfacility_daemon,             /* syslog facility to use */
  58   logoption_ndelay|logoption_pid, /* logging options for syslog */
  59   0                               /* log level for syslog */
  60 };
  61
  62 /* Default log config: log nothing to files.
  63       0:    not set individually
  64       NULL: Name of file
  65       -1:   logfiles fd
  66       0:   Log Level
  67       0:    Display options */
  68 #define DEFAULT_LOG_CONFIG {0, NULL, -1, 0, 0}
  69
  70 filelog_conf_t file_configs[logtype_end_of_list_marker] = {
  71     DEFAULT_LOG_CONFIG, /* logtype_default */
  72     DEFAULT_LOG_CONFIG, /* logtype_core */
  73     DEFAULT_LOG_CONFIG, /* logtype_logger */
  74     DEFAULT_LOG_CONFIG, /* logtype_cnid */
  75     DEFAULT_LOG_CONFIG, /* logtype_afpd */
  76     DEFAULT_LOG_CONFIG, /* logtype_atalkd */
  77     DEFAULT_LOG_CONFIG, /* logtype_papd */
  78     DEFAULT_LOG_CONFIG  /* logtype_uams */
  79 };
  80
  81 /* These are used by the LOG macro to store __FILE__ and __LINE__ */
  82 char *log_src_filename;
  83 int  log_src_linenumber;
  84
  85 /* Array to store text to list given a log type */
  86 static const char *arr_logtype_strings[] =  LOGTYPE_STRING_IDENTIFIERS;
  87 static const int num_logtype_strings = COUNT_ARRAY(arr_logtype_strings);
  88
  89 /* Array for charachters representing log severity in the log file */
  90 static const char arr_loglevel_chars[] = {'-','S', 'E', 'W', 'N', 'I', 'D'};
  91 static const int num_loglevel_chars = COUNT_ARRAY(arr_loglevel_chars);
  92
  93 static const char *arr_loglevel_strings[] = LOGLEVEL_STRING_IDENTIFIERS;
  94 static const int num_loglevel_strings = COUNT_ARRAY(arr_loglevel_strings);
  95
  96 /* =========================================================================
  97     Internal function definitions
  98    ========================================================================= */
  99
 100 /*
 101  * If filename == NULL its for syslog logging, otherwise its for file-logging.
 102  * "unsetuplog" calls with loglevel == NULL.
 103  * loglevel == NULL means:
 104  *    if logtype == default
 105  *       disable logging
 106  *    else
 107  *       set to default logging
 108  */
 109
 110   /* -[un]setuplog <logtype> <loglevel> [<filename>]*/
 111 static void setuplog_internal(const char *logtype, const char *loglevel, const char *filename)
 112 {
 113   int typenum, levelnum;
 114
 115   /* Parse logtype */
 116   for( typenum=0; typenum < num_logtype_strings; typenum++) {
 117       if (strcasecmp(logtype, arr_logtype_strings[typenum]) == 0)
 118           break;
 119   }
 120   if (typenum >= num_logtype_strings) {
 121       return;
 122   }
 123
 124   /* Parse loglevel */
 125   if (loglevel == NULL) {
 126       levelnum = 0;
 127   } else {
 128       for(levelnum=1; levelnum < num_loglevel_strings; levelnum++) {
 129           if (strcasecmp(loglevel, arr_loglevel_strings[levelnum]) == 0)
 130               break;
 131       }
 132       if (levelnum >= num_loglevel_strings) {
 133           return;
 134       }
 135   }
 136
 137   /* is this a syslog setup or a filelog setup ? */
 138   if (filename == NULL) {
 139       /* must be syslog */
 140       syslog_setup(levelnum, 0,
 141                    log_config.syslog_display_options,
 142                    log_config.facility);
 143   } else {
 144       /* this must be a filelog */
 145       log_setup(filename, levelnum, typenum);
 146   }
 147
 148   return;
 149 }
 150
 151 static void generate_message_details(char *message_details_buffer,
 152                               int message_details_buffer_length,
 153                               int display_options,
 154                               enum loglevels loglevel, enum logtypes logtype)
 155 {
 156     char   *ptr = message_details_buffer;
 157     int    templen;
 158     int    len = message_details_buffer_length;
 159     struct timeval tv;
 160
 161     *ptr = 0;
 162
 163     /* Print time */
 164     gettimeofday(&tv, NULL);
 165     strftime(ptr, len, "%b %d %H:%M:%S.", localtime(&tv.tv_sec));
 166     templen = strlen(ptr);
 167     len -= templen;
 168     ptr += templen;
 169
 170     templen = snprintf(ptr, len, "%06u ", (int)tv.tv_usec);
 171     len -= templen;
 172     ptr += templen;
 173
 174     /* Process name */
 175     strncpy(ptr, log_config.processname, len);
 176     templen = strlen(ptr);
 177     len -= templen;
 178     ptr += templen;
 179
 180     /* PID */
 181     pid_t pid = getpid();
 182     templen = snprintf(ptr, len, "[%d]", pid);
 183     len -= templen;
 184     ptr += templen;
 185
 186     /* Source info ? */
 187     if ( ! (display_options & logoption_nsrcinfo)) {
 188         char *basename = strrchr(log_src_filename, '/');
 189         if (basename)
 190             templen = snprintf(ptr, len, " {%s:%d}", basename + 1, log_src_linenumber);
 191         else
 192             templen = snprintf(ptr, len, " {%s:%d}", log_src_filename, log_src_linenumber);
 193         if (templen >= len)
 194             return;
 195         len -= templen;
 196         ptr += templen;
 197     }
 198
 199     /* Errorlevel */
 200     if (loglevel >= (num_loglevel_chars - 1))
 201         templen = snprintf(ptr, len,  " (D%d:", loglevel - 1);
 202     else
 203         templen = snprintf(ptr, len, " (%c:", arr_loglevel_chars[loglevel]);
 204     len -= templen;
 205     ptr += templen;
 206
 207     /* Errortype */
 208     if (logtype<num_logtype_strings) {
 209         templen = snprintf(ptr, len, "%s", arr_logtype_strings[logtype]);
 210         len -= templen;
 211         ptr += templen;
 212     }
 213
 214     strncat(ptr, "): ", len);
 215 }
 216
 217 int get_syslog_equivalent(enum loglevels loglevel)
 218 {
 219   switch (loglevel)
 220   {
 221     /* The question is we know how bad it is for us,
 222                     but how should that translate in the syslogs?  */
 223     case 1: /* severe */
 224       return LOG_ERR;
 225     case 2: /* error */
 226       return LOG_ERR;
 227     case 3: /* warning */
 228       return LOG_WARNING;
 229     case 4: /* note */
 230       return LOG_NOTICE;
 231     case 5: /* information */
 232       return LOG_INFO;
 233     default: /* debug */
 234       return LOG_DEBUG;
 235   }
 236 }
 237
 238 /* =========================================================================
 239     Global function definitions
 240    ========================================================================= */
 241
 242 void log_init(void)
 243 {
 244 #ifdef LOGFILEPATH
 245     log_setup(LOGFILEPATH, log_note, logtype_default);
 246 #else
 247     syslog_setup(log_note, 0,
 248                  log_config.syslog_display_options,
 249                  log_config.facility);
 250 #endif
 251 }
 252
 253 void log_setup(const char *filename, enum loglevels loglevel, enum logtypes logtype)
 254 {
 255     uid_t process_uid;
 256
 257     if (loglevel == 0) {
 258         /* Disable */
 259         if (file_configs[logtype].set) {
 260             if (file_configs[logtype].filename) {
 261                 free(file_configs[logtype].filename);
 262                 file_configs[logtype].filename = NULL;
 263             }
 264             close(file_configs[logtype].fd);
 265             file_configs[logtype].fd = -1;
 266             file_configs[logtype].level = 0;
 267             file_configs[logtype].set = 0;
 268
 269             /* if disabling default also set all "default using" levels to 0 */
 270             if (logtype == logtype_default) {
 271                 while (logtype != logtype_end_of_list_marker) {
 272                     if ( ! (file_configs[logtype].set))
 273                         file_configs[logtype].level = 0;
 274                     logtype++;
 275                 }
 276             }
 277         }
 278
 279         return;
 280     }
 281
 282     /* Safety check */
 283     if (NULL == filename)
 284         return;
 285
 286     /* Resetting existing config ? */
 287     if (file_configs[logtype].set && file_configs[logtype].filename) {
 288         free(file_configs[logtype].filename);
 289         file_configs[logtype].filename = NULL;
 290         close(file_configs[logtype].fd);
 291         file_configs[logtype].fd = -1;
 292         file_configs[logtype].level = 0;
 293         file_configs[logtype].set = 0;
 294     }
 295
 296     /* Set new values */
 297     file_configs[logtype].filename = strdup(filename);
 298     file_configs[logtype].level = loglevel;
 299
 300
 301     /* Open log file as OPEN_LOGS_AS_UID*/
 302     process_uid = geteuid();
 303     if (process_uid)
 304         seteuid(OPEN_LOGS_AS_UID);
 305     file_configs[logtype].fd = open( file_configs[logtype].filename,
 306                                      O_CREAT | O_WRONLY | O_APPEND,
 307                                      S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
 308     if (process_uid)
 309         seteuid(process_uid);
 310
 311     /* Check for error opening/creating logfile */
 312     if (-1 == file_configs[logtype].fd) {
 313         free(file_configs[logtype].filename);
 314         file_configs[logtype].filename = NULL;
 315         file_configs[logtype].level = -1;
 316         file_configs[logtype].set = 0;
 317         return;
 318     }
 319
 320     fcntl(file_configs[logtype].fd, F_SETFD, FD_CLOEXEC);
 321     file_configs[logtype].set = 1;
 322     log_config.filelogging = 1;
 323     log_config.inited = 1;
 324
 325     /* Here's how we make it possible to LOG to a logtype like "logtype_afpd" */
 326     /* which then uses the default logtype setup if it isn't setup itself: */
 327     /* we just copy the loglevel from default to all logtypes that are not setup. */
 328     /* In "make_log_entry" we then check for the logtypes if they arent setup */
 329     /* and use default then. We must provide accessible values for all logtypes */
 330     /* in order to make it easy and fast to check the loglevels in the LOG macro! */
 331
 332     if (logtype == logtype_default) {
 333         while (logtype != logtype_end_of_list_marker) {
 334             if ( ! (file_configs[logtype].set))
 335                 file_configs[logtype].level = loglevel;
 336             logtype++;
 337         }
 338         logtype = logtype_default;
 339     }
 340
 341     LOG(log_debug, logtype_logger, "Setup file logging: type: %s, level: %s, file: %s",
 342         arr_logtype_strings[logtype], arr_loglevel_strings[loglevel], file_configs[logtype].filename);
 343 }
 344
 345 /* logtype is ignored, it's just one for all */
 346 void syslog_setup(int loglevel, enum logtypes logtype _U_,
 347                   int display_options, int facility)
 348 {
 349     log_config.syslog_level = loglevel;
 350     log_config.syslog_display_options = display_options;
 351     log_config.facility = facility;
 352
 353     log_config.inited = 1;
 354
 355     LOG(log_note, logtype_logger, "Set syslog logging to level: %s",
 356         arr_loglevel_strings[loglevel]);
 357 }
 358
 359 void log_close()
 360 {
 361 }
 362
 363 /* This function sets up the processname */
 364 void set_processname(const char *processname)
 365 {
 366   strncpy(log_config.processname, processname, 15);
 367   log_config.processname[15] = 0;
 368 }
 369
 370 /* -------------------------------------------------------------------------
 371     make_log_entry has 1 main flaws:
 372       The message in its entirity, must fit into the tempbuffer.
 373       So it must be shorter than MAXLOGSIZE
 374    ------------------------------------------------------------------------- */
 375 void make_log_entry(enum loglevels loglevel, enum logtypes logtype,
 376                     char *message, ...)
 377 {
 378   /* fn is not reentrant but is used in signal handler
 379    * with LOGGER it's a little late source name and line number
 380    * are already changed. */
 381     static int inlog = 0;
 382     int fd, len;
 383     char temp_buffer[MAXLOGSIZE];
 384     char log_details_buffer[MAXLOGSIZE];
 385     va_list args;
 386     struct iovec iov[2];
 387
 388   if (inlog)
 389      return;
 390   inlog = 1;
 391
 392   /* Initialise the Messages */
 393   va_start(args, message);
 394   len = vsnprintf(temp_buffer, MAXLOGSIZE - 1, message, args);
 395   va_end(args);
 396
 397   /* Append \n */
 398   if (len >= MAXLOGSIZE)
 399       /* vsnprintf hit the buffer size*/
 400       temp_buffer[MAXLOGSIZE-2] = '\n';
 401   else {
 402       temp_buffer[len] = '\n';
 403       temp_buffer[len+1] = 0;
 404   }
 405
 406   generate_message_details(log_details_buffer, sizeof(log_details_buffer),
 407                            file_configs[logtype].set ?
 408                                file_configs[logtype].display_options :
 409                                file_configs[logtype_default].display_options,
 410                            loglevel, logtype);
 411
 412   /* Check if requested logtype is setup */
 413   if (file_configs[logtype].set)
 414       /* Yes */
 415       fd = file_configs[logtype].fd;
 416   else
 417       /* No: use default */
 418       fd = file_configs[logtype_default].fd;
 419
 420   /* If default wasnt setup its fd is -1 */
 421   if (fd >= 0) {
 422       iov[0].iov_base = log_details_buffer;
 423       iov[0].iov_len = strlen(log_details_buffer);
 424       iov[1].iov_base = temp_buffer;
 425       iov[1].iov_len = strlen(temp_buffer);
 426       writev( fd,  iov, 2);
 427   }
 428
 429   inlog = 0;
 430 }
 431
 432 /* Called by the LOG macro for syslog messages */
 433 void make_syslog_entry(enum loglevels loglevel, enum logtypes logtype, char *message, ...)
 434 {
 435     va_list args;
 436     char log_buffer[MAXLOGSIZE];
 437     /* fn is not reentrant but is used in signal handler
 438      * with LOGGER it's a little late source name and line number
 439      * are already changed.
 440      */
 441     static int inlog = 0;
 442
 443     if (inlog)
 444         return;
 445     inlog = 1;
 446
 447     if ( ! (log_config.syslog_opened) ) {
 448         openlog(log_config.processname, log_config.syslog_display_options,
 449                 log_config.facility);
 450         log_config.syslog_opened = 1;
 451     }
 452
 453     /* Initialise the Messages */
 454     va_start(args, message);
 455     vsnprintf(log_buffer, sizeof(log_buffer), message, args);
 456     va_end(args);
 457
 458     syslog(get_syslog_equivalent(loglevel), "%s", log_buffer);
 459
 460     inlog = 0;
 461 }
 462
 463 void setuplog(const char *logstr)
 464 {
 465     char *ptr, *ptrbak, *logtype, *loglevel, *filename;
 466     ptr = strdup(logstr);
 467     ptrbak = ptr;
 468
 469     /* logtype */
 470     logtype = ptr;
 471
 472     /* get loglevel */
 473     ptr = strpbrk(ptr, " \t");
 474     if (ptr) {
 475         *ptr++ = 0;
 476         while (*ptr && isspace(*ptr))
 477             ptr++;
 478         loglevel = ptr;
 479
 480         /* get filename */
 481         ptr = strpbrk(ptr, " \t");
 482         if (ptr) {
 483             *ptr++ = 0;
 484             while (*ptr && isspace(*ptr))
 485                 ptr++;
 486         }
 487         filename = ptr;
 488     }
 489
 490     /* finally call setuplog, filename can be NULL */
 491     setuplog_internal(logtype, loglevel, filename);
 492
 493     free(ptrbak);
 494 }
 495
 496 void unsetuplog(const char *logstr)
 497 {
 498       char *str, *logtype, *filename;
 499
 500       str = strdup(logstr);
 501
 502       /* logtype */
 503       logtype = str;
 504
 505       /* get filename, can be NULL */
 506       strtok(str, " \t");
 507       filename = strtok(NULL, " \t");
 508
 509       /* finally call setuplog, filename can be NULL */
 510       setuplog_internal(str, NULL, filename);
 511
 512       free(str);
 513 }