Moving "Check Out" from the action toolbar to the view menu
[koha.git] / circ / circulation.pl
blobe307fdde76a3555ae801fe65e5cc9570448092fc
1 #!/usr/bin/perl
3 # Please use 8-character tabs for this file (indents are every 4 characters)
5 # written 8/5/2002 by Finlay
6 # script to execute issuing of books
8 # Copyright 2000-2002 Katipo Communications
10 # This file is part of Koha.
12 # Koha is free software; you can redistribute it and/or modify it under the
13 # terms of the GNU General Public License as published by the Free Software
14 # Foundation; either version 2 of the License, or (at your option) any later
15 # version.
17 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
18 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License along with
22 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
23 # Suite 330, Boston, MA 02111-1307 USA
25 use strict;
26 use CGI;
27 use C4::Output;
28 use C4::Print;
29 use C4::Auth qw/:DEFAULT get_session/;
30 use C4::Date;
31 use C4::Branch; # GetBranches
32 use C4::Koha; # GetPrinter
33 use C4::Circulation;
34 use C4::Members;
35 use C4::Biblio;
36 use C4::Reserves;
37 use C4::Context;
38 use CGI::Session;
40 use Date::Calc qw(
41 Today
42 Today_and_Now
43 Add_Delta_YM
44 Add_Delta_Days
45 Date_to_Days
50 # PARAMETERS READING
52 my $query = new CGI;
54 # new op dev the branch and the printer are now defined by the userenv
55 # but first we have to check if someone has tried to change them
57 my $branch = $query->param('branch');
58 if ($branch){
59 # update our session so the userenv is updated
60 my $dbh=C4::Context->dbh;
61 my $sessionID = $query->cookie("CGISESSID") ;
62 my $session = get_session($sessionID);
63 $session->param('branch',$branch);
64 my $branchname = GetBranchName($branch);
65 $session->param('branchname',$branchname);
68 my $printer = $query->param('printer');
69 if ($printer){
70 # update our session so the userenv is updated
71 my $dbh=C4::Context->dbh;
72 my $sessionID = $query->cookie("CGISESSID") ;
73 my $session = get_session($sessionID);
74 $session->param('branchprinter',$printer);
79 my ( $template, $loggedinuser, $cookie ) = get_template_and_user (
81 template_name => 'circ/circulation.tmpl',
82 query => $query,
83 type => "intranet",
84 authnotrequired => 0,
85 flagsrequired => { circulate => 1 },
88 my $branches = GetBranches();
90 my $printers = GetPrinters();
92 my @failedrenews = $query->param('failedrenew');
93 my @renew_failed;
94 for (@failedrenews) { $renew_failed[$_] = 1; }
96 my $findborrower = $query->param('findborrower');
97 $findborrower =~ s|,| |g;
98 #$findborrower =~ s|'| |g;
99 my $borrowernumber = $query->param('borrowernumber');
101 $branch = C4::Context->userenv->{'branch'};
102 $printer = C4::Context->userenv->{'branchprinter'};
105 # If Autolocated is not activated, we show the Circulation Parameters to chage settings of librarian
106 if (C4::Context->preference("AutoLocation") ne 1)
108 $template->param(
109 ManualLocation => 1,
113 my $barcode = $query->param('barcode') || '';
114 my $year = $query->param('year');
115 my $month = $query->param('month');
116 my $day = $query->param('day');
117 my $stickyduedate = $query->param('stickyduedate');
118 my $duedatespec = $query->param('duedatespec');
119 my $issueconfirmed = $query->param('issueconfirmed');
120 my $cancelreserve = $query->param('cancelreserve');
121 my $organisation = $query->param('organisations');
122 my $print = $query->param('print');
124 #set up cookie.....
125 # my $branchcookie;
126 # my $printercookie;
127 # if ($query->param('setcookies')) {
128 # $branchcookie = $query->cookie(-name=>'branch', -value=>"$branch", -expires=>'+1y');
129 # $printercookie = $query->cookie(-name=>'printer', -value=>"$printer", -expires=>'+1y');
133 my ($datedue,$invalidduedate);
134 if($duedatespec) {
135 $datedue= C4::Dates->new($duedatespec );
136 $invalidduedate=1 unless $datedue;
138 #if (defined($year)) {
139 # $duedatespec = "$year-$month-$day";
140 #} else {
141 # ($year, $month, $day) = ($duedatespec) ? split /-/, $duedatespec : (0,0,0);
144 my @datearr = localtime( time() );
146 # FIXME - Could just use POSIX::strftime("%Y%m%d", localtime);
147 my $todaysdate =
148 ( 1900 + $datearr[5] )
149 . sprintf( "%0.2d", ( $datearr[4] + 1 ) )
150 . sprintf( "%0.2d", ( $datearr[3] ) );
152 # check and see if we should print
153 if ( $barcode eq '' && $print eq 'maybe' ) {
154 $print = 'yes';
157 my $inprocess = ($barcode eq '') ? '' : $query->param('inprocess');
159 if ( $barcode eq '' && $query->param('charges') eq 'yes' ) {
160 $template->param(
161 PAYCHARGES => 'yes',
162 borrowernumber => $borrowernumber
166 if ( $print eq 'yes' && $borrowernumber ne '' ) {
167 printslip( $borrowernumber );
168 $query->param( 'borrowernumber', '' );
169 $borrowernumber = '';
173 # STEP 2 : FIND BORROWER
174 # if there is a list of find borrowers....
176 my $borrowerslist;
177 my $message;
178 if ($findborrower) {
179 my ( $count, $borrowers ) =
180 SearchMember($findborrower, 'cardnumber', 'web' );
181 my @borrowers = @$borrowers;
182 if ( $#borrowers == -1 ) {
183 $query->param( 'findborrower', '' );
184 $message = "'$findborrower'";
186 elsif ( $#borrowers == 0 ) {
187 $query->param( 'borrowernumber', $borrowers[0]->{'borrowernumber'} );
188 $query->param( 'barcode', '' );
189 $borrowernumber = $borrowers[0]->{'borrowernumber'};
191 else {
192 $borrowerslist = \@borrowers;
196 # get the borrower information.....
197 my $borrower;
198 my @lines;
199 warn $borrowernumber;
200 if ($borrowernumber) {
201 $borrower = GetMemberDetails( $borrowernumber, 0 );
202 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrowernumber );
204 # Warningdate is the date that the warning starts appearing
205 my ( $today_year, $today_month, $today_day ) = Today();
206 my ( $warning_year, $warning_month, $warning_day ) = split /-/,
207 $borrower->{'dateexpiry'};
208 my ( $enrol_year, $enrol_month, $enrol_day ) = split /-/,
209 $borrower->{'dateenrolled'};
210 # Renew day is calculated by adding the enrolment period to today
211 my ( $renew_year, $renew_month, $renew_day ) =
212 Add_Delta_YM( $enrol_year, $enrol_month, $enrol_day,
213 0 , $borrower->{'enrolmentperiod'}) if ($enrol_year*$enrol_month*$enrol_day>0);
214 # if the expiry date is before today
215 if ( $warning_year*$warning_month*$warning_day==0
216 || Date_to_Days( $today_year, $today_month, $today_day )
217 > Date_to_Days( $warning_year, $warning_month, $warning_day ) )
220 #borrowercard expired or nearly expired, warn the librarian
221 $template->param(
222 flagged => "1",
223 warndeparture => format_date($borrower->{dateexpiry}),
224 renewaldate => format_date("$renew_year-$renew_month-$renew_day")
227 # check for NotifyBorrowerDeparture
228 if ($warning_year*$warning_month*$warning_day==0
229 || (C4::Context->preference('NotifyBorrowerDeparture') &&
230 Date_to_Days(Add_Delta_Days($warning_year,$warning_month,$warning_day,- C4::Context->preference('NotifyBorrowerDeparture'))) <
231 Date_to_Days( $today_year, $today_month, $today_day )) )
233 $template->param("warndeparture" => format_date($borrower->{dateexpiry}));
235 $template->param(
236 overduecount => $od,
237 issuecount => $issue,
238 finetotal => $fines
243 # STEP 3 : ISSUING
247 if ($barcode) {
248 # $barcode = cuecatbarcodedecode($barcode);
250 if ($issueconfirmed) {
251 AddIssue( $borrower, $barcode, $datedue, $cancelreserve );
252 $inprocess = 1;
254 else {
255 my ( $error, $question ) =
256 CanBookBeIssued( $borrower, $barcode, $datedue , $inprocess );
257 my $noerror = 1;
258 my $noquestion = 1;
259 # Get the item title for more information
260 my $getmessageiteminfo = GetBiblioFromItemNumber(undef,$barcode);
262 foreach my $impossible ( keys %$error ) {
263 $template->param(
264 $impossible => $$error{$impossible},
265 IMPOSSIBLE => 1
267 $noerror = 0;
269 foreach my $needsconfirmation ( keys %$question ) {
270 $template->param(
271 $needsconfirmation => $$question{$needsconfirmation},
272 getTitleMessageIteminfo => $getmessageiteminfo->{'title'},
273 NEEDSCONFIRMATION => 1
275 $noquestion = 0;
277 $template->param(
278 itemhomebranch => $getmessageiteminfo->{'homebranch'} ,
279 day => $day,
280 month => $month,
281 year => $year
283 if ( $noerror && ( $noquestion || $issueconfirmed ) ) {
284 AddIssue( $borrower, $barcode, $datedue );
285 $inprocess = 1;
289 # FIXME If the issue is confirmed, we launch another time borrdata2, now display the issue count after issue
290 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrowernumber );
291 $template->param(
292 issuecount => $issue,
296 # reload the borrower info for the sake of reseting the flags.....
297 if ($borrowernumber) {
298 $borrower = GetMemberDetails( $borrowernumber, 0 );
301 ##################################################################################
302 # BUILD HTML
303 # show all reserves of this borrower, and the position of the reservation ....
304 if ($borrowernumber) {
306 # new op dev
307 # now we show the status of the borrower's reservations
308 my @borrowerreserv = GetReservesFromBorrowernumber($borrowernumber );
309 my @reservloop;
310 my @WaitingReserveLoop;
312 foreach my $num_res (@borrowerreserv) {
313 my %getreserv;
314 my %getWaitingReserveInfo;
315 my $getiteminfo = GetBiblioFromItemNumber( $num_res->{'itemnumber'} );
316 my $itemtypeinfo = getitemtypeinfo( (C4::Context->preference('item-level_itype')) ? $getiteminfo->{'itype'} : $getiteminfo->{'itemtype'} );
317 my ( $transfertwhen, $transfertfrom, $transfertto ) =
318 GetTransfers( $num_res->{'itemnumber'} );
320 $getreserv{waiting} = 0;
321 $getreserv{transfered} = 0;
322 $getreserv{nottransfered} = 0;
324 $getreserv{reservedate} = format_date( $num_res->{'reservedate'} );
325 $getreserv{title} = $getiteminfo->{'title'};
326 $getreserv{itemtype} = $itemtypeinfo->{'description'};
327 $getreserv{author} = $getiteminfo->{'author'};
328 $getreserv{barcodereserv} = $getiteminfo->{'barcode'};
329 $getreserv{itemcallnumber} = $getiteminfo->{'itemcallnumber'};
330 $getreserv{biblionumber} = $getiteminfo->{'biblionumber'};
332 # check if we have a waiting status for reservations
333 if ( $num_res->{'found'} eq 'W' ) {
334 $getreserv{color} = 'reserved';
335 $getreserv{waiting} = 1;
336 # genarate information displaying only waiting reserves
337 $getWaitingReserveInfo{title} = $getiteminfo->{'title'};
338 $getWaitingReserveInfo{biblionumber} = $getiteminfo->{'biblionumber'};
339 $getWaitingReserveInfo{itemtype} = $itemtypeinfo->{'description'};
340 $getWaitingReserveInfo{author} = $getiteminfo->{'author'};
341 $getWaitingReserveInfo{reservedate} = format_date( $num_res->{'reservedate'} );
342 if ($getiteminfo->{'holdingbranch'} ne $num_res->{'branchcode'} ) {
343 $getWaitingReserveInfo{waitingat} = GetBranchName( $num_res->{'branchcode'} );
347 # check transfers with the itemnumber foud in th reservation loop
348 if ($transfertwhen) {
349 $getreserv{color} = 'transfered';
350 $getreserv{transfered} = 1;
351 $getreserv{datesent} = format_date($transfertwhen);
352 $getreserv{frombranch} = GetBranchName($transfertfrom);
355 if ( ( $getiteminfo->{'holdingbranch'} ne $num_res->{'branchcode'} )
356 and not $transfertwhen )
358 $getreserv{nottransfered} = 1;
359 $getreserv{nottransferedby} =
360 GetBranchName( $getiteminfo->{'holdingbranch'} );
363 # if we don't have a reserv on item, we put the biblio infos and the waiting position
364 if ( $getiteminfo->{'title'} eq '' ) {
365 my $getbibinfo = GetBiblioData( $num_res->{'biblionumber'} );
366 my $getbibtype = getitemtypeinfo( $getbibinfo->{'itemtype'} ); # fixme - we should have item-level reserves here ?
367 $getreserv{color} = 'inwait';
368 $getreserv{title} = $getbibinfo->{'title'};
369 $getreserv{waitingposition} = $num_res->{'priority'};
370 $getreserv{nottransfered} = 0;
371 $getreserv{itemtype} = $getbibtype->{'description'};
372 $getreserv{author} = $getbibinfo->{'author'};
373 $getreserv{itemcallnumber} = '----------';
374 $getreserv{biblionumber} = $num_res->{'biblionumber'};
376 push( @reservloop, \%getreserv );
378 # if we have a reserve waiting, initiate waitingreserveloop
379 if ($getreserv{waiting} eq 1) {
380 push (@WaitingReserveLoop, \%getWaitingReserveInfo)
385 # return result to the template
386 $template->param(
387 countreserv => scalar @reservloop,
388 reservloop => \@reservloop ,
389 WaitingReserveLoop => \@WaitingReserveLoop,
393 # make the issued books table.
394 my $todaysissues = '';
395 my $previssues = '';
396 my @todaysissues;
397 my @previousissues;
398 my $allowborrow;
399 ## ADDED BY JF: new itemtype issuingrules counter stuff
400 my $issued_itemtypes_loop;
401 my $issued_itemtypes_count;
402 my $issued_itemtypes_allowed_count; # hashref with total allowed by itemtype
403 my $issued_itemtypes_remaining; # hashref with remaining
404 my $issued_itemtypes_flags; #hashref that stores flags
405 my @issued_itemtypes_count_loop;
407 if ($borrower) {
409 # get each issue of the borrower & separate them in todayissues & previous issues
410 my ($countissues,$issueslist) = GetPendingIssues($borrower->{'borrowernumber'});
412 # split in 2 arrays for today & previous
413 foreach my $it ( @$issueslist ) {
414 my $issuedate = $it->{'issuedate'};
415 $issuedate =~ s/-//g;
416 $issuedate = substr( $issuedate, 0, 8 );
417 ($it->{'charge'}, $it->{'itemtype_charge'}) = GetIssuingCharges(
418 $it->{'itemnumber'}, $borrower->{'borrowernumber'}
420 $it->{'charge'} = sprintf("%.2f", $it->{'charge'});
421 ($it->{'can_renew'}, $it->{'can_renew_error'}) = CanBookBeRenewed(
422 $borrower->{'borrowernumber'},$it->{'itemnumber'}
424 my ($restype, $reserves) = CheckReserves($it->{'itemnumber'});
425 ($restype) and $it->{'can_renew'} = 0;
427 $it->{'dd'} = format_date($it->{'date_due'});
428 my $datedue = $it->{'date_due'};
429 $datedue =~ s/-//g;
430 $it->{'od'} = ($datedue < $todaysdate) ? 1 : 0 ;
431 ($it->{'author'} eq '') and $it->{'author'} = ' ';
432 $it->{'renew_failed'} = $renew_failed[$it->{'itemnumber'}];
433 # ADDED BY JF: NEW ITEMTYPE COUNT DISPLAY
434 $issued_itemtypes_count->{ $it->{'itemtype'} }++;
436 if ( $todaysdate == $issuedate ) {
437 push @todaysissues, $it;
438 } else {
439 push @previousissues, $it;
442 @todaysissues = sort { $b->{'timestamp'} <=> $a->{'timestamp'} } @todaysissues;
443 @previousissues = sort { $b->{'date_due' } <=> $a->{'date_due' } } @previousissues;
444 my $i = 1;
445 foreach my $book (@todaysissues) {
446 $book->{'togglecolor'} = (++$i % 2) ? 0 : 1 ;
448 $i = 1;
449 foreach my $book (@previousissues) {
450 $book->{'togglecolor'} = (++$i % 2) ? 0 : 1 ;
454 #### ADDED BY JF FOR COUNTS BY ITEMTYPE RULES
455 # FIXME: This should utilize all the issuingrules options rather than just the defaults
456 # and it should be moved to a module
457 my $dbh = C4::Context->dbh;
459 # how many of each is allowed?
460 my $issueqty_sth = $dbh->prepare( "
461 SELECT itemtypes.description AS description,issuingrules.itemtype,maxissueqty
462 FROM issuingrules
463 LEFT JOIN itemtypes ON (itemtypes.itemtype=issuingrules.itemtype)
464 WHERE categorycode=?
465 " );
466 #my @issued_itemtypes_count; # huh?
467 $issueqty_sth->execute("*");
469 while ( my $data = $issueqty_sth->fetchrow_hashref() ) {
471 # subtract how many of each this borrower has
472 $data->{'count'} = $issued_itemtypes_count->{ $data->{'description'} };
473 $data->{'left'} =
474 ( $data->{'maxissueqty'} -
475 $issued_itemtypes_count->{ $data->{'description'} } );
477 # can't have a negative number of remaining
478 if ( $data->{'left'} < 0 ) { $data->{'left'} = "0" }
479 $data->{'flag'} = 1 unless ( $data->{'maxissueqty'} > $data->{'count'} );
480 unless ( ( $data->{'maxissueqty'} < 1 )
481 || ( $data->{'itemtype'} eq "*" )
482 || ( $data->{'itemtype'} eq "CIRC" ) )
484 push @issued_itemtypes_count_loop, $data;
487 $issued_itemtypes_loop = \@issued_itemtypes_count_loop;
489 #### / JF
491 my @values;
492 my %labels;
493 my $CGIselectborrower;
494 if ($borrowerslist) {
495 foreach (
496 sort {
497 $a->{'surname'}
498 . $a->{'firstname'} cmp $b->{'surname'}
499 . $b->{'firstname'}
500 } @$borrowerslist
503 push @values, $_->{'borrowernumber'};
504 $labels{ $_->{'borrowernumber'} } =
505 "$_->{'surname'}, $_->{'firstname'} ... ($_->{'cardnumber'} - $_->{'categorycode'}) ... $_->{'address'} ";
507 $CGIselectborrower = CGI::scrolling_list(
508 -name => 'borrowernumber',
509 -class => 'focus',
510 -id => 'borrowernumber',
511 -values => \@values,
512 -labels => \%labels,
513 -size => 7,
514 -tabindex => '',
515 -multiple => 0
519 #title
520 my $flags = $borrower->{'flags'};
521 my $flag;
523 foreach $flag ( sort keys %$flags ) {
525 $flags->{$flag}->{'message'} =~ s/\n/<br>/g;
526 if ( $flags->{$flag}->{'noissues'} ) {
527 $template->param(
528 flagged => 1,
529 noissues => 'true',
531 if ( $flag eq 'GNA' ) {
532 $template->param( gna => 'true' );
534 if ( $flag eq 'LOST' ) {
535 $template->param( lost => 'true' );
537 if ( $flag eq 'DBARRED' ) {
538 $template->param( dbarred => 'true' );
540 if ( $flag eq 'CHARGES' ) {
541 $template->param(
542 charges => 'true',
543 chargesmsg => $flags->{'CHARGES'}->{'message'}
546 if ( $flag eq 'CREDITS' ) {
547 $template->param(
548 credits => 'true',
549 creditsmsg => $flags->{'CREDITS'}->{'message'}
553 else {
554 if ( $flag eq 'CHARGES' ) {
555 $template->param(
556 charges => 'true',
557 flagged => 1,
558 chargesmsg => $flags->{'CHARGES'}->{'message'}
561 if ( $flag eq 'CREDITS' ) {
562 $template->param(
563 credits => 'true',
564 creditsmsg => $flags->{'CREDITS'}->{'message'}
567 if ( $flag eq 'ODUES' ) {
568 $template->param(
569 odues => 'true',
570 flagged => 1,
571 oduesmsg => $flags->{'ODUES'}->{'message'}
574 my $items = $flags->{$flag}->{'itemlist'};
575 # useless ???
577 # my @itemswaiting;
578 # foreach my $item (@$items) {
579 # my ($iteminformation) =
580 # getiteminformation( $item->{'itemnumber'}, 0 );
581 # push @itemswaiting, $iteminformation;
584 if ( $query->param('module') ne 'returns' ) {
585 $template->param( nonreturns => 'true' );
588 if ( $flag eq 'NOTES' ) {
589 $template->param(
590 notes => 'true',
591 flagged => 1,
592 notesmsg => $flags->{'NOTES'}->{'message'}
598 my $amountold = $borrower->{flags}->{'CHARGES'}->{'message'} || 0;
599 my @temp = split( /\$/, $amountold );
601 my $CGIorganisations;
602 my $member_of_institution;
603 if ( C4::Context->preference("memberofinstitution") ) {
604 my $organisations = get_institutions();
605 my @orgs;
606 my %org_labels;
607 foreach my $organisation ( keys %$organisations ) {
608 push @orgs, $organisation;
609 $org_labels{$organisation} =
610 $organisations->{$organisation}->{'surname'};
612 $member_of_institution = 1;
613 $CGIorganisations = CGI::popup_menu(
614 -id => 'organisations',
615 -name => 'organisations',
616 -labels => \%org_labels,
617 -values => \@orgs,
621 $amountold = $temp[1];
623 my $borrowercategory = GetBorrowercategory( $borrower->{'categorycode'} );
624 my $category_type = $borrowercategory->{'category_type'};
625 ( $template->param( adultborrower => 1 ) ) if ( $category_type eq 'A' );
627 $template->param(
628 issued_itemtypes_count_loop => $issued_itemtypes_loop,
629 findborrower => $findborrower,
630 borrower => $borrower,
631 borrowernumber => $borrowernumber,
632 branch => $branch,
633 printer => $printer,
634 printername => $printer,
635 firstname => $borrower->{'firstname'},
636 surname => $borrower->{'surname'},
637 expiry =>
638 $borrower->{'dateexpiry'}, #format_date($borrower->{'dateexpiry'}),
639 categorycode => $borrower->{'categorycode'},
640 address => $borrower->{'address'},
641 address2 => $borrower->{'address2'},
642 email => $borrower->{'email'},
643 emailpro => $borrower->{'emailpro'},
644 borrowernotes => $borrower->{'borrowernotes'},
645 city => $borrower->{'city'},
646 phone => $borrower->{'phone'} || $borrower->{'mobile'},
647 cardnumber => $borrower->{'cardnumber'},
648 amountold => $amountold,
649 barcode => $barcode,
650 stickyduedate => $stickyduedate,
651 message => $message,
652 CGIselectborrower => $CGIselectborrower,
653 todayissues => \@todaysissues,
654 previssues => \@previousissues,
655 inprocess => $inprocess,
656 memberofinstution => $member_of_institution,
657 CGIorganisations => $CGIorganisations,
658 circview => 1,
662 # set return date if stickyduedate
663 if ($stickyduedate) {
664 $template->param(
665 duedatespec => $duedatespec,
669 #if ($branchcookie) {
670 #$cookie=[$cookie, $branchcookie, $printercookie];
673 $template->param(
674 SpecifyDueDate => C4::Context->preference("SpecifyDueDate"),
675 CircAutocompl => C4::Context->preference("CircAutocompl") ,
676 DHTMLformat => C4::Dates->DHTMLcalendar(),
678 output_html_with_http_headers $query, $cookie, $template->output;