fixlicense.py

彩信浏览器

#!/usr/bin/env python

# This file is part of Ambulant Player, www.ambulantplayer.org.
#
# Copyright (C) 2003-2007 Stichting CWI, 
# Kruislaan 413, 1098 SJ Amsterdam, The Netherlands.
#
# Ambulant Player is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 2.1 of the License, or
# (at your option) any later version.
#
# Ambulant Player 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Ambulant Player; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

# This script requires Python 2.2 or later.
# This script originally written by Sjoerd Mullender from the Monet project.

# backward compatibility for Python 2.2
try:
    True
except NameError:
    False, True = 0, 1

import os, sys, getopt, stat, re

usage = '''\
%(prog)s [-ar] [-l licensefile] [file...]

Options:
-a\tadd license text (default)
-r\tremove license text
-l licensefile
\tprovide alternative license text
\t(handy for removing incorrect license text)

If no file arguments, %(prog)s will read file names from standard input.

%(prog)s makes backups of all modified files.
The backup is the file with a tilde (~) appended.\
'''

license = [
    'This file is part of Ambulant Player, www.ambulantplayer.org.',
    '',
    'Copyright (C) 2003-2007 Stichting CWI, ',
    'Kruislaan 413, 1098 SJ Amsterdam, The Netherlands.',
    '',
    'Ambulant Player is free software; you can redistribute it and/or modify',
    'it under the terms of the GNU Lesser General Public License as published by',
    'the Free Software Foundation; either version 2.1 of the License, or',
    '(at your option) any later version.',
    '',
    'Ambulant Player 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 Lesser General Public License for more details.',
    '',
    'You should have received a copy of the GNU Lesser General Public License',
    'along with Ambulant Player; if not, write to the Free Software',
    'Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA',
    ]

re_copyright = re.compile('Copyright Notice:\n(.*-------*\n)?')

def main():
    func = addlicense
    pre = post = start = end = None
    try:
        opts, args = getopt.getopt(sys.argv[1:], 'arl:',
                                   ['pre=', 'post=', 'start=', 'end='])
    except getopt.GetoptError:
        print >> sys.stderr, usage % {'prog': sys.argv[0]}
        sys.exit(1)
    for o, a in opts:
        if o == '-a':
            func = addlicense
        elif o == '-r':
            func = dellicense
        elif o == '-l':
            try:
                f = open(a)
            except IOError:
                print >> sys.stderr, 'Cannot open file %s' % a
                sys.exit(1)
            del license[:]
            while True:
                line = f.readline()
                if not line:
                    break
                license.append(line[:-1])
            f.close()
        elif o == '--pre':
            pre = a
        elif o == '--post':
            post = a
        elif o == '--start':
            start = a
        elif o == '--end':
            end = a

    if args:
        for a in args:
            func(a, pre=pre, post=post, start=start, end=end)
    else:
        while True:
            filename = sys.stdin.readline()
            if not filename:
                break
            func(filename[:-1], pre=pre, post=post, start=start, end=end)

suffixrules = {
    # suffix:(pre,     post,  start,  end)
    '.ag':   ('',      '',    '# ',   ''),
    '.bash': ('',      '',    '# ',   ''),
    '.brg':  ('/*',    ' */', ' * ',  ''),
    '.c':    ('/*',    ' */', ' * ',  ''),
    '.m':    ('/*',    ' */', ' * ',  ''),
    '.cc':   ('',      '',    '// ',  ''),
    '.mm':   ('',      '',    '// ',  ''),
    '.cf':   ('',      '',    '# ',   ''),
    '.cpp':  ('',      '',    '// ',  ''),
    '.el':   ('',      '',    '; ',   ''),
    '.h':    ('/*',    ' */', ' * ',  ''),
##  '.h':    ('',      '',    '// ',  ''),
    '.hs':   ('',      '',    '-- ',  ''),
    '.html': ('<!--',  '-->', '',     ''),
    '.i':    ('',      '',    '// ',  ''),
    '.java': ('/*',    ' */', ' * ',  ''),
    '.m4':   ('',      '',    'dnl ', ''),
    '.mk':   ('',      '',    '# ',   ''),
    '.msc':  ('',      '',    '# ',   ''),
    '.mx':   ('',      '',    "@' ",  ''),
    '.php':  ('<?php', '?>',  '# ',   ''),
    '.pc':   ('',      '',    '# ',   ''),
    '.pl':   ('',      '',    '# ',   ''),
    '.pm':   ('',      '',    '# ',   ''),
    '.py':   ('',      '',    '# ',   ''),
    '.sh':   ('',      '',    '# ',   ''),
    '.tcl':  ('',      '',    '# ',   ''),
    '.xml':  ('<!--',  '-->', '',     ''),
    }

