1 /*- 2 * ------+---------+---------+-------- + --------+---------+---------+---------* 3 * This file includes significant modifications done by: 4 * Copyright (c) 2003, 2004 - Garance Alistair Drosehn <gad@FreeBSD.org>. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * ------+---------+---------+-------- + --------+---------+---------+---------* 29 */ 30 31 /* 32 * This file contains changes from the Open Software Foundation. 33 */ 34 35 /* 36 * Copyright 1988, 1989 by the Massachusetts Institute of Technology 37 * 38 * Permission to use, copy, modify, and distribute this software and its 39 * documentation for any purpose and without fee is hereby granted, provided 40 * that the above copyright notice appear in all copies and that both that 41 * copyright notice and this permission notice appear in supporting 42 * documentation, and that the names of M.I.T. and the M.I.T. S.I.P.B. not be 43 * used in advertising or publicity pertaining to distribution of the 44 * software without specific, written prior permission. M.I.T. and the M.I.T. 45 * S.I.P.B. make no representations about the suitability of this software 46 * for any purpose. It is provided "as is" without express or implied 47 * warranty. 48 * 49 */ 50 51 /* 52 * newsyslog - roll over selected logs at the appropriate time, keeping the a 53 * specified number of backup files around. 54 */ 55 56 #include <sys/cdefs.h> 57 __FBSDID("$FreeBSD$"); 58 59 #define OSF 60 61 #include <sys/param.h> 62 #include <sys/queue.h> 63 #include <sys/stat.h> 64 #include <sys/wait.h> 65 66 #include <assert.h> 67 #include <ctype.h> 68 #include <err.h> 69 #include <errno.h> 70 #include <dirent.h> 71 #include <fcntl.h> 72 #include <fnmatch.h> 73 #include <glob.h> 74 #include <grp.h> 75 #include <paths.h> 76 #include <pwd.h> 77 #include <signal.h> 78 #include <stdio.h> 79 #include <libgen.h> 80 #include <stdlib.h> 81 #include <string.h> 82 #include <time.h> 83 #include <unistd.h> 84 85 #include "pathnames.h" 86 #include "extern.h" 87 88 /* 89 * Compression suffixes 90 */ 91 #ifndef COMPRESS_SUFFIX_GZ 92 #define COMPRESS_SUFFIX_GZ ".gz" 93 #endif 94 95 #ifndef COMPRESS_SUFFIX_BZ2 96 #define COMPRESS_SUFFIX_BZ2 ".bz2" 97 #endif 98 99 #ifndef COMPRESS_SUFFIX_XZ 100 #define COMPRESS_SUFFIX_XZ ".xz" 101 #endif 102 103 #define COMPRESS_SUFFIX_MAXLEN MAX(MAX(sizeof(COMPRESS_SUFFIX_GZ),sizeof(COMPRESS_SUFFIX_BZ2)),sizeof(COMPRESS_SUFFIX_XZ)) 104 105 /* 106 * Compression types 107 */ 108 #define COMPRESS_TYPES 4 /* Number of supported compression types */ 109 110 #define COMPRESS_NONE 0 111 #define COMPRESS_GZIP 1 112 #define COMPRESS_BZIP2 2 113 #define COMPRESS_XZ 3 114 115 /* 116 * Bit-values for the 'flags' parsed from a config-file entry. 117 */ 118 #define CE_BINARY 0x0008 /* Logfile is in binary, do not add status */ 119 /* messages to logfile(s) when rotating. */ 120 #define CE_NOSIGNAL 0x0010 /* There is no process to signal when */ 121 /* trimming this file. */ 122 #define CE_TRIMAT 0x0020 /* trim file at a specific time. */ 123 #define CE_GLOB 0x0040 /* name of the log is file name pattern. */ 124 #define CE_SIGNALGROUP 0x0080 /* Signal a process-group instead of a single */ 125 /* process when trimming this file. */ 126 #define CE_CREATE 0x0100 /* Create the log file if it does not exist. */ 127 #define CE_NODUMP 0x0200 /* Set 'nodump' on newly created log file. */ 128 #define CE_PID2CMD 0x0400 /* Replace PID file with a shell command.*/ 129 130 #define MIN_PID 5 /* Don't touch pids lower than this */ 131 #define MAX_PID 99999 /* was lower, see /usr/include/sys/proc.h */ 132 133 #define kbytes(size) (((size) + 1023) >> 10) 134 135 #define DEFAULT_MARKER "<default>" 136 #define DEBUG_MARKER "<debug>" 137 #define INCLUDE_MARKER "<include>" 138 #define DEFAULT_TIMEFNAME_FMT "%Y%m%dT%H%M%S" 139 140 #define MAX_OLDLOGS 65536 /* Default maximum number of old logfiles */ 141 142 struct compress_types { 143 const char *flag; /* Flag in configuration file */ 144 const char *suffix; /* Compression suffix */ 145 const char *path; /* Path to compression program */ 146 }; 147 148 static const struct compress_types compress_type[COMPRESS_TYPES] = { 149 { "", "", "" }, /* no compression */ 150 { "Z", COMPRESS_SUFFIX_GZ, _PATH_GZIP }, /* gzip compression */ 151 { "J", COMPRESS_SUFFIX_BZ2, _PATH_BZIP2 }, /* bzip2 compression */ 152 { "X", COMPRESS_SUFFIX_XZ, _PATH_XZ } /* xz compression */ 153 }; 154 155 struct conf_entry { 156 STAILQ_ENTRY(conf_entry) cf_nextp; 157 char *log; /* Name of the log */ 158 char *pid_cmd_file; /* PID or command file */ 159 char *r_reason; /* The reason this file is being rotated */ 160 int firstcreate; /* Creating log for the first time (-C). */ 161 int rotate; /* Non-zero if this file should be rotated */ 162 int fsize; /* size found for the log file */ 163 uid_t uid; /* Owner of log */ 164 gid_t gid; /* Group of log */ 165 int numlogs; /* Number of logs to keep */ 166 int trsize; /* Size cutoff to trigger trimming the log */ 167 int hours; /* Hours between log trimming */ 168 struct ptime_data *trim_at; /* Specific time to do trimming */ 169 unsigned int permissions; /* File permissions on the log */ 170 int flags; /* CE_BINARY */ 171 int compress; /* Compression */ 172 int sig; /* Signal to send */ 173 int def_cfg; /* Using the <default> rule for this file */ 174 }; 175 176 struct sigwork_entry { 177 SLIST_ENTRY(sigwork_entry) sw_nextp; 178 int sw_signum; /* the signal to send */ 179 int sw_pidok; /* true if pid value is valid */ 180 pid_t sw_pid; /* the process id from the PID file */ 181 const char *sw_pidtype; /* "daemon" or "process group" */ 182 int sw_runcmd; /* run command or send PID to signal */ 183 char sw_fname[1]; /* file the PID was read from or shell cmd */ 184 }; 185 186 struct zipwork_entry { 187 SLIST_ENTRY(zipwork_entry) zw_nextp; 188 const struct conf_entry *zw_conf; /* for chown/perm/flag info */ 189 const struct sigwork_entry *zw_swork; /* to know success of signal */ 190 int zw_fsize; /* size of the file to compress */ 191 char zw_fname[1]; /* the file to compress */ 192 }; 193 194 struct include_entry { 195 STAILQ_ENTRY(include_entry) inc_nextp; 196 const char *file; /* Name of file to process */ 197 }; 198 199 struct oldlog_entry { 200 char *fname; /* Filename of the log file */ 201 time_t t; /* Parsed timestamp of the logfile */ 202 }; 203 204 typedef enum { 205 FREE_ENT, KEEP_ENT 206 } fk_entry; 207 208 STAILQ_HEAD(cflist, conf_entry); 209 static SLIST_HEAD(swlisthead, sigwork_entry) swhead = 210 SLIST_HEAD_INITIALIZER(swhead); 211 static SLIST_HEAD(zwlisthead, zipwork_entry) zwhead = 212 SLIST_HEAD_INITIALIZER(zwhead); 213 STAILQ_HEAD(ilist, include_entry); 214 215 int dbg_at_times; /* -D Show details of 'trim_at' code */ 216 217 static int archtodir = 0; /* Archive old logfiles to other directory */ 218 static int createlogs; /* Create (non-GLOB) logfiles which do not */ 219 /* already exist. 1=='for entries with */ 220 /* C flag', 2=='for all entries'. */ 221 int verbose = 0; /* Print out what's going on */ 222 static int needroot = 1; /* Root privs are necessary */ 223 int noaction = 0; /* Don't do anything, just show it */ 224 static int norotate = 0; /* Don't rotate */ 225 static int nosignal; /* Do not send any signals */ 226 static int enforcepid = 0; /* If PID file does not exist or empty, do nothing */ 227 static int force = 0; /* Force the trim no matter what */ 228 static int rotatereq = 0; /* -R = Always rotate the file(s) as given */ 229 /* on the command (this also requires */ 230 /* that a list of files *are* given on */ 231 /* the run command). */ 232 static char *requestor; /* The name given on a -R request */ 233 static char *timefnamefmt = NULL;/* Use time based filenames instead of .0 */ 234 static char *archdirname; /* Directory path to old logfiles archive */ 235 static char *destdir = NULL; /* Directory to treat at root for logs */ 236 static const char *conf; /* Configuration file to use */ 237 238 struct ptime_data *dbg_timenow; /* A "timenow" value set via -D option */ 239 static struct ptime_data *timenow; /* The time to use for checking at-fields */ 240 241 #define DAYTIME_LEN 16 242 static char daytime[DAYTIME_LEN];/* The current time in human readable form, 243 * used for rotation-tracking messages. */ 244 static char hostname[MAXHOSTNAMELEN]; /* hostname */ 245 246 static const char *path_syslogpid = _PATH_SYSLOGPID; 247 248 static struct cflist *get_worklist(char **files); 249 static void parse_file(FILE *cf, struct cflist *work_p, struct cflist *glob_p, 250 struct conf_entry *defconf_p, struct ilist *inclist); 251 static void add_to_queue(const char *fname, struct ilist *inclist); 252 static char *sob(char *p); 253 static char *son(char *p); 254 static int isnumberstr(const char *); 255 static int isglobstr(const char *); 256 static char *missing_field(char *p, char *errline); 257 static void change_attrs(const char *, const struct conf_entry *); 258 static const char *get_logfile_suffix(const char *logfile); 259 static fk_entry do_entry(struct conf_entry *); 260 static fk_entry do_rotate(const struct conf_entry *); 261 static void do_sigwork(struct sigwork_entry *); 262 static void do_zipwork(struct zipwork_entry *); 263 static struct sigwork_entry * 264 save_sigwork(const struct conf_entry *); 265 static struct zipwork_entry * 266 save_zipwork(const struct conf_entry *, const struct 267 sigwork_entry *, int, const char *); 268 static void set_swpid(struct sigwork_entry *, const struct conf_entry *); 269 static int sizefile(const char *); 270 static void expand_globs(struct cflist *work_p, struct cflist *glob_p); 271 static void free_clist(struct cflist *list); 272 static void free_entry(struct conf_entry *ent); 273 static struct conf_entry *init_entry(const char *fname, 274 struct conf_entry *src_entry); 275 static void parse_args(int argc, char **argv); 276 static int parse_doption(const char *doption); 277 static void usage(void); 278 static int log_trim(const char *logname, const struct conf_entry *log_ent); 279 static int age_old_log(const char *file); 280 static void savelog(char *from, char *to); 281 static void createdir(const struct conf_entry *ent, char *dirpart); 282 static void createlog(const struct conf_entry *ent); 283 284 /* 285 * All the following take a parameter of 'int', but expect values in the 286 * range of unsigned char. Define wrappers which take values of type 'char', 287 * whether signed or unsigned, and ensure they end up in the right range. 288 */ 289 #define isdigitch(Anychar) isdigit((u_char)(Anychar)) 290 #define isprintch(Anychar) isprint((u_char)(Anychar)) 291 #define isspacech(Anychar) isspace((u_char)(Anychar)) 292 #define tolowerch(Anychar) tolower((u_char)(Anychar)) 293 294 int 295 main(int argc, char **argv) 296 { 297 struct cflist *worklist; 298 struct conf_entry *p; 299 struct sigwork_entry *stmp; 300 struct zipwork_entry *ztmp; 301 302 SLIST_INIT(&swhead); 303 SLIST_INIT(&zwhead); 304 305 parse_args(argc, argv); 306 argc -= optind; 307 argv += optind; 308 309 if (needroot && getuid() && geteuid()) 310 errx(1, "must have root privs"); 311 worklist = get_worklist(argv); 312 313 /* 314 * Rotate all the files which need to be rotated. Note that 315 * some users have *hundreds* of entries in newsyslog.conf! 316 */ 317 while (!STAILQ_EMPTY(worklist)) { 318 p = STAILQ_FIRST(worklist); 319 STAILQ_REMOVE_HEAD(worklist, cf_nextp); 320 if (do_entry(p) == FREE_ENT) 321 free_entry(p); 322 } 323 324 /* 325 * Send signals to any processes which need a signal to tell 326 * them to close and re-open the log file(s) we have rotated. 327 * Note that zipwork_entries include pointers to these 328 * sigwork_entry's, so we can not free the entries here. 329 */ 330 if (!SLIST_EMPTY(&swhead)) { 331 if (noaction || verbose) 332 printf("Signal all daemon process(es)...\n"); 333 SLIST_FOREACH(stmp, &swhead, sw_nextp) 334 do_sigwork(stmp); 335 if (noaction) 336 printf("\tsleep 10\n"); 337 else { 338 if (verbose) 339 printf("Pause 10 seconds to allow daemon(s)" 340 " to close log file(s)\n"); 341 sleep(10); 342 } 343 } 344 /* 345 * Compress all files that we're expected to compress, now 346 * that all processes should have closed the files which 347 * have been rotated. 348 */ 349 if (!SLIST_EMPTY(&zwhead)) { 350 if (noaction || verbose) 351 printf("Compress all rotated log file(s)...\n"); 352 while (!SLIST_EMPTY(&zwhead)) { 353 ztmp = SLIST_FIRST(&zwhead); 354 do_zipwork(ztmp); 355 SLIST_REMOVE_HEAD(&zwhead, zw_nextp); 356 free(ztmp); 357 } 358 } 359 /* Now free all the sigwork entries. */ 360 while (!SLIST_EMPTY(&swhead)) { 361 stmp = SLIST_FIRST(&swhead); 362 SLIST_REMOVE_HEAD(&swhead, sw_nextp); 363 free(stmp); 364 } 365 366 while (wait(NULL) > 0 || errno == EINTR) 367 ; 368 return (0); 369 } 370 371 static struct conf_entry * 372 init_entry(const char *fname, struct conf_entry *src_entry) 373 { 374 struct conf_entry *tempwork; 375 376 if (verbose > 4) 377 printf("\t--> [creating entry for %s]\n", fname); 378 379 tempwork = malloc(sizeof(struct conf_entry)); 380 if (tempwork == NULL) 381 err(1, "malloc of conf_entry for %s", fname); 382 383 if (destdir == NULL || fname[0] != '/') 384 tempwork->log = strdup(fname); 385 else 386 asprintf(&tempwork->log, "%s%s", destdir, fname); 387 if (tempwork->log == NULL) 388 err(1, "strdup for %s", fname); 389 390 if (src_entry != NULL) { 391 tempwork->pid_cmd_file = NULL; 392 if (src_entry->pid_cmd_file) 393 tempwork->pid_cmd_file = strdup(src_entry->pid_cmd_file); 394 tempwork->r_reason = NULL; 395 tempwork->firstcreate = 0; 396 tempwork->rotate = 0; 397 tempwork->fsize = -1; 398 tempwork->uid = src_entry->uid; 399 tempwork->gid = src_entry->gid; 400 tempwork->numlogs = src_entry->numlogs; 401 tempwork->trsize = src_entry->trsize; 402 tempwork->hours = src_entry->hours; 403 tempwork->trim_at = NULL; 404 if (src_entry->trim_at != NULL) 405 tempwork->trim_at = ptime_init(src_entry->trim_at); 406 tempwork->permissions = src_entry->permissions; 407 tempwork->flags = src_entry->flags; 408 tempwork->compress = src_entry->compress; 409 tempwork->sig = src_entry->sig; 410 tempwork->def_cfg = src_entry->def_cfg; 411 } else { 412 /* Initialize as a "do-nothing" entry */ 413 tempwork->pid_cmd_file = NULL; 414 tempwork->r_reason = NULL; 415 tempwork->firstcreate = 0; 416 tempwork->rotate = 0; 417 tempwork->fsize = -1; 418 tempwork->uid = (uid_t)-1; 419 tempwork->gid = (gid_t)-1; 420 tempwork->numlogs = 1; 421 tempwork->trsize = -1; 422 tempwork->hours = -1; 423 tempwork->trim_at = NULL; 424 tempwork->permissions = 0; 425 tempwork->flags = 0; 426 tempwork->compress = COMPRESS_NONE; 427 tempwork->sig = SIGHUP; 428 tempwork->def_cfg = 0; 429 } 430 431 return (tempwork); 432 } 433 434 static void 435 free_entry(struct conf_entry *ent) 436 { 437 438 if (ent == NULL) 439 return; 440 441 if (ent->log != NULL) { 442 if (verbose > 4) 443 printf("\t--> [freeing entry for %s]\n", ent->log); 444 free(ent->log); 445 ent->log = NULL; 446 } 447 448 if (ent->pid_cmd_file != NULL) { 449 free(ent->pid_cmd_file); 450 ent->pid_cmd_file = NULL; 451 } 452 453 if (ent->r_reason != NULL) { 454 free(ent->r_reason); 455 ent->r_reason = NULL; 456 } 457 458 if (ent->trim_at != NULL) { 459 ptime_free(ent->trim_at); 460 ent->trim_at = NULL; 461 } 462 463 free(ent); 464 } 465 466 static void 467 free_clist(struct cflist *list) 468 { 469 struct conf_entry *ent; 470 471 while (!STAILQ_EMPTY(list)) { 472 ent = STAILQ_FIRST(list); 473 STAILQ_REMOVE_HEAD(list, cf_nextp); 474 free_entry(ent); 475 } 476 477 free(list); 478 list = NULL; 479 } 480 481 static fk_entry 482 do_entry(struct conf_entry * ent) 483 { 484 #define REASON_MAX 80 485 int modtime; 486 fk_entry free_or_keep; 487 double diffsecs; 488 char temp_reason[REASON_MAX]; 489 int oversized; 490 491 free_or_keep = FREE_ENT; 492 if (verbose) 493 printf("%s <%d%s>: ", ent->log, ent->numlogs, 494 compress_type[ent->compress].flag); 495 ent->fsize = sizefile(ent->log); 496 oversized = ((ent->trsize > 0) && (ent->fsize >= ent->trsize)); 497 modtime = age_old_log(ent->log); 498 ent->rotate = 0; 499 ent->firstcreate = 0; 500 if (ent->fsize < 0) { 501 /* 502 * If either the C flag or the -C option was specified, 503 * and if we won't be creating the file, then have the 504 * verbose message include a hint as to why the file 505 * will not be created. 506 */ 507 temp_reason[0] = '\0'; 508 if (createlogs > 1) 509 ent->firstcreate = 1; 510 else if ((ent->flags & CE_CREATE) && createlogs) 511 ent->firstcreate = 1; 512 else if (ent->flags & CE_CREATE) 513 strlcpy(temp_reason, " (no -C option)", REASON_MAX); 514 else if (createlogs) 515 strlcpy(temp_reason, " (no C flag)", REASON_MAX); 516 517 if (ent->firstcreate) { 518 if (verbose) 519 printf("does not exist -> will create.\n"); 520 createlog(ent); 521 } else if (verbose) { 522 printf("does not exist, skipped%s.\n", temp_reason); 523 } 524 } else { 525 if (ent->flags & CE_TRIMAT && !force && !rotatereq && 526 !oversized) { 527 diffsecs = ptimeget_diff(timenow, ent->trim_at); 528 if (diffsecs < 0.0) { 529 /* trim_at is some time in the future. */ 530 if (verbose) { 531 ptime_adjust4dst(ent->trim_at, 532 timenow); 533 printf("--> will trim at %s", 534 ptimeget_ctime(ent->trim_at)); 535 } 536 return (free_or_keep); 537 } else if (diffsecs >= 3600.0) { 538 /* 539 * trim_at is more than an hour in the past, 540 * so find the next valid trim_at time, and 541 * tell the user what that will be. 542 */ 543 if (verbose && dbg_at_times) 544 printf("\n\t--> prev trim at %s\t", 545 ptimeget_ctime(ent->trim_at)); 546 if (verbose) { 547 ptimeset_nxtime(ent->trim_at); 548 printf("--> will trim at %s", 549 ptimeget_ctime(ent->trim_at)); 550 } 551 return (free_or_keep); 552 } else if (verbose && noaction && dbg_at_times) { 553 /* 554 * If we are just debugging at-times, then 555 * a detailed message is helpful. Also 556 * skip "doing" any commands, since they 557 * would all be turned off by no-action. 558 */ 559 printf("\n\t--> timematch at %s", 560 ptimeget_ctime(ent->trim_at)); 561 return (free_or_keep); 562 } else if (verbose && ent->hours <= 0) { 563 printf("--> time is up\n"); 564 } 565 } 566 if (verbose && (ent->trsize > 0)) 567 printf("size (Kb): %d [%d] ", ent->fsize, ent->trsize); 568 if (verbose && (ent->hours > 0)) 569 printf(" age (hr): %d [%d] ", modtime, ent->hours); 570 571 /* 572 * Figure out if this logfile needs to be rotated. 573 */ 574 temp_reason[0] = '\0'; 575 if (rotatereq) { 576 ent->rotate = 1; 577 snprintf(temp_reason, REASON_MAX, " due to -R from %s", 578 requestor); 579 } else if (force) { 580 ent->rotate = 1; 581 snprintf(temp_reason, REASON_MAX, " due to -F request"); 582 } else if (oversized) { 583 ent->rotate = 1; 584 snprintf(temp_reason, REASON_MAX, " due to size>%dK", 585 ent->trsize); 586 } else if (ent->hours <= 0 && (ent->flags & CE_TRIMAT)) { 587 ent->rotate = 1; 588 } else if ((ent->hours > 0) && ((modtime >= ent->hours) || 589 (modtime < 0))) { 590 ent->rotate = 1; 591 } 592 593 /* 594 * If the file needs to be rotated, then rotate it. 595 */ 596 if (ent->rotate && !norotate) { 597 if (temp_reason[0] != '\0') 598 ent->r_reason = strdup(temp_reason); 599 if (verbose) 600 printf("--> trimming log....\n"); 601 if (noaction && !verbose) 602 printf("%s <%d%s>: trimming\n", ent->log, 603 ent->numlogs, 604 compress_type[ent->compress].flag); 605 free_or_keep = do_rotate(ent); 606 } else { 607 if (verbose) 608 printf("--> skipping\n"); 609 } 610 } 611 return (free_or_keep); 612 #undef REASON_MAX 613 } 614 615 static void 616 parse_args(int argc, char **argv) 617 { 618 int ch; 619 char *p; 620 621 timenow = ptime_init(NULL); 622 ptimeset_time(timenow, time(NULL)); 623 strlcpy(daytime, ptimeget_ctime(timenow) + 4, DAYTIME_LEN); 624 625 /* Let's get our hostname */ 626 (void)gethostname(hostname, sizeof(hostname)); 627 628 /* Truncate domain */ 629 if ((p = strchr(hostname, '.')) != NULL) 630 *p = '\0'; 631 632 /* Parse command line options. */ 633 while ((ch = getopt(argc, argv, "a:d:f:nrst:vCD:FNPR:S:")) != -1) 634 switch (ch) { 635 case 'a': 636 archtodir++; 637 archdirname = optarg; 638 break; 639 case 'd': 640 destdir = optarg; 641 break; 642 case 'f': 643 conf = optarg; 644 break; 645 case 'n': 646 noaction++; 647 /* FALLTHROUGH */ 648 case 'r': 649 needroot = 0; 650 break; 651 case 's': 652 nosignal = 1; 653 break; 654 case 't': 655 if (optarg[0] == '\0' || 656 strcmp(optarg, "DEFAULT") == 0) 657 timefnamefmt = strdup(DEFAULT_TIMEFNAME_FMT); 658 else 659 timefnamefmt = strdup(optarg); 660 break; 661 case 'v': 662 verbose++; 663 break; 664 case 'C': 665 /* Useful for things like rc.diskless... */ 666 createlogs++; 667 break; 668 case 'D': 669 /* 670 * Set some debugging option. The specific option 671 * depends on the value of optarg. These options 672 * may come and go without notice or documentation. 673 */ 674 if (parse_doption(optarg)) 675 break; 676 usage(); 677 /* NOTREACHED */ 678 case 'F': 679 force++; 680 break; 681 case 'N': 682 norotate++; 683 break; 684 case 'P': 685 enforcepid++; 686 break; 687 case 'R': 688 rotatereq++; 689 requestor = strdup(optarg); 690 break; 691 case 'S': 692 path_syslogpid = optarg; 693 break; 694 case 'm': /* Used by OpenBSD for "monitor mode" */ 695 default: 696 usage(); 697 /* NOTREACHED */ 698 } 699 700 if (force && norotate) { 701 warnx("Only one of -F and -N may be specified."); 702 usage(); 703 /* NOTREACHED */ 704 } 705 706 if (rotatereq) { 707 if (optind == argc) { 708 warnx("At least one filename must be given when -R is specified."); 709 usage(); 710 /* NOTREACHED */ 711 } 712 /* Make sure "requestor" value is safe for a syslog message. */ 713 for (p = requestor; *p != '\0'; p++) { 714 if (!isprintch(*p) && (*p != '\t')) 715 *p = '.'; 716 } 717 } 718 719 if (dbg_timenow) { 720 /* 721 * Note that the 'daytime' variable is not changed. 722 * That is only used in messages that track when a 723 * logfile is rotated, and if a file *is* rotated, 724 * then it will still rotated at the "real now" time. 725 */ 726 ptime_free(timenow); 727 timenow = dbg_timenow; 728 fprintf(stderr, "Debug: Running as if TimeNow is %s", 729 ptimeget_ctime(dbg_timenow)); 730 } 731 732 } 733 734 /* 735 * These debugging options are mainly meant for developer use, such 736 * as writing regression-tests. They would not be needed by users 737 * during normal operation of newsyslog... 738 */ 739 static int 740 parse_doption(const char *doption) 741 { 742 const char TN[] = "TN="; 743 int res; 744 745 if (strncmp(doption, TN, sizeof(TN) - 1) == 0) { 746 /* 747 * The "TimeNow" debugging option. This might be off 748 * by an hour when crossing a timezone change. 749 */ 750 dbg_timenow = ptime_init(NULL); 751 res = ptime_relparse(dbg_timenow, PTM_PARSE_ISO8601, 752 time(NULL), doption + sizeof(TN) - 1); 753 if (res == -2) { 754 warnx("Non-existent time specified on -D %s", doption); 755 return (0); /* failure */ 756 } else if (res < 0) { 757 warnx("Malformed time given on -D %s", doption); 758 return (0); /* failure */ 759 } 760 return (1); /* successfully parsed */ 761 762 } 763 764 if (strcmp(doption, "ats") == 0) { 765 dbg_at_times++; 766 return (1); /* successfully parsed */ 767 } 768 769 /* XXX - This check could probably be dropped. */ 770 if ((strcmp(doption, "neworder") == 0) || (strcmp(doption, "oldorder") 771 == 0)) { 772 warnx("NOTE: newsyslog always uses 'neworder'."); 773 return (1); /* successfully parsed */ 774 } 775 776 warnx("Unknown -D (debug) option: '%s'", doption); 777 return (0); /* failure */ 778 } 779 780 static void 781 usage(void) 782 { 783 784 fprintf(stderr, 785 "usage: newsyslog [-CFNPnrsv] [-a directory] [-d directory] [-f config_file]\n" 786 " [-S pidfile] [-t timefmt] [[-R tagname] file ...]\n"); 787 exit(1); 788 } 789 790 /* 791 * Parse a configuration file and return a linked list of all the logs 792 * which should be processed. 793 */ 794 static struct cflist * 795 get_worklist(char **files) 796 { 797 FILE *f; 798 char **given; 799 struct cflist *cmdlist, *filelist, *globlist; 800 struct conf_entry *defconf, *dupent, *ent; 801 struct ilist inclist; 802 struct include_entry *inc; 803 int gmatch, fnres; 804 805 defconf = NULL; 806 STAILQ_INIT(&inclist); 807 808 filelist = malloc(sizeof(struct cflist)); 809 if (filelist == NULL) 810 err(1, "malloc of filelist"); 811 STAILQ_INIT(filelist); 812 globlist = malloc(sizeof(struct cflist)); 813 if (globlist == NULL) 814 err(1, "malloc of globlist"); 815 STAILQ_INIT(globlist); 816 817 inc = malloc(sizeof(struct include_entry)); 818 if (inc == NULL) 819 err(1, "malloc of inc"); 820 inc->file = conf; 821 if (inc->file == NULL) 822 inc->file = _PATH_CONF; 823 STAILQ_INSERT_TAIL(&inclist, inc, inc_nextp); 824 825 STAILQ_FOREACH(inc, &inclist, inc_nextp) { 826 if (strcmp(inc->file, "-") != 0) 827 f = fopen(inc->file, "r"); 828 else { 829 f = stdin; 830 inc->file = "<stdin>"; 831 } 832 if (!f) 833 err(1, "%s", inc->file); 834 835 if (verbose) 836 printf("Processing %s\n", inc->file); 837 parse_file(f, filelist, globlist, defconf, &inclist); 838 (void) fclose(f); 839 } 840 841 /* 842 * All config-file information has been read in and turned into 843 * a filelist and a globlist. If there were no specific files 844 * given on the run command, then the only thing left to do is to 845 * call a routine which finds all files matched by the globlist 846 * and adds them to the filelist. Then return the worklist. 847 */ 848 if (*files == NULL) { 849 expand_globs(filelist, globlist); 850 free_clist(globlist); 851 if (defconf != NULL) 852 free_entry(defconf); 853 return (filelist); 854 /* NOTREACHED */ 855 } 856 857 /* 858 * If newsyslog was given a specific list of files to process, 859 * it may be that some of those files were not listed in any 860 * config file. Those unlisted files should get the default 861 * rotation action. First, create the default-rotation action 862 * if none was found in a system config file. 863 */ 864 if (defconf == NULL) { 865 defconf = init_entry(DEFAULT_MARKER, NULL); 866 defconf->numlogs = 3; 867 defconf->trsize = 50; 868 defconf->permissions = S_IRUSR|S_IWUSR; 869 } 870 871 /* 872 * If newsyslog was run with a list of specific filenames, 873 * then create a new worklist which has only those files in 874 * it, picking up the rotation-rules for those files from 875 * the original filelist. 876 * 877 * XXX - Note that this will copy multiple rules for a single 878 * logfile, if multiple entries are an exact match for 879 * that file. That matches the historic behavior, but do 880 * we want to continue to allow it? If so, it should 881 * probably be handled more intelligently. 882 */ 883 cmdlist = malloc(sizeof(struct cflist)); 884 if (cmdlist == NULL) 885 err(1, "malloc of cmdlist"); 886 STAILQ_INIT(cmdlist); 887 888 for (given = files; *given; ++given) { 889 /* 890 * First try to find exact-matches for this given file. 891 */ 892 gmatch = 0; 893 STAILQ_FOREACH(ent, filelist, cf_nextp) { 894 if (strcmp(ent->log, *given) == 0) { 895 gmatch++; 896 dupent = init_entry(*given, ent); 897 STAILQ_INSERT_TAIL(cmdlist, dupent, cf_nextp); 898 } 899 } 900 if (gmatch) { 901 if (verbose > 2) 902 printf("\t+ Matched entry %s\n", *given); 903 continue; 904 } 905 906 /* 907 * There was no exact-match for this given file, so look 908 * for a "glob" entry which does match. 909 */ 910 gmatch = 0; 911 if (verbose > 2 && globlist != NULL) 912 printf("\t+ Checking globs for %s\n", *given); 913 STAILQ_FOREACH(ent, globlist, cf_nextp) { 914 fnres = fnmatch(ent->log, *given, FNM_PATHNAME); 915 if (verbose > 2) 916 printf("\t+ = %d for pattern %s\n", fnres, 917 ent->log); 918 if (fnres == 0) { 919 gmatch++; 920 dupent = init_entry(*given, ent); 921 /* This new entry is not a glob! */ 922 dupent->flags &= ~CE_GLOB; 923 STAILQ_INSERT_TAIL(cmdlist, dupent, cf_nextp); 924 /* Only allow a match to one glob-entry */ 925 break; 926 } 927 } 928 if (gmatch) { 929 if (verbose > 2) 930 printf("\t+ Matched %s via %s\n", *given, 931 ent->log); 932 continue; 933 } 934 935 /* 936 * This given file was not found in any config file, so 937 * add a worklist item based on the default entry. 938 */ 939 if (verbose > 2) 940 printf("\t+ No entry matched %s (will use %s)\n", 941 *given, DEFAULT_MARKER); 942 dupent = init_entry(*given, defconf); 943 /* Mark that it was *not* found in a config file */ 944 dupent->def_cfg = 1; 945 STAILQ_INSERT_TAIL(cmdlist, dupent, cf_nextp); 946 } 947 948 /* 949 * Free all the entries in the original work list, the list of 950 * glob entries, and the default entry. 951 */ 952 free_clist(filelist); 953 free_clist(globlist); 954 free_entry(defconf); 955 956 /* And finally, return a worklist which matches the given files. */ 957 return (cmdlist); 958 } 959 960 /* 961 * Expand the list of entries with filename patterns, and add all files 962 * which match those glob-entries onto the worklist. 963 */ 964 static void 965 expand_globs(struct cflist *work_p, struct cflist *glob_p) 966 { 967 int gmatch, gres; 968 size_t i; 969 char *mfname; 970 struct conf_entry *dupent, *ent, *globent; 971 glob_t pglob; 972 struct stat st_fm; 973 974 /* 975 * The worklist contains all fully-specified (non-GLOB) names. 976 * 977 * Now expand the list of filename-pattern (GLOB) entries into 978 * a second list, which (by definition) will only match files 979 * that already exist. Do not add a glob-related entry for any 980 * file which already exists in the fully-specified list. 981 */ 982 STAILQ_FOREACH(globent, glob_p, cf_nextp) { 983 gres = glob(globent->log, GLOB_NOCHECK, NULL, &pglob); 984 if (gres != 0) { 985 warn("cannot expand pattern (%d): %s", gres, 986 globent->log); 987 continue; 988 } 989 990 if (verbose > 2) 991 printf("\t+ Expanding pattern %s\n", globent->log); 992 for (i = 0; i < pglob.gl_matchc; i++) { 993 mfname = pglob.gl_pathv[i]; 994 995 /* See if this file already has a specific entry. */ 996 gmatch = 0; 997 STAILQ_FOREACH(ent, work_p, cf_nextp) { 998 if (strcmp(mfname, ent->log) == 0) { 999 gmatch++; 1000 break; 1001 } 1002 } 1003 if (gmatch) 1004 continue; 1005 1006 /* Make sure the named matched is a file. */ 1007 gres = lstat(mfname, &st_fm); 1008 if (gres != 0) { 1009 /* Error on a file that glob() matched?!? */ 1010 warn("Skipping %s - lstat() error", mfname); 1011 continue; 1012 } 1013 if (!S_ISREG(st_fm.st_mode)) { 1014 /* We only rotate files! */ 1015 if (verbose > 2) 1016 printf("\t+ . skipping %s (!file)\n", 1017 mfname); 1018 continue; 1019 } 1020 1021 if (verbose > 2) 1022 printf("\t+ . add file %s\n", mfname); 1023 dupent = init_entry(mfname, globent); 1024 /* This new entry is not a glob! */ 1025 dupent->flags &= ~CE_GLOB; 1026 1027 /* Add to the worklist. */ 1028 STAILQ_INSERT_TAIL(work_p, dupent, cf_nextp); 1029 } 1030 globfree(&pglob); 1031 if (verbose > 2) 1032 printf("\t+ Done with pattern %s\n", globent->log); 1033 } 1034 } 1035 1036 /* 1037 * Parse a configuration file and update a linked list of all the logs to 1038 * process. 1039 */ 1040 static void 1041 parse_file(FILE *cf, struct cflist *work_p, struct cflist *glob_p, 1042 struct conf_entry *defconf_p, struct ilist *inclist) 1043 { 1044 char line[BUFSIZ], *parse, *q; 1045 char *cp, *errline, *group; 1046 struct conf_entry *working; 1047 struct passwd *pwd; 1048 struct group *grp; 1049 glob_t pglob; 1050 int eol, ptm_opts, res, special; 1051 size_t i; 1052 1053 errline = NULL; 1054 while (fgets(line, BUFSIZ, cf)) { 1055 if ((line[0] == '\n') || (line[0] == '#') || 1056 (strlen(line) == 0)) 1057 continue; 1058 if (errline != NULL) 1059 free(errline); 1060 errline = strdup(line); 1061 for (cp = line + 1; *cp != '\0'; cp++) { 1062 if (*cp != '#') 1063 continue; 1064 if (*(cp - 1) == '\\') { 1065 strcpy(cp - 1, cp); 1066 cp--; 1067 continue; 1068 } 1069 *cp = '\0'; 1070 break; 1071 } 1072 1073 q = parse = missing_field(sob(line), errline); 1074 parse = son(line); 1075 if (!*parse) 1076 errx(1, "malformed line (missing fields):\n%s", 1077 errline); 1078 *parse = '\0'; 1079 1080 /* 1081 * Allow people to set debug options via the config file. 1082 * (NOTE: debug options are undocumented, and may disappear 1083 * at any time, etc). 1084 */ 1085 if (strcasecmp(DEBUG_MARKER, q) == 0) { 1086 q = parse = missing_field(sob(++parse), errline); 1087 parse = son(parse); 1088 if (!*parse) 1089 warnx("debug line specifies no option:\n%s", 1090 errline); 1091 else { 1092 *parse = '\0'; 1093 parse_doption(q); 1094 } 1095 continue; 1096 } else if (strcasecmp(INCLUDE_MARKER, q) == 0) { 1097 if (verbose) 1098 printf("Found: %s", errline); 1099 q = parse = missing_field(sob(++parse), errline); 1100 parse = son(parse); 1101 if (!*parse) { 1102 warnx("include line missing argument:\n%s", 1103 errline); 1104 continue; 1105 } 1106 1107 *parse = '\0'; 1108 1109 if (isglobstr(q)) { 1110 res = glob(q, GLOB_NOCHECK, NULL, &pglob); 1111 if (res != 0) { 1112 warn("cannot expand pattern (%d): %s", 1113 res, q); 1114 continue; 1115 } 1116 1117 if (verbose > 2) 1118 printf("\t+ Expanding pattern %s\n", q); 1119 1120 for (i = 0; i < pglob.gl_matchc; i++) 1121 add_to_queue(pglob.gl_pathv[i], 1122 inclist); 1123 globfree(&pglob); 1124 } else 1125 add_to_queue(q, inclist); 1126 continue; 1127 } 1128 1129 special = 0; 1130 working = init_entry(q, NULL); 1131 if (strcasecmp(DEFAULT_MARKER, q) == 0) { 1132 special = 1; 1133 if (defconf_p != NULL) { 1134 warnx("Ignoring duplicate entry for %s!", q); 1135 free_entry(working); 1136 continue; 1137 } 1138 defconf_p = working; 1139 } 1140 1141 q = parse = missing_field(sob(++parse), errline); 1142 parse = son(parse); 1143 if (!*parse) 1144 errx(1, "malformed line (missing fields):\n%s", 1145 errline); 1146 *parse = '\0'; 1147 if ((group = strchr(q, ':')) != NULL || 1148 (group = strrchr(q, '.')) != NULL) { 1149 *group++ = '\0'; 1150 if (*q) { 1151 if (!(isnumberstr(q))) { 1152 if ((pwd = getpwnam(q)) == NULL) 1153 errx(1, 1154 "error in config file; unknown user:\n%s", 1155 errline); 1156 working->uid = pwd->pw_uid; 1157 } else 1158 working->uid = atoi(q); 1159 } else 1160 working->uid = (uid_t)-1; 1161 1162 q = group; 1163 if (*q) { 1164 if (!(isnumberstr(q))) { 1165 if ((grp = getgrnam(q)) == NULL) 1166 errx(1, 1167 "error in config file; unknown group:\n%s", 1168 errline); 1169 working->gid = grp->gr_gid; 1170 } else 1171 working->gid = atoi(q); 1172 } else 1173 working->gid = (gid_t)-1; 1174 1175 q = parse = missing_field(sob(++parse), errline); 1176 parse = son(parse); 1177 if (!*parse) 1178 errx(1, "malformed line (missing fields):\n%s", 1179 errline); 1180 *parse = '\0'; 1181 } else { 1182 working->uid = (uid_t)-1; 1183 working->gid = (gid_t)-1; 1184 } 1185 1186 if (!sscanf(q, "%o", &working->permissions)) 1187 errx(1, "error in config file; bad permissions:\n%s", 1188 errline); 1189 1190 q = parse = missing_field(sob(++parse), errline); 1191 parse = son(parse); 1192 if (!*parse) 1193 errx(1, "malformed line (missing fields):\n%s", 1194 errline); 1195 *parse = '\0'; 1196 if (!sscanf(q, "%d", &working->numlogs) || working->numlogs < 0) 1197 errx(1, "error in config file; bad value for count of logs to save:\n%s", 1198 errline); 1199 1200 q = parse = missing_field(sob(++parse), errline); 1201 parse = son(parse); 1202 if (!*parse) 1203 errx(1, "malformed line (missing fields):\n%s", 1204 errline); 1205 *parse = '\0'; 1206 if (isdigitch(*q)) 1207 working->trsize = atoi(q); 1208 else if (strcmp(q, "*") == 0) 1209 working->trsize = -1; 1210 else { 1211 warnx("Invalid value of '%s' for 'size' in line:\n%s", 1212 q, errline); 1213 working->trsize = -1; 1214 } 1215 1216 working->flags = 0; 1217 working->compress = COMPRESS_NONE; 1218 q = parse = missing_field(sob(++parse), errline); 1219 parse = son(parse); 1220 eol = !*parse; 1221 *parse = '\0'; 1222 { 1223 char *ep; 1224 u_long ul; 1225 1226 ul = strtoul(q, &ep, 10); 1227 if (ep == q) 1228 working->hours = 0; 1229 else if (*ep == '*') 1230 working->hours = -1; 1231 else if (ul > INT_MAX) 1232 errx(1, "interval is too large:\n%s", errline); 1233 else 1234 working->hours = ul; 1235 1236 if (*ep == '\0' || strcmp(ep, "*") == 0) 1237 goto no_trimat; 1238 if (*ep != '@' && *ep != '$') 1239 errx(1, "malformed interval/at:\n%s", errline); 1240 1241 working->flags |= CE_TRIMAT; 1242 working->trim_at = ptime_init(NULL); 1243 ptm_opts = PTM_PARSE_ISO8601; 1244 if (*ep == '$') 1245 ptm_opts = PTM_PARSE_DWM; 1246 ptm_opts |= PTM_PARSE_MATCHDOM; 1247 res = ptime_relparse(working->trim_at, ptm_opts, 1248 ptimeget_secs(timenow), ep + 1); 1249 if (res == -2) 1250 errx(1, "nonexistent time for 'at' value:\n%s", 1251 errline); 1252 else if (res < 0) 1253 errx(1, "malformed 'at' value:\n%s", errline); 1254 } 1255 no_trimat: 1256 1257 if (eol) 1258 q = NULL; 1259 else { 1260 q = parse = sob(++parse); /* Optional field */ 1261 parse = son(parse); 1262 if (!*parse) 1263 eol = 1; 1264 *parse = '\0'; 1265 } 1266 1267 for (; q && *q && !isspacech(*q); q++) { 1268 switch (tolowerch(*q)) { 1269 case 'b': 1270 working->flags |= CE_BINARY; 1271 break; 1272 case 'c': 1273 /* 1274 * XXX - Ick! Ugly! Remove ASAP! 1275 * We want `c' and `C' for "create". But we 1276 * will temporarily treat `c' as `g', because 1277 * FreeBSD releases <= 4.8 have a typo of 1278 * checking ('G' || 'c') for CE_GLOB. 1279 */ 1280 if (*q == 'c') { 1281 warnx("Assuming 'g' for 'c' in flags for line:\n%s", 1282 errline); 1283 warnx("The 'c' flag will eventually mean 'CREATE'"); 1284 working->flags |= CE_GLOB; 1285 break; 1286 } 1287 working->flags |= CE_CREATE; 1288 break; 1289 case 'd': 1290 working->flags |= CE_NODUMP; 1291 break; 1292 case 'g': 1293 working->flags |= CE_GLOB; 1294 break; 1295 case 'j': 1296 working->compress = COMPRESS_BZIP2; 1297 break; 1298 case 'n': 1299 working->flags |= CE_NOSIGNAL; 1300 break; 1301 case 'r': 1302 working->flags |= CE_PID2CMD; 1303 break; 1304 case 'u': 1305 working->flags |= CE_SIGNALGROUP; 1306 break; 1307 case 'w': 1308 /* Depreciated flag - keep for compatibility purposes */ 1309 break; 1310 case 'x': 1311 working->compress = COMPRESS_XZ; 1312 break; 1313 case 'z': 1314 working->compress = COMPRESS_GZIP; 1315 break; 1316 case '-': 1317 break; 1318 case 'f': /* Used by OpenBSD for "CE_FOLLOW" */ 1319 case 'm': /* Used by OpenBSD for "CE_MONITOR" */ 1320 case 'p': /* Used by NetBSD for "CE_PLAIN0" */ 1321 default: 1322 errx(1, "illegal flag in config file -- %c", 1323 *q); 1324 } 1325 } 1326 1327 if (eol) 1328 q = NULL; 1329 else { 1330 q = parse = sob(++parse); /* Optional field */ 1331 parse = son(parse); 1332 if (!*parse) 1333 eol = 1; 1334 *parse = '\0'; 1335 } 1336 1337 working->pid_cmd_file = NULL; 1338 if (q && *q) { 1339 if (*q == '/') 1340 working->pid_cmd_file = strdup(q); 1341 else if (isdigit(*q)) 1342 goto got_sig; 1343 else 1344 errx(1, 1345 "illegal pid file or signal number in config file:\n%s", 1346 errline); 1347 } 1348 if (eol) 1349 q = NULL; 1350 else { 1351 q = parse = sob(++parse); /* Optional field */ 1352 *(parse = son(parse)) = '\0'; 1353 } 1354 1355 working->sig = SIGHUP; 1356 if (q && *q) { 1357 if (isdigit(*q)) { 1358 got_sig: 1359 working->sig = atoi(q); 1360 } else { 1361 err_sig: 1362 errx(1, 1363 "illegal signal number in config file:\n%s", 1364 errline); 1365 } 1366 if (working->sig < 1 || working->sig >= NSIG) 1367 goto err_sig; 1368 } 1369 1370 /* 1371 * Finish figuring out what pid-file to use (if any) in 1372 * later processing if this logfile needs to be rotated. 1373 */ 1374 if ((working->flags & CE_NOSIGNAL) == CE_NOSIGNAL) { 1375 /* 1376 * This config-entry specified 'n' for nosignal, 1377 * see if it also specified an explicit pid_cmd_file. 1378 * This would be a pretty pointless combination. 1379 */ 1380 if (working->pid_cmd_file != NULL) { 1381 warnx("Ignoring '%s' because flag 'n' was specified in line:\n%s", 1382 working->pid_cmd_file, errline); 1383 free(working->pid_cmd_file); 1384 working->pid_cmd_file = NULL; 1385 } 1386 } else if (working->pid_cmd_file == NULL) { 1387 /* 1388 * This entry did not specify the 'n' flag, which 1389 * means it should signal syslogd unless it had 1390 * specified some other pid-file (and obviously the 1391 * syslog pid-file will not be for a process-group). 1392 * Also, we should only try to notify syslog if we 1393 * are root. 1394 */ 1395 if (working->flags & CE_SIGNALGROUP) { 1396 warnx("Ignoring flag 'U' in line:\n%s", 1397 errline); 1398 working->flags &= ~CE_SIGNALGROUP; 1399 } 1400 if (needroot) 1401 working->pid_cmd_file = strdup(path_syslogpid); 1402 } 1403 1404 /* 1405 * Add this entry to the appropriate list of entries, unless 1406 * it was some kind of special entry (eg: <default>). 1407 */ 1408 if (special) { 1409 ; /* Do not add to any list */ 1410 } else if (working->flags & CE_GLOB) { 1411 STAILQ_INSERT_TAIL(glob_p, working, cf_nextp); 1412 } else { 1413 STAILQ_INSERT_TAIL(work_p, working, cf_nextp); 1414 } 1415 } 1416 if (errline != NULL) 1417 free(errline); 1418 } 1419 1420 static char * 1421 missing_field(char *p, char *errline) 1422 { 1423 1424 if (!p || !*p) 1425 errx(1, "missing field in config file:\n%s", errline); 1426 return (p); 1427 } 1428 1429 /* 1430 * In our sort we return it in the reverse of what qsort normally 1431 * would do, as we want the newest files first. If we have two 1432 * entries with the same time we don't really care about order. 1433 * 1434 * Support function for qsort() in delete_oldest_timelog(). 1435 */ 1436 static int 1437 oldlog_entry_compare(const void *a, const void *b) 1438 { 1439 const struct oldlog_entry *ola = a, *olb = b; 1440 1441 if (ola->t > olb->t) 1442 return (-1); 1443 else if (ola->t < olb->t) 1444 return (1); 1445 else 1446 return (0); 1447 } 1448 1449 /* 1450 * Check whether the file corresponding to dp is an archive of the logfile 1451 * logfname, based on the timefnamefmt format string. Return true and fill out 1452 * tm if this is the case; otherwise return false. 1453 */ 1454 static int 1455 validate_old_timelog(const struct dirent *dp, const char *logfname, struct tm *tm) 1456 { 1457 size_t logfname_len; 1458 char *s; 1459 int c; 1460 1461 logfname_len = strlen(logfname); 1462 1463 if (dp->d_type != DT_REG) 1464 return (0); 1465 /* Ignore everything but files with our logfile prefix. */ 1466 if (strncmp(dp->d_name, logfname, logfname_len) != 0) 1467 return (0); 1468 /* Ignore the actual non-rotated logfile. */ 1469 if (dp->d_namlen == logfname_len) 1470 return (0); 1471 1472 /* 1473 * Make sure we created have found a logfile, so the 1474 * postfix is valid, IE format is: '.<time>(.[bgx]z)?'. 1475 */ 1476 if (dp->d_name[logfname_len] != '.') { 1477 if (verbose) 1478 printf("Ignoring %s which has unexpected " 1479 "extension '%s'\n", dp->d_name, 1480 &dp->d_name[logfname_len]); 1481 return (0); 1482 } 1483 if ((s = strptime(&dp->d_name[logfname_len + 1], 1484 timefnamefmt, tm)) == NULL) { 1485 /* 1486 * We could special case "old" sequentially named logfiles here, 1487 * but we do not as that would require special handling to 1488 * decide which one was the oldest compared to "new" time based 1489 * logfiles. 1490 */ 1491 if (verbose) 1492 printf("Ignoring %s which does not " 1493 "match time format\n", dp->d_name); 1494 return (0); 1495 } 1496 1497 for (c = 0; c < COMPRESS_TYPES; c++) 1498 if (strcmp(s, compress_type[c].suffix) == 0) 1499 /* We're done. */ 1500 return (1); 1501 1502 if (verbose) 1503 printf("Ignoring %s which has unexpected extension '%s'\n", 1504 dp->d_name, s); 1505 1506 return (0); 1507 } 1508 1509 /* 1510 * Delete the oldest logfiles, when using time based filenames. 1511 */ 1512 static void 1513 delete_oldest_timelog(const struct conf_entry *ent, const char *archive_dir) 1514 { 1515 char *logfname, *s, *dir, errbuf[80]; 1516 int dir_fd, i, logcnt, max_logcnt; 1517 struct oldlog_entry *oldlogs; 1518 struct dirent *dp; 1519 const char *cdir; 1520 struct tm tm; 1521 DIR *dirp; 1522 1523 oldlogs = malloc(MAX_OLDLOGS * sizeof(struct oldlog_entry)); 1524 max_logcnt = MAX_OLDLOGS; 1525 logcnt = 0; 1526 1527 if (archive_dir != NULL && archive_dir[0] != '\0') 1528 cdir = archive_dir; 1529 else 1530 if ((cdir = dirname(ent->log)) == NULL) 1531 err(1, "dirname()"); 1532 if ((dir = strdup(cdir)) == NULL) 1533 err(1, "strdup()"); 1534 1535 if ((s = basename(ent->log)) == NULL) 1536 err(1, "basename()"); 1537 if ((logfname = strdup(s)) == NULL) 1538 err(1, "strdup()"); 1539 if (strcmp(logfname, "/") == 0) 1540 errx(1, "Invalid log filename - became '/'"); 1541 1542 if (verbose > 2) 1543 printf("Searching for old logs in %s\n", dir); 1544 1545 /* First we create a 'list' of all archived logfiles */ 1546 if ((dirp = opendir(dir)) == NULL) 1547 err(1, "Cannot open log directory '%s'", dir); 1548 dir_fd = dirfd(dirp); 1549 while ((dp = readdir(dirp)) != NULL) { 1550 if (validate_old_timelog(dp, logfname, &tm) == 0) 1551 continue; 1552 1553 /* 1554 * We should now have old an old rotated logfile, so 1555 * add it to the 'list'. 1556 */ 1557 if ((oldlogs[logcnt].t = timegm(&tm)) == -1) 1558 err(1, "Could not convert time string to time value"); 1559 if ((oldlogs[logcnt].fname = strdup(dp->d_name)) == NULL) 1560 err(1, "strdup()"); 1561 logcnt++; 1562 1563 /* 1564 * It is very unlikely we ever run out of space in the 1565 * logfile array from the default size, but lets 1566 * handle it anyway... 1567 */ 1568 if (logcnt >= max_logcnt) { 1569 max_logcnt *= 4; 1570 /* Detect integer overflow */ 1571 if (max_logcnt < logcnt) 1572 errx(1, "Too many old logfiles found"); 1573 oldlogs = realloc(oldlogs, 1574 max_logcnt * sizeof(struct oldlog_entry)); 1575 if (oldlogs == NULL) 1576 err(1, "realloc()"); 1577 } 1578 } 1579 1580 /* Second, if needed we delete oldest archived logfiles */ 1581 if (logcnt > 0 && logcnt >= ent->numlogs && ent->numlogs > 1) { 1582 oldlogs = realloc(oldlogs, logcnt * 1583 sizeof(struct oldlog_entry)); 1584 if (oldlogs == NULL) 1585 err(1, "realloc()"); 1586 1587 /* 1588 * We now sort the logs in the order of newest to 1589 * oldest. That way we can simply skip over the 1590 * number of records we want to keep. 1591 */ 1592 qsort(oldlogs, logcnt, sizeof(struct oldlog_entry), 1593 oldlog_entry_compare); 1594 for (i = ent->numlogs - 1; i < logcnt; i++) { 1595 if (noaction) 1596 printf("\trm -f %s/%s\n", dir, 1597 oldlogs[i].fname); 1598 else if (unlinkat(dir_fd, oldlogs[i].fname, 0) != 0) { 1599 snprintf(errbuf, sizeof(errbuf), 1600 "Could not delete old logfile '%s'", 1601 oldlogs[i].fname); 1602 perror(errbuf); 1603 } 1604 } 1605 } else if (verbose > 1) 1606 printf("No old logs to delete for logfile %s\n", ent->log); 1607 1608 /* Third, cleanup */ 1609 closedir(dirp); 1610 for (i = 0; i < logcnt; i++) { 1611 assert(oldlogs[i].fname != NULL); 1612 free(oldlogs[i].fname); 1613 } 1614 free(oldlogs); 1615 free(logfname); 1616 free(dir); 1617 } 1618 1619 /* 1620 * Generate a log filename, when using classic filenames. 1621 */ 1622 static void 1623 gen_classiclog_fname(char *fname, size_t fname_sz, const char *archive_dir, 1624 const char *namepart, int numlogs_c) 1625 { 1626 1627 if (archive_dir[0] != '\0') 1628 (void) snprintf(fname, fname_sz, "%s/%s.%d", archive_dir, 1629 namepart, numlogs_c); 1630 else 1631 (void) snprintf(fname, fname_sz, "%s.%d", namepart, numlogs_c); 1632 } 1633 1634 /* 1635 * Delete a rotated logfile, when using classic filenames. 1636 */ 1637 static void 1638 delete_classiclog(const char *archive_dir, const char *namepart, int numlog_c) 1639 { 1640 char file1[MAXPATHLEN], zfile1[MAXPATHLEN]; 1641 int c; 1642 1643 gen_classiclog_fname(file1, sizeof(file1), archive_dir, namepart, 1644 numlog_c); 1645 1646 for (c = 0; c < COMPRESS_TYPES; c++) { 1647 (void) snprintf(zfile1, sizeof(zfile1), "%s%s", file1, 1648 compress_type[c].suffix); 1649 if (noaction) 1650 printf("\trm -f %s\n", zfile1); 1651 else 1652 (void) unlink(zfile1); 1653 } 1654 } 1655 1656 /* 1657 * Only add to the queue if the file hasn't already been added. This is 1658 * done to prevent circular include loops. 1659 */ 1660 static void 1661 add_to_queue(const char *fname, struct ilist *inclist) 1662 { 1663 struct include_entry *inc; 1664 1665 STAILQ_FOREACH(inc, inclist, inc_nextp) { 1666 if (strcmp(fname, inc->file) == 0) { 1667 warnx("duplicate include detected: %s", fname); 1668 return; 1669 } 1670 } 1671 1672 inc = malloc(sizeof(struct include_entry)); 1673 if (inc == NULL) 1674 err(1, "malloc of inc"); 1675 inc->file = strdup(fname); 1676 1677 if (verbose > 2) 1678 printf("\t+ Adding %s to the processing queue.\n", fname); 1679 1680 STAILQ_INSERT_TAIL(inclist, inc, inc_nextp); 1681 } 1682 1683 /* 1684 * Search for logfile and return its compression suffix (if supported) 1685 * The suffix detection is first-match in the order of compress_types 1686 * 1687 * Note: if logfile without suffix exists (uncompressed, COMPRESS_NONE) 1688 * a zero-length string is returned 1689 */ 1690 static const char * 1691 get_logfile_suffix(const char *logfile) 1692 { 1693 struct stat st; 1694 char zfile[MAXPATHLEN]; 1695 int c; 1696 1697 for (c = 0; c < COMPRESS_TYPES; c++) { 1698 (void) strlcpy(zfile, logfile, MAXPATHLEN); 1699 (void) strlcat(zfile, compress_type[c].suffix, MAXPATHLEN); 1700 if (lstat(zfile, &st) == 0) 1701 return (compress_type[c].suffix); 1702 } 1703 return (NULL); 1704 } 1705 1706 static fk_entry 1707 do_rotate(const struct conf_entry *ent) 1708 { 1709 char dirpart[MAXPATHLEN], namepart[MAXPATHLEN]; 1710 char file1[MAXPATHLEN], file2[MAXPATHLEN]; 1711 char zfile1[MAXPATHLEN], zfile2[MAXPATHLEN]; 1712 const char *logfile_suffix; 1713 char datetimestr[30]; 1714 int flags, numlogs_c; 1715 fk_entry free_or_keep; 1716 struct sigwork_entry *swork; 1717 struct stat st; 1718 struct tm tm; 1719 time_t now; 1720 1721 flags = ent->flags; 1722 free_or_keep = FREE_ENT; 1723 1724 if (archtodir) { 1725 char *p; 1726 1727 /* build complete name of archive directory into dirpart */ 1728 if (*archdirname == '/') { /* absolute */ 1729 strlcpy(dirpart, archdirname, sizeof(dirpart)); 1730 } else { /* relative */ 1731 /* get directory part of logfile */ 1732 strlcpy(dirpart, ent->log, sizeof(dirpart)); 1733 if ((p = strrchr(dirpart, '/')) == NULL) 1734 dirpart[0] = '\0'; 1735 else 1736 *(p + 1) = '\0'; 1737 strlcat(dirpart, archdirname, sizeof(dirpart)); 1738 } 1739 1740 /* check if archive directory exists, if not, create it */ 1741 if (lstat(dirpart, &st)) 1742 createdir(ent, dirpart); 1743 1744 /* get filename part of logfile */ 1745 if ((p = strrchr(ent->log, '/')) == NULL) 1746 strlcpy(namepart, ent->log, sizeof(namepart)); 1747 else 1748 strlcpy(namepart, p + 1, sizeof(namepart)); 1749 } else { 1750 /* 1751 * Tell utility functions we are not using an archive 1752 * dir. 1753 */ 1754 dirpart[0] = '\0'; 1755 strlcpy(namepart, ent->log, sizeof(namepart)); 1756 } 1757 1758 /* Delete old logs */ 1759 if (timefnamefmt != NULL) 1760 delete_oldest_timelog(ent, dirpart); 1761 else { 1762 /* 1763 * Handle cleaning up after legacy newsyslog where we 1764 * kept ent->numlogs + 1 files. This code can go away 1765 * at some point in the future. 1766 */ 1767 delete_classiclog(dirpart, namepart, ent->numlogs); 1768 1769 if (ent->numlogs > 0) 1770 delete_classiclog(dirpart, namepart, ent->numlogs - 1); 1771 1772 } 1773 1774 if (timefnamefmt != NULL) { 1775 /* If time functions fails we can't really do any sensible */ 1776 if (time(&now) == (time_t)-1 || 1777 localtime_r(&now, &tm) == NULL) 1778 bzero(&tm, sizeof(tm)); 1779 1780 strftime(datetimestr, sizeof(datetimestr), timefnamefmt, &tm); 1781 if (archtodir) 1782 (void) snprintf(file1, sizeof(file1), "%s/%s.%s", 1783 dirpart, namepart, datetimestr); 1784 else 1785 (void) snprintf(file1, sizeof(file1), "%s.%s", 1786 ent->log, datetimestr); 1787 1788 /* Don't run the code to move down logs */ 1789 numlogs_c = -1; 1790 } else { 1791 gen_classiclog_fname(file1, sizeof(file1), dirpart, namepart, 1792 ent->numlogs - 1); 1793 numlogs_c = ent->numlogs - 2; /* copy for countdown */ 1794 } 1795 1796 /* Move down log files */ 1797 for (; numlogs_c >= 0; numlogs_c--) { 1798 (void) strlcpy(file2, file1, sizeof(file2)); 1799 1800 gen_classiclog_fname(file1, sizeof(file1), dirpart, namepart, 1801 numlogs_c); 1802 1803 logfile_suffix = get_logfile_suffix(file1); 1804 if (logfile_suffix == NULL) 1805 continue; 1806 (void) strlcpy(zfile1, file1, MAXPATHLEN); 1807 (void) strlcpy(zfile2, file2, MAXPATHLEN); 1808 (void) strlcat(zfile1, logfile_suffix, MAXPATHLEN); 1809 (void) strlcat(zfile2, logfile_suffix, MAXPATHLEN); 1810 1811 if (noaction) 1812 printf("\tmv %s %s\n", zfile1, zfile2); 1813 else { 1814 /* XXX - Ought to be checking for failure! */ 1815 (void)rename(zfile1, zfile2); 1816 } 1817 change_attrs(zfile2, ent); 1818 } 1819 1820 if (ent->numlogs > 0) { 1821 if (noaction) { 1822 /* 1823 * Note that savelog() may succeed with using link() 1824 * for the archtodir case, but there is no good way 1825 * of knowing if it will when doing "noaction", so 1826 * here we claim that it will have to do a copy... 1827 */ 1828 if (archtodir) 1829 printf("\tcp %s %s\n", ent->log, file1); 1830 else 1831 printf("\tln %s %s\n", ent->log, file1); 1832 printf("\ttouch %s\t\t" 1833 "# Update mtime for 'when'-interval processing\n", 1834 file1); 1835 } else { 1836 if (!(flags & CE_BINARY)) { 1837 /* Report the trimming to the old log */ 1838 log_trim(ent->log, ent); 1839 } 1840 savelog(ent->log, file1); 1841 /* 1842 * Interval-based rotations are done using the mtime of 1843 * the most recently archived log, so make sure it gets 1844 * updated during a rotation. 1845 */ 1846 utimes(file1, NULL); 1847 } 1848 change_attrs(file1, ent); 1849 } 1850 1851 /* Create the new log file and move it into place */ 1852 if (noaction) 1853 printf("Start new log...\n"); 1854 createlog(ent); 1855 1856 /* 1857 * Save all signalling and file-compression to be done after log 1858 * files from all entries have been rotated. This way any one 1859 * process will not be sent the same signal multiple times when 1860 * multiple log files had to be rotated. 1861 */ 1862 swork = NULL; 1863 if (ent->pid_cmd_file != NULL) 1864 swork = save_sigwork(ent); 1865 if (ent->numlogs > 0 && ent->compress > COMPRESS_NONE) { 1866 /* 1867 * The zipwork_entry will include a pointer to this 1868 * conf_entry, so the conf_entry should not be freed. 1869 */ 1870 free_or_keep = KEEP_ENT; 1871 save_zipwork(ent, swork, ent->fsize, file1); 1872 } 1873 1874 return (free_or_keep); 1875 } 1876 1877 static void 1878 do_sigwork(struct sigwork_entry *swork) 1879 { 1880 struct sigwork_entry *nextsig; 1881 int kres, secs; 1882 char *tmp; 1883 1884 if (swork->sw_runcmd == 0 && (!(swork->sw_pidok) || swork->sw_pid == 0)) 1885 return; /* no work to do... */ 1886 1887 /* 1888 * If nosignal (-s) was specified, then do not signal any process. 1889 * Note that a nosignal request triggers a warning message if the 1890 * rotated logfile needs to be compressed, *unless* -R was also 1891 * specified. We assume that an `-sR' request came from a process 1892 * which writes to the logfile, and as such, we assume that process 1893 * has already made sure the logfile is not presently in use. This 1894 * just sets swork->sw_pidok to a special value, and do_zipwork 1895 * will print any necessary warning(s). 1896 */ 1897 if (nosignal) { 1898 if (!rotatereq) 1899 swork->sw_pidok = -1; 1900 return; 1901 } 1902 1903 /* 1904 * Compute the pause between consecutive signals. Use a longer 1905 * sleep time if we will be sending two signals to the same 1906 * deamon or process-group. 1907 */ 1908 secs = 0; 1909 nextsig = SLIST_NEXT(swork, sw_nextp); 1910 if (nextsig != NULL) { 1911 if (swork->sw_pid == nextsig->sw_pid) 1912 secs = 10; 1913 else 1914 secs = 1; 1915 } 1916 1917 if (noaction) { 1918 if (swork->sw_runcmd) 1919 printf("\tsh -c '%s %d'\n", swork->sw_fname, 1920 swork->sw_signum); 1921 else { 1922 printf("\tkill -%d %d \t\t# %s\n", swork->sw_signum, 1923 (int)swork->sw_pid, swork->sw_fname); 1924 if (secs > 0) 1925 printf("\tsleep %d\n", secs); 1926 } 1927 return; 1928 } 1929 1930 if (swork->sw_runcmd) { 1931 asprintf(&tmp, "%s %d", swork->sw_fname, swork->sw_signum); 1932 if (tmp == NULL) { 1933 warn("can't allocate memory to run %s", 1934 swork->sw_fname); 1935 return; 1936 } 1937 if (verbose) 1938 printf("Run command: %s\n", tmp); 1939 kres = system(tmp); 1940 if (kres) { 1941 warnx("%s: returned non-zero exit code: %d", 1942 tmp, kres); 1943 } 1944 free(tmp); 1945 return; 1946 } 1947 1948 kres = kill(swork->sw_pid, swork->sw_signum); 1949 if (kres != 0) { 1950 /* 1951 * Assume that "no such process" (ESRCH) is something 1952 * to warn about, but is not an error. Presumably the 1953 * process which writes to the rotated log file(s) is 1954 * gone, in which case we should have no problem with 1955 * compressing the rotated log file(s). 1956 */ 1957 if (errno != ESRCH) 1958 swork->sw_pidok = 0; 1959 warn("can't notify %s, pid %d", swork->sw_pidtype, 1960 (int)swork->sw_pid); 1961 } else { 1962 if (verbose) 1963 printf("Notified %s pid %d = %s\n", swork->sw_pidtype, 1964 (int)swork->sw_pid, swork->sw_fname); 1965 if (secs > 0) { 1966 if (verbose) 1967 printf("Pause %d second(s) between signals\n", 1968 secs); 1969 sleep(secs); 1970 } 1971 } 1972 } 1973 1974 static void 1975 do_zipwork(struct zipwork_entry *zwork) 1976 { 1977 const char *pgm_name, *pgm_path; 1978 int errsav, fcount, zstatus; 1979 pid_t pidzip, wpid; 1980 char zresult[MAXPATHLEN]; 1981 int c; 1982 1983 assert(zwork != NULL); 1984 pgm_path = NULL; 1985 strlcpy(zresult, zwork->zw_fname, sizeof(zresult)); 1986 if (zwork->zw_conf != NULL && 1987 zwork->zw_conf->compress > COMPRESS_NONE) 1988 for (c = 1; c < COMPRESS_TYPES; c++) { 1989 if (zwork->zw_conf->compress == c) { 1990 pgm_path = compress_type[c].path; 1991 (void) strlcat(zresult, 1992 compress_type[c].suffix, sizeof(zresult)); 1993 break; 1994 } 1995 } 1996 if (pgm_path == NULL) { 1997 warnx("invalid entry for %s in do_zipwork", zwork->zw_fname); 1998 return; 1999 } 2000 pgm_name = strrchr(pgm_path, '/'); 2001 if (pgm_name == NULL) 2002 pgm_name = pgm_path; 2003 else 2004 pgm_name++; 2005 2006 if (zwork->zw_swork != NULL && zwork->zw_swork->sw_runcmd == 0 && 2007 zwork->zw_swork->sw_pidok <= 0) { 2008 warnx( 2009 "log %s not compressed because daemon(s) not notified", 2010 zwork->zw_fname); 2011 change_attrs(zwork->zw_fname, zwork->zw_conf); 2012 return; 2013 } 2014 2015 if (noaction) { 2016 printf("\t%s %s\n", pgm_name, zwork->zw_fname); 2017 change_attrs(zresult, zwork->zw_conf); 2018 return; 2019 } 2020 2021 fcount = 1; 2022 pidzip = fork(); 2023 while (pidzip < 0) { 2024 /* 2025 * The fork failed. If the failure was due to a temporary 2026 * problem, then wait a short time and try it again. 2027 */ 2028 errsav = errno; 2029 warn("fork() for `%s %s'", pgm_name, zwork->zw_fname); 2030 if (errsav != EAGAIN || fcount > 5) 2031 errx(1, "Exiting..."); 2032 sleep(fcount * 12); 2033 fcount++; 2034 pidzip = fork(); 2035 } 2036 if (!pidzip) { 2037 /* The child process executes the compression command */ 2038 execl(pgm_path, pgm_path, "-f", zwork->zw_fname, (char *)0); 2039 err(1, "execl(`%s -f %s')", pgm_path, zwork->zw_fname); 2040 } 2041 2042 wpid = waitpid(pidzip, &zstatus, 0); 2043 if (wpid == -1) { 2044 /* XXX - should this be a fatal error? */ 2045 warn("%s: waitpid(%d)", pgm_path, pidzip); 2046 return; 2047 } 2048 if (!WIFEXITED(zstatus)) { 2049 warnx("`%s -f %s' did not terminate normally", pgm_name, 2050 zwork->zw_fname); 2051 return; 2052 } 2053 if (WEXITSTATUS(zstatus)) { 2054 warnx("`%s -f %s' terminated with a non-zero status (%d)", 2055 pgm_name, zwork->zw_fname, WEXITSTATUS(zstatus)); 2056 return; 2057 } 2058 2059 /* Compression was successful, set file attributes on the result. */ 2060 change_attrs(zresult, zwork->zw_conf); 2061 } 2062 2063 /* 2064 * Save information on any process we need to signal. Any single 2065 * process may need to be sent different signal-values for different 2066 * log files, but usually a single signal-value will cause the process 2067 * to close and re-open all of it's log files. 2068 */ 2069 static struct sigwork_entry * 2070 save_sigwork(const struct conf_entry *ent) 2071 { 2072 struct sigwork_entry *sprev, *stmp; 2073 int ndiff; 2074 size_t tmpsiz; 2075 2076 sprev = NULL; 2077 ndiff = 1; 2078 SLIST_FOREACH(stmp, &swhead, sw_nextp) { 2079 ndiff = strcmp(ent->pid_cmd_file, stmp->sw_fname); 2080 if (ndiff > 0) 2081 break; 2082 if (ndiff == 0) { 2083 if (ent->sig == stmp->sw_signum) 2084 break; 2085 if (ent->sig > stmp->sw_signum) { 2086 ndiff = 1; 2087 break; 2088 } 2089 } 2090 sprev = stmp; 2091 } 2092 if (stmp != NULL && ndiff == 0) 2093 return (stmp); 2094 2095 tmpsiz = sizeof(struct sigwork_entry) + strlen(ent->pid_cmd_file) + 1; 2096 stmp = malloc(tmpsiz); 2097 2098 stmp->sw_runcmd = 0; 2099 /* If this is a command to run we just set the flag and run command */ 2100 if (ent->flags & CE_PID2CMD) { 2101 stmp->sw_pid = -1; 2102 stmp->sw_pidok = 0; 2103 stmp->sw_runcmd = 1; 2104 } else { 2105 set_swpid(stmp, ent); 2106 } 2107 stmp->sw_signum = ent->sig; 2108 strcpy(stmp->sw_fname, ent->pid_cmd_file); 2109 if (sprev == NULL) 2110 SLIST_INSERT_HEAD(&swhead, stmp, sw_nextp); 2111 else 2112 SLIST_INSERT_AFTER(sprev, stmp, sw_nextp); 2113 return (stmp); 2114 } 2115 2116 /* 2117 * Save information on any file we need to compress. We may see the same 2118 * file multiple times, so check the full list to avoid duplicates. The 2119 * list itself is sorted smallest-to-largest, because that's the order we 2120 * want to compress the files. If the partition is very low on disk space, 2121 * then the smallest files are the most likely to compress, and compressing 2122 * them first will free up more space for the larger files. 2123 */ 2124 static struct zipwork_entry * 2125 save_zipwork(const struct conf_entry *ent, const struct sigwork_entry *swork, 2126 int zsize, const char *zipfname) 2127 { 2128 struct zipwork_entry *zprev, *ztmp; 2129 int ndiff; 2130 size_t tmpsiz; 2131 2132 /* Compute the size if the caller did not know it. */ 2133 if (zsize < 0) 2134 zsize = sizefile(zipfname); 2135 2136 zprev = NULL; 2137 ndiff = 1; 2138 SLIST_FOREACH(ztmp, &zwhead, zw_nextp) { 2139 ndiff = strcmp(zipfname, ztmp->zw_fname); 2140 if (ndiff == 0) 2141 break; 2142 if (zsize > ztmp->zw_fsize) 2143 zprev = ztmp; 2144 } 2145 if (ztmp != NULL && ndiff == 0) 2146 return (ztmp); 2147 2148 tmpsiz = sizeof(struct zipwork_entry) + strlen(zipfname) + 1; 2149 ztmp = malloc(tmpsiz); 2150 ztmp->zw_conf = ent; 2151 ztmp->zw_swork = swork; 2152 ztmp->zw_fsize = zsize; 2153 strcpy(ztmp->zw_fname, zipfname); 2154 if (zprev == NULL) 2155 SLIST_INSERT_HEAD(&zwhead, ztmp, zw_nextp); 2156 else 2157 SLIST_INSERT_AFTER(zprev, ztmp, zw_nextp); 2158 return (ztmp); 2159 } 2160 2161 /* Send a signal to the pid specified by pidfile */ 2162 static void 2163 set_swpid(struct sigwork_entry *swork, const struct conf_entry *ent) 2164 { 2165 FILE *f; 2166 long minok, maxok, rval; 2167 char *endp, *linep, line[BUFSIZ]; 2168 2169 minok = MIN_PID; 2170 maxok = MAX_PID; 2171 swork->sw_pidok = 0; 2172 swork->sw_pid = 0; 2173 swork->sw_pidtype = "daemon"; 2174 if (ent->flags & CE_SIGNALGROUP) { 2175 /* 2176 * If we are expected to signal a process-group when 2177 * rotating this logfile, then the value read in should 2178 * be the negative of a valid process ID. 2179 */ 2180 minok = -MAX_PID; 2181 maxok = -MIN_PID; 2182 swork->sw_pidtype = "process-group"; 2183 } 2184 2185 f = fopen(ent->pid_cmd_file, "r"); 2186 if (f == NULL) { 2187 if (errno == ENOENT && enforcepid == 0) { 2188 /* 2189 * Warn if the PID file doesn't exist, but do 2190 * not consider it an error. Most likely it 2191 * means the process has been terminated, 2192 * so it should be safe to rotate any log 2193 * files that the process would have been using. 2194 */ 2195 swork->sw_pidok = 1; 2196 warnx("pid file doesn't exist: %s", ent->pid_cmd_file); 2197 } else 2198 warn("can't open pid file: %s", ent->pid_cmd_file); 2199 return; 2200 } 2201 2202 if (fgets(line, BUFSIZ, f) == NULL) { 2203 /* 2204 * Warn if the PID file is empty, but do not consider 2205 * it an error. Most likely it means the process has 2206 * has terminated, so it should be safe to rotate any 2207 * log files that the process would have been using. 2208 */ 2209 if (feof(f) && enforcepid == 0) { 2210 swork->sw_pidok = 1; 2211 warnx("pid/cmd file is empty: %s", ent->pid_cmd_file); 2212 } else 2213 warn("can't read from pid file: %s", ent->pid_cmd_file); 2214 (void)fclose(f); 2215 return; 2216 } 2217 (void)fclose(f); 2218 2219 errno = 0; 2220 linep = line; 2221 while (*linep == ' ') 2222 linep++; 2223 rval = strtol(linep, &endp, 10); 2224 if (*endp != '\0' && !isspacech(*endp)) { 2225 warnx("pid file does not start with a valid number: %s", 2226 ent->pid_cmd_file); 2227 } else if (rval < minok || rval > maxok) { 2228 warnx("bad value '%ld' for process number in %s", 2229 rval, ent->pid_cmd_file); 2230 if (verbose) 2231 warnx("\t(expecting value between %ld and %ld)", 2232 minok, maxok); 2233 } else { 2234 swork->sw_pidok = 1; 2235 swork->sw_pid = rval; 2236 } 2237 2238 return; 2239 } 2240 2241 /* Log the fact that the logs were turned over */ 2242 static int 2243 log_trim(const char *logname, const struct conf_entry *log_ent) 2244 { 2245 FILE *f; 2246 const char *xtra; 2247 2248 if ((f = fopen(logname, "a")) == NULL) 2249 return (-1); 2250 xtra = ""; 2251 if (log_ent->def_cfg) 2252 xtra = " using <default> rule"; 2253 if (log_ent->firstcreate) 2254 fprintf(f, "%s %s newsyslog[%d]: logfile first created%s\n", 2255 daytime, hostname, (int) getpid(), xtra); 2256 else if (log_ent->r_reason != NULL) 2257 fprintf(f, "%s %s newsyslog[%d]: logfile turned over%s%s\n", 2258 daytime, hostname, (int) getpid(), log_ent->r_reason, xtra); 2259 else 2260 fprintf(f, "%s %s newsyslog[%d]: logfile turned over%s\n", 2261 daytime, hostname, (int) getpid(), xtra); 2262 if (fclose(f) == EOF) 2263 err(1, "log_trim: fclose"); 2264 return (0); 2265 } 2266 2267 /* Return size in kilobytes of a file */ 2268 static int 2269 sizefile(const char *file) 2270 { 2271 struct stat sb; 2272 2273 if (stat(file, &sb) < 0) 2274 return (-1); 2275 return (kbytes(dbtob(sb.st_blocks))); 2276 } 2277 2278 /* 2279 * Return the mtime of the most recent archive of the logfile, using timestamp 2280 * based filenames. 2281 */ 2282 static time_t 2283 mtime_old_timelog(const char *file) 2284 { 2285 struct stat sb; 2286 struct tm tm; 2287 int dir_fd; 2288 time_t t; 2289 struct dirent *dp; 2290 DIR *dirp; 2291 char *s, *logfname, *dir; 2292 2293 t = -1; 2294 2295 if ((dir = dirname(file)) == NULL) { 2296 warn("dirname() of '%s'", file); 2297 return (t); 2298 } 2299 if ((s = basename(file)) == NULL) { 2300 warn("basename() of '%s'", file); 2301 return (t); 2302 } else if (s[0] == '/') { 2303 warnx("Invalid log filename '%s'", s); 2304 return (t); 2305 } else if ((logfname = strdup(s)) == NULL) 2306 err(1, "strdup()"); 2307 2308 if ((dirp = opendir(dir)) == NULL) { 2309 warn("Cannot open log directory '%s'", dir); 2310 return (t); 2311 } 2312 dir_fd = dirfd(dirp); 2313 /* Open the archive dir and find the most recent archive of logfname. */ 2314 while ((dp = readdir(dirp)) != NULL) { 2315 if (validate_old_timelog(dp, logfname, &tm) == 0) 2316 continue; 2317 2318 if (fstatat(dir_fd, logfname, &sb, 0) == -1) { 2319 warn("Cannot stat '%s'", file); 2320 continue; 2321 } 2322 if (t < sb.st_mtime) 2323 t = sb.st_mtime; 2324 } 2325 closedir(dirp); 2326 2327 return (t); 2328 } 2329 2330 /* Return the age in hours of the most recent archive of the logfile. */ 2331 static int 2332 age_old_log(const char *file) 2333 { 2334 struct stat sb; 2335 const char *logfile_suffix; 2336 char tmp[MAXPATHLEN + sizeof(".0") + COMPRESS_SUFFIX_MAXLEN + 1]; 2337 time_t mtime; 2338 2339 if (archtodir) { 2340 char *p; 2341 2342 /* build name of archive directory into tmp */ 2343 if (*archdirname == '/') { /* absolute */ 2344 strlcpy(tmp, archdirname, sizeof(tmp)); 2345 } else { /* relative */ 2346 /* get directory part of logfile */ 2347 strlcpy(tmp, file, sizeof(tmp)); 2348 if ((p = strrchr(tmp, '/')) == NULL) 2349 tmp[0] = '\0'; 2350 else 2351 *(p + 1) = '\0'; 2352 strlcat(tmp, archdirname, sizeof(tmp)); 2353 } 2354 2355 strlcat(tmp, "/", sizeof(tmp)); 2356 2357 /* get filename part of logfile */ 2358 if ((p = strrchr(file, '/')) == NULL) 2359 strlcat(tmp, file, sizeof(tmp)); 2360 else 2361 strlcat(tmp, p + 1, sizeof(tmp)); 2362 } else { 2363 (void) strlcpy(tmp, file, sizeof(tmp)); 2364 } 2365 2366 if (timefnamefmt != NULL) { 2367 mtime = mtime_old_timelog(tmp); 2368 if (mtime == -1) 2369 return (-1); 2370 } else { 2371 strlcat(tmp, ".0", sizeof(tmp)); 2372 logfile_suffix = get_logfile_suffix(tmp); 2373 if (logfile_suffix == NULL) 2374 return (-1); 2375 (void) strlcat(tmp, logfile_suffix, sizeof(tmp)); 2376 if (stat(tmp, &sb) < 0) 2377 return (-1); 2378 mtime = sb.st_mtime; 2379 } 2380 2381 return ((int)(ptimeget_secs(timenow) - mtime + 1800) / 3600); 2382 } 2383 2384 /* Skip Over Blanks */ 2385 static char * 2386 sob(char *p) 2387 { 2388 while (p && *p && isspace(*p)) 2389 p++; 2390 return (p); 2391 } 2392 2393 /* Skip Over Non-Blanks */ 2394 static char * 2395 son(char *p) 2396 { 2397 while (p && *p && !isspace(*p)) 2398 p++; 2399 return (p); 2400 } 2401 2402 /* Check if string is actually a number */ 2403 static int 2404 isnumberstr(const char *string) 2405 { 2406 while (*string) { 2407 if (!isdigitch(*string++)) 2408 return (0); 2409 } 2410 return (1); 2411 } 2412 2413 /* Check if string contains a glob */ 2414 static int 2415 isglobstr(const char *string) 2416 { 2417 char chr; 2418 2419 while ((chr = *string++)) { 2420 if (chr == '*' || chr == '?' || chr == '[') 2421 return (1); 2422 } 2423 return (0); 2424 } 2425 2426 /* 2427 * Save the active log file under a new name. A link to the new name 2428 * is the quick-and-easy way to do this. If that fails (which it will 2429 * if the destination is on another partition), then make a copy of 2430 * the file to the new location. 2431 */ 2432 static void 2433 savelog(char *from, char *to) 2434 { 2435 FILE *src, *dst; 2436 int c, res; 2437 2438 res = link(from, to); 2439 if (res == 0) 2440 return; 2441 2442 if ((src = fopen(from, "r")) == NULL) 2443 err(1, "can't fopen %s for reading", from); 2444 if ((dst = fopen(to, "w")) == NULL) 2445 err(1, "can't fopen %s for writing", to); 2446 2447 while ((c = getc(src)) != EOF) { 2448 if ((putc(c, dst)) == EOF) 2449 err(1, "error writing to %s", to); 2450 } 2451 2452 if (ferror(src)) 2453 err(1, "error reading from %s", from); 2454 if ((fclose(src)) != 0) 2455 err(1, "can't fclose %s", to); 2456 if ((fclose(dst)) != 0) 2457 err(1, "can't fclose %s", from); 2458 } 2459 2460 /* create one or more directory components of a path */ 2461 static void 2462 createdir(const struct conf_entry *ent, char *dirpart) 2463 { 2464 int res; 2465 char *s, *d; 2466 char mkdirpath[MAXPATHLEN]; 2467 struct stat st; 2468 2469 s = dirpart; 2470 d = mkdirpath; 2471 2472 for (;;) { 2473 *d++ = *s++; 2474 if (*s != '/' && *s != '\0') 2475 continue; 2476 *d = '\0'; 2477 res = lstat(mkdirpath, &st); 2478 if (res != 0) { 2479 if (noaction) { 2480 printf("\tmkdir %s\n", mkdirpath); 2481 } else { 2482 res = mkdir(mkdirpath, 0755); 2483 if (res != 0) 2484 err(1, "Error on mkdir(\"%s\") for -a", 2485 mkdirpath); 2486 } 2487 } 2488 if (*s == '\0') 2489 break; 2490 } 2491 if (verbose) { 2492 if (ent->firstcreate) 2493 printf("Created directory '%s' for new %s\n", 2494 dirpart, ent->log); 2495 else 2496 printf("Created directory '%s' for -a\n", dirpart); 2497 } 2498 } 2499 2500 /* 2501 * Create a new log file, destroying any currently-existing version 2502 * of the log file in the process. If the caller wants a backup copy 2503 * of the file to exist, they should call 'link(logfile,logbackup)' 2504 * before calling this routine. 2505 */ 2506 void 2507 createlog(const struct conf_entry *ent) 2508 { 2509 int fd, failed; 2510 struct stat st; 2511 char *realfile, *slash, tempfile[MAXPATHLEN]; 2512 2513 fd = -1; 2514 realfile = ent->log; 2515 2516 /* 2517 * If this log file is being created for the first time (-C option), 2518 * then it may also be true that the parent directory does not exist 2519 * yet. Check, and create that directory if it is missing. 2520 */ 2521 if (ent->firstcreate) { 2522 strlcpy(tempfile, realfile, sizeof(tempfile)); 2523 slash = strrchr(tempfile, '/'); 2524 if (slash != NULL) { 2525 *slash = '\0'; 2526 failed = stat(tempfile, &st); 2527 if (failed && errno != ENOENT) 2528 err(1, "Error on stat(%s)", tempfile); 2529 if (failed) 2530 createdir(ent, tempfile); 2531 else if (!S_ISDIR(st.st_mode)) 2532 errx(1, "%s exists but is not a directory", 2533 tempfile); 2534 } 2535 } 2536 2537 /* 2538 * First create an unused filename, so it can be chown'ed and 2539 * chmod'ed before it is moved into the real location. mkstemp 2540 * will create the file mode=600 & owned by us. Note that all 2541 * temp files will have a suffix of '.z<something>'. 2542 */ 2543 strlcpy(tempfile, realfile, sizeof(tempfile)); 2544 strlcat(tempfile, ".zXXXXXX", sizeof(tempfile)); 2545 if (noaction) 2546 printf("\tmktemp %s\n", tempfile); 2547 else { 2548 fd = mkstemp(tempfile); 2549 if (fd < 0) 2550 err(1, "can't mkstemp logfile %s", tempfile); 2551 2552 /* 2553 * Add status message to what will become the new log file. 2554 */ 2555 if (!(ent->flags & CE_BINARY)) { 2556 if (log_trim(tempfile, ent)) 2557 err(1, "can't add status message to log"); 2558 } 2559 } 2560 2561 /* Change the owner/group, if we are supposed to */ 2562 if (ent->uid != (uid_t)-1 || ent->gid != (gid_t)-1) { 2563 if (noaction) 2564 printf("\tchown %u:%u %s\n", ent->uid, ent->gid, 2565 tempfile); 2566 else { 2567 failed = fchown(fd, ent->uid, ent->gid); 2568 if (failed) 2569 err(1, "can't fchown temp file %s", tempfile); 2570 } 2571 } 2572 2573 /* Turn on NODUMP if it was requested in the config-file. */ 2574 if (ent->flags & CE_NODUMP) { 2575 if (noaction) 2576 printf("\tchflags nodump %s\n", tempfile); 2577 else { 2578 failed = fchflags(fd, UF_NODUMP); 2579 if (failed) { 2580 warn("log_trim: fchflags(NODUMP)"); 2581 } 2582 } 2583 } 2584 2585 /* 2586 * Note that if the real logfile still exists, and if the call 2587 * to rename() fails, then "neither the old file nor the new 2588 * file shall be changed or created" (to quote the standard). 2589 * If the call succeeds, then the file will be replaced without 2590 * any window where some other process might find that the file 2591 * did not exist. 2592 * XXX - ? It may be that for some error conditions, we could 2593 * retry by first removing the realfile and then renaming. 2594 */ 2595 if (noaction) { 2596 printf("\tchmod %o %s\n", ent->permissions, tempfile); 2597 printf("\tmv %s %s\n", tempfile, realfile); 2598 } else { 2599 failed = fchmod(fd, ent->permissions); 2600 if (failed) 2601 err(1, "can't fchmod temp file '%s'", tempfile); 2602 failed = rename(tempfile, realfile); 2603 if (failed) 2604 err(1, "can't mv %s to %s", tempfile, realfile); 2605 } 2606 2607 if (fd >= 0) 2608 close(fd); 2609 } 2610 2611 /* 2612 * Change the attributes of a given filename to what was specified in 2613 * the newsyslog.conf entry. This routine is only called for files 2614 * that newsyslog expects that it has created, and thus it is a fatal 2615 * error if this routine finds that the file does not exist. 2616 */ 2617 static void 2618 change_attrs(const char *fname, const struct conf_entry *ent) 2619 { 2620 int failed; 2621 2622 if (noaction) { 2623 printf("\tchmod %o %s\n", ent->permissions, fname); 2624 2625 if (ent->uid != (uid_t)-1 || ent->gid != (gid_t)-1) 2626 printf("\tchown %u:%u %s\n", 2627 ent->uid, ent->gid, fname); 2628 2629 if (ent->flags & CE_NODUMP) 2630 printf("\tchflags nodump %s\n", fname); 2631 return; 2632 } 2633 2634 failed = chmod(fname, ent->permissions); 2635 if (failed) { 2636 if (errno != EPERM) 2637 err(1, "chmod(%s) in change_attrs", fname); 2638 warn("change_attrs couldn't chmod(%s)", fname); 2639 } 2640 2641 if (ent->uid != (uid_t)-1 || ent->gid != (gid_t)-1) { 2642 failed = chown(fname, ent->uid, ent->gid); 2643 if (failed) 2644 warn("can't chown %s", fname); 2645 } 2646 2647 if (ent->flags & CE_NODUMP) { 2648 failed = chflags(fname, UF_NODUMP); 2649 if (failed) 2650 warn("can't chflags %s NODUMP", fname); 2651 } 2652 } 2653