consistency is nice
[freeside.git] / FS / bin / freeside-credit-report
index 4307a21..92931bc 100755 (executable)
@@ -1,9 +1,11 @@
 #!/usr/bin/perl -Tw
 
+
 use strict;
 use Date::Parse;
 use Time::Local;
 use Getopt::Std;
+use Text::Template;
 use FS::Conf;
 use FS::UID qw(adminsuidsetup);
 use FS::Record qw(qsearch);
@@ -13,24 +15,24 @@ use FS::cust_credit;
 my $mail_program = "/usr/sbin/sendmail -t -n"; 
 
 &untaint_argv; #what it sounds like  (eww)
-use vars qw($opt_v $opt_p $opt_e $opt_d $opt_s);
-getopts("vped:s:");    #switches
+use vars qw($opt_v $opt_p $opt_m $opt_e $opt_t $opt_s $opt_f $report_lines $report_template @buf);
+getopts("vpmef:s:");   #switches
 
 #we're at now now (and later).
-my($_enddate)= $main::opt_d ? str2time($main::opt_d) : $^T;
-my($_startdate)= $main::opt_s ? str2time($main::opt_s) : $^T;
+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]; 
-$syear+=1900;
 $smon++;
+$syear += 1900;
 
 # Get the current month
-my ($esec,$emin,$ehour,$emday,$emon,$eyear) =
-       (localtime($_enddate) )[0,1,2,3,4,5]; 
-$eyear+=1900;
-$emon++;
+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;
@@ -40,6 +42,19 @@ adminsuidsetup $user;
 my $conf = new FS::Conf;
 my $lpr = $conf->config('lpr');
 my $email = $conf->config('email');
+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_credits)=qsearch('cust_credit',{});
 if (scalar(@cust_credits) == 0)
@@ -49,15 +64,14 @@ if (scalar(@cust_credits) == 0)
 
 # Open print and email pipes
 # $lpr and opt_p for printing
-# $email and opt_e for email
+# $email and opt_m for email
 
 if ($lpr && $main::opt_p)
 {
         open(LPR, "|$lpr");
-        print LPR qq~ I N  H O U S E  C R E D I T S for period beginning: $smon/$smday/$syear and ending $emon/$emday/$eyear\n\n~;
 }
 
-if ($email && $main::opt_e)
+if ($email && $main::opt_m)
 {
        open (MAIL, "|$mail_program");
        print MAIL <<END
@@ -66,49 +80,71 @@ From: Account Processor
 Subject: In House Credits
 
 
-I N  H O U S E  C R E D I T S  for period beginning: $smon/$smday/$syear and ending $emon/$emday/$eyear
-
 END
 }
 
+my $uninvoiced = 0;
 my $total = 0;
+my $taxed = 0;
+my $untaxed = 0;
+my $total_tax = 0;
 
 # Now I can start looping
 foreach my $cust_credit (@cust_credits)
 {
        my $_date = $cust_credit->getfield('_date');
        my $amount = $cust_credit->getfield('amount');
-       my $credited = $cust_credit->getfield('credited');
-       
 
-       if ($_date >= $_startdate && $_date <= $_enddate) {
+       if ($_date >= $_startdate && $_date <= $_finishdate) {
                $total += $amount;
-
-               my ($sec,$min,$hour,$mday,$mon,$year) =
-                       (localtime($_date) )[0,1,2,3,4,5]; 
-               $mon++;
-
        }
+}
 
+push @buf, sprintf(qq{\n%25s%14.2f\n}, "Credits Offered", $total);
+push @buf, sprintf(qq{\n%39s\n%39.2f\n}, "=========", $total);
+
+sub FS::credit_report::_template::report_lines {
+  my $lines = shift;
+  map {
+    scalar(@buf) ? shift @buf : '' ;
+  }
+  ( 1 .. $lines );
 }
 
-if ($main::opt_v) {
-       printf(qq{\n\n%25s%14.2f\n}, "Credits Offered", $total);
-       printf(qq{\n%39s\n%39.2f\n}, "=========", $total);
+$FS::credit_report::_template::title = qq~IN HOUSE CREDITS for $smon/$smday/$syear through $fmon/$fmday/$fyear~;
+$FS::credit_report::_template::title = $opt_t if $opt_t;
+$FS::credit_report::_template::page = 1;
+$FS::credit_report::_template::date = $^T;
+$FS::credit_report::_template::date = $^T;
+$FS::credit_report::_template::fdate = $_finishdate;
+$FS::credit_report::_template::fdate = $_finishdate;
+$FS::credit_report::_template::sdate = $_startdate;
+$FS::credit_report::_template::sdate = $_startdate;
+$FS::credit_report::_template::total_pages = 
+  int( scalar(@buf) / $report_lines);
+$FS::credit_report::_template::total_pages++ if scalar(@buf) % $report_lines;
+
+my @report;
+while (@buf) {
+  push @report, split("\n", 
+    $report_template->fill_in( PACKAGE => 'FS::credit_report::_template' )
+  );
+  $FS::credit_report::_template::page++;
 }
 
-# Now I need to close LPR and EMAIL if they were open
-if($lpr && $main::opt_p)
+if ($opt_v) {
+  print map "$_\n", @report;
+}
+if($lpr && $opt_p)
 {
-       printf(LPR qq{\n\n%25s%14.2f\n}, "Credits Offered", $total);
-       printf(LPR qq{\n%39s\n%39.2f\n}, "=========", $total);
-       close LPR || die "Could not close printer: $lpr\n";
+  print LPR map "$_\n", @report;
+  print LPR "\f" if $opt_e;
+  close LPR || die "Could not close printer: $lpr\n";
 }
-if($email && $main::opt_e)
+if($email && $opt_m)
 {
-       printf(MAIL qq{\n\n%25s%14.2f\n}, "Credits Offered", $total);
-       printf(MAIL qq{\n%39s\n%39.2f\n}, "=========", $total);
-       close MAIL || die "Could not close printer: $email\n";
+  print MAIL map "$_\n", @report;
+  close MAIL || die "Could not close printer: $email\n";
 }
 
 
@@ -126,27 +162,35 @@ sub usage {
 
 =head1 NAME
 
-freeside-credit-report - Prints or emails in house credits offered in a given period.
+freeside-credit-report - Prints or emails total credit memos in a given period.
 
 =head1 SYNOPSIS
 
-  freeside-credit-report [-v] [-p] [-e] user
+  freeside-credit-report [-v] [-p] [-m] [-e] [-t "title"] [-s date] [-f date] user
 
 =head1 DESCRIPTION
 
-Prints or emails in house credits offered in a given period.
+Prints or emails total credit memos in a given period.
 
 -v: Verbose - Prints records to STDOUT.
 
 -p: Print to printer lpr as found in the conf directory.
 
--e: Email output to user found in the Conf email file.
+-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-credit-report,v 1.1 2002-02-22 23:18:32 jeff Exp $
+$Id: freeside-credit-report,v 1.2 2002-03-05 23:13:23 jeff Exp $
 
 =head1 BUGS
 
@@ -166,17 +210,8 @@ L<FS::cust_main>, config.html from the base documentation
 griff@aver-computer.com July 99
 
 $Log: freeside-credit-report,v $
-Revision 1.1  2002-02-22 23:18:32  jeff
-add some reporting features
-
-Revision 1.1  2002/02/19 14:24:53  jeff
-might be functional now
-
-Revision 1.1  2000/09/20 19:25:19  jeff
-local modifications
-
-Revision 1.1  2000/05/13 21:57:56  ivan
-add print_batch script from Joel Griffiths
+Revision 1.2  2002-03-05 23:13:23  jeff
+consistency is nice
 
 
 =cut