Bug 9302: (QA follow-up) Dumper plugin isn't used
[koha.git] / opac / opac-user.pl
blob3400f39d4230af8d16b1c6c8014cc3d65ed3a8c2
1 #!/usr/bin/perl
3 # This file is part of Koha.
4 # parts copyright 2010 BibLibre
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.
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.
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>.
20 use strict;
21 #use warnings; FIXME - Bug 2505
23 use CGI qw ( -utf8 );
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;
47 use constant ATTRIBUTE_SHOW_BARCODE => 'SHOW_BCODE';
49 use Scalar::Util qw(looks_like_number);
50 use Date::Calc qw(
51 Today
52 Add_Delta_Days
53 Date_to_Days
56 my $query = new CGI;
58 BEGIN {
59 if (C4::Context->preference('BakerTaylorEnabled')) {
60 require C4::External::BakerTaylor;
61 import C4::External::BakerTaylor qw(&image_url &link_url);
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);
69 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
71 template_name => "opac-user.tt",
72 query => $query,
73 type => "opac",
74 authnotrequired => 0,
75 debug => 1,
79 my %renewed = map { $_ => 1 } split( ':', $query->param('renewed') );
81 my $show_priority;
82 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
83 m/priority/ and $show_priority = 1;
86 my $patronupdate = $query->param('patronupdate');
87 my $canrenew = 1;
89 $template->param( shibbolethAuthentication => C4::Context->config('useshibboleth') );
91 # get borrower information ....
92 my $patron = Koha::Patrons->find( $borrowernumber );
93 my $borr = $patron->unblessed;
95 my ( $today_year, $today_month, $today_day) = Today();
96 my ($warning_year, $warning_month, $warning_day) = split /-/, $borr->{'dateexpiry'};
98 my $debar = Koha::Patrons->find( $borrowernumber )->is_debarred;
99 my $userdebarred;
101 if ($debar) {
102 $userdebarred = 1;
103 $template->param( 'userdebarred' => $userdebarred );
104 if ( $debar ne "9999-12-31" ) {
105 $borr->{'userdebarreddate'} = $debar;
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,
113 $template->param( 'discharge_available' => $available && Koha::Patron::Discharge::is_discharged({borrowernumber => $borrowernumber}) );
116 if ( $userdebarred || $borr->{'gonenoaddress'} || $borr->{'lost'} ) {
117 $borr->{'flagged'} = 1;
118 $canrenew = 0;
121 my $amountoutstanding = $patron->account->balance;
122 if ( $amountoutstanding > 5 ) {
123 $borr->{'amountoverfive'} = 1;
125 if ( 5 >= $amountoutstanding && $amountoutstanding > 0 ) {
126 $borr->{'amountoverzero'} = 1;
128 my $no_renewal_amt = C4::Context->preference( 'OPACFineNoRenewals' );
129 $no_renewal_amt = undef unless looks_like_number( $no_renewal_amt );
131 if ( C4::Context->preference('OpacRenewalAllowed')
132 && defined($no_renewal_amt)
133 && $amountoutstanding > $no_renewal_amt )
135 $borr->{'flagged'} = 1;
136 $canrenew = 0;
137 $template->param(
138 renewal_blocked_fines => $no_renewal_amt,
139 renewal_blocked_fines_amountoutstanding => $amountoutstanding,
143 if ( $amountoutstanding < 0 ) {
144 $borr->{'amountlessthanzero'} = 1;
145 $amountoutstanding = -1 * ( $amountoutstanding );
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;
163 # pass on any renew errors to the template for displaying
164 my $renew_error = $query->param('renew_error');
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,
176 #get issued items ....
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 $pending_checkouts = $patron->pending_checkouts->search({}, { order_by => [ { -desc => 'date_due' }, { -asc => 'issue_id' } ] });
184 if ( $pending_checkouts->count ) { # Useless test
185 while ( my $c = $pending_checkouts->next ) {
186 my $issue = $c->unblessed_all_relateds;
187 # check for reserves
188 my $restype = GetReserveStatus( $issue->{'itemnumber'} );
189 if ( $restype ) {
190 $issue->{'reserved'} = 1;
193 # Must be moved in a module if reused
194 my $charges = Koha::Account::Lines->search(
196 borrowernumber => $patron->borrowernumber,
197 amountoutstanding => { '>' => 0 },
198 accounttype => [ 'F', 'FU', 'L' ],
199 itemnumber => $issue->{itemnumber}
201 { select => [ { sum => 'amountoutstanding' } ], as => ['charges'] }
203 $issue->{charges} = $charges->count ? $charges->next->get_column('charges') : 0;
205 my $rental_fines = Koha::Account::Lines->search(
207 borrowernumber => $patron->borrowernumber,
208 amountoutstanding => { '>' => 0 },
209 accounttype => 'Rent',
210 itemnumber => $issue->{itemnumber}
213 select => [ { sum => 'amountoutstanding' } ],
214 as => ['rental_fines']
217 $issue->{rentalfines} = $charges->count ? $charges->next->get_column('rental_fines') : 0;
219 my $marcrecord = GetMarcBiblio({ biblionumber => $issue->{'biblionumber'} });
220 $issue->{'subtitle'} = GetRecordValue('subtitle', $marcrecord, GetFrameworkCode($issue->{'biblionumber'}));
221 # check if item is renewable
222 my ($status,$renewerror) = CanBookBeRenewed( $borrowernumber, $issue->{'itemnumber'} );
223 ($issue->{'renewcount'},$issue->{'renewsallowed'},$issue->{'renewsleft'}) = GetRenewCount($borrowernumber, $issue->{'itemnumber'});
224 ( $issue->{'renewalfee'}, $issue->{'renewalitemtype'} ) = GetIssuingCharges( $issue->{'itemnumber'}, $borrowernumber );
225 if($status && C4::Context->preference("OpacRenewalAllowed")){
226 $issue->{'status'} = $status;
229 $issue->{'renewed'} = $renewed{ $issue->{'itemnumber'} };
231 if ($renewerror) {
232 $issue->{'too_many'} = 1 if $renewerror eq 'too_many';
233 $issue->{'on_reserve'} = 1 if $renewerror eq 'on_reserve';
234 $issue->{'norenew_overdue'} = 1 if $renewerror eq 'overdue';
235 $issue->{'auto_renew'} = 1 if $renewerror eq 'auto_renew';
236 $issue->{'auto_too_soon'} = 1 if $renewerror eq 'auto_too_soon';
237 $issue->{'auto_too_late'} = 1 if $renewerror eq 'auto_too_late';
238 $issue->{'auto_too_much_oweing'} = 1 if $renewerror eq 'auto_too_much_oweing';
240 if ( $renewerror eq 'too_soon' ) {
241 $issue->{'too_soon'} = 1;
242 $issue->{'soonestrenewdate'} = output_pref(
243 C4::Circulation::GetSoonestRenewDate(
244 $issue->{borrowernumber},
245 $issue->{itemnumber}
251 if ( $c->is_overdue ) {
252 push @overdues, $issue;
253 $overdues_count++;
254 $issue->{'overdue'} = 1;
256 else {
257 $issue->{'issued'} = 1;
259 # imageurl:
260 my $itemtype = $issue->{'itemtype'};
261 if ( $itemtype ) {
262 $issue->{'imageurl'} = getitemtypeimagelocation( 'opac', $itemtypes->{$itemtype}->{'imageurl'} );
263 $issue->{'description'} = $itemtypes->{$itemtype}->{'description'};
265 push @issuedat, $issue;
266 $count++;
268 my $isbn = GetNormalizedISBN($issue->{'isbn'});
269 $issue->{normalized_isbn} = $isbn;
270 $issue->{normalized_upc} = GetNormalizedUPC( $marcrecord, C4::Context->preference('marcflavour') );
272 # My Summary HTML
273 if (my $my_summary_html = C4::Context->preference('OPACMySummaryHTML')){
274 $issue->{author} ? $my_summary_html =~ s/{AUTHOR}/$issue->{author}/g : $my_summary_html =~ s/{AUTHOR}//g;
275 $issue->{title} =~ s/\/+$//; # remove trailing slash
276 $issue->{title} =~ s/\s+$//; # remove trailing space
277 $issue->{title} ? $my_summary_html =~ s/{TITLE}/$issue->{title}/g : $my_summary_html =~ s/{TITLE}//g;
278 $issue->{isbn} ? $my_summary_html =~ s/{ISBN}/$isbn/g : $my_summary_html =~ s/{ISBN}//g;
279 $issue->{biblionumber} ? $my_summary_html =~ s/{BIBLIONUMBER}/$issue->{biblionumber}/g : $my_summary_html =~ s/{BIBLIONUMBER}//g;
280 $issue->{MySummaryHTML} = $my_summary_html;
284 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
285 $canrenew = 0 if ($overduesblockrenewing ne 'allow' and $overdues_count == $count);
287 $template->param( ISSUES => \@issuedat );
288 $template->param( issues_count => $count );
289 $template->param( canrenew => $canrenew );
290 $template->param( OVERDUES => \@overdues );
291 $template->param( overdues_count => $overdues_count );
293 my $show_barcode = Koha::Patron::Attribute::Types->search(
294 { code => ATTRIBUTE_SHOW_BARCODE } )->count;
295 if ($show_barcode) {
296 my $patron_show_barcode = GetBorrowerAttributeValue($borrowernumber, ATTRIBUTE_SHOW_BARCODE);
297 undef $show_barcode if defined($patron_show_barcode) && !$patron_show_barcode;
299 $template->param( show_barcode => 1 ) if $show_barcode;
301 # now the reserved items....
302 my $reserves = Koha::Holds->search( { borrowernumber => $borrowernumber } );
304 $template->param(
305 RESERVES => $reserves,
306 showpriority => $show_priority,
309 # current alert subscriptions
310 my $alerts = getalert($borrowernumber);
311 foreach ( @$alerts ) {
312 $_->{ $_->{type} } = 1;
313 $_->{relatedto} = findrelatedto( $_->{type}, $_->{externalid} );
316 if (C4::Context->preference('BakerTaylorEnabled')) {
317 $template->param(
318 BakerTaylorEnabled => 1,
319 BakerTaylorImageURL => &image_url(),
320 BakerTaylorLinkURL => &link_url(),
321 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
325 if (C4::Context->preference("OPACAmazonCoverImages") or
326 C4::Context->preference("GoogleJackets") or
327 C4::Context->preference("BakerTaylorEnabled") or
328 C4::Context->preference("SyndeticsCoverImages")) {
329 $template->param(JacketImages=>1);
332 $template->param(
333 OverDriveCirculation => C4::Context->preference('OverDriveCirculation') || 0,
334 overdrive_error => scalar $query->param('overdrive_error') || undef,
335 overdrive_tab => scalar $query->param('overdrive_tab') || 0,
338 my $patron_messages = Koha::Patron::Messages->search(
340 borrowernumber => $borrowernumber,
341 message_type => 'B',
345 if ( C4::Context->preference('AllowPatronToSetCheckoutsVisibilityForGuarantor')
346 || C4::Context->preference('AllowStaffToSetCheckoutsVisibilityForGuarantor') )
348 my @relatives =
349 Koha::Database->new()->schema()->resultset("Borrower")->search(
351 privacy_guarantor_checkouts => 1,
352 'me.guarantorid' => $borrowernumber
354 { prefetch => [ { 'issues' => { 'item' => 'biblio' } } ] }
356 $template->param( relatives => \@relatives );
359 $template->param(
360 borrower => scalar Koha::Patrons->find($borrowernumber),
361 patron_messages => $patron_messages,
362 opacnote => $borr->{opacnote},
363 patronupdate => $patronupdate,
364 OpacRenewalAllowed => C4::Context->preference("OpacRenewalAllowed"),
365 userview => 1,
366 SuspendHoldsOpac => C4::Context->preference('SuspendHoldsOpac'),
367 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
368 OpacHoldNotes => C4::Context->preference('OpacHoldNotes'),
369 failed_holds => scalar $query->param('failed_holds'),
372 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };