123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767 |
- ;;; GNU Guix --- Functional package management for GNU
- ;;; Copyright © 2017, 2020 Mathieu Othacehe <m.othacehe@gmail.com>
- ;;; Copyright © 2018-2022 Ludovic Courtès <ludo@gnu.org>
- ;;; Copyright © 2021 Kyle Meyer <kyle@kyleam.com>
- ;;; Copyright © 2021 Marius Bakke <marius@gnu.org>
- ;;; Copyright © 2022 Maxime Devos <maximedevos@telenet.be>
- ;;; Copyright © 2023 Tobias Geerinckx-Rice <me@tobias.gr>
- ;;;
- ;;; 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 git)
- #:use-module (git)
- #:use-module (guix i18n)
- #:use-module (guix base32)
- #:use-module (guix cache)
- #:use-module (gcrypt hash)
- #:use-module ((guix build utils)
- #:select (mkdir-p delete-file-recursively))
- #:use-module (guix store)
- #:use-module (guix utils)
- #:use-module (guix records)
- #:use-module (guix gexp)
- #:autoload (guix git-download)
- (git-reference-url git-reference-commit git-reference-recursive?)
- #:use-module (guix sets)
- #:use-module ((guix diagnostics) #:select (leave warning))
- #:use-module (guix progress)
- #:autoload (guix swh) (swh-download commit-id?)
- #:use-module (rnrs bytevectors)
- #:use-module (ice-9 format)
- #:use-module (ice-9 match)
- #:use-module (ice-9 ftw)
- #:use-module (srfi srfi-1)
- #:use-module (srfi srfi-11)
- #:use-module (srfi srfi-26)
- #:use-module (srfi srfi-34)
- #:use-module (srfi srfi-35)
- #:export (%repository-cache-directory
- honor-system-x509-certificates!
- url-cache-directory
- with-repository
- with-git-error-handling
- false-if-git-not-found
- update-cached-checkout
- url+commit->name
- latest-repository-commit
- commit-difference
- commit-relation
- commit-descendant?
- commit-id?
- remote-refs
- git-checkout
- git-checkout?
- git-checkout-url
- git-checkout-branch
- git-checkout-commit
- git-checkout-recursive?
- git-reference->git-checkout))
- (define %repository-cache-directory
- (make-parameter (string-append (cache-directory #:ensure? #f)
- "/checkouts")))
- (define (honor-system-x509-certificates!)
- "Use the system's X.509 certificates for Git checkouts over HTTPS. Honor
- the 'SSL_CERT_FILE' and 'SSL_CERT_DIR' environment variables."
- ;; On distros such as CentOS 7, /etc/ssl/certs contains only a couple of
- ;; files (instead of all the certificates) among which "ca-bundle.crt". On
- ;; other distros /etc/ssl/certs usually contains the whole set of
- ;; certificates along with "ca-certificates.crt". Try to choose the right
- ;; one.
- (let ((file (letrec-syntax ((choose
- (syntax-rules ()
- ((_ file rest ...)
- (let ((f file))
- (if (and f (file-exists? f))
- f
- (choose rest ...))))
- ((_)
- #f))))
- (choose (getenv "SSL_CERT_FILE")
- "/etc/ssl/certs/ca-certificates.crt"
- "/etc/ssl/certs/ca-bundle.crt")))
- (directory (or (getenv "SSL_CERT_DIR") "/etc/ssl/certs")))
- (and (or file
- (and=> (stat directory #f)
- (lambda (st)
- (> (stat:nlink st) 2))))
- (begin
- (set-tls-certificate-locations! directory file)
- #t))))
- (define %certificates-initialized?
- ;; Whether 'honor-system-x509-certificates!' has already been called.
- #f)
- (define-syntax-rule (with-libgit2 thunk ...)
- (begin
- ;; XXX: The right thing to do would be to call (libgit2-shutdown) here,
- ;; but pointer finalizers used in guile-git may be called after shutdown,
- ;; resulting in a segfault. Hence, let's skip shutdown call for now.
- (libgit2-init!)
- (unless %certificates-initialized?
- (honor-system-x509-certificates!)
- (set! %certificates-initialized? #t))
- thunk ...))
- (define* (url-cache-directory url
- #:optional (cache-directory
- (%repository-cache-directory))
- #:key recursive?)
- "Return the directory associated to URL in %repository-cache-directory."
- (string-append
- cache-directory "/"
- (bytevector->base32-string
- (sha256 (string->utf8 (if recursive?
- (string-append "R:" url)
- url))))))
- (define (show-progress progress)
- "Display a progress bar as we fetch Git code. PROGRESS is an
- <indexer-progress> record from (git)."
- (define total
- (indexer-progress-total-objects progress))
- (define-values (done label)
- (if (< (indexer-progress-received-objects progress) total)
- (values (indexer-progress-received-objects progress)
- (G_ "receiving objects"))
- (values (indexer-progress-indexed-objects progress)
- (G_ "indexing objects"))))
- (define %
- (* 100. (/ done total)))
- ;; TODO: Both should be handled & exposed by the PROGRESS-BAR API instead.
- (define width
- (max (- (current-terminal-columns)
- (string-length label) 7)
- 3))
- (define grain
- (match (quotient total (max 100 (* 8 width))) ; assume 1/8 glyph resolution
- (0 1)
- (x x)))
- (when (and (< % 100) (zero? (modulo done grain)))
- (erase-current-line (current-error-port))
- (format (current-error-port) "~a ~3,d% ~a"
- label (inexact->exact (round %))
- (progress-bar % width))
- (force-output (current-error-port)))
- (when (= % 100.)
- ;; We're done, erase the line.
- (erase-current-line (current-error-port))
- (force-output (current-error-port)))
- ;; Return true to indicate that we should go on.
- #t)
- (define (make-default-fetch-options)
- "Return the default fetch options."
- (let ((auth-method (%make-auth-ssh-agent)))
- ;; The #:transfer-progress and #:proxy-url options appeared in Guile-Git
- ;; 0.4.0. Omit them when using an older version.
- (catch 'wrong-number-of-args
- (lambda ()
- (make-fetch-options auth-method
- ;; Guile-Git doesn't distinguish between these.
- #:proxy-url (or (getenv "http_proxy")
- (getenv "https_proxy"))
- #:transfer-progress
- (and (isatty? (current-error-port))
- show-progress)))
- (lambda args
- (make-fetch-options auth-method)))))
- (define GITERR_HTTP
- ;; Guile-Git <= 0.5.2 lacks this constant.
- (let ((errors (resolve-interface '(git errors))))
- (if (module-defined? errors 'GITERR_HTTP)
- (module-ref errors 'GITERR_HTTP)
- 34)))
- (define (clone* url directory)
- "Clone git repository at URL into DIRECTORY. Upon failure,
- make sure no empty directory is left behind."
- (with-throw-handler #t
- (lambda ()
- (mkdir-p directory)
- (clone url directory
- (make-clone-options
- #:fetch-options (make-default-fetch-options))))
- (lambda _
- (false-if-exception (rmdir directory)))))
- (define (url+commit->name url sha1)
- "Return the string \"<REPO-NAME>-<SHA1:7>\" where REPO-NAME is the name of
- the git repository, extracted from URL and SHA1:7 the seven first digits
- of SHA1 string."
- (string-append
- (string-replace-substring
- (last (string-split url #\/)) ".git" "")
- "-" (string-take sha1 7)))
- (define (commit-id? str)
- "Return true if STR is likely a Git commit ID, false otherwise---e.g., if it
- is a tag name. This is based on a simple heuristic so use with care!"
- (and (= (string-length str) 40)
- (string-every char-set:hex-digit str)))
- (define (resolve-reference repository ref)
- "Resolve the branch, commit or tag specified by REF, and return the
- corresponding Git object."
- (let resolve ((ref ref))
- (match ref
- (('branch . branch)
- (let ((oid (reference-target
- (branch-lookup repository branch BRANCH-REMOTE))))
- (object-lookup repository oid)))
- (('symref . symref)
- (let ((oid (reference-name->oid repository symref)))
- (object-lookup repository oid)))
- (('commit . commit)
- (let ((len (string-length commit)))
- ;; 'object-lookup-prefix' appeared in Guile-Git in Mar. 2018, so we
- ;; can't be sure it's available. Furthermore, 'string->oid' used to
- ;; read out-of-bounds when passed a string shorter than 40 chars,
- ;; which is why we delay calls to it below.
- (if (< len 40)
- (object-lookup-prefix repository (string->oid commit) len)
- (object-lookup repository (string->oid commit)))))
- (('tag-or-commit . str)
- (cond ((and (string-contains str "-g")
- (match (string-split str #\-)
- ((version ... revision g+commit)
- (if (and (> (string-length g+commit) 4)
- (string-every char-set:digit revision)
- (string-every char-set:hex-digit
- (string-drop g+commit 1)))
- ;; Looks like a 'git describe' style ID, like
- ;; v1.3.0-7-gaa34d4d28d.
- (string-drop g+commit 1)
- #f))
- (_ #f)))
- => (lambda (commit) (resolve `(commit . ,commit))))
- ((or (> (string-length str) 40)
- (not (string-every char-set:hex-digit str)))
- (resolve `(tag . ,str))) ;definitely a tag
- (else
- (catch 'git-error
- (lambda ()
- (resolve `(tag . ,str)))
- (lambda _
- ;; There's no such tag, so it must be a commit ID.
- (resolve `(commit . ,str)))))))
- (('tag . tag)
- (let* ((oid (reference-name->oid repository
- (string-append "refs/tags/" tag)))
- (obj (object-lookup repository oid)))
- ;; OID may designate an "annotated tag" object or a "commit" object.
- ;; Return the commit object in both cases.
- (if (= OBJ-TAG (object-type obj))
- (object-lookup repository
- (tag-target-id (tag-lookup repository oid)))
- obj))))))
- (define (switch-to-ref repository ref)
- "Switch to REPOSITORY's branch, commit or tag specified by REF. Return the
- OID (roughly the commit hash) corresponding to REF."
- (define obj
- (resolve-reference repository ref))
- (reset repository obj RESET_HARD)
- (object-id obj))
- (define (call-with-repository directory proc)
- (let ((repository #f))
- (dynamic-wind
- (lambda ()
- (set! repository (repository-open directory)))
- (lambda ()
- (proc repository))
- (lambda ()
- (repository-close! repository)))))
- (define-syntax-rule (with-repository directory repository exp ...)
- "Open the repository at DIRECTORY and bind REPOSITORY to it within the
- dynamic extent of EXP."
- (call-with-repository directory
- (lambda (repository) exp ...)))
- (define (report-git-error error)
- "Report the given Guile-Git error."
- ;; Prior to Guile-Git commit b6b2760c2fd6dfaa5c0fedb43eeaff06166b3134,
- ;; errors would be represented by integers.
- (match error
- ((? integer? error) ;old Guile-Git
- (leave (G_ "Git error ~a~%") error))
- ((? git-error? error) ;new Guile-Git
- (leave (G_ "Git error: ~a~%") (git-error-message error)))))
- (define-syntax-rule (with-git-error-handling body ...)
- (catch 'git-error
- (lambda ()
- body ...)
- (lambda (key err)
- (report-git-error err))))
- (define* (update-submodules repository
- #:key (log-port (current-error-port))
- (fetch-options #f))
- "Update the submodules of REPOSITORY, a Git repository object."
- (for-each (lambda (name)
- (let ((submodule (submodule-lookup repository name)))
- (format log-port (G_ "updating submodule '~a'...~%")
- name)
- (submodule-update submodule
- #:fetch-options fetch-options)
- ;; Recurse in SUBMODULE.
- (let ((directory (string-append
- (repository-working-directory repository)
- "/" (submodule-path submodule))))
- (with-repository directory repository
- (update-submodules repository
- #:fetch-options fetch-options
- #:log-port log-port)))))
- (repository-submodules repository)))
- (define-syntax-rule (false-if-git-not-found exp)
- "Evaluate EXP, returning #false if a GIT_ENOTFOUND error is raised."
- (catch 'git-error
- (lambda ()
- exp)
- (lambda (key error . rest)
- (if (= GIT_ENOTFOUND (git-error-code error))
- #f
- (apply throw key error rest)))))
- (define (reference-available? repository ref)
- "Return true if REF, a reference such as '(commit . \"cabba9e\"), is
- definitely available in REPOSITORY, false otherwise."
- (match ref
- ((or ('commit . commit)
- ('tag-or-commit . (? commit-id? commit)))
- (let ((len (string-length commit))
- (oid (string->oid commit)))
- (false-if-git-not-found
- (->bool (if (< len 40)
- (object-lookup-prefix repository oid len OBJ-COMMIT)
- (commit-lookup repository oid))))))
- (_
- #f)))
- (define (clone-from-swh url tag-or-commit output)
- "Attempt to clone TAG-OR-COMMIT (a string), which originates from URL, using
- a copy archived at Software Heritage."
- (call-with-temporary-directory
- (lambda (bare)
- (and (swh-download url tag-or-commit bare
- #:archive-type 'git-bare)
- (let ((repository (clone* bare output)))
- (remote-set-url! repository "origin" url)
- repository)))))
- (define (clone/swh-fallback url ref cache-directory)
- "Like 'clone', but fallback to Software Heritage if the repository cannot be
- found at URL."
- (define (inaccessible-url-error? err)
- (let ((class (git-error-class err))
- (code (git-error-code err)))
- (or (= class GITERR_HTTP) ;404 or similar
- (= class GITERR_NET)))) ;unknown host, etc.
- (catch 'git-error
- (lambda ()
- (clone* url cache-directory))
- (lambda (key err)
- (match ref
- (((or 'commit 'tag-or-commit) . commit)
- (if (inaccessible-url-error? err)
- (or (clone-from-swh url commit cache-directory)
- (begin
- (warning (G_ "revision ~a of ~a \
- could not be fetched from Software Heritage~%")
- commit url)
- (throw key err)))
- (throw key err)))
- (_ (throw key err))))))
- (define cached-checkout-expiration
- ;; Return the expiration time procedure for a cached checkout.
- ;; TODO: Honor $GUIX_GIT_CACHE_EXPIRATION.
- ;; Use the mtime rather than the atime to cope with file systems mounted
- ;; with 'noatime'.
- (file-expiration-time (* 90 24 3600) stat:mtime))
- (define %checkout-cache-cleanup-period
- ;; Period for the removal of expired cached checkouts.
- (* 5 24 3600))
- (define (delete-checkout directory)
- "Delete DIRECTORY recursively, in an atomic fashion."
- (let ((trashed (string-append directory ".trashed")))
- (rename-file directory trashed)
- (delete-file-recursively trashed)))
- (define* (update-cached-checkout url
- #:key
- (ref '())
- recursive?
- (check-out? #t)
- starting-commit
- (log-port (%make-void-port "w"))
- (cache-directory
- (url-cache-directory
- url (%repository-cache-directory)
- #:recursive? recursive?)))
- "Update the cached checkout of URL to REF in CACHE-DIRECTORY. Return three
- values: the cache directory name, and the SHA1 commit (a string) corresponding
- to REF, and the relation of the new commit relative to STARTING-COMMIT (if
- provided) as returned by 'commit-relation'.
- REF is pair whose key is [branch | commit | tag | tag-or-commit ] and value
- the associated data: [<branch name> | <sha1> | <tag name> | <string>].
- If REF is the empty list, the remote HEAD is used.
- When RECURSIVE? is true, check out submodules as well, if any.
- When CHECK-OUT? is true, reset the cached working tree to REF; otherwise leave
- it unchanged."
- (define (cache-entries directory)
- (filter-map (match-lambda
- ((or "." "..")
- #f)
- (file
- (string-append directory "/" file)))
- (or (scandir directory) '())))
- (define canonical-ref
- ;; We used to require callers to specify "origin/" for each branch, which
- ;; made little sense since the cache should be transparent to them. So
- ;; here we append "origin/" if it's missing and otherwise keep it.
- (match ref
- (() '(symref . "refs/remotes/origin/HEAD"))
- (('branch . branch)
- `(branch . ,(if (string-prefix? "origin/" branch)
- branch
- (string-append "origin/" branch))))
- (_ ref)))
- (with-libgit2
- (let* ((cache-exists? (openable-repository? cache-directory))
- (repository (if cache-exists?
- (repository-open cache-directory)
- (clone/swh-fallback url ref cache-directory))))
- ;; Only fetch remote if it has not been cloned just before.
- (when (and cache-exists?
- (not (reference-available? repository ref)))
- (remote-fetch (remote-lookup repository "origin")
- #:fetch-options (make-default-fetch-options)))
- (when recursive?
- (update-submodules repository #:log-port log-port
- #:fetch-options (make-default-fetch-options)))
- ;; Note: call 'commit-relation' from here because it's more efficient
- ;; than letting users re-open the checkout later on.
- (let* ((oid (if check-out?
- (switch-to-ref repository canonical-ref)
- (object-id
- (resolve-reference repository canonical-ref))))
- (new (and starting-commit
- (commit-lookup repository oid)))
- (old (and starting-commit
- (false-if-git-not-found
- (commit-lookup repository
- (string->oid starting-commit)))))
- (relation (and starting-commit
- (if old
- (commit-relation old new)
- 'unrelated))))
- ;; Reclaim file descriptors and memory mappings associated with
- ;; REPOSITORY as soon as possible.
- (repository-close! repository)
- ;; Update CACHE-DIRECTORY's mtime to so the cache logic sees it.
- (match (gettimeofday)
- ((seconds . microseconds)
- (let ((nanoseconds (* 1000 microseconds)))
- (utime cache-directory
- seconds seconds
- nanoseconds nanoseconds))))
- ;; When CACHE-DIRECTORY is a sub-directory of the default cache
- ;; directory, remove expired checkouts that are next to it.
- (let ((parent (dirname cache-directory)))
- (when (string=? parent (%repository-cache-directory))
- (maybe-remove-expired-cache-entries parent cache-entries
- #:entry-expiration
- cached-checkout-expiration
- #:delete-entry delete-checkout
- #:cleanup-period
- %checkout-cache-cleanup-period)))
- (values cache-directory (oid->string oid) relation)))))
- (define* (latest-repository-commit store url
- #:key
- recursive?
- (log-port (%make-void-port "w"))
- (cache-directory
- (%repository-cache-directory))
- (ref '()))
- "Return two values: the content of the git repository at URL copied into a
- store directory and the sha1 of the top level commit in this directory. The
- reference to be checkout, once the repository is fetched, is specified by REF.
- REF is pair whose key is [branch | commit | tag] and value the associated
- data, respectively [<branch name> | <sha1> | <tag name>]. If REF is the empty
- list, the remote HEAD is used.
- When RECURSIVE? is true, check out submodules as well, if any.
- Git repositories are kept in the cache directory specified by
- %repository-cache-directory parameter.
- Log progress and checkout info to LOG-PORT."
- (define (dot-git? file stat)
- (and (string=? (basename file) ".git")
- (or (eq? 'directory (stat:type stat))
- ;; Submodule checkouts end up with a '.git' regular file that
- ;; contains metadata about where their actual '.git' directory
- ;; lives.
- (and recursive?
- (eq? 'regular (stat:type stat))))))
- (format log-port "updating checkout of '~a'...~%" url)
- (let*-values
- (((checkout commit _)
- (update-cached-checkout url
- #:recursive? recursive?
- #:ref ref
- #:cache-directory
- (url-cache-directory url cache-directory
- #:recursive?
- recursive?)
- #:log-port log-port))
- ((name)
- (url+commit->name url commit)))
- (format log-port "retrieved commit ~a~%" commit)
- (values (add-to-store store name #t "sha256" checkout
- #:select? (negate dot-git?))
- commit)))
- (define (print-git-error port key args default-printer)
- (match args
- (((? git-error? error) . _)
- (format port (G_ "Git error: ~a~%")
- (git-error-message error)))))
- (set-exception-printer! 'git-error print-git-error)
- ;;;
- ;;; Commit difference.
- ;;;
- (define* (commit-closure commit #:optional (visited (setq)))
- "Return the closure of COMMIT as a set. Skip commits contained in VISITED,
- a set, and adjoin VISITED to the result."
- (let loop ((commits (list commit))
- (visited visited))
- (match commits
- (()
- visited)
- ((head . tail)
- (if (set-contains? visited head)
- (loop tail visited)
- (loop (append (commit-parents head) tail)
- (set-insert head visited)))))))
- (define* (commit-difference new old #:optional (excluded '()))
- "Return the list of commits between NEW and OLD, where OLD is assumed to be
- an ancestor of NEW. Exclude all the commits listed in EXCLUDED along with
- their ancestors.
- Essentially, this computes the set difference between the closure of NEW and
- that of OLD."
- (let loop ((commits (list new))
- (result '())
- (visited (fold commit-closure
- (setq)
- (cons old excluded))))
- (match commits
- (()
- (reverse result))
- ((head . tail)
- (if (set-contains? visited head)
- (loop tail result visited)
- (loop (append (commit-parents head) tail)
- (cons head result)
- (set-insert head visited)))))))
- (define (commit-relation old new)
- "Return a symbol denoting the relation between OLD and NEW, two commit
- objects: 'ancestor (meaning that OLD is an ancestor of NEW), 'descendant, or
- 'unrelated, or 'self (OLD and NEW are the same commit)."
- (if (eq? old new)
- 'self
- (let ((newest (commit-closure new)))
- (if (set-contains? newest old)
- 'ancestor
- (let* ((seen (list->setq (commit-parents new)))
- (oldest (commit-closure old seen)))
- (if (set-contains? oldest new)
- 'descendant
- 'unrelated))))))
- (define (commit-descendant? new old)
- "Return true if NEW is the descendant of one of OLD, a list of commits.
- When the expected result is likely #t, this is faster than using
- 'commit-relation' since fewer commits need to be traversed."
- (let ((old (list->setq old)))
- (let loop ((commits (list new))
- (visited (setq)))
- (match commits
- (()
- #f)
- (_
- ;; Perform a breadth-first search as this is likely going to
- ;; terminate more quickly than a depth-first search.
- (let ((commits (remove (cut set-contains? visited <>) commits)))
- (or (any (cut set-contains? old <>) commits)
- (loop (append-map commit-parents commits)
- (fold set-insert visited commits)))))))))
- ;;
- ;;; Remote operations.
- ;;;
- (define* (remote-refs url #:key tags?)
- "Return the list of references advertised at Git repository URL. If TAGS?
- is true, limit to only refs/tags."
- (define (ref? ref)
- ;; Like `git ls-remote --refs', only show actual references.
- (and (string-prefix? "refs/" ref)
- (not (string-suffix? "^{}" ref))))
- (define (tag? ref)
- (string-prefix? "refs/tags/" ref))
- (define (include? ref)
- (and (ref? ref)
- (or (not tags?) (tag? ref))))
- (define (remote-head->ref remote)
- (let ((name (remote-head-name remote)))
- (and (include? name)
- name)))
- (with-libgit2
- (call-with-temporary-directory
- (lambda (cache-directory)
- (let* ((repository (repository-init cache-directory))
- ;; Create an in-memory remote so we don't touch disk.
- (remote (remote-create-anonymous repository url)))
- (remote-connect remote)
- (let* ((remote-heads (remote-ls remote))
- (refs (filter-map remote-head->ref remote-heads)))
- ;; Wait until we're finished with the repository before closing it.
- (remote-disconnect remote)
- (repository-close! repository)
- refs))))))
- ;;;
- ;;; Checkouts.
- ;;;
- ;; Representation of the "latest" checkout of a branch or a specific commit.
- (define-record-type* <git-checkout>
- git-checkout make-git-checkout
- git-checkout?
- (url git-checkout-url)
- (branch git-checkout-branch (default #f))
- (commit git-checkout-commit (default #f)) ;#f | tag | commit
- (recursive? git-checkout-recursive? (default #f)))
- (define (git-reference->git-checkout reference)
- "Convert the <git-reference> REFERENCE to an equivalent <git-checkout>."
- (git-checkout
- (url (git-reference-url reference))
- (commit (git-reference-commit reference))
- (recursive? (git-reference-recursive? reference))))
- (define* (latest-repository-commit* url #:key ref recursive? log-port)
- ;; Monadic variant of 'latest-repository-commit'.
- (lambda (store)
- ;; The caller--e.g., (guix scripts build)--may not handle 'git-error' so
- ;; translate it into '&message' conditions that we know will be properly
- ;; handled.
- (catch 'git-error
- (lambda ()
- (values (latest-repository-commit store url
- #:ref ref
- #:recursive? recursive?
- #:log-port log-port)
- store))
- (lambda (key error . _)
- (raise (condition
- (&message
- (message
- (match ref
- (('commit . commit)
- (format #f (G_ "cannot fetch commit ~a from ~a: ~a")
- commit url (git-error-message error)))
- (('branch . branch)
- (format #f (G_ "cannot fetch branch '~a' from ~a: ~a")
- branch url (git-error-message error)))
- (_
- (format #f (G_ "Git failure while fetching ~a: ~a")
- url (git-error-message error))))))))))))
- (define-gexp-compiler (git-checkout-compiler (checkout <git-checkout>)
- system target)
- ;; "Compile" CHECKOUT by updating the local checkout and adding it to the
- ;; store.
- (match checkout
- (($ <git-checkout> url branch commit recursive?)
- (latest-repository-commit* url
- #:ref (cond (commit
- `(tag-or-commit . ,commit))
- (branch
- `(branch . ,branch))
- (else '()))
- #:recursive? recursive?
- #:log-port (current-error-port)))))
- ;; Local Variables:
- ;; eval: (put 'with-repository 'scheme-indent-function 2)
- ;; End:
|