3 # koha-sip - Manage SIP server for Koha instances
4 # Copyright 2019 Theke Solutions
5 # Copyright 2012 Catalyst IT, Ltd
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.
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.
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/>.
22 . /lib/lsb/init-functions
24 # Read configuration variable file if it is present
25 [ -r /etc/default/koha-common ] && . /etc/default/koha-common
27 # include helper functions
28 if [ -f "/usr/share/koha/bin/koha-functions.sh" ]; then
29 . "/usr/share/koha/bin/koha-functions.sh"
31 echo "Error: /usr/share/koha/bin/koha-functions.sh not present." 1>&2
37 local scriptname=$(basename $0)
42 This script lets you manage the SIP server for your Koha instances.
45 $scriptname [--start|--stop|--restart] instancename1 [instancename2...]
48 --enable Enable the Koha SIP server.
49 --disable Disable and stop the Koha SIP server.
50 --start Start the SIP server for the specified instance(s)
51 --stop Stop the SIP server for the specified instance(s)
52 --restart Restart the SIP server for the specified instance(s)
53 --status Show the status of the SIP server for the specified instance(s)
54 --verbose|-v Display progress and actions messages
55 --help|-h Display this help message
64 _check_and_fix_perms $name
66 if ! is_sip_running $name; then
67 if [ ! -f "/etc/koha/sites/${name}/SIPconfig.xml" ] || [ ! -f "/var/lib/koha/${name}/sip.enabled" ] ; then
68 echo "SIP is disabled, or you do not have a SIPconfig.xml file."
70 adjust_paths_dev_install $name
71 export KOHA_HOME PERL5LIB
73 if [ "$DEV_INSTALL" = "" ]; then
79 DAEMONOPTS="--name=${name}-koha-sip \
80 --errlog=/var/log/koha/${name}/sip-error.log \
81 --stdout=/var/log/koha/${name}/sip.log \
82 --output=/var/log/koha/${name}/sip-output.log \
86 --pidfiles=/var/run/koha/${name} \
87 --user=${name}-koha.${name}-koha"
89 SIP_PARAMS="$LIBDIR/C4/SIP/SIPServer.pm \
90 /etc/koha/sites/${name}/SIPconfig.xml"
92 [ "$verbose" != "no" ] && \
93 log_daemon_msg "Starting SIP server for ${name}"
95 if daemon $DAEMONOPTS -- perl $SIP_PARAMS; then
96 ([ "$verbose" != "no" ] && \
97 log_end_msg 0) || return 0
99 ([ "$verbose" != "no" ] && \
100 log_end_msg 1) || return 1
104 if [ "$verbose" != "no" ]; then
105 log_daemon_msg "Warning: SIP server already running for ${name}"
117 if is_sip_running $name; then
119 DAEMONOPTS="--name=${name}-koha-sip \
120 --errlog=/var/log/koha/${name}/sip-error.log \
121 --stdout=/var/log/koha/${name}/sip.log \
122 --output=/var/log/koha/${name}/sip-output.log \
126 --pidfiles=/var/run/koha/${name} \
127 --user=${name}-koha.${name}-koha"
129 [ "$verbose" != "no" ] && \
130 log_daemon_msg "Stopping SIP server for ${name}"
132 if daemon $DAEMONOPTS --stop; then
133 ([ "$verbose" != "no" ] && \
134 log_end_msg 0) || return 0
136 ([ "$verbose" != "no" ] && \
137 log_end_msg 1) || return 1
140 if [ "$verbose" != "no" ]; then
141 log_daemon_msg "Warning: SIP server not running for ${name}"
153 if is_sip_running ${name}; then
155 [ "$verbose" != "no" ] && noLF=""
156 echo $noLF `stop_sip ${name}`
159 while is_sip_running ${name}; do
161 if [ $MAX_ITERATION -lt $i ]; then
167 echo $noLF `start_sip ${name}`
169 if [ "$verbose" != "no" ]; then
170 log_warning_msg "Warning: SIP server not running for ${name}."
183 if is_sip_running ${name}; then
184 log_daemon_msg "SIP server running for ${name}"
187 log_daemon_msg "SIP server not running for ${name}"
195 local libdir=/var/lib/koha/${name}
197 sipfile=/etc/koha/sites/${name}/SIPconfig.xml
199 if is_sip_enabled ${name}; then
200 echo "Warning: SIP server already enabled for ${name}"
202 echo "Enabling SIP server for ${name} - edit ${sipfile} to configure"
203 touch $libdir/sip.enabled
204 if [[ ! -f "/etc/koha/sites/${name}/SIPconfig.xml" ]]; then
205 cp -v /etc/koha/SIPconfig.xml ${sipfile}
206 chown ${name}-koha:${name}-koha ${sipfile}
208 echo "This is the first time SIP has been enabled. Please check the configurations in /etc/koha/sites/${name}/SIPconfig.xml"
216 local libdir=/var/lib/koha/${name}
218 if is_sip_enabled ${name}; then
219 # SIP is enabled, we should disable it
220 echo "Stopping running SIP"
222 rm ${libdir}/sip.enabled
223 echo "Information: SIP server disabled for ${name}"
225 echo " SIP server for ${name} not enabled - use koha-sip --enable <instance> to enable."
230 _check_and_fix_perms()
234 local files="/var/log/koha/${name}/sip-error.log \
235 /var/log/koha/${name}/sip.log \
236 /var/log/koha/$name/sip-output.log"
240 if [ ! -e "${file}" ]; then
243 chown "${name}-koha":"${name}-koha" ${file}
249 if [ "$op" = "" ]; then
252 die "Error: only one action can be specified."
259 # Backwards compatible with old koha-*-sip scripts
260 # TODO: Remove once there's consensus to remove the legacy scripts
261 used_script_name=$(basename $0)
263 if [ "$used_script_name" != "koha-sip" ]; then
264 warn "Deprecated script used (${used_script_name})"
266 case "$used_script_name" in
268 set_action "start" ;;
272 set_action "enable" ;;
277 # / Backwards compatible handling code
279 # Read command line parameters
280 while [ $# -gt 0 ]; do
307 die "Error: invalid option switch ($1)" ;;
309 # We expect the remaining stuff are the instance names
315 if [ $# -gt 0 ]; then
316 # We have at least one instance name
319 if is_instance $name; then
321 export KOHA_CONF="/etc/koha/sites/$name/koha-conf.xml"
344 if [ "$verbose" != "no" ]; then
345 log_daemon_msg "Error: Invalid instance name $name"
352 if [ "$verbose" != "no" ]; then
353 warn "Error: you must provide at least one instance name"