diff --git a/scancodeio/settings.py b/scancodeio/settings.py index 9fe0fabac..596aef62a 100644 --- a/scancodeio/settings.py +++ b/scancodeio/settings.py @@ -85,6 +85,7 @@ # Local apps # Must come before Third-party apps for proper templates override "scanpipe", + "scantext", # Django built-in "django.contrib.auth", "django.contrib.contenttypes", diff --git a/scancodeio/urls.py b/scancodeio/urls.py index a8bd62ce9..08ab7f1eb 100644 --- a/scancodeio/urls.py +++ b/scancodeio/urls.py @@ -52,6 +52,7 @@ path("admin/", admin.site.urls), path("api/", include(api_router.urls)), path("license/", include(licenses.urls)), + path("scantext/", include("scantext.urls")), path("", include("scanpipe.urls")), path("", RedirectView.as_view(url="project/")), ] diff --git a/scanpipe/templates/scanpipe/includes/navbar_header.html b/scanpipe/templates/scanpipe/includes/navbar_header.html index cc3c3a877..1e26aa6d4 100644 --- a/scanpipe/templates/scanpipe/includes/navbar_header.html +++ b/scanpipe/templates/scanpipe/includes/navbar_header.html @@ -9,6 +9,16 @@ Projects +
+ + Utilities + +
+ + Detect License + +
+
Documentation diff --git a/scantext/__init__.py b/scantext/__init__.py new file mode 100644 index 000000000..1f72cf031 --- /dev/null +++ b/scantext/__init__.py @@ -0,0 +1,21 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# http://nexb.com and https://github.com/nexB/scancode.io +# The ScanCode.io software is licensed under the Apache License version 2.0. +# Data generated with ScanCode.io is provided as-is without warranties. +# 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. +# +# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES +# OR CONDITIONS OF ANY KIND, either express or implied. No content created from +# ScanCode.io should be considered or used as legal advice. Consult an Attorney +# for any legal advice. +# +# ScanCode.io is a free software code scanning tool from nexB Inc. and others. +# Visit https://github.com/nexB/scancode.io for support and download. diff --git a/scantext/apps.py b/scantext/apps.py new file mode 100644 index 000000000..9c100a202 --- /dev/null +++ b/scantext/apps.py @@ -0,0 +1,27 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# http://nexb.com and https://github.com/nexB/scancode.io +# The ScanCode.io software is licensed under the Apache License version 2.0. +# Data generated with ScanCode.io is provided as-is without warranties. +# 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. +# +# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES +# OR CONDITIONS OF ANY KIND, either express or implied. No content created from +# ScanCode.io should be considered or used as legal advice. Consult an Attorney +# for any legal advice. +# +# ScanCode.io is a free software code scanning tool from nexB Inc. and others. +# Visit https://github.com/nexB/scancode.io for support and download. + +from django.apps import AppConfig + + +class ScantextConfig(AppConfig): + name = "scantext" diff --git a/scantext/forms.py b/scantext/forms.py new file mode 100644 index 000000000..c01721749 --- /dev/null +++ b/scantext/forms.py @@ -0,0 +1,66 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# http://nexb.com and https://github.com/nexB/scancode.io +# The ScanCode.io software is licensed under the Apache License version 2.0. +# Data generated with ScanCode.io is provided as-is without warranties. +# 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. +# +# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES +# OR CONDITIONS OF ANY KIND, either express or implied. No content created from +# ScanCode.io should be considered or used as legal advice. Consult an Attorney +# for any legal advice. +# +# ScanCode.io is a free software code scanning tool from nexB Inc. and others. +# Visit https://github.com/nexB/scancode.io for support and download. + +import tempfile + +from django import forms + + +class LicenseScanForm(forms.Form): + input_text = forms.CharField( + strip=False, + widget=forms.Textarea( + attrs={ + "rows": 15, + "class": "textarea has-fixed-size", + "placeholder": "Paste your license text here.", + } + ), + required=False, + ) + input_file = forms.FileField( + required=False, + widget=forms.ClearableFileInput( + attrs={"class": "file-input", "multiple": False}, + ), + ) + + +def handle_input_text(input_text, temp_dir): + # The flush in tempfile is required to ensure that the content is + # written to the disk before it's read by get_licenses function + with tempfile.NamedTemporaryFile(mode="w", dir=temp_dir, delete=False) as temp_file: + temp_file.write(input_text) + temp_file.flush() + + return temp_file.name + + +def handle_input_file(input_file, temp_dir): + # Save the input file to the temporary directory + with tempfile.NamedTemporaryFile( + mode="wb", dir=temp_dir, delete=False + ) as temp_file: + for chunk in input_file.chunks(): + temp_file.write(chunk) + + return temp_file.name diff --git a/scantext/match_text.py b/scantext/match_text.py new file mode 100644 index 000000000..c4e0567a1 --- /dev/null +++ b/scantext/match_text.py @@ -0,0 +1,417 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# http://nexb.com and https://github.com/nexB/scancode.io +# The ScanCode.io software is licensed under the Apache License version 2.0. +# Data generated with ScanCode.io is provided as-is without warranties. +# 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. +# +# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES +# OR CONDITIONS OF ANY KIND, either express or implied. No content created from +# ScanCode.io should be considered or used as legal advice. Consult an Attorney +# for any legal advice. +# +# ScanCode.io is a free software code scanning tool from nexB Inc. and others. +# Visit https://github.com/nexB/scancode.io for support and download. + +import attr +from licensedcode import models +from licensedcode import query +from licensedcode.spans import Span +from licensedcode.stopwords import STOPWORDS +from licensedcode.tokenize import index_tokenizer +from licensedcode.tokenize import matched_query_text_tokenizer + +SCANCODE_BASE_URL = ( + "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data" +) +SPDX_LICENSE_URL = "https://spdx.org/licenses/{}" +SCANCODE_LICENSEDB_URL = "https://scancode-licensedb.aboutcode.org/{}" + + +@attr.s(slots=True) +class Token: + """ + Used to represent a token in collected query-side matched texts and SPDX + identifiers. + + ``matches`` is a lits of LicenseMatch to accomodate for overlapping matches. + For example, say we have these two matched text portions: + QueryText: this is licensed under GPL or MIT + Match1: this is licensed under GPL + Match2: licensed under GPL or MIT + + Each Token would be to assigned one or more LicenseMatch: + this: Match1 : yellow + is: Match1 : yellow + licensed: Match1, Match2 : orange (mixing yellow and pink colors) + under: Match1, Match2 : orange (mixing yellow and pink colors) + GPL: Match1, Match2 : orange (mixing yellow and pink colors) + or: Match2 : pink + MIT: Match2 : pink + """ + + # original text value for this token. + value = attr.ib() + + # line number, one-based + line_num = attr.ib() + + # absolute position for known tokens, zero-based. -1 for unknown tokens + pos = attr.ib(default=-1) + + # True if text/alpha False if this is punctuation or spaces + is_text = attr.ib(default=False) + + # True if part of a match + is_matched = attr.ib(default=False) + + # True if this is a known token + is_known = attr.ib(default=False) + + # List of LicenseMatch ids that match this token + match_ids = attr.ib(attr.Factory(list)) + + # Rules collected from license_matches using above match_ids + match_rules = attr.ib(default=None) + + +def get_match_details(mid, match, license_url_template, spdx_license_url): + """ + Return a mapping of license data built from a LicenseMatch ``match``. + """ + from licensedcode import cache + + licenses = cache.get_licenses_db() + + # TODO: decide whether the text should be highlighted or not. + matched_text = match.matched_text(whole_lines=False, highlight=False) + + SCANCODE_LICENSE_TEXT_URL = SCANCODE_BASE_URL + "/{}.LICENSE" + SCANCODE_LICENSE_DATA_URL = SCANCODE_BASE_URL + "/{}.yml" + + result = {} + + result["mid"] = mid + # Detection Level Information + result["score"] = int(match.score()) + result["start_line"] = match.start_line + result["end_line"] = match.end_line + result["matched_length"] = match.len() + result["match_coverage"] = match.coverage() + result["matcher"] = match.matcher + + # LicenseDB Level Information (Rule that was matched) + result["license_expression"] = match.rule.license_expression + result["rule_text_url"] = get_rule_text_url(match.rule) + result["rule_identifier"] = match.rule.identifier + result["referenced_filenames"] = match.rule.referenced_filenames + result["is_license_text"] = match.rule.is_license_text + result["is_license_notice"] = match.rule.is_license_notice + result["is_license_reference"] = match.rule.is_license_reference + result["is_license_tag"] = match.rule.is_license_tag + result["is_license_intro"] = match.rule.is_license_intro + result["rule_length"] = match.rule.length + result["rule_relevance"] = match.rule.relevance + result["matched_text"] = matched_text + + # License Level Information (Individual licenses that this rule refers to) + result["licenses"] = detected_licenses = [] + for license_key in match.rule.license_keys(): + detected_license = {} + detected_licenses.append(detected_license) + + lic = licenses.get(license_key) + + detected_license["key"] = lic.key + detected_license["name"] = lic.name + detected_license["short_name"] = lic.short_name + detected_license["category"] = lic.category + detected_license["is_exception"] = lic.is_exception + detected_license["is_unknown"] = lic.is_unknown + detected_license["owner"] = lic.owner + detected_license["homepage_url"] = lic.homepage_url + detected_license["text_url"] = lic.text_urls[0] if lic.text_urls else "" + detected_license["reference_url"] = license_url_template.format(lic.key) + detected_license["scancode_text_url"] = SCANCODE_LICENSE_TEXT_URL.format( + lic.key + ) + detected_license["scancode_data_url"] = SCANCODE_LICENSE_DATA_URL.format( + lic.key + ) + + spdx_key = lic.spdx_license_key + detected_license["spdx_license_key"] = spdx_key + + if spdx_key: + is_license_ref = spdx_key.lower().startswith("licenseref-") + if is_license_ref: + spdx_url = SCANCODE_LICENSE_TEXT_URL.format(lic.key) + else: + # TODO: Is this replacing spdx_key??? + spdx_key = lic.spdx_license_key.rstrip("+") + spdx_url = spdx_license_url.format(spdx_key) + else: + spdx_url = "" + detected_license["spdx_url"] = spdx_url + + return result + + +def get_licenses(location, license_url_template=SCANCODE_LICENSEDB_URL, **kwargs): + """ + Return a mapping of license match data from detecting license + in the file at ``location`` suitable for use in template. + + The mapping can be empty if there are no matches. + """ + from licensedcode.cache import get_index + + idx = get_index() + + # gets matches from a license file + matches = idx.match( + location=location, + unknown_licenses=True, + **kwargs, + ) + + if not matches: + return {} + + query = matches[0].query + + # Assign a numeric id to every match. + matches_by_id = dict(enumerate(matches)) + + del matches + + license_matches = [] + + for mid, match in matches_by_id.items(): + license_matches.append( + get_match_details( + mid=mid, + match=match, + license_url_template=license_url_template, + spdx_license_url=SPDX_LICENSE_URL, + ) + ) + + license_tokens = get_license_tokens( + query=query, + matches_by_id=matches_by_id, + stopwords=STOPWORDS, + ) + + for tkn in license_tokens: + if tkn.match_ids: + rules, seperator = [], ", " + for rule_id in tkn.match_ids: + rules.append(license_matches[rule_id]["license_expression"]) + tkn.match_rules = seperator.join(rules) + del rules + else: + tkn.match_rules = "No match found." + + match_colors = get_build_colors(matches_by_id=matches_by_id) + + return { + "license_matches": license_matches, + "license_tokens": license_tokens, + "match_colors": match_colors, + "license_keys_count": get_license_keys_count(matches=matches_by_id.values()), + "percentage_of_license_text": get_percentage_of_license_text( + query=query, matches=matches_by_id.values() + ), + } + + +def get_license_tokens(query, matches_by_id, stopwords=STOPWORDS): + """ + Return a list of tokens from the list of ``matches`` in ``query``. + """ + # Token(value="", pos=3, is_text=True, is_matched=True, match_ids=[mid, mid, mid]) + tokens = list( + tokenize_matched_text( + location=query.location, + query_string=query.query_string, + dictionary=query.idx.dictionary, + start_line=query.start_line, + ) + ) + + for mid, match in matches_by_id.items(): + tag_matched_tokens(tokens=tokens, match_qspan=match.qspan, mid=mid) + + return tokens + + +def tokenize_matched_text(location, query_string, dictionary, start_line=1): + """ + Yield Token objects with pos and line number collected from the file at + `location` or the `query_string` string. `dictionary` is the index mapping + of tokens to token ids. + """ + pos = 0 + qls = query.query_lines( + location=location, + query_string=query_string, + strip=False, + start_line=start_line, + ) + for line_num, line in qls: + for is_text, token_str in matched_query_text_tokenizer(line): + # Determine if a token is is_known in the license index or not. This + # is essential as we need to realign the query-time tokenization + # with the full text to report proper matches. + if is_text and token_str and token_str.strip(): + # we retokenize using the query tokenizer: + # 1. to lookup for is_known tokens in the index dictionary + + # 2. to ensure the number of tokens is the same in both + # tokenizers (though, of course, the case will differ as the + # regular query tokenizer ignores case and punctuations). + qtokenized = list(index_tokenizer(token_str)) + if not qtokenized: + yield Token( + value=token_str, + line_num=line_num, + is_text=is_text, + is_known=False, + pos=-1, + ) + + elif len(qtokenized) == 1: + is_known = qtokenized[0] in dictionary + if is_known: + p = pos + pos += 1 + else: + p = -1 + + yield Token( + value=token_str, + line_num=line_num, + is_text=is_text, + is_known=is_known, + pos=p, + ) + else: + # we have two or more tokens from the original query mapped + # to a single matched text tokenizer token. + for qtoken in qtokenized: + is_known = qtoken in dictionary + if is_known: + p = pos + pos += 1 + else: + p = -1 + + yield Token( + value=qtoken, + line_num=line_num, + is_text=is_text, + is_known=is_known, + pos=p, + ) + else: + yield Token( + value=token_str, + line_num=line_num, + is_text=False, + is_known=False, + pos=-1, + ) + + +def tag_matched_tokens(tokens, match_qspan, mid): + """ + Tag an iterable of ``tokens`` tagging each token with ``mid`` match id + if matched meaning the token is in the ``match_qspan``. + """ + previous_is_matched = False + for tok in tokens: + if previous_is_matched and not tok.is_text: + tok.match_ids.append(mid) + tok = attr.evolve(tok, is_matched=True) + previous_is_matched = False + elif tok.pos != -1 and tok.is_known and tok.pos in match_qspan: + tok.match_ids.append(mid) + tok = attr.evolve(tok, is_matched=True) + previous_is_matched = True + + +def get_build_colors(matches_by_id): + """ + Return a list of color codes. + + .matched1 {background-color: rgba(30, 220, 90, 0.3);} + .matched2 {background-color: rgba(30, 90, 220, 0.3);} + .matched3 {background-color: rgba(220, 90, 30, 0.3);} + """ + color_code_ids = [] + + color_codes = [ + ".matched{} {{background-color: rgba(255, 176, 0, 1);}}", + ".matched{} {{background-color: rgba(100, 143, 255, 1);}}", + ".matched{} {{background-color: rgba(120, 94, 240, 1);}}", + ".matched{} {{background-color: rgba(220, 38, 127, 1);}}", + ".matched{} {{background-color: rgba(254, 97, 0, 1);}}", + ".matched{} {{background-color: rgba(204, 121, 167, 1);}}", + ".matched{} {{background-color: rgba(68, 170, 153, 1);}}", + ] + + for mid in matches_by_id: + color_code_ids.append(color_codes[mid % len(color_codes)].format(mid)) + return color_code_ids + + +def get_percentage_of_license_text(query, matches): + """ + Return percentage of license text matched in ``query`` Query by + a list of ``matches`` percentage is a float between 0 and 100. + """ + + # TODO: percentage of license text should be done by scancode-toolkit. + if not matches: + return 0 + + qspans = (match.qspan for match in matches) + + matched_tokens_length = len(Span().union(*qspans)) + query_tokens_length = query.tokens_length(with_unknown=True) + return round((matched_tokens_length / query_tokens_length) * 100, 2) + + +def get_rule_text_url(rule, base_url=SCANCODE_BASE_URL): + """ + Return a URL to the text file of a ``rule`` Rule. + Return None if there is no URL for the ``rule``. + """ + + if isinstance(rule, (models.SpdxRule, models.UnknownRule)): + return + + if rule.is_from_license: + return f"{base_url}/licenses/{rule.identifier}" + + else: + return f"{base_url}/rules/{rule.identifier}" + + +def get_license_keys_count(matches): + """ + Return the number of unique license keys found in a list of license matches. + """ + keys = set() + for match in matches: + keys.update(match.rule.license_keys()) + + return len(keys) diff --git a/scantext/templates/scantext/includes/license_report.html b/scantext/templates/scantext/includes/license_report.html new file mode 100644 index 000000000..aa3c064d5 --- /dev/null +++ b/scantext/templates/scantext/includes/license_report.html @@ -0,0 +1,2 @@ +Report on Github \ No newline at end of file diff --git a/scantext/templates/scantext/includes/license_summary_detail.html b/scantext/templates/scantext/includes/license_summary_detail.html new file mode 100644 index 000000000..ba19754d0 --- /dev/null +++ b/scantext/templates/scantext/includes/license_summary_detail.html @@ -0,0 +1,90 @@ +
+
+

Detected Licenses

+
+ {% for license in detected_licenses.license_matches %} +
+ +
+ {{ license.mid|add:1 }}.{{ license.license_expression }} +
+ +
+

{{ license.score }}%

+
+

+ + + +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
License Expression{{ license.license_expression }}
Score{{ license.score }}%
Matched Line(s){% if license.start_line == license.end_line %} {{ license.start_line }} {% else %} {{ license.start_line }} - {{ license.end_line }} {% endif %}
Rule Identifier + {% if license.rule_text_url %} + {{ license.rule_identifier }} + {% else %} + {{ license.rule_identifier }} + {% endif %} +
Matcher{{ license.matcher }}
Match Coverage{{ license.match_coverage }}
Matched Length{{ license.matched_length }}
Key(s) + {% for key in license.licenses %} + {{ key.key }} + {% endfor %} +
Rule Relevance{{ license.rule_relevance }}
Rule Length{{ license.rule_length }}
+
+ + {% include 'scantext/includes/license_report.html' with license=license %} +
+
+
+
+
+
+ {% endfor %} +
+
+
+

Input Text

+
{% for token in detected_licenses.license_tokens %}{{ token.value }}{% endfor %}
+
+
\ No newline at end of file diff --git a/scantext/templates/scantext/includes/license_summary_header.html b/scantext/templates/scantext/includes/license_summary_header.html new file mode 100644 index 000000000..d580d2cee --- /dev/null +++ b/scantext/templates/scantext/includes/license_summary_header.html @@ -0,0 +1,27 @@ +{% load humanize %} + \ No newline at end of file diff --git a/scantext/templates/scantext/license_scan_form.html b/scantext/templates/scantext/license_scan_form.html new file mode 100644 index 000000000..6b16acf13 --- /dev/null +++ b/scantext/templates/scantext/license_scan_form.html @@ -0,0 +1,53 @@ +{% extends "scanpipe/base.html" %} +{% load static humanize %} + +{% block content %} +
+ {% include 'scanpipe/includes/navbar_header.html' %} +
{% include 'scanpipe/includes/messages.html' %}
+ +
+
+

