FS/FS/part_pkg/voip_cdr.pm

   1 package FS::part_pkg::voip_cdr;
   2
   3 use strict;
   4 use vars qw(@ISA $DEBUG %info);
   5 use Date::Format;
   6 use Tie::IxHash;
   7 use FS::Conf;
   8 use FS::Record qw(qsearchs qsearch);
   9 use FS::part_pkg::flat;
  10 use FS::cdr;
  11 use FS::rate;
  12 use FS::rate_prefix;
  13 use FS::rate_detail;
  14
  15 @ISA = qw(FS::part_pkg::flat);
  16
  17 $DEBUG = 1;
  18
  19 tie my %rating_method, 'Tie::IxHash',
  20   'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
  21   '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.',
  22   'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
  23 ;
  24
  25 #tie my %cdr_location, 'Tie::IxHash',
  26 #  'internal' => 'Internal: CDR records imported into the internal CDR table',
  27 #  'external' => 'External: CDR records queried directly from an external '.
  28 #                'Asterisk (or other?) CDR table',
  29 #;
  30
  31 tie my %temporalities, 'Tie::IxHash',
  32   'upcoming'  => "Upcoming (future)",
  33   'preceding' => "Preceding (past)",
  34 ;
  35
  36 %info = (
  37   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
  38   'shortname' => 'VoIP/telco CDR rating (standard)',
  39   'fields' => {
  40     'setup_fee'     => { 'name' => 'Setup fee for this package',
  41                          'default' => 0,
  42                        },
  43     'recur_fee'     => { 'name' => 'Base recurring fee for this package',
  44                          'default' => 0,
  45                        },
  46
  47     #false laziness w/flat.pm
  48     'recur_temporality' => { 'name' => 'Charge recurring fee for period',
  49                              'type' => 'select',
  50                              'select_options' => \%temporalities,
  51                            },
  52
  53     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
  54                                    ' of service at cancellation',
  55                          'type' => 'checkbox',
  56                        },
  57     'ratenum'   => { 'name' => 'Rate plan',
  58                      'type' => 'select',
  59                      'select_table' => 'rate',
  60                      'select_key'   => 'ratenum',
  61                      'select_label' => 'ratename',
  62                    },
  63     'rating_method' => { 'name' => 'Region rating method',
  64                          'type' => 'radio',
  65                          'options' => \%rating_method,
  66                        },
  67
  68     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
  69                           'default' => '+1',
  70                         },
  71
  72     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
  73                        'type' => 'checkbox'
  74                      },
  75
  76     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
  77                            'default' => '1',
  78                          },
  79
  80 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
  81 #                                    'type' => 'checkbox',
  82 #                                  },
  83
  84     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
  85                                 'default' => '011',
  86                               },
  87
  88     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
  89                             'type' => 'checkbox',
  90                           },
  91
  92     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
  93                         'type' => 'checkbox',
  94                       },
  95
  96     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
  97                            'type' => 'checkbox',
  98                          },
  99
 100     'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
 101                                  'type' => 'checkbox',
 102                                },
 103
 104     'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
 105                          },
 106
 107     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
 108                          },
 109
 110     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
 111                           'type' => 'checkbox',
 112                         },
 113
 114     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes: ',
 115                       },
 116
 117     'output_format' => { 'name' => 'Simple output format',
 118                          'type' => 'select',
 119                          'select_options' => { FS::cdr::invoice_formats() },
 120                        },
 121
 122     'usage_section' => { 'name' => 'Section in which to place separate usage charges',
 123                        },
 124
 125     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 126                           'type' => 'checkbox',
 127                         },
 128
 129     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call.  Useful for prepaid.',
 130                            'type' => 'checkbox',
 131                          },
 132
 133     #XXX also have option for an external db
 134 #    'cdr_location' => { 'name' => 'CDR database location'
 135 #                        'type' => 'select',
 136 #                        'select_options' => \%cdr_location,
 137 #                        'select_callback' => {
 138 #                          'external' => {
 139 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 140 #                          },
 141 #                          'internal' => {
 142 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 143 #                          }
 144 #                        },
 145 #                      },
 146 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 147 #                   'disabled' => 'Y',
 148 #                 },
 149 #    'username' => { 'name' => 'External database username',
 150 #                    'disabled' => 'Y',
 151 #                  },
 152 #    'password' => { 'name' => 'External database password',
 153 #                    'disabled' => 'Y',
 154 #                  },
 155
 156   },
 157   'fieldorder' => [qw(
 158                        setup_fee recur_fee recur_temporality unused_credit
 159                        rating_method ratenum
 160                        default_prefix
 161                        disable_src
 162                        domestic_prefix international_prefix
 163                        disable_tollfree
 164                        use_amaflags use_disposition
 165                        use_disposition_taqua use_carrierid use_cdrtypenum
 166                        use_duration
 167                        411_rewrite
 168                        output_format summarize_usage usage_section
 169                        bill_every_call
 170                      )
 171                   ],
 172   'weight' => 40,
 173 );
 174
 175 sub calc_setup {
 176   my($self, $cust_pkg ) = @_;
 177   $self->option('setup_fee');
 178 }
 179
 180 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 181 sub calc_recur {
 182   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
 183
 184   #my $last_bill = $cust_pkg->last_bill;
 185   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 186
 187   return 0
 188     if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
 189
 190   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 191
 192   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
 193
 194   my %included_min = ();
 195
 196   my $charges = 0;
 197
 198   my $downstream_cdr = '';
 199
 200   my $output_format = $self->option('output_format', 'Hush!')
 201                       || 'simple';
 202
 203   eval "use Text::CSV_XS;";
 204   die $@ if $@;
 205   my $csv = new Text::CSV_XS;
 206
 207   foreach my $cust_svc (
 208     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
 209   ) {
 210
 211     foreach my $cdr (
 212       $cust_svc->get_cdrs_for_update( 'disable_src'    => $self->option('disable_src'),
 213                                       'default_prefix' => $self->option('default_prefix'),
 214                                     )  # $last_bill, $$sdate )
 215     ) {
 216       if ( $DEBUG > 1 ) {
 217         warn "rating CDR $cdr\n".
 218              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 219       }
 220
 221       my $rate_detail;
 222       my( $rate_region, $regionnum );
 223       my $pretty_destnum;
 224       my $charge = '';
 225       my $classnum = '';
 226       my @call_details = ();
 227       if ( $self->option('rating_method') eq 'prefix'
 228            || ! $self->option('rating_method')
 229          )
 230       {
 231
 232         #should have some better way of checking these options than a long
 233         #if-else tree...
 234         my $notchg = "not charging for CDR";
 235
 236         if ( $self->option('use_amaflags') && $cdr->amaflags != 2 ) {
 237
 238           warn "$notchg (amaflags != 2)\n" if $DEBUG;
 239           $charge = 0;
 240
 241         } elsif ( $self->option('use_disposition')
 242                   && $cdr->disposition ne 'ANSWERED' ) {
 243
 244           warn "$notchg (disposition != ANSWERED)\n" if $DEBUG;
 245           $charge = 0;
 246
 247         } elsif ( $self->option('use_disposition_taqua')
 248                   && $cdr->disposition != 100 ) {
 249
 250           warn "$notchg (disposition != 100)\n" if $DEBUG;
 251           $charge = 0;
 252
 253         } elsif ( $self->option('use_carrierid')
 254                   && $cdr->carrierid != $self->option('use_carrierid') ) {
 255
 256           warn "$notchg (carrierid != ". $self->option('use_carrierid'). ")\n"
 257             if $DEBUG;
 258           $charge = 0;
 259
 260         } elsif ( $self->option('use_cdrtypenum')
 261                   && $cdr->cdrtypenum != $self->option('use_cdrtypenum') ) {
 262
 263           warn "$notchg (cdrtypenum != ". $self->option('use_cdrtypenum'). ")\n"
 264             if $DEBUG;
 265           $charge = 0;
 266
 267         } else {
 268
 269           ###
 270           # look up rate details based on called station id
 271           # (or calling station id for toll free calls)
 272           ###
 273
 274           if ( $self->option('411_rewrite') ) {
 275             my @dirass = split(/\s*,\s*/, $self->option('411_rewrite'));
 276             $cdr->dst('411') if grep $cdr->dst eq $_, @dirass;
 277           }
 278
 279           my( $to_or_from, $number );
 280           if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
 281                && ! $self->option('disable_tollfree')
 282               )
 283           { #tollfree call
 284             $to_or_from = 'from';
 285             $number = $cdr->src;
 286           } else { #regular call
 287             $to_or_from = 'to';
 288             $number = $cdr->dst;
 289           }
 290
 291           warn "parsing call $to_or_from $number\n" if $DEBUG;
 292
 293           #remove non-phone# stuff and whitespace
 294           $number =~ s/\s//g;
 295 #          my $proto = '';
 296 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
 297 #          my $siphost = '';
 298 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 299
 300           my $intl = $self->option('international_prefix') || '011';
 301
 302           #determine the country code
 303           my $countrycode;
 304           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
 305                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
 306              )
 307           {
 308
 309             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
 310             #first look for 1 digit country code
 311             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
 312               $countrycode = $one;
 313               $number = $u1.$u2.$rest;
 314             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
 315               $countrycode = $two;
 316               $number = $u2.$rest;
 317             } else { #3 digit country code
 318               $countrycode = $three;
 319               $number = $rest;
 320             }
 321
 322           } else {
 323             $countrycode = $self->option('domestic_prefix') || '1';
 324             $number =~ s/^$countrycode//;# if length($number) > 10;
 325           }
 326
 327           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
 328           $pretty_destnum = "+$countrycode $number";
 329
 330           my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
 331             or die "ratenum $ratenum not found!";
 332
 333           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 334                                               'phonenum'    => $number,
 335                                             });
 336
 337           $rate_region = $rate_detail->dest_region;
 338           $regionnum = $rate_region->regionnum;
 339
 340           warn "  found rate for regionnum $regionnum ".
 341                "and rate detail $rate_detail\n"
 342             if $DEBUG;
 343
 344         }
 345
 346       } elsif ( $self->option('rating_method') eq 'upstream' ) {
 347
 348         if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
 349
 350           $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
 351
 352           $regionnum = $rate_detail->dest_regionnum;
 353           $rate_region = $rate_detail->dest_region;
 354
 355           $pretty_destnum = $cdr->dst;
 356
 357           warn "  found rate for regionnum $regionnum and ".
 358                "rate detail $rate_detail\n"
 359             if $DEBUG;
 360
 361         } else { #pass upstream price through
 362
 363           $charge = sprintf('%.2f', $cdr->upstream_price);
 364           $charges += $charge;
 365
 366           @call_details = (
 367             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
 368             time2str("%c", $cdr->calldate_unix),  #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot
 369             'N/A', #minutes...
 370             '$'.$charge,
 371             #$pretty_destnum,
 372             $cdr->description, #$rate_region->regionname,
 373           );
 374
 375         }
 376
 377       } elsif ( $self->option('rating_method') eq 'upstream_simple' ) {
 378
 379         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
 380         $charge = sprintf('%.3f', $cdr->upstream_price);
 381         $charges += $charge;
 382
 383         @call_details = ($cdr->downstream_csv( 'format' => $output_format ));
 384
 385       } else {
 386         die "don't know how to rate CDRs using method: ".
 387             $self->option('rating_method'). "\n";
 388       }
 389
 390       ###
 391       # find the price and add detail to the invoice
 392       ###
 393
 394       # if $rate_detail is not found, skip this CDR... i.e.
 395       # don't add it to invoice, don't set its status to NULL,
 396       # don't call downstream_csv or something on it...
 397       # but DO emit a warning...
 398       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
 399       if ( ! $rate_detail && $charge eq '' ) {
 400
 401         warn "no rate_detail found for CDR.acctid:  ". $cdr->acctid.
 402              "; skipping\n"
 403
 404       } else { # there *is* a rate_detail (or call_details), proceed...
 405
 406         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
 407
 408           $included_min{$regionnum} = $rate_detail->min_included
 409             unless exists $included_min{$regionnum};
 410
 411           my $granularity = $rate_detail->sec_granularity;
 412
 413                       # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
 414           my $seconds = $self->option('use_duration')
 415                           ? $cdr->duration
 416                           : $cdr->billsec;
 417
 418           $seconds += $granularity - ( $seconds % $granularity )
 419             if $seconds      # don't granular-ize 0 billsec calls (bills them)
 420             && $granularity; # 0 is per call
 421           my $minutes = sprintf("%.1f", $seconds / 60);
 422           $minutes =~ s/\.0$// if $granularity == 60;
 423
 424           # per call rather than per minute
 425           $minutes = 1 unless $granularity;
 426
 427           $included_min{$regionnum} -= $minutes;
 428
 429           if ( $included_min{$regionnum} < 0 ) {
 430             my $charge_min = 0 - $included_min{$regionnum};
 431             $included_min{$regionnum} = 0;
 432             $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
 433             $charges += $charge;
 434           }
 435
 436           # this is why we need regionnum/rate_region....
 437           warn "  (rate region $rate_region)\n" if $DEBUG;
 438
 439           @call_details = (
 440             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
 441             time2str("%c", $cdr->calldate_unix),  #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot
 442             $granularity ? $minutes.'m' : $minutes.' call',
 443             '$'.$charge,
 444             $pretty_destnum,
 445             $rate_region->regionname,
 446           );
 447
 448           $classnum = $rate_detail->classnum;
 449
 450         }
 451
 452         if ( $charge > 0 ) {
 453           #just use FS::cust_bill_pkg_detail objects?
 454           my $call_details;
 455           if ( $self->option('rating_method') eq 'upstream_simple' ) {
 456             $call_details = [ 'C', $call_details[0], $charge, $classnum ];
 457           }else{
 458             $csv->combine(@call_details);
 459             $call_details = [ 'C', $csv->string, $charge, $classnum ];
 460           }
 461           warn "  adding details on charge to invoice: [ ".
 462               join(', ', @{$call_details} ). " ]"
 463             if ( $DEBUG && ref($call_details) );
 464           push @$details, $call_details; #\@call_details,
 465         }
 466
 467         # if the customer flag is on, call "downstream_csv" or something
 468         # like it to export the call downstream!
 469         # XXX price plan option to pick format, or something...
 470         $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
 471           if $spool_cdr;
 472
 473         my $error = $cdr->set_status_and_rated_price('done', $charge);
 474         die $error if $error;
 475
 476       }
 477
 478     } # $cdr
 479
 480   } # $cust_svc
 481
 482   unshift @$details, [ 'C', FS::cdr::invoice_header( $output_format) ]
 483     if (@$details && $self->option('rating_method') eq 'upstream_simple' );
 484
 485   if ( $spool_cdr && length($downstream_cdr) ) {
 486
 487     use FS::UID qw(datasrc);
 488     my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 489     mkdir $dir, 0700 unless -d $dir;
 490     $dir .= '/'. $cust_pkg->custnum.
 491     mkdir $dir, 0700 unless -d $dir;
 492     my $filename = time2str("$dir/CDR%Y%m%d-spool.CSV", time); #XXX invoice date instead?  would require changing the order things are generated in cust_main::bill insert cust_bill first - with transactions it could be done though
 493
 494     push @{ $param->{'precommit_hooks'} },
 495          sub {
 496                #lock the downstream spool file and append the records
 497                use Fcntl qw(:flock);
 498                use IO::File;
 499                my $spool = new IO::File ">>$filename"
 500                  or die "can't open $filename: $!\n";
 501                flock( $spool, LOCK_EX)
 502                  or die "can't lock $filename: $!\n";
 503                seek($spool, 0, 2)
 504                  or die "can't seek to end of $filename: $!\n";
 505                print $spool $downstream_cdr;
 506                flock( $spool, LOCK_UN );
 507                close $spool;
 508              };
 509
 510   } #if ( $spool_cdr && length($downstream_cdr) )
 511
 512   $charges += $self->option('recur_fee')
 513     if $param->{'increment_next_bill'};
 514
 515   $charges;
 516 }
 517
 518 sub is_free {
 519   0;
 520 }
 521
 522 sub base_recur {
 523   my($self, $cust_pkg) = @_;
 524   $self->option('recur_fee');
 525 }
 526
 527 #  This equates svc_phone records; perhaps svc_phone should have a field
 528 #  to indicate it represents a line
 529 sub calc_units {
 530   my($self, $cust_pkg ) = @_;
 531   scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 532 }
 533
 534 1;
 535