debian/scripts/koha-zebra

   1 #!/bin/bash
   2
   3 # koha-zebra - Manage Zebra daemons for Koha instances
   4 #              Copyright 2016 Theke Solutions
   5 #              Copyright 2010 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 Zebra daemon for your Koha instances.
  43
  44 Usage:
  45 $scriptname [--start|--stop|--restart] instancename1 [instancename2...]
  46 $scriptname -h|--help
  47
  48     --start               Start the Zebra daemon for the specified instance(s)
  49     --stop                Stop the Zebra daemon for the specified instance(s)
  50     --restart             Restart the Zebra daemon for the specified instance(s)
  51     --status              Show the status of the Zebra daemon 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_zebra()
  59 {
  60     local name=$1
  61
  62     # get zebra log levels from koha-conf.xml
  63     local loglevels=$(get_loglevels ${name})
  64
  65     if ! is_zebra_running $name; then
  66
  67         _check_and_fix_perms ${name}
  68
  69         DAEMONOPTS="--name=${name}-koha-zebra \
  70                     --pidfiles=/var/run/koha/${name}/ \
  71                     --errlog=/var/log/koha/${name}/zebra-error.log \
  72                     --output=/var/log/koha/${name}/zebra-output.log \
  73                     --verbose=1 \
  74                     --respawn \
  75                     --delay=30 \
  76                     --user=${name}-koha.${name}-koha"
  77
  78         ZEBRA_PARAMS="-v $loglevels \
  79                       -f /etc/koha/sites/${name}/koha-conf.xml"
  80
  81         [ "$verbose" != "no" ] && \
  82             log_daemon_msg "Starting Koha Zebra daemon for ${name}"
  83
  84         if daemon $DAEMONOPTS -- $ZEBRA_DAEMON $ZEBRA_PARAMS; then
  85             [ "$verbose" != "no" ] && \
  86                 log_end_msg 0
  87         else
  88             [ "$verbose" != "no" ] && \
  89                 log_end_msg 1
  90         fi
  91     else
  92         if [ "$verbose" != "no" ]; then
  93             log_daemon_msg "Error: Zebra already running for ${name}"
  94             log_end_msg 1
  95         fi
  96     fi
  97 }
  98
  99 stop_zebra()
 100 {
 101     local name=$1
 102
 103     if is_zebra_running $name; then
 104
 105         DAEMONOPTS="--name=${name}-koha-zebra \
 106                     --pidfiles=/var/run/koha/${name}/ \
 107                     --errlog=/var/log/koha/${name}/zebra-error.log \
 108                     --output=/var/log/koha/${name}/zebra-output.log \
 109                     --verbose=1 \
 110                     --respawn \
 111                     --delay=30 \
 112                     --user=${name}-koha.${name}-koha"
 113
 114         [ "$verbose" != "no" ] && \
 115             log_daemon_msg "Stopping Koha Zebra daemon for ${name}"
 116
 117         if daemon $DAEMONOPTS --stop -- $ZEBRA_DAEMON $ZEBRA_PARAMS; then
 118             [ "$verbose" != "no" ] && \
 119                 log_end_msg 0
 120         else
 121             [ "$verbose" != "no" ] && \
 122                 log_end_msg 1
 123         fi
 124     else
 125         if [ "$verbose" != "no" ]; then
 126             log_daemon_msg "Error: Zebra not running for ${name}"
 127             log_end_msg 1
 128         fi
 129     fi
 130 }
 131
 132 restart_zebra()
 133 {
 134     local name=$1
 135
 136     if is_zebra_running ${name}; then
 137
 138         stop_zebra ${name} && \
 139         start_zebra ${name}
 140     else
 141         if [ "$verbose" != "no" ]; then
 142             log_daemon_msg "Error: Zebra not running for ${name}"
 143             log_end_msg 1
 144         fi
 145     fi
 146 }
 147
 148 zebra_status()
 149 {
 150     local name=$1
 151
 152     if is_zebra_running; then
 153         log_daemon_msg "Zebra running for ${name}"
 154         log_end_msg 0
 155     else
 156         log_daemon_msg "Zebra not running for ${name}"
 157         log_end_msg 3
 158     fi
 159 }
 160
 161 _check_and_fix_perms()
 162 {
 163     local name=$1
 164
 165     local files="/var/log/koha/${name}/zebra-output.log \
 166                  /var/log/koha/${name}/zebra-error.log"
 167
 168     for file in ${files}
 169     do
 170         if [ ! -e "${file}" ]; then
 171             touch ${file}
 172         fi
 173         chown "${name}-koha":"${name}-koha" ${file}
 174     done
 175 }
 176
 177 set_action()
 178 {
 179     if [ "$op" = "" ]; then
 180         op=$1
 181     else
 182         die "Error: only one action can be specified."
 183     fi
 184 }
 185
 186 op=""
 187 verbose="no"
 188
 189 # Backwards compatible with old koha-*-zebra scripts
 190 # TODO: Remove once there's consensus to remove the legacy scripts
 191 used_script_name=$(basename $0)
 192
 193 if [ "$used_script_name" != "koha-zebra" ]; then
 194     warn "Deprecated script used (${used_script_name})"
 195
 196     case "$used_script_name" in
 197         koha-start-zebra)
 198             set_action "start" ;;
 199         koha-stop-zebra)
 200             set_action "stop" ;;
 201         koha-restart-zebra)
 202             set_action "restart" ;;
 203         *)
 204             break ;;
 205     esac
 206 fi
 207 # / Backwards compatible handling code
 208
 209 # Read command line parameters
 210 while [ $# -gt 0 ]; do
 211
 212     case "$1" in
 213         -h|--help)
 214             usage ; exit 0 ;;
 215         -v|--verbose)
 216             verbose="yes"
 217             shift ;;
 218         --start)
 219             set_action "start"
 220             shift ;;
 221         --stop)
 222             set_action "stop"
 223             shift ;;
 224         --restart)
 225             set_action "restart"
 226             shift ;;
 227         -*)
 228             die "Error: invalid option switch ($1)" ;;
 229         *)
 230             # We expect the remaining stuff are the instance names
 231             break ;;
 232     esac
 233
 234 done
 235
 236 ZEBRA_DAEMON=$(which zebrasrv)
 237
 238 if [ $# -gt 0 ]; then
 239     # We have at least one instance name
 240     for name in "$@"; do
 241
 242         if is_instance $name; then
 243
 244             case $op in
 245                 "start")
 246                     start_zebra $name
 247                     ;;
 248                 "stop")
 249                     stop_zebra $name
 250                     ;;
 251                 "restart")
 252                     restart_zebra $name
 253                     ;;
 254                 "status")
 255                     zebra_status $name
 256             esac
 257
 258         else
 259             if [ "$verbose" != "no" ]; then
 260                 log_daemon_msg "Error: Invalid instance name $name"
 261                 log_end_msg 1
 262             fi
 263         fi
 264
 265     done
 266 else
 267     if [ "$verbose" != "no" ]; then
 268         warn "Error: you must provide at least one instance name"
 269     fi
 270 fi
 271
 272 exit 0