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