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