Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/maint-helper.py
blob: e1bbe22db794179c62bec31fc94f8710f08ae974 (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
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
#!/usr/bin/env python

# Copyright (C) 2007, Red Hat, Inc.
#
# 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 2 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, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

# Latest source available at git://dev.laptop.org/sugar 

import os
import sys
import re
import datetime
import subprocess

source_exts = [ '.py', '.c', '.h', '.cpp' ]

def is_source(path):
    for ext in source_exts:
        if path.endswith(ext):
            return True

def get_name_and_version():
    f = open('configure.ac', 'r')
    config = f.read()
    f.close()

    exp = 'AC_INIT\(\[[^\]]+\],\[([^\]]+)\],\[\],\[([^\]]+)\]'
    match = re.search(exp, config)
    if not match:
        print 'Cannot find the package name and version.'
        sys.exit(0)

    return [ match.group(2), match.group(1) ]

def cmd_help():
    print 'Usage: \n\
maint-helper.py build-snapshot       - build a source snapshot \n\
maint-helper.py fix-copyright [path] - fix the copyright year \n\
maint-helper.py check-licenses       - check licenses in the source'

def cmd_build_snapshot():
    [ name, version ] = get_name_and_version()

    print 'Update git...'

    retcode = subprocess.call(['git', 'pull'])
    if retcode:
        print 'ERROR - cannot pull from git'

    cmd = 'git-show-ref --hash=10 refs/heads/master'
    alphatag = os.popen(cmd).readline().strip()

    tarball = '%s-%s-git%s.tar.bz2' % (name, version, alphatag)

    print 'Build %s...' % tarball

    retcode = subprocess.call(['make', 'distcheck'])
    if retcode:
        sys.exit(0)

    os.rename('%s-%s.tar.bz2' % (name, version), tarball)

    print 'Update NEWS.sugar...'

    if os.environ.has_key('SUGAR_NEWS'):
        sugar_news_path = os.environ['SUGAR_NEWS']
        if os.path.isfile(sugar_news_path):
            f = open(sugar_news_path, 'r')
            sugar_news = f.read()
            f.close()
        else:
            sugar_news = ''

        [ name, version ] = get_name_and_version()
        sugar_news += '%s - %s - %s\n\n' % (name, version, alphatag)

        f = open('NEWS', 'r')
        for line in f.readlines():
            if len(line.strip()) > 0:
                sugar_news += line
            else:
                break
        f.close()

        f = open(sugar_news_path, 'w')
        f.write(sugar_news)
        f.close()

    print 'Update NEWS...'

    f = open('NEWS', 'r')
    news = f.read()
    f.close()

    news = 'Snapshot %s\n\n' % alphatag + news

    f = open('NEWS', 'w')
    f.write(news)
    f.close()

    print 'Committing to git...'

    changelog = 'Snapshot %s.' % alphatag
    retcode = subprocess.call(['git', 'commit', '-a', '-m % s' % changelog])
    if retcode:
        print 'ERROR - cannot commit to git'

    retcode = subprocess.call(['git', 'push'])
    if retcode:
        print 'ERROR - cannot push to git'

    print 'Done.'

def check_licenses(path, license, missing):
    matchers = { 'LGPL' : 'GNU Lesser General Public',
                 'GPL'  : 'GNU General Public License' }

    license_file = os.path.join(path, '.license')
    if os.path.isfile(license_file):
        f = open(license_file, 'r')
        license = f.readline().strip()
        f.close()

    for item in os.listdir(path):
        full_path = os.path.join(path, item)

        if os.path.isdir(full_path):
            check_licenses(full_path, license, missing)
        else:
            check_source = is_source(item)

            # Special cases.
            if item.find('marshal') > 0 or \
               item.startswith('egg') > 0:
                check_source = False

            if check_source:
                f = open(full_path, 'r')
                source = f.read()
                f.close()

                miss_license = True
                if source.find(matchers[license]) > 0:
                    miss_license = False

                # Special cases.
                if source.find('THIS FILE IS GENERATED') > 0:
                    miss_license = False

                if miss_license:
                    if not missing.has_key(license):
                        missing[license] = []
                    missing[license].append(full_path)

def cmd_check_licenses():
    missing = {}
    check_licenses(os.getcwd(), 'GPL', missing)

    for item in missing.keys():
        print '%s:\n' % item
        for path in missing[item]:
            print path
        print '\n'

COPYRIGHT = 'Copyright (C) '

def fix_copyright(path):
    for item in os.listdir(path):
        full_path = os.path.join(path, item)

        if os.path.isdir(full_path):
            fix_copyright(full_path)
        elif is_source(item):
            f = open(full_path, 'r')
            source = f.read()
            f.close()

            year_start = -1
            year_end = -1

            i1 = source.find(COPYRIGHT)
            if i1 != -1:
                i1 += len(COPYRIGHT)
                i2 = i1 + source[i1:].find(' ')
                if i1 > 0:
                    try:
                        year_start = int(source[i1:i1 + 4])
                        year_end = int(source[i1 + 6: i1 + 10])
                    except ValueError:
                        pass

                if year_start > 0 and year_end < 0:
                    year_end = year_start

                year = datetime.date.today().year
                if year_end < year:
                    result = '%s%d-%d%s' % (source[:i1], year_start,
                                            year, source[i2:])
                    f = open(full_path, 'w')
                    f.write(result)
                    f.close()

def cmd_fix_copyright(path):
    fix_copyright(path)

if len(sys.argv) < 2:
    cmd_help()
elif sys.argv[1] == 'build-snapshot':
    cmd_build_snapshot()
elif sys.argv[1] == 'check-licenses':
    cmd_check_licenses()
elif sys.argv[1] == 'fix-copyright' and len(sys.argv) > 2:
    cmd_fix_copyright(sys.argv[2])