(bug #3170) check if mandatory fields are not empty
[koha.git] / opac / opac-search.pl
index 0f2fc2f..ae7f4ea 100755 (executable)
@@ -1,7 +1,8 @@
 #!/usr/bin/perl
 # Script to perform searching
-# Copied from search.pl
+# Mostly copied from search.pl, see POD there
 use strict;            # always use
+use warnings;
 
 ## STEP 1. Load things that are used in both search page and
 # results page and decide which template to load, operations 
@@ -9,10 +10,12 @@ use strict;            # always use
 ## load Koha modules
 use C4::Context;
 use C4::Output;
-use C4::Auth;
+use C4::Auth qw(:DEFAULT get_session);
 use C4::Search;
+use C4::Biblio;  # GetBiblioData
 use C4::Koha;
-use POSIX qw(ceil floor);
+use C4::Tags qw(get_tags);
+use POSIX qw(ceil floor strftime);
 use C4::Branch; # GetBranches
 
 # create a new CGI object
@@ -20,14 +23,29 @@ use C4::Branch; # GetBranches
 use CGI qw('-no_undef_params');
 my $cgi = new CGI;
 
+BEGIN {
+       if (C4::Context->preference('BakerTaylorEnabled')) {
+               require C4::External::BakerTaylor;
+               import C4::External::BakerTaylor qw(&image_url &link_url);
+       }
+}
+
 my ($template,$borrowernumber,$cookie);
 
 # decide which template to use
 my $template_name;
-my $template_type;
+my $template_type = 'basic';
 my @params = $cgi->param("limit");
-if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
-    $template_name = 'opac-results.tmpl';
+
+my $build_grouped_results = C4::Context->preference('OPACGroupResults');
+if ($cgi->param("format") && $cgi->param("format") =~ /(rss|atom|opensearchdescription)/) {
+       $template_name = 'opac-opensearch.tmpl';
+}
+elsif ($build_grouped_results) {
+    $template_name = 'opac-results-grouped.tmpl';
+}
+elsif ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
+       $template_name = 'opac-results.tmpl';
 }
 else {
     $template_name = 'opac-advsearch.tmpl';
@@ -41,9 +59,40 @@ else {
     authnotrequired => 1,
     }
 );
+
+if ($cgi->param("format") && $cgi->param("format") eq 'rss2') {
+       $template->param("rss2" => 1);
+}
+elsif ($cgi->param("format") && $cgi->param("format") eq 'atom') {
+       $template->param("atom" => 1);
+    # FIXME - the timestamp is a hack - the biblio update timestamp should be used for each
+    # entry, but not sure if that's worth an extra database query for each bib
+    $template->param(timestamp => strftime("%Y-%m-%dT%H:%M:%S-00:00", gmtime));
+}
+elsif ($cgi->param("format") && $cgi->param("format") eq 'opensearchdescription') {
+       $template->param("opensearchdescription" => 1);
+}
 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
     $template->param('UNIMARC' => 1);
 }
+if (C4::Context->preference("marcflavour") eq "MARC21" ) {
+    $template->param('usmarc' => 1);
+}
+
+if (C4::Context->preference('BakerTaylorEnabled')) {
+       $template->param(
+               BakerTaylorEnabled  => 1,
+               BakerTaylorImageURL => &image_url(),
+               BakerTaylorLinkURL  => &link_url(),
+               BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
+       );
+}
+if (C4::Context->preference('TagsEnabled')) {
+       $template->param(TagsEnabled => 1);
+       foreach (qw(TagsShowOnList TagsInputOnList)) {
+               C4::Context->preference($_) and $template->param($_ => 1);
+       }
+}
 
 ## URI Re-Writing
 # Deprecated, but preserved because it's interesting :-)
@@ -70,42 +119,69 @@ if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 #}
 
 # load the branches
+my $mybranch = ( C4::Context->preference( 'SearchMyLibraryFirst' ) && C4::Context->userenv ) ? C4::Context->userenv->{branch} : '';
 my $branches = GetBranches();
