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