do-copyright.py

#!/usr/bin/python

import os
import sys, getopt
import re

#
# Note: this is a mutliline regexp:
#
text = """
/*
 * (c) Copyright YEAR CORSIKA Project, corsika-project@lists.kit.edu
 *
 * See file AUTHORS for a list of contributors.
 *
 * This software is distributed under the terms of the GNU General Public
 * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
 * the license.
 */\n
"""

Debug = 0 # 0: nothing, 1: checking, 2: filesystem

excludeDirs = ["ThirdParty", "git"]
excludeFiles = ['PhysicalConstants.h','CorsikaFenvOSX.cc', 'sgn.h']

extensions = [".cc", ".h", ".test"]

justCheck = True # T: only checking, F: also changing files 
foundMissing = False

forYear="YEAR" # replace this with year via command line


###############################################
#
def checkNote(filename):
    global foundMissing, justCheck, forYear
    
    if Debug>0:
        print ("***********************************************")
        print ("file: " + filename )
    
    startNote = []
    endNote = []

    # read input file into lines
    lines = []
    with open(filename, "r") as file:
        for line in file.readlines():
            lines.append(line)            
        file.close()

    searchStatus = 0 # 0:before comment block, #1 in comment block, #2 found copyright
    blockStart = 0
    for iLine in range(len(lines)):
        line = lines[iLine]
        if "/*" in line and searchStatus==0:
            searchStatus = 1
            blockStart = iLine
        if "copyright" in line.lower() and searchStatus>0:
            searchStatus = 2
        if "*/" in line:
            if searchStatus>=2:
                startNote.append(blockStart)
                endNote.append(iLine)
            searchStatus = 0
        iLine += 1

    if Debug>0:
        txt = "states: n=" + str(len(startNote))
        for i in xrange(len(startNote)):
            txt += ",  [" + str(startNote[i]) + "-" + str(endNote[i]) + "]"         
        print ("stats: ") + txt

    # now check if first copyright notices is already identical...
    isSame = False
    if len(startNote)>0: 
        isSame = True
        noteLines = text.split('\n')
        for iLine in range(len(noteLines)-2):
            if startNote[0]+iLine >= len(lines):
                isSame = False
                break
            regex = re.compile(re.escape(noteLines[iLine+1].strip(" \n")).replace('YEAR','....'))
            if not re.match(regex, lines[startNote[0]+iLine].strip(" \n")):
                isSame = False
                foundMissing = True
                print "needs update: " + filename + " new=\'" + noteLines[iLine+1] + "\' vs old=\'" + lines[startNote[0]+iLine].rstrip('\n') + "\'"
                break
    if Debug>0:
        print ("isSame=" + str(isSame) + " " + str(len(startNote)))
    
    # check if notice is the same, or we need to remove multiple notices...
    if isSame and len(startNote)<=1:
        return                

    if (len(startNote)==0):
        print ("No copyright note in file: " + filename)

    # either we found a file with no copyright, or with wrong copyright notice here
    if justCheck:
        foundMissing = True
        return
    
    # add (new) copyright notice here:
    print ("File: " + filename + ", make copy to " + filename+".bak")
    os.rename(filename, filename+".bak")

    with open(filename, "w") as file:

        textReplace = re.sub(r"Copyright YEAR ", "Copyright " + forYear + " ", text)
        file.write(textReplace)
        
        skip = False
        for iLine in range(len(lines)):

            inBlock = False
            for iBlock in range(len(startNote)):
                if iLine>=startNote[iBlock] and iLine<=endNote[iBlock]:
                    print "   [remove " + str(iBlock) + "] " + (lines[iLine]).strip()
                    inBlock = True
                    skip = True

            if inBlock:
                continue
            
            if lines[iLine].strip() != "": # if line after comment is empty, also remove it
                skip = False
                    
            if not skip:
                file.write(lines[iLine])
        
        file.close()


###############################################
#
# check files: loops over list of files,
# excludes if wished, process otherwise
# 
def next_file(dir_name, files):
    for check in excludeDirs :
        if check in dir_name:
            if Debug>1:
                print ("exclude-dir: " + check)
            return True
    for check in files :
        if (os.path.isdir(check)):
            continue
        filename, file_extension = os.path.splitext(check)
        if '#' in check or '~' in check:
            continue
        excludeThisFile=False
        for check2 in excludeFiles :
            if check2 in check:
                if Debug>1:
                    print ("exclude: " + check2)
                excludeThisFile=True
        if excludeThisFile:
            continue
        if file_extension in extensions:
            checkNote(os.path.join(dir_name, check))
        else:
            if Debug>1:
                print ("exclude-extension: " + os.path.join(dir_name, check))

                
###############################################
# the main program
def main(argv):
   global justCheck, foundMissing, Debug, forYear
   justCheck = True
   Debug = 0
   try:
      opts, args = getopt.getopt(argv, "cAhd:", ["check", "add=", "debug="])
   except getopt.GetoptError:
      print 'do-copyright.py [--check] [--add=YEAR] [--debug=0]'
      sys.exit(2)
   for opt, arg in opts:
      if opt == '-h':
         print 'do-copyright.py [--check] [--add=YEAR] [--debug=0]'
         sys.exit()
      elif opt in ("-c", "--check"):
         justCheck = True
      elif opt in ("-A", "--add"):
         justCheck = False
         forYear = str(arg)
         print 'Adding \'Copyright ' + forYear + '\' notice, where needed. '
      elif opt in ("-d", "--debug"):
         Debug = int(arg)

   if justCheck:
       print 'Only checking. No changes. See \'do-copyright.py -h\' for options.' 
         
   for root, dirs, files in os.walk('./'):
       next_file(root, files)

    
###############################################
# main entry point
if __name__ == "__main__":
   main(sys.argv[1:])

   if justCheck and foundMissing:
       sys.exit(-1) # found error
   print "Finished"
   sys.exit(0)