Koha/debian/scripts/koha-dump
Marcel de Rooy fea1d135be
Bug 23345: Rename include-indexes to exclude-indexes in koha-dump
Trivial edit. The usage statement is wrong.

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
2019-07-26 16:23:03 +01:00

149 lines
4 KiB
Bash
Executable file

#!/bin/sh
#
# koha-dump: dump all contents and configs for a Koha site
# 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
# include helper functions
if [ -f "/usr/share/koha/bin/koha-functions.sh" ]; then
. "/usr/share/koha/bin/koha-functions.sh"
else
echo "Error: /usr/share/koha/bin/koha-functions.sh not present." 1>&2
exit 1
fi
# Make sure the files we create are not accessible by anyone else.
umask 0077
usage()
{
local scriptname=$(basename $0)
cat <<EOF
$scriptname
This script dumps your Koha instance data for backup or migration.
Usage:
$scriptname [--quiet|-q] [--exclude-indexes] instancename1 [instancename2...]
$scriptname -h|--help
--exclude-indexes Include Zebra indexes on the backup.
--quiet|-q Make the script avoid printing to STDOUT
(useful for calling from another scripts).
--help|-h Display this help message
EOF
}
dump_instance()
{
local name=$1
kohaconfig="/etc/koha/sites/$name/koha-conf.xml"
date="$(date +%Y-%m-%d)"
[ "$quiet" = "no" ] && echo "Dumping Koha site $name:"
# Dump database.
mysqlhost="$( xmlstarlet sel -t -v 'yazgfs/config/hostname' $kohaconfig )"
mysqldb="$( xmlstarlet sel -t -v 'yazgfs/config/database' $kohaconfig )"
mysqluser="$( xmlstarlet sel -t -v 'yazgfs/config/user' $kohaconfig )"
mysqlpass="$( xmlstarlet sel -t -v 'yazgfs/config/pass' $kohaconfig )"
backupdir="$( xmlstarlet sel -t -v 'yazgfs/config/backupdir' $kohaconfig || true )"
[ -z "$backupdir" ] && backupdir="/var/spool/koha/$name"
dbdump="$backupdir/$name-$date.sql.gz"
[ "$quiet" = "no" ] && echo "* DB to $dbdump"
mysqldump --databases --host="$mysqlhost" \
--user="$mysqluser" --password="$mysqlpass" "$mysqldb" |
gzip > "$dbdump"
chown "root:$name-koha" "$dbdump"
chmod g+r "$dbdump"
instancefile="$name.conf"
# Dump configs, logs, etc.
metadump="$backupdir/$name-$date.tar.gz"
[ "$quiet" = "no" ] && echo "* configs, logs to $metadump"
if [ "$exclude_indexes" = "yes" ]; then
excludes="--exclude=var/lib/koha/$name/biblios \
--exclude=var/lib/koha/$name/authorities"
fi
tar -czf "$metadump" -C / $excludes \
"etc/koha/sites/$name" \
"etc/apache2/sites-available/$instancefile" \
"etc/apache2/sites-enabled/$instancefile" \
"var/lib/koha/$name" \
"var/log/koha/$name"
[ "$quiet" = "no" ] && echo "Done."
}
# Default values
quiet="no"
exclude_indexes="no"
while [ $# -gt 0 ]; do
case "$1" in
--exclude-indexes)
exclude_indexes="yes"
shift ;;
-h|--help)
usage ; exit 0 ;;
-q|--quiet)
quiet="yes"
shift ;;
-*)
die "Error: invalid option switch ($1)" ;;
*)
# We expect the remaining stuff are the instance names
break ;;
esac
done
# Read instance names
if [ $# -gt 0 ]; then
# We have at least one instance name
for name in "$@"; do
if is_instance $name; then
dump_instance $name
else
if [ "$quiet" = "no" ]; then
die "Error: Invalid instance name $name"
else
exit 1
fi
fi
done
else
if [ "$quiet" = "no" ]; then
die "Error: you must provide at least one instance name"
else
exit 1
fi
fi
exit 0