debian/scripts/koha-sip

   1 #!/bin/bash
   2
   3 # koha-sip - Manage SIP server for Koha instances
   4 #              Copyright 2019 Theke Solutions
   5 #              Copyright 2012 Catalyst IT, Ltd
   6 #
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 set -e
  21
  22 . /lib/lsb/init-functions
  23
  24 # Read configuration variable file if it is present
  25 [ -r /etc/default/koha-common ] && . /etc/default/koha-common
  26
  27 # include helper functions
  28 if [ -f "/usr/share/koha/bin/koha-functions.sh" ]; then
  29     . "/usr/share/koha/bin/koha-functions.sh"
  30 else
  31     echo "Error: /usr/share/koha/bin/koha-functions.sh not present." 1>&2
  32     exit 1
  33 fi
  34
  35 usage()
  36 {
  37     local scriptname=$(basename $0)
  38
  39     cat <<EOF
  40 $scriptname
  41
  42 This script lets you manage the SIP server for your Koha instances.
  43
  44 Usage:
  45 $scriptname [--start|--stop|--restart] instancename1 [instancename2...]
  46 $scriptname -h|--help
  47
  48     --start               Start the SIP server for the specified instance(s)
  49     --stop                Stop the SIP server for the specified instance(s)
  50     --restart             Restart the SIP server for the specified instance(s)
  51     --status              Show the status of the SIP server for the specified instance(s)
  52     --verbose|-v          Display progress and actions messages
  53     --help|-h             Display this help message
  54
  55 EOF
  56 }
  57
  58 start_sip()
  59 {
  60     local name=$1
  61
  62     _check_and_fix_perms $name
  63
  64     if ! is_sip_running $name; then
  65
  66         adjust_paths_dev_install $name
  67         export KOHA_HOME PERL5LIB
  68
  69         if [ "$DEV_INSTALL" = "" ]; then
  70             LIBDIR=$KOHA_HOME/lib
  71         else
  72             LIBDIR=$KOHA_HOME
  73         fi
  74
  75         DAEMONOPTS="--name=${name}-koha-sip \
  76                     --errlog=/var/log/koha/${name}/sip-error.log \
  77                     --stdout=/var/log/koha/${name}/sip.log \
  78                     --output=/var/log/koha/${name}/sip-output.log \
  79                     --verbose=1 \
  80                     --respawn \
  81                     --delay=30 \
  82                     --pidfiles=/var/run/koha/${name} \
  83                     --user=${name}-koha.${name}-koha"
  84
  85         SIP_PARAMS="$LIBDIR/C4/SIP/SIPServer.pm \
  86                     /etc/koha/sites/${name}/SIPconfig.xml"
  87
  88         [ "$verbose" != "no" ] && \
  89             log_daemon_msg "Starting SIP server for ${name}"
  90
  91         if daemon $DAEMONOPTS -- perl $SIP_PARAMS; then
  92             ([ "$verbose" != "no" ] && \
  93                 log_end_msg 0) || return 0
  94         else
  95             ([ "$verbose" != "no" ] && \
  96                 log_end_msg 1) || return 1
  97         fi
  98     else
  99         if [ "$verbose" != "no" ]; then
 100             log_daemon_msg "Warning: SIP server already running for ${name}"
 101             log_end_msg 0
 102         else
 103             return 0
 104         fi
 105     fi
 106 }
 107
 108 stop_sip()
 109 {
 110     local name=$1
 111
 112     if is_sip_running $name; then
 113
 114         DAEMONOPTS="--name=${name}-koha-sip \
 115                     --errlog=/var/log/koha/${name}/sip-error.log \
 116                     --stdout=/var/log/koha/${name}/sip.log \
 117                     --output=/var/log/koha/${name}/sip-output.log \
 118                     --verbose=1 \
 119                     --respawn \
 120                     --delay=30 \
 121                     --pidfiles=/var/run/koha/${name} \
 122                     --user=${name}-koha.${name}-koha"
 123
 124         [ "$verbose" != "no" ] && \
 125             log_daemon_msg "Stopping SIP server for ${name}"
 126
 127         if daemon $DAEMONOPTS --stop; then
 128             ([ "$verbose" != "no" ] && \
 129                 log_end_msg 0) || return 0
 130         else
 131             ([ "$verbose" != "no" ] && \
 132                 log_end_msg 1) || return 1
 133         fi
 134     else
 135         if [ "$verbose" != "no" ]; then
 136             log_daemon_msg "Warning: SIP server not running for ${name}"
 137             log_end_msg 0
 138         else
 139             return 0
 140         fi
 141     fi
 142 }
 143
 144 restart_sip()
 145 {
 146     local name=$1
 147
 148     if is_sip_running ${name}; then
 149         local noLF="-n"
 150         [ "$verbose" != "no" ] && noLF=""
 151         echo $noLF `stop_sip ${name}`
 152
 153         MAX_ITERATION=10
 154         while is_sip_running ${name}; do
 155             i=$((i+1))
 156             if [ $MAX_ITERATION -lt $i ]; then
 157                 break
 158             fi
 159             sleep 1;
 160
 161         done
 162         echo $noLF `start_sip ${name}`
 163     else
 164         if [ "$verbose" != "no" ]; then
 165             log_daemon_msg "Warning: SIP server not running for ${name}"
 166             log_end_msg 0
 167         else
 168             return 0
 169         fi
 170     fi
 171 }
 172
 173 sip_status()
 174 {
 175     local name=$1
 176
 177     if is_sip_running ${name}; then
 178         log_daemon_msg "SIP server running for ${name}"
 179         log_end_msg 0
 180     else
 181         log_daemon_msg "SIP server not running for ${name}"
 182         log_end_msg 3
 183     fi
 184 }
 185
 186 enable_sip()
 187 {
 188     local name=$1
 189
 190     sipfile=/etc/koha/sites/${name}/SIPconfig.xml
 191
 192     if is_sip_enabled ${name}; then
 193         echo "Warning: SIP server already enabled for ${name}"
 194     else
 195         echo "Enabling SIP server for ${name} - edit ${sipfile} to configure"
 196         cp -v /etc/koha/SIPconfig.xml ${sipfile}
 197         chown ${name}-koha:${name}-koha ${sipfile}
 198         chmod 600 ${sipfile}
 199     fi
 200 }
 201
 202 _check_and_fix_perms()
 203 {
 204     local name=$1
 205
 206     local files="/var/log/koha/${name}/sip-error.log \
 207                  /var/log/koha/${name}/sip.log \
 208                  /var/log/koha/$name/sip-output.log"
 209
 210     for file in ${files}
 211     do
 212         if [ ! -e "${file}" ]; then
 213             touch ${file}
 214         fi
 215         chown "${name}-koha":"${name}-koha" ${file}
 216     done
 217 }
 218
 219 set_action()
 220 {
 221     if [ "$op" = "" ]; then
 222         op=$1
 223     else
 224         die "Error: only one action can be specified."
 225     fi
 226 }
 227
 228 op=""
 229 verbose="no"
 230
 231 # Backwards compatible with old koha-*-sip scripts
 232 # TODO: Remove once there's consensus to remove the legacy scripts
 233 used_script_name=$(basename $0)
 234
 235 if [ "$used_script_name" != "koha-sip" ]; then
 236     warn "Deprecated script used (${used_script_name})"
 237
 238     case "$used_script_name" in
 239         koha-start-sip)
 240             set_action "start" ;;
 241         koha-stop-sip)
 242             set_action "stop" ;;
 243         koha-enable-sip)
 244             set_action "enable" ;;
 245         *)
 246             break ;;
 247     esac
 248 fi
 249 # / Backwards compatible handling code
 250
 251 # Read command line parameters
 252 while [ $# -gt 0 ]; do
 253
 254     case "$1" in
 255         -h|--help)
 256             usage ; exit 0 ;;
 257         -v|--verbose)
 258             verbose="yes"
 259             shift ;;
 260         --start)
 261             set_action "start"
 262             shift ;;
 263         --stop)
 264             set_action "stop"
 265             shift ;;
 266         --restart)
 267             set_action "restart"
 268             shift ;;
 269         --status)
 270             set_action "status"
 271             shift ;;
 272         --enable)
 273             set_action "enable"
 274             shift ;;
 275         -*)
 276             die "Error: invalid option switch ($1)" ;;
 277         *)
 278             # We expect the remaining stuff are the instance names
 279             break ;;
 280     esac
 281
 282 done
 283
 284 if [ $# -gt 0 ]; then
 285     # We have at least one instance name
 286     for name in "$@"; do
 287
 288         if is_instance $name; then
 289
 290             export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
 291
 292             case $op in
 293                 "start")
 294                     start_sip $name
 295                     ;;
 296                 "stop")
 297                     stop_sip $name
 298                     ;;
 299                 "restart")
 300                     restart_sip $name
 301                     ;;
 302                 "status")
 303                     sip_status $name
 304                     ;;
 305                 "enable")
 306                     enable_sip $name
 307             esac
 308
 309         else
 310             if [ "$verbose" != "no" ]; then
 311                 log_daemon_msg "Error: Invalid instance name $name"
 312                 log_end_msg 1
 313             fi
 314         fi
 315
 316     done
 317 else
 318     if [ "$verbose" != "no" ]; then
 319         warn "Error: you must provide at least one instance name"
 320     fi
 321 fi
 322
 323 exit 0