Bug 12001: Move GetMemberAccountRecords to the Koha namespace
[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 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
66     {
67         template_name   => "opac-user.tt",
68         query           => $query,
69         type            => "opac",
70         authnotrequired => 0,
71         debug           => 1,
72     }
73 );
74
75 my %renewed = map { $_ => 1 } split( ':', $query->param('renewed') );
76
77 my $show_priority;
78 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
79     m/priority/ and $show_priority = 1;
80 }
81
82 my $patronupdate = $query->param('patronupdate');
83 my $canrenew = 1;
84
85 $template->param( shibbolethAuthentication => C4::Context->config('useshibboleth') );
86
87 if (!$borrowernumber) {
88     $template->param( adminWarning => 1 );
89 }
90
91 # get borrower information ....
92 my $patron = Koha::Patrons->find( $borrowernumber );
93 my $borr = $patron->unblessed;
94
95 my (  $today_year,   $today_month,   $today_day) = Today();
96 my ($warning_year, $warning_month, $warning_day) = split /-/, $borr->{'dateexpiry'};
97
98 my $debar = Koha::Patrons->find( $borrowernumber )->is_debarred;
99 my $userdebarred;
100
101 if ($debar) {
102     $userdebarred = 1;
103     $template->param( 'userdebarred' => $userdebarred );
104     if ( $debar ne "9999-12-31" ) {
105         $borr->{'userdebarreddate'} = $debar;
106     }
107     # FIXME looks like $available is not needed
108     # If a user is discharged they have a validated discharge available
109     my $available = Koha::Patron::Discharge::count({
110         borrowernumber => $borrowernumber,
111         validated      => 1,
112     });
113     $template->param( 'discharge_available' => $available && Koha::Patron::Discharge::is_discharged({borrowernumber => $borrowernumber}) );
114 }
115
116 if ( $userdebarred || $borr->{'gonenoaddress'} || $borr->{'lost'} ) {
117     $borr->{'flagged'} = 1;
118     $canrenew = 0;
119 }
120
121 my $amountoutstanding = $patron->account->balance;
122 if ( $amountoutstanding > 5 ) {
123     $borr->{'amountoverfive'} = 1;
124 }
125 if ( 5 >= $amountoutstanding && $amountoutstanding > 0 ) {
126     $borr->{'amountoverzero'} = 1;
127 }
128 my $no_renewal_amt = C4::Context->preference( 'OPACFineNoRenewals' );
129 $no_renewal_amt = undef unless looks_like_number( $no_renewal_amt );
130
131 if (   C4::Context->preference('OpacRenewalAllowed')
132     && defined($no_renewal_amt)
133     && $amountoutstanding > $no_renewal_amt )
134 {
135     $borr->{'flagged'} = 1;
136     $canrenew = 0;
137     $template->param(
138         renewal_blocked_fines => $no_renewal_amt,
139         renewal_blocked_fines_amountoutstanding => $amountoutstanding,
140     );
141 }
142
143 if ( $amountoutstanding < 0 ) {
144     $borr->{'amountlessthanzero'} = 1;
145     $amountoutstanding = -1 * ( $amountoutstanding );
146 }
147
148 # Warningdate is the date that the warning starts appearing
149 if ( $borr->{'dateexpiry'} && C4::Context->preference('NotifyBorrowerDeparture') ) {
150     my $days_to_expiry = Date_to_Days( $warning_year, $warning_month, $warning_day ) - Date_to_Days( $today_year, $today_month, $today_day );
151     if ( $days_to_expiry < 0 ) {
152         #borrower card has expired, warn the borrower
153         $borr->{'warnexpired'} = $borr->{'dateexpiry'};
154     } elsif ( $days_to_expiry < C4::Context->preference('NotifyBorrowerDeparture') ) {
155         # borrower card soon to expire, warn the borrower
156         $borr->{'warndeparture'} = $borr->{dateexpiry};
157         if (C4::Context->preference('ReturnBeforeExpiry')){
158             $borr->{'returnbeforeexpiry'} = 1;
159         }
160     }
161 }
162
163 # pass on any renew errors to the template for displaying
164 my $renew_error = $query->param('renew_error');
165
166 $template->param(   BORROWER_INFO     => $borr,
167                     amountoutstanding => $amountoutstanding,
168                     borrowernumber    => $borrowernumber,
169                     patron_flagged    => $borr->{flagged},
170                     OPACMySummaryHTML => (C4::Context->preference("OPACMySummaryHTML")) ? 1 : 0,
171                     surname           => $borr->{surname},
172                     RENEW_ERROR       => $renew_error,
173                     borrower          => $borr,
174                 );
175
176 #get issued items ....
177
178 my $count          = 0;
179 my $overdues_count = 0;
180 my @overdues;
181 my @issuedat;
182 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
183 my $issues = GetPendingIssues($borrowernumber);
184 if ($issues){
185     foreach my $issue ( sort { $b->{date_due}->datetime() cmp $a->{date_due}->datetime() } @{$issues} ) {
186         # check for reserves
187         my $restype = GetReserveStatus( $issue->{'itemnumber'} );
188         if ( $restype ) {
189             $issue->{'reserved'} = 1;
190         }
191
192         # Must be moved in a module if reused
193         my $charges = Koha::Account::Lines->search(
194             {
195                 borrowernumber    => $patron->borrowernumber,
196                 amountoutstanding => { '>' => 0 },
197                 accounttype       => [ 'F', 'FU', 'L' ],
198                 itemnumber        => $issue->{itemnumber}
199             },
200             { select => [ { sum => 'amountoutstanding' } ], as => ['charges'] }
201         );
202         $issue->{charges} = $charges->count ? $charges->next->get_column('charges') : 0;
203
204         my $rental_fines = Koha::Account::Lines->search(
205             {
206                 borrowernumber    => $patron->borrowernumber,
207                 amountoutstanding => { '>' => 0 },
208                 accounttype       => 'Rent',
209                 itemnumber        => $issue->{itemnumber}
210             },
211             {
212                 select => [ { sum => 'amountoutstanding' } ],
213                 as     => ['rental_fines']
214             }
215         );
216         $issue->{rentalfines} = $charges->count ? $charges->next->get_column('rental_fines') : 0;
217
218         my $marcrecord = GetMarcBiblio({ biblionumber => $issue->{'biblionumber'} });
219         $issue->{'subtitle'} = GetRecordValue('subtitle', $marcrecord, GetFrameworkCode($issue->{'biblionumber'}));
220         # check if item is renewable
221         my ($status,$renewerror) = CanBookBeRenewed( $borrowernumber, $issue->{'itemnumber'} );
222         ($issue->{'renewcount'},$issue->{'renewsallowed'},$issue->{'renewsleft'}) = GetRenewCount($borrowernumber, $issue->{'itemnumber'});
223         ( $issue->{'renewalfee'}, $issue->{'renewalitemtype'} ) = GetIssuingCharges( $issue->{'itemnumber'}, $borrowernumber );
224         if($status && C4::Context->preference("OpacRenewalAllowed")){
225             $issue->{'status'} = $status;
226         }
227
228         $issue->{'renewed'} = $renewed{ $issue->{'itemnumber'} };
229
230         if ($renewerror) {
231             $issue->{'too_many'}       = 1 if $renewerror eq 'too_many';
232             $issue->{'on_reserve'}     = 1 if $renewerror eq 'on_reserve';
233             $issue->{'norenew_overdue'} = 1 if $renewerror eq 'overdue';
234             $issue->{'auto_renew'}     = 1 if $renewerror eq 'auto_renew';
235             $issue->{'auto_too_soon'}  = 1 if $renewerror eq 'auto_too_soon';
236             $issue->{'auto_too_late'}  = 1 if $renewerror eq 'auto_too_late';
237             $issue->{'auto_too_much_oweing'}  = 1 if $renewerror eq 'auto_too_much_oweing';
238
239             if ( $renewerror eq 'too_soon' ) {
240                 $issue->{'too_soon'}         = 1;
241                 $issue->{'soonestrenewdate'} = output_pref(
242                     C4::Circulation::GetSoonestRenewDate(
243                         $issue->{borrowernumber},
244                         $issue->{itemnumber}
245                     )
246                 );
247             }
248         }
249
250         if ( $issue->{'overdue'} ) {
251             push @overdues, $issue;
252             $overdues_count++;
253             $issue->{'overdue'} = 1;
254         }
255         else {
256             $issue->{'issued'} = 1;
257         }
258         # imageurl:
259         my $itemtype = $issue->{'itemtype'};
260         if ( $itemtype ) {
261             $issue->{'imageurl'}    = getitemtypeimagelocation( 'opac', $itemtypes->{$itemtype}->{'imageurl'} );
262             $issue->{'description'} = $itemtypes->{$itemtype}->{'description'};
263         }
264         push @issuedat, $issue;
265         $count++;
266
267         my $isbn = GetNormalizedISBN($issue->{'isbn'});
268         $issue->{normalized_isbn} = $isbn;
269         $issue->{normalized_upc} = GetNormalizedUPC( $marcrecord, C4::Context->preference('marcflavour') );
270
271                 # My Summary HTML
272                 if (my $my_summary_html = C4::Context->preference('OPACMySummaryHTML')){
273                     $issue->{author} ? $my_summary_html =~ s/{AUTHOR}/$issue->{author}/g : $my_summary_html =~ s/{AUTHOR}//g;
274                     $issue->{title} =~ s/\/+$//; # remove trailing slash
275                     $issue->{title} =~ s/\s+$//; # remove trailing space
276                     $issue->{title} ? $my_summary_html =~ s/{TITLE}/$issue->{title}/g : $my_summary_html =~ s/{TITLE}//g;
277                     $issue->{isbn} ? $my_summary_html =~ s/{ISBN}/$isbn/g : $my_summary_html =~ s/{ISBN}//g;
278                     $issue->{biblionumber} ? $my_summary_html =~ s/{BIBLIONUMBER}/$issue->{biblionumber}/g : $my_summary_html =~ s/{BIBLIONUMBER}//g;
279                     $issue->{MySummaryHTML} = $my_summary_html;
280                 }
281     }
282 }
283 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
284 $canrenew = 0 if ($overduesblockrenewing ne 'allow' and $overdues_count == $count);
285
286 $template->param( ISSUES       => \@issuedat );
287 $template->param( issues_count => $count );
288 $template->param( canrenew     => $canrenew );
289 $template->param( OVERDUES       => \@overdues );
290 $template->param( overdues_count => $overdues_count );
291
292 my $show_barcode = Koha::Patron::Attribute::Types->search(
293     { code => ATTRIBUTE_SHOW_BARCODE } )->count;
294 if ($show_barcode) {
295     my $patron_show_barcode = GetBorrowerAttributeValue($borrowernumber, ATTRIBUTE_SHOW_BARCODE);
296     undef $show_barcode if defined($patron_show_barcode) && !$patron_show_barcode;
297 }
298 $template->param( show_barcode => 1 ) if $show_barcode;
299
300 # now the reserved items....
301 my $reserves = Koha::Holds->search( { borrowernumber => $borrowernumber } );
302
303 $template->param(
304     RESERVES       => $reserves,
305     showpriority   => $show_priority,
306 );
307
308 # current alert subscriptions
309 my $alerts = getalert($borrowernumber);
310 foreach ( @$alerts ) {
311     $_->{ $_->{type} } = 1;
312     $_->{relatedto} = findrelatedto( $_->{type}, $_->{externalid} );
313 }
314
315 if (C4::Context->preference('BakerTaylorEnabled')) {
316     $template->param(
317         BakerTaylorEnabled  => 1,
318         BakerTaylorImageURL => &image_url(),
319         BakerTaylorLinkURL  => &link_url(),
320         BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
321     );
322 }
323
324 if (C4::Context->preference("OPACAmazonCoverImages") or 
325     C4::Context->preference("GoogleJackets") or
326     C4::Context->preference("BakerTaylorEnabled") or
327     C4::Context->preference("SyndeticsCoverImages")) {
328         $template->param(JacketImages=>1);
329 }
330
331 $template->param(
332     OverDriveCirculation => C4::Context->preference('OverDriveCirculation') || 0,
333     overdrive_error      => scalar $query->param('overdrive_error') || undef,
334     overdrive_tab        => scalar $query->param('overdrive_tab') || 0,
335 );
336
337 my $patron_messages = Koha::Patron::Messages->search(
338     {
339         borrowernumber => $borrowernumber,
340         message_type => 'B',
341     }
342 );
343
344 if (   C4::Context->preference('AllowPatronToSetCheckoutsVisibilityForGuarantor')
345     || C4::Context->preference('AllowStaffToSetCheckoutsVisibilityForGuarantor') )
346 {
347     my @relatives =
348       Koha::Database->new()->schema()->resultset("Borrower")->search(
349         {
350             privacy_guarantor_checkouts => 1,
351             'me.guarantorid'           => $borrowernumber
352         },
353         { prefetch => [ { 'issues' => { 'item' => 'biblio' } } ] }
354       );
355     $template->param( relatives => \@relatives );
356 }
357
358 $template->param(
359     borrower                 => scalar Koha::Patrons->find($borrowernumber),
360     patron_messages          => $patron_messages,
361     opacnote                 => $borr->{opacnote},
362     patronupdate             => $patronupdate,
363     OpacRenewalAllowed       => C4::Context->preference("OpacRenewalAllowed"),
364     userview                 => 1,
365     SuspendHoldsOpac         => C4::Context->preference('SuspendHoldsOpac'),
366     AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
367     OpacHoldNotes            => C4::Context->preference('OpacHoldNotes'),
368     failed_holds             => scalar $query->param('failed_holds'),
369 );
370
371 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };