Implemented production/debug mode for snf-server.suse.

Corrected default log file directory in INSTALL.


git-svn-id: https://svn.microneil.com/svn/PKG-SNF-CS-NIX/trunk@38 233e721a-07f6-49eb-a7da-05e0e16828fc

SNF_CS_Developer_Package/ChangeLog

@@ -1,3 +1,8 @@
+2009-06-29  Alban Deniz  <adeniz@skidmark.localdomain>
+
+	* Scripts/snf-server.suse: Implement debug mode and production
+	mode (Copied from snf-milter.suse in snf-milter distribution).
+
 2009-06-28  Alban Deniz  <adeniz@skidmark.localdomain>
 
 	* config_files/SNFServer.xml.sample.in: Change "path" attribute of

SNF_CS_Developer_Package/INSTALL

@@ -170,7 +170,7 @@ To configure SNFServer, do the following:
      a) Specify the directories.  The default directories are:
 
           <node identity='/etc/snf-server/identity.xml'>
-          <log path='/usr/share/snf-server/'/>
+          <log path='/var/log/snf-server/'/>
           <rulebase path='/usr/share/snf-server/'/>
           <workspace path='/usr/share/snf-server/'/>
           <update-script on-off='on' call='/usr/sbin/getRulebase'

SNF_CS_Developer_Package/Scripts/snf-server.suse

@@ -1,7 +1,6 @@
 #!/bin/bash
 #
-# SNFServer	This shell script takes care of starting and stopping
-#		the MicroNeil SNFServer daemon for SUSE systems.
+# snf-server	Starts and stops the SNFServer daemon (SUSE).
 #
 # Author--  Alban Deniz
 #
@@ -20,11 +19,27 @@
 # Default-Start:     3 4 5
 # Default-Stop:      0 1 2 6
 # Short-Description: SNFServer providing email filtering.
-# Description:       Start SNFServer to filter email for spam,
-#	blacklist IP addresses, etc.
+# Description:       Start SNFServer to filter email for spam and
+#	check IP addresses.
 ### END INIT INFO
 
-# Location of programs.
+# Directory to run in.
+runDir=PREFIX/share/PACKAGE_NAME
+
+# Define mode files.
+debugModeFile=$runDir/debug_mode
+productionModeFile=$runDir/production_mode
+
+# Set debug mode flag.
+if [ -f $debugModeFile ]
+then
+    debugMode=true
+fi
+
+# Debug output file.
+debugOutputFile=/var/log/PACKAGE_NAME/debug.log
+
+# Location of installation.
 installedDir="PREFIX"
 
 # Location of programs.
@@ -34,7 +49,8 @@ dir="$installedDir/sbin"
 configFile="CONFFILE"
 
 # Name of daemon.
-prog="SNFServer"
+debugProg="SNFDebugServer"
+productionProg="SNFServer"
 
 # Name of client.
 clientProg="SNFClient"
@@ -43,15 +59,15 @@ clientProg="SNFClient"
 userName="snfilter"
 
 # Name of lockfile.
-lockFile="/var/lock/subsys/$prog"
+lockFile="/var/lock/subsys/$productionProg"
 
-# Start command.
-snfStartCmd="$dir/$prog $configFile > /dev/null 2>&1 &"
+# Name of client.
+clientProg="SNFClient"
 
 # Check for missing binaries (stale symlinks should not happen)
 # Note: Special treatment of stop for LSB conformance
