[freeside-commits] branch FREESIDE_2_3_BRANCH updated. 5c619fec0cb5d8adbce182d91c7c6a22d6725bcf

Mark Wells mark at 420.am
Thu Apr 25 16:16:07 PDT 2013


The branch, FREESIDE_2_3_BRANCH has been updated
       via  5c619fec0cb5d8adbce182d91c7c6a22d6725bcf (commit)
      from  bf6644780bf1036f5eca4d191caf7c141447dd47 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 5c619fec0cb5d8adbce182d91c7c6a22d6725bcf
Author: Mark Wells <mark at freeside.biz>
Date:   Thu Apr 25 16:15:38 2013 -0700

    billing event "initialize" feature for 2.3, #22766

diff --git a/FS/FS/cust_event.pm b/FS/FS/cust_event.pm
index 1407f43..bf8ab76 100644
--- a/FS/FS/cust_event.pm
+++ b/FS/FS/cust_event.pm
@@ -138,7 +138,7 @@ sub check {
                               $dbdef_eventtable->primary_key
                             )
     || $self->ut_number('_date')
-    || $self->ut_enum('status', [qw( new locked done failed )])
+    || $self->ut_enum('status', [qw( new locked done failed initial )])
     || $self->ut_anything('statustext')
   ;
   return $error if $error;
diff --git a/FS/FS/part_event.pm b/FS/FS/part_event.pm
index c18c9f3..efe09bd 100644
--- a/FS/FS/part_event.pm
+++ b/FS/FS/part_event.pm
@@ -314,6 +314,90 @@ sub targets {
   @tested_objects;
 }
 
+=item initialize PARAMS
+
+Identify all objects eligible for this event and create L<FS::cust_event>
+records for each of them, as of the present time, with status "initial".  When 
+combined with conditions that prevent an event from running more than once
+(at all or within some period), this will exclude any objects that met the 
+conditions before the event was created.
+
+If an L<FS::part_event> object needs to be initialized, it should be created 
+in a disabled state to avoid running the event prematurely for any existing 
+objects.  C<initialize> will enable it once all the cust_event records 
+have been created.
+
+This may take some time, so it should be run from the job queue.
+
+=cut
+
+sub initialize {
+  my $self = shift;
+  my $time = time; # $opt{'time'}?
+
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  my $eventpart = $self->eventpart;
+  $eventpart =~ /^\d+$/ or die "bad eventpart $eventpart";
+  my $eventtable = $self->eventtable;
+
+  # find all objects that meet the conditions for this part_event
+  my $linkage = '';
+  # this is the 'object' side of the FROM clause
+  if ( $eventtable ne 'cust_main' ) {
+    $linkage = #($self->eventtables_cust_join->{$eventtable} || '') . 
+        ' LEFT JOIN cust_main USING (custnum) '
+  }
+
+  # this is the 'event' side
+  my $join  = FS::part_event_condition->join_conditions_sql( $eventtable );
+  my $where = FS::part_event_condition->where_conditions_sql( $eventtable,
+    'time' => $time
+  );
+  $join = $linkage . 
+      " INNER JOIN part_event ON ( part_event.eventpart = $eventpart ) $join";
+
+  $where .= ' AND cust_main.agentnum = '.$self->agentnum
+    if $self->agentnum;
+  # don't enforce check_freq since this is a special, out-of-order check,
+  # and don't enforce disabled because we want to do this with the part_event 
+  # disabled.
+  my @objects = qsearch({
+      table     => $eventtable,
+      hashref   => {},
+      addl_from => $join,
+      extra_sql => "WHERE $where",
+      debug     => 1,
+  });
+  warn "initialize: ".(scalar @objects) ." $eventtable objects found\n" 
+    if $DEBUG;
+  my $error = '';
+  foreach my $object ( @objects ) {
+    # test conditions
+    my $cust_event = $self->new_cust_event($object, 'time' => $time);
+    next unless $cust_event->test_conditions;
+
+    $cust_event->status('initial');
+    $error = $cust_event->insert;
+    last if $error;
+  }
+  if ( !$error and $self->disabled ) {
+    $self->disabled('');
+    $error = $self->replace;
+  }
+  if ( $error ) {
+    $dbh->rollback;
+    return $error;
+  }
+  $dbh->commit if $oldAutoCommit;
+  return;
+}
+
+=cut
+
+
 =back
 
 =head1 CLASS METHODS
