Bug 19502: Retrieve index.max_result_window from ES
[koha.git] / opac / sco / sco-main.pl
blob9fcf7293b51b981f823671c6bade8e854b71a536
1 #!/usr/bin/perl
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
34 use Modern::Perl;
36 use CGI qw ( -utf8 );
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;
53 my $query = new CGI;
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;
61 if (C4::Context->preference('AutoSelfCheckAllowed'))
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']);
69 $query->param(-name=>'sco_user_login',-values=>[1]);
71 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
73 template_name => "sco/sco-main.tt",
74 authnotrequired => 0,
75 flagsrequired => { self_check => "self_checkout_module" },
76 query => $query,
77 type => "opac",
78 debug => 1,
82 # Get the self checkout timeout preference, or use 120 seconds as a default
83 my $selfchecktimeout = 120000;
84 if (C4::Context->preference('SelfCheckTimeout')) {
85 $selfchecktimeout = C4::Context->preference('SelfCheckTimeout') * 1000;
87 $template->param( SelfCheckTimeout => $selfchecktimeout );
89 # Checks policy laid out by AllowSelfCheckReturns, defaults to 'on' if preference is undefined
90 my $allowselfcheckreturns = 1;
91 if (defined C4::Context->preference('AllowSelfCheckReturns')) {
92 $allowselfcheckreturns = C4::Context->preference('AllowSelfCheckReturns');
95 my $issuerid = $loggedinuser;
96 my ($op, $patronid, $patronlogin, $patronpw, $barcode, $confirmed) = (
97 $query->param("op") || '',
98 $query->param("patronid") || '',
99 $query->param("patronlogin")|| '',
100 $query->param("patronpw") || '',
101 $query->param("barcode") || '',
102 $query->param("confirmed") || '',
105 my $issuenoconfirm = 1; #don't need to confirm on issue.
106 my $issuer = Koha::Patrons->find( $issuerid )->unblessed;
107 my $item = GetItem(undef,$barcode);
108 if (C4::Context->preference('SelfCheckoutByLogin') && !$patronid) {
109 my $dbh = C4::Context->dbh;
110 my $resval;
111 ($resval, $patronid) = checkpw($dbh, $patronlogin, $patronpw);
114 my ( $borrower, $patron );
115 if ( $patronid ) {
116 $patron = Koha::Patrons->find( { cardnumber => $patronid } );
117 $borrower = $patron->unblessed if $patron;
120 my $branch = $issuer->{branchcode};
121 my $confirm_required = 0;
122 my $return_only = 0;
123 #warn "issuer cardnumber: " . $issuer->{cardnumber};
124 #warn "patron cardnumber: " . $borrower->{cardnumber};
125 if ($op eq "logout") {
126 $query->param( patronid => undef, patronlogin => undef, patronpw => undef );
128 elsif ( $op eq "returnbook" && $allowselfcheckreturns ) {
129 my ($doreturn) = AddReturn( $barcode, $branch );
131 elsif ( $patron and $op eq "checkout" ) {
132 my $impossible = {};
133 my $needconfirm = {};
134 ( $impossible, $needconfirm ) = CanBookBeIssued(
135 $patron,
136 $barcode,
137 undef,
139 C4::Context->preference("AllowItemsOnHoldCheckoutSCO")
141 my $issue_error;
142 if ( $confirm_required = scalar keys %$needconfirm ) {
143 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) ) {
144 if ( $needconfirm->{$error} ) {
145 $issue_error = $error;
146 $confirmed = 0;
147 last;
152 #warn "confirm_required: " . $confirm_required ;
153 if (scalar keys %$impossible) {
155 my $issue_error = (keys %$impossible)[0]; # FIXME This is wrong, we assume only one error and keys are not ordered
157 $template->param(
158 impossible => $issue_error,
159 "circ_error_$issue_error" => 1,
160 title => $item->{title},
161 hide_main => 1,
163 if ($issue_error eq 'DEBT') {
164 $template->param(DEBT => $impossible->{DEBT});
166 #warn "issue_error: " . $issue_error ;
167 if ( $issue_error eq "NO_MORE_RENEWALS" ) {
168 $return_only = 1;
169 $template->param(
170 returnitem => 1,
171 barcode => $barcode,
174 } elsif ( $needconfirm->{RENEW_ISSUE} ) {
175 if ($confirmed) {
176 #warn "renewing";
177 AddRenewal( $borrower->{borrowernumber}, $item->{itemnumber} );
178 } else {
179 #warn "renew confirmation";
180 $template->param(
181 renew => 1,
182 barcode => $barcode,
183 confirm => 1,
184 confirm_renew_issue => 1,
185 hide_main => 1,
188 } elsif ( $confirm_required && !$confirmed ) {
189 #warn "failed confirmation";
190 $template->param(
191 impossible => 1,
192 "circ_error_$issue_error" => 1,
193 hide_main => 1,
195 if ($issue_error eq 'DEBT') {
196 $template->param(DEBT => $needconfirm->{DEBT});
198 } else {
199 if ( $confirmed || $issuenoconfirm ) { # we'll want to call getpatroninfo again to get updated issues.
200 my ( $hold_existed, $item );
201 if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
202 # There is no easy way to know if the patron has been charged for this item.
203 # So we check if a hold existed for this item before the check in
204 $item = Koha::Items->find({ barcode => $barcode });
205 $hold_existed = Koha::Holds->search(
207 -and => {
208 borrowernumber => $borrower->{borrowernumber},
209 -or => {
210 biblionumber => $item->biblionumber,
211 itemnumber => $item->itemnumber
215 )->count;
217 AddIssue( $borrower, $barcode );
219 if ( $hold_existed ) {
220 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
221 $template->param(
222 # If the hold existed before the check in, let's confirm that the charge line exists
223 # Note that this should not be needed but since we do not have proper exception handling here we do it this way
224 patron_has_hold_fee => Koha::Account::Lines->search(
226 borrowernumber => $borrower->{borrowernumber},
227 accounttype => 'Res',
228 description => 'Reserve Charge - ' . $item->biblio->title,
229 date => $dtf->format_date(dt_from_string)
231 )->count,
234 } else {
235 $confirm_required = 1;
236 #warn "issue confirmation";
237 $template->param(
238 confirm => "Issuing title: " . $item->{title},
239 barcode => $barcode,
240 hide_main => 1,
241 inputfocus => 'confirm',
245 } # $op
247 if ($borrower) {
248 # warn "issuer's branchcode: " . $issuer->{branchcode};
249 # warn "user's branchcode: " . $borrower->{branchcode};
250 my $borrowername = sprintf "%s %s", ($borrower->{firstname} || ''), ($borrower->{surname} || '');
251 my $pending_checkouts = $patron->pending_checkouts;
252 my @checkouts;
253 while ( my $c = $pending_checkouts->next ) {
254 my $checkout = $c->unblessed_all_relateds;
255 my ($can_be_renewed, $renew_error) = CanBookBeRenewed(
256 $borrower->{borrowernumber},
257 $checkout->{itemnumber},
259 $checkout->{can_be_renewed} = $can_be_renewed; # In the future this will be $checkout->can_be_renewed
260 $checkout->{renew_error} = $renew_error;
261 $checkout->{overdue} = $c->is_overdue;
262 push @checkouts, $checkout;
265 $template->param(
266 validuser => 1,
267 borrowername => $borrowername,
268 issues_count => scalar(@checkouts),
269 ISSUES => \@checkouts,
270 patronid => $patronid,
271 patronlogin => $patronlogin,
272 patronpw => $patronpw,
273 noitemlinks => 1 ,
274 borrowernumber => $borrower->{'borrowernumber'},
277 my $patron_messages = Koha::Patron::Messages->search(
279 borrowernumber => $borrower->{'borrowernumber'},
280 message_type => 'B',
283 $template->param(
284 patron_messages => $patron_messages,
285 opacnote => $borrower->{opacnote},
288 my $inputfocus = ($return_only == 1) ? 'returnbook' :
289 ($confirm_required == 1) ? 'confirm' : 'barcode' ;
290 $template->param(
291 inputfocus => $inputfocus,
292 nofines => 1,
295 if (C4::Context->preference('ShowPatronImageInWebBasedSelfCheck')) {
296 my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
297 $template->param(
298 display_patron_image => 1,
299 csrf_token => Koha::Token->new->generate_csrf( { session_id => scalar $query->cookie('CGISESSID') . $borrower->{cardnumber}, id => $borrower->{userid}} ),
300 ) if $patron_image;
302 } else {
303 $template->param(
304 patronid => $patronid,
305 nouser => $patronid,
309 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };