367 lines
14 KiB
Perl
Executable file
367 lines
14 KiB
Perl
Executable file
#!/usr/bin/perl
|
|
# Copyright © 2018, Bradley M. Kuhn
|
|
# License: AGPL-3.0-or-later
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
use autodie qw(:all);
|
|
|
|
use Getopt::Long;
|
|
use File::Spec;
|
|
use Date::Manip qw(ParseDate UnixDate);
|
|
|
|
our $RT_CMD;
|
|
require 'rt-helper.pl';
|
|
|
|
my($PAYMENT_DIR, $VERBOSE, $INTERACTIVE, $PAYMENT_NUMBER, $INVOICE_LINE, $INTERN_SUCCESS_FILE,
|
|
$INTERN_FAIL_FILE, $LEDGER_ENTRY_DATE, $SVN_CMD, $ROUND, $TRAVEL_NOTICE_TICKET);
|
|
|
|
###############################################################################
|
|
sub LedgerTagFromTicket($$) {
|
|
my($ticketSpec, $tag) = @_;
|
|
open(my $rtPayFH, "-|", "$RT_CMD", "show", "-f", 'CF.{ledger-tags}', $ticketSpec);
|
|
my $tagValue;
|
|
while (my $tagsLine = <$rtPayFH>) {
|
|
print STDERR "Tag Lookup for \"$ticketSpec\" for \"$tag\", searching this line for it: $tagsLine"
|
|
if ($VERBOSE > 6);
|
|
chomp $tagsLine;
|
|
if ($tagsLine =~ /^(?:\s*|\s*CF[^:]+\s*}\s*:\s*);?$tag\s*:\s*(.+)\s*$/i) {
|
|
$tagValue = $1;
|
|
last;
|
|
}
|
|
}
|
|
close $rtPayFH;
|
|
return $tagValue;
|
|
}
|
|
###############################################################################
|
|
sub AllFormattedLedgerTagFromTicket($) {
|
|
my($ticketSpec) = @_;
|
|
my @tags;
|
|
open(my $rtLedgerTagsFH, "-|", "$RT_CMD", "show", "-f", 'CF.{ledger-tags}', $ticketSpec);
|
|
my $tagValue;
|
|
my $start = 0;
|
|
while (my $tagsLine = <$rtLedgerTagsFH>) {
|
|
$start = 1 if $tagsLine =~ s/^\s*CF.{ledger-tags}\s*:\s+//;
|
|
next unless $start;
|
|
$tagsLine =~ s/^\s*//;
|
|
push(@tags, " $tagsLine");
|
|
}
|
|
close $rtLedgerTagsFH;
|
|
return @tags;
|
|
}
|
|
###############################################################################
|
|
sub GetLinksForTicket($) {
|
|
my($ticketSpec) = @_;
|
|
my @linked;
|
|
open(my $rtLinksFH, "-|", "$RT_CMD", "show", $ticketSpec . '/links');
|
|
while (my $linksLine = <$rtLinksFH>) {
|
|
if ($linksLine =~ m%rt.*(ticket/\d+)\s*,?\s*$%) {
|
|
push(@linked, $1);
|
|
}
|
|
}
|
|
close $rtLinksFH;
|
|
return @linked;
|
|
}
|
|
###############################################################################
|
|
sub FindTaxTicketFromList(@) {
|
|
my $taxTicket;
|
|
foreach my $ticket (@_) {
|
|
open(my $rtQueueFH, "-|", "$RT_CMD", "show", "-f", 'Queue', $ticket);
|
|
while (my $queueLine = <$rtQueueFH>) {
|
|
if ($queueLine =~ /\s*Queue\s*:\s*(\S+)\s*$/) {
|
|
my $queue = $1;
|
|
$taxTicket = $ticket if $queue =~ /accounts-taxinfo/;
|
|
last;
|
|
}
|
|
}
|
|
close $rtQueueFH;
|
|
last if defined $taxTicket;
|
|
}
|
|
return $taxTicket;
|
|
}
|
|
###############################################################################
|
|
sub FindReimbursementTicketFromList(@) {
|
|
my $reimbursementTicket;
|
|
foreach my $ticket (@_) {
|
|
$ticket =~ s%\s*ticket/?\s*(\d+)\s*%$1%;
|
|
open(my $rtReimburseFH, "-|", "$RT_CMD", "ls", "-i", 'Queue = accounts-payable AND ' .
|
|
"AND Subject LIKE '" . $ROUND .
|
|
"' AND (Subject LIKE 'reimbursement' OR Subject LIKE 'travel') and id = " . $ticket);
|
|
while (my $reimburseLine = <$rtReimburseFH>) {
|
|
if ($reimburseLine =~ m%\s*ticket\s*/?\s*(\d+)\s*$%) {
|
|
my $tt = $1;
|
|
if ($tt == $ticket) {
|
|
$reimbursementTicket = $ticket;
|
|
last;
|
|
}
|
|
}
|
|
}
|
|
close $rtReimburseFH;
|
|
last if defined $reimbursementTicket;
|
|
}
|
|
return $reimbursementTicket;
|
|
}
|
|
###############################################################################
|
|
|
|
GetOptions("paymentDir=s" => \$PAYMENT_DIR, "verbose=i" => \$VERBOSE, "interactive" => \$INTERACTIVE,
|
|
"paymentNumber=i" => \$PAYMENT_NUMBER, "rtCommand=s" => \$RT_CMD,
|
|
"invoiceLine=s" => \$INVOICE_LINE, "internSuccessFile=s", \$INTERN_SUCCESS_FILE,
|
|
"internFailFile=s", \$INTERN_FAIL_FILE, 'ledgerEntryDate=s' => \$LEDGER_ENTRY_DATE,
|
|
"svnCommand=s" => \$SVN_CMD, "round=s" => \$ROUND,
|
|
'travelNoticeTicket=i' => \$TRAVEL_NOTICE_TICKET);
|
|
|
|
$RT_CMD = '/usr/bin/rt' unless defined $RT_CMD;
|
|
$SVN_CMD = '/usr/bin/svn' unless defined $SVN_CMD;
|
|
|
|
$INTERACTIVE = 0 if not defined $INTERACTIVE;
|
|
|
|
unless (defined $TRAVEL_NOTICE_TICKET) {
|
|
print STDERR "usage: $0 --travelNoticeTicket=<TICKET_NUMBER> option is required and must be an integer\n";
|
|
exit 1;
|
|
}
|
|
unless (defined $ROUND and $ROUND =~ /^[\d\-]+$/) {
|
|
print STDERR "usage: $0 --round=<YEAR-MONTH> option is required and must formated as YYYY-MM\n";
|
|
exit 1;
|
|
}
|
|
unless (defined $LEDGER_ENTRY_DATE and $LEDGER_ENTRY_DATE =~ /^[\d\-]+$/) {
|
|
print STDERR "usage: $0 --ledgerEntryDate=<DATE> option is required and must be in ISO 8601 format\n";
|
|
exit 1;
|
|
}
|
|
unless (defined $INVOICE_LINE and $INVOICE_LINE =~ /^rt.*/) {
|
|
print STDERR "usage: $0 --invoiceLine=<RT_SPEC> option is required and must match an RT spec\n";
|
|
exit 1;
|
|
}
|
|
unless (defined $PAYMENT_DIR and -d $PAYMENT_DIR) {
|
|
print STDERR "usage: $0 --paymentDir=<DIRECTORY> option is required and directory must exist\n";
|
|
exit 1;
|
|
}
|
|
unless (-r $INTERN_SUCCESS_FILE and -f $INTERN_SUCCESS_FILE) {
|
|
print STDERR "usage: $0 --internUpdateFile=<FILE> option is required and must be readible text file\n";
|
|
exit 1;
|
|
}
|
|
unless (-r $INTERN_FAIL_FILE and -f $INTERN_FAIL_FILE) {
|
|
print STDERR "usage: $0 --internFailFile=<FILE> option is required and must be readible text file\n";
|
|
exit 1;
|
|
}
|
|
my %internCorrespond = ('success' => [], 'failed' => [] );
|
|
open (my $internUpdateFH, "<", File::Spec->catfile($PAYMENT_DIR, $INTERN_SUCCESS_FILE));
|
|
while (my $line = <$internUpdateFH>) {
|
|
push(@{$internCorrespond{success}}, $line);
|
|
}
|
|
my @internFailData;
|
|
open (my $internFailFH, "<", File::Spec->catfile($PAYMENT_DIR, $INTERN_FAIL_FILE));
|
|
while (my $line = <$internFailFH>) {
|
|
push(@{$internCorrespond{failed}}, $line);
|
|
}
|
|
unless (defined $PAYMENT_NUMBER and $PAYMENT_NUMBER =~ /^[123]$/) {
|
|
print STDERR "usage: $0 --paymentNumber=<VALUE> option is required and must be 1, 2 or 3\n";
|
|
exit 1;
|
|
}
|
|
$VERBOSE = 0 unless defined $VERBOSE;
|
|
|
|
opendir(my $dh, $PAYMENT_DIR);
|
|
|
|
my $oldInterns = 0;
|
|
|
|
while (my $file = readdir $dh) {
|
|
unless ($file =~ /^\s*(success|faile?d?)-(\S+)\.txt\s*$/i) {
|
|
print STDERR "Skipping $file which does not match proper format...\n" if ($VERBOSE >= 2);
|
|
next;
|
|
}
|
|
my($pass, $name) = ($1, $2);
|
|
$pass = ($pass =~ /success/) ? 1 : 0;
|
|
|
|
open(my $fh, "<", File::Spec->catfile($PAYMENT_DIR, $file));
|
|
my $mentorDate;
|
|
while (my $line = <$fh> ) {
|
|
if ($line =~ /^\s*Date\s*:\s*(.+)\s*$/) {
|
|
$mentorDate = UnixDate(ParseDate($1), "%Y-%m-%d");
|
|
next;
|
|
}
|
|
}
|
|
if (not defined $mentorDate) {
|
|
print STDERR "\"$file\": Skipping: Inside that file there is no valid Date: header" ;
|
|
next;
|
|
}
|
|
|
|
my(@nameComponents) = split(/\s*-\s*/, $name);
|
|
my(@searchTerms);
|
|
foreach my $name (@nameComponents) {
|
|
push(@searchTerms, 'Subject LIKE "' . $name . '"');
|
|
}
|
|
# Find the ticket number for this intern.
|
|
my $ticket = Outreachy_FindUniqueTicket($ROUND, @searchTerms);
|
|
if (not defined $ticket) {
|
|
foreach my $term (@searchTerms) {
|
|
$ticket = Outreachy_FindUniqueTicket(($term));
|
|
last if (defined $ticket);
|
|
}
|
|
}
|
|
if (not defined $ticket) {
|
|
if (not $INTERACTIVE) {
|
|
print STDERR "\"$file\": TICKET-NOT-FOUND: Skipped: unable to to find a matching ticket.\n";
|
|
next;
|
|
} else {
|
|
# FIXME: prompt for ticket
|
|
die "interactive mode not yet supported";
|
|
}
|
|
}
|
|
my $completedInternshipField = GetCustomFieldForTicket($ticket, "completed-internship");
|
|
if (not defined $completedInternshipField) {
|
|
print STDERR "\"$file\": \"$ticket\": FIELD-NOT-FOUND: Skipping: cannot determine Entity from ticket.\n" ;
|
|
next;
|
|
} elsif ($completedInternshipField eq 'successful') {
|
|
# Don't print to STDERR here, just keep a count since these are "old interns"
|
|
$oldInterns++;
|
|
next;
|
|
}
|
|
my $entity = LedgerTagFromTicket($ticket, 'Entity');
|
|
if (not defined $entity) {
|
|
print STDERR "\"$file\": \"$ticket\": ENTITY-NOT-FOUND: Skipping: cannot determine Entity from ticket.\n" ;
|
|
next;
|
|
}
|
|
|
|
if ($PAYMENT_NUMBER <= 1) {
|
|
print STDERR "Sorry, script does not yet support first payment\n";
|
|
exit 1;
|
|
}
|
|
# Check to see if this payment was already made
|
|
my $thisPayDate = PaymentDateByTicket($ticket, $PAYMENT_NUMBER);
|
|
if (defined $thisPayDate) {
|
|
print STDERR "\"$file\": \"$ticket\": Skipped: payment $PAYMENT_NUMBER",
|
|
" was already made on \"$thisPayDate\"";
|
|
if ($pass) {
|
|
print STDERR ".\n";
|
|
} else {
|
|
print STDERR "... BIG PROBLEM: the intern actually failed but got this payment.\n";
|
|
}
|
|
next;
|
|
}
|
|
# Check to see if previous payment was sent payment
|
|
my $prevPayNum = $PAYMENT_NUMBER - 1;
|
|
|
|
my $lastPayDate = PaymentDateByTicket($ticket, $prevPayNum);
|
|
if (not defined $lastPayDate) {
|
|
print STDERR "\"$file\": \"$ticket\": Skipped: payment $prevPayNum was not made yet";
|
|
if ($pass) {
|
|
print STDERR ".\n";
|
|
} else {
|
|
print STDERR "... NOTE: previous payment was not sent; should it be sent now?\n";
|
|
}
|
|
next;
|
|
}
|
|
my $expectVal = 'payment-' . $PAYMENT_NUMBER . "-approved";
|
|
if ($completedInternshipField eq $expectVal) {
|
|
print STDERR "\"$file\": \"$ticket\": $PAYMENT_NUMBER PAYMENT-DONE: Skipped: completed-internship is ",
|
|
"\"$completedInternshipField\" which indicates this payment round is in process.\n";
|
|
next;
|
|
}
|
|
$expectVal = 'payment-' . $prevPayNum . "-approved";
|
|
if ($completedInternshipField ne $expectVal) {
|
|
print STDERR "\"$file\": \"$ticket\": Skipped: completed-internship field was ",
|
|
"\"$completedInternshipField\" instead of \"$expectVal\".\n";
|
|
next;
|
|
}
|
|
|
|
my(@links) = GetLinksForTicket($ticket);
|
|
if ($VERBOSE > 5) {
|
|
print STDERR "\"$file\": \"$ticket\": Found the following links: " , join( ", ", @links), "\n";
|
|
}
|
|
my $taxTicket = FindTaxTicketFromList(@links);
|
|
if (not defined $taxTicket) {
|
|
print STDERR "\"$file\": \"$ticket\": Skipped: no tax ticket found.\n";
|
|
next;
|
|
}
|
|
my $reimbursementTicket = FindReimbursementTicketFromList(@links);
|
|
if (not defined $reimbursementTicket) {
|
|
print STDERR "\"$file\": \"$ticket\": Skipped: no reimbursement ticket found.\n";
|
|
next;
|
|
}
|
|
print STDERR "\"$file\": \"$ticket\": found a tax ticket of \"$taxTicket\"\n" if ($VERBOSE > 5);
|
|
my $taxTicketStatus = GetStatusFromTicket($taxTicket);
|
|
if ($taxTicketStatus ne "resolved") {
|
|
print STDERR "\"$file\": \"$ticket\": TAX-TICKET-PENDING: \"$taxTicket\": Skipped: ",
|
|
"tax ticket is in status \"$taxTicketStatus\" instead of \"resolved\"\n";
|
|
next;
|
|
}
|
|
my $mainTicketStatus = GetStatusFromTicket($ticket);
|
|
if ($mainTicketStatus ne "needs-project-ok") {
|
|
print STDERR "\"$file\": \"$ticket\": PREV-PAYMENT-INCOMPLETE: Skipped: ",
|
|
"ticket is in status \"$mainTicketStatus\" instead of \"needs-project-ok\"\n";
|
|
next;
|
|
}
|
|
print STDERR "\"$file\": \"$ticket\": processing to payment $PAYMENT_NUMBER state... ";
|
|
my $successString = ($pass) ? "success" : "failed";
|
|
my $repositoryFile = File::Spec->catfile($PAYMENT_DIR, $mentorDate . "_" . $entity . '_' . $successString . '-report.mbox');
|
|
my $approvalTag = $repositoryFile;
|
|
$approvalTag =~ s%^.*(Projects/Outreachy/.*)$%$1%;
|
|
$approvalTag = " ;Approval: $approvalTag";
|
|
|
|
rename(File::Spec->catfile($PAYMENT_DIR, $file), $repositoryFile);
|
|
system($SVN_CMD, "add", $repositoryFile);
|
|
open(my $rtCorrespondFH, "|-", $RT_CMD, 'correspond', $ticket, '-m', '-');
|
|
my @dd;
|
|
foreach my $line (@{$internCorrespond{$successString}}) {
|
|
$line =~ s/FIXME_PAYMENT_NUMBER/$PAYMENT_NUMBER/g;
|
|
$line =~ s/FIXME_INVOICE_DATE/$LEDGER_ENTRY_DATE/g;
|
|
$line =~ s/FIXME_MENTOR_DATE/$mentorDate/g;
|
|
push(@dd, $line);
|
|
}
|
|
print $rtCorrespondFH @dd;
|
|
close $rtCorrespondFH;
|
|
|
|
my $invoiceTicket = $INVOICE_LINE;
|
|
$invoiceTicket =~ s%^.*ticket/(\d+).*$%$1%;
|
|
my $num = $ticket; $num =~ s%^.*ticket/(\d+).*$%$1%;
|
|
system($RT_CMD, 'link', $invoiceTicket, 'refersto', $num);
|
|
|
|
if ($pass) {
|
|
open(my $rtCommentFH, "|-", $RT_CMD, 'comment', $ticket, '-m', '-');
|
|
print $rtCommentFH " ;Invoice: $INVOICE_LINE\n";
|
|
close $rtCommentFH;
|
|
system($RT_CMD, "edit", $ticket, 'set', 'CF.{completed-internship}=payment-' . $PAYMENT_NUMBER . '-approved',
|
|
'Status=open');
|
|
my($leftA, $rightA);
|
|
if ($PAYMENT_NUMBER == 1) {
|
|
$leftA = ' $-500.00'; $rightA = ' $500.00';
|
|
} elsif ($PAYMENT_NUMBER == 2) {
|
|
$leftA = '$-2,250.00'; $rightA = '$2,250.00';
|
|
} elsif ($PAYMENT_NUMBER == 3) {
|
|
$leftA = '$-2,750.00'; $rightA = '$2,750.00';
|
|
}
|
|
my(@tags) = AllFormattedLedgerTagFromTicket($ticket);
|
|
open(my $ledgerEntryFH, ">>", File::Spec->catfile($PAYMENT_DIR, "entry.ledger"));
|
|
print $ledgerEntryFH <<LEDGER_ENTRY
|
|
|
|
$LEDGER_ENTRY_DATE FIXME - Outreachy Internship - Round 2018-05 - Payment 2
|
|
@tags ;Invoice: $INVOICE_LINE
|
|
$approvalTag
|
|
Accrued:Accounts Payable:Outreachy $leftA
|
|
Expenses:Outreachy:Internships $rightA
|
|
LEDGER_ENTRY
|
|
;
|
|
close $ledgerEntryFH;
|
|
} else {
|
|
system($RT_CMD, "edit", $ticket, 'set', 'CF.{completed-internship}=unsuccessful');
|
|
if ($PAYMENT_NUMBER == 1) {
|
|
system($RT_CMD, "edit", $taxTicketStatus, 'set', 'Status=rejected');
|
|
system($RT_CMD, "edit", $ticket, 'set', 'Status=rejected');
|
|
} else {
|
|
system($RT_CMD, "edit", $ticket, 'set', 'Status=entered');
|
|
}
|
|
system($RT_CMD, "link", '-d', $reimbursementTicket, 'dependson', $TRAVEL_NOTICE_TICKET);
|
|
system($RT_CMD, "edit", $reimbursementTicket, 'set', 'Status=open');
|
|
system($RT_CMD, "edit", $reimbursementTicket, 'set', 'Status=rejected');
|
|
}
|
|
print STDERR "...done\n";
|
|
print STDERR "Waiting? ";
|
|
my $x = <STDIN>;
|
|
}
|
|
print STDERR "Old Interns, who were marked as successful (likely from previous interns) ignored: $oldInterns\n";
|
|
###############################################################################
|
|
#
|
|
# Local variables:
|
|
# compile-command: "perl -c rt-outreachy-payment-next.plx"
|
|
# perl-indent-level: 2
|
|
# End:
|