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 Data::Dumper qw(Dumper);
  33
  34 use vars qw(@ISA @EXPORT);
  35
  36 BEGIN {
  37     require Exporter;
  38     @ISA    = qw(Exporter);
  39     @EXPORT = qw(
  40       &manualinvoice
  41       &getnextacctno
  42       &chargelostitem
  43       &purge_zero_balance_fees
  44     );
  45 }
  46
  47 =head1 NAME
  48
  49 C4::Accounts - Functions for dealing with Koha accounts
  50
  51 =head1 SYNOPSIS
  52
  53 use C4::Accounts;
  54
  55 =head1 DESCRIPTION
  56
  57 The functions in this module deal with the monetary aspect of Koha,
  58 including looking up and modifying the amount of money owed by a
  59 patron.
  60
  61 =head1 FUNCTIONS
  62
  63 =head2 getnextacctno
  64
  65   $nextacct = &getnextacctno($borrowernumber);
  66
  67 Returns the next unused account number for the patron with the given
  68 borrower number.
  69
  70 =cut
  71
  72 #'
  73 # FIXME - Okay, so what does the above actually _mean_?
  74 sub getnextacctno {
  75     my ($borrowernumber) = shift or return;
  76     my $sth = C4::Context->dbh->prepare(
  77         "SELECT accountno+1 FROM accountlines
  78             WHERE    (borrowernumber = ?)
  79             ORDER BY accountno DESC
  80             LIMIT 1"
  81     );
  82     $sth->execute($borrowernumber);
  83     return ($sth->fetchrow || 1);
  84 }
  85
  86 =head2 chargelostitem
  87
  88 In a default install of Koha the following lost values are set
  89 1 = Lost
  90 2 = Long overdue
  91 3 = Lost and paid for
  92
  93 FIXME: itemlost should be set to 3 after payment is made, should be a warning to the interface that a charge has been added
  94 FIXME : if no replacement price, borrower just doesn't get charged?
  95
  96 =cut
  97
  98 sub chargelostitem{
  99     my $dbh = C4::Context->dbh();
 100     my ($borrowernumber, $itemnumber, $amount, $description) = @_;
 101     my $itype = Koha::ItemTypes->find({ itemtype => Koha::Items->find($itemnumber)->effective_itemtype() });
 102     my $replacementprice = $amount;
 103     my $defaultreplacecost = $itype->defaultreplacecost;
 104     my $processfee = $itype->processfee;
 105     my $usedefaultreplacementcost = C4::Context->preference("useDefaultReplacementCost");
 106     my $processingfeenote = C4::Context->preference("ProcessingFeeNote");
 107     if ($usedefaultreplacementcost && $amount == 0 && $defaultreplacecost){
 108         $replacementprice = $defaultreplacecost;
 109     }
 110     # first make sure the borrower hasn't already been charged for this item
 111     # FIXME this should be more exact
 112     #       there is no reason a user can't lose an item, find and return it, and lost it again
 113     my $existing_charges = Koha::Account::Lines->search(
 114         {
 115             borrowernumber => $borrowernumber,
 116             itemnumber     => $itemnumber,
 117             accounttype    => 'L',
 118         }
 119     )->count();
 120
 121     # OK, they haven't
 122     unless ($existing_charges) {
 123         my $checkout = Koha::Checkouts->find({ itemnumber => $itemnumber });
 124         my $issue_id = $checkout ? $checkout->issue_id : undef;
 125         #add processing fee
 126         if ($processfee && $processfee > 0){
 127             my $accountline = Koha::Account::Line->new(
 128                 {
 129                     borrowernumber    => $borrowernumber,
 130                     issue_id          => $issue_id,
 131                     accountno         => getnextacctno($borrowernumber),
 132                     date              => \'NOW()',
 133                     amount            => $processfee,
 134                     description       => $description,
 135                     accounttype       => 'PF',
 136                     amountoutstanding => $processfee,
 137                     itemnumber        => $itemnumber,
 138                     note              => $processingfeenote,
 139                     manager_id        => C4::Context->userenv ? C4::Context->userenv->{'number'} : 0,
 140                 }
 141             )->store();
 142
 143             my $account_offset = Koha::Account::Offset->new(
 144                 {
 145                     debit_id => $accountline->id,
 146                     type     => 'Processing Fee',
 147                     amount   => $accountline->amount,
 148                 }
 149             )->store();
 150
 151             if ( C4::Context->preference("FinesLog") ) {
 152                 logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 153                     action            => 'create_fee',
 154                     borrowernumber    => $accountline->borrowernumber,,
 155                     accountno         => $accountline->accountno,
 156                     amount            => $accountline->amount,
 157                     description       => $accountline->description,
 158                     accounttype       => $accountline->accounttype,
 159                     amountoutstanding => $accountline->amountoutstanding,
 160                     note              => $accountline->note,
 161                     itemnumber        => $accountline->itemnumber,
 162                     manager_id        => $accountline->manager_id,
 163                 }));
 164             }
 165         }
 166         #add replace cost
 167         if ($replacementprice > 0){
 168             my $accountline = Koha::Account::Line->new(
 169                 {
 170                     borrowernumber    => $borrowernumber,
 171                     issue_id          => $issue_id,
 172                     accountno         => getnextacctno($borrowernumber),
 173                     date              => \'NOW()',
 174                     amount            => $replacementprice,
 175                     description       => $description,
 176                     accounttype       => 'L',
 177                     amountoutstanding => $replacementprice,
 178                     itemnumber        => $itemnumber,
 179                     manager_id        => C4::Context->userenv ? C4::Context->userenv->{'number'} : 0,
 180                 }
 181             )->store();
 182
 183             my $account_offset = Koha::Account::Offset->new(
 184                 {
 185                     debit_id => $accountline->id,
 186                     type     => 'Lost Item',
 187                     amount   => $accountline->amount,
 188                 }
 189             )->store();
 190
 191             if ( C4::Context->preference("FinesLog") ) {
 192                 logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 193                     action            => 'create_fee',
 194                     borrowernumber    => $accountline->borrowernumber,,
 195                     accountno         => $accountline->accountno,
 196                     amount            => $accountline->amount,
 197                     description       => $accountline->description,
 198                     accounttype       => $accountline->accounttype,
 199                     amountoutstanding => $accountline->amountoutstanding,
 200                     note              => $accountline->note,
 201                     itemnumber        => $accountline->itemnumber,
 202                     manager_id        => $accountline->manager_id,
 203                 }));
 204             }
 205         }
 206     }
 207 }
 208
 209 =head2 manualinvoice
 210
 211   &manualinvoice($borrowernumber, $itemnumber, $description, $type,
 212                  $amount, $note);
 213
 214 C<$borrowernumber> is the patron's borrower number.
 215 C<$description> is a description of the transaction.
 216 C<$type> may be one of C<CS>, C<CB>, C<CW>, C<CF>, C<CL>, C<N>, C<L>,
 217 or C<REF>.
 218 C<$itemnumber> is the item involved, if pertinent; otherwise, it
 219 should be the empty string.
 220
 221 =cut
 222
 223 #'
 224 # FIXME: In Koha 3.0 , the only account adjustment 'types' passed to this function
 225 # are:
 226 #               'C' = CREDIT
 227 #               'FOR' = FORGIVEN  (Formerly 'F', but 'F' is taken to mean 'FINE' elsewhere)
 228 #               'N' = New Card fee
 229 #               'F' = Fine
 230 #               'A' = Account Management fee
 231 #               'M' = Sundry
 232 #               'L' = Lost Item
 233 #
 234
 235 sub manualinvoice {
 236     my ( $borrowernumber, $itemnum, $desc, $type, $amount, $note ) = @_;
 237     my $manager_id = 0;
 238     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
 239     my $dbh      = C4::Context->dbh;
 240     my $insert;
 241     my $accountno  = getnextacctno($borrowernumber);
 242     my $amountleft = $amount;
 243
 244     my $accountline = Koha::Account::Line->new(
 245         {
 246             borrowernumber    => $borrowernumber,
 247             accountno         => $accountno,
 248             date              => \'NOW()',
 249             amount            => $amount,
 250             description       => $desc,
 251             accounttype       => $type,
 252             amountoutstanding => $amountleft,
 253             itemnumber        => $itemnum || undef,
 254             note              => $note,
 255             manager_id        => $manager_id,
 256         }
 257     )->store();
 258
 259     my $account_offset = Koha::Account::Offset->new(
 260         {
 261             debit_id => $accountline->id,
 262             type     => 'Manual Debit',
 263             amount   => $amount,
 264         }
 265     )->store();
 266
 267     if ( C4::Context->preference("FinesLog") ) {
 268         logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 269             action            => 'create_fee',
 270             borrowernumber    => $borrowernumber,
 271             accountno         => $accountno,
 272             amount            => $amount,
 273             description       => $desc,
 274             accounttype       => $type,
 275             amountoutstanding => $amountleft,
 276             note              => $note,
 277             itemnumber        => $itemnum,
 278             manager_id        => $manager_id,
 279         }));
 280     }
 281
 282     return 0;
 283 }
 284
 285 =head2 purge_zero_balance_fees
 286
 287   purge_zero_balance_fees( $days );
 288
 289 Delete accountlines entries where amountoutstanding is 0 or NULL which are more than a given number of days old.
 290
 291 B<$days> -- Zero balance fees older than B<$days> days old will be deleted.
 292
 293 B<Warning:> Because fines and payments are not linked in accountlines, it is
 294 possible for a fine to be deleted without the accompanying payment,
 295 or vise versa. This won't affect the account balance, but might be
 296 confusing to staff.
 297
 298 =cut
 299
 300 sub purge_zero_balance_fees {
 301     my $days  = shift;
 302     my $count = 0;
 303
 304     my $dbh = C4::Context->dbh;
 305     my $sth = $dbh->prepare(
 306         q{
 307             DELETE a1 FROM accountlines a1
 308
 309             LEFT JOIN account_offsets credit_offset ON ( a1.accountlines_id = credit_offset.credit_id )
 310             LEFT JOIN accountlines a2 ON ( credit_offset.debit_id = a2.accountlines_id )
 311
 312             LEFT JOIN account_offsets debit_offset ON ( a1.accountlines_id = debit_offset.debit_id )
 313             LEFT JOIN accountlines a3 ON ( debit_offset.credit_id = a3.accountlines_id )
 314
 315             WHERE a1.date < date_sub(curdate(), INTERVAL ? DAY)
 316               AND ( a1.amountoutstanding = 0 OR a1.amountoutstanding IS NULL )
 317               AND ( a2.amountoutstanding = 0 OR a2.amountoutstanding IS NULL )
 318               AND ( a3.amountoutstanding = 0 OR a3.amountoutstanding IS NULL )
 319         }
 320     );
 321     $sth->execute($days) or die $dbh->errstr;
 322 }
 323
 324 END { }    # module clean-up code here (global destructor)
 325
 326 1;
 327 __END__
 328
 329 =head1 SEE ALSO
 330
 331 DBI(3)
 332
 333 =cut
 334