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