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>.
24 use C4::Auth qw( get_template_and_user );
26 getitemtypeimagelocation
30 use C4::Circulation qw( CanBookBeRenewed GetRenewCount GetIssuingCharges GetSoonestRenewDate );
31 use C4::External::BakerTaylor qw( image_url link_url );
32 use C4::Reserves qw( GetReserveStatus );
34 use C4::Output qw( output_html_with_http_headers );
35 use C4::Biblio qw( GetMarcBiblio );
36 use Koha::Account::Lines;
39 use Koha::DateUtils qw( output_pref );
43 use Koha::Patron::Attribute::Types;
45 use Koha::Patron::Messages;
46 use Koha::Patron::Discharge;
51 use constant ATTRIBUTE_SHOW_BARCODE => 'SHOW_BCODE';
53 use Scalar::Util qw( looks_like_number );
54 use Date::Calc qw( Date_to_Days Today );
58 # CAS single logout handling
59 # Will print header and exit
60 if ( C4::Context->preference('casAuthentication') ) {
61 require C4::Auth_with_cas;
62 C4::Auth_with_cas::logout_if_required($query);
65 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
67 template_name => "opac-user.tt",
73 my %renewed = map { $_ => 1 } split( ':', $query->param('renewed') || '' );
76 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
77 m/priority/ and $show_priority = 1;
80 my $patronupdate = $query->param('patronupdate');
83 $template->param( shibbolethAuthentication => C4::Context->config('useshibboleth') );
85 # get borrower information ....
86 my $patron = Koha::Patrons->find( $borrowernumber );
88 if( $query->param('update_arc') && C4::Context->preference("AllowPatronToControlAutorenewal") ){
89 die "Wrong CSRF token"
90 unless Koha::Token->new->check_csrf({
91 session_id => scalar $query->cookie('CGISESSID'),
92 token => scalar $query->param('csrf_token'),
95 my $autorenew_checkouts = $query->param('borrower_autorenew_checkouts');
96 $patron->autorenew_checkouts( $autorenew_checkouts )->store() if defined $autorenew_checkouts;
99 my $borr = $patron->unblessed;
100 # unblessed is a hash vs. object/undef. Hence the use of curly braces here.
101 my $borcat = $borr ? $borr->{categorycode} : q{};
103 my ( $today_year, $today_month, $today_day) = Today();
104 my ($warning_year, $warning_month, $warning_day) = split /-/, $borr->{'dateexpiry'};
106 my $debar = Koha::Patrons->find( $borrowernumber )->is_debarred;
111 $template->param( 'userdebarred' => $userdebarred );
112 if ( $debar ne "9999-12-31" ) {
113 $borr->{'userdebarreddate'} = $debar;
115 # FIXME looks like $available is not needed
116 # If a user is discharged they have a validated discharge available
117 my $available = Koha::Patron::Discharge::count({
118 borrowernumber => $borrowernumber,
121 $template->param( 'discharge_available' => $available && Koha::Patron::Discharge::is_discharged({borrowernumber => $borrowernumber}) );
124 if ( $userdebarred || $borr->{'gonenoaddress'} || $borr->{'lost'} ) {
125 $borr->{'flagged'} = 1;
129 my $amountoutstanding = $patron->account->balance;
130 my $no_renewal_amt = C4::Context->preference( 'OPACFineNoRenewals' );
131 $no_renewal_amt = undef unless looks_like_number( $no_renewal_amt );
132 my $amountoutstandingfornewal =
133 C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
135 : $patron->account->outstanding_debits->total_outstanding;
137 if ( C4::Context->preference('OpacRenewalAllowed')
138 && defined($no_renewal_amt)
139 && $amountoutstandingfornewal > $no_renewal_amt )
141 $borr->{'flagged'} = 1;
144 renewal_blocked_fines => $no_renewal_amt,
145 renewal_blocked_fines_amountoutstanding => $amountoutstandingfornewal,
149 my $maxoutstanding = C4::Context->preference('maxoutstanding');
150 if ( $amountoutstanding && ( $amountoutstanding > $maxoutstanding ) ){
151 $borr->{blockedonfines} = 1;
154 # Warningdate is the date that the warning starts appearing
155 if ( $borr->{'dateexpiry'} && C4::Context->preference('NotifyBorrowerDeparture') ) {
156 my $days_to_expiry = Date_to_Days( $warning_year, $warning_month, $warning_day ) - Date_to_Days( $today_year, $today_month, $today_day );
157 if ( $days_to_expiry < 0 ) {
158 #borrower card has expired, warn the borrower
159 $borr->{'warnexpired'} = $borr->{'dateexpiry'};
160 } elsif ( $days_to_expiry < C4::Context->preference('NotifyBorrowerDeparture') ) {
161 # borrower card soon to expire, warn the borrower
162 $borr->{'warndeparture'} = $borr->{dateexpiry};
163 if (C4::Context->preference('ReturnBeforeExpiry')){
164 $borr->{'returnbeforeexpiry'} = 1;
169 # pass on any renew errors to the template for displaying
170 my $renew_error = $query->param('renew_error');
173 amountoutstanding => $amountoutstanding,
174 borrowernumber => $borrowernumber,
175 patron_flagged => $borr->{flagged},
176 OPACMySummaryHTML => (C4::Context->preference("OPACMySummaryHTML")) ? 1 : 0,
177 surname => $borr->{surname},
178 RENEW_ERROR => $renew_error,
180 csrf_token => Koha::Token->new->generate_csrf({
181 session_id => scalar $query->cookie('CGISESSID'),
185 #get issued items ....
188 my $overdues_count = 0;
191 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
192 my $pending_checkouts = $patron->pending_checkouts->search({}, { order_by => [ { -desc => 'date_due' }, { -asc => 'issue_id' } ] });
193 my $are_renewable_items = 0;
194 if ( $pending_checkouts->count ) { # Useless test
195 while ( my $c = $pending_checkouts->next ) {
196 my $issue = $c->unblessed_all_relateds;
198 my $restype = GetReserveStatus( $issue->{'itemnumber'} );
200 $issue->{'reserved'} = 1;
203 # Must be moved in a module if reused
204 my $charges = Koha::Account::Lines->search(
206 borrowernumber => $patron->borrowernumber,
207 amountoutstanding => { '>' => 0 },
208 debit_type_code => [ 'OVERDUE', 'LOST' ],
209 itemnumber => $issue->{itemnumber}
212 $issue->{charges} = $charges->total_outstanding;
214 my $rental_fines = Koha::Account::Lines->search(
216 borrowernumber => $patron->borrowernumber,
217 amountoutstanding => { '>' => 0 },
218 debit_type_code => { 'LIKE' => 'RENT_%' },
219 itemnumber => $issue->{itemnumber}
222 $issue->{rentalfines} = $rental_fines->total_outstanding;
224 # check if item is renewable
225 my ($status,$renewerror) = CanBookBeRenewed( $borrowernumber, $issue->{'itemnumber'} );
227 $issue->{'renewcount'},
228 $issue->{'renewsallowed'},
229 $issue->{'renewsleft'},
230 $issue->{'unseencount'},
231 $issue->{'unseenallowed'},
232 $issue->{'unseenleft'}
233 ) = GetRenewCount($borrowernumber, $issue->{'itemnumber'});
234 ( $issue->{'renewalfee'}, $issue->{'renewalitemtype'} ) = GetIssuingCharges( $issue->{'itemnumber'}, $borrowernumber );
235 $issue->{itemtype_object} = Koha::ItemTypes->find( Koha::Items->find( $issue->{itemnumber} )->effective_itemtype );
236 if($status && C4::Context->preference("OpacRenewalAllowed")){
237 $are_renewable_items = 1;
238 $issue->{'status'} = $status;
241 $issue->{'renewed'} = $renewed{ $issue->{'itemnumber'} };
244 $issue->{'too_many'} = 1 if $renewerror eq 'too_many';
245 $issue->{'too_unseen'} = 1 if $renewerror eq 'too_unseen';
246 $issue->{'on_reserve'} = 1 if $renewerror eq 'on_reserve';
247 $issue->{'norenew_overdue'} = 1 if $renewerror eq 'overdue';
248 $issue->{'auto_renew'} = 1 if $renewerror eq 'auto_renew';
249 $issue->{'auto_too_soon'} = 1 if $renewerror eq 'auto_too_soon';
250 $issue->{'auto_too_late'} = 1 if $renewerror eq 'auto_too_late';
251 $issue->{'auto_too_much_oweing'} = 1 if $renewerror eq 'auto_too_much_oweing';
252 $issue->{'item_denied_renewal'} = 1 if $renewerror eq 'item_denied_renewal';
254 if ( $renewerror eq 'too_soon' ) {
255 $issue->{'too_soon'} = 1;
256 $issue->{'soonestrenewdate'} = output_pref(
257 C4::Circulation::GetSoonestRenewDate(
258 $issue->{borrowernumber},
265 if ( $c->is_overdue ) {
266 push @overdues, $issue;
268 $issue->{'overdue'} = 1;
271 $issue->{'issued'} = 1;
274 my $itemtype = $issue->{'itemtype'};
276 $issue->{'imageurl'} = getitemtypeimagelocation( 'opac', $itemtypes->{$itemtype}->{'imageurl'} );
277 $issue->{'description'} = $itemtypes->{$itemtype}->{'description'};
280 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
281 my $ratings = Koha::Ratings->search({ biblionumber => $issue->{biblionumber} });
282 $issue->{ratings} = $ratings;
283 $issue->{my_rating} = $borrowernumber ? $ratings->search({ borrowernumber => $borrowernumber })->next : undef;
286 $issue->{biblio_object} = Koha::Biblios->find($issue->{biblionumber});
287 push @issuedat, $issue;
290 my $isbn = GetNormalizedISBN($issue->{'isbn'});
291 $issue->{normalized_isbn} = $isbn;
292 my $marcrecord = GetMarcBiblio({
293 biblionumber => $issue->{'biblionumber'},
296 borcat => $borcat });
297 $issue->{normalized_upc} = GetNormalizedUPC( $marcrecord, C4::Context->preference('marcflavour') );
300 if (my $my_summary_html = C4::Context->preference('OPACMySummaryHTML')){
301 $issue->{author} ? $my_summary_html =~ s/{AUTHOR}/$issue->{author}/g : $my_summary_html =~ s/{AUTHOR}//g;
302 $issue->{title} =~ s/\/+$//; # remove trailing slash
303 $issue->{title} =~ s/\s+$//; # remove trailing space
304 $issue->{title} ? $my_summary_html =~ s/{TITLE}/$issue->{title}/g : $my_summary_html =~ s/{TITLE}//g;
305 $issue->{isbn} ? $my_summary_html =~ s/{ISBN}/$isbn/g : $my_summary_html =~ s/{ISBN}//g;
306 $issue->{biblionumber} ? $my_summary_html =~ s/{BIBLIONUMBER}/$issue->{biblionumber}/g : $my_summary_html =~ s/{BIBLIONUMBER}//g;
307 $issue->{MySummaryHTML} = $my_summary_html;
310 my $maybe_recalls = Koha::Recalls->search({ biblionumber => $issue->{biblionumber}, itemnumber => [ undef, $issue->{itemnumber} ], old => undef });
311 while( my $recall = $maybe_recalls->next ) {
312 if ( $recall->checkout and $recall->checkout->issue_id == $issue->{issue_id} ) {
313 $issue->{recall} = 1;
319 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
320 $canrenew = 0 if ($overduesblockrenewing ne 'allow' and $overdues_count == $count) || !$are_renewable_items;
322 $template->param( ISSUES => \@issuedat );
323 $template->param( issues_count => $count );
324 $template->param( canrenew => $canrenew );
325 $template->param( OVERDUES => \@overdues );
326 $template->param( overdues_count => $overdues_count );
328 my $show_barcode = Koha::Patron::Attribute::Types->search( # FIXME we should not need this search
329 { code => ATTRIBUTE_SHOW_BARCODE } )->count;
331 my $patron_show_barcode = $patron->get_extended_attribute(ATTRIBUTE_SHOW_BARCODE);
332 undef $show_barcode if $patron_show_barcode and not $patron_show_barcode->attribute;
334 $template->param( show_barcode => 1 ) if $show_barcode;
336 # now the reserved items....
337 my $reserves = Koha::Holds->search( { borrowernumber => $borrowernumber } );
338 my $recalls = Koha::Recalls->search({ borrowernumber => $borrowernumber, old => undef });
341 RESERVES => $reserves,
342 showpriority => $show_priority,
346 if (C4::Context->preference('BakerTaylorEnabled')) {
348 BakerTaylorEnabled => 1,
349 BakerTaylorImageURL => &image_url(),
350 BakerTaylorLinkURL => &link_url(),
351 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
355 if (C4::Context->preference("OPACAmazonCoverImages") or
356 C4::Context->preference("GoogleJackets") or
357 C4::Context->preference("BakerTaylorEnabled") or
358 C4::Context->preference("SyndeticsCoverImages") or
359 ( C4::Context->preference('OPACCustomCoverImages') and C4::Context->preference('CustomCoverImagesURL') )
361 $template->param(JacketImages=>1);
365 OverDriveCirculation => C4::Context->preference('OverDriveCirculation') || 0,
366 overdrive_error => scalar $query->param('overdrive_error') || undef,
367 overdrive_tab => scalar $query->param('overdrive_tab') || 0,
368 RecordedBooksCirculation => C4::Context->preference('RecordedBooksClientSecret') && C4::Context->preference('RecordedBooksLibraryID'),
371 my $patron_messages = Koha::Patron::Messages->search(
373 borrowernumber => $borrowernumber,
378 if ( C4::Context->preference('AllowPatronToSetCheckoutsVisibilityForGuarantor')
379 || C4::Context->preference('AllowStaffToSetCheckoutsVisibilityForGuarantor') )
382 # Filter out guarantees that don't want guarantor to see checkouts
383 foreach my $gr ( $patron->guarantee_relationships->as_list ) {
384 my $g = $gr->guarantee;
385 push( @relatives, $g ) if $g->privacy_guarantor_checkouts;
387 $template->param( relatives => \@relatives );
390 if ( C4::Context->preference('AllowPatronToSetFinesVisibilityForGuarantor')
391 || C4::Context->preference('AllowStaffToSetFinesVisibilityForGuarantor') )
393 my @relatives_with_fines;
394 # Filter out guarantees that don't want guarantor to see checkouts
395 foreach my $gr ( $patron->guarantee_relationships->as_list ) {
396 my $g = $gr->guarantee;
397 push( @relatives_with_fines, $g ) if $g->privacy_guarantor_fines;
399 $template->param( relatives_with_fines => \@relatives_with_fines );
402 if ( C4::Context->preference("ArticleRequests") ) {
404 current_article_requests => [$patron->article_requests->filter_by_current->as_list],
409 patron_messages => $patron_messages,
410 opacnote => $borr->{opacnote},
411 patronupdate => $patronupdate,
412 OpacRenewalAllowed => C4::Context->preference("OpacRenewalAllowed"),
414 SuspendHoldsOpac => C4::Context->preference('SuspendHoldsOpac'),
415 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
416 OpacHoldNotes => C4::Context->preference('OpacHoldNotes'),
417 failed_holds => scalar $query->param('failed_holds'),
420 # if not an empty string this indicates to return
421 # back to the opac-results page
422 my $search_query = $query->param('has-search-query');
426 print $query->redirect(
427 -uri => "/cgi-bin/koha/opac-search.pl?$search_query",
432 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };