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