Bug 19160: (follow-up) Fix problems introduced by renaming logout_required to logout_...
[koha.git] / opac / opac-user.pl
1 #!/usr/bin/perl
2
3 # This file is part of Koha.
4 # parts copyright 2010 BibLibre
5 #
6 # Koha is free software; you can redistribute it and/or modify it
7 # under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
10 #
11 # Koha is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with Koha; if not, see <http://www.gnu.org/licenses>.
18
19
20 use strict;
21 #use warnings; FIXME - Bug 2505
22
23 use CGI qw ( -utf8 );
24
25 use C4::Auth;
26 use C4::Koha;
27 use C4::Circulation;
28 use C4::Reserves;
29 use C4::Members;
30 use C4::Members::AttributeTypes;
31 use C4::Members::Attributes qw/GetBorrowerAttributeValue/;
32 use C4::Output;
33 use C4::Biblio;
34 use C4::Items;
35 use C4::Letters;
36 use Koha::Account::Lines;
37 use Koha::Libraries;
38 use Koha::DateUtils;
39 use Koha::Holds;
40 use Koha::Database;
41 use Koha::ItemTypes;
42 use Koha::Patron::Attribute::Types;
43 use Koha::Patron::Messages;
44 use Koha::Patron::Discharge;
45 use Koha::Patrons;
46
47 use constant ATTRIBUTE_SHOW_BARCODE => 'SHOW_BCODE';
48
49 use Scalar::Util qw(looks_like_number);
50 use Date::Calc qw(
51   Today
52   Add_Delta_Days
53   Date_to_Days
54 );
55
56 my $query = new CGI;
57
58 BEGIN {
59     if (C4::Context->preference('BakerTaylorEnabled')) {
60         require C4::External::BakerTaylor;
61         import C4::External::BakerTaylor qw(&image_url &link_url);
62     }
63 }
64
65 # CAS single logout handling
66 # Will print header and exit
67 C4::Context->preference('casAuthentication') and C4::Auth_with_cas::logout_if_required($query);
68
69 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
70     {
71         template_name   => "opac-user.tt",
72         query           => $query,
73         type            => "opac",
74         authnotrequired => 0,
75         debug           => 1,
76     }
77 );
78
79 my %renewed = map { $_ => 1 } split( ':', $query->param('renewed') );
80
81 my $show_priority;
82 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
83     m/priority/ and $show_priority = 1;
84 }
85
86 my $patronupdate = $query->param('patronupdate');
87 my $canrenew = 1;
88
89 $template->param( shibbolethAuthentication => C4::Context->config('useshibboleth') );
90
91 if (!$borrowernumber) {
92     $template->param( adminWarning => 1 );
93 }
94
95 # get borrower information ....
96 my $patron = Koha::Patrons->find( $borrowernumber );
97 my $borr = $patron->unblessed;
98
99 my (  $today_year,   $today_month,   $today_day) = Today();
100 my ($warning_year, $warning_month, $warning_day) = split /-/, $borr->{'dateexpiry'};
101
102 my $debar = Koha::Patrons->find( $borrowernumber )->is_debarred;
103 my $userdebarred;
104
105 if ($debar) {
106     $userdebarred = 1;
107     $template->param( 'userdebarred' => $userdebarred );
108     if ( $debar ne "9999-12-31" ) {
109         $borr->{'userdebarreddate'} = $debar;
110     }
111     # FIXME looks like $available is not needed
112     # If a user is discharged they have a validated discharge available
113     my $available = Koha::Patron::Discharge::count({
114         borrowernumber => $borrowernumber,
115         validated      => 1,
116     });
117     $template->param( 'discharge_available' => $available && Koha::Patron::Discharge::is_discharged({borrowernumber => $borrowernumber}) );
118 }
119
120 if ( $userdebarred || $borr->{'gonenoaddress'} || $borr->{'lost'} ) {
121     $borr->{'flagged'} = 1;
122     $canrenew = 0;
123 }
124
125 my $amountoutstanding = $patron->account->balance;
126 if ( $amountoutstanding > 5 ) {
127     $borr->{'amountoverfive'} = 1;
128 }
129 if ( 5 >= $amountoutstanding && $amountoutstanding > 0 ) {
130     $borr->{'amountoverzero'} = 1;
131 }
132 my $no_renewal_amt = C4::Context->preference( 'OPACFineNoRenewals' );
133 $no_renewal_amt = undef unless looks_like_number( $no_renewal_amt );
134
135 if (   C4::Context->preference('OpacRenewalAllowed')
136     && defined($no_renewal_amt)
137     && $amountoutstanding > $no_renewal_amt )
138 {
139     $borr->{'flagged'} = 1;
140     $canrenew = 0;
141     $template->param(
142         renewal_blocked_fines => $no_renewal_amt,
143         renewal_blocked_fines_amountoutstanding => $amountoutstanding,
144     );
145 }
146
147 if ( $amountoutstanding < 0 ) {
148     $borr->{'amountlessthanzero'} = 1;
149     $amountoutstanding = -1 * ( $amountoutstanding );
150 }
151
152 # Warningdate is the date that the warning starts appearing
153 if ( $borr->{'dateexpiry'} && C4::Context->preference('NotifyBorrowerDeparture') ) {
154     my $days_to_expiry = Date_to_Days( $warning_year, $warning_month, $warning_day ) - Date_to_Days( $today_year, $today_month, $today_day );
155     if ( $days_to_expiry < 0 ) {
156         #borrower card has expired, warn the borrower
157         $borr->{'warnexpired'} = $borr->{'dateexpiry'};
158     } elsif ( $days_to_expiry < C4::Context->preference('NotifyBorrowerDeparture') ) {
159         # borrower card soon to expire, warn the borrower
160         $borr->{'warndeparture'} = $borr->{dateexpiry};
161         if (C4::Context->preference('ReturnBeforeExpiry')){
162             $borr->{'returnbeforeexpiry'} = 1;
163         }
164     }
165 }
166
167 # pass on any renew errors to the template for displaying
168 my $renew_error = $query->param('renew_error');
169
170 $template->param(   BORROWER_INFO     => $borr,
171                     amountoutstanding => $amountoutstanding,
172                     borrowernumber    => $borrowernumber,
173                     patron_flagged    => $borr->{flagged},
174                     OPACMySummaryHTML => (C4::Context->preference("OPACMySummaryHTML")) ? 1 : 0,
175                     surname           => $borr->{surname},
176                     RENEW_ERROR       => $renew_error,
177                     borrower          => $borr,
178                 );
179
180 #get issued items ....
181
182 my $count          = 0;
183 my $overdues_count = 0;
184 my @overdues;
185 my @issuedat;
186 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
187 my $issues = GetPendingIssues($borrowernumber);
188 if ($issues){
189     foreach my $issue ( sort { $b->{date_due}->datetime() cmp $a->{date_due}->datetime() } @{$issues} ) {
190         # check for reserves
191         my $restype = GetReserveStatus( $issue->{'itemnumber'} );
192         if ( $restype ) {
193             $issue->{'reserved'} = 1;
194         }
195
196         # Must be moved in a module if reused
197         my $charges = Koha::Account::Lines->search(
198             {
199                 borrowernumber    => $patron->borrowernumber,
200                 amountoutstanding => { '>' => 0 },
201                 accounttype       => [ 'F', 'FU', 'L' ],
202                 itemnumber        => $issue->{itemnumber}
203             },
204             { select => [ { sum => 'amountoutstanding' } ], as => ['charges'] }
205         );
206         $issue->{charges} = $charges->count ? $charges->next->get_column('charges') : 0;
207
208         my $rental_fines = Koha::Account::Lines->search(
209             {
210                 borrowernumber    => $patron->borrowernumber,
211                 amountoutstanding => { '>' => 0 },
212                 accounttype       => 'Rent',
213                 itemnumber        => $issue->{itemnumber}
214             },
215             {
216                 select => [ { sum => 'amountoutstanding' } ],
217                 as     => ['rental_fines']
218             }
219         );
220         $issue->{rentalfines} = $charges->count ? $charges->next->get_column('rental_fines') : 0;
221
222         my $marcrecord = GetMarcBiblio({ biblionumber => $issue->{'biblionumber'} });
223         $issue->{'subtitle'} = GetRecordValue('subtitle', $marcrecord, GetFrameworkCode($issue->{'biblionumber'}));
224         # check if item is renewable
225         my ($status,$renewerror) = CanBookBeRenewed( $borrowernumber, $issue->{'itemnumber'} );
226         ($issue->{'renewcount'},$issue->{'renewsallowed'},$issue->{'renewsleft'}) = GetRenewCount($borrowernumber, $issue->{'itemnumber'});
227         ( $issue->{'renewalfee'}, $issue->{'renewalitemtype'} ) = GetIssuingCharges( $issue->{'itemnumber'}, $borrowernumber );
228         if($status && C4::Context->preference("OpacRenewalAllowed")){
229             $issue->{'status'} = $status;
230         }
231
232         $issue->{'renewed'} = $renewed{ $issue->{'itemnumber'} };
233
234         if ($renewerror) {
235             $issue->{'too_many'}       = 1 if $renewerror eq 'too_many';
236             $issue->{'on_reserve'}     = 1 if $renewerror eq 'on_reserve';
237             $issue->{'norenew_overdue'} = 1 if $renewerror eq 'overdue';
238             $issue->{'auto_renew'}     = 1 if $renewerror eq 'auto_renew';
239             $issue->{'auto_too_soon'}  = 1 if $renewerror eq 'auto_too_soon';
240             $issue->{'auto_too_late'}  = 1 if $renewerror eq 'auto_too_late';
241             $issue->{'auto_too_much_oweing'}  = 1 if $renewerror eq 'auto_too_much_oweing';
242
243             if ( $renewerror eq 'too_soon' ) {
244                 $issue->{'too_soon'}         = 1;
245                 $issue->{'soonestrenewdate'} = output_pref(
246                     C4::Circulation::GetSoonestRenewDate(
247                         $issue->{borrowernumber},
248                         $issue->{itemnumber}
249                     )
250                 );
251             }
252         }
253
254         if ( $issue->{'overdue'} ) {
255             push @overdues, $issue;
256             $overdues_count++;
257             $issue->{'overdue'} = 1;
258         }
259         else {
260             $issue->{'issued'} = 1;
261         }
262         # imageurl:
263         my $itemtype = $issue->{'itemtype'};
264         if ( $itemtype ) {
265             $issue->{'imageurl'}    = getitemtypeimagelocation( 'opac', $itemtypes->{$itemtype}->{'imageurl'} );
266             $issue->{'description'} = $itemtypes->{$itemtype}->{'description'};
267         }
268         push @issuedat, $issue;
269         $count++;
270
271         my $isbn = GetNormalizedISBN($issue->{'isbn'});
272         $issue->{normalized_isbn} = $isbn;
273         $issue->{normalized_upc} = GetNormalizedUPC( $marcrecord, C4::Context->preference('marcflavour') );
274
275                 # My Summary HTML
276                 if (my $my_summary_html = C4::Context->preference('OPACMySummaryHTML')){
277                     $issue->{author} ? $my_summary_html =~ s/{AUTHOR}/$issue->{author}/g : $my_summary_html =~ s/{AUTHOR}//g;
278                     $issue->{title} =~ s/\/+$//; # remove trailing slash
279                     $issue->{title} =~ s/\s+$//; # remove trailing space
280                     $issue->{title} ? $my_summary_html =~ s/{TITLE}/$issue->{title}/g : $my_summary_html =~ s/{TITLE}//g;
281                     $issue->{isbn} ? $my_summary_html =~ s/{ISBN}/$isbn/g : $my_summary_html =~ s/{ISBN}//g;
282                     $issue->{biblionumber} ? $my_summary_html =~ s/{BIBLIONUMBER}/$issue->{biblionumber}/g : $my_summary_html =~ s/{BIBLIONUMBER}//g;
283                     $issue->{MySummaryHTML} = $my_summary_html;
284                 }
285     }
286 }
287 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
288 $canrenew = 0 if ($overduesblockrenewing ne 'allow' and $overdues_count == $count);
289
290 $template->param( ISSUES       => \@issuedat );
291 $template->param( issues_count => $count );
292 $template->param( canrenew     => $canrenew );
293 $template->param( OVERDUES       => \@overdues );
294 $template->param( overdues_count => $overdues_count );
295
296 my $show_barcode = Koha::Patron::Attribute::Types->search(
297     { code => ATTRIBUTE_SHOW_BARCODE } )->count;
298 if ($show_barcode) {
299     my $patron_show_barcode = GetBorrowerAttributeValue($borrowernumber, ATTRIBUTE_SHOW_BARCODE);
300     undef $show_barcode if defined($patron_show_barcode) && !$patron_show_barcode;
301 }
302 $template->param( show_barcode => 1 ) if $show_barcode;
303
304 # now the reserved items....
305 my $reserves = Koha::Holds->search( { borrowernumber => $borrowernumber } );
306
307 $template->param(
308     RESERVES       => $reserves,
309     showpriority   => $show_priority,
310 );
311
312 # current alert subscriptions
313 my $alerts = getalert($borrowernumber);
314 foreach ( @$alerts ) {
315     $_->{ $_->{type} } = 1;
316     $_->{relatedto} = findrelatedto( $_->{type}, $_->{externalid} );
317 }
318
319 if (C4::Context->preference('BakerTaylorEnabled')) {
320     $template->param(
321         BakerTaylorEnabled  => 1,
322         BakerTaylorImageURL => &image_url(),
323         BakerTaylorLinkURL  => &link_url(),
324         BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
325     );
326 }
327
328 if (C4::Context->preference("OPACAmazonCoverImages") or 
329     C4::Context->preference("GoogleJackets") or
330     C4::Context->preference("BakerTaylorEnabled") or
331     C4::Context->preference("SyndeticsCoverImages")) {
332         $template->param(JacketImages=>1);
333 }
334
335 $template->param(
336     OverDriveCirculation => C4::Context->preference('OverDriveCirculation') || 0,
337     overdrive_error      => scalar $query->param('overdrive_error') || undef,
338     overdrive_tab        => scalar $query->param('overdrive_tab') || 0,
339 );
340
341 my $patron_messages = Koha::Patron::Messages->search(
342     {
343         borrowernumber => $borrowernumber,
344         message_type => 'B',
345     }
346 );
347
348 if (   C4::Context->preference('AllowPatronToSetCheckoutsVisibilityForGuarantor')
349     || C4::Context->preference('AllowStaffToSetCheckoutsVisibilityForGuarantor') )
350 {
351     my @relatives =
352       Koha::Database->new()->schema()->resultset("Borrower")->search(
353         {
354             privacy_guarantor_checkouts => 1,
355             'me.guarantorid'           => $borrowernumber
356         },
357         { prefetch => [ { 'issues' => { 'item' => 'biblio' } } ] }
358       );
359     $template->param( relatives => \@relatives );
360 }
361
362 $template->param(
363     borrower                 => scalar Koha::Patrons->find($borrowernumber),
364     patron_messages          => $patron_messages,
365     opacnote                 => $borr->{opacnote},
366     patronupdate             => $patronupdate,
367     OpacRenewalAllowed       => C4::Context->preference("OpacRenewalAllowed"),
368     userview                 => 1,
369     SuspendHoldsOpac         => C4::Context->preference('SuspendHoldsOpac'),
370     AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
371     OpacHoldNotes            => C4::Context->preference('OpacHoldNotes'),
372     failed_holds             => scalar $query->param('failed_holds'),
373 );
374
375 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };