Koha/debian/scripts/koha-rebuild-zebra
Robin Sheat c31e553a72 Bug 10379: silence zebra rebuild cron when no instances are enabled
This adds a -q option to koha-rebuild-zebra that prevents it outputting
help if no instances are provided on the command line. This means that
if you've just installed the package, you won't get messages from cron
telling you how to use the script.

Test plan:
* install koha-common 3.12 or master onto a system with no enabled
  instances.
* note that you or the sysadmin will start getting emails every 5
  minutes.
* replace /etc/cron.d/koha-common and /usr/sbin/koha-rebuild-zebra with
  the versions from this patch.
* note that the emails stop flowing.

Signed-off-by: Magnus Enger <magnus@enger.priv.no>
"sudo koha-rebuild-zebra -q" gives no output, as expected.
Followed the test plan, all looks good.
Signed-off-by: Galen Charlton <gmc@esilibrary.com>
2013-06-26 08:55:23 -07:00

182 lines
4.2 KiB
Bash
Executable file

#!/bin/sh
#
# koha-rebuild-zebra - Rebuild the Zebra database for Koha instances.
# Copyright 2010 Catalyst IT, Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
set -e
die()
{
echo "$@" 1>&2
exit 1
}
warn()
{
echo "$@" 1>&2
}
is_instance()
{
local instancename=$1
if find /etc/koha/sites -mindepth 1 -maxdepth 1 \
-type d -printf '%f\n'\
| grep -q -x $instancename ; then
return 0
else
return 1
fi
}
toggle_biblios_only()
{
biblios_only="yes"
biblios="yes"
if [ "$authorities_only" != "yes" ]; then
authorities="no"
fi
}
toggle_authorities_only()
{
authorities_only="yes"
authorities="yes"
if [ "$biblios_only" != "yes" ]; then
biblios="no"
fi
}
run_rebuild_zebra()
{
local instancename=$1; shift
# TODO: This comment is here to remind us that we should make
# rebuild_zebra.pl return error codes on failure
if sudo -u "$instancename-koha" -H \
env PERL5LIB=/usr/share/koha/lib \
KOHA_CONF="/etc/koha/sites/$instancename/koha-conf.xml" \
/usr/share/koha/bin/migration_tools/rebuild_zebra.pl $@ ; then
return 0
else
return 1
fi
}
usage()
{
local scriptname=$0
cat <<EOF
Rebuild the Zebra indexes for Koha instances. The default behaviour
is to do an incremental rebuild.
Usage: $scriptname [options] instancename1 instancename2...
Options:
--usmarc|-u Runs the process as USMARC rather than
the default of MARCXML.
--authorities|-a Only run process for authorities.
--biblios|-b Only run process for biblios.
--full|-f Does a reindex of the whole collection.
--quiet|-q Sometimes be a bit quieter for scripts/cronjobs.
--verbose|-v Be verbose.
--help|-h Print this help.
Note: Any other options are passed directly to rebuild_zebra.pl.
EOF
}
# Default parameters
opt_idx="-z"
opt_xml="-x"
opt_verbose=""
opts_other=""
biblios_only="no"
authorities_only="no"
biblios="yes"
authorities="yes"
# The '-q' option is intended to prevent the cronjob causing this to output
# help information if there are no instances defined.
quiet="no"
# Read parameters
while [ -n "$*" ]; do
case "$1" in
-h|--help)
usage ; exit 0
;;
-b|--biblios)
toggle_biblios_only
;;
-a|--authorities)
toggle_authorities_only
;;
-u|--usmarc)
opt_xml=""
;;
-f|--full)
opt_idx="-r"
;;
-v|--verbose)
opt_verbose="-v"
;;
-q|--quiet)
quiet="yes"
;;
-*)
opts_other="$opts_other $1";
;;
*)
break
;;
esac
shift
done
# Parse command line.
if [ $# -lt 1 ]; then
if [ "$quiet" = "no" ]; then
usage
die "Missing instance name."
else
exit
fi
fi
# Loop over instance names
for name in "$@"
do
if is_instance $name; then
if [ "$biblios" = "yes" ]; then
if ! run_rebuild_zebra $name \
-b $opt_verbose $opt_idx $opt_xml $opts_other; then
warn "Something went wrong rebuilding biblio indexes for $name"
fi
fi
if [ "$authorities" = "yes" ]; then
if ! run_rebuild_zebra $name \
-a $opt_verbose $opt_idx $opts_other ; then
warn "Something went wrong rebuilding authority indexes for $name"
fi
fi
else
warn "Unknown instance $name."
fi
done
exit 0