FS/FS/part_pkg/voip_cdr.pm

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