2 * ------+---------+---------+-------- + --------+---------+---------+---------*
3 * This file includes significant modifications done by:
4 * Copyright (c) 2003, 2004 - Garance Alistair Drosehn <gad@FreeBSD.org>.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
28 * ------+---------+---------+-------- + --------+---------+---------+---------*
32 * This file contains changes from the Open Software Foundation.
36 * Copyright 1988, 1989 by the Massachusetts Institute of Technology
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
52 * newsyslog - roll over selected logs at the appropriate time, keeping the a
53 * specified number of backup files around.
56 #include <sys/cdefs.h>
57 __FBSDID("$FreeBSD$");
61 #include <sys/param.h>
62 #include <sys/queue.h>
85 #include "pathnames.h"
89 * Compression suffixes
91 #ifndef COMPRESS_SUFFIX_GZ
92 #define COMPRESS_SUFFIX_GZ ".gz"
95 #ifndef COMPRESS_SUFFIX_BZ2
96 #define COMPRESS_SUFFIX_BZ2 ".bz2"
99 #ifndef COMPRESS_SUFFIX_XZ
100 #define COMPRESS_SUFFIX_XZ ".xz"
103 #define COMPRESS_SUFFIX_MAXLEN MAX(MAX(sizeof(COMPRESS_SUFFIX_GZ),sizeof(COMPRESS_SUFFIX_BZ2)),sizeof(COMPRESS_SUFFIX_XZ))
108 #define COMPRESS_TYPES 4 /* Number of supported compression types */
110 #define COMPRESS_NONE 0
111 #define COMPRESS_GZIP 1
112 #define COMPRESS_BZIP2 2
113 #define COMPRESS_XZ 3
116 * Bit-values for the 'flags' parsed from a config-file entry.
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.*/
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 */
133 #define kbytes(size) (((size) + 1023) >> 10)
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"
140 #define MAX_OLDLOGS 65536 /* Default maximum number of old logfiles */
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 */
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 */
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 */
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 */
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 */
194 struct include_entry {
195 STAILQ_ENTRY(include_entry) inc_nextp;
196 const char *file; /* Name of file to process */
199 struct oldlog_entry {
200 char *fname; /* Filename of the log file */
201 time_t t; /* Parsed timestamp of the logfile */
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);
215 int dbg_at_times; /* -D Show details of 'trim_at' code */
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 */
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 */
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 */
246 static const char *path_syslogpid = _PATH_SYSLOGPID;
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);
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.
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))
295 main(int argc, char **argv)
297 struct cflist *worklist;
298 struct conf_entry *p;
299 struct sigwork_entry *stmp;
300 struct zipwork_entry *ztmp;
305 parse_args(argc, argv);
309 if (needroot && getuid() && geteuid())
310 errx(1, "must have root privs");
311 worklist = get_worklist(argv);
314 * Rotate all the files which need to be rotated. Note that
315 * some users have *hundreds* of entries in newsyslog.conf!
317 while (!STAILQ_EMPTY(worklist)) {
318 p = STAILQ_FIRST(worklist);
319 STAILQ_REMOVE_HEAD(worklist, cf_nextp);
320 if (do_entry(p) == FREE_ENT)
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.
330 if (!SLIST_EMPTY(&swhead)) {
331 if (noaction || verbose)
332 printf("Signal all daemon process(es)...\n");
333 SLIST_FOREACH(stmp, &swhead, sw_nextp)
336 printf("\tsleep 10\n");
339 printf("Pause 10 seconds to allow daemon(s)"
340 " to close log file(s)\n");
345 * Compress all files that we're expected to compress, now
346 * that all processes should have closed the files which
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);
355 SLIST_REMOVE_HEAD(&zwhead, zw_nextp);
359 /* Now free all the sigwork entries. */
360 while (!SLIST_EMPTY(&swhead)) {
361 stmp = SLIST_FIRST(&swhead);
362 SLIST_REMOVE_HEAD(&swhead, sw_nextp);
366 while (wait(NULL) > 0 || errno == EINTR)
371 static struct conf_entry *
372 init_entry(const char *fname, struct conf_entry *src_entry)
374 struct conf_entry *tempwork;
377 printf("\t--> [creating entry for %s]\n", fname);
379 tempwork = malloc(sizeof(struct conf_entry));
380 if (tempwork == NULL)
381 err(1, "malloc of conf_entry for %s", fname);
383 if (destdir == NULL || fname[0] != '/')
384 tempwork->log = strdup(fname);
386 asprintf(&tempwork->log, "%s%s", destdir, fname);
387 if (tempwork->log == NULL)
388 err(1, "strdup for %s", fname);
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;
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;
426 tempwork->compress = COMPRESS_NONE;
427 tempwork->sig = SIGHUP;
428 tempwork->def_cfg = 0;
435 free_entry(struct conf_entry *ent)
441 if (ent->log != NULL) {
443 printf("\t--> [freeing entry for %s]\n", ent->log);
448 if (ent->pid_cmd_file != NULL) {
449 free(ent->pid_cmd_file);
450 ent->pid_cmd_file = NULL;
453 if (ent->r_reason != NULL) {
455 ent->r_reason = NULL;
458 if (ent->trim_at != NULL) {
459 ptime_free(ent->trim_at);
467 free_clist(struct cflist *list)
469 struct conf_entry *ent;
471 while (!STAILQ_EMPTY(list)) {
472 ent = STAILQ_FIRST(list);
473 STAILQ_REMOVE_HEAD(list, cf_nextp);
482 do_entry(struct conf_entry * ent)
484 #define REASON_MAX 80
486 fk_entry free_or_keep;
488 char temp_reason[REASON_MAX];
491 free_or_keep = FREE_ENT;
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);
499 ent->firstcreate = 0;
500 if (ent->fsize < 0) {
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.
507 temp_reason[0] = '\0';
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);
515 strlcpy(temp_reason, " (no C flag)", REASON_MAX);
517 if (ent->firstcreate) {
519 printf("does not exist -> will create.\n");
521 } else if (verbose) {
522 printf("does not exist, skipped%s.\n", temp_reason);
525 if (ent->flags & CE_TRIMAT && !force && !rotatereq &&
527 diffsecs = ptimeget_diff(timenow, ent->trim_at);
528 if (diffsecs < 0.0) {
529 /* trim_at is some time in the future. */
531 ptime_adjust4dst(ent->trim_at,
533 printf("--> will trim at %s",
534 ptimeget_ctime(ent->trim_at));
536 return (free_or_keep);
537 } else if (diffsecs >= 3600.0) {
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.
543 if (verbose && dbg_at_times)
544 printf("\n\t--> prev trim at %s\t",
545 ptimeget_ctime(ent->trim_at));
547 ptimeset_nxtime(ent->trim_at);
548 printf("--> will trim at %s",
549 ptimeget_ctime(ent->trim_at));
551 return (free_or_keep);
552 } else if (verbose && noaction && dbg_at_times) {
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.
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");
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);
572 * Figure out if this logfile needs to be rotated.
574 temp_reason[0] = '\0';
577 snprintf(temp_reason, REASON_MAX, " due to -R from %s",
581 snprintf(temp_reason, REASON_MAX, " due to -F request");
582 } else if (oversized) {
584 snprintf(temp_reason, REASON_MAX, " due to size>%dK",
586 } else if (ent->hours <= 0 && (ent->flags & CE_TRIMAT)) {
588 } else if ((ent->hours > 0) && ((modtime >= ent->hours) ||
594 * If the file needs to be rotated, then rotate it.
596 if (ent->rotate && !norotate) {
597 if (temp_reason[0] != '\0')
598 ent->r_reason = strdup(temp_reason);
600 printf("--> trimming log....\n");
601 if (noaction && !verbose)
602 printf("%s <%d%s>: trimming\n", ent->log,
604 compress_type[ent->compress].flag);
605 free_or_keep = do_rotate(ent);
608 printf("--> skipping\n");
611 return (free_or_keep);
616 parse_args(int argc, char **argv)
621 timenow = ptime_init(NULL);
622 ptimeset_time(timenow, time(NULL));
623 strlcpy(daytime, ptimeget_ctime(timenow) + 4, DAYTIME_LEN);
625 /* Let's get our hostname */
626 (void)gethostname(hostname, sizeof(hostname));
628 /* Truncate domain */
629 if ((p = strchr(hostname, '.')) != NULL)
632 /* Parse command line options. */
633 while ((ch = getopt(argc, argv, "a:d:f:nrst:vCD:FNPR:S:")) != -1)
637 archdirname = optarg;
655 if (optarg[0] == '\0' ||
656 strcmp(optarg, "DEFAULT") == 0)
657 timefnamefmt = strdup(DEFAULT_TIMEFNAME_FMT);
659 timefnamefmt = strdup(optarg);
665 /* Useful for things like rc.diskless... */
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.
674 if (parse_doption(optarg))
689 requestor = strdup(optarg);
692 path_syslogpid = optarg;
694 case 'm': /* Used by OpenBSD for "monitor mode" */
700 if (force && norotate) {
701 warnx("Only one of -F and -N may be specified.");
707 if (optind == argc) {
708 warnx("At least one filename must be given when -R is specified.");
712 /* Make sure "requestor" value is safe for a syslog message. */
713 for (p = requestor; *p != '\0'; p++) {
714 if (!isprintch(*p) && (*p != '\t'))
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.
727 timenow = dbg_timenow;
728 fprintf(stderr, "Debug: Running as if TimeNow is %s",
729 ptimeget_ctime(dbg_timenow));
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...
740 parse_doption(const char *doption)
742 const char TN[] = "TN=";
745 if (strncmp(doption, TN, sizeof(TN) - 1) == 0) {
747 * The "TimeNow" debugging option. This might be off
748 * by an hour when crossing a timezone change.
750 dbg_timenow = ptime_init(NULL);
751 res = ptime_relparse(dbg_timenow, PTM_PARSE_ISO8601,
752 time(NULL), doption + sizeof(TN) - 1);
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 */
760 return (1); /* successfully parsed */
764 if (strcmp(doption, "ats") == 0) {
766 return (1); /* successfully parsed */
769 /* XXX - This check could probably be dropped. */
770 if ((strcmp(doption, "neworder") == 0) || (strcmp(doption, "oldorder")
772 warnx("NOTE: newsyslog always uses 'neworder'.");
773 return (1); /* successfully parsed */
776 warnx("Unknown -D (debug) option: '%s'", doption);
777 return (0); /* failure */
785 "usage: newsyslog [-CFNPnrsv] [-a directory] [-d directory] [-f config_file]\n"
786 " [-S pidfile] [-t timefmt] [[-R tagname] file ...]\n");
791 * Parse a configuration file and return a linked list of all the logs
792 * which should be processed.
794 static struct cflist *
795 get_worklist(char **files)
799 struct cflist *cmdlist, *filelist, *globlist;
800 struct conf_entry *defconf, *dupent, *ent;
801 struct ilist inclist;
802 struct include_entry *inc;
806 STAILQ_INIT(&inclist);
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);
817 inc = malloc(sizeof(struct include_entry));
819 err(1, "malloc of inc");
821 if (inc->file == NULL)
822 inc->file = _PATH_CONF;
823 STAILQ_INSERT_TAIL(&inclist, inc, inc_nextp);
825 STAILQ_FOREACH(inc, &inclist, inc_nextp) {
826 if (strcmp(inc->file, "-") != 0)
827 f = fopen(inc->file, "r");
830 inc->file = "<stdin>";
833 err(1, "%s", inc->file);
836 printf("Processing %s\n", inc->file);
837 parse_file(f, filelist, globlist, defconf, &inclist);
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.
848 if (*files == NULL) {
849 expand_globs(filelist, globlist);
850 free_clist(globlist);
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.
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;
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.
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.
883 cmdlist = malloc(sizeof(struct cflist));
885 err(1, "malloc of cmdlist");
886 STAILQ_INIT(cmdlist);
888 for (given = files; *given; ++given) {
890 * First try to find exact-matches for this given file.
893 STAILQ_FOREACH(ent, filelist, cf_nextp) {
894 if (strcmp(ent->log, *given) == 0) {
896 dupent = init_entry(*given, ent);
897 STAILQ_INSERT_TAIL(cmdlist, dupent, cf_nextp);
902 printf("\t+ Matched entry %s\n", *given);
907 * There was no exact-match for this given file, so look
908 * for a "glob" entry which does match.
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);
916 printf("\t+ = %d for pattern %s\n", fnres,
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 */
930 printf("\t+ Matched %s via %s\n", *given,
936 * This given file was not found in any config file, so
937 * add a worklist item based on the default entry.
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 */
945 STAILQ_INSERT_TAIL(cmdlist, dupent, cf_nextp);
949 * Free all the entries in the original work list, the list of
950 * glob entries, and the default entry.
952 free_clist(filelist);
953 free_clist(globlist);
956 /* And finally, return a worklist which matches the given files. */
961 * Expand the list of entries with filename patterns, and add all files
962 * which match those glob-entries onto the worklist.
965 expand_globs(struct cflist *work_p, struct cflist *glob_p)
970 struct conf_entry *dupent, *ent, *globent;
975 * The worklist contains all fully-specified (non-GLOB) names.
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.
982 STAILQ_FOREACH(globent, glob_p, cf_nextp) {
983 gres = glob(globent->log, GLOB_NOCHECK, NULL, &pglob);
985 warn("cannot expand pattern (%d): %s", gres,
991 printf("\t+ Expanding pattern %s\n", globent->log);
992 for (i = 0; i < pglob.gl_matchc; i++) {
993 mfname = pglob.gl_pathv[i];
995 /* See if this file already has a specific entry. */
997 STAILQ_FOREACH(ent, work_p, cf_nextp) {
998 if (strcmp(mfname, ent->log) == 0) {
1006 /* Make sure the named matched is a file. */
1007 gres = lstat(mfname, &st_fm);
1009 /* Error on a file that glob() matched?!? */
1010 warn("Skipping %s - lstat() error", mfname);
1013 if (!S_ISREG(st_fm.st_mode)) {
1014 /* We only rotate files! */
1016 printf("\t+ . skipping %s (!file)\n",
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;
1027 /* Add to the worklist. */
1028 STAILQ_INSERT_TAIL(work_p, dupent, cf_nextp);
1032 printf("\t+ Done with pattern %s\n", globent->log);
1037 * Parse a configuration file and update a linked list of all the logs to
1041 parse_file(FILE *cf, struct cflist *work_p, struct cflist *glob_p,
1042 struct conf_entry *defconf_p, struct ilist *inclist)
1044 char line[BUFSIZ], *parse, *q;
1045 char *cp, *errline, *group;
1046 struct conf_entry *working;
1050 int eol, ptm_opts, res, special;
1054 while (fgets(line, BUFSIZ, cf)) {
1055 if ((line[0] == '\n') || (line[0] == '#') ||
1056 (strlen(line) == 0))
1058 if (errline != NULL)
1060 errline = strdup(line);
1061 for (cp = line + 1; *cp != '\0'; cp++) {
1064 if (*(cp - 1) == '\\') {
1073 q = parse = missing_field(sob(line), errline);
1076 errx(1, "malformed line (missing fields):\n%s",
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).
1085 if (strcasecmp(DEBUG_MARKER, q) == 0) {
1086 q = parse = missing_field(sob(++parse), errline);
1089 warnx("debug line specifies no option:\n%s",
1096 } else if (strcasecmp(INCLUDE_MARKER, q) == 0) {
1098 printf("Found: %s", errline);
1099 q = parse = missing_field(sob(++parse), errline);
1102 warnx("include line missing argument:\n%s",
1110 res = glob(q, GLOB_NOCHECK, NULL, &pglob);
1112 warn("cannot expand pattern (%d): %s",
1118 printf("\t+ Expanding pattern %s\n", q);
1120 for (i = 0; i < pglob.gl_matchc; i++)
1121 add_to_queue(pglob.gl_pathv[i],
1125 add_to_queue(q, inclist);
1130 working = init_entry(q, NULL);
1131 if (strcasecmp(DEFAULT_MARKER, q) == 0) {
1133 if (defconf_p != NULL) {
1134 warnx("Ignoring duplicate entry for %s!", q);
1135 free_entry(working);
1138 defconf_p = working;
1141 q = parse = missing_field(sob(++parse), errline);
1144 errx(1, "malformed line (missing fields):\n%s",
1147 if ((group = strchr(q, ':')) != NULL ||
1148 (group = strrchr(q, '.')) != NULL) {
1151 if (!(isnumberstr(q))) {
1152 if ((pwd = getpwnam(q)) == NULL)
1154 "error in config file; unknown user:\n%s",
1156 working->uid = pwd->pw_uid;
1158 working->uid = atoi(q);
1160 working->uid = (uid_t)-1;
1164 if (!(isnumberstr(q))) {
1165 if ((grp = getgrnam(q)) == NULL)
1167 "error in config file; unknown group:\n%s",
1169 working->gid = grp->gr_gid;
1171 working->gid = atoi(q);
1173 working->gid = (gid_t)-1;
1175 q = parse = missing_field(sob(++parse), errline);
1178 errx(1, "malformed line (missing fields):\n%s",
1182 working->uid = (uid_t)-1;
1183 working->gid = (gid_t)-1;
1186 if (!sscanf(q, "%o", &working->permissions))
1187 errx(1, "error in config file; bad permissions:\n%s",
1190 q = parse = missing_field(sob(++parse), errline);
1193 errx(1, "malformed line (missing fields):\n%s",
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",
1200 q = parse = missing_field(sob(++parse), errline);
1203 errx(1, "malformed line (missing fields):\n%s",
1207 working->trsize = atoi(q);
1208 else if (strcmp(q, "*") == 0)
1209 working->trsize = -1;
1211 warnx("Invalid value of '%s' for 'size' in line:\n%s",
1213 working->trsize = -1;
1217 working->compress = COMPRESS_NONE;
1218 q = parse = missing_field(sob(++parse), errline);
1226 ul = strtoul(q, &ep, 10);
1229 else if (*ep == '*')
1230 working->hours = -1;
1231 else if (ul > INT_MAX)
1232 errx(1, "interval is too large:\n%s", errline);
1234 working->hours = ul;
1236 if (*ep == '\0' || strcmp(ep, "*") == 0)
1238 if (*ep != '@' && *ep != '$')
1239 errx(1, "malformed interval/at:\n%s", errline);
1241 working->flags |= CE_TRIMAT;
1242 working->trim_at = ptime_init(NULL);
1243 ptm_opts = PTM_PARSE_ISO8601;
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);
1250 errx(1, "nonexistent time for 'at' value:\n%s",
1253 errx(1, "malformed 'at' value:\n%s", errline);
1260 q = parse = sob(++parse); /* Optional field */
1267 for (; q && *q && !isspacech(*q); q++) {
1268 switch (tolowerch(*q)) {
1270 working->flags |= CE_BINARY;
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.
1281 warnx("Assuming 'g' for 'c' in flags for line:\n%s",
1283 warnx("The 'c' flag will eventually mean 'CREATE'");
1284 working->flags |= CE_GLOB;
1287 working->flags |= CE_CREATE;
1290 working->flags |= CE_NODUMP;
1293 working->flags |= CE_GLOB;
1296 working->compress = COMPRESS_BZIP2;
1299 working->flags |= CE_NOSIGNAL;
1302 working->flags |= CE_PID2CMD;
1305 working->flags |= CE_SIGNALGROUP;
1308 /* Depreciated flag - keep for compatibility purposes */
1311 working->compress = COMPRESS_XZ;
1314 working->compress = COMPRESS_GZIP;
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" */
1322 errx(1, "illegal flag in config file -- %c",
1330 q = parse = sob(++parse); /* Optional field */
1337 working->pid_cmd_file = NULL;
1340 working->pid_cmd_file = strdup(q);
1341 else if (isdigit(*q))
1345 "illegal pid file or signal number in config file:\n%s",
1351 q = parse = sob(++parse); /* Optional field */
1352 *(parse = son(parse)) = '\0';
1355 working->sig = SIGHUP;
1359 working->sig = atoi(q);
1363 "illegal signal number in config file:\n%s",
1366 if (working->sig < 1 || working->sig >= NSIG)
1371 * Finish figuring out what pid-file to use (if any) in
1372 * later processing if this logfile needs to be rotated.
1374 if ((working->flags & CE_NOSIGNAL) == CE_NOSIGNAL) {
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.
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;
1386 } else if (working->pid_cmd_file == NULL) {
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
1395 if (working->flags & CE_SIGNALGROUP) {
1396 warnx("Ignoring flag 'U' in line:\n%s",
1398 working->flags &= ~CE_SIGNALGROUP;
1401 working->pid_cmd_file = strdup(path_syslogpid);
1405 * Add this entry to the appropriate list of entries, unless
1406 * it was some kind of special entry (eg: <default>).
1409 ; /* Do not add to any list */
1410 } else if (working->flags & CE_GLOB) {
1411 STAILQ_INSERT_TAIL(glob_p, working, cf_nextp);
1413 STAILQ_INSERT_TAIL(work_p, working, cf_nextp);
1416 if (errline != NULL)
1421 missing_field(char *p, char *errline)
1425 errx(1, "missing field in config file:\n%s", errline);
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.
1434 * Support function for qsort() in delete_oldest_timelog().
1437 oldlog_entry_compare(const void *a, const void *b)
1439 const struct oldlog_entry *ola = a, *olb = b;
1441 if (ola->t > olb->t)
1443 else if (ola->t < olb->t)
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.
1455 validate_old_timelog(const struct dirent *dp, const char *logfname, struct tm *tm)
1457 size_t logfname_len;
1461 logfname_len = strlen(logfname);
1463 if (dp->d_type != DT_REG)
1465 /* Ignore everything but files with our logfile prefix. */
1466 if (strncmp(dp->d_name, logfname, logfname_len) != 0)
1468 /* Ignore the actual non-rotated logfile. */
1469 if (dp->d_namlen == logfname_len)
1473 * Make sure we created have found a logfile, so the
1474 * postfix is valid, IE format is: '.<time>(.[bgx]z)?'.
1476 if (dp->d_name[logfname_len] != '.') {
1478 printf("Ignoring %s which has unexpected "
1479 "extension '%s'\n", dp->d_name,
1480 &dp->d_name[logfname_len]);
1483 if ((s = strptime(&dp->d_name[logfname_len + 1],
1484 timefnamefmt, tm)) == NULL) {
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
1492 printf("Ignoring %s which does not "
1493 "match time format\n", dp->d_name);
1497 for (c = 0; c < COMPRESS_TYPES; c++)
1498 if (strcmp(s, compress_type[c].suffix) == 0)
1503 printf("Ignoring %s which has unexpected extension '%s'\n",
1510 * Delete the oldest logfiles, when using time based filenames.
1513 delete_oldest_timelog(const struct conf_entry *ent, const char *archive_dir)
1515 char *logfname, *s, *dir, errbuf[80];
1516 int dir_fd, i, logcnt, max_logcnt;
1517 struct oldlog_entry *oldlogs;
1523 oldlogs = malloc(MAX_OLDLOGS * sizeof(struct oldlog_entry));
1524 max_logcnt = MAX_OLDLOGS;
1527 if (archive_dir != NULL && archive_dir[0] != '\0')
1530 if ((cdir = dirname(ent->log)) == NULL)
1531 err(1, "dirname()");
1532 if ((dir = strdup(cdir)) == NULL)
1535 if ((s = basename(ent->log)) == NULL)
1536 err(1, "basename()");
1537 if ((logfname = strdup(s)) == NULL)
1539 if (strcmp(logfname, "/") == 0)
1540 errx(1, "Invalid log filename - became '/'");
1543 printf("Searching for old logs in %s\n", dir);
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)
1554 * We should now have old an old rotated logfile, so
1555 * add it to the 'list'.
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)
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...
1568 if (logcnt >= max_logcnt) {
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()");
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()");
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.
1592 qsort(oldlogs, logcnt, sizeof(struct oldlog_entry),
1593 oldlog_entry_compare);
1594 for (i = ent->numlogs - 1; i < logcnt; i++) {
1596 printf("\trm -f %s/%s\n", dir,
1598 else if (unlinkat(dir_fd, oldlogs[i].fname, 0) != 0) {
1599 snprintf(errbuf, sizeof(errbuf),
1600 "Could not delete old logfile '%s'",
1605 } else if (verbose > 1)
1606 printf("No old logs to delete for logfile %s\n", ent->log);
1608 /* Third, cleanup */
1610 for (i = 0; i < logcnt; i++) {
1611 assert(oldlogs[i].fname != NULL);
1612 free(oldlogs[i].fname);
1620 * Generate a log filename, when using classic filenames.
1623 gen_classiclog_fname(char *fname, size_t fname_sz, const char *archive_dir,
1624 const char *namepart, int numlogs_c)
1627 if (archive_dir[0] != '\0')
1628 (void) snprintf(fname, fname_sz, "%s/%s.%d", archive_dir,
1629 namepart, numlogs_c);
1631 (void) snprintf(fname, fname_sz, "%s.%d", namepart, numlogs_c);
1635 * Delete a rotated logfile, when using classic filenames.
1638 delete_classiclog(const char *archive_dir, const char *namepart, int numlog_c)
1640 char file1[MAXPATHLEN], zfile1[MAXPATHLEN];
1643 gen_classiclog_fname(file1, sizeof(file1), archive_dir, namepart,
1646 for (c = 0; c < COMPRESS_TYPES; c++) {
1647 (void) snprintf(zfile1, sizeof(zfile1), "%s%s", file1,
1648 compress_type[c].suffix);
1650 printf("\trm -f %s\n", zfile1);
1652 (void) unlink(zfile1);
1657 * Only add to the queue if the file hasn't already been added. This is
1658 * done to prevent circular include loops.
1661 add_to_queue(const char *fname, struct ilist *inclist)
1663 struct include_entry *inc;
1665 STAILQ_FOREACH(inc, inclist, inc_nextp) {
1666 if (strcmp(fname, inc->file) == 0) {
1667 warnx("duplicate include detected: %s", fname);
1672 inc = malloc(sizeof(struct include_entry));
1674 err(1, "malloc of inc");
1675 inc->file = strdup(fname);
1678 printf("\t+ Adding %s to the processing queue.\n", fname);
1680 STAILQ_INSERT_TAIL(inclist, inc, inc_nextp);
1684 * Search for logfile and return its compression suffix (if supported)
1685 * The suffix detection is first-match in the order of compress_types
1687 * Note: if logfile without suffix exists (uncompressed, COMPRESS_NONE)
1688 * a zero-length string is returned
1691 get_logfile_suffix(const char *logfile)
1694 char zfile[MAXPATHLEN];
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);
1707 do_rotate(const struct conf_entry *ent)
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;
1722 free_or_keep = FREE_ENT;
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)
1737 strlcat(dirpart, archdirname, sizeof(dirpart));
1740 /* check if archive directory exists, if not, create it */
1741 if (lstat(dirpart, &st))
1742 createdir(ent, dirpart);
1744 /* get filename part of logfile */
1745 if ((p = strrchr(ent->log, '/')) == NULL)
1746 strlcpy(namepart, ent->log, sizeof(namepart));
1748 strlcpy(namepart, p + 1, sizeof(namepart));
1751 * Tell utility functions we are not using an archive
1755 strlcpy(namepart, ent->log, sizeof(namepart));
1758 /* Delete old logs */
1759 if (timefnamefmt != NULL)
1760 delete_oldest_timelog(ent, dirpart);
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.
1767 delete_classiclog(dirpart, namepart, ent->numlogs);
1769 if (ent->numlogs > 0)
1770 delete_classiclog(dirpart, namepart, ent->numlogs - 1);
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));
1780 strftime(datetimestr, sizeof(datetimestr), timefnamefmt, &tm);
1782 (void) snprintf(file1, sizeof(file1), "%s/%s.%s",
1783 dirpart, namepart, datetimestr);
1785 (void) snprintf(file1, sizeof(file1), "%s.%s",
1786 ent->log, datetimestr);
1788 /* Don't run the code to move down logs */
1791 gen_classiclog_fname(file1, sizeof(file1), dirpart, namepart,
1793 numlogs_c = ent->numlogs - 2; /* copy for countdown */
1796 /* Move down log files */
1797 for (; numlogs_c >= 0; numlogs_c--) {
1798 (void) strlcpy(file2, file1, sizeof(file2));
1800 gen_classiclog_fname(file1, sizeof(file1), dirpart, namepart,
1803 logfile_suffix = get_logfile_suffix(file1);
1804 if (logfile_suffix == NULL)
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);
1812 printf("\tmv %s %s\n", zfile1, zfile2);
1814 /* XXX - Ought to be checking for failure! */
1815 (void)rename(zfile1, zfile2);
1817 change_attrs(zfile2, ent);
1820 if (ent->numlogs > 0) {
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...
1829 printf("\tcp %s %s\n", ent->log, file1);
1831 printf("\tln %s %s\n", ent->log, file1);
1832 printf("\ttouch %s\t\t"
1833 "# Update mtime for 'when'-interval processing\n",
1836 if (!(flags & CE_BINARY)) {
1837 /* Report the trimming to the old log */
1838 log_trim(ent->log, ent);
1840 savelog(ent->log, file1);
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.
1846 utimes(file1, NULL);
1848 change_attrs(file1, ent);
1851 /* Create the new log file and move it into place */
1853 printf("Start new log...\n");
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.
1863 if (ent->pid_cmd_file != NULL)
1864 swork = save_sigwork(ent);
1865 if (ent->numlogs > 0 && ent->compress > COMPRESS_NONE) {
1867 * The zipwork_entry will include a pointer to this
1868 * conf_entry, so the conf_entry should not be freed.
1870 free_or_keep = KEEP_ENT;
1871 save_zipwork(ent, swork, ent->fsize, file1);
1874 return (free_or_keep);
1878 do_sigwork(struct sigwork_entry *swork)
1880 struct sigwork_entry *nextsig;
1884 if (swork->sw_runcmd == 0 && (!(swork->sw_pidok) || swork->sw_pid == 0))
1885 return; /* no work to do... */
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).
1899 swork->sw_pidok = -1;
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.
1909 nextsig = SLIST_NEXT(swork, sw_nextp);
1910 if (nextsig != NULL) {
1911 if (swork->sw_pid == nextsig->sw_pid)
1918 if (swork->sw_runcmd)
1919 printf("\tsh -c '%s %d'\n", swork->sw_fname,
1922 printf("\tkill -%d %d \t\t# %s\n", swork->sw_signum,
1923 (int)swork->sw_pid, swork->sw_fname);
1925 printf("\tsleep %d\n", secs);
1930 if (swork->sw_runcmd) {
1931 asprintf(&tmp, "%s %d", swork->sw_fname, swork->sw_signum);
1933 warn("can't allocate memory to run %s",
1938 printf("Run command: %s\n", tmp);
1941 warnx("%s: returned non-zero exit code: %d",
1948 kres = kill(swork->sw_pid, swork->sw_signum);
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).
1958 swork->sw_pidok = 0;
1959 warn("can't notify %s, pid %d", swork->sw_pidtype,
1960 (int)swork->sw_pid);
1963 printf("Notified %s pid %d = %s\n", swork->sw_pidtype,
1964 (int)swork->sw_pid, swork->sw_fname);
1967 printf("Pause %d second(s) between signals\n",
1975 do_zipwork(struct zipwork_entry *zwork)
1977 const char *pgm_name, *pgm_path;
1978 int errsav, fcount, zstatus;
1980 char zresult[MAXPATHLEN];
1983 assert(zwork != 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));
1996 if (pgm_path == NULL) {
1997 warnx("invalid entry for %s in do_zipwork", zwork->zw_fname);
2000 pgm_name = strrchr(pgm_path, '/');
2001 if (pgm_name == NULL)
2002 pgm_name = pgm_path;
2006 if (zwork->zw_swork != NULL && zwork->zw_swork->sw_runcmd == 0 &&
2007 zwork->zw_swork->sw_pidok <= 0) {
2009 "log %s not compressed because daemon(s) not notified",
2011 change_attrs(zwork->zw_fname, zwork->zw_conf);
2016 printf("\t%s %s\n", pgm_name, zwork->zw_fname);
2017 change_attrs(zresult, zwork->zw_conf);
2023 while (pidzip < 0) {
2025 * The fork failed. If the failure was due to a temporary
2026 * problem, then wait a short time and try it again.
2029 warn("fork() for `%s %s'", pgm_name, zwork->zw_fname);
2030 if (errsav != EAGAIN || fcount > 5)
2031 errx(1, "Exiting...");
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);
2042 wpid = waitpid(pidzip, &zstatus, 0);
2044 /* XXX - should this be a fatal error? */
2045 warn("%s: waitpid(%d)", pgm_path, pidzip);
2048 if (!WIFEXITED(zstatus)) {
2049 warnx("`%s -f %s' did not terminate normally", pgm_name,
2053 if (WEXITSTATUS(zstatus)) {
2054 warnx("`%s -f %s' terminated with a non-zero status (%d)",
2055 pgm_name, zwork->zw_fname, WEXITSTATUS(zstatus));
2059 /* Compression was successful, set file attributes on the result. */
2060 change_attrs(zresult, zwork->zw_conf);
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.
2069 static struct sigwork_entry *
2070 save_sigwork(const struct conf_entry *ent)
2072 struct sigwork_entry *sprev, *stmp;
2078 SLIST_FOREACH(stmp, &swhead, sw_nextp) {
2079 ndiff = strcmp(ent->pid_cmd_file, stmp->sw_fname);
2083 if (ent->sig == stmp->sw_signum)
2085 if (ent->sig > stmp->sw_signum) {
2092 if (stmp != NULL && ndiff == 0)
2095 tmpsiz = sizeof(struct sigwork_entry) + strlen(ent->pid_cmd_file) + 1;
2096 stmp = malloc(tmpsiz);
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) {
2103 stmp->sw_runcmd = 1;
2105 set_swpid(stmp, ent);
2107 stmp->sw_signum = ent->sig;
2108 strcpy(stmp->sw_fname, ent->pid_cmd_file);
2110 SLIST_INSERT_HEAD(&swhead, stmp, sw_nextp);
2112 SLIST_INSERT_AFTER(sprev, stmp, sw_nextp);
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.
2124 static struct zipwork_entry *
2125 save_zipwork(const struct conf_entry *ent, const struct sigwork_entry *swork,
2126 int zsize, const char *zipfname)
2128 struct zipwork_entry *zprev, *ztmp;
2132 /* Compute the size if the caller did not know it. */
2134 zsize = sizefile(zipfname);
2138 SLIST_FOREACH(ztmp, &zwhead, zw_nextp) {
2139 ndiff = strcmp(zipfname, ztmp->zw_fname);
2142 if (zsize > ztmp->zw_fsize)
2145 if (ztmp != NULL && ndiff == 0)
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);
2155 SLIST_INSERT_HEAD(&zwhead, ztmp, zw_nextp);
2157 SLIST_INSERT_AFTER(zprev, ztmp, zw_nextp);
2161 /* Send a signal to the pid specified by pidfile */
2163 set_swpid(struct sigwork_entry *swork, const struct conf_entry *ent)
2166 long minok, maxok, rval;
2167 char *endp, *linep, line[BUFSIZ];
2171 swork->sw_pidok = 0;
2173 swork->sw_pidtype = "daemon";
2174 if (ent->flags & CE_SIGNALGROUP) {
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.
2182 swork->sw_pidtype = "process-group";
2185 f = fopen(ent->pid_cmd_file, "r");
2187 if (errno == ENOENT && enforcepid == 0) {
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.
2195 swork->sw_pidok = 1;
2196 warnx("pid file doesn't exist: %s", ent->pid_cmd_file);
2198 warn("can't open pid file: %s", ent->pid_cmd_file);
2202 if (fgets(line, BUFSIZ, f) == NULL) {
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.
2209 if (feof(f) && enforcepid == 0) {
2210 swork->sw_pidok = 1;
2211 warnx("pid/cmd file is empty: %s", ent->pid_cmd_file);
2213 warn("can't read from pid file: %s", ent->pid_cmd_file);
2221 while (*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",
2227 } else if (rval < minok || rval > maxok) {
2228 warnx("bad value '%ld' for process number in %s",
2229 rval, ent->pid_cmd_file);
2231 warnx("\t(expecting value between %ld and %ld)",
2234 swork->sw_pidok = 1;
2235 swork->sw_pid = rval;
2241 /* Log the fact that the logs were turned over */
2243 log_trim(const char *logname, const struct conf_entry *log_ent)
2248 if ((f = fopen(logname, "a")) == NULL)
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);
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");
2267 /* Return size in kilobytes of a file */
2269 sizefile(const char *file)
2273 if (stat(file, &sb) < 0)
2275 return (kbytes(dbtob(sb.st_blocks)));
2279 * Return the mtime of the most recent archive of the logfile, using timestamp
2283 mtime_old_timelog(const char *file)
2291 char *s, *logfname, *dir;
2295 if ((dir = dirname(file)) == NULL) {
2296 warn("dirname() of '%s'", file);
2299 if ((s = basename(file)) == NULL) {
2300 warn("basename() of '%s'", file);
2302 } else if (s[0] == '/') {
2303 warnx("Invalid log filename '%s'", s);
2305 } else if ((logfname = strdup(s)) == NULL)
2308 if ((dirp = opendir(dir)) == NULL) {
2309 warn("Cannot open log directory '%s'", dir);
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)
2318 if (fstatat(dir_fd, logfname, &sb, 0) == -1) {
2319 warn("Cannot stat '%s'", file);
2322 if (t < sb.st_mtime)
2330 /* Return the age in hours of the most recent archive of the logfile. */
2332 age_old_log(const char *file)
2335 const char *logfile_suffix;
2336 char tmp[MAXPATHLEN + sizeof(".0") + COMPRESS_SUFFIX_MAXLEN + 1];
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)
2352 strlcat(tmp, archdirname, sizeof(tmp));
2355 strlcat(tmp, "/", sizeof(tmp));
2357 /* get filename part of logfile */
2358 if ((p = strrchr(file, '/')) == NULL)
2359 strlcat(tmp, file, sizeof(tmp));
2361 strlcat(tmp, p + 1, sizeof(tmp));
2363 (void) strlcpy(tmp, file, sizeof(tmp));
2366 if (timefnamefmt != NULL) {
2367 mtime = mtime_old_timelog(tmp);
2371 strlcat(tmp, ".0", sizeof(tmp));
2372 logfile_suffix = get_logfile_suffix(tmp);
2373 if (logfile_suffix == NULL)
2375 (void) strlcat(tmp, logfile_suffix, sizeof(tmp));
2376 if (stat(tmp, &sb) < 0)
2378 mtime = sb.st_mtime;
2381 return ((int)(ptimeget_secs(timenow) - mtime + 1800) / 3600);
2384 /* Skip Over Blanks */
2388 while (p && *p && isspace(*p))
2393 /* Skip Over Non-Blanks */
2397 while (p && *p && !isspace(*p))
2402 /* Check if string is actually a number */
2404 isnumberstr(const char *string)
2407 if (!isdigitch(*string++))
2413 /* Check if string contains a glob */
2415 isglobstr(const char *string)
2419 while ((chr = *string++)) {
2420 if (chr == '*' || chr == '?' || chr == '[')
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.
2433 savelog(char *from, char *to)
2438 res = link(from, to);
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);
2447 while ((c = getc(src)) != EOF) {
2448 if ((putc(c, dst)) == EOF)
2449 err(1, "error writing to %s", to);
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);
2460 /* create one or more directory components of a path */
2462 createdir(const struct conf_entry *ent, char *dirpart)
2466 char mkdirpath[MAXPATHLEN];
2474 if (*s != '/' && *s != '\0')
2477 res = lstat(mkdirpath, &st);
2480 printf("\tmkdir %s\n", mkdirpath);
2482 res = mkdir(mkdirpath, 0755);
2484 err(1, "Error on mkdir(\"%s\") for -a",
2492 if (ent->firstcreate)
2493 printf("Created directory '%s' for new %s\n",
2496 printf("Created directory '%s' for -a\n", dirpart);
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.
2507 createlog(const struct conf_entry *ent)
2511 char *realfile, *slash, tempfile[MAXPATHLEN];
2514 realfile = ent->log;
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.
2521 if (ent->firstcreate) {
2522 strlcpy(tempfile, realfile, sizeof(tempfile));
2523 slash = strrchr(tempfile, '/');
2524 if (slash != NULL) {
2526 failed = stat(tempfile, &st);
2527 if (failed && errno != ENOENT)
2528 err(1, "Error on stat(%s)", tempfile);
2530 createdir(ent, tempfile);
2531 else if (!S_ISDIR(st.st_mode))
2532 errx(1, "%s exists but is not a directory",
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>'.
2543 strlcpy(tempfile, realfile, sizeof(tempfile));
2544 strlcat(tempfile, ".zXXXXXX", sizeof(tempfile));
2546 printf("\tmktemp %s\n", tempfile);
2548 fd = mkstemp(tempfile);
2550 err(1, "can't mkstemp logfile %s", tempfile);
2553 * Add status message to what will become the new log file.
2555 if (!(ent->flags & CE_BINARY)) {
2556 if (log_trim(tempfile, ent))
2557 err(1, "can't add status message to log");
2561 /* Change the owner/group, if we are supposed to */
2562 if (ent->uid != (uid_t)-1 || ent->gid != (gid_t)-1) {
2564 printf("\tchown %u:%u %s\n", ent->uid, ent->gid,
2567 failed = fchown(fd, ent->uid, ent->gid);
2569 err(1, "can't fchown temp file %s", tempfile);
2573 /* Turn on NODUMP if it was requested in the config-file. */
2574 if (ent->flags & CE_NODUMP) {
2576 printf("\tchflags nodump %s\n", tempfile);
2578 failed = fchflags(fd, UF_NODUMP);
2580 warn("log_trim: fchflags(NODUMP)");
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
2592 * XXX - ? It may be that for some error conditions, we could
2593 * retry by first removing the realfile and then renaming.
2596 printf("\tchmod %o %s\n", ent->permissions, tempfile);
2597 printf("\tmv %s %s\n", tempfile, realfile);
2599 failed = fchmod(fd, ent->permissions);
2601 err(1, "can't fchmod temp file '%s'", tempfile);
2602 failed = rename(tempfile, realfile);
2604 err(1, "can't mv %s to %s", tempfile, realfile);
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.
2618 change_attrs(const char *fname, const struct conf_entry *ent)
2623 printf("\tchmod %o %s\n", ent->permissions, fname);
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);
2629 if (ent->flags & CE_NODUMP)
2630 printf("\tchflags nodump %s\n", fname);
2634 failed = chmod(fname, ent->permissions);
2637 err(1, "chmod(%s) in change_attrs", fname);
2638 warn("change_attrs couldn't chmod(%s)", fname);
2641 if (ent->uid != (uid_t)-1 || ent->gid != (gid_t)-1) {
2642 failed = chown(fname, ent->uid, ent->gid);
2644 warn("can't chown %s", fname);
2647 if (ent->flags & CE_NODUMP) {
2648 failed = chflags(fname, UF_NODUMP);
2650 warn("can't chflags %s NODUMP", fname);