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)
7 # This file is part of Koha.
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.
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.
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>.
22 # We're going to authenticate a self-check user. we'll add a flag to borrowers 'selfcheck'
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!
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.
32 # FIXME: inputfocus not really used in TMPL
38 use C4::Auth qw( in_iprange get_template_and_user checkpw );
39 use C4::Circulation qw( barcodedecode AddReturn CanBookBeIssued AddIssue CanBookBeRenewed AddRenewal );
41 use C4::Output qw( output_html_with_http_headers );
43 use Koha::DateUtils qw( dt_from_string );
44 use Koha::Acquisition::Currencies;
47 use Koha::Patron::Images;
48 use Koha::Patron::Messages;
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");
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");
66 if (C4::Context->preference('AutoSelfCheckAllowed'))
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']);
74 $query->param(-name=>'sco_user_login',-values=>[1]);
76 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
78 template_name => "sco/sco-main.tt",
79 flagsrequired => { self_check => "self_checkout_module" },
85 # Get the self checkout timeout preference, or use 120 seconds as a default
86 my $selfchecktimeout = 120000;
87 if (C4::Context->preference('SelfCheckTimeout')) {
88 $selfchecktimeout = C4::Context->preference('SelfCheckTimeout') * 1000;
90 $template->param( SelfCheckTimeout => $selfchecktimeout );
92 # Checks policy laid out by SCOAllowCheckin, defaults to 'on' if preference is undefined
93 my $allowselfcheckreturns = 1;
94 if (defined C4::Context->preference('SCOAllowCheckin')) {
95 $allowselfcheckreturns = C4::Context->preference('SCOAllowCheckin');
98 my $issuerid = $loggedinuser;
99 my ($op, $patronid, $patronlogin, $patronpw, $barcode, $confirmed, $newissues) = (
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 $query->param("newissues") || '',
109 $barcode = barcodedecode( $barcode ) if $barcode;
111 my @newissueslist = split /,/, $newissues;
112 my $issuenoconfirm = 1; #don't need to confirm on issue.
113 my $issuer = Koha::Patrons->find( $issuerid )->unblessed;
114 my $item = Koha::Items->find({ barcode => $barcode });
115 if (C4::Context->preference('SelfCheckoutByLogin') && !$patronid) {
116 my $dbh = C4::Context->dbh;
118 ($resval, $patronid) = checkpw($dbh, $patronlogin, $patronpw);
121 my ( $borrower, $patron );
123 ( $patronid ) = Koha::Plugins->call_recursive( 'patron_barcode_transform', $patronid );
124 $patron = Koha::Patrons->find( { cardnumber => $patronid } );
125 $borrower = $patron->unblessed if $patron;
128 my $branch = $issuer->{branchcode};
129 my $confirm_required = 0;
131 #warn "issuer cardnumber: " . $issuer->{cardnumber};
132 #warn "patron cardnumber: " . $borrower->{cardnumber};
133 if ($op eq "logout") {
134 $template->param( loggedout => 1 );
135 $query->param( patronid => undef, patronlogin => undef, patronpw => undef );
137 elsif ( $op eq "returnbook" && $allowselfcheckreturns ) {
139 my $human_required = 0;
140 if ( C4::Context->preference("CircConfirmItemParts") ) {
141 my $item = Koha::Items->find( { barcode => $barcode } );
143 && $item->materials )
149 ($success) = AddReturn( $barcode, $branch )
150 unless $human_required;
151 $template->param( returned => $success );
153 elsif ( $patron && ( $op eq 'checkout' ) ) {
155 my $needconfirm = {};
156 ( $impossible, $needconfirm ) = CanBookBeIssued(
161 C4::Context->preference("AllowItemsOnHoldCheckoutSCO")
164 if ( $confirm_required = scalar keys %$needconfirm ) {
165 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 ) ) {
166 if ( $needconfirm->{$error} ) {
167 $issue_error = $error;
174 #warn "confirm_required: " . $confirm_required ;
175 if (scalar keys %$impossible) {
177 my $issue_error = (keys %$impossible)[0]; # FIXME This is wrong, we assume only one error and keys are not ordered
178 my $title = ( $item ) ? $item->biblio->title : '';
181 impossible => $issue_error,
182 "circ_error_$issue_error" => 1,
186 if ($issue_error eq 'DEBT') {
187 $template->param(DEBT => $impossible->{DEBT});
189 #warn "issue_error: " . $issue_error ;
190 if ( $issue_error eq "NO_MORE_RENEWALS" ) {
197 } elsif ( $needconfirm->{RENEW_ISSUE} ){
202 confirm_renew_issue => 1,
205 } elsif ( $confirm_required && !$confirmed ) {
206 #warn "failed confirmation";
209 "circ_error_$issue_error" => 1,
212 if ($issue_error eq 'DEBT') {
213 $template->param(DEBT => $needconfirm->{DEBT});
216 if ( $confirmed || $issuenoconfirm ) { # we'll want to call getpatroninfo again to get updated issues.
217 my ( $hold_existed, $item );
218 if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
219 # There is no easy way to know if the patron has been charged for this item.
220 # So we check if a hold existed for this item before the check in
221 $item = Koha::Items->find({ barcode => $barcode });
222 $hold_existed = Koha::Holds->search(
225 borrowernumber => $borrower->{borrowernumber},
227 biblionumber => $item->biblionumber,
228 itemnumber => $item->itemnumber
235 AddIssue( $borrower, $barcode );
236 $template->param( issued => 1 );
237 push @newissueslist, $barcode;
239 if ( $hold_existed ) {
240 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
242 # If the hold existed before the check in, let's confirm that the charge line exists
243 # Note that this should not be needed but since we do not have proper exception handling here we do it this way
244 patron_has_hold_fee => Koha::Account::Lines->search(
246 borrowernumber => $borrower->{borrowernumber},
247 debit_type_code => 'RESERVE',
248 description => $item->biblio->title,
249 date => $dtf->format_date(dt_from_string)
255 $confirm_required = 1;
256 #warn "issue confirmation";
258 confirm => "Issuing title: " . $item->biblio->title,
261 inputfocus => 'confirm',
267 if ( $patron && ( $op eq 'renew' ) ) {
268 my ($status,$renewerror) = CanBookBeRenewed( $borrower->{borrowernumber}, $item->itemnumber );
271 AddRenewal( $borrower->{borrowernumber}, $item->itemnumber, undef, undef, undef, undef, 1 );
272 push @newissueslist, $barcode;
273 $template->param( renewed => 1 );
278 # warn "issuer's branchcode: " . $issuer->{branchcode};
279 # warn "user's branchcode: " . $borrower->{branchcode};
280 my $borrowername = sprintf "%s %s", ($borrower->{firstname} || ''), ($borrower->{surname} || '');
281 my $pending_checkouts = $patron->pending_checkouts;
283 while ( my $c = $pending_checkouts->next ) {
284 my $checkout = $c->unblessed_all_relateds;
285 my ($can_be_renewed, $renew_error) = CanBookBeRenewed(
286 $borrower->{borrowernumber},
287 $checkout->{itemnumber},
289 $checkout->{can_be_renewed} = $can_be_renewed; # In the future this will be $checkout->can_be_renewed
290 $checkout->{renew_error} = $renew_error;
291 $checkout->{overdue} = $c->is_overdue;
292 push @checkouts, $checkout;
296 for ( C4::Context->preference("OPACShowHoldQueueDetails") ) {
297 m/priority/ and $show_priority = 1;
300 my $account = $patron->account;
301 my $total = $account->balance;
302 my $accountlines = $account->lines;
304 my $holds = $patron->holds;
305 my $waiting_holds_count = 0;
307 while(my $hold = $holds->next) {
308 $waiting_holds_count++ if $hold->is_waiting;
313 borrowername => $borrowername,
314 issues_count => scalar(@checkouts),
315 ISSUES => \@checkouts,
317 newissues => join(',',@newissueslist),
318 patronid => $patronid,
319 patronlogin => $patronlogin,
320 patronpw => $patronpw,
321 waiting_holds_count => $waiting_holds_count,
323 borrowernumber => $borrower->{'borrowernumber'},
324 SuspendHoldsOpac => C4::Context->preference('SuspendHoldsOpac'),
325 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
326 howpriority => $show_priority,
327 ACCOUNT_LINES => $accountlines,
331 my $patron_messages = Koha::Patron::Messages->search(
333 borrowernumber => $borrower->{'borrowernumber'},
338 patron_messages => $patron_messages,
339 opacnote => $borrower->{opacnote},
342 my $inputfocus = ($return_only == 1) ? 'returnbook' :
343 ($confirm_required == 1) ? 'confirm' : 'barcode' ;
345 inputfocus => $inputfocus,
349 if (C4::Context->preference('ShowPatronImageInWebBasedSelfCheck')) {
350 my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
352 display_patron_image => 1,
353 csrf_token => Koha::Token->new->generate_csrf( { session_id => scalar $query->cookie('CGISESSID') . $borrower->{cardnumber}, id => $borrower->{userid}} ),
358 patronid => $patronid,
363 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };