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                          'default'        => 'default', #XXX test
 121                        },
 122
 123     'usage_section' => { 'name' => 'Section in which to place separate usage charges',
 124                        },
 125
 126     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 127                           'type' => 'checkbox',
 128                         },
 129
 130     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call.  Useful for prepaid.',
 131                            'type' => 'checkbox',
 132                          },
 133
 134     #XXX also have option for an external db
 135 #    'cdr_location' => { 'name' => 'CDR database location'
 136 #                        'type' => 'select',
 137 #                        'select_options' => \%cdr_location,
 138 #                        'select_callback' => {
 139 #                          'external' => {
 140 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 141 #                          },
 142 #                          'internal' => {
 143 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 144 #                          }
 145 #                        },
 146 #                      },
 147 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 148 #                   'disabled' => 'Y',
 149 #                 },
 150 #    'username' => { 'name' => 'External database username',
 151 #                    'disabled' => 'Y',
 152 #                  },
 153 #    'password' => { 'name' => 'External database password',
 154 #                    'disabled' => 'Y',
 155 #                  },
 156
 157   },
 158   'fieldorder' => [qw(
 159                        setup_fee recur_fee recur_temporality unused_credit
 160                        rating_method ratenum
 161                        default_prefix
 162                        disable_src
 163                        domestic_prefix international_prefix
 164                        disable_tollfree
 165                        use_amaflags use_disposition
 166                        use_disposition_taqua use_carrierid use_cdrtypenum
 167                        use_duration
 168                        411_rewrite
 169                        output_format summarize_usage usage_section
 170                        bill_every_call
 171                      )
 172                   ],
 173   'weight' => 40,
 174 );
 175
 176 sub calc_setup {
 177   my($self, $cust_pkg ) = @_;
 178   $self->option('setup_fee');
 179 }
 180
 181 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 182 sub calc_recur {
 183   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
 184
 185   #my $last_bill = $cust_pkg->last_bill;
 186   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 187
 188   return 0
 189     if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
 190
 191   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 192
 193   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
 194
 195   my %included_min = ();
 196
 197   my $charges = 0;
 198
 199   my $downstream_cdr = '';
 200
 201   my $rating_method = $self->option('rating_method') || 'prefix';
 202
 203   my $output_format =
 204     $self->option('output_format', 'Hush!')
 205     || ( $rating_method eq 'upstream_simple' ? 'simple' : 'default' );
 206
 207   eval "use Text::CSV_XS;";
 208   die $@ if $@;
 209   my $csv = new Text::CSV_XS;
 210
 211   foreach my $cust_svc (
 212     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
 213   ) {
 214
 215     foreach my $cdr (
 216       $cust_svc->get_cdrs_for_update( 'disable_src'    => $self->option('disable_src'),
 217                                       'default_prefix' => $self->option('default_prefix'),
 218                                     )  # $last_bill, $$sdate )
 219     ) {
 220       if ( $DEBUG > 1 ) {
 221         warn "rating CDR $cdr\n".
 222              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 223       }
 224
 225       my $rate_detail;
 226       my( $rate_region, $regionnum );
 227       my $pretty_destnum;
 228       my $charge = '';
 229       my $classnum = '';
 230       my @call_details = ();
 231       if ( $rating_method eq 'prefix' ) {
 232
 233         #should have some better way of checking these options than a long
 234         #if-else tree...
 235         my $notchg = "not charging for CDR";
 236
 237         if ( $self->option('use_amaflags') && $cdr->amaflags != 2 ) {
 238
 239           warn "$notchg (amaflags != 2)\n" if $DEBUG;
 240           $charge = 0;
 241
 242         } elsif ( $self->option('use_disposition')
 243                   && $cdr->disposition ne 'ANSWERED' ) {
 244
 245           warn "$notchg (disposition != ANSWERED)\n" if $DEBUG;
 246           $charge = 0;
 247
 248         } elsif ( $self->option('use_disposition_taqua')
 249                   && $cdr->disposition != 100 ) {
 250
 251           warn "$notchg (disposition != 100)\n" if $DEBUG;
 252           $charge = 0;
 253
 254         } elsif ( $self->option('use_carrierid')
 255                   && $cdr->carrierid != $self->option('use_carrierid') ) {
 256
 257           warn "$notchg (carrierid != ". $self->option('use_carrierid'). ")\n"
 258             if $DEBUG;
 259           $charge = 0;
 260
 261         } elsif ( $self->option('use_cdrtypenum')
 262                   && $cdr->cdrtypenum != $self->option('use_cdrtypenum') ) {
 263
 264           warn "$notchg (cdrtypenum != ". $self->option('use_cdrtypenum'). ")\n"
 265             if $DEBUG;
 266           $charge = 0;
 267
 268         } else {
 269
 270           ###
 271           # look up rate details based on called station id
 272           # (or calling station id for toll free calls)
 273           ###
 274
 275           if ( $self->option('411_rewrite') ) {
 276             my @dirass = split(/\s*,\s*/, $self->option('411_rewrite'));
 277             $cdr->dst('411') if grep $cdr->dst eq $_, @dirass;
 278           }
 279
 280           my( $to_or_from, $number );
 281           if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
 282                && ! $self->option('disable_tollfree')
 283               )
 284           { #tollfree call
 285             $to_or_from = 'from';
 286             $number = $cdr->src;
 287           } else { #regular call
 288             $to_or_from = 'to';
 289             $number = $cdr->dst;
 290           }
 291
 292           warn "parsing call $to_or_from $number\n" if $DEBUG;
 293
 294           #remove non-phone# stuff and whitespace
 295           $number =~ s/\s//g;
 296 #          my $proto = '';
 297 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
 298 #          my $siphost = '';
 299 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 300
 301           my $intl = $self->option('international_prefix') || '011';
 302
 303           #determine the country code
 304           my $countrycode;
 305           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
 306                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
 307              )
 308           {
 309
 310             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
 311             #first look for 1 digit country code
 312             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
 313               $countrycode = $one;
 314               $number = $u1.$u2.$rest;
 315             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
 316               $countrycode = $two;
 317               $number = $u2.$rest;
 318             } else { #3 digit country code
 319               $countrycode = $three;
 320               $number = $rest;
 321             }
 322
 323           } else {
 324             $countrycode = $self->option('domestic_prefix') || '1';
 325             $number =~ s/^$countrycode//;# if length($number) > 10;
 326           }
 327
 328           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
 329           $pretty_destnum = "+$countrycode $number";
 330
 331           my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
 332             or die "ratenum $ratenum not found!";
 333
 334           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 335                                               'phonenum'    => $number,
 336                                             });
 337
 338           $rate_region = $rate_detail->dest_region;
 339           $regionnum = $rate_region->regionnum;
 340
 341           warn "  found rate for regionnum $regionnum ".
 342                "and rate detail $rate_detail\n"
 343             if $DEBUG;
 344
 345         }
 346
 347       } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used.  very much becoming the odd one out. remove?
 348
 349         if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
 350
 351           $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
 352
 353           $regionnum = $rate_detail->dest_regionnum;
 354           $rate_region = $rate_detail->dest_region;
 355
 356           $pretty_destnum = $cdr->dst;
 357
 358           warn "  found rate for regionnum $regionnum and ".
 359                "rate detail $rate_detail\n"
 360             if $DEBUG;
 361
 362         } else { #pass upstream price through
 363
 364           $charge = sprintf('%.2f', $cdr->upstream_price);
 365           $charges += $charge;
 366
 367           @call_details = (
 368             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
 369             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
 370             'N/A', #minutes...
 371             '$'.$charge,
 372             #$pretty_destnum,
 373             $cdr->description, #$rate_region->regionname,
 374           );
 375
 376         }
 377
 378       } elsif ( $rating_method eq 'upstream_simple' ) {
 379
 380         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
 381         $charge = sprintf('%.3f', $cdr->upstream_price);
 382         $charges += $charge;
 383
 384         @call_details = ($cdr->downstream_csv( 'format' => $output_format ));
 385         $classnum = $cdr->calltypenum;
 386
 387       } else {
 388         die "don't know how to rate CDRs using method: $rating_method\n";
 389       }
 390
 391       ###
 392       # find the price and add detail to the invoice
 393       ###
 394
 395       # if $rate_detail is not found, skip this CDR... i.e.
 396       # don't add it to invoice, don't set its status to NULL,
 397       # don't call downstream_csv or something on it...
 398       # but DO emit a warning...
 399       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
 400       if ( ! $rate_detail && $charge eq '' ) {
 401
 402         warn "no rate_detail found for CDR.acctid:  ". $cdr->acctid.
 403              "; skipping\n"
 404
 405       } else { # there *is* a rate_detail (or call_details), proceed...
 406
 407         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
 408
 409           $included_min{$regionnum} = $rate_detail->min_included
 410             unless exists $included_min{$regionnum};
 411
 412           my $granularity = $rate_detail->sec_granularity;
 413
 414                       # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
 415           my $seconds = $self->option('use_duration')
 416                           ? $cdr->duration
 417                           : $cdr->billsec;
 418
 419           $seconds += $granularity - ( $seconds % $granularity )
 420             if $seconds      # don't granular-ize 0 billsec calls (bills them)
 421             && $granularity; # 0 is per call
 422           my $minutes = sprintf("%.1f", $seconds / 60);
 423           $minutes =~ s/\.0$// if $granularity == 60;
 424
 425           # per call rather than per minute
 426           $minutes = 1 unless $granularity;
 427
 428           $included_min{$regionnum} -= $minutes;
 429
 430           if ( $included_min{$regionnum} < 0 ) {
 431             my $charge_min = 0 - $included_min{$regionnum};
 432             $included_min{$regionnum} = 0;
 433             $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
 434             $charges += $charge;
 435           }
 436
 437           # this is why we need regionnum/rate_region....
 438           warn "  (rate region $rate_region)\n" if $DEBUG;
 439
 440           @call_details = (
 441            $cdr->downstream_csv( 'format'         => $output_format,
 442                                  'granularity'    => $granularity,
 443                                  'minutes'        => $minutes,
 444                                  'charge'         => $charge,
 445                                  'pretty_dst'     => $pretty_destnum,
 446                                  'dst_regionname' => $rate_region->regionname,
 447                                )
 448           );
 449
 450           $classnum = $rate_detail->classnum;
 451
 452         }
 453
 454         if ( $charge > 0 ) {
 455           #just use FS::cust_bill_pkg_detail objects?
 456           my $call_details;
 457
 458           #if ( $self->option('rating_method') eq 'upstream_simple' ) {
 459           if ( scalar(@call_details) == 1 ) {
 460             $call_details = [ 'C', $call_details[0], $charge, $classnum ];
 461           } else { #only used for $rating_method eq 'upstream' now
 462             $csv->combine(@call_details);
 463             $call_details = [ 'C', $csv->string, $charge, $classnum ];
 464           }
 465           warn "  adding details on charge to invoice: [ ".
 466               join(', ', @{$call_details} ). " ]"
 467             if ( $DEBUG && ref($call_details) );
 468           push @$details, $call_details; #\@call_details,
 469         }
 470
 471         # if the customer flag is on, call "downstream_csv" or something
 472         # like it to export the call downstream!
 473         # XXX price plan option to pick format, or something...
 474         $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
 475           if $spool_cdr;
 476
 477         my $error = $cdr->set_status_and_rated_price('done', $charge);
 478         die $error if $error;
 479
 480       }
 481
 482     } # $cdr
 483
 484   } # $cust_svc
 485
 486   unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
 487     if @$details && $rating_method ne 'upstream';
 488
 489   if ( $spool_cdr && length($downstream_cdr) ) {
 490
 491     use FS::UID qw(datasrc);
 492     my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 493     mkdir $dir, 0700 unless -d $dir;
 494     $dir .= '/'. $cust_pkg->custnum.
 495     mkdir $dir, 0700 unless -d $dir;
 496     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
 497
 498     push @{ $param->{'precommit_hooks'} },
 499          sub {
 500                #lock the downstream spool file and append the records
 501                use Fcntl qw(:flock);
 502                use IO::File;
 503                my $spool = new IO::File ">>$filename"
 504                  or die "can't open $filename: $!\n";
 505                flock( $spool, LOCK_EX)
 506                  or die "can't lock $filename: $!\n";
 507                seek($spool, 0, 2)
 508                  or die "can't seek to end of $filename: $!\n";
 509                print $spool $downstream_cdr;
 510                flock( $spool, LOCK_UN );
 511                close $spool;
 512              };
 513
 514   } #if ( $spool_cdr && length($downstream_cdr) )
 515
 516   $charges += $self->option('recur_fee')
 517     if $param->{'increment_next_bill'};
 518
 519   $charges;
 520 }
 521
 522 sub is_free {
 523   0;
 524 }
 525
 526 sub base_recur {
 527   my($self, $cust_pkg) = @_;
 528   $self->option('recur_fee');
 529 }
 530
 531 #  This equates svc_phone records; perhaps svc_phone should have a field
 532 #  to indicate it represents a line
 533 sub calc_units {
 534   my($self, $cust_pkg ) = @_;
 535   scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 536 }
 537
 538 1;
 539