FS/FS/part_pkg/voip_cdr.pm

   1 package FS::part_pkg::voip_cdr;
   2
   3 use strict;
   4 use vars qw(@ISA $DEBUG %info);
   5 use Date::Format;
   6 use Tie::IxHash;
   7 use FS::Conf;
   8 use FS::Record qw(qsearchs qsearch);
   9 use FS::part_pkg::recur_Common;
  10 use FS::cdr;
  11 use FS::rate;
  12 use FS::rate_prefix;
  13 use FS::rate_detail;
  14 use FS::part_pkg::recur_Common;
  15
  16 @ISA = qw(FS::part_pkg::recur_Common);
  17
  18 $DEBUG = 0;
  19
  20 tie my %rating_method, 'Tie::IxHash',
  21   'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
  22 #  '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.',
  23   'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
  24   'single_price' => 'A single price per minute for all calls.',
  25 ;
  26
  27 #tie my %cdr_location, 'Tie::IxHash',
  28 #  'internal' => 'Internal: CDR records imported into the internal CDR table',
  29 #  'external' => 'External: CDR records queried directly from an external '.
  30 #                'Asterisk (or other?) CDR table',
  31 #;
  32
  33 tie my %temporalities, 'Tie::IxHash',
  34   'upcoming'  => "Upcoming (future)",
  35   'preceding' => "Preceding (past)",
  36 ;
  37
  38 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
  39
  40 %info = (
  41   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
  42   'shortname' => 'VoIP/telco CDR rating (standard)',
  43   'fields' => {
  44     'setup_fee'     => { 'name' => 'Setup fee for this package',
  45                          'default' => 0,
  46                        },
  47     'recur_fee'     => { 'name' => 'Base recurring fee for this package',
  48                          'default' => 0,
  49                        },
  50
  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     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
  58                                    ' of service at cancellation',
  59                          'type' => 'checkbox',
  60                        },
  61
  62     'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating or '.
  63                                    'subscription',
  64                          'default' => '1',
  65                        },
  66
  67     'recur_method'  => { 'name' => 'Recurring fee method',
  68                          #'type' => 'radio',
  69                          #'options' => \%recur_method,
  70                          'type' => 'select',
  71                          'select_options' => \%FS::part_pkg::recur_Common::recur_method,
  72                        },
  73
  74     'rating_method' => { 'name' => 'Rating method',
  75                          'type' => 'radio',
  76                          'options' => \%rating_method,
  77                        },
  78
  79     'ratenum'   => { 'name' => 'Rate plan',
  80                      'type' => 'select',
  81                      'select_table' => 'rate',
  82                      'select_key'   => 'ratenum',
  83                      'select_label' => 'ratename',
  84                    },
  85
  86     'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
  87                     },
  88
  89     'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
  90                            'type' => 'select',
  91                            'select_options' => \%granularity,
  92                          },
  93
  94     '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.',
  95                              'type' => 'checkbox',
  96                            },
  97
  98     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
  99                           'default' => '+1',
 100                         },
 101
 102     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
 103                        'type' => 'checkbox'
 104                      },
 105
 106     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
 107                            'default' => '1',
 108                          },
 109
 110 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
 111 #                                    'type' => 'checkbox',
 112 #                                  },
 113
 114     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
 115                                 'default' => '011',
 116                               },
 117
 118     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
 119                             'type' => 'checkbox',
 120                           },
 121
 122     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
 123                         'type' => 'checkbox',
 124                       },
 125
 126     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
 127                            'type' => 'checkbox',
 128                          },
 129
 130     'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
 131                                  'type' => 'checkbox',
 132                                },
 133
 134     'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
 135                          },
 136
 137     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
 138                          },
 139
 140     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
 141                        },
 142
 143     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
 144                                 },
 145
 146     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
 147                               },
 148
 149     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
 150                       },
 151
 152     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
 153                           'type' => 'checkbox',
 154                         },
 155
 156     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
 157                       },
 158
 159     #false laziness w/cdr_termination.pm
 160     'output_format' => { 'name' => 'CDR invoice display format',
 161                          'type' => 'select',
 162                          'select_options' => { FS::cdr::invoice_formats() },
 163                          'default'        => 'default', #XXX test
 164                        },
 165
 166     'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not)',
 167                        },
 168
 169     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 170                           'type' => 'checkbox',
 171                         },
 172
 173     'usage_mandate' => { 'name' => 'Always put usage details in separate section',
 174                           'type' => 'checkbox',
 175                        },
 176     #eofalse
 177
 178     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call.  Useful for prepaid.',
 179                            'type' => 'checkbox',
 180                          },
 181
 182     '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.',
 183                            'type' => 'checkbox',
 184                          },
 185
 186     #XXX also have option for an external db
 187 #    'cdr_location' => { 'name' => 'CDR database location'
 188 #                        'type' => 'select',
 189 #                        'select_options' => \%cdr_location,
 190 #                        'select_callback' => {
 191 #                          'external' => {
 192 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 193 #                          },
 194 #                          'internal' => {
 195 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 196 #                          }
 197 #                        },
 198 #                      },
 199 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 200 #                   'disabled' => 'Y',
 201 #                 },
 202 #    'username' => { 'name' => 'External database username',
 203 #                    'disabled' => 'Y',
 204 #                  },
 205 #    'password' => { 'name' => 'External database password',
 206 #                    'disabled' => 'Y',
 207 #                  },
 208
 209   },
 210   'fieldorder' => [qw(
 211                        setup_fee recur_fee recur_temporality unused_credit
 212                        recur_method cutoff_day
 213                        rating_method ratenum min_charge sec_granularity
 214                        ignore_unrateable
 215                        default_prefix
 216                        disable_src
 217                        domestic_prefix international_prefix
 218                        disable_tollfree
 219                        use_amaflags use_disposition
 220                        use_disposition_taqua use_carrierid use_cdrtypenum
 221                        skip_dcontext skip_dstchannel_prefix
 222                        skip_dst_length_less skip_lastapp
 223                        use_duration
 224                        411_rewrite
 225                        output_format usage_mandate summarize_usage usage_section
 226                        bill_every_call
 227                        count_available_phones
 228                      )
 229                   ],
 230   'weight' => 40,
 231 );
 232
 233 sub calc_setup {
 234   my($self, $cust_pkg ) = @_;
 235   $self->option('setup_fee');
 236 }
 237
 238 sub calc_recur {
 239   my $self = shift;
 240   my($cust_pkg, $sdate, $details, $param ) = @_;
 241
 242   my $charges = 0;
 243
 244   $charges += $self->calc_usage(@_);
 245   $charges += $self->calc_recur_Common(@_);
 246
 247   $charges;
 248
 249 }
 250
 251 sub calc_cancel {
 252   my $self = shift;
 253   my($cust_pkg, $sdate, $details, $param ) = @_;
 254
 255   $self->calc_usage(@_);
 256 }
 257
 258 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 259
 260 sub calc_usage {
 261   my $self = shift;
 262   my($cust_pkg, $sdate, $details, $param ) = @_;
 263
 264   #my $last_bill = $cust_pkg->last_bill;
 265   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 266
 267   return 0
 268     if $self->option('recur_temporality', 1) eq 'preceding'
 269     && ( $last_bill eq '' || $last_bill == 0 );
 270
 271   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 272
 273   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
 274
 275   my %included_min = ();
 276
 277   my $charges = 0;
 278
 279 #  my $downstream_cdr = '';
 280
 281   my $rating_method     = $self->option('rating_method') || 'prefix';
 282   my $intl              = $self->option('international_prefix') || '011';
 283   my $domestic_prefix   = $self->option('domestic_prefix');
 284   my $disable_tollfree  = $self->option('disable_tollfree');
 285   my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
 286   my $use_duration      = $self->option('use_duration');
 287
 288   my $output_format     = $self->option('output_format', 'Hush!')
 289                           || ( $rating_method eq 'upstream_simple'
 290                                  ? 'simple'
 291                                  : 'default'
 292                              );
 293
 294   my @dirass = ();
 295   if ( $self->option('411_rewrite') ) {
 296     my $dirass = $self->option('411_rewrite');
 297     $dirass =~ s/\s//g;
 298     @dirass = split(',', $dirass);
 299   }
 300
 301   #for check_chargable, so we don't keep looking up options inside the loop
 302   my %opt_cache = ();
 303
 304   eval "use Text::CSV_XS;";
 305   die $@ if $@;
 306   my $csv = new Text::CSV_XS;
 307
 308   foreach my $cust_svc (
 309     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
 310   ) {
 311
 312     my $svc_phone = $cust_svc->svc_x;
 313     foreach my $cdr (
 314       $svc_phone->get_cdrs(
 315         'disable_src'    => $self->option('disable_src'),
 316         'default_prefix' => $self->option('default_prefix'),
 317         'status'         => '',
 318         'for_update'     => 1,
 319       )  # $last_bill, $$sdate )
 320     ) {
 321       if ( $DEBUG > 1 ) {
 322         warn "rating CDR $cdr\n".
 323              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 324       }
 325
 326       my $rate_detail;
 327       my( $rate_region, $regionnum );
 328       my $pretty_destnum;
 329       my $charge = '';
 330       my $seconds = '';
 331       my $regionname = '';
 332       my $classnum = '';
 333       my @call_details = ();
 334       if ( $rating_method eq 'prefix' ) {
 335
 336         my $da_rewrote = 0;
 337         if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
 338           $cdr->dst('411');
 339           $da_rewrote = 1;
 340         }
 341
 342         my $reason = $self->check_chargable( $cdr,
 343                                              'da_rewrote'   => $da_rewrote,
 344                                              'option_cache' => \%opt_cache,
 345                                            );
 346
 347         if ( $reason ) {
 348
 349           warn "not charging for CDR ($reason)\n" if $DEBUG;
 350           $charge = 0;
 351
 352         } else {
 353
 354           ###
 355           # look up rate details based on called station id
 356           # (or calling station id for toll free calls)
 357           ###
 358
 359           my( $to_or_from, $number );
 360           if ( $cdr->is_tollfree && ! $disable_tollfree )
 361           { #tollfree call
 362             $to_or_from = 'from';
 363             $number = $cdr->src;
 364           } else { #regular call
 365             $to_or_from = 'to';
 366             $number = $cdr->dst;
 367           }
 368
 369           warn "parsing call $to_or_from $number\n" if $DEBUG;
 370
 371           #remove non-phone# stuff and whitespace
 372           $number =~ s/\s//g;
 373 #          my $proto = '';
 374 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
 375 #          my $siphost = '';
 376 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 377
 378           #determine the country code
 379           my $countrycode;
 380           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
 381                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
 382              )
 383           {
 384
 385             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
 386             #first look for 1 digit country code
 387             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
 388               $countrycode = $one;
 389               $number = $u1.$u2.$rest;
 390             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
 391               $countrycode = $two;
 392               $number = $u2.$rest;
 393             } else { #3 digit country code
 394               $countrycode = $three;
 395               $number = $rest;
 396             }
 397
 398           } else {
 399             $countrycode = $domestic_prefix || '1';
 400             $number =~ s/^$countrycode//;# if length($number) > 10;
 401           }
 402
 403           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
 404           $pretty_destnum = "+$countrycode $number";
 405           #asterisks here causes inserting the detail to barf, so:
 406           $pretty_destnum =~ s/\*//g;
 407
 408           my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
 409             or die "ratenum $ratenum not found!";
 410
 411           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 412                                               'phonenum'    => $number,
 413                                             });
 414
 415           if ( $rate_detail ) {
 416
 417             $rate_region = $rate_detail->dest_region;
 418             $regionnum = $rate_region->regionnum;
 419             $regionname = $rate_region->regionname;
 420             warn "  found rate for regionnum $regionnum ".
 421                  "and rate detail $rate_detail\n"
 422               if $DEBUG;
 423
 424           } elsif ( $ignore_unrateable ) {
 425
 426             $rate_region = '';
 427             $regionnum = '';
 428             #code below will throw a warning & skip
 429
 430           } else {
 431
 432             die "FATAL: no rate_detail found in ".
 433                 $rate->ratenum. ":". $rate->ratename. " rate plan ".
 434                 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
 435                 "add a rate or set ignore_unrateable flag on the package def\n";
 436           }
 437
 438         }
 439
 440 #      } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used.  very much becoming the odd one out. remove?
 441 #
 442 #        if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
 443 #
 444 #          $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
 445 #
 446 #          $regionnum = $rate_detail->dest_regionnum;
 447 #          $rate_region = $rate_detail->dest_region;
 448 #
 449 #          $pretty_destnum = $cdr->dst;
 450 #
 451 #          warn "  found rate for regionnum $regionnum and ".
 452 #               "rate detail $rate_detail\n"
 453 #            if $DEBUG;
 454 #
 455 #        } else { #pass upstream price through
 456 #
 457 #          $charge = sprintf('%.2f', $cdr->upstream_price);
 458 #          $charges += $charge;
 459 #
 460 #          @call_details = (
 461 #            #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
 462 #            time2str("%c", $cdr->calldate_unix),  #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot
 463 #            'N/A', #minutes...
 464 #            '$'.$charge,
 465 #            #$pretty_destnum,
 466 #            $cdr->description, #$rate_region->regionname,
 467 #          );
 468 #
 469 #        }
 470
 471       } elsif ( $rating_method eq 'upstream_simple' ) {
 472
 473         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
 474         $charge = sprintf('%.3f', $cdr->upstream_price);
 475         $charges += $charge;
 476
 477         @call_details = ($cdr->downstream_csv( 'format' => $output_format,
 478                                                'charge' => $charge,
 479                                              )
 480                         );
 481         $classnum = $cdr->calltypenum;
 482
 483       } elsif ( $rating_method eq 'single_price' ) {
 484
 485         # a little false laziness w/below
 486
 487         my $granularity = length($self->option('sec_granularity'))
 488                             ? $self->option('sec_granularity')
 489                             : 60;
 490
 491                     # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
 492         $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
 493
 494         $seconds += $granularity - ( $seconds % $granularity )
 495           if $seconds      # don't granular-ize 0 billsec calls (bills them)
 496           && $granularity; # 0 is per call
 497         my $minutes = $seconds / 60; # sprintf("%.1f",
 498         #$minutes =~ s/\.0$// if $granularity == 60;
 499
 500         # XXX config?
 501         #$charge = sprintf('%.2f', ( $self->option('min_charge') * $minutes )
 502                                   #+ 0.00000001 ); #so 1.005 rounds to 1.01
 503         $charge = sprintf('%.4f', ( $self->option('min_charge') * $minutes )
 504                                   + 0.0000000001 ); #so 1.00005 rounds to 1.0001
 505
 506         $charges += $charge;
 507
 508         @call_details = ($cdr->downstream_csv( 'format' => $output_format,
 509                                                'charge' => $charge,
 510                                              )
 511                         );
 512
 513       } else {
 514         die "don't know how to rate CDRs using method: $rating_method\n";
 515       }
 516
 517       ###
 518       # find the price and add detail to the invoice
 519       ###
 520
 521       # if $rate_detail is not found, skip this CDR... i.e.
 522       # don't add it to invoice, don't set its status to done,
 523       # don't call downstream_csv or something on it...
 524       # but DO emit a warning...
 525       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
 526       if ( ! $rate_detail && $charge eq '' ) {
 527
 528         warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
 529              "; skipping\n"
 530
 531       } else { # there *is* a rate_detail (or call_details), proceed...
 532
 533         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
 534
 535           $included_min{$regionnum} = $rate_detail->min_included
 536             unless exists $included_min{$regionnum};
 537
 538           my $granularity = $rate_detail->sec_granularity;
 539
 540                       # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
 541           $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
 542
 543           $seconds -= $rate_detail->conn_sec;
 544           $seconds = 0 if $seconds < 0;
 545
 546           $seconds += $granularity - ( $seconds % $granularity )
 547             if $seconds      # don't granular-ize 0 billsec calls (bills them)
 548             && $granularity; # 0 is per call
 549           my $minutes = sprintf("%.1f", $seconds / 60);
 550           $minutes =~ s/\.0$// if $granularity == 60;
 551
 552           # per call rather than per minute
 553           $minutes = 1 unless $granularity;
 554
 555           $included_min{$regionnum} -= $minutes;
 556
 557           $charge = sprintf('%.2f', $rate_detail->conn_charge);
 558
 559           if ( $included_min{$regionnum} < 0 ) {
 560             my $charge_min = 0 - $included_min{$regionnum}; #XXX should preserve
 561                                                             #(display?) this
 562             $included_min{$regionnum} = 0;
 563             $charge += sprintf('%.2f', ($rate_detail->min_charge * $charge_min)
 564                                        + 0.00000001 ); #so 1.005 rounds to 1.01
 565             $charge = sprintf('%.2f', $charge);
 566             $charges += $charge;
 567           }
 568
 569           # this is why we need regionnum/rate_region....
 570           warn "  (rate region $rate_region)\n" if $DEBUG;
 571
 572           @call_details = (
 573            $cdr->downstream_csv( 'format'         => $output_format,
 574                                  'granularity'    => $granularity,
 575                                  'minutes'        => $minutes,
 576                                  'charge'         => $charge,
 577                                  'pretty_dst'     => $pretty_destnum,
 578                                  'dst_regionname' => $regionname,
 579                                )
 580           );
 581
 582           $classnum = $rate_detail->classnum;
 583
 584         }
 585
 586         if ( $charge > 0 ) {
 587           #just use FS::cust_bill_pkg_detail objects?
 588           my $call_details;
 589           my $phonenum = $cust_svc->svc_x->phonenum;
 590
 591           #if ( $self->option('rating_method') eq 'upstream_simple' ) {
 592           if ( scalar(@call_details) == 1 ) {
 593             $call_details =
 594               [ 'C',
 595                 $call_details[0],
 596                 $charge,
 597                 $classnum,
 598                 $phonenum,
 599                 $seconds,
 600                 $regionname,
 601               ];
 602           } else { #only used for $rating_method eq 'upstream' now
 603             $csv->combine(@call_details);
 604             $call_details =
 605               [ 'C',
 606                 $csv->string,
 607                 $charge,
 608                 $classnum,
 609                 $phonenum,
 610                 $seconds,
 611                 $regionname,
 612               ];
 613           }
 614           warn "  adding details on charge to invoice: [ ".
 615               join(', ', @{$call_details} ). " ]"
 616             if ( $DEBUG && ref($call_details) );
 617           push @$details, $call_details; #\@call_details,
 618         }
 619
 620         # if the customer flag is on, call "downstream_csv" or something
 621         # like it to export the call downstream!
 622         # XXX price plan option to pick format, or something...
 623         #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
 624         #  if $spool_cdr;
 625
 626         my $error = $cdr->set_status_and_rated_price( 'done',
 627                                                       $charge,
 628                                                       $cust_svc->svcnum,
 629                                                     );
 630         die $error if $error;
 631
 632       }
 633
 634     } # $cdr
 635
 636   } # $cust_svc
 637
 638   unshift @$details, [ 'C',
 639                        FS::cdr::invoice_header($output_format),
 640                        '',
 641                        '',
 642                        '',
 643                        '',
 644                        '',
 645                      ]
 646     if @$details && $rating_method ne 'upstream';
 647
 648 #  if ( $spool_cdr && length($downstream_cdr) ) {
 649 #
 650 #    use FS::UID qw(datasrc);
 651 #    my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 652 #    mkdir $dir, 0700 unless -d $dir;
 653 #    $dir .= '/'. $cust_pkg->custnum.
 654 #    mkdir $dir, 0700 unless -d $dir;
 655 #    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
 656 #
 657 #    push @{ $param->{'precommit_hooks'} },
 658 #         sub {
 659 #               #lock the downstream spool file and append the records
 660 #               use Fcntl qw(:flock);
 661 #               use IO::File;
 662 #               my $spool = new IO::File ">>$filename"
 663 #                 or die "can't open $filename: $!\n";
 664 #               flock( $spool, LOCK_EX)
 665 #                 or die "can't lock $filename: $!\n";
 666 #               seek($spool, 0, 2)
 667 #                 or die "can't seek to end of $filename: $!\n";
 668 #               print $spool $downstream_cdr;
 669 #               flock( $spool, LOCK_UN );
 670 #               close $spool;
 671 #             };
 672 #
 673 #  } #if ( $spool_cdr && length($downstream_cdr) )
 674
 675   $charges;
 676 }
 677
 678 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
 679 sub check_chargable {
 680   my( $self, $cdr, %flags ) = @_;
 681
 682   #should have some better way of checking these options from a hash
 683   #or something
 684
 685   my @opt = qw(
 686     use_amaflags
 687     use_disposition
 688     use_disposition_taqua
 689     use_carrierid
 690     use_cdrtypenum
 691     skip_dcontext
 692     skip_dstchannel_prefix
 693     skip_dst_length_less
 694     skip_lastapp
 695   );
 696   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
 697     $flags{option_cache}->{$opt} = $self->option($opt, 1);
 698   }
 699   my %opt = %{ $flags{option_cache} };
 700
 701   return 'amaflags != 2'
 702     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
 703
 704   return 'disposition != ANSWERED'
 705     if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
 706
 707   return "disposition != 100"
 708     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
 709
 710   return "carrierid != $opt{'use_carrierid'}"
 711     if length($opt{'use_carrierid'})
 712     && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
 713     && ! $flags{'da_rewrote'};
 714
 715   return "cdrtypenum != $opt{'use_cdrtypenum'}"
 716     if length($opt{'use_cdrtypenum'})
 717     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
 718
 719   return "dcontext IN ( $opt{'skip_dcontext'} )"
 720     if $opt{'skip_dcontext'} =~ /\S/
 721     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
 722
 723   my $len_prefix = length($opt{'skip_dstchannel_prefix'});
 724   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
 725     if $len_prefix
 726     && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
 727
 728   my $dst_length = $opt{'skip_dst_length_less'};
 729   return "destination less than $dst_length digits"
 730     if $dst_length && length($cdr->dst) < $dst_length;
 731
 732   return "lastapp is $opt{'skip_lastapp'}"
 733     if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
 734
 735   #all right then, rate it
 736   '';
 737 }
 738
 739 sub is_free {
 740   0;
 741 }
 742
 743 #  This equates svc_phone records; perhaps svc_phone should have a field
 744 #  to indicate it represents a line
 745 sub calc_units {
 746   my($self, $cust_pkg ) = @_;
 747   my $count = 0;
 748   if ( $self->option('count_available_phones', 1)) {
 749     map { $count += ( $_->quantity || 0 ) }
 750       grep { $_->part_svc->svcdb eq 'svc_phone' }
 751       $cust_pkg->part_pkg->pkg_svc;
 752   } else {
 753     $count =
 754       scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 755   }
 756   $count;
 757 }
 758
 759 1;
 760