Bug 17600: Standardize our EXPORT_OK
[srvgit] / circ / returns.pl
index 456d0d1..914d5de 100755 (executable)
@@ -34,30 +34,29 @@ use Modern::Perl;
 use CGI qw ( -utf8 );
 use DateTime;
 
-use C4::Auth qw/:DEFAULT get_session/;
-use C4::Output;
-use C4::Circulation;
-use C4::Reserves;
-use C4::Biblio;
-use C4::Circulation;
+use C4::Auth qw( get_template_and_user get_session haspermission );
+use C4::Output qw( output_html_with_http_headers );
+use C4::Circulation qw( barcodedecode GetBranchItemRule AddReturn updateWrongTransfer LostItem );
+use C4::Reserves qw( ModReserve ModReserveAffect GetOtherReserves );
+use C4::Circulation qw( barcodedecode GetBranchItemRule AddReturn updateWrongTransfer LostItem );
 use C4::Context;
-use C4::Items;
-use C4::Koha;   # FIXME : is it still useful ?
+use C4::Items qw( ModItemTransfer );
 use C4::Members::Messaging;
 use C4::Members;
-use C4::Output;
-use C4::Reserves;
+use C4::Output qw( output_html_with_http_headers );
+use C4::Reserves qw( ModReserve ModReserveAffect GetOtherReserves );
 use C4::RotatingCollections;
 use Koha::AuthorisedValues;
 use Koha::BiblioFrameworks;
 use Koha::Calendar;
 use Koha::Checkouts;
-use Koha::DateUtils;
+use Koha::DateUtils qw( dt_from_string output_pref );
 use Koha::Holds;
 use Koha::Items;
+use Koha::Item::Transfers;
 use Koha::Patrons;
 
-my $query = new CGI;
+my $query = CGI->new;
 
 #getting the template
 my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
@@ -65,21 +64,19 @@ my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
         template_name   => "circ/returns.tt",
         query           => $query,
         type            => "intranet",
-        authnotrequired => 0,
         flagsrequired   => { circulate => "circulate_remaining_permissions" },
     }
 );
 
 my $sessionID = $query->cookie("CGISESSID");
 my $session = get_session($sessionID);
+my $desk_id = C4::Context->userenv->{"desk_id"} || '';
 
 # Print a reserve slip on this page
 if ( $query->param('print_slip') ) {
     $template->param(
         print_slip     => 1,
-        borrowernumber => scalar $query->param('borrowernumber'), # FIXME We should send a Koha::Patron and raise an error if not exist.
-        biblionumber   => scalar $query->param('biblionumber'),
-        itemnumber     => scalar $query->param('itemnumber'),
+        reserve_id => scalar $query->param('reserve_id'),
     );
 }
 
@@ -89,7 +86,7 @@ my $userenv = C4::Context->userenv;
 my $userenv_branch = $userenv->{'branch'} // '';
 my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
 
-my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
+my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') eq 'production');
 
 # Set up the item stack ....
 my %returneditems;
