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