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