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