From 017c059433c42ed8cc4f8e0fc87c9b1120b91e56 Mon Sep 17 00:00:00 2001 From: "John M. Horan" Date: Mon, 7 Oct 2019 10:55:05 -0700 Subject: [PATCH] Create initial category post-scan plugin #1745 * Install by navigating to /scancode-toolkit/plugins/scancode-categories/ and running 'pip install .' * Rules comprise a set of any() and all() functions contained as string values in a list of JSON objects. * Current test ruleset is quite small, based solely on scan of bionic-master-libc-bionic.tar.gz-extract * Current working ruleset: /scancode-categories/src/python_rules/python_rules_01.py * Command example: scancode -i -n 2 --categories --json * Currently uses JSON object inside .py file. Test of .json file coming soon. * Unable thus far to create working rules (1) using YAML or text files or (2) without including Python code (any/all() functions) inside the rules themselves. * Code not yet cleaned up -- still a WIP. Signed-off-by: John M. Horan --- LICENSE.txt | 748 ++++++++++++++++++ plugins/scancode-categories/.gitignore | 2 + plugins/scancode-categories/MANIFEST.in | 11 + plugins/scancode-categories/NOTICE | 25 + plugins/scancode-categories/README.md | 15 + .../scancode-categories/apache-2.0.LICENSE | 202 +++++ plugins/scancode-categories/setup.cfg | 8 + plugins/scancode-categories/setup.py | 55 ++ plugins/scancode-categories/src/__init__.py | 0 .../src/plugin_categories/__init__.py | 0 .../plugin_categories/plugin_categories.py | 219 +++++ .../plugin_categories_test_01.py | 348 ++++++++ .../plugin_categories_test_02.py | 363 +++++++++ .../plugin_categories_test_03.py | 122 +++ .../src/plugin_categories/test_rules.py | 63 ++ .../plugin_categories/test_rules_simple_01.py | 34 + .../src/python_rules/__init__.py | 0 .../src/python_rules/python_rules_01.py | 34 + .../src/text_rules/text_rules_01.txt | 61 ++ .../src/yaml_rules/test_yaml_rules_01.yml | 34 + .../src/yaml_rules/test_yaml_rules_02.yml | 9 + 21 files changed, 2353 insertions(+) create mode 100644 LICENSE.txt create mode 100644 plugins/scancode-categories/.gitignore create mode 100644 plugins/scancode-categories/MANIFEST.in create mode 100644 plugins/scancode-categories/NOTICE create mode 100644 plugins/scancode-categories/README.md create mode 100644 plugins/scancode-categories/apache-2.0.LICENSE create mode 100644 plugins/scancode-categories/setup.cfg create mode 100644 plugins/scancode-categories/setup.py create mode 100644 plugins/scancode-categories/src/__init__.py create mode 100644 plugins/scancode-categories/src/plugin_categories/__init__.py create mode 100644 plugins/scancode-categories/src/plugin_categories/plugin_categories.py create mode 100644 plugins/scancode-categories/src/plugin_categories/plugin_categories_test_01.py create mode 100644 plugins/scancode-categories/src/plugin_categories/plugin_categories_test_02.py create mode 100644 plugins/scancode-categories/src/plugin_categories/plugin_categories_test_03.py create mode 100644 plugins/scancode-categories/src/plugin_categories/test_rules.py create mode 100644 plugins/scancode-categories/src/plugin_categories/test_rules_simple_01.py create mode 100644 plugins/scancode-categories/src/python_rules/__init__.py create mode 100644 plugins/scancode-categories/src/python_rules/python_rules_01.py create mode 100644 plugins/scancode-categories/src/text_rules/text_rules_01.txt create mode 100644 plugins/scancode-categories/src/yaml_rules/test_yaml_rules_01.yml create mode 100644 plugins/scancode-categories/src/yaml_rules/test_yaml_rules_02.yml diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000000..96aa5b50fe5 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,748 @@ +A. HISTORY OF THE SOFTWARE +========================== + +Python was created in the early 1990s by Guido van Rossum at Stichting +Mathematisch Centrum (CWI, see http://www.cwi.nl) in the Netherlands +as a successor of a language called ABC. Guido remains Python's +principal author, although it includes many contributions from others. + +In 1995, Guido continued his work on Python at the Corporation for +National Research Initiatives (CNRI, see http://www.cnri.reston.va.us) +in Reston, Virginia where he released several versions of the +software. + +In May 2000, Guido and the Python core development team moved to +BeOpen.com to form the BeOpen PythonLabs team. In October of the same +year, the PythonLabs team moved to Digital Creations, which became +Zope Corporation. In 2001, the Python Software Foundation (PSF, see +https://www.python.org/psf/) was formed, a non-profit organization +created specifically to own Python-related Intellectual Property. +Zope Corporation was a sponsoring member of the PSF. + +All Python releases are Open Source (see http://www.opensource.org for +the Open Source Definition). Historically, most, but not all, Python +releases have also been GPL-compatible; the table below summarizes +the various releases. + + Release Derived Year Owner GPL- + from compatible? (1) + + 0.9.0 thru 1.2 1991-1995 CWI yes + 1.3 thru 1.5.2 1.2 1995-1999 CNRI yes + 1.6 1.5.2 2000 CNRI no + 2.0 1.6 2000 BeOpen.com no + 1.6.1 1.6 2001 CNRI yes (2) + 2.1 2.0+1.6.1 2001 PSF no + 2.0.1 2.0+1.6.1 2001 PSF yes + 2.1.1 2.1+2.0.1 2001 PSF yes + 2.1.2 2.1.1 2002 PSF yes + 2.1.3 2.1.2 2002 PSF yes + 2.2 and above 2.1.1 2001-now PSF yes + +Footnotes: + +(1) GPL-compatible doesn't mean that we're distributing Python under + the GPL. All Python licenses, unlike the GPL, let you distribute + a modified version without making your changes open source. The + GPL-compatible licenses make it possible to combine Python with + other software that is released under the GPL; the others don't. + +(2) According to Richard Stallman, 1.6.1 is not GPL-compatible, + because its license has a choice of law clause. According to + CNRI, however, Stallman's lawyer has told CNRI's lawyer that 1.6.1 + is "not incompatible" with the GPL. + +Thanks to the many outside volunteers who have worked under Guido's +direction to make these releases possible. + + +B. TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING PYTHON +=============================================================== + +PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2 +-------------------------------------------- + +1. This LICENSE AGREEMENT is between the Python Software Foundation +("PSF"), and the Individual or Organization ("Licensee") accessing and +otherwise using this software ("Python") in source or binary form and +its associated documentation. + +2. Subject to the terms and conditions of this License Agreement, PSF hereby +grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce, +analyze, test, perform and/or display publicly, prepare derivative works, +distribute, and otherwise use Python alone or in any derivative version, +provided, however, that PSF's License Agreement and PSF's notice of copyright, +i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, +2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018 Python Software Foundation; All +Rights Reserved" are retained in Python alone or in any derivative version +prepared by Licensee. + +3. In the event Licensee prepares a derivative work that is based on +or incorporates Python or any part thereof, and wants to make +the derivative work available to others as provided herein, then +Licensee hereby agrees to include in any such work a brief summary of +the changes made to Python. + +4. PSF is making Python available to Licensee on an "AS IS" +basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR +IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND +DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS +FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT +INFRINGE ANY THIRD PARTY RIGHTS. + +5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON +FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS +A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON, +OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. + +6. This License Agreement will automatically terminate upon a material +breach of its terms and conditions. + +7. Nothing in this License Agreement shall be deemed to create any +relationship of agency, partnership, or joint venture between PSF and +Licensee. This License Agreement does not grant permission to use PSF +trademarks or trade name in a trademark sense to endorse or promote +products or services of Licensee, or any third party. + +8. By copying, installing or otherwise using Python, Licensee +agrees to be bound by the terms and conditions of this License +Agreement. + + +BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0 +------------------------------------------- + +BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1 + +1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an +office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the +Individual or Organization ("Licensee") accessing and otherwise using +this software in source or binary form and its associated +documentation ("the Software"). + +2. Subject to the terms and conditions of this BeOpen Python License +Agreement, BeOpen hereby grants Licensee a non-exclusive, +royalty-free, world-wide license to reproduce, analyze, test, perform +and/or display publicly, prepare derivative works, distribute, and +otherwise use the Software alone or in any derivative version, +provided, however, that the BeOpen Python License is retained in the +Software, alone or in any derivative version prepared by Licensee. + +3. BeOpen is making the Software available to Licensee on an "AS IS" +basis. BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR +IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND +DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS +FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT +INFRINGE ANY THIRD PARTY RIGHTS. + +4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE +SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS +AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY +DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. + +5. This License Agreement will automatically terminate upon a material +breach of its terms and conditions. + +6. This License Agreement shall be governed by and interpreted in all +respects by the law of the State of California, excluding conflict of +law provisions. Nothing in this License Agreement shall be deemed to +create any relationship of agency, partnership, or joint venture +between BeOpen and Licensee. This License Agreement does not grant +permission to use BeOpen trademarks or trade names in a trademark +sense to endorse or promote products or services of Licensee, or any +third party. As an exception, the "BeOpen Python" logos available at +http://www.pythonlabs.com/logos.html may be used according to the +permissions granted on that web page. + +7. By copying, installing or otherwise using the software, Licensee +agrees to be bound by the terms and conditions of this License +Agreement. + + +CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1 +--------------------------------------- + +1. This LICENSE AGREEMENT is between the Corporation for National +Research Initiatives, having an office at 1895 Preston White Drive, +Reston, VA 20191 ("CNRI"), and the Individual or Organization +("Licensee") accessing and otherwise using Python 1.6.1 software in +source or binary form and its associated documentation. + +2. Subject to the terms and conditions of this License Agreement, CNRI +hereby grants Licensee a nonexclusive, royalty-free, world-wide +license to reproduce, analyze, test, perform and/or display publicly, +prepare derivative works, distribute, and otherwise use Python 1.6.1 +alone or in any derivative version, provided, however, that CNRI's +License Agreement and CNRI's notice of copyright, i.e., "Copyright (c) +1995-2001 Corporation for National Research Initiatives; All Rights +Reserved" are retained in Python 1.6.1 alone or in any derivative +version prepared by Licensee. Alternately, in lieu of CNRI's License +Agreement, Licensee may substitute the following text (omitting the +quotes): "Python 1.6.1 is made available subject to the terms and +conditions in CNRI's License Agreement. This Agreement together with +Python 1.6.1 may be located on the Internet using the following +unique, persistent identifier (known as a handle): 1895.22/1013. This +Agreement may also be obtained from a proxy server on the Internet +using the following URL: http://hdl.handle.net/1895.22/1013". + +3. In the event Licensee prepares a derivative work that is based on +or incorporates Python 1.6.1 or any part thereof, and wants to make +the derivative work available to others as provided herein, then +Licensee hereby agrees to include in any such work a brief summary of +the changes made to Python 1.6.1. + +4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS" +basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR +IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND +DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS +FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6.1 WILL NOT +INFRINGE ANY THIRD PARTY RIGHTS. + +5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON +1.6.1 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS +A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1, +OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. + +6. This License Agreement will automatically terminate upon a material +breach of its terms and conditions. + +7. This License Agreement shall be governed by the federal +intellectual property law of the United States, including without +limitation the federal copyright law, and, to the extent such +U.S. federal law does not apply, by the law of the Commonwealth of +Virginia, excluding Virginia's conflict of law provisions. +Notwithstanding the foregoing, with regard to derivative works based +on Python 1.6.1 that incorporate non-separable material that was +previously distributed under the GNU General Public License (GPL), the +law of the Commonwealth of Virginia shall govern this License +Agreement only as to issues arising under or with respect to +Paragraphs 4, 5, and 7 of this License Agreement. Nothing in this +License Agreement shall be deemed to create any relationship of +agency, partnership, or joint venture between CNRI and Licensee. This +License Agreement does not grant permission to use CNRI trademarks or +trade name in a trademark sense to endorse or promote products or +services of Licensee, or any third party. + +8. By clicking on the "ACCEPT" button where indicated, or by copying, +installing or otherwise using Python 1.6.1, Licensee agrees to be +bound by the terms and conditions of this License Agreement. + + ACCEPT + + +CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2 +-------------------------------------------------- + +Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam, +The Netherlands. All rights reserved. + +Permission to use, copy, modify, and distribute this software and its +documentation for any purpose and without fee is hereby granted, +provided that the above copyright notice appear in all copies and that +both that copyright notice and this permission notice appear in +supporting documentation, and that the name of Stichting Mathematisch +Centrum or CWI not be used in advertising or publicity pertaining to +distribution of the software without specific, written prior +permission. + +STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO +THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE +FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT +OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + + +Additional Conditions for this Windows binary build +--------------------------------------------------- + +This program is linked with and uses Microsoft Distributable Code, +copyrighted by Microsoft Corporation. The Microsoft Distributable Code +includes the following files: + +msvcr90.dll +msvcp90.dll +msvcm90.dll + +If you further distribute programs that include the Microsoft +Distributable Code, you must comply with the restrictions on +distribution specified by Microsoft. In particular, you must require +distributors and external end users to agree to terms that protect the +Microsoft Distributable Code at least as much as Microsoft's own +requirements for the Distributable Code. See Microsoft's documentation +(included in its developer tools and on its website at microsoft.com) +for specific details. + +Redistribution of the Windows binary build of the Python interpreter +complies with this agreement, provided that you do not: + +- alter any copyright, trademark or patent notice in Microsoft's +Distributable Code; + +- use Microsoft's trademarks in your programs' names or in a way that +suggests your programs come from or are endorsed by Microsoft; + +- distribute Microsoft's Distributable Code to run on a platform other +than Microsoft operating systems, run-time technologies or application +platforms; or + +- include Microsoft Distributable Code in malicious, deceptive or +unlawful programs. + +These restrictions apply only to the Microsoft Distributable Code as +defined above, not to Python itself or any programs running on the +Python interpreter. The redistribution of the Python interpreter and +libraries is governed by the Python Software License included with this +file, or by other licenses as marked. + + +This copy of Python includes a copy of bzip2, which is licensed under the following terms: + + +-------------------------------------------------------------------------- + +This program, "bzip2", the associated library "libbzip2", and all +documentation, are copyright (C) 1996-2010 Julian R Seward. All +rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +2. The origin of this software must not be misrepresented; you must + not claim that you wrote the original software. If you use this + software in a product, an acknowledgment in the product + documentation would be appreciated but is not required. + +3. Altered source versions must be plainly marked as such, and must + not be misrepresented as being the original software. + +4. The name of the author may not be used to endorse or promote + products derived from this software without specific prior written + permission. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS +OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Julian Seward, jseward@bzip.org +bzip2/libbzip2 version 1.0.6 of 6 September 2010 + +-------------------------------------------------------------------------- + +This copy of Python includes a copy of Berkeley DB, which is licensed under the following terms: + +/*- + * $Id: LICENSE,v 12.9 2008/02/07 17:12:17 mark Exp $ + */ + +The following is the license that applies to this copy of the Berkeley DB +software. For a license to use the Berkeley DB software under conditions +other than those described here, or to purchase support for this software, +please contact Oracle at berkeleydb-info_us@oracle.com. + +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +/* + * Copyright (c) 1990,2008 Oracle. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Redistributions in any form must be accompanied by information on + * how to obtain complete source code for the DB software and any + * accompanying software that uses the DB software. The source code + * must either be included in the distribution or be available for no + * more than the cost of distribution plus a nominal fee, and must be + * freely redistributable under reasonable conditions. For an + * executable file, complete source code means the source code for all + * modules it contains. It does not include source code for modules or + * files that typically accompany the major components of the operating + * system on which the executable file runs. + * + * THIS SOFTWARE IS PROVIDED BY ORACLE ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR + * NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL ORACLE BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR + * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, + * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE + * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN + * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/* + * Copyright (c) 1990, 1993, 1994, 1995 + * The Regents of the University of California. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the University nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ +/* + * Copyright (c) 1995, 1996 + * The President and Fellows of Harvard University. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the University nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY HARVARD AND ITS CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL HARVARD OR ITS CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= +/*** + * ASM: a very small and fast Java bytecode manipulation framework + * Copyright (c) 2000-2005 INRIA, France Telecom + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the copyright holders nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + * THE POSSIBILITY OF SUCH DAMAGE. + */ + +This copy of Python includes a copy of openssl, which is licensed under the following terms: + + + LICENSE ISSUES + ============== + + The OpenSSL toolkit stays under a double license, i.e. both the conditions of + the OpenSSL License and the original SSLeay license apply to the toolkit. + See below for the actual license texts. Actually both licenses are BSD-style + Open Source licenses. In case of any license issues related to OpenSSL + please contact openssl-core@openssl.org. + + OpenSSL License + --------------- + +/* ==================================================================== + * Copyright (c) 1998-2018 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + + Original SSLeay License + ----------------------- + +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + + +This copy of Python includes a copy of Tcl, which is licensed under the following terms: + +This software is copyrighted by the Regents of the University of +California, Sun Microsystems, Inc., Scriptics Corporation, ActiveState +Corporation and other parties. The following terms apply to all files +associated with the software unless explicitly disclaimed in +individual files. + +The authors hereby grant permission to use, copy, modify, distribute, +and license this software and its documentation for any purpose, provided +that existing copyright notices are retained in all copies and that this +notice is included verbatim in any distributions. No written agreement, +license, or royalty fee is required for any of the authorized uses. +Modifications to this software may be copyrighted by their authors +and need not follow the licensing terms described here, provided that +the new terms are clearly indicated on the first page of each file where +they apply. + +IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY +FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY +DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE +IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE +NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR +MODIFICATIONS. + +GOVERNMENT USE: If you are acquiring this software on behalf of the +U.S. government, the Government shall have only "Restricted Rights" +in the software and related documentation as defined in the Federal +Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you +are acquiring the software on behalf of the Department of Defense, the +software shall be classified as "Commercial Computer Software" and the +Government shall have only "Restricted Rights" as defined in Clause +252.227-7013 (b) (3) of DFARs. Notwithstanding the foregoing, the +authors grant the U.S. Government and others acting in its behalf +permission to use and distribute the software in accordance with the +terms specified in this license. + +This copy of Python includes a copy of Tk, which is licensed under the following terms: + +This software is copyrighted by the Regents of the University of +California, Sun Microsystems, Inc., and other parties. The following +terms apply to all files associated with the software unless explicitly +disclaimed in individual files. + +The authors hereby grant permission to use, copy, modify, distribute, +and license this software and its documentation for any purpose, provided +that existing copyright notices are retained in all copies and that this +notice is included verbatim in any distributions. No written agreement, +license, or royalty fee is required for any of the authorized uses. +Modifications to this software may be copyrighted by their authors +and need not follow the licensing terms described here, provided that +the new terms are clearly indicated on the first page of each file where +they apply. + +IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY +FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY +DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE +IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE +NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR +MODIFICATIONS. + +GOVERNMENT USE: If you are acquiring this software on behalf of the +U.S. government, the Government shall have only "Restricted Rights" +in the software and related documentation as defined in the Federal +Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you +are acquiring the software on behalf of the Department of Defense, the +software shall be classified as "Commercial Computer Software" and the +Government shall have only "Restricted Rights" as defined in Clause +252.227-7013 (b) (3) of DFARs. Notwithstanding the foregoing, the +authors grant the U.S. Government and others acting in its behalf +permission to use and distribute the software in accordance with the +terms specified in this license. + +This copy of Python includes a copy of Tix, which is licensed under the following terms: + +Copyright (c) 1993-1999 Ioi Kim Lam. +Copyright (c) 2000-2001 Tix Project Group. +Copyright (c) 2004 ActiveState + +This software is copyrighted by the above entities +and other parties. The following terms apply to all files associated +with the software unless explicitly disclaimed in individual files. + +The authors hereby grant permission to use, copy, modify, distribute, +and license this software and its documentation for any purpose, provided +that existing copyright notices are retained in all copies and that this +notice is included verbatim in any distributions. No written agreement, +license, or royalty fee is required for any of the authorized uses. +Modifications to this software may be copyrighted by their authors +and need not follow the licensing terms described here, provided that +the new terms are clearly indicated on the first page of each file where +they apply. + +IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY +FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY +DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. THIS SOFTWARE +IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE +NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR +MODIFICATIONS. + +GOVERNMENT USE: If you are acquiring this software on behalf of the +U.S. government, the Government shall have only "Restricted Rights" +in the software and related documentation as defined in the Federal +Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you +are acquiring the software on behalf of the Department of Defense, the +software shall be classified as "Commercial Computer Software" and the +Government shall have only "Restricted Rights" as defined in Clause +252.227-7013 (c) (1) of DFARs. Notwithstanding the foregoing, the +authors grant the U.S. Government and others acting in its behalf +permission to use and distribute the software in accordance with the +terms specified in this license. + +---------------------------------------------------------------------- + +Parts of this software are based on the Tcl/Tk software copyrighted by +the Regents of the University of California, Sun Microsystems, Inc., +and other parties. The original license terms of the Tcl/Tk software +distribution is included in the file docs/license.tcltk. + +Parts of this software are based on the HTML Library software +copyrighted by Sun Microsystems, Inc. The original license terms of +the HTML Library software distribution is included in the file +docs/license.html_lib. diff --git a/plugins/scancode-categories/.gitignore b/plugins/scancode-categories/.gitignore new file mode 100644 index 00000000000..95832e8eb97 --- /dev/null +++ b/plugins/scancode-categories/.gitignore @@ -0,0 +1,2 @@ +/build/ +/dist/ \ No newline at end of file diff --git a/plugins/scancode-categories/MANIFEST.in b/plugins/scancode-categories/MANIFEST.in new file mode 100644 index 00000000000..21e06255860 --- /dev/null +++ b/plugins/scancode-categories/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__ *.*~ \ No newline at end of file diff --git a/plugins/scancode-categories/NOTICE b/plugins/scancode-categories/NOTICE new file mode 100644 index 00000000000..ca485a13afa --- /dev/null +++ b/plugins/scancode-categories/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. \ No newline at end of file diff --git a/plugins/scancode-categories/README.md b/plugins/scancode-categories/README.md new file mode 100644 index 00000000000..5047a0ac28b --- /dev/null +++ b/plugins/scancode-categories/README.md @@ -0,0 +1,15 @@ +### Description: +[to come] + +### Usage +``` +[to come] +``` + +### Example: +``` +[to come] +``` + +### Notes: +[to come] \ No newline at end of file diff --git a/plugins/scancode-categories/apache-2.0.LICENSE b/plugins/scancode-categories/apache-2.0.LICENSE new file mode 100644 index 00000000000..7a4a3ea2424 --- /dev/null +++ b/plugins/scancode-categories/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. \ No newline at end of file diff --git a/plugins/scancode-categories/setup.cfg b/plugins/scancode-categories/setup.cfg new file mode 100644 index 00000000000..e15bdbfa98a --- /dev/null +++ b/plugins/scancode-categories/setup.cfg @@ -0,0 +1,8 @@ +[metadata] +license_file = NOTICE + +[bdist_wheel] +universal = 1 + +[aliases] +release = clean --all bdist_wheel \ No newline at end of file diff --git a/plugins/scancode-categories/setup.py b/plugins/scancode-categories/setup.py new file mode 100644 index 00000000000..af8f753f8de --- /dev/null +++ b/plugins/scancode-categories/setup.py @@ -0,0 +1,55 @@ +#!/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 categorize each file in a codebase scan.''' + +setup( + name='scancode-categories', + 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 :: 2.7', + 'Topic :: Utilities', + ], + keywords=[ + 'open source', 'scancode', 'file type', 'MIME type', 'extension', 'language', 'programming language' + ], + install_requires=[ + 'scancode-toolkit', + ], + entry_points={ + 'scancode_post_scan': [ + 'categories = plugin_categories.plugin_categories:CategoryRules', + # 'categories = plugin_categories.plugin_categories_test_01:CategoryRules', + # 'categories = plugin_categories.plugin_categories_test_02:CategoryRules', + # 'categories = plugin_categories.plugin_categories_test_03:CategoryRules', + ], + } +) diff --git a/plugins/scancode-categories/src/__init__.py b/plugins/scancode-categories/src/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/plugins/scancode-categories/src/plugin_categories/__init__.py b/plugins/scancode-categories/src/plugin_categories/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/plugins/scancode-categories/src/plugin_categories/plugin_categories.py b/plugins/scancode-categories/src/plugin_categories/plugin_categories.py new file mode 100644 index 00000000000..ac4f7edae26 --- /dev/null +++ b/plugins/scancode-categories/src/plugin_categories/plugin_categories.py @@ -0,0 +1,219 @@ +# +# Copyright (c) 2019 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. + +from __future__ import absolute_import +from __future__ import division +from __future__ import print_function +from __future__ import unicode_literals + +from collections import OrderedDict + +import attr + +# from commoncode import saneyaml +# import os.path +# from os.path import exists +# from os.path import isdir + +from plugincode.post_scan import PostScanPlugin +from plugincode.post_scan import post_scan_impl +from scancode import CommandLineOption +from scancode import POST_SCAN_GROUP + + +@post_scan_impl +class CategoryRules(PostScanPlugin): + """ + Identify the category (e.g., Java, JavaScript, Python) for each file in the codebase being scanned. + """ + + options = [ + CommandLineOption(('--categories',), + help='Identify the category (e.g., Java, JavaScript, Python) for each file in the codebase being scanned. Rules comprise a set of any() and all() functions contained as string values in a list of JSON objects. The category and related information (including the rule applied to the file) will be added to a new "category" field in the ScanCode JSON output file.', + metavar='FILE', + help_group=POST_SCAN_GROUP) + ] + + resource_attributes = dict(category=attr.ib(default=attr.Factory(dict))) + + def is_enabled(self, categories, **kwargs): + return categories + + def process_codebase(self, codebase, categories, **kwargs): + """ + Populate a category mapping with two attributes: category_type and category_rule + at the File Resource level. + """ + if not self.is_enabled(categories): + return + + # with open('/c/code/nexb/dev/scancode-toolkit/plugins/scancode-categories/src/python_rules/python_rules_01.py', 'r') as f: + # line = f.readline() + # header = [] + # data = [] + # while line: + # if line.startswith('#'): + # header.append(line) + # else: + # data.append(line) + # line = f.readline() + + import json + # s = '/c/code/nexb/dev/scancode-toolkit/plugins/scancode-categories/src/python_rules/python_rules_01.py' + # s = r'C:\code\nexb\dev\scancode-toolkit\plugins\scancode-categories\src\python_rules\python_rules_01.py' + # s = r'C:\nexb\scancode_plugin_tests\rules\python_rules_01.py' + # does this represent the path passed with the command? + s = categories + + # jdata = json.loads(s) + # print(jdata) + # for d in jdata: + # for key, value in d.items(): + # print(key, value) + # ============================================ + # # this prints as expected, but test value must be in quotes + + # my_path = os.path.abspath(os.path.dirname(__file__)) + # # my_rules = os.path.join(my_path, 'test_rules_simple_01.py') + # # try different folder + # my_rules = os.path.join(my_path, '../python_rules/python_rules_01.py') + # with open(my_rules) as json_file: + # data = json.load(json_file) + + # try to import with full path from different directory + with open(s) as json_file: + data = json.load(json_file) + + + + + # print('\nHELLO\n') + # for p in data['new_rules']: + # print('Name: ' + p['name']) + # print('Test: ' + p['test']) + # print('') + # ============================================ + + # # apply rules to resource + # for resource in codebase.walk(topdown=False): + # self.vet_resource(resource, categories) + # codebase.save_resource(resource) + + # same as above but indented one level so we can pass "data" from json.load above + for resource in codebase.walk(topdown=False): + # self.vet_resource(resource, categories) + self.vet_resource(resource, categories, data) + codebase.save_resource(resource) + + # def vet_resource(self, resource, categories, **kwargs): + def vet_resource(self, resource, categories, data, **kwargs): + # ================================================== + # Next: try to read from list inside python_rules_01.py instead of the list below + # ================================================== + # new_rules = [ + # { + # 'name': 'cpp_files_01', + # "test": (all(extension == resource.extension for extension in [".cpp"]) & + # any(file_type == resource.file_type for file_type in ["C source, ASCII text", "C++ source, ASCII text"])), + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'map_files_01', + # "test": (any(extension == resource.extension for extension in [".map"]) & + # any(file_type == resource.file_type for file_type in ["ASCII text"])), + # 'domain': 'general', + # 'status': 'non-core' + # }, + # { + # 'name': 'c_files_01', + # "test": (all(resource.extension == extension for extension in [".c"]) & + # any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + # 'domain': 'general', + # 'status': 'core' + # }, + # ] + + # # # with open('/c/code/nexb/dev/scancode-toolkit/plugins/scancode-categories/src/python_rules/python_rules_01.py', 'r') as f: + # # with open('../python_rules/python_rules_01.py', 'r') as f: + # # new_rules = [line for line in f] + + # new_path = os.path.abspath(os.path.dirname(__file__)) + # new_yamlRules = os.path.join(new_path, '../python_rules/python_rules_01.py') + # with open(new_yamlRules) as f: + # new_rules = [line for line in f] + # # # # # use safe_load instead load + # # # # # rules_map = yaml.safe_load(f) + # # # new_rules_map = saneyaml.load(f) + + # from python_rules_01 import new_rules + + # import sys + # import os + # sys.path.append(os.path.abspath("../../python_rules")) + # sys.path.append(os.path.abspath("/c/code/nexb/dev/scancode-toolkit/plugins/scancode-categories/src/python_rules/python_rules_01.py")) + # sys.path.append(os.path.abspath("/c/code/nexb/dev/scancode-toolkit/plugins/scancode-categories/src/python_rules")) + + # all these fail: no module named x + # from python_rules_01 import new_rules + # from test_rules import new_rules + # import test_rules + + + # use list located in this same file + # now we get it fropm a .py file in the same directory + matched_rules = [] + resource.category = matched_rules + # for i in new_rules: + for i in data["new_rules"]: + # # if i["test"]: + # convert_to_code = i["test"] + # if convert_to_code: + # if exec(i["test"]): + # execute = exec(i["test"]) + # execute = exec(i["test"].decode("utf-8")) + + # decode_value = i["test"].decode("utf-8") + # decode_value = i["test"] # no longer necessary -- see below + + # execute = exec(decode_value) + # if execute: + # if exec(decode_value): + scope = locals() # this captures all local variables, which we pass in eval() just below so the json "test" value can use "resource"! + # if eval(decode_value, scope): + if eval(i["test"], scope): + # with the tests cleaned up, not sure if the 1st part of this if/else is still necessary -- needs further testing + if resource.type == 'directory': + resource.category = 'directory' + elif resource.type == 'file': + matched_rules.append(OrderedDict((k, i[k]) for k in ('name', 'test', 'domain', 'status'))) + resource.category = matched_rules + + if not resource.category: + if resource.type == 'directory': + resource.category = 'directory' + else: + resource.category = "no match" + + return resource diff --git a/plugins/scancode-categories/src/plugin_categories/plugin_categories_test_01.py b/plugins/scancode-categories/src/plugin_categories/plugin_categories_test_01.py new file mode 100644 index 00000000000..6c916abc9ba --- /dev/null +++ b/plugins/scancode-categories/src/plugin_categories/plugin_categories_test_01.py @@ -0,0 +1,348 @@ +# +# Copyright (c) 2019 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. + +from __future__ import absolute_import +from __future__ import division +from __future__ import print_function +from __future__ import unicode_literals + +# from collections import Counter +# from collections import defaultdict +from collections import OrderedDict + +import attr + +from commoncode import saneyaml +import os.path +from os.path import exists +from os.path import isdir + +# from cluecode.copyrights import CopyrightDetector +# from commoncode.text import python_safe_name +# from license_expression import Licensing +# from packagedcode import get_package_instance +# from packagedcode.build import BaseBuildManifestPackage +# from packagedcode.utils import combine_expressions +from plugincode.post_scan import PostScanPlugin +from plugincode.post_scan import post_scan_impl +from scancode import CommandLineOption +from scancode import POST_SCAN_GROUP + + +@post_scan_impl +class CategoryRules(PostScanPlugin): + """ + Identify the category (e.g., Java, JavaScript, Python) for each file in the codebase being scanned. + """ + + options = [ + CommandLineOption(('--categories',), + # is_flag=True, + help='Identify the category (e.g., Java, JavaScript, Python) for each file in the codebase being scanned. The category and related information (including the rule applied to the file) will be added to a new field in the ScanCode output file.', + # sort_order=10, + metavar='FILE', + help_group=POST_SCAN_GROUP) + ] + + # attributes = dict(category=attr.ib()) + # resource_attributes = dict(category=attr.ib(default=attr.Factory(dict))) + resource_attributes = dict(category=attr.ib(default=attr.Factory(dict))) + + # def is_enabled(self, fingerprint, info, **kwargs): + # def is_enabled(self, category, **kwargs): + def is_enabled(self, categories, **kwargs): + # return fingerprint and info + # return category + return categories + + # def process_codebase(self, codebase, fingerprint, **kwargs): + # def process_codebase(self, codebase, category, **kwargs): + def process_codebase(self, codebase, categories, **kwargs): + if not self.is_enabled(categories): + # if not self.is_enabled(categories): + return + + # apply rules to resource + for resource in codebase.walk(topdown=False): + # if not resource.is_file: + # continue + + # if resource.sha1 != 1: + # resource.category = 'whatever' + # # resource.save(codebase) + # codebase.save_resource(resource) + + # resource.category = 'some_new_value' + # resource.category = resource.programming_language + # resource.categories = 'some_value' + # resource.save(codebase) + # ======================== + # if not resource.is_file: + # resource.category = 'I am a simple directory and have no programming_language' + # elif resource.programming_language: + # resource.category = 'I am a file and my programming_language is ' + resource.programming_language + # else: + # resource.category = 'I am a file but I have no programming_language' + + self.vet_resource(resource, categories) + + codebase.save_resource(resource) + + def vet_resource(self, resource, categories, **kwargs): + # yamlRules = r'C:\code\jupyter_notebooks\nexb-jupyter\a_kreatv_d2d_05\yaml\kv_rules_01.yaml' + # yamlRules = './yaml_rules/test_yaml_rules_01.yml' #doesn't work + my_path = os.path.abspath(os.path.dirname(__file__)) + yamlRules = os.path.join(my_path, '../yaml_rules/test_yaml_rules_01.yml') + # with open(yamlRules) as f: + # # use safe_load instead load + # # rules_map = yaml.safe_load(f) + # rules_map = saneyaml.load(f) + + # with open(yamlRules, 'r') as conf: + # conf_content = conf.read() + # rules_map = saneyaml.load(conf_content) + + # policies = load_license_policy(license_policy).get('license_policies', []) + # rules_map = load_license_policy(yamlRules).get('rules', []) + # pass in the rules_location in the command -- the variable should be the same name as the name of the plugin command i.e. 'categories' + # no does not work: NameError: global name 'categories' is not defined + rules_map = load_rules(categories).get('rules', []) + + # if resource.programming_language: + # resource.category = 'Yo -- I am a file and my programming_language is ' + resource.programming_language + matched_rules = [] + # for rule in rules_map: + # # if resource.extension == rule.get('extension'): + # # # resource.category = rule.get('name') + # # # resource.category = rule + # # matched_rules.append(rule) + # # resource.category = matched_rules + # if resource.extension in rule.get('extension'): + # matched_rules.append(rule) + # resource.category = matched_rules + # # else: + # # resource.category = 'YIKES!' +# ============================================ + # rulelist = [ + # { + # 'name': 'cpp_files01', + # 'extension': ['.cpp'], + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'cpp_files02', + # 'extension': ['.cpp'], + # 'domain': 'general', + # 'status': 'core' + # } + # ] + + # for rule in rulelist: + # if resource.extension in rule.get('extension'): + # matched_rules.append(rule) + # resource.category = matched_rules +# ============================================ + + rulelist = [ + { + 'name': 'cpp_files01', + # 'test': 'any(extension in resource.extension for extension in (".cpp", ".js"))', + "test": "any(resource.extension == extension for extension in (\".cpp\", \".js\"))", + 'domain': 'general', + 'status': 'core' + }, + { + 'name': 'cpp_files02', + # 'test': 'all(extension in resource.extension for extension in (".cpp", ".js"))', + "test": "all(resource.extension == extension for extension in (\".cpp\", \".js\"))", + 'domain': 'general', + 'status': 'core' + } + ] + + # for rule in rulelist: + # if rule.get('test'): + # matched_rules.append(rule) + # resource.category = matched_rules + + + # if all(resource.extension == extension for extension in [".cpp", ".js"]): + # matched_rules.append('rule01') + # resource.category = matched_rules + # elif any(resource.extension == extension for extension in [".cppppppp", ".js"]): + # matched_rules.append('rule02') + # resource.category = matched_rules + # elif (any(extension == resource.extension for extension in [".cpp", ".js"]) & + # any(file_type == resource.file_type for file_type in ["C source, ASCII text"])): + # matched_rules.append('rule03') + # resource.category = matched_rules + # elif (resource.extension in [".cpp", ".js"]): + # matched_rules.append('rule04') + # resource.category = matched_rules + # else: + # resource.category = "no match" + +# ================================================== +# read from list inside python_rules_01.py instead of the list below + + # new_rules = [ + # { + # 'name': 'cpp_files01', + # "test": (all(extension == resource.extension for extension in [".cpp"]) & + # any(file_type == resource.file_type for file_type in ["C source, ASCII text"])), + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'cpp_files02', + # "test": (all(resource.extension == extension for extension in [".cpp"]) & + # any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'cpp_files03', + # "test": (all(resource.extension in extension for extension in [".cpp"]) & + # any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'cpp_files04', + # "test": (all(resource.extension in extension for extension in [".cppppppppp"]) & + # any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'cpp_files05', + # "test": (all(resource.extension in extension for extension in [".pcppppppppp"]) & + # any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'cpp_files06', + # "test": (all(resource.extension in extension for extension in [".pcppppppppp"]) | + # any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'cpp_files07', + # "test": + # ( + # all(resource.extension in extension for extension in [".pcppppppppp"]) | + # any(resource.file_type == file_type for file_type in ["C source, ASCII text"]) + # ), + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'cpp_files08', + # "test": (any(extension == resource.extension for extension in [".cpp", ".js"]) & + # any(file_type == resource.file_type for file_type in ["C source, ASCII text"])), + # 'domain': 'general', + # 'status': 'core' + # } + # ] + + # from python_rules_01 import new_rules + # my_new_rules = new_rules + + # new_path = os.path.abspath(os.path.dirname(__file__)) + # theRules = os.path.join(new_path, '../python_rules/python_rules_01.txt') + # file1 = open(theRules, "rb") + # new_rules = file1 + # # import json + # # with open(theRules) as json_file: + # # new_rules = json.load(json_file) + + # new_path = os.path.abspath(os.path.dirname(__file__)) + # new_yamlRules = os.path.join(new_path, '../yaml_rules/test_yaml_rules_02.yml') + # # with open(new_yamlRules) as f: + # # # # use safe_load instead load + # # # # rules_map = yaml.safe_load(f) + # # new_rules_map = saneyaml.load(f) + + # # for i in new_rules: + # for i in new_rules_map: + # # for i in new_rules['new_rules']: + # # for i in my_new_rules: + # # if i.get('test'): + # if i["test"]: + # # matched_rules.append(i.get('name')) + # # matched_rules.append(i) + # matched_rules.append(OrderedDict((k, i[k]) for k in ('name', 'domain', 'status'))) + # resource.category = matched_rules + # else: + # resource.category = 'no match' + + # this loads a yaml file passed in the command + """ + - pass a yaml rules file + - python file with relevant code: + C:\code\nexb\dev\scancode-toolkit\plugins\scancode-categories\src\plugin_categories\plugin_categories_test_01.py + - yaml does not seem to enable the use of conditonal expressions or other tests -- no code + - values seem to always be treated as strings, even if not enclosed in quotes + - the attempted test for true/false instead tests for the presence of a value, so every resource is treated as satisfying every test + + /c/code/nexb/dev/scancode-toolkit/scancode -i -n 2 /c/nexb/scancode_plugin_tests/sample_codebases/bionic-master-libc-bionic.tar.gz-extract --categories /c/code/nexb/dev/scancode-toolkit/plugins/scancode-categories/src/yaml_rules/test_yaml_rules_02.yml --json /c/nexb/scancode_plugin_tests/scan_output/libc-bionic-categories-scan02.json + """ + rules_map_01 = load_rules(categories).get('rules', []) + + # if resource.programming_language: + # resource.category = 'Yo -- I am a file and my programming_language is ' + resource.programming_language + matched_rules_01 = [] + for rule in rules_map_01: + # if resource.extension == rule.get('extension'): + # # resource.category = rule.get('name') + # # resource.category = rule + # matched_rules.append(rule) + # resource.category = matched_rules + + if rule.get("test"): + matched_rules_01.append(rule) + resource.category = matched_rules_01 + else: + resource.category = "egads" + + +# ============================================ + return resource + + +# def load_license_policy(license_policy_location): +def load_rules(rules_location): + """ + Return a category rules dictionary loaded from a category rules file. + """ + if not rules_location or not exists(rules_location): + return {} + elif isdir(rules_location): + return {} + with open(rules_location, 'r') as conf: + conf_content = conf.read() + return saneyaml.load(conf_content) diff --git a/plugins/scancode-categories/src/plugin_categories/plugin_categories_test_02.py b/plugins/scancode-categories/src/plugin_categories/plugin_categories_test_02.py new file mode 100644 index 00000000000..166b1efd053 --- /dev/null +++ b/plugins/scancode-categories/src/plugin_categories/plugin_categories_test_02.py @@ -0,0 +1,363 @@ +# +# Copyright (c) 2019 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. + +from __future__ import absolute_import +from __future__ import division +from __future__ import print_function +from __future__ import unicode_literals + +# from collections import Counter +# from collections import defaultdict +from collections import OrderedDict + +import attr + +from commoncode import saneyaml +import os.path +from os.path import exists +from os.path import isdir + +# from cluecode.copyrights import CopyrightDetector +# from commoncode.text import python_safe_name +# from license_expression import Licensing +# from packagedcode import get_package_instance +# from packagedcode.build import BaseBuildManifestPackage +# from packagedcode.utils import combine_expressions +from plugincode.post_scan import PostScanPlugin +from plugincode.post_scan import post_scan_impl +from scancode import CommandLineOption +from scancode import POST_SCAN_GROUP + + +@post_scan_impl +class CategoryRules(PostScanPlugin): + """ + Identify the category (e.g., Java, JavaScript, Python) for each file in the codebase being scanned. + """ + + options = [ + CommandLineOption(('--categories',), + # is_flag=True, + help='Identify the category (e.g., Java, JavaScript, Python) for each file in the codebase being scanned. The category and related information (including the rule applied to the file) will be added to a new field in the ScanCode output file.', + # sort_order=10, + metavar='FILE', + help_group=POST_SCAN_GROUP) + ] + + # attributes = dict(category=attr.ib()) + # resource_attributes = dict(category=attr.ib(default=attr.Factory(dict))) + resource_attributes = dict(category=attr.ib(default=attr.Factory(dict))) + + # def is_enabled(self, fingerprint, info, **kwargs): + # def is_enabled(self, category, **kwargs): + def is_enabled(self, categories, **kwargs): + # return fingerprint and info + # return category + return categories + + # def process_codebase(self, codebase, fingerprint, **kwargs): + # def process_codebase(self, codebase, category, **kwargs): + def process_codebase(self, codebase, categories, **kwargs): + if not self.is_enabled(categories): + # if not self.is_enabled(categories): + return + + # apply rules to resource + for resource in codebase.walk(topdown=False): + # if not resource.is_file: + # continue + + # if resource.sha1 != 1: + # resource.category = 'whatever' + # # resource.save(codebase) + # codebase.save_resource(resource) + + # resource.category = 'some_new_value' + # resource.category = resource.programming_language + # resource.categories = 'some_value' + # resource.save(codebase) + # ======================== + # if not resource.is_file: + # resource.category = 'I am a simple directory and have no programming_language' + # elif resource.programming_language: + # resource.category = 'I am a file and my programming_language is ' + resource.programming_language + # else: + # resource.category = 'I am a file but I have no programming_language' + + self.vet_resource(resource, categories) + + codebase.save_resource(resource) + + def vet_resource(self, resource, categories, **kwargs): + # yamlRules = r'C:\code\jupyter_notebooks\nexb-jupyter\a_kreatv_d2d_05\yaml\kv_rules_01.yaml' + # yamlRules = './yaml_rules/test_yaml_rules_01.yml' #doesn't work + # my_path = os.path.abspath(os.path.dirname(__file__)) + # yamlRules = os.path.join(my_path, '../yaml_rules/test_yaml_rules_01.yml') + # with open(yamlRules) as f: + # # use safe_load instead load + # # rules_map = yaml.safe_load(f) + # rules_map = saneyaml.load(f) + + # with open(yamlRules, 'r') as conf: + # conf_content = conf.read() + # rules_map = saneyaml.load(conf_content) + + # policies = load_license_policy(license_policy).get('license_policies', []) + # rules_map = load_license_policy(yamlRules).get('rules', []) + # pass in the rules_location in the command -- the variable should be the same name as the name of the plugin command i.e. 'categories' + # no does not work: NameError: global name 'categories' is not defined + + # rules_map = load_rules(categories).get('rules', []) # loads the yaml file using the function below, inspired by license-policy plugin + # but yaml (ditto json) does not seem to provide a way to pass conditional expressions/tests + + # if resource.programming_language: + # resource.category = 'Yo -- I am a file and my programming_language is ' + resource.programming_language + + # matched_rules = [] + + # for rule in rules_map: + # # if resource.extension == rule.get('extension'): + # # # resource.category = rule.get('name') + # # # resource.category = rule + # # matched_rules.append(rule) + # # resource.category = matched_rules + # if resource.extension in rule.get('extension'): + # matched_rules.append(rule) + # resource.category = matched_rules + # # else: + # # resource.category = 'YIKES!' +# ============================================ + # rulelist = [ + # { + # 'name': 'cpp_files01', + # 'extension': ['.cpp'], + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'cpp_files02', + # 'extension': ['.cpp'], + # 'domain': 'general', + # 'status': 'core' + # } + # ] + + # for rule in rulelist: + # if resource.extension in rule.get('extension'): + # matched_rules.append(rule) + # resource.category = matched_rules +# ============================================ + + # rulelist = [ + # { + # 'name': 'cpp_files01', + # # 'test': 'any(extension in resource.extension for extension in (".cpp", ".js"))', + # "test": "any(resource.extension == extension for extension in (\".cpp\", \".js\"))", + # 'domain': 'general', + # 'status': 'core' + # }, + # { + # 'name': 'cpp_files02', + # # 'test': 'all(extension in resource.extension for extension in (".cpp", ".js"))', + # "test": "all(resource.extension == extension for extension in (\".cpp\", \".js\"))", + # 'domain': 'general', + # 'status': 'core' + # } + # ] + + # for rule in rulelist: + # if rule.get('test'): + # matched_rules.append(rule) + # resource.category = matched_rules + + + # if all(resource.extension == extension for extension in [".cpp", ".js"]): + # matched_rules.append('rule01') + # resource.category = matched_rules + # elif any(resource.extension == extension for extension in [".cppppppp", ".js"]): + # matched_rules.append('rule02') + # resource.category = matched_rules + # elif (any(extension == resource.extension for extension in [".cpp", ".js"]) & + # any(file_type == resource.file_type for file_type in ["C source, ASCII text"])): + # matched_rules.append('rule03') + # resource.category = matched_rules + # elif (resource.extension in [".cpp", ".js"]): + # matched_rules.append('rule04') + # resource.category = matched_rules + # else: + # resource.category = "no match" + +# ================================================== +# read from list inside python_rules_01.py instead of the list below + + """ + Use an internal list -- i.e., in same file as code -- of dictionaries + - even though not passing the path of a rules file, need to use --categories flag to invoke + - so passing a file that's not used -- just needs to be a valif path-to-some-file + - unrelated code not yet cleaned up, but -- this works! + - includes many test rules that need to be removed, and needs other working rules + - then we need a codebase containing a far wider range of file types for testing. + + /c/code/nexb/dev/scancode-toolkit/scancode -i -n 2 /c/nexb/scancode_plugin_tests/sample_codebases/bionic-master-libc-bionic.tar.gz-extract --categories /c/code/nexb/dev/scancode-toolkit/plugins/scancode-categories/src/yaml_rules/test_yaml_rules_02.yml --json /c/nexb/scancode_plugin_tests/scan_output/libc-bionic-categories-scan02.json + """ + + new_rules = [ + { + 'name': 'cpp_files01', + "test": (all(extension == resource.extension for extension in [".cpp"]) & + any(file_type == resource.file_type for file_type in ["C source, ASCII text", "C++ source, ASCII text"])), + 'domain': 'general', + 'status': 'core' + }, + { + 'name': 'cpp_files02', + "test": (all(resource.extension == extension for extension in [".cpp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + 'domain': 'general', + 'status': 'core' + }, + { + 'name': 'cpp_files03', + "test": (all(resource.extension == extension for extension in [".cpp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + 'domain': 'general', + 'status': 'core' + }, + { + 'name': 'cpp_files04', + "test": (all(resource.extension in extension for extension in [".cppppppppp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + 'domain': 'general', + 'status': 'core' + }, + { + 'name': 'cpp_files05', + "test": (all(resource.extension in extension for extension in [".pcppppppppp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + 'domain': 'general', + 'status': 'core' + }, + { + 'name': 'cpp_files06', + "test": (all(resource.extension in extension for extension in [".pcppppppppp"]) | + all(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + 'domain': 'general', + 'status': 'core' + }, + { + 'name': 'cpp_files07', + "test": + ( + all(resource.extension in extension for extension in [".pcppppppppp"]) | + any(resource.file_type == file_type for file_type in ["C source, ASCII text"]) + ), + 'domain': 'general', + 'status': 'core' + }, + { + 'name': 'cpp_files08', + "test": (any(extension == resource.extension for extension in [".cpp", ".js"]) & + any(file_type == resource.file_type for file_type in ["C source, ASCII text"])), + 'domain': 'general', + 'status': 'core' + }, + { + 'name': 'map_files01', + "test": (any(extension == resource.extension for extension in [".cpp", ".js", ".map"]) & + any(file_type == resource.file_type for file_type in ["ASCII text"])), + 'domain': 'general', + 'status': 'non-core' + }, + { + 'name': 'c_files01', + "test": (all(resource.extension == extension for extension in [".c"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + 'domain': 'general', + 'status': 'core' + }, + ] + + # from python_rules_01 import new_rules + # my_new_rules = new_rules + + # new_path = os.path.abspath(os.path.dirname(__file__)) + # theRules = os.path.join(new_path, '../python_rules/python_rules_01.txt') + # file1 = open(theRules, "rb") + # new_rules = file1 + # # import json + # # with open(theRules) as json_file: + # # new_rules = json.load(json_file) + + # new_path = os.path.abspath(os.path.dirname(__file__)) + # new_yamlRules = os.path.join(new_path, '../yaml_rules/test_yaml_rules_02.yml') + # # with open(new_yamlRules) as f: + # # # # use safe_load instead load + # # # # rules_map = yaml.safe_load(f) + # # new_rules_map = saneyaml.load(f) + + + # use list located in this same file + matched_rules = [] + resource.category = matched_rules + for i in new_rules: + # for i in new_rules_map: + # # for i in new_rules['new_rules']: + # # for i in my_new_rules: + # # if i.get('test'): + + + + if i["test"]: + if resource.type == 'directory': + resource.category = 'directory' + elif resource.type == 'file': + + # # matched_rules.append(i.get('name')) + # matched_rules.append(i) + matched_rules.append(OrderedDict((k, i[k]) for k in ('name', 'test', 'domain', 'status'))) + resource.category = matched_rules + # else: + # resource.category = 'no match' + + if not resource.category: + resource.category = "no match" + # else: + # matched_rules = "hello" + +# ============================================ + return resource + + +# # def load_license_policy(license_policy_location): +# def load_rules(rules_location): +# """ +# Return a category rules dictionary loaded from a category rules file. +# """ +# if not rules_location or not exists(rules_location): +# return {} +# elif isdir(rules_location): +# return {} +# with open(rules_location, 'r') as conf: +# conf_content = conf.read() +# return saneyaml.load(conf_content) diff --git a/plugins/scancode-categories/src/plugin_categories/plugin_categories_test_03.py b/plugins/scancode-categories/src/plugin_categories/plugin_categories_test_03.py new file mode 100644 index 00000000000..98d22380606 --- /dev/null +++ b/plugins/scancode-categories/src/plugin_categories/plugin_categories_test_03.py @@ -0,0 +1,122 @@ +# +# Copyright (c) 2019 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. + +from __future__ import absolute_import +from __future__ import division +from __future__ import print_function +from __future__ import unicode_literals + +from collections import OrderedDict + +import attr + +from commoncode import saneyaml +import os.path +from os.path import exists +from os.path import isdir + +from plugincode.post_scan import PostScanPlugin +from plugincode.post_scan import post_scan_impl +from scancode import CommandLineOption +from scancode import POST_SCAN_GROUP + + +@post_scan_impl +class CategoryRules(PostScanPlugin): + """ + Identify the category (e.g., Java, JavaScript, Python) for each file in the codebase being scanned. + """ + + options = [ + CommandLineOption(('--categories',), + help='Identify the category (e.g., Java, JavaScript, Python) for each file in the codebase being scanned. The category and related information (including the rule applied to the file) will be added to a new field in the ScanCode output file.', + metavar='FILE', + help_group=POST_SCAN_GROUP) + ] + + resource_attributes = dict(category=attr.ib(default=attr.Factory(dict))) + + def is_enabled(self, categories, **kwargs): + return categories + + def process_codebase(self, codebase, categories, **kwargs): + """ + Populate a category mapping with two attributes: category_type and category_rule + at the File Resource level. + """ + if not self.is_enabled(categories): + return + + # apply rules to resource + for resource in codebase.walk(topdown=False): + self.vet_resource(resource, categories) + codebase.save_resource(resource) + + def vet_resource(self, resource, categories, **kwargs): + # ================================================== + # Next: try to read from list inside python_rules_01.py instead of the list below + # ================================================== + new_rules = [ + { + 'name': 'cpp_files_01', + "test": (all(extension == resource.extension for extension in [".cpp"]) & + any(file_type == resource.file_type for file_type in ["C source, ASCII text", "C++ source, ASCII text"])), + 'domain': 'general', + 'status': 'core' + }, + { + 'name': 'map_files_01', + "test": (any(extension == resource.extension for extension in [".map"]) & + any(file_type == resource.file_type for file_type in ["ASCII text"])), + 'domain': 'general', + 'status': 'non-core' + }, + { + 'name': 'c_files_01', + "test": (all(resource.extension == extension for extension in [".c"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + 'domain': 'general', + 'status': 'core' + }, + ] + + # use list located in this same file + matched_rules = [] + resource.category = matched_rules + for i in new_rules: + if i["test"]: + # with the tests cleaned up, not sure if the 1st part of this if/else is still necessary -- needs further testing + if resource.type == 'directory': + resource.category = 'directory' + elif resource.type == 'file': + matched_rules.append(OrderedDict((k, i[k]) for k in ('name', 'test', 'domain', 'status'))) + resource.category = matched_rules + + if not resource.category: + if resource.type == 'directory': + resource.category = 'this is a directory' + else: + resource.category = "no match" + + return resource diff --git a/plugins/scancode-categories/src/plugin_categories/test_rules.py b/plugins/scancode-categories/src/plugin_categories/test_rules.py new file mode 100644 index 00000000000..c5cd223077c --- /dev/null +++ b/plugins/scancode-categories/src/plugin_categories/test_rules.py @@ -0,0 +1,63 @@ +{ +"new_rules": [ + { + "name": "cpp_files01", + "test": (all(extension == resource.extension for extension in [".cpp"]) & + any(file_type == resource.file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" + }, + { + "name": "cpp_files02", + "test": (all(resource.extension == extension for extension in [".cpp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" + }, + { + "name": "cpp_files03", + "test": (all(resource.extension in extension for extension in [".cpp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" + }, + { + "name": "cpp_files04", + "test": (all(resource.extension in extension for extension in [".cppppppppp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" + }, + { + "name": "cpp_files05", + "test": (all(resource.extension in extension for extension in [".pcppppppppp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" + }, + { + "name": "cpp_files06", + "test": (all(resource.extension in extension for extension in [".pcppppppppp"]) | + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" + }, + { + "name": "cpp_files07", + "test": + ( + all(resource.extension in extension for extension in [".pcppppppppp"]) | + any(resource.file_type == file_type for file_type in ["C source, ASCII text"]) + ), + "domain": "general", + "status": "This is core, dude!" + }, + { + "name": "cpp_files08", + "test": (any(extension == resource.extension for extension in [".cpp", ".js"]) & + any(file_type == resource.file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" + } +] +} diff --git a/plugins/scancode-categories/src/plugin_categories/test_rules_simple_01.py b/plugins/scancode-categories/src/plugin_categories/test_rules_simple_01.py new file mode 100644 index 00000000000..f5b5a5130e3 --- /dev/null +++ b/plugins/scancode-categories/src/plugin_categories/test_rules_simple_01.py @@ -0,0 +1,34 @@ +{ + "new_rules": [ + { + "name": "cpp_files01", + "test": "all(extension == resource.extension for extension in ['.cpp']) & any(file_type == resource.file_type for file_type in ['C source, ASCII text', 'C++ source, ASCII text', 'ASCII text'])", + "domain": "general", + "status": "core code" + }, + { + "name": "cpp_files_c_extension01", + "test": "all(extension == resource.extension for extension in ['.c']) & any(file_type == resource.file_type for file_type in ['C source, ASCII text']) & all(programming_language == resource.programming_language for programming_language in ['C++'])", + "domain": "general", + "status": "core code" + }, + { + "name": "cpp_files_header01", + "test": "all(extension == resource.extension for extension in ['.h']) & any(file_type == resource.file_type for file_type in ['ASCII text', 'C++ source, ASCII text', 'C source, ASCII text'])", + "domain": "general", + "status": "core code" + }, + { + "name": "map_files01", + "test": "all(extension == resource.extension for extension in ['.map']) & any(file_type == resource.file_type for file_type in ['ASCII text'])", + "domain": "general", + "status": "non-core JavaScript map file" + }, + { + "name": "Blueprint_files01", + "test": "all(extension == resource.extension for extension in ['.bp']) & any(file_type == resource.file_type for file_type in ['ASCII text'])", + "domain": "general", + "status": "non-core build configuration" + } + ] +} diff --git a/plugins/scancode-categories/src/python_rules/__init__.py b/plugins/scancode-categories/src/python_rules/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/plugins/scancode-categories/src/python_rules/python_rules_01.py b/plugins/scancode-categories/src/python_rules/python_rules_01.py new file mode 100644 index 00000000000..57df54dfaad --- /dev/null +++ b/plugins/scancode-categories/src/python_rules/python_rules_01.py @@ -0,0 +1,34 @@ +{ + "new_rules": [ + { + "name": "cpp_files01_different_directory_inside_scancode", + "test": "all(extension == resource.extension for extension in ['.cpp']) & any(file_type == resource.file_type for file_type in ['C source, ASCII text', 'C++ source, ASCII text', 'ASCII text'])", + "domain": "general", + "status": "core code" + }, + { + "name": "cpp_files_c_extension01_different_directory_inside_scancode", + "test": "all(extension == resource.extension for extension in ['.c']) & any(file_type == resource.file_type for file_type in ['C source, ASCII text']) & all(programming_language == resource.programming_language for programming_language in ['C++'])", + "domain": "general", + "status": "core code" + }, + { + "name": "cpp_files_header01_different_directory_inside_scancode", + "test": "all(extension == resource.extension for extension in ['.h']) & any(file_type == resource.file_type for file_type in ['ASCII text', 'C++ source, ASCII text', 'C source, ASCII text'])", + "domain": "general", + "status": "core code" + }, + { + "name": "map_files01_different_directory_inside_scancode", + "test": "all(extension == resource.extension for extension in ['.map']) & any(file_type == resource.file_type for file_type in ['ASCII text'])", + "domain": "general", + "status": "non-core JavaScript map file" + }, + { + "name": "Blueprint_files01_different_directory_inside_scancode", + "test": "all(extension == resource.extension for extension in ['.bp']) & any(file_type == resource.file_type for file_type in ['ASCII text'])", + "domain": "general", + "status": "non-core build configuration" + } + ] +} diff --git a/plugins/scancode-categories/src/text_rules/text_rules_01.txt b/plugins/scancode-categories/src/text_rules/text_rules_01.txt new file mode 100644 index 00000000000..0ec151c6896 --- /dev/null +++ b/plugins/scancode-categories/src/text_rules/text_rules_01.txt @@ -0,0 +1,61 @@ +"new_rules": [ +{ + "name": "cpp_files01", + "test": (all(extension == resource.extension for extension in [".cpp"]) & + any(file_type == resource.file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" +}, +{ + "name": "cpp_files02", + "test": (all(resource.extension == extension for extension in [".cpp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" +}, +{ + "name": "cpp_files03", + "test": (all(resource.extension in extension for extension in [".cpp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" +}, +{ + "name": "cpp_files04", + "test": (all(resource.extension in extension for extension in [".cppppppppp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" +}, +{ + "name": "cpp_files05", + "test": (all(resource.extension in extension for extension in [".pcppppppppp"]) & + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" +}, +{ + "name": "cpp_files06", + "test": (all(resource.extension in extension for extension in [".pcppppppppp"]) | + any(resource.file_type == file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" +}, +{ + "name": "cpp_files07", + "test": + ( + all(resource.extension in extension for extension in [".pcppppppppp"]) | + any(resource.file_type == file_type for file_type in ["C source, ASCII text"]) + ), + "domain": "general", + "status": "This is core, dude!" +}, +{ + "name": "cpp_files08", + "test": (any(extension == resource.extension for extension in [".cpp", ".js"]) & + any(file_type == resource.file_type for file_type in ["C source, ASCII text"])), + "domain": "general", + "status": "core" +} +] diff --git a/plugins/scancode-categories/src/yaml_rules/test_yaml_rules_01.yml b/plugins/scancode-categories/src/yaml_rules/test_yaml_rules_01.yml new file mode 100644 index 00000000000..d08ff18703b --- /dev/null +++ b/plugins/scancode-categories/src/yaml_rules/test_yaml_rules_01.yml @@ -0,0 +1,34 @@ +rules: + + - name: cpp_files + domain: general + extension: .cpp + classification: CPP + status: core + + - name: cpp_files_01 + domain: general_01 + extension: .cpp + classification: CPP_01 + status: core_01 + + - name: cpp_files_02 + domain: general_02 + extension: one.single.string.cpp + classification: CPP_02 + status: core_02 + + - name: cpp_files_03 + domain: general_03 + extension: + - app + - bpp + - .cpp + classification: CPP_03 + status: core_03 + + - name: cpp_files_04 + domain: general_04 + extension: cpp + classification: CPP_04 + status: core_04 \ No newline at end of file diff --git a/plugins/scancode-categories/src/yaml_rules/test_yaml_rules_02.yml b/plugins/scancode-categories/src/yaml_rules/test_yaml_rules_02.yml new file mode 100644 index 00000000000..4a4179abe15 --- /dev/null +++ b/plugins/scancode-categories/src/yaml_rules/test_yaml_rules_02.yml @@ -0,0 +1,9 @@ +rules: + + - name: cpp_files + domain: general + extension: .cpp + classification: CPP + status: core + test: (all(extension == resource.extension for extension in [".cpp"]) & + any(file_type == resource.file_type for file_type in ["C source, ASCII text"])) \ No newline at end of file