@@ -134,13 +131,8 @@ foreach ( $query->param ) {
 
 ############
 # Deal with the requests....
-
-if ($query->param('WT-itemNumber')){
-       updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
-}
-
+my $itemnumber = $query->param('itemnumber');
 if ( $query->param('reserve_id') ) {
-    my $itemnumber     = $query->param('itemnumber');
     my $borrowernumber = $query->param('borrowernumber');
     my $reserve_id     = $query->param('reserve_id');
     my $diffBranchReturned = $query->param('diffBranch');
@@ -158,20 +150,17 @@ if ( $query->param('reserve_id') ) {
         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( $itemnumber, $borrowernumber, $diffBranchSend, $reserve_id );
+        ModReserveAffect( $itemnumber, $borrowernumber, $diffBranchSend, $reserve_id, $desk_id );
     }
 #   check if we have other reserves for this document, if we have a return send the message of transfer
     my ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
 
     my $patron = Koha::Patrons->find( $nextreservinfo );
-    my $name   = $patron ? $patron->surname . ", " . $patron->title . " " . $patron->firstname : '';
     if ( $messages->{'transfert'} ) {
         $template->param(
             itemtitle      => $biblio->title,
-            itemnumber     => $item->itemnumber,
             itembiblionumber => $biblio->biblionumber,
             iteminfo       => $biblio->author,
-            name           => $name,
             patron         => $patron,
             diffbranch     => 1,
         );
@@ -182,7 +171,6 @@ my $borrower;
 my $returned = 0;
 my $messages;
 my $issue;
-my $itemnumber;
 my $barcode     = $query->param('barcode');
 my $exemptfine  = $query->param('exemptfine');
 if (
@@ -196,6 +184,7 @@ if (
 my $dropboxmode = $query->param('dropboxmode');
 my $dotransfer  = $query->param('dotransfer');
 my $canceltransfer = $query->param('canceltransfer');
+my $transit = $query->param('transit');
 my $dest = $query->param('dest');
 #dropbox: get last open day (today - 1)
 my $dropboxdate = Koha::Checkouts::calculate_dropbox_date();
@@ -233,9 +222,18 @@ if ($dotransfer){
     ModItemTransfer($transferitem, $userenv_branch, $tobranch, $trigger);
 }
 
-if ($canceltransfer){
-    $itemnumber=$query->param('itemnumber');
-    DeleteTransfer($itemnumber);
+if ($transit) {
+    my $transfer = Koha::Item::Transfers->find($transit);
+    if ( $canceltransfer ) {
+        $transfer->cancel({ reason => 'Manual', force => 1});
+        $template->param( transfercancelled => 1);
+    } else {
+        $transfer->transit;
+    }
+} elsif ($canceltransfer){
+    my $item = Koha::Items->find($itemnumber);
+    my $transfer = $item->get_transfer;
+    $transfer->cancel({ reason => 'Manual', force => 1});
     if($dest eq "ttr"){
         print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
         exit;
@@ -244,6 +242,7 @@ if ($canceltransfer){
     }
 }
 
+
 # actually return book and prepare item table.....
 my $returnbranch;
 if ($barcode) {
@@ -274,18 +273,14 @@ if ($barcode) {
         my $checkout = $item->checkout;
         my $biblio   = $item->biblio;
         $template->param(
-            title            => $biblio->title,
-            homebranch       => $item->homebranch,
-            holdingbranch    => $item->holdingbranch,
-            returnbranch     => $returnbranch,
-            author           => $biblio->author,
-            itembarcode      => $item->barcode,
-            itemtype         => $item->effective_itemtype,
-            ccode            => $item->ccode,
-            itembiblionumber => $biblio->biblionumber,
-            biblionumber     => $biblio->biblionumber,
+            title                => $biblio->title,
+            returnbranch         => $returnbranch,
+            author               => $biblio->author,
+            itembiblionumber     => $biblio->biblionumber,
+            biblionumber         => $biblio->biblionumber,
             additional_materials => $materials,
-            issue            => $checkout,
+            issue                => $checkout,
+            item                 => $item,
         );
     } # FIXME else we should not call AddReturn but set BadBarcode directly instead
 
@@ -297,12 +292,22 @@ if ($barcode) {
 
     my $return_date = $dropboxmode ? $dropboxdate : $return_date_override_dt;
 
+    # Block return if multi-part and confirm has not been received
+    my $needs_confirm =
+         C4::Context->preference("CircConfirmItemParts")
+      && $item
+      && $item->materials
+      && !$query->param('multiple_confirm');
+    $template->param( 'multiple_confirmed' => 1 )
+      if $query->param('multiple_confirm');
+
     # do the return
     ( $returned, $messages, $issue, $borrower ) =
-      AddReturn( $barcode, $userenv_branch, $exemptfine, $return_date );
+      AddReturn( $barcode, $userenv_branch, $exemptfine, $return_date )
+          unless $needs_confirm;
 
     if ($returned) {
-        my $time_now = DateTime->now( time_zone => C4::Context->tz )->truncate( to => 'minute');
+        my $time_now = dt_from_string()->truncate( to => 'minute');
         my $date_due_dt = dt_from_string( $issue->date_due, 'sql' );
         my $duedate = $date_due_dt->strftime('%Y-%m-%d %H:%M');
         $returneditems{0}      = $barcode;
@@ -311,7 +316,7 @@ if ($barcode) {
         $input{borrowernumber} = $borrower->{'borrowernumber'};
         $input{duedate}        = $duedate;
         unless ( $dropboxmode ) {
-            $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, DateTime->now()) == -1);
+            $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, dt_from_string()) == -1);
         } else {
             $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, $dropboxdate) == -1);
         }
@@ -340,13 +345,17 @@ if ($barcode) {
                 );
             }
         }
-    } elsif ( C4::Context->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} ) {
+    } elsif ( C4::Context->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} and !$needs_confirm ) {
         $input{duedate}   = 0;
         $returneditems{0} = $barcode;
         $riduedate{0}     = 0;
         push( @inputloop, \%input );
     }
     $template->param( privacy => $borrower->{privacy} );
