4 # Copyright 2000-2002 Katipo Communications
5 # copyright 2010 BibLibre
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 2 of the License, or (at your option) any later
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #use warnings; FIXME - Bug 2505
24 use Date::Calc qw/Today Date_to_Days/;
25 use Date::Manip qw/UnixDate/;
29 use C4::Log; # logaction
32 use vars qw($VERSION @ISA @EXPORT);
35 # set the version for version checking
36 $VERSION = 3.07.00.049;
39 # subs to rename (and maybe merge some...)
44 &CheckAccountLineLevelInfo
45 &CheckAccountLineItemInfo
46 &CheckExistantNotifyid
56 &CreateItemAccountLine
69 # check that an equivalent don't exist already before moving
71 # subs to move to Circulation.pm
76 # &GetIssuingRules - delete.
77 # use C4::Circulation::GetIssuingRule instead.
79 # subs to move to Members.pm
81 &CheckBorrowerDebarred
83 # subs to move to Biblio.pm
92 C4::Circulation::Fines - Koha module dealing with fines
100 This module contains several functions for dealing with fines for
101 overdue items. It is primarily used by the 'misc/fines2.pl' script.
107 $overdues = Getoverdues( { minimumdays => 1, maximumdays => 30 } );
109 Returns the list of all overdue books, with their itemtype.
111 C<$overdues> is a reference-to-array. Each element is a
112 reference-to-hash whose keys are the fields of the issues table in the
120 my $dbh = C4::Context->dbh;
122 if ( C4::Context->preference('item-level_itypes') ) {
124 SELECT issues.*, items.itype as itemtype, items.homebranch, items.barcode
126 LEFT JOIN items USING (itemnumber)
127 WHERE date_due < NOW()
131 SELECT issues.*, biblioitems.itemtype, items.itype, items.homebranch, items.barcode
133 LEFT JOIN items USING (itemnumber)
134 LEFT JOIN biblioitems USING (biblioitemnumber)
135 WHERE date_due < NOW()
140 if ( exists $params->{'minimumdays'} and exists $params->{'maximumdays'} ) {
141 $statement .= ' AND TO_DAYS( NOW() )-TO_DAYS( date_due ) BETWEEN ? and ? ';
142 push @bind_parameters, $params->{'minimumdays'}, $params->{'maximumdays'};
143 } elsif ( exists $params->{'minimumdays'} ) {
144 $statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) > ? ';
145 push @bind_parameters, $params->{'minimumdays'};
146 } elsif ( exists $params->{'maximumdays'} ) {
147 $statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ? ';
148 push @bind_parameters, $params->{'maximumdays'};
150 $statement .= 'ORDER BY borrowernumber';
151 my $sth = $dbh->prepare( $statement );
152 $sth->execute( @bind_parameters );
153 return $sth->fetchall_arrayref({});
159 ($count, $overdueitems) = checkoverdues($borrowernumber);
161 Returns a count and a list of overdueitems for a given borrowernumber
166 my $borrowernumber = shift or return;
167 # don't select biblioitems.marc or biblioitems.marcxml... too slow on large systems
168 my $sth = C4::Context->dbh->prepare(
169 "SELECT biblio.*, items.*, issues.*,
172 biblioitems.itemtype,
175 biblioitems.publicationyear,
176 biblioitems.publishercode,
177 biblioitems.volumedate,
178 biblioitems.volumedesc,
179 biblioitems.collectiontitle,
180 biblioitems.collectionissn,
181 biblioitems.collectionvolume,
182 biblioitems.editionstatement,
183 biblioitems.editionresponsibility,
191 biblioitems.cn_source,
192 biblioitems.cn_class,
194 biblioitems.cn_suffix,
196 biblioitems.totalissues
198 LEFT JOIN items ON issues.itemnumber = items.itemnumber
199 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
200 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
201 WHERE issues.borrowernumber = ?
202 AND issues.date_due < NOW()"
204 # FIXME: SELECT * across 4 tables? do we really need the marc AND marcxml blobs??
205 $sth->execute($borrowernumber);
206 my $results = $sth->fetchall_arrayref({});
207 return ( scalar(@$results), $results); # returning the count and the results is silly
212 ($amount, $chargename, $daycounttotal) = &CalcFine($item,
213 $categorycode, $branch,
214 $start_dt, $end_dt );
216 Calculates the fine for a book.
218 The issuingrules table in the Koha database is a fine matrix, listing
219 the penalties for each type of patron for each type of item and each branch (e.g., the
220 standard fine for books might be $0.50, but $1.50 for DVDs, or staff
221 members might get a longer grace period between the first and second
222 reminders that a book is overdue).
225 C<$item> is an item object (hashref).
227 C<$categorycode> is the category code (string) of the patron who currently has
230 C<$branchcode> is the library (string) whose issuingrules govern this transaction.
232 C<$start_date> & C<$end_date> are DateTime objects
233 defining the date range over which to determine the fine.
235 Fines scripts should just supply the date range over which to calculate the fine.
237 C<&CalcFine> returns four values:
239 C<$amount> is the fine owed by the patron (see above).
241 C<$chargename> is the chargename field from the applicable record in
242 the categoryitem table, whatever that is.
244 C<$unitcount> is the number of chargeable units (days between start and end dates, Calendar adjusted where needed,
245 minus any applicable grace period, or hours)
247 FIXME - What is chargename supposed to be ?
249 FIXME: previously attempted to return C<$message> as a text message, either "First Notice", "Second Notice",
250 or "Final Notice". But CalcFine never defined any value.
255 my ( $item, $bortype, $branchcode, $due_dt, $end_date ) = @_;
256 my $start_date = $due_dt->clone();
257 # get issuingrules (fines part will be used)
258 my $itemtype = $item->{itemtype} || $item->{itype};
259 my $data = C4::Circulation::GetIssuingRule($bortype, $itemtype, $branchcode);
260 my $fine_unit = $data->{lengthunit};
261 $fine_unit ||= 'days';
263 my $chargeable_units = _get_chargeable_units($fine_unit, $start_date, $end_date, $branchcode);
264 my $units_minus_grace = $chargeable_units - $data->{firstremind};
266 if ($data->{'chargeperiod'} && $units_minus_grace ) {
267 $amount = int($chargeable_units / $data->{'chargeperiod'}) * $data->{'fine'};# TODO fine calc should be in cents
269 # a zero (or null) chargeperiod means no charge.
271 $amount = $data->{overduefinescap} if $data->{overduefinescap} && $amount > $data->{overduefinescap};
272 $debug and warn sprintf("CalcFine returning (%s, %s, %s, %s)", $amount, $data->{'chargename'}, $units_minus_grace, $chargeable_units);
273 return ($amount, $data->{'chargename'}, $units_minus_grace, $chargeable_units);
274 # FIXME: chargename is NEVER populated anywhere.
278 =head2 _get_chargeable_units
280 _get_chargeable_units($unit, $start_date_ $end_date, $branchcode);
282 return integer value of units between C<$start_date> and C<$end_date>, factoring in holidays for C<$branchcode>.
284 C<$unit> is 'days' or 'hours' (default is 'days').
286 C<$start_date> and C<$end_date> are the two DateTimes to get the number of units between.
288 C<$branchcode> is the branch whose calendar to use for finding holidays.
292 sub _get_chargeable_units {
293 my ($unit, $dt1, $dt2, $branchcode) = @_;
294 my $charge_units = 0;
296 if ($unit eq 'hours') {
297 if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
298 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
299 $charge_duration = $calendar->hours_between( $dt1, $dt2 );
301 $charge_duration = $dt2->delta_ms( $dt1 );
303 if($charge_duration->in_units('hours') == 0 && $charge_duration->in_units('seconds') > 0){
306 return $charge_duration->in_units('hours');
309 if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
310 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
311 $charge_duration = $calendar->days_between( $dt1, $dt2 );
313 $charge_duration = $dt2->delta_days( $dt1 );
315 return $charge_duration->in_units('days');
320 =head2 GetSpecialHolidays
322 &GetSpecialHolidays($date_dues,$itemnumber);
324 return number of special days between date of the day and date due
326 C<$date_dues> is the envisaged date of book return.
328 C<$itemnumber> is the book's item number.
332 sub GetSpecialHolidays {
333 my ( $date_dues, $itemnumber ) = @_;
335 # calcul the today date
336 my $today = join "-", &Today();
338 # return the holdingbranch
339 my $iteminfo = GetIssuesIteminfo($itemnumber);
341 # use sql request to find all date between date_due and today
342 my $dbh = C4::Context->dbh;
344 qq|SELECT DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') as date
345 FROM `special_holidays`
346 WHERE DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') >= ?
347 AND DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') <= ?
350 my @result = GetWdayFromItemnumber($itemnumber);
354 my $sth = $dbh->prepare($query);
355 $sth->execute( $date_dues, $today, $iteminfo->{'branchcode'} )
356 ; # FIXME: just use NOW() in SQL instead of passing in $today
358 while ( my $special_date = $sth->fetchrow_hashref ) {
359 push( @result_date, $special_date );
362 my $specialdaycount = scalar(@result_date);
364 for ( my $i = 0 ; $i < scalar(@result_date) ; $i++ ) {
365 $dateinsec = UnixDate( $result_date[$i]->{'date'}, "%o" );
366 ( undef, undef, undef, undef, undef, undef, $wday, undef, undef ) =
367 localtime($dateinsec);
368 for ( my $j = 0 ; $j < scalar(@result) ; $j++ ) {
369 if ( $wday == ( $result[$j]->{'weekday'} ) ) {
375 return $specialdaycount;
378 =head2 GetRepeatableHolidays
380 &GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
382 return number of day closed between date of the day and date due
384 C<$date_dues> is the envisaged date of book return.
386 C<$itemnumber> is item number.
388 C<$difference> numbers of between day date of the day and date due
392 sub GetRepeatableHolidays {
393 my ( $date_dues, $itemnumber, $difference ) = @_;
394 my $dateinsec = UnixDate( $date_dues, "%o" );
395 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) =
396 localtime($dateinsec);
397 my @result = GetWdayFromItemnumber($itemnumber);
401 for ( my $i = 0 ; $i < scalar(@result) ; $i++ ) {
404 for ( $j = 0 ; $j < $difference ; $j++ ) {
405 if ( $result[$i]->{'weekday'} == $k ) {
406 push( @dayclosedcount, $k );
409 ( $k = 0 ) if ( $k eq 7 );
412 return scalar(@dayclosedcount);
416 =head2 GetWayFromItemnumber
418 &Getwdayfromitemnumber($itemnumber);
420 return the different week day from repeatable_holidays table
422 C<$itemnumber> is item number.
426 sub GetWdayFromItemnumber {
427 my ($itemnumber) = @_;
428 my $iteminfo = GetIssuesIteminfo($itemnumber);
430 my $query = qq|SELECT weekday
431 FROM repeatable_holidays
434 my $sth = C4::Context->dbh->prepare($query);
436 $sth->execute( $iteminfo->{'branchcode'} );
437 while ( my $weekday = $sth->fetchrow_hashref ) {
438 push( @result, $weekday );
444 =head2 GetIssuesIteminfo
446 &GetIssuesIteminfo($itemnumber);
448 return all data from issues about item
450 C<$itemnumber> is item number.
454 sub GetIssuesIteminfo {
455 my ($itemnumber) = @_;
456 my $dbh = C4::Context->dbh;
457 my $query = qq|SELECT *
461 my $sth = $dbh->prepare($query);
462 $sth->execute($itemnumber);
463 my ($issuesinfo) = $sth->fetchrow_hashref;
470 &UpdateFine($itemnumber, $borrowernumber, $amount, $type, $description);
472 (Note: the following is mostly conjecture and guesswork.)
474 Updates the fine owed on an overdue book.
476 C<$itemnumber> is the book's item number.
478 C<$borrowernumber> is the borrower number of the patron who currently
479 has the book on loan.
481 C<$amount> is the current amount owed by the patron.
483 C<$type> will be used in the description of the fine.
485 C<$description> is a string that must be present in the description of
486 the fine. I think this is expected to be a date in DD/MM/YYYY format.
488 C<&UpdateFine> looks up the amount currently owed on the given item
489 and sets it to C<$amount>, creating, if necessary, a new entry in the
490 accountlines table of the Koha database.
495 # Question: Why should the caller have to
496 # specify both the item number and the borrower number? A book can't
497 # be on loan to two different people, so the item number should be
500 # Possible Answer: You might update a fine for a damaged item, *after* it is returned.
503 my ( $itemnum, $borrowernumber, $amount, $type, $due ) = @_;
504 $debug and warn "UpdateFine($itemnum, $borrowernumber, $amount, " . ($type||'""') . ", $due) called";
505 my $dbh = C4::Context->dbh;
506 # FIXME - What exactly is this query supposed to do? It looks up an
507 # entry in accountlines that matches the given item and borrower
508 # numbers, where the description contains $due, and where the
509 # account type has one of several values, but what does this _mean_?
510 # Does it look up existing fines for this item?
511 # FIXME - What are these various account types? ("FU", "O", "F", "M")
513 # "A" is Account Management Fee
518 # "FU" is Fine UPDATE??
520 # "REF" is Cash Refund
521 my $sth = $dbh->prepare(
522 "SELECT * FROM accountlines
523 WHERE borrowernumber=?
524 AND accounttype IN ('FU','O','F','M')"
526 $sth->execute( $borrowernumber );
528 my $total_amount_other = 0.00;
529 my $due_qr = qr/$due/;
530 # Cycle through the fines and
531 # - find line that relates to the requested $itemnum
532 # - accumulate fines for other items
533 # so we can update $itemnum fine taking in account fine caps
534 while (my $rec = $sth->fetchrow_hashref) {
535 if ($rec->{itemnumber} == $itemnum && $rec->{description} =~ /$due_qr/) {
537 warn "Not a unique accountlines record for item $itemnum borrower $borrowernumber";
543 $total_amount_other += $rec->{'amount'};
545 if (my $maxfine = C4::Context->preference('MaxFine')) {
546 if ($total_amount_other + $amount > $maxfine) {
547 my $new_amount = $maxfine - $total_amount_other;
548 warn "Reducing fine for item $itemnum borrower $borrowernumber from $amount to $new_amount - MaxFine reached";
549 return if $new_amount <= 0.00;
551 $amount = $new_amount;
557 # we're updating an existing fine. Only modify if amount changed
558 # Note that in the current implementation, you cannot pay against an accruing fine
559 # (i.e. , of accounttype 'FU'). Doing so will break accrual.
560 if ( $data->{'amount'} != $amount ) {
561 my $diff = $amount - $data->{'amount'};
562 #3341: diff could be positive or negative!
563 my $out = $data->{'amountoutstanding'} + $diff;
566 SET date=now(), amount=?, amountoutstanding=?,
567 lastincrement=?, accounttype='FU'
568 WHERE borrowernumber=?
570 AND accounttype IN ('FU','O')
571 AND description LIKE ?
573 my $sth2 = $dbh->prepare($query);
574 # FIXME: BOGUS query cannot ensure uniqueness w/ LIKE %x% !!!
575 # LIMIT 1 added to prevent multiple affected lines
576 # FIXME: accountlines table needs unique key!! Possibly a combo of borrowernumber and accountline.
577 # But actually, we should just have a regular autoincrementing PK and forget accountline,
578 # including the bogus getnextaccountno function (doesn't prevent conflict on simultaneous ops).
579 # FIXME: Why only 2 account types here?
580 $debug and print STDERR "UpdateFine query: $query\n" .
581 "w/ args: $amount, $out, $diff, $data->{'borrowernumber'}, $data->{'itemnumber'}, \"\%$due\%\"\n";
582 $sth2->execute($amount, $out, $diff, $data->{'borrowernumber'}, $data->{'itemnumber'}, "%$due%");
584 # print "no update needed $data->{'amount'}"
587 my $sth4 = $dbh->prepare(
588 "SELECT title FROM biblio LEFT JOIN items ON biblio.biblionumber=items.biblionumber WHERE items.itemnumber=?"
590 $sth4->execute($itemnum);
591 my $title = $sth4->fetchrow;
593 # # print "not in account";
594 # my $sth3 = $dbh->prepare("Select max(accountno) from accountlines");
597 # # FIXME - Make $accountno a scalar.
598 # my @accountno = $sth3->fetchrow_array;
602 my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
603 my $desc = ($type ? "$type " : '') . "$title $due"; # FIXEDME, avoid whitespace prefix on empty $type
604 my $query = "INSERT INTO accountlines
605 (borrowernumber,itemnumber,date,amount,description,accounttype,amountoutstanding,lastincrement,accountno)
606 VALUES (?,?,now(),?,?,'FU',?,?,?)";
607 my $sth2 = $dbh->prepare($query);
608 $debug and print STDERR "UpdateFine query: $query\nw/ args: $borrowernumber, $itemnum, $amount, $desc, $amount, $amount, $nextaccntno\n";
609 $sth2->execute($borrowernumber, $itemnum, $amount, $desc, $amount, $amount, $nextaccntno);
616 "due=".$due." amount=".$amount." itemnumber=".$itemnum
617 ) if C4::Context->preference("FinesLog");
622 $borrower = &BorType($borrowernumber);
624 Looks up a patron by borrower number.
626 C<$borrower> is a reference-to-hash whose keys are all of the fields
627 from the borrowers and categories tables of the Koha database. Thus,
628 C<$borrower> contains all information about both the borrower and
629 category he or she belongs to.
635 my ($borrowernumber) = @_;
636 my $dbh = C4::Context->dbh;
637 my $sth = $dbh->prepare(
638 "SELECT * from borrowers
639 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
640 WHERE borrowernumber=?"
642 $sth->execute($borrowernumber);
643 return $sth->fetchrow_hashref;
646 =head2 ReplacementCost
648 $cost = &ReplacementCost($itemnumber);
650 Returns the replacement cost of the item with the given item number.
655 sub ReplacementCost {
657 my $dbh = C4::Context->dbh;
659 $dbh->prepare("Select replacementprice from items where itemnumber=?");
660 $sth->execute($itemnum);
662 # FIXME - Use fetchrow_array or a slice.
663 my $data = $sth->fetchrow_hashref;
664 return ( $data->{'replacementprice'} );
669 $data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
671 return the total of fine
673 C<$itemnum> is item number
675 C<$borrowernumber> is the borrowernumber
681 my ( $itemnum, $borrowernumber ) = @_;
682 my $dbh = C4::Context->dbh();
683 my $query = q|SELECT sum(amountoutstanding) as fineamount FROM accountlines
684 where accounttype like 'F%'
685 AND amountoutstanding > 0 AND itemnumber = ? AND borrowernumber=?|;
686 my $sth = $dbh->prepare($query);
687 $sth->execute( $itemnum, $borrowernumber );
688 my $fine = $sth->fetchrow_hashref();
689 if ($fine->{fineamount}) {
690 return $fine->{fineamount};
696 =head2 GetIssuingRules
698 FIXME - This sub should be deprecated and removed.
699 It ignores branch and defaults.
701 $data = &GetIssuingRules($itemtype,$categorycode);
703 Looks up for all issuingrules an item info
705 C<$itemnumber> is a reference-to-hash whose keys are all of the fields
706 from the borrowers and categories tables of the Koha database. Thus,
708 C<$categorycode> contains information about borrowers category
710 C<$data> contains all information about both the borrower and
711 category he or she belongs to.
714 sub GetIssuingRules {
715 warn "GetIssuingRules is deprecated: use GetIssuingRule from C4::Circulation instead.";
716 my ($itemtype,$categorycode)=@_;
717 my $dbh = C4::Context->dbh();
718 my $query=qq|SELECT *
720 WHERE issuingrules.itemtype=?
721 AND issuingrules.categorycode=?
723 my $sth = $dbh->prepare($query);
725 $sth->execute($itemtype,$categorycode);
726 return $sth->fetchrow_hashref;
730 sub ReplacementCost2 {
731 my ( $itemnum, $borrowernumber ) = @_;
732 my $dbh = C4::Context->dbh();
733 my $query = "SELECT amountoutstanding
735 WHERE accounttype like 'L'
736 AND amountoutstanding > 0
738 AND borrowernumber= ?";
739 my $sth = $dbh->prepare($query);
740 $sth->execute( $itemnum, $borrowernumber );
741 my $data = $sth->fetchrow_hashref();
742 return ( $data->{'amountoutstanding'} );
746 =head2 GetNextIdNotify
748 ($result) = &GetNextIdNotify($reference);
750 Returns the new file number
752 C<$result> contains the next file number
754 C<$reference> contains the beggining of file number
758 sub GetNextIdNotify {
759 my ($reference) = @_;
760 my $query = qq|SELECT max(notify_id)
762 WHERE notify_id like \"$reference%\"
765 # AND borrowernumber=?|;
766 my $dbh = C4::Context->dbh;
767 my $sth = $dbh->prepare($query);
769 my $result = $sth->fetchrow;
771 if ( $result eq '' ) {
772 ( $result = $reference . "01" );
775 $count = substr( $result, 6 ) + 1;
778 ( $count = "0" . $count );
780 $result = $reference . $count;
785 =head2 NumberNotifyId
787 (@notify) = &NumberNotifyId($borrowernumber);
789 Returns amount for all file per borrowers
790 C<@notify> array contains all file per borrowers
792 C<$notify_id> contains the file number for the borrower number nad item number
797 my ($borrowernumber)=@_;
798 my $dbh = C4::Context->dbh;
799 my $query=qq| SELECT distinct(notify_id)
801 WHERE borrowernumber=?|;
803 my $sth = $dbh->prepare($query);
804 $sth->execute($borrowernumber);
805 while ( my ($numberofnotify) = $sth->fetchrow ) {
806 push( @notify, $numberofnotify );
813 ($totalnotify) = &AmountNotify($notifyid);
815 Returns amount for all file per borrowers
816 C<$notifyid> is the file number
818 C<$totalnotify> contains amount of a file
820 C<$notify_id> contains the file number for the borrower number and item number
825 my ($notifyid,$borrowernumber)=@_;
826 my $dbh = C4::Context->dbh;
827 my $query=qq| SELECT sum(amountoutstanding)
829 WHERE notify_id=? AND borrowernumber = ?|;
830 my $sth=$dbh->prepare($query);
831 $sth->execute($notifyid,$borrowernumber);
832 my $totalnotify=$sth->fetchrow;
834 return ($totalnotify);
840 ($notify_id) = &GetNotifyId($borrowernumber,$itemnumber);
842 Returns the file number per borrower and itemnumber
844 C<$borrowernumber> is a reference-to-hash whose keys are all of the fields
845 from the items tables of the Koha database. Thus,
847 C<$itemnumber> contains the borrower categorycode
849 C<$notify_id> contains the file number for the borrower number nad item number
854 my ( $borrowernumber, $itemnumber ) = @_;
855 my $query = qq|SELECT notify_id
857 WHERE borrowernumber=?
859 AND (accounttype='FU' or accounttype='O')|;
860 my $dbh = C4::Context->dbh;
861 my $sth = $dbh->prepare($query);
862 $sth->execute( $borrowernumber, $itemnumber );
863 my ($notify_id) = $sth->fetchrow;
868 =head2 CreateItemAccountLine
870 () = &CreateItemAccountLine($borrowernumber, $itemnumber, $date, $amount,
871 $description, $accounttype, $amountoutstanding,
872 $timestamp, $notify_id, $level);
874 update the account lines with file number or with file level
876 C<$items> is a reference-to-hash whose keys are all of the fields
877 from the items tables of the Koha database. Thus,
879 C<$itemnumber> contains the item number
881 C<$borrowernumber> contains the borrower number
883 C<$date> contains the date of the day
885 C<$amount> contains item price
887 C<$description> contains the descritpion of accounttype
889 C<$accounttype> contains the account type
891 C<$amountoutstanding> contains the $amountoutstanding
893 C<$timestamp> contains the timestamp with time and the date of the day
895 C<$notify_id> contains the file number
897 C<$level> contains the file level
901 sub CreateItemAccountLine {
903 $borrowernumber, $itemnumber, $date, $amount,
904 $description, $accounttype, $amountoutstanding, $timestamp,
907 my $dbh = C4::Context->dbh;
908 my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
909 my $query = "INSERT into accountlines
910 (borrowernumber,accountno,itemnumber,date,amount,description,accounttype,amountoutstanding,timestamp,notify_id,notify_level)
912 (?,?,?,?,?,?,?,?,?,?,?)";
914 my $sth = $dbh->prepare($query);
916 $borrowernumber, $nextaccntno, $itemnumber,
917 $date, $amount, $description,
918 $accounttype, $amountoutstanding, $timestamp,
923 =head2 UpdateAccountLines
925 () = &UpdateAccountLines($notify_id,$notify_level,$borrowernumber,$itemnumber);
927 update the account lines with file number or with file level
929 C<$items> is a reference-to-hash whose keys are all of the fields
930 from the items tables of the Koha database. Thus,
932 C<$itemnumber> contains the item number
934 C<$notify_id> contains the file number
936 C<$notify_level> contains the file level
938 C<$borrowernumber> contains the borrowernumber
942 sub UpdateAccountLines {
943 my ( $notify_id, $notify_level, $borrowernumber, $itemnumber ) = @_;
945 if ( $notify_id eq '' ) {
946 $query = qq|UPDATE accountlines
948 WHERE borrowernumber=? AND itemnumber=?
949 AND (accounttype='FU' or accounttype='O')|;
951 $query = qq|UPDATE accountlines
952 SET notify_id=?, notify_level=?
953 WHERE borrowernumber=?
955 AND (accounttype='FU' or accounttype='O')|;
958 my $sth = C4::Context->dbh->prepare($query);
959 if ( $notify_id eq '' ) {
960 $sth->execute( $notify_level, $borrowernumber, $itemnumber );
962 $sth->execute( $notify_id, $notify_level, $borrowernumber, $itemnumber );
968 ($items) = &GetItems($itemnumber);
970 Returns the list of all delays from overduerules.
972 C<$items> is a reference-to-hash whose keys are all of the fields
973 from the items tables of the Koha database. Thus,
975 C<$itemnumber> contains the borrower categorycode
979 # FIXME: This is a bad function to have here.
980 # Shouldn't it be in C4::Items?
981 # Shouldn't it be called GetItem since you only get 1 row?
982 # Shouldn't it be called GetItem since you give it only 1 itemnumber?
985 my $itemnumber = shift or return;
986 my $query = qq|SELECT *
989 my $sth = C4::Context->dbh->prepare($query);
990 $sth->execute($itemnumber);
991 my ($items) = $sth->fetchrow_hashref;
995 =head2 GetOverdueDelays
997 (@delays) = &GetOverdueDelays($categorycode);
999 Returns the list of all delays from overduerules.
1001 C<@delays> it's an array contains the three delays from overduerules table
1003 C<$categorycode> contains the borrower categorycode
1007 sub GetOverdueDelays {
1008 my ($category) = @_;
1009 my $query = qq|SELECT delay1,delay2,delay3
1011 WHERE categorycode=?|;
1012 my $sth = C4::Context->dbh->prepare($query);
1013 $sth->execute($category);
1014 my (@delays) = $sth->fetchrow_array;
1018 =head2 GetBranchcodesWithOverdueRules
1020 my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
1022 returns a list of branch codes for branches with overdue rules defined.
1026 sub GetBranchcodesWithOverdueRules {
1027 my $dbh = C4::Context->dbh;
1028 my $rqoverduebranches = $dbh->prepare("SELECT DISTINCT branchcode FROM overduerules WHERE delay1 IS NOT NULL AND branchcode <> '' ORDER BY branchcode");
1029 $rqoverduebranches->execute;
1030 my @branches = map { shift @$_ } @{ $rqoverduebranches->fetchall_arrayref };
1031 if (!$branches[0]) {
1032 my $availbranches = C4::Branch::GetBranches();
1033 @branches = keys %$availbranches;
1038 =head2 CheckAccountLineLevelInfo
1040 ($exist) = &CheckAccountLineLevelInfo($borrowernumber,$itemnumber,$accounttype,notify_level);
1042 Check and Returns the list of all overdue books.
1044 C<$exist> contains number of line in accounlines
1045 with the same .biblionumber,itemnumber,accounttype,and notify_level
1047 C<$borrowernumber> contains the borrower number
1049 C<$itemnumber> contains item number
1051 C<$accounttype> contains account type
1053 C<$notify_level> contains the accountline level
1058 sub CheckAccountLineLevelInfo {
1059 my ( $borrowernumber, $itemnumber, $level ) = @_;
1060 my $dbh = C4::Context->dbh;
1061 my $query = qq|SELECT count(*)
1063 WHERE borrowernumber =?
1065 AND notify_level=?|;
1066 my $sth = $dbh->prepare($query);
1067 $sth->execute( $borrowernumber, $itemnumber, $level );
1068 my ($exist) = $sth->fetchrow;
1072 =head2 GetOverduerules
1074 ($overduerules) = &GetOverduerules($categorycode);
1076 Returns the value of borrowers (debarred or not) with notify level
1078 C<$overduerules> return value of debbraed field in overduerules table
1080 C<$category> contains the borrower categorycode
1082 C<$notify_level> contains the notify level
1086 sub GetOverduerules {
1087 my ( $category, $notify_level ) = @_;
1088 my $dbh = C4::Context->dbh;
1089 my $query = qq|SELECT debarred$notify_level
1091 WHERE categorycode=?|;
1092 my $sth = $dbh->prepare($query);
1093 $sth->execute($category);
1094 my ($overduerules) = $sth->fetchrow;
1095 return ($overduerules);
1099 =head2 CheckBorrowerDebarred
1101 ($debarredstatus) = &CheckBorrowerDebarred($borrowernumber);
1103 Check if the borrowers is already debarred
1105 C<$debarredstatus> return 0 for not debarred and return 1 for debarred
1107 C<$borrowernumber> contains the borrower number
1111 # FIXME: Shouldn't this be in C4::Members?
1112 sub CheckBorrowerDebarred {
1113 my ($borrowernumber) = @_;
1114 my $dbh = C4::Context->dbh;
1118 WHERE borrowernumber=?
1119 AND debarred > NOW()
1121 my $sth = $dbh->prepare($query);
1122 $sth->execute($borrowernumber);
1123 my $debarredstatus = $sth->fetchrow;
1124 return $debarredstatus;
1128 =head2 CheckExistantNotifyid
1130 ($exist) = &CheckExistantNotifyid($borrowernumber,$itemnumber,$accounttype,$notify_id);
1132 Check and Returns the notify id if exist else return 0.
1134 C<$exist> contains a notify_id
1136 C<$borrowernumber> contains the borrower number
1138 C<$date_due> contains the date of item return
1143 sub CheckExistantNotifyid {
1144 my ( $borrowernumber, $date_due ) = @_;
1145 my $dbh = C4::Context->dbh;
1146 my $query = qq|SELECT notify_id FROM accountlines
1147 LEFT JOIN issues ON issues.itemnumber= accountlines.itemnumber
1148 WHERE accountlines.borrowernumber =?
1150 my $sth = $dbh->prepare($query);
1151 $sth->execute( $borrowernumber, $date_due );
1152 return $sth->fetchrow || 0;
1155 =head2 CheckAccountLineItemInfo
1157 ($exist) = &CheckAccountLineItemInfo($borrowernumber,$itemnumber,$accounttype,$notify_id);
1159 Check and Returns the list of all overdue items from the same file number(notify_id).
1161 C<$exist> contains number of line in accounlines
1162 with the same .biblionumber,itemnumber,accounttype,notify_id
1164 C<$borrowernumber> contains the borrower number
1166 C<$itemnumber> contains item number
1168 C<$accounttype> contains account type
1170 C<$notify_id> contains the file number
1174 sub CheckAccountLineItemInfo {
1175 my ( $borrowernumber, $itemnumber, $accounttype, $notify_id ) = @_;
1176 my $dbh = C4::Context->dbh;
1177 my $query = qq|SELECT count(*) FROM accountlines
1178 WHERE borrowernumber =?
1182 my $sth = $dbh->prepare($query);
1183 $sth->execute( $borrowernumber, $itemnumber, $accounttype, $notify_id );
1184 my ($exist) = $sth->fetchrow;
1188 =head2 CheckItemNotify
1190 Sql request to check if the document has alreday been notified
1191 this function is not exported, only used with GetOverduesForBranch
1195 sub CheckItemNotify {
1196 my ($notify_id,$notify_level,$itemnumber) = @_;
1197 my $dbh = C4::Context->dbh;
1198 my $sth = $dbh->prepare("
1202 AND notify_level = ?
1203 AND itemnumber = ? ");
1204 $sth->execute($notify_id,$notify_level,$itemnumber);
1205 my $notified = $sth->fetchrow;
1209 =head2 GetOverduesForBranch
1211 Sql request for display all information for branchoverdues.pl
1212 2 possibilities : with or without location .
1213 display is filtered by branch
1215 FIXME: This function should be renamed.
1219 sub GetOverduesForBranch {
1220 my ( $branch, $location) = @_;
1221 my $itype_link = (C4::Context->preference('item-level_itypes')) ? " items.itype " : " biblioitems.itemtype ";
1222 my $dbh = C4::Context->dbh;
1225 borrowers.borrowernumber,
1227 borrowers.firstname,
1232 biblio.biblionumber,
1236 branches.branchname,
1239 items.itemcallnumber,
1242 itemtypes.description,
1243 accountlines.notify_id,
1244 accountlines.notify_level,
1245 accountlines.amountoutstanding
1247 LEFT JOIN issues ON issues.itemnumber = accountlines.itemnumber
1248 AND issues.borrowernumber = accountlines.borrowernumber
1249 LEFT JOIN borrowers ON borrowers.borrowernumber = accountlines.borrowernumber
1250 LEFT JOIN items ON items.itemnumber = issues.itemnumber
1251 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1252 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1253 LEFT JOIN itemtypes ON itemtypes.itemtype = $itype_link
1254 LEFT JOIN branches ON branches.branchcode = issues.branchcode
1255 WHERE (accountlines.amountoutstanding != '0.000000')
1256 AND (accountlines.accounttype = 'FU' )
1257 AND (issues.branchcode = ? )
1258 AND (issues.date_due < NOW())
1264 $sth = $dbh->prepare("$select AND items.location = ? ORDER BY borrowers.surname, borrowers.firstname");
1265 $sth->execute($branch, $location);
1267 $sth = $dbh->prepare("$select ORDER BY borrowers.surname, borrowers.firstname");
1268 $sth->execute($branch);
1270 while ( my $data = $sth->fetchrow_hashref ) {
1271 #check if the document has already been notified
1272 my $countnotify = CheckItemNotify($data->{'notify_id'}, $data->{'notify_level'}, $data->{'itemnumber'});
1273 if ($countnotify eq '0') {
1274 $getoverdues[$i] = $data;
1278 return (@getoverdues);
1282 =head2 AddNotifyLine
1284 &AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
1286 Create a line into notify, if the method is phone, the notification_send_date is implemented to
1291 my ( $borrowernumber, $itemnumber, $overduelevel, $method, $notifyId ) = @_;
1292 my $dbh = C4::Context->dbh;
1293 if ( $method eq "phone" ) {
1294 my $sth = $dbh->prepare(
1295 "INSERT INTO notifys (borrowernumber,itemnumber,notify_date,notify_send_date,notify_level,method,notify_id)
1296 VALUES (?,?,now(),now(),?,?,?)"
1298 $sth->execute( $borrowernumber, $itemnumber, $overduelevel, $method,
1302 my $sth = $dbh->prepare(
1303 "INSERT INTO notifys (borrowernumber,itemnumber,notify_date,notify_level,method,notify_id)
1304 VALUES (?,?,now(),?,?,?)"
1306 $sth->execute( $borrowernumber, $itemnumber, $overduelevel, $method,
1312 =head2 RemoveNotifyLine
1314 &RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
1316 Cancel a notification
1320 sub RemoveNotifyLine {
1321 my ( $borrowernumber, $itemnumber, $notify_date ) = @_;
1322 my $dbh = C4::Context->dbh;
1323 my $sth = $dbh->prepare(
1324 "DELETE FROM notifys
1330 $sth->execute( $borrowernumber, $itemnumber, $notify_date );
1339 Koha Development Team <http://koha-community.org/>