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] [--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     --status              Show the status of the worker for the specified instances
  51     --quiet|-q            Make the script quiet about non existent instance names
  52                           (useful for calling from another scripts).
  53     --help|-h             Display this help message
  54
  55 EOF
  56 }
  57
  58 start_worker()
  59 {
  60     local name=$1
  61     local queue=$2
  62
  63     if ! is_worker_running $name $queue; then
  64
  65         worker_name=`get_worker_name $name $queue`
  66
  67         export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
  68
  69         DAEMONOPTS="--name=${worker_name} \
  70             --errlog=/var/log/koha/$name/worker-error.log \
  71             --stdout=/var/log/koha/$name/worker.log \
  72             --output=/var/log/koha/$name/worker-output.log \
  73             --pidfiles=/var/run/koha/$name/ \
  74             --verbose=1 --respawn --delay=30 \
  75             --user=$name-koha.$name-koha"
  76
  77         log_daemon_msg "Starting Koha worker daemon for $name ($queue)"
  78
  79         if daemon $DAEMONOPTS -- $worker_DAEMON --queue ${queue}; then
  80             log_end_msg 0
  81         else
  82             log_end_msg 1
  83         fi
  84     else
  85         log_daemon_msg "Error: worker already running for $name ($queue)"
  86         log_end_msg 1
  87     fi
  88 }
  89
  90 stop_worker()
  91 {
  92     local name=$1
  93     local queue=$2
  94
  95     if is_worker_running $name $queue; then
  96         export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
  97
  98         worker_name=`get_worker_name $name $queue`
  99
 100         DAEMONOPTS="--name=${worker_name} \
 101             --errlog=/var/log/koha/$name/worker-error.log \
 102             --stdout=/var/log/koha/$name/worker.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             --stdout=/var/log/koha/$name/worker.log \
 134             --output=/var/log/koha/$name/worker-output.log \
 135             --pidfiles=/var/run/koha/$name/ \
 136             --verbose=1 --respawn --delay=30 \
 137             --user=$name-koha.$name-koha"
 138
 139         log_daemon_msg "Restarting Koha worker daemon for $name ($queue)"
 140
 141         if daemon $DAEMONOPTS --restart -- $worker_DAEMON --queue ${queue}; then
 142             log_end_msg 0
 143         else
 144             log_end_msg 1
 145         fi
 146     else
 147         log_daemon_msg "Error: worker not running for $name ($queue)"
 148         log_end_msg 1
 149     fi
 150 }
 151
 152 worker_status()
 153 {
 154     local name=$1
 155     local queue=$2
 156
 157     if is_worker_running ${name} ${queue}; then
 158         log_daemon_msg "worker running for ${name} ($queue)"
 159         log_end_msg 0
 160     else
 161         log_daemon_msg "worker not running for ${name} ($queue)"
 162         log_end_msg 3
 163     fi
 164 }
 165
 166 set_action()
 167 {
 168     if [ "$op" = "" ]; then
 169         op=$1
 170     else
 171         die "Error: only one action can be specified."
 172     fi
 173 }
 174
 175 op=""
 176 queue="default"
 177 quiet="no"
 178
 179 # Read command line parameters
 180 while [ $# -gt 0 ]; do
 181
 182     case "$1" in
 183         -h|--help)
 184             usage ; exit 0 ;;
 185         -q|--quiet)
 186             quiet="yes"
 187             shift ;;
 188         --start)
 189             set_action "start"
 190             shift ;;
 191         --stop)
 192             set_action "stop"
 193             shift ;;
 194         --restart)
 195             set_action "restart"
 196             shift ;;
 197         --status)
 198             set_action "status"
 199             shift ;;
 200         --queue)
 201             queue="$2"
 202             shift 2 ;;
 203         -*)
 204             die "Error: invalid option switch ($1)" ;;
 205         *)
 206             # We expect the remaining stuff are the instance names
 207             break ;;
 208     esac
 209
 210 done
 211
 212 # Optionally use alternative paths for a dev install
 213 adjust_paths_dev_install $1
 214
 215 if [ "$DEV_INSTALL" = "" ]; then
 216     worker_DAEMON="${KOHA_HOME}/bin/background_jobs_worker.pl"
 217 else
 218     worker_DAEMON="${KOHA_HOME}/misc/background_jobs_worker.pl"
 219 fi
 220
 221 # PERL5LIB has been read from etc/default
 222 export PERL5LIB
 223
 224 if [ $# -gt 0 ]; then
 225     # We have at least one instance name
 226     for name in "$@"; do
 227
 228         if is_instance $name; then
 229
 230             case $op in
 231                 "start")
 232                     start_worker $name $queue
 233                     ;;
 234                 "stop")
 235                     stop_worker $name $queue
 236                     ;;
 237                 "restart")
 238                     restart_worker $name $queue
 239                     ;;
 240                 "status")
 241                     worker_status $name $queue
 242             esac
 243
 244         else
 245             if [ "$quiet" = "no" ]; then
 246                 log_daemon_msg "Error: Invalid instance name $name"
 247                 log_end_msg 1
 248             fi
 249         fi
 250
 251     done
 252 else
 253     if [ "$quiet" = "no" ]; then
 254         warn "Error: you must provide at least one instance name"
 255     fi
 256 fi
 257
 258 exit 0