3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
19 #use warnings; FIXME - Bug 2505
22 use C4::Biblio; # GetMarcFromKohaField, GetBiblioData
23 use C4::Koha; # getFacets
26 use C4::Search::PazPar2;
28 use C4::Members qw(GetHideLostItemsPreference);
31 use C4::Reserves; # GetReserveStatus
40 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
42 # set the version for version checking
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( $dbh, $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( $dbh, $marcrecord, '' );
151 # FIXME :: why 2 $biblionumber ?
153 push @results, $result->{'biblionumber'};
154 push @results, $result->{'title'};
163 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers] );
165 This function provides a simple search API on the bibliographic catalog
171 * $query can be a simple keyword or a complete CCL query
172 * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
173 * $offset - If present, represents the number of records at the beginning to omit. Defaults to 0
174 * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
179 Returns an array consisting of three elements
180 * $error is undefined unless an error is detected
181 * $results is a reference to an array of records.
182 * $total_hits is the number of hits that would have been returned with no limit
184 If an error is returned the two other return elements are undefined. If error itself is undefined
185 the other two elements are always defined
187 =item C<usage in the script:>
191 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
193 if (defined $error) {
194 $template->param(query_error => $error);
195 warn "error: ".$error;
196 output_html_with_http_headers $input, $cookie, $template->output;
200 my $hits = @{$marcresults};
203 for my $r ( @{$marcresults} ) {
204 my $marcrecord = MARC::File::USMARC::decode($r);
205 my $biblio = TransformMarcToKoha(C4::Context->dbh,$marcrecord,q{});
207 #build the iarray of hashs for the template.
209 title => $biblio->{'title'},
210 subtitle => $biblio->{'subtitle'},
211 biblionumber => $biblio->{'biblionumber'},
212 author => $biblio->{'author'},
213 publishercode => $biblio->{'publishercode'},
214 publicationyear => $biblio->{'publicationyear'},
219 $template->param(result=>\@results);
224 my ( $query, $offset, $max_results, $servers ) = @_;
226 return ( 'No query entered', undef, undef ) unless $query;
227 # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
228 my @servers = defined ( $servers ) ? @$servers : ( 'biblioserver' );
236 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') && ! ($query =~ m/\w,\w|\w=\w/));
238 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
241 # Initialize & Search Zebra
242 for ( my $i = 0 ; $i < @servers ; $i++ ) {
244 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
247 $QParser->parse( $query );
248 $query = $QParser->target_syntax($servers[$i]);
249 $zoom_queries[$i] = new ZOOM::Query::PQF( $query, $zconns[$i]);
252 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
254 $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
258 $zconns[$i]->errmsg() . " ("
259 . $zconns[$i]->errcode() . ") "
260 . $zconns[$i]->addinfo() . " "
261 . $zconns[$i]->diagset();
263 return ( $error, undef, undef ) if $zconns[$i]->errcode();
267 # caught a ZOOM::Exception
271 . $@->addinfo() . " "
273 warn $error." for query: $query";
274 return ( $error, undef, undef );
283 my $first_record = defined($offset) ? $offset + 1 : 1;
284 my $hits = $tmpresults[ $i - 1 ]->size();
285 $total_hits += $hits;
286 my $last_record = $hits;
287 if ( defined $max_results && $offset + $max_results < $hits ) {
288 $last_record = $offset + $max_results;
291 for my $j ( $first_record .. $last_record ) {
293 $tmpresults[ $i - 1 ]->record( $j - 1 )->raw()
296 push @{$results}, $record if defined $record;
301 foreach my $zoom_query (@zoom_queries) {
302 $zoom_query->destroy();
305 return ( undef, $results, $total_hits );
310 ( undef, $results_hashref, \@facets_loop ) = getRecords (
312 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
313 $results_per_page, $offset, $expanded_facet, $branches,$itemtypes,
317 The all singing, all dancing, multi-server, asynchronous, scanning,
318 searching, record nabbing, facet-building
320 See verbse embedded documentation.
326 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
327 $results_per_page, $offset, $expanded_facet, $branches,
328 $itemtypes, $query_type, $scan, $opac
331 my @servers = @$servers_ref;
332 my @sort_by = @$sort_by_ref;
334 # Initialize variables for the ZOOM connection and results object
338 my $results_hashref = ();
340 # Initialize variables for the faceted results objects
341 my $facets_counter = {};
342 my $facets_info = {};
343 my $facets = getFacets();
345 my @facets_loop; # stores the ref to array of hashes for template facets loop
347 ### LOOP THROUGH THE SERVERS
348 for ( my $i = 0 ; $i < @servers ; $i++ ) {
349 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
351 # perform the search, create the results objects
352 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
353 my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
355 #$query_to_use = $simple_query if $scan;
356 warn $simple_query if ( $scan and $DEBUG );
358 # Check if we've got a query_type defined, if so, use it
361 if ($query_type =~ /^ccl/) {
362 $query_to_use =~ s/\:/\=/g; # change : to = last minute (FIXME)
363 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
364 } elsif ($query_type =~ /^cql/) {
365 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
366 } elsif ($query_type =~ /^pqf/) {
367 $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
369 warn "Unknown query_type '$query_type'. Results undetermined.";
372 $results[$i] = $zconns[$i]->scan( new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
374 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
378 warn "WARNING: query problem with $query_to_use " . $@;
381 # Concatenate the sort_by limits and pass them to the results object
382 # Note: sort will override rank
384 foreach my $sort (@sort_by) {
385 if ( $sort eq "author_az" || $sort eq "author_asc" ) {
386 $sort_by .= "1=1003 <i ";
388 elsif ( $sort eq "author_za" || $sort eq "author_dsc" ) {
389 $sort_by .= "1=1003 >i ";
391 elsif ( $sort eq "popularity_asc" ) {
392 $sort_by .= "1=9003 <i ";
394 elsif ( $sort eq "popularity_dsc" ) {
395 $sort_by .= "1=9003 >i ";
397 elsif ( $sort eq "call_number_asc" ) {
398 $sort_by .= "1=8007 <i ";
400 elsif ( $sort eq "call_number_dsc" ) {
401 $sort_by .= "1=8007 >i ";
403 elsif ( $sort eq "pubdate_asc" ) {
404 $sort_by .= "1=31 <i ";
406 elsif ( $sort eq "pubdate_dsc" ) {
407 $sort_by .= "1=31 >i ";
409 elsif ( $sort eq "acqdate_asc" ) {
410 $sort_by .= "1=32 <i ";
412 elsif ( $sort eq "acqdate_dsc" ) {
413 $sort_by .= "1=32 >i ";
415 elsif ( $sort eq "title_az" || $sort eq "title_asc" ) {
416 $sort_by .= "1=4 <i ";
418 elsif ( $sort eq "title_za" || $sort eq "title_dsc" ) {
419 $sort_by .= "1=4 >i ";
422 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
425 if ( $sort_by && !$scan && $results[$i] ) {
426 if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
427 warn "WARNING sort $sort_by failed";
430 } # finished looping through servers
432 # The big moment: asynchronously retrieve results from all servers
437 my ( $i, $size ) = @_;
440 # loop through the results
441 $results_hash->{'hits'} = $size;
443 if ( $offset + $results_per_page <= $size ) {
444 $times = $offset + $results_per_page;
450 for ( my $j = $offset ; $j < $times ; $j++ ) {
454 ## Check if it's an index scan
456 my ( $term, $occ ) = $results[ $i - 1 ]->display_term($j);
458 # here we create a minimal MARC record and hand it off to the
459 # template just like a normal result ... perhaps not ideal, but
461 my $tmprecord = MARC::Record->new();
462 $tmprecord->encoding('UTF-8');
466 # the minimal record in author/title (depending on MARC flavour)
467 if ( C4::Context->preference("marcflavour") eq
470 $tmptitle = MARC::Field->new(
475 $tmprecord->append_fields($tmptitle);
479 MARC::Field->new( '245', ' ', ' ', a => $term, );
481 MARC::Field->new( '100', ' ', ' ', a => $occ, );
482 $tmprecord->append_fields($tmptitle);
483 $tmprecord->append_fields($tmpauthor);
485 $results_hash->{'RECORDS'}[$j] =
486 $tmprecord->as_usmarc();
491 $record = $results[ $i - 1 ]->record($j)->raw();
492 # warn "RECORD $j:".$record;
493 $results_hash->{'RECORDS'}[$j] = $record;
497 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
499 # Fill the facets while we're looping, but only for the
500 # biblioserver and not for a scan
501 if ( !$scan && $servers[ $i - 1 ] =~ /biblioserver/ ) {
502 $facets_counter = GetFacets( $results[ $i - 1 ] );
503 $facets_info = _get_facets_info( $facets );
507 if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
509 sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
510 keys %$facets_counter
514 my $number_of_facets;
515 my @this_facets_array;
518 $facets_counter->{$link_value}
519 ->{$b} <=> $facets_counter->{$link_value}
521 } keys %{ $facets_counter->{$link_value} }
525 if ( ( $number_of_facets <= 5 )
526 || ( $expanded_facet eq $link_value )
527 || ( $facets_info->{$link_value}->{'expanded'} )
531 # Sanitize the link value : parenthesis, question and exclamation mark will cause errors with CCL
532 my $facet_link_value = $one_facet;
533 $facet_link_value =~ s/[()!?¡¿؟]/ /g;
535 # fix the length that will display in the label,
536 my $facet_label_value = $one_facet;
537 my $facet_max_length = C4::Context->preference(
538 'FacetLabelTruncationLength')
541 substr( $one_facet, 0, $facet_max_length )
543 if length($facet_label_value) >
546 # if it's a branch, label by the name, not the code,
547 if ( $link_value =~ /branch/ ) {
548 if ( defined $branches
549 && ref($branches) eq "HASH"
550 && defined $branches->{$one_facet}
551 && ref( $branches->{$one_facet} ) eq
555 $branches->{$one_facet}
559 $facet_label_value = "*";
563 # if it's a itemtype, label by the name, not the code,
564 if ( $link_value =~ /itype/ ) {
565 if ( defined $itemtypes
566 && ref($itemtypes) eq "HASH"
567 && defined $itemtypes->{$one_facet}
568 && ref( $itemtypes->{$one_facet} ) eq
572 $itemtypes->{$one_facet}
573 ->{translated_description};
577 # also, if it's a location code, use the name instead of the code
578 if ( $link_value =~ /location/ ) {
580 GetKohaAuthorisedValueLib( 'LOC',
584 # but we're down with the whole label being in the link's title.
585 push @this_facets_array,
588 $facets_counter->{$link_value}
590 facet_label_value => $facet_label_value,
591 facet_title_value => $one_facet,
592 facet_link_value => $facet_link_value,
593 type_link_value => $link_value,
595 if ($facet_label_value);
599 # handle expanded option
600 unless ( $facets_info->{$link_value}->{'expanded'} ) {
602 if ( ( $number_of_facets > 5 )
603 && ( $expanded_facet ne $link_value ) );
607 type_link_value => $link_value,
608 type_id => $link_value . "_id",
610 . $facets_info->{$link_value}->{'label_value'} =>
612 facets => \@this_facets_array,
613 expandable => $expandable,
614 expand => $link_value,
618 $facets_info->{$link_value}->{'label_value'} =~
621 and ( Koha::Libraries->search->count == 1 )
627 return ( undef, $results_hashref, \@facets_loop );
635 my $indexing_mode = C4::Context->config('zebra_bib_index_mode') // 'dom';
636 my $use_zebra_facets = C4::Context->config('use_zebra_facets') // 0;
638 if ( $indexing_mode eq 'dom' &&
639 $use_zebra_facets ) {
640 $facets = _get_facets_from_zebra( $rs );
642 $facets = _get_facets_from_records( $rs );
648 sub _get_facets_from_records {
652 my $facets_maxrecs = C4::Context->preference('maxRecordsForFacets') // 20;
653 my $facets_config = getFacets();
655 my $size = $rs->size();
656 my $jmax = $size > $facets_maxrecs
660 for ( my $j = 0 ; $j < $jmax ; $j++ ) {
662 my $marc_record = new_record_from_zebra (
664 $rs->record( $j )->raw()
667 if ( ! defined $marc_record ) {
668 warn "ERROR DECODING RECORD - $@: " .
669 $rs->record( $j )->raw();
673 _get_facets_data_from_record( $marc_record, $facets_config, $facets );
679 =head2 _get_facets_data_from_record
681 C4::Search::_get_facets_data_from_record( $marc_record, $facets, $facets_counter );
683 Internal function that extracts facets information from a MARC::Record object
684 and populates $facets_counter for using in getRecords.
686 $facets is expected to be filled with C4::Koha::getFacets output (i.e. the configured
691 sub _get_facets_data_from_record {
693 my ( $marc_record, $facets, $facets_counter ) = @_;
695 for my $facet (@$facets) {
699 foreach my $tag ( @{ $facet->{ tags } } ) {
701 # tag number is the first three digits
702 my $tag_num = substr( $tag, 0, 3 );
703 # subfields are the remainder
704 my $subfield_letters = substr( $tag, 3 );
706 my @fields = $marc_record->field( $tag_num );
707 foreach my $field (@fields) {
708 # If $field->indicator(1) eq 'z', it means it is a 'see from'
709 # field introduced because of IncludeSeeFromInSearches, so skip it
710 next if $field->indicator(1) eq 'z';
712 my $data = $field->as_string( $subfield_letters, $facet->{ sep } );
714 unless ( grep { /^\Q$data\E$/ } @used_datas ) {
715 push @used_datas, $data;
716 $facets_counter->{ $facet->{ idx } }->{ $data }++;
723 =head2 _get_facets_from_zebra
725 my $facets = _get_facets_from_zebra( $result_set )
727 Retrieves facets for a specified result set. It loops through the facets defined
728 in C4::Koha::getFacets and returns a hash with the following structure:
738 sub _get_facets_from_zebra {
742 # save current elementSetName
743 my $elementSetName = $rs->option( 'elementSetName' );
745 my $facets_loop = getFacets();
746 my $facets_data = {};
747 # loop through defined facets and fill the facets hashref
748 foreach my $facet ( @$facets_loop ) {
750 my $idx = $facet->{ idx };
751 my $sep = $facet->{ sep };
752 my $facet_values = _get_facet_from_result_set( $idx, $rs, $sep );
753 if ( $facet_values ) {
754 # we've actually got a result
755 $facets_data->{ $idx } = $facet_values;
758 # set elementSetName to its previous value to avoid side effects
759 $rs->option( elementSetName => $elementSetName );
764 =head2 _get_facet_from_result_set
767 C4::Search::_get_facet_from_result_set( $facet_idx, $result_set, $sep )
769 Internal function that extracts facet information for a specific index ($facet_idx) and
770 returns a hash containing facet values and count:
773 $facet_value => $count ,
777 Warning: this function has the side effect of changing the elementSetName for the result
778 set. It is a helper function for the main loop, which takes care of backing it up for
783 sub _get_facet_from_result_set {
785 my $facet_idx = shift;
789 my $internal_sep = '<*>';
790 my $facetMaxCount = C4::Context->preference('FacetMaxCount') // 20;
792 return if ( ! defined $facet_idx || ! defined $rs );
793 # zebra's facet element, untokenized index
794 my $facet_element = 'zebra::facet::' . $facet_idx . ':0:' . $facetMaxCount;
795 # configure zebra results for retrieving the desired facet
796 $rs->option( elementSetName => $facet_element );
797 # get the facet record from result set
798 my $facet = $rs->record( 0 )->raw;
799 # if the facet has no restuls...
800 return if !defined $facet;
801 # TODO: benchmark DOM vs. SAX performance
802 my $facet_dom = XML::LibXML->load_xml(
805 my @terms = $facet_dom->getElementsByTagName('term');
809 foreach my $term ( @terms ) {
810 my $facet_value = $term->textContent;
811 $facet_value =~ s/\Q$internal_sep\E/$sep/ if defined $sep;
812 $facets->{ $facet_value } = $term->getAttribute( 'occur' );
818 =head2 _get_facets_info
820 my $facets_info = C4::Search::_get_facets_info( $facets )
822 Internal function that extracts facets information and properly builds
823 the data structure needed to render facet labels.
827 sub _get_facets_info {
831 my $facets_info = {};
833 for my $facet ( @$facets ) {
834 $facets_info->{ $facet->{ idx } }->{ label_value } = $facet->{ label };
835 $facets_info->{ $facet->{ idx } }->{ expanded } = $facet->{ expanded };
843 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
844 $results_per_page, $offset, $expanded_facet, $branches,
848 my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
850 $paz->search($simple_query);
851 sleep 1; # FIXME: WHY?
854 my $results_hashref = {};
855 my $stats = XMLin($paz->stat);
856 my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
858 # for a grouped search result, the number of hits
859 # is the number of groups returned; 'bib_hits' will have
860 # the total number of bibs.
861 $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
862 $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
864 HIT: foreach my $hit (@{ $results->{'hit'} }) {
865 my $recid = $hit->{recid}->[0];
867 my $work_title = $hit->{'md-work-title'}->[0];
869 if (exists $hit->{'md-work-author'}) {
870 $work_author = $hit->{'md-work-author'}->[0];
872 my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
874 my $result_group = {};
875 $result_group->{'group_label'} = $group_label;
876 $result_group->{'group_merge_key'} = $recid;
879 if (exists $hit->{count}) {
880 $count = $hit->{count}->[0];
882 $result_group->{'group_count'} = $count;
884 for (my $i = 0; $i < $count; $i++) {
885 # FIXME -- may need to worry about diacritics here
886 my $rec = $paz->record($recid, $i);
887 push @{ $result_group->{'RECORDS'} }, $rec;
890 push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
893 # pass through facets
894 my $termlist_xml = $paz->termlist('author,subject');
895 my $terms = XMLin($termlist_xml, forcearray => 1);
896 my @facets_loop = ();
897 #die Dumper($results);
898 # foreach my $list (sort keys %{ $terms->{'list'} }) {
900 # foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
902 # facet_label_value => $facet->{'name'}->[0],
905 # push @facets_loop, ( {
906 # type_label => $list,
907 # facets => \@facets,
911 return ( undef, $results_hashref, \@facets_loop );
915 sub _detect_truncation {
916 my ( $operand, $index ) = @_;
917 my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
920 my @wordlist = split( /\s/, $operand );
921 foreach my $word (@wordlist) {
922 if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
923 push @rightlefttruncated, $word;
925 elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
926 push @lefttruncated, $word;
928 elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
929 push @righttruncated, $word;
931 elsif ( index( $word, "*" ) < 0 ) {
932 push @nontruncated, $word;
935 push @regexpr, $word;
939 \@nontruncated, \@righttruncated, \@lefttruncated,
940 \@rightlefttruncated, \@regexpr
945 sub _build_stemmed_operand {
946 my ($operand,$lang) = @_;
947 require Lingua::Stem::Snowball ;
948 my $stemmed_operand=q{};
950 # If operand contains a digit, it is almost certainly an identifier, and should
951 # not be stemmed. This is particularly relevant for ISBNs and ISSNs, which
952 # can contain the letter "X" - for example, _build_stemmend_operand would reduce
953 # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
954 # results (e.g., "23 x 29 cm." from the 300$c). Bug 2098.
955 return $operand if $operand =~ /\d/;
957 # FIXME: the locale should be set based on the user's language and/or search choice
959 # Make sure we only use the first two letters from the language code
960 $lang = lc(substr($lang, 0, 2));
961 # The language codes for the two variants of Norwegian will now be "nb" and "nn",
962 # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
963 if ($lang eq 'nb' || $lang eq 'nn') {
966 my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
967 encoding => "UTF-8" );
969 my @words = split( / /, $operand );
970 my @stems = $stemmer->stem(\@words);
971 for my $stem (@stems) {
972 $stemmed_operand .= "$stem";
973 $stemmed_operand .= "?"
974 unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
975 $stemmed_operand .= " ";
977 warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
978 return $stemmed_operand;
982 sub _build_weighted_query {
984 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
985 # pretty well but could work much better if we had a smarter query parser
986 my ( $operand, $stemmed_operand, $index ) = @_;
987 my $stemming = C4::Context->preference("QueryStemming") || 0;
988 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
989 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
990 $operand =~ s/"/ /g; # Bug 7518: searches with quotation marks don't work
992 my $weighted_query .= "(rk=("; # Specifies that we're applying rank
994 # Keyword, or, no index specified
995 if ( ( $index eq 'kw' ) || ( !$index ) ) {
997 "Title-cover,ext,r1=\"$operand\""; # exact title-cover
998 $weighted_query .= " or ti,ext,r2=\"$operand\""; # exact title
999 $weighted_query .= " or Title-cover,phr,r3=\"$operand\""; # phrase title
1000 $weighted_query .= " or ti,wrdl,r4=\"$operand\""; # words in title
1001 #$weighted_query .= " or any,ext,r4=$operand"; # exact any
1002 #$weighted_query .=" or kw,wrdl,r5=\"$operand\""; # word list any
1003 $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
1004 if $fuzzy_enabled; # add fuzzy, word list
1005 $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
1006 if ( $stemming and $stemmed_operand )
1007 ; # add stemming, right truncation
1008 $weighted_query .= " or wrdl,r9=\"$operand\"";
1010 # embedded sorting: 0 a-z; 1 z-a
1011 # $weighted_query .= ") or (sort1,aut=1";
1014 # Barcode searches should skip this process
1015 elsif ( $index eq 'bc' ) {
1016 $weighted_query .= "bc=\"$operand\"";
1019 # Authority-number searches should skip this process
1020 elsif ( $index eq 'an' ) {
1021 $weighted_query .= "an=\"$operand\"";
1024 # If the index already has more than one qualifier, wrap the operand
1025 # in quotes and pass it back (assumption is that the user knows what they
1026 # are doing and won't appreciate us mucking up their query
1027 elsif ( $index =~ ',' ) {
1028 $weighted_query .= " $index=\"$operand\"";
1031 #TODO: build better cases based on specific search indexes
1033 $weighted_query .= " $index,ext,r1=\"$operand\""; # exact index
1034 #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
1035 $weighted_query .= " or $index,phr,r3=\"$operand\""; # phrase index
1036 $weighted_query .= " or $index,wrdl,r6=\"$operand\""; # word list index
1037 $weighted_query .= " or $index,wrdl,fuzzy,r8=\"$operand\""
1038 if $fuzzy_enabled; # add fuzzy, word list
1039 $weighted_query .= " or $index,wrdl,rt,r9=\"$stemmed_operand\""
1040 if ( $stemming and $stemmed_operand ); # add stemming, right truncation
1043 $weighted_query .= "))"; # close rank specification
1044 return $weighted_query;
1049 Return an array with available indexes.
1071 'Author-personal-bibliography',
1081 'Chronological-subdivision',
1091 'Conference-name-heading',
1092 'Conference-name-see',
1093 'Conference-name-seealso',
1098 'Corporate-name-heading',
1099 'Corporate-name-see',
1100 'Corporate-name-seealso',
1101 'Country-publication',
1104 'date-entered-on-file',
1105 'Date-of-acquisition',
1106 'Date-of-publication',
1107 'Date-time-last-modified',
1108 'Dewey-classification',
1109 'Dissertation-information',
1118 'Geographic-subdivision',
1121 'Heading-use-main-or-added-entry',
1122 'Heading-use-series-added-entry ',
1123 'Heading-use-subject-added-entry',
1126 'Illustration-code',
1128 'Index-term-uncontrolled',
1138 'language-original',
1147 'Local-classification',
1150 'Match-heading-see-from',
1158 'Name-geographic-heading',
1159 'Name-geographic-see',
1160 'Name-geographic-seealso',
1168 'Personal-name-heading',
1169 'Personal-name-see',
1170 'Personal-name-seealso',
1172 'Place-publication',
1179 'Record-control-number',
1190 'Subject-heading-thesaurus',
1191 'Subject-name-personal',
1192 'Subject-subdivision',
1201 'Term-genre-form-heading',
1202 'Term-genre-form-see',
1203 'Term-genre-form-seealso',
1209 'Title-uniform-heading',
1210 'Title-uniform-see',
1211 'Title-uniform-seealso',
1221 'classification-source',
1223 'coded-location-qualifier',
1234 'Local-classification',
1237 'materials-specified',
1242 'Number-local-acquisition',
1247 'replacementpricedate',
1262 =head2 _handle_exploding_index
1264 my $query = _handle_exploding_index($index, $term)
1266 Callback routine to generate the search for "exploding" indexes (i.e.
1267 those indexes which are turned into multiple or-connected searches based
1272 sub _handle_exploding_index {
1273 my ($QParser, $filter, $params, $negate, $server) = @_;
1274 my $index = $filter;
1275 my $term = join(' ', @$params);
1277 return unless ($index =~ m/(su-br|su-na|su-rl)/ && $term);
1279 my $marcflavour = C4::Context->preference('marcflavour');
1281 my $codesubfield = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1282 my $wantedcodes = '';
1283 my @subqueries = ( "\@attr 1=Subject \@attr 4=1 \"$term\"");
1284 my ($error, $results, $total_hits) = SimpleSearch( "he:$term", undef, undef, [ "authorityserver" ] );
1285 foreach my $auth (@$results) {
1286 my $record = MARC::Record->new_from_usmarc($auth);
1287 my @references = $record->field('5..');
1289 if ($index eq 'su-br') {
1291 } elsif ($index eq 'su-na') {
1293 } elsif ($index eq 'su-rl') {
1296 foreach my $reference (@references) {
1297 my $codes = $reference->subfield($codesubfield);
1298 push @subqueries, '@attr 1=Subject @attr 4=1 "' . $reference->as_string('abcdefghijlmnopqrstuvxyz') . '"' if (($codes && $codes eq $wantedcodes) || !$wantedcodes);
1302 my $query = ' @or ' x (scalar(@subqueries) - 1) . join(' ', @subqueries);
1308 ( $operators, $operands, $indexes, $limits,
1309 $sort_by, $scan, $lang ) =
1310 buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1312 Shim function to ease the transition from buildQuery to a new QueryParser.
1313 This function is called at the beginning of buildQuery, and modifies
1314 buildQuery's input. If it can handle the input, it returns a query that
1315 buildQuery will not try to parse.
1319 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1321 my @operators = $operators ? @$operators : ();
1322 my @indexes = $indexes ? @$indexes : ();
1323 my @operands = $operands ? @$operands : ();
1324 my @limits = $limits ? @$limits : ();
1325 my @sort_by = $sort_by ? @$sort_by : ();
1327 my $query = $operands[0];
1333 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') || $query =~ s/^qp=//);
1334 undef $QParser if ($query =~ m/^(ccl=|pqf=|cql=)/ || grep (/\w,\w|\w=\w/, @operands, @indexes) );
1335 undef $QParser if (scalar @limits > 0);
1339 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
1341 for ( my $ii = 0 ; $ii <= @operands ; $ii++ ) {
1342 next unless $operands[$ii];
1343 $query .= $operators[ $ii - 1 ] eq 'or' ? ' || ' : ' && '
1345 if ( $operands[$ii] =~ /^[^"]\W*[-|_\w]*:\w.*[^"]$/ ) {
1346 $query .= $operands[$ii];
1348 elsif ( $indexes[$ii] =~ m/su-/ ) {
1349 $query .= $indexes[$ii] . '(' . $operands[$ii] . ')';
1353 ( $indexes[$ii] ? "$indexes[$ii]:" : '' ) . $operands[$ii];
1356 foreach my $limit (@limits) {
1358 if ( scalar(@sort_by) > 0 ) {
1360 '#(' . join( '|', @{ $QParser->modifiers } ) . ')';
1361 $query =~ s/$modifier_re//g;
1362 foreach my $modifier (@sort_by) {
1363 $query .= " #$modifier";
1367 $query_desc = $query;
1368 $query_desc =~ s/\s+/ /g;
1369 if ( C4::Context->preference("QueryWeightFields") ) {
1371 $QParser->add_bib1_filter_map( 'su-br' => 'biblioserver' =>
1372 { 'target_syntax_callback' => \&_handle_exploding_index } );
1373 $QParser->add_bib1_filter_map( 'su-na' => 'biblioserver' =>
1374 { 'target_syntax_callback' => \&_handle_exploding_index } );
1375 $QParser->add_bib1_filter_map( 'su-rl' => 'biblioserver' =>
1376 { 'target_syntax_callback' => \&_handle_exploding_index } );
1377 $QParser->parse($query);
1378 $operands[0] = "pqf=" . $QParser->target_syntax('biblioserver');
1381 require Koha::QueryParser::Driver::PQF;
1382 my $modifier_re = '#(' . join( '|', @{Koha::QueryParser::Driver::PQF->modifiers}) . ')';
1383 s/$modifier_re//g for @operands;
1386 return ( $operators, \@operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc);
1392 $simple_query, $query_cgi,
1393 $query_desc, $limit,
1394 $limit_cgi, $limit_desc,
1395 $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1397 Build queries and limits in CCL, CGI, Human,
1398 handle truncation, stemming, field weighting, fuzziness, etc.
1400 See verbose embedded documentation.
1406 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1408 warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1411 ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc) = parseQuery($operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1414 my @operators = $operators ? @$operators : ();
1415 my @indexes = $indexes ? @$indexes : ();
1416 my @operands = $operands ? @$operands : ();
1417 my @limits = $limits ? @$limits : ();
1418 my @sort_by = $sort_by ? @$sort_by : ();
1420 my $stemming = C4::Context->preference("QueryStemming") || 0;
1421 my $auto_truncation = C4::Context->preference("QueryAutoTruncate") || 0;
1422 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1423 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1425 my $query = $operands[0];
1426 my $simple_query = $operands[0];
1428 # initialize the variables we're passing back
1437 my $cclindexes = getIndexes();
1438 if ( $query !~ /\s*(ccl=|pqf=|cql=)/ ) {
1439 while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1441 $cclq = grep { lc($_) eq $dx } @$cclindexes;
1443 $query = "ccl=$query" if $cclq;
1446 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1448 if ( $query =~ /^ccl=/ ) {
1450 # This is needed otherwise ccl= and &limit won't work together, and
1451 # this happens when selecting a subject on the opac-detail page
1452 @limits = grep {!/^$/} @limits;
1454 $q .= ' and '.join(' and ', @limits);
1456 return ( undef, $q, $q, "q=ccl=".uri_escape_utf8($q), $q, '', '', '', 'ccl' );
1458 if ( $query =~ /^cql=/ ) {
1459 return ( undef, $', $', "q=cql=".uri_escape_utf8($'), $', '', '', '', 'cql' );
1461 if ( $query =~ /^pqf=/ ) {
1463 $query_cgi = "q=".uri_escape_utf8($query_desc);
1466 $query_cgi = "q=pqf=".uri_escape_utf8($');
1468 return ( undef, $', $', $query_cgi, $query_desc, '', '', '', 'pqf' );
1471 # pass nested queries directly
1472 # FIXME: need better handling of some of these variables in this case
1473 # Nested queries aren't handled well and this implementation is flawed and causes users to be
1474 # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1475 # if ( $query =~ /(\(|\))/ ) {
1477 # undef, $query, $simple_query, $query_cgi,
1478 # $query, $limit, $limit_cgi, $limit_desc,
1483 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1484 # query operands and indexes and add stemming, truncation, field weighting, etc.
1485 # Once we do so, we'll end up with a value in $query, just like if we had an
1486 # incoming $query from the user
1489 ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1490 my $previous_operand
1491 ; # a flag used to keep track if there was a previous query
1492 # if there was, we can apply the current operator
1494 for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1496 # COMBINE OPERANDS, INDEXES AND OPERATORS
1497 if ( $operands[$i] ) {
1498 $operands[$i]=~s/^\s+//;
1500 # A flag to determine whether or not to add the index to the query
1503 # If the user is sophisticated enough to specify an index, turn off field weighting, and stemming handling
1504 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1508 $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1510 my $operand = $operands[$i];
1511 my $index = $indexes[$i];
1513 # Add index-specific attributes
1515 #Afaik, this 'yr' condition will only ever be met in the staff client advanced search
1516 #for "Publication date", since typing 'yr:YYYY' into the search box produces a CCL query,
1517 #which is processed higher up in this sub. Other than that, year searches are typically
1518 #handled as limits which are not processed her either.
1520 # Date of Publication
1521 if ( $index =~ /yr/ ) {
1522 #weight_fields/relevance search causes errors with date ranges
1523 #In the case of YYYY-, it will only return records with a 'yr' of YYYY (not the range)
1524 #In the case of YYYY-YYYY, it will return no results
1525 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1528 # Date of Acquisition
1529 elsif ( $index =~ /acqdate/ ) {
1530 #stemming and auto_truncation would have zero impact since it already is YYYY-MM-DD format
1531 #Weight_fields probably SHOULD be turned OFF, otherwise you'll get records floating to the
1532 #top of the results just because they have lots of item records matching that date.
1533 #Fuzzy actually only applies during _build_weighted_query, and is reset there anyway, so
1535 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = 0;
1537 # ISBN,ISSN,Standard Number, don't need special treatment
1538 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1540 $stemming, $auto_truncation,
1541 $weight_fields, $fuzzy_enabled
1544 if ( $index eq 'nb' ) {
1545 if ( C4::Context->preference("SearchWithISBNVariations") ) {
1546 my @isbns = C4::Koha::GetVariationsOfISBN( $operand );
1547 $operands[$i] = $operand = '(nb=' . join(' OR nb=', @isbns) . ')';
1548 $indexes[$i] = $index = '';
1557 # Set default structure attribute (word list)
1558 my $struct_attr = q{};
1559 unless ( $indexes_set || !$index || $index =~ /,(st-|phr|ext|wrdl)/ || $index =~ /^(nb|ns)$/ ) {
1560 $struct_attr = ",wrdl";
1563 # Some helpful index variants
1564 my $index_plus = $index . $struct_attr . ':';
1565 my $index_plus_comma = $index . $struct_attr . ',';
1567 if ($auto_truncation){
1568 unless ( $index =~ /,(st-|phr|ext)/ ) {
1569 #FIXME only valid with LTR scripts
1570 $operand=join(" ",map{
1571 (index($_,"*")>0?"$_":"$_*")
1572 }split (/\s+/,$operand));
1573 warn $operand if $DEBUG;
1578 my $truncated_operand;
1579 my( $nontruncated, $righttruncated, $lefttruncated,
1580 $rightlefttruncated, $regexpr
1581 ) = _detect_truncation( $operand, $index );
1583 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1588 scalar(@$righttruncated) + scalar(@$lefttruncated) +
1589 scalar(@$rightlefttruncated) > 0 )
1592 # Don't field weight or add the index to the query, we do it here
1594 undef $weight_fields;
1595 my $previous_truncation_operand;
1596 if (scalar @$nontruncated) {
1597 $truncated_operand .= "$index_plus @$nontruncated ";
1598 $previous_truncation_operand = 1;
1600 if (scalar @$righttruncated) {
1601 $truncated_operand .= "and " if $previous_truncation_operand;
1602 $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1603 $previous_truncation_operand = 1;
1605 if (scalar @$lefttruncated) {
1606 $truncated_operand .= "and " if $previous_truncation_operand;
1607 $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1608 $previous_truncation_operand = 1;
1610 if (scalar @$rightlefttruncated) {
1611 $truncated_operand .= "and " if $previous_truncation_operand;
1612 $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1613 $previous_truncation_operand = 1;
1616 $operand = $truncated_operand if $truncated_operand;
1617 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1620 my $stemmed_operand;
1621 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1624 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1626 # Handle Field Weighting
1627 my $weighted_operand;
1628 if ($weight_fields) {
1629 $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1630 $operand = $weighted_operand;
1634 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1636 ($query,$query_cgi,$query_desc,$previous_operand) = _build_initial_query({
1638 query_cgi => $query_cgi,
1639 query_desc => $query_desc,
1640 operator => ($operators[ $i - 1 ]) ? $operators[ $i - 1 ] : '',
1641 parsed_operand => $operand,
1642 original_operand => ($operands[$i]) ? $operands[$i] : '',
1644 index_plus => $index_plus,
1645 indexes_set => $indexes_set,
1646 previous_operand => $previous_operand,
1652 warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1655 my %group_OR_limits;
1656 my $availability_limit;
1657 foreach my $this_limit (@limits) {
1658 next unless $this_limit;
1659 if ( $this_limit =~ /available/ ) {
1661 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1663 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1664 $availability_limit .=
1665 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1666 $limit_cgi .= "&limit=available";
1670 # group_OR_limits, prefixed by mc-
1671 # OR every member of the group
1672 elsif ( $this_limit =~ /mc/ ) {
1673 my ($k,$v) = split(/:/, $this_limit,2);
1674 if ( $k !~ /mc-i(tem)?type/ ) {
1675 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1676 $this_limit =~ tr/"//d;
1677 $this_limit = $k.":'".$v."'";
1680 $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1681 $limit_desc .= " or " if $group_OR_limits{$k};
1682 $group_OR_limits{$k} .= "$this_limit";
1683 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1684 $limit_desc .= " $this_limit";
1687 # Regular old limits
1689 $limit .= " and " if $limit || $query;
1690 $limit .= "$this_limit";
1691 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1692 if ($this_limit =~ /^branch:(.+)/) {
1693 my $branchcode = $1;
1694 my $branchname = GetBranchName($branchcode);
1695 if (defined $branchname) {
1696 $limit_desc .= " branch:$branchname";
1698 $limit_desc .= " $this_limit";
1701 $limit_desc .= " $this_limit";
1705 foreach my $k (keys (%group_OR_limits)) {
1706 $limit .= " and " if ( $query || $limit );
1707 $limit .= "($group_OR_limits{$k})";
1709 if ($availability_limit) {
1710 $limit .= " and " if ( $query || $limit );
1711 $limit .= "($availability_limit)";
1714 # Normalize the query and limit strings
1715 # This is flawed , means we can't search anything with : in it
1716 # if user wants to do ccl or cql, start the query with that
1717 # $query =~ s/:/=/g;
1718 #NOTE: We use several several different regexps here as you can't have variable length lookback assertions
1719 $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1720 $query =~ s/(?<=(wrdl)):/=/g;
1721 $query =~ s/(?<=(trn|phr)):/=/g;
1722 $query =~ s/(?<=(st-numeric)):/=/g;
1723 $query =~ s/(?<=(st-year)):/=/g;
1724 $query =~ s/(?<=(st-date-normalized)):/=/g;
1726 for ( $query, $query_desc, $limit, $limit_desc ) {
1727 s/ +/ /g; # remove extra spaces
1728 s/^ //g; # remove any beginning spaces
1729 s/ $//g; # remove any ending spaces
1730 s/==/=/g; # remove double == from query
1732 $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1734 for ($query_cgi,$simple_query) {
1737 # append the limit to the query
1738 $query .= " " . $limit;
1742 warn "QUERY:" . $query;
1743 warn "QUERY CGI:" . $query_cgi;
1744 warn "QUERY DESC:" . $query_desc;
1745 warn "LIMIT:" . $limit;
1746 warn "LIMIT CGI:" . $limit_cgi;
1747 warn "LIMIT DESC:" . $limit_desc;
1748 warn "---------\nLeave buildQuery\n---------";
1751 undef, $query, $simple_query, $query_cgi,
1752 $query_desc, $limit, $limit_cgi, $limit_desc,
1757 =head2 _build_initial_query
1759 ($query, $query_cgi, $query_desc, $previous_operand) = _build_initial_query($initial_query_params);
1761 Build a section of the initial query containing indexes, operators, and operands.
1765 sub _build_initial_query {
1769 if ($params->{previous_operand}){
1770 #If there is a previous operand, add a supplied operator or the default 'and'
1771 $operator = ($params->{operator}) ? " ".($params->{operator})." " : ' and ';
1774 #NOTE: indexes_set is typically set when doing truncation or field weighting
1775 my $operand = ($params->{indexes_set}) ? $params->{parsed_operand} : $params->{index_plus}.$params->{parsed_operand};
1777 #e.g. "kw,wrdl:test"
1778 #e.g. " and kw,wrdl:test"
1779 $params->{query} .= $operator . $operand;
1781 $params->{query_cgi} .= "&op=".uri_escape_utf8($operator) if $operator;
1782 $params->{query_cgi} .= "&idx=".uri_escape_utf8($params->{index}) if $params->{index};
1783 $params->{query_cgi} .= "&q=".uri_escape_utf8($params->{original_operand}) if $params->{original_operand};
1785 #e.g. " and kw,wrdl: test"
1786 $params->{query_desc} .= $operator . $params->{index_plus} . " " . $params->{original_operand};
1788 $params->{previous_operand} = 1 unless $params->{previous_operand}; #If there is no previous operand, mark this as one
1790 return ($params->{query}, $params->{query_cgi}, $params->{query_desc}, $params->{previous_operand});
1793 =head2 searchResults
1795 my @search_results = searchResults($search_context, $searchdesc, $hits,
1796 $results_per_page, $offset, $scan,
1799 Format results in a form suitable for passing to the template
1803 # IMO this subroutine is pretty messy still -- it's responsible for
1804 # building the HTML output for the template
1806 my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1807 my $dbh = C4::Context->dbh;
1812 $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1813 my ($is_opac, $hidelostitems);
1814 if ($search_context eq 'opac') {
1815 $hidelostitems = C4::Context->preference('hidelostitems');
1819 #Build branchnames hash
1821 #get branch information.....
1823 my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1825 while ( my $bdata = $bsth->fetchrow_hashref ) {
1826 $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1828 # FIXME - We build an authorised values hash here, using the default framework
1829 # though it is possible to have different authvals for different fws.
1831 my $shelflocations =GetKohaAuthorisedValues('items.location','');
1833 # get notforloan authorised value list (see $shelflocations FIXME)
1834 my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1837 my %itemtypes = %{ GetItemTypes() };
1839 #search item field code
1840 my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber", "" );
1842 ## find column names of items related to MARC
1843 my %subfieldstosearch;
1844 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
1845 for my $column ( @columns ) {
1846 my ( $tagfield, $tagsubfield ) =
1847 &GetMarcFromKohaField( "items." . $column, "" );
1848 if ( defined $tagsubfield ) {
1849 $subfieldstosearch{$column} = $tagsubfield;
1853 # handle which records to actually retrieve
1855 if ( $hits && $offset + $results_per_page <= $hits ) {
1856 $times = $offset + $results_per_page;
1859 $times = $hits; # FIXME: if $hits is undefined, why do we want to equal it?
1862 my $marcflavour = C4::Context->preference("marcflavour");
1863 # We get the biblionumber position in MARC
1864 my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1866 # loop through all of the records we've retrieved
1867 for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1871 # For Scan searches we built USMARC data
1872 $marcrecord = MARC::Record->new_from_usmarc( $marcresults->[$i]);
1874 # Normal search, render from Zebra's output
1875 $marcrecord = new_record_from_zebra(
1880 if ( ! defined $marcrecord ) {
1881 warn "ERROR DECODING RECORD - $@: " . $marcresults->[$i];
1889 ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1890 : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1892 SetUTF8Flag($marcrecord);
1893 my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, $fw );
1894 $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1895 $oldbiblio->{result_number} = $i + 1;
1897 # add imageurl to itemtype if there is one
1898 $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1900 $oldbiblio->{'authorised_value_images'} = ($search_context eq 'opac' && C4::Context->preference('AuthorisedValueImages')) || ($search_context eq 'intranet' && C4::Context->preference('StaffAuthorisedValueImages')) ? C4::Items::get_authorised_value_images( C4::Biblio::get_biblio_authorised_values( $oldbiblio->{'biblionumber'}, $marcrecord ) ) : [];
1901 $oldbiblio->{normalized_upc} = GetNormalizedUPC( $marcrecord,$marcflavour);
1902 $oldbiblio->{normalized_ean} = GetNormalizedEAN( $marcrecord,$marcflavour);
1903 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1904 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1905 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1907 # edition information, if any
1908 $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1909 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{translated_description};
1910 # Build summary if there is one (the summary is defined in the itemtypes table)
1911 # FIXME: is this used anywhere, I think it can be commented out? -- JF
1912 if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1913 my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1914 my @fields = $marcrecord->fields();
1917 foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1919 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1920 $tag =~ /(.{3})(.)/;
1921 if($marcrecord->field($1)){
1922 my @abc = $marcrecord->field($1)->subfield($2);
1923 $tags->{$tag} = $#abc + 1 ;
1927 # We catch how many times to repeat this line
1929 foreach my $tag (keys(%$tags)){
1930 $max = $tags->{$tag} if($tags->{$tag} > $max);
1933 # we replace, and repeat each line
1934 for (my $i = 0 ; $i < $max ; $i++){
1935 my $newline = $line;
1937 foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1938 $tag =~ /(.{3})(.)/;
1940 if($marcrecord->field($1)){
1941 my @repl = $marcrecord->field($1)->subfield($2);
1942 my $subfieldvalue = $repl[$i];
1943 $newline =~ s/\[$tag\]/$subfieldvalue/g;
1946 $newsummary .= "$newline\n";
1950 $newsummary =~ s/\[(.*?)]//g;
1951 $newsummary =~ s/\n/<br\/>/g;
1952 $oldbiblio->{summary} = $newsummary;
1955 # Pull out the items fields
1956 my @fields = $marcrecord->field($itemtag);
1957 my $marcflavor = C4::Context->preference("marcflavour");
1958 # adding linked items that belong to host records
1959 my $analyticsfield = '773';
1960 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1961 $analyticsfield = '773';
1962 } elsif ($marcflavor eq 'UNIMARC') {
1963 $analyticsfield = '461';
1965 foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
1966 my $hostbiblionumber = $hostfield->subfield("0");
1967 my $linkeditemnumber = $hostfield->subfield("9");
1968 if(!$hostbiblionumber eq undef){
1969 my $hostbiblio = GetMarcBiblio($hostbiblionumber, 1);
1970 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
1971 if(!$hostbiblio eq undef){
1972 my @hostitems = $hostbiblio->field($itemfield);
1973 foreach my $hostitem (@hostitems){
1974 if ($hostitem->subfield("9") eq $linkeditemnumber){
1975 my $linkeditem =$hostitem;
1976 # append linked items if they exist
1977 if (!$linkeditem eq undef){
1978 push (@fields, $linkeditem);}
1985 # Setting item statuses for display
1986 my @available_items_loop;
1987 my @onloan_items_loop;
1988 my @other_items_loop;
1990 my $available_items;
1994 my $ordered_count = 0;
1995 my $available_count = 0;
1996 my $onloan_count = 0;
1997 my $longoverdue_count = 0;
1998 my $other_count = 0;
1999 my $withdrawn_count = 0;
2000 my $itemlost_count = 0;
2001 my $hideatopac_count = 0;
2002 my $itembinding_count = 0;
2003 my $itemdamaged_count = 0;
2004 my $item_in_transit_count = 0;
2005 my $can_place_holds = 0;
2006 my $item_onhold_count = 0;
2007 my $notforloan_count = 0;
2008 my $items_count = scalar(@fields);
2009 my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
2010 my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
2011 my @hiddenitems; # hidden itemnumbers based on OpacHiddenItems syspref
2013 # loop through every item
2014 foreach my $field (@fields) {
2017 # populate the items hash
2018 foreach my $code ( keys %subfieldstosearch ) {
2019 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
2021 $item->{description} = $itemtypes{ $item->{itype} }{translated_description};
2025 # hidden because lost
2026 if ($hidelostitems && $item->{itemlost}) {
2027 $hideatopac_count++;
2030 # hidden based on OpacHiddenItems syspref
2031 my @hi = C4::Items::GetHiddenItemnumbers($item);
2033 push @hiddenitems, @hi;
2034 $hideatopac_count++;
2039 my $hbranch = C4::Context->preference('StaffSearchResultsDisplayBranch');
2040 my $otherbranch = $hbranch eq 'homebranch' ? 'holdingbranch' : 'homebranch';
2042 # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
2043 if ($item->{$hbranch}) {
2044 $item->{'branchname'} = $branches{$item->{$hbranch}};
2046 elsif ($item->{$otherbranch}) { # Last resort
2047 $item->{'branchname'} = $branches{$item->{$otherbranch}};
2050 my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
2051 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
2052 my $userenv = C4::Context->userenv;
2053 if ( $item->{onloan}
2054 && !( C4::Members::GetHideLostItemsPreference( $userenv->{'number'} ) && $item->{itemlost} ) )
2057 my $key = $prefix . $item->{onloan} . $item->{barcode};
2058 $onloan_items->{$key}->{due_date} = output_pref( { dt => dt_from_string( $item->{onloan} ), dateonly => 1 } );
2059 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
2060 $onloan_items->{$key}->{branchname} = $item->{branchname};
2061 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2062 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
2063 $onloan_items->{$key}->{description} = $item->{description};
2064 $onloan_items->{$key}->{imageurl} =
2065 getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2067 # if something's checked out and lost, mark it as 'long overdue'
2068 if ( $item->{itemlost} ) {
2069 $onloan_items->{$key}->{longoverdue}++;
2070 $longoverdue_count++;
2072 else { # can place holds as long as item isn't lost
2073 $can_place_holds = 1;
2077 # items not on loan, but still unavailable ( lost, withdrawn, damaged )
2080 $item->{notforloan}=1 if !$item->{notforloan} && $itemtypes{ C4::Context->preference("item-level_itypes")? $item->{itype}: $oldbiblio->{itemtype} }->{notforloan};
2083 if ( $item->{notforloan} < 0 ) {
2085 } elsif ( $item->{notforloan} > 0 ) {
2086 $notforloan_count++;
2089 # is item in transit?
2090 my $transfertwhen = '';
2091 my ($transfertfrom, $transfertto);
2093 # is item on the reserve shelf?
2094 my $reservestatus = '';
2096 unless ($item->{withdrawn}
2097 || $item->{itemlost}
2099 || $item->{notforloan}
2100 || ( C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck')
2101 && $items_count > C4::Context->preference('MaxSearchResultsItemsPerRecordStatusCheck') ) ) {
2103 # A couple heuristics to limit how many times
2104 # we query the database for item transfer information, sacrificing
2105 # accuracy in some cases for speed;
2107 # 1. don't query if item has one of the other statuses
2108 # 2. don't check transit status if the bib has
2109 # more than 20 items
2111 # FIXME: to avoid having the query the database like this, and to make
2112 # the in transit status count as unavailable for search limiting,
2113 # should map transit status to record indexed in Zebra.
2115 ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
2116 $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
2119 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
2120 if ( $item->{withdrawn}
2121 || $item->{itemlost}
2123 || $item->{notforloan}
2124 || $reservestatus eq 'Waiting'
2125 || ($transfertwhen ne ''))
2127 $withdrawn_count++ if $item->{withdrawn};
2128 $itemlost_count++ if $item->{itemlost};
2129 $itemdamaged_count++ if $item->{damaged};
2130 $item_in_transit_count++ if $transfertwhen ne '';
2131 $item_onhold_count++ if $reservestatus eq 'Waiting';
2132 $item->{status} = $item->{withdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
2134 # can place a hold on a item if
2135 # not lost nor withdrawn
2136 # not damaged unless AllowHoldsOnDamagedItems is true
2137 # item is either for loan or on order (notforloan < 0)
2138 $can_place_holds = 1
2141 && !$item->{withdrawn}
2142 && ( !$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems') )
2143 && ( !$item->{notforloan} || $item->{notforloan} < 0 )
2148 my $key = $prefix . $item->{status};
2149 foreach (qw(withdrawn itemlost damaged branchname itemcallnumber)) {
2150 $other_items->{$key}->{$_} = $item->{$_};
2152 $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
2153 $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
2154 $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
2155 $other_items->{$key}->{count}++ if $item->{$hbranch};
2156 $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2157 $other_items->{$key}->{description} = $item->{description};
2158 $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2162 $can_place_holds = 1;
2164 $available_items->{$prefix}->{count}++ if $item->{$hbranch};
2165 foreach (qw(branchname itemcallnumber description)) {
2166 $available_items->{$prefix}->{$_} = $item->{$_};
2168 $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
2169 $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2172 } # notforloan, item level and biblioitem level
2174 # if all items are hidden, do not show the record
2175 if ($items_count > 0 && $hideatopac_count == $items_count) {
2179 my ( $availableitemscount, $onloanitemscount, $otheritemscount );
2180 for my $key ( sort keys %$onloan_items ) {
2181 (++$onloanitemscount > $maxitems) and last;
2182 push @onloan_items_loop, $onloan_items->{$key};
2184 for my $key ( sort keys %$other_items ) {
2185 (++$otheritemscount > $maxitems) and last;
2186 push @other_items_loop, $other_items->{$key};
2188 for my $key ( sort keys %$available_items ) {
2189 (++$availableitemscount > $maxitems) and last;
2190 push @available_items_loop, $available_items->{$key}
2193 # XSLT processing of some stuff
2194 my $interface = $search_context eq 'opac' ? 'OPAC' : '';
2195 if (!$scan && C4::Context->preference($interface . "XSLTResultsDisplay")) {
2196 $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $interface."XSLTResultsDisplay", 1, \@hiddenitems);
2197 # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
2200 # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
2201 if (!C4::Context->preference("item-level_itypes")) {
2202 if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
2203 $can_place_holds = 0;
2206 $oldbiblio->{norequests} = 1 unless $can_place_holds;
2207 $oldbiblio->{itemsplural} = 1 if $items_count > 1;
2208 $oldbiblio->{items_count} = $items_count;
2209 $oldbiblio->{available_items_loop} = \@available_items_loop;
2210 $oldbiblio->{onloan_items_loop} = \@onloan_items_loop;
2211 $oldbiblio->{other_items_loop} = \@other_items_loop;
2212 $oldbiblio->{availablecount} = $available_count;
2213 $oldbiblio->{availableplural} = 1 if $available_count > 1;
2214 $oldbiblio->{onloancount} = $onloan_count;
2215 $oldbiblio->{onloanplural} = 1 if $onloan_count > 1;
2216 $oldbiblio->{othercount} = $other_count;
2217 $oldbiblio->{otherplural} = 1 if $other_count > 1;
2218 $oldbiblio->{withdrawncount} = $withdrawn_count;
2219 $oldbiblio->{itemlostcount} = $itemlost_count;
2220 $oldbiblio->{damagedcount} = $itemdamaged_count;
2221 $oldbiblio->{intransitcount} = $item_in_transit_count;
2222 $oldbiblio->{onholdcount} = $item_onhold_count;
2223 $oldbiblio->{orderedcount} = $ordered_count;
2224 $oldbiblio->{notforloancount} = $notforloan_count;
2226 if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
2227 my $fieldspec = C4::Context->preference("AlternateHoldingsField");
2228 my $subfields = substr $fieldspec, 3;
2229 my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
2230 my @alternateholdingsinfo = ();
2231 my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
2232 my $alternateholdingscount = 0;
2234 for my $field (@holdingsfields) {
2235 my %holding = ( holding => '' );
2236 my $havesubfield = 0;
2237 for my $subfield ($field->subfields()) {
2238 if ((index $subfields, $$subfield[0]) >= 0) {
2239 $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
2240 $holding{'holding'} .= $$subfield[1];
2244 if ($havesubfield) {
2245 push(@alternateholdingsinfo, \%holding);
2246 $alternateholdingscount++;
2250 $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
2251 $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
2254 push( @newresults, $oldbiblio );
2260 =head2 SearchAcquisitions
2261 Search for acquisitions
2264 sub SearchAcquisitions{
2265 my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
2267 my $dbh=C4::Context->dbh;
2268 # Variable initialization
2272 LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
2273 LEFT JOIN items ON items.biblionumber=biblio.biblionumber
2274 WHERE dateaccessioned BETWEEN ? AND ?
2277 my (@params,@loopcriteria);
2279 push @params, $datebegin->output("iso");
2280 push @params, $dateend->output("iso");
2282 if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
2283 if(C4::Context->preference("item-level_itypes")){
2284 $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2286 $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2288 push @params, @$itemtypes;
2291 if ($criteria =~/itemtype/){
2292 if(C4::Context->preference("item-level_itypes")){
2293 $str .= "AND items.itype=? ";
2295 $str .= "AND biblioitems.itemtype=? ";
2298 if(scalar(@$itemtypes) == 0){
2299 my $itypes = GetItemTypes();
2300 for my $key (keys %$itypes){
2301 push @$itemtypes, $key;
2305 @loopcriteria= @$itemtypes;
2306 }elsif ($criteria=~/itemcallnumber/){
2307 $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
2308 OR items.itemcallnumber is NULL
2309 OR items.itemcallnumber = '')";
2311 @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
2313 $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
2314 @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
2317 if ($orderby =~ /date_desc/){
2318 $str.=" ORDER BY dateaccessioned DESC";
2320 $str.=" ORDER BY title";
2323 my $qdataacquisitions=$dbh->prepare($str);
2325 my @loopacquisitions;
2326 foreach my $value(@loopcriteria){
2327 push @params,$value;
2329 $cell{"title"}=$value;
2330 $cell{"titlecode"}=$value;
2332 eval{$qdataacquisitions->execute(@params);};
2334 if ($@){ warn "recentacquisitions Error :$@";}
2337 while (my $data=$qdataacquisitions->fetchrow_hashref){
2338 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
2340 $cell{"loopdata"}=\@loopdata;
2342 push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
2345 $qdataacquisitions->finish;
2346 return \@loopacquisitions;
2349 =head2 enabled_staff_search_views
2351 %hash = enabled_staff_search_views()
2353 This function returns a hash that contains three flags obtained from the system
2354 preferences, used to determine whether a particular staff search results view
2359 =item C<Output arg:>
2361 * $hash{can_view_MARC} is true only if the MARC view is enabled
2362 * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2363 * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2365 =item C<usage in the script:>
2369 $template->param ( C4::Search::enabled_staff_search_views );
2373 sub enabled_staff_search_views
2376 can_view_MARC => C4::Context->preference('viewMARC'), # 1 if the staff search allows the MARC view
2377 can_view_ISBD => C4::Context->preference('viewISBD'), # 1 if the staff search allows the ISBD view
2378 can_view_labeledMARC => C4::Context->preference('viewLabeledMARC'), # 1 if the staff search allows the Labeled MARC view
2382 =head2 z3950_search_args
2384 $arrayref = z3950_search_args($matchpoints)
2386 This function returns an array reference that contains the search parameters to be
2387 passed to the Z39.50 search script (z3950_search.pl). The array elements
2388 are hash refs whose keys are name and value, and whose values are the
2389 name of a search parameter, the value of that search parameter and the URL encoded
2390 value of that parameter.
2392 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2394 The search parameter values are obtained from the bibliographic record whose
2395 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2397 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2398 a general purpose search argument. In this case, the returned array contains only
2399 entry: the key is 'title' and the value is derived from $matchpoints.
2401 If a search parameter value is undefined or empty, it is not included in the returned
2404 The returned array reference may be passed directly to the template parameters.
2408 =item C<Output arg:>
2410 * $array containing hash refs as described above
2412 =item C<usage in the script:>
2416 $data = Biblio::GetBiblioData($bibno);
2417 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2421 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2425 sub z3950_search_args {
2428 my $isbn_string = ref( $bibrec ) ? $bibrec->{title} : $bibrec;
2429 my $isbn = Business::ISBN->new( $isbn_string );
2431 if (defined $isbn && $isbn->is_valid)
2433 if ( ref($bibrec) ) {
2434 $bibrec->{isbn} = $isbn_string;
2435 $bibrec->{title} = undef;
2437 $bibrec = { isbn => $isbn_string };
2441 $bibrec = { title => $bibrec } if !ref $bibrec;
2444 for my $field (qw/ lccn isbn issn title author dewey subject /)
2446 push @$array, { name => $field, value => $bibrec->{$field} }
2447 if defined $bibrec->{$field};
2452 =head2 GetDistinctValues($field);
2454 C<$field> is a reference to the fields array
2458 sub GetDistinctValues {
2459 my ($fieldname,$string)=@_;
2460 # returns a reference to a hash of references to branches...
2461 if ($fieldname=~/\./){
2462 my ($table,$column)=split /\./, $fieldname;
2463 my $dbh = C4::Context->dbh;
2464 warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2465 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 ");
2467 my $elements=$sth->fetchall_arrayref({});
2472 my @servers=qw<biblioserver authorityserver>;
2473 my (@zconns,@results);
2474 for ( my $i = 0 ; $i < @servers ; $i++ ) {
2475 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2478 ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2481 # The big moment: asynchronously retrieve results from all servers
2487 my ( $i, $size ) = @_;
2488 for ( my $j = 0 ; $j < $size ; $j++ ) {
2490 @hashscan{qw(value cnt)} =
2491 $results[ $i - 1 ]->display_term($j);
2492 push @elements, \%hashscan;
2500 =head2 _ZOOM_event_loop
2502 _ZOOM_event_loop(\@zconns, \@results, sub {
2503 my ( $i, $size ) = @_;
2507 Processes a ZOOM event loop and passes control to a closure for
2508 processing the results, and destroying the resultsets.
2512 sub _ZOOM_event_loop {
2513 my ($zconns, $results, $callback) = @_;
2514 while ( ( my $i = ZOOM::event( $zconns ) ) != 0 ) {
2515 my $ev = $zconns->[ $i - 1 ]->last_event();
2516 if ( $ev == ZOOM::Event::ZEND ) {
2517 next unless $results->[ $i - 1 ];
2518 my $size = $results->[ $i - 1 ]->size();
2520 $callback->($i, $size);
2525 foreach my $result (@$results) {
2530 =head2 new_record_from_zebra
2532 Given raw data from a Zebra result set, return a MARC::Record object
2534 This helper function is needed to take into account all the involved
2535 system preferences and configuration variables to properly create the
2536 MARC::Record object.
2538 If we are using GRS-1, then the raw data we get from Zebra should be USMARC
2539 data. If we are using DOM, then it has to be MARCXML.
2543 sub new_record_from_zebra {
2546 my $raw_data = shift;
2547 # Set the default indexing modes
2548 my $index_mode = ( $server eq 'biblioserver' )
2549 ? C4::Context->config('zebra_bib_index_mode') // 'dom'
2550 : C4::Context->config('zebra_auth_index_mode') // 'dom';
2552 my $marc_record = eval {
2553 if ( $index_mode eq 'dom' ) {
2554 MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2556 MARC::Record->new_from_usmarc( $raw_data );
2563 return $marc_record;
2568 END { } # module clean-up code here (global destructor)
2575 Koha Development Team <http://koha-community.org/>