1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2013, 2018 Mark H Weaver <mhw@netris.org>
4 ;;; Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org>
5 ;;; Copyright © 2014 Cyril Roelandt <tipecaml@gmail.com>
6 ;;; Copyright © 2014 Cyrill Schenkel <cyrill.schenkel@gmail.com>
7 ;;; Copyright © 2014, 2015, 2017 Alex Kost <alezost@gmail.com>
8 ;;; Copyright © 2015 David Thompson <davet@gnu.org>
9 ;;; Copyright © 2015, 2016 Mathieu Lirzin <mthl@gnu.org>
10 ;;; Copyright © 2016 Roel Janssen <roel@gnu.org>
11 ;;; Copyright © 2016 Benz Schenk <benz.schenk@uzh.ch>
12 ;;; Copyright © 2018 Kyle Meyer <kyle@kyleam.com>
13 ;;; Copyright © 2018 Ricardo Wurmus <rekado@elephly.net>
14 ;;; Copyright © 2019 Chris Marusich <cmmarusich@gmail.com>
15 ;;; Copyright © 2019 Tobias Geerinckx-Rice <me@tobias.gr>
16 ;;; Copyright © 2019 Simon Tournier <zimon.toutoune@gmail.com>
18 ;;; This file is part of GNU Guix.
20 ;;; GNU Guix is free software; you can redistribute it and/or modify it
21 ;;; under the terms of the GNU General Public License as published by
22 ;;; the Free Software Foundation; either version 3 of the License, or (at
23 ;;; your option) any later version.
25 ;;; GNU Guix is distributed in the hope that it will be useful, but
26 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
27 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 ;;; GNU General Public License for more details.
30 ;;; You should have received a copy of the GNU General Public License
31 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
33 (define-module (guix ui)
34 #:use-module (guix i18n)
35 #:use-module (guix colors)
36 #:use-module (guix diagnostics)
37 #:use-module (guix gexp)
38 #:use-module (guix sets)
39 #:use-module (guix utils)
40 #:use-module (guix store)
41 #:use-module (guix config)
42 #:use-module (guix packages)
43 #:use-module (guix profiles)
44 #:use-module (guix derivations)
45 #:use-module (guix build-system)
46 #:use-module (guix serialization)
47 #:use-module ((guix licenses)
48 #:select (license? license-name license-uri))
49 #:use-module ((guix build syscalls)
50 #:select (free-disk-space terminal-columns terminal-rows
51 with-file-lock/no-wait))
52 #:use-module ((guix build utils)
53 ;; XXX: All we need are the bindings related to
54 ;; '&invoke-error'. However, to work around the bug described
55 ;; in 5d669883ecc104403c5d3ba7d172e9c02234577c, #:hide
56 ;; unwanted bindings instead of #:select'ing the needed
58 #:hide (package-name->name+version
59 ;; Avoid "overrides core binding" warning.
61 #:use-module (srfi srfi-1)
62 #:use-module (srfi srfi-11)
63 #:use-module (srfi srfi-19)
64 #:use-module (srfi srfi-26)
65 #:use-module (srfi srfi-31)
66 #:use-module (srfi srfi-34)
67 #:use-module (srfi srfi-35)
68 #:autoload (ice-9 ftw) (scandir)
69 #:use-module (ice-9 match)
70 #:use-module (ice-9 format)
71 #:use-module (ice-9 regex)
72 #:autoload (system base compile) (compile-file)
73 #:autoload (system repl repl) (start-repl)
74 #:autoload (system repl debug) (make-debug stack->vector)
75 #:autoload (web uri) (encode-and-join-uri-path)
76 #:use-module (texinfo)
77 #:use-module (texinfo plain-text)
78 #:use-module (texinfo string-utils)
80 ;; Re-exports for backward compatibility.
81 #:re-export (G_ N_ P_ ;now in (guix i18n)
83 warning info report-error leave ;now in (guix diagnostics)
85 guix-warning-port program-name)
86 #:export (display-hint
91 show-bug-report-information
95 show-derivation-outputs
98 show-manifest-transaction
99 call-with-error-handling
101 with-unbound-variable-handling
104 read/eval-package-expression
105 check-available-space
109 package-description-string
110 package-synopsis-string
113 package-specification->name+version+output
122 display-search-results
129 display-profile-content
130 display-profile-content-diff
132 switch-to-generation*
135 %default-message-language
136 current-message-language
144 ;;; User interface facilities for command-line tools.
148 (define (print-unbound-variable-error port key args default-printer)
149 ;; Print unbound variable errors more nicely, and in the right language.
151 ((proc message (variable) _ ...)
152 ;; We can always omit PROC because when it's useful (i.e., different from
153 ;; "module-lookup"), it gets displayed before.
154 (format port (G_ "error: ~a: unbound variable") variable))
158 (set-exception-printer! 'unbound-variable print-unbound-variable-error)
160 (define (make-user-module modules)
161 "Return a new user module with the additional MODULES loaded."
162 ;; Module in which the machine description file is loaded.
163 (let ((module (make-fresh-user-module)))
164 (for-each (lambda (iface)
165 (module-use! module (resolve-interface iface)))
169 (define (last-frame-with-source stack)
170 "Walk stack upwards and return the last frame that has source location
171 information, or #f if it could not be found."
172 (define (frame-with-source frame)
173 ;; Walk from FRAME upwards until source location information is found.
174 (let loop ((frame frame)
179 ;; On Guile 3, the latest frame with source may be that of
180 ;; 'raise-exception' in boot-9.scm. Skip it.
181 (if (and (frame-source frame)
182 (not (eq? 'raise-exception (frame-procedure-name frame))))
184 (loop (frame-previous frame) frame)))))
186 (let* ((depth (stack-length stack))
187 (last (and (> depth 0) (stack-ref stack 0))))
188 (frame-with-source (if (> depth 1)
189 (stack-ref stack 1) ;skip the 'throw' frame
192 (define* (load* file user-module
193 #:key (on-error 'nothing-special))
194 "Load the user provided Scheme source code FILE."
195 (define (error-string frame args)
196 (call-with-output-string
198 (apply display-error frame port (cdr args)))))
201 (make-prompt-tag "user-code"))
205 ;; XXX: Force a recompilation to avoid ABI issues.
207 ;; In 2.2.3, the bogus answer to <https://bugs.gnu.org/29226> was to
208 ;; ignore all available .go, not just those from ~/.cache, which in turn
209 ;; meant that we had to rebuild *everything*. Since this is too costly,
210 ;; we have to turn off '%fresh-auto-compile' with that version, so to
211 ;; avoid ABI breakage in the user's config file, we explicitly compile
212 ;; it (the problem remains if the user's config is spread on several
213 ;; modules.) See <https://bugs.gnu.org/29881>.
214 (unless (string=? (version) "2.2.3")
215 (set! %fresh-auto-compile #t))
217 (set! %load-should-auto-compile #t)
219 (save-module-excursion
221 (set-current-module user-module)
223 ;; Hide the "auto-compiling" messages.
224 (parameterize ((current-warning-port (%make-void-port "w")))
225 (call-with-prompt tag
227 (when (string=? (version) "2.2.3")
230 (compile-file file #:env user-module))
231 (const #f))) ;EACCES maybe, let's interpret it
233 ;; Give 'load' an absolute file name so that it doesn't try to
234 ;; search for FILE in %LOAD-PATH. Note: use 'load', not
235 ;; 'primitive-load', so that FILE is compiled, which then allows us
236 ;; to provide better error reporting with source line numbers.
237 (load (canonicalize-path file)))
240 ;; XXX: Errors are reported from the pre-unwind handler below, but
241 ;; calling 'exit' from there has no effect, so we call it here.
243 (rec (handle-error . args)
244 ;; Capture the stack up to this procedure call, excluded, and pass
245 ;; the faulty stack frame to 'report-load-error'.
246 (let* ((stack (make-stack #t handle-error tag))
247 (frame (last-frame-with-source stack)))
249 (report-load-error file args frame)
254 (display (G_ "entering debugger; type ',bt' for a backtrace\n"))
255 (start-repl #:debug (make-debug (stack->vector stack) 0
256 (error-string frame args)
259 (newline (current-error-port))
260 (display-backtrace stack (current-error-port)))
264 (define (known-variable-definition variable)
265 "Search among the currently loaded modules one that defines a variable named
266 VARIABLE and return it, or #f if none was found."
267 (define (module<? m1 m2)
268 (match (module-name m2)
271 (match (module-name m1)
276 (let loop ((modules (list (resolve-module '() #f #f #:ensure #f)))
281 ;; Pick the "best" suggestion.
282 (match (sort suggestions module<?)
284 ((first _ ...) first)))
286 (if (set-contains? visited head)
287 (loop tail suggestions visited)
288 (let ((visited (set-insert head visited))
290 (hash-map->list (lambda (name module)
292 (module-submodules head)))))
293 (match (module-local-variable head variable)
294 (#f (loop next suggestions visited))
296 (match (module-name head)
297 (('gnu _ ...) head) ;must be that one
298 (_ (loop next (cons head suggestions) visited)))))))))))
300 (define %hint-color (color BOLD CYAN))
302 (define* (display-hint message #:optional (port (current-error-port)))
303 "Display MESSAGE, a l10n message possibly containing Texinfo markup, to
306 (if (color-output? port)
308 (colorize-string str %hint-color))
311 (display (colorize (G_ "hint: ")) port)
313 ;; XXX: We should arrange so that the initial indent is wider.
314 (parameterize ((%text-width (max 15 (- (terminal-columns) 5))))
315 (texi->plain-text message))
318 (define* (report-unbound-variable-error args #:key frame)
319 "Return the given unbound-variable error, where ARGS is the list of 'throw'
323 (print-exception (current-error-port) frame key args)))
325 (('unbound-variable proc message (variable) _ ...)
326 (match (known-variable-definition variable)
328 (display-hint (G_ "Did you forget a @code{use-modules} form?")))
330 (display-hint (format #f (G_ "Did you forget @code{(use-modules ~a)}?")
331 (module-name module))))))))
333 (define (check-module-matches-file module file)
334 "Check whether FILE starts with 'define-module MODULE' and print a hint if
336 ;; This is a common mistake when people start writing their own package
337 ;; definitions and try loading them with 'guix build -L …', so help them
338 ;; diagnose the problem.
340 (display-hint (format #f (G_ "File @file{~a} should probably start with:
342 @example\n(define-module ~a)\n@end example")
347 (let* ((sexp (call-with-input-file file read))
348 (loc (and (pair? sexp)
349 (source-properties->location (source-properties sexp)))))
351 (('define-module (names ...) _ ...)
352 (unless (equal? module names)
354 (G_ "module name ~a does not match file name '~a'~%")
355 names (module->source-file-name module))
358 (warning (G_ "~a: file is empty~%") file))
363 (define* (report-load-error file args #:optional frame)
364 "Report the failure to load FILE, a user-provided Scheme file.
365 ARGS is the list of arguments received by the 'throw' handler."
367 (('system-error . rest)
368 (let ((err (system-error-errno args)))
369 (report-error (G_ "failed to load '~a': ~a~%") file (strerror err))))
370 (('read-error "scm_i_lreadparen" message _ ...)
371 ;; Guile's missing-paren messages are obscure so we make them more
372 ;; intelligible here.
373 (if (string-suffix? "end of file" message)
374 (let ((location (string-drop-right message
375 (string-length "end of file"))))
376 (format (current-error-port) (G_ "~amissing closing parenthesis~%")
379 (('syntax-error proc message properties form subform . rest)
380 (let ((loc (source-properties->location properties)))
381 (report-error loc (G_ "~s: ~a~%")
382 (or subform form) message)))
383 (('unbound-variable _ ...)
384 (report-unbound-variable-error args #:frame frame))
385 (((or 'srfi-34 '%exception) obj)
386 (if (message-condition? obj)
387 (report-error (and (error-location? obj)
388 (error-location obj))
390 (gettext (condition-message obj) %gettext-domain))
391 (report-error (G_ "exception thrown: ~s~%") obj))
392 (when (fix-hint? obj)
393 (display-hint (condition-fix-hint obj))))
395 (report-error (G_ "failed to load '~a':~%") file)
397 (((? symbol? proc) (? string? message) (args ...) . rest)
398 (display-error frame (current-error-port) proc message
401 ;; Some exceptions like 'git-error' do not follow Guile's convention
402 ;; above and need to be printed with 'print-exception'.
403 (print-exception (current-error-port) frame key args))))))
405 (define (warn-about-load-error file module args) ;FIXME: factorize with ↑
406 "Report the failure to load FILE, a user-provided Scheme file, without
407 exiting. ARGS is the list of arguments received by the 'throw' handler."
409 (('system-error . rest)
410 (let ((err (system-error-errno args)))
411 (warning (G_ "failed to load '~a': ~a~%") module (strerror err))))
412 (('syntax-error proc message properties form . rest)
413 (let ((loc (source-properties->location properties)))
414 (warning loc (G_ "~a~%") message)))
415 (('unbound-variable _ ...)
416 (report-unbound-variable-error args))
417 (((or 'srfi-34 '%exception) obj)
418 (if (message-condition? obj)
419 (warning (G_ "failed to load '~a': ~a~%")
421 (gettext (condition-message obj) %gettext-domain))
422 (warning (G_ "failed to load '~a': exception thrown: ~s~%")
425 (warning (G_ "failed to load '~a':~%") module)
426 (apply display-error #f (current-error-port) args)
427 (check-module-matches-file module file))))
429 (define (call-with-unbound-variable-handling thunk)
431 (make-prompt-tag "user-code"))
433 (catch 'unbound-variable
435 (call-with-prompt tag
439 (rec (handle-error . args)
440 (let* ((stack (make-stack #t handle-error tag))
441 (frame (and stack (last-frame-with-source stack))))
442 (report-unbound-variable-error args #:frame frame)
445 (define-syntax-rule (with-unbound-variable-handling exp ...)
446 "Capture 'unbound-variable' exceptions in the dynamic extent of EXP... and
447 report them in a user-friendly way."
448 (call-with-unbound-variable-handling (lambda () exp ...)))
450 (define %default-message-language
451 ;; Default language to use for messages.
452 (make-parameter "en"))
454 (define (current-message-language)
455 "Return the language used for messages according to the current locale.
456 Return %DEFAULT-MESSAGE-LANGUAGE if that information could not be obtained. The
457 result is an ISO-639-2 language code such as \"ar\", without the territory
459 (let ((locale (setlocale LC_MESSAGES)))
460 (match (string-index locale #\_)
462 (index (string-take locale index)))))
464 (define (install-locale)
465 "Install the current locale settings."
468 (setlocale LC_ALL ""))
470 (display-hint (G_ "Consider installing the @code{glibc-utf8-locales} or
471 @code{glibc-locales} package and defining @code{GUIX_LOCPATH}, along these
475 guix package -i glibc-utf8-locales
476 export GUIX_LOCPATH=\"$HOME/.guix-profile/lib/locale\"
479 See the \"Application Setup\" section in the manual, for more info.\n")))))
481 (define (initialize-guix)
482 "Perform the usual initialization for stand-alone Guix commands."
483 ;; By default don't annoy users with deprecation warnings. In practice,
484 ;; 'define-deprecated' in (ice-9 deprecated) arranges so that those warnings
485 ;; are emitted at expansion-time only, but there are cases where they could
486 ;; slip through, for instance when interpreting code.
487 (unless (getenv "GUILE_WARN_DEPRECATED")
488 (debug-disable 'warn-deprecated))
491 (textdomain %gettext-domain)
493 ;; Ignore SIGPIPE. If the daemon closes the connection, we prefer to be
494 ;; notified via an EPIPE later.
495 (sigaction SIGPIPE SIG_IGN)
497 (setvbuf (current-output-port) 'line)
498 (setvbuf (current-error-port) 'line))
500 (define* (show-version-and-exit #:optional (command (car (command-line))))
501 "Display version information for COMMAND and `(exit 0)'."
502 (simple-format #t "~a (~a) ~a~%"
503 command %guix-package-name %guix-version)
504 (format #t "Copyright ~a 2020 ~a"
505 ;; TRANSLATORS: Translate "(C)" to the copyright symbol
506 ;; (C-in-a-circle), if this symbol is available in the user's
507 ;; locale. Otherwise, do not translate "(C)"; leave it as-is. */
509 (G_ "the Guix authors\n"))
511 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
512 This is free software: you are free to change and redistribute it.
513 There is NO WARRANTY, to the extent permitted by law.
517 (define (show-bug-report-information)
518 ;; TRANSLATORS: The placeholder indicates the bug-reporting address for this
519 ;; package. Please add another line saying "Report translation bugs to
520 ;; ...\n" with the address for translation bugs (typically your translation
521 ;; team's web or email address).
523 Report bugs to: ~a.") %guix-bug-report-address)
525 ~a home page: <~a>") %guix-package-name %guix-home-page-url)
527 General help using GNU software: <http://www.gnu.org/gethelp/>"))
530 (define (augmented-system-error-handler file)
531 "Return a 'system-error' handler that mentions FILE in its message."
532 (lambda (key proc fmt args errno)
533 ;; Augment the FMT and ARGS with information about TARGET (this
534 ;; information is missing as of Guile 2.0.11, making the exception
536 (apply throw key proc "~A: ~S"
537 (list (strerror (car errno)) file)
540 (define-syntax apply-formals
542 ((_ proc (args ...)) (proc args ...))
543 ((_ proc (arg1 args ... . rest)) (apply proc arg1 args ... rest))))
545 (define-syntax-rule (error-reporting-wrapper proc formals file)
546 "Wrap PROC such that its 'system-error' exceptions are augmented to mention
548 (let ((real-proc (@ (guile) proc)))
552 (apply-formals real-proc formals))
553 (augmented-system-error-handler file)))))
556 ;; We 'set!' the global binding because (gnu build ...) modules and similar
557 ;; typically don't use (guix ui).
558 (error-reporting-wrapper symlink (source target) target))
561 ;; Note: here we use 'set!', not #:replace, because UIs typically use
562 ;; 'copy-recursively', which doesn't use (guix ui).
563 (error-reporting-wrapper copy-file (source target) target))
565 (set! canonicalize-path
566 (error-reporting-wrapper canonicalize-path (file) file))
569 (error-reporting-wrapper delete-file (file) file))
572 (error-reporting-wrapper execlp (filename . args) filename))
574 (define (make-regexp* regexp . flags)
575 "Like 'make-regexp' but error out if REGEXP is invalid, reporting the error
577 (catch 'regular-expression-syntax
579 (apply make-regexp regexp flags))
580 (lambda (key proc message . rest)
581 (leave (G_ "'~a' is not a valid regular expression: ~a~%")
584 (define (string->number* str)
585 "Like `string->number', but error out with an error message on failure."
586 (or (string->number str)
587 (leave (G_ "~a: invalid number~%") str)))
589 (define (size->number str)
590 "Convert STR, a storage measurement representation such as \"1024\" or
591 \"1MiB\", to a number of bytes. Raise an error if STR could not be
595 (char-set-union (char-set #\.) char-set:digit)))
598 (and unit-pos (substring str (+ 1 unit-pos))))
600 (let* ((numstr (if unit-pos
601 (substring str 0 (+ 1 unit-pos))
603 (num (string->number numstr)))
605 (leave (G_ "invalid number: ~a~%") numstr))
607 ((compose inexact->exact round)
610 ((or "KiB" "K" "k") (expt 2 10))
611 ((or "MiB" "M") (expt 2 20))
612 ((or "GiB" "G") (expt 2 30))
613 ((or "TiB" "T") (expt 2 40))
614 ((or "PiB" "P") (expt 2 50))
615 ((or "EiB" "E") (expt 2 60))
616 ((or "ZiB" "Z") (expt 2 70))
617 ((or "YiB" "Y") (expt 2 80))
628 (leave (G_ "unknown unit: ~a~%") unit)))))))
630 (define (display-collision-resolution-hint collision)
631 "Display hints on how to resolve COLLISION, a &profile-collistion-error."
632 (define (top-most-entry entry)
633 (let loop ((entry entry))
634 (match (force (manifest-entry-parent entry))
636 (parent (loop parent)))))
638 (let* ((first (profile-collision-error-entry collision))
639 (second (profile-collision-error-conflict collision))
640 (name1 (manifest-entry-name (top-most-entry first)))
641 (name2 (manifest-entry-name (top-most-entry second))))
642 (if (string=? name1 name2)
643 (display-hint (format #f (G_ "You cannot have two different versions
644 or variants of @code{~a} in the same profile.")
646 (display-hint (format #f (G_ "Try upgrading both @code{~a} and @code{~a},
647 or remove one of them from the profile.")
650 (define (call-with-error-handling thunk)
651 "Call THUNK within a user-friendly error handler."
652 (define (port-filename* port)
653 ;; 'port-filename' returns #f for non-file ports, but it raises an
654 ;; exception for file ports that are closed. Work around that.
655 (and (not (port-closed? port))
656 (port-filename port)))
658 (guard (c ((package-input-error? c)
659 (let* ((package (package-error-package c))
660 (input (package-error-invalid-input c))
661 (location (package-location package))
662 (file (location-file location))
663 (line (location-line location))
664 (column (location-column location)))
665 (leave (G_ "~a:~a:~a: package `~a' has an invalid input: ~s~%")
667 (package-full-name package) input)))
668 ((package-cross-build-system-error? c)
669 (let* ((package (package-error-package c))
670 (loc (package-location package))
671 (system (package-build-system package)))
672 (leave (G_ "~a: ~a: build system `~a' does not support cross builds~%")
673 (location->string loc)
674 (package-full-name package)
675 (build-system-name system))))
676 ((gexp-input-error? c)
677 (let ((input (package-error-invalid-input c)))
678 (leave (G_ "~s: invalid G-expression input~%")
679 (gexp-error-invalid-input c))))
680 ((profile-not-found-error? c)
681 (leave (G_ "profile '~a' does not exist~%")
682 (profile-error-profile c)))
683 ((missing-generation-error? c)
684 (leave (G_ "generation ~a of profile '~a' does not exist~%")
685 (missing-generation-error-generation c)
686 (profile-error-profile c)))
687 ((unmatched-pattern-error? c)
688 (let ((pattern (unmatched-pattern-error-pattern c)))
689 (leave (G_ "package '~a~@[@~a~]~@[:~a~]' not found in profile~%")
690 (manifest-pattern-name pattern)
691 (manifest-pattern-version pattern)
692 (match (manifest-pattern-output pattern)
695 ((profile-collision-error? c)
696 (let ((entry (profile-collision-error-entry c))
697 (conflict (profile-collision-error-conflict c)))
698 (define (report-parent-entries entry)
699 (let ((parent (force (manifest-entry-parent entry))))
700 (when (manifest-entry? parent)
701 (report-error (G_ " ... propagated from ~a@~a~%")
702 (manifest-entry-name parent)
703 (manifest-entry-version parent))
704 (report-parent-entries parent))))
706 (define (manifest-entry-output* entry)
707 (match (manifest-entry-output entry)
709 (output (string-append ":" output))))
711 (report-error (G_ "profile contains conflicting entries for ~a~a~%")
712 (manifest-entry-name entry)
713 (manifest-entry-output* entry))
714 (report-error (G_ " first entry: ~a@~a~a ~a~%")
715 (manifest-entry-name entry)
716 (manifest-entry-version entry)
717 (manifest-entry-output* entry)
718 (manifest-entry-item entry))
719 (report-parent-entries entry)
720 (report-error (G_ " second entry: ~a@~a~a ~a~%")
721 (manifest-entry-name conflict)
722 (manifest-entry-version conflict)
723 (manifest-entry-output* conflict)
724 (manifest-entry-item conflict))
725 (report-parent-entries conflict)
726 (display-collision-resolution-hint c)
729 (let ((file (nar-error-file c))
730 (port (nar-error-port c)))
732 (leave (G_ "corrupt input while restoring '~a' from ~s~%")
733 file (or (port-filename* port) port))
734 (leave (G_ "corrupt input while restoring archive from ~s~%")
735 (or (port-filename* port) port)))))
736 ((store-connection-error? c)
737 (leave (G_ "failed to connect to `~a': ~a~%")
738 (store-connection-error-file c)
739 (strerror (store-connection-error-code c))))
740 ((store-protocol-error? c)
741 ;; FIXME: Server-provided error messages aren't i18n'd.
743 (store-protocol-error-message c)))
744 ((derivation-missing-output-error? c)
745 (leave (G_ "reference to invalid output '~a' of derivation '~a'~%")
746 (derivation-missing-output c)
747 (derivation-file-name (derivation-error-derivation c))))
748 ((file-search-error? c)
749 (leave (G_ "file '~a' could not be found in these \
750 directories:~{ ~a~}~%")
751 (file-search-error-file-name c)
752 (file-search-error-search-path c)))
754 (leave (G_ "program exited\
755 ~@[ with non-zero exit status ~a~]\
756 ~@[ terminated by signal ~a~]\
757 ~@[ stopped by signal ~a~]: ~s~%")
758 (invoke-error-exit-status c)
759 (invoke-error-term-signal c)
760 (invoke-error-stop-signal c)
761 (cons (invoke-error-program c)
762 (invoke-error-arguments c))))
763 ((and (error-location? c) (message-condition? c))
764 (report-error (error-location c) (G_ "~a~%")
765 (gettext (condition-message c) %gettext-domain))
767 (display-hint (condition-fix-hint c)))
769 ((and (message-condition? c) (fix-hint? c))
770 (report-error (G_ "~a~%")
771 (gettext (condition-message c) %gettext-domain))
772 (display-hint (condition-fix-hint c))
775 ;; On Guile 3.0.0, exceptions such as 'unbound-variable' are
776 ;; compound and include a '&message'. However, that message only
777 ;; contains the format string. Thus, special-case it here to
778 ;; avoid displaying a bare format string.
781 ((exception-predicate &exception-with-kind-and-args) c))
785 ((message-condition? c)
786 ;; Normally '&message' error conditions have an i18n'd message.
788 (gettext (condition-message c) %gettext-domain))))
789 ;; Catch EPIPE and the likes.
792 (lambda (key proc format-string format-args . rest)
793 (leave (G_ "~a: ~a~%") proc
794 (apply format #f format-string format-args))))))
796 (define-syntax-rule (leave-on-EPIPE exp ...)
797 "Run EXP... in a context when EPIPE errors are caught and lead to 'exit'
798 with successful exit code. This is useful when writing to the standard output
799 may lead to EPIPE, because the standard output is piped through 'head' or
805 ;; We really have to exit this brutally, otherwise Guile eventually
806 ;; attempts to flush all the ports, leading to an uncaught EPIPE down
808 (if (= EPIPE (system-error-errno args))
810 (apply throw args)))))
812 (define %guix-user-module
813 ;; Module in which user expressions are evaluated.
814 ;; Compute lazily to avoid circularity with (guix gexp).
816 (let ((module (make-module)))
817 (beautify-user-module! module)
818 ;; Use (guix gexp) so that one can use #~ & co.
819 (module-use! module (resolve-interface '(guix gexp)))
822 (define (read/eval str)
823 "Read and evaluate STR, raising an error if something goes wrong."
826 (call-with-input-string str read))
828 (leave (G_ "failed to read expression ~s: ~s~%")
832 (eval exp (force %guix-user-module)))
834 (report-error (G_ "failed to evaluate expression '~a':~%") exp)
836 (('syntax-error proc message properties form . rest)
837 (report-error (G_ "syntax error: ~a~%") message))
838 (((or 'srfi-34 '%exception) obj)
839 (if (message-condition? obj)
840 (report-error (G_ "~a~%")
841 (gettext (condition-message obj)
843 (report-error (G_ "exception thrown: ~s~%") obj)))
845 (apply display-error #f (current-error-port) args))
849 (define (read/eval-package-expression str)
850 "Read and evaluate STR and return the package it refers to, or exit an
852 (match (read/eval str)
855 (leave (G_ "expression ~s does not evaluate to a package~%")
858 (define (show-derivation-outputs derivation)
859 "Show the output file names of DERIVATION, which can be a derivation or a
861 (define (show-outputs derivation outputs)
862 (format #t "~{~a~%~}"
863 (map (cut derivation->output-path derivation <>)
868 (show-outputs derivation (derivation-output-names derivation)))
869 ((? derivation-input? input)
870 (show-outputs (derivation-input-derivation input)
871 (derivation-input-sub-derivations input)))))
873 (define* (check-available-space need
874 #:optional (directory (%store-prefix)))
875 "Make sure at least NEED bytes are available in DIRECTORY. Otherwise emit a
877 (let ((free (catch 'system-error
879 (free-disk-space directory))
881 (when (and free (>= need free))
882 (warning (G_ "at least ~,1h MB needed but only ~,1h MB available in ~a~%")
883 (/ need 1e6) (/ free 1e6) directory))))
885 (define (graft-derivation? drv)
886 "Return true if DRV is definitely a graft derivation, false otherwise."
887 (match (assq-ref (derivation-properties drv) 'type)
891 (define (profile-hook-derivation? drv)
892 "Return true if DRV is definitely a profile hook derivation, false otherwise."
893 (match (assq-ref (derivation-properties drv) 'type)
897 (define (colorize-store-file-name file)
898 "Colorize FILE, a store file name, such that the hash part is less prominent
900 (let ((len (string-length file))
901 (prefix (+ (string-length (%store-prefix)) 32 2)))
904 (string-append (colorize-string (string-take file prefix)
906 (string-drop file prefix)))))
908 (define* (show-what-to-build store drv
909 #:key dry-run? (use-substitutes? #t)
910 (mode (build-mode normal)))
911 "Show what will or would (depending on DRY-RUN?) be built in realizing the
912 derivations listed in DRV using MODE, a 'build-mode' value. The elements of
913 DRV can be either derivations or derivation inputs.
915 Return #t if there's something to build, #f otherwise. When USE-SUBSTITUTES?,
916 check and report what is prerequisites are available for download."
919 ((? derivation? drv) (derivation-input drv))
920 ((? derivation-input? input) input))
923 (define substitutable-info
924 ;; Call 'substitutation-oracle' upfront so we don't end up launching the
925 ;; substituter many times. This makes a big difference, especially when
926 ;; DRV is a long list as is the case with 'guix environment'.
928 (substitution-oracle store inputs #:mode mode)
931 (define colorized-store-item
932 (if (color-output? (current-error-port))
933 colorize-store-file-name
936 (let*-values (((build download)
937 (derivation-build-plan store inputs
942 (match (fold (lambda (drv acc)
943 (let ((file (derivation-file-name drv)))
945 ((#:graft graft #:hook hook #:build build)
947 ((graft-derivation? drv)
948 `(#:graft ,(cons file graft)
951 ((profile-hook-derivation? drv)
953 #:hook ,(cons file hook)
958 #:build ,(cons file build))))))))
959 '(#:graft () #:hook () #:build ())
961 ((#:graft graft #:hook hook #:build build)
962 (values graft hook build)))))
963 (define installed-size
964 (reduce + 0 (map substitutable-nar-size download)))
966 (define download-size
967 (/ (reduce + 0 (map substitutable-download-size download))
970 (define display-download-size?
971 ;; Sometimes narinfos lack information about the download size. Only
972 ;; display when we have information for all of DOWNLOAD.
973 (not (any (compose zero? substitutable-download-size) download)))
977 (format (current-error-port)
978 (N_ "~:[The following derivation would be built:~%~{ ~a~%~}~;~]"
979 "~:[The following derivations would be built:~%~{ ~a~%~}~;~]"
981 (null? build) (map colorized-store-item build))
982 (if display-download-size?
983 (format (current-error-port)
984 ;; TRANSLATORS: "MB" is for "megabyte"; it should be
985 ;; translated to the corresponding abbreviation.
986 (G_ "~:[~,1h MB would be downloaded:~%~{ ~a~%~}~;~]")
989 (map (compose colorized-store-item substitutable-path)
991 (format (current-error-port)
992 (N_ "~:[The following file would be downloaded:~%~{ ~a~%~}~;~]"
993 "~:[The following files would be downloaded:~%~{ ~a~%~}~;~]"
996 (map (compose colorized-store-item substitutable-path)
998 (format (current-error-port)
999 (N_ "~:[The following graft would be made:~%~{ ~a~%~}~;~]"
1000 "~:[The following grafts would be made:~%~{ ~a~%~}~;~]"
1002 (null? graft) (map colorized-store-item graft))
1003 (format (current-error-port)
1004 (N_ "~:[The following profile hook would be built:~%~{ ~a~%~}~;~]"
1005 "~:[The following profile hooks would be built:~%~{ ~a~%~}~;~]"
1007 (null? hook) (map colorized-store-item hook)))
1009 (format (current-error-port)
1010 (N_ "~:[The following derivation will be built:~%~{ ~a~%~}~;~]"
1011 "~:[The following derivations will be built:~%~{ ~a~%~}~;~]"
1013 (null? build) (map colorized-store-item build))
1014 (if display-download-size?
1015 (format (current-error-port)
1016 ;; TRANSLATORS: "MB" is for "megabyte"; it should be
1017 ;; translated to the corresponding abbreviation.
1018 (G_ "~:[~,1h MB will be downloaded:~%~{ ~a~%~}~;~]")
1021 (map (compose colorized-store-item substitutable-path)
1023 (format (current-error-port)
1024 (N_ "~:[The following file will be downloaded:~%~{ ~a~%~}~;~]"
1025 "~:[The following files will be downloaded:~%~{ ~a~%~}~;~]"
1028 (map (compose colorized-store-item substitutable-path)
1030 (format (current-error-port)
1031 (N_ "~:[The following graft will be made:~%~{ ~a~%~}~;~]"
1032 "~:[The following grafts will be made:~%~{ ~a~%~}~;~]"
1034 (null? graft) (map colorized-store-item graft))
1035 (format (current-error-port)
1036 (N_ "~:[The following profile hook will be built:~%~{ ~a~%~}~;~]"
1037 "~:[The following profile hooks will be built:~%~{ ~a~%~}~;~]"
1039 (null? hook) (map colorized-store-item hook))))
1041 (check-available-space installed-size)
1045 (define show-what-to-build*
1046 (store-lift show-what-to-build))
1048 (define (right-arrow port)
1049 "Return either a string containing the 'RIGHT ARROW' character, or an ASCII
1050 replacement if PORT is not Unicode-capable."
1051 (let ((encoding (port-encoding port))
1053 (catch 'encoding-error
1055 (call-with-output-string
1057 (set-port-encoding! port encoding)
1058 (set-port-conversion-strategy! port 'error)
1059 (display arrow port))))
1060 (lambda (key . args)
1063 (define* (show-manifest-transaction store manifest transaction
1065 "Display what will/would be installed/removed from MANIFEST by TRANSACTION."
1066 (define (package-strings name version output item)
1067 (map (lambda (name version output item)
1068 (format #f " ~a~:[:~a~;~*~]\t~a\t~a"
1070 (equal? output "out") output version
1072 (package-output store item output)
1074 name version output item))
1076 (define → ;an arrow that can be represented on stderr
1077 (right-arrow (current-error-port)))
1079 (define (upgrade-string name old-version new-version output item)
1080 (format #f " ~a~:[:~a~;~*~]\t~a ~a ~a\t~a"
1081 name (equal? output "out") output
1082 old-version → new-version
1084 (package-output store item output)
1087 (let-values (((remove install upgrade downgrade)
1088 (manifest-transaction-effects manifest transaction)))
1090 ((($ <manifest-entry> name version output item) ..1)
1091 (let ((len (length name))
1092 (remove (package-strings name version output item)))
1094 (format (current-error-port)
1095 (N_ "The following package would be removed:~%~{~a~%~}~%"
1096 "The following packages would be removed:~%~{~a~%~}~%"
1099 (format (current-error-port)
1100 (N_ "The following package will be removed:~%~{~a~%~}~%"
1101 "The following packages will be removed:~%~{~a~%~}~%"
1106 (((($ <manifest-entry> name old-version)
1107 . ($ <manifest-entry> _ new-version output item)) ..1)
1108 (let ((len (length name))
1109 (downgrade (map upgrade-string
1110 name old-version new-version output item)))
1112 (format (current-error-port)
1113 (N_ "The following package would be downgraded:~%~{~a~%~}~%"
1114 "The following packages would be downgraded:~%~{~a~%~}~%"
1117 (format (current-error-port)
1118 (N_ "The following package will be downgraded:~%~{~a~%~}~%"
1119 "The following packages will be downgraded:~%~{~a~%~}~%"
1124 (((($ <manifest-entry> name old-version)
1125 . ($ <manifest-entry> _ new-version output item)) ..1)
1126 (let ((len (length name))
1127 (upgrade (map upgrade-string
1128 name old-version new-version output item)))
1130 (format (current-error-port)
1131 (N_ "The following package would be upgraded:~%~{~a~%~}~%"
1132 "The following packages would be upgraded:~%~{~a~%~}~%"
1135 (format (current-error-port)
1136 (N_ "The following package will be upgraded:~%~{~a~%~}~%"
1137 "The following packages will be upgraded:~%~{~a~%~}~%"
1142 ((($ <manifest-entry> name version output item _) ..1)
1143 (let ((len (length name))
1144 (install (package-strings name version output item)))
1146 (format (current-error-port)
1147 (N_ "The following package would be installed:~%~{~a~%~}~%"
1148 "The following packages would be installed:~%~{~a~%~}~%"
1151 (format (current-error-port)
1152 (N_ "The following package will be installed:~%~{~a~%~}~%"
1153 "The following packages will be installed:~%~{~a~%~}~%"
1158 (define-syntax with-error-handling
1160 "Run BODY within a user-friendly error condition handler."
1162 (call-with-error-handling
1166 (define* (fill-paragraph str width #:optional (column 0))
1167 "Fill STR such that each line contains at most WIDTH characters, assuming
1168 that the first character is at COLUMN.
1170 When STR contains a single line break surrounded by other characters, it is
1171 converted to a space; sequences of more than one line break are preserved."
1172 (define (maybe-break chr result)
1174 ((column newlines chars)
1177 `(,column ,(+ 1 newlines) ,chars))
1179 (let* ((spaces (if (and (pair? chars) (eqv? (car chars) #\.)) 2 1))
1180 (chars (case newlines
1183 (append (make-list spaces #\space) chars))
1185 (append (make-list newlines #\newline) chars))))
1186 (column (case newlines
1188 ((1) (+ spaces column))
1190 (let ((chars (cons chr chars))
1191 (column (+ 1 column)))
1192 (if (> column width)
1193 (let*-values (((before after)
1194 (break (cut eqv? #\space <>) chars))
1204 (drop-while (cut eqv? #\space <>)
1206 `(,column 0 ,chars))) ; unbreakable
1207 `(,column 0 ,chars)))))))))
1209 (match (string-fold maybe-break
1212 ((column newlines chars)
1213 (list->string (reverse chars)))))
1221 (make-parameter (terminal-columns)))
1223 (set! (@@ (texinfo plain-text) wrap*)
1224 ;; XXX: Monkey patch this private procedure to let 'package->recutils'
1225 ;; parameterize the fill of description field correctly.
1227 (let ((indent (fluid-ref (@@ (texinfo plain-text) *indent*))))
1228 (fill-string (string-concatenate strings)
1229 #:line-width (%text-width) #:initial-indent indent
1230 #:subsequent-indent indent))))
1232 (define (texi->plain-text str)
1233 "Return a plain-text representation of texinfo fragment STR."
1234 ;; 'texi-fragment->stexi' uses a string port so make sure it's a
1235 ;; Unicode-capable one (see <http://bugs.gnu.org/11197>.)
1236 (with-fluids ((%default-port-encoding "UTF-8"))
1237 (stexi->plain-text (texi-fragment->stexi str))))
1239 (define (package-field-string package field-accessor)
1240 "Return a plain-text representation of PACKAGE field."
1241 (and=> (field-accessor package)
1242 (compose texi->plain-text P_)))
1244 (define (package-description-string package)
1245 "Return a plain-text representation of PACKAGE description field."
1246 (package-field-string package package-description))
1248 (define (package-synopsis-string package)
1249 "Return a plain-text representation of PACKAGE synopsis field."
1250 (package-field-string package package-synopsis))
1252 (define (string->recutils str)
1253 "Return a version of STR where newlines have been replaced by newlines
1254 followed by \"+ \", which makes for a valid multi-line field value in the
1257 (string-fold-right (lambda (chr result)
1258 (if (eqv? chr #\newline)
1259 (cons* chr #\+ #\space result)
1264 (define (hyperlink uri text)
1265 "Return a string that denotes a hyperlink using an OSC escape sequence as
1267 <https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda>."
1268 (string-append "\x1b]8;;" uri "\x1b\\"
1269 text "\x1b]8;;\x1b\\"))
1271 (define* (supports-hyperlinks? #:optional (port (current-output-port)))
1272 "Return true if PORT is a terminal that supports hyperlink escapes."
1273 ;; Note that terminals are supposed to ignore OSC escapes they don't
1274 ;; understand (this is the case of xterm as of version 349, for instance.)
1275 ;; However, Emacs comint as of 26.3 does not ignore it and instead lets it
1276 ;; through, hence the 'INSIDE_EMACS' special case below.
1277 (and (isatty?* port)
1278 (not (getenv "INSIDE_EMACS"))))
1280 (define* (file-hyperlink file #:optional (text file))
1281 "Return TEXT with escapes for a hyperlink to FILE."
1282 (hyperlink (string-append "file://" (gethostname)
1283 (encode-and-join-uri-path
1284 (string-split file #\/)))
1287 (define (location->hyperlink location)
1288 "Return a string corresponding to LOCATION, with escapes for a hyperlink."
1289 (let ((str (location->string location))
1290 (file (if (string-prefix? "/" (location-file location))
1291 (location-file location)
1292 (search-path %load-path (location-file location)))))
1294 (file-hyperlink file str)
1297 (define* (package->recutils p port #:optional (width (%text-width))
1299 (hyperlinks? (supports-hyperlinks? port))
1301 "Write to PORT a `recutils' record of package P, arranging to fit within
1302 WIDTH columns. EXTRA-FIELDS is a list of symbol/value pairs to emit. When
1303 HYPERLINKS? is true, emit hyperlink escape sequences when appropriate."
1305 ;; The available number of columns once we've taken into account space for
1306 ;; the initial "+ " prefix.
1307 (if (> width 2) (- width 2) width))
1309 (define (dependencies->recutils packages)
1310 (let ((list (string-join (delete-duplicates
1311 (map package-full-name
1312 (sort packages package<?))) " ")))
1314 (fill-paragraph list width*
1315 (string-length "dependencies: ")))))
1317 (define (package<? p1 p2)
1318 (string<? (package-full-name p1) (package-full-name p2)))
1320 ;; Note: Don't i18n field names so that people can post-process it.
1321 (format port "name: ~a~%" (package-name p))
1322 (format port "version: ~a~%" (package-version p))
1323 (format port "outputs: ~a~%" (string-join (package-outputs p)))
1324 (format port "systems: ~a~%"
1325 (string-join (package-transitive-supported-systems p)))
1326 (format port "dependencies: ~a~%"
1327 (match (package-direct-inputs p)
1328 (((labels inputs . _) ...)
1329 (dependencies->recutils (filter package? inputs)))))
1330 (format port "location: ~a~%"
1331 (or (and=> (package-location p)
1332 (if hyperlinks? location->hyperlink location->string))
1335 ;; Note: Starting from version 1.6 or recutils, hyphens are not allowed in
1336 ;; field identifiers.
1337 (format port "homepage: ~a~%" (package-home-page p))
1339 (format port "license: ~a~%"
1340 (match (package-license p)
1341 (((? license? licenses) ...)
1342 (string-join (map license-name licenses)
1344 ((? license? license)
1345 (let ((text (license-name license))
1346 (uri (license-uri license)))
1347 (if (and hyperlinks? uri (string-prefix? "http" uri))
1348 (hyperlink uri text)
1352 (format port "synopsis: ~a~%"
1353 (string-map (match-lambda
1356 (or (and=> (package-synopsis-string p) P_)
1361 (parameterize ((%text-width width*))
1363 (string-append "description: "
1364 (or (and=> (package-description p) P_)
1367 (for-each (match-lambda
1369 (let ((field (symbol->string field)))
1370 (format port "~a: ~a~%"
1372 (fill-paragraph (object->string value) width*
1373 (string-length field))))))
1382 (define (relevance obj regexps metrics)
1383 "Compute a \"relevance score\" for OBJ as a function of its number of
1384 matches of REGEXPS and accordingly to METRICS. METRICS is list of
1385 field/weight pairs, where FIELD is a procedure that returns a string or list
1386 of strings describing OBJ, and WEIGHT is a positive integer denoting the
1387 weight of this field in the final score.
1389 A score of zero means that OBJ does not match any of REGEXPS. The higher the
1390 score, the more relevant OBJ is to REGEXPS."
1391 (define (score regexp str)
1392 (fold-matches regexp str 0
1395 (if (string=? (match:substring m) str)
1399 (define (regexp->score regexp)
1400 (let ((score-regexp (lambda (str) (score regexp str))))
1401 (fold (lambda (metric relevance)
1407 (+ relevance (* (score-regexp str) weight)))
1409 (+ relevance (* weight (apply + (map score-regexp lst)))))))))
1412 (let ((scores (map regexp->score regexps)))
1413 ;; Return zero if one of REGEXPS doesn't match.
1414 (if (any zero? scores)
1416 (reduce + 0 scores))))
1418 (define %package-metrics
1419 ;; Metrics used to compute the "relevance score" of a package against a set
1421 `((,package-name . 4)
1423 ;; Match against uncommon outputs.
1425 (filter (lambda (output)
1427 ;; Some common outpus shared by many packages.
1428 '("out" "doc" "debug" "lib" "include" "bin"))))
1429 (package-outputs package)))
1432 ;; Match regexps on the raw Texinfo since formatting it is quite expensive
1433 ;; and doesn't have much of an effect on search results.
1435 (and=> (package-synopsis package) P_)) . 3)
1437 (and=> (package-description package) P_)) . 2)
1440 (match (and=> (package-location type) location-file)
1441 ((? string? file) (basename file ".scm"))
1445 (define (package-relevance package regexps)
1446 "Return a score denoting the relevance of PACKAGE for REGEXPS. A score of
1447 zero means that PACKAGE does not match any of REGEXPS."
1448 (relevance package regexps %package-metrics))
1450 (define* (display-search-results matches port
1452 (command "guix search")
1453 (print package->recutils))
1454 "Display MATCHES, a list of object/score pairs, by calling PRINT on each of
1455 them. If PORT is a terminal, print at most a full screen of results."
1460 (and first-line (isatty? port)
1461 (terminal-rows port)))
1463 (define (line-count str)
1464 (string-count str #\newline))
1466 (let loop ((matches matches))
1468 (((package . score) rest ...)
1469 (let* ((links? (supports-hyperlinks? port))
1470 (text (call-with-output-string
1473 #:hyperlinks? links?
1475 `((relevance . ,score)))))))
1477 (> (port-line port) first-line) ;print at least one result
1478 (> (+ 4 (line-count text) (port-line port))
1480 (unless (null? rest)
1481 (display-hint (format #f (G_ "Run @code{~a ... | less} \
1482 to view all the results.")
1491 (define (string->generations str)
1492 "Return the list of generations matching a pattern in STR. This function
1493 accepts the following patterns: \"1\", \"1,2,3\", \"1..9\", \"1..\", \"..9\"."
1494 (define (maybe-integer)
1495 (let ((x (string->number str)))
1499 (define (maybe-comma-separated-integers)
1500 (let ((lst (delete-duplicates
1502 (string-split str #\,)))))
1503 (and (every integer? lst)
1506 (cond ((maybe-integer)
1509 ((maybe-comma-separated-integers)
1512 ((string-match "^([0-9]+)\\.\\.([0-9]+)$" str)
1515 (let ((s (string->number (match:substring match 1)))
1516 (e (string->number (match:substring match 2))))
1517 (and (every integer? (list s e))
1519 (iota (1+ (- e s)) s)))))
1520 ((string-match "^([0-9]+)\\.\\.$" str)
1523 (let ((s (string->number (match:substring match 1))))
1526 ((string-match "^\\.\\.([0-9]+)$" str)
1529 (let ((e (string->number (match:substring match 1))))
1534 (define (string->duration str)
1535 "Return the duration matching a pattern in STR. This function accepts the
1536 following patterns: \"1d\", \"1w\", \"1m\"."
1537 (define (hours->duration hours match)
1538 (make-time time-duration 0
1539 (* 3600 hours (string->number (match:substring match 1)))))
1541 (cond ((string-match "^([0-9]+)s$" str)
1544 (make-time time-duration 0
1545 (string->number (match:substring match 1)))))
1546 ((string-match "^([0-9]+)h$" str)
1549 (hours->duration 1 match)))
1550 ((string-match "^([0-9]+)d$" str)
1553 (hours->duration 24 match)))
1554 ((string-match "^([0-9]+)w$" str)
1557 (hours->duration (* 24 7) match)))
1558 ((string-match "^([0-9]+)m$" str)
1561 (hours->duration (* 24 30) match)))
1564 (define* (matching-generations str profile
1565 #:key (duration-relation <=))
1566 "Return the list of available generations matching a pattern in STR. See
1567 'string->generations' and 'string->duration' for the list of valid patterns.
1568 When STR is a duration pattern, return all the generations whose ctime has
1569 DURATION-RELATION with the current time."
1570 (define (valid-generations lst)
1571 (define (valid-generation? n)
1572 (any (cut = n <>) (generation-numbers profile)))
1574 (fold-right (lambda (x acc)
1575 (if (valid-generation? x)
1581 (define (filter-generations generations)
1585 (drop-while (cut > n <>)
1586 (generation-numbers profile)))
1588 (valid-generations (iota n 1)))
1590 (valid-generations lst))
1593 (define (filter-by-duration duration)
1594 (define (time-at-midnight time)
1595 ;; Return TIME at midnight by setting nanoseconds, seconds, minutes, and
1597 (let ((d (time-utc->date time)))
1600 (date-day d) (date-month d)
1601 (date-year d) (date-zone-offset d)))))
1603 (define generation-ctime-alist
1604 (map (lambda (number)
1608 (generation-time profile number)))))
1609 (generation-numbers profile)))
1614 (let ((s (time-second
1615 (subtract-duration (time-at-midnight (current-time))
1617 (delete #f (map (lambda (x)
1618 (and (duration-relation s (cdr x))
1620 generation-ctime-alist))))))
1622 (cond ((string->generations str)
1625 ((string->duration str)
1630 (condition (&message
1631 (message (format #f (G_ "invalid syntax: ~a~%")
1634 (define (display-generation profile number)
1635 "Display a one-line summary of generation NUMBER of PROFILE."
1636 (unless (zero? number)
1637 (let* ((file (generation-file-name profile number))
1638 (link (if (supports-hyperlinks?)
1639 (cut file-hyperlink file <>)
1641 (header (format #f (link (highlight (G_ "Generation ~a\t~a")))
1645 (generation-time profile number))
1646 ;; TRANSLATORS: This is a format-string for date->string.
1647 ;; Please choose a format that corresponds to the
1648 ;; usual way of presenting dates in your locale.
1649 ;; See https://www.gnu.org/software/guile/manual/html_node/SRFI_002d19-Date-to-string.html
1651 (G_ "~b ~d ~Y ~T"))))
1652 (current (generation-number profile)))
1653 (if (= number current)
1654 ;; TRANSLATORS: The word "current" here is an adjective for
1655 ;; "Generation", as in "current generation". Use the appropriate
1656 ;; gender where applicable.
1657 (format #t (G_ "~a\t(current)~%") header)
1658 (format #t "~a~%" header)))))
1660 (define (display-profile-content-diff profile gen1 gen2)
1661 "Display the changed packages in PROFILE GEN2 compared to generation GEN1."
1663 (define (equal-entry? first second)
1664 (string= (manifest-entry-item first) (manifest-entry-item second)))
1666 (define (display-entry entry prefix)
1668 (($ <manifest-entry> name version output location _)
1669 (format #t " ~a ~a\t~a\t~a\t~a~%" prefix name version output location))))
1671 (define (list-entries number)
1672 (manifest-entries (profile-manifest (generation-file-name profile number))))
1674 (define (display-diff profile old new)
1675 (display-generation profile new)
1676 (let ((added (lset-difference
1677 equal-entry? (list-entries new) (list-entries old)))
1678 (removed (lset-difference
1679 equal-entry? (list-entries old) (list-entries new))))
1680 (for-each (cut display-entry <> "+") added)
1681 (for-each (cut display-entry <> "-") removed)
1684 (display-diff profile gen1 gen2))
1686 (define (profile-lock-handler profile errno . _)
1687 "Handle failure to acquire PROFILE's lock."
1688 ;; NFS mounts can return ENOLCK. When that happens, there's not much that
1689 ;; can be done, so warn the user and keep going.
1690 (if (= errno ENOLCK)
1691 (warning (G_ "cannot lock profile ~a: ~a~%")
1692 profile (strerror errno))
1693 (leave (G_ "profile ~a is locked by another process~%")
1696 (define profile-lock-file
1697 (cut string-append <> ".lock"))
1699 (define-syntax-rule (with-profile-lock profile exp ...)
1700 "Grab PROFILE's lock and evaluate EXP... Call 'leave' if the lock is
1702 (with-file-lock/no-wait (profile-lock-file profile)
1703 (cut profile-lock-handler profile <...>)
1706 (define (display-profile-content profile number)
1707 "Display the packages in PROFILE, generation NUMBER, in a human-readable
1709 (for-each (match-lambda
1710 (($ <manifest-entry> name version output location _)
1711 (format #t " ~a\t~a\t~a\t~a~%"
1712 name version output location)))
1714 ;; Show most recently installed packages last.
1717 (profile-manifest (generation-file-name profile number))))))
1719 (define (display-generation-change previous current)
1720 (format #t (G_ "switched from generation ~a to ~a~%") previous current))
1722 (define (roll-back* store profile)
1723 "Like 'roll-back', but display what is happening."
1726 (roll-back store profile))
1727 display-generation-change))
1729 (define (switch-to-generation* profile number)
1730 "Like 'switch-generation', but display what is happening."
1731 (let ((previous (switch-to-generation profile number)))
1732 (display-generation-change previous number)))
1734 (define (delete-generation* store profile generation)
1735 "Like 'delete-generation', but display what is going on."
1736 (format #t (G_ "deleting ~a~%")
1737 (generation-file-name profile generation))
1738 (delete-generation store profile generation))
1740 (define* (package-specification->name+version+output spec
1741 #:optional (output "out"))
1742 "Parse package specification SPEC and return three value: the specified
1743 package name, version number (or #f), and output name (or OUTPUT). SPEC may
1744 optionally contain a version number and an output name, as in these examples:
1751 (let*-values (((name sub-drv)
1752 (match (string-rindex spec #\:)
1753 (#f (values spec output))
1754 (colon (values (substring spec 0 colon)
1755 (substring spec (+ 1 colon))))))
1757 (package-name->name+version name)))
1758 (values name version sub-drv)))
1762 ;;; Command-line option processing.
1765 (define (show-guix-usage)
1766 (format (current-error-port)
1767 (G_ "Try `guix --help' for more information.~%"))
1770 (define (command-files)
1771 "Return the list of source files that define Guix sub-commands."
1773 (and=> (search-path %load-path "guix.scm")
1774 (compose (cut string-append <> "/guix/scripts")
1778 (cut string-suffix? ".scm" <>))
1781 (scandir directory dot-scm?)
1785 "Return the list of Guix command names."
1786 (map (compose (cut string-drop-right <> 4)
1790 (define (show-guix-help)
1791 (define (internal? command)
1792 (member command '("substitute" "authenticate" "offload"
1793 "perform-download")))
1795 (format #t (G_ "Usage: guix COMMAND ARGS...
1796 Run COMMAND with ARGS.\n"))
1798 (format #t (G_ "COMMAND must be one of the sub-commands listed below:\n"))
1800 ;; TODO: Display a synopsis of each command.
1801 (format #t "~{ ~a~%~}" (sort (remove internal? (commands))
1803 (show-bug-report-information))
1805 (define (run-guix-command command . args)
1806 "Run COMMAND with the given ARGS. Report an error when COMMAND is not
1811 (resolve-interface `(guix scripts ,command)))
1813 (format (current-error-port)
1814 (G_ "guix: ~a: command not found~%") command)
1815 (show-guix-usage))))
1817 (let ((command-main (module-ref module
1818 (symbol-append 'guix- command))))
1819 (parameterize ((program-name command))
1820 ;; Disable canonicalization so we don't don't stat unreasonably.
1821 (with-fluids ((%file-port-name-canonicalization #f))
1825 (apply command-main args))
1827 ;; Abuse 'exit-hook' (which is normally meant to be used by the
1828 ;; REPL) to run things like profiling hooks upon completion.
1829 (run-hook exit-hook)))))))
1831 (define (run-guix . args)
1832 "Run the 'guix' command defined by command line ARGS.
1833 Unlike 'guix-main', this procedure assumes that locale, i18n support,
1834 and signal handling has already been set up."
1835 (define option? (cut string-prefix? "-" <>))
1837 ;; The default %LOAD-EXTENSIONS includes the empty string, which doubles the
1838 ;; number of 'stat' calls per entry in %LOAD-PATH. Shamelessly remove it.
1839 (set! %load-extensions '(".scm"))
1843 (format (current-error-port)
1844 (G_ "guix: missing command name~%"))
1846 ((or ("-h") ("--help"))
1848 ((or ("-V") ("--version"))
1849 (show-version-and-exit "guix"))
1850 (((? option? o) args ...)
1851 (format (current-error-port)
1852 (G_ "guix: unrecognized option '~a'~%") o)
1855 (apply run-guix-command (string->symbol command)
1860 (apply run-guix-command
1861 (string->symbol command)
1864 (define (guix-main arg0 . args)
1866 (apply run-guix args))
1868 ;;; ui.scm ends here