C4/Overdues.pm

   1 package C4::Overdues;
   2
   3
   4 # Copyright 2000-2002 Katipo Communications
   5 # copyright 2010 BibLibre
   6 #
   7 # This file is part of Koha.
   8 #
   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.
  13 #
  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.
  18 #
  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>.
  21
  22 use strict;
  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;
  29 use Carp;
  30
  31 use C4::Circulation;
  32 use C4::Context;
  33 use C4::Accounts;
  34 use C4::Log; # logaction
  35 use C4::Debug;
  36 use Koha::DateUtils;
  37 use Koha::Account::Line;
  38 use Koha::Account::Lines;
  39
  40 use vars qw(@ISA @EXPORT);
  41
  42 BEGIN {
  43     require Exporter;
  44     @ISA = qw(Exporter);
  45
  46     # subs to rename (and maybe merge some...)
  47     push @EXPORT, qw(
  48       &CalcFine
  49       &Getoverdues
  50       &checkoverdues
  51       &NumberNotifyId
  52       &AmountNotify
  53       &UpdateFine
  54       &GetFine
  55       &get_chargeable_units
  56       &CheckItemNotify
  57       &GetOverduesForBranch
  58       &RemoveNotifyLine
  59       &AddNotifyLine
  60       &GetOverdueMessageTransportTypes
  61       &parse_overdues_letter
  62     );
  63
  64     # subs to remove
  65     push @EXPORT, qw(
  66       &BorType
  67     );
  68
  69     # check that an equivalent don't exist already before moving
  70
  71     # subs to move to Circulation.pm
  72     push @EXPORT, qw(
  73       &GetIssuesIteminfo
  74     );
  75
  76     # &GetIssuingRules - delete.
  77     # use C4::Circulation::GetIssuingRule instead.
  78
  79     # subs to move to Biblio.pm
  80     push @EXPORT, qw(
  81       &GetItems
  82     );
  83 }
  84
  85 =head1 NAME
  86
  87 C4::Circulation::Fines - Koha module dealing with fines
  88
  89 =head1 SYNOPSIS
  90
  91   use C4::Overdues;
  92
  93 =head1 DESCRIPTION
  94
  95 This module contains several functions for dealing with fines for
  96 overdue items. It is primarily used by the 'misc/fines2.pl' script.
  97
  98 =head1 FUNCTIONS
  99
 100 =head2 Getoverdues
 101
 102   $overdues = Getoverdues( { minimumdays => 1, maximumdays => 30 } );
 103
 104 Returns the list of all overdue books, with their itemtype.
 105
 106 C<$overdues> is a reference-to-array. Each element is a
 107 reference-to-hash whose keys are the fields of the issues table in the
 108 Koha database.
 109
 110 =cut
 111
 112 #'
 113 sub Getoverdues {
 114     my $params = shift;
 115     my $dbh = C4::Context->dbh;
 116     my $statement;
 117     if ( C4::Context->preference('item-level_itypes') ) {
 118         $statement = "
 119    SELECT issues.*, items.itype as itemtype, items.homebranch, items.barcode, items.itemlost, items.replacementprice
 120      FROM issues
 121 LEFT JOIN items       USING (itemnumber)
 122     WHERE date_due < NOW()
 123 ";
 124     } else {
 125         $statement = "
 126    SELECT issues.*, biblioitems.itemtype, items.itype, items.homebranch, items.barcode, items.itemlost, replacementprice
 127      FROM issues
 128 LEFT JOIN items       USING (itemnumber)
 129 LEFT JOIN biblioitems USING (biblioitemnumber)
 130     WHERE date_due < NOW()
 131 ";
 132     }
 133
 134     my @bind_parameters;
 135     if ( exists $params->{'minimumdays'} and exists $params->{'maximumdays'} ) {
 136         $statement .= ' AND TO_DAYS( NOW() )-TO_DAYS( date_due ) BETWEEN ? and ? ';
 137         push @bind_parameters, $params->{'minimumdays'}, $params->{'maximumdays'};
 138     } elsif ( exists $params->{'minimumdays'} ) {
 139         $statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) > ? ';
 140         push @bind_parameters, $params->{'minimumdays'};
 141     } elsif ( exists $params->{'maximumdays'} ) {
 142         $statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ? ';
 143         push @bind_parameters, $params->{'maximumdays'};
 144     }
 145     $statement .= 'ORDER BY borrowernumber';
 146     my $sth = $dbh->prepare( $statement );
 147     $sth->execute( @bind_parameters );
 148     return $sth->fetchall_arrayref({});
 149 }
 150
 151
 152 =head2 checkoverdues
 153
 154     ($count, $overdueitems) = checkoverdues($borrowernumber);
 155
 156 Returns a count and a list of overdueitems for a given borrowernumber
 157
 158 =cut
 159
 160 sub checkoverdues {
 161     my $borrowernumber = shift or return;
 162     # don't select biblioitems.marc or biblioitems.marcxml... too slow on large systems
 163     my $sth = C4::Context->dbh->prepare(
 164         "SELECT biblio.*, items.*, issues.*,
 165                 biblioitems.volume,
 166                 biblioitems.number,
 167                 biblioitems.itemtype,
 168                 biblioitems.isbn,
 169                 biblioitems.issn,
 170                 biblioitems.publicationyear,
 171                 biblioitems.publishercode,
 172                 biblioitems.volumedate,
 173                 biblioitems.volumedesc,
 174                 biblioitems.collectiontitle,
 175                 biblioitems.collectionissn,
 176                 biblioitems.collectionvolume,
 177                 biblioitems.editionstatement,
 178                 biblioitems.editionresponsibility,
 179                 biblioitems.illus,
 180                 biblioitems.pages,
 181                 biblioitems.notes,
 182                 biblioitems.size,
 183                 biblioitems.place,
 184                 biblioitems.lccn,
 185                 biblioitems.url,
 186                 biblioitems.cn_source,
 187                 biblioitems.cn_class,
 188                 biblioitems.cn_item,
 189                 biblioitems.cn_suffix,
 190                 biblioitems.cn_sort,
 191                 biblioitems.totalissues
 192          FROM issues
 193          LEFT JOIN items       ON issues.itemnumber      = items.itemnumber
 194          LEFT JOIN biblio      ON items.biblionumber     = biblio.biblionumber
 195          LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
 196             WHERE issues.borrowernumber  = ?
 197             AND   issues.date_due < NOW()"
 198     );
 199     # FIXME: SELECT * across 4 tables?  do we really need the marc AND marcxml blobs??
 200     $sth->execute($borrowernumber);
 201     my $results = $sth->fetchall_arrayref({});
 202     return ( scalar(@$results), $results);  # returning the count and the results is silly
 203 }
 204
 205 =head2 CalcFine
 206
 207     ($amount, $chargename,  $units_minus_grace, $chargeable_units) = &CalcFine($item,
 208                                   $categorycode, $branch,
 209                                   $start_dt, $end_dt );
 210
 211 Calculates the fine for a book.
 212
 213 The issuingrules table in the Koha database is a fine matrix, listing
 214 the penalties for each type of patron for each type of item and each branch (e.g., the
 215 standard fine for books might be $0.50, but $1.50 for DVDs, or staff
 216 members might get a longer grace period between the first and second
 217 reminders that a book is overdue).
 218
 219
 220 C<$item> is an item object (hashref).
 221
 222 C<$categorycode> is the category code (string) of the patron who currently has
 223 the book.
 224
 225 C<$branchcode> is the library (string) whose issuingrules govern this transaction.
 226
 227 C<$start_date> & C<$end_date> are DateTime objects
 228 defining the date range over which to determine the fine.
 229
 230 Fines scripts should just supply the date range over which to calculate the fine.
 231
 232 C<&CalcFine> returns four values:
 233
 234 C<$amount> is the fine owed by the patron (see above).
 235
 236 C<$chargename> is the chargename field from the applicable record in
 237 the categoryitem table, whatever that is.
 238
 239 C<$units_minus_grace> is the number of chargeable units minus the grace period
 240
 241 C<$chargeable_units> is the number of chargeable units (days between start and end dates, Calendar adjusted where needed,
 242 minus any applicable grace period, or hours)
 243
 244 FIXME: previously attempted to return C<$message> as a text message, either "First Notice", "Second Notice",
 245 or "Final Notice".  But CalcFine never defined any value.
 246
 247 =cut
 248
 249 sub CalcFine {
 250     my ( $item, $bortype, $branchcode, $due_dt, $end_date  ) = @_;
 251     my $start_date = $due_dt->clone();
 252     # get issuingrules (fines part will be used)
 253     my $itemtype = $item->{itemtype} || $item->{itype};
 254     my $data = C4::Circulation::GetIssuingRule($bortype, $itemtype, $branchcode);
 255     my $fine_unit = $data->{lengthunit};
 256     $fine_unit ||= 'days';
 257
 258     my $chargeable_units = get_chargeable_units($fine_unit, $start_date, $end_date, $branchcode);
 259     my $units_minus_grace = $chargeable_units - $data->{firstremind};
 260     my $amount = 0;
 261     if ( $data->{'chargeperiod'} && ( $units_minus_grace > 0 ) ) {
 262         my $units = C4::Context->preference('FinesIncludeGracePeriod') ? $chargeable_units : $units_minus_grace;
 263         my $charge_periods = $units / $data->{'chargeperiod'};
 264         # If chargeperiod_charge_at = 1, we charge a fine at the start of each charge period
 265         # if chargeperiod_charge_at = 0, we charge at the end of each charge period
 266         $charge_periods = $data->{'chargeperiod_charge_at'} == 1 ? ceil($charge_periods) : floor($charge_periods);
 267         $amount = $charge_periods * $data->{'fine'};
 268     } # else { # a zero (or null) chargeperiod or negative units_minus_grace value means no charge. }
 269
 270     $amount = $data->{overduefinescap} if $data->{overduefinescap} && $amount > $data->{overduefinescap};
 271     $amount = $item->{replacementprice} if ( $data->{cap_fine_to_replacement_price} && $item->{replacementprice} && $amount > $item->{replacementprice} );
 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.
 275 }
 276
 277
 278 =head2 get_chargeable_units
 279
 280     get_chargeable_units($unit, $start_date_ $end_date, $branchcode);
 281
 282 return integer value of units between C<$start_date> and C<$end_date>, factoring in holidays for C<$branchcode>.
 283
 284 C<$unit> is 'days' or 'hours' (default is 'days').
 285
 286 C<$start_date> and C<$end_date> are the two DateTimes to get the number of units between.
 287
 288 C<$branchcode> is the branch whose calendar to use for finding holidays.
 289
 290 =cut
 291
 292 sub get_chargeable_units {
 293     my ($unit, $date_due, $date_returned, $branchcode) = @_;
 294
 295     # If the due date is later than the return date
 296     return 0 unless ( $date_returned > $date_due );
 297
 298     my $charge_units = 0;
 299     my $charge_duration;
 300     if ($unit eq 'hours') {
 301         if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
 302             my $calendar = Koha::Calendar->new( branchcode => $branchcode );
 303             $charge_duration = $calendar->hours_between( $date_due, $date_returned );
 304         } else {
 305             $charge_duration = $date_returned->delta_ms( $date_due );
 306         }
 307         if($charge_duration->in_units('hours') == 0 && $charge_duration->in_units('seconds') > 0){
 308             return 1;
 309         }
 310         return $charge_duration->in_units('hours');
 311     }
 312     else { # days
 313         if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
 314             my $calendar = Koha::Calendar->new( branchcode => $branchcode );
 315             $charge_duration = $calendar->days_between( $date_due, $date_returned );
 316         } else {
 317             $charge_duration = $date_returned->delta_days( $date_due );
 318         }
 319         return $charge_duration->in_units('days');
 320     }
 321 }
 322
 323
 324 =head2 GetSpecialHolidays
 325
 326     &GetSpecialHolidays($date_dues,$itemnumber);
 327
 328 return number of special days  between date of the day and date due
 329
 330 C<$date_dues> is the envisaged date of book return.
 331
 332 C<$itemnumber> is the book's item number.
 333
 334 =cut
 335
 336 sub GetSpecialHolidays {
 337     my ( $date_dues, $itemnumber ) = @_;
 338
 339     # calcul the today date
 340     my $today = join "-", &Today();
 341
 342     # return the holdingbranch
 343     my $iteminfo = GetIssuesIteminfo($itemnumber);
 344
 345     # use sql request to find all date between date_due and today
 346     my $dbh = C4::Context->dbh;
 347     my $query =
 348       qq|SELECT DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') as date
 349 FROM `special_holidays`
 350 WHERE DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') >= ?
 351 AND   DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') <= ?
 352 AND branchcode=?
 353 |;
 354     my @result = GetWdayFromItemnumber($itemnumber);
 355     my @result_date;
 356     my $wday;
 357     my $dateinsec;
 358     my $sth = $dbh->prepare($query);
 359     $sth->execute( $date_dues, $today, $iteminfo->{'branchcode'} )
 360       ;    # FIXME: just use NOW() in SQL instead of passing in $today
 361
 362     while ( my $special_date = $sth->fetchrow_hashref ) {
 363         push( @result_date, $special_date );
 364     }
 365
 366     my $specialdaycount = scalar(@result_date);
 367
 368     for ( my $i = 0 ; $i < scalar(@result_date) ; $i++ ) {
 369         $dateinsec = UnixDate( $result_date[$i]->{'date'}, "%o" );
 370         ( undef, undef, undef, undef, undef, undef, $wday, undef, undef ) =
 371           localtime($dateinsec);
 372         for ( my $j = 0 ; $j < scalar(@result) ; $j++ ) {
 373             if ( $wday == ( $result[$j]->{'weekday'} ) ) {
 374                 $specialdaycount--;
 375             }
 376         }
 377     }
 378
 379     return $specialdaycount;
 380 }
 381
 382 =head2 GetRepeatableHolidays
 383
 384     &GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
 385
 386 return number of day closed between date of the day and date due
 387
 388 C<$date_dues> is the envisaged date of book return.
 389
 390 C<$itemnumber> is item number.
 391
 392 C<$difference> numbers of between day date of the day and date due
 393
 394 =cut
 395
 396 sub GetRepeatableHolidays {
 397     my ( $date_dues, $itemnumber, $difference ) = @_;
 398     my $dateinsec = UnixDate( $date_dues, "%o" );
 399     my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) =
 400       localtime($dateinsec);
 401     my @result = GetWdayFromItemnumber($itemnumber);
 402     my @dayclosedcount;
 403     my $j;
 404
 405     for ( my $i = 0 ; $i < scalar(@result) ; $i++ ) {
 406         my $k = $wday;
 407
 408         for ( $j = 0 ; $j < $difference ; $j++ ) {
 409             if ( $result[$i]->{'weekday'} == $k ) {
 410                 push( @dayclosedcount, $k );
 411             }
 412             $k++;
 413             ( $k = 0 ) if ( $k eq 7 );
 414         }
 415     }
 416     return scalar(@dayclosedcount);
 417 }
 418
 419
 420 =head2 GetWayFromItemnumber
 421
 422     &Getwdayfromitemnumber($itemnumber);
 423
 424 return the different week day from repeatable_holidays table
 425
 426 C<$itemnumber> is  item number.
 427
 428 =cut
 429
 430 sub GetWdayFromItemnumber {
 431     my ($itemnumber) = @_;
 432     my $iteminfo = GetIssuesIteminfo($itemnumber);
 433     my @result;
 434     my $query = qq|SELECT weekday
 435     FROM repeatable_holidays
 436     WHERE branchcode=?
 437 |;
 438     my $sth = C4::Context->dbh->prepare($query);
 439
 440     $sth->execute( $iteminfo->{'branchcode'} );
 441     while ( my $weekday = $sth->fetchrow_hashref ) {
 442         push( @result, $weekday );
 443     }
 444     return @result;
 445 }
 446
 447
 448 =head2 GetIssuesIteminfo
 449
 450     &GetIssuesIteminfo($itemnumber);
 451
 452 return all data from issues about item
 453
 454 C<$itemnumber> is  item number.
 455
 456 =cut
 457
 458 sub GetIssuesIteminfo {
 459     my ($itemnumber) = @_;
 460     my $dbh          = C4::Context->dbh;
 461     my $query        = qq|SELECT *
 462     FROM issues
 463     WHERE itemnumber=?
 464     |;
 465     my $sth = $dbh->prepare($query);
 466     $sth->execute($itemnumber);
 467     my ($issuesinfo) = $sth->fetchrow_hashref;
 468     return $issuesinfo;
 469 }
 470
 471
 472 =head2 UpdateFine
 473
 474     &UpdateFine({ issue_id => $issue_id, itemnumber => $itemnumber, borrwernumber => $borrowernumber, amount => $amount, type => $type, $due => $date_due });
 475
 476 (Note: the following is mostly conjecture and guesswork.)
 477
 478 Updates the fine owed on an overdue book.
 479
 480 C<$itemnumber> is the book's item number.
 481
 482 C<$borrowernumber> is the borrower number of the patron who currently
 483 has the book on loan.
 484
 485 C<$amount> is the current amount owed by the patron.
 486
 487 C<$type> will be used in the description of the fine.
 488
 489 C<$due> is the due date formatted to the currently specified date format
 490
 491 C<&UpdateFine> looks up the amount currently owed on the given item
 492 and sets it to C<$amount>, creating, if necessary, a new entry in the
 493 accountlines table of the Koha database.
 494
 495 =cut
 496
 497 #
 498 # Question: Why should the caller have to
 499 # specify both the item number and the borrower number? A book can't
 500 # be on loan to two different people, so the item number should be
 501 # sufficient.
 502 #
 503 # Possible Answer: You might update a fine for a damaged item, *after* it is returned.
 504 #
 505 sub UpdateFine {
 506     my ($params) = @_;
 507
 508     my $issue_id       = $params->{issue_id};
 509     my $itemnum        = $params->{itemnumber};
 510     my $borrowernumber = $params->{borrowernumber};
 511     my $amount         = $params->{amount};
 512     my $type           = $params->{type};
 513     my $due            = $params->{due};
 514
 515     $debug and warn "UpdateFine({ itemnumber => $itemnum, borrowernumber => $borrowernumber, type => $type, due => $due, issue_id => $issue_id})";
 516
 517     unless ( $issue_id ) {
 518         carp("No issue_id passed in!");
 519         return;
 520     }
 521
 522     my $dbh = C4::Context->dbh;
 523     # FIXME - What exactly is this query supposed to do? It looks up an
 524     # entry in accountlines that matches the given item and borrower
 525     # numbers, where the description contains $due, and where the
 526     # account type has one of several values, but what does this _mean_?
 527     # Does it look up existing fines for this item?
 528     # FIXME - What are these various account types? ("FU", "O", "F", "M")
 529     #   "L"   is LOST item
 530     #   "A"   is Account Management Fee
 531     #   "N"   is New Card
 532     #   "M"   is Sundry
 533     #   "O"   is Overdue ??
 534     #   "F"   is Fine ??
 535     #   "FU"  is Fine UPDATE??
 536     #   "Pay" is Payment
 537     #   "REF" is Cash Refund
 538     my $sth = $dbh->prepare(
 539         "SELECT * FROM accountlines
 540         WHERE borrowernumber=? AND
 541         (( accounttype IN ('O','F','M') AND amountoutstanding<>0 ) OR
 542            accounttype = 'FU' )"
 543     );
 544     $sth->execute( $borrowernumber );
 545     my $data;
 546     my $total_amount_other = 0.00;
 547     my $due_qr = qr/$due/;
 548     # Cycle through the fines and
 549     # - find line that relates to the requested $itemnum
 550     # - accumulate fines for other items
 551     # so we can update $itemnum fine taking in account fine caps
 552     while (my $rec = $sth->fetchrow_hashref) {
 553         if ( $rec->{issue_id} == $issue_id && $rec->{accounttype} eq 'FU' ) {
 554             if ($data) {
 555                 warn "Not a unique accountlines record for issue_id $issue_id";
 556                 #FIXME Should we still count this one in total_amount ??
 557             }
 558             else {
 559                 $data = $rec;
 560                 next;
 561             }
 562         }
 563         $total_amount_other += $rec->{'amountoutstanding'};
 564     }
 565
 566     if (my $maxfine = C4::Context->preference('MaxFine')) {
 567         if ($total_amount_other + $amount > $maxfine) {
 568             my $new_amount = $maxfine - $total_amount_other;
 569             return if $new_amount <= 0.00;
 570             warn "Reducing fine for item $itemnum borrower $borrowernumber from $amount to $new_amount - MaxFine reached";
 571             $amount = $new_amount;
 572         }
 573     }
 574
 575     if ( $data ) {
 576         # we're updating an existing fine.  Only modify if amount changed
 577         # Note that in the current implementation, you cannot pay against an accruing fine
 578         # (i.e. , of accounttype 'FU').  Doing so will break accrual.
 579         if ( $data->{'amount'} != $amount ) {
 580             my $accountline = Koha::Account::Lines->find( $data->{accountlines_id} );
 581             my $diff = $amount - $data->{'amount'};
 582
 583             #3341: diff could be positive or negative!
 584             my $out   = $data->{'amountoutstanding'} + $diff;
 585
 586             $accountline->set(
 587                 {
 588                     date          => dt_from_string(),
 589                     amount        => $amount,
 590                     amountoutstanding   => $out,
 591                     lastincrement => $diff,
 592                     accounttype   => 'FU',
 593                 }
 594             )->store();
 595         }
 596     } else {
 597         if ( $amount ) { # Don't add new fines with an amount of 0
 598             my $sth4 = $dbh->prepare(
 599                 "SELECT title FROM biblio LEFT JOIN items ON biblio.biblionumber=items.biblionumber WHERE items.itemnumber=?"
 600             );
 601             $sth4->execute($itemnum);
 602             my $title = $sth4->fetchrow;
 603
 604             my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
 605
 606             my $desc = ( $type ? "$type " : '' ) . "$title $due";    # FIXEDME, avoid whitespace prefix on empty $type
 607
 608             my $accountline = Koha::Account::Line->new(
 609                 {
 610                     borrowernumber    => $borrowernumber,
 611                     itemnumber        => $itemnum,
 612                     date              => dt_from_string(),
 613                     amount            => $amount,
 614                     description       => $desc,
 615                     accounttype       => 'FU',
 616                     amountoutstanding => $amount,
 617                     lastincrement     => $amount,
 618                     accountno         => $nextaccntno,
 619                     issue_id          => $issue_id,
 620                 }
 621             )->store();
 622         }
 623     }
 624     # logging action
 625     &logaction(
 626         "FINES",
 627         $type,
 628         $borrowernumber,
 629         "due=".$due."  amount=".$amount." itemnumber=".$itemnum
 630         ) if C4::Context->preference("FinesLog");
 631 }
 632
 633 =head2 BorType
 634
 635     $borrower = &BorType($borrowernumber);
 636
 637 Looks up a patron by borrower number.
 638
 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.
 643
 644 =cut
 645
 646 sub BorType {
 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=?"
 653     );
 654     $sth->execute($borrowernumber);
 655     return $sth->fetchrow_hashref;
 656 }
 657
 658 =head2 GetFine
 659
 660     $data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
 661
 662 return the total of fine
 663
 664 C<$itemnum> is item number
 665
 666 C<$borrowernumber> is the borrowernumber
 667
 668 =cut
 669
 670 sub GetFine {
 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=?|;
 676     my @query_param;
 677     push @query_param, $borrowernumber;
 678     if (defined $itemnum )
 679     {
 680         $query .= " AND itemnumber=?";
 681         push @query_param, $itemnum;
 682     }
 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};
 688     }
 689     return 0;
 690 }
 691
 692 =head2 NumberNotifyId
 693
 694     (@notify) = &NumberNotifyId($borrowernumber);
 695
 696 Returns amount for all file per borrowers
 697 C<@notify> array contains all file per borrowers
 698
 699 C<$notify_id> contains the file number for the borrower number nad item number
 700
 701 =cut
 702
 703 sub NumberNotifyId{
 704     my ($borrowernumber)=@_;
 705     my $dbh = C4::Context->dbh;
 706     my $query=qq|    SELECT distinct(notify_id)
 707             FROM accountlines
 708             WHERE borrowernumber=?|;
 709     my @notify;
 710     my $sth = $dbh->prepare($query);
 711     $sth->execute($borrowernumber);
 712     while ( my ($numberofnotify) = $sth->fetchrow ) {
 713         push( @notify, $numberofnotify );
 714     }
 715     return (@notify);
 716 }
 717
 718 =head2 AmountNotify
 719
 720     ($totalnotify) = &AmountNotify($notifyid);
 721
 722 Returns amount for all file per borrowers
 723 C<$notifyid> is the file number
 724
 725 C<$totalnotify> contains amount of a file
 726
 727 C<$notify_id> contains the file number for the borrower number and item number
 728
 729 =cut
 730
 731 sub AmountNotify{
 732     my ($notifyid,$borrowernumber)=@_;
 733     my $dbh = C4::Context->dbh;
 734     my $query=qq|    SELECT sum(amountoutstanding)
 735             FROM accountlines
 736             WHERE notify_id=? AND borrowernumber = ?|;
 737     my $sth=$dbh->prepare($query);
 738         $sth->execute($notifyid,$borrowernumber);
 739         my $totalnotify=$sth->fetchrow;
 740     $sth->finish;
 741     return ($totalnotify);
 742 }
 743
 744 =head2 GetItems
 745
 746     ($items) = &GetItems($itemnumber);
 747
 748 Returns the list of all delays from overduerules.
 749
 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,
 752
 753 C<$itemnumber> contains the borrower categorycode
 754
 755 =cut
 756
 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?
 761
 762 sub GetItems {
 763     my $itemnumber = shift or return;
 764     my $query = qq|SELECT *
 765              FROM items
 766               WHERE itemnumber=?|;
 767     my $sth = C4::Context->dbh->prepare($query);
 768     $sth->execute($itemnumber);
 769     my ($items) = $sth->fetchrow_hashref;
 770     return ($items);
 771 }
 772
 773 =head2 GetBranchcodesWithOverdueRules
 774
 775     my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
 776
 777 returns a list of branch codes for branches with overdue rules defined.
 778
 779 =cut
 780
 781 sub GetBranchcodesWithOverdueRules {
 782     my $dbh               = C4::Context->dbh;
 783     my $branchcodes = $dbh->selectcol_arrayref(q|
 784         SELECT DISTINCT(branchcode)
 785         FROM overduerules
 786         WHERE delay1 IS NOT NULL
 787         ORDER BY branchcode
 788     |);
 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;
 793     }
 794     return @$branchcodes;
 795 }
 796
 797 =head2 CheckItemNotify
 798
 799 Sql request to check if the document has alreday been notified
 800 this function is not exported, only used with GetOverduesForBranch
 801
 802 =cut
 803
 804 sub CheckItemNotify {
 805     my ($notify_id,$notify_level,$itemnumber) = @_;
 806     my $dbh = C4::Context->dbh;
 807     my $sth = $dbh->prepare("
 808     SELECT COUNT(*)
 809      FROM notifys
 810     WHERE notify_id    = ?
 811      AND  notify_level = ?
 812      AND  itemnumber   = ? ");
 813     $sth->execute($notify_id,$notify_level,$itemnumber);
 814     my $notified = $sth->fetchrow;
 815     return ($notified);
 816 }
 817
 818 =head2 GetOverduesForBranch
 819
 820 Sql request for display all information for branchoverdues.pl
 821 2 possibilities : with or without location .
 822 display is filtered by branch
 823
 824 FIXME: This function should be renamed.
 825
 826 =cut
 827
 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;
 832     my $select = "
 833     SELECT
 834             borrowers.cardnumber,
 835             borrowers.borrowernumber,
 836             borrowers.surname,
 837             borrowers.firstname,
 838             borrowers.phone,
 839             borrowers.email,
 840                biblio.title,
 841                biblio.author,
 842                biblio.biblionumber,
 843                issues.date_due,
 844                issues.returndate,
 845                issues.branchcode,
 846              branches.branchname,
 847                 items.barcode,
 848                 items.homebranch,
 849                 items.itemcallnumber,
 850                 items.location,
 851                 items.itemnumber,
 852             itemtypes.description,
 853          accountlines.notify_id,
 854          accountlines.notify_level,
 855          accountlines.amountoutstanding
 856     FROM  accountlines
 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())
 869     ";
 870     my @getoverdues;
 871     my $i = 0;
 872     my $sth;
 873     if ($location) {
 874         $sth = $dbh->prepare("$select AND items.location = ? ORDER BY borrowers.surname, borrowers.firstname");
 875         $sth->execute($branch, $location);
 876     } else {
 877         $sth = $dbh->prepare("$select ORDER BY borrowers.surname, borrowers.firstname");
 878         $sth->execute($branch);
 879     }
 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;
 885             $i++;
 886         }
 887     }
 888     return (@getoverdues);
 889 }
 890
 891
 892 =head2 AddNotifyLine
 893
 894     &AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
 895
 896 Create a line into notify, if the method is phone, the notification_send_date is implemented to
 897
 898 =cut
 899
 900 sub AddNotifyLine {
 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(),?,?,?)"
 907         );
 908         $sth->execute( $borrowernumber, $itemnumber, $overduelevel, $method,
 909             $notifyId );
 910     }
 911     else {
 912         my $sth = $dbh->prepare(
 913             "INSERT INTO notifys (borrowernumber,itemnumber,notify_date,notify_level,method,notify_id)
 914         VALUES (?,?,now(),?,?,?)"
 915         );
 916         $sth->execute( $borrowernumber, $itemnumber, $overduelevel, $method,
 917             $notifyId );
 918     }
 919     return 1;
 920 }
 921
 922 =head2 RemoveNotifyLine
 923
 924     &RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
 925
 926 Cancel a notification
 927
 928 =cut
 929
 930 sub RemoveNotifyLine {
 931     my ( $borrowernumber, $itemnumber, $notify_date ) = @_;
 932     my $dbh = C4::Context->dbh;
 933     my $sth = $dbh->prepare(
 934         "DELETE FROM notifys
 935             WHERE
 936             borrowernumber=?
 937             AND itemnumber=?
 938             AND notify_date=?"
 939     );
 940     $sth->execute( $borrowernumber, $itemnumber, $notify_date );
 941     return 1;
 942 }
 943
 944 =head2 GetOverdueMessageTransportTypes
 945
 946     my $message_transport_types = GetOverdueMessageTransportTypes( $branchcode, $categorycode, $letternumber);
 947
 948     return a arrayref with all message_transport_type for given branchcode, categorycode and letternumber(1,2 or 3)
 949
 950 =cut
 951
 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)
 959         WHERE branchcode = ?
 960           AND categorycode = ?
 961           AND letternumber = ?
 962     ");
 963     $sth->execute( $branchcode, $categorycode, $letternumber );
 964     my @mtts;
 965     while ( my $mtt = $sth->fetchrow ) {
 966         push @mtts, $mtt;
 967     }
 968
 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;
 973
 974     return \@mtts;
 975 }
 976
 977 =head2 parse_overdues_letter
 978
 979 parses the letter template, replacing the placeholders with data
 980 specific to this patron, biblio, or item for overdues
 981
 982 named parameters:
 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
 987
 988 returns the C<letter> hashref, with the content updated to reflect the
 989 substituted keys and values.
 990
 991 =cut
 992
 993 sub parse_overdues_letter {
 994     my $params = shift;
 995     foreach my $required (qw( letter_code borrowernumber )) {
 996         return unless ( exists $params->{$required} && $params->{$required} );
 997     }
 998
 999     my $substitute = $params->{'substitute'} || {};
1000     $substitute->{today} ||= output_pref( { dt => dt_from_string, dateonly => 1} );
1001
1002     my %tables = ( 'borrowers' => $params->{'borrowernumber'} );
1003     if ( my $p = $params->{'branchcode'} ) {
1004         $tables{'branches'} = $p;
1005     }
1006
1007     my $active_currency = Koha::Acquisition::Currencies->get_active;
1008
1009     my $currency_format;
1010     $currency_format = $active_currency->currency if defined($active_currency);
1011
1012     my @item_tables;
1013     if ( my $i = $params->{'items'} ) {
1014         my $item_format = '';
1015         foreach my $item (@$i) {
1016             my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
1017             if ( !$item_format and defined $params->{'letter'}->{'content'} ) {
1018                 $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
1019                 $item_format = $1;
1020             }
1021
1022             $item->{'fine'} = currency_format($currency_format, "$fine", FMT_SYMBOL);
1023             # if active currency isn't correct ISO code fallback to sprintf
1024             $item->{'fine'} = sprintf('%.2f', $fine) unless $item->{'fine'};
1025
1026             push @item_tables, {
1027                 'biblio' => $item->{'biblionumber'},
1028                 'biblioitems' => $item->{'biblionumber'},
1029                 'items' => $item,
1030                 'issues' => $item->{'itemnumber'},
1031             };
1032         }
1033     }
1034
1035     return C4::Letters::GetPreparedLetter (
1036         module => 'circulation',
1037         letter_code => $params->{'letter_code'},
1038         branchcode => $params->{'branchcode'},
1039         tables => \%tables,
1040         substitute => $substitute,
1041         repeat => { item => \@item_tables },
1042         message_transport_type => $params->{message_transport_type},
1043     );
1044 }
1045
1046 1;
1047 __END__
1048
1049 =head1 AUTHOR
1050
1051 Koha Development Team <http://koha-community.org/>
1052
1053 =cut