Revert "Bug 23493: (follow-up) Switch to aDataSort for multi-column sorting"
[koha.git] / C4 / Breeding.pm
bloba93189c13fe6ba3fa1a1996afe9f0fff640ecaa7
1 package C4::Breeding;
3 # Copyright 2000-2002 Katipo Communications
4 # Parts Copyright 2013 Prosentient Systems
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21 use strict;
22 use warnings;
24 use C4::Biblio;
25 use C4::Koha;
26 use C4::Charset;
27 use MARC::File::USMARC;
28 use MARC::Field;
29 use C4::ImportBatch;
30 use C4::AuthoritiesMarc; #GuessAuthTypeCode, FindDuplicateAuthority
31 use C4::Languages;
32 use Koha::Database;
33 use Koha::XSLT_Handler;
35 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
37 BEGIN {
38 require Exporter;
39 @ISA = qw(Exporter);
40 @EXPORT = qw(&BreedingSearch &Z3950Search &Z3950SearchAuth);
43 =head1 NAME
45 C4::Breeding : module to add biblios to import_records via
46 the breeding/reservoir API.
48 =head1 SYNOPSIS
50 Z3950Search($pars, $template);
51 ($count, @results) = &BreedingSearch($title,$isbn);
53 =head1 DESCRIPTION
55 This module contains routines related to Koha's Z39.50 search into
56 cataloguing reservoir features.
58 =head2 BreedingSearch
60 ($count, @results) = &BreedingSearch($title,$isbn);
61 C<$title> contains the title,
62 C<$isbn> contains isbn or issn,
64 C<$count> is the number of items in C<@results>. C<@results> is an
65 array of references-to-hash; the keys are the items from the C<import_records> and
66 C<import_biblios> tables of the Koha database.
68 =cut
70 sub BreedingSearch {
71 my ($search,$isbn) = @_;
72 my $dbh = C4::Context->dbh;
73 my $count = 0;
74 my ($query,@bind);
75 my $sth;
76 my @results;
78 # normalise ISBN like at import
79 $isbn = C4::Koha::GetNormalizedISBN($isbn);
81 $query = "SELECT import_record_id, file_name, isbn, title, author
82 FROM import_biblios
83 JOIN import_records USING (import_record_id)
84 JOIN import_batches USING (import_batch_id)
85 WHERE ";
86 @bind=();
87 if (defined($search) && length($search)>0) {
88 $search =~ s/(\s+)/\%/g;
89 $query .= "title like ? OR author like ?";
90 push(@bind,"%$search%", "%$search%");
92 if ($#bind!=-1 && defined($isbn) && length($isbn)>0) {
93 $query .= " and ";
95 if (defined($isbn) && length($isbn)>0) {
96 $query .= "isbn like ?";
97 push(@bind,"$isbn%");
99 $sth = $dbh->prepare($query);
100 $sth->execute(@bind);
101 while (my $data = $sth->fetchrow_hashref) {
102 $results[$count] = $data;
103 # FIXME - hack to reflect difference in name
104 # of columns in old marc_breeding and import_records
105 # There needs to be more separation between column names and
106 # field names used in the templates </soapbox>
107 $data->{'file'} = $data->{'file_name'};
108 $data->{'id'} = $data->{'import_record_id'};
109 $count++;
110 } # while
112 $sth->finish;
113 return($count, @results);
114 } # sub breedingsearch
117 =head2 Z3950Search
119 Z3950Search($pars, $template);
121 Parameters for Z3950 search are all passed via the $pars hash. It may contain isbn, title, author, dewey, subject, lccall, controlnumber, stdid, srchany.
122 Also it should contain an arrayref id that points to a list of id's of the z3950 targets to be queried (see z3950servers table).
123 This code is used in acqui/z3950_search and cataloging/z3950_search.
124 The second parameter $template is a Template object. The routine uses this parameter to store the found values into the template.
126 =cut
128 sub Z3950Search {
129 my ($pars, $template)= @_;
131 my @id= @{$pars->{id}};
132 my $page= $pars->{page};
133 my $biblionumber= $pars->{biblionumber};
135 my $show_next = 0;
136 my $total_pages = 0;
137 my @results;
138 my @breeding_loop = ();
139 my @oConnection;
140 my @oResult;
141 my @errconn;
142 my $s = 0;
143 my $imported=0;
145 my ( $zquery, $squery ) = _bib_build_query( $pars );
147 my $schema = Koha::Database->new()->schema();
148 my $rs = $schema->resultset('Z3950server')->search(
149 { id => [ @id ] },
150 { result_class => 'DBIx::Class::ResultClass::HashRefInflator' },
152 my @servers = $rs->all;
153 foreach my $server ( @servers ) {
154 $oConnection[$s] = _create_connection( $server );
155 $oResult[$s] =
156 $server->{servertype} eq 'zed'?
157 $oConnection[$s]->search_pqf( $zquery ):
158 $oConnection[$s]->search(new ZOOM::Query::CQL(
159 _translate_query( $server, $squery )));
160 $s++;
162 my $xslh = Koha::XSLT_Handler->new;
164 my $nremaining = $s;
165 while ( $nremaining-- ) {
166 my $k;
167 my $event;
168 while ( ( $k = ZOOM::event( \@oConnection ) ) != 0 ) {
169 $event = $oConnection[ $k - 1 ]->last_event();
170 last if $event == ZOOM::Event::ZEND;
173 if ( $k != 0 ) {
174 $k--;
175 my ($error)= $oConnection[$k]->error_x(); #ignores errmsg, addinfo, diagset
176 if ($error) {
177 if ($error =~ m/^(10000|10007)$/ ) {
178 push(@errconn, { server => $servers[$k]->{host}, error => $error } );
181 else {
182 my $numresults = $oResult[$k]->size();
183 my $i;
184 my $res;
185 if ( $numresults > 0 and $numresults >= (($page-1)*20)) {
186 $show_next = 1 if $numresults >= ($page*20);
187 $total_pages = int($numresults/20)+1 if $total_pages < ($numresults/20);
188 for ($i = ($page-1)*20; $i < (($numresults < ($page*20)) ? $numresults : ($page*20)); $i++) {
189 if ( $oResult[$k]->record($i) ) {
190 undef $error;
191 ( $res, $error ) = _handle_one_result( $oResult[$k]->record($i), $servers[$k], ++$imported, $biblionumber, $xslh ); #ignores error in sequence numbering
192 push @breeding_loop, $res if $res;
193 push @errconn, { server => $servers[$k]->{servername}, error => $error, seq => $i+1 } if $error;
195 else {
196 push @errconn, { 'server' => $servers[$k]->{servername}, error => ( ( $oConnection[$k]->error_x() )[0] ), seq => $i+1 };
199 } #if $numresults
201 } # if $k !=0
203 $template->param(
204 numberpending => $nremaining,
205 current_page => $page,
206 total_pages => $total_pages,
207 show_nextbutton => $show_next?1:0,
208 show_prevbutton => $page!=1,
210 } # while nremaining
212 #close result sets and connections
213 foreach(0..$s-1) {
214 $oResult[$_]->destroy();
215 $oConnection[$_]->destroy();
218 $template->param(
219 breeding_loop => \@breeding_loop,
220 servers => \@servers,
221 errconn => \@errconn
225 sub _auth_build_query {
226 my ( $pars ) = @_;
228 my $qry_build = {
229 nameany => '@attr 1=1002 "#term" ',
230 authorany => '@attr 1=1003 "#term" ',
231 authorcorp => '@attr 1=2 "#term" ',
232 authorpersonal => '@attr 1=1 "#term" ',
233 authormeetingcon => '@attr 1=3 "#term" ',
234 subject => '@attr 1=21 "#term" ',
235 subjectsubdiv => '@attr 1=47 "#term" ',
236 title => '@attr 1=4 "#term" ',
237 uniformtitle => '@attr 1=6 "#term" ',
238 srchany => '@attr 1=1016 "#term" ',
239 controlnumber => '@attr 1=12 "#term" ',
242 return _build_query( $pars, $qry_build );
245 sub _bib_build_query {
247 my ( $pars ) = @_;
249 my $qry_build = {
250 isbn => '@attr 1=7 @attr 5=1 "#term" ',
251 issn => '@attr 1=8 @attr 5=1 "#term" ',
252 title => '@attr 1=4 "#term" ',
253 author => '@attr 1=1003 "#term" ',
254 dewey => '@attr 1=16 "#term" ',
255 subject => '@attr 1=21 "#term" ',
256 lccall => '@attr 1=16 @attr 2=3 @attr 3=1 @attr 4=1 @attr 5=1 '.
257 '@attr 6=1 "#term" ',
258 controlnumber => '@attr 1=12 "#term" ',
259 srchany => '@attr 1=1016 "#term" ',
260 stdid => '@attr 1=1007 "#term" ',
263 return _build_query( $pars, $qry_build );
266 sub _build_query {
268 my ( $pars, $qry_build ) = @_;
270 my $zquery='';
271 my $squery='';
272 my $nterms=0;
273 foreach my $k ( sort keys %$pars ) {
274 #note that the sort keys forces an identical result under Perl 5.18
275 #one of the unit tests is based on that assumption
276 if( ( my $val=$pars->{$k} ) && $qry_build->{$k} ) {
277 $qry_build->{$k} =~ s/#term/$val/g;
278 $zquery .= $qry_build->{$k};
279 $squery .= "[$k]=\"$val\" and ";
280 $nterms++;
283 $zquery = "\@and " . $zquery for 2..$nterms;
284 $squery =~ s/ and $//;
285 return ( $zquery, $squery );
288 sub _handle_one_result {
289 my ( $zoomrec, $servhref, $seq, $bib, $xslh )= @_;
291 my $raw= $zoomrec->raw();
292 my $marcrecord;
293 if( $servhref->{servertype} eq 'sru' ) {
294 $marcrecord= MARC::Record->new_from_xml( $raw, 'UTF-8',
295 $servhref->{syntax} );
296 } else {
297 ($marcrecord) = MarcToUTF8Record($raw, C4::Context->preference('marcflavour'), $servhref->{encoding} // "iso-5426" ); #ignores charset return values
299 SetUTF8Flag($marcrecord);
300 my $error;
301 ( $marcrecord, $error ) = _do_xslt_proc($marcrecord, $servhref, $xslh);
303 my $batch_id = GetZ3950BatchId($servhref->{servername});
304 my $breedingid = AddBiblioToBatch($batch_id, $seq, $marcrecord, 'UTF-8', 0);
305 #Last zero indicates: no update for batch record counts
308 #call to TransformMarcToKoha replaced by next call
309 #we only need six fields from the marc record
310 my $row;
311 $row = _add_rowdata(
313 biblionumber => $bib,
314 server => $servhref->{servername},
315 breedingid => $breedingid,
316 }, $marcrecord) if $breedingid;
317 return ( $row, $error );
320 sub _do_xslt_proc {
321 my ( $marc, $server, $xslh ) = @_;
322 return $marc if !$server->{add_xslt};
324 my $htdocs = C4::Context->config('intrahtdocs');
325 my $theme = C4::Context->preference("template"); #staff
326 my $lang = C4::Languages::getlanguage() || 'en';
328 my @files= split ',', $server->{add_xslt};
329 my $xml = $marc->as_xml;
330 foreach my $f ( @files ) {
331 $f =~ s/^\s+//; $f =~ s/\s+$//; next if !$f;
332 $f = C4::XSLT::_get_best_default_xslt_filename(
333 $htdocs, $theme, $lang, $f ) unless $f =~ /^\//;
334 $xml = $xslh->transform( $xml, $f );
335 last if $xslh->err; #skip other files
337 if( !$xslh->err ) {
338 return MARC::Record->new_from_xml($xml, 'UTF-8');
339 } else {
340 return ( $marc, $xslh->err ); #original record in case of errors
344 sub _add_rowdata {
345 my ($row, $record)=@_;
346 my %fetch= (
347 title => 'biblio.title',
348 author => 'biblio.author',
349 isbn =>'biblioitems.isbn',
350 lccn =>'biblioitems.lccn', #LC control number (not call number)
351 edition =>'biblioitems.editionstatement'
353 $fetch{date} = C4::Context->preference('marcflavour') eq "MARC21" ? 'biblio.copyrightdate' : 'biblioitems.publicationyear';
355 foreach my $k (keys %fetch) {
356 $row->{$k} = C4::Biblio::TransformMarcToKohaOneField( $fetch{$k}, $record );
358 $row->{date}//= $row->{date2};
359 $row->{isbn}=_isbn_replace($row->{isbn});
361 $row = _add_custom_field_rowdata($row, $record);
363 return $row;
366 sub _add_custom_field_rowdata
368 my ( $row, $record ) = @_;
369 my $pref_newtags = C4::Context->preference('AdditionalFieldsInZ3950ResultSearch');
370 my $pref_flavour = C4::Context->preference('MarcFlavour');
372 $pref_newtags =~ s/^\s+|\s+$//g;
373 $pref_newtags =~ s/\h+/ /g;
375 my @addnumberfields;
377 foreach my $field (split /\,/, $pref_newtags) {
378 $field =~ s/^\s+|\s+$//g ; # trim whitespace
379 my ($tag, $subtags) = split(/\$/, $field);
381 if ( $record->field($tag) ) {
382 my @content = ();
384 for my $marcfield ($record->field($tag)) {
385 if ( $subtags ) {
386 my $str = '';
387 for my $code (split //, $subtags) {
388 if ( $marcfield->subfield($code) ) {
389 $str .= $marcfield->subfield($code) . ' ';
392 if ( not $str eq '') {
393 push @content, $str;
395 } elsif ( $tag == 10 ) {
396 push @content, ( $pref_flavour eq "MARC21" ? $marcfield->data : $marcfield->as_string );
397 } elsif ( $tag < 10 ) {
398 push @content, $marcfield->data();
399 } else {
400 push @content, $marcfield->as_string();
404 if ( @content ) {
405 $row->{$field} = \@content;
406 push( @addnumberfields, $field );
411 $row->{'addnumberfields'} = \@addnumberfields;
413 return $row;
416 sub _isbn_replace {
417 my ($isbn) = @_;
418 return unless defined $isbn;
419 $isbn =~ s/ |-|\.//g;
420 $isbn =~ s/\|/ \| /g;
421 $isbn =~ s/\(/ \(/g;
422 return $isbn;
425 sub _create_connection {
426 my ( $server ) = @_;
427 my $option1= new ZOOM::Options();
428 $option1->option( 'async' => 1 );
429 $option1->option( 'elementSetName', 'F' );
430 $option1->option( 'preferredRecordSyntax', $server->{syntax} );
431 $option1->option( 'timeout', $server->{timeout} ) if $server->{timeout};
433 if( $server->{servertype} eq 'sru' ) {
434 foreach( split ',', $server->{sru_options}//'' ) {
435 #first remove surrounding spaces at comma and equals-sign
436 s/^\s+|\s+$//g;
437 my @temp= split '=', $_, 2;
438 @temp= map { my $c=$_; $c=~s/^\s+|\s+$//g; $c; } @temp;
439 $option1->option( $temp[0] => $temp[1] ) if @temp;
441 } elsif( $server->{servertype} eq 'zed' ) {
442 $option1->option( 'databaseName', $server->{db} );
443 $option1->option( 'user', $server->{userid} ) if $server->{userid};
444 $option1->option( 'password', $server->{password} ) if $server->{password};
446 my $obj= ZOOM::Connection->create($option1);
447 if( $server->{servertype} eq 'sru' ) {
448 my $host= $server->{host};
449 if( $host !~ /^https?:\/\// ) {
450 #Normally, host will not be prefixed by protocol.
451 #In that case we can (safely) assume http.
452 #In case someone prefixed with https, give it a try..
453 $host = 'http://' . $host;
455 $obj->connect( $host.':'.$server->{port}.'/'.$server->{db} );
456 } else {
457 $obj->connect( $server->{host}, $server->{port} );
459 return $obj;
462 sub _translate_query { #SRU query adjusted per server cf. srufields column
463 my ($server, $query) = @_;
465 #sru_fields is in format title=field,isbn=field,...
466 #if a field doesn't exist, try anywhere or remove [field]=
467 my @parts= split(',', $server->{sru_fields} );
468 my %trans= map { if( /=/ ) { ( $`,$' ) } else { () } } @parts;
469 my $any= $trans{srchany}?$trans{srchany}.'=':'';
471 my $q=$query;
472 foreach my $key (keys %trans) {
473 my $f=$trans{$key};
474 if( $f ) {
475 $q=~s/\[$key\]/$f/g;
476 } else {
477 $q=~s/\[$key\]=/$any/g;
480 $q=~s/\[\w+\]=/$any/g; # remove remaining fields (not found in field list)
481 return $q;
484 =head2 ImportBreedingAuth
486 ImportBreedingAuth( $marcrecord, $filename, $encoding, $heading );
488 ImportBreedingAuth imports MARC records in the reservoir (import_records table) or returns their id if they already exist.
490 =cut
492 sub ImportBreedingAuth {
493 my ( $marcrecord, $filename, $encoding, $heading ) = @_;
494 my $dbh = C4::Context->dbh;
496 my $batch_id = GetZ3950BatchId($filename);
497 my $searchbreeding = $dbh->prepare("select import_record_id from import_auths where control_number=? and authorized_heading=?");
499 my $controlnumber = $marcrecord->field('001')->data;
501 # Normalize the record so it doesn't have separated diacritics
502 SetUTF8Flag($marcrecord);
504 $searchbreeding->execute($controlnumber,$heading);
505 my ($breedingid) = $searchbreeding->fetchrow;
507 return $breedingid if $breedingid;
508 $breedingid = AddAuthToBatch($batch_id, 0, $marcrecord, $encoding);
509 return $breedingid;
512 =head2 Z3950SearchAuth
514 Z3950SearchAuth($pars, $template);
516 Parameters for Z3950 search are all passed via the $pars hash. It may contain nameany, namepersonal, namecorp, namemeetingcon,
517 title, uniform title, subject, subjectsubdiv, srchany.
518 Also it should contain an arrayref id that points to a list of IDs of the z3950 targets to be queried (see z3950servers table).
519 This code is used in cataloging/z3950_auth_search.
520 The second parameter $template is a Template object. The routine uses this parameter to store the found values into the template.
522 =cut
524 sub Z3950SearchAuth {
525 my ($pars, $template)= @_;
527 my $dbh = C4::Context->dbh;
528 my @id= @{$pars->{id}};
529 my $page= $pars->{page};
532 my $show_next = 0;
533 my $total_pages = 0;
534 my @encoding;
535 my @results;
536 my @serverhost;
537 my @breeding_loop = ();
538 my @oConnection;
539 my @oResult;
540 my @errconn;
541 my @servers;
542 my $s = 0;
543 my $query;
544 my $nterms=0;
546 my $marcflavour = C4::Context->preference('marcflavour');
547 my $marc_type = $marcflavour eq 'UNIMARC' ? 'UNIMARCAUTH' : $marcflavour;
548 my $authid= $pars->{authid};
549 my ( $zquery, $squery ) = _auth_build_query( $pars );
550 foreach my $servid (@id) {
551 my $sth = $dbh->prepare("select * from z3950servers where id=?");
552 $sth->execute($servid);
553 while ( my $server = $sth->fetchrow_hashref ) {
554 $oConnection[$s] = _create_connection( $server );
556 $oResult[$s] =
557 $server->{servertype} eq 'zed'?
558 $oConnection[$s]->search_pqf( $zquery ):
559 $oConnection[$s]->search(new ZOOM::Query::CQL(
560 _translate_query( $server, $squery )));
561 $encoding[$s] = $server->{encoding} // "iso-5426";
562 $servers[$s] = $server;
563 $s++;
564 } ## while fetch
565 } # foreach
566 my $nremaining = $s;
568 while ( $nremaining-- ) {
569 my $k;
570 my $event;
571 while ( ( $k = ZOOM::event( \@oConnection ) ) != 0 ) {
572 $event = $oConnection[ $k - 1 ]->last_event();
573 last if $event == ZOOM::Event::ZEND;
576 if ( $k != 0 ) {
577 $k--;
578 my ($error )= $oConnection[$k]->error_x(); #ignores errmsg, addinfo, diagset
579 if ($error) {
580 if ($error =~ m/^(10000|10007)$/ ) {
581 push(@errconn, {'server' => $serverhost[$k]});
584 else {
585 my $numresults = $oResult[$k]->size();
586 my $i;
587 my $result = '';
588 if ( $numresults > 0 and $numresults >= (($page-1)*20)) {
589 $show_next = 1 if $numresults >= ($page*20);
590 $total_pages = int($numresults/20)+1 if $total_pages < ($numresults/20);
591 for ($i = ($page-1)*20; $i < (($numresults < ($page*20)) ? $numresults : ($page*20)); $i++) {
592 my $rec = $oResult[$k]->record($i);
593 if ($rec) {
594 my $marcrecord;
595 my $marcdata;
596 $marcdata = $rec->raw();
598 my ($charset_result, $charset_errors);
599 if( $servers[$k]->{servertype} eq 'sru' ) {
600 $marcrecord = MARC::Record->new_from_xml( $marcdata, 'UTF-8', $servers[$k]->{syntax} );
601 } else {
602 ( $marcrecord, $charset_result, $charset_errors ) = MarcToUTF8Record( $marcdata, $marc_type, $encoding[$k] );
604 my $heading;
605 my $heading_authtype_code;
606 $heading_authtype_code = GuessAuthTypeCode($marcrecord);
607 $heading = C4::AuthoritiesMarc::GetAuthorizedHeading({ record => $marcrecord });
609 my $breedingid = ImportBreedingAuth( $marcrecord, $serverhost[$k], $encoding[$k], $heading );
610 my %row_data;
611 $row_data{server} = $servers[$k]->{'servername'};
612 $row_data{breedingid} = $breedingid;
613 $row_data{heading} = $heading;
614 $row_data{authid} = $authid;
615 $row_data{heading_code} = $heading_authtype_code;
616 push( @breeding_loop, \%row_data );
618 else {
619 push(@breeding_loop,{'server'=>$servers[$k]->{'servername'},'title'=>join(': ',$oConnection[$k]->error_x()),'breedingid'=>-1,'authid'=>-1});
622 } #if $numresults
624 } # if $k !=0
626 $template->param(
627 numberpending => $nremaining,
628 current_page => $page,
629 total_pages => $total_pages,
630 show_nextbutton => $show_next?1:0,
631 show_prevbutton => $page!=1,
633 } # while nremaining
635 #close result sets and connections
636 foreach(0..$s-1) {
637 $oResult[$_]->destroy();
638 $oConnection[$_]->destroy();
641 @servers = ();
642 foreach my $id (@id) {
643 push @servers, {id => $id};
645 $template->param(
646 breeding_loop => \@breeding_loop,
647 servers => \@servers,
648 errconn => \@errconn
653 __END__