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