* limitations under the License.
*/
-/*
- * Simple program to rotate Apache logs without having to kill the server.
- *
- * Contributed by Ben Laurie <ben algroup.co.uk>
- *
- * 12 Mar 1996
- *
- * Ported to APR by Mladen Turk <mturk mappingsoft.com>
- *
- * 23 Sep 2001
- *
- * -l option added 2004-06-11
- *
- * -l causes the use of local time rather than GMT as the base for the
- * interval. NB: Using -l in an environment which changes the GMT offset
- * (such as for BST or DST) can lead to unpredictable results!
- *
- * -f option added Feb, 2008. This causes rotatelog to open/create
- * the logfile as soon as it's started, not as soon as it sees
- * data.
- *
- * -v option added Feb, 2008. Verbose output of command line parsing.
- */
-
-
#include "apr.h"
#include "apr_lib.h"
#include "apr_strings.h"
#include "apr_time.h"
#include "apr_getopt.h"
#include "apr_thread_proc.h"
+#include "apr_signal.h"
+#if APR_FILES_AS_SOCKETS
+#include "apr_poll.h"
+#endif
#if APR_HAVE_STDLIB_H
#include <stdlib.h>
#include "apr_want.h"
#define BUFSIZE 65536
-#define ERRMSGSZ 256
-
-#ifndef MAX_PATH
-#define MAX_PATH 1024
-#endif
#define ROTATE_NONE 0
#define ROTATE_NEW 1
#define ROTATE_SIZE 3
#define ROTATE_FORCE 4
-static const char *ROTATE_REASONS[] = {
+static const char *const ROTATE_REASONS[] = {
"None",
"Open a new file",
"Time interval expired",
int force_open;
int verbose;
int echo;
- const char *szLogRoot;
+ char *szLogRoot;
int truncate;
const char *linkfile;
const char *postrotate_prog;
+#if APR_FILES_AS_SOCKETS
+ int create_empty;
+#endif
+ int num_files;
+ int create_path;
};
typedef struct rotate_status rotate_status_t;
+/* "adjusted_time_t" is used to store Unix time (seconds since epoch)
+ * which has been adjusted for some timezone fudge factor. It should
+ * be used for storing the return values from get_now(). A typedef is
+ * used since this type is similar to time_t, but different. */
+typedef long adjusted_time_t;
+
/* Structure to contain relevant logfile state: fd, pool and
* filename. */
struct logfile {
apr_pool_t *pool;
apr_file_t *fd;
- char name[MAX_PATH];
+ char name[APR_PATH_MAX];
};
struct rotate_status {
struct logfile current; /* current logfile. */
apr_pool_t *pool; /* top-level pool */
- char errbuf[ERRMSGSZ];
int rotateReason;
- int tLogEnd;
+ adjusted_time_t tLogEnd;
int nMessCount;
+ int fileNum;
};
static rotate_config_t config;
fprintf(stderr, "%s\n", reason);
}
fprintf(stderr,
- "Usage: %s [-v] [-l] [-L linkname] [-p prog] [-f] [-t] [-e] <logfile> "
+#if APR_FILES_AS_SOCKETS
+ "Usage: %s [-v] [-l] [-L linkname] [-p prog] [-f] [-D] [-t] [-e] [-c] [-n number] <logfile> "
+#else
+ "Usage: %s [-v] [-l] [-L linkname] [-p prog] [-f] [-D] [-t] [-e] [-n number] <logfile> "
+#endif
"{<rotation time in seconds>|<rotation size>(B|K|M|G)} "
"[offset minutes from UTC]\n\n",
argv0);
" -L path Create hard link from current log to specified path.\n"
" -p prog Run specified program after opening a new log file. See below.\n"
" -f Force opening of log on program start.\n"
+ " -D Create parent directories of log file.\n"
" -t Truncate logfile instead of rotating, tail friendly.\n"
" -e Echo log to stdout for further processing.\n"
+#if APR_FILES_AS_SOCKETS
+ " -c Create log even if it is empty.\n"
+#endif
+ " -n num Rotate file by adding suffixes '.0', '.1', ..., '.(num-1)'.\n"
"\n"
- "The program is invoked as \"[prog] <curfile> [<prevfile>]\"\n"
+ "The program
for '-p' is invoked as \"[prog] <curfile> [<prevfile>]\"\n"
"where <curfile> is the filename of the newly opened logfile, and\n"
"<prevfile>, if given, is the filename of the previously used logfile.\n"
"\n");
exit(1);
}
-/*
- * Get the unix time with timezone corrections
- * given in the config struct.
- */
-static int get_now(rotate_config_t *config)
+/* This function returns the current Unix time (time_t) adjusted for
+ * any configured or derived local time offset. The offset applied is
+ * returned via *offset. */
+static adjusted_time_t get_now(rotate_config_t *config, apr_int32_t *offset)
{
apr_time_t tNow = apr_time_now();
- int utc_offset = config->utc_offset;
+ apr_int32_t utc_offset;
+
if (config->use_localtime) {
/* Check for our UTC offset before using it, since it might
* change if there's a switch between standard and daylight
apr_time_exp_lt(<, tNow);
utc_offset = lt.tm_gmtoff;
}
- return (int)apr_time_sec(tNow) + utc_offset;
+ else {
+ utc_offset = config->utc_offset;
+ }
+
+ if (offset)
+ *offset = utc_offset;
+
+ return apr_time_sec(tNow) + utc_offset;
}
/*
fprintf(stderr, "Rotation based on localtime: %12s\n", config->use_localtime ? "yes" : "no");
fprintf(stderr, "Rotation file date pattern: %12s\n", config->use_strftime ? "yes" : "no");
fprintf(stderr, "Rotation file forced open: %12s\n", config->force_open ? "yes" : "no");
+ fprintf(stderr, "Create parent directories: %12s\n", config->create_path ? "yes" : "no");
fprintf(stderr, "Rotation verbose: %12s\n", config->verbose ? "yes" : "no");
+#if APR_FILES_AS_SOCKETS
+ fprintf(stderr, "Rotation create empty logs: %12s\n", config->create_empty ? "yes" : "no");
+#endif
fprintf(stderr, "Rotation file name: %21s\n", config->szLogRoot);
- fprintf(stderr, "Post-rotation prog: %21s\n", config->postrotate_prog);
+ fprintf(stderr, "Post-rotation prog: %21s\n", config->postrotate_prog ? config->postrotate_prog : "not used");
}
/*
status->rotateReason = ROTATE_SIZE;
}
else if (config->tRotation) {
- if (get_now(config) >= status->tLogEnd) {
+ if (get_now(config, NULL) >= status->tLogEnd) {
status->rotateReason = ROTATE_TIME;
}
}
}
else if (config->tRotation) {
- if (get_now(config) >= status->tLogEnd) {
+ if (get_now(config, NULL) >= status->tLogEnd) {
status->rotateReason = ROTATE_TIME;
}
}
rotate_config_t *config, rotate_status_t *status)
{
apr_status_t rv;
- char error[120];
apr_procattr_t *pattr;
const char *argv[4];
apr_proc_t proc;
if (config->linkfile) {
apr_file_remove(config->linkfile, newlog->pool);
if (config->verbose) {
- fprintf(stderr,"Linking %s to %s\n", newlog->name, config->linkfile);
+ fprintf(stderr, "Linking %s to %s\n", newlog->name, config->linkfile);
}
rv = apr_file_link(newlog->name, config->linkfile);
if (rv != APR_SUCCESS) {
- char error[120];
- apr_strerror(rv, error, sizeof error);
- fprintf(stderr, "Error linking file %s to %s (%s)\n",
- newlog->name, config->linkfile, error);
+ char *error = apr_psprintf(pool, "Error linking file %s to %s (%pm)\n",
+ newlog->name, config->linkfile, &rv);
+ fputs(error, stderr);
exit(2);
}
}
-
+
if (!config->postrotate_prog) {
/* Nothing more to do. */
return;
/* noop */;
if ((rv = apr_procattr_create(&pattr, pool)) != APR_SUCCESS) {
- fprintf(stderr,
- "post_rotate: apr_procattr_create failed for '%s': %s\n",
- config->postrotate_prog,
- apr_strerror(rv, error, sizeof(error)));
+ char *error = apr_psprintf(pool, "post_rotate: apr_procattr_create failed " \
+ "for '%s': %pm\n", config->postrotate_prog, &rv);
+ fputs(error, stderr);
return;
}
rv = apr_procattr_cmdtype_set(pattr, APR_PROGRAM_ENV);
if (rv != APR_SUCCESS) {
- fprintf(stderr,
- "post_rotate: could not set up process attributes for '%s': %s\n",
- config->postrotate_prog,
- apr_strerror(rv, error, sizeof(error)));
+ char *error = apr_psprintf(pool, "post_rotate: could not set up process " \
+ "attributes for '%s': %pm\n", config->postrotate_prog,
+ &rv);
+ fputs(error, stderr);
return;
}
argv[0] = config->postrotate_prog;
argv[1] = newlog->name;
- if (status->current.name) {
+ if (status->current.fd) {
argv[2] = status->current.name;
argv[3] = NULL;
}
rv = apr_proc_create(&proc, argv[0], argv, NULL, pattr, pool);
if (rv != APR_SUCCESS) {
- fprintf(stderr, "Could not spawn post-rotate process '%s': %s\n",
- config->postrotate_prog,
- apr_strerror(rv, error, sizeof(error)));
+ char *error = apr_psprintf(pool, "Could not spawn post-rotate process " \
+ "'%s': %pm\n", config->postrotate_prog, &rv);
+ fputs(error, stderr);
return;
}
}
+/* After a error, truncate the current file and write out an error
+ * message, which must be contained in message. The process is
+ * terminated on failure. */
+static void truncate_and_write_error(rotate_status_t *status, const char *message)
+{
+ apr_size_t buflen = strlen(message);
+
+ if (apr_file_trunc(status->current.fd, 0) != APR_SUCCESS) {
+ fprintf(stderr, "Error truncating the file %s\n", status->current.name);
+ exit(2);
+ }
+ if (apr_file_write_full(status->current.fd, message, buflen, NULL) != APR_SUCCESS) {
+ fprintf(stderr, "Error writing error (%s) to the file %s\n",
+ message, status->current.name);
+ exit(2);
+ }
+}
+
/*
* Open a new log file, and if successful
* also close the old one.
*/
static void doRotate(rotate_config_t *config, rotate_status_t *status)
{
-
- int now = get_now(config);
- int tLogStart;
+ apr_int32_t offset;
+ adjusted_time_t now, tLogStart;
apr_status_t rv;
struct logfile newlog;
-
+ int thisLogNum = -1;
+
+ /* Retrieve local-time-adjusted-Unix-time. */
+ now = get_now(config, &offset);
+
status->rotateReason = ROTATE_NONE;
if (config->tRotation) {
- int tLogEnd;
+ adjusted_time_t tLogEnd;
+
tLogStart = (now / config->tRotation) * config->tRotation;
tLogEnd = tLogStart + config->tRotation;
/*
apr_time_exp_t e;
apr_size_t rs;
- apr_time_exp_gmt(&e, tNow);
+ /* Explode the local-time-adjusted-Unix-time into a struct tm,
+ * first *reversing* local-time-adjustment applied by
+ * get_now() if we are using localtime. */
+ if (config->use_localtime)
+ apr_time_exp_lt(&e, tNow - apr_time_from_sec(offset));
+ else
+ apr_time_exp_gmt(&e, tNow);
apr_strftime(newlog.name, &rs, sizeof(newlog.name), config->szLogRoot, &e);
}
else {
if (config->truncate) {
apr_snprintf(newlog.name, sizeof(newlog.name), "%s", config->szLogRoot);
}
+ else if (config->num_files > 0) {
+ if (status->fileNum == -1 || status->fileNum == (config->num_files - 1)) {
+ thisLogNum = 0;
+ apr_snprintf(newlog.name, sizeof(newlog.name), "%s", config->szLogRoot);
+ }
+ else {
+ thisLogNum = status->fileNum + 1;
+ apr_snprintf(newlog.name, sizeof(newlog.name), "%s.%d", config->szLogRoot, thisLogNum);
+ }
+ }
else {
- apr_snprintf(newlog.name, sizeof(newlog.name), "%s.%010d", config->szLogRoot,
+ apr_snprintf(newlog.name, sizeof(newlog.name), "%s.%010ld", config->szLogRoot,
tLogStart);
}
}
apr_pool_create(&newlog.pool, status->pool);
+ if (config->create_path) {
+ char *ptr = strrchr(newlog.name, '/');
+ if (ptr && ptr > newlog.name) {
+ char *path = apr_pstrmemdup(newlog.pool, newlog.name, ptr - newlog.name);
+ if (config->verbose) {
+ fprintf(stderr, "Creating directory tree %s\n", path);
+ }
+ rv = apr_dir_make_recursive(path, APR_FPROT_OS_DEFAULT, newlog.pool);
+ if (rv != APR_SUCCESS) {
+ char *error = apr_psprintf(newlog.pool,
+ "Could not create directory '%s' (%pm)\n",
+ path, &rv);
+ fputs(error, stderr);
+ exit(2);
+ }
+ }
+ }
if (config->verbose) {
fprintf(stderr, "Opening file %s\n", newlog.name);
}
rv = apr_file_open(&newlog.fd, newlog.name, APR_WRITE | APR_CREATE | APR_APPEND
- | (config->truncate ? APR_TRUNCATE : 0), APR_OS_DEFAULT, newlog.pool);
+ | (config->truncate || (config->num_files > 0 && status->current.fd) ? APR_TRUNCATE : 0),
+ APR_OS_DEFAULT, newlog.pool);
if (rv == APR_SUCCESS) {
/* Handle post-rotate processing. */
post_rotate(newlog.pool, &newlog, config, status);
+ status->fileNum = thisLogNum;
/* Close out old (previously 'current') logfile, if any. */
if (status->current.fd) {
close_logfile(config, &status->current);
status->current = newlog;
}
else {
- char error[120];
- apr_size_t nWrite;
-
- apr_strerror(rv, error, sizeof error);
+ char *error = apr_psprintf(newlog.pool, "%pm", &rv);
+ char *message;
/* Uh-oh. Failed to open the new log file. Try to clear
* the previous log file, note the lost log entries,
fprintf(stderr, "Could not open log file '%s' (%s)\n", newlog.name, error);
exit(2);
}
-
- /* Throw away new state; it isn't going to be used. */
- apr_pool_destroy(newlog.pool);
-
+
/* Try to keep this error message constant length
* in case it occurs several times. */
- apr_snprintf(status->errbuf, sizeof status->errbuf,
- "Resetting log file due to error opening "
- "new log file, %10d messages lost: %-25.25s\n",
- status->nMessCount, error);
- nWrite = strlen(status->errbuf);
-
- if (apr_file_trunc(status->current.fd, 0) != APR_SUCCESS) {
- fprintf(stderr, "Error truncating the file %s\n", status->current.name);
- exit(2);
- }
- if (apr_file_write(status->current.fd, status->errbuf, &nWrite) != APR_SUCCESS) {
- fprintf(stderr, "Error writing to the file %s\n", status->current.name);
- exit(2);
- }
+ message = apr_psprintf(newlog.pool,
+ "Resetting log file due to error opening "
+ "new log file, %10d messages lost: %-25.25s\n",
+ status->nMessCount, error);
+
+ truncate_and_write_error(status, message);
+
+ /* Throw away new state; it isn't going to be used. */
+ apr_pool_destroy(newlog.pool);
}
-
+
status->nMessCount = 0;
}
char c;
const char *opt_arg;
const char *err = NULL;
+#if APR_FILES_AS_SOCKETS
+ apr_pollfd_t pollfd = { 0 };
+ apr_status_t pollret = APR_SUCCESS;
+ long polltimeout;
+#endif
apr_app_initialize(&argc, &argv, NULL);
atexit(apr_terminate);
apr_pool_create(&status.pool, NULL);
apr_getopt_init(&opt, status.pool, argc, argv);
- while ((rv = apr_getopt(opt, "lL:p:ftve", &c, &opt_arg)) == APR_SUCCESS) {
+#if APR_FILES_AS_SOCKETS
+ while ((rv = apr_getopt(opt, "lL:p:fDtvecn:", &c, &opt_arg)) == APR_SUCCESS) {
+#else
+ while ((rv = apr_getopt(opt, "lL:p:fDtven:", &c, &opt_arg)) == APR_SUCCESS) {
+#endif
switch (c) {
case 'l':
config.use_localtime = 1;
break;
case 'p':
config.postrotate_prog = opt_arg;
+#ifdef SIGCHLD
+ /* Prevent creation of zombies (on modern Unix systems). */
+ apr_signal(SIGCHLD, SIG_IGN);
+#endif
break;
case 'f':
config.force_open = 1;
break;
+ case 'D':
+ config.create_path = 1;
+ break;
case 't':
config.truncate = 1;
break;
case 'e':
config.echo = 1;
break;
+#if APR_FILES_AS_SOCKETS
+ case 'c':
+ config.create_empty = 1;
+ break;
+#endif
+ case 'n':
+ config.num_files = atoi(opt_arg);
+ status.fileNum = -1;
+ break;
}
}
usage(argv[0], "Incorrect number of arguments");
}
- config.szLogRoot = argv[opt->ind++];
+ rv = apr_filepath_merge(&config.szLogRoot, "", argv[opt->ind++],
+ APR_FILEPATH_TRUENAME, status.pool);
+ if (rv != APR_SUCCESS && rv != APR_EPATHWILD) {
+ usage(argv[0], "Invalid filename given");
+ }
/* Read in the remaining flags, namely time, size and UTC offset. */
for(; opt->ind < argc; opt->ind++) {
config.use_strftime = (strchr(config.szLogRoot, '%') != NULL);
+ if (config.use_strftime && config.num_files > 0) {
+ fprintf(stderr, "Cannot use -n with %% in filename\n");
+ exit(1);
+ }
+
+ if (status.fileNum == -1 && config.num_files < 1) {
+ fprintf(stderr, "Invalid -n argument\n");
+ exit(1);
+ }
+
if (apr_file_open_stdin(&f_stdin, status.pool) != APR_SUCCESS) {
fprintf(stderr, "Unable to open stdin\n");
exit(1);
dumpConfig(&config);
}
+#if APR_FILES_AS_SOCKETS
+ if (config.create_empty && config.tRotation) {
+ pollfd.p = status.pool;
+ pollfd.desc_type = APR_POLL_FILE;
+ pollfd.reqevents = APR_POLLIN;
+ pollfd.desc.f = f_stdin;
+ }
+#endif
+
/*
* Immediately open the logfile as we start, if we were forced
* to do so via '-f'.
for (;;) {
nRead = sizeof(buf);
+#if APR_FILES_AS_SOCKETS
+ if (config.create_empty && config.tRotation) {
+ polltimeout = status.tLogEnd ? status.tLogEnd - get_now(&config, NULL) : config.tRotation;
+ if (polltimeout <= 0) {
+ pollret = APR_TIMEUP;
+ }
+ else {
+ pollret = apr_poll(&pollfd, 1, &pollret, apr_time_from_sec(polltimeout));
+ }
+ }
+ if (pollret == APR_SUCCESS) {
+ rv = apr_file_read(f_stdin, buf, &nRead);
+ if (APR_STATUS_IS_EOF(rv)) {
+ break;
+ }
+ else if (rv != APR_SUCCESS) {
+ exit(3);
+ }
+ }
+ else if (pollret == APR_TIMEUP) {
+ *buf = 0;
+ nRead = 0;
+ }
+ else {
+ fprintf(stderr, "Unable to poll stdin\n");
+ exit(5);
+ }
+#else /* APR_FILES_AS_SOCKETS */
rv = apr_file_read(f_stdin, buf, &nRead);
if (APR_STATUS_IS_EOF(rv)) {
break;
else if (rv != APR_SUCCESS) {
exit(3);
}
+#endif /* APR_FILES_AS_SOCKETS */
checkRotate(&config, &status);
if (status.rotateReason != ROTATE_NONE) {
doRotate(&config, &status);
}
nWrite = nRead;
- rv = apr_file_write(status.current.fd, buf, &nWrite);
- if (rv == APR_SUCCESS && nWrite != nRead) {
- /* buffer partially written, which for rotatelogs means we encountered
- * an error such as out of space or quota or some other limit reached;
- * try to write the rest so we get the real error code
- */
- apr_size_t nWritten = nWrite;
-
- nRead = nRead - nWritten;
- nWrite = nRead;
- rv = apr_file_write(status.current.fd, buf + nWritten, &nWrite);
- }
+ rv = apr_file_write_full(status.current.fd, buf, nWrite, &nWrite);
if (nWrite != nRead) {
- char strerrbuf[120];
apr_off_t cur_offset;
+ apr_pool_t *pool;
+ char *error;
cur_offset = 0;
if (apr_file_seek(status.current.fd, APR_CUR, &cur_offset) != APR_SUCCESS) {
cur_offset = -1;
}
- apr_strerror(rv, strerrbuf, sizeof strerrbuf);
status.nMessCount++;
- apr_snprintf(status.errbuf, sizeof status.errbuf,
- "Error %d writing to log file at offset %" APR_OFF_T_FMT ". "
- "%10d messages lost (%s)\n",
- rv, cur_offset, status.nMessCount, strerrbuf);
- nWrite = strlen(status.errbuf);
- apr_file_trunc(status.current.fd, 0);
- if (apr_file_write(status.current.fd, status.errbuf, &nWrite) != APR_SUCCESS) {
- fprintf(stderr, "Error writing to the file %s\n", status.current.name);
- exit(2);
- }
+ apr_pool_create(&pool, status.pool);
+ error = apr_psprintf(pool, "Error %d writing to log file at offset %"
+ APR_OFF_T_FMT ". %10d messages lost (%pm)\n",
+ rv, cur_offset, status.nMessCount, &rv);
+
+ truncate_and_write_error(&status, error);
+ apr_pool_destroy(pool);
}
else {
status.nMessCount++;
}
if (config.echo) {
- if (apr_file_write_full(f_stdout, buf, nRead, &nWrite)) {
+ if (apr_file_write_full(f_stdout, buf, nRead, NULL)) {
fprintf(stderr, "Unable to write to stdout\n");
exit(4);
}
projects / apache / blobdiff