copyright.py

# Copyright 2021 The BladeDISC Authors. All rights reserved.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import argparse
import io
import re
import subprocess

COPYRIGHT = '''
Copyright 2023 The RECom Authors. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
'''

LANG_COMMENT_MARK = None

NEW_LINE_MARK = None

COPYRIGHT_HEADER = None

NEW_LINE_MARK = '\n'
COPYRIGHT_HEADER = COPYRIGHT.split(NEW_LINE_MARK)[1]
p = re.search('(\d{4})', COPYRIGHT_HEADER).group(0)  # noqa: W605
process = subprocess.Popen(["date", "+%Y"], stdout=subprocess.PIPE)
date, err = process.communicate()
date = date.decode("utf-8").rstrip("\n")
COPYRIGHT_HEADER = COPYRIGHT_HEADER.replace(p, date)


def generate_copyright(template, lang='go'):
    if lang in ['Python', 'shell']:
        LANG_COMMENT_MARK = '#'
    else:
        LANG_COMMENT_MARK = "//"

    lines = template.split(NEW_LINE_MARK)
    BLANK = " "
    ans = LANG_COMMENT_MARK + BLANK + COPYRIGHT_HEADER + NEW_LINE_MARK
    for lino, line in enumerate(lines):
        if lino == 0 or lino == 1 or lino == len(lines) - 1:
            continue
        if len(line) == 0:
            BLANK = ""
        else:
            BLANK = " "
        ans += LANG_COMMENT_MARK + BLANK + line + NEW_LINE_MARK

    return ans + "\n"


def lang_type(filename):
    if filename.endswith(".py"):
        return "Python"
    elif filename.endswith(".go"):
        return "go"
    elif filename.endswith(".proto"):
        return "go"
    elif filename.endswith(".sh"):
        return "shell"
    elif filename.endswith(".cpp") or filename.endswith(".h") \
            or filename.endswith(".cc"):
        return "cpp"
    else:
        print("Unsupported filetype %s", filename)
        exit(0)


PYTHON_ENCODE = re.compile("^[ \t\v]*#.*?coding[:=][ \t]*([-_.a-zA-Z0-9]+)")


def main(argv=None):
    parser = argparse.ArgumentParser(
        description='Checker for copyright declaration.')
    parser.add_argument('filenames', nargs='*', help='Filenames to check')
    args = parser.parse_args(argv)

    retv = 0
    for filename in args.filenames:
        fd = io.open(filename, encoding="utf-8")
        first_line = fd.readline()
        second_line = fd.readline()
        third_line = fd.readline()
        # check for 3 head lines
        if "COPYRIGHT " in first_line.upper():
            continue
        if "COPYRIGHT " in second_line.upper():
            continue
        if "COPYRIGHT " in third_line.upper():
            continue
        skip_one = False
        skip_two = False
        if first_line.startswith("#!"):
            skip_one = True
        if PYTHON_ENCODE.match(second_line) is not None:
            skip_two = True
        if PYTHON_ENCODE.match(first_line) is not None:
            skip_one = True

        original_content_lines = io.open(filename,
                                         encoding="utf-8").read().split("\n")
        copyright_string = generate_copyright(COPYRIGHT, lang_type(filename))
        if skip_one:
            new_contents = "\n".join(
                [original_content_lines[0], copyright_string] +
                original_content_lines[1:])
        elif skip_two:
            new_contents = "\n".join([
                original_content_lines[0], original_content_lines[1],
                copyright_string
            ] + original_content_lines[2:])
        else:
            new_contents = generate_copyright(
                COPYRIGHT,
                lang_type(filename)) + "\n".join(original_content_lines)
        print('Auto Insert Copyright Header {}'.format(filename))
        with io.open(filename, 'w', encoding='utf8') as output_file:
            output_file.write(new_contents)

    return retv


if __name__ == '__main__':
    exit(main())