licenses.c

Go to the documentation of this file.

/*
 SPDX-FileCopyrightText: © 2006-2013 Hewlett-Packard Development Company, L.P.
 
 SPDX-License-Identifier: GPL-2.0-only
*/
/* Equivalent to core nomos v1.48 */
 
#define _GNU_SOURCE
 
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include <time.h>
#include <signal.h>
#include <libgen.h>
#include <limits.h>
#include <stdlib.h>
 
#include "nomos.h"
#include "licenses.h"
#include "nomos_utils.h"
#include "util.h"
#include "list.h"
#include "nomos_regex.h"
#include "parse.h"
#include <_autodefs.h>
 
#define HASHES    "#####################"
#define DEBCPYRIGHT "debian/copyright"
 
static void makeLicenseSummary(list_t *, int, char *, int);
static void noLicenseFound();
#ifdef notdef
static void licenseStringChecks();
static void findLines(char *, char *, int, int, list_t *);
#endif /* notdef */
static int searchStrategy(int, char *, int);
static void saveLicenseData(scanres_t *, int, int, int);
static int scoreCompare(const void *, const void *);
static void printHighlightInfo(GArray* keyWords,  GArray* theMatches);
static char any[6];
static char some[7];
static char few[6];
static char year[7];
 
#ifdef  MEMSTATS
extern void memStats();
#endif  /* MEMSTATS */
#ifdef  STOPWATCH
DECL_TIMER;
int timerBytes;
char timerName[64];
#endif  /* STOPWATCH */
 
#ifndef MAX
#define MAX(a, b) ((a) > (b) ? a : b) 
#define MIN(a, b) ((a) < (b) ? a : b) 
#endif
 
void licenseInit() {
 
  int i;
  int len;
  int same;
  int ssAbove = 0;
  int ssBelow = 0;
  item_t *p;
  char *cp;
  char buf[myBUFSIZ];
 
#ifdef  PROC_TRACE
  traceFunc("== licenseInit()\n");
#endif  /* PROC_TRACE */
 
  strcpy(any, "=ANY=");
  strcpy(some, "=SOME=");
  strcpy(few, "=FEW=");
  strcpy(year, "=YEAR=");
  listInit(&gl.sHash, 0, "search-cache"); /* CDB - Added */
 
  for (i = 0; i < NFOOTPRINTS; i++) {
    same = 0;
    len = licSpec[i].seed.csLen;
    if (licSpec[i].text.csData == NULL_STR) {
      licText[i].tseed = "(null)";
    }
    if ((licSpec[i].text.csLen == 1) && (*(licSpec[i].text.csData) == '.')) {
      same++;
      /*CDB -- CHanged next line to use ! */
    }
    else if ((licSpec[i].seed.csLen == licSpec[i].text.csLen) && !memcmp(
        licSpec[i].seed.csData, licSpec[i].text.csData, len)) {
      same++;
    }
#ifdef  FIX_STRINGS
    fixSearchString(buf, sizeof(buf), i, YES);
#endif  /* FIX_STRINGS */
 
    licText[i].tseed = licSpec[i].seed.csData;
 
    /*---------------------------------------*/
    /* CDB - This is the code that I inadvertently removed. */
    if ((p = listGetItem(&gl.sHash, licText[i].tseed)) == NULL_ITEM) {
      LOG_FATAL("Cannot enqueue search-cache item \"%s\"", licText[i].tseed)
                            Bail(-__LINE__);
    }
    p->refCount++;
 
    /*--------------------------------*/
 
    if (strcmp(licText[i].tseed, "=NULL=") == 0) { /* null */
#ifdef  OLD_DECRYPT
      memFree(licText[i].tseed, MTAG_SEEDTEXT);
#endif  /* OLD_DECRYPT */
      licText[i].tseed = NULL_STR;
      licText[i].nAbove = licText->nBelow = -1;
    }
    if (same) { /* seed == phrase */
      licText[i].regex = licText[i].tseed;
#if 0
      ssBelow = searchStrategy(i, buf, NO);
      licText[i].nBelow = MIN(ssBelow, 2);
#endif
      licText[i].nAbove = licText[i].nBelow = 0;
    }
    else { /* seed != phrase */
      len = licSpec[i].text.csLen;
      memcpy(buf, licSpec[i].text.csData, (size_t)(len + 1));
#ifdef  OLD_DECRYPT
      decrypt(buf, len);
#endif  /* OLD_DECRYPT */
      ssAbove = searchStrategy(i, buf, YES);
      ssBelow = searchStrategy(i, buf, NO);
#if 0
      licText[i].nAbove = MIN(ssAbove, 3);
      licText[i].nBelow = MIN(ssBelow, 6);
#endif
      licText[i].nAbove = licText[i].nBelow = 1; /* for now... */
#ifdef  FIX_STRINGS
      fixSearchString(buf, sizeof(buf), i, NO);
#endif  /* FIX_STRINGS */
      licText[i].regex = copyString(buf, MTAG_SRCHTEXT);
    }
    if (p->ssComp < (ssAbove * 100) + ssBelow) {
      p->ssComp = (ssAbove * 100) + ssBelow;
    }
    licText[i].compiled = 0;
    licText[i].plain = 1; /* assume plain-text for now */
  }
  for (i = 0; i < NFOOTPRINTS; i++) {
    if (licText[i].tseed == NULL_STR) {
#ifdef  LICENSE_DEBUG
      LOG_NOTICE("License[%d] configured with NULL seed", i)
#endif  /* LICENSE_DEBUG */
                            continue;
    }
    if (licText[i].tseed == licText[i].regex) {
#ifdef  LICENSE_DEBUG
      LOG_NOTICE("License[%d] seed == regex", i)
#endif  /* LICENSE_DEBUG */
                            continue;
    }
    licText[i].nAbove = p->ssComp / 100;
    licText[i].nBelow = p->ssComp % 100;
  }
 
  for (i = 0; i < NFOOTPRINTS; i++) {
    for (cp = _REGEX(i); licText[i].plain && *cp; cp++) {
      switch (*cp) {
        case '.':
        case '*':
        case '+':
        case '|':
        case '[':
        case ']':
        case '(':
        case ')':
        case '^':
        case '$':
        case '?':
        case ',':
        case '<':
        case '>':
        case '{':
        case '}':
        case '\\':
          licText[i].plain = 0;
          break;
      }
    }
    if (i >= _CR_first && i <= _CR_last) {
      continue;
    }
  }
 
  /* pre-compile all non-plain patterns once; idx_regc[] reused in idxGrep_base() */
  for (i = 0; i < NFOOTPRINTS; i++) {
    if (!licText[i].plain && licText[i].regex != NULL_STR) {
      int rc = regcomp(&idx_regc[i], licText[i].regex, REG_ICASE | REG_EXTENDED);
      if (rc == 0) {
        licText[i].compiled = 1;
      } else {
        LOG_WARNING("nomos: failed to pre-compile regex #%d: %s", i, licText[i].regex);
      }
    }
  }
  return;
}
 
