3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 2 of the License, or (at your option) any later
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License along with
15 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
16 # Suite 330, Boston, MA 02111-1307 USA
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; # CheckReserves
38 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
40 # set the version for version checking
42 $VERSION = 3.07.00.049;
43 $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
48 C4::Search - Functions for searching the Koha catalog.
52 See opac/opac-search.pl or catalogue/search.pl for example of usage
56 This module provides searching functions for Koha's bibliographic databases
72 &enabled_staff_search_views
76 # make all your functions, whether exported or not;
80 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
82 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
88 my $dbh = C4::Context->dbh;
89 my $result = TransformMarcToKoha( $dbh, $record, '' );
94 my ( $biblionumber, $title );
96 # search duplicate on ISBN, easy and fast..
98 if ( $result->{isbn} ) {
99 $result->{isbn} =~ s/\(.*$//;
100 $result->{isbn} =~ s/\s+$//;
101 $query = "isbn=$result->{isbn}";
104 $result->{title} =~ s /\\//g;
105 $result->{title} =~ s /\"//g;
106 $result->{title} =~ s /\(//g;
107 $result->{title} =~ s /\)//g;
109 # FIXME: instead of removing operators, could just do
110 # quotes around the value
111 $result->{title} =~ s/(and|or|not)//g;
112 $query = "ti,ext=$result->{title}";
113 $query .= " and itemtype=$result->{itemtype}"
114 if ( $result->{itemtype} );
115 if ( $result->{author} ) {
116 $result->{author} =~ s /\\//g;
117 $result->{author} =~ s /\"//g;
118 $result->{author} =~ s /\(//g;
119 $result->{author} =~ s /\)//g;
121 # remove valid operators
122 $result->{author} =~ s/(and|or|not)//g;
123 $query .= " and au,ext=$result->{author}";
127 my ( $error, $searchresults, undef ) = SimpleSearch($query); # FIXME :: hardcoded !
129 if (!defined $error) {
130 foreach my $possible_duplicate_record (@{$searchresults}) {
132 MARC::Record->new_from_usmarc($possible_duplicate_record);
133 my $result = TransformMarcToKoha( $dbh, $marcrecord, '' );
135 # FIXME :: why 2 $biblionumber ?
137 push @results, $result->{'biblionumber'};
138 push @results, $result->{'title'};
147 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers] );
149 This function provides a simple search API on the bibliographic catalog
155 * $query can be a simple keyword or a complete CCL query
156 * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
157 * $offset - If present, represents the number of records at the beggining to omit. Defaults to 0
158 * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
163 Returns an array consisting of three elements
164 * $error is undefined unless an error is detected
165 * $results is a reference to an array of records.
166 * $total_hits is the number of hits that would have been returned with no limit
168 If an error is returned the two other return elements are undefined. If error itself is undefined
169 the other two elements are always defined
171 =item C<usage in the script:>
175 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
177 if (defined $error) {
178 $template->param(query_error => $error);
179 warn "error: ".$error;
180 output_html_with_http_headers $input, $cookie, $template->output;
184 my $hits = @{$marcresults};
187 for my $r ( @{$marcresults} ) {
188 my $marcrecord = MARC::File::USMARC::decode($r);
189 my $biblio = TransformMarcToKoha(C4::Context->dbh,$marcrecord,q{});
191 #build the iarray of hashs for the template.
193 title => $biblio->{'title'},
194 subtitle => $biblio->{'subtitle'},
195 biblionumber => $biblio->{'biblionumber'},
196 author => $biblio->{'author'},
197 publishercode => $biblio->{'publishercode'},
198 publicationyear => $biblio->{'publicationyear'},
203 $template->param(result=>\@results);
208 my ( $query, $offset, $max_results, $servers ) = @_;
210 if ( C4::Context->preference('NoZebra') ) {
211 my $result = NZorder( NZanalyse($query) )->{'biblioserver'};
214 && $result->{hits} > 0 ? $result->{'RECORDS'} : [] );
215 return ( undef, $search_result, scalar($result->{hits}) );
218 return ( 'No query entered', undef, undef ) unless $query;
219 # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
220 my @servers = defined ( $servers ) ? @$servers : ( 'biblioserver' );
227 # Initialize & Search Zebra
228 for ( my $i = 0 ; $i < @servers ; $i++ ) {
230 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
231 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
232 $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
236 $zconns[$i]->errmsg() . " ("
237 . $zconns[$i]->errcode() . ") "
238 . $zconns[$i]->addinfo() . " "
239 . $zconns[$i]->diagset();
241 return ( $error, undef, undef ) if $zconns[$i]->errcode();
245 # caught a ZOOM::Exception
249 . $@->addinfo() . " "
252 return ( $error, undef, undef );
255 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
256 my $event = $zconns[ $i - 1 ]->last_event();
257 if ( $event == ZOOM::Event::ZEND ) {
259 my $first_record = defined( $offset ) ? $offset+1 : 1;
260 my $hits = $tmpresults[ $i - 1 ]->size();
261 $total_hits += $hits;
262 my $last_record = $hits;
263 if ( defined $max_results && $offset + $max_results < $hits ) {
264 $last_record = $offset + $max_results;
267 for my $j ( $first_record..$last_record ) {
268 my $record = $tmpresults[ $i - 1 ]->record( $j-1 )->raw(); # 0 indexed
269 push @{$results}, $record;
274 foreach my $result (@tmpresults) {
277 foreach my $zoom_query (@zoom_queries) {
278 $zoom_query->destroy();
281 return ( undef, $results, $total_hits );
287 ( undef, $results_hashref, \@facets_loop ) = getRecords (
289 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
290 $results_per_page, $offset, $expanded_facet, $branches,$itemtypes,
294 The all singing, all dancing, multi-server, asynchronous, scanning,
295 searching, record nabbing, facet-building
297 See verbse embedded documentation.
303 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
304 $results_per_page, $offset, $expanded_facet, $branches,$itemtypes,
308 my @servers = @$servers_ref;
309 my @sort_by = @$sort_by_ref;
311 # Initialize variables for the ZOOM connection and results object
315 my $results_hashref = ();
317 # Initialize variables for the faceted results objects
318 my $facets_counter = ();
319 my $facets_info = ();
320 my $facets = getFacets();
321 my $facets_maxrecs = C4::Context->preference('maxRecordsForFacets')||20;
323 my @facets_loop; # stores the ref to array of hashes for template facets loop
325 ### LOOP THROUGH THE SERVERS
326 for ( my $i = 0 ; $i < @servers ; $i++ ) {
327 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
329 # perform the search, create the results objects
330 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
331 my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
333 #$query_to_use = $simple_query if $scan;
334 warn $simple_query if ( $scan and $DEBUG );
336 # Check if we've got a query_type defined, if so, use it
339 if ($query_type =~ /^ccl/) {
340 $query_to_use =~ s/\:/\=/g; # change : to = last minute (FIXME)
341 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
342 } elsif ($query_type =~ /^cql/) {
343 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
344 } elsif ($query_type =~ /^pqf/) {
345 $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
347 warn "Unknown query_type '$query_type'. Results undetermined.";
350 $results[$i] = $zconns[$i]->scan( new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
352 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
356 warn "WARNING: query problem with $query_to_use " . $@;
359 # Concatenate the sort_by limits and pass them to the results object
360 # Note: sort will override rank
362 foreach my $sort (@sort_by) {
363 if ( $sort eq "author_az" || $sort eq "author_asc" ) {
364 $sort_by .= "1=1003 <i ";
366 elsif ( $sort eq "author_za" || $sort eq "author_dsc" ) {
367 $sort_by .= "1=1003 >i ";
369 elsif ( $sort eq "popularity_asc" ) {
370 $sort_by .= "1=9003 <i ";
372 elsif ( $sort eq "popularity_dsc" ) {
373 $sort_by .= "1=9003 >i ";
375 elsif ( $sort eq "call_number_asc" ) {
376 $sort_by .= "1=8007 <i ";
378 elsif ( $sort eq "call_number_dsc" ) {
379 $sort_by .= "1=8007 >i ";
381 elsif ( $sort eq "pubdate_asc" ) {
382 $sort_by .= "1=31 <i ";
384 elsif ( $sort eq "pubdate_dsc" ) {
385 $sort_by .= "1=31 >i ";
387 elsif ( $sort eq "acqdate_asc" ) {
388 $sort_by .= "1=32 <i ";
390 elsif ( $sort eq "acqdate_dsc" ) {
391 $sort_by .= "1=32 >i ";
393 elsif ( $sort eq "title_az" || $sort eq "title_asc" ) {
394 $sort_by .= "1=4 <i ";
396 elsif ( $sort eq "title_za" || $sort eq "title_dsc" ) {
397 $sort_by .= "1=4 >i ";
400 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
403 if ($sort_by && !$scan) {
404 if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
405 warn "WARNING sort $sort_by failed";
408 } # finished looping through servers
410 # The big moment: asynchronously retrieve results from all servers
411 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
412 my $ev = $zconns[ $i - 1 ]->last_event();
413 if ( $ev == ZOOM::Event::ZEND ) {
414 next unless $results[ $i - 1 ];
415 my $size = $results[ $i - 1 ]->size();
419 # loop through the results
420 $results_hash->{'hits'} = $size;
422 if ( $offset + $results_per_page <= $size ) {
423 $times = $offset + $results_per_page;
428 for ( my $j = $offset ; $j < $times ; $j++ ) {
432 ## Check if it's an index scan
434 my ( $term, $occ ) = $results[ $i - 1 ]->term($j);
436 # here we create a minimal MARC record and hand it off to the
437 # template just like a normal result ... perhaps not ideal, but
439 my $tmprecord = MARC::Record->new();
440 $tmprecord->encoding('UTF-8');
444 # the minimal record in author/title (depending on MARC flavour)
445 if (C4::Context->preference("marcflavour") eq "UNIMARC") {
446 $tmptitle = MARC::Field->new('200',' ',' ', a => $term, f => $occ);
447 $tmprecord->append_fields($tmptitle);
449 $tmptitle = MARC::Field->new('245',' ',' ', a => $term,);
450 $tmpauthor = MARC::Field->new('100',' ',' ', a => $occ,);
451 $tmprecord->append_fields($tmptitle);
452 $tmprecord->append_fields($tmpauthor);
454 $results_hash->{'RECORDS'}[$j] = $tmprecord->as_usmarc();
459 $record = $results[ $i - 1 ]->record($j)->raw();
461 # warn "RECORD $j:".$record;
462 $results_hash->{'RECORDS'}[$j] = $record;
466 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
468 # Fill the facets while we're looping, but only for the biblioserver and not for a scan
469 if ( !$scan && $servers[ $i - 1 ] =~ /biblioserver/ ) {
471 my $jmax = $size>$facets_maxrecs? $facets_maxrecs: $size;
472 for my $facet ( @$facets ) {
473 for ( my $j = 0 ; $j < $jmax ; $j++ ) {
474 my $render_record = $results[ $i - 1 ]->record($j)->render();
476 foreach my $tag ( @{$facet->{tags}} ) {
478 my $tag_num = substr($tag, 0, 3);
479 my $letters = substr($tag, 3);
480 my $field_pattern = '\n' . $tag_num . ' ([^z][^\n]+)';
481 $field_pattern = '\n' . $tag_num . ' ([^\n]+)' if (int($tag_num) < 10);
482 my @field_tokens = ( $render_record =~ /$field_pattern/g ) ;
483 foreach my $field_token (@field_tokens) {
484 my @subf = ( $field_token =~ /\$([a-zA-Z0-9]) ([^\$]+)/g );
486 for (my $i = 0; $i < @subf; $i += 2) {
487 if ( $letters =~ $subf[$i] ) {
488 my $value = $subf[$i+1];
491 push @values, $value;
494 my $data = join($facet->{sep}, @values);
495 unless ( $data ~~ @used_datas ) {
496 $facets_counter->{ $facet->{idx} }->{$data}++;
497 push @used_datas, $data;
502 $facets_info->{ $facet->{idx} }->{label_value} = $facet->{label};
503 $facets_info->{ $facet->{idx} }->{expanded} = $facet->{expanded};
508 # warn "connection ", $i-1, ": $size hits";
509 # warn $results[$i-1]->record(0)->render() if $size > 0;
512 if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
514 sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
515 keys %$facets_counter )
518 my $number_of_facets;
519 my @this_facets_array;
522 $facets_counter->{$link_value}->{$b}
523 <=> $facets_counter->{$link_value}->{$a}
524 } keys %{ $facets_counter->{$link_value} }
528 if ( ( $number_of_facets < 6 )
529 || ( $expanded_facet eq $link_value )
530 || ( $facets_info->{$link_value}->{'expanded'} ) )
533 # Sanitize the link value ), ( will cause errors with CCL,
534 my $facet_link_value = $one_facet;
535 $facet_link_value =~ s/(\(|\))/ /g;
537 # fix the length that will display in the label,
538 my $facet_label_value = $one_facet;
539 my $facet_max_length =
540 C4::Context->preference('FacetLabelTruncationLength') || 20;
542 substr( $one_facet, 0, $facet_max_length ) . "..."
543 if length($facet_label_value) > $facet_max_length;
545 # if it's a branch, label by the name, not the code,
546 if ( $link_value =~ /branch/ ) {
547 if (defined $branches
548 && ref($branches) eq "HASH"
549 && defined $branches->{$one_facet}
550 && ref ($branches->{$one_facet}) eq "HASH")
553 $branches->{$one_facet}->{'branchname'};
556 $facet_label_value = "*";
559 # if it's a itemtype, label by the name, not the code,
560 if ( $link_value =~ /itype/ ) {
561 if (defined $itemtypes
562 && ref($itemtypes) eq "HASH"
563 && defined $itemtypes->{$one_facet}
564 && ref ($itemtypes->{$one_facet}) eq "HASH")
567 $itemtypes->{$one_facet}->{'description'};
571 # but we're down with the whole label being in the link's title.
572 push @this_facets_array, {
573 facet_count => $facets_counter->{$link_value}->{$one_facet},
574 facet_label_value => $facet_label_value,
575 facet_title_value => $one_facet,
576 facet_link_value => $facet_link_value,
577 type_link_value => $link_value,
582 # handle expanded option
583 unless ( $facets_info->{$link_value}->{'expanded'} ) {
585 if ( ( $number_of_facets > 6 )
586 && ( $expanded_facet ne $link_value ) );
589 type_link_value => $link_value,
590 type_id => $link_value . "_id",
591 "type_label_" . $facets_info->{$link_value}->{'label_value'} => 1,
592 facets => \@this_facets_array,
593 expandable => $expandable,
594 expand => $link_value,
595 } unless ( ($facets_info->{$link_value}->{'label_value'} =~ /Libraries/) and (C4::Context->preference('singleBranchMode')) );
600 return ( undef, $results_hashref, \@facets_loop );
605 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
606 $results_per_page, $offset, $expanded_facet, $branches,
610 my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
612 $paz->search($simple_query);
613 sleep 1; # FIXME: WHY?
616 my $results_hashref = {};
617 my $stats = XMLin($paz->stat);
618 my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
620 # for a grouped search result, the number of hits
621 # is the number of groups returned; 'bib_hits' will have
622 # the total number of bibs.
623 $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
624 $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
626 HIT: foreach my $hit (@{ $results->{'hit'} }) {
627 my $recid = $hit->{recid}->[0];
629 my $work_title = $hit->{'md-work-title'}->[0];
631 if (exists $hit->{'md-work-author'}) {
632 $work_author = $hit->{'md-work-author'}->[0];
634 my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
636 my $result_group = {};
637 $result_group->{'group_label'} = $group_label;
638 $result_group->{'group_merge_key'} = $recid;
641 if (exists $hit->{count}) {
642 $count = $hit->{count}->[0];
644 $result_group->{'group_count'} = $count;
646 for (my $i = 0; $i < $count; $i++) {
647 # FIXME -- may need to worry about diacritics here
648 my $rec = $paz->record($recid, $i);
649 push @{ $result_group->{'RECORDS'} }, $rec;
652 push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
655 # pass through facets
656 my $termlist_xml = $paz->termlist('author,subject');
657 my $terms = XMLin($termlist_xml, forcearray => 1);
658 my @facets_loop = ();
659 #die Dumper($results);
660 # foreach my $list (sort keys %{ $terms->{'list'} }) {
662 # foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
664 # facet_label_value => $facet->{'name'}->[0],
667 # push @facets_loop, ( {
668 # type_label => $list,
669 # facets => \@facets,
673 return ( undef, $results_hashref, \@facets_loop );
677 sub _remove_stopwords {
678 my ( $operand, $index ) = @_;
679 my @stopwords_removed;
681 # phrase and exact-qualified indexes shouldn't have stopwords removed
682 if ( $index !~ m/phr|ext/ ) {
684 # remove stopwords from operand : parse all stopwords & remove them (case insensitive)
685 # we use IsAlpha unicode definition, to deal correctly with diacritics.
686 # otherwise, a French word like "leçon" woudl be split into "le" "çon", "le"
687 # is a stopword, we'd get "çon" and wouldn't find anything...
689 foreach ( keys %{ C4::Context->stopwords } ) {
690 next if ( $_ =~ /(and|or|not)/ ); # don't remove operators
691 if ( my ($matched) = ($operand =~
692 /([^\X\p{isAlnum}]\Q$_\E[^\X\p{isAlnum}]|[^\X\p{isAlnum}]\Q$_\E$|^\Q$_\E[^\X\p{isAlnum}])/gi))
694 $operand =~ s/\Q$matched\E/ /gi;
695 push @stopwords_removed, $_;
699 return ( $operand, \@stopwords_removed );
703 sub _detect_truncation {
704 my ( $operand, $index ) = @_;
705 my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
708 my @wordlist = split( /\s/, $operand );
709 foreach my $word (@wordlist) {
710 if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
711 push @rightlefttruncated, $word;
713 elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
714 push @lefttruncated, $word;
716 elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
717 push @righttruncated, $word;
719 elsif ( index( $word, "*" ) < 0 ) {
720 push @nontruncated, $word;
723 push @regexpr, $word;
727 \@nontruncated, \@righttruncated, \@lefttruncated,
728 \@rightlefttruncated, \@regexpr
733 sub _build_stemmed_operand {
734 my ($operand,$lang) = @_;
735 require Lingua::Stem::Snowball ;
736 my $stemmed_operand=q{};
738 # If operand contains a digit, it is almost certainly an identifier, and should
739 # not be stemmed. This is particularly relevant for ISBNs and ISSNs, which
740 # can contain the letter "X" - for example, _build_stemmend_operand would reduce
741 # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
742 # results (e.g., "23 x 29 cm." from the 300$c). Bug 2098.
743 return $operand if $operand =~ /\d/;
745 # FIXME: the locale should be set based on the user's language and/or search choice
747 # Make sure we only use the first two letters from the language code
748 $lang = lc(substr($lang, 0, 2));
749 # The language codes for the two variants of Norwegian will now be "nb" and "nn",
750 # none of which Lingua::Stem::Snowball can use, so we need to "translate" them
751 if ($lang eq 'nb' || $lang eq 'nn') {
754 my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
755 encoding => "UTF-8" );
757 my @words = split( / /, $operand );
758 my @stems = $stemmer->stem(\@words);
759 for my $stem (@stems) {
760 $stemmed_operand .= "$stem";
761 $stemmed_operand .= "?"
762 unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
763 $stemmed_operand .= " ";
765 warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
766 return $stemmed_operand;
770 sub _build_weighted_query {
772 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
773 # pretty well but could work much better if we had a smarter query parser
774 my ( $operand, $stemmed_operand, $index ) = @_;
775 my $stemming = C4::Context->preference("QueryStemming") || 0;
776 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
777 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
779 my $weighted_query .= "(rk=("; # Specifies that we're applying rank
781 # Keyword, or, no index specified
782 if ( ( $index eq 'kw' ) || ( !$index ) ) {
784 "Title-cover,ext,r1=\"$operand\""; # exact title-cover
785 $weighted_query .= " or ti,ext,r2=\"$operand\""; # exact title
786 $weighted_query .= " or Title-cover,phr,r3=\"$operand\""; # phrase title
787 #$weighted_query .= " or any,ext,r4=$operand"; # exact any
788 #$weighted_query .=" or kw,wrdl,r5=\"$operand\""; # word list any
789 $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
790 if $fuzzy_enabled; # add fuzzy, word list
791 $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
792 if ( $stemming and $stemmed_operand )
793 ; # add stemming, right truncation
794 $weighted_query .= " or wrdl,r9=\"$operand\"";
796 # embedded sorting: 0 a-z; 1 z-a
797 # $weighted_query .= ") or (sort1,aut=1";
800 # Barcode searches should skip this process
801 elsif ( $index eq 'bc' ) {
802 $weighted_query .= "bc=\"$operand\"";
805 # Authority-number searches should skip this process
806 elsif ( $index eq 'an' ) {
807 $weighted_query .= "an=\"$operand\"";
810 # If the index already has more than one qualifier, wrap the operand
811 # in quotes and pass it back (assumption is that the user knows what they
812 # are doing and won't appreciate us mucking up their query
813 elsif ( $index =~ ',' ) {
814 $weighted_query .= " $index=\"$operand\"";
817 #TODO: build better cases based on specific search indexes
819 $weighted_query .= " $index,ext,r1=\"$operand\""; # exact index
820 #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
821 $weighted_query .= " or $index,phr,r3=\"$operand\""; # phrase index
823 " or $index,rt,wrdl,r3=\"$operand\""; # word list index
826 $weighted_query .= "))"; # close rank specification
827 return $weighted_query;
832 Return an array with available indexes.
854 'Author-personal-bibliography',
864 'Chronological-subdivision',
874 'Conference-name-heading',
875 'Conference-name-see',
876 'Conference-name-seealso',
881 'Corporate-name-heading',
882 'Corporate-name-see',
883 'Corporate-name-seealso',
885 'date-entered-on-file',
886 'Date-of-acquisition',
887 'Date-of-publication',
888 'Dewey-classification',
895 'Geographic-subdivision',
898 'Heading-use-main-or-added-entry',
899 'Heading-use-series-added-entry ',
900 'Heading-use-subject-added-entry',
918 'Local-classification',
921 'Match-heading-see-from',
929 'Name-geographic-heading',
930 'Name-geographic-see',
931 'Name-geographic-seealso',
939 'Personal-name-heading',
941 'Personal-name-seealso',
948 'Record-control-number',
959 'Subject-heading-thesaurus',
960 'Subject-name-personal',
961 'Subject-subdivision',
971 'Term-genre-form-heading',
972 'Term-genre-form-see',
973 'Term-genre-form-seealso',
980 'Title-uniform-heading',
982 'Title-uniform-seealso',
992 'classification-source',
994 'coded-location-qualifier',
1005 'Local-classification',
1008 'materials-specified',
1017 'replacementpricedate',
1035 $simple_query, $query_cgi,
1036 $query_desc, $limit,
1037 $limit_cgi, $limit_desc,
1038 $stopwords_removed, $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1040 Build queries and limits in CCL, CGI, Human,
1041 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
1043 See verbose embedded documentation.
1049 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1051 warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1054 my @operators = $operators ? @$operators : ();
1055 my @indexes = $indexes ? @$indexes : ();
1056 my @operands = $operands ? @$operands : ();
1057 my @limits = $limits ? @$limits : ();
1058 my @sort_by = $sort_by ? @$sort_by : ();
1060 my $stemming = C4::Context->preference("QueryStemming") || 0;
1061 my $auto_truncation = C4::Context->preference("QueryAutoTruncate") || 0;
1062 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1063 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1064 my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
1066 # no stemming/weight/fuzzy in NoZebra
1067 if ( C4::Context->preference("NoZebra") ) {
1071 $auto_truncation = 0;
1074 my $query = $operands[0];
1075 my $simple_query = $operands[0];
1077 # initialize the variables we're passing back
1086 my $stopwords_removed; # flag to determine if stopwords have been removed
1089 my $cclindexes = getIndexes();
1090 if ( $query !~ /\s*ccl=/ ) {
1091 while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1093 $cclq = grep { lc($_) eq $dx } @$cclindexes;
1095 $query = "ccl=$query" if $cclq;
1098 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1100 if ( $query =~ /^ccl=/ ) {
1102 # This is needed otherwise ccl= and &limit won't work together, and
1103 # this happens when selecting a subject on the opac-detail page
1105 $q .= ' and '.join(' and ', @limits);
1107 return ( undef, $q, $q, "q=ccl=$q", $q, '', '', '', '', 'ccl' );
1109 if ( $query =~ /^cql=/ ) {
1110 return ( undef, $', $', "q=cql=$'", $', '', '', '', '', 'cql' );
1112 if ( $query =~ /^pqf=/ ) {
1113 return ( undef, $', $', "q=pqf=$'", $', '', '', '', '', 'pqf' );
1116 # pass nested queries directly
1117 # FIXME: need better handling of some of these variables in this case
1118 # Nested queries aren't handled well and this implementation is flawed and causes users to be
1119 # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1120 # if ( $query =~ /(\(|\))/ ) {
1122 # undef, $query, $simple_query, $query_cgi,
1123 # $query, $limit, $limit_cgi, $limit_desc,
1124 # $stopwords_removed, 'ccl'
1128 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1129 # query operands and indexes and add stemming, truncation, field weighting, etc.
1130 # Once we do so, we'll end up with a value in $query, just like if we had an
1131 # incoming $query from the user
1134 ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1135 my $previous_operand
1136 ; # a flag used to keep track if there was a previous query
1137 # if there was, we can apply the current operator
1139 for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1141 # COMBINE OPERANDS, INDEXES AND OPERATORS
1142 if ( $operands[$i] ) {
1143 $operands[$i]=~s/^\s+//;
1145 # A flag to determine whether or not to add the index to the query
1148 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
1149 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1152 $remove_stopwords = 0;
1154 $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1156 my $operand = $operands[$i];
1157 my $index = $indexes[$i];
1159 # Add index-specific attributes
1160 # Date of Publication
1161 if ( $index eq 'yr' ) {
1162 $index .= ",st-numeric";
1164 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1167 # Date of Acquisition
1168 elsif ( $index eq 'acqdate' ) {
1169 $index .= ",st-date-normalized";
1171 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1173 # ISBN,ISSN,Standard Number, don't need special treatment
1174 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1176 $stemming, $auto_truncation,
1177 $weight_fields, $fuzzy_enabled,
1179 ) = ( 0, 0, 0, 0, 0 );
1187 # Set default structure attribute (word list)
1188 my $struct_attr = q{};
1189 unless ( $indexes_set || !$index || $index =~ /(st-|phr|ext|wrdl|nb|ns)/ ) {
1190 $struct_attr = ",wrdl";
1193 # Some helpful index variants
1194 my $index_plus = $index . $struct_attr . ':';
1195 my $index_plus_comma = $index . $struct_attr . ',';
1198 if ($remove_stopwords) {
1199 ( $operand, $stopwords_removed ) =
1200 _remove_stopwords( $operand, $index );
1201 warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
1202 warn "REMOVED STOPWORDS: @$stopwords_removed"
1203 if ( $stopwords_removed && $DEBUG );
1206 if ($auto_truncation){
1207 unless ( $index =~ /(st-|phr|ext)/ ) {
1208 #FIXME only valid with LTR scripts
1209 $operand=join(" ",map{
1210 (index($_,"*")>0?"$_":"$_*")
1211 }split (/\s+/,$operand));
1212 warn $operand if $DEBUG;
1217 my $truncated_operand;
1218 my( $nontruncated, $righttruncated, $lefttruncated,
1219 $rightlefttruncated, $regexpr
1220 ) = _detect_truncation( $operand, $index );
1222 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1227 scalar(@$righttruncated) + scalar(@$lefttruncated) +
1228 scalar(@$rightlefttruncated) > 0 )
1231 # Don't field weight or add the index to the query, we do it here
1233 undef $weight_fields;
1234 my $previous_truncation_operand;
1235 if (scalar @$nontruncated) {
1236 $truncated_operand .= "$index_plus @$nontruncated ";
1237 $previous_truncation_operand = 1;
1239 if (scalar @$righttruncated) {
1240 $truncated_operand .= "and " if $previous_truncation_operand;
1241 $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1242 $previous_truncation_operand = 1;
1244 if (scalar @$lefttruncated) {
1245 $truncated_operand .= "and " if $previous_truncation_operand;
1246 $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1247 $previous_truncation_operand = 1;
1249 if (scalar @$rightlefttruncated) {
1250 $truncated_operand .= "and " if $previous_truncation_operand;
1251 $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1252 $previous_truncation_operand = 1;
1255 $operand = $truncated_operand if $truncated_operand;
1256 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1259 my $stemmed_operand;
1260 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1263 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1265 # Handle Field Weighting
1266 my $weighted_operand;
1267 if ($weight_fields) {
1268 $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1269 $operand = $weighted_operand;
1273 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1275 # If there's a previous operand, we need to add an operator
1276 if ($previous_operand) {
1278 # User-specified operator
1279 if ( $operators[ $i - 1 ] ) {
1280 $query .= " $operators[$i-1] ";
1281 $query .= " $index_plus " unless $indexes_set;
1282 $query .= " $operand";
1283 $query_cgi .= "&op=$operators[$i-1]";
1284 $query_cgi .= "&idx=$index" if $index;
1285 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1287 " $operators[$i-1] $index_plus $operands[$i]";
1290 # Default operator is and
1293 $query .= "$index_plus " unless $indexes_set;
1294 $query .= "$operand";
1295 $query_cgi .= "&op=and&idx=$index" if $index;
1296 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1297 $query_desc .= " and $index_plus $operands[$i]";
1301 # There isn't a pervious operand, don't need an operator
1304 # Field-weighted queries already have indexes set
1305 $query .= " $index_plus " unless $indexes_set;
1307 $query_desc .= " $index_plus $operands[$i]";
1308 $query_cgi .= "&idx=$index" if $index;
1309 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1310 $previous_operand = 1;
1315 warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1318 my %group_OR_limits;
1319 my $availability_limit;
1320 foreach my $this_limit (@limits) {
1321 if ( $this_limit =~ /available/ ) {
1323 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1325 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1326 $availability_limit .=
1327 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1328 $limit_cgi .= "&limit=available";
1332 # group_OR_limits, prefixed by mc-
1333 # OR every member of the group
1334 elsif ( $this_limit =~ /mc/ ) {
1335 my ($k,$v) = split(/:/, $this_limit,2);
1336 if ( $k !~ /mc-i(tem)?type/ ) {
1337 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1338 $this_limit =~ tr/"//d;
1339 $this_limit = $k.":\"".$v."\"";
1342 $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1343 $limit_desc .= " or " if $group_OR_limits{$k};
1344 $group_OR_limits{$k} .= "$this_limit";
1345 $limit_cgi .= "&limit=$this_limit";
1346 $limit_desc .= " $this_limit";
1349 # Regular old limits
1351 $limit .= " and " if $limit || $query;
1352 $limit .= "$this_limit";
1353 $limit_cgi .= "&limit=$this_limit";
1354 if ($this_limit =~ /^branch:(.+)/) {
1355 my $branchcode = $1;
1356 my $branchname = GetBranchName($branchcode);
1357 if (defined $branchname) {
1358 $limit_desc .= " branch:$branchname";
1360 $limit_desc .= " $this_limit";
1363 $limit_desc .= " $this_limit";
1367 foreach my $k (keys (%group_OR_limits)) {
1368 $limit .= " and " if ( $query || $limit );
1369 $limit .= "($group_OR_limits{$k})";
1371 if ($availability_limit) {
1372 $limit .= " and " if ( $query || $limit );
1373 $limit .= "($availability_limit)";
1376 # Normalize the query and limit strings
1377 # This is flawed , means we can't search anything with : in it
1378 # if user wants to do ccl or cql, start the query with that
1379 # $query =~ s/:/=/g;
1380 $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1381 $query =~ s/(?<=(wrdl)):/=/g;
1382 $query =~ s/(?<=(trn|phr)):/=/g;
1384 for ( $query, $query_desc, $limit, $limit_desc ) {
1385 s/ +/ /g; # remove extra spaces
1386 s/^ //g; # remove any beginning spaces
1387 s/ $//g; # remove any ending spaces
1388 s/==/=/g; # remove double == from query
1390 $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1392 for ($query_cgi,$simple_query) {
1395 # append the limit to the query
1396 $query .= " " . $limit;
1400 warn "QUERY:" . $query;
1401 warn "QUERY CGI:" . $query_cgi;
1402 warn "QUERY DESC:" . $query_desc;
1403 warn "LIMIT:" . $limit;
1404 warn "LIMIT CGI:" . $limit_cgi;
1405 warn "LIMIT DESC:" . $limit_desc;
1406 warn "---------\nLeave buildQuery\n---------";
1409 undef, $query, $simple_query, $query_cgi,
1410 $query_desc, $limit, $limit_cgi, $limit_desc,
1411 $stopwords_removed, $query_type
1415 =head2 searchResults
1417 my @search_results = searchResults($search_context, $searchdesc, $hits,
1418 $results_per_page, $offset, $scan,
1421 Format results in a form suitable for passing to the template
1425 # IMO this subroutine is pretty messy still -- it's responsible for
1426 # building the HTML output for the template
1428 my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1429 my $dbh = C4::Context->dbh;
1434 $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1435 my ($is_opac, $hidelostitems);
1436 if ($search_context eq 'opac') {
1437 $hidelostitems = C4::Context->preference('hidelostitems');
1441 #Build branchnames hash
1443 #get branch information.....
1445 my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1447 while ( my $bdata = $bsth->fetchrow_hashref ) {
1448 $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1450 # FIXME - We build an authorised values hash here, using the default framework
1451 # though it is possible to have different authvals for different fws.
1453 my $shelflocations =GetKohaAuthorisedValues('items.location','');
1455 # get notforloan authorised value list (see $shelflocations FIXME)
1456 my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1458 #Build itemtype hash
1459 #find itemtype & itemtype image
1463 "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1466 while ( my $bdata = $bsth->fetchrow_hashref ) {
1467 foreach (qw(description imageurl summary notforloan)) {
1468 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1472 #search item field code
1473 my ($itemtag, undef) = &GetMarcFromKohaField( "items.itemnumber", "" );
1475 ## find column names of items related to MARC
1476 my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1478 my %subfieldstosearch;
1479 while ( ( my $column ) = $sth2->fetchrow ) {
1480 my ( $tagfield, $tagsubfield ) =
1481 &GetMarcFromKohaField( "items." . $column, "" );
1482 $subfieldstosearch{$column} = $tagsubfield;
1485 # handle which records to actually retrieve
1487 if ( $hits && $offset + $results_per_page <= $hits ) {
1488 $times = $offset + $results_per_page;
1491 $times = $hits; # FIXME: if $hits is undefined, why do we want to equal it?
1494 my $marcflavour = C4::Context->preference("marcflavour");
1495 # We get the biblionumber position in MARC
1496 my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1498 # loop through all of the records we've retrieved
1499 for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1500 my $marcrecord = MARC::File::USMARC::decode( $marcresults->[$i] );
1504 ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1505 : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1506 my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, $fw );
1507 $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1508 $oldbiblio->{result_number} = $i + 1;
1510 # add imageurl to itemtype if there is one
1511 $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1513 $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 ) ) : [];
1514 $oldbiblio->{normalized_upc} = GetNormalizedUPC( $marcrecord,$marcflavour);
1515 $oldbiblio->{normalized_ean} = GetNormalizedEAN( $marcrecord,$marcflavour);
1516 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1517 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1518 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1520 # edition information, if any
1521 $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1522 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1523 # Build summary if there is one (the summary is defined in the itemtypes table)
1524 # FIXME: is this used anywhere, I think it can be commented out? -- JF
1525 if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1526 my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1527 my @fields = $marcrecord->fields();
1530 foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1532 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1533 $tag =~ /(.{3})(.)/;
1534 if($marcrecord->field($1)){
1535 my @abc = $marcrecord->field($1)->subfield($2);
1536 $tags->{$tag} = $#abc + 1 ;
1540 # We catch how many times to repeat this line
1542 foreach my $tag (keys(%$tags)){
1543 $max = $tags->{$tag} if($tags->{$tag} > $max);
1546 # we replace, and repeat each line
1547 for (my $i = 0 ; $i < $max ; $i++){
1548 my $newline = $line;
1550 foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1551 $tag =~ /(.{3})(.)/;
1553 if($marcrecord->field($1)){
1554 my @repl = $marcrecord->field($1)->subfield($2);
1555 my $subfieldvalue = $repl[$i];
1557 if (! utf8::is_utf8($subfieldvalue)) {
1558 utf8::decode($subfieldvalue);
1561 $newline =~ s/\[$tag\]/$subfieldvalue/g;
1564 $newsummary .= "$newline\n";
1568 $newsummary =~ s/\[(.*?)]//g;
1569 $newsummary =~ s/\n/<br\/>/g;
1570 $oldbiblio->{summary} = $newsummary;
1573 # Pull out the items fields
1574 my @fields = $marcrecord->field($itemtag);
1575 my $marcflavor = C4::Context->preference("marcflavour");
1576 # adding linked items that belong to host records
1577 my $analyticsfield = '773';
1578 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1579 $analyticsfield = '773';
1580 } elsif ($marcflavor eq 'UNIMARC') {
1581 $analyticsfield = '461';
1583 foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
1584 my $hostbiblionumber = $hostfield->subfield("0");
1585 my $linkeditemnumber = $hostfield->subfield("9");
1586 if(!$hostbiblionumber eq undef){
1587 my $hostbiblio = GetMarcBiblio($hostbiblionumber, 1);
1588 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
1589 if(!$hostbiblio eq undef){
1590 my @hostitems = $hostbiblio->field($itemfield);
1591 foreach my $hostitem (@hostitems){
1592 if ($hostitem->subfield("9") eq $linkeditemnumber){
1593 my $linkeditem =$hostitem;
1594 # append linked items if they exist
1595 if (!$linkeditem eq undef){
1596 push (@fields, $linkeditem);}
1603 # Setting item statuses for display
1604 my @available_items_loop;
1605 my @onloan_items_loop;
1606 my @other_items_loop;
1608 my $available_items;
1612 my $ordered_count = 0;
1613 my $available_count = 0;
1614 my $onloan_count = 0;
1615 my $longoverdue_count = 0;
1616 my $other_count = 0;
1617 my $wthdrawn_count = 0;
1618 my $itemlost_count = 0;
1619 my $hideatopac_count = 0;
1620 my $itembinding_count = 0;
1621 my $itemdamaged_count = 0;
1622 my $item_in_transit_count = 0;
1623 my $can_place_holds = 0;
1624 my $item_onhold_count = 0;
1625 my $items_count = scalar(@fields);
1626 my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
1627 my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
1629 # loop through every item
1631 foreach my $field (@fields) {
1634 # populate the items hash
1635 foreach my $code ( keys %subfieldstosearch ) {
1636 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1638 $item->{description} = $itemtypes{ $item->{itype} }{description};
1642 my @hi = C4::Items::GetHiddenItemnumbers($item);
1643 $item->{'hideatopac'} = @hi;
1644 push @hiddenitems, @hi;
1647 my $hbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'homebranch' : 'holdingbranch';
1648 my $otherbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1650 # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1651 if ($item->{$hbranch}) {
1652 $item->{'branchname'} = $branches{$item->{$hbranch}};
1654 elsif ($item->{$otherbranch}) { # Last resort
1655 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1658 my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
1659 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1660 my $userenv = C4::Context->userenv;
1661 if ( $item->{onloan} && !(C4::Members::GetHideLostItemsPreference($userenv->{'number'}) && $item->{itemlost}) ) {
1663 my $key = $prefix . $item->{onloan} . $item->{barcode};
1664 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
1665 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
1666 $onloan_items->{$key}->{branchname} = $item->{branchname};
1667 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1668 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1669 $onloan_items->{$key}->{description} = $item->{description};
1670 $onloan_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1671 # if something's checked out and lost, mark it as 'long overdue'
1672 if ( $item->{itemlost} ) {
1673 $onloan_items->{$prefix}->{longoverdue}++;
1674 $longoverdue_count++;
1675 } else { # can place holds as long as item isn't lost
1676 $can_place_holds = 1;
1680 # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1684 if ( $item->{notforloan} == -1 ) {
1688 # is item in transit?
1689 my $transfertwhen = '';
1690 my ($transfertfrom, $transfertto);
1692 # is item on the reserve shelf?
1693 my $reservestatus = '';
1696 unless ($item->{wthdrawn}
1697 || $item->{itemlost}
1699 || $item->{notforloan}
1700 || $items_count > 20) {
1702 # A couple heuristics to limit how many times
1703 # we query the database for item transfer information, sacrificing
1704 # accuracy in some cases for speed;
1706 # 1. don't query if item has one of the other statuses
1707 # 2. don't check transit status if the bib has
1708 # more than 20 items
1710 # FIXME: to avoid having the query the database like this, and to make
1711 # the in transit status count as unavailable for search limiting,
1712 # should map transit status to record indexed in Zebra.
1714 ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
1715 ($reservestatus, $reserveitem, undef) = C4::Reserves::CheckReserves($item->{itemnumber});
1718 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
1719 if ( $item->{wthdrawn}
1720 || $item->{itemlost}
1722 || $item->{notforloan} > 0
1723 || $item->{hideatopac}
1724 || $reservestatus eq 'Waiting'
1725 || ($transfertwhen ne ''))
1727 $wthdrawn_count++ if $item->{wthdrawn};
1728 $itemlost_count++ if $item->{itemlost};
1729 $itemdamaged_count++ if $item->{damaged};
1730 $hideatopac_count++ if $item->{hideatopac};
1731 $item_in_transit_count++ if $transfertwhen ne '';
1732 $item_onhold_count++ if $reservestatus eq 'Waiting';
1733 $item->{status} = $item->{wthdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
1735 # can place hold on item ?
1736 if ((!$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems'))
1737 && !$item->{itemlost}
1738 && !$item->{withdrawn}
1740 $can_place_holds = 1;
1745 my $key = $prefix . $item->{status};
1746 foreach (qw(wthdrawn itemlost damaged branchname itemcallnumber hideatopac)) {
1747 $other_items->{$key}->{$_} = $item->{$_};
1749 $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
1750 $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
1751 $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value and $item->{notforloan};
1752 $other_items->{$key}->{count}++ if $item->{$hbranch};
1753 $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1754 $other_items->{$key}->{description} = $item->{description};
1755 $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1759 $can_place_holds = 1;
1761 $available_items->{$prefix}->{count}++ if $item->{$hbranch};
1762 foreach (qw(branchname itemcallnumber hideatopac description)) {
1763 $available_items->{$prefix}->{$_} = $item->{$_};
1765 $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
1766 $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1769 } # notforloan, item level and biblioitem level
1770 if ($items_count > 0) {
1771 next if $is_opac && $hideatopac_count >= $items_count;
1772 next if $hidelostitems && $itemlost_count >= $items_count;
1774 my ( $availableitemscount, $onloanitemscount, $otheritemscount );
1775 for my $key ( sort keys %$onloan_items ) {
1776 (++$onloanitemscount > $maxitems) and last;
1777 push @onloan_items_loop, $onloan_items->{$key};
1779 for my $key ( sort keys %$other_items ) {
1780 (++$otheritemscount > $maxitems) and last;
1781 push @other_items_loop, $other_items->{$key};
1783 for my $key ( sort keys %$available_items ) {
1784 (++$availableitemscount > $maxitems) and last;
1785 push @available_items_loop, $available_items->{$key}
1788 # XSLT processing of some stuff
1790 SetUTF8Flag($marcrecord);
1791 warn $marcrecord->as_formatted if $DEBUG;
1792 my $interface = $search_context eq 'opac' ? 'OPAC' : '';
1793 if (!$scan && C4::Context->preference($interface . "XSLTResultsDisplay")) {
1794 $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $interface."XSLTResultsDisplay", 1, \@hiddenitems);
1795 # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
1798 # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
1799 if (!C4::Context->preference("item-level_itypes")) {
1800 if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
1801 $can_place_holds = 0;
1804 $oldbiblio->{norequests} = 1 unless $can_place_holds;
1805 $oldbiblio->{itemsplural} = 1 if $items_count > 1;
1806 $oldbiblio->{items_count} = $items_count;
1807 $oldbiblio->{available_items_loop} = \@available_items_loop;
1808 $oldbiblio->{onloan_items_loop} = \@onloan_items_loop;
1809 $oldbiblio->{other_items_loop} = \@other_items_loop;
1810 $oldbiblio->{availablecount} = $available_count;
1811 $oldbiblio->{availableplural} = 1 if $available_count > 1;
1812 $oldbiblio->{onloancount} = $onloan_count;
1813 $oldbiblio->{onloanplural} = 1 if $onloan_count > 1;
1814 $oldbiblio->{othercount} = $other_count;
1815 $oldbiblio->{otherplural} = 1 if $other_count > 1;
1816 $oldbiblio->{wthdrawncount} = $wthdrawn_count;
1817 $oldbiblio->{itemlostcount} = $itemlost_count;
1818 $oldbiblio->{damagedcount} = $itemdamaged_count;
1819 $oldbiblio->{intransitcount} = $item_in_transit_count;
1820 $oldbiblio->{onholdcount} = $item_onhold_count;
1821 $oldbiblio->{orderedcount} = $ordered_count;
1823 if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
1824 my $fieldspec = C4::Context->preference("AlternateHoldingsField");
1825 my $subfields = substr $fieldspec, 3;
1826 my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
1827 my @alternateholdingsinfo = ();
1828 my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
1829 my $alternateholdingscount = 0;
1831 for my $field (@holdingsfields) {
1832 my %holding = ( holding => '' );
1833 my $havesubfield = 0;
1834 for my $subfield ($field->subfields()) {
1835 if ((index $subfields, $$subfield[0]) >= 0) {
1836 $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
1837 $holding{'holding'} .= $$subfield[1];
1841 if ($havesubfield) {
1842 push(@alternateholdingsinfo, \%holding);
1843 $alternateholdingscount++;
1847 $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
1848 $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
1851 push( @newresults, $oldbiblio );
1857 =head2 SearchAcquisitions
1858 Search for acquisitions
1861 sub SearchAcquisitions{
1862 my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
1864 my $dbh=C4::Context->dbh;
1865 # Variable initialization
1869 LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
1870 LEFT JOIN items ON items.biblionumber=biblio.biblionumber
1871 WHERE dateaccessioned BETWEEN ? AND ?
1874 my (@params,@loopcriteria);
1876 push @params, $datebegin->output("iso");
1877 push @params, $dateend->output("iso");
1879 if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
1880 if(C4::Context->preference("item-level_itypes")){
1881 $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
1883 $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
1885 push @params, @$itemtypes;
1888 if ($criteria =~/itemtype/){
1889 if(C4::Context->preference("item-level_itypes")){
1890 $str .= "AND items.itype=? ";
1892 $str .= "AND biblioitems.itemtype=? ";
1895 if(scalar(@$itemtypes) == 0){
1896 my $itypes = GetItemTypes();
1897 for my $key (keys %$itypes){
1898 push @$itemtypes, $key;
1902 @loopcriteria= @$itemtypes;
1903 }elsif ($criteria=~/itemcallnumber/){
1904 $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
1905 OR items.itemcallnumber is NULL
1906 OR items.itemcallnumber = '')";
1908 @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
1910 $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
1911 @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
1914 if ($orderby =~ /date_desc/){
1915 $str.=" ORDER BY dateaccessioned DESC";
1917 $str.=" ORDER BY title";
1920 my $qdataacquisitions=$dbh->prepare($str);
1922 my @loopacquisitions;
1923 foreach my $value(@loopcriteria){
1924 push @params,$value;
1926 $cell{"title"}=$value;
1927 $cell{"titlecode"}=$value;
1929 eval{$qdataacquisitions->execute(@params);};
1931 if ($@){ warn "recentacquisitions Error :$@";}
1934 while (my $data=$qdataacquisitions->fetchrow_hashref){
1935 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
1937 $cell{"loopdata"}=\@loopdata;
1939 push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
1942 $qdataacquisitions->finish;
1943 return \@loopacquisitions;
1945 #----------------------------------------------------------------------
1947 # Non-Zebra GetRecords#
1948 #----------------------------------------------------------------------
1952 NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1958 $query, $simple_query, $sort_by_ref, $servers_ref,
1959 $results_per_page, $offset, $expanded_facet, $branches,
1962 warn "query =$query" if $DEBUG;
1963 my $result = NZanalyse($query);
1964 warn "results =$result" if $DEBUG;
1966 NZorder( $result, @$sort_by_ref[0], $results_per_page, $offset ),
1972 NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1973 the list is built from an inverted index in the nozebra SQL table
1974 note that title is here only for convenience : the sorting will be very fast when requested on title
1975 if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1980 my ( $string, $server ) = @_;
1981 # warn "---------" if $DEBUG;
1982 warn " NZanalyse" if $DEBUG;
1983 # warn "---------" if $DEBUG;
1985 # $server contains biblioserver or authorities, depending on what we search on.
1986 #warn "querying : $string on $server";
1987 $server = 'biblioserver' unless $server;
1989 # if we have a ", replace the content to discard temporarily any and/or/not inside
1991 if ( $string =~ /"/ ) {
1992 $string =~ s/"(.*?)"/__X__/;
1994 warn "commacontent : $commacontent" if $DEBUG;
1997 # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1998 # then, call again NZanalyse with $left and $right
1999 # (recursive until we find a leaf (=> something without and/or/not)
2000 # delete repeated operator... Would then go in infinite loop
2001 while ( $string =~ s/( and| or| not| AND| OR| NOT)\1/$1/g ) {
2004 #process parenthesis before.
2005 if ( $string =~ /^\s*\((.*)\)(( and | or | not | AND | OR | NOT )(.*))?/ ) {
2008 my $operator = lc($3); # FIXME: and/or/not are operators, not operands
2010 "dealing w/parenthesis before recursive sub call. left :$left operator:$operator right:$right"
2012 my $leftresult = NZanalyse( $left, $server );
2014 my $rightresult = NZanalyse( $right, $server );
2016 # OK, we have the results for right and left part of the query
2017 # depending of operand, intersect, union or exclude both lists
2018 # to get a result list
2019 if ( $operator eq ' and ' ) {
2020 return NZoperatorAND($leftresult,$rightresult);
2022 elsif ( $operator eq ' or ' ) {
2024 # just merge the 2 strings
2025 return $leftresult . $rightresult;
2027 elsif ( $operator eq ' not ' ) {
2028 return NZoperatorNOT($leftresult,$rightresult);
2032 # this error is impossible, because of the regexp that isolate the operand, but just in case...
2036 warn "string :" . $string if $DEBUG;
2040 if ($string =~ /(.*?)( and | or | not | AND | OR | NOT )(.*)/) {
2043 $operator = lc($2); # FIXME: and/or/not are operators, not operands
2045 warn "no parenthesis. left : $left operator: $operator right: $right"
2048 # it's not a leaf, we have a and/or/not
2051 # reintroduce comma content if needed
2052 $right =~ s/__X__/"$commacontent"/ if $commacontent;
2053 $left =~ s/__X__/"$commacontent"/ if $commacontent;
2054 warn "node : $left / $operator / $right\n" if $DEBUG;
2055 my $leftresult = NZanalyse( $left, $server );
2056 my $rightresult = NZanalyse( $right, $server );
2057 warn " leftresult : $leftresult" if $DEBUG;
2058 warn " rightresult : $rightresult" if $DEBUG;
2059 # OK, we have the results for right and left part of the query
2060 # depending of operand, intersect, union or exclude both lists
2061 # to get a result list
2062 if ( $operator eq ' and ' ) {
2063 return NZoperatorAND($leftresult,$rightresult);
2065 elsif ( $operator eq ' or ' ) {
2067 # just merge the 2 strings
2068 return $leftresult . $rightresult;
2070 elsif ( $operator eq ' not ' ) {
2071 return NZoperatorNOT($leftresult,$rightresult);
2075 # this error is impossible, because of the regexp that isolate the operand, but just in case...
2076 die "error : operand unknown : $operator for $string";
2079 # it's a leaf, do the real SQL query and return the result
2082 $string =~ s/__X__/"$commacontent"/ if $commacontent;
2083 $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
2084 #remove trailing blank at the beginning
2086 warn "leaf:$string" if $DEBUG;
2088 # parse the string in in operator/operand/value again
2092 if ($string =~ /(.*)(>=|<=)(.*)/) {
2099 # warn "handling leaf... left:$left operator:$operator right:$right"
2101 unless ($operator) {
2102 if ($string =~ /(.*)(>|<|=)(.*)/) {
2107 "handling unless (operator)... left:$left operator:$operator right:$right"
2115 # strip adv, zebra keywords, currently not handled in nozebra: wrdl, ext, phr...
2118 # automatic replace for short operators
2119 $left = 'title' if $left =~ '^ti$';
2120 $left = 'author' if $left =~ '^au$';
2121 $left = 'publisher' if $left =~ '^pb$';
2122 $left = 'subject' if $left =~ '^su$';
2123 $left = 'koha-Auth-Number' if $left =~ '^an$';
2124 $left = 'keyword' if $left =~ '^kw$';
2125 $left = 'itemtype' if $left =~ '^mc$'; # Fix for Bug 2599 - Search limits not working for NoZebra
2126 warn "handling leaf... left:$left operator:$operator right:$right" if $DEBUG;
2127 my $dbh = C4::Context->dbh;
2128 if ( $operator && $left ne 'keyword' ) {
2129 #do a specific search
2130 $operator = 'LIKE' if $operator eq '=' and $right =~ /%/;
2131 my $sth = $dbh->prepare(
2132 "SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?"
2134 warn "$left / $operator / $right\n" if $DEBUG;
2136 # split each word, query the DB and build the biblionumbers result
2137 #sanitizing leftpart
2138 $left =~ s/^\s+|\s+$//;
2139 foreach ( split / /, $right ) {
2141 $_ =~ s/^\s+|\s+$//;
2143 warn "EXECUTE : $server, $left, $_" if $DEBUG;
2144 $sth->execute( $server, $left, $_ )
2145 or warn "execute failed: $!";
2146 while ( my ( $line, $value ) = $sth->fetchrow ) {
2148 # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
2149 # otherwise, fill the result
2150 $biblionumbers .= $line
2151 unless ( $right =~ /^\d+$/ && $value =~ /\D/ );
2152 warn "result : $value "
2153 . ( $right =~ /\d/ ) . "=="
2154 . ( $value =~ /\D/?$line:"" ) if $DEBUG; #= $line";
2157 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
2159 warn "NZAND" if $DEBUG;
2160 $results = NZoperatorAND($biblionumbers,$results);
2162 $results = $biblionumbers;
2167 #do a complete search (all indexes), if index='kw' do complete search too.
2168 my $sth = $dbh->prepare(
2169 "SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?"
2172 # split each word, query the DB and build the biblionumbers result
2173 foreach ( split / /, $string ) {
2174 next if C4::Context->stopwords->{ uc($_) }; # skip if stopword
2175 warn "search on all indexes on $_" if $DEBUG;
2178 $sth->execute( $server, $_ );
2179 while ( my $line = $sth->fetchrow ) {
2180 $biblionumbers .= $line;
2183 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
2185 $results = NZoperatorAND($biblionumbers,$results);
2188 warn "NEW RES for $_ = $biblionumbers" if $DEBUG;
2189 $results = $biblionumbers;
2193 warn "return : $results for LEAF : $string" if $DEBUG;
2196 warn "---------\nLeave NZanalyse\n---------" if $DEBUG;
2200 my ($rightresult, $leftresult)=@_;
2202 my @leftresult = split /;/, $leftresult;
2203 warn " @leftresult / $rightresult \n" if $DEBUG;
2205 # my @rightresult = split /;/,$leftresult;
2208 # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
2209 # the result is stored twice, to have the same weight for AND than OR.
2210 # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
2211 # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
2212 foreach (@leftresult) {
2215 ( $value, $countvalue ) = ( $1, $2 ) if ($value=~/(.*)-(\d+)$/);
2216 if ( $rightresult =~ /\Q$value\E-(\d+);/ ) {
2217 $countvalue = ( $1 > $countvalue ? $countvalue : $1 );
2219 "$value-$countvalue;$value-$countvalue;";
2222 warn "NZAND DONE : $finalresult \n" if $DEBUG;
2223 return $finalresult;
2227 my ($rightresult, $leftresult)=@_;
2228 return $rightresult.$leftresult;
2232 my ($leftresult, $rightresult)=@_;
2234 my @leftresult = split /;/, $leftresult;
2236 # my @rightresult = split /;/,$leftresult;
2238 foreach (@leftresult) {
2240 $value=$1 if $value=~m/(.*)-\d+$/;
2241 unless ($rightresult =~ "$value-") {
2242 $finalresult .= "$_;";
2245 return $finalresult;
2250 $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
2257 my ( $biblionumbers, $ordering, $results_per_page, $offset ) = @_;
2258 warn "biblionumbers = $biblionumbers and ordering = $ordering\n" if $DEBUG;
2260 # order title asc by default
2261 # $ordering = '1=36 <i' unless $ordering;
2262 $results_per_page = 20 unless $results_per_page;
2263 $offset = 0 unless $offset;
2264 my $dbh = C4::Context->dbh;
2267 # order by POPULARITY
2269 if ( $ordering =~ /popularity/ ) {
2273 # popularity is not in MARC record, it's builded from a specific query
2275 $dbh->prepare("select sum(issues) from items where biblionumber=?");
2276 foreach ( split /;/, $biblionumbers ) {
2277 my ( $biblionumber, $title ) = split /,/, $_;
2278 $result{$biblionumber} = GetMarcBiblio($biblionumber);
2279 $sth->execute($biblionumber);
2280 my $popularity = $sth->fetchrow || 0;
2282 # hint : the key is popularity.title because we can have
2283 # many results with the same popularity. In this case, sub-ordering is done by title
2284 # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
2285 # (un-frequent, I agree, but we won't forget anything that way ;-)
2286 $popularity{ sprintf( "%10d", $popularity ) . $title
2287 . $biblionumber } = $biblionumber;
2290 # sort the hash and return the same structure as GetRecords (Zebra querying)
2293 if ( $ordering eq 'popularity_dsc' ) { # sort popularity DESC
2294 foreach my $key ( sort { $b cmp $a } ( keys %popularity ) ) {
2295 $result_hash->{'RECORDS'}[ $numbers++ ] =
2296 $result{ $popularity{$key} }->as_usmarc();
2299 else { # sort popularity ASC
2300 foreach my $key ( sort ( keys %popularity ) ) {
2301 $result_hash->{'RECORDS'}[ $numbers++ ] =
2302 $result{ $popularity{$key} }->as_usmarc();
2305 my $finalresult = ();
2306 $result_hash->{'hits'} = $numbers;
2307 $finalresult->{'biblioserver'} = $result_hash;
2308 return $finalresult;
2314 elsif ( $ordering =~ /author/ ) {
2316 foreach ( split /;/, $biblionumbers ) {
2317 my ( $biblionumber, $title ) = split /,/, $_;
2318 my $record = GetMarcBiblio($biblionumber);
2320 if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
2321 $author = $record->subfield( '200', 'f' );
2322 $author = $record->subfield( '700', 'a' ) unless $author;
2325 $author = $record->subfield( '100', 'a' );
2328 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2329 # and we don't want to get only 1 result for each of them !!!
2330 $result{ $author . $biblionumber } = $record;
2333 # sort the hash and return the same structure as GetRecords (Zebra querying)
2336 if ( $ordering eq 'author_za' || $ordering eq 'author_dsc' ) { # sort by author desc
2337 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2338 $result_hash->{'RECORDS'}[ $numbers++ ] =
2339 $result{$key}->as_usmarc();
2342 else { # sort by author ASC
2343 foreach my $key ( sort ( keys %result ) ) {
2344 $result_hash->{'RECORDS'}[ $numbers++ ] =
2345 $result{$key}->as_usmarc();
2348 my $finalresult = ();
2349 $result_hash->{'hits'} = $numbers;
2350 $finalresult->{'biblioserver'} = $result_hash;
2351 return $finalresult;
2354 # ORDER BY callnumber
2357 elsif ( $ordering =~ /callnumber/ ) {
2359 foreach ( split /;/, $biblionumbers ) {
2360 my ( $biblionumber, $title ) = split /,/, $_;
2361 my $record = GetMarcBiblio($biblionumber);
2363 my $frameworkcode = GetFrameworkCode($biblionumber);
2364 my ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField( 'items.itemcallnumber', $frameworkcode);
2365 ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField('biblioitems.callnumber', $frameworkcode)
2366 unless $callnumber_tag;
2367 if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
2368 $callnumber = $record->subfield( '200', 'f' );
2370 $callnumber = $record->subfield( '100', 'a' );
2373 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2374 # and we don't want to get only 1 result for each of them !!!
2375 $result{ $callnumber . $biblionumber } = $record;
2378 # sort the hash and return the same structure as GetRecords (Zebra querying)
2381 if ( $ordering eq 'call_number_dsc' ) { # sort by title desc
2382 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2383 $result_hash->{'RECORDS'}[ $numbers++ ] =
2384 $result{$key}->as_usmarc();
2387 else { # sort by title ASC
2388 foreach my $key ( sort { $a cmp $b } ( keys %result ) ) {
2389 $result_hash->{'RECORDS'}[ $numbers++ ] =
2390 $result{$key}->as_usmarc();
2393 my $finalresult = ();
2394 $result_hash->{'hits'} = $numbers;
2395 $finalresult->{'biblioserver'} = $result_hash;
2396 return $finalresult;
2398 elsif ( $ordering =~ /pubdate/ ) { #pub year
2400 foreach ( split /;/, $biblionumbers ) {
2401 my ( $biblionumber, $title ) = split /,/, $_;
2402 my $record = GetMarcBiblio($biblionumber);
2403 my ( $publicationyear_tag, $publicationyear_subfield ) =
2404 GetMarcFromKohaField( 'biblioitems.publicationyear', '' );
2405 my $publicationyear =
2406 $record->subfield( $publicationyear_tag,
2407 $publicationyear_subfield );
2409 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2410 # and we don't want to get only 1 result for each of them !!!
2411 $result{ $publicationyear . $biblionumber } = $record;
2414 # sort the hash and return the same structure as GetRecords (Zebra querying)
2417 if ( $ordering eq 'pubdate_dsc' ) { # sort by pubyear desc
2418 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2419 $result_hash->{'RECORDS'}[ $numbers++ ] =
2420 $result{$key}->as_usmarc();
2423 else { # sort by pub year ASC
2424 foreach my $key ( sort ( keys %result ) ) {
2425 $result_hash->{'RECORDS'}[ $numbers++ ] =
2426 $result{$key}->as_usmarc();
2429 my $finalresult = ();
2430 $result_hash->{'hits'} = $numbers;
2431 $finalresult->{'biblioserver'} = $result_hash;
2432 return $finalresult;
2438 elsif ( $ordering =~ /title/ ) {
2440 # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
2442 foreach ( split /;/, $biblionumbers ) {
2443 my ( $biblionumber, $title ) = split /,/, $_;
2445 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2446 # and we don't want to get only 1 result for each of them !!!
2447 # hint & speed improvement : we can order without reading the record
2448 # so order, and read records only for the requested page !
2449 $result{ $title . $biblionumber } = $biblionumber;
2452 # sort the hash and return the same structure as GetRecords (Zebra querying)
2455 if ( $ordering eq 'title_az' ) { # sort by title desc
2456 foreach my $key ( sort ( keys %result ) ) {
2457 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2460 else { # sort by title ASC
2461 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2462 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2466 # limit the $results_per_page to result size if it's more
2467 $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2469 # for the requested page, replace biblionumber by the complete record
2470 # speed improvement : avoid reading too much things
2472 my $counter = $offset ;
2473 $counter <= $offset + $results_per_page ;
2477 $result_hash->{'RECORDS'}[$counter] =
2478 GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc;
2480 my $finalresult = ();
2481 $result_hash->{'hits'} = $numbers;
2482 $finalresult->{'biblioserver'} = $result_hash;
2483 return $finalresult;
2490 # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
2493 foreach ( split /;/, $biblionumbers ) {
2494 my ( $biblionumber, $title ) = split /,/, $_;
2495 $title =~ /(.*)-(\d)/;
2500 # note that we + the ranking because ranking is calculated on weight of EACH term requested.
2501 # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
2502 # biblio N has ranking = 6
2503 $count_ranking{$biblionumber} += $ranking;
2506 # build the result by "inverting" the count_ranking hash
2507 # hing : as usual, we don't order by ranking only, to avoid having only 1 result for each rank. We build an hash on concat(ranking,biblionumber) instead
2509 foreach ( keys %count_ranking ) {
2510 $result{ sprintf( "%10d", $count_ranking{$_} ) . '-' . $_ } = $_;
2513 # sort the hash and return the same structure as GetRecords (Zebra querying)
2516 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2517 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2520 # limit the $results_per_page to result size if it's more
2521 $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2523 # for the requested page, replace biblionumber by the complete record
2524 # speed improvement : avoid reading too much things
2526 my $counter = $offset ;
2527 $counter <= $offset + $results_per_page ;
2531 $result_hash->{'RECORDS'}[$counter] =
2532 GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc
2533 if $result_hash->{'RECORDS'}[$counter];
2535 my $finalresult = ();
2536 $result_hash->{'hits'} = $numbers;
2537 $finalresult->{'biblioserver'} = $result_hash;
2538 return $finalresult;
2542 =head2 enabled_staff_search_views
2544 %hash = enabled_staff_search_views()
2546 This function returns a hash that contains three flags obtained from the system
2547 preferences, used to determine whether a particular staff search results view
2552 =item C<Output arg:>
2554 * $hash{can_view_MARC} is true only if the MARC view is enabled
2555 * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2556 * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2558 =item C<usage in the script:>
2562 $template->param ( C4::Search::enabled_staff_search_views );
2566 sub enabled_staff_search_views
2569 can_view_MARC => C4::Context->preference('viewMARC'), # 1 if the staff search allows the MARC view
2570 can_view_ISBD => C4::Context->preference('viewISBD'), # 1 if the staff search allows the ISBD view
2571 can_view_labeledMARC => C4::Context->preference('viewLabeledMARC'), # 1 if the staff search allows the Labeled MARC view
2575 sub AddSearchHistory{
2576 my ($borrowernumber,$session,$query_desc,$query_cgi, $total)=@_;
2577 my $dbh = C4::Context->dbh;
2579 # Add the request the user just made
2580 my $sql = "INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time) VALUES(?, ?, ?, ?, ?, NOW())";
2581 my $sth = $dbh->prepare($sql);
2582 $sth->execute($borrowernumber, $session, $query_desc, $query_cgi, $total);
2583 return $dbh->last_insert_id(undef, 'search_history', undef,undef,undef);
2586 sub GetSearchHistory{
2587 my ($borrowernumber,$session)=@_;
2588 my $dbh = C4::Context->dbh;
2590 # Add the request the user just made
2591 my $query = "SELECT FROM search_history WHERE (userid=? OR sessionid=?)";
2592 my $sth = $dbh->prepare($query);
2593 $sth->execute($borrowernumber, $session);
2594 return $sth->fetchall_hashref({});
2597 =head2 z3950_search_args
2599 $arrayref = z3950_search_args($matchpoints)
2601 This function returns an array reference that contains the search parameters to be
2602 passed to the Z39.50 search script (z3950_search.pl). The array elements
2603 are hash refs whose keys are name, value and encvalue, and whose values are the
2604 name of a search parameter, the value of that search parameter and the URL encoded
2605 value of that parameter.
2607 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2609 The search parameter values are obtained from the bibliographic record whose
2610 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2612 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2613 a general purpose search argument. In this case, the returned array contains only
2614 entry: the key is 'title' and the value and encvalue are derived from $matchpoints.
2616 If a search parameter value is undefined or empty, it is not included in the returned
2619 The returned array reference may be passed directly to the template parameters.
2623 =item C<Output arg:>
2625 * $array containing hash refs as described above
2627 =item C<usage in the script:>
2631 $data = Biblio::GetBiblioData($bibno);
2632 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2636 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2640 sub z3950_search_args {
2642 my $isbn = Business::ISBN->new($bibrec);
2644 if (defined $isbn && $isbn->is_valid)
2646 $bibrec = { isbn => $bibrec } if !ref $bibrec;
2649 $bibrec = { title => $bibrec } if !ref $bibrec;
2652 for my $field (qw/ lccn isbn issn title author dewey subject /)
2654 my $encvalue = URI::Escape::uri_escape_utf8($bibrec->{$field});
2655 push @$array, { name=>$field, value=>$bibrec->{$field}, encvalue=>$encvalue } if defined $bibrec->{$field};
2660 =head2 GetDistinctValues($field);
2662 C<$field> is a reference to the fields array
2666 sub GetDistinctValues {
2667 my ($fieldname,$string)=@_;
2668 # returns a reference to a hash of references to branches...
2669 if ($fieldname=~/\./){
2670 my ($table,$column)=split /\./, $fieldname;
2671 my $dbh = C4::Context->dbh;
2672 warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2673 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 ");
2675 my $elements=$sth->fetchall_arrayref({});
2680 my @servers=qw<biblioserver authorityserver>;
2681 my (@zconns,@results);
2682 for ( my $i = 0 ; $i < @servers ; $i++ ) {
2683 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2686 ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2689 # The big moment: asynchronously retrieve results from all servers
2691 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
2692 my $ev = $zconns[ $i - 1 ]->last_event();
2693 if ( $ev == ZOOM::Event::ZEND ) {
2694 next unless $results[ $i - 1 ];
2695 my $size = $results[ $i - 1 ]->size();
2697 for (my $j=0;$j<$size;$j++){
2699 @hashscan{qw(value cnt)}=$results[ $i - 1 ]->display_term($j);
2700 push @elements, \%hashscan;
2710 END { } # module clean-up code here (global destructor)
2717 Koha Development Team <http://koha-community.org/>