Kyle M Hall
a588b3b996
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
1066 lines
33 KiB
Perl
1066 lines
33 KiB
Perl
package C4::Overdues;
|
|
|
|
|
|
# Copyright 2000-2002 Katipo Communications
|
|
# copyright 2010 BibLibre
|
|
#
|
|
# This file is part of Koha.
|
|
#
|
|
# Koha is free software; you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Koha is distributed in the hope that it will be useful, but
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Koha; if not, see <http://www.gnu.org/licenses>.
|
|
|
|
use strict;
|
|
#use warnings; FIXME - Bug 2505
|
|
use Date::Calc qw/Today Date_to_Days/;
|
|
use Date::Manip qw/UnixDate/;
|
|
use List::MoreUtils qw( uniq );
|
|
use POSIX qw( floor ceil );
|
|
use Locale::Currency::Format 1.28;
|
|
use Carp;
|
|
|
|
use C4::Circulation;
|
|
use C4::Context;
|
|
use C4::Accounts;
|
|
use C4::Log; # logaction
|
|
use C4::Debug;
|
|
use Koha::DateUtils;
|
|
use Koha::Account::Lines;
|
|
use Koha::Account::Offsets;
|
|
use Koha::IssuingRules;
|
|
use Koha::Libraries;
|
|
|
|
use vars qw(@ISA @EXPORT);
|
|
|
|
BEGIN {
|
|
require Exporter;
|
|
@ISA = qw(Exporter);
|
|
|
|
# subs to rename (and maybe merge some...)
|
|
push @EXPORT, qw(
|
|
&CalcFine
|
|
&Getoverdues
|
|
&checkoverdues
|
|
&NumberNotifyId
|
|
&AmountNotify
|
|
&UpdateFine
|
|
&GetFine
|
|
&get_chargeable_units
|
|
&CheckItemNotify
|
|
&GetOverduesForBranch
|
|
&RemoveNotifyLine
|
|
&AddNotifyLine
|
|
&GetOverdueMessageTransportTypes
|
|
&parse_overdues_letter
|
|
);
|
|
|
|
# subs to remove
|
|
push @EXPORT, qw(
|
|
&BorType
|
|
);
|
|
|
|
# check that an equivalent don't exist already before moving
|
|
|
|
# subs to move to Circulation.pm
|
|
push @EXPORT, qw(
|
|
&GetIssuesIteminfo
|
|
);
|
|
|
|
# subs to move to Biblio.pm
|
|
push @EXPORT, qw(
|
|
&GetItems
|
|
);
|
|
}
|
|
|
|
=head1 NAME
|
|
|
|
C4::Circulation::Fines - Koha module dealing with fines
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use C4::Overdues;
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This module contains several functions for dealing with fines for
|
|
overdue items. It is primarily used by the 'misc/fines2.pl' script.
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
=head2 Getoverdues
|
|
|
|
$overdues = Getoverdues( { minimumdays => 1, maximumdays => 30 } );
|
|
|
|
Returns the list of all overdue books, with their itemtype.
|
|
|
|
C<$overdues> is a reference-to-array. Each element is a
|
|
reference-to-hash whose keys are the fields of the issues table in the
|
|
Koha database.
|
|
|
|
=cut
|
|
|
|
#'
|
|
sub Getoverdues {
|
|
my $params = shift;
|
|
my $dbh = C4::Context->dbh;
|
|
my $statement;
|
|
if ( C4::Context->preference('item-level_itypes') ) {
|
|
$statement = "
|
|
SELECT issues.*, items.itype as itemtype, items.homebranch, items.barcode, items.itemlost, items.replacementprice
|
|
FROM issues
|
|
LEFT JOIN items USING (itemnumber)
|
|
WHERE date_due < NOW()
|
|
";
|
|
} else {
|
|
$statement = "
|
|
SELECT issues.*, biblioitems.itemtype, items.itype, items.homebranch, items.barcode, items.itemlost, replacementprice
|
|
FROM issues
|
|
LEFT JOIN items USING (itemnumber)
|
|
LEFT JOIN biblioitems USING (biblioitemnumber)
|
|
WHERE date_due < NOW()
|
|
";
|
|
}
|
|
|
|
my @bind_parameters;
|
|
if ( exists $params->{'minimumdays'} and exists $params->{'maximumdays'} ) {
|
|
$statement .= ' AND TO_DAYS( NOW() )-TO_DAYS( date_due ) BETWEEN ? and ? ';
|
|
push @bind_parameters, $params->{'minimumdays'}, $params->{'maximumdays'};
|
|
} elsif ( exists $params->{'minimumdays'} ) {
|
|
$statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) > ? ';
|
|
push @bind_parameters, $params->{'minimumdays'};
|
|
} elsif ( exists $params->{'maximumdays'} ) {
|
|
$statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ? ';
|
|
push @bind_parameters, $params->{'maximumdays'};
|
|
}
|
|
$statement .= 'ORDER BY borrowernumber';
|
|
my $sth = $dbh->prepare( $statement );
|
|
$sth->execute( @bind_parameters );
|
|
return $sth->fetchall_arrayref({});
|
|
}
|
|
|
|
|
|
=head2 checkoverdues
|
|
|
|
($count, $overdueitems) = checkoverdues($borrowernumber);
|
|
|
|
Returns a count and a list of overdueitems for a given borrowernumber
|
|
|
|
=cut
|
|
|
|
sub checkoverdues {
|
|
my $borrowernumber = shift or return;
|
|
my $sth = C4::Context->dbh->prepare(
|
|
"SELECT biblio.*, items.*, issues.*,
|
|
biblioitems.volume,
|
|
biblioitems.number,
|
|
biblioitems.itemtype,
|
|
biblioitems.isbn,
|
|
biblioitems.issn,
|
|
biblioitems.publicationyear,
|
|
biblioitems.publishercode,
|
|
biblioitems.volumedate,
|
|
biblioitems.volumedesc,
|
|
biblioitems.collectiontitle,
|
|
biblioitems.collectionissn,
|
|
biblioitems.collectionvolume,
|
|
biblioitems.editionstatement,
|
|
biblioitems.editionresponsibility,
|
|
biblioitems.illus,
|
|
biblioitems.pages,
|
|
biblioitems.notes,
|
|
biblioitems.size,
|
|
biblioitems.place,
|
|
biblioitems.lccn,
|
|
biblioitems.url,
|
|
biblioitems.cn_source,
|
|
biblioitems.cn_class,
|
|
biblioitems.cn_item,
|
|
biblioitems.cn_suffix,
|
|
biblioitems.cn_sort,
|
|
biblioitems.totalissues
|
|
FROM issues
|
|
LEFT JOIN items ON issues.itemnumber = items.itemnumber
|
|
LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
|
|
LEFT JOIN biblioitems ON items.biblioitemnumber = biblioitems.biblioitemnumber
|
|
WHERE issues.borrowernumber = ?
|
|
AND issues.date_due < NOW()"
|
|
);
|
|
$sth->execute($borrowernumber);
|
|
my $results = $sth->fetchall_arrayref({});
|
|
return ( scalar(@$results), $results); # returning the count and the results is silly
|
|
}
|
|
|
|
=head2 CalcFine
|
|
|
|
($amount, $chargename, $units_minus_grace, $chargeable_units) = &CalcFine($item,
|
|
$categorycode, $branch,
|
|
$start_dt, $end_dt );
|
|
|
|
Calculates the fine for a book.
|
|
|
|
The issuingrules table in the Koha database is a fine matrix, listing
|
|
the penalties for each type of patron for each type of item and each branch (e.g., the
|
|
standard fine for books might be $0.50, but $1.50 for DVDs, or staff
|
|
members might get a longer grace period between the first and second
|
|
reminders that a book is overdue).
|
|
|
|
|
|
C<$item> is an item object (hashref).
|
|
|
|
C<$categorycode> is the category code (string) of the patron who currently has
|
|
the book.
|
|
|
|
C<$branchcode> is the library (string) whose issuingrules govern this transaction.
|
|
|
|
C<$start_date> & C<$end_date> are DateTime objects
|
|
defining the date range over which to determine the fine.
|
|
|
|
Fines scripts should just supply the date range over which to calculate the fine.
|
|
|
|
C<&CalcFine> returns four values:
|
|
|
|
C<$amount> is the fine owed by the patron (see above).
|
|
|
|
C<$chargename> is the chargename field from the applicable record in
|
|
the categoryitem table, whatever that is.
|
|
|
|
C<$units_minus_grace> is the number of chargeable units minus the grace period
|
|
|
|
C<$chargeable_units> is the number of chargeable units (days between start and end dates, Calendar adjusted where needed,
|
|
minus any applicable grace period, or hours)
|
|
|
|
FIXME: previously attempted to return C<$message> as a text message, either "First Notice", "Second Notice",
|
|
or "Final Notice". But CalcFine never defined any value.
|
|
|
|
=cut
|
|
|
|
sub CalcFine {
|
|
my ( $item, $bortype, $branchcode, $due_dt, $end_date ) = @_;
|
|
my $start_date = $due_dt->clone();
|
|
# get issuingrules (fines part will be used)
|
|
my $itemtype = $item->{itemtype} || $item->{itype};
|
|
my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule({ categorycode => $bortype, itemtype => $itemtype, branchcode => $branchcode });
|
|
|
|
return unless $issuing_rule; # If not rule exist, there is no fine
|
|
|
|
my $fine_unit = $issuing_rule->lengthunit || 'days';
|
|
|
|
my $chargeable_units = get_chargeable_units($fine_unit, $start_date, $end_date, $branchcode);
|
|
my $units_minus_grace = $chargeable_units - $issuing_rule->firstremind;
|
|
my $amount = 0;
|
|
if ( $issuing_rule->chargeperiod && ( $units_minus_grace > 0 ) ) {
|
|
my $units = C4::Context->preference('FinesIncludeGracePeriod') ? $chargeable_units : $units_minus_grace;
|
|
my $charge_periods = $units / $issuing_rule->chargeperiod;
|
|
# If chargeperiod_charge_at = 1, we charge a fine at the start of each charge period
|
|
# if chargeperiod_charge_at = 0, we charge at the end of each charge period
|
|
$charge_periods = $issuing_rule->chargeperiod_charge_at == 1 ? ceil($charge_periods) : floor($charge_periods);
|
|
$amount = $charge_periods * $issuing_rule->fine;
|
|
} # else { # a zero (or null) chargeperiod or negative units_minus_grace value means no charge. }
|
|
|
|
$amount = $issuing_rule->overduefinescap if $issuing_rule->overduefinescap && $amount > $issuing_rule->overduefinescap;
|
|
$amount = $item->{replacementprice} if ( $issuing_rule->cap_fine_to_replacement_price && $item->{replacementprice} && $amount > $item->{replacementprice} );
|
|
$debug and warn sprintf("CalcFine returning (%s, %s, %s, %s)", $amount, $issuing_rule->chargename, $units_minus_grace, $chargeable_units);
|
|
return ($amount, $issuing_rule->chargename, $units_minus_grace, $chargeable_units);
|
|
# FIXME: chargename is NEVER populated anywhere.
|
|
}
|
|
|
|
|
|
=head2 get_chargeable_units
|
|
|
|
get_chargeable_units($unit, $start_date_ $end_date, $branchcode);
|
|
|
|
return integer value of units between C<$start_date> and C<$end_date>, factoring in holidays for C<$branchcode>.
|
|
|
|
C<$unit> is 'days' or 'hours' (default is 'days').
|
|
|
|
C<$start_date> and C<$end_date> are the two DateTimes to get the number of units between.
|
|
|
|
C<$branchcode> is the branch whose calendar to use for finding holidays.
|
|
|
|
=cut
|
|
|
|
sub get_chargeable_units {
|
|
my ($unit, $date_due, $date_returned, $branchcode) = @_;
|
|
|
|
# If the due date is later than the return date
|
|
return 0 unless ( $date_returned > $date_due );
|
|
|
|
my $charge_units = 0;
|
|
my $charge_duration;
|
|
if ($unit eq 'hours') {
|
|
if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
|
|
my $calendar = Koha::Calendar->new( branchcode => $branchcode );
|
|
$charge_duration = $calendar->hours_between( $date_due, $date_returned );
|
|
} else {
|
|
$charge_duration = $date_returned->delta_ms( $date_due );
|
|
}
|
|
if($charge_duration->in_units('hours') == 0 && $charge_duration->in_units('seconds') > 0){
|
|
return 1;
|
|
}
|
|
return $charge_duration->in_units('hours');
|
|
}
|
|
else { # days
|
|
if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
|
|
my $calendar = Koha::Calendar->new( branchcode => $branchcode );
|
|
$charge_duration = $calendar->days_between( $date_due, $date_returned );
|
|
} else {
|
|
$charge_duration = $date_returned->delta_days( $date_due );
|
|
}
|
|
return $charge_duration->in_units('days');
|
|
}
|
|
}
|
|
|
|
|
|
=head2 GetSpecialHolidays
|
|
|
|
&GetSpecialHolidays($date_dues,$itemnumber);
|
|
|
|
return number of special days between date of the day and date due
|
|
|
|
C<$date_dues> is the envisaged date of book return.
|
|
|
|
C<$itemnumber> is the book's item number.
|
|
|
|
=cut
|
|
|
|
sub GetSpecialHolidays {
|
|
my ( $date_dues, $itemnumber ) = @_;
|
|
|
|
# calcul the today date
|
|
my $today = join "-", &Today();
|
|
|
|
# return the holdingbranch
|
|
my $iteminfo = GetIssuesIteminfo($itemnumber);
|
|
|
|
# use sql request to find all date between date_due and today
|
|
my $dbh = C4::Context->dbh;
|
|
my $query =
|
|
qq|SELECT DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') as date
|
|
FROM `special_holidays`
|
|
WHERE DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') >= ?
|
|
AND DATE_FORMAT(concat(year,'-',month,'-',day),'%Y-%m-%d') <= ?
|
|
AND branchcode=?
|
|
|;
|
|
my @result = GetWdayFromItemnumber($itemnumber);
|
|
my @result_date;
|
|
my $wday;
|
|
my $dateinsec;
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute( $date_dues, $today, $iteminfo->{'branchcode'} )
|
|
; # FIXME: just use NOW() in SQL instead of passing in $today
|
|
|
|
while ( my $special_date = $sth->fetchrow_hashref ) {
|
|
push( @result_date, $special_date );
|
|
}
|
|
|
|
my $specialdaycount = scalar(@result_date);
|
|
|
|
for ( my $i = 0 ; $i < scalar(@result_date) ; $i++ ) {
|
|
$dateinsec = UnixDate( $result_date[$i]->{'date'}, "%o" );
|
|
( undef, undef, undef, undef, undef, undef, $wday, undef, undef ) =
|
|
localtime($dateinsec);
|
|
for ( my $j = 0 ; $j < scalar(@result) ; $j++ ) {
|
|
if ( $wday == ( $result[$j]->{'weekday'} ) ) {
|
|
$specialdaycount--;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $specialdaycount;
|
|
}
|
|
|
|
=head2 GetRepeatableHolidays
|
|
|
|
&GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
|
|
|
|
return number of day closed between date of the day and date due
|
|
|
|
C<$date_dues> is the envisaged date of book return.
|
|
|
|
C<$itemnumber> is item number.
|
|
|
|
C<$difference> numbers of between day date of the day and date due
|
|
|
|
=cut
|
|
|
|
sub GetRepeatableHolidays {
|
|
my ( $date_dues, $itemnumber, $difference ) = @_;
|
|
my $dateinsec = UnixDate( $date_dues, "%o" );
|
|
my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) =
|
|
localtime($dateinsec);
|
|
my @result = GetWdayFromItemnumber($itemnumber);
|
|
my @dayclosedcount;
|
|
my $j;
|
|
|
|
for ( my $i = 0 ; $i < scalar(@result) ; $i++ ) {
|
|
my $k = $wday;
|
|
|
|
for ( $j = 0 ; $j < $difference ; $j++ ) {
|
|
if ( $result[$i]->{'weekday'} == $k ) {
|
|
push( @dayclosedcount, $k );
|
|
}
|
|
$k++;
|
|
( $k = 0 ) if ( $k eq 7 );
|
|
}
|
|
}
|
|
return scalar(@dayclosedcount);
|
|
}
|
|
|
|
|
|
=head2 GetWayFromItemnumber
|
|
|
|
&Getwdayfromitemnumber($itemnumber);
|
|
|
|
return the different week day from repeatable_holidays table
|
|
|
|
C<$itemnumber> is item number.
|
|
|
|
=cut
|
|
|
|
sub GetWdayFromItemnumber {
|
|
my ($itemnumber) = @_;
|
|
my $iteminfo = GetIssuesIteminfo($itemnumber);
|
|
my @result;
|
|
my $query = qq|SELECT weekday
|
|
FROM repeatable_holidays
|
|
WHERE branchcode=?
|
|
|;
|
|
my $sth = C4::Context->dbh->prepare($query);
|
|
|
|
$sth->execute( $iteminfo->{'branchcode'} );
|
|
while ( my $weekday = $sth->fetchrow_hashref ) {
|
|
push( @result, $weekday );
|
|
}
|
|
return @result;
|
|
}
|
|
|
|
|
|
=head2 GetIssuesIteminfo
|
|
|
|
&GetIssuesIteminfo($itemnumber);
|
|
|
|
return all data from issues about item
|
|
|
|
C<$itemnumber> is item number.
|
|
|
|
=cut
|
|
|
|
sub GetIssuesIteminfo {
|
|
my ($itemnumber) = @_;
|
|
my $dbh = C4::Context->dbh;
|
|
my $query = qq|SELECT *
|
|
FROM issues
|
|
WHERE itemnumber=?
|
|
|;
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute($itemnumber);
|
|
my ($issuesinfo) = $sth->fetchrow_hashref;
|
|
return $issuesinfo;
|
|
}
|
|
|
|
|
|
=head2 UpdateFine
|
|
|
|
&UpdateFine({ issue_id => $issue_id, itemnumber => $itemnumber, borrwernumber => $borrowernumber, amount => $amount, type => $type, $due => $date_due });
|
|
|
|
(Note: the following is mostly conjecture and guesswork.)
|
|
|
|
Updates the fine owed on an overdue book.
|
|
|
|
C<$itemnumber> is the book's item number.
|
|
|
|
C<$borrowernumber> is the borrower number of the patron who currently
|
|
has the book on loan.
|
|
|
|
C<$amount> is the current amount owed by the patron.
|
|
|
|
C<$type> will be used in the description of the fine.
|
|
|
|
C<$due> is the due date formatted to the currently specified date format
|
|
|
|
C<&UpdateFine> looks up the amount currently owed on the given item
|
|
and sets it to C<$amount>, creating, if necessary, a new entry in the
|
|
accountlines table of the Koha database.
|
|
|
|
=cut
|
|
|
|
#
|
|
# Question: Why should the caller have to
|
|
# specify both the item number and the borrower number? A book can't
|
|
# be on loan to two different people, so the item number should be
|
|
# sufficient.
|
|
#
|
|
# Possible Answer: You might update a fine for a damaged item, *after* it is returned.
|
|
#
|
|
sub UpdateFine {
|
|
my ($params) = @_;
|
|
|
|
my $issue_id = $params->{issue_id};
|
|
my $itemnum = $params->{itemnumber};
|
|
my $borrowernumber = $params->{borrowernumber};
|
|
my $amount = $params->{amount};
|
|
my $type = $params->{type};
|
|
my $due = $params->{due};
|
|
|
|
$debug and warn "UpdateFine({ itemnumber => $itemnum, borrowernumber => $borrowernumber, type => $type, due => $due, issue_id => $issue_id})";
|
|
|
|
unless ( $issue_id ) {
|
|
carp("No issue_id passed in!");
|
|
return;
|
|
}
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
# FIXME - What exactly is this query supposed to do? It looks up an
|
|
# entry in accountlines that matches the given item and borrower
|
|
# numbers, where the description contains $due, and where the
|
|
# account type has one of several values, but what does this _mean_?
|
|
# Does it look up existing fines for this item?
|
|
# FIXME - What are these various account types? ("FU", "O", "F", "M")
|
|
# "L" is LOST item
|
|
# "A" is Account Management Fee
|
|
# "N" is New Card
|
|
# "M" is Sundry
|
|
# "O" is Overdue ??
|
|
# "F" is Fine ??
|
|
# "FU" is Fine UPDATE??
|
|
# "Pay" is Payment
|
|
# "REF" is Cash Refund
|
|
my $sth = $dbh->prepare(
|
|
"SELECT * FROM accountlines
|
|
WHERE borrowernumber=? AND
|
|
(( accounttype IN ('O','F','M') AND amountoutstanding<>0 ) OR
|
|
accounttype = 'FU' )"
|
|
);
|
|
$sth->execute( $borrowernumber );
|
|
my $data;
|
|
my $total_amount_other = 0.00;
|
|
my $due_qr = qr/$due/;
|
|
# Cycle through the fines and
|
|
# - find line that relates to the requested $itemnum
|
|
# - accumulate fines for other items
|
|
# so we can update $itemnum fine taking in account fine caps
|
|
while (my $rec = $sth->fetchrow_hashref) {
|
|
if ( $rec->{issue_id} == $issue_id && $rec->{accounttype} eq 'FU' ) {
|
|
if ($data) {
|
|
warn "Not a unique accountlines record for issue_id $issue_id";
|
|
#FIXME Should we still count this one in total_amount ??
|
|
}
|
|
else {
|
|
$data = $rec;
|
|
next;
|
|
}
|
|
}
|
|
$total_amount_other += $rec->{'amountoutstanding'};
|
|
}
|
|
|
|
if (my $maxfine = C4::Context->preference('MaxFine')) {
|
|
if ($total_amount_other + $amount > $maxfine) {
|
|
my $new_amount = $maxfine - $total_amount_other;
|
|
return if $new_amount <= 0.00;
|
|
warn "Reducing fine for item $itemnum borrower $borrowernumber from $amount to $new_amount - MaxFine reached";
|
|
$amount = $new_amount;
|
|
}
|
|
}
|
|
|
|
if ( $data ) {
|
|
# we're updating an existing fine. Only modify if amount changed
|
|
# Note that in the current implementation, you cannot pay against an accruing fine
|
|
# (i.e. , of accounttype 'FU'). Doing so will break accrual.
|
|
if ( $data->{'amount'} != $amount ) {
|
|
my $accountline = Koha::Account::Lines->find( $data->{accountlines_id} );
|
|
my $diff = $amount - $data->{'amount'};
|
|
|
|
#3341: diff could be positive or negative!
|
|
my $out = $data->{'amountoutstanding'} + $diff;
|
|
|
|
$accountline->set(
|
|
{
|
|
date => dt_from_string(),
|
|
amount => $amount,
|
|
amountoutstanding => $out,
|
|
lastincrement => $diff,
|
|
accounttype => 'FU',
|
|
}
|
|
)->store();
|
|
|
|
Koha::Account::Offset->new(
|
|
{
|
|
debit_id => $accountline->id,
|
|
type => 'Fine Update',
|
|
amount => $diff,
|
|
}
|
|
)->store();
|
|
}
|
|
} else {
|
|
if ( $amount ) { # Don't add new fines with an amount of 0
|
|
my $sth4 = $dbh->prepare(
|
|
"SELECT title FROM biblio LEFT JOIN items ON biblio.biblionumber=items.biblionumber WHERE items.itemnumber=?"
|
|
);
|
|
$sth4->execute($itemnum);
|
|
my $title = $sth4->fetchrow;
|
|
|
|
my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
|
|
|
|
my $desc = ( $type ? "$type " : '' ) . "$title $due"; # FIXEDME, avoid whitespace prefix on empty $type
|
|
|
|
my $accountline = Koha::Account::Line->new(
|
|
{
|
|
borrowernumber => $borrowernumber,
|
|
itemnumber => $itemnum,
|
|
date => dt_from_string(),
|
|
amount => $amount,
|
|
description => $desc,
|
|
accounttype => 'FU',
|
|
amountoutstanding => $amount,
|
|
lastincrement => $amount,
|
|
accountno => $nextaccntno,
|
|
issue_id => $issue_id,
|
|
}
|
|
)->store();
|
|
|
|
Koha::Account::Offset->new(
|
|
{
|
|
debit_id => $accountline->id,
|
|
type => 'Fine',
|
|
amount => $amount,
|
|
}
|
|
)->store();
|
|
}
|
|
}
|
|
# logging action
|
|
&logaction(
|
|
"FINES",
|
|
$type,
|
|
$borrowernumber,
|
|
"due=".$due." amount=".$amount." itemnumber=".$itemnum
|
|
) if C4::Context->preference("FinesLog");
|
|
}
|
|
|
|
=head2 BorType
|
|
|
|
$borrower = &BorType($borrowernumber);
|
|
|
|
Looks up a patron by borrower number.
|
|
|
|
C<$borrower> is a reference-to-hash whose keys are all of the fields
|
|
from the borrowers and categories tables of the Koha database. Thus,
|
|
C<$borrower> contains all information about both the borrower and
|
|
category they belong to.
|
|
|
|
=cut
|
|
|
|
sub BorType {
|
|
my ($borrowernumber) = @_;
|
|
my $dbh = C4::Context->dbh;
|
|
my $sth = $dbh->prepare(
|
|
"SELECT * from borrowers
|
|
LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
|
|
WHERE borrowernumber=?"
|
|
);
|
|
$sth->execute($borrowernumber);
|
|
return $sth->fetchrow_hashref;
|
|
}
|
|
|
|
=head2 GetFine
|
|
|
|
$data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
|
|
|
|
return the total of fine
|
|
|
|
C<$itemnum> is item number
|
|
|
|
C<$borrowernumber> is the borrowernumber
|
|
|
|
=cut
|
|
|
|
sub GetFine {
|
|
my ( $itemnum, $borrowernumber ) = @_;
|
|
my $dbh = C4::Context->dbh();
|
|
my $query = q|SELECT sum(amountoutstanding) as fineamount FROM accountlines
|
|
where accounttype like 'F%'
|
|
AND amountoutstanding > 0 AND borrowernumber=?|;
|
|
my @query_param;
|
|
push @query_param, $borrowernumber;
|
|
if (defined $itemnum )
|
|
{
|
|
$query .= " AND itemnumber=?";
|
|
push @query_param, $itemnum;
|
|
}
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute( @query_param );
|
|
my $fine = $sth->fetchrow_hashref();
|
|
if ($fine->{fineamount}) {
|
|
return $fine->{fineamount};
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
=head2 NumberNotifyId
|
|
|
|
(@notify) = &NumberNotifyId($borrowernumber);
|
|
|
|
Returns amount for all file per borrowers
|
|
C<@notify> array contains all file per borrowers
|
|
|
|
C<$notify_id> contains the file number for the borrower number nad item number
|
|
|
|
=cut
|
|
|
|
sub NumberNotifyId{
|
|
my ($borrowernumber)=@_;
|
|
my $dbh = C4::Context->dbh;
|
|
my $query=qq| SELECT distinct(notify_id)
|
|
FROM accountlines
|
|
WHERE borrowernumber=?|;
|
|
my @notify;
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute($borrowernumber);
|
|
while ( my ($numberofnotify) = $sth->fetchrow ) {
|
|
push( @notify, $numberofnotify );
|
|
}
|
|
return (@notify);
|
|
}
|
|
|
|
=head2 AmountNotify
|
|
|
|
($totalnotify) = &AmountNotify($notifyid);
|
|
|
|
Returns amount for all file per borrowers
|
|
C<$notifyid> is the file number
|
|
|
|
C<$totalnotify> contains amount of a file
|
|
|
|
C<$notify_id> contains the file number for the borrower number and item number
|
|
|
|
=cut
|
|
|
|
sub AmountNotify{
|
|
my ($notifyid,$borrowernumber)=@_;
|
|
my $dbh = C4::Context->dbh;
|
|
my $query=qq| SELECT sum(amountoutstanding)
|
|
FROM accountlines
|
|
WHERE notify_id=? AND borrowernumber = ?|;
|
|
my $sth=$dbh->prepare($query);
|
|
$sth->execute($notifyid,$borrowernumber);
|
|
my $totalnotify=$sth->fetchrow;
|
|
$sth->finish;
|
|
return ($totalnotify);
|
|
}
|
|
|
|
=head2 GetItems
|
|
|
|
($items) = &GetItems($itemnumber);
|
|
|
|
Returns the list of all delays from overduerules.
|
|
|
|
C<$items> is a reference-to-hash whose keys are all of the fields
|
|
from the items tables of the Koha database. Thus,
|
|
|
|
C<$itemnumber> contains the borrower categorycode
|
|
|
|
=cut
|
|
|
|
# FIXME: This is a bad function to have here.
|
|
# Shouldn't it be in C4::Items?
|
|
# Shouldn't it be called GetItem since you only get 1 row?
|
|
# Shouldn't it be called GetItem since you give it only 1 itemnumber?
|
|
|
|
sub GetItems {
|
|
my $itemnumber = shift or return;
|
|
my $query = qq|SELECT *
|
|
FROM items
|
|
WHERE itemnumber=?|;
|
|
my $sth = C4::Context->dbh->prepare($query);
|
|
$sth->execute($itemnumber);
|
|
my ($items) = $sth->fetchrow_hashref;
|
|
return ($items);
|
|
}
|
|
|
|
=head2 GetBranchcodesWithOverdueRules
|
|
|
|
my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
|
|
|
|
returns a list of branch codes for branches with overdue rules defined.
|
|
|
|
=cut
|
|
|
|
sub GetBranchcodesWithOverdueRules {
|
|
my $dbh = C4::Context->dbh;
|
|
my $branchcodes = $dbh->selectcol_arrayref(q|
|
|
SELECT DISTINCT(branchcode)
|
|
FROM overduerules
|
|
WHERE delay1 IS NOT NULL
|
|
ORDER BY branchcode
|
|
|);
|
|
if ( $branchcodes->[0] eq '' ) {
|
|
# If a default rule exists, all branches should be returned
|
|
return map { $_->branchcode } Koha::Libraries->search({}, { order_by => 'branchname' });
|
|
}
|
|
return @$branchcodes;
|
|
}
|
|
|
|
=head2 CheckItemNotify
|
|
|
|
Sql request to check if the document has alreday been notified
|
|
this function is not exported, only used with GetOverduesForBranch
|
|
|
|
=cut
|
|
|
|
sub CheckItemNotify {
|
|
my ($notify_id,$notify_level,$itemnumber) = @_;
|
|
my $dbh = C4::Context->dbh;
|
|
my $sth = $dbh->prepare("
|
|
SELECT COUNT(*)
|
|
FROM notifys
|
|
WHERE notify_id = ?
|
|
AND notify_level = ?
|
|
AND itemnumber = ? ");
|
|
$sth->execute($notify_id,$notify_level,$itemnumber);
|
|
my $notified = $sth->fetchrow;
|
|
return ($notified);
|
|
}
|
|
|
|
=head2 GetOverduesForBranch
|
|
|
|
Sql request for display all information for branchoverdues.pl
|
|
2 possibilities : with or without location .
|
|
display is filtered by branch
|
|
|
|
FIXME: This function should be renamed.
|
|
|
|
=cut
|
|
|
|
sub GetOverduesForBranch {
|
|
my ( $branch, $location) = @_;
|
|
my $itype_link = (C4::Context->preference('item-level_itypes')) ? " items.itype " : " biblioitems.itemtype ";
|
|
my $dbh = C4::Context->dbh;
|
|
my $select = "
|
|
SELECT
|
|
borrowers.cardnumber,
|
|
borrowers.borrowernumber,
|
|
borrowers.surname,
|
|
borrowers.firstname,
|
|
borrowers.phone,
|
|
borrowers.email,
|
|
biblio.title,
|
|
biblio.author,
|
|
biblio.biblionumber,
|
|
issues.date_due,
|
|
issues.returndate,
|
|
issues.branchcode,
|
|
branches.branchname,
|
|
items.barcode,
|
|
items.homebranch,
|
|
items.itemcallnumber,
|
|
items.location,
|
|
items.itemnumber,
|
|
itemtypes.description,
|
|
accountlines.notify_id,
|
|
accountlines.notify_level,
|
|
accountlines.amountoutstanding
|
|
FROM accountlines
|
|
LEFT JOIN issues ON issues.itemnumber = accountlines.itemnumber
|
|
AND issues.borrowernumber = accountlines.borrowernumber
|
|
LEFT JOIN borrowers ON borrowers.borrowernumber = accountlines.borrowernumber
|
|
LEFT JOIN items ON items.itemnumber = issues.itemnumber
|
|
LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
|
|
LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
|
|
LEFT JOIN itemtypes ON itemtypes.itemtype = $itype_link
|
|
LEFT JOIN branches ON branches.branchcode = issues.branchcode
|
|
WHERE (accountlines.amountoutstanding != '0.000000')
|
|
AND (accountlines.accounttype = 'FU' )
|
|
AND (issues.branchcode = ? )
|
|
AND (issues.date_due < NOW())
|
|
";
|
|
my @getoverdues;
|
|
my $i = 0;
|
|
my $sth;
|
|
if ($location) {
|
|
$sth = $dbh->prepare("$select AND items.location = ? ORDER BY borrowers.surname, borrowers.firstname");
|
|
$sth->execute($branch, $location);
|
|
} else {
|
|
$sth = $dbh->prepare("$select ORDER BY borrowers.surname, borrowers.firstname");
|
|
$sth->execute($branch);
|
|
}
|
|
while ( my $data = $sth->fetchrow_hashref ) {
|
|
#check if the document has already been notified
|
|
my $countnotify = CheckItemNotify($data->{'notify_id'}, $data->{'notify_level'}, $data->{'itemnumber'});
|
|
if ($countnotify eq '0') {
|
|
$getoverdues[$i] = $data;
|
|
$i++;
|
|
}
|
|
}
|
|
return (@getoverdues);
|
|
}
|
|
|
|
|
|
=head2 AddNotifyLine
|
|
|
|
&AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
|
|
|
|
Create a line into notify, if the method is phone, the notification_send_date is implemented to
|
|
|
|
=cut
|
|
|
|
sub AddNotifyLine {
|
|
my ( $borrowernumber, $itemnumber, $overduelevel, $method, $notifyId ) = @_;
|
|
my $dbh = C4::Context->dbh;
|
|
if ( $method eq "phone" ) {
|
|
my $sth = $dbh->prepare(
|
|
"INSERT INTO notifys (borrowernumber,itemnumber,notify_date,notify_send_date,notify_level,method,notify_id)
|
|
VALUES (?,?,now(),now(),?,?,?)"
|
|
);
|
|
$sth->execute( $borrowernumber, $itemnumber, $overduelevel, $method,
|
|
$notifyId );
|
|
}
|
|
else {
|
|
my $sth = $dbh->prepare(
|
|
"INSERT INTO notifys (borrowernumber,itemnumber,notify_date,notify_level,method,notify_id)
|
|
VALUES (?,?,now(),?,?,?)"
|
|
);
|
|
$sth->execute( $borrowernumber, $itemnumber, $overduelevel, $method,
|
|
$notifyId );
|
|
}
|
|
return 1;
|
|
}
|
|
|
|
=head2 RemoveNotifyLine
|
|
|
|
&RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
|
|
|
|
Cancel a notification
|
|
|
|
=cut
|
|
|
|
sub RemoveNotifyLine {
|
|
my ( $borrowernumber, $itemnumber, $notify_date ) = @_;
|
|
my $dbh = C4::Context->dbh;
|
|
my $sth = $dbh->prepare(
|
|
"DELETE FROM notifys
|
|
WHERE
|
|
borrowernumber=?
|
|
AND itemnumber=?
|
|
AND notify_date=?"
|
|
);
|
|
$sth->execute( $borrowernumber, $itemnumber, $notify_date );
|
|
return 1;
|
|
}
|
|
|
|
=head2 GetOverdueMessageTransportTypes
|
|
|
|
my $message_transport_types = GetOverdueMessageTransportTypes( $branchcode, $categorycode, $letternumber);
|
|
|
|
return a arrayref with all message_transport_type for given branchcode, categorycode and letternumber(1,2 or 3)
|
|
|
|
=cut
|
|
|
|
sub GetOverdueMessageTransportTypes {
|
|
my ( $branchcode, $categorycode, $letternumber ) = @_;
|
|
return unless $categorycode and $letternumber;
|
|
my $dbh = C4::Context->dbh;
|
|
my $sth = $dbh->prepare("
|
|
SELECT message_transport_type
|
|
FROM overduerules odr LEFT JOIN overduerules_transport_types ott USING (overduerules_id)
|
|
WHERE branchcode = ?
|
|
AND categorycode = ?
|
|
AND letternumber = ?
|
|
");
|
|
$sth->execute( $branchcode, $categorycode, $letternumber );
|
|
my @mtts;
|
|
while ( my $mtt = $sth->fetchrow ) {
|
|
push @mtts, $mtt;
|
|
}
|
|
|
|
# Put 'print' in first if exists
|
|
# It avoid to sent a print notice with an email or sms template is no email or sms is defined
|
|
@mtts = uniq( 'print', @mtts )
|
|
if grep {/^print$/} @mtts;
|
|
|
|
return \@mtts;
|
|
}
|
|
|
|
=head2 parse_overdues_letter
|
|
|
|
parses the letter template, replacing the placeholders with data
|
|
specific to this patron, biblio, or item for overdues
|
|
|
|
named parameters:
|
|
letter - required hashref
|
|
borrowernumber - required integer
|
|
substitute - optional hashref of other key/value pairs that should
|
|
be substituted in the letter content
|
|
|
|
returns the C<letter> hashref, with the content updated to reflect the
|
|
substituted keys and values.
|
|
|
|
=cut
|
|
|
|
sub parse_overdues_letter {
|
|
my $params = shift;
|
|
foreach my $required (qw( letter_code borrowernumber )) {
|
|
return unless ( exists $params->{$required} && $params->{$required} );
|
|
}
|
|
|
|
my $patron = Koha::Patrons->find( $params->{borrowernumber} );
|
|
|
|
my $substitute = $params->{'substitute'} || {};
|
|
|
|
my %tables = ( 'borrowers' => $params->{'borrowernumber'} );
|
|
if ( my $p = $params->{'branchcode'} ) {
|
|
$tables{'branches'} = $p;
|
|
}
|
|
|
|
my $active_currency = Koha::Acquisition::Currencies->get_active;
|
|
|
|
my $currency_format;
|
|
$currency_format = $active_currency->currency if defined($active_currency);
|
|
|
|
my @item_tables;
|
|
if ( my $i = $params->{'items'} ) {
|
|
foreach my $item (@$i) {
|
|
my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
|
|
$item->{'fine'} = currency_format($currency_format, "$fine", FMT_SYMBOL);
|
|
# if active currency isn't correct ISO code fallback to sprintf
|
|
$item->{'fine'} = sprintf('%.2f', $fine) unless $item->{'fine'};
|
|
|
|
push @item_tables, {
|
|
'biblio' => $item->{'biblionumber'},
|
|
'biblioitems' => $item->{'biblionumber'},
|
|
'items' => $item,
|
|
'issues' => $item->{'itemnumber'},
|
|
};
|
|
}
|
|
}
|
|
|
|
return C4::Letters::GetPreparedLetter (
|
|
module => 'circulation',
|
|
letter_code => $params->{'letter_code'},
|
|
branchcode => $params->{'branchcode'},
|
|
lang => $patron->lang,
|
|
tables => \%tables,
|
|
loops => {
|
|
overdues => [ map { $_->{items}->{itemnumber} } @item_tables ],
|
|
},
|
|
substitute => $substitute,
|
|
repeat => { item => \@item_tables },
|
|
message_transport_type => $params->{message_transport_type},
|
|
);
|
|
}
|
|
|
|
1;
|
|
__END__
|
|
|
|
=head1 AUTHOR
|
|
|
|
Koha Development Team <http://koha-community.org/>
|
|
|
|
=cut
|