Koha-clms/debian/scripts/koha-worker

276 lines
7.7 KiB
Bash
Executable File

#!/bin/bash
#
# Copyright 2020 Koha Development team
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
. /lib/lsb/init-functions
# Read configuration variable file if it is present
[ -r /etc/default/koha-common ] && . /etc/default/koha-common
# include helper functions
if [ -f "/usr/share/koha/bin/koha-functions.sh" ]; then
. "/usr/share/koha/bin/koha-functions.sh"
else
echo "Error: /usr/share/koha/bin/koha-functions.sh not present." 1>&2
exit 1
fi
usage()
{
local scriptname=$(basename $0)
cat <<EOF
$scriptname
This script lets you manage the worker daemon for your Koha instances.
Usage:
$scriptname [--start|--stop|--restart] [--queue queue_name|--all-queues] [--quiet|-q] instancename1 [instancename2...]
$scriptname --status instancename1 [instancename2...]
$scriptname -h|--help
--start Start the worker daemon for the specified instances
--stop Stop the worker daemon for the specified instances
--restart Restart the worker daemon for the specified instances
--queue Specify the queue/worker to perform the action on - 'default' is
used if not specified (unless --all-queues is passed)
current queues are: default, long_tasks
--all-queues Perform the action on all defined queues
--status Show the status of the worker for the specified instances
--quiet|-q Make the script quiet about non existent instance names
(useful for calling from another scripts).
--help|-h Display this help message
Note: There used to be a queue called elastic_index, but since the introduction
of koha-es-indexer this queue should not be active.
EOF
}
start_worker()
{
local name=$1
local queues=$2
local error_count=0
for queue in $queues; do
if ! is_worker_running "$name" "$queue"; then
worker_name=$(get_worker_name "$name" "$queue")
export KOHA_CONF="/etc/koha/sites/${name}/koha-conf.xml"
DAEMONOPTS="--name=${worker_name} \
--errlog=/var/log/koha/${name}/worker-error.log \
--output=/var/log/koha/${name}/worker-output.log \
--pidfiles=/var/run/koha/${name}/ \
--verbose=1 --respawn --delay=30 \
--user=${name}-koha.${name}-koha"
echo "Starting Koha worker daemon for ${name} (${queue})"
if ! daemon $DAEMONOPTS -- "$worker_DAEMON" --queue "$queue"; then
((error_count++))
fi
else
echo "Error: worker already running for ${name} (${queue})"
((error_count++))
fi
done
log_end_msg $error_count
}
stop_worker()
{
local name=$1
local queues=$2
local error_count=0
for queue in $queues; do
if is_worker_running "$name" "$queue"; then
export KOHA_CONF="/etc/koha/sites/${name}/koha-conf.xml"
worker_name=$(get_worker_name "$name" "$queue")
DAEMONOPTS="--name=${worker_name} \
--errlog=/var/log/koha/${name}/worker-error.log \
--output=/var/log/koha/${name}/worker-output.log \
--pidfiles=/var/run/koha/${name}/ \
--verbose=1 --respawn --delay=30 \
--user=${name}-koha.${name}-koha"
echo "Stopping Koha worker daemon for ${name} (${queue})"
if ! daemon $DAEMONOPTS --stop -- "$worker_DAEMON" --queue "$queue"; then
((error_count++))
fi
else
echo "Error: worker not running for ${name} (${queue})"
((error_count++))
fi
done
log_end_msg $error_count
}
restart_worker()
{
local name=$1
local queues=$2
local error_count=0
for queue in $queues; do
if is_worker_running "$name" "$queue"; then
export KOHA_CONF="/etc/koha/sites/${name}/koha-conf.xml"
worker_name=$(get_worker_name "$name" "$queue")
DAEMONOPTS="--name=${worker_name} \
--errlog=/var/log/koha/${name}/worker-error.log \
--output=/var/log/koha/${name}/worker-output.log \
--pidfiles=/var/run/koha/${name}/ \
--verbose=1 --respawn --delay=30 \
--user=${name}-koha.${name}-koha"
echo "Restarting Koha worker daemon for ${name} (${queue})"
if ! daemon $DAEMONOPTS --restart -- "$worker_DAEMON" --queue "$queue"; then
((error_count++))
fi
else
echo "Worker not running for ${name} (${queue})."
start_worker $name $queue
fi
done
log_end_msg $error_count
}
worker_status()
{
local name=$1
local queues=$2
for queue in $queues; do
if is_worker_running "$name" "$queue"; then
log_daemon_msg "worker running for ${name} (${queue})"
log_end_msg 0
else
log_daemon_msg "worker not running for ${name} (${queue})"
log_end_msg 3
fi
done
}
set_action()
{
if [ "$op" = "" ]; then
op=$1
else
die "Error: only one action can be specified."
fi
}
op=""
queue="default"
quiet="no"
all_queues="no"
# Read command line parameters
while [ $# -gt 0 ]; do
case "$1" in
-h|--help)
usage ; exit 0 ;;
-q|--quiet)
quiet="yes"
shift ;;
--start)
set_action "start"
shift ;;
--stop)
set_action "stop"
shift ;;
--restart)
set_action "restart"
shift ;;
--status)
set_action "status"
shift ;;
--queue)
queue="$2"
shift 2 ;;
--all-queues)
all_queues="yes";
shift ;;
-*)
die "Error: invalid option switch ($1)" ;;
*)
# We expect the remaining stuff are the instance names
break ;;
esac
done
if [ $# -gt 0 ]; then
# We have at least one instance name
for name in "$@"; do
if is_instance $name; then
adjust_paths_git_install $name
worker_DAEMON="${KOHA_HOME}/${KOHA_BINDIR}/workers/background_jobs_worker.pl"
export PERL5LIB
if [ "$all_queues" = "yes" ]; then
queues=$(get_worker_queues | xargs)
else
queues=$queue
fi
case $op in
"start")
start_worker "$name" "$queues"
;;
"stop")
stop_worker "$name" "$queues"
;;
"restart")
restart_worker "$name" "$queues"
;;
"status")
worker_status "$name" "$queues"
esac
else
if [ "$quiet" = "no" ]; then
log_daemon_msg "Error: Invalid instance name $name"
log_end_msg 1
fi
fi
done
else
if [ "$quiet" = "no" ]; then
warn "Error: you must provide at least one instance name"
fi
fi
exit 0