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 disabled - Disabled flag, empty or `Y'
73 Creates a new invoice event definition. To add the invoice event definition to
74 the database, see L<"insert">.
76 Note that this stores the hash reference, not a distinct copy of the hash it
77 points to. You can ask the object for a copy with the I<hash> method.
81 # the new method can be inherited from FS::Record, if a table method is defined
83 sub table { 'part_bill_event'; }
87 Adds this record to the database. If there is an error, returns the error,
88 otherwise returns false.
92 # the insert method can be inherited from FS::Record
96 Delete this record from the database.
100 # the delete method can be inherited from FS::Record
102 =item replace OLD_RECORD
104 Replaces the OLD_RECORD with this one in the database. If there is an error,
105 returns the error, otherwise returns false.
109 # the replace method can be inherited from FS::Record
113 Checks all fields to make sure this is a valid invoice event definition. If
114 there is an error, returns the error, otherwise returns false. Called by the
115 insert and replace methods.
119 # the check method should currently be supplied - FS::Record contains some
120 # data checking routines
125 $self->weight(0) unless $self->weight;
127 my $conf = new FS::Conf;
128 if ( $conf->exists('safe-part_bill_event') ) {
129 my $error = $self->ut_anything('eventcode');
130 return $error if $error;
132 my $c = $self->eventcode;
134 $c =~ /^\s*\$cust_main\->(suspend|cancel|invoicing_list_addpost|bill|collect)\(\);\s*("";)?\s*$/
136 or $c =~ /^\s*\$cust_bill\->(comp|realtime_(card|ach|lec)|batch_card|send)\((%options)*\);\s*$/
138 or $c =~ /^\s*\$cust_bill\->send(_if_newest)?\(\'[\w\-\s]+\'\s*(,\s*(\d+|\[\s*\d+(,\s*\d+)*\s*\])\s*,\s*'[\w\@\.\-\+]*'\s*)?\);\s*$/
140 or $c =~ /^\s*\$cust_main\->apply_payments; \$cust_main->apply_credits; "";\s*$/
142 or $c =~ /^\s*\$cust_main\->charge\( \s*\d*\.?\d*\s*,\s*\'[\w \!\@\#\$\%\&\(\)\-\+\;\:\"\,\.\?\/]*\'\s*\);\s*$/
144 or $c =~ /^\s*\$cust_main\->suspend_(if|unless)_pkgpart\([\d\,\s]*\);\s*$/
146 or $c =~ /^\s*\$cust_bill\->cust_suspend_if_balance_over\([\d\.\s]*\);\s*$/
150 return "illegal eventcode: $c";
155 my $error = $self->ut_numbern('eventpart')
156 || $self->ut_enum('payby', [qw( CARD DCLN DCRD CHEK DCHK LECB BILL COMP )] )
157 || $self->ut_text('event')
158 || $self->ut_anything('eventcode')
159 || $self->ut_number('seconds')
160 || $self->ut_enum('disabled', [ '', 'Y' ] )
161 || $self->ut_number('weight')
162 || $self->ut_textn('plan')
163 || $self->ut_anything('plandata')
165 #|| $self->ut_snumber('seconds')
166 return $error if $error;
169 if ( $self->plandata =~ /^(agent_)?templatename\s+(.*)$/m ) {
172 foreach my $file (qw( template
173 latex latexnotes latexreturnaddress latexfooter
175 html htmlnotes htmlreturnaddress htmlfooter
178 unless ( $conf->exists("invoice_${file}_$name") ) {
180 "invoice_${file}_$name" =>
181 join("\n", $conf->config("invoice_$file") )
192 Returns the alternate invoice template name, if any, or false if there is
193 no alternate template for this invoice event.
199 if ( $self->plan =~ /^send_(alternate|agent)$/
200 && $self->plandata =~ /^(agent_)?templatename (.*)$/m
211 Returns the list of events due, if any, or false if there is none.
212 Requires record and payby, but event_time and extra_sql are optional.
217 my ($record, $payby, $event_time, $extra_sql) = @_;
220 $event_time = time unless $event_time;
221 $interval = $event_time - $record->_date;
223 sort { $a->seconds <=> $b->seconds
224 || $a->weight <=> $b->weight
225 || $a->eventpart <=> $b->eventpart }
226 grep { $_->seconds <= ( $interval )
227 && ! qsearch( 'cust_bill_event', {
228 'invnum' => $record->get($record->dbdef_table->primary_key),
229 'eventpart' => $_->eventpart,
234 'table' => 'part_bill_event',
235 'hashref' => { 'payby' => $payby,
237 'extra_sql' => $extra_sql,
245 Performs the event and returns any errors that occur.
246 Requires a record on which to perform the event.
247 Should only be performed inside a transaction.
252 my ($self, $object, %options) = @_;
253 warn " calling event (". $self->eventcode. ") for " . $object->table . " " ,
254 $object->get($object->dbdef_table->primary_key) . "\n" if $DEBUG > 1;
255 my $oldAutoCommit = $FS::UID::AutoCommit;
256 local $FS::UID::AutoCommit = 0;
258 # for "callback" -- heh
259 my $cust_main = $object->cust_main;
261 if ($object->table eq 'cust_bill'){
262 $cust_bill = $object;
265 if ($object->table eq 'cust_pay_batch'){
266 $cust_pay_batch = $object;
271 local $SIG{__DIE__}; # don't want Mason __DIE__ handler active
272 $error = eval $self->eventcode;
282 $statustext = $error;
288 my $cust_bill_event = new FS::cust_bill_event {
289 # 'invnum' => $object->get($object->dbdef_table->primary_key),
290 'invnum' => $object->invnum,
291 'eventpart' => $self->eventpart,
294 'statustext' => $statustext,
296 $error = $cust_bill_event->insert;
298 my $e = 'WARNING: Event run but database not updated - '.
299 'error inserting cust_bill_event, invnum #'. $object->invnum .
300 ', eventpart '. $self->eventpart.": $error";
311 The whole "eventcode" idea is bunk. This should be refactored with subclasses
312 like part_pkg/ and part_export/
316 L<FS::cust_bill>, L<FS::cust_bill_event>, L<FS::Record>, schema.html from the