opac/sco/sco-main.pl

   1 #!/usr/bin/perl
   2 #
   3 # This code has been modified by Trendsetters (originally from opac-user.pl)
   4 # This code has been modified by rch
   5 # Parts Copyright 2010-2011, ByWater Solutions (those related to username/password auth)
   6 #
   7 # This file is part of Koha.
   8 #
   9 # Koha is free software; you can redistribute it and/or modify it
  10 # under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation; either version 3 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but
  15 # WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  21
  22 # We're going to authenticate a self-check user.  we'll add a flag to borrowers 'selfcheck'
  23 #
  24 # We're not in a controlled environment; we never trust the user.
  25 #
  26 # The checkout permission comes form the CGI cookie/session of a staff user.
  27 # The patron is not really logging in here in the same way as they do on the
  28 # rest of the OPAC.  So don't confuse loggedinuser with the patron user.
  29 # The patron id/cardnumber is retrieved from the JWT
  30
  31 use Modern::Perl;
  32
  33 use CGI qw ( -utf8 );
  34
  35 use C4::Auth qw( in_iprange get_template_and_user checkpw );
  36 use C4::Circulation qw( barcodedecode AddReturn CanBookBeIssued AddIssue CanBookBeRenewed AddRenewal );
  37 use C4::Reserves;
  38 use C4::Output qw( output_html_with_http_headers );
  39 use C4::Members;
  40 use Koha::DateUtils qw( dt_from_string );
  41 use Koha::Acquisition::Currencies;
  42 use Koha::Items;
  43 use Koha::Patrons;
  44 use Koha::Patron::Images;
  45 use Koha::Patron::Messages;
  46 use Koha::Plugins;
  47 use Koha::Token;
  48
  49 my $query = CGI->new;
  50
  51 unless (C4::Context->preference('WebBasedSelfCheck')) {
  52     # redirect to OPAC home if self-check is not enabled
  53     print $query->redirect("/cgi-bin/koha/opac-main.pl");
  54     exit;
  55 }
  56
  57 unless ( in_iprange(C4::Context->preference('SelfCheckAllowByIPRanges')) ) {
  58     # redirect to OPAC home if self-checkout not permitted from current IP
  59     print $query->redirect("/cgi-bin/koha/opac-main.pl");
  60     exit;
  61 }
  62
  63 if (C4::Context->preference('AutoSelfCheckAllowed'))
  64 {
  65     my $AutoSelfCheckID = C4::Context->preference('AutoSelfCheckID');
  66     my $AutoSelfCheckPass = C4::Context->preference('AutoSelfCheckPass');
  67     $query->param(-name=>'userid',-values=>[$AutoSelfCheckID]);
  68     $query->param(-name=>'password',-values=>[$AutoSelfCheckPass]);
  69     $query->param(-name=>'koha_login_context',-values=>['sco']);
  70 }
  71 $query->param(-name=>'sco_user_login',-values=>[1]);
  72
  73 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  74     {
  75         template_name   => "sco/sco-main.tt",
  76         flagsrequired   => { self_check => "self_checkout_module" },
  77         query           => $query,
  78         type            => "opac",
  79     }
  80 );
  81
  82 # Get the self checkout timeout preference, or use 120 seconds as a default
  83 my $selfchecktimeout = 120000;
  84 if (C4::Context->preference('SelfCheckTimeout')) {
  85     $selfchecktimeout = C4::Context->preference('SelfCheckTimeout') * 1000;
  86 }
  87 $template->param( SelfCheckTimeout => $selfchecktimeout );
  88
  89 # Checks policy laid out by SCOAllowCheckin, defaults to 'on' if preference is undefined
  90 my $allowselfcheckreturns = 1;
  91 if (defined C4::Context->preference('SCOAllowCheckin')) {
  92     $allowselfcheckreturns = C4::Context->preference('SCOAllowCheckin');
  93 }
  94
  95 my $issuerid = $loggedinuser;
  96 my ($op, $patronlogin, $patronpw, $barcode, $confirmed, $newissues) = (
  97     $query->param("op")         || '',
  98     $query->param("patronlogin")|| '',
  99     $query->param("patronpw")   || '',
 100     $query->param("barcode")    || '',
 101     $query->param("confirmed")  || '',
 102     $query->param("newissues")  || '',
 103 );
 104
 105 my $jwt = $query->cookie('JWT');
 106 if ($op eq "logout") {
 107     $template->param( loggedout => 1 );
 108     $query->param( patronlogin => undef, patronpw => undef );
 109     undef $jwt;
 110 }
 111
 112 $barcode = barcodedecode( $barcode ) if $barcode;
 113
 114 my @newissueslist = split /,/, $newissues;
 115 my $issuenoconfirm = 1; #don't need to confirm on issue.
 116 my $issuer   = Koha::Patrons->find( $issuerid )->unblessed;
 117
 118 my $patronid = $jwt ? Koha::Token->new->decode_jwt({ token => $jwt }) : undef;
 119 unless ( $patronid ) {
 120     if ( C4::Context->preference('SelfCheckoutByLogin') ) {
 121         ( undef, $patronid ) = checkpw( $patronlogin, $patronpw );
 122     }
 123     else {    # People should not do that unless they know what they are doing!
 124               # SelfCheckAllowByIPRanges MUST be configured
 125         $patronid = $query->param('patronid');
 126     }
 127     $jwt = Koha::Token->new->generate_jwt({ id => $patronid }) if $patronid;
 128 }
 129
 130 my $patron;
 131 if ( $patronid ) {
 132     Koha::Plugins->call( 'patron_barcode_transform', \$patronid );
 133     $patron = Koha::Patrons->find( { cardnumber => $patronid } );
 134 }
 135
 136 undef $jwt unless $patron;
 137
 138 my $branch = $issuer->{branchcode};
 139 my $confirm_required = 0;
 140 my $return_only = 0;
 141
 142 if ( $patron && $op eq "returnbook" && $allowselfcheckreturns ) {
 143     my $success = 1;
 144
 145
 146     my $item = Koha::Items->find( { barcode => $barcode } );
 147     if ( $success && C4::Context->preference("CircConfirmItemParts") ) {
 148         if ( defined($item)
 149             && $item->materials )
 150         {
 151             $success = 0;
 152         }
 153     }
 154
 155     if ($success) {
 156         # Patron cannot checkin an item they don't own
 157         $success = 0
 158           unless $patron->checkouts->find( { itemnumber => $item->itemnumber } );
 159     }
 160
 161     if ( $success ) {
 162         ($success) = AddReturn( $barcode, $branch )
 163     }
 164
 165     $template->param( returned => $success );
 166 }
 167 elsif ( $patron && ( $op eq 'checkout' ) ) {
 168
 169     my $item = Koha::Items->find( { barcode => $barcode } );
 170     my $impossible  = {};
 171     my $needconfirm = {};
 172     ( $impossible, $needconfirm ) = CanBookBeIssued(
 173         $patron,
 174         $barcode,
 175         undef,
 176         0,
 177         C4::Context->preference("AllowItemsOnHoldCheckoutSCO")
 178     );
 179     my $issue_error;
 180     if ( $confirm_required = scalar keys %$needconfirm ) {
 181         for my $error ( qw( UNKNOWN_BARCODE max_loans_allowed ISSUED_TO_ANOTHER NO_MORE_RENEWALS NOT_FOR_LOAN DEBT WTHDRAWN RESTRICTED RESERVED ITEMNOTSAMEBRANCH EXPIRED DEBARRED CARD_LOST GNA INVALID_DATE UNKNOWN_BARCODE TOO_MANY DEBT_GUARANTEES DEBT_GUARANTORS USERBLOCKEDOVERDUE PATRON_CANT PREVISSUE NOT_FOR_LOAN_FORCING ITEM_LOST ADDITIONAL_MATERIALS ) ) {
 182             if ( $needconfirm->{$error} ) {
 183                 $issue_error = $error;
 184                 $confirmed = 0;
 185                 last;
 186             }
 187         }
 188     }
 189
 190     if (scalar keys %$impossible) {
 191
 192         my $issue_error = (keys %$impossible)[0]; # FIXME This is wrong, we assume only one error and keys are not ordered
 193         my $title = ( $item ) ? $item->biblio->title : '';
 194
 195         $template->param(
 196             impossible                => $issue_error,
 197             "circ_error_$issue_error" => 1,
 198             title                     => $title,
 199             hide_main                 => 1,
 200         );
 201         if ($issue_error eq 'DEBT') {
 202             $template->param(DEBT => $impossible->{DEBT});
 203         }
 204         if ( $issue_error eq "NO_MORE_RENEWALS" ) {
 205             $return_only = 1;
 206             $template->param(
 207                 returnitem => 1,
 208                 barcode    => $barcode,
 209             );
 210         }
 211     } elsif ( $needconfirm->{RENEW_ISSUE} ){
 212         $template->param(
 213                 renew               => 1,
 214                 barcode             => $barcode,
 215                 confirm             => 1,
 216                 confirm_renew_issue => 1,
 217                 hide_main           => 1,
 218         );
 219     } elsif ( $confirm_required && !$confirmed ) {
 220         $template->param(
 221             impossible                => 1,
 222             "circ_error_$issue_error" => 1,
 223             hide_main                 => 1,
 224         );
 225         if ($issue_error eq 'DEBT') {
 226             $template->param(DEBT => $needconfirm->{DEBT});
 227         }
 228     } else {
 229         if ( $confirmed || $issuenoconfirm ) {    # we'll want to call getpatroninfo again to get updated issues.
 230             my ( $hold_existed, $item );
 231             if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
 232                 # There is no easy way to know if the patron has been charged for this item.
 233                 # So we check if a hold existed for this item before the check in
 234                 $item = Koha::Items->find({ barcode => $barcode });
 235                 $hold_existed = Koha::Holds->search(
 236                     {
 237                         -and => {
 238                             borrowernumber => $patron->borrowernumber,
 239                             -or            => {
 240                                 biblionumber => $item->biblionumber,
 241                                 itemnumber   => $item->itemnumber
 242                             }
 243                         }
 244                     }
 245                 )->count;
 246             }
 247
 248             AddIssue( $patron->unblessed, $barcode );
 249             $template->param( issued => 1 );
 250             push @newissueslist, $barcode;
 251
 252             if ( $hold_existed ) {
 253                 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
 254                 $template->param(
 255                     # If the hold existed before the check in, let's confirm that the charge line exists
 256                     # Note that this should not be needed but since we do not have proper exception handling here we do it this way
 257                     patron_has_hold_fee => Koha::Account::Lines->search(
 258                         {
 259                             borrowernumber  => $patron->borrowernumber,
 260                             debit_type_code => 'RESERVE',
 261                             description     => $item->biblio->title,
 262                             date            => $dtf->format_date(dt_from_string)
 263                         }
 264                       )->count,
 265                 );
 266             }
 267         } else {
 268             $confirm_required = 1;
 269             $template->param(
 270                 confirm    => "Issuing title: " . $item->biblio->title,
 271                 barcode    => $barcode,
 272                 hide_main  => 1,
 273             );
 274         }
 275     }
 276 } # $op
 277
 278 if ( $patron && ( $op eq 'renew' ) ) {
 279     my $item = Koha::Items->find({ barcode => $barcode });
 280
 281     if ( $patron->checkouts->find( { itemnumber => $item->itemnumber } ) ) {
 282         my ($status,$renewerror) = CanBookBeRenewed( $patron->borrowernumber, $item->itemnumber );
 283         if ($status) {
 284             AddRenewal( $patron->borrowernumber, $item->itemnumber, undef, undef, undef, undef, 1 );
 285             push @newissueslist, $barcode;
 286             $template->param( renewed => 1 );
 287         }
 288     } else {
 289         $template->param( renewed => 0 );
 290     }
 291 }
 292
 293 if ( $patron) {
 294     my $borrowername = sprintf "%s %s", ($patron->firstname || ''), ($patron->surname || '');
 295     my $pending_checkouts = $patron->pending_checkouts;
 296     my @checkouts;
 297     while ( my $c = $pending_checkouts->next ) {
 298         my $checkout = $c->unblessed_all_relateds;
 299         my ($can_be_renewed, $renew_error) = CanBookBeRenewed(
 300             $patron->borrowernumber,
 301             $checkout->{itemnumber},
 302         );
 303         $checkout->{can_be_renewed} = $can_be_renewed; # In the future this will be $checkout->can_be_renewed
 304         $checkout->{renew_error} = $renew_error;
 305         $checkout->{overdue} = $c->is_overdue;
 306         push @checkouts, $checkout;
 307     }
 308
 309     my $show_priority;
 310     for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
 311         m/priority/ and $show_priority = 1;
 312     }
 313
 314     my $account = $patron->account;
 315     my $total = $account->balance;
 316     my $accountlines = $account->lines;
 317
 318     my $holds = $patron->holds;
 319     my $waiting_holds_count = 0;
 320
 321     while(my $hold = $holds->next) {
 322         $waiting_holds_count++ if $hold->is_waiting;
 323     }
 324
 325     $template->param(
 326         validuser => 1,
 327         borrowername => $borrowername,
 328         issues_count => scalar(@checkouts),
 329         ISSUES => \@checkouts,
 330         HOLDS => $holds,
 331         newissues => join(',',@newissueslist),
 332         patronlogin => $patronlogin,
 333         patronpw => $patronpw,
 334         waiting_holds_count => $waiting_holds_count,
 335         noitemlinks => 1 ,
 336         borrowernumber => $patron->borrowernumber,
 337         SuspendHoldsOpac => C4::Context->preference('SuspendHoldsOpac'),
 338         AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
 339         howpriority   => $show_priority,
 340         ACCOUNT_LINES => $accountlines,
 341         total => $total,
 342     );
 343
 344     my $patron_messages = Koha::Patron::Messages->search(
 345         {
 346             borrowernumber => $patron->borrowernumber,
 347             message_type => 'B',
 348         }
 349     );
 350     $template->param(
 351         patron_messages => $patron_messages,
 352         opacnote => $patron->opacnote,
 353     );
 354
 355     $template->param(
 356         nofines => 1,
 357
 358     );
 359     if (C4::Context->preference('ShowPatronImageInWebBasedSelfCheck')) {
 360         my $patron_image = $patron->image;
 361         $template->param(
 362             display_patron_image => 1,
 363             csrf_token           => Koha::Token->new->generate_csrf( { session_id => scalar $query->cookie('CGISESSID') . $patron->cardnumber, id => $patron->userid } ),
 364         ) if $patron_image;
 365     }
 366 } else {
 367     $template->param(
 368         nouser     => $patronid,
 369     );
 370 }
 371
 372 $cookie = $query->cookie(
 373     -name => 'JWT',
 374     -value => $jwt // '',
 375     -expires => $jwt ? '+1d' : '',
 376     -HttpOnly => 1,
 377     -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 378     -sameSite => 'Lax'
 379 );
 380
 381 $template->param(patronid => $patronid);
 382
 383 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };