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