Bug 25950: Remove <client> in X-Forwarded-For from proxy tests
[koha.git] / debian / scripts / koha-functions.sh
blob082d3628faccd5b6e8509208cef82f0768f7cb9c
1 #!/bin/sh
3 # koha-functions.sh -- shared library of helper functions for koha-* scripts
4 # Copyright 2014 - Tomas Cohen Arazi
5 # Universidad Nacional de Cordoba
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/>.
21 die()
23 echo "$@" 1>&2
24 exit 1
27 warn()
29 echo "$@" 1>&2
32 get_apache_config_for()
34 local site=$1
35 local sitefile="/etc/apache2/sites-available/$site"
37 if is_instance $site; then
38 if [ -f "$sitefile.conf" ]; then
39 echo "$sitefile.conf"
40 elif [ -f "$sitefile" ]; then
41 echo "$sitefile"
46 get_opacdomain_for()
48 local site=$1
50 if [ -e /etc/koha/koha-sites.conf ]; then
51 . /etc/koha/koha-sites.conf
52 else
53 echo "Error: /etc/koha/koha-sites.conf not present." 1>&2
54 exit 1
56 local opacdomain="$OPACPREFIX$site$OPACSUFFIX$DOMAIN"
57 echo "$opacdomain"
60 get_intradomain_for()
62 local site=$1
64 if [ -e /etc/koha/koha-sites.conf ]; then
65 . /etc/koha/koha-sites.conf
66 else
67 echo "Error: /etc/koha/koha-sites.conf not present." 1>&2
68 exit 1
70 local intradomain="$INTRAPREFIX$site$INTRASUFFIX$DOMAIN"
71 echo "$intradomain"
74 letsencrypt_get_opacdomain_for()
76 local site=$1
78 if [ -e /var/lib/koha/$site/letsencrypt.enabled ]; then
79 . /var/lib/koha/$site/letsencrypt.enabled
80 else
81 local opacdomain=$(get_opacdomain_for $site)
83 echo "$opacdomain"
86 is_enabled()
88 local site=$1
89 local instancefile=$(get_apache_config_for $site)
91 if [ "$instancefile" = "" ]; then
92 return 1
95 if grep -q '^[[:space:]]*Include /etc/koha/apache-shared-disable.conf' \
96 "$instancefile" ; then
97 return 1
98 else
99 return 0
103 is_instance()
105 local instancename=$1
107 if find -L /etc/koha/sites -mindepth 1 -maxdepth 1 \
108 -type d -printf '%f\n'\
109 | grep -q -x "$instancename" ; then
110 return 0
111 else
112 return 1
116 is_email_enabled()
118 local instancename=$1
120 if [ -e /var/lib/koha/$instancename/email.enabled ]; then
121 return 0
122 else
123 return 1
127 is_letsencrypt_enabled()
129 local instancename=$1
131 if [ -e /var/lib/koha/$instancename/letsencrypt.enabled ]; then
132 return 0
133 else
134 return 1
138 is_sip_enabled()
140 local instancename=$1
142 if [ -e /var/lib/koha/$instancename/sip.enabled ]; then
143 return 0
144 else
145 return 1
149 is_sitemap_enabled()
151 local instancename=$1
153 if [ -e /var/lib/koha/$instancename/sitemap.enabled ]; then
154 return 0
155 else
156 return 1
160 is_sip_running()
162 local instancename=$1
164 if daemon --name="$instancename-koha-sip" \
165 --pidfiles="/var/run/koha/$instancename/" \
166 --user="$instancename-koha.$instancename-koha" \
167 --running ; then
168 return 0
169 else
170 return 1
174 is_zebra_running()
176 local instancename=$1
178 if daemon --name="$instancename-koha-zebra" \
179 --pidfiles="/var/run/koha/$instancename/" \
180 --user="$instancename-koha.$instancename-koha" \
181 --running ; then
182 return 0
183 else
184 return 1
188 is_indexer_running()
190 local instancename=$1
192 if daemon --name="$instancename-koha-indexer" \
193 --pidfiles="/var/run/koha/$instancename/" \
194 --user="$instancename-koha.$instancename-koha" \
195 --running ; then
196 return 0
197 else
198 return 1
202 is_plack_enabled_opac()
204 local instancefile=$1
206 if [ "$instancefile" = "" ]; then
207 return 1
210 # remember 0 means success/true in bash.
211 if grep -q '^[[:space:]]*Include /etc/koha/apache-shared-opac-plack.conf' \
212 "$instancefile" ; then
213 return 0
214 else
215 return 1
219 is_plack_enabled_intranet()
221 local instancefile=$1
223 if [ "$instancefile" = "" ]; then
224 return 1
227 # remember 0 means success/true in bash.
228 if grep -q '^[[:space:]]*Include /etc/koha/apache-shared-intranet-plack.conf' \
229 "$instancefile" ; then
230 return 0
231 else
232 return 1
236 is_plack_enabled()
238 local site=$1
239 local instancefile=$(get_apache_config_for $site)
241 if [ "$instancefile" = "" ]; then
242 return 1
245 if is_plack_enabled_opac $instancefile ; then
246 enabledopac=1
247 else
248 enabledopac=0
250 if is_plack_enabled_intranet $instancefile ; then
251 enabledintra=1
252 else
253 enabledintra=0
256 # remember 0 means success/true in bash.
257 if [ "$enabledopac" != "$enabledintra" ] ; then
258 echo "$site has a plack configuration error. Enable or disable plack to correct this."
259 return 0
260 elif [ "$enabledopac" = "1" ] ; then
261 return 0
262 else
263 return 1
267 is_plack_running()
269 local instancename=$1
271 if start-stop-daemon --pidfile "/var/run/koha/${instancename}/plack.pid" \
272 --user="$instancename-koha" \
273 --status ; then
274 return 0
275 else
276 return 1
280 is_z3950_enabled()
282 local instancename=$1
284 if [ -e /etc/koha/sites/$instancename/z3950/config.xml ]; then
285 return 0
286 else
287 return 1
291 is_z3950_running()
293 local instancename=$1
295 if start-stop-daemon --pidfile "/var/run/koha/${instancename}/z3950-responder.pid" \
296 --user="$instancename-koha" \
297 --status ; then
298 return 0
299 else
300 return 1
304 adjust_paths_dev_install()
306 # Adjust KOHA_HOME, PERL5LIB for dev installs, as indicated by
307 # corresponding tag in koha-conf.xml
309 local instancename=$1
310 local dev_install=""
312 if [ "$instancename" != "" ] && is_instance $instancename; then
313 dev_install=$(run_safe_xmlstarlet $instancename dev_install)
316 if [ "$dev_install" != "" ] && [ "$dev_install" != "0" ]; then
317 DEV_INSTALL=1
318 KOHA_HOME=$(run_safe_xmlstarlet $instancename intranetdir)
319 PERL5LIB=$KOHA_HOME
320 else
321 DEV_INSTALL=""
325 get_instances()
327 find -L /etc/koha/sites -mindepth 1 -maxdepth 1\
328 -type d -printf '%f\n' | sort
331 get_loglevels()
333 local instancename=$1
334 local retval=$(run_safe_xmlstarlet $instancename zebra_loglevels)
335 if [ "$retval" != "" ]; then
336 echo "$retval"
337 else
338 echo "none,fatal,warn"
342 get_max_record_size()
344 local instancename=$1
345 local retval=$(xmlstarlet sel -t -v 'yazgfs/config/zebra_max_record_size' /etc/koha/sites/$instancename/koha-conf.xml)
346 if [ "$retval" != "" ]; then
347 echo "$retval"
348 else
349 echo "1024"
353 get_tmpdir()
355 if [ "$TMPDIR" != "" ]; then
356 if [ -d "$TMPDIR" ]; then
357 echo $TMPDIR
358 return 0
360 # We will not unset TMPDIR but just default to /tmp here
361 # Note that mktemp (used later) would look at TMPDIR
362 echo "/tmp"
363 return 0
365 local retval=$(mktemp -u)
366 if [ "$retval" = "" ]; then
367 echo "/tmp"
368 return 0
370 echo $(dirname $retval)
373 run_safe_xmlstarlet()
375 # When a bash script sets -e (errexit), calling xmlstarlet on an
376 # unexisting key would halt the script. This is resolved by calling
377 # this function in a subshell. It will always returns true, while not
378 # affecting the exec env of the caller. (Otherwise, errexit is cleared.)
379 local instancename=$1
380 local myexpr=$2
381 set +e; # stay on the safe side
382 echo $(xmlstarlet sel -t -v "yazgfs/config/$myexpr" /etc/koha/sites/$instancename/koha-conf.xml)
383 return 0