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