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
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # Koha is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 #use warnings; FIXME - Bug 2505
24 use Date::Calc qw/Today Date_to_Days/;
25 use Date::Manip qw/UnixDate/;
26 use List::MoreUtils qw( uniq );
27 use POSIX qw( floor ceil );
28 use Locale::Currency::Format 1.28;
34 use C4::Log; # logaction
36 use C4::Budgets qw(GetCurrency);
38 use Koha::Account::Line;
39 use Koha::Account::Lines;
41 use vars qw($VERSION @ISA @EXPORT);
44 # set the version for version checking
45 $VERSION = 3.07.00.049;
49 # subs to rename (and maybe merge some...)
63 &GetOverdueMessageTransportTypes
64 &parse_overdues_letter
72 # check that an equivalent don't exist already before moving
74 # subs to move to Circulation.pm
79 # &GetIssuingRules - delete.
80 # use C4::Circulation::GetIssuingRule instead.
82 # subs to move to Biblio.pm
90 C4::Circulation::Fines - Koha module dealing with fines
98 This module contains several functions for dealing with fines for
99 overdue items. It is primarily used by the 'misc/fines2.pl' script.
105 $overdues = Getoverdues( { minimumdays => 1, maximumdays => 30 } );
107 Returns the list of all overdue books, with their itemtype.
109 C<$overdues> is a reference-to-array. Each element is a
110 reference-to-hash whose keys are the fields of the issues table in the
118 my $dbh = C4::Context->dbh;
120 if ( C4::Context->preference('item-level_itypes') ) {
122 SELECT issues.*, items.itype as itemtype, items.homebranch, items.barcode, items.itemlost, items.replacementprice
124 LEFT JOIN items USING (itemnumber)
125 WHERE date_due < NOW()
129 SELECT issues.*, biblioitems.itemtype, items.itype, items.homebranch, items.barcode, items.itemlost, replacementprice
131 LEFT JOIN items USING (itemnumber)
132 LEFT JOIN biblioitems USING (biblioitemnumber)
133 WHERE date_due < NOW()
138 if ( exists $params->{'minimumdays'} and exists $params->{'maximumdays'} ) {
139 $statement .= ' AND TO_DAYS( NOW() )-TO_DAYS( date_due ) BETWEEN ? and ? ';
140 push @bind_parameters, $params->{'minimumdays'}, $params->{'maximumdays'};
141 } elsif ( exists $params->{'minimumdays'} ) {
142 $statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) > ? ';
143 push @bind_parameters, $params->{'minimumdays'};
144 } elsif ( exists $params->{'maximumdays'} ) {
145 $statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ? ';
146 push @bind_parameters, $params->{'maximumdays'};
148 $statement .= 'ORDER BY borrowernumber';
149 my $sth = $dbh->prepare( $statement );
150 $sth->execute( @bind_parameters );
151 return $sth->fetchall_arrayref({});
157 ($count, $overdueitems) = checkoverdues($borrowernumber);
159 Returns a count and a list of overdueitems for a given borrowernumber
164 my $borrowernumber = shift or return;
165 # don't select biblioitems.marc or biblioitems.marcxml... too slow on large systems
166 my $sth = C4::Context->dbh->prepare(
167 "SELECT biblio.*, items.*, issues.*,
170 biblioitems.itemtype,
173 biblioitems.publicationyear,
174 biblioitems.publishercode,
175 biblioitems.volumedate,
176 biblioitems.volumedesc,
177 biblioitems.collectiontitle,
178 biblioitems.collectionissn,
179 biblioitems.collectionvolume,
180 biblioitems.editionstatement,
181 biblioitems.editionresponsibility,
189 biblioitems.cn_source,
190 biblioitems.cn_class,
192 biblioitems.cn_suffix,
194 biblioitems.totalissues
196 LEFT JOIN items ON issues.itemnumber = items.itemnumber
197 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
198 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
199 WHERE issues.borrowernumber = ?
200 AND issues.date_due < NOW()"
202 # FIXME: SELECT * across 4 tables? do we really need the marc AND marcxml blobs??
203 $sth->execute($borrowernumber);
204 my $results = $sth->fetchall_arrayref({});
205 return ( scalar(@$results), $results); # returning the count and the results is silly
210 ($amount, $chargename, $units_minus_grace, $chargeable_units) = &CalcFine($item,
211 $categorycode, $branch,
212 $start_dt, $end_dt );
214 Calculates the fine for a book.
216 The issuingrules table in the Koha database is a fine matrix, listing
217 the penalties for each type of patron for each type of item and each branch (e.g., the
218 standard fine for books might be $0.50, but $1.50 for DVDs, or staff
219 members might get a longer grace period between the first and second
220 reminders that a book is overdue).
223 C<$item> is an item object (hashref).
225 C<$categorycode> is the category code (string) of the patron who currently has
228 C<$branchcode> is the library (string) whose issuingrules govern this transaction.
230 C<$start_date> & C<$end_date> are DateTime objects
231 defining the date range over which to determine the fine.
233 Fines scripts should just supply the date range over which to calculate the fine.
235 C<&CalcFine> returns four values:
237 C<$amount> is the fine owed by the patron (see above).
239 C<$chargename> is the chargename field from the applicable record in
240 the categoryitem table, whatever that is.
242 C<$units_minus_grace> is the number of chargeable units minus the grace period
244 C<$chargeable_units> 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: previously attempted to return C<$message> as a text message, either "First Notice", "Second Notice",
248 or "Final Notice". But CalcFine never defined any value.
253 my ( $item, $bortype, $branchcode, $due_dt, $end_date ) = @_;
254 my $start_date = $due_dt->clone();
255 # get issuingrules (fines part will be used)
256 my $itemtype = $item->{itemtype} || $item->{itype};
257 my $data = C4::Circulation::GetIssuingRule($bortype, $itemtype, $branchcode);
258 my $fine_unit = $data->{lengthunit};
259 $fine_unit ||= 'days';
261 my $chargeable_units = get_chargeable_units($fine_unit, $start_date, $end_date, $branchcode);
262 my $units_minus_grace = $chargeable_units - $data->{firstremind};
264 if ( $data->{'chargeperiod'} && ( $units_minus_grace > 0 ) ) {
265 my $units = C4::Context->preference('FinesIncludeGracePeriod') ? $chargeable_units : $units_minus_grace;
266 my $charge_periods = $units / $data->{'chargeperiod'};
267 # If chargeperiod_charge_at = 1, we charge a fine at the start of each charge period
268 # if chargeperiod_charge_at = 0, we charge at the end of each charge period
269 $charge_periods = $data->{'chargeperiod_charge_at'} == 1 ? ceil($charge_periods) : floor($charge_periods);
270 $amount = $charge_periods * $data->{'fine'};
271 } # else { # a zero (or null) chargeperiod or negative units_minus_grace value means no charge. }
273 $amount = $data->{overduefinescap} if $data->{overduefinescap} && $amount > $data->{overduefinescap};
274 $amount = $item->{replacementprice} if ( $data->{cap_fine_to_replacement_price} && $item->{replacementprice} && $amount > $item->{replacementprice} );
275 $debug and warn sprintf("CalcFine returning (%s, %s, %s, %s)", $amount, $data->{'chargename'}, $units_minus_grace, $chargeable_units);
276 return ($amount, $data->{'chargename'}, $units_minus_grace, $chargeable_units);
277 # FIXME: chargename is NEVER populated anywhere.
281 =head2 get_chargeable_units
283 get_chargeable_units($unit, $start_date_ $end_date, $branchcode);
285 return integer value of units between C<$start_date> and C<$end_date>, factoring in holidays for C<$branchcode>.
287 C<$unit> is 'days' or 'hours' (default is 'days').
289 C<$start_date> and C<$end_date> are the two DateTimes to get the number of units between.
291 C<$branchcode> is the branch whose calendar to use for finding holidays.
295 sub get_chargeable_units {
296 my ($unit, $date_due, $date_returned, $branchcode) = @_;
298 # If the due date is later than the return date
299 return 0 unless ( $date_returned > $date_due );
301 my $charge_units = 0;
303 if ($unit eq 'hours') {
304 if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
305 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
306 $charge_duration = $calendar->hours_between( $date_due, $date_returned );
308 $charge_duration = $date_returned->delta_ms( $date_due );
310 if($charge_duration->in_units('hours') == 0 && $charge_duration->in_units('seconds') > 0){
313 return $charge_duration->in_units('hours');
316 if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
317 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
318 $charge_duration = $calendar->days_between( $date_due, $date_returned );
320 $charge_duration = $date_returned->delta_days( $date_due );
322 return $charge_duration->in_units('days');
327 =head2 GetSpecialHolidays
329 &GetSpecialHolidays($date_dues,$itemnumber);
331 return number of special days between date of the day and date due
333 C<$date_dues> is the envisaged date of book return.
335 C<$itemnumber> is the book's item number.
339 sub GetSpecialHolidays {
340 my ( $date_dues, $itemnumber ) = @_;
342 # calcul the today date
343 my $today = join "-", &Today();
345 # return the holdingbranch
346 my $iteminfo = GetIssuesIteminfo($itemnumber);
348 # use sql request to find all date between date_due and today
349 my $dbh = C4::Context->dbh;
351 qq|SELECT DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') as date
352 FROM `special_holidays`
353 WHERE DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') >= ?
354 AND DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') <= ?
357 my @result = GetWdayFromItemnumber($itemnumber);
361 my $sth = $dbh->prepare($query);
362 $sth->execute( $date_dues, $today, $iteminfo->{'branchcode'} )
363 ; # FIXME: just use NOW() in SQL instead of passing in $today
365 while ( my $special_date = $sth->fetchrow_hashref ) {
366 push( @result_date, $special_date );
369 my $specialdaycount = scalar(@result_date);
371 for ( my $i = 0 ; $i < scalar(@result_date) ; $i++ ) {
372 $dateinsec = UnixDate( $result_date[$i]->{'date'}, "%o" );
373 ( undef, undef, undef, undef, undef, undef, $wday, undef, undef ) =
374 localtime($dateinsec);
375 for ( my $j = 0 ; $j < scalar(@result) ; $j++ ) {
376 if ( $wday == ( $result[$j]->{'weekday'} ) ) {
382 return $specialdaycount;
385 =head2 GetRepeatableHolidays
387 &GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
389 return number of day closed between date of the day and date due
391 C<$date_dues> is the envisaged date of book return.
393 C<$itemnumber> is item number.
395 C<$difference> numbers of between day date of the day and date due
399 sub GetRepeatableHolidays {
400 my ( $date_dues, $itemnumber, $difference ) = @_;
401 my $dateinsec = UnixDate( $date_dues, "%o" );
402 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) =
403 localtime($dateinsec);
404 my @result = GetWdayFromItemnumber($itemnumber);
408 for ( my $i = 0 ; $i < scalar(@result) ; $i++ ) {
411 for ( $j = 0 ; $j < $difference ; $j++ ) {
412 if ( $result[$i]->{'weekday'} == $k ) {
413 push( @dayclosedcount, $k );
416 ( $k = 0 ) if ( $k eq 7 );
419 return scalar(@dayclosedcount);
423 =head2 GetWayFromItemnumber
425 &Getwdayfromitemnumber($itemnumber);
427 return the different week day from repeatable_holidays table
429 C<$itemnumber> is item number.
433 sub GetWdayFromItemnumber {
434 my ($itemnumber) = @_;
435 my $iteminfo = GetIssuesIteminfo($itemnumber);
437 my $query = qq|SELECT weekday
438 FROM repeatable_holidays
441 my $sth = C4::Context->dbh->prepare($query);
443 $sth->execute( $iteminfo->{'branchcode'} );
444 while ( my $weekday = $sth->fetchrow_hashref ) {
445 push( @result, $weekday );
451 =head2 GetIssuesIteminfo
453 &GetIssuesIteminfo($itemnumber);
455 return all data from issues about item
457 C<$itemnumber> is item number.
461 sub GetIssuesIteminfo {
462 my ($itemnumber) = @_;
463 my $dbh = C4::Context->dbh;
464 my $query = qq|SELECT *
468 my $sth = $dbh->prepare($query);
469 $sth->execute($itemnumber);
470 my ($issuesinfo) = $sth->fetchrow_hashref;
477 &UpdateFine({ issue_id => $issue_id, itemnumber => $itemnumber, borrwernumber => $borrowernumber, amount => $amount, type => $type, $due => $date_due });
479 (Note: the following is mostly conjecture and guesswork.)
481 Updates the fine owed on an overdue book.
483 C<$itemnumber> is the book's item number.
485 C<$borrowernumber> is the borrower number of the patron who currently
486 has the book on loan.
488 C<$amount> is the current amount owed by the patron.
490 C<$type> will be used in the description of the fine.
492 C<$due> is the due date formatted to the currently specified date format
494 C<&UpdateFine> looks up the amount currently owed on the given item
495 and sets it to C<$amount>, creating, if necessary, a new entry in the
496 accountlines table of the Koha database.
501 # Question: Why should the caller have to
502 # specify both the item number and the borrower number? A book can't
503 # be on loan to two different people, so the item number should be
506 # Possible Answer: You might update a fine for a damaged item, *after* it is returned.
511 my $issue_id = $params->{issue_id};
512 my $itemnum = $params->{itemnumber};
513 my $borrowernumber = $params->{borrowernumber};
514 my $amount = $params->{amount};
515 my $type = $params->{type};
516 my $due = $params->{due};
518 $debug and warn "UpdateFine({ itemnumber => $itemnum, borrowernumber => $borrowernumber, type => $type, due => $due, issue_id => $issue_id})";
520 unless ( $issue_id ) {
521 carp("No issue_id passed in!");
525 my $dbh = C4::Context->dbh;
526 # FIXME - What exactly is this query supposed to do? It looks up an
527 # entry in accountlines that matches the given item and borrower
528 # numbers, where the description contains $due, and where the
529 # account type has one of several values, but what does this _mean_?
530 # Does it look up existing fines for this item?
531 # FIXME - What are these various account types? ("FU", "O", "F", "M")
533 # "A" is Account Management Fee
538 # "FU" is Fine UPDATE??
540 # "REF" is Cash Refund
541 my $sth = $dbh->prepare(
542 "SELECT * FROM accountlines
543 WHERE borrowernumber=?
544 AND accounttype IN ('FU','O','F','M')"
546 $sth->execute( $borrowernumber );
548 my $total_amount_other = 0.00;
549 my $due_qr = qr/$due/;
550 # Cycle through the fines and
551 # - find line that relates to the requested $itemnum
552 # - accumulate fines for other items
553 # so we can update $itemnum fine taking in account fine caps
554 while (my $rec = $sth->fetchrow_hashref) {
555 if ( $rec->{issue_id} == $issue_id ) {
557 warn "Not a unique accountlines record for issue_id $issue_id";
564 $total_amount_other += $rec->{'amountoutstanding'};
567 if (my $maxfine = C4::Context->preference('MaxFine')) {
568 if ($total_amount_other + $amount > $maxfine) {
569 my $new_amount = $maxfine - $total_amount_other;
570 return if $new_amount <= 0.00;
571 warn "Reducing fine for item $itemnum borrower $borrowernumber from $amount to $new_amount - MaxFine reached";
572 $amount = $new_amount;
577 # we're updating an existing fine. Only modify if amount changed
578 # Note that in the current implementation, you cannot pay against an accruing fine
579 # (i.e. , of accounttype 'FU'). Doing so will break accrual.
580 if ( $data->{'amount'} != $amount ) {
581 my $accountline = Koha::Account::Lines->find( $data->{accountlines_id} );
582 my $diff = $amount - $data->{'amount'};
584 #3341: diff could be positive or negative!
585 my $out = $data->{'amountoutstanding'} + $diff;
589 date => dt_from_string(),
592 lastincrement => $diff,
598 if ( $amount ) { # Don't add new fines with an amount of 0
599 my $sth4 = $dbh->prepare(
600 "SELECT title FROM biblio LEFT JOIN items ON biblio.biblionumber=items.biblionumber WHERE items.itemnumber=?"
602 $sth4->execute($itemnum);
603 my $title = $sth4->fetchrow;
605 my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
607 my $desc = ( $type ? "$type " : '' ) . "$title $due"; # FIXEDME, avoid whitespace prefix on empty $type
609 my $accountline = Koha::Account::Line->new(
611 borrowernumber => $borrowernumber,
612 itemnumber => $itemnum,
613 date => dt_from_string(),
615 description => $desc,
617 amountoutstanding => $amount,
618 lastincrement => $amount,
619 accountno => $nextaccntno,
629 "due=".$due." amount=".$amount." itemnumber=".$itemnum
630 ) if C4::Context->preference("FinesLog");
635 $borrower = &BorType($borrowernumber);
637 Looks up a patron by borrower number.
639 C<$borrower> is a reference-to-hash whose keys are all of the fields
640 from the borrowers and categories tables of the Koha database. Thus,
641 C<$borrower> contains all information about both the borrower and
642 category he or she belongs to.
647 my ($borrowernumber) = @_;
648 my $dbh = C4::Context->dbh;
649 my $sth = $dbh->prepare(
650 "SELECT * from borrowers
651 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
652 WHERE borrowernumber=?"
654 $sth->execute($borrowernumber);
655 return $sth->fetchrow_hashref;
660 $data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
662 return the total of fine
664 C<$itemnum> is item number
666 C<$borrowernumber> is the borrowernumber
671 my ( $itemnum, $borrowernumber ) = @_;
672 my $dbh = C4::Context->dbh();
673 my $query = q|SELECT sum(amountoutstanding) as fineamount FROM accountlines
674 where accounttype like 'F%'
675 AND amountoutstanding > 0 AND borrowernumber=?|;
677 push @query_param, $borrowernumber;
678 if (defined $itemnum )
680 $query .= " AND itemnumber=?";
681 push @query_param, $itemnum;
683 my $sth = $dbh->prepare($query);
684 $sth->execute( @query_param );
685 my $fine = $sth->fetchrow_hashref();
686 if ($fine->{fineamount}) {
687 return $fine->{fineamount};
692 =head2 NumberNotifyId
694 (@notify) = &NumberNotifyId($borrowernumber);
696 Returns amount for all file per borrowers
697 C<@notify> array contains all file per borrowers
699 C<$notify_id> contains the file number for the borrower number nad item number
704 my ($borrowernumber)=@_;
705 my $dbh = C4::Context->dbh;
706 my $query=qq| SELECT distinct(notify_id)
708 WHERE borrowernumber=?|;
710 my $sth = $dbh->prepare($query);
711 $sth->execute($borrowernumber);
712 while ( my ($numberofnotify) = $sth->fetchrow ) {
713 push( @notify, $numberofnotify );
720 ($totalnotify) = &AmountNotify($notifyid);
722 Returns amount for all file per borrowers
723 C<$notifyid> is the file number
725 C<$totalnotify> contains amount of a file
727 C<$notify_id> contains the file number for the borrower number and item number
732 my ($notifyid,$borrowernumber)=@_;
733 my $dbh = C4::Context->dbh;
734 my $query=qq| SELECT sum(amountoutstanding)
736 WHERE notify_id=? AND borrowernumber = ?|;
737 my $sth=$dbh->prepare($query);
738 $sth->execute($notifyid,$borrowernumber);
739 my $totalnotify=$sth->fetchrow;
741 return ($totalnotify);
746 ($items) = &GetItems($itemnumber);
748 Returns the list of all delays from overduerules.
750 C<$items> is a reference-to-hash whose keys are all of the fields
751 from the items tables of the Koha database. Thus,
753 C<$itemnumber> contains the borrower categorycode
757 # FIXME: This is a bad function to have here.
758 # Shouldn't it be in C4::Items?
759 # Shouldn't it be called GetItem since you only get 1 row?
760 # Shouldn't it be called GetItem since you give it only 1 itemnumber?
763 my $itemnumber = shift or return;
764 my $query = qq|SELECT *
767 my $sth = C4::Context->dbh->prepare($query);
768 $sth->execute($itemnumber);
769 my ($items) = $sth->fetchrow_hashref;
773 =head2 GetBranchcodesWithOverdueRules
775 my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
777 returns a list of branch codes for branches with overdue rules defined.
781 sub GetBranchcodesWithOverdueRules {
782 my $dbh = C4::Context->dbh;
783 my $branchcodes = $dbh->selectcol_arrayref(q|
784 SELECT DISTINCT(branchcode)
786 WHERE delay1 IS NOT NULL
789 if ( $branchcodes->[0] eq '' ) {
790 # If a default rule exists, all branches should be returned
791 my $availbranches = C4::Branch::GetBranches();
792 return keys %$availbranches;
794 return @$branchcodes;
797 =head2 CheckItemNotify
799 Sql request to check if the document has alreday been notified
800 this function is not exported, only used with GetOverduesForBranch
804 sub CheckItemNotify {
805 my ($notify_id,$notify_level,$itemnumber) = @_;
806 my $dbh = C4::Context->dbh;
807 my $sth = $dbh->prepare("
812 AND itemnumber = ? ");
813 $sth->execute($notify_id,$notify_level,$itemnumber);
814 my $notified = $sth->fetchrow;
818 =head2 GetOverduesForBranch
820 Sql request for display all information for branchoverdues.pl
821 2 possibilities : with or without location .
822 display is filtered by branch
824 FIXME: This function should be renamed.
828 sub GetOverduesForBranch {
829 my ( $branch, $location) = @_;
830 my $itype_link = (C4::Context->preference('item-level_itypes')) ? " items.itype " : " biblioitems.itemtype ";
831 my $dbh = C4::Context->dbh;
834 borrowers.cardnumber,
835 borrowers.borrowernumber,
849 items.itemcallnumber,
852 itemtypes.description,
853 accountlines.notify_id,
854 accountlines.notify_level,
855 accountlines.amountoutstanding
857 LEFT JOIN issues ON issues.itemnumber = accountlines.itemnumber
858 AND issues.borrowernumber = accountlines.borrowernumber
859 LEFT JOIN borrowers ON borrowers.borrowernumber = accountlines.borrowernumber
860 LEFT JOIN items ON items.itemnumber = issues.itemnumber
861 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
862 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
863 LEFT JOIN itemtypes ON itemtypes.itemtype = $itype_link
864 LEFT JOIN branches ON branches.branchcode = issues.branchcode
865 WHERE (accountlines.amountoutstanding != '0.000000')
866 AND (accountlines.accounttype = 'FU' )
867 AND (issues.branchcode = ? )
868 AND (issues.date_due < NOW())
874 $sth = $dbh->prepare("$select AND items.location = ? ORDER BY borrowers.surname, borrowers.firstname");
875 $sth->execute($branch, $location);
877 $sth = $dbh->prepare("$select ORDER BY borrowers.surname, borrowers.firstname");
878 $sth->execute($branch);
880 while ( my $data = $sth->fetchrow_hashref ) {
881 #check if the document has already been notified
882 my $countnotify = CheckItemNotify($data->{'notify_id'}, $data->{'notify_level'}, $data->{'itemnumber'});
883 if ($countnotify eq '0') {
884 $getoverdues[$i] = $data;
888 return (@getoverdues);
894 &AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
896 Create a line into notify, if the method is phone, the notification_send_date is implemented to
901 my ( $borrowernumber, $itemnumber, $overduelevel, $method, $notifyId ) = @_;
902 my $dbh = C4::Context->dbh;
903 if ( $method eq "phone" ) {
904 my $sth = $dbh->prepare(
905 "INSERT INTO notifys (borrowernumber,itemnumber,notify_date,notify_send_date,notify_level,method,notify_id)
906 VALUES (?,?,now(),now(),?,?,?)"
908 $sth->execute( $borrowernumber, $itemnumber, $overduelevel, $method,
912 my $sth = $dbh->prepare(
913 "INSERT INTO notifys (borrowernumber,itemnumber,notify_date,notify_level,method,notify_id)
914 VALUES (?,?,now(),?,?,?)"
916 $sth->execute( $borrowernumber, $itemnumber, $overduelevel, $method,
922 =head2 RemoveNotifyLine
924 &RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
926 Cancel a notification
930 sub RemoveNotifyLine {
931 my ( $borrowernumber, $itemnumber, $notify_date ) = @_;
932 my $dbh = C4::Context->dbh;
933 my $sth = $dbh->prepare(
940 $sth->execute( $borrowernumber, $itemnumber, $notify_date );
944 =head2 GetOverdueMessageTransportTypes
946 my $message_transport_types = GetOverdueMessageTransportTypes( $branchcode, $categorycode, $letternumber);
948 return a arrayref with all message_transport_type for given branchcode, categorycode and letternumber(1,2 or 3)
952 sub GetOverdueMessageTransportTypes {
953 my ( $branchcode, $categorycode, $letternumber ) = @_;
954 return unless $categorycode and $letternumber;
955 my $dbh = C4::Context->dbh;
956 my $sth = $dbh->prepare("
957 SELECT message_transport_type
958 FROM overduerules odr LEFT JOIN overduerules_transport_types ott USING (overduerules_id)
963 $sth->execute( $branchcode, $categorycode, $letternumber );
965 while ( my $mtt = $sth->fetchrow ) {
969 # Put 'print' in first if exists
970 # It avoid to sent a print notice with an email or sms template is no email or sms is defined
971 @mtts = uniq( 'print', @mtts )
972 if grep {/^print$/} @mtts;
977 =head2 parse_overdues_letter
979 parses the letter template, replacing the placeholders with data
980 specific to this patron, biblio, or item for overdues
983 letter - required hashref
984 borrowernumber - required integer
985 substitute - optional hashref of other key/value pairs that should
986 be substituted in the letter content
988 returns the C<letter> hashref, with the content updated to reflect the
989 substituted keys and values.
993 sub parse_overdues_letter {
995 foreach my $required (qw( letter_code borrowernumber )) {
996 return unless ( exists $params->{$required} && $params->{$required} );
999 my $substitute = $params->{'substitute'} || {};
1000 $substitute->{today} ||= output_pref( { dt => dt_from_string, dateonly => 1} );
1002 my %tables = ( 'borrowers' => $params->{'borrowernumber'} );
1003 if ( my $p = $params->{'branchcode'} ) {
1004 $tables{'branches'} = $p;
1007 my $currencies = GetCurrency();
1008 my $currency_format;
1009 $currency_format = $currencies->{currency} if defined($currencies);
1012 if ( my $i = $params->{'items'} ) {
1013 my $item_format = '';
1014 foreach my $item (@$i) {
1015 my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
1016 if ( !$item_format and defined $params->{'letter'}->{'content'} ) {
1017 $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
1021 $item->{'fine'} = currency_format($currency_format, "$fine", FMT_SYMBOL);
1022 # if active currency isn't correct ISO code fallback to sprintf
1023 $item->{'fine'} = sprintf('%.2f', $fine) unless $item->{'fine'};
1025 push @item_tables, {
1026 'biblio' => $item->{'biblionumber'},
1027 'biblioitems' => $item->{'biblionumber'},
1029 'issues' => $item->{'itemnumber'},
1034 return C4::Letters::GetPreparedLetter (
1035 module => 'circulation',
1036 letter_code => $params->{'letter_code'},
1037 branchcode => $params->{'branchcode'},
1039 substitute => $substitute,
1040 repeat => { item => \@item_tables },
1041 message_transport_type => $params->{message_transport_type},
1050 Koha Development Team <http://koha-community.org/>