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
25 use C4::Search::PazPar2;
27 use C4::Dates qw(format_date);
28 use C4::Members qw(GetHideLostItemsPreference);
31 use C4::Reserves; # GetReserveStatus
39 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
41 # set the version for version checking
43 $VERSION = 3.07.00.049;
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
75 # make all your functions, whether exported or not;
79 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
81 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
87 my $dbh = C4::Context->dbh;
88 my $result = TransformMarcToKoha( $dbh, $record, '' );
93 my ( $biblionumber, $title );
95 # search duplicate on ISBN, easy and fast..
97 if ( $result->{isbn} ) {
98 $result->{isbn} =~ s/\(.*$//;
99 $result->{isbn} =~ s/\s+$//;
100 $query = "isbn:$result->{isbn}";
104 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser'));
110 $titleindex = 'title|exact';
111 $authorindex = 'author|exact';
113 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
115 $titleindex = 'ti,ext';
116 $authorindex = 'au,ext';
120 $result->{title} =~ s /\\//g;
121 $result->{title} =~ s /\"//g;
122 $result->{title} =~ s /\(//g;
123 $result->{title} =~ s /\)//g;
125 # FIXME: instead of removing operators, could just do
126 # quotes around the value
127 $result->{title} =~ s/(and|or|not)//g;
128 $query = "$titleindex:\"$result->{title}\"";
129 if ( $result->{author} ) {
130 $result->{author} =~ s /\\//g;
131 $result->{author} =~ s /\"//g;
132 $result->{author} =~ s /\(//g;
133 $result->{author} =~ s /\)//g;
135 # remove valid operators
136 $result->{author} =~ s/(and|or|not)//g;
137 $query .= " $op $authorindex:\"$result->{author}\"";
141 my ( $error, $searchresults, undef ) = SimpleSearch($query); # FIXME :: hardcoded !
143 if (!defined $error) {
144 foreach my $possible_duplicate_record (@{$searchresults}) {
145 my $marcrecord = new_record_from_zebra(
147 $possible_duplicate_record
150 my $result = TransformMarcToKoha( $dbh, $marcrecord, '' );
152 # FIXME :: why 2 $biblionumber ?
154 push @results, $result->{'biblionumber'};
155 push @results, $result->{'title'};
164 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers] );
166 This function provides a simple search API on the bibliographic catalog
172 * $query can be a simple keyword or a complete CCL query
173 * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
174 * $offset - If present, represents the number of records at the beggining to omit. Defaults to 0
175 * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
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(C4::Context->dbh,$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 ) = @_;
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 );
248 $QParser->parse( $query );
249 $query = $QParser->target_syntax($servers[$i]);
250 $zoom_queries[$i] = new ZOOM::Query::PQF( $query, $zconns[$i]);
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, $expanded_facet, $branches,$itemtypes,
318 The all singing, all dancing, multi-server, asynchronous, scanning,
319 searching, record nabbing, facet-building
321 See verbse embedded documentation.
327 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
328 $results_per_page, $offset, $expanded_facet, $branches,
329 $itemtypes, $query_type, $scan, $opac
332 my @servers = @$servers_ref;
333 my @sort_by = @$sort_by_ref;
335 # Initialize variables for the ZOOM connection and results object
339 my $results_hashref = ();
341 # Initialize variables for the faceted results objects
342 my $facets_counter = {};
343 my $facets_info = {};
344 my $facets = getFacets();
346 my @facets_loop; # stores the ref to array of hashes for template facets loop
348 ### LOOP THROUGH THE SERVERS
349 for ( my $i = 0 ; $i < @servers ; $i++ ) {
350 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
352 # perform the search, create the results objects
353 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
354 my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
356 #$query_to_use = $simple_query if $scan;
357 warn $simple_query if ( $scan and $DEBUG );
359 # Check if we've got a query_type defined, if so, use it
362 if ($query_type =~ /^ccl/) {
363 $query_to_use =~ s/\:/\=/g; # change : to = last minute (FIXME)
364 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
365 } elsif ($query_type =~ /^cql/) {
366 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
367 } elsif ($query_type =~ /^pqf/) {
368 $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
370 warn "Unknown query_type '$query_type'. Results undetermined.";
373 $results[$i] = $zconns[$i]->scan( new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
375 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
379 warn "WARNING: query problem with $query_to_use " . $@;
382 # Concatenate the sort_by limits and pass them to the results object
383 # Note: sort will override rank
385 foreach my $sort (@sort_by) {
386 if ( $sort eq "author_az" || $sort eq "author_asc" ) {
387 $sort_by .= "1=1003 <i ";
389 elsif ( $sort eq "author_za" || $sort eq "author_dsc" ) {
390 $sort_by .= "1=1003 >i ";
392 elsif ( $sort eq "popularity_asc" ) {
393 $sort_by .= "1=9003 <i ";
395 elsif ( $sort eq "popularity_dsc" ) {
396 $sort_by .= "1=9003 >i ";
398 elsif ( $sort eq "call_number_asc" ) {
399 $sort_by .= "1=8007 <i ";
401 elsif ( $sort eq "call_number_dsc" ) {
402 $sort_by .= "1=8007 >i ";
404 elsif ( $sort eq "pubdate_asc" ) {
405 $sort_by .= "1=31 <i ";
407 elsif ( $sort eq "pubdate_dsc" ) {
408 $sort_by .= "1=31 >i ";
410 elsif ( $sort eq "acqdate_asc" ) {
411 $sort_by .= "1=32 <i ";
413 elsif ( $sort eq "acqdate_dsc" ) {
414 $sort_by .= "1=32 >i ";
416 elsif ( $sort eq "title_az" || $sort eq "title_asc" ) {
417 $sort_by .= "1=4 <i ";
419 elsif ( $sort eq "title_za" || $sort eq "title_dsc" ) {
420 $sort_by .= "1=4 >i ";
423 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
426 if ( $sort_by && !$scan && $results[$i] ) {
427 if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
428 warn "WARNING sort $sort_by failed";
431 } # finished looping through servers
433 # The big moment: asynchronously retrieve results from all servers
438 my ( $i, $size ) = @_;
441 # loop through the results
442 $results_hash->{'hits'} = $size;
444 if ( $offset + $results_per_page <= $size ) {
445 $times = $offset + $results_per_page;
451 for ( my $j = $offset ; $j < $times ; $j++ ) {
455 ## Check if it's an index scan
457 my ( $term, $occ ) = $results[ $i - 1 ]->display_term($j);
459 # here we create a minimal MARC record and hand it off to the
460 # template just like a normal result ... perhaps not ideal, but
462 my $tmprecord = MARC::Record->new();
463 $tmprecord->encoding('UTF-8');
467 # the minimal record in author/title (depending on MARC flavour)
468 if ( C4::Context->preference("marcflavour") eq
471 $tmptitle = MARC::Field->new(
476 $tmprecord->append_fields($tmptitle);
480 MARC::Field->new( '245', ' ', ' ', a => $term, );
482 MARC::Field->new( '100', ' ', ' ', a => $occ, );
483 $tmprecord->append_fields($tmptitle);
484 $tmprecord->append_fields($tmpauthor);
486 $results_hash->{'RECORDS'}[$j] =
487 $tmprecord->as_usmarc();
492 $record = $results[ $i - 1 ]->record($j)->raw();
493 # warn "RECORD $j:".$record;
494 $results_hash->{'RECORDS'}[$j] = $record;
498 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
500 # Fill the facets while we're looping, but only for the
501 # biblioserver and not for a scan
502 if ( !$scan && $servers[ $i - 1 ] =~ /biblioserver/ ) {
503 $facets_counter = GetFacets( $results[ $i - 1 ] );
504 $facets_info = _get_facets_info( $facets );
508 if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
510 sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
511 keys %$facets_counter
515 my $number_of_facets;
516 my @this_facets_array;
519 $facets_counter->{$link_value}
520 ->{$b} <=> $facets_counter->{$link_value}
522 } keys %{ $facets_counter->{$link_value} }
526 if ( ( $number_of_facets <= 5 )
527 || ( $expanded_facet eq $link_value )
528 || ( $facets_info->{$link_value}->{'expanded'} )
532 # Sanitize the link value : parenthesis, question and exclamation mark will cause errors with CCL
533 my $facet_link_value = $one_facet;
534 $facet_link_value =~ s/[()!?¡¿؟]/ /g;
536 # fix the length that will display in the label,
537 my $facet_label_value = $one_facet;
538 my $facet_max_length = C4::Context->preference(
539 'FacetLabelTruncationLength')
542 substr( $one_facet, 0, $facet_max_length )
544 if length($facet_label_value) >
547 # if it's a branch, label by the name, not the code,
548 if ( $link_value =~ /branch/ ) {
549 if ( defined $branches
550 && ref($branches) eq "HASH"
551 && defined $branches->{$one_facet}
552 && ref( $branches->{$one_facet} ) eq
556 $branches->{$one_facet}
560 $facet_label_value = "*";
564 # if it's a itemtype, label by the name, not the code,
565 if ( $link_value =~ /itype/ ) {
566 if ( defined $itemtypes
567 && ref($itemtypes) eq "HASH"
568 && defined $itemtypes->{$one_facet}
569 && ref( $itemtypes->{$one_facet} ) eq
573 $itemtypes->{$one_facet}
578 # also, if it's a location code, use the name instead of the code
579 if ( $link_value =~ /location/ ) {
581 GetKohaAuthorisedValueLib( 'LOC',
585 # but we're down with the whole label being in the link's title.
586 push @this_facets_array,
589 $facets_counter->{$link_value}
591 facet_label_value => $facet_label_value,
592 facet_title_value => $one_facet,
593 facet_link_value => $facet_link_value,
594 type_link_value => $link_value,
596 if ($facet_label_value);
600 # handle expanded option
601 unless ( $facets_info->{$link_value}->{'expanded'} ) {
603 if ( ( $number_of_facets > 5 )
604 && ( $expanded_facet ne $link_value ) );
608 type_link_value => $link_value,
609 type_id => $link_value . "_id",
611 . $facets_info->{$link_value}->{'label_value'} =>
613 facets => \@this_facets_array,
614 expandable => $expandable,
615 expand => $link_value,
619 $facets_info->{$link_value}->{'label_value'} =~
622 and ( C4::Context->preference('singleBranchMode') )
628 return ( undef, $results_hashref, \@facets_loop );
636 my $indexing_mode = C4::Context->config('zebra_bib_index_mode') // 'dom';
637 my $use_zebra_facets = C4::Context->config('use_zebra_facets') // 0;
639 if ( $indexing_mode eq 'dom' &&
640 $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 { /^\Q$data\E$/ } @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 };
836 $facets_info->{ $facet->{ idx } }->{ expanded } = $facet->{ expanded };
844 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
845 $results_per_page, $offset, $expanded_facet, $branches,
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 _remove_stopwords {
917 my ( $operand, $index ) = @_;
918 my @stopwords_removed;
920 # phrase and exact-qualified indexes shouldn't have stopwords removed
921 if ( $index !~ m/,(phr|ext)/ ) {
923 # remove stopwords from operand : parse all stopwords & remove them (case insensitive)
924 # we use IsAlpha unicode definition, to deal correctly with diacritics.
925 # otherwise, a French word like "leçon" woudl be split into "le" "çon", "le"
926 # is a stopword, we'd get "çon" and wouldn't find anything...
928 foreach ( keys %{ C4::Context->stopwords } ) {
929 next if ( $_ =~ /(and|or|not)/ ); # don't remove operators
930 if ( my ($matched) = ($operand =~
931 /([^\X\p{isAlnum}]\Q$_\E[^\X\p{isAlnum}]|[^\X\p{isAlnum}]\Q$_\E$|^\Q$_\E[^\X\p{isAlnum}])/gi))
933 $operand =~ s/\Q$matched\E/ /gi;
934 push @stopwords_removed, $_;
938 return ( $operand, \@stopwords_removed );
942 sub _detect_truncation {
943 my ( $operand, $index ) = @_;
944 my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
947 my @wordlist = split( /\s/, $operand );
948 foreach my $word (@wordlist) {
949 if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
950 push @rightlefttruncated, $word;
952 elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
953 push @lefttruncated, $word;
955 elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
956 push @righttruncated, $word;
958 elsif ( index( $word, "*" ) < 0 ) {
959 push @nontruncated, $word;
962 push @regexpr, $word;
966 \@nontruncated, \@righttruncated, \@lefttruncated,
967 \@rightlefttruncated, \@regexpr
972 sub _build_stemmed_operand {
973 my ($operand,$lang) = @_;
974 require Lingua::Stem::Snowball ;
975 my $stemmed_operand=q{};
977 # If operand contains a digit, it is almost certainly an identifier, and should
978 # not be stemmed. This is particularly relevant for ISBNs and ISSNs, which
979 # can contain the letter "X" - for example, _build_stemmend_operand would reduce
980 # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
981 # results (e.g., "23 x 29 cm." from the 300$c). Bug 2098.
982 return $operand if $operand =~ /\d/;
984 # FIXME: the locale should be set based on the user's language and/or search choice
986 # Make sure we only use the first two letters from the language code
987 $lang = lc(substr($lang, 0, 2));
988 # The language codes for the two variants of Norwegian will now be "nb" and "nn",
989 # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
990 if ($lang eq 'nb' || $lang eq 'nn') {
993 my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
994 encoding => "UTF-8" );
996 my @words = split( / /, $operand );
997 my @stems = $stemmer->stem(\@words);
998 for my $stem (@stems) {
999 $stemmed_operand .= "$stem";
1000 $stemmed_operand .= "?"
1001 unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
1002 $stemmed_operand .= " ";
1004 warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
1005 return $stemmed_operand;
1009 sub _build_weighted_query {
1011 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
1012 # pretty well but could work much better if we had a smarter query parser
1013 my ( $operand, $stemmed_operand, $index ) = @_;
1014 my $stemming = C4::Context->preference("QueryStemming") || 0;
1015 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1016 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1017 $operand =~ s/"/ /g; # Bug 7518: searches with quotation marks don't work
1019 my $weighted_query .= "(rk=("; # Specifies that we're applying rank
1021 # Keyword, or, no index specified
1022 if ( ( $index eq 'kw' ) || ( !$index ) ) {
1024 "Title-cover,ext,r1=\"$operand\""; # exact title-cover
1025 $weighted_query .= " or ti,ext,r2=\"$operand\""; # exact title
1026 $weighted_query .= " or Title-cover,phr,r3=\"$operand\""; # phrase title
1027 $weighted_query .= " or ti,wrdl,r4=\"$operand\""; # words in title
1028 #$weighted_query .= " or any,ext,r4=$operand"; # exact any
1029 #$weighted_query .=" or kw,wrdl,r5=\"$operand\""; # word list any
1030 $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
1031 if $fuzzy_enabled; # add fuzzy, word list
1032 $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
1033 if ( $stemming and $stemmed_operand )
1034 ; # add stemming, right truncation
1035 $weighted_query .= " or wrdl,r9=\"$operand\"";
1037 # embedded sorting: 0 a-z; 1 z-a
1038 # $weighted_query .= ") or (sort1,aut=1";
1041 # Barcode searches should skip this process
1042 elsif ( $index eq 'bc' ) {
1043 $weighted_query .= "bc=\"$operand\"";
1046 # Authority-number searches should skip this process
1047 elsif ( $index eq 'an' ) {
1048 $weighted_query .= "an=\"$operand\"";
1051 # If the index already has more than one qualifier, wrap the operand
1052 # in quotes and pass it back (assumption is that the user knows what they
1053 # are doing and won't appreciate us mucking up their query
1054 elsif ( $index =~ ',' ) {
1055 $weighted_query .= " $index=\"$operand\"";
1058 #TODO: build better cases based on specific search indexes
1060 $weighted_query .= " $index,ext,r1=\"$operand\""; # exact index
1061 #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
1062 $weighted_query .= " or $index,phr,r3=\"$operand\""; # phrase index
1063 $weighted_query .= " or $index,wrdl,r6=\"$operand\""; # word list index
1064 $weighted_query .= " or $index,wrdl,fuzzy,r8=\"$operand\""
1065 if $fuzzy_enabled; # add fuzzy, word list
1066 $weighted_query .= " or $index,wrdl,rt,r9=\"$stemmed_operand\""
1067 if ( $stemming and $stemmed_operand ); # add stemming, right truncation
1070 $weighted_query .= "))"; # close rank specification
1071 return $weighted_query;
1076 Return an array with available indexes.
1098 'Author-personal-bibliography',
1108 'Chronological-subdivision',
1118 'Conference-name-heading',
1119 'Conference-name-see',
1120 'Conference-name-seealso',
1125 'Corporate-name-heading',
1126 'Corporate-name-see',
1127 'Corporate-name-seealso',
1128 'Country-publication',
1131 'date-entered-on-file',
1132 'Date-of-acquisition',
1133 'Date-of-publication',
1134 'Dewey-classification',
1135 'Dissertation-information',
1142 'Geographic-subdivision',
1145 'Heading-use-main-or-added-entry',
1146 'Heading-use-series-added-entry ',
1147 'Heading-use-subject-added-entry',
1150 'Illustration-code',
1152 'Index-term-uncontrolled',
1162 'language-original',
1171 'Local-classification',
1174 'Match-heading-see-from',
1182 'Name-geographic-heading',
1183 'Name-geographic-see',
1184 'Name-geographic-seealso',
1192 'Personal-name-heading',
1193 'Personal-name-see',
1194 'Personal-name-seealso',
1196 'Place-publication',
1201 'Record-control-number',
1212 'Subject-heading-thesaurus',
1213 'Subject-name-personal',
1214 'Subject-subdivision',
1223 'Term-genre-form-heading',
1224 'Term-genre-form-see',
1225 'Term-genre-form-seealso',
1231 'Title-uniform-heading',
1232 'Title-uniform-see',
1233 'Title-uniform-seealso',
1243 'classification-source',
1245 'coded-location-qualifier',
1256 'Local-classification',
1259 'materials-specified',
1264 'Number-local-acquisition',
1269 'replacementpricedate',
1284 =head2 _handle_exploding_index
1286 my $query = _handle_exploding_index($index, $term)
1288 Callback routine to generate the search for "exploding" indexes (i.e.
1289 those indexes which are turned into multiple or-connected searches based
1294 sub _handle_exploding_index {
1295 my ($QParser, $filter, $params, $negate, $server) = @_;
1296 my $index = $filter;
1297 my $term = join(' ', @$params);
1299 return unless ($index =~ m/(su-br|su-na|su-rl)/ && $term);
1301 my $marcflavour = C4::Context->preference('marcflavour');
1303 my $codesubfield = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1304 my $wantedcodes = '';
1305 my @subqueries = ( "\@attr 1=Subject \@attr 4=1 \"$term\"");
1306 my ($error, $results, $total_hits) = SimpleSearch( "he:$term", undef, undef, [ "authorityserver" ] );
1307 foreach my $auth (@$results) {
1308 my $record = MARC::Record->new_from_usmarc($auth);
1309 my @references = $record->field('5..');
1311 if ($index eq 'su-br') {
1313 } elsif ($index eq 'su-na') {
1315 } elsif ($index eq 'su-rl') {
1318 foreach my $reference (@references) {
1319 my $codes = $reference->subfield($codesubfield);
1320 push @subqueries, '@attr 1=Subject @attr 4=1 "' . $reference->as_string('abcdefghijlmnopqrstuvxyz') . '"' if (($codes && $codes eq $wantedcodes) || !$wantedcodes);
1324 my $query = ' @or ' x (scalar(@subqueries) - 1) . join(' ', @subqueries);
1330 ( $operators, $operands, $indexes, $limits,
1331 $sort_by, $scan, $lang ) =
1332 buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1334 Shim function to ease the transition from buildQuery to a new QueryParser.
1335 This function is called at the beginning of buildQuery, and modifies
1336 buildQuery's input. If it can handle the input, it returns a query that
1337 buildQuery will not try to parse.
1341 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1343 my @operators = $operators ? @$operators : ();
1344 my @indexes = $indexes ? @$indexes : ();
1345 my @operands = $operands ? @$operands : ();
1346 my @limits = $limits ? @$limits : ();
1347 my @sort_by = $sort_by ? @$sort_by : ();
1349 my $query = $operands[0];
1355 $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser') || $query =~ s/^qp=//);
1356 undef $QParser if ($query =~ m/^(ccl=|pqf=|cql=)/ || grep (/\w,\w|\w=\w/, @operands, @indexes) );
1357 undef $QParser if (scalar @limits > 0);
1361 $QParser->custom_data->{'QueryAutoTruncate'} = C4::Context->preference('QueryAutoTruncate');
1363 for ( my $ii = 0 ; $ii <= @operands ; $ii++ ) {
1364 next unless $operands[$ii];
1365 $query .= $operators[ $ii - 1 ] eq 'or' ? ' || ' : ' && '
1367 if ( $operands[$ii] =~ /^[^"]\W*[-|_\w]*:\w.*[^"]$/ ) {
1368 $query .= $operands[$ii];
1370 elsif ( $indexes[$ii] =~ m/su-/ ) {
1371 $query .= $indexes[$ii] . '(' . $operands[$ii] . ')';
1375 ( $indexes[$ii] ? "$indexes[$ii]:" : '' ) . $operands[$ii];
1378 foreach my $limit (@limits) {
1380 if ( scalar(@sort_by) > 0 ) {
1382 '#(' . join( '|', @{ $QParser->modifiers } ) . ')';
1383 $query =~ s/$modifier_re//g;
1384 foreach my $modifier (@sort_by) {
1385 $query .= " #$modifier";
1389 $query_desc = $query;
1390 $query_desc =~ s/\s+/ /g;
1391 if ( C4::Context->preference("QueryWeightFields") ) {
1393 $QParser->add_bib1_filter_map( 'su-br' => 'biblioserver' =>
1394 { 'target_syntax_callback' => \&_handle_exploding_index } );
1395 $QParser->add_bib1_filter_map( 'su-na' => 'biblioserver' =>
1396 { 'target_syntax_callback' => \&_handle_exploding_index } );
1397 $QParser->add_bib1_filter_map( 'su-rl' => 'biblioserver' =>
1398 { 'target_syntax_callback' => \&_handle_exploding_index } );
1399 $QParser->parse($query);
1400 $operands[0] = "pqf=" . $QParser->target_syntax('biblioserver');
1403 require Koha::QueryParser::Driver::PQF;
1404 my $modifier_re = '#(' . join( '|', @{Koha::QueryParser::Driver::PQF->modifiers}) . ')';
1405 s/$modifier_re//g for @operands;
1408 return ( $operators, \@operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc);
1414 $simple_query, $query_cgi,
1415 $query_desc, $limit,
1416 $limit_cgi, $limit_desc,
1417 $stopwords_removed, $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1419 Build queries and limits in CCL, CGI, Human,
1420 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
1422 See verbose embedded documentation.
1428 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1430 warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1433 ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang, $query_desc) = parseQuery($operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1436 my @operators = $operators ? @$operators : ();
1437 my @indexes = $indexes ? @$indexes : ();
1438 my @operands = $operands ? @$operands : ();
1439 my @limits = $limits ? @$limits : ();
1440 my @sort_by = $sort_by ? @$sort_by : ();
1442 my $stemming = C4::Context->preference("QueryStemming") || 0;
1443 my $auto_truncation = C4::Context->preference("QueryAutoTruncate") || 0;
1444 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1445 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1446 my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
1448 my $query = $operands[0];
1449 my $simple_query = $operands[0];
1451 # initialize the variables we're passing back
1459 my $stopwords_removed; # flag to determine if stopwords have been removed
1462 my $cclindexes = getIndexes();
1463 if ( $query !~ /\s*(ccl=|pqf=|cql=)/ ) {
1464 while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1466 $cclq = grep { lc($_) eq $dx } @$cclindexes;
1468 $query = "ccl=$query" if $cclq;
1471 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1473 if ( $query =~ /^ccl=/ ) {
1475 # This is needed otherwise ccl= and &limit won't work together, and
1476 # this happens when selecting a subject on the opac-detail page
1477 @limits = grep {!/^$/} @limits;
1479 $q .= ' and '.join(' and ', @limits);
1481 return ( undef, $q, $q, "q=ccl=".uri_escape_utf8($q), $q, '', '', '', '', 'ccl' );
1483 if ( $query =~ /^cql=/ ) {
1484 return ( undef, $', $', "q=cql=".uri_escape_utf8($'), $', '', '', '', '', 'cql' );
1486 if ( $query =~ /^pqf=/ ) {
1488 $query_cgi = "q=".uri_escape_utf8($query_desc);
1491 $query_cgi = "q=pqf=".uri_escape_utf8($');
1493 return ( undef, $', $', $query_cgi, $query_desc, '', '', '', '', 'pqf' );
1496 # pass nested queries directly
1497 # FIXME: need better handling of some of these variables in this case
1498 # Nested queries aren't handled well and this implementation is flawed and causes users to be
1499 # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1500 # if ( $query =~ /(\(|\))/ ) {
1502 # undef, $query, $simple_query, $query_cgi,
1503 # $query, $limit, $limit_cgi, $limit_desc,
1504 # $stopwords_removed, 'ccl'
1508 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1509 # query operands and indexes and add stemming, truncation, field weighting, etc.
1510 # Once we do so, we'll end up with a value in $query, just like if we had an
1511 # incoming $query from the user
1514 ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1515 my $previous_operand
1516 ; # a flag used to keep track if there was a previous query
1517 # if there was, we can apply the current operator
1519 for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1521 # COMBINE OPERANDS, INDEXES AND OPERATORS
1522 if ( $operands[$i] ) {
1523 $operands[$i]=~s/^\s+//;
1525 # A flag to determine whether or not to add the index to the query
1528 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
1529 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1532 $remove_stopwords = 0;
1534 $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1536 my $operand = $operands[$i];
1537 my $index = $indexes[$i];
1539 # Add index-specific attributes
1541 #Afaik, this 'yr' condition will only ever be met in the staff client advanced search
1542 #for "Publication date", since typing 'yr:YYYY' into the search box produces a CCL query,
1543 #which is processed higher up in this sub. Other than that, year searches are typically
1544 #handled as limits which are not processed her either.
1546 # Date of Publication
1547 if ( $index =~ /yr/ ) {
1548 #weight_fields/relevance search causes errors with date ranges
1549 #In the case of YYYY-, it will only return records with a 'yr' of YYYY (not the range)
1550 #In the case of YYYY-YYYY, it will return no results
1551 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1554 # Date of Acquisition
1555 elsif ( $index =~ /acqdate/ ) {
1556 #stemming and auto_truncation would have zero impact since it already is YYYY-MM-DD format
1557 #Weight_fields probably SHOULD be turned OFF, otherwise you'll get records floating to the
1558 #top of the results just because they have lots of item records matching that date.
1559 #Fuzzy actually only applies during _build_weighted_query, and is reset there anyway, so
1561 #remove_stopwords doesn't function anymore so is irrelevant
1562 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1564 # ISBN,ISSN,Standard Number, don't need special treatment
1565 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1567 $stemming, $auto_truncation,
1568 $weight_fields, $fuzzy_enabled,
1570 ) = ( 0, 0, 0, 0, 0 );
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 = '';
1585 # Set default structure attribute (word list)
1586 my $struct_attr = q{};
1587 unless ( $indexes_set || !$index || $index =~ /,(st-|phr|ext|wrdl)/ || $index =~ /^(nb|ns)$/ ) {
1588 $struct_attr = ",wrdl";
1591 # Some helpful index variants
1592 my $index_plus = $index . $struct_attr . ':';
1593 my $index_plus_comma = $index . $struct_attr . ',';
1596 if ($remove_stopwords) {
1597 ( $operand, $stopwords_removed ) =
1598 _remove_stopwords( $operand, $index );
1599 warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
1600 warn "REMOVED STOPWORDS: @$stopwords_removed"
1601 if ( $stopwords_removed && $DEBUG );
1604 if ($auto_truncation){
1605 unless ( $index =~ /,(st-|phr|ext)/ ) {
1606 #FIXME only valid with LTR scripts
1607 $operand=join(" ",map{
1608 (index($_,"*")>0?"$_":"$_*")
1609 }split (/\s+/,$operand));
1610 warn $operand if $DEBUG;
1615 my $truncated_operand;
1616 my( $nontruncated, $righttruncated, $lefttruncated,
1617 $rightlefttruncated, $regexpr
1618 ) = _detect_truncation( $operand, $index );
1620 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1625 scalar(@$righttruncated) + scalar(@$lefttruncated) +
1626 scalar(@$rightlefttruncated) > 0 )
1629 # Don't field weight or add the index to the query, we do it here
1631 undef $weight_fields;
1632 my $previous_truncation_operand;
1633 if (scalar @$nontruncated) {
1634 $truncated_operand .= "$index_plus @$nontruncated ";
1635 $previous_truncation_operand = 1;
1637 if (scalar @$righttruncated) {
1638 $truncated_operand .= "and " if $previous_truncation_operand;
1639 $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1640 $previous_truncation_operand = 1;
1642 if (scalar @$lefttruncated) {
1643 $truncated_operand .= "and " if $previous_truncation_operand;
1644 $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1645 $previous_truncation_operand = 1;
1647 if (scalar @$rightlefttruncated) {
1648 $truncated_operand .= "and " if $previous_truncation_operand;
1649 $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1650 $previous_truncation_operand = 1;
1653 $operand = $truncated_operand if $truncated_operand;
1654 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1657 my $stemmed_operand;
1658 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1661 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1663 # Handle Field Weighting
1664 my $weighted_operand;
1665 if ($weight_fields) {
1666 $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1667 $operand = $weighted_operand;
1671 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1673 ($query,$query_cgi,$query_desc,$previous_operand) = _build_initial_query({
1675 query_cgi => $query_cgi,
1676 query_desc => $query_desc,
1677 operator => ($operators[ $i - 1 ]) ? $operators[ $i - 1 ] : '',
1678 parsed_operand => $operand,
1679 original_operand => ($operands[$i]) ? $operands[$i] : '',
1681 index_plus => $index_plus,
1682 indexes_set => $indexes_set,
1683 previous_operand => $previous_operand,
1689 warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1692 my %group_OR_limits;
1693 my $availability_limit;
1694 foreach my $this_limit (@limits) {
1695 next unless $this_limit;
1696 if ( $this_limit =~ /available/ ) {
1698 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1700 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1701 $availability_limit .=
1702 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1703 $limit_cgi .= "&limit=available";
1707 # group_OR_limits, prefixed by mc-
1708 # OR every member of the group
1709 elsif ( $this_limit =~ /mc/ ) {
1710 my ($k,$v) = split(/:/, $this_limit,2);
1711 if ( $k !~ /mc-i(tem)?type/ ) {
1712 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1713 $this_limit =~ tr/"//d;
1714 $this_limit = $k.":'".$v."'";
1717 $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1718 $limit_desc .= " or " if $group_OR_limits{$k};
1719 $group_OR_limits{$k} .= "$this_limit";
1720 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1721 $limit_desc .= " $this_limit";
1724 # Regular old limits
1726 $limit .= " and " if $limit || $query;
1727 $limit .= "$this_limit";
1728 $limit_cgi .= "&limit=" . uri_escape_utf8($this_limit);
1729 if ($this_limit =~ /^branch:(.+)/) {
1730 my $branchcode = $1;
1731 my $branchname = GetBranchName($branchcode);
1732 if (defined $branchname) {
1733 $limit_desc .= " branch:$branchname";
1735 $limit_desc .= " $this_limit";
1738 $limit_desc .= " $this_limit";
1742 foreach my $k (keys (%group_OR_limits)) {
1743 $limit .= " and " if ( $query || $limit );
1744 $limit .= "($group_OR_limits{$k})";
1746 if ($availability_limit) {
1747 $limit .= " and " if ( $query || $limit );
1748 $limit .= "($availability_limit)";
1751 # Normalize the query and limit strings
1752 # This is flawed , means we can't search anything with : in it
1753 # if user wants to do ccl or cql, start the query with that
1754 # $query =~ s/:/=/g;
1755 #NOTE: We use several several different regexps here as you can't have variable length lookback assertions
1756 $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1757 $query =~ s/(?<=(wrdl)):/=/g;
1758 $query =~ s/(?<=(trn|phr)):/=/g;
1759 $query =~ s/(?<=(st-numeric)):/=/g;
1760 $query =~ s/(?<=(st-year)):/=/g;
1761 $query =~ s/(?<=(st-date-normalized)):/=/g;
1763 for ( $query, $query_desc, $limit, $limit_desc ) {
1764 s/ +/ /g; # remove extra spaces
1765 s/^ //g; # remove any beginning spaces
1766 s/ $//g; # remove any ending spaces
1767 s/==/=/g; # remove double == from query
1769 $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1771 for ($query_cgi,$simple_query) {
1774 # append the limit to the query
1775 $query .= " " . $limit;
1779 warn "QUERY:" . $query;
1780 warn "QUERY CGI:" . $query_cgi;
1781 warn "QUERY DESC:" . $query_desc;
1782 warn "LIMIT:" . $limit;
1783 warn "LIMIT CGI:" . $limit_cgi;
1784 warn "LIMIT DESC:" . $limit_desc;
1785 warn "---------\nLeave buildQuery\n---------";
1788 undef, $query, $simple_query, $query_cgi,
1789 $query_desc, $limit, $limit_cgi, $limit_desc,
1790 $stopwords_removed, $query_type
1794 =head2 _build_initial_query
1796 ($query, $query_cgi, $query_desc, $previous_operand) = _build_initial_query($initial_query_params);
1798 Build a section of the initial query containing indexes, operators, and operands.
1802 sub _build_initial_query {
1806 if ($params->{previous_operand}){
1807 #If there is a previous operand, add a supplied operator or the default 'and'
1808 $operator = ($params->{operator}) ? " ".($params->{operator})." " : ' and ';
1811 #NOTE: indexes_set is typically set when doing truncation or field weighting
1812 my $operand = ($params->{indexes_set}) ? $params->{parsed_operand} : $params->{index_plus}.$params->{parsed_operand};
1814 #e.g. "kw,wrdl:test"
1815 #e.g. " and kw,wrdl:test"
1816 $params->{query} .= $operator . $operand;
1818 $params->{query_cgi} .= "&op=".uri_escape_utf8($operator) if $operator;
1819 $params->{query_cgi} .= "&idx=".uri_escape_utf8($params->{index}) if $params->{index};
1820 $params->{query_cgi} .= "&q=".uri_escape_utf8($params->{original_operand}) if $params->{original_operand};
1822 #e.g. " and kw,wrdl: test"
1823 $params->{query_desc} .= $operator . $params->{index_plus} . " " . $params->{original_operand};
1825 $params->{previous_operand} = 1 unless $params->{previous_operand}; #If there is no previous operand, mark this as one
1827 return ($params->{query}, $params->{query_cgi}, $params->{query_desc}, $params->{previous_operand});
1830 =head2 searchResults
1832 my @search_results = searchResults($search_context, $searchdesc, $hits,
1833 $results_per_page, $offset, $scan,
1836 Format results in a form suitable for passing to the template
1840 # IMO this subroutine is pretty messy still -- it's responsible for
1841 # building the HTML output for the template
1843 my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1844 my $dbh = C4::Context->dbh;
1849 $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1850 my ($is_opac, $hidelostitems);
1851 if ($search_context eq 'opac') {
1852 $hidelostitems = C4::Context->preference('hidelostitems');
1856 #Build branchnames hash
1858 #get branch information.....
1860 my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1862 while ( my $bdata = $bsth->fetchrow_hashref ) {
1863 $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1865 # FIXME - We build an authorised values hash here, using the default framework
1866 # though it is possible to have different authvals for different fws.
1868 my $shelflocations =GetKohaAuthorisedValues('items.location','');
1870 # get notforloan authorised value list (see $shelflocations FIXME)
1871 my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1873 #Build itemtype hash
1874 #find itemtype & itemtype image
1878 "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1881 while ( my $bdata = $bsth->fetchrow_hashref ) {
1882 foreach (qw(description imageurl summary notforloan)) {
1883 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1887 #search item field code
1888 my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber", "" );
1890 ## find column names of items related to MARC
1891 my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1893 my %subfieldstosearch;
1894 while ( ( my $column ) = $sth2->fetchrow ) {
1895 my ( $tagfield, $tagsubfield ) =
1896 &GetMarcFromKohaField( "items." . $column, "" );
1897 if ( defined $tagsubfield ) {
1898 $subfieldstosearch{$column} = $tagsubfield;
1902 # handle which records to actually retrieve
1904 if ( $hits && $offset + $results_per_page <= $hits ) {
1905 $times = $offset + $results_per_page;
1908 $times = $hits; # FIXME: if $hits is undefined, why do we want to equal it?
1911 my $marcflavour = C4::Context->preference("marcflavour");
1912 # We get the biblionumber position in MARC
1913 my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
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( $dbh, $marcrecord, $fw );
1943 $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1944 $oldbiblio->{result_number} = $i + 1;
1946 # add imageurl to itemtype if there is one
1947 $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1949 $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 ) ) : [];
1950 $oldbiblio->{normalized_upc} = GetNormalizedUPC( $marcrecord,$marcflavour);
1951 $oldbiblio->{normalized_ean} = GetNormalizedEAN( $marcrecord,$marcflavour);
1952 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1953 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1954 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1956 # edition information, if any
1957 $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1958 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1959 # Build summary if there is one (the summary is defined in the itemtypes table)
1960 # FIXME: is this used anywhere, I think it can be commented out? -- JF
1961 if ( $itemtypes{ $oldbiblio->{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");
2007 # adding linked items that belong to host records
2008 my $analyticsfield = '773';
2009 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
2010 $analyticsfield = '773';
2011 } elsif ($marcflavor eq 'UNIMARC') {
2012 $analyticsfield = '461';
2014 foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
2015 my $hostbiblionumber = $hostfield->subfield("0");
2016 my $linkeditemnumber = $hostfield->subfield("9");
2017 if(!$hostbiblionumber eq undef){
2018 my $hostbiblio = GetMarcBiblio($hostbiblionumber, 1);
2019 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
2020 if(!$hostbiblio eq undef){
2021 my @hostitems = $hostbiblio->field($itemfield);
2022 foreach my $hostitem (@hostitems){
2023 if ($hostitem->subfield("9") eq $linkeditemnumber){
2024 my $linkeditem =$hostitem;
2025 # append linked items if they exist
2026 if (!$linkeditem eq undef){
2027 push (@fields, $linkeditem);}
2034 # Setting item statuses for display
2035 my @available_items_loop;
2036 my @onloan_items_loop;
2037 my @other_items_loop;
2039 my $available_items;
2043 my $ordered_count = 0;
2044 my $available_count = 0;
2045 my $onloan_count = 0;
2046 my $longoverdue_count = 0;
2047 my $other_count = 0;
2048 my $withdrawn_count = 0;
2049 my $itemlost_count = 0;
2050 my $hideatopac_count = 0;
2051 my $itembinding_count = 0;
2052 my $itemdamaged_count = 0;
2053 my $item_in_transit_count = 0;
2054 my $can_place_holds = 0;
2055 my $item_onhold_count = 0;
2056 my $notforloan_count = 0;
2057 my $items_count = scalar(@fields);
2058 my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
2059 my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
2060 my @hiddenitems; # hidden itemnumbers based on OpacHiddenItems syspref
2062 # loop through every item
2063 foreach my $field (@fields) {
2066 # populate the items hash
2067 foreach my $code ( keys %subfieldstosearch ) {
2068 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
2070 $item->{description} = $itemtypes{ $item->{itype} }{description};
2074 # hidden because lost
2075 if ($hidelostitems && $item->{itemlost}) {
2076 $hideatopac_count++;
2079 # hidden based on OpacHiddenItems syspref
2080 my @hi = C4::Items::GetHiddenItemnumbers($item);
2082 push @hiddenitems, @hi;
2083 $hideatopac_count++;
2088 my $hbranch = C4::Context->preference('StaffSearchResultsDisplayBranch');
2089 my $otherbranch = $hbranch eq 'homebranch' ? 'holdingbranch' : 'homebranch';
2091 # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
2092 if ($item->{$hbranch}) {
2093 $item->{'branchname'} = $branches{$item->{$hbranch}};
2095 elsif ($item->{$otherbranch}) { # Last resort
2096 $item->{'branchname'} = $branches{$item->{$otherbranch}};
2099 my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
2100 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
2101 my $userenv = C4::Context->userenv;
2102 if ( $item->{onloan} && !(C4::Members::GetHideLostItemsPreference($userenv->{'number'}) && $item->{itemlost}) ) {
2104 my $key = $prefix . $item->{onloan} . $item->{barcode};
2105 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
2106 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
2107 $onloan_items->{$key}->{branchname} = $item->{branchname};
2108 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2109 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
2110 $onloan_items->{$key}->{description} = $item->{description};
2111 $onloan_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2112 # if something's checked out and lost, mark it as 'long overdue'
2113 if ( $item->{itemlost} ) {
2114 $onloan_items->{$prefix}->{longoverdue}++;
2115 $longoverdue_count++;
2116 } else { # can place holds as long as item isn't lost
2117 $can_place_holds = 1;
2121 # items not on loan, but still unavailable ( lost, withdrawn, damaged )
2125 if ( $item->{notforloan} < 0 ) {
2127 } elsif ( $item->{notforloan} > 0 ) {
2128 $notforloan_count++;
2131 # is item in transit?
2132 my $transfertwhen = '';
2133 my ($transfertfrom, $transfertto);
2135 # is item on the reserve shelf?
2136 my $reservestatus = '';
2138 unless ($item->{withdrawn}
2139 || $item->{itemlost}
2141 || $item->{notforloan}
2142 || $items_count > 20) {
2144 # A couple heuristics to limit how many times
2145 # we query the database for item transfer information, sacrificing
2146 # accuracy in some cases for speed;
2148 # 1. don't query if item has one of the other statuses
2149 # 2. don't check transit status if the bib has
2150 # more than 20 items
2152 # FIXME: to avoid having the query the database like this, and to make
2153 # the in transit status count as unavailable for search limiting,
2154 # should map transit status to record indexed in Zebra.
2156 ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
2157 $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
2160 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
2161 if ( $item->{withdrawn}
2162 || $item->{itemlost}
2164 || $item->{notforloan}
2165 || $reservestatus eq 'Waiting'
2166 || ($transfertwhen ne ''))
2168 $withdrawn_count++ if $item->{withdrawn};
2169 $itemlost_count++ if $item->{itemlost};
2170 $itemdamaged_count++ if $item->{damaged};
2171 $item_in_transit_count++ if $transfertwhen ne '';
2172 $item_onhold_count++ if $reservestatus eq 'Waiting';
2173 $item->{status} = $item->{withdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
2175 # can place a hold on a item if
2176 # not lost nor withdrawn
2177 # not damaged unless AllowHoldsOnDamagedItems is true
2178 # item is either for loan or on order (notforloan < 0)
2179 $can_place_holds = 1
2182 && !$item->{withdrawn}
2183 && ( !$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems') )
2184 && ( !$item->{notforloan} || $item->{notforloan} < 0 )
2189 my $key = $prefix . $item->{status};
2190 foreach (qw(withdrawn itemlost damaged branchname itemcallnumber)) {
2191 $other_items->{$key}->{$_} = $item->{$_};
2193 $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
2194 $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
2195 $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
2196 $other_items->{$key}->{count}++ if $item->{$hbranch};
2197 $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
2198 $other_items->{$key}->{description} = $item->{description};
2199 $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2203 $can_place_holds = 1;
2205 $available_items->{$prefix}->{count}++ if $item->{$hbranch};
2206 foreach (qw(branchname itemcallnumber description)) {
2207 $available_items->{$prefix}->{$_} = $item->{$_};
2209 $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
2210 $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
2213 } # notforloan, item level and biblioitem level
2215 # if all items are hidden, do not show the record
2216 if ($items_count > 0 && $hideatopac_count == $items_count) {
2220 my ( $availableitemscount, $onloanitemscount, $otheritemscount );
2221 for my $key ( sort keys %$onloan_items ) {
2222 (++$onloanitemscount > $maxitems) and last;
2223 push @onloan_items_loop, $onloan_items->{$key};
2225 for my $key ( sort keys %$other_items ) {
2226 (++$otheritemscount > $maxitems) and last;
2227 push @other_items_loop, $other_items->{$key};
2229 for my $key ( sort keys %$available_items ) {
2230 (++$availableitemscount > $maxitems) and last;
2231 push @available_items_loop, $available_items->{$key}
2234 # XSLT processing of some stuff
2235 my $interface = $search_context eq 'opac' ? 'OPAC' : '';
2236 if (!$scan && C4::Context->preference($interface . "XSLTResultsDisplay")) {
2237 $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $interface."XSLTResultsDisplay", 1, \@hiddenitems);
2238 # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
2241 # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
2242 if (!C4::Context->preference("item-level_itypes")) {
2243 if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
2244 $can_place_holds = 0;
2247 $oldbiblio->{norequests} = 1 unless $can_place_holds;
2248 $oldbiblio->{itemsplural} = 1 if $items_count > 1;
2249 $oldbiblio->{items_count} = $items_count;
2250 $oldbiblio->{available_items_loop} = \@available_items_loop;
2251 $oldbiblio->{onloan_items_loop} = \@onloan_items_loop;
2252 $oldbiblio->{other_items_loop} = \@other_items_loop;
2253 $oldbiblio->{availablecount} = $available_count;
2254 $oldbiblio->{availableplural} = 1 if $available_count > 1;
2255 $oldbiblio->{onloancount} = $onloan_count;
2256 $oldbiblio->{onloanplural} = 1 if $onloan_count > 1;
2257 $oldbiblio->{othercount} = $other_count;
2258 $oldbiblio->{otherplural} = 1 if $other_count > 1;
2259 $oldbiblio->{withdrawncount} = $withdrawn_count;
2260 $oldbiblio->{itemlostcount} = $itemlost_count;
2261 $oldbiblio->{damagedcount} = $itemdamaged_count;
2262 $oldbiblio->{intransitcount} = $item_in_transit_count;
2263 $oldbiblio->{onholdcount} = $item_onhold_count;
2264 $oldbiblio->{orderedcount} = $ordered_count;
2265 $oldbiblio->{notforloancount} = $notforloan_count;
2267 if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
2268 my $fieldspec = C4::Context->preference("AlternateHoldingsField");
2269 my $subfields = substr $fieldspec, 3;
2270 my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
2271 my @alternateholdingsinfo = ();
2272 my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
2273 my $alternateholdingscount = 0;
2275 for my $field (@holdingsfields) {
2276 my %holding = ( holding => '' );
2277 my $havesubfield = 0;
2278 for my $subfield ($field->subfields()) {
2279 if ((index $subfields, $$subfield[0]) >= 0) {
2280 $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
2281 $holding{'holding'} .= $$subfield[1];
2285 if ($havesubfield) {
2286 push(@alternateholdingsinfo, \%holding);
2287 $alternateholdingscount++;
2291 $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
2292 $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
2295 push( @newresults, $oldbiblio );
2301 =head2 SearchAcquisitions
2302 Search for acquisitions
2305 sub SearchAcquisitions{
2306 my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
2308 my $dbh=C4::Context->dbh;
2309 # Variable initialization
2313 LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
2314 LEFT JOIN items ON items.biblionumber=biblio.biblionumber
2315 WHERE dateaccessioned BETWEEN ? AND ?
2318 my (@params,@loopcriteria);
2320 push @params, $datebegin->output("iso");
2321 push @params, $dateend->output("iso");
2323 if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
2324 if(C4::Context->preference("item-level_itypes")){
2325 $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2327 $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
2329 push @params, @$itemtypes;
2332 if ($criteria =~/itemtype/){
2333 if(C4::Context->preference("item-level_itypes")){
2334 $str .= "AND items.itype=? ";
2336 $str .= "AND biblioitems.itemtype=? ";
2339 if(scalar(@$itemtypes) == 0){
2340 my $itypes = GetItemTypes();
2341 for my $key (keys %$itypes){
2342 push @$itemtypes, $key;
2346 @loopcriteria= @$itemtypes;
2347 }elsif ($criteria=~/itemcallnumber/){
2348 $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
2349 OR items.itemcallnumber is NULL
2350 OR items.itemcallnumber = '')";
2352 @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
2354 $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
2355 @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
2358 if ($orderby =~ /date_desc/){
2359 $str.=" ORDER BY dateaccessioned DESC";
2361 $str.=" ORDER BY title";
2364 my $qdataacquisitions=$dbh->prepare($str);
2366 my @loopacquisitions;
2367 foreach my $value(@loopcriteria){
2368 push @params,$value;
2370 $cell{"title"}=$value;
2371 $cell{"titlecode"}=$value;
2373 eval{$qdataacquisitions->execute(@params);};
2375 if ($@){ warn "recentacquisitions Error :$@";}
2378 while (my $data=$qdataacquisitions->fetchrow_hashref){
2379 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
2381 $cell{"loopdata"}=\@loopdata;
2383 push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
2386 $qdataacquisitions->finish;
2387 return \@loopacquisitions;
2390 =head2 enabled_staff_search_views
2392 %hash = enabled_staff_search_views()
2394 This function returns a hash that contains three flags obtained from the system
2395 preferences, used to determine whether a particular staff search results view
2400 =item C<Output arg:>
2402 * $hash{can_view_MARC} is true only if the MARC view is enabled
2403 * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2404 * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2406 =item C<usage in the script:>
2410 $template->param ( C4::Search::enabled_staff_search_views );
2414 sub enabled_staff_search_views
2417 can_view_MARC => C4::Context->preference('viewMARC'), # 1 if the staff search allows the MARC view
2418 can_view_ISBD => C4::Context->preference('viewISBD'), # 1 if the staff search allows the ISBD view
2419 can_view_labeledMARC => C4::Context->preference('viewLabeledMARC'), # 1 if the staff search allows the Labeled MARC view
2423 sub PurgeSearchHistory{
2424 my ($pSearchhistory)=@_;
2425 my $dbh = C4::Context->dbh;
2426 my $sth = $dbh->prepare("DELETE FROM search_history WHERE time < DATE_SUB( NOW(), INTERVAL ? DAY )");
2427 $sth->execute($pSearchhistory) or die $dbh->errstr;
2430 =head2 z3950_search_args
2432 $arrayref = z3950_search_args($matchpoints)
2434 This function returns an array reference that contains the search parameters to be
2435 passed to the Z39.50 search script (z3950_search.pl). The array elements
2436 are hash refs whose keys are name and value, and whose values are the
2437 name of a search parameter, the value of that search parameter and the URL encoded
2438 value of that parameter.
2440 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2442 The search parameter values are obtained from the bibliographic record whose
2443 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2445 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2446 a general purpose search argument. In this case, the returned array contains only
2447 entry: the key is 'title' and the value is derived from $matchpoints.
2449 If a search parameter value is undefined or empty, it is not included in the returned
2452 The returned array reference may be passed directly to the template parameters.
2456 =item C<Output arg:>
2458 * $array containing hash refs as described above
2460 =item C<usage in the script:>
2464 $data = Biblio::GetBiblioData($bibno);
2465 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2469 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2473 sub z3950_search_args {
2476 my $isbn_string = ref( $bibrec ) ? $bibrec->{title} : $bibrec;
2477 my $isbn = Business::ISBN->new( $isbn_string );
2479 if (defined $isbn && $isbn->is_valid)
2481 if ( ref($bibrec) ) {
2482 $bibrec->{isbn} = $isbn_string;
2483 $bibrec->{title} = undef;
2485 $bibrec = { isbn => $isbn_string };
2489 $bibrec = { title => $bibrec } if !ref $bibrec;
2492 for my $field (qw/ lccn isbn issn title author dewey subject /)
2494 push @$array, { name => $field, value => $bibrec->{$field} }
2495 if defined $bibrec->{$field};
2500 =head2 GetDistinctValues($field);
2502 C<$field> is a reference to the fields array
2506 sub GetDistinctValues {
2507 my ($fieldname,$string)=@_;
2508 # returns a reference to a hash of references to branches...
2509 if ($fieldname=~/\./){
2510 my ($table,$column)=split /\./, $fieldname;
2511 my $dbh = C4::Context->dbh;
2512 warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2513 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 ");
2515 my $elements=$sth->fetchall_arrayref({});
2520 my @servers=qw<biblioserver authorityserver>;
2521 my (@zconns,@results);
2522 for ( my $i = 0 ; $i < @servers ; $i++ ) {
2523 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2526 ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2529 # The big moment: asynchronously retrieve results from all servers
2535 my ( $i, $size ) = @_;
2536 for ( my $j = 0 ; $j < $size ; $j++ ) {
2538 @hashscan{qw(value cnt)} =
2539 $results[ $i - 1 ]->display_term($j);
2540 push @elements, \%hashscan;
2548 =head2 _ZOOM_event_loop
2550 _ZOOM_event_loop(\@zconns, \@results, sub {
2551 my ( $i, $size ) = @_;
2555 Processes a ZOOM event loop and passes control to a closure for
2556 processing the results, and destroying the resultsets.
2560 sub _ZOOM_event_loop {
2561 my ($zconns, $results, $callback) = @_;
2562 while ( ( my $i = ZOOM::event( $zconns ) ) != 0 ) {
2563 my $ev = $zconns->[ $i - 1 ]->last_event();
2564 if ( $ev == ZOOM::Event::ZEND ) {
2565 next unless $results->[ $i - 1 ];
2566 my $size = $results->[ $i - 1 ]->size();
2568 $callback->($i, $size);
2573 foreach my $result (@$results) {
2578 =head2 new_record_from_zebra
2580 Given raw data from a Zebra result set, return a MARC::Record object
2582 This helper function is needed to take into account all the involved
2583 system preferences and configuration variables to properly create the
2584 MARC::Record object.
2586 If we are using GRS-1, then the raw data we get from Zebra should be USMARC
2587 data. If we are using DOM, then it has to be MARCXML.
2591 sub new_record_from_zebra {
2594 my $raw_data = shift;
2595 # Set the default indexing modes
2596 my $index_mode = ( $server eq 'biblioserver' )
2597 ? C4::Context->config('zebra_bib_index_mode') // 'dom'
2598 : C4::Context->config('zebra_auth_index_mode') // 'dom';
2600 my $marc_record = eval {
2601 if ( $index_mode eq 'dom' ) {
2602 MARC::Record->new_from_xml( $raw_data, 'UTF-8' );
2604 MARC::Record->new_from_usmarc( $raw_data );
2611 return $marc_record;
2616 END { } # module clean-up code here (global destructor)
2623 Koha Development Team <http://koha-community.org/>