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