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