void licenseRegexFree(void)
{
  int i;
  for (i = 0; i < NFOOTPRINTS; i++) {
    if (licText[i].compiled) {
      regfree(&idx_regc[i]);
      licText[i].compiled = 0;
    }
  }
}
 
#define LINE_BYTES  50  
#define LINE_WORDS  8   
#define WC_BYTES  30    
#define WC_WORDS  3     
#define PUNT_LINES  3   
#define MIN_LINES 1     
static int searchStrategy(int index, char *regex, int aboveCalc) {
  char *start;
  char *cp;
  char *s;
  char seed[myBUFSIZ];
  int words;
  int lines;
  int bytes;
  int minLines;
  int matchWild;
  int matchSeed;
 
#ifdef  PROC_TRACE
  traceFunc("== searchStrategy(%d(%s), \"%s\", %d)\n", index,
      _SEED(index), regex, aboveCalc);
#endif  /* PROC_TRACE */
 
  s = _SEED(index);
  if (s == NULL_STR || strlen(s) == 0) {
#ifdef  LICENSE_DEBUG
    LOG_NOTICE("Lic[%d] has NULL seed", index)
#endif  /* LICENSE_DEBUG */
                        return (0);
  }
  if (regex == NULL_STR || strlen(regex) == 0) {
#ifdef  LICENSE_DEBUG
    Assert(NO, "searchStrategy(%d) called with NULL data", index);
#endif  /* LICENSE_DEBUG */
    return (0);
  }
  if (strcmp(s, regex) == 0) {
    return (0);
  }
  bytes = words = lines = 0;
  (void) strcpy(seed, s);
  while (seed[strlen(seed) - 1] == ' ') {
    seed[strlen(seed) - 1] = NULL_CHAR;
  }
  /* how far ABOVE to look depends on location of the seed in footprint */
  if (aboveCalc) {
    if (strGrep(seed, regex, REG_ICASE) == 0) {
#ifdef  LICENSE_DEBUG
      printf("DEBUG: seed(%d) no hit in regex!\n", index);
#endif  /* LICENSE_DEBUG */
      return (PUNT_LINES); /* guess */
    }
    start = regex;
    cp = start;
    for (minLines = 0; cp != NULL; start = cp + 1) {
      matchWild = matchSeed = 0;
      if ((cp = strchr(start, ' ')) != NULL_STR) {
        *cp = NULL_CHAR;
      }
      matchWild = (strcmp(start, any) == 0 || strcmp(start, some) == 0
          || strcmp(start, few));
      matchSeed = strcmp(start, seed) == 0;
      if (!matchSeed) {
        bytes += (matchWild ? WC_BYTES : strlen(start) + 1);
        words += (matchWild ? WC_WORDS : 1);
      }
      if (cp != NULL_STR) {
        *cp = ' ';
      }
      if (matchSeed) { /* found seed? */
        break;
      }
    }
    /* optimization for single-lines: */
    minLines += (words >= LINE_WORDS / 2 && words < LINE_WORDS);
    lines = MAX(bytes/LINE_BYTES, words/LINE_WORDS) + minLines;
#ifdef  LICENSE_DEBUG
    printf("ABOVE: .... bytes=%d, words=%d; max(%d,%d)+%d == %d\n",
        bytes, words, bytes/LINE_BYTES, words/LINE_WORDS,
        minLines, lines);
#endif  /* LICENSE_DEBUG */
    return (words == 0 ? 0 : lines);
  }
  /* calculate how far below to look -- depends on length of footprint */
  for (minLines = MIN_LINES, cp = start = regex; cp; start = cp + 1) {
    matchWild = matchSeed = 0;
    if ((cp = strchr(start, ' ')) != NULL_STR) {
      *cp = NULL_CHAR;
    }
    matchWild = (strcmp(start, any) == 0 || strcmp(start, some) == 0
        || strcmp(start, few));
    matchSeed = strcmp(start, seed) == 0;
    if (matchSeed) {
      bytes = words = 0;
      /*minLines = MIN_LINES+1;*/
    }
    else {
      bytes += (matchWild ? WC_BYTES : strlen(start) + 1);
      words += (matchWild ? WC_WORDS : 1);
    }
    if (cp != NULL_STR) {
      *cp = ' ';
    }
  }
  lines = MAX(bytes/LINE_BYTES, words/LINE_WORDS) + minLines;
#ifdef  LICENSE_DEBUG
  printf("BELOW: .... bytes=%d, words=%d; max(%d,%d)+%d == %d\n",
      bytes, words, bytes/LINE_BYTES, words/LINE_WORDS, minLines, lines);
#endif  /* LICENSE_DEBUG */
  return (lines);
}
 
