Bug 22675: Fix SCO behaviour on non-existent barcodes
[koha.git] / 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::Items;
49 use Koha::Patrons;
50 use Koha::Patron::Images;
51 use Koha::Patron::Messages;
52 use Koha::Token;
53
54 my $query = new CGI;
55
56 unless (C4::Context->preference('WebBasedSelfCheck')) {
57     # redirect to OPAC home if self-check is not enabled
58     print $query->redirect("/cgi-bin/koha/opac-main.pl");
59     exit;
60 }
61
62 if (C4::Context->preference('AutoSelfCheckAllowed')) 
63 {
64     my $AutoSelfCheckID = C4::Context->preference('AutoSelfCheckID');
65     my $AutoSelfCheckPass = C4::Context->preference('AutoSelfCheckPass');
66     $query->param(-name=>'userid',-values=>[$AutoSelfCheckID]);
67     $query->param(-name=>'password',-values=>[$AutoSelfCheckPass]);
68     $query->param(-name=>'koha_login_context',-values=>['sco']);
69 }
70 $query->param(-name=>'sco_user_login',-values=>[1]);
71
72 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
73     {
74         template_name   => "sco/sco-main.tt",
75         authnotrequired => 0,
76         flagsrequired   => { self_check => "self_checkout_module" },
77         query           => $query,
78         type            => "opac",
79         debug           => 1,
80     }
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
96 my $issuerid = $loggedinuser;
97 my ($op, $patronid, $patronlogin, $patronpw, $barcode, $confirmed, $newissues) = (
98     $query->param("op")         || '',
99     $query->param("patronid")   || '',
100     $query->param("patronlogin")|| '',
101     $query->param("patronpw")   || '',
102     $query->param("barcode")    || '',
103     $query->param("confirmed")  || '',
104     $query->param("newissues")  || '',
105 );
106
107 my @newissueslist = split /,/, $newissues;
108 my $issuenoconfirm = 1; #don't need to confirm on issue.
109 my $issuer   = Koha::Patrons->find( $issuerid )->unblessed;
110 my $item     = Koha::Items->find({ barcode => $barcode });
111 if (C4::Context->preference('SelfCheckoutByLogin') && !$patronid) {
112     my $dbh = C4::Context->dbh;
113     my $resval;
114     ($resval, $patronid) = checkpw($dbh, $patronlogin, $patronpw);
115 }
116
117 my ( $borrower, $patron );
118 if ( $patronid ) {
119     $patron = Koha::Patrons->find( { cardnumber => $patronid } );
120     $borrower = $patron->unblessed if $patron;
121 }
122
123 my $branch = $issuer->{branchcode};
124 my $confirm_required = 0;
125 my $return_only = 0;
126 #warn "issuer cardnumber: " .   $issuer->{cardnumber};
127 #warn "patron cardnumber: " . $borrower->{cardnumber};
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 ($doreturn) = AddReturn( $barcode, $branch );
134     $template->param( returned => $doreturn );
135 }
136 elsif ( $patron && ( $op eq 'checkout' || $op eq 'renew' ) ) {
137     my $impossible  = {};
138     my $needconfirm = {};
139     ( $impossible, $needconfirm ) = CanBookBeIssued(
140         $patron,
141         $barcode,
142         undef,
143         0,
144         C4::Context->preference("AllowItemsOnHoldCheckoutSCO")
145     );
146     my $issue_error;
147     if ( $confirm_required = scalar keys %$needconfirm ) {
148         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) ) {
149             if ( $needconfirm->{$error} ) {
150                 $issue_error = $error;
151                 $confirmed = 0;
152                 last;
153             }
154         }
155     }
156
157     #warn "confirm_required: " . $confirm_required ;
158     if (scalar keys %$impossible) {
159
160         my $issue_error = (keys %$impossible)[0]; # FIXME This is wrong, we assume only one error and keys are not ordered
161         my $title = ( $item ) ? $item->biblio->title : '';
162
163         $template->param(
164             impossible                => $issue_error,
165             "circ_error_$issue_error" => 1,
166             title                     => $title,
167             hide_main                 => 1,
168         );
169         if ($issue_error eq 'DEBT') {
170             $template->param(DEBT => $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} || $op eq 'renew' ) {
181         if ($confirmed) {
182             #warn "renewing";
183             AddRenewal( $borrower->{borrowernumber}, $item->itemnumber );
184             push @newissueslist, $barcode;
185             $template->param( renewed => 1 );
186         } else {
187             #warn "renew confirmation";
188             $template->param(
189                 renew               => 1,
190                 barcode             => $barcode,
191                 confirm             => 1,
192                 confirm_renew_issue => 1,
193                 hide_main           => 1,
194             );
195         }
196     } elsif ( $confirm_required && !$confirmed ) {
197         #warn "failed confirmation";
198         $template->param(
199             impossible                => 1,
200             "circ_error_$issue_error" => 1,
201             hide_main                 => 1,
202         );
203         if ($issue_error eq 'DEBT') {
204             $template->param(DEBT => $needconfirm->{DEBT});
205         }
206     } else {
207         if ( $confirmed || $issuenoconfirm ) {    # we'll want to call getpatroninfo again to get updated issues.
208             my ( $hold_existed, $item );
209             if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
210                 # There is no easy way to know if the patron has been charged for this item.
211                 # So we check if a hold existed for this item before the check in
212                 $item = Koha::Items->find({ barcode => $barcode });
213                 $hold_existed = Koha::Holds->search(
214                     {
215                         -and => {
216                             borrowernumber => $borrower->{borrowernumber},
217                             -or            => {
218                                 biblionumber => $item->biblionumber,
219                                 itemnumber   => $item->itemnumber
220                             }
221                         }
222                     }
223                 )->count;
224             }
225
226             AddIssue( $borrower, $barcode );
227             $template->param( issued => 1 );
228             push @newissueslist, $barcode;
229
230             if ( $hold_existed ) {
231                 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
232                 $template->param(
233                     # If the hold existed before the check in, let's confirm that the charge line exists
234                     # Note that this should not be needed but since we do not have proper exception handling here we do it this way
235                     patron_has_hold_fee => Koha::Account::Lines->search(
236                         {
237                             borrowernumber => $borrower->{borrowernumber},
238                             accounttype    => 'Res',
239                             description    => 'Reserve Charge - ' . $item->biblio->title,
240                             date           => $dtf->format_date(dt_from_string)
241                         }
242                       )->count,
243                 );
244             }
245         } else {
246             $confirm_required = 1;
247             #warn "issue confirmation";
248             $template->param(
249                 confirm    => "Issuing title: " . $item->biblio->title,
250                 barcode    => $barcode,
251                 hide_main  => 1,
252                 inputfocus => 'confirm',
253             );
254         }
255     }
256 } # $op
257
258 if ($borrower) {
259 #   warn "issuer's  branchcode: " .   $issuer->{branchcode};
260 #   warn   "user's  branchcode: " . $borrower->{branchcode};
261     my $borrowername = sprintf "%s %s", ($borrower->{firstname} || ''), ($borrower->{surname} || '');
262     my $pending_checkouts = $patron->pending_checkouts;
263     my @checkouts;
264     while ( my $c = $pending_checkouts->next ) {
265         my $checkout = $c->unblessed_all_relateds;
266         my ($can_be_renewed, $renew_error) = CanBookBeRenewed(
267             $borrower->{borrowernumber},
268             $checkout->{itemnumber},
269         );
270         $checkout->{can_be_renewed} = $can_be_renewed; # In the future this will be $checkout->can_be_renewed
271         $checkout->{renew_error} = $renew_error;
272         $checkout->{overdue} = $c->is_overdue;
273         push @checkouts, $checkout;
274     }
275
276     my $show_priority;
277     for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
278         m/priority/ and $show_priority = 1;
279     }
280
281     my $total = $patron->account->balance;
282     my $accts = Koha::Account::Lines->search(
283         { borrowernumber => $borrower->{borrowernumber} },
284         { order_by       => { -desc => 'accountlines_id' } }
285     );
286
287     my @accountlines;
288     while ( my $line = $accts->next ) {
289         my $accountline = $line->unblessed;
290         $accountline->{'amount'} = sprintf( "%.2f", $accountline->{'amount'} || '0.00');
291         if ( $accountline->{'amount'} >= 0 ) {
292             $accountline->{'amountcredit'} = 1;
293         }
294         $accountline->{'amountoutstanding'} =
295         sprintf( "%.2f", $accountline->{'amountoutstanding'} || '0.00' );
296         if ( $accountline->{'amountoutstanding'} >= 0 ) {
297             $accountline->{'amountoutstandingcredit'} = 1;
298         }
299         push @accountlines, $accountline;
300     }
301
302     my $holds = $patron->holds;
303
304     $template->param(
305         validuser => 1,
306         borrowername => $borrowername,
307         issues_count => scalar(@checkouts),
308         ISSUES => \@checkouts,
309         HOLDS => $holds,
310         newissues => join(',',@newissueslist),
311         patronid => $patronid,
312         patronlogin => $patronlogin,
313         patronpw => $patronpw,
314         noitemlinks => 1 ,
315         borrowernumber => $borrower->{'borrowernumber'},
316         SuspendHoldsOpac => C4::Context->preference('SuspendHoldsOpac'),
317         AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
318         showpriority   => $show_priority,
319         ACCOUNT_LINES => \@accountlines,
320         total => sprintf( "%.2f", $total ),
321     );
322
323     my $patron_messages = Koha::Patron::Messages->search(
324         {
325             borrowernumber => $borrower->{'borrowernumber'},
326             message_type => 'B',
327         }
328     );
329     $template->param(
330         patron_messages => $patron_messages,
331         opacnote => $borrower->{opacnote},
332     );
333
334     my $inputfocus = ($return_only      == 1) ? 'returnbook' :
335                      ($confirm_required == 1) ? 'confirm'    : 'barcode' ;
336     $template->param(
337         inputfocus => $inputfocus,
338         nofines => 1,
339
340     );
341     if (C4::Context->preference('ShowPatronImageInWebBasedSelfCheck')) {
342         my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
343         $template->param(
344             display_patron_image => 1,
345             csrf_token           => Koha::Token->new->generate_csrf( { session_id => scalar $query->cookie('CGISESSID') . $borrower->{cardnumber}, id => $borrower->{userid}} ),
346         ) if $patron_image;
347     }
348 } else {
349     $template->param(
350         patronid   => $patronid,
351         nouser     => $patronid,
352     );
353 }
354
355 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };