Bug 23895: Move installer file into the mandatory directory
[koha.git] / opac / opac-user.pl
bloba380d88f0152e3738e9403aa18aa4b537150e566
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 Modern::Perl;
22 use CGI qw ( -utf8 );
24 use C4::Auth;
25 use C4::Koha;
26 use C4::Circulation;
27 use C4::External::BakerTaylor qw( image_url link_url );
28 use C4::Reserves;
29 use C4::Members;
30 use C4::Output;
31 use C4::Biblio;
32 use C4::Items;
33 use C4::Letters;
34 use Koha::Account::Lines;
35 use Koha::Biblios;
36 use Koha::Libraries;
37 use Koha::DateUtils;
38 use Koha::Holds;
39 use Koha::Database;
40 use Koha::ItemTypes;
41 use Koha::Patron::Attribute::Types;
42 use Koha::Patrons;
43 use Koha::Patron::Messages;
44 use Koha::Patron::Discharge;
45 use Koha::Patrons;
46 use Koha::Ratings;
47 use Koha::Token;
49 use constant ATTRIBUTE_SHOW_BARCODE => 'SHOW_BCODE';
51 use Scalar::Util qw(looks_like_number);
52 use Date::Calc qw(
53 Today
54 Add_Delta_Days
55 Date_to_Days
58 my $query = new CGI;
60 # CAS single logout handling
61 # Will print header and exit
62 C4::Context->preference('casAuthentication') and C4::Auth_with_cas::logout_if_required($query);
64 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
66 template_name => "opac-user.tt",
67 query => $query,
68 type => "opac",
69 debug => 1,
73 my %renewed = map { $_ => 1 } split( ':', $query->param('renewed') || '' );
75 my $show_priority;
76 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
77 m/priority/ and $show_priority = 1;
80 my $patronupdate = $query->param('patronupdate');
81 my $canrenew = 1;
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'),
93 });
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;
107 my $userdebarred;
109 if ($debar) {
110 $userdebarred = 1;
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,
119 validated => 1,
121 $template->param( 'discharge_available' => $available && Koha::Patron::Discharge::is_discharged({borrowernumber => $borrowernumber}) );
124 if ( $userdebarred || $borr->{'gonenoaddress'} || $borr->{'lost'} ) {
125 $borr->{'flagged'} = 1;
126 $canrenew = 0;
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")
134 ? $amountoutstanding
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;
142 $canrenew = 0;
143 $template->param(
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');
172 $template->param(
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,
179 borrower => $borr,
180 csrf_token => Koha::Token->new->generate_csrf({
181 session_id => scalar $query->cookie('CGISESSID'),
185 #get issued items ....
187 my $count = 0;
188 my $overdues_count = 0;
189 my @overdues;
190 my @issuedat;
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;
197 # check for reserves
198 my $restype = GetReserveStatus( $issue->{'itemnumber'} );
199 if ( $restype ) {
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'} );
226 ($issue->{'renewcount'},$issue->{'renewsallowed'},$issue->{'renewsleft'}) = GetRenewCount($borrowernumber, $issue->{'itemnumber'});
227 ( $issue->{'renewalfee'}, $issue->{'renewalitemtype'} ) = GetIssuingCharges( $issue->{'itemnumber'}, $borrowernumber );
228 $issue->{itemtype_object} = Koha::ItemTypes->find( Koha::Items->find( $issue->{itemnumber} )->effective_itemtype );
229 if($status && C4::Context->preference("OpacRenewalAllowed")){
230 $are_renewable_items = 1;
231 $issue->{'status'} = $status;
234 $issue->{'renewed'} = $renewed{ $issue->{'itemnumber'} };
236 if ($renewerror) {
237 $issue->{'too_many'} = 1 if $renewerror eq 'too_many';
238 $issue->{'on_reserve'} = 1 if $renewerror eq 'on_reserve';
239 $issue->{'norenew_overdue'} = 1 if $renewerror eq 'overdue';
240 $issue->{'auto_renew'} = 1 if $renewerror eq 'auto_renew';
241 $issue->{'auto_too_soon'} = 1 if $renewerror eq 'auto_too_soon';
242 $issue->{'auto_too_late'} = 1 if $renewerror eq 'auto_too_late';
243 $issue->{'auto_too_much_oweing'} = 1 if $renewerror eq 'auto_too_much_oweing';
244 $issue->{'item_denied_renewal'} = 1 if $renewerror eq 'item_denied_renewal';
246 if ( $renewerror eq 'too_soon' ) {
247 $issue->{'too_soon'} = 1;
248 $issue->{'soonestrenewdate'} = output_pref(
249 C4::Circulation::GetSoonestRenewDate(
250 $issue->{borrowernumber},
251 $issue->{itemnumber}
257 if ( $c->is_overdue ) {
258 push @overdues, $issue;
259 $overdues_count++;
260 $issue->{'overdue'} = 1;
262 else {
263 $issue->{'issued'} = 1;
265 # imageurl:
266 my $itemtype = $issue->{'itemtype'};
267 if ( $itemtype ) {
268 $issue->{'imageurl'} = getitemtypeimagelocation( 'opac', $itemtypes->{$itemtype}->{'imageurl'} );
269 $issue->{'description'} = $itemtypes->{$itemtype}->{'description'};
272 if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
273 my $ratings = Koha::Ratings->search({ biblionumber => $issue->{biblionumber} });
274 $issue->{ratings} = $ratings;
275 $issue->{my_rating} = $borrowernumber ? $ratings->search({ borrowernumber => $borrowernumber })->next : undef;
278 $issue->{biblio_object} = Koha::Biblios->find($issue->{biblionumber});
279 push @issuedat, $issue;
280 $count++;
282 my $isbn = GetNormalizedISBN($issue->{'isbn'});
283 $issue->{normalized_isbn} = $isbn;
284 my $marcrecord = GetMarcBiblio({
285 biblionumber => $issue->{'biblionumber'},
286 embed_items => 1,
287 opac => 1,
288 borcat => $borcat });
289 $issue->{normalized_upc} = GetNormalizedUPC( $marcrecord, C4::Context->preference('marcflavour') );
291 # My Summary HTML
292 if (my $my_summary_html = C4::Context->preference('OPACMySummaryHTML')){
293 $issue->{author} ? $my_summary_html =~ s/{AUTHOR}/$issue->{author}/g : $my_summary_html =~ s/{AUTHOR}//g;
294 $issue->{title} =~ s/\/+$//; # remove trailing slash
295 $issue->{title} =~ s/\s+$//; # remove trailing space
296 $issue->{title} ? $my_summary_html =~ s/{TITLE}/$issue->{title}/g : $my_summary_html =~ s/{TITLE}//g;
297 $issue->{isbn} ? $my_summary_html =~ s/{ISBN}/$isbn/g : $my_summary_html =~ s/{ISBN}//g;
298 $issue->{biblionumber} ? $my_summary_html =~ s/{BIBLIONUMBER}/$issue->{biblionumber}/g : $my_summary_html =~ s/{BIBLIONUMBER}//g;
299 $issue->{MySummaryHTML} = $my_summary_html;
303 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
304 $canrenew = 0 if ($overduesblockrenewing ne 'allow' and $overdues_count == $count) || !$are_renewable_items;
306 $template->param( ISSUES => \@issuedat );
307 $template->param( issues_count => $count );
308 $template->param( canrenew => $canrenew );
309 $template->param( OVERDUES => \@overdues );
310 $template->param( overdues_count => $overdues_count );
312 my $show_barcode = Koha::Patron::Attribute::Types->search( # FIXME we should not need this search
313 { code => ATTRIBUTE_SHOW_BARCODE } )->count;
314 if ($show_barcode) {
315 my $patron_show_barcode = $patron->get_extended_attribute(ATTRIBUTE_SHOW_BARCODE);
316 undef $show_barcode if $patron_show_barcode and not $patron_show_barcode->attribute;
318 $template->param( show_barcode => 1 ) if $show_barcode;
320 # now the reserved items....
321 my $reserves = Koha::Holds->search( { borrowernumber => $borrowernumber } );
323 $template->param(
324 RESERVES => $reserves,
325 showpriority => $show_priority,
328 if (C4::Context->preference('BakerTaylorEnabled')) {
329 $template->param(
330 BakerTaylorEnabled => 1,
331 BakerTaylorImageURL => &image_url(),
332 BakerTaylorLinkURL => &link_url(),
333 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
337 if (C4::Context->preference("OPACAmazonCoverImages") or
338 C4::Context->preference("GoogleJackets") or
339 C4::Context->preference("BakerTaylorEnabled") or
340 C4::Context->preference("SyndeticsCoverImages") or
341 ( C4::Context->preference('OPACCustomCoverImages') and C4::Context->preference('CustomCoverImagesURL') )
343 $template->param(JacketImages=>1);
346 $template->param(
347 OverDriveCirculation => C4::Context->preference('OverDriveCirculation') || 0,
348 overdrive_error => scalar $query->param('overdrive_error') || undef,
349 overdrive_tab => scalar $query->param('overdrive_tab') || 0,
350 RecordedBooksCirculation => C4::Context->preference('RecordedBooksClientSecret') && C4::Context->preference('RecordedBooksLibraryID'),
353 my $patron_messages = Koha::Patron::Messages->search(
355 borrowernumber => $borrowernumber,
356 message_type => 'B',
360 if ( C4::Context->preference('AllowPatronToSetCheckoutsVisibilityForGuarantor')
361 || C4::Context->preference('AllowStaffToSetCheckoutsVisibilityForGuarantor') )
363 my @relatives;
364 # Filter out guarantees that don't want guarantor to see checkouts
365 foreach my $gr ( $patron->guarantee_relationships() ) {
366 my $g = $gr->guarantee;
367 push( @relatives, $g ) if $g->privacy_guarantor_checkouts;
369 $template->param( relatives => \@relatives );
372 if ( C4::Context->preference('AllowPatronToSetFinesVisibilityForGuarantor')
373 || C4::Context->preference('AllowStaffToSetFinesVisibilityForGuarantor') )
375 my @relatives_with_fines;
376 # Filter out guarantees that don't want guarantor to see checkouts
377 foreach my $gr ( $patron->guarantee_relationships() ) {
378 my $g = $gr->guarantee;
379 push( @relatives_with_fines, $g ) if $g->privacy_guarantor_fines;
381 $template->param( relatives_with_fines => \@relatives_with_fines );
385 $template->param(
386 patron_messages => $patron_messages,
387 opacnote => $borr->{opacnote},
388 patronupdate => $patronupdate,
389 OpacRenewalAllowed => C4::Context->preference("OpacRenewalAllowed"),
390 userview => 1,
391 SuspendHoldsOpac => C4::Context->preference('SuspendHoldsOpac'),
392 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
393 OpacHoldNotes => C4::Context->preference('OpacHoldNotes'),
394 failed_holds => scalar $query->param('failed_holds'),
397 # if not an empty string this indicates to return
398 # back to the opac-results page
399 my $search_query = $query->param('has-search-query');
401 if ($search_query) {
403 print $query->redirect(
404 -uri => "/cgi-bin/koha/opac-search.pl?$search_query",
405 -cookie => $cookie,
409 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };