diff --git a/filter-ignorable-copyrights/.gitignore b/filter-ignorable-copyrights/.gitignore new file mode 100644 index 0000000..e2cae22 --- /dev/null +++ b/filter-ignorable-copyrights/.gitignore @@ -0,0 +1,2 @@ +/build/ +/dist/ diff --git a/filter-ignorable-copyrights/MANIFEST.in b/filter-ignorable-copyrights/MANIFEST.in new file mode 100644 index 0000000..c2cc854 --- /dev/null +++ b/filter-ignorable-copyrights/MANIFEST.in @@ -0,0 +1,11 @@ +graft src + +include setup.py +include setup.cfg +include .gitignore +include README.md +include MANIFEST.in +include NOTICE +include apache-2.0.LICENSE + +global-exclude *.py[co] __pycache__ *.*~ diff --git a/filter-ignorable-copyrights/NOTICE b/filter-ignorable-copyrights/NOTICE new file mode 100644 index 0000000..eefa408 --- /dev/null +++ b/filter-ignorable-copyrights/NOTICE @@ -0,0 +1,25 @@ +Software license +================ + +Copyright (c) nexB Inc. and others. All rights reserved. +http://nexb.com and https://github.com/nexB/scancode-toolkit/ +The ScanCode software is licensed under the Apache License version 2.0. +Data generated with ScanCode require an acknowledgment. +ScanCode is a trademark of nexB Inc. + +You may not use this software except in compliance with the License. +You may obtain a copy of the License at: http://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. + +When you publish or redistribute any data created with ScanCode or any ScanCode +derivative work, you must accompany this data with the following acknowledgment: + + Generated with ScanCode and provided on an "AS IS" BASIS, WITHOUT WARRANTIES + OR CONDITIONS OF ANY KIND, either express or implied. No content created from + ScanCode should be considered or used as legal advice. Consult an Attorney + for any legal advice. + ScanCode is a free software code scanning tool from nexB Inc. and others. + Visit https://github.com/nexB/scancode-toolkit/ for support and download. diff --git a/filter-ignorable-copyrights/README.md b/filter-ignorable-copyrights/README.md new file mode 100644 index 0000000..d030791 --- /dev/null +++ b/filter-ignorable-copyrights/README.md @@ -0,0 +1,2 @@ +A post-scan plugin to filter out ignorable-copyrights that are read from license's yaml file. +These copyrights are just noise as these are the copyrights for the license text and not for the code itself diff --git a/filter-ignorable-copyrights/apache-2.0.LICENSE b/filter-ignorable-copyrights/apache-2.0.LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/filter-ignorable-copyrights/apache-2.0.LICENSE @@ -0,0 +1,202 @@ + + 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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/filter-ignorable-copyrights/setup.cfg b/filter-ignorable-copyrights/setup.cfg new file mode 100644 index 0000000..917cf1e --- /dev/null +++ b/filter-ignorable-copyrights/setup.cfg @@ -0,0 +1,8 @@ +[metadata] +license_file = NOTICE + +[bdist_wheel] +universal = 1 + +[aliases] +release = clean --all bdist_wheel diff --git a/filter-ignorable-copyrights/setup.py b/filter-ignorable-copyrights/setup.py new file mode 100644 index 0000000..1df66f1 --- /dev/null +++ b/filter-ignorable-copyrights/setup.py @@ -0,0 +1,53 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from __future__ import absolute_import +from __future__ import print_function + +from glob import glob +from os.path import basename +from os.path import join +from os.path import splitext + +from setuptools import find_packages +from setuptools import setup + + +desc = '''A ScanCode post-scan plugin to filter out copyrights that are for the + license text and not the code itself''' + +setup( + name='filter-ignorable-copyrights', + version='1.0.0', + license='Apache-2.0 with ScanCode acknowledgment', + description=desc, + long_description=desc, + author='nexB', + author_email='info@aboutcode.org', + url='https://github.com/nexB/scancode-toolkit/plugins/scancode-categories', + packages=find_packages('src'), + package_dir={'': 'src'}, + py_modules=[splitext(basename(path))[0] for path in glob('src/*.py')], + include_package_data=True, + zip_safe=False, + classifiers=[ + # complete classifier list: http://pypi.python.org/pypi?%3Aaction=list_classifiers + 'Development Status :: 4 - Beta', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: Apache Software License', + 'Programming Language :: Python', + 'Programming Language :: Python :: 3.6', + 'Topic :: Utilities', + ], + keywords=[ + 'scancode', 'plugin', 'post-scan', 'filter-ignorable-copyrights' + ], + install_requires=[ + 'scancode-toolkit', + ], + entry_points={ + 'scancode_post_scan': [ + 'filter-ignorable-copyrights = filter_ignorable_copyrights.filter_ignorable_copyrights:FilterIgnorableCopyrights', + ], + } +) \ No newline at end of file diff --git a/filter-ignorable-copyrights/src/__init__.py b/filter-ignorable-copyrights/src/__init__.py new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/filter-ignorable-copyrights/src/__init__.py @@ -0,0 +1 @@ + diff --git a/filter-ignorable-copyrights/src/filter_ignorable_copyrights/__init__.py b/filter-ignorable-copyrights/src/filter_ignorable_copyrights/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/filter-ignorable-copyrights/src/filter_ignorable_copyrights/filter_ignorable_copyrights.py b/filter-ignorable-copyrights/src/filter_ignorable_copyrights/filter_ignorable_copyrights.py new file mode 100644 index 0000000..53b2140 --- /dev/null +++ b/filter-ignorable-copyrights/src/filter_ignorable_copyrights/filter_ignorable_copyrights.py @@ -0,0 +1,77 @@ +from plugincode.post_scan import PostScanPlugin +from plugincode.post_scan import post_scan_impl +from commoncode.cliutils import PluggableCommandLineOption +from commoncode.cliutils import POST_SCAN_GROUP + +import saneyaml +import licensedcode +from os.path import abspath +from os.path import dirname +from os.path import join + +@post_scan_impl +class FilterIgnorableCopyrights(PostScanPlugin): + """ + A post-scan plugin to filter out ignorable-copyrights that are read from license's yaml + file. These copyrights are just noise as these are the copyrights for the license text + and not for the code itself. + """ + + options = [ + PluggableCommandLineOption(('--filter-ignorable-copyrights',), + is_flag=True, default=False, + help='Filter out copyrights that are for the license text and note the code itself', + help_group=POST_SCAN_GROUP) + ] + + def is_enabled(self, filter_ignorable_copyrights, **kwargs): + return filter_ignorable_copyrights + + def process_codebase(self, codebase, filter_ignorable_copyrights, **kwargs): + """ + Remove ignorable copyrights from resource that are detected in the same line ranges + as the licenses. + """ + if not self.is_enabled(filter_ignorable_copyrights): + return + + licenses_dir = join(abspath(dirname(licensedcode.__file__)), 'data', 'licenses') + + for resource in codebase.walk(topdown=True): + if not resource.is_file: + continue + try: + licenses = [entry for entry in resource.licenses] + copyrights = [entry for entry in resource.copyrights] + except AttributeError: + continue + + for license in licenses: + copyrights_temp = [] + for copyright in copyrights: + if not self.in_range(license, copyright): + continue + + ignorable_copyrights = self.get_ignorable_copyrights(licenses_dir, license.get('key')) + + if copyright.get('value') not in ignorable_copyrights: + copyrights_temp.append(copyright) + + resource.copyrights = copyrights_temp + + codebase.save_resource(resource) + + def in_range(self, license, copyright): + return license.get('start_line') <= copyright.get( + 'start_line') and license.get('end_line') >= copyright.get('end_line') + + def get_ignorable_copyrights(self, licenses_dir, key): + if not licenses_dir or not exists(licenses_dir): + return [] + + file_path = join(licenses_dir, key + '.yml') + with open(file_path, 'r') as f: + file_content = f.read() + + data = saneyaml.load(file_content) + return data.get('ignorable_copyrights', [])