]> git.evergreen-ils.org Git - Evergreen.git/blob - Open-ILS/src/perlmods/OpenILS/Application/Circ/Money.pm
more fields for credit card payments
[Evergreen.git] / 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
23 use OpenSRF::EX qw(:try);
24 use OpenILS::Perm;
25 use Data::Dumper;
26 use OpenSRF::Utils::Logger qw/:logger/;
27
28
29 __PACKAGE__->register_method(
30         method  => "make_payments",
31         api_name        => "open-ils.circ.money.payment",
32         notes           => <<"  NOTE");
33         Pass in a structure like so:
34                 { 
35                         cash_drawer: <string>, 
36                         payment_type : <string>, 
37                         note : <string>, 
38                         userid : <id>,
39                         payments: [ 
40                                 [trans_id, amt], 
41                                 [...]
42                         ], 
43                         patron_credit : <credit amt> 
44                 }
45         login must have CREATE_PAYMENT priveleges.
46         If any payments fail, all are reverted back.
47         NOTE
48
49 sub make_payments {
50
51         my( $self, $client, $login, $payments ) = @_;
52
53         my( $user, $trans, $evt );
54
55         ( $user, $evt ) = $apputils->checkses($login);
56         return $evt if $evt;
57         $evt = $apputils->check_perms($user->id, $user->home_ou, 'CREATE_PAYMENT');
58         return $evt if $evt;
59
60         $logger->activity("Creating payment objects: " . Dumper($payments) );
61
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';
74
75         for my $pay (@{$payments->{payments}}) {
76
77                 my $transid = $pay->[0];
78                 my $amount = $pay->[1];
79                 ($trans, $evt) = $apputils->fetch_open_billable_transaction($transid);
80                 return $evt if $evt;
81
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  );
85                 }
86
87                 my $payobj = "Fieldmapper::money::$type";
88                 $payobj = $payobj->new;
89
90                 $payobj->amount($amount);
91                 $payobj->amount_collected($amount);
92                 $payobj->accepting_usr($user->id);
93                 $payobj->xact($transid);
94                 $payobj->note($note);
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);
102                 
103                 # update the transaction if it's done 
104                 if( ($trans->balance_owed - $amount) <= 0 ) {
105
106                         $logger->debug("Transactin " . $trans->id . ' is complete');
107                         $trans = $session->request(
108                                 "open-ils.storage.direct.money.billable_transaction.retrieve", $transid )->gather(1);
109
110                         $trans->xact_finish("now");
111                         my $s = $session->request(
112                                 "open-ils.storage.direct.money.billable_transaction.update", $trans )->gather(1);
113
114                         if(!$s) { throw OpenSRF::EX::ERROR 
115                                 ("Error updating billable_xact in circ.money.payment"); }
116                                         
117                 }
118
119                 $logger->debug("Creating new $payobj for \$$amount\n");
120
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"); }
124
125         }
126
127         _update_patron_credit( $session, $userid, $credit );
128
129         $apputils->commit_db_session($session);
130         return 1;
131                 
132 }
133
134 sub _update_patron_credit {
135         my( $session, $userid, $credit ) = @_;
136         return if $credit < 0;
137
138         my $patron = $session->request( 
139                 'open-ils.storage.direct.actor.user.retrieve', $userid )->gather(1);
140
141         $patron->credit_forward_balance( 
142                 $patron->credit_forward_balance + $credit);
143
144         my $res = $session->request(
145                 'open-ils.storage.direct.actor.user.update', $patron )->gather(1);
146
147         if(!$res) {
148                 throw OpenSRF::EX("Error updating patron credit");
149         }
150 }
151
152
153 __PACKAGE__->register_method(
154         method  => "retrieve_payments",
155         api_name        => "open-ils.circ.money.payment.retrieve.all",
156         notes           => "Returns a list of payments attached to a given transaction"
157         );
158         
159 sub retrieve_payments {
160         my( $self, $client, $login, $transid ) = @_;
161
162         my( $staff, $evt ) =  
163                 $apputils->checksesperm($login, 'VIEW_TRANSACTION');
164         return $evt if $evt;
165
166         # XXX the logic here is wrong.. we need to check the owner of the transaction
167         # to make sure the requestor has access
168
169         return $apputils->simplereq(
170                 'open-ils.storage',
171                 'open-ils.storage.direct.money.payment.search.xact.atomic', $transid );
172 }
173
174
175
176 __PACKAGE__->register_method(
177         method  => "create_grocery_bill",
178         api_name        => "open-ils.circ.money.grocery.create",
179         notes           => <<"  NOTE");
180         Creates a new grocery transaction using the transaction object provided
181         PARAMS: (login_session, money.grocery (mg) object)
182         NOTE
183
184 sub create_grocery_bill {
185         my( $self, $client, $login, $transaction ) = @_;
186
187         my( $staff, $evt ) = $apputils->checkses($login);
188         return $evt if $evt;
189         $evt = $apputils->check_perms($staff->id, 
190                 $transaction->billing_location, 'CREATE_TRANSACTION' );
191         return $evt if $evt;
192
193
194         $logger->activity("Creating grocery bill " . Dumper($transaction) );
195
196         $transaction->clear_id;
197         my $session = $apputils->start_db_session;
198         my $transid = $session->request(
199                 'open-ils.storage.direct.money.grocery.create', $transaction)->gather(1);
200
201         throw OpenSRF::EX ("Error creating new money.grocery") unless defined $transid;
202
203         $logger->debug("Created new grocery transaction $transid");
204         
205         $apputils->commit_db_session($session);
206
207         return $transid;
208 }
209
210 __PACKAGE__->register_method(
211         method  => "billing_items",
212         api_name        => "open-ils.circ.money.billing.retrieve.all",
213         notes           =><<"   NOTE");
214         Returns a list of billing items for the given transaction.
215         PARAMS( login, transaction_id )
216         NOTE
217
218 sub billing_items {
219         my( $self, $client, $login, $transid ) = @_;
220
221         my( $staff, $evt ) = $apputils->checksesperm($login, 'VIEW_TRANSACTION');
222         return $evt if $evt;
223
224 # we need to grab the transaction by id and check the billing location
225 # to determin the permissibility XXX
226
227 #       $evt = $apputils->check_perms($staff->id, 
228 #               $transaction->billing_location, 'VIEW_TRANSACTION' );
229 #       return $evt if $evt;
230
231         return $apputils->simplereq( 'open-ils.storage',
232                 'open-ils.storage.direct.money.billing.search.xact.atomic', $transid )
233
234 }
235
236
237 __PACKAGE__->register_method(
238         method  => "billing_items_create",
239         api_name        => "open-ils.circ.money.billing.create",
240         notes           =><<"   NOTE");
241         Creates a new billing line item
242         PARAMS( login, bill_object (mb) )
243         NOTE
244
245 sub billing_items_create {
246         my( $self, $client, $login, $billing ) = @_;
247
248         my( $staff, $evt ) = $apputils->checksesperm($login, 'CREATE_BILL');
249         return $evt if $evt;
250
251         my $session = $apputils->start_db_session;
252
253         my $id = $session->request(
254                 'open-ils.storage.direct.money.billing.create', $billing )->gather(1);
255
256         throw OpenSRF::EX ("Error creating new bill") unless defined $id;
257
258         $apputils->commit_db_session($session);
259
260         return $id;
261 }
262
263
264
265
266
267 1;
268
269
270