Scan License

+
+ +
+ {% csrf_token %} + {{ form.input_text }} +
+
+ +
+
+ +
+
+
+
+
+{% endblock %} + +{% block scripts %} + +{% endblock %} \ No newline at end of file diff --git a/scantext/templates/scantext/license_summary.html b/scantext/templates/scantext/license_summary.html new file mode 100644 index 000000000..de12a3dd6 --- /dev/null +++ b/scantext/templates/scantext/license_summary.html @@ -0,0 +1,121 @@ +{% extends 'scanpipe/base.html' %} +{% load static humanize %} + +{% block extrahead %} + +{% endblock %} + +{% block content %} +
+ {% include 'scanpipe/includes/navbar_header.html' %} + + {% include 'scantext/includes/license_summary_header.html' with detected_licenses=detected_licenses %} +
+ +
+ {% include 'scantext/includes/license_summary_detail.html' with detected_licenses=detected_licenses %} +
+ +
+{% endblock %} + +{% block scripts %} + +{% endblock %} \ No newline at end of file diff --git a/scantext/tests/__init__.py b/scantext/tests/__init__.py new file mode 100644 index 000000000..1f72cf031 --- /dev/null +++ b/scantext/tests/__init__.py @@ -0,0 +1,21 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# http://nexb.com and https://github.com/nexB/scancode.io +# The ScanCode.io software is licensed under the Apache License version 2.0. +# Data generated with ScanCode.io is provided as-is without warranties. +# 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. +# +# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES +# OR CONDITIONS OF ANY KIND, either express or implied. No content created from +# ScanCode.io should be considered or used as legal advice. Consult an Attorney +# for any legal advice. +# +# ScanCode.io is a free software code scanning tool from nexB Inc. and others. +# Visit https://github.com/nexB/scancode.io for support and download. diff --git a/scantext/tests/data/LICENSES b/scantext/tests/data/LICENSES new file mode 100644 index 000000000..4e2825c9b --- /dev/null +++ b/scantext/tests/data/LICENSES @@ -0,0 +1,755 @@ + 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.Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +Redistributions of source code must retain the above copyright notice, this list +of conditions and the following disclaimer. + +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. + +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 HOLDER 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.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 holder 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 HOLDER 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.Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, 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.GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be introduced by others. + + Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those libraries into non-free programs. + + When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating system. + + Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must + be optional: if the application does not supply it, the square root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in these notices. + + Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies the executable. + + It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the Sections above. + + b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is +implemented by public license practices. Many people have made generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot impose that choice. + +This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it!Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.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 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 OPEN SOURCE LICENSE AGREEMENT (for Python 1.6b1) +-------------------------------------------------- + +IMPORTANT: PLEASE READ THE FOLLOWING AGREEMENT CAREFULLY. + +BY CLICKING ON "ACCEPT" WHERE INDICATED BELOW, OR BY COPYING, +INSTALLING OR OTHERWISE USING PYTHON 1.6, beta 1 SOFTWARE, YOU ARE +DEEMED TO HAVE AGREED TO THE TERMS AND CONDITIONS OF THIS LICENSE +AGREEMENT. + +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, beta 1 +software in source or binary form and its associated documentation, +as released at the www.python.org Internet site on August 4, 2000 +("Python 1.6b1"). + +2. Subject to the terms and conditions of this License Agreement, CNRI +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 +Python 1.6b1 alone or in any derivative version, provided, however, +that CNRIs License Agreement is retained in Python 1.6b1, alone or +in any derivative version prepared by Licensee. + +Alternately, in lieu of CNRIs License Agreement, Licensee may +substitute the following text (omitting the quotes): "Python 1.6, +beta 1, is made available subject to the terms and conditions in +CNRIs License Agreement. This Agreement may be located on the +Internet using the following unique, persistent identifier (known +as a handle): 1895.22/1011. This Agreement may also be obtained +from a proxy server on the Internet using the +URL:http://hdl.handle.net/1895.22/1011". + +3. In the event Licensee prepares a derivative work that is based on +or incorporates Python 1.6b1 or any part thereof, and wants to make +the derivative work available to the public as provided herein, +then Licensee hereby agrees to indicate in any such work the nature +of the modifications made to Python 1.6b1. + +4. CNRI is making Python 1.6b1 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.6b1 +WILL NOT INFRINGE ANY THIRD PARTY RIGHTS. + +5. CNRI 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 PYTHON 1.6b1, +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 and interpreted in all +respects by the law of the State of Virginia, excluding conflict of +law provisions. 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.6b1, 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. + +Apache-2.0 + +MIT + +Lesser GPL diff --git a/scantext/tests/data/complexLICENSES b/scantext/tests/data/complexLICENSES new file mode 100644 index 000000000..a0b64aea1 --- /dev/null +++ b/scantext/tests/data/complexLICENSES @@ -0,0 +1,106 @@ +#FFmpeg: + +Most files in FFmpeg are under the GNU Lesser General Public License version 2.1 +or later (LGPL v2.1+). Read the file COPYING.LGPLv2.1 for details. Some other +files have MIT/X11/BSD-style licenses. In combination the LGPL v2.1+ applies to +FFmpeg. + +Some optional parts of FFmpeg are licensed under the GNU General Public License +version 2 or later (GPL v2+). See the file COPYING.GPLv2 for details. None of +these parts are used by default, you have to explicitly pass --enable-gpl to +configure to activate them. In this case, FFmpeg's license changes to GPL v2+. + +Specifically, the GPL parts of FFmpeg are: + +- libpostproc +- libmpcodecs +- optional x86 optimizations in the files + libavcodec/x86/flac_dsp_gpl.asm + libavcodec/x86/idct_mmx.c +- libutvideo encoding/decoding wrappers in + libavcodec/libutvideo*.cpp +- the X11 grabber in libavdevice/x11grab.c +- the swresample test app in + libswresample/swresample-test.c +- the texi2pod.pl tool +- the following filters in libavfilter: + - f_ebur128.c + - vf_blackframe.c + - vf_boxblur.c + - vf_colormatrix.c + - vf_cropdetect.c + - vf_decimate.c + - vf_delogo.c + - vf_geq.c + - vf_histeq.c + - vf_hqdn3d.c + - vf_interlace.c + - vf_kerndeint.c + - vf_mcdeint.c + - vf_mp.c + - vf_owdenoise.c + - vf_perspective.c + - vf_phase.c + - vf_pp.c + - vf_pullup.c + - vf_sab.c + - vf_smartblur.c + - vf_spp.c + - vf_stereo3d.c + - vf_super2xsai.c + - vf_tinterlace.c + - vsrc_mptestsrc.c + +Should you, for whatever reason, prefer to use version 3 of the (L)GPL, then +the configure parameter --enable-version3 will activate this licensing option +for you. Read the file COPYING.LGPLv3 or, if you have enabled GPL parts, +COPYING.GPLv3 to learn the exact legal terms that apply in this case. + +There are a handful of files under other licensing terms, namely: + +* The files libavcodec/jfdctfst.c, libavcodec/jfdctint_template.c and + libavcodec/jrevdct.c are taken from libjpeg, see the top of the files for + licensing details. Specifically note that you must credit the IJG in the + documentation accompanying your program if you only distribute executables. + You must also indicate any changes including additions and deletions to + those three files in the documentation. + tests/reference.pnm is under the expat license + + +external libraries +================== + +FFmpeg can be combined with a number of external libraries, which sometimes +affect the licensing of binaries resulting from the combination. + +compatible libraries +-------------------- + +The following libraries are under GPL: + - frei0r + - libcdio + - libutvideo + - libvidstab + - libx264 + - libx265 + - libxavs + - libxvid +When combining them with FFmpeg, FFmpeg needs to be licensed as GPL as well by +passing --enable-gpl to configure. + +The OpenCORE and VisualOn libraries are under the Apache License 2.0. That +license is incompatible with the LGPL v2.1 and the GPL v2, but not with +version 3 of those licenses. So to combine these libraries with FFmpeg, the +license version needs to be upgraded by passing --enable-version3 to configure. + +incompatible libraries +---------------------- + +The Fraunhofer AAC library, FAAC and aacplus are under licenses which +are incompatible with the GPLv2 and v3. We do not know for certain if their +licenses are compatible with the LGPL. +If you wish to enable these libraries, pass --enable-nonfree to configure. +But note that if you enable any of these libraries the resulting binary will +be under a complex license mix that is more restrictive than the LGPL and that +may result in additional obligations. It is possible that these +restrictions cause the resulting binary to be unredistributeable. \ No newline at end of file diff --git a/scantext/tests/data/miniLICENSES b/scantext/tests/data/miniLICENSES new file mode 100644 index 000000000..ea5c84937 --- /dev/null +++ b/scantext/tests/data/miniLICENSES @@ -0,0 +1,5 @@ +Apache-2.0 + +MIT + +Lesser GPL \ No newline at end of file diff --git a/scantext/tests/test_views.py b/scantext/tests/test_views.py new file mode 100644 index 000000000..e38021221 --- /dev/null +++ b/scantext/tests/test_views.py @@ -0,0 +1,81 @@ +# -*- coding: utf-8 -*- +# +# Copyright (c) nexB Inc. and others. All rights reserved. +# ScanCode is a trademark of nexB Inc. +# SPDX-License-Identifier: Apache-2.0 +# See http://www.apache.org/licenses/LICENSE-2.0 for the license text. +# See https://github.com/nexB/scancode-toolkit for support or download. +# See https://aboutcode.org for more information about nexB OSS projects. +# +import os + +from commoncode.testcase import FileBasedTesting +from licensedcode import match +from licensedcode import models +from licensedcode.spans import Span + +from scantext.match_text import get_build_colors +from scantext.match_text import get_license_keys_count +from scantext.match_text import get_rule_text_url + +TEST_DATA_DIR = os.path.join(os.path.dirname(__file__), "data") + +SCANCODE_BASE_URL = ( + "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data" +) +SPDX_LICENSE_URL = "https://spdx.org/licenses/{}" +SCANCODE_LICENSEDB_URL = "https://scancode-licensedb.aboutcode.org/{}" + + +class TestScantextViews(FileBasedTesting): + test_data_dir = TEST_DATA_DIR + + def test_get_license_keys_count(self): + rule1 = models.Rule(license_expression="Apache-2.0", text="1") + rule2 = models.Rule(license_expression="Apache-2.0 OR MIT", text="2") + rule3 = models.Rule(license_expression="BSD AND GPL", text="3") + + match1 = match.LicenseMatch(rule=rule1, ispan=Span(), qspan=Span()) + match2 = match.LicenseMatch(rule=rule2, ispan=Span(), qspan=Span()) + match3 = match.LicenseMatch(rule=rule3, ispan=Span(), qspan=Span()) + matches = [match1, match2, match3] + + response = get_license_keys_count(matches) + expected = 4 + self.assertEqual(response, expected) + + def test_get_rule_text_url_for_rule(self): + rule1 = models.Rule(license_expression="Apache-2.0", text="1") + rule1.identifier = "Apache-2.0.RULE" + + response = get_rule_text_url(rule=rule1, base_url="http://example.com") + expected = "http://example.com/rules/Apache-2.0.RULE" + self.assertEqual(response, expected) + + def test_get_rule_text_url_for_license(self): + rule1 = models.Rule( + license_expression="Apache-2.0", text="1", is_from_license=True + ) + rule1.identifier = "Apache-2.0.LICENSE" + + response = get_rule_text_url(rule=rule1, base_url="http://example.com") + expected = "http://example.com/licenses/Apache-2.0.LICENSE" + self.assertEqual(response, expected) + + def test_get_rule_text_url_for_spdx(self): + rule1 = models.SpdxRule(license_expression="Apache-2.0", text="1") + response = get_rule_text_url(rule=rule1, base_url="http://example.com") + self.assertIsNone(response) + + def test_get_rule_text_url_for_unknown(self): + rule1 = models.UnknownRule(license_expression="Apache-2.0", text="1") + response = get_rule_text_url(rule=rule1, base_url="http://example.com") + self.assertIsNone(response) + + def test_get_rule_text_url_with_default_base_url(self): + rule1 = models.Rule(license_expression="apache-2.0 or mit", text="1") + rule1.identifier = "apache-2.0_or_mit_48.RULE" + + response = get_rule_text_url(rule=rule1) + expected = SCANCODE_BASE_URL + "/rules/apache-2.0_or_mit_48.RULE" + self.assertEqual(response, expected) diff --git a/scantext/urls.py b/scantext/urls.py new file mode 100644 index 000000000..38b277a64 --- /dev/null +++ b/scantext/urls.py @@ -0,0 +1,29 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# http://nexb.com and https://github.com/nexB/scancode.io +# The ScanCode.io software is licensed under the Apache License version 2.0. +# Data generated with ScanCode.io is provided as-is without warranties. +# 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. +# +# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES +# OR CONDITIONS OF ANY KIND, either express or implied. No content created from +# ScanCode.io should be considered or used as legal advice. Consult an Attorney +# for any legal advice. +# +# ScanCode.io is a free software code scanning tool from nexB Inc. and others. +# Visit https://github.com/nexB/scancode.io for support and download. + +from django.urls import path + +from scantext import views + +urlpatterns = [ + path("", views.license_scanview, name="license_scan"), +] diff --git a/scantext/views.py b/scantext/views.py new file mode 100644 index 000000000..ce6daa328 --- /dev/null +++ b/scantext/views.py @@ -0,0 +1,97 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# http://nexb.com and https://github.com/nexB/scancode.io +# The ScanCode.io software is licensed under the Apache License version 2.0. +# Data generated with ScanCode.io is provided as-is without warranties. +# 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. +# +# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES +# OR CONDITIONS OF ANY KIND, either express or implied. No content created from +# ScanCode.io should be considered or used as legal advice. Consult an Attorney +# for any legal advice. +# +# ScanCode.io is a free software code scanning tool from nexB Inc. and others. +# Visit https://github.com/nexB/scancode.io for support and download. + +from django.contrib import messages +from django.shortcuts import render + +from scantext.forms import LicenseScanForm +from scantext.forms import handle_input_file +from scantext.forms import handle_input_text +from scantext.match_text import get_licenses + + +def license_scanview(request): + if request.method != "POST": + return render( + request, "scantext/license_scan_form.html", {"form": LicenseScanForm()} + ) + + form = LicenseScanForm(request.POST, request.FILES) + if not form.is_valid(): + return render( + request, "scantext/license_scan_form.html", {"form": LicenseScanForm()} + ) + + input_text = form.cleaned_data["input_text"] + input_file = request.FILES.get("input_file", False) + + if input_text and input_file: + message = "Provide text or a text file but not both." + messages.warning(request, message) + return render( + request, + "scantext/license_scan_form.html", + { + "form": LicenseScanForm(), + }, + ) + + if not input_text and not input_file: + message = "Provide text or a text file to scan." + messages.warning(request, message) + return render( + request, + "scantext/license_scan_form.html", + { + "form": LicenseScanForm(), + }, + ) + + from commoncode.fileutils import get_temp_dir + + temp_dir = get_temp_dir(prefix="scantext_") + if input_text: + file_path = handle_input_text(input_text, temp_dir) + elif input_file: + file_path = handle_input_file(input_file, temp_dir) + + expressions = get_licenses(location=file_path) + + if not expressions: + message = "Could not detect any license." + messages.warning(request, message) + return render( + request, + "scantext/license_scan_form.html", + { + "form": LicenseScanForm(), + }, + ) + + return render( + request, + "scantext/license_summary.html", + { + "text": input_text, + "detected_licenses": expressions, + }, + )