diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..d63e4dc64 --- /dev/null +++ b/LICENSE @@ -0,0 +1,190 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2023 Space and Time Labs, Inc. + + 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. diff --git a/tools/code_format/check_format.py b/tools/code_format/check_format.py index 86038aa2c..0e66930a0 100755 --- a/tools/code_format/check_format.py +++ b/tools/code_format/check_format.py @@ -24,6 +24,7 @@ CLANG_FORMAT_PATH = os.getenv("CLANG_FORMAT", "clang-format-17") BUILD_FIXER_PATH = os.path.join(os.path.dirname(os.path.abspath(sys.argv[0])), "build_fixer.py") HEADER_ORDER_PATH = os.path.join(os.path.dirname(os.path.abspath(sys.argv[0])), "header_order.py") +COPYRIGHT_FIXER_PATH = os.path.join(os.path.dirname(os.path.abspath(sys.argv[0])), "copyright_fixer.py") SUBDIR_SET = set(common.include_dir_order()) @@ -221,20 +222,29 @@ def fix_source_path(self, file_path): error_messages = [] error_messages += self.fix_header_order(file_path) - error_messages += self.clang_format(file_path) + error_messages += self.fix_header_copyright(file_path) + error_messages += self.fix_clang_format(file_path) return error_messages def check_source_path(self, file_path): error_messages = self.check_file_contents(file_path, self.check_source_line) + # check header order command = ( "%s --include_dir_order %s --path %s | diff %s -" % (HEADER_ORDER_PATH, self.include_dir_order, file_path, file_path)) - error_messages += self.execute_check_command( command, "header_order.py check failed", file_path) + # check header copyright + command = ( + "%s --path %s | diff %s -" % + (COPYRIGHT_FIXER_PATH, file_path, file_path)) + error_messages += self.execute_check_command( + command, "copyright_fixer.py check failed", file_path) + + # check clang format command = ("%s %s | diff %s -" % (CLANG_FORMAT_PATH, file_path, file_path)) error_messages += self.execute_check_command(command, "clang-format check failed", file_path) @@ -287,7 +297,16 @@ def fix_header_order(self, file_path): return [] - def clang_format(self, file_path): + def fix_header_copyright(self, file_path): + command = "%s --rewrite --path %s" % ( + COPYRIGHT_FIXER_PATH, file_path) + + if self.execute_fix_command(command, file_path) != 0: + return ["copyright_fixer.py rewrite error: %s" % (file_path)] + + return [] + + def fix_clang_format(self, file_path): command = "%s -i %s" % (CLANG_FORMAT_PATH, file_path) if self.execute_fix_command(command, file_path) != 0: diff --git a/tools/code_format/copyright_fixer.py b/tools/code_format/copyright_fixer.py new file mode 100755 index 000000000..ac1d3d3ff --- /dev/null +++ b/tools/code_format/copyright_fixer.py @@ -0,0 +1,126 @@ +#!/usr/bin/python3 + +import sys +import re +import argparse +import pathlib +import sys +import datetime + +SXT_COPYRIGHT_KEY = "Copyright" +SXT_COPYRIGHT_YEAR = SXT_COPYRIGHT_KEY + " XYZ" +SXT_COPYRIGHT_BEG_MARKER = "/** Proofs GPU - Space and Time's cryptographic proof algorithms on the CPU and GPU." +SXT_COPYRIGHT_END_MARKER = " */" +SXT_COPYRIGHT = ( + """ * + * """ + + SXT_COPYRIGHT_YEAR + + """ Space and Time Labs, Inc. + * + * 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.""" +) + + +def extract_copyright_year(block_comment): + if len(block_comment) > 0: + # Extract the current year from the existing block comment + block_comment = "\n".join(block_comment) + copyright_match = re.search( + (SXT_COPYRIGHT_KEY + "\s*\d+(\s*-\s*\d+|(\s*,\s*\d+)*)"), block_comment + ).group(0) + copyright_year = str(copyright_match).replace(SXT_COPYRIGHT_KEY, "").strip() + + return copyright_year + else: + # If there is no copyright, annotate the new copyright with the current year + return str(datetime.date.today().year) + + +def read_copyright_block(all_lines): + copyright_lines = [] + + try: + # Iterate through the lines until we find the end of the copyright block. + while True: + line = next(all_lines) + if line == SXT_COPYRIGHT_END_MARKER: + break + copyright_lines.append(line) + except StopIteration: + print("Error: could not find end of copyright block", file=sys.stderr) + sys.exit(1) + + return copyright_lines + + +# Fix the copyright header +def fix_copyright_header(path): + pathl = pathlib.Path(path) + source = pathl.read_text(encoding="utf-8") + all_lines = iter(source.split("\n")) + + copyright_lines = [] + non_copyright_lines = [] + + try: + # Iterate through the lines until we find the beginning + # of the copyright block or the end of the file. + while True: + line = next(all_lines) + if line == SXT_COPYRIGHT_BEG_MARKER: + copyright_lines = read_copyright_block(all_lines) + else: + non_copyright_lines.append(line) + except StopIteration: + pass + + # Collect the remaining lines in `non_copyright_lines`. + non_copyright_lines += list(all_lines) + + copyright_year = extract_copyright_year(copyright_lines) + + # Update year only if the copyright notice doesn't exist. + copyright_lines = str(SXT_COPYRIGHT).replace( + SXT_COPYRIGHT_YEAR, SXT_COPYRIGHT_KEY + " " + copyright_year + ) + + return "\n".join( + filter( + lambda x: x, + [ + SXT_COPYRIGHT_BEG_MARKER, + copyright_lines, + SXT_COPYRIGHT_END_MARKER, + "\n".join(non_copyright_lines), + ], + ) + ) + + +def parse_args(): + parser = argparse.ArgumentParser(description="Header reordering.") + parser.add_argument("--path", type=str, help="Specify the path to the header file") + parser.add_argument( + "--rewrite", action="store_true", help="Rewrite header file in-place" + ) + return parser.parse_args() + + +if __name__ == "__main__": + args = parse_args() + copyrightd_source = fix_copyright_header(args.path) + + if args.rewrite: + pathlib.Path(args.path).write_text(copyrightd_source, encoding="utf-8") + else: + sys.stdout.buffer.write(copyrightd_source.encode("utf-8"))