FS/FS/part_pkg/voip_cdr.pm

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