Bug 8296: Add descriptive (text) published date field for serials
[koha.git] / circ / circulation.pl
blobc8e787257e6954a8df9042f0a7b074ec0b89e1ca
1 #!/usr/bin/perl
3 # script to execute issuing of books
5 # Copyright 2000-2002 Katipo Communications
6 # copyright 2010 BibLibre
7 # Copyright 2011 PTFS-Europe Ltd.
8 # Copyright 2012 software.coop and MJ Ray
10 # This file is part of Koha.
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.
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.
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>.
25 use strict;
26 use warnings;
27 use CGI qw ( -utf8 );
28 use DateTime;
29 use DateTime::Duration;
30 use C4::Output;
31 use C4::Print;
32 use C4::Auth qw/:DEFAULT get_session haspermission/;
33 use C4::Branch; # GetBranches
34 use C4::Koha; # GetPrinter
35 use C4::Circulation;
36 use C4::Utils::DataTables::Members;
37 use C4::Members;
38 use C4::Biblio;
39 use C4::Search;
40 use MARC::Record;
41 use C4::Reserves;
42 use Koha::Holds;
43 use C4::Context;
44 use CGI::Session;
45 use C4::Members::Attributes qw(GetBorrowerAttributes);
46 use Koha::Borrower::Debarments qw(GetDebarments IsDebarred);
47 use Koha::DateUtils;
48 use Koha::Database;
50 use Date::Calc qw(
51 Today
52 Add_Delta_YM
53 Add_Delta_Days
54 Date_to_Days
56 use List::MoreUtils qw/uniq/;
60 # PARAMETERS READING
62 my $query = new CGI;
64 my $sessionID = $query->cookie("CGISESSID") ;
65 my $session = get_session($sessionID);
67 # branch and printer are now defined by the userenv
68 # but first we have to check if someone has tried to change them
70 my $branch = $query->param('branch');
71 if ($branch){
72 # update our session so the userenv is updated
73 $session->param('branch', $branch);
74 $session->param('branchname', GetBranchName($branch));
77 my $printer = $query->param('printer');
78 if ($printer){
79 # update our session so the userenv is updated
80 $session->param('branchprinter', $printer);
83 if (!C4::Context->userenv && !$branch){
84 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
85 # no branch set we can't issue
86 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
87 exit;
91 my $barcodes = [];
92 if ( my $barcode = $query->param('barcode') ) {
93 $barcodes = [ $barcode ];
94 } else {
95 my $filefh = $query->upload('uploadfile');
96 if ( $filefh ) {
97 while ( my $content = <$filefh> ) {
98 $content =~ s/[\r\n]*$//g;
99 push @$barcodes, $content if $content;
101 } elsif ( my $list = $query->param('barcodelist') ) {
102 push @$barcodes, split( /\s\n/, $list );
103 $barcodes = [ map { $_ =~ /^\s*$/ ? () : $_ } @$barcodes ];
104 } else {
105 @$barcodes = $query->param('barcodes');
109 $barcodes = [ uniq @$barcodes ];
111 my $template_name = q|circ/circulation.tt|;
112 my $borrowernumber = $query->param('borrowernumber');
113 my $borrower = $borrowernumber ? GetMember( borrowernumber => $borrowernumber ) : undef;
114 my $batch = $query->param('batch');
115 my $batch_allowed = 0;
116 if ( $batch && C4::Context->preference('BatchCheckouts') ) {
117 $template_name = q|circ/circulation_batch_checkouts.tt|;
118 my @batch_category_codes = split '\|', C4::Context->preference('BatchCheckoutsValidCategories');
119 if ( grep {/^$borrower->{categorycode}$/} @batch_category_codes ) {
120 $batch_allowed = 1;
121 } else {
122 $barcodes = [];
126 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
128 template_name => $template_name,
129 query => $query,
130 type => "intranet",
131 authnotrequired => 0,
132 flagsrequired => { circulate => 'circulate_remaining_permissions' },
136 my $branches = GetBranches();
138 my $force_allow_issue = $query->param('forceallow') || 0;
139 if (!C4::Auth::haspermission( C4::Context->userenv->{id} , { circulate => 'force_checkout' } )) {
140 $force_allow_issue = 0;
143 my $onsite_checkout = $query->param('onsite_checkout');
145 my @failedrenews = $query->param('failedrenew'); # expected to be itemnumbers
146 our %renew_failed = ();
147 for (@failedrenews) { $renew_failed{$_} = 1; }
149 my @failedreturns = $query->param('failedreturn');
150 our %return_failed = ();
151 for (@failedreturns) { $return_failed{$_} = 1; }
153 my $findborrower = $query->param('findborrower') || q{};
154 $findborrower =~ s|,| |g;
156 $branch = C4::Context->userenv->{'branch'};
157 $printer = C4::Context->userenv->{'branchprinter'};
160 # If AutoLocation is not activated, we show the Circulation Parameters to chage settings of librarian
161 if (C4::Context->preference("AutoLocation") != 1) {
162 $template->param(ManualLocation => 1);
165 if (C4::Context->preference("DisplayClearScreenButton")) {
166 $template->param(DisplayClearScreenButton => 1);
169 for my $barcode ( @$barcodes ) {
170 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
171 $barcode = barcodedecode($barcode)
172 if( $barcode && C4::Context->preference('itemBarcodeInputFilter'));
175 my $stickyduedate = $query->param('stickyduedate') || $session->param('stickyduedate');
176 my $duedatespec = $query->param('duedatespec') || $session->param('stickyduedate');
177 $duedatespec = eval { output_pref( { dt => dt_from_string( $duedatespec ), dateformat => 'iso' }); }
178 if ( $duedatespec );
180 my $issueconfirmed = $query->param('issueconfirmed');
181 my $cancelreserve = $query->param('cancelreserve');
182 my $print = $query->param('print') || q{};
183 my $debt_confirmed = $query->param('debt_confirmed') || 0; # Don't show the debt error dialog twice
184 my $charges = $query->param('charges') || q{};
186 # Check if stickyduedate is turned off
187 if ( @$barcodes ) {
188 # was stickyduedate loaded from session?
189 if ( $stickyduedate && ! $query->param("stickyduedate") ) {
190 $session->clear( 'stickyduedate' );
191 $stickyduedate = $query->param('stickyduedate');
192 $duedatespec = $query->param('duedatespec');
194 $session->param('auto_renew', $query->param('auto_renew'));
196 else {
197 $session->clear('auto_renew');
200 my ($datedue,$invalidduedate);
202 my $duedatespec_allow = C4::Context->preference('SpecifyDueDate');
203 if( $onsite_checkout && !$duedatespec_allow ) {
204 $datedue = output_pref({ dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
205 $datedue .= ' 23:59:00';
206 } elsif( $duedatespec_allow ) {
207 if ( $duedatespec ) {
208 $datedue = eval { dt_from_string( $duedatespec ) };
209 if (! $datedue ) {
210 $invalidduedate = 1;
211 $template->param( IMPOSSIBLE=>1, INVALID_DATE=>$duedatespec );
216 # check and see if we should print
217 if ( @$barcodes == 0 && $print eq 'maybe' ) {
218 $print = 'yes';
221 my $inprocess = (@$barcodes == 0) ? '' : $query->param('inprocess');
222 if ( @$barcodes == 0 && $charges eq 'yes' ) {
223 $template->param(
224 PAYCHARGES => 'yes',
225 borrowernumber => $borrowernumber
229 if ( $print eq 'yes' && $borrowernumber ne '' ) {
230 if ( C4::Context->boolean_preference('printcirculationslips') ) {
231 my $letter = IssueSlip($branch, $borrowernumber, "QUICK");
232 NetworkPrint($letter->{content});
234 $query->param( 'borrowernumber', '' );
235 $borrowernumber = '';
239 # STEP 2 : FIND BORROWER
240 # if there is a list of find borrowers....
242 my $message;
243 if ($findborrower) {
244 my $borrower = C4::Members::GetMember( cardnumber => $findborrower );
245 if ( $borrower ) {
246 $borrowernumber = $borrower->{borrowernumber};
247 } else {
248 my $dt_params = { iDisplayLength => -1 };
249 my $results = C4::Utils::DataTables::Members::search(
251 searchmember => $findborrower,
252 searchtype => 'contain',
253 dt_params => $dt_params,
256 my $borrowers = $results->{patrons};
257 if ( scalar @$borrowers == 1 ) {
258 $borrowernumber = $borrowers->[0]->{borrowernumber};
259 $query->param( 'borrowernumber', $borrowernumber );
260 $query->param( 'barcode', '' );
261 } elsif ( @$borrowers ) {
262 $template->param( borrowers => $borrowers );
263 } else {
264 $query->param( 'findborrower', '' );
265 $message = "'$findborrower'";
270 # get the borrower information.....
271 if ($borrowernumber) {
272 $borrower = GetMemberDetails( $borrowernumber, 0 );
273 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrowernumber );
275 # Warningdate is the date that the warning starts appearing
276 my ( $today_year, $today_month, $today_day) = Today();
277 my ($warning_year, $warning_month, $warning_day) = split /-/, $borrower->{'dateexpiry'};
278 my ( $enrol_year, $enrol_month, $enrol_day) = split /-/, $borrower->{'dateenrolled'};
279 # Renew day is calculated by adding the enrolment period to today
280 my ( $renew_year, $renew_month, $renew_day);
281 if ($enrol_year*$enrol_month*$enrol_day>0) {
282 ( $renew_year, $renew_month, $renew_day) =
283 Add_Delta_YM( $enrol_year, $enrol_month, $enrol_day,
284 0 , $borrower->{'enrolmentperiod'});
286 # if the expiry date is before today ie they have expired
287 if ( !$borrower->{'dateexpiry'} || $warning_year*$warning_month*$warning_day==0
288 || Date_to_Days($today_year, $today_month, $today_day )
289 > Date_to_Days($warning_year, $warning_month, $warning_day) )
291 #borrowercard expired, no issues
292 $template->param(
293 flagged => "1",
294 noissues => ($force_allow_issue) ? 0 : "1",
295 forceallow => $force_allow_issue,
296 expired => "1",
297 renewaldate => "$renew_year-$renew_month-$renew_day",
300 # check for NotifyBorrowerDeparture
301 elsif ( C4::Context->preference('NotifyBorrowerDeparture') &&
302 Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
303 Date_to_Days( $today_year, $today_month, $today_day ) )
305 # borrower card soon to expire warn librarian
306 $template->param( "warndeparture" => $borrower->{dateexpiry} ,
307 flagged => "1"
309 if (C4::Context->preference('ReturnBeforeExpiry')){
310 $template->param("returnbeforeexpiry" => 1);
313 $template->param(
314 overduecount => $od,
315 issuecount => $issue,
316 finetotal => $fines
319 if ( IsDebarred($borrowernumber) ) {
320 $template->param(
321 'userdebarred' => $borrower->{debarred},
322 'debarredcomment' => $borrower->{debarredcomment},
325 if ( $borrower->{debarred} ne "9999-12-31" ) {
326 $template->param( 'userdebarreddate' => $borrower->{debarred} );
333 # STEP 3 : ISSUING
336 if (@$barcodes) {
337 my $checkout_infos;
338 for my $barcode ( @$barcodes ) {
339 my $template_params = { barcode => $barcode };
340 # always check for blockers on issuing
341 my ( $error, $question, $alerts ) =
342 CanBookBeIssued( $borrower, $barcode, $datedue , $inprocess, undef, { onsite_checkout => $onsite_checkout } );
343 my $blocker = $invalidduedate ? 1 : 0;
345 $template_params->{alert} = $alerts;
347 # Get the item title for more information
348 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
349 $template_params->{authvalcode_notforloan} =
350 C4::Koha::GetAuthValCode('items.notforloan', $getmessageiteminfo->{'frameworkcode'});
352 # Fix for bug 7494: optional checkout-time fallback search for a book
354 if ( $error->{'UNKNOWN_BARCODE'}
355 && C4::Context->preference("itemBarcodeFallbackSearch")
356 && not $batch
359 $template_params->{FALLBACK} = 1;
361 my $query = "kw=" . $barcode;
362 my ( $searcherror, $results, $total_hits ) = SimpleSearch($query);
364 # if multiple hits, offer options to librarian
365 if ( $total_hits > 0 ) {
366 my @options = ();
367 foreach my $hit ( @{$results} ) {
368 my $chosen =
369 TransformMarcToKoha( C4::Context->dbh,
370 C4::Search::new_record_from_zebra('biblioserver',$hit) );
372 # offer all barcodes individually
373 if ( $chosen->{barcode} ) {
374 foreach my $barcode ( sort split(/\s*\|\s*/, $chosen->{barcode}) ) {
375 my %chosen_single = %{$chosen};
376 $chosen_single{barcode} = $barcode;
377 push( @options, \%chosen_single );
381 $template_params->{options} = \@options;
385 unless( $onsite_checkout and C4::Context->preference("OnSiteCheckoutsForce") ) {
386 delete $question->{'DEBT'} if ($debt_confirmed);
387 foreach my $impossible ( keys %$error ) {
388 $template_params->{$impossible} = $$error{$impossible};
389 $template_params->{IMPOSSIBLE} = 1;
390 $blocker = 1;
393 my $iteminfo = GetBiblioFromItemNumber(undef, $barcode);
394 if( !$blocker || $force_allow_issue ){
395 my $confirm_required = 0;
396 unless($issueconfirmed){
397 # Get the item title for more information
398 $template_params->{additional_materials} = $iteminfo->{'materials'};
399 $template_params->{itemhomebranch} = $iteminfo->{'homebranch'};
401 # pass needsconfirmation to template if issuing is possible and user hasn't yet confirmed.
402 foreach my $needsconfirmation ( keys %$question ) {
403 $template_params->{$needsconfirmation} = $$question{$needsconfirmation};
404 $template_params->{getTitleMessageIteminfo} = $iteminfo->{'title'};
405 $template_params->{getBarcodeMessageIteminfo} = $iteminfo->{'barcode'};
406 $template_params->{NEEDSCONFIRMATION} = 1;
407 $template_params->{onsite_checkout} = $onsite_checkout;
408 $confirm_required = 1;
411 unless($confirm_required) {
412 my $issue = AddIssue( $borrower, $barcode, $datedue, $cancelreserve, undef, undef, { onsite_checkout => $onsite_checkout, auto_renew => $session->param('auto_renew') } );
413 $template->param( issue => $issue );
414 $session->clear('auto_renew');
415 $inprocess = 1;
419 # FIXME If the issue is confirmed, we launch another time GetMemberIssuesAndFines, now display the issue count after issue
420 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines($borrowernumber);
422 if ($question->{RESERVE_WAITING} or $question->{RESERVED}){
423 $template->param(
424 reserveborrowernumber => $question->{'resborrowernumber'},
425 itembiblionumber => $getmessageiteminfo->{'biblionumber'}
429 $template_params->{issuecount} = $issue;
431 if ( $iteminfo ) {
432 $iteminfo->{subtitle} = GetRecordValue('subtitle', GetMarcBiblio($iteminfo->{biblionumber}), GetFrameworkCode($iteminfo->{biblionumber}));
433 $template_params->{item} = $iteminfo;
435 push @$checkout_infos, $template_params;
437 unless ( $batch ) {
438 $template->param( %{$checkout_infos->[0]} );
439 $template->param( barcode => $barcodes->[0] );
440 } else {
441 my $confirmation_needed = grep { $_->{NEEDSCONFIRMATION} } @$checkout_infos;
442 $template->param(
443 checkout_infos => $checkout_infos,
444 confirmation_needed => $confirmation_needed,
449 # reload the borrower info for the sake of reseting the flags.....
450 if ($borrowernumber) {
451 $borrower = GetMemberDetails( $borrowernumber, 0 );
454 ##################################################################################
455 # BUILD HTML
456 # show all reserves of this borrower, and the position of the reservation ....
457 if ($borrowernumber) {
458 my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } );
459 $template->param(
460 holds_count => $holds->count(),
461 WaitingHolds => scalar $holds->waiting(),
464 $template->param( adultborrower => 1 ) if ( $borrower->{category_type} eq 'A' || $borrower->{category_type} eq 'I' );
467 #title
468 my $flags = $borrower->{'flags'};
469 foreach my $flag ( sort keys %$flags ) {
470 $template->param( flagged=> 1);
471 $flags->{$flag}->{'message'} =~ s#\n#<br />#g;
472 if ( $flags->{$flag}->{'noissues'} ) {
473 $template->param(
474 noissues => ($force_allow_issue) ? 0 : 'true',
475 forceallow => $force_allow_issue,
477 if ( $flag eq 'GNA' ) {
478 $template->param( gna => 'true' );
480 elsif ( $flag eq 'LOST' ) {
481 $template->param( lost => 'true' );
483 elsif ( $flag eq 'DBARRED' ) {
484 $template->param( dbarred => 'true' );
486 elsif ( $flag eq 'CHARGES' ) {
487 $template->param(
488 charges => 'true',
489 chargesmsg => $flags->{'CHARGES'}->{'message'},
490 chargesamount => $flags->{'CHARGES'}->{'amount'},
491 charges_is_blocker => 1
494 elsif ( $flag eq 'CREDITS' ) {
495 $template->param(
496 credits => 'true',
497 creditsmsg => $flags->{'CREDITS'}->{'message'},
498 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
502 else {
503 if ( $flag eq 'CHARGES' ) {
504 $template->param(
505 charges => 'true',
506 chargesmsg => $flags->{'CHARGES'}->{'message'},
507 chargesamount => $flags->{'CHARGES'}->{'amount'},
510 elsif ( $flag eq 'CREDITS' ) {
511 $template->param(
512 credits => 'true',
513 creditsmsg => $flags->{'CREDITS'}->{'message'},
514 creditsamount => sprintf("%.02f", -($flags->{'CREDITS'}->{'amount'})), # from patron's pov
517 elsif ( $flag eq 'ODUES' ) {
518 $template->param(
519 odues => 'true',
520 oduesmsg => $flags->{'ODUES'}->{'message'}
523 my $items = $flags->{$flag}->{'itemlist'};
524 if ( ! $query->param('module') || $query->param('module') ne 'returns' ) {
525 $template->param( nonreturns => 'true' );
528 elsif ( $flag eq 'NOTES' ) {
529 $template->param(
530 notes => 'true',
531 notesmsg => $flags->{'NOTES'}->{'message'}
537 my $amountold = $borrower->{flags}->{'CHARGES'}->{'message'} || 0;
538 $amountold =~ s/^.*\$//; # remove upto the $, if any
540 my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
542 if ( $borrowernumber && $borrower->{'category_type'} eq 'C') {
543 my ( $catcodes, $labels ) = GetborCatFromCatType( 'A', 'WHERE category_type = ?' );
544 my $cnt = scalar(@$catcodes);
545 $template->param( 'CATCODE_MULTI' => 1) if $cnt > 1;
546 $template->param( 'catcode' => $catcodes->[0]) if $cnt == 1;
549 my $lib_messages_loop = GetMessages( $borrowernumber, 'L', $branch );
550 if($lib_messages_loop){ $template->param(flagged => 1 ); }
552 my $bor_messages_loop = GetMessages( $borrowernumber, 'B', $branch );
553 if($bor_messages_loop){ $template->param(flagged => 1 ); }
555 my $fast_cataloging = 0;
556 if (defined getframeworkinfo('FA')) {
557 $fast_cataloging = 1
560 if (C4::Context->preference('ExtendedPatronAttributes')) {
561 my $attributes = GetBorrowerAttributes($borrowernumber);
562 $template->param(
563 ExtendedPatronAttributes => 1,
564 extendedattributes => $attributes
567 my $view = $batch
568 ?'batch_checkout_view'
569 : 'circview';
571 my @relatives = GetMemberRelatives( $borrower->{'borrowernumber'} );
572 my $relatives_issues_count =
573 Koha::Database->new()->schema()->resultset('Issue')
574 ->count( { borrowernumber => \@relatives } );
576 my $roadtype = C4::Koha::GetAuthorisedValueByCode( 'ROADTYPE', $borrower->{streettype} );
578 $template->param(%$borrower);
580 $template->param(
581 lib_messages_loop => $lib_messages_loop,
582 bor_messages_loop => $bor_messages_loop,
583 all_messages_del => C4::Context->preference('AllowAllMessageDeletion'),
584 findborrower => $findborrower,
585 borrower => $borrower,
586 borrowernumber => $borrowernumber,
587 branch => $branch,
588 branchname => GetBranchName($borrower->{'branchcode'}),
589 printer => $printer,
590 printername => $printer,
591 was_renewed => $query->param('was_renewed') ? 1 : 0,
592 expiry => $borrower->{'dateexpiry'},
593 roadtype => $roadtype,
594 amountold => $amountold,
595 barcodes => $barcodes,
596 stickyduedate => $stickyduedate,
597 duedatespec => $duedatespec,
598 message => $message,
599 totaldue => sprintf('%.2f', $total),
600 inprocess => $inprocess,
601 is_child => ($borrowernumber && $borrower->{'category_type'} eq 'C'),
602 $view => 1,
603 batch_allowed => $batch_allowed,
604 AudioAlerts => C4::Context->preference("AudioAlerts"),
605 fast_cataloging => $fast_cataloging,
606 CircAutoPrintQuickSlip => C4::Context->preference("CircAutoPrintQuickSlip"),
607 activeBorrowerRelationship => (C4::Context->preference('borrowerRelationship') ne ''),
608 SuspendHoldsIntranet => C4::Context->preference('SuspendHoldsIntranet'),
609 AutoResumeSuspendedHolds => C4::Context->preference('AutoResumeSuspendedHolds'),
610 RoutingSerials => C4::Context->preference('RoutingSerials'),
611 relatives_issues_count => $relatives_issues_count,
612 relatives_borrowernumbers => \@relatives,
615 # save stickyduedate to session
616 if ($stickyduedate) {
617 $session->param( 'stickyduedate', $duedatespec );
620 my ($picture, $dberror) = GetPatronImage($borrower->{'borrowernumber'});
621 $template->param( picture => 1 ) if $picture;
623 # get authorised values with type of BOR_NOTES
625 my $canned_notes = GetAuthorisedValues("BOR_NOTES");
627 $template->param(
628 debt_confirmed => $debt_confirmed,
629 SpecifyDueDate => $duedatespec_allow,
630 CircAutocompl => C4::Context->preference("CircAutocompl"),
631 AllowRenewalLimitOverride => C4::Context->preference("AllowRenewalLimitOverride"),
632 canned_bor_notes_loop => $canned_notes,
633 debarments => GetDebarments({ borrowernumber => $borrowernumber }),
634 todaysdate => output_pref( { dt => dt_from_string()->set(hour => 23)->set(minute => 59), dateformat => 'sql' } ),
637 output_html_with_http_headers $query, $cookie, $template->output;