summaryrefslogtreecommitdiff
path: root/copyright-statement-lint
blob: 236ece58623fe836b8659118b88b81209eba09d4 (plain)
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
#!/usr/bin/python
# Copyright 2013-2014  Lars Wirzenius
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# =*= License: GPL-3+ =*=


__version__ = '0.1'


import cliapp
import os
import re
import sys


copyright_pattern = re.compile(
      r'Copyright\s+(\([cC]\)\s+)?(?P<years>\d+((,|-|\s)|\d+)*)\s(?P<names>.*)')


class CopyrightStatementLint(cliapp.Application):

      def add_settings(self):
            self.settings.integer(
                  ['debug-commit-year'],
                  'pretend the commit is from YEAR',
                  metavar='YEAR')

      def setup(self):
            self.errors = False

      def cleanup(self):
            if self.errors:
                  sys.exit(1)

      def process_input(self, filename):
            self.statements = []
            cliapp.Application.process_input(self, filename)
            if self.statements:
                  commit_year = self.get_commit_year(filename)
                  if not self.statements_contain_year(commit_year):
                        years = [m.group('years') for m in self.statements]
                        sys.stderr.write(
                              '%s: commit year %s not contained in '
                              'copyright statement years: %s\n' %
                              (filename, commit_year, ' '.join(years)))
                        self.errors = True
            else:
                  sys.stderr.write('%s: no copyright statements\n' % filename)
                  self.errors = True

      def process_input_line(self, filename, line):
            m = copyright_pattern.search(line)
            if m:
                  self.statements.append(m)

      def get_commit_year(self, filename):
            if self.settings['debug-commit-year']:
                  return self.settings['debug-commit-year']

            output = cliapp.runcmd(['git', 'log', '-n1', filename])
            for line in output.splitlines():

                  if line.startswith('Date:'):
                        words = line.split()
                        return int(words[5]) # return year
            return 0 # dummy year

      def statements_contain_year(self, year):
            for match in self.statements:
                  pairs = self.parse_years(match.group('years'))
                  for start, end in pairs:
                        if start <= year <= end:
                              return True
            return False

      def parse_years(self, years):
            pairs = []
            words = [s.strip() for s in years.split(',')]
            for word in words:
                  if '-' in word:
                        start, end = word.split('-', 1)
                  else:
                        start = end = word
                  pairs.append((int(start), int(end)))
            return pairs


CopyrightStatementLint(version=__version__).run()