Bug 30858: Add serial enumeration/chronology to item search
[srvgit] / circ / returns.pl
index 58a5e84..c118260 100755 (executable)
@@ -34,30 +34,27 @@ 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::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;
+use Koha::Recalls;
 
-my $query = new CGI;
+my $query = CGI->new;
 
 #getting the template
 my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
@@ -71,6 +68,7 @@ my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
 
 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') ) {
@@ -80,13 +78,22 @@ if ( $query->param('print_slip') ) {
     );
 }
 
+# print a recall slip
+if ( $query->param('recall_slip') ) {
+    $template->param(
+        recall_slip => 1,
+        recall_id => scalar $query->param('recall_id'),
+    );
+}
+
+
 #####################
 #Global vars
 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;
@@ -112,8 +119,7 @@ foreach ( $query->param ) {
     $counter++;
 
     # decode barcode    ## Didn't we already decode them before passing them back last time??
-    $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
-    $barcode = barcodedecode($barcode) if(C4::Context->preference('itemBarcodeInputFilter'));
+    $barcode = barcodedecode($barcode) if $barcode;
 
     ######################
     #Are these lines still useful ?
@@ -131,13 +137,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');
@@ -155,31 +156,47 @@ 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,
         );
     }
 }
 
+if ( $query->param('recall_id') ) {
+    my $recall = Koha::Recalls->find( scalar $query->param('recall_id') );
+    my $itemnumber = $query->param('itemnumber');
+    my $return_branch = $query->param('returnbranch');
+
+    if ($recall) {
+        my $item;
+        if ( !$recall->item_level ) {
+            $item = Koha::Items->find( $itemnumber );
+        }
+
+        if ( $recall->pickup_library_id ne $return_branch ) {
+            $recall->start_transfer({ item => $item }) if !$recall->in_transit;
+        } else {
+            my $expirationdate = $recall->calc_expirationdate;
+            $recall->set_waiting({ item => $item, expirationdate => $expirationdate }) if !$recall->waiting;
+        }
+    }
+}
+
 my $borrower;
 my $returned = 0;
 my $messages;
 my $issue;
-my $itemnumber;
 my $barcode     = $query->param('barcode');
 my $exemptfine  = $query->param('exemptfine');
 if (
@@ -193,6 +210,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();
@@ -230,9 +248,30 @@ 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});
+        if ( C4::Context->preference('UseRecalls') ) {
+            my $recall_transfer_deleted = Koha::Recalls->find({ item_id => $itemnumber, status => 'in_transit' });
+            if ( defined $recall_transfer_deleted ) {
+                $recall_transfer_deleted->revert_transfer;
+            }
+        }
+        $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 ( C4::Context->preference('UseRecalls') ) {
+        my $recall_transfer_deleted = Koha::Recalls->find({ item_id => $itemnumber, status => 'in_transit' });
+        if ( defined $recall_transfer_deleted ) {
+            $recall_transfer_deleted->revert_transfer;
+        }
+    }
     if($dest eq "ttr"){
         print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
         exit;
@@ -241,11 +280,11 @@ if ($canceltransfer){
     }
 }
 
+
 # actually return book and prepare item table.....
 my $returnbranch;
 if ($barcode) {
-    $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
-    $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
+    $barcode = barcodedecode($barcode) if $barcode;
     my $item = Koha::Items->find({ barcode => $barcode });
 
     if ( $item ) {
@@ -272,17 +311,13 @@ if ($barcode) {
         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,
             additional_materials => $materials,
             issue                => $checkout,
+            item                 => $item,
         );
     } # FIXME else we should not call AddReturn but set BadBarcode directly instead
 
@@ -295,17 +330,26 @@ 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 = 0;
-    if ( C4::Context->preference("CircConfirmItemParts") ) {
-        if ( $item->materials && !$query->param('multiple_confirm') ) {
-                $needs_confirm = 1;
-        }
-    }
+    my $needs_confirm =
+         C4::Context->preference("CircConfirmItemParts")
+      && $item
+      && $item->materials
+      && !$query->param('multiple_confirm');
+    $template->param( 'multiple_confirmed' => 1 )
+      if $query->param('multiple_confirm');
+
+    # Block return if bundle and confirm has not been received
+    my $bundle_confirm =
+         $item
+      && $item->is_bundle
+      && !$query->param('confirm_items_bundle_return');
+    $template->param( 'confirm_items_bundle_returned' => 1 )
+      if $query->param('confirm_items_bundle_return');
 
     # do the return
     ( $returned, $messages, $issue, $borrower ) =
       AddReturn( $barcode, $userenv_branch, $exemptfine, $return_date )
-      unless $needs_confirm;
+          unless ( $needs_confirm || $bundle_confirm );
 
     if ($returned) {
         my $time_now = dt_from_string()->truncate( to => 'minute');
@@ -346,7 +390,8 @@ if ($barcode) {
                 );
             }
         }
-    } elsif ( C4::Context->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} and !$needs_confirm ) {
+
+    } elsif ( C4::Context->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} and !$needs_confirm and !$bundle_confirm ) {
         $input{duedate}   = 0;
         $returneditems{0} = $barcode;
         $riduedate{0}     = 0;
@@ -357,13 +402,96 @@ if ($barcode) {
     if ( $needs_confirm ) {
         $template->param( needs_confirm => $needs_confirm );
     }
+
+    if ( $bundle_confirm ) {
+        $template->param(
+            items_bundle_return_confirmation => 1,
+        );
+    }
+
+    # Mark missing bundle items as lost and report unexpected items
+    if ( $item && $item->is_bundle && $query->param('confirm_items_bundle_return') ) {
+        my $BundleLostValue = C4::Context->preference('BundleLostValue');
+        my $barcodes = $query->param('verify-items-bundle-contents-barcodes');
+        my @barcodes = map { s/^\s+|\s+$//gr } ( split /\n/, $barcodes );
+        my $expected_items = { map { $_->barcode => $_ } $item->bundle_items->as_list };
+        my $verify_items = Koha::Items->search( { barcode => { 'in' => \@barcodes } } );
+        my @unexpected_items;
+        my @missing_items;
+        my @bundle_items;
+        while ( my $verify_item = $verify_items->next ) {
+            # Fix and lost statuses
+            $verify_item->itemlost(0);
+
+            # Update last_seen
+            $verify_item->datelastseen( dt_from_string()->ymd() );
+
+            # Update last_borrowed if actual checkin
+            $verify_item->datelastborrowed( dt_from_string()->ymd() ) if $issue;
+
+            # Expected item, remove from lookup table
+            if ( delete $expected_items->{$verify_item->barcode} ) {
+                push @bundle_items, $verify_item;
+            }
+            # Unexpected item, warn and remove from bundle
+            else {
+                $verify_item->remove_from_bundle;
+                push @unexpected_items, $verify_item;
+            }
+
+            # Store results
+            $verify_item->store();
+        }
+        for my $missing_item ( keys %{$expected_items} ) {
+            my $bundle_item = $expected_items->{$missing_item};
+            # Mark as lost if it's not already lost
+            if ( !$bundle_item->itemlost ) {
+                $bundle_item->itemlost($BundleLostValue)->store();
+
+                # Add return_claim record if this is an actual checkin
+                if ($issue) {
+                    $bundle_item->_result->create_related(
+                        'return_claims',
+                        {
+                            issue_id       => $issue->issue_id,
+                            itemnumber     => $bundle_item->itemnumber,
+                            borrowernumber => $issue->borrowernumber,
+                            created_by     => C4::Context->userenv()->{number},
+                            created_on     => dt_from_string
+                        }
+                    );
+                }
+                push @missing_items, $bundle_item;
+
+                # NOTE: We cannot use C4::LostItem here because the item itself doesn't have a checkout
+                # and thus would not get charged.. it's checked out as part of the bundle.
+                if ( C4::Context->preference('WhenLostChargeReplacementFee') && $issue ) {
+                    C4::Accounts::chargelostitem(
+                        $issue->borrowernumber,
+                        $bundle_item->itemnumber,
+                        $bundle_item->replacementprice,
+                        sprintf( "%s %s %s",
+                            $bundle_item->biblio->title  || q{},
+                            $bundle_item->barcode        || q{},
+                            $bundle_item->itemcallnumber || q{},
+                        ),
+                    );
+                }
+            }
+        }
+        $template->param(
+            unexpected_items => \@unexpected_items,
+            missing_items    => \@missing_items,
+            bundle_items     => \@bundle_items
+        );
+    }
 }
 $template->param( inputloop => \@inputloop );
 
-
 my $found    = 0;
 my $waiting  = 0;
 my $reserved = 0;
+my $recalled = 0;
 
 # new op dev : we check if the document must be returned to his homebranch directly,
 #  if the document is transferred, we have warning message .
@@ -371,7 +499,8 @@ my $reserved = 0;
 if ( $messages->{'WasTransfered'} ) {
     $template->param(
         found          => 1,
-        transfer       => 1,
+        transfer       => $messages->{'WasTransfered'},
+        trigger        => $messages->{'TransferTrigger'},
         itemnumber     => $itemnumber,
     );
 }
@@ -381,7 +510,6 @@ if ( $messages->{'NeedsTransfer'} ){
         found          => 1,
         needstransfer  => $messages->{'NeedsTransfer'},
         trigger        => $messages->{'TransferTrigger'},
-        itemnumber     => $itemnumber,
     );
 }
 
@@ -395,47 +523,54 @@ 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,
-    );
 }
 
 #
 # reserve found and item arrived at the expected branch
 #
-if ( $messages->{'ResFound'}) {
+if ( $messages->{'ResFound'} ) {
     my $reserve    = $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( $itemnumber, $reserve->{borrowernumber}, $diffBranchSend, $reserve->{reserve_id}, $desk_id );
         my ( $messages, $nextreservinfo ) = GetOtherReserves($reserve->{itemnumber});
 
         $template->param(
             hold_auto_filled => 1,
             print_slip       => C4::Context->preference('HoldsAutoFillPrintSlip'),
             reserve_id       => $nextreservinfo->{reserve_id},
-            itemnumber       => $itemnumber,
         );
 
         if ( $messages->{'transfert'} ) {
@@ -446,23 +581,14 @@ if ( $messages->{'ResFound'}) {
                 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,
-                itemnumber   => $itemnumber,
-            );
-        }
-
-    } # else { ; }  # error?
 
     # same params for Waiting or Reserved
     $template->param(
@@ -476,6 +602,40 @@ if ( $messages->{'ResFound'}) {
     );
 }
 
+if ( $messages->{RecallFound} ) {
+    my $recall = $messages->{RecallFound};
+    if ( dt_from_string( $recall->timestamp ) == dt_from_string ) {
+        # we just updated this recall
+        $template->param( recall => $recall );
+    } else {
+        my $transferbranch = $messages->{RecallNeedsTransfer};
+        my $transfertodo = ( !$transferbranch or $transferbranch eq $recall->library->branchcode ) ? undef : 1;
+        $template->param(
+            found => 1,
+            recall => $recall,
+            recalled => $recall->waiting ? 0 : 1,
+            transfertodo => $transfertodo,
+            waitingrecall => $recall->waiting ? 1 : 0,
+        );
+    }
+}
+
+if ( $messages->{TransferredRecall} ) {
+    my $recall = $messages->{TransferredRecall};
+
+    # confirm transfer has arrived at the branch
+    my $transfer = Koha::Item::Transfers->search({ datearrived => { '!=' => undef }, itemnumber => $recall->item_id }, { order_by => { -desc => 'datearrived' } })->next;
+
+    # if transfer has completed, show popup to confirm as waiting
+    if ( defined $transfer and $transfer->tobranch eq $recall->pickup_library_id ) {
+        $template->param(
+            found => 1,
+            recall => $recall,
+            recalled => 1,
+        );
+    }
+}
+
 # Error Messages
 my @errmsgloop;
 foreach my $code ( keys %$messages ) {
@@ -499,6 +659,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?
     }
@@ -523,6 +689,9 @@ foreach my $code ( keys %$messages ) {
     elsif ( $code eq 'TransferTrigger' ) {
         ;    # Handled alongside NeedsTransfer
     }
+    elsif ( $code eq 'TransferArrived' ) {
+        $err{transferred} = $messages->{'TransferArrived'};
+    }
     elsif ( $code eq 'Wrongbranch' ) {
     }
     elsif ( $code eq 'Debarred' ) {
@@ -548,6 +717,14 @@ foreach my $code ( keys %$messages ) {
     }
     elsif ( $code eq 'ReturnClaims' ) {
         $template->param( ReturnClaims => $messages->{ReturnClaims} );
+    } elsif ( $code eq 'RecallFound' ) {
+        ;
+    } elsif ( $code eq 'RecallNeedsTransfer' ) {
+        ;
+    } elsif ( $code eq 'TransferredRecall' ) {
+        ;
+    } elsif ( $code eq 'InBundle' ) {
+        $template->param( InBundle => $messages->{InBundle} );
     } else {
         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
@@ -613,7 +790,8 @@ foreach ( sort { $a <=> $b } keys %returneditems ) {
         $ri{itemnumber}          = $item->itemnumber;
         $ri{barcode}             = $bar_code;
         $ri{homebranch}          = $item->homebranch;
-        $ri{holdingbranch}       = $item->holdingbranch;
+        $ri{transferbranch}      = $item->get_transfer ? $item->get_transfer->tobranch : '';
+        $ri{damaged}             = $item->damaged;
 
         $ri{location} = $item->location;
         my $shelfcode = $ri{'location'};
@@ -649,13 +827,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' );