Skip to content

Commit 3ee2d3e

Browse files
Support rust makepkg’s .SRCINFO files
1 parent 05a98f6 commit 3ee2d3e

11 files changed

Lines changed: 361 additions & 0 deletions

File tree

‎src/packagedcode/__init__.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
from packagedcode import readme
3838
from packagedcode import rpm
3939
from packagedcode import rubygems
40+
from packagedcode import srcinfo
4041
from packagedcode import swift
4142
from packagedcode import win_pe
4243
from packagedcode import windows
@@ -191,6 +192,8 @@
191192
rubygems.GemMetadataArchiveExtractedHandler,
192193
rubygems.GemArchiveHandler,
193194

195+
srcinfo.SrcinfoHandler,
196+
194197
# the order of these handlers matter
195198
rubygems.GemfileInExtractedGemHandler,
196199
rubygems.GemfileHandler,

‎src/packagedcode/srcinfo.py‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
#
2+
# Copyright (c) nexB Inc. and others. All rights reserved.
3+
# ScanCode is a trademark of nexB Inc.
4+
# SPDX-License-Identifier: Apache-2.0
5+
#
6+
7+
import logging
8+
import re
9+
10+
from packageurl import PackageURL
11+
12+
from packagedcode import models
13+
14+
15+
logger = logging.getLogger(__name__)
16+
17+
ARCHITECTURE_FIELDS = {
18+
"checkdepends",
19+
"conflicts",
20+
"depends",
21+
"makedepends",
22+
"optdepends",
23+
"provides",
24+
"replaces",
25+
"source",
26+
}
27+
ARCHITECTURE_SUFFIX = re.compile(
28+
r"^(?P<field>[a-z][a-z0-9]*)_(?P<architecture>[a-z0-9][a-z0-9_]*)$"
29+
)
30+
DEPENDENCY_FIELDS = (
31+
("depends", "depends", True, False),
32+
("makedepends", "makedepends", False, False),
33+
("checkdepends", "checkdepends", False, False),
34+
("optdepends", "optdepends", True, True),
35+
)
36+
37+
38+
class SrcinfoHandler(models.DatafileHandler):
39+
"""
40+
Parse Arch Linux makepkg ``.SRCINFO`` package metadata.
41+
"""
42+
43+
datasource_id = "arch_srcinfo"
44+
path_patterns = ("*.SRCINFO", "*/.SRCINFO")
45+
default_package_type = "arch"
46+
default_primary_language = None
47+
description = "Arch Linux .SRCINFO package metadata"
48+
documentation_url = "https://wiki.archlinux.org/title/.SRCINFO"
49+
50+
@classmethod
51+
def parse(cls, location, package_only=False):
52+
with open(location, encoding="utf-8") as srcinfo_file:
53+
sections = cls._parse(srcinfo_file)
54+
55+
if not sections:
56+
return
57+
58+
base = sections[0]
59+
package_sections = sections[1:] or [base]
60+
for package_section in package_sections:
61+
data = dict(base)
62+
data.update(package_section)
63+
package_name = data.get("pkgname") or data.get("pkgbase")
64+
if not package_name:
65+
logger.warning("No package name found in .SRCINFO: %s", location)
66+
continue
67+
yield cls._to_package_data(data, package_only)
68+
69+
@staticmethod
70+
def _add_value(section, key, value):
71+
existing = section.get(key)
72+
if existing is None:
73+
section[key] = value
74+
elif isinstance(existing, list):
75+
existing.append(value)
76+
else:
77+
section[key] = [existing, value]
78+
79+
@classmethod
80+
def _parse(cls, file_object):
81+
base = None
82+
packages = []
83+
current = None
84+
85+
for line_number, line in enumerate(file_object, 1):
86+
line = line.strip()
87+
if not line or line.startswith("#"):
88+
continue
89+
if "=" not in line:
90+
logger.debug("Ignoring invalid .SRCINFO line %d: %s", line_number, line)
91+
continue
92+
93+
key, value = (part.strip() for part in line.split("=", 1))
94+
if key == "pkgbase":
95+
base = {"pkgbase": value}
96+
current = base
97+
continue
98+
if current is None:
99+
logger.debug("Ignoring .SRCINFO field before pkgbase on line %d", line_number)
100+
continue
101+
if key == "pkgname":
102+
current = {"pkgbase": base.get("pkgbase"), "pkgname": value}
103+
packages.append(current)
104+
continue
105+
106+
match = ARCHITECTURE_SUFFIX.match(key)
107+
if match and match.group("field") in ARCHITECTURE_FIELDS:
108+
key = match.group("field")
109+
value = (value, match.group("architecture"))
110+
SrcinfoHandler._add_value(current, key, value)
111+
112+
if base is None:
113+
return []
114+
return [base, *packages]
115+
116+
@classmethod
117+
def _to_package_data(cls, data, package_only):
118+
package_name = data.get("pkgname") or data["pkgbase"]
119+
version = data.get("pkgver")
120+
if data.get("pkgrel"):
121+
version = f"{version}-{data['pkgrel']}" if version else data["pkgrel"]
122+
if data.get("epoch"):
123+
version = f"{data['epoch']}:{version}" if version else data["epoch"]
124+
125+
dependencies = []
126+
for field, scope, is_runtime, is_optional in DEPENDENCY_FIELDS:
127+
for requirement in cls._as_list(data.get(field)):
128+
architecture = None
129+
if isinstance(requirement, tuple):
130+
requirement, architecture = requirement
131+
dependency_name = re.split(r"[<>=:]", requirement, maxsplit=1)[0].strip()
132+
if not dependency_name:
133+
continue
134+
dependencies.append(
135+
models.DependentPackage(
136+
purl=PackageURL(type="arch", name=dependency_name).to_string(),
137+
extracted_requirement=requirement,
138+
scope=f"{scope}_{architecture}" if architecture else scope,
139+
is_runtime=is_runtime,
140+
is_optional=is_optional,
141+
)
142+
)
143+
144+
extra_data = {}
145+
for field in (
146+
"arch",
147+
"source",
148+
"md5sums",
149+
"sha1sums",
150+
"sha256sums",
151+
"sha512sums",
152+
"conflicts",
153+
"provides",
154+
"replaces",
155+
):
156+
values = cls._as_list(data.get(field))
157+
if values:
158+
extra_data[field] = values
159+
160+
extracted_license_statement = cls._join_values(data.get("license"))
161+
package_data = {
162+
"datasource_id": cls.datasource_id,
163+
"type": cls.default_package_type,
164+
"name": package_name,
165+
"version": version,
166+
"description": data.get("pkgdesc"),
167+
"homepage_url": data.get("url"),
168+
"extracted_license_statement": extracted_license_statement,
169+
"dependencies": dependencies,
170+
"extra_data": extra_data,
171+
}
172+
if extracted_license_statement and cls._is_custom_license(extracted_license_statement):
173+
package_data["declared_license_expression"] = "unknown-license-reference"
174+
return models.PackageData.from_data(package_data, package_only=package_only)
175+
176+
@staticmethod
177+
def _as_list(value):
178+
if value is None:
179+
return []
180+
return value if isinstance(value, list) else [value]
181+
182+
@staticmethod
183+
def _join_values(value):
184+
values = SrcinfoHandler._as_list(value)
185+
return " AND ".join(item if isinstance(item, str) else item[0] for item in values) or None
186+
187+
@staticmethod
188+
def _is_custom_license(license_statement):
189+
return all(
190+
value.strip().lower().startswith("custom") for value in license_statement.split(" AND ")
191+
)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
pkgbase = rust-multiarch
2+
pkgdesc = Multi-architecture Rust package
3+
pkgver = 1.5.0
4+
pkgrel = 2
5+
arch = x86_64
6+
arch = aarch64
7+
license = GPL
8+
depends = glibc
9+
depends_x86_64 = lib32-glibc
10+
depends_aarch64 = aarch64-specific-lib
11+
makedepends = rust
12+
source = source.tar.gz
13+
sha256sums = SKIP
14+
15+
pkgname = rust-multiarch
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
pkgbase = example
2+
pkgver = 1.2.3
3+
pkgrel = 1
4+
pkgdesc = An example Arch package
5+
url = https://example.test
6+
license = MIT
7+
source = https://example.test/example.tar.gz
8+
sha256sums = abc123
9+
depends = openssl
10+
depends_x86_64 = zlib
11+
makedepends = python
12+
optdepends = docs: documentation
13+
arch = x86_64
14+
pkgname = example
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pkgbase = custom-license-example
2+
pkgver = 1.0
3+
pkgrel = 1
4+
license = custom:vendor-license
5+
pkgname = custom-license-example
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
pkgbase = rust-basic
2+
pkgdesc = A basic Rust package
3+
pkgver = 1.0.0
4+
pkgrel = 1
5+
url = https://github.com/example/rust-basic
6+
arch = x86_64
7+
license = MIT
8+
makedepends = rust
9+
makedepends = cargo
10+
source = https://github.com/example/rust-basic/archive/1.0.0.tar.gz
11+
sha256sums = SKIP
12+
13+
pkgname = rust-basic
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
pkgbase = rust-split
2+
pkgdesc = Split package example
3+
pkgver = 1.0.0
4+
pkgrel = 1
5+
arch = x86_64
6+
license = MIT
7+
makedepends = rust
8+
source = source.tar.gz
9+
10+
pkgname = rust-split-bin
11+
pkgdesc = Binary package
12+
depends = glibc
13+
14+
pkgname = rust-split-lib
15+
pkgdesc = Library package
16+
depends = gcc-libs
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
pkgbase = example
2+
pkgver = 2.0
3+
pkgrel = 1
4+
pkgdesc = A split package
5+
license = Apache-2.0
6+
pkgname = example
7+
pkgname = example-tools
8+
depends = example
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
pkgbase = rust-checksums
2+
pkgdesc = Package with checksums
3+
pkgver = 1.0.0
4+
pkgrel = 1
5+
arch = x86_64
6+
license = MIT
7+
source = file1.tar.gz
8+
source = file2.tar.gz
9+
sha256sums = abc123def456
10+
sha256sums = 789ghi012jkl
11+
12+
pkgname = rust-checksums
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
pkgbase = rust-app
2+
pkgdesc = Rust application with dependencies
3+
pkgver = 2.0.0
4+
pkgrel = 1
5+
arch = x86_64
6+
arch = aarch64
7+
license = Apache
8+
depends = gcc-libs
9+
depends = glibc
10+
makedepends = rust
11+
makedepends = cargo
12+
optdepends = python: for scripts
13+
optdepends = bash: for shell completion
14+
source = rust-app-2.0.0.tar.gz
15+
md5sums = abc123
16+
17+
pkgname = rust-app

0 commit comments

Comments
 (0)