summaryrefslogtreecommitdiff
path: root/FS/FS/part_pkg/discount_Mixin.pm
blob: 1edf258d65217a35abf2dba11dd8e7b983d9500b (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
package FS::part_pkg::discount_Mixin;

use strict;
use vars qw( %info );
use Time::Local qw( timelocal );
use List::Util  qw( min );
use FS::cust_pkg;
use FS::cust_bill_pkg_discount;

%info = ( 'disabled' => 1 );

=head1 NAME

FS::part_pkg::discount_Mixin - Mixin class for part_pkg:: classes that 
can be discounted.

=head1 SYNOPSIS

package FS::part_pkg::...;
use base qw( FS::part_pkg::discount_Mixin );

sub calc_recur {
  ...
  my $discount = $self->calc_discount($cust_pkg, $$sdate, $details, $param);
  $charge -= $discount;
  ...
}

=head METHODS

=item calc_discount

Takes all the arguments of calc_recur.  Calculates and returns  the amount 
by which to reduce the recurring fee; also increments months used on the 
discount and generates an invoice detail describing it.

=cut

sub calc_discount {
  my($self, $cust_pkg, $sdate, $details, $param ) = @_;
  my $conf = new FS::Conf;

  my $br = $self->base_recur_permonth($cust_pkg, $sdate);
  $br += $param->{'override_charges'} if $param->{'override_charges'};
 
  my $tot_discount = 0;
  #UI enforces just 1 for now, will need ordering when they can be stacked

  if ( $param->{freq_override} ) {
    # When a customer pays for more than one month at a time to receive a 
    # term discount, freq_override is set to the number of months.
    my $real_part_pkg = new FS::part_pkg { $self->hash };
    $real_part_pkg->pkgpart($param->{real_pkgpart} || $self->pkgpart);
    # Find a discount with that duration...
    my @discount = grep { $_->months == $param->{freq_override} }
                    map { $_->discount } $real_part_pkg->part_pkg_discount;
    my $discount = shift @discount;
    # and default to bill that many months at once.
    $param->{months} = $param->{freq_override} unless $param->{months};
    my $error;
    if ($discount) {
      # Then set the cust_pkg discount.
      if ($discount->months == $param->{months}) {
        $cust_pkg->discountnum($discount->discountnum);
        $error = $cust_pkg->insert_discount;
      } else {
        $cust_pkg->discountnum(-1);
        foreach ( qw( amount percent months ) ) {
          my $method = "discountnum_$_";
          $cust_pkg->$method($discount->$_);
        }
        $error = $cust_pkg->insert_discount;
      }
      die "error discounting using part_pkg_discount: $error" if $error;
    }
  }

  my @cust_pkg_discount = $cust_pkg->cust_pkg_discount_active;
  foreach my $cust_pkg_discount ( @cust_pkg_discount ) {
    my $discount_left;
    my $discount = $cust_pkg_discount->discount;
    #UI enforces one or the other (for now?  probably for good)
    my $amount = 0;
    $amount += $discount->amount
        if $cust_pkg->pkgpart == $param->{'real_pkgpart'};
    $amount += sprintf('%.2f', $discount->percent * $br / 100 );
    my $chg_months = defined($param->{'months'}) ?
                      $param->{'months'} :
                      $cust_pkg->part_pkg->freq;

    my $months = $discount->months
    ? min( $chg_months,
      $discount->months - $cust_pkg_discount->months_used )
    : $chg_months;

    if (defined $param->{'setup_charge'}) {
        next unless $discount->setup;

        if ( $discount->percent > 0 ) {
            $amount = sprintf('%.2f', $discount->percent * $param->{'setup_charge'} / 100 );
            $months = 1;
        } elsif ( $discount->amount > 0 && $discount->months == 1) {
            $discount_left = $param->{'setup_charge'} - $discount->amount;
            $amount = $param->{'setup_charge'} if $discount_left < 0;
            $amount = $discount->amount if $discount_left >= 0;
            $months = 1;
                
            # transfer remainder of discount, if any, to recur
            $param->{'discount_left_recur'}{$discount->discountnum} = 
                0 - $discount_left if $discount_left < 0;
        } else {
            next; 
        }
    } elsif ( defined $param->{'discount_left_recur'}{$discount->discountnum}
              && $param->{'discount_left_recur'}{$discount->discountnum} > 0
            ) {
        # use up transferred remainder of discount from setup
        $amount = $param->{'discount_left_recur'}{$discount->discountnum};
        $param->{'discount_left_recur'}{$discount->discountnum} = 0;
        $months = 1;
    } elsif (    $discount->setup
              && $discount->months == 1
              && $discount->amount > 0
            ) {
        next;
    }

    if ( ! defined $param->{'setup_charge'} ) {
      if ( $cust_pkg->pkgpart == $param->{'real_pkgpart'} ) {
        push @{ $param->{precommit_hooks} }, sub {
          my $error = $cust_pkg_discount->increment_months_used($months);
          die "error discounting: $error" if $error;
        };
      }

      $amount = min($amount, $br);
      $amount *= $months;
    }

    $amount = sprintf('%.2f', $amount + 0.00000001 ); #so 1.005 rounds to 1.01

    next unless $amount > 0;

    # transfer remainder of discount, if any, to setup
    if ( $discount->setup && $discount->amount > 0
        && (!$discount->months || $discount->months != 1)
        && !defined $param->{'setup_charge'}
       )
    {
      $discount_left = $br - $amount;
      if ( $discount_left < 0 ) {
        $amount = $br;
        $param->{'discount_left_setup'}{$discount->discountnum} = 
          0 - $discount_left;
      }
    }

    #record details in cust_bill_pkg_discount
    my $cust_bill_pkg_discount = new FS::cust_bill_pkg_discount {
      'pkgdiscountnum' => $cust_pkg_discount->pkgdiscountnum,
      'amount'         => $amount,
      'months'         => $months,
    };
    push @{ $param->{'discounts'} }, $cust_bill_pkg_discount;

    #add details on discount to invoice
    my $money_char = $conf->config('money_char') || '$';
    $months = sprintf('%.2f', $months) if $months =~ /\./;

    my $d = 'Includes ';
    $d .= 'setup ' if defined $param->{'setup_charge'};
    $d .= 'discount of '. $discount->description_short;
    $d .= " for $months month". ( $months!=1 ? 's' : '' ) unless defined $param->{'setup_charge'};
    $d .= ": $money_char$amount" if $months != 1 || $discount->percent;
    push @$details, $d;

    $tot_discount += $amount;
  }

  sprintf('%.2f', $tot_discount);
}

1;