1 package FS::part_bill_event;
4 use vars qw( @ISA $DEBUG @EXPORT_OK );
5 use FS::Record qw( dbh qsearch qsearchs );
8 @ISA = qw( FS::Record );
9 @EXPORT_OK = qw( due_events );
14 FS::part_bill_event - Object methods for part_bill_event records
18 use FS::part_bill_event;
20 $record = new FS::part_bill_event \%hash;
21 $record = new FS::part_bill_event { 'column' => 'value' };
23 $error = $record->insert;
25 $error = $new_record->replace($old_record);
27 $error = $record->delete;
29 $error = $record->check;
31 $error = $record->do_event( $direct_object );
33 @events = due_events ( { 'record' => $event_triggering_record,
35 'event_time => $_date,
36 'extra_sql => $extra } );
40 An FS::part_bill_event object represents an invoice event definition -
41 a callback which is triggered when an invoice is a certain amount of time
42 overdue. FS::part_bill_event inherits from
43 FS::Record. The following fields are currently supported:
47 =item eventpart - primary key
49 =item payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, or COMP
51 =item event - event name
53 =item eventcode - event action
55 =item seconds - how long after the invoice date events of this type are triggered
57 =item weight - ordering for events with identical seconds
59 =item plan - eventcode plan
61 =item plandata - additional plan data
63 =item reason - an associated reason for this event to fire
65 =item disabled - Disabled flag, empty or `Y'
75 Creates a new invoice event definition. To add the invoice event definition to
76 the database, see L<"insert">.
78 Note that this stores the hash reference, not a distinct copy of the hash it
79 points to. You can ask the object for a copy with the I<hash> method.
83 # the new method can be inherited from FS::Record, if a table method is defined
85 sub table { 'part_bill_event'; }
89 Adds this record to the database. If there is an error, returns the error,
90 otherwise returns false.
94 # the insert method can be inherited from FS::Record
98 Delete this record from the database.
102 # the delete method can be inherited from FS::Record
104 =item replace OLD_RECORD
106 Replaces the OLD_RECORD with this one in the database. If there is an error,
107 returns the error, otherwise returns false.
111 # the replace method can be inherited from FS::Record
115 Checks all fields to make sure this is a valid invoice event definition. If
116 there is an error, returns the error, otherwise returns false. Called by the
117 insert and replace methods.
121 # the check method should currently be supplied - FS::Record contains some
122 # data checking routines
127 $self->weight(0) unless $self->weight;
129 my $conf = new FS::Conf;
130 if ( $conf->exists('safe-part_bill_event') ) {
131 my $error = $self->ut_anything('eventcode');
132 return $error if $error;
134 my $c = $self->eventcode;
136 $c =~ /^\s*\$cust_main\->(suspend|cancel|invoicing_list_addpost|bill|collect)\(\);\s*("";)?\s*$/
138 or $c =~ /^\s*\$cust_bill\->(comp|realtime_(card|ach|lec)|batch_card|send)\((%options)*\);\s*$/
140 or $c =~ /^\s*\$cust_bill\->send(_if_newest)?\(\'[\w\-\s]+\'\s*(,\s*(\d+|\[\s*\d+(,\s*\d+)*\s*\])\s*,\s*'[\w\@\.\-\+]*'\s*)?\);\s*$/
142 or $c =~ /^\s*\$cust_main\->apply_payments; \$cust_main->apply_credits; "";\s*$/
144 or $c =~ /^\s*\$cust_main\->charge\( \s*\d*\.?\d*\s*,\s*\'[\w \!\@\#\$\%\&\(\)\-\+\;\:\"\,\.\?\/]*\'\s*\);\s*$/
146 or $c =~ /^\s*\$cust_main\->suspend_(if|unless)_pkgpart\([\d\,\s]*\);\s*$/
148 or $c =~ /^\s*\$cust_bill\->cust_suspend_if_balance_over\([\d\.\s]*\);\s*$/
152 return "illegal eventcode: $c";
157 my $error = $self->ut_numbern('eventpart')
158 || $self->ut_enum('payby', [qw( CARD DCLN DCRD CHEK DCHK LECB BILL COMP )] )
159 || $self->ut_text('event')
160 || $self->ut_anything('eventcode')
161 || $self->ut_number('seconds')
162 || $self->ut_enum('disabled', [ '', 'Y' ] )
163 || $self->ut_number('weight')
164 || $self->ut_textn('plan')
165 || $self->ut_anything('plandata')
166 || $self->ut_numbern('reason')
168 #|| $self->ut_snumber('seconds')
169 return $error if $error;
172 if ( $self->plandata =~ /^(agent_)?templatename\s+(.*)$/m ) {
175 foreach my $file (qw( template
176 latex latexnotes latexreturnaddress latexfooter
178 html htmlnotes htmlreturnaddress htmlfooter
181 unless ( $conf->exists("invoice_${file}_$name") ) {
183 "invoice_${file}_$name" =>
184 join("\n", $conf->config("invoice_$file") )
190 my $reasonr = qsearchs('reason', {'reasonnum' => $self->reason});
191 return "Unknown reason" unless $reasonr;
198 Returns the alternate invoice template name, if any, or false if there is
199 no alternate template for this invoice event.
205 if ( $self->plan =~ /^send_(alternate|agent)$/
206 && $self->plandata =~ /^(agent_)?templatename (.*)$/m
217 Returns the list of events due, if any, or false if there is none.
218 Requires record and payby, but event_time and extra_sql are optional.
223 my ($record, $payby, $event_time, $extra_sql) = @_;
226 $event_time = time unless $event_time;
227 $interval = $event_time - $record->_date;
229 sort { $a->seconds <=> $b->seconds
230 || $a->weight <=> $b->weight
231 || $a->eventpart <=> $b->eventpart }
232 grep { $_->seconds <= ( $interval )
233 && ! qsearch( 'cust_bill_event', {
234 'invnum' => $record->get($record->dbdef_table->primary_key),
235 'eventpart' => $_->eventpart,
240 'table' => 'part_bill_event',
241 'hashref' => { 'payby' => $payby,
243 'extra_sql' => $extra_sql,
251 Performs the event and returns any errors that occur.
252 Requires a record on which to perform the event.
253 Should only be performed inside a transaction.
258 my ($self, $object, %options) = @_;
259 warn " calling event (". $self->eventcode. ") for " . $object->table . " " ,
260 $object->get($object->dbdef_table->primary_key) . "\n" if $DEBUG > 1;
261 my $oldAutoCommit = $FS::UID::AutoCommit;
262 local $FS::UID::AutoCommit = 0;
264 # for "callback" -- heh
265 my $cust_main = $object->cust_main;
267 if ($object->table eq 'cust_bill'){
268 $cust_bill = $object;
271 if ($object->table eq 'cust_pay_batch'){
272 $cust_pay_batch = $object;
277 local $SIG{__DIE__}; # don't want Mason __DIE__ handler active
278 $error = eval $self->eventcode;
288 $statustext = $error;
294 my $cust_bill_event = new FS::cust_bill_event {
295 # 'invnum' => $object->get($object->dbdef_table->primary_key),
296 'invnum' => $object->invnum,
297 'eventpart' => $self->eventpart,
300 'statustext' => $statustext,
302 $error = $cust_bill_event->insert;
304 my $e = 'WARNING: Event run but database not updated - '.
305 'error inserting cust_bill_event, invnum #'. $object->invnum .
306 ', eventpart '. $self->eventpart.": $error";
315 Returns the text of any reason associated with this event.
321 my $r = qsearchs('reason', { 'reasonnum' => $self->reason });
333 The whole "eventcode" idea is bunk. This should be refactored with subclasses
334 like part_pkg/ and part_export/
338 L<FS::cust_bill>, L<FS::cust_bill_event>, L<FS::Record>, schema.html from the