An app to detect licenses from the provided input license text

scancodeio/settings.py

@@ -78,6 +78,7 @@
     # Local apps
     # Must come before Third-party apps for proper templates override
     "scanpipe",
+    "scantext",
     # Django built-in
     "django.contrib.auth",
     "django.contrib.contenttypes",

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/")),
 ]

scanpipe/templates/scanpipe/base.html

@@ -57,4 +57,4 @@
     <script src="{% static 'htmx-1.7.0.min.js' %}" crossorigin="anonymous" defer></script>
     {% block scripts %}{% endblock %}
   </body>
-</html>
+</html>

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.

scantext/apps.py

@@ -0,0 +1,28 @@
+# 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):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "scantext"

scantext/forms.py

@@ -0,0 +1,42 @@
+# 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 import forms
+
+
+class EditorForm(forms.Form):
+    input_text = forms.CharField(
+        widget=forms.Textarea(
+            attrs={
+                "rows": 25,
+                "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},
+        ),
+    )

scantext/models.py

@@ -0,0 +1,25 @@
+# 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.db import models
+
+# Create your models here.

scantext/templates/scantext/includes/license_summary_level.html

@@ -0,0 +1,27 @@
+{% load humanize %}
+<nav class="level is-mobile">
+    <div class="level-item has-text-centered">
+        <div>
+            <p class="heading">Percentage Of License Text</p>
+            <p class="title">
+              <span>{{ expr.percentage_of_license_text }}</span>
+            </p>
+        </div>
+    </div>
+    <div class="level-item has-text-centered">
+        <div>
+            <p class="heading">License Expressions</p>
+            <p class="title">
+              <span>{{ expr.license_expressions|length }}</span>
+            </p>
+        </div>
+    </div>
+    <div class="level-item has-text-centered">
+        <div>
+            <p class="heading">Licenses</p>
+            <p class="title">
+              <span>{{ expr.licenses|length }}</span>
+            </p>
+        </div>
+    </div>
+</nav>

scantext/templates/scantext/license_detail.html

@@ -0,0 +1,99 @@
+{% extends 'scanpipe/base.html' %} 
+{% load static humanize %} 
+
+{% block content %}
+<div class="container is-widescreen">
+    {% include 'scanpipe/includes/navbar_header.html' %}
+    <div class="mx-5 mb-2">{% include 'scanpipe/includes/messages.html' %}</div>
+
+    <section class="section p-0">
+        <div class="is-flex is-justify-content-space-between is-align-items-center mb-2">
+            <div class="mb-2">
+                <h1 class="title is-4">License Detection Summary</h1>
+            </div>
+            <div>
+                <a href="{% url 'license_scan' %}" class="button is-link">Scan Again</a>
+            </div>
+        </div>
+    </section>
+
+    <hr class="mx-5">
+    {% include "scantext/includes/license_summary_level.html" with expr=expr %}
+    <hr class="mx-5">
+
+    <div class="columns mb-5">
+        <div class="column is-half">
+            <p class="title is-4">Input License Text</p>
+            <pre>{{ text }}</pre>
+        </div>
+        <div class="column is-half">
+            <p class="title is-4">Detected Licenses</p>
+            <div class="card">
+                {% for license in expr.licenses %}
+                <div class="licenses-card">
+                    <div class="card-header is-flex is-justify-content-space-between">
+                        <div class="card-header-title" title="{{ license.short_name }}">
+                          {% if license.homepage_url %}
+                            <a href="{{ license.homepage_url }}" title="{{ license.name }} ({{ license.short_name }})">{{ license.short_name }}</a> 
+                          {% else %} {{ license.short_name }} {% endif %}
+                        </div>
+                        <div class="is-flex is-justify-content-row is-align-items-center">
+                            <p class="lines tag is-6 mx-1 is-light is-info">
+                              {% if license.start_line == license.end_line %} Line {{ license.start_line }} {% else %} Lines {{ license.start_line }} - {{ license.end_line }} {% endif %}
+                            </p>
+                            <p class="tag is-6 mx-1 is-light 
+                  {% if license.score == 100 %} is-success {% else %} is-warning {% endif %}">{{ license.score }}</p>
+                            <p class="card-header-icon" aria-label="more options">
+                              <span class="icon">
+                                <i class="fas fa-angle-down" aria-hidden="true"></i>
+                              </span>
+                            </p>
+                        </div>
+                    </div>
+                    <div class="card-content is-hidden">
+                        <div class="content">
+                            <div class="is-flex is-justify-content-space-between">
+                                <div>
+                                    <p class="subtitle is-5">Matched Text</p>
+                                </div>
+                                <div>
+                                    <p class="tag is-6 mx-1 is-light is-primary">{{ license.category }}</p>
+                                    <a class="tag is-6 mx-1 is-light is-link" href="{{ license.reference_url }}">ref</a>
+                                    <p class="tag is-6 mx-1 is-light is-info">
+                                        {% if license.start_line == license.end_line %} Line {{ license.start_line }} {% else %} Lines {{ license.start_line }} - {{ license.end_line }} {% endif %}
+                                    </p>
+                                </div>
+                            </div>
+                            <pre>{{ license.matched_text }}</pre>
+                        </div>
+                    </div>
+                </div>
+                {% endfor %}
+            </div>
+        </div>
+    </div>
+
+</div>
+{% endblock %} 
+
+{% block scripts %}
+<script type="text/javascript">
+    const cards = document.querySelectorAll('.card-header-icon')
+
+    cards.forEach(card => {
+      card.addEventListener('click', (event) => {
+        event.preventDefault()
+        content = card.parentElement.parentElement.parentElement.querySelector('.card-content').classList
+        lineTag= card.parentElement.querySelector('.lines').classList
+        if (content.contains('is-hidden')) {
+          content.remove('is-hidden')
+          lineTag.add('is-hidden')
+        } else {
+          content.add('is-hidden')
+          lineTag.remove('is-hidden')
+        }
+      })
+    })
+
+</script>
+{% endblock %}

scantext/templates/scantext/license_scan.html

@@ -0,0 +1,50 @@
+{% extends "scanpipe/base.html" %} 
+{% load static humanize %} 
+
+{% block content %}
+<div class="container is-max-desktop">
+    {% include 'scanpipe/includes/navbar_header.html' %}
+    <div class="mx-5 mb-2">{% include 'scanpipe/includes/messages.html' %}</div>
+
+    <section class="section pt-0">
+        <div class="is-flex is-justify-content-space-between is-align-items-center mb-2">
+            <div class="mb-2">
+                <h1 class="title is-5">Scan License</h1>
+            </div>
+            <div>
+                <a href="{% url 'project_list' %}" class="button is-link">Go to Projects</a>
+            </div>
+        </div>
+        <form method="post" action="{% url 'license_scan' %}">
+            {% csrf_token %}
+            {{ form.input_text }}
+            <div class="columns mt-1">
+                <div class="file has-name is-fullwidth column is-half">
+                  <label class="file-label">
+                    {{ form.input_file }}
+                    <span class="file-cta">
+                      <span class="file-icon">
+                        <i class="fas fa-upload"></i>
+                      </span>
+                      <span class="file-label">Choose a file to scan…</span>
+                    </span>
+                    <span class="file-name">/home/user/dev/license-text.txt</span>
+                  </label>
+                </div>
+                <div class="column is-half">
+                  <input type="submit" class="button is-fullwidth is-link" value="Scan License">
+                </div>
+            </div>
+        </form>
+    </section>
+</div>
+{% endblock %} {% block scripts %}
+<script>
+    let form = document.querySelector('form');
+
+    // form.addEventListener('submit', (event) => {
+
+    //   if (!form["id_input_file"].files.length && !form["id_input_text"].value.length) return false;
+    // });
+</script>
+{% endblock %} -->

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.