3 # Copyright 2015 Theke Solutions
4 # Copyright 2016 Koha-Suomi
6 # This file is part of Koha.
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
23 . /lib/lsb/init-functions
25 # Read configuration variable file if it is present
26 [ -r /etc/default/koha-common ] && . /etc/default/koha-common
28 # include helper functions
29 if [ -f "/usr/share/koha/bin/koha-functions.sh" ]; then
30 . "/usr/share/koha/bin/koha-functions.sh"
32 echo "Error: /usr/share/koha/bin/koha-functions.sh not present." 1>&2
38 local scriptname=$(basename $0)
43 This script lets you manage the plack daemons for your Koha instances.
46 $scriptname --start|--stop|--restart|--reload|--status [--quiet|-q] instancename1 [instancename2...]
47 $scriptname --enable|--disable instancename1 [instancename2]
50 --start Start the plack daemon for the specified instances
51 --stop Stop the plack daemon for the specified instances
52 --restart Restart the plack daemon for the specified instances
53 --reload Reload the plack daemon for the specified instances,
54 letting the busy workers finish processing their
55 requests before restarting them
56 --enable Enable plack for the specified instances
57 --disable Disable plack for the specified instances
58 --status Show the status of Plack for the specified instances
59 --debugger Enable running Plack in debug mode
60 --debugger-key Specify the key the IDE is expecting
61 --debugger-location Specify the host:port for your debugger tool (defaults
63 --debugger-path Specify the path for the debugger library
64 --quiet|-q Make the script quiet about non existent instance names
65 (useful for calling from another scripts).
66 --help|-h Display this help message
75 local PIDFILE="/var/run/koha/${instancename}/plack.pid"
76 local PLACKSOCKET="/var/run/koha/${instancename}/plack.sock"
77 local PSGIFILE="/etc/koha/plack.psgi"
78 local NAME="${instancename}-koha-plack"
80 if [ -e "/etc/koha/sites/${instancename}/plack.psgi" ]; then
81 # pick instance-specific psgi file
82 PSGIFILE="/etc/koha/sites/${instancename}/plack.psgi"
83 fi # else stick with the default one
85 _check_and_fix_perms $instancename
87 PLACK_MAX_REQUESTS=$(run_safe_xmlstarlet $instancename plack_max_requests)
88 [ -z $PLACK_MAX_REQUESTS ] && PLACK_MAX_REQUESTS="50"
89 PLACK_WORKERS=$(run_safe_xmlstarlet $instancename plack_workers)
90 [ -z $PLACK_WORKERS ] && PLACK_WORKERS="2"
92 instance_user="${instancename}-koha"
94 environment="deployment"
95 daemonize="--daemonize"
96 logging="--access-log /var/log/koha/${instancename}/plack.log \
97 --error-log /var/log/koha/${instancename}/plack-error.log"
98 max_requests_and_workers="--max-requests ${PLACK_MAX_REQUESTS} --workers ${PLACK_WORKERS}"
100 if [ "$DEV_INSTALL" = "1" ]; then
101 # Maybe we should switch off debug_mode if DEV_INSTALL is not set?
102 environment="development"
105 if [ "$debug_mode" = "yes" ]; then
106 environment="development"
108 logging="" # remote debugger takes care
109 max_requests_and_workers="--workers 1"
110 STARMAN="/usr/bin/perl -d ${STARMAN}"
113 STARMANOPTS="-M FindBin ${max_requests_and_workers} \
114 --user=${instance_user} --group ${instancename}-koha \
115 --pid ${PIDFILE} ${daemonize} ${logging} \
116 -E ${environment} --socket ${PLACKSOCKET} ${PSGIFILE}"
118 if ! is_plack_running ${instancename}; then
119 export KOHA_CONF="/etc/koha/sites/${instancename}/koha-conf.xml"
121 log_daemon_msg "Starting Plack daemon for ${instancename}"
123 # Change to the instance's user dir
125 eval cd ~$instance_user
127 if ${STARMAN} ${STARMANOPTS}; then
132 # Go back to the original dir
136 log_daemon_msg "Error: Plack already running for ${instancename}"
143 local instancename=$1
145 local PIDFILE="/var/run/koha/${instancename}/plack.pid"
147 if is_plack_running ${instancename}; then
149 log_daemon_msg "Stopping Plack daemon for ${instancename}"
151 if start-stop-daemon --pidfile ${PIDFILE} --user="${instancename}-koha" --stop --retry=QUIT/30/KILL/5; then
157 log_daemon_msg "Error: Plack not running for ${instancename}"
164 local instancename=$1
166 local PIDFILE="/var/run/koha/${instancename}/plack.pid"
168 if is_plack_running ${instancename}; then
169 stop_plack $instancename && start_plack $instancename
171 log_warning_msg "Plack not running for ${instancename}."
172 start_plack $instancename
178 local instancename=$1
180 local PIDFILE="/var/run/koha/${instancename}/plack.pid"
182 if is_plack_running ${instancename}; then
183 log_daemon_msg "Reloading Plack daemon for ${instancename}"
185 if start-stop-daemon --pidfile ${PIDFILE} --user="${instancename}-koha" --stop --signal HUP; then
191 log_daemon_msg "Error: Plack not running for ${instancename}"
200 if is_plack_running ${name}; then
201 log_daemon_msg "Plack running for ${name}"
204 log_daemon_msg "Plack not running for ${name}"
211 local instancename=$1
212 local instancefile=$(get_apache_config_for "$instancename")
218 if ! is_plack_enabled_opac $instancefile; then
219 # Uncomment the plack related lines for OPAC
220 sed -i 's:^\s*#\(\s*Include /etc/koha/apache-shared-opac-plack.conf\)$:\1:' "$instancefile"
221 if ! is_plack_enabled_opac $instancefile; then
222 [ "${quiet}" != "yes" ] && warn "Plack not enabled for ${instancename} OPAC"
225 [ "${quiet}" != "yes" ] && warn "Plack enabled for ${instancename} OPAC"
228 [ "${quiet}" != "yes" ] && warn "Plack already enabled for ${instancename} OPAC"
231 if ! is_plack_enabled_intranet $instancefile; then
232 # Uncomment the plack related lines for intranet
233 sed -i 's:^\s*#\(\s*Include /etc/koha/apache-shared-intranet-plack.conf\)$:\1:' "$instancefile"
234 if ! is_plack_enabled_intranet $instancefile; then
235 [ "${quiet}" != "yes" ] && warn "Plack not enabled for ${instancename} Intranet"
238 [ "${quiet}" != "yes" ] && warn "Plack enabled for ${instancename} Intranet"
241 [ "${quiet}" != "yes" ] && warn "Plack already enabled for ${instancename} Intranet"
245 # Fail if it was already plack enabled.
246 if [ $alreadyopac -eq 1 ] && [ $alreadyintra -eq 1 ] ; then
248 elif [ "$alreadyopac" != "$alreadyintra" ]; then
249 [ "${quiet}" != "yes" ] && warn "$instancename had a plack configuration error. Please confirm it is corrected."
252 # Succeed if both or any plack were turned on.
253 if [ $failopac -eq 0 ] || [ $failintra -eq 0 ] ; then
262 local instancename=$1
263 local instancefile=$(get_apache_config_for "$instancename")
269 if is_plack_enabled_opac $instancefile ; then
270 # Comment the plack related lines for OPAC
271 sed -i 's:^\(\s*Include /etc/koha/apache-shared-opac-plack.conf\)$:#\1:' "$instancefile"
272 if is_plack_enabled_opac $instancefile ; then
273 [ "${quiet}" != "yes" ] && warn "Plack not disabled for ${instancename} OPAC"
276 [ "${quiet}" != "yes" ] && warn "Plack disabled for ${instancename} OPAC"
279 [ "${quiet}" != "yes" ] && warn "Plack already disabled for ${instancename} OPAC"
282 if is_plack_enabled_intranet $instancefile; then
283 # Comment the plack related lines for intranet
284 sed -i 's:^\(\s*Include /etc/koha/apache-shared-intranet-plack.conf\)$:#\1:' "$instancefile"
285 if is_plack_enabled_intranet $instancefile; then
286 [ "${quiet}" != "yes" ] && warn "Plack not disabled for ${instancename} Intranet"
289 [ "${quiet}" != "yes" ] && warn "Plack disabled for ${instancename} Intranet"
292 [ "${quiet}" != "yes" ] && warn "Plack already disabled for ${instancename} Intranet"
296 # Fail if it was already plack disabled.
297 if [ $alreadyopac -eq 1 ] && [ $alreadyintra -eq 1 ] ; then
299 elif [ "$alreadyopac" != "$alreadyintra" ]; then
300 [ "${quiet}" != "yes" ] && warn "$instancename had a plack configuration error. Please confirm it is corrected."
303 # Succeed if both or any plack were turned off.
304 if [ $failopac -eq 0 ] || [ $failintra -eq 0 ] ; then
313 local apache_version_ok="no"
314 local required_modules="headers proxy_http"
315 local missing_modules=""
317 if /usr/sbin/apache2ctl -v | grep -q "Server version: Apache/2.4"; then
318 apache_version_ok="yes"
321 for module in ${required_modules}; do
322 if ! /usr/sbin/apachectl -M 2> /dev/null | grep -q ${module}; then
323 missing_modules="${missing_modules}${module} "
327 if [ "${apache_version_ok}" != "yes" ]; then
328 warn "WARNING: koha-plack requires Apache 2.4.x and you don't have that."
331 if [ "${missing_modules}" != "" ]; then
333 WARNING: koha-plack requires some Apache modules that you are missing.
334 You can install them with:
336 sudo a2enmod ${missing_modules}
343 _check_and_fix_perms()
347 local files="/var/log/koha/${instance}/plack.log \
348 /var/log/koha/${instance}/plack-error.log"
352 if [ ! -e "${file}" ]; then
355 chown "${instance}-koha":"${instance}-koha" ${file}
361 if [ "$op" = "" ]; then
364 die "Error: only one action can be specified."
370 local PERL5LIB=$PERL5LIB
371 local KOHA_HOME=$KOHA_HOME
372 local DEV_INSTALL=$DEV_INSTALL
374 adjust_paths_dev_install $name
375 PERL5LIB=$PERL5LIB:$KOHA_HOME/installer:$KOHA_HOME/lib/installer
376 # If debug mode is enabled, add the debugger lib path
377 # to PERL5LIB if appropriate
378 #FIXME: many of these variables should be set in a higher scope
379 if [ "$debug_mode" = "yes" ]; then
380 if [ "$debugger_path" != "" ]; then
381 PERL5LIB="${debugger_path}":$PERL5LIB
383 export PERL5DB="BEGIN { require q(${debugger_path}/perl5db.pl) }"
384 export PERLDB_OPTS="RemotePort=${debugger_location} async=1 LogFile=/var/log/koha/${name}/plack-debug.log"
385 export DBGP_IDEKEY=${debugger_key}
418 STARMAN=$(which starman)
423 debugger_location="localhost:9000"
426 # Read command line parameters
427 while [ $# -gt 0 ]; do
463 debugger_location="$2"
469 die "Error: invalid option switch ($1)" ;;
471 # We expect the remaining stuff are the instance names
477 [ "${quiet}" != "yes" ] && check_env_and_warn
483 if [ $# -gt 0 ]; then
484 # We have at least one instance name
487 if is_instance $name; then
490 if [ "$quiet" = "no" ]; then
491 log_daemon_msg "Error: Invalid instance name $name"
498 if [ "$quiet" = "no" ]; then
499 warn "Error: you must provide at least one instance name"