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