1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
#!/usr/bin/env python
#coding=utf-8
import os, re, datetime, sys, subprocess
DEFAULT_LICENSE = "gpl3"
CONTRIBUTOR_LICENSE = "mit"
LICENSE_DIR = "Documentation/Licenses"
# The following regex parses license comment blocks and its part out of a complete source file.
reParseLicenseCommentBlocks = re.compile(r'(\/\*\n\s\*\sCopyright \(c\) (?P<startYear>\d\d\d\d)(-(?P<endYear>\d\d\d\d))? (?P<author>[^\n\.]*)\.?\n.\* (?P<license>[^\n]*)\n \* (?P<seeMore>[^\n]+)\n *\*\/)')
class License :
def __init__(self, name, file) :
self.name = name
self.file = file
licenses = {
"default": License("All rights reserved.", "See the COPYING file for more information."),
"gpl3" : License("Licensed under the GNU General Public License v3.", "See " + LICENSE_DIR + "/" + "GPLv3.txt" + " for more information."),
"mit" : License("Licensed under the MIT License.", "See " + LICENSE_DIR + "/" + "MIT.txt" + " for more information."),
}
class Copyright :
def __init__(self, author, year, license) :
self.author = author
self.year = year
self.license = license
def to_string(self, comment_chars) :
return "\n".join([
comment_chars[0],
comment_chars[1] + " Copyright (c) %(year)s %(name)s" % {"year" : self.year, "name" : self.author },
comment_chars[1] + licenses[self.license].name,
comment_chars[1] + licenses[self.license].file,
comment_chars[2],
"\n"])
def __str__(self):
return """/*
* Copyright (c) %s %s.
* %s
* %s
*/
""" % (self.year, self.author, licenses[self.license].name, licenses[self.license].file)
class ContentRef :
def __init__(self, begin, end, content):
self.begin = begin
self.end = end
self.content = content
class CopyrightBlock :
def __init__(self, yearBegin, yearEnd, author, license, seeMore, total):
self.yearBegin = yearBegin
self.yearEnd = yearEnd
self.author = author
self.license = license
self.seeMore = seeMore
self.total = total
def cref_from_group(match, group):
if match.group(group):
return ContentRef(match.start(group), match.end(group), match.group(group))
else :
return None
def parse_file_new(filename):
copyrightBlocks = []
with open(filename, 'r') as file:
content = file.read()
for match in re.finditer(reParseLicenseCommentBlocks, content):
copyrightBlocks.append(CopyrightBlock(
cref_from_group(match, "startYear"),
cref_from_group(match, "endYear"),
cref_from_group(match, "author"),
cref_from_group(match, "license"),
cref_from_group(match, "seeMore"),
cref_from_group(match, 0)))
return copyrightBlocks
def get_userinfo() :
p = subprocess.Popen("git config user.name", shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=(os.name != "nt"))
username = p.stdout.read().rstrip()
p.stdin.close()
if p.wait() != 0 :
return None
p = subprocess.Popen("git config user.email", shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=(os.name != "nt"))
email = p.stdout.read().rstrip()
p.stdin.close()
if p.wait() != 0 :
return None
return (username, email)
def get_copyright(username, email) :
if email in ["git@el-tramo.be", "git@kismith.co.uk"] :
license = DEFAULT_LICENSE
else :
license = CONTRIBUTOR_LICENSE
return Copyright(username, datetime.date.today().strftime("%Y"), license)
def get_copyright_setting(username, email) :
config = os.getenv("SWIFT_LICENSE_CONFIG")
if config :
copyrightHolder, license = config.split("|")
else :
if email.endswith("isode.com") or email in ["git@el-tramo.be", "git@kismith.co.uk", "tm@ayena.de"] :
copyrightHolder, license = "Isode Limited", "default"
else :
copyrightHolder, license = username, "mit"
return Copyright(copyrightHolder, datetime.date.today().year, license)
def check_copyright(filename, hints) :
copyrightBlocks = parse_file_new(filename)
if copyrightBlocks :
# looking for copyright block for current author
username, email = get_userinfo()
copyrightSetting = get_copyright_setting(username, email)
for block in copyrightBlocks :
if block.author.content == copyrightSetting.author:
year = block.yearBegin.content if not block.yearEnd else block.yearEnd.content
if int(year) == copyrightSetting.year:
return True
else :
if hints :
print("Copyright block for " + copyrightSetting.author + " does not cover current year in: " + filename)
return False
if hints :
print("Missing copyright block for " + copyrightSetting.author + " in: " + filename)
return False
else :
if hints :
print("No copyright found in: " + filename)
return False
def replace_data_in_file(filename, begin, end, replaceWith) :
with open(filename, 'r') as file:
content = file.read()
with open(filename, 'w') as file:
file.write(content[:begin] + replaceWith + content[end:])
def set_or_update_copyright(filename) :
if check_copyright(filename, False) :
print("No update required for file: " + filename)
else :
copyrightBlocks = parse_file_new(filename)
username, email = get_userinfo()
copyrightSetting = get_copyright_setting(username, email)
lastBlock = 0
for block in copyrightBlocks :
if block.author.content == copyrightSetting.author :
if not block.yearEnd :
# replace year with range
replace_data_in_file(filename, block.yearBegin.begin, block.yearBegin.end, "%s-%s" % (block.yearBegin.content, str(copyrightSetting.year)))
else :
# replace end of range with current year
replace_data_in_file(filename, block.yearEnd.begin, block.yearEnd.end, "%s" % str(copyrightSetting.year))
return
lastBlock = block.total.end
# No copyright block found. Append a new one.
replace_data_in_file(filename, lastBlock+1, lastBlock+1, "\n" + str(copyrightSetting))
def print_help() :
print("""Usage:
Copyrighter.py check-copyright $filename
Cheks for the existence of a copyright comment block.
Copyrighter.py set-copyright $filename
Adds or updates the existing copyright comment block.
License setting:
A users license configuration can be set via the SWIFT_LICENSE_CONFIG environment variable
in the format "$copyright holder|$license", e.g. "Jane Doe|mit". Possible values for
$license are default, mit and gpl.
""")
if sys.argv[1] == "check-copyright" :
file = sys.argv[2]
if (file.endswith(".cpp") or file.endswith(".h")) and not "3rdParty" in file :
if not check_copyright(file, True) :
sys.exit(-1)
elif sys.argv[1] == "set-copyright" :
file = sys.argv[2]
set_or_update_copyright(file)
else :
print("Unknown command: " + sys.argv[1])
print_help()
sys.exit(-1)
|
