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