Bug 15548: Move new patron related code to Patron*
[koha.git] / opac / opac-user.pl
index 4dbc432..0828739 100755 (executable)
@@ -3,24 +3,24 @@
 # This file is part of Koha.
 # parts copyright 2010 BibLibre
 #
-# 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 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 3 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.
+# 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.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 
 use strict;
 #use warnings; FIXME - Bug 2505
 
-use CGI;
+use CGI qw ( -utf8 );
 
 use C4::Auth;
 use C4::Koha;
@@ -30,15 +30,19 @@ use C4::Members;
 use C4::Members::AttributeTypes;
 use C4::Members::Attributes qw/GetBorrowerAttributeValue/;
 use C4::Output;
-use C4::Overdues qw/CheckBorrowerDebarred/;
 use C4::Biblio;
 use C4::Items;
 use C4::Letters;
 use C4::Branch; # GetBranches
 use Koha::DateUtils;
+use Koha::Patron::Debarments qw(IsDebarred);
+use Koha::Holds;
+use Koha::Database;
+use Koha::Patron::Messages;
 
 use constant ATTRIBUTE_SHOW_BARCODE => 'SHOW_BCODE';
 
+use Scalar::Util qw(looks_like_number);
 use Date::Calc qw(
   Today
   Add_Delta_Days
@@ -56,31 +60,33 @@ BEGIN {
 
 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
     {
-        template_name   => "opac-user.tmpl",
+        template_name   => "opac-user.tt",
         query           => $query,
         type            => "opac",
         authnotrequired => 0,
-        flagsrequired   => { borrow => 1 },
         debug           => 1,
     }
 );
 
+my %renewed = map { $_ => 1 } split( ':', $query->param('renewed') );
+
 my $show_priority;
 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
     m/priority/ and $show_priority = 1;
 }
+
 my $patronupdate = $query->param('patronupdate');
 my $canrenew = 1;
 
+$template->param( shibbolethAuthentication => C4::Context->config('useshibboleth') );
+
 # get borrower information ....
 my ( $borr ) = GetMemberDetails( $borrowernumber );
 
 my (  $today_year,   $today_month,   $today_day) = Today();
 my ($warning_year, $warning_month, $warning_day) = split /-/, $borr->{'dateexpiry'};
 
