FS/FS/part_pkg/voip_cdr.pm

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