+
+    if ( $needs_confirm ) {
+        $template->param( needs_confirm => $needs_confirm );
+    }
 }
 $template->param( inputloop => \@inputloop );
 
@@ -360,7 +369,8 @@ my $reserved = 0;
 if ( $messages->{'WasTransfered'} ) {
     $template->param(
         found          => 1,
-        transfer       => 1,
+        transfer       => $messages->{'WasTransfered'},
+        trigger        => $messages->{'TransferTrigger'},
         itemnumber     => $itemnumber,
     );
 }
@@ -370,7 +380,6 @@ if ( $messages->{'NeedsTransfer'} ){
         found          => 1,
         needstransfer  => $messages->{'NeedsTransfer'},
         trigger        => $messages->{'TransferTrigger'},
-        itemnumber     => $itemnumber,
     );
 }
 
@@ -384,24 +393,28 @@ if ( $messages->{'Wrongbranch'} ){
 # case of wrong transfert, if the document wasn't transferred to the right library (according to branchtransfer (tobranch) BDD)
 
 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
+
+    # Trigger modal to prompt librarian
     $template->param(
         WrongTransfer  => 1,
         TransferWaitingAt => $messages->{'WrongTransfer'},
         WrongTransferItem => $messages->{'WrongTransferItem'},
-        itemnumber => $itemnumber,
+        trigger           => $messages->{'TransferTrigger'},
+    );
+
+    # Update the transfer to reflect the new item holdingbranch
+    my $new_transfer = updateWrongTransfer($messages->{'WrongTransferItem'},$messages->{'WrongTransfer'}, $userenv_branch);
+    $template->param(
+        NewTransfer => $new_transfer->id
     );
 
     my $reserve    = $messages->{'ResFound'};
     if ( $reserve ) {
         my $patron = Koha::Patrons->find( $reserve->{'borrowernumber'} );
-        my $name = $patron->surname . ", " . $patron->title . " " . $patron->firstname;
         $template->param(
             patron => $patron,
         );
     }
-    $template->param(
-        wtransfertFrom  => $userenv_branch,
-    );
 }
 
 #
@@ -412,49 +425,40 @@ if ( $messages->{'ResFound'}) {
     my $patron = Koha::Patrons->find( $reserve->{borrowernumber} );
     my $holdmsgpreferences =  C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $reserve->{'borrowernumber'}, message_name   => 'Hold_Filled' } );
     my $branchCheck = ( $userenv_branch eq $reserve->{branchcode} );
