4 # This file is part of Koha.
6 # Koha is free software; you can redistribute it and/or modify it
7 # under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # Koha is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21 use List::MoreUtils qw(uniq);
30 use Koha::Biblioitems;
32 use Koha::CsvProfiles;
33 use Koha::Exporter::Record;
34 use Koha::DateUtils qw( dt_from_string output_pref );
36 my ( $output_format, $timestamp, $dont_export_items, $csv_profile_id, $deleted_barcodes, $clean, $filename, $record_type, $id_list_file, $starting_authid, $ending_authid, $authtype, $starting_biblionumber, $ending_biblionumber, $itemtype, $starting_callnumber, $ending_callnumber, $start_accession, $end_accession, $help );
38 'format=s' => \$output_format,
39 'date=s' => \$timestamp,
40 'dont_export_items' => \$dont_export_items,
41 'csv_profile_id=s' => \$csv_profile_id,
42 'deleted_barcodes' => \$deleted_barcodes,
44 'filename=s' => \$filename,
45 'record-type=s' => \$record_type,
46 'id_list_file=s' => \$id_list_file,
47 'starting_authid=s' => \$starting_authid,
48 'ending_authid=s' => \$ending_authid,
49 'authtype=s' => \$authtype,
50 'starting_biblionumber=s' => \$starting_biblionumber,
51 'ending_biblionumber=s' => \$ending_biblionumber,
52 'itemtype=s' => \$itemtype,
53 'starting_callnumber=s' => \$starting_callnumber,
54 'ending_callnumber=s' => \$ending_callnumber,
55 'start_accession=s' => \$start_accession,
56 'end_accession=s' => \$end_accession,
64 $filename ||= 'koha.mrc';
65 $output_format ||= 'iso2709';
66 $record_type ||= 'bibs';
68 # Retrocompatibility for the format parameter
69 $output_format = 'iso2709' if $output_format eq 'marc';
71 if ( $output_format eq 'csv' and $record_type eq 'auths' ) {
72 pod2usage(q|CSV output is only available for biblio records|);
76 if ( $timestamp and $record_type ne 'bibs' ) {
77 pod2usage(q|--timestamp can only be used with biblios|);
80 if ( $record_type ne 'bibs' and $record_type ne 'auths' ) {
81 pod2usage(q|--record_type is not valid|);
84 if ( $deleted_barcodes and $record_type ne 'bibs' ) {
85 pod2usage(q|--deleted_barcodes can only be used with biblios|);
88 $start_accession = dt_from_string( $start_accession ) if $start_accession;
89 $end_accession = dt_from_string( $end_accession ) if $end_accession;
91 my $dbh = C4::Context->dbh;
94 open STDOUT, '>', $filename if $filename;
99 $timestamp = ($timestamp) ? output_pref({ dt => dt_from_string($timestamp), dateformat => 'iso', dateonly => 1, }): '';
101 if ( $record_type eq 'bibs' ) {
103 push @record_ids, $_->{biblionumber} for @{
104 $dbh->selectall_arrayref(q| (
107 LEFT JOIN items USING(biblionumber)
108 WHERE biblioitems.timestamp >= ?
109 OR items.timestamp >= ?
113 LEFT JOIN deleteditems USING(biblionumber)
114 WHERE biblioitems.timestamp >= ?
115 OR deleteditems.timestamp >= ?
116 ) |, { Slice => {} }, ( $timestamp ) x 4 );
120 ( $starting_biblionumber or $ending_biblionumber )
122 "me.biblionumber" => {
123 ( $starting_biblionumber ? ( '>=' => $starting_biblionumber ) : () ),
124 ( $ending_biblionumber ? ( '<=' => $ending_biblionumber ) : () ),
128 ( $starting_callnumber or $ending_callnumber )
131 ( $starting_callnumber ? ( '>=' => $starting_callnumber ) : () ),
132 ( $ending_callnumber ? ( '<=' => $ending_callnumber ) : () ),
136 ( $start_accession or $end_accession )
139 ( $start_accession ? ( '>=' => $start_accession ) : () ),
140 ( $end_accession ? ( '<=' => $end_accession ) : () ),
146 C4::Context->preference('item-level_itypes')
147 ? ( 'items.itype' => $itemtype )
148 : ( 'biblioitems.itemtype' => $itemtype )
153 my $biblioitems = Koha::Biblioitems->search( $conditions, { join => 'items' } );
154 while ( my $biblioitem = $biblioitems->next ) {
155 push @record_ids, $biblioitem->biblionumber;
159 elsif ( $record_type eq 'auths' ) {
161 ( $starting_authid or $ending_authid )
164 ( $starting_authid ? ( '>=' => $starting_authid ) : () ),
165 ( $ending_authid ? ( '<=' => $ending_authid ) : () ),
169 ( $authtype ? ( authtypecode => $authtype ) : () ),
171 # Koha::MetadataRecord::Authority is not a Koha::Object...
172 my $authorities = Koha::Database->new->schema->resultset('AuthHeader')->search( $conditions );
173 @record_ids = map { $_->authid } $authorities->all;
176 @record_ids = uniq @record_ids;
177 if ( @record_ids and $id_list_file ) {
178 open my $fh, '<', $id_list_file or die "Cannot open file $id_list_file ($!)";
179 my @filter_record_ids = <$fh>;
180 @filter_record_ids = map { my $id = $_; $id =~ s/[\r\n]*$//; $id } @filter_record_ids;
182 my %record_ids = map { $_ => 1 } @record_ids;
183 @record_ids = grep $record_ids{$_}, @filter_record_ids;
186 if ($deleted_barcodes) {
187 for my $record_id ( @record_ids ) {
190 my $barcode = $dbh->selectall_arrayref(q| (
191 SELECT DISTINCT barcode
193 WHERE deleteditems.biblionumber = ?
194 |, { Slice => {} }, $record_id );
195 say $_->{barcode} for @$barcode
199 unless ( $csv_profile_id ) {
200 my $default_csv_profile = Koha::CsvProfiles->search({ profile => C4::Context->preference('ExportWithCsvProfile') });
201 $csv_profile_id = $default_csv_profile ? $default_csv_profile->export_format_id : undef;
203 Koha::Exporter::Record::export(
204 { record_type => $record_type,
205 record_ids => \@record_ids,
206 format => $output_format,
207 csv_profile_id => $csv_profile_id,
208 export_items => (not $dont_export_items),
209 clean => $clean || 0,
218 export records - This script exports record (biblios or authorities)
222 export_records.pl [-h|--help] [--format=format] [--date=date] [--record-type=TYPE] [--dont_export_items] [--deleted_barcodes] [--clean] [--id_list_file=PATH] --filename=outputfile
230 Print a brief help message.
234 --format=FORMAT FORMAT is either 'xml', 'csv' (biblio records only) or 'marc' (default).
238 --date=DATE DATE should be entered as the 'dateformat' syspref is
239 set (dd/mm/yyyy for metric, yyyy-mm-dd for iso,
240 mm/dd/yyyy for us) records exported are the ones that
241 have been modified since DATE.
243 =item B<--record-type>
245 --record-type=TYPE TYPE is 'bibs' or 'auths'.
247 =item B<--dont_export_items>
249 --dont_export_items If enabled, the item infos won't be exported.
251 =item B<--csv_profile_id>
253 --csv_profile_id=ID Generate a CSV file with the given CSV profile id (see tools/csv-profiles.pl)
254 Unless provided, the one defined in the system preference 'ExportWithCsvProfile' will be used.
255 This can only be used to export biblio records.
257 =item B<--deleted_barcodes>
259 --deleted_barcodes If used, a list of barcodes of items deleted since DATE
260 is produced (or from all deleted items if no date is
261 specified). Used only if TYPE is 'bibs'.
265 --clean removes NSE/NSB.
267 =item B<--id_list_file>
269 --id_list_file=PATH PATH is a path to a file containing a list of
270 IDs (biblionumber or authid) with one ID per line.
271 This list works as a filter; it is compatible with
272 other parameters for selecting records.
276 --filename=FILENAME FILENAME used to export the data.
278 =item B<--starting_authid>
280 --starting_authid=ID Export authorities with authid >= ID
282 =item B<--ending_authid>
284 --ending_authid=ID Export authorities with authid <= ID
288 --authtype=AUTHTYPE Export authorities from the given AUTHTYPE
290 =item B<--starting_biblionumber>
292 --starting_biblionumber=ID Export biblio with biblionumber >= ID
294 =item B<--ending_biblionumber>
296 --ending_biblionumber=ID Export biblio with biblionumber <= ID
300 --itemtype=ITEMTYPE Export biblio from the given ITEMTYPE
302 =item B<--starting_callnumber>
304 --starting_callnumber=CALLNUMBER Export biblio with callnumber >=CALLNUMBER
306 =item B<--ending_callnumber>
308 --ending_callnumber=CALLNUMBER Export biblio with callnumber <=CALLNUMBER
310 =item B<--start_accession>
312 --starting_accession=DATE Export biblio with an item accessionned after DATE
314 =item B<--end_accession>
316 --end_accession=DATE Export biblio with an item accessionned after DATE
322 Koha Development Team
330 This file is part of Koha.
332 Koha 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
333 Foundation; either version 3 of the License, or (at your option) any later version.
335 You should have received a copy of the GNU General Public License along
336 with Koha; if not, write to the Free Software Foundation, Inc.,
337 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.