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