X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=FS%2FFS%2Fpart_pkg%2Fvoip_cdr.pm;h=a3b54ee84bc66450e0882faa724a0321cd75beb3;hb=5b73387992a96f7b80e40b5ecb2fedabd8a78d6b;hp=155d8e78caa7962d88ab95d9663991f5e47eaf48;hpb=8e21a8c2ce7617a64ec962b3933c77a868682b94;p=freeside.git

diff --git a/FS/FS/part_pkg/voip_cdr.pm b/FS/FS/part_pkg/voip_cdr.pm
index 155d8e78c..bd0e9065b 100644
--- a/FS/FS/part_pkg/voip_cdr.pm
+++ b/FS/FS/part_pkg/voip_cdr.pm
@@ -1,23 +1,32 @@
 package FS::part_pkg::voip_cdr;
+use base qw( FS::part_pkg::recur_Common );
 
 use strict;
-use vars qw(@ISA $DEBUG %info);
-use Date::Format;
+use vars qw( $DEBUG %info );
+use List::Util qw(first min);
 use Tie::IxHash;
+use Date::Format;
+use Text::CSV_XS;
 use FS::Conf;
 use FS::Record qw(qsearchs qsearch);
-use FS::part_pkg::flat;
+use FS::cdr;
 #use FS::rate;
 #use FS::rate_prefix;
+#use FS::rate_detail;
 
-@ISA = qw(FS::part_pkg::flat);
+$DEBUG = 0;
 
-$DEBUG = 1;
+tie my %cdr_svc_method, 'Tie::IxHash',
+  'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)',
+  'svc_pbx.title'      => 'PBX name (svc_pbx.title)',
+  'svc_pbx.svcnum'     => 'Freeside service # (svc_pbx.svcnum)',
+;
 
 tie my %rating_method, 'Tie::IxHash',
   'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
-  'upstream' => 'Rate calls based on upstream data: If the call type is "1", map the upstream rate ID directly to an internal rate (rate_detail), otherwise, pass the upstream price through directly.',
+#  'upstream' => 'Rate calls based on upstream data: If the call type is "1", map the upstream rate ID directly to an internal rate (rate_detail), otherwise, pass the upstream price through directly.',
   'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
+  'single_price' => 'A single price per minute for all calls.',
 ;
 
 #tie my %cdr_location, 'Tie::IxHash',
@@ -26,30 +35,86 @@ tie my %rating_method, 'Tie::IxHash',
 #                'Asterisk (or other?) CDR table',
 #;
 
+tie my %temporalities, 'Tie::IxHash',
+  'upcoming'  => "Upcoming (future)",
+  'preceding' => "Preceding (past)",
+;
+
+tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
+
+# previously "1" was "ignore"
+tie my %unrateable_opts, 'Tie::IxHash',
+  '' => 'Exit with a fatal error',
+  1  => 'Ignore and continue',
+  2  => 'Flag for later review',
+;
+
 %info = (
   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
   'shortname' => 'VoIP/telco CDR rating (standard)',
+  'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
   'fields' => {
-    'setup_fee'     => { 'name' => 'Setup fee for this package',
-                         'default' => 0,
+    'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
+                        'type' => 'checkbox',
+                      },
+    #false laziness w/flat.pm
+    'recur_temporality' => { 'name' => 'Charge recurring fee for period',
+                             'type' => 'select',
+                             'select_options' => \%temporalities,
+                           },
+
+    'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating or '.
+                                   'subscription',
+                         'default' => '1',
                        },
-    'recur_fee'     => { 'name' => 'Base recurring fee for this package',
-                         'default' => 0,
+    'recur_method'  => { 'name' => 'Recurring fee method',
+                         #'type' => 'radio',
+                         #'options' => \%recur_method,
+                         'type' => 'select',
+                         'select_options' => \%FS::part_pkg::recur_Common::recur_method,
                        },
-    'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
-                                   ' of service at cancellation',
-                         'type' => 'checkbox',
+
+    'cdr_svc_method' => { 'name' => 'CDR service matching method',
+                          'type' => 'radio',
+                          'options' => \%cdr_svc_method,
+                        },
+
+    'rating_method' => { 'name' => 'Rating method',
+                         'type' => 'radio',
+                         'options' => \%rating_method,
                        },
+
     'ratenum'   => { 'name' => 'Rate plan',
                      'type' => 'select',
                      'select_table' => 'rate',
                      'select_key'   => 'ratenum',
                      'select_label' => 'ratename',
                    },
-    'rating_method' => { 'name' => 'Region rating method',
-                         'type' => 'radio',
-                         'options' => \%rating_method,
-                       },
+                   
+    'intrastate_ratenum'   => { 'name' => 'Optional alternate intrastate rate plan',
+                     'type' => 'select',
+                     'select_table' => 'rate',
+                     'select_key'   => 'ratenum',
+                     'select_label' => 'ratename',
+                     'disable_empty' => 0,
+                     'empty_label'   => '',
+                   },
+
+    'min_included' => { 'name' => 'Minutes included when using the "single price per minute" rating method or when using the "prefix" rating method ("region group" billing)',
+                    },
+
+    'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
+                    },
+
+    'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
+                           'type' => 'select',
+                           'select_options' => \%granularity,
+                         },
+
+    'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
+                             'type' => 'select',
+                             'select_options' => \%unrateable_opts,
+                           },
 
     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
                           'default' => '+1',
@@ -71,7 +136,107 @@ tie my %rating_method, 'Tie::IxHash',
                                 'default' => '011',
                               },
 
-    #XXX also have option for an external db
+    'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
+                            'type' => 'checkbox',
+                          },
+
+    'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
+                        'type' => 'checkbox',
+                      },
+
+    'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to: ',
+                         },
+
+    'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to: ',
+                         },
+    
+    'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to: ',
+                         },
+    
+    'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
+                         },
+    
+    'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
+                         },
+
+    'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
+    },
+
+    'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
+                       },
+
+    'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
+                                },
+
+    'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
+                              },
+
+    'noskip_src_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where source is equal or greater than the specified digits, when accountcode is toll free',
+                                                  'type' => 'checkbox',
+                                                },
+
+    'accountcode_tollfree_ratenum' => {
+      'name' => 'Optional alternate rate plan when accountcode is toll free: ',
+      'type' => 'select',
+      'select_table'  => 'rate',
+      'select_key'    => 'ratenum',
+      'select_label'  => 'ratename',
+      'disable_empty' => 0,
+      'empty_label'   => '',
+    },
+
+    'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
+                              },
+
+    'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
+                                                  'type' => 'checkbox',
+                                                },
+
+    'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
+                      },
+
+    'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
+                          },
+
+    'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
+                          'type' => 'checkbox',
+                        },
+
+    '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
+                      },
+
+    #false laziness w/cdr_termination.pm
+    'output_format' => { 'name' => 'CDR invoice display format',
+                         'type' => 'select',
+                         'select_options' => { FS::cdr::invoice_formats() },
+                         'default'        => 'default', #XXX test
+                       },
+
+    'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
+                       },
+
+    'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
+                          'type' => 'checkbox',
+                        },
+
+    'usage_mandate' => { 'name' => 'Always put usage details in separate section',
+                          'type' => 'checkbox',
+                       },
+    #eofalse
+
+    'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment).  Useful for prepaid.',
+                           'type' => 'checkbox',
+                         },
+
+    'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
+                              'type' => 'checkbox',
+                            },
+
+    'count_available_phones' => { 'name' => 'Consider for tax purposes the number of lines to be svc_phones that may be provisioned rather than those that actually are.',
+                           'type' => 'checkbox',
+                         },
+
+    #XXX also have option for an external db?  these days we suck them into ours
 #    'cdr_location' => { 'name' => 'CDR database location'
 #                        'type' => 'select',
 #                        'select_options' => \%cdr_location,
@@ -95,301 +260,428 @@ tie my %rating_method, 'Tie::IxHash',
 #                  },
 
   },
-  'fieldorder' => [qw( setup_fee recur_fee unused_credit ratenum rating_method default_prefix disable_src domestic_prefix international_prefix )],
+  'fieldorder' => [qw(
+                       recur_temporality
+                       recur_method cutoff_day ),
+                       FS::part_pkg::prorate_Mixin::fieldorder,
+                    qw(
+                       cdr_svc_method
+                       rating_method ratenum intrastate_ratenum 
+                       min_charge min_included sec_granularity
+                       ignore_unrateable
+                       default_prefix
+                       disable_src
+                       domestic_prefix international_prefix
+                       disable_tollfree
+                       use_amaflags
+                       use_carrierid 
+                       use_cdrtypenum ignore_cdrtypenum
+                       ignore_disposition disposition_in
+                       skip_dcontext skip_dst_prefix 
+                       skip_dstchannel_prefix skip_src_length_more 
+                       noskip_src_length_accountcode_tollfree
+                       accountcode_tollfree_ratenum
+                       skip_dst_length_less
+                       noskip_dst_length_accountcode_tollfree
+                       skip_lastapp
+                       skip_max_callers
+                       use_duration
+                       411_rewrite
+                       output_format usage_mandate summarize_usage usage_section
+                       bill_every_call bill_inactive_svcs
+                       count_available_phones suspend_bill 
+                     )
+                  ],
   'weight' => 40,
 );
 
-sub calc_setup {
-  my($self, $cust_pkg ) = @_;
-  $self->option('setup_fee');
+sub price_info {
+    my $self = shift;
+    my $str = $self->SUPER::price_info;
+    $str .= " plus usage" if $str;
+    $str;
 }
 
-#false laziness w/voip_sqlradacct... resolve it if that one ever gets used again
 sub calc_recur {
-  my($self, $cust_pkg, $sdate, $details, $param ) = @_;
+  my $self = shift;
+  my($cust_pkg, $sdate, $details, $param ) = @_;
+
+  my $charges = 0;
+
+  $charges += $self->calc_usage(@_);
+  $charges += $self->calc_recur_Common(@_);
+
+  $charges;
 
-  my $last_bill = $cust_pkg->last_bill;
+}
+
+sub calc_cancel {
+  my $self = shift;
+  my($cust_pkg, $sdate, $details, $param ) = @_;
+
+  $self->calc_usage(@_);
+}
 
-  my $ratenum = $cust_pkg->part_pkg->option('ratenum');
+#false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 
-  my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
+sub calc_usage {
+  my $self = shift;
+  my($cust_pkg, $sdate, $details, $param ) = @_;
 
-  my %included_min = ();
+  #my $last_bill = $cust_pkg->last_bill;
+  my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
+
+  return 0
+    if $self->recur_temporality eq 'preceding'
+    && ( $last_bill eq '' || $last_bill == 0 );
 
   my $charges = 0;
 
-  my $downstream_cdr = '';
+  my $included_min = $self->option('min_included', 1) || 0; #single price rating
+
+  my $cdr_svc_method    = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
+  my $rating_method     = $self->option('rating_method') || 'prefix';
+  my $region_group_included_min = $self->option('min_included',1) || 0;
+  my %region_group_included_min = ();
+
+  my $output_format     = $self->option('output_format', 'Hush!')
+                          || ( $rating_method eq 'upstream_simple'
+                                 ? 'simple'
+                                 : 'default'
+                             );
+
+  my $use_duration = $self->option('use_duration');
+
+  my $csv = new Text::CSV_XS;
+
+  my($svc_table, $svc_field) = split('\.', $cdr_svc_method);
+
+  my @cust_svc;
+  if( $self->option('bill_inactive_svcs',1) ) {
+    #XXX in this mode do we need to restrict the set of CDRs by date also?
+    @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
+  }
+  else {
+    @cust_svc = $cust_pkg->cust_svc;
+  }
+  @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
+
+  foreach my $cust_svc (@cust_svc) {
+
+    my $svc_x;
+    if( $self->option('bill_inactive_svcs',1) ) {
+      $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
+    }
+    else {
+      $svc_x = $cust_svc->svc_x;
+    }
+
+    my %options = (
+        'disable_src'    => $self->option('disable_src'),
+        'default_prefix' => $self->option('default_prefix'),
+        'cdrtypenum'     => $self->option('use_cdrtypenum'),
+        'status'         => '',
+        'for_update'     => 1,
+      );  # $last_bill, $$sdate )
+    $options{'by_svcnum'} = 1 if $svc_field eq 'svcnum';
+
+    my @invoice_details_sort;
+
+    #first rate any outstanding CDRs not yet rated
+    foreach my $cdr (
+      $svc_x->get_cdrs( %options )
+    ) {
+
+      my $error = $cdr->rate(
+        'part_pkg'                          => $self,
+        'svcnum'                            => $svc_x->svcnum,
+        'single_price_included_min'         => \$included_min,
+        'region_group_included_min'         => \$region_group_included_min,
+        'region_group_included_min_hashref' => \%region_group_included_min,
+      );
+      die $error if $error; #??
 
-  foreach my $cust_svc (
-    grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
-  ) {
+    } # $cdr
 
+    #then add details to invoices & get a total
+    $options{'status'} = 'rated';
     foreach my $cdr (
-      $cust_svc->get_cdrs_for_update()  # $last_bill, $$sdate )
+      $svc_x->get_cdrs( %options )
     ) {
-      if ( $DEBUG > 1 ) {
-        warn "rating CDR $cdr\n".
-             join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
-      }
 
-      my $rate_detail;
-      my( $rate_region, $regionnum );
-      my $pretty_destnum;
-      my $charge = 0;
+      my $classnum = '';
       my @call_details = ();
-      if ( $self->option('rating_method') eq 'prefix'
-           || ! $self->option('rating_method')
-         )
-      {
-
-        ###
-        # look up rate details based on called station id
-        # (or calling station id for toll free calls)
-        ###
-
-        my( $to_or_from, $number );
-        if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/ ) { #tollfree call
-          $to_or_from = 'from';
-          $number = $cdr->src;
-        } else { #regular call
-          $to_or_from = 'to';
-          $number = $cdr->dst;
-        }
-  
-        #remove non-phone# stuff and whitespace
-        $number =~ s/\s//g;
-#        my $proto = '';
-#        $dest =~ s/^(\w+):// and $proto = $1; #sip:
-#        my $siphost = '';
-#        $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
-
-        my $intl = $self->option('international_prefix') || '011';
-  
-        #determine the country code
-        my $countrycode;
-        if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
-             || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
-           )
-        {
-  
-          my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
-          #first look for 1 digit country code
-          if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
-            $countrycode = $one;
-            $number = $u1.$u2.$rest;
-          } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
-            $countrycode = $two;
-            $number = $u2.$rest;
-          } else { #3 digit country code
-            $countrycode = $three;
-            $number = $rest;
-          }
-  
-        } else {
-          $countrycode = $self->option('domestic_prefix') || '1';
-          $number =~ s/^$countrycode//;# if length($number) > 10;
-        }
-  
-        warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
-        $pretty_destnum = "+$countrycode $number";
-  
-        #find a rate prefix, first look at most specific (4 digits) then 3, etc.,
-        # finally trying the country code only
-        my $rate_prefix = '';
-        for my $len ( reverse(1..6) ) {
-          $rate_prefix = qsearchs('rate_prefix', {
-            'countrycode' => $countrycode,
-            #'npa'         => { op=> 'LIKE', value=> substr($number, 0, $len) }
-            'npa'         => substr($number, 0, $len),
-          } ) and last;
+      
+      if ( $rating_method eq 'prefix' ) {
+
+        $classnum = $cdr->rated_classnum;
+
+        unless ( $self->sum_usage ) {
+          @call_details = ($cdr->downstream_csv(
+            'format'         => $output_format,
+            'granularity'    => $cdr->rated_granularity, 
+            'seconds'        =>($use_duration ? $cdr->duration : $cdr->billsec),
+            'charge'         => $cdr->rated_price,
+            'pretty_dst'     => $cdr->rated_pretty_dst,
+            'dst_regionname' => $cdr->rated_regionname,
+          ));
         }
-        $rate_prefix ||= qsearchs('rate_prefix', {
-          'countrycode' => $countrycode,
-          'npa'         => '',
-        });
-
-        #
-        die "Can't find rate for call $to_or_from +$countrycode $number\n"
-          unless $rate_prefix;
-  
-        $regionnum = $rate_prefix->regionnum;
-        $rate_detail = qsearchs('rate_detail', {
-          'ratenum'        => $ratenum,
-          'dest_regionnum' => $regionnum,
-        } );
-  
-        $rate_region = $rate_prefix->rate_region;
-
-        warn "  found rate for regionnum $regionnum ".
-             "and rate detail $rate_detail\n"
-          if $DEBUG;
 
-      } elsif ( $self->option('rating_method') eq 'upstream' ) {
 
-        if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
+      } elsif ( $rating_method eq 'upstream_simple' ) {
 
-          $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
+        $classnum = $cdr->calltypenum; #? meaningful these days?
 
-          $regionnum = $rate_detail->dest_regionnum;
-          $rate_region = $rate_detail->dest_region;
+        @call_details = ($cdr->downstream_csv(
+          'format' => $output_format,
+          'charge' => $cdr->rated_price,
+        ));
 
-          $pretty_destnum = $cdr->dst;
+      } elsif ( $rating_method eq 'single_price' ) {
 
-          warn "  found rate for regionnum $regionnum and ".
-               "rate detail $rate_detail\n"
-            if $DEBUG;
+        my $granularity = length($self->option_cacheable('sec_granularity'))
+                            ? $self->option_cacheable('sec_granularity')
+                            : 60;
 
-        } else { #pass upstream price through
+        @call_details = ($cdr->downstream_csv(
+          'format'      => $output_format,
+          'charge'      => $cdr->rated_price,
+          'seconds'     => ($use_duration ? $cdr->duration : $cdr->billsec),
+          'granularity' => $granularity,
+        ));
 
-          $charge = sprintf('%.2f', $cdr->upstream_price);
-  
-          @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
-            'N/A', #minutes...
-            '$'.$charge,
-            #$pretty_destnum,
-            $cdr->description, #$rate_region->regionname,
-          );
+      } else {
+        die "don't know how to rate CDRs using method: $rating_method\n";
+      }
 
-        }
+      $charges += $cdr->rated_price;
+
+      #if ( $cdr->rated_price > 0 ) {
+      # generate a detail record for every call; filter out
+      # $cdr->rated_price == 0 # later.
+      my $call_details;
+      my $phonenum = $svc_x->phonenum;
+
+      if ( scalar(@call_details) == 1 ) {
+        $call_details =
+        { format      => 'C',
+          detail      => $call_details[0],
+          amount      => $cdr->rated_price,
+          classnum    => $classnum,
+          phonenum    => $phonenum,
+          accountcode => $cdr->accountcode,
+          startdate   => $cdr->startdate,
+          duration    => $cdr->rated_seconds,
+          regionname  => $cdr->rated_regionname,
+        };
+      } else { #only used for $rating_method eq 'upstream' now
+        # and for sum_ formats
+        $csv->combine(@call_details);
+        $call_details =
+        { format      => 'C',
+          detail      => $csv->string,
+          amount      => $cdr->rated_price,
+          classnum    => $classnum,
+          phonenum    => $phonenum,
+          accountcode => $cdr->accountcode,
+          startdate   => $cdr->startdate,
+          duration    => $cdr->rated_seconds,
+          regionname  => $cdr->rated_regionname,
+        };
+      }
+      $call_details->{'ratename'} = $cdr->rated_ratename;
 
-      } elsif ( $self->option('rating_method') eq 'upstream_simple' ) {
+      push @invoice_details_sort, [ $call_details, $cdr->calldate_unix ];
+      #} $charge > 0
 
-        #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
-        $charge = sprintf('%.3f', $cdr->upstream_price);
-        $charges += $charge;
+      my $error = $cdr->set_status('done');
+      die $error if $error; #??
 
-        @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
-          sprintf('%.2f', $cdr->billsec / 60 ).'m',
-          '$'.$charge, #XXX $money_char
-          #$pretty_destnum,
-          $cdr->userfield, #$rate_region->regionname,
-          $cdr->dst,
-        );
+    }
 
-      } else {
-        die "don't know how to rate CDRs using method: ".
-            $self->option('rating_method'). "\n";
+    if ( !$self->sum_usage ) {
+      #sort them
+      my @sorted_invoice_details = 
+        sort { @{$a}[1] <=> @{$b}[1] } @invoice_details_sort;
+      foreach my $sorted_call_detail ( @sorted_invoice_details ) {
+        my $d = $sorted_call_detail->[0];
+        push @$details, $d if $d->{amount} > 0;
       }
+    }
+    else { #$self->sum_usage
+        push @$details, $self->sum_detail($svc_x, \@invoice_details_sort);
+    }
+  } # $cust_svc
 
-      ###
-      # find the price and add detail to the invoice
-      ###
+  unshift @$details, { format => 'C',
+                       detail => FS::cdr::invoice_header($output_format),
+                     }
+    if @$details && $rating_method ne 'upstream';
 
-      # if $rate_detail is not found, skip this CDR... i.e. 
-      # don't add it to invoice, don't set its status to NULL,
-      # don't call downstream_csv or something on it...
-      # but DO emit a warning...
-      if ( ! $rate_detail && ! scalar(@call_details) ) {
-  
-        warn "no rate_detail found for CDR.acctid:  ". $cdr->acctid.
-             "; skipping\n"
+  $charges;
+}
 
-      } else { # there *is* a rate_detail (or call_details), proceed...
+#returns a reason why not to rate this CDR, or false if the CDR is chargeable
+sub check_chargable {
+  my( $self, $cdr, %flags ) = @_;
 
-        unless ( @call_details ) {
-    
-          $included_min{$regionnum} = $rate_detail->min_included
-            unless exists $included_min{$regionnum};
-      
-          my $granularity = $rate_detail->sec_granularity;
-          my $seconds = $cdr->billsec; # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
-          $seconds += $granularity - ( $seconds % $granularity )
-            if $seconds      # don't granular-ize 0 billsec calls (bills them)
-            && $granularity; # 0 is per call
-          my $minutes = sprintf("%.1f", $seconds / 60);
-          $minutes =~ s/\.0$// if $granularity == 60;
-
-          # per call rather than per minute
-          $minutes = 1 unless $granularity;
-      
-          $included_min{$regionnum} -= $minutes;
-      
-          if ( $included_min{$regionnum} < 0 ) {
-            my $charge_min = 0 - $included_min{$regionnum};
-            $included_min{$regionnum} = 0;
-            $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
-            $charges += $charge;
-          }
-      
-          # this is why we need regionnum/rate_region....
-          warn "  (rate region $rate_region)\n" if $DEBUG;
-      
-          @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
-            $granularity ? $minutes.'m' : $minutes.' call',
-            '$'.$charge,
-            $pretty_destnum,
-            $rate_region->regionname,
-          );
+  return 'amaflags != 2'
+    if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
 
-        }
-    
-        warn "  adding details on charge to invoice: ".
-             join(' - ', @call_details )
-          if $DEBUG && $charge > 0;
-    
-        push @$details, join(' - ', @call_details) #\@call_details,
-          if $charge > 0;
-  
-        # if the customer flag is on, call "downstream_csv" or something
-        # like it to export the call downstream!
-        # XXX price plan option to pick format, or something...
-        $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
-          if $spool_cdr;
+  return "disposition NOT IN ( $self->option_cacheable('disposition_in') )"
+    if $self->option_cacheable('disposition_in') =~ /\S/
+    && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
   
-        my $error = $cdr->set_status_and_rated_price('done', $charge);
-        die $error if $error;
+  return "disposition IN ( $self->option_cacheable('ignore_disposition') )"
+    if $self->option_cacheable('ignore_disposition') =~ /\S/
+    && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
+
+  foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
+    return "dst starts with '$_'"
+    if length($_) && substr($cdr->dst,0,length($_)) eq $_;
+  }
+
+  return "carrierid != $self->option_cacheable('use_carrierid')"
+    if length($self->option_cacheable('use_carrierid'))
+    && $cdr->carrierid ne $self->option_cacheable('use_carrierid') #ne otherwise 0 matches ''
+    && ! $flags{'da_rewrote'};
+
+  # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
+  return "cdrtypenum != $self->option_cacheable('use_cdrtypenum')"
+    if length($self->option_cacheable('use_cdrtypenum'))
+    && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
   
+  return "cdrtypenum == $self->option_cacheable('ignore_cdrtypenum')"
+    if length($self->option_cacheable('ignore_cdrtypenum'))
+    && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
+
+  return "dcontext IN ( $self->option_cacheable('skip_dcontext') )"
+    if $self->option_cacheable('skip_dcontext') =~ /\S/
+    && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
+
+  my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
+  return "dstchannel starts with $self->option_cacheable('skip_dstchannel_prefix')"
+    if $len_prefix
+    && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
+
+  my $dst_length = $self->option_cacheable('skip_dst_length_less');
+  return "destination less than $dst_length digits"
+    if $dst_length && length($cdr->dst) < $dst_length
+    && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
+            && $cdr->is_tollfree('accountcode')
+         );
+
+  return "lastapp is $self->option_cacheable('skip_lastapp')"
+    if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
+
+  my $src_length = $self->option_cacheable('skip_src_length_more');
+  if ( $src_length ) {
+
+    if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
+
+      if ( $cdr->is_tollfree('accountcode') ) {
+        return "source less than or equal to $src_length digits"
+          if length($cdr->src) <= $src_length;
+      } else {
+        return "source more than $src_length digits"
+          if length($cdr->src) > $src_length;
       }
-  
-    } # $cdr
 
-  } # $cust_svc
+    } else {
+      return "source more than $src_length digits"
+        if length($cdr->src) > $src_length;
+    }
+
+  }
 
-  if ( $spool_cdr && length($downstream_cdr) ) {
-
-    use FS::UID qw(datasrc);
-    my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
-    mkdir $dir, 0700 unless -d $dir;
-    $dir .= '/'. $cust_pkg->custnum.
-    mkdir $dir, 0700 unless -d $dir;
-    my $filename = time2str("$dir/CDR%Y%m%d-spool.CSV", time); #XXX invoice date instead?  would require changing the order things are generated in cust_main::bill insert cust_bill first - with transactions it could be done though
-
-    push @{ $param->{'precommit_hooks'} },
-         sub {
-               #lock the downstream spool file and append the records 
-               use Fcntl qw(:flock);
-               use IO::File;
-               my $spool = new IO::File ">>$filename"
-                 or die "can't open $filename: $!\n";
-               flock( $spool, LOCK_EX)
-                 or die "can't lock $filename: $!\n";
-               seek($spool, 0, 2)
-                 or die "can't seek to end of $filename: $!\n";
-               print $spool $downstream_cdr;
-               flock( $spool, LOCK_UN );
-               close $spool;
-             };
-
-  } #if ( $spool_cdr && length($downstream_cdr) )
-
-  $self->option('recur_fee') + $charges;
+  return "max_callers <= ". $self->option_cacheable('skip_max_callers')
+    if length($self->option_cacheable('skip_max_callers'))
+      and length($cdr->max_callers)
+      and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
 
+  #all right then, rate it
+  '';
 }
 
 sub is_free {
   0;
 }
 
-sub base_recur {
-  my($self, $cust_pkg) = @_;
-  $self->option('recur_fee');
+#  This equates svc_phone records; perhaps svc_phone should have a field
+#  to indicate it represents a line
+sub calc_units {    
+  my($self, $cust_pkg ) = @_;
+  my $count = 0;
+  if ( $self->option('count_available_phones', 1)) {
+    map { $count += ( $_->quantity || 0 ) }
+      grep { $_->part_svc->svcdb eq 'svc_phone' }
+      $cust_pkg->part_pkg->pkg_svc;
+  } else {
+    $count = 
+      scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
+  }
+  $count;
+}
+
+# tells whether cust_bill_pkg_detail should return a single line for 
+# each phonenum
+sub sum_usage {
+  my $self = shift;
+  $self->option('output_format') =~ /^sum_/;
+}
+
+sub sum_detail {
+  my $self = shift;
+  my $svc_x = shift;
+  my $invoice_details = shift || [];
+  return () if !@$invoice_details;
+  my $details_by_rate = {};
+  # combine the entire set of CDRs
+  foreach ( @$invoice_details ) {
+    my $d = $_->[0];
+    my $sum = $details_by_rate->{ $d->{ratename} } ||= {
+      amount      => 0,
+      format      => 'C',
+      classnum    => '', #XXX
+      duration    => 0,
+      phonenum    => $svc_x->phonenum,
+      accountcode => '', #XXX
+      startdate   => '', #XXX
+      regionname  => '',
+      count       => 0,
+    };
+    $sum->{amount} += $d->{amount};
+    $sum->{duration} += $d->{duration};
+    $sum->{count}++;
+  }
+  my @details;
+  foreach my $ratename ( sort keys(%$details_by_rate) ) {
+    my $sum = $details_by_rate->{$ratename};
+    next if $sum->{count} == 0;
+    my $total_cdr = FS::cdr->new({
+        'billsec' => $sum->{duration},
+        'src'     => $sum->{phonenum},
+      });
+    $sum->{detail} = $total_cdr->downstream_csv(
+      format    => $self->option('output_format'),
+      seconds   => $sum->{duration},
+      charge    => sprintf('%.2f',$sum->{amount}),
+      ratename  => $ratename,
+      phonenum  => $sum->{phonenum},
+      count     => $sum->{count},
+    );
+    push @details, $sum;
+  }
+  @details;
+}
+
+# and whether cust_bill should show a detail line for the service label 
+# (separate from usage details)
+sub hide_svc_detail {
+  my $self = shift;
+  $self->option('output_format') =~ /^sum_/;
 }
 
+
 1;