C4/Accounts.pm

   1 package C4::Accounts;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20
  21 use strict;
  22 #use warnings; FIXME - Bug 2505
  23 use C4::Context;
  24 use C4::Stats;
  25 use C4::Members;
  26 use C4::Log qw(logaction);
  27 use Koha::Account;
  28 use Koha::Account::Lines;
  29 use Koha::Account::Offsets;
  30 use Koha::Items;
  31
  32 use Mojo::Util qw(deprecated);
  33 use Data::Dumper qw(Dumper);
  34
  35 use vars qw(@ISA @EXPORT);
  36
  37 BEGIN {
  38     require Exporter;
  39     @ISA    = qw(Exporter);
  40     @EXPORT = qw(
  41       &chargelostitem
  42       &purge_zero_balance_fees
  43     );
  44 }
  45
  46 =head1 NAME
  47
  48 C4::Accounts - Functions for dealing with Koha accounts
  49
  50 =head1 SYNOPSIS
  51
  52 use C4::Accounts;
  53
  54 =head1 DESCRIPTION
  55
  56 The functions in this module deal with the monetary aspect of Koha,
  57 including looking up and modifying the amount of money owed by a
  58 patron.
  59
  60 =head1 FUNCTIONS
  61
  62 =head2 chargelostitem
  63
  64 In a default install of Koha the following lost values are set
  65 1 = Lost
  66 2 = Long overdue
  67 3 = Lost and paid for
  68
  69 FIXME: itemlost should be set to 3 after payment is made, should be a warning to the interface that a charge has been added
  70 FIXME : if no replacement price, borrower just doesn't get charged?
  71
  72 =cut
  73
  74 sub chargelostitem{
  75     my $dbh = C4::Context->dbh();
  76     my ($borrowernumber, $itemnumber, $amount, $description) = @_;
  77     my $itype = Koha::ItemTypes->find({ itemtype => Koha::Items->find($itemnumber)->effective_itemtype() });
  78     my $replacementprice = $amount;
  79     my $defaultreplacecost = $itype->defaultreplacecost;
  80     my $processfee = $itype->processfee;
  81     my $usedefaultreplacementcost = C4::Context->preference("useDefaultReplacementCost");
  82     my $processingfeenote = C4::Context->preference("ProcessingFeeNote");
  83     if ($usedefaultreplacementcost && $amount == 0 && $defaultreplacecost){
  84         $replacementprice = $defaultreplacecost;
  85     }
  86
  87     my $account = Koha::Account->new({ patron_id => $borrowernumber });
  88     # first make sure the borrower hasn't already been charged for this item
  89     # FIXME this should be more exact
  90     #       there is no reason a user can't lose an item, find and return it, and lost it again
  91     my $existing_charges = $account->lines->search(
  92         {
  93             itemnumber     => $itemnumber,
  94             accounttype    => 'L',
  95         }
  96     )->count();
  97
  98     # OK, they haven't
  99     unless ($existing_charges) {
 100         my $checkout = Koha::Checkouts->find({ itemnumber => $itemnumber });
 101         my $issue_id = $checkout ? $checkout->issue_id : undef;
 102         #add processing fee
 103         if ($processfee && $processfee > 0){
 104             my $accountline = $account->add_debit(
 105                 {
 106                     amount      => $processfee,
 107                     description => $description,
 108                     note        => $processingfeenote,
 109                     user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : 0,
 110                     library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
 111                     type        => 'processing',
 112                     item_id     => $itemnumber,
 113                     issue_id    => $issue_id,
 114                 }
 115             );
 116         }
 117         #add replace cost
 118         if ($replacementprice > 0){
 119             my $accountline = $account->add_debit(
 120                 {
 121                     amount      => $replacementprice,
 122                     description => $description,
 123                     note        => undef,
 124                     user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : 0,
 125                     library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
 126                     type        => 'lost_item',
 127                     item_id     => $itemnumber,
 128                     issue_id    => $issue_id,
 129                 }
 130             );
 131         }
 132     }
 133 }
 134
 135 =head2 manualinvoice
 136
 137   &manualinvoice($borrowernumber, $itemnumber, $description, $type,
 138                  $amount, $note);
 139
 140 This function is now deprecated and not used anywhere within koha. It is due for complete removal in 19.11
 141
 142 =cut
 143
 144 sub manualinvoice {
 145     my ( $borrowernumber, $itemnum, $desc, $type, $amount, $note ) = @_;
 146
 147     deprecated "C4::Accounts::manualinvoice is deprecated in favor of Koha::Account->add_debit";
 148
 149     my $manager_id = 0;
 150     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
 151     my $dbh      = C4::Context->dbh;
 152     my $insert;
 153     my $amountleft = $amount;
 154
 155     my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
 156
 157     my $accountline = Koha::Account::Line->new(
 158         {
 159             borrowernumber    => $borrowernumber,
 160             date              => \'NOW()',
 161             amount            => $amount,
 162             description       => $desc,
 163             accounttype       => $type,
 164             amountoutstanding => $amountleft,
 165             itemnumber        => $itemnum || undef,
 166             note              => $note,
 167             manager_id        => $manager_id,
 168             branchcode        => $branchcode,
 169         }
 170     )->store();
 171
 172     my $account_offset = Koha::Account::Offset->new(
 173         {
 174             debit_id => $accountline->id,
 175             type     => 'Manual Debit',
 176             amount   => $amount,
 177         }
 178     )->store();
 179
 180     if ( C4::Context->preference("FinesLog") ) {
 181         logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 182             action            => 'create_fee',
 183             borrowernumber    => $borrowernumber,
 184             amount            => $amount,
 185             description       => $desc,
 186             accounttype       => $type,
 187             amountoutstanding => $amountleft,
 188             note              => $note,
 189             itemnumber        => $itemnum,
 190             manager_id        => $manager_id,
 191         }));
 192     }
 193
 194     return 0;
 195 }
 196
 197 =head2 purge_zero_balance_fees
 198
 199   purge_zero_balance_fees( $days );
 200
 201 Delete accountlines entries where amountoutstanding is 0 or NULL which are more than a given number of days old.
 202
 203 B<$days> -- Zero balance fees older than B<$days> days old will be deleted.
 204
 205 B<Warning:> Because fines and payments are not linked in accountlines, it is
 206 possible for a fine to be deleted without the accompanying payment,
 207 or vise versa. This won't affect the account balance, but might be
 208 confusing to staff.
 209
 210 =cut
 211
 212 sub purge_zero_balance_fees {
 213     my $days  = shift;
 214     my $count = 0;
 215
 216     my $dbh = C4::Context->dbh;
 217     my $sth = $dbh->prepare(
 218         q{
 219             DELETE a1 FROM accountlines a1
 220
 221             LEFT JOIN account_offsets credit_offset ON ( a1.accountlines_id = credit_offset.credit_id )
 222             LEFT JOIN accountlines a2 ON ( credit_offset.debit_id = a2.accountlines_id )
 223
 224             LEFT JOIN account_offsets debit_offset ON ( a1.accountlines_id = debit_offset.debit_id )
 225             LEFT JOIN accountlines a3 ON ( debit_offset.credit_id = a3.accountlines_id )
 226
 227             WHERE a1.date < date_sub(curdate(), INTERVAL ? DAY)
 228               AND ( a1.amountoutstanding = 0 OR a1.amountoutstanding IS NULL )
 229               AND ( a2.amountoutstanding = 0 OR a2.amountoutstanding IS NULL )
 230               AND ( a3.amountoutstanding = 0 OR a3.amountoutstanding IS NULL )
 231         }
 232     );
 233     $sth->execute($days) or die $dbh->errstr;
 234 }
 235
 236 END { }    # module clean-up code here (global destructor)
 237
 238 1;
 239 __END__
 240
 241 =head1 SEE ALSO
 242
 243 DBI(3)
 244
 245 =cut
 246