3 # Copyright 2020 Koha Development team
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.
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.
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/>.
20 . /lib/lsb/init-functions
22 # Read configuration variable file if it is present
23 [ -r /etc/default/koha-common ] && . /etc/default/koha-common
25 # include helper functions
26 if [ -f "/usr/share/koha/bin/koha-functions.sh" ]; then
27 . "/usr/share/koha/bin/koha-functions.sh"
29 echo "Error: /usr/share/koha/bin/koha-functions.sh not present." 1>&2
35 local scriptname=$(basename $0)
40 This script lets you manage the worker daemon for your Koha instances.
43 $scriptname [--start|--stop|--restart] [--queue queue_name] [--quiet|-q] instancename1 [instancename2...]
44 $scriptname --status instancename1 [instancename2...]
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
65 if ! is_worker_running $name $queue; then
67 worker_name=`get_worker_name $name $queue`
69 export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
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"
78 log_daemon_msg "Starting Koha worker daemon for $name ($queue)"
80 if daemon $DAEMONOPTS -- $worker_DAEMON --queue ${queue}; then
86 log_daemon_msg "Error: worker already running for $name ($queue)"
96 if is_worker_running $name $queue; then
97 export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
99 worker_name=`get_worker_name $name $queue`
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"
108 log_daemon_msg "Stopping Koha worker daemon for $name ($queue)"
110 if daemon $DAEMONOPTS --stop -- $worker_DAEMON --queue ${queue}; then
116 log_daemon_msg "Error: worker not running for $name ($queue)"
126 if is_worker_running $name $queue; then
127 export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
129 worker_name=`get_worker_name $name $queue`
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"
138 log_daemon_msg "Restarting Koha worker daemon for $name ($queue)"
140 if daemon $DAEMONOPTS --restart -- $worker_DAEMON --queue ${queue}; then
146 log_warning_msg "Worker not running for $name ($queue)."
147 start_worker $name $queue
156 if is_worker_running ${name} ${queue}; then
157 log_daemon_msg "worker running for ${name} ($queue)"
160 log_daemon_msg "worker not running for ${name} ($queue)"
167 if [ "$op" = "" ]; then
170 die "Error: only one action can be specified."
178 # Read command line parameters
179 while [ $# -gt 0 ]; do
203 die "Error: invalid option switch ($1)" ;;
205 # We expect the remaining stuff are the instance names
211 # Optionally use alternative paths for a dev install
212 adjust_paths_dev_install $1
214 if [ "$DEV_INSTALL" = "" ]; then
215 worker_DAEMON="${KOHA_HOME}/bin/workers/background_jobs_worker.pl"
217 worker_DAEMON="${KOHA_HOME}/misc/workers/background_jobs_worker.pl"
220 # PERL5LIB has been read from etc/default
223 if [ $# -gt 0 ]; then
224 # We have at least one instance name
227 if is_instance $name; then
231 start_worker $name $queue
234 stop_worker $name $queue
237 restart_worker $name $queue
240 worker_status $name $queue
244 if [ "$quiet" = "no" ]; then
245 log_daemon_msg "Error: Invalid instance name $name"
252 if [ "$quiet" = "no" ]; then
253 warn "Error: you must provide at least one instance name"