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             --output=/var/log/koha/$name/worker-output.log \
  74             --pidfiles=/var/run/koha/$name/ \
  75             --verbose=1 --respawn --delay=30 \
  76             --user=$name-koha.$name-koha"
  77
  78         log_daemon_msg "Starting Koha worker daemon for $name ($queue)"
  79
  80         if daemon $DAEMONOPTS -- $worker_DAEMON --queue ${queue}; then
  81             log_end_msg 0
  82         else
  83             log_end_msg 1
  84         fi
  85     else
  86         log_daemon_msg "Error: worker already running for $name ($queue)"
  87         log_end_msg 1
  88     fi
  89 }
  90
  91 stop_worker()
  92 {
  93     local name=$1
  94     local queue=$2
  95
  96     if is_worker_running $name $queue; then
  97         export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
  98
  99         worker_name=`get_worker_name $name $queue`
 100
 101         DAEMONOPTS="--name=${worker_name} \
 102             --errlog=/var/log/koha/$name/worker-error.log \
 103             --output=/var/log/koha/$name/worker-output.log \
 104             --pidfiles=/var/run/koha/$name/ \
 105             --verbose=1 --respawn --delay=30 \
 106             --user=$name-koha.$name-koha"
 107
 108         log_daemon_msg "Stopping Koha worker daemon for $name ($queue)"
 109
 110         if daemon $DAEMONOPTS --stop -- $worker_DAEMON --queue ${queue}; then
 111             log_end_msg 0
 112         else
 113             log_end_msg 1
 114         fi
 115     else
 116         log_daemon_msg "Error: worker not running for $name ($queue)"
 117         log_end_msg 1
 118     fi
 119 }
 120
 121 restart_worker()
 122 {
 123     local name=$1
 124     local queue=$2
 125
 126     if is_worker_running $name $queue; then
 127         export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
 128
 129         worker_name=`get_worker_name $name $queue`
 130
 131         DAEMONOPTS="--name=${worker_name} \
 132             --errlog=/var/log/koha/$name/worker-error.log \
 133             --output=/var/log/koha/$name/worker-output.log \
 134             --pidfiles=/var/run/koha/$name/ \
 135             --verbose=1 --respawn --delay=30 \
 136             --user=$name-koha.$name-koha"
 137
 138         log_daemon_msg "Restarting Koha worker daemon for $name ($queue)"
 139
 140         if daemon $DAEMONOPTS --restart -- $worker_DAEMON --queue ${queue}; then
 141             log_end_msg 0
 142         else
 143             log_end_msg 1
 144         fi
 145     else
 146         log_warning_msg "Worker not running for $name ($queue)."
 147         start_worker $name $queue
 148     fi
 149 }
 150
 151 worker_status()
 152 {
 153     local name=$1
 154     local queue=$2
 155
 156     if is_worker_running ${name} ${queue}; then
 157         log_daemon_msg "worker running for ${name} ($queue)"
 158         log_end_msg 0
 159     else
 160         log_daemon_msg "worker not running for ${name} ($queue)"
 161         log_end_msg 3
 162     fi
 163 }
 164
 165 set_action()
 166 {
 167     if [ "$op" = "" ]; then
 168         op=$1
 169     else
 170         die "Error: only one action can be specified."
 171     fi
 172 }
 173
 174 op=""
 175 queue="default"
 176 quiet="no"
 177
 178 # Read command line parameters
 179 while [ $# -gt 0 ]; do
 180
 181     case "$1" in
 182         -h|--help)
 183             usage ; exit 0 ;;
 184         -q|--quiet)
 185             quiet="yes"
 186             shift ;;
 187         --start)
 188             set_action "start"
 189             shift ;;
 190         --stop)
 191             set_action "stop"
 192             shift ;;
 193         --restart)
 194             set_action "restart"
 195             shift ;;
 196         --status)
 197             set_action "status"
 198             shift ;;
 199         --queue)
 200             queue="$2"
 201             shift 2 ;;
 202         -*)
 203             die "Error: invalid option switch ($1)" ;;
 204         *)
 205             # We expect the remaining stuff are the instance names
 206             break ;;
 207     esac
 208
 209 done
 210
 211 # Optionally use alternative paths for a dev install
 212 adjust_paths_dev_install $1
 213
 214 if [ "$DEV_INSTALL" = "" ]; then
 215     worker_DAEMON="${KOHA_HOME}/bin/workers/background_jobs_worker.pl"
 216 else
 217     worker_DAEMON="${KOHA_HOME}/misc/workers/background_jobs_worker.pl"
 218 fi
 219
 220 # PERL5LIB has been read from etc/default
 221 export PERL5LIB
 222
 223 if [ $# -gt 0 ]; then
 224     # We have at least one instance name
 225     for name in "$@"; do
 226
 227         if is_instance $name; then
 228
 229             case $op in
 230                 "start")
 231                     start_worker $name $queue
 232                     ;;
 233                 "stop")
 234                     stop_worker $name $queue
 235                     ;;
 236                 "restart")
 237                     restart_worker $name $queue
 238                     ;;
 239                 "status")
 240                     worker_status $name $queue
 241             esac
 242
 243         else
 244             if [ "$quiet" = "no" ]; then
 245                 log_daemon_msg "Error: Invalid instance name $name"
 246                 log_end_msg 1
 247             fi
 248         fi
 249
 250     done
 251 else
 252     if [ "$quiet" = "no" ]; then
 253         warn "Error: you must provide at least one instance name"
 254     fi
 255 fi
 256
 257 exit 0