From 7ce54fafab402a942e95efab757d72750b248dae Mon Sep 17 00:00:00 2001
From: Joerg Jaspert <joerg@debian.org>
Date: Sun, 28 Sep 2008 10:40:22 +0200
Subject: Hooks, Hub

Implement 5 hooks so we can call scripts at various places of the
mirror sync.

Also make runmirrors optional, depending on if we are a hub or not.

Signed-off-by: Joerg Jaspert <joerg@debian.org>
---
 bin/ftpsync      | 54 +++++++++++++++++++++++++++++++++++++++++++++++++-----
 etc/ftpsync.conf | 21 +++++++++++++++++++++
 2 files changed, 70 insertions(+), 5 deletions(-)

diff --git a/bin/ftpsync b/bin/ftpsync
index 3d2df90..1d87b22 100755
--- a/bin/ftpsync
+++ b/bin/ftpsync
@@ -24,6 +24,11 @@ set -e
 
 # Read our config file
 NAME="`basename $0`"
+
+# In case we are called with an argument we look for a different configuration.
+if [ -n $1 ];
+	NAME="${NAME}-$1"
+fi
 . ${HOME}/etc/${NAME}.conf
 
 ########################################################################
@@ -140,6 +145,13 @@ log "Mirrorsync start"
 
 log "Acquired main lock"
 
+if [ -n ${HOOK1} ]; then
+	log "Running hook1: ${HOOK1}"
+	${HOOK1}
+	result=$?
+	log "Back from hook1, got returncode ${result}"
+fi
+
 export RSYNC_PASSWORD
 
 # Now do the actual mirroring, and run as long as we have an updaterequired file.
@@ -152,15 +164,30 @@ while [ -e "${UPDATEREQUIRED}" ]; do
 		${RSYNC_USER}@${RSYNC_HOST}::${RSYNC_PATH} ${TO}
 
 	result=$?
-	# 24 - vanished source files. Ignore, that should be the target of $UPDATEREQUIRED
-	# and us re-running.
+	# 24 - vanished source files. Ignored, that should be the target of $UPDATEREQUIRED
+	# and us re-running. If it's not, uplink is broken anyways.
 	if [ $result -eq 0 ] || [ $result -eq 24 ]; then
+
+		if [ -n ${HOOK2} ]; then
+			log "Running hook2: ${HOOK1}"
+			${HOOK2}
+			result=$?
+			log "Back from hook1, got returncode ${result}"
+		fi
+
 		# We are lucky, it worked. Now do step 2 and sync again, this time including
 		# the packages/releases files
 		${RSYNC} ${RSYNC_OPTIONS} ${RSYNC_OPTIONS2} ${EXCLUDE} ${SOURCE_EXCLUDE} \
 			${RSYNC_USER}@${RSYNC_HOST}::${RSYNC_PATH} ${TO}
 		result=$?
-		if [ $result -ne 0 ]; then
+		if [ $result -eq 0 ] || [ $result -eq 24 ]; then
+			if [ -n ${HOOK3} ]; then
+				log "Running hook3: ${HOOK1}"
+				${HOOK3}
+				result=$?
+				log "Back from hook3, got returncode ${result}"
+			fi
+		else
 			error "ERROR: Sync step 2 went wrong, got errorcode ${result}. Logfile: ${LOG}"
 			exit 4
 		fi
@@ -174,8 +201,25 @@ if [ -d "${TO}/project/trace" ]; then
       date -u > "${TO}/project/trace/${HOSTNAME}"
 fi
 
-log "Trigger slave mirrors"
-${HOME}/bin/runmirrors
+if [ -n ${HOOK4} ]; then
+	log "Running hook4: ${HOOK1}"
+	${HOOK4}
+	result=$?
+	log "Back from hook4, got returncode ${result}"
+fi
+
+if [ x${HUB} = "xtrue" ]; then
+	log "Trigger slave mirrors"
+	${HOME}/bin/runmirrors
+	log "Trigger slave done"
+
+	if [ -n ${HOOK5} ]; then
+		log "Running hook5: ${HOOK1}"
+		${HOOK5}
+		result=$?
+		log "Back from hook5, got returncode ${result}"
+	fi
+fi
 
 # Finally, all done. Mail the log, exit.
 if [ -n "${MAILTO}" ]; then
diff --git a/etc/ftpsync.conf b/etc/ftpsync.conf
index 510ed4d..4844e19 100644
--- a/etc/ftpsync.conf
+++ b/etc/ftpsync.conf
@@ -5,3 +5,24 @@ RSYNC_PASSWORD=PASSWORD
 RSYNC_PATH="debian-all"
 PROGRAM=ftpsync
 MAILTO="somewhere@example.com"
+# Hook scripts can be run at various places during the sync.
+# Leave them blank if you don't want any
+# Hook1: After lock is acquired, before first rsync
+# Hook2: After first rsync, if successful
+# Hook3: After second rsync, if successful
+# Hook4: Right before leaf mirror triggering
+# Hook5: After leaf mirror trigger, only if we have slave mirrors (HUB=true)
+#
+# Note that Hook3 and Hook4 are likely to be called directly after each other.
+# Difference is: Hook3 is called *every* time the second rsync was successful,
+# but even if the mirroring needs to re-run thanks to a second push.
+# Hook4 is only effective if we are done with mirroring.
+HOOK1=
+HOOK2=
+HOOK3=
+HOOK4=
+HOOK5=
+# Do we have leaf mirror to signal we are done and they should sync?
+# If so set it to true and make sure you configure runmirrors.mirrors
+# and runmirrors.conf for your need.
+HUB=true
-- 
cgit v1.2.3