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 [--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 --enable Enable plack for the specified instances
54 --disable Disable plack for the specified instances
55 --debugger Enable running Plack in debug mode
56 --debugger-key Specify the key the IDE is expecting
57 --debugger-location Specify the host:port for your debugger tool (defaults
59 --debugger-path Specify the path for the debugger library
60 --quiet|-q Make the script quiet about non existent instance names
61 (useful for calling from another scripts).
62 --help|-h Display this help message
71 local PIDFILE
="/var/run/koha/${instancename}/plack.pid"
72 local PLACKSOCKET
="/var/run/koha/${instancename}/plack.sock"
73 local PSGIFILE
="/etc/koha/plack.psgi"
74 local NAME
="${instancename}-koha-plack"
76 if [ -e "/etc/koha/sites/${instancename}/plack.psgi" ]; then
77 # pick instance-specific psgi file
78 PSGIFILE
="/etc/koha/sites/${instancename}/plack.psgi"
79 fi # else stick with the default one
81 _check_and_fix_perms
$instancename
83 PLACK_MAX_REQUESTS
=$
(run_safe_xmlstarlet
$instancename plack_max_requests
)
84 [ -z $PLACK_MAX_REQUESTS ] && PLACK_MAX_REQUESTS
="50"
85 PLACK_WORKERS
=$
(run_safe_xmlstarlet
$instancename plack_workers
)
86 [ -z $PLACK_WORKERS ] && PLACK_WORKERS
="2"
88 instance_user
="${instancename}-koha"
90 environment
="deployment"
91 daemonize
="--daemonize"
92 logging
="--access-log /var/log/koha/${instancename}/plack.log \
93 --error-log /var/log/koha/${instancename}/plack-error.log"
94 max_requests_and_workers
="--max-requests ${PLACK_MAX_REQUESTS} --workers ${PLACK_WORKERS}"
96 if [ "$debug_mode" = "yes" ]; then
97 environment
="development"
99 logging
="" # remote debugger takes care
100 max_requests_and_workers
="--workers 1"
101 STARMAN
="/usr/bin/perl -d ${STARMAN}"
104 STARMANOPTS
="-M FindBin ${max_requests_and_workers} \
105 --user=${instance_user} --group ${instancename}-koha \
106 --pid ${PIDFILE} ${daemonize} ${logging} \
107 -E ${environment} --socket ${PLACKSOCKET} ${PSGIFILE}"
109 if ! is_plack_running
${instancename}; then
110 export KOHA_CONF
="/etc/koha/sites/${instancename}/koha-conf.xml"
112 log_daemon_msg
"Starting Plack daemon for ${instancename}"
114 # Change to the instance's user dir
116 eval cd ~
$instance_user
118 if ${STARMAN} ${STARMANOPTS}; then
123 # Go back to the original dir
127 log_daemon_msg
"Error: Plack already running for ${instancename}"
134 local instancename
=$1
136 local PIDFILE
="/var/run/koha/${instancename}/plack.pid"
138 if is_plack_running
${instancename}; then
140 log_daemon_msg
"Stopping Plack daemon for ${instancename}"
142 if start-stop-daemon
--pidfile ${PIDFILE} --stop --retry=TERM
/30/KILL
/5; then
148 log_daemon_msg
"Error: Plack not running for ${instancename}"
155 local instancename
=$1
157 local PIDFILE
="/var/run/koha/${instancename}/plack.pid"
159 if is_plack_running
${instancename}; then
161 log_daemon_msg
"Restarting Plack daemon for ${instancename}"
163 if stop_plack
$instancename && start_plack
$instancename; then
169 log_daemon_msg
"Error: Plack not running for ${instancename}"
176 local instancename
=$1
177 local instancefile
=$
(get_apache_config_for
"$instancename")
179 if ! is_plack_enabled
$instancename; then
180 # Uncomment the plack related lines for OPAC and intranet
181 sed -i 's:^\s*#\(\s*Include /etc/koha/apache-shared-opac-plack.conf\)$:\1:' "$instancefile"
182 sed -i 's:^\s*#\(\s*Include /etc/koha/apache-shared-intranet-plack.conf\)$:\1:' "$instancefile"
183 [ "${quiet}" != "yes" ] && warn
"Plack enabled for ${instancename}"
186 [ "${quiet}" != "yes" ] && warn
"Plack already enabled for ${instancename}"
193 local instancename
=$1
194 local instancefile
=$
(get_apache_config_for
"$instancename")
196 if is_plack_enabled
$instancename; then
197 # Comment out the plack related lines for OPAC and intranet
198 sed -i 's:^\(\s*Include /etc/koha/apache-shared-opac-plack.conf\)$:#\1:' "$instancefile"
199 sed -i 's:^\(\s*Include /etc/koha/apache-shared-intranet-plack.conf\)$:#\1:' "$instancefile"
200 [ "${quiet}" != "yes" ] && warn
"Plack disabled for ${instancename}"
203 [ "${quiet}" != "yes" ] && warn
"Plack already disabled for ${instancename}"
210 local apache_version_ok
="no"
211 local required_modules
="headers proxy_http"
212 local missing_modules
=""
214 if /usr
/sbin
/apache2ctl
-v |
grep -q "Server version: Apache/2.4"; then
215 apache_version_ok
="yes"
218 for module
in ${required_modules}; do
219 if ! /usr
/sbin
/apachectl
-M 2> /dev
/null |
grep -q ${module}; then
220 missing_modules
="${missing_modules}${module} "
224 if [ "${apache_version_ok}" != "yes" ]; then
225 warn
"WARNING: koha-plack requires Apache 2.4.x and you don't have that."
228 if [ "${missing_modules}" != "" ]; then
230 WARNING: koha-plack requires some Apache modules that you are missing.
231 You can install them with:
233 sudo a2enmod ${missing_modules}
240 _check_and_fix_perms
()
244 local files
="/var/log/koha/${instance}/plack.log \
245 /var/log/koha/${instance}/plack-error.log"
249 if [ ! -e "${file}" ]; then
252 chown
"${instance}-koha":"${instance}-koha" ${file}
258 if [ "$op" = "" ]; then
261 die "Error
: only one action can be specified.
"
265 STARMAN=$(which starman)
270 debugger_location="localhost
:9000"
273 # Read command line parameters
274 while [ $# -gt 0 ]; do
304 debugger_location="$2"
310 die "Error
: invalid option switch
($1)" ;;
312 # We expect the remaining stuff are the instance names
318 [ "${quiet}" != "yes" ] && check_env_and_warn
320 if [ $# -gt 0 ]; then
321 # We have at least one instance name
324 if is_instance $name; then
326 adjust_paths_dev_install $name
329 PERL5LIB=$PERL5LIB:$KOHA_HOME/installer:$KOHA_HOME/lib/installer
330 # If debug mode is enabled, add the debugger lib path
331 # to PERL5LIB if appropriate
332 if [ "$debug_mode" = "yes" ]; then
333 if [ "$debugger_path" != "" ]; then
334 PERL5LIB="${debugger_path}":$PERL5LIB
336 export PERL5DB="BEGIN
{ require q
(${debugger_path}/perl5db.pl
) }"
337 export PERLDB_OPTS="RemotePort
=${debugger_location} async
=1 LogFile
=/var
/log
/koha
/${name}/plack-debug.log
"
338 export DBGP_IDEKEY=${debugger_key}
367 if [ "$quiet" = "no
" ]; then
368 log_daemon_msg "Error
: Invalid instance name
$name"
375 if [ "$quiet" = "no
" ]; then
376 warn "Error
: you must provide
at least one instance name
"