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