Bug 17738: Replace GetReservesFromBorrowernumber with Koha::Patron->get_holds
[koha-ffzg.git] / circ / returns.pl
index 4a13711..a6041d1 100755 (executable)
@@ -44,16 +44,20 @@ use C4::Reserves;
 use C4::Biblio;
 use C4::Items;
 use C4::Members;
-use C4::Branch; # GetBranches GetBranchName
+use C4::Members::Messaging;
 use C4::Koha;   # FIXME : is it still useful ?
 use C4::RotatingCollections;
+use Koha::AuthorisedValues;
 use Koha::DateUtils;
 use Koha::Calendar;
+use Koha::BiblioFrameworks;
+use Koha::Checkouts;
+use Koha::Patrons;
 
 my $query = new CGI;
 
 #getting the template
-my ( $template, $librarian, $cookie ) = get_template_and_user(
+my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
     {
         template_name   => "circ/returns.tt",
         query           => $query,
@@ -75,14 +79,13 @@ if ($session->param('branch') eq 'NO_LIBRARY_SET'){
 if ( $query->param('print_slip') ) {
     $template->param(
         print_slip     => 1,
-        borrowernumber => $query->param('borrowernumber'),
-        biblionumber   => $query->param('biblionumber'),
+        borrowernumber => scalar $query->param('borrowernumber'),
+        biblionumber   => scalar $query->param('biblionumber'),
     );
 }
 
 #####################
 #Global vars
-my $branches = GetBranches();
 my $printers = GetPrinters();
 my $userenv = C4::Context->userenv;
 my $userenv_branch = $userenv->{'branch'} // '';
@@ -90,7 +93,7 @@ my $printer = $userenv->{'branchprinter'} // '';
 my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
 
 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
-#
+ #
 # Some code to handle the error if there is no branch or printer setting.....
 #
 
@@ -142,10 +145,10 @@ if ($query->param('WT-itemNumber')){
        updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
 }
 
-if ( $query->param('resbarcode') ) {
+if ( $query->param('reserve_id') ) {
     my $item           = $query->param('itemnumber');
     my $borrowernumber = $query->param('borrowernumber');
-    my $resbarcode     = $query->param('resbarcode');
+    my $reserve_id     = $query->param('reserve_id');
     my $diffBranchReturned = $query->param('diffBranch');
     my $iteminfo   = GetBiblioFromItemNumber($item);
     my $cancel_reserve = $query->param('cancel_reserve');
@@ -153,17 +156,17 @@ if ( $query->param('resbarcode') ) {
     $iteminfo->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $iteminfo->{'itype'} : $iteminfo->{'itemtype'};
 
     if ( $cancel_reserve ) {
-        CancelReserve({ borrowernumber => $borrowernumber, itemnumber => $item, charge_cancel_fee => !$forgivemanualholdsexpire });
+        CancelReserve({ reserve_id => $reserve_id, charge_cancel_fee => !$forgivemanualholdsexpire });
     } else {
         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);
+        ModReserveAffect( $item, $borrowernumber, $diffBranchSend, $reserve_id );
     }
 #   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 ($borr) = GetMemberDetails( $nextreservinfo, 0 );
+    my $borr = GetMember( borrowernumber => $nextreservinfo );
     my $name   = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
     if ( $messages->{'transfert'} ) {
         $template->param(
@@ -171,12 +174,12 @@ if ( $query->param('resbarcode') ) {
             itemnumber     => $iteminfo->{'itemnumber'},
             itembiblionumber => $iteminfo->{'biblionumber'},
             iteminfo       => $iteminfo->{'author'},
-            tobranchname   => GetBranchName($messages->{'transfert'}),
             name           => $name,
             borrowernumber => $borrowernumber,
             borcnum        => $borr->{'cardnumber'},
             borfirstname   => $borr->{'firstname'},
             borsurname     => $borr->{'surname'},
+            borcategory    => $borr->{'description'},
             diffbranch     => 1,
         );
     }
@@ -211,9 +214,8 @@ my $return_date_override_remember =
   $query->param('return_date_override_remember');
 if ($return_date_override) {
     if ( C4::Context->preference('SpecifyReturnDate') ) {
-        # FIXME we really need to stop adding more uses of C4::Dates
-        if ( $return_date_override =~ C4::Dates->regexp('syspref') ) {
-
+        my $return_date_override_dt = eval {dt_from_string( $return_date_override ) };
+        if ( $return_date_override_dt ) {
             # note that we've overriden the return date
             $template->param( return_date_was_overriden => 1);
             # Save the original format if we are remembering for this series
@@ -222,9 +224,8 @@ if ($return_date_override) {
                 return_date_override_remember => 1
             ) if ($return_date_override_remember);
 
-            my $dt = dt_from_string($return_date_override);
             $return_date_override =
-              DateTime::Format::MySQL->format_datetime($dt);
+              DateTime::Format::MySQL->format_datetime( $return_date_override_dt );
         }
     }
     else {
@@ -251,6 +252,7 @@ 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');
@@ -267,21 +269,28 @@ if ($barcode) {
 
     # Check if we should display a checkin message, based on the the item
     # type of the checked in item
-    my $itemtype = C4::ItemType->get( $biblio->{'itemtype'} );
-    if ( $itemtype->{'checkinmsg'} ) {
+    my $itemtype = Koha::ItemTypes->find( $biblio->{'itemtype'} );
+    if ( $itemtype && $itemtype->checkinmsg ) {
         $template->param(
-            checkinmsg     => $itemtype->{'checkinmsg'},
-            checkinmsgtype => $itemtype->{'checkinmsgtype'},
+            checkinmsg     => $itemtype->checkinmsg,
+            checkinmsgtype => $itemtype->checkinmsgtype,
         );
     }
 
     # make sure return branch respects home branch circulation rules, default to homebranch
-    my $hbr = GetBranchItemRule($biblio->{'homebranch'}, $itemtype)->{'returnbranch'} || "homebranch";
-    my $returnbranch = $biblio->{$hbr} ;
+    my $hbr = GetBranchItemRule($biblio->{'homebranch'}, $itemtype ? $itemtype->itemtype : undef )->{'returnbranch'} || "homebranch";
+    $returnbranch = $biblio->{$hbr};
+
+    my $materials = $biblio->{'materials'};
+    my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({frameworkcode => '', kohafield =>'items.materials', authorised_value => $materials });
+    $materials = $descriptions->{lib} // $materials;
+
+    my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
 
     $template->param(
         title            => $biblio->{'title'},
         homebranch       => $biblio->{'homebranch'},
+        holdingbranch    => $biblio->{'holdingbranch'},
         returnbranch     => $returnbranch,
         author           => $biblio->{'author'},
         itembarcode      => $biblio->{'barcode'},
@@ -290,7 +299,8 @@ if ($barcode) {
         itembiblionumber => $biblio->{'biblionumber'},
         biblionumber     => $biblio->{'biblionumber'},
         borrower         => $borrower,
-        additional_materials => $biblio->{'materials'},
+        additional_materials => $materials,
+        issue            => $issue,
     );
 
     my %input = (
@@ -319,22 +329,19 @@ if ($barcode) {
         push( @inputloop, \%input );
 
         if ( C4::Context->preference("FineNotifyAtCheckin") ) {
-            my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrower->{'borrowernumber'} );
-            if ($fines && $fines > 0) {
-                $template->param( fines => sprintf("%.2f",$fines) );
+            my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
+            my $balance = $patron->account->balance;
+
+            if ($balance > 0) {
+                $template->param( fines => sprintf("%.2f", $balance) );
                 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
             }
         }
 
         if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
             #Check for waiting holds
-            my @reserves = GetReservesFromBorrowernumber($borrower->{'borrowernumber'});
-            my $waiting_holds = 0;
-            foreach my $num_res (@reserves) {
-                if ( $num_res->{'found'} eq 'W' && $num_res->{'branchcode'} eq $userenv_branch) {
-                    $waiting_holds++;
-                }
-            }
+            my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
+            my $waiting_holds = $patron->holds->search({ found => 'W', branchcode => $userenv_branch })->count;
             if ($waiting_holds > 0) {
                 $template->param(
                     waiting_holds       => $waiting_holds,
@@ -344,13 +351,13 @@ if ($barcode) {
                 );
             }
         }
-    }
-    elsif ( !$messages->{'BadBarcode'} ) {
+    } elsif ( C4::Context->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} ) {
         $input{duedate}   = 0;
         $returneditems{0} = $barcode;
         $riduedate{0}     = 0;
         push( @inputloop, \%input );
     }
+    $template->param( privacy => $borrower->{privacy} );
 }
 $template->param( inputloop => \@inputloop );
 
@@ -380,6 +387,7 @@ if ( $messages->{'NeedsTransfer'} ){
 if ( $messages->{'Wrongbranch'} ){
     $template->param(
         wrongbranch => 1,
+        rightbranch => $messages->{'Wrongbranch'}->{'Rightbranch'},
     );
 }
 
@@ -394,21 +402,24 @@ if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
     );
 
     my $reserve    = $messages->{'ResFound'};
-    my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
-    my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
+    my $borr = C4::Members::GetMember( borrowernumber => $reserve->{'borrowernumber'} );
     my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
     $template->param(
             wname           => $name,
             wborfirstname   => $borr->{'firstname'},
             wborsurname     => $borr->{'surname'},
+            wborcategory    => $borr->{'description'},
             wbortitle       => $borr->{'title'},
             wborphone       => $borr->{'phone'},
             wboremail       => $borr->{'email'},
-            wborstnum       => $borr->{streetnumber},
-            wboraddress     => $borr->{'address'},
-            wboraddress2    => $borr->{'address2'},
-            wborcity        => $borr->{'city'},
-            wborzip         => $borr->{'zipcode'},
+            streetnumber    => $borr->{streetnumber},
+            streettype      => $borr->{streettype},
+            address         => $borr->{'address'},
+            address2        => $borr->{'address2'},
+            city            => $borr->{'city'},
+            zipcode         => $borr->{'zipcode'},
+            state           => $borr->{'state'},
+            country         => $borr->{'country'},
             wborrowernumber => $reserve->{'borrowernumber'},
             wborcnum        => $borr->{'cardnumber'},
             wtransfertFrom  => $userenv_branch,
@@ -420,9 +431,8 @@ if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
 #
 if ( $messages->{'ResFound'}) {
     my $reserve    = $messages->{'ResFound'};
-    my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
-    my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
-
+    my $borr = C4::Members::GetMember( borrowernumber => $reserve->{'borrowernumber'} );
+    my $holdmsgpreferences =  C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $reserve->{'borrowernumber'}, message_name   => 'Hold_Filled' } );
     if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
         if ( $reserve->{'ResFound'} eq "Waiting" ) {
             $template->param(
@@ -432,7 +442,7 @@ if ( $messages->{'ResFound'}) {
             $template->param(
                 intransit    => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
                 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
-                resbarcode   => $barcode,
+                reserve_id   => $reserve->{reserve_id},
                 reserved     => 1,
             );
         }
@@ -440,19 +450,21 @@ if ( $messages->{'ResFound'}) {
         # same params for Waiting or Reserved
         $template->param(
             found          => 1,
-            currentbranch  => $branches->{$userenv_branch}->{'branchname'},
-            destbranchname => $branches->{ $reserve->{'branchcode'} }->{'branchname'},
             name           => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
             borfirstname   => $borr->{'firstname'},
             borsurname     => $borr->{'surname'},
+            borcategory    => $borr->{'description'},
             bortitle       => $borr->{'title'},
             borphone       => $borr->{'phone'},
             boremail       => $borr->{'email'},
-            boraddress     => $borr->{'address'},
-            boraddress2    => $borr->{'address2'},
-            borstnum       => $borr->{streetnumber},
-            borcity        => $borr->{'city'},
-            borzip         => $borr->{'zipcode'},
+            streetnumber   => $borr->{streetnumber},
+            streettype     => $borr->{streettype},
+            address        => $borr->{'address'},
+            address2       => $borr->{'address2'},
+            city           => $borr->{'city'},
+            zipcode        => $borr->{'zipcode'},
+            state          => $borr->{'state'},
+            country        => $borr->{'country'},
             borcnum        => $borr->{'cardnumber'},
             debarred       => $borr->{'debarred'},
             gonenoaddress  => $borr->{'gonenoaddress'},
@@ -461,6 +473,8 @@ if ( $messages->{'ResFound'}) {
             borrowernumber => $reserve->{'borrowernumber'},
             itemnumber     => $reserve->{'itemnumber'},
             reservenotes   => $reserve->{'reservenotes'},
+            reserve_id     => $reserve->{reserve_id},
+            bormessagepref => $holdmsgpreferences->{'transports'},
         );
     } # else { ; }  # error?
 }
@@ -477,7 +491,7 @@ foreach my $code ( keys %$messages ) {
     elsif ( $code eq 'NotIssued' ) {
         $err{notissued} = 1;
         $err{msg} = '';
-        $err{msg} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'} if $messages->{'IsPermanent'};
+        $err{msg} = $messages->{'IsPermanent'} if $messages->{'IsPermanent'};
     }
     elsif ( $code eq 'LocalUse' ) {
         $err{localuse} = 1;
@@ -504,8 +518,7 @@ foreach my $code ( keys %$messages ) {
     elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
         if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
             $err{ispermanent} = 1;
-            $err{msg}         =
-              $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
+            $err{msg}         = $messages->{'IsPermanent'};
         }
     }
     elsif ( $code eq 'WrongTransfer' ) {
@@ -548,7 +561,8 @@ $template->param( errmsgloop => \@errmsgloop );
 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
 my $count = 0;
 my @riloop;
-my $shelflocations = GetKohaAuthorisedValues('items.location','');
+my $shelflocations =
+  { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
 foreach ( sort { $a <=> $b } keys %returneditems ) {
     my %ri;
     if ( $count++ < $returned_counter ) {
@@ -561,7 +575,7 @@ foreach ( sort { $a <=> $b } keys %returneditems ) {
             $ri{hour}   = $duedate->hour();
             $ri{minute}   = $duedate->minute();
             $ri{duedate} = output_pref($duedate);
-            my ($b)      = GetMemberDetails( $riborrowernumber{$_}, 0 );
+            my $b      = C4::Members::GetMember( borrowernumber => $riborrowernumber{$_} );
             unless ( $dropboxmode ) {
                 $ri{return_overdue} = 1 if (DateTime->compare($duedate, DateTime->now()) == -1);
             } else {
@@ -574,6 +588,7 @@ foreach ( sort { $a <=> $b } keys %returneditems ) {
             $ri{bortitle}       = $b->{'title'};
             $ri{bornote}        = $b->{'borrowernotes'};
             $ri{borcategorycode}= $b->{'categorycode'};
+            $ri{borissuescount} = Koha::Checkouts->count( { borrowernumber => $b->{'borrowernumber'} } );
         }
         else {
             $ri{borrowernumber} = $riborrowernumber{$_};
@@ -584,17 +599,20 @@ foreach ( sort { $a <=> $b } keys %returneditems ) {
         my $item   = GetItem( GetItemnumberFromBarcode($bar_code) );
         # fix up item type for display
         $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
-        $ri{itembiblionumber} = $biblio->{'biblionumber'};
-        $ri{itemtitle}        = $biblio->{'title'};
-        $ri{itemauthor}       = $biblio->{'author'};
-        $ri{itemcallnumber}   = $biblio->{'itemcallnumber'};
-        $ri{itemtype}         = $biblio->{'itemtype'};
-        $ri{itemnote}         = $biblio->{'itemnotes'};
-        $ri{ccode}            = $biblio->{'ccode'};
-        $ri{itemnumber}       = $biblio->{'itemnumber'};
-        $ri{barcode}          = $bar_code;
-        $ri{homebranch}       = $item->{'homebranch'};
-        $ri{holdingbranch}    = $item->{'holdingbranch'};
+        $ri{itembiblionumber}    = $biblio->{'biblionumber'};
+        $ri{itemtitle}           = $biblio->{'title'};
+        $ri{itemauthor}          = $biblio->{'author'};
+        $ri{itemcallnumber}      = $biblio->{'itemcallnumber'};
+        $ri{dateaccessioned}     = $item->{dateaccessioned};
+        $ri{itemtype}            = $biblio->{'itemtype'};
+        $ri{itemnote}            = $biblio->{'itemnotes'};
+        $ri{itemnotes_nonpublic} = $item->{'itemnotes_nonpublic'};
+        $ri{ccode}               = $biblio->{'ccode'};
+        $ri{enumchron}           = $biblio->{'enumchron'};
+        $ri{itemnumber}          = $biblio->{'itemnumber'};
+        $ri{barcode}             = $bar_code;
+        $ri{homebranch}          = $item->{'homebranch'};
+        $ri{holdingbranch}       = $item->{'holdingbranch'};
 
         $ri{location}         = $biblio->{'location'};
         my $shelfcode = $ri{'location'};
@@ -606,18 +624,9 @@ foreach ( sort { $a <=> $b } keys %returneditems ) {
     }
     push @riloop, \%ri;
 }
-my ($genbrname, $genprname);
-if (my $b = $branches->{$userenv_branch}) {
-    $genbrname = $b->{'branchname'};
-}
-if (my $p = $printers->{$printer}) {
-    $genprname = $p->{'printername'};
-}
+
 $template->param(
     riloop         => \@riloop,
-    genbrname      => $genbrname,
-    genprname      => $genprname,
-    branchname     => $genbrname,
     printer        => $printer,
     errmsgloop     => \@errmsgloop,
     exemptfine     => $exemptfine,
@@ -625,22 +634,28 @@ $template->param(
     dropboxdate    => output_pref($dropboxdate),
     forgivemanualholdsexpire => $forgivemanualholdsexpire,
     overduecharges => $overduecharges,
-    soundon        => C4::Context->preference("SoundOn"),
+    AudioAlerts        => C4::Context->preference("AudioAlerts"),
     BlockReturnOfWithdrawnItems => C4::Context->preference("BlockReturnOfWithdrawnItems"),
 );
 
 $itemnumber = GetItemnumberFromBarcode( $barcode );
 if ( $itemnumber ) {
-   my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
-    $holdingBranch //= '';
-    $collectionBranch //= '';
-    if ( ! ( $holdingBranch eq $collectionBranch ) ) {
-        $template->param(
-          collectionItemNeedsTransferred => 1,
-          collectionBranch => GetBranchName($collectionBranch),
-        );
+    my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
+    if ( $holdingBranch and $collectionBranch ) {
+        $holdingBranch //= '';
+        $collectionBranch //= $returnbranch;
+        if ( ! ( $holdingBranch eq $collectionBranch ) ) {
+            $template->param(
+              collectionItemNeedsTransferred => 1,
+              collectionBranch => $collectionBranch,
+              itemnumber => $itemnumber,
+            );
+        }
     }
 }
 
+# Checking if there is a Fast Cataloging Framework
+$template->param( fast_cataloging => 1 ) if Koha::BiblioFrameworks->find( 'FA' );
+
 # actually print the page!
 output_html_with_http_headers $query, $cookie, $template->output;