debian/scripts/koha-worker

   1 #!/bin/bash
   2 #
   3 # Copyright 2020 Koha Development team
   4 #
   5 # This program is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 set -e
  19
  20 . /lib/lsb/init-functions
  21
  22 # Read configuration variable file if it is present
  23 [ -r /etc/default/koha-common ] && . /etc/default/koha-common
  24
  25 # include helper functions
  26 if [ -f "/usr/share/koha/bin/koha-functions.sh" ]; then
  27     . "/usr/share/koha/bin/koha-functions.sh"
  28 else
  29     echo "Error: /usr/share/koha/bin/koha-functions.sh not present." 1>&2
  30     exit 1
  31 fi
  32
  33 usage()
  34 {
  35     local scriptname=$(basename $0)
  36
  37     cat <<EOF
  38 $scriptname
  39
  40 This script lets you manage the worker daemon for your Koha instances.
  41
  42 Usage:
  43 $scriptname [--start|--stop|--restart] [--queue queue_name] [--quiet|-q] instancename1 [instancename2...]
  44 $scriptname --status instancename1 [instancename2...]
  45 $scriptname -h|--help
  46
  47     --start               Start the worker daemon for the specified instances
  48     --stop                Stop the worker daemon for the specified instances
  49     --restart             Restart the worker daemon for the specified instances
  50     --queue               Specify the queue/worker to restart - 'default' is used if not specified
  51                           current queues are: default, long_tasks
  52     --status              Show the status of the worker for the specified instances
  53     --quiet|-q            Make the script quiet about non existent instance names
  54                           (useful for calling from another scripts).
  55     --help|-h             Display this help message
  56
  57 EOF
  58 }
  59
  60 start_worker()
  61 {
  62     local name=$1
  63     local queue=$2
  64
  65     if ! is_worker_running $name $queue; then
  66
  67         worker_name=`get_worker_name $name $queue`
  68
  69         export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
  70
  71         DAEMONOPTS="--name=${worker_name} \
  72             --errlog=/var/log/koha/$name/worker-error.log \
  73             --stdout=/var/log/koha/$name/worker.log \
  74             --output=/var/log/koha/$name/worker-output.log \
  75             --pidfiles=/var/run/koha/$name/ \
  76             --verbose=1 --respawn --delay=30 \
  77             --user=$name-koha.$name-koha"
  78
  79         log_daemon_msg "Starting Koha worker daemon for $name ($queue)"
  80
  81         if daemon $DAEMONOPTS -- $worker_DAEMON --queue ${queue}; then
  82             log_end_msg 0
  83         else
  84             log_end_msg 1
  85         fi
  86     else
  87         log_daemon_msg "Error: worker already running for $name ($queue)"
  88         log_end_msg 1
  89     fi
  90 }
  91
  92 stop_worker()
  93 {
  94     local name=$1
  95     local queue=$2
  96
  97     if is_worker_running $name $queue; then
  98         export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
  99
 100         worker_name=`get_worker_name $name $queue`
 101
 102         DAEMONOPTS="--name=${worker_name} \
 103             --errlog=/var/log/koha/$name/worker-error.log \
 104             --stdout=/var/log/koha/$name/worker.log \
 105             --output=/var/log/koha/$name/worker-output.log \
 106             --pidfiles=/var/run/koha/$name/ \
 107             --verbose=1 --respawn --delay=30 \
 108             --user=$name-koha.$name-koha"
 109
 110         log_daemon_msg "Stopping Koha worker daemon for $name ($queue)"
 111
 112         if daemon $DAEMONOPTS --stop -- $worker_DAEMON --queue ${queue}; then
 113             log_end_msg 0
 114         else
 115             log_end_msg 1
 116         fi
 117     else
 118         log_daemon_msg "Error: worker not running for $name ($queue)"
 119         log_end_msg 1
 120     fi
 121 }
 122
 123 restart_worker()
 124 {
 125     local name=$1
 126     local queue=$2
 127
 128     if is_worker_running $name $queue; then
 129         export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
 130
 131         worker_name=`get_worker_name $name $queue`
 132
 133         DAEMONOPTS="--name=${worker_name} \
 134             --errlog=/var/log/koha/$name/worker-error.log \
 135             --stdout=/var/log/koha/$name/worker.log \
 136             --output=/var/log/koha/$name/worker-output.log \
 137             --pidfiles=/var/run/koha/$name/ \
 138             --verbose=1 --respawn --delay=30 \
 139             --user=$name-koha.$name-koha"
 140
 141         log_daemon_msg "Restarting Koha worker daemon for $name ($queue)"
 142
 143         if daemon $DAEMONOPTS --restart -- $worker_DAEMON --queue ${queue}; then
 144             log_end_msg 0
 145         else
 146             log_end_msg 1
 147         fi
 148     else
 149         log_warning_msg "Worker not running for $name ($queue)."
 150         start_worker $name $queue
 151     fi
 152 }
 153
 154 worker_status()
 155 {
 156     local name=$1
 157     local queue=$2
 158
 159     if is_worker_running ${name} ${queue}; then
 160         log_daemon_msg "worker running for ${name} ($queue)"
 161         log_end_msg 0
 162     else
 163         log_daemon_msg "worker not running for ${name} ($queue)"
 164         log_end_msg 3
 165     fi
 166 }
 167
 168 set_action()
 169 {
 170     if [ "$op" = "" ]; then
 171         op=$1
 172     else
 173         die "Error: only one action can be specified."
 174     fi
 175 }
 176
 177 op=""
 178 queue="default"
 179 quiet="no"
 180
 181 # Read command line parameters
 182 while [ $# -gt 0 ]; do
 183
 184     case "$1" in
 185         -h|--help)
 186             usage ; exit 0 ;;
 187         -q|--quiet)
 188             quiet="yes"
 189             shift ;;
 190         --start)
 191             set_action "start"
 192             shift ;;
 193         --stop)
 194             set_action "stop"
 195             shift ;;
 196         --restart)
 197             set_action "restart"
 198             shift ;;
 199         --status)
 200             set_action "status"
 201             shift ;;
 202         --queue)
 203             queue="$2"
 204             shift 2 ;;
 205         -*)
 206             die "Error: invalid option switch ($1)" ;;
 207         *)
 208             # We expect the remaining stuff are the instance names
 209             break ;;
 210     esac
 211
 212 done
 213
 214 # Optionally use alternative paths for a dev install
 215 adjust_paths_dev_install $1
 216
 217 if [ "$DEV_INSTALL" = "" ]; then
 218     worker_DAEMON="${KOHA_HOME}/bin/background_jobs_worker.pl"
 219 else
 220     worker_DAEMON="${KOHA_HOME}/misc/background_jobs_worker.pl"
 221 fi
 222
 223 # PERL5LIB has been read from etc/default
 224 export PERL5LIB
 225
 226 if [ $# -gt 0 ]; then
 227     # We have at least one instance name
 228     for name in "$@"; do
 229
 230         if is_instance $name; then
 231
 232             case $op in
 233                 "start")
 234                     start_worker $name $queue
 235                     ;;
 236                 "stop")
 237                     stop_worker $name $queue
 238                     ;;
 239                 "restart")
 240                     restart_worker $name $queue
 241                     ;;
 242                 "status")
 243                     worker_status $name $queue
 244             esac
 245
 246         else
 247             if [ "$quiet" = "no" ]; then
 248                 log_daemon_msg "Error: Invalid instance name $name"
 249                 log_end_msg 1
 250             fi
 251         fi
 252
 253     done
 254 else
 255     if [ "$quiet" = "no" ]; then
 256         warn "Error: you must provide at least one instance name"
 257     fi
 258 fi
 259
 260 exit 0