Bug Fixing : returns.pl compile error $duedate undefined
[koha.git] / circ / returns.pl
index 8e1d6cc..c75496d 100755 (executable)
@@ -41,7 +41,7 @@ use C4::Reserves;
 use C4::Biblio;
 use C4::Items;
 use C4::Members;
-use C4::Branch; # GetBranchName
+use C4::Branch; # GetBranches GetBranchName
 use C4::Koha;   # FIXME : is it still useful ?
 
 my $query = new CGI;
@@ -63,7 +63,7 @@ my ( $template, $librarian, $cookie ) = get_template_and_user(
         query           => $query,
         type            => "intranet",
         authnotrequired => 0,
-        flagsrequired   => { circulate => 1 },
+        flagsrequired   => { circulate => "circulate_remaining_permissions" },
     }
 );
 
@@ -73,8 +73,10 @@ my $branches = GetBranches();
 my $printers = GetPrinters();
 
 #my $branch  = C4::Context->userenv?C4::Context->userenv->{'branch'}:"";
-my $printer = C4::Context->userenv?C4::Context->userenv->{'branchprinter'}:"";
+my $printer = C4::Context->userenv ? C4::Context->userenv->{'branchprinter'} : "";
 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
+
+my $userenv_branch = C4::Context->userenv->{'branch'} || '';
 #
 # Some code to handle the error if there is no branch or printer setting.....
 #
