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