=================================================================== RCS file: /cvs/RT/Invoicing/rt_invoices.pl,v retrieving revision 1.39 retrieving revision 1.40 diff -u -r1.39 -r1.40 --- RT/Invoicing/rt_invoices.pl 2011/12/21 02:21:54 1.39 +++ RT/Invoicing/rt_invoices.pl 2011/12/22 04:52:28 1.40 @@ -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,20 +78,22 @@ my $iterator = $results->get_iterator; while ( my $ticket = &$iterator ) { - 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} }; @@ -130,15 +134,13 @@ 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( time_zone => 'local' )->ymd, - transactions => [], - ); + $invoice->{custid} = $cust->{id}; + $invoice->{transactions} = []; my %transactions; foreach my $project ( @{ $invoice->{projects} } ) { @@ -156,7 +158,7 @@ $project->{total} = $subtotal; $invoice->{total} += $subtotal; } - @{ $li{transactions} } = sort { $a <=> $b } keys %transactions; + @{ $invoice->{transactions} } = sort { $a <=> $b } keys %transactions; if ( $invoice->{discount} ) { my $c = "Included Hours\n"; @@ -172,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}; } @@ -182,31 +204,16 @@ my $from = $config->get('from'); $from = get_user($from) if !ref $from; + $invoice->{id} = $state->next_invoice_id; + $invoice->{file} = sprintf 'invoice_%06d.pdf', $invoice->{id}; + $invoice->{organization} = $from->{organization} || $from->{name}; $invoice->{from} = make_address($from); - $invoice->{to} = make_address( $cust->{address} || $cust->{id} ); - - $state->{lastinvoice}++; - $invoice->{id} = $state->{lastinvoice}; - $invoice->{file} = sprintf 'invoice_%06d.pdf', $state->{lastinvoice}; + $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}->{ $invoice->{id} } = \%li; foreach my $key (qw/ start end /) { if ( exists $invoice->{$key} ) { @@ -226,6 +233,7 @@ printf "Generated %s for %s: \$%.02f\n", $invoice->{file}, $cust->{id}, $invoice->{total}; + } $state->save; @@ -239,7 +247,7 @@ } sub find_customer_for_ticket { - my ($ticket) = @_; + my ($ticket, $customers) = @_; foreach my $cust ( @{$customers} ) { next unless $cust->{match}; @@ -260,7 +268,7 @@ } # 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}; @@ -272,6 +280,7 @@ } ]; + set_cust_dates($cust); return $cust; } @@ -311,52 +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 $billend = DateTime->now( time_zone => 'local' ) - ->set( hour => 0, minute => 0, second => 0 ); + 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 == !!! - $billend->subtract( days => 1 ) - while $day && $billend->$day_method != $day; + return if $invoice{start} && $invoice{start} > $invoice{end}; - my $date = $billend->clone->subtract( $per => $freq ); - my %invoice = ( end => $billend->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? - return {} - if DateTime->compare( $date->clone->add( $per => $freq ), $billend ) - > 0; - if ( $cust->{base_rate} ) { - my ( $project, $hours ) = make_base_project( - $cust, - { date => $date, - billend => $billend, - per => $per, - freq => $freq, - } - ); + my ( $project, $hours ) = make_base_project( $cust ); if ( @{ $project->{fees} } ) { $invoice{end} = $project->{end}; @@ -372,21 +348,18 @@ ]; } - return {} if $invoice{start} && $invoice{end} < $invoice{start}; - return \%invoice; } sub make_base_project { - my ( $cust, $args ) = @_; + my ( $cust ) = @_; - my $date = $args->{date}; - my $billend = $args->{billend}; - my $per = $args->{per}; - my $freq = $args->{freq}; + 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'; @@ -397,10 +370,10 @@ while ( $date < $billend ) { my $start = $date->clone; - $date->add( $per => $freq ); + $date->add( $freq ); - my $end = $date->clone->subtract( seconds => 1 ); - $end = $billend->clone->subtract( seconds => 1 ) if $date > $billend; + my $end = $date > $billend ? $billend->clone : $date->clone; + $end->subtract( seconds => 1 ); $project{end} = $end->clone; @@ -593,151 +566,68 @@ ); } -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; }