1 # ---------------------------------------------------------------
2 # Copyright (C) 2005 Georgia Public Library Service
3 # Bill Erickson <billserickson@gmail.com>
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.
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 # ---------------------------------------------------------------
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";
23 use OpenSRF::EX qw(:try);
26 use OpenSRF::Utils::Logger qw/:logger/;
29 __PACKAGE__->register_method(
30 method => "make_payments",
31 api_name => "open-ils.circ.money.payment",
33 Pass in a structure like so:
35 cash_drawer: <string>,
36 payment_type : <string>,
43 patron_credit : <credit amt>
45 login must have CREATE_PAYMENT priveleges.
46 If any payments fail, all are reverted back.
51 my( $self, $client, $login, $payments ) = @_;
53 my( $user, $trans, $evt );
55 ( $user, $evt ) = $apputils->checkses($login);
57 $evt = $apputils->check_perms($user->id, $user->home_ou, 'CREATE_PAYMENT');
60 $logger->activity("Creating payment objects: " . Dumper($payments) );
62 my $session = $apputils->start_db_session;
63 my $type = $payments->{payment_type};
64 my $credit = $payments->{patron_credit};
65 my $drawer = $payments->{cash_drawer};
66 my $userid = $payments->{userid};
67 my $note = $payments->{note};
68 my $cc_type = $payments->{cc_type} || 'n/a';
69 my $cc_number = $payments->{cc_number} || 'n/a';
70 my $expire_month = $payments->{expire_month};
71 my $expire_year = $payments->{expire_year};
72 my $approval_code = $payments->{approval_code} || 'n/a';
73 my $check_number = $payments->{check_number} || 'n/a';
75 for my $pay (@{$payments->{payments}}) {
77 my $transid = $pay->[0];
78 my $amount = $pay->[1];
79 ($trans, $evt) = $apputils->fetch_open_billable_transaction($transid);
82 if($trans->usr != $userid) { # Do we need to restrict this in some way ??
83 $logger->info( " * User $userid is making a payment for " .
84 "a different user: " . $trans->usr . ' for transaction ' . $trans->id );
87 my $payobj = "Fieldmapper::money::$type";
88 $payobj = $payobj->new;
90 $payobj->amount($amount);
91 $payobj->amount_collected($amount);
92 $payobj->accepting_usr($user->id);
93 $payobj->xact($transid);
95 if ($payobj->has_field('cash_drawer')) { $payobj->cash_drawer($drawer); }
96 if ($payobj->has_field('cc_type')) { $payobj->cc_type($cc_type); }
97 if ($payobj->has_field('cc_number')) { $payobj->cc_number($cc_number); }
98 if ($payobj->has_field('expire_month')) { $payobj->expire_month($expire_month); }
99 if ($payobj->has_field('expire_year')) { $payobj->expire_year($expire_year); }
100 if ($payobj->has_field('approval_code')) { $payobj->approval_code($approval_code); }
101 if ($payobj->has_field('check_number')) { $payobj->check_number($check_number); }
103 # update the transaction if it's done
104 if( ($trans->balance_owed - $amount) <= 0 ) {
106 $logger->debug("Transactin " . $trans->id . ' is complete');
107 $trans = $session->request(
108 "open-ils.storage.direct.money.billable_transaction.retrieve", $transid )->gather(1);
110 $trans->xact_finish("now");
111 my $s = $session->request(
112 "open-ils.storage.direct.money.billable_transaction.update", $trans )->gather(1);
114 if(!$s) { throw OpenSRF::EX::ERROR
115 ("Error updating billable_xact in circ.money.payment"); }
119 $logger->debug("Creating new $payobj for \$$amount\n");
121 my $s = $session->request(
122 "open-ils.storage.direct.money.$type.create", $payobj )->gather(1);
123 if(!$s) { throw OpenSRF::EX::ERROR ("Error creating new $type"); }
127 _update_patron_credit( $session, $userid, $credit );
129 $apputils->commit_db_session($session);
134 sub _update_patron_credit {
135 my( $session, $userid, $credit ) = @_;
136 return if $credit <= 0;
138 my $patron = $session->request(
139 'open-ils.storage.direct.actor.user.retrieve', $userid )->gather(1);
141 $logger->activity( "Adding to patron [$userid] credit: $credit" );
143 $patron->credit_forward_balance(
144 $patron->credit_forward_balance + $credit);
146 $logger->debug("Total patron credit is now " . $patron->credit_forward_balance );
148 my $res = $session->request(
149 'open-ils.storage.direct.actor.user.update', $patron )->gather(1);
152 throw OpenSRF::EX("Error updating patron credit");
157 __PACKAGE__->register_method(
158 method => "retrieve_payments",
159 api_name => "open-ils.circ.money.payment.retrieve.all",
160 notes => "Returns a list of payments attached to a given transaction"
163 sub retrieve_payments {
164 my( $self, $client, $login, $transid ) = @_;
167 $apputils->checksesperm($login, 'VIEW_TRANSACTION');
170 # XXX the logic here is wrong.. we need to check the owner of the transaction
171 # to make sure the requestor has access
173 return $apputils->simplereq(
175 'open-ils.storage.direct.money.payment.search.xact.atomic', $transid );
180 __PACKAGE__->register_method(
181 method => "create_grocery_bill",
182 api_name => "open-ils.circ.money.grocery.create",
184 Creates a new grocery transaction using the transaction object provided
185 PARAMS: (login_session, money.grocery (mg) object)
188 sub create_grocery_bill {
189 my( $self, $client, $login, $transaction ) = @_;
191 my( $staff, $evt ) = $apputils->checkses($login);
193 $evt = $apputils->check_perms($staff->id,
194 $transaction->billing_location, 'CREATE_TRANSACTION' );
198 $logger->activity("Creating grocery bill " . Dumper($transaction) );
200 $transaction->clear_id;
201 my $session = $apputils->start_db_session;
202 my $transid = $session->request(
203 'open-ils.storage.direct.money.grocery.create', $transaction)->gather(1);
205 throw OpenSRF::EX ("Error creating new money.grocery") unless defined $transid;
207 $logger->debug("Created new grocery transaction $transid");
209 $apputils->commit_db_session($session);
214 __PACKAGE__->register_method(
215 method => "billing_items",
216 api_name => "open-ils.circ.money.billing.retrieve.all",
218 Returns a list of billing items for the given transaction.
219 PARAMS( login, transaction_id )
223 my( $self, $client, $login, $transid ) = @_;
225 my( $staff, $evt ) = $apputils->checksesperm($login, 'VIEW_TRANSACTION');
228 # we need to grab the transaction by id and check the billing location
229 # to determin the permissibility XXX
231 # $evt = $apputils->check_perms($staff->id,
232 # $transaction->billing_location, 'VIEW_TRANSACTION' );
233 # return $evt if $evt;
235 return $apputils->simplereq( 'open-ils.storage',
236 'open-ils.storage.direct.money.billing.search.xact.atomic', $transid )
241 __PACKAGE__->register_method(
242 method => "billing_items_create",
243 api_name => "open-ils.circ.money.billing.create",
245 Creates a new billing line item
246 PARAMS( login, bill_object (mb) )
249 sub billing_items_create {
250 my( $self, $client, $login, $billing ) = @_;
252 my( $staff, $evt ) = $apputils->checksesperm($login, 'CREATE_BILL');
255 my $session = $apputils->start_db_session;
257 my $id = $session->request(
258 'open-ils.storage.direct.money.billing.create', $billing )->gather(1);
260 throw OpenSRF::EX ("Error creating new bill") unless defined $id;
262 $apputils->commit_db_session($session);