Better beanstalkd init script for debian/ubuntu

beanstalkd.init.sh

#!/bin/sh
# 
# Copyright (c) 2012 NGMOCO
# Updated by Jesse Sanford <[email protected]>
# 
# Portions taken from debian package by 
# Javier Fernandez-Sanguino <[email protected]>
#
# This is free software; you may redistribute it and/or modify
# it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2,
# or (at your option) any later version.
#
# This is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License with
# the Debian operating system, in /usr/share/common-licenses/GPL;  if
# not, write to the Free Software Foundation, Inc., 59 Temple Place,
# Suite 330, Boston, MA 02111-1307 USA
#
### BEGIN INIT INFO
# Provides:          beanstalkd
# Required-Start:    $network $local_fs
# Required-Stop:
# Should-Start:      $named
# Should-Stop:
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: in-memory queueing server
# Description:       beanstalk is a simple, fast, queueing server. Its
#                    interface is generic, but was originally designed
#                    for reducing the latency of page views in high-volume
#                    web applications by running time-consuming tasks
#                    asynchronously.
### END INIT INFO

# NOTE: this script was taken from the debian package for beanstalkd and
# and modified to use the bbexec.sh daemon wrapper in order to redirect
# the stdout and stderr to a log file. You can find the bbexec.sh wrapper
# here: https://github.com/ngmoco/bbexec

PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin

WRAPPER_SCRIPT=/usr/local/bin/bbexec.sh # The daemonizing script for redirection purposes
DAEMON=/usr/bin/beanstalkd # Introduce the server's location here
NAME=beanstalkd             # Introduce the short server's name here
DESC="in-memory queueing server" # Introduce a short description here
LOGDIR=/var/log/beanstalkd  # Log directory to use
LOGFILE=$LOGDIR/$NAME.log  # Server logfile
PIDFILE=/var/run/$NAME/$NAME.pid

test -x $DAEMON || exit 0

# Define LSB log_* functions.
# Depends on lsb-base (>= 3.0-6) to ensure that this file is present
. /lib/lsb/init-functions

# Default options, these can be overriden by the information
# at /etc/default/$NAME
DAEMON_OPTS=""          # Additional options given to the server (set in /etc/default/beanstalkd)

#DIETIME=10              # Time to wait for the server to die, in seconds
                        # If this value is set too low you might not
                        # let some servers to die gracefully and
                        # 'restart' will not work

STARTTIME=1             # Time to wait for the server to start, in seconds
                        # If this value is set each time the server is
                        # started (on start or restart) the script will
                        # stall to try to determine if it is running
                        # If it is not set and the server takes time
                        # to setup a pid file the log message might
                        # be a false positive (says it did not start
                        # when it actually did)

DAEMONUSER=beanstalkd   # Users to run the daemons as. If this value
                        # is set start-stop-daemon will chuid the server

# Set verbosity default
VERBOSE=no

# Load the VERBOSE setting and other rcS variables if they are set
if [ -f /lib/init/vars.sh ] ; then
    . /lib/init/vars.sh
fi

# Include defaults if available
if [ -f /etc/default/$NAME ] ; then
    . /etc/default/$NAME
fi

# NOTE we leave the trailing -a so that when the DAEMON_OPTS are added below they are sent to the wrapper
# correctly within the -a argument. Normally we would concatenate them here as they are available now but
# there is an odd bug with quoting and start-stop-daemon which munges the DAEMON_OPTS so we leave it till
# below. see http://stackoverflow.com/questions/1661193/start-stop-daemon-quoted-arguments-misinterpreted
WRAPPER_OPTS="-l ${LOGFILE} -p ${PIDFILE} -d ${DAEMON} -a"

# Check that the user exists (if we set a user)
# Does the user exist?
if [ -n "$DAEMONUSER" ] ; then
    if getent passwd | grep -q "^$DAEMONUSER:"; then
        # Obtain the uid and gid
        DAEMONUID=`getent passwd |grep "^$DAEMONUSER:" | awk -F : '{print $3}'`
        DAEMONGID=`getent passwd |grep "^$DAEMONUSER:" | awk -F : '{print $4}'`
    else
        log_failure_msg "The user $DAEMONUSER, required to run $NAME does not exist."
        exit 0
    fi
fi

# Exit on error
set -e

running_pid() {
    # Check if a given process pid's cmdline matches a given name
    pid=$1
    name=$2
    [ -z "$pid" ] && return 1
    [ ! -d /proc/$pid ] &&  return 1
    cmd=`cat /proc/$pid/cmdline | tr "\000" "\n"|head -n 1 |cut -d : -f 1`
    # Is this the expected server
    [ "$cmd" != "$name" ] &&  return 1
    return 0
}

