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 %info = (
  47   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
  48   'shortname' => 'VoIP/telco CDR rating (standard)',
  49   'inherit_fields' => [ 'global_Mixin' ],
  50   'fields' => {
  51     'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
  52                         'type' => 'checkbox',
  53                       },
  54     #false laziness w/flat.pm
  55     'recur_temporality' => { 'name' => 'Charge recurring fee for period',
  56                              'type' => 'select',
  57                              'select_options' => \%temporalities,
  58                            },
  59
  60     'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating or '.
  61                                    'subscription',
  62                          'default' => '1',
  63                        },
  64     'add_full_period'=> { 'name' => 'When prorating first month, also bill '.
  65                                     'for one full period after that',
  66                           'type' => 'checkbox',
  67                         },
  68     'recur_method'  => { 'name' => 'Recurring fee method',
  69                          #'type' => 'radio',
  70                          #'options' => \%recur_method,
  71                          'type' => 'select',
  72                          'select_options' => \%FS::part_pkg::recur_Common::recur_method,
  73                        },
  74
  75     'cdr_svc_method' => { 'name' => 'CDR service matching method',
  76                           'type' => 'radio',
  77                           'options' => \%cdr_svc_method,
  78                         },
  79
  80     'rating_method' => { 'name' => 'Rating method',
  81                          'type' => 'radio',
  82                          'options' => \%rating_method,
  83                        },
  84
  85     'ratenum'   => { 'name' => 'Rate plan',
  86                      'type' => 'select',
  87                      'select_table' => 'rate',
  88                      'select_key'   => 'ratenum',
  89                      'select_label' => 'ratename',
  90                    },
  91
  92     'intrastate_ratenum'   => { 'name' => 'Optional alternate intrastate rate plan',
  93                      'type' => 'select',
  94                      'select_table' => 'rate',
  95                      'select_key'   => 'ratenum',
  96                      'select_label' => 'ratename',
  97                      'disable_empty' => 0,
  98                      'empty_label'   => '',
  99                    },
 100
 101     'min_included' => { 'name' => 'Minutes included when using the "single price per minute" rating method or when using the "prefix" rating method ("region group" billing)',
 102                     },
 103
 104     'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
 105                     },
 106
 107     'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
 108                            'type' => 'select',
 109                            'select_options' => \%granularity,
 110                          },
 111
 112     '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.',
 113                              'type' => 'checkbox',
 114                            },
 115
 116     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
 117                           'default' => '+1',
 118                         },
 119
 120     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
 121                        'type' => 'checkbox'
 122                      },
 123
 124     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
 125                            'default' => '1',
 126                          },
 127
 128 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
 129 #                                    'type' => 'checkbox',
 130 #                                  },
 131
 132     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
 133                                 'default' => '011',
 134                               },
 135
 136     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
 137                             'type' => 'checkbox',
 138                           },
 139
 140     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
 141                         'type' => 'checkbox',
 142                       },
 143
 144     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
 145                            'type' => 'checkbox',
 146                          },
 147
 148     'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
 149                                  'type' => 'checkbox',
 150                                },
 151
 152     'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
 153                          },
 154
 155     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
 156                          },
 157
 158     'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to: ',
 159                          },
 160
 161     'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
 162                          },
 163
 164     'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
 165     },
 166
 167     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
 168                        },
 169
 170     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
 171                                 },
 172
 173     'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
 174                               },
 175
 176     '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',
 177                                                   'type' => 'checkbox',
 178                                                 },
 179
 180     'accountcode_tollfree_ratenum' => {
 181       'name' => 'Optional alternate rate plan when accountcode is toll free: ',
 182       'type' => 'select',
 183       'select_table'  => 'rate',
 184       'select_key'    => 'ratenum',
 185       'select_label'  => 'ratename',
 186       'disable_empty' => 0,
 187       'empty_label'   => '',
 188     },
 189
 190     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
 191                               },
 192
 193     'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
 194                                                   'type' => 'checkbox',
 195                                                 },
 196
 197     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
 198                       },
 199
 200     'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
 201                           },
 202
 203     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
 204                           'type' => 'checkbox',
 205                         },
 206
 207     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
 208                       },
 209
 210     #false laziness w/cdr_termination.pm
 211     'output_format' => { 'name' => 'CDR invoice display format',
 212                          'type' => 'select',
 213                          'select_options' => { FS::cdr::invoice_formats() },
 214                          'default'        => 'default', #XXX test
 215                        },
 216
 217     'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
 218                        },
 219
 220     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 221                           'type' => 'checkbox',
 222                         },
 223
 224     'usage_mandate' => { 'name' => 'Always put usage details in separate section',
 225                           'type' => 'checkbox',
 226                        },
 227     #eofalse
 228
 229     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment).  Useful for prepaid.',
 230                            'type' => 'checkbox',
 231                          },
 232
 233     'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
 234                               'type' => 'checkbox',
 235                             },
 236
 237     '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.',
 238                            'type' => 'checkbox',
 239                          },
 240
 241     #XXX also have option for an external db
 242 #    'cdr_location' => { 'name' => 'CDR database location'
 243 #                        'type' => 'select',
 244 #                        'select_options' => \%cdr_location,
 245 #                        'select_callback' => {
 246 #                          'external' => {
 247 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 248 #                          },
 249 #                          'internal' => {
 250 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 251 #                          }
 252 #                        },
 253 #                      },
 254 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 255 #                   'disabled' => 'Y',
 256 #                 },
 257 #    'username' => { 'name' => 'External database username',
 258 #                    'disabled' => 'Y',
 259 #                  },
 260 #    'password' => { 'name' => 'External database password',
 261 #                    'disabled' => 'Y',
 262 #                  },
 263
 264   },
 265   'fieldorder' => [qw(
 266                        recur_temporality
 267                        recur_method cutoff_day
 268                        add_full_period
 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 use_disposition
 279                        use_disposition_taqua use_carrierid
 280                        use_cdrtypenum ignore_cdrtypenum
 281                        ignore_disposition
 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_setup {
 308   my($self, $cust_pkg ) = @_;
 309   $self->option('setup_fee');
 310 }
 311
 312 sub calc_recur {
 313   my $self = shift;
 314   my($cust_pkg, $sdate, $details, $param ) = @_;
 315
 316   my $charges = 0;
 317
 318   $charges += $self->calc_usage(@_);
 319   $charges += $self->calc_recur_Common(@_);
 320
 321   $charges;
 322
 323 }
 324
 325 sub calc_cancel {
 326   my $self = shift;
 327   my($cust_pkg, $sdate, $details, $param ) = @_;
 328
 329   $self->calc_usage(@_);
 330 }
 331
 332 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 333
 334 sub calc_usage {
 335   my $self = shift;
 336   my($cust_pkg, $sdate, $details, $param ) = @_;
 337
 338   #my $last_bill = $cust_pkg->last_bill;
 339   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 340
 341   return 0
 342     if $self->recur_temporality eq 'preceding'
 343     && ( $last_bill eq '' || $last_bill == 0 );
 344
 345   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 346
 347   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
 348
 349   my %included_min = ();
 350
 351   my $charges = 0;
 352
 353 #  my $downstream_cdr = '';
 354
 355   my $cdr_svc_method    = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
 356   my $rating_method     = $self->option('rating_method') || 'prefix';
 357   my $intl              = $self->option('international_prefix') || '011';
 358   my $domestic_prefix   = $self->option('domestic_prefix');
 359   my $disable_tollfree  = $self->option('disable_tollfree');
 360   my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
 361   my $use_duration      = $self->option('use_duration');
 362   my $region_group      = ($rating_method eq 'prefix' && ($self->option('min_included',1) || 0) > 0);
 363   my $region_group_included_min = $region_group ? $self->option('min_included') : 0;
 364
 365   my $output_format     = $self->option('output_format', 'Hush!')
 366                           || ( $rating_method eq 'upstream_simple'
 367                                  ? 'simple'
 368                                  : 'default'
 369                              );
 370
 371   my @dirass = ();
 372   if ( $self->option('411_rewrite') ) {
 373     my $dirass = $self->option('411_rewrite');
 374     $dirass =~ s/\s//g;
 375     @dirass = split(',', $dirass);
 376   }
 377
 378   my %interval_cache = (); # for timed rates
 379
 380   #for check_chargable, so we don't keep looking up options inside the loop
 381   my %opt_cache = ();
 382
 383   eval "use Text::CSV_XS;";
 384   die $@ if $@;
 385   my $csv = new Text::CSV_XS;
 386
 387   my($svc_table, $svc_field) = split('\.', $cdr_svc_method);
 388
 389   my @cust_svc;
 390   if( $self->option('bill_inactive_svcs',1) ) {
 391     #XXX in this mode do we need to restrict the set of CDRs by date also?
 392     @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
 393   }
 394   else {
 395     @cust_svc = $cust_pkg->cust_svc;
 396   }
 397   @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
 398
 399   foreach my $cust_svc (@cust_svc) {
 400
 401     my $svc_x;
 402     if( $self->option('bill_inactive_svcs',1) ) {
 403       $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
 404     }
 405     else {
 406       $svc_x = $cust_svc->svc_x;
 407     }
 408     my %options = (
 409         'disable_src'    => $self->option('disable_src'),
 410         'default_prefix' => $self->option('default_prefix'),
 411         'status'         => '',
 412         'for_update'     => 1,
 413       );  # $last_bill, $$sdate )
 414     $options{'by_svcnum'} = 1 if $svc_field eq 'svcnum';
 415
 416     my @invoice_details_sort;
 417
 418     foreach my $cdr (
 419       $svc_x->get_cdrs( %options )
 420     ) {
 421       if ( $DEBUG > 1 ) {
 422         warn "rating CDR $cdr\n".
 423              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 424       }
 425
 426       my $rate_detail;
 427       my( $rate_region, $regionnum );
 428       my $rate;
 429       my $pretty_destnum;
 430       my $charge = '';
 431       my $seconds = '';
 432       my $weektime = '';
 433       my $regionname = '';
 434       my $classnum = '';
 435       my $countrycode;
 436       my $number;
 437
 438       my @call_details = ();
 439       if ( $rating_method eq 'prefix' ) {
 440
 441         my $da_rewrote = 0;
 442         if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
 443           $cdr->dst('411');
 444           $da_rewrote = 1;
 445         }
 446
 447         my $reason = $self->check_chargable( $cdr,
 448                                              'da_rewrote'   => $da_rewrote,
 449                                              'option_cache' => \%opt_cache,
 450                                            );
 451
 452         if ( $reason ) {
 453
 454           warn "not charging for CDR ($reason)\n" if $DEBUG;
 455           $charge = 0;
 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         warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
 654              "; skipping\n"
 655
 656       } else { # there *is* a rate_detail (or call_details), proceed...
 657         # About this section:
 658         # We don't round _anything_ (except granularizing)
 659         # until the final $charge = sprintf("%.2f"...).
 660
 661         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
 662
 663           my $seconds_left = $use_duration ? $cdr->duration : $cdr->billsec;
 664           # charge for the first (conn_sec) seconds
 665           $seconds = min($seconds_left, $rate_detail->conn_sec);
 666           $seconds_left -= $seconds;
 667           $weektime     += $seconds;
 668           $charge = $rate_detail->conn_charge;
 669
 670           my $etime;
 671           while($seconds_left) {
 672             my $ratetimenum = $rate_detail->ratetimenum; # may be empty
 673
 674             # find the end of the current rate interval
 675             if(@{ $interval_cache{$regionnum} } == 0) {
 676               # There are no timed rates in this group, so just stay
 677               # in the default rate_detail for the entire duration.
 678               # Set an "end" of 1 past the end of the current call.
 679               $etime = $weektime + $seconds_left + 1;
 680             }
 681             elsif($ratetimenum) {
 682               # This is a timed rate, so go to the etime of this interval.
 683               # If it's followed by another timed rate, the stime of that
 684               # interval should match the etime of this one.
 685               my $interval = $rate_detail->rate_time->contains($weektime);
 686               $etime = $interval->etime;
 687             }
 688             else {
 689               # This is a default rate, so use the stime of the next
 690               # interval in the sequence.
 691               my $next_int = first { $_->stime > $weektime }
 692                               @{ $interval_cache{$regionnum} };
 693               if ($next_int) {
 694                 $etime = $next_int->stime;
 695               }
 696               else {
 697                 # weektime is near the end of the week, so decrement
 698                 # it by a full week and use the stime of the first
 699                 # interval.
 700                 $weektime -= (3600*24*7);
 701                 $etime = $interval_cache{$regionnum}->[0]->stime;
 702               }
 703             }
 704
 705             my $charge_sec = min($seconds_left, $etime - $weektime);
 706
 707             $seconds_left -= $charge_sec;
 708
 709             $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included
 710               unless exists $included_min{$regionnum}{$ratetimenum};
 711
 712             my $granularity = $rate_detail->sec_granularity;
 713
 714             my $minutes;
 715             if ( $granularity ) { # charge per minute
 716               # Round up to the nearest $granularity
 717               if ( $charge_sec and $charge_sec % $granularity ) {
 718                 $charge_sec += $granularity - ($charge_sec % $granularity);
 719               }
 720               $minutes = $charge_sec / 60; #don't round this
 721             }
 722             else { # per call
 723               $minutes = 1;
 724               $seconds_left = 0;
 725             }
 726
 727             $seconds += $charge_sec;
 728
 729             $region_group_included_min -= $minutes
 730                 if $region_group && $rate_detail->region_group;
 731
 732             $included_min{$regionnum}{$ratetimenum} -= $minutes;
 733             if ( ($region_group_included_min <= 0 || !$rate_detail->region_group)
 734                           && $included_min{$regionnum}{$ratetimenum} <= 0 ) {
 735               my $charge_min = 0 - $included_min{$regionnum}{$ratetimenum}; #XXX should preserve
 736                                                               #(display?) this
 737               $included_min{$regionnum}{$ratetimenum} = 0;
 738               $charge += ($rate_detail->min_charge * $charge_min); #still not rounded
 739             }
 740             elsif( $region_group_included_min > 0 && $region_group
 741                 && $rate_detail->region_group ) {
 742                 $included_min{$regionnum}{$ratetimenum} = 0
 743             }
 744
 745             # choose next rate_detail
 746             $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 747                                                 'phonenum'    => $number,
 748                                                 'weektime'    => $etime,
 749                                                 'cdrtypenum'  => $cdr->cdrtypenum })
 750                     if($seconds_left);
 751             # we have now moved forward to $etime
 752             $weektime = $etime;
 753
 754           } #while $seconds_left
 755           # this is why we need regionnum/rate_region....
 756           warn "  (rate region $rate_region)\n" if $DEBUG;
 757
 758           $classnum = $rate_detail->classnum;
 759           $charge = sprintf('%.2f', $charge + 0.000001); # NOW round it.
 760           warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 761           $charges += $charge;
 762
 763           @call_details = (
 764             $cdr->downstream_csv( 'format'         => $output_format,
 765                                   'granularity'    => $rate_detail->sec_granularity,
 766                                   'seconds'        => ($use_duration ?
 767                                                        $cdr->duration :
 768                                                        $cdr->billsec),
 769                                   'charge'         => $charge,
 770                                   'pretty_dst'     => $pretty_destnum,
 771                                   'dst_regionname' => $regionname,
 772                                 )
 773           );
 774         } #if(there is a rate_detail)
 775
 776
 777         if ( $charge > 0 ) {
 778           #just use FS::cust_bill_pkg_detail objects?
 779           my $call_details;
 780           my $phonenum = $svc_x->phonenum;
 781
 782           if ( scalar(@call_details) == 1 ) {
 783             $call_details =
 784               [ 'C',
 785                 $call_details[0],
 786                 $charge,
 787                 $classnum,
 788                 $phonenum,
 789                 $cdr->accountcode,
 790                 $seconds,
 791                 $regionname,
 792               ];
 793           } else { #only used for $rating_method eq 'upstream' now
 794             $csv->combine(@call_details);
 795             $call_details =
 796               [ 'C',
 797                 $csv->string,
 798                 $charge,
 799                 $classnum,
 800                 $phonenum,
 801                 $cdr->accountcode,
 802                 $seconds,
 803                 $regionname,
 804               ];
 805           }
 806           warn "  adding details on charge to invoice: [ ".
 807               join(', ', @{$call_details} ). " ]"
 808             if ( $DEBUG && ref($call_details) );
 809           push @invoice_details_sort, [ $call_details, $cdr->calldate_unix ];
 810         }
 811
 812         # if the customer flag is on, call "downstream_csv" or something
 813         # like it to export the call downstream!
 814         # XXX price plan option to pick format, or something...
 815         #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
 816         #  if $spool_cdr;
 817
 818         my $error = $cdr->set_status_and_rated_price( 'done',
 819                                                       $charge,
 820                                                       $cust_svc->svcnum,
 821                                                     );
 822         die $error if $error;
 823
 824       }
 825
 826     } # $cdr
 827
 828     my @sorted_invoice_details = sort { @{$a}[1] <=> @{$b}[1] } @invoice_details_sort;
 829     foreach my $sorted_call_detail ( @sorted_invoice_details ) {
 830         push @$details, @{$sorted_call_detail}[0];
 831     }
 832
 833   } # $cust_svc
 834
 835   unshift @$details, [ 'C',
 836                        FS::cdr::invoice_header($output_format),
 837                        '',
 838                        '',
 839                        '',
 840                        '',
 841                        '',
 842                      ]
 843     if @$details && $rating_method ne 'upstream';
 844
 845 #  if ( $spool_cdr && length($downstream_cdr) ) {
 846 #
 847 #    use FS::UID qw(datasrc);
 848 #    my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 849 #    mkdir $dir, 0700 unless -d $dir;
 850 #    $dir .= '/'. $cust_pkg->custnum.
 851 #    mkdir $dir, 0700 unless -d $dir;
 852 #    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
 853 #
 854 #    push @{ $param->{'precommit_hooks'} },
 855 #         sub {
 856 #               #lock the downstream spool file and append the records
 857 #               use Fcntl qw(:flock);
 858 #               use IO::File;
 859 #               my $spool = new IO::File ">>$filename"
 860 #                 or die "can't open $filename: $!\n";
 861 #               flock( $spool, LOCK_EX)
 862 #                 or die "can't lock $filename: $!\n";
 863 #               seek($spool, 0, 2)
 864 #                 or die "can't seek to end of $filename: $!\n";
 865 #               print $spool $downstream_cdr;
 866 #               flock( $spool, LOCK_UN );
 867 #               close $spool;
 868 #             };
 869 #
 870 #  } #if ( $spool_cdr && length($downstream_cdr) )
 871
 872   $charges;
 873 }
 874
 875 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
 876 sub check_chargable {
 877   my( $self, $cdr, %flags ) = @_;
 878
 879   #should have some better way of checking these options from a hash
 880   #or something
 881
 882   my @opt = qw(
 883     use_amaflags
 884     use_disposition
 885     use_disposition_taqua
 886     use_carrierid
 887     use_cdrtypenum
 888     ignore_cdrtypenum
 889     ignore_disposition
 890     skip_dst_prefix
 891     skip_dcontext
 892     skip_dstchannel_prefix
 893     skip_src_length_more noskip_src_length_accountcode_tollfree
 894     skip_dst_length_less noskip_dst_length_accountcode_tollfree
 895     skip_lastapp
 896     skip_max_callers
 897   );
 898   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
 899     $flags{option_cache}->{$opt} = $self->option($opt, 1);
 900   }
 901   my %opt = %{ $flags{option_cache} };
 902
 903   return 'amaflags != 2'
 904     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
 905
 906   return 'disposition != ANSWERED'
 907     if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
 908
 909   return "disposition != 100"
 910     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
 911
 912   return "disposition IN ( $opt{'ignore_disposition'} )"
 913     if $opt{'ignore_disposition'} =~ /\S/
 914     && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'ignore_disposition'});
 915
 916   return "carrierid != $opt{'use_carrierid'}"
 917     if length($opt{'use_carrierid'})
 918     && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
 919     && ! $flags{'da_rewrote'};
 920
 921   return "cdrtypenum != $opt{'use_cdrtypenum'}"
 922     if length($opt{'use_cdrtypenum'})
 923     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
 924
 925   return "cdrtypenum == $opt{'ignore_cdrtypenum'}"
 926     if length($opt{'ignore_cdrtypenum'})
 927     && $cdr->cdrtypenum eq $opt{'ignore_cdrtypenum'}; #eq otherwise 0 matches ''
 928
 929   foreach(split(',',$opt{'skip_dst_prefix'})) {
 930     return "dst starts with '$_'"
 931     if length($_) && substr($cdr->dst,0,length($_)) eq $_;
 932   }
 933
 934   return "dcontext IN ( $opt{'skip_dcontext'} )"
 935     if $opt{'skip_dcontext'} =~ /\S/
 936     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
 937
 938   my $len_prefix = length($opt{'skip_dstchannel_prefix'});
 939   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
 940     if $len_prefix
 941     && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
 942
 943   my $dst_length = $opt{'skip_dst_length_less'};
 944   return "destination less than $dst_length digits"
 945     if $dst_length && length($cdr->dst) < $dst_length
 946     && ! ( $opt{'noskip_dst_length_accountcode_tollfree'}
 947             && $cdr->is_tollfree('accountcode')
 948          );
 949
 950   return "lastapp is $opt{'skip_lastapp'}"
 951     if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
 952
 953   my $src_length = $opt{'skip_src_length_more'};
 954   if ( $src_length ) {
 955
 956     if ( $opt{'noskip_src_length_accountcode_tollfree'} ) {
 957
 958       if ( $cdr->is_tollfree('accountcode') ) {
 959         return "source less than or equal to $src_length digits"
 960           if length($cdr->src) <= $src_length;
 961       } else {
 962         return "source more than $src_length digits"
 963           if length($cdr->src) > $src_length;
 964       }
 965
 966     } else {
 967       return "source more than $src_length digits"
 968         if length($cdr->src) > $src_length;
 969     }
 970
 971   }
 972
 973   return "max_callers <= $opt{skip_max_callers}"
 974     if length($opt{'skip_max_callers'})
 975       and length($cdr->max_callers)
 976       and $cdr->max_callers <= $opt{'skip_max_callers'};
 977
 978   #all right then, rate it
 979   '';
 980 }
 981
 982 sub is_free {
 983   0;
 984 }
 985
 986 #  This equates svc_phone records; perhaps svc_phone should have a field
 987 #  to indicate it represents a line
 988 sub calc_units {
 989   my($self, $cust_pkg ) = @_;
 990   my $count = 0;
 991   if ( $self->option('count_available_phones', 1)) {
 992     map { $count += ( $_->quantity || 0 ) }
 993       grep { $_->part_svc->svcdb eq 'svc_phone' }
 994       $cust_pkg->part_pkg->pkg_svc;
 995   } else {
 996     $count =
 997       scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 998   }
 999   $count;
1000 }
1001
1002 1;
1003