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