=================================================================== RCS file: /cvs/RT/Invoicing/rt_invoices.pl,v retrieving revision 1.36 retrieving revision 1.53 diff -u -r1.36 -r1.53 --- RT/Invoicing/rt_invoices.pl 2011/05/18 20:03:17 1.36 +++ RT/Invoicing/rt_invoices.pl 2015/05/07 06:26:08 1.53 @@ -1,5 +1,5 @@ #!/usr/bin/perl -# $AFresh1: rt_invoices.pl,v 1.35 2011/05/18 19:02:36 andrew Exp $ +# $AFresh1: rt_invoices.pl,v 1.52 2015/05/07 05:23:15 andrew Exp $ ######################################################################## # Copyright (c) 2011 Andrew Fresh # @@ -19,7 +19,11 @@ use warnings; use 5.010; +use experimental qw( switch smartmatch ); +# Because we don't have a real cert +$ENV{PERL_LWP_SSL_VERIFY_HOSTNAME} = 0; + use Template; use RT::Client::REST; use RT::Client::REST::Ticket; @@ -28,6 +32,13 @@ use File::Path; use DateTime; +use List::Util qw/ sum /; + +use lib './lib'; # XXX This is fragile, there are better ways +use RTI::Config; +use RTI::State; +use RTI::Util qw/ round ymd_to_DateTime /; + my $config = RTI::Config->new(); my $state = RTI::State->new( $config->get('state') ); @@ -43,9 +54,8 @@ #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 +67,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,37 +84,38 @@ 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_invoice}; $cust->{invoice} ||= make_invoice($cust); - if ( !$cust->{invoice}->{end} ) { - say " $cust->{id} has no open invoices [" . $ticket->id . ']'; - next; - } + die "$cust->{id} has no open invoices [" . $ticket->id . ']' + unless $cust->{invoice}; + + 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 $type = 'unknown'; - while ( $type && $type ne '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->{$type} && $hours->{$type} > 0; my $discount_time = 0; - if ( $hours->{$type} > $fee->{count} ) { - $hours->{$type} -= $fee->{count}; - $discount_time = $fee->{count}; + if ( $hours->{$type} > $count ) { + $hours->{$type} -= $count; + $discount_time = $count; } else { $discount_time = $hours->{$type}; @@ -120,6 +129,7 @@ += $discount_time; $type = '' if $type eq 'default'; + $count -= $discount_time; $fee->{detail} .= " $discount_time $type Hours Discounted"; } } @@ -128,15 +138,97 @@ push @{ $cust->{invoice}->{projects} }, $project; } + +if ( my $unpaid_invoices = $state->unpaid_invoices() ) { + foreach my $custid ( keys %{$unpaid_invoices} ) { + my %project + = ( title => 'Unpaid Invoices', fees => [], no_total => 1 ); + my $past_due = 0; + my $unpaid = 0; + + my $cust; + foreach ( @{$customers} ) { + if ( $_->{id} eq $custid ) { + $cust = $_; + last; + } + } + $cust ||= fake_customer($custid); + + foreach my $id ( + sort { $a <=> $b } + keys %{ $unpaid_invoices->{$custid} } + ) + { + my $unpaid = $state->get_invoice($id); + my $invdate = ymd_to_DateTime( $unpaid->{invdate} ); + + my $content + = sprintf( "Invoice %06d from %s", $id, $invdate->ymd ); + if ( $cust->{duedate} && $invdate < $cust->{duedate}) { + $content = "PAST DUE: $content"; + $past_due += $unpaid_invoices->{$custid}->{$id}; + } + else { + $unpaid += $unpaid_invoices->{$custid}->{$id}; + } + + push @{ $project{fees} }, + { + id => $id, + contents => $content, + count => 1, + rate => $unpaid_invoices->{$custid}->{$id}, + }; + } + + if ($past_due) { + $cust->{invoice} ||= make_invoice($cust); + + $cust->{invoice}->{past_due} = $past_due; + $cust->{invoice}->{unpaid} = $unpaid; + + unshift @{ $cust->{invoice}->{projects} }, \%project; + } + } +} + +if ( my $credits = $state->credits ) { + foreach my $custid ( keys %{$credits} ) { + + my $cust; + foreach ( @{$customers} ) { + if ( $_->{id} eq $custid ) { + $cust = $_; + last; + } + } + + next unless $cust; + next unless $cust->{invoice}; + next unless $credits->{$custid} < 0; + + $cust->{invoice}->{credit} = $credits->{$custid}; + + unshift @{ $cust->{invoice}->{projects} }, { + title => 'Credits', + no_total => 1, + fees => [ + { contents => 'Available Credit', + count => 1, + rate => -$credits->{$custid}, + } + ], + }; + } +} + 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} } ) { @@ -152,9 +244,11 @@ $subtotal += round( $expense->{amount} ); } $project->{total} = $subtotal; + + next if $project->{no_total}; $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"; @@ -170,8 +264,9 @@ $invoice->{total} -= round( $invoice->{discount}{amount} ); } - if ( $invoice->{past_due} ) { - $invoice->{total_due} = $invoice->{total} + $invoice->{past_due}; + if ($invoice->{past_due}) { + $invoice->{total_due} + = sum( @{ $invoice }{ qw/ total past_due unpaid / } ); } next unless $invoice->{total} > 0 || $invoice->{total_due}; @@ -180,38 +275,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}->{ $li{end} }{ $invoice->{id} } = \%li; - - foreach my $key (qw/ start end /) { - if ( exists $invoice->{$key} ) { - $invoice->{$key} = $invoice->{$key}->strftime('%B %d, %Y'); - } - } - my $invoice_dir = $config->get('invoice_dir'); File::Path::make_path($invoice_dir); my $file = join '/', $invoice_dir, $invoice->{file}; @@ -224,20 +297,13 @@ printf "Generated %s for %s: \$%.02f\n", $invoice->{file}, $cust->{id}, $invoice->{total}; + } $state->save; -sub round { - my ($amount) = @_; - - #$amount =~ s/\.\d\d\K.*$//; - #return $amount; - return sprintf "%.02f", $amount; -} - sub find_customer_for_ticket { - my ($ticket) = @_; + my ( $ticket, $customers ) = @_; foreach my $cust ( @{$customers} ) { next unless $cust->{match}; @@ -257,19 +323,24 @@ } } - # Fake customer if we didn't find one - my $cust = $config->get('default') || {}; + return fake_customer($ticket->requestors); +} - ( $cust->{id} ) = $ticket->requestors; - return unless $cust->{id}; +sub fake_customer { + my ($custid) = @_; + return unless $custid; + + my $cust = $config->new_customer; push @{$customers}, $cust; + $cust->{id} = $custid; $cust->{match} = [ { type => 'requestors', regex => $cust->{id}, } ]; + set_cust_dates($cust); return $cust; } @@ -309,52 +380,15 @@ sub make_invoice { my ($cust) = @_; - my $day = $cust->{day} ||= 0; - my $per = $cust->{per} ||= 'week'; - my $freq = $cust->{frequency} ||= 1; + my %invoice = ( + end => $cust->{billend}->clone->subtract( seconds => 1 ), + total => 0, + ); + $invoice{start} = $cust->{startinvoicedate}->clone + if $cust->{startinvoicedate}; - 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 $billend = DateTime->now( time_zone => 'local' ) - ->set( hour => 0, minute => 0, second => 0 ); - - # XXX This is helpful, but monthly and billday > 28 == !!! - $billend->subtract( days => 1 ) - while $day && $billend->$day_method != $day; - - 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}; @@ -370,21 +404,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'; @@ -395,10 +426,10 @@ while ( $date < $billend ) { my $start = $date->clone; - $date->add( $per => $freq ); + $date->add_duration($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; @@ -511,7 +542,7 @@ # XXX Only need $ticket for the alternate subject my $work_time = sprintf "%.03f", $txn->time_taken / 60; - my $work_type = $txn->cf('WorkType'); + my $work_type = $txn->cf('WorkType') || ''; if ( $work_type =~ s/\s*Onsite//i ) { @@ -574,168 +605,74 @@ return $hours; } -sub ymd_to_DateTime { - my ($ymd) = @_; - my ( $date, $time ) = split /[\sT]/, $ymd; - my ( $year, $month, $day ) = split '-', $date; - my ( $hour, $minute, $second ) = split ':', $time if $time; +sub get_billing_frequency { + my ($cust) = @_; + my $per = $cust->{per} || 'week'; + my $freq = $cust->{frequency} || 1; - return DateTime->new( - year => $year, - month => $month, - day => $day, - hour => $hour || 0, - minute => $minute || 0, - second => $second || 0, - time_zone => 'local', - ); -} + 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" } + } -package RTI::Config; -use strict; -use warnings; - -use 5.010; - -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) = @_; - # 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; -} + my $newest_invoice; + my $max_duration; -sub read_config { - my ( $self, $file ) = @_; + foreach my $cust ( @{$customers} ) { + set_cust_dates($cust); - $file ||= $self->{file}; - die "$file: no such file\n" unless -e $file; + my ($freq) = get_billing_frequency($cust); + $max_duration = $freq + if !$max_duration + || DateTime::Duration->compare( $freq, $max_duration ) > 0; - 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; -} + $newest_invoice ||= DateTime->now; -sub get { - my ( $self, $key ) = @_; - my $value = Load( Dump( $self->{_config}->{$key} ) ); - - return $value if $value; - my ( $volume, $directories, $file ) - = File::Spec->splitpath( File::Spec->rel2abs( $self->{file} ) ); - - 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' ); - } - } - - return $value; + return $newest_invoice->clone->subtract_duration($max_duration) + ->subtract( days => 1 ); } -package RTI::State; -use strict; -use warnings; +sub set_cust_dates { + my ($cust) = @_; -use 5.010; + my $day = $cust->{day} || 0; + my ( $freq, $day_method ) = get_billing_frequency($cust); -use YAML::Any qw/ LoadFile DumpFile /; + my $end = DateTime->now( time_zone => 'local' ) + ->set( hour => 0, minute => 0, second => 0 ); -my $file = ''; + my $start = $end->clone->subtract_duration($freq); -sub new { - my $class; - ( $class, $file ) = @_; + # XXX This is helpful, but monthly and billday > 28 == !!! + $end->subtract( days => 1 ) while $day && $end->$day_method != $day; - 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} ) { + $start = ymd_to_DateTime( $lastinvoice->{end} )->add( days => 1 ); + $cust->{startinvoicedate} = $start->clone; } - bless $self, $class; + $cust->{duedate} + = $cust->{net} + ? DateTime->now->subtract( days => $cust->{net} ) + : 0; - 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->{no_invoice} = 1 if $start->clone->add_duration($freq) > $end; + $cust->{billend} = $end; + $cust->{billstart} = $start; }