@@ -492,12 +576,30 @@ sub all_actions {
        keys %actions
 }
 
+=item process_initialize 'eventpart' => EVENTPART
+
+Job queue wrapper for "initialize".  EVENTPART identifies the 
+L<FS::part_event> object to initialize.
+
+=cut
+
+sub process_initialize {
+  my %opt = @_;
+  my $part_event =
+      qsearchs('part_event', { eventpart => $opt{'eventpart'}})
+        or die "eventpart '$opt{eventpart}' not found!\n";
+  my $error = $part_event->initialize;
+  die $error if $error;
+  '';
+}
+
 =back
 
 =head1 SEE ALSO
 
 L<FS::part_event_option>, L<FS::part_event_condition>, L<FS::cust_main>,
-L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_bill_event>, L<FS::Record>,
+L<FS::cust_pkg>, L<FS::svc_acct>, L<FS::cust_bill>, L<FS::cust_bill_event>, 
+L<FS::Record>,
 schema.html from the base documentation.
 
 =cut
diff --git a/httemplate/edit/part_event.html b/httemplate/edit/part_event.html
index dc1eba0..702471b 100644
--- a/httemplate/edit/part_event.html
+++ b/httemplate/edit/part_event.html
@@ -22,6 +22,11 @@
                               type    => 'checkbox',
                               value   => 'Y',
                             },
+                            { field   => '_initialize',
+                              type      => 'checkbox',
+                              onchange  => '_initialize_changed',
+                              value   => 'Y',
+                            }, 
                             { type    => 'title',
                               value   => 'Event Conditions',
                             },
@@ -54,7 +59,6 @@
                               layer_values_callback => $action_layer_values,
                               html_between => n_a('action'),
                             },
-
                           ],
               'labels' => {
                             'eventpart'  => 'Event',
@@ -67,6 +71,7 @@
                             'conditionname' => 'Add new condition',
                             #'weight',
                             'action'     => 'Action',
+                            '_initialize' => 'Initialize event',
                           },
               'viewall_dir' => 'browse',
               'new_callback' => sub { #start empty for new events only
@@ -469,6 +474,16 @@
 
   }
 
+  function _initialize_changed(what) {
+    document.getElementById('disabled').disabled = what.checked;
+    if ( what.checked ) {
+%# because it's not an immediately obvious concept
+      alert('Initializing the event will treat it as "already run" on the '+
+            'current date for all existing customers.  This affects '+
+            'conditions that prevent running an event more than once.');
+    }
+  }
+
 </SCRIPT>
 <%once>
 
diff --git a/httemplate/edit/process/part_event.html b/httemplate/edit/process/part_event.html
index 20066ba..a8c434c 100644
--- a/httemplate/edit/process/part_event.html
+++ b/httemplate/edit/process/part_event.html
@@ -82,8 +82,21 @@
            length($actionfields{'reasonnum'}) == 0 ) {
         return 'Reason required';
       }
+      if ( $cgi->param('_initialize') ) {
+        $cgi->param('disabled', 'Y');
+      }
       return '';
     },
+    'noerror_callback' => sub {
+      my ($cgi, $new) = @_;
+      if ( $cgi->param('_initialize') ) {
+        my $job = new FS::queue { 
+          'job' => 'FS::part_event::process_initialize'
+        };
+        my $error = $job->insert('eventpart' => $new->eventpart);
+        warn "error queueing job: $error\n" if $error; # can't do anything else
+      }
+    },
 
     'agent_virt'       => 1,
     'agent_null_right' => 'Edit global billing events',

-----------------------------------------------------------------------

Summary of changes:
 FS/FS/cust_event.pm                     |    2 +-
 FS/FS/part_event.pm                     |  104 ++++++++++++++++++++++++++++++-
 httemplate/edit/part_event.html         |   17 +++++-
 httemplate/edit/process/part_event.html |   13 ++++
 4 files changed, 133 insertions(+), 3 deletions(-)




More information about the freeside-commits mailing list