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
22 use C4::Biblio; # GetMarcFromKohaField, GetBiblioData
23 use C4::Koha; # getFacets
25 use C4::Search::PazPar2;
27 use C4::Dates qw(format_date);
34 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG);
36 # set the version for version checking
39 $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
44 C4::Search - Functions for searching the Koha catalog.
48 See opac/opac-search.pl or catalogue/search.pl for example of usage
52 This module provides searching functions for Koha's bibliographic databases
70 #FIXME: i had to add BiblioAddAuthorities here because in Biblios.pm it caused circular dependencies (C4::Search uses C4::Biblio, and BiblioAddAuthorities uses SimpleSearch from C4::Search)
72 # make all your functions, whether exported or not;
76 ($biblionumber,$biblionumber,$title) = FindDuplicate($record);
78 This function attempts to find duplicate records using a hard-coded, fairly simplistic algorithm
84 my $dbh = C4::Context->dbh;
85 my $result = TransformMarcToKoha( $dbh, $record, '' );
90 my ( $biblionumber, $title );
92 # search duplicate on ISBN, easy and fast..
94 if ( $result->{isbn} ) {
95 $result->{isbn} =~ s/\(.*$//;
96 $result->{isbn} =~ s/\s+$//;
97 $query = "isbn=$result->{isbn}";
100 $result->{title} =~ s /\\//g;
101 $result->{title} =~ s /\"//g;
102 $result->{title} =~ s /\(//g;
103 $result->{title} =~ s /\)//g;
105 # FIXME: instead of removing operators, could just do
106 # quotes around the value
107 $result->{title} =~ s/(and|or|not)//g;
108 $query = "ti,ext=$result->{title}";
109 $query .= " and itemtype=$result->{itemtype}"
110 if ( $result->{itemtype} );
111 if ( $result->{author} ) {
112 $result->{author} =~ s /\\//g;
113 $result->{author} =~ s /\"//g;
114 $result->{author} =~ s /\(//g;
115 $result->{author} =~ s /\)//g;
117 # remove valid operators
118 $result->{author} =~ s/(and|or|not)//g;
119 $query .= " and au,ext=$result->{author}";
123 # FIXME: add error handling
124 my ( $error, $searchresults ) = SimpleSearch($query); # FIXME :: hardcoded !
126 foreach my $possible_duplicate_record (@$searchresults) {
128 MARC::Record->new_from_usmarc($possible_duplicate_record);
129 my $result = TransformMarcToKoha( $dbh, $marcrecord, '' );
131 # FIXME :: why 2 $biblionumber ?
133 push @results, $result->{'biblionumber'};
134 push @results, $result->{'title'};
142 ( $error, $results, $total_hits ) = SimpleSearch( $query, $offset, $max_results, [@servers] );
144 This function provides a simple search API on the bibliographic catalog
150 * $query can be a simple keyword or a complete CCL query
151 * @servers is optional. Defaults to biblioserver as found in koha-conf.xml
152 * $offset - If present, represents the number of records at the beggining to omit. Defaults to 0
153 * $max_results - if present, determines the maximum number of records to fetch. undef is All. defaults to undef.
158 * $error is a empty unless an error is detected
159 * \@results is an array of records.
160 * $total_hits is the number of hits that would have been returned with no limit
162 =item C<usage in the script:>
166 my ( $error, $marcresults, $total_hits ) = SimpleSearch($query);
168 if (defined $error) {
169 $template->param(query_error => $error);
170 warn "error: ".$error;
171 output_html_with_http_headers $input, $cookie, $template->output;
175 my $hits = scalar @$marcresults;
178 for my $i (0..$hits) {
180 my $marcrecord = MARC::File::USMARC::decode($marcresults->[$i]);
181 my $biblio = TransformMarcToKoha(C4::Context->dbh,$marcrecord,'');
183 #build the hash for the template.
184 $resultsloop{title} = $biblio->{'title'};
185 $resultsloop{subtitle} = $biblio->{'subtitle'};
186 $resultsloop{biblionumber} = $biblio->{'biblionumber'};
187 $resultsloop{author} = $biblio->{'author'};
188 $resultsloop{publishercode} = $biblio->{'publishercode'};
189 $resultsloop{publicationyear} = $biblio->{'publicationyear'};
191 push @results, \%resultsloop;
194 $template->param(result=>\@results);
199 my ( $query, $offset, $max_results, $servers ) = @_;
201 if ( C4::Context->preference('NoZebra') ) {
202 my $result = NZorder( NZanalyse($query) )->{'biblioserver'};
205 && $result->{hits} > 0 ? $result->{'RECORDS'} : [] );
206 return ( undef, $search_result, scalar($result->{hits}) );
209 # FIXME hardcoded value. See catalog/search.pl & opac-search.pl too.
210 my @servers = defined ( $servers ) ? @$servers : ( "biblioserver" );
216 return ( "No query entered", undef, undef ) unless $query;
218 # Initialize & Search Zebra
219 for ( my $i = 0 ; $i < @servers ; $i++ ) {
221 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
222 $zoom_queries[$i] = new ZOOM::Query::CCL2RPN( $query, $zconns[$i]);
223 $tmpresults[$i] = $zconns[$i]->search( $zoom_queries[$i] );
227 $zconns[$i]->errmsg() . " ("
228 . $zconns[$i]->errcode() . ") "
229 . $zconns[$i]->addinfo() . " "
230 . $zconns[$i]->diagset();
232 return ( $error, undef, undef ) if $zconns[$i]->errcode();
236 # caught a ZOOM::Exception
240 . $@->addinfo() . " "
243 return ( $error, undef, undef );
246 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
247 my $event = $zconns[ $i - 1 ]->last_event();
248 if ( $event == ZOOM::Event::ZEND ) {
250 my $first_record = defined( $offset ) ? $offset+1 : 1;
251 my $hits = $tmpresults[ $i - 1 ]->size();
252 $total_hits += $hits;
253 my $last_record = $hits;
254 if ( defined $max_results && $offset + $max_results < $hits ) {
255 $last_record = $offset + $max_results;
258 for my $j ( $first_record..$last_record ) {
259 my $record = $tmpresults[ $i - 1 ]->record( $j-1 )->raw(); # 0 indexed
260 push @results, $record;
265 foreach my $result (@tmpresults) {
268 foreach my $zoom_query (@zoom_queries) {
269 $zoom_query->destroy();
272 return ( undef, \@results, $total_hits );
278 ( undef, $results_hashref, \@facets_loop ) = getRecords (
280 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
281 $results_per_page, $offset, $expanded_facet, $branches,
285 The all singing, all dancing, multi-server, asynchronous, scanning,
286 searching, record nabbing, facet-building
288 See verbse embedded documentation.
294 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
295 $results_per_page, $offset, $expanded_facet, $branches,
299 my @servers = @$servers_ref;
300 my @sort_by = @$sort_by_ref;
302 # Initialize variables for the ZOOM connection and results object
306 my $results_hashref = ();
308 # Initialize variables for the faceted results objects
309 my $facets_counter = ();
310 my $facets_info = ();
311 my $facets = getFacets();
313 my @facets_loop; # stores the ref to array of hashes for template facets loop
315 ### LOOP THROUGH THE SERVERS
316 for ( my $i = 0 ; $i < @servers ; $i++ ) {
317 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
319 # perform the search, create the results objects
320 # if this is a local search, use the $koha-query, if it's a federated one, use the federated-query
321 my $query_to_use = ($servers[$i] =~ /biblioserver/) ? $koha_query : $simple_query;
323 #$query_to_use = $simple_query if $scan;
324 warn $simple_query if ( $scan and $DEBUG );
326 # Check if we've got a query_type defined, if so, use it
329 if ($query_type =~ /^ccl/) {
330 $query_to_use =~ s/\:/\=/g; # change : to = last minute (FIXME)
331 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
332 } elsif ($query_type =~ /^cql/) {
333 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CQL($query_to_use, $zconns[$i]));
334 } elsif ($query_type =~ /^pqf/) {
335 $results[$i] = $zconns[$i]->search(new ZOOM::Query::PQF($query_to_use, $zconns[$i]));
337 warn "Unknown query_type '$query_type'. Results undetermined.";
340 $results[$i] = $zconns[$i]->scan( new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
342 $results[$i] = $zconns[$i]->search(new ZOOM::Query::CCL2RPN($query_to_use, $zconns[$i]));
346 warn "WARNING: query problem with $query_to_use " . $@;
349 # Concatenate the sort_by limits and pass them to the results object
350 # Note: sort will override rank
352 foreach my $sort (@sort_by) {
353 if ( $sort eq "author_az" ) {
354 $sort_by .= "1=1003 <i ";
356 elsif ( $sort eq "author_za" ) {
357 $sort_by .= "1=1003 >i ";
359 elsif ( $sort eq "popularity_asc" ) {
360 $sort_by .= "1=9003 <i ";
362 elsif ( $sort eq "popularity_dsc" ) {
363 $sort_by .= "1=9003 >i ";
365 elsif ( $sort eq "call_number_asc" ) {
366 $sort_by .= "1=20 <i ";
368 elsif ( $sort eq "call_number_dsc" ) {
369 $sort_by .= "1=20 >i ";
371 elsif ( $sort eq "pubdate_asc" ) {
372 $sort_by .= "1=31 <i ";
374 elsif ( $sort eq "pubdate_dsc" ) {
375 $sort_by .= "1=31 >i ";
377 elsif ( $sort eq "acqdate_asc" ) {
378 $sort_by .= "1=32 <i ";
380 elsif ( $sort eq "acqdate_dsc" ) {
381 $sort_by .= "1=32 >i ";
383 elsif ( $sort eq "title_az" ) {
384 $sort_by .= "1=4 <i ";
386 elsif ( $sort eq "title_za" ) {
387 $sort_by .= "1=4 >i ";
390 warn "Ignoring unrecognized sort '$sort' requested" if $sort_by;
394 if ( $results[$i]->sort( "yaz", $sort_by ) < 0 ) {
395 warn "WARNING sort $sort_by failed";
398 } # finished looping through servers
400 # The big moment: asynchronously retrieve results from all servers
401 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
402 my $ev = $zconns[ $i - 1 ]->last_event();
403 if ( $ev == ZOOM::Event::ZEND ) {
404 next unless $results[ $i - 1 ];
405 my $size = $results[ $i - 1 ]->size();
409 # loop through the results
410 $results_hash->{'hits'} = $size;
412 if ( $offset + $results_per_page <= $size ) {
413 $times = $offset + $results_per_page;
418 for ( my $j = $offset ; $j < $times ; $j++ ) {
423 ## Check if it's an index scan
425 my ( $term, $occ ) = $results[ $i - 1 ]->term($j);
427 # here we create a minimal MARC record and hand it off to the
428 # template just like a normal result ... perhaps not ideal, but
430 my $tmprecord = MARC::Record->new();
431 $tmprecord->encoding('UTF-8');
435 # the minimal record in author/title (depending on MARC flavour)
436 if (C4::Context->preference("marcflavour") eq "UNIMARC") {
437 $tmptitle = MARC::Field->new('200',' ',' ', a => $term, f => $occ);
438 $tmprecord->append_fields($tmptitle);
440 $tmptitle = MARC::Field->new('245',' ',' ', a => $term,);
441 $tmpauthor = MARC::Field->new('100',' ',' ', a => $occ,);
442 $tmprecord->append_fields($tmptitle);
443 $tmprecord->append_fields($tmpauthor);
445 $results_hash->{'RECORDS'}[$j] = $tmprecord->as_usmarc();
450 $record = $results[ $i - 1 ]->record($j)->raw();
452 # warn "RECORD $j:".$record;
453 $results_hash->{'RECORDS'}[$j] = $record;
455 # Fill the facets while we're looping, but only for the biblioserver
456 $facet_record = MARC::Record->new_from_usmarc($record)
457 if $servers[ $i - 1 ] =~ /biblioserver/;
459 #warn $servers[$i-1]."\n".$record; #.$facet_record->title();
461 for ( my $k = 0 ; $k <= @$facets ; $k++ ) {
462 ($facets->[$k]) or next;
463 my @fields = map {$facet_record->field($_)} @{$facets->[$k]->{'tags'}} ;
464 for my $field (@fields) {
465 my @subfields = $field->subfields();
466 for my $subfield (@subfields) {
467 my ( $code, $data ) = @$subfield;
468 ($code eq $facets->[$k]->{'subfield'}) or next;
469 $facets_counter->{ $facets->[$k]->{'link_value'} }->{$data}++;
472 $facets_info->{ $facets->[$k]->{'link_value'} }->{'label_value'} =
473 $facets->[$k]->{'label_value'};
474 $facets_info->{ $facets->[$k]->{'link_value'} }->{'expanded'} =
475 $facets->[$k]->{'expanded'};
480 $results_hashref->{ $servers[ $i - 1 ] } = $results_hash;
483 # warn "connection ", $i-1, ": $size hits";
484 # warn $results[$i-1]->record(0)->render() if $size > 0;
487 if ( $servers[ $i - 1 ] =~ /biblioserver/ ) {
489 sort { $facets_counter->{$b} <=> $facets_counter->{$a} }
490 keys %$facets_counter )
493 my $number_of_facets;
494 my @this_facets_array;
497 $facets_counter->{$link_value}->{$b}
498 <=> $facets_counter->{$link_value}->{$a}
499 } keys %{ $facets_counter->{$link_value} }
503 if ( ( $number_of_facets < 6 )
504 || ( $expanded_facet eq $link_value )
505 || ( $facets_info->{$link_value}->{'expanded'} ) )
508 # Sanitize the link value ), ( will cause errors with CCL,
509 my $facet_link_value = $one_facet;
510 $facet_link_value =~ s/(\(|\))/ /g;
512 # fix the length that will display in the label,
513 my $facet_label_value = $one_facet;
515 substr( $one_facet, 0, 20 ) . "..."
516 unless length($facet_label_value) <= 20;
518 # if it's a branch, label by the name, not the code,
519 if ( $link_value =~ /branch/ ) {
520 if (defined $branches
521 && ref($branches) eq "HASH"
522 && defined $branches->{$one_facet}
523 && ref ($branches->{$one_facet}) eq "HASH")
526 $branches->{$one_facet}->{'branchname'};
529 $facet_label_value = "*";
533 # but we're down with the whole label being in the link's title.
534 push @this_facets_array, {
535 facet_count => $facets_counter->{$link_value}->{$one_facet},
536 facet_label_value => $facet_label_value,
537 facet_title_value => $one_facet,
538 facet_link_value => $facet_link_value,
539 type_link_value => $link_value,
544 # handle expanded option
545 unless ( $facets_info->{$link_value}->{'expanded'} ) {
547 if ( ( $number_of_facets > 6 )
548 && ( $expanded_facet ne $link_value ) );
551 type_link_value => $link_value,
552 type_id => $link_value . "_id",
553 "type_label_" . $facets_info->{$link_value}->{'label_value'} => 1,
554 facets => \@this_facets_array,
555 expandable => $expandable,
556 expand => $link_value,
557 } unless ( ($facets_info->{$link_value}->{'label_value'} =~ /Libraries/) and (C4::Context->preference('singleBranchMode')) );
562 return ( undef, $results_hashref, \@facets_loop );
567 $koha_query, $simple_query, $sort_by_ref, $servers_ref,
568 $results_per_page, $offset, $expanded_facet, $branches,
572 my $paz = C4::Search::PazPar2->new(C4::Context->config('pazpar2url'));
574 $paz->search($simple_query);
575 sleep 1; # FIXME: WHY?
578 my $results_hashref = {};
579 my $stats = XMLin($paz->stat);
580 my $results = XMLin($paz->show($offset, $results_per_page, 'work-title:1'), forcearray => 1);
582 # for a grouped search result, the number of hits
583 # is the number of groups returned; 'bib_hits' will have
584 # the total number of bibs.
585 $results_hashref->{'biblioserver'}->{'hits'} = $results->{'merged'}->[0];
586 $results_hashref->{'biblioserver'}->{'bib_hits'} = $stats->{'hits'};
588 HIT: foreach my $hit (@{ $results->{'hit'} }) {
589 my $recid = $hit->{recid}->[0];
591 my $work_title = $hit->{'md-work-title'}->[0];
593 if (exists $hit->{'md-work-author'}) {
594 $work_author = $hit->{'md-work-author'}->[0];
596 my $group_label = (defined $work_author) ? "$work_title / $work_author" : $work_title;
598 my $result_group = {};
599 $result_group->{'group_label'} = $group_label;
600 $result_group->{'group_merge_key'} = $recid;
603 if (exists $hit->{count}) {
604 $count = $hit->{count}->[0];
606 $result_group->{'group_count'} = $count;
608 for (my $i = 0; $i < $count; $i++) {
609 # FIXME -- may need to worry about diacritics here
610 my $rec = $paz->record($recid, $i);
611 push @{ $result_group->{'RECORDS'} }, $rec;
614 push @{ $results_hashref->{'biblioserver'}->{'GROUPS'} }, $result_group;
617 # pass through facets
618 my $termlist_xml = $paz->termlist('author,subject');
619 my $terms = XMLin($termlist_xml, forcearray => 1);
620 my @facets_loop = ();
621 #die Dumper($results);
622 # foreach my $list (sort keys %{ $terms->{'list'} }) {
624 # foreach my $facet (sort @{ $terms->{'list'}->{$list}->{'term'} } ) {
626 # facet_label_value => $facet->{'name'}->[0],
629 # push @facets_loop, ( {
630 # type_label => $list,
631 # facets => \@facets,
635 return ( undef, $results_hashref, \@facets_loop );
639 sub _remove_stopwords {
640 my ( $operand, $index ) = @_;
641 my @stopwords_removed;
643 # phrase and exact-qualified indexes shouldn't have stopwords removed
644 if ( $index !~ m/phr|ext/ ) {
646 # remove stopwords from operand : parse all stopwords & remove them (case insensitive)
647 # we use IsAlpha unicode definition, to deal correctly with diacritics.
648 # otherwise, a French word like "leçon" woudl be split into "le" "çon", "le"
649 # is a stopword, we'd get "çon" and wouldn't find anything...
651 foreach ( keys %{ C4::Context->stopwords } ) {
652 next if ( $_ =~ /(and|or|not)/ ); # don't remove operators
653 $debug && warn "$_ Dump($operand)";
654 if ( my ($matched) = ($operand =~
655 /([^\X\p{isAlnum}]\Q$_\E[^\X\p{isAlnum}]|[^\X\p{isAlnum}]\Q$_\E$|^\Q$_\E[^\X\p{isAlnum}])/gi))
657 $operand =~ s/\Q$matched\E/ /gi;
658 push @stopwords_removed, $_;
662 return ( $operand, \@stopwords_removed );
666 sub _detect_truncation {
667 my ( $operand, $index ) = @_;
668 my ( @nontruncated, @righttruncated, @lefttruncated, @rightlefttruncated,
671 my @wordlist = split( /\s/, $operand );
672 foreach my $word (@wordlist) {
673 if ( $word =~ s/^\*([^\*]+)\*$/$1/ ) {
674 push @rightlefttruncated, $word;
676 elsif ( $word =~ s/^\*([^\*]+)$/$1/ ) {
677 push @lefttruncated, $word;
679 elsif ( $word =~ s/^([^\*]+)\*$/$1/ ) {
680 push @righttruncated, $word;
682 elsif ( index( $word, "*" ) < 0 ) {
683 push @nontruncated, $word;
686 push @regexpr, $word;
690 \@nontruncated, \@righttruncated, \@lefttruncated,
691 \@rightlefttruncated, \@regexpr
696 sub _build_stemmed_operand {
697 my ($operand,$lang) = @_;
698 require Lingua::Stem::Snowball ;
701 # If operand contains a digit, it is almost certainly an identifier, and should
702 # not be stemmed. This is particularly relevant for ISBNs and ISSNs, which
703 # can contain the letter "X" - for example, _build_stemmend_operand would reduce
704 # "014100018X" to "x ", which for a MARC21 database would bring up irrelevant
705 # results (e.g., "23 x 29 cm." from the 300$c). Bug 2098.
706 return $operand if $operand =~ /\d/;
708 # FIXME: the locale should be set based on the user's language and/or search choice
710 my $stemmer = Lingua::Stem::Snowball->new( lang => $lang,
711 encoding => "UTF-8" );
713 my @words = split( / /, $operand );
714 my @stems = $stemmer->stem(\@words);
715 for my $stem (@stems) {
716 $stemmed_operand .= "$stem";
717 $stemmed_operand .= "?"
718 unless ( $stem =~ /(and$|or$|not$)/ ) || ( length($stem) < 3 );
719 $stemmed_operand .= " ";
721 warn "STEMMED OPERAND: $stemmed_operand" if $DEBUG;
722 return $stemmed_operand;
726 sub _build_weighted_query {
728 # FIELD WEIGHTING - This is largely experimental stuff. What I'm committing works
729 # pretty well but could work much better if we had a smarter query parser
730 my ( $operand, $stemmed_operand, $index ) = @_;
731 my $stemming = C4::Context->preference("QueryStemming") || 0;
732 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
733 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
735 my $weighted_query .= "(rk=("; # Specifies that we're applying rank
737 # Keyword, or, no index specified
738 if ( ( $index eq 'kw' ) || ( !$index ) ) {
740 "Title-cover,ext,r1=\"$operand\""; # exact title-cover
741 $weighted_query .= " or ti,ext,r2=\"$operand\""; # exact title
742 $weighted_query .= " or ti,phr,r3=\"$operand\""; # phrase title
743 #$weighted_query .= " or any,ext,r4=$operand"; # exact any
744 #$weighted_query .=" or kw,wrdl,r5=\"$operand\""; # word list any
745 $weighted_query .= " or wrdl,fuzzy,r8=\"$operand\""
746 if $fuzzy_enabled; # add fuzzy, word list
747 $weighted_query .= " or wrdl,right-Truncation,r9=\"$stemmed_operand\""
748 if ( $stemming and $stemmed_operand )
749 ; # add stemming, right truncation
750 $weighted_query .= " or wrdl,r9=\"$operand\"";
752 # embedded sorting: 0 a-z; 1 z-a
753 # $weighted_query .= ") or (sort1,aut=1";
756 # Barcode searches should skip this process
757 elsif ( $index eq 'bc' ) {
758 $weighted_query .= "bc=\"$operand\"";
761 # Authority-number searches should skip this process
762 elsif ( $index eq 'an' ) {
763 $weighted_query .= "an=\"$operand\"";
766 # If the index already has more than one qualifier, wrap the operand
767 # in quotes and pass it back (assumption is that the user knows what they
768 # are doing and won't appreciate us mucking up their query
769 elsif ( $index =~ ',' ) {
770 $weighted_query .= " $index=\"$operand\"";
773 #TODO: build better cases based on specific search indexes
775 $weighted_query .= " $index,ext,r1=\"$operand\""; # exact index
776 #$weighted_query .= " or (title-sort-az=0 or $index,startswithnt,st-word,r3=$operand #)";
777 $weighted_query .= " or $index,phr,r3=\"$operand\""; # phrase index
779 " or $index,rt,wrdl,r3=\"$operand\""; # word list index
782 $weighted_query .= "))"; # close rank specification
783 return $weighted_query;
788 Return an array with available indexes.
810 'Author-personal-bibliography',
819 'Chronological-subdivision',
829 'Conference-name-heading',
830 'Conference-name-see',
831 'Conference-name-seealso',
836 'Corporate-name-heading',
837 'Corporate-name-see',
838 'Corporate-name-seealso',
840 'date-entered-on-file',
841 'Date-of-acquisition',
842 'Date-of-publication',
843 'Dewey-classification',
849 'Geographic-subdivision',
852 'Heading-use-main-or-added-entry',
853 'Heading-use-series-added-entry ',
854 'Heading-use-subject-added-entry',
870 'Local-classification',
873 'Match-heading-see-from',
879 'Name-geographic-heading',
880 'Name-geographic-see',
881 'Name-geographic-seealso',
888 'Personal-name-heading',
890 'Personal-name-seealso',
906 'Subject-heading-thesaurus',
907 'Subject-name-personal',
908 'Subject-subdivision',
917 'Term-genre-form-heading',
918 'Term-genre-form-see',
919 'Term-genre-form-seealso',
925 'Title-uniform-heading',
927 'Title-uniform-seealso',
937 'classification-source',
939 'coded-location-qualifier',
949 'Local-classification',
952 'materials-specified',
961 'replacementpricedate',
977 $simple_query, $query_cgi,
979 $limit_cgi, $limit_desc,
980 $stopwords_removed, $query_type ) = buildQuery ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang);
982 Build queries and limits in CCL, CGI, Human,
983 handle truncation, stemming, field weighting, stopwords, fuzziness, etc.
985 See verbose embedded documentation.
991 my ( $operators, $operands, $indexes, $limits, $sort_by, $scan, $lang) = @_;
993 warn "---------\nEnter buildQuery\n---------" if $DEBUG;
996 my @operators = $operators ? @$operators : ();
997 my @indexes = $indexes ? @$indexes : ();
998 my @operands = $operands ? @$operands : ();
999 my @limits = $limits ? @$limits : ();
1000 my @sort_by = $sort_by ? @$sort_by : ();
1002 my $stemming = C4::Context->preference("QueryStemming") || 0;
1003 my $auto_truncation = C4::Context->preference("QueryAutoTruncate") || 0;
1004 my $weight_fields = C4::Context->preference("QueryWeightFields") || 0;
1005 my $fuzzy_enabled = C4::Context->preference("QueryFuzzy") || 0;
1006 my $remove_stopwords = C4::Context->preference("QueryRemoveStopwords") || 0;
1008 # no stemming/weight/fuzzy in NoZebra
1009 if ( C4::Context->preference("NoZebra") ) {
1013 $auto_truncation = 0;
1016 my $query = $operands[0];
1017 my $simple_query = $operands[0];
1019 # initialize the variables we're passing back
1028 my $stopwords_removed; # flag to determine if stopwords have been removed
1031 my $cclindexes = getIndexes();
1032 if( $query !~ /\s*ccl=/ ){
1033 for my $index (@$cclindexes){
1034 if($query =~ /($index)(,?\w)*[:=]/){
1038 $query = "ccl=$query" if($cclq);
1041 # for handling ccl, cql, pqf queries in diagnostic mode, skip the rest of the steps
1043 if ( $query =~ /^ccl=/ ) {
1044 return ( undef, $', $', "q=ccl=$'", $', '', '', '', '', 'ccl' );
1046 if ( $query =~ /^cql=/ ) {
1047 return ( undef, $', $', "q=cql=$'", $', '', '', '', '', 'cql' );
1049 if ( $query =~ /^pqf=/ ) {
1050 return ( undef, $', $', "q=pqf=$'", $', '', '', '', '', 'pqf' );
1053 # pass nested queries directly
1054 # FIXME: need better handling of some of these variables in this case
1055 # Nested queries aren't handled well and this implementation is flawed and causes users to be
1056 # unable to search for anything containing () commenting out, will be rewritten for 3.4.0
1057 # if ( $query =~ /(\(|\))/ ) {
1059 # undef, $query, $simple_query, $query_cgi,
1060 # $query, $limit, $limit_cgi, $limit_desc,
1061 # $stopwords_removed, 'ccl'
1065 # Form-based queries are non-nested and fixed depth, so we can easily modify the incoming
1066 # query operands and indexes and add stemming, truncation, field weighting, etc.
1067 # Once we do so, we'll end up with a value in $query, just like if we had an
1068 # incoming $query from the user
1071 ; # clear it out so we can populate properly with field-weighted, stemmed, etc. query
1072 my $previous_operand
1073 ; # a flag used to keep track if there was a previous query
1074 # if there was, we can apply the current operator
1076 for ( my $i = 0 ; $i <= @operands ; $i++ ) {
1078 # COMBINE OPERANDS, INDEXES AND OPERATORS
1079 if ( $operands[$i] ) {
1081 # A flag to determine whether or not to add the index to the query
1084 # If the user is sophisticated enough to specify an index, turn off field weighting, stemming, and stopword handling
1085 if ( $operands[$i] =~ /(:|=)/ || $scan ) {
1088 $remove_stopwords = 0;
1090 my $operand = $operands[$i];
1091 my $index = $indexes[$i];
1093 # Add index-specific attributes
1094 # Date of Publication
1095 if ( $index eq 'yr' ) {
1096 $index .= ",st-numeric";
1098 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1101 # Date of Acquisition
1102 elsif ( $index eq 'acqdate' ) {
1103 $index .= ",st-date-normalized";
1105 $stemming = $auto_truncation = $weight_fields = $fuzzy_enabled = $remove_stopwords = 0;
1107 # ISBN,ISSN,Standard Number, don't need special treatment
1108 elsif ( $index eq 'nb' || $index eq 'ns' ) {
1111 $stemming, $auto_truncation,
1112 $weight_fields, $fuzzy_enabled,
1114 ) = ( 0, 0, 0, 0, 0 );
1122 # Set default structure attribute (word list)
1124 unless ( $indexes_set || !$index || $index =~ /(st-|phr|ext|wrdl)/ ) {
1125 $struct_attr = ",wrdl";
1128 # Some helpful index variants
1129 my $index_plus = $index . $struct_attr . ":" if $index;
1130 my $index_plus_comma = $index . $struct_attr . "," if $index;
1133 if ($remove_stopwords) {
1134 ( $operand, $stopwords_removed ) =
1135 _remove_stopwords( $operand, $index );
1136 warn "OPERAND w/out STOPWORDS: >$operand<" if $DEBUG;
1137 warn "REMOVED STOPWORDS: @$stopwords_removed"
1138 if ( $stopwords_removed && $DEBUG );
1141 if ($auto_truncation){
1142 unless ( $index =~ /(st-|phr|ext)/ ) {
1143 #FIXME only valid with LTR scripts
1144 $operand=join(" ",map{
1145 (index($_,"*")>0?"$_":"$_*")
1146 }split (/\s+/,$operand));
1147 warn $operand if $DEBUG;
1152 my $truncated_operand;
1153 my( $nontruncated, $righttruncated, $lefttruncated,
1154 $rightlefttruncated, $regexpr
1155 ) = _detect_truncation( $operand, $index );
1157 "TRUNCATION: NON:>@$nontruncated< RIGHT:>@$righttruncated< LEFT:>@$lefttruncated< RIGHTLEFT:>@$rightlefttruncated< REGEX:>@$regexpr<"
1162 scalar(@$righttruncated) + scalar(@$lefttruncated) +
1163 scalar(@$rightlefttruncated) > 0 )
1166 # Don't field weight or add the index to the query, we do it here
1168 undef $weight_fields;
1169 my $previous_truncation_operand;
1170 if (scalar @$nontruncated) {
1171 $truncated_operand .= "$index_plus @$nontruncated ";
1172 $previous_truncation_operand = 1;
1174 if (scalar @$righttruncated) {
1175 $truncated_operand .= "and " if $previous_truncation_operand;
1176 $truncated_operand .= $index_plus_comma . "rtrn:@$righttruncated ";
1177 $previous_truncation_operand = 1;
1179 if (scalar @$lefttruncated) {
1180 $truncated_operand .= "and " if $previous_truncation_operand;
1181 $truncated_operand .= $index_plus_comma . "ltrn:@$lefttruncated ";
1182 $previous_truncation_operand = 1;
1184 if (scalar @$rightlefttruncated) {
1185 $truncated_operand .= "and " if $previous_truncation_operand;
1186 $truncated_operand .= $index_plus_comma . "rltrn:@$rightlefttruncated ";
1187 $previous_truncation_operand = 1;
1190 $operand = $truncated_operand if $truncated_operand;
1191 warn "TRUNCATED OPERAND: >$truncated_operand<" if $DEBUG;
1194 my $stemmed_operand;
1195 $stemmed_operand = _build_stemmed_operand($operand, $lang)
1198 warn "STEMMED OPERAND: >$stemmed_operand<" if $DEBUG;
1200 # Handle Field Weighting
1201 my $weighted_operand;
1202 if ($weight_fields) {
1203 $weighted_operand = _build_weighted_query( $operand, $stemmed_operand, $index );
1204 $operand = $weighted_operand;
1208 warn "FIELD WEIGHTED OPERAND: >$weighted_operand<" if $DEBUG;
1210 # If there's a previous operand, we need to add an operator
1211 if ($previous_operand) {
1213 # User-specified operator
1214 if ( $operators[ $i - 1 ] ) {
1215 $query .= " $operators[$i-1] ";
1216 $query .= " $index_plus " unless $indexes_set;
1217 $query .= " $operand";
1218 $query_cgi .= "&op=$operators[$i-1]";
1219 $query_cgi .= "&idx=$index" if $index;
1220 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1222 " $operators[$i-1] $index_plus $operands[$i]";
1225 # Default operator is and
1228 $query .= "$index_plus " unless $indexes_set;
1229 $query .= "$operand";
1230 $query_cgi .= "&op=and&idx=$index" if $index;
1231 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1232 $query_desc .= " and $index_plus $operands[$i]";
1236 # There isn't a pervious operand, don't need an operator
1239 # Field-weighted queries already have indexes set
1240 $query .= " $index_plus " unless $indexes_set;
1242 $query_desc .= " $index_plus $operands[$i]";
1243 $query_cgi .= "&idx=$index" if $index;
1244 $query_cgi .= "&q=$operands[$i]" if $operands[$i];
1245 $previous_operand = 1;
1250 warn "QUERY BEFORE LIMITS: >$query<" if $DEBUG;
1253 my $group_OR_limits;
1254 my $availability_limit;
1255 foreach my $this_limit (@limits) {
1256 # if ( $this_limit =~ /available/ ) {
1258 ## 'available' is defined as (items.onloan is NULL) and (items.itemlost = 0)
1260 ## all records not indexed in the onloan register (zebra) and all records with a value of lost equal to 0
1261 # $availability_limit .=
1262 #"( ( allrecords,AlwaysMatches='' not onloan,AlwaysMatches='') and (lost,st-numeric=0) )"; #or ( allrecords,AlwaysMatches='' not lost,AlwaysMatches='')) )";
1263 # $limit_cgi .= "&limit=available";
1264 # $limit_desc .= "";
1267 # group_OR_limits, prefixed by mc-
1268 # OR every member of the group
1269 # elsif ( $this_limit =~ /mc/ ) {
1270 if ( $this_limit =~ /mc/ ) {
1271 $group_OR_limits .= " or " if $group_OR_limits;
1272 $limit_desc .= " or " if $group_OR_limits;
1273 $group_OR_limits .= "$this_limit";
1274 $limit_cgi .= "&limit=$this_limit";
1275 $limit_desc .= " $this_limit";
1278 # Regular old limits
1280 $limit .= " and " if $limit || $query;
1281 $limit .= "$this_limit";
1282 $limit_cgi .= "&limit=$this_limit";
1283 if ($this_limit =~ /^branch:(.+)/) {
1284 my $branchcode = $1;
1285 my $branchname = GetBranchName($branchcode);
1286 if (defined $branchname) {
1287 $limit_desc .= " branch:$branchname";
1289 $limit_desc .= " $this_limit";
1292 $limit_desc .= " $this_limit";
1296 if ($group_OR_limits) {
1297 $limit .= " and " if ( $query || $limit );
1298 $limit .= "($group_OR_limits)";
1300 if ($availability_limit) {
1301 $limit .= " and " if ( $query || $limit );
1302 $limit .= "($availability_limit)";
1305 # Normalize the query and limit strings
1306 # This is flawed , means we can't search anything with : in it
1307 # if user wants to do ccl or cql, start the query with that
1308 # $query =~ s/:/=/g;
1309 $query =~ s/(?<=(ti|au|pb|su|an|kw|mc)):/=/g;
1310 $query =~ s/(?<=rtrn):/=/g;
1312 for ( $query, $query_desc, $limit, $limit_desc ) {
1313 s/ / /g; # remove extra spaces
1314 s/^ //g; # remove any beginning spaces
1315 s/ $//g; # remove any ending spaces
1316 s/==/=/g; # remove double == from query
1318 $query_cgi =~ s/^&//; # remove unnecessary & from beginning of the query cgi
1320 for ($query_cgi,$simple_query) {
1323 # append the limit to the query
1324 $query .= " " . $limit;
1328 warn "QUERY:" . $query;
1329 warn "QUERY CGI:" . $query_cgi;
1330 warn "QUERY DESC:" . $query_desc;
1331 warn "LIMIT:" . $limit;
1332 warn "LIMIT CGI:" . $limit_cgi;
1333 warn "LIMIT DESC:" . $limit_desc;
1334 warn "---------\nLeave buildQuery\n---------";
1337 undef, $query, $simple_query, $query_cgi,
1338 $query_desc, $limit, $limit_cgi, $limit_desc,
1339 $stopwords_removed, $query_type
1343 =head2 searchResults
1345 Format results in a form suitable for passing to the template
1349 # IMO this subroutine is pretty messy still -- it's responsible for
1350 # building the HTML output for the template
1352 my ( $searchdesc, $hits, $results_per_page, $offset, $scan, @marcresults, $hidelostitems ) = @_;
1353 my $dbh = C4::Context->dbh;
1356 #Build branchnames hash
1358 #get branch information.....
1360 my $bsth =$dbh->prepare("SELECT branchcode,branchname FROM branches"); # FIXME : use C4::Branch::GetBranches
1362 while ( my $bdata = $bsth->fetchrow_hashref ) {
1363 $branches{ $bdata->{'branchcode'} } = $bdata->{'branchname'};
1365 # FIXME - We build an authorised values hash here, using the default framework
1366 # though it is possible to have different authvals for different fws.
1368 my $shelflocations =GetKohaAuthorisedValues('items.location','');
1370 # get notforloan authorised value list (see $shelflocations FIXME)
1371 my $notforloan_authorised_value = GetAuthValCode('items.notforloan','');
1373 #Build itemtype hash
1374 #find itemtype & itemtype image
1378 "SELECT itemtype,description,imageurl,summary,notforloan FROM itemtypes"
1381 while ( my $bdata = $bsth->fetchrow_hashref ) {
1382 foreach (qw(description imageurl summary notforloan)) {
1383 $itemtypes{ $bdata->{'itemtype'} }->{$_} = $bdata->{$_};
1387 #search item field code
1390 "SELECT tagfield FROM marc_subfield_structure WHERE kohafield LIKE 'items.itemnumber'"
1393 my ($itemtag) = $sth->fetchrow;
1395 ## find column names of items related to MARC
1396 my $sth2 = $dbh->prepare("SHOW COLUMNS FROM items");
1398 my %subfieldstosearch;
1399 while ( ( my $column ) = $sth2->fetchrow ) {
1400 my ( $tagfield, $tagsubfield ) =
1401 &GetMarcFromKohaField( "items." . $column, "" );
1402 $subfieldstosearch{$column} = $tagsubfield;
1405 # handle which records to actually retrieve
1407 if ( $hits && $offset + $results_per_page <= $hits ) {
1408 $times = $offset + $results_per_page;
1411 $times = $hits; # FIXME: if $hits is undefined, why do we want to equal it?
1414 my $marcflavour = C4::Context->preference("marcflavour");
1415 # We get the biblionumber position in MARC
1416 my ($bibliotag,$bibliosubf)=GetMarcFromKohaField('biblio.biblionumber','');
1419 # loop through all of the records we've retrieved
1420 for ( my $i = $offset ; $i <= $times - 1 ; $i++ ) {
1421 my $marcrecord = MARC::File::USMARC::decode( $marcresults[$i] );
1423 $fw = GetFrameworkCode($marcrecord->field($bibliotag)->data);
1425 $fw = GetFrameworkCode($marcrecord->subfield($bibliotag,$bibliosubf));
1428 my $oldbiblio = TransformMarcToKoha( $dbh, $marcrecord, $fw );
1429 $oldbiblio->{subtitle} = GetRecordValue('subtitle', $marcrecord, $fw);
1430 $oldbiblio->{result_number} = $i + 1;
1432 # add imageurl to itemtype if there is one
1433 $oldbiblio->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $oldbiblio->{itemtype} }->{imageurl} );
1435 $oldbiblio->{'authorised_value_images'} = C4::Items::get_authorised_value_images( C4::Biblio::get_biblio_authorised_values( $oldbiblio->{'biblionumber'}, $marcrecord ) );
1436 $oldbiblio->{normalized_upc} = GetNormalizedUPC( $marcrecord,$marcflavour);
1437 $oldbiblio->{normalized_ean} = GetNormalizedEAN( $marcrecord,$marcflavour);
1438 $oldbiblio->{normalized_oclc} = GetNormalizedOCLCNumber($marcrecord,$marcflavour);
1439 $oldbiblio->{normalized_isbn} = GetNormalizedISBN(undef,$marcrecord,$marcflavour);
1440 $oldbiblio->{content_identifier_exists} = 1 if ($oldbiblio->{normalized_isbn} or $oldbiblio->{normalized_oclc} or $oldbiblio->{normalized_ean} or $oldbiblio->{normalized_upc});
1442 # edition information, if any
1443 $oldbiblio->{edition} = $oldbiblio->{editionstatement};
1444 $oldbiblio->{description} = $itemtypes{ $oldbiblio->{itemtype} }->{description};
1445 # Build summary if there is one (the summary is defined in the itemtypes table)
1446 # FIXME: is this used anywhere, I think it can be commented out? -- JF
1447 if ( $itemtypes{ $oldbiblio->{itemtype} }->{summary} ) {
1448 my $summary = $itemtypes{ $oldbiblio->{itemtype} }->{summary};
1449 my @fields = $marcrecord->fields();
1452 foreach my $line ( "$summary\n" =~ /(.*)\n/g ){
1454 foreach my $tag ( $line =~ /\[(\d{3}[\w|\d])\]/ ) {
1455 $tag =~ /(.{3})(.)/;
1456 if($marcrecord->field($1)){
1457 my @abc = $marcrecord->field($1)->subfield($2);
1458 $tags->{$tag} = $#abc + 1 ;
1462 # We catch how many times to repeat this line
1464 foreach my $tag (keys(%$tags)){
1465 $max = $tags->{$tag} if($tags->{$tag} > $max);
1468 # we replace, and repeat each line
1469 for (my $i = 0 ; $i < $max ; $i++){
1470 my $newline = $line;
1472 foreach my $tag ( $newline =~ /\[(\d{3}[\w|\d])\]/g ) {
1473 $tag =~ /(.{3})(.)/;
1475 if($marcrecord->field($1)){
1476 my @repl = $marcrecord->field($1)->subfield($2);
1477 my $subfieldvalue = $repl[$i];
1479 if (! utf8::is_utf8($subfieldvalue)) {
1480 utf8::decode($subfieldvalue);
1483 $newline =~ s/\[$tag\]/$subfieldvalue/g;
1486 $newsummary .= "$newline\n";
1490 $newsummary =~ s/\[(.*?)]//g;
1491 $newsummary =~ s/\n/<br\/>/g;
1492 $oldbiblio->{summary} = $newsummary;
1495 # Pull out the items fields
1496 my @fields = $marcrecord->field($itemtag);
1498 # Setting item statuses for display
1499 my @available_items_loop;
1500 my @onloan_items_loop;
1501 my @other_items_loop;
1503 my $available_items;
1507 my $ordered_count = 0;
1508 my $available_count = 0;
1509 my $onloan_count = 0;
1510 my $longoverdue_count = 0;
1511 my $other_count = 0;
1512 my $wthdrawn_count = 0;
1513 my $itemlost_count = 0;
1514 my $itembinding_count = 0;
1515 my $itemdamaged_count = 0;
1516 my $item_in_transit_count = 0;
1517 my $can_place_holds = 0;
1518 my $items_count = scalar(@fields);
1520 ( C4::Context->preference('maxItemsinSearchResults') )
1521 ? C4::Context->preference('maxItemsinSearchResults') - 1
1524 # loop through every item
1525 foreach my $field (@fields) {
1528 # populate the items hash
1529 foreach my $code ( keys %subfieldstosearch ) {
1530 $item->{$code} = $field->subfield( $subfieldstosearch{$code} );
1533 my $hbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'homebranch' : 'holdingbranch';
1534 my $otherbranch = C4::Context->preference('HomeOrHoldingBranch') eq 'homebranch' ? 'holdingbranch' : 'homebranch';
1535 # set item's branch name, use HomeOrHoldingBranch syspref first, fall back to the other one
1536 if ($item->{$hbranch}) {
1537 $item->{'branchname'} = $branches{$item->{$hbranch}};
1539 elsif ($item->{$otherbranch}) { # Last resort
1540 $item->{'branchname'} = $branches{$item->{$otherbranch}};
1543 my $prefix = $item->{$hbranch} . '--' . $item->{location} . $item->{itype} . $item->{itemcallnumber};
1544 # For each grouping of items (onloan, available, unavailable), we build a key to store relevant info about that item
1545 if ( $item->{onloan} ) {
1547 my $key = $prefix . $item->{onloan} . $item->{barcode};
1548 $onloan_items->{$key}->{due_date} = format_date($item->{onloan});
1549 $onloan_items->{$key}->{count}++ if $item->{$hbranch};
1550 $onloan_items->{$key}->{branchname} = $item->{branchname};
1551 $onloan_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1552 $onloan_items->{$key}->{itemcallnumber} = $item->{itemcallnumber};
1553 $onloan_items->{$key}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1554 # if something's checked out and lost, mark it as 'long overdue'
1555 if ( $item->{itemlost} ) {
1556 $onloan_items->{$prefix}->{longoverdue}++;
1557 $longoverdue_count++;
1558 } else { # can place holds as long as item isn't lost
1559 $can_place_holds = 1;
1563 # items not on loan, but still unavailable ( lost, withdrawn, damaged )
1567 if ( $item->{notforloan} == -1 ) {
1571 # is item in transit?
1572 my $transfertwhen = '';
1573 my ($transfertfrom, $transfertto);
1575 unless ($item->{wthdrawn}
1576 || $item->{itemlost}
1578 || $item->{notforloan}
1579 || $items_count > 20) {
1581 # A couple heuristics to limit how many times
1582 # we query the database for item transfer information, sacrificing
1583 # accuracy in some cases for speed;
1585 # 1. don't query if item has one of the other statuses
1586 # 2. don't check transit status if the bib has
1587 # more than 20 items
1589 # FIXME: to avoid having the query the database like this, and to make
1590 # the in transit status count as unavailable for search limiting,
1591 # should map transit status to record indexed in Zebra.
1593 ($transfertwhen, $transfertfrom, $transfertto) = C4::Circulation::GetTransfers($item->{itemnumber});
1596 # item is withdrawn, lost or damaged
1597 if ( $item->{wthdrawn}
1598 || $item->{itemlost}
1600 || $item->{notforloan}
1601 || ($transfertwhen ne ''))
1603 $wthdrawn_count++ if $item->{wthdrawn};
1604 $itemlost_count++ if $item->{itemlost};
1605 $itemdamaged_count++ if $item->{damaged};
1606 $item_in_transit_count++ if $transfertwhen ne '';
1607 $item->{status} = $item->{wthdrawn} . "-" . $item->{itemlost} . "-" . $item->{damaged} . "-" . $item->{notforloan};
1610 my $key = $prefix . $item->{status};
1611 foreach (qw(wthdrawn itemlost damaged branchname itemcallnumber)) {
1612 $other_items->{$key}->{$_} = $item->{$_};
1614 $other_items->{$key}->{intransit} = ($transfertwhen ne '') ? 1 : 0;
1615 $other_items->{$key}->{notforloan} = GetAuthorisedValueDesc('','',$item->{notforloan},'','',$notforloan_authorised_value) if $notforloan_authorised_value;
1616 $other_items->{$key}->{count}++ if $item->{$hbranch};
1617 $other_items->{$key}->{location} = $shelflocations->{ $item->{location} };
1618 $other_items->{$key}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1622 $can_place_holds = 1;
1624 $available_items->{$prefix}->{count}++ if $item->{$hbranch};
1625 foreach (qw(branchname itemcallnumber)) {
1626 $available_items->{$prefix}->{$_} = $item->{$_};
1628 $available_items->{$prefix}->{location} = $shelflocations->{ $item->{location} };
1629 $available_items->{$prefix}->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes{ $item->{itype} }->{imageurl} );
1632 } # notforloan, item level and biblioitem level
1633 my ( $availableitemscount, $onloanitemscount, $otheritemscount );
1635 ( C4::Context->preference('maxItemsinSearchResults') )
1636 ? C4::Context->preference('maxItemsinSearchResults') - 1
1638 for my $key ( sort keys %$onloan_items ) {
1639 (++$onloanitemscount > $maxitems) and last;
1640 push @onloan_items_loop, $onloan_items->{$key};
1642 for my $key ( sort keys %$other_items ) {
1643 (++$otheritemscount > $maxitems) and last;
1644 push @other_items_loop, $other_items->{$key};
1646 for my $key ( sort keys %$available_items ) {
1647 (++$availableitemscount > $maxitems) and last;
1648 push @available_items_loop, $available_items->{$key}
1651 # XSLT processing of some stuff
1654 SetUTF8Flag($marcrecord);
1655 $debug && warn $marcrecord->as_formatted;
1656 if (C4::Context->preference("XSLTResultsDisplay") && !$scan) {
1657 $oldbiblio->{XSLTResultsRecord} = XSLTParse4Display(
1658 $oldbiblio->{biblionumber}, $marcrecord, 'Results' );
1661 # last check for norequest : if itemtype is notforloan, it can't be reserved either, whatever the items
1662 $can_place_holds = 0
1663 if $itemtypes{ $oldbiblio->{itemtype} }->{notforloan};
1664 $oldbiblio->{norequests} = 1 unless $can_place_holds;
1665 $oldbiblio->{itemsplural} = 1 if $items_count > 1;
1666 $oldbiblio->{items_count} = $items_count;
1667 $oldbiblio->{available_items_loop} = \@available_items_loop;
1668 $oldbiblio->{onloan_items_loop} = \@onloan_items_loop;
1669 $oldbiblio->{other_items_loop} = \@other_items_loop;
1670 $oldbiblio->{availablecount} = $available_count;
1671 $oldbiblio->{availableplural} = 1 if $available_count > 1;
1672 $oldbiblio->{onloancount} = $onloan_count;
1673 $oldbiblio->{onloanplural} = 1 if $onloan_count > 1;
1674 $oldbiblio->{othercount} = $other_count;
1675 $oldbiblio->{otherplural} = 1 if $other_count > 1;
1676 $oldbiblio->{wthdrawncount} = $wthdrawn_count;
1677 $oldbiblio->{itemlostcount} = $itemlost_count;
1678 $oldbiblio->{damagedcount} = $itemdamaged_count;
1679 $oldbiblio->{intransitcount} = $item_in_transit_count;
1680 $oldbiblio->{orderedcount} = $ordered_count;
1681 $oldbiblio->{isbn} =~
1682 s/-//g; # deleting - in isbn to enable amazon content
1683 push( @newresults, $oldbiblio )
1684 if(not $hidelostitems
1685 or (($items_count > $itemlost_count )
1686 && $hidelostitems));
1692 =head2 SearchAcquisitions
1693 Search for acquisitions
1696 sub SearchAcquisitions{
1697 my ($datebegin, $dateend, $itemtypes,$criteria, $orderby) = @_;
1699 my $dbh=C4::Context->dbh;
1700 # Variable initialization
1704 LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
1705 LEFT JOIN items ON items.biblionumber=biblio.biblionumber
1706 WHERE dateaccessioned BETWEEN ? AND ?
1709 my (@params,@loopcriteria);
1711 push @params, $datebegin->output("iso");
1712 push @params, $dateend->output("iso");
1714 if (scalar(@$itemtypes)>0 and $criteria ne "itemtype" ){
1715 if(C4::Context->preference("item-level_itypes")){
1716 $str .= "AND items.itype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
1718 $str .= "AND biblioitems.itemtype IN (?".( ',?' x scalar @$itemtypes - 1 ).") ";
1720 push @params, @$itemtypes;
1723 if ($criteria =~/itemtype/){
1724 if(C4::Context->preference("item-level_itypes")){
1725 $str .= "AND items.itype=? ";
1727 $str .= "AND biblioitems.itemtype=? ";
1730 if(scalar(@$itemtypes) == 0){
1731 my $itypes = GetItemTypes();
1732 for my $key (keys %$itypes){
1733 push @$itemtypes, $key;
1737 @loopcriteria= @$itemtypes;
1738 }elsif ($criteria=~/itemcallnumber/){
1739 $str .= "AND (items.itemcallnumber LIKE CONCAT(?,'%')
1740 OR items.itemcallnumber is NULL
1741 OR items.itemcallnumber = '')";
1743 @loopcriteria = ("AA".."ZZ", "") unless (scalar(@loopcriteria)>0);
1745 $str .= "AND biblio.title LIKE CONCAT(?,'%') ";
1746 @loopcriteria = ("A".."z") unless (scalar(@loopcriteria)>0);
1749 if ($orderby =~ /date_desc/){
1750 $str.=" ORDER BY dateaccessioned DESC";
1752 $str.=" ORDER BY title";
1755 my $qdataacquisitions=$dbh->prepare($str);
1757 my @loopacquisitions;
1758 foreach my $value(@loopcriteria){
1759 push @params,$value;
1761 $cell{"title"}=$value;
1762 $cell{"titlecode"}=$value;
1764 eval{$qdataacquisitions->execute(@params);};
1766 if ($@){ warn "recentacquisitions Error :$@";}
1769 while (my $data=$qdataacquisitions->fetchrow_hashref){
1770 push @loopdata, {"summary"=>GetBiblioSummary( $data->{'marcxml'} ) };
1772 $cell{"loopdata"}=\@loopdata;
1774 push @loopacquisitions,\%cell if (scalar(@{$cell{loopdata}})>0);
1777 $qdataacquisitions->finish;
1778 return \@loopacquisitions;
1780 #----------------------------------------------------------------------
1782 # Non-Zebra GetRecords#
1783 #----------------------------------------------------------------------
1787 NZgetRecords has the same API as zera getRecords, even if some parameters are not managed
1793 $query, $simple_query, $sort_by_ref, $servers_ref,
1794 $results_per_page, $offset, $expanded_facet, $branches,
1797 warn "query =$query" if $DEBUG;
1798 my $result = NZanalyse($query);
1799 warn "results =$result" if $DEBUG;
1801 NZorder( $result, @$sort_by_ref[0], $results_per_page, $offset ),
1807 NZanalyse : get a CQL string as parameter, and returns a list of biblionumber;title,biblionumber;title,...
1808 the list is built from an inverted index in the nozebra SQL table
1809 note that title is here only for convenience : the sorting will be very fast when requested on title
1810 if the sorting is requested on something else, we will have to reread all results, and that may be longer.
1815 my ( $string, $server ) = @_;
1816 # warn "---------" if $DEBUG;
1817 warn " NZanalyse" if $DEBUG;
1818 # warn "---------" if $DEBUG;
1820 # $server contains biblioserver or authorities, depending on what we search on.
1821 #warn "querying : $string on $server";
1822 $server = 'biblioserver' unless $server;
1824 # if we have a ", replace the content to discard temporarily any and/or/not inside
1826 if ( $string =~ /"/ ) {
1827 $string =~ s/"(.*?)"/__X__/;
1829 warn "commacontent : $commacontent" if $DEBUG;
1832 # split the query string in 3 parts : X AND Y means : $left="X", $operand="AND" and $right="Y"
1833 # then, call again NZanalyse with $left and $right
1834 # (recursive until we find a leaf (=> something without and/or/not)
1835 # delete repeated operator... Would then go in infinite loop
1836 while ( $string =~ s/( and| or| not| AND| OR| NOT)\1/$1/g ) {
1839 #process parenthesis before.
1840 if ( $string =~ /^\s*\((.*)\)(( and | or | not | AND | OR | NOT )(.*))?/ ) {
1843 my $operator = lc($3); # FIXME: and/or/not are operators, not operands
1845 "dealing w/parenthesis before recursive sub call. left :$left operator:$operator right:$right"
1847 my $leftresult = NZanalyse( $left, $server );
1849 my $rightresult = NZanalyse( $right, $server );
1851 # OK, we have the results for right and left part of the query
1852 # depending of operand, intersect, union or exclude both lists
1853 # to get a result list
1854 if ( $operator eq ' and ' ) {
1855 return NZoperatorAND($leftresult,$rightresult);
1857 elsif ( $operator eq ' or ' ) {
1859 # just merge the 2 strings
1860 return $leftresult . $rightresult;
1862 elsif ( $operator eq ' not ' ) {
1863 return NZoperatorNOT($leftresult,$rightresult);
1867 # this error is impossible, because of the regexp that isolate the operand, but just in case...
1871 warn "string :" . $string if $DEBUG;
1875 if ($string =~ /(.*?)( and | or | not | AND | OR | NOT )(.*)/) {
1878 $operator = lc($2); # FIXME: and/or/not are operators, not operands
1880 warn "no parenthesis. left : $left operator: $operator right: $right"
1883 # it's not a leaf, we have a and/or/not
1886 # reintroduce comma content if needed
1887 $right =~ s/__X__/"$commacontent"/ if $commacontent;
1888 $left =~ s/__X__/"$commacontent"/ if $commacontent;
1889 warn "node : $left / $operator / $right\n" if $DEBUG;
1890 my $leftresult = NZanalyse( $left, $server );
1891 my $rightresult = NZanalyse( $right, $server );
1892 warn " leftresult : $leftresult" if $DEBUG;
1893 warn " rightresult : $rightresult" if $DEBUG;
1894 # OK, we have the results for right and left part of the query
1895 # depending of operand, intersect, union or exclude both lists
1896 # to get a result list
1897 if ( $operator eq ' and ' ) {
1899 return NZoperatorAND($leftresult,$rightresult);
1901 elsif ( $operator eq ' or ' ) {
1903 # just merge the 2 strings
1904 return $leftresult . $rightresult;
1906 elsif ( $operator eq ' not ' ) {
1907 return NZoperatorNOT($leftresult,$rightresult);
1911 # this error is impossible, because of the regexp that isolate the operand, but just in case...
1912 die "error : operand unknown : $operator for $string";
1915 # it's a leaf, do the real SQL query and return the result
1918 $string =~ s/__X__/"$commacontent"/ if $commacontent;
1919 $string =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|&|\+|\*|\// /g;
1920 #remove trailing blank at the beginning
1922 warn "leaf:$string" if $DEBUG;
1924 # parse the string in in operator/operand/value again
1928 if ($string =~ /(.*)(>=|<=)(.*)/) {
1935 # warn "handling leaf... left:$left operator:$operator right:$right"
1937 unless ($operator) {
1938 if ($string =~ /(.*)(>|<|=)(.*)/) {
1943 "handling unless (operator)... left:$left operator:$operator right:$right"
1951 # strip adv, zebra keywords, currently not handled in nozebra: wrdl, ext, phr...
1954 # automatic replace for short operators
1955 $left = 'title' if $left =~ '^ti$';
1956 $left = 'author' if $left =~ '^au$';
1957 $left = 'publisher' if $left =~ '^pb$';
1958 $left = 'subject' if $left =~ '^su$';
1959 $left = 'koha-Auth-Number' if $left =~ '^an$';
1960 $left = 'keyword' if $left =~ '^kw$';
1961 $left = 'itemtype' if $left =~ '^mc$'; # Fix for Bug 2599 - Search limits not working for NoZebra
1962 warn "handling leaf... left:$left operator:$operator right:$right" if $DEBUG;
1963 my $dbh = C4::Context->dbh;
1964 if ( $operator && $left ne 'keyword' ) {
1965 #do a specific search
1966 $operator = 'LIKE' if $operator eq '=' and $right =~ /%/;
1967 my $sth = $dbh->prepare(
1968 "SELECT biblionumbers,value FROM nozebra WHERE server=? AND indexname=? AND value $operator ?"
1970 warn "$left / $operator / $right\n" if $DEBUG;
1972 # split each word, query the DB and build the biblionumbers result
1973 #sanitizing leftpart
1974 $left =~ s/^\s+|\s+$//;
1975 foreach ( split / /, $right ) {
1977 $_ =~ s/^\s+|\s+$//;
1979 warn "EXECUTE : $server, $left, $_" if $DEBUG;
1980 $sth->execute( $server, $left, $_ )
1981 or warn "execute failed: $!";
1982 while ( my ( $line, $value ) = $sth->fetchrow ) {
1984 # if we are dealing with a numeric value, use only numeric results (in case of >=, <=, > or <)
1985 # otherwise, fill the result
1986 $biblionumbers .= $line
1987 unless ( $right =~ /^\d+$/ && $value =~ /\D/ );
1988 warn "result : $value "
1989 . ( $right =~ /\d/ ) . "=="
1990 . ( $value =~ /\D/?$line:"" ) if $DEBUG; #= $line";
1993 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
1995 warn "NZAND" if $DEBUG;
1996 $results = NZoperatorAND($biblionumbers,$results);
1998 $results = $biblionumbers;
2003 #do a complete search (all indexes), if index='kw' do complete search too.
2004 my $sth = $dbh->prepare(
2005 "SELECT biblionumbers FROM nozebra WHERE server=? AND value LIKE ?"
2008 # split each word, query the DB and build the biblionumbers result
2009 foreach ( split / /, $string ) {
2010 next if C4::Context->stopwords->{ uc($_) }; # skip if stopword
2011 warn "search on all indexes on $_" if $DEBUG;
2014 $sth->execute( $server, $_ );
2015 while ( my $line = $sth->fetchrow ) {
2016 $biblionumbers .= $line;
2019 # do a AND with existing list if there is one, otherwise, use the biblionumbers list as 1st result list
2021 $results = NZoperatorAND($biblionumbers,$results);
2024 warn "NEW RES for $_ = $biblionumbers" if $DEBUG;
2025 $results = $biblionumbers;
2029 warn "return : $results for LEAF : $string" if $DEBUG;
2032 warn "---------\nLeave NZanalyse\n---------" if $DEBUG;
2036 my ($rightresult, $leftresult)=@_;
2038 my @leftresult = split /;/, $leftresult;
2039 warn " @leftresult / $rightresult \n" if $DEBUG;
2041 # my @rightresult = split /;/,$leftresult;
2044 # parse the left results, and if the biblionumber exist in the right result, save it in finalresult
2045 # the result is stored twice, to have the same weight for AND than OR.
2046 # example : TWO : 61,61,64,121 (two is twice in the biblio #61) / TOWER : 61,64,130
2047 # result : 61,61,61,61,64,64 for two AND tower : 61 has more weight than 64
2048 foreach (@leftresult) {
2051 ( $value, $countvalue ) = ( $1, $2 ) if ($value=~/(.*)-(\d+)$/);
2052 if ( $rightresult =~ /\Q$value\E-(\d+);/ ) {
2053 $countvalue = ( $1 > $countvalue ? $countvalue : $1 );
2055 "$value-$countvalue;$value-$countvalue;";
2058 warn "NZAND DONE : $finalresult \n" if $DEBUG;
2059 return $finalresult;
2063 my ($rightresult, $leftresult)=@_;
2064 return $rightresult.$leftresult;
2068 my ($leftresult, $rightresult)=@_;
2070 my @leftresult = split /;/, $leftresult;
2072 # my @rightresult = split /;/,$leftresult;
2074 foreach (@leftresult) {
2076 $value=$1 if $value=~m/(.*)-\d+$/;
2077 unless ($rightresult =~ "$value-") {
2078 $finalresult .= "$_;";
2081 return $finalresult;
2086 $finalresult = NZorder($biblionumbers, $ordering,$results_per_page,$offset);
2093 my ( $biblionumbers, $ordering, $results_per_page, $offset ) = @_;
2094 warn "biblionumbers = $biblionumbers and ordering = $ordering\n" if $DEBUG;
2096 # order title asc by default
2097 # $ordering = '1=36 <i' unless $ordering;
2098 $results_per_page = 20 unless $results_per_page;
2099 $offset = 0 unless $offset;
2100 my $dbh = C4::Context->dbh;
2103 # order by POPULARITY
2105 if ( $ordering =~ /popularity/ ) {
2109 # popularity is not in MARC record, it's builded from a specific query
2111 $dbh->prepare("select sum(issues) from items where biblionumber=?");
2112 foreach ( split /;/, $biblionumbers ) {
2113 my ( $biblionumber, $title ) = split /,/, $_;
2114 $result{$biblionumber} = GetMarcBiblio($biblionumber);
2115 $sth->execute($biblionumber);
2116 my $popularity = $sth->fetchrow || 0;
2118 # hint : the key is popularity.title because we can have
2119 # many results with the same popularity. In this case, sub-ordering is done by title
2120 # we also have biblionumber to avoid bug for 2 biblios with the same title & popularity
2121 # (un-frequent, I agree, but we won't forget anything that way ;-)
2122 $popularity{ sprintf( "%10d", $popularity ) . $title
2123 . $biblionumber } = $biblionumber;
2126 # sort the hash and return the same structure as GetRecords (Zebra querying)
2129 if ( $ordering eq 'popularity_dsc' ) { # sort popularity DESC
2130 foreach my $key ( sort { $b cmp $a } ( keys %popularity ) ) {
2131 $result_hash->{'RECORDS'}[ $numbers++ ] =
2132 $result{ $popularity{$key} }->as_usmarc();
2135 else { # sort popularity ASC
2136 foreach my $key ( sort ( keys %popularity ) ) {
2137 $result_hash->{'RECORDS'}[ $numbers++ ] =
2138 $result{ $popularity{$key} }->as_usmarc();
2141 my $finalresult = ();
2142 $result_hash->{'hits'} = $numbers;
2143 $finalresult->{'biblioserver'} = $result_hash;
2144 return $finalresult;
2150 elsif ( $ordering =~ /author/ ) {
2152 foreach ( split /;/, $biblionumbers ) {
2153 my ( $biblionumber, $title ) = split /,/, $_;
2154 my $record = GetMarcBiblio($biblionumber);
2156 if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
2157 $author = $record->subfield( '200', 'f' );
2158 $author = $record->subfield( '700', 'a' ) unless $author;
2161 $author = $record->subfield( '100', 'a' );
2164 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2165 # and we don't want to get only 1 result for each of them !!!
2166 $result{ $author . $biblionumber } = $record;
2169 # sort the hash and return the same structure as GetRecords (Zebra querying)
2172 if ( $ordering eq 'author_za' ) { # sort by author desc
2173 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2174 $result_hash->{'RECORDS'}[ $numbers++ ] =
2175 $result{$key}->as_usmarc();
2178 else { # sort by author ASC
2179 foreach my $key ( sort ( keys %result ) ) {
2180 $result_hash->{'RECORDS'}[ $numbers++ ] =
2181 $result{$key}->as_usmarc();
2184 my $finalresult = ();
2185 $result_hash->{'hits'} = $numbers;
2186 $finalresult->{'biblioserver'} = $result_hash;
2187 return $finalresult;
2190 # ORDER BY callnumber
2193 elsif ( $ordering =~ /callnumber/ ) {
2195 foreach ( split /;/, $biblionumbers ) {
2196 my ( $biblionumber, $title ) = split /,/, $_;
2197 my $record = GetMarcBiblio($biblionumber);
2199 my $frameworkcode = GetFrameworkCode($biblionumber);
2200 my ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField( 'items.itemcallnumber', $frameworkcode);
2201 ( $callnumber_tag, $callnumber_subfield ) = GetMarcFromKohaField('biblioitems.callnumber', $frameworkcode)
2202 unless $callnumber_tag;
2203 if ( C4::Context->preference('marcflavour') eq 'UNIMARC' ) {
2204 $callnumber = $record->subfield( '200', 'f' );
2206 $callnumber = $record->subfield( '100', 'a' );
2209 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2210 # and we don't want to get only 1 result for each of them !!!
2211 $result{ $callnumber . $biblionumber } = $record;
2214 # sort the hash and return the same structure as GetRecords (Zebra querying)
2217 if ( $ordering eq 'call_number_dsc' ) { # sort by title desc
2218 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2219 $result_hash->{'RECORDS'}[ $numbers++ ] =
2220 $result{$key}->as_usmarc();
2223 else { # sort by title ASC
2224 foreach my $key ( sort { $a cmp $b } ( keys %result ) ) {
2225 $result_hash->{'RECORDS'}[ $numbers++ ] =
2226 $result{$key}->as_usmarc();
2229 my $finalresult = ();
2230 $result_hash->{'hits'} = $numbers;
2231 $finalresult->{'biblioserver'} = $result_hash;
2232 return $finalresult;
2234 elsif ( $ordering =~ /pubdate/ ) { #pub year
2236 foreach ( split /;/, $biblionumbers ) {
2237 my ( $biblionumber, $title ) = split /,/, $_;
2238 my $record = GetMarcBiblio($biblionumber);
2239 my ( $publicationyear_tag, $publicationyear_subfield ) =
2240 GetMarcFromKohaField( 'biblioitems.publicationyear', '' );
2241 my $publicationyear =
2242 $record->subfield( $publicationyear_tag,
2243 $publicationyear_subfield );
2245 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2246 # and we don't want to get only 1 result for each of them !!!
2247 $result{ $publicationyear . $biblionumber } = $record;
2250 # sort the hash and return the same structure as GetRecords (Zebra querying)
2253 if ( $ordering eq 'pubdate_dsc' ) { # sort by pubyear desc
2254 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2255 $result_hash->{'RECORDS'}[ $numbers++ ] =
2256 $result{$key}->as_usmarc();
2259 else { # sort by pub year ASC
2260 foreach my $key ( sort ( keys %result ) ) {
2261 $result_hash->{'RECORDS'}[ $numbers++ ] =
2262 $result{$key}->as_usmarc();
2265 my $finalresult = ();
2266 $result_hash->{'hits'} = $numbers;
2267 $finalresult->{'biblioserver'} = $result_hash;
2268 return $finalresult;
2274 elsif ( $ordering =~ /title/ ) {
2276 # the title is in the biblionumbers string, so we just need to build a hash, sort it and return
2278 foreach ( split /;/, $biblionumbers ) {
2279 my ( $biblionumber, $title ) = split /,/, $_;
2281 # hint : the result is sorted by title.biblionumber because we can have X biblios with the same title
2282 # and we don't want to get only 1 result for each of them !!!
2283 # hint & speed improvement : we can order without reading the record
2284 # so order, and read records only for the requested page !
2285 $result{ $title . $biblionumber } = $biblionumber;
2288 # sort the hash and return the same structure as GetRecords (Zebra querying)
2291 if ( $ordering eq 'title_az' ) { # sort by title desc
2292 foreach my $key ( sort ( keys %result ) ) {
2293 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2296 else { # sort by title ASC
2297 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2298 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2302 # limit the $results_per_page to result size if it's more
2303 $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2305 # for the requested page, replace biblionumber by the complete record
2306 # speed improvement : avoid reading too much things
2308 my $counter = $offset ;
2309 $counter <= $offset + $results_per_page ;
2313 $result_hash->{'RECORDS'}[$counter] =
2314 GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc;
2316 my $finalresult = ();
2317 $result_hash->{'hits'} = $numbers;
2318 $finalresult->{'biblioserver'} = $result_hash;
2319 return $finalresult;
2326 # we need 2 hashes to order by ranking : the 1st one to count the ranking, the 2nd to order by ranking
2329 foreach ( split /;/, $biblionumbers ) {
2330 my ( $biblionumber, $title ) = split /,/, $_;
2331 $title =~ /(.*)-(\d)/;
2336 # note that we + the ranking because ranking is calculated on weight of EACH term requested.
2337 # if we ask for "two towers", and "two" has weight 2 in biblio N, and "towers" has weight 4 in biblio N
2338 # biblio N has ranking = 6
2339 $count_ranking{$biblionumber} += $ranking;
2342 # build the result by "inverting" the count_ranking hash
2343 # 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
2345 foreach ( keys %count_ranking ) {
2346 $result{ sprintf( "%10d", $count_ranking{$_} ) . '-' . $_ } = $_;
2349 # sort the hash and return the same structure as GetRecords (Zebra querying)
2352 foreach my $key ( sort { $b cmp $a } ( keys %result ) ) {
2353 $result_hash->{'RECORDS'}[ $numbers++ ] = $result{$key};
2356 # limit the $results_per_page to result size if it's more
2357 $results_per_page = $numbers - 1 if $numbers < $results_per_page;
2359 # for the requested page, replace biblionumber by the complete record
2360 # speed improvement : avoid reading too much things
2362 my $counter = $offset ;
2363 $counter <= $offset + $results_per_page ;
2367 $result_hash->{'RECORDS'}[$counter] =
2368 GetMarcBiblio( $result_hash->{'RECORDS'}[$counter] )->as_usmarc
2369 if $result_hash->{'RECORDS'}[$counter];
2371 my $finalresult = ();
2372 $result_hash->{'hits'} = $numbers;
2373 $finalresult->{'biblioserver'} = $result_hash;
2374 return $finalresult;
2378 =head2 enabled_staff_search_views
2380 %hash = enabled_staff_search_views()
2382 This function returns a hash that contains three flags obtained from the system
2383 preferences, used to determine whether a particular staff search results view
2388 =item C<Output arg:>
2390 * $hash{can_view_MARC} is true only if the MARC view is enabled
2391 * $hash{can_view_ISBD} is true only if the ISBD view is enabled
2392 * $hash{can_view_labeledMARC} is true only if the Labeled MARC view is enabled
2394 =item C<usage in the script:>
2398 $template->param ( C4::Search::enabled_staff_search_views );
2402 sub enabled_staff_search_views
2405 can_view_MARC => C4::Context->preference('viewMARC'), # 1 if the staff search allows the MARC view
2406 can_view_ISBD => C4::Context->preference('viewISBD'), # 1 if the staff search allows the ISBD view
2407 can_view_labeledMARC => C4::Context->preference('viewLabeledMARC'), # 1 if the staff search allows the Labeled MARC view
2411 sub AddSearchHistory{
2412 my ($borrowernumber,$session,$query_desc,$query_cgi, $total)=@_;
2413 my $dbh = C4::Context->dbh;
2415 # Add the request the user just made
2416 my $sql = "INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, total, time) VALUES(?, ?, ?, ?, ?, NOW())";
2417 my $sth = $dbh->prepare($sql);
2418 $sth->execute($borrowernumber, $session, $query_desc, $query_cgi, $total);
2419 return $dbh->last_insert_id(undef, 'search_history', undef,undef,undef);
2422 sub GetSearchHistory{
2423 my ($borrowernumber,$session)=@_;
2424 my $dbh = C4::Context->dbh;
2426 # Add the request the user just made
2427 my $query = "SELECT FROM search_history WHERE (userid=? OR sessionid=?)";
2428 my $sth = $dbh->prepare($query);
2429 $sth->execute($borrowernumber, $session);
2430 return $sth->fetchall_hashref({});
2433 =head2 z3950_search_args
2435 $arrayref = z3950_search_args($matchpoints)
2437 This function returns an array reference that contains the search parameters to be
2438 passed to the Z39.50 search script (z3950_search.pl). The array elements
2439 are hash refs whose keys are name, value and encvalue, and whose values are the
2440 name of a search parameter, the value of that search parameter and the URL encoded
2441 value of that parameter.
2443 The search parameter names are lccn, isbn, issn, title, author, dewey and subject.
2445 The search parameter values are obtained from the bibliographic record whose
2446 data is in a hash reference in $matchpoints, as returned by Biblio::GetBiblioData().
2448 If $matchpoints is a scalar, it is assumed to be an unnamed query descriptor, e.g.
2449 a general purpose search argument. In this case, the returned array contains only
2450 entry: the key is 'title' and the value and encvalue are derived from $matchpoints.
2452 If a search parameter value is undefined or empty, it is not included in the returned
2455 The returned array reference may be passed directly to the template parameters.
2459 =item C<Output arg:>
2461 * $array containing hash refs as described above
2463 =item C<usage in the script:>
2467 $data = Biblio::GetBiblioData($bibno);
2468 $template->param ( MYLOOP => C4::Search::z3950_search_args($data) )
2472 $template->param ( MYLOOP => C4::Search::z3950_search_args($searchscalar) )
2476 sub z3950_search_args {
2478 $bibrec = { title => $bibrec } if !ref $bibrec;
2480 for my $field (qw/ lccn isbn issn title author dewey subject /)
2482 my $encvalue = URI::Escape::uri_escape_utf8($bibrec->{$field});
2483 push @$array, { name=>$field, value=>$bibrec->{$field}, encvalue=>$encvalue } if defined $bibrec->{$field};
2488 =head2 BiblioAddAuthorities
2490 ( $countlinked, $countcreated ) = BiblioAddAuthorities($record, $frameworkcode);
2492 this function finds the authorities linked to the biblio
2493 * search in the authority DB for the same authid (in $9 of the biblio)
2494 * search in the authority DB for the same 001 (in $3 of the biblio in UNIMARC)
2495 * search in the authority DB for the same values (exactly) (in all subfields of the biblio)
2496 OR adds a new authority record
2502 * $record is the MARC record in question (marc blob)
2503 * $frameworkcode is the bibliographic framework to use (if it is "" it uses the default framework)
2505 =item C<Output arg:>
2507 * $countlinked is the number of authorities records that are linked to this authority
2511 * I had to add this to Search.pm (instead of the logical Biblio.pm) because of a circular dependency (this sub uses SimpleSearch, and Search.pm uses Biblio.pm)
2517 sub BiblioAddAuthorities{
2518 my ( $record, $frameworkcode ) = @_;
2519 my $dbh=C4::Context->dbh;
2520 my $query=$dbh->prepare(qq|
2521 SELECT authtypecode,tagfield
2522 FROM marc_subfield_structure
2523 WHERE frameworkcode=?
2524 AND (authtypecode IS NOT NULL AND authtypecode<>\"\")|);
2525 # SELECT authtypecode,tagfield
2526 # FROM marc_subfield_structure
2527 # WHERE frameworkcode=?
2528 # AND (authtypecode IS NOT NULL OR authtypecode<>\"\")|);
2529 $query->execute($frameworkcode);
2530 my ($countcreated,$countlinked);
2531 while (my $data=$query->fetchrow_hashref){
2532 foreach my $field ($record->field($data->{tagfield})){
2533 next if ($field->subfield('3')||$field->subfield('9'));
2534 # No authorities id in the tag.
2535 # Search if there is any authorities to link to.
2536 my $query='at='.$data->{authtypecode}.' ';
2537 map {$query.= ' and he,ext="'.$_->[1].'"' if ($_->[0]=~/[A-z]/)} $field->subfields();
2538 my ($error, $results, $total_hits)=SimpleSearch( $query, undef, undef, [ "authorityserver" ] );
2539 # there is only 1 result
2541 warn "BIBLIOADDSAUTHORITIES: $error";
2544 if ($results && scalar(@$results)==1) {
2545 my $marcrecord = MARC::File::USMARC::decode($results->[0]);
2546 $field->add_subfields('9'=>$marcrecord->field('001')->data);
2548 } elsif (scalar(@$results)>1) {
2549 #More than One result
2550 #This can comes out of a lack of a subfield.
2551 # my $marcrecord = MARC::File::USMARC::decode($results->[0]);
2552 # $record->field($data->{tagfield})->add_subfields('9'=>$marcrecord->field('001')->data);
2555 #There are no results, build authority record, add it to Authorities, get authid and add it to 9
2556 ###NOTICE : This is only valid if a subfield is linked to one and only one authtypecode
2557 ###NOTICE : This can be a problem. We should also look into other types and rejected forms.
2558 my $authtypedata=C4::AuthoritiesMarc->GetAuthType($data->{authtypecode});
2559 next unless $authtypedata;
2560 my $marcrecordauth=MARC::Record->new();
2561 my $authfield=MARC::Field->new($authtypedata->{auth_tag_to_report},'','',"a"=>"".$field->subfield('a'));
2562 map { $authfield->add_subfields($_->[0]=>$_->[1]) if ($_->[0]=~/[A-z]/ && $_->[0] ne "a" )} $field->subfields();
2563 $marcrecordauth->insert_fields_ordered($authfield);
2565 # bug 2317: ensure new authority knows it's using UTF-8; currently
2566 # only need to do this for MARC21, as MARC::Record->as_xml_record() handles
2567 # automatically for UNIMARC (by not transcoding)
2568 # FIXME: AddAuthority() instead should simply explicitly require that the MARC::Record
2569 # use UTF-8, but as of 2008-08-05, did not want to introduce that kind
2570 # of change to a core API just before the 3.0 release.
2571 if (C4::Context->preference('marcflavour') eq 'MARC21') {
2572 SetMarcUnicodeFlag($marcrecordauth, 'MARC21');
2575 # warn "AUTH RECORD ADDED : ".$marcrecordauth->as_formatted;
2577 my $authid=AddAuthority($marcrecordauth,'',$data->{authtypecode});
2579 $field->add_subfields('9'=>$authid);
2583 return ($countlinked,$countcreated);
2586 =head2 GetDistinctValues($field);
2588 C<$field> is a reference to the fields array
2592 sub GetDistinctValues {
2593 my ($fieldname,$string)=@_;
2594 # returns a reference to a hash of references to branches...
2595 if ($fieldname=~/\./){
2596 my ($table,$column)=split /\./, $fieldname;
2597 my $dbh = C4::Context->dbh;
2598 warn "select DISTINCT($column) as value, count(*) as cnt from $table group by lib order by $column ";
2599 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 ");
2601 my $elements=$sth->fetchall_arrayref({});
2606 my @servers=qw<biblioserver authorityserver>;
2607 my (@zconns,@results);
2608 for ( my $i = 0 ; $i < @servers ; $i++ ) {
2609 $zconns[$i] = C4::Context->Zconn( $servers[$i], 1 );
2612 ZOOM::Query::CCL2RPN->new( qq"$fieldname $string", $zconns[$i])
2615 # The big moment: asynchronously retrieve results from all servers
2617 while ( ( my $i = ZOOM::event( \@zconns ) ) != 0 ) {
2618 my $ev = $zconns[ $i - 1 ]->last_event();
2619 if ( $ev == ZOOM::Event::ZEND ) {
2620 next unless $results[ $i - 1 ];
2621 my $size = $results[ $i - 1 ]->size();
2623 for (my $j=0;$j<$size;$j++){
2625 @hashscan{qw(value cnt)}=$results[ $i - 1 ]->display_term($j);
2626 push @elements, \%hashscan;
2636 END { } # module clean-up code here (global destructor)
2643 Koha Developement team <info@koha.org>