2 # No way I try to deal with a crippled sh just for POSIX foo.
4 # Copyright (C) 2009-2015 Joerg Jaspert <joerg@debian.org>
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; version 2.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 # Homer: Are you saying you're never going to eat any animal again? What
25 # Lisa: Dad, those all come from the same animal.
26 # Homer: Heh heh heh. Ooh, yeah, right, Lisa. A wonderful, magical animal.
30 # A pipeline's return status is the value of the last (rightmost)
31 # command to exit with a non-zero status, or zero if all commands exit
34 # make sure to only use defined variables
36 # ERR traps should be inherited from functions too. (And command
37 # substitutions and subshells and whatnot, but for us the functions is
38 # the important part here)
41 # The extglob shell option is enabled using the shopt builtin, several
42 # extended pattern matching operators are recognized. We use it for
43 # the POSSIBLEARGS and the first case ${ARGS} matching
46 # And use one locale, no matter what the caller has set
50 # import the general variable set.
51 export SCRIPTVARS=/srv/ftp-master.debian.org/dak/config/debian/vars
55 declare -lr ARG=${1:-"meh"}
57 # program name is the (lower cased) first argument.
60 # And the following types of cronscripts exists
61 declare -lr POSSIBLEARGS='+(unchecked|dinstall|hourly|daily|weekly|monthly|yearly)'
63 # set DEBUG if you want to see a little more logs (needs to be used more)
66 # Check if the argument is a known one. If so, lock us so that only
67 # one copy of the type of cronscript runs. The $type.tasks file is
68 # mandantory, so use that for locking.
71 # Only one of me should ever run.
72 FLOCKER=${FLOCKER:-""}
73 [ "${FLOCKER}" != "${configdir}/${PROGRAM}.tasks" ] && exec env FLOCKER="${configdir}/${PROGRAM}.tasks" flock -E 0 -en "${configdir}/${PROGRAM}.tasks" "$0" "$@" || :
77 This is the FTPMaster cronscript. It needs an argument or it won't do
80 Currently accepted Arguments:
82 unchecked - Process the unchecked queue
83 dinstall - Run a dinstall
84 yearly, hourly, daily, weekly - Run that part
91 # common functions are "outsourced"
92 . "${configdir}/common"
94 # Timestamp when we started
95 NOW=$(date "+%Y.%m.%d-%H:%M:%S")
97 # Which list of tasks should we run?
98 declare -r TASKLIST="${configdir}/${PROGRAM}.tasks"
100 # A logfile for every cron script
101 LOGFILE="${logdir}/${PROGRAM}_${NOW}.log"
103 # Each "cronscript" may have a variables and a functions file
105 for what in variables functions; do
106 if [[ -f ${configdir}/${PROGRAM}.${what} ]]; then
107 . ${configdir}/${PROGRAM}.${what}
111 # Get rid of tempfiles at the end
112 trap cleanup EXIT TERM HUP INT QUIT
116 # Do not run during dinstall
117 if [[ -e ${LOCK_DAILY} ]]; then
120 # only run one cron.unchecked and also lock against hourly (newoverview)
121 if ! lockfile -r8 ${LOCK_UNCHECKED} 2> /dev/null; then
122 # log "aborting cron.unchecked because $LOCK_UNCHECKED has already been locked"
125 TMPFILES="${TMPFILES} ${LOCK_UNCHECKED}"
140 error "Unknown arg ${ARG}"
145 # An easy access by name for the current log
146 ln -sf ${LOGFILE} ${logdir}/${PROGRAM}
148 # And from here, all output to the log please
149 exec >> "$LOGFILE" 2>&1
151 # The stage function uses this directory
152 # This amends the stagedir variable from "vars"
153 stagedir="${stagedir}/${PROGRAM}"
154 # Ensure the dir exists
157 # This loop simply wants to be fed by a list of values (see below)
158 # made out of 5 columns.
159 # The first four are the array values for the stage function, the
160 # fifth tells us if we should background the stage call.
162 # - FUNC - the function name to call
163 # - ARGS - Possible arguments to hand to the function. Can be the empty string
164 # - TIME - The timestamp name. Can be the empty string
165 # - ERR - if this is the string false, then the call will be surrounded by
166 # set +e ... set -e calls, so errors in the function do not exit
167 # dinstall. Can be the empty string, meaning true.
168 # - BG - Background the function stage?
170 # ATTENTION: Spaces in arguments or timestamp names need to be escaped by \
172 # NOTE 1: There are two special values for the first column (FUNC).
173 # STATE - do not call stage function, call the state
174 # function to update the public statefile "where is dinstall"
175 # NOSTAGE - do not call stage function, call the command directly.
177 # Note 2: If you want to hand an empty value to the stage function,
178 # use the word "none" in the list below.
179 while read FUNC ARGS TIME ERR BACKGROUND; do
180 debug "FUNC: $FUNC ARGS: $ARGS TIME: $TIME ERR: $ERR BG: $BACKGROUND"
182 # Empty values in the value list are the string "none" (or the
183 # while read loop won't work). Here we ensure that variables that
184 # can be empty, are empty if the string none is set for them.
185 for var in ARGS TIME; do
186 if [[ ${!var} == none ]]; then
191 # ERR/BACKGROUND are boolean, check that they are.
192 for var in ERR BACKGROUND; do
193 if [[ ${!var} != false ]] && [[ ${!var} != true ]]; then
194 error "Illegal value ${!var} for ${var} (should be true or false), line for function ${FUNC}"
212 if [[ ${BACKGROUND} == true ]]; then
219 done < <(grep -v '^#' ${TASKLIST} )
221 # we need to wait for the background processes before the end of the cron script
225 # Common to all cron scripts
226 log "Cron script successful, all done"
227 # Redirect output to another file, as we want to compress our logfile
228 # and ensure its no longer used
229 exec > "$logdir/after${PROGRAM}.log" 2>&1
237 touch "${DINSTALLEND}"
251 # Now, at the very (successful) end of this run, make sure we remove
252 # our stage files, so the next dinstall run will do it all again.
256 # Logfile should be gone, remove the symlink
257 [[ -L ${logdir}/${PROGRAM} ]] && [[ ! -f ${logdir}/${PROGRAM} ]] && rm -f ${logdir}/${PROGRAM} || log "Logfile still exists or symlink gone already? Something fishy going on"
259 # FIXME: Mail the log when its non-empty
260 [[ -s "${logdir}/after${PROGRAM}.log" ]] || rm "${logdir}/after${PROGRAM}.log"