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