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
37 use Koha::Account::Lines;
38 use Koha::Account::Offsets;
39 use Koha::IssuingRules;
42 use vars qw(@ISA @EXPORT);
48 # subs to rename (and maybe merge some...)
62 &GetOverdueMessageTransportTypes
63 &parse_overdues_letter
71 # check that an equivalent don't exist already before moving
73 # subs to move to Circulation.pm
78 # subs to move to Biblio.pm
86 C4::Circulation::Fines - Koha module dealing with fines
94 This module contains several functions for dealing with fines for
95 overdue items. It is primarily used by the 'misc/fines2.pl' script.
101 $overdues = Getoverdues( { minimumdays => 1, maximumdays => 30 } );
103 Returns the list of all overdue books, with their itemtype.
105 C<$overdues> is a reference-to-array. Each element is a
106 reference-to-hash whose keys are the fields of the issues table in the
114 my $dbh = C4::Context->dbh;
116 if ( C4::Context->preference('item-level_itypes') ) {
118 SELECT issues.*, items.itype as itemtype, items.homebranch, items.barcode, items.itemlost, items.replacementprice
120 LEFT JOIN items USING (itemnumber)
121 WHERE date_due < NOW()
125 SELECT issues.*, biblioitems.itemtype, items.itype, items.homebranch, items.barcode, items.itemlost, replacementprice
127 LEFT JOIN items USING (itemnumber)
128 LEFT JOIN biblioitems USING (biblioitemnumber)
129 WHERE date_due < NOW()
134 if ( exists $params->{'minimumdays'} and exists $params->{'maximumdays'} ) {
135 $statement .= ' AND TO_DAYS( NOW() )-TO_DAYS( date_due ) BETWEEN ? and ? ';
136 push @bind_parameters, $params->{'minimumdays'}, $params->{'maximumdays'};
137 } elsif ( exists $params->{'minimumdays'} ) {
138 $statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) > ? ';
139 push @bind_parameters, $params->{'minimumdays'};
140 } elsif ( exists $params->{'maximumdays'} ) {
141 $statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ? ';
142 push @bind_parameters, $params->{'maximumdays'};
144 $statement .= 'ORDER BY borrowernumber';
145 my $sth = $dbh->prepare( $statement );
146 $sth->execute( @bind_parameters );
147 return $sth->fetchall_arrayref({});
153 ($count, $overdueitems) = checkoverdues($borrowernumber);
155 Returns a count and a list of overdueitems for a given borrowernumber
160 my $borrowernumber = shift or return;
161 my $sth = C4::Context->dbh->prepare(
162 "SELECT biblio.*, items.*, issues.*,
165 biblioitems.itemtype,
168 biblioitems.publicationyear,
169 biblioitems.publishercode,
170 biblioitems.volumedate,
171 biblioitems.volumedesc,
172 biblioitems.collectiontitle,
173 biblioitems.collectionissn,
174 biblioitems.collectionvolume,
175 biblioitems.editionstatement,
176 biblioitems.editionresponsibility,
184 biblioitems.cn_source,
185 biblioitems.cn_class,
187 biblioitems.cn_suffix,
189 biblioitems.totalissues
191 LEFT JOIN items ON issues.itemnumber = items.itemnumber
192 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
193 LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
194 WHERE issues.borrowernumber = ?
195 AND issues.date_due < NOW()"
197 $sth->execute($borrowernumber);
198 my $results = $sth->fetchall_arrayref({});
199 return ( scalar(@$results), $results); # returning the count and the results is silly
204 ($amount, $chargename, $units_minus_grace, $chargeable_units) = &CalcFine($item,
205 $categorycode, $branch,
206 $start_dt, $end_dt );
208 Calculates the fine for a book.
210 The issuingrules table in the Koha database is a fine matrix, listing
211 the penalties for each type of patron for each type of item and each branch (e.g., the
212 standard fine for books might be $0.50, but $1.50 for DVDs, or staff
213 members might get a longer grace period between the first and second
214 reminders that a book is overdue).
217 C<$item> is an item object (hashref).
219 C<$categorycode> is the category code (string) of the patron who currently has
222 C<$branchcode> is the library (string) whose issuingrules govern this transaction.
224 C<$start_date> & C<$end_date> are DateTime objects
225 defining the date range over which to determine the fine.
227 Fines scripts should just supply the date range over which to calculate the fine.
229 C<&CalcFine> returns four values:
231 C<$amount> is the fine owed by the patron (see above).
233 C<$chargename> is the chargename field from the applicable record in
234 the categoryitem table, whatever that is.
236 C<$units_minus_grace> is the number of chargeable units minus the grace period
238 C<$chargeable_units> is the number of chargeable units (days between start and end dates, Calendar adjusted where needed,
239 minus any applicable grace period, or hours)
241 FIXME: previously attempted to return C<$message> as a text message, either "First Notice", "Second Notice",
242 or "Final Notice". But CalcFine never defined any value.
247 my ( $item, $bortype, $branchcode, $due_dt, $end_date ) = @_;
248 my $start_date = $due_dt->clone();
249 # get issuingrules (fines part will be used)
250 my $itemtype = $item->{itemtype} || $item->{itype};
251 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule({ categorycode => $bortype, itemtype => $itemtype, branchcode => $branchcode });
253 return unless $issuing_rule; # If not rule exist, there is no fine
255 my $fine_unit = $issuing_rule->lengthunit || 'days';
257 my $chargeable_units = get_chargeable_units($fine_unit, $start_date, $end_date, $branchcode);
258 my $units_minus_grace = $chargeable_units - $issuing_rule->firstremind;
260 if ( $issuing_rule->chargeperiod && ( $units_minus_grace > 0 ) ) {
261 my $units = C4::Context->preference('FinesIncludeGracePeriod') ? $chargeable_units : $units_minus_grace;
262 my $charge_periods = $units / $issuing_rule->chargeperiod;
263 # If chargeperiod_charge_at = 1, we charge a fine at the start of each charge period
264 # if chargeperiod_charge_at = 0, we charge at the end of each charge period
265 $charge_periods = $issuing_rule->chargeperiod_charge_at == 1 ? ceil($charge_periods) : floor($charge_periods);
266 $amount = $charge_periods * $issuing_rule->fine;
267 } # else { # a zero (or null) chargeperiod or negative units_minus_grace value means no charge. }
269 $amount = $issuing_rule->overduefinescap if $issuing_rule->overduefinescap && $amount > $issuing_rule->overduefinescap;
270 $amount = $item->{replacementprice} if ( $issuing_rule->cap_fine_to_replacement_price && $item->{replacementprice} && $amount > $item->{replacementprice} );
271 $debug and warn sprintf("CalcFine returning (%s, %s, %s, %s)", $amount, $issuing_rule->chargename, $units_minus_grace, $chargeable_units);
272 return ($amount, $issuing_rule->chargename, $units_minus_grace, $chargeable_units);
273 # FIXME: chargename is NEVER populated anywhere.
277 =head2 get_chargeable_units
279 get_chargeable_units($unit, $start_date_ $end_date, $branchcode);
281 return integer value of units between C<$start_date> and C<$end_date>, factoring in holidays for C<$branchcode>.
283 C<$unit> is 'days' or 'hours' (default is 'days').
285 C<$start_date> and C<$end_date> are the two DateTimes to get the number of units between.
287 C<$branchcode> is the branch whose calendar to use for finding holidays.
291 sub get_chargeable_units {
292 my ($unit, $date_due, $date_returned, $branchcode) = @_;
294 # If the due date is later than the return date
295 return 0 unless ( $date_returned > $date_due );
297 my $charge_units = 0;
299 if ($unit eq 'hours') {
300 if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
301 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
302 $charge_duration = $calendar->hours_between( $date_due, $date_returned );
304 $charge_duration = $date_returned->delta_ms( $date_due );
306 if($charge_duration->in_units('hours') == 0 && $charge_duration->in_units('seconds') > 0){
309 return $charge_duration->in_units('hours');
312 if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
313 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
314 $charge_duration = $calendar->days_between( $date_due, $date_returned );
316 $charge_duration = $date_returned->delta_days( $date_due );
318 return $charge_duration->in_units('days');
323 =head2 GetSpecialHolidays
325 &GetSpecialHolidays($date_dues,$itemnumber);
327 return number of special days between date of the day and date due
329 C<$date_dues> is the envisaged date of book return.
331 C<$itemnumber> is the book's item number.
335 sub GetSpecialHolidays {
336 my ( $date_dues, $itemnumber ) = @_;
338 # calcul the today date
339 my $today = join "-", &Today();
341 # return the holdingbranch
342 my $iteminfo = GetIssuesIteminfo($itemnumber);
344 # use sql request to find all date between date_due and today
345 my $dbh = C4::Context->dbh;
347 qq|SELECT DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') as date
348 FROM `special_holidays`
349 WHERE DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') >= ?
350 AND DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') <= ?
353 my @result = GetWdayFromItemnumber($itemnumber);
357 my $sth = $dbh->prepare($query);
358 $sth->execute( $date_dues, $today, $iteminfo->{'branchcode'} )
359 ; # FIXME: just use NOW() in SQL instead of passing in $today
361 while ( my $special_date = $sth->fetchrow_hashref ) {
362 push( @result_date, $special_date );
365 my $specialdaycount = scalar(@result_date);
367 for ( my $i = 0 ; $i < scalar(@result_date) ; $i++ ) {
368 $dateinsec = UnixDate( $result_date[$i]->{'date'}, "%o" );
369 ( undef, undef, undef, undef, undef, undef, $wday, undef, undef ) =
370 localtime($dateinsec);
371 for ( my $j = 0 ; $j < scalar(@result) ; $j++ ) {
372 if ( $wday == ( $result[$j]->{'weekday'} ) ) {
378 return $specialdaycount;
381 =head2 GetRepeatableHolidays
383 &GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
385 return number of day closed between date of the day and date due
387 C<$date_dues> is the envisaged date of book return.
389 C<$itemnumber> is item number.
391 C<$difference> numbers of between day date of the day and date due
395 sub GetRepeatableHolidays {
396 my ( $date_dues, $itemnumber, $difference ) = @_;
397 my $dateinsec = UnixDate( $date_dues, "%o" );
398 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) =
399 localtime($dateinsec);
400 my @result = GetWdayFromItemnumber($itemnumber);
404 for ( my $i = 0 ; $i < scalar(@result) ; $i++ ) {
407 for ( $j = 0 ; $j < $difference ; $j++ ) {
408 if ( $result[$i]->{'weekday'} == $k ) {
409 push( @dayclosedcount, $k );
412 ( $k = 0 ) if ( $k eq 7 );
415 return scalar(@dayclosedcount);
419 =head2 GetWayFromItemnumber
421 &Getwdayfromitemnumber($itemnumber);
423 return the different week day from repeatable_holidays table
425 C<$itemnumber> is item number.
429 sub GetWdayFromItemnumber {
430 my ($itemnumber) = @_;
431 my $iteminfo = GetIssuesIteminfo($itemnumber);
433 my $query = qq|SELECT weekday
434 FROM repeatable_holidays
437 my $sth = C4::Context->dbh->prepare($query);
439 $sth->execute( $iteminfo->{'branchcode'} );
440 while ( my $weekday = $sth->fetchrow_hashref ) {
441 push( @result, $weekday );
447 =head2 GetIssuesIteminfo
449 &GetIssuesIteminfo($itemnumber);
451 return all data from issues about item
453 C<$itemnumber> is item number.
457 sub GetIssuesIteminfo {
458 my ($itemnumber) = @_;
459 my $dbh = C4::Context->dbh;
460 my $query = qq|SELECT *
464 my $sth = $dbh->prepare($query);
465 $sth->execute($itemnumber);
466 my ($issuesinfo) = $sth->fetchrow_hashref;
473 &UpdateFine({ issue_id => $issue_id, itemnumber => $itemnumber, borrwernumber => $borrowernumber, amount => $amount, type => $type, $due => $date_due });
475 (Note: the following is mostly conjecture and guesswork.)
477 Updates the fine owed on an overdue book.
479 C<$itemnumber> is the book's item number.
481 C<$borrowernumber> is the borrower number of the patron who currently
482 has the book on loan.
484 C<$amount> is the current amount owed by the patron.
486 C<$type> will be used in the description of the fine.
488 C<$due> is the due date formatted to the currently specified date format
490 C<&UpdateFine> looks up the amount currently owed on the given item
491 and sets it to C<$amount>, creating, if necessary, a new entry in the
492 accountlines table of the Koha database.
497 # Question: Why should the caller have to
498 # specify both the item number and the borrower number? A book can't
499 # be on loan to two different people, so the item number should be
502 # Possible Answer: You might update a fine for a damaged item, *after* it is returned.
507 my $issue_id = $params->{issue_id};
508 my $itemnum = $params->{itemnumber};
509 my $borrowernumber = $params->{borrowernumber};
510 my $amount = $params->{amount};
511 my $type = $params->{type};
512 my $due = $params->{due};
514 $debug and warn "UpdateFine({ itemnumber => $itemnum, borrowernumber => $borrowernumber, type => $type, due => $due, issue_id => $issue_id})";
516 unless ( $issue_id ) {
517 carp("No issue_id passed in!");
521 my $dbh = C4::Context->dbh;
522 # FIXME - What exactly is this query supposed to do? It looks up an
523 # entry in accountlines that matches the given item and borrower
524 # numbers, where the description contains $due, and where the
525 # account type has one of several values, but what does this _mean_?
526 # Does it look up existing fines for this item?
527 # FIXME - What are these various account types? ("FU", "O", "F", "M")
529 # "A" is Account Management Fee
534 # "FU" is Fine UPDATE??
536 # "REF" is Cash Refund
537 my $sth = $dbh->prepare(
538 "SELECT * FROM accountlines
539 WHERE borrowernumber=? AND
540 (( accounttype IN ('O','F','M') AND amountoutstanding<>0 ) OR
541 accounttype = 'FU' )"
543 $sth->execute( $borrowernumber );
545 my $total_amount_other = 0.00;
546 my $due_qr = qr/$due/;
547 # Cycle through the fines and
548 # - find line that relates to the requested $itemnum
549 # - accumulate fines for other items
550 # so we can update $itemnum fine taking in account fine caps
551 while (my $rec = $sth->fetchrow_hashref) {
552 if ( $rec->{issue_id} == $issue_id && $rec->{accounttype} eq 'FU' ) {
554 warn "Not a unique accountlines record for issue_id $issue_id";
555 #FIXME Should we still count this one in total_amount ??
562 $total_amount_other += $rec->{'amountoutstanding'};
565 if (my $maxfine = C4::Context->preference('MaxFine')) {
566 if ($total_amount_other + $amount > $maxfine) {
567 my $new_amount = $maxfine - $total_amount_other;
568 return if $new_amount <= 0.00;
569 warn "Reducing fine for item $itemnum borrower $borrowernumber from $amount to $new_amount - MaxFine reached";
570 $amount = $new_amount;
575 # we're updating an existing fine. Only modify if amount changed
576 # Note that in the current implementation, you cannot pay against an accruing fine
577 # (i.e. , of accounttype 'FU'). Doing so will break accrual.
578 if ( $data->{'amount'} != $amount ) {
579 my $accountline = Koha::Account::Lines->find( $data->{accountlines_id} );
580 my $diff = $amount - $data->{'amount'};
582 #3341: diff could be positive or negative!
583 my $out = $data->{'amountoutstanding'} + $diff;
587 date => dt_from_string(),
589 amountoutstanding => $out,
590 lastincrement => $diff,
595 Koha::Account::Offset->new(
597 debit_id => $accountline->id,
598 type => 'Fine Update',
604 if ( $amount ) { # Don't add new fines with an amount of 0
605 my $sth4 = $dbh->prepare(
606 "SELECT title FROM biblio LEFT JOIN items ON biblio.biblionumber=items.biblionumber WHERE items.itemnumber=?"
608 $sth4->execute($itemnum);
609 my $title = $sth4->fetchrow;
611 my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
613 my $desc = ( $type ? "$type " : '' ) . "$title $due"; # FIXEDME, avoid whitespace prefix on empty $type
615 my $accountline = Koha::Account::Line->new(
617 borrowernumber => $borrowernumber,
618 itemnumber => $itemnum,
619 date => dt_from_string(),
621 description => $desc,
623 amountoutstanding => $amount,
624 lastincrement => $amount,
625 accountno => $nextaccntno,
626 issue_id => $issue_id,
630 Koha::Account::Offset->new(
632 debit_id => $accountline->id,
644 "due=".$due." amount=".$amount." itemnumber=".$itemnum
645 ) if C4::Context->preference("FinesLog");
650 $borrower = &BorType($borrowernumber);
652 Looks up a patron by borrower number.
654 C<$borrower> is a reference-to-hash whose keys are all of the fields
655 from the borrowers and categories tables of the Koha database. Thus,
656 C<$borrower> contains all information about both the borrower and
657 category they belong to.
662 my ($borrowernumber) = @_;
663 my $dbh = C4::Context->dbh;
664 my $sth = $dbh->prepare(
665 "SELECT * from borrowers
666 LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
667 WHERE borrowernumber=?"
669 $sth->execute($borrowernumber);
670 return $sth->fetchrow_hashref;
675 $data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
677 return the total of fine
679 C<$itemnum> is item number
681 C<$borrowernumber> is the borrowernumber
686 my ( $itemnum, $borrowernumber ) = @_;
687 my $dbh = C4::Context->dbh();
688 my $query = q|SELECT sum(amountoutstanding) as fineamount FROM accountlines
689 where accounttype like 'F%'
690 AND amountoutstanding > 0 AND borrowernumber=?|;
692 push @query_param, $borrowernumber;
693 if (defined $itemnum )
695 $query .= " AND itemnumber=?";
696 push @query_param, $itemnum;
698 my $sth = $dbh->prepare($query);
699 $sth->execute( @query_param );
700 my $fine = $sth->fetchrow_hashref();
701 if ($fine->{fineamount}) {
702 return $fine->{fineamount};
707 =head2 NumberNotifyId
709 (@notify) = &NumberNotifyId($borrowernumber);
711 Returns amount for all file per borrowers
712 C<@notify> array contains all file per borrowers
714 C<$notify_id> contains the file number for the borrower number nad item number
719 my ($borrowernumber)=@_;
720 my $dbh = C4::Context->dbh;
721 my $query=qq| SELECT distinct(notify_id)
723 WHERE borrowernumber=?|;
725 my $sth = $dbh->prepare($query);
726 $sth->execute($borrowernumber);
727 while ( my ($numberofnotify) = $sth->fetchrow ) {
728 push( @notify, $numberofnotify );
735 ($totalnotify) = &AmountNotify($notifyid);
737 Returns amount for all file per borrowers
738 C<$notifyid> is the file number
740 C<$totalnotify> contains amount of a file
742 C<$notify_id> contains the file number for the borrower number and item number
747 my ($notifyid,$borrowernumber)=@_;
748 my $dbh = C4::Context->dbh;
749 my $query=qq| SELECT sum(amountoutstanding)
751 WHERE notify_id=? AND borrowernumber = ?|;
752 my $sth=$dbh->prepare($query);
753 $sth->execute($notifyid,$borrowernumber);
754 my $totalnotify=$sth->fetchrow;
756 return ($totalnotify);
761 ($items) = &GetItems($itemnumber);
763 Returns the list of all delays from overduerules.
765 C<$items> is a reference-to-hash whose keys are all of the fields
766 from the items tables of the Koha database. Thus,
768 C<$itemnumber> contains the borrower categorycode
772 # FIXME: This is a bad function to have here.
773 # Shouldn't it be in C4::Items?
774 # Shouldn't it be called GetItem since you only get 1 row?
775 # Shouldn't it be called GetItem since you give it only 1 itemnumber?
778 my $itemnumber = shift or return;
779 my $query = qq|SELECT *
782 my $sth = C4::Context->dbh->prepare($query);
783 $sth->execute($itemnumber);
784 my ($items) = $sth->fetchrow_hashref;
788 =head2 GetBranchcodesWithOverdueRules
790 my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
792 returns a list of branch codes for branches with overdue rules defined.
796 sub GetBranchcodesWithOverdueRules {
797 my $dbh = C4::Context->dbh;
798 my $branchcodes = $dbh->selectcol_arrayref(q|
799 SELECT DISTINCT(branchcode)
801 WHERE delay1 IS NOT NULL
804 if ( $branchcodes->[0] eq '' ) {
805 # If a default rule exists, all branches should be returned
806 return map { $_->branchcode } Koha::Libraries->search({}, { order_by => 'branchname' });
808 return @$branchcodes;
811 =head2 CheckItemNotify
813 Sql request to check if the document has alreday been notified
814 this function is not exported, only used with GetOverduesForBranch
818 sub CheckItemNotify {
819 my ($notify_id,$notify_level,$itemnumber) = @_;
820 my $dbh = C4::Context->dbh;
821 my $sth = $dbh->prepare("
826 AND itemnumber = ? ");
827 $sth->execute($notify_id,$notify_level,$itemnumber);
828 my $notified = $sth->fetchrow;
832 =head2 GetOverduesForBranch
834 Sql request for display all information for branchoverdues.pl
835 2 possibilities : with or without location .
836 display is filtered by branch
838 FIXME: This function should be renamed.
842 sub GetOverduesForBranch {
843 my ( $branch, $location) = @_;
844 my $itype_link = (C4::Context->preference('item-level_itypes')) ? " items.itype " : " biblioitems.itemtype ";
845 my $dbh = C4::Context->dbh;
848 borrowers.cardnumber,
849 borrowers.borrowernumber,
863 items.itemcallnumber,
866 itemtypes.description,
867 accountlines.notify_id,
868 accountlines.notify_level,
869 accountlines.amountoutstanding
871 LEFT JOIN issues ON issues.itemnumber = accountlines.itemnumber
872 AND issues.borrowernumber = accountlines.borrowernumber
873 LEFT JOIN borrowers ON borrowers.borrowernumber = accountlines.borrowernumber
874 LEFT JOIN items ON items.itemnumber = issues.itemnumber
875 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
876 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
877 LEFT JOIN itemtypes ON itemtypes.itemtype = $itype_link
878 LEFT JOIN branches ON branches.branchcode = issues.branchcode
879 WHERE (accountlines.amountoutstanding != '0.000000')
880 AND (accountlines.accounttype = 'FU' )
881 AND (issues.branchcode = ? )
882 AND (issues.date_due < NOW())
888 $sth = $dbh->prepare("$select AND items.location = ? ORDER BY borrowers.surname, borrowers.firstname");
889 $sth->execute($branch, $location);
891 $sth = $dbh->prepare("$select ORDER BY borrowers.surname, borrowers.firstname");
892 $sth->execute($branch);
894 while ( my $data = $sth->fetchrow_hashref ) {
895 #check if the document has already been notified
896 my $countnotify = CheckItemNotify($data->{'notify_id'}, $data->{'notify_level'}, $data->{'itemnumber'});
897 if ($countnotify eq '0') {
898 $getoverdues[$i] = $data;
902 return (@getoverdues);
908 &AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
910 Create a line into notify, if the method is phone, the notification_send_date is implemented to
915 my ( $borrowernumber, $itemnumber, $overduelevel, $method, $notifyId ) = @_;
916 my $dbh = C4::Context->dbh;
917 if ( $method eq "phone" ) {
918 my $sth = $dbh->prepare(
919 "INSERT INTO notifys (borrowernumber,itemnumber,notify_date,notify_send_date,notify_level,method,notify_id)
920 VALUES (?,?,now(),now(),?,?,?)"
922 $sth->execute( $borrowernumber, $itemnumber, $overduelevel, $method,
926 my $sth = $dbh->prepare(
927 "INSERT INTO notifys (borrowernumber,itemnumber,notify_date,notify_level,method,notify_id)
928 VALUES (?,?,now(),?,?,?)"
930 $sth->execute( $borrowernumber, $itemnumber, $overduelevel, $method,
936 =head2 RemoveNotifyLine
938 &RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
940 Cancel a notification
944 sub RemoveNotifyLine {
945 my ( $borrowernumber, $itemnumber, $notify_date ) = @_;
946 my $dbh = C4::Context->dbh;
947 my $sth = $dbh->prepare(
954 $sth->execute( $borrowernumber, $itemnumber, $notify_date );
958 =head2 GetOverdueMessageTransportTypes
960 my $message_transport_types = GetOverdueMessageTransportTypes( $branchcode, $categorycode, $letternumber);
962 return a arrayref with all message_transport_type for given branchcode, categorycode and letternumber(1,2 or 3)
966 sub GetOverdueMessageTransportTypes {
967 my ( $branchcode, $categorycode, $letternumber ) = @_;
968 return unless $categorycode and $letternumber;
969 my $dbh = C4::Context->dbh;
970 my $sth = $dbh->prepare("
971 SELECT message_transport_type
972 FROM overduerules odr LEFT JOIN overduerules_transport_types ott USING (overduerules_id)
977 $sth->execute( $branchcode, $categorycode, $letternumber );
979 while ( my $mtt = $sth->fetchrow ) {
983 # Put 'print' in first if exists
984 # It avoid to sent a print notice with an email or sms template is no email or sms is defined
985 @mtts = uniq( 'print', @mtts )
986 if grep {/^print$/} @mtts;
991 =head2 parse_overdues_letter
993 parses the letter template, replacing the placeholders with data
994 specific to this patron, biblio, or item for overdues
997 letter - required hashref
998 borrowernumber - required integer
999 substitute - optional hashref of other key/value pairs that should
1000 be substituted in the letter content
1002 returns the C<letter> hashref, with the content updated to reflect the
1003 substituted keys and values.
1007 sub parse_overdues_letter {
1009 foreach my $required (qw( letter_code borrowernumber )) {
1010 return unless ( exists $params->{$required} && $params->{$required} );
1013 my $patron = Koha::Patrons->find( $params->{borrowernumber} );
1015 my $substitute = $params->{'substitute'} || {};
1017 my %tables = ( 'borrowers' => $params->{'borrowernumber'} );
1018 if ( my $p = $params->{'branchcode'} ) {
1019 $tables{'branches'} = $p;
1022 my $active_currency = Koha::Acquisition::Currencies->get_active;
1024 my $currency_format;
1025 $currency_format = $active_currency->currency if defined($active_currency);
1028 if ( my $i = $params->{'items'} ) {
1029 foreach my $item (@$i) {
1030 my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
1031 $item->{'fine'} = currency_format($currency_format, "$fine", FMT_SYMBOL);
1032 # if active currency isn't correct ISO code fallback to sprintf
1033 $item->{'fine'} = sprintf('%.2f', $fine) unless $item->{'fine'};
1035 push @item_tables, {
1036 'biblio' => $item->{'biblionumber'},
1037 'biblioitems' => $item->{'biblionumber'},
1039 'issues' => $item->{'itemnumber'},
1044 return C4::Letters::GetPreparedLetter (
1045 module => 'circulation',
1046 letter_code => $params->{'letter_code'},
1047 branchcode => $params->{'branchcode'},
1048 lang => $patron->lang,
1051 overdues => [ map { $_->{items}->{itemnumber} } @item_tables ],
1053 substitute => $substitute,
1054 repeat => { item => \@item_tables },
1055 message_transport_type => $params->{message_transport_type},
1064 Koha Development Team <http://koha-community.org/>