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 use Modern::Perl;
  33
  34 use CGI qw ( -utf8 );
  35
  36 use C4::Auth qw(get_template_and_user checkpw in_iprange);
  37 use C4::Koha;
  38 use C4::Circulation;
  39 use C4::Reserves;
  40 use C4::Output;
  41 use C4::Members;
  42 use C4::Biblio;
  43 use C4::Items;
  44 use Koha::DateUtils qw( dt_from_string );
  45 use Koha::Acquisition::Currencies;
  46 use Koha::Items;
  47 use Koha::Patrons;
  48 use Koha::Patron::Images;
  49 use Koha::Patron::Messages;
  50 use Koha::Token;
  51
  52 my $query = CGI->new;
  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 unless ( in_iprange(C4::Context->preference('SelfCheckAllowByIPRanges')) ) {
  61     # redirect to OPAC home if self-checkout not permitted from current IP
  62     print $query->redirect("/cgi-bin/koha/opac-main.pl");
  63     exit;
  64 }
  65
  66 if (C4::Context->preference('AutoSelfCheckAllowed'))
  67 {
  68     my $AutoSelfCheckID = C4::Context->preference('AutoSelfCheckID');
  69     my $AutoSelfCheckPass = C4::Context->preference('AutoSelfCheckPass');
  70     $query->param(-name=>'userid',-values=>[$AutoSelfCheckID]);
  71     $query->param(-name=>'password',-values=>[$AutoSelfCheckPass]);
  72     $query->param(-name=>'koha_login_context',-values=>['sco']);
  73 }
  74 $query->param(-name=>'sco_user_login',-values=>[1]);
  75
  76 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  77     {
  78         template_name   => "sco/sco-main.tt",
  79         flagsrequired   => { self_check => "self_checkout_module" },
  80         query           => $query,
  81         type            => "opac",
  82         debug           => 1,
  83     }
  84 );
  85
  86 # Get the self checkout timeout preference, or use 120 seconds as a default
  87 my $selfchecktimeout = 120000;
  88 if (C4::Context->preference('SelfCheckTimeout')) {
  89     $selfchecktimeout = C4::Context->preference('SelfCheckTimeout') * 1000;
  90 }
  91 $template->param( SelfCheckTimeout => $selfchecktimeout );
  92
  93 # Checks policy laid out by SCOAllowCheckin, defaults to 'on' if preference is undefined
  94 my $allowselfcheckreturns = 1;
  95 if (defined C4::Context->preference('SCOAllowCheckin')) {
  96     $allowselfcheckreturns = C4::Context->preference('SCOAllowCheckin');
  97 }
  98
  99 my $issuerid = $loggedinuser;
 100 my ($op, $patronid, $patronlogin, $patronpw, $barcode, $confirmed, $newissues) = (
 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     $query->param("newissues")  || '',
 108 );
 109
 110 my @newissueslist = split /,/, $newissues;
 111 my $issuenoconfirm = 1; #don't need to confirm on issue.
 112 my $issuer   = Koha::Patrons->find( $issuerid )->unblessed;
 113 my $item     = Koha::Items->find({ barcode => $barcode });
 114 if (C4::Context->preference('SelfCheckoutByLogin') && !$patronid) {
 115     my $dbh = C4::Context->dbh;
 116     my $resval;
 117     ($resval, $patronid) = checkpw($dbh, $patronlogin, $patronpw);
 118 }
 119
 120 my $patron;
 121 if ( $patronid ) {
 122     $patron = Koha::Patrons->find( { cardnumber => $patronid } );
 123 }
 124
 125 my $branch = $issuer->{branchcode};
 126 my $confirm_required = 0;
 127 my $return_only = 0;
 128 if ($op eq "logout") {
 129     $template->param( loggedout => 1 );
 130     $query->param( patronid => undef, patronlogin => undef, patronpw => undef );
 131 }
 132 elsif ( $op eq "returnbook" && $allowselfcheckreturns ) {
 133     my $success        = 0;
 134     my $human_required = 0;
 135     if ( C4::Context->preference("CircConfirmItemParts") ) {
 136         my $item = Koha::Items->find( { barcode => $barcode } );
 137         if ( defined($item)
 138             && $item->materials )
 139         {
 140             $human_required = 1;
 141         }
 142     }
 143
 144     ($success) = AddReturn( $barcode, $branch )
 145       unless $human_required;
 146     $template->param( returned => $success );
 147 }
 148 elsif ( $patron && ( $op eq 'checkout' ) ) {
 149     my $impossible  = {};
 150     my $needconfirm = {};
 151     ( $impossible, $needconfirm ) = CanBookBeIssued(
 152         $patron,
 153         $barcode,
 154         undef,
 155         0,
 156         C4::Context->preference("AllowItemsOnHoldCheckoutSCO")
 157     );
 158     my $issue_error;
 159     if ( $confirm_required = scalar keys %$needconfirm ) {
 160         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 ) ) {
 161             if ( $needconfirm->{$error} ) {
 162                 $issue_error = $error;
 163                 $confirmed = 0;
 164                 last;
 165             }
 166         }
 167     }
 168
 169     #warn "confirm_required: " . $confirm_required ;
 170     if (scalar keys %$impossible) {
 171
 172         my $issue_error = (keys %$impossible)[0]; # FIXME This is wrong, we assume only one error and keys are not ordered
 173         my $title = ( $item ) ? $item->biblio->title : '';
 174
 175         $template->param(
 176             impossible                => $issue_error,
 177             "circ_error_$issue_error" => 1,
 178             title                     => $title,
 179             hide_main                 => 1,
 180         );
 181         if ($issue_error eq 'DEBT') {
 182             $template->param(DEBT => $impossible->{DEBT});
 183         }
 184         #warn "issue_error: " . $issue_error ;
 185         if ( $issue_error eq "NO_MORE_RENEWALS" ) {
 186             $return_only = 1;
 187             $template->param(
 188                 returnitem => 1,
 189                 barcode    => $barcode,
 190             );
 191         }
 192     } elsif ( $needconfirm->{RENEW_ISSUE} ){
 193         $template->param(
 194                 renew               => 1,
 195                 barcode             => $barcode,
 196                 confirm             => 1,
 197                 confirm_renew_issue => 1,
 198                 hide_main           => 1,
 199         );
 200     } elsif ( $confirm_required && !$confirmed ) {
 201         #warn "failed confirmation";
 202         $template->param(
 203             impossible                => 1,
 204             "circ_error_$issue_error" => 1,
 205             hide_main                 => 1,
 206         );
 207         if ($issue_error eq 'DEBT') {
 208             $template->param(DEBT => $needconfirm->{DEBT});
 209         }
 210     } else {
 211         if ( $confirmed || $issuenoconfirm ) {    # we'll want to call getpatroninfo again to get updated issues.
 212             my ( $hold_existed, $item );
 213             if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
 214                 # There is no easy way to know if the patron has been charged for this item.
 215                 # So we check if a hold existed for this item before the check in
 216                 $item = Koha::Items->find({ barcode => $barcode });
 217                 $hold_existed = Koha::Holds->search(
 218                     {
 219                         -and => {
 220                             borrowernumber => $patron->borrowernumber,
 221                             -or            => {
 222                                 biblionumber => $item->biblionumber,
 223                                 itemnumber   => $item->itemnumber
 224                             }
 225                         }
 226                     }
 227                 )->count;
 228             }
 229
 230             AddIssue( $patron->unblessed, $barcode );
 231             $template->param( issued => 1 );
 232             push @newissueslist, $barcode;
 233
 234             if ( $hold_existed ) {
 235                 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
 236                 $template->param(
 237                     # If the hold existed before the check in, let's confirm that the charge line exists
 238                     # Note that this should not be needed but since we do not have proper exception handling here we do it this way
 239                     patron_has_hold_fee => Koha::Account::Lines->search(
 240                         {
 241                             borrowernumber  => $patron->borrowernumber,
 242                             debit_type_code => 'RESERVE',
 243                             description     => $item->biblio->title,
 244                             date            => $dtf->format_date(dt_from_string)
 245                         }
 246                       )->count,
 247                 );
 248             }
 249         } else {
 250             $confirm_required = 1;
 251             #warn "issue confirmation";
 252             $template->param(
 253                 confirm    => "Issuing title: " . $item->biblio->title,
 254                 barcode    => $barcode,
 255                 hide_main  => 1,
 256             );
 257         }
 258     }
 259 } # $op
 260
 261 if ( $patron && ( $op eq 'renew' ) ) {
 262     my ($status,$renewerror) = CanBookBeRenewed( $patron->borrowernumber, $item->itemnumber );
 263     if ($status) {
 264         #warn "renewing";
 265         AddRenewal( $patron->borrowernumber, $item->itemnumber, undef, undef, undef, undef, 1 );
 266         push @newissueslist, $barcode;
 267         $template->param( renewed => 1 );
 268     }
 269 }
 270
 271 if ($patron) {
 272     my $borrowername = sprintf "%s %s", ($patron->firstname || ''), ($patron->surname || '');
 273     my $pending_checkouts = $patron->pending_checkouts;
 274     my @checkouts;
 275     while ( my $c = $pending_checkouts->next ) {
 276         my $checkout = $c->unblessed_all_relateds;
 277         my ($can_be_renewed, $renew_error) = CanBookBeRenewed(
 278             $patron->borrowernumber,
 279             $checkout->{itemnumber},
 280         );
 281         $checkout->{can_be_renewed} = $can_be_renewed; # In the future this will be $checkout->can_be_renewed
 282         $checkout->{renew_error} = $renew_error;
 283         $checkout->{overdue} = $c->is_overdue;
 284         push @checkouts, $checkout;
 285     }
 286
 287     my $show_priority;
 288     for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
 289         m/priority/ and $show_priority = 1;
 290     }
 291
 292     my $account = $patron->account;
 293     my $total = $account->balance;
 294     my $accountlines = $account->lines;
 295
 296     my $holds = $patron->holds;
 297     my $waiting_holds_count = 0;
 298
 299     while(my $hold = $holds->next) {
 300         $waiting_holds_count++ if $hold->is_waiting;
 301     }
 302
 303     $template->param(
 304         validuser => 1,
 305         borrowername => $borrowername,
 306         issues_count => scalar(@checkouts),
 307         ISSUES => \@checkouts,
 308         HOLDS => $holds,
 309         newissues => join(',',@newissueslist),
 310         patronid => $patronid,
 311         patronlogin => $patronlogin,
 312         patronpw => $patronpw,
 313         waiting_holds_count => $waiting_holds_count,
 314         noitemlinks => 1 ,
 315         borrowernumber => $patron->borrowernumber,
 316         SuspendHoldsOpac => C4::Context->preference('SuspendHoldsOpac'),
 317         AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
 318         howpriority   => $show_priority,
 319         ACCOUNT_LINES => $accountlines,
 320         total => $total,
 321     );
 322
 323     my $patron_messages = Koha::Patron::Messages->search(
 324         {
 325             borrowernumber => $patron->borrowernumber,
 326             message_type => 'B',
 327         }
 328     );
 329     $template->param(
 330         patron_messages => $patron_messages,
 331         opacnote => $patron->opacnote,
 332     );
 333
 334     $template->param(
 335         nofines => 1,
 336
 337     );
 338     if (C4::Context->preference('ShowPatronImageInWebBasedSelfCheck')) {
 339         my $patron_image = $patron->image;
 340         $template->param(
 341             display_patron_image => 1,
 342             csrf_token           => Koha::Token->new->generate_csrf( { session_id => scalar $query->cookie('CGISESSID') . $patron->cardnumber, id => $patron->userid } ),
 343         ) if $patron_image;
 344     }
 345 } else {
 346     $template->param(
 347         patronid   => $patronid,
 348         nouser     => $patronid,
 349     );
 350 }
 351
 352 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };