Revert "Bug 17278: Use available limit when requesting zebra when ccl query is used"
[koha.git] / C4 / Search.pm
blobd9a193c641cd14848062dfe7918aa69bb40150f1
1 package C4::Search;
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>.
18 use strict;
19 #use warnings; FIXME - Bug 2505
20 require Exporter;
21 use C4::Context;
22 use C4::Biblio; # GetMarcFromKohaField, GetBiblioData
23 use C4::Koha; # getFacets
24 use Koha::DateUtils;
25 use Lingua::Stem;
26 use C4::Search::PazPar2;
27 use XML::Simple;
28 use C4::Members qw(GetHideLostItemsPreference);
29 use C4::XSLT;
30 use C4::Branch;
31 use C4::Reserves; # GetReserveStatus
32 use C4::Debug;
33 use C4::Charset;
34 use Koha::Libraries;
35 use YAML;
36 use URI::Escape;
37 use Business::ISBN;
38 use MARC::Record;
39 use MARC::Field;
40 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
42 BEGIN {
43 $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
46 =head1 NAME
48 C4::Search - Functions for searching the Koha catalog.
50 =head1 SYNOPSIS
52 See opac/opac-search.pl or catalogue/search.pl for example of usage
54 =head1 DESCRIPTION
56 This module provides searching functions for Koha's bibliographic databases
58 =head1 FUNCTIONS
60 =cut
62 @ISA = qw(Exporter);
63 @EXPORT = qw(
64 &FindDuplicate
65 &SimpleSearch
66 &searchResults
67 &getRecords
68 &buildQuery
69 &GetDistinctValues
70 &enabled_staff_search_views
73 # make all your functions, whether exported or not;
75 =head2 FindDuplicate
77 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
79 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
81 =cut
83 sub FindDuplicate {
84 my ($record) = @_;
85 my $dbh = C4::Context->dbh;
86 my $result = TransformMarcToKoha( $record, '' );
87 my $sth;
88 my $query;
89 my $search;
90 my $type;
91 my ( $biblionumber, $title );
93 # search duplicate on ISBN, easy and fast..
94 # ... normalize first
95 if ( $result->{isbn} ) {
96 $result->{isbn} =~ s/\(.*$//;
97 $result->{isbn} =~ s/\s+$//;
98 $query = "isbn:$result->{isbn}";
100 else {
101 my $QParser;
102 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser'));
103 my $titleindex;
104 my $authorindex;
105 my $op;
107 if ($QParser) {
108 $titleindex = 'title|exact';
109 $authorindex = 'author|exact';
110 $op = '&&';
111 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
112 } else {
113 $titleindex = 'ti,ext';
114 $authorindex = 'au,ext';
115 $op = 'and';
118 $result->{title} =~ s /\\//g;
119 $result->{title} =~ s /\"//g;
120 $result->{title} =~ s /\(//g;
121 $result->{title} =~ s /\)//g;
123 # FIXME: instead of removing operators, could just do
124 # quotes around the value
125 $result->{title} =~ s/(and|or|not)//g;
126 $query = "$titleindex:\"$result->{title}\"";
127 if ( $result->{author} ) {
128 $result->{author} =~ s /\\//g;
129 $result->{author} =~ s /\"//g;
130 $result->{author} =~ s /\(//g;
131 $result->{author} =~ s /\)//g;
133 # remove valid operators
134 $result->{author} =~ s/(and|or|not)//g;
135 $query .= " $op $authorindex:\"$result->{author}\"";
139 my ( $error, $searchresults, undef ) = SimpleSearch($query); # FIXME :: hardcoded !
140 my @results;
141 if (!defined $error) {
142 foreach my $possible_duplicate_record (@{$searchresults}) {
143 my $marcrecord = new_record_from_zebra(
144 'biblioserver',
145 $possible_duplicate_record
148 my $result = TransformMarcToKoha( $marcrecord, '' );
150 # FIXME :: why 2 $biblionumber ?
151 if ($result) {
152 push @results, $result->{'biblionumber'};
153 push @results, $result->{'title'};
157 return @results;
160 =head2 SimpleSearch
162 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers] );
164 This function provides a simple search API on the bibliographic catalog
166 =over 2
168 =item C<input arg:>
170 * $query can be a simple keyword or a complete CCL query
171 * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
172 * $offset - If present, represents the number of records at the beginning to omit. Defaults to 0
173 * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
176 =item C<Return:>
178 Returns an array consisting of three elements
179 * $error is undefined unless an error is detected
180 * $results is a reference to an array of records.
181 * $total_hits is the number of hits that would have been returned with no limit
183 If an error is returned the two other return elements are undefined. If error itself is undefined
184 the other two elements are always defined
186 =item C<usage in the script:>
188 =back
190 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
192 if (defined $error) {
193 $template->param(query_error => $error);
194 warn "error: ".$error;
195 output_html_with_http_headers $input, $cookie, $template->output;
196 exit;
199 my $hits = @{$marcresults};
200 my @results;
202 for my $r ( @{$marcresults} ) {
203 my $marcrecord = MARC::File::USMARC::decode($r);
204 my $biblio = TransformMarcToKoha($marcrecord,q{});
206 #build the iarray of hashs for the template.
207 push @results, {
208 title => $biblio->{'title'},
209 subtitle => $biblio->{'subtitle'},
210 biblionumber => $biblio->{'biblionumber'},
211 author => $biblio->{'author'},
212 publishercode => $biblio->{'publishercode'},
213 publicationyear => $biblio->{'publicationyear'},
218 $template->param(result=>\@results);
220 =cut
222 sub SimpleSearch {
223 my ( $query, $offset, $max_results, $servers ) = @_;
225 return ( 'No query entered', undef, undef ) unless $query;
226 # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
227 my @servers = defined ( $servers ) ? @$servers : ( 'biblioserver' );
228 my @zoom_queries;
229 my @tmpresults;
230 my @zconns;
231 my $results = [];
232 my $total_hits = 0;
234 my $QParser;
235 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') && ! ($query =~ m/\w,\w|\w=\w/));
236 if ($QParser) {
237 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
240 # Initialize & Search Zebra
241 for ( my $i = 0 ; $i < @servers ; $i++ ) {
242 eval {
243 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
244 if ($QParser) {
245 $query =~ s/=/:/g;
246 $QParser->parse( $query );
247 $query = $QParser->target_syntax($servers[$i]);
248 $zoom_queries[$i] = new ZOOM::Query::PQF( $query, $zconns[$i]);
249 } else {
250 $query =~ s/:/=/g;
251 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
253 $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
255 # error handling
256 my $error =
257 $zconns[$i]->errmsg() . " ("
258 . $zconns[$i]->errcode() . ") "
259 . $zconns[$i]->addinfo() . " "
260 . $zconns[$i]->diagset();
262 return ( $error, undef, undef ) if $zconns[$i]->errcode();
264 if ($@) {
266 # caught a ZOOM::Exception
267 my $error =
268 $@->message() . " ("
269 . $@->code() . ") "
270 . $@->addinfo() . " "
271 . $@->diagset();
272 warn $error." for query: $query";
273 return ( $error, undef, undef );
277 _ZOOM_event_loop(
278 \@zconns,
279 \@tmpresults,
280 sub {
281 my ($i, $size) = @_;
282 my $first_record = defined($offset) ? $offset + 1 : 1;
283 my $hits = $tmpresults[ $i - 1 ]->size();
284 $total_hits += $hits;
285 my $last_record = $hits;
286 if ( defined $max_results && $offset + $max_results < $hits ) {
287 $last_record = $offset + $max_results;
290 for my $j ( $first_record .. $last_record ) {
291 my $record = eval {
292 $tmpresults[ $i - 1 ]->record( $j - 1 )->raw()
293 ; # 0 indexed
295 push @{$results}, $record if defined $record;
300 foreach my $zoom_query (@zoom_queries) {
301 $zoom_query->destroy();
304 return ( undef, $results, $total_hits );
307 =head2 getRecords
309 ( undef, $results_hashref, \@facets_loop ) = getRecords (
311 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
312 $results_per_page, $offset, $expanded_facet, $branches,$itemtypes,
313 $query_type, $scan
316 The all singing, all dancing, multi-server, asynchronous, scanning,
317 searching, record nabbing, facet-building
319 See verbse embedded documentation.
321 =cut
323 sub getRecords {
324 my (
325 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
326 $results_per_page, $offset, $expanded_facet, $branches,
327 $itemtypes, $query_type, $scan, $opac
328 ) = @_;
330 my @servers = @$servers_ref;
331 my @sort_by = @$sort_by_ref;
333 # Initialize variables for the ZOOM connection and results object
334 my $zconn;
335 my @zconns;
336 my @results;
337 my $results_hashref = ();
339 # Initialize variables for the faceted results objects
340 my $facets_counter = {};
341 my $facets_info = {};
342 my $facets = getFacets();
344 my @facets_loop; # stores the ref to array of hashes for template facets loop
346 ### LOOP THROUGH THE SERVERS
347 for ( my $i = 0 ; $i < @servers ; $i++ ) {
348 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
350 # perform the search, create the results objects
351 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
352 my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
354 #$query_to_use = $simple_query if $scan;
355 warn $simple_query if ( $scan and $DEBUG );
357 # Check if we've got a query_type defined, if so, use it
358 eval {
359 if ($query_type) {
360 if ($query_type =~ /^ccl/) {
361 $query_to_use =~ s/\:/\=/g; # change : to = last minute (FIXME)
362 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
363 } elsif ($query_type =~ /^cql/) {
364 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
365 } elsif ($query_type =~ /^pqf/) {
366 $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
367 } else {
368 warn "Unknown query_type '$query_type'. Results undetermined.";
370 } elsif ($scan) {
371 $results[$i] = $zconns[$i]->scan( new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
372 } else {
373 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
376 if ($@) {
377 warn "WARNING: query problem with $query_to_use " . $@;
380 # Concatenate the sort_by limits and pass them to the results object
381 # Note: sort will override rank
382 my $sort_by;
383 foreach my $sort (@sort_by) {
384 if ( $sort eq "author_az" || $sort eq "author_asc" ) {
385 $sort_by .= "1=1003 <i ";
387 elsif ( $sort eq "author_za" || $sort eq "author_dsc" ) {
388 $sort_by .= "1=1003 >i ";
390 elsif ( $sort eq "popularity_asc" ) {
391 $sort_by .= "1=9003 <i ";
393 elsif ( $sort eq "popularity_dsc" ) {
394 $sort_by .= "1=9003 >i ";
396 elsif ( $sort eq "call_number_asc" ) {
397 $sort_by .= "1=8007 <i ";
399 elsif ( $sort eq "call_number_dsc" ) {
400 $sort_by .= "1=8007 >i ";
402 elsif ( $sort eq "pubdate_asc" ) {
403 $sort_by .= "1=31 <i ";
405 elsif ( $sort eq "pubdate_dsc" ) {
406 $sort_by .= "1=31 >i ";
408 elsif ( $sort eq "acqdate_asc" ) {
409 $sort_by .= "1=32 <i ";
411 elsif ( $sort eq "acqdate_dsc" ) {
412 $sort_by .= "1=32 >i ";
414 elsif ( $sort eq "title_az" || $sort eq "title_asc" ) {
415 $sort_by .= "1=4 <i ";
417 elsif ( $sort eq "title_za" || $sort eq "title_dsc" ) {
418 $sort_by .= "1=4 >i ";
420 else {
421 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
424 if ( $sort_by && !$scan && $results[$i] ) {
425 if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
426 warn "WARNING sort $sort_by failed";
429 } # finished looping through servers
431 # The big moment: asynchronously retrieve results from all servers
432 _ZOOM_event_loop(
433 \@zconns,
434 \@results,
435 sub {
436 my ( $i, $size ) = @_;
437 my $results_hash;
439 # loop through the results
440 $results_hash->{'hits'} = $size;
441 my $times;
442 if ( $offset + $results_per_page <= $size ) {
443 $times = $offset + $results_per_page;
445 else {
446 $times = $size;
449 for ( my $j = $offset ; $j < $times ; $j++ ) {
450 my $records_hash;
451 my $record;
453 ## Check if it's an index scan
454 if ($scan) {
455 my ( $term, $occ ) = $results[ $i - 1 ]->display_term($j);
457 # here we create a minimal MARC record and hand it off to the
458 # template just like a normal result ... perhaps not ideal, but
459 # it works for now
460 my $tmprecord = MARC::Record->new();
461 $tmprecord->encoding('UTF-8');
462 my $tmptitle;
463 my $tmpauthor;
465 # the minimal record in author/title (depending on MARC flavour)
466 if ( C4::Context->preference("marcflavour") eq
467 "UNIMARC" )
469 $tmptitle = MARC::Field->new(
470 '200', ' ', ' ',
471 a => $term,
472 f => $occ
474 $tmprecord->append_fields($tmptitle);
476 else {
477 $tmptitle =
478 MARC::Field->new( '245', ' ', ' ', a => $term, );
479 $tmpauthor =
480 MARC::Field->new( '100', ' ', ' ', a => $occ, );
481 $tmprecord->append_fields($tmptitle);
482 $tmprecord->append_fields($tmpauthor);
484 $results_hash->{'RECORDS'}[$j] =
485 $tmprecord->as_usmarc();
488 # not an index scan
489 else {
490 $record = $results[ $i - 1 ]->record($j)->raw();
491 # warn "RECORD $j:".$record;
492 $results_hash->{'RECORDS'}[$j] = $record;
496 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
498 # Fill the facets while we're looping, but only for the
499 # biblioserver and not for a scan
500 if ( !$scan && $servers[ $i - 1 ] =~ /biblioserver/ ) {
501 $facets_counter = GetFacets( $results[ $i - 1 ] );
502 $facets_info = _get_facets_info( $facets );
505 # BUILD FACETS
506 if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
507 for my $link_value (
508 sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
509 keys %$facets_counter
512 my $expandable;
513 my $number_of_facets;
514 my @this_facets_array;
515 for my $one_facet (
516 sort {
517 $facets_counter->{$link_value}
518 ->{$b} <=> $facets_counter->{$link_value}
519 ->{$a}
520 } keys %{ $facets_counter->{$link_value} }
523 $number_of_facets++;
524 if ( ( $number_of_facets <= 5 )
525 || ( $expanded_facet eq $link_value )
526 || ( $facets_info->{$link_value}->{'expanded'} )
530 # Sanitize the link value : parenthesis, question and exclamation mark will cause errors with CCL
531 my $facet_link_value = $one_facet;
532 $facet_link_value =~ s/[()!?¡¿؟]/ /g;
534 # fix the length that will display in the label,
535 my $facet_label_value = $one_facet;
536 my $facet_max_length = C4::Context->preference(
537 'FacetLabelTruncationLength')
538 || 20;
539 $facet_label_value =
540 substr( $one_facet, 0, $facet_max_length )
541 . "..."
542 if length($facet_label_value) >
543 $facet_max_length;
545 # if it's a branch, label by the name, not the code,
546 if ( $link_value =~ /branch/ ) {
547 if ( defined $branches
548 && ref($branches) eq "HASH"
549 && defined $branches->{$one_facet}
550 && ref( $branches->{$one_facet} ) eq
551 "HASH" )
553 $facet_label_value =
554 $branches->{$one_facet}
555 ->{'branchname'};
557 else {
558 $facet_label_value = "*";
562 # if it's a itemtype, label by the name, not the code,
563 if ( $link_value =~ /itype/ ) {
564 if ( defined $itemtypes
565 && ref($itemtypes) eq "HASH"
566 && defined $itemtypes->{$one_facet}
567 && ref( $itemtypes->{$one_facet} ) eq
568 "HASH" )
570 $facet_label_value =
571 $itemtypes->{$one_facet}
572 ->{translated_description};
576 # also, if it's a location code, use the name instead of the code
577 if ( $link_value =~ /location/ ) {
578 $facet_label_value =
579 GetKohaAuthorisedValueLib( 'LOC',
580 $one_facet, $opac );
583 # but we're down with the whole label being in the link's title.
584 push @this_facets_array,
586 facet_count =>
587 $facets_counter->{$link_value}
588 ->{$one_facet},
589 facet_label_value => $facet_label_value,
590 facet_title_value => $one_facet,
591 facet_link_value => $facet_link_value,
592 type_link_value => $link_value,
594 if ($facet_label_value);
598 # handle expanded option
599 unless ( $facets_info->{$link_value}->{'expanded'} ) {
600 $expandable = 1
601 if ( ( $number_of_facets > 5 )
602 && ( $expanded_facet ne $link_value ) );
604 push @facets_loop,
606 type_link_value => $link_value,
607 type_id => $link_value . "_id",
608 "type_label_"
609 . $facets_info->{$link_value}->{'label_value'} =>
611 facets => \@this_facets_array,
612 expandable => $expandable,
613 expand => $link_value,
615 unless (
617 $facets_info->{$link_value}->{'label_value'} =~
618 /Libraries/
620 and ( Koha::Libraries->search->count == 1 )
627 # This sorts the facets into alphabetical order
628 if (@facets_loop) {
629 foreach my $f (@facets_loop) {
630 $f->{facets} = [ sort { uc($a->{facet_label_value}) cmp uc($b->{facet_label_value}) } @{ $f->{facets} } ];
632 @facets_loop = sort {$a->{expand} cmp $b->{expand}} @facets_loop;
635 return ( undef, $results_hashref, \@facets_loop );
638 sub GetFacets {
640 my $rs = shift;
641 my $facets;
643 my $indexing_mode = C4::Context->config('zebra_bib_index_mode') // 'dom';
644 my $use_zebra_facets = C4::Context->config('use_zebra_facets') // 0;
646 if ( $indexing_mode eq 'dom' &&
647 $use_zebra_facets ) {
648 $facets = _get_facets_from_zebra( $rs );
649 } else {
650 $facets = _get_facets_from_records( $rs );
653 return $facets;
656 sub _get_facets_from_records {
658 my $rs = shift;
660 my $facets_maxrecs = C4::Context->preference('maxRecordsForFacets') // 20;
661 my $facets_config = getFacets();
662 my $facets = {};
663 my $size = $rs->size();
664 my $jmax = $size > $facets_maxrecs
665 ? $facets_maxrecs
666 : $size;
668 for ( my $j = 0 ; $j < $jmax ; $j++ ) {
670 my $marc_record = new_record_from_zebra (
671 'biblioserver',
672 $rs->record( $j )->raw()
675 if ( ! defined $marc_record ) {
676 warn "ERROR DECODING RECORD - $@: " .
677 $rs->record( $j )->raw();
678 next;
681 _get_facets_data_from_record( $marc_record, $facets_config, $facets );
684 return $facets;
687 =head2 _get_facets_data_from_record
689 C4::Search::_get_facets_data_from_record( $marc_record, $facets, $facets_counter );
691 Internal function that extracts facets information from a MARC::Record object
692 and populates $facets_counter for using in getRecords.
694 $facets is expected to be filled with C4::Koha::getFacets output (i.e. the configured
695 facets for Zebra).
697 =cut
699 sub _get_facets_data_from_record {
701 my ( $marc_record, $facets, $facets_counter ) = @_;
703 for my $facet (@$facets) {
705 my @used_datas = ();
707 foreach my $tag ( @{ $facet->{ tags } } ) {
709 # tag number is the first three digits
710 my $tag_num = substr( $tag, 0, 3 );
711 # subfields are the remainder
712 my $subfield_letters = substr( $tag, 3 );
714 my @fields = $marc_record->field( $tag_num );
715 foreach my $field (@fields) {
716 # If $field->indicator(1) eq 'z', it means it is a 'see from'
717 # field introduced because of IncludeSeeFromInSearches, so skip it
718 next if $field->indicator(1) eq 'z';
720 my $data = $field->as_string( $subfield_letters, $facet->{ sep } );
722 unless ( grep { /^\Q$data\E$/ } @used_datas ) {
723 push @used_datas, $data;
724 $facets_counter->{ $facet->{ idx } }->{ $data }++;
731 =head2 _get_facets_from_zebra
733 my $facets = _get_facets_from_zebra( $result_set )
735 Retrieves facets for a specified result set. It loops through the facets defined
736 in C4::Koha::getFacets and returns a hash with the following structure:
738 { facet_idx => {
739 facet_value => count
744 =cut
746 sub _get_facets_from_zebra {
748 my $rs = shift;
750 # save current elementSetName
751 my $elementSetName = $rs->option( 'elementSetName' );
753 my $facets_loop = getFacets();
754 my $facets_data = {};
755 # loop through defined facets and fill the facets hashref
756 foreach my $facet ( @$facets_loop ) {
758 my $idx = $facet->{ idx };
759 my $sep = $facet->{ sep };
760 my $facet_values = _get_facet_from_result_set( $idx, $rs, $sep );
761 if ( $facet_values ) {
762 # we've actually got a result
763 $facets_data->{ $idx } = $facet_values;
766 # set elementSetName to its previous value to avoid side effects
767 $rs->option( elementSetName => $elementSetName );
769 return $facets_data;
772 =head2 _get_facet_from_result_set
774 my $facet_values =
775 C4::Search::_get_facet_from_result_set( $facet_idx, $result_set, $sep )
777 Internal function that extracts facet information for a specific index ($facet_idx) and
778 returns a hash containing facet values and count:
781 $facet_value => $count ,
785 Warning: this function has the side effect of changing the elementSetName for the result
786 set. It is a helper function for the main loop, which takes care of backing it up for
787 restoring.
789 =cut
791 sub _get_facet_from_result_set {
793 my $facet_idx = shift;
794 my $rs = shift;
795 my $sep = shift;
797 my $internal_sep = '<*>';
798 my $facetMaxCount = C4::Context->preference('FacetMaxCount') // 20;
800 return if ( ! defined $facet_idx || ! defined $rs );
801 # zebra's facet element, untokenized index
802 my $facet_element = 'zebra::facet::' . $facet_idx . ':0:' . $facetMaxCount;
803 # configure zebra results for retrieving the desired facet
804 $rs->option( elementSetName => $facet_element );
805 # get the facet record from result set
806 my $facet = $rs->record( 0 )->raw;
807 # if the facet has no restuls...
808 return if !defined $facet;
809 # TODO: benchmark DOM vs. SAX performance
810 my $facet_dom = XML::LibXML->load_xml(
811 string => ($facet)
813 my @terms = $facet_dom->getElementsByTagName('term');
814 return if ! @terms;
816 my $facets = {};
817 foreach my $term ( @terms ) {
818 my $facet_value = $term->textContent;
819 $facet_value =~ s/\Q$internal_sep\E/$sep/ if defined $sep;
820 $facets->{ $facet_value } = $term->getAttribute( 'occur' );
823 return $facets;
826 =head2 _get_facets_info
828 my $facets_info = C4::Search::_get_facets_info( $facets )
830 Internal function that extracts facets information and properly builds
831 the data structure needed to render facet labels.
833 =cut
835 sub _get_facets_info {
837 my $facets = shift;
839 my $facets_info = {};
841 for my $facet ( @$facets ) {
842 $facets_info->{ $facet->{ idx } }->{ label_value } = $facet->{ label };
843 $facets_info->{ $facet->{ idx } }->{ expanded } = $facet->{ expanded };
846 return $facets_info;
849 sub pazGetRecords {
850 my (
851 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
852 $results_per_page, $offset, $expanded_facet, $branches,
853 $query_type, $scan
854 ) = @_;
856 my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
857 $paz->init();
858 $paz->search($simple_query);
859 sleep 1; # FIXME: WHY?
861 # do results
862 my $results_hashref = {};
863 my $stats = XMLin($paz->stat);
864 my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
866 # for a grouped search result, the number of hits
867 # is the number of groups returned; 'bib_hits' will have
868 # the total number of bibs.
869 $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
870 $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
872 HIT: foreach my $hit (@{ $results->{'hit'} }) {
873 my $recid = $hit->{recid}->[0];
875 my $work_title = $hit->{'md-work-title'}->[0];
876 my $work_author;
877 if (exists $hit->{'md-work-author'}) {
878 $work_author = $hit->{'md-work-author'}->[0];
880 my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
882 my $result_group = {};
883 $result_group->{'group_label'} = $group_label;
884 $result_group->{'group_merge_key'} = $recid;
886 my $count = 1;
887 if (exists $hit->{count}) {
888 $count = $hit->{count}->[0];
890 $result_group->{'group_count'} = $count;
892 for (my $i = 0; $i < $count; $i++) {
893 # FIXME -- may need to worry about diacritics here
894 my $rec = $paz->record($recid, $i);
895 push @{ $result_group->{'RECORDS'} }, $rec;
898 push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
901 # pass through facets
902 my $termlist_xml = $paz->termlist('author,subject');
903 my $terms = XMLin($termlist_xml, forcearray => 1);
904 my @facets_loop = ();
905 #die Dumper($results);
906 # foreach my $list (sort keys %{ $terms->{'list'} }) {
907 # my @facets = ();
908 # foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
909 # push @facets, {
910 # facet_label_value => $facet->{'name'}->[0],
911 # };
913 # push @facets_loop, ( {
914 # type_label => $list,
915 # facets => \@facets,
916 # } );
919 return ( undef, $results_hashref, \@facets_loop );
922 # TRUNCATION
923 sub _detect_truncation {
924 my ( $operand, $index ) = @_;
925 my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
926 @regexpr );
927 $operand =~ s/^ //g;
928 my @wordlist = split( /\s/, $operand );
929 foreach my $word (@wordlist) {
930 if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
931 push @rightlefttruncated, $word;
933 elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
934 push @lefttruncated, $word;
936 elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
937 push @righttruncated, $word;
939 elsif ( index( $word, "*" ) < 0 ) {
940 push @nontruncated, $word;
942 else {
943 push @regexpr, $word;
946 return (
947 \@nontruncated, \@righttruncated, \@lefttruncated,
948 \@rightlefttruncated, \@regexpr
952 # STEMMING
953 sub _build_stemmed_operand {
954 my ($operand,$lang) = @_;
955 require Lingua::Stem::Snowball ;
956 my $stemmed_operand=q{};
958 # If operand contains a digit, it is almost certainly an identifier, and should
959 # not be stemmed. This is particularly relevant for ISBNs and ISSNs, which
960 # can contain the letter "X" - for example, _build_stemmend_operand would reduce
961 # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
962 # results (e.g., "23 x 29 cm." from the 300$c). Bug 2098.
963 return $operand if $operand =~ /\d/;
965 # FIXME: the locale should be set based on the user's language and/or search choice
966 #warn "$lang";
967 # Make sure we only use the first two letters from the language code
968 $lang = lc(substr($lang, 0, 2));
969 # The language codes for the two variants of Norwegian will now be "nb" and "nn",
970 # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
971 if ($lang eq 'nb' || $lang eq 'nn') {
972 $lang = 'no';
974 my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
975 encoding => "UTF-8" );
977 my @words = split( / /, $operand );
978 my @stems = $stemmer->stem(\@words);
979 for my $stem (@stems) {
980 $stemmed_operand .= "$stem";
981 $stemmed_operand .= "?"
982 unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
983 $stemmed_operand .= " ";
985 warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
986 return $stemmed_operand;
989 # FIELD WEIGHTING
990 sub _build_weighted_query {
992 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
993 # pretty well but could work much better if we had a smarter query parser
994 my ( $operand, $stemmed_operand, $index ) = @_;
995 my $stemming = C4::Context->preference("QueryStemming") || 0;
996 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
997 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
998 $operand =~ s/"/ /g; # Bug 7518: searches with quotation marks don't work
1000 my $weighted_query .= "(rk=("; # Specifies that we're applying rank
1002 # Keyword, or, no index specified
1003 if ( ( $index eq 'kw' ) || ( !$index ) ) {
1004 $weighted_query .=
1005 "Title-cover,ext,r1=\"$operand\""; # exact title-cover
1006 $weighted_query .= " or ti,ext,r2=\"$operand\""; # exact title
1007 $weighted_query .= " or Title-cover,phr,r3=\"$operand\""; # phrase title
1008 $weighted_query .= " or ti,wrdl,r4=\"$operand\""; # words in title
1009 #$weighted_query .= " or any,ext,r4=$operand"; # exact any
1010 #$weighted_query .=" or kw,wrdl,r5=\"$operand\""; # word list any
1011 $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
1012 if $fuzzy_enabled; # add fuzzy, word list
1013 $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
1014 if ( $stemming and $stemmed_operand )
1015 ; # add stemming, right truncation
1016 $weighted_query .= " or wrdl,r9=\"$operand\"";
1018 # embedded sorting: 0 a-z; 1 z-a
1019 # $weighted_query .= ") or (sort1,aut=1";
1022 # Barcode searches should skip this process
1023 elsif ( $index eq 'bc' ) {
1024 $weighted_query .= "bc=\"$operand\"";
1027 # Authority-number searches should skip this process
1028 elsif ( $index eq 'an' ) {
1029 $weighted_query .= "an=\"$operand\"";
1032 # If the index is numeric, don't autoquote it.
1033 elsif ( $index =~ /,st-numeric$/ ) {
1034 $weighted_query .= " $index=$operand";
1037 # If the index already has more than one qualifier, wrap the operand
1038 # in quotes and pass it back (assumption is that the user knows what they
1039 # are doing and won't appreciate us mucking up their query
1040 elsif ( $index =~ ',' ) {
1041 $weighted_query .= " $index=\"$operand\"";
1044 #TODO: build better cases based on specific search indexes
1045 else {
1046 $weighted_query .= " $index,ext,r1=\"$operand\""; # exact index
1047 #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
1048 $weighted_query .= " or $index,phr,r3=\"$operand\""; # phrase index
1049 $weighted_query .= " or $index,wrdl,r6=\"$operand\""; # word list index
1050 $weighted_query .= " or $index,wrdl,fuzzy,r8=\"$operand\""
1051 if $fuzzy_enabled; # add fuzzy, word list
1052 $weighted_query .= " or $index,wrdl,rt,r9=\"$stemmed_operand\""
1053 if ( $stemming and $stemmed_operand ); # add stemming, right truncation
1056 $weighted_query .= "))"; # close rank specification
1057 return $weighted_query;
1060 =head2 getIndexes
1062 Return an array with available indexes.
1064 =cut
1066 sub getIndexes{
1067 my @indexes = (
1068 # biblio indexes
1069 'ab',
1070 'Abstract',
1071 'acqdate',
1072 'allrecords',
1073 'an',
1074 'Any',
1075 'at',
1076 'au',
1077 'aub',
1078 'aud',
1079 'audience',
1080 'auo',
1081 'aut',
1082 'Author',
1083 'Author-in-order ',
1084 'Author-personal-bibliography',
1085 'Authority-Number',
1086 'authtype',
1087 'bc',
1088 'Bib-level',
1089 'biblionumber',
1090 'bio',
1091 'biography',
1092 'callnum',
1093 'cfn',
1094 'Chronological-subdivision',
1095 'cn-bib-source',
1096 'cn-bib-sort',
1097 'cn-class',
1098 'cn-item',
1099 'cn-prefix',
1100 'cn-suffix',
1101 'cpn',
1102 'Code-institution',
1103 'Conference-name',
1104 'Conference-name-heading',
1105 'Conference-name-see',
1106 'Conference-name-seealso',
1107 'Content-type',
1108 'Control-number',
1109 'copydate',
1110 'Corporate-name',
1111 'Corporate-name-heading',
1112 'Corporate-name-see',
1113 'Corporate-name-seealso',
1114 'Country-publication',
1115 'ctype',
1116 'curriculum',
1117 'date-entered-on-file',
1118 'Date-of-acquisition',
1119 'Date-of-publication',
1120 'Date-time-last-modified',
1121 'Dewey-classification',
1122 'Dissertation-information',
1123 'diss',
1124 'dtlm',
1125 'EAN',
1126 'extent',
1127 'fic',
1128 'fiction',
1129 'Form-subdivision',
1130 'format',
1131 'Geographic-subdivision',
1132 'he',
1133 'Heading',
1134 'Heading-use-main-or-added-entry',
1135 'Heading-use-series-added-entry ',
1136 'Heading-use-subject-added-entry',
1137 'Host-item',
1138 'id-other',
1139 'ident',
1140 'Identifier-standard',
1141 'Illustration-code',
1142 'Index-term-genre',
1143 'Index-term-uncontrolled',
1144 'Interest-age-level',
1145 'Interest-grade-level',
1146 'ISBN',
1147 'isbn',
1148 'ISSN',
1149 'issn',
1150 'itemtype',
1151 'kw',
1152 'Koha-Auth-Number',
1153 'l-format',
1154 'language',
1155 'language-original',
1156 'lc-card',
1157 'LC-card-number',
1158 'lcn',
1159 'lex',
1160 'lexile-number',
1161 'llength',
1162 'ln',
1163 'ln-audio',
1164 'ln-subtitle',
1165 'Local-classification',
1166 'Local-number',
1167 'Match-heading',
1168 'Match-heading-see-from',
1169 'Material-type',
1170 'mc-itemtype',
1171 'mc-rtype',
1172 'mus',
1173 'name',
1174 'Music-number',
1175 'Name-geographic',
1176 'Name-geographic-heading',
1177 'Name-geographic-see',
1178 'Name-geographic-seealso',
1179 'nb',
1180 'Note',
1181 'notes',
1182 'ns',
1183 'nt',
1184 'Other-control-number',
1185 'pb',
1186 'Personal-name',
1187 'Personal-name-heading',
1188 'Personal-name-see',
1189 'Personal-name-seealso',
1190 'pl',
1191 'Place-publication',
1192 'pn',
1193 'popularity',
1194 'pubdate',
1195 'Publisher',
1196 'Provider',
1197 'pv',
1198 'Reading-grade-level',
1199 'Record-control-number',
1200 'rcn',
1201 'Record-type',
1202 'rtype',
1203 'se',
1204 'See',
1205 'See-also',
1206 'sn',
1207 'Stock-number',
1208 'su',
1209 'Subject',
1210 'Subject-heading-thesaurus',
1211 'Subject-name-personal',
1212 'Subject-subdivision',
1213 'Summary',
1214 'Suppress',
1215 'su-geo',
1216 'su-na',
1217 'su-to',
1218 'su-ut',
1219 'ut',
1220 'Term-genre-form',
1221 'Term-genre-form-heading',
1222 'Term-genre-form-see',
1223 'Term-genre-form-seealso',
1224 'ti',
1225 'Title',
1226 'Title-cover',
1227 'Title-series',
1228 'Title-uniform',
1229 'Title-uniform-heading',
1230 'Title-uniform-see',
1231 'Title-uniform-seealso',
1232 'totalissues',
1233 'yr',
1235 # items indexes
1236 'acqsource',
1237 'barcode',
1238 'bc',
1239 'branch',
1240 'ccode',
1241 'classification-source',
1242 'cn-sort',
1243 'coded-location-qualifier',
1244 'copynumber',
1245 'damaged',
1246 'datelastborrowed',
1247 'datelastseen',
1248 'holdingbranch',
1249 'homebranch',
1250 'issues',
1251 'item',
1252 'itemnumber',
1253 'itype',
1254 'Local-classification',
1255 'location',
1256 'lost',
1257 'materials-specified',
1258 'mc-ccode',
1259 'mc-itype',
1260 'mc-loc',
1261 'notforloan',
1262 'Number-local-acquisition',
1263 'onloan',
1264 'price',
1265 'renewals',
1266 'replacementprice',
1267 'replacementpricedate',
1268 'reserves',
1269 'restricted',
1270 'stack',
1271 'stocknumber',
1272 'inv',
1273 'uri',
1274 'withdrawn',
1276 # subject related
1279 return \@indexes;
1282 =head2 _handle_exploding_index
1284 my $query = _handle_exploding_index($index, $term)
1286 Callback routine to generate the search for "exploding" indexes (i.e.
1287 those indexes which are turned into multiple or-connected searches based
1288 on authority data).
1290 =cut
1292 sub _handle_exploding_index {
1293 my ($QParser, $filter, $params, $negate, $server) = @_;
1294 my $index = $filter;
1295 my $term = join(' ', @$params);
1297 return unless ($index =~ m/(su-br|su-na|su-rl)/ && $term);
1299 my $marcflavour = C4::Context->preference('marcflavour');
1301 my $codesubfield = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1302 my $wantedcodes = '';
1303 my @subqueries = ( "\@attr 1=Subject \@attr 4=1 \"$term\"");
1304 my ($error, $results, $total_hits) = SimpleSearch( "he:$term", undef, undef, [ "authorityserver" ] );
1305 foreach my $auth (@$results) {
1306 my $record = MARC::Record->new_from_usmarc($auth);
1307 my @references = $record->field('5..');
1308 if (@references) {
1309 if ($index eq 'su-br') {
1310 $wantedcodes = 'g';
1311 } elsif ($index eq 'su-na') {
1312 $wantedcodes = 'h';
1313 } elsif ($index eq 'su-rl') {
1314 $wantedcodes = '';
1316 foreach my $reference (@references) {
1317 my $codes = $reference->subfield($codesubfield);
1318 push @subqueries, '@attr 1=Subject @attr 4=1 "' . $reference->as_string('abcdefghijlmnopqrstuvxyz') . '"' if (($codes && $codes eq $wantedcodes) || !$wantedcodes);
1322 my $query = ' @or ' x (scalar(@subqueries) - 1) . join(' ', @subqueries);
1323 return $query;
1326 =head2 parseQuery
1328 ( $operators, $operands, $indexes, $limits,
1329 $sort_by, $scan, $lang ) =
1330 buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1332 Shim function to ease the transition from buildQuery to a new QueryParser.
1333 This function is called at the beginning of buildQuery, and modifies
1334 buildQuery's input. If it can handle the input, it returns a query that
1335 buildQuery will not try to parse.
1337 =cut
1339 sub parseQuery {
1340 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1342 my @operators = $operators ? @$operators : ();
1343 my @indexes = $indexes ? @$indexes : ();
1344 my @operands = $operands ? @$operands : ();
1345 my @limits = $limits ? @$limits : ();
1346 my @sort_by = $sort_by ? @$sort_by : ();
1348 my $query = $operands[0];
1349 my $index;
1350 my $term;
1351 my $query_desc;
1353 my $QParser;
1354 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') || $query =~ s/^qp=//);
1355 undef $QParser if ($query =~ m/^(ccl=|pqf=|cql=)/ || grep (/\w,\w|\w=\w/, @operands, @indexes) );
1356 undef $QParser if (scalar @limits > 0);
1358 if ($QParser)
1360 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
1361 $query = '';
1362 for ( my $ii = 0 ; $ii <= @operands ; $ii++ ) {
1363 next unless $operands[$ii];
1364 $query .= $operators[ $ii - 1 ] eq 'or' ? ' || ' : ' && '
1365 if ($query);
1366 if ( $operands[$ii] =~ /^[^"]\W*[-|_\w]*:\w.*[^"]$/ ) {
1367 $query .= $operands[$ii];
1369 elsif ( $indexes[$ii] =~ m/su-/ ) {
1370 $query .= $indexes[$ii] . '(' . $operands[$ii] . ')';
1372 else {
1373 $query .=
1374 ( $indexes[$ii] ? "$indexes[$ii]:" : '' ) . $operands[$ii];
1377 foreach my $limit (@limits) {
1379 if ( scalar(@sort_by) > 0 ) {
1380 my $modifier_re =
1381 '#(' . join( '|', @{ $QParser->modifiers } ) . ')';
1382 $query =~ s/$modifier_re//g;
1383 foreach my $modifier (@sort_by) {
1384 $query .= " #$modifier";
1388 $query_desc = $query;
1389 $query_desc =~ s/\s+/ /g;
1390 if ( C4::Context->preference("QueryWeightFields") ) {
1392 $QParser->add_bib1_filter_map( 'su-br' => 'biblioserver' =>
1393 { 'target_syntax_callback' => \&_handle_exploding_index } );
1394 $QParser->add_bib1_filter_map( 'su-na' => 'biblioserver' =>
1395 { 'target_syntax_callback' => \&_handle_exploding_index } );
1396 $QParser->add_bib1_filter_map( 'su-rl' => 'biblioserver' =>
1397 { 'target_syntax_callback' => \&_handle_exploding_index } );
1398 $QParser->parse($query);
1399 $operands[0] = "pqf=" . $QParser->target_syntax('biblioserver');
1401 else {
1402 require Koha::QueryParser::Driver::PQF;
1403 my $modifier_re = '#(' . join( '|', @{Koha::QueryParser::Driver::PQF->modifiers}) . ')';
1404 s/$modifier_re//g for @operands;
1407 return ( $operators, \@operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc);
1410 =head2 buildQuery
1412 ( $error, $query,
1413 $simple_query, $query_cgi,
1414 $query_desc, $limit,
1415 $limit_cgi, $limit_desc,
1416 $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1418 Build queries and limits in CCL, CGI, Human,
1419 handle truncation, stemming, field weighting, fuzziness, etc.
1421 See verbose embedded documentation.
1424 =cut
1426 sub buildQuery {
1427 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1429 warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1431 my $query_desc;
1432 ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc) = parseQuery($operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1434 # dereference
1435 my @operators = $operators ? @$operators : ();
1436 my @indexes = $indexes ? @$indexes : ();
1437 my @operands = $operands ? @$operands : ();
1438 my @limits = $limits ? @$limits : ();
1439 my @sort_by = $sort_by ? @$sort_by : ();
1441 my $stemming = C4::Context->preference("QueryStemming") || 0;
1442 my $auto_truncation = C4::Context->preference("QueryAutoTruncate") || 0;
1443 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1444 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1446 my $query = $operands[0];
1447 my $simple_query = $operands[0];
1449 # initialize the variables we're passing back
1450 my $query_cgi;
1451 my $query_type;
1453 my $limit;
1454 my $limit_cgi;
1455 my $limit_desc;
1457 my $cclq = 0;
1458 my $cclindexes = getIndexes();
1459 if ( $query !~ /\s*(ccl=|pqf=|cql=)/ ) {
1460 while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1461 my $dx = lc($1);
1462 $cclq = grep { lc($_) eq $dx } @$cclindexes;
1464 $query = "ccl=$query" if $cclq;
1467 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1468 # DIAGNOSTIC ONLY!!
1469 if ( $query =~ /^ccl=/ ) {
1470 my $q=$';
1471 # This is needed otherwise ccl= and &limit won't work together, and
1472 # this happens when selecting a subject on the opac-detail page
1473 @limits = grep {!/^$/} @limits;
1474 if ( @limits ) {
1475 $q .= ' and '.join(' and ', @limits);
1477 return ( undef, $q, $q, "q=ccl=".uri_escape_utf8($q), $q, '', '', '', 'ccl' );
1479 if ( $query =~ /^cql=/ ) {
1480 return ( undef, $', $', "q=cql=".uri_escape_utf8($'), $', '', '', '', 'cql' );
1482 if ( $query =~ /^pqf=/ ) {
1483 if ($query_desc) {
1484 $query_cgi = "q=".uri_escape_utf8($query_desc);
1485 } else {
1486 $query_desc = $';
1487 $query_cgi = "q=pqf=".uri_escape_utf8($');
1489 return ( undef, $', $', $query_cgi, $query_desc, '', '', '', 'pqf' );
1492 # pass nested queries directly
1493 # FIXME: need better handling of some of these variables in this case
1494 # Nested queries aren't handled well and this implementation is flawed and causes users to be
1495 # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1496 # if ( $query =~ /(\(|\))/ ) {
1497 # return (
1498 # undef, $query, $simple_query, $query_cgi,
1499 # $query, $limit, $limit_cgi, $limit_desc,
1500 # 'ccl'
1501 # );
1504 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1505 # query operands and indexes and add stemming, truncation, field weighting, etc.
1506 # Once we do so, we'll end up with a value in $query, just like if we had an
1507 # incoming $query from the user
1508 else {
1509 $query = ""
1510 ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1511 my $previous_operand
1512 ; # a flag used to keep track if there was a previous query
1513 # if there was, we can apply the current operator
1514 # for every operand
1515 for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1517 # COMBINE OPERANDS, INDEXES AND OPERATORS
1518 if ( $operands[$i] ) {
1519 $operands[$i]=~s/^\s+//;
1521 # A flag to determine whether or not to add the index to the query
1522 my $indexes_set;
1524 # If the user is sophisticated enough to specify an index, turn off field weighting, and stemming handling
1525 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1526 $weight_fields = 0;
1527 $stemming = 0;
1528 } else {
1529 $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1531 my $operand = $operands[$i];
1532 my $index = $indexes[$i];
1534 # Add index-specific attributes
1536 #Afaik, this 'yr' condition will only ever be met in the staff client advanced search
1537 #for "Publication date", since typing 'yr:YYYY' into the search box produces a CCL query,
1538 #which is processed higher up in this sub. Other than that, year searches are typically
1539 #handled as limits which are not processed her either.
1541 # Search ranges: Date of Publication, st-numeric
1542 if ( $index =~ /(yr|st-numeric)/ ) {
1543 #weight_fields/relevance search causes errors with date ranges
1544 #In the case of YYYY-, it will only return records with a 'yr' of YYYY (not the range)
1545 #In the case of YYYY-YYYY, it will return no results
1546 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1549 # Date of Acquisition
1550 elsif ( $index =~ /acqdate/ ) {
1551 #stemming and auto_truncation would have zero impact since it already is YYYY-MM-DD format
1552 #Weight_fields probably SHOULD be turned OFF, otherwise you'll get records floating to the
1553 #top of the results just because they have lots of item records matching that date.
1554 #Fuzzy actually only applies during _build_weighted_query, and is reset there anyway, so
1555 #irrelevant here
1556 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1558 # ISBN,ISSN,Standard Number, don't need special treatment
1559 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1561 $stemming, $auto_truncation,
1562 $weight_fields, $fuzzy_enabled
1563 ) = ( 0, 0, 0, 0 );
1565 if ( $index eq 'nb' ) {
1566 if ( C4::Context->preference("SearchWithISBNVariations") ) {
1567 my @isbns = C4::Koha::GetVariationsOfISBN( $operand );
1568 $operands[$i] = $operand = '(nb=' . join(' OR nb=', @isbns) . ')';
1569 $indexes[$i] = $index = '';
1574 if(not $index){
1575 $index = 'kw';
1578 # Set default structure attribute (word list)
1579 my $struct_attr = q{};
1580 unless ( $indexes_set || !$index || $index =~ /,(st-|phr|ext|wrdl)/ || $index =~ /^(nb|ns)$/ ) {
1581 $struct_attr = ",wrdl";
1584 # Some helpful index variants
1585 my $index_plus = $index . $struct_attr . ':';
1586 my $index_plus_comma = $index . $struct_attr . ',';
1588 if ($auto_truncation){
1589 unless ( $index =~ /,(st-|phr|ext)/ ) {
1590 #FIXME only valid with LTR scripts
1591 $operand=join(" ",map{
1592 (index($_,"*")>0?"$_":"$_*")
1593 }split (/\s+/,$operand));
1594 warn $operand if $DEBUG;
1598 # Detect Truncation
1599 my $truncated_operand;
1600 my( $nontruncated, $righttruncated, $lefttruncated,
1601 $rightlefttruncated, $regexpr
1602 ) = _detect_truncation( $operand, $index );
1603 warn
1604 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1605 if $DEBUG;
1607 # Apply Truncation
1608 if (
1609 scalar(@$righttruncated) + scalar(@$lefttruncated) +
1610 scalar(@$rightlefttruncated) > 0 )
1613 # Don't field weight or add the index to the query, we do it here
1614 $indexes_set = 1;
1615 undef $weight_fields;
1616 my $previous_truncation_operand;
1617 if (scalar @$nontruncated) {
1618 $truncated_operand .= "$index_plus @$nontruncated ";
1619 $previous_truncation_operand = 1;
1621 if (scalar @$righttruncated) {
1622 $truncated_operand .= "and " if $previous_truncation_operand;
1623 $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1624 $previous_truncation_operand = 1;
1626 if (scalar @$lefttruncated) {
1627 $truncated_operand .= "and " if $previous_truncation_operand;
1628 $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1629 $previous_truncation_operand = 1;
1631 if (scalar @$rightlefttruncated) {
1632 $truncated_operand .= "and " if $previous_truncation_operand;
1633 $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1634 $previous_truncation_operand = 1;
1637 $operand = $truncated_operand if $truncated_operand;
1638 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1640 # Handle Stemming
1641 my $stemmed_operand;
1642 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1643 if $stemming;
1645 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1647 # Handle Field Weighting
1648 my $weighted_operand;
1649 if ($weight_fields) {
1650 $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1651 $operand = $weighted_operand;
1652 $indexes_set = 1;
1655 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1657 ($query,$query_cgi,$query_desc,$previous_operand) = _build_initial_query({
1658 query => $query,
1659 query_cgi => $query_cgi,
1660 query_desc => $query_desc,
1661 operator => ($operators[ $i - 1 ]) ? $operators[ $i - 1 ] : '',
1662 parsed_operand => $operand,
1663 original_operand => ($operands[$i]) ? $operands[$i] : '',
1664 index => $index,
1665 index_plus => $index_plus,
1666 indexes_set => $indexes_set,
1667 previous_operand => $previous_operand,
1670 } #/if $operands
1671 } # /for
1673 warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1675 # add limits
1676 my %group_OR_limits;
1677 my $availability_limit;
1678 foreach my $this_limit (@limits) {
1679 next unless $this_limit;
1680 if ( $this_limit =~ /available/ ) {
1682 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1683 ## In English:
1684 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1685 $availability_limit .=
1686 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1687 $limit_cgi .= "&limit=available";
1688 $limit_desc .= "";
1691 # group_OR_limits, prefixed by mc-
1692 # OR every member of the group
1693 elsif ( $this_limit =~ /mc/ ) {
1694 my ($k,$v) = split(/:/, $this_limit,2);
1695 if ( $k !~ /mc-i(tem)?type/ ) {
1696 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1697 $this_limit =~ tr/"//d;
1698 $this_limit = $k.":'".$v."'";
1701 $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1702 $limit_desc .= " or " if $group_OR_limits{$k};
1703 $group_OR_limits{$k} .= "$this_limit";
1704 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1705 $limit_desc .= " $this_limit";
1708 # Regular old limits
1709 else {
1710 $limit .= " and " if $limit || $query;
1711 $limit .= "$this_limit";
1712 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1713 if ($this_limit =~ /^branch:(.+)/) {
1714 my $branchcode = $1;
1715 my $branchname = GetBranchName($branchcode);
1716 if (defined $branchname) {
1717 $limit_desc .= " branch:$branchname";
1718 } else {
1719 $limit_desc .= " $this_limit";
1721 } else {
1722 $limit_desc .= " $this_limit";
1726 foreach my $k (keys (%group_OR_limits)) {
1727 $limit .= " and " if ( $query || $limit );
1728 $limit .= "($group_OR_limits{$k})";
1730 if ($availability_limit) {
1731 $limit .= " and " if ( $query || $limit );
1732 $limit .= "($availability_limit)";
1735 # Normalize the query and limit strings
1736 # This is flawed , means we can't search anything with : in it
1737 # if user wants to do ccl or cql, start the query with that
1738 # $query =~ s/:/=/g;
1739 #NOTE: We use several several different regexps here as you can't have variable length lookback assertions
1740 $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1741 $query =~ s/(?<=(wrdl)):/=/g;
1742 $query =~ s/(?<=(trn|phr)):/=/g;
1743 $query =~ s/(?<=(st-numeric)):/=/g;
1744 $query =~ s/(?<=(st-year)):/=/g;
1745 $query =~ s/(?<=(st-date-normalized)):/=/g;
1746 $limit =~ s/:/=/g;
1747 for ( $query, $query_desc, $limit, $limit_desc ) {
1748 s/ +/ /g; # remove extra spaces
1749 s/^ //g; # remove any beginning spaces
1750 s/ $//g; # remove any ending spaces
1751 s/==/=/g; # remove double == from query
1753 $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1755 for ($query_cgi,$simple_query) {
1756 s/"//g;
1758 # append the limit to the query
1759 $query .= " " . $limit;
1761 # Warnings if DEBUG
1762 if ($DEBUG) {
1763 warn "QUERY:" . $query;
1764 warn "QUERY CGI:" . $query_cgi;
1765 warn "QUERY DESC:" . $query_desc;
1766 warn "LIMIT:" . $limit;
1767 warn "LIMIT CGI:" . $limit_cgi;
1768 warn "LIMIT DESC:" . $limit_desc;
1769 warn "---------\nLeave buildQuery\n---------";
1772 return (
1773 undef, $query, $simple_query, $query_cgi,
1774 $query_desc, $limit, $limit_cgi, $limit_desc,
1775 $query_type
1779 =head2 _build_initial_query
1781 ($query, $query_cgi, $query_desc, $previous_operand) = _build_initial_query($initial_query_params);
1783 Build a section of the initial query containing indexes, operators, and operands.
1785 =cut
1787 sub _build_initial_query {
1788 my ($params) = @_;
1790 my $operator = "";
1791 if ($params->{previous_operand}){
1792 #If there is a previous operand, add a supplied operator or the default 'and'
1793 $operator = ($params->{operator}) ? " ".($params->{operator})." " : ' and ';
1796 #NOTE: indexes_set is typically set when doing truncation or field weighting
1797 my $operand = ($params->{indexes_set}) ? $params->{parsed_operand} : $params->{index_plus}.$params->{parsed_operand};
1799 #e.g. "kw,wrdl:test"
1800 #e.g. " and kw,wrdl:test"
1801 $params->{query} .= $operator . $operand;
1803 $params->{query_cgi} .= "&op=".uri_escape_utf8($operator) if $operator;
1804 $params->{query_cgi} .= "&idx=".uri_escape_utf8($params->{index}) if $params->{index};
1805 $params->{query_cgi} .= "&q=".uri_escape_utf8($params->{original_operand}) if $params->{original_operand};
1807 #e.g. " and kw,wrdl: test"
1808 $params->{query_desc} .= $operator . $params->{index_plus} . " " . $params->{original_operand};
1810 $params->{previous_operand} = 1 unless $params->{previous_operand}; #If there is no previous operand, mark this as one
1812 return ($params->{query}, $params->{query_cgi}, $params->{query_desc}, $params->{previous_operand});
1815 =head2 searchResults
1817 my @search_results = searchResults($search_context, $searchdesc, $hits,
1818 $results_per_page, $offset, $scan,
1819 @marcresults);
1821 Format results in a form suitable for passing to the template
1823 =cut
1825 # IMO this subroutine is pretty messy still -- it's responsible for
1826 # building the HTML output for the template
1827 sub searchResults {
1828 my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1829 my $dbh = C4::Context->dbh;
1830 my @newresults;
1832 require C4::Items;
1834 $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1835 my ($is_opac, $hidelostitems);
1836 if ($search_context eq 'opac') {
1837 $hidelostitems = C4::Context->preference('hidelostitems');
1838 $is_opac = 1;
1841 #Build branchnames hash
1842 #find branchname
1843 #get branch information.....
1844 my %branches;
1845 my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1846 $bsth->execute();
1847 while ( my $bdata = $bsth->fetchrow_hashref ) {
1848 $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1850 # FIXME - We build an authorised values hash here, using the default framework
1851 # though it is possible to have different authvals for different fws.
1853 my $shelflocations =GetKohaAuthorisedValues('items.location','');
1855 # get notforloan authorised value list (see $shelflocations FIXME)
1856 my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1858 #Get itemtype hash
1859 my %itemtypes = %{ GetItemTypes() };
1861 #search item field code
1862 my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber", "" );
1864 ## find column names of items related to MARC
1865 my %subfieldstosearch;
1866 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
1867 for my $column ( @columns ) {
1868 my ( $tagfield, $tagsubfield ) =
1869 &GetMarcFromKohaField( "items." . $column, "" );
1870 if ( defined $tagsubfield ) {
1871 $subfieldstosearch{$column} = $tagsubfield;
1875 # handle which records to actually retrieve
1876 my $times;
1877 if ( $hits && $offset + $results_per_page <= $hits ) {
1878 $times = $offset + $results_per_page;
1880 else {
1881 $times = $hits; # FIXME: if $hits is undefined, why do we want to equal it?
1884 my $marcflavour = C4::Context->preference("marcflavour");
1885 # We get the biblionumber position in MARC
1886 my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1888 # set stuff for XSLT processing here once, not later again for every record we retrieved
1889 my $interface = $search_context eq 'opac' ? 'OPAC' : '';
1890 my $xslsyspref = $interface . "XSLTResultsDisplay";
1891 my $xslfile = C4::Context->preference($xslsyspref);
1892 my $lang = $xslfile ? C4::Languages::getlanguage() : undef;
1893 my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
1895 # loop through all of the records we've retrieved
1896 for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1898 my $marcrecord;
1899 if ($scan) {
1900 # For Scan searches we built USMARC data
1901 $marcrecord = MARC::Record->new_from_usmarc( $marcresults->[$i]);
1902 } else {
1903 # Normal search, render from Zebra's output
1904 $marcrecord = new_record_from_zebra(
1905 'biblioserver',
1906 $marcresults->[$i]
1909 if ( ! defined $marcrecord ) {
1910 warn "ERROR DECODING RECORD - $@: " . $marcresults->[$i];
1911 next;
1915 my $fw = $scan
1916 ? undef
1917 : $bibliotag < 10
1918 ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1919 : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1921 SetUTF8Flag($marcrecord);
1922 my $oldbiblio = TransformMarcToKoha( $marcrecord, $fw );
1923 $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1924 $oldbiblio->{result_number} = $i + 1;
1926 # add imageurl to itemtype if there is one
1927 $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1929 $oldbiblio->{normalized_upc} = GetNormalizedUPC( $marcrecord,$marcflavour);
1930 $oldbiblio->{normalized_ean} = GetNormalizedEAN( $marcrecord,$marcflavour);
1931 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1932 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1933 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1935 # edition information, if any
1936 $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1937 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{translated_description};
1938 # Build summary if there is one (the summary is defined in the itemtypes table)
1939 # FIXME: is this used anywhere, I think it can be commented out? -- JF
1940 if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1941 my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1942 my @fields = $marcrecord->fields();
1944 my $newsummary;
1945 foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1946 my $tags = {};
1947 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1948 $tag =~ /(.{3})(.)/;
1949 if($marcrecord->field($1)){
1950 my @abc = $marcrecord->field($1)->subfield($2);
1951 $tags->{$tag} = $#abc + 1 ;
1955 # We catch how many times to repeat this line
1956 my $max = 0;
1957 foreach my $tag (keys(%$tags)){
1958 $max = $tags->{$tag} if($tags->{$tag} > $max);
1961 # we replace, and repeat each line
1962 for (my $i = 0 ; $i < $max ; $i++){
1963 my $newline = $line;
1965 foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1966 $tag =~ /(.{3})(.)/;
1968 if($marcrecord->field($1)){
1969 my @repl = $marcrecord->field($1)->subfield($2);
1970 my $subfieldvalue = $repl[$i];
1971 $newline =~ s/\[$tag\]/$subfieldvalue/g;
1974 $newsummary .= "$newline\n";
1978 $newsummary =~ s/\[(.*?)]//g;
1979 $newsummary =~ s/\n/<br\/>/g;
1980 $oldbiblio->{summary} = $newsummary;
1983 # Pull out the items fields
1984 my @fields = $marcrecord->field($itemtag);
1985 my $marcflavor = C4::Context->preference("marcflavour");
1986 # adding linked items that belong to host records
1987 my $analyticsfield = '773';
1988 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1989 $analyticsfield = '773';
1990 } elsif ($marcflavor eq 'UNIMARC') {
1991 $analyticsfield = '461';
1993 foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
1994 my $hostbiblionumber = $hostfield->subfield("0");
1995 my $linkeditemnumber = $hostfield->subfield("9");
1996 if(!$hostbiblionumber eq undef){
1997 my $hostbiblio = GetMarcBiblio($hostbiblionumber, 1);
1998 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
1999 if(!$hostbiblio eq undef){
2000 my @hostitems = $hostbiblio->field($itemfield);
2001 foreach my $hostitem (@hostitems){
2002 if ($hostitem->subfield("9") eq $linkeditemnumber){
2003 my $linkeditem =$hostitem;
2004 # append linked items if they exist
2005 if (!$linkeditem eq undef){
2006 push (@fields, $linkeditem);}
2013 # Setting item statuses for display
2014 my @available_items_loop;
2015 my @onloan_items_loop;
2016 my @other_items_loop;
2018 my $available_items;
2019 my $onloan_items;
2020 my $other_items;
2022 my $ordered_count = 0;
2023 my $available_count = 0;
2024 my $onloan_count = 0;
2025 my $longoverdue_count = 0;
2026 my $other_count = 0;
2027 my $withdrawn_count = 0;
2028 my $itemlost_count = 0;
2029 my $hideatopac_count = 0;
2030 my $itembinding_count = 0;
2031 my $itemdamaged_count = 0;
2032 my $item_in_transit_count = 0;
2033 my $can_place_holds = 0;
2034 my $item_onhold_count = 0;
2035 my $notforloan_count = 0;
2036 my $items_count = scalar(@fields);
2037 my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
2038 my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
2039 my @hiddenitems; # hidden itemnumbers based on OpacHiddenItems syspref
2041 # loop through every item
2042 foreach my $field (@fields) {
2043 my $item;
2045 # populate the items hash
2046 foreach my $code ( keys %subfieldstosearch ) {
2047 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
2049 $item->{description} = $itemtypes{ $item->{itype} }{translated_description};
2051 # OPAC hidden items
2052 if ($is_opac) {
2053 # hidden because lost
2054 if ($hidelostitems && $item->{itemlost}) {
2055 $hideatopac_count++;
2056 next;
2058 # hidden based on OpacHiddenItems syspref
2059 my @hi = C4::Items::GetHiddenItemnumbers($item);
2060 if (scalar @hi) {
2061 push @hiddenitems, @hi;
2062 $hideatopac_count++;
2063 next;
2067 my $hbranch = C4::Context->preference('StaffSearchResultsDisplayBranch');
2068 my $otherbranch = $hbranch eq 'homebranch' ? 'holdingbranch' : 'homebranch';
2070 # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
2071 if ($item->{$hbranch}) {
2072 $item->{'branchname'} = $branches{$item->{$hbranch}};
2074 elsif ($item->{$otherbranch}) { # Last resort
2075 $item->{'branchname'} = $branches{$item->{$otherbranch}};
2078 my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
2079 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
2080 my $userenv = C4::Context->userenv;
2081 if ( $item->{onloan}
2082 && !( C4::Members::GetHideLostItemsPreference( $userenv->{'number'} ) && $item->{itemlost} ) )
2084 $onloan_count++;
2085 my $key = $prefix . $item->{onloan} . $item->{barcode};
2086 $onloan_items->{$key}->{due_date} = output_pref( { dt => dt_from_string( $item->{onloan} ), dateonly => 1 } );
2087 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
2088 $onloan_items->{$key}->{branchname} = $item->{branchname};
2089 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2090 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
2091 $onloan_items->{$key}->{description} = $item->{description};
2092 $onloan_items->{$key}->{imageurl} =
2093 getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2095 # if something's checked out and lost, mark it as 'long overdue'
2096 if ( $item->{itemlost} ) {
2097 $onloan_items->{$key}->{longoverdue}++;
2098 $longoverdue_count++;
2100 else { # can place holds as long as item isn't lost
2101 $can_place_holds = 1;
2105 # items not on loan, but still unavailable ( lost, withdrawn, damaged )
2106 else {
2108 $item->{notforloan}=1 if !$item->{notforloan} && $itemtypes{ C4::Context->preference("item-level_itypes")? $item->{itype}: $oldbiblio->{itemtype} }->{notforloan};
2110 # item is on order
2111 if ( $item->{notforloan} < 0 ) {
2112 $ordered_count++;
2113 } elsif ( $item->{notforloan} > 0 ) {
2114 $notforloan_count++;
2117 # is item in transit?
2118 my $transfertwhen = '';
2119 my ($transfertfrom, $transfertto);
2121 # is item on the reserve shelf?
2122 my $reservestatus = '';
2124 unless ($item->{withdrawn}
2125 || $item->{itemlost}
2126 || $item->{damaged}
2127 || $item->{notforloan}
2128 || ( C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck')
2129 && $items_count > C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck') ) ) {
2131 # A couple heuristics to limit how many times
2132 # we query the database for item transfer information, sacrificing
2133 # accuracy in some cases for speed;
2135 # 1. don't query if item has one of the other statuses
2136 # 2. don't check transit status if the bib has
2137 # more than 20 items
2139 # FIXME: to avoid having the query the database like this, and to make
2140 # the in transit status count as unavailable for search limiting,
2141 # should map transit status to record indexed in Zebra.
2143 ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
2144 $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
2147 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
2148 if ( $item->{withdrawn}
2149 || $item->{itemlost}
2150 || $item->{damaged}
2151 || $item->{notforloan}
2152 || $reservestatus eq 'Waiting'
2153 || ($transfertwhen ne ''))
2155 $withdrawn_count++ if $item->{withdrawn};
2156 $itemlost_count++ if $item->{itemlost};
2157 $itemdamaged_count++ if $item->{damaged};
2158 $item_in_transit_count++ if $transfertwhen ne '';
2159 $item_onhold_count++ if $reservestatus eq 'Waiting';
2160 $item->{status} = $item->{withdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
2162 # can place a hold on a item if
2163 # not lost nor withdrawn
2164 # not damaged unless AllowHoldsOnDamagedItems is true
2165 # item is either for loan or on order (notforloan < 0)
2166 $can_place_holds = 1
2167 if (
2168 !$item->{itemlost}
2169 && !$item->{withdrawn}
2170 && ( !$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems') )
2171 && ( !$item->{notforloan} || $item->{notforloan} < 0 )
2174 $other_count++;
2176 my $key = $prefix . $item->{status};
2177 foreach (qw(withdrawn itemlost damaged branchname itemcallnumber)) {
2178 $other_items->{$key}->{$_} = $item->{$_};
2180 $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
2181 $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
2182 $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
2183 $other_items->{$key}->{count}++ if $item->{$hbranch};
2184 $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2185 $other_items->{$key}->{description} = $item->{description};
2186 $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2188 # item is available
2189 else {
2190 $can_place_holds = 1;
2191 $available_count++;
2192 $available_items->{$prefix}->{count}++ if $item->{$hbranch};
2193 foreach (qw(branchname itemcallnumber description)) {
2194 $available_items->{$prefix}->{$_} = $item->{$_};
2196 $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
2197 $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2200 } # notforloan, item level and biblioitem level
2202 # if all items are hidden, do not show the record
2203 if ($items_count > 0 && $hideatopac_count == $items_count) {
2204 next;
2207 my ( $availableitemscount, $onloanitemscount, $otheritemscount );
2208 for my $key ( sort keys %$onloan_items ) {
2209 (++$onloanitemscount > $maxitems) and last;
2210 push @onloan_items_loop, $onloan_items->{$key};
2212 for my $key ( sort keys %$other_items ) {
2213 (++$otheritemscount > $maxitems) and last;
2214 push @other_items_loop, $other_items->{$key};
2216 for my $key ( sort keys %$available_items ) {
2217 (++$availableitemscount > $maxitems) and last;
2218 push @available_items_loop, $available_items->{$key}
2221 # XSLT processing of some stuff
2222 # we fetched the sysprefs already before the loop through all retrieved record!
2223 if (!$scan && $xslfile) {
2224 $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $xslsyspref, 1, \@hiddenitems, $sysxml, $xslfile, $lang);
2225 # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
2228 # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
2229 if (!C4::Context->preference("item-level_itypes")) {
2230 if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
2231 $can_place_holds = 0;
2234 $oldbiblio->{norequests} = 1 unless $can_place_holds;
2235 $oldbiblio->{itemsplural} = 1 if $items_count > 1;
2236 $oldbiblio->{items_count} = $items_count;
2237 $oldbiblio->{available_items_loop} = \@available_items_loop;
2238 $oldbiblio->{onloan_items_loop} = \@onloan_items_loop;
2239 $oldbiblio->{other_items_loop} = \@other_items_loop;
2240 $oldbiblio->{availablecount} = $available_count;
2241 $oldbiblio->{availableplural} = 1 if $available_count > 1;
2242 $oldbiblio->{onloancount} = $onloan_count;
2243 $oldbiblio->{onloanplural} = 1 if $onloan_count > 1;
2244 $oldbiblio->{othercount} = $other_count;
2245 $oldbiblio->{otherplural} = 1 if $other_count > 1;
2246 $oldbiblio->{withdrawncount} = $withdrawn_count;
2247 $oldbiblio->{itemlostcount} = $itemlost_count;
2248 $oldbiblio->{damagedcount} = $itemdamaged_count;
2249 $oldbiblio->{intransitcount} = $item_in_transit_count;
2250 $oldbiblio->{onholdcount} = $item_onhold_count;
2251 $oldbiblio->{orderedcount} = $ordered_count;
2252 $oldbiblio->{notforloancount} = $notforloan_count;
2254 if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
2255 my $fieldspec = C4::Context->preference("AlternateHoldingsField");
2256 my $subfields = substr $fieldspec, 3;
2257 my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
2258 my @alternateholdingsinfo = ();
2259 my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
2260 my $alternateholdingscount = 0;
2262 for my $field (@holdingsfields) {
2263 my %holding = ( holding => '' );
2264 my $havesubfield = 0;
2265 for my $subfield ($field->subfields()) {
2266 if ((index $subfields, $$subfield[0]) >= 0) {
2267 $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
2268 $holding{'holding'} .= $$subfield[1];
2269 $havesubfield++;
2272 if ($havesubfield) {
2273 push(@alternateholdingsinfo, \%holding);
2274 $alternateholdingscount++;
2278 $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
2279 $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
2282 push( @newresults, $oldbiblio );
2285 return @newresults;
2288 =head2 SearchAcquisitions
2289 Search for acquisitions
2290 =cut
2292 sub SearchAcquisitions{
2293 my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
2295 my $dbh=C4::Context->dbh;
2296 # Variable initialization
2297 my $str=qq|
2298 SELECT marcxml
2299 FROM biblio
2300 LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
2301 LEFT JOIN items ON items.biblionumber=biblio.biblionumber
2302 WHERE dateaccessioned BETWEEN ? AND ?
2305 my (@params,@loopcriteria);
2307 push @params, $datebegin->output("iso");
2308 push @params, $dateend->output("iso");
2310 if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
2311 if(C4::Context->preference("item-level_itypes")){
2312 $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2313 }else{
2314 $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2316 push @params, @$itemtypes;
2319 if ($criteria =~/itemtype/){
2320 if(C4::Context->preference("item-level_itypes")){
2321 $str .= "AND items.itype=? ";
2322 }else{
2323 $str .= "AND biblioitems.itemtype=? ";
2326 if(scalar(@$itemtypes) == 0){
2327 my $itypes = GetItemTypes();
2328 for my $key (keys %$itypes){
2329 push @$itemtypes, $key;
2333 @loopcriteria= @$itemtypes;
2334 }elsif ($criteria=~/itemcallnumber/){
2335 $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
2336 OR items.itemcallnumber is NULL
2337 OR items.itemcallnumber = '')";
2339 @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
2340 }else {
2341 $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
2342 @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
2345 if ($orderby =~ /date_desc/){
2346 $str.=" ORDER BY dateaccessioned DESC";
2347 } else {
2348 $str.=" ORDER BY title";
2351 my $qdataacquisitions=$dbh->prepare($str);
2353 my @loopacquisitions;
2354 foreach my $value(@loopcriteria){
2355 push @params,$value;
2356 my %cell;
2357 $cell{"title"}=$value;
2358 $cell{"titlecode"}=$value;
2360 eval{$qdataacquisitions->execute(@params);};
2362 if ($@){ warn "recentacquisitions Error :$@";}
2363 else {
2364 my @loopdata;
2365 while (my $data=$qdataacquisitions->fetchrow_hashref){
2366 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
2368 $cell{"loopdata"}=\@loopdata;
2370 push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
2371 pop @params;
2373 $qdataacquisitions->finish;
2374 return \@loopacquisitions;
2377 =head2 enabled_staff_search_views
2379 %hash = enabled_staff_search_views()
2381 This function returns a hash that contains three flags obtained from the system
2382 preferences, used to determine whether a particular staff search results view
2383 is enabled.
2385 =over 2
2387 =item C<Output arg:>
2389 * $hash{can_view_MARC} is true only if the MARC view is enabled
2390 * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2391 * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2393 =item C<usage in the script:>
2395 =back
2397 $template->param ( C4::Search::enabled_staff_search_views );
2399 =cut
2401 sub enabled_staff_search_views
2403 return (
2404 can_view_MARC => C4::Context->preference('viewMARC'), # 1 if the staff search allows the MARC view
2405 can_view_ISBD => C4::Context->preference('viewISBD'), # 1 if the staff search allows the ISBD view
2406 can_view_labeledMARC => C4::Context->preference('viewLabeledMARC'), # 1 if the staff search allows the Labeled MARC view
2410 =head2 z3950_search_args
2412 $arrayref = z3950_search_args($matchpoints)
2414 This function returns an array reference that contains the search parameters to be
2415 passed to the Z39.50 search script (z3950_search.pl). The array elements
2416 are hash refs whose keys are name and value, and whose values are the
2417 name of a search parameter, the value of that search parameter and the URL encoded
2418 value of that parameter.
2420 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2422 The search parameter values are obtained from the bibliographic record whose
2423 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2425 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2426 a general purpose search argument. In this case, the returned array contains only
2427 entry: the key is 'title' and the value is derived from $matchpoints.
2429 If a search parameter value is undefined or empty, it is not included in the returned
2430 array.
2432 The returned array reference may be passed directly to the template parameters.
2434 =over 2
2436 =item C<Output arg:>
2438 * $array containing hash refs as described above
2440 =item C<usage in the script:>
2442 =back
2444 $data = Biblio::GetBiblioData($bibno);
2445 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2447 *OR*
2449 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2451 =cut
2453 sub z3950_search_args {
2454 my $bibrec = shift;
2456 my $isbn_string = ref( $bibrec ) ? $bibrec->{title} : $bibrec;
2457 my $isbn = Business::ISBN->new( $isbn_string );
2459 if (defined $isbn && $isbn->is_valid)
2461 if ( ref($bibrec) ) {
2462 $bibrec->{isbn} = $isbn_string;
2463 $bibrec->{title} = undef;
2464 } else {
2465 $bibrec = { isbn => $isbn_string };
2468 else {
2469 $bibrec = { title => $bibrec } if !ref $bibrec;
2471 my $array = [];
2472 for my $field (qw/ lccn isbn issn title author dewey subject /)
2474 push @$array, { name => $field, value => $bibrec->{$field} }
2475 if defined $bibrec->{$field};
2477 return $array;
2480 =head2 GetDistinctValues($field);
2482 C<$field> is a reference to the fields array
2484 =cut
2486 sub GetDistinctValues {
2487 my ($fieldname,$string)=@_;
2488 # returns a reference to a hash of references to branches...
2489 if ($fieldname=~/\./){
2490 my ($table,$column)=split /\./, $fieldname;
2491 my $dbh = C4::Context->dbh;
2492 warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2493 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 ");
2494 $sth->execute;
2495 my $elements=$sth->fetchall_arrayref({});
2496 return $elements;
2498 else {
2499 $string||= qq("");
2500 my @servers=qw<biblioserver authorityserver>;
2501 my (@zconns,@results);
2502 for ( my $i = 0 ; $i < @servers ; $i++ ) {
2503 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2504 $results[$i] =
2505 $zconns[$i]->scan(
2506 ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2509 # The big moment: asynchronously retrieve results from all servers
2510 my @elements;
2511 _ZOOM_event_loop(
2512 \@zconns,
2513 \@results,
2514 sub {
2515 my ( $i, $size ) = @_;
2516 for ( my $j = 0 ; $j < $size ; $j++ ) {
2517 my %hashscan;
2518 @hashscan{qw(value cnt)} =
2519 $results[ $i - 1 ]->display_term($j);
2520 push @elements, \%hashscan;
2524 return \@elements;
2528 =head2 _ZOOM_event_loop
2530 _ZOOM_event_loop(\@zconns, \@results, sub {
2531 my ( $i, $size ) = @_;
2532 ....
2533 } );
2535 Processes a ZOOM event loop and passes control to a closure for
2536 processing the results, and destroying the resultsets.
2538 =cut
2540 sub _ZOOM_event_loop {
2541 my ($zconns, $results, $callback) = @_;
2542 while ( ( my $i = ZOOM::event( $zconns ) ) != 0 ) {
2543 my $ev = $zconns->[ $i - 1 ]->last_event();
2544 if ( $ev == ZOOM::Event::ZEND ) {
2545 next unless $results->[ $i - 1 ];
2546 my $size = $results->[ $i - 1 ]->size();
2547 if ( $size > 0 ) {
2548 $callback->($i, $size);
2553 foreach my $result (@$results) {
2554 $result->destroy();
2558 =head2 new_record_from_zebra
2560 Given raw data from a searchengine result set, return a MARC::Record object
2562 This helper function is needed to take into account all the involved
2563 system preferences and configuration variables to properly create the
2564 MARC::Record object.
2566 If we are using GRS-1, then the raw data we get from Zebra should be USMARC
2567 data. If we are using DOM, then it has to be MARCXML.
2569 If we are using elasticsearch, it'll already be a MARC::Record and this
2570 function needs a new name.
2572 =cut
2574 sub new_record_from_zebra {
2576 my $server = shift;
2577 my $raw_data = shift;
2578 # Set the default indexing modes
2579 my $search_engine = C4::Context->preference("SearchEngine");
2580 if ($search_engine eq 'Elasticsearch') {
2581 return $raw_data;
2583 my $index_mode = ( $server eq 'biblioserver' )
2584 ? C4::Context->config('zebra_bib_index_mode') // 'dom'
2585 : C4::Context->config('zebra_auth_index_mode') // 'dom';
2587 my $marc_record = eval {
2588 if ( $index_mode eq 'dom' ) {
2589 MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2590 } else {
2591 MARC::Record->new_from_usmarc( $raw_data );
2595 if ($@) {
2596 return;
2597 } else {
2598 return $marc_record;
2603 END { } # module clean-up code here (global destructor)
2606 __END__
2608 =head1 AUTHOR
2610 Koha Development Team <http://koha-community.org/>
2612 =cut