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_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
 145                          },
 146
 147     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
 148                          },
 149
 150     'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to: ',
 151                          },
 152
 153     'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
 154                          },
 155
 156     'disposition_in' => { 'name' => 'Do not charge for CDRs where the Disposition is not set to any of these (comma-separated) values: ',
 157                          },
 158
 159     'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
 160     },
 161
 162     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
 163                        },
 164
 165     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
 166                                 },
 167
 168     'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
 169                               },
 170
 171     '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',
 172                                                   'type' => 'checkbox',
 173                                                 },
 174
 175     'accountcode_tollfree_ratenum' => {
 176       'name' => 'Optional alternate rate plan when accountcode is toll free: ',
 177       'type' => 'select',
 178       'select_table'  => 'rate',
 179       'select_key'    => 'ratenum',
 180       'select_label'  => 'ratename',
 181       'disable_empty' => 0,
 182       'empty_label'   => '',
 183     },
 184
 185     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
 186                               },
 187
 188     'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
 189                                                   'type' => 'checkbox',
 190                                                 },
 191
 192     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
 193                       },
 194
 195     'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
 196                           },
 197
 198     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
 199                           'type' => 'checkbox',
 200                         },
 201
 202     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
 203                       },
 204
 205     #false laziness w/cdr_termination.pm
 206     'output_format' => { 'name' => 'CDR invoice display format',
 207                          'type' => 'select',
 208                          'select_options' => { FS::cdr::invoice_formats() },
 209                          'default'        => 'default', #XXX test
 210                        },
 211
 212     'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
 213                        },
 214
 215     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 216                           'type' => 'checkbox',
 217                         },
 218
 219     'usage_mandate' => { 'name' => 'Always put usage details in separate section',
 220                           'type' => 'checkbox',
 221                        },
 222     #eofalse
 223
 224     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment).  Useful for prepaid.',
 225                            'type' => 'checkbox',
 226                          },
 227
 228     'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
 229                               'type' => 'checkbox',
 230                             },
 231
 232     '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.',
 233                            'type' => 'checkbox',
 234                          },
 235
 236     #XXX also have option for an external db
 237 #    'cdr_location' => { 'name' => 'CDR database location'
 238 #                        'type' => 'select',
 239 #                        'select_options' => \%cdr_location,
 240 #                        'select_callback' => {
 241 #                          'external' => {
 242 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 243 #                          },
 244 #                          'internal' => {
 245 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 246 #                          }
 247 #                        },
 248 #                      },
 249 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 250 #                   'disabled' => 'Y',
 251 #                 },
 252 #    'username' => { 'name' => 'External database username',
 253 #                    'disabled' => 'Y',
 254 #                  },
 255 #    'password' => { 'name' => 'External database password',
 256 #                    'disabled' => 'Y',
 257 #                  },
 258
 259   },
 260   'fieldorder' => [qw(
 261                        recur_temporality
 262                        recur_method cutoff_day
 263                        add_full_period
 264                        cdr_svc_method
 265                        rating_method ratenum intrastate_ratenum
 266                        min_charge min_included
 267                                sec_granularity
 268                        ignore_unrateable
 269                        default_prefix
 270                        disable_src
 271                        domestic_prefix international_prefix
 272                        disable_tollfree
 273                        use_amaflags
 274                        use_carrierid
 275                        use_cdrtypenum ignore_cdrtypenum
 276                        ignore_disposition disposition_in
 277                        skip_dcontext skip_dst_prefix
 278                        skip_dstchannel_prefix skip_src_length_more
 279                        noskip_src_length_accountcode_tollfree
 280                        accountcode_tollfree_ratenum
 281                        skip_dst_length_less
 282                        noskip_dst_length_accountcode_tollfree
 283                        skip_lastapp
 284                        skip_max_callers
 285                        use_duration
 286                        411_rewrite
 287                        output_format usage_mandate summarize_usage usage_section
 288                        bill_every_call bill_inactive_svcs
 289                        count_available_phones suspend_bill
 290                      )
 291                   ],
 292   'weight' => 40,
 293 );
 294
 295 sub price_info {
 296     my $self = shift;
 297     my $str = $self->SUPER::price_info;
 298     $str .= " plus usage" if $str;
 299     $str;
 300 }
 301
 302 sub calc_setup {
 303   my($self, $cust_pkg ) = @_;
 304   $self->option('setup_fee');
 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         'status'         => '',
 407         'for_update'     => 1,
 408       );  # $last_bill, $$sdate )
 409     $options{'by_svcnum'} = 1 if $svc_field eq 'svcnum';
 410
 411     my @invoice_details_sort;
 412
 413     foreach my $cdr (
 414       $svc_x->get_cdrs( %options )
 415     ) {
 416       if ( $DEBUG > 1 ) {
 417         warn "rating CDR $cdr\n".
 418              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 419       }
 420
 421       my $rate_detail;
 422       my( $rate_region, $regionnum );
 423       my $rate;
 424       my $pretty_destnum;
 425       my $charge = '';
 426       my $seconds = '';
 427       my $weektime = '';
 428       my $regionname = '';
 429       my $classnum = '';
 430       my $countrycode;
 431       my $number;
 432
 433       my @call_details = ();
 434       if ( $rating_method eq 'prefix' ) {
 435
 436         my $da_rewrote = 0;
 437         if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
 438           $cdr->dst('411');
 439           $da_rewrote = 1;
 440         }
 441
 442         my $reason = $self->check_chargable( $cdr,
 443                                              'da_rewrote'   => $da_rewrote,
 444                                              'option_cache' => \%opt_cache,
 445                                            );
 446
 447         if ( $reason ) {
 448
 449           warn "not charging for CDR ($reason)\n" if $DEBUG;
 450           $charge = 0;
 451
 452         } else {
 453
 454           ###
 455           # look up rate details based on called station id
 456           # (or calling station id for toll free calls)
 457           ###
 458
 459           my( $to_or_from );
 460           if ( $cdr->is_tollfree && ! $disable_tollfree )
 461           { #tollfree call
 462             $to_or_from = 'from';
 463             $number = $cdr->src;
 464           } else { #regular call
 465             $to_or_from = 'to';
 466             $number = $cdr->dst;
 467           }
 468
 469           warn "parsing call $to_or_from $number\n" if $DEBUG;
 470
 471           #remove non-phone# stuff and whitespace
 472           $number =~ s/\s//g;
 473 #          my $proto = '';
 474 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
 475 #          my $siphost = '';
 476 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 477
 478           #determine the country code
 479           $countrycode = '';
 480           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
 481                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
 482              )
 483           {
 484
 485             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
 486             #first look for 1 digit country code
 487             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
 488               $countrycode = $one;
 489               $number = $u1.$u2.$rest;
 490             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
 491               $countrycode = $two;
 492               $number = $u2.$rest;
 493             } else { #3 digit country code
 494               $countrycode = $three;
 495               $number = $rest;
 496             }
 497
 498           } else {
 499             $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
 500             $number =~ s/^$countrycode//;# if length($number) > 10;
 501           }
 502
 503           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
 504           $pretty_destnum = "+$countrycode $number";
 505           #asterisks here causes inserting the detail to barf, so:
 506           $pretty_destnum =~ s/\*//g;
 507
 508           my $eff_ratenum = $cdr->is_tollfree('accountcode')
 509             ? $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum')
 510             : '';
 511
 512           my $intrastate_ratenum = $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum');
 513           if ( $intrastate_ratenum && !$cdr->is_tollfree ) {
 514             # this is relatively easy only because:
 515             # -assume all numbers are valid NANP numbers NOT in a fully-qualified format
 516             # -disregard toll-free
 517             # -disregard private or unknown numbers
 518             # -there is exactly one record in rate_prefix for a given NPANXX
 519             # -default to interstate if we can't find one or both of the prefixes
 520             my $dstprefix = $cdr->dst;
 521             $dstprefix =~ /^(\d{6})/;
 522             $dstprefix = qsearchs('rate_prefix', {   'countrycode' => '1',
 523                                                         'npa' => $1,
 524                                                  }) || '';
 525             my $srcprefix = $cdr->src;
 526             $srcprefix =~ /^(\d{6})/;
 527             $srcprefix = qsearchs('rate_prefix', {   'countrycode' => '1',
 528                                                      'npa' => $1,
 529                                                  }) || '';
 530             $eff_ratenum = $intrastate_ratenum if ($srcprefix && $dstprefix
 531                 && $srcprefix->state && $dstprefix->state
 532                 && $srcprefix->state eq $dstprefix->state);
 533           }
 534
 535           $eff_ratenum ||= $ratenum;
 536           $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
 537             or die "ratenum $eff_ratenum not found!";
 538
 539           my @ltime = localtime($cdr->startdate);
 540           $weektime = $ltime[0] +
 541                       $ltime[1]*60 +   #minutes
 542                       $ltime[2]*3600 + #hours
 543                       $ltime[6]*86400; #days since sunday
 544           # if there's no timed rate_detail for this time/region combination,
 545           # dest_detail returns the default.  There may still be a timed rate
 546           # that applies after the starttime of the call, so be careful...
 547           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 548                                               'phonenum'    => $number,
 549                                               'weektime'    => $weektime,
 550                                               'cdrtypenum'  => $cdr->cdrtypenum,
 551                                             });
 552
 553           if ( $rate_detail ) {
 554
 555             $rate_region = $rate_detail->dest_region;
 556             $regionnum = $rate_region->regionnum;
 557             $regionname = $rate_region->regionname;
 558             warn "  found rate for regionnum $regionnum ".
 559                  "and rate detail $rate_detail\n"
 560               if $DEBUG;
 561
 562             if ( !exists($interval_cache{$regionnum}) ) {
 563               my @intervals = (
 564                 sort { $a->stime <=> $b->stime }
 565                 map { my $r = $_->rate_time; $r ? $r->intervals : () }
 566                 $rate->rate_detail
 567               );
 568               $interval_cache{$regionnum} = \@intervals;
 569               warn "  cached ".scalar(@intervals)." interval(s)\n"
 570                 if $DEBUG;
 571             }
 572
 573           } elsif ( $ignore_unrateable ) {
 574
 575             $rate_region = '';
 576             $regionnum = '';
 577             #code below will throw a warning & skip
 578
 579           } else {
 580
 581             die "FATAL: no rate_detail found in ".
 582                 $rate->ratenum. ":". $rate->ratename. " rate plan ".
 583                 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
 584                 "add a rate or set ignore_unrateable flag on the package def\n";
 585           }
 586
 587         }
 588
 589       } elsif ( $rating_method eq 'upstream_simple' ) {
 590
 591         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
 592         $charge = sprintf('%.3f', $cdr->upstream_price);
 593         $charges += $charge;
 594         warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 595
 596         @call_details = ($cdr->downstream_csv( 'format' => $output_format,
 597                                                'charge' => $charge,
 598                                              )
 599                         );
 600         $classnum = $cdr->calltypenum;
 601
 602       } elsif ( $rating_method eq 'single_price' ) {
 603
 604         # a little false laziness w/below
 605         # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
 606
 607         my $granularity = length($self->option('sec_granularity'))
 608                             ? $self->option('sec_granularity')
 609                             : 60;
 610
 611         $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
 612
 613         $seconds += $granularity - ( $seconds % $granularity )
 614           if $seconds      # don't granular-ize 0 billsec calls (bills them)
 615           && $granularity  # 0 is per call
 616           && $seconds % $granularity;
 617         my $minutes = $granularity ? ($seconds / 60) : 1;
 618         $charge = sprintf('%.4f', ( $self->option('min_charge') * $minutes )
 619                                   + 0.0000000001 ); #so 1.00005 rounds to 1.0001
 620
 621         warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 622         $charges += $charge;
 623
 624         @call_details = ($cdr->downstream_csv( 'format'  => $output_format,
 625                                                'charge'  => $charge,
 626                                                'seconds' => ($use_duration ?
 627                                                              $cdr->duration :
 628                                                              $cdr->billsec),
 629                                                'granularity' => $granularity,
 630                                              )
 631                         );
 632
 633       } else {
 634         die "don't know how to rate CDRs using method: $rating_method\n";
 635       }
 636
 637       ###
 638       # find the price and add detail to the invoice
 639       ###
 640
 641       # if $rate_detail is not found, skip this CDR... i.e.
 642       # don't add it to invoice, don't set its status to done,
 643       # don't call downstream_csv or something on it...
 644       # but DO emit a warning...
 645       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
 646       if ( ! $rate_detail && $charge eq '' ) {
 647
 648         warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
 649              "; skipping\n"
 650
 651       } else { # there *is* a rate_detail (or call_details), proceed...
 652         # About this section:
 653         # We don't round _anything_ (except granularizing)
 654         # until the final $charge = sprintf("%.2f"...).
 655
 656         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
 657
 658           my $seconds_left = $use_duration ? $cdr->duration : $cdr->billsec;
 659           # charge for the first (conn_sec) seconds
 660           $seconds = min($seconds_left, $rate_detail->conn_sec);
 661           $seconds_left -= $seconds;
 662           $weektime     += $seconds;
 663           $charge = $rate_detail->conn_charge;
 664
 665           my $etime;
 666           while($seconds_left) {
 667             my $ratetimenum = $rate_detail->ratetimenum; # may be empty
 668
 669             # find the end of the current rate interval
 670             if(@{ $interval_cache{$regionnum} } == 0) {
 671               # There are no timed rates in this group, so just stay
 672               # in the default rate_detail for the entire duration.
 673               # Set an "end" of 1 past the end of the current call.
 674               $etime = $weektime + $seconds_left + 1;
 675             }
 676             elsif($ratetimenum) {
 677               # This is a timed rate, so go to the etime of this interval.
 678               # If it's followed by another timed rate, the stime of that
 679               # interval should match the etime of this one.
 680               my $interval = $rate_detail->rate_time->contains($weektime);
 681               $etime = $interval->etime;
 682             }
 683             else {
 684               # This is a default rate, so use the stime of the next
 685               # interval in the sequence.
 686               my $next_int = first { $_->stime > $weektime }
 687                               @{ $interval_cache{$regionnum} };
 688               if ($next_int) {
 689                 $etime = $next_int->stime;
 690               }
 691               else {
 692                 # weektime is near the end of the week, so decrement
 693                 # it by a full week and use the stime of the first
 694                 # interval.
 695                 $weektime -= (3600*24*7);
 696                 $etime = $interval_cache{$regionnum}->[0]->stime;
 697               }
 698             }
 699
 700             my $charge_sec = min($seconds_left, $etime - $weektime);
 701
 702             $seconds_left -= $charge_sec;
 703
 704             $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included
 705               unless exists $included_min{$regionnum}{$ratetimenum};
 706
 707             my $granularity = $rate_detail->sec_granularity;
 708
 709             my $minutes;
 710             if ( $granularity ) { # charge per minute
 711               # Round up to the nearest $granularity
 712               if ( $charge_sec and $charge_sec % $granularity ) {
 713                 $charge_sec += $granularity - ($charge_sec % $granularity);
 714               }
 715               $minutes = $charge_sec / 60; #don't round this
 716             }
 717             else { # per call
 718               $minutes = 1;
 719               $seconds_left = 0;
 720             }
 721
 722             $seconds += $charge_sec;
 723
 724             $region_group_included_min -= $minutes
 725                 if $region_group && $rate_detail->region_group;
 726
 727             $included_min{$regionnum}{$ratetimenum} -= $minutes;
 728             if ( ($region_group_included_min <= 0 || !$rate_detail->region_group)
 729                           && $included_min{$regionnum}{$ratetimenum} <= 0 ) {
 730               my $charge_min = 0 - $included_min{$regionnum}{$ratetimenum}; #XXX should preserve
 731                                                               #(display?) this
 732               $included_min{$regionnum}{$ratetimenum} = 0;
 733               $charge += ($rate_detail->min_charge * $charge_min); #still not rounded
 734             }
 735             elsif( $region_group_included_min > 0 && $region_group
 736                 && $rate_detail->region_group ) {
 737                 $included_min{$regionnum}{$ratetimenum} = 0
 738             }
 739
 740             # choose next rate_detail
 741             $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 742                                                 'phonenum'    => $number,
 743                                                 'weektime'    => $etime,
 744                                                 'cdrtypenum'  => $cdr->cdrtypenum })
 745                     if($seconds_left);
 746             # we have now moved forward to $etime
 747             $weektime = $etime;
 748
 749           } #while $seconds_left
 750           # this is why we need regionnum/rate_region....
 751           warn "  (rate region $rate_region)\n" if $DEBUG;
 752
 753           $classnum = $rate_detail->classnum;
 754           $charge = sprintf('%.2f', $charge + 0.000001); # NOW round it.
 755           warn "Incrementing \$charges by $charge.  Now $charges\n" if $DEBUG;
 756           $charges += $charge;
 757
 758           @call_details = (
 759             $cdr->downstream_csv( 'format'         => $output_format,
 760                                   'granularity'    => $rate_detail->sec_granularity,
 761                                   'seconds'        => ($use_duration ?
 762                                                        $cdr->duration :
 763                                                        $cdr->billsec),
 764                                   'charge'         => $charge,
 765                                   'pretty_dst'     => $pretty_destnum,
 766                                   'dst_regionname' => $regionname,
 767                                 )
 768           );
 769         } #if(there is a rate_detail)
 770
 771
 772         if ( $charge > 0 ) {
 773           #just use FS::cust_bill_pkg_detail objects?
 774           my $call_details;
 775           my $phonenum = $svc_x->phonenum;
 776
 777           if ( scalar(@call_details) == 1 ) {
 778             $call_details =
 779               [ 'C',
 780                 $call_details[0],
 781                 $charge,
 782                 $classnum,
 783                 $phonenum,
 784                 $cdr->accountcode,
 785                 $seconds,
 786                 $regionname,
 787               ];
 788           } else { #only used for $rating_method eq 'upstream' now
 789             $csv->combine(@call_details);
 790             $call_details =
 791               [ 'C',
 792                 $csv->string,
 793                 $charge,
 794                 $classnum,
 795                 $phonenum,
 796                 $cdr->accountcode,
 797                 $seconds,
 798                 $regionname,
 799               ];
 800           }
 801           warn "  adding details on charge to invoice: [ ".
 802               join(', ', @{$call_details} ). " ]"
 803             if ( $DEBUG && ref($call_details) );
 804           push @invoice_details_sort, [ $call_details, $cdr->calldate_unix ];
 805         }
 806
 807         # if the customer flag is on, call "downstream_csv" or something
 808         # like it to export the call downstream!
 809         # XXX price plan option to pick format, or something...
 810         #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
 811         #  if $spool_cdr;
 812
 813         my $error = $cdr->set_status_and_rated_price( 'done',
 814                                                       $charge,
 815                                                       $cust_svc->svcnum,
 816                                                     );
 817         die $error if $error;
 818
 819       }
 820
 821     } # $cdr
 822
 823     my @sorted_invoice_details = sort { @{$a}[1] <=> @{$b}[1] } @invoice_details_sort;
 824     foreach my $sorted_call_detail ( @sorted_invoice_details ) {
 825         push @$details, @{$sorted_call_detail}[0];
 826     }
 827
 828   } # $cust_svc
 829
 830   unshift @$details, [ 'C',
 831                        FS::cdr::invoice_header($output_format),
 832                        '',
 833                        '',
 834                        '',
 835                        '',
 836                        '',
 837                      ]
 838     if @$details && $rating_method ne 'upstream';
 839
 840 #  if ( $spool_cdr && length($downstream_cdr) ) {
 841 #
 842 #    use FS::UID qw(datasrc);
 843 #    my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 844 #    mkdir $dir, 0700 unless -d $dir;
 845 #    $dir .= '/'. $cust_pkg->custnum.
 846 #    mkdir $dir, 0700 unless -d $dir;
 847 #    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
 848 #
 849 #    push @{ $param->{'precommit_hooks'} },
 850 #         sub {
 851 #               #lock the downstream spool file and append the records
 852 #               use Fcntl qw(:flock);
 853 #               use IO::File;
 854 #               my $spool = new IO::File ">>$filename"
 855 #                 or die "can't open $filename: $!\n";
 856 #               flock( $spool, LOCK_EX)
 857 #                 or die "can't lock $filename: $!\n";
 858 #               seek($spool, 0, 2)
 859 #                 or die "can't seek to end of $filename: $!\n";
 860 #               print $spool $downstream_cdr;
 861 #               flock( $spool, LOCK_UN );
 862 #               close $spool;
 863 #             };
 864 #
 865 #  } #if ( $spool_cdr && length($downstream_cdr) )
 866
 867   $charges;
 868 }
 869
 870 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
 871 sub check_chargable {
 872   my( $self, $cdr, %flags ) = @_;
 873
 874   #should have some better way of checking these options from a hash
 875   #or something
 876
 877   my @opt = qw(
 878     use_amaflags
 879     use_carrierid
 880     use_cdrtypenum
 881     ignore_cdrtypenum
 882     disposition_in
 883     ignore_disposition
 884     skip_dst_prefix
 885     skip_dcontext
 886     skip_dstchannel_prefix
 887     skip_src_length_more noskip_src_length_accountcode_tollfree
 888     skip_dst_length_less noskip_dst_length_accountcode_tollfree
 889     skip_lastapp
 890     skip_max_callers
 891   );
 892   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
 893     $flags{option_cache}->{$opt} = $self->option($opt, 1);
 894   }
 895   my %opt = %{ $flags{option_cache} };
 896
 897   return 'amaflags != 2'
 898     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
 899
 900   return "disposition NOT IN ( $opt{'disposition_in'} )"
 901     if $opt{'disposition_in'} =~ /\S/
 902     && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'disposition_in'});
 903
 904   return "disposition IN ( $opt{'ignore_disposition'} )"
 905     if $opt{'ignore_disposition'} =~ /\S/
 906     && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'ignore_disposition'});
 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   return "cdrtypenum != $opt{'use_cdrtypenum'}"
 914     if length($opt{'use_cdrtypenum'})
 915     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
 916
 917   return "cdrtypenum == $opt{'ignore_cdrtypenum'}"
 918     if length($opt{'ignore_cdrtypenum'})
 919     && $cdr->cdrtypenum eq $opt{'ignore_cdrtypenum'}; #eq otherwise 0 matches ''
 920
 921   foreach(split(',',$opt{'skip_dst_prefix'})) {
 922     return "dst starts with '$_'"
 923     if length($_) && substr($cdr->dst,0,length($_)) eq $_;
 924   }
 925
 926   return "dcontext IN ( $opt{'skip_dcontext'} )"
 927     if $opt{'skip_dcontext'} =~ /\S/
 928     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
 929
 930   my $len_prefix = length($opt{'skip_dstchannel_prefix'});
 931   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
 932     if $len_prefix
 933     && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
 934
 935   my $dst_length = $opt{'skip_dst_length_less'};
 936   return "destination less than $dst_length digits"
 937     if $dst_length && length($cdr->dst) < $dst_length
 938     && ! ( $opt{'noskip_dst_length_accountcode_tollfree'}
 939             && $cdr->is_tollfree('accountcode')
 940          );
 941
 942   return "lastapp is $opt{'skip_lastapp'}"
 943     if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
 944
 945   my $src_length = $opt{'skip_src_length_more'};
 946   if ( $src_length ) {
 947
 948     if ( $opt{'noskip_src_length_accountcode_tollfree'} ) {
 949
 950       if ( $cdr->is_tollfree('accountcode') ) {
 951         return "source less than or equal to $src_length digits"
 952           if length($cdr->src) <= $src_length;
 953       } else {
 954         return "source more than $src_length digits"
 955           if length($cdr->src) > $src_length;
 956       }
 957
 958     } else {
 959       return "source more than $src_length digits"
 960         if length($cdr->src) > $src_length;
 961     }
 962
 963   }
 964
 965   return "max_callers <= $opt{skip_max_callers}"
 966     if length($opt{'skip_max_callers'})
 967       and length($cdr->max_callers)
 968       and $cdr->max_callers <= $opt{'skip_max_callers'};
 969
 970   #all right then, rate it
 971   '';
 972 }
 973
 974 sub is_free {
 975   0;
 976 }
 977
 978 #  This equates svc_phone records; perhaps svc_phone should have a field
 979 #  to indicate it represents a line
 980 sub calc_units {
 981   my($self, $cust_pkg ) = @_;
 982   my $count = 0;
 983   if ( $self->option('count_available_phones', 1)) {
 984     map { $count += ( $_->quantity || 0 ) }
 985       grep { $_->part_svc->svcdb eq 'svc_phone' }
 986       $cust_pkg->part_pkg->pkg_svc;
 987   } else {
 988     $count =
 989       scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 990   }
 991   $count;
 992 }
 993
 994 1;
 995