[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.9 and 1.30

version 1.9, 2011/03/22 01:01:53 version 1.30, 2011/05/03 05:41:11
Line 1 
Line 1 
 #!/usr/bin/perl  #!/usr/bin/perl
   # $AFresh1: rt_invoices.pl,v 1.29 2011/05/03 04:38:56 andrew Exp $
   ########################################################################
   # Copyright (c) 2011 Andrew Fresh <andrew@afresh1.com>
   #
   # Permission to use, copy, modify, and distribute this software for any
   # purpose with or without fee is hereby granted, provided that the above
   # copyright notice and this permission notice appear in all copies.
   #
   # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
   # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
   # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
   # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
   # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
   # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
   ########################################################################
 use strict;  use strict;
 use warnings;  use warnings;
   
 use 5.010;  use 5.010;
   
 use YAML::Any;  
 use Template;  use Template;
 use RT::Client::REST;  use RT::Client::REST;
 use RT::Client::REST::Ticket;  use RT::Client::REST::Ticket;
 use RT::Client::REST::User;  use RT::Client::REST::User;
   
   use File::Path;
 use DateTime;  use DateTime;
   
 my $config = RTI::Config->new();  my $config = RTI::Config->new();
Line 21 
Line 37 
     timeout => $rt_conf->{timeout},      timeout => $rt_conf->{timeout},
 );  );
 my $tickets = RT::Client::REST::Ticket->new( rt => $rt );  my $tickets = RT::Client::REST::Ticket->new( rt => $rt );
 my $users = RT::Client::REST::User->new( rt => $rt );  
   
 $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');
 CUSTOMER: while ( my ( $custid, $cust ) = each %{$customers} ) {  
   
     my %invoice = ( end => DateTime->now, );  
   
     if ( $cust->{base_rate} ) {  
         my $day  = $cust->{day}       || 1;  
         my $freq = $cust->{frequency} || 1;  
   
         my $per;  
         my $day_method;  
         given ( $cust->{per} ) {  
             when ('week')  { $per = 'weeks';  $day_method = 'dow' }  
             when ('month') { $per = 'months'; $day_method = 'day' }  
             default { die "Unknown per [$cust->{per}]\n" }  
         }  
   
         my $billends  
             = DateTime->now->set( hour => 0, minute => 0, second => 0 );  
         $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  
             = $freq == 1  
             ? ucfirst( $cust->{per} . 'ly' )  
             : $freq . ' ' . ucfirst( $cust->{per} );  
         $title .= ' Retainer';  
   
         my %project = ( title => $title, fees => [], );  
   
         while ( $date < $billends ) {  
             my $start = $date->clone;  
   
             $date->add( $per => $freq );  
             $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 = (  
                 start => $start->clone,  
                 end   => $end->clone,  
                 hours => { %{ $cust->{hours} } },  
             );  
   
             push @{ $invoice{hours} }, \%hours;  
             push @{ $project{fees} },  
                 {  
                 count    => 1,  
                 rate     => $cust->{base_rate},  
                 contents => $start->ymd . ' to ' . $end->ymd,  
                 };  
   
         }  
   
         if ( @{ $project{fees} } ) {  
             push @{ $invoice{projects} }, \%project;  
         }  
     }  
   
     $cust->{from} ||= get_user($custid);  
     $cust->{invoice} = \%invoice;  
 }  
   
 my @limits = map +{  my @limits = map +{
     attribute  => 'status',      attribute  => 'status',
     operator   => '=',      operator   => '=',
Line 138 
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 );      if ( !$ticket->time_worked ) {
           say "Ticket " . $ticket->id . " has no time worked";
           next;
       }
   
       my $cust = find_customer_for_ticket($ticket);
     if ( !$cust ) {      if ( !$cust ) {
         say "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 $h_type
             = exists $hours->{ $fee->{type} }              = exists $hours->{ $fee->{type} }
Line 173 
Line 119 
         }          }
   
         if ($discount_time) {          if ($discount_time) {
             $invoice->{discount}{amount} += $discount_time * $fee->{rate};              $cust->{invoice}->{discount}->{amount}
             $invoice->{discount}{hours}{$h_type} += $discount_time;                  += round( $discount_time * $fee->{rate} );
               $cust->{invoice}->{discount}->{hours}{$h_type} += $discount_time;
   
             $h_type = '' if $h_type eq 'default';              $h_type = '' if $h_type eq 'default';
             $fee->{detail} = "$discount_time $h_type Hours Discounted";              $fee->{detail} = "$discount_time $h_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, );      my %li = (
           custid  => $cust->{id},
           invdate => DateTime->now( time_zone => 'local' )->ymd,
       );
   
     foreach my $project ( @{ $invoice->{projects} } ) {      foreach my $project ( @{ $invoice->{projects} } ) {
         if ( $project->{transactions} ) {          if ( $project->{transactions} ) {
Line 225 
Line 175 
   
     next unless $invoice->{total} > 0 || $invoice->{total_due};      next unless $invoice->{total} > 0 || $invoice->{total_due};
   
     # XXX Here we need to "make_address"  
     $invoice->{info} = $config->get('info');      $invoice->{info} = $config->get('info');
     $invoice->{from} = $config->get('from');      my $from = $config->get('from');
     $invoice->{to}   = $cust->{address};      $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} = 'invoice_' . $state->{lastinvoice} . '.pdf';      $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 /)
       {
           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 /) {      foreach my $key (qw/ start end /) {
         if ( exists $invoice->{$key} ) {          if ( exists $invoice->{$key} ) {
             $invoice->{$key} = $invoice->{$key}->strftime('%B %d, %Y');              $invoice->{$key} = $invoice->{$key}->strftime('%B %d, %Y');
         }          }
     }      }
   
     foreach my $k (qw/ transactions start end total past_due total_due /) {      my $invoice_dir = $config->get('invoice_dir');
         if    ( $invoice->{$k} ) { $li{$k} = $invoice->{$k} }      File::Path::make_path($invoice_dir);
         elsif ( $cust->{$k} )    { $li{$k} = $cust->{$k} }      my $file = join '/', $invoice_dir, $invoice->{file};
     }  
   
     $state->{invoice}->{ $invoice->{end} }{ $invoice->{id} } = \%li;      my $tt = Template->new( INCLUDE_PATH => $config->get('template_dir'), )
           || die $Template::ERROR, "\n";
   
     my $tt = Template->new;      $tt->process( $config->get('invoice_template'), $invoice, $file )
     $tt->process( 'invoice.tex.tt', $invoice, $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 266 
Line 236 
 }  }
   
 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 ) = @_;  
   
     # make the custid the first requestor  
     my ($custid) = $ticket->requestors;  
     return unless $custid;  
   
     my $cust = $config->get('default') || {};      my $cust = $config->get('default') || {};
     $cust->{to} = get_user($custid);  
   
     my %invoice = ( end => DateTime->now );      ( $cust->{id} ) = $ticket->requestors;
       return unless $cust->{id};
       push @{$customers}, $cust;
   
     my $lastinvoice = $state->last_invoice($custid);      $cust->{match} = [
     if ( $lastinvoice->{date} ) {          {   type  => 'requestors',
         my $last_invoice_date = ymd_to_DateTime( $lastinvoice->{date} );              regex => $cust->{id},
         $invoice{start} = $last_invoice_date->clone->add( days => 1 );          }
     }      ];
   
     if ( !( $invoice{start} && $invoice{start} < $invoice{end} ) ) {  
         $cust->{invoice} = \%invoice;  
     }  
   
     $customers->{$custid} = $cust;  
     return $cust;      return $cust;
 }  }
   
