Add copyright holder field to PackageData model #3290

Signed-off-by: Keshav Priyadarshi <git@keshav.space>

Author: keshav-space

src/packagedcode/models.py

@@ -711,8 +711,34 @@ class PackageData(IdentifiablePackageData):
         repr=True,
     )
 
+    holder= String(
+    label='Holder',
+    help='Holder for this package. Typically one per line.')
+
     def __attrs_post_init__(self, *args, **kwargs):
         self.populate_license_fields()
+        self.populate_holder_field()
+
+    def populate_holder_field(self):
+        if self.copyright:
+            from cluecode.copyrights import CopyrightDetector
+
+            numbered_lines = [
+                (count, value) for count, value in enumerate(self.copyright.split("\n"), start=1)
+            ]
+            detector = CopyrightDetector()
+            holder_list = list(
+                detector.detect(
+                    numbered_lines,
+                    include_copyrights=False,
+                    include_holders=True,
+                    include_authors=False,
+                )
+            )
+            if holder_list:
+                self.holder = "\n".join(
+                    [holder_detection.holder for holder_detection in holder_list]
+                )
 
     def populate_license_fields(self):
         """

tests/licensedcode/data/licenses_reference_reporting/scan-matched-text-with-reference.expected.json

@@ -69,6 +69,7 @@
       "repository_homepage_url": "https://www.npmjs.com/package/npm",
       "repository_download_url": "https://registry.npmjs.org/npm/-/npm-2.13.5.tgz",
       "api_data_url": "https://registry.npmjs.org/npm/2.13.5",
+      "holder": null,
       "package_uid": "pkg:npm/npm@2.13.5?uuid=fixed-uid-done-for-testing-5642512d1758",
       "datafile_paths": [
         "scan/package.json"
@@ -522,6 +523,7 @@
           "repository_download_url": "https://registry.npmjs.org/npm/-/npm-2.13.5.tgz",
           "api_data_url": "https://registry.npmjs.org/npm/2.13.5",
           "datasource_id": "npm_package_json",
+          "holder": null,
           "purl": "pkg:npm/npm@2.13.5"
         }
       ],

tests/licensedcode/data/licenses_reference_reporting/scan-with-reference.expected.json

@@ -69,6 +69,7 @@
       "repository_homepage_url": "https://www.npmjs.com/package/npm",
       "repository_download_url": "https://registry.npmjs.org/npm/-/npm-2.13.5.tgz",
       "api_data_url": "https://registry.npmjs.org/npm/2.13.5",
+      "holder": null,
       "package_uid": "pkg:npm/npm@2.13.5?uuid=fixed-uid-done-for-testing-5642512d1758",
       "datafile_paths": [
         "scan/package.json"
@@ -516,6 +517,7 @@
           "repository_download_url": "https://registry.npmjs.org/npm/-/npm-2.13.5.tgz",
           "api_data_url": "https://registry.npmjs.org/npm/2.13.5",
           "datasource_id": "npm_package_json",
+          "holder": null,
           "purl": "pkg:npm/npm@2.13.5"
         }
       ],

tests/packagedcode/data/about/aboutfiles.expected.json

@@ -64,6 +64,7 @@
       "repository_homepage_url": null,
       "repository_download_url": null,
       "api_data_url": null,
+      "holder": "holger krekel",
       "package_uid": "pkg:about/apipkg@1.4?uuid=fixed-uid-done-for-testing-5642512d1758",
       "datafile_paths": [
         "aboutfiles/apipkg.ABOUT"
@@ -149,6 +150,7 @@
       "repository_homepage_url": null,
       "repository_download_url": null,
       "api_data_url": null,
+      "holder": "ActiveState Software Inc.",
       "package_uid": "pkg:about/appdirs@1.4.3?uuid=fixed-uid-done-for-testing-5642512d1758",
       "datafile_paths": [
         "aboutfiles/appdirs.ABOUT"
@@ -258,6 +260,7 @@
           "repository_download_url": null,
           "api_data_url": null,
           "datasource_id": "about_file",
+          "holder": "holger krekel",
           "purl": "pkg:about/apipkg@1.4"
         }
       ],
@@ -347,6 +350,7 @@
           "repository_download_url": null,
           "api_data_url": null,
           "datasource_id": "about_file",
+          "holder": "ActiveState Software Inc.",
           "purl": "pkg:about/appdirs@1.4.3"
         }
       ],

tests/packagedcode/data/about/apipkg.ABOUT-expected

@@ -76,6 +76,7 @@
     "repository_download_url": null,
     "api_data_url": null,
     "datasource_id": "about_file",
+    "holder": "holger krekel",
     "purl": "pkg:about/apipkg@1.4"
   }
 ]

tests/packagedcode/data/about/appdirs.ABOUT-expected

@@ -76,6 +76,7 @@
     "repository_download_url": null,
     "api_data_url": null,
     "datasource_id": "about_file",
+    "holder": "ActiveState Software Inc.",
     "purl": "pkg:about/appdirs@1.4.3"
   }
 ]

tests/packagedcode/data/alpine/alpine-container-layer.tar.xz-get-installed-expected.json

@@ -79,6 +79,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/alpine-baselayout-data@3.2.0-r22?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -287,6 +288,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/musl@1.2.3-r0?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -387,6 +389,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/busybox@1.35.0-r15?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -550,6 +553,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/alpine-baselayout@3.2.0-r22?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -902,6 +906,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/alpine-keys@2.4-r1?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -1191,6 +1196,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/ca-certificates-bundle@20211220-r0?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -1300,6 +1306,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/libcrypto1.1@1.1.1q-r0?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -1481,6 +1488,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/libssl1.1@1.1.1q-r0?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -1569,6 +1577,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/ssl_client@1.35.0-r15?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -1669,6 +1678,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/zlib@1.2.12-r1?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -1757,6 +1767,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/apk-tools@2.12.9-r3?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -1854,6 +1865,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/scanelf@1.3.4-r0?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -1942,6 +1954,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/musl-utils@1.2.3-r0?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"
@@ -2066,6 +2079,7 @@
     "repository_homepage_url": null,
     "repository_download_url": null,
     "api_data_url": null,
+    "holder": null,
     "package_uid": "pkg:alpine/libc-utils@0.7.2-r3?arch=x86_64&uuid=fixed-uid-done-for-testing-5642512d1758",
     "datafile_paths": [
       "alpine-container-layer.tar.xz/lib/apk/db/installed"