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