def addlicense(file, pre = None, post = None, start = None, end = None):
    if pre is None and post is None and start is None and end is None:
        root, ext = os.path.splitext(file)
        if ext == '.in':
            # special case: .in suffix doesn't count
            root, ext = os.path.splitext(root)
        if not suffixrules.has_key(ext):
            # no known suffix
            # see if file starts with #! (i.e. shell script)
            try:
                f = open(file)
                line = f.readline()
                f.close()
            except IOError:
                return
            if line[:2] == '#!':
                ext = '.sh'
            else:
                return
        pre, post, start, end = suffixrules[ext]
    if not pre:
        pre = ''
    if not post:
        post = ''
    if not start:
        start = ''
    if not end:
        end = ''
    try:
        f = open(file)
    except IOError:
        print >> sys.stderr, 'Cannot open file %s' % file
        return
    try:
        g = open(file + '.new', 'w')
    except IOError:
        print >> sys.stderr, 'Cannot create temp file %s.new' % file
        return
    data = f.read()
    res = re_copyright.search(data)
    if res is not None:
        pos = res.end(0)
        g.write(data[:pos])
        g.write(start.rstrip() + '\n')
    else:
        f.seek(0)
        line = f.readline()
        addblank = False
        if line[:2] == '#!':
            # if file starts with #! command interpreter, keep the line there
            g.write(line)
            # add a blank line
            addblank = True
            line = f.readline()
        if line.find('-*-') >= 0:
            # if file starts with an Emacs mode specification, keep
            # the line there
            g.write(line)
            # add a blank line
            addblank = True
            line = f.readline()
        if line[:5] == '<?xml':
            # if line starts with an XML declaration, keep the line there
            g.write(line)
            # add a blank line
            addblank = True
            line = f.readline()
        if addblank:
            g.write('\n')
        if pre:
            g.write(pre + '\n')
    for l in license:
        if l[:1] == '\t' or (not l and (not end or end[:1] == '\t')):
            # if text after start begins with tab, remove spaces from start
            g.write(start.rstrip() + l + end + '\n')
        else:
            g.write(start + l + end + '\n')
    if res is not None:
        # copy rest of file
        g.write(data[pos:])
    else:
        if post:
            g.write(post + '\n')
        # add empty line after license
        if line:
            g.write('\n')
        # but only one, so skip empty line from file, if any
        if line and line != '\n':
            g.write(line)
        # copy rest of file
        g.write(f.read())
    f.close()
    g.close()
    try:
        st = os.stat(file)
        os.chmod(file + '.new', stat.S_IMODE(st.st_mode))
    except OSError:
        pass
    try:
        os.rename(file, file + '~')     # make backup
    except OSError:
        print >> sys.stderr, 'Cannot make backup for %s' % file
        return
    try:
        os.rename(file + '.new', file)
    except OSError:
        print >> sys.stderr, 'Cannot move file %s into position' % file

def normalize(s):
    # normalize white space: remove leading and trailing white space,
    # and replace multiple white space characters by a single space
    return ' '.join(s.split())

