# 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 2 of the License, or (at your option) any later
-# version.
+# 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.
+# 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, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA 02111-1307 USA
+# 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 Date::Calc qw/Today/;
+#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::Line;
+use Koha::Account::Lines;
use vars qw($VERSION @ISA @EXPORT);
BEGIN {
- # set the version for version checking
- $VERSION = 3.01;
- require Exporter;
- @ISA = qw(Exporter);
- # subs to rename (and maybe merge some...)
- push @EXPORT, qw(
- &CalcFine
- &Getoverdues
- &checkoverdues
- &CheckAccountLineLevelInfo
- &CheckAccountLineItemInfo
- &CheckExistantNotifyid
- &GetNextIdNotify
- &GetNotifyId
- &NumberNotifyId
- &AmountNotify
- &UpdateAccountLines
- &UpdateFine
- &GetOverdueDelays
- &GetOverduerules
- &GetFine
- &CreateItemAccountLine
- &ReplacementCost2
-
- &CheckItemNotify
- &GetOverduesForBranch
- &RemoveNotifyLine
- &AddNotifyLine
- );
- # 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(
- &GetIssuingRules
- &GetIssuesIteminfo
- );
- # subs to move to Members.pm
- push @EXPORT, qw(
- &CheckBorrowerDebarred
- &UpdateBorrowerDebarred
- );
- # subs to move to Biblio.pm
- push @EXPORT, qw(
- &GetItems
- &ReplacementCost
- );
+ # set the version for version checking
+ $VERSION = 3.07.00.049;
+ 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
+ );
+
+ # &GetIssuingRules - delete.
+ # use C4::Circulation::GetIssuingRule instead.
+
+ # subs to move to Biblio.pm
+ push @EXPORT, qw(
+ &GetItems
+ );
}
=head1 NAME
=head1 FUNCTIONS
-=over 2
-
-=item Getoverdues
+=head2 Getoverdues
- ($overdues) = &Getoverdues();
+ $overdues = Getoverdues( { minimumdays => 1, maximumdays => 30 } );
Returns the list of all overdue books, with their itemtype.
#'
sub Getoverdues {
+ my $params = shift;
my $dbh = C4::Context->dbh;
- my $sth = (C4::Context->preference('item-level_itypes')) ?
- $dbh->prepare(
- "SELECT issues.*,items.itype as itemtype FROM issues
- LEFT JOIN items USING (itemnumber)
- WHERE date_due < now()
- ORDER BY borrowernumber " )
- :
- $dbh->prepare(
- "SELECT issues.*,biblioitems.itemtype,items.itype FROM issues
- LEFT JOIN items USING (itemnumber)
- LEFT JOIN biblioitems USING (biblioitemnumber)
- WHERE date_due < now()
- ORDER BY borrowernumber " );
- $sth->execute;
-
- my @results;
- while ( my $data = $sth->fetchrow_hashref ) {
- push @results, $data;
+ 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()
+";
}
- $sth->finish;
- return \@results;
+ 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, $dbh );
+ ($count, $overdueitems) = checkoverdues($borrowernumber);
-Not exported
+Returns a count and a list of overdueitems for a given borrowernumber
=cut
sub checkoverdues {
-
-# From Main.pm, modified to return a list of overdueitems, in addition to a count
-#checks whether a borrower has overdue items
- my ( $borrowernumber, $dbh ) = @_;
- my @datearr = localtime;
- my $today =
- ( $datearr[5] + 1900 ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
- my @overdueitems;
- my $count = 0;
- my $sth = $dbh->prepare(
- "SELECT * FROM issues
- LEFT JOIN items ON issues.itemnumber = items.itemnumber
- LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
+ my $borrowernumber = shift or return;
+ # don't select biblioitems.marc or biblioitems.marcxml... too slow on large systems
+ 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 < ?"
+ AND issues.date_due < NOW()"
);
- $sth->execute( $borrowernumber, $today );
- while ( my $data = $sth->fetchrow_hashref ) {
- push( @overdueitems, $data );
- $count++;
- }
- $sth->finish;
- return ( $count, \@overdueitems );
+ # FIXME: SELECT * across 4 tables? do we really need the marc AND marcxml blobs??
+ $sth->execute($borrowernumber);
+ my $results = $sth->fetchall_arrayref({});
+ return ( scalar(@$results), $results); # returning the count and the results is silly
}
-=item CalcFine
+=head2 CalcFine
- ($amount, $chargename, $message) =
- &CalcFine($itemnumber, $borrowercode, $days_overdue);
+ ($amount, $chargename, $units_minus_grace, $chargeable_units) = &CalcFine($item,
+ $categorycode, $branch,
+ $start_dt, $end_dt );
Calculates the fine for a book.
members might get a longer grace period between the first and second
reminders that a book is overdue).
-The fine is calculated as follows: if it is time for the first
-reminder, the fine is the value listed for the given (branch, item type,
-borrower code) combination. If it is time for the second reminder, the
-fine is doubled. Finally, if it is time to send the account to a
-collection agency, the fine is set to 5 local monetary units (a really
-good deal for the patron if the library is in Italy). Otherwise, the
-fine is 0.
-
-Note that the way this function is currently implemented, it only
-returns a nonzero value on the notable days listed above. That is, if
-the categoryitems entry says to send a first reminder 7 days after the
-book is due, then if you call C<&CalcFine> 7 days after the book is
-due, it will give a nonzero fine. If you call C<&CalcFine> the next
-day, however, it will say that the fine is 0.
-C<$itemnumber> is the book's item number.
+C<$item> is an item object (hashref).
-C<$borrowercode> is the borrower code of the patron who currently has
+C<$categorycode> is the category code (string) of the patron who currently has
the book.
-C<$days_overdue> is the number of days elapsed since the book's due
-date.
+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 a list of three values:
+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<$message> is a text message, either "First Notice", "Second Notice",
-or "Final Notice".
+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, $difference , $dues ) = @_;
- my $dbh = C4::Context->dbh;
- my $amount = 0;
- my $printout;
- # calculate how many days the patron is late
- my $countspecialday=&GetSpecialHolidays($dues,$item->{itemnumber});
- my $countrepeatableday=&GetRepeatableHolidays($dues,$item->{itemnumber},$difference);
- my $countalldayclosed = $countspecialday + $countrepeatableday;
- my $daycount = $difference - $countalldayclosed;
+ my ( $item, $bortype, $branchcode, $due_dt, $end_date ) = @_;
+ my $start_date = $due_dt->clone();
# get issuingrules (fines part will be used)
- my $data = GetIssuingRules($item->{'itemtype'},$bortype);
- my $daycounttotal = $daycount - $data->{'firstremind'};
- if ($data->{'chargeperiod'} >0) { # if there is a rule for this bortype
- if ($data->{'firstremind'} < $daycount)
- {
- $amount = int($daycounttotal/$data->{'chargeperiod'})*$data->{'fine'};
+ my $itemtype = $item->{itemtype} || $item->{itype};
+ my $data = C4::Circulation::GetIssuingRule($bortype, $itemtype, $branchcode);
+ my $fine_unit = $data->{lengthunit};
+ $fine_unit ||= 'days';
+
+ my $chargeable_units = get_chargeable_units($fine_unit, $start_date, $end_date, $branchcode);
+ my $units_minus_grace = $chargeable_units - $data->{firstremind};
+ my $amount = 0;
+ if ( $data->{'chargeperiod'} && ( $units_minus_grace > 0 ) ) {
+ my $units = C4::Context->preference('FinesIncludeGracePeriod') ? $chargeable_units : $units_minus_grace;
+ my $charge_periods = $units / $data->{'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 = $data->{'chargeperiod_charge_at'} == 1 ? ceil($charge_periods) : floor($charge_periods);
+ $amount = $charge_periods * $data->{'fine'};
+ } # else { # a zero (or null) chargeperiod or negative units_minus_grace value means no charge. }
+
+ $amount = $data->{overduefinescap} if $data->{overduefinescap} && $amount > $data->{overduefinescap};
+ $amount = $item->{replacementprice} if ( $data->{cap_fine_to_replacement_price} && $item->{replacementprice} && $amount > $item->{replacementprice} );
+ $debug and warn sprintf("CalcFine returning (%s, %s, %s, %s)", $amount, $data->{'chargename'}, $units_minus_grace, $chargeable_units);
+ return ($amount, $data->{'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 );
}
- } else {
- # get fines default rules
- my $data = GetIssuingRules($item->{'itemtype'},'*');
- $daycounttotal = $daycount - $data->{'firstremind'};
- if ($data->{'firstremind'} < $daycount)
- {
- if ($data->{'chargeperiod'} >0) { # if there is a rule for this bortype
- $amount = int($daycounttotal/$data->{'chargeperiod'})*$data->{'fine'};
- }
- }
+ 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');
}
-
- warn "Calc Fine for $item->{'itemnumber'}, $bortype, $difference , $dues = $amount / $daycount";
- return ( $amount, $data->{'chargename'}, $printout ,$daycounttotal ,$daycount );
}
-=item GetSpecialHolidays
+=head2 GetSpecialHolidays
-&GetSpecialHolidays($date_dues,$itemnumber);
+ &GetSpecialHolidays($date_dues,$itemnumber);
return number of special days between date of the day and date due
=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
+ 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'});
-
-while ( my $special_date=$sth->fetchrow_hashref){
- push (@result_date,$special_date);
-}
+ 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);
+ 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 --;
+ 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;
+ return $specialdaycount;
}
-=item GetRepeatableHolidays
+=head2 GetRepeatableHolidays
-&GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
+ &GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
return number of day closed between 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);
+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);
+ $k++;
+ ( $k = 0 ) if ( $k eq 7 );
}
}
-return scalar(@dayclosedcount);
+ return scalar(@dayclosedcount);
}
-=item GetWayFromItemnumber
+=head2 GetWayFromItemnumber
-&Getwdayfromitemnumber($itemnumber);
+ &Getwdayfromitemnumber($itemnumber);
return the different week day from repeatable_holidays table
=cut
-sub GetWdayFromItemnumber{
-my($itemnumber)=@_;
-my $iteminfo=GetIssuesIteminfo($itemnumber);
-my @result;
-my $dbh = C4::Context->dbh;
-my $query = qq|SELECT weekday
+sub GetWdayFromItemnumber {
+ my ($itemnumber) = @_;
+ my $iteminfo = GetIssuesIteminfo($itemnumber);
+ my @result;
+ my $query = qq|SELECT weekday
FROM repeatable_holidays
WHERE branchcode=?
|;
-my $sth = $dbh->prepare($query);
- # print $query;
+ my $sth = C4::Context->dbh->prepare($query);
-$sth->execute($iteminfo->{'branchcode'});
-while ( my $weekday=$sth->fetchrow_hashref){
- push (@result,$weekday);
+ $sth->execute( $iteminfo->{'branchcode'} );
+ while ( my $weekday = $sth->fetchrow_hashref ) {
+ push( @result, $weekday );
}
-return @result;
+ return @result;
}
-=item GetIssuesIteminfo
+=head2 GetIssuesIteminfo
-&GetIssuesIteminfo($itemnumber);
+ &GetIssuesIteminfo($itemnumber);
return all data from issues about item
=cut
-sub GetIssuesIteminfo{
-my($itemnumber)=@_;
-my $dbh = C4::Context->dbh;
-my $query = qq|SELECT *
+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;
+ |;
+ my $sth = $dbh->prepare($query);
+ $sth->execute($itemnumber);
+ my ($issuesinfo) = $sth->fetchrow_hashref;
+ return $issuesinfo;
}
-=item UpdateFine
+=head2 UpdateFine
- &UpdateFine($itemnumber, $borrowernumber, $amount, $type, $description);
+ &UpdateFine({ issue_id => $issue_id, itemnumber => $itemnumber, borrwernumber => $borrowernumber, amount => $amount, type => $type, $due => $date_due });
(Note: the following is mostly conjecture and guesswork.)
C<$type> will be used in the description of the fine.
-C<$description> is a string that must be present in the description of
-the fine. I think this is expected to be a date in DD/MM/YYYY format.
+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
=cut
-#'
-# FIXME - This API doesn't look right: why should the caller have to
+#
+# 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 ( $itemnum, $borrowernumber, $amount, $type, $due ) = @_;
+ 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
# 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 itemnumber=? and
- borrowernumber=? and (accounttype='FU' or accounttype='O' or
- accounttype='F' or accounttype='M') and description like ?"
+ "SELECT * FROM accountlines
+ WHERE borrowernumber=?
+ AND accounttype IN ('FU','O','F','M')"
);
- $sth->execute( $itemnum, $borrowernumber, "%$due%" );
-
- if ( my $data = $sth->fetchrow_hashref ) {
-
- # I think this if-clause deals with the case where we're updating
- # an existing fine.
- # print "in accounts ...";
- if ( $data->{'amount'} != $amount ) {
-
- # print "updating";
- my $diff = $amount - $data->{'amount'};
- my $out = $data->{'amountoutstanding'} + $diff;
- my $sth2 = $dbh->prepare(
- "UPDATE accountlines SET date=now(), amount=?,
- amountoutstanding=?,accounttype='FU' WHERE
- borrowernumber=? AND itemnumber=?
- AND (accounttype='FU' OR accounttype='O') AND description LIKE ?"
- );
- $sth2->execute( $amount, $out, $data->{'borrowernumber'},
- $data->{'itemnumber'}, "%$due%" );
- $sth2->finish;
+ $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 ) {
+ if ($data) {
+ warn "Not a unique accountlines record for issue_id $issue_id";
+ }
+ else {
+ $data = $rec;
+ next;
+ }
}
- else {
+ $total_amount_other += $rec->{'amountoutstanding'};
+ }
- # print "no update needed $data->{'amount'}"
+ 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;
}
}
- else {
- # I think this else-clause deals with the case where we're adding
- # a new fine.
- 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_hashref;
- $sth4->finish;
-
-# # print "not in account";
-# my $sth3 = $dbh->prepare("Select max(accountno) from accountlines");
-# $sth3->execute;
-#
-# # FIXME - Make $accountno a scalar.
-# my @accountno = $sth3->fetchrow_array;
-# $sth3->finish;
-# $accountno[0]++;
-# begin transaction
- my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
- my $sth2 = $dbh->prepare(
- "INSERT INTO accountlines
- (borrowernumber,itemnumber,date,amount,
- description,accounttype,amountoutstanding,accountno) VALUES
- (?,?,now(),?,?,'FU',?,?)"
- );
- $sth2->execute( $borrowernumber, $itemnum, $amount,
- "$type $title->{'title'} $due",
- $amount, $nextaccntno);
- $sth2->finish;
+ 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,
+ outstanding => $out,
+ lastincrement => $diff,
+ accounttype => 'FU',
+ }
+ )->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,
+ }
+ )->store();
+ }
}
# logging action
&logaction(
$borrowernumber,
"due=".$due." amount=".$amount." itemnumber=".$itemnum
) if C4::Context->preference("FinesLog");
-
- $sth->finish;
}
-=item BorType
+=head2 BorType
- $borrower = &BorType($borrowernumber);
+ $borrower = &BorType($borrowernumber);
Looks up a patron by borrower number.
=cut
-#'
sub BorType {
my ($borrowernumber) = @_;
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare(
- "SELECT * from borrowers
+ "SELECT * from borrowers
LEFT JOIN categories ON borrowers.categorycode=categories.categorycode
WHERE borrowernumber=?"
);
$sth->execute($borrowernumber);
- my $data = $sth->fetchrow_hashref;
- $sth->finish;
- return ($data);
+ return $sth->fetchrow_hashref;
}
-=item ReplacementCost
+=head2 GetFine
- $cost = &ReplacementCost($itemnumber);
-
-Returns the replacement cost of the item with the given item number.
-
-=cut
-
-#'
-sub ReplacementCost {
- my ($itemnum) = @_;
- my $dbh = C4::Context->dbh;
- my $sth =
- $dbh->prepare("Select replacementprice from items where itemnumber=?");
- $sth->execute($itemnum);
-
- # FIXME - Use fetchrow_array or something.
- my $data = $sth->fetchrow_hashref;
- $sth->finish;
- return ( $data->{'replacementprice'} );
-}
-
-=item GetFine
-
-$data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
+ $data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
return the total of fine
=cut
-
sub GetFine {
my ( $itemnum, $borrowernumber ) = @_;
my $dbh = C4::Context->dbh();
- my $query = "SELECT sum(amountoutstanding) FROM accountlines
- where accounttype like 'F%'
- AND amountoutstanding > 0 AND itemnumber = ? AND borrowernumber=?";
- my $sth = $dbh->prepare($query);
- $sth->execute( $itemnum, $borrowernumber );
- my $data = $sth->fetchrow_hashref();
- $sth->finish();
- $dbh->disconnect();
- return ( $data->{'sum(amountoutstanding)'} );
-}
-
-
-
-
-=item GetIssuingRules
-
-$data = &GetIssuingRules($itemtype,$categorycode);
-
-Looks up for all issuingrules an item info
-
-C<$itemnumber> is a reference-to-hash whose keys are all of the fields
-from the borrowers and categories tables of the Koha database. Thus,
-
-C<$categorycode> contains information about borrowers category
-
-C<$data> contains all information about both the borrower and
-category he or she belongs to.
-=cut
-
-sub GetIssuingRules {
- my ($itemtype,$categorycode)=@_;
- my $dbh = C4::Context->dbh();
- my $query=qq|SELECT *
- FROM issuingrules
- WHERE issuingrules.itemtype=?
- AND issuingrules.categorycode=?
- |;
- my $sth = $dbh->prepare($query);
- # print $query;
- $sth->execute($itemtype,$categorycode);
- my ($data) = $sth->fetchrow_hashref;
- $sth->finish;
-return ($data);
-
-}
-
-
-sub ReplacementCost2 {
- my ( $itemnum, $borrowernumber ) = @_;
- my $dbh = C4::Context->dbh();
- my $query = "SELECT amountoutstanding
- FROM accountlines
- WHERE accounttype like 'L'
- AND amountoutstanding > 0
- AND itemnumber = ?
- AND borrowernumber= ?";
- my $sth = $dbh->prepare($query);
- $sth->execute( $itemnum, $borrowernumber );
- my $data = $sth->fetchrow_hashref();
- $sth->finish();
- $dbh->disconnect();
- return ( $data->{'amountoutstanding'} );
-}
-
-
-=item GetNextIdNotify
-
-($result) = &GetNextIdNotify($reference);
-
-Returns the new file number
-
-C<$result> contains the next file number
-
-C<$reference> contains the beggining of file number
-
-=cut
-
-
-
-sub GetNextIdNotify {
-my ($reference)=@_;
-my $query=qq|SELECT max(notify_id)
- FROM accountlines
- WHERE notify_id like \"$reference%\"
- |;
-# AND borrowernumber=?|;
-my $dbh = C4::Context->dbh;
-my $sth=$dbh->prepare($query);
-$sth->execute();
-my $result=$sth->fetchrow;
-$sth->finish;
-my $count;
- if ($result eq '')
- {
- ($result=$reference."01") ;
- }else
+ 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 )
{
- $count=substr($result,6)+1;
-
- if($count<10){
- ($count = "0".$count);
- }
- $result=$reference.$count;
- }
-return $result;
+ $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
-=item NumberNotifyId
-
-(@notify) = &NumberNotifyId($borrowernumber);
+ (@notify) = &NumberNotifyId($borrowernumber);
Returns amount for all file per borrowers
C<@notify> array contains all file per borrowers
FROM accountlines
WHERE borrowernumber=?|;
my @notify;
- my $sth=$dbh->prepare($query);
- $sth->execute($borrowernumber);
- while ( my ($numberofnotify)=$sth->fetchrow){
- push (@notify,$numberofnotify);
+ my $sth = $dbh->prepare($query);
+ $sth->execute($borrowernumber);
+ while ( my ($numberofnotify) = $sth->fetchrow ) {
+ push( @notify, $numberofnotify );
}
- $sth->finish;
-
return (@notify);
-
}
-=item AmountNotify
+=head2 AmountNotify
-($totalnotify) = &AmountNotify($notifyid);
+ ($totalnotify) = &AmountNotify($notifyid);
Returns amount for all file per borrowers
C<$notifyid> is the file number
return ($totalnotify);
}
+=head2 GetItems
-=item GetNotifyId
-
-($notify_id) = &GetNotifyId($borrowernumber,$itemnumber);
-
-Returns the file number per borrower and itemnumber
-
-C<$borrowernumber> 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
-
-C<$notify_id> contains the file number for the borrower number nad item number
-
-=cut
-
- sub GetNotifyId {
- my ($borrowernumber,$itemnumber)=@_;
- my $query=qq|SELECT notify_id
- FROM accountlines
- WHERE borrowernumber=?
- AND itemnumber=?
- AND (accounttype='FU' or accounttype='O')|;
- my $dbh = C4::Context->dbh;
- my $sth=$dbh->prepare($query);
- $sth->execute($borrowernumber,$itemnumber);
- my ($notify_id)=$sth->fetchrow;
- $sth->finish;
- return ($notify_id);
-
- }
-
-=item CreateItemAccountLine
-
-() = &CreateItemAccountLine($borrowernumber,$itemnumber,$date,$amount,$description,$accounttype,$amountoutstanding,$timestamp,$notify_id,$level);
-
-update the account lines with file number or with file level
-
-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 item number
-
-C<$borrowernumber> contains the borrower number
-
-C<$date> contains the date of the day
-
-C<$amount> contains item price
-
-C<$description> contains the descritpion of accounttype
-
-C<$accounttype> contains the account type
-
-C<$amountoutstanding> contains the $amountoutstanding
-
-C<$timestamp> contains the timestamp with time and the date of the day
-
-C<$notify_id> contains the file number
-
-C<$level> contains the file level
-
-
-=cut
-
- sub CreateItemAccountLine {
- my ($borrowernumber,$itemnumber,$date,$amount,$description,$accounttype,$amountoutstanding,$timestamp,$notify_id,$level)=@_;
- my $dbh = C4::Context->dbh;
- my $nextaccntno = getnextacctno($borrowernumber);
- my $query= "INSERT into accountlines
- (borrowernumber,accountno,itemnumber,date,amount,description,accounttype,amountoutstanding,timestamp,notify_id,notify_level)
- VALUES
- (?,?,?,?,?,?,?,?,?,?,?)";
-
-
- my $sth=$dbh->prepare($query);
- $sth->execute($borrowernumber,$nextaccntno,$itemnumber,$date,$amount,$description,$accounttype,$amountoutstanding,$timestamp,$notify_id,$level);
- $sth->finish;
- }
-
-=item UpdateAccountLines
-
-() = &UpdateAccountLines($notify_id,$notify_level,$borrowernumber,$itemnumber);
-
-update the account lines with file number or with file level
-
-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 item number
-
-C<$notify_id> contains the file number
-
-C<$notify_level> contains the file level
-
-C<$borrowernumber> contains the borrowernumber
-
-=cut
-
-sub UpdateAccountLines {
-my ($notify_id,$notify_level,$borrowernumber,$itemnumber)=@_;
-my $query;
-if ($notify_id eq '')
-{
-
- $query=qq|UPDATE accountlines
- SET notify_level=?
- WHERE borrowernumber=? AND itemnumber=?
- AND (accounttype='FU' or accounttype='O')|;
-}else
-{
- $query=qq|UPDATE accountlines
- SET notify_id=?, notify_level=?
- WHERE borrowernumber=?
- AND itemnumber=?
- AND (accounttype='FU' or accounttype='O')|;
-}
- my $dbh = C4::Context->dbh;
- my $sth=$dbh->prepare($query);
-
-if ($notify_id eq '')
-{
- $sth->execute($notify_level,$borrowernumber,$itemnumber);
-}else
-{
- $sth->execute($notify_id,$notify_level,$borrowernumber,$itemnumber);
-}
- $sth->finish;
-
-}
-
-
-=item GetItems
-
-($items) = &GetItems($itemnumber);
+ ($items) = &GetItems($itemnumber);
Returns the list of all delays from overduerules.
=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) = @_;
- my $query=qq|SELECT *
+ my $itemnumber = shift or return;
+ my $query = qq|SELECT *
FROM items
WHERE itemnumber=?|;
- my $dbh = C4::Context->dbh;
- my $sth=$dbh->prepare($query);
- $sth->execute($itemnumber);
- my ($items)=$sth->fetchrow_hashref;
- $sth->finish;
- return($items);
+ my $sth = C4::Context->dbh->prepare($query);
+ $sth->execute($itemnumber);
+ my ($items) = $sth->fetchrow_hashref;
+ return ($items);
}
-=item GetOverdueDelays
-
-(@delays) = &GetOverdueDelays($categorycode);
+=head2 GetBranchcodesWithOverdueRules
-Returns the list of all delays from overduerules.
-
-C<@delays> it's an array contains the three delays from overduerules table
+ my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
-C<$categorycode> contains the borrower categorycode
+returns a list of branch codes for branches with overdue rules defined.
=cut
-sub GetOverdueDelays {
- my($category) = @_;
- my $dbh = C4::Context->dbh;
- my $query=qq|SELECT delay1,delay2,delay3
- FROM overduerules
- WHERE categorycode=?|;
- my $sth=$dbh->prepare($query);
- $sth->execute($category);
- my (@delays)=$sth->fetchrow_array;
- $sth->finish;
- return(@delays);
-}
-
-=item CheckAccountLineLevelInfo
-
-($exist) = &CheckAccountLineLevelInfo($borrowernumber,$itemnumber,$accounttype,notify_level);
-
-Check and Returns the list of all overdue books.
-
-C<$exist> contains number of line in accounlines
-with the same .biblionumber,itemnumber,accounttype,and notify_level
-
-C<$borrowernumber> contains the borrower number
-
-C<$itemnumber> contains item number
-
-C<$accounttype> contains account type
-
-C<$notify_level> contains the accountline level
-
-
-=cut
-
-sub CheckAccountLineLevelInfo {
- my($borrowernumber,$itemnumber,$level) = @_;
- my $dbh = C4::Context->dbh;
- my $query= qq|SELECT count(*)
- FROM accountlines
- WHERE borrowernumber =?
- AND itemnumber = ?
- AND notify_level=?|;
- my $sth=$dbh->prepare($query);
- $sth->execute($borrowernumber,$itemnumber,$level);
- my ($exist)=$sth->fetchrow;
- $sth->finish;
- return($exist);
-}
-
-=item GetOverduerules
-
-($overduerules) = &GetOverduerules($categorycode);
-
-Returns the value of borrowers (debarred or not) with notify level
-
-C<$overduerules> return value of debbraed field in overduerules table
-
-C<$category> contains the borrower categorycode
-
-C<$notify_level> contains the notify level
-=cut
-
-
-sub GetOverduerules{
- my($category,$notify_level) = @_;
- my $dbh = C4::Context->dbh;
- my $query=qq|SELECT debarred$notify_level
- FROM overduerules
- WHERE categorycode=?|;
- my $sth=$dbh->prepare($query);
- $sth->execute($category);
- my ($overduerules)=$sth->fetchrow;
- $sth->finish;
- return($overduerules);
-}
-
-
-=item CheckBorrowerDebarred
-
-($debarredstatus) = &CheckBorrowerDebarred($borrowernumber);
-
-Check if the borrowers is already debarred
-
-C<$debarredstatus> return 0 for not debarred and return 1 for debarred
-
-C<$borrowernumber> contains the borrower number
-
-=cut
-
-
-sub CheckBorrowerDebarred{
- my($borrowernumber) = @_;
- my $dbh = C4::Context->dbh;
- my $query=qq|SELECT debarred
- FROM borrowers
- WHERE borrowernumber=?
- |;
- my $sth=$dbh->prepare($query);
- $sth->execute($borrowernumber);
- my ($debarredstatus)=$sth->fetchrow;
- $sth->finish;
- if ($debarredstatus eq '1'){
- return(1);}
- else{
- return(0);
+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
+ my $availbranches = C4::Branch::GetBranches();
+ return keys %$availbranches;
}
+ return @$branchcodes;
}
-=item UpdateBorrowerDebarred
-
-($borrowerstatut) = &UpdateBorrowerDebarred($borrowernumber);
-
-update status of borrowers in borrowers table (field debarred)
-
-C<$borrowernumber> borrower number
-
-=cut
-
-sub UpdateBorrowerDebarred{
- my($borrowernumber) = @_;
- my $dbh = C4::Context->dbh;
- my $query=qq|UPDATE borrowers
- SET debarred='1'
- WHERE borrowernumber=?
- |;
- my $sth=$dbh->prepare($query);
- $sth->execute($borrowernumber);
- $sth->finish;
- return 1;
-}
-
-=item CheckExistantNotifyid
-
- ($exist) = &CheckExistantNotifyid($borrowernumber,$itemnumber,$accounttype,$notify_id);
-
-Check and Returns the notify id if exist else return 0.
-
-C<$exist> contains a notify_id
-
-C<$borrowernumber> contains the borrower number
-
-C<$date_due> contains the date of item return
-
-
-=cut
-
-sub CheckExistantNotifyid {
- my($borrowernumber,$date_due) = @_;
- my $dbh = C4::Context->dbh;
- my $query = qq|SELECT notify_id FROM accountlines
- LEFT JOIN issues ON issues.itemnumber= accountlines.itemnumber
- WHERE accountlines.borrowernumber =?
- AND date_due = ?|;
- my $sth=$dbh->prepare($query);
- $sth->execute($borrowernumber,$date_due);
- my ($exist)=$sth->fetchrow;
- $sth->finish;
- if ($exist eq '')
- {
- return(0);
- }else
- {
- return($exist);
- }
-}
-
-=item CheckAccountLineItemInfo
-
- ($exist) = &CheckAccountLineItemInfo($borrowernumber,$itemnumber,$accounttype,$notify_id);
-
-Check and Returns the list of all overdue items from the same file number(notify_id).
-
-C<$exist> contains number of line in accounlines
-with the same .biblionumber,itemnumber,accounttype,notify_id
-
-C<$borrowernumber> contains the borrower number
-
-C<$itemnumber> contains item number
-
-C<$accounttype> contains account type
-
-C<$notify_id> contains the file number
-
-=cut
-
-sub CheckAccountLineItemInfo {
- my($borrowernumber,$itemnumber,$accounttype,$notify_id) = @_;
- my $dbh = C4::Context->dbh;
- my $query = qq|SELECT count(*) FROM accountlines
- WHERE borrowernumber =?
- AND itemnumber = ?
- AND accounttype= ?
- AND notify_id = ?|;
- my $sth=$dbh->prepare($query);
- $sth->execute($borrowernumber,$itemnumber,$accounttype,$notify_id);
- my ($exist)=$sth->fetchrow;
- $sth->finish;
- return($exist);
- }
-
=head2 CheckItemNotify
Sql request to check if the document has alreday been notified
=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;
-$sth->finish;
-return ($notified);
+ 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
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 ";
- if ( not $location ) {
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("
- SELECT
- borrowers.surname,
- borrowers.firstname,
- biblio.title,
- itemtypes.description,
- issues.date_due,
- issues.returndate,
- branches.branchname,
+ 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,
- borrowers.phone,
- borrowers.email,
+ items.homebranch,
items.itemcallnumber,
- borrowers.borrowernumber,
- items.itemnumber,
- biblio.biblionumber,
- issues.branchcode,
- accountlines.notify_id,
- accountlines.notify_level,
items.location,
- 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())
- ORDER BY borrowers.surname
- ");
- $sth->execute($branch);
- my @getoverdues;
- my $i = 0;
- 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'){
+ 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);
- $sth->finish;
- }
- else {
- my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare( "
- SELECT borrowers.surname,
- borrowers.firstname,
- biblio.title,
- itemtypes.description,
- issues.date_due,
- issues.returndate,
- branches.branchname,
- items.barcode,
- borrowers.phone,
- borrowers.email,
- items.itemcallnumber,
- borrowers.borrowernumber,
- items.itemnumber,
- biblio.biblionumber,
- issues.branchcode,
- accountlines.notify_id,
- accountlines.notify_level,
- items.location,
- 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 items.location = ?)
- AND (issues.date_due <= NOW())
- ORDER BY borrowers.surname
- " );
- $sth->execute( $branch, $location);
- my @getoverdues;
- my $i = 0;
- 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++;
- }
}
- $sth->finish;
- return (@getoverdues);
}
+ return (@getoverdues);
}
=head2 AddNotifyLine
-&AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
+ &AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
-Creat a line into notify, if the method is phone, the notification_send_date is implemented to
+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 $dbh = C4::Context->dbh;
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 );
- $sth->finish;
}
else {
- my $dbh = C4::Context->dbh;
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 );
- $sth->finish;
}
return 1;
}
=head2 RemoveNotifyLine
-&RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
+ &RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
Cancel a notification
AND notify_date=?"
);
$sth->execute( $borrowernumber, $itemnumber, $notify_date );
- $sth->finish;
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 $substitute = $params->{'substitute'} || {};
+ $substitute->{today} ||= output_pref( { dt => dt_from_string, dateonly => 1} );
+
+ 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'} ) {
+ my $item_format = '';
+ foreach my $item (@$i) {
+ my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
+ if ( !$item_format and defined $params->{'letter'}->{'content'} ) {
+ $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
+ $item_format = $1;
+ }
+
+ $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'},
+ tables => \%tables,
+ substitute => $substitute,
+ repeat => { item => \@item_tables },
+ message_transport_type => $params->{message_transport_type},
+ );
+}
+
1;
__END__
-=back
-
=head1 AUTHOR
-Koha Developement team <info@koha.org>
+Koha Development Team <http://koha-community.org/>
=cut
projects / koha.git / blobdiff