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 OpenILS::Event;
  28 use OpenSRF::Utils::Logger qw/:logger/;
  29 use OpenILS::Utils::CStoreEditor qw/:funcs/;
  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->ws_ou, 'CREATE_PAYMENT');
  60         return $evt if $evt;
  61
  62         my $e = new_editor(); # at this point, just for convenience
  63
  64         $logger->info("Creating payment objects: " . Dumper($payments) );
  65
  66         my $session = $apputils->start_db_session;
  67         my $type                = $payments->{payment_type};
  68         my $credit      = $payments->{patron_credit} || 0;
  69         my $drawer      = $user->wsid;
  70         my $userid      = $payments->{userid};
  71         my $note                = $payments->{note};
  72         my $cc_type = $payments->{cc_type} || 'n/a';
  73         my $cc_number           = $payments->{cc_number} || 'n/a';
  74         my $expire_month        = $payments->{expire_month};
  75         my $expire_year = $payments->{expire_year};
  76         my $approval_code = $payments->{approval_code} || 'n/a';
  77         my $check_number        = $payments->{check_number} || 'n/a';
  78
  79         my $total_paid = 0;
  80
  81         for my $pay (@{$payments->{payments}}) {
  82
  83                 my $transid = $pay->[0];
  84                 my $amount = $pay->[1];
  85                 $amount =~ s/\$//og; # just to be safe
  86
  87                 $total_paid += $amount;
  88
  89                 $trans = $self->fetch_mbts($client, $login, $transid);
  90                 return $trans if $U->event_code($trans);
  91
  92                 $logger->info("payment: processing transaction [$transid] with balance_owed = ".
  93                         $trans->balance_owed. ",  payment amount = $amount, and payment type = $type");
  94
  95                 if($trans->usr != $userid) { # Do we need to restrict this in some way ??
  96                         $logger->info( " * User $userid is making a payment for " .
  97                                 "a different user: " .  $trans->usr . ' for transaction ' . $trans->id  );
  98                 }
  99
 100                 if($type eq 'credit_payment') {
 101                         $credit -= $amount;
 102                         $logger->activity("user ".$user->id." reducing patron credit by ".
 103                                 "$credit for making a credit_payment on transaction ".$trans->id);
 104                 }
 105
 106                 # A negative payment is a refund.
 107                 if( $amount < 0 ) {
 108
 109                         $logger->info("payment: received a negative payment (refund) of $amount");
 110
 111                         # If the refund causes the transaction balance to exceed 0 dollars,
 112                         # we are in effect loaning the patron money.  This is not allowed.
 113                         if( ($trans->balance_owed - $amount) > 0 ) {
 114                                 return OpenILS::Event->new('REFUND_EXCEEDS_BALANCE');
 115                         }
 116
 117                         # Otherwise, make sure the refund does not exceed desk payments
 118                         # This is also not allowed
 119                         my $desk_total = 0;
 120                         my $desk_payments = $e->search_money_desk_payment(
 121                                 { xact => $transid, voided => 'f' });
 122                         $desk_total += $_->amount for @$desk_payments;
 123
 124                         if( (-$amount) > $desk_total ) {
 125                                 return OpenILS::Event->new(
 126                                         'REFUND_EXCEEDS_DESK_PAYMENTS',
 127                                         payload => { allowed_refund => $desk_total, submitted_refund => -$amount } );
 128                         }
 129                 }
 130
 131                 my $payobj = "Fieldmapper::money::$type";
 132                 $payobj = $payobj->new;
 133
 134                 $payobj->amount($amount);
 135                 $payobj->amount_collected($amount);
 136                 $payobj->accepting_usr($user->id);
 137                 $payobj->xact($transid);
 138                 $payobj->note($note);
 139
 140                 if ($payobj->has_field('cash_drawer')) { $payobj->cash_drawer($drawer); }
 141                 if ($payobj->has_field('cc_type')) { $payobj->cc_type($cc_type); }
 142                 if ($payobj->has_field('cc_number')) { $payobj->cc_number($cc_number); }
 143                 if ($payobj->has_field('expire_month')) { $payobj->expire_month($expire_month); }
 144                 if ($payobj->has_field('expire_year')) { $payobj->expire_year($expire_year); }
 145                 if ($payobj->has_field('approval_code')) { $payobj->approval_code($approval_code); }
 146                 if ($payobj->has_field('check_number')) { $payobj->check_number($check_number); }
 147
 148                 # update the transaction if it's done
 149                 if( (my $cred = ($trans->balance_owed - $amount)) <= 0 ) {
 150
 151                         # Any overpay on this transaction goes directly into patron credit
 152                         $cred = -$cred;
 153
 154                         $logger->info("payment: amount ($amount) exceeds transaction balance of ".
 155                                 $trans->balance_owed.".  Applying patron credit of $cred");
 156
 157                         $credit += $cred;
 158
 159                         $trans = $session->request(
 160                                 "open-ils.storage.direct.money.billable_transaction.retrieve", $transid )->gather(1);
 161
 162                         # If this is a circulation, we can't close the transaction unless stop_fines is set
 163                         my $circ = $session->request(
 164                                 'open-ils.storage.direct.action.circulation.retrieve', $transid )->gather(1);
 165
 166                         if( !$circ || $circ->stop_fines ) {
 167
 168                                 $trans->xact_finish("now");
 169                                 my $s = $session->request(
 170                                         "open-ils.storage.direct.money.billable_transaction.update", $trans )->gather(1);
 171
 172                                 if(!$s) { throw OpenSRF::EX::ERROR
 173                                         ("Error updating billable_xact in circ.money.payment"); }
 174                         }
 175                 }
 176
 177                 my $s = $session->request(
 178                         "open-ils.storage.direct.money.$type.create", $payobj )->gather(1);
 179                 if(!$s) { throw OpenSRF::EX::ERROR ("Error creating new $type"); }
 180
 181         }
 182
 183
 184         my $uid = $user->id;
 185         $logger->info("user $uid applying total ".
 186                 "credit of $credit to user $userid") if $credit != 0;
 187
 188         $logger->info("user $uid applying total payment of $total_paid to user $userid");
 189
 190         $evt = _update_patron_credit( $session, $userid, $credit );
 191         return $evt if $evt;
 192
 193         $apputils->commit_db_session($session);
 194
 195         # ------------------------------------------------------------------------------
 196         # Update the patron penalty info in the DB
 197         # ------------------------------------------------------------------------------
 198         $U->update_patron_penalties(
 199                 authtoken => $login,
 200                 patronid  => $userid,
 201         );
 202
 203         $client->respond_complete(1);
 204
 205         return undef;
 206 }
 207
 208
 209 sub _update_patron_credit {
 210         my( $session, $userid, $credit ) = @_;
 211         #return if $credit <= 0;
 212
 213         my $patron = $session->request(
 214                 'open-ils.storage.direct.actor.user.retrieve', $userid )->gather(1);
 215
 216         $patron->credit_forward_balance(
 217                 $patron->credit_forward_balance + $credit);
 218
 219         if( $patron->credit_forward_balance < 0 ) {
 220                 return OpenILS::Event->new('NEGATIVE_PATRON_BALANCE');
 221         }
 222
 223         $logger->info("Total patron credit for $userid is now " . $patron->credit_forward_balance );
 224
 225         $session->request(
 226                 'open-ils.storage.direct.actor.user.update', $patron )->gather(1);
 227
 228         return undef;
 229 }
 230
 231
 232 __PACKAGE__->register_method(
 233         method  => "retrieve_payments",
 234         api_name        => "open-ils.circ.money.payment.retrieve.all_",
 235         notes           => "Returns a list of payments attached to a given transaction"
 236         );
 237
 238 sub retrieve_payments {
 239         my( $self, $client, $login, $transid ) = @_;
 240
 241         my( $staff, $evt ) =
 242                 $apputils->checksesperm($login, 'VIEW_TRANSACTION');
 243         return $evt if $evt;
 244
 245         # XXX the logic here is wrong.. we need to check the owner of the transaction
 246         # to make sure the requestor has access
 247
 248         # XXX grab the view, for each object in the view, grab the real object
 249
 250         return $apputils->simplereq(
 251                 'open-ils.cstore',
 252                 'open-ils.cstore.direct.money.payment.search.atomic', { xact => $transid } );
 253 }
 254
 255
 256
 257 __PACKAGE__->register_method(
 258         method  => "retrieve_payments2",
 259         api_name        => "open-ils.circ.money.payment.retrieve.all",
 260         notes           => "Returns a list of payments attached to a given transaction"
 261         );
 262
 263 sub retrieve_payments2 {
 264         my( $self, $client, $login, $transid ) = @_;
 265
 266         my $e = new_editor(authtoken=>$login);
 267         return $e->event unless $e->checkauth;
 268         return $e->event unless $e->allowed('VIEW_TRANSACTION');
 269
 270         my @payments;
 271         my $pmnts = $e->search_money_payment({ xact => $transid });
 272         for( @$pmnts ) {
 273                 my $type = $_->payment_type;
 274                 my $meth = "retrieve_money_$type";
 275                 my $p = $e->$meth($_->id) or return $e->event;
 276                 $p->payment_type($type);
 277                 $p->cash_drawer($e->retrieve_actor_workstation($p->cash_drawer))
 278                         if $p->has_field('cash_drawer');
 279                 push( @payments, $p );
 280         }
 281
 282         return \@payments;
 283 }
 284
 285
 286
 287 __PACKAGE__->register_method(
 288         method  => "create_grocery_bill",
 289         api_name        => "open-ils.circ.money.grocery.create",
 290         notes           => <<"  NOTE");
 291         Creates a new grocery transaction using the transaction object provided
 292         PARAMS: (login_session, money.grocery (mg) object)
 293         NOTE
 294
 295 sub create_grocery_bill {
 296         my( $self, $client, $login, $transaction ) = @_;
 297
 298         my( $staff, $evt ) = $apputils->checkses($login);
 299         return $evt if $evt;
 300         $evt = $apputils->check_perms($staff->id,
 301                 $transaction->billing_location, 'CREATE_TRANSACTION' );
 302         return $evt if $evt;
 303
 304
 305         $logger->activity("Creating grocery bill " . Dumper($transaction) );
 306
 307         $transaction->clear_id;
 308         my $session = $apputils->start_db_session;
 309         my $transid = $session->request(
 310                 'open-ils.storage.direct.money.grocery.create', $transaction)->gather(1);
 311
 312         throw OpenSRF::EX ("Error creating new money.grocery") unless defined $transid;
 313
 314         $logger->debug("Created new grocery transaction $transid");
 315
 316         $apputils->commit_db_session($session);
 317
 318         return $transid;
 319 }
 320
 321
 322 __PACKAGE__->register_method(
 323         method => 'fetch_grocery',
 324         api_name => 'open-ils.circ.money.grocery.retrieve'
 325 );
 326
 327 sub fetch_grocery {
 328         my( $self, $conn, $auth, $id ) = @_;
 329         my $e = new_editor(authtoken=>$auth);
 330         return $e->event unless $e->checkauth;
 331         return $e->event unless $e->allowed('VIEW_TRANSACTION'); # eh.. basically the same permission
 332         my $g = $e->retrieve_money_grocery($id)
 333                 or return $e->event;
 334         return $g;
 335 }
 336
 337
 338 __PACKAGE__->register_method(
 339         method  => "billing_items",
 340         api_name        => "open-ils.circ.money.billing.retrieve.all",
 341         notes           =><<"   NOTE");
 342         Returns a list of billing items for the given transaction.
 343         PARAMS( login, transaction_id )
 344         NOTE
 345
 346 sub billing_items {
 347         my( $self, $client, $login, $transid ) = @_;
 348
 349         my( $trans, $evt ) = $U->fetch_billable_xact($transid);
 350         return $evt if $evt;
 351
 352         my $staff;
 353         ($staff, $evt ) = $apputils->checkses($login);
 354         return $evt if $evt;
 355
 356         if($staff->id ne $trans->usr) {
 357                 $evt = $U->check_perms($staff->id, $staff->home_ou, 'VIEW_TRANSACTION');
 358                 return $evt if $evt;
 359         }
 360
 361         return $apputils->simplereq( 'open-ils.cstore',
 362                 'open-ils.cstore.direct.money.billing.search.atomic', { xact => $transid } )
 363 }
 364
 365
 366 __PACKAGE__->register_method(
 367         method  => "billing_items_create",
 368         api_name        => "open-ils.circ.money.billing.create",
 369         notes           =><<"   NOTE");
 370         Creates a new billing line item
 371         PARAMS( login, bill_object (mb) )
 372         NOTE
 373
 374 sub billing_items_create {
 375         my( $self, $client, $login, $billing ) = @_;
 376
 377         my $e = new_editor(authtoken => $login, xact => 1);
 378         return $e->event unless $e->checkauth;
 379         return $e->event unless $e->allowed('CREATE_BILL');
 380
 381         my $xact = $e->retrieve_money_billable_transaction($billing->xact)
 382                 or return $e->event;
 383
 384         # if the transaction was closed, re-open it
 385         if($xact->xact_finish) {
 386                 $xact->clear_xact_finish;
 387                 $e->update_money_billable_transaction($xact)
 388                         or return $e->event;
 389         }
 390
 391         my $amt = $billing->amount;
 392         $amt =~ s/\$//og;
 393         $billing->amount($amt);
 394
 395         $e->create_money_billing($billing) or return $e->event;
 396         $e->commit;
 397
 398         # ------------------------------------------------------------------------------
 399         # Update the patron penalty info in the DB
 400         # ------------------------------------------------------------------------------
 401         $U->update_patron_penalties(
 402                 authtoken => $login,
 403                 patronid  => $xact->usr,
 404         );
 405
 406         return $billing->id;
 407 }
 408
 409 __PACKAGE__->register_method(
 410         method          =>      'void_bill',
 411         api_name                => 'open-ils.circ.money.billing.void',
 412         signature       => q/
 413                 Voids a bill
 414                 @param authtoken Login session key
 415                 @param billid The id of the bill to void
 416                 @return 1 on success, Event on error
 417         /
 418 );
 419
 420
 421 sub void_bill {
 422         my( $s, $c, $authtoken, @billids ) = @_;
 423
 424         my $e = new_editor( authtoken => $authtoken, xact => 1 );
 425         return $e->event unless $e->checkauth;
 426         return $e->event unless $e->allowed('VOID_BILLING');
 427
 428     my %users;
 429     for my $billid (@billids) {
 430
 431             my $bill = $e->retrieve_money_billing($billid)
 432                     or return $e->event;
 433
 434         my $xact = $e->retrieve_money_billable_transaction($bill->xact)
 435             or return $e->event;
 436
 437         $users{$xact->usr} = 1;
 438
 439             return OpenILS::Event->new('BILL_ALREADY_VOIDED', payload => $bill)
 440                     if $bill->voided and $bill->voided =~ /t/io;
 441
 442             $bill->voided('t');
 443             $bill->voider($e->requestor->id);
 444             $bill->void_time('now');
 445
 446             $e->update_money_billing($bill) or return $e->event;
 447             my $evt = _check_open_xact($e, $bill->xact, $xact);
 448             return $evt if $evt;
 449     }
 450
 451         $e->commit;
 452     # update the penalties for each affected user
 453         $U->update_patron_penalties( authtoken => $authtoken, patronid  => $_ ) for keys %users;
 454         return 1;
 455 }
 456
 457
 458 sub _check_open_xact {
 459         my( $editor, $xactid, $xact ) = @_;
 460
 461         # Grab the transaction
 462         $xact ||= $editor->retrieve_money_billable_transaction($xactid);
 463     return $editor->event unless $xact;
 464     $xactid ||= $xact->id;
 465
 466         # grab the summary and see how much is owed on this transaction
 467         my ($summary) = $U->fetch_mbts($xactid, $editor);
 468
 469         # grab the circulation if it is a circ;
 470         my $circ = $editor->retrieve_action_circulation($xactid);
 471
 472         # If nothing is owed on the transaction but it is still open
 473         # and this transaction is not an open circulation, close it
 474         if(
 475                 ( $summary->balance_owed == 0 and ! $xact->xact_finish ) and
 476                 ( !$circ or $circ->stop_fines )) {
 477
 478                 $logger->info("closing transaction ".$xact->id. ' becauase balance_owed == 0');
 479                 $xact->xact_finish('now');
 480                 $editor->update_money_billable_transaction($xact)
 481                         or return $editor->event;
 482                 return undef;
 483         }
 484
 485         # If money is owed or a refund is due on the xact and xact_finish
 486         # is set, clear it (to reopen the xact) and update
 487         if( $summary->balance_owed != 0 and $xact->xact_finish ) {
 488                 $logger->info("re-opening transaction ".$xact->id. ' becauase balance_owed != 0');
 489                 $xact->clear_xact_finish;
 490                 $editor->update_money_billable_transaction($xact)
 491                         or return $editor->event;
 492                 return undef;
 493         }
 494
 495         return undef;
 496 }
 497
 498
 499
 500 __PACKAGE__->register_method (
 501         method => 'fetch_mbts',
 502         api_name => 'open-ils.circ.money.billable_xact_summary.retrieve'
 503 );
 504 sub fetch_mbts {
 505         my( $self, $conn, $auth, $id) = @_;
 506
 507         my $e = new_editor(xact => 1, authtoken=>$auth);
 508         return $e->event unless $e->checkauth;
 509         my ($mbts) = $U->fetch_mbts($id, $e);
 510
 511         my $user = $e->retrieve_actor_user($mbts->usr)
 512                 or return $e->die_event;
 513
 514         return $e->die_event unless $e->allowed('VIEW_TRANSACTION', $user->home_ou);
 515         $e->rollback;
 516         return $mbts
 517 }
 518
 519
 520
 521 __PACKAGE__->register_method(
 522         method => 'desk_payments',
 523         api_name => 'open-ils.circ.money.org_unit.desk_payments'
 524 );
 525
 526 sub desk_payments {
 527         my( $self, $conn, $auth, $org, $start_date, $end_date ) = @_;
 528         my $e = new_editor(authtoken=>$auth);
 529         return $e->event unless $e->checkauth;
 530         return $e->event unless $e->allowed('VIEW_TRANSACTION', $org);
 531         my $data = $U->storagereq(
 532                 'open-ils.storage.money.org_unit.desk_payments.atomic',
 533                 $org, $start_date, $end_date );
 534
 535         $_->workstation( $_->workstation->name ) for(@$data);
 536         return $data;
 537 }
 538
 539
 540 __PACKAGE__->register_method(
 541         method => 'user_payments',
 542         api_name => 'open-ils.circ.money.org_unit.user_payments'
 543 );
 544
 545 sub user_payments {
 546         my( $self, $conn, $auth, $org, $start_date, $end_date ) = @_;
 547         my $e = new_editor(authtoken=>$auth);
 548         return $e->event unless $e->checkauth;
 549         return $e->event unless $e->allowed('VIEW_TRANSACTION', $org);
 550         my $data = $U->storagereq(
 551                 'open-ils.storage.money.org_unit.user_payments.atomic',
 552                 $org, $start_date, $end_date );
 553         for(@$data) {
 554                 $_->usr->card(
 555                         $e->retrieve_actor_card($_->usr->card)->barcode);
 556                 $_->usr->home_ou(
 557                         $e->retrieve_actor_org_unit($_->usr->home_ou)->shortname);
 558         }
 559         return $data;
 560 }
 561
 562
 563
 564
 565 1;
 566
 567
 568