Koha-clms/tools
Jared Camins-Esakov bbcb1d784b Bug 8268: Add database dump to export tool
This patch builds on work by Lars Wirzenius for the Koha packages.

To date, the only way for a Koha librarian to obtain a complete backup
of their system has been to log into the system via SSH (or FTP) to
download the mysqldump file. This patch makes it possible for
superlibrarians in properly configured systems to download night backups
via the staff client's Export tool.

Recognizing that this is functionality with potentially very grave
security implications, system administrators must manually enable these
features in the koha-conf.xml configuration file.

The following configuration settings have been added to the koha-conf.xml
file:
* backupdir => directory where backups should be stored.
* backup_db_via_tools => whether to allow superlibrarians to download
  database backups via the Export tool. The default is disabled, and
  there is no way -- by design -- to enable this option without manually
  editing koha-conf.xml.
* backup_conf_via_tools => whether to allow superlibrarians to download
  configuration backups via the Export tool (this may be applicable to
  packages only). The default is disabled, and there is no way -- by
  design -- to enable this option without manually editing koha-conf.xml.

This commit modifies the following scripts to make use of the new
backupdir configuration option:
* koha-dump and koha-run-backups in the Debian packages
* The sample backup script misc/cronjobs/backup.sh

Note that for security reasons, superlibrarians will not be allowed
to download files that are not owned by the web server's effective user.
This imposes a de facto dependency on ITK (for Apache) or running the
web server as the Koha user (as is done with Plack).

To test:
1. Apply patch.
2. Go to export page as a superlibrarian. Notice that no additional
   export options appear because they have not been enabled.
3. Add <backupdir>$KOHADEV/var/spool</backup> to the <config> section
   of your koha-conf.xml (note that you will need to adjust that so that
   it is pointing at a logical directory).
4. Create the aforementioned directory.
5. Go to export page as a superlibrarian. Notice that no additional
   export options appear because they have not been enabled.
6. Add <backup_db_via_tools>1</backup_db_via_tools> to the <config>
   section of your koha-conf.xml
7. Go to the export page as a superlibrarian. Notice the new tab.
8. Go to the export page as a non-superlibrarian. Notice there is no
   new tab.
9. Run: mysqldump -u koha -p koha | gzip > $BACKUPDIR/backup.sql.gz
   (substituting appropriate user, password, and database name)
10. Go to the export page as a superlibrarian, and look at the "Export
    database" tab. If you are running the web server as your Koha user,
    and ran the above command as your Koha user, you should now see the
    file listed as an option for download.
11. If you *did* see the file listed, change the ownership to something
    else: sudo chown root:root $BACKUPDIR/backup.sql.gz
11a. Confirm that you no longer see the file listed when you look at the
     "Export database" tab.
12. Change the ownership on the file to your web server (or Koha) user:
    sudo chown www-data:www-data backup.sql.gz
13. Go to the export page as a superlibrarian, and look at the "Export
    database" tab. You should now see backup.sql.gz listed.
14. Choose to download backup.sql.gz
15. Confirm that the downloaded file is what you were expecting.

If you are interested, you can repeat the above steps but replace
<backup_db_via_tools> with <backup_conf_via_tools>, and instead of
creating an sql file, create a tar file.

To test packaging: run koha-dump, confirm that it still creates a
usable backup.

------

This signoff contains two changes:

10-1. If no backup/conf files were present, then the message telling you
so doesn't appear and the download button does. Made them behave
correctly.
10-2. The test for a file existing required it to be owned by the
webserver UID. This change makes it so it only has to be readable.

Signed-off-by: Robin Sheat <robin@catalyst.net.nz>
2012-07-12 17:40:21 +02:00
..
csv-profiles MT2116: Addons to the CSV export 2010-02-17 07:51:33 -05:00
quotes Bug 7977: Fixing a bug which results in quote fields being incorrectly offset when saving uploaded quotes 2012-05-24 14:15:05 +02:00
background-job-progress.pl Bug 5449: JSON malformed in Koha - Blocker with jQuery 1.4.x 2011-03-12 08:53:41 +13:00
batchMod.pl Bug 7739 - Batch edit items of a title 2012-05-11 12:16:22 +02:00
cleanborrowers.pl Bug 7310: Improving list permissions: Deleting patron 2012-03-21 16:47:03 +01:00
copy-holidays.pl Bug 7477: Copy holidays from one branch to another 2012-03-19 18:10:44 +01:00
csv-profiles.pl Bug 5385: POD Cleanups (part 2) 2010-11-12 10:06:56 +13:00
exceptionHolidays.pl Bug 2505: Enabled warnings in tools-home.pl, holidays.pl, exceptionHolidays.pl, and newHolidays.pl 2009-09-12 08:38:35 -04:00
export.pl Bug 8268: Add database dump to export tool 2012-07-12 17:40:21 +02:00
holidays.pl Bug 7833 - unique holiday link broken 2012-04-19 10:54:00 +02:00
import_borrowers.pl Bug 5373 - allow 'cardnumber' to appear on the patron import field list 2012-02-21 17:04:18 +01:00
inventory.pl Bug 6453 Corrects the barcode comparisons in inventory.pl 2011-06-20 11:59:50 +12:00
koha-news.pl Fix for Bug 6306 - It is not possible edit news 2011-05-29 16:05:34 +12:00
letter.pl Bug 7848 - Issues data missing from circulation notices 2012-07-10 13:50:10 +02:00
manage-marc-import.pl bug_7613: OCLC Connexion gateway 2012-04-06 17:26:20 +02:00
modborrowers.pl Bug 5742: Followup: sort* fields can to be filled with an input text 2012-05-15 17:45:12 +02:00
newHolidays.pl Bug 6663: Features for holidays.pl with datepicker 2011-12-13 15:07:05 +01:00
overduerules.pl Bug #6064 Improvement of default value usage in overdue 2011-04-07 21:33:40 +12:00
pdfViewer.pl Convert to UTF-8. 2010-05-06 17:58:54 -04:00
picture-upload.pl Bug 5453 Move declarations out of conditionals 2011-07-15 15:50:23 +12:00
quotes-upload.pl Bug 7977: QOTD uploader to enable uploading csv files containing quotes 2012-05-24 14:14:09 +02:00
quotes.pl Bug 7977: Quote-of-the-day (QOTD) Feature for OPAC 2012-05-24 14:14:05 +02:00
scheduler.pl Bug 2505 - Add commented use warnings where missing in the tools/ directory 2010-04-21 20:26:38 +12:00
stage-marc-import.pl Merge remote-tracking branch 'kc/new/bug_5449' into kcmaster 2011-05-09 08:25:36 +12:00
tools-home.pl Bug 7259 - Show a count of items pending approval on staff client home and tools pages 2011-12-08 12:04:28 +01:00
upload-cover-image.pl Bug 7961 - Local cover images should support CSV link files 2012-06-20 09:42:25 +02:00
upload-file-progress.pl Bug 5449: JSON malformed in Koha - Blocker with jQuery 1.4.x 2011-03-12 08:53:41 +13:00
upload-file.pl Bug 7775 - tools/upload-file.pl: scoping for plack 2012-03-26 18:17:45 +02:00
viewlog.pl Replace itemnumber by barcode in links of patron modification log 2012-05-11 11:24:57 +02:00