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
|
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2014-2017, 2019, 2024 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2016 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2021 Xinglu Chen <public@yoctocell.xyz>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
(define-module (guix hg-download)
#:use-module (guix gexp)
#:use-module (guix store)
#:use-module (guix monads)
#:use-module (guix records)
#:use-module (guix modules)
#:use-module (guix packages)
#:use-module (srfi srfi-34)
#:use-module (srfi srfi-35)
#:use-module (ice-9 match)
#:use-module (ice-9 popen)
#:use-module (ice-9 rdelim)
#:export (hg-reference
hg-reference?
hg-reference-url
hg-reference-changeset
hg-predicate
hg-fetch
hg-version
hg-file-name))
;;; Commentary:
;;;
;;; An <origin> method that fetches a specific changeset from a Mercurial
;;; repository. The repository URL and changeset ID are specified with a
;;; <hg-reference> object.
;;;
;;; Code:
(define-record-type* <hg-reference>
hg-reference make-hg-reference
hg-reference?
(url hg-reference-url)
(changeset hg-reference-changeset))
(define (hg-package)
"Return the default Mercurial package."
(let ((distro (resolve-interface '(gnu packages version-control))))
(module-ref distro 'mercurial)))
(define* (hg-fetch ref hash-algo hash
#:optional name
#:key (system (%current-system)) (guile (default-guile))
(hg (hg-package)))
"Return a fixed-output derivation that fetches REF, a <hg-reference>
object. The output is expected to have recursive hash HASH of type
HASH-ALGO (a symbol). Use NAME as the file name, or a generic name if #f."
(define inputs
;; The 'swh-download' procedure requires tar and gzip.
`(("gzip" ,(module-ref (resolve-interface '(gnu packages compression))
'gzip))
("tar" ,(module-ref (resolve-interface '(gnu packages base))
'tar))))
(define guile-lzlib
(module-ref (resolve-interface '(gnu packages guile)) 'guile-lzlib))
(define guile-json
(module-ref (resolve-interface '(gnu packages guile)) 'guile-json-4))
(define gnutls
(module-ref (resolve-interface '(gnu packages tls)) 'guile-gnutls))
(define modules
(delete '(guix config)
(source-module-closure '((guix build hg)
(guix build download)
(guix build download-nar)
(guix swh)))))
(define build
(with-imported-modules modules
(with-extensions (list guile-json gnutls ;for (guix swh)
guile-lzlib)
#~(begin
(use-modules (guix build hg)
(guix build utils) ;for `set-path-environment-variable'
((guix build download)
#:select (download-method-enabled?))
(guix build download-nar)
(guix swh)
(ice-9 match))
(set-path-environment-variable "PATH" '("bin")
(match '#+inputs
(((names dirs outputs ...) ...)
dirs)))
(setvbuf (current-output-port) 'line)
(setvbuf (current-error-port) 'line)
(or (and (download-method-enabled? 'upstream)
(hg-fetch '#$(hg-reference-url ref)
'#$(hg-reference-changeset ref)
#$output
#:hg-command (string-append #+hg "/bin/hg")))
(and (download-method-enabled? 'nar)
(download-nar #$output))
;; As a last resort, attempt to download from Software Heritage.
;; Disable X.509 certificate verification to avoid depending
;; on nss-certs--we're authenticating the checkout anyway.
(and (download-method-enabled? 'swh)
(parameterize ((%verify-swh-certificate? #f))
(format (current-error-port)
"Trying to download from Software Heritage...~%")
(or (swh-download-directory-by-nar-hash
#$hash '#$hash-algo #$output)
(swh-download #$(hg-reference-url ref)
#$(hg-reference-changeset ref)
#$output)))))))))
(mlet %store-monad ((guile (package->derivation guile system)))
(gexp->derivation (or name "hg-checkout") build
#:leaked-env-vars '("http_proxy" "https_proxy"
"LC_ALL" "LC_MESSAGES" "LANG"
"COLUMNS")
#:env-vars (match (getenv "GUIX_DOWNLOAD_METHODS")
(#f '())
(value
`(("GUIX_DOWNLOAD_METHODS" . ,value))))
#:system system
#:local-build? #t ;don't offload repo cloning
#:hash-algo hash-algo
#:hash hash
#:recursive? #t
#:guile-for-build guile)))
(define (hg-version version revision changeset)
"Return the version string for packages using hg-download."
;; hg-version is almost exclusively executed while modules are being loaded.
;; This makes any errors hide their backtrace. Avoid the mysterious error
;; "Value out of range 0 to N: 7" when the commit ID is too short, which
;; can happen, for example, when the user swapped the revision and commit
;; arguments by mistake.
(when (< (string-length changeset) 7)
(raise
(condition
(&message (message "hg-version: changeset ID unexpectedly short")))))
(string-append version "-" revision "." (string-take changeset 7)))
(define (hg-file-name name version)
"Return the file-name for packages using hg-download."
(string-append name "-" version "-checkout"))
(define (hg-file-list directory)
"Evaluates to a list of files contained in the repository at path
@var{directory}"
(let* ((port (open-input-pipe (format #f "hg files --repository ~s" directory)))
(files (let loop ((files '()))
(let ((line (read-line port)))
(cond
((eof-object? line) files)
(else
(loop (cons line files))))))))
(close-pipe port)
(map canonicalize-path files)))
(define (should-select? path-list candidate)
"Returns #t in case that @var{candidate} is a file that is part of the given
@var{path-list}."
(let ((canon-candidate (canonicalize-path candidate)))
(let loop ((xs path-list))
(cond
((null? xs)
;; Directories are not part of `hg files', but `local-file' will not
;; recurse if we don't return #t for directories.
(equal? (array-ref (lstat candidate) 13) 'directory))
((string-contains candidate (car xs)) #t)
(else (loop (cdr xs)))))))
(define (hg-predicate directory)
"This procedure evaluates to a predicate that reports back whether a given
@var{file} - @var{stat} combination is part of the files tracked by
Mercurial."
(let ((files (hg-file-list directory)))
(lambda (file stat)
(should-select? files file))))
;;; hg-download.scm ends here
|