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 use OpenILS::Event;
  29 use OpenILS::Utils::Editor;
  30
  31 __PACKAGE__->register_method(
  32         method  => "make_payments",
  33         api_name        => "open-ils.circ.money.payment",
  34         notes           => <<"  NOTE");
  35         Pass in a structure like so:
  36                 {
  37                         cash_drawer: <string>,
  38                         payment_type : <string>,
  39                         note : <string>,
  40                         userid : <id>,
  41                         payments: [
  42                                 [trans_id, amt],
  43                                 [...]
  44                         ],
  45                         patron_credit : <credit amt>
  46                 }
  47         login must have CREATE_PAYMENT priveleges.
  48         If any payments fail, all are reverted back.
  49         NOTE
  50
  51 sub make_payments {
  52
  53         my( $self, $client, $login, $payments ) = @_;
  54
  55         my( $user, $trans, $evt );
  56
  57         ( $user, $evt ) = $apputils->checkses($login);
  58         return $evt if $evt;
  59         $evt = $apputils->check_perms($user->id, $user->home_ou, 'CREATE_PAYMENT');
  60         return $evt if $evt;
  61
  62         $logger->info("Creating payment objects: " . Dumper($payments) );
  63
  64         my $session = $apputils->start_db_session;
  65         my $type                = $payments->{payment_type};
  66         my $credit      = $payments->{patron_credit} || 0;
  67         my $drawer      = $user->wsid;
  68         my $userid      = $payments->{userid};
  69         my $note                = $payments->{note};
  70         my $cc_type = $payments->{cc_type} || 'n/a';
  71         my $cc_number           = $payments->{cc_number} || 'n/a';
  72         my $expire_month        = $payments->{expire_month};
  73         my $expire_year = $payments->{expire_year};
  74         my $approval_code = $payments->{approval_code} || 'n/a';
  75         my $check_number        = $payments->{check_number} || 'n/a';
  76
  77         for my $pay (@{$payments->{payments}}) {
  78
  79                 my $transid = $pay->[0];
  80                 my $amount = $pay->[1];
  81                 ($trans, $evt) = $apputils->fetch_open_billable_transaction($transid);
  82                 return $evt if $evt;
  83
  84                 if($trans->usr != $userid) { # Do we need to restrict this in some way ??
  85                         $logger->info( " * User $userid is making a payment for " .
  86                                 "a different user: " .  $trans->usr . ' for transaction ' . $trans->id  );
  87                 }
  88
  89                 if($type eq 'credit_payment') {
  90                         $credit -= $amount;
  91                         $logger->activity("user ".$user->id." reducing patron credit by ".
  92                                 "$credit for making a credit_payment on transaction ".$trans->id);
  93                 }
  94
  95
  96                 # A negative payment is a refund.  If the refund causes the transaction
  97                 # balance to exceed 0 dollars, we are in effect loaning the patron
  98                 # money.  This is not allowed.
  99                 if( $amount < 0 and ($trans->balance_owed - $amount > 0) ) {
 100                         return OpenILS::Event->new('REFUND_EXCEEDS_BALANCE');
 101                 }
 102
 103                 my $payobj = "Fieldmapper::money::$type";
 104                 $payobj = $payobj->new;
 105
 106                 $payobj->amount($amount);
 107                 $payobj->amount_collected($amount);
 108                 $payobj->accepting_usr($user->id);
 109                 $payobj->xact($transid);
 110                 $payobj->note($note);
 111
 112                 if ($payobj->has_field('cash_drawer')) { $payobj->cash_drawer($drawer); }
 113                 if ($payobj->has_field('cc_type')) { $payobj->cc_type($cc_type); }
 114                 if ($payobj->has_field('cc_number')) { $payobj->cc_number($cc_number); }
 115                 if ($payobj->has_field('expire_month')) { $payobj->expire_month($expire_month); }
 116                 if ($payobj->has_field('expire_year')) { $payobj->expire_year($expire_year); }
 117                 if ($payobj->has_field('approval_code')) { $payobj->approval_code($approval_code); }
 118                 if ($payobj->has_field('check_number')) { $payobj->check_number($check_number); }
 119
 120                 # update the transaction if it's done
 121                 if( (my $cred = ($trans->balance_owed - $amount)) <= 0 ) {
 122
 123                         # Any overpay on this transaction goes directly into patron credit
 124                         $cred = -$cred;
 125                         $credit += $cred;
 126                         $logger->activity("user ".$user->id." applying credit ".
 127                                 "of $cred on transaction ".$trans->id. " because of overpayment");
 128
 129                         $logger->debug("Transactin " . $trans->id . ' is complete');
 130                         $trans = $session->request(
 131                                 "open-ils.storage.direct.money.billable_transaction.retrieve", $transid )->gather(1);
 132
 133                         $trans->xact_finish("now");
 134                         my $s = $session->request(
 135                                 "open-ils.storage.direct.money.billable_transaction.update", $trans )->gather(1);
 136
 137                         if(!$s) { throw OpenSRF::EX::ERROR
 138                                 ("Error updating billable_xact in circ.money.payment"); }
 139
 140                 }
 141
 142
 143                 $logger->debug("Creating new $payobj for \$$amount\n");
 144
 145                 my $s = $session->request(
 146                         "open-ils.storage.direct.money.$type.create", $payobj )->gather(1);
 147                 if(!$s) { throw OpenSRF::EX::ERROR ("Error creating new $type"); }
 148
 149         }
 150
 151
 152         $logger->activity("user ".$user->id." applying total ".
 153                 "credit of $credit to user $userid") if $credit != 0;
 154
 155         $evt = _update_patron_credit( $session, $userid, $credit );
 156         return $evt if $evt;
 157
 158         $apputils->commit_db_session($session);
 159
 160         $client->respond_complete(1);
 161
 162         # ------------------------------------------------------------------------------
 163         # Update the patron penalty info in the DB
 164         # ------------------------------------------------------------------------------
 165         $U->update_patron_penalties(
 166                 authtoken => $login,
 167                 patronid  => $userid,
 168         );
 169
 170         return undef;
 171 }
 172
 173
 174 sub _update_patron_credit {
 175         my( $session, $userid, $credit ) = @_;
 176         #return if $credit <= 0;
 177
 178         my $patron = $session->request(
 179                 'open-ils.storage.direct.actor.user.retrieve', $userid )->gather(1);
 180
 181         $patron->credit_forward_balance(
 182                 $patron->credit_forward_balance + $credit);
 183
 184         if( $patron->credit_forward_balance < 0 ) {
 185                 return OpenILS::Event->new('NEGATIVE_PATRON_BALANCE');
 186         }
 187
 188         $logger->info("Total patron credit for $userid is now " . $patron->credit_forward_balance );
 189
 190         $session->request(
 191                 'open-ils.storage.direct.actor.user.update', $patron )->gather(1);
 192
 193         return undef;
 194 }
 195
 196
 197 __PACKAGE__->register_method(
 198         method  => "retrieve_payments",
 199         api_name        => "open-ils.circ.money.payment.retrieve.all",
 200         notes           => "Returns a list of payments attached to a given transaction"
 201         );
 202
 203 sub retrieve_payments {
 204         my( $self, $client, $login, $transid ) = @_;
 205
 206         my( $staff, $evt ) =
 207                 $apputils->checksesperm($login, 'VIEW_TRANSACTION');
 208         return $evt if $evt;
 209
 210         # XXX the logic here is wrong.. we need to check the owner of the transaction
 211         # to make sure the requestor has access
 212
 213         return $apputils->simplereq(
 214                 'open-ils.storage',
 215                 'open-ils.storage.direct.money.payment.search.xact.atomic', $transid );
 216 }
 217
 218
 219
 220 __PACKAGE__->register_method(
 221         method  => "create_grocery_bill",
 222         api_name        => "open-ils.circ.money.grocery.create",
 223         notes           => <<"  NOTE");
 224         Creates a new grocery transaction using the transaction object provided
 225         PARAMS: (login_session, money.grocery (mg) object)
 226         NOTE
 227
 228 sub create_grocery_bill {
 229         my( $self, $client, $login, $transaction ) = @_;
 230
 231         my( $staff, $evt ) = $apputils->checkses($login);
 232         return $evt if $evt;
 233         $evt = $apputils->check_perms($staff->id,
 234                 $transaction->billing_location, 'CREATE_TRANSACTION' );
 235         return $evt if $evt;
 236
 237
 238         $logger->activity("Creating grocery bill " . Dumper($transaction) );
 239
 240         $transaction->clear_id;
 241         my $session = $apputils->start_db_session;
 242         my $transid = $session->request(
 243                 'open-ils.storage.direct.money.grocery.create', $transaction)->gather(1);
 244
 245         throw OpenSRF::EX ("Error creating new money.grocery") unless defined $transid;
 246
 247         $logger->debug("Created new grocery transaction $transid");
 248
 249         $apputils->commit_db_session($session);
 250
 251         return $transid;
 252 }
 253
 254 __PACKAGE__->register_method(
 255         method  => "billing_items",
 256         api_name        => "open-ils.circ.money.billing.retrieve.all",
 257         notes           =><<"   NOTE");
 258         Returns a list of billing items for the given transaction.
 259         PARAMS( login, transaction_id )
 260         NOTE
 261
 262 sub billing_items {
 263         my( $self, $client, $login, $transid ) = @_;
 264
 265         my( $trans, $evt ) = $U->fetch_billable_xact($transid);
 266         return $evt if $evt;
 267
 268         my $staff;
 269         ($staff, $evt ) = $apputils->checkses($login);
 270         return $evt if $evt;
 271
 272         if($staff->id ne $trans->usr) {
 273                 $evt = $U->check_perms($staff->id, $staff->home_ou, 'VIEW_TRANSACTION');
 274                 return $evt if $evt;
 275         }
 276
 277         return $apputils->simplereq( 'open-ils.storage',
 278                 'open-ils.storage.direct.money.billing.search.xact.atomic', $transid )
 279 }
 280
 281
 282 __PACKAGE__->register_method(
 283         method  => "billing_items_create",
 284         api_name        => "open-ils.circ.money.billing.create",
 285         notes           =><<"   NOTE");
 286         Creates a new billing line item
 287         PARAMS( login, bill_object (mb) )
 288         NOTE
 289
 290 sub billing_items_create {
 291         my( $self, $client, $login, $billing ) = @_;
 292
 293         my( $staff, $evt ) = $apputils->checksesperm($login, 'CREATE_BILL');
 294         return $evt if $evt;
 295
 296         my $session = $apputils->start_db_session;
 297
 298         my $id = $session->request(
 299                 'open-ils.storage.direct.money.billing.create', $billing )->gather(1);
 300
 301         return $U->DB_UPDATE_FAILED($billing) unless defined $id;
 302
 303         $apputils->commit_db_session($session);
 304
 305         return $id;
 306 }
 307
 308 __PACKAGE__->register_method(
 309         method          =>      'void_bill',
 310         api_name                => 'open-ils.circ.money.billing.void',
 311         signature       => q/
 312                 Voids a bill
 313                 @param authtoken Login session key
 314                 @param billid The id of the bill to void
 315                 @return 1 on success, Event on error
 316         /
 317 );
 318
 319 sub void_bill {
 320         my( $s, $c, $authtoken, $billid ) = @_;
 321
 322         my $e = OpenILS::Utils::Editor->new( authtoken => $authtoken );
 323         return $e->event unless $e->checkauth;
 324         return $e->event unless $e->allowed('VOID_BILLING');
 325
 326         my $bill = $e->retrieve_money_billing($billid)
 327                 or return $e->event;
 328
 329         return OpenILS::Event->new('BILL_ALREADY_VOIDED', payload => $bill)
 330                 if $bill->voided and $bill->voided =~ /t/io;
 331
 332         $bill->voided('t');
 333         $bill->voider($e->requestor->id);
 334         $bill->void_time('now');
 335
 336         $e->update_money_billing($bill) or return $e->event;
 337         my $evt = _check_open_xact($e, $bill->xact);
 338         return $evt if $evt;
 339
 340         $e->finish;
 341         return 1;
 342 }
 343
 344 sub _check_open_xact {
 345         my( $editor, $xactid ) = @_;
 346
 347         # Grab the transaction
 348         my $xact = $editor->retrieve_money_billable_transaction($xactid)
 349                 or return $editor->event;
 350
 351         # if it's still open, good.
 352         return undef unless $xact->xact_finish;
 353
 354         $logger->info("re-opening transaction ".$xact->id);
 355         my $finish = $xact->xact_finish;
 356
 357         # clear the transaction finish time
 358         $xact->clear_xact_finish;
 359         $editor->update_money_billable_transaction($xact);
 360
 361         # grab the summary and see how much is owed on this transaction
 362         my $summary = $editor->retrieve_money_open_billable_transaction_summary($xactid)
 363                 or return $editor->event;
 364
 365         if( $summary->balance_owed == 0 ) {
 366                 # if nothing is owed, re-close the transaction
 367                 $xact->xact_finish($finish);
 368                 $editor->update_money_billable_transaction($xact);
 369         }
 370
 371         return undef;
 372 }
 373
 374 __PACKAGE__->register_method (
 375         method => 'fetch_mbts',
 376         api_name => 'open-ils.circ.money.billable_xact_summary.retrieve'
 377 );
 378 sub fetch_mbts {
 379         my($s, $c, $authtoken, $id) = @_;
 380
 381         my $sum = $U->storagereq(
 382                 'open-ils.storage.direct.money.billable_transaction_summary.retrieve', $id );
 383         return OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_SUMMARY_NOT_FOUND', id => $id) unless $sum;
 384
 385         my ($reqr, $evt) = $U->checkses($authtoken);
 386         return $evt if $evt;
 387
 388         my $usr;
 389         ($usr, $evt) = $U->fetch_user($sum->usr);
 390         return $evt if $evt;
 391
 392         $evt = $U->check_perms($reqr->id, $usr->home_ou, 'VIEW_TRANSACTION');
 393         return $evt if $evt;
 394
 395         return $sum;
 396 }
 397
 398
 399
 400
 401
 402 1;
 403
 404
 405