summaryrefslogtreecommitdiff
path: root/guix/scripts/import.scm
blob: 5de5fc9e000fa8d7ce27aaeb6e4b23b5ee30102f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2012-2014, 2020-2023 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2014 David Thompson <davet@gnu.org>
;;; Copyright © 2018 Kyle Meyer <kyle@kyleam.com>
;;; Copyright © 2019, 2022 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2021 Simon Tournier <zimon.toutoune@gmail.com>
;;; Copyright © 2021 Xinglu Chen <public@yoctocell.xyz>
;;; Copyright © 2022 Philip McGrath <philip@philipmcgrath.com>
;;; Copyright © 2024 Herman Rimm <herman@rimm.ee>
;;;
;;; 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 import)
  #:use-module (guix import utils)
  #:use-module (guix diagnostics)
  #:use-module (guix i18n)
  #:use-module (guix ui)
  #:use-module (guix scripts)
  #:use-module (guix read-print)
  #:use-module (guix utils)
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-26)
  #:use-module (srfi srfi-37)
  #:use-module (ice-9 format)
  #:use-module (ice-9 match)
  #:export (%standard-import-options
            guix-import))


;;;
;;; Command line options.
;;;

(define %standard-import-options
  (list
   ;; Hidden option for importer-specific file preprocessing.
   (option '("file-to-insert") #f #t
           (lambda (opt name arg result)
             (if (file-exists? arg)
                 (alist-cons 'file-to-insert arg result)
                 (leave (G_ "file '~a' does not exist~%") arg))))))


;;;
;;; Entry point.
;;;

;; The list of all known importers.  These are printed in order by SHOW-HELP, so
;; please keep this list alphabetically sorted!
(define importers '("composer" "cpan" "cran" "crate" "egg" "elm" "elpa"
                    "gem" "gnu" "go" "hackage" "hexpm" "json" "luanti"
                    "minetest"          ; deprecated
                    "npm-binary" "nuget" "opam" "pypi" "stackage" "texlive"))

(define (resolve-importer name)
  (let ((module (resolve-interface
                 `(guix scripts import ,(string->symbol name))))
        (proc (string->symbol (string-append "guix-import-" name))))
    (module-ref module proc)))

(define (show-help)
  (display (G_ "Usage: guix import IMPORTER ARGS ...
Run IMPORTER with ARGS.\n"))
  (newline)
  (display (G_ "IMPORTER must be one of the importers listed below:\n"))
  (newline)
  (format #t "~{   ~a~%~}" importers)
  (display (G_ "
  -h, --help             display this help and exit"))
  (display (G_ "
  -i, --insert=FILE      insert packages into FILE alphabetically"))
  (display (G_ "
  -V, --version          display version information and exit"))
  (newline)
  (show-bug-report-information))

(define (import-as-definitions importer args proc)
  "Wrap package expressions from IMPORTER with 'define-public and invoke
PROC callback."
  (if (member importer importers)
      (match (apply (resolve-importer importer) args)
        ((and expr (or ('package _ ...)
                       ('let _ ...)))
         (proc (package->definition expr)))
        ((and expr (or ('define-public _ ...)
                       ('define _ ...)))
         (proc expr))
        ((expressions ...)
         (for-each (lambda (expr)
                     (match expr
                       ((and expr (or ('package _ ...)
                                      ('let _ ...)))
                        (proc (package->definition expr)))
                       ((and expr (or ('define-public _ ...)
                                      ('define _ ...)))
                        (proc expr))))
                   expressions))
        (x
         (leave (G_ "'~a' import failed~%") importer)))
      (let ((hint (string-closest importer importers #:threshold 3)))
        (report-error (G_ "~a: invalid importer~%") importer)
        (when hint
          (display-hint (G_ "Did you mean @code{~a}?~%") hint))
        (exit 1))))

(define-command (guix-import . args)
  (category packaging)
  (synopsis "import a package definition from an external repository")

  (define (process-args args)
    (match args
      ;; Workaround to accpet ‘--insert=FILE’, for the consistency of
      ;; command-line interface.
      ((arg . rest)
       (if (string-prefix? "--insert=" arg)
           (append (string-split arg #\=)
                   rest)
           args))
      (_ args)))

  (match (process-args args)
    (()
     (format (current-error-port)
             (G_ "guix import: missing importer name~%")))
    ((or ("-h" _ ...) ("--help" _ ...))
     (leave-on-EPIPE (show-help))
     (exit 0))
    ((or ("-V" _ ...) ("--version" _ ...))
     (show-version-and-exit "guix import"))
    ((or ("-i" file importer args ...)
         ("--insert" file importer args ...))
     (let* ((define-prefixes
             `(,@(if (member importer '("crate"))
                     '(define)
                     '())
               define-public))
            (define-prefix? (cut member <> define-prefixes))
            (find-and-insert
             (lambda (expr)
               (match expr
                 (((? define-prefix? define-prefix) term _ ...)
                  ;; Skip existing definition.
                  (unless (find-definition-location
                           file term #:define-prefix define-prefix)
                    (let ((source-properties
                           (find-definition-insertion-location
                            file term #:define-prefix define-prefix)))
                      (if source-properties
                          (insert-expression source-properties expr)
                          (let ((port (open-file file "a")))
                            (pretty-print-with-comments port expr)
                            (newline port)
                            (newline port)
                            (close-port port))))))))))
       (import-as-definitions importer
                              (cons (string-append "--file-to-insert=" file)
                                    args)
                              find-and-insert)))
    ((importer args ...)
     (let ((print (lambda (expr)
                    (leave-on-EPIPE
                      (pretty-print-with-comments
                        (current-output-port) expr)
                      ;; Two newlines: one after the closing paren, and
                      ;; one to leave a blank line.
                      (newline) (newline)))))
       (import-as-definitions importer args print)))))