1 package FS::cust_event;
4 use vars qw( @ISA $DEBUG $me );
5 use Carp qw( croak confess );
6 use FS::Record qw( qsearch qsearchs dbdef );
7 use FS::cust_main_Mixin;
14 @ISA = qw(FS::cust_main_Mixin FS::Record);
17 $me = '[FS::cust_event]';
21 FS::cust_event - Object methods for cust_event records
27 $record = new FS::cust_event \%hash;
28 $record = new FS::cust_event { 'column' => 'value' };
30 $error = $record->insert;
32 $error = $new_record->replace($old_record);
34 $error = $record->delete;
36 $error = $record->check;
40 An FS::cust_event object represents an completed event. FS::cust_event
41 inherits from FS::Record. The following fields are currently supported:
45 =item eventnum - primary key
47 =item eventpart - event definition (see L<FS::part_event>)
49 =item tablenum - customer, package or invoice, depending on the value of part_event.eventtable (see L<FS::cust_main>, L<FS::cust_pkg>, and L<FS::cust_bill>)
51 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
52 L<Time::Local> and L<Date::Parse> for conversion functions.
54 =item status - event status: B<new>, B<locked>, B<done> or B<failed>. Note: B<done> indicates the event is complete and should not be retried (statustext may still be set to an optional message), while B<failed> indicates the event failed and should be retried.
56 =item statustext - additional status detail (i.e. error or progress message)
66 Creates a new completed invoice event. To add the compelted invoice event to
67 the database, see L<"insert">.
69 Note that this stores the hash reference, not a distinct copy of the hash it
70 points to. You can ask the object for a copy with the I<hash> method.
74 # the new method can be inherited from FS::Record, if a table method is defined
76 sub table { 'cust_event'; }
78 sub cust_linked { $_[0]->cust_main_custnum; }
79 sub cust_unlinked_msg {
81 "WARNING: can't find cust_main.custnum ". $self->custnum;
82 #' (cust_bill.invnum '. $self->invnum. ')';
86 $self->cust_main_custnum(@_) || $self->SUPER::custnum(@_);
91 Adds this record to the database. If there is an error, returns the error,
92 otherwise returns false.
96 # the insert method can be inherited from FS::Record
100 Delete this record from the database.
104 # the delete method can be inherited from FS::Record
106 =item replace OLD_RECORD
108 Replaces the OLD_RECORD with this one in the database. If there is an error,
109 returns the error, otherwise returns false.
113 # the replace method can be inherited from FS::Record
117 Checks all fields to make sure this is a valid completed invoice event. If
118 there is an error, returns the error, otherwise returns false. Called by the
119 insert and replace methods.
123 # the check method should currently be supplied - FS::Record contains some
124 # data checking routines
129 my $error = $self->ut_numbern('eventnum')
130 || $self->ut_foreign_key('eventpart', 'part_event', 'eventpart')
132 return $error if $error;
134 my $eventtable = $self->part_event->eventtable;
135 my $dbdef_eventtable = dbdef->table( $eventtable );
138 $self->ut_foreign_key( 'tablenum',
140 $dbdef_eventtable->primary_key
142 || $self->ut_number('_date')
143 || $self->ut_enum('status', [qw( new locked done failed )])
144 || $self->ut_anything('statustext')
146 return $error if $error;
153 Returns the event definition (see L<FS::part_event>) for this completed event.
159 qsearchs( 'part_event', { 'eventpart' => $self->eventpart } );
164 Returns the customer, package, invoice or batched payment (see
165 L<FS::cust_main>, L<FS::cust_pkg>, L<FS::cust_bill> or L<FS::cust_pay_batch>)
166 for this completed invoice event.
171 croak "FS::cust_event::cust_bill called";
176 my $eventtable = $self->part_event->eventtable;
177 my $dbdef_table = dbdef->table( $eventtable );
178 my $primary_key = $dbdef_table->primary_key;
179 qsearchs( $eventtable, { $primary_key => $self->tablenum } );
182 =item test_conditions [ OPTION => VALUE ... ]
184 Tests conditions for this event, returns true if all conditions are satisfied,
189 sub test_conditions {
190 my( $self, %opt ) = @_;
191 my $part_event = $self->part_event;
192 my $object = $self->cust_X;
193 my @conditions = $part_event->part_event_condition;
194 $opt{'cust_event'} = $self;
196 #no unsatisfied conditions
197 #! grep ! $_->condition( $object, %opt ), @conditions;
198 my @unsatisfied = grep ! $_->condition( $object, %opt ), @conditions;
200 if ( $opt{'stats_hashref'} ) {
201 foreach my $unsat (@unsatisfied) {
202 $opt{'stats_hashref'}->{$unsat->conditionname}++;
211 Runs the event action.
218 my $part_event = $self->part_event;
220 my $object = $self->cust_X;
221 my $obj_pkey = $object->primary_key;
222 my $for = "for ". $object->table. " ". $object->$obj_pkey();
223 warn "running cust_event ". $self->eventnum.
224 " (". $part_event->action. ") $for\n"
227 my $oldAutoCommit = $FS::UID::AutoCommit;
228 local $FS::UID::AutoCommit = 0;
232 local $SIG{__DIE__}; # don't want Mason __DIE__ handler active
233 $error = eval { $part_event->do_action($object); };
241 $statustext = "Error running ". $part_event->action. " action: $@";
244 $statustext = $error;
249 #replace or add myself
251 $self->status($status);
252 $self->statustext($statustext);
254 $error = $self->eventnum ? $self->replace : $self->insert;
256 #this is why we need that locked state...
257 my $e = 'WARNING: Event run but database not updated - '.
258 'error replacing or inserting cust_event '. $self->eventnum.
270 Changes the status of this event from B<done> to B<failed>, allowing it to be
277 return '' unless $self->status eq 'done';
278 my $old = ref($self)->new( { $self->hash } );
279 $self->status('failed');
280 $self->replace($old);
285 #Changes the statustext of this event to B<retriable>, rendering it
286 #retriable (should retry be called).
291 confess "cust_event->retriable called";
293 return '' unless $self->status eq 'done';
294 my $old = ref($self)->new( { $self->hash } );
295 $self->statustext('retriable');
296 $self->replace($old);
307 JOIN part_event USING ( eventpart )
308 LEFT JOIN cust_bill ON ( eventtable = 'cust_bill' AND tablenum = invnum )
309 LEFT JOIN cust_pkg ON ( eventtable = 'cust_pkg' AND tablenum = pkgnum )
310 LEFT JOIN cust_main ON ( ( eventtable = 'cust_main' AND tablenum = cust_main.custnum )
311 OR ( eventtable = 'cust_bill' AND cust_bill.custnum = cust_main.custnum )
312 OR ( eventtable = 'cust_pkg' AND cust_pkg.custnum = cust_main.custnum )
318 =item search_sql HASHREF
320 Class method which returns an SQL WHERE fragment to search for parameters
321 specified in HASHREF. Valid parameters are
333 #Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
337 my($class, $param) = @_;
339 warn "$me search_sql called with params: \n".
340 join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
345 if ( $param->{'agentnum'} && $param->{'agentnum'} =~ /^(\d+)$/ ) {
346 push @search, "cust_main.agentnum = $1";
347 #my $agent = qsearchs('agent', { 'agentnum' => $1 } );
348 #die "unknown agentnum $1" unless $agent;
351 if ( $param->{'beginning'} =~ /^(\d+)$/ ) {
352 push @search, "cust_event._date >= $1";
354 if ( $param->{'ending'} =~ /^(\d+)$/ ) {
355 push @search, "cust_event._date <= $1";
358 if ( $param->{'failed'} ) {
359 push @search, "statustext != ''",
360 "statustext IS NOT NULL",
361 "statustext != 'N/A'";
364 #if ( $param->{'part_event.payby'} =~ /^(\w+)$/ ) {
365 # push @search, "part_event.payby = '$1'";
368 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
369 push @search, "cust_main.custnum = '$1'";
372 if ( $param->{'invnum'} =~ /^(\d+)$/ ) {
373 push @search, "part_event.eventtable = 'cust_bill'",
377 if ( $param->{'pkgnum'} =~ /^(\d+)$/ ) {
378 push @search, "part_event.eventtable = 'cust_pkg'",
382 #here is the agent virtualization
384 $FS::CurrentUser::CurrentUser->agentnums_sql( 'table' => 'cust_main' );
386 my $where = 'WHERE '. join(' AND ', @search );
389 join(' AND ', @search );
403 sub process_reprint {
404 process_re_X('print', @_);
411 sub process_reemail {
412 process_re_X('email', @_);
420 process_re_X('fax', @_);
423 use Storable qw(thaw);
427 my( $method, $job ) = ( shift, shift );
429 my $param = thaw(decode_base64(shift));
430 warn Dumper($param) if $DEBUG;
441 my($method, $param, $job) = @_;
443 my $search_sql = FS::cust_event->search_sql($param);
445 #maybe not...? we do want the "re-" action to match the search more closely
446 # # yuck! hardcoded *AND* sequential scans!
447 #my $where = " WHERE action LIKE 'cust_bill_send%' ".
448 # ( $search_sql ? " AND $search_sql" : "" );
450 my $where = ( $search_sql ? " WHERE $search_sql" : "" );
452 my @cust_event = qsearch({
453 'table' => 'cust_event',
454 'addl_from' => FS::cust_event->join_sql(),
456 'extra_sql' => $where,
459 warn "$me re_X found ". scalar(@cust_event). " events\n"
462 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
463 foreach my $cust_event ( @cust_event ) {
465 my $cust_X = $cust_event->cust_X; # cust_bill
466 next unless $cust_X->can($method);
468 $cust_X->$method( $cust_event->part_event->templatename
469 || $cust_X->agent_template
472 if ( $job ) { #progressbar foo
474 if ( time - $min_sec > $last ) {
475 my $error = $job->update_statustext(
476 int( 100 * $num / scalar(@cust_event) )
478 die $error if $error;
485 #this doesn't work, but it would be nice
486 #if ( $job ) { #progressbar foo
487 # my $error = $job->update_statustext(
488 # scalar(@cust_event). " invoices re-${method}ed"
490 # die $error if $error;
499 L<FS::part_event>, L<FS::cust_bill>, L<FS::Record>, schema.html from the