#ifdef  FIX_STRINGS
static void fixSearchString(char *s, int size, int i, int wildcardBad)
{
  char *cp;
  int len;
  char wildCard[16];
  /* */
#ifdef  PROC_TRACE
  traceFunc("== fixSearchString(\"%s\", %d, %d, %d)\n", s, size, i,
      wildcardBad);
#endif  /* PROC_TRACE */
  /* */
  cp = s;
  while (isspace(*cp)) {
    cp++;
  }
  if (strncmp(cp, any, sizeof(any)-1) == 0 ||
      strncmp(cp, some, sizeof(some)-1) == 0 ||
      strncmp(cp, few, sizeof(few)-1) == 0) {
    printf("string %d == \"%s\"\n", i, cp);
    LOG_FATAL("Text-spec %d begins with a wild-card", i)
    Bail(-__LINE__);
  }
  /*
   * We'll replace the string " =ANY=" (6 chars) with ".*" (2 chars).
   * The token MUST OCCUR BY ITSELF (e.g., not a substring)!
   */
  (void) sprintf(wildCard, " %s", any);
  len = strlen(wildCard);
  for (cp = s; strGrep(wildCard, cp, 0); ) {
    if (wildcardBad) {
      LOG_FATAL("OOPS, regex %d, wild-card not allowed here", i)
                            Bail(-__LINE__);
    }
    if (*(cp+cur.regm.rm_eo) == NULL_CHAR) {
      LOG_FATAL("String %d ends in a wild-card", i)
                            Bail(-__LINE__);
    }
    else if (*(cp+cur.regm.rm_eo) == ' ') {
#ifdef  DEBUG
      printf("BEFORE(any): %s\n", s);
#endif  /* DEBUG */
      cp += cur.regm.rm_so;
      *cp++ = '.';
      *cp++ = '*';
      memmove(cp, cp+len-1, strlen(cp+len)+2);
#ifdef  DEBUG
      printf("_AFTER(any): %s\n", s);
#endif  /* DEBUG */
    }
    else {
      LOG_NOTICE("Wild-card \"%s\" sub-string, phrase %d", wildCard, i)
                            cp += cur.regm.rm_eo;
    }
  }
  /*
   * Ditto for replacing " =SOME= " (8 chars) with ".{0,60}" (7 chars)
   */
  (void) sprintf(wildCard, " %s", some);
  len = strlen(wildCard);
  for (cp = s; strGrep(wildCard, cp, 0); ) {
    if (wildcardBad) {
      LOG_FATAL("OOPS, regex %d, wild-card not allowed here", i)
                            Bail(-__LINE__);
    }
    if (*(cp+cur.regm.rm_eo) == NULL_CHAR) {
      LOG_FATAL("String %d ends in a wild-card", i)
                            Bail(-__LINE__);
    }
    else if (*(cp+cur.regm.rm_eo) == ' ') {
#ifdef  DEBUG
      printf("BEFORE(some): %s\n", s);
#endif  /* DEBUG */
      cp += cur.regm.rm_so;
      *cp++ = '.';
      *cp++ = '{';
      *cp++ = '0';
      *cp++ = ',';
      *cp++ = '6';
      *cp++ = '0';
      *cp++ = '}';
      memmove(cp, cp+len-6, strlen(cp+len)+7);
#ifdef  DEBUG
      printf("_AFTER(some): %s\n", s);
#endif  /* DEBUG */
    }
    else {
      LOG_NOTICE("Wild-card \"%s\" sub-string, phrase %d", wildCard, i)
                            cp += cur.regm.rm_eo;
    }
  }
  /*
   * And, same for replacing " =FEW= " (7 chars) with ".{0,15}" (7 chars)
   */
  (void) sprintf(wildCard, " %s", few);
  len = strlen(wildCard);
  for (cp = s; strGrep(wildCard, cp, 0); ) {
    if (wildcardBad) {
      LOG_FATAL("OOPS, regex %d, wild-card not allowed here", i)
                            Bail(-__LINE__);
    }
    if (*(cp+cur.regm.rm_eo) == NULL_CHAR) {
      LOG_FATAL("String %d ends in a wild-card", i)
                            Bail(-__LINE__);
    }
    else if (*(cp+cur.regm.rm_eo) == ' ') {
#ifdef  DEBUG
      printf("BEFORE(few): %s\n", s);
#endif  /* DEBUG */
      cp += cur.regm.rm_so;
      *cp++ = '.';
      *cp++ = '{';
      *cp++ = '0';
      *cp++ = ',';
      *cp++ = '3';
      *cp++ = '0';
      *cp++ = '}';
      memmove(cp, cp+len-6, strlen(cp+len)+7);
#ifdef  DEBUG
      printf("_AFTER(few): %s\n", s);
#endif  /* DEBUG */
    }
    else {
      LOG_NOTICE("Wild-card \"%s\" sub-string, phrase %d", wildCard, i)
                            cp += cur.regm.rm_eo;
    }
  }
  /*
   * AND, replace the string "=YEAR=" with "[12][0-9][0-9][0-9][,- ]*".
   * The former is 6 chars in length, the latter is 24.  We must be careful
   * not to overflow the buffer we're passed.
   */
  len = strlen(year);
  while (strGrep(year, s, 0)) {
    if (strlen(s)+25 >= size) { /* 24 plus 1(NULL) */
      LOG_FATAL("buffer overflow, text-spec %d", i)
                            Bail(-__LINE__);
    }
    cp = (char *)(s+cur.regm.rm_so);
#ifdef  DEBUG
    printf("BEFORE: %s\n", s);
#endif  /* DEBUG */
    memmove(cp+25, cp+6, strlen(cp+len)+1); /* was 26, 6 */
    memset(cp+6, '_', 19);
#ifdef  DEBUG
    printf("_MOVED: %s\n", s);
#endif  /* DEBUG */
    *cp = *(cp+4) = *(cp+9) = *(cp+14) = *(cp+19) = '[';
    *(cp+1) = '1';
    *(cp+2) = '2';
    *(cp+5) = *(cp+10) = *(cp+15) = '0';
    *(cp+6) = *(cp+11) = *(cp+16) = '-';
    *(cp+7) = *(cp+12) = *(cp+17) = '9';
    *(cp+3) = *(cp+8) = *(cp+13) = *(cp+18) = *(cp+23) = ']';
    *(cp+20) = ' ';
    *(cp+21) = ',';
    *(cp+22) = '-';
    *(cp+24) = '*';
#ifdef  DEBUG
    printf("_AFTER: %s\n", s);
#endif  /* DEBUG */
  }
  return;
}
#endif  /* FIX_STRINGS */
 
