prorating for the fixed recurring portion of voip
[freeside.git] / 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::prorate);
16
17 $DEBUG = 0;
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
58     'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating.  Leave'.
59                                    ' blank to charge full first month instead.',
60                          'default' => '',
61                        },
62
63     'rating_method' => { 'name' => 'Region rating method',
64                          'type' => 'radio',
65                          'options' => \%rating_method,
66                        },
67
68     'ratenum'   => { 'name' => 'Rate plan',
69                      'type' => 'select',
70                      'select_table' => 'rate',
71                      'select_key'   => 'ratenum',
72                      'select_label' => 'ratename',
73                    },
74
75     'ignore_unrateable' => { 'name' => 'Ignore calls without a rate in the rate tables.  By default, the system will throw a fatal error upon encountering unrateable calls.',
76                              'type' => 'checkbox',
77                            },
78
79     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
80                           'default' => '+1',
81                         },
82
83     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
84                        'type' => 'checkbox'
85                      },
86
87     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
88                            'default' => '1',
89                          },
90
91 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
92 #                                    'type' => 'checkbox',
93 #                                  },
94
95     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
96                                 'default' => '011',
97                               },
98
99     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
100                             'type' => 'checkbox',
101                           },
102
103     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
104                         'type' => 'checkbox',
105                       },
106
107     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
108                            'type' => 'checkbox',
109                          },
110
111     'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
112                                  'type' => 'checkbox',
113                                },
114
115     'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
116                          },
117
118     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
119                          },
120
121     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
122                        },
123
124     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
125                                 },
126
127     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
128                               },
129
130     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
131                       },
132
133     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
134                           'type' => 'checkbox',
135                         },
136
137     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
138                       },
139
140     'output_format' => { 'name' => 'CDR invoice display format',
141                          'type' => 'select',
142                          'select_options' => { FS::cdr::invoice_formats() },
143                          'default'        => 'default', #XXX test
144                        },
145
146     'usage_section' => { 'name' => 'Section in which to place separate usage charges',
147                        },
148
149     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
150                           'type' => 'checkbox',
151                         },
152
153     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call.  Useful for prepaid.',
154                            'type' => 'checkbox',
155                          },
156
157     #XXX also have option for an external db
158 #    'cdr_location' => { 'name' => 'CDR database location'
159 #                        'type' => 'select',
160 #                        'select_options' => \%cdr_location,
161 #                        'select_callback' => {
162 #                          'external' => {
163 #                            'enable' => [ 'datasrc', 'username', 'password' ],
164 #                          },
165 #                          'internal' => {
166 #                            'disable' => [ 'datasrc', 'username', 'password' ],
167 #                          }
168 #                        },
169 #                      },
170 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
171 #                   'disabled' => 'Y',
172 #                 },
173 #    'username' => { 'name' => 'External database username',
174 #                    'disabled' => 'Y',
175 #                  },
176 #    'password' => { 'name' => 'External database password',
177 #                    'disabled' => 'Y',
178 #                  },
179
180   },
181   'fieldorder' => [qw(
182                        setup_fee recur_fee recur_temporality unused_credit
183                        cutoff_day rating_method ratenum ignore_unrateable
184                        default_prefix
185                        disable_src
186                        domestic_prefix international_prefix
187                        disable_tollfree
188                        use_amaflags use_disposition
189                        use_disposition_taqua use_carrierid use_cdrtypenum
190                        skip_dcontext skip_dstchannel_prefix
191                        skip_dst_length_less skip_lastapp
192                        use_duration
193                        411_rewrite
194                        output_format summarize_usage usage_section
195                        bill_every_call
196                      )
197                   ],
198   'weight' => 40,
199 );
200
201 sub calc_setup {
202   my($self, $cust_pkg ) = @_;
203   $self->option('setup_fee');
204 }
205
206 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
207 sub calc_recur {
208   my $self = shift;
209   my($cust_pkg, $sdate, $details, $param ) = @_;
210
211   #my $last_bill = $cust_pkg->last_bill;
212   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
213
214   return 0
215     if $self->option('recur_temporality', 1) eq 'preceding'
216     && ( $last_bill eq '' || $last_bill == 0 );
217
218   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
219
220   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
221
222   my %included_min = ();
223
224   my $charges = 0;
225
226   my $downstream_cdr = '';
227
228   my $rating_method     = $self->option('rating_method') || 'prefix';
229   my $intl              = $self->option('international_prefix') || '011';
230   my $domestic_prefix   = $self->option('domestic_prefix');
231   my $disable_tollfree  = $self->option('disable_tollfree');
232   my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
233   my $use_duration      = $self->option('use_duration');
234
235   my $output_format     = $self->option('output_format', 'Hush!')
236                           || ( $rating_method eq 'upstream_simple'
237                                  ? 'simple'
238                                  : 'default'
239                              );
240
241   my @dirass = ();
242   if ( $self->option('411_rewrite') ) {
243     my $dirass = $self->option('411_rewrite');
244     $dirass =~ s/\s//g;
245     @dirass = split(',', $dirass);
246   }
247
248   #for check_chargable, so we don't keep looking up options inside the loop
249   my %opt_cache = ();
250
251   eval "use Text::CSV_XS;";
252   die $@ if $@;
253   my $csv = new Text::CSV_XS;
254
255   foreach my $cust_svc (
256     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
257   ) {
258
259     foreach my $cdr (
260       $cust_svc->get_cdrs_for_update(
261         'disable_src'    => $self->option('disable_src'),
262         'default_prefix' => $self->option('default_prefix'),
263       )  # $last_bill, $$sdate )
264     ) {
265       if ( $DEBUG > 1 ) {
266         warn "rating CDR $cdr\n".
267              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
268       }
269
270       my $rate_detail;
271       my( $rate_region, $regionnum );
272       my $pretty_destnum;
273       my $charge = '';
274       my $classnum = '';
275       my @call_details = ();
276       if ( $rating_method eq 'prefix' ) {
277
278         my $da_rewrote = 0;
279         if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
280           $cdr->dst('411');
281           $da_rewrote = 1;
282         }
283
284         my $reason = $self->check_chargable( $cdr,
285                                              'da_rewrote'   => $da_rewrote,
286                                              'option_cache' => \%opt_cache,
287                                            );
288
289         if ( $reason ) {
290
291           warn "not charging for CDR ($reason)\n" if $DEBUG;
292           $charge = 0;
293
294         } else {
295           
296           ###
297           # look up rate details based on called station id
298           # (or calling station id for toll free calls)
299           ###
300
301           my( $to_or_from, $number );
302           if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
303                && ! $disable_tollfree
304               )
305           { #tollfree call
306             $to_or_from = 'from';
307             $number = $cdr->src;
308           } else { #regular call
309             $to_or_from = 'to';
310             $number = $cdr->dst;
311           }
312
313           warn "parsing call $to_or_from $number\n" if $DEBUG;
314
315           #remove non-phone# stuff and whitespace
316           $number =~ s/\s//g;
317 #          my $proto = '';
318 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
319 #          my $siphost = '';
320 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
321
322           #determine the country code
323           my $countrycode;
324           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
325                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
326              )
327           {
328
329             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
330             #first look for 1 digit country code
331             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
332               $countrycode = $one;
333               $number = $u1.$u2.$rest;
334             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
335               $countrycode = $two;
336               $number = $u2.$rest;
337             } else { #3 digit country code
338               $countrycode = $three;
339               $number = $rest;
340             }
341
342           } else {
343             $countrycode = $domestic_prefix || '1';
344             $number =~ s/^$countrycode//;# if length($number) > 10;
345           }
346
347           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
348           $pretty_destnum = "+$countrycode $number";
349
350           my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
351             or die "ratenum $ratenum not found!";
352
353           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
354                                               'phonenum'    => $number,
355                                             });
356
357           if ( $rate_detail ) {
358
359             $rate_region = $rate_detail->dest_region;
360             $regionnum = $rate_region->regionnum;
361             warn "  found rate for regionnum $regionnum ".
362                  "and rate detail $rate_detail\n"
363               if $DEBUG;
364
365           } elsif ( $ignore_unrateable ) {
366
367             $rate_region = '';
368             $regionnum = '';
369             #code below will throw a warning & skip
370
371           } else {
372
373             die "FATAL: no rate_detail found in ".
374                 $rate->ratenum. ":". $rate->ratename. " rate plan ".
375                 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
376                 "add a rate or set ignore_unrateable flag on the package def\n";
377           }
378
379         }
380
381       } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used.  very much becoming the odd one out. remove?
382
383         if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
384
385           $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
386
387           $regionnum = $rate_detail->dest_regionnum;
388           $rate_region = $rate_detail->dest_region;
389
390           $pretty_destnum = $cdr->dst;
391
392           warn "  found rate for regionnum $regionnum and ".
393                "rate detail $rate_detail\n"
394             if $DEBUG;
395
396         } else { #pass upstream price through
397
398           $charge = sprintf('%.2f', $cdr->upstream_price);
399           $charges += $charge;
400  
401           @call_details = (
402             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
403             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
404             'N/A', #minutes...
405             '$'.$charge,
406             #$pretty_destnum,
407             $cdr->description, #$rate_region->regionname,
408           );
409
410         }
411
412       } elsif ( $rating_method eq 'upstream_simple' ) {
413
414         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
415         $charge = sprintf('%.3f', $cdr->upstream_price);
416         $charges += $charge;
417
418         @call_details = ($cdr->downstream_csv( 'format' => $output_format,
419                                                'charge' => $charge,
420                                              )
421                         );
422         $classnum = $cdr->calltypenum;
423
424       } else {
425         die "don't know how to rate CDRs using method: $rating_method\n";
426       }
427
428       ###
429       # find the price and add detail to the invoice
430       ###
431
432       # if $rate_detail is not found, skip this CDR... i.e. 
433       # don't add it to invoice, don't set its status to done,
434       # don't call downstream_csv or something on it...
435       # but DO emit a warning...
436       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
437       if ( ! $rate_detail && $charge eq '' ) {
438
439         warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
440              "; skipping\n"
441
442       } else { # there *is* a rate_detail (or call_details), proceed...
443
444         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
445
446           $included_min{$regionnum} = $rate_detail->min_included
447             unless exists $included_min{$regionnum};
448
449           my $granularity = $rate_detail->sec_granularity;
450
451                       # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
452           my $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
453
454           $seconds += $granularity - ( $seconds % $granularity )
455             if $seconds      # don't granular-ize 0 billsec calls (bills them)
456             && $granularity; # 0 is per call
457           my $minutes = sprintf("%.1f", $seconds / 60);
458           $minutes =~ s/\.0$// if $granularity == 60;
459
460           # per call rather than per minute
461           $minutes = 1 unless $granularity;
462
463           $included_min{$regionnum} -= $minutes;
464
465           if ( $included_min{$regionnum} < 0 ) {
466             my $charge_min = 0 - $included_min{$regionnum}; #XXX should preserve
467                                                             #(display?) this
468             $included_min{$regionnum} = 0;
469             $charge = sprintf('%.2f', ( $rate_detail->min_charge * $charge_min )
470                                       + 0.00000001 ); #so 1.005 rounds to 1.01
471             $charges += $charge;
472           }
473
474           # this is why we need regionnum/rate_region....
475           warn "  (rate region $rate_region)\n" if $DEBUG;
476
477           @call_details = (
478            $cdr->downstream_csv( 'format'         => $output_format,
479                                  'granularity'    => $granularity,
480                                  'minutes'        => $minutes,
481                                  'charge'         => $charge,
482                                  'pretty_dst'     => $pretty_destnum,
483                                  'dst_regionname' => $rate_region->regionname,
484                                )
485           );
486
487           $classnum = $rate_detail->classnum;
488
489         }
490
491         if ( $charge > 0 ) {
492           #just use FS::cust_bill_pkg_detail objects?
493           my $call_details;
494
495           #if ( $self->option('rating_method') eq 'upstream_simple' ) {
496           if ( scalar(@call_details) == 1 ) {
497             $call_details = [ 'C', $call_details[0], $charge, $classnum ];
498           } else { #only used for $rating_method eq 'upstream' now
499             $csv->combine(@call_details);
500             $call_details = [ 'C', $csv->string, $charge, $classnum ];
501           }
502           warn "  adding details on charge to invoice: [ ".
503               join(', ', @{$call_details} ). " ]"
504             if ( $DEBUG && ref($call_details) );
505           push @$details, $call_details; #\@call_details,
506         }
507
508         # if the customer flag is on, call "downstream_csv" or something
509         # like it to export the call downstream!
510         # XXX price plan option to pick format, or something...
511         $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
512           if $spool_cdr;
513
514         my $error = $cdr->set_status_and_rated_price('done', $charge);
515         die $error if $error;
516
517       }
518
519     } # $cdr
520
521   } # $cust_svc
522
523   unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
524     if @$details && $rating_method ne 'upstream';
525
526   if ( $spool_cdr && length($downstream_cdr) ) {
527
528     use FS::UID qw(datasrc);
529     my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
530     mkdir $dir, 0700 unless -d $dir;
531     $dir .= '/'. $cust_pkg->custnum.
532     mkdir $dir, 0700 unless -d $dir;
533     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
534
535     push @{ $param->{'precommit_hooks'} },
536          sub {
537                #lock the downstream spool file and append the records 
538                use Fcntl qw(:flock);
539                use IO::File;
540                my $spool = new IO::File ">>$filename"
541                  or die "can't open $filename: $!\n";
542                flock( $spool, LOCK_EX)
543                  or die "can't lock $filename: $!\n";
544                seek($spool, 0, 2)
545                  or die "can't seek to end of $filename: $!\n";
546                print $spool $downstream_cdr;
547                flock( $spool, LOCK_UN );
548                close $spool;
549              };
550
551   } #if ( $spool_cdr && length($downstream_cdr) )
552
553   if ($param->{'increment_next_bill'}) {
554     if ( $self->option('cutoff_day', 1) ) {
555       $charges += $self->SUPER::calc_recur(@_);
556     } else {
557       $charges += $self->option('recur_fee')
558     }
559   }
560
561   $charges;
562 }
563
564 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
565 sub check_chargable {
566   my( $self, $cdr, %flags ) = @_;
567
568   #should have some better way of checking these options from a hash
569   #or something
570
571   my @opt = qw(
572     use_amaflags
573     use_disposition
574     use_disposition_taqua
575     use_carrierid
576     use_cdrtypenum
577     skip_dcontext
578     skip_dstchannel_prefix
579     skip_dst_length_less
580     skip_lastapp
581   );
582   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
583     $flags{option_cache}->{$opt} = $self->option($opt);
584   }
585   my %opt = %{ $flags{option_cache} };
586
587   return 'amaflags != 2'
588     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
589
590   return 'disposition != ANSWERED'
591     if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
592
593   return "disposition != 100"
594     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
595
596   return "carrierid != $opt{'use_carrierid'}"
597     if length($opt{'use_carrierid'})
598     && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
599     && ! $flags{'da_rewrote'};
600
601   return "cdrtypenum != $opt{'use_cdrtypenum'}"
602     if length($opt{'use_cdrtypenum'})
603     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
604
605   return "dcontext IN ( $opt{'skip_dcontext'} )"
606     if $opt{'skip_dcontext'} =~ /\S/
607     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
608
609   my $len_prefix = length($opt{'skip_dstchannel_prefix'});
610   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
611     if $len_prefix
612     && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
613
614   my $dst_length = $opt{'skip_dst_length_less'};
615   return "destination less than $dst_length digits"
616     if $dst_length && length($cdr->dst) < $dst_length;
617
618   return "lastapp is $opt{'skip_lastapp'}"
619     if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
620
621   #all right then, rate it
622   '';
623 }
624
625 sub is_free {
626   0;
627 }
628
629 sub base_recur {
630   my($self, $cust_pkg) = @_;
631   $self->option('recur_fee');
632 }
633
634 #  This equates svc_phone records; perhaps svc_phone should have a field
635 #  to indicate it represents a line
636 sub calc_units {    
637   my($self, $cust_pkg ) = @_;
638   scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
639 }
640
641 1;
642