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