304 lines
12 KiB
Scheme
304 lines
12 KiB
Scheme
;;; GNU Guix --- Functional package management for GNU
|
||
;;; Copyright © 2018, 2019, 2020, 2021, 2023 Ludovic Courtès <ludo@gnu.org>
|
||
;;; Copyright © 2018 Oleg Pykhalov <go.wigust@gmail.com>
|
||
;;; Copyright © 2020 Ekaitz Zarraga <ekaitz@elenq.tech>
|
||
;;; Copyright © 2021 Simon Tournier <zimon.toutoune@gmail.com>
|
||
;;; Copyright © 2022 jgart <jgart@dismail.de>
|
||
;;;
|
||
;;; 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 scripts describe)
|
||
#:use-module ((guix config) #:select (%guix-version))
|
||
#:use-module ((guix ui) #:hide (display-profile-content))
|
||
#:use-module ((guix utils) #:select (string-replace-substring))
|
||
#:use-module (guix channels)
|
||
#:use-module (guix scripts)
|
||
#:use-module (guix describe)
|
||
#:use-module (guix profiles)
|
||
#:autoload (guix colors) (supports-hyperlinks? hyperlink)
|
||
#:autoload (guix openpgp) (openpgp-format-fingerprint)
|
||
#:autoload (json builder) (scm->json-string)
|
||
#:use-module (srfi srfi-1)
|
||
#:use-module (srfi srfi-26)
|
||
#:use-module (srfi srfi-37)
|
||
#:use-module (ice-9 match)
|
||
#:use-module (ice-9 format)
|
||
#:autoload (ice-9 pretty-print) (pretty-print)
|
||
#:use-module (web uri)
|
||
#:export (display-profile-content
|
||
channel-commit-hyperlink
|
||
|
||
guix-describe))
|
||
|
||
|
||
;;;
|
||
;;; Command-line options.
|
||
;;;
|
||
(define %available-formats
|
||
'("human" "channels" "channels-sans-intro" "json" "recutils"))
|
||
|
||
(define (list-formats)
|
||
(display (G_ "The available formats are:\n"))
|
||
(newline)
|
||
(for-each (lambda (f)
|
||
(format #t " - ~a~%" f))
|
||
%available-formats))
|
||
|
||
(define %options
|
||
;; Specifications of the command-line options.
|
||
(list (option '(#\f "format") #t #f
|
||
(lambda (opt name arg result)
|
||
(unless (member arg %available-formats)
|
||
(leave (G_ "~a: unsupported output format~%") arg))
|
||
(alist-cons 'format (string->symbol arg) result)))
|
||
(option '("list-formats") #f #f
|
||
(lambda (opt name arg result)
|
||
(list-formats)
|
||
(exit 0)))
|
||
(option '(#\p "profile") #t #f
|
||
(lambda (opt name arg result)
|
||
(alist-cons 'profile (canonicalize-profile arg)
|
||
result)))
|
||
(option '(#\h "help") #f #f
|
||
(lambda args
|
||
(leave-on-EPIPE (show-help))
|
||
(exit 0)))
|
||
(option '(#\V "version") #f #f
|
||
(lambda args
|
||
(show-version-and-exit "guix describe")))))
|
||
|
||
(define %default-options
|
||
;; Alist of default option values.
|
||
'((format . human)))
|
||
|
||
(define (show-help)
|
||
(display (G_ "Usage: guix describe [OPTION]...
|
||
Display information about the channels currently in use.\n"))
|
||
(display (G_ "
|
||
-f, --format=FORMAT display information in the given FORMAT"))
|
||
(display (G_ "
|
||
--list-formats display available formats"))
|
||
(display (G_ "
|
||
-p, --profile=PROFILE display information about PROFILE"))
|
||
(newline)
|
||
(display (G_ "
|
||
-h, --help display this help and exit"))
|
||
(display (G_ "
|
||
-V, --version display version information and exit"))
|
||
(newline)
|
||
(show-bug-report-information))
|
||
|
||
(define (display-package-search-path fmt)
|
||
"Display GUIX_PACKAGE_PATH, if it is set, according to FMT."
|
||
(match (getenv "GUIX_PACKAGE_PATH")
|
||
(#f #t)
|
||
(string
|
||
(match fmt
|
||
('human
|
||
(format #t "~%GUIX_PACKAGE_PATH=\"~a\"~%" string))
|
||
('channels
|
||
(format #t (G_ "~%;; warning: GUIX_PACKAGE_PATH=\"~a\"~%")
|
||
string))
|
||
(_
|
||
(warning (G_ "'GUIX_PACKAGE_PATH' is set but it is not captured~%")))))))
|
||
|
||
(define (channel->json channel)
|
||
(scm->json-string
|
||
(let ((intro (channel-introduction channel)))
|
||
`((name . ,(channel-name channel))
|
||
(url . ,(channel-url channel))
|
||
(branch . ,(channel-branch channel))
|
||
(commit . ,(channel-commit channel))
|
||
,@(if intro
|
||
`((introduction
|
||
. ((commit . ,(channel-introduction-first-signed-commit
|
||
intro))
|
||
(signer . ,(openpgp-format-fingerprint
|
||
(channel-introduction-first-commit-signer
|
||
intro))))))
|
||
'())))))
|
||
|
||
(define (channel->recutils channel port)
|
||
(define intro
|
||
(channel-introduction channel))
|
||
|
||
(format port "name: ~a~%" (channel-name channel))
|
||
(format port "url: ~a~%" (channel-url channel))
|
||
(format port "branch: ~a~%" (channel-branch channel))
|
||
(format port "commit: ~a~%" (channel-commit channel))
|
||
(when intro
|
||
(format port "introductioncommit: ~a~%"
|
||
(channel-introduction-first-signed-commit intro))
|
||
(format port "introductionsigner: ~a~%"
|
||
(openpgp-format-fingerprint
|
||
(channel-introduction-first-commit-signer intro)))))
|
||
|
||
(define (display-checkout-info fmt)
|
||
"Display information about the current checkout according to FMT, a symbol
|
||
denoting the requested format. Exit if the current directory does not lie
|
||
within a Git checkout."
|
||
(let* ((program (car (command-line)))
|
||
(channel (repository->guix-channel (dirname program))))
|
||
(unless channel
|
||
(report-error (G_ "failed to determine origin~%"))
|
||
(display-hint (G_ "Perhaps this
|
||
@command{guix} command was not obtained with @command{guix pull}? Its version
|
||
string is ~a.~%")
|
||
%guix-version)
|
||
(exit 1))
|
||
|
||
(match fmt
|
||
('human
|
||
(format #t (G_ "Git checkout:~%"))
|
||
(format #t (G_ " repository: ~a~%") (channel-url channel))
|
||
(format #t (G_ " branch: ~a~%") (channel-branch channel))
|
||
(format #t (G_ " commit: ~a~%") (channel-commit channel)))
|
||
('channels
|
||
(pretty-print `(list ,(channel->code channel))))
|
||
('json
|
||
(display (channel->json channel))
|
||
(newline))
|
||
('recutils
|
||
(channel->recutils channel (current-output-port))))
|
||
(display-package-search-path fmt)))
|
||
|
||
(define* (display-profile-info profile fmt
|
||
#:optional
|
||
(channels (profile-channels profile)))
|
||
"Display information about PROFILE, a profile as created by (guix channels),
|
||
in the format specified by FMT. PROFILE can be #f, in which case CHANNELS is
|
||
what matters."
|
||
(define number
|
||
(and profile (generation-number profile)))
|
||
|
||
(match fmt
|
||
('human
|
||
(display-profile-content profile number channels))
|
||
('channels
|
||
(pretty-print `(list ,@(map channel->code channels))))
|
||
('channels-sans-intro
|
||
(pretty-print `(list ,@(map (cut channel->code <>
|
||
#:include-introduction? #f)
|
||
channels))))
|
||
('json
|
||
(format #t "[~a]~%" (string-join (map channel->json channels) ",")))
|
||
('recutils
|
||
(format #t "~{~a~%~}"
|
||
(map (lambda (channel)
|
||
(with-output-to-string
|
||
(lambda ()
|
||
(channel->recutils channel (current-output-port)))))
|
||
channels))))
|
||
(display-package-search-path fmt))
|
||
|
||
(define (profile-generation-channels profile number)
|
||
"Return the list of channels for generation NUMBER of PROFILE."
|
||
(profile-channels (if (zero? number)
|
||
profile
|
||
(generation-file-name profile number))))
|
||
|
||
(define* (display-profile-content profile number
|
||
#:optional
|
||
(channels
|
||
(profile-generation-channels profile
|
||
number)))
|
||
"Display CHANNELS along with PROFILE info, generation NUMBER, in a
|
||
human-readable way and displaying details about the channel's source code.
|
||
PROFILE and NUMBER "
|
||
(when (and number profile)
|
||
(display-generation profile number))
|
||
|
||
(for-each (lambda (channel)
|
||
(format #t " ~a ~a~%"
|
||
(channel-name channel)
|
||
(string-take (channel-commit channel) 7))
|
||
(format #t (G_ " repository URL: ~a~%")
|
||
(channel-url channel))
|
||
(when (channel-branch channel)
|
||
(format #t (G_ " branch: ~a~%")
|
||
(channel-branch channel)))
|
||
(format #t (G_ " commit: ~a~%")
|
||
(if (supports-hyperlinks?)
|
||
(channel-commit-hyperlink channel)
|
||
(channel-commit channel))))
|
||
channels))
|
||
|
||
(define %vcs-web-views
|
||
;; Hard-coded list of host names and corresponding web view URL templates.
|
||
;; TODO: Allow '.guix-channel' files to specify a URL template.
|
||
(let ((labhub-url (lambda (repository-url commit)
|
||
(string-append
|
||
(if (string-suffix? ".git" repository-url)
|
||
(string-drop-right repository-url 4)
|
||
repository-url)
|
||
"/commit/" commit))))
|
||
`(("git.savannah.gnu.org"
|
||
,(lambda (repository-url commit)
|
||
(string-append (string-replace-substring repository-url
|
||
"/git/" "/cgit/")
|
||
"/commit/?id=" commit)))
|
||
("notabug.org" ,labhub-url)
|
||
("framagit.org" ,labhub-url)
|
||
("gitlab.com" ,labhub-url)
|
||
("gitlab.inria.fr" ,labhub-url)
|
||
("github.com" ,labhub-url))))
|
||
|
||
(define* (channel-commit-hyperlink channel
|
||
#:optional
|
||
(commit (channel-commit channel)))
|
||
"Return a hyperlink for COMMIT in CHANNEL, using COMMIT as the hyperlink's
|
||
text. The hyperlink links to a web view of COMMIT, when available."
|
||
(let* ((url (channel-url channel))
|
||
(uri (string->uri url))
|
||
(host (and uri (uri-host uri))))
|
||
(if host
|
||
(match (assoc host %vcs-web-views)
|
||
(#f
|
||
commit)
|
||
((_ template)
|
||
(hyperlink (template url commit) commit)))
|
||
commit)))
|
||
|
||
|
||
;;;
|
||
;;; Entry point.
|
||
;;;
|
||
|
||
(define-command (guix-describe . args)
|
||
(synopsis "describe the channel revisions currently used")
|
||
(let* ((opts (parse-command-line args %options (list %default-options)
|
||
#:build-options? #f
|
||
#:argument-handler cons))
|
||
(format (assq-ref opts 'format))
|
||
(profile (or (assq-ref opts 'profile) (current-profile))))
|
||
(with-error-handling
|
||
(match profile
|
||
(#f
|
||
(match (current-channels)
|
||
(()
|
||
(display-checkout-info format))
|
||
(channels
|
||
(display-profile-info #f format channels))))
|
||
(profile
|
||
;; For the current profile, resort to 'current-channels', which has a
|
||
;; fallback to metadata from (guix config) in case PROFILE lacks it.
|
||
(let ((channels (if (and (current-profile)
|
||
(string=? profile (current-profile)))
|
||
(current-channels)
|
||
(profile-channels profile))))
|
||
(display-profile-info (canonicalize-profile profile)
|
||
format channels)))))))
|