Commit | Line | Data |
---|---|---|
3e0c0365 DC |
1 | ;;; GNU Guix --- Functional package management for GNU |
2 | ;;; Copyright © 2016 David Craven <david@craven.ch> | |
1327ec82 | 3 | ;;; Copyright © 2019, 2020, 2021 Ludovic Courtès <ludo@gnu.org> |
269c1db4 | 4 | ;;; Copyright © 2019, 2020 Martin Becze <mjbecze@riseup.net> |
ab512c21 | 5 | ;;; Copyright © 2021 Nicolas Goaziou <mail@nicolasgoaziou.fr> |
3e0c0365 DC |
6 | ;;; |
7 | ;;; This file is part of GNU Guix. | |
8 | ;;; | |
9 | ;;; GNU Guix is free software; you can redistribute it and/or modify it | |
10 | ;;; under the terms of the GNU General Public License as published by | |
11 | ;;; the Free Software Foundation; either version 3 of the License, or (at | |
12 | ;;; your option) any later version. | |
13 | ;;; | |
14 | ;;; GNU Guix is distributed in the hope that it will be useful, but | |
15 | ;;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | ;;; GNU General Public License for more details. | |
18 | ;;; | |
19 | ;;; You should have received a copy of the GNU General Public License | |
20 | ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>. | |
21 | ||
22 | (define-module (guix import crate) | |
23 | #:use-module (guix base32) | |
24 | #:use-module (guix build-system cargo) | |
25 | #:use-module ((guix download) #:prefix download:) | |
ca719424 | 26 | #:use-module (gcrypt hash) |
3e0c0365 DC |
27 | #:use-module (guix http-client) |
28 | #:use-module (guix import json) | |
29 | #:use-module (guix import utils) | |
30 | #:use-module ((guix licenses) #:prefix license:) | |
d9feb23e | 31 | #:use-module (guix memoization) |
3e0c0365 DC |
32 | #:use-module (guix monads) |
33 | #:use-module (guix packages) | |
34 | #:use-module (guix upstream) | |
35 | #:use-module (guix utils) | |
054e308f | 36 | #:use-module (gnu packages) |
3e0c0365 | 37 | #:use-module (ice-9 match) |
191668bc | 38 | #:use-module (ice-9 regex) |
3e0c0365 DC |
39 | #:use-module (json) |
40 | #:use-module (srfi srfi-1) | |
41 | #:use-module (srfi srfi-2) | |
42 | #:use-module (srfi srfi-26) | |
269c1db4 | 43 | #:use-module (srfi srfi-71) |
3e0c0365 | 44 | #:export (crate->guix-package |
8ac52987 | 45 | guix-package->crate-name |
72c678af | 46 | string->license |
f8372932 | 47 | crate-recursive-import |
8ac52987 | 48 | %crate-updater)) |
3e0c0365 | 49 | |
2791870d LC |
50 | \f |
51 | ;;; | |
52 | ;;; Interface to https://crates.io/api/v1. | |
53 | ;;; | |
3e0c0365 | 54 | |
2791870d LC |
55 | ;; Crates. A crate is essentially a "package". It can have several |
56 | ;; "versions", each of which has its own set of dependencies, license, | |
57 | ;; etc.--see <crate-version> below. | |
58 | (define-json-mapping <crate> make-crate crate? | |
59 | json->crate | |
60 | (name crate-name) ;string | |
61 | (latest-version crate-latest-version "max_version") ;string | |
62 | (home-page crate-home-page "homepage") ;string | #nil | |
63 | (repository crate-repository) ;string | |
64 | (description crate-description) ;string | |
65 | (keywords crate-keywords ;list of strings | |
66 | "keywords" vector->list) | |
67 | (categories crate-categories ;list of strings | |
68 | "categories" vector->list) | |
69 | (versions crate-versions "actual_versions" ;list of <crate-version> | |
70 | (lambda (vector) | |
71 | (map json->crate-version | |
72 | (vector->list vector)))) | |
73 | (links crate-links)) ;alist | |
3e0c0365 | 74 | |
2791870d LC |
75 | ;; Crate version. |
76 | (define-json-mapping <crate-version> make-crate-version crate-version? | |
77 | json->crate-version | |
78 | (id crate-version-id) ;integer | |
79 | (number crate-version-number "num") ;string | |
80 | (download-path crate-version-download-path "dl_path") ;string | |
81 | (readme-path crate-version-readme-path "readme_path") ;string | |
1327ec82 LC |
82 | (license crate-version-license "license" ;string | #f |
83 | (match-lambda | |
84 | ('null #f) | |
85 | ((? string? str) str))) | |
2791870d LC |
86 | (links crate-version-links)) ;alist |
87 | ||
88 | ;; Crate dependency. Each dependency (each edge in the graph) is annotated as | |
89 | ;; being a "normal" dependency or a development dependency. There also | |
90 | ;; information about the minimum required version, such as "^0.0.41". | |
91 | (define-json-mapping <crate-dependency> make-crate-dependency | |
92 | crate-dependency? | |
93 | json->crate-dependency | |
94 | (id crate-dependency-id "crate_id") ;string | |
269c1db4 | 95 | (kind crate-dependency-kind "kind" ;'normal | 'dev | 'build |
2791870d LC |
96 | string->symbol) |
97 | (requirement crate-dependency-requirement "req")) ;string | |
98 | ||
e3065ec1 | 99 | ;; Autoload Guile-Semver so we only have a soft dependency. |
269c1db4 | 100 | (module-autoload! (current-module) |
054e308f | 101 | '(semver) '(string->semver semver->string semver<?)) |
269c1db4 MB |
102 | (module-autoload! (current-module) |
103 | '(semver ranges) '(string->semver-range semver-range-contains?)) | |
104 | ||
2791870d LC |
105 | (define (lookup-crate name) |
106 | "Look up NAME on https://crates.io and return the corresopnding <crate> | |
107 | record or #f if it was not found." | |
108 | (let ((json (json-fetch (string-append (%crate-base-url) "/api/v1/crates/" | |
109 | name)))) | |
110 | (and=> (and json (assoc-ref json "crate")) | |
111 | (lambda (alist) | |
112 | ;; The "versions" field of ALIST is simply a list of version IDs | |
113 | ;; (integers). Here, we squeeze in the actual version | |
114 | ;; dictionaries that are not part of ALIST but are just more | |
115 | ;; convenient handled this way. | |
116 | (let ((versions (or (assoc-ref json "versions") '#()))) | |
117 | (json->crate `(,@alist | |
118 | ("actual_versions" . ,versions)))))))) | |
119 | ||
d9feb23e MB |
120 | (define lookup-crate* (memoize lookup-crate)) |
121 | ||
2791870d LC |
122 | (define (crate-version-dependencies version) |
123 | "Return the list of <crate-dependency> records of VERSION, a | |
124 | <crate-version>." | |
125 | (let* ((path (assoc-ref (crate-version-links version) "dependencies")) | |
126 | (url (string-append (%crate-base-url) path))) | |
127 | (match (assoc-ref (or (json-fetch url) '()) "dependencies") | |
128 | ((? vector? vector) | |
cf2b91aa | 129 | (delete-duplicates (map json->crate-dependency (vector->list vector)))) |
2791870d LC |
130 | (_ |
131 | '())))) | |
3e0c0365 | 132 | |
2791870d LC |
133 | \f |
134 | ;;; | |
135 | ;;; Converting crates to Guix packages. | |
136 | ;;; | |
3e0c0365 | 137 | |
5a9ef8a9 IP |
138 | (define (maybe-cargo-inputs package-names) |
139 | (match (package-names->package-inputs package-names) | |
140 | (() | |
141 | '()) | |
142 | ((package-inputs ...) | |
022288ba | 143 | `(#:cargo-inputs ,package-inputs)))) |
5a9ef8a9 IP |
144 | |
145 | (define (maybe-cargo-development-inputs package-names) | |
146 | (match (package-names->package-inputs package-names) | |
147 | (() | |
148 | '()) | |
149 | ((package-inputs ...) | |
022288ba | 150 | `(#:cargo-development-inputs ,package-inputs)))) |
5a9ef8a9 IP |
151 | |
152 | (define (maybe-arguments arguments) | |
153 | (match arguments | |
154 | (() | |
155 | '()) | |
156 | ((args ...) | |
157 | `((arguments (,'quasiquote ,args)))))) | |
158 | ||
45584061 HG |
159 | (define (version->semver-prefix version) |
160 | "Return the version up to and including the first non-zero part" | |
161 | (first | |
162 | (map match:substring | |
163 | (list-matches "^(0+\\.){,2}[0-9]+" version)))) | |
164 | ||
5a9ef8a9 | 165 | (define* (make-crate-sexp #:key name version cargo-inputs cargo-development-inputs |
50fbb3f0 | 166 | home-page synopsis description license build?) |
3e0c0365 | 167 | "Return the `package' s-expression for a rust package with the given NAME, |
5a9ef8a9 IP |
168 | VERSION, CARGO-INPUTS, CARGO-DEVELOPMENT-INPUTS, HOME-PAGE, SYNOPSIS, DESCRIPTION, |
169 | and LICENSE." | |
269c1db4 MB |
170 | (define (format-inputs inputs) |
171 | (map | |
172 | (match-lambda | |
173 | ((name version) | |
9a48e35b | 174 | (list (crate-name->package-name name) |
45584061 | 175 | (version->semver-prefix version)))) |
269c1db4 MB |
176 | inputs)) |
177 | ||
3e0c0365 DC |
178 | (let* ((port (http-fetch (crate-uri name version))) |
179 | (guix-name (crate-name->package-name name)) | |
269c1db4 MB |
180 | (cargo-inputs (format-inputs cargo-inputs)) |
181 | (cargo-development-inputs (format-inputs cargo-development-inputs)) | |
3e0c0365 DC |
182 | (pkg `(package |
183 | (name ,guix-name) | |
184 | (version ,version) | |
185 | (source (origin | |
186 | (method url-fetch) | |
187 | (uri (crate-uri ,name version)) | |
188 | (file-name (string-append name "-" version ".tar.gz")) | |
189 | (sha256 | |
190 | (base32 | |
191 | ,(bytevector->nix-base32-string (port-sha256 port)))))) | |
192 | (build-system cargo-build-system) | |
50fbb3f0 MB |
193 | ,@(maybe-arguments (append (if build? |
194 | '() | |
195 | '(#:skip-build? #t)) | |
269c1db4 | 196 | (maybe-cargo-inputs cargo-inputs) |
5a9ef8a9 IP |
197 | (maybe-cargo-development-inputs |
198 | cargo-development-inputs))) | |
ab512c21 | 199 | (home-page ,home-page) |
3e0c0365 DC |
200 | (synopsis ,synopsis) |
201 | (description ,(beautify-description description)) | |
202 | (license ,(match license | |
203 | (() #f) | |
1327ec82 | 204 | (#f #f) |
3e0c0365 DC |
205 | ((license) license) |
206 | (_ `(list ,@license))))))) | |
207 | (close-port port) | |
45584061 | 208 | (package->definition pkg (version->semver-prefix version)))) |
3e0c0365 | 209 | |
263a267b BW |
210 | (define (string->license string) |
211 | (filter-map (lambda (license) | |
212 | (and (not (string-null? license)) | |
213 | (not (any (lambda (elem) (string=? elem license)) | |
214 | '("AND" "OR" "WITH"))) | |
215 | (or (spdx-string->license license) | |
216 | 'unknown-license!))) | |
217 | (string-split string (string->char-set " /")))) | |
191668bc | 218 | |
50fbb3f0 | 219 | (define* (crate->guix-package crate-name #:key version include-dev-deps? repo) |
3e0c0365 | 220 | "Fetch the metadata for CRATE-NAME from crates.io, and return the |
fd63ecbe | 221 | `package' s-expression corresponding to that package, or #f on failure. |
269c1db4 MB |
222 | When VERSION is specified, convert it into a semver range and attempt to fetch |
223 | the latest version matching this semver range; otherwise fetch the latest | |
50fbb3f0 MB |
224 | version of CRATE-NAME. If INCLUDE-DEV-DEPS is true then this will also |
225 | look up the development dependencs for the given crate." | |
269c1db4 MB |
226 | |
227 | (define (semver-range-contains-string? range version) | |
228 | (semver-range-contains? (string->semver-range range) | |
229 | (string->semver version))) | |
2791870d LC |
230 | |
231 | (define (normal-dependency? dependency) | |
269c1db4 MB |
232 | (or (eq? (crate-dependency-kind dependency) 'build) |
233 | (eq? (crate-dependency-kind dependency) 'normal))) | |
2791870d LC |
234 | |
235 | (define crate | |
d9feb23e | 236 | (lookup-crate* crate-name)) |
2791870d | 237 | |
fd63ecbe | 238 | (define version-number |
5fbc753a LC |
239 | (and crate |
240 | (or version | |
241 | (crate-latest-version crate)))) | |
fd63ecbe | 242 | |
054e308f HG |
243 | ;; find the highest existing package that fulfills the semver <range> |
244 | (define (find-package-version name range) | |
245 | (let* ((semver-range (string->semver-range range)) | |
246 | (versions | |
247 | (sort | |
248 | (filter (lambda (version) | |
249 | (semver-range-contains? semver-range version)) | |
250 | (map (lambda (pkg) | |
251 | (string->semver (package-version pkg))) | |
252 | (find-packages-by-name | |
253 | (crate-name->package-name name)))) | |
254 | semver<?))) | |
255 | (and (not (null-list? versions)) | |
256 | (semver->string (last versions))))) | |
257 | ||
269c1db4 MB |
258 | ;; find the highest version of a crate that fulfills the semver <range> |
259 | (define (find-crate-version crate range) | |
260 | (let* ((semver-range (string->semver-range range)) | |
261 | (versions | |
262 | (sort | |
263 | (filter (lambda (entry) | |
264 | (semver-range-contains? semver-range (first entry))) | |
265 | (map (lambda (ver) | |
266 | (list (string->semver (crate-version-number ver)) | |
267 | ver)) | |
268 | (crate-versions crate))) | |
269 | (match-lambda* (((semver _) ...) | |
270 | (apply semver<? semver)))))) | |
271 | (and (not (null-list? versions)) | |
272 | (second (last versions))))) | |
273 | ||
054e308f HG |
274 | (define (dependency-name+version dep) |
275 | (let* ((name (crate-dependency-id dep)) | |
276 | (req (crate-dependency-requirement dep)) | |
277 | (existing-version (find-package-version name req))) | |
278 | (if existing-version | |
279 | (list name existing-version) | |
280 | (let* ((crate (lookup-crate* name)) | |
281 | (ver (find-crate-version crate req))) | |
282 | (list name | |
283 | (crate-version-number ver)))))) | |
284 | ||
fd63ecbe | 285 | (define version* |
5fbc753a | 286 | (and crate |
269c1db4 MB |
287 | (find-crate-version crate version-number))) |
288 | ||
289 | ;; sort and map the dependencies to a list containing | |
290 | ;; pairs of (name version) | |
291 | (define (sort-map-dependencies deps) | |
054e308f | 292 | (sort (map dependency-name+version |
269c1db4 MB |
293 | deps) |
294 | (match-lambda* (((name _) ...) | |
295 | (apply string-ci<? name))))) | |
fd63ecbe MB |
296 | |
297 | (and crate version* | |
269c1db4 MB |
298 | (let* ((dependencies (crate-version-dependencies version*)) |
299 | (dep-crates dev-dep-crates (partition normal-dependency? dependencies)) | |
300 | (cargo-inputs (sort-map-dependencies dep-crates)) | |
50fbb3f0 MB |
301 | (cargo-development-inputs (if include-dev-deps? |
302 | (sort-map-dependencies dev-dep-crates) | |
303 | '()))) | |
f8372932 | 304 | (values |
50fbb3f0 MB |
305 | (make-crate-sexp #:build? include-dev-deps? |
306 | #:name crate-name | |
f8372932 MB |
307 | #:version (crate-version-number version*) |
308 | #:cargo-inputs cargo-inputs | |
309 | #:cargo-development-inputs cargo-development-inputs | |
ab512c21 NG |
310 | #:home-page |
311 | (let ((home-page (crate-home-page crate))) | |
312 | (if (string? home-page) | |
313 | home-page | |
314 | (let ((repository (crate-repository crate))) | |
315 | (if (string? repository) | |
316 | repository | |
317 | "")))) | |
f8372932 MB |
318 | #:synopsis (crate-description crate) |
319 | #:description (crate-description crate) | |
320 | #:license (and=> (crate-version-license version*) | |
321 | string->license)) | |
322 | (append cargo-inputs cargo-development-inputs))))) | |
323 | ||
bea3b177 MB |
324 | (define* (crate-recursive-import crate-name #:key version) |
325 | (recursive-import crate-name | |
50fbb3f0 MB |
326 | #:repo->guix-package (lambda* params |
327 | ;; download development dependencies only for the top level package | |
328 | (let ((include-dev-deps? (equal? (car params) crate-name)) | |
329 | (crate->guix-package* (memoize crate->guix-package))) | |
330 | (apply crate->guix-package* | |
331 | (append params `(#:include-dev-deps? ,include-dev-deps?))))) | |
bea3b177 | 332 | #:version version |
f8372932 | 333 | #:guix-name crate-name->package-name)) |
3e0c0365 DC |
334 | |
335 | (define (guix-package->crate-name package) | |
336 | "Return the crate name of PACKAGE." | |
337 | (and-let* ((origin (package-source package)) | |
338 | (uri (origin-uri origin)) | |
339 | (crate-url? uri) | |
340 | (len (string-length crate-url)) | |
341 | (path (xsubstring uri len)) | |
342 | (parts (string-split path #\/))) | |
343 | (match parts | |
344 | ((name _ ...) name)))) | |
345 | ||
346 | (define (crate-name->package-name name) | |
269c1db4 | 347 | (guix-name "rust-" name)) |
3e0c0365 | 348 | |
2791870d | 349 | \f |
8ac52987 DC |
350 | ;;; |
351 | ;;; Updater | |
352 | ;;; | |
353 | ||
00290e73 LC |
354 | (define crate-package? |
355 | (url-predicate crate-url?)) | |
8ac52987 DC |
356 | |
357 | (define (latest-release package) | |
358 | "Return an <upstream-source> for the latest release of PACKAGE." | |
359 | (let* ((crate-name (guix-package->crate-name package)) | |
2791870d LC |
360 | (crate (lookup-crate crate-name)) |
361 | (version (crate-latest-version crate)) | |
362 | (url (crate-uri crate-name version))) | |
8ac52987 DC |
363 | (upstream-source |
364 | (package (package-name package)) | |
365 | (version version) | |
366 | (urls (list url))))) | |
367 | ||
368 | (define %crate-updater | |
369 | (upstream-updater | |
5420db32 | 370 | (name 'crate) |
8ac52987 DC |
371 | (description "Updater for crates.io packages") |
372 | (pred crate-package?) | |
373 | (latest latest-release))) | |
374 |