char* createRelativePath(item_t *p, scanres_t *scp)
{
  char* cp;
  if (*(p->str) == '/')
  {
    strcpy(scp->fullpath, p->str);
    scp->nameOffset = (size_t) (cur.targetLen + 1);
    cp = scp->fullpath; /* full pathname */
  }
  else
  {
    strncpy(scp->fullpath, cur.cwd, sizeof(scp->fullpath)-1);
    strncat(scp->fullpath, "/", sizeof(scp->fullpath)-1);
    strncat(scp->fullpath, p->str, sizeof(scp->fullpath)-1);
    scp->nameOffset = (size_t) (cur.cwdLen + 1);
    cp = p->str; /* relative path == faster open() */
  }
 
  return cp;
}
 
void scanForKeywordsAndSetScore(scanres_t* scores, list_t* licenseList)
{
  /*
     CDB -- Some other part of FOSSology has already decided we
     want to scan this file, so we need to look into removing this
     file scoring stuff.
   */
  scanres_t* scp;
  int c;
  item_t* p;
  char* textp;
  char* cp;
  for (scp = scores; (p = listIterate(licenseList)) != NULL_ITEM ; scp++)
  {
 
    /*
     * Use *relative* pathnames wherever possible -- we'll spend less time in
     * the kernel looking up inodes and pathname components that way.
     */
    cp = createRelativePath(p, scp);
 
#ifdef  DEBUG
    printf("licenseScan: scan %s\n",
        (char *)(scp->fullpath+scp->nameOffset));
#endif  /* DEBUG */
    /*
     * Zero-length files are of no interest; there's nothing in them!
     *  CDB - We need to report this error somehow... and clean up
     *  /tmp/nomos.tmpdir (or equivalent).
     */
    if ((textp = mmapFile(cp)) == NULL_STR) {
      /* perror(cp); */
      /*printf("Zero length file: %s\n", cp); */
      continue;
    }
    scp->size = cur.stbuf.st_size; /* Where did this get set ? CDB */
    /*
     * Disinterest #3 (discriminate-by-file-content):
     * Files not of a known-good type (as reported by file(1)/magic(3)) should
     * also be skipped (some are quite large!).  _UTIL_MAGIC (see _autodata.c)
     * contains a regex for MOST of the files we're interested in, but there
     * ARE some exceptions (logged below).
     *
     *****
     * exception (A): patch/diff files are sometimes identified as "data".
     *****
     * FIX-ME: we don't currently use _UTIL_FILTER, which is set up to
     * exclude some files by filename.
     */
    /*
     * Scan for keywords (_KW_), and use the number found for the score.
     */
    assert(NKEYWORDS >= sizeof(scp->kwbm));
 
    for (scp->kwbm = c = 0; c < NKEYWORDS; c++)
    {
      if (idxGrep_recordPosition(c + _KW_first, textp, REG_EXTENDED | REG_ICASE))
      {
        scp->kwbm |= (1 << c);  // put a one at c'th position in kwbm (KeywordByteMap)
        scp->score++;
#if (DEBUG > 5)
        printf("Keyword %d (\"%s\"): YES\n", c, _REGEX(c+_KW_first));
#endif  /* DEBUG > 5 */
      }
    }
    munmapFile(textp);
#if (DEBUG > 5)
    printf("%s = %d\n", (char *)(scp->fullpath+scp->nameOffset),
        scp->score);
#endif  /* DEBUG > 5 */
 
  }
  return;
}
 
void relaxScoreCriterionForSingleFile(scanres_t* scores)
{
  /*
   * CDB - It is always the case that we are doing one file at a time.
   */
  if (scores->score == 0)
  {
    scores->score = 1;
  }
}
 
int fiterResultsOfKeywordScan(int lowWater, scanres_t* scores, int nFiles)
{
  int nCand;
 
  scanres_t* scp;
  int i;
 
  for (scp = scores, i = nCand = 0; i < nFiles; i++, scp++)
  {
    scp->relpath = (char *) (scp->fullpath + scp->nameOffset);
    if (idxGrep(_FN_LICENSEPATT, pathBasename(scp->relpath), REG_ICASE
        | REG_EXTENDED)) {
      scp->flag = 1;
      if (idxGrep(_FN_DEBCPYRT, scp->relpath, REG_ICASE)) {
        scp->flag = 2;
      }
    }
    else if (scp->score >= lowWater) {
      scp->flag |= 1;
    }
    /*
     * So now, save any license candidate EITHER named "debian/copyright*"
     * OR having a score > 0
     */
    if (scp->flag == 2 || (scp->score && scp->flag)) {
#if (DEBUG > 3)
      printf("%s [score: %d], %07o\n", scp->fullpath,
          scp->score, scp->kwbm);
#endif  /* DEBUG > 3 */
      nCand++;
    }
  }
  return nCand;
}
 
void licenseScan(list_t *licenseList)
{
  int lowWater = 1; // constant
 
  int nCand; //relevant output
 
  //fields
  int counts[NKEYWORDS + 1];
  scanres_t *scores;
 
  //recycled temp variables
  scanres_t *scp;
  int nFilesInList;
 
#ifdef  PROC_TRACE
  traceFunc("== licenseScan(%p, %d)\n", l);
#endif  /* PROC_TRACE */
 
#ifdef  MEMSTATS
  printf("... allocating %d bytes for scanres_t[] array\n",
      sizeof(*scp)*licenseList->used);
#endif  /* MEMSTATS */
 
  scores = (scanres_t *) memAlloc(sizeof(*scp) * licenseList->used, MTAG_SCANRES);
  memset((void *) counts, 0, (size_t) ((NKEYWORDS + 1) * sizeof(int)));
 
  scanForKeywordsAndSetScore(scores, licenseList);
  relaxScoreCriterionForSingleFile(scores);
 
#ifdef  PROC_TRACE
  traceFunc("=> invoking qsort(): callback == scoreCompare()\n");
#endif  /* PROC_TRACE */
 
  nFilesInList = licenseList->used;
  qsort(scores, (size_t) nFilesInList, sizeof(*scp), scoreCompare);
 
  //recycled temp variables
  nCand = fiterResultsOfKeywordScan(lowWater, scores, nFilesInList);
  /*
   * OF SPECIAL INTEREST: saveLicenseData() changes directory (to "..")!!!
   */
  /* DBug: printf("licenseScan: gl.initwd is:%s\n",gl.initwd); */
  saveLicenseData(scores, nCand, nFilesInList, lowWater);
  /*
   * At this point, we don't need either the raw-source directory or the
   * unpacked results anymore, so get rid of 'em.
   */
  if (scores->licenses) free(scores->licenses);
  memFree((char *) scores, "scores table");
  return;
} /* licenseScan */
 
static int scoreCompare(const void *arg1, const void *arg2) {
  scanres_t *sc1 = (scanres_t *) arg1;
  scanres_t *sc2 = (scanres_t *) arg2;
 
  if (sc1->score > sc2->score) {
    return (-1);
  }
  else if (sc1->score < sc2->score) {
    return (1);
  }
  else if ((sc1->fullpath != NULL_STR) && (sc2->fullpath == NULL_STR)) {
    return (-1);
  }
  else if ((sc2->fullpath != NULL_STR) && (sc1->fullpath == NULL_STR)) {
    return (1);
  }
  else {
    return (-strcmp(sc1->fullpath, sc2->fullpath));
  }
}
 
static void noLicenseFound() {
 
#ifdef  PROC_TRACE
  traceFunc("== noLicenseFound\n");
#endif  /* PROC_TRACE */
 
  (void) strcpy(cur.compLic, LS_NOSUM);
  return;
}
 
