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