updateCopyright.pl 6.47 KB
Newer Older
1 2
#!/usr/bin/perl -w

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
############################################################################
#
# Copyright (C) 2016 The Qt Company Ltd.
# Contact: https://www.qt.io/licensing/
#
# This file is part of Qt Creator.
#
# Commercial License Usage
# Licensees holding valid commercial Qt licenses may use this file in
# accordance with the commercial license agreement provided with the
# Software or, alternatively, in accordance with the terms contained in
# a written agreement between you and The Qt Company. For licensing terms
# and conditions see https://www.qt.io/terms-conditions. For further
# information use the contact form at https://www.qt.io/contact-us.
#
# GNU General Public License Usage
# Alternatively, this file may be used under the terms of the GNU
# General Public License version 3 as published by the Free Software
# Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
# included in the packaging of this file. Please review the following
# information to ensure the GNU General Public License requirements will
# be met: https://www.gnu.org/licenses/gpl-3.0.html.
#
############################################################################

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 226 227 228 229 230 231 232
use strict;

my $old_template = shift @ARGV;
my $new_template = shift @ARGV;
my $file = shift @ARGV;

# Usage: git grep "(C) " | cut -d':' -f1 | sort -u | xargs -L 1 scripts/updateCopyright.pl old.header new.header

# This will remove a verbatim copy of old.header from the file
# given as the last argument and then inserts the new.header
# instead. It may retain copyright year, copyright holder, author
# lines or "this file is part of" information.

# All lines of the old.header are compared to the lines in the file.
# Exceptions are lines matching "Copyright (C) (\d+) ", "Author: " or
# "file is part of" which will must also match both the old.template
# as well as the file-line to be considered a match.

# If there is no match between old.header and the start of file, then
# the file is skipped.

### Set which information to keep from the file here:
my $keepYear = 0;
my $keepHolder = 1;
my $keepContact = 1;
my $keepPartOf = 1;
my $keepAuthors = 1;

### Do not edit below this line...

die "Usage: $0 /path/to/oldtemplate /path/to/newtemplate /path/to/file\n" unless $file;

open TEMPLATE, "<$old_template" or die $!;
my @oldT = <TEMPLATE>;
close TEMPLATE;

open TEMPLATE, "<$new_template" or die $!;
my @newT = <TEMPLATE>;
close TEMPLATE;

open FILE, "<$file" or die $!;
my @contents = <FILE>;
close FILE;

my $currentLineNo = -1;
my $oldLineNo = -1;
my @copyrightYear;
my @copyrightHolder;
my @authors;
my $contactInfo = "";
my $partOf = "";

my $matched = 1;

my $hadCopyright = 0;
my $hadAuthors = 0;

foreach (@contents) {
    last unless $matched;

    my $currentLine = $_;
    ++$currentLineNo;
    ++$oldLineNo unless $hadCopyright or $hadAuthors;

    last if $oldLineNo == @oldT;

    my $oldLine = $oldT[$oldLineNo];

    # print "$currentLineNo: $currentLine";
    # print "old: $oldLine";

    if ($currentLine =~ / Copyright .C. (\d+) (.*)$/i) {
        $hadAuthors = 0;

        push(@copyrightYear, $1);
        my $holder = $2;
        # sanitize "Copyright (C) 2014 - 2016 whoever"
        if ($holder =~ /^- \d\d\d\d (.*)$/) { $holder = $1; }
        push(@copyrightHolder, $holder);

        ## print "  Found copyright ($1, $2)...\n";

        if (!$hadCopyright) {
            $hadCopyright = 1;
            ++$oldLineNo;
            $matched = 0 unless $oldLine =~ / Copyright .C. \d+ /i;
            ### print "    matched copyright: $matched\n";
        }
        next;
    }
    $hadCopyright = 0;

    if ($currentLine =~ / Author: (.*)$/i) {
        push(@authors, $1);

        ## print "  Found author...\n";

        if (!$hadAuthors) {
            $hadAuthors = 1;
            ++$oldLineNo;
            $matched = 0 unless $oldLine =~ / Author: /i;
            ### print "    matched author: $matched\n";
        }
        next;
    }
    $hadAuthors = 0;

    if ($currentLine =~ / Contact: (.*)$/i) {
        $contactInfo = $1;
        ## print "  Found contact...\n";
        $matched = 0 unless $oldLine =~ / Contact: /i;
        ### print "    matched contact: $matched\n";
        next;
    }
    if ($currentLine =~ / file is part of (.*)$/) {
        $partOf = $1;
        ## print "  Found part of...\n";
        $matched = 0 unless $oldLine =~ / file is part of /;
        ### print "    matched partOf: $matched\n";
        next;
    }
    $matched = 0 unless $oldLine eq $currentLine;
    ### print "    GENERIC: $matched\n";
}

if (!$matched) {
    print "$file: did not match input template. Skipping.\n";
    exit 0;
}

# remove empty lines...
++$currentLineNo while ($currentLineNo < @contents and $contents[$currentLineNo] =~ /^\s*$/);

splice @contents, 0, $currentLineNo;

print "Contents found in $file:\n";
print "Copyright:\n";
for (my $i = 0; $i < @copyrightYear; ++$i) {
    print "    " . $copyrightYear[$i] . " - " . $copyrightHolder[$i] . ".\n";
}
print "Authors:\n";
foreach (@authors) { print "    $_...\n"; }
print "Contact: $contactInfo...\n";

### Write file:
my $hasEmptyLine = 0;
open FILE, ">$file" or die "Failed to write into $file: $!.\n";

foreach (@newT) {
    my $currentLine = $_;

    $hasEmptyLine = ($currentLine =~ /^\s*$/);

    if ($currentLine =~ /^(.* Copyright .C.) (\d+) (.*)$/i) {
        my $prefix = $1;
        my $year = $2;
        my $holder = $3;
        if ($keepYear || $keepHolder) {
            for (my $i = 0; $i < @copyrightYear; ++$i) {
                my $y = $year;
                $y = $copyrightYear[$i] if $keepYear;
                my $h = $holder;
                $h = $copyrightHolder[$i] if $keepHolder;
                print FILE "$prefix $y $h\n";
            }
            next;
        }
    }

    if ($currentLine =~ /^(.* Author:) (.*)$/i) {
        my $prefix = $1;
        my $author = $2;

        if ($keepAuthors) {
            foreach (@authors) { print FILE "$prefix $_\n"; }
            next;
        }
    }

    if ($currentLine =~ /^(.* Contact:) (.*)$/i) {
        my $prefix = $1;
        $contactInfo = $2 unless $contactInfo;
        if ($keepContact) {
            print FILE "$prefix $contactInfo\n";
            next;
        }
    }

    if ($currentLine =~ /^(.* file is part of) (.*)$/) {
        my $prefix = $1;
        if ($keepPartOf) {
            $partOf = $2 unless $partOf;
            print FILE "$prefix $partOf\n";
            next;
        }
    }

    print FILE $currentLine;
}

print FILE "\n" unless ($hasEmptyLine);

foreach (@contents) { print FILE $_; }

close FILE;