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 in a controlled environment; we trust the user.
  25 # So the selfcheck station will accept a patronid and issue items to that borrower.
  26 # FIXME: NOT really a controlled environment...  We're on the internet!
  27 #
  28 # The checkout permission comes form the CGI cookie/session of a staff user.
  29 # The patron is not really logging in here in the same way as they do on the
  30 # rest of the OPAC.  So don't confuse loggedinuser with the patron user.
  31 #
  32 # FIXME: inputfocus not really used in TMPL
  33
  34 use Modern::Perl;
  35
  36 use CGI qw ( -utf8 );
  37
  38 use C4::Auth qw(get_template_and_user checkpw);
  39 use C4::Koha;
  40 use C4::Circulation;
  41 use C4::Reserves;
  42 use C4::Output;
  43 use C4::Members;
  44 use C4::Biblio;
  45 use C4::Items;
  46 use Koha::DateUtils qw( dt_from_string );
  47 use Koha::Acquisition::Currencies;
  48 use Koha::Patrons;
  49 use Koha::Patron::Images;
  50 use Koha::Patron::Messages;
  51 use Koha::Token;
  52
  53 my $query = new CGI;
  54
  55 unless (C4::Context->preference('WebBasedSelfCheck')) {
  56     # redirect to OPAC home if self-check is not enabled
  57     print $query->redirect("/cgi-bin/koha/opac-main.pl");
  58     exit;
  59 }
  60
  61 if (C4::Context->preference('AutoSelfCheckAllowed'))
  62 {
  63     my $AutoSelfCheckID = C4::Context->preference('AutoSelfCheckID');
  64     my $AutoSelfCheckPass = C4::Context->preference('AutoSelfCheckPass');
  65     $query->param(-name=>'userid',-values=>[$AutoSelfCheckID]);
  66     $query->param(-name=>'password',-values=>[$AutoSelfCheckPass]);
  67     $query->param(-name=>'koha_login_context',-values=>['sco']);
  68 }
  69 $query->param(-name=>'sco_user_login',-values=>[1]);
  70 my ($template, $loggedinuser, $cookie) = get_template_and_user({
  71     template_name   => "sco/sco-main.tt",
  72     authnotrequired => 0,
  73     flagsrequired => { circulate => "self_checkout" },
  74     query => $query,
  75     type  => "opac",
  76     debug => 1,
  77 });
  78
  79 # Get the self checkout timeout preference, or use 120 seconds as a default
  80 my $selfchecktimeout = 120000;
  81 if (C4::Context->preference('SelfCheckTimeout')) {
  82     $selfchecktimeout = C4::Context->preference('SelfCheckTimeout') * 1000;
  83 }
  84 $template->param( SelfCheckTimeout => $selfchecktimeout );
  85
  86 # Checks policy laid out by AllowSelfCheckReturns, defaults to 'on' if preference is undefined
  87 my $allowselfcheckreturns = 1;
  88 if (defined C4::Context->preference('AllowSelfCheckReturns')) {
  89     $allowselfcheckreturns = C4::Context->preference('AllowSelfCheckReturns');
  90 }
  91
  92 my $issuerid = $loggedinuser;
  93 my ($op, $patronid, $patronlogin, $patronpw, $barcode, $confirmed) = (
  94     $query->param("op")         || '',
  95     $query->param("patronid")   || '',
  96     $query->param("patronlogin")|| '',
  97     $query->param("patronpw")   || '',
  98     $query->param("barcode")    || '',
  99     $query->param("confirmed")  || '',
 100 );
 101
 102 my $issuenoconfirm = 1; #don't need to confirm on issue.
 103 my $issuer   = Koha::Patrons->find( $issuerid )->unblessed;
 104 my $item     = GetItem(undef,$barcode);
 105 if (C4::Context->preference('SelfCheckoutByLogin') && !$patronid) {
 106     my $dbh = C4::Context->dbh;
 107     my $resval;
 108     ($resval, $patronid) = checkpw($dbh, $patronlogin, $patronpw);
 109 }
 110
 111 my ( $borrower, $patron );
 112 if ( $patronid ) {
 113     $patron = Koha::Patrons->find( { cardnumber => $patronid } );
 114     $borrower = $patron->unblessed if $patron;
 115 }
 116
 117 my $currencySymbol = "";
 118 if ( my $active_currency = Koha::Acquisition::Currencies->get_active ) {
 119     $currencySymbol = $active_currency->symbol;
 120 }
 121
 122 my $branch = $issuer->{branchcode};
 123 my $confirm_required = 0;
 124 my $return_only = 0;
 125 #warn "issuer cardnumber: " .   $issuer->{cardnumber};
 126 #warn "patron cardnumber: " . $borrower->{cardnumber};
 127 if ($op eq "logout") {
 128     $query->param( patronid => undef, patronlogin => undef, patronpw => undef );
 129 }
 130 elsif ( $op eq "returnbook" && $allowselfcheckreturns ) {
 131     my ($doreturn) = AddReturn( $barcode, $branch );
 132 }
 133 elsif ( $patron and $op eq "checkout" ) {
 134     my $impossible  = {};
 135     my $needconfirm = {};
 136     ( $impossible, $needconfirm ) = CanBookBeIssued(
 137         $patron,
 138         $barcode,
 139         undef,
 140         0,
 141         C4::Context->preference("AllowItemsOnHoldCheckoutSCO")
 142     );
 143     my $issue_error;
 144     if ( $confirm_required = scalar keys %$needconfirm ) {
 145         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 USERBLOCKEDOVERDUE PATRON_CANT PREVISSUE NOT_FOR_LOAN_FORCING ITEM_LOST) ) {
 146             if ( $needconfirm->{$error} ) {
 147                 $issue_error = $error;
 148                 $confirmed = 0;
 149                 last;
 150             }
 151         }
 152     }
 153
 154     #warn "confirm_required: " . $confirm_required ;
 155     if (scalar keys %$impossible) {
 156
 157         my $issue_error = (keys %$impossible)[0]; # FIXME This is wrong, we assume only one error and keys are not ordered
 158
 159         $template->param(
 160             impossible                => $issue_error,
 161             "circ_error_$issue_error" => 1,
 162             title                     => $item->{title},
 163             hide_main                 => 1,
 164         );
 165         if ($issue_error eq 'DEBT') {
 166             $template->param(amount => $currencySymbol.$impossible->{DEBT});
 167         }
 168         #warn "issue_error: " . $issue_error ;
 169         if ( $issue_error eq "NO_MORE_RENEWALS" ) {
 170             $return_only = 1;
 171             $template->param(
 172                 returnitem => 1,
 173                 barcode    => $barcode,
 174             );
 175         }
 176     } elsif ( $needconfirm->{RENEW_ISSUE} ) {
 177         if ($confirmed) {
 178             #warn "renewing";
 179             AddRenewal( $borrower->{borrowernumber}, $item->{itemnumber} );
 180         } else {
 181             #warn "renew confirmation";
 182             $template->param(
 183                 renew               => 1,
 184                 barcode             => $barcode,
 185                 confirm             => 1,
 186                 confirm_renew_issue => 1,
 187                 hide_main           => 1,
 188             );
 189         }
 190     } elsif ( $confirm_required && !$confirmed ) {
 191         #warn "failed confirmation";
 192         $template->param(
 193             impossible                => 1,
 194             "circ_error_$issue_error" => 1,
 195             hide_main                 => 1,
 196         );
 197         if ($issue_error eq 'DEBT') {
 198             $template->param(amount => $currencySymbol.$needconfirm->{DEBT});
 199         }
 200     } else {
 201         if ( $confirmed || $issuenoconfirm ) {    # we'll want to call getpatroninfo again to get updated issues.
 202             my ( $hold_existed, $item );
 203             if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
 204                 # There is no easy way to know if the patron has been charged for this item.
 205                 # So we check if a hold existed for this item before the check in
 206                 $item = Koha::Items->find({ barcode => $barcode });
 207                 $hold_existed = Koha::Holds->search(
 208                     {
 209                         -and => {
 210                             borrowernumber => $borrower->{borrowernumber},
 211                             -or            => {
 212                                 biblionumber => $item->biblionumber,
 213                                 itemnumber   => $item->itemnumber
 214                             }
 215                         }
 216                     }
 217                 )->count;
 218             }
 219             AddIssue( $borrower, $barcode );
 220
 221             if ( $hold_existed ) {
 222                 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
 223                 $template->param(
 224                     # If the hold existed before the check in, let's confirm that the charge line exists
 225                     # Note that this should not be needed but since we do not have proper exception handling here we do it this way
 226                     patron_has_hold_fee => Koha::Account::Lines->search(
 227                         {
 228                             borrowernumber => $borrower->{borrowernumber},
 229                             accounttype    => 'Res',
 230                             description    => 'Reserve Charge - ' . $item->biblio->title,
 231                             date           => $dtf->format_date(dt_from_string)
 232                         }
 233                       )->count,
 234                 );
 235             }
 236         } else {
 237             $confirm_required = 1;
 238             #warn "issue confirmation";
 239             $template->param(
 240                 confirm    => "Issuing title: " . $item->{title},
 241                 barcode    => $barcode,
 242                 hide_main  => 1,
 243                 inputfocus => 'confirm',
 244             );
 245         }
 246     }
 247 } # $op
 248
 249 if ($borrower) {
 250 #   warn "issuer's  branchcode: " .   $issuer->{branchcode};
 251 #   warn   "user's  branchcode: " . $borrower->{branchcode};
 252     my $borrowername = sprintf "%s %s", ($borrower->{firstname} || ''), ($borrower->{surname} || '');
 253     my @issues;
 254     my ($issueslist) = GetPendingIssues( $borrower->{'borrowernumber'} );
 255     foreach my $it (@$issueslist) {
 256         my ($can_be_renewed, $renew_error) = CanBookBeRenewed(
 257             $borrower->{borrowernumber},
 258             $it->{itemnumber},
 259         );
 260         $it->{can_be_renewed} = $can_be_renewed;
 261         $it->{renew_error} = $renew_error;
 262         $it->{date_due}  = $it->{date_due_sql};
 263         push @issues, $it;
 264     }
 265
 266     $template->param(
 267         validuser => 1,
 268         borrowername => $borrowername,
 269         issues_count => scalar(@issues),
 270         ISSUES => \@issues,
 271         patronid => $patronid,
 272         patronlogin => $patronlogin,
 273         patronpw => $patronpw,
 274         noitemlinks => 1 ,
 275         borrowernumber => $borrower->{'borrowernumber'},
 276     );
 277
 278     my $patron_messages = Koha::Patron::Messages->search(
 279         {
 280             borrowernumber => $borrower->{'borrowernumber'},
 281             message_type => 'B',
 282         }
 283     );
 284     $template->param(
 285         patron_messages => $patron_messages,
 286         opacnote => $borrower->{opacnote},
 287     );
 288
 289     my $inputfocus = ($return_only      == 1) ? 'returnbook' :
 290                      ($confirm_required == 1) ? 'confirm'    : 'barcode' ;
 291     $template->param(
 292         inputfocus => $inputfocus,
 293         nofines => 1,
 294
 295     );
 296     if (C4::Context->preference('ShowPatronImageInWebBasedSelfCheck')) {
 297         my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
 298         $template->param(
 299             display_patron_image => 1,
 300             csrf_token           => Koha::Token->new->generate_csrf( { session_id => scalar $query->cookie('CGISESSID') . $borrower->{cardnumber}, id => $borrower->{userid}} ),
 301         ) if $patron_image;
 302     }
 303 } else {
 304     $template->param(
 305         patronid   => $patronid,
 306         nouser     => $patronid,
 307     );
 308 }
 309
 310 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };