From 504df6097d8524c7488506c9a5767404bc0bb1a1 Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Fri, 14 Sep 2012 15:26:12 -0300 Subject: [PATCH] [PASSED QA] Bug 8773 - Start per-instance koha-index-daemon in .deb setup Short: Launch a koha-index-daemon (from Koha::Contrib::tamil) process for each enabled instance. Enabling/disabling the use of the indexer is handled using a new(ly introduced) /etc/default/koha-common config file that can be used for other stuff too, and is the Debian way of handling init scripts control variables[1]. Also provide command line tools to manage the running indexer daemons for your instances. Long: Using an indexing daemon avoids launching a new interpreter each time the cron triggers the indexing, and also allows sub-minute incremental reindexing, a requirement from our librarians.[2] Using the indexer daemon should remain "experimental" so is disabled by default. To enable the use of the indexer the user has to tweak the /etc/default/koha-common config file (introduced by this patch). Specifically the USE_INDEXER_DAEMON variable, which is clearly explained in the file. Update frecquency defaults to 30 sec, and can be changed by tweaking the /etc/default/koha-common config file too. This patch relies on Koha::Contrib::Tamil's koha-index-daemon script [3], but could be easily adjusted to use another if we got a new one (SolR?). As Robin proposed it checks for availability of the relevant files before trying to spawn the daemon. If there's something I could change to make this patches better just let me know. Note: there was a problem Robin found regarding the spawned processes forgetting the PERL5LIB and/or KOHA_CONF env variables, this is fixed in this version with the inclusion of the 'export' keyword for the relevant variables. Edit: fixed koha-create to call the koha-indexer script instead, and added -q to make koha-inxeder quiet (useful for the init script). Regards To+ [1] Section 9.3.2 of http://www.debian.org/doc/debian-policy/ch-opersys.html [2] This is the .deb version of http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=8519 [3] The default cronjob that is set using the debian/koha-common.cron.d file is being disbaled by this patch to avoid collision. Sponsored-by: Universidad Nacional de Cordoba Signed-off-by: Chris Cormack Signed-off-by: Martin Renvoize --- debian/docs/koha-common.xml | 7 ++ debian/docs/koha-indexer.xml | 86 +++++++++++++ debian/koha-common.cron.d | 1 + debian/koha-common.default | 20 ++- debian/koha-common.init | 12 ++ debian/koha-common.install | 1 + debian/scripts/koha-create | 7 ++ debian/scripts/koha-indexer | 277 ++++++++++++++++++++++++++++++++++++++++++ 8 files changed, 410 insertions(+), 1 deletion(-) create mode 100644 debian/docs/koha-indexer.xml create mode 100755 debian/scripts/koha-indexer diff --git a/debian/docs/koha-common.xml b/debian/docs/koha-common.xml index d602aa9..2790341 100644 --- a/debian/docs/koha-common.xml +++ b/debian/docs/koha-common.xml @@ -145,6 +145,13 @@ Stop Zebra for named Koha instances. + + + + + Manage the indexer daemon for named Koha instances. + + diff --git a/debian/docs/koha-indexer.xml b/debian/docs/koha-indexer.xml new file mode 100644 index 0000000..66e177c --- /dev/null +++ b/debian/docs/koha-indexer.xml @@ -0,0 +1,86 @@ +
+koha-indexer + +Koha is the first free software library automation package. + + The Koha Community + http://koha-community.org/ + + + + + + + koha-indexer + 8 + + + + koha-indexer + Manage the indexer daemon for Koha instances. + UNIX/Linux + + + + + koha-indexer + |||||| + instancename + + + + Options + + + + + + + Start the indexer daemon for the desired Koha instances. + + + + + + + Stop the indexer daemon for the desired Koha instances. + + + + + + + Restart the indexer daemon for the desired Koha instances. + + + + + + + Make the script quiet about non existent instance names. Useful when calling koha-indexer from another scripts. + + + + + + + Show usage information. + + + + + + + Description + The koha-indexer script lets you manage your Koha instances indexer daemon. + + + See also + + /etc/default/koha-common + + + + + +
diff --git a/debian/koha-common.cron.d b/debian/koha-common.cron.d index f763f30..96ff1b2 100644 --- a/debian/koha-common.cron.d +++ b/debian/koha-common.cron.d @@ -6,5 +6,6 @@ SHELL=/bin/sh PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin +# Comment the following line if you want to use the experimental koha-index-daemon integration */5 * * * * root test -x /usr/sbin/koha-rebuild-zebra && koha-rebuild-zebra -q $(koha-list --enabled) */15 * * * * root koha-foreach --enabled --email /usr/share/koha/bin/cronjobs/process_message_queue.pl diff --git a/debian/koha-common.default b/debian/koha-common.default index d572f17..73b27a6 100644 --- a/debian/koha-common.default +++ b/debian/koha-common.default @@ -1,3 +1,21 @@ -## General koha-common default options +## General koha-common default options file PERL5LIB="/usr/share/koha/lib" + +# If you want to use the koha-index-daemon script that is part of the +# Koha::Contrib::Tamil package instead of the cronjob, set USE_INDEXER_DAEMON +# to "yes". More information can be found here: +# http://wiki.koha-community.org/wiki/PackagesIndexDaemon +# Note: You should comment the relevant line in /etc/cron.d/koha-common +# +# The default value is "no" +USE_INDEXER_DAEMON="no" + +# Indexer daemon script. The default is to use Tamil's +INDEXER_DAEMON="koha-index-daemon" + +# If you are using the koha-index-daemon you can set the frecquency (in sec) +# of the indexes update. +# +# The default value is 30 +INDEXER_TIMEOUT=30 diff --git a/debian/koha-common.init b/debian/koha-common.init index 1ba591d..241aaa6 100755 --- a/debian/koha-common.init +++ b/debian/koha-common.init @@ -49,6 +49,10 @@ do_start() koha-create-dirs $(koha-list) koha-start-zebra $(koha-list --enabled) koha-start-sip $(koha-list --enabled) + + if [ "$USE_INDEXER_DAEMON" = "yes" ]; then + koha-indexer --start --quiet $(koha-list --enabled) + fi } # @@ -59,6 +63,10 @@ do_stop() # We stop everything, including disabled ones. koha-stop-zebra $(koha-list) || true koha-stop-sip $(koha-list) || true + + if [ "$USE_INDEXER_DAEMON" = "yes" ]; then + koha-indexer --stop --quiet $(koha-list --enabled) + fi } # @@ -68,6 +76,10 @@ do_reload() { koha-restart-zebra $(koha-list --enabled) koha-stop-sip $(koha-list) || true koha-start-sip $(koha-list --enabled) + + if [ "$USE_INDEXER_DAEMON" = "yes" ]; then + koha-indexer --restart --quiet $(koha-list --enabled) + fi } # diff --git a/debian/koha-common.install b/debian/koha-common.install index e215bde..e894f37 100644 --- a/debian/koha-common.install +++ b/debian/koha-common.install @@ -16,6 +16,7 @@ debian/scripts/koha-email-disable usr/sbin debian/scripts/koha-email-enable usr/sbin debian/scripts/koha-enable usr/sbin debian/scripts/koha-foreach usr/sbin +debian/scripts/koha-indexer usr/sbin debian/scripts/koha-list usr/sbin debian/scripts/koha-mysql usr/sbin debian/scripts/koha-rebuild-zebra usr/sbin diff --git a/debian/scripts/koha-create b/debian/scripts/koha-create index 7f05eb0..3f19791 100755 --- a/debian/scripts/koha-create +++ b/debian/scripts/koha-create @@ -16,6 +16,8 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +# Read configuration variable file if it is present +[ -r /etc/default/koha-common ] && . /etc/default/koha-common set -e @@ -532,6 +534,11 @@ then # Start Zebra. koha-start-zebra "$name" + + if [ "$USE_INDEXER_DAEMON" = "yes" ]; then + # Start Indexer daemon + koha-indexer --start "$name" + fi fi diff --git a/debian/scripts/koha-indexer b/debian/scripts/koha-indexer new file mode 100755 index 0000000..ec3a69e --- /dev/null +++ b/debian/scripts/koha-indexer @@ -0,0 +1,277 @@ +#!/bin/bash +# +# koha-indexer - Manage Indexer Daemons for Koha instances +# Copyright 2012 Tomás Cohen Arazi @ Universidad Nacional de Córdoba +# +# 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 . + +set -e + +. /lib/lsb/init-functions + +# Read configuration variable file if it is present +[ -r /etc/default/koha-common ] && . /etc/default/koha-common + +warn() +{ + echo "$@" 1>&2 +} + +die() +{ + echo "$@" 1>&2 + exit 1 +} + +usage() +{ + local scriptname=$(basename $0) + + cat <