static void printHighlightInfo(GArray* keyWords,  GArray* theMatches){
  if ( optionIsSet(OPTS_HIGHLIGHT_STDOUT) )
  {
    printf(" Highlighting Info at");
    int currentKeyw;
    for (currentKeyw=0; currentKeyw < keyWords->len; ++currentKeyw ) {
      MatchPositionAndType* ourMatchv = getMatchfromHighlightInfo(keyWords,currentKeyw );
      printf(" Keyword at %i, length %i, index = 0,",  ourMatchv->start, ourMatchv->end - ourMatchv->start );
    }
    int currentLicence;
    for (currentLicence = 0; currentLicence < theMatches->len; ++currentLicence)
    {
      LicenceAndMatchPositions* theLicence = getLicenceAndMatchPositions(theMatches, currentLicence);
 
      int highl;
      for (highl = 0; highl < theLicence->matchPositions->len; ++highl)
      {
        MatchPositionAndType* ourMatchv = getMatchfromHighlightInfo(theLicence->matchPositions, highl);
        printf(" License #%s# at %i, length %i, index = %i,", theLicence->licenceName , ourMatchv->start, ourMatchv->end - ourMatchv->start,    ourMatchv->index  );
 
      }
    }
  }
  printf("\n");
  return;
}
 
static void printKeyWordMatches(scanres_t *scores, int idx)
{
  int c;
  int base;
  char miscbuf[myBUFSIZ];
  int offset;
  /*
   * construct the list of keywords that matched in licenseScan()
   */
  (void) strcpy(miscbuf, "Matches: ");
  offset = 9; /* e.g., strlen("Matches: ") */
  for (base = c = 0; c < NKEYWORDS; c++)
  {
    if (scores[idx].kwbm & (1 << c))
    {
      if (base++)
      {
        miscbuf[offset++] = ',';
        miscbuf[offset++] = ' ';
      }
      offset += sprintf(miscbuf + offset, "%s", _REGEX(c + _KW_first));
    }
  }
 
  printf("%s\n", miscbuf);
 
}
 
static gint compare_integer(gconstpointer a, gconstpointer b)
{
  gint out;
 
  if (a < b)
    out = -1;
  else if (a == b)
    out = 0;
  else
    out = 1;
  return out;
 
}
 
static void rescanOriginalTextForFoundLicences(char* textp, int isFileMarkupLanguage, int isPS){
 if (cur.theMatches->len > 0 )
  {
    if (cur.cliMode == 1 && !optionIsSet(OPTS_HIGHLIGHT_STDOUT) ) return;
    // do a fresh doctoring of the buffer
    g_array_free(cur.docBufferPositionsAndOffsets, TRUE);
    cur.docBufferPositionsAndOffsets = g_array_new(FALSE, FALSE, sizeof(pairPosOff));
    doctorBuffer(textp, isFileMarkupLanguage, isPS, NO);
 
    for (cur.currentLicenceIndex = 0; cur.currentLicenceIndex < cur.theMatches->len; ++cur.currentLicenceIndex)
    {
      LicenceAndMatchPositions* currentLicence = getLicenceAndMatchPositions(cur.theMatches, cur.currentLicenceIndex);
 
      //we want to only look for each found index once
      g_array_sort(currentLicence->indexList, compare_integer);
 
      int myIndex;
      int lastindex = -1;
      for (myIndex = 0; myIndex < currentLicence->indexList->len; ++myIndex)
      {
        int currentIndex = g_array_index(currentLicence->indexList, int, myIndex);
        if (currentIndex == lastindex) continue;
        idxGrep_recordPositionDoctored(currentIndex, textp, REG_ICASE | REG_EXTENDED);
        lastindex = currentIndex;
      }
    }
  }
}
 
