File size: 10,529 Bytes
d1ceb73 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
"""Manager and Tornado handlers for license reporting."""
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
from __future__ import annotations
import asyncio
import csv
import io
import json
import mimetypes
import re
from concurrent.futures import ThreadPoolExecutor
from pathlib import Path
from typing import TYPE_CHECKING, Any
from jupyter_server.base.handlers import APIHandler
from tornado import web
from traitlets import List, Unicode
from traitlets.config import LoggingConfigurable
from .config import get_federated_extensions
# this is duplicated in @juptyerlab/builder
DEFAULT_THIRD_PARTY_LICENSE_FILE = "third-party-licenses.json"
UNKNOWN_PACKAGE_NAME = "UNKNOWN"
if mimetypes.guess_extension("text/markdown") is None: # pragma: no cover
# for python <3.8 https://bugs.python.org/issue39324
mimetypes.add_type("text/markdown", ".md")
class LicensesManager(LoggingConfigurable):
"""A manager for listing the licenses for all frontend end code distributed
by an application and any federated extensions
"""
executor = ThreadPoolExecutor(max_workers=1)
third_party_licenses_files = List(
Unicode(),
default_value=[
DEFAULT_THIRD_PARTY_LICENSE_FILE,
f"static/{DEFAULT_THIRD_PARTY_LICENSE_FILE}",
],
help="the license report data in built app and federated extensions",
)
@property
def federated_extensions(self) -> dict[str, Any]:
"""Lazily load the currrently-available federated extensions.
This is expensive, but probably the only way to be sure to get
up-to-date license information for extensions installed interactively.
"""
if TYPE_CHECKING:
from .app import LabServerApp
assert isinstance(self.parent, LabServerApp)
per_paths = [
self.parent.labextensions_path,
self.parent.extra_labextensions_path,
]
labextensions_path = [extension for extensions in per_paths for extension in extensions]
return get_federated_extensions(labextensions_path)
async def report_async(
self, report_format: str = "markdown", bundles_pattern: str = ".*", full_text: bool = False
) -> tuple[str, str]:
"""Asynchronous wrapper around the potentially slow job of locating
and encoding all of the licenses
"""
return await asyncio.wrap_future(
self.executor.submit(
self.report,
report_format=report_format,
bundles_pattern=bundles_pattern,
full_text=full_text,
)
)
def report(self, report_format: str, bundles_pattern: str, full_text: bool) -> tuple[str, str]:
"""create a human- or machine-readable report"""
bundles = self.bundles(bundles_pattern=bundles_pattern)
if report_format == "json":
return self.report_json(bundles), "application/json"
if report_format == "csv":
return self.report_csv(bundles), "text/csv"
if report_format == "markdown":
return (
self.report_markdown(bundles, full_text=full_text),
"text/markdown",
)
msg = f"Unsupported report format {report_format}."
raise ValueError(msg)
def report_json(self, bundles: dict[str, Any]) -> str:
"""create a JSON report
TODO: SPDX
"""
return json.dumps({"bundles": bundles}, indent=2, sort_keys=True)
def report_csv(self, bundles: dict[str, Any]) -> str:
"""create a CSV report"""
outfile = io.StringIO()
fieldnames = ["name", "versionInfo", "licenseId", "extractedText"]
writer = csv.DictWriter(outfile, fieldnames=["bundle", *fieldnames])
writer.writeheader()
for bundle_name, bundle in bundles.items():
for package in bundle["packages"]:
writer.writerow(
{
"bundle": bundle_name,
**{field: package.get(field, "") for field in fieldnames},
}
)
return outfile.getvalue()
def report_markdown(self, bundles: dict[str, Any], full_text: bool = True) -> str:
"""create a markdown report"""
lines = []
library_names = [
len(package.get("name", UNKNOWN_PACKAGE_NAME))
for bundle_name, bundle in bundles.items()
for package in bundle.get("packages", [])
]
longest_name = max(library_names) if library_names else 1
for bundle_name, bundle in bundles.items():
# TODO: parametrize template
lines += [f"# {bundle_name}", ""]
packages = bundle.get("packages", [])
if not packages:
lines += ["> No licenses found", ""]
continue
for package in packages:
name = package.get("name", UNKNOWN_PACKAGE_NAME).strip()
version_info = package.get("versionInfo", UNKNOWN_PACKAGE_NAME).strip()
license_id = package.get("licenseId", UNKNOWN_PACKAGE_NAME).strip()
extracted_text = package.get("extractedText", "")
lines += [
"## "
+ (
"\t".join(
[
f"""**{name}**""".ljust(longest_name),
f"""`{version_info}`""".ljust(20),
license_id,
]
)
)
]
if full_text:
if not extracted_text:
lines += ["", "> No license text available", ""]
else:
lines += ["", "", "<pre/>", extracted_text, "</pre>", ""]
return "\n".join(lines)
def license_bundle(self, path: Path, bundle: str | None) -> dict[str, Any]:
"""Return the content of a packages's license bundles"""
bundle_json: dict = {"packages": []}
checked_paths = []
for license_file in self.third_party_licenses_files:
licenses_path = path / license_file
self.log.debug("Loading licenses from %s", licenses_path)
if not licenses_path.exists():
checked_paths += [licenses_path]
continue
try:
file_json = json.loads(licenses_path.read_text(encoding="utf-8"))
except Exception as err:
self.log.warning(
"Failed to open third-party licenses for %s: %s\n%s",
bundle,
licenses_path,
err,
)
continue
try:
bundle_json["packages"].extend(file_json["packages"])
except Exception as err:
self.log.warning(
"Failed to find packages for %s: %s\n%s",
bundle,
licenses_path,
err,
)
continue
if not bundle_json["packages"]:
self.log.warning("Third-party licenses not found for %s: %s", bundle, checked_paths)
return bundle_json
def app_static_info(self) -> tuple[Path | None, str | None]:
"""get the static directory for this app
This will usually be in `static_dir`, but may also appear in the
parent of `static_dir`.
"""
if TYPE_CHECKING:
from .app import LabServerApp
assert isinstance(self.parent, LabServerApp)
path = Path(self.parent.static_dir)
package_json = path / "package.json"
if not package_json.exists():
parent_package_json = path.parent / "package.json"
if parent_package_json.exists():
package_json = parent_package_json
else:
return None, None
name = json.loads(package_json.read_text(encoding="utf-8"))["name"]
return path, name
def bundles(self, bundles_pattern: str = ".*") -> dict[str, Any]:
"""Read all of the licenses
TODO: schema
"""
bundles = {
name: self.license_bundle(Path(ext["ext_path"]), name)
for name, ext in self.federated_extensions.items()
if re.match(bundles_pattern, name)
}
app_path, app_name = self.app_static_info()
if app_path is not None:
assert app_name is not None
if re.match(bundles_pattern, app_name):
bundles[app_name] = self.license_bundle(app_path, app_name)
if not bundles:
self.log.warning("No license bundles found at all")
return bundles
class LicensesHandler(APIHandler):
"""A handler for serving licenses used by the application"""
def initialize(self, manager: LicensesManager) -> None:
"""Initialize the handler."""
super().initialize()
self.manager = manager
@web.authenticated
async def get(self, _args: Any) -> None:
"""Return all the frontend licenses"""
full_text = bool(json.loads(self.get_argument("full_text", "true")))
report_format = self.get_argument("format", "json")
bundles_pattern = self.get_argument("bundles", ".*")
download = bool(json.loads(self.get_argument("download", "0")))
report, mime = await self.manager.report_async(
report_format=report_format,
bundles_pattern=bundles_pattern,
full_text=full_text,
)
if TYPE_CHECKING:
from .app import LabServerApp
assert isinstance(self.manager.parent, LabServerApp)
if download:
filename = "{}-licenses{}".format(
self.manager.parent.app_name.lower(), mimetypes.guess_extension(mime)
)
self.set_attachment_header(filename)
self.write(report)
await self.finish(_mime_type=mime)
async def finish( # type:ignore[override]
self, _mime_type: str, *args: Any, **kwargs: Any
) -> Any:
"""Overload the regular finish, which (sensibly) always sets JSON"""
self.update_api_activity()
self.set_header("Content-Type", _mime_type)
return await super(APIHandler, self).finish(*args, **kwargs)
|