Projects/lumberjack
1
0
Fork 0
Code Releases Wiki Activity

Update help text. Add sanity check for {} in link name in raw mode.

Browse source
This commit is contained in:
Darren 'Tadgy' Austin 2018-04-18 19:32:48 +01:00
commit b2dae9022a
1 changed files with 12 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

20
lumberjack
View file

@ -32,9 +32,10 @@ display_help() {
-j <jobs> Maximum number of compression jobs to have active at once. -j <jobs> Maximum number of compression jobs to have active at once.
Default: $LJ_MAXJOBS. Don't set this too high. Default: $LJ_MAXJOBS. Don't set this too high.
-l <link> Create a symlink named <link> to the currently active log file. -l <link> Create a symlink named <link> to the currently active log file.
The <link> is created relative to <basedir>. The link name may The <link> is created relative to <basedir>. In normal mode,
include the same {} sequence and %-escaped formatting as the the link name may include the same '{}' sequence and %-escaped
<template> - see below for an explanation of these expansions. formatting as the <template> (see below). In raw mode (-r), the
'{}' is not allowed, but % escape sequences can still be used.
WARNING: The (expanded) location of this link will be WIPED OUT! WARNING: The (expanded) location of this link will be WIPED OUT!
-r Raw logging mode. In this mode, no processing of the log line -r Raw logging mode. In this mode, no processing of the log line
for an httpd VirtualHost site identifier is performed - log for an httpd VirtualHost site identifier is performed - log
@ -51,12 +52,12 @@ display_help() {
Arguments (all of which are mandatory): Arguments (all of which are mandatory):
<basedir> The base directory of where to write the log files. <basedir> The base directory of where to write the log files.
<template> The filename template. When normal mode, the template must <template> The filename template. When in normal mode, the template must
include at least one occurrance of '{}', which is replaced with include at least one occurrance of '{}', which is replaced with
the site name from the VirtualHost identifier. In raw mode the site name from the VirtualHost identifier. In raw mode
(-r), '{}' should not be included in the template. The template (-r), the '{}' should not be included in the template. The
may also include any %-escaped format strings recognised by the template may also include any %-escaped format strings
strftime(3) function. See below for examples. recognised by the strftime(3) function. See below for examples.
Examples: Examples:
When used with the httpd CustomLog directive, using %v as the first log format When used with the httpd CustomLog directive, using %v as the first log format
@ -305,13 +306,16 @@ done
# The remaining arguments should be the base directory and the template. # The remaining arguments should be the base directory and the template.
LJ_BASEDIR="$1" LJ_BASEDIR="$1"
LJ_TEMPLATE="$2"
# Santy checking.
[[ "${LJ_BASEDIR:0:1}" != "/" ]] && die "$LJ_BASEDIR: must be an absolute path" [[ "${LJ_BASEDIR:0:1}" != "/" ]] && die "$LJ_BASEDIR: must be an absolute path"
[[ ! -e "$LJ_BASEDIR" ]] && die "$LJ_BASEDIR: base directory does not exist" [[ ! -e "$LJ_BASEDIR" ]] && die "$LJ_BASEDIR: base directory does not exist"
[[ ! -d "$LJ_BASEDIR" ]] && die "$LJ_BASEDIR: not a directory" [[ ! -d "$LJ_BASEDIR" ]] && die "$LJ_BASEDIR: not a directory"
LJ_TEMPLATE="$2"
[[ "${LJ_TEMPLATE: -1:1}" == "/" ]] && die "$LJ_TEMPLATE: template cannot end with '/'" [[ "${LJ_TEMPLATE: -1:1}" == "/" ]] && die "$LJ_TEMPLATE: template cannot end with '/'"
(( LJ_RAW == 0 )) && [[ ! "$LJ_TEMPLATE" =~ .*\{\} ]] && die "$LJ_TEMPLATE: template must include at least one '{}'" (( LJ_RAW == 0 )) && [[ ! "$LJ_TEMPLATE" =~ .*\{\} ]] && die "$LJ_TEMPLATE: template must include at least one '{}'"
(( LJ_RAW != 0 )) && [[ "$LJ_TEMPLATE" =~ .*\{\} ]] && die "$LJ_TEMPLATE: template cannot include '{}'" (( LJ_RAW != 0 )) && [[ "$LJ_TEMPLATE" =~ .*\{\} ]] && die "$LJ_TEMPLATE: template cannot include '{}'"
(( LJ_RAW != 0 )) && [[ "$LJ_LINKFILE" =~ .*\{\} ]] && die "$LJ_LINKFILE: link name cannot include '{}'"
# The array of file descriptors corresponding to each path. # The array of file descriptors corresponding to each path.
declare -A LJ_FDS declare -A LJ_FDS