bbcb1d784b
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>
254 lines
8.7 KiB
Text
254 lines
8.7 KiB
Text
[% INCLUDE 'doc-head-open.inc' %]
|
|
<title>Koha › Tools › MARC export</title>
|
|
[% INCLUDE 'doc-head-close.inc' %]
|
|
[% INCLUDE 'calendar.inc' %]
|
|
<script type="text/javascript">
|
|
//<![CDATA[
|
|
$(document).ready(function() {
|
|
$('#exporttype').tabs();
|
|
});
|
|
//]]>
|
|
</script>
|
|
</head>
|
|
<body id="tools_export" class="tools">
|
|
[% INCLUDE 'header.inc' %]
|
|
[% INCLUDE 'cat-search.inc' %]
|
|
|
|
<div id="breadcrumbs"><a href="/cgi-bin/koha/mainpage.pl">Home</a> › <a href="/cgi-bin/koha/tools/tools-home.pl">Tools</a> › MARC export</div>
|
|
|
|
<div id="doc3" class="yui-t2">
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
|
|
<div id="exporttype" class="toptabs">
|
|
<ul>
|
|
<li><a href="#bibs">Export bibliographic records</a></li>
|
|
<li><a href="#auths">Export authority records</a></li>
|
|
[% IF ( allow_db_export ) %]
|
|
<li><a href="#db">Export database</a></li>
|
|
[% END %]
|
|
[% IF ( allow_conf_export ) %]
|
|
<li><a href="#conf">Export configuration</a></li>
|
|
[% END %]
|
|
</ul>
|
|
<div id="bibs">
|
|
<p>
|
|
<b>Note : The items are exported by this tool unless specified.</b>
|
|
</p>
|
|
|
|
<form method="post" action="/cgi-bin/koha/tools/export.pl">
|
|
<fieldset class="rows">
|
|
<legend> Select records to export </legend>
|
|
<ol><li>
|
|
<label for="start">From biblio number: </label>
|
|
<input id="start" type="text" name="StartingBiblionumber" size="5" />
|
|
</li>
|
|
<li>
|
|
<label for="end">To biblio number: </label>
|
|
<input id="end" type="text" name="EndingBiblionumber" size="5" />
|
|
</li>
|
|
|
|
<li>
|
|
<label for="itemtype">Item type: </label>
|
|
<select name="itemtype" id="itemtype">
|
|
<option value="">-- All --</option>
|
|
[% FOREACH itemtypeloo IN itemtypeloop %]
|
|
[% IF ( itemtypeloo.selected ) %]
|
|
<option value="[% itemtypeloo.value %]" selected="selected">[% itemtypeloo.description %]</option>
|
|
[% ELSE %]
|
|
<option value="[% itemtypeloo.value %]">[% itemtypeloo.description %]</option>
|
|
[% END %]
|
|
[% END %]
|
|
</select>
|
|
</li>
|
|
|
|
<li>
|
|
<label for="branch">Library: </label>
|
|
<select id="branch" name="branch">
|
|
<option value="">-- All --</option>
|
|
[% FOREACH branchloo IN branchloop %]
|
|
[% IF ( branchloo.selected ) %]<option value="[% branchloo.value %]" selected="selected">[% branchloo.branchname %]</option>
|
|
[% ELSE %]
|
|
<option value="[% branchloo.value %]">[% branchloo.branchname %]</option>
|
|
[% END %]
|
|
[% END %]
|
|
</select>
|
|
</li>
|
|
<li>
|
|
<label for="startcn">From item call number: </label>
|
|
<input id="startcn" type="text" name="start_callnumber" size="5" />
|
|
</li>
|
|
<li>
|
|
<label for="endcn">To item call number: </label>
|
|
<input id="endcn" type="text" name="end_callnumber" size="5" />
|
|
</li>
|
|
<li>Accession date (inclusive):
|
|
<ul><li>
|
|
<label for="from">Start date:</label>
|
|
<input type="text" size="10" id="from" name="start_accession" value="[% from %]" class="datepickerfrom" />
|
|
</li>
|
|
<li><label for="to">
|
|
End date:
|
|
</label>
|
|
<input size="10" id="to" name="end_accession" value="[% end_accession %]" type="text" class="datepickerto" />
|
|
</li>
|
|
</ul></li></ol>
|
|
</fieldset>
|
|
<fieldset class="rows">
|
|
<legend> Options</legend>
|
|
<ol> <li>
|
|
<label for="dont_export_item">Don't export items</label>
|
|
<input id="dont_export_item" type="checkbox" name="dont_export_item" />
|
|
</li>
|
|
<li>
|
|
<label for="strip_nonlocal_items">Remove non-local items</label>
|
|
<input id="strip_nonlocal_items" type="checkbox" name="strip_nonlocal_items" />
|
|
</li>
|
|
<li>
|
|
<label for="dont_export_fields">Don't export fields</label>
|
|
<input id="dont_export_fields" type="text" name="dont_export_fields" />
|
|
separate by a blank. (e.g., 100a 200 606)
|
|
</li></ol>
|
|
</fieldset>
|
|
<fieldset class="rows">
|
|
<legend>
|
|
Output format
|
|
</legend>
|
|
<ol><li>
|
|
<label for="output_format">File format: </label>
|
|
<select id="output_format" name="output_format">
|
|
<option value="marc">marc</option>
|
|
<option value="xml">xml</option>
|
|
</select>
|
|
|
|
</li>
|
|
<li>
|
|
<label for="filename">File name:</label><input id="filename" type="text" name="filename" value="koha.mrc" />
|
|
</li></ol>
|
|
</fieldset>
|
|
<input type="hidden" name="op" value="export" />
|
|
<input type="hidden" name="record_type" value="bibs" />
|
|
|
|
<fieldset class="action"><input type="submit" value="Export bibliographic records" class="button" /></fieldset>
|
|
</form>
|
|
</div>
|
|
|
|
<div id="auths">
|
|
<form method="post" action="/cgi-bin/koha/tools/export.pl">
|
|
<fieldset class="rows">
|
|
<legend> Select records to export </legend>
|
|
<ol><li>
|
|
<label for="start">From authid: </label>
|
|
<input id="start" type="text" name="starting_authid" size="6" />
|
|
</li>
|
|
<li>
|
|
<label for="end">To authid: </label>
|
|
<input id="end" type="text" name="ending_authid" size="6" />
|
|
</li>
|
|
<li>
|
|
<label for="authtype">Authority type: </label>
|
|
<select name="authtype" id="authtype">
|
|
<option value="">-- All --</option>
|
|
[% FOREACH authtypeloo IN authtypeloop %]
|
|
[% IF ( authtypeloo.selected ) %]
|
|
<option value="[% authtypeloo.value %]" selected="selected">[% authtypeloo.description %]</option>
|
|
[% ELSE %]
|
|
<option value="[% authtypeloo.value %]">[% authtypeloo.description %]</option>
|
|
[% END %]
|
|
[% END %]
|
|
</select>
|
|
</li>
|
|
</ol>
|
|
</fieldset>
|
|
<fieldset class="rows">
|
|
<legend>Options</legend>
|
|
<ol>
|
|
<li>
|
|
<label for="dont_export_fields">Don't export fields</label>
|
|
<input id="dont_export_fields" type="text" name="dont_export_fields" />
|
|
separate by a blank. (e.g., 100a 200 606)
|
|
</li></ol>
|
|
</fieldset>
|
|
<fieldset class="rows">
|
|
<legend>Output format</legend>
|
|
<ol><li>
|
|
<label for="output_format">File format: </label>
|
|
<select id="output_format" name="output_format">
|
|
<option value="marc">marc</option>
|
|
<option value="xml">xml</option>
|
|
</select>
|
|
</li>
|
|
<li>
|
|
<label for="filename">File name:</label><input id="filename" type="text" name="filename" value="koha.mrc" />
|
|
</li></ol>
|
|
</fieldset>
|
|
<input type="hidden" name="op" value="export" />
|
|
<input type="hidden" name="record_type" value="auths" />
|
|
|
|
<fieldset class="action"><input type="submit" value="Export authority records" class="button" /></fieldset>
|
|
</form>
|
|
</div>
|
|
|
|
[% IF ( allow_db_export ) %]
|
|
<div id="db">
|
|
<form method="post" action="/cgi-bin/koha/tools/export.pl">
|
|
<p><b>Note : This export file will be very large, and is generated nightly.</b></p>
|
|
<fieldset class="rows">
|
|
<legend> Choose a file </legend>
|
|
[% IF ( dbfiles && (dbfiles.size > 0) ) %]
|
|
<ul>
|
|
[% FOREACH dbfile IN dbfiles %]
|
|
<li><input type="radio" name="filename" value="[% dbfile %]">[% dbfile %]</input></li>
|
|
[% END %]
|
|
</ul>
|
|
[% ELSE %]
|
|
<p>Unfortunately, no backups are available.</p>
|
|
[% END %]
|
|
</fieldset>
|
|
|
|
[% IF ( dbfiles && (dbfiles.size > 0) ) %]
|
|
<input type="hidden" name="op" value="export" />
|
|
<input type="hidden" name="record_type" value="db" />
|
|
<fieldset class="action"><input type="submit" value="Download database" class="button" /></fieldset>
|
|
[% END %]
|
|
</form>
|
|
</div>
|
|
[% END %]
|
|
|
|
[% IF ( allow_conf_export ) %]
|
|
<div id="conf">
|
|
<form method="post" action="/cgi-bin/koha/tools/export.pl">
|
|
<p><b>Note : This export file will be very large, and is generated nightly.</b></p>
|
|
<fieldset class="rows">
|
|
<legend> Choose a file </legend>
|
|
[% IF ( conffiles && (conffiles.size > 0) ) %]
|
|
<ul>
|
|
[% FOREACH conffile IN conffiles %]
|
|
<li><input type="radio" name="filename" value="[% conffile %]">[% conffile %]</input></li>
|
|
[% END %]
|
|
</ul>
|
|
[% ELSE %]
|
|
<p>Unfortunately, no backups are available.</p>
|
|
[% END %]
|
|
</fieldset>
|
|
|
|
[% IF ( conffiles && (conffiles.size > 0) ) %]
|
|
<input type="hidden" name="op" value="export" />
|
|
<input type="hidden" name="record_type" value="conf" />
|
|
<fieldset class="action"><input type="submit" value="Download configuration" class="button" /></fieldset>
|
|
[% END %]
|
|
</form>
|
|
</div>
|
|
[% END %]
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b noprint">
|
|
[% INCLUDE 'tools-menu.inc' %]
|
|
</div>
|
|
</div>
|
|
[% INCLUDE 'intranet-bottom.inc' %]
|