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     if ( !$confirmed ) {
 141         ( $impossible, $needconfirm ) = CanBookBeIssued(
 142             $borrower,
 143             $barcode,
 144             undef,
 145             0,
 146             C4::Context->preference("AllowItemsOnHoldCheckoutSCO")
 147         );
 148     }
 149     $confirm_required = scalar keys %$needconfirm;
 150
 151     #warn "confirm_required: " . $confirm_required ;
 152     if (scalar keys %$impossible) {
 153
 154         #  warn "impossible: numkeys: " . scalar (keys(%$impossible));
 155         #warn join " ", keys %$impossible;
 156         my $issue_error = (keys %$impossible)[0];
 157
 158         # FIXME  we assume only one error.
 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, $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         my $issue_error = (keys %$needconfirm)[0];
 193         $template->param(
 194             impossible                => (keys %$needconfirm)[0],
 195             "circ_error_$issue_error" => 1,
 196             hide_main                 => 1,
 197         );
 198         if ($issue_error eq 'DEBT') {
 199             $template->param(amount => $currencySymbol.$needconfirm->{DEBT});
 200         }
 201     } else {
 202         if ( $confirmed || $issuenoconfirm ) {    # we'll want to call getpatroninfo again to get updated issues.
 203             my ( $hold_existed, $item );
 204             if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
 205                 # There is no easy way to know if the patron has been charged for this item.
 206                 # So we check if a hold existed for this item before the check in
 207                 $item = Koha::Items->find({ barcode => $barcode });
 208                 $hold_existed = Koha::Holds->search(
 209                     {
 210                         -and => {
 211                             borrowernumber => $borrower->{borrowernumber},
 212                             -or            => {
 213                                 biblionumber => $item->biblionumber,
 214                                 itemnumber   => $item->itemnumber
 215                             }
 216                         }
 217                     }
 218                 )->count;
 219             }
 220             AddIssue( $borrower, $barcode );
 221
 222             if ( $hold_existed ) {
 223                 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
 224                 $template->param(
 225                     # If the hold existed before the check in, let's confirm that the charge line exists
 226                     # Note that this should not be needed but since we do not have proper exception handling here we do it this way
 227                     patron_has_hold_fee => Koha::Account::Lines->search(
 228                         {
 229                             borrowernumber => $borrower->{borrowernumber},
 230                             accounttype    => 'Res',
 231                             description    => 'Reserve Charge - ' . $item->biblio->title,
 232                             date           => $dtf->format_date(dt_from_string)
 233                         }
 234                       )->count,
 235                 );
 236             }
 237         } else {
 238             $confirm_required = 1;
 239             #warn "issue confirmation";
 240             $template->param(
 241                 confirm    => "Issuing title: " . $item->{title},
 242                 barcode    => $barcode,
 243                 hide_main  => 1,
 244                 inputfocus => 'confirm',
 245             );
 246         }
 247     }
 248 } # $op
 249
 250 if ($borrower->{cardnumber}) {
 251 #   warn "issuer's  branchcode: " .   $issuer->{branchcode};
 252 #   warn   "user's  branchcode: " . $borrower->{branchcode};
 253     my $borrowername = sprintf "%s %s", ($borrower->{firstname} || ''), ($borrower->{surname} || '');
 254     my @issues;
 255     my ($issueslist) = GetPendingIssues( $borrower->{'borrowernumber'} );
 256     foreach my $it (@$issueslist) {
 257         my ($can_be_renewed, $renew_error) = CanBookBeRenewed(
 258             $borrower->{borrowernumber},
 259             $it->{itemnumber},
 260         );
 261         $it->{can_be_renewed} = $can_be_renewed;
 262         $it->{renew_error} = $renew_error;
 263         $it->{date_due}  = $it->{date_due_sql};
 264         push @issues, $it;
 265     }
 266
 267     $template->param(
 268         validuser => 1,
 269         borrowername => $borrowername,
 270         issues_count => scalar(@issues),
 271         ISSUES => \@issues,
 272         patronid => $patronid,
 273         patronlogin => $patronlogin,
 274         patronpw => $patronpw,
 275         noitemlinks => 1 ,
 276         borrowernumber => $borrower->{'borrowernumber'},
 277     );
 278
 279     my $patron_messages = Koha::Patron::Messages->search(
 280         {
 281             borrowernumber => $borrower->{'borrowernumber'},
 282             message_type => 'B',
 283         }
 284     );
 285     $template->param(
 286         patron_messages => $patron_messages,
 287         opacnote => $borrower->{opacnote},
 288     );
 289
 290     my $inputfocus = ($return_only      == 1) ? 'returnbook' :
 291                      ($confirm_required == 1) ? 'confirm'    : 'barcode' ;
 292     $template->param(
 293         inputfocus => $inputfocus,
 294         nofines => 1,
 295
 296     );
 297     if (C4::Context->preference('ShowPatronImageInWebBasedSelfCheck')) {
 298         my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
 299         $template->param(
 300             display_patron_image => 1,
 301             cardnumber           => $borrower->{cardnumber},
 302         ) if $patron_image;
 303     }
 304 } else {
 305     $template->param(
 306         patronid   => $patronid,
 307         nouser     => $patronid,
 308     );
 309 }
 310
 311 $template->param(
 312     SCOUserJS  => C4::Context->preference('SCOUserJS'),
 313     SCOUserCSS => C4::Context->preference('SCOUserCSS'),
 314 );
 315
 316 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };