aboutsummaryrefslogtreecommitdiff
path: root/gnu/installer/build-installer.scm
blob: c7f439b35fb08d6a25fc46d1a40e33291f5fde9d (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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2018 Mathieu Othacehe <m.othacehe@gmail.com>
;;;
;;; 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 (gnu installer build-installer)
  #:use-module (guix packages)
  #:use-module (guix gexp)
  #:use-module (guix modules)
  #:use-module (guix utils)
  #:use-module (guix ui)
  #:use-module ((guix self) #:select (make-config.scm))
  #:use-module (gnu installer)
  #:use-module (gnu packages admin)
  #:use-module (gnu packages base)
  #:use-module (gnu packages bash)
  #:use-module (gnu packages connman)
  #:use-module (gnu packages guile)
  #:autoload   (gnu packages gnupg) (guile-gcrypt)
  #:use-module (gnu packages iso-codes)
  #:use-module (gnu packages linux)
  #:use-module (gnu packages ncurses)
  #:use-module (gnu packages package-management)
  #:use-module (gnu packages xorg)
  #:use-module (ice-9 match)
  #:use-module (srfi srfi-1)
  #:export (installer-program
            installer-program-launcher))

(define not-config?
  ;; Select (guix …) and (gnu …) modules, except (guix config).
  (match-lambda
    (('guix 'config) #f)
    (('guix rest ...) #t)
    (('gnu rest ...) #t)
    (rest #f)))

(define* (build-compiled-file name locale-builder)
  "Return a file-like object that evalutes the gexp LOCALE-BUILDER and store
its result in the scheme file NAME. The derivation will also build a compiled
version of this file."
  (define set-utf8-locale
    #~(begin
        (setenv "LOCPATH"
                #$(file-append glibc-utf8-locales "/lib/locale/"
                               (version-major+minor
                                (package-version glibc-utf8-locales))))
        (setlocale LC_ALL "en_US.utf8")))

  (define builder
    (with-extensions (list guile-json)
      (with-imported-modules (source-module-closure
                              '((gnu installer locale)))
        #~(begin
            (use-modules (gnu installer locale))

            ;; The locale files contain non-ASCII characters.
            #$set-utf8-locale

            (mkdir #$output)
            (let ((locale-file
                   (string-append #$output "/" #$name ".scm"))
                  (locale-compiled-file
                   (string-append #$output "/" #$name ".go")))
              (call-with-output-file locale-file
                (lambda (port)
                  (write #$locale-builder port)))
              (compile-file locale-file
                            #:output-file locale-compiled-file))))))
  (computed-file name builder))

(define apply-locale
  ;; Install the specified locale.
  #~(lambda (locale-name)
      (false-if-exception
       (setlocale LC_ALL locale-name))))

(define* (compute-locale-step installer
                              #:key
                              locales-name
                              iso639-languages-name
                              iso3166-territories-name)
  "Return a gexp that run the locale-page of INSTALLER, and install the
selected locale. The list of locales, languages and territories passed to
locale-page are computed in derivations named respectively LOCALES-NAME,
ISO639-LANGUAGES-NAME and ISO3166-TERRITORIES-NAME. Those lists are compiled,
so that when the installer is run, all the lengthy operations have already
been performed at build time."
  (define (compiled-file-loader file name)
    #~(load-compiled
       (string-append #$file "/" #$name ".go")))

  (let* ((supported-locales #~(supported-locales->locales
                               #$(local-file "aux-files/SUPPORTED")))
         (iso-codes #~(string-append #$iso-codes "/share/iso-codes/json/"))
         (iso639-3 #~(string-append #$iso-codes "iso_639-3.json"))
         (iso639-5 #~(string-append #$iso-codes "iso_639-5.json"))
         (iso3166 #~(string-append #$iso-codes "iso_3166-1.json"))
         (locales-file (build-compiled-file
                        locales-name
                        #~`(quote ,#$supported-locales)))
         (iso639-file (build-compiled-file
                       iso639-languages-name
                       #~`(quote ,(iso639->iso639-languages
                                   #$supported-locales
                                   #$iso639-3 #$iso639-5))))
         (iso3166-file (build-compiled-file
                        iso3166-territories-name
                        #~`(quote ,(iso3166->iso3166-territories #$iso3166))))
         (locales-loader (compiled-file-loader locales-file
                                               locales-name))
         (iso639-loader (compiled-file-loader iso639-file
                                              iso639-languages-name))
         (iso3166-loader (compiled-file-loader iso3166-file
                                               iso3166-territories-name)))
    #~(let ((result
             (#$(installer-locale-page installer)
              #:supported-locales #$locales-loader
              #:iso639-languages #$iso639-loader
              #:iso3166-territories #$iso3166-loader)))
        (#$apply-locale result))))

(define apply-keymap
  ;; Apply the specified keymap.
  #~(match-lambda
      ((model layout variant)
       (kmscon-update-keymap model layout variant))))

(define* (compute-keymap-step installer)
  "Return a gexp that runs the keymap-page of INSTALLER and install the
selected keymap."
  #~(let ((result
           (call-with-values
               (lambda ()
                 (xkb-rules->models+layouts
                  (string-append #$xkeyboard-config
                                 "/share/X11/xkb/rules/base.xml")))
             (lambda (models layouts)
               (#$(installer-keymap-page installer)
                #:models models
                #:layouts layouts)))))
      (#$apply-keymap result)))

(define (installer-steps installer)
  (let ((locale-step (compute-locale-step
                      installer
                      #:locales-name "locales"
                      #:iso639-languages-name "iso639-languages"
                      #:iso3166-territories-name "iso3166-territories"))
        (keymap-step (compute-keymap-step installer))
        (timezone-data #~(string-append #$tzdata
                                        "/share/zoneinfo/zone.tab")))
    #~(list
       ;; Welcome the user and ask him to choose between manual installation
       ;; and graphical install.
       (installer-step
        (id 'welcome)
        (compute (lambda _
                   #$(installer-welcome-page installer))))

       ;; Ask the user to choose a locale among those supported by the glibc.
       ;; Install the selected locale right away, so that the user may
       ;; benefit from any available translation for the installer messages.
       (installer-step
        (id 'locale)
        (description (G_ "Locale selection"))
        (compute (lambda _
                   #$locale-step)))

       ;; Ask the user to select a timezone under glibc format.
       (installer-step
        (id 'timezone)
        (description (G_ "Timezone selection"))
        (compute (lambda _
                   (#$(installer-timezone-page installer)
                    #$timezone-data))))

       ;; The installer runs in a kmscon virtual terminal where loadkeys
       ;; won't work. kmscon uses libxkbcommon as a backend for keyboard
       ;; input. It is possible to update kmscon current keymap by sending it
       ;; a keyboard model, layout and variant, in a somehow similar way as
       ;; what is done with setxkbmap utility.
       ;;
       ;; So ask for a keyboard model, layout and variant to update the
       ;; current kmscon keymap.
       (installer-step
        (id 'keymap)
        (description (G_ "Keyboard mapping selection"))
        (compute (lambda _
                   #$keymap-step)))

       ;; Ask the user to input a hostname for the system.
       (installer-step
        (id 'hostname)
        (description (G_ "Hostname selection"))
        (compute (lambda _
                   #$(installer-hostname-page installer))))

       ;; Provide an interface above connmanctl, so that the user can select
       ;; a network susceptible to acces Internet.
       (installer-step
        (id 'network)
        (description (G_ "Network selection"))
        (compute (lambda _
                   #$(installer-network-page installer))))

       ;; Prompt for users (name, group and home directory).
       (installer-step
        (id 'hostname)
        (description (G_ "User selection"))
        (compute (lambda _
                   #$(installer-user-page installer)))))))

(define (installer-program installer)
  "Return a file-like object that runs the given INSTALLER."
  (define init-gettext
    ;; Initialize gettext support, so that installer messages can be
    ;; translated.
    #~(begin
        (bindtextdomain "guix" (string-append #$guix "/share/locale"))
        (textdomain "guix")))

  (define set-installer-path
    ;; Add the specified binary to PATH for later use by the installer.
    #~(let* ((inputs
              '#$(append (list bash connman shadow)
                         (map canonical-package (list coreutils)))))
        (with-output-to-port (%make-void-port "w")
          (lambda ()
            (set-path-environment-variable "PATH" '("bin" "sbin") inputs)))))

  (define installer-builder
    (with-extensions (list guile-gcrypt guile-newt guile-json)
      (with-imported-modules `(,@(source-module-closure
                                  `(,@(installer-modules installer)
                                    (guix build utils))
                                  #:select? not-config?)
                               ((guix config) => ,(make-config.scm)))
        #~(begin
            (use-modules (gnu installer keymap)
                         (gnu installer steps)
                         (gnu installer locale)
                         #$@(installer-modules installer)
                         (guix i18n)
                         (guix build utils)
                         (ice-9 match))

            ;; Initialize gettext support so that installers can use
            ;; (guix i18n) module.
            #$init-gettext

            ;; Add some binaries used by the installers to PATH.
            #$set-installer-path

            #$(installer-init installer)

            (catch #t
              (lambda ()
                (run-installer-steps
                 #:rewind-strategy 'menu
                 #:menu-proc #$(installer-menu-page installer)
                 #:steps #$(installer-steps installer)))
              (const #f)
              (lambda (key . args)
                (#$(installer-exit-error installer) key args)

                ;; Be sure to call newt-finish, to restore the terminal into
                ;; its original state before printing the error report.
                (call-with-output-file "/tmp/error"
                  (lambda (port)
                    (display-backtrace (make-stack #t) port)
                    (print-exception port
                                     (stack-ref (make-stack #t) 1)
                                     key args)))
                (primitive-exit 1)))
            #$(installer-exit installer)))))

  (program-file "installer" installer-builder))

;; We want the installer to honor the LANG environment variable, so that the
;; locale is correctly installed when the installer is launched, and the
;; welcome page is possibly translated.  The /etc/environment file (containing
;; LANG) is supposed to be loaded using PAM by the login program. As the
;; installer replaces the login program, read this file and set all the
;; variables it contains before starting the installer. This is a dirty hack,
;; we might want to find a better way to do it in the future.
(define (installer-program-launcher installer)
  "Return a file-like object that set the variables in /etc/environment and
run the given INSTALLER."
  (define load-environment
    #~(call-with-input-file "/etc/environment"
        (lambda (port)
          (let ((lines (read-lines port)))
            (map (lambda (line)
                   (match (string-split line #\=)
                     ((name value)
                      (setenv name value))))
                 lines)))))

  (define wrapper
    (with-imported-modules '((gnu installer utils))
      #~(begin
          (use-modules (gnu installer utils)
                       (ice-9 match))

          #$load-environment
          (system #$(installer-program installer)))))

  (program-file "installer-launcher" wrapper))