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