-my @branch_loop;
-
-for my $branch_hash (sort keys %$branches) {
-    push @branch_loop, {value => "$branch_hash" , branchname => $branches->{$branch_hash}->{'branchname'}, };
-}
+# FIXME: next line duplicates GetBranchesLoop(0,0);
+my @branch_loop = map {
+                    {
+                        value => $_,
+                        branchname => $branches->{$_}->{branchname},
+                        selected => ( $mybranch eq $_ ) ? 1 : 0
+                    }
+                } sort {
+                    $branches->{$a}->{branchname} cmp $branches->{$b}->{branchname}
+                } keys %$branches;
 
 my $categories = GetBranchCategories(undef,'searchdomain');
 
 $template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
 
-# load the itemtypes
+# load the Type stuff
 my $itemtypes = GetItemTypes;
+# the index parameter is different for item-level itemtypes
+my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
 my @itemtypesloop;
 my $selected=1;
 my $cnt;
-my $imgdir = getitemtypeimagesrc();
-foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
+my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes");
+
+if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {
+       foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
     my %row =(  number=>$cnt++,
-                imageurl=> $itemtypes->{$thisitemtype}->{'imageurl'}?($imgdir."/".$itemtypes->{$thisitemtype}->{'imageurl'}):"",
+                               ccl => $itype_or_itemtype,
                 code => $thisitemtype,
                 selected => $selected,
                 description => $itemtypes->{$thisitemtype}->{'description'},
                 count5 => $cnt % 4,
+                imageurl=> getitemtypeimagelocation( 'opac', $itemtypes->{$thisitemtype}->{'imageurl'} ),
             );
-    $selected = 0 if ($selected) ;
-    push @itemtypesloop, \%row;
+       $selected = 0 if ($selected) ;
+       push @itemtypesloop, \%row;
+       }
+       $template->param(itemtypeloop => \@itemtypesloop);
+} else {
+    my $advsearchtypes = GetAuthorisedValues($advanced_search_types);
+       for my $thisitemtype (@$advsearchtypes) {
+               my %row =(
+                               number=>$cnt++,
+                               ccl => $advanced_search_types,
+                code => $thisitemtype->{authorised_value},
+                selected => $selected,
+                description => $thisitemtype->{'lib'},
+                count5 => $cnt % 4,
+                imageurl=> getitemtypeimagelocation( 'opac', $thisitemtype->{'imageurl'} ),
+            );
+               push @itemtypesloop, \%row;
+       }
+       $template->param(itemtypeloop => \@itemtypesloop);
 }
-$template->param(itemtypeloop => \@itemtypesloop);
 
 # # load the itypes (Called item types in the template -- just authorized values for searching)
 # my ($itypecount,@itype_loop) = GetCcodes();
 # $template->param(itypeloop=>\@itype_loop,);
 
 # The following should only be loaded if we're bringing up the advanced search template
