[BACK]Return to rt_invoices.pl CVS log [TXT][DIR] Up to [local] / RT / Invoicing

Diff for /RT/Invoicing/rt_invoices.pl between version 1.38 and 1.46

version 1.38, 2011/06/21 01:20:28 version 1.46, 2012/01/27 04:13:45
Line 1 
Line 1 
 #!/usr/bin/perl  #!/usr/bin/perl
 # $AFresh1: rt_invoices.pl,v 1.37 2011/05/26 01:09:36 andrew Exp $  # $AFresh1: rt_invoices.pl,v 1.45 2011/12/31 02:14:32 andrew Exp $
 ########################################################################  ########################################################################
 # Copyright (c) 2011 Andrew Fresh <andrew@afresh1.com>  # Copyright (c) 2011 Andrew Fresh <andrew@afresh1.com>
 #  #
Line 28 
Line 28 
 use File::Path;  use File::Path;
 use DateTime;  use DateTime;
   
   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 $config = RTI::Config->new();
 my $state  = RTI::State->new( $config->get('state') );  my $state  = RTI::State->new( $config->get('state') );
   
Line 43 
Line 48 
 #use YAML;  #use YAML;
 #print Dump $config, $state; exit;  #print Dump $config, $state; exit;
   
 my $startdate;  
   
 my $customers = $config->get('customers');  my $customers = $config->get('customers');
   my $startdate = set_dates($customers);
   
 my @limits = map +{  my @limits = map +{
     attribute  => 'status',      attribute  => 'status',
Line 57 
Line 61 
     # XXX This should be a config option      # XXX This should be a config option
     qw/ open stalled resolved /;      qw/ open stalled resolved /;
   
 if ($startdate) {  push @limits,
     push @limits,      {
         {      attribute => 'last_updated',
         attribute => 'last_updated',      operator  => '>=',
         operator  => '>=',      value     => $startdate->ymd,
         value     => $startdate->ymd,      };
         };  
 }  
   
 my $results = $tickets->search(  my $results = $tickets->search(
     limits  => \@limits,      limits  => \@limits,
Line 76 
Line 78 
   
 my $iterator = $results->get_iterator;  my $iterator = $results->get_iterator;
 while ( my $ticket = &$iterator ) {  while ( my $ticket = &$iterator ) {
     my $cust = find_customer_for_ticket($ticket);      my $cust = find_customer_for_ticket( $ticket, $customers );
     if ( !$cust ) {      if ( !$cust ) {
         warn "No customer found for ticket " . $ticket->id;          warn "No customer found for ticket " . $ticket->id;
         next;          next;
     }      }
   
     say 'Ticket ' . $ticket->id . " belongs to $cust->{id}";      next if $cust->{no_invoice};
   
     $cust->{invoice} ||= make_invoice($cust);      $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 );      my $project = make_project( $ticket, $cust );
     next unless @{ $project->{fees} } || @{ $project->{expenses} };      next unless @{ $project->{fees} } || @{ $project->{expenses} };
   
Line 130 
Line 132 
     push @{ $cust->{invoice}->{projects} }, $project;      push @{ $cust->{invoice}->{projects} }, $project;
 }  }
   
   
   if ( my $unpaid_invoices = $state->unpaid_invoices() ) {
       foreach my $custid ( keys %{$unpaid_invoices} ) {
           my %project  = ( title => 'Unpaid Invoices', fees => [], );
           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}
                   && DateTime->compare( $invdate, $cust->{duedate} ) > 0 )
               {
                   $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->{invoice}->{past_due} = $past_due;
               $cust->{invoice}->{unpaid}   = $unpaid;
               $cust->{invoice}->{total_due}
                   = $cust->{invoice}->{total} + $past_due + $unpaid;
   
               unshift @{ $cust->{invoice}->{projects} }, \%project;
           }
       }
   }
   
 foreach my $cust ( @{$customers} ) {  foreach my $cust ( @{$customers} ) {
     my $invoice = $cust->{invoice};      my $invoice = $cust->{invoice};
     next unless $invoice && $invoice->{projects} && @{ $invoice->{projects} };      next unless $invoice && $invoice->{projects} && @{ $invoice->{projects} };
   
     my %li = (      $invoice->{custid}       = $cust->{id};
         custid       => $cust->{id},      $invoice->{transactions} = [];
         invdate      => DateTime->now( time_zone => 'local' )->ymd,  
         transactions => [],  
     );  
   
     my %transactions;      my %transactions;
     foreach my $project ( @{ $invoice->{projects} } ) {      foreach my $project ( @{ $invoice->{projects} } ) {
Line 156 
Line 213 
         $project->{total} = $subtotal;          $project->{total} = $subtotal;
         $invoice->{total} += $subtotal;          $invoice->{total} += $subtotal;
     }      }
     @{ $li{transactions} } = sort { $a <=> $b } keys %transactions;      @{ $invoice->{transactions} } = sort { $a <=> $b } keys %transactions;
   
     if ( $invoice->{discount} ) {      if ( $invoice->{discount} ) {
         my $c = "Included Hours\n";          my $c = "Included Hours\n";
Line 172 
Line 229 
         $invoice->{total} -= round( $invoice->{discount}{amount} );          $invoice->{total} -= round( $invoice->{discount}{amount} );
     }      }
   
     if ( $invoice->{past_due} ) {  
         $invoice->{total_due} = $invoice->{total} + $invoice->{past_due};  
     }  
   
     next unless $invoice->{total} > 0 || $invoice->{total_due};      next unless $invoice->{total} > 0 || $invoice->{total_due};
   
     $invoice->{info} = $config->get('info');      $invoice->{info} = $config->get('info');
     my $from = $config->get('from');      my $from = $config->get('from');
     $from = get_user($from) if !ref $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->{organization} = $from->{organization} || $from->{name};
     $invoice->{from} = make_address($from);      $invoice->{from} = make_address($from);
     $invoice->{to} = make_address( $cust->{address} || $cust->{id} );      $invoice->{to}   = make_address( $cust->{address} || $cust->{id} );
   
     $state->{lastinvoice}++;  
     $invoice->{id}   = $state->{lastinvoice};  
     $invoice->{file} = sprintf 'invoice_%06d.pdf', $state->{lastinvoice};  
     $invoice->{logo} = $config->get('logo');      $invoice->{logo} = $config->get('logo');
   
     foreach my $k (qw/ file transactions start end total past_due total_due /)      $state->add_invoice($invoice);
     {  
         my $v;  
         if    ( $invoice->{$k} ) { $v = $invoice->{$k} }  
         elsif ( $cust->{$k} )    { $v = $cust->{$k} }  
   
         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');      my $invoice_dir = $config->get('invoice_dir');
     File::Path::make_path($invoice_dir);      File::Path::make_path($invoice_dir);
     my $file = join '/', $invoice_dir, $invoice->{file};      my $file = join '/', $invoice_dir, $invoice->{file};
Line 226 
Line 257 
   
     printf "Generated %s for %s: \$%.02f\n", $invoice->{file}, $cust->{id},      printf "Generated %s for %s: \$%.02f\n", $invoice->{file}, $cust->{id},
         $invoice->{total};          $invoice->{total};
   
 }  }
   
 $state->save;  $state->save;
   
 sub round {  
     my ($amount) = @_;  
   
     #$amount =~ s/\.\d\d\K.*$//;  
     #return $amount;  
     return sprintf "%.02f", $amount;  
 }  
   
 sub find_customer_for_ticket {  sub find_customer_for_ticket {
     my ($ticket) = @_;      my ( $ticket, $customers ) = @_;
   
     foreach my $cust ( @{$customers} ) {      foreach my $cust ( @{$customers} ) {
         next unless $cust->{match};          next unless $cust->{match};
Line 259 
Line 283 
         }          }
     }      }
   
     # Fake customer if we didn't find one      return fake_customer($ticket->requestors);
     my $cust = $config->get('default') || {};  }
   
     ( $cust->{id} ) = $ticket->requestors;  sub fake_customer {
     return unless $cust->{id};      my ($custid) = @_;
       return unless $custid;
   
       my $cust = $config->new_customer;
     push @{$customers}, $cust;      push @{$customers}, $cust;
   
       $cust->{id} = $custid;
     $cust->{match} = [      $cust->{match} = [
         {   type  => 'requestors',          {   type  => 'requestors',
             regex => $cust->{id},              regex => $cust->{id},
         }          }
     ];      ];
   
       set_cust_dates($cust);
     return $cust;      return $cust;
 }  }
   
