bug Fixing opac/opac-reserve.pl was broken
[koha.git] / opac / opac-reserve.pl
index 749f3fb..552cffb 100755 (executable)
 #!/usr/bin/perl
-# NOTE: This file uses standard 8-character tabs
+
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
+# Suite 330, Boston, MA  02111-1307 USA
 
 use strict;
-require Exporter;
 use CGI;
-
-use C4::Search;
-use C4::Auth;         # checkauth, getborrowernumber.
+use C4::Biblio;
+use C4::Items;
+use C4::Auth;    # checkauth, getborrowernumber.
 use C4::Koha;
-use C4::Circulation::Circ2;
-use C4::Reserves2;
-use C4::Interface::CGI::Output;
-use HTML::Template;
-use C4::Date;
+use C4::Circulation;
+use C4::Reserves;
+use C4::Output;
+use C4::Dates qw/format_date/;
 use C4::Context;
+use C4::Members;
+use C4::Branch; # GetBranches
+use C4::Debug;
+# use Data::Dumper;
 
 my $MAXIMUM_NUMBER_OF_RESERVES = C4::Context->preference("maxreserves");
 
 my $query = new CGI;
-my ($template, $borrowernumber, $cookie)
-    = get_template_and_user({template_name => "opac-reserve.tmpl",
-                            query => $query,
-                            type => "opac",
-                            authnotrequired => 0,
-                            flagsrequired => {borrow => 1},
-                            debug => 1,
-                            });
+my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
+    {
+        template_name   => "opac-reserve.tmpl",
+        query           => $query,
+        type            => "opac",
+        authnotrequired => 0,
+        flagsrequired   => { borrow => 1 },
+        debug           => 1,
+    }
+);
+
+sub get_out ($$$) {
+       output_html_with_http_headers(shift,shift,shift); # $query, $cookie, $template->output;
+       exit;
+}
 
 # get borrower information ....
-my ($borr, $flags) = getpatroninformation(undef, $borrowernumber);
-my @bordat;
-$bordat[0] = $borr;
+my ( $borr ) = GetMemberDetails( $borrowernumber );
+
+# get branches and itemtypes
+my $branches = GetBranches();
+my $itemtypes = GetItemTypes();
 
 # get biblionumber.....
-my $biblionumber = $query->param('bib');
+my $biblionumber = $query->param('biblionumber');
+if (! $biblionumber) {
+       $template->param(message=>1,no_biblionumber=>1);
+       &get_out($query, $cookie, $template->output);
+}
+$template->param( biblionumber => $biblionumber );
 
-my $bibdata = bibdata($biblionumber);
- $template->param($bibdata);
- $template->param(BORROWER_INFO => \@bordat, biblionumber => $biblionumber);
+my $bibdata = GetBiblioData($biblionumber);
+if (! $bibdata) {
+       $template->param(message=>1,bad_biblionumber=>$biblionumber);
+       &get_out($query, $cookie, $template->output);
+}
+$template->param($bibdata);            # FIXME: bad form.
 
 # get the rank number....
-my ($rank,$reserves) = FindReserves($biblionumber,'');
-$template->param(reservecount => $rank);
+my ( $rank, $reserves ) = GetReservesFromBiblionumber( $biblionumber);
+$template->param( reservecount => $rank );
 
 foreach my $res (@$reserves) {
-    if ($res->{'found'} eq 'W') {
-       $rank--;
+    if ( $res->{'found'} eq 'W' ) {
+        $rank--;
     }
 }
 
 $rank++;
-$template->param(rank => $rank);
+$template->param( rank => $rank );
 
 # pass the pickup branch along....
 my $branch = $query->param('branch');
-$template->param(branch => $branch);
-
-my $branches = getbranches();
-$template->param(branchname => $branches->{$branch}->{'branchname'});
+$template->param( branch => $branch );
 
+# make sure it's a real branch
+if ( !$branches->{$branch} ) {
+    $branch = '';
+}
+$template->param( branchname => $branches->{$branch}->{'branchname'} );
 
 # make branch selection options...
-#my $branchoptions = '';
 my @branches;
 my @select_branch;
 my %select_branches;
 
-foreach my $branch (keys %$branches) {
-       if ($branch) {
-               push @select_branch, $branch;
-               $select_branches{$branch} = $branches->{$branch}->{'branchname'};
-       }
+my @CGIbranchlooparray;
+
+foreach my $branch ( keys %$branches ) {
+    if ($branch) {
+        my %line;
+        $line{branch} = $branches->{$branch}->{'branchname'};
+        $line{value}  = $branch;
+        if ($line{value} eq C4::Context->userenv->{'branch'}) {
+            $line{selected} = 1;
+        }
+        push @CGIbranchlooparray, \%line;
+    }
 }
-my $CGIbranch=CGI::scrolling_list( -name     => 'branch',
-                       -values   => \@select_branch,
-                       -labels   => \%select_branches,
-                       -size     => 1,
-                       -multiple => 0 );
-$template->param( CGIbranch => $CGIbranch);
-
-#### THIS IS A BIT OF A HACK BECAUSE THE BIBLIOITEMS DATA IS A LITTLE MESSED UP!
-# get the itemtype data....
-my @items = ItemInfo(undef, $biblionumber, 'opac');
-
-#######################################################
-# old version, add so that old templates still work
-my %types_old;
+@CGIbranchlooparray =
+  sort { $a->{branch} cmp $b->{branch} } @CGIbranchlooparray;
+my $CGIbranchloop = \@CGIbranchlooparray;
+$template->param( CGIbranch => $CGIbranchloop );
+
+my @items = GetItemsInfo($biblionumber);
+
+# an item was previously required to have an itemtype in order to be reserved.
+# this behavior removed to fix bug 1891 .
+# my @items = grep { (C4::Context->preference('item-level_itypes') ? $_->{'itype'} : $_->{'itemtype'} ) } @all_items ;
+
+$template->param( itemcount => scalar(@items) );
+
+my %itemhash;
+my $forloan;
 foreach my $itm (@items) {
-    my $ity = $itm->{'itemtype'};
-    unless ($types_old {$ity}) {
-       $types_old{$ity}->{'itemtype'} = $ity;
-       $types_old{$ity}->{'branchinfo'}->{$itm->{'branchcode'}} = 1;
-       $types_old{$ity}->{'description'} = $itm->{'description'};
+       $debug and warn $itm->{'notforloan'};
+    my $fee = GetReserveFee( undef, $borrowernumber, $itm->{'biblionumber'}, 'a', ( $itm->{'biblioitemnumber'} ) );
+    $itm->{'reservefee'} = sprintf "%.02f", $fee;
+    # pass itype to itemtype for display purposes.  
+    $itm->{'itemtype'} = $itm->{'itype'} if(C4::Context->preference('item-level_itypes'));     
+       $itemhash{$itm->{'itemnumber'}}=$itm;
+    if (!$itm->{'notforloan'} && !($itm->{'itemnotforloan'} > 0)){
+               $forloan=1;
+       }
+}
+
+if ( $query->param('place_reserve') ) {
+    my @bibitems=$query->param('biblioitem');
+    my $notes=$query->param('notes');
+    my $checkitem=$query->param('checkitem');
+    my $found;
+    
+    #if we have an item selectionned, and the pickup branch is the same as the holdingbranch of the document, we force the value $rank and $found.
+    if ($checkitem ne ''){
+        $rank = '0' unless C4::Context->preference('ReservesNeedReturns');
+        my $item = $checkitem;
+        $item = GetItem($item);
+        if ( $item->{'holdingbranch'} eq $branch ){
+            $found = 'W' unless C4::Context->preference('ReservesNeedReturns');
+        }
+    }
+        
+        my $count=@bibitems;
+    @bibitems=sort @bibitems;
+    my $i2=1;
+    my @realbi;
+    $realbi[0]=$bibitems[0];
+    for (my $i=1;$i<$count;$i++) {
+        my $i3=$i2-1;
+        if ($realbi[$i3] ne $bibitems[$i]) {
+            $realbi[$i2]=$bibitems[$i];
+            $i2++;
+        }
+    }
+    # here we actually do the reserveration. Stage 3.
+    if ($query->param('request') eq 'any'){
+        # place a request on 1st available
+        AddReserve($branch,$borrowernumber,$biblionumber,'a',\@realbi,$rank,$notes,$bibdata->{'title'},$checkitem,$found);
     } else {
-       $types_old{$ity}->{'branchinfo'}->{$itm->{'branchcode'}} ++;
+        AddReserve($branch,$borrowernumber,$biblionumber,'a',\@realbi,$rank,$notes,$bibdata->{'title'},$checkitem, $found);
     }
+    print $query->redirect("/cgi-bin/koha/opac-user.pl#opac-user-holds");
 }
+else {
 
-foreach my $type (values %types_old) {
-    my $copies = "";
-    foreach my $bc (keys %{$type->{'branchinfo'}}) {
-       $copies .= $branches->{$bc}->{'branchname'}."(".$type->{'branchinfo'}->{$bc}.")";
+    # Here we check that the borrower can actually make reserves Stage 1.
+    my $noreserves     = 0;
+    my $maxoutstanding = C4::Context->preference("maxoutstanding");
+    $template->param( noreserve => 1 ) unless $maxoutstanding;
+    if ( $borr->{'amountoutstanding'} > $maxoutstanding ) {
+        my $amount = sprintf "\$%.02f", $borr->{'amountoutstanding'};
+        $template->param( message => 1 );
+        $noreserves = 1;
+        $template->param( too_much_oweing => $amount );
+    }
+    if ( $borr->{gonenoaddress} eq 1 ) {
+        $noreserves = 1;
+        $template->param(
+            message => 1,
+            GNA     => 1
+        );
+    }
+    if ( $borr->{lost} eq 1 ) {
+        $noreserves = 1;
+        $template->param(
+            message => 1,
+            lost    => 1
+        );
+    }
+    if ( $borr->{debarred} eq 1 ) {
+        $noreserves = 1;
+        $template->param(
+            message  => 1,
+            debarred => 1
+        );
+    }
+    my @reserves = GetReservesFromBorrowernumber( $borrowernumber );
+    $template->param( RESERVES => \@reserves );
+    if ( scalar(@reserves) >= $MAXIMUM_NUMBER_OF_RESERVES ) {
+        $template->param( message => 1 );
+        $noreserves = 1;
+        $template->param( too_many_reserves => scalar(@reserves));
+    }
+    foreach my $res (@reserves) {
+        if ( $res->{'biblionumber'} == $biblionumber && $res->{'borrowernumber'} == $borrowernumber) {
+            $template->param( message => 1 );
+            $noreserves = 1;
+            $template->param( already_reserved => 1 );
+        }
+    }
+    unless ($noreserves) {
+        $template->param( select_item_types => 1 );
     }
-    $type->{'copies'} = $copies;
 }
 
-my @types_old = values %types_old;
 
-# end old version
-################################
+my %itemnumbers_of_biblioitem;
+my @itemnumbers  = @{ get_itemnumbers_of($biblionumber)->{$biblionumber} };
+my $iteminfos_of = GetItemInfosOf(@itemnumbers);
 
-my @temp;
-foreach my $itm (@items) {
-    push @temp, $itm if $itm->{'itemtype'};
+foreach my $itemnumber (@itemnumbers) {
+    my $biblioitemnumber = $iteminfos_of->{$itemnumber}->{biblioitemnumber};
+    push( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} }, $itemnumber );
 }
-@items = @temp;
-my $itemcount = @items;
-$template->param(itemcount => $itemcount);
 
-my %types;
-my %itemtypes;
-my @duedates;
-foreach my $itm (@items) {
-    push @duedates, {date_due => format_date($itm->{'date_due'})} if defined $itm->{'date_due'};
-    $itm->{$itm->{'publictype'}} = 1;
-    # FIXME CalcReserveFee is supposed to be internal-use-only
-    my $fee  = CalcReserveFee(undef, $borrowernumber, $itm->{'biblionumber'},'a',($itm->{'biblioitemnumber'}));
-    $fee = sprintf "%.02f", $fee;
-    $itm->{'reservefee'} = $fee;
-    my $pty = $itm->{'publictype'};
-    $itemtypes{$itm->{'itemtype'}} = $itm;
-    unless ($types {$pty}) {
-       $types{$pty}->{'count'} = 1;
-       $types{$pty}->{$itm->{'itemtype'}} = 1;
-       push @{$types{$pty}->{'items'}}, $itm;
-    } else {
-       unless ($types{$pty}->{$itm->{'itemtype'}}) {
-           $types{$pty}->{'count'}++;
-           $types{$pty}->{$itm->{'itemtype'}} = 1;
-           push @{$types{$pty}->{'items'}}, $itm;
-       }
-    }
+my @biblioitemnumbers = keys %itemnumbers_of_biblioitem;
+
+my $notforloan_label_of = get_notforloan_label_of();
+my $biblioiteminfos_of  = GetBiblioItemInfosOf(@biblioitemnumbers);
+
+my @itemtypes;
+foreach my $biblioitemnumber (@biblioitemnumbers) {
+    push @itemtypes, $biblioiteminfos_of->{$biblioitemnumber}{itemtype};
 }
 
+my @bibitemloop;
 
-$template->param(ITEMS => \@duedates);
+foreach my $biblioitemnumber (@biblioitemnumbers) {
+    my $biblioitem = $biblioiteminfos_of->{$biblioitemnumber};
 
-my $width = keys %types;
-my @publictypes = sort {$b->{'count'} <=> $a->{'count'}} values %types;
-my $typecount;
-foreach my $pt (@publictypes) {
-    $typecount += $pt->{'count'};
-}
-$template->param(onlyone => 1) if $typecount == 1;
-
-my @typerows;
-for (my $rownum=0;$rownum<$publictypes[0]->{'count'} ;$rownum++) {
-    my @row;
-    foreach my $pty (@publictypes) {
-       my @items = @{$pty->{'items'}};
-       push @row, $items[$rownum] if defined $items[$rownum];
+    $biblioitem->{description} =
+      $itemtypes->{ $biblioitem->{itemtype} }{description};
+
+    foreach
+      my $itemnumber ( @{ $itemnumbers_of_biblioitem{$biblioitemnumber} } )
+    {
+               my $item = $itemhash{$itemnumber};
+
+        $item->{homebranchname} =
+          $branches->{ $item->{homebranch} }{branchname};
+
+        # if the holdingbranch is different than the homebranch, we show the
+        # holdingbranch of the document too
+        if ( $item->{homebranch} ne $item->{holdingbranch} ) {
+            $item->{holdingbranchname} =
+              $branches->{ $item->{holdingbranch} }{branchname};
+        }
+        
+#      add information
+       $item->{itemcallnumber} = $item->{itemcallnumber};
+       
+        # if the item is currently on loan, we display its return date and
+        # change the background color
+        my $issues= GetItemIssue($itemnumber);
+        if ( $issues->{'date_due'} ) {
+            $item->{date_due} = format_date($issues->{'date_due'});
+            $item->{backgroundcolor} = 'onloan';
+        }
+
+        # checking reserve
+        my ($reservedate,$reservedfor,$expectedAt) = GetReservesFromItemnumber($itemnumber);
+        my $ItemBorrowerReserveInfo = GetMemberDetails( $reservedfor, 0);
+
+        if ( defined $reservedate ) {
+            $item->{backgroundcolor} = 'reserved';
+            $item->{reservedate}     = format_date($reservedate);
+            $item->{ReservedForBorrowernumber}     = $reservedfor;
+            $item->{ReservedForSurname}     = $ItemBorrowerReserveInfo->{'surname'};
+            $item->{ReservedForFirstname}     = $ItemBorrowerReserveInfo->{'firstname'};
+            $item->{ExpectedAtLibrary}     = $expectedAt;
+            
+        }
+
+        # Management of the notforloan document
+        if ( $item->{notforloan} || $item->{itemnotforloan}) {
+            $item->{backgroundcolor} = 'other';
+            $item->{notforloanvalue} =
+              $notforloan_label_of->{ $item->{notforloan} };
+        }
+
+        # Management of lost or long overdue items
+        if ( $item->{itemlost} ) {
+
+            # FIXME localized strings should never be in Perl code
+            $item->{message} =
+                $item->{itemlost} == 1 ? "(lost)"
+              : $item->{itemlost} == 2 ? "(long overdue)"
+              : "";
+            $item->{backgroundcolor} = 'other';
+        }
+
+        # Check of the transfered documents
+        my ( $transfertwhen, $transfertfrom, $transfertto ) =
+          GetTransfers($itemnumber);
+
+        if ( $transfertwhen ne '' ) {
+            $item->{transfertwhen} = format_date($transfertwhen);
+            $item->{transfertfrom} =
+              $branches->{$transfertfrom}{branchname};
+            $item->{transfertto} = $branches->{$transfertto}{branchname};
+               $item->{nocancel} = 1;
+        }
+
+        # If there is no loan, return and transfer, we show a checkbox.
+        $item->{notforloan} = $item->{notforloan} || 0;
+
+        if (IsAvailableForItemLevelRequest($itemnumber)) {
+            $item->{available} = 1;
+        }
+
+       # FIXME: move this to a pm
+        my $dbh = C4::Context->dbh;
+        my $sth2 = $dbh->prepare("SELECT * FROM reserves WHERE borrowernumber=? AND itemnumber=? AND found='W'");
+        $sth2->execute($item->{ReservedForBorrowernumber},$item->{itemnumber});
+        while (my $wait_hashref = $sth2->fetchrow_hashref) {
+            $item->{waitingdate} = format_date($wait_hashref->{waitingdate});
+        }
+       $item->{imageurl} = getitemtypeimagelocation( 'opac', $itemtypes->{ $item->{itype} }{imageurl} );
+        push @{ $biblioitem->{itemloop} }, $item;
     }
-    my $last = @row;
-    $row[$last-1]->{'last'} =1 if $last == $width;
-    my $fill = ($width - $last)*2;
-    $fill-- if $fill;
-    push @typerows, {ROW => \@row, fill => $fill};
-}
-$template->param(TYPE_ROWS => \@typerows);
-$width = 2*$width -1;
-$template->param(totalwidth => 2*$width-1);
-
-if ($query->param('item_types_selected')) {
-       # this is what happens after the itemtypes have been selected. Stage 2
-       my @itemtypes = $query->param('itemtype');
-       my $fee = 0;
-       my $proceed = 0;
-       if (@itemtypes) {
-               my %newtypes;
-               foreach my $itmtype (@itemtypes) {
-               $newtypes{$itmtype} = $itemtypes{$itmtype};
-               }
-               my @types = values %newtypes;
-               $template->param(TYPES => \@types);
-               foreach my $type (@itemtypes) {
-               my @reqbibs;
-               foreach my $item (@items) {
-                       if ($item->{'itemtype'} eq $type) {
-                       push @reqbibs, $item->{'biblioitemnumber'};
-                       }
-               }
-               $fee += CalcReserveFee(undef,$borrowernumber,$biblionumber,'o',\@reqbibs);
-               }
-               $proceed = 1;
-       } elsif ($query->param('all')) {
-               $template->param(all => 1);
-               $fee = 1;
-               $proceed = 1;
-       }
-       warn "branch :$branch:";
-       if ($proceed && $branch) {
-               $fee = sprintf "%.02f", $fee;
-               $template->param(fee => $fee);
-               $template->param(item_types_selected => 1);
-       } else {
-               $template->param(message => 1);
-               $template->param(no_items_selected => 1) unless ($proceed);
-               $template->param(no_branch_selected =>1) unless ($branch);
-       }
-} elsif ($query->param('place_reserve')) {
-       # here we actually do the reserveration. Stage 3.
-       my $title = $bibdata->{'title'};
-       my @itemtypes = $query->param('itemtype');
-       foreach my $type (@itemtypes) {
-               my @reqbibs;
-               foreach my $item (@items) {
-               if ($item->{'itemtype'} eq $type) {
-                       push @reqbibs, $item->{'biblioitemnumber'};
-               }
-               }
-               CreateReserve(undef,$branch,$borrowernumber,$biblionumber,'o',\@reqbibs,$rank,'',$title);
-       }
-       if ($query->param('all')) {
-               CreateReserve(undef,$branch,$borrowernumber,$biblionumber,'a', undef, $rank,'',$title);
-       }
-       print $query->redirect("/cgi-bin/koha/opac-user.pl");
-} else {
-       # Here we check that the borrower can actually make reserves Stage 1.
-       my $noreserves = 0;
-       my $maxoutstanding = C4::Context->preference("maxoustanding");
-       if ($borr->{'amountoutstanding'} > $maxoutstanding) {
-               my $amount = sprintf "\$%.02f", $borr->{'amountoutstanding'};
-               $template->param(message => 1);
-               $noreserves = 1;
-               $template->param(too_much_oweing => $amount);
-       }
-       my ($resnum, $reserves) = FindReserves('', $borrowernumber);
-       $template->param(RESERVES => $reserves);
-       if ($resnum >= $MAXIMUM_NUMBER_OF_RESERVES) {
-               $template->param(message => 1);
-               $noreserves = 1;
-               $template->param(too_many_reserves => $resnum);
-       }
-       foreach my $res (@$reserves) {
-               if ($res->{'biblionumber'} == $biblionumber) {
-               $template->param(message => 1);
-               $noreserves = 1;
-               $template->param(already_reserved => 1);
-               }
-       }
-       unless ($noreserves) {
-               $template->param(TYPES => \@types_old);
-               $template->param(select_item_types => 1);
-       }
-}
 
-# check that you can actually make the reserve.
+    push @bibitemloop, $biblioitem;
+}
 
+# display infos
+$template->param(
+       forloan           => $forloan,
+    bibitemloop       => \@bibitemloop,
+);
 output_html_with_http_headers $query, $cookie, $template->output;
 
 # Local Variables: