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