1 package FS::part_event;
4 use base qw( FS::m2name_Common FS::option_Common );
7 use FS::Record qw( dbh qsearch qsearchs );
9 use FS::part_event_option;
10 use FS::part_event_condition;
18 FS::part_event - Object methods for part_event records
24 $record = new FS::part_event \%hash;
25 $record = new FS::part_event { 'column' => 'value' };
27 $error = $record->insert( { 'option' => 'value' } );
28 $error = $record->insert( \%options );
30 $error = $new_record->replace($old_record);
32 $error = $record->delete;
34 $error = $record->check;
36 $error = $record->do_event( $direct_object );
40 An FS::part_event object represents an event definition - a billing, collection
41 or other callback which is triggered when certain customer, invoice, package or
42 other conditions are met. FS::part_event inherits from FS::Record. The
43 following fields are currently supported:
47 =item eventpart - primary key
49 =item agentnum - Optional agentnum (see L<FS::agent>)
51 =item event - event name
53 =item eventtable - table name against which this event is triggered: one of "cust_main", "cust_bill", "cust_statement", "cust_pkg", "svc_acct".
55 =item check_freq - how often events of this type are checked; currently "1d" (daily) and "1m" (monthly) are recognized. Note that the apprioriate freeside-daily and/or freeside-monthly cron job needs to be in place.
57 =item weight - ordering for events
59 =item action - event action (like part_bill_event.plan - eventcode plan)
61 =item disabled - Disabled flag, empty or `Y'
71 Creates a new invoice event definition. To add the invoice event definition to
72 the database, see L<"insert">.
74 Note that this stores the hash reference, not a distinct copy of the hash it
75 points to. You can ask the object for a copy with the I<hash> method.
79 # the new method can be inherited from FS::Record, if a table method is defined
81 sub table { 'part_event'; }
83 =item insert [ HASHREF ]
85 Adds this record to the database. If there is an error, returns the error,
86 otherwise returns false.
88 If a list or hash reference of options is supplied, part_export_option records
89 are created (see L<FS::part_event_option>).
93 # the insert method can be inherited from FS::Record
97 Delete this record from the database.
101 # the delete method can be inherited from FS::Record
103 =item replace OLD_RECORD [ HASHREF | OPTION => VALUE ... ]
105 Replaces the OLD_RECORD with this one in the database. If there is an error,
106 returns the error, otherwise returns false.
108 If a list or hash reference of options is supplied, part_event_option
109 records are created or modified (see L<FS::part_event_option>).
113 # the replace method can be inherited from FS::Record
117 Checks all fields to make sure this is a valid invoice event definition. 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 $self->weight(0) unless $self->weight;
132 $self->ut_numbern('eventpart')
133 || $self->ut_text('event')
134 || $self->ut_enum('eventtable', [ $self->eventtables ] )
135 || $self->ut_enum('check_freq', [ '1d', '1m' ])
136 || $self->ut_number('weight')
137 || $self->ut_alpha('action')
138 || $self->ut_enum('disabled', [ '', 'Y' ] )
139 || $self->ut_agentnum_acl('agentnum', 'Edit global billing events')
141 return $error if $error;
143 #XXX check action to make sure a module exists?
144 # well it'll die in _rebless...
151 Reblesses the object into the FS::part_event::Action::ACTION class, where
152 ACTION is the object's I<action> field.
158 my $action = $self->action or return $self;
159 #my $class = ref($self). "::$action";
160 my $class = "FS::part_event::Action::$action";
163 bless($self, $class); # unless $@;
167 =item part_event_condition
169 Returns the conditions associated with this event, as FS::part_event_condition
170 objects (see L<FS::part_event_condition>)
174 sub part_event_condition {
176 qsearch( 'part_event_condition', { 'eventpart' => $self->eventpart } );
179 =item new_cust_event OBJECT, [ OPTION => VALUE ]
181 Creates a new customer event (see L<FS::cust_event>) for the provided object.
183 The only option allowed is 'time', to set the "current" time for the event.
188 my( $self, $object, %opt ) = @_;
190 confess "**** $object is not a ". $self->eventtable
191 if ref($object) ne "FS::". $self->eventtable;
193 my $pkey = $object->primary_key;
196 'eventpart' => $self->eventpart,
197 'tablenum' => $object->$pkey(),
198 #'_date' => time, #i think we always want the real "now" here.
199 '_date' => ($opt{'time'} || time),
204 #surely this doesn't work
205 sub reasontext { confess "part_event->reasontext deprecated"; }
208 #Returns the text of any reason associated with this event.
214 # my $r = qsearchs('reason', { 'reasonnum' => $self->reason });
224 Returns the associated agent for this event, if any, as an FS::agent object.
230 qsearchs('agent', { 'agentnum' => $self->agentnum } );
235 Returns the alternate invoice template name, if any, or false if there is
236 no alternate template for this event.
243 if ( $self->action =~ /^cust_bill_send_(alternate|agent)$/
244 && ( $self->option('agent_templatename')
245 || $self->option('templatename') )
248 $self->option('agent_templatename')
249 || $self->option('templatename');
256 =item initialize PARAMS
258 Identify all objects eligible for this event and create L<FS::cust_event>
259 records for each of them, as of the present time, with status "initial". When
260 combined with conditions that prevent an event from running more than once
261 (at all or within some period), this will exclude any objects that met the
262 conditions before the event was created.
264 If an L<FS::part_event> object needs to be initialized, it should be created
265 in a disabled state to avoid running the event prematurely for any existing
266 objects. C<initialize> will enable it once all the cust_event records
269 This may take some time, so it should be run from the job queue.
275 my $time = time; # $opt{'time'}?
277 my $oldAutoCommit = $FS::UID::AutoCommit;
278 local $FS::UID::AutoCommit = 0;
281 my $eventpart = $self->eventpart;
282 $eventpart =~ /^\d+$/ or die "bad eventpart $eventpart";
283 my $eventtable = $self->eventtable;
285 # find all objects that meet the conditions for this part_event
287 # this is the 'object' side of the FROM clause
288 if ( $eventtable ne 'cust_main' ) {
289 $linkage = ($self->eventtables_cust_join->{$eventtable} || '') .
290 ' LEFT JOIN cust_main USING (custnum) '
293 # this is the 'event' side
294 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
295 my $where = FS::part_event_condition->where_conditions_sql( $eventtable,
299 " INNER JOIN part_event ON ( part_event.eventpart = $eventpart ) $join";
301 $where .= ' AND cust_main.agentnum = '.$self->agentnum
303 # don't enforce check_freq since this is a special, out-of-order check,
304 # and don't enforce disabled because we want to do this with the part_event
306 my @objects = qsearch({
307 table => $eventtable,
310 extra_sql => "WHERE $where",
313 warn "initialize: ".(scalar @objects) ." $eventtable objects found\n"
316 foreach my $object ( @objects ) {
318 my $cust_event = $self->new_cust_event($object, 'time' => $time);
319 next unless $cust_event->test_conditions;
321 $cust_event->status('initial');
322 $error = $cust_event->insert;
325 if ( !$error and $self->disabled ) {
327 $error = $self->replace;
333 $dbh->commit if $oldAutoCommit;
346 =item eventtable_labels
348 Returns a hash reference of labels for eventtable values,
349 i.e. 'cust_main'=>'Customer'
353 sub eventtable_labels {
356 tie my %hash, 'Tie::IxHash',
357 'cust_pkg' => 'Package',
358 'cust_bill' => 'Invoice',
359 'cust_main' => 'Customer',
360 'cust_pay_batch' => 'Batch payment',
361 'cust_statement' => 'Statement', #too general a name here? "Invoice group"?
362 'svc_acct' => 'Login service',
368 =item eventtable_pkey_sql
370 Returns a hash reference of full SQL primary key names for eventtable values,
371 i.e. 'cust_main'=>'cust_main.custnum'
375 sub eventtable_pkey_sql {
378 my $hashref = $class->eventtable_pkey;
380 my %hash = map { $_ => "$_.". $hashref->{$_} } keys %$hashref;
385 =item eventtable_pkey
387 Returns a hash reference of full SQL primary key names for eventtable values,
388 i.e. 'cust_main'=>'custnum'
392 sub eventtable_pkey {
396 'cust_main' => 'custnum',
397 'cust_bill' => 'invnum',
398 'cust_pkg' => 'pkgnum',
399 'cust_pay_batch' => 'paybatchnum',
400 'cust_statement' => 'statementnum',
401 'svc_acct' => 'svcnum',
407 Returns a list of eventtable values (default ordering; suited for display).
413 my $eventtables = $class->eventtable_labels;
417 =item eventtables_runorder
419 Returns a list of eventtable values (run order).
423 sub eventtables_runorder {
424 shift->eventtables; #same for now
427 =item eventtables_cust_join
429 Returns a hash reference of SQL expressions to join each eventtable to
430 a table with a 'custnum' field.
434 sub eventtables_cust_join {
436 'svc_acct' => 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum)',
441 =item eventtables_custnum
443 Returns a hash reference of SQL expressions for the 'custnum' field when
444 I<eventtables_cust_join> is in effect. The default is "$eventtable.custnum".
448 sub eventtables_custnum {
450 map({ $_, "$_.custnum" } shift->eventtables),
451 'svc_acct' => 'cust_pkg.custnum'
457 =item check_freq_labels
459 Returns a hash reference of labels for check_freq values,
464 sub check_freq_labels {
474 =item actions [ EVENTTABLE ]
476 Return information about the available actions. If an eventtable is specified,
477 only return information about actions available for that eventtable.
479 Information is returned as key-value pairs. Keys are event names. Values are
480 hashrefs with the following keys:
486 =item eventtable_hashref
496 =head1 ADDING NEW EVENTTABLES
498 To add an eventtable, you must:
502 =item Add the table to "eventtable_labels" (with a label) and to
503 "eventtable_pkey" (with its primary key).
505 =item If the table doesn't have a "custnum" field of its own (such
506 as a svc_x table), add a suitable join expression to
507 eventtables_cust_join and an expression for the final custnum field
508 to eventtables_custnum.
510 =item Create a method named FS::cust_main->$eventtable(): a wrapper
511 around qsearch() to return all records in the new table belonging to
512 the cust_main object. This method must accept 'addl_from' and
513 'extra_sql' arguments in the way qsearch() does. For svc_ tables,
514 wrap the svc_x() method.
516 =item Add it to FS::cust_event->join_sql and search_sql_where so that
517 search/cust_event.html will find it.
519 =item Create a UI link/form to search for events linked to objects
520 in the new eventtable, using search/cust_event.html. Place this
521 somewhere appropriate to the eventtable.
525 See L<FS::part_event::Action> for more information.
529 #false laziness w/part_event_condition.pm
530 #some false laziness w/part_export & part_pkg
532 foreach my $INC ( @INC ) {
533 foreach my $file ( glob("$INC/FS/part_event/Action/*.pm") ) {
534 warn "attempting to load Action from $file\n" if $DEBUG;
535 $file =~ /\/(\w+)\.pm$/ or do {
536 warn "unrecognized file in $INC/FS/part_event/Action/: $file\n";
540 eval "use FS::part_event::Action::$mod;";
542 die "error using FS::part_event::Action::$mod (skipping): $@\n" if $@;
543 #warn "error using FS::part_event::Action::$mod (skipping): $@\n" if $@;
547 ( map { $_ => "FS::part_event::Action::$mod"->$_() }
548 qw( description eventtable_hashref default_weight deprecated )
549 #option_fields_hashref
551 'option_fields' => [ "FS::part_event::Action::$mod"->option_fields() ],
557 my( $class, $eventtable ) = @_;
559 map { $_ => $actions{$_} }
560 sort { $actions{$a}->{'default_weight'}<=>$actions{$b}->{'default_weight'} }
561 $class->all_actions( $eventtable )
566 =item all_actions [ EVENTTABLE ]
568 Returns a list of just the action names
573 my ( $class, $eventtable ) = @_;
575 grep { !$eventtable || $actions{$_}->{'eventtable_hashref'}{$eventtable} }
579 =item process_initialize 'eventpart' => EVENTPART
581 Job queue wrapper for "initialize". EVENTPART identifies the
582 L<FS::part_event> object to initialize.
586 sub process_initialize {
589 qsearchs('part_event', { eventpart => $opt{'eventpart'}})
590 or die "eventpart '$opt{eventpart}' not found!\n";
591 $part_event->initialize;
598 L<FS::part_event_option>, L<FS::part_event_condition>, L<FS::cust_main>,
599 L<FS::cust_pkg>, L<FS::svc_acct>, L<FS::cust_bill>, L<FS::cust_bill_event>,
601 schema.html from the base documentation.