source: trunk/check-links.pl @ 7668

#!/usr/bin/perl
use strict;

# check-links.pl - Verifies existence and correctness of source code links.

my $cmd = "find legacy projects -name '*.java'";
my @src = `$cmd`;
my $allOK = 1;

for my $f (@src) {
  chop $f;

  open FILE, "$f" or die "$f: $!";
  my @lines = <FILE>;
  close(FILE);

  my $tracActual = '';
  my $svnActual = '';
  my $tagIndex = 0;
  my $codeIndex = 0;
  my $lineNo = 0;
  for my $line (@lines) {
    chop $line;
    $lineNo++;
    if ($line =~ />Trac</) {
      $tracActual = $line;
      $tracActual =~ s/.*(http:.*)".*/$1/;
      $codeIndex = $lineNo;
    }
    elsif ($line =~ />SVN</) {
      $svnActual = $line;
      $svnActual =~ s/.*(http:.*)".*/$1/;
      $codeIndex = $lineNo;
    }
    elsif ($line =~ /^ \* @/ && $tagIndex == 0) {
      $tagIndex = $lineNo;
    }
  }

  # check header
  my $headerOK = 1;
  my $filename = $f;
  $filename =~ s/.*\///;
  my $headerExpected = "// $filename";
  my $headerActual = $headerExpected;
  if ($lines[0] ne '//' || $lines[1] ne $headerExpected || $lines[2] ne '//') {
    $headerOK = 0;
  }

  # check comment annotations
  my $commentOK = 1;
  if ($tagIndex > 0 && $tagIndex < $codeIndex) {
    $commentOK = 0;
  }

  my $tracExpected = "http://dev.loci.wisc.edu/trac/software/browser/trunk/$f";
  my $svnExpected = "http://dev.loci.wisc.edu/svn/software/trunk/$f";

  if (!$headerOK || !$commentOK || $tracActual ne $tracExpected ||
    $svnActual ne $svnExpected)
  {
    print "$f:\n";
    $allOK = 0;
  }

  if (!$headerOK) {
    print "  incorrect header\n";
  }
  if (!$commentOK) {
    print "  misplaced comment annotation\n";
  }
  if ($tracActual eq '') {
    print "  no Trac link (should be $tracExpected)\n";
  }
  elsif ($tracActual ne $tracExpected) {
    print "  wrong Trac link: $tracActual\n";
    #my $tracSed = $tracExpected;
    #$tracSed =~ s/\//\\\//g;
    #`sed -i '' -e "s/http.*>Trac<\\\/a>/$tracSed\\\">Trac<\\\/a>/" $f`;
    #print "  fixed wrong Trac link\n";
  }
  if ($svnActual eq '') {
    print "  no SVN link (should be $svnExpected)\n";
  }
  elsif ($svnActual ne $svnExpected) {
    print "  wrong SVN link: $svnActual\n";
    #my $svnSed = $svnExpected;
    #$svnSed =~ s/\//\\\//g;
    #`sed -i '' -e "s/http.*>SVN<\\\/a>/$svnSed\\\">SVN<\\\/a>/" $f`;
    #print "  fixed wrong SVN link\n";
  }
}

if ($allOK) {
  print "All source files OK!\n";
}