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