FS/FS/part_pkg/voip_cdr.pm

   1 package FS::part_pkg::voip_cdr;
   2 use base qw( FS::part_pkg::recur_Common );
   3
   4 use strict;
   5 use vars qw( $DEBUG %info );
   6 use Tie::IxHash;
   7 use Date::Parse;
   8 use Date::Format;
   9 use Text::CSV_XS;
  10 use FS::Conf;
  11 use FS::Record qw(qsearchs qsearch);
  12 use FS::cdr;
  13 use FS::detail_format;
  14
  15 $DEBUG = 0;
  16
  17 tie my %cdr_svc_method, 'Tie::IxHash',
  18   'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)',
  19   'svc_pbx.title'      => 'PBX name (svc_pbx.title)',
  20   'svc_pbx.svcnum'     => 'Freeside service # (svc_pbx.svcnum)',
  21   'svc_pbx.ip.src'     => 'PBX name to source IP address',
  22   'svc_pbx.ip.dst'     => 'PBX name to destination IP address',
  23   'svc_acct.username'  => 'Username (svc_acct.username)',
  24 ;
  25
  26 tie my %rating_method, 'Tie::IxHash',
  27   'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
  28 #  'upstream' => 'Rate calls based on upstream data: If the call type is "1", map the upstream rate ID directly to an internal rate (rate_detail), otherwise, pass the upstream price through directly.',
  29   'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount (ignoring all options to skip calls).',
  30   'single_price' => 'A single price per minute for all calls (ignoring all options to skip calls).',
  31 ;
  32
  33 tie my %rounding, 'Tie::IxHash',
  34   '2' => 'Two decimal places (cent)',
  35   '4' => 'Four decimal places (100th of a cent)',
  36 ;
  37
  38 #tie my %cdr_location, 'Tie::IxHash',
  39 #  'internal' => 'Internal: CDR records imported into the internal CDR table',
  40 #  'external' => 'External: CDR records queried directly from an external '.
  41 #                'Asterisk (or other?) CDR table',
  42 #;
  43
  44 tie my %temporalities, 'Tie::IxHash',
  45   'upcoming'  => "Upcoming (future)",
  46   'preceding' => "Preceding (past)",
  47 ;
  48
  49 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
  50
  51 # previously "1" was "ignore"
  52 tie my %unrateable_opts, 'Tie::IxHash',
  53   '' => 'Exit with a fatal error',
  54   1  => 'Ignore and continue',
  55   2  => 'Flag for later review',
  56 ;
  57
  58 tie my %detail_formats, 'Tie::IxHash',
  59   '' => '',
  60   FS::cdr::invoice_formats()
  61 ;
  62
  63 tie my %accountcode_tollfree_field, 'Tie::IxHash',
  64   'dst' => 'Destination (dst)',
  65   'src' => 'Source (src)',
  66 ;
  67
  68 %info = (
  69   'name' => 'VoIP rating by plan of CDR records',
  70   'shortname' => 'VoIP/telco CDR rating (standard)',
  71   'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
  72   'fields' => {
  73     'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
  74                         'type' => 'checkbox',
  75                       },
  76     #false laziness w/flat.pm
  77     'recur_temporality' => { 'name' => 'Charge recurring fee for period',
  78                              'type' => 'select',
  79                              'select_options' => \%temporalities,
  80                            },
  81
  82     'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating or '.
  83                                    'subscription',
  84                          'default' => '1',
  85                        },
  86     'recur_method'  => { 'name' => 'Recurring fee method',
  87                          #'type' => 'radio',
  88                          #'options' => \%recur_method,
  89                          'type' => 'select',
  90                          'select_options' => \%FS::part_pkg::recur_Common::recur_method,
  91                        },
  92
  93     'cdr_svc_method' => { 'name' => 'CDR service matching method',
  94 #                          'type' => 'radio',
  95                           'type' => 'select',
  96                           'select_options' => \%cdr_svc_method,
  97                         },
  98
  99     'rating_method' => { 'name' => 'Rating method',
 100                          'type' => 'radio',
 101                          'options' => \%rating_method,
 102                        },
 103
 104     'rounding' => { 'name' => 'Rounding for destination prefix rating',
 105                     'type' => 'select',
 106                     'select_options' => \%rounding,
 107                   },
 108
 109     'ratenum'   => { 'name' => 'Rate plan',
 110                      'type' => 'select-rate',
 111                    },
 112
 113     'intrastate_ratenum'   => { 'name' => 'Optional alternate intrastate rate plan',
 114                      'type' => 'select-rate',
 115                      'disable_empty' => 0,
 116                      'empty_label'   => ' ',
 117                    },
 118
 119     'calls_included' => { 'name' => 'Number of calls included at no usage charge', },
 120
 121     'min_included' => { 'name' => 'Minutes included when using the "single price per minute" or "prefix" rating method',
 122                     },
 123
 124     'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
 125                     },
 126
 127     'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
 128                            'type' => 'select',
 129                            'select_options' => \%granularity,
 130                          },
 131
 132     'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
 133                              'type' => 'select',
 134                              'select_options' => \%unrateable_opts,
 135                            },
 136
 137     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
 138                           'default' => '+1',
 139                         },
 140
 141     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
 142                        'type' => 'checkbox'
 143                      },
 144
 145     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
 146                            'default' => '1',
 147                          },
 148
 149 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
 150 #                                    'type' => 'checkbox',
 151 #                                  },
 152
 153     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records (or "none" for no prefix)',
 154                                 'default' => '011',
 155                               },
 156
 157     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
 158                             'type' => 'checkbox',
 159                           },
 160
 161     'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
 162                         'type' => 'checkbox',
 163                       },
 164
 165     'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to any of these (comma-separated) values: ',
 166                          },
 167
 168     'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to this cdrtypenum: ',
 169                           'validate' => \&FS::part_pkg::validate_number_blank,
 170                           'js_validate' => 'digits: true',
 171                          },
 172
 173     'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to this cdrtypenum: ',
 174                              'validate' => \&FS::part_pkg::validate_number_blank,
 175                              'js_validate' => 'digits: true',
 176                          },
 177
 178     'use_calltypenum' => { 'name' => 'Only charge for CDRs where the CDR Call Type is set to this calltypenum: ',
 179                          },
 180
 181     'ignore_calltypenum' => { 'name' => 'Do not charge for CDRs where the CDR Call Type is set to this calltypenum: ',
 182                          },
 183
 184     'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
 185                          },
 186
 187     'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
 188                          },
 189
 190     'disposition_prefix' => { 'name' => 'Only charge for CDRs where the Disposition starts with: ',
 191                          },
 192
 193     'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these (comma-separated) values: ',
 194     },
 195
 196     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where dcontext is set to any of these (comma-separated) values: ',
 197                        },
 198
 199     'noskip_dcontext_tollfree' => { 'name' => 'Do charge for CDRs where dcontext is set to any of the specified values, if the CDR is tollfree',
 200                                                   'type' => 'checkbox',
 201                                                 },
 202
 203     'skip_dcontext_prefix' => { 'name' => 'Do not charge for CDRs where dcontext starts with: ',
 204                        },
 205
 206     'skip_dcontext_suffix' => { 'name' => 'Do not charge for CDRs where dcontext ends with: ',
 207                        },
 208
 209     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
 210                                 },
 211
 212     'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
 213                               },
 214
 215     'noskip_src_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where source is equal or greater than the specified digits, when accountcode is toll free',
 216                                                   'type' => 'checkbox',
 217                                                 },
 218
 219     'accountcode_tollfree_ratenum' => {
 220       'name' => 'Optional alternate rate plan when accountcode is toll free: ',
 221       'type' => 'select',
 222       'select_table'  => 'rate',
 223       'select_key'    => 'ratenum',
 224       'select_label'  => 'ratename',
 225       'disable_empty' => 0,
 226       'empty_label'   => '',
 227     },
 228
 229     'accountcode_tollfree_field' => {
 230       'name'           => 'When using an alternate rate plan for toll-free accountcodes, the CDR field to use in rating calculations',
 231       'type'           => 'select',
 232       'select_options' => \%accountcode_tollfree_field,
 233     },
 234
 235     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
 236                               },
 237
 238     'noskip_dst_length_n11' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when dst is N11 (i.e. 411, 611)',
 239                                                   'type' => 'checkbox',
 240                                                 },
 241
 242     'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
 243                                                   'type' => 'checkbox',
 244                                                 },
 245
 246     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
 247                       },
 248
 249     'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
 250                           },
 251
 252     'skip_same_customer' => {
 253       'name' => 'Do not charge for calls between numbers belonging to the same customer',
 254       'type' => 'checkbox',
 255     },
 256
 257     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
 258                           'type' => 'checkbox',
 259                         },
 260
 261     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
 262                       },
 263
 264     #false laziness w/cdr_termination.pm
 265     'output_format' => { 'name' => 'CDR display format for invoices',
 266                          'type' => 'select',
 267                          'select_options' => \%detail_formats,
 268                          'default'        => 'default', #XXX test
 269                        },
 270
 271     'selfservice_format' =>
 272       { 'name' => 'CDR display format for selfservice',
 273         'type' => 'select',
 274         'select_options' => \%detail_formats,
 275         'default' => 'default'
 276       },
 277     'selfservice_inbound_format' =>
 278       { 'name' => 'Inbound CDR display format for selfservice',
 279         'type' => 'select',
 280         'select_options' => \%detail_formats,
 281         'default' => ''
 282       },
 283
 284     'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
 285                        },
 286
 287     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 288                           'type' => 'checkbox',
 289                         },
 290
 291     'usage_mandate' => { 'name' => 'Always put usage details in separate section.  The section is defined in the next option.',
 292                           'type' => 'checkbox',
 293                        },
 294     #eofalse
 295
 296     'usage_showzero' => { 'name' => 'Show details for included / no-charge calls.',
 297                         'type' => 'checkbox',
 298                       },
 299
 300     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment).  Useful for prepaid.',
 301                            'type' => 'checkbox',
 302                          },
 303
 304     'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
 305                               'type' => 'checkbox',
 306                             },
 307     'bill_only_pkg_dates' => { 'name' => 'Only bill CDRs with a date during the package billing period',
 308                                'type' => 'checkbox',
 309                              },
 310     'skip_old' => { 'name' => 'Do not charge for CDRs older than: ',
 311                     'type' => 'date',
 312                   },
 313
 314     #XXX also have option for an external db?  these days we suck them into ours
 315 #    'cdr_location' => { 'name' => 'CDR database location'
 316 #                        'type' => 'select',
 317 #                        'select_options' => \%cdr_location,
 318 #                        'select_callback' => {
 319 #                          'external' => {
 320 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 321 #                          },
 322 #                          'internal' => {
 323 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 324 #                          }
 325 #                        },
 326 #                      },
 327 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 328 #                   'disabled' => 'Y',
 329 #                 },
 330 #    'username' => { 'name' => 'External database username',
 331 #                    'disabled' => 'Y',
 332 #                  },
 333 #    'password' => { 'name' => 'External database password',
 334 #                    'disabled' => 'Y',
 335 #                  },
 336
 337   },
 338   'fieldorder' => [qw(
 339                        recur_temporality
 340                        recur_method cutoff_day ),
 341                        FS::part_pkg::prorate_Mixin::fieldorder,
 342                     qw(
 343                        cdr_svc_method
 344                        rating_method rounding ratenum intrastate_ratenum
 345                        calls_included
 346                        min_charge min_included
 347                        sec_granularity
 348                        ignore_unrateable
 349                        default_prefix
 350                        disable_src
 351                        domestic_prefix international_prefix
 352                        disable_tollfree
 353                        use_amaflags
 354                        use_carrierid
 355                        use_cdrtypenum ignore_cdrtypenum
 356                        use_calltypenum ignore_calltypenum
 357                        ignore_disposition disposition_in disposition_prefix
 358                        skip_dcontext noskip_dcontext_tollfree
 359                        skip_dcontext_prefix skip_dcontext_suffix
 360                        skip_dst_prefix
 361                        skip_dstchannel_prefix skip_src_length_more
 362                        noskip_src_length_accountcode_tollfree
 363                        accountcode_tollfree_ratenum accountcode_tollfree_field
 364                        skip_dst_length_less noskip_dst_length_n11
 365                        noskip_dst_length_accountcode_tollfree
 366                        skip_lastapp
 367                        skip_max_callers
 368                        skip_same_customer
 369                        use_duration
 370                        411_rewrite
 371                        output_format
 372                        selfservice_format selfservice_inbound_format
 373                        usage_mandate usage_section summarize_usage
 374                        usage_showzero bill_every_call bill_inactive_svcs
 375                        bill_only_pkg_dates skip_old
 376                        suspend_bill
 377                      )
 378                   ],
 379   'weight' => 41,
 380   'validate' => sub {
 381     # Validation function for FS::part_pkg::check_options()
 382     my $options = shift;
 383     return "Please choose a Rate Plan for use with selected Rating Method"
 384       if $options->{rating_method} eq 'prefix' &&  !$options->{ratenum};
 385     return;
 386   },
 387 );
 388
 389 sub price_info {
 390     my $self = shift;
 391     my $str = $self->SUPER::price_info(@_);
 392     $str .= " plus usage" if $str;
 393     $str;
 394 }
 395
 396 sub calc_recur {
 397   my $self = shift;
 398   my($cust_pkg, $sdate, $details, $param ) = @_;
 399
 400   my $charges = 0;
 401
 402   $charges += $self->calc_usage(@_);
 403   $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_);
 404
 405   $charges;
 406
 407 }
 408
 409 # use the default
 410 #sub calc_cancel {
 411 #  my $self = shift;
 412 #  my($cust_pkg, $sdate, $details, $param ) = @_;
 413 #
 414 #  $self->calc_usage(@_);
 415 #}
 416
 417 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 418
 419 sub calc_usage {
 420   my $self = shift;
 421   my($cust_pkg, $sdate, $details, $param ) = @_;
 422
 423   #my $last_bill = $cust_pkg->last_bill;
 424   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 425
 426   return 0
 427     if $self->recur_temporality eq 'preceding'
 428     && ( $last_bill eq '' || $last_bill == 0 );
 429
 430   my $charges = 0;
 431
 432   my $included_min_total = ($self->option('min_included', 1) || 0)
 433                            * ($cust_pkg->quantity || 1);
 434     #single price rating
 435     #or region group
 436   my $included_min_left = $included_min_total;
 437
 438   my $included_calls = $self->option('calls_included', 1) || 0;
 439   $included_calls *= ($cust_pkg->quantity || 1);
 440
 441   my $cdr_svc_method    = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
 442   my $rating_method     = $self->option('rating_method') || 'prefix';
 443   my %detail_included_min = ();
 444
 445   my $output_format     = $self->option('output_format', 'Hush!')
 446                           || ( $rating_method eq 'upstream_simple'
 447                                  ? 'simple'
 448                                  : 'default'
 449                              );
 450
 451   my $usage_showzero    = $self->option('usage_showzero', 1);
 452
 453   my $formatter = FS::detail_format->new($output_format,
 454     buffer => $details,
 455     locale => $cust_pkg->cust_main->locale,
 456     rounding  => ($self->option_cacheable('rounding') || 2),
 457   );
 458
 459   my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method);
 460
 461   my @cust_svc;
 462   if( $self->option('bill_inactive_svcs',1) ) {
 463     #XXX in this mode do we need to restrict the set of CDRs by date also?
 464     @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
 465   }
 466   else {
 467     @cust_svc = $cust_pkg->cust_svc;
 468   }
 469   @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
 470
 471   foreach my $cust_svc (@cust_svc) {
 472
 473     my $svc_x;
 474     if( $self->option('bill_inactive_svcs',1) ) {
 475       $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
 476     }
 477     else {
 478       $svc_x = $cust_svc->svc_x;
 479     }
 480
 481     unless ( $svc_x ) {
 482       my $h = $self->option('bill_inactive_svcs',1) ? 'h_' : '';
 483       warn "WARNING: no $h$svc_table for svcnum ". $cust_svc->svcnum. "\n";
 484     }
 485
 486     my %options = (
 487         'disable_src'    => $self->option('disable_src',1),
 488         'default_prefix' => $self->option('default_prefix',1),
 489         'cdrtypenum'     => $self->option('use_cdrtypenum',1),
 490         'calltypenum'    => $self->option('use_calltypenum',1),
 491         'status'         => '',
 492         'for_update'     => 1,
 493     );
 494     if ( $self->option('bill_only_pkg_dates') ) {
 495       $options{'begin'} = $last_bill;
 496       $options{'end'}   = $$sdate;
 497     }
 498     if ( $svc_field eq 'svcnum' ) {
 499       $options{'by_svcnum'} = 1;
 500     } elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
 501       $options{'by_ip_addr'} = $by_ip_addr;
 502     }
 503
 504     #my @invoice_details_sort;
 505
 506     # for tagging invoice details
 507     # (unfortunate; should be a svc_x class method or table_info item or
 508     # something)
 509     my $phonenum;
 510     if ( $svc_table eq 'svc_phone' ) {
 511       $phonenum = $svc_x->phonenum;
 512     } elsif ( $svc_table eq 'svc_pbx' ) {
 513       $phonenum = $svc_x->title;
 514     } elsif ( $svc_table eq 'svc_acct' ) {
 515       $phonenum = $svc_x->username;
 516     }
 517     $formatter->phonenum($phonenum);
 518
 519     #first rate any outstanding CDRs not yet rated
 520     # use FS::Cursor for this starting in 4.x
 521     my $cdr_search = $svc_x->psearch_cdrs(%options);
 522     $cdr_search->limit(1000);
 523     $cdr_search->increment(0); # because we're changing their status as we go
 524     while ( my $cdr = $cdr_search->fetch ) {
 525
 526       my $error = $cdr->rate(
 527         'part_pkg'                          => $self,
 528         'cust_pkg'                          => $cust_pkg,
 529         'svcnum'                            => $svc_x->svcnum,
 530         'plan_included_min'                 => \$included_min_left,
 531         'detail_included_min_hashref'       => \%detail_included_min,
 532       );
 533       die $error if $error; #??
 534
 535       $cdr_search->adjust(1) if $cdr->freesidestatus eq '';
 536       # it was skipped without changing status, so increment the
 537       # offset so that we don't re-fetch it on refill
 538
 539     } # $cdr
 540
 541     #then add details to invoices & get a total
 542     $options{'status'} = 'rated';
 543
 544     $cdr_search = $svc_x->psearch_cdrs(%options);
 545     $cdr_search->limit(1000);
 546     $cdr_search->increment(0);
 547     while ( my $cdr = $cdr_search->fetch ) {
 548       my $error;
 549       # at this point we officially Do Not Care about the rating method
 550       if ( $included_calls > 0 ) {
 551         $included_calls--;
 552         #$charges += 0, obviously
 553         #but don't set the rated price to zero--there should be a record
 554         $error = $cdr->set_status('no-charge');
 555       }
 556       else {
 557         $charges += $cdr->rated_price;
 558         $error = $cdr->set_status('done');
 559       }
 560       die $error if $error;
 561       $formatter->append($cdr)
 562         unless $cdr->rated_price == 0 and not $usage_showzero;
 563
 564       $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
 565     } #$cdr
 566   }
 567
 568   $formatter->finish; #writes into $details
 569   unshift @$details, $formatter->header if @$details;
 570
 571   if ( $included_min_total > 0 ) {
 572
 573     my $min_detail = sprintf('%d / %d ',
 574                        $included_min_total - $included_min_left,
 575                        $included_min_total
 576                      ) .  $cust_pkg->mt('included minutes used');
 577     unshift @$details, $min_detail;
 578   }
 579
 580   $charges;
 581 }
 582
 583 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
 584 # lots of false laziness w/voip_inbound
 585 sub check_chargable {
 586   my( $self, $cdr, %flags ) = @_;
 587
 588   return 'amaflags != 2'
 589     if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
 590
 591   return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
 592     if $self->option_cacheable('disposition_in') =~ /\S/
 593     && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
 594
 595   my $disposition_prefix = $self->option_cacheable('disposition_prefix');
 596   my $len_dis_prefix = length($disposition_prefix);
 597   return "disposition does not start with $disposition_prefix"
 598     if $len_dis_prefix
 599     && substr($cdr->disposition, 0, $len_dis_prefix) ne $disposition_prefix;
 600
 601   return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
 602     if $self->option_cacheable('ignore_disposition') =~ /\S/
 603     && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
 604
 605   foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
 606     return "dst starts with '$_'"
 607     if length($_) && substr($cdr->dst,0,length($_)) eq $_;
 608   }
 609
 610   return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )"
 611     if $self->option_cacheable('use_carrierid') =~ /\S/
 612     && ! $flags{'da_rewrote'} #why?
 613     && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches ''
 614
 615   # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
 616   return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum')
 617     if length($self->option_cacheable('use_cdrtypenum'))
 618     && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
 619
 620   return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum')
 621     if length($self->option_cacheable('ignore_cdrtypenum'))
 622     && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
 623
 624   # unlike everything else, use_calltypenum is applied in FS::svc_x::get_cdrs.
 625   return "calltypenum != ". $self->option_cacheable('use_calltypenum')
 626     if length($self->option_cacheable('use_calltypenum'))
 627     && $cdr->calltypenum ne $self->option_cacheable('use_calltypenum'); #ne otherwise 0 matches ''
 628
 629   return "calltypenum == ". $self->option_cacheable('ignore_calltypenum')
 630     if length($self->option_cacheable('ignore_calltypenum'))
 631     && $cdr->calltypenum eq $self->option_cacheable('ignore_calltypenum'); #eq otherwise 0 matches ''
 632
 633   return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )"
 634     if $self->option_cacheable('skip_dcontext') =~ /\S/
 635     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'))
 636     && ! (    $self->option_cacheable('noskip_dcontext_tollfree')
 637            && $cdr->is_tollfree
 638          );
 639
 640   my $len_dcontext_prefix =
 641     length($self->option_cacheable('skip_dcontext_prefix'));
 642   return "dcontext starts with ". $self->option_cacheable('skip_dcontext_prefix')
 643     if $len_dcontext_prefix
 644     && substr($cdr->dcontext,0,$len_dcontext_prefix) eq $self->option_cacheable('skip_dcontext_prefix');
 645
 646   my $len_suffix = length($self->option_cacheable('skip_dcontext_suffix'));
 647   return "dcontext ends with ". $self->option_cacheable('skip_dcontext_suffix')
 648     if $len_suffix
 649     && substr($cdr->dcontext,-$len_suffix,$len_suffix) eq $self->option_cacheable('skip_dcontext_suffix');
 650
 651   my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
 652   return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
 653     if $len_prefix
 654     && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
 655
 656   my $dst_length = $self->option_cacheable('skip_dst_length_less');
 657   return "destination less than $dst_length digits"
 658     if $dst_length && length($cdr->dst) < $dst_length
 659     && ! (    $self->option_cacheable('noskip_dst_length_n11')
 660            && $cdr->dst =~ /^\d11$/
 661          )
 662     && ! (    $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
 663            && $cdr->is_tollfree('accountcode')
 664          );
 665
 666   return "lastapp is ". $self->option_cacheable('skip_lastapp')
 667     if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
 668
 669   my $src_length = $self->option_cacheable('skip_src_length_more');
 670   if ( $src_length ) {
 671
 672     if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
 673
 674       if ( $cdr->is_tollfree('accountcode') ) {
 675         return "source less than or equal to $src_length digits"
 676           if length($cdr->src) <= $src_length;
 677       } else {
 678         return "source more than $src_length digits"
 679           if length($cdr->src) > $src_length;
 680       }
 681
 682     } else {
 683       return "source more than $src_length digits"
 684         if length($cdr->src) > $src_length;
 685     }
 686
 687   }
 688
 689   return "max_callers <= ". $self->option_cacheable('skip_max_callers')
 690     if length($self->option_cacheable('skip_max_callers'))
 691       and length($cdr->max_callers)
 692       and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
 693
 694   return "calldate < ". $self->option_cacheable('skip_old')
 695     if length($self->option_cacheable('skip_old'))
 696     && $cdr->calldate_unix < str2time($self->option_cacheable('skip_old'));
 697
 698   #all right then, rate it
 699   '';
 700 }
 701
 702 sub is_free {
 703   0;
 704 }
 705
 706 sub reset_usage {
 707   my ($self, $cust_pkg, %opt) = @_;
 708   my @part_pkg_usage = $self->part_pkg_usage or return '';
 709   warn "  resetting usage minutes\n" if $opt{debug};
 710   my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage;
 711   foreach my $part_pkg_usage (@part_pkg_usage) {
 712     my $part = $part_pkg_usage->pkgusagepart;
 713     my $usage = $cust_pkg_usage{$part} ||
 714                 FS::cust_pkg_usage->new({
 715                     'pkgnum'        => $cust_pkg->pkgnum,
 716                     'pkgusagepart'  => $part,
 717                     'minutes'       => $part_pkg_usage->minutes *
 718                                         ($cust_pkg->quantity || 1),
 719                 });
 720     foreach my $cdr_usage (
 721       qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
 722     ) {
 723       my $error = $cdr_usage->delete;
 724       warn "  error resetting CDR usage: $error\n";
 725     }
 726
 727     if ( $usage->pkgusagenum ) {
 728       if ( $part_pkg_usage->rollover ) {
 729         $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes);
 730       } else {
 731         $usage->set('minutes', $part_pkg_usage->minutes);
 732       }
 733       my $error = $usage->replace;
 734       warn "  error resetting usage minutes: $error\n" if $error;
 735     } else {
 736       my $error = $usage->insert;
 737       warn "  error resetting usage minutes: $error\n" if $error;
 738     }
 739   } #foreach $part_pkg_usage
 740 }
 741
 742 # tells whether cust_bill_pkg_detail should return a single line for
 743 # each phonenum
 744 # i think this is currently unused?
 745 sub sum_usage {
 746   my $self = shift;
 747   $self->option('output_format') =~ /^sum_/;
 748 }
 749
 750 # and whether cust_bill should show a detail line for the service label
 751 # (separate from usage details)
 752 sub hide_svc_detail {
 753   my $self = shift;
 754   $self->option('output_format') =~ /^sum_/;
 755 }
 756
 757
 758 1;