2017-05-05 11:01:50 +02:00
|
|
|
;;; GNU Guix --- Functional package management for GNU
|
|
|
|
;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com>
|
2018-03-17 23:59:18 +01:00
|
|
|
;;; Copyright © 2018 Ludovic Courtès <ludo@gnu.org>
|
2017-05-05 11:01:50 +02:00
|
|
|
;;;
|
|
|
|
;;; 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 (git object)
|
|
|
|
#:use-module (guix base32)
|
|
|
|
#:use-module (guix hash)
|
2017-11-06 18:05:09 +01:00
|
|
|
#:use-module ((guix build utils) #:select (mkdir-p))
|
2017-05-05 11:01:50 +02:00
|
|
|
#:use-module (guix store)
|
|
|
|
#:use-module (guix utils)
|
|
|
|
#:use-module (rnrs bytevectors)
|
|
|
|
#:use-module (ice-9 match)
|
|
|
|
#:use-module (srfi srfi-1)
|
2018-03-17 23:59:18 +01:00
|
|
|
#:use-module (srfi srfi-34)
|
|
|
|
#:use-module (srfi srfi-35)
|
2017-05-05 11:01:50 +02:00
|
|
|
#:export (%repository-cache-directory
|
|
|
|
latest-repository-commit))
|
|
|
|
|
|
|
|
(define %repository-cache-directory
|
|
|
|
(make-parameter "/var/cache/guix/checkouts"))
|
|
|
|
|
|
|
|
(define-syntax-rule (with-libgit2 thunk ...)
|
2017-07-01 12:14:05 +02:00
|
|
|
(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!)
|
|
|
|
thunk ...))
|
2017-05-05 11:01:50 +02:00
|
|
|
|
|
|
|
(define* (url-cache-directory url
|
|
|
|
#:optional (cache-directory
|
|
|
|
(%repository-cache-directory)))
|
|
|
|
"Return the directory associated to URL in %repository-cache-directory."
|
|
|
|
(string-append
|
|
|
|
cache-directory "/"
|
|
|
|
(bytevector->base32-string (sha256 (string->utf8 url)))))
|
|
|
|
|
|
|
|
(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)
|
2017-11-10 12:59:55 +01:00
|
|
|
|
|
|
|
;; Note: Explicitly pass options to work around the invalid default
|
|
|
|
;; value in Guile-Git: <https://bugs.gnu.org/29238>.
|
2017-11-11 18:38:27 +01:00
|
|
|
(if (module-defined? (resolve-interface '(git))
|
|
|
|
'clone-init-options)
|
|
|
|
(clone url directory (clone-init-options))
|
|
|
|
(clone url directory)))
|
2017-05-05 11:01:50 +02:00
|
|
|
(lambda _
|
|
|
|
(false-if-exception (rmdir directory)))))
|
|
|
|
|
|
|
|
(define (repository->head-sha1 repo)
|
|
|
|
"Return the sha1 of the HEAD commit in REPOSITORY as a string."
|
|
|
|
(let ((oid (reference-target (repository-head repo))))
|
|
|
|
(oid->string (commit-id (commit-lookup repo oid)))))
|
|
|
|
|
|
|
|
(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* (copy-to-store store cache-directory #:key url repository)
|
2017-11-21 15:25:57 +01:00
|
|
|
"Copy CACHE-DIRECTORY recursively to STORE. URL and REPOSITORY are used to
|
|
|
|
create the store directory name."
|
|
|
|
(define (dot-git? file stat)
|
|
|
|
(and (string=? (basename file) ".git")
|
|
|
|
(eq? 'directory (stat:type stat))))
|
|
|
|
|
2017-05-05 11:01:50 +02:00
|
|
|
(let* ((commit (repository->head-sha1 repository))
|
|
|
|
(name (url+commit->name url commit)))
|
2017-11-21 15:25:57 +01:00
|
|
|
(values (add-to-store store name #t "sha256" cache-directory
|
|
|
|
#:select? (negate dot-git?))
|
|
|
|
commit)))
|
2017-05-05 11:01:50 +02:00
|
|
|
|
|
|
|
(define (switch-to-ref repository ref)
|
|
|
|
"Switch to REPOSITORY's branch, commit or tag specified by REF."
|
2018-03-17 23:59:18 +01:00
|
|
|
(define obj
|
|
|
|
(match ref
|
|
|
|
(('branch . branch)
|
|
|
|
(let ((oid (reference-target
|
|
|
|
(branch-lookup repository branch BRANCH-REMOTE))))
|
|
|
|
(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)
|
|
|
|
(if (module-defined? (resolve-interface '(git object))
|
|
|
|
'object-lookup-prefix)
|
|
|
|
(object-lookup-prefix repository (string->oid commit) len)
|
|
|
|
(raise (condition
|
|
|
|
(&message
|
|
|
|
(message "long Git object ID is required")))))
|
|
|
|
(object-lookup repository (string->oid commit)))))
|
|
|
|
(('tag . tag)
|
|
|
|
(let ((oid (reference-name->oid repository
|
|
|
|
(string-append "refs/tags/" tag))))
|
|
|
|
(object-lookup repository oid)))))
|
|
|
|
|
|
|
|
(reset repository obj RESET_HARD))
|
2017-05-05 11:01:50 +02:00
|
|
|
|
|
|
|
(define* (latest-repository-commit store url
|
|
|
|
#:key
|
|
|
|
(cache-directory
|
|
|
|
(%repository-cache-directory))
|
|
|
|
(ref '(branch . "origin/master")))
|
|
|
|
"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>].
|
|
|
|
|
|
|
|
Git repositories are kept in the cache directory specified by
|
|
|
|
%repository-cache-directory parameter."
|
|
|
|
(with-libgit2
|
|
|
|
(let* ((cache-dir (url-cache-directory url cache-directory))
|
|
|
|
(cache-exists? (openable-repository? cache-dir))
|
|
|
|
(repository (if cache-exists?
|
|
|
|
(repository-open cache-dir)
|
|
|
|
(clone* url cache-dir))))
|
|
|
|
;; Only fetch remote if it has not been cloned just before.
|
|
|
|
(when cache-exists?
|
|
|
|
(remote-fetch (remote-lookup repository "origin")))
|
|
|
|
(switch-to-ref repository ref)
|
|
|
|
(copy-to-store store cache-dir
|
|
|
|
#:url url
|
|
|
|
#:repository repository))))
|