IAP GITLAB

Skip to content
Snippets Groups Projects

Copyright

Merged Copyright
copyright into master
Merged Ralf Ulrich requested to merge copyright into master
Viewing commit 8e3e2abd
Prev Next
Show latest version
1 file
+ 73
− 38
Compare changes
  • Side-by-side
  • Inline
do-copyright.py
+ 145
− 38
#!/usr/bin/python
#!/usr/bin/env python3
import os.path
import os
import sys, getopt
import re
text = """
/*
* (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
"""
Note: this is technically used as a mutliline regexp
"""
text = """/*
* (c) Copyright YEAR CORSIKA Project, corsika-project@lists.kit.edu
*
* See file AUTHORS for a list of contributors.
*
@@ -14,30 +18,66 @@ text = """
*/\n
"""
Debug = 0 # 0: nothing, 1: checking, 2: filesystem
"""
Debug settings are 0: nothing, 1: checking, 2: filesystem
"""
Debug = 0
excludeDirs = ["ThirdParty", "git"]
excludeFiles = ['PhysicalConstants.h','CorsikaFenvOSX.cc']
excludeFiles = ['PhysicalConstants.h','CorsikaFenvOSX.cc', 'sgn.h']
extensions = [".cc", ".h", ".test"]
def checkNote(filename):
"""
justCheck: T: only checking, F: also changing files
"""
justCheck = True
"""
foundMissing: global variable set to True in case of any needed action
"""
foundMissing = False
"""
forYear: replace this with year for copyright notice via command line
"""
forYear="YEAR"
###############################################
#
def checkNote(filename, justCheck, forYear):
"""
function to check, if the file 'filename' contains an exact copy
of the copyright notice defined above.
The function also checks for eventual multiple (maybe conflicting)
copyright notices in the same file.
If 'justCheck' is True, the file will never be changed, otherwise
the function will attempt to put the correct notice exactly once
at the top of the file. The copyright YEAR will be replace with
'forYear', e.g. forYear="2019" or forYear="2018-2020", etc.
The global variable 'foundMissing' is set to True in the event
where any changes are identified, BUT not implemented.
"""
global foundMissing
if Debug>0:
print ("***********************************************")
print ("file: " + filename )
startNote = []
endNote = []
# read input file into lines
""" read input file into lines """
lines = []
with open(filename, "r") as file:
with open(filename, "r", encoding="utf-8") 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
""" 0:before comment block, #1 in comment block, #2 found copyright """
searchStatus = 0
blockStart = 0
for iLine in range(len(lines)):
line = lines[iLine]
@@ -52,55 +92,67 @@ def checkNote(filename):
endNote.append(iLine)
searchStatus = 0
iLine += 1
if Debug>0:
txt = "states: n=" + str(len(startNote))
for i in xrange(len(startNote)):
for i in range(len(startNote)):
txt += ", [" + str(startNote[i]) + "-" + str(endNote[i]) + "]"
print ("stats: ") + txt
# now check if first copyright notices is already identical...
print ("stats: " + txt)
""" now check if first copyright notices is already identical... """
isSame = False
if len(startNote)>0:
isSame = True
noteLines = text.split('\n')
noteLines = text.split('\n')
for iLine in range(len(noteLines)-2):
if startNote[0]+iLine >= len(lines):
isSame = False
break
if noteLines[iLine+1].strip(" \n") != lines[startNote[0]+iLine].strip(" \n"):
regex = re.compile(re.escape(noteLines[iLine].strip(" \n")).replace('YEAR','....'))
if not re.match(regex, lines[startNote[0]+iLine].strip(" \n")):
isSame = False
print "need update: " + filename + " new=\'" + noteLines[iLine+1] + "\' vs old=\'" + lines[startNote[0]+iLine].rstrip('\n') + "\'"
foundMissing = True
print ("needs update: " + filename + " new=\'" + noteLines[iLine] + "\' vs old=\'" + lines[startNote[0]+iLine].rstrip('\n') + "\'")
break
if Debug>0:
print ("isSame=" + str(isSame))
print ("isSame=" + str(isSame) + " " + str(len(startNote)))
# check if notice is the same, or we need to remove multiple notices...
""" check if notice is the same, or we need to remove multiple notices... """
if isSame and len(startNote)<=1:
return
# add (new) copyright notice here:
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:
file.write(text)
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()
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
""" if line after comment is empty, also remove it """
if lines[iLine].strip() != "":
skip = False
if not skip:
@@ -109,7 +161,13 @@ def checkNote(filename):
file.close()
def next_file(x, dir_name, files):
###############################################
#
def next_file(dir_name, files, justCheck, forYear):
"""
check files: loops over list of files,
excludes if wished, process otherwise
"""
for check in excludeDirs :
if check in dir_name:
if Debug>1:
@@ -121,16 +179,65 @@ def next_file(x, dir_name, files):
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)
continue
excludeThisFile=True
if excludeThisFile:
continue
if file_extension in extensions:
checkNote(dir_name + "/" + check)
checkNote(os.path.join(dir_name, check), justCheck, forYear)
else:
if Debug>1:
print ("exclude-extension: " + dir_name + "/" + check)
print ("exclude-extension: " + os.path.join(dir_name, check))
###############################################
#
def main(argv):
"""
the main program
"""
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, justCheck, forYear)
os.path.walk("./", next_file, 0)
###############################################
#
if __name__ == "__main__":
"""
main python entry point
"""
main(sys.argv[1:])
if justCheck and foundMissing:
""" found any need for action """
sys.exit(-1)
print ("Finished")
sys.exit(0)

data privacy - impressum