-$borr->{'ethnicity'} = fixEthnicity( $borr->{'ethnicity'} );
-
-my $debar = CheckBorrowerDebarred($borrowernumber);
+my $debar = IsDebarred($borrowernumber);
 my $userdebarred;
 
 if ($debar) {
@@ -103,13 +109,18 @@ if ( 5 >= $borr->{'amountoutstanding'} && $borr->{'amountoutstanding'} > 0 ) {
     $borr->{'amountoverzero'} = 1;
 }
 my $no_renewal_amt = C4::Context->preference( 'OPACFineNoRenewals' );
-$no_renewal_amt ||= 0;
+$no_renewal_amt = undef unless looks_like_number( $no_renewal_amt );
 
-if ( $borr->{amountoutstanding} > $no_renewal_amt ) {
+if (   C4::Context->preference('OpacRenewalAllowed')
+    && defined($no_renewal_amt)
+    && $borr->{amountoutstanding} > $no_renewal_amt )
+{
     $borr->{'flagged'} = 1;
     $canrenew = 0;
     $template->param(
         renewal_blocked_fines => sprintf( '%.02f', $no_renewal_amt ),
+        renewal_blocked_fines_amountoutstanding =>
+          sprintf( '%.02f', $borr->{amountoutstanding} ),
     );
 }
 
@@ -120,28 +131,31 @@ if ( $borr->{'amountoutstanding'} < 0 ) {
 
 $borr->{'amountoutstanding'} = sprintf "%.02f", $borr->{'amountoutstanding'};
 
-my @bordat;
-$bordat[0] = $borr;
-
 # Warningdate is the date that the warning starts appearing
-if ( $borr->{dateexpiry} && C4::Context->preference('NotifyBorrowerDeparture') &&
-    Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
-    Date_to_Days( $today_year, $today_month, $today_day ) ) 
-{
-    # borrower card soon to expire, warn the borrower
-    $borr->{'warndeparture'} = $borr->{dateexpiry};
-    if (C4::Context->preference('ReturnBeforeExpiry')){
-        $borr->{'returnbeforeexpiry'} = 1;
+if ( $borr->{'dateexpiry'} && C4::Context->preference('NotifyBorrowerDeparture') ) {
+    my $days_to_expiry = Date_to_Days( $warning_year, $warning_month, $warning_day ) - Date_to_Days( $today_year, $today_month, $today_day );
+    if ( $days_to_expiry < 0 ) {
+        #borrower card has expired, warn the borrower
+        $borr->{'warnexpired'} = $borr->{'dateexpiry'};
+    } elsif ( $days_to_expiry < C4::Context->preference('NotifyBorrowerDeparture') ) {
+        # borrower card soon to expire, warn the borrower
+        $borr->{'warndeparture'} = $borr->{dateexpiry};
+        if (C4::Context->preference('ReturnBeforeExpiry')){
+            $borr->{'returnbeforeexpiry'} = 1;
+        }
     }
 }
 
-$template->param(   BORROWER_INFO     => \@bordat,
+# pass on any renew errors to the template for displaying
+my $renew_error = $query->param('renew_error');
+
+$template->param(   BORROWER_INFO     => $borr,
                     borrowernumber    => $borrowernumber,
                     patron_flagged    => $borr->{flagged},
                     OPACMySummaryHTML => (C4::Context->preference("OPACMySummaryHTML")) ? 1 : 0,
                     surname           => $borr->{surname},
-                    showname          => $borr->{showname},
-
+                    RENEW_ERROR       => $renew_error,
+                    borrower          => $borr,
                 );
 
 #get issued items ....
@@ -153,58 +167,75 @@ my @issuedat;
 my $itemtypes = GetItemTypes();
 my $issues = GetPendingIssues($borrowernumber);
 if ($issues){
-       foreach my $issue ( sort { $b->{date_due}->datetime() cmp $a->{date_due}->datetime() } @{$issues} ) {
-               # check for reserves
-               my ( $restype, $res, undef ) = CheckReserves( $issue->{'itemnumber'} );
-               if ( $restype ) {
-                       $issue->{'reserved'} = 1;
-               }
-               
-               my ( $total , $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
-               my $charges = 0;
-               foreach my $ac (@$accts) {
-                       if ( $ac->{'itemnumber'} == $issue->{'itemnumber'} ) {
-                               $charges += $ac->{'amountoutstanding'}
-                                 if $ac->{'accounttype'} eq 'F';
-                               $charges += $ac->{'amountoutstanding'}
-                                 if $ac->{'accounttype'} eq 'L';
-                       }
-               }
-               $issue->{'charges'} = $charges;
-
-               # get publictype for icon
-
-               my $publictype = $issue->{'publictype'};
-               $issue->{$publictype} = 1;
-
-               # check if item is renewable
-               my ($status,$renewerror) = CanBookBeRenewed( $borrowernumber, $issue->{'itemnumber'} );
-               ($issue->{'renewcount'},$issue->{'renewsallowed'},$issue->{'renewsleft'}) = GetRenewCount($borrowernumber, $issue->{'itemnumber'});
+    foreach my $issue ( sort { $b->{date_due}->datetime() cmp $a->{date_due}->datetime() } @{$issues} ) {
+        # check for reserves
+        my $restype = GetReserveStatus( $issue->{'itemnumber'} );
+        if ( $restype ) {
+            $issue->{'reserved'} = 1;
+        }
+
+        my ( $total , $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
+        my $charges = 0;
+        foreach my $ac (@$accts) {
+            if ( $ac->{'itemnumber'} == $issue->{'itemnumber'} ) {
+                $charges += $ac->{'amountoutstanding'}
+                  if $ac->{'accounttype'} eq 'F';
+                $charges += $ac->{'amountoutstanding'}
+                  if $ac->{'accounttype'} eq 'FU';
+                $charges += $ac->{'amountoutstanding'}
+                  if $ac->{'accounttype'} eq 'L';
+            }
+        }
+        $issue->{'charges'} = $charges;
+        my $marcrecord = GetMarcBiblio( $issue->{'biblionumber'} );
+        $issue->{'subtitle'} = GetRecordValue('subtitle', $marcrecord, GetFrameworkCode($issue->{'biblionumber'}));
+        # check if item is renewable
+        my ($status,$renewerror) = CanBookBeRenewed( $borrowernumber, $issue->{'itemnumber'} );
+        ($issue->{'renewcount'},$issue->{'renewsallowed'},$issue->{'renewsleft'}) = GetRenewCount($borrowernumber, $issue->{'itemnumber'});
         if($status && C4::Context->preference("OpacRenewalAllowed")){
             $issue->{'status'} = $status;
         }
-               $issue->{'too_many'} = 1 if $renewerror and $renewerror eq 'too_many';
-               $issue->{'on_reserve'} = 1 if $renewerror and $renewerror eq 'on_reserve';
-
-               if ( $issue->{'overdue'} ) {
-                       push @overdues, $issue;
-                       $overdues_count++;
-                       $issue->{'overdue'} = 1;
-               }
-               else {
-                       $issue->{'issued'} = 1;
-               }
-               # imageurl:
-               my $itemtype = $issue->{'itemtype'};
-               if ( $itemtype ) {
-                       $issue->{'imageurl'}    = getitemtypeimagelocation( 'opac', $itemtypes->{$itemtype}->{'imageurl'} );
-                       $issue->{'description'} = $itemtypes->{$itemtype}->{'description'};
-               }
-               push @issuedat, $issue;
-               $count++;
-               
-               my $isbn = GetNormalizedISBN($issue->{'isbn'});
-               $issue->{normalized_isbn} = $isbn;
+
+        $issue->{'renewed'} = $renewed{ $issue->{'itemnumber'} };
+
+        if ($renewerror) {
+            $issue->{'too_many'}       = 1 if $renewerror eq 'too_many';
+            $issue->{'on_reserve'}     = 1 if $renewerror eq 'on_reserve';
+            $issue->{'norenew_overdue'} = 1 if $renewerror eq 'overdue';
+            $issue->{'auto_renew'}     = 1 if $renewerror eq 'auto_renew';
+            $issue->{'auto_too_soon'}  = 1 if $renewerror eq 'auto_too_soon';
+
+            if ( $renewerror eq 'too_soon' ) {
+                $issue->{'too_soon'}         = 1;
+                $issue->{'soonestrenewdate'} = output_pref(
+                    C4::Circulation::GetSoonestRenewDate(
+                        $issue->{borrowernumber},
+                        $issue->{itemnumber}
+                    )
+                );
+            }
+        }
+
+        if ( $issue->{'overdue'} ) {
+            push @overdues, $issue;
+            $overdues_count++;
+            $issue->{'overdue'} = 1;
+        }
+        else {
+            $issue->{'issued'} = 1;
+        }
+        # imageurl:
+        my $itemtype = $issue->{'itemtype'};
+        if ( $itemtype ) {
+            $issue->{'imageurl'}    = getitemtypeimagelocation( 'opac', $itemtypes->{$itemtype}->{'imageurl'} );
+            $issue->{'description'} = $itemtypes->{$itemtype}->{'description'};
+        }
+        push @issuedat, $issue;
+        $count++;
+
+        my $isbn = GetNormalizedISBN($issue->{'isbn'});
+        $issue->{normalized_isbn} = $isbn;
+        $issue->{normalized_upc} = GetNormalizedUPC( $marcrecord, C4::Context->preference('marcflavour') );
 
                 # My Summary HTML
                 if (my $my_summary_html = C4::Context->preference('OPACMySummaryHTML')){
@@ -216,8 +247,10 @@ if ($issues){
                     $issue->{biblionumber} ? $my_summary_html =~ s/{BIBLIONUMBER}/$issue->{biblionumber}/g : $my_summary_html =~ s/{BIBLIONUMBER}//g;
                     $issue->{MySummaryHTML} = $my_summary_html;
                 }
-       }
+    }
 }
+my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
+$canrenew = 0 if ($overduesblockrenewing ne 'allow' and $overdues_count == $count);
 $template->param( ISSUES       => \@issuedat );
 $template->param( issues_count => $count );
 $template->param( canrenew     => $canrenew );
@@ -250,76 +283,12 @@ for my $branch_hash ( sort keys %{$branches} ) {
 $template->param( branchloop => \@branch_loop );
 
 # now the reserved items....
-my @reserves  = GetReservesFromBorrowernumber( $borrowernumber );
-foreach my $res (@reserves) {
-
-    if ( $res->{'expirationdate'} eq '0000-00-00' ) {
-      $res->{'expirationdate'} = '';
-    }
-    
-    my $publictype = $res->{'publictype'};
-    $res->{$publictype} = 1;
-    $res->{'waiting'} = 1 if $res->{'found'} eq 'W';
-    $res->{'branch'} = $branches->{ $res->{'branchcode'} }->{'branchname'};
-    my $biblioData = GetBiblioData($res->{'biblionumber'});
-    $res->{'reserves_title'} = $biblioData->{'title'};
-    if ($show_priority) {
-        $res->{'priority'} ||= '';
-    }
-    $res->{'suspend_until'} = C4::Dates->new( $res->{'suspend_until'}, "iso")->output("syspref") if ( $res->{'suspend_until'} );
-}
-
-# use Data::Dumper;
-# warn Dumper(@reserves);
-
-$template->param( RESERVES       => \@reserves );
-$template->param( reserves_count => $#reserves+1 );
-$template->param( showpriority=>$show_priority );
-
-my @waiting;
-my $wcount = 0;
-foreach my $res (@reserves) {
-    if ( $res->{'itemnumber'} ) {
-        my $item = GetItem( $res->{'itemnumber'});
-        $res->{'holdingbranch'} =
-          $branches->{ $item->{'holdingbranch'} }->{'branchname'};
-        $res->{'branch'} = $branches->{ $res->{'branchcode'} }->{'branchname'};
-        # get document reserve status
-        my $biblioData = GetBiblioData($res->{'biblionumber'});
-        $res->{'waiting_title'} = $biblioData->{'title'};
-        if ( ( $res->{'found'} eq 'W' ) ) {
-            my $item = $res->{'itemnumber'};
-            $item = GetBiblioFromItemNumber($item,undef);
-            $res->{'wait'}= 1; 
-            $res->{'holdingbranch'}=$item->{'holdingbranch'};
-            $res->{'biblionumber'}=$item->{'biblionumber'};
-            $res->{'barcode'} = $item->{'barcode'};
-            $res->{'wbrcode'} = $res->{'branchcode'};
-            $res->{'itemnumber'}    = $res->{'itemnumber'};
-            $res->{'wbrname'} = $branches->{$res->{'branchcode'}}->{'branchname'};
-            if($res->{'holdingbranch'} eq $res->{'wbrcode'}){
-                $res->{'atdestination'} = 1;
-            }
-            # set found to 1 if reserve is waiting for patron pickup
-            $res->{'found'} = 1 if $res->{'found'} eq 'W';
-        } else {
-            my ($transfertwhen, $transfertfrom, $transfertto) = GetTransfers( $res->{'itemnumber'} );
-            if ($transfertwhen) {
-                $res->{intransit} = 1;
-                $res->{datesent}   = $transfertwhen;
-                $res->{frombranch} = GetBranchName($transfertfrom);
-            }
-        }
-        push @waiting, $res;
-        $wcount++;
-    }
-    # can be cancelled
-    #$res->{'cancelable'} = 1 if ($res->{'wait'} && $res->{'atdestination'} && $res->{'found'} ne "1");
-    $res->{'cancelable'} = 1 if    ($res->{wait} and not $res->{found}) or (not $res->{wait} and not $res->{intransit});
-    
-}
+my $reserves = Koha::Holds->search( { borrowernumber => $borrowernumber } );
 
-$template->param( WAITING => \@waiting );
+$template->param(
+    RESERVES       => $reserves,
+    showpriority   => $show_priority,
+);
 
 # current alert subscriptions
 my $alerts = getalert($borrowernumber);
@@ -340,12 +309,18 @@ if (C4::Context->preference('BakerTaylorEnabled')) {
 if (C4::Context->preference("OPACAmazonCoverImages") or 
     C4::Context->preference("GoogleJackets") or
     C4::Context->preference("BakerTaylorEnabled") or
-       C4::Context->preference("SyndeticsCoverImages")) {
+    C4::Context->preference("SyndeticsCoverImages")) {
         $template->param(JacketImages=>1);
 }
 
-if ( GetMessagesCount( $borrowernumber, 'B' ) ) {
-       $template->param( bor_messages => 1 );
+my $patron_messages = Koha::Patron::Messages->search(
+    {
+        borrowernumber => $borrowernumber,
+        message_type => 'B',
+    }
+);
+if ( $patron_messages->count ) {
+    $template->param( bor_messages => 1 );
 }
 
 if ( $borr->{'opacnote'} ) {
@@ -355,20 +330,30 @@ if ( $borr->{'opacnote'} ) {
   );
 }
 
-$template->param(
-    bor_messages_loop  => GetMessages( $borrowernumber, 'B', 'NONE' ),
-    waiting_count      => $wcount,
-    patronupdate => $patronupdate,
-    OpacRenewalAllowed => C4::Context->preference("OpacRenewalAllowed"),
-    userview => 1,
-    dateformat    => C4::Context->preference("dateformat"),
-);
+if (   C4::Context->preference('AllowPatronToSetCheckoutsVisibilityForGuarantor')
+    || C4::Context->preference('AllowStaffToSetCheckoutsVisibilityForGuarantor') )
+{
+    my @relatives =
+      Koha::Database->new()->schema()->resultset("Borrower")->search(
+        {
+            privacy_guarantor_checkouts => 1,
+            'me.guarantorid'           => $borrowernumber
+        },
+        { prefetch => [ { 'issues' => { 'item' => 'biblio' } } ] }
+      );
+    $template->param( relatives => \@relatives );
+}
 
-$template->param( DHTMLcalendar_dateformat  => C4::Dates->DHTMLcalendar() );
 $template->param(
-    SuspendHoldsOpac => C4::Context->preference('SuspendHoldsOpac'),
-    AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds') ,
+    borrower                 => $borr,
+    patron_messages          => $patron_messages,
+    patronupdate             => $patronupdate,
+    OpacRenewalAllowed       => C4::Context->preference("OpacRenewalAllowed"),
+    userview                 => 1,
+    SuspendHoldsOpac         => C4::Context->preference('SuspendHoldsOpac'),
+    AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
+    OpacHoldNotes            => C4::Context->preference('OpacHoldNotes'),
+    failed_holds             => $query->param('failed_holds'),
 );
 
-output_html_with_http_headers $query, $cookie, $template->output;
-
+output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };