debian/scripts/koha-functions.sh

   1 #!/bin/sh
   2 #
   3 # koha-functions.sh -- shared library of helper functions for koha-* scripts
   4 # Copyright 2014 - Tomas Cohen Arazi
   5 #                  Universidad Nacional de Cordoba
   6 #
   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.
  11 #
  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.
  16 #
  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/>.
  19
  20
  21 die()
  22 {
  23     echo "$@" 1>&2
  24     exit 1
  25 }
  26
  27 warn()
  28 {
  29     echo "$@" 1>&2
  30 }
  31
  32 get_apache_config_for()
  33 {
  34     local site=$1
  35     local sitefile="/etc/apache2/sites-available/$site"
  36
  37     if is_instance $site; then
  38         if [ -f "$sitefile.conf" ]; then
  39             echo "$sitefile.conf"
  40         elif [ -f "$sitefile" ]; then
  41             echo "$sitefile"
  42         fi
  43     fi
  44 }
  45
  46 get_opacdomain_for()
  47 {
  48     local site=$1
  49
  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
  55     fi
  56     local opacdomain="$OPACPREFIX$site$OPACSUFFIX$DOMAIN"
  57     echo "$opacdomain"
  58 }
  59
  60 get_intradomain_for()
  61 {
  62     local site=$1
  63
  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
  69     fi
  70     local intradomain="$INTRAPREFIX$site$INTRASUFFIX$DOMAIN"
  71     echo "$intradomain"
  72 }
  73
  74 letsencrypt_get_opacdomain_for()
  75 {
  76     local site=$1
  77
  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)
  82     fi
  83     echo "$opacdomain"
  84 }
  85
  86 is_enabled()
  87 {
  88     local site=$1
  89     local instancefile=$(get_apache_config_for $site)
  90
  91     if [ "$instancefile" = "" ]; then
  92         return 1
  93     fi
  94
  95     if grep -q '^[[:space:]]*Include /etc/koha/apache-shared-disable.conf' \
  96             "$instancefile" ; then
  97         return 1
  98     else
  99         return 0
 100     fi
 101 }
 102
 103 is_instance()
 104 {
 105     local instancename=$1
 106
 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
 113     fi
 114 }
 115
 116 is_email_enabled()
 117 {
 118     local instancename=$1
 119
 120     if [ -e /var/lib/koha/$instancename/email.enabled ]; then
 121         return 0
 122     else
 123         return 1
 124     fi
 125 }
 126
 127 is_letsencrypt_enabled()
 128 {
 129     local instancename=$1
 130
 131     if [ -e /var/lib/koha/$instancename/letsencrypt.enabled ]; then
 132         return 0
 133     else
 134         return 1
 135     fi
 136 }
 137
 138 is_sip_enabled()
 139 {
 140     local instancename=$1
 141
 142     if [ -e /var/lib/koha/$instancename/sip.enabled ]; then
 143         return 0
 144     else
 145         return 1
 146     fi
 147 }
 148
 149 is_sitemap_enabled()
 150 {
 151     local instancename=$1
 152
 153     if [ -e /var/lib/koha/$instancename/sitemap.enabled ]; then
 154         return 0
 155     else
 156         return 1
 157     fi
 158 }
 159
 160 is_sip_running()
 161 {
 162     local instancename=$1
 163
 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
 171     fi
 172 }
 173
 174 is_zebra_running()
 175 {
 176     local instancename=$1
 177
 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
 185     fi
 186 }
 187
 188 is_indexer_running()
 189 {
 190     local instancename=$1
 191
 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
 199     fi
 200 }
 201
 202 is_worker_running()
 203 {
 204     local instancename=$1
 205
 206     if daemon --name="$instancename-koha-worker" \
 207             --pidfiles="/var/run/koha/$instancename/" \
 208             --user="$instancename-koha.$instancename-koha" \
 209             --running ; then
 210         return 0
 211     else
 212         return 1
 213     fi
 214 }
 215
 216 is_plack_enabled_opac()
 217 {
 218     local instancefile=$1
 219
 220     if [ "$instancefile" = "" ]; then
 221         return 1
 222     fi
 223
 224     # remember 0 means success/true in bash.
 225     if grep -q '^[[:space:]]*Include /etc/koha/apache-shared-opac-plack.conf' \
 226             "$instancefile" ; then
 227         return 0
 228     else
 229         return 1
 230     fi
 231 }
 232
 233 is_plack_enabled_intranet()
 234 {
 235     local instancefile=$1
 236
 237     if [ "$instancefile" = "" ]; then
 238         return 1
 239     fi
 240
 241     # remember 0 means success/true in bash.
 242     if grep -q '^[[:space:]]*Include /etc/koha/apache-shared-intranet-plack.conf' \
 243             "$instancefile" ; then
 244         return 0
 245     else
 246         return 1
 247     fi
 248 }
 249
 250 is_plack_enabled()
 251 {
 252     local site=$1
 253     local instancefile=$(get_apache_config_for $site)
 254
 255     if [ "$instancefile" = "" ]; then
 256         return 1
 257     fi
 258
 259     if is_plack_enabled_opac $instancefile ; then
 260         enabledopac=1
 261     else
 262         enabledopac=0
 263     fi
 264     if is_plack_enabled_intranet $instancefile ; then
 265         enabledintra=1
 266     else
 267         enabledintra=0
 268     fi
 269
 270     # remember 0 means success/true in bash.
 271     if [ "$enabledopac" != "$enabledintra" ] ; then
 272         echo "$site has a plack configuration error. Enable or disable plack to correct this."
 273         return 0
 274     elif [ "$enabledopac" = "1" ] ; then
 275         return 0
 276     else
 277         return 1
 278     fi
 279 }
 280
 281 is_plack_running()
 282 {
 283     local instancename=$1
 284
 285     if start-stop-daemon --pidfile "/var/run/koha/${instancename}/plack.pid" \
 286             --user="$instancename-koha" \
 287             --status ; then
 288         return 0
 289     else
 290         return 1
 291     fi
 292 }
 293
 294 is_z3950_enabled()
 295 {
 296     local instancename=$1
 297
 298     if [ -e /etc/koha/sites/$instancename/z3950/config.xml ]; then
 299         return 0
 300     else
 301         return 1
 302     fi
 303 }
 304
 305 is_z3950_running()
 306 {
 307     local instancename=$1
 308
 309     if start-stop-daemon --pidfile "/var/run/koha/${instancename}/z3950-responder.pid" \
 310             --user="$instancename-koha" \
 311             --status ; then
 312         return 0
 313     else
 314         return 1
 315     fi
 316 }
 317
 318 adjust_paths_dev_install()
 319 {
 320 # Adjust KOHA_HOME, PERL5LIB for dev installs, as indicated by
 321 # corresponding tag in koha-conf.xml
 322
 323     local instancename=$1
 324     local dev_install=""
 325
 326     if [ "$instancename" != "" ] && is_instance $instancename; then
 327         dev_install=$(run_safe_xmlstarlet $instancename dev_install)
 328     fi
 329
 330     if [ "$dev_install" != "" ] && [ "$dev_install" != "0" ]; then
 331         DEV_INSTALL=1
 332         KOHA_HOME=$(run_safe_xmlstarlet $instancename intranetdir)
 333         PERL5LIB=$KOHA_HOME
 334     else
 335         DEV_INSTALL=""
 336     fi
 337 }
 338
 339 get_instances()
 340 {
 341     find -L /etc/koha/sites -mindepth 1 -maxdepth 1\
 342                          -type d -printf '%f\n' | sort
 343 }
 344
 345 get_loglevels()
 346 {
 347     local instancename=$1
 348     local retval=$(run_safe_xmlstarlet $instancename zebra_loglevels)
 349     if [ "$retval" != "" ]; then
 350         echo "$retval"
 351     else
 352         echo "none,fatal,warn"
 353     fi
 354 }
 355
 356 get_max_record_size()
 357 {
 358     local instancename=$1
 359     local retval=$(xmlstarlet sel -t -v 'yazgfs/config/zebra_max_record_size' /etc/koha/sites/$instancename/koha-conf.xml)
 360     if [ "$retval" != "" ]; then
 361         echo "$retval"
 362     else
 363         echo "1024"
 364     fi
 365 }
 366
 367 get_tmpdir()
 368 {
 369     if [ "$TMPDIR" != "" ]; then
 370         if [ -d "$TMPDIR" ]; then
 371             echo $TMPDIR
 372             return 0
 373         fi
 374         # We will not unset TMPDIR but just default to /tmp here
 375         # Note that mktemp (used later) would look at TMPDIR
 376         echo "/tmp"
 377         return 0
 378     fi
 379     local retval=$(mktemp -u)
 380     if [ "$retval" = "" ]; then
 381         echo "/tmp"
 382         return 0
 383     fi
 384     echo $(dirname $retval)
 385 }
 386
 387 run_safe_xmlstarlet()
 388 {
 389     # When a bash script sets -e (errexit), calling xmlstarlet on an
 390     # unexisting key would halt the script. This is resolved by calling
 391     # this function in a subshell. It will always returns true, while not
 392     # affecting the exec env of the caller. (Otherwise, errexit is cleared.)
 393     local instancename=$1
 394     local myexpr=$2
 395     set +e; # stay on the safe side
 396     echo $(xmlstarlet sel -t -v "yazgfs/config/$myexpr" /etc/koha/sites/$instancename/koha-conf.xml)
 397     return 0
 398 }