static void saveLicenseData(scanres_t *scores, int nCand, int nElem,
    int lowWater) {
  int i;
 // int c;
 // int base;
  int size;
  int highScore = scores->score;
  int isFileMarkupLanguage = 0;
  int isPS = 0;
  // int offset;
  int idx;
  char *fileName;
  char *textp;
  item_t *p;
  char realPathOfTarget[PATH_MAX];
 
#ifdef  PROC_TRACE
  traceFunc("== saveLicenseData(%p, %d, %d, %d, %d)\n", scores, nCand,
      nElem, lowWater);
#endif  /* PROC_TRACE */
 
  /* DBug: printf("saveLicenseData on entry gl.initwd is:%s\n",gl.initwd); */
  /*
   * Save the necessary licensing information in a list of files...
   */
#ifdef  DEBUG
  printf("saveLicenseData: %d candidates\n", nCand);
#endif  /* DEBUG */
 
  /*    changeDir("..");*//* CDB- Why?!!!! */
 
  /* BE PERFORMANCE-CONSCIOUS WITHIN THIS LOOP (it runs a LOT!) */
  /*
   * OPTIMIZE-ME: should we store local variables and use lots of
   * registers instead of accessing everything through the scanres
   * array?  We've got to be doing some serious address calculations.
   */
  i = 1;
 
  for (idx = 0; i <= nCand; idx++) {
    /*
     * If we didn't flag this file as needing to be saved, ignore it.
     */
    if (scores[idx].flag == 0) {
      continue;
    }
    (void) sprintf(scores[idx].linkname, "Link%03d.txt", i++);
#if DEBUG > 5
    printf("name: %s\n[%s]\n", scores[idx].relpath, scores[idx].fullpath);
#endif  /* DEBUG > 5 */
    /*
     * Kludge up the pointer to the relative-path in scores[idx].fullpath
     * so we don't
     * have to as many directory entries to open each file... this works for
     * anything EXCEPT 'distribution files'.
     */
    fileName = scores[idx].fullpath;
    if (optionIsSet(OPTS_DEBUG)) {
      printf("File name: %s\n", fileName);
    }
    if ((textp = mmapFile(fileName)) == NULL_STR) {
 
      /* Fatal("Null mmapFile(), path=%s", fileName); */
      noLicenseFound();
      continue;
    }
    /* CDB  size = (int) cur.stbuf.st_size; */
    size = scores[idx].size;
    if (scores[idx].dataOffset) {
      textp += scores[idx].dataOffset;
    }
 
    /* wordCount() sets nLines in global structure "cur".  */
    wordCount(textp);
 
    /*
     * Report which package (if any) this file came from
     */
 
    /*
     * Since we hard-wire the score of every file (invoked as --file), a score
     * of 1 could be either 0 or 1, so scores[idx].kwbm tells the real story...
     */
    if (optionIsSet(OPTS_DEBUG)) {
      printf("File score: %d (0x%06x)\n",
          (scores[idx].kwbm ? scores[idx].score : scores[idx].kwbm),
          scores[idx].kwbm);
      if (scores[idx].kwbm) {
        printKeyWordMatches(scores, idx);
      }
    }
    /*
     * Print the license claim (e.g., what's listed in the package)
     */
    /*
     * determine licenses in the file, and record 'em; wrap up by including
     * the file contents
     *****
     * FIX-ME: we should filter some names out like the shellscript does.
     * For instance, word-spell-dictionary files will score high but will
     * likely NOT contain a license.  But the shellscript filters these
     * names AFTER they're already scanned.  Think about it.
     *****
         FILTERPATTERNS="(/man|\.[0-9]|\.[0-9][a-z]|rfc[0-9].*|.po|.pot"
         FILTERPATTERNS="$FILTERPATTERNS|words.*|.*spelling.*|spell)$"
     */
#if defined(DEBUG) || defined(DOCTOR_DEBUG) || defined(LTSR_DEBUG)  \
    || defined(BATCH_DEBUG) || defined(PARSE_STOPWATCH) || defined(MEMSTATS) \
    || defined(MEM_DEBUG) || defined(UNKNOWN_CHECK_DEBUG)
    printf("*** PROCESS File: %s\n", scores[idx].relpath);
    printf("... %d bytes, score %d\n", scores[idx].size, scores[idx].score);
#endif /* DEBUG || DOCTOR_DEBUG || LTSR_DEBUG || BATCH_DEBUG || PARSE_STOPWATCH || MEMSTATS || MEM_DEBUG || defined(UNKNOWN_CHECK_DEBUG)*/
 
    isFileMarkupLanguage = idxGrep(_UTIL_MARKUP, textp, REG_ICASE | REG_EXTENDED);
 
#ifdef  DOCTOR_DEBUG
    printf("idxGrep(ML) returns %d\n", isFileMarkupLanguage);
    if (isFileMarkupLanguage)
    {
      int n;
      printf("isMarkUp@%d: [", cur.regm.rm_so);
      for (n = cur.regm.rm_so; n <= cur.regm.rm_eo; n++) {
        printf("%c", *(textp+n));
      }
      printf("]\n");
    }
#endif  /* DOCTOR_DEBUG */
    /*
     * BUG: When _FTYP_POSTSCR is "(postscript|utf-8 unicode)", the resulting
     * license-parse yields 'NoLicenseFound' but when both "postscript" and
     * "utf-8 unicode" are searched independently, parsing definitely finds
     * quantifiable licenses. WHY?
     */
#ifdef  DOCTOR_DEBUG
    printf("idxGrep(PS) returns %d\n", isPS);
    if (isPS) {
      int n;
      printf("isPostScript@%d: [", cur.regm.rm_so);
      printf("]\n");
    }
#endif  /* DOCTOR_DEBUG */
    /*
     * Interesting - copyString(parseLicenses(args), MTAG_FILELIC)...
     * will randomly segfault on 32-bit Debian releases.  Split the calls.
     */
    fileName = parseLicenses(textp, size, &scores[idx], isFileMarkupLanguage, isPS);
    scores[idx].licenses = copyString(fileName, MTAG_FILELIC);
#ifdef  QA_CHECKS
    if (fileName == NULL_STR) {
      Assert(NO, "Expected non-null parseLicenses return!");
    }
    if (scores[idx].licenses == NULL_STR) {
      Assert(NO, "Expected non-null license summary!");
    }
#endif  /* QA_CHECKS */
#ifdef  STOPWATCH
    timerBytes += size;
#endif  /* STOPWATCH */
#ifdef  FLAG_NO_COPYRIGHT
    if (gl.flags & FL_NOCOPYRIGHT) {
      p = listGetItem(&cur.nocpyrtList, scores[idx].relpath);
      p->buf = copyString(scores[idx].linkname, MTAG_PATHBASE);
      p->num = scores[idx].score;
    }
#endif  /* FLAG_NO_COPYRIGHT */
    if (cur.licPara != NULL_STR) {
      memFree(cur.licPara, MTAG_TEXTPARA); /* be free! */
      cur.licPara = NULL_STR; /* remember */
    }
 
 
    if( !optionIsSet(OPTS_NO_HIGHLIGHTINFO) ) {
      //careful this function changes the content of textp
      rescanOriginalTextForFoundLicences(textp, isFileMarkupLanguage, isPS);
      //but as it is freed right here we do not make a copy..
    }
 
    munmapFile(textp);
 
    /*
     * Remember this license in this file...
     */
    p = listGetItem(&cur.lList, scores[idx].licenses);
    p->refCount++;
    /*
     * Clear out the buffer-offsets list
     */
#ifdef fix_later
    /* CDB - need to move this code to a point after we save the license info */
#ifdef  PHRASE_DEBUG
    listDump(&cur.offList, NO);
#endif  /* PHRASE_DEBUG */
    while ((p = listIterate(&cur.offList)) != 0) {
      listClear(p->buf, YES);
    }
    listClear(&cur.offList, NO);
#endif /* fix_later */
  }
 
  listSort(&cur.lList, SORT_BY_COUNT_DSC);
 
#ifdef  QA_CHECKS
  if (cur.lList.used == 0) {
    Assert(NO, "No entries in license-list");
  }
#endif  /* QA_CHECKS */
 
  /*
   * Construct a 'computed license'.  Wherever possible, leave off the
   * entries for None and LikelyNot; those are individual-file results
   * and we're making an 'aggregate summary' here.
   */
  if (cur.parseList.used == 0) {
    noLicenseFound();
  }
  else {
    makeLicenseSummary(&cur.parseList, highScore, cur.compLic,
        sizeof(cur.compLic));
  }
  if (optionIsSet(OPTS_DEBUG)) {
    printf("==> ");
  }
  /* CDB - Debug code */
  /*
    printf("saveLicData: the offset list is:\n");
    listDump(&cur.offList, YES);
 
     while ((p = listIterate(&cur.offList)) != 0) {
     listDump(p->buf, YES);
     }
   */
  /* print results if running from the command line */
  /* DBug: printf("saveLicenseData on return gl.initwd is:%s\n",gl.initwd); */
  if(cur.cliMode)
  {
    if (optionIsSet(OPTS_JSON_OUTPUT))
    {
      writeJson();
    } else {
      if (optionIsSet(OPTS_LONG_CMD_OUTPUT) && realpath(cur.targetFile, realPathOfTarget))
        {
          printf("File %s contains license(s) %s", realPathOfTarget, cur.compLic);
        }
      else
        {
          printf("File %s contains license(s) %s", basename(cur.targetFile), cur.compLic);
        }
      printHighlightInfo(cur.keywordPositions, cur.theMatches);
    }
  }
  return;
} /* saveLicenseData */
 
 
static void makeLicenseSummary(list_t *l, int highScore, char *target, int size) {
  item_t *p;
  int printCount = 0;
  int len = 0;
  int new;
  int goodStuff;
 
#ifdef  PROC_TRACE
  traceFunc("== makeLicenseSummary(%p, %d, %p, %d)\n", l, highScore,
      target, size);
#endif  /* PROC_TRACE */
 
  if (l->used == 0) { /* zero/nothing */
    (void) strcpy(target, LS_NOSUM);
    return;
  }
  /*
   * Now we know there's something in the list of AT LEAST marginal interest
   * in the component-list.  If listCount() is zero, ALL data is 'marginal';
   * else we have 'good stuff'.  For the latter, we only summarize items with
   * a 'val' > 0 (the really interesting stuff).
   */
  listSort(l, SORT_BY_COUNT_DSC); /* sort components */
  size--; /* maximum strlen, adjust to allow *1* NULL */
  for (goodStuff = 0; (p = listIterate(l)) != NULL_ITEM; /*nada */) {
    if (p->iLevel) {
      goodStuff = 1; /* interesting license */
      l->ix = -1; /* reset saved index */
      break;
    }
  }
  while ((p = listIterate(l)) != NULL_ITEM) {
    if (goodStuff && (p->iLevel <= IL_LOW)) { /* uninteresting */
      continue;
    }
    if (printCount) {
      target[len++] = ',';
    }
    printCount++;
    new = sprintf(target + len, "%s", p->str);
    if ((len += new) > size) {
      LOG_FATAL("Buffer-overwrite, marginal license components")
                            Bail(-__LINE__);
    }
    new = 0;
  }
  return;
}
 
#ifdef  LICENSE_DEBUG
dumpLicenses()
{
  int i;
 
#ifdef  PROC_TRACE
  traceFunc("== dumpLicenses()\n");
#endif  /* PROC_TRACE */
 
  for (i = 0; i < NFOOTPRINTS; i++) {
    printf("License[%d]: seedlen=%d, regexlen=%d\n", i,
        licSpec[i].seed.csLen, licSpec[i].text.csLen);
  }
  printf("[NFOOTPRINTS = %d\n", NFOOTPRINTS);
}
#endif  /* LICENSE_DEBUG */