Line 311 
Line 340 
 sub make_invoice {  sub make_invoice {
     my ($cust) = @_;      my ($cust) = @_;
   
     my $day  = $cust->{day}       ||= 0;      my %invoice
     my $per  = $cust->{per}       ||= 'week';          = ( end => $cust->{billend}->clone->subtract( seconds => 1 ) );
     my $freq = $cust->{frequency} ||= 1;      $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} ) {      if ( $cust->{base_rate} ) {
         my ( $project, $hours ) = make_base_project(          my ( $project, $hours ) = make_base_project($cust);
             $cust,  
             {   date    => $date,  
                 billend => $billend,  
                 per     => $per,  
                 freq    => $freq,  
             }  
         );  
   
         if ( @{ $project->{fees} } ) {          if ( @{ $project->{fees} } ) {
             $invoice{end}   = $project->{end};              $invoice{end}   = $project->{end};
Line 372 
Line 362 
         ];          ];
     }      }
   
     return {} if $invoice{start} && $invoice{end} < $invoice{start};  
   
     return \%invoice;      return \%invoice;
 }  }
   
 sub make_base_project {  sub make_base_project {
     my ( $cust, $args ) = @_;      my ($cust) = @_;
   
     my $date    = $args->{date};      my $date    = $cust->{billstart}->clone;
     my $billend = $args->{billend};      my $billend = $cust->{billend}->clone;
     my $per     = $args->{per};      my ($freq)  = get_billing_frequency($cust);
     my $freq    = $args->{freq};  
   
     my $title      my $title
         = $freq == 1          = $cust->{frequency} == 1
         ? ucfirst( $cust->{per} . 'ly' )          ? ucfirst( $cust->{per} . 'ly' )
         : $freq . ' ' . ucfirst( $cust->{per} );          : $freq . ' ' . ucfirst( $cust->{per} );
     $title .= ' Retainer';      $title .= ' Retainer';
Line 397 
Line 384 
     while ( $date < $billend ) {      while ( $date < $billend ) {
         my $start = $date->clone;          my $start = $date->clone;
   
         $date->add( $per => $freq );          $date->add($freq);
   
         my $end = $date->clone->subtract( seconds => 1 );          my $end = $date > $billend ? $billend->clone : $date->clone;
         $end = $billend->clone->subtract( seconds => 1 ) if $date > $billend;          $end->subtract( seconds => 1 );
   
         $project{end} = $end->clone;          $project{end} = $end->clone;
   
Line 576 
Line 563 
     return $hours;      return $hours;
 }  }
   
 sub ymd_to_DateTime {  sub get_billing_frequency {
     my ($ymd) = @_;      my ($cust) = @_;
     my ( $date, $time ) = split /[\sT]/, $ymd;      my $per  = $cust->{per}       || 'week';
     my ( $year, $month, $day ) = split '-', $date;      my $freq = $cust->{frequency} || 1;
     my ( $hour, $minute, $second ) = split ':', $time if $time;  
   
     return DateTime->new(      my $day_method;
         year      => $year,      given ($per) {
         month     => $month,          when ('week')  { $per = 'weeks';  $day_method = 'dow' }
         day       => $day,          when ('month') { $per = 'months'; $day_method = 'day' }
         hour      => $hour || 0,          default { die "Unknown per [$per]\n" }
         minute    => $minute || 0,      }
         second    => $second || 0,  
         time_zone => 'local',  
     );  
 }  
   
 package RTI::Config;      return DateTime::Duration->new( $per => $freq ), $day_method;
 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;  
 }  }
   
 sub _find_config {  sub set_dates {
     my ($self) = @_;      my ($customers) = @_;
   
     # XXX This needs to be better      my $newest_invoice;
     foreach my $file (qw/ rt_invoice.conf rt_invoice.cfg .rt_invoicerc /) {      my $max_duration;
         foreach my $dir ( '.', $ENV{HOME} . '/.rt_invoicing', $ENV{HOME} ) {  
             my $path = join '/', $dir, $file;  
             return $path if -e $path;  
         }  
     }  
     return;  
 }  
   
 sub read_config {      foreach my $cust ( @{$customers} ) {
     my ( $self, $file ) = @_;          set_cust_dates($cust);
   
     $file ||= $self->{file};          my ($freq) = get_billing_frequency($cust);
     die "$file: no such file\n" unless -e $file;          $max_duration = $freq
               if !$max_duration
                   || DateTime::Duration->compare( $freq, $max_duration ) > 0;
   
     my $c = LoadFile($file) or die "Unable to load $file\n";          if ( $cust->{startinvoicedate} ) {
               my $date = $cust->{startinvoicedate}->clone;
     $c->{customers} ||= [];              $newest_invoice = $date->clone
     if ( $c->{default} ) {                  if !$newest_invoice || $newest_invoice < $date;
         foreach my $cust ( @{ $c->{customers} } ) {  
             foreach my $k ( keys %{ $c->{default} } ) {  
                 $cust->{$k} //= Load( Dump( $c->{default}->{$k} ) );  
             }  
         }          }
     }      }
   
     $self->{_config} = $c;      return $newest_invoice->clone->subtract($max_duration)
     $self->{file}    = $file;          ->subtract( days => 1 );
 }  }
   
 sub get {  sub set_cust_dates {
     my ( $self, $key ) = @_;      my ($cust) = @_;
     my $value = Load( Dump( $self->{_config}->{$key} ) );  
   
     return $value if $value;      my $day = $cust->{day} || 0;
     my ( $volume, $directories, $file )      my ( $freq, $day_method ) = get_billing_frequency($cust);
         = File::Spec->splitpath( File::Spec->rel2abs( $self->{file} ) );  
   
     given ($key) {      my $end = DateTime->now( time_zone => 'local' )
         when ('state') {          ->set( hour => 0, minute => 0, second => 0 );
             $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;      my $start = $end->clone->subtract($freq);
 }  
   
 package RTI::State;      # XXX This is helpful, but monthly and billday > 28 == !!!
 use strict;      $end->subtract( days => 1 ) while $day && $end->$day_method != $day;
 use warnings;  
   
 use 5.010;      my $lastinvoice = $state->last_invoice( $cust->{id} );
       if ( $lastinvoice && $lastinvoice->{end} ) {
 use YAML::Any qw/ LoadFile DumpFile /;          $start = ymd_to_DateTime( $lastinvoice->{end} )->add( days => 1 );
           $cust->{startinvoicedate} = $start->clone;
 my $file = '';  
   
 sub new {  
     my $class;  
     ( $class, $file ) = @_;  
   
     my $self = { lastinvoice => 0, };  
     if ( -e $file ) {  
         $self = LoadFile($file) or die "Unable to load state: $!";  
     }      }
   
     bless $self, $class;      $cust->{duedate}
           = $cust->{net}
           ? DateTime->now->subtract( days => $cust->{net} )
           : 0;
   
     die "Need to pass filename to new: $!" unless $file;      $cust->{no_invoice} = 1 if $start->clone->add($freq) > $end;
       $cust->{billend}    = $end;
     return $self;      $cust->{billstart}  = $start;
 }  
   
 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: $!";  
 }  }
Legend:
Removed from v.1.38  
changed lines
  Added in v.1.46
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>