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);
32 use C4::Reserves; # GetReserveStatus
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/ ) {
583 GetKohaAuthorisedValueLib( 'LOC',
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,
860 my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
862 $paz->search($simple_query);
863 sleep 1; # FIXME: WHY?
866 my $results_hashref = {};
867 my $stats = XMLin($paz->stat);
868 my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
870 # for a grouped search result, the number of hits
871 # is the number of groups returned; 'bib_hits' will have
872 # the total number of bibs.
873 $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
874 $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
876 HIT: foreach my $hit (@{ $results->{'hit'} }) {
877 my $recid = $hit->{recid}->[0];
879 my $work_title = $hit->{'md-work-title'}->[0];
881 if (exists $hit->{'md-work-author'}) {
882 $work_author = $hit->{'md-work-author'}->[0];
884 my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
886 my $result_group = {};
887 $result_group->{'group_label'} = $group_label;
888 $result_group->{'group_merge_key'} = $recid;
891 if (exists $hit->{count}) {
892 $count = $hit->{count}->[0];
894 $result_group->{'group_count'} = $count;
896 for (my $i = 0; $i < $count; $i++) {
897 # FIXME -- may need to worry about diacritics here
898 my $rec = $paz->record($recid, $i);
899 push @{ $result_group->{'RECORDS'} }, $rec;
902 push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
905 # pass through facets
906 my $termlist_xml = $paz->termlist('author,subject');
907 my $terms = XMLin($termlist_xml, forcearray => 1);
908 my @facets_loop = ();
909 #die Dumper($results);
910 # foreach my $list (sort keys %{ $terms->{'list'} }) {
912 # foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
914 # facet_label_value => $facet->{'name'}->[0],
917 # push @facets_loop, ( {
918 # type_label => $list,
919 # facets => \@facets,
923 return ( undef, $results_hashref, \@facets_loop );
927 sub _detect_truncation {
928 my ( $operand, $index ) = @_;
929 my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
932 my @wordlist = split( /\s/, $operand );
933 foreach my $word (@wordlist) {
934 if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
935 push @rightlefttruncated, $word;
937 elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
938 push @lefttruncated, $word;
940 elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
941 push @righttruncated, $word;
943 elsif ( index( $word, "*" ) < 0 ) {
944 push @nontruncated, $word;
947 push @regexpr, $word;
951 \@nontruncated, \@righttruncated, \@lefttruncated,
952 \@rightlefttruncated, \@regexpr
957 sub _build_stemmed_operand {
958 my ($operand,$lang) = @_;
959 require Lingua::Stem::Snowball ;
960 my $stemmed_operand=q{};
962 # If operand contains a digit, it is almost certainly an identifier, and should
963 # not be stemmed. This is particularly relevant for ISBNs and ISSNs, which
964 # can contain the letter "X" - for example, _build_stemmend_operand would reduce
965 # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
966 # results (e.g., "23 x 29 cm." from the 300$c). Bug 2098.
967 return $operand if $operand =~ /\d/;
969 # FIXME: the locale should be set based on the user's language and/or search choice
971 # Make sure we only use the first two letters from the language code
972 $lang = lc(substr($lang, 0, 2));
973 # The language codes for the two variants of Norwegian will now be "nb" and "nn",
974 # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
975 if ($lang eq 'nb' || $lang eq 'nn') {
978 my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
979 encoding => "UTF-8" );
981 my @words = split( / /, $operand );
982 my @stems = $stemmer->stem(\@words);
983 for my $stem (@stems) {
984 $stemmed_operand .= "$stem";
985 $stemmed_operand .= "?"
986 unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
987 $stemmed_operand .= " ";
989 warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
990 return $stemmed_operand;
994 sub _build_weighted_query {
996 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
997 # pretty well but could work much better if we had a smarter query parser
998 my ( $operand, $stemmed_operand, $index ) = @_;
999 my $stemming = C4::Context->preference("QueryStemming") || 0;
1000 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1001 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1002 $operand =~ s/"/ /g; # Bug 7518: searches with quotation marks don't work
1004 my $weighted_query .= "(rk=("; # Specifies that we're applying rank
1006 # Keyword, or, no index specified
1007 if ( ( $index eq 'kw' ) || ( !$index ) ) {
1009 "Title-cover,ext,r1=\"$operand\""; # exact title-cover
1010 $weighted_query .= " or ti,ext,r2=\"$operand\""; # exact title
1011 $weighted_query .= " or Title-cover,phr,r3=\"$operand\""; # phrase title
1012 $weighted_query .= " or ti,wrdl,r4=\"$operand\""; # words in title
1013 #$weighted_query .= " or any,ext,r4=$operand"; # exact any
1014 #$weighted_query .=" or kw,wrdl,r5=\"$operand\""; # word list any
1015 $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
1016 if $fuzzy_enabled; # add fuzzy, word list
1017 $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
1018 if ( $stemming and $stemmed_operand )
1019 ; # add stemming, right truncation
1020 $weighted_query .= " or wrdl,r9=\"$operand\"";
1022 # embedded sorting: 0 a-z; 1 z-a
1023 # $weighted_query .= ") or (sort1,aut=1";
1026 # Barcode searches should skip this process
1027 elsif ( $index eq 'bc' ) {
1028 $weighted_query .= "bc=\"$operand\"";
1031 # Authority-number searches should skip this process
1032 elsif ( $index eq 'an' ) {
1033 $weighted_query .= "an=\"$operand\"";
1036 # If the index is numeric, don't autoquote it.
1037 elsif ( $index =~ /,st-numeric$/ ) {
1038 $weighted_query .= " $index=$operand";
1041 # If the index already has more than one qualifier, wrap the operand
1042 # in quotes and pass it back (assumption is that the user knows what they
1043 # are doing and won't appreciate us mucking up their query
1044 elsif ( $index =~ ',' ) {
1045 $weighted_query .= " $index=\"$operand\"";
1048 #TODO: build better cases based on specific search indexes
1050 $weighted_query .= " $index,ext,r1=\"$operand\""; # exact index
1051 #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
1052 $weighted_query .= " or $index,phr,r3=\"$operand\""; # phrase index
1053 $weighted_query .= " or $index,wrdl,r6=\"$operand\""; # word list index
1054 $weighted_query .= " or $index,wrdl,fuzzy,r8=\"$operand\""
1055 if $fuzzy_enabled; # add fuzzy, word list
1056 $weighted_query .= " or $index,wrdl,rt,r9=\"$stemmed_operand\""
1057 if ( $stemming and $stemmed_operand ); # add stemming, right truncation
1060 $weighted_query .= "))"; # close rank specification
1061 return $weighted_query;
1066 Return an array with available indexes.
1088 'Author-personal-bibliography',
1098 'Chronological-subdivision',
1108 'Conference-name-heading',
1109 'Conference-name-see',
1110 'Conference-name-seealso',
1115 'Corporate-name-heading',
1116 'Corporate-name-see',
1117 'Corporate-name-seealso',
1118 'Country-publication',
1121 'date-entered-on-file',
1122 'Date-of-acquisition',
1123 'Date-of-publication',
1124 'Date-time-last-modified',
1125 'Dewey-classification',
1126 'Dissertation-information',
1135 'Geographic-subdivision',
1138 'Heading-use-main-or-added-entry',
1139 'Heading-use-series-added-entry ',
1140 'Heading-use-subject-added-entry',
1144 'Identifier-standard',
1145 'Illustration-code',
1147 'Index-term-uncontrolled',
1148 'Interest-age-level',
1149 'Interest-grade-level',
1159 'language-original',
1169 'Local-classification',
1172 'Match-heading-see-from',
1180 'Name-geographic-heading',
1181 'Name-geographic-see',
1182 'Name-geographic-seealso',
1188 'Other-control-number',
1191 'Personal-name-heading',
1192 'Personal-name-see',
1193 'Personal-name-seealso',
1195 'Place-publication',
1202 'Reading-grade-level',
1203 'Record-control-number',
1214 'Subject-heading-thesaurus',
1215 'Subject-name-personal',
1216 'Subject-subdivision',
1225 'Term-genre-form-heading',
1226 'Term-genre-form-see',
1227 'Term-genre-form-seealso',
1233 'Title-uniform-heading',
1234 'Title-uniform-see',
1235 'Title-uniform-seealso',
1245 'classification-source',
1247 'coded-location-qualifier',
1258 'Local-classification',
1261 'materials-specified',
1266 'Number-local-acquisition',
1271 'replacementpricedate',
1286 =head2 _handle_exploding_index
1288 my $query = _handle_exploding_index($index, $term)
1290 Callback routine to generate the search for "exploding" indexes (i.e.
1291 those indexes which are turned into multiple or-connected searches based
1296 sub _handle_exploding_index {
1297 my ($QParser, $filter, $params, $negate, $server) = @_;
1298 my $index = $filter;
1299 my $term = join(' ', @$params);
1301 return unless ($index =~ m/(su-br|su-na|su-rl)/ && $term);
1303 my $marcflavour = C4::Context->preference('marcflavour');
1305 my $codesubfield = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1306 my $wantedcodes = '';
1307 my @subqueries = ( "\@attr 1=Subject \@attr 4=1 \"$term\"");
1308 my ($error, $results, $total_hits) = SimpleSearch( "he:$term", undef, undef, [ "authorityserver" ] );
1309 foreach my $auth (@$results) {
1310 my $record = MARC::Record->new_from_usmarc($auth);
1311 my @references = $record->field('5..');
1313 if ($index eq 'su-br') {
1315 } elsif ($index eq 'su-na') {
1317 } elsif ($index eq 'su-rl') {
1320 foreach my $reference (@references) {
1321 my $codes = $reference->subfield($codesubfield);
1322 push @subqueries, '@attr 1=Subject @attr 4=1 "' . $reference->as_string('abcdefghijlmnopqrstuvxyz') . '"' if (($codes && $codes eq $wantedcodes) || !$wantedcodes);
1326 my $query = ' @or ' x (scalar(@subqueries) - 1) . join(' ', @subqueries);
1332 ( $operators, $operands, $indexes, $limits,
1333 $sort_by, $scan, $lang ) =
1334 buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1336 Shim function to ease the transition from buildQuery to a new QueryParser.
1337 This function is called at the beginning of buildQuery, and modifies
1338 buildQuery's input. If it can handle the input, it returns a query that
1339 buildQuery will not try to parse.
1344 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1346 my @operators = $operators ? @$operators : ();
1347 my @indexes = $indexes ? @$indexes : ();
1348 my @operands = $operands ? @$operands : ();
1349 my @limits = $limits ? @$limits : ();
1350 my @sort_by = $sort_by ? @$sort_by : ();
1352 my $query = $operands[0];
1358 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') || $query =~ s/^qp=//);
1359 undef $QParser if ($query =~ m/^(ccl=|pqf=|cql=)/ || grep (/\w,\w|\w=\w/, @operands, @indexes) );
1360 undef $QParser if (scalar @limits > 0);
1364 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
1366 for ( my $ii = 0 ; $ii <= @operands ; $ii++ ) {
1367 next unless $operands[$ii];
1368 $query .= $operators[ $ii - 1 ] eq 'or' ? ' || ' : ' && '
1370 if ( $operands[$ii] =~ /^[^"]\W*[-|_\w]*:\w.*[^"]$/ ) {
1371 $query .= $operands[$ii];
1373 elsif ( $indexes[$ii] =~ m/su-/ ) {
1374 $query .= $indexes[$ii] . '(' . $operands[$ii] . ')';
1378 ( $indexes[$ii] ? "$indexes[$ii]:" : '' ) . $operands[$ii];
1381 foreach my $limit (@limits) {
1383 if ( scalar(@sort_by) > 0 ) {
1385 '#(' . join( '|', @{ $QParser->modifiers } ) . ')';
1386 $query =~ s/$modifier_re//g;
1387 foreach my $modifier (@sort_by) {
1388 $query .= " #$modifier";
1392 $query_desc = $query;
1393 $query_desc =~ s/\s+/ /g;
1394 if ( C4::Context->preference("QueryWeightFields") ) {
1396 $QParser->add_bib1_filter_map( 'su-br' => 'biblioserver' =>
1397 { 'target_syntax_callback' => \&_handle_exploding_index } );
1398 $QParser->add_bib1_filter_map( 'su-na' => 'biblioserver' =>
1399 { 'target_syntax_callback' => \&_handle_exploding_index } );
1400 $QParser->add_bib1_filter_map( 'su-rl' => 'biblioserver' =>
1401 { 'target_syntax_callback' => \&_handle_exploding_index } );
1402 $QParser->parse($query);
1403 $operands[0] = "pqf=" . $QParser->target_syntax('biblioserver');
1406 require Koha::QueryParser::Driver::PQF;
1407 my $modifier_re = '#(' . join( '|', @{Koha::QueryParser::Driver::PQF->modifiers}) . ')';
1408 s/$modifier_re//g for @operands;
1411 return ( $operators, \@operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc);
1417 $simple_query, $query_cgi,
1418 $query_desc, $limit,
1419 $limit_cgi, $limit_desc,
1420 $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1422 Build queries and limits in CCL, CGI, Human,
1423 handle truncation, stemming, field weighting, fuzziness, etc.
1425 See verbose embedded documentation.
1431 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1433 warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1436 ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc) = parseQuery($operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1439 my @operators = $operators ? @$operators : ();
1440 my @indexes = $indexes ? @$indexes : ();
1441 my @operands = $operands ? @$operands : ();
1442 my @limits = $limits ? @$limits : ();
1443 my @sort_by = $sort_by ? @$sort_by : ();
1445 my $stemming = C4::Context->preference("QueryStemming") || 0;
1446 my $auto_truncation = C4::Context->preference("QueryAutoTruncate") || 0;
1447 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1448 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1450 my $query = $operands[0];
1451 my $simple_query = $operands[0];
1453 # initialize the variables we're passing back
1462 my $cclindexes = getIndexes();
1463 if ( $query !~ /\s*(ccl=|pqf=|cql=)/ ) {
1464 while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1466 $cclq = grep { lc($_) eq $dx } @$cclindexes;
1468 $query = "ccl=$query" if $cclq;
1471 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1473 if ( $query =~ /^ccl=/ ) {
1475 # This is needed otherwise ccl= and &limit won't work together, and
1476 # this happens when selecting a subject on the opac-detail page
1477 @limits = grep {!/^$/} @limits;
1479 $q .= ' and '.join(' and ', @limits);
1481 return ( undef, $q, $q, "q=ccl=".uri_escape_utf8($q), $q, '', '', '', 'ccl' );
1483 if ( $query =~ /^cql=/ ) {
1484 return ( undef, $', $', "q=cql=".uri_escape_utf8($'), $', '', '', '', 'cql' );
1486 if ( $query =~ /^pqf=/ ) {
1488 $query_cgi = "q=".uri_escape_utf8($query_desc);
1491 $query_cgi = "q=pqf=".uri_escape_utf8($');
1493 return ( undef, $', $', $query_cgi, $query_desc, '', '', '', 'pqf' );
1496 # pass nested queries directly
1497 # FIXME: need better handling of some of these variables in this case
1498 # Nested queries aren't handled well and this implementation is flawed and causes users to be
1499 # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1500 # if ( $query =~ /(\(|\))/ ) {
1502 # undef, $query, $simple_query, $query_cgi,
1503 # $query, $limit, $limit_cgi, $limit_desc,
1508 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1509 # query operands and indexes and add stemming, truncation, field weighting, etc.
1510 # Once we do so, we'll end up with a value in $query, just like if we had an
1511 # incoming $query from the user
1514 ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1515 my $previous_operand
1516 ; # a flag used to keep track if there was a previous query
1517 # if there was, we can apply the current operator
1519 for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1521 # COMBINE OPERANDS, INDEXES AND OPERATORS
1522 if ( $operands[$i] ) {
1523 $operands[$i]=~s/^\s+//;
1525 # A flag to determine whether or not to add the index to the query
1528 # If the user is sophisticated enough to specify an index, turn off field weighting, and stemming handling
1529 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1533 $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1535 my $operand = $operands[$i];
1536 my $index = $indexes[$i];
1538 # Add index-specific attributes
1540 #Afaik, this 'yr' condition will only ever be met in the staff client advanced search
1541 #for "Publication date", since typing 'yr:YYYY' into the search box produces a CCL query,
1542 #which is processed higher up in this sub. Other than that, year searches are typically
1543 #handled as limits which are not processed her either.
1545 # Search ranges: Date of Publication, st-numeric
1546 if ( $index =~ /(yr|st-numeric)/ ) {
1547 #weight_fields/relevance search causes errors with date ranges
1548 #In the case of YYYY-, it will only return records with a 'yr' of YYYY (not the range)
1549 #In the case of YYYY-YYYY, it will return no results
1550 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1553 # Date of Acquisition
1554 elsif ( $index =~ /acqdate/ ) {
1555 #stemming and auto_truncation would have zero impact since it already is YYYY-MM-DD format
1556 #Weight_fields probably SHOULD be turned OFF, otherwise you'll get records floating to the
1557 #top of the results just because they have lots of item records matching that date.
1558 #Fuzzy actually only applies during _build_weighted_query, and is reset there anyway, so
1560 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1562 # ISBN,ISSN,Standard Number, don't need special treatment
1563 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1565 $stemming, $auto_truncation,
1566 $weight_fields, $fuzzy_enabled
1569 if ( $index eq 'nb' ) {
1570 if ( C4::Context->preference("SearchWithISBNVariations") ) {
1571 my @isbns = C4::Koha::GetVariationsOfISBN( $operand );
1572 $operands[$i] = $operand = '(nb=' . join(' OR nb=', @isbns) . ')';
1573 $indexes[$i] = $index = '';
1582 # Set default structure attribute (word list)
1583 my $struct_attr = q{};
1584 unless ( $indexes_set || !$index || $index =~ /,(st-|phr|ext|wrdl)/ || $index =~ /^(nb|ns)$/ ) {
1585 $struct_attr = ",wrdl";
1588 # Some helpful index variants
1589 my $index_plus = $index . $struct_attr . ':';
1590 my $index_plus_comma = $index . $struct_attr . ',';
1592 if ($auto_truncation){
1593 unless ( $index =~ /,(st-|phr|ext)/ ) {
1594 #FIXME only valid with LTR scripts
1595 $operand=join(" ",map{
1596 (index($_,"*")>0?"$_":"$_*")
1597 }split (/\s+/,$operand));
1598 warn $operand if $DEBUG;
1603 my $truncated_operand;
1604 my( $nontruncated, $righttruncated, $lefttruncated,
1605 $rightlefttruncated, $regexpr
1606 ) = _detect_truncation( $operand, $index );
1608 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1613 scalar(@$righttruncated) + scalar(@$lefttruncated) +
1614 scalar(@$rightlefttruncated) > 0 )
1617 # Don't field weight or add the index to the query, we do it here
1619 undef $weight_fields;
1620 my $previous_truncation_operand;
1621 if (scalar @$nontruncated) {
1622 $truncated_operand .= "$index_plus @$nontruncated ";
1623 $previous_truncation_operand = 1;
1625 if (scalar @$righttruncated) {
1626 $truncated_operand .= "and " if $previous_truncation_operand;
1627 $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1628 $previous_truncation_operand = 1;
1630 if (scalar @$lefttruncated) {
1631 $truncated_operand .= "and " if $previous_truncation_operand;
1632 $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1633 $previous_truncation_operand = 1;
1635 if (scalar @$rightlefttruncated) {
1636 $truncated_operand .= "and " if $previous_truncation_operand;
1637 $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1638 $previous_truncation_operand = 1;
1641 $operand = $truncated_operand if $truncated_operand;
1642 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1645 my $stemmed_operand;
1646 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1649 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1651 # Handle Field Weighting
1652 my $weighted_operand;
1653 if ($weight_fields) {
1654 $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1655 $operand = $weighted_operand;
1659 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1661 ($query,$query_cgi,$query_desc,$previous_operand) = _build_initial_query({
1663 query_cgi => $query_cgi,
1664 query_desc => $query_desc,
1665 operator => ($operators[ $i - 1 ]) ? $operators[ $i - 1 ] : '',
1666 parsed_operand => $operand,
1667 original_operand => ($operands[$i]) ? $operands[$i] : '',
1669 index_plus => $index_plus,
1670 indexes_set => $indexes_set,
1671 previous_operand => $previous_operand,
1677 warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1680 my %group_OR_limits;
1681 my $availability_limit;
1682 foreach my $this_limit (@limits) {
1683 next unless $this_limit;
1684 if ( $this_limit =~ /available/ ) {
1686 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1688 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1689 $availability_limit .=
1690 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1691 $limit_cgi .= "&limit=available";
1695 # group_OR_limits, prefixed by mc-
1696 # OR every member of the group
1697 elsif ( $this_limit =~ /mc/ ) {
1698 my ($k,$v) = split(/:/, $this_limit,2);
1699 if ( $k !~ /mc-i(tem)?type/ ) {
1700 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1701 $this_limit =~ tr/"//d;
1702 $this_limit = $k.":'".$v."'";
1705 $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1706 $limit_desc .= " or " if $group_OR_limits{$k};
1707 $group_OR_limits{$k} .= "$this_limit";
1708 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1709 $limit_desc .= " $this_limit";
1712 # Regular old limits
1714 $limit .= " and " if $limit || $query;
1715 $limit .= "$this_limit";
1716 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1717 if ($this_limit =~ /^branch:(.+)/) {
1718 my $branchcode = $1;
1719 my $library = Koha::Libraries->find( $branchcode );
1720 if (defined $library) {
1721 $limit_desc .= " branch:" . $library->branchname;
1723 $limit_desc .= " $this_limit";
1726 $limit_desc .= " $this_limit";
1730 foreach my $k (keys (%group_OR_limits)) {
1731 $limit .= " and " if ( $query || $limit );
1732 $limit .= "($group_OR_limits{$k})";
1734 if ($availability_limit) {
1735 $limit .= " and " if ( $query || $limit );
1736 $limit .= "($availability_limit)";
1739 # Normalize the query and limit strings
1740 # This is flawed , means we can't search anything with : in it
1741 # if user wants to do ccl or cql, start the query with that
1742 # $query =~ s/:/=/g;
1743 #NOTE: We use several several different regexps here as you can't have variable length lookback assertions
1744 $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1745 $query =~ s/(?<=(wrdl)):/=/g;
1746 $query =~ s/(?<=(trn|phr)):/=/g;
1747 $query =~ s/(?<=(st-numeric)):/=/g;
1748 $query =~ s/(?<=(st-year)):/=/g;
1749 $query =~ s/(?<=(st-date-normalized)):/=/g;
1751 for ( $query, $query_desc, $limit, $limit_desc ) {
1752 s/ +/ /g; # remove extra spaces
1753 s/^ //g; # remove any beginning spaces
1754 s/ $//g; # remove any ending spaces
1755 s/==/=/g; # remove double == from query
1757 $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1759 for ($query_cgi,$simple_query) {
1762 # append the limit to the query
1763 $query .= " " . $limit;
1767 warn "QUERY:" . $query;
1768 warn "QUERY CGI:" . $query_cgi;
1769 warn "QUERY DESC:" . $query_desc;
1770 warn "LIMIT:" . $limit;
1771 warn "LIMIT CGI:" . $limit_cgi;
1772 warn "LIMIT DESC:" . $limit_desc;
1773 warn "---------\nLeave buildQuery\n---------";
1777 undef, $query, $simple_query, $query_cgi,
1778 $query_desc, $limit, $limit_cgi, $limit_desc,
1783 =head2 _build_initial_query
1785 ($query, $query_cgi, $query_desc, $previous_operand) = _build_initial_query($initial_query_params);
1787 Build a section of the initial query containing indexes, operators, and operands.
1791 sub _build_initial_query {
1795 if ($params->{previous_operand}){
1796 #If there is a previous operand, add a supplied operator or the default 'and'
1797 $operator = ($params->{operator}) ? " ".($params->{operator})." " : ' and ';
1800 #NOTE: indexes_set is typically set when doing truncation or field weighting
1801 my $operand = ($params->{indexes_set}) ? $params->{parsed_operand} : $params->{index_plus}.$params->{parsed_operand};
1803 #e.g. "kw,wrdl:test"
1804 #e.g. " and kw,wrdl:test"
1805 $params->{query} .= $operator . $operand;
1807 $params->{query_cgi} .= "&op=".uri_escape_utf8($operator) if $operator;
1808 $params->{query_cgi} .= "&idx=".uri_escape_utf8($params->{index}) if $params->{index};
1809 $params->{query_cgi} .= "&q=".uri_escape_utf8($params->{original_operand}) if $params->{original_operand};
1811 #e.g. " and kw,wrdl: test"
1812 $params->{query_desc} .= $operator . $params->{index_plus} . " " . $params->{original_operand};
1814 $params->{previous_operand} = 1 unless $params->{previous_operand}; #If there is no previous operand, mark this as one
1816 return ($params->{query}, $params->{query_cgi}, $params->{query_desc}, $params->{previous_operand});
1819 =head2 searchResults
1821 my @search_results = searchResults($search_context, $searchdesc, $hits,
1822 $results_per_page, $offset, $scan,
1825 Format results in a form suitable for passing to the template
1829 # IMO this subroutine is pretty messy still -- it's responsible for
1830 # building the HTML output for the template
1832 my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1833 my $dbh = C4::Context->dbh;
1838 $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1839 my ($is_opac, $hidelostitems);
1840 if ($search_context eq 'opac') {
1841 $hidelostitems = C4::Context->preference('hidelostitems');
1845 #Build branchnames hash
1847 #get branch information.....
1849 my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1851 while ( my $bdata = $bsth->fetchrow_hashref ) {
1852 $branches{ $bdata->{'branchcode'} } = $bdata->{'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 =GetKohaAuthorisedValues('items.location','');
1859 # get notforloan authorised value list (see $shelflocations FIXME)
1860 my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1863 my %itemtypes = %{ GetItemTypes() };
1865 #search item field code
1866 my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber", "" );
1868 ## find column names of items related to MARC
1869 my %subfieldstosearch;
1870 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
1871 for my $column ( @columns ) {
1872 my ( $tagfield, $tagsubfield ) =
1873 &GetMarcFromKohaField( "items." . $column, "" );
1874 if ( defined $tagsubfield ) {
1875 $subfieldstosearch{$column} = $tagsubfield;
1879 # handle which records to actually retrieve
1881 if ( $hits && $offset + $results_per_page <= $hits ) {
1882 $times = $offset + $results_per_page;
1885 $times = $hits; # FIXME: if $hits is undefined, why do we want to equal it?
1888 my $marcflavour = C4::Context->preference("marcflavour");
1889 # We get the biblionumber position in MARC
1890 my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1892 # set stuff for XSLT processing here once, not later again for every record we retrieved
1893 my $interface = $search_context eq 'opac' ? 'OPAC' : '';
1894 my $xslsyspref = $interface . "XSLTResultsDisplay";
1895 my $xslfile = C4::Context->preference($xslsyspref);
1896 my $lang = $xslfile ? C4::Languages::getlanguage() : undef;
1897 my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
1899 # loop through all of the records we've retrieved
1900 for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1904 # For Scan searches we built USMARC data
1905 $marcrecord = MARC::Record->new_from_usmarc( $marcresults->[$i]);
1907 # Normal search, render from Zebra's output
1908 $marcrecord = new_record_from_zebra(
1913 if ( ! defined $marcrecord ) {
1914 warn "ERROR DECODING RECORD - $@: " . $marcresults->[$i];
1922 ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1923 : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1925 SetUTF8Flag($marcrecord);
1926 my $oldbiblio = TransformMarcToKoha( $marcrecord, $fw );
1927 $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1928 $oldbiblio->{result_number} = $i + 1;
1930 # add imageurl to itemtype if there is one
1931 $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1933 $oldbiblio->{normalized_upc} = GetNormalizedUPC( $marcrecord,$marcflavour);
1934 $oldbiblio->{normalized_ean} = GetNormalizedEAN( $marcrecord,$marcflavour);
1935 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1936 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1937 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1939 # edition information, if any
1940 $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1941 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{translated_description};
1942 # Build summary if there is one (the summary is defined in the itemtypes table)
1943 # FIXME: is this used anywhere, I think it can be commented out? -- JF
1944 if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1945 my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1946 my @fields = $marcrecord->fields();
1949 foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1951 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1952 $tag =~ /(.{3})(.)/;
1953 if($marcrecord->field($1)){
1954 my @abc = $marcrecord->field($1)->subfield($2);
1955 $tags->{$tag} = $#abc + 1 ;
1959 # We catch how many times to repeat this line
1961 foreach my $tag (keys(%$tags)){
1962 $max = $tags->{$tag} if($tags->{$tag} > $max);
1965 # we replace, and repeat each line
1966 for (my $i = 0 ; $i < $max ; $i++){
1967 my $newline = $line;
1969 foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1970 $tag =~ /(.{3})(.)/;
1972 if($marcrecord->field($1)){
1973 my @repl = $marcrecord->field($1)->subfield($2);
1974 my $subfieldvalue = $repl[$i];
1975 $newline =~ s/\[$tag\]/$subfieldvalue/g;
1978 $newsummary .= "$newline\n";
1982 $newsummary =~ s/\[(.*?)]//g;
1983 $newsummary =~ s/\n/<br\/>/g;
1984 $oldbiblio->{summary} = $newsummary;
1987 # Pull out the items fields
1988 my @fields = $marcrecord->field($itemtag);
1989 my $marcflavor = C4::Context->preference("marcflavour");
1990 # adding linked items that belong to host records
1991 my $analyticsfield = '773';
1992 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1993 $analyticsfield = '773';
1994 } elsif ($marcflavor eq 'UNIMARC') {
1995 $analyticsfield = '461';
1997 foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
1998 my $hostbiblionumber = $hostfield->subfield("0");
1999 my $linkeditemnumber = $hostfield->subfield("9");
2000 if(!$hostbiblionumber eq undef){
2001 my $hostbiblio = GetMarcBiblio($hostbiblionumber, 1);
2002 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
2003 if(!$hostbiblio eq undef){
2004 my @hostitems = $hostbiblio->field($itemfield);
2005 foreach my $hostitem (@hostitems){
2006 if ($hostitem->subfield("9") eq $linkeditemnumber){
2007 my $linkeditem =$hostitem;
2008 # append linked items if they exist
2009 if (!$linkeditem eq undef){
2010 push (@fields, $linkeditem);}
2017 # Setting item statuses for display
2018 my @available_items_loop;
2019 my @onloan_items_loop;
2020 my @other_items_loop;
2022 my $available_items;
2026 my $ordered_count = 0;
2027 my $available_count = 0;
2028 my $onloan_count = 0;
2029 my $longoverdue_count = 0;
2030 my $other_count = 0;
2031 my $withdrawn_count = 0;
2032 my $itemlost_count = 0;
2033 my $hideatopac_count = 0;
2034 my $itembinding_count = 0;
2035 my $itemdamaged_count = 0;
2036 my $item_in_transit_count = 0;
2037 my $can_place_holds = 0;
2038 my $item_onhold_count = 0;
2039 my $notforloan_count = 0;
2040 my $items_count = scalar(@fields);
2041 my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
2042 my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
2043 my @hiddenitems; # hidden itemnumbers based on OpacHiddenItems syspref
2045 # loop through every item
2046 foreach my $field (@fields) {
2049 # populate the items hash
2050 foreach my $code ( keys %subfieldstosearch ) {
2051 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
2053 $item->{description} = $itemtypes{ $item->{itype} }{translated_description};
2057 # hidden because lost
2058 if ($hidelostitems && $item->{itemlost}) {
2059 $hideatopac_count++;
2062 # hidden based on OpacHiddenItems syspref
2063 my @hi = C4::Items::GetHiddenItemnumbers($item);
2065 push @hiddenitems, @hi;
2066 $hideatopac_count++;
2071 my $hbranch = C4::Context->preference('StaffSearchResultsDisplayBranch');
2072 my $otherbranch = $hbranch eq 'homebranch' ? 'holdingbranch' : 'homebranch';
2074 # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
2075 if ($item->{$hbranch}) {
2076 $item->{'branchname'} = $branches{$item->{$hbranch}};
2078 elsif ($item->{$otherbranch}) { # Last resort
2079 $item->{'branchname'} = $branches{$item->{$otherbranch}};
2082 my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
2083 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
2084 my $userenv = C4::Context->userenv;
2085 if ( $item->{onloan}
2086 && !( C4::Members::GetHideLostItemsPreference( $userenv->{'number'} ) && $item->{itemlost} ) )
2089 my $key = $prefix . $item->{onloan} . $item->{barcode};
2090 $onloan_items->{$key}->{due_date} = output_pref( { dt => dt_from_string( $item->{onloan} ), dateonly => 1 } );
2091 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
2092 $onloan_items->{$key}->{branchname} = $item->{branchname};
2093 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2094 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
2095 $onloan_items->{$key}->{description} = $item->{description};
2096 $onloan_items->{$key}->{imageurl} =
2097 getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2099 # if something's checked out and lost, mark it as 'long overdue'
2100 if ( $item->{itemlost} ) {
2101 $onloan_items->{$key}->{longoverdue}++;
2102 $longoverdue_count++;
2104 else { # can place holds as long as item isn't lost
2105 $can_place_holds = 1;
2109 # items not on loan, but still unavailable ( lost, withdrawn, damaged )
2112 $item->{notforloan}=1 if !$item->{notforloan} && $itemtypes{ C4::Context->preference("item-level_itypes")? $item->{itype}: $oldbiblio->{itemtype} }->{notforloan};
2115 if ( $item->{notforloan} < 0 ) {
2117 } elsif ( $item->{notforloan} > 0 ) {
2118 $notforloan_count++;
2121 # is item in transit?
2122 my $transfertwhen = '';
2123 my ($transfertfrom, $transfertto);
2125 # is item on the reserve shelf?
2126 my $reservestatus = '';
2128 unless ($item->{withdrawn}
2129 || $item->{itemlost}
2131 || $item->{notforloan}
2132 || ( C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck')
2133 && $items_count > C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck') ) ) {
2135 # A couple heuristics to limit how many times
2136 # we query the database for item transfer information, sacrificing
2137 # accuracy in some cases for speed;
2139 # 1. don't query if item has one of the other statuses
2140 # 2. don't check transit status if the bib has
2141 # more than 20 items
2143 # FIXME: to avoid having the query the database like this, and to make
2144 # the in transit status count as unavailable for search limiting,
2145 # should map transit status to record indexed in Zebra.
2147 ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
2148 $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
2151 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
2152 if ( $item->{withdrawn}
2153 || $item->{itemlost}
2155 || $item->{notforloan}
2156 || $reservestatus eq 'Waiting'
2157 || ($transfertwhen ne ''))
2159 $withdrawn_count++ if $item->{withdrawn};
2160 $itemlost_count++ if $item->{itemlost};
2161 $itemdamaged_count++ if $item->{damaged};
2162 $item_in_transit_count++ if $transfertwhen ne '';
2163 $item_onhold_count++ if $reservestatus eq 'Waiting';
2164 $item->{status} = $item->{withdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
2166 # can place a hold on a item if
2167 # not lost nor withdrawn
2168 # not damaged unless AllowHoldsOnDamagedItems is true
2169 # item is either for loan or on order (notforloan < 0)
2170 $can_place_holds = 1
2173 && !$item->{withdrawn}
2174 && ( !$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems') )
2175 && ( !$item->{notforloan} || $item->{notforloan} < 0 )
2180 my $key = $prefix . $item->{status};
2181 foreach (qw(withdrawn itemlost damaged branchname itemcallnumber)) {
2182 $other_items->{$key}->{$_} = $item->{$_};
2184 $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
2185 $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
2186 $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
2187 $other_items->{$key}->{count}++ if $item->{$hbranch};
2188 $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2189 $other_items->{$key}->{description} = $item->{description};
2190 $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2194 $can_place_holds = 1;
2196 $available_items->{$prefix}->{count}++ if $item->{$hbranch};
2197 foreach (qw(branchname itemcallnumber description)) {
2198 $available_items->{$prefix}->{$_} = $item->{$_};
2200 $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
2201 $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2204 } # notforloan, item level and biblioitem level
2206 # if all items are hidden, do not show the record
2207 if ($items_count > 0 && $hideatopac_count == $items_count) {
2211 my ( $availableitemscount, $onloanitemscount, $otheritemscount );
2212 for my $key ( sort keys %$onloan_items ) {
2213 (++$onloanitemscount > $maxitems) and last;
2214 push @onloan_items_loop, $onloan_items->{$key};
2216 for my $key ( sort keys %$other_items ) {
2217 (++$otheritemscount > $maxitems) and last;
2218 push @other_items_loop, $other_items->{$key};
2220 for my $key ( sort keys %$available_items ) {
2221 (++$availableitemscount > $maxitems) and last;
2222 push @available_items_loop, $available_items->{$key}
2225 # XSLT processing of some stuff
2226 # we fetched the sysprefs already before the loop through all retrieved record!
2227 if (!$scan && $xslfile) {
2228 $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $xslsyspref, 1, \@hiddenitems, $sysxml, $xslfile, $lang);
2229 # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
2232 # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
2233 if (!C4::Context->preference("item-level_itypes")) {
2234 if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
2235 $can_place_holds = 0;
2238 $oldbiblio->{norequests} = 1 unless $can_place_holds;
2239 $oldbiblio->{itemsplural} = 1 if $items_count > 1;
2240 $oldbiblio->{items_count} = $items_count;
2241 $oldbiblio->{available_items_loop} = \@available_items_loop;
2242 $oldbiblio->{onloan_items_loop} = \@onloan_items_loop;
2243 $oldbiblio->{other_items_loop} = \@other_items_loop;
2244 $oldbiblio->{availablecount} = $available_count;
2245 $oldbiblio->{availableplural} = 1 if $available_count > 1;
2246 $oldbiblio->{onloancount} = $onloan_count;
2247 $oldbiblio->{onloanplural} = 1 if $onloan_count > 1;
2248 $oldbiblio->{othercount} = $other_count;
2249 $oldbiblio->{otherplural} = 1 if $other_count > 1;
2250 $oldbiblio->{withdrawncount} = $withdrawn_count;
2251 $oldbiblio->{itemlostcount} = $itemlost_count;
2252 $oldbiblio->{damagedcount} = $itemdamaged_count;
2253 $oldbiblio->{intransitcount} = $item_in_transit_count;
2254 $oldbiblio->{onholdcount} = $item_onhold_count;
2255 $oldbiblio->{orderedcount} = $ordered_count;
2256 $oldbiblio->{notforloancount} = $notforloan_count;
2258 if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
2259 my $fieldspec = C4::Context->preference("AlternateHoldingsField");
2260 my $subfields = substr $fieldspec, 3;
2261 my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
2262 my @alternateholdingsinfo = ();
2263 my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
2264 my $alternateholdingscount = 0;
2266 for my $field (@holdingsfields) {
2267 my %holding = ( holding => '' );
2268 my $havesubfield = 0;
2269 for my $subfield ($field->subfields()) {
2270 if ((index $subfields, $$subfield[0]) >= 0) {
2271 $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
2272 $holding{'holding'} .= $$subfield[1];
2276 if ($havesubfield) {
2277 push(@alternateholdingsinfo, \%holding);
2278 $alternateholdingscount++;
2282 $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
2283 $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
2286 push( @newresults, $oldbiblio );
2292 =head2 SearchAcquisitions
2293 Search for acquisitions
2296 sub SearchAcquisitions{
2297 my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
2299 my $dbh=C4::Context->dbh;
2300 # Variable initialization
2304 LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
2305 LEFT JOIN items ON items.biblionumber=biblio.biblionumber
2306 WHERE dateaccessioned BETWEEN ? AND ?
2309 my (@params,@loopcriteria);
2311 push @params, $datebegin->output("iso");
2312 push @params, $dateend->output("iso");
2314 if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
2315 if(C4::Context->preference("item-level_itypes")){
2316 $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2318 $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2320 push @params, @$itemtypes;
2323 if ($criteria =~/itemtype/){
2324 if(C4::Context->preference("item-level_itypes")){
2325 $str .= "AND items.itype=? ";
2327 $str .= "AND biblioitems.itemtype=? ";
2330 if(scalar(@$itemtypes) == 0){
2331 my $itypes = GetItemTypes();
2332 for my $key (keys %$itypes){
2333 push @$itemtypes, $key;
2337 @loopcriteria= @$itemtypes;
2338 }elsif ($criteria=~/itemcallnumber/){
2339 $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
2340 OR items.itemcallnumber is NULL
2341 OR items.itemcallnumber = '')";
2343 @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
2345 $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
2346 @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
2349 if ($orderby =~ /date_desc/){
2350 $str.=" ORDER BY dateaccessioned DESC";
2352 $str.=" ORDER BY title";
2355 my $qdataacquisitions=$dbh->prepare($str);
2357 my @loopacquisitions;
2358 foreach my $value(@loopcriteria){
2359 push @params,$value;
2361 $cell{"title"}=$value;
2362 $cell{"titlecode"}=$value;
2364 eval{$qdataacquisitions->execute(@params);};
2366 if ($@){ warn "recentacquisitions Error :$@";}
2369 while (my $data=$qdataacquisitions->fetchrow_hashref){
2370 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
2372 $cell{"loopdata"}=\@loopdata;
2374 push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
2377 $qdataacquisitions->finish;
2378 return \@loopacquisitions;
2381 =head2 enabled_staff_search_views
2383 %hash = enabled_staff_search_views()
2385 This function returns a hash that contains three flags obtained from the system
2386 preferences, used to determine whether a particular staff search results view
2391 =item C<Output arg:>
2393 * $hash{can_view_MARC} is true only if the MARC view is enabled
2394 * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2395 * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2397 =item C<usage in the script:>
2401 $template->param ( C4::Search::enabled_staff_search_views );
2405 sub enabled_staff_search_views
2408 can_view_MARC => C4::Context->preference('viewMARC'), # 1 if the staff search allows the MARC view
2409 can_view_ISBD => C4::Context->preference('viewISBD'), # 1 if the staff search allows the ISBD view
2410 can_view_labeledMARC => C4::Context->preference('viewLabeledMARC'), # 1 if the staff search allows the Labeled MARC view
2414 =head2 z3950_search_args
2416 $arrayref = z3950_search_args($matchpoints)
2418 This function returns an array reference that contains the search parameters to be
2419 passed to the Z39.50 search script (z3950_search.pl). The array elements
2420 are hash refs whose keys are name and value, and whose values are the
2421 name of a search parameter, the value of that search parameter and the URL encoded
2422 value of that parameter.
2424 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2426 The search parameter values are obtained from the bibliographic record whose
2427 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2429 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2430 a general purpose search argument. In this case, the returned array contains only
2431 entry: the key is 'title' and the value is derived from $matchpoints.
2433 If a search parameter value is undefined or empty, it is not included in the returned
2436 The returned array reference may be passed directly to the template parameters.
2440 =item C<Output arg:>
2442 * $array containing hash refs as described above
2444 =item C<usage in the script:>
2448 $data = Biblio::GetBiblioData($bibno);
2449 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2453 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2457 sub z3950_search_args {
2460 my $isbn_string = ref( $bibrec ) ? $bibrec->{title} : $bibrec;
2461 my $isbn = Business::ISBN->new( $isbn_string );
2463 if (defined $isbn && $isbn->is_valid)
2465 if ( ref($bibrec) ) {
2466 $bibrec->{isbn} = $isbn_string;
2467 $bibrec->{title} = undef;
2469 $bibrec = { isbn => $isbn_string };
2473 $bibrec = { title => $bibrec } if !ref $bibrec;
2476 for my $field (qw/ lccn isbn issn title author dewey subject /)
2478 push @$array, { name => $field, value => $bibrec->{$field} }
2479 if defined $bibrec->{$field};
2484 =head2 GetDistinctValues($field);
2486 C<$field> is a reference to the fields array
2490 sub GetDistinctValues {
2491 my ($fieldname,$string)=@_;
2492 # returns a reference to a hash of references to branches...
2493 if ($fieldname=~/\./){
2494 my ($table,$column)=split /\./, $fieldname;
2495 my $dbh = C4::Context->dbh;
2496 warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2497 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 ");
2499 my $elements=$sth->fetchall_arrayref({});
2504 my @servers=qw<biblioserver authorityserver>;
2505 my (@zconns,@results);
2506 for ( my $i = 0 ; $i < @servers ; $i++ ) {
2507 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2510 ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2513 # The big moment: asynchronously retrieve results from all servers
2519 my ( $i, $size ) = @_;
2520 for ( my $j = 0 ; $j < $size ; $j++ ) {
2522 @hashscan{qw(value cnt)} =
2523 $results[ $i - 1 ]->display_term($j);
2524 push @elements, \%hashscan;
2532 =head2 _ZOOM_event_loop
2534 _ZOOM_event_loop(\@zconns, \@results, sub {
2535 my ( $i, $size ) = @_;
2539 Processes a ZOOM event loop and passes control to a closure for
2540 processing the results, and destroying the resultsets.
2544 sub _ZOOM_event_loop {
2545 my ($zconns, $results, $callback) = @_;
2546 while ( ( my $i = ZOOM::event( $zconns ) ) != 0 ) {
2547 my $ev = $zconns->[ $i - 1 ]->last_event();
2548 if ( $ev == ZOOM::Event::ZEND ) {
2549 next unless $results->[ $i - 1 ];
2550 my $size = $results->[ $i - 1 ]->size();
2552 $callback->($i, $size);
2557 foreach my $result (@$results) {
2562 =head2 new_record_from_zebra
2564 Given raw data from a searchengine result set, return a MARC::Record object
2566 This helper function is needed to take into account all the involved
2567 system preferences and configuration variables to properly create the
2568 MARC::Record object.
2570 If we are using GRS-1, then the raw data we get from Zebra should be USMARC
2571 data. If we are using DOM, then it has to be MARCXML.
2573 If we are using elasticsearch, it'll already be a MARC::Record and this
2574 function needs a new name.
2578 sub new_record_from_zebra {
2581 my $raw_data = shift;
2582 # Set the default indexing modes
2583 my $search_engine = C4::Context->preference("SearchEngine");
2584 if ($search_engine eq 'Elasticsearch') {
2587 my $index_mode = ( $server eq 'biblioserver' )
2588 ? C4::Context->config('zebra_bib_index_mode') // 'dom'
2589 : C4::Context->config('zebra_auth_index_mode') // 'dom';
2591 my $marc_record = eval {
2592 if ( $index_mode eq 'dom' ) {
2593 MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2595 MARC::Record->new_from_usmarc( $raw_data );
2602 return $marc_record;
2607 END { } # module clean-up code here (global destructor)
2614 Koha Development Team <http://koha-community.org/>