libatalk/util/logger.c

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