An app to detect licenses from the provided input license text

scancodeio/settings.py

@@ -45,7 +45,7 @@
 ALLOWED_HOSTS = env.list("ALLOWED_HOSTS", default=[".localhost", "127.0.0.1", "[::1]"])
 
 # SECURITY WARNING: don't run with debug turned on in production
-DEBUG = env.bool("SCANCODEIO_DEBUG", default=False)
+DEBUG = env.bool("SCANCODEIO_DEBUG", default=True)
 
 SCANCODEIO_REQUIRE_AUTHENTICATION = env.bool(
     "SCANCODEIO_REQUIRE_AUTHENTICATION", default=False
@@ -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("scan/", include("scantext.urls")),
     path("", include("scanpipe.urls")),
     path("", RedirectView.as_view(url="project/")),
 ]

scanpipe/templates/scanpipe/base.html

@@ -5,6 +5,7 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title>{% block title %}ScanCode.io{% endblock %}</title>
+    <link rel="icon" href="{% static 'favicon.ico' %}" type="image/x-icon"/>
     <link rel="stylesheet" href="{% static 'bulma-0.9.2.min.css' %}" crossorigin="anonymous">
     <link rel="stylesheet" href="{% static 'highlight-10.6.0.css' %}" crossorigin="anonymous">
     <style>

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/admin.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.contrib import admin
+
+# Register your models here.

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,64 @@
+# 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": 30,
+                "class": "textarea has-fixed-size",
+                "placeholder": "Paste your license text here.",
+            }
+        ),
+        required=True,
+    )
+
+    # def clean_input_text(self):
+    #     input_text = self.cleaned_data.get("input_text")
+    #     return " ".join(input_text.split())
+
+    # def save(self, *args, **kwargs):
+    #     license = super().save(*args, **kwargs)
+    #     self.handle_input(license)
+    #     return license
+
+    # class Media:
+    #     js = ("add-inputs.js",)
+
+    # def handle_inputs(self, project):
+    #     input_file = self.files.getlist("input_files")
+    #     input_text = self.cleaned_data.get("input_text")
+    #     print(input_text)
+    #     if input_file:
+    #         license.add_uploads(input_file)
+    #     elif input_text:
+    #         license.add_license(input_text)
+
+    # input_files = 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,35 @@
+{% 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,107 @@
+{% extends 'scanpipe/base.html' %}
+{% load static humanize %}
+
+
+{% block extrahead %}
+  <link rel="stylesheet" href="{% static 'billboard-3.0.1-datalab.min.css' %}" crossorigin="anonymous" />
+{% endblock %}
+
+{% 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 pt-0">
+      <div class="is-flex is-justify-content-space-between 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">
+        <div class="column is-half">
+          <p class="title is-4">Input License Text</p>
+           <div class="box">
+             {% for line in text %}
+              <p>{{line}}</p>
+             {% endfor %}
+           </div>
+        </div>
+        <div class="column is-half">
+          <p class="title is-4">Detected License Errors</p>
+
+          {% for license in expr.licenses %}
+
+          <div class="card">
+            <div class="card-header">
+              <div class="card-header-title">
+                  <a class="" href="{{license.homepage_url}}" title="{{license.short_name}}">{{license.name| center:"15"}}</a>
+                  <p class="tag is-6 mx-1 is-light 
+                  {% if license.score == 100 %}
+                  is-success
+                  {% else %}
+                  is-warning
+                  {% endif %}
+                  ">{{license.score}}</p>
+                  <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>
+                  <p class="tag is-6 mx-1 is-light is-primary">{{license.category}}</p>
+              </div>
+              <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>
+          {% if license.score < 100 %}
+          <div class="card-content">
+              <p class="subtitle is-5">Recommended License</p>
+              <p class="content">{{license}}</p>
+          </div>
+          {% endif %}
+        </div>
+        <br>
+          {% endfor %}
+      </div>
+    </div>
+</div>
+{% endblock %}
+
+{% block scripts %}
+<script type="text/javascript">
+const cards = document.querySelectorAll('.card')
+
+// const cardsicons = document.querySelectorAll('.card-header-icon')
+// cardsicons.forEach(icon => {
+//   icon.addEventListener('click', (e, index) => {
+//     e.preventDefault();
+//     removeActiveCards();
+//     console.log(e)
+//     console.log(index)
+//     icon.parentNode.parentNode.parentNode.querySelector('.card-content').style.display="visible"
+//   })
+// })
+
+// function removeActiveCards() {
+//     cards.forEach(card => {
+//         card.parentNode.parentNode.parentNode.querySelector('.card-content').style.display="none"
+//     })
+// }
+</script>
+{% endblock %}