-SNFServer_BIN=$dir/$prog
-test -x $SNFServer_BIN || { echo "$SNFServer_BIN not installed"; 
+SNFServer_BIN=$dir/$productionProg
+test -x $SNFServer_BIN || { echo $"$SNFServer_BIN not installed"; 
 	if [ "$1" = "stop" ]; then exit 0;
 	else exit 5; fi; }
 
@@ -106,7 +122,7 @@ else
 	start_daemon() { return daemon ${1+"$@"}; }
     else
 	# emulate it
-	echo_rc() { echo "  [${_SMSG[${_RC_RV}]}] "; }
+	echo_rc() { echo $"  [${_SMSG[${_RC_RV}]}] "; }
     fi
     rc_reset() { _RC_RV=0; }
     rc_failed()
@@ -144,6 +160,43 @@ fi
 # Reset status of this service
 rc_reset
 
+#
+# Function to create the mode file.
+#
+createModeFile()
+{
+    fileName=$1
+
+    # Remove any existing mode files.
+    rm -f $productionModeFile $debugModeFile $fileName
+    (
+	echo $"PACKAGE_NAME mode file"
+	echo
+	echo $"This file specifies whether PACKAGE_NAME is configured to run in"
+	echo $"production mode or debug mode.  If the name of this file is"
+        echo $"'production_mode', then PACKAGE_NAME is configured to run in"
+        echo $"production mode.  If the name is 'debug_mode', then PACKAGE_NAME is"
+        echo $"configured to run in debug mode."
+	echo
+	echo $"To run in debug mode:"
+	echo
+	echo $"    1) Run 'PACKAGE_NAME debug_mode'"
+	echo
+	echo $"    2) Run 'PACKAGE_NAME restart' (if PACKAGE_NAME is already running),"
+	echo $"       or 'PACKAGE_NAME start' (to start PACKAGE_NAME)"
+	echo
+	echo $"To run in production mode:"
+	echo
+	echo $"    1) Run 'PACKAGE_NAME production_mode'"
+	echo
+	echo $"    2) Run 'PACKAGE_NAME restart' (if PACKAGE_NAME is already running),"
+	echo $"       or 'PACKAGE_NAME start' (to start PACKAGE_NAME)"
+	echo
+	echo $"By default, PACKAGE_NAME is configured to run in production mode."
+	) > $fileName
+
+}
+
 # Return values acc. to LSB for all commands but status:
 # 0	  - success
 # 1       - generic or unspecified error
@@ -161,18 +214,42 @@ rc_reset
 # considered a success.
 
 start(){
-    SNFPID=$(pidof -s $dir/$prog)
-    echo -n $"Starting $prog "
-    if [ -n "$SNFPID" ] ; then
-	return 0
+    echo -n $"Starting $productionProg: "
+    for prog in $productionProg $debugProg
+    do
+        SNFPID=$(pidof -s $dir/$prog)
+        if [ -n "$SNFPID" ] ; then
+	    return 0
+        fi
+    done
+
+    # Start.
+    if [ $debugMode ]
+    then
+
+	# Enable core dumps and start with output redirected.
+        (ulimit -c unlimited; \
+            su $userName -s /bin/sh -c \
+            "echo Starting $dir/$debugProg on $(date) >> $debugOutputFile"; \
+            cd PREFIX/share/PACKAGE_NAME; \
+	    su $userName -c \
+            "strace -r -tt -v $dir/$debugProg $configFile >> $debugOutputFile 2>&1 &" \
+	    -s /bin/sh)
+
     else
-	su $userName -c "$snfStartCmd" -s /bin/sh
-        RETVAL=$?
-        if [ $RETVAL -eq 0 ]; then
-	    $dir/$clientProg -status.second > /dev/null 2>&1
-	    RETVAL=$?
-	fi
+        
+	(cd PREFIX/share/PACKAGE_NAME; \
+            su $userName -c "$dir/$productionProg $configFile > /dev/null 2>&1 &" \
+	    -s /bin/sh > /dev/null 2>&1)
+    fi
+
+
+    RETVAL=$?
+    if [ $RETVAL -eq 0 ]; then 
+	$dir/$clientProg -status.second > /dev/null 2>&1
+	RETVAL=$?
     fi
+
     if [ $RETVAL -eq 0 ]; then
 	touch $lockFile
     else
@@ -182,22 +259,29 @@ start(){
 }
 
 stop(){
-    echo -n $"Stopping $prog "
-    SNFPID=$(pidof -s $dir/$prog)
-    if [ -n "$SNFPID" ]; then
+    echo -n $"Stopping $productionProg: "
+    DEBUG_SNFPID=$(pidof -s $dir/$debugProg)
+    PRODUCTION_SNFPID=$(pidof -s $dir/$productionProg)
+    if [ -n "$DEBUG_SNFPID" ] || [ -n "$PRODUCTION_SNFPID" ]; then
 	$dir/$clientProg -shutdown > /dev/null 2>&1
 	sleep 10
-	SNFPID=$(pidof -s $dir/$prog)
-	if [ -n "$SNFPID" ]; then
-	    kill $SNFPID
-	    RETVAL=$?
-	else
-	    RETVAL=0
-	fi
+
+        # Check that the programs are no longer running.
+        RETVAL=0
+        for prog in $debugProg $productionProg
+        do
+
+            SNFPID=$(pidof -s $dir/$prog)
+	    if [ -n "$SNFPID" ]; then
+	        kill $SNFPID
+	        RETVAL=$(($RETVAL+$?))
+	    fi
+        done
     else
 	# Process is not running.
 	RETVAL=0
     fi
+
     if [ $RETVAL -eq 0 ]; then 
 	rm -f $lockFile
     else
@@ -237,7 +321,24 @@ case "$1" in
 	echo -n "Checking for service SNFServer "
 	checkproc $SNFServer_BIN
 	rc_status -v
+	echo -n "Checking for service SNFDebugServer "
+	checkproc $dir/$debugProg
+	rc_status -v
 	;;
+    debug_mode)
+  	#
+  	# Remove any mode flags, and create the debug_mode file.
+  	#
+  	echo $"Switching to debug mode"
+  	createModeFile $debugModeFile
+  	;;
+    production_mode)
+  	#
+  	# Remove any mode flags, and create the production_mode file.
+  	#
+  	echo $"Switching to production mode"
+  	createModeFile $productionModeFile
+  	;;
     try-restart|condrestart|force-reload|reload|probe)
 	# Not supported.
 	echo -n "$0 $1 "
@@ -245,7 +346,7 @@ case "$1" in
 	rc_status -v
 	;;
     *)
-	echo "Usage: $0 {start|stop|status|restart}"
+	echo $"Usage: $0 {start|stop|status|restart|production_mode|debug_mode}"
 	exit 1
 	;;
 esac