Line 332 
Line 286 
         name          => 'username',          name          => 'username',
     );      );
   
     $users->id($id);      my $users = RT::Client::REST::User->new( rt => $rt, id => $id );
     $users->retrieve;      $users->retrieve;
   
     my %user;      my %user;
Line 351 
Line 305 
     return \%user;      return \%user;
 }  }
   
   sub make_invoice {
       my ($cust) = @_;
   
       my $day  = $cust->{day}       ||= 0;
       my $per  = $cust->{per}       ||= 'week';
       my $freq = $cust->{frequency} ||= 1;
   
       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,
               }
           );
   
           if ( @{ $project->{fees} } ) {
               $invoice{end}   = $project->{end};
               $invoice{hours} = $hours;
               push @{ $invoice{projects} }, $project;
           }
       }
       elsif ( $cust->{hours} ) {
           $invoice{hours} = [
               {   end   => $invoice{end}->clone,
                   hours => $cust->{hours},
               }
           ];
       }
   
       return {} if $invoice{start} && $invoice{end} < $invoice{start};
   
       return \%invoice;
   }
   
   sub make_base_project {
       my ( $cust, $args ) = @_;
   
       my $date    = $args->{date};
       my $billend = $args->{billend};
       my $per     = $args->{per};
       my $freq    = $args->{freq};
   
       my $title
           = $freq == 1
           ? ucfirst( $cust->{per} . 'ly' )
           : $freq . ' ' . ucfirst( $cust->{per} );
       $title .= ' Retainer';
   
       my %project = ( title => $title, start => $date->clone, fees => [], );
       my @hours;
   
       while ( $date < $billend ) {
           my $start = $date->clone;
   
           $date->add( $per => $freq );
   
           my $end = $date->clone->subtract( seconds => 1 );
           $end = $billend->clone->subtract( seconds => 1 ) if $date > $billend;
   
           $project{end} = $end->clone;
   
           push @{ $project{fees} },
               {
               count    => 1,
               rate     => $cust->{base_rate},
               contents => $start->ymd . ' to ' . $end->ymd,
               };
   
           push @hours,
               {
               start => $start->clone,
               end   => $end->clone,
               hours => { %{ $cust->{hours} } },
               };
       }
   
       return \%project, \@hours;
   }
   
   sub make_address {
       my ($addr) = @_;
       my @adr;
   
       $addr = get_user($addr) unless ref $addr;
   
       if ( $addr->{organization} ) {
           push @adr, $addr->{organization};
       }
       elsif ( $addr->{name} && !$addr->{attn} ) {
           push @adr, $addr->{name};
       }
   
       if (   ( $addr->{addr1} || $addr->{addr2} )
           && $addr->{city}
           && $addr->{state}
           && $addr->{zip} )
       {
           push @adr, $addr->{attn}  if $addr->{attn};
           push @adr, $addr->{addr1} if $addr->{addr1};
           push @adr, $addr->{addr2} if $addr->{addr2};
           push @adr,
               $addr->{city} . ', ' . $addr->{state} . '  ' . $addr->{zip};
       }
       else {
           push @adr, $addr->{email} if $addr->{email};
       }
   
       return join "\n\n", @adr;
   }
   
 sub make_project {  sub make_project {
     my ( $ticket, $cust ) = @_;      my ( $ticket, $cust ) = @_;
   
Line 361 
Line 460 
         title  => $ticket->subject,          title  => $ticket->subject,
         detail => 'Ticket: '          detail => 'Ticket: '
             . $ticket->id              . $ticket->id
             . ' Queue: '              . ' Status: '
             . $ticket->queue              . $ticket->status
             . ' Requestors: '              . ' Requestors: '
             . join( ', ', $ticket->requestors ),              . join( ', ', $ticket->requestors ),
         fees     => [],          fees     => [],
Line 383 
Line 482 
         }          }
   
         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;
Line 439 
Line 542 
   
 sub ymd_to_DateTime {  sub ymd_to_DateTime {
     my ($ymd) = @_;      my ($ymd) = @_;
     my ( $date, $time ) = split ' ', $ymd;      my ( $date, $time ) = split /[\sT]/, $ymd;
     my ( $year, $month, $day ) = split '-', $date;      my ( $year, $month, $day ) = split '-', $date;
     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 460 
Line 564 
 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 495 
Line 599 
   
     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 511 
Line 615 
 sub get {  sub get {
     my ( $self, $key ) = @_;      my ( $self, $key ) = @_;
     my $value = Load( Dump( $self->{_config}->{$key} ) );      my $value = Load( Dump( $self->{_config}->{$key} ) );
     if ( !$value ) {  
         given ($key) {      return $value if $value;
             when ('state') {      my ( $volume, $directories, $file )
                 $value = dirname( $self->{file} ) . '/rt_invoice.state'          = 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 $value;
 }  }
   
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.30
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>