-if ( $template_type eq 'advsearch' ) {
+if ( $template_type && $template_type eq 'advsearch' ) {
 
     # load the servers (used for searching -- to do federated searching, etc.)
     my $primary_servers_loop;# = displayPrimaryServers();
@@ -113,12 +189,17 @@ if ( $template_type eq 'advsearch' ) {
     
     my $secondary_servers_loop;# = displaySecondaryServers();
     $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
-    
+
+    # set the default sorting
+    my $default_sort_by = C4::Context->preference('OPACdefaultSortField')."_".C4::Context->preference('OPACdefaultSortOrder') 
+        if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
+    $template->param($default_sort_by => 1);
+
     # determine what to display next to the search boxes (ie, boolean option
     # shouldn't appear on the first one, scan indexes should, adding a new
     # box should only appear on the last, etc.
     my @search_boxes_array;
-    my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") | 3; # FIXME: should be a syspref
+    my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") || 3; # FIXME: should be a syspref
     for (my $i=1;$i<=$search_boxes_count;$i++) {
         # if it's the first one, don't display boolean option, but show scan indexes
         if ($i==1) {
@@ -149,11 +230,11 @@ if ( $template_type eq 'advsearch' ) {
                       search_boxes_loop => \@search_boxes_array);
 
 # use the global setting by default
-       if ( C4::Context->preference("expandedSearchOption") == 1) {
+       if ( C4::Context->preference("expandedSearchOption") ) {
                $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
        }
        # but let the user override it
-       if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
+       if ( $cgi->param("expanded_options") && (($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 )) ) {
        $template->param( expanded_options => $cgi->param('expanded_options'));
        }
 
@@ -168,6 +249,8 @@ if ( $template_type eq 'advsearch' ) {
 #  * we can edit the values by changing the key
 #  * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
 my $params = $cgi->Vars;
+my $tag;
+$tag = $params->{tag} if $params->{tag};
 
 # Params that can have more than one value
 # sort by is used to sort the query
@@ -177,7 +260,7 @@ my $default_sort_by = C4::Context->preference('OPACdefaultSortField')."_".C4::Co
     if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
 
 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
-$sort_by[0] = $default_sort_by unless $sort_by[0];
+$sort_by[0] = $default_sort_by if !$sort_by[0] && defined($default_sort_by);
 foreach my $sort (@sort_by) {
     $template->param($sort => 1);
 }
@@ -199,7 +282,8 @@ my @operators;
 
 # indexes are query qualifiers, like 'title', 'author', etc. They
 # can be single or multiple parameters separated by comma: kw,right-Truncation 
-my @indexes = split("\0",$params->{'idx'});
+my @indexes;
+@indexes = split("\0",$params->{'idx'}) if $params->{'idx'};
 
 # if a simple index (only one)  display the index used in the top search box
 if ($indexes[0] && !$indexes[1]) {
@@ -250,7 +334,7 @@ my $count = C4::Context->preference('OPACnumSearchResults') || 20;
 my $results_per_page = $params->{'count'} || $count;
 my $offset = $params->{'offset'} || 0;
 my $page = $cgi->param('page') || 1;
-#my $offset = ($page-1)*$results_per_page;
+$offset = ($page-1)*$results_per_page if $page>1;
 my $hits;
 my $expanded_facet = $params->{'expand'};
 
@@ -266,10 +350,8 @@ sub _input_cgi_parse ($) {
     my @elements;
     for my $this_cgi ( split('&',shift) ) {
         next unless $this_cgi;
-        $this_cgi =~ /(.*)=(.*)/;
-        my $input_name = $1;
-        my $input_value = $2;
-        push @elements, { input_name => $input_name, input_value => $input_value };
+        $this_cgi =~ /(.*?)=(.*)/;
+        push @elements, { input_name => $1, input_value => $2 };
     }
     return @elements;
 }
@@ -279,7 +361,7 @@ my @query_inputs = _input_cgi_parse($query_cgi);
 $template->param ( QUERY_INPUTS => \@query_inputs );
 
 ## parse the limit_cgi string and put it into a form suitable for <input>s
-my @limit_inputs = _input_cgi_parse($query_cgi);
+my @limit_inputs = $limit_cgi ? _input_cgi_parse($limit_cgi) : ();
 
 # add OPAC 'hidelostitems'
 if (C4::Context->preference('hidelostitems') == 1) {
@@ -295,20 +377,36 @@ if (C4::Context->preference('OpacSuppression')) {
 $template->param ( LIMIT_INPUTS => \@limit_inputs );
 
 ## II. DO THE SEARCH AND GET THE RESULTS
-my $total; # the total results for the whole set
+my $total = 0; # the total results for the whole set
 my $facets; # this object stores the faceted results that display on the left-hand of the results page
 my @results_array;
 my $results_hashref;
-
-if (C4::Context->preference('NoZebra')) {
+my @coins;
+
+if ($tag) {
+       my $taglist = get_tags({term=>$tag, approved=>1});
+       $results_hashref->{biblioserver}->{hits} = scalar (@$taglist);
+       my @biblist  = (map {GetBiblioData($_->{biblionumber})} @$taglist);
+       my @marclist = (map {$_->{marc}} @biblist );
+       $DEBUG and printf STDERR "taglist (%s biblionumber)\nmarclist (%s records)\n", scalar(@$taglist), scalar(@marclist);
+       $results_hashref->{biblioserver}->{RECORDS} = \@marclist;
+       # FIXME: tag search and standard search should work together, not exclusively
+       # FIXME: No facets for tags search.
+}
+elsif (C4::Context->preference('NoZebra')) {
     eval {
         ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
     };
+} elsif ($build_grouped_results) {
+    eval {
+        ($error, $results_hashref, $facets) = C4::Search::pazGetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
+    };
 } else {
     eval {
         ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
     };
 }
+# use Data::Dumper; print STDERR "-" x 25, "\n", Dumper($results_hashref);
 if ($@ || $error) {
     $template->param(query_error => $error.$@);
     output_html_with_http_headers $cgi, $cookie, $template->output;
@@ -320,15 +418,54 @@ if ($@ || $error) {
 my @sup_results_array;
 for (my $i=0;$i<=@servers;$i++) {
     my $server = $servers[$i];
-    if ($server =~/biblioserver/) { # this is the local bibliographic server
+    if ($server && $server =~/biblioserver/) { # this is the local bibliographic server
         $hits = $results_hashref->{$server}->{"hits"};
         my $page = $cgi->param('page') || 0;
-        my @newresults = searchResults( $query_desc,$hits,$results_per_page,$offset,@{$results_hashref->{$server}->{"RECORDS"}});
-        $total = $total + $results_hashref->{$server}->{"hits"};
+        my @newresults;
+        if ($build_grouped_results) {
+            foreach my $group (@{ $results_hashref->{$server}->{"GROUPS"} }) {
+                # because pazGetRecords handles retieving only the records
+                # we want as specified by $offset and $results_per_page,
+                # we need to set the offset parameter of searchResults to 0
+                my @group_results = searchResults( $query_desc, $group->{'group_count'},$results_per_page, 0, $scan,
+                                                   @{ $group->{"RECORDS"} });
+                push @newresults, { group_label => $group->{'group_label'}, GROUP_RESULTS => \@group_results };
+            }
+        } else {
+            @newresults = searchResults( $query_desc,$hits,$results_per_page,$offset,$scan,@{$results_hashref->{$server}->{"RECORDS"}});
+        }
+               my $tag_quantity;
+               if (C4::Context->preference('TagsEnabled') and
+                       $tag_quantity = C4::Context->preference('TagsShowOnList')) {
+                       foreach (@newresults) {
+                               my $bibnum = $_->{biblionumber} or next;
+                               $_ ->{'TagLoop'} = get_tags({biblionumber=>$bibnum, approved=>1, 'sort'=>'-weight',
+                                                                               limit=>$tag_quantity });
+                       }
+               }
+               foreach (@newresults) {
+                   $_->{coins} = GetCOinSBiblio($_->{'biblionumber'});
+               }
+      
+       if ($results_hashref->{$server}->{"hits"}){
+           $total = $total + $results_hashref->{$server}->{"hits"};
+       }
+        ## If there's just one result, redirect to the detail page
+        if ($total == 1) {         
+            my $biblionumber=$newresults[0]->{biblionumber};
+            if (C4::Context->preference('BiblioDefaultView') eq 'isbd') {
+                print $cgi->redirect("/cgi-bin/koha/opac-ISBDdetail.pl?biblionumber=$biblionumber");
+            } elsif  (C4::Context->preference('BiblioDefaultView') eq 'marc') {
+                print $cgi->redirect("/cgi-bin/koha/opac-MARCdetail.pl?biblionumber=$biblionumber");
+            } else {
+                print $cgi->redirect("/cgi-bin/koha/opac-detail.pl?biblionumber=$biblionumber");
+            } 
+            exit;
+        }
         if ($hits) {
             $template->param(total => $hits);
             my $limit_cgi_not_availablity = $limit_cgi;
-            $limit_cgi_not_availablity =~ s/&limit=available//g;
+            $limit_cgi_not_availablity =~ s/&limit=available//g if defined $limit_cgi_not_availablity;
             $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
             $template->param(limit_cgi => $limit_cgi);
             $template->param(query_cgi => $query_cgi);
@@ -392,32 +529,27 @@ for (my $i=0;$i<=@servers;$i++) {
             $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
         }
     } # end of the if local
-    else {
-        # check if it's a z3950 or opensearch source
-        my $zed3950 = 0;  # FIXME :: Hardcoded value.
-        if ($zed3950) {
-            my @inner_sup_results_array;
-            for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
-                my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
-                my $control_number = $marc_record_object->field('010')->subfield('a') if $marc_record_object->field('010');
-                $control_number =~ s/^ //g;
-                my $link = "http://catalog.loc.gov/cgi-bin/Pwebrecon.cgi?SAB1=".$control_number."&BOOL1=all+of+these&FLD1=LC+Control+Number+LCCN+%28K010%29+%28K010%29&GRP1=AND+with+next+set&SAB2=&BOOL2=all+of+these&FLD2=Keyword+Anywhere+%28GKEY%29+%28GKEY%29&PID=6211&SEQ=20060816121838&CNT=25&HIST=1";
-                my $title = $marc_record_object->title();
-                push @inner_sup_results_array, {
-                    'title' => $title,
-                    'link' => $link,
-                };
-            }
-            my $servername = $server;
-            push @sup_results_array, { servername => $servername, inner_sup_results_loop => \@inner_sup_results_array};
-            $template->param(outer_sup_results_loop => \@sup_results_array);
+    # asynchronously search the authority server
+    elsif ($server && $server =~/authorityserver/) { # this is the local authority server
+        my @inner_sup_results_array;
+        for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
+            my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
+            my $title_field = $marc_record_object->field(100);
+             warn "Authority Found: ".$marc_record_object->as_formatted();
+            push @inner_sup_results_array, {
+                'title' => $title_field->subfield('a'),
+                'link' => "&amp;idx=an&amp;q=".$marc_record_object->field('001')->as_string(),
+            };
         }
+        my $servername = $server;
+        push @sup_results_array, {  servername => $servername,
+                                    inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
     }
-
+    # FIXME: can add support for other targets as needed here
+    $template->param(           outer_sup_results_loop => \@sup_results_array);
 } #/end of the for loop
 #$template->param(FEDERATED_RESULTS => \@results_array);
 
-
 $template->param(
             #classlist => $classlist,
             total => $total,
@@ -478,4 +610,34 @@ if ( C4::Context->preference("kohaspsuggest") ) {
 }
 
 # VI. BUILD THE TEMPLATE
-output_html_with_http_headers $cgi, $cookie, $template->output;
+# Build drop-down list for 'Add To:' menu...
+my $session = get_session($cgi->cookie("CGISESSID"));
+my @addpubshelves;
+my $pubshelves = $session->param('pubshelves');
+my $barshelves = $session->param('barshelves');
+foreach my $shelf (@$pubshelves) {
+       next if ( ($shelf->{'owner'} != ($borrowernumber ? $borrowernumber : -1)) && ($shelf->{'category'} < 3) );
+       push (@addpubshelves, $shelf);
+}
+
+if (@addpubshelves) {
+       $template->param( addpubshelves     => scalar (@addpubshelves));
+       $template->param( addpubshelvesloop => \@addpubshelves);
+}
+
+if (defined $barshelves) {
+       $template->param( addbarshelves     => scalar (@$barshelves));
+       $template->param( addbarshelvesloop => $barshelves);
+}
+
+my $content_type;
+
+if ($cgi->param('format') && $cgi->param('format') =~ /rss/) {
+    $content_type = 'rss'
+} elsif ($cgi->param('format') && $cgi->param('format') =~ /atom/) {
+    $content_type = 'atom'
+} else {
+    $content_type = 'html'
+}
+
+output_with_http_headers $cgi, $cookie, $template->output, $content_type;