multiple usage classes checkpoint

[freeside.git] / FS / FS / part_pkg / voip_cdr.pm

diff --git a/FS/FS/part_pkg/voip_cdr.pm b/FS/FS/part_pkg/voip_cdr.pm
index c4e6ab2..1025705 100644 (file)
--- a/FS/FS/part_pkg/voip_cdr.pm
+++ b/FS/FS/part_pkg/voip_cdr.pm
@@ -85,6 +85,17 @@ tie my %rating_method, 'Tie::IxHash',
                          'select_options' => { FS::cdr::invoice_formats() },
                        },
 
+    'separate_usage' => { 'name' => 'Separate usage charges from recurring charges',
+                          'type' => 'checkbox',
+                        },
+
+    'usage_section' => { 'name' => 'Section in which to place separate usage charges',
+                       },
+
+    'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
+                          'type' => 'checkbox',
+                        },
+
     #XXX also have option for an external db
 #    'cdr_location' => { 'name' => 'CDR database location'
 #                        'type' => 'select',
@@ -116,6 +127,7 @@ tie my %rating_method, 'Tie::IxHash',
                        disable_src
                        domestic_prefix international_prefix
                        use_amaflags use_disposition output_format
+                       separate_usage summarize_usage usage_section
                      )
                   ],
   'weight' => 40,
@@ -126,8 +138,16 @@ sub calc_setup {
   $self->option('setup_fee');
 }
 
-#false laziness w/voip_sqlradacct... resolve it if that one ever gets used again
 sub calc_recur {
+  my $self = shift;
+  my $charges = 0;
+  $charges = $self->calc_usage(@_)
+    unless $self->option('separate_usage', 'Hush!');
+  $self->option('recur_fee') + $charges;
+}
+
+#false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
+sub calc_usage {
   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
 
   my $last_bill = $cust_pkg->last_bill;
@@ -145,6 +165,10 @@ sub calc_recur {
   my $output_format = $self->option('output_format', 'Hush!')
                       || 'simple';
 
+  eval "use Text::CSV_XS;";
+  die $@ if $@;
+  my $csv = new Text::CSV_XS;
+
   foreach my $cust_svc (
     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
   ) {
@@ -163,6 +187,7 @@ sub calc_recur {
       my( $rate_region, $regionnum );
       my $pretty_destnum;
       my $charge = '';
+      my $classnum = '';
       my @call_details = ();
       if ( $self->option('rating_method') eq 'prefix'
            || ! $self->option('rating_method')
@@ -285,7 +310,7 @@ sub calc_recur {
 
           $charge = sprintf('%.2f', $cdr->upstream_price);
           $charges += $charge;
-
+ 
           @call_details = (
             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
             time2str("%c", $cdr->calldate_unix),  #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot
@@ -363,17 +388,19 @@ sub calc_recur {
             $rate_region->regionname,
           );
 
+          $classnum = $rate_detail->classnum;
+
         }
 
         if ( $charge > 0 ) {
+          #just use FS::cust_bill_pkg_detail objects?
           my $call_details;
           if ( $self->option('rating_method') eq 'upstream_simple' ) {
-            $call_details = [ 'C', $call_details[0] ];
+            $call_details = [ 'C', $call_details[0], $charge, $classnum ];
           }else{
-            $call_details = join(' - ', @call_details );
+            $csv->combine(@call_details);
+            $call_details = [ 'C', $csv->string, $charge, $classnum ];
           }
-          warn "  adding details on charge to invoice: $call_details"
-            if ( $DEBUG && !ref($call_details) );
           warn "  adding details on charge to invoice: [ ".
               join(', ', @{$call_details} ). " ]"
             if ( $DEBUG && ref($call_details) );
@@ -425,7 +452,7 @@ sub calc_recur {
 
   } #if ( $spool_cdr && length($downstream_cdr) )
 
-  $self->option('recur_fee') + $charges;
+  $charges;
 
 }
 
@@ -445,5 +472,55 @@ sub calc_units {
   scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 }
 
+sub append_cust_bill_pkgs {
+  my $self = shift;
+  my($cust_pkg, $sdate, $details, $param ) = @_;
+  return []
+    unless $self->option('separate_usage', 'Hush!');
+
+  my @details = ();
+  my $charges = $self->calc_usage($cust_pkg, $sdate, \@details, $param);
+
+  return []
+    unless $charges;  # unless @details?
+
+  my @cust_bill_pkg = ();
+
+  my $want_summary = $self->option('summarize_usage', 'Hush!') &&
+                     $self->option('usage_section', 'Hush!');
+
+  push @cust_bill_pkg, new FS::cust_bill_pkg {
+    'pkgnum'    => $cust_pkg->pkgnum,
+    'setup'     => 0,
+    'unitsetup' => 0,
+    'recur'     => sprintf( "%.2f", $charges),  # hmmm
+    'unitrecur' => 0,
+    'quantity'  => $cust_pkg->quantity,
+    'sdate'     => $$sdate,
+    'edate'     => $cust_pkg->bill,             # already fiddled
+    'itemdesc'  => 'Usage charges',             # configurable?
+    'duplicate' => 'Y',
+  }
+    if $want_summary;
+
+  push @cust_bill_pkg, new FS::cust_bill_pkg {
+    'pkgnum'     => $cust_pkg->pkgnum,
+    'setup'      => 0,
+    'unitsetup ' => 0,
+    'recur'      => sprintf( "%.2f", $charges),  # hmmm
+    'unitrecur ' => 0,
+    'quantity'   => $cust_pkg->quantity,
+    'sdate'      => $$sdate,
+    'edate'      => $cust_pkg->bill,             # already fiddled
+    'itemdesc'   => 'Usage charges',             # configurable?
+    'section'    => $self->option('usage_section', 'Hush!'),
+    'details'    => \@details,
+    'post_total' => ( $want_summary ? 'Y' : '' ),
+  };
+
+
+  return [ @cust_bill_pkg ];
+}
+
 1;