[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.18 and 1.38

version 1.18, 2011/03/22 05:55:27 version 1.38, 2011/06/21 01:20:28
Line 1 
Line 1 
 #!/usr/bin/perl  #!/usr/bin/perl
 # $AFresh1$  # $AFresh1: rt_invoices.pl,v 1.37 2011/05/26 01:09:36 andrew Exp $
 ########################################################################  ########################################################################
 # Copyright (c) 2011 Andrew Fresh <andrew@afresh1.com>  # Copyright (c) 2011 Andrew Fresh <andrew@afresh1.com>
 #  #
Line 40 
Line 40 
   
 $rt->login( username => $rt_conf->{user}, password => $rt_conf->{pass} );  $rt->login( username => $rt_conf->{user}, password => $rt_conf->{pass} );
   
   #use YAML;
 #print Dump $config, $state; exit;  #print Dump $config, $state; exit;
   
 my $startdate;  my $startdate;
   
 my $customers = $config->get('customers');  my $customers = $config->get('customers');
 while ( my ( $custid, $cust ) = each %{$customers} ) {  
     $cust->{id} = $custid;  
   
     if ( my $invoice = make_invoice($cust) ) {  
         $cust->{invoice} = $invoice;  
     }  
 }  
   
 my @limits = map +{  my @limits = map +{
     attribute  => 'status',      attribute  => 'status',
     operator   => '=',      operator   => '=',
Line 82 
Line 76 
   
 my $iterator = $results->get_iterator;  my $iterator = $results->get_iterator;
 while ( my $ticket = &$iterator ) {  while ( my $ticket = &$iterator ) {
     my $cust = find_customer_for_ticket( $customers, $ticket );      my $cust = find_customer_for_ticket($ticket);
     if ( !$cust ) {      if ( !$cust ) {
         warn "No customer found for ticket " . $ticket->id;          warn "No customer found for ticket " . $ticket->id;
         next;          next;
     }      }
     if ( !$cust->{invoice} ) {  
   
         #say "Customer has no open invoices for ticket " . $ticket->id;      say 'Ticket ' . $ticket->id . " belongs to $cust->{id}";
   
       $cust->{invoice} ||= make_invoice($cust);
       if ( !$cust->{invoice}->{end} ) {
           say "  $cust->{id} has no open invoices [" . $ticket->id . ']';
         next;          next;
     }      }
     my $invoice = $cust->{invoice};  
   
     my $project = make_project( $ticket, $cust );      my $project = make_project( $ticket, $cust );
     next unless @{ $project->{fees} } || @{ $project->{expenses} };      next unless @{ $project->{fees} } || @{ $project->{expenses} };
   
     foreach my $fee ( @{ $project->{fees} } ) {      foreach my $fee ( @{ $project->{fees} } ) {
         my $hours = hours_for_date( $invoice, $fee->{date} );          my $hours = hours_for_date( $cust->{invoice}, $fee->{date} );
   
         my $h_type          my $type  = 'unknown';
             = exists $hours->{ $fee->{type} }          my $count = $fee->{count};
             ? $fee->{type}          while ( $type && $count > 0 && $type ne 'default' ) {
             : '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;              my $discount_time = 0;
         if ( $hours->{$h_type} > $fee->{count} ) {              if ( $hours->{$type} > $count ) {
             $hours->{$h_type} -= $fee->{count};                  $hours->{$type} -= $count;
             $discount_time = $fee->{count};                  $discount_time = $count;
         }              }
         else {              else {
             $discount_time = $hours->{$h_type};                  $discount_time = $hours->{$type};
             $hours->{$h_type} = 0;                  $hours->{$type} = 0;
         }              }
   
         if ($discount_time) {              if ($discount_time) {
             $invoice->{discount}{amount}                  $cust->{invoice}->{discount}->{amount}
                 += round( $discount_time * $fee->{rate} );                      += round( $discount_time * $fee->{rate} );
             $invoice->{discount}{hours}{$h_type} += $discount_time;                  $cust->{invoice}->{discount}->{hours}{$type}
                       += $discount_time;
   
             $h_type = '' if $h_type eq 'default';                  $type = '' if $type eq 'default';
             $fee->{detail} = "$discount_time $h_type Hours Discounted";                  $count -= $discount_time;
                   $fee->{detail} .= " $discount_time $type Hours Discounted";
               }
         }          }
     }      }
   
     push @{ $invoice->{projects} }, $project;      push @{ $cust->{invoice}->{projects} }, $project;
 }  }
   
 while ( my ( $custid, $cust ) = each %{$customers} ) {  foreach my $cust ( @{$customers} ) {
     my $invoice = $cust->{invoice};      my $invoice = $cust->{invoice};
     next unless $invoice->{projects} && @{ $invoice->{projects} };      next unless $invoice && $invoice->{projects} && @{ $invoice->{projects} };
   
     my %li = ( custid => $custid, invdate => DateTime->now->ymd, );      my %li = (
           custid       => $cust->{id},
           invdate      => DateTime->now( time_zone => 'local' )->ymd,
           transactions => [],
       );
   
       my %transactions;
     foreach my $project ( @{ $invoice->{projects} } ) {      foreach my $project ( @{ $invoice->{projects} } ) {
         if ( $project->{transactions} ) {          if ( $project->{transactions} ) {
             push @{ $li{transactions} }, @{ $project->{transactions} };              %transactions = ( %transactions, %{ $project->{transactions} } );
         }          }
         my $subtotal = 0;          my $subtotal = 0;
         foreach my $fee ( @{ $project->{fees} } ) {          foreach my $fee ( @{ $project->{fees} } ) {
Line 151 
Line 156 
         $project->{total} = $subtotal;          $project->{total} = $subtotal;
         $invoice->{total} += $subtotal;          $invoice->{total} += $subtotal;
     }      }
       @{ $li{transactions} } = sort { $a <=> $b } keys %transactions;
   
     if ( $invoice->{discount} ) {      if ( $invoice->{discount} ) {
         my $c = "Included Hours\n";          my $c = "Included Hours\n";
         if ( $invoice->{discount}{hours} ) {          if ( $invoice->{discount}{hours} ) {
             foreach my $t ( keys %{ $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 .= 's' if $invoice->{discount}{hours}{$t} != 1;
                 $c .= "\n";                  $c .= "\n";
             }              }
Line 172 
Line 179 
     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');
     $invoice->{from} = make_address( $config->get('from') );      my $from = $config->get('from');
     $invoice->{to}   = make_address( $cust->{address} || $custid );      $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} );
   
     $state->{lastinvoice}++;      $state->{lastinvoice}++;
     $invoice->{id} = $state->{lastinvoice};      $invoice->{id}   = $state->{lastinvoice};
     $invoice->{file} = sprintf 'invoice_%06d.pdf', $state->{lastinvoice};      $invoice->{file} = sprintf 'invoice_%06d.pdf', $state->{lastinvoice};
       $invoice->{logo} = $config->get('logo');
   
     foreach my $k (qw/ file transactions start end total past_due total_due /)      foreach my $k (qw/ file transactions start end total past_due total_due /)
     {      {
Line 206 
Line 218 
     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};
   
     my $tt = Template->new;      my $tt = Template->new( INCLUDE_PATH => $config->get('template_dir'), )
     $tt->process( 'invoice.tex.tt', $invoice, $file )          || die $Template::ERROR, "\n";
   
       $tt->process( $config->get('invoice_template'), $invoice, $file )
         or die $tt->error . "\n";          or die $tt->error . "\n";
   
     printf "Generated %s for %s: \$%.02f\n", $invoice->{file}, $custid,      printf "Generated %s for %s: \$%.02f\n", $invoice->{file}, $cust->{id},
         $invoice->{total};          $invoice->{total};
 }  }
   
Line 225 
Line 239 
 }  }
   
 sub find_customer_for_ticket {  sub find_customer_for_ticket {
     my ( $customers, $ticket ) = @_;      my ($ticket) = @_;
   
 INVOICE: foreach my $cust ( values %{$customers} ) {      foreach my $cust ( @{$customers} ) {
         next INVOICE unless $cust->{match};          next unless $cust->{match};
         foreach my $m ( @{ $cust->{match} } ) {          foreach my $m ( @{ $cust->{match} } ) {
             my $type = $m->{type};              my $type = $m->{type};
             my $thing = join ' ', $ticket->$type;              my $match
                   = exists $m->{$type}
                   ? lc( $m->{$type} )
                   : qr/\Q$m->{regex}\E/;
               my $thing = [ map {lc} $ticket->$type ];
   
             if ( $m->{$type} ) {              if ( !$match ) {
                 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!";                  warn "Invalid match!";
                 next INVOICE;                  next;
             }              }
               return $cust if ( $match ~~ $thing );
         }          }
         return $cust;  
     }      }
   
     return fake_customer( $customers, $ticket );      # Fake customer if we didn't find one
 }  
   
 sub fake_customer {  
     my ( $customers, $ticket ) = @_;  
   
     my $cust = $config->get('default') || {};      my $cust = $config->get('default') || {};
   
     ( $cust->{id} ) = $ticket->requestors;      ( $cust->{id} ) = $ticket->requestors;
     return unless $cust->{id};      return unless $cust->{id};
       push @{$customers}, $cust;
   
     $cust->{match} = [      $cust->{match} = [
         {   type  => 'requestors',          {   type  => 'requestors',
Line 265 
Line 272 
         }          }
     ];      ];
   
     if ( my $invoice = make_invoice($cust) ) {  
         $cust->{invoice} = $invoice;  
     }  
   
     $customers->{ $cust->{id} } = $cust;  
     return $cust;      return $cust;
 }  }
   
Line 309 
Line 311 
 sub make_invoice {  sub make_invoice {
     my ($cust) = @_;      my ($cust) = @_;
   
     my $day  = $cust->{day}       ||= 1;      my $day  = $cust->{day}       ||= 0;
     my $per  = $cust->{per}       ||= 'week';      my $per  = $cust->{per}       ||= 'week';
     my $freq = $cust->{frequency} ||= 1;      my $freq = $cust->{frequency} ||= 1;
   
Line 320 
Line 322 
         default { die "Unknown per [$per]\n" }          default { die "Unknown per [$per]\n" }
     }      }
   
     my $billends = DateTime->now->set( hour => 0, minute => 0, second => 0 );      my $billend = DateTime->now( time_zone => 'local' )
           ->set( hour => 0, minute => 0, second => 0 );
   
     # XXX This is helpful, but monthly and billday > 28 == !!!      # XXX This is helpful, but monthly and billday > 28 == !!!
     $billends->subtract( days => 1 ) while $billends->$day_method != $day;      $billend->subtract( days => 1 )
           while $day && $billend->$day_method != $day;
   
     my $date = $billends->clone->subtract( $per => $freq );      my $date = $billend->clone->subtract( $per => $freq );
       my %invoice = ( end => $billend->clone->subtract( seconds => 1 ) );
   
     my %invoice = ( end => $billends->clone->subtract( seconds => 1 ) );  
   
     my $lastinvoice = $state->last_invoice( $cust->{id} );      my $lastinvoice = $state->last_invoice( $cust->{id} );
     if ( $lastinvoice->{date} ) {      if ( $lastinvoice->{date} ) {
         my $last_invoice_date = ymd_to_DateTime( $lastinvoice->{date} );          my $last_invoice_date = ymd_to_DateTime( $lastinvoice->{date} );
Line 340 
Line 343 
             if !$startdate || $startdate > $date;              if !$startdate || $startdate > $date;
     }      }
   
     return if $billends <= $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,
             {   startdate  => $date,              {   date    => $date,
                 enddate    => $billends,                  billend => $billend,
                 per        => $per,                  per     => $per,
                 freq       => $freq,                  freq    => $freq,
                 day        => $day,  
                 day_method => $day_method,  
             }              }
         );          );
   
Line 368 
Line 372 
         ];          ];
     }      }
   
     return if $invoice{start} && $invoice{end} < $invoice{start};      return {} if $invoice{start} && $invoice{end} < $invoice{start};
   
     return \%invoice;      return \%invoice;
 }  }
