summaryrefslogtreecommitdiff
path: root/FS/FS/part_pkg/agent_cdr.pm
blob: a638b5b5af80697c205d714996262c0b3f5c8a1b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
package FS::part_pkg::agent_cdr;
use base qw( FS::part_pkg::recur_Common );

#kind of glommed together from cdr_termination, agent, voip_cdr
# some false laziness w/ all of them

use strict;
use vars qw( $DEBUG $me %info );
use FS::Record qw( qsearch );
use FS::PagedSearch qw( psearch );
use FS::agent;
use FS::cust_main;
use FS::cdr;

$DEBUG = 0;

$me = '[FS::part_pkg::agent_cdr]';

tie my %temporalities, 'Tie::IxHash',
  'upcoming'  => "Upcoming (future)",
  'preceding' => "Preceding (past)",
;

%info = (
  'name'      => 'Wholesale CDR cost billing, for master customers of an agent.',
  'shortname' => 'Wholesale CDR cost billing for agent',
  'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
  'fields' => { #false laziness w/cdr_termination

    #false laziness w/flat.pm
    'recur_temporality' => { 'name' => 'Charge recurring fee for period',
                             'type' => 'select',
                             'select_options' => \%temporalities,
                           },

    'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating or '.
                                   'subscription',
                         'default' => '1',
                       },
    'recur_method'  => { 'name' => 'Recurring fee method',
                         #'type' => 'radio',
                         #'options' => \%recur_method,
                         'type' => 'select',
                         'select_options' => \%FS::part_pkg::recur_Common::recur_method,
                       },

    #false laziness w/voip_cdr.pm
    'output_format' => { 'name' => 'CDR invoice display format',
                         'type' => 'select',
                         'select_options' => { FS::cdr::invoice_formats() },
                         'default'        => 'simple2', #with source
                       },

    'usage_section' => { 'name' => 'Section in which to place separate usage charges',
                       },

    'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
                          'type' => 'checkbox',
                        },

    'usage_mandate' => { 'name' => 'Always put usage details in separate section',
                          'type' => 'checkbox',
                       },
    #eofalse

  },

  'fieldorder' => [ qw( recur_temporality recur_method cutoff_day ),
                    FS::part_pkg::prorate_Mixin::fieldorder, 
                    qw(
                       output_format usage_section summarize_usage usage_mandate
                    ),
                  ],

  'weight' => 53,

);

sub calc_recur {
  my( $self, $cust_pkg, $sdate, $details, $param ) = @_;

  #my $last_bill = $cust_pkg->last_bill;
  my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup

  return 0
    if $self->recur_temporality eq 'preceding'
    && ( $last_bill eq '' || $last_bill == 0 );

  my $charges = 0;

  my $output_format = $self->option('output_format', 'Hush!') || 'simple2';

  #CDR calculations

  #false laziness w/agent.pm
  #almost always just one,
  #unless you have multiple agents with same master customer0
  my @agents = qsearch('agent', { 'agent_custnum' => $cust_pkg->custnum } );

  foreach my $agent (@agents) {

    warn "$me billing wholesale CDRs for agent ". $agent->agent. "\n"
      if $DEBUG;

    #not the most efficient to load them all into memory,
    #but good enough for our current needs
    my @cust_main = qsearch('cust_main', { 'agentnum' => $agent->agentnum } );

    foreach my $cust_main (@cust_main) {

      warn "$me billing agent wholesale CDRs for ". $cust_main->name_short. "\n"
        if $DEBUG;

      #eofalse laziness w/agent.pm

      my @svcnum = ();
      foreach my $cust_pkg ( $cust_main->cust_pkg ) {
        push @svcnum, map $_->svcnum, $cust_pkg->cust_svc( svcdb=>'svc_phone' );
      }

      next unless @svcnum;

      #false laziness w/cdr_termination

      my $termpart = 1; #or from an option -- we're not termination, we're wholesale?  for now, use one or the other

      #false lazienss w/search/cdr.html (i should be a part_termination method)
      my $where_term =
        "( cdr.acctid = cdr_termination.acctid AND termpart = $termpart ) ";
      #my $join_term = "LEFT JOIN cdr_termination ON ( $where_term )";
      my $extra_sql =
        "AND NOT EXISTS ( SELECT 1 FROM cdr_termination WHERE $where_term )";

      #eofalse laziness w/cdr_termination.pm

      #false laziness w/ svc_phone->psearch_cdrs, kinda
      my $cdr_search = psearch({
        'table'     => 'cdr',
        #'addl_from' => $join_term,
        'hashref'   => {},
        'extra_sql' => " WHERE freesidestatus IN ( 'rated', 'done' ) ".
                       "   AND svcnum IN (". join(',', @svcnum). ") ".
                       $extra_sql,
        'order_by'  => 'ORDER BY startdate FOR UPDATE ',

      });

      #false laziness w/voip_cdr
      $cdr_search->limit(1000);
      $cdr_search->increment(0); #because we're adding cdr_termination as we go?
      while ( my $cdr = $cdr_search->fetch ) {

        my $cost = $cdr->rate_cost;
        #XXX exception handling?  return undef? (and err?) ref to a scalar err?

        #false laziness w/cdr_termination

        #add a cdr_termination record and the charges

        my $cdr_termination = new FS::cdr_termination {
          'acctid'      => $cdr->acctid,
          'termpart'    => $termpart,
          'rated_price' => $cost,
          'status'      => 'done',
        };

        my $error = $cdr_termination->insert;
        die $error if $error; #next if $error; #or just skip this one???  why?

        $charges += $cost;

        # and add a line to the invoice

        my $call_details = $cdr->downstream_csv( 'format' => $output_format,
                                                 'charge' => $cost,
                                               );
        my $classnum = ''; #usage class?

       #option to turn off?  or just use squelch_cdr for the customer probably
        # XXX use detail_format for this at some point
        push @$details, { 'format'    => 'C',
                          'detail'    => $call_details,
                          'amount'    => $cost,
                          'classnum'  => $classnum };

        #eofalse laziness w/cdr_termination

      }

    }

  }

  #eo CDR calculations

  $charges += ($cust_pkg->quantity || 1)
                * $self->calc_recur_Common($cust_pkg, $sdate, $details, $param);

  $charges;
}

sub can_discount { 0; }

#?  sub hide_svc_detail { 1; }

sub is_free { 0; }

sub can_usageprice { 0; }

1;