summaryrefslogtreecommitdiff
path: root/FS/bin/freeside-cc-receipts-report
blob: 06e3aba814a0d0efde415958e50ecd0355c6f327 (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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
#!/usr/bin/perl -Tw


use strict;
use Date::Parse;
use Time::Local;
use Getopt::Std;
use Text::Template;
use Net::SMTP;
use Mail::Header;
use Mail::Internet;
use FS::Conf;
use FS::UID qw(adminsuidsetup);
use FS::Record qw(qsearch qsearchs);
use FS::cust_pay;
use FS::cust_pay_batch;


&untaint_argv;	#what it sounds like  (eww)
use vars qw($opt_v $opt_p $opt_m $opt_e $opt_t $opt_s $opt_f $report_lines $report_template @buf $header);
getopts("vpmef:s:");	#switches

#we're at now now (and later).
my($_finishdate)= $opt_f ? str2time($main::opt_f) : $^T;
my($_startdate)= $opt_s ? str2time($main::opt_s) : $^T;

# Get the current month
my ($ssec,$smin,$shour,$smday,$smon,$syear) =
	(localtime($_startdate) )[0,1,2,3,4,5]; 
$smon++;
$syear += 1900;

# Get the current month
my ($fsec,$fmin,$fhour,$fmday,$fmon,$fyear) =
	(localtime($_finishdate) )[0,1,2,3,4,5]; 
$fmon++;
$fyear += 1900;

# Login to the database
my $user = shift or die &usage;
adminsuidsetup $user;

# Get the needed configuration files
my $conf = new FS::Conf;
my $lpr = $conf->config('lpr');
my $email = $conf->config('email');
my $smtpmachine = $conf->config('smtpmachine');
my $mail_sender = $conf->exists('invoice_from') ? $conf->config('invoice_from') :
  'postmaster';
my @report_template = $conf->config('report_template')
  or die "cannot load config file report_template";
$report_lines = 0;
foreach ( grep /report_lines\(\d+\)/, @report_template ) { #kludgy :/
  /report_lines\((\d+)\)/;
  $report_lines += $1;
}
die "no report_lines() functions in template?" unless $report_lines;
$report_template = new Text::Template (
  TYPE   => 'ARRAY',
  SOURCE => [ map "$_\n", @report_template ],
) or die "can't create new Text::Template object: $Text::Template::ERROR";


my(@cust_pays)=qsearch('cust_pay',{});
if (scalar(@cust_pays) == 0)
{
	exit 1;
}

# Open print and email pipes
# $lpr and opt_p for printing
# $email and opt_m for email

if ($lpr && $main::opt_p)
{
        open(LPR, "|$lpr");
}

if ($email && $main::opt_m)
{
  $ENV{MAILADDRESS} = $mail_sender;
  $header = new Mail::Header ( [
    "From: Account Processor",
    "To: $email",
    "Sender: $mail_sender",
    "Reply-To: $mail_sender",
    "Subject: Credit Card Receipts",
  ] );
}

my $uninvoiced = 0;
my $total = 0;
my $taxed = 0;
my $untaxed = 0;
my $total_tax = 0;

# Now I can start looping
foreach my $cust_pay (@cust_pays)
{
	my $_date = $cust_pay->getfield('_date');
	my $invnum = $cust_pay->getfield('invnum');
	my $paid = $cust_pay->getfield('paid');
	my $payby = $cust_pay->getfield('payby');
	

	if ($_date >= $_startdate && $_date <= $_finishdate && $payby =~ 'CARD') {
		$total += $paid;

		$uninvoiced += $cust_pay->unapplied; 
		my @cust_bill_pays = $cust_pay->cust_bill_pay;
                foreach my $cust_bill_pay (@cust_bill_pays) {
			my $invoice_amt =0;
			my $invoice_tax =0;
			my(@cust_bill_pkgs)= $cust_bill_pay->cust_bill->cust_bill_pkg;
			foreach my $cust_bill_pkg (@cust_bill_pkgs) {

				my $recur = $cust_bill_pkg->getfield('recur');
				my $setup = $cust_bill_pkg->getfield('setup');
				my $pkgnum = $cust_bill_pkg->getfield('pkgnum');
			
				if ($pkgnum == 0) {
					$invoice_tax += $recur;
					$invoice_tax += $setup;
				} else {
					$invoice_amt += $recur;
					$invoice_amt += $setup;
				}

			}

			if ($invoice_tax > 0) {
				if ($invoice_amt != $paid) {
					# attempt to prorate partially paid invoices
					$total_tax += $paid / ($invoice_amt + $invoice_tax) * $invoice_tax;
					$taxed += $paid / ($invoice_amt + $invoice_tax) * $invoice_amt;
				} else {
					$total_tax += $invoice_tax;
					$taxed += $invoice_amt;
				}
			} else {
				$untaxed += $paid;
			}

		}

	}

}

push @buf, sprintf(qq{\n%25s%14.2f\n}, "Uninvoiced", $uninvoiced);
push @buf, sprintf(qq{%25s%14.2f\n}, "Untaxed", $untaxed);
push @buf, sprintf(qq{%25s%14.2f\n}, "Taxed", $taxed);
push @buf, sprintf(qq{%25s%14.2f\n}, "Tax", $total_tax);
push @buf, sprintf(qq{\n%39s\n%39.2f\n}, "=========", $total);

sub FS::cc_receipts_report::_template::report_lines {
  my $lines = shift;
  map {
    scalar(@buf) ? shift @buf : '' ;
  }
  ( 1 .. $lines );
}

$FS::cc_receipts_report::_template::title = qq~CREDIT CARD RECEIPTS for period $smon/$smday/$syear through $fmon/$fmday/$fyear~;
$FS::cc_receipts_report::_template::title = $opt_t if $opt_t;
$FS::cc_receipts_report::_template::page = 1;
$FS::cc_receipts_report::_template::date = $^T;
$FS::cc_receipts_report::_template::date = $^T;
$FS::cc_receipts_report::_template::fdate = $_finishdate;
$FS::cc_receipts_report::_template::fdate = $_finishdate;
$FS::cc_receipts_report::_template::sdate = $_startdate;
$FS::cc_receipts_report::_template::sdate = $_startdate;
$FS::cc_receipts_report::_template::total_pages = 
  int( scalar(@buf) / $report_lines);
$FS::cc_receipts_report::_template::total_pages++ if scalar(@buf) % $report_lines;

my @report;
while (@buf) {
  push @report, split("\n", 
    $report_template->fill_in( PACKAGE => 'FS::cc_receipts_report::_template' )
  );
  $FS::cc_receipts_report::_template::page++;
}

if ($opt_v) {
  print map "$_\n", @report;
}
if($lpr && $opt_p)
{
  print LPR map "$_\n", @report;
  print LPR "\f" if $opt_e;
  close LPR || die "Could not close printer: $lpr\n";
}
if($email && $opt_m)
{
  my $message = new Mail::Internet (
    'Header' => $header,
    'Body' => [ (@report) ],
  );
  $!=0;
  $message->smtpsend( Host => "$smtpmachine" )
    or die "can't send report to $email via $smtpmachine: $!";
}


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

sub usage {
  die "Usage:\n\n  freeside-cc-receipts-report [-v] [-p] [-e] user\n";
}

=head1 NAME

freeside-cc-receipts-report - Prints or emails total credit card receipts in a given period.

=head1 SYNOPSIS

  freeside-cc-receipts-report [-v] [-p] [-m] [-e] [-t "title"] [-s date] [-f date] user

=head1 DESCRIPTION

Prints or emails sales taxes invoiced in a given period.

-v: Verbose - Prints records to STDOUT.

-p: Print to printer lpr as found in the conf directory.

-m: Email output to user found in the Conf email file.

-e: Print a final form feed to the printer.

-t: supply a title for the top of each page.

-s: starting date for inclusion

-f: final date for inclusion

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

=head1 VERSION

$Id: freeside-cc-receipts-report,v 1.4 2002-03-07 19:50:23 jeff Exp $

=head1 BUGS

Yes..... Use at your own risk. No guarantees or warrantees of any
kind apply to this program. Parts of this program are hacked from
other GNU licensed software created mainly by Ivan Kohler.

This is released under the GNU Public License. See www.gnu.org
for more information regarding this license.

=head1 SEE ALSO

L<FS::cust_main>, config.html from the base documentation

=head1 AUTHOR

Jeff Finucane <jeff@cmh.net>

based on print-batch by Joel Griffiths <griff@aver-computer.com>

=cut