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     #false laziness w/flat.pm
  54     'recur_temporality' => { 'name' => 'Charge recurring fee for period',
  55                              'type' => 'select',
  56                              'select_options' => \%temporalities,
  57                            },
  58
  59     'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating or '.
  60                                    'subscription',
  61                          'default' => '1',
  62                        },
  63     'add_full_period'=> { 'name' => 'When prorating first month, also bill '.
  64                                     'for one full period after that',
  65                           'type' => 'checkbox',
  66                         },
  67     'recur_method'  => { 'name' => 'Recurring fee method',
  68                          #'type' => 'radio',
  69                          #'options' => \%recur_method,
  70                          'type' => 'select',
  71                          'select_options' => \%FS::part_pkg::recur_Common::recur_method,
  72                        },
  73
  74     'cdr_svc_method' => { 'name' => 'CDR service matching method',
  75                           'type' => 'radio',
  76                           'options' => \%cdr_svc_method,
  77                         },
  78
  79     'rating_method' => { 'name' => 'Rating method',
  80                          'type' => 'radio',
  81                          'options' => \%rating_method,
  82                        },
  83
  84     'ratenum'   => { 'name' => 'Rate plan',
  85                      'type' => 'select',
  86                      'select_table' => 'rate',
  87                      'select_key'   => 'ratenum',
  88                      'select_label' => 'ratename',
  89                    },
  90
  91     'min_included' => { 'name' => 'Minutes included when using "single price per minute" rating method',
  92                     },
  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 sec_granularity
 256                        ignore_unrateable
 257                        default_prefix
 258                        disable_src
 259                        domestic_prefix international_prefix
 260                        disable_tollfree
 261                        use_amaflags use_disposition
 262                        use_disposition_taqua use_carrierid use_cdrtypenum
 263                        skip_dcontext skip_dst_prefix
 264                        skip_dstchannel_prefix skip_src_length_more
 265                        noskip_src_length_accountcode_tollfree
 266                        accountcode_tollfree_ratenum
 267                        skip_dst_length_less
 268                        noskip_dst_length_accountcode_tollfree
 269                        skip_lastapp
 270                        skip_max_callers
 271                        use_duration
 272                        411_rewrite
 273                        output_format usage_mandate summarize_usage usage_section
 274                        bill_every_call bill_inactive_svcs
 275                        count_available_phones
 276                      )
 277                   ],
 278   'weight' => 40,
 279 );
 280
 281 sub price_info {
 282     my $self = shift;
 283     my $str = $self->SUPER::price_info;
 284     $str .= " plus usage" if $str;
 285     $str;
 286 }
 287
 288 sub calc_setup {
 289   my($self, $cust_pkg ) = @_;
 290   $self->option('setup_fee');
 291 }
 292
 293 sub calc_recur {
 294   my $self = shift;
 295   my($cust_pkg, $sdate, $details, $param ) = @_;
 296
 297   my $charges = 0;
 298
 299   $charges += $self->calc_usage(@_);
 300   $charges += $self->calc_recur_Common(@_);
 301
 302   $charges;
 303
 304 }
 305
 306 sub calc_cancel {
 307   my $self = shift;
 308   my($cust_pkg, $sdate, $details, $param ) = @_;
 309
 310   $self->calc_usage(@_);
 311 }
 312
 313 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 314
 315 sub calc_usage {
 316   my $self = shift;
 317   my($cust_pkg, $sdate, $details, $param ) = @_;
 318
 319   #my $last_bill = $cust_pkg->last_bill;
 320   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 321
 322   return 0
 323     if $self->option('recur_temporality', 1) eq 'preceding'
 324     && ( $last_bill eq '' || $last_bill == 0 );
 325
 326   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 327
 328   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
 329
 330   my %included_min = ();
 331
 332   my $charges = 0;
 333
 334 #  my $downstream_cdr = '';
 335
 336   my $cdr_svc_method    = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
 337   my $rating_method     = $self->option('rating_method') || 'prefix';
 338   my $intl              = $self->option('international_prefix') || '011';
 339   my $domestic_prefix   = $self->option('domestic_prefix');
 340   my $disable_tollfree  = $self->option('disable_tollfree');
 341   my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
 342   my $use_duration      = $self->option('use_duration');
 343
 344   my $output_format     = $self->option('output_format', 'Hush!')
 345                           || ( $rating_method eq 'upstream_simple'
 346                                  ? 'simple'
 347                                  : 'default'
 348                              );
 349
 350   my @dirass = ();
 351   if ( $self->option('411_rewrite') ) {
 352     my $dirass = $self->option('411_rewrite');
 353     $dirass =~ s/\s//g;
 354     @dirass = split(',', $dirass);
 355   }
 356
 357   my %interval_cache = (); # for timed rates
 358
 359   #for check_chargable, so we don't keep looking up options inside the loop
 360   my %opt_cache = ();
 361
 362   eval "use Text::CSV_XS;";
 363   die $@ if $@;
 364   my $csv = new Text::CSV_XS;
 365
 366   my($svc_table, $svc_field) = split('\.', $cdr_svc_method);
 367
 368   my @cust_svc;
 369   if( $self->option('bill_inactive_svcs',1) ) {
 370     #XXX in this mode do we need to restrict the set of CDRs by date also?
 371     @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
 372   }
 373   else {
 374     @cust_svc = $cust_pkg->cust_svc;
 375   }
 376   @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
 377
 378   foreach my $cust_svc (@cust_svc) {
 379
 380     my $svc_x;
 381     if( $self->option('bill_inactive_svcs',1) ) {
 382       $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
 383     }
 384     else {
 385       $svc_x = $cust_svc->svc_x;
 386     }
 387     my %options = (
 388         'disable_src'    => $self->option('disable_src'),
 389         'default_prefix' => $self->option('default_prefix'),
 390         'status'         => '',
 391         'for_update'     => 1,
 392       );  # $last_bill, $$sdate )
 393     $options{'by_svcnum'} = 1 if $svc_field eq 'svcnum';
 394
 395     my @invoice_details_sort;
 396
 397     foreach my $cdr (
 398       $svc_x->get_cdrs( %options )
 399     ) {
 400       if ( $DEBUG > 1 ) {
 401         warn "rating CDR $cdr\n".
 402              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 403       }
 404
 405       my $rate_detail;
 406       my( $rate_region, $regionnum );
 407       my $rate;
 408       my $pretty_destnum;
 409       my $charge = '';
 410       my $seconds = '';
 411       my $weektime = '';
 412       my $regionname = '';
 413       my $classnum = '';
 414       my $countrycode;
 415       my $number;
 416
 417       my @call_details = ();
 418       if ( $rating_method eq 'prefix' ) {
 419
 420         my $da_rewrote = 0;
 421         if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
 422           $cdr->dst('411');
 423           $da_rewrote = 1;
 424         }
 425
 426         my $reason = $self->check_chargable( $cdr,
 427                                              'da_rewrote'   => $da_rewrote,
 428                                              'option_cache' => \%opt_cache,
 429                                            );
 430
 431         if ( $reason ) {
 432
 433           warn "not charging for CDR ($reason)\n" if $DEBUG;
 434           $charge = 0;
 435
 436         } else {
 437
 438           ###
 439           # look up rate details based on called station id
 440           # (or calling station id for toll free calls)
 441           ###
 442
 443           my( $to_or_from );
 444           if ( $cdr->is_tollfree && ! $disable_tollfree )
 445           { #tollfree call
 446             $to_or_from = 'from';
 447             $number = $cdr->src;
 448           } else { #regular call
 449             $to_or_from = 'to';
 450             $number = $cdr->dst;
 451           }
 452
 453           warn "parsing call $to_or_from $number\n" if $DEBUG;
 454
 455           #remove non-phone# stuff and whitespace
 456           $number =~ s/\s//g;
 457 #          my $proto = '';
 458 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
 459 #          my $siphost = '';
 460 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 461
 462           #determine the country code
 463           $countrycode = '';
 464           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
 465                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
 466              )
 467           {
 468
 469             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
 470             #first look for 1 digit country code
 471             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
 472               $countrycode = $one;
 473               $number = $u1.$u2.$rest;
 474             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
 475               $countrycode = $two;
 476               $number = $u2.$rest;
 477             } else { #3 digit country code
 478               $countrycode = $three;
 479               $number = $rest;
 480             }
 481
 482           } else {
 483             $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
 484             $number =~ s/^$countrycode//;# if length($number) > 10;
 485           }
 486
 487           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
 488           $pretty_destnum = "+$countrycode $number";
 489           #asterisks here causes inserting the detail to barf, so:
 490           $pretty_destnum =~ s/\*//g;
 491
 492           my $eff_ratenum = $cdr->is_tollfree('accountcode')
 493             ? $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum')
 494             : '';
 495           $eff_ratenum ||= $ratenum;
 496           $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
 497             or die "ratenum $eff_ratenum not found!";
 498
 499           my @ltime = localtime($cdr->startdate);
 500           $weektime = $ltime[0] +
 501                       $ltime[1]*60 +   #minutes
 502                       $ltime[2]*3600 + #hours
 503                       $ltime[6]*86400; #days since sunday
 504           # if there's no timed rate_detail for this time/region combination,
 505           # dest_detail returns the default.  There may still be a timed rate
 506           # that applies after the starttime of the call, so be careful...
 507           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 508                                               'phonenum'    => $number,
 509                                               'weektime'    => $weektime,
 510                                             });
 511
 512           if ( $rate_detail ) {
 513
 514             $rate_region = $rate_detail->dest_region;
 515             $regionnum = $rate_region->regionnum;
 516             $regionname = $rate_region->regionname;
 517             warn "  found rate for regionnum $regionnum ".
 518                  "and rate detail $rate_detail\n"
 519               if $DEBUG;
 520
 521             if ( !exists($interval_cache{$regionnum}) ) {
 522               my @intervals = (
 523                 sort { $a->stime <=> $b->stime }
 524                 map { my $r = $_->rate_time; $r ? $r->intervals : () }
 525                 $rate->rate_detail
 526               );
 527               $interval_cache{$regionnum} = \@intervals;
 528               warn "  cached ".scalar(@intervals)." interval(s)\n"
 529                 if $DEBUG;
 530             }
 531
 532           } elsif ( $ignore_unrateable ) {
 533
 534             $rate_region = '';
 535             $regionnum = '';
 536             #code below will throw a warning & skip
 537
 538           } else {
 539
 540             die "FATAL: no rate_detail found in ".
 541                 $rate->ratenum. ":". $rate->ratename. " rate plan ".
 542                 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
 543                 "add a rate or set ignore_unrateable flag on the package def\n";
 544           }
 545
 546         }
 547
 548       } elsif ( $rating_method eq 'upstream_simple' ) {
 549
 550         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
 551         $charge = sprintf('%.3f', $cdr->upstream_price);
 552         $charges += $charge;
 553         warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 554
 555         @call_details = ($cdr->downstream_csv( 'format' => $output_format,
 556                                                'charge' => $charge,
 557                                              )
 558                         );
 559         $classnum = $cdr->calltypenum;
 560
 561       } elsif ( $rating_method eq 'single_price' ) {
 562
 563         # a little false laziness w/below
 564         # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
 565
 566         my $granularity = length($self->option('sec_granularity'))
 567                             ? $self->option('sec_granularity')
 568                             : 60;
 569
 570         $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
 571
 572         $seconds += $granularity - ( $seconds % $granularity )
 573           if $seconds      # don't granular-ize 0 billsec calls (bills them)
 574           && $granularity  # 0 is per call
 575           && $seconds % $granularity;
 576         my $minutes = $seconds / 60;
 577         # XXX config?
 578         #$charge = sprintf('%.2f', ( $self->option('min_charge') * $minutes )
 579                                   #+ 0.00000001 ); #so 1.005 rounds to 1.01
 580         $charge = sprintf('%.4f', ( $self->option('min_charge') * $minutes )
 581                                   + 0.0000000001 ); #so 1.00005 rounds to 1.0001
 582
 583         warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 584         $charges += $charge;
 585
 586         @call_details = ($cdr->downstream_csv( 'format'  => $output_format,
 587                                                'charge'  => $charge,
 588                                                'seconds' => ($use_duration ?
 589                                                              $cdr->duration :
 590                                                              $cdr->billsec),
 591                                                'granularity' => $granularity,
 592                                              )
 593                         );
 594
 595       } else {
 596         die "don't know how to rate CDRs using method: $rating_method\n";
 597       }
 598
 599       ###
 600       # find the price and add detail to the invoice
 601       ###
 602
 603       # if $rate_detail is not found, skip this CDR... i.e.
 604       # don't add it to invoice, don't set its status to done,
 605       # don't call downstream_csv or something on it...
 606       # but DO emit a warning...
 607       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
 608       if ( ! $rate_detail && $charge eq '' ) {
 609
 610         warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
 611              "; skipping\n"
 612
 613       } else { # there *is* a rate_detail (or call_details), proceed...
 614         # About this section:
 615         # We don't round _anything_ (except granularizing)
 616         # until the final $charge = sprintf("%.2f"...).
 617
 618         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
 619
 620           my $seconds_left = $use_duration ? $cdr->duration : $cdr->billsec;
 621           # charge for the first (conn_sec) seconds
 622           $seconds = min($seconds_left, $rate_detail->conn_sec);
 623           $seconds_left -= $seconds;
 624           $weektime     += $seconds;
 625           $charge = $rate_detail->conn_charge;
 626
 627           my $etime;
 628           while($seconds_left) {
 629             my $ratetimenum = $rate_detail->ratetimenum; # may be empty
 630
 631             # find the end of the current rate interval
 632             if(@{ $interval_cache{$regionnum} } == 0) {
 633               # There are no timed rates in this group, so just stay
 634               # in the default rate_detail for the entire duration.
 635               # Set an "end" of 1 past the end of the current call.
 636               $etime = $weektime + $seconds_left + 1;
 637             }
 638             elsif($ratetimenum) {
 639               # This is a timed rate, so go to the etime of this interval.
 640               # If it's followed by another timed rate, the stime of that
 641               # interval should match the etime of this one.
 642               my $interval = $rate_detail->rate_time->contains($weektime);
 643               $etime = $interval->etime;
 644             }
 645             else {
 646               # This is a default rate, so use the stime of the next
 647               # interval in the sequence.
 648               my $next_int = first { $_->stime > $weektime }
 649                               @{ $interval_cache{$regionnum} };
 650               if ($next_int) {
 651                 $etime = $next_int->stime;
 652               }
 653               else {
 654                 # weektime is near the end of the week, so decrement
 655                 # it by a full week and use the stime of the first
 656                 # interval.
 657                 $weektime -= (3600*24*7);
 658                 $etime = $interval_cache{$regionnum}->[0]->stime;
 659               }
 660             }
 661
 662             my $charge_sec = min($seconds_left, $etime - $weektime);
 663
 664             $seconds_left -= $charge_sec;
 665
 666             $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included
 667               unless exists $included_min{$regionnum}{$ratetimenum};
 668
 669             my $granularity = $rate_detail->sec_granularity;
 670
 671             my $minutes;
 672             if ( $granularity ) { # charge per minute
 673               # Round up to the nearest $granularity
 674               if ( $charge_sec and $charge_sec % $granularity ) {
 675                 $charge_sec += $granularity - ($charge_sec % $granularity);
 676               }
 677               $minutes = $charge_sec / 60; #don't round this
 678             }
 679             else { # per call
 680               $minutes = 1;
 681               $seconds_left = 0;
 682             }
 683
 684             $seconds += $charge_sec;
 685
 686             $included_min{$regionnum}{$ratetimenum} -= $minutes;
 687             if ( $included_min{$regionnum}{$ratetimenum} <= 0 ) {
 688               my $charge_min = 0 - $included_min{$regionnum}{$ratetimenum}; #XXX should preserve
 689                                                               #(display?) this
 690               $included_min{$regionnum}{$ratetimenum} = 0;
 691               $charge += ($rate_detail->min_charge * $charge_min); #still not rounded
 692             }
 693
 694             # choose next rate_detail
 695             $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 696                                                 'phonenum'    => $number,
 697                                                 'weektime'    => $etime })
 698                     if($seconds_left);
 699             # we have now moved forward to $etime
 700             $weektime = $etime;
 701
 702           } #while $seconds_left
 703           # this is why we need regionnum/rate_region....
 704           warn "  (rate region $rate_region)\n" if $DEBUG;
 705
 706           $classnum = $rate_detail->classnum;
 707           $charge = sprintf('%.2f', $charge + 0.000001); # NOW round it.
 708           warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 709           $charges += $charge;
 710
 711           @call_details = (
 712             $cdr->downstream_csv( 'format'         => $output_format,
 713                                   'granularity'    => $rate_detail->sec_granularity,
 714                                   'seconds'        => ($use_duration ?
 715                                                        $cdr->duration :
 716                                                        $cdr->billsec),
 717                                   'charge'         => $charge,
 718                                   'pretty_dst'     => $pretty_destnum,
 719                                   'dst_regionname' => $regionname,
 720                                 )
 721           );
 722         } #if(there is a rate_detail)
 723
 724
 725         if ( $charge > 0 ) {
 726           #just use FS::cust_bill_pkg_detail objects?
 727           my $call_details;
 728           my $phonenum = $svc_x->phonenum;
 729
 730           if ( scalar(@call_details) == 1 ) {
 731             $call_details =
 732               [ 'C',
 733                 $call_details[0],
 734                 $charge,
 735                 $classnum,
 736                 $phonenum,
 737                 $seconds,
 738                 $regionname,
 739               ];
 740           } else { #only used for $rating_method eq 'upstream' now
 741             $csv->combine(@call_details);
 742             $call_details =
 743               [ 'C',
 744                 $csv->string,
 745                 $charge,
 746                 $classnum,
 747                 $phonenum,
 748                 $seconds,
 749                 $regionname,
 750               ];
 751           }
 752           warn "  adding details on charge to invoice: [ ".
 753               join(', ', @{$call_details} ). " ]"
 754             if ( $DEBUG && ref($call_details) );
 755           push @invoice_details_sort, [ $call_details, $cdr->calldate_unix ];
 756         }
 757
 758         # if the customer flag is on, call "downstream_csv" or something
 759         # like it to export the call downstream!
 760         # XXX price plan option to pick format, or something...
 761         #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
 762         #  if $spool_cdr;
 763
 764         my $error = $cdr->set_status_and_rated_price( 'done',
 765                                                       $charge,
 766                                                       $cust_svc->svcnum,
 767                                                     );
 768         die $error if $error;
 769
 770       }
 771
 772     } # $cdr
 773
 774     my @sorted_invoice_details = sort { @{$a}[1] <=> @{$b}[1] } @invoice_details_sort;
 775     foreach my $sorted_call_detail ( @sorted_invoice_details ) {
 776         push @$details, @{$sorted_call_detail}[0];
 777     }
 778
 779   } # $cust_svc
 780
 781   unshift @$details, [ 'C',
 782                        FS::cdr::invoice_header($output_format),
 783                        '',
 784                        '',
 785                        '',
 786                        '',
 787                        '',
 788                      ]
 789     if @$details && $rating_method ne 'upstream';
 790
 791 #  if ( $spool_cdr && length($downstream_cdr) ) {
 792 #
 793 #    use FS::UID qw(datasrc);
 794 #    my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 795 #    mkdir $dir, 0700 unless -d $dir;
 796 #    $dir .= '/'. $cust_pkg->custnum.
 797 #    mkdir $dir, 0700 unless -d $dir;
 798 #    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
 799 #
 800 #    push @{ $param->{'precommit_hooks'} },
 801 #         sub {
 802 #               #lock the downstream spool file and append the records
 803 #               use Fcntl qw(:flock);
 804 #               use IO::File;
 805 #               my $spool = new IO::File ">>$filename"
 806 #                 or die "can't open $filename: $!\n";
 807 #               flock( $spool, LOCK_EX)
 808 #                 or die "can't lock $filename: $!\n";
 809 #               seek($spool, 0, 2)
 810 #                 or die "can't seek to end of $filename: $!\n";
 811 #               print $spool $downstream_cdr;
 812 #               flock( $spool, LOCK_UN );
 813 #               close $spool;
 814 #             };
 815 #
 816 #  } #if ( $spool_cdr && length($downstream_cdr) )
 817
 818   $charges;
 819 }
 820
 821 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
 822 sub check_chargable {
 823   my( $self, $cdr, %flags ) = @_;
 824
 825   #should have some better way of checking these options from a hash
 826   #or something
 827
 828   my @opt = qw(
 829     use_amaflags
 830     use_disposition
 831     use_disposition_taqua
 832     use_carrierid
 833     use_cdrtypenum
 834     skip_dst_prefix
 835     skip_dcontext
 836     skip_dstchannel_prefix
 837     skip_src_length_more noskip_src_length_accountcode_tollfree
 838     skip_dst_length_less noskip_dst_length_accountcode_tollfree
 839     skip_lastapp
 840     skip_max_callers
 841   );
 842   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
 843     $flags{option_cache}->{$opt} = $self->option($opt, 1);
 844   }
 845   my %opt = %{ $flags{option_cache} };
 846
 847   return 'amaflags != 2'
 848     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
 849
 850   return 'disposition != ANSWERED'
 851     if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
 852
 853   return "disposition != 100"
 854     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
 855
 856   return "carrierid != $opt{'use_carrierid'}"
 857     if length($opt{'use_carrierid'})
 858     && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
 859     && ! $flags{'da_rewrote'};
 860
 861   return "cdrtypenum != $opt{'use_cdrtypenum'}"
 862     if length($opt{'use_cdrtypenum'})
 863     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
 864
 865   foreach(split(',',$opt{'skip_dst_prefix'})) {
 866     return "dst starts with '$_'"
 867     if length($_) && substr($cdr->dst,0,length($_)) eq $_;
 868   }
 869
 870   return "dcontext IN ( $opt{'skip_dcontext'} )"
 871     if $opt{'skip_dcontext'} =~ /\S/
 872     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
 873
 874   my $len_prefix = length($opt{'skip_dstchannel_prefix'});
 875   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
 876     if $len_prefix
 877     && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
 878
 879   my $dst_length = $opt{'skip_dst_length_less'};
 880   return "destination less than $dst_length digits"
 881     if $dst_length && length($cdr->dst) < $dst_length
 882     && ! ( $opt{'noskip_dst_length_accountcode_tollfree'}
 883             && $cdr->is_tollfree('accountcode')
 884          );
 885
 886   return "lastapp is $opt{'skip_lastapp'}"
 887     if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
 888
 889   my $src_length = $opt{'skip_src_length_more'};
 890   if ( $src_length ) {
 891
 892     if ( $opt{'noskip_src_length_accountcode_tollfree'} ) {
 893
 894       if ( $cdr->is_tollfree('accountcode') ) {
 895         return "source less than or equal to $src_length digits"
 896           if length($cdr->src) <= $src_length;
 897       } else {
 898         return "source more than $src_length digits"
 899           if length($cdr->src) > $src_length;
 900       }
 901
 902     } else {
 903       return "source more than $src_length digits"
 904         if length($cdr->src) > $src_length;
 905     }
 906
 907   }
 908
 909   return "max_callers <= $opt{skip_max_callers}"
 910     if length($opt{'skip_max_callers'})
 911       and length($cdr->max_callers)
 912       and $cdr->max_callers <= $opt{'skip_max_callers'};
 913
 914   #all right then, rate it
 915   '';
 916 }
 917
 918 sub is_free {
 919   0;
 920 }
 921
 922 #  This equates svc_phone records; perhaps svc_phone should have a field
 923 #  to indicate it represents a line
 924 sub calc_units {
 925   my($self, $cust_pkg ) = @_;
 926   my $count = 0;
 927   if ( $self->option('count_available_phones', 1)) {
 928     map { $count += ( $_->quantity || 0 ) }
 929       grep { $_->part_svc->svcdb eq 'svc_phone' }
 930       $cust_pkg->part_pkg->pkg_svc;
 931   } else {
 932     $count =
 933       scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 934   }
 935   $count;
 936 }
 937
 938 1;
 939