Line 376 
Line 380 
 sub make_base_project {  sub make_base_project {
     my ( $cust, $args ) = @_;      my ( $cust, $args ) = @_;
   
     my $date       = $args->{startdate};      my $date    = $args->{date};
     my $enddate    = $args->{enddate};      my $billend = $args->{billend};
     my $per        = $args->{per};      my $per     = $args->{per};
     my $freq       = $args->{freq};      my $freq    = $args->{freq};
     my $day        = $args->{day};  
     my $day_method = $args->{day_method};  
   
     my $title      my $title
         = $freq == 1          = $freq == 1
Line 392 
Line 394 
     my %project = ( title => $title, start => $date->clone, fees => [], );      my %project = ( title => $title, start => $date->clone, fees => [], );
     my @hours;      my @hours;
   
     while ( $date < $enddate ) {      while ( $date < $billend ) {
         my $start = $date->clone;          my $start = $date->clone;
   
         $date->add( $per => $freq );          $date->add( $per => $freq );
         $date = $enddate->clone if $date > $enddate;  
   
         # 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 );          my $end = $date->clone->subtract( seconds => 1 );
           $end = $billend->clone->subtract( seconds => 1 ) if $date > $billend;
   
         last if $end < $start;  
   
         $project{end} = $end->clone;          $project{end} = $end->clone;
   
         push @{ $project{fees} },          push @{ $project{fees} },
Line 477 
Line 474 
     my $txns = $ticket->transactions( type => [qw(Comment Correspond)] );      my $txns = $ticket->transactions( type => [qw(Comment Correspond)] );
     my $txn_i = $txns->get_iterator;      my $txn_i = $txns->get_iterator;
     while ( my $txn = $txn_i->() ) {      while ( my $txn = $txn_i->() ) {
         next unless $txn->time_taken;  
         next if $state->txn_is_invoiced( $txn->id );          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 );          my $fee = make_fee( $txn, $cust->{rates}, $ticket );
   
         if ( !( $fee->{rate} && $fee->{count} ) ) {          if ( !( $fee->{rate} && $fee->{count} ) ) {
Line 488 
Line 491 
         }          }
   
         my $invoice = $cust->{invoice};          my $invoice = $cust->{invoice};
         next          if ( $invoice->{start} && $invoice->{start} > $fee->{date} ) {
             if $invoice->{start}              warn "Ticket "
                 && $invoice->{start} > $fee->{date};                  . $ticket->id
                   . " has uninvoiced Transaction "
                   . $txn->id . "\n";
               next;
           }
         next if $invoice->{end} < $fee->{date};          next if $invoice->{end} < $fee->{date};
   
         push @{ $project{fees} },         $fee;          push @{ $project{fees} }, $fee;
         push @{ $project{transactions} }, $txn->id;          $project{transactions}{ $txn->id } = 1;
     }      }
   
     return \%project;      return \%project;
Line 508 
Line 515 
     my $work_time = sprintf "%.03f", $txn->time_taken / 60;      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 ) {
   
           # XXX Do something special for onsite activities
       }
   
       $work_type =~ s/^\s+|\s+$//g;
       $work_type ||= 'Normal';
   
     my %fee = (      my %fee = (
         id       => $txn->id,          id       => $txn->id,
         contents => $txn->created . ' ('          contents => $txn->created . ' ('
Line 526 
Line 541 
     return \%fee;      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 {  sub hours_for_date {
     my ( $invoice, $date ) = @_;      my ( $invoice, $date ) = @_;
   
Line 549 
Line 583 
     my ( $hour, $minute, $second ) = split ':', $time if $time;      my ( $hour, $minute, $second ) = split ':', $time if $time;
   
     return DateTime->new(      return DateTime->new(
         year   => $year,          year      => $year,
         month  => $month,          month     => $month,
         day    => $day,          day       => $day,
         hour   => $hour || 0,          hour      => $hour || 0,
         minute => $minute || 0,          minute    => $minute || 0,
         second => $second || 0,          second    => $second || 0,
           time_zone => 'local',
     );      );
 }  }
   
Line 565 
Line 600 
 use 5.010;  use 5.010;
   
 use YAML::Any qw/ LoadFile Dump Load /;  use YAML::Any qw/ LoadFile Dump Load /;
 use File::Basename;  use File::Spec;
   
 sub new {  sub new {
     my ( $class, $args ) = @_;      my ( $class, $args ) = @_;
Line 600 
Line 635 
   
     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 ( values %{ $c->{customers} } ) {          foreach my $cust ( @{ $c->{customers} } ) {
             foreach my $k ( keys %{ $c->{default} } ) {              foreach my $k ( keys %{ $c->{default} } ) {
                 $cust->{$k} //= Load( Dump( $c->{default}->{$k} ) );                  $cust->{$k} //= Load( Dump( $c->{default}->{$k} ) );
             }              }
Line 618 
Line 653 
     my $value = Load( Dump( $self->{_config}->{$key} ) );      my $value = Load( Dump( $self->{_config}->{$key} ) );
   
     return $value if $value;      return $value if $value;
       my ( $volume, $directories, $file )
           = File::Spec->splitpath( File::Spec->rel2abs( $self->{file} ) );
   
     given ($key) {      given ($key) {
         when ('state') {          when ('state') {
Line 625 
Line 662 
             $value =~ s/(?:\.[^.]+)?$/\.state/;              $value =~ s/(?:\.[^.]+)?$/\.state/;
         }          }
         when ('invoice_dir') {          when ('invoice_dir') {
             $value = dirname( $self->{file} ) . '/invoices';              $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' );
         }          }
     }      }
   
Legend:
Removed from v.1.18  
changed lines
  Added in v.1.38
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>