-    if ( $reserve->{'ResFound'} eq "Reserved" && C4::Context->preference('HoldsAutoFill') ) {
+    if ( $reserve->{'ResFound'} eq "Waiting" ) {
+        $template->param(
+            waiting      => $branchCheck ? 1 : undef,
+        );
+    } elsif ( C4::Context->preference('HoldsAutoFill') ) {
         my $item = Koha::Items->find( $itemnumber );
         my $biblio = $item->biblio;
 
         my $diffBranchSend = !$branchCheck ? $reserve->{branchcode} : undef;
-        ModReserveAffect( $reserve->{itemnumber}, $reserve->{borrowernumber}, $diffBranchSend, $reserve->{reserve_id} );
+        ModReserveAffect( $reserve->{itemnumber}, $reserve->{borrowernumber}, $diffBranchSend, $reserve->{reserve_id}, $desk_id );
         my ( $messages, $nextreservinfo ) = GetOtherReserves($reserve->{itemnumber});
 
-        my $patron = Koha::Patrons->find( $nextreservinfo );
-
         $template->param(
             hold_auto_filled => 1,
             print_slip       => C4::Context->preference('HoldsAutoFillPrintSlip'),
-            patron           => $patron,
-            borrowernumber   => $patron->id,
-            biblionumber     => $biblio->id,
+            reserve_id       => $nextreservinfo->{reserve_id},
         );
 
         if ( $messages->{'transfert'} ) {
             $template->param(
-                itemtitle      => $biblio->title,
-                itemnumber     => $item->itemnumber,
+                itemtitle        => $biblio->title,
                 itembiblionumber => $biblio->biblionumber,
-                iteminfo       => $biblio->author,
-                diffbranch     => 1,
+                iteminfo         => $biblio->author,
+                diffbranch       => 1,
             );
         }
+    } else {
+        $template->param(
+            intransit    => $branchCheck ? undef : 1,
+            transfertodo => $branchCheck ? undef : 1,
+            reserve_id   => $reserve->{reserve_id},
+            reserved     => 1,
+        );
     }
-    elsif ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
-        if ( $reserve->{'ResFound'} eq "Waiting" ) {
-            $template->param(
-                waiting      => $branchCheck ? 1 : undef,
-            );
-        } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
-            $template->param(
-                intransit    => $branchCheck ? undef : 1,
-                transfertodo => $branchCheck ? undef : 1,
-                reserve_id   => $reserve->{reserve_id},
-                reserved     => 1,
-            );
-        }
-
-    } # else { ; }  # error?
 
     # same params for Waiting or Reserved
     $template->param(
@@ -462,7 +466,6 @@ if ( $messages->{'ResFound'}) {
         patron         => $patron,
         barcode        => $barcode,
         destbranch     => $reserve->{'branchcode'},
-        itemnumber     => $reserve->{'itemnumber'},
         reservenotes   => $reserve->{'reservenotes'},
         reserve_id     => $reserve->{reserve_id},
         bormessagepref => $holdmsgpreferences->{'transports'},
@@ -492,6 +495,12 @@ foreach my $code ( keys %$messages ) {
     elsif ( $code eq 'LostItemFeeRefunded' ) {
         $template->param( LostItemFeeRefunded => 1 );
     }
+    elsif ( $code eq 'LostItemFeeCharged' ) {
+        $template->param( LostItemFeeCharged => 1 );
+    }
+    elsif ( $code eq 'LostItemFeeRestored' ) {
+        $template->param( LostItemFeeRestored => 1 );
+    }
     elsif ( $code eq 'ResFound' ) {
         ;    # FIXME... anything to do here?
     }
@@ -513,6 +522,12 @@ foreach my $code ( keys %$messages ) {
     }
     elsif ( $code eq 'NeedsTransfer' ) {
     }
+    elsif ( $code eq 'TransferTrigger' ) {
+        ;    # Handled alongside NeedsTransfer
+    }
+    elsif ( $code eq 'TransferArrived' ) {
+        $err{transferred} = $messages->{'TransferArrived'};
+    }
     elsif ( $code eq 'Wrongbranch' ) {
     }
     elsif ( $code eq 'Debarred' ) {
@@ -569,7 +584,7 @@ foreach ( sort { $a <=> $b } keys %returneditems ) {
             $ri{duedate} = output_pref($duedate);
             my $patron = Koha::Patrons->find( $riborrowernumber{$_} );
             unless ( $dropboxmode ) {
-                $ri{return_overdue} = 1 if (DateTime->compare($duedate, DateTime->now()) == -1);
+                $ri{return_overdue} = 1 if (DateTime->compare($duedate, dt_from_string()) == -1);
             } else {
                 $ri{return_overdue} = 1 if (DateTime->compare($duedate, $dropboxdate) == -1);
             }
@@ -604,6 +619,7 @@ foreach ( sort { $a <=> $b } keys %returneditems ) {
         $ri{barcode}             = $bar_code;
         $ri{homebranch}          = $item->homebranch;
         $ri{holdingbranch}       = $item->holdingbranch;
+        $ri{damaged}             = $item->damaged;
 
         $ri{location} = $item->location;
         my $shelfcode = $ri{'location'};
@@ -639,13 +655,14 @@ if ( $barcode ) {
                 $template->param(
                   collectionItemNeedsTransferred => 1,
                   collectionBranch => $collectionBranch,
-                  itemnumber => $itemnumber,
                 );
             }
         }
     }
 }
 
+$template->param( itemnumber => $itemnumber );
+
 # Checking if there is a Fast Cataloging Framework
 $template->param( fast_cataloging => 1 ) if Koha::BiblioFrameworks->find( 'FA' );