[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.1 and 1.8

version 1.1, 2011/03/21 00:55:41 version 1.8, 2011/03/22 00:22:27
Line 12 
Line 12 
   
 use DateTime;  use DateTime;
   
 my %rates;  
 my %included_hours;  
   
 my $config = RTI::Config->new();  my $config = RTI::Config->new();
   my $state  = RTI::State->new( $config->get('state') );
   
 #print Dump $config; exit;  my $rt_conf = $config->get('rt');
   my $rt      = RT::Client::REST->new(
       server  => $rt_conf->{server},
       timeout => $rt_conf->{timeout},
   );
   my $tickets = RT::Client::REST::Ticket->new( rt => $rt );
   my $users = RT::Client::REST::User->new( rt => $rt );
   
 # my $state = RTI::State->new($cust);  $rt->login( username => $rt_conf->{user}, password => $rt_conf->{pass} );
 # $invoice{state} = $state;  
 my $lastinvdate;    # = $state->{lastinvoicedte}; XXX Needs to be a DateTime  
   
 #$lastinvdate = DateTime->now->subtract( months => 2 );  #print Dump $config, $state; exit;
 my $invoiceid = 1;    # $state->{lastinvoice} + 1;  
   
 my $startdate;  my $startdate;
 my @invoices;  
 foreach my $cust ( @{ $config->get('customers') } ) {  
     my %invoice = (  
         from  => $config->get('from'),  
         to    => $cust->{address},  
         rates => $cust->{rates},  
         match => $cust->{match},  
     );  
   
   my $customers = $config->get('customers');
   CUSTOMER: while ( my ( $custid, $cust ) = each %{$customers} ) {
   
       my %invoice = ( end => DateTime->now, );
   
     if ( $cust->{base_rate} ) {      if ( $cust->{base_rate} ) {
         my $date = DateTime->now;          my $day  = $cust->{day}       || 1;
         my $day  = $cust->{day} || 1;  
         my $freq = $cust->{frequency} || 1;          my $freq = $cust->{frequency} || 1;
   
         my $diff;  
         my $per;          my $per;
           my $day_method;
         given ( $cust->{per} ) {          given ( $cust->{per} ) {
             when ('week')  { $per = 'weeks';  $diff = $date->dow - $day; }              when ('week')  { $per = 'weeks';  $day_method = 'dow' }
             when ('month') { $per = 'months'; $diff = $date->day - $day; }              when ('month') { $per = 'months'; $day_method = 'day' }
             default { die "Unknown per [$cust->{per}]\n" }              default { die "Unknown per [$cust->{per}]\n" }
         }          }
   
         # $day is start day, end should be one day further back          my $billends
         $diff = abs($diff) + 1;              = DateTime->now->set( hour => 0, minute => 0, second => 0 );
         $date->subtract( days => $diff );          $billends->subtract( days => 1 ) while $billends->$day_method != $day;
   
           my $date = $billends->clone->subtract( $per => $freq );
   
           my $lastinvoice = $state->last_invoice($custid);
           if ( $lastinvoice->{date} ) {
               my $last_invoice_date = ymd_to_DateTime( $lastinvoice->{date} );
               $date = $last_invoice_date->clone->add( days => 1 );
           }
   
           next CUSTOMER if $billends <= $date;
   
         my $title          my $title
             = $freq == 1              = $freq == 1
             ? ucfirst( $cust->{per} . 'ly' )              ? ucfirst( $cust->{per} . 'ly' )
Line 61 
Line 68 
   
         my %project = ( title => $title, fees => [], );          my %project = ( title => $title, fees => [], );
   
         # XXX need to add them until we get to where we billed already          while ( $date < $billends ) {
         # if we don't know the last invoice date, assume the day before              my $start = $date->clone;
         $lastinvdate ||= $date->clone->subtract( days => 1 );  
         while ( $date > $lastinvdate ) {              $date->add( $per => $freq );
             $invoice{enddate} = $date->clone;              $date = $billends->clone if $date > $billends;
   
               # XXX This is helpful, but monthly and billday > 28 == !!!
               $date->subtract( days => 1 ) while $date->$day_method != $day;
   
               my $end = $date->clone->subtract( seconds => 1 );
   
               next if $end < $start;
   
               $startdate = $start->clone if !$startdate || $startdate > $start;
               $invoice{start} ||= $start->clone;
               $invoice{end} = $end->clone;
             my %hours = (              my %hours = (
                 end   => $date->clone,                  start => $start->clone,
                   end   => $end->clone,
                 hours => { %{ $cust->{hours} } },                  hours => { %{ $cust->{hours} } },
             );              );
   
             my $contents = ' to ' . $date->ymd;              push @{ $invoice{hours} }, \%hours;
             $date->subtract( $per => $freq )->add( days => 1 );              push @{ $project{fees} },
             $contents = $date->ymd . $contents;  
   
             $invoice{startdate} ||= $date->clone;  
             $hours{start} = $date->clone;  
             $startdate = $date->clone;  
   
             unshift @{ $invoice{hours} }, \%hours;  
             unshift @{ $project{fees} },  
                 {                  {
                 count    => 1,                  count    => 1,
                 rate     => $cust->{base_rate},                  rate     => $cust->{base_rate},
                 contents => $contents,                  contents => $start->ymd . ' to ' . $end->ymd,
                 };                  };
   
             # Next time, one day less  
             $date->subtract( days => 1 );  
         }          }
   
         push @{ $invoice{projects} }, \%project;          if ( @{ $project{fees} } ) {
               push @{ $invoice{projects} }, \%project;
           }
     }      }
     else {  
         $invoice{enddate} = DateTime->now->ymd;  
         push @{ $invoice{hours} },  
             { end => DateTime->now, hours => $cust->{hours} };  
     }  
   
     push @invoices, \%invoice;      $cust->{invoice} = \%invoice;
 }  }
   
 #print Dump \@invoices; exit;  
   
 my $rt_conf = $config->get('rt');  
 my $rt      = RT::Client::REST->new(  
     server  => $rt_conf->{server},  
     timeout => $rt_conf->{timeout},  
 );  
 $rt->login(  
     username => $rt_conf->{user},  
     password => $rt_conf->{pass},  
 );  
 my $tickets = RT::Client::REST::Ticket->new( rt => $rt );  
 my $users = RT::Client::REST::User->new( rt => $rt );  
   
 my @limits = map +{  my @limits = map +{
     attribute  => 'status',      attribute  => 'status',
     operator   => '=',      operator   => '=',
Line 126 
Line 118 
     # XXX This should be a config option      # XXX This should be a config option
     qw/ open stalled resolved /;      qw/ open stalled resolved /;
   
 #push @limits,  
 #    {  
 #    attribute => 'resolved',  
 #    operator  => '>=',  
 #    value     => '2011-03-01'  
 #    };  
 if ($startdate) {  if ($startdate) {
     push @limits,      push @limits,
         {          {
Line 141 
Line 127 
         };          };
 }  }
   
 #push @limits, { attribute => 'id', operator => '=', value => '51' };  
 #push @limits, { attribute => '', operator => '', value => '' };  
   
 my $results = $tickets->search(  my $results = $tickets->search(
     limits  => \@limits,      limits  => \@limits,
     orderby => 'id',      orderby => 'id',
 );  );
   
 #print Dump $ticket, $results;  
   
 my $count = $results->count;  my $count = $results->count;
 print "There are $count results that matched your query\n";  print "There are $count results that matched your query\n";
   
 my $iterator = $results->get_iterator;  my $iterator = $results->get_iterator;
 while ( my $ticket = &$iterator ) {  while ( my $ticket = &$iterator ) {
     my %project = (      my $cust = find_customer_for_ticket( $customers, $ticket );
         id     => $ticket->id,      if ( !$cust ) {
         queue  => $ticket->queue,          say "No customer found for ticket " . $ticket->id;
         owner  => $ticket->owner,          next;
         title  => $ticket->id . ': ' . $ticket->subject,  
         detail => 'Requestors: '  
             . join( ', ', $ticket->requestors )  
             . ' Queue: '  
             . $ticket->queue,  
         fees     => [],  
         expenses => [],  
     );  
   
     my $invoice;  
 INVOICE: foreach my $i (@invoices) {  
         next INVOICE unless $i->{match};  
         foreach my $m ( @{ $i->{match} } ) {  
             my $type = $m->{type};  
             my $thing = join ' ', $ticket->$type;  
   
             if ( $m->{$type} ) {  
                 my $match = lc $m->{$type};  
                 next INVOICE unless lc($thing) ~~ $match;  
             }  
             elsif ( $m->{regex} ) {  
                 next INVOICE unless $thing ~~ /\Q$m->{regex}\E/;  
             }  
             else {  
                 warn "Invalid match!";  
                 next INVOICE;  
             }  
         }  
         $invoice = $i;  
     }      }
       if ( !$cust->{invoice} ) {
     if ( !$invoice ) {          say "Customer has no open invoices for ticket " . $ticket->id;
         say "No invoice found for ticket " . $ticket->id;  
   
         # XXX should construct a "new" invoice to pop onto the list  
         next;          next;
     }      }
       my $invoice = $cust->{invoice};
   
     #foreach my $r ($ticket->requestors) {      my $project = make_project( $ticket, $cust );
     #    $users->id( $r );      next unless @{ $project->{fees} } || @{ $project->{expenses} };
     #    $users->retrieve;  
     #    print Dump $users;  
     #}  
   
     my $txns = $ticket->transactions( type => [qw(Comment Correspond)] );      foreach my $fee ( @{ $project->{fees} } ) {
     my $txn_i = $txns->get_iterator;          my $hours = hours_for_date( $invoice, $fee->{date} );
     while ( my $txn = $txn_i->() ) {  
         next unless $txn->time_taken;  
   
         my $work_time = sprintf "%.03f", $txn->time_taken / 60;          my $h_type
         my $work_type = $txn->cf('WorkType');              = exists $hours->{ $fee->{type} }
         my $work_rate = $rates{$work_type} || $rates{default} || 0;              ? $fee->{type}
   
         my $ih_type  
             = exists $included_hours{$work_type}  
             ? $work_type  
             : 'default';              : 'default';
   
         my %fee = (          next unless exists $hours->{$h_type} && $hours->{$h_type} > 0;
             id       => $txn->id,  
             contents => $txn->created . ' ('  
                 . $txn->id . ')' . "\n\n"  
                 . ( $txn->data || $ticket->subject ),  
             count => $work_time,  
             rate  => $work_rate,  
         );  
         if ( $work_type && $work_type ne 'Normal' ) {  
             $fee{detail} = $work_type . ' rate';  
         }  
   
         push @{ $project{fees} }, \%fee;  
   
         next  
             unless $included_hours{$ih_type} && $included_hours{$ih_type} > 0;  
   
         my $discount_time = 0;          my $discount_time = 0;
         if ( $included_hours{$ih_type} > $work_time ) {          if ( $hours->{$h_type} > $fee->{count} ) {
             $included_hours{$ih_type} -= $work_time;              $hours->{$h_type} -= $fee->{count};
             $discount_time = $work_time;              $discount_time = $fee->{count};
         }          }
         else {          else {
             $discount_time = $included_hours{$ih_type};              $discount_time = $hours->{$h_type};
             $included_hours{$ih_type} = 0;              $hours->{$h_type} = 0;
         }          }
   
         if ($discount_time) {          if ($discount_time) {
             $fee{detail} = "$discount_time $work_type Hours Discounted";              $invoice->{discount}{amount} += $discount_time * $fee->{rate};
             $invoice->{discount}{amount} += $discount_time * $fee{rate};              $invoice->{discount}{hours}{$h_type} += $discount_time;
             $invoice->{discount}{hours}{$work_type} += $discount_time;  
         }  
   
         #print Dump $txn; exit;              $h_type = '' if $h_type eq 'default';
               $fee->{detail} = "$discount_time $h_type Hours Discounted";
           }
     }      }
   
     next unless @{ $project{fees} } || @{ $project{expenses} };      print " Added ticket $project->{id}\n";
     print " Added ticket $project{id}\n";      push @{ $invoice->{projects} }, $project;
     push @{ $invoice->{projects} }, \%project;  
 }  }
   
 foreach my $invoice (@invoices) {  while ( my ( $custid, $cust ) = each %{$customers} ) {
       my $invoice = $cust->{invoice};
     next unless $invoice->{projects} && @{ $invoice->{projects} };      next unless $invoice->{projects} && @{ $invoice->{projects} };
   
       my %li = ( custid => $custid, );
   
     foreach my $project ( @{ $invoice->{projects} } ) {      foreach my $project ( @{ $invoice->{projects} } ) {
         print "$project->{title}\n";          print "$project->{title}\n";
           if ( $project->{transactions} ) {
               push @{ $li{transactions} }, @{ $project->{transactions} };
           }
         my $subtotal = 0;          my $subtotal = 0;
         foreach my $fee ( @{ $project->{fees} } ) {          foreach my $fee ( @{ $project->{fees} } ) {
             my $amount = round( $fee->{count} * $fee->{rate} );              my $amount = round( $fee->{count} * $fee->{rate} );
Line 295 
Line 226 
         $invoice->{total_due} = $invoice->{total} + $invoice->{past_due};          $invoice->{total_due} = $invoice->{total} + $invoice->{past_due};
     }      }
   
     $invoice->{id}   = $invoiceid;      # XXX Here we need to "make_address"
     $invoice->{file} = 'invoice_' . $invoiceid . '.pdf';      $invoice->{info} = $config->get('info');
       $invoice->{from} = $config->get('from');
       $invoice->{to}   = $cust->{address};
   
       $state->{lastinvoice}++;
       $invoice->{id}   = $state->{lastinvoice};
       $invoice->{file} = 'invoice_' . $state->{lastinvoice} . '.pdf';
   
       foreach my $k (qw/ transactions /) {
           if    ( $invoice->{$k} ) { $li{$k} = $invoice->{$k} }
           elsif ( $cust->{$k} )    { $li{$k} = $cust->{$k} }
       }
   
       $state->{invoice}->{ $invoice->{end}->ymd }{ $state->{lastinvoice} }
           = \%li;
   
     print "Created Invoice\n";      print "Created Invoice\n";
     print Dump $invoice;      print Dump $cust;
   
       foreach my $key (qw/ start end /) {
           if ( exists $invoice->{$key} ) {
               $invoice->{$key} = $invoice->{$key}->strftime('%B %d, %Y');
           }
       }
   
     my $tt = Template->new;      my $tt = Template->new;
     $tt->process( 'invoice.tex.tt', $invoice, $invoice->{file} )      $tt->process( 'invoice.tex.tt', $invoice, $invoice->{file} )
         or die $tt->error . "\n";          or die $tt->error . "\n";
   
     print "Generated $invoice->{file}\n";      print "Generated $invoice->{file}\n";
   
     $invoiceid++;  
 }  }
   
 # XXX Save State  # XXX Save State
   print Dump $state;
   $state->save;
   
 sub round {  sub round {
     my ($amount) = @_;      my ($amount) = @_;
Line 320 
Line 271 
     return sprintf "%.02f", $amount;      return sprintf "%.02f", $amount;
 }  }
   
   sub find_customer_for_ticket {
       my ( $customers, $ticket ) = @_;
   
   INVOICE: foreach my $cust ( values %{$customers} ) {
           next INVOICE unless $cust->{match};
           foreach my $m ( @{ $cust->{match} } ) {
               my $type = $m->{type};
               my $thing = join ' ', $ticket->$type;
   
               if ( $m->{$type} ) {
                   my $match = lc $m->{$type};
                   next INVOICE unless lc($thing) ~~ $match;
               }
               elsif ( $m->{regex} ) {
                   next INVOICE unless $thing ~~ /\Q$m->{regex}\E/;
               }
               else {
                   warn "Invalid match!";
                   next INVOICE;
               }
           }
           return $cust;
       }
   
       return fake_customer( $customers, $ticket );
   }
   
   sub fake_customer {
       my ( $customers, $ticket ) = @_;
   
       # make the custid the first requestor
       my ($custid) = $ticket->requestors;
       return unless $custid;
   
       my $cust = $config->get('default') || {};
       $cust->{to} = get_requestor($custid);
   
       my %invoice = ( end => DateTime->now );
   
       my $lastinvoice = $state->last_invoice($custid);
       if ( $lastinvoice->{date} ) {
           my $last_invoice_date = ymd_to_DateTime( $lastinvoice->{date} );
           $invoice{start} = $last_invoice_date->clone->add( days => 1 );
       }
   
       if ( !( $invoice{start} && $invoice{start} < $invoice{end} ) ) {
           $cust->{invoice} = \%invoice;
       }
   
       $customers->{$custid} = $cust;
       return $cust;
   }
   
   sub get_requestor {
       my ($id) = @_;
   
       state %requestors;
       return $requestors{$id} if $requestors{$id};
   
       my %map = (
           address_one   => 'addr1',
           address_two   => 'addr2',
           email_address => 'email',
       );
   
       $users->id($id);
       $users->retrieve;
   
       my %requestor;
       foreach my $m ( keys %{ $users->_attributes } ) {
           next unless $users->can($m);
   
           my $v = $users->$m;
           next unless $v;
   
           $m = $map{$m} if exists $map{$m};
   
           $requestor{$m} = $v;
       }
   
       $requestors{$id} = \%requestor;
       return \%requestor;
   }
   
   sub make_project {
       my ( $ticket, $cust ) = @_;
   
       my %project = (
           id     => $ticket->id,
           queue  => $ticket->queue,
           owner  => $ticket->owner,
           title  => $ticket->subject,
           detail => 'Ticket: '
               . $ticket->id
               . ' Queue: '
               . $ticket->queue
               . ' Requestors: '
               . join( ', ', $ticket->requestors ),
           fees     => [],
           expenses => [],
       );
   
       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 );
   
           my $fee = make_fee( $txn, $cust->{rates}, $ticket );
   
           if ( !( $fee->{rate} && $fee->{count} ) ) {
               warn "Invalid Fee, no rate or count";
               next;
           }
   
           my $invoice = $cust->{invoice};
           next
               if $invoice->{start}
                   && $invoice->{start} > $fee->{date};
           next if $invoice->{end} < $fee->{date};
   
           push @{ $project{fees} },         $fee;
           push @{ $project{transactions} }, $txn->id;
       }
   
       return \%project;
   }
   
   sub make_fee {
       my ( $txn, $rates, $ticket ) = @_;
   
       # XXX Only need $ticket for the alternate subject
   
       my $work_time = sprintf "%.03f", $txn->time_taken / 60;
       my $work_type = $txn->cf('WorkType');
   
       my %fee = (
           id       => $txn->id,
           contents => $txn->created . ' ('
               . $txn->id . ')' . "\n\n"
               . ( $txn->data || $ticket->subject ),
           count => $work_time,
           type  => $work_type,
           date  => ymd_to_DateTime( $txn->created ),
           rate  => $rates->{$work_type} || $rates->{default} || 0,
       );
   
       if ( $work_type && $work_type ne 'Normal' ) {
           $fee{detail} = $work_type . ' rate';
       }
   
       return \%fee;
   }
   
   sub hours_for_date {
       my ( $invoice, $date ) = @_;
   
       my $hours = {};
       if ( $invoice->{hours} ) {
           foreach my $h ( @{ $invoice->{hours} } ) {
               next if $h->{start} && $h->{start} > $date;
               next if $h->{end} < $date;
   
               $hours = $h->{hours};
               last;
           }
       }
       return $hours;
   }
   
   sub ymd_to_DateTime {
       my ($ymd) = @_;
       my ( $date, $time ) = split ' ', $ymd;
       my ( $year, $month, $day ) = split '-', $date;
       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,
       );
   }
   
 package RTI::Config;  package RTI::Config;
 use strict;  use strict;
 use warnings;  use warnings;
   
 use 5.010;  use 5.010;
   
 use YAML::Any qw/ LoadFile /;  use YAML::Any qw/ LoadFile Dump Load /;
   use File::Basename;
   
 sub new {  sub new {
     my ( $class, $args ) = @_;      my ( $class, $args ) = @_;
   
     my $self = { file => '', };      my $self = { file => '', };
     bless $self, $class;      bless $self, $class;
   
     my $file = $args->{file} || $self->_find_config;      my $file = $args->{file} || $self->_find_config;
     $self->read_config($file);      $self->read_config($file);
   
Line 344 
Line 483 
   
     # XXX This needs to be better      # XXX This needs to be better
     foreach my $file (qw/ rt_invoice.conf rt_invoice.cfg .rt_invoicerc /) {      foreach my $file (qw/ rt_invoice.conf rt_invoice.cfg .rt_invoicerc /) {
         foreach my $dir ( '.', $ENV{HOME} . '/.rt_invoice', $ENV{HOME} ) {          foreach my $dir ( '.', $ENV{HOME} . '/.rt_invoicing', $ENV{HOME} ) {
             my $path = join '/', $dir, $file;              my $path = join '/', $dir, $file;
             return $path if -e $path;              return $path if -e $path;
         }          }
Line 360 
Line 499 
   
     my $c = LoadFile($file) or die "Unable to load $file\n";      my $c = LoadFile($file) or die "Unable to load $file\n";
   
     $c->{customers} ||= [];      $c->{customers} ||= {};
     if ( $c->{default} ) {      if ( $c->{default} ) {
         foreach my $cust ( @{ $c->{customers} } ) {          foreach my $cust ( values %{ $c->{customers} } ) {
             foreach my $k ( keys %{ $c->{default} } ) {              foreach my $k ( keys %{ $c->{default} } ) {
                 $cust->{$k} //= $c->{default}->{$k};                  $cust->{$k} //= Load( Dump( $c->{default}->{$k} ) );
             }              }
         }          }
     }      }
Line 375 
Line 514 
   
 sub get {  sub get {
     my ( $self, $key ) = @_;      my ( $self, $key ) = @_;
       my $value = Load( Dump( $self->{_config}->{$key} ) );
     # XXX This should deep copy? not a reference would be good      if ( !$value ) {
     return $self->{_config}->{$key};          given ($key) {
               when ('state') {
                   $value = dirname( $self->{file} ) . '/rt_invoice.state'
               }
           }
       }
       return $value;
 }  }
   
 package RTI::State;  package RTI::State;
Line 388 
Line 533 
   
 use YAML::Any qw/ LoadFile DumpFile /;  use YAML::Any qw/ LoadFile DumpFile /;
   
   my $file = '';
   
 sub new {  sub new {
     my ( $class, $args ) = @_;      my $class;
       ( $class, $file ) = @_;
   
     my $self = { file => '', };      my $self = { lastinvoice => 0, };
       if ( -e $file ) {
           $self = LoadFile($file) or die "Unable to load state: $!";
       }
   
     bless $self, $class;      bless $self, $class;
     my $file = $args->{file} || $self->_find_config;  
     $self->read_config($file);  
   
       die "Need to pass filename to new: $!" unless $file;
   
     return $self;      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: $!";
 }  }
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.8
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>