Open-ILS/src/perlmods/OpenILS/Application/Circ/Money.pm

   1 # ---------------------------------------------------------------
   2 # Copyright (C) 2005  Georgia Public Library Service
   3 # Bill Erickson <billserickson@gmail.com>
   4
   5 # This program is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU General Public License
   7 # as published by the Free Software Foundation; either version 2
   8 # of the License, or (at your option) any later version.
   9
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 # ---------------------------------------------------------------
  15
  16
  17 package OpenILS::Application::Circ::Money;
  18 use base qw/OpenSRF::Application/;
  19 use strict; use warnings;
  20 use OpenILS::Application::AppUtils;
  21 my $apputils = "OpenILS::Application::AppUtils";
  22 my $U = "OpenILS::Application::AppUtils";
  23
  24 use OpenSRF::EX qw(:try);
  25 use OpenILS::Perm;
  26 use Data::Dumper;
  27 use OpenSRF::Utils::Logger qw/:logger/;
  28
  29
  30 __PACKAGE__->register_method(
  31         method  => "make_payments",
  32         api_name        => "open-ils.circ.money.payment",
  33         notes           => <<"  NOTE");
  34         Pass in a structure like so:
  35                 {
  36                         cash_drawer: <string>,
  37                         payment_type : <string>,
  38                         note : <string>,
  39                         userid : <id>,
  40                         payments: [
  41                                 [trans_id, amt],
  42                                 [...]
  43                         ],
  44                         patron_credit : <credit amt>
  45                 }
  46         login must have CREATE_PAYMENT priveleges.
  47         If any payments fail, all are reverted back.
  48         NOTE
  49
  50 sub make_payments {
  51
  52         my( $self, $client, $login, $payments ) = @_;
  53
  54         my( $user, $trans, $evt );
  55
  56         ( $user, $evt ) = $apputils->checkses($login);
  57         return $evt if $evt;
  58         $evt = $apputils->check_perms($user->id, $user->home_ou, 'CREATE_PAYMENT');
  59         return $evt if $evt;
  60
  61         $logger->info("Creating payment objects: " . Dumper($payments) );
  62
  63         my $session = $apputils->start_db_session;
  64         my $type                = $payments->{payment_type};
  65         my $credit      = $payments->{patron_credit} || 0;
  66         my $drawer      = $user->wsid;
  67         my $userid      = $payments->{userid};
  68         my $note                = $payments->{note};
  69         my $cc_type = $payments->{cc_type} || 'n/a';
  70         my $cc_number           = $payments->{cc_number} || 'n/a';
  71         my $expire_month        = $payments->{expire_month};
  72         my $expire_year = $payments->{expire_year};
  73         my $approval_code = $payments->{approval_code} || 'n/a';
  74         my $check_number        = $payments->{check_number} || 'n/a';
  75
  76         for my $pay (@{$payments->{payments}}) {
  77
  78                 my $transid = $pay->[0];
  79                 my $amount = $pay->[1];
  80                 ($trans, $evt) = $apputils->fetch_open_billable_transaction($transid);
  81                 return $evt if $evt;
  82
  83                 if($trans->usr != $userid) { # Do we need to restrict this in some way ??
  84                         $logger->info( " * User $userid is making a payment for " .
  85                                 "a different user: " .  $trans->usr . ' for transaction ' . $trans->id  );
  86                 }
  87
  88                 if($type == 'credit_payment') {
  89                         $credit -= $amount;
  90                         $logger->activity("user ".$user->id." reducing patron credit to ".
  91                                 "$credit by making a credit_payment on transaction ".$trans->id);
  92                 }
  93
  94
  95                 # A negative payment is a refund.  If the refund causes the transaction
  96                 # balance to exceed 0 dollars, we are in effect loaning the patron
  97                 # money.  This is not allowed.
  98                 if( $amount < 0 and ($trans->balance_owed - $amount > 0) ) {
  99                         return OpenILS::Event->new('REFUND_EXCEEDS_BALANCE');
 100                 }
 101
 102                 my $payobj = "Fieldmapper::money::$type";
 103                 $payobj = $payobj->new;
 104
 105                 $payobj->amount($amount);
 106                 $payobj->amount_collected($amount);
 107                 $payobj->accepting_usr($user->id);
 108                 $payobj->xact($transid);
 109                 $payobj->note($note);
 110
 111                 if ($payobj->has_field('cash_drawer')) { $payobj->cash_drawer($drawer); }
 112                 if ($payobj->has_field('cc_type')) { $payobj->cc_type($cc_type); }
 113                 if ($payobj->has_field('cc_number')) { $payobj->cc_number($cc_number); }
 114                 if ($payobj->has_field('expire_month')) { $payobj->expire_month($expire_month); }
 115                 if ($payobj->has_field('expire_year')) { $payobj->expire_year($expire_year); }
 116                 if ($payobj->has_field('approval_code')) { $payobj->approval_code($approval_code); }
 117                 if ($payobj->has_field('check_number')) { $payobj->check_number($check_number); }
 118
 119                 # update the transaction if it's done
 120                 if( (my $cred = ($trans->balance_owed - $amount)) <= 0 ) {
 121
 122                         # Any overpay on this transaction goes directly into patron credit
 123                         $cred = -$cred;
 124                         $credit += $cred;
 125                         $logger->activity("user ".$user->id." applying credit ".
 126                                 "of $cred on transaction ".$trans->id. " because of overpayment");
 127
 128                         $logger->debug("Transactin " . $trans->id . ' is complete');
 129                         $trans = $session->request(
 130                                 "open-ils.storage.direct.money.billable_transaction.retrieve", $transid )->gather(1);
 131
 132                         $trans->xact_finish("now");
 133                         my $s = $session->request(
 134                                 "open-ils.storage.direct.money.billable_transaction.update", $trans )->gather(1);
 135
 136                         if(!$s) { throw OpenSRF::EX::ERROR
 137                                 ("Error updating billable_xact in circ.money.payment"); }
 138
 139                 }
 140
 141
 142                 $logger->debug("Creating new $payobj for \$$amount\n");
 143
 144                 my $s = $session->request(
 145                         "open-ils.storage.direct.money.$type.create", $payobj )->gather(1);
 146                 if(!$s) { throw OpenSRF::EX::ERROR ("Error creating new $type"); }
 147
 148         }
 149
 150
 151         $logger->activity("user ".$user->id." applying total ".
 152                 "credit of $credit to user $userid") if $credit != 0;
 153
 154         _update_patron_credit( $session, $userid, $credit );
 155
 156         $apputils->commit_db_session($session);
 157
 158         $client->respond_complete(1);
 159
 160         # ------------------------------------------------------------------------------
 161         # Update the patron penalty info in the DB
 162         # ------------------------------------------------------------------------------
 163         $U->update_patron_penalties(
 164                 authtoken => $login,
 165                 patronid  => $userid,
 166         );
 167
 168         return undef;
 169 }
 170
 171
 172 sub _update_patron_credit {
 173         my( $session, $userid, $credit ) = @_;
 174         #return if $credit <= 0;
 175
 176         my $patron = $session->request(
 177                 'open-ils.storage.direct.actor.user.retrieve', $userid )->gather(1);
 178
 179         $patron->credit_forward_balance(
 180                 $patron->credit_forward_balance + $credit);
 181
 182         $logger->info("Total patron credit for $userid is now " . $patron->credit_forward_balance );
 183
 184         $session->request(
 185                 'open-ils.storage.direct.actor.user.update', $patron )->gather(1);
 186 }
 187
 188
 189 __PACKAGE__->register_method(
 190         method  => "retrieve_payments",
 191         api_name        => "open-ils.circ.money.payment.retrieve.all",
 192         notes           => "Returns a list of payments attached to a given transaction"
 193         );
 194
 195 sub retrieve_payments {
 196         my( $self, $client, $login, $transid ) = @_;
 197
 198         my( $staff, $evt ) =
 199                 $apputils->checksesperm($login, 'VIEW_TRANSACTION');
 200         return $evt if $evt;
 201
 202         # XXX the logic here is wrong.. we need to check the owner of the transaction
 203         # to make sure the requestor has access
 204
 205         return $apputils->simplereq(
 206                 'open-ils.storage',
 207                 'open-ils.storage.direct.money.payment.search.xact.atomic', $transid );
 208 }
 209
 210
 211
 212 __PACKAGE__->register_method(
 213         method  => "create_grocery_bill",
 214         api_name        => "open-ils.circ.money.grocery.create",
 215         notes           => <<"  NOTE");
 216         Creates a new grocery transaction using the transaction object provided
 217         PARAMS: (login_session, money.grocery (mg) object)
 218         NOTE
 219
 220 sub create_grocery_bill {
 221         my( $self, $client, $login, $transaction ) = @_;
 222
 223         my( $staff, $evt ) = $apputils->checkses($login);
 224         return $evt if $evt;
 225         $evt = $apputils->check_perms($staff->id,
 226                 $transaction->billing_location, 'CREATE_TRANSACTION' );
 227         return $evt if $evt;
 228
 229
 230         $logger->activity("Creating grocery bill " . Dumper($transaction) );
 231
 232         $transaction->clear_id;
 233         my $session = $apputils->start_db_session;
 234         my $transid = $session->request(
 235                 'open-ils.storage.direct.money.grocery.create', $transaction)->gather(1);
 236
 237         throw OpenSRF::EX ("Error creating new money.grocery") unless defined $transid;
 238
 239         $logger->debug("Created new grocery transaction $transid");
 240
 241         $apputils->commit_db_session($session);
 242
 243         return $transid;
 244 }
 245
 246 __PACKAGE__->register_method(
 247         method  => "billing_items",
 248         api_name        => "open-ils.circ.money.billing.retrieve.all",
 249         notes           =><<"   NOTE");
 250         Returns a list of billing items for the given transaction.
 251         PARAMS( login, transaction_id )
 252         NOTE
 253
 254 sub billing_items {
 255         my( $self, $client, $login, $transid ) = @_;
 256
 257         my( $trans, $evt ) = $U->fetch_billable_xact($transid);
 258         return $evt if $evt;
 259
 260         my $staff;
 261         ($staff, $evt ) = $apputils->checkses($login);
 262         return $evt if $evt;
 263
 264         if($staff->id ne $trans->usr) {
 265                 $evt = $U->check_perms($staff->id, $staff->home_ou, 'VIEW_TRANSACTION');
 266                 return $evt if $evt;
 267         }
 268
 269         return $apputils->simplereq( 'open-ils.storage',
 270                 'open-ils.storage.direct.money.billing.search.xact.atomic', $transid )
 271 }
 272
 273
 274 __PACKAGE__->register_method(
 275         method  => "billing_items_create",
 276         api_name        => "open-ils.circ.money.billing.create",
 277         notes           =><<"   NOTE");
 278         Creates a new billing line item
 279         PARAMS( login, bill_object (mb) )
 280         NOTE
 281
 282 sub billing_items_create {
 283         my( $self, $client, $login, $billing ) = @_;
 284
 285         my( $staff, $evt ) = $apputils->checksesperm($login, 'CREATE_BILL');
 286         return $evt if $evt;
 287
 288         my $session = $apputils->start_db_session;
 289
 290         my $id = $session->request(
 291                 'open-ils.storage.direct.money.billing.create', $billing )->gather(1);
 292
 293         return $U->DB_UPDATE_FAILED($billing) unless defined $id;
 294
 295         $apputils->commit_db_session($session);
 296
 297         return $id;
 298 }
 299
 300 __PACKAGE__->register_method(
 301         method          =>      'void_bill',
 302         api_name                => 'open-ils.circ.money.billing.void',
 303         signature       => q/
 304                 Voids a bill
 305                 @param authtoken Login session key
 306                 @param billid The id of the bill to void
 307                 @return 1 on success, Event on error
 308         /
 309 );
 310
 311 sub void_bill {
 312         my( $s, $c, $authtoken, $billid ) = @_;
 313
 314         my $reqr;
 315         my( $bill, $evt ) = $U->fetch_bill($billid);
 316         return $evt if $evt;
 317
 318
 319         ($reqr, $evt) = $U->checkses($authtoken);
 320         return $evt if $evt;
 321         $evt = $U->check_perms($reqr->id, $reqr->ws_ou, 'VOID_BILLING');
 322         return $evt if $evt;
 323
 324         $bill->voided('t');
 325         $bill->voider($reqr->id);
 326         $bill->void_time('now');
 327
 328         my $stat = $U->storagereq(
 329                 'open-ils.storage.direct.money.billing.update', $bill);
 330         return $U->DB_UPDATE_FAILED($bill) unless defined $stat;
 331
 332         return 1;
 333 }
 334
 335 __PACKAGE__->register_method (
 336         method => 'fetch_mbts',
 337         api_name => 'open-ils.circ.money.billable_xact_summary.retrieve'
 338 );
 339 sub fetch_mbts {
 340         my($s, $c, $authtoken, $id) = @_;
 341
 342         my $sum = $U->storagereq(
 343                 'open-ils.storage.direct.money.billable_transaction_summary.retrieve', $id );
 344         return OpenILS::Event->new('BILLABLE_XACT_SUMMARY_NOT_FOUND', id => $id) unless $sum;
 345
 346         my ($reqr, $evt) = $U->checkses($authtoken);
 347         return $evt if $evt;
 348
 349         my $usr;
 350         ($usr, $evt) = $U->fetch_user($sum->usr);
 351         return $evt if $evt;
 352
 353         $evt = $U->check_perms($reqr->id, $usr->home_ou, 'VIEW_TRANSACTION');
 354         return $evt if $evt;
 355
 356         return $sum;
 357 }
 358
 359
 360
 361
 362
 363 1;
 364
 365
 366