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