Bug 21832: add unit test
[koha.git] / tools / export.pl
blob0704b57d6de4ef59ec05c057db9e5f8a8f83c9dc
1 #!/usr/bin/perl
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>.
19 use Modern::Perl;
20 use CGI qw ( -utf8 );
21 use MARC::File::XML;
22 use List::MoreUtils qw(uniq);
23 use C4::Auth;
24 use C4::Output;
26 use Koha::Authority::Types;
27 use Koha::Biblioitems;
28 use Koha::CsvProfiles;
29 use Koha::Database;
30 use Koha::DateUtils qw( dt_from_string output_pref );
31 use Koha::Exporter::Record;
32 use Koha::ItemTypes;
33 use Koha::Libraries;
35 my $query = new CGI;
37 my $dont_export_items = $query->param("dont_export_item") || 0;
38 my $record_type = $query->param("record_type");
39 my $op = $query->param("op") || '';
40 my $output_format = $query->param("format") || $query->param("output_format") || 'iso2709';
41 my $backupdir = C4::Context->config('backupdir');
42 my $filename = $query->param("filename") || ( $output_format eq 'csv' ? 'koha.csv' : 'koha.mrc' );
43 $filename =~ s/(\r|\n)//;
45 my $dbh = C4::Context->dbh;
47 my @record_ids;
48 # biblionumbers is sent from circulation.pl only
49 if ( $query->param("biblionumbers") ) {
50 $record_type = 'bibs';
51 @record_ids = $query->multi_param("biblionumbers");
54 # Default value for output_format is 'iso2709'
55 $output_format ||= 'iso2709';
56 # Retrocompatibility for the format parameter
57 $output_format = 'iso2709' if $output_format eq 'marc';
59 my ( $template, $loggedinuser, $cookie, $flags ) = get_template_and_user(
61 template_name => "tools/export.tt",
62 query => $query,
63 type => "intranet",
64 authnotrequired => 0,
65 flagsrequired => { tools => 'export_catalog' },
66 debug => 1,
70 my @branch = $query->multi_param("branch");
72 my @messages;
73 if ( $op eq 'export' ) {
74 my $filename = $query->param('id_list_file');
75 if ( $filename ) {
76 my $mimetype = $query->uploadInfo($filename)->{'Content-Type'};
77 my @valid_mimetypes = qw( application/octet-stream text/csv text/plain application/vnd.ms-excel );
78 unless ( grep { /^$mimetype$/ } @valid_mimetypes ) {
79 push @messages, { type => 'alert', code => 'invalid_mimetype' };
80 $op = '';
85 if ( $op eq "export" ) {
87 my $export_remove_fields = $query->param("export_remove_fields") || q||;
88 my @biblionumbers = $query->multi_param("biblionumbers");
89 my @itemnumbers = $query->multi_param("itemnumbers");
90 my $strip_items_not_from_libraries = $query->param('strip_items_not_from_libraries');
91 my @sql_params;
92 my $sql_query;
94 my $libraries = Koha::Libraries->search_filtered->unblessed;
95 my $only_export_items_for_branches = $strip_items_not_from_libraries ? \@branch : undef;
96 my @branchcodes;
97 for my $branchcode ( @branch ) {
98 if ( grep { $_->{branchcode} eq $branchcode } @$libraries ) {
99 push @branchcodes, $branchcode;
103 if ( $record_type eq 'bibs' or $record_type eq 'auths' ) {
104 # No need to retrieve the record_ids if we already get them
105 unless ( @record_ids ) {
106 if ( $record_type eq 'bibs' ) {
107 my $starting_biblionumber = $query->param("StartingBiblionumber");
108 my $ending_biblionumber = $query->param("EndingBiblionumber");
109 my $itemtype = $query->param("itemtype");
110 my $start_callnumber = $query->param("start_callnumber");
111 my $end_callnumber = $query->param("end_callnumber");
112 my $start_accession =
113 ( $query->param("start_accession") )
114 ? dt_from_string( scalar $query->param("start_accession") )
115 : '';
116 my $end_accession =
117 ( $query->param("end_accession") )
118 ? dt_from_string( scalar $query->param("end_accession") )
119 : '';
122 my $conditions = {
123 ( $starting_biblionumber or $ending_biblionumber )
125 "me.biblionumber" => {
126 ( $starting_biblionumber ? ( '>=' => $starting_biblionumber ) : () ),
127 ( $ending_biblionumber ? ( '<=' => $ending_biblionumber ) : () ),
130 : (),
132 ( $start_callnumber or $end_callnumber )
134 'items.itemcallnumber' => {
135 ( $start_callnumber ? ( '>=' => $start_callnumber ) : () ),
136 ( $end_callnumber ? ( '<=' => $end_callnumber ) : () ),
139 : (),
141 ( $start_accession or $end_accession )
143 'items.dateaccessioned' => {
144 ( $start_accession ? ( '>=' => $start_accession ) : () ),
145 ( $end_accession ? ( '<=' => $end_accession ) : () ),
148 : (),
149 ( @branchcodes ? ( 'items.homebranch' => { in => \@branchcodes } ) : () ),
150 ( $itemtype
152 C4::Context->preference('item-level_itypes')
153 ? ( 'items.itype' => $itemtype )
154 : ( 'me.itemtype' => $itemtype )
155 : ()
159 my $biblioitems = Koha::Biblioitems->search( $conditions, { join => 'items', columns => 'biblionumber' } );
160 while ( my $biblioitem = $biblioitems->next ) {
161 push @record_ids, $biblioitem->biblionumber;
164 elsif ( $record_type eq 'auths' ) {
165 my $starting_authid = $query->param('starting_authid');
166 my $ending_authid = $query->param('ending_authid');
167 my $authtype = $query->param('authtype');
169 my $conditions = {
170 ( $starting_authid or $ending_authid )
172 authid => {
173 ( $starting_authid ? ( '>=' => $starting_authid ) : () ),
174 ( $ending_authid ? ( '<=' => $ending_authid ) : () ),
177 : (),
178 ( $authtype ? ( authtypecode => $authtype ) : () ),
180 # Koha::MetadataRecord::Authority is not a Koha::Object...
181 my $authorities = Koha::Database->new->schema->resultset('AuthHeader')->search( $conditions );
182 @record_ids = map { $_->authid } $authorities->all;
186 @record_ids = uniq @record_ids;
187 if ( @record_ids and my $filefh = $query->upload("id_list_file") ) {
188 my @filter_record_ids = <$filefh>;
189 @filter_record_ids = map { my $id = $_; $id =~ s/[\r\n]*$//; $id } @filter_record_ids;
190 # intersection
191 my %record_ids = map { $_ => 1 } @record_ids;
192 @record_ids = grep $record_ids{$_}, @filter_record_ids;
195 print CGI->new->header(
196 -type => 'application/octet-stream',
197 -charset => 'utf-8',
198 -attachment => $filename,
201 my $csv_profile_id = $query->param('csv_profile_id');
202 Koha::Exporter::Record::export(
203 { record_type => $record_type,
204 record_ids => \@record_ids,
205 format => $output_format,
206 filename => $filename,
207 itemnumbers => \@itemnumbers,
208 dont_export_fields => $export_remove_fields,
209 csv_profile_id => $csv_profile_id,
210 export_items => (not $dont_export_items),
211 only_export_items_for_branches => $only_export_items_for_branches,
215 elsif ( $record_type eq 'db' or $record_type eq 'conf' ) {
216 my $successful_export;
218 if ( $flags->{superlibrarian}
219 and (
220 $record_type eq 'db' and C4::Context->config('backup_db_via_tools')
222 $record_type eq 'conf' and C4::Context->config('backup_conf_via_tools')
225 binmode STDOUT, ':encoding(UTF-8)';
227 my $charset = 'utf-8';
228 my $mimetype = 'application/octet-stream';
229 if ( $filename =~ m/\.gz$/ ) {
230 $mimetype = 'application/x-gzip';
231 $charset = '';
232 binmode STDOUT;
234 elsif ( $filename =~ m/\.bz2$/ ) {
235 $mimetype = 'application/x-bzip2';
236 binmode STDOUT;
237 $charset = '';
239 print $query->header(
240 -type => $mimetype,
241 -charset => $charset,
242 -attachment => $filename,
245 my $extension = $record_type eq 'db' ? 'sql' : 'tar';
247 $successful_export = download_backup(
249 directory => $backupdir,
250 extension => $extension,
251 filename => $filename,
254 unless ($successful_export) {
255 my $remotehost = $query->remote_host();
256 $remotehost =~ s/(\n|\r)//;
257 warn
258 "A suspicious attempt was made to download the " . ( $record_type eq 'db' ? 'db' : 'configuration' ) . "at '$filename' by someone at "
259 . $remotehost . "\n";
264 exit;
267 else {
269 my $itemtypes = Koha::ItemTypes->search_with_localization;
271 my $authority_types = Koha::Authority::Types->search( {}, { order_by => ['authtypecode'] } );
273 my $libraries = Koha::Libraries->search_filtered({}, { order_by => ['branchname'] })->unblessed;
274 for my $library ( @$libraries ) {
275 $library->{selected} = 1 if grep { $library->{branchcode} eq $_ } @branch;
278 if ( $flags->{superlibrarian}
279 && C4::Context->config('backup_db_via_tools')
280 && $backupdir
281 && -d $backupdir )
283 $template->{VARS}->{'allow_db_export'} = 1;
284 $template->{VARS}->{'dbfiles'} = getbackupfilelist(
285 { directory => "$backupdir", extension => 'sql' } );
288 if ( $flags->{superlibrarian}
289 && C4::Context->config('backup_conf_via_tools')
290 && $backupdir
291 && -d $backupdir )
293 $template->{VARS}->{'allow_conf_export'} = 1;
294 $template->{VARS}->{'conffiles'} = getbackupfilelist(
295 { directory => "$backupdir", extension => 'tar' } );
298 $template->param(
299 libraries => $libraries,
300 itemtypes => $itemtypes,
301 authority_types => $authority_types,
302 export_remove_fields => C4::Context->preference("ExportRemoveFields"),
303 csv_profiles => [ Koha::CsvProfiles->search({ type => 'marc', used_for => 'export_records' }) ],
304 messages => \@messages,
307 output_html_with_http_headers $query, $cookie, $template->output;
310 sub getbackupfilelist {
311 my $args = shift;
312 my $directory = $args->{directory};
313 my $extension = $args->{extension};
314 my @files;
316 if ( opendir( my $dir, $directory ) ) {
317 while ( my $file = readdir($dir) ) {
318 next unless ( $file =~ m/\.$extension(\.(gz|bz2|xz))?/ );
319 push @files, $file
320 if ( -f "$directory/$file" && -r "$directory/$file" );
322 closedir($dir);
324 return \@files;
327 sub download_backup {
328 my $args = shift;
329 my $directory = $args->{directory};
330 my $extension = $args->{extension};
331 my $filename = $args->{filename};
333 return unless ( $directory && -d $directory );
334 return unless ( $filename =~ m/\.$extension(\.(gz|bz2|xz))?$/ );
335 return if ( $filename =~ m#/# );
336 $filename = "$directory/$filename";
337 return unless ( -f $filename && -r $filename );
338 return unless ( open( my $dump, '<', $filename ) );
339 binmode $dump;
341 while ( read( $dump, my $data, 64 * 1024 ) ) {
342 print $data;
344 close($dump);
345 return 1;