annotate licenser/licenses.py @ 27:7e0c931a201d

web licenser now works
author Jeff Hammel <jhammel@mozilla.com>
date Fri, 25 Nov 2011 00:57:38 -0800
parents 0faf3e7b593a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
1 # ***** BEGIN LICENSE BLOCK *****
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
2 # Version: MPL 1.1/GPL 2.0/LGPL 2.1
10
952eb98f6f6e remove whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
3 #
5
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
4 # The contents of this file are subject to the Mozilla Public License Version
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
5 # 1.1 (the "License"); you may not use this file except in compliance with
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
6 # the License. You may obtain a copy of the License at
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
7 # http://www.mozilla.org/MPL/
10
952eb98f6f6e remove whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
8 #
5
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
9 # Software distributed under the License is distributed on an "AS IS" basis,
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
10 # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
11 # for the specific language governing rights and limitations under the
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
12 # License.
10
952eb98f6f6e remove whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
13 #
5
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
14 # The Original Code is mozilla.org code.
10
952eb98f6f6e remove whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
15 #
5
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
16 # The Initial Developer of the Original Code is
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
17 # Mozilla.org.
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
18 # Portions created by the Initial Developer are Copyright (C) 2010
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
19 # the Initial Developer. All Rights Reserved.
10
952eb98f6f6e remove whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
20 #
5
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
21 # Contributor(s):
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
22 # Jeff Hammel <jhammel@mozilla.com> (Original author)
10
952eb98f6f6e remove whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
23 #
5
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
24 # Alternatively, the contents of this file may be used under the terms of
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
25 # either of the GNU General Public License Version 2 or later (the "GPL"),
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
26 # or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
27 # in which case the provisions of the GPL or the LGPL are applicable instead
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
28 # of those above. If you wish to allow use of your version of this file only
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
29 # under the terms of either the GPL or the LGPL, and not to allow others to
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
30 # use your version of this file under the terms of the MPL, indicate your
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
31 # decision by deleting the provisions above and replace them with the notice
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
32 # and other provisions required by the GPL or the LGPL. If you do not delete
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
33 # the provisions above, a recipient may use your version of this file under
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
34 # the terms of any one of the MPL, the GPL or the LGPL.
10
952eb98f6f6e remove whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
35 #
5
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
36 # ***** END LICENSE BLOCK *****
10
952eb98f6f6e remove whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
37
1
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
38 import os
11
a8ad01735f71 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
39 import urllib2
0
b0665b243ccd initial import of licenser
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
40 from datetime import datetime
4
e46374799119 do the interpolation
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
41 from string import Template
0
b0665b243ccd initial import of licenser
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
42
14
ed9d64d1fd32 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
43 # types of comments
ed9d64d1fd32 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
44
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
45 class CommentedFile(object):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
46
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
47 extensions = set()
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
48
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
49 @classmethod
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
50 def match(cls, filename):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
51 basename, extension = os.path.splitext(os.path.basename(filename))
20
272e10163900 minor fixes
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
52 extension = extension.lstrip('.')
19
73e815e13914 fix a few things
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
53 if extension in cls.extensions:
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
54 return cls(filename)
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
55
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
56 def __init__(self, filename):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
57 self.filename = filename
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
58
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
59 def fileobj(self):
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
60 """return a file object open for writing"""
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
61 if isinstance(self.filename, basestring):
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
62 return file(self.filename, 'w')
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
63 return self.filename
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
64
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
65 def close(self, _file):
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
66 if isinstance(self.filename, basestring):
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
67 _file.close()
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
68
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
69 def isempty(self):
24
d3e3a506dd29 tests now pass
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
70 return not bool(file(self.filename).read().strip)
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
71
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
72 def lines(self):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
73 if hasattr(self, '_lines'):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
74 return self._lines
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
75 self._lines = file(self.filename).readlines()
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
76 return self._lines
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
77
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
78 class AsteriskCommentsFile(CommentedFile):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
79
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
80 extensions = set(['c'])
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
81
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
82 def __call__(self, license):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
83
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
84 lines = self.lines()
21
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
85 if self.isempty():
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
86 return # you're done
25
8729685a2cf6 stub web interface
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
87
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
88 # open the file for writing
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
89 f = self.fileobj()
21
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
90
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
91 # print the license
22
9db63b0119de syntax error
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
92 license_lines = license.splitlines()
24
d3e3a506dd29 tests now pass
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
93 for index, line in enumerate(license_lines):
21
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
94 prefix = ' *'
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
95 suffix = ''
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
96 if index == len(license_lines) - 1:
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
97 suffix = ' */'
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
98 if not index:
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
99 prefix = '/*'
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
100 print >> f, '%s %s%s' % (prefix, line, suffix)
24
d3e3a506dd29 tests now pass
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
101 print >> f
21
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
102
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
103 # print the rest of the file
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
104 for line in lines:
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
105 f.write(line)
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
106 self.close(f)
21
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
107
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
108
19
73e815e13914 fix a few things
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
109 class HashCommentsFile(CommentedFile):
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
110
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
111 extensions = set(['py', 'sh'])
14
ed9d64d1fd32 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
112
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
113 def __call__(self, license):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
114 """interpolate the file"""
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
115
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
116 lines = self.lines()
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
117 if self.isempty():
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
118 return # you're done
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
119
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
120 # open the file for writing
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
121 f = self.fileobj()
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
122
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
123 # print shebang if it exists
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
124 if lines[0].startswith('#!'):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
125 shebang = lines.pop(0).strip()
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
126 print >> f, shebang
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
127 print >> f
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
128
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
129 # print the license
21
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
130 for line in license.splitlines():
80193ae99aaf fill out asterisk-style licenses
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
131 print >> f, '# %s' % line
14
ed9d64d1fd32 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
132
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
133 # print the rest of the file
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
134 for line in lines:
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
135 f.write(line)
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
136 self.close(f)
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
137
23
ba47f936e9f6 remove unneeded argument
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
138 def isempty(self):
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
139 """
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
140 determines if a file is empty; that is, contains only comments
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
141 """
18
c04a53145f19 interpolate the files, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 17
diff changeset
142 for line in self.lines():
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
143 line = line.strip()
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
144 if line and line[0] != '#':
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
145 return False
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
146 return True
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
147
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
148
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
149 filetypes = [HashCommentsFile, AsteriskCommentsFile]
14
ed9d64d1fd32 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
150
25
8729685a2cf6 stub web interface
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
151 def filetypes_string(filetypes=filetypes[:]):
8729685a2cf6 stub web interface
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
152 extensions = set()
8729685a2cf6 stub web interface
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
153 for filetype in filetypes:
8729685a2cf6 stub web interface
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
154 extensions.update(filetype.extensions)
8729685a2cf6 stub web interface
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
155 return ', '.join([i for i in extensions])
8729685a2cf6 stub web interface
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
156
1
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
157 class License(object):
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
158 """Abstract base class for a license"""
1
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
159
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
160 variables = [] # required variables
1
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
161
18
c04a53145f19 interpolate the files, i hope
Jeff Hammel <jhammel@mozilla.com>
parents: 17
diff changeset
162 def __init__(self, filetypes=filetypes[:]):
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
163 if self.template:
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
164 if not os.path.isabs(self.template):
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
165 self.template = os.path.join(os.path.dirname(__file__),
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
166 'licenses',
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
167 self.template)
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
168 assert os.path.exists(self.template)
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
169 self.filetypes = filetypes
25
8729685a2cf6 stub web interface
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
170
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
171 def license(self):
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
172 return file(self.template).read()
1
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
173
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
174 def print_license(self):
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
175 print self.license()
11
a8ad01735f71 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
176
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
177 def token(self):
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
178 """a token indicative of the license, by default the first line"""
19
73e815e13914 fix a few things
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
179 return self.license().splitlines()[0].strip()
3
e700bd2ec289 finish basic structure
Jeff Hammel <jhammel@mozilla.com>
parents: 2
diff changeset
180
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
181 def has_license(self, filename):
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
182 """does the file already have a license?"""
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
183 token = self.token()
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
184 if isinstance(filename, basestring):
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
185 f = file(filename)
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
186 else:
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
187 f = filename
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
188 for line in f.readlines():
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
189 if token in line:
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
190 return True
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
191 return False
14
ed9d64d1fd32 stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
192
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
193 def __call__(self, directory, **kw):
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
194 variables = self.obtain_variables(**kw)
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
195 self.interpolate(directory, variables)
2
b8d620fa1116 solidify refactored workflow"
Jeff Hammel <jhammel@mozilla.com>
parents: 1
diff changeset
196
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
197 def obtain_variables(self, **kw):
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
198 for var in self.variables:
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
199 if var not in kw:
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
200 import pdb; pdb.set_trace()
15
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
201 print 'Enter %s: ' % var,
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
202 kw[var] = raw_input()
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
203 self.pre(kw)
cf920f85fb98 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 14
diff changeset
204 return kw
1
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
205
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
206 def pre(self, variables):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
207 """do anything that needs to be done with the variables before interpolation"""
6
0a01ed263c06 add ability to interpolate a single file; should move to makeitso
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
208
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
209 def filetype(self, _file):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
210 """determine the filetype for a given file"""
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
211 for filetype in self.filetypes:
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
212 match = filetype.match(_file)
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
213 if match:
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
214 return match
6
0a01ed263c06 add ability to interpolate a single file; should move to makeitso
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
215
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
216 def interpolate_file(self, _file, variables):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
217
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
218 # if the file is licensed, no need to proceed
19
73e815e13914 fix a few things
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
219 if self.has_license(_file):
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
220 return # you're done
6
0a01ed263c06 add ability to interpolate a single file; should move to makeitso
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
221
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
222 # get the filetype
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
223 filetype = self.filetype(_file)
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
224 if not filetype:
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
225 return # you're done
10
952eb98f6f6e remove whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
226
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
227 # get the license
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
228 license = self.interpolate_license(**variables)
1
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
229
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
230 # add the license to the file
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
231 filetype(license)
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
232
27
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
233
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
234 def interpolate_license(self, **variables):
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
235 license = self.license()
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
236 return Template(license).substitute(**variables)
7e0c931a201d web licenser now works
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
237
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
238 def interpolate(self, directory, variables):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
239 for _file in self.files(directory):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
240 self.interpolate_file(_file, variables)
1
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
241
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
242 def files(self, directory):
19
73e815e13914 fix a few things
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
243 files = []
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
244 for dirpath, _, filenames in os.walk(directory):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
245 for f in filenames:
19
73e815e13914 fix a few things
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
246 files.append(os.path.join(dirpath, f))
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
247 return files
1
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
248
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
249
cc5add25bf83 abstract License to its own class and do the work there
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
250 class MPL(License):
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
251 """Mozilla Public License"""
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
252 template = 'MPL' # could be implicit here
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
253 variables = [ 'author', 'email' ]
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
254 url = 'http://www.mozilla.org/MPL/boilerplate-1.1/mpl-tri-license-txt'
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
255
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
256 def license(self):
11
a8ad01735f71 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
257
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
258 if hasattr(self, '_license'):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
259 # return the cached copy
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
260 return self._license
26
0faf3e7b593a more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
261
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
262 # get the raw license
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
263 raw = urllib2.urlopen(self.url).read()
11
a8ad01735f71 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
264
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
265 # now make it something not crazy
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
266 lines = raw.splitlines()
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
267 contributor_index = None
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
268 for index, line in enumerate(lines):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
269 if line.startswith('The Original Code is'):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
270 lines[index] = 'The Original Code is mozilla.org code.'
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
271 if line.startswith('_'):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
272 lines[index] = 'the Mozilla Foundation.'
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
273 if '2___' in line:
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
274 lines[index] = line.replace('2___', '${year}')
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
275 if line.startswith('Contributor'):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
276 contributor_index = index
11
a8ad01735f71 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
277
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
278 assert contributor_index
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
279 lines.insert(contributor_index+1, ' ${author} <${email}>')
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
280 self._license = '\n'.join(lines)
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
281 return self._license
5
f7d485cedc80 recursively use licenser on itself; useful and proof of concept
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
282
17
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
283 def pre(self, variables):
4566b3ac9838 this may almost work
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
284 variables['year'] = datetime.now().year
11
a8ad01735f71 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
285