|
| 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 | + ) |
0 commit comments