3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
19 #use warnings; FIXME - Bug 2505
22 use C4::Biblio; # GetMarcFromKohaField, GetBiblioData
23 use C4::Koha; # getFacets
27 use C4::Search::PazPar2;
29 use C4::Members qw(GetHideLostItemsPreference);
31 use C4::Reserves; # GetReserveStatus
34 use Koha::AuthorisedValues;
41 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
44 $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
49 C4::Search - Functions for searching the Koha catalog.
53 See opac/opac-search.pl or catalogue/search.pl for example of usage
57 This module provides searching functions for Koha's bibliographic databases
71 &enabled_staff_search_views
74 # make all your functions, whether exported or not;
78 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
80 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
86 my $dbh = C4::Context->dbh;
87 my $result = TransformMarcToKoha( $record, '' );
92 my ( $biblionumber, $title );
94 # search duplicate on ISBN, easy and fast..
96 if ( $result->{isbn} ) {
97 $result->{isbn} =~ s/\(.*$//;
98 $result->{isbn} =~ s/\s+$//;
99 $query = "isbn:$result->{isbn}";
103 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser'));
109 $titleindex = 'title|exact';
110 $authorindex = 'author|exact';
112 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
114 $titleindex = 'ti,ext';
115 $authorindex = 'au,ext';
119 $result->{title} =~ s /\\//g;
120 $result->{title} =~ s /\"//g;
121 $result->{title} =~ s /\(//g;
122 $result->{title} =~ s /\)//g;
124 # FIXME: instead of removing operators, could just do
125 # quotes around the value
126 $result->{title} =~ s/(and|or|not)//g;
127 $query = "$titleindex:\"$result->{title}\"";
128 if ( $result->{author} ) {
129 $result->{author} =~ s /\\//g;
130 $result->{author} =~ s /\"//g;
131 $result->{author} =~ s /\(//g;
132 $result->{author} =~ s /\)//g;
134 # remove valid operators
135 $result->{author} =~ s/(and|or|not)//g;
136 $query .= " $op $authorindex:\"$result->{author}\"";
140 my ( $error, $searchresults, undef ) = SimpleSearch($query); # FIXME :: hardcoded !
142 if (!defined $error) {
143 foreach my $possible_duplicate_record (@{$searchresults}) {
144 my $marcrecord = new_record_from_zebra(
146 $possible_duplicate_record
149 my $result = TransformMarcToKoha( $marcrecord, '' );
151 # FIXME :: why 2 $biblionumber ?
153 push @results, $result->{'biblionumber'};
154 push @results, $result->{'title'};
163 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers] );
165 This function provides a simple search API on the bibliographic catalog
171 * $query can be a simple keyword or a complete CCL query
172 * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
173 * $offset - If present, represents the number of records at the beginning to omit. Defaults to 0
174 * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
179 Returns an array consisting of three elements
180 * $error is undefined unless an error is detected
181 * $results is a reference to an array of records.
182 * $total_hits is the number of hits that would have been returned with no limit
184 If an error is returned the two other return elements are undefined. If error itself is undefined
185 the other two elements are always defined
187 =item C<usage in the script:>
191 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
193 if (defined $error) {
194 $template->param(query_error => $error);
195 warn "error: ".$error;
196 output_html_with_http_headers $input, $cookie, $template->output;
200 my $hits = @{$marcresults};
203 for my $r ( @{$marcresults} ) {
204 my $marcrecord = MARC::File::USMARC::decode($r);
205 my $biblio = TransformMarcToKoha($marcrecord,q{});
207 #build the iarray of hashs for the template.
209 title => $biblio->{'title'},
210 subtitle => $biblio->{'subtitle'},
211 biblionumber => $biblio->{'biblionumber'},
212 author => $biblio->{'author'},
213 publishercode => $biblio->{'publishercode'},
214 publicationyear => $biblio->{'publicationyear'},
219 $template->param(result=>\@results);
224 my ( $query, $offset, $max_results, $servers ) = @_;
226 return ( 'No query entered', undef, undef ) unless $query;
227 # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
228 my @servers = defined ( $servers ) ? @$servers : ( 'biblioserver' );
236 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') && ! ($query =~ m/\w,\w|\w=\w/));
238 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
241 # Initialize & Search Zebra
242 for ( my $i = 0 ; $i < @servers ; $i++ ) {
244 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
247 $QParser->parse( $query );
248 $query = $QParser->target_syntax($servers[$i]);
249 $zoom_queries[$i] = new ZOOM::Query::PQF( $query, $zconns[$i]);
252 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
254 $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
258 $zconns[$i]->errmsg() . " ("
259 . $zconns[$i]->errcode() . ") "
260 . $zconns[$i]->addinfo() . " "
261 . $zconns[$i]->diagset();
263 return ( $error, undef, undef ) if $zconns[$i]->errcode();
267 # caught a ZOOM::Exception
271 . $@->addinfo() . " "
273 warn $error." for query: $query";
274 return ( $error, undef, undef );
283 my $first_record = defined($offset) ? $offset + 1 : 1;
284 my $hits = $tmpresults[ $i - 1 ]->size();
285 $total_hits += $hits;
286 my $last_record = $hits;
287 if ( defined $max_results && $offset + $max_results < $hits ) {
288 $last_record = $offset + $max_results;
291 for my $j ( $first_record .. $last_record ) {
293 $tmpresults[ $i - 1 ]->record( $j - 1 )->raw()
296 push @{$results}, $record if defined $record;
301 foreach my $zoom_query (@zoom_queries) {
302 $zoom_query->destroy();
305 return ( undef, $results, $total_hits );
310 ( undef, $results_hashref, \@facets_loop ) = getRecords (
312 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
313 $results_per_page, $offset, $expanded_facet, $branches,$itemtypes,
317 The all singing, all dancing, multi-server, asynchronous, scanning,
318 searching, record nabbing, facet-building
320 See verbse embedded documentation.
326 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
327 $results_per_page, $offset, $expanded_facet, $branches,
328 $itemtypes, $query_type, $scan, $opac
331 my @servers = @$servers_ref;
332 my @sort_by = @$sort_by_ref;
334 # Initialize variables for the ZOOM connection and results object
338 my $results_hashref = ();
340 # TODO simplify this structure ( { branchcode => $branchname } is enought) and remove this parameter
341 $branches ||= { map { $_->branchcode => { branchname => $_->branchname } } Koha::Libraries->search };
343 # Initialize variables for the faceted results objects
344 my $facets_counter = {};
345 my $facets_info = {};
346 my $facets = getFacets();
348 my @facets_loop; # stores the ref to array of hashes for template facets loop
350 ### LOOP THROUGH THE SERVERS
351 for ( my $i = 0 ; $i < @servers ; $i++ ) {
352 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
354 # perform the search, create the results objects
355 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
356 my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
358 #$query_to_use = $simple_query if $scan;
359 warn $simple_query if ( $scan and $DEBUG );
361 # Check if we've got a query_type defined, if so, use it
364 if ($query_type =~ /^ccl/) {
365 $query_to_use =~ s/\:/\=/g; # change : to = last minute (FIXME)
366 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
367 } elsif ($query_type =~ /^cql/) {
368 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
369 } elsif ($query_type =~ /^pqf/) {
370 $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
372 warn "Unknown query_type '$query_type'. Results undetermined.";
375 $results[$i] = $zconns[$i]->scan( new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
377 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
381 warn "WARNING: query problem with $query_to_use " . $@;
384 # Concatenate the sort_by limits and pass them to the results object
385 # Note: sort will override rank
387 foreach my $sort (@sort_by) {
388 if ( $sort eq "author_az" || $sort eq "author_asc" ) {
389 $sort_by .= "1=1003 <i ";
391 elsif ( $sort eq "author_za" || $sort eq "author_dsc" ) {
392 $sort_by .= "1=1003 >i ";
394 elsif ( $sort eq "popularity_asc" ) {
395 $sort_by .= "1=9003 <i ";
397 elsif ( $sort eq "popularity_dsc" ) {
398 $sort_by .= "1=9003 >i ";
400 elsif ( $sort eq "call_number_asc" ) {
401 $sort_by .= "1=8007 <i ";
403 elsif ( $sort eq "call_number_dsc" ) {
404 $sort_by .= "1=8007 >i ";
406 elsif ( $sort eq "pubdate_asc" ) {
407 $sort_by .= "1=31 <i ";
409 elsif ( $sort eq "pubdate_dsc" ) {
410 $sort_by .= "1=31 >i ";
412 elsif ( $sort eq "acqdate_asc" ) {
413 $sort_by .= "1=32 <i ";
415 elsif ( $sort eq "acqdate_dsc" ) {
416 $sort_by .= "1=32 >i ";
418 elsif ( $sort eq "title_az" || $sort eq "title_asc" ) {
419 $sort_by .= "1=4 <i ";
421 elsif ( $sort eq "title_za" || $sort eq "title_dsc" ) {
422 $sort_by .= "1=4 >i ";
425 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
428 if ( $sort_by && !$scan && $results[$i] ) {
429 if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
430 warn "WARNING sort $sort_by failed";
433 } # finished looping through servers
435 # The big moment: asynchronously retrieve results from all servers
440 my ( $i, $size ) = @_;
443 # loop through the results
444 $results_hash->{'hits'} = $size;
446 if ( $offset + $results_per_page <= $size ) {
447 $times = $offset + $results_per_page;
453 for ( my $j = $offset ; $j < $times ; $j++ ) {
457 ## Check if it's an index scan
459 my ( $term, $occ ) = $results[ $i - 1 ]->display_term($j);
461 # here we create a minimal MARC record and hand it off to the
462 # template just like a normal result ... perhaps not ideal, but
464 my $tmprecord = MARC::Record->new();
465 $tmprecord->encoding('UTF-8');
469 # the minimal record in author/title (depending on MARC flavour)
470 if ( C4::Context->preference("marcflavour") eq
473 $tmptitle = MARC::Field->new(
478 $tmprecord->append_fields($tmptitle);
482 MARC::Field->new( '245', ' ', ' ', a => $term, );
484 MARC::Field->new( '100', ' ', ' ', a => $occ, );
485 $tmprecord->append_fields($tmptitle);
486 $tmprecord->append_fields($tmpauthor);
488 $results_hash->{'RECORDS'}[$j] =
489 $tmprecord->as_usmarc();
494 $record = $results[ $i - 1 ]->record($j)->raw();
495 # warn "RECORD $j:".$record;
496 $results_hash->{'RECORDS'}[$j] = $record;
500 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
502 # Fill the facets while we're looping, but only for the
503 # biblioserver and not for a scan
504 if ( !$scan && $servers[ $i - 1 ] =~ /biblioserver/ ) {
505 $facets_counter = GetFacets( $results[ $i - 1 ] );
506 $facets_info = _get_facets_info( $facets );
510 if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
512 sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
513 keys %$facets_counter
517 my $number_of_facets;
518 my @this_facets_array;
521 $facets_counter->{$link_value}
522 ->{$b} <=> $facets_counter->{$link_value}
524 } keys %{ $facets_counter->{$link_value} }
528 if ( ( $number_of_facets <= 5 )
529 || ( $expanded_facet eq $link_value )
530 || ( $facets_info->{$link_value}->{'expanded'} )
534 # Sanitize the link value : parenthesis, question and exclamation mark will cause errors with CCL
535 my $facet_link_value = $one_facet;
536 $facet_link_value =~ s/[()!?¡¿؟]/ /g;
538 # fix the length that will display in the label,
539 my $facet_label_value = $one_facet;
540 my $facet_max_length = C4::Context->preference(
541 'FacetLabelTruncationLength')
544 substr( $one_facet, 0, $facet_max_length )
546 if length($facet_label_value) >
549 # if it's a branch, label by the name, not the code,
550 if ( $link_value =~ /branch/ ) {
551 if ( defined $branches
552 && ref($branches) eq "HASH"
553 && defined $branches->{$one_facet}
554 && ref( $branches->{$one_facet} ) eq
558 $branches->{$one_facet}
562 $facet_label_value = "*";
566 # if it's a itemtype, label by the name, not the code,
567 if ( $link_value =~ /itype/ ) {
568 if ( defined $itemtypes
569 && ref($itemtypes) eq "HASH"
570 && defined $itemtypes->{$one_facet}
571 && ref( $itemtypes->{$one_facet} ) eq
575 $itemtypes->{$one_facet}
576 ->{translated_description};
580 # also, if it's a location code, use the name instead of the code
581 if ( $link_value =~ /location/ ) {
582 # TODO Retrieve all authorised values at once, instead of 1 query per entry
583 my $av = Koha::AuthorisedValues->search({ category => 'LOC', authorised_value => $one_facet });
584 $facet_label_value = $av->count ? $av->next->opac_description : '';
587 # but we're down with the whole label being in the link's title.
588 push @this_facets_array,
591 $facets_counter->{$link_value}
593 facet_label_value => $facet_label_value,
594 facet_title_value => $one_facet,
595 facet_link_value => $facet_link_value,
596 type_link_value => $link_value,
598 if ($facet_label_value);
602 # handle expanded option
603 unless ( $facets_info->{$link_value}->{'expanded'} ) {
605 if ( ( $number_of_facets > 5 )
606 && ( $expanded_facet ne $link_value ) );
610 type_link_value => $link_value,
611 type_id => $link_value . "_id",
613 . $facets_info->{$link_value}->{'label_value'} =>
615 facets => \@this_facets_array,
616 expandable => $expandable,
617 expand => $link_value,
621 $facets_info->{$link_value}->{'label_value'} =~
624 and ( Koha::Libraries->search->count == 1 )
631 # This sorts the facets into alphabetical order
633 foreach my $f (@facets_loop) {
634 $f->{facets} = [ sort { uc($a->{facet_label_value}) cmp uc($b->{facet_label_value}) } @{ $f->{facets} } ];
636 @facets_loop = sort {$a->{expand} cmp $b->{expand}} @facets_loop;
639 return ( undef, $results_hashref, \@facets_loop );
647 my $indexing_mode = C4::Context->config('zebra_bib_index_mode') // 'dom';
648 my $use_zebra_facets = C4::Context->config('use_zebra_facets') // 0;
650 if ( $indexing_mode eq 'dom' &&
651 $use_zebra_facets ) {
652 $facets = _get_facets_from_zebra( $rs );
654 $facets = _get_facets_from_records( $rs );
660 sub _get_facets_from_records {
664 my $facets_maxrecs = C4::Context->preference('maxRecordsForFacets') // 20;
665 my $facets_config = getFacets();
667 my $size = $rs->size();
668 my $jmax = $size > $facets_maxrecs
672 for ( my $j = 0 ; $j < $jmax ; $j++ ) {
674 my $marc_record = new_record_from_zebra (
676 $rs->record( $j )->raw()
679 if ( ! defined $marc_record ) {
680 warn "ERROR DECODING RECORD - $@: " .
681 $rs->record( $j )->raw();
685 _get_facets_data_from_record( $marc_record, $facets_config, $facets );
691 =head2 _get_facets_data_from_record
693 C4::Search::_get_facets_data_from_record( $marc_record, $facets, $facets_counter );
695 Internal function that extracts facets information from a MARC::Record object
696 and populates $facets_counter for using in getRecords.
698 $facets is expected to be filled with C4::Koha::getFacets output (i.e. the configured
703 sub _get_facets_data_from_record {
705 my ( $marc_record, $facets, $facets_counter ) = @_;
707 for my $facet (@$facets) {
711 foreach my $tag ( @{ $facet->{ tags } } ) {
713 # tag number is the first three digits
714 my $tag_num = substr( $tag, 0, 3 );
715 # subfields are the remainder
716 my $subfield_letters = substr( $tag, 3 );
718 my @fields = $marc_record->field( $tag_num );
719 foreach my $field (@fields) {
720 # If $field->indicator(1) eq 'z', it means it is a 'see from'
721 # field introduced because of IncludeSeeFromInSearches, so skip it
722 next if $field->indicator(1) eq 'z';
724 my $data = $field->as_string( $subfield_letters, $facet->{ sep } );
726 unless ( grep { /^\Q$data\E$/ } @used_datas ) {
727 push @used_datas, $data;
728 $facets_counter->{ $facet->{ idx } }->{ $data }++;
735 =head2 _get_facets_from_zebra
737 my $facets = _get_facets_from_zebra( $result_set )
739 Retrieves facets for a specified result set. It loops through the facets defined
740 in C4::Koha::getFacets and returns a hash with the following structure:
750 sub _get_facets_from_zebra {
754 # save current elementSetName
755 my $elementSetName = $rs->option( 'elementSetName' );
757 my $facets_loop = getFacets();
758 my $facets_data = {};
759 # loop through defined facets and fill the facets hashref
760 foreach my $facet ( @$facets_loop ) {
762 my $idx = $facet->{ idx };
763 my $sep = $facet->{ sep };
764 my $facet_values = _get_facet_from_result_set( $idx, $rs, $sep );
765 if ( $facet_values ) {
766 # we've actually got a result
767 $facets_data->{ $idx } = $facet_values;
770 # set elementSetName to its previous value to avoid side effects
771 $rs->option( elementSetName => $elementSetName );
776 =head2 _get_facet_from_result_set
779 C4::Search::_get_facet_from_result_set( $facet_idx, $result_set, $sep )
781 Internal function that extracts facet information for a specific index ($facet_idx) and
782 returns a hash containing facet values and count:
785 $facet_value => $count ,
789 Warning: this function has the side effect of changing the elementSetName for the result
790 set. It is a helper function for the main loop, which takes care of backing it up for
795 sub _get_facet_from_result_set {
797 my $facet_idx = shift;
801 my $internal_sep = '<*>';
802 my $facetMaxCount = C4::Context->preference('FacetMaxCount') // 20;
804 return if ( ! defined $facet_idx || ! defined $rs );
805 # zebra's facet element, untokenized index
806 my $facet_element = 'zebra::facet::' . $facet_idx . ':0:' . $facetMaxCount;
807 # configure zebra results for retrieving the desired facet
808 $rs->option( elementSetName => $facet_element );
809 # get the facet record from result set
810 my $facet = $rs->record( 0 )->raw;
811 # if the facet has no restuls...
812 return if !defined $facet;
813 # TODO: benchmark DOM vs. SAX performance
814 my $facet_dom = XML::LibXML->load_xml(
817 my @terms = $facet_dom->getElementsByTagName('term');
821 foreach my $term ( @terms ) {
822 my $facet_value = $term->textContent;
823 $facet_value =~ s/\Q$internal_sep\E/$sep/ if defined $sep;
824 $facets->{ $facet_value } = $term->getAttribute( 'occur' );
830 =head2 _get_facets_info
832 my $facets_info = C4::Search::_get_facets_info( $facets )
834 Internal function that extracts facets information and properly builds
835 the data structure needed to render facet labels.
839 sub _get_facets_info {
843 my $facets_info = {};
845 for my $facet ( @$facets ) {
846 $facets_info->{ $facet->{ idx } }->{ label_value } = $facet->{ label };
847 $facets_info->{ $facet->{ idx } }->{ expanded } = $facet->{ expanded };
855 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
856 $results_per_page, $offset, $expanded_facet, $branches,
859 #NOTE: Parameter $branches is not used here !
861 my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
863 $paz->search($simple_query);
864 sleep 1; # FIXME: WHY?
867 my $results_hashref = {};
868 my $stats = XMLin($paz->stat);
869 my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
871 # for a grouped search result, the number of hits
872 # is the number of groups returned; 'bib_hits' will have
873 # the total number of bibs.
874 $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
875 $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
877 HIT: foreach my $hit (@{ $results->{'hit'} }) {
878 my $recid = $hit->{recid}->[0];
880 my $work_title = $hit->{'md-work-title'}->[0];
882 if (exists $hit->{'md-work-author'}) {
883 $work_author = $hit->{'md-work-author'}->[0];
885 my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
887 my $result_group = {};
888 $result_group->{'group_label'} = $group_label;
889 $result_group->{'group_merge_key'} = $recid;
892 if (exists $hit->{count}) {
893 $count = $hit->{count}->[0];
895 $result_group->{'group_count'} = $count;
897 for (my $i = 0; $i < $count; $i++) {
898 # FIXME -- may need to worry about diacritics here
899 my $rec = $paz->record($recid, $i);
900 push @{ $result_group->{'RECORDS'} }, $rec;
903 push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
906 # pass through facets
907 my $termlist_xml = $paz->termlist('author,subject');
908 my $terms = XMLin($termlist_xml, forcearray => 1);
909 my @facets_loop = ();
910 #die Dumper($results);
911 # foreach my $list (sort keys %{ $terms->{'list'} }) {
913 # foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
915 # facet_label_value => $facet->{'name'}->[0],
918 # push @facets_loop, ( {
919 # type_label => $list,
920 # facets => \@facets,
924 return ( undef, $results_hashref, \@facets_loop );
928 sub _detect_truncation {
929 my ( $operand, $index ) = @_;
930 my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
933 my @wordlist = split( /\s/, $operand );
934 foreach my $word (@wordlist) {
935 if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
936 push @rightlefttruncated, $word;
938 elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
939 push @lefttruncated, $word;
941 elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
942 push @righttruncated, $word;
944 elsif ( index( $word, "*" ) < 0 ) {
945 push @nontruncated, $word;
948 push @regexpr, $word;
952 \@nontruncated, \@righttruncated, \@lefttruncated,
953 \@rightlefttruncated, \@regexpr
958 sub _build_stemmed_operand {
959 my ($operand,$lang) = @_;
960 require Lingua::Stem::Snowball ;
961 my $stemmed_operand=q{};
963 # If operand contains a digit, it is almost certainly an identifier, and should
964 # not be stemmed. This is particularly relevant for ISBNs and ISSNs, which
965 # can contain the letter "X" - for example, _build_stemmend_operand would reduce
966 # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
967 # results (e.g., "23 x 29 cm." from the 300$c). Bug 2098.
968 return $operand if $operand =~ /\d/;
970 # FIXME: the locale should be set based on the user's language and/or search choice
972 # Make sure we only use the first two letters from the language code
973 $lang = lc(substr($lang, 0, 2));
974 # The language codes for the two variants of Norwegian will now be "nb" and "nn",
975 # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
976 if ($lang eq 'nb' || $lang eq 'nn') {
979 my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
980 encoding => "UTF-8" );
982 my @words = split( / /, $operand );
983 my @stems = $stemmer->stem(\@words);
984 for my $stem (@stems) {
985 $stemmed_operand .= "$stem";
986 $stemmed_operand .= "?"
987 unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
988 $stemmed_operand .= " ";
990 warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
991 return $stemmed_operand;
995 sub _build_weighted_query {
997 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
998 # pretty well but could work much better if we had a smarter query parser
999 my ( $operand, $stemmed_operand, $index ) = @_;
1000 my $stemming = C4::Context->preference("QueryStemming") || 0;
1001 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1002 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1003 $operand =~ s/"/ /g; # Bug 7518: searches with quotation marks don't work
1005 my $weighted_query .= "(rk=("; # Specifies that we're applying rank
1007 # Keyword, or, no index specified
1008 if ( ( $index eq 'kw' ) || ( !$index ) ) {
1010 "Title-cover,ext,r1=\"$operand\""; # exact title-cover
1011 $weighted_query .= " or ti,ext,r2=\"$operand\""; # exact title
1012 $weighted_query .= " or Title-cover,phr,r3=\"$operand\""; # phrase title
1013 $weighted_query .= " or ti,wrdl,r4=\"$operand\""; # words in title
1014 #$weighted_query .= " or any,ext,r4=$operand"; # exact any
1015 #$weighted_query .=" or kw,wrdl,r5=\"$operand\""; # word list any
1016 $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
1017 if $fuzzy_enabled; # add fuzzy, word list
1018 $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
1019 if ( $stemming and $stemmed_operand )
1020 ; # add stemming, right truncation
1021 $weighted_query .= " or wrdl,r9=\"$operand\"";
1023 # embedded sorting: 0 a-z; 1 z-a
1024 # $weighted_query .= ") or (sort1,aut=1";
1027 # Barcode searches should skip this process
1028 elsif ( $index eq 'bc' ) {
1029 $weighted_query .= "bc=\"$operand\"";
1032 # Authority-number searches should skip this process
1033 elsif ( $index eq 'an' ) {
1034 $weighted_query .= "an=\"$operand\"";
1037 # If the index is numeric, don't autoquote it.
1038 elsif ( $index =~ /,st-numeric$/ ) {
1039 $weighted_query .= " $index=$operand";
1042 # If the index already has more than one qualifier, wrap the operand
1043 # in quotes and pass it back (assumption is that the user knows what they
1044 # are doing and won't appreciate us mucking up their query
1045 elsif ( $index =~ ',' ) {
1046 $weighted_query .= " $index=\"$operand\"";
1049 #TODO: build better cases based on specific search indexes
1051 $weighted_query .= " $index,ext,r1=\"$operand\""; # exact index
1052 #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
1053 $weighted_query .= " or $index,phr,r3=\"$operand\""; # phrase index
1054 $weighted_query .= " or $index,wrdl,r6=\"$operand\""; # word list index
1055 $weighted_query .= " or $index,wrdl,fuzzy,r8=\"$operand\""
1056 if $fuzzy_enabled; # add fuzzy, word list
1057 $weighted_query .= " or $index,wrdl,rt,r9=\"$stemmed_operand\""
1058 if ( $stemming and $stemmed_operand ); # add stemming, right truncation
1061 $weighted_query .= "))"; # close rank specification
1062 return $weighted_query;
1067 Return an array with available indexes.
1089 'Author-personal-bibliography',
1099 'Chronological-subdivision',
1109 'Conference-name-heading',
1110 'Conference-name-see',
1111 'Conference-name-seealso',
1116 'Corporate-name-heading',
1117 'Corporate-name-see',
1118 'Corporate-name-seealso',
1119 'Country-publication',
1122 'date-entered-on-file',
1123 'Date-of-acquisition',
1124 'Date-of-publication',
1125 'Date-time-last-modified',
1126 'Dewey-classification',
1127 'Dissertation-information',
1136 'Geographic-subdivision',
1139 'Heading-use-main-or-added-entry',
1140 'Heading-use-series-added-entry ',
1141 'Heading-use-subject-added-entry',
1145 'Identifier-standard',
1146 'Illustration-code',
1148 'Index-term-uncontrolled',
1149 'Interest-age-level',
1150 'Interest-grade-level',
1160 'language-original',
1170 'Local-classification',
1173 'Match-heading-see-from',
1181 'Name-geographic-heading',
1182 'Name-geographic-see',
1183 'Name-geographic-seealso',
1189 'Other-control-number',
1192 'Personal-name-heading',
1193 'Personal-name-see',
1194 'Personal-name-seealso',
1196 'Place-publication',
1203 'Reading-grade-level',
1204 'Record-control-number',
1215 'Subject-heading-thesaurus',
1216 'Subject-name-personal',
1217 'Subject-subdivision',
1226 'Term-genre-form-heading',
1227 'Term-genre-form-see',
1228 'Term-genre-form-seealso',
1234 'Title-uniform-heading',
1235 'Title-uniform-see',
1236 'Title-uniform-seealso',
1246 'classification-source',
1248 'coded-location-qualifier',
1259 'Local-classification',
1262 'materials-specified',
1267 'Number-local-acquisition',
1272 'replacementpricedate',
1287 =head2 _handle_exploding_index
1289 my $query = _handle_exploding_index($index, $term)
1291 Callback routine to generate the search for "exploding" indexes (i.e.
1292 those indexes which are turned into multiple or-connected searches based
1297 sub _handle_exploding_index {
1298 my ($QParser, $filter, $params, $negate, $server) = @_;
1299 my $index = $filter;
1300 my $term = join(' ', @$params);
1302 return unless ($index =~ m/(su-br|su-na|su-rl)/ && $term);
1304 my $marcflavour = C4::Context->preference('marcflavour');
1306 my $codesubfield = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1307 my $wantedcodes = '';
1308 my @subqueries = ( "\@attr 1=Subject \@attr 4=1 \"$term\"");
1309 my ($error, $results, $total_hits) = SimpleSearch( "he:$term", undef, undef, [ "authorityserver" ] );
1310 foreach my $auth (@$results) {
1311 my $record = MARC::Record->new_from_usmarc($auth);
1312 my @references = $record->field('5..');
1314 if ($index eq 'su-br') {
1316 } elsif ($index eq 'su-na') {
1318 } elsif ($index eq 'su-rl') {
1321 foreach my $reference (@references) {
1322 my $codes = $reference->subfield($codesubfield);
1323 push @subqueries, '@attr 1=Subject @attr 4=1 "' . $reference->as_string('abcdefghijlmnopqrstuvxyz') . '"' if (($codes && $codes eq $wantedcodes) || !$wantedcodes);
1327 my $query = ' @or ' x (scalar(@subqueries) - 1) . join(' ', @subqueries);
1333 ( $operators, $operands, $indexes, $limits,
1334 $sort_by, $scan, $lang ) =
1335 buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1337 Shim function to ease the transition from buildQuery to a new QueryParser.
1338 This function is called at the beginning of buildQuery, and modifies
1339 buildQuery's input. If it can handle the input, it returns a query that
1340 buildQuery will not try to parse.
1345 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1347 my @operators = $operators ? @$operators : ();
1348 my @indexes = $indexes ? @$indexes : ();
1349 my @operands = $operands ? @$operands : ();
1350 my @limits = $limits ? @$limits : ();
1351 my @sort_by = $sort_by ? @$sort_by : ();
1353 my $query = $operands[0];
1359 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') || $query =~ s/^qp=//);
1360 undef $QParser if ($query =~ m/^(ccl=|pqf=|cql=)/ || grep (/\w,\w|\w=\w/, @operands, @indexes) );
1361 undef $QParser if (scalar @limits > 0);
1365 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
1367 for ( my $ii = 0 ; $ii <= @operands ; $ii++ ) {
1368 next unless $operands[$ii];
1369 $query .= $operators[ $ii - 1 ] eq 'or' ? ' || ' : ' && '
1371 if ( $operands[$ii] =~ /^[^"]\W*[-|_\w]*:\w.*[^"]$/ ) {
1372 $query .= $operands[$ii];
1374 elsif ( $indexes[$ii] =~ m/su-/ ) {
1375 $query .= $indexes[$ii] . '(' . $operands[$ii] . ')';
1379 ( $indexes[$ii] ? "$indexes[$ii]:" : '' ) . $operands[$ii];
1382 foreach my $limit (@limits) {
1384 if ( scalar(@sort_by) > 0 ) {
1386 '#(' . join( '|', @{ $QParser->modifiers } ) . ')';
1387 $query =~ s/$modifier_re//g;
1388 foreach my $modifier (@sort_by) {
1389 $query .= " #$modifier";
1393 $query_desc = $query;
1394 $query_desc =~ s/\s+/ /g;
1395 if ( C4::Context->preference("QueryWeightFields") ) {
1397 $QParser->add_bib1_filter_map( 'su-br' => 'biblioserver' =>
1398 { 'target_syntax_callback' => \&_handle_exploding_index } );
1399 $QParser->add_bib1_filter_map( 'su-na' => 'biblioserver' =>
1400 { 'target_syntax_callback' => \&_handle_exploding_index } );
1401 $QParser->add_bib1_filter_map( 'su-rl' => 'biblioserver' =>
1402 { 'target_syntax_callback' => \&_handle_exploding_index } );
1403 $QParser->parse($query);
1404 $operands[0] = "pqf=" . $QParser->target_syntax('biblioserver');
1407 require Koha::QueryParser::Driver::PQF;
1408 my $modifier_re = '#(' . join( '|', @{Koha::QueryParser::Driver::PQF->modifiers}) . ')';
1409 s/$modifier_re//g for @operands;
1412 return ( $operators, \@operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc);
1418 $simple_query, $query_cgi,
1419 $query_desc, $limit,
1420 $limit_cgi, $limit_desc,
1421 $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1423 Build queries and limits in CCL, CGI, Human,
1424 handle truncation, stemming, field weighting, fuzziness, etc.
1426 See verbose embedded documentation.
1432 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1434 warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1437 ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc) = parseQuery($operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1440 my @operators = $operators ? @$operators : ();
1441 my @indexes = $indexes ? @$indexes : ();
1442 my @operands = $operands ? @$operands : ();
1443 my @limits = $limits ? @$limits : ();
1444 my @sort_by = $sort_by ? @$sort_by : ();
1446 my $stemming = C4::Context->preference("QueryStemming") || 0;
1447 my $auto_truncation = C4::Context->preference("QueryAutoTruncate") || 0;
1448 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1449 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1451 my $query = $operands[0];
1452 my $simple_query = $operands[0];
1454 # initialize the variables we're passing back
1463 my $cclindexes = getIndexes();
1464 if ( $query !~ /\s*(ccl=|pqf=|cql=)/ ) {
1465 while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1467 $cclq = grep { lc($_) eq $dx } @$cclindexes;
1469 $query = "ccl=$query" if $cclq;
1472 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1474 if ( $query =~ /^ccl=/ ) {
1476 # This is needed otherwise ccl= and &limit won't work together, and
1477 # this happens when selecting a subject on the opac-detail page
1478 @limits = grep {!/^$/} @limits;
1479 my $original_q = $q; # without available part
1481 if ( grep { /^available$/ } @limits ) {
1482 $q .= q| and ( ( allrecords,AlwaysMatches:'' not onloan,AlwaysMatches:'') and (lost,st-numeric=0) )|;
1483 delete $limits['available'];
1485 $q .= ' and '.join(' and ', @limits) if @limits;
1487 return ( undef, $q, $q, "q=ccl=".uri_escape_utf8($q), $original_q, '', '', '', 'ccl' );
1489 if ( $query =~ /^cql=/ ) {
1490 return ( undef, $', $', "q=cql=".uri_escape_utf8($'), $', '', '', '', 'cql' );
1492 if ( $query =~ /^pqf=/ ) {
1494 $query_cgi = "q=".uri_escape_utf8($query_desc);
1497 $query_cgi = "q=pqf=".uri_escape_utf8($');
1499 return ( undef, $', $', $query_cgi, $query_desc, '', '', '', 'pqf' );
1502 # pass nested queries directly
1503 # FIXME: need better handling of some of these variables in this case
1504 # Nested queries aren't handled well and this implementation is flawed and causes users to be
1505 # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1506 # if ( $query =~ /(\(|\))/ ) {
1508 # undef, $query, $simple_query, $query_cgi,
1509 # $query, $limit, $limit_cgi, $limit_desc,
1514 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1515 # query operands and indexes and add stemming, truncation, field weighting, etc.
1516 # Once we do so, we'll end up with a value in $query, just like if we had an
1517 # incoming $query from the user
1520 ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1521 my $previous_operand
1522 ; # a flag used to keep track if there was a previous query
1523 # if there was, we can apply the current operator
1525 for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1527 # COMBINE OPERANDS, INDEXES AND OPERATORS
1528 if ( $operands[$i] ) {
1529 $operands[$i]=~s/^\s+//;
1531 # A flag to determine whether or not to add the index to the query
1534 # If the user is sophisticated enough to specify an index, turn off field weighting, and stemming handling
1535 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1539 $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1541 my $operand = $operands[$i];
1542 my $index = $indexes[$i];
1544 # Add index-specific attributes
1546 #Afaik, this 'yr' condition will only ever be met in the staff client advanced search
1547 #for "Publication date", since typing 'yr:YYYY' into the search box produces a CCL query,
1548 #which is processed higher up in this sub. Other than that, year searches are typically
1549 #handled as limits which are not processed her either.
1551 # Search ranges: Date of Publication, st-numeric
1552 if ( $index =~ /(yr|st-numeric)/ ) {
1553 #weight_fields/relevance search causes errors with date ranges
1554 #In the case of YYYY-, it will only return records with a 'yr' of YYYY (not the range)
1555 #In the case of YYYY-YYYY, it will return no results
1556 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1559 # Date of Acquisition
1560 elsif ( $index =~ /acqdate/ ) {
1561 #stemming and auto_truncation would have zero impact since it already is YYYY-MM-DD format
1562 #Weight_fields probably SHOULD be turned OFF, otherwise you'll get records floating to the
1563 #top of the results just because they have lots of item records matching that date.
1564 #Fuzzy actually only applies during _build_weighted_query, and is reset there anyway, so
1566 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1568 # ISBN,ISSN,Standard Number, don't need special treatment
1569 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1571 $stemming, $auto_truncation,
1572 $weight_fields, $fuzzy_enabled
1575 if ( $index eq 'nb' ) {
1576 if ( C4::Context->preference("SearchWithISBNVariations") ) {
1577 my @isbns = C4::Koha::GetVariationsOfISBN( $operand );
1578 $operands[$i] = $operand = '(nb=' . join(' OR nb=', @isbns) . ')';
1579 $indexes[$i] = $index = '';
1588 # Set default structure attribute (word list)
1589 my $struct_attr = q{};
1590 unless ( $indexes_set || !$index || $index =~ /,(st-|phr|ext|wrdl)/ || $index =~ /^(nb|ns)$/ ) {
1591 $struct_attr = ",wrdl";
1594 # Some helpful index variants
1595 my $index_plus = $index . $struct_attr . ':';
1596 my $index_plus_comma = $index . $struct_attr . ',';
1598 if ($auto_truncation){
1599 unless ( $index =~ /,(st-|phr|ext)/ ) {
1600 #FIXME only valid with LTR scripts
1601 $operand=join(" ",map{
1602 (index($_,"*")>0?"$_":"$_*")
1603 }split (/\s+/,$operand));
1604 warn $operand if $DEBUG;
1609 my $truncated_operand;
1610 my( $nontruncated, $righttruncated, $lefttruncated,
1611 $rightlefttruncated, $regexpr
1612 ) = _detect_truncation( $operand, $index );
1614 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1619 scalar(@$righttruncated) + scalar(@$lefttruncated) +
1620 scalar(@$rightlefttruncated) > 0 )
1623 # Don't field weight or add the index to the query, we do it here
1625 undef $weight_fields;
1626 my $previous_truncation_operand;
1627 if (scalar @$nontruncated) {
1628 $truncated_operand .= "$index_plus @$nontruncated ";
1629 $previous_truncation_operand = 1;
1631 if (scalar @$righttruncated) {
1632 $truncated_operand .= "and " if $previous_truncation_operand;
1633 $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1634 $previous_truncation_operand = 1;
1636 if (scalar @$lefttruncated) {
1637 $truncated_operand .= "and " if $previous_truncation_operand;
1638 $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1639 $previous_truncation_operand = 1;
1641 if (scalar @$rightlefttruncated) {
1642 $truncated_operand .= "and " if $previous_truncation_operand;
1643 $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1644 $previous_truncation_operand = 1;
1647 $operand = $truncated_operand if $truncated_operand;
1648 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1651 my $stemmed_operand;
1652 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1655 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1657 # Handle Field Weighting
1658 my $weighted_operand;
1659 if ($weight_fields) {
1660 $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1661 $operand = $weighted_operand;
1665 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1667 ($query,$query_cgi,$query_desc,$previous_operand) = _build_initial_query({
1669 query_cgi => $query_cgi,
1670 query_desc => $query_desc,
1671 operator => ($operators[ $i - 1 ]) ? $operators[ $i - 1 ] : '',
1672 parsed_operand => $operand,
1673 original_operand => ($operands[$i]) ? $operands[$i] : '',
1675 index_plus => $index_plus,
1676 indexes_set => $indexes_set,
1677 previous_operand => $previous_operand,
1683 warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1686 my %group_OR_limits;
1687 my $availability_limit;
1688 foreach my $this_limit (@limits) {
1689 next unless $this_limit;
1690 if ( $this_limit =~ /available/ ) {
1692 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1694 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1695 $availability_limit .=
1696 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1697 $limit_cgi .= "&limit=available";
1701 # group_OR_limits, prefixed by mc-
1702 # OR every member of the group
1703 elsif ( $this_limit =~ /mc/ ) {
1704 my ($k,$v) = split(/:/, $this_limit,2);
1705 if ( $k !~ /mc-i(tem)?type/ ) {
1706 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1707 $this_limit =~ tr/"//d;
1708 $this_limit = $k.":'".$v."'";
1711 $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1712 $limit_desc .= " or " if $group_OR_limits{$k};
1713 $group_OR_limits{$k} .= "$this_limit";
1714 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1715 $limit_desc .= " $this_limit";
1718 # Regular old limits
1720 $limit .= " and " if $limit || $query;
1721 $limit .= "$this_limit";
1722 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1723 if ($this_limit =~ /^branch:(.+)/) {
1724 my $branchcode = $1;
1725 my $library = Koha::Libraries->find( $branchcode );
1726 if (defined $library) {
1727 $limit_desc .= " branch:" . $library->branchname;
1729 $limit_desc .= " $this_limit";
1732 $limit_desc .= " $this_limit";
1736 foreach my $k (keys (%group_OR_limits)) {
1737 $limit .= " and " if ( $query || $limit );
1738 $limit .= "($group_OR_limits{$k})";
1740 if ($availability_limit) {
1741 $limit .= " and " if ( $query || $limit );
1742 $limit .= "($availability_limit)";
1745 # Normalize the query and limit strings
1746 # This is flawed , means we can't search anything with : in it
1747 # if user wants to do ccl or cql, start the query with that
1748 # $query =~ s/:/=/g;
1749 #NOTE: We use several several different regexps here as you can't have variable length lookback assertions
1750 $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1751 $query =~ s/(?<=(wrdl)):/=/g;
1752 $query =~ s/(?<=(trn|phr)):/=/g;
1753 $query =~ s/(?<=(st-numeric)):/=/g;
1754 $query =~ s/(?<=(st-year)):/=/g;
1755 $query =~ s/(?<=(st-date-normalized)):/=/g;
1757 for ( $query, $query_desc, $limit, $limit_desc ) {
1758 s/ +/ /g; # remove extra spaces
1759 s/^ //g; # remove any beginning spaces
1760 s/ $//g; # remove any ending spaces
1761 s/==/=/g; # remove double == from query
1763 $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1765 for ($query_cgi,$simple_query) {
1768 # append the limit to the query
1769 $query .= " " . $limit;
1773 warn "QUERY:" . $query;
1774 warn "QUERY CGI:" . $query_cgi;
1775 warn "QUERY DESC:" . $query_desc;
1776 warn "LIMIT:" . $limit;
1777 warn "LIMIT CGI:" . $limit_cgi;
1778 warn "LIMIT DESC:" . $limit_desc;
1779 warn "---------\nLeave buildQuery\n---------";
1783 undef, $query, $simple_query, $query_cgi,
1784 $query_desc, $limit, $limit_cgi, $limit_desc,
1789 =head2 _build_initial_query
1791 ($query, $query_cgi, $query_desc, $previous_operand) = _build_initial_query($initial_query_params);
1793 Build a section of the initial query containing indexes, operators, and operands.
1797 sub _build_initial_query {
1801 if ($params->{previous_operand}){
1802 #If there is a previous operand, add a supplied operator or the default 'and'
1803 $operator = ($params->{operator}) ? " ".($params->{operator})." " : ' and ';
1806 #NOTE: indexes_set is typically set when doing truncation or field weighting
1807 my $operand = ($params->{indexes_set}) ? $params->{parsed_operand} : $params->{index_plus}.$params->{parsed_operand};
1809 #e.g. "kw,wrdl:test"
1810 #e.g. " and kw,wrdl:test"
1811 $params->{query} .= $operator . $operand;
1813 $params->{query_cgi} .= "&op=".uri_escape_utf8($operator) if $operator;
1814 $params->{query_cgi} .= "&idx=".uri_escape_utf8($params->{index}) if $params->{index};
1815 $params->{query_cgi} .= "&q=".uri_escape_utf8($params->{original_operand}) if $params->{original_operand};
1817 #e.g. " and kw,wrdl: test"
1818 $params->{query_desc} .= $operator . $params->{index_plus} . " " . $params->{original_operand};
1820 $params->{previous_operand} = 1 unless $params->{previous_operand}; #If there is no previous operand, mark this as one
1822 return ($params->{query}, $params->{query_cgi}, $params->{query_desc}, $params->{previous_operand});
1825 =head2 searchResults
1827 my @search_results = searchResults($search_context, $searchdesc, $hits,
1828 $results_per_page, $offset, $scan,
1831 Format results in a form suitable for passing to the template
1835 # IMO this subroutine is pretty messy still -- it's responsible for
1836 # building the HTML output for the template
1838 my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1839 my $dbh = C4::Context->dbh;
1844 $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1845 my ($is_opac, $hidelostitems);
1846 if ($search_context eq 'opac') {
1847 $hidelostitems = C4::Context->preference('hidelostitems');
1851 #Build branchnames hash
1852 my %branches = map { $_->branchcode => $_->branchname } Koha::Libraries->search({}, { order_by => 'branchname' });
1854 # FIXME - We build an authorised values hash here, using the default framework
1855 # though it is possible to have different authvals for different fws.
1857 my $shelflocations =
1858 { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
1860 # get notforloan authorised value list (see $shelflocations FIXME)
1861 my $av = Koha::MarcSubfieldStructures->search({ frameworkcode => '', kohafield => 'items.notforloan', authorised_value => { not => undef } });
1862 my $notforloan_authorised_value = $av->count ? $av->next->authorised_value : undef;
1865 my %itemtypes = %{ GetItemTypes() };
1867 #search item field code
1868 my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber", "" );
1870 ## find column names of items related to MARC
1871 my %subfieldstosearch;
1872 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
1873 for my $column ( @columns ) {
1874 my ( $tagfield, $tagsubfield ) =
1875 &GetMarcFromKohaField( "items." . $column, "" );
1876 if ( defined $tagsubfield ) {
1877 $subfieldstosearch{$column} = $tagsubfield;
1881 # handle which records to actually retrieve
1883 if ( $hits && $offset + $results_per_page <= $hits ) {
1884 $times = $offset + $results_per_page;
1887 $times = $hits; # FIXME: if $hits is undefined, why do we want to equal it?
1890 my $marcflavour = C4::Context->preference("marcflavour");
1891 # We get the biblionumber position in MARC
1892 my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1894 # set stuff for XSLT processing here once, not later again for every record we retrieved
1895 my $interface = $search_context eq 'opac' ? 'OPAC' : '';
1896 my $xslsyspref = $interface . "XSLTResultsDisplay";
1897 my $xslfile = C4::Context->preference($xslsyspref);
1898 my $lang = $xslfile ? C4::Languages::getlanguage() : undef;
1899 my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
1901 # loop through all of the records we've retrieved
1902 for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1906 # For Scan searches we built USMARC data
1907 $marcrecord = MARC::Record->new_from_usmarc( $marcresults->[$i]);
1909 # Normal search, render from Zebra's output
1910 $marcrecord = new_record_from_zebra(
1915 if ( ! defined $marcrecord ) {
1916 warn "ERROR DECODING RECORD - $@: " . $marcresults->[$i];
1924 ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1925 : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1927 SetUTF8Flag($marcrecord);
1928 my $oldbiblio = TransformMarcToKoha( $marcrecord, $fw );
1929 $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1930 $oldbiblio->{result_number} = $i + 1;
1932 # add imageurl to itemtype if there is one
1933 $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1935 $oldbiblio->{normalized_upc} = GetNormalizedUPC( $marcrecord,$marcflavour);
1936 $oldbiblio->{normalized_ean} = GetNormalizedEAN( $marcrecord,$marcflavour);
1937 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1938 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1939 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1941 # edition information, if any
1942 $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1943 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{translated_description};
1944 # Build summary if there is one (the summary is defined in the itemtypes table)
1945 # FIXME: is this used anywhere, I think it can be commented out? -- JF
1946 if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1947 my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1948 my @fields = $marcrecord->fields();
1951 foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1953 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1954 $tag =~ /(.{3})(.)/;
1955 if($marcrecord->field($1)){
1956 my @abc = $marcrecord->field($1)->subfield($2);
1957 $tags->{$tag} = $#abc + 1 ;
1961 # We catch how many times to repeat this line
1963 foreach my $tag (keys(%$tags)){
1964 $max = $tags->{$tag} if($tags->{$tag} > $max);
1967 # we replace, and repeat each line
1968 for (my $i = 0 ; $i < $max ; $i++){
1969 my $newline = $line;
1971 foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1972 $tag =~ /(.{3})(.)/;
1974 if($marcrecord->field($1)){
1975 my @repl = $marcrecord->field($1)->subfield($2);
1976 my $subfieldvalue = $repl[$i];
1977 $newline =~ s/\[$tag\]/$subfieldvalue/g;
1980 $newsummary .= "$newline\n";
1984 $newsummary =~ s/\[(.*?)]//g;
1985 $newsummary =~ s/\n/<br\/>/g;
1986 $oldbiblio->{summary} = $newsummary;
1989 # Pull out the items fields
1990 my @fields = $marcrecord->field($itemtag);
1991 my $marcflavor = C4::Context->preference("marcflavour");
1992 # adding linked items that belong to host records
1993 my $analyticsfield = '773';
1994 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1995 $analyticsfield = '773';
1996 } elsif ($marcflavor eq 'UNIMARC') {
1997 $analyticsfield = '461';
1999 foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
2000 my $hostbiblionumber = $hostfield->subfield("0");
2001 my $linkeditemnumber = $hostfield->subfield("9");
2002 if(!$hostbiblionumber eq undef){
2003 my $hostbiblio = GetMarcBiblio($hostbiblionumber, 1);
2004 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
2005 if(!$hostbiblio eq undef){
2006 my @hostitems = $hostbiblio->field($itemfield);
2007 foreach my $hostitem (@hostitems){
2008 if ($hostitem->subfield("9") eq $linkeditemnumber){
2009 my $linkeditem =$hostitem;
2010 # append linked items if they exist
2011 if (!$linkeditem eq undef){
2012 push (@fields, $linkeditem);}
2019 # Setting item statuses for display
2020 my @available_items_loop;
2021 my @onloan_items_loop;
2022 my @other_items_loop;
2024 my $available_items;
2028 my $ordered_count = 0;
2029 my $available_count = 0;
2030 my $onloan_count = 0;
2031 my $longoverdue_count = 0;
2032 my $other_count = 0;
2033 my $withdrawn_count = 0;
2034 my $itemlost_count = 0;
2035 my $hideatopac_count = 0;
2036 my $itembinding_count = 0;
2037 my $itemdamaged_count = 0;
2038 my $item_in_transit_count = 0;
2039 my $can_place_holds = 0;
2040 my $item_onhold_count = 0;
2041 my $notforloan_count = 0;
2042 my $items_count = scalar(@fields);
2043 my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
2044 my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
2045 my @hiddenitems; # hidden itemnumbers based on OpacHiddenItems syspref
2047 # loop through every item
2048 foreach my $field (@fields) {
2051 # populate the items hash
2052 foreach my $code ( keys %subfieldstosearch ) {
2053 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
2055 $item->{description} = $itemtypes{ $item->{itype} }{translated_description};
2059 # hidden because lost
2060 if ($hidelostitems && $item->{itemlost}) {
2061 $hideatopac_count++;
2064 # hidden based on OpacHiddenItems syspref
2065 my @hi = C4::Items::GetHiddenItemnumbers($item);
2067 push @hiddenitems, @hi;
2068 $hideatopac_count++;
2073 my $hbranch = C4::Context->preference('StaffSearchResultsDisplayBranch');
2074 my $otherbranch = $hbranch eq 'homebranch' ? 'holdingbranch' : 'homebranch';
2076 # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
2077 if ($item->{$hbranch}) {
2078 $item->{'branchname'} = $branches{$item->{$hbranch}};
2080 elsif ($item->{$otherbranch}) { # Last resort
2081 $item->{'branchname'} = $branches{$item->{$otherbranch}};
2084 my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
2085 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
2086 my $userenv = C4::Context->userenv;
2087 if ( $item->{onloan}
2088 && !( C4::Members::GetHideLostItemsPreference( $userenv->{'number'} ) && $item->{itemlost} ) )
2091 my $key = $prefix . $item->{onloan} . $item->{barcode};
2092 $onloan_items->{$key}->{due_date} = output_pref( { dt => dt_from_string( $item->{onloan} ), dateonly => 1 } );
2093 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
2094 $onloan_items->{$key}->{branchname} = $item->{branchname};
2095 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2096 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
2097 $onloan_items->{$key}->{description} = $item->{description};
2098 $onloan_items->{$key}->{imageurl} =
2099 getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2101 # if something's checked out and lost, mark it as 'long overdue'
2102 if ( $item->{itemlost} ) {
2103 $onloan_items->{$key}->{longoverdue}++;
2104 $longoverdue_count++;
2106 else { # can place holds as long as item isn't lost
2107 $can_place_holds = 1;
2111 # items not on loan, but still unavailable ( lost, withdrawn, damaged )
2114 $item->{notforloan}=1 if !$item->{notforloan} && $itemtypes{ C4::Context->preference("item-level_itypes")? $item->{itype}: $oldbiblio->{itemtype} }->{notforloan};
2117 if ( $item->{notforloan} < 0 ) {
2119 } elsif ( $item->{notforloan} > 0 ) {
2120 $notforloan_count++;
2123 # is item in transit?
2124 my $transfertwhen = '';
2125 my ($transfertfrom, $transfertto);
2127 # is item on the reserve shelf?
2128 my $reservestatus = '';
2130 unless ($item->{withdrawn}
2131 || $item->{itemlost}
2133 || $item->{notforloan}
2134 || ( C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck')
2135 && $items_count > C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck') ) ) {
2137 # A couple heuristics to limit how many times
2138 # we query the database for item transfer information, sacrificing
2139 # accuracy in some cases for speed;
2141 # 1. don't query if item has one of the other statuses
2142 # 2. don't check transit status if the bib has
2143 # more than 20 items
2145 # FIXME: to avoid having the query the database like this, and to make
2146 # the in transit status count as unavailable for search limiting,
2147 # should map transit status to record indexed in Zebra.
2149 ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
2150 $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
2153 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
2154 if ( $item->{withdrawn}
2155 || $item->{itemlost}
2157 || $item->{notforloan}
2158 || $reservestatus eq 'Waiting'
2159 || ($transfertwhen ne ''))
2161 $withdrawn_count++ if $item->{withdrawn};
2162 $itemlost_count++ if $item->{itemlost};
2163 $itemdamaged_count++ if $item->{damaged};
2164 $item_in_transit_count++ if $transfertwhen ne '';
2165 $item_onhold_count++ if $reservestatus eq 'Waiting';
2166 $item->{status} = $item->{withdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
2168 # can place a hold on a item if
2169 # not lost nor withdrawn
2170 # not damaged unless AllowHoldsOnDamagedItems is true
2171 # item is either for loan or on order (notforloan < 0)
2172 $can_place_holds = 1
2175 && !$item->{withdrawn}
2176 && ( !$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems') )
2177 && ( !$item->{notforloan} || $item->{notforloan} < 0 )
2182 my $key = $prefix . $item->{status};
2183 foreach (qw(withdrawn itemlost damaged branchname itemcallnumber)) {
2184 $other_items->{$key}->{$_} = $item->{$_};
2186 $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
2187 $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
2188 $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
2189 $other_items->{$key}->{count}++ if $item->{$hbranch};
2190 $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2191 $other_items->{$key}->{description} = $item->{description};
2192 $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2196 $can_place_holds = 1;
2198 $available_items->{$prefix}->{count}++ if $item->{$hbranch};
2199 foreach (qw(branchname itemcallnumber description)) {
2200 $available_items->{$prefix}->{$_} = $item->{$_};
2202 $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
2203 $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2206 } # notforloan, item level and biblioitem level
2208 # if all items are hidden, do not show the record
2209 if ($items_count > 0 && $hideatopac_count == $items_count) {
2213 my ( $availableitemscount, $onloanitemscount, $otheritemscount );
2214 for my $key ( sort keys %$onloan_items ) {
2215 (++$onloanitemscount > $maxitems) and last;
2216 push @onloan_items_loop, $onloan_items->{$key};
2218 for my $key ( sort keys %$other_items ) {
2219 (++$otheritemscount > $maxitems) and last;
2220 push @other_items_loop, $other_items->{$key};
2222 for my $key ( sort keys %$available_items ) {
2223 (++$availableitemscount > $maxitems) and last;
2224 push @available_items_loop, $available_items->{$key}
2227 # XSLT processing of some stuff
2228 # we fetched the sysprefs already before the loop through all retrieved record!
2229 if (!$scan && $xslfile) {
2230 $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $xslsyspref, 1, \@hiddenitems, $sysxml, $xslfile, $lang);
2231 # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
2234 # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
2235 if (!C4::Context->preference("item-level_itypes")) {
2236 if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
2237 $can_place_holds = 0;
2240 $oldbiblio->{norequests} = 1 unless $can_place_holds;
2241 $oldbiblio->{itemsplural} = 1 if $items_count > 1;
2242 $oldbiblio->{items_count} = $items_count;
2243 $oldbiblio->{available_items_loop} = \@available_items_loop;
2244 $oldbiblio->{onloan_items_loop} = \@onloan_items_loop;
2245 $oldbiblio->{other_items_loop} = \@other_items_loop;
2246 $oldbiblio->{availablecount} = $available_count;
2247 $oldbiblio->{availableplural} = 1 if $available_count > 1;
2248 $oldbiblio->{onloancount} = $onloan_count;
2249 $oldbiblio->{onloanplural} = 1 if $onloan_count > 1;
2250 $oldbiblio->{othercount} = $other_count;
2251 $oldbiblio->{otherplural} = 1 if $other_count > 1;
2252 $oldbiblio->{withdrawncount} = $withdrawn_count;
2253 $oldbiblio->{itemlostcount} = $itemlost_count;
2254 $oldbiblio->{damagedcount} = $itemdamaged_count;
2255 $oldbiblio->{intransitcount} = $item_in_transit_count;
2256 $oldbiblio->{onholdcount} = $item_onhold_count;
2257 $oldbiblio->{orderedcount} = $ordered_count;
2258 $oldbiblio->{notforloancount} = $notforloan_count;
2260 if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
2261 my $fieldspec = C4::Context->preference("AlternateHoldingsField");
2262 my $subfields = substr $fieldspec, 3;
2263 my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
2264 my @alternateholdingsinfo = ();
2265 my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
2266 my $alternateholdingscount = 0;
2268 for my $field (@holdingsfields) {
2269 my %holding = ( holding => '' );
2270 my $havesubfield = 0;
2271 for my $subfield ($field->subfields()) {
2272 if ((index $subfields, $$subfield[0]) >= 0) {
2273 $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
2274 $holding{'holding'} .= $$subfield[1];
2278 if ($havesubfield) {
2279 push(@alternateholdingsinfo, \%holding);
2280 $alternateholdingscount++;
2284 $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
2285 $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
2288 push( @newresults, $oldbiblio );
2294 =head2 enabled_staff_search_views
2296 %hash = enabled_staff_search_views()
2298 This function returns a hash that contains three flags obtained from the system
2299 preferences, used to determine whether a particular staff search results view
2304 =item C<Output arg:>
2306 * $hash{can_view_MARC} is true only if the MARC view is enabled
2307 * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2308 * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2310 =item C<usage in the script:>
2314 $template->param ( C4::Search::enabled_staff_search_views );
2318 sub enabled_staff_search_views
2321 can_view_MARC => C4::Context->preference('viewMARC'), # 1 if the staff search allows the MARC view
2322 can_view_ISBD => C4::Context->preference('viewISBD'), # 1 if the staff search allows the ISBD view
2323 can_view_labeledMARC => C4::Context->preference('viewLabeledMARC'), # 1 if the staff search allows the Labeled MARC view
2327 =head2 z3950_search_args
2329 $arrayref = z3950_search_args($matchpoints)
2331 This function returns an array reference that contains the search parameters to be
2332 passed to the Z39.50 search script (z3950_search.pl). The array elements
2333 are hash refs whose keys are name and value, and whose values are the
2334 name of a search parameter, the value of that search parameter and the URL encoded
2335 value of that parameter.
2337 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2339 The search parameter values are obtained from the bibliographic record whose
2340 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2342 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2343 a general purpose search argument. In this case, the returned array contains only
2344 entry: the key is 'title' and the value is derived from $matchpoints.
2346 If a search parameter value is undefined or empty, it is not included in the returned
2349 The returned array reference may be passed directly to the template parameters.
2353 =item C<Output arg:>
2355 * $array containing hash refs as described above
2357 =item C<usage in the script:>
2361 $data = Biblio::GetBiblioData($bibno);
2362 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2366 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2370 sub z3950_search_args {
2373 my $isbn_string = ref( $bibrec ) ? $bibrec->{title} : $bibrec;
2374 my $isbn = Business::ISBN->new( $isbn_string );
2376 if (defined $isbn && $isbn->is_valid)
2378 if ( ref($bibrec) ) {
2379 $bibrec->{isbn} = $isbn_string;
2380 $bibrec->{title} = undef;
2382 $bibrec = { isbn => $isbn_string };
2386 $bibrec = { title => $bibrec } if !ref $bibrec;
2389 for my $field (qw/ lccn isbn issn title author dewey subject /)
2391 push @$array, { name => $field, value => $bibrec->{$field} }
2392 if defined $bibrec->{$field};
2397 =head2 GetDistinctValues($field);
2399 C<$field> is a reference to the fields array
2403 sub GetDistinctValues {
2404 my ($fieldname,$string)=@_;
2405 # returns a reference to a hash of references to branches...
2406 if ($fieldname=~/\./){
2407 my ($table,$column)=split /\./, $fieldname;
2408 my $dbh = C4::Context->dbh;
2409 warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2410 my $sth = $dbh->prepare("select DISTINCT($column) as value, count(*) as cnt from $table ".($string?" where $column like \"$string%\"":"")."group by value order by $column ");
2412 my $elements=$sth->fetchall_arrayref({});
2417 my @servers=qw<biblioserver authorityserver>;
2418 my (@zconns,@results);
2419 for ( my $i = 0 ; $i < @servers ; $i++ ) {
2420 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2423 ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2426 # The big moment: asynchronously retrieve results from all servers
2432 my ( $i, $size ) = @_;
2433 for ( my $j = 0 ; $j < $size ; $j++ ) {
2435 @hashscan{qw(value cnt)} =
2436 $results[ $i - 1 ]->display_term($j);
2437 push @elements, \%hashscan;
2445 =head2 _ZOOM_event_loop
2447 _ZOOM_event_loop(\@zconns, \@results, sub {
2448 my ( $i, $size ) = @_;
2452 Processes a ZOOM event loop and passes control to a closure for
2453 processing the results, and destroying the resultsets.
2457 sub _ZOOM_event_loop {
2458 my ($zconns, $results, $callback) = @_;
2459 while ( ( my $i = ZOOM::event( $zconns ) ) != 0 ) {
2460 my $ev = $zconns->[ $i - 1 ]->last_event();
2461 if ( $ev == ZOOM::Event::ZEND ) {
2462 next unless $results->[ $i - 1 ];
2463 my $size = $results->[ $i - 1 ]->size();
2465 $callback->($i, $size);
2470 foreach my $result (@$results) {
2475 =head2 new_record_from_zebra
2477 Given raw data from a searchengine result set, return a MARC::Record object
2479 This helper function is needed to take into account all the involved
2480 system preferences and configuration variables to properly create the
2481 MARC::Record object.
2483 If we are using GRS-1, then the raw data we get from Zebra should be USMARC
2484 data. If we are using DOM, then it has to be MARCXML.
2486 If we are using elasticsearch, it'll already be a MARC::Record and this
2487 function needs a new name.
2491 sub new_record_from_zebra {
2494 my $raw_data = shift;
2495 # Set the default indexing modes
2496 my $search_engine = C4::Context->preference("SearchEngine");
2497 if ($search_engine eq 'Elasticsearch') {
2500 my $index_mode = ( $server eq 'biblioserver' )
2501 ? C4::Context->config('zebra_bib_index_mode') // 'dom'
2502 : C4::Context->config('zebra_auth_index_mode') // 'dom';
2504 my $marc_record = eval {
2505 if ( $index_mode eq 'dom' ) {
2506 MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2508 MARC::Record->new_from_usmarc( $raw_data );
2515 return $marc_record;
2520 END { } # module clean-up code here (global destructor)
2527 Koha Development Team <http://koha-community.org/>