running() {
    # Check if the process is running looking at /proc
    # (works for all users)

    # No pidfile, probably no daemon present
    [ ! -f "$PIDFILE" ] && return 1
    pid=`cat $PIDFILE`
    running_pid $pid $DAEMON || return 1
    return 0
}

start_server() {
        # Start the process using the bbexec.sh wrapper.
        if [ "x$START" != "xyes" -a "x$START" != "xtrue"  ]; then
            echo ""
            echo "beanstalkd not configured to start, please edit /etc/default/beanstalkd to enable"
            exit 0
        fi
        if [ -z "$DAEMONUSER" ] ; then
            start_daemon -p $PIDFILE $WRAPPER_SCRIPT $WRAPPER_OPTS "$DAEMON_OPTS"
            errcode=$?
        else
            # If we are using a daemonuser then change the user id
            # Note: we don't need start-stop-daemon to create the pid aka --make-pidfile
            # because the bbexec.sh wrapper will do it for us.
            start-stop-daemon --start --quiet --pidfile $PIDFILE \
                        --chuid $DAEMONUSER --background \
                        --exec $WRAPPER_SCRIPT -- $WRAPPER_OPTS "$DAEMON_OPTS"
            errcode=$?
        fi
        return $errcode
}

stop_server() {
        # Stop the process using the pid produced by the bbexec wrapper.
        if [ -z "$DAEMONUSER" ] ; then
            killproc -p $PIDFILE $DAEMON
            errcode=$?
        else
            # If we are using a daemonuser then look for process that match
            start-stop-daemon --stop --quiet --pidfile $PIDFILE \
                        --user $DAEMONUSER \
                        --exec $DAEMON
            errcode=$?
        fi
        rm -f $PIDFILE

        return $errcode
}

reload_server() {
    [ ! -f "$PIDFILE" ] && return 1
    pid=pidofproc $PIDFILE # This is the daemon's pid
    # Send a SIGHUP
    kill -1 $pid
    return $?
}

force_stop() {
    # Force the process to die killing it manually
    [ ! -e "$PIDFILE" ] && return
    if running ; then
        kill -15 $pid
        # Is it really dead?
        sleep "$DIETIME"s
        if running ; then
            kill -9 $pid
            sleep "$DIETIME"s
            if running ; then
                echo "Cannot kill $NAME (pid=$pid)!"
                exit 0
            fi
        fi
    fi
    rm -f $PIDFILE
}


case "$1" in
  start)
        log_daemon_msg "Starting $DESC " "$NAME"
        # Check if it's running first
        if running ;  then
            log_progress_msg "apparently already running"
            log_end_msg 0
            exit 0
        fi
        if start_server ; then
            # NOTE: Some servers might die some time after they start,
            # this code will detect this issue if STARTTIME is set
            # to a reasonable value
            [ -n "$STARTTIME" ] && sleep $STARTTIME # Wait some time 
            if  running ;  then
                # It's ok, the server started and is running
                log_end_msg 0
            else
                # It is not running after we did start
                log_end_msg 1
            fi
        else
            # Either we could not start it
            log_end_msg 1
        fi
        ;;
  stop)
        log_daemon_msg "Stopping $DESC" "$NAME"
        if running ; then
            # Only stop the server if we see it running
            errcode=0
            stop_server || errcode=$?
            log_end_msg $errcode
        else
            # If it's not running don't do anything
            log_progress_msg "apparently not running"
            log_end_msg 0
            exit 0
        fi
        ;;
  force-stop)
        # First try to stop gracefully the program
        $0 stop
        if running; then
            # If it's still running try to kill it more forcefully
            log_daemon_msg "Stopping (force) $DESC" "$NAME"
            errcode=0
            force_stop || errcode=$?
            log_end_msg $errcode
        fi
        ;;
  restart|force-reload)
        log_daemon_msg "Restarting $DESC" "$NAME"
        errcode=0
        stop_server || errcode=$?
        # Wait some sensible amount, some server need this
        [ -n "$DIETIME" ] && sleep $DIETIME
        start_server || errcode=$?
        [ -n "$STARTTIME" ] && sleep $STARTTIME
        running || errcode=$?
        log_end_msg $errcode
        ;;
  status)

        log_daemon_msg "Checking status of $DESC" "$NAME"
        if running ;  then
            log_progress_msg "running"
            log_end_msg 0
        else
            log_progress_msg "apparently not running ... "
            log_end_msg 1
            exit 0
        fi
        ;;
  reload)
        log_warning_msg "Reloading $NAME daemon: not implemented (use restart)."
        ;;
  *)
        N=/etc/init.d/$NAME
        echo "Usage: $N {start|stop|force-stop|restart|force-reload|status}" >&2
        exit 1
        ;;
esac

exit 0