FS/FS/part_pkg/voip_cdr.pm

   1 package FS::part_pkg::voip_cdr;
   2
   3 use strict;
   4 use vars qw(@ISA $DEBUG %info);
   5 use Date::Format;
   6 use Tie::IxHash;
   7 use FS::Conf;
   8 use FS::Record qw(qsearchs qsearch);
   9 use FS::part_pkg::recur_Common;
  10 use FS::cdr;
  11 use FS::rate;
  12 use FS::rate_prefix;
  13 use FS::rate_detail;
  14 use FS::part_pkg::recur_Common;
  15
  16 use List::Util qw(first min);
  17
  18 @ISA = qw(FS::part_pkg::recur_Common);
  19
  20 $DEBUG = 0;
  21
  22 tie my %cdr_svc_method, 'Tie::IxHash',
  23   'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)',
  24   'svc_pbx.title'      => 'PBX name (svc_pbx.title)',
  25   'svc_pbx.svcnum'     => 'Freeside service # (svc_pbx.svcnum)',
  26 ;
  27
  28 tie my %rating_method, 'Tie::IxHash',
  29   'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
  30 #  '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.',
  31   'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
  32   'single_price' => 'A single price per minute for all calls.',
  33 ;
  34
  35 #tie my %cdr_location, 'Tie::IxHash',
  36 #  'internal' => 'Internal: CDR records imported into the internal CDR table',
  37 #  'external' => 'External: CDR records queried directly from an external '.
  38 #                'Asterisk (or other?) CDR table',
  39 #;
  40
  41 tie my %temporalities, 'Tie::IxHash',
  42   'upcoming'  => "Upcoming (future)",
  43   'preceding' => "Preceding (past)",
  44 ;
  45
  46 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
  47
  48 %info = (
  49   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
  50   'shortname' => 'VoIP/telco CDR rating (standard)',
  51   'inherit_fields' => [ 'global_Mixin' ],
  52   'fields' => {
  53     'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
  54                         'type' => 'checkbox',
  55                       },
  56     #false laziness w/flat.pm
  57     'recur_temporality' => { 'name' => 'Charge recurring fee for period',
  58                              'type' => 'select',
  59                              'select_options' => \%temporalities,
  60                            },
  61
  62     'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating or '.
  63                                    'subscription',
  64                          'default' => '1',
  65                        },
  66     'add_full_period'=> { 'name' => 'When prorating first month, also bill '.
  67                                     'for one full period after that',
  68                           'type' => 'checkbox',
  69                         },
  70     'recur_method'  => { 'name' => 'Recurring fee method',
  71                          #'type' => 'radio',
  72                          #'options' => \%recur_method,
  73                          'type' => 'select',
  74                          'select_options' => \%FS::part_pkg::recur_Common::recur_method,
  75                        },
  76
  77     'cdr_svc_method' => { 'name' => 'CDR service matching method',
  78                           'type' => 'radio',
  79                           'options' => \%cdr_svc_method,
  80                         },
  81
  82     'rating_method' => { 'name' => 'Rating method',
  83                          'type' => 'radio',
  84                          'options' => \%rating_method,
  85                        },
  86
  87     'ratenum'   => { 'name' => 'Rate plan',
  88                      'type' => 'select',
  89                      'select_table' => 'rate',
  90                      'select_key'   => 'ratenum',
  91                      'select_label' => 'ratename',
  92                    },
  93
  94     'min_included' => { 'name' => 'Minutes included when using "single price per minute" rating method',
  95                     },
  96
  97
  98     'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
  99                     },
 100
 101     'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
 102                            'type' => 'select',
 103                            'select_options' => \%granularity,
 104                          },
 105
 106     'ignore_unrateable' => { 'name' => 'Ignore calls without a rate in the rate tables.  By default, the system will throw a fatal error upon encountering unrateable calls.',
 107                              'type' => 'checkbox',
 108                            },
 109
 110     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
 111                           'default' => '+1',
 112                         },
 113
 114     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
 115                        'type' => 'checkbox'
 116                      },
 117
 118     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
 119                            'default' => '1',
 120                          },
 121
 122 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
 123 #                                    'type' => 'checkbox',
 124 #                                  },
 125
 126     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
 127                                 'default' => '011',
 128                               },
 129
 130     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
 131                             'type' => 'checkbox',
 132                           },
 133
 134     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
 135                         'type' => 'checkbox',
 136                       },
 137
 138     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
 139                            'type' => 'checkbox',
 140                          },
 141
 142     'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
 143                                  'type' => 'checkbox',
 144                                },
 145
 146     'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
 147                          },
 148
 149     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
 150                          },
 151
 152     'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
 153     },
 154
 155     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
 156                        },
 157
 158     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
 159                                 },
 160
 161     'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
 162                               },
 163
 164     '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',
 165                                                   'type' => 'checkbox',
 166                                                 },
 167
 168     'accountcode_tollfree_ratenum' => {
 169       'name' => 'Optional alternate rate plan when accountcode is toll free: ',
 170       'type' => 'select',
 171       'select_table'  => 'rate',
 172       'select_key'    => 'ratenum',
 173       'select_label'  => 'ratename',
 174       'disable_empty' => 0,
 175       'empty_label'   => '',
 176     },
 177
 178     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
 179                               },
 180
 181     'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
 182                                                   'type' => 'checkbox',
 183                                                 },
 184
 185     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
 186                       },
 187
 188     'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
 189                           },
 190
 191     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
 192                           'type' => 'checkbox',
 193                         },
 194
 195     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
 196                       },
 197
 198     #false laziness w/cdr_termination.pm
 199     'output_format' => { 'name' => 'CDR invoice display format',
 200                          'type' => 'select',
 201                          'select_options' => { FS::cdr::invoice_formats() },
 202                          'default'        => 'default', #XXX test
 203                        },
 204
 205     'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
 206                        },
 207
 208     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 209                           'type' => 'checkbox',
 210                         },
 211
 212     'usage_mandate' => { 'name' => 'Always put usage details in separate section',
 213                           'type' => 'checkbox',
 214                        },
 215     #eofalse
 216
 217     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment).  Useful for prepaid.',
 218                            'type' => 'checkbox',
 219                          },
 220
 221     'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
 222                               'type' => 'checkbox',
 223                             },
 224
 225     '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.',
 226                            'type' => 'checkbox',
 227                          },
 228
 229     #XXX also have option for an external db
 230 #    'cdr_location' => { 'name' => 'CDR database location'
 231 #                        'type' => 'select',
 232 #                        'select_options' => \%cdr_location,
 233 #                        'select_callback' => {
 234 #                          'external' => {
 235 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 236 #                          },
 237 #                          'internal' => {
 238 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 239 #                          }
 240 #                        },
 241 #                      },
 242 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 243 #                   'disabled' => 'Y',
 244 #                 },
 245 #    'username' => { 'name' => 'External database username',
 246 #                    'disabled' => 'Y',
 247 #                  },
 248 #    'password' => { 'name' => 'External database password',
 249 #                    'disabled' => 'Y',
 250 #                  },
 251
 252   },
 253   'fieldorder' => [qw(
 254                        recur_temporality
 255                        recur_method cutoff_day
 256                        add_full_period
 257                        cdr_svc_method
 258                        rating_method ratenum min_charge sec_granularity
 259                        ignore_unrateable
 260                        default_prefix
 261                        disable_src
 262                        domestic_prefix international_prefix
 263                        disable_tollfree
 264                        use_amaflags use_disposition
 265                        use_disposition_taqua use_carrierid use_cdrtypenum
 266                        skip_dcontext skip_dst_prefix
 267                        skip_dstchannel_prefix skip_src_length_more
 268                        noskip_src_length_accountcode_tollfree
 269                        accountcode_tollfree_ratenum
 270                        skip_dst_length_less
 271                        noskip_dst_length_accountcode_tollfree
 272                        skip_lastapp
 273                        skip_max_callers
 274                        use_duration
 275                        411_rewrite
 276                        output_format usage_mandate summarize_usage usage_section
 277                        bill_every_call bill_inactive_svcs
 278                        count_available_phones suspend_bill
 279                      )
 280                   ],
 281   'weight' => 40,
 282 );
 283
 284 sub price_info {
 285     my $self = shift;
 286     my $str = $self->SUPER::price_info;
 287     $str .= " plus usage" if $str;
 288     $str;
 289 }
 290
 291 sub calc_setup {
 292   my($self, $cust_pkg ) = @_;
 293   $self->option('setup_fee');
 294 }
 295
 296 sub calc_recur {
 297   my $self = shift;
 298   my($cust_pkg, $sdate, $details, $param ) = @_;
 299
 300   my $charges = 0;
 301
 302   $charges += $self->calc_usage(@_);
 303   $charges += $self->calc_recur_Common(@_);
 304
 305   $charges;
 306
 307 }
 308
 309 sub calc_cancel {
 310   my $self = shift;
 311   my($cust_pkg, $sdate, $details, $param ) = @_;
 312
 313   $self->calc_usage(@_);
 314 }
 315
 316 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 317
 318 sub calc_usage {
 319   my $self = shift;
 320   my($cust_pkg, $sdate, $details, $param ) = @_;
 321
 322   #my $last_bill = $cust_pkg->last_bill;
 323   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 324
 325   return 0
 326     if $self->option('recur_temporality', 1) eq 'preceding'
 327     && ( $last_bill eq '' || $last_bill == 0 );
 328
 329   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 330
 331   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
 332
 333   my %included_min = ();
 334
 335   my $charges = 0;
 336
 337 #  my $downstream_cdr = '';
 338
 339   my $cdr_svc_method    = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
 340   my $rating_method     = $self->option('rating_method') || 'prefix';
 341   my $intl              = $self->option('international_prefix') || '011';
 342   my $domestic_prefix   = $self->option('domestic_prefix');
 343   my $disable_tollfree  = $self->option('disable_tollfree');
 344   my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
 345   my $use_duration      = $self->option('use_duration');
 346
 347   my $output_format     = $self->option('output_format', 'Hush!')
 348                           || ( $rating_method eq 'upstream_simple'
 349                                  ? 'simple'
 350                                  : 'default'
 351                              );
 352
 353   my @dirass = ();
 354   if ( $self->option('411_rewrite') ) {
 355     my $dirass = $self->option('411_rewrite');
 356     $dirass =~ s/\s//g;
 357     @dirass = split(',', $dirass);
 358   }
 359
 360   my %interval_cache = (); # for timed rates
 361
 362   #for check_chargable, so we don't keep looking up options inside the loop
 363   my %opt_cache = ();
 364
 365   eval "use Text::CSV_XS;";
 366   die $@ if $@;
 367   my $csv = new Text::CSV_XS;
 368
 369   my($svc_table, $svc_field) = split('\.', $cdr_svc_method);
 370
 371   my @cust_svc;
 372   if( $self->option('bill_inactive_svcs',1) ) {
 373     #XXX in this mode do we need to restrict the set of CDRs by date also?
 374     @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
 375   }
 376   else {
 377     @cust_svc = $cust_pkg->cust_svc;
 378   }
 379   @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
 380
 381   foreach my $cust_svc (@cust_svc) {
 382
 383     my $svc_x;
 384     if( $self->option('bill_inactive_svcs',1) ) {
 385       $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
 386     }
 387     else {
 388       $svc_x = $cust_svc->svc_x;
 389     }
 390     my %options = (
 391         'disable_src'    => $self->option('disable_src'),
 392         'default_prefix' => $self->option('default_prefix'),
 393         'status'         => '',
 394         'for_update'     => 1,
 395       );  # $last_bill, $$sdate )
 396     $options{'by_svcnum'} = 1 if $svc_field eq 'svcnum';
 397
 398     my @invoice_details_sort;
 399
 400     foreach my $cdr (
 401       $svc_x->get_cdrs( %options )
 402     ) {
 403       if ( $DEBUG > 1 ) {
 404         warn "rating CDR $cdr\n".
 405              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 406       }
 407
 408       my $rate_detail;
 409       my( $rate_region, $regionnum );
 410       my $rate;
 411       my $pretty_destnum;
 412       my $charge = '';
 413       my $seconds = '';
 414       my $weektime = '';
 415       my $regionname = '';
 416       my $classnum = '';
 417       my $countrycode;
 418       my $number;
 419
 420       my @call_details = ();
 421       if ( $rating_method eq 'prefix' ) {
 422
 423         my $da_rewrote = 0;
 424         if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
 425           $cdr->dst('411');
 426           $da_rewrote = 1;
 427         }
 428
 429         my $reason = $self->check_chargable( $cdr,
 430                                              'da_rewrote'   => $da_rewrote,
 431                                              'option_cache' => \%opt_cache,
 432                                            );
 433
 434         if ( $reason ) {
 435
 436           warn "not charging for CDR ($reason)\n" if $DEBUG;
 437           $charge = 0;
 438
 439         } else {
 440
 441           ###
 442           # look up rate details based on called station id
 443           # (or calling station id for toll free calls)
 444           ###
 445
 446           my( $to_or_from );
 447           if ( $cdr->is_tollfree && ! $disable_tollfree )
 448           { #tollfree call
 449             $to_or_from = 'from';
 450             $number = $cdr->src;
 451           } else { #regular call
 452             $to_or_from = 'to';
 453             $number = $cdr->dst;
 454           }
 455
 456           warn "parsing call $to_or_from $number\n" if $DEBUG;
 457
 458           #remove non-phone# stuff and whitespace
 459           $number =~ s/\s//g;
 460 #          my $proto = '';
 461 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
 462 #          my $siphost = '';
 463 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 464
 465           #determine the country code
 466           $countrycode = '';
 467           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
 468                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
 469              )
 470           {
 471
 472             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
 473             #first look for 1 digit country code
 474             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
 475               $countrycode = $one;
 476               $number = $u1.$u2.$rest;
 477             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
 478               $countrycode = $two;
 479               $number = $u2.$rest;
 480             } else { #3 digit country code
 481               $countrycode = $three;
 482               $number = $rest;
 483             }
 484
 485           } else {
 486             $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
 487             $number =~ s/^$countrycode//;# if length($number) > 10;
 488           }
 489
 490           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
 491           $pretty_destnum = "+$countrycode $number";
 492           #asterisks here causes inserting the detail to barf, so:
 493           $pretty_destnum =~ s/\*//g;
 494
 495           my $eff_ratenum = $cdr->is_tollfree('accountcode')
 496             ? $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum')
 497             : '';
 498           $eff_ratenum ||= $ratenum;
 499           $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
 500             or die "ratenum $eff_ratenum not found!";
 501
 502           my @ltime = localtime($cdr->startdate);
 503           $weektime = $ltime[0] +
 504                       $ltime[1]*60 +   #minutes
 505                       $ltime[2]*3600 + #hours
 506                       $ltime[6]*86400; #days since sunday
 507           # if there's no timed rate_detail for this time/region combination,
 508           # dest_detail returns the default.  There may still be a timed rate
 509           # that applies after the starttime of the call, so be careful...
 510           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 511                                               'phonenum'    => $number,
 512                                               'weektime'    => $weektime,
 513                                             });
 514
 515           if ( $rate_detail ) {
 516
 517             $rate_region = $rate_detail->dest_region;
 518             $regionnum = $rate_region->regionnum;
 519             $regionname = $rate_region->regionname;
 520             warn "  found rate for regionnum $regionnum ".
 521                  "and rate detail $rate_detail\n"
 522               if $DEBUG;
 523
 524             if ( !exists($interval_cache{$regionnum}) ) {
 525               my @intervals = (
 526                 sort { $a->stime <=> $b->stime }
 527                 map { my $r = $_->rate_time; $r ? $r->intervals : () }
 528                 $rate->rate_detail
 529               );
 530               $interval_cache{$regionnum} = \@intervals;
 531               warn "  cached ".scalar(@intervals)." interval(s)\n"
 532                 if $DEBUG;
 533             }
 534
 535           } elsif ( $ignore_unrateable ) {
 536
 537             $rate_region = '';
 538             $regionnum = '';
 539             #code below will throw a warning & skip
 540
 541           } else {
 542
 543             die "FATAL: no rate_detail found in ".
 544                 $rate->ratenum. ":". $rate->ratename. " rate plan ".
 545                 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
 546                 "add a rate or set ignore_unrateable flag on the package def\n";
 547           }
 548
 549         }
 550
 551       } elsif ( $rating_method eq 'upstream_simple' ) {
 552
 553         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
 554         $charge = sprintf('%.3f', $cdr->upstream_price);
 555         $charges += $charge;
 556         warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 557
 558         @call_details = ($cdr->downstream_csv( 'format' => $output_format,
 559                                                'charge' => $charge,
 560                                              )
 561                         );
 562         $classnum = $cdr->calltypenum;
 563
 564       } elsif ( $rating_method eq 'single_price' ) {
 565
 566         # a little false laziness w/below
 567         # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
 568
 569         my $granularity = length($self->option('sec_granularity'))
 570                             ? $self->option('sec_granularity')
 571                             : 60;
 572
 573         $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
 574
 575         $seconds += $granularity - ( $seconds % $granularity )
 576           if $seconds      # don't granular-ize 0 billsec calls (bills them)
 577           && $granularity  # 0 is per call
 578           && $seconds % $granularity;
 579         my $minutes = $seconds / 60;
 580         # XXX config?
 581         #$charge = sprintf('%.2f', ( $self->option('min_charge') * $minutes )
 582                                   #+ 0.00000001 ); #so 1.005 rounds to 1.01
 583         $charge = sprintf('%.4f', ( $self->option('min_charge') * $minutes )
 584                                   + 0.0000000001 ); #so 1.00005 rounds to 1.0001
 585
 586         warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 587         $charges += $charge;
 588
 589         @call_details = ($cdr->downstream_csv( 'format'  => $output_format,
 590                                                'charge'  => $charge,
 591                                                'seconds' => ($use_duration ?
 592                                                              $cdr->duration :
 593                                                              $cdr->billsec),
 594                                                'granularity' => $granularity,
 595                                              )
 596                         );
 597
 598       } else {
 599         die "don't know how to rate CDRs using method: $rating_method\n";
 600       }
 601
 602       ###
 603       # find the price and add detail to the invoice
 604       ###
 605
 606       # if $rate_detail is not found, skip this CDR... i.e.
 607       # don't add it to invoice, don't set its status to done,
 608       # don't call downstream_csv or something on it...
 609       # but DO emit a warning...
 610       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
 611       if ( ! $rate_detail && $charge eq '' ) {
 612
 613         warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
 614              "; skipping\n"
 615
 616       } else { # there *is* a rate_detail (or call_details), proceed...
 617         # About this section:
 618         # We don't round _anything_ (except granularizing)
 619         # until the final $charge = sprintf("%.2f"...).
 620
 621         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
 622
 623           my $seconds_left = $use_duration ? $cdr->duration : $cdr->billsec;
 624           # charge for the first (conn_sec) seconds
 625           $seconds = min($seconds_left, $rate_detail->conn_sec);
 626           $seconds_left -= $seconds;
 627           $weektime     += $seconds;
 628           $charge = $rate_detail->conn_charge;
 629
 630           my $etime;
 631           while($seconds_left) {
 632             my $ratetimenum = $rate_detail->ratetimenum; # may be empty
 633
 634             # find the end of the current rate interval
 635             if(@{ $interval_cache{$regionnum} } == 0) {
 636               # There are no timed rates in this group, so just stay
 637               # in the default rate_detail for the entire duration.
 638               # Set an "end" of 1 past the end of the current call.
 639               $etime = $weektime + $seconds_left + 1;
 640             }
 641             elsif($ratetimenum) {
 642               # This is a timed rate, so go to the etime of this interval.
 643               # If it's followed by another timed rate, the stime of that
 644               # interval should match the etime of this one.
 645               my $interval = $rate_detail->rate_time->contains($weektime);
 646               $etime = $interval->etime;
 647             }
 648             else {
 649               # This is a default rate, so use the stime of the next
 650               # interval in the sequence.
 651               my $next_int = first { $_->stime > $weektime }
 652                               @{ $interval_cache{$regionnum} };
 653               if ($next_int) {
 654                 $etime = $next_int->stime;
 655               }
 656               else {
 657                 # weektime is near the end of the week, so decrement
 658                 # it by a full week and use the stime of the first
 659                 # interval.
 660                 $weektime -= (3600*24*7);
 661                 $etime = $interval_cache{$regionnum}->[0]->stime;
 662               }
 663             }
 664
 665             my $charge_sec = min($seconds_left, $etime - $weektime);
 666
 667             $seconds_left -= $charge_sec;
 668
 669             $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included
 670               unless exists $included_min{$regionnum}{$ratetimenum};
 671
 672             my $granularity = $rate_detail->sec_granularity;
 673
 674             my $minutes;
 675             if ( $granularity ) { # charge per minute
 676               # Round up to the nearest $granularity
 677               if ( $charge_sec and $charge_sec % $granularity ) {
 678                 $charge_sec += $granularity - ($charge_sec % $granularity);
 679               }
 680               $minutes = $charge_sec / 60; #don't round this
 681             }
 682             else { # per call
 683               $minutes = 1;
 684               $seconds_left = 0;
 685             }
 686
 687             $seconds += $charge_sec;
 688
 689             $included_min{$regionnum}{$ratetimenum} -= $minutes;
 690             if ( $included_min{$regionnum}{$ratetimenum} <= 0 ) {
 691               my $charge_min = 0 - $included_min{$regionnum}{$ratetimenum}; #XXX should preserve
 692                                                               #(display?) this
 693               $included_min{$regionnum}{$ratetimenum} = 0;
 694               $charge += ($rate_detail->min_charge * $charge_min); #still not rounded
 695             }
 696
 697             # choose next rate_detail
 698             $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 699                                                 'phonenum'    => $number,
 700                                                 'weektime'    => $etime })
 701                     if($seconds_left);
 702             # we have now moved forward to $etime
 703             $weektime = $etime;
 704
 705           } #while $seconds_left
 706           # this is why we need regionnum/rate_region....
 707           warn "  (rate region $rate_region)\n" if $DEBUG;
 708
 709           $classnum = $rate_detail->classnum;
 710           $charge = sprintf('%.2f', $charge + 0.000001); # NOW round it.
 711           warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 712           $charges += $charge;
 713
 714           @call_details = (
 715             $cdr->downstream_csv( 'format'         => $output_format,
 716                                   'granularity'    => $rate_detail->sec_granularity,
 717                                   'seconds'        => ($use_duration ?
 718                                                        $cdr->duration :
 719                                                        $cdr->billsec),
 720                                   'charge'         => $charge,
 721                                   'pretty_dst'     => $pretty_destnum,
 722                                   'dst_regionname' => $regionname,
 723                                 )
 724           );
 725         } #if(there is a rate_detail)
 726
 727
 728         if ( $charge > 0 ) {
 729           #just use FS::cust_bill_pkg_detail objects?
 730           my $call_details;
 731           my $phonenum = $svc_x->phonenum;
 732
 733           if ( scalar(@call_details) == 1 ) {
 734             $call_details =
 735               [ 'C',
 736                 $call_details[0],
 737                 $charge,
 738                 $classnum,
 739                 $phonenum,
 740                 $seconds,
 741                 $regionname,
 742               ];
 743           } else { #only used for $rating_method eq 'upstream' now
 744             $csv->combine(@call_details);
 745             $call_details =
 746               [ 'C',
 747                 $csv->string,
 748                 $charge,
 749                 $classnum,
 750                 $phonenum,
 751                 $seconds,
 752                 $regionname,
 753               ];
 754           }
 755           warn "  adding details on charge to invoice: [ ".
 756               join(', ', @{$call_details} ). " ]"
 757             if ( $DEBUG && ref($call_details) );
 758           push @invoice_details_sort, [ $call_details, $cdr->calldate_unix ];
 759         }
 760
 761         # if the customer flag is on, call "downstream_csv" or something
 762         # like it to export the call downstream!
 763         # XXX price plan option to pick format, or something...
 764         #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
 765         #  if $spool_cdr;
 766
 767         my $error = $cdr->set_status_and_rated_price( 'done',
 768                                                       $charge,
 769                                                       $cust_svc->svcnum,
 770                                                     );
 771         die $error if $error;
 772
 773       }
 774
 775     } # $cdr
 776
 777     my @sorted_invoice_details = sort { @{$a}[1] <=> @{$b}[1] } @invoice_details_sort;
 778     foreach my $sorted_call_detail ( @sorted_invoice_details ) {
 779         push @$details, @{$sorted_call_detail}[0];
 780     }
 781
 782   } # $cust_svc
 783
 784   unshift @$details, [ 'C',
 785                        FS::cdr::invoice_header($output_format),
 786                        '',
 787                        '',
 788                        '',
 789                        '',
 790                        '',
 791                      ]
 792     if @$details && $rating_method ne 'upstream';
 793
 794 #  if ( $spool_cdr && length($downstream_cdr) ) {
 795 #
 796 #    use FS::UID qw(datasrc);
 797 #    my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 798 #    mkdir $dir, 0700 unless -d $dir;
 799 #    $dir .= '/'. $cust_pkg->custnum.
 800 #    mkdir $dir, 0700 unless -d $dir;
 801 #    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
 802 #
 803 #    push @{ $param->{'precommit_hooks'} },
 804 #         sub {
 805 #               #lock the downstream spool file and append the records
 806 #               use Fcntl qw(:flock);
 807 #               use IO::File;
 808 #               my $spool = new IO::File ">>$filename"
 809 #                 or die "can't open $filename: $!\n";
 810 #               flock( $spool, LOCK_EX)
 811 #                 or die "can't lock $filename: $!\n";
 812 #               seek($spool, 0, 2)
 813 #                 or die "can't seek to end of $filename: $!\n";
 814 #               print $spool $downstream_cdr;
 815 #               flock( $spool, LOCK_UN );
 816 #               close $spool;
 817 #             };
 818 #
 819 #  } #if ( $spool_cdr && length($downstream_cdr) )
 820
 821   $charges;
 822 }
 823
 824 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
 825 sub check_chargable {
 826   my( $self, $cdr, %flags ) = @_;
 827
 828   #should have some better way of checking these options from a hash
 829   #or something
 830
 831   my @opt = qw(
 832     use_amaflags
 833     use_disposition
 834     use_disposition_taqua
 835     use_carrierid
 836     use_cdrtypenum
 837     skip_dst_prefix
 838     skip_dcontext
 839     skip_dstchannel_prefix
 840     skip_src_length_more noskip_src_length_accountcode_tollfree
 841     skip_dst_length_less noskip_dst_length_accountcode_tollfree
 842     skip_lastapp
 843     skip_max_callers
 844   );
 845   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
 846     $flags{option_cache}->{$opt} = $self->option($opt, 1);
 847   }
 848   my %opt = %{ $flags{option_cache} };
 849
 850   return 'amaflags != 2'
 851     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
 852
 853   return 'disposition != ANSWERED'
 854     if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
 855
 856   return "disposition != 100"
 857     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
 858
 859   return "carrierid != $opt{'use_carrierid'}"
 860     if length($opt{'use_carrierid'})
 861     && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
 862     && ! $flags{'da_rewrote'};
 863
 864   return "cdrtypenum != $opt{'use_cdrtypenum'}"
 865     if length($opt{'use_cdrtypenum'})
 866     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
 867
 868   foreach(split(',',$opt{'skip_dst_prefix'})) {
 869     return "dst starts with '$_'"
 870     if length($_) && substr($cdr->dst,0,length($_)) eq $_;
 871   }
 872
 873   return "dcontext IN ( $opt{'skip_dcontext'} )"
 874     if $opt{'skip_dcontext'} =~ /\S/
 875     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
 876
 877   my $len_prefix = length($opt{'skip_dstchannel_prefix'});
 878   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
 879     if $len_prefix
 880     && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
 881
 882   my $dst_length = $opt{'skip_dst_length_less'};
 883   return "destination less than $dst_length digits"
 884     if $dst_length && length($cdr->dst) < $dst_length
 885     && ! ( $opt{'noskip_dst_length_accountcode_tollfree'}
 886             && $cdr->is_tollfree('accountcode')
 887          );
 888
 889   return "lastapp is $opt{'skip_lastapp'}"
 890     if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
 891
 892   my $src_length = $opt{'skip_src_length_more'};
 893   if ( $src_length ) {
 894
 895     if ( $opt{'noskip_src_length_accountcode_tollfree'} ) {
 896
 897       if ( $cdr->is_tollfree('accountcode') ) {
 898         return "source less than or equal to $src_length digits"
 899           if length($cdr->src) <= $src_length;
 900       } else {
 901         return "source more than $src_length digits"
 902           if length($cdr->src) > $src_length;
 903       }
 904
 905     } else {
 906       return "source more than $src_length digits"
 907         if length($cdr->src) > $src_length;
 908     }
 909
 910   }
 911
 912   return "max_callers <= $opt{skip_max_callers}"
 913     if length($opt{'skip_max_callers'})
 914       and length($cdr->max_callers)
 915       and $cdr->max_callers <= $opt{'skip_max_callers'};
 916
 917   #all right then, rate it
 918   '';
 919 }
 920
 921 sub is_free {
 922   0;
 923 }
 924
 925 #  This equates svc_phone records; perhaps svc_phone should have a field
 926 #  to indicate it represents a line
 927 sub calc_units {
 928   my($self, $cust_pkg ) = @_;
 929   my $count = 0;
 930   if ( $self->option('count_available_phones', 1)) {
 931     map { $count += ( $_->quantity || 0 ) }
 932       grep { $_->part_svc->svcdb eq 'svc_phone' }
 933       $cust_pkg->part_pkg->pkg_svc;
 934   } else {
 935     $count =
 936       scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 937   }
 938   $count;
 939 }
 940
 941 1;
 942