def dellicense(file, pre = None, post = None, start = None, end = None):
    if pre is None and post is None and start is None and end is None:
        root, ext = os.path.splitext(file)
        if ext == '.in':
            # special case: .in suffix doesn't count
            root, ext = os.path.splitext(root)
        if not suffixrules.has_key(ext):
            # no known suffix
            # see if file starts with #! (i.e. shell script)
            try:
                f = open(file)
                line = f.readline()
                f.close()
            except IOError:
                return
            if line[:2] == '#!':
                ext = '.sh'
            else:
                return
        pre, post, start, end = suffixrules[ext]
    if not pre:
        pre = ''
    if not post:
        post = ''
    if not start:
        start = ''
    if not end:
        end = ''
    pre = normalize(pre)
    post = normalize(post)
    start = normalize(start)
    end = normalize(end)
    try:
        f = open(file)
    except IOError:
        print >> sys.stderr, 'Cannot open file %s' % file
        return
    try:
        g = open(file + '.new', 'w')
    except IOError:
        print >> sys.stderr, 'Cannot create temp file %s.new' % file
        return
    data = f.read()
    res = re_copyright.search(data)
    if res is not None:
        pos = res.end(0)
        g.write(data[:pos])
        nl = data.find('\n', pos) + 1
        nstart = normalize(start)
        while normalize(data[pos:nl]) == nstart:
            pos = nl
            nl = data.find('\n', pos) + 1
        line = data[pos:nl]
        for l in license:
            nline = normalize(line)
            if nline.find(normalize(l)) >= 0:
                pos = nl
                nl = data.find('\n', pos) + 1
                line = data[pos:nl]
                nline = normalize(line)
            else:
                # doesn't match
                print >> sys.stderr, 'line doesn\'t match in file %s' % file
                print >> sys.stderr, 'file:    "%s"' % line
                print >> sys.stderr, 'license: "%s"' % l
                f.close()
                g.close()
                try:
                    os.unlink(file + '.new')
                except OSError:
                    pass
                return
        pos2 = pos
        nl2 = nl
        if normalize(line) == normalize(start):
            pos2 = nl2
            nl2 = data.find('\n', pos2) + 1
            line = data[pos2:nl2]
            nline = normalize(line)
        if nline.find('Contributors') >= 0:
            nstart = normalize(start)
            nstartlen = len(nstart)
            while normalize(line)[:nstartlen] == nstart and \
                  len(normalize(line)) > 1:
                pos2 = nl2
                nl2 = data.find('\n', pos2) + 1
                line = data[pos2:nl2]
                nline = normalize(line)
            pos = pos2
        g.write(data[pos:])
    else:
        f.seek(0)
        line = f.readline()
        if line[:2] == '#!':
            g.write(line)
            line = f.readline()
            if line and line == '\n':
                line = f.readline()
        if line.find('-*-') >= 0:
            g.write(line)
            line = f.readline()
            if line and line == '\n':
                line = f.readline()
        if line[:5] == '<?xml':
            g.write(line)
            line = f.readline()
            if line and line == '\n':
                line = f.readline()
        nline = normalize(line)
        if pre:
            if nline == pre:
                line = f.readline()
                nline = normalize(line)
            else:
                # doesn't match
                print >> sys.stderr, 'PRE doesn\'t match in file %s' % file
                f.close()
                g.close()
                try:
                    os.unlink(file + '.new')
                except OSError:
                    pass
                return
        for l in license:
            if nline.find(normalize(l)) >= 0:
                line = f.readline()
                nline = normalize(line)
            else:
                # doesn't match
                print >> sys.stderr, 'line doesn\'t match in file %s' % file
                print >> sys.stderr, 'file:    "%s"' % line
                print >> sys.stderr, 'license: "%s"' % l
                f.close()
                g.close()
                try:
                    os.unlink(file + '.new')
                except OSError:
                    pass
                return
        if post:
            if nline == post:
                line = f.readline()
                nline = normalize(line)
            else:
                # doesn't match
                print >> sys.stderr, 'POST doesn\'t match in file %s' % file
                f.close()
                g.close()
                try:
                    os.unlink(file + '.new')
                except OSError:
                    pass
                return
        if line and line != '\n':
            g.write(line)
        g.write(f.read())
    f.close()
    g.close()
    try:
        os.rename(file, file + '~')     # make backup
    except OSError:
        print >> sys.stderr, 'Cannot make backup for %s' % file
        return
    try:
        os.rename(file + '.new', file)
    except OSError:
        print >> sys.stderr, 'Cannot move file %s into position' % file

if __name__ == '__main__' or sys.argv[0] == __name__:
    main()