guix-play/guix/scripts/home/edit.scm
Ludovic Courtès 43c36c5c9f
ui: 'display-hint' quotes extra arguments for Texinfo.
Fixes <https://issues.guix.gnu.org/61201>.

Previously, common practice was to splice arbitrary strings (user names,
file names, etc.) into Texinfo snippets passed to 'display-hint'.  This
is unsafe in the general case because at signs and braces need to be
escaped to produced valid Texinfo.  This commit addresses that.

* guix/ui.scm (texinfo-quote): New procedure.
(display-hint): When ARGUMENTS is non-empty, pass it to 'texinfo-quote'
and call 'format'.
(report-unbound-variable-error, check-module-matches-file)
(display-collision-resolution-hint, run-guix-command): Remove explicit
'format' call; pass 'format' arguments as extra arguments to 'display-hint'.
* gnu/services/monitoring.scm (zabbix-front-end-config): Likewise.
* guix/scripts.scm (warn-about-disk-space): Likewise.
* guix/scripts/build.scm (%standard-cross-build-options)
(%standard-native-build-options): Likewise.
* guix/scripts/describe.scm (display-checkout-info): Likewise.
* guix/scripts/environment.scm (suggest-command-name): Likewise.
* guix/scripts/home.scm (process-command): Likewise.
* guix/scripts/home/edit.scm (service-type-not-found): Likewise.
* guix/scripts/import.scm (guix-import): Likewise.
* guix/scripts/package.scm (display-search-path-hint): Likewise.
* guix/scripts/pull.scm (build-and-install): Likewise.
* guix/scripts/shell.scm (auto-detect-manifest): Likewise.
* guix/scripts/system.scm (check-file-system-availability): Likewise.
(guix-system): Likewise.
* guix/scripts/system/edit.scm (service-type-not-found): Likewise.
* guix/status.scm (print-build-event): Likewise.
2023-02-27 23:40:43 +01:00

67 lines
2.8 KiB
Scheme
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2022, 2023 Ludovic Courtès <ludo@gnu.org>
;;;
;;; 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 home edit)
#:use-module (guix diagnostics)
#:use-module (guix i18n)
#:use-module (guix ui)
#:autoload (guix utils) (string-closest)
#:use-module (gnu services)
#:use-module (gnu home services)
#:use-module (srfi srfi-1)
#:use-module (ice-9 match)
#:autoload (guix scripts edit) (spawn-editor)
#:export (guix-home-edit))
(define (service-type-not-found type)
"Report an error about @var{type} not being found and exit."
(report-error (G_ "~a: no such service type~%") type)
(let* ((type (symbol->string type))
(available (fold-home-service-types (lambda (type lst)
(cons (symbol->string
(service-type-name type))
lst))
'()))
(closest (string-closest type available)))
(unless (or (not closest) (string=? closest type))
(display-hint (G_ "Did you mean @code{~a}?~%")
closest)))
(exit 1))
(define (guix-home-edit . args)
(when (null? args)
(leave (G_ "no service types specified, nothing to edit~%")))
(with-error-handling
(let* ((types (append-map (lambda (type)
(let ((type (string->symbol type)))
(match (lookup-home-service-types type)
(() (service-type-not-found type))
((one) (list one))
(lst
(warning (N_ "~a: ~a matching service type~%"
"~a: ~a matching service types~%"
(length lst))
type (length lst))
lst))))
args)))
(spawn-editor (filter-map service-type-location types)))))