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.',
  30   'single_price' => 'A single price per minute for all 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,
 170                           'js_validate' => 'digits',
 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,
 175                              'js_validate' => 'digits',
 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     'skip_dcontext_prefix' => { 'name' => 'Do not charge for CDRs where dcontext starts with: ',
 200                        },
 201
 202     'skip_dcontext_suffix' => { 'name' => 'Do not charge for CDRs where dcontext ends with: ',
 203                        },
 204
 205     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
 206                                 },
 207
 208     'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
 209                               },
 210
 211     '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',
 212                                                   'type' => 'checkbox',
 213                                                 },
 214
 215     'accountcode_tollfree_ratenum' => {
 216       'name' => 'Optional alternate rate plan when accountcode is toll free: ',
 217       'type' => 'select',
 218       'select_table'  => 'rate',
 219       'select_key'    => 'ratenum',
 220       'select_label'  => 'ratename',
 221       'disable_empty' => 0,
 222       'empty_label'   => '',
 223     },
 224
 225     'accountcode_tollfree_field' => {
 226       'name'           => 'When using an alternate rate plan for toll-free accountcodes, the CDR field to use in rating calculations',
 227       'type'           => 'select',
 228       'select_options' => \%accountcode_tollfree_field,
 229     },
 230
 231     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
 232                               },
 233
 234     'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
 235                                                   'type' => 'checkbox',
 236                                                 },
 237
 238     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
 239                       },
 240
 241     'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
 242                           },
 243
 244     'skip_same_customer' => {
 245       'name' => 'Do not charge for calls between numbers belonging to the same customer',
 246       'type' => 'checkbox',
 247     },
 248
 249     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
 250                           'type' => 'checkbox',
 251                         },
 252
 253     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
 254                       },
 255
 256     #false laziness w/cdr_termination.pm
 257     'output_format' => { 'name' => 'CDR display format for invoices',
 258                          'type' => 'select',
 259                          'select_options' => \%detail_formats,
 260                          'default'        => 'default', #XXX test
 261                        },
 262
 263     'selfservice_format' =>
 264       { 'name' => 'CDR display format for selfservice',
 265         'type' => 'select',
 266         'select_options' => \%detail_formats,
 267         'default' => 'default'
 268       },
 269     'selfservice_inbound_format' =>
 270       { 'name' => 'Inbound CDR display format for selfservice',
 271         'type' => 'select',
 272         'select_options' => \%detail_formats,
 273         'default' => ''
 274       },
 275
 276     'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
 277                        },
 278
 279     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 280                           'type' => 'checkbox',
 281                         },
 282
 283     'usage_mandate' => { 'name' => 'Always put usage details in separate section.  The section is defined in the next option.',
 284                           'type' => 'checkbox',
 285                        },
 286     #eofalse
 287
 288     'usage_showzero' => { 'name' => 'Show details for included / no-charge calls.',
 289                         'type' => 'checkbox',
 290                       },
 291
 292     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment).  Useful for prepaid.',
 293                            'type' => 'checkbox',
 294                          },
 295
 296     'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
 297                               'type' => 'checkbox',
 298                             },
 299     'bill_only_pkg_dates' => { 'name' => 'Only bill CDRs with a date during the package billing period',
 300                                'type' => 'checkbox',
 301                              },
 302     'skip_old' => { 'name' => 'Do not charge for CDRs older than: ',
 303                     'type' => 'date',
 304                   },
 305
 306     #XXX also have option for an external db?  these days we suck them into ours
 307 #    'cdr_location' => { 'name' => 'CDR database location'
 308 #                        'type' => 'select',
 309 #                        'select_options' => \%cdr_location,
 310 #                        'select_callback' => {
 311 #                          'external' => {
 312 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 313 #                          },
 314 #                          'internal' => {
 315 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 316 #                          }
 317 #                        },
 318 #                      },
 319 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 320 #                   'disabled' => 'Y',
 321 #                 },
 322 #    'username' => { 'name' => 'External database username',
 323 #                    'disabled' => 'Y',
 324 #                  },
 325 #    'password' => { 'name' => 'External database password',
 326 #                    'disabled' => 'Y',
 327 #                  },
 328
 329   },
 330   'fieldorder' => [qw(
 331                        recur_temporality
 332                        recur_method cutoff_day ),
 333                        FS::part_pkg::prorate_Mixin::fieldorder,
 334                     qw(
 335                        cdr_svc_method
 336                        rating_method rounding ratenum intrastate_ratenum
 337                        calls_included
 338                        min_charge min_included
 339                        sec_granularity
 340                        ignore_unrateable
 341                        default_prefix
 342                        disable_src
 343                        domestic_prefix international_prefix
 344                        disable_tollfree
 345                        use_amaflags
 346                        use_carrierid
 347                        use_cdrtypenum ignore_cdrtypenum
 348                        use_calltypenum ignore_calltypenum
 349                        ignore_disposition disposition_in disposition_prefix
 350                        skip_dcontext skip_dcontext_prefix skip_dcontext_suffix
 351                        skip_dst_prefix
 352                        skip_dstchannel_prefix skip_src_length_more
 353                        noskip_src_length_accountcode_tollfree
 354                        accountcode_tollfree_ratenum accountcode_tollfree_field
 355                        skip_dst_length_less
 356                        noskip_dst_length_accountcode_tollfree
 357                        skip_lastapp
 358                        skip_max_callers
 359                        skip_same_customer
 360                        use_duration
 361                        411_rewrite
 362                        output_format
 363                        selfservice_format selfservice_inbound_format
 364                        usage_mandate usage_section summarize_usage
 365                        usage_showzero bill_every_call bill_inactive_svcs
 366                        bill_only_pkg_dates skip_old
 367                        suspend_bill
 368                      )
 369                   ],
 370   'weight' => 41,
 371   'validate' => sub {
 372     # Validation function for FS::part_pkg::check_options()
 373     my $options = shift;
 374     return "Please choose a Rate Plan for use with selected Rating Method"
 375       if $options->{rating_method} eq 'prefix' &&  !$options->{ratenum};
 376     return;
 377   },
 378 );
 379
 380 sub price_info {
 381     my $self = shift;
 382     my $str = $self->SUPER::price_info(@_);
 383     $str .= " plus usage" if $str;
 384     $str;
 385 }
 386
 387 sub calc_recur {
 388   my $self = shift;
 389   my($cust_pkg, $sdate, $details, $param ) = @_;
 390
 391   my $charges = 0;
 392
 393   $charges += $self->calc_usage(@_);
 394   $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_);
 395
 396   $charges;
 397
 398 }
 399
 400 # use the default
 401 #sub calc_cancel {
 402 #  my $self = shift;
 403 #  my($cust_pkg, $sdate, $details, $param ) = @_;
 404 #
 405 #  $self->calc_usage(@_);
 406 #}
 407
 408 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 409
 410 sub calc_usage {
 411   my $self = shift;
 412   my($cust_pkg, $sdate, $details, $param ) = @_;
 413
 414   #my $last_bill = $cust_pkg->last_bill;
 415   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 416
 417   return 0
 418     if $self->recur_temporality eq 'preceding'
 419     && ( $last_bill eq '' || $last_bill == 0 );
 420
 421   my $charges = 0;
 422
 423   my $included_min_total = ($self->option('min_included', 1) || 0)
 424                            * ($cust_pkg->quantity || 1);
 425     #single price rating
 426     #or region group
 427   my $included_min_left = $included_min_total;
 428
 429   my $included_calls = $self->option('calls_included', 1) || 0;
 430   $included_calls *= ($cust_pkg->quantity || 1);
 431
 432   my $cdr_svc_method    = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
 433   my $rating_method     = $self->option('rating_method') || 'prefix';
 434   my %detail_included_min = ();
 435
 436   my $output_format     = $self->option('output_format', 'Hush!')
 437                           || ( $rating_method eq 'upstream_simple'
 438                                  ? 'simple'
 439                                  : 'default'
 440                              );
 441
 442   my $usage_showzero    = $self->option('usage_showzero', 1);
 443
 444   my $formatter = FS::detail_format->new($output_format,
 445     buffer => $details,
 446     locale => $cust_pkg->cust_main->locale,
 447     rounding  => ($self->option_cacheable('rounding') || 2),
 448   );
 449
 450   my $use_duration = $self->option('use_duration');
 451
 452   my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method);
 453
 454   my @cust_svc;
 455   if( $self->option('bill_inactive_svcs',1) ) {
 456     #XXX in this mode do we need to restrict the set of CDRs by date also?
 457     @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
 458   }
 459   else {
 460     @cust_svc = $cust_pkg->cust_svc;
 461   }
 462   @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
 463
 464   foreach my $cust_svc (@cust_svc) {
 465
 466     my $svc_x;
 467     if( $self->option('bill_inactive_svcs',1) ) {
 468       $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
 469     }
 470     else {
 471       $svc_x = $cust_svc->svc_x;
 472     }
 473
 474     unless ( $svc_x ) {
 475       my $h = $self->option('bill_inactive_svcs',1) ? 'h_' : '';
 476       warn "WARNING: no $h$svc_table for svcnum ". $cust_svc->svcnum. "\n";
 477     }
 478
 479     my %options = (
 480         'disable_src'    => $self->option('disable_src',1),
 481         'default_prefix' => $self->option('default_prefix',1),
 482         'cdrtypenum'     => $self->option('use_cdrtypenum',1),
 483         'calltypenum'    => $self->option('use_calltypenum',1),
 484         'status'         => '',
 485         'for_update'     => 1,
 486     );
 487     if ( $self->option('bill_only_pkg_dates') ) {
 488       $options{'begin'} = $last_bill;
 489       $options{'end'}   = $$sdate;
 490     }
 491     if ( $svc_field eq 'svcnum' ) {
 492       $options{'by_svcnum'} = 1;
 493     } elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
 494       $options{'by_ip_addr'} = $by_ip_addr;
 495     }
 496
 497     #my @invoice_details_sort;
 498
 499     # for tagging invoice details
 500     # (unfortunate; should be a svc_x class method or table_info item or
 501     # something)
 502     my $phonenum;
 503     if ( $svc_table eq 'svc_phone' ) {
 504       $phonenum = $svc_x->phonenum;
 505     } elsif ( $svc_table eq 'svc_pbx' ) {
 506       $phonenum = $svc_x->title;
 507     } elsif ( $svc_table eq 'svc_acct' ) {
 508       $phonenum = $svc_x->username;
 509     }
 510     $formatter->phonenum($phonenum);
 511
 512     #first rate any outstanding CDRs not yet rated
 513     # use FS::Cursor for this starting in 4.x
 514     my $cdr_search = $svc_x->psearch_cdrs(%options);
 515     $cdr_search->limit(1000);
 516     $cdr_search->increment(0); # because we're changing their status as we go
 517     while ( my $cdr = $cdr_search->fetch ) {
 518
 519       my $error = $cdr->rate(
 520         'part_pkg'                          => $self,
 521         'cust_pkg'                          => $cust_pkg,
 522         'svcnum'                            => $svc_x->svcnum,
 523         'plan_included_min'                 => \$included_min_left,
 524         'detail_included_min_hashref'       => \%detail_included_min,
 525       );
 526       die $error if $error; #??
 527
 528       $cdr_search->adjust(1) if $cdr->freesidestatus eq '';
 529       # it was skipped without changing status, so increment the
 530       # offset so that we don't re-fetch it on refill
 531
 532     } # $cdr
 533
 534     #then add details to invoices & get a total
 535     $options{'status'} = 'rated';
 536
 537     $cdr_search = $svc_x->psearch_cdrs(%options);
 538     $cdr_search->limit(1000);
 539     $cdr_search->increment(0);
 540     while ( my $cdr = $cdr_search->fetch ) {
 541       my $error;
 542       # at this point we officially Do Not Care about the rating method
 543       if ( $included_calls > 0 ) {
 544         $included_calls--;
 545         #$charges += 0, obviously
 546         #but don't set the rated price to zero--there should be a record
 547         $error = $cdr->set_status('no-charge');
 548       }
 549       else {
 550         $charges += $cdr->rated_price;
 551         $error = $cdr->set_status('done');
 552       }
 553       die $error if $error;
 554       $formatter->append($cdr)
 555         unless $cdr->rated_price == 0 and not $usage_showzero;
 556
 557       $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
 558     } #$cdr
 559   }
 560
 561   $formatter->finish; #writes into $details
 562   unshift @$details, $formatter->header if @$details;
 563
 564   if ( $included_min_total > 0 ) {
 565
 566     my $min_detail = sprintf('%d / %d ',
 567                        $included_min_total - $included_min_left,
 568                        $included_min_total
 569                      ) .  $cust_pkg->mt('included minutes used');
 570     unshift @$details, $min_detail;
 571   }
 572
 573   $charges;
 574 }
 575
 576 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
 577 # lots of false laziness w/voip_inbound
 578 sub check_chargable {
 579   my( $self, $cdr, %flags ) = @_;
 580
 581   return 'amaflags != 2'
 582     if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
 583
 584   return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
 585     if $self->option_cacheable('disposition_in') =~ /\S/
 586     && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
 587
 588   my $disposition_prefix = $self->option_cacheable('disposition_prefix');
 589   my $len_dis_prefix = length($disposition_prefix);
 590   return "disposition does not start with $disposition_prefix"
 591     if $len_dis_prefix
 592     && substr($cdr->disposition, 0, $len_dis_prefix) ne $disposition_prefix;
 593
 594   return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
 595     if $self->option_cacheable('ignore_disposition') =~ /\S/
 596     && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
 597
 598   foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
 599     return "dst starts with '$_'"
 600     if length($_) && substr($cdr->dst,0,length($_)) eq $_;
 601   }
 602
 603   return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )"
 604     if $self->option_cacheable('use_carrierid') =~ /\S/
 605     && ! $flags{'da_rewrote'} #why?
 606     && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches ''
 607
 608   # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
 609   return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum')
 610     if length($self->option_cacheable('use_cdrtypenum'))
 611     && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
 612
 613   return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum')
 614     if length($self->option_cacheable('ignore_cdrtypenum'))
 615     && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
 616
 617   # unlike everything else, use_calltypenum is applied in FS::svc_x::get_cdrs.
 618   return "calltypenum != ". $self->option_cacheable('use_calltypenum')
 619     if length($self->option_cacheable('use_calltypenum'))
 620     && $cdr->calltypenum ne $self->option_cacheable('use_calltypenum'); #ne otherwise 0 matches ''
 621
 622   return "calltypenum == ". $self->option_cacheable('ignore_calltypenum')
 623     if length($self->option_cacheable('ignore_calltypenum'))
 624     && $cdr->calltypenum eq $self->option_cacheable('ignore_calltypenum'); #eq otherwise 0 matches ''
 625
 626   return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )"
 627     if $self->option_cacheable('skip_dcontext') =~ /\S/
 628     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
 629
 630   my $len_dcontext_prefix =
 631     length($self->option_cacheable('skip_dcontext_prefix'));
 632   return "dcontext starts with ". $self->option_cacheable('skip_dcontext_prefix')
 633     if $len_dcontext_prefix
 634     && substr($cdr->dcontext,0,$len_dcontext_prefix) eq $self->option_cacheable('skip_dcontext_prefix');
 635
 636   my $len_suffix = length($self->option_cacheable('skip_dcontext_suffix'));
 637   return "dcontext ends with ". $self->option_cacheable('skip_dcontext_suffix')
 638     if $len_suffix
 639     && substr($cdr->dcontext,-$len_suffix,$len_suffix) eq $self->option_cacheable('skip_dcontext_suffix');
 640
 641   my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
 642   return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
 643     if $len_prefix
 644     && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
 645
 646   my $dst_length = $self->option_cacheable('skip_dst_length_less');
 647   return "destination less than $dst_length digits"
 648     if $dst_length && length($cdr->dst) < $dst_length
 649     && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
 650             && $cdr->is_tollfree('accountcode')
 651          );
 652
 653   return "lastapp is ". $self->option_cacheable('skip_lastapp')
 654     if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
 655
 656   my $src_length = $self->option_cacheable('skip_src_length_more');
 657   if ( $src_length ) {
 658
 659     if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
 660
 661       if ( $cdr->is_tollfree('accountcode') ) {
 662         return "source less than or equal to $src_length digits"
 663           if length($cdr->src) <= $src_length;
 664       } else {
 665         return "source more than $src_length digits"
 666           if length($cdr->src) > $src_length;
 667       }
 668
 669     } else {
 670       return "source more than $src_length digits"
 671         if length($cdr->src) > $src_length;
 672     }
 673
 674   }
 675
 676   return "max_callers <= ". $self->option_cacheable('skip_max_callers')
 677     if length($self->option_cacheable('skip_max_callers'))
 678       and length($cdr->max_callers)
 679       and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
 680
 681   return "calldate < ". $self->option_cacheable('skip_old')
 682     if $self->option_cacheable('skip_old')
 683     && $cdr->calldate_unix < str2time($self->option_cacheable('skip_old'));
 684
 685   #all right then, rate it
 686   '';
 687 }
 688
 689 sub is_free {
 690   0;
 691 }
 692
 693 sub reset_usage {
 694   my ($self, $cust_pkg, %opt) = @_;
 695   my @part_pkg_usage = $self->part_pkg_usage or return '';
 696   warn "  resetting usage minutes\n" if $opt{debug};
 697   my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage;
 698   foreach my $part_pkg_usage (@part_pkg_usage) {
 699     my $part = $part_pkg_usage->pkgusagepart;
 700     my $usage = $cust_pkg_usage{$part} ||
 701                 FS::cust_pkg_usage->new({
 702                     'pkgnum'        => $cust_pkg->pkgnum,
 703                     'pkgusagepart'  => $part,
 704                     'minutes'       => $part_pkg_usage->minutes *
 705                                         ($cust_pkg->quantity || 1),
 706                 });
 707     foreach my $cdr_usage (
 708       qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
 709     ) {
 710       my $error = $cdr_usage->delete;
 711       warn "  error resetting CDR usage: $error\n";
 712     }
 713
 714     if ( $usage->pkgusagenum ) {
 715       if ( $part_pkg_usage->rollover ) {
 716         $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes);
 717       } else {
 718         $usage->set('minutes', $part_pkg_usage->minutes);
 719       }
 720       my $error = $usage->replace;
 721       warn "  error resetting usage minutes: $error\n" if $error;
 722     } else {
 723       my $error = $usage->insert;
 724       warn "  error resetting usage minutes: $error\n" if $error;
 725     }
 726   } #foreach $part_pkg_usage
 727 }
 728
 729 # tells whether cust_bill_pkg_detail should return a single line for
 730 # each phonenum
 731 # i think this is currently unused?
 732 sub sum_usage {
 733   my $self = shift;
 734   $self->option('output_format') =~ /^sum_/;
 735 }
 736
 737 # and whether cust_bill should show a detail line for the service label
 738 # (separate from usage details)
 739 sub hide_svc_detail {
 740   my $self = shift;
 741   $self->option('output_format') =~ /^sum_/;
 742 }
 743
 744
 745 1;