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