@@ -94,7 +96,7 @@ foreach ( $query->param ) {
     my $borrowernumber = $query->param("bn-$counter");
     $counter++;
 
-    # decode barcode
+    # decode barcode    ## Didn't we already decode them before passing them back last time??
     $barcode = barcodedecode($barcode) if(C4::Context->preference('itemBarcodeInputFilter'));
 
     ######################
@@ -123,44 +125,30 @@ if ( $query->param('resbarcode') ) {
     my $borrowernumber = $query->param('borrowernumber');
     my $resbarcode     = $query->param('resbarcode');
     my $diffBranchReturned = $query->param('diffBranch');
-    # set to waiting....
     my $iteminfo   = GetBiblioFromItemNumber($item);
     # fix up item type for display
     $iteminfo->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $iteminfo->{'itype'} : $iteminfo->{'itemtype'};
-    my $diffBranchSend;
-    
-#     addin in ModReserveAffect the possibility to check if the document is expected in this library or not,
-# if not we send a value in reserve waiting for not implementting waiting status
-    if ($diffBranchReturned) {
-        $diffBranchSend = $diffBranchReturned;
-    }
-    else {
-        $diffBranchSend = undef;
-    }
-    ModReserveAffect( $item, $borrowernumber,$diffBranchSend);
-#   check if we have other reservs for this document, if we have a return send the message of transfer
+    my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
+# diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
+# i.e., whether to apply waiting status
+    ModReserveAffect( $item, $borrowernumber, $diffBranchSend);
+#   check if we have other reserves for this document, if we have a return send the message of transfer
     my ( $messages, $nextreservinfo ) = GetOtherReserves($item);
 
-    my $branchname = GetBranchName( $messages->{'transfert'} );
     my ($borr) = GetMemberDetails( $nextreservinfo, 0 );
-    my $borcnum = $borr->{'cardnumber'};
-    my $name    =
-      $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
-    my $slip = $query->param('resslip');
-
-
+    my $name   = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
     if ( $messages->{'transfert'} ) {
         $template->param(
             itemtitle      => $iteminfo->{'title'},
                        itembiblionumber => $iteminfo->{'biblionumber'},
             iteminfo       => $iteminfo->{'author'},
-            tobranchname   => $branchname,
+            tobranchname   => GetBranchName($messages->{'transfert'}),
             name           => $name,
             borrowernumber => $borrowernumber,
-            borcnum        => $borcnum,
+            borcnum        => $borr->{'cardnumber'},
             borfirstname   => $borr->{'firstname'},
             borsurname     => $borr->{'surname'},
-            diffbranch     => 1
+            diffbranch     => 1,
         );
     }
 }
@@ -169,34 +157,36 @@ my $borrower;
 my $returned = 0;
 my $messages;
 my $issueinformation;
-my $barcode = $query->param('barcode');
-# strip whitespace
-# $barcode =~ s/\s*//g; - use barcodedecode for this; whitespace is not invalid.
-my $exemptfine = $query->param('exemptfine');
-my $dropboxmode= $query->param('dropboxmode');
-my $calendar = C4::Calendar->new(  branchcode => C4::Context->userenv->{'branch'} );
+my $itemnumber;
+my $barcode     = $query->param('barcode');
+my $exemptfine  = $query->param('exemptfine');
+my $dropboxmode = $query->param('dropboxmode');
+my $dotransfer  = $query->param('dotransfer');
+my $calendar    = C4::Calendar->new( branchcode => $userenv_branch );
        #dropbox: get last open day (today - 1)
 my $today       = C4::Dates->new();
 my $today_iso   = $today->output('iso');
-my $dropboxdate = $calendar->addDate($today, -1 );
-my $dotransfer = $query->param('dotransfer');
+my $dropboxdate = $calendar->addDate($today, -1);
 if ($dotransfer){
-       # An item has been returned to a branch other than the homebranch, and the librarian has choosen to initiate a transfer
-       my $transferitem=$query->param('transferitem');
-       my $tobranch=$query->param('tobranch');
-       ModItemTransfer($transferitem, C4::Context->userenv->{'branch'}, $tobranch); 
+       # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
+       my $transferitem = $query->param('transferitem');
+       my $tobranch     = $query->param('tobranch');
+       ModItemTransfer($transferitem, $userenv_branch, $tobranch); 
 }
 
 # actually return book and prepare item table.....
 if ($barcode) {
-    $barcode = barcodedecode($barcode)  if(C4::Context->preference('itemBarcodeInputFilter'));
+    $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
 #
 # save the return
 #
+    $itemnumber = GetItemnumberFromBarcode($barcode);
+
     ( $returned, $messages, $issueinformation, $borrower ) =
-      AddReturn( $barcode, C4::Context->userenv->{'branch'}, $exemptfine, $dropboxmode);
+      AddReturn( $barcode, $userenv_branch, $exemptfine, $dropboxmode);     # do the return
+
     # get biblio description
-    my $biblio = GetBiblioFromItemNumber($issueinformation->{'itemnumber'});
+    my $biblio = GetBiblioFromItemNumber($itemnumber);
     # fix up item type for display
     $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
 
@@ -210,41 +200,38 @@ if ($barcode) {
         itembiblionumber => $biblio->{'biblionumber'},    
     );
 
+    my %input = (
+        counter => 0,
+        first   => 1,
+        barcode => $barcode,
+    );
+
     if ($returned) {
         $returneditems{0}    = $barcode;
         $riborrowernumber{0} = $borrower->{'borrowernumber'};
         $riduedate{0}        = $issueinformation->{'date_due'};
-        my %input;
-        $input{counter}        = 0;
-        $input{first}          = 1;
-        $input{barcode}        = $barcode;
         $input{borrowernumber} = $borrower->{'borrowernumber'};
-        $input{duedate}        = $issueinformation->{'date_due'};
-        $input{return_overdue} = 1 if ($issueinformation->{'date_due'} lt $today->output('iso'));
+        $input{duedate}        = $riduedate{0};
+        $input{return_overdue} = 1 if ($riduedate{0} and $riduedate{0} lt $today->output('iso'));
         push( @inputloop, \%input );
 
         # check if the branch is the same as homebranch
         # if not, we want to put a message
-        if ( $biblio->{'homebranch'} ne C4::Context->userenv->{'branch'} ) {
+        if ( $biblio->{'homebranch'} ne $userenv_branch ) {
             $template->param( homebranch => $biblio->{'homebranch'} );
         }
     }
     elsif ( !$messages->{'BadBarcode'} ) {
-        my %input;
-        $input{counter} = 0;
-        $input{first}   = 1;
-        $input{barcode} = $barcode;
-        $input{duedate} = 0;
-
+        $input{duedate}   = 0;
         $returneditems{0} = $barcode;
         $riduedate{0}     = 0;
         if ( $messages->{'wthdrawn'} ) {
             $input{withdrawn}      = 1;
-            $input{borrowernumber} = 'Item Cancelled';
+            $input{borrowernumber} = 'Item Cancelled';  # FIXME: should be in display layer ?
             $riborrowernumber{0}   = 'Item Cancelled';
         }
         else {
-            $input{borrowernumber} = ' ';
+            $input{borrowernumber} = ' ';  # This seems clearly bogus.
             $riborrowernumber{0}   = ' ';
         }
         push( @inputloop, \%input );
@@ -270,7 +257,7 @@ if ( $messages->{'NeedsTransfer'} ){
        $template->param(
                found          => 1,
                needstransfer  => 1,
-               itemnumber => $issueinformation->{'itemnumber'}
+               itemnumber     => $itemnumber,
        );
 }
 
@@ -280,7 +267,7 @@ if ( $messages->{'Wrongbranch'} ){
        );
 }
 
-# adding a case of wrong transfert, if the document wasn't transfered in the good library (according to branchtransfer (tobranch) BDD)
+# case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
 
 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
        $template->param(
@@ -289,11 +276,10 @@ if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
         WrongTransferItem => $messages->{'WrongTransferItem'},
     );
 
-    my $reserve        = $messages->{'ResFound'};
+    my $reserve    = $messages->{'ResFound'};
     my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
     my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
-    my $name =
-      $borr->{'surname'} . " " . $borr->{'title'} . " " . $borr->{'firstname'};
+    my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
     $template->param(
             wname           => $name,
             wborfirstname   => $borr->{'firstname'},
@@ -307,29 +293,38 @@ if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
             wborzip         => $borr->{'zipcode'},
             wborrowernumber => $reserve->{'borrowernumber'},
             wborcnum        => $borr->{'cardnumber'},
-            wtransfertFrom  => C4::Context->userenv->{'branch'},
+            wtransfertFrom  => $userenv_branch,
     );
 }
 
-
 #
 # reserve found and item arrived at the expected branch
 #
 if ( $messages->{'ResFound'}) {
-    my $reserve        = $messages->{'ResFound'};
+    my $reserve    = $messages->{'ResFound'};
     my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
     my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
-    if ( $reserve->{'ResFound'} eq "Waiting" ) {
-        if ( C4::Context->userenv->{'branch'} eq $reserve->{'branchcode'} ) {
-            $template->param( waiting => 1 );
-        }
-        else {
-            $template->param( waiting => 0 );
+
+    if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
+        if ( $reserve->{'ResFound'} eq "Waiting" ) {
+            $template->param(
+                waiting      => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
+            );
+        } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
+            $template->param(
+                intransit    => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
+                transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
+                resbarcode   => $barcode,
+                reserved     => 1,
+            );
         }
 
+        # same params for Waiting or Reserved
         $template->param(
             found          => 1,
-            name           => $borr->{'surname'} . " " . $borr->{'title'} . " " . $borr->{'firstname'},
+            currentbranch  => $branches->{$userenv_branch}->{'branchname'},
+            destbranchname => $branches->{ $reserve->{'branchcode'} }->{'branchname'},
+            name           => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
             borfirstname   => $borr->{'firstname'},
             borsurname     => $borr->{'surname'},
             bortitle       => $borr->{'title'},
@@ -339,62 +334,20 @@ if ( $messages->{'ResFound'}) {
             boraddress2    => $borr->{'address2'},
             borcity        => $borr->{'city'},
             borzip         => $borr->{'zipcode'},
-            borrowernumber => $reserve->{'borrowernumber'},
             borcnum        => $borr->{'cardnumber'},
             debarred       => $borr->{'debarred'},
             gonenoaddress  => $borr->{'gonenoaddress'},
-            currentbranch  => $branches->{C4::Context->userenv->{'branch'}}->{'branchname'},
-            itemnumber     => $reserve->{'itemnumber'},
             barcode        => $barcode,
-            destbranchname =>
-              $branches->{ $reserve->{'branchcode'} }->{'branchname'},
             destbranch    => $reserve->{'branchcode'},
+            borrowernumber => $reserve->{'borrowernumber'},
+            itemnumber     => $reserve->{'itemnumber'},
         );
-
-    }
-    if ( $reserve->{'ResFound'} eq "Reserved" ) {
-        if ( C4::Context->userenv->{'branch'} eq $reserve->{'branchcode'} ) {
-            $template->param( intransit => 0 );
-        }
-        else {
-            $template->param( intransit => 1 );
-        }
-
-        $template->param(
-            found          => 1,
-            currentbranch  => $branches->{C4::Context->userenv->{'branch'}}->{'branchname'},
-            destbranchname =>
-              $branches->{ $reserve->{'branchcode'} }->{'branchname'},
-            destbranch    => $reserve->{'branchcode'},
-            transfertodo => ( C4::Context->userenv->{'branch'} eq $reserve->{'branchcode'} ? 0 : 1 ),
-            reserved => 1,
-            resbarcode       => $barcode,
-          #  today            => $todaysdate,
-            itemnumber       => $reserve->{'itemnumber'},
-            borsurname       => $borr->{'surname'},
-            bortitle         => $borr->{'title'},
-            borfirstname     => $borr->{'firstname'},
-            borrowernumber   => $reserve->{'borrowernumber'},
-            borcnum          => $borr->{'cardnumber'},
-            borphone         => $borr->{'phone'},
-            boraddress       => $borr->{'address'},
-            boraddress2      => $borr->{'address2'},
-            borsub           => $borr->{'suburb'},
-            borcity          => $borr->{'city'},
-            borzip           => $borr->{'zipcode'},
-            boremail         => $borr->{'email'},
-            debarred         => $borr->{'debarred'},
-            gonenoaddress    => $borr->{'gonenoaddress'},
-            barcode          => $barcode
-        );
-    }
+    } # else { ; }  # error?
 }
 
 # Error Messages
 my @errmsgloop;
 foreach my $code ( keys %$messages ) {
-
-    #    warn $code;
     my %err;
     my $exit_required_p = 0;
     if ( $code eq 'BadBarcode' ) {
@@ -422,7 +375,7 @@ foreach my $code ( keys %$messages ) {
         $exit_required_p = 1;
     }
     elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
-        if ( $messages->{'IsPermanent'} ne C4::Context->userenv->{'branch'} ) {
+        if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
             $err{ispermanent} = 1;
             $err{msg}         =
               $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
@@ -434,13 +387,14 @@ foreach my $code ( keys %$messages ) {
     elsif ( $code eq 'WrongTransferItem' ) {
         ;    # FIXME... anything to do here?
     }
-       elsif ( $code eq 'NeedsTransfer' ) {
-       }
-       elsif ( $code eq 'Wrongbranch' ) {
-       }
+    elsif ( $code eq 'NeedsTransfer' ) {
+    }
+    elsif ( $code eq 'Wrongbranch' ) {
+    }
                
     else {
-        die "Unknown error code $code";    # XXX
+        die "Unknown error code $code";    # note we need all the (empty) elsif's above, or we die.
+        # This forces the issue of staying in sync w/ Circulation.pm
     }
     if (%err) {
         push( @errmsgloop, \%err );
@@ -471,16 +425,13 @@ if ($borrower) {
             my @waitingitemloop;
             my $items = $flags->{$flag}->{'itemlist'};
             foreach my $item (@$items) {
-                my $biblio =
-                  GetBiblioFromItemNumber( $item->{'itemnumber'});
-                my %waitingitem;
-                $waitingitem{biblionum} = $biblio->{'biblionumber'};
-                $waitingitem{barcode}   = $biblio->{'barcode'};
-                $waitingitem{title}     = $biblio->{'title'};
-                $waitingitem{brname}    =
-                  $branches->{ $biblio->{'holdingbranch'} }
-                  ->{'branchname'};
-                push( @waitingitemloop, \%waitingitem );
+                my $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'});
+                push @waitingitemloop, {
+                    biblionum => $biblio->{'biblionumber'},
+                    barcode   => $biblio->{'barcode'},
+                    title     => $biblio->{'title'},
+                    brname    => $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
+                };
             }
             $flaginfo{itemloop} = \@waitingitemloop;
         }
@@ -491,14 +442,13 @@ if ($borrower) {
                 @$items )
             {
                 my $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'});
-                my %overdueitem;
-                $overdueitem{duedate}   = format_date( $item->{'date_due'} );
-                $overdueitem{biblionum} = $biblio->{'biblionumber'};
-                $overdueitem{barcode}   = $biblio->{'barcode'};
-                $overdueitem{title}     = $biblio->{'title'};
-                $overdueitem{brname}    =
-                  $branches->{ $biblio->{'holdingbranch'}} ->{'branchname'};
-                push( @itemloop, \%overdueitem );
+                push @itemloop, {
+                    duedate   => format_date($item->{'date_due'}),
+                    biblionum => $biblio->{'biblionumber'},
+                    barcode   => $biblio->{'barcode'},
+                    title     => $biblio->{'title'},
+                    brname    => $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
+                };
             }
             $flaginfo{itemloop} = \@itemloop;
             $flaginfo{overdue}  = 1;
@@ -521,11 +471,12 @@ if ($borrower) {
 }
 
 #set up so only the last 8 returned items display (make for faster loading pages)
+my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
 my $count = 0;
 my @riloop;
 foreach ( sort { $a <=> $b } keys %returneditems ) {
     my %ri;
-    if ( $count++ < 8 ) {
+    if ( $count++ < $returned_counter ) {
         my $barcode = $returneditems{$_};
         my $duedate = $riduedate{$_};
         my $overduetext;
@@ -536,16 +487,15 @@ foreach ( sort { $a <=> $b } keys %returneditems ) {
             $ri{month} = $tempdate[1];
             $ri{day}   = $tempdate[2];
             $ri{duedate} = format_date($duedate);
-            my ($borrower) =
-              GetMemberDetails( $riborrowernumber{$_}, 0 );
-            $ri{return_overdue} = 1 if ($duedate < $today->output('iso'));
+            my ($borrower) = GetMemberDetails( $riborrowernumber{$_}, 0 );
+            $ri{return_overdue} = 1 if ($duedate lt $today->output('iso'));
             $ri{borrowernumber} = $borrower->{'borrowernumber'};
             $ri{borcnum}        = $borrower->{'cardnumber'};
             $ri{borfirstname}   = $borrower->{'firstname'};
             $ri{borsurname}     = $borrower->{'surname'};
             $ri{bortitle}       = $borrower->{'title'};
             $ri{bornote}        = $borrower->{'borrowernotes'};
-            $ri{borcategorycode}   = $borrower->{'categorycode'};
+            $ri{borcategorycode}= $borrower->{'categorycode'};
         }
         else {
             $ri{borrowernumber} = $riborrowernumber{$_};
@@ -569,18 +519,18 @@ foreach ( sort { $a <=> $b } keys %returneditems ) {
     }
     push( @riloop, \%ri );
 }
-$template->param( riloop => \@riloop );
 
 $template->param(
-    genbrname               => $branches->{C4::Context->userenv->{'branch'}}->{'branchname'},
-    genprname               => $printers->{$printer}->{'printername'},
-    branchname              => $branches->{C4::Context->userenv->{'branch'}}->{'branchname'},
-    printer                 => $printer,
-    errmsgloop              => \@errmsgloop,
-    exemptfine              => $exemptfine,
-    dropboxmode             => $dropboxmode,
-    dropboxdate                                => $dropboxdate->output(),
-       overduecharges          => $overduecharges,
+    riloop         => \@riloop,
+    genbrname      => $branches->{$userenv_branch}->{'branchname'},
+    genprname      => $printers->{$printer}->{'printername'},
+    branchname     => $branches->{$userenv_branch}->{'branchname'},
+    printer        => $printer,
+    errmsgloop     => \@errmsgloop,
+    exemptfine     => $exemptfine,
+    dropboxmode    => $dropboxmode,
+    dropboxdate           => $dropboxdate->output(),
+    overduecharges => $overduecharges,
 );
 
 # actually print the page!