credit for unused portion at cancellation, patch from pbowen
[freeside.git] / FS / FS / part_pkg / flat.pm
1 package FS::part_pkg::flat;
2
3 use strict;
4 use vars qw(@ISA %info);
5 #use FS::Record qw(qsearch);
6 use FS::part_pkg;
7
8 @ISA = qw(FS::part_pkg);
9
10 %info = (
11   'name' => 'Flat rate (anniversary billing)',
12   'fields' => {
13     'setup_fee'     => { 'name' => 'Setup fee for this package',
14                          'default' => 0,
15                        },
16     'recur_fee'     => { 'name' => 'Recurring fee for this package',
17                          'default' => 0,
18                        },
19     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
20                                    ' of service at cancellation',
21                          'type' => 'checkbox',
22                        },
23   },
24   'fieldorder' => [ 'setup_fee', 'recur_fee', 'unused_credit' ],
25   #'setup' => 'what.setup_fee.value',
26   #'recur' => 'what.recur_fee.value',
27   'weight' => 10,
28 );
29
30 sub calc_setup {
31   my($self, $cust_pkg ) = @_;
32   $self->option('setup_fee');
33 }
34
35 sub calc_recur {
36   my $self = shift;
37   $self->base_recur(@_);
38 }
39
40 sub base_recur {
41   my($self, $cust_pkg) = @_;
42   $self->option('recur_fee');
43 }
44
45 sub calc_remain {
46   my ($self, $cust_pkg) = @_;
47   my $time = time;
48   my $next_bill = $cust_pkg->getfield('bill') || 0;
49   my $last_bill = $cust_pkg->last_bill || 0;
50   return 0 if    ! $self->base_recur
51               || ! $self->option('unused_credit')
52               || ! $last_bill
53               || ! $next_bill;
54
55   my $now_date = ParseDate("epoch $time");
56   my $last_date = ParseDate("epoch $last_bill");
57   my $next_date = ParseDate("epoch $next_bill");
58   my $err;
59   my $delta = DateCalc($now_date,$next_date,\$err, 0);
60   my $days_remaining = Delta_Format($delta, 4, "%dh");
61
62   my $frequency = $self->freq;
63
64   # TODO: Remove this after the frequencies are Data::Manip friendly.
65   $frequency .= "m" unless $frequency =~ /[wd]$/;
66
67   my $freq_delta = ParseDateDelta($frequency);
68   my $days = Delta_Format($freq_delta,4,"%dh");
69
70   my $recurring= $self->base_recur;
71   my $daily =  $recurring/$days;
72
73   sprintf("%.2f",($daily * $days_remaining));
74 }
75
76 sub is_free_options {
77   qw( setup_fee recur_fee );
78 }
79
80 1;