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
39 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
41 # set the version for version checking
44 $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
49 C4::Search - Functions for searching the Koha catalog.
53 See opac/opac-search.pl or catalogue/search.pl for example of usage
57 This module provides searching functions for Koha's bibliographic databases
73 &enabled_staff_search_views
77 # make all your functions, whether exported or not;
81 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
83 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
89 my $dbh = C4::Context->dbh;
90 my $result = TransformMarcToKoha( $dbh, $record, '' );
95 my ( $biblionumber, $title );
97 # search duplicate on ISBN, easy and fast..
99 if ( $result->{isbn} ) {
100 $result->{isbn} =~ s/\(.*$//;
101 $result->{isbn} =~ s/\s+$//;
102 $query = "isbn=$result->{isbn}";
105 $result->{title} =~ s /\\//g;
106 $result->{title} =~ s /\"//g;
107 $result->{title} =~ s /\(//g;
108 $result->{title} =~ s /\)//g;
110 # FIXME: instead of removing operators, could just do
111 # quotes around the value
112 $result->{title} =~ s/(and|or|not)//g;
113 $query = "ti,ext=$result->{title}";
114 $query .= " and itemtype=$result->{itemtype}"
115 if ( $result->{itemtype} );
116 if ( $result->{author} ) {
117 $result->{author} =~ s /\\//g;
118 $result->{author} =~ s /\"//g;
119 $result->{author} =~ s /\(//g;
120 $result->{author} =~ s /\)//g;
122 # remove valid operators
123 $result->{author} =~ s/(and|or|not)//g;
124 $query .= " and au,ext=$result->{author}";
128 my ( $error, $searchresults, undef ) = SimpleSearch($query); # FIXME :: hardcoded !
130 if (!defined $error) {
131 foreach my $possible_duplicate_record (@{$searchresults}) {
133 MARC::Record->new_from_usmarc($possible_duplicate_record);
134 my $result = TransformMarcToKoha( $dbh, $marcrecord, '' );
136 # FIXME :: why 2 $biblionumber ?
138 push @results, $result->{'biblionumber'};
139 push @results, $result->{'title'};
148 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers] );
150 This function provides a simple search API on the bibliographic catalog
156 * $query can be a simple keyword or a complete CCL query
157 * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
158 * $offset - If present, represents the number of records at the beggining to omit. Defaults to 0
159 * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
164 Returns an array consisting of three elements
165 * $error is undefined unless an error is detected
166 * $results is a reference to an array of records.
167 * $total_hits is the number of hits that would have been returned with no limit
169 If an error is returned the two other return elements are undefined. If error itself is undefined
170 the other two elements are always defined
172 =item C<usage in the script:>
176 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
178 if (defined $error) {
179 $template->param(query_error => $error);
180 warn "error: ".$error;
181 output_html_with_http_headers $input, $cookie, $template->output;
185 my $hits = @{$marcresults};
188 for my $r ( @{$marcresults} ) {
189 my $marcrecord = MARC::File::USMARC::decode($r);
190 my $biblio = TransformMarcToKoha(C4::Context->dbh,$marcrecord,q{});
192 #build the iarray of hashs for the template.
194 title => $biblio->{'title'},
195 subtitle => $biblio->{'subtitle'},
196 biblionumber => $biblio->{'biblionumber'},
197 author => $biblio->{'author'},
198 publishercode => $biblio->{'publishercode'},
199 publicationyear => $biblio->{'publicationyear'},
204 $template->param(result=>\@results);
209 my ( $query, $offset, $max_results, $servers ) = @_;
211 if ( C4::Context->preference('NoZebra') ) {
212 my $result = NZorder( NZanalyse($query) )->{'biblioserver'};
215 && $result->{hits} > 0 ? $result->{'RECORDS'} : [] );
216 return ( undef, $search_result, scalar($result->{hits}) );
219 return ( 'No query entered', undef, undef ) unless $query;
220 # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
221 my @servers = defined ( $servers ) ? @$servers : ( 'biblioserver' );
228 # Initialize & Search Zebra
229 for ( my $i = 0 ; $i < @servers ; $i++ ) {
231 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
232 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
233 $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
237 $zconns[$i]->errmsg() . " ("
238 . $zconns[$i]->errcode() . ") "
239 . $zconns[$i]->addinfo() . " "
240 . $zconns[$i]->diagset();
242 return ( $error, undef, undef ) if $zconns[$i]->errcode();
246 # caught a ZOOM::Exception
250 . $@->addinfo() . " "
253 return ( $error, undef, undef );
256 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
257 my $event = $zconns[ $i - 1 ]->last_event();
258 if ( $event == ZOOM::Event::ZEND ) {
260 my $first_record = defined( $offset ) ? $offset+1 : 1;
261 my $hits = $tmpresults[ $i - 1 ]->size();
262 $total_hits += $hits;
263 my $last_record = $hits;
264 if ( defined $max_results && $offset + $max_results < $hits ) {
265 $last_record = $offset + $max_results;
268 for my $j ( $first_record..$last_record ) {
269 my $record = $tmpresults[ $i - 1 ]->record( $j-1 )->raw(); # 0 indexed
270 push @{$results}, $record;
275 foreach my $result (@tmpresults) {
278 foreach my $zoom_query (@zoom_queries) {
279 $zoom_query->destroy();
282 return ( undef, $results, $total_hits );
288 ( undef, $results_hashref, \@facets_loop ) = getRecords (
290 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
291 $results_per_page, $offset, $expanded_facet, $branches,
295 The all singing, all dancing, multi-server, asynchronous, scanning,
296 searching, record nabbing, facet-building
298 See verbse embedded documentation.
304 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
305 $results_per_page, $offset, $expanded_facet, $branches,
309 my @servers = @$servers_ref;
310 my @sort_by = @$sort_by_ref;
312 # Initialize variables for the ZOOM connection and results object
316 my $results_hashref = ();
318 # Initialize variables for the faceted results objects
319 my $facets_counter = ();
320 my $facets_info = ();
321 my $facets = getFacets();
322 my $facets_maxrecs = C4::Context->preference('maxRecordsForFacets')||20;
324 my @facets_loop; # stores the ref to array of hashes for template facets loop
326 ### LOOP THROUGH THE SERVERS
327 for ( my $i = 0 ; $i < @servers ; $i++ ) {
328 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
330 # perform the search, create the results objects
331 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
332 my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
334 #$query_to_use = $simple_query if $scan;
335 warn $simple_query if ( $scan and $DEBUG );
337 # Check if we've got a query_type defined, if so, use it
340 if ($query_type =~ /^ccl/) {
341 $query_to_use =~ s/\:/\=/g; # change : to = last minute (FIXME)
342 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
343 } elsif ($query_type =~ /^cql/) {
344 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
345 } elsif ($query_type =~ /^pqf/) {
346 $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
348 warn "Unknown query_type '$query_type'. Results undetermined.";
351 $results[$i] = $zconns[$i]->scan( new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
353 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
357 warn "WARNING: query problem with $query_to_use " . $@;
360 # Concatenate the sort_by limits and pass them to the results object
361 # Note: sort will override rank
363 foreach my $sort (@sort_by) {
364 if ( $sort eq "author_az" || $sort eq "author_asc" ) {
365 $sort_by .= "1=1003 <i ";
367 elsif ( $sort eq "author_za" || $sort eq "author_dsc" ) {
368 $sort_by .= "1=1003 >i ";
370 elsif ( $sort eq "popularity_asc" ) {
371 $sort_by .= "1=9003 <i ";
373 elsif ( $sort eq "popularity_dsc" ) {
374 $sort_by .= "1=9003 >i ";
376 elsif ( $sort eq "call_number_asc" ) {
377 $sort_by .= "1=8007 <i ";
379 elsif ( $sort eq "call_number_dsc" ) {
380 $sort_by .= "1=8007 >i ";
382 elsif ( $sort eq "pubdate_asc" ) {
383 $sort_by .= "1=31 <i ";
385 elsif ( $sort eq "pubdate_dsc" ) {
386 $sort_by .= "1=31 >i ";
388 elsif ( $sort eq "acqdate_asc" ) {
389 $sort_by .= "1=32 <i ";
391 elsif ( $sort eq "acqdate_dsc" ) {
392 $sort_by .= "1=32 >i ";
394 elsif ( $sort eq "title_az" || $sort eq "title_asc" ) {
395 $sort_by .= "1=4 <i ";
397 elsif ( $sort eq "title_za" || $sort eq "title_dsc" ) {
398 $sort_by .= "1=4 >i ";
401 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
404 if ($sort_by && !$scan) {
405 if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
406 warn "WARNING sort $sort_by failed";
409 } # finished looping through servers
411 # The big moment: asynchronously retrieve results from all servers
412 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
413 my $ev = $zconns[ $i - 1 ]->last_event();
414 if ( $ev == ZOOM::Event::ZEND ) {
415 next unless $results[ $i - 1 ];
416 my $size = $results[ $i - 1 ]->size();
420 # loop through the results
421 $results_hash->{'hits'} = $size;
423 if ( $offset + $results_per_page <= $size ) {
424 $times = $offset + $results_per_page;
429 for ( my $j = $offset ; $j < $times ; $j++ ) {
433 ## Check if it's an index scan
435 my ( $term, $occ ) = $results[ $i - 1 ]->term($j);
437 # here we create a minimal MARC record and hand it off to the
438 # template just like a normal result ... perhaps not ideal, but
440 my $tmprecord = MARC::Record->new();
441 $tmprecord->encoding('UTF-8');
445 # the minimal record in author/title (depending on MARC flavour)
446 if (C4::Context->preference("marcflavour") eq "UNIMARC") {
447 $tmptitle = MARC::Field->new('200',' ',' ', a => $term, f => $occ);
448 $tmprecord->append_fields($tmptitle);
450 $tmptitle = MARC::Field->new('245',' ',' ', a => $term,);
451 $tmpauthor = MARC::Field->new('100',' ',' ', a => $occ,);
452 $tmprecord->append_fields($tmptitle);
453 $tmprecord->append_fields($tmpauthor);
455 $results_hash->{'RECORDS'}[$j] = $tmprecord->as_usmarc();
460 $record = $results[ $i - 1 ]->record($j)->raw();
462 # warn "RECORD $j:".$record;
463 $results_hash->{'RECORDS'}[$j] = $record;
467 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
469 # Fill the facets while we're looping, but only for the biblioserver and not for a scan
470 if ( !$scan && $servers[ $i - 1 ] =~ /biblioserver/ ) {
472 my $jmax = $size>$facets_maxrecs? $facets_maxrecs: $size;
473 for my $facet ( @$facets ) {
474 for ( my $j = 0 ; $j < $jmax ; $j++ ) {
475 my $render_record = $results[ $i - 1 ]->record($j)->render();
477 foreach my $tag ( @{$facet->{tags}} ) {
479 my $tag_num = substr($tag, 0, 3);
480 my $letters = substr($tag, 3);
481 my $field_pattern = '\n' . $tag_num . ' ([^\n]+)';
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 = "*";
560 # but we're down with the whole label being in the link's title.
561 push @this_facets_array, {
562 facet_count => $facets_counter->{$link_value}->{$one_facet},
563 facet_label_value => $facet_label_value,
564 facet_title_value => $one_facet,
565 facet_link_value => $facet_link_value,
566 type_link_value => $link_value,
571 # handle expanded option
572 unless ( $facets_info->{$link_value}->{'expanded'} ) {
574 if ( ( $number_of_facets > 6 )
575 && ( $expanded_facet ne $link_value ) );
578 type_link_value => $link_value,
579 type_id => $link_value . "_id",
580 "type_label_" . $facets_info->{$link_value}->{'label_value'} => 1,
581 facets => \@this_facets_array,
582 expandable => $expandable,
583 expand => $link_value,
584 } unless ( ($facets_info->{$link_value}->{'label_value'} =~ /Libraries/) and (C4::Context->preference('singleBranchMode')) );
589 return ( undef, $results_hashref, \@facets_loop );
594 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
595 $results_per_page, $offset, $expanded_facet, $branches,
599 my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
601 $paz->search($simple_query);
602 sleep 1; # FIXME: WHY?
605 my $results_hashref = {};
606 my $stats = XMLin($paz->stat);
607 my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
609 # for a grouped search result, the number of hits
610 # is the number of groups returned; 'bib_hits' will have
611 # the total number of bibs.
612 $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
613 $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
615 HIT: foreach my $hit (@{ $results->{'hit'} }) {
616 my $recid = $hit->{recid}->[0];
618 my $work_title = $hit->{'md-work-title'}->[0];
620 if (exists $hit->{'md-work-author'}) {
621 $work_author = $hit->{'md-work-author'}->[0];
623 my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
625 my $result_group = {};
626 $result_group->{'group_label'} = $group_label;
627 $result_group->{'group_merge_key'} = $recid;
630 if (exists $hit->{count}) {
631 $count = $hit->{count}->[0];
633 $result_group->{'group_count'} = $count;
635 for (my $i = 0; $i < $count; $i++) {
636 # FIXME -- may need to worry about diacritics here
637 my $rec = $paz->record($recid, $i);
638 push @{ $result_group->{'RECORDS'} }, $rec;
641 push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
644 # pass through facets
645 my $termlist_xml = $paz->termlist('author,subject');
646 my $terms = XMLin($termlist_xml, forcearray => 1);
647 my @facets_loop = ();
648 #die Dumper($results);
649 # foreach my $list (sort keys %{ $terms->{'list'} }) {
651 # foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
653 # facet_label_value => $facet->{'name'}->[0],
656 # push @facets_loop, ( {
657 # type_label => $list,
658 # facets => \@facets,
662 return ( undef, $results_hashref, \@facets_loop );
666 sub _remove_stopwords {
667 my ( $operand, $index ) = @_;
668 my @stopwords_removed;
670 # phrase and exact-qualified indexes shouldn't have stopwords removed
671 if ( $index !~ m/phr|ext/ ) {
673 # remove stopwords from operand : parse all stopwords & remove them (case insensitive)
674 # we use IsAlpha unicode definition, to deal correctly with diacritics.
675 # otherwise, a French word like "leçon" woudl be split into "le" "çon", "le"
676 # is a stopword, we'd get "çon" and wouldn't find anything...
678 foreach ( keys %{ C4::Context->stopwords } ) {
679 next if ( $_ =~ /(and|or|not)/ ); # don't remove operators
680 if ( my ($matched) = ($operand =~
681 /([^\X\p{isAlnum}]\Q$_\E[^\X\p{isAlnum}]|[^\X\p{isAlnum}]\Q$_\E$|^\Q$_\E[^\X\p{isAlnum}])/gi))
683 $operand =~ s/\Q$matched\E/ /gi;
684 push @stopwords_removed, $_;
688 return ( $operand, \@stopwords_removed );
692 sub _detect_truncation {
693 my ( $operand, $index ) = @_;
694 my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
697 my @wordlist = split( /\s/, $operand );
698 foreach my $word (@wordlist) {
699 if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
700 push @rightlefttruncated, $word;
702 elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
703 push @lefttruncated, $word;
705 elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
706 push @righttruncated, $word;
708 elsif ( index( $word, "*" ) < 0 ) {
709 push @nontruncated, $word;
712 push @regexpr, $word;
716 \@nontruncated, \@righttruncated, \@lefttruncated,
717 \@rightlefttruncated, \@regexpr
722 sub _build_stemmed_operand {
723 my ($operand,$lang) = @_;
724 require Lingua::Stem::Snowball ;
727 # If operand contains a digit, it is almost certainly an identifier, and should
728 # not be stemmed. This is particularly relevant for ISBNs and ISSNs, which
729 # can contain the letter "X" - for example, _build_stemmend_operand would reduce
730 # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
731 # results (e.g., "23 x 29 cm." from the 300$c). Bug 2098.
732 return $operand if $operand =~ /\d/;
734 # FIXME: the locale should be set based on the user's language and/or search choice
736 my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
737 encoding => "UTF-8" );
739 my @words = split( / /, $operand );
740 my @stems = $stemmer->stem(\@words);
741 for my $stem (@stems) {
742 $stemmed_operand .= "$stem";
743 $stemmed_operand .= "?"
744 unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
745 $stemmed_operand .= " ";
747 warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
748 return $stemmed_operand;
752 sub _build_weighted_query {
754 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
755 # pretty well but could work much better if we had a smarter query parser
756 my ( $operand, $stemmed_operand, $index ) = @_;
757 my $stemming = C4::Context->preference("QueryStemming") || 0;
758 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
759 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
761 my $weighted_query .= "(rk=("; # Specifies that we're applying rank
763 # Keyword, or, no index specified
764 if ( ( $index eq 'kw' ) || ( !$index ) ) {
766 "Title-cover,ext,r1=\"$operand\""; # exact title-cover
767 $weighted_query .= " or ti,ext,r2=\"$operand\""; # exact title
768 $weighted_query .= " or ti,phr,r3=\"$operand\""; # phrase title
769 #$weighted_query .= " or any,ext,r4=$operand"; # exact any
770 #$weighted_query .=" or kw,wrdl,r5=\"$operand\""; # word list any
771 $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
772 if $fuzzy_enabled; # add fuzzy, word list
773 $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
774 if ( $stemming and $stemmed_operand )
775 ; # add stemming, right truncation
776 $weighted_query .= " or wrdl,r9=\"$operand\"";
778 # embedded sorting: 0 a-z; 1 z-a
779 # $weighted_query .= ") or (sort1,aut=1";
782 # Barcode searches should skip this process
783 elsif ( $index eq 'bc' ) {
784 $weighted_query .= "bc=\"$operand\"";
787 # Authority-number searches should skip this process
788 elsif ( $index eq 'an' ) {
789 $weighted_query .= "an=\"$operand\"";
792 # If the index already has more than one qualifier, wrap the operand
793 # in quotes and pass it back (assumption is that the user knows what they
794 # are doing and won't appreciate us mucking up their query
795 elsif ( $index =~ ',' ) {
796 $weighted_query .= " $index=\"$operand\"";
799 #TODO: build better cases based on specific search indexes
801 $weighted_query .= " $index,ext,r1=\"$operand\""; # exact index
802 #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
803 $weighted_query .= " or $index,phr,r3=\"$operand\""; # phrase index
805 " or $index,rt,wrdl,r3=\"$operand\""; # word list index
808 $weighted_query .= "))"; # close rank specification
809 return $weighted_query;
814 Return an array with available indexes.
836 'Author-personal-bibliography',
846 'Chronological-subdivision',
856 'Conference-name-heading',
857 'Conference-name-see',
858 'Conference-name-seealso',
863 'Corporate-name-heading',
864 'Corporate-name-see',
865 'Corporate-name-seealso',
867 'date-entered-on-file',
868 'Date-of-acquisition',
869 'Date-of-publication',
870 'Dewey-classification',
877 'Geographic-subdivision',
880 'Heading-use-main-or-added-entry',
881 'Heading-use-series-added-entry ',
882 'Heading-use-subject-added-entry',
900 'Local-classification',
903 'Match-heading-see-from',
911 'Name-geographic-heading',
912 'Name-geographic-see',
913 'Name-geographic-seealso',
921 'Personal-name-heading',
923 'Personal-name-seealso',
930 'Record-control-number',
941 'Subject-heading-thesaurus',
942 'Subject-name-personal',
943 'Subject-subdivision',
953 'Term-genre-form-heading',
954 'Term-genre-form-see',
955 'Term-genre-form-seealso',
962 'Title-uniform-heading',
964 'Title-uniform-seealso',
974 'classification-source',
976 'coded-location-qualifier',
987 'Local-classification',
990 'materials-specified',
999 'replacementpricedate',
1017 $simple_query, $query_cgi,
1018 $query_desc, $limit,
1019 $limit_cgi, $limit_desc,
1020 $stopwords_removed, $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
1022 Build queries and limits in CCL, CGI, Human,
1023 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
1025 See verbose embedded documentation.
1031 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
1033 warn "---------\nEnter buildQuery\n---------" if $DEBUG;
1036 my @operators = $operators ? @$operators : ();
1037 my @indexes = $indexes ? @$indexes : ();
1038 my @operands = $operands ? @$operands : ();
1039 my @limits = $limits ? @$limits : ();
1040 my @sort_by = $sort_by ? @$sort_by : ();
1042 my $stemming = C4::Context->preference("QueryStemming") || 0;
1043 my $auto_truncation = C4::Context->preference("QueryAutoTruncate") || 0;
1044 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1045 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1046 my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
1048 # no stemming/weight/fuzzy in NoZebra
1049 if ( C4::Context->preference("NoZebra") ) {
1053 $auto_truncation = 0;
1056 my $query = $operands[0];
1057 my $simple_query = $operands[0];
1059 # initialize the variables we're passing back
1068 my $stopwords_removed; # flag to determine if stopwords have been removed
1071 my $cclindexes = getIndexes();
1072 if ( $query !~ /\s*ccl=/ ) {
1073 while ( !$cclq && $query =~ /(?:^|\W)([\w-]+)(,[\w-]+)*[:=]/g ) {
1075 $cclq = grep { lc($_) eq $dx } @$cclindexes;
1077 $query = "ccl=$query" if $cclq;
1080 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1082 if ( $query =~ /^ccl=/ ) {
1084 # This is needed otherwise ccl= and &limit won't work together, and
1085 # this happens when selecting a subject on the opac-detail page
1087 $q .= ' and '.join(' and ', @limits);
1089 return ( undef, $q, $q, "q=ccl=$q", $q, '', '', '', '', 'ccl' );
1091 if ( $query =~ /^cql=/ ) {
1092 return ( undef, $', $', "q=cql=$'", $', '', '', '', '', 'cql' );
1094 if ( $query =~ /^pqf=/ ) {
1095 return ( undef, $', $', "q=pqf=$'", $', '', '', '', '', 'pqf' );
1098 # pass nested queries directly
1099 # FIXME: need better handling of some of these variables in this case
1100 # Nested queries aren't handled well and this implementation is flawed and causes users to be
1101 # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1102 # if ( $query =~ /(\(|\))/ ) {
1104 # undef, $query, $simple_query, $query_cgi,
1105 # $query, $limit, $limit_cgi, $limit_desc,
1106 # $stopwords_removed, 'ccl'
1110 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1111 # query operands and indexes and add stemming, truncation, field weighting, etc.
1112 # Once we do so, we'll end up with a value in $query, just like if we had an
1113 # incoming $query from the user
1116 ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1117 my $previous_operand
1118 ; # a flag used to keep track if there was a previous query
1119 # if there was, we can apply the current operator
1121 for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1123 # COMBINE OPERANDS, INDEXES AND OPERATORS
1124 if ( $operands[$i] ) {
1125 $operands[$i]=~s/^\s+//;
1127 # A flag to determine whether or not to add the index to the query
1130 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
1131 if ( $operands[$i] =~ /\w(:|=)/ || $scan ) {
1134 $remove_stopwords = 0;
1136 $operands[$i] =~ s/\?/{?}/g; # need to escape question marks
1138 my $operand = $operands[$i];
1139 my $index = $indexes[$i];
1141 # Add index-specific attributes
1142 # Date of Publication
1143 if ( $index eq 'yr' ) {
1144 $index .= ",st-numeric";
1146 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1149 # Date of Acquisition
1150 elsif ( $index eq 'acqdate' ) {
1151 $index .= ",st-date-normalized";
1153 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1155 # ISBN,ISSN,Standard Number, don't need special treatment
1156 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1158 $stemming, $auto_truncation,
1159 $weight_fields, $fuzzy_enabled,
1161 ) = ( 0, 0, 0, 0, 0 );
1169 # Set default structure attribute (word list)
1170 my $struct_attr = q{};
1171 unless ( $indexes_set || !$index || $index =~ /(st-|phr|ext|wrdl|nb|ns)/ ) {
1172 $struct_attr = ",wrdl";
1175 # Some helpful index variants
1176 my $index_plus = $index . $struct_attr . ':';
1177 my $index_plus_comma = $index . $struct_attr . ',';
1180 if ($remove_stopwords) {
1181 ( $operand, $stopwords_removed ) =
1182 _remove_stopwords( $operand, $index );
1183 warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
1184 warn "REMOVED STOPWORDS: @$stopwords_removed"
1185 if ( $stopwords_removed && $DEBUG );
1188 if ($auto_truncation){
1189 unless ( $index =~ /(st-|phr|ext)/ ) {
1190 #FIXME only valid with LTR scripts
1191 $operand=join(" ",map{
1192 (index($_,"*")>0?"$_":"$_*")
1193 }split (/\s+/,$operand));
1194 warn $operand if $DEBUG;
1199 my $truncated_operand;
1200 my( $nontruncated, $righttruncated, $lefttruncated,
1201 $rightlefttruncated, $regexpr
1202 ) = _detect_truncation( $operand, $index );
1204 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1209 scalar(@$righttruncated) + scalar(@$lefttruncated) +
1210 scalar(@$rightlefttruncated) > 0 )
1213 # Don't field weight or add the index to the query, we do it here
1215 undef $weight_fields;
1216 my $previous_truncation_operand;
1217 if (scalar @$nontruncated) {
1218 $truncated_operand .= "$index_plus @$nontruncated ";
1219 $previous_truncation_operand = 1;
1221 if (scalar @$righttruncated) {
1222 $truncated_operand .= "and " if $previous_truncation_operand;
1223 $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1224 $previous_truncation_operand = 1;
1226 if (scalar @$lefttruncated) {
1227 $truncated_operand .= "and " if $previous_truncation_operand;
1228 $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1229 $previous_truncation_operand = 1;
1231 if (scalar @$rightlefttruncated) {
1232 $truncated_operand .= "and " if $previous_truncation_operand;
1233 $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1234 $previous_truncation_operand = 1;
1237 $operand = $truncated_operand if $truncated_operand;
1238 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1241 my $stemmed_operand;
1242 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1245 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1247 # Handle Field Weighting
1248 my $weighted_operand;
1249 if ($weight_fields) {
1250 $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1251 $operand = $weighted_operand;
1255 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1257 # If there's a previous operand, we need to add an operator
1258 if ($previous_operand) {
1260 # User-specified operator
1261 if ( $operators[ $i - 1 ] ) {
1262 $query .= " $operators[$i-1] ";
1263 $query .= " $index_plus " unless $indexes_set;
1264 $query .= " $operand";
1265 $query_cgi .= "&op=$operators[$i-1]";
1266 $query_cgi .= "&idx=$index" if $index;
1267 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1269 " $operators[$i-1] $index_plus $operands[$i]";
1272 # Default operator is and
1275 $query .= "$index_plus " unless $indexes_set;
1276 $query .= "$operand";
1277 $query_cgi .= "&op=and&idx=$index" if $index;
1278 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1279 $query_desc .= " and $index_plus $operands[$i]";
1283 # There isn't a pervious operand, don't need an operator
1286 # Field-weighted queries already have indexes set
1287 $query .= " $index_plus " unless $indexes_set;
1289 $query_desc .= " $index_plus $operands[$i]";
1290 $query_cgi .= "&idx=$index" if $index;
1291 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1292 $previous_operand = 1;
1297 warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1300 my %group_OR_limits;
1301 my $availability_limit;
1302 foreach my $this_limit (@limits) {
1303 if ( $this_limit =~ /available/ ) {
1305 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1307 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1308 $availability_limit .=
1309 "( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1310 $limit_cgi .= "&limit=available";
1314 # group_OR_limits, prefixed by mc-
1315 # OR every member of the group
1316 elsif ( $this_limit =~ /mc/ ) {
1317 my ($k,$v) = split(/:/, $this_limit,2);
1318 if ( $k !~ /mc-i(tem)?type/ ) {
1319 # in case the mc-ccode value has complicating chars like ()'s inside it we wrap in quotes
1320 $this_limit =~ tr/"//d;
1321 $this_limit = $k.":\"".$v."\"";
1324 $group_OR_limits{$k} .= " or " if $group_OR_limits{$k};
1325 $limit_desc .= " or " if $group_OR_limits{$k};
1326 $group_OR_limits{$k} .= "$this_limit";
1327 $limit_cgi .= "&limit=$this_limit";
1328 $limit_desc .= " $this_limit";
1331 # Regular old limits
1333 $limit .= " and " if $limit || $query;
1334 $limit .= "$this_limit";
1335 $limit_cgi .= "&limit=$this_limit";
1336 if ($this_limit =~ /^branch:(.+)/) {
1337 my $branchcode = $1;
1338 my $branchname = GetBranchName($branchcode);
1339 if (defined $branchname) {
1340 $limit_desc .= " branch:$branchname";
1342 $limit_desc .= " $this_limit";
1345 $limit_desc .= " $this_limit";
1349 foreach my $k (keys (%group_OR_limits)) {
1350 $limit .= " and " if ( $query || $limit );
1351 $limit .= "($group_OR_limits{$k})";
1353 if ($availability_limit) {
1354 $limit .= " and " if ( $query || $limit );
1355 $limit .= "($availability_limit)";
1358 # Normalize the query and limit strings
1359 # This is flawed , means we can't search anything with : in it
1360 # if user wants to do ccl or cql, start the query with that
1361 # $query =~ s/:/=/g;
1362 $query =~ s/(?<=(ti|au|pb|su|an|kw|mc|nb|ns)):/=/g;
1363 $query =~ s/(?<=(wrdl)):/=/g;
1364 $query =~ s/(?<=(trn|phr)):/=/g;
1366 for ( $query, $query_desc, $limit, $limit_desc ) {
1367 s/ +/ /g; # remove extra spaces
1368 s/^ //g; # remove any beginning spaces
1369 s/ $//g; # remove any ending spaces
1370 s/==/=/g; # remove double == from query
1372 $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1374 for ($query_cgi,$simple_query) {
1377 # append the limit to the query
1378 $query .= " " . $limit;
1382 warn "QUERY:" . $query;
1383 warn "QUERY CGI:" . $query_cgi;
1384 warn "QUERY DESC:" . $query_desc;
1385 warn "LIMIT:" . $limit;
1386 warn "LIMIT CGI:" . $limit_cgi;
1387 warn "LIMIT DESC:" . $limit_desc;
1388 warn "---------\nLeave buildQuery\n---------";
1391 undef, $query, $simple_query, $query_cgi,
1392 $query_desc, $limit, $limit_cgi, $limit_desc,
1393 $stopwords_removed, $query_type
1397 =head2 searchResults
1399 my @search_results = searchResults($search_context, $searchdesc, $hits,
1400 $results_per_page, $offset, $scan,
1401 @marcresults, $hidelostitems);
1403 Format results in a form suitable for passing to the template
1407 # IMO this subroutine is pretty messy still -- it's responsible for
1408 # building the HTML output for the template
1410 my ( $search_context, $searchdesc, $hits, $results_per_page, $offset, $scan, $marcresults ) = @_;
1411 my $dbh = C4::Context->dbh;
1414 $search_context = 'opac' if !$search_context || $search_context ne 'intranet';
1415 my ($is_opac, $hidelostitems);
1416 if ($search_context eq 'opac') {
1417 $hidelostitems = C4::Context->preference('hidelostitems');
1421 #Build branchnames hash
1423 #get branch information.....
1425 my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1427 while ( my $bdata = $bsth->fetchrow_hashref ) {
1428 $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1430 # FIXME - We build an authorised values hash here, using the default framework
1431 # though it is possible to have different authvals for different fws.
1433 my $shelflocations =GetKohaAuthorisedValues('items.location','');
1435 # get notforloan authorised value list (see $shelflocations FIXME)
1436 my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1438 #Build itemtype hash
1439 #find itemtype & itemtype image
1443 "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1446 while ( my $bdata = $bsth->fetchrow_hashref ) {
1447 foreach (qw(description imageurl summary notforloan)) {
1448 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1452 #search item field code
1455 "SELECT tagfield FROM marc_subfield_structure WHERE kohafield LIKE 'items.itemnumber'"
1458 my ($itemtag) = $sth->fetchrow;
1460 ## find column names of items related to MARC
1461 my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1463 my %subfieldstosearch;
1464 while ( ( my $column ) = $sth2->fetchrow ) {
1465 my ( $tagfield, $tagsubfield ) =
1466 &GetMarcFromKohaField( "items." . $column, "" );
1467 $subfieldstosearch{$column} = $tagsubfield;
1470 # handle which records to actually retrieve
1472 if ( $hits && $offset + $results_per_page <= $hits ) {
1473 $times = $offset + $results_per_page;
1476 $times = $hits; # FIXME: if $hits is undefined, why do we want to equal it?
1479 my $marcflavour = C4::Context->preference("marcflavour");
1480 # We get the biblionumber position in MARC
1481 my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1483 # loop through all of the records we've retrieved
1484 for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1485 my $marcrecord = MARC::File::USMARC::decode( $marcresults->[$i] );
1489 ? GetFrameworkCode($marcrecord->field($bibliotag)->data)
1490 : GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1491 my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, $fw );
1492 $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1493 $oldbiblio->{result_number} = $i + 1;
1495 # add imageurl to itemtype if there is one
1496 $oldbiblio->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1498 $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 ) ) : [];
1499 $oldbiblio->{normalized_upc} = GetNormalizedUPC( $marcrecord,$marcflavour);
1500 $oldbiblio->{normalized_ean} = GetNormalizedEAN( $marcrecord,$marcflavour);
1501 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1502 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1503 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1505 # edition information, if any
1506 $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1507 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1508 # Build summary if there is one (the summary is defined in the itemtypes table)
1509 # FIXME: is this used anywhere, I think it can be commented out? -- JF
1510 if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1511 my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1512 my @fields = $marcrecord->fields();
1515 foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1517 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1518 $tag =~ /(.{3})(.)/;
1519 if($marcrecord->field($1)){
1520 my @abc = $marcrecord->field($1)->subfield($2);
1521 $tags->{$tag} = $#abc + 1 ;
1525 # We catch how many times to repeat this line
1527 foreach my $tag (keys(%$tags)){
1528 $max = $tags->{$tag} if($tags->{$tag} > $max);
1531 # we replace, and repeat each line
1532 for (my $i = 0 ; $i < $max ; $i++){
1533 my $newline = $line;
1535 foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1536 $tag =~ /(.{3})(.)/;
1538 if($marcrecord->field($1)){
1539 my @repl = $marcrecord->field($1)->subfield($2);
1540 my $subfieldvalue = $repl[$i];
1542 if (! utf8::is_utf8($subfieldvalue)) {
1543 utf8::decode($subfieldvalue);
1546 $newline =~ s/\[$tag\]/$subfieldvalue/g;
1549 $newsummary .= "$newline\n";
1553 $newsummary =~ s/\[(.*?)]//g;
1554 $newsummary =~ s/\n/<br\/>/g;
1555 $oldbiblio->{summary} = $newsummary;
1558 # Pull out the items fields
1559 my @fields = $marcrecord->field($itemtag);
1560 my $marcflavor = C4::Context->preference("marcflavour");
1561 # adding linked items that belong to host records
1562 my $analyticsfield = '773';
1563 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1564 $analyticsfield = '773';
1565 } elsif ($marcflavor eq 'UNIMARC') {
1566 $analyticsfield = '461';
1568 foreach my $hostfield ( $marcrecord->field($analyticsfield)) {
1569 my $hostbiblionumber = $hostfield->subfield("0");
1570 my $linkeditemnumber = $hostfield->subfield("9");
1571 if(!$hostbiblionumber eq undef){
1572 my $hostbiblio = GetMarcBiblio($hostbiblionumber, 1);
1573 my ($itemfield, undef) = GetMarcFromKohaField( 'items.itemnumber', GetFrameworkCode($hostbiblionumber) );
1574 if(!$hostbiblio eq undef){
1575 my @hostitems = $hostbiblio->field($itemfield);
1576 foreach my $hostitem (@hostitems){
1577 if ($hostitem->subfield("9") eq $linkeditemnumber){
1578 my $linkeditem =$hostitem;
1579 # append linked items if they exist
1580 if (!$linkeditem eq undef){
1581 push (@fields, $linkeditem);}
1588 # Setting item statuses for display
1589 my @available_items_loop;
1590 my @onloan_items_loop;
1591 my @other_items_loop;
1593 my $available_items;
1597 my $ordered_count = 0;
1598 my $available_count = 0;
1599 my $onloan_count = 0;
1600 my $longoverdue_count = 0;
1601 my $other_count = 0;
1602 my $wthdrawn_count = 0;
1603 my $itemlost_count = 0;
1604 my $hideatopac_count = 0;
1605 my $itembinding_count = 0;
1606 my $itemdamaged_count = 0;
1607 my $item_in_transit_count = 0;
1608 my $can_place_holds = 0;
1609 my $item_onhold_count = 0;
1610 my $items_count = scalar(@fields);
1611 my $maxitems_pref = C4::Context->preference('maxItemsinSearchResults');
1612 my $maxitems = $maxitems_pref ? $maxitems_pref - 1 : 1;
1614 # loop through every item
1616 foreach my $field (@fields) {
1619 # populate the items hash
1620 foreach my $code ( keys %subfieldstosearch ) {
1621 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1623 $item->{description} = $itemtypes{ $item->{itype} }{description};
1627 my @hi = GetHiddenItemnumbers($item);
1628 $item->{'hideatopac'} = @hi;
1629 push @hiddenitems, @hi;
1632 my $hbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'homebranch' : 'holdingbranch';
1633 my $otherbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1635 # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1636 if ($item->{$hbranch}) {
1637 $item->{'branchname'} = $branches{$item->{$hbranch}};
1639 elsif ($item->{$otherbranch}) { # Last resort
1640 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1643 my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
1644 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1645 my $userenv = C4::Context->userenv;
1646 if ( $item->{onloan} && !(C4::Members::GetHideLostItemsPreference($userenv->{'number'}) && $item->{itemlost}) ) {
1648 my $key = $prefix . $item->{onloan} . $item->{barcode};
1649 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
1650 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
1651 $onloan_items->{$key}->{branchname} = $item->{branchname};
1652 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1653 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1654 $onloan_items->{$key}->{description} = $item->{description};
1655 $onloan_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1656 # if something's checked out and lost, mark it as 'long overdue'
1657 if ( $item->{itemlost} ) {
1658 $onloan_items->{$prefix}->{longoverdue}++;
1659 $longoverdue_count++;
1660 } else { # can place holds as long as item isn't lost
1661 $can_place_holds = 1;
1665 # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1669 if ( $item->{notforloan} == -1 ) {
1673 # is item in transit?
1674 my $transfertwhen = '';
1675 my ($transfertfrom, $transfertto);
1677 # is item on the reserve shelf?
1678 my $reservestatus = '';
1681 unless ($item->{wthdrawn}
1682 || $item->{itemlost}
1684 || $item->{notforloan}
1685 || $items_count > 20) {
1687 # A couple heuristics to limit how many times
1688 # we query the database for item transfer information, sacrificing
1689 # accuracy in some cases for speed;
1691 # 1. don't query if item has one of the other statuses
1692 # 2. don't check transit status if the bib has
1693 # more than 20 items
1695 # FIXME: to avoid having the query the database like this, and to make
1696 # the in transit status count as unavailable for search limiting,
1697 # should map transit status to record indexed in Zebra.
1699 ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
1700 ($reservestatus, $reserveitem, undef) = C4::Reserves::CheckReserves($item->{itemnumber});
1703 # item is withdrawn, lost, damaged, not for loan, reserved or in transit
1704 if ( $item->{wthdrawn}
1705 || $item->{itemlost}
1707 || $item->{notforloan} > 0
1708 || $item->{hideatopac}
1709 || $reservestatus eq 'Waiting'
1710 || ($transfertwhen ne ''))
1712 $wthdrawn_count++ if $item->{wthdrawn};
1713 $itemlost_count++ if $item->{itemlost};
1714 $itemdamaged_count++ if $item->{damaged};
1715 $hideatopac_count++ if $item->{hideatopac};
1716 $item_in_transit_count++ if $transfertwhen ne '';
1717 $item_onhold_count++ if $reservestatus eq 'Waiting';
1718 $item->{status} = $item->{wthdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
1720 # can place hold on item ?
1721 if ((!$item->{damaged} || C4::Context->preference('AllowHoldsOnDamagedItems'))
1722 && !$item->{itemlost}
1723 && !$item->{withdrawn}
1725 $can_place_holds = 1;
1730 my $key = $prefix . $item->{status};
1731 foreach (qw(wthdrawn itemlost damaged branchname itemcallnumber hideatopac)) {
1732 $other_items->{$key}->{$_} = $item->{$_};
1734 $other_items->{$key}->{intransit} = ( $transfertwhen ne '' ) ? 1 : 0;
1735 $other_items->{$key}->{onhold} = ($reservestatus) ? 1 : 0;
1736 $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value;
1737 $other_items->{$key}->{count}++ if $item->{$hbranch};
1738 $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1739 $other_items->{$key}->{description} = $item->{description};
1740 $other_items->{$key}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1744 $can_place_holds = 1;
1746 $available_items->{$prefix}->{count}++ if $item->{$hbranch};
1747 foreach (qw(branchname itemcallnumber hideatopac description)) {
1748 $available_items->{$prefix}->{$_} = $item->{$_};
1750 $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
1751 $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( $search_context, $itemtypes{ $item->{itype} }->{imageurl} );
1754 } # notforloan, item level and biblioitem level
1755 if ($items_count > 0) {
1756 next if $is_opac && $hideatopac_count >= $items_count;
1757 next if $hidelostitems && $itemlost_count >= $items_count;
1759 my ( $availableitemscount, $onloanitemscount, $otheritemscount );
1760 for my $key ( sort keys %$onloan_items ) {
1761 (++$onloanitemscount > $maxitems) and last;
1762 push @onloan_items_loop, $onloan_items->{$key};
1764 for my $key ( sort keys %$other_items ) {
1765 (++$otheritemscount > $maxitems) and last;
1766 push @other_items_loop, $other_items->{$key};
1768 for my $key ( sort keys %$available_items ) {
1769 (++$availableitemscount > $maxitems) and last;
1770 push @available_items_loop, $available_items->{$key}
1773 # XSLT processing of some stuff
1775 SetUTF8Flag($marcrecord);
1776 $debug && warn $marcrecord->as_formatted;
1777 my $interface = $search_context eq 'opac' ? 'OPAC' : '';
1778 if (!$scan && C4::Context->preference($interface . "XSLTResultsDisplay")) {
1779 $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display($oldbiblio->{biblionumber}, $marcrecord, $interface."XSLTResultsDisplay", 1, \@hiddenitems);
1780 # the last parameter tells Koha to clean up the problematic ampersand entities that Zebra outputs
1783 # if biblio level itypes are used and itemtype is notforloan, it can't be reserved either
1784 if (!C4::Context->preference("item-level_itypes")) {
1785 if ($itemtypes{ $oldbiblio->{itemtype} }->{notforloan}) {
1786 $can_place_holds = 0;
1789 $oldbiblio->{norequests} = 1 unless $can_place_holds;
1790 $oldbiblio->{itemsplural} = 1 if $items_count > 1;
1791 $oldbiblio->{items_count} = $items_count;
1792 $oldbiblio->{available_items_loop} = \@available_items_loop;
1793 $oldbiblio->{onloan_items_loop} = \@onloan_items_loop;
1794 $oldbiblio->{other_items_loop} = \@other_items_loop;
1795 $oldbiblio->{availablecount} = $available_count;
1796 $oldbiblio->{availableplural} = 1 if $available_count > 1;
1797 $oldbiblio->{onloancount} = $onloan_count;
1798 $oldbiblio->{onloanplural} = 1 if $onloan_count > 1;
1799 $oldbiblio->{othercount} = $other_count;
1800 $oldbiblio->{otherplural} = 1 if $other_count > 1;
1801 $oldbiblio->{wthdrawncount} = $wthdrawn_count;
1802 $oldbiblio->{itemlostcount} = $itemlost_count;
1803 $oldbiblio->{damagedcount} = $itemdamaged_count;
1804 $oldbiblio->{intransitcount} = $item_in_transit_count;
1805 $oldbiblio->{onholdcount} = $item_onhold_count;
1806 $oldbiblio->{orderedcount} = $ordered_count;
1807 # deleting - in isbn to enable amazon content
1808 $oldbiblio->{isbn} =~ s/-//g;
1810 if (C4::Context->preference("AlternateHoldingsField") && $items_count == 0) {
1811 my $fieldspec = C4::Context->preference("AlternateHoldingsField");
1812 my $subfields = substr $fieldspec, 3;
1813 my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
1814 my @alternateholdingsinfo = ();
1815 my @holdingsfields = $marcrecord->field(substr $fieldspec, 0, 3);
1816 my $alternateholdingscount = 0;
1818 for my $field (@holdingsfields) {
1819 my %holding = ( holding => '' );
1820 my $havesubfield = 0;
1821 for my $subfield ($field->subfields()) {
1822 if ((index $subfields, $$subfield[0]) >= 0) {
1823 $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
1824 $holding{'holding'} .= $$subfield[1];
1828 if ($havesubfield) {
1829 push(@alternateholdingsinfo, \%holding);
1830 $alternateholdingscount++;
1834 $oldbiblio->{'ALTERNATEHOLDINGS'} = \@alternateholdingsinfo;
1835 $oldbiblio->{'alternateholdings_count'} = $alternateholdingscount;
1838 push( @newresults, $oldbiblio );
1844 =head2 SearchAcquisitions
1845 Search for acquisitions
1848 sub SearchAcquisitions{
1849 my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
1851 my $dbh=C4::Context->dbh;
1852 # Variable initialization
1856 LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
1857 LEFT JOIN items ON items.biblionumber=biblio.biblionumber
1858 WHERE dateaccessioned BETWEEN ? AND ?
1861 my (@params,@loopcriteria);
1863 push @params, $datebegin->output("iso");
1864 push @params, $dateend->output("iso");
1866 if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
1867 if(C4::Context->preference("item-level_itypes")){
1868 $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
1870 $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
1872 push @params, @$itemtypes;
1875 if ($criteria =~/itemtype/){
1876 if(C4::Context->preference("item-level_itypes")){
1877 $str .= "AND items.itype=? ";
1879 $str .= "AND biblioitems.itemtype=? ";
1882 if(scalar(@$itemtypes) == 0){
1883 my $itypes = GetItemTypes();
1884 for my $key (keys %$itypes){
1885 push @$itemtypes, $key;
1889 @loopcriteria= @$itemtypes;
1890 }elsif ($criteria=~/itemcallnumber/){
1891 $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
1892 OR items.itemcallnumber is NULL
1893 OR items.itemcallnumber = '')";
1895 @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
1897 $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
1898 @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
1901 if ($orderby =~ /date_desc/){
1902 $str.=" ORDER BY dateaccessioned DESC";
1904 $str.=" ORDER BY title";
1907 my $qdataacquisitions=$dbh->prepare($str);
1909 my @loopacquisitions;
1910 foreach my $value(@loopcriteria){
1911 push @params,$value;
1913 $cell{"title"}=$value;
1914 $cell{"titlecode"}=$value;
1916 eval{$qdataacquisitions->execute(@params);};
1918 if ($@){ warn "recentacquisitions Error :$@";}
1921 while (my $data=$qdataacquisitions->fetchrow_hashref){
1922 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
1924 $cell{"loopdata"}=\@loopdata;
1926 push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
1929 $qdataacquisitions->finish;
1930 return \@loopacquisitions;
1932 #----------------------------------------------------------------------
1934 # Non-Zebra GetRecords#
1935 #----------------------------------------------------------------------
1939 NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1945 $query, $simple_query, $sort_by_ref, $servers_ref,
1946 $results_per_page, $offset, $expanded_facet, $branches,
1949 warn "query =$query" if $DEBUG;
1950 my $result = NZanalyse($query);
1951 warn "results =$result" if $DEBUG;
1953 NZorder( $result, @$sort_by_ref[0], $results_per_page, $offset ),
1959 NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1960 the list is built from an inverted index in the nozebra SQL table
1961 note that title is here only for convenience : the sorting will be very fast when requested on title
1962 if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1967 my ( $string, $server ) = @_;
1968 # warn "---------" if $DEBUG;
1969 warn " NZanalyse" if $DEBUG;
1970 # warn "---------" if $DEBUG;
1972 # $server contains biblioserver or authorities, depending on what we search on.
1973 #warn "querying : $string on $server";
1974 $server = 'biblioserver' unless $server;
1976 # if we have a ", replace the content to discard temporarily any and/or/not inside
1978 if ( $string =~ /"/ ) {
1979 $string =~ s/"(.*?)"/__X__/;
1981 warn "commacontent : $commacontent" if $DEBUG;
1984 # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1985 # then, call again NZanalyse with $left and $right
1986 # (recursive until we find a leaf (=> something without and/or/not)
1987 # delete repeated operator... Would then go in infinite loop
1988 while ( $string =~ s/( and| or| not| AND| OR| NOT)\1/$1/g ) {
1991 #process parenthesis before.
1992 if ( $string =~ /^\s*\((.*)\)(( and | or | not | AND | OR | NOT )(.*))?/ ) {
1995 my $operator = lc($3); # FIXME: and/or/not are operators, not operands
1997 "dealing w/parenthesis before recursive sub call. left :$left operator:$operator right:$right"
1999 my $leftresult = NZanalyse( $left, $server );
2001 my $rightresult = NZanalyse( $right, $server );
2003 # OK, we have the results for right and left part of the query
2004 # depending of operand, intersect, union or exclude both lists
2005 # to get a result list
2006 if ( $operator eq ' and ' ) {
2007 return NZoperatorAND($leftresult,$rightresult);
2009 elsif ( $operator eq ' or ' ) {
2011 # just merge the 2 strings
2012 return $leftresult . $rightresult;
2014 elsif ( $operator eq ' not ' ) {
2015 return NZoperatorNOT($leftresult,$rightresult);
2019 # this error is impossible, because of the regexp that isolate the operand, but just in case...
2023 warn "string :" . $string if $DEBUG;
2027 if ($string =~ /(.*?)( and | or | not | AND | OR | NOT )(.*)/) {
2030 $operator = lc($2); # FIXME: and/or/not are operators, not operands
2032 warn "no parenthesis. left : $left operator: $operator right: $right"
2035 # it's not a leaf, we have a and/or/not
2038 # reintroduce comma content if needed
2039 $right =~ s/__X__/"$commacontent"/ if $commacontent;
2040 $left =~ s/__X__/"$commacontent"/ if $commacontent;
2041 warn "node : $left / $operator / $right\n" if $DEBUG;
2042 my $leftresult = NZanalyse( $left, $server );
2043 my $rightresult = NZanalyse( $right, $server );
2044 warn " leftresult : $leftresult" if $DEBUG;
2045 warn " rightresult : $rightresult" if $DEBUG;
2046 # OK, we have the results for right and left part of the query
2047 # depending of operand, intersect, union or exclude both lists
2048 # to get a result list
2049 if ( $operator eq ' and ' ) {
2050 return NZoperatorAND($leftresult,$rightresult);
2052 elsif ( $operator eq ' or ' ) {
2054 # just merge the 2 strings
2055 return $leftresult . $rightresult;
2057 elsif ( $operator eq ' not ' ) {
2058 return NZoperatorNOT($leftresult,$rightresult);
2062 # this error is impossible, because of the regexp that isolate the operand, but just in case...
2063 die "error : operand unknown : $operator for $string";
2066 # it's a leaf, do the real SQL query and return the result
2069 $string =~ s/__X__/"$commacontent"/ if $commacontent;
2070 $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
2071 #remove trailing blank at the beginning
2073 warn "leaf:$string" if $DEBUG;
2075 # parse the string in in operator/operand/value again
2079 if ($string =~ /(.*)(>=|<=)(.*)/) {
2086 # warn "handling leaf... left:$left operator:$operator right:$right"
2088 unless ($operator) {
2089 if ($string =~ /(.*)(>|<|=)(.*)/) {
2094 "handling unless (operator)... left:$left operator:$operator right:$right"
2102 # strip adv, zebra keywords, currently not handled in nozebra: wrdl, ext, phr...
2105 # automatic replace for short operators
2106 $left = 'title' if $left =~ '^ti$';
2107 $left = 'author' if $left =~ '^au$';
2108 $left = 'publisher' if $left =~ '^pb$';
2109 $left = 'subject' if $left =~ '^su$';
2110 $left = 'koha-Auth-Number' if $left =~ '^an$';
2111 $left = 'keyword' if $left =~ '^kw$';
2112 $left = 'itemtype' if $left =~ '^mc$'; # Fix for Bug 2599 - Search limits not working for NoZebra
2113 warn "handling leaf... left:$left operator:$operator right:$right" if $DEBUG;
2114 my $dbh = C4::Context->dbh;
2115 if ( $operator && $left ne 'keyword' ) {
2116 #do a specific search
2117 $operator = 'LIKE' if $operator eq '=' and $right =~ /%/;
2118 my $sth = $dbh->prepare(
2119 "SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?"
2121 warn "$left / $operator / $right\n" if $DEBUG;
2123 # split each word, query the DB and build the biblionumbers result
2124 #sanitizing leftpart
2125 $left =~ s/^\s+|\s+$//;
2126 foreach ( split / /, $right ) {
2128 $_ =~ s/^\s+|\s+$//;
2130 warn "EXECUTE : $server, $left, $_" if $DEBUG;
2131 $sth->execute( $server, $left, $_ )
2132 or warn "execute failed: $!";
2133 while ( my ( $line, $value ) = $sth->fetchrow ) {
2135 # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
2136 # otherwise, fill the result
2137 $biblionumbers .= $line
2138 unless ( $right =~ /^\d+$/ && $value =~ /\D/ );
2139 warn "result : $value "
2140 . ( $right =~ /\d/ ) . "=="
2141 . ( $value =~ /\D/?$line:"" ) if $DEBUG; #= $line";
2144 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
2146 warn "NZAND" if $DEBUG;
2147 $results = NZoperatorAND($biblionumbers,$results);
2149 $results = $biblionumbers;
2154 #do a complete search (all indexes), if index='kw' do complete search too.
2155 my $sth = $dbh->prepare(
2156 "SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?"
2159 # split each word, query the DB and build the biblionumbers result
2160 foreach ( split / /, $string ) {
2161 next if C4::Context->stopwords->{ uc($_) }; # skip if stopword
2162 warn "search on all indexes on $_" if $DEBUG;
2165 $sth->execute( $server, $_ );
2166 while ( my $line = $sth->fetchrow ) {
2167 $biblionumbers .= $line;
2170 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
2172 $results = NZoperatorAND($biblionumbers,$results);
2175 warn "NEW RES for $_ = $biblionumbers" if $DEBUG;
2176 $results = $biblionumbers;
2180 warn "return : $results for LEAF : $string" if $DEBUG;
2183 warn "---------\nLeave NZanalyse\n---------" if $DEBUG;
2187 my ($rightresult, $leftresult)=@_;
2189 my @leftresult = split /;/, $leftresult;
2190 warn " @leftresult / $rightresult \n" if $DEBUG;
2192 # my @rightresult = split /;/,$leftresult;
2195 # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
2196 # the result is stored twice, to have the same weight for AND than OR.
2197 # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
2198 # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
2199 foreach (@leftresult) {
2202 ( $value, $countvalue ) = ( $1, $2 ) if ($value=~/(.*)-(\d+)$/);
2203 if ( $rightresult =~ /\Q$value\E-(\d+);/ ) {
2204 $countvalue = ( $1 > $countvalue ? $countvalue : $1 );
2206 "$value-$countvalue;$value-$countvalue;";
2209 warn "NZAND DONE : $finalresult \n" if $DEBUG;
2210 return $finalresult;
2214 my ($rightresult, $leftresult)=@_;
2215 return $rightresult.$leftresult;
2219 my ($leftresult, $rightresult)=@_;
2221 my @leftresult = split /;/, $leftresult;
2223 # my @rightresult = split /;/,$leftresult;
2225 foreach (@leftresult) {
2227 $value=$1 if $value=~m/(.*)-\d+$/;
2228 unless ($rightresult =~ "$value-") {
2229 $finalresult .= "$_;";
2232 return $finalresult;
2237 $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
2244 my ( $biblionumbers, $ordering, $results_per_page, $offset ) = @_;
2245 warn "biblionumbers = $biblionumbers and ordering = $ordering\n" if $DEBUG;
2247 # order title asc by default
2248 # $ordering = '1=36 <i' unless $ordering;
2249 $results_per_page = 20 unless $results_per_page;
2250 $offset = 0 unless $offset;
2251 my $dbh = C4::Context->dbh;
2254 # order by POPULARITY
2256 if ( $ordering =~ /popularity/ ) {
2260 # popularity is not in MARC record, it's builded from a specific query
2262 $dbh->prepare("select sum(issues) from items where biblionumber=?");
2263 foreach ( split /;/, $biblionumbers ) {
2264 my ( $biblionumber, $title ) = split /,/, $_;
2265 $result{$biblionumber} = GetMarcBiblio($biblionumber);
2266 $sth->execute($biblionumber);
2267 my $popularity = $sth->fetchrow || 0;
2269 # hint : the key is popularity.title because we can have
2270 # many results with the same popularity. In this case, sub-ordering is done by title
2271 # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
2272 # (un-frequent, I agree, but we won't forget anything that way ;-)
2273 $popularity{ sprintf( "%10d", $popularity ) . $title
2274 . $biblionumber } = $biblionumber;
2277 # sort the hash and return the same structure as GetRecords (Zebra querying)
2280 if ( $ordering eq 'popularity_dsc' ) { # sort popularity DESC
2281 foreach my $key ( sort { $b cmp $a } ( keys %popularity ) ) {
2282 $result_hash->{'RECORDS'}[ $numbers++ ] =
2283 $result{ $popularity{$key} }->as_usmarc();
2286 else { # sort popularity ASC
2287 foreach my $key ( sort ( keys %popularity ) ) {
2288 $result_hash->{'RECORDS'}[ $numbers++ ] =
2289 $result{ $popularity{$key} }->as_usmarc();
2292 my $finalresult = ();
2293 $result_hash->{'hits'} = $numbers;
2294 $finalresult->{'biblioserver'} = $result_hash;
2295 return $finalresult;
2301 elsif ( $ordering =~ /author/ ) {
2303 foreach ( split /;/, $biblionumbers ) {
2304 my ( $biblionumber, $title ) = split /,/, $_;
2305 my $record = GetMarcBiblio($biblionumber);
2307 if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
2308 $author = $record->subfield( '200', 'f' );
2309 $author = $record->subfield( '700', 'a' ) unless $author;
2312 $author = $record->subfield( '100', 'a' );
2315 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2316 # and we don't want to get only 1 result for each of them !!!
2317 $result{ $author . $biblionumber } = $record;
2320 # sort the hash and return the same structure as GetRecords (Zebra querying)
2323 if ( $ordering eq 'author_za' || $ordering eq 'author_dsc' ) { # sort by author desc
2324 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2325 $result_hash->{'RECORDS'}[ $numbers++ ] =
2326 $result{$key}->as_usmarc();
2329 else { # sort by author ASC
2330 foreach my $key ( sort ( keys %result ) ) {
2331 $result_hash->{'RECORDS'}[ $numbers++ ] =
2332 $result{$key}->as_usmarc();
2335 my $finalresult = ();
2336 $result_hash->{'hits'} = $numbers;
2337 $finalresult->{'biblioserver'} = $result_hash;
2338 return $finalresult;
2341 # ORDER BY callnumber
2344 elsif ( $ordering =~ /callnumber/ ) {
2346 foreach ( split /;/, $biblionumbers ) {
2347 my ( $biblionumber, $title ) = split /,/, $_;
2348 my $record = GetMarcBiblio($biblionumber);
2350 my $frameworkcode = GetFrameworkCode($biblionumber);
2351 my ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField( 'items.itemcallnumber', $frameworkcode);
2352 ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField('biblioitems.callnumber', $frameworkcode)
2353 unless $callnumber_tag;
2354 if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
2355 $callnumber = $record->subfield( '200', 'f' );
2357 $callnumber = $record->subfield( '100', 'a' );
2360 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2361 # and we don't want to get only 1 result for each of them !!!
2362 $result{ $callnumber . $biblionumber } = $record;
2365 # sort the hash and return the same structure as GetRecords (Zebra querying)
2368 if ( $ordering eq 'call_number_dsc' ) { # sort by title desc
2369 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2370 $result_hash->{'RECORDS'}[ $numbers++ ] =
2371 $result{$key}->as_usmarc();
2374 else { # sort by title ASC
2375 foreach my $key ( sort { $a cmp $b } ( keys %result ) ) {
2376 $result_hash->{'RECORDS'}[ $numbers++ ] =
2377 $result{$key}->as_usmarc();
2380 my $finalresult = ();
2381 $result_hash->{'hits'} = $numbers;
2382 $finalresult->{'biblioserver'} = $result_hash;
2383 return $finalresult;
2385 elsif ( $ordering =~ /pubdate/ ) { #pub year
2387 foreach ( split /;/, $biblionumbers ) {
2388 my ( $biblionumber, $title ) = split /,/, $_;
2389 my $record = GetMarcBiblio($biblionumber);
2390 my ( $publicationyear_tag, $publicationyear_subfield ) =
2391 GetMarcFromKohaField( 'biblioitems.publicationyear', '' );
2392 my $publicationyear =
2393 $record->subfield( $publicationyear_tag,
2394 $publicationyear_subfield );
2396 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2397 # and we don't want to get only 1 result for each of them !!!
2398 $result{ $publicationyear . $biblionumber } = $record;
2401 # sort the hash and return the same structure as GetRecords (Zebra querying)
2404 if ( $ordering eq 'pubdate_dsc' ) { # sort by pubyear desc
2405 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2406 $result_hash->{'RECORDS'}[ $numbers++ ] =
2407 $result{$key}->as_usmarc();
2410 else { # sort by pub year ASC
2411 foreach my $key ( sort ( keys %result ) ) {
2412 $result_hash->{'RECORDS'}[ $numbers++ ] =
2413 $result{$key}->as_usmarc();
2416 my $finalresult = ();
2417 $result_hash->{'hits'} = $numbers;
2418 $finalresult->{'biblioserver'} = $result_hash;
2419 return $finalresult;
2425 elsif ( $ordering =~ /title/ ) {
2427 # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
2429 foreach ( split /;/, $biblionumbers ) {
2430 my ( $biblionumber, $title ) = split /,/, $_;
2432 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2433 # and we don't want to get only 1 result for each of them !!!
2434 # hint & speed improvement : we can order without reading the record
2435 # so order, and read records only for the requested page !
2436 $result{ $title . $biblionumber } = $biblionumber;
2439 # sort the hash and return the same structure as GetRecords (Zebra querying)
2442 if ( $ordering eq 'title_az' ) { # sort by title desc
2443 foreach my $key ( sort ( keys %result ) ) {
2444 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2447 else { # sort by title ASC
2448 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2449 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2453 # limit the $results_per_page to result size if it's more
2454 $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2456 # for the requested page, replace biblionumber by the complete record
2457 # speed improvement : avoid reading too much things
2459 my $counter = $offset ;
2460 $counter <= $offset + $results_per_page ;
2464 $result_hash->{'RECORDS'}[$counter] =
2465 GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc;
2467 my $finalresult = ();
2468 $result_hash->{'hits'} = $numbers;
2469 $finalresult->{'biblioserver'} = $result_hash;
2470 return $finalresult;
2477 # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
2480 foreach ( split /;/, $biblionumbers ) {
2481 my ( $biblionumber, $title ) = split /,/, $_;
2482 $title =~ /(.*)-(\d)/;
2487 # note that we + the ranking because ranking is calculated on weight of EACH term requested.
2488 # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
2489 # biblio N has ranking = 6
2490 $count_ranking{$biblionumber} += $ranking;
2493 # build the result by "inverting" the count_ranking hash
2494 # 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
2496 foreach ( keys %count_ranking ) {
2497 $result{ sprintf( "%10d", $count_ranking{$_} ) . '-' . $_ } = $_;
2500 # sort the hash and return the same structure as GetRecords (Zebra querying)
2503 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2504 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2507 # limit the $results_per_page to result size if it's more
2508 $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2510 # for the requested page, replace biblionumber by the complete record
2511 # speed improvement : avoid reading too much things
2513 my $counter = $offset ;
2514 $counter <= $offset + $results_per_page ;
2518 $result_hash->{'RECORDS'}[$counter] =
2519 GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc
2520 if $result_hash->{'RECORDS'}[$counter];
2522 my $finalresult = ();
2523 $result_hash->{'hits'} = $numbers;
2524 $finalresult->{'biblioserver'} = $result_hash;
2525 return $finalresult;
2529 =head2 enabled_staff_search_views
2531 %hash = enabled_staff_search_views()
2533 This function returns a hash that contains three flags obtained from the system
2534 preferences, used to determine whether a particular staff search results view
2539 =item C<Output arg:>
2541 * $hash{can_view_MARC} is true only if the MARC view is enabled
2542 * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2543 * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2545 =item C<usage in the script:>
2549 $template->param ( C4::Search::enabled_staff_search_views );
2553 sub enabled_staff_search_views
2556 can_view_MARC => C4::Context->preference('viewMARC'), # 1 if the staff search allows the MARC view
2557 can_view_ISBD => C4::Context->preference('viewISBD'), # 1 if the staff search allows the ISBD view
2558 can_view_labeledMARC => C4::Context->preference('viewLabeledMARC'), # 1 if the staff search allows the Labeled MARC view
2562 sub AddSearchHistory{
2563 my ($borrowernumber,$session,$query_desc,$query_cgi, $total)=@_;
2564 my $dbh = C4::Context->dbh;
2566 # Add the request the user just made
2567 my $sql = "INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time) VALUES(?, ?, ?, ?, ?, NOW())";
2568 my $sth = $dbh->prepare($sql);
2569 $sth->execute($borrowernumber, $session, $query_desc, $query_cgi, $total);
2570 return $dbh->last_insert_id(undef, 'search_history', undef,undef,undef);
2573 sub GetSearchHistory{
2574 my ($borrowernumber,$session)=@_;
2575 my $dbh = C4::Context->dbh;
2577 # Add the request the user just made
2578 my $query = "SELECT FROM search_history WHERE (userid=? OR sessionid=?)";
2579 my $sth = $dbh->prepare($query);
2580 $sth->execute($borrowernumber, $session);
2581 return $sth->fetchall_hashref({});
2584 =head2 z3950_search_args
2586 $arrayref = z3950_search_args($matchpoints)
2588 This function returns an array reference that contains the search parameters to be
2589 passed to the Z39.50 search script (z3950_search.pl). The array elements
2590 are hash refs whose keys are name, value and encvalue, and whose values are the
2591 name of a search parameter, the value of that search parameter and the URL encoded
2592 value of that parameter.
2594 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2596 The search parameter values are obtained from the bibliographic record whose
2597 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2599 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2600 a general purpose search argument. In this case, the returned array contains only
2601 entry: the key is 'title' and the value and encvalue are derived from $matchpoints.
2603 If a search parameter value is undefined or empty, it is not included in the returned
2606 The returned array reference may be passed directly to the template parameters.
2610 =item C<Output arg:>
2612 * $array containing hash refs as described above
2614 =item C<usage in the script:>
2618 $data = Biblio::GetBiblioData($bibno);
2619 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2623 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2627 sub z3950_search_args {
2629 my $isbn = Business::ISBN->new($bibrec);
2631 if (defined $isbn && $isbn->is_valid)
2633 $bibrec = { isbn => $bibrec } if !ref $bibrec;
2636 $bibrec = { title => $bibrec } if !ref $bibrec;
2639 for my $field (qw/ lccn isbn issn title author dewey subject /)
2641 my $encvalue = URI::Escape::uri_escape_utf8($bibrec->{$field});
2642 push @$array, { name=>$field, value=>$bibrec->{$field}, encvalue=>$encvalue } if defined $bibrec->{$field};
2647 =head2 GetDistinctValues($field);
2649 C<$field> is a reference to the fields array
2653 sub GetDistinctValues {
2654 my ($fieldname,$string)=@_;
2655 # returns a reference to a hash of references to branches...
2656 if ($fieldname=~/\./){
2657 my ($table,$column)=split /\./, $fieldname;
2658 my $dbh = C4::Context->dbh;
2659 warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column " if $DEBUG;
2660 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 ");
2662 my $elements=$sth->fetchall_arrayref({});
2667 my @servers=qw<biblioserver authorityserver>;
2668 my (@zconns,@results);
2669 for ( my $i = 0 ; $i < @servers ; $i++ ) {
2670 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2673 ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2676 # The big moment: asynchronously retrieve results from all servers
2678 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
2679 my $ev = $zconns[ $i - 1 ]->last_event();
2680 if ( $ev == ZOOM::Event::ZEND ) {
2681 next unless $results[ $i - 1 ];
2682 my $size = $results[ $i - 1 ]->size();
2684 for (my $j=0;$j<$size;$j++){
2686 @hashscan{qw(value cnt)}=$results[ $i - 1 ]->display_term($j);
2687 push @elements, \%hashscan;
2697 END { } # module clean-up code here (global destructor)
2704 Koha Development Team <http://koha-community.org/>