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