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>.
21 use C4::Biblio; # GetMarcFromKohaField, GetBiblioData
22 use C4::Koha; # getFacets
26 use C4::Search::PazPar2;
29 use C4::Reserves; # GetReserveStatus
32 use Koha::AuthorisedValues;
41 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
44 $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
49 C4::Search - Functions for searching the Koha catalog.
53 See opac/opac-search.pl or catalogue/search.pl for example of usage
57 This module provides searching functions for Koha's bibliographic databases
71 &enabled_staff_search_views
74 # make all your functions, whether exported or not;
78 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
80 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
86 my $dbh = C4::Context->dbh;
87 my $result = TransformMarcToKoha( $record, '' );
92 my ( $biblionumber, $title );
94 # search duplicate on ISBN, easy and fast..
96 if ( $result->{isbn} ) {
97 $result->{isbn} =~ s/\(.*$//;
98 $result->{isbn} =~ s/\s+$//;
99 $query = "isbn:$result->{isbn}";
103 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser'));
109 $titleindex = 'title|exact';
110 $authorindex = 'author|exact';
112 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
114 $titleindex = 'ti,ext';
115 $authorindex = 'au,ext';
119 $result->{title} =~ s /\\//g;
120 $result->{title} =~ s /\"//g;
121 $result->{title} =~ s /\(//g;
122 $result->{title} =~ s /\)//g;
124 # FIXME: instead of removing operators, could just do
125 # quotes around the value
126 $result->{title} =~ s/(and|or|not)//g;
127 $query = "$titleindex:\"$result->{title}\"";
128 if ( $result->{author} ) {
129 $result->{author} =~ s /\\//g;
130 $result->{author} =~ s /\"//g;
131 $result->{author} =~ s /\(//g;
132 $result->{author} =~ s /\)//g;
134 # remove valid operators
135 $result->{author} =~ s/(and|or|not)//g;
136 $query .= " $op $authorindex:\"$result->{author}\"";
140 my ( $error, $searchresults, undef ) = SimpleSearch($query); # FIXME :: hardcoded !
142 if (!defined $error) {
143 foreach my $possible_duplicate_record (@{$searchresults}) {
144 my $marcrecord = new_record_from_zebra(
146 $possible_duplicate_record
149 my $result = TransformMarcToKoha( $marcrecord, '' );
151 # FIXME :: why 2 $biblionumber ?
153 push @results, $result->{'biblionumber'};
154 push @results, $result->{'title'};
163 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers], [%options] );
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.
175 * %options is optional. (e.g. "skip_normalize" allows you to skip changing : to = )
180 Returns an array consisting of three elements
181 * $error is undefined unless an error is detected
182 * $results is a reference to an array of records.
183 * $total_hits is the number of hits that would have been returned with no limit
185 If an error is returned the two other return elements are undefined. If error itself is undefined
186 the other two elements are always defined
188 =item C<usage in the script:>
192 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
194 if (defined $error) {
195 $template->param(query_error => $error);
196 warn "error: ".$error;
197 output_html_with_http_headers $input, $cookie, $template->output;
201 my $hits = @{$marcresults};
204 for my $r ( @{$marcresults} ) {
205 my $marcrecord = MARC::File::USMARC::decode($r);
206 my $biblio = TransformMarcToKoha($marcrecord,q{});
208 #build the iarray of hashs for the template.
210 title => $biblio->{'title'},
211 subtitle => $biblio->{'subtitle'},
212 biblionumber => $biblio->{'biblionumber'},
213 author => $biblio->{'author'},
214 publishercode => $biblio->{'publishercode'},
215 publicationyear => $biblio->{'publicationyear'},
220 $template->param(result=>\@results);
225 my ( $query, $offset, $max_results, $servers, %options ) = @_;
227 return ( 'No query entered', undef, undef ) unless $query;
228 # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
229 my @servers = defined ( $servers ) ? @$servers : ( 'biblioserver' );
237 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') && ! ($query =~ m/\w,\w|\w=\w/));
239 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
242 # Initialize & Search Zebra
243 for ( my $i = 0 ; $i < @servers ; $i++ ) {
245 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
247 $query =~ s/=/:/g unless $options{skip_normalize};
248 $QParser->parse( $query );
249 $query = $QParser->target_syntax($servers[$i]);
250 $zoom_queries[$i] = new ZOOM::Query::PQF( $query, $zconns[$i]);
252 $query =~ s/:/=/g unless $options{skip_normalize};
253 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
255 $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
259 $zconns[$i]->errmsg() . " ("
260 . $zconns[$i]->errcode() . ") "
261 . $zconns[$i]->addinfo() . " "
262 . $zconns[$i]->diagset();
264 return ( $error, undef, undef ) if $zconns[$i]->errcode();
268 # caught a ZOOM::Exception
272 . $@->addinfo() . " "
274 warn $error." for query: $query";
275 return ( $error, undef, undef );
284 my $first_record = defined($offset) ? $offset + 1 : 1;
285 my $hits = $tmpresults[ $i - 1 ]->size();
286 $total_hits += $hits;
287 my $last_record = $hits;
288 if ( defined $max_results && $offset + $max_results < $hits ) {
289 $last_record = $offset + $max_results;
292 for my $j ( $first_record .. $last_record ) {
294 $tmpresults[ $i - 1 ]->record( $j - 1 )->raw()
297 push @{$results}, $record if defined $record;
302 foreach my $zoom_query (@zoom_queries) {
303 $zoom_query->destroy();
306 return ( undef, $results, $total_hits );
311 ( undef, $results_hashref, \@facets_loop ) = getRecords (
313 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
314 $results_per_page, $offset, $branches, $itemtypes,
315 $query_type, $scan, $opac
318 The all singing, all dancing, multi-server, asynchronous, scanning,
319 searching, record nabbing, facet-building
321 See verbose embedded documentation.
327 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
328 $results_per_page, $offset, $branches, $itemtypes,
329 $query_type, $scan, $opac
332 my @servers = @$servers_ref;
333 my @sort_by = @$sort_by_ref;
334 $offset = 0 if $offset < 0;
336 # Initialize variables for the ZOOM connection and results object
340 my $results_hashref = ();
342 # TODO simplify this structure ( { branchcode => $branchname } is enought) and remove this parameter
343 $branches ||= { map { $_->branchcode => { branchname => $_->branchname } } Koha::Libraries->search };
345 # Initialize variables for the faceted results objects
346 my $facets_counter = {};
347 my $facets_info = {};
348 my $facets = getFacets();
350 my @facets_loop; # stores the ref to array of hashes for template facets loop
352 ### LOOP THROUGH THE SERVERS
353 for ( my $i = 0 ; $i < @servers ; $i++ ) {
354 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
356 # perform the search, create the results objects
357 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
358 my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
360 #$query_to_use = $simple_query if $scan;
361 warn $simple_query if ( $scan and $DEBUG );
363 # Check if we've got a query_type defined, if so, use it
366 if ($query_type =~ /^ccl/) {
367 $query_to_use =~ s/\:/\=/g; # change : to = last minute (FIXME)
368 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
369 } elsif ($query_type =~ /^cql/) {
370 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
371 } elsif ($query_type =~ /^pqf/) {
372 $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
374 warn "Unknown query_type '$query_type'. Results undetermined.";
377 $results[$i] = $zconns[$i]->scan( new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
379 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
383 warn "WARNING: query problem with $query_to_use " . $@;
386 # Concatenate the sort_by limits and pass them to the results object
387 # Note: sort will override rank
389 foreach my $sort (@sort_by) {
390 if ( $sort eq "author_az" || $sort eq "author_asc" ) {
391 $sort_by .= "1=1003 <i ";
393 elsif ( $sort eq "author_za" || $sort eq "author_dsc" ) {
394 $sort_by .= "1=1003 >i ";
396 elsif ( $sort eq "popularity_asc" ) {
397 $sort_by .= "1=9003 <i ";
399 elsif ( $sort eq "popularity_dsc" ) {
400 $sort_by .= "1=9003 >i ";
402 elsif ( $sort eq "call_number_asc" ) {
403 $sort_by .= "1=8007 <i ";
405 elsif ( $sort eq "call_number_dsc" ) {
406 $sort_by .= "1=8007 >i ";
408 elsif ( $sort eq "pubdate_asc" ) {
409 $sort_by .= "1=31 <i ";
411 elsif ( $sort eq "pubdate_dsc" ) {
412 $sort_by .= "1=31 >i ";
414 elsif ( $sort eq "acqdate_asc" ) {
415 $sort_by .= "1=32 <i ";
417 elsif ( $sort eq "acqdate_dsc" ) {
418 $sort_by .= "1=32 >i ";
420 elsif ( $sort eq "title_az" || $sort eq "title_asc" ) {
421 $sort_by .= "1=4 <i ";
423 elsif ( $sort eq "title_za" || $sort eq "title_dsc" ) {
424 $sort_by .= "1=4 >i ";
427 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
430 if ( $sort_by && !$scan && $results[$i] ) {
431 if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
432 warn "WARNING sort $sort_by failed";
435 } # finished looping through servers
437 # The big moment: asynchronously retrieve results from all servers
442 my ( $i, $size ) = @_;
445 # loop through the results
446 $results_hash->{'hits'} = $size;
448 if ( $offset + $results_per_page <= $size ) {
449 $times = $offset + $results_per_page;
455 for ( my $j = $offset ; $j < $times ; $j++ ) {
459 ## Check if it's an index scan
461 my ( $term, $occ ) = $results[ $i - 1 ]->display_term($j);
463 # here we create a minimal MARC record and hand it off to the
464 # template just like a normal result ... perhaps not ideal, but
466 my $tmprecord = MARC::Record->new();
467 $tmprecord->encoding('UTF-8');
471 # the minimal record in author/title (depending on MARC flavour)
472 if ( C4::Context->preference("marcflavour") eq
475 $tmptitle = MARC::Field->new(
480 $tmprecord->append_fields($tmptitle);
484 MARC::Field->new( '245', ' ', ' ', a => $term, );
486 MARC::Field->new( '100', ' ', ' ', a => $occ, );
487 $tmprecord->append_fields($tmptitle);
488 $tmprecord->append_fields($tmpauthor);
490 $results_hash->{'RECORDS'}[$j] =
491 $tmprecord->as_usmarc();
496 $record = $results[ $i - 1 ]->record($j)->raw();
497 # warn "RECORD $j:".$record;
498 $results_hash->{'RECORDS'}[$j] = $record;
502 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
504 # Fill the facets while we're looping, but only for the
505 # biblioserver and not for a scan
506 if ( !$scan && $servers[ $i - 1 ] =~ /biblioserver/ ) {
507 $facets_counter = GetFacets( $results[ $i - 1 ] );
508 $facets_info = _get_facets_info( $facets );
512 if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
514 sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
515 keys %$facets_counter
518 my @this_facets_array;
521 $facets_counter->{$link_value}
522 ->{$b} <=> $facets_counter->{$link_value}
524 } keys %{ $facets_counter->{$link_value} }
527 # Sanitize the link value : parenthesis, question and exclamation mark will cause errors with CCL
528 my $facet_link_value = $one_facet;
529 $facet_link_value =~ s/[()!?¡¿؟]/ /g;
531 # fix the length that will display in the label,
532 my $facet_label_value = $one_facet;
533 my $facet_max_length = C4::Context->preference(
534 'FacetLabelTruncationLength')
537 substr( $one_facet, 0, $facet_max_length )
539 if length($facet_label_value) >
542 # if it's a branch, label by the name, not the code,
543 if ( $link_value =~ /branch/ ) {
544 if ( defined $branches
545 && ref($branches) eq "HASH"
546 && defined $branches->{$one_facet}
547 && ref( $branches->{$one_facet} ) eq
551 $branches->{$one_facet}
555 $facet_label_value = "*";
559 # if it's a itemtype, label by the name, not the code,
560 if ( $link_value =~ /itype/ ) {
561 if ( defined $itemtypes
562 && ref($itemtypes) eq "HASH"
563 && defined $itemtypes->{$one_facet}
564 && ref( $itemtypes->{$one_facet} ) eq
568 $itemtypes->{$one_facet}
569 ->{translated_description};
573 # also, if it's a location code, use the name instead of the code
574 if ( $link_value =~ /location/ ) {
575 # TODO Retrieve all authorised values at once, instead of 1 query per entry
576 my $av = Koha::AuthorisedValues->search({ category => 'LOC', authorised_value => $one_facet });
577 $facet_label_value = $av->count ? $av->next->opac_description : '';
580 # also, if it's a collection code, use the name instead of the code
581 if ( $link_value =~ /ccode/ ) {
582 # TODO Retrieve all authorised values at once, instead of 1 query per entry
583 my $av = Koha::AuthorisedValues->search({ category => 'CCODE', authorised_value => $one_facet });
584 $facet_label_value = $av->count ? $av->next->opac_description : '';
587 # but we're down with the whole label being in the link's title.
588 push @this_facets_array,
591 $facets_counter->{$link_value}
593 facet_label_value => $facet_label_value,
594 facet_title_value => $one_facet,
595 facet_link_value => $facet_link_value,
596 type_link_value => $link_value,
598 if ($facet_label_value);
603 type_link_value => $link_value,
604 type_id => $link_value . "_id",
606 . $facets_info->{$link_value}->{'label_value'} =>
608 facets => \@this_facets_array,
612 $facets_info->{$link_value}->{'label_value'} =~
615 and ( Koha::Libraries->search->count == 1 )
622 # This sorts the facets into alphabetical order
624 foreach my $f (@facets_loop) {
625 $f->{facets} = [ sort { uc($a->{facet_label_value}) cmp uc($b->{facet_label_value}) } @{ $f->{facets} } ];
627 @facets_loop = sort {defined $a->{expand} && defined $b->{expand} && $a->{expand} cmp $b->{expand}} @facets_loop;
630 return ( undef, $results_hashref, \@facets_loop );
638 my $use_zebra_facets = C4::Context->config('use_zebra_facets') // 0;
640 if ( $use_zebra_facets ) {
641 $facets = _get_facets_from_zebra( $rs );
643 $facets = _get_facets_from_records( $rs );
649 sub _get_facets_from_records {
653 my $facets_maxrecs = C4::Context->preference('maxRecordsForFacets') // 20;
654 my $facets_config = getFacets();
656 my $size = $rs->size();
657 my $jmax = $size > $facets_maxrecs
661 for ( my $j = 0 ; $j < $jmax ; $j++ ) {
663 my $marc_record = new_record_from_zebra (
665 $rs->record( $j )->raw()
668 if ( ! defined $marc_record ) {
669 warn "ERROR DECODING RECORD - $@: " .
670 $rs->record( $j )->raw();
674 _get_facets_data_from_record( $marc_record, $facets_config, $facets );
680 =head2 _get_facets_data_from_record
682 C4::Search::_get_facets_data_from_record( $marc_record, $facets, $facets_counter );
684 Internal function that extracts facets information from a MARC::Record object
685 and populates $facets_counter for using in getRecords.
687 $facets is expected to be filled with C4::Koha::getFacets output (i.e. the configured
692 sub _get_facets_data_from_record {
694 my ( $marc_record, $facets, $facets_counter ) = @_;
696 for my $facet (@$facets) {
700 foreach my $tag ( @{ $facet->{ tags } } ) {
702 # tag number is the first three digits
703 my $tag_num = substr( $tag, 0, 3 );
704 # subfields are the remainder
705 my $subfield_letters = substr( $tag, 3 );
707 my @fields = $marc_record->field( $tag_num );
708 foreach my $field (@fields) {
709 # If $field->indicator(1) eq 'z', it means it is a 'see from'
710 # field introduced because of IncludeSeeFromInSearches, so skip it
711 next if $field->indicator(1) eq 'z';
713 my $data = $field->as_string( $subfield_letters, $facet->{ sep } );
715 unless ( grep { $_ eq $data } @used_datas ) {
716 push @used_datas, $data;
717 $facets_counter->{ $facet->{ idx } }->{ $data }++;
724 =head2 _get_facets_from_zebra
726 my $facets = _get_facets_from_zebra( $result_set )
728 Retrieves facets for a specified result set. It loops through the facets defined
729 in C4::Koha::getFacets and returns a hash with the following structure:
739 sub _get_facets_from_zebra {
743 # save current elementSetName
744 my $elementSetName = $rs->option( 'elementSetName' );
746 my $facets_loop = getFacets();
747 my $facets_data = {};
748 # loop through defined facets and fill the facets hashref
749 foreach my $facet ( @$facets_loop ) {
751 my $idx = $facet->{ idx };
752 my $sep = $facet->{ sep };
753 my $facet_values = _get_facet_from_result_set( $idx, $rs, $sep );
754 if ( $facet_values ) {
755 # we've actually got a result
756 $facets_data->{ $idx } = $facet_values;
759 # set elementSetName to its previous value to avoid side effects
760 $rs->option( elementSetName => $elementSetName );
765 =head2 _get_facet_from_result_set
768 C4::Search::_get_facet_from_result_set( $facet_idx, $result_set, $sep )
770 Internal function that extracts facet information for a specific index ($facet_idx) and
771 returns a hash containing facet values and count:
774 $facet_value => $count ,
778 Warning: this function has the side effect of changing the elementSetName for the result
779 set. It is a helper function for the main loop, which takes care of backing it up for
784 sub _get_facet_from_result_set {
786 my $facet_idx = shift;
790 my $internal_sep = '<*>';
791 my $facetMaxCount = C4::Context->preference('FacetMaxCount') // 20;
793 return if ( ! defined $facet_idx || ! defined $rs );
794 # zebra's facet element, untokenized index
795 my $facet_element = 'zebra::facet::' . $facet_idx . ':0:' . $facetMaxCount;
796 # configure zebra results for retrieving the desired facet
797 $rs->option( elementSetName => $facet_element );
798 # get the facet record from result set
799 my $facet = $rs->record( 0 )->raw;
800 # if the facet has no restuls...
801 return if !defined $facet;
802 # TODO: benchmark DOM vs. SAX performance
803 my $facet_dom = XML::LibXML->load_xml(
806 my @terms = $facet_dom->getElementsByTagName('term');
810 foreach my $term ( @terms ) {
811 my $facet_value = $term->textContent;
812 $facet_value =~ s/\Q$internal_sep\E/$sep/ if defined $sep;
813 $facets->{ $facet_value } = $term->getAttribute( 'occur' );
819 =head2 _get_facets_info
821 my $facets_info = C4::Search::_get_facets_info( $facets )
823 Internal function that extracts facets information and properly builds
824 the data structure needed to render facet labels.
828 sub _get_facets_info {
832 my $facets_info = {};
834 for my $facet ( @$facets ) {
835 $facets_info->{ $facet->{ idx } }->{ label_value } = $facet->{ label };
843 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
844 $results_per_page, $offset, $branches, $query_type,
847 #NOTE: Parameter $branches is not used here !
849 my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
851 $paz->search($simple_query);
852 sleep 1; # FIXME: WHY?
855 my $results_hashref = {};
856 my $stats = XMLin($paz->stat);
857 my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
859 # for a grouped search result, the number of hits
860 # is the number of groups returned; 'bib_hits' will have
861 # the total number of bibs.
862 $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
863 $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
865 HIT: foreach my $hit (@{ $results->{'hit'} }) {
866 my $recid = $hit->{recid}->[0];
868 my $work_title = $hit->{'md-work-title'}->[0];
870 if (exists $hit->{'md-work-author'}) {
871 $work_author = $hit->{'md-work-author'}->[0];
873 my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
875 my $result_group = {};
876 $result_group->{'group_label'} = $group_label;
877 $result_group->{'group_merge_key'} = $recid;
880 if (exists $hit->{count}) {
881 $count = $hit->{count}->[0];
883 $result_group->{'group_count'} = $count;
885 for (my $i = 0; $i < $count; $i++) {
886 # FIXME -- may need to worry about diacritics here
887 my $rec = $paz->record($recid, $i);
888 push @{ $result_group->{'RECORDS'} }, $rec;
891 push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
894 # pass through facets
895 my $termlist_xml = $paz->termlist('author,subject');
896 my $terms = XMLin($termlist_xml, forcearray => 1);
897 my @facets_loop = ();
898 #die Dumper($results);
899 # foreach my $list (sort keys %{ $terms->{'list'} }) {
901 # foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
903 # facet_label_value => $facet->{'name'}->[0],
906 # push @facets_loop, ( {
907 # type_label => $list,
908 # facets => \@facets,
912 return ( undef, $results_hashref, \@facets_loop );
916 sub _detect_truncation {
917 my ( $operand, $index ) = @_;
918 my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
921 my @wordlist = split( /\s/, $operand );
922 foreach my $word (@wordlist) {
923 if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
924 push @rightlefttruncated, $word;
926 elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
927 push @lefttruncated, $word;
929 elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
930 push @righttruncated, $word;
932 elsif ( index( $word, "*" ) < 0 ) {
933 push @nontruncated, $word;
936 push @regexpr, $word;
940 \@nontruncated, \@righttruncated, \@lefttruncated,
941 \@rightlefttruncated, \@regexpr
946 sub _build_stemmed_operand {
947 my ($operand,$lang) = @_;
948 require Lingua::Stem::Snowball ;
949 my $stemmed_operand=q{};
951 # Stemmer needs language
952 return $operand unless $lang;
954 # If operand contains a digit, it is almost certainly an identifier, and should
955 # not be stemmed. This is particularly relevant for ISBNs and ISSNs, which
956 # can contain the letter "X" - for example, _build_stemmend_operand would reduce
957 # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
958 # results (e.g., "23 x 29 cm." from the 300$c). Bug 2098.
959 return $operand if $operand =~ /\d/;
961 # FIXME: the locale should be set based on the user's language and/or search choice
963 # Make sure we only use the first two letters from the language code
964 $lang = lc(substr($lang, 0, 2));
965 # The language codes for the two variants of Norwegian will now be "nb" and "nn",
966 # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
967 if ($lang eq 'nb' || $lang eq 'nn') {
970 my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
971 encoding => "UTF-8" );
973 my @words = split( / /, $operand );
974 my @stems = $stemmer->stem(\@words);
975 for my $stem (@stems) {
976 $stemmed_operand .= "$stem";
977 $stemmed_operand .= "?"
978 unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
979 $stemmed_operand .= " ";
981 warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
982 return $stemmed_operand;
986 sub _build_weighted_query {
988 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
989 # pretty well but could work much better if we had a smarter query parser
990 my ( $operand, $stemmed_operand, $index ) = @_;
991 my $stemming = C4::Context->preference("QueryStemming") || 0;
992 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
993 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
994 $operand =~ s/"/ /g; # Bug 7518: searches with quotation marks don't work
996 my $weighted_query .= "(rk=("; # Specifies that we're applying rank
998 # Keyword, or, no index specified
999 if ( ( $index eq 'kw' ) || ( !$index ) ) {
1001 "Title-cover,ext,r1=\"$operand\""; # exact title-cover
1002 $weighted_query .= " or ti,ext,r2=\"$operand\""; # exact title
1003 $weighted_query .= " or Title-cover,phr,r3=\"$operand\""; # phrase title
1004 $weighted_query .= " or ti,wrdl,r4=\"$operand\""; # words in title
1005 #$weighted_query .= " or any,ext,r4=$operand"; # exact any
1006 #$weighted_query .=" or kw,wrdl,r5=\"$operand\""; # word list any
1007 $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
1008 if $fuzzy_enabled; # add fuzzy, word list
1009 $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
1010 if ( $stemming and $stemmed_operand )
1011 ; # add stemming, right truncation
1012 $weighted_query .= " or wrdl,r9=\"$operand\"";
1014 # embedded sorting: 0 a-z; 1 z-a
1015 # $weighted_query .= ") or (sort1,aut=1";
1018 # Barcode searches should skip this process
1019 elsif ( $index eq 'bc' ) {
1020 $weighted_query .= "bc=\"$operand\"";
1023 # Authority-number searches should skip this process
1024 elsif ( $index eq 'an' ) {
1025 $weighted_query .= "an=\"$operand\"";
1028 # If the index is numeric, don't autoquote it.
1029 elsif ( $index =~ /,st-numeric$/ ) {
1030 $weighted_query .= " $index=$operand";
1033 # If the index already has more than one qualifier, wrap the operand
1034 # in quotes and pass it back (assumption is that the user knows what they
1035 # are doing and won't appreciate us mucking up their query
1036 elsif ( $index =~ ',' ) {
1037 $weighted_query .= " $index=\"$operand\"";
1040 #TODO: build better cases based on specific search indexes
1042 $weighted_query .= " $index,ext,r1=\"$operand\""; # exact index
1043 #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
1044 $weighted_query .= " or $index,phr,r3=\"$operand\""; # phrase index
1045 $weighted_query .= " or $index,wrdl,r6=\"$operand\""; # word list index
1046 $weighted_query .= " or $index,wrdl,fuzzy,r8=\"$operand\""
1047 if $fuzzy_enabled; # add fuzzy, word list
1048 $weighted_query .= " or $index,wrdl,rt,r9=\"$stemmed_operand\""
1049 if ( $stemming and $stemmed_operand ); # add stemming, right truncation
1052 $weighted_query .= "))"; # close rank specification
1053 return $weighted_query;
1058 Return an array with available indexes.
1082 'Author-personal-bibliography',
1092 'Chronological-subdivision',
1102 'Conference-name-heading',
1103 'Conference-name-see',
1104 'Conference-name-seealso',
1109 'Corporate-name-heading',
1110 'Corporate-name-see',
1111 'Corporate-name-seealso',
1112 'Country-publication',
1115 'date-entered-on-file',
1116 'Date-of-acquisition',
1117 'Date-of-publication',
1118 'Date-time-last-modified',
1119 'Dewey-classification',
1120 'Dissertation-information',
1129 'Geographic-subdivision',
1132 'Heading-use-main-or-added-entry',
1133 'Heading-use-series-added-entry ',
1134 'Heading-use-subject-added-entry',
1138 'Identifier-standard',
1139 'Illustration-code',
1141 'Index-term-uncontrolled',
1142 'Interest-age-level',
1143 'Interest-grade-level',
1153 'language-original',
1163 'Local-classification',
1166 'Match-heading-see-from',
1174 'Name-geographic-heading',
1175 'Name-geographic-see',
1176 'Name-geographic-seealso',
1182 'Other-control-number',
1185 'Personal-name-heading',
1186 'Personal-name-see',
1187 'Personal-name-seealso',
1189 'Place-publication',
1196 'Reading-grade-level',
1197 'Record-control-number',
1208 'Subject-heading-thesaurus',
1209 'Subject-name-personal',
1210 'Subject-subdivision',
1219 'Term-genre-form-heading',
1220 'Term-genre-form-see',
1221 'Term-genre-form-seealso',
1227 'Title-uniform-heading',
1228 'Title-uniform-see',
1229 'Title-uniform-seealso',
1239 'classification-source',
1241 'coded-location-qualifier',
1252 'Local-classification',
1255 'materials-specified',
1260 'Number-local-acquisition',
1265 'replacementpricedate',
1280 =head2 _handle_exploding_index
1282 my $query = _handle_exploding_index($index, $term)
1284 Callback routine to generate the search for "exploding" indexes (i.e.
1285 those indexes which are turned into multiple or-connected searches based
1290 sub _handle_exploding_index {
1291 my ($QParser, $filter, $params, $negate, $server) = @_;
1292 my $index = $filter;
1293 my $term = join(' ', @$params);
1295 return unless ($index =~ m/(su-br|su-na|su-rl)/ && $term);
1297 my $marcflavour = C4::Context->preference('marcflavour');
1299 my $codesubfield = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1300 my $wantedcodes = '';
1301 my @subqueries = ( "\@attr 1=Subject \@attr 4=1 \"$term\"");
1302 my ($error, $results, $total_hits) = SimpleSearch( "he:$term", undef, undef, [ "authorityserver" ] );
1303 foreach my $auth (@$results) {
1304 my $record = MARC::Record->new_from_usmarc($auth);
1305 my @references = $record->field('5..');
1307 if ($index eq 'su-br') {
1309 } elsif ($index eq 'su-na') {
1311 } elsif ($index eq 'su-rl') {
1314 foreach my $reference (@references) {
1315 my $codes = $reference->subfield($codesubfield);
1316 push @subqueries, '@attr 1=Subject @attr 4=1 "' . $reference->as_string('abcdefghijlmnopqrstuvxyz') . '"' if (($codes && $codes eq $wantedcodes) || !$wantedcodes);
1320 my $query = ' @or ' x (scalar(@subqueries) - 1) . join(' ', @subqueries);
1326 ( $operators, $operands, $indexes, $limits,
1327 $sort_by, $scan, $lang ) =
1328 parseQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1330 Shim function to ease the transition from buildQuery to a new QueryParser.
1331 This function is called at the beginning of buildQuery, and modifies
1332 buildQuery's input. If it can handle the input, it returns a query that
1333 buildQuery will not try to parse.
1338 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1340 my @operators = $operators ? @$operators : ();
1341 my @indexes = $indexes ? @$indexes : ();
1342 my @operands = $operands ? @$operands : ();
1343 my @limits = $limits ? @$limits : ();
1344 my @sort_by = $sort_by ? @$sort_by : ();
1346 my $query = $operands[0];
1352 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') || $query =~ s/^qp=//);
1353 undef $QParser if ($query =~ m/^(ccl=|pqf=|cql=)/ || grep (/\w,\w|\w=\w/, @operands, @indexes) );
1354 undef $QParser if (scalar @limits > 0);
1358 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
1360 for ( my $ii = 0 ; $ii <= @operands ; $ii++ ) {
1361 next unless $operands[$ii];
1362 $query .= $operators[$ii-1] && $operators[ $ii - 1 ] eq 'or' ? ' || ' : ' && '
1364 if ( $operands[$ii] =~ /^[^"]\W*[-|_\w]*:\w.*[^"]$/ ) {
1365 $query .= $operands[$ii];
1367 elsif ( $indexes[$ii] && $indexes[$ii] =~ m/su-/ ) {
1368 $query .= $indexes[$ii] . '(' . $operands[$ii] . ')';
1372 ( $indexes[$ii] ? "$indexes[$ii]:" : '' ) . $operands[$ii];
1375 foreach my $limit (@limits) {
1377 if ( scalar(@sort_by) > 0 ) {
1379 '#(' . join( '|', @{ $QParser->modifiers } ) . ')';
1380 $query =~ s/$modifier_re//g;
1381 foreach my $modifier (@sort_by) {
1382 $query .= " #$modifier";
1386 $query_desc = $query;
1387 $query_desc =~ s/\s+/ /g;
1388 if ( C4::Context->preference("QueryWeightFields") ) {
1390 $QParser->add_bib1_filter_map( 'su-br' => 'biblioserver' =>
1391 { 'target_syntax_callback' => \&_handle_exploding_index } );
1392 $QParser->add_bib1_filter_map( 'su-na' => 'biblioserver' =>
1393 { 'target_syntax_callback' => \&_handle_exploding_index } );
1394 $QParser->add_bib1_filter_map( 'su-rl' => 'biblioserver' =>
1395 { 'target_syntax_callback' => \&_handle_exploding_index } );
1396 $QParser->parse($query);
1397 $operands[0] = "pqf=" . $QParser->target_syntax('biblioserver');
1400 require Koha::QueryParser::Driver::PQF;
1401 my $modifier_re = '#(' . join( '|', @{Koha::QueryParser::Driver::PQF->modifiers}) . ')';
1402 s/$modifier_re//g for @operands;
1405 return ( $operators, \@operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc);
1411 $simple_query, $query_cgi,
1412 $query_desc, $limit,
1413 $limit_cgi, $limit_desc,
1414 $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1416 Build queries and limits in CCL, CGI, Human,
1417 handle truncation, stemming, field weighting, fuzziness, etc.
1419 See verbose embedded documentation.
1425 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1427 warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1430 ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc) = parseQuery($operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1433 my @operators = $operators ? @$operators : ();
1434 my @indexes = $indexes ? @$indexes : ();
1435 my @operands = $operands ? @$operands : ();
1436 my @limits = $limits ? @$limits : ();
1437 my @sort_by = $sort_by ? @$sort_by : ();
1439 my $stemming = C4::Context->preference("QueryStemming") || 0;
1440 my $auto_truncation = C4::Context->preference("QueryAutoTruncate") || 0;
1441 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1442 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1444 my $query = $operands[0];
1445 my $simple_query = $operands[0];
1447 # initialize the variables we're passing back
1456 my $cclindexes = getIndexes();
1457 if ( $query !~ /\s*(ccl=|pqf=|cql=)/ ) {
1458 while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1460 $cclq = grep { lc($_) eq $dx } @$cclindexes;
1462 $query = "ccl=$query" if $cclq;
1465 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1467 if ( $query =~ /^ccl=/ ) {
1469 # This is needed otherwise ccl= and &limit won't work together, and
1470 # this happens when selecting a subject on the opac-detail page
1471 @limits = grep {!/^$/} @limits;
1472 my $original_q = $q; # without available part
1473 unless ( grep { $_ eq 'available' } @limits ) {
1474 $q =~ s| and \( \(allrecords,AlwaysMatches=''\) and \(not-onloan-count,st-numeric >= 1\) and \(lost,st-numeric=0\) \)||;
1478 if ( grep { $_ eq 'available' } @limits ) {
1479 $q .= q| and ( (allrecords,AlwaysMatches='') and (not-onloan-count,st-numeric >= 1) and (lost,st-numeric=0) )|;
1480 @limits = grep {!/^available$/} @limits;
1482 $q .= ' and '.join(' and ', @limits) if @limits;
1484 return ( undef, $q, $q, "q=ccl=".uri_escape_utf8($q), $original_q, '', '', '', 'ccl' );
1486 if ( $query =~ /^cql=/ ) {
1487 return ( undef, $', $', "q=cql=".uri_escape_utf8($'), $', '', '', '', 'cql' );
1489 if ( $query =~ /^pqf=/ ) {
1491 $query_cgi = "q=".uri_escape_utf8($query_desc);
1494 $query_cgi = "q=pqf=".uri_escape_utf8($');
1496 return ( undef, $', $', $query_cgi, $query_desc, '', '', '', 'pqf' );
1499 # pass nested queries directly
1500 # FIXME: need better handling of some of these variables in this case
1501 # Nested queries aren't handled well and this implementation is flawed and causes users to be
1502 # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1503 # if ( $query =~ /(\(|\))/ ) {
1505 # undef, $query, $simple_query, $query_cgi,
1506 # $query, $limit, $limit_cgi, $limit_desc,
1511 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1512 # query operands and indexes and add stemming, truncation, field weighting, etc.
1513 # Once we do so, we'll end up with a value in $query, just like if we had an
1514 # incoming $query from the user
1517 ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1518 my $previous_operand
1519 ; # a flag used to keep track if there was a previous query
1520 # if there was, we can apply the current operator
1522 for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1524 # COMBINE OPERANDS, INDEXES AND OPERATORS
1525 if ( ($operands[$i] // '') ne '' ) {
1526 $operands[$i]=~s/^\s+//;
1528 # A flag to determine whether or not to add the index to the query
1531 # If the user is sophisticated enough to specify an index, turn off field weighting, and stemming handling
1532 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1536 $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1538 my $operand = $operands[$i];
1539 my $index = $indexes[$i] || 'kw';
1541 # Add index-specific attributes
1543 #Afaik, this 'yr' condition will only ever be met in the staff client advanced search
1544 #for "Publication date", since typing 'yr:YYYY' into the search box produces a CCL query,
1545 #which is processed higher up in this sub. Other than that, year searches are typically
1546 #handled as limits which are not processed her either.
1548 # Search ranges: Date of Publication, st-numeric
1549 if ( $index =~ /(yr|st-numeric)/ ) {
1550 #weight_fields/relevance search causes errors with date ranges
1551 #In the case of YYYY-, it will only return records with a 'yr' of YYYY (not the range)
1552 #In the case of YYYY-YYYY, it will return no results
1553 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1556 # Date of Acquisition
1557 elsif ( $index =~ /acqdate/ ) {
1558 #stemming and auto_truncation would have zero impact since it already is YYYY-MM-DD format
1559 #Weight_fields probably SHOULD be turned OFF, otherwise you'll get records floating to the
1560 #top of the results just because they have lots of item records matching that date.
1561 #Fuzzy actually only applies during _build_weighted_query, and is reset there anyway, so
1563 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1565 # ISBN,ISSN,Standard Number, don't need special treatment
1566 elsif ( $index eq 'nb' || $index eq 'ns' || $index eq 'hi' ) {
1568 $stemming, $auto_truncation,
1569 $weight_fields, $fuzzy_enabled
1572 if ( $index eq 'nb' ) {
1573 if ( C4::Context->preference("SearchWithISBNVariations") ) {
1574 my @isbns = C4::Koha::GetVariationsOfISBN( $operand );
1575 $operands[$i] = $operand = '(nb=' . join(' OR nb=', @isbns) . ')';
1576 $indexes[$i] = $index = 'kw';
1581 # Set default structure attribute (word list)
1582 my $struct_attr = q{};
1583 unless ( $indexes_set || $index =~ /,(st-|phr|ext|wrdl)/ || $index =~ /^(nb|ns)$/ ) {
1584 $struct_attr = ",wrdl";
1587 # Some helpful index variants
1588 my $index_plus = $index . $struct_attr . ':';
1589 my $index_plus_comma = $index . $struct_attr . ',';
1591 if ($auto_truncation){
1592 unless ( $index =~ /,(st-|phr|ext)/ ) {
1593 #FIXME only valid with LTR scripts
1594 $operand=join(" ",map{
1595 (index($_,"*")>0?"$_":"$_*")
1596 }split (/\s+/,$operand));
1597 warn $operand if $DEBUG;
1602 my $truncated_operand;
1603 my( $nontruncated, $righttruncated, $lefttruncated,
1604 $rightlefttruncated, $regexpr
1605 ) = _detect_truncation( $operand, $index );
1607 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1612 scalar(@$righttruncated) + scalar(@$lefttruncated) +
1613 scalar(@$rightlefttruncated) > 0 )
1616 # Don't field weight or add the index to the query, we do it here
1618 undef $weight_fields;
1619 my $previous_truncation_operand;
1620 if (scalar @$nontruncated) {
1621 $truncated_operand .= "$index_plus @$nontruncated ";
1622 $previous_truncation_operand = 1;
1624 if (scalar @$righttruncated) {
1625 $truncated_operand .= "and " if $previous_truncation_operand;
1626 $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1627 $previous_truncation_operand = 1;
1629 if (scalar @$lefttruncated) {
1630 $truncated_operand .= "and " if $previous_truncation_operand;
1631 $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1632 $previous_truncation_operand = 1;
1634 if (scalar @$rightlefttruncated) {
1635 $truncated_operand .= "and " if $previous_truncation_operand;
1636 $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1637 $previous_truncation_operand = 1;
1640 $operand = $truncated_operand if $truncated_operand;
1641 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1644 my $stemmed_operand;
1645 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1648 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1650 # Handle Field Weighting
1651 my $weighted_operand;
1652 if ($weight_fields) {
1653 $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1654 $operand = $weighted_operand;
1658 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1660 ($query,$query_cgi,$query_desc,$previous_operand) = _build_initial_query({
1662 query_cgi => $query_cgi,
1663 query_desc => $query_desc,
1664 operator => ($operators[ $i - 1 ]) ? $operators[ $i - 1 ] : '',
1665 parsed_operand => $operand,
1666 original_operand => $operands[$i] // '',
1668 index_plus => $index_plus,
1669 indexes_set => $indexes_set,
1670 previous_operand => $previous_operand,
1676 warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1679 my %group_OR_limits;
1680 my $availability_limit;
1681 foreach my $this_limit (@limits) {
1682 next unless $this_limit;
1683 if ( $this_limit =~ /available/ ) {
1685 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1687 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1688 $availability_limit .=
1689 "( (allrecords,AlwaysMatches='') and (not-onloan-count,st-numeric >= 1) and (lost,st-numeric=0) )";
1690 $limit_cgi .= "&limit=available";
1694 # group_OR_limits, prefixed by mc-
1695 # OR every member of the group
1696 elsif ( $this_limit =~ /mc/ ) {
1697 my ($k,$v) = split(/:/, $this_limit,2);
1698 if ( $k !~ /mc-i(tem)?type/ ) {
1699 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1700 $this_limit =~ tr/"//d;
1701 $this_limit = $k.":'".$v."'";
1704 $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1705 $limit_desc .= " or " if $group_OR_limits{$k};
1706 $group_OR_limits{$k} .= "$this_limit";
1707 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1708 $limit_desc .= " $this_limit";
1711 # Regular old limits
1713 $limit .= " and " if $limit || $query;
1714 $limit .= "$this_limit";
1715 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1716 if ($this_limit =~ /^branch:(.+)/) {
1717 my $branchcode = $1;
1718 my $library = Koha::Libraries->find( $branchcode );
1719 if (defined $library) {
1720 $limit_desc .= " branch:" . $library->branchname;
1722 $limit_desc .= " $this_limit";
1725 $limit_desc .= " $this_limit";
1729 foreach my $k (keys (%group_OR_limits)) {
1730 $limit .= " and " if ( $query || $limit );
1731 $limit .= "($group_OR_limits{$k})";
1733 if ($availability_limit) {
1734 $limit .= " and " if ( $query || $limit );
1735 $limit .= "($availability_limit)";
1738 # Normalize the query and limit strings
1739 # This is flawed , means we can't search anything with : in it
1740 # if user wants to do ccl or cql, start the query with that
1741 # $query =~ s/:/=/g;
1742 #NOTE: We use several several different regexps here as you can't have variable length lookback assertions
1743 $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1744 $query =~ s/(?<=(wrdl)):/=/g;
1745 $query =~ s/(?<=(trn|phr)):/=/g;
1746 $query =~ s/(?<=(st-numeric)):/=/g;
1747 $query =~ s/(?<=(st-year)):/=/g;
1748 $query =~ s/(?<=(st-date-normalized)):/=/g;
1750 # Removing warnings for later substitutions
1752 $query_desc //= q{};
1755 $limit_desc //= q{};
1757 for ( $query, $query_desc, $limit, $limit_desc ) {
1758 s/ +/ /g; # remove extra spaces
1759 s/^ //g; # remove any beginning spaces
1760 s/ $//g; # remove any ending spaces
1761 s/==/=/g; # remove double == from query
1763 $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1765 for ($query_cgi,$simple_query) {
1768 # append the limit to the query
1769 $query .= " " . $limit;
1773 warn "QUERY:" . $query;
1774 warn "QUERY CGI:" . $query_cgi;
1775 warn "QUERY DESC:" . $query_desc;
1776 warn "LIMIT:" . $limit;
1777 warn "LIMIT CGI:" . $limit_cgi;
1778 warn "LIMIT DESC:" . $limit_desc;
1779 warn "---------\nLeave buildQuery\n---------";
1783 undef, $query, $simple_query, $query_cgi,
1784 $query_desc, $limit, $limit_cgi, $limit_desc,
1789 =head2 _build_initial_query
1791 ($query, $query_cgi, $query_desc, $previous_operand) = _build_initial_query($initial_query_params);
1793 Build a section of the initial query containing indexes, operators, and operands.
1797 sub _build_initial_query {
1801 if ($params->{previous_operand}){
1802 #If there is a previous operand, add a supplied operator or the default 'and'
1803 $operator = ($params->{operator}) ? " ".($params->{operator})." " : ' and ';
1806 #NOTE: indexes_set is typically set when doing truncation or field weighting
1807 my $operand = ($params->{indexes_set}) ? $params->{parsed_operand} : $params->{index_plus}.$params->{parsed_operand};
1809 #e.g. "kw,wrdl:test"
1810 #e.g. " and kw,wrdl:test"
1811 $params->{query} .= $operator . $operand;
1813 $params->{query_cgi} .= "&op=".uri_escape_utf8($operator) if $operator;
1814 $params->{query_cgi} .= "&idx=".uri_escape_utf8($params->{index}) if $params->{index};
1815 $params->{query_cgi} .= "&q=".uri_escape_utf8($params->{original_operand}) if $params->{original_operand};
1817 #e.g. " and kw,wrdl: test"
1818 $params->{query_desc} .= $operator . $params->{index_plus} . " " . $params->{original_operand};
1820 $params->{previous_operand} = 1 unless $params->{previous_operand}; #If there is no previous operand, mark this as one
1822 return ($params->{query}, $params->{query_cgi}, $params->{query_desc}, $params->{previous_operand});
1825 =head2 searchResults
1827 my @search_results = searchResults($search_context, $searchdesc, $hits,
1828 $results_per_page, $offset, $scan,
1831 Format results in a form suitable for passing to the template
1835 # IMO this subroutine is pretty messy still -- it's responsible for
1836 # building the HTML output for the template
1838 my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1839 my $dbh = C4::Context->dbh;
1844 $search_context->{'interface'} = 'opac' if !$search_context->{'interface'} || $search_context->{'interface'} ne 'intranet';
1845 my ($is_opac, $hidelostitems);
1846 if ($search_context->{'interface'} eq 'opac') {
1847 $hidelostitems = C4::Context->preference('hidelostitems');
1851 #Build branchnames hash
1852 my %branches = map { $_->branchcode => $_->branchname } Koha::Libraries->search({}, { order_by => 'branchname' });
1854 # FIXME - We build an authorised values hash here, using the default framework
1855 # though it is possible to have different authvals for different fws.
1857 my $shelflocations =
1858 { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
1860 # get notforloan authorised value list (see $shelflocations FIXME)
1861 my $av = Koha::MarcSubfieldStructures->search({ frameworkcode => '', kohafield => 'items.notforloan', authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
1862 my $notforloan_authorised_value = $av->count ? $av->next->authorised_value : undef;
1865 my $itemtypes = Koha::ItemTypes->search_with_localization;
1866 my %itemtypes = map { $_->{itemtype} => $_ } @{ $itemtypes->unblessed };
1868 #search item field code
1869 my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber" );
1871 ## find column names of items related to MARC
1872 my %subfieldstosearch;
1873 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
1874 for my $column ( @columns ) {
1875 my ( $tagfield, $tagsubfield ) =
1876 &GetMarcFromKohaField( "items." . $column );
1877 if ( defined $tagsubfield ) {
1878 $subfieldstosearch{$column} = $tagsubfield;
1882 # handle which records to actually retrieve
1884 if ( $hits && $offset + $results_per_page <= $hits ) {
1885 $times = $offset + $results_per_page;
1888 $times = $hits; # FIXME: if $hits is undefined, why do we want to equal it?
1891 my $marcflavour = C4::Context->preference("marcflavour");
1892 # We get the biblionumber position in MARC
1893 my ($bibliotag,$bibliosubf)=GetMarcFromKohaField( 'biblio.biblionumber' );
1895 # set stuff for XSLT processing here once, not later again for every record we retrieved
1899 $xslsyspref = "OPACXSLTResultsDisplay";
1900 $xslfile = C4::Context->preference( $xslsyspref );
1902 $xslsyspref = "XSLTResultsDisplay";
1903 $xslfile = C4::Context->preference( $xslsyspref ) || "default";
1905 my $lang = $xslfile ? C4::Languages::getlanguage() : undef;
1906 my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
1908 my $userenv = C4::Context->userenv;
1910 = ( defined $userenv and $userenv->{number} )
1911 ? Koha::Patrons->find( $userenv->{number} )
1913 my $patron_category_hide_lost_items = ($logged_in_user) ? $logged_in_user->category->hidelostitems : 0;
1915 # loop through all of the records we've retrieved
1916 for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1920 # For Scan searches we built USMARC data
1921 $marcrecord = MARC::Record->new_from_usmarc( $marcresults->[$i]);
1923 # Normal search, render from Zebra's output
1924 $marcrecord = new_record_from_zebra(
1929 if ( ! defined $marcrecord ) {
1930 warn "ERROR DECODING RECORD - $@: " . $marcresults->[$i];
1938 ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1939 : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1941 SetUTF8Flag($marcrecord);
1942 my $oldbiblio = TransformMarcToKoha( $marcrecord, $fw );
1943 $oldbiblio->{result_number} = $i + 1;
1945 $oldbiblio->{normalized_upc} = GetNormalizedUPC( $marcrecord,$marcflavour);
1946 $oldbiblio->{normalized_ean} = GetNormalizedEAN( $marcrecord,$marcflavour);
1947 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1948 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1949 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1951 # edition information, if any
1952 $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1954 my $itemtype = $oldbiblio->{itemtype} ? $itemtypes{$oldbiblio->{itemtype}} : undef;
1955 # add imageurl to itemtype if there is one
1956 $oldbiblio->{imageurl} = $itemtype ? getitemtypeimagelocation( $search_context->{'interface'}, $itemtype->{imageurl} ) : q{};
1957 # Build summary if there is one (the summary is defined in the itemtypes table)
1958 $oldbiblio->{description} = $itemtype ? $itemtype->{translated_description} : q{};
1960 # FIXME: this is only used in the deprecated non-XLST opac results
1961 if ( !$xslfile && $is_opac && $itemtype && $itemtype->{summary} ) {
1962 my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1963 my @fields = $marcrecord->fields();
1966 foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1968 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1969 $tag =~ /(.{3})(.)/;
1970 if($marcrecord->field($1)){
1971 my @abc = $marcrecord->field($1)->subfield($2);
1972 $tags->{$tag} = $#abc + 1 ;
1976 # We catch how many times to repeat this line
1978 foreach my $tag (keys(%$tags)){
1979 $max = $tags->{$tag} if($tags->{$tag} > $max);
1982 # we replace, and repeat each line
1983 for (my $i = 0 ; $i < $max ; $i++){
1984 my $newline = $line;
1986 foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1987 $tag =~ /(.{3})(.)/;
1989 if($marcrecord->field($1)){
1990 my @repl = $marcrecord->field($1)->subfield($2);
1991 my $subfieldvalue = $repl[$i];
1992 $newline =~ s/\[$tag\]/$subfieldvalue/g;
1995 $newsummary .= "$newline\n";
1999 $newsummary =~ s/\[(.*?)]//g;
2000 $newsummary =~ s/\n/<br\/>/g;
2001 $oldbiblio->{summary} = $newsummary;
2004 # Pull out the items fields
2005 my @fields = $marcrecord->field($itemtag);
2006 my $marcflavor = C4::Context->preference("marcflavour");
2008 # adding linked items that belong to host records
2009 if ( C4::Context->preference('EasyAnalyticalRecords') ) {
2010 my $analyticsfield = '773';
2011 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
2012 $analyticsfield = '773';
2013 } elsif ($marcflavor eq 'UNIMARC') {
2014 $analyticsfield = '461';
2016 foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
2017 my $hostbiblionumber = $hostfield->subfield("0");
2018 my $linkeditemnumber = $hostfield->subfield("9");
2019 if( $hostbiblionumber ) {
2020 my $hostbiblio = GetMarcBiblio({
2021 biblionumber => $hostbiblionumber,
2022 embed_items => 1 });
2023 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber' );
2025 my @hostitems = $hostbiblio->field($itemfield);
2026 foreach my $hostitem (@hostitems){
2027 if ($hostitem->subfield("9") eq $linkeditemnumber){
2028 my $linkeditem =$hostitem;
2029 # append linked items if they exist
2030 push @fields, $linkeditem if $linkeditem;
2038 # Setting item statuses for display
2039 my @available_items_loop;
2040 my @onloan_items_loop;
2041 my @other_items_loop;
2043 my $available_items;
2047 my $ordered_count = 0;
2048 my $available_count = 0;
2049 my $onloan_count = 0;
2050 my $longoverdue_count = 0;
2051 my $other_count = 0;
2052 my $withdrawn_count = 0;
2053 my $itemlost_count = 0;
2054 my $hideatopac_count = 0;
2055 my $itembinding_count = 0;
2056 my $itemdamaged_count = 0;
2057 my $item_in_transit_count = 0;
2058 my $can_place_holds = 0;
2059 my $item_onhold_count = 0;
2060 my $notforloan_count = 0;
2061 my $items_count = scalar(@fields);
2062 my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
2063 my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
2064 my @hiddenitems; # hidden itemnumbers based on OpacHiddenItems syspref
2066 # loop through every item
2067 foreach my $field (@fields) {
2070 # populate the items hash
2071 foreach my $code ( keys %subfieldstosearch ) {
2072 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
2074 $item->{description} = $itemtypes{ $item->{itype} }{translated_description} if $item->{itype};
2078 # hidden because lost
2079 if ($hidelostitems && $item->{itemlost}) {
2080 $hideatopac_count++;
2083 # hidden based on OpacHiddenItems syspref
2084 my @hi = C4::Items::GetHiddenItemnumbers({ items=> [ $item ], borcat => $search_context->{category} });
2086 push @hiddenitems, @hi;
2087 $hideatopac_count++;
2092 my $hbranch = C4::Context->preference('StaffSearchResultsDisplayBranch');
2093 my $otherbranch = $hbranch eq 'homebranch' ? 'holdingbranch' : 'homebranch';
2095 # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
2096 if ($item->{$hbranch}) {
2097 $item->{'branchname'} = $branches{$item->{$hbranch}};
2099 elsif ($item->{$otherbranch}) { # Last resort
2100 $item->{'branchname'} = $branches{$item->{$otherbranch}};
2104 ( $item->{$hbranch} ? $item->{$hbranch} . '--' : q{} )
2105 . ( $item->{location} ? $item->{location} : q{} )
2106 . ( $item->{itype} ? $item->{itype} : q{} )
2107 . ( $item->{itemcallnumber} ? $item->{itemcallnumber} : q{} );
2108 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
2109 if ( $item->{onloan}
2111 and !( $patron_category_hide_lost_items and $item->{itemlost} ) )
2114 my $key = $prefix . $item->{onloan} . $item->{barcode};
2115 $onloan_items->{$key}->{due_date} = $item->{onloan};
2116 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
2117 $onloan_items->{$key}->{branchname} = $item->{branchname};
2118 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2119 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
2120 $onloan_items->{$key}->{description} = $item->{description};
2121 $onloan_items->{$key}->{imageurl} =
2122 getitemtypeimagelocation( $search_context->{'interface'}, $itemtypes{ $item->{itype} }->{imageurl} );
2124 # if something's checked out and lost, mark it as 'long overdue'
2125 if ( $item->{itemlost} ) {
2126 $onloan_items->{$key}->{longoverdue}++;
2127 $longoverdue_count++;
2129 else { # can place holds as long as item isn't lost
2130 $can_place_holds = 1;
2134 # items not on loan, but still unavailable ( lost, withdrawn, damaged )
2137 my $itemtype = C4::Context->preference("item-level_itypes")? $item->{itype}: $oldbiblio->{itemtype};
2138 $item->{notforloan} = 1 if !$item->{notforloan} &&
2139 $itemtype && $itemtypes{ $itemtype }->{notforloan};
2142 if ( $item->{notforloan} < 0 ) {
2144 } elsif ( $item->{notforloan} > 0 ) {
2145 $notforloan_count++;
2148 # is item in transit?
2149 my $transfertwhen = '';
2150 my ($transfertfrom, $transfertto);
2152 # is item on the reserve shelf?
2153 my $reservestatus = '';
2155 unless ($item->{withdrawn}
2156 || $item->{itemlost}
2158 || $item->{notforloan}
2159 || ( C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck')
2160 && $items_count > C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck') ) ) {
2162 # A couple heuristics to limit how many times
2163 # we query the database for item transfer information, sacrificing
2164 # accuracy in some cases for speed;
2166 # 1. don't query if item has one of the other statuses
2167 # 2. don't check transit status if the bib has
2168 # more than 20 items
2170 # FIXME: to avoid having the query the database like this, and to make
2171 # the in transit status count as unavailable for search limiting,
2172 # should map transit status to record indexed in Zebra.
2174 ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
2175 $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
2178 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
2179 if ( $item->{withdrawn}
2180 || $item->{itemlost}
2182 || $item->{notforloan}
2183 || $reservestatus eq 'Waiting'
2184 || ($transfertwhen && $transfertwhen ne ''))
2186 $withdrawn_count++ if $item->{withdrawn};
2187 $itemlost_count++ if $item->{itemlost};
2188 $itemdamaged_count++ if $item->{damaged};
2189 $item_in_transit_count++ if $transfertwhen && $transfertwhen ne '';
2190 $item_onhold_count++ if $reservestatus eq 'Waiting';
2191 $item->{status} = ($item->{withdrawn}//q{}) . "-" . ($item->{itemlost}//q{}) . "-" . ($item->{damaged}//q{}) . "-" . ($item->{notforloan}//q{});
2193 # can place a hold on a item if
2194 # not lost nor withdrawn
2195 # not damaged unless AllowHoldsOnDamagedItems is true
2196 # item is either for loan or on order (notforloan < 0)
2197 $can_place_holds = 1
2200 && !$item->{withdrawn}
2201 && ( !$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems') )
2202 && ( !$item->{notforloan} || $item->{notforloan} < 0 )
2207 my $key = $prefix . $item->{status};
2208 foreach (qw(withdrawn itemlost damaged branchname itemcallnumber)) {
2209 $other_items->{$key}->{$_} = $item->{$_};
2211 $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
2212 $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
2213 $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
2214 $other_items->{$key}->{count}++ if $item->{$hbranch};
2215 $other_items->{$key}->{location} = $shelflocations->{ $item->{location} } if $item->{location};
2216 $other_items->{$key}->{description} = $item->{description};
2217 $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context->{'interface'}, $itemtypes{ $item->{itype}//q{} }->{imageurl} );
2221 $can_place_holds = 1;
2223 $available_items->{$prefix}->{count}++ if $item->{$hbranch};
2224 foreach (qw(branchname itemcallnumber description)) {
2225 $available_items->{$prefix}->{$_} = $item->{$_};
2227 $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} } if $item->{location};
2228 $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context->{'interface'}, $itemtypes{ $item->{itype}//q{} }->{imageurl} );
2231 } # notforloan, item level and biblioitem level
2233 # if all items are hidden, do not show the record
2234 if ($items_count > 0 && $hideatopac_count == $items_count) {
2238 my ( $availableitemscount, $onloanitemscount, $otheritemscount );
2239 for my $key ( sort keys %$onloan_items ) {
2240 (++$onloanitemscount > $maxitems) and last;
2241 push @onloan_items_loop, $onloan_items->{$key};
2243 for my $key ( sort keys %$other_items ) {
2244 (++$otheritemscount > $maxitems) and last;
2245 push @other_items_loop, $other_items->{$key};
2247 for my $key ( sort keys %$available_items ) {
2248 (++$availableitemscount > $maxitems) and last;
2249 push @available_items_loop, $available_items->{$key}
2252 # XSLT processing of some stuff
2253 # we fetched the sysprefs already before the loop through all retrieved record!
2254 if (!$scan && $xslfile) {
2255 $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $xslsyspref, 1, \@hiddenitems, $sysxml, $xslfile, $lang);
2258 # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
2259 if (!C4::Context->preference("item-level_itypes")) {
2260 if ($itemtype && $itemtype->{notforloan}) {
2261 $can_place_holds = 0;
2264 $oldbiblio->{norequests} = 1 unless $can_place_holds;
2265 $oldbiblio->{items_count} = $items_count;
2266 $oldbiblio->{available_items_loop} = \@available_items_loop;
2267 $oldbiblio->{onloan_items_loop} = \@onloan_items_loop;
2268 $oldbiblio->{other_items_loop} = \@other_items_loop;
2269 $oldbiblio->{availablecount} = $available_count;
2270 $oldbiblio->{availableplural} = 1 if $available_count > 1;
2271 $oldbiblio->{onloancount} = $onloan_count;
2272 $oldbiblio->{onloanplural} = 1 if $onloan_count > 1;
2273 $oldbiblio->{othercount} = $other_count;
2274 $oldbiblio->{otherplural} = 1 if $other_count > 1;
2275 $oldbiblio->{withdrawncount} = $withdrawn_count;
2276 $oldbiblio->{itemlostcount} = $itemlost_count;
2277 $oldbiblio->{damagedcount} = $itemdamaged_count;
2278 $oldbiblio->{intransitcount} = $item_in_transit_count;
2279 $oldbiblio->{onholdcount} = $item_onhold_count;
2280 $oldbiblio->{orderedcount} = $ordered_count;
2281 $oldbiblio->{notforloancount} = $notforloan_count;
2283 if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
2284 my $fieldspec = C4::Context->preference("AlternateHoldingsField");
2285 my $subfields = substr $fieldspec, 3;
2286 my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
2287 my @alternateholdingsinfo = ();
2288 my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
2289 my $alternateholdingscount = 0;
2291 for my $field (@holdingsfields) {
2292 my %holding = ( holding => '' );
2293 my $havesubfield = 0;
2294 for my $subfield ($field->subfields()) {
2295 if ((index $subfields, $$subfield[0]) >= 0) {
2296 $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
2297 $holding{'holding'} .= $$subfield[1];
2301 if ($havesubfield) {
2302 push(@alternateholdingsinfo, \%holding);
2303 $alternateholdingscount++;
2307 $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
2308 $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
2311 $oldbiblio->{biblio_object} = Koha::Biblios->find( $oldbiblio->{biblionumber} );
2313 push( @newresults, $oldbiblio );
2319 =head2 enabled_staff_search_views
2321 %hash = enabled_staff_search_views()
2323 This function returns a hash that contains three flags obtained from the system
2324 preferences, used to determine whether a particular staff search results view
2329 =item C<Output arg:>
2331 * $hash{can_view_MARC} is true only if the MARC view is enabled
2332 * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2333 * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2335 =item C<usage in the script:>
2339 $template->param ( C4::Search::enabled_staff_search_views );
2343 sub enabled_staff_search_views
2346 can_view_MARC => C4::Context->preference('viewMARC'), # 1 if the staff search allows the MARC view
2347 can_view_ISBD => C4::Context->preference('viewISBD'), # 1 if the staff search allows the ISBD view
2348 can_view_labeledMARC => C4::Context->preference('viewLabeledMARC'), # 1 if the staff search allows the Labeled MARC view
2352 =head2 z3950_search_args
2354 $arrayref = z3950_search_args($matchpoints)
2356 This function returns an array reference that contains the search parameters to be
2357 passed to the Z39.50 search script (z3950_search.pl). The array elements
2358 are hash refs whose keys are name and value, and whose values are the
2359 name of a search parameter, the value of that search parameter and the URL encoded
2360 value of that parameter.
2362 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2364 The search parameter values are obtained from the bibliographic record whose
2365 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2367 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2368 a general purpose search argument. In this case, the returned array contains only
2369 entry: the key is 'title' and the value is derived from $matchpoints.
2371 If a search parameter value is undefined or empty, it is not included in the returned
2374 The returned array reference may be passed directly to the template parameters.
2378 =item C<Output arg:>
2380 * $array containing hash refs as described above
2382 =item C<usage in the script:>
2386 $data = Biblio::GetBiblioData($bibno);
2387 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2391 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2395 sub z3950_search_args {
2398 my $isbn_string = ref( $bibrec ) ? $bibrec->{title} : $bibrec;
2399 my $isbn = Business::ISBN->new( $isbn_string );
2401 if (defined $isbn && $isbn->is_valid)
2403 if ( ref($bibrec) ) {
2404 $bibrec->{isbn} = $isbn_string;
2405 $bibrec->{title} = undef;
2407 $bibrec = { isbn => $isbn_string };
2411 $bibrec = { title => $bibrec } if !ref $bibrec;
2414 for my $field (qw/ lccn isbn issn title author dewey subject /)
2416 push @$array, { name => $field, value => $bibrec->{$field} }
2417 if defined $bibrec->{$field};
2422 =head2 GetDistinctValues($field);
2424 C<$field> is a reference to the fields array
2428 sub GetDistinctValues {
2429 my ($fieldname,$string)=@_;
2430 # returns a reference to a hash of references to branches...
2431 if ($fieldname=~/\./){
2432 my ($table,$column)=split /\./, $fieldname;
2433 my $dbh = C4::Context->dbh;
2434 warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2435 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 ");
2437 my $elements=$sth->fetchall_arrayref({});
2442 my @servers=qw<biblioserver authorityserver>;
2443 my (@zconns,@results);
2444 for ( my $i = 0 ; $i < @servers ; $i++ ) {
2445 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2448 ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2451 # The big moment: asynchronously retrieve results from all servers
2457 my ( $i, $size ) = @_;
2458 for ( my $j = 0 ; $j < $size ; $j++ ) {
2460 @hashscan{qw(value cnt)} =
2461 $results[ $i - 1 ]->display_term($j);
2462 push @elements, \%hashscan;
2470 =head2 _ZOOM_event_loop
2472 _ZOOM_event_loop(\@zconns, \@results, sub {
2473 my ( $i, $size ) = @_;
2477 Processes a ZOOM event loop and passes control to a closure for
2478 processing the results, and destroying the resultsets.
2482 sub _ZOOM_event_loop {
2483 my ($zconns, $results, $callback) = @_;
2484 while ( ( my $i = ZOOM::event( $zconns ) ) != 0 ) {
2485 my $ev = $zconns->[ $i - 1 ]->last_event();
2486 if ( $ev == ZOOM::Event::ZEND ) {
2487 next unless $results->[ $i - 1 ];
2488 my $size = $results->[ $i - 1 ]->size();
2490 $callback->($i, $size);
2495 foreach my $result (@$results) {
2500 =head2 new_record_from_zebra
2502 Given raw data from a searchengine result set, return a MARC::Record object
2504 This helper function is needed to take into account all the involved
2505 system preferences and configuration variables to properly create the
2506 MARC::Record object.
2508 If we are using GRS-1, then the raw data we get from Zebra should be USMARC
2509 data. If we are using DOM, then it has to be MARCXML.
2511 If we are using elasticsearch, it'll already be a MARC::Record and this
2512 function needs a new name.
2516 sub new_record_from_zebra {
2519 my $raw_data = shift;
2520 # Set the default indexing modes
2521 my $search_engine = C4::Context->preference("SearchEngine");
2522 if ($search_engine eq 'Elasticsearch') {
2523 return ref $raw_data eq 'MARC::Record' ? $raw_data : MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2525 my $index_mode = ( $server eq 'biblioserver' )
2526 ? C4::Context->config('zebra_bib_index_mode') // 'dom'
2527 : C4::Context->config('zebra_auth_index_mode') // 'dom';
2529 my $marc_record = eval {
2530 if ( $index_mode eq 'dom' ) {
2531 MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2533 MARC::Record->new_from_usmarc( $raw_data );
2540 return $marc_record;
2545 END { } # module clean-up code here (global destructor)
2552 Koha Development Team <http://koha-community.org/>