summaryrefslogtreecommitdiff
path: root/FS/bin/freeside-overdue
blob: 116245f9cb2bd2523ada057109adb9426e1322a1 (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
#!/usr/bin/perl -w

use strict;
use vars qw( $days_to_pay $cust_main $cust_pkg 
             $cust_svc $svc_acct );
use Getopt::Std;
use FS::cust_main;
use FS::cust_pkg;
use FS::cust_svc;
use FS::svc_acct;
use FS::Record qw(qsearch qsearchs);
use FS::UID qw(adminsuidsetup);

&untaint_argv;
my %opt;
getopts('ed:qpl:scbyoi', \%opt);
my $user = shift or die &usage;

adminsuidsetup $user;

my $now = time; #eventually take a time option like freeside-bill
my ($sec,$min,$hour,$mday,$mon,$year) =
  (localtime($now) )[0,1,2,3,4,5];
$mon++;
$year += 1900;

foreach $cust_main ( qsearch('cust_main',{} ) ) {

  my ( $eyear, $emon, $eday ) = ( 2037, 12, 31 );
  if ( $cust_main->paydate =~ /^(\d{4})\-(\d{1,2})\-(\d{1,2})$/
       && $cust_main->payby eq 'BILL') {
    ( $eyear, $emon, $eday ) = ( $1, $2, $3 );
  }

  if ( ( $opt{d}
           && $cust_main->balance_date(time - $opt{d} * 86400) > 0
           && qsearchs( 'cust_pkg', { 'custnum' => $cust_main->custnum,
                                      'susp' => "" } ) )
       || ( $opt{e}
            && $cust_main->payby eq 'BILL'
            && ( $eyear < $year
                 || ( $eyear == $year && $emon < $mon ) ) )
  ) { 

    unless ( $opt{q} ) {
      print $cust_main->custnum, "\t",
            $cust_main->last, "\t", $cust_main->first, "\t",
            $cust_main->balance_date(time-$opt{d} * 86400);
    }

    if ( $opt{p} && ! grep { $_ eq 'POST' } $cust_main->invoicing_list ) {
      print "\n\tAdding postal invoicing" unless $opt{q};
      my @invoicing_list = $cust_main->invoicing_list;
      push @invoicing_list, 'POST';
      $cust_main->invoicing_list(\@invoicing_list);
    }

    if ( $opt{l} ) {
      print "\n\tCharging late fee of \$$opt{l}" unless $opt{q};
      my $error = $cust_main->charge($opt{l}, 'Late fee');
      # comment or plandata with info so we don't redo the same late fee every
      # day
    }

    foreach $cust_pkg ( qsearch( 'cust_pkg', 
                                 { 'custnum' => $cust_main->custnum } ) ) {

      if ($opt{s}) {
        print "\n\tSuspending pkgnum " . $cust_pkg->pkgnum unless $opt{q};
        $cust_pkg->suspend;
      }

      if ($opt{c}) {
        print "\n\tCancelling pkgnum " . $cust_pkg->pkgnum unless $opt{q};
        $cust_pkg->cancel;
      }
      
    }

    if ( $opt{b} ) {
      print "\n\tBilling" unless $opt{q};
      my $error = $cust_main->bill('time'=>$now);
      warn "Error billing,  customer #" . $cust_main->custnum . 
        ":" . $error if $error;
    }

    if ( $opt{y} ) {
      print "\n\tApplying outstanding payments and credits" unless $opt{q};
      $cust_main->apply_payments;
      $cust_main->apply_credits;
    }

    if ( $opt{o} ) {
      print "\n\tCollecting" unless $opt{q};
      my $error = $cust_main->collect(
        'invoice_time' => $now,
        'batch_card'   => $opt{i} ? 'no' : 'yes',
        'force_print'  => 'yes',
      );
      warn "Error collecting from customer #" . $cust_main->custnum.  ":$error"
        if $error;
    }

    print "\n" unless $opt{q};

  }

}

sub untaint_argv {
  foreach $_ ( $[ .. $#ARGV ) { 
    $ARGV[$_] =~ /^([\w\-\/\.]*)$/ || die "Illegal arguement \"$ARGV[$_]\"";
    $ARGV[$_]=$1;
  }
}

sub usage {
  die "Usage:\n\n    freeside-overdue [ -e ] [ -d days ] [ -q ] [ -p ] [ -l amount ] [ -s ] [ -c ] [ -b ] [ -y ] [ -o [ -i ] ] user\n";
}


=head1 NAME

freeside-overdue - Perform actions on overdue and/or expired accounts.

=head1 SYNOPSIS

  freeside-overdue [ -e ] [ -d days ] [ -q ] [ -p ] [ -l amount ] [ -s ] [ -c ] [ -b ] [ -y ] [ -o [ -i ] ] user

=head1 DESCRIPTION

This script is deprecated in 1.4.0.  You should use freeside-daily and invoice
events instead.

Performs actions on overdue and/or expired accounts.

Selection options (at least one selection option is required):

  -d:  Customers with a balance due on invoices older than the supplied number
       of days.  Requires an integer argument.

  -e:  Customers with a billing expiration date in the past.

Action options: 

  -q:  Be quiet (by default, selected accounts are printed).

  -p:  Add postal invoicing to the relevant customers.

  -l:  Add a charge of the given amount to the relevant customers.

  -s:  Suspend accounts.

  -c:  Cancel accounts.

  -b:  Bill customers (create invoices)

  -y:  Apply unapplied payments and credits

  -o:  Collect from customers (charge cards, print invoices)

    -i:  real-time billing (as opposed to batch billing).  only relevant
         for credit cards.

  user: From the mapsecrets file - see config.html from the base documentation

=head1 CRONTAB

Example crontab entries:

# suspend expired accounts
20 4 * * * freeside-overdue -e -s user

# quietly add postal invoicing to customers over 30 days past due
20 4 * * * freeside-overdue -d 30 -p -q user

# suspend accounts and charge a $10.23 fee for customers over 60 days past due
20 4 * * * freeside-overdue -d 60 -s -l 10.23 user

# cancel accounts over 90 days past due
20 4 * * * freeside-overdue -d 90 -c user

=head1 ORIGINAL AUTHORS

Original disable-overdue version by mw/kwh: Mark W.? and Kristian Hoffmann ?

Ivan seems to be turning it into the "do-everything" CLI.

=head1 BUGS

Hell now that this is the do-everything CLI it should have --longoptions

=cut

1;