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 Modern::Perl;
  21
  22 use CGI qw ( -utf8 );
  23 use URI;
  24
  25 use C4::Auth qw( get_template_and_user );
  26 use C4::Koha qw(
  27     getitemtypeimagelocation
  28     GetNormalizedISBN
  29     GetNormalizedUPC
  30     GetNormalizedOCLCNumber
  31 );
  32 use C4::Circulation qw( CanBookBeRenewed GetRenewCount GetIssuingCharges );
  33 use C4::External::BakerTaylor qw( image_url link_url );
  34 use C4::Reserves qw( GetReserveStatus );
  35 use C4::Members;
  36 use C4::Output qw( output_html_with_http_headers );
  37 use Koha::Account::Lines;
  38 use Koha::Biblios;
  39 use Koha::Libraries;
  40 use Koha::DateUtils qw( output_pref );
  41 use Koha::Holds;
  42 use Koha::Database;
  43 use Koha::ItemTypes;
  44 use Koha::Patron::Attribute::Types;
  45 use Koha::Patrons;
  46 use Koha::Patron::Messages;
  47 use Koha::Patron::Discharge;
  48 use Koha::Patrons;
  49 use Koha::Ratings;
  50 use Koha::Recalls;
  51 use Koha::Token;
  52
  53 use constant ATTRIBUTE_SHOW_BARCODE => 'SHOW_BCODE';
  54
  55 use Scalar::Util qw( looks_like_number );
  56 use Date::Calc qw( Date_to_Days Today );
  57
  58 my $query = CGI->new;
  59
  60 # CAS single logout handling
  61 # Will print header and exit
  62 if ( C4::Context->preference('casAuthentication') ) {
  63     require C4::Auth_with_cas;
  64     C4::Auth_with_cas::logout_if_required($query);
  65 }
  66
  67 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
  68     {
  69         template_name   => "opac-user.tt",
  70         query           => $query,
  71         type            => "opac",
  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 # get borrower information ....
  88 my $patron = Koha::Patrons->find( $borrowernumber );
  89
  90 if( $query->param('update_arc') && C4::Context->preference("AllowPatronToControlAutorenewal") ){
  91     die "Wrong CSRF token"
  92         unless Koha::Token->new->check_csrf({
  93             session_id => scalar $query->cookie('CGISESSID'),
  94             token  => scalar $query->param('csrf_token'),
  95         });
  96
  97     my $autorenew_checkouts = $query->param('borrower_autorenew_checkouts');
  98     $patron->autorenew_checkouts( $autorenew_checkouts )->store() if defined $autorenew_checkouts;
  99 }
 100
 101 my $borr = $patron->unblessed;
 102
 103 my (  $today_year,   $today_month,   $today_day) = Today();
 104 my ($warning_year, $warning_month, $warning_day) = split /-/, $borr->{'dateexpiry'};
 105
 106 my $debar = Koha::Patrons->find( $borrowernumber )->is_debarred;
 107 my $userdebarred;
 108
 109 if ($debar) {
 110     $userdebarred = 1;
 111     $template->param( 'userdebarred' => $userdebarred );
 112     if ( $debar ne "9999-12-31" ) {
 113         $borr->{'userdebarreddate'} = $debar;
 114     }
 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,
 120     });
 121     $template->param( 'discharge_available' => $available && Koha::Patron::Discharge::is_discharged({borrowernumber => $borrowernumber}) );
 122 }
 123
 124 if ( $userdebarred || $borr->{'gonenoaddress'} || $borr->{'lost'} ) {
 125     $borr->{'flagged'} = 1;
 126     $canrenew = 0;
 127 }
 128
 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;
 136
 137 if (   C4::Context->preference('OpacRenewalAllowed')
 138     && defined($no_renewal_amt)
 139     && $amountoutstandingfornewal > $no_renewal_amt )
 140 {
 141     $borr->{'flagged'} = 1;
 142     $canrenew = 0;
 143     $template->param(
 144         renewal_blocked_fines => $no_renewal_amt,
 145         renewal_blocked_fines_amountoutstanding => $amountoutstandingfornewal,
 146     );
 147 }
 148
 149 my $maxoutstanding = C4::Context->preference('maxoutstanding');
 150 if ( $amountoutstanding && ( $amountoutstanding > $maxoutstanding ) ){
 151     $borr->{blockedonfines} = 1;
 152 }
 153
 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;
 165         }
 166     }
 167 }
 168
 169 my $saving_display = C4::Context->preference('OPACShowSavings');
 170 if ( $saving_display =~ /user/ ) {
 171     $template->param( savings => $patron->get_savings );
 172 }
 173
 174 # pass on any renew errors to the template for displaying
 175 my $renew_error = $query->param('renew_error');
 176
 177 $template->param(
 178                     amountoutstanding => $amountoutstanding,
 179                     borrowernumber    => $borrowernumber,
 180                     patron_flagged    => $borr->{flagged},
 181                     OPACMySummaryHTML => (C4::Context->preference("OPACMySummaryHTML")) ? 1 : 0,
 182                     surname           => $borr->{surname},
 183                     RENEW_ERROR       => $renew_error,
 184                     borrower          => $borr,
 185                     csrf_token             => Koha::Token->new->generate_csrf({
 186                         session_id => scalar $query->cookie('CGISESSID'),
 187                     }),
 188                 );
 189
 190 #get issued items ....
 191
 192 my $count          = 0;
 193 my $overdues_count = 0;
 194 my @overdues;
 195 my @issuedat;
 196 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search_with_localization->unblessed } };
 197 my $pending_checkouts = $patron->pending_checkouts->search(
 198     {},
 199     {
 200         order_by => [ { -desc => 'date_due' }, { -asc => 'issue_id' } ],
 201         prefetch => 'item'
 202     }
 203 );
 204 my $are_renewable_items = 0;
 205 if ( $pending_checkouts->count ) { # Useless test
 206     while ( my $c = $pending_checkouts->next ) {
 207         my $issue = $c->unblessed_all_relateds;
 208         # check for reserves
 209         my $restype = GetReserveStatus( $issue->{'itemnumber'} );
 210         if ( $restype ) {
 211             $issue->{'reserved'} = 1;
 212         }
 213
 214         # Must be moved in a module if reused
 215         my $charges = Koha::Account::Lines->search(
 216             {
 217                 borrowernumber    => $patron->borrowernumber,
 218                 amountoutstanding => { '>' => 0 },
 219                 debit_type_code   => [ 'OVERDUE', 'LOST' ],
 220                 itemnumber        => $issue->{itemnumber}
 221             },
 222         );
 223         $issue->{charges} = $charges->total_outstanding;
 224
 225         my $rental_fines = Koha::Account::Lines->search(
 226             {
 227                 borrowernumber    => $patron->borrowernumber,
 228                 amountoutstanding => { '>' => 0 },
 229                 debit_type_code   => { 'LIKE' => 'RENT_%' },
 230                 itemnumber        => $issue->{itemnumber}
 231             }
 232         );
 233         $issue->{rentalfines} = $rental_fines->total_outstanding;
 234
 235         # check if item is renewable
 236         my ($status, $renewerror, $info) = CanBookBeRenewed( $patron, $c );
 237         (
 238             $issue->{'renewcount'},
 239             $issue->{'renewsallowed'},
 240             $issue->{'renewsleft'},
 241             $issue->{'unseencount'},
 242             $issue->{'unseenallowed'},
 243             $issue->{'unseenleft'}
 244         ) = GetRenewCount($patron, $c->item);
 245         ( $issue->{'renewalfee'}, $issue->{'renewalitemtype'} ) = GetIssuingCharges( $issue->{'itemnumber'}, $borrowernumber );
 246         $issue->{itemtype_object} = Koha::ItemTypes->find( $c->item->effective_itemtype );
 247         if($status && C4::Context->preference("OpacRenewalAllowed")){
 248             $are_renewable_items = 1;
 249             $issue->{'status'} = $status;
 250         }
 251
 252         $issue->{'renewed'} = $renewed{ $issue->{'itemnumber'} };
 253
 254         if ($renewerror) {
 255             $issue->{'too_many'}       = 1 if $renewerror eq 'too_many';
 256             $issue->{'too_unseen'}     = 1 if $renewerror eq 'too_unseen';
 257             $issue->{'on_reserve'}     = 1 if $renewerror eq 'on_reserve';
 258             $issue->{'norenew_overdue'} = 1 if $renewerror eq 'overdue';
 259             $issue->{'auto_renew'}     = 1 if $renewerror eq 'auto_renew';
 260             $issue->{'auto_too_soon'}  = 1 if $renewerror eq 'auto_too_soon';
 261             $issue->{'auto_too_late'}  = 1 if $renewerror eq 'auto_too_late';
 262             $issue->{'auto_too_much_oweing'}  = 1 if $renewerror eq 'auto_too_much_oweing';
 263             $issue->{'item_denied_renewal'}  = 1 if $renewerror eq 'item_denied_renewal';
 264             $issue->{'item_issued_to_other_patron'} = 1 if $renewerror eq 'item_issued_to_other_patron';
 265
 266             if ( $renewerror eq 'too_soon' ) {
 267                 $issue->{'too_soon'}         = 1;
 268                 $issue->{'soonestrenewdate'} = $info->{soonest_renew_date};
 269             }
 270         }
 271
 272         if ( $c->is_overdue ) {
 273             push @overdues, $issue;
 274             $overdues_count++;
 275             $issue->{'overdue'} = 1;
 276         }
 277         else {
 278             $issue->{'issued'} = 1;
 279         }
 280         # imageurl:
 281         my $itemtype = $issue->{'itemtype'};
 282         if ( $itemtype ) {
 283             $issue->{'imageurl'}    = getitemtypeimagelocation( 'opac', $itemtypes->{$itemtype}->{'imageurl'} );
 284             $issue->{'description'} = $itemtypes->{$itemtype}->{'description'};
 285         }
 286
 287         if ( C4::Context->preference('OpacStarRatings') eq 'all' ) {
 288             my $ratings = Koha::Ratings->search({ biblionumber => $issue->{biblionumber} });
 289             $issue->{ratings} = $ratings;
 290             $issue->{my_rating} = $borrowernumber ? $ratings->search({ borrowernumber => $borrowernumber })->next : undef;
 291         }
 292
 293         my $biblio_object = Koha::Biblios->find($issue->{biblionumber});
 294         $issue->{biblio_object} = $biblio_object;
 295         push @issuedat, $issue;
 296         $count++;
 297
 298         my $isbn = GetNormalizedISBN($issue->{'isbn'});
 299         $issue->{normalized_isbn} = $isbn;
 300
 301         if (   C4::Context->preference('BakerTaylorEnabled')
 302             || C4::Context->preference('SyndeticsEnabled')
 303             || C4::Context->preference('SyndeticsCoverImages') )
 304         {
 305             my $marcrecord = $biblio_object->metadata->record( { embed_items => 1, opac => 1, patron => $patron, } );
 306             $issue->{normalized_upc}  = GetNormalizedUPC( $marcrecord, C4::Context->preference('marcflavour') );
 307             $issue->{normalized_oclc} = GetNormalizedOCLCNumber( $marcrecord, C4::Context->preference('marcflavour') );
 308         }
 309                 # My Summary HTML
 310                 if (my $my_summary_html = C4::Context->preference('OPACMySummaryHTML')){
 311                     $issue->{author} ? $my_summary_html =~ s/{AUTHOR}/$issue->{author}/g : $my_summary_html =~ s/{AUTHOR}//g;
 312                     $issue->{title} =~ s/\/+$//; # remove trailing slash
 313                     $issue->{title} =~ s/\s+$//; # remove trailing space
 314                     $issue->{title} ? $my_summary_html =~ s/{TITLE}/$issue->{title}/g : $my_summary_html =~ s/{TITLE}//g;
 315                     $issue->{isbn} ? $my_summary_html =~ s/{ISBN}/$isbn/g : $my_summary_html =~ s/{ISBN}//g;
 316                     $issue->{biblionumber} ? $my_summary_html =~ s/{BIBLIONUMBER}/$issue->{biblionumber}/g : $my_summary_html =~ s/{BIBLIONUMBER}//g;
 317                     $issue->{MySummaryHTML} = $my_summary_html;
 318                 }
 319
 320         if ( C4::Context->preference('UseRecalls') ) {
 321             my $maybe_recalls = Koha::Recalls->search({ biblio_id => $issue->{biblionumber}, item_id => [ undef, $issue->{itemnumber} ], completed => 0 });
 322             while( my $recall = $maybe_recalls->next ) {
 323                 if ( $recall->checkout and $recall->checkout->issue_id == $issue->{issue_id} ) {
 324                     $issue->{recall} = 1;
 325                     last;
 326                 }
 327             }
 328         }
 329     }
 330 }
 331 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
 332 $canrenew = 0 if ($overduesblockrenewing ne 'allow' and $overdues_count == $count) || !$are_renewable_items;
 333
 334 $template->param( ISSUES       => \@issuedat );
 335 $template->param( issues_count => $count );
 336 $template->param( canrenew     => $canrenew );
 337 $template->param( OVERDUES       => \@overdues );
 338 $template->param( overdues_count => $overdues_count );
 339
 340 my $show_barcode = Koha::Patron::Attribute::Types->search( # FIXME we should not need this search
 341     { code => ATTRIBUTE_SHOW_BARCODE } )->count;
 342 if ($show_barcode) {
 343     my $patron_show_barcode = $patron->get_extended_attribute(ATTRIBUTE_SHOW_BARCODE);
 344     undef $show_barcode if $patron_show_barcode and not $patron_show_barcode->attribute;
 345 }
 346 $template->param( show_barcode => 1 ) if $show_barcode;
 347
 348 # now the reserved items....
 349 my $reserves = $patron->holds->filter_out_has_cancellation_requests;
 350
 351 $template->param(
 352     RESERVES       => $reserves,
 353     showpriority   => $show_priority,
 354 );
 355
 356 if ( C4::Context->preference('UseRecalls') ) {
 357     my $recalls = Koha::Recalls->search( { patron_id => $borrowernumber, completed => 0 } );
 358     $template->param( RECALLS => $recalls );
 359 }
 360
 361 if (C4::Context->preference('BakerTaylorEnabled')) {
 362     $template->param(
 363         BakerTaylorEnabled  => 1,
 364         BakerTaylorImageURL => &image_url(),
 365         BakerTaylorLinkURL  => &link_url(),
 366         BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
 367     );
 368 }
 369
 370 if (C4::Context->preference("OPACAmazonCoverImages") or
 371     C4::Context->preference("GoogleJackets") or
 372     C4::Context->preference("BakerTaylorEnabled") or
 373     C4::Context->preference("SyndeticsCoverImages") or
 374     ( C4::Context->preference('OPACCustomCoverImages') and C4::Context->preference('CustomCoverImagesURL') )
 375 ) {
 376         $template->param(JacketImages=>1);
 377 }
 378
 379 $template->param(
 380     OverDriveCirculation => C4::Context->preference('OverDriveCirculation') || 0,
 381     overdrive_error      => scalar $query->param('overdrive_error') || undef,
 382     overdrive_tab        => scalar $query->param('overdrive_tab') || 0,
 383 );
 384
 385 my $patron_messages = Koha::Patron::Messages->search(
 386     {
 387         borrowernumber => $borrowernumber,
 388         message_type => 'B',
 389     }
 390 );
 391
 392 if (   C4::Context->preference('AllowPatronToSetCheckoutsVisibilityForGuarantor')
 393     || C4::Context->preference('AllowStaffToSetCheckoutsVisibilityForGuarantor') )
 394 {
 395     my @relatives;
 396     # Filter out guarantees that don't want guarantor to see checkouts
 397     foreach my $gr ( $patron->guarantee_relationships->as_list ) {
 398         my $g = $gr->guarantee;
 399         push( @relatives, $g ) if $g->privacy_guarantor_checkouts;
 400     }
 401     $template->param( relatives => \@relatives );
 402 }
 403
 404 if (   C4::Context->preference('AllowPatronToSetFinesVisibilityForGuarantor')
 405     || C4::Context->preference('AllowStaffToSetFinesVisibilityForGuarantor') )
 406 {
 407     my @relatives_with_fines;
 408     # Filter out guarantees that don't want guarantor to see checkouts
 409     foreach my $gr ( $patron->guarantee_relationships->as_list ) {
 410         my $g = $gr->guarantee;
 411         push( @relatives_with_fines, $g ) if $g->privacy_guarantor_fines;
 412     }
 413     $template->param( relatives_with_fines => \@relatives_with_fines );
 414 }
 415
 416 if ( C4::Context->preference("ArticleRequests") ) {
 417     $template->param(
 418         current_article_requests => [$patron->article_requests->filter_by_current->as_list],
 419     );
 420 }
 421
 422 $template->param(
 423     patron_messages            => $patron_messages,
 424     opacnote                   => $borr->{opacnote},
 425     patronupdate               => $patronupdate,
 426     OpacRenewalAllowed         => C4::Context->preference("OpacRenewalAllowed"),
 427     userview                   => 1,
 428     SuspendHoldsOpac           => C4::Context->preference('SuspendHoldsOpac'),
 429     AutoResumeSuspendedHolds   => C4::Context->preference('AutoResumeSuspendedHolds'),
 430     OpacHoldNotes              => C4::Context->preference('OpacHoldNotes'),
 431     failed_holds               => scalar $query->param('failed_holds'),
 432     opac_user_holds            => scalar $query->param('opac-user-holds')            || 0,
 433     opac_user_article_requests => scalar $query->param('opac-user-article-requests') || 0,
 434 );
 435
 436 # if not an empty string this indicates to return
 437 # back to the opac-results page
 438 my $search_query = $query->param('has-search-query');
 439
 440 if ($search_query) {
 441
 442     print $query->redirect(
 443         -uri    => "/cgi-bin/koha/opac-search.pl?$search_query",
 444         -cookie => $cookie,
 445     );
 446 }
 447
 448 # if not an empty string this indicates to return
 449 # back to the page we triggered the login from
 450 my $return = $query->param('return');
 451 if ( $return ) {
 452     my $uri_syspref = C4::Context->preference('OPACBaseURL');
 453     if ( $uri_syspref ){
 454         my $uri = URI->new($uri_syspref);
 455         if ( $uri->isa('URI::http') && $uri->host() ){
 456             my $return_uri = URI->new($return);
 457             $return_uri->scheme( $uri->scheme() );
 458             $return_uri->authority( $uri->authority() );
 459             print $query->redirect(
 460                 -uri    => "$return_uri",
 461                 -cookie => $cookie,
 462             );
 463         }
 464     }
 465 }
 466
 467 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };