FS/FS/part_pkg/voip_cdr.pm

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