b2bf087dfb32e8560417b172c1dca29a505c5cd0
[share-koha-fer] / intranet / cgi-bin / circ / circulation.pl
1 #!/usr/bin/perl
2
3 # script to execute issuing of books
4
5 # Copyright 2000-2002 Katipo Communications
6 # copyright 2010 BibLibre
7 # Copyright 2011 PTFS-Europe Ltd.
8 # Copyright 2012 software.coop and MJ Ray
9 #
10 # This file is part of Koha.
11 #
12 # Koha is free software; you can redistribute it and/or modify it
13 # under the terms of the GNU General Public License as published by
14 # the Free Software Foundation; either version 3 of the License, or
15 # (at your option) any later version.
16 #
17 # Koha is distributed in the hope that it will be useful, but
18 # WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 # GNU General Public License for more details.
21 #
22 # You should have received a copy of the GNU General Public License
23 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24
25 # FIXME There are too many calls to Koha::Patrons->find in this script
26
27 use Modern::Perl;
28 use CGI qw ( -utf8 );
29 use DateTime;
30 use DateTime::Duration;
31 use Scalar::Util qw( looks_like_number );
32 use C4::Output;
33 use C4::Print;
34 use C4::Auth qw/:DEFAULT get_session haspermission/;
35 use C4::Koha;   # GetPrinter
36 use C4::Circulation;
37 use C4::Utils::DataTables::Members;
38 use C4::Members;
39 use C4::Biblio;
40 use C4::Search;
41 use MARC::Record;
42 use C4::Reserves;
43 use Koha::Holds;
44 use C4::Context;
45 use CGI::Session;
46 use Koha::AuthorisedValues;
47 use Koha::CsvProfiles;
48 use Koha::Patrons;
49 use Koha::Patron::Debarments qw(GetDebarments);
50 use Koha::DateUtils;
51 use Koha::Database;
52 use Koha::BiblioFrameworks;
53 use Koha::Items;
54 use Koha::Patron::Messages;
55 use Koha::SearchEngine;
56 use Koha::SearchEngine::Search;
57 use Koha::Patron::Modifications;
58
59 use Date::Calc qw(
60   Today
61   Add_Delta_Days
62   Date_to_Days
63 );
64 use List::MoreUtils qw/uniq/;
65
66 #
67 # PARAMETERS READING
68 #
69 my $query = new CGI;
70
71 my $override_high_holds     = $query->param('override_high_holds');
72 my $override_high_holds_tmp = $query->param('override_high_holds_tmp');
73
74 my $sessionID = $query->cookie("CGISESSID") ;
75 my $session = get_session($sessionID);
76 if (!C4::Context->userenv){
77     if ($session->param('branch') eq 'NO_LIBRARY_SET'){
78         # no branch set we can't issue
79         print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
80         exit;
81     }
82 }
83
84 my $barcodes = [];
85 my $barcode =  $query->param('barcode');
86 my $findborrower;
87 my $autoswitched;
88 my $borrowernumber = $query->param('borrowernumber');
89
90 if (C4::Context->preference("AutoSwitchPatron") && $barcode) {
91     if (Koha::Patrons->search( { cardnumber => $barcode} )->count() > 0) {
92         $findborrower = $barcode;
93         undef $barcode;
94         undef $borrowernumber;
95         $autoswitched = 1;
96     }
97 }
98 $findborrower ||= $query->param('findborrower') || q{};
99 $findborrower =~ s|,| |g;
100
101 # Barcode given by user could be '0'
102 if ( $barcode || ( defined($barcode) && $barcode eq '0' ) ) {
103     $barcodes = [ $barcode ];
104 } else {
105     my $filefh = $query->upload('uploadfile');
106     if ( $filefh ) {
107         while ( my $content = <$filefh> ) {
108             $content =~ s/[\r\n]*$//g;
109             push @$barcodes, $content if $content;
110         }
111     } elsif ( my $list = $query->param('barcodelist') ) {
112         push @$barcodes, split( /\s\n/, $list );
113         $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
114     } else {
115         @$barcodes = $query->multi_param('barcodes');
116     }
117 }
118
119 $barcodes = [ uniq @$barcodes ];
120
121 my $template_name = q|circ/circulation.tt|;
122 my $patron = $borrowernumber ? Koha::Patrons->find( $borrowernumber ) : undef;
123 my $batch = $query->param('batch');
124 my $batch_allowed = 0;
125 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
126     $template_name = q|circ/circulation_batch_checkouts.tt|;
127     my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
128     my $categorycode = $patron->categorycode;
129     if ( $categorycode && grep {/^$categorycode$/} @batch_category_codes ) {
130         $batch_allowed = 1;
131     } else {
132         $barcodes = [];
133     }
134 }
135
136 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
137     {
138         template_name   => $template_name,
139         query           => $query,
140         type            => "intranet",
141         authnotrequired => 0,
142         flagsrequired   => { circulate => 'circulate_remaining_permissions' },
143     }
144 );
145 my $logged_in_user = Koha::Patrons->find( $loggedinuser ) or die "Not logged in";
146
147 my $force_allow_issue = $query->param('forceallow') || 0;
148 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
149     $force_allow_issue = 0;
150 }
151
152 my $onsite_checkout = $query->param('onsite_checkout');
153
154 my @failedrenews = $query->multi_param('failedrenew');    # expected to be itemnumbers
155 our %renew_failed = ();
156 for (@failedrenews) { $renew_failed{$_} = 1; }
157
158 my @failedreturns = $query->multi_param('failedreturn');
159 our %return_failed = ();
160 for (@failedreturns) { $return_failed{$_} = 1; }
161
162 my $searchtype = $query->param('searchtype') || q{contain};
163
164 my $branch = C4::Context->userenv->{'branch'};
165
166 if (C4::Context->preference("DisplayClearScreenButton")) {
167     $template->param(DisplayClearScreenButton => 1);
168 }
169
170 for my $barcode ( @$barcodes ) {
171     $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
172     $barcode = barcodedecode($barcode)
173         if( $barcode && C4::Context->preference('itemBarcodeInputFilter'));
174 }
175
176 my $stickyduedate  = $query->param('stickyduedate') || $session->param('stickyduedate');
177 my $duedatespec    = $query->param('duedatespec')   || $session->param('stickyduedate');
178 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso', timeformat => '24hr' }); }
179     if ( $duedatespec );
180 my $restoreduedatespec  = $query->param('restoreduedatespec') || $duedatespec || $session->param('stickyduedate');
181 if ( $restoreduedatespec && $restoreduedatespec eq "highholds_empty" ) {
182     undef $restoreduedatespec;
183 }
184 my $issueconfirmed = $query->param('issueconfirmed');
185 my $cancelreserve  = $query->param('cancelreserve');
186 my $print          = $query->param('print') || q{};
187 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
188 my $charges        = $query->param('charges') || q{};
189
190 # Check if stickyduedate is turned off
191 if ( @$barcodes ) {
192     # was stickyduedate loaded from session?
193     if ( $stickyduedate && ! $query->param("stickyduedate") ) {
194         $session->clear( 'stickyduedate' );
195         $stickyduedate  = $query->param('stickyduedate');
196         $duedatespec    = $query->param('duedatespec');
197     }
198     $session->param('auto_renew', scalar $query->param('auto_renew'));
199 }
200 else {
201     $session->clear('auto_renew');
202 }
203
204 my ($datedue,$invalidduedate);
205
206 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
207 if( $onsite_checkout && !$duedatespec_allow ) {
208     $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
209     $datedue .= ' 23:59:00';
210 } elsif( $duedatespec_allow ) {
211     if ( $duedatespec ) {
212         $datedue = eval { dt_from_string( $duedatespec ) };
213         if (! $datedue ) {
214             $invalidduedate = 1;
215             $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
216         }
217     }
218 }
219
220 # check and see if we should print
221 if ( @$barcodes == 0 && $print eq 'maybe' ) {
222     $print = 'yes';
223 }
224
225 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
226 if ( @$barcodes == 0 && $charges eq 'yes' ) {
227     $template->param(
228         PAYCHARGES     => 'yes',
229         borrowernumber => $borrowernumber
230     );
231 }
232
233 if ( $print eq 'yes' && $borrowernumber ne '' ) {
234     if ( C4::Context->boolean_preference('printcirculationslips') ) {
235         my $letter = IssueSlip($branch, $borrowernumber, "QUICK");
236         NetworkPrint($letter->{content});
237     }
238     $query->param( 'borrowernumber', '' );
239     $borrowernumber = '';
240     undef $patron;
241 }
242
243 #
244 # STEP 2 : FIND BORROWER
245 # if there is a list of find borrowers....
246 #
247 my $message;
248 if ($findborrower) {
249         # FIXME dpavlin - FER
250         $findborrower =~ s/^.*%B601983\d\d(\d{10})\d&.*$/S$1/ && warn "JMBAG: $1";
251     my $patron = Koha::Patrons->find( { cardnumber => $findborrower } );
252     if ( $patron ) {
253         $borrowernumber = $patron->borrowernumber;
254     } else {
255         my $dt_params = { iDisplayLength => -1 };
256         my $results = C4::Utils::DataTables::Members::search(
257             {
258                 searchmember => $findborrower,
259                 searchtype   => $searchtype,
260                 dt_params    => $dt_params,
261             }
262         );
263         my $borrowers = $results->{patrons};
264         if ( scalar @$borrowers == 1 ) {
265             $borrowernumber = $borrowers->[0]->{borrowernumber};
266             $query->param( 'borrowernumber', $borrowernumber );
267             $query->param( 'barcode',           '' );
268         } elsif ( @$borrowers ) {
269             $template->param( borrowers => $borrowers );
270         } else {
271             $query->param( 'findborrower', '' );
272             $message = "'$findborrower'";
273         }
274     }
275 }
276
277 # get the borrower information.....
278 my $balance = 0;
279 $patron ||= Koha::Patrons->find( $borrowernumber ) if $borrowernumber;
280 if ($patron) {
281
282     $template->param( borrowernumber => $patron->borrowernumber );
283     output_and_exit_if_error( $query, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
284
285     my $overdues = $patron->get_overdues;
286     my $issues = $patron->checkouts;
287     $balance = $patron->account->balance;
288
289
290     # if the expiry date is before today ie they have expired
291     if ( $patron->is_expired ) {
292         #borrowercard expired, no issues
293         $template->param(
294             noissues => ($force_allow_issue) ? 0 : "1",
295             forceallow => $force_allow_issue,
296             expired => "1",
297         );
298     }
299     # check for NotifyBorrowerDeparture
300     elsif ( $patron->is_going_to_expire ) {
301         # borrower card soon to expire warn librarian
302         $template->param( "warndeparture" => $patron->dateexpiry ,
303                         );
304         if (C4::Context->preference('ReturnBeforeExpiry')){
305             $template->param("returnbeforeexpiry" => 1);
306         }
307     }
308     $template->param(
309         overduecount => $overdues->count,
310         issuecount   => $issues->count,
311         finetotal    => $balance,
312     );
313
314     if ( $patron and $patron->is_debarred ) {
315         $template->param(
316             'userdebarred'    => $patron->debarred,
317             'debarredcomment' => $patron->debarredcomment,
318         );
319
320         if ( $patron->debarred ne "9999-12-31" ) {
321             $template->param( 'userdebarreddate' => $patron->debarred );
322         }
323     }
324
325 }
326
327 #
328 # STEP 3 : ISSUING
329 #
330 #
331 if (@$barcodes) {
332   my $checkout_infos;
333   for my $barcode ( @$barcodes ) {
334
335     my $template_params = {
336         barcode         => $barcode,
337         onsite_checkout => $onsite_checkout,
338     };
339
340     # always check for blockers on issuing
341     my ( $error, $question, $alerts, $messages ) = CanBookBeIssued(
342         $patron,
343         $barcode, $datedue,
344         $inprocess,
345         undef,
346         {
347             onsite_checkout     => $onsite_checkout,
348             override_high_holds => $override_high_holds || $override_high_holds_tmp || 0,
349         }
350     );
351
352     my $blocker = $invalidduedate ? 1 : 0;
353
354     $template_params->{alert} = $alerts;
355     $template_params->{messages} = $messages;
356
357     my $item = Koha::Items->find({ barcode => $barcode });
358
359     my $biblio;
360     if ( $item ) {
361         $biblio = $item->biblio;
362     }
363
364     # Fix for bug 7494: optional checkout-time fallback search for a book
365
366     if ( $error->{'UNKNOWN_BARCODE'}
367         && C4::Context->preference("itemBarcodeFallbackSearch")
368         && not $batch
369     )
370     {
371      $template_params->{FALLBACK} = 1;
372
373         my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
374         my $query = "kw=" . $barcode;
375         my ( $searcherror, $results, $total_hits ) = $searcher->simple_search_compat($query, 0, 10);
376
377         # if multiple hits, offer options to librarian
378         if ( $total_hits > 0 ) {
379             my @options = ();
380             foreach my $hit ( @{$results} ) {
381                 my $chosen =
382                   TransformMarcToKoha( C4::Search::new_record_from_zebra('biblioserver',$hit) );
383
384                 # offer all barcodes individually
385                 if ( $chosen->{barcode} ) {
386                     foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
387                         my %chosen_single = %{$chosen};
388                         $chosen_single{barcode} = $barcode;
389                         push( @options, \%chosen_single );
390                     }
391                 }
392             }
393             $template_params->{options} = \@options;
394         }
395     }
396
397     if ( $error->{UNKNOWN_BARCODE} or not $onsite_checkout or not C4::Context->preference("OnSiteCheckoutsForce") ) {
398         delete $question->{'DEBT'} if ($debt_confirmed);
399         foreach my $impossible ( keys %$error ) {
400             $template_params->{$impossible} = $$error{$impossible};
401             $template_params->{IMPOSSIBLE} = 1;
402             $blocker = 1;
403         }
404     }
405
406     if( $item and ( !$blocker or $force_allow_issue ) ){
407         my $confirm_required = 0;
408         unless($issueconfirmed){
409             #  Get the item title for more information
410             my $materials = $item->materials;
411             my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({ frameworkcode => $biblio->frameworkcode, kohafield => 'items.materials', authorised_value => $materials });
412             $materials = $descriptions->{lib} // $materials;
413             $template_params->{additional_materials} = $materials;
414             $template_params->{itemhomebranch} = $item->homebranch;
415
416             # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
417             foreach my $needsconfirmation ( keys %$question ) {
418                 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
419                 $template_params->{getTitleMessageIteminfo} = $biblio->title;
420                 $template_params->{getBarcodeMessageIteminfo} = $item->barcode;
421                 $template_params->{NEEDSCONFIRMATION} = 1;
422                 $template_params->{auto_renew} = $session->param('auto_renew');
423                 $confirm_required = 1;
424             }
425         }
426         unless($confirm_required) {
427             my $switch_onsite_checkout = exists $messages->{ONSITE_CHECKOUT_WILL_BE_SWITCHED};
428             my $issue = AddIssue( $patron->unblessed, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew'), switch_onsite_checkout => $switch_onsite_checkout, } );
429             $template_params->{issue} = $issue;
430             $session->clear('auto_renew');
431             $inprocess = 1;
432         }
433     }
434
435     if ($question->{RESERVE_WAITING} or $question->{RESERVED}){
436         $template->param(
437             reserveborrowernumber => $question->{'resborrowernumber'}
438         );
439     }
440
441
442     # FIXME If the issue is confirmed, we launch another time checkouts->count, now display the issue count after issue
443     $patron = Koha::Patrons->find( $borrowernumber );
444     $template_params->{issuecount} = $patron->checkouts->count;
445
446     if ( $item ) {
447         $template_params->{item} = $item;
448         $template_params->{biblio} = $biblio;
449         $template_params->{itembiblionumber} = $biblio->biblionumber;
450     }
451     push @$checkout_infos, $template_params;
452   }
453   unless ( $batch ) {
454     $template->param( %{$checkout_infos->[0]} );
455     $template->param( barcode => $barcodes->[0] );
456   } else {
457     my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
458     $template->param(
459         checkout_infos => $checkout_infos,
460         confirmation_needed => $confirmation_needed,
461     );
462   }
463 }
464
465 ##################################################################################
466 # BUILD HTML
467 # show all reserves of this borrower, and the position of the reservation ....
468 if ($patron) {
469     my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
470     my $waiting_holds = $holds->waiting;
471     $template->param(
472         holds_count  => $holds->count(),
473         WaitingHolds => $waiting_holds,
474     );
475 }
476
477 if ( $patron ) {
478     my $noissues;
479     if ( $patron->gonenoaddress ) {
480         $template->param( gna => 1 );
481         $noissues = 1;
482     }
483     if ( $patron->lost ) {
484         $template->param( lost=> 1 );
485         $noissues = 1;
486     }
487     if ( $patron->is_debarred ) {
488         $template->param( dbarred=> 1 );
489         $noissues = 1;
490     }
491     my $account = $patron->account;
492     if( ( my $owing = $account->non_issues_charges ) > 0 ) {
493         my $noissuescharge = C4::Context->preference("noissuescharge") || 5; # FIXME If noissuescharge == 0 then 5, why??
494         $noissues ||= ( not C4::Context->preference("AllowFineOverride") and ( $owing > $noissuescharge ) );
495         $template->param(
496             charges => 1,
497             chargesamount => $owing,
498         )
499     } elsif ( $balance < 0 ) {
500         $template->param(
501             credits => 1,
502             creditsamount => -$balance,
503         );
504     }
505
506     my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
507     $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
508     if ( defined $no_issues_charge_guarantees ) {
509         my $guarantees_non_issues_charges = 0;
510         my $guarantees = $patron->guarantees;
511         while ( my $g = $guarantees->next ) {
512             $guarantees_non_issues_charges += $g->account->non_issues_charges;
513         }
514         if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees ) {
515             $template->param(
516                 charges_guarantees    => 1,
517                 chargesamount_guarantees => $guarantees_non_issues_charges,
518             );
519             $noissues = 1 unless C4::Context->preference("allowfineoverride");
520         }
521     }
522
523     if ( $patron->has_overdues ) {
524         $template->param( odues => 1 );
525     }
526
527     if ( $patron->borrowernotes ) {
528         my $borrowernotes = $patron->borrowernotes;
529         $borrowernotes =~ s#\n#<br />#g;
530         $template->param(
531             notes =>1,
532             notesmsg => $borrowernotes,
533         )
534     }
535
536     if ( $noissues ) {
537         $template->param(
538             noissues => ($force_allow_issue) ? 0 : 'true',
539             forceallow => $force_allow_issue,
540         );
541     }
542 }
543
544 my $messages = Koha::Patron::Messages->search(
545     {
546         'me.borrowernumber' => $borrowernumber,
547     },
548     {
549        join => 'manager',
550        '+select' => ['manager.surname', 'manager.firstname' ],
551        '+as' => ['manager_surname', 'manager_firstname'],
552     }
553 );
554
555 my $fast_cataloging = 0;
556 if ( Koha::BiblioFrameworks->find('FA') ) {
557     $fast_cataloging = 1 
558 }
559
560 my $view = $batch
561     ?'batch_checkout_view'
562     : 'circview';
563
564 my @relatives;
565 if ( $borrowernumber ) {
566     if ( $patron ) {
567         if ( my $guarantor = $patron->guarantor ) {
568             push @relatives, $guarantor->borrowernumber;
569             push @relatives, $_->borrowernumber for $patron->siblings;
570         } else {
571             push @relatives, $_->borrowernumber for $patron->guarantees;
572         }
573     }
574 }
575 my $relatives_issues_count =
576   Koha::Database->new()->schema()->resultset('Issue')
577   ->count( { borrowernumber => \@relatives } );
578
579 if ( $patron ) {
580     my $av = Koha::AuthorisedValues->search({ category => 'ROADTYPE', authorised_value => $patron->streettype });
581     my $roadtype = $av->count ? $av->next->lib : '';
582     $template->param(
583         roadtype          => $roadtype,
584         patron            => $patron,
585         categoryname      => $patron->category->description,
586         expiry            => $patron->dateexpiry,
587     );
588 }
589
590 # Restore date if changed by holds and/or save stickyduedate to session
591 if ($restoreduedatespec || $stickyduedate) {
592     $duedatespec = $restoreduedatespec || $duedatespec;
593
594     if ($stickyduedate) {
595         $session->param( 'stickyduedate', $duedatespec );
596     }
597 } elsif (defined($duedatespec) && !defined($restoreduedatespec)) {
598     undef $duedatespec;
599 }
600
601 $template->param(
602     messages           => $messages,
603     borrowernumber    => $borrowernumber,
604     branch            => $branch,
605     was_renewed       => scalar $query->param('was_renewed') ? 1 : 0,
606     barcodes          => $barcodes,
607     stickyduedate     => $stickyduedate,
608     duedatespec       => $duedatespec,
609     restoreduedatespec => $restoreduedatespec,
610     message           => $message,
611     totaldue          => sprintf('%.2f', $balance), # FIXME not used in template?
612     inprocess         => $inprocess,
613     $view             => 1,
614     batch_allowed     => $batch_allowed,
615     batch             => $batch,
616     AudioAlerts           => C4::Context->preference("AudioAlerts"),
617     fast_cataloging   => $fast_cataloging,
618     CircAutoPrintQuickSlip   => C4::Context->preference("CircAutoPrintQuickSlip"),
619     RoutingSerials => C4::Context->preference('RoutingSerials'),
620     relatives_issues_count => $relatives_issues_count,
621     relatives_borrowernumbers => \@relatives,
622 );
623
624
625 if ( C4::Context->preference("ExportCircHistory") ) {
626     $template->param(csv_profiles => [ Koha::CsvProfiles->search({ type => 'marc' }) ]);
627 }
628
629 my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count;
630 $template->param(
631     debt_confirmed            => $debt_confirmed,
632     SpecifyDueDate            => $duedatespec_allow,
633     CircAutocompl             => C4::Context->preference("CircAutocompl"),
634     debarments                => scalar GetDebarments({ borrowernumber => $borrowernumber }),
635     todaysdate                => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
636     has_modifications         => $has_modifications,
637     override_high_holds       => $override_high_holds,
638     nopermission              => scalar $query->param('nopermission'),
639     autoswitched              => $autoswitched,
640 );
641
642 output_html_with_http_headers $query, $cookie, $template->output;