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 = 1;
  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_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
  99                     },
 100
 101     'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
 102                            'type' => 'select',
 103                            'select_options' => \%granularity,
 104                          },
 105
 106     'ignore_unrateable' => { 'name' => 'Ignore calls without a rate in the rate tables.  By default, the system will throw a fatal error upon encountering unrateable calls.',
 107                              'type' => 'checkbox',
 108                            },
 109
 110     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
 111                           'default' => '+1',
 112                         },
 113
 114     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
 115                        'type' => 'checkbox'
 116                      },
 117
 118     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
 119                            'default' => '1',
 120                          },
 121
 122 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
 123 #                                    'type' => 'checkbox',
 124 #                                  },
 125
 126     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
 127                                 'default' => '011',
 128                               },
 129
 130     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
 131                             'type' => 'checkbox',
 132                           },
 133
 134     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
 135                         'type' => 'checkbox',
 136                       },
 137
 138     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
 139                            'type' => 'checkbox',
 140                          },
 141
 142     'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
 143                                  'type' => 'checkbox',
 144                                },
 145
 146     'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
 147                          },
 148
 149     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
 150                          },
 151
 152     'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
 153     },
 154
 155     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
 156                        },
 157
 158     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
 159                                 },
 160
 161     'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
 162                               },
 163
 164     'noskip_src_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where source is equal or greater than the specified digits, when accountcode is toll free',
 165                                                   'type' => 'checkbox',
 166                                                 },
 167
 168     'accountcode_tollfree_ratenum' => {
 169       'name' => 'Optional alternate rate plan when accountcode is toll free: ',
 170       'type' => 'select',
 171       'select_table'  => 'rate',
 172       'select_key'    => 'ratenum',
 173       'select_label'  => 'ratename',
 174       'disable_empty' => 0,
 175       'empty_label'   => '',
 176     },
 177
 178     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
 179                               },
 180
 181     'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
 182                                                   'type' => 'checkbox',
 183                                                 },
 184
 185     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
 186                       },
 187
 188     'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is greater than this value: ',
 189                           },
 190
 191     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
 192                           'type' => 'checkbox',
 193                         },
 194
 195     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
 196                       },
 197
 198     #false laziness w/cdr_termination.pm
 199     'output_format' => { 'name' => 'CDR invoice display format',
 200                          'type' => 'select',
 201                          'select_options' => { FS::cdr::invoice_formats() },
 202                          'default'        => 'default', #XXX test
 203                        },
 204
 205     'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
 206                        },
 207
 208     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 209                           'type' => 'checkbox',
 210                         },
 211
 212     'usage_mandate' => { 'name' => 'Always put usage details in separate section',
 213                           'type' => 'checkbox',
 214                        },
 215     #eofalse
 216
 217     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call.  Useful for prepaid.',
 218                            'type' => 'checkbox',
 219                          },
 220
 221     '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.',
 222                            'type' => 'checkbox',
 223                          },
 224
 225     #XXX also have option for an external db
 226 #    'cdr_location' => { 'name' => 'CDR database location'
 227 #                        'type' => 'select',
 228 #                        'select_options' => \%cdr_location,
 229 #                        'select_callback' => {
 230 #                          'external' => {
 231 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 232 #                          },
 233 #                          'internal' => {
 234 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 235 #                          }
 236 #                        },
 237 #                      },
 238 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 239 #                   'disabled' => 'Y',
 240 #                 },
 241 #    'username' => { 'name' => 'External database username',
 242 #                    'disabled' => 'Y',
 243 #                  },
 244 #    'password' => { 'name' => 'External database password',
 245 #                    'disabled' => 'Y',
 246 #                  },
 247
 248   },
 249   'fieldorder' => [qw(
 250                        setup_fee recur_fee recur_temporality unused_credit
 251                        recur_method cutoff_day
 252                        cdr_svc_method
 253                        rating_method ratenum min_charge sec_granularity
 254                        ignore_unrateable
 255                        default_prefix
 256                        disable_src
 257                        domestic_prefix international_prefix
 258                        disable_tollfree
 259                        use_amaflags use_disposition
 260                        use_disposition_taqua use_carrierid use_cdrtypenum
 261                        skip_dcontext skip_dst_prefix
 262                        skip_dstchannel_prefix skip_src_length_more
 263                        noskip_src_length_accountcode_tollfree
 264                        accountcode_tollfree_ratenum
 265                        skip_dst_length_less
 266                        noskip_dst_length_accountcode_tollfree
 267                        skip_lastapp
 268                        skip_max_callers
 269                        use_duration
 270                        411_rewrite
 271                        output_format usage_mandate summarize_usage usage_section
 272                        bill_every_call
 273                        count_available_phones
 274                      )
 275                   ],
 276   'weight' => 40,
 277 );
 278
 279 sub calc_setup {
 280   my($self, $cust_pkg ) = @_;
 281   $self->option('setup_fee');
 282 }
 283
 284 sub calc_recur {
 285   my $self = shift;
 286   my($cust_pkg, $sdate, $details, $param ) = @_;
 287
 288   my $charges = 0;
 289
 290   $charges += $self->calc_usage(@_);
 291   $charges += $self->calc_recur_Common(@_);
 292
 293   $charges;
 294
 295 }
 296
 297 sub calc_cancel {
 298   my $self = shift;
 299   my($cust_pkg, $sdate, $details, $param ) = @_;
 300
 301   $self->calc_usage(@_);
 302 }
 303
 304 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 305
 306 sub calc_usage {
 307   my $self = shift;
 308   my($cust_pkg, $sdate, $details, $param ) = @_;
 309
 310   #my $last_bill = $cust_pkg->last_bill;
 311   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 312
 313   return 0
 314     if $self->option('recur_temporality', 1) eq 'preceding'
 315     && ( $last_bill eq '' || $last_bill == 0 );
 316
 317   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 318
 319   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
 320
 321   my %included_min = ();
 322
 323   my $charges = 0;
 324
 325 #  my $downstream_cdr = '';
 326
 327   my $cdr_svc_method    = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
 328   my $rating_method     = $self->option('rating_method') || 'prefix';
 329   my $intl              = $self->option('international_prefix') || '011';
 330   my $domestic_prefix   = $self->option('domestic_prefix');
 331   my $disable_tollfree  = $self->option('disable_tollfree');
 332   my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
 333   my $use_duration      = $self->option('use_duration');
 334
 335   my $output_format     = $self->option('output_format', 'Hush!')
 336                           || ( $rating_method eq 'upstream_simple'
 337                                  ? 'simple'
 338                                  : 'default'
 339                              );
 340
 341   my @dirass = ();
 342   if ( $self->option('411_rewrite') ) {
 343     my $dirass = $self->option('411_rewrite');
 344     $dirass =~ s/\s//g;
 345     @dirass = split(',', $dirass);
 346   }
 347
 348   my %interval_cache = (); # for timed rates
 349
 350   #for check_chargable, so we don't keep looking up options inside the loop
 351   my %opt_cache = ();
 352
 353   eval "use Text::CSV_XS;";
 354   die $@ if $@;
 355   my $csv = new Text::CSV_XS;
 356
 357   my($svc_table, $svc_field) = split('\.', $cdr_svc_method);
 358
 359   foreach my $cust_svc (
 360     grep { $_->part_svc->svcdb eq $svc_table } $cust_pkg->cust_svc
 361   ) {
 362
 363     my $svc_x = $cust_svc->svc_x;
 364     foreach my $cdr (
 365       $svc_x->get_cdrs(
 366         'disable_src'    => $self->option('disable_src'),
 367         'default_prefix' => $self->option('default_prefix'),
 368         'status'         => '',
 369         'for_update'     => 1,
 370       )  # $last_bill, $$sdate )
 371     ) {
 372       if ( $DEBUG > 1 ) {
 373         warn "rating CDR $cdr\n".
 374              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 375       }
 376
 377       my $rate_detail;
 378       my( $rate_region, $regionnum );
 379       my $rate;
 380       my $pretty_destnum;
 381       my $charge = '';
 382       my $seconds = '';
 383       my $weektime = '';
 384       my $regionname = '';
 385       my $classnum = '';
 386       my $countrycode;
 387       my $number;
 388
 389       my @call_details = ();
 390       if ( $rating_method eq 'prefix' ) {
 391
 392         my $da_rewrote = 0;
 393         if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
 394           $cdr->dst('411');
 395           $da_rewrote = 1;
 396         }
 397
 398         my $reason = $self->check_chargable( $cdr,
 399                                              'da_rewrote'   => $da_rewrote,
 400                                              'option_cache' => \%opt_cache,
 401                                            );
 402
 403         if ( $reason ) {
 404
 405           warn "not charging for CDR ($reason)\n" if $DEBUG;
 406           $charge = 0;
 407
 408         } else {
 409
 410           ###
 411           # look up rate details based on called station id
 412           # (or calling station id for toll free calls)
 413           ###
 414
 415           my( $to_or_from );
 416           if ( $cdr->is_tollfree && ! $disable_tollfree )
 417           { #tollfree call
 418             $to_or_from = 'from';
 419             $number = $cdr->src;
 420           } else { #regular call
 421             $to_or_from = 'to';
 422             $number = $cdr->dst;
 423           }
 424
 425           warn "parsing call $to_or_from $number\n" if $DEBUG;
 426
 427           #remove non-phone# stuff and whitespace
 428           $number =~ s/\s//g;
 429 #          my $proto = '';
 430 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
 431 #          my $siphost = '';
 432 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 433
 434           #determine the country code
 435           $countrycode = '';
 436           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
 437                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
 438              )
 439           {
 440
 441             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
 442             #first look for 1 digit country code
 443             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
 444               $countrycode = $one;
 445               $number = $u1.$u2.$rest;
 446             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
 447               $countrycode = $two;
 448               $number = $u2.$rest;
 449             } else { #3 digit country code
 450               $countrycode = $three;
 451               $number = $rest;
 452             }
 453
 454           } else {
 455             $countrycode = $domestic_prefix || '1';
 456             $number =~ s/^$countrycode//;# if length($number) > 10;
 457           }
 458
 459           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
 460           $pretty_destnum = "+$countrycode $number";
 461           #asterisks here causes inserting the detail to barf, so:
 462           $pretty_destnum =~ s/\*//g;
 463
 464           my $eff_ratenum = $cdr->is_tollfree('accountcode')
 465             ? $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum')
 466             : '';
 467           $eff_ratenum ||= $ratenum;
 468           $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
 469             or die "ratenum $eff_ratenum not found!";
 470
 471           my @ltime = localtime($cdr->startdate);
 472           $weektime = $ltime[0] +
 473                       $ltime[1]*60 +   #minutes
 474                       $ltime[2]*3600 + #hours
 475                       $ltime[6]*86400; #days since sunday
 476           # if there's no timed rate_detail for this time/region combination,
 477           # dest_detail returns the default.  There may still be a timed rate
 478           # that applies after the starttime of the call, so be careful...
 479           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 480                                               'phonenum'    => $number,
 481                                               'weektime'    => $weektime,
 482                                             });
 483
 484           if ( $rate_detail ) {
 485
 486             $rate_region = $rate_detail->dest_region;
 487             $regionnum = $rate_region->regionnum;
 488             $regionname = $rate_region->regionname;
 489             warn "  found rate for regionnum $regionnum ".
 490                  "and rate detail $rate_detail\n"
 491               if $DEBUG;
 492
 493             if ( !exists($interval_cache{$regionnum}) ) {
 494               my @intervals = (
 495                 sort { $a->stime <=> $b->stime }
 496                 map { my $r = $_->rate_time; $r ? $r->intervals : () }
 497                 $rate->rate_detail
 498               );
 499               $interval_cache{$regionnum} = \@intervals;
 500               warn "  cached ".scalar(@intervals)." interval(s)\n"
 501                 if $DEBUG;
 502             }
 503
 504           } elsif ( $ignore_unrateable ) {
 505
 506             $rate_region = '';
 507             $regionnum = '';
 508             #code below will throw a warning & skip
 509
 510           } else {
 511
 512             die "FATAL: no rate_detail found in ".
 513                 $rate->ratenum. ":". $rate->ratename. " rate plan ".
 514                 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
 515                 "add a rate or set ignore_unrateable flag on the package def\n";
 516           }
 517
 518         }
 519
 520 #      } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used.  very much becoming the odd one out. remove?
 521 #
 522 #        if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
 523 #
 524 #          $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
 525 #
 526 #          $regionnum = $rate_detail->dest_regionnum;
 527 #          $rate_region = $rate_detail->dest_region;
 528 #
 529 #          $pretty_destnum = $cdr->dst;
 530 #
 531 #          warn "  found rate for regionnum $regionnum and ".
 532 #               "rate detail $rate_detail\n"
 533 #            if $DEBUG;
 534 #
 535 #        } else { #pass upstream price through
 536 #
 537 #          $charge = sprintf('%.2f', $cdr->upstream_price);
 538 #          warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 539 #          $charges += $charge;
 540 #
 541 #          @call_details = (
 542 #            #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
 543 #            time2str("%c", $cdr->calldate_unix),  #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot
 544 #            'N/A', #minutes...
 545 #            '$'.$charge,
 546 #            #$pretty_destnum,
 547 #            $cdr->description, #$rate_region->regionname,
 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
 569         my $granularity = length($self->option('sec_granularity'))
 570                             ? $self->option('sec_granularity')
 571                             : 60;
 572
 573                     # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
 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         my $minutes = $seconds / 60; # sprintf("%.1f",
 580         #$minutes =~ s/\.0$// if $granularity == 60;
 581
 582         # XXX config?
 583         #$charge = sprintf('%.2f', ( $self->option('min_charge') * $minutes )
 584                                   #+ 0.00000001 ); #so 1.005 rounds to 1.01
 585         $charge = sprintf('%.4f', ( $self->option('min_charge') * $minutes )
 586                                   + 0.0000000001 ); #so 1.00005 rounds to 1.0001
 587
 588         warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 589         $charges += $charge;
 590
 591         @call_details = ($cdr->downstream_csv( 'format' => $output_format,
 592                                                'charge' => $charge,
 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
 616         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
 617
 618           my $seconds_left = $use_duration ? $cdr->duration : $cdr->billsec;
 619           # charge for the first (conn_sec) seconds
 620           $seconds = min($seconds_left, $rate_detail->conn_sec);
 621           $seconds_left -= $seconds;
 622           $weektime     += $seconds;
 623           $charge = sprintf("%.02f", $rate_detail->conn_charge);
 624
 625           my $total_minutes = 0;
 626           my $whole_minutes = 1;
 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             $whole_minutes = 0 if $granularity;
 671
 672             # should this be done in every rate interval?
 673             $charge_sec += $granularity - ( $charge_sec % $granularity )
 674               if $charge_sec   # don't granular-ize 0 billsec calls (bills them)
 675               && $granularity; # 0 is per call
 676             my $minutes = sprintf("%.1f", $charge_sec / 60);
 677             $minutes =~ s/\.0$// if $granularity == 60;
 678
 679             $seconds += $charge_sec;
 680
 681             # per call rather than per minute
 682             $minutes = 1 unless $granularity;
 683             $seconds_left = 0 unless $granularity;
 684
 685             $included_min{$regionnum}{$ratetimenum} -= $minutes;
 686
 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 += sprintf('%.2f', ($rate_detail->min_charge * $charge_min)
 692                                          + 0.00000001 ); #so 1.005 rounds to 1.01
 693             }
 694
 695             # choose next rate_detail
 696             $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 697                                                 'phonenum'    => $number,
 698                                                 'weektime'    => $etime })
 699                     if($seconds_left);
 700             # we have now moved forward to $etime
 701             $weektime = $etime;
 702
 703           } #while $seconds_left
 704           # this is why we need regionnum/rate_region....
 705           warn "  (rate region $rate_region)\n" if $DEBUG;
 706
 707           $total_minutes = sprintf("%.1f", $seconds / 60);
 708           $total_minutes =~ s/\.0$// if $whole_minutes;
 709
 710           $classnum = $rate_detail->classnum;
 711           $charge = sprintf('%.2f', $charge);
 712           warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 713           $charges += $charge;
 714
 715           @call_details = (
 716             $cdr->downstream_csv( 'format'         => $output_format,
 717                                   'granularity'    => $rate_detail->sec_granularity,
 718                                   'minutes'        => $total_minutes,
 719                                   # why do we go through this hocus-pocus?
 720                                   # the cdr *will* show duration here
 721                                   # if we forego the 'minutes' key
 722                                   # duration vs billsec?
 723                                   'charge'         => $charge,
 724                                   'pretty_dst'     => $pretty_destnum,
 725                                   'dst_regionname' => $regionname,
 726                                 )
 727           );
 728         } #if(there is a rate_detail)
 729
 730
 731         if ( $charge > 0 ) {
 732           #just use FS::cust_bill_pkg_detail objects?
 733           my $call_details;
 734           my $phonenum = $cust_svc->svc_x->phonenum;
 735
 736           #if ( $self->option('rating_method') eq 'upstream_simple' ) {
 737           if ( scalar(@call_details) == 1 ) {
 738             $call_details =
 739               [ 'C',
 740                 $call_details[0],
 741                 $charge,
 742                 $classnum,
 743                 $phonenum,
 744                 $seconds,
 745                 $regionname,
 746               ];
 747           } else { #only used for $rating_method eq 'upstream' now
 748             $csv->combine(@call_details);
 749             $call_details =
 750               [ 'C',
 751                 $csv->string,
 752                 $charge,
 753                 $classnum,
 754                 $phonenum,
 755                 $seconds,
 756                 $regionname,
 757               ];
 758           }
 759           warn "  adding details on charge to invoice: [ ".
 760               join(', ', @{$call_details} ). " ]"
 761             if ( $DEBUG && ref($call_details) );
 762           push @$details, $call_details; #\@call_details,
 763         }
 764
 765         # if the customer flag is on, call "downstream_csv" or something
 766         # like it to export the call downstream!
 767         # XXX price plan option to pick format, or something...
 768         #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
 769         #  if $spool_cdr;
 770
 771         my $error = $cdr->set_status_and_rated_price( 'done',
 772                                                       $charge,
 773                                                       $cust_svc->svcnum,
 774                                                     );
 775         die $error if $error;
 776
 777       }
 778
 779     } # $cdr
 780
 781   } # $cust_svc
 782
 783   unshift @$details, [ 'C',
 784                        FS::cdr::invoice_header($output_format),
 785                        '',
 786                        '',
 787                        '',
 788                        '',
 789                        '',
 790                      ]
 791     if @$details && $rating_method ne 'upstream';
 792
 793 #  if ( $spool_cdr && length($downstream_cdr) ) {
 794 #
 795 #    use FS::UID qw(datasrc);
 796 #    my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 797 #    mkdir $dir, 0700 unless -d $dir;
 798 #    $dir .= '/'. $cust_pkg->custnum.
 799 #    mkdir $dir, 0700 unless -d $dir;
 800 #    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
 801 #
 802 #    push @{ $param->{'precommit_hooks'} },
 803 #         sub {
 804 #               #lock the downstream spool file and append the records
 805 #               use Fcntl qw(:flock);
 806 #               use IO::File;
 807 #               my $spool = new IO::File ">>$filename"
 808 #                 or die "can't open $filename: $!\n";
 809 #               flock( $spool, LOCK_EX)
 810 #                 or die "can't lock $filename: $!\n";
 811 #               seek($spool, 0, 2)
 812 #                 or die "can't seek to end of $filename: $!\n";
 813 #               print $spool $downstream_cdr;
 814 #               flock( $spool, LOCK_UN );
 815 #               close $spool;
 816 #             };
 817 #
 818 #  } #if ( $spool_cdr && length($downstream_cdr) )
 819
 820   $charges;
 821 }
 822
 823 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
 824 sub check_chargable {
 825   my( $self, $cdr, %flags ) = @_;
 826
 827   #should have some better way of checking these options from a hash
 828   #or something
 829
 830   my @opt = qw(
 831     use_amaflags
 832     use_disposition
 833     use_disposition_taqua
 834     use_carrierid
 835     use_cdrtypenum
 836     skip_dst_prefix
 837     skip_dcontext
 838     skip_dstchannel_prefix
 839     skip_src_length_more noskip_src_length_accountcode_tollfree
 840     skip_dst_length_less noskip_dst_length_accountcode_tollfree
 841     skip_lastapp
 842     skip_max_callers
 843   );
 844   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
 845     $flags{option_cache}->{$opt} = $self->option($opt, 1);
 846   }
 847   my %opt = %{ $flags{option_cache} };
 848
 849   return 'amaflags != 2'
 850     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
 851
 852   return 'disposition != ANSWERED'
 853     if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
 854
 855   return "disposition != 100"
 856     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
 857
 858   return "carrierid != $opt{'use_carrierid'}"
 859     if length($opt{'use_carrierid'})
 860     && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
 861     && ! $flags{'da_rewrote'};
 862
 863   return "cdrtypenum != $opt{'use_cdrtypenum'}"
 864     if length($opt{'use_cdrtypenum'})
 865     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
 866
 867   foreach(split(',',$opt{'skip_dst_prefix'})) {
 868     return "dst starts with '$_'"
 869     if length($_) && substr($cdr->dst,0,length($_)) eq $_;
 870   }
 871
 872   return "dcontext IN ( $opt{'skip_dcontext'} )"
 873     if $opt{'skip_dcontext'} =~ /\S/
 874     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
 875
 876   my $len_prefix = length($opt{'skip_dstchannel_prefix'});
 877   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
 878     if $len_prefix
 879     && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
 880
 881   my $dst_length = $opt{'skip_dst_length_less'};
 882   return "destination less than $dst_length digits"
 883     if $dst_length && length($cdr->dst) < $dst_length
 884     && ! ( $opt{'noskip_dst_length_accountcode_tollfree'}
 885             && $cdr->is_tollfree
 886          );
 887
 888   return "lastapp is $opt{'skip_lastapp'}"
 889     if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
 890
 891   my $src_length = $opt{'skip_src_length_more'};
 892   if ( $src_length ) {
 893
 894     if ( $opt{'noskip_src_length_accountcode_tollfree'} ) {
 895
 896       if ( $cdr->is_tollfree('accountcode') ) {
 897         return "source less than or equal to $src_length digits"
 898           if length($cdr->src) <= $src_length;
 899       } else {
 900         return "source more than $src_length digits"
 901           if length($cdr->src) > $src_length;
 902       }
 903
 904     } else {
 905       return "source more than $src_length digits"
 906         if length($cdr->src) > $src_length;
 907     }
 908
 909   }
 910
 911   return "max_callers > $opt{skip_max_callers}"
 912     if length($opt{'skip_max_callers'})
 913       and length($cdr->max_callers)
 914       and $cdr->max_callers > $opt{'skip_max_callers'};
 915
 916   #all right then, rate it
 917   '';
 918 }
 919
 920 sub is_free {
 921   0;
 922 }
 923
 924 #  This equates svc_phone records; perhaps svc_phone should have a field
 925 #  to indicate it represents a line
 926 sub calc_units {
 927   my($self, $cust_pkg ) = @_;
 928   my $count = 0;
 929   if ( $self->option('count_available_phones', 1)) {
 930     map { $count += ( $_->quantity || 0 ) }
 931       grep { $_->part_svc->svcdb eq 'svc_phone' }
 932       $cust_pkg->part_pkg->pkg_svc;
 933   } else {
 934     $count =
 935       scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 936   }
 937   $count;
 938 }
 939
 940 1;
 941