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