===================================================================
RCS file: /cvs/RT/Invoicing/rt_invoices.pl,v
retrieving revision 1.26
retrieving revision 1.40
diff -u -r1.26 -r1.40
--- RT/Invoicing/rt_invoices.pl	2011/04/19 04:19:27	1.26
+++ RT/Invoicing/rt_invoices.pl	2011/12/22 04:52:28	1.40
@@ -1,5 +1,5 @@
 #!/usr/bin/perl
-# $AFresh1: rt_invoices.pl,v 1.25 2011/04/19 03:18:13 andrew Exp $
+# $AFresh1: rt_invoices.pl,v 1.38 2011/06/21 00:20:28 andrew Exp $
 ########################################################################
 # Copyright (c) 2011 Andrew Fresh <andrew@afresh1.com>
 #
@@ -28,6 +28,10 @@
 use File::Path;
 use DateTime;
 
+use lib './lib';    # XXX This is fragile, there are better ways
+use RTI::Config;
+use RTI::State;
+
 my $config = RTI::Config->new();
 my $state  = RTI::State->new( $config->get('state') );
 
@@ -43,9 +47,9 @@
 #use YAML;
 #print Dump $config, $state; exit;
 
-my $startdate;
 
 my $customers = $config->get('customers');
+my $startdate = set_dates($customers);
 
 my @limits = map +{
     attribute  => 'status',
@@ -57,14 +61,12 @@
     # XXX This should be a config option
     qw/ open stalled resolved /;
 
-if ($startdate) {
-    push @limits,
-        {
-        attribute => 'last_updated',
-        operator  => '>=',
-        value     => $startdate->ymd,
-        };
-}
+push @limits,
+    {
+    attribute => 'last_updated',
+    operator  => '>=',
+    value     => $startdate->ymd,
+    };
 
 my $results = $tickets->search(
     limits  => \@limits,
@@ -76,70 +78,74 @@
 
 my $iterator = $results->get_iterator;
 while ( my $ticket = &$iterator ) {
-    if (!$ticket->time_worked) {
-        say "Ticket " . $ticket->id . " has no time worked";
-        next;
-    }
-
-    my $cust = find_customer_for_ticket( $ticket );
+    my $cust = find_customer_for_ticket($ticket, $customers);
     if ( !$cust ) {
         warn "No customer found for ticket " . $ticket->id;
         next;
     }
 
-    say 'Ticket ' . $ticket->id . " belongs to $cust->{id}";
-
+    next if $cust->{no_invoices};
     $cust->{invoice} ||= make_invoice($cust);
-    if ( !$cust->{invoice}->{end} ) {
-        say "  $cust->{id} has no open invoices [" . $ticket->id . ']';
+    if ( !$cust->{invoice} ) {
+        $cust->{no_invoices} = 1;
+        say "$cust->{id} has no open invoices [" . $ticket->id . ']';
         next;
     }
 
+    say 'Ticket ' . $ticket->id . " belongs to $cust->{id}";
+
     my $project = make_project( $ticket, $cust );
     next unless @{ $project->{fees} } || @{ $project->{expenses} };
 
     foreach my $fee ( @{ $project->{fees} } ) {
         my $hours = hours_for_date( $cust->{invoice}, $fee->{date} );
 
-        my $h_type
-            = exists $hours->{ $fee->{type} }
-            ? $fee->{type}
-            : 'default';
+        my $type  = 'unknown';
+        my $count = $fee->{count};
+        while ( $type && $count > 0 && $type ne 'default' ) {
+            $type = exists $hours->{ $fee->{type} }
+                && $hours->{ $fee->{type} } > 0 ? $fee->{type} : 'default';
 
-        next unless exists $hours->{$h_type} && $hours->{$h_type} > 0;
+            next unless exists $hours->{$type} && $hours->{$type} > 0;
 
-        my $discount_time = 0;
-        if ( $hours->{$h_type} > $fee->{count} ) {
-            $hours->{$h_type} -= $fee->{count};
-            $discount_time = $fee->{count};
-        }
-        else {
-            $discount_time = $hours->{$h_type};
-            $hours->{$h_type} = 0;
-        }
+            my $discount_time = 0;
+            if ( $hours->{$type} > $count ) {
+                $hours->{$type} -= $count;
+                $discount_time = $count;
+            }
+            else {
+                $discount_time = $hours->{$type};
+                $hours->{$type} = 0;
+            }
 
-        if ($discount_time) {
-            $cust->{invoice}->{discount}->{amount}
-                += round( $discount_time * $fee->{rate} );
-            $cust->{invoice}->{discount}->{hours}{$h_type} += $discount_time;
+            if ($discount_time) {
+                $cust->{invoice}->{discount}->{amount}
+                    += round( $discount_time * $fee->{rate} );
+                $cust->{invoice}->{discount}->{hours}{$type}
+                    += $discount_time;
 
-            $h_type = '' if $h_type eq 'default';
-            $fee->{detail} = "$discount_time $h_type Hours Discounted";
+                $type = '' if $type eq 'default';
+                $count -= $discount_time;
+                $fee->{detail} .= " $discount_time $type Hours Discounted";
+            }
         }
     }
 
     push @{ $cust->{invoice}->{projects} }, $project;
 }
 
+
 foreach my $cust ( @{$customers} ) {
     my $invoice = $cust->{invoice};
     next unless $invoice && $invoice->{projects} && @{ $invoice->{projects} };
 
-    my %li = ( custid => $cust->{id}, invdate => DateTime->now->ymd, );
+    $invoice->{custid}  = $cust->{id};
+    $invoice->{transactions} = [];
 
+    my %transactions;
     foreach my $project ( @{ $invoice->{projects} } ) {
         if ( $project->{transactions} ) {
-            push @{ $li{transactions} }, @{ $project->{transactions} };
+            %transactions = ( %transactions, %{ $project->{transactions} } );
         }
         my $subtotal = 0;
         foreach my $fee ( @{ $project->{fees} } ) {
@@ -152,12 +158,14 @@
         $project->{total} = $subtotal;
         $invoice->{total} += $subtotal;
     }
+    @{ $invoice->{transactions} } = sort { $a <=> $b } keys %transactions;
 
     if ( $invoice->{discount} ) {
         my $c = "Included Hours\n";
         if ( $invoice->{discount}{hours} ) {
             foreach my $t ( keys %{ $invoice->{discount}{hours} } ) {
-                $c .= "\n$invoice->{discount}{hours}{$t} $t hour";
+                my $type = $t eq 'default' ? '' : $t;
+                $c .= "\n$invoice->{discount}{hours}{$t} $type hour";
                 $c .= 's' if $invoice->{discount}{hours}{$t} != 1;
                 $c .= "\n";
             }
@@ -166,6 +174,26 @@
         $invoice->{total} -= round( $invoice->{discount}{amount} );
     }
 
+    $invoice->{past_due} = 0;
+    if (my $unpaid_invoices = $state->unpaid_invoices($cust->{id})) {
+        my %project = ( title => 'Unpaid Invoices', fees => [], );
+
+        foreach my $id ( sort { $a <=> $b } keys %{$unpaid_invoices} ) {
+            my $unpaid = $state->get_invoice($id);
+            $invoice->{past_due} += $unpaid_invoices->{$id};
+            push @{ $project{fees} }, {
+                id       => $id,
+                contents => sprintf(
+                    "Invoice %06d from %s",
+                    $id, ymd_to_DateTime( $unpaid->{invdate} )->ymd
+                ),
+                count => 1,
+                rate  => $unpaid_invoices->{$id},
+            };
+        }
+        unshift @{ $invoice->{projects} }, \%project;
+    }
+
     if ( $invoice->{past_due} ) {
         $invoice->{total_due} = $invoice->{total} + $invoice->{past_due};
     }
@@ -176,31 +204,16 @@
     my $from = $config->get('from');
     $from = get_user($from) if !ref $from;
 
-    $invoice->{organization} = $from->{organization} || $from->{name};
-    $invoice->{from}         = make_address($from);
-    $invoice->{to}           = make_address( $cust->{address} || $cust->{id} );
+    $invoice->{id} = $state->next_invoice_id;
+    $invoice->{file} = sprintf 'invoice_%06d.pdf', $invoice->{id};
 
-    $state->{lastinvoice}++;
-    $invoice->{id} = $state->{lastinvoice};
-    $invoice->{file} = sprintf 'invoice_%06d.pdf', $state->{lastinvoice};
+    $invoice->{organization} = $from->{organization} || $from->{name};
+    $invoice->{from} = make_address($from);
+    $invoice->{to}   = make_address( $cust->{address} || $cust->{id} );
     $invoice->{logo} = $config->get('logo');
 
-    foreach my $k (qw/ file transactions start end total past_due total_due /)
-    {
-        my $v;
-        if    ( $invoice->{$k} ) { $v = $invoice->{$k} }
-        elsif ( $cust->{$k} )    { $v = $cust->{$k} }
+    $state->add_invoice( $invoice );
 
-        if ( defined $v && length $v ) {
-            if ( ref $v eq 'DateTime' ) {
-                $li{$k} = $v->ymd;
-            }
-            else {
-                $li{$k} = $v;
-            }
-        }
-    }
-    $state->{invoice}->{ $li{end} }{ $invoice->{id} } = \%li;
 
     foreach my $key (qw/ start end /) {
         if ( exists $invoice->{$key} ) {
@@ -220,6 +233,7 @@
 
     printf "Generated %s for %s: \$%.02f\n", $invoice->{file}, $cust->{id},
         $invoice->{total};
+
 }
 
 $state->save;
@@ -233,25 +247,28 @@
 }
 
 sub find_customer_for_ticket {
-    my ($ticket) = @_;
+    my ($ticket, $customers) = @_;
 
     foreach my $cust ( @{$customers} ) {
         next unless $cust->{match};
         foreach my $m ( @{ $cust->{match} } ) {
             my $type = $m->{type};
-            my $match = exists $m->{$type} ? lc($m->{$type}) : qr/\Q$m->{regex}\E/;
-            my $thing = [ map { lc } $ticket->$type ];
+            my $match
+                = exists $m->{$type}
+                ? lc( $m->{$type} )
+                : qr/\Q$m->{regex}\E/;
+            my $thing = [ map {lc} $ticket->$type ];
 
-            if (! $match) {
+            if ( !$match ) {
                 warn "Invalid match!";
                 next;
             }
-            return $cust if ($match ~~ $thing);
+            return $cust if ( $match ~~ $thing );
         }
     }
 
     # Fake customer if we didn't find one
-    my $cust = $config->get('default') || {};
+    my $cust = $config->new_customer;
 
     ( $cust->{id} ) = $ticket->requestors;
     return unless $cust->{id};
@@ -263,6 +280,7 @@
         }
     ];
 
+    set_cust_dates($cust);
     return $cust;
 }
 
@@ -302,56 +320,19 @@
 sub make_invoice {
     my ($cust) = @_;
 
-    my $day  = $cust->{day}       ||= 0;
-    my $per  = $cust->{per}       ||= 'week';
-    my $freq = $cust->{frequency} ||= 1;
+    return unless $cust->{billstart};
 
-    my $day_method;
-    given ($per) {
-        when ('week')  { $per = 'weeks';  $day_method = 'dow' }
-        when ('month') { $per = 'months'; $day_method = 'day' }
-        default { die "Unknown per [$per]\n" }
-    }
+    my ($freq) = get_billing_frequency($cust);
+    return if $cust->{billstart}->clone->add($freq) > $cust->{billend};
 
-    my $billends = DateTime->now
-        ->subtract( days => 1 )
-        ->set( hour => 23, minute => 59, second => 59 );
+    my %invoice = ( end => $cust->{billend}->clone->subtract( seconds => 1 ) );
+    $invoice{start} = $cust->{startinvoicedate}->clone 
+        if $cust->{startinvoicedate};
 
-    # XXX This is helpful, but monthly and billday > 28 == !!!
-    $billends->subtract( days => 1 )
-        while $day && $billends->$day_method != $day;
+    return if $invoice{start} && $invoice{start} > $invoice{end};
 
-    my $date = $billends->clone->subtract( $per => $freq )
-        ->set( hour => 0, minute => 0, second => 0 );
-
-    my %invoice = ( end => $billends->clone->subtract( seconds => 1 ) );
-
-    my $lastinvoice = $state->last_invoice( $cust->{id} );
-    if ( $lastinvoice->{date} ) {
-        my $last_invoice_date = ymd_to_DateTime( $lastinvoice->{date} );
-        $date = $last_invoice_date->clone->add( days => 1 );
-
-        $invoice{start} = $date->clone;
-
-        $startdate = $date->clone->subtract( $per => $freq )
-            if !$startdate || $startdate > $date;
-    }
-
-    # Is the start date more than $freq $per before the end date?
-    my $diff = $billends - $date;
-    return {} if $diff->in_units($per) < 1;
-
     if ( $cust->{base_rate} ) {
-        my ( $project, $hours ) = make_base_project(
-            $cust,
-            {   startdate  => $date,
-                enddate    => $billends,
-                per        => $per,
-                freq       => $freq,
-                day        => $day,
-                day_method => $day_method,
-            }
-        );
+        my ( $project, $hours ) = make_base_project( $cust );
 
         if ( @{ $project->{fees} } ) {
             $invoice{end}   = $project->{end};
@@ -367,23 +348,18 @@
         ];
     }
 
-    return {} if $invoice{start} && $invoice{end} < $invoice{start};
-
     return \%invoice;
 }
 
 sub make_base_project {
-    my ( $cust, $args ) = @_;
+    my ( $cust ) = @_;
 
-    my $date       = $args->{startdate};
-    my $enddate    = $args->{enddate};
-    my $per        = $args->{per};
-    my $freq       = $args->{freq};
-    my $day        = $args->{day};
-    my $day_method = $args->{day_method};
+    my $date    = $cust->{billstart}->clone;
+    my $billend = $cust->{billend}->clone;
+    my ($freq) = get_billing_frequency($cust);
 
     my $title
-        = $freq == 1
+        = $cust->{frequency} == 1
         ? ucfirst( $cust->{per} . 'ly' )
         : $freq . ' ' . ucfirst( $cust->{per} );
     $title .= ' Retainer';
@@ -391,19 +367,14 @@
     my %project = ( title => $title, start => $date->clone, fees => [], );
     my @hours;
 
-    while ( $date < $enddate ) {
+    while ( $date < $billend ) {
         my $start = $date->clone;
 
-        $date->add( $per => $freq );
-        $date = $enddate->clone if $date > $enddate;
+        $date->add( $freq );
 
-        # XXX This is helpful, but monthly and billday > 28 == !!!
-        $date->subtract( days => 1 ) while $day && $date->$day_method != $day;
+        my $end = $date > $billend ? $billend->clone : $date->clone;
+        $end->subtract( seconds => 1 );
 
-        my $end = $date->clone->subtract( seconds => 1 );
-
-        last if $end < $start;
-
         $project{end} = $end->clone;
 
         push @{ $project{fees} },
@@ -476,9 +447,15 @@
     my $txns = $ticket->transactions( type => [qw(Comment Correspond)] );
     my $txn_i = $txns->get_iterator;
     while ( my $txn = $txn_i->() ) {
-        next unless $txn->time_taken;
         next if $state->txn_is_invoiced( $txn->id );
 
+        if ( my $expense = make_expense( $txn, $ticket ) ) {
+            push @{ $project{expenses} }, $expense;
+            $project{transactions}{ $txn->id } = 1;
+        }
+
+        next unless $txn->time_taken;
+
         my $fee = make_fee( $txn, $cust->{rates}, $ticket );
 
         if ( !( $fee->{rate} && $fee->{count} ) ) {
@@ -487,13 +464,17 @@
         }
 
         my $invoice = $cust->{invoice};
-        next
-            if $invoice->{start}
-                && $invoice->{start} > $fee->{date};
+        if ( $invoice->{start} && $invoice->{start} > $fee->{date} ) {
+            warn "Ticket "
+                . $ticket->id
+                . " has uninvoiced Transaction "
+                . $txn->id . "\n";
+            next;
+        }
         next if $invoice->{end} < $fee->{date};
 
-        push @{ $project{fees} },         $fee;
-        push @{ $project{transactions} }, $txn->id;
+        push @{ $project{fees} }, $fee;
+        $project{transactions}{ $txn->id } = 1;
     }
 
     return \%project;
@@ -507,6 +488,14 @@
     my $work_time = sprintf "%.03f", $txn->time_taken / 60;
     my $work_type = $txn->cf('WorkType');
 
+    if ( $work_type =~ s/\s*Onsite//i ) {
+
+        # XXX Do something special for onsite activities
+    }
+
+    $work_type =~ s/^\s+|\s+$//g;
+    $work_type ||= 'Normal';
+
     my %fee = (
         id       => $txn->id,
         contents => $txn->created . ' ('
@@ -525,6 +514,25 @@
     return \%fee;
 }
 
+sub make_expense {
+    my ( $txn, $ticket ) = @_;
+
+    my $amount = $txn->cf('ExpenseAmount') or return;
+
+    my %expense = (
+        id       => $txn->id,
+        contents => $txn->created . ' ('
+            . $txn->id . ')' . "\n\n"
+            . ( $txn->data || $ticket->subject ),
+        amount => $amount,
+        date   => ymd_to_DateTime( $txn->created ),
+
+        # detail => ???,
+    );
+
+    return \%expense;
+}
+
 sub hours_for_date {
     my ( $invoice, $date ) = @_;
 
@@ -548,160 +556,78 @@
     my ( $hour, $minute, $second ) = split ':', $time if $time;
 
     return DateTime->new(
-        year   => $year,
-        month  => $month,
-        day    => $day,
-        hour   => $hour || 0,
-        minute => $minute || 0,
-        second => $second || 0,
+        year      => $year,
+        month     => $month,
+        day       => $day,
+        hour      => $hour || 0,
+        minute    => $minute || 0,
+        second    => $second || 0,
+        time_zone => 'local',
     );
 }
 
-package RTI::Config;
-use strict;
-use warnings;
+sub get_billing_frequency {
+    my ($cust) = @_;
+    my $per  = $cust->{per}       || 'week';
+    my $freq = $cust->{frequency} || 1;
 
-use 5.010;
+    my $day_method;
+    given ($per) {
+        when ('week')  { $per = 'weeks';  $day_method = 'dow' }
+        when ('month') { $per = 'months'; $day_method = 'day' }
+        default { die "Unknown per [$per]\n" }
+    }
 
-use YAML::Any qw/ LoadFile Dump Load /;
-use File::Spec;
-
-sub new {
-    my ( $class, $args ) = @_;
-
-    my $self = { file => '', };
-    bless $self, $class;
-
-    my $file = $args->{file} || $self->_find_config;
-    $self->read_config($file);
-
-    return $self;
+    return DateTime::Duration->new($per => $freq), $day_method;
 }
 
-sub _find_config {
-    my ($self) = @_;
+sub set_dates {
+    my ($customers) = @_;
+ 
+    my $newest_invoice;
+    my $max_duration;
 
-    # XXX This needs to be better
-    foreach my $file (qw/ rt_invoice.conf rt_invoice.cfg .rt_invoicerc /) {
-        foreach my $dir ( '.', $ENV{HOME} . '/.rt_invoicing', $ENV{HOME} ) {
-            my $path = join '/', $dir, $file;
-            return $path if -e $path;
-        }
-    }
-    return;
-}
+    foreach my $cust ( @{$customers} ) {
+        set_cust_dates($cust);
 
-sub read_config {
-    my ( $self, $file ) = @_;
+        my ($freq) = get_billing_frequency($cust);
+        $max_duration = $freq
+            if !$max_duration
+                || DateTime::Duration->compare( $freq, $max_duration ) > 0;
 
-    $file ||= $self->{file};
-    die "$file: no such file\n" unless -e $file;
-
-    my $c = LoadFile($file) or die "Unable to load $file\n";
-
-    $c->{customers} ||= [];
-    if ( $c->{default} ) {
-        foreach my $cust ( @{ $c->{customers} } ) {
-            foreach my $k ( keys %{ $c->{default} } ) {
-                $cust->{$k} //= Load( Dump( $c->{default}->{$k} ) );
-            }
+        if ( $cust->{startinvoicedate} ) {
+            my $date = $cust->{startinvoicedate}->clone;
+            $newest_invoice = $date->clone
+                if !$newest_invoice || $newest_invoice < $date;
         }
     }
 
-    $self->{_config} = $c;
-    $self->{file}    = $file;
+    return $newest_invoice->clone->subtract($max_duration)
+        ->subtract( days => 1 );
 }
 
-sub get {
-    my ( $self, $key ) = @_;
-    my $value = Load( Dump( $self->{_config}->{$key} ) );
+sub set_cust_dates {
+    my ($cust) = @_;
 
-    return $value if $value;
-    my ($volume,$directories,$file) =File::Spec->splitpath(
-         File::Spec->rel2abs( $self->{file} ));
+    my $day = $cust->{day} || 0;
+    my ( $freq, $day_method ) = get_billing_frequency($cust);
 
-    given ($key) {
-        when ('state') {
-            $value = $self->{file};
-            $value =~ s/(?:\.[^.]+)?$/\.state/;
-        }
-        when ('invoice_dir') {
-            $value = File::Spec->catdir($volume, $directories, 'invoices' );
-        }
-        when ('template_dir') {
-            $value = File::Spec->catdir( $volume, $directories );
-        }
-        when ('invoice_template') {
-            $value = 'invoice.tex.tt';
-        }
-        when ('logo') {
-            $value = File::Spec->catfile($volume, $directories, 'Logo.pdf' );
-        }
-    }
+    my $billend = DateTime->now( time_zone => 'local' )
+        ->set( hour => 0, minute => 0, second => 0 );
 
-    return $value;
-}
+    my $date = $billend->clone->subtract($freq);
 
-package RTI::State;
-use strict;
-use warnings;
+    # XXX This is helpful, but monthly and billday > 28 == !!!
+    $billend->subtract( days => 1 )
+        while $day && $billend->$day_method != $day;
 
-use 5.010;
+    $cust->{billend} = $billend;
 
-use YAML::Any qw/ LoadFile DumpFile /;
-
-my $file = '';
-
-sub new {
-    my $class;
-    ( $class, $file ) = @_;
-
-    my $self = { lastinvoice => 0, };
-    if ( -e $file ) {
-        $self = LoadFile($file) or die "Unable to load state: $!";
+    my $lastinvoice = $state->last_invoice( $cust->{id} );
+    if ( $lastinvoice && $lastinvoice->{end} ) {
+        $date = ymd_to_DateTime( $lastinvoice->{end} )->add( days => 1 );
+        $cust->{startinvoicedate} = $date->clone;
     }
 
-    bless $self, $class;
-
-    die "Need to pass filename to new: $!" unless $file;
-
-    return $self;
-}
-
-sub last_invoice {
-    my ( $self, $custid ) = @_;
-    state %table;
-    if ( !%table ) {
-        foreach my $date ( sort keys %{ $self->{invoice} } ) {
-            while ( my ( $id, $inv ) = each %{ $self->{invoice}->{$date} } ) {
-                next unless $inv->{custid};
-                $table{ $inv->{custid} } = {
-                    id   => $id,
-                    date => $date,
-                    %{$inv},
-                };
-            }
-        }
-    }
-    return $table{$custid} || {};
-}
-
-sub txn_is_invoiced {
-    my ( $self, $txn ) = @_;
-    state %table;
-    if ( !%table ) {
-        foreach my $date ( sort keys %{ $self->{invoice} } ) {
-            foreach my $inv ( values %{ $self->{invoice}->{$date} } ) {
-                foreach my $t ( @{ $inv->{transactions} } ) {
-                    $table{$t} = 1;
-                }
-            }
-        }
-    }
-    return $table{$txn};
-}
-
-sub save {
-    my ($self) = @_;
-    DumpFile( $file, {%$self} ) or die "Unable to save state: $!";
+    $cust->{billstart} = $date;
 }