aboutsummaryrefslogtreecommitdiff
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2017, 2022 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2023, 2024 Nicolas Goaziou <mail@nicolasgoaziou.fr>
;;;
;;; 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 (test-texlive)
  #:use-module (gnu packages tex)
  #:use-module (guix import texlive)
  #:use-module (guix tests)
  #:use-module (guix tests http)
  #:use-module (guix build utils)
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-64)
  #:use-module (srfi srfi-26)
  #:use-module (web client)
  #:use-module (ice-9 match))

(test-begin "texlive")

(define %fake-tlpdb
  '((database-revision . 12345)
    ("12many"
     . ((name
         . "12many")
        (catalogue
         . "one2many")
        (shortdesc
         . "Generalising mathematical index sets")
        (longdesc
         . "In the discrete branches of mathematics...")
        (docfiles
         . ("texmf-dist/doc/latex/12many/12many.pdf"
            "texmf-dist/doc/latex/12many/README"))
        (srcfiles
         . ("texmf-dist/source/latex/12many/12many.dtx"
            "texmf-dist/source/latex/12many/12many.ins"))
        (runfiles
         . ("texmf-dist/tex/latex/12many/12many.sty"))
        (catalogue-license . "lppl")))
    ("adforn"
     (name . "adforn")
     (shortdesc . "OrnementsADF font with TeX/LaTeX support")
     (longdesc . "The bundle provides the Ornements ADF font...")
     (execute "addMap OrnementsADF.map")
     (docfiles
      "texmf-dist/doc/fonts/adforn/COPYING"
      "texmf-dist/doc/fonts/adforn/NOTICE"
      "texmf-dist/doc/fonts/adforn/README"
      "texmf-dist/doc/fonts/adforn/adforn.pdf")
     (runfiles
      "texmf-dist/fonts/afm/arkandis/adforn/OrnementsADF.afm"
      "texmf-dist/fonts/enc/dvips/adforn/OrnementsADF.enc"
      "texmf-dist/fonts/map/dvips/adforn/OrnementsADF.map"
      "texmf-dist/fonts/tfm/arkandis/adforn/OrnementsADF.tfm"
      "texmf-dist/fonts/type1/arkandis/adforn/OrnementsADF.pfb"
      "texmf-dist/tex/latex/adforn/adforn.sty"
      "texmf-dist/tex/latex/adforn/uornementsadf.fd")
     (catalogue-license . "lppl gpl2"))
    ("authorindex"
     (name . "authorindex")
     (shortdesc . "Index citations by author names")
     (longdesc . "This package allows the user to...")
     (depend "authorindex.ARCH")
     (docfiles "texmf-dist/doc/latex/authorindex/COPYING")
     (runfiles
      "texmf-dist/scripts/authorindex/authorindex"
      "texmf-dist/tex/latex/authorindex/authorindex.sty")
     (catalogue-license . "lppl"))
    ("authorindex.x86_64-linux"
     (name . "authorindex.x86_64-linux")
     (binfiles "bin/amd64-netbsd/authorindex"))
    ("chs-physics-report"
     . ((name . "ch-physics-report")
        (shortdesc . "Physics lab reports...")
        (longdesc . "This package may...")
        (docfiles
         .
         ("texmf-dist/doc/latex/chs-physics-report/README.txt"
          "texmf-dist/doc/latex/chs-physics-report/chs-physics-report.pdf"))
        (runfiles
         .
         ("texmf-dist/tex/latex/chs-physics-report/chs-physics-report.sty"))
        (catalogue-license . "pd cc-by-sa-3")))
    ("collection-basic"
     (name . "collection-basic")
     (shortdesc . "Essential programs and files")
     (longdesc . "These files are regarded as basic...")
     (depend "amsfonts" "hyph-utf8" "hyphen-base" "texlive-common"
             "texlive.infra" "tlshell"))
    ("collection-texworks"
     (name . "collection-texworks")
     (shortdesc . "TeXworks editor...")
     (longdesc . "See http...")
     (depend "texworks" "collection-basic"))
    ("cyrillic-bin"
     (name . "cyrillic-bin")
     (shortdesc . "Cyrillic bibtex and makeindex")
     (depend "cyrillic-bin.ARCH")
     (docfiles
      "texmf-dist/doc/man/man1/rubibtex.1"
      "texmf-dist/doc/man/man1/rubibtex.man1.pdf")
     (runfiles
      "texmf-dist/scripts/texlive-extra/rumakeindex.sh"
      "texmf-dist/scripts/texlive-extra/rubibtex.sh"))
    ("cyrillic-bin.x86_64-linux"
     (name . "cyrillic-bin.x86_64-linux")
     (shortdesc . "x86_64-linux files of cyrillic-bin")
     (binfiles
      "bin/x86_64-linux/rubibtex"
      "bin/x86_64-linux/rumakeindex"))
    ("example"
     . ((name . "example")
        (shortdesc . "Typeset examples...")
        (longdesc . "The package makes it easier...")
        (runfiles
         .
         ("texmf-dist/tex/latex/example/example.sty"))
        (catalogue-license . "gpl")))
    ("lollipop"
     (name . "lollipop")
     (shortdesc . "TeX made easy")
     (longdesc . "Lollipop is TeX made easy...")
     (execute "AddFormat name=lollipop engine=tex options=\"lollipop.ini\"...")
     (docfiles
      "texmf-dist/doc/otherformats/lollipop/README"
      "texmf-dist/doc/otherformats/lollipop/manual/address.tex"
      "texmf-dist/doc/otherformats/lollipop/manual/appendix.tex"
      "texmf-dist/doc/otherformats/lollipop/manual/btxmac.tex"
      "texmf-dist/doc/otherformats/lollipop/manual/comm.tex"
      "texmf-dist/doc/otherformats/lollipop/manual/comment.tex"
      "texmf-dist/doc/otherformats/lollipop/manual/example.tex"
      "texmf-dist/doc/otherformats/lollipop/manual/extern.tex"
      "texmf-dist/doc/otherformats/lollipop/manual/head.tex"
      "texmf-dist/doc/otherformats/lollipop/manual/list.tex"
      "texmf-dist/doc/otherformats/lollipop/manual/lollipop-manual.bib"
      "texmf-dist/doc/otherformats/lollipop/manual/lollipop-manual.pdf")
     (runfiles
      "texmf-dist/tex/lollipop/lollipop-define.tex"
      "texmf-dist/tex/lollipop/lollipop-document.tex"
      "texmf-dist/tex/lollipop/lollipop-float.tex"
      "texmf-dist/tex/lollipop/lollipop-fontdefs.tex"
      "texmf-dist/tex/lollipop/lollipop-fonts.tex"
      "texmf-dist/tex/lollipop/lollipop-heading.tex"
      "texmf-dist/tex/lollipop/lollipop-lists.tex"
      "texmf-dist/tex/lollipop/lollipop-output.tex"
      "texmf-dist/tex/lollipop/lollipop-plain.tex"
      "texmf-dist/tex/lollipop/lollipop-text.tex"
      "texmf-dist/tex/lollipop/lollipop-tools.tex"
      "texmf-dist/tex/lollipop/lollipop.ini"
      "texmf-dist/tex/lollipop/lollipop.tex")
     (catalogue-license . "gpl3"))
    ("m-tx"
     (name . "m-tx")
     (shortdesc . "A preprocessor for pmx")
     (longdesc . "M-Tx is a preprocessor to pmx")
     (depend "m-tx.ARCH")
     (runfiles "texmf-dist/scripts/m-tx/m-tx.lua"))
    ("m-tx.x86_64-linux"
     (name . "m-tx.x86_64-linux")
     (binfiles "bin/x86_64-linux/m-tx"
               "bin/x86_64-linux/prepmx"))
    ("pax"
     (name . "pax")
     (shortdesc . "Extract and reinsert PDF...")
     (longdesc . "If PDF files are...")
     (depend "pax.ARCH")
     (docfiles
      "texmf-dist/doc/latex/pax/README")
     (srcfiles
      "texmf-dist/source/latex/pax/Makefile"
      "texmf-dist/source/latex/pax/build.xml")
     (runfiles
      "texmf-dist/scripts/pax/pdfannotextractor.pl")
     (catalogue-license . "lppl gpl"))
    ("pax.x86_64-linux"
     (name . "pax.x86_64-linux")
     (shortdesc . "x86_64-linux files of pax")
     (binfiles
      "bin/x86_64-linux/pdfannotextractor"))
    ("r_und_s"
     (name . "r_und_s")
     (runfiles "texmf-dist/tex/latex/r_und_s/r_und_s.sty"))
    ("stricttex"
     . ((name
         . "stricttex")
        (shortdesc
         . "Strictly balanced brackets and numbers in command names")
        (longdesc
         . "This is a small, LuaLaTeX-only package providing you with three,
sometimes useful features: It allows you to make brackets [...]  \"strict\",
meaning that each [ must be balanced by a ]. It allows you to use numbers in
command names, so that you can do stuff like \\newcommand\\pi12{\\pi_{12}}. It
allows you to use numbers and primes in command names, so that you can do
stuff like \\newcommand\\pi'12{\\pi '_{12}}.")
        (docfiles
         . ("texmf-dist/doc/lualatex/stricttex/README.md"
            "texmf-dist/doc/lualatex/stricttex/stricttex.pdf"))
        (runfiles
         . ("texmf-dist/tex/lualatex/stricttex/stricttex.lua"
            "texmf-dist/tex/lualatex/stricttex/stricttex.sty"))
        (catalogue-license . "lppl1.3c")))
    ("tex"
     (name . "tex")
     (shortdesc . "A sophisticated typesetting engine")
     (longdesc . "TeX is a typesetting system that incorporates...")
     (depend "cm" "hyphen-base" "tex.ARCH")
     (docfiles "texmf-dist/doc/man/man1/tex.1")
     (catalogue-license . "knuth"))
    ("texsis"
     . ((name
         . "texsis")
        (shortdesc
         . "Plain TeX macros for Physicists")
        (longdesc
         . "TeXsis is a TeX macro package which provides useful features for
typesetting research papers and related documents. For example, it includes
support specifically for: Automatic numbering of equations, figures, tables
and references; Simplified control of type sizes, line spacing, footnotes,
running headlines and footlines, and tables of contents, figures and tables;
Specialized document formats for research papers, preprints and \"e-prints\",
conference proceedings, theses, books, referee reports, letters, and
memoranda; Simplified means of constructing an index for a book or thesis;
Easy to use double column formatting; Specialized environments for lists,
theorems and proofs, centered or non-justified text, and listing computer
code; Specialized macros for easily constructing ruled tables. TeXsis was
originally developed for physicists, but others may also find it useful. It is
completely compatible with Plain TeX.")
        (depend . ("tex" "plain" "knuth-lib" "hyphen-base" "cm"))
        (docfiles
         . ("texmf-dist/doc/man/man1/texsis.1"
            "texmf-dist/doc/man/man1/texsis.man1.pdf"
            "texmf-dist/doc/otherformats/texsis/base/COPYING"
            "texmf-dist/doc/otherformats/texsis/base/Example.tex"
            "texmf-dist/doc/otherformats/texsis/base/Fonts.tex"
            "texmf-dist/doc/otherformats/texsis/base/INSTALL"
            "texmf-dist/doc/otherformats/texsis/base/Install.tex"
            "texmf-dist/doc/otherformats/texsis/base/MANIFEST"
            "texmf-dist/doc/otherformats/texsis/base/Manual.fgl"
            "texmf-dist/doc/otherformats/texsis/base/Manual.ref"
            "texmf-dist/doc/otherformats/texsis/base/Manual.tbl"
            "texmf-dist/doc/otherformats/texsis/base/Manual.tex"
            "texmf-dist/doc/otherformats/texsis/base/NEWS"
            "texmf-dist/doc/otherformats/texsis/base/README"
            "texmf-dist/doc/otherformats/texsis/base/TXSapxF.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXScover.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSdcol.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSdoc.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSdoc0.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSdocM.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSend.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSenvmt.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSeqns.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSfigs.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSfmts.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSfonts.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSinstl.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSintro.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSletr.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSmisc.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSprns.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSrefs.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSrevs.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSruled.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSsects.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXSsite.000"
            "texmf-dist/doc/otherformats/texsis/base/TXSsymb.doc"
            "texmf-dist/doc/otherformats/texsis/base/TXStags.doc"
            "texmf-dist/doc/otherformats/texsis/base/index.tex"
            "texmf-dist/doc/otherformats/texsis/base/letr"
            "texmf-dist/doc/otherformats/texsis/base/penguin.eps"
            "texmf-dist/doc/otherformats/texsis/base/penguin2.eps"
            "texmf-dist/doc/otherformats/texsis/base/texsis.el"
            "texmf-dist/doc/otherformats/texsis/base/texsis.lsm"))
        (runfiles
         . ("texmf-dist/bibtex/bst/texsis/texsis.bst"
            "texmf-dist/tex/texsis/base/AIP.txs"
            "texmf-dist/tex/texsis/base/CVformat.txs"
            "texmf-dist/tex/texsis/base/Elsevier.txs"
            "texmf-dist/tex/texsis/base/Exam.txs"
            "texmf-dist/tex/texsis/base/Formletr.txs"
            "texmf-dist/tex/texsis/base/IEEE.txs"
            "texmf-dist/tex/texsis/base/PhysRev.txs"
            "texmf-dist/tex/texsis/base/Spanish.txs"
            "texmf-dist/tex/texsis/base/Swedish.txs"
            "texmf-dist/tex/texsis/base/TXSconts.tex"
            "texmf-dist/tex/texsis/base/TXSdcol.tex"
            "texmf-dist/tex/texsis/base/TXSenvmt.tex"
            "texmf-dist/tex/texsis/base/TXSeqns.tex"
            "texmf-dist/tex/texsis/base/TXSfigs.tex"
            "texmf-dist/tex/texsis/base/TXSfmts.tex"
            "texmf-dist/tex/texsis/base/TXSfonts.tex"
            "texmf-dist/tex/texsis/base/TXShead.tex"
            "texmf-dist/tex/texsis/base/TXSinit.tex"
            "texmf-dist/tex/texsis/base/TXSletr.tex"
            "texmf-dist/tex/texsis/base/TXSmacs.tex"
            "texmf-dist/tex/texsis/base/TXSmemo.tex"
            "texmf-dist/tex/texsis/base/TXSprns.tex"
            "texmf-dist/tex/texsis/base/TXSrefs.tex"
            "texmf-dist/tex/texsis/base/TXSruled.tex"
            "texmf-dist/tex/texsis/base/TXSsects.tex"
            "texmf-dist/tex/texsis/base/TXSsite.tex"
            "texmf-dist/tex/texsis/base/TXSsymb.tex"
            "texmf-dist/tex/texsis/base/TXStags.tex"
            "texmf-dist/tex/texsis/base/TXStitle.tex"
            "texmf-dist/tex/texsis/base/Tablebod.txs"
            "texmf-dist/tex/texsis/base/WorldSci.txs"
            "texmf-dist/tex/texsis/base/color.txs"
            "texmf-dist/tex/texsis/base/nuclproc.txs"
            "texmf-dist/tex/texsis/base/printfont.txs"
            "texmf-dist/tex/texsis/base/spine.txs"
            "texmf-dist/tex/texsis/base/texsis.tex"
            "texmf-dist/tex/texsis/base/thesis.txs"
            "texmf-dist/tex/texsis/base/twin.txs"
            "texmf-dist/tex/texsis/config/texsis.ini"))
        (catalogue-license . "lppl")))
    ("trsym"
     (name . "trsym")
     (shortdesc . "Symbols for transformations")
     (longdesc . "The bundle provides Metafont...")
     (docfiles "texmf-dist/doc/latex/trsym/README"
               "texmf-dist/doc/latex/trsym/manifest.txt"
               "texmf-dist/doc/latex/trsym/trsym.pdf")
     (srcfiles "texmf-dist/source/latex/trsym/trsym.dtx"
               "texmf-dist/source/latex/trsym/trsym.ins")
     (runfiles "texmf-dist/fonts/source/public/trsym/trsy.mf"
               "texmf-dist/fonts/source/public/trsym/trsy10.mf"
               "texmf-dist/fonts/source/public/trsym/trsy12.mf"
               "texmf-dist/fonts/tfm/public/trsym/trsy10.tfm"
               "texmf-dist/fonts/tfm/public/trsym/trsy12.tfm"
               "texmf-dist/tex/latex/trsym/trsym.sty"
               "texmf-dist/tex/latex/trsym/utrsy.fd")
     (catalogue-license . "lppl"))
    ("vlna"
     (name . "vlna")
     (shortdesc . "Add ~ after non-syllabic preposition")
     (longdesc . "Preprocessor for TeX source")
     (depend "vlna.ARCH")
     (docfiles "texmf-dist/doc/man/man1/vlna.1"))
    ("vlna.x86_64-linux"
     (shortdesc "x86_64-linux files of vlna")
     (binfiles "bin/x86_64-linux/vlna"))
    ("web"
     (depend "web.ARCH")
     (docfiles "texmf-dist/doc/man/man1/tangle.1"))
    ("web.x86_64-linux"
     (name . "web.x86_64-linux")
     (binfiles "bin/x86_64-linux/tangle"))))

(test-assert "texlive->guix-package, no docfiles"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "example"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-example")
               ('version _)
               ('source ('origin
                          ('method 'svn-multi-fetch)
                          ('uri ('svn-multi-reference
                                 ('url ('texlive-packages-repository 'version))
                                 ('revision 12345)
                                 ('locations ('list "tex/latex/example/"))))
                          ('file-name ('git-file-name 'name 'version))
                          ('sha256
                           ('base32 (? string? hash)))))
               ('build-system 'texlive-build-system)
               ('home-page (? string?))
               ('synopsis (? string?))
               ('description (? string?))
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "texsis"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-texsis")
               ('version _)
               ('source ('origin
                          ('method 'svn-multi-fetch)
                          ('uri ('svn-multi-reference
                                 ('url ('texlive-packages-repository 'version))
                                 ('revision 12345)
                                 ('locations
                                  ('list "bibtex/bst/texsis/"
                                         "doc/man/man1/texsis.1"
                                         "doc/man/man1/texsis.man1.pdf"
                                         "doc/otherformats/texsis/base/"
                                         "tex/texsis/base/"
                                         "tex/texsis/config/"))))
                          ('file-name ('git-file-name 'name 'version))
                          ('sha256
                           ('base32 (? string? hash)))))
               ('outputs ''("out" "doc"))
               ('build-system 'texlive-build-system)
               ('propagated-inputs
                ('list 'texlive-cm
                       'texlive-hyphen-base
                       'texlive-knuth-lib
                       'texlive-plain
                       'texlive-tex))
               ('home-page (? string?))
               ('synopsis (? string?))
               ('description (? string?))
               ('license 'lppl))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, with METAFONT files"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "trsym"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name _)
               ('version _)
               ('source _)
               ('outputs _)
               ('build-system _)
               ('native-inputs
                ('list 'texlive-metafont))
               ('home-page (? string?))
               ('synopsis (? string?))
               ('description (? string?))
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, with catalogue entry, no inputs"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "12many"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-12many")
               ('version _)
               ('source ('origin
                          ('method 'svn-multi-fetch)
                          ('uri ('svn-multi-reference
                                 ('url ('texlive-packages-repository 'version))
                                 ('revision 12345)
                                 ('locations ('list "doc/latex/12many/"
                                                    "source/latex/12many/"
                                                    "tex/latex/12many/"))))
                          ('file-name ('git-file-name 'name 'version))
                          ('sha256
                           ('base32 (? string? hash)))))
               ('outputs ''("out" "doc"))
               ('build-system 'texlive-build-system)
               ('home-page "https://ctan.org/pkg/one2many")
               ('synopsis (? string?))
               ('description (? string?))
               ('license 'lppl))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, multiple licenses"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "chs-physics-report"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-chs-physics-report")
               ('version _)
               ('source ('origin
                          ('method 'svn-multi-fetch)
                          ('uri ('svn-multi-reference
                                 ('url ('texlive-packages-repository 'version))
                                 ('revision 12345)
                                 ('locations
                                  ('list "doc/latex/chs-physics-report/"
                                         "tex/latex/chs-physics-report/"))))
                          ('file-name ('git-file-name 'name 'version))
                          ('sha256
                           ('base32 (? string? hash)))))
               ('outputs ''("out" "doc"))
               ('build-system 'texlive-build-system)
               ('home-page (? string?))
               ('synopsis (? string?))
               ('description (? string?))
               ('license ('list 'public-domain 'cc-by-sa3.0)))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, meta-package"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "collection-texworks"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-collection-texworks")
               ('version '%texlive-version)
               ('source #f)
               ('build-system 'trivial-build-system)
               ('arguments
                ('list '#:builder ('gexp ('mkdir ('ungexp 'output)))))
               ('propagated-inputs
                ('list 'texlive-collection-basic))
               ('home-page "https://www.tug.org/texlive/")
               ('synopsis (? string?))
               ('description (? string?))
               ('license
                ('fsf-free "https://www.tug.org/texlive/copying.html")))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, with TeX format"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "lollipop"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-lollipop")
               ('version _)
               ('source ('origin
                          ('method 'svn-multi-fetch)
                          ('uri ('svn-multi-reference
                                 ('url ('texlive-packages-repository 'version))
                                 ('revision 12345)
                                 ('locations ('list "doc/otherformats/lollipop/"
                                                    "tex/lollipop/"))))
                          ('file-name ('git-file-name 'name 'version))
                          ('sha256
                           ('base32 (? string? hash)))))
               ('outputs ''("out" "doc"))
               ('build-system 'texlive-build-system)
               ('arguments ('list '#:create-formats ('gexp ('list "lollipop"))))
               ('home-page (? string?))
               ('synopsis (? string?))
               ('description (? string?))
               ('license 'gpl3))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, execute but no TeX format"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "adforn"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-adforn")
               ('version _)
               ('source _)
               ('outputs ''("out" "doc"))
               ('build-system 'texlive-build-system)
               ('home-page (? string?))
               ('synopsis (? string?))
               ('description (? string?))
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, translate dependencies"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "collection-basic"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-collection-basic")
               ('version _)
               ('source _)
               ('build-system 'trivial-build-system)
               ('arguments
                ('list '#:builder ('gexp ('mkdir ('ungexp 'output)))))
               ('propagated-inputs
                ('list 'texlive-amsfonts 'texlive-hyphen-complete))
               ('home-page (? string?))
               ('synopsis (? string?))
               ('description (? string?))
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, lonely `hyphen-base' dependency and ARCH"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "tex"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-tex")
               ('version _)
               ('source _)
               ('outputs _)
               ('build-system 'texlive-build-system)
               ('arguments ('list '#:texlive-latex-bin? #f))
               ('propagated-inputs
                ('list 'texlive-cm 'texlive-hyphen-base))
               ('home-page (? string?))
               ('synopsis (? string?))
               ('description (? string?))
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, single script, no extension"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "authorindex"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-authorindex")
               ('version _)
               ('source _)
               ('outputs _)
               ('build-system 'texlive-build-system)
               ('arguments
                ('list '#:link-scripts ('gexp ('list "authorindex"))))
               ('home-page (? string?))
               ('synopsis (? string?))
               ('description (? string?))
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, multiple scripts, with extensions"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "cyrillic-bin"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-cyrillic-bin")
               ('version _)
               ('source _)
               ('outputs _)
               ('build-system 'texlive-build-system)
               ('arguments
                ('list '#:link-scripts
                       ('gexp ('list "rubibtex.sh" "rumakeindex.sh"))))
               ('home-page _)
               ('synopsis _)
               ('description _)
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, script with associated input"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "pax"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-pax")
               ('version _)
               ('source _)
               ('outputs _)
               ('build-system 'texlive-build-system)
               ('arguments
                ('list '#:link-scripts ('gexp ('list "pdfannotextractor.pl"))))
               ('inputs
                ('list 'perl))
               ('home-page _)
               ('synopsis _)
               ('description _)
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, propagated binaries, no script"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "vlna"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-vlna")
               ('version _)
               ('source _)
               ('outputs _)
               ('build-system 'texlive-build-system)
               ('propagated-inputs
                ('list 'texlive-vlna-bin))
               ('home-page _)
               ('synopsis _)
               ('description _)
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, propagated binaries and scripts"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "m-tx"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-m-tx")
               ('version _)
               ('source _)
               ('build-system 'texlive-build-system)
               ('arguments
                ('list '#:link-scripts ('gexp ('list "m-tx.lua"))))
               ('propagated-inputs
                ('list 'texlive-m-tx-bin))
               ('home-page _)
               ('synopsis _)
               ('description _)
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, with skipped propagated binaries"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "web"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-web")
               ('version _)
               ('source _)
               ('outputs _)
               ('build-system 'texlive-build-system)
               ('home-page _)
               ('synopsis _)
               ('description _)
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-assert "texlive->guix-package, with upstream-name property"
  ;; Replace network resources with sample data.
  (mock ((guix build svn) svn-fetch
         (lambda* (url revision directory
                       #:key (svn-command "svn")
                       (user-name #f)
                       (password #f)
                       (recursive? #t))
           (mkdir-p directory)
           (with-output-to-file (string-append directory "/foo")
             (lambda ()
               (display "source")))))
        (let ((result (texlive->guix-package "r_und_s"
                                             #:version "0"
                                             #:database %fake-tlpdb)))
          (match result
            (('package
               ('name "texlive-r-und-s")
               ('version _)
               ('source _)
               ('properties _)
               ('build-system 'texlive-build-system)
               ('home-page _)
               ('synopsis _)
               ('description _)
               ('license _))
             #true)
            (_
             (begin
               (format #t "~s~%" result)
               (pk 'fail result #f)))))))

(test-end "texlive")
generated by cgit
#~("--noissue") #~()) #$@(if init-string #~("--init-string" #$init-string) #~()) #$@(if no-clear? #~("--noclear") #~()) ;;; FIXME This doesn't work as expected. According to agetty(8), if this option ;;; is not passed, then the default is 'auto'. However, in my tests, when that ;;; option is selected, agetty never presents the login prompt, and the ;;; term-ttyS0 service respawns every few seconds. #$@(if local-line #~(#$(match local-line ('auto "--local-line=auto") ('always "--local-line=always") ('never "-local-line=never"))) #~()) #$@(if tty #~() #~("--keep-baud")) #$@(if extract-baud? #~("--extract-baud") #~()) #$@(if skip-login? #~("--skip-login") #~()) #$@(if no-newline? #~("--nonewline") #~()) #$@(if login-options #~("--login-options" #$login-options) #~()) #$@(if chroot #~("--chroot" #$chroot) #~()) #$@(if hangup? #~("--hangup") #~()) #$@(if keep-baud? #~("--keep-baud") #~()) #$@(if timeout #~("--timeout" #$(number->string timeout)) #~()) #$@(if detect-case? #~("--detect-case") #~()) #$@(if wait-cr? #~("--wait-cr") #~()) #$@(if no-hints? #~("--nohints?") #~()) #$@(if no-hostname? #~("--nohostname") #~()) #$@(if long-hostname? #~("--long-hostname") #~()) #$@(if erase-characters #~("--erase-chars" #$erase-characters) #~()) #$@(if kill-characters #~("--kill-chars" #$kill-characters) #~()) #$@(if chdir #~("--chdir" #$chdir) #~()) #$@(if delay #~("--delay" #$(number->string delay)) #~()) #$@(if nice #~("--nice" #$(number->string nice)) #~()) #$@(if auto-login (list "--autologin" auto-login) '()) #$@(if login-program #~("--login-program" #$login-program) #~()) #$@(if login-pause? #~("--login-pause") #~()) defaulted-tty #$@(if baud-rate #~(#$baud-rate) #~()) #$@(if term #~(#$term) #~()))) #$(if tty #~(const #f) ;always fail to start #~(lambda _ ;succeed, but don't do anything (format #t "~a: \ no serial port console requested; doing nothing~%" '#$(car provision)) 'idle))) args))))) (stop #~(let ((stop (make-kill-destructor))) (lambda (running) (if (eq? 'idle running) #f (stop running))))))))) (define agetty-service-type (service-type (name 'agetty) (extensions (list (service-extension shepherd-root-service-type agetty-shepherd-service))) (description "Provide console login using the @command{agetty} program."))) (define-deprecated (agetty-service config) agetty-service-type "Return a service to run agetty according to @var{config}, which specifies the tty to run, among other things." (service agetty-service-type config)) (define-record-type* <mingetty-configuration> mingetty-configuration make-mingetty-configuration mingetty-configuration? (mingetty mingetty-configuration-mingetty ;file-like (default mingetty)) (tty mingetty-configuration-tty) ;string (auto-login mingetty-auto-login ;string | #f (default #f)) (login-program mingetty-login-program ;gexp (default #f)) (login-pause? mingetty-login-pause? ;Boolean (default #f)) (clear-on-logout? mingetty-clear-on-logout? ;Boolean (default #t))) (define (mingetty-shepherd-service config) (match-record config <mingetty-configuration> (mingetty tty auto-login login-program login-pause? clear-on-logout?) (list (shepherd-service (documentation "Run mingetty on an tty.") (provision (list (symbol-append 'term- (string->symbol tty)))) ;; Since the login prompt shows the host name, wait for the 'host-name' ;; service to be done. Also wait for udev essentially so that the tty ;; text is not lost in the middle of kernel messages (XXX). (requirement '(user-processes host-name udev virtual-terminal)) (start #~(make-forkexec-constructor (list #$(file-append mingetty "/sbin/mingetty") ;; Avoiding 'vhangup' allows us to avoid 'setfont' ;; errors down the path where various ioctls get ;; EIO--see 'hung_up_tty_ioctl' in driver/tty/tty_io.c ;; in Linux. "--nohangup" #$tty #$@(if clear-on-logout? #~() #~("--noclear")) #$@(if auto-login #~("--autologin" #$auto-login) #~()) #$@(if login-program #~("--loginprog" #$login-program) #~()) #$@(if login-pause? #~("--loginpause") #~())))) (stop #~(make-kill-destructor)))))) (define mingetty-service-type (service-type (name 'mingetty) (extensions (list (service-extension shepherd-root-service-type mingetty-shepherd-service))) (description "Provide console login using the @command{mingetty} program."))) (define-deprecated (mingetty-service config) mingetty-service-type "Return a service to run mingetty according to @var{config}, which specifies the tty to run, among other things." (service mingetty-service-type config)) (define-record-type* <nscd-configuration> nscd-configuration make-nscd-configuration nscd-configuration? (log-file nscd-configuration-log-file ;string (default #f)) (debug-level nscd-debug-level ;integer (default 0)) ;; TODO: See nscd.conf in glibc for other options to add. (caches nscd-configuration-caches ;list of <nscd-cache> (default %nscd-default-caches)) (name-services nscd-configuration-name-services ;list of file-like (default '())) (glibc nscd-configuration-glibc ;file-like (default (let-system (system target) ;; Unless we're cross-compiling, arrange to use nscd ;; from 'glibc-final' instead of pulling in a second ;; glibc copy. (if target glibc (canonical-package glibc)))))) (define-record-type* <nscd-cache> nscd-cache make-nscd-cache nscd-cache? (database nscd-cache-database) ;symbol (positive-time-to-live nscd-cache-positive-time-to-live) ;integer (negative-time-to-live nscd-cache-negative-time-to-live (default 20)) ;integer (suggested-size nscd-cache-suggested-size ;integer ("default module ;of hash table") (default 211)) (check-files? nscd-cache-check-files? ;Boolean (default #t)) (persistent? nscd-cache-persistent? ;Boolean (default #t)) (shared? nscd-cache-shared? ;Boolean (default #t)) (max-database-size nscd-cache-max-database-size ;integer (default (* 32 (expt 2 20)))) (auto-propagate? nscd-cache-auto-propagate? ;Boolean (default #t))) (define %nscd-default-caches ;; Caches that we want to enable by default. Note that when providing an ;; empty nscd.conf, all caches are disabled. (list (nscd-cache (database 'hosts) ;; Aggressively cache the host name cache to improve ;; privacy and resilience. (positive-time-to-live (* 3600 12)) (negative-time-to-live 20) (persistent? #t)) (nscd-cache (database 'services) ;; Services are unlikely to change, so we can be even more ;; aggressive. (positive-time-to-live (* 3600 24)) (negative-time-to-live 3600) (check-files? #t) ;check /etc/services changes (persistent? #t)) ;; Enable minimal caching of the user databases, not so much for ;; caching but rather to allow that uses of NSS plugins like LDAP ;; don't lead user processes to dlopen them (which is likely to fail ;; due to them not being found in $LD_LIBRARY_PATH). (nscd-cache (database 'passwd) (positive-time-to-live 600) (negative-time-to-live 20) (check-files? #t) ;check /etc/passwd changes (persistent? #f)) (nscd-cache (database 'group) (positive-time-to-live 600) (negative-time-to-live 20) (check-files? #t) ;check /etc/group changes (persistent? #f)))) (define-deprecated %nscd-default-configuration #f ;; Default nscd configuration. (nscd-configuration)) (define (nscd.conf-file config) "Return the @file{nscd.conf} configuration file for @var{config}, an @code{<nscd-configuration>} object." (define (cache->config cache) (match-record cache <nscd-cache> (database positive-time-to-live negative-time-to-live suggested-size check-files? persistent? shared? max-database-size auto-propagate?) (let ((database (symbol->string database))) (string-append "\nenable-cache\t" database "\tyes\n" "positive-time-to-live\t" database "\t" (number->string positive-time-to-live) "\n" "negative-time-to-live\t" database "\t" (number->string negative-time-to-live) "\n" "suggested-size\t" database "\t" (number->string suggested-size) "\n" "check-files\t" database "\t" (if check-files? "yes\n" "no\n") "persistent\t" database "\t" (if persistent? "yes\n" "no\n") "shared\t" database "\t" (if shared? "yes\n" "no\n") "max-db-size\t" database "\t" (number->string max-database-size) "\n" "auto-propagate\t" database "\t" (if auto-propagate? "yes\n" "no\n"))))) (match-record config <nscd-configuration> (log-file debug-level caches) (plain-file "nscd.conf" (string-append "\ # Configuration of libc's name service cache daemon (nscd).\n\n" (if log-file (string-append "logfile\t" log-file) "") "\n" (if debug-level (string-append "debug-level\t" (number->string debug-level)) "") "\n" (string-concatenate (map cache->config caches)))))) (define (nscd-action-procedure nscd config option) ;; XXX: This is duplicated from mcron; factorize. #~(lambda (_ . args) ;; Run 'nscd' in a pipe so we can explicitly redirect its output to ;; 'current-output-port', which at this stage is bound to the client ;; connection. (let ((pipe (apply open-pipe* OPEN_READ #$nscd "-f" #$config #$option args))) (let loop () (match (read-line pipe 'concat) ((? eof-object?) (catch 'system-error (lambda () (zero? (close-pipe pipe))) (lambda args ;; There's a race with the SIGCHLD handler, which could ;; call 'waitpid' before 'close-pipe' above does. If we ;; get ECHILD, that means we lost the race; in that case, we ;; cannot tell what the exit code was (FIXME). (or (= ECHILD (system-error-errno args)) (apply throw args))))) (line (display line) (loop))))))) (define (nscd-actions nscd config) "Return Shepherd actions for NSCD using CONFIG its config file." ;; Make this functionality available as actions because that's a simple way ;; to run the right 'nscd' binary with the right config file. (list (shepherd-configuration-action config) (shepherd-action (name 'statistics) (documentation "Display statistics about nscd usage.") (procedure (nscd-action-procedure nscd config "--statistics"))) (shepherd-action (name 'invalidate) (documentation "Invalidate the given cache--e.g., 'hosts' for host name lookups.") (procedure (nscd-action-procedure nscd config "--invalidate"))))) (define (nscd-shepherd-service config) "Return a shepherd service for CONFIG, an <nscd-configuration> object." (let ((nscd (file-append (nscd-configuration-glibc config) "/sbin/nscd")) (nscd.conf (nscd.conf-file config)) (name-services (nscd-configuration-name-services config))) (list (shepherd-service (documentation "Run libc's name service cache daemon (nscd).") (provision '(nscd)) ;; Logs are written with syslog(3), which writes to /dev/console ;; when nobody's listening--ugly. Thus, wait for syslogd. (requirement '(user-processes syslogd)) (start #~(make-forkexec-constructor (list #$nscd "-f" #$nscd.conf "--foreground") ;; Wait for the PID file. However, the PID file is ;; written before nscd is actually listening on its ;; socket (XXX). #:pid-file "/var/run/nscd/nscd.pid" #:environment-variables (list (string-append "LD_LIBRARY_PATH=" (string-join (map (lambda (dir) (string-append dir "/lib")) (list #$@name-services)) ":"))))) (stop #~(make-kill-destructor)) (modules `((ice-9 popen) ;for the actions (ice-9 rdelim) (ice-9 match) ,@%default-modules)) (actions (nscd-actions nscd nscd.conf)))))) (define nscd-activation ;; Actions to take before starting nscd. #~(begin (use-modules (guix build utils)) (mkdir-p "/var/run/nscd") (mkdir-p "/var/db/nscd") ;for the persistent cache ;; In libc 2.25 nscd uses inotify to watch /etc/resolv.conf, but only if ;; that file exists when it is started. Thus create it here. Note: on ;; some systems, such as when NetworkManager is used, /etc/resolv.conf ;; is a symlink, hence 'lstat'. (unless (false-if-exception (lstat "/etc/resolv.conf")) (call-with-output-file "/etc/resolv.conf" (lambda (port) (display "# This is a placeholder.\n" port)))))) (define nscd-service-type (service-type (name 'nscd) (extensions (list (service-extension activation-service-type (const nscd-activation)) (service-extension shepherd-root-service-type nscd-shepherd-service))) ;; This can be extended by providing additional name services ;; such as nss-mdns. (compose concatenate) (extend (lambda (config name-services) (nscd-configuration (inherit config) (name-services (append (nscd-configuration-name-services config) name-services))))) (default-value (nscd-configuration)) (description "Runs libc's @dfn{name service cache daemon} (nscd) with the given configuration---an @code{<nscd-configuration>} object. @xref{Name Service Switch}, for an example."))) (define-deprecated (nscd-service #:optional (config (nscd-configuration))) nscd-service-type "Return a service that runs libc's name service cache daemon (nscd) with the given @var{config}---an @code{<nscd-configuration>} object. @xref{Name Service Switch}, for an example." (service nscd-service-type config)) ;;; Snippet adapted from the GNU inetutils manual. (define %default-syslog.conf (plain-file "syslog.conf" "\ # See info '(inetutils) syslogd invocation' for the documentation # of the syslogd configuration syntax. # Log all error messages, authentication messages of # level notice or higher and anything of level err or # higher to the console. # Don't log private authentication messages! *.alert;auth.notice;authpriv.none -/dev/console # Log anything (except mail) of level info or higher. # Don't log private authentication messages! *.info;mail.none;authpriv.none -/var/log/messages # Log \"debug\"-level entries and nothing else. *.=debug -/var/log/debug # Same, in a different place. *.info;mail.none;authpriv.none -/dev/tty12 # The authpriv file has restricted access. # 'fsync' the file after each line (hence the lack of a leading dash). # Also include unprivileged auth logs of info or higher level # to conveniently gather the authentication data at the same place. authpriv.*;auth.info /var/log/secure # Log all the mail messages in one place. mail.* -/var/log/maillog ")) (define-record-type* <syslog-configuration> syslog-configuration make-syslog-configuration syslog-configuration? (syslogd syslog-configuration-syslogd (default (file-append inetutils "/libexec/syslogd"))) (config-file syslog-configuration-config-file (default %default-syslog.conf))) ;;; Note: a static file name is used for syslog.conf so that the reload action ;;; work as intended. (define syslog.conf "/etc/syslog.conf") (define (syslog-etc configuration) (match-record configuration <syslog-configuration> (config-file) (list `(,(basename syslog.conf) ,config-file)))) (define (syslog-shepherd-service config) (define config-file (syslog-configuration-config-file config)) (shepherd-service (documentation "Run the syslog daemon (syslogd).") (provision '(syslogd)) (requirement '(user-processes)) (actions (list (shepherd-configuration-action syslog.conf) (shepherd-action (name 'reload) (documentation "Reload the configuration file from disk.") (procedure #~(lambda (pid) (if pid (begin (kill pid SIGHUP) (display #$(G_ "Service syslog has been asked to \ reload its settings file."))) (display #$(G_ "Service syslog is not running.")))))))) ;; Note: a static file name is used for syslog.conf so that the reload ;; action work as intended. (start #~(make-forkexec-constructor (list #$(syslog-configuration-syslogd config) #$(string-append "--rcfile=" syslog.conf)) #:file-creation-mask #o137 #:pid-file "/var/run/syslog.pid")) (stop #~(make-kill-destructor)))) (define syslog-service-type (service-type (name 'syslog) (default-value (syslog-configuration)) (extensions (list (service-extension shepherd-root-service-type (compose list syslog-shepherd-service)) (service-extension etc-service-type syslog-etc))) (description "Run the syslog daemon, @command{syslogd}, which is responsible for logging system messages."))) (define-deprecated (syslog-service #:optional (config (syslog-configuration))) syslog-service-type "Return a service that runs @command{syslogd} and takes @var{<syslog-configuration>} as a parameter. @xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more information on the configuration file syntax." (service syslog-service-type config)) (define pam-limits-service-type (let ((pam-extension (lambda (limits-file) (pam-extension (transformer (lambda (pam) (let ((pam-limits (pam-entry (control "required") (module "pam_limits.so") (arguments (list #~(string-append "conf=" #$limits-file)))))) (if (member (pam-service-name pam) '("login" "greetd" "su" "slim" "gdm-password" "sddm" "lightdm" "sudo" "sshd")) (pam-service (inherit pam) (session (cons pam-limits (pam-service-session pam)))) pam))))))) (make-limits-file (match-lambda ;; XXX: Using file-like objects is deprecated, use lists instead. ;; This is to be reduced into the list? case when the deprecated ;; code gets removed. ((? file-like? obj) (warning (G_ "Using file-like value for \ 'pam-limits-service-type' is deprecated~%")) obj) ((? list? lst) (plain-file "limits.conf" (string-join (map pam-limits-entry->string lst) "\n" 'suffix))) (_ (raise (formatted-message (G_ "invalid input for 'pam-limits-service-type'~%"))))))) (service-type (name 'limits) (extensions (list (service-extension pam-root-service-type (lambda (config) (list (pam-extension (make-limits-file config))))))) (description "Use the @code{pam_limits} authentication module to set the specified resource usage limits.") (default-value '())))) (define-deprecated (pam-limits-service #:optional (limits '())) pam-limits-service-type "Return a service that makes selected programs respect the list of pam-limits-entry specified in LIMITS via pam_limits.so." (service pam-limits-service-type (plain-file "limits.conf" (string-join (map pam-limits-entry->string limits) "\n")))) ;;; ;;; Guix services. ;;; (define* (guix-build-accounts count #:key (group "guixbuild") (shadow shadow)) "Return a list of COUNT user accounts for Guix build users with the given GID." (unfold (cut > <> count) (lambda (n) (user-account (name (format #f "guixbuilder~2,'0d" n)) (system? #t) (group group) ;; guix-daemon expects GROUP to be listed as a ;; supplementary group too: ;; <http://lists.gnu.org/archive/html/bug-guix/2013-01/msg00239.html>. (supplementary-groups (list group "kvm")) (comment (format #f "Guix Build User ~2d" n)) (home-directory "/var/empty") (shell (file-append shadow "/sbin/nologin")))) 1+ 1)) (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 (substitute-key-authorization keys guix) "Return a gexp with code to register KEYS, a list of files containing 'guix archive' public keys, with GUIX." (define default-acl (with-extensions (list guile-gcrypt) (with-imported-modules `(((guix config) => ,(make-config.scm)) ,@(source-module-closure '((guix pki)) #:select? not-config?)) (computed-file "acl" #~(begin (use-modules (guix pki) (gcrypt pk-crypto) (ice-9 rdelim)) (define keys (map (lambda (file) (call-with-input-file file (compose string->canonical-sexp read-string))) '(#$@keys))) (call-with-output-file #$output (lambda (port) (write-acl (public-keys->acl keys) port)))))))) (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils)) (define acl-file #$%acl-file) ;; If the ACL already exists, move it out of the way. Create a backup ;; if it's a regular file: it's likely that the user manually updated ;; it with 'guix archive --authorize'. (if (file-exists? acl-file) (if (and (symbolic-link? acl-file) (store-file-name? (readlink acl-file))) (delete-file acl-file) (rename-file acl-file (string-append acl-file ".bak"))) (mkdir-p (dirname acl-file))) ;; Installed the declared ACL. (symlink #+default-acl acl-file)))) (define (install-channels-file channels) "Return a gexp with code to install CHANNELS, a list of channels, in /etc/guix/channels.scm." (define channels-file (scheme-file "channels.scm" `(list ,@(map channel->code channels)))) (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils)) ;; If channels.scm already exists, move it out of the way. Create a ;; backup if it's a regular file: it's likely that the user ;; manually defined it. (if (file-exists? "/etc/guix/channels.scm") (if (and (symbolic-link? "/etc/guix/channels.scm") (store-file-name? (readlink "/etc/guix/channels.scm"))) (delete-file "/etc/guix/channels.scm") (rename-file "/etc/guix/channels.scm" "/etc/guix/channels.scm.bak")) (mkdir-p "/etc/guix")) ;; Installed the declared channels. (symlink #+channels-file "/etc/guix/channels.scm")))) (define %default-authorized-guix-keys ;; List of authorized substitute keys. (list (file-append guix "/share/guix/berlin.guix.gnu.org.pub") (file-append guix "/share/guix/bordeaux.guix.gnu.org.pub"))) (define (guix-machines-files-installation machines) "Return a gexp to install MACHINES, a list of gexps, as /etc/guix/machines.scm, which is used for offloading." (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils)) (define machines-file "/etc/guix/machines.scm") ;; If MACHINES-FILE already exists, move it out of the way. ;; Create a backup if it's a regular file: it's likely that the ;; user manually updated it. (let ((stat (false-if-exception (lstat machines-file)))) (if stat (if (and (eq? 'symlink (stat:type stat)) (store-file-name? (readlink machines-file))) (delete-file machines-file) (rename-file machines-file (string-append machines-file ".bak"))) (mkdir-p (dirname machines-file)))) ;; Installed the declared machines file. (symlink #+(scheme-file "machines.scm" #~((@ (srfi srfi-1) append-map) (lambda (entry) (if (build-machine? entry) (list entry) entry)) #$machines)) machines-file)))) (define-record-type* <guix-configuration> guix-configuration make-guix-configuration guix-configuration? (guix guix-configuration-guix ;file-like (default guix)) (build-group guix-configuration-build-group ;string (default "guixbuild")) (build-accounts guix-configuration-build-accounts ;integer (default 10)) (authorize-key? guix-configuration-authorize-key? ;Boolean (default #t)) (authorized-keys guix-configuration-authorized-keys ;list of gexps (default %default-authorized-guix-keys)) (use-substitutes? guix-configuration-use-substitutes? ;Boolean (default #t)) (substitute-urls guix-configuration-substitute-urls ;list of strings (default %default-substitute-urls)) (generate-substitute-key? guix-configuration-generate-substitute-key? (default #t)) ;Boolean (channels guix-configuration-channels ;file-like (default #f)) (chroot-directories guix-configuration-chroot-directories ;list of file-like/strings (default '())) (max-silent-time guix-configuration-max-silent-time ;integer (default 3600)) (timeout guix-configuration-timeout ;integer (default (* 3600 24))) (log-compression guix-configuration-log-compression (default 'gzip)) (discover? guix-configuration-discover? (default #f)) (extra-options guix-configuration-extra-options ;list of strings (default '())) (log-file guix-configuration-log-file ;string (default "/var/log/guix-daemon.log")) (http-proxy guix-http-proxy ;string | #f (default #f)) (tmpdir guix-tmpdir ;string | #f (default #f)) (build-machines guix-configuration-build-machines ;list of gexps | '() (default '())) (environment guix-configuration-environment ;list of strings (default '()))) (define %default-guix-configuration (guix-configuration)) (define shepherd-set-http-proxy-action ;; Shepherd action to change the HTTP(S) proxy. (shepherd-action (name 'set-http-proxy) (documentation "Change the HTTP(S) proxy used by 'guix-daemon' and restart it.") (procedure #~(lambda* (_ #:optional proxy) (let ((environment (environ))) ;; A bit of a hack: communicate PROXY to the 'start' ;; method via environment variables. (if proxy (begin (format #t "changing HTTP/HTTPS \ proxy of 'guix-daemon' to ~s...~%" proxy) (setenv "http_proxy" proxy)) (begin (format #t "clearing HTTP/HTTPS \ proxy of 'guix-daemon'...~%") (unsetenv "http_proxy"))) (perform-service-action (lookup-service 'guix-daemon) 'restart) (environ environment) #t))))) (define shepherd-discover-action ;; Shepherd action to enable or disable substitute servers discovery. (shepherd-action (name 'discover) (documentation "Enable or disable substitute servers discovery and restart the 'guix-daemon'.") (procedure #~(lambda* (_ status) (let ((environment (environ))) (if (and status (string=? status "on")) (begin (format #t "enable substitute servers discovery~%") (setenv "discover" "on")) (begin (format #t "disable substitute servers discovery~%") (unsetenv "discover"))) (perform-service-action (lookup-service 'guix-daemon) 'restart) (environ environment) #t))))) (define (guix-shepherd-service config) "Return a <shepherd-service> for the Guix daemon service with CONFIG." (define locales (let-system (system target) (if (target-hurd? (or target system)) (make-glibc-utf8-locales glibc/hurd) glibc-utf8-locales))) (match-record config <guix-configuration> (guix build-group build-accounts authorize-key? authorized-keys use-substitutes? substitute-urls max-silent-time timeout log-compression discover? extra-options log-file http-proxy tmpdir chroot-directories environment) (list (shepherd-service (documentation "Run the Guix daemon.") (provision '(guix-daemon)) (requirement `(user-processes ,@(if discover? '(avahi-daemon) '()))) (actions (list shepherd-set-http-proxy-action shepherd-discover-action)) (modules '((srfi srfi-1) (ice-9 match) (gnu build shepherd))) (start (with-imported-modules `(((guix config) => ,(make-config.scm)) ,@(source-module-closure '((gnu build shepherd)) #:select? not-config?)) #~(lambda args (define proxy ;; HTTP/HTTPS proxy. The 'http_proxy' variable is set by ;; the 'set-http-proxy' action. (or (getenv "http_proxy") #$http-proxy)) (define discover? (or (getenv "discover") #$discover?)) ;; Start the guix-daemon from a container, when supported, ;; to solve an installation issue. See the comment below for ;; more details. (fork+exec-command/container (cons* #$(file-append guix "/bin/guix-daemon") "--build-users-group" #$build-group "--max-silent-time" #$(number->string max-silent-time) "--timeout" #$(number->string timeout) "--log-compression" #$(symbol->string log-compression) #$@(if use-substitutes? '() '("--no-substitutes")) (string-append "--discover=" (if discover? "yes" "no")) "--substitute-urls" #$(string-join substitute-urls) #$@extra-options ;; Add CHROOT-DIRECTORIES and all their dependencies ;; (if these are store items) to the chroot. (append-map (lambda (file) (append-map (lambda (directory) (list "--chroot-directory" directory)) (call-with-input-file file read))) '#$(map references-file chroot-directories))) ;; When running the installer, we need guix-daemon to ;; operate from within the same MNT namespace as the ;; installation container. In that case only, enter the ;; namespace of the process PID passed as start argument. ;; Otherwise, for symmetry purposes enter the caller ;; namespaces which is a no-op. #:pid (match args ((pid) (string->number pid)) (else (getpid))) #:environment-variables (append (list #$@(if tmpdir (list (string-append "TMPDIR=" tmpdir)) '()) ;; Make sure we run in a UTF-8 locale so that ;; 'guix offload' correctly restores nars ;; that contain UTF-8 file names such as ;; 'nss-certs'. See ;; <https://bugs.gnu.org/32942>. (string-append "GUIX_LOCPATH=" #$locales "/lib/locale") "LC_ALL=en_US.utf8" ;; Make 'tar' and 'gzip' available so ;; that 'guix perform-download' can use ;; them when downloading from Software ;; Heritage via '(guix swh)'. (string-append "PATH=" #$(file-append tar "/bin") ":" #$(file-append gzip "/bin"))) (if proxy (list (string-append "http_proxy=" proxy) (string-append "https_proxy=" proxy)) '()) '#$environment) #:log-file #$log-file)))) (stop #~(make-kill-destructor)))))) (define (guix-accounts config) "Return the user accounts and user groups for CONFIG." (cons (user-group (name (guix-configuration-build-group config)) (system? #t) ;; Use a fixed GID so that we can create the store with the right ;; owner. (id 30000)) (guix-build-accounts (guix-configuration-build-accounts config) #:group (guix-configuration-build-group config)))) (define (guix-activation config) "Return the activation gexp for CONFIG." (match-record config <guix-configuration> (guix generate-substitute-key? authorize-key? authorized-keys channels) #~(begin ;; Assume that the store has BUILD-GROUP as its group. We could ;; otherwise call 'chown' here, but the problem is that on a COW overlayfs, ;; chown leads to an entire copy of the tree, which is a bad idea. ;; Generate a key pair and optionally authorize substitute server keys. (unless (or #$(not generate-substitute-key?) (file-exists? "/etc/guix/signing-key.pub")) (system* #$(file-append guix "/bin/guix") "archive" "--generate-key")) ;; Optionally install /etc/guix/acl... #$(if authorize-key? (substitute-key-authorization authorized-keys guix) #~#f) ;; ... and /etc/guix/channels.scm... #$(and channels (install-channels-file channels)) ;; ... and /etc/guix/machines.scm. #$(if (null? (guix-configuration-build-machines config)) #~#f (guix-machines-files-installation #~(list #$@(guix-configuration-build-machines config))))))) (define-record-type* <guix-extension> guix-extension make-guix-extension guix-extension? (authorized-keys guix-extension-authorized-keys ;list of file-like (default '())) (substitute-urls guix-extension-substitute-urls ;list of strings (default '())) (build-machines guix-extension-build-machines ;list of gexps (default '())) (chroot-directories guix-extension-chroot-directories ;list of file-like/strings (default '()))) (define (guix-extension-merge a b) (guix-extension (authorized-keys (append (guix-extension-authorized-keys a) (guix-extension-authorized-keys b))) (substitute-urls (append (guix-extension-substitute-urls a) (guix-extension-substitute-urls b))) (build-machines (append (guix-extension-build-machines a) (guix-extension-build-machines b))) (chroot-directories (append (guix-extension-chroot-directories a) (guix-extension-chroot-directories b))))) (define guix-service-type (service-type (name 'guix) (extensions (list (service-extension shepherd-root-service-type guix-shepherd-service) (service-extension account-service-type guix-accounts) (service-extension activation-service-type guix-activation) (service-extension profile-service-type (compose list guix-configuration-guix)))) ;; Extensions can specify extra directories to add to the build chroot, ;; extra substitute urls and extra authorized keys (compose (lambda (args) (fold guix-extension-merge (guix-extension) args))) (extend (lambda (config extension) (guix-configuration (inherit config) (authorized-keys (append (guix-extension-authorized-keys extension) (guix-configuration-authorized-keys config))) (substitute-urls (append (guix-extension-substitute-urls extension) (guix-configuration-substitute-urls config))) (build-machines (and (or (guix-configuration-build-machines config) (pair? (guix-extension-build-machines extension))) (append (guix-configuration-build-machines config) (guix-extension-build-machines extension)))) (chroot-directories (append (guix-extension-chroot-directories extension) (guix-configuration-chroot-directories config)))))) (default-value (guix-configuration)) (description "Run the build daemon of GNU@tie{}Guix, aka. @command{guix-daemon}."))) (define-record-type* <guix-publish-configuration> guix-publish-configuration make-guix-publish-configuration guix-publish-configuration? (guix guix-publish-configuration-guix ;file-like (default guix)) (port guix-publish-configuration-port ;number (default 80)) (host guix-publish-configuration-host ;string (default "localhost")) (advertise? guix-publish-advertise? ;boolean (default #f)) (compression guix-publish-configuration-compression (thunked) (default (default-compression this-record))) (nar-path guix-publish-configuration-nar-path ;string (default "nar")) (cache guix-publish-configuration-cache ;#f | string (default #f)) (cache-bypass-threshold guix-publish-configuration-cache-bypass-threshold (default (* 10 (expt 2 20)))) ;integer (workers guix-publish-configuration-workers ;#f | integer (default #f)) (ttl guix-publish-configuration-ttl ;#f | integer (default #f)) (negative-ttl guix-publish-configuration-negative-ttl ;#f | integer (default #f))) (define (default-compression config) "Return the default 'guix publish' compression according to CONFIG, and raise a deprecation warning if the 'compression-level' field was used." ;; Default to low compression levels when there's no cache so that users ;; get good bandwidth by default. (if (guix-publish-configuration-cache config) '(("gzip" 5) ("zstd" 19)) '(("gzip" 3) ("zstd" 3)))) ;zstd compresses faster (define (guix-publish-shepherd-service config) (define (config->compression-options config) (match (guix-publish-configuration-compression config) (() ;empty list means "no compression" '("-C0")) (lst (append-map (match-lambda ((type level) `("-C" ,(string-append type ":" (number->string level))))) lst)))) (match-record config <guix-publish-configuration> (guix port host nar-path cache workers ttl negative-ttl cache-bypass-threshold advertise?) (let ((command #~(list #$(file-append guix "/bin/guix") "publish" "-u" "guix-publish" "-p" #$(number->string port) #$@(config->compression-options config) (string-append "--nar-path=" #$nar-path) (string-append "--listen=" #$host) #$@(if advertise? #~("--advertise") #~()) #$@(if workers #~((string-append "--workers=" #$(number->string workers))) #~()) #$@(if ttl #~((string-append "--ttl=" #$(number->string ttl) "s")) #~()) #$@(if negative-ttl #~((string-append "--negative-ttl=" #$(number->string negative-ttl) "s")) #~()) #$@(if cache #~((string-append "--cache=" #$cache) #$(string-append "--cache-bypass-threshold=" (number->string cache-bypass-threshold))) #~()))) (options #~(#:environment-variables ;; Make sure we run in a UTF-8 locale so we can produce ;; nars for packages that contain UTF-8 file names such ;; as 'nss-certs'. See <https://bugs.gnu.org/26948>. (list (string-append "GUIX_LOCPATH=" #$(libc-utf8-locales-for-target) "/lib/locale") "LC_ALL=en_US.utf8") #:log-file "/var/log/guix-publish.log")) (endpoints #~(let ((ai (false-if-exception (getaddrinfo #$host #$(number->string port) AI_NUMERICSERV)))) (if (pair? ai) (list (endpoint (addrinfo:addr (car ai)))) '())))) (list (shepherd-service (provision '(guix-publish)) (requirement `(user-processes guix-daemon ,@(if advertise? '(avahi-daemon) '()))) ;; Use lazy socket activation unless ADVERTISE? is true: in that ;; case the process should start right away to advertise itself. (start #~(make-systemd-constructor #$command #$endpoints #$@options #:lazy-start? #$(not advertise?))) (stop #~(make-systemd-destructor))))))) (define %guix-publish-accounts (list (user-group (name "guix-publish") (system? #t)) (user-account (name "guix-publish") (group "guix-publish") (system? #t) (comment "guix publish user") (home-directory "/var/empty") (shell (file-append shadow "/sbin/nologin"))))) (define %guix-publish-log-rotations (list (log-rotation (files (list "/var/log/guix-publish.log")) (options `("rotate 4" ;don't keep too many of them ,@%default-log-rotation-options))))) (define (guix-publish-activation config) (let ((cache (guix-publish-configuration-cache config))) (if cache (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils)) (mkdir-p #$cache) (let* ((pw (getpw "guix-publish")) (uid (passwd:uid pw)) (gid (passwd:gid pw))) (chown #$cache uid gid)))) #t))) (define guix-publish-service-type (service-type (name 'guix-publish) (extensions (list (service-extension shepherd-root-service-type guix-publish-shepherd-service) (service-extension account-service-type (const %guix-publish-accounts)) (service-extension rottlog-service-type (const %guix-publish-log-rotations)) (service-extension activation-service-type guix-publish-activation))) (default-value (guix-publish-configuration)) (description "Add a Shepherd service running @command{guix publish}, a command that allows you to share pre-built binaries with others over HTTP."))) ;;; ;;; Udev. ;;; (define-record-type* <udev-configuration> udev-configuration make-udev-configuration udev-configuration? (udev udev-configuration-udev ;file-like (default eudev)) (rules udev-configuration-rules ;list of file-like (default '())) (hardware udev-configuration-hardware ;list of file-like (default '()))) (define (udev-configurations-union subdirectory packages) "Return the union of the lib/udev/SUBDIRECTORY directories found in each item of PACKAGES." (define build (with-imported-modules '((guix build union) (guix build utils)) #~(begin (use-modules (guix build union) (guix build utils) (srfi srfi-1) (srfi srfi-26)) (define %standard-locations '(#$(string-append "/lib/udev/" subdirectory) #$(string-append "/libexec/udev/" subdirectory))) (define (configuration-sub-directory directory) ;; Return the sub-directory of DIRECTORY containing udev ;; configurations, or #f if none was found. (find directory-exists? (map (cut string-append directory <>) %standard-locations))) (union-build #$output (filter-map configuration-sub-directory '#$packages))))) (computed-file (string-append "udev-" subdirectory) build)) (define (udev-rules-union packages) "Return the union of the lib/udev/rules.d directories found in each item of PACKAGES." (udev-configurations-union "rules.d" packages)) (define (udev-configuration-file subdirectory file-name contents) "Return a directory with a udev configuration file FILE-NAME containing CONTENTS." (file->udev-configuration-file subdirectory file-name (plain-file file-name contents))) (define (udev-rule file-name contents) "Return a directory with a udev rule file FILE-NAME containing CONTENTS." (udev-configuration-file "rules.d" file-name contents)) (define (udev-hardware file-name contents) "Return a directory with a udev hardware file FILE-NAME containing CONTENTS." (udev-configuration-file "hwdb.d" file-name contents)) (define (file->udev-configuration-file subdirectory file-name file) "Return a directory with a udev configuration file FILE-NAME which is a copy of FILE." (computed-file file-name (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils)) (define configuration-directory (string-append #$output "/lib/udev/" #$subdirectory)) (define file-copy-dest (string-append configuration-directory "/" #$file-name)) (mkdir-p configuration-directory) (copy-file #$file file-copy-dest))))) (define (file->udev-rule file-name file) "Return a directory with a udev rule file FILE-NAME which is a copy of FILE." (file->udev-configuration-file "rules.d" file-name file)) (define (file->udev-hardware file-name file) "Return a directory with a udev hardware file FILE-NAME which is a copy of FILE." (file->udev-configuration-file "hwdb.d" file-name file)) (define kvm-udev-rule ;; Return a directory with a udev rule that changes the group of /dev/kvm to ;; "kvm" and makes it #o660. Apparently QEMU-KVM used to ship this rule, ;; but now we have to add it by ourselves. ;; Build users are part of the "kvm" group, so we can fearlessly make ;; /dev/kvm 660 (see <http://bugs.gnu.org/18994>, for background.) (udev-rule "90-kvm.rules" "KERNEL==\"kvm\", GROUP=\"kvm\", MODE=\"0660\"\n")) (define (udev-shepherd-service config) ;; Return a <shepherd-service> for UDEV with RULES. (let ((udev (udev-configuration-udev config))) (list (shepherd-service (provision '(udev)) ;; Udev needs /dev to be a 'devtmpfs' mount so that new device nodes can ;; be added: see ;; <http://www.linuxfromscratch.org/lfs/view/development/chapter07/udev.html>. (requirement '(root-file-system)) (documentation "Populate the /dev directory, dynamically.") (start (with-imported-modules (source-module-closure '((gnu build linux-boot))) #~(lambda () (define udevd ;; 'udevd' from eudev. #$(file-append udev "/sbin/udevd")) (define (wait-for-udevd) ;; Wait until someone's listening on udevd's control ;; socket. (let ((sock (socket AF_UNIX SOCK_SEQPACKET 0))) (let try () (catch 'system-error (lambda () (connect sock PF_UNIX "/run/udev/control") (close-port sock)) (lambda args (format #t "waiting for udevd...~%") (usleep 500000) (try)))))) ;; Allow udev to find the modules. (setenv "LINUX_MODULE_DIRECTORY" "/run/booted-system/kernel/lib/modules") (let* ((kernel-release (utsname:release (uname))) (linux-module-directory (getenv "LINUX_MODULE_DIRECTORY")) (directory (string-append linux-module-directory "/" kernel-release)) (old-umask (umask #o022))) ;; If we're in a container, DIRECTORY might not exist, ;; for instance because the host runs a different ;; kernel. In that case, skip it; we'll just miss a few ;; nodes like /dev/fuse. (when (file-exists? directory) (make-static-device-nodes directory)) (umask old-umask)) (let ((pid (fork+exec-command (list udevd) #:environment-variables (cons* ;; The first one is for udev, the second one for ;; eudev. "UDEV_CONFIG_FILE=/etc/udev/udev.conf" "EUDEV_RULES_DIRECTORY=/etc/udev/rules.d" (string-append "LINUX_MODULE_DIRECTORY=" (getenv "LINUX_MODULE_DIRECTORY")) (default-environment-variables))))) ;; Wait until udevd is up and running. This appears to ;; be needed so that the events triggered below are ;; actually handled. (wait-for-udevd) ;; Trigger device node creation. (system* #$(file-append udev "/bin/udevadm") "trigger" "--action=add") ;; Wait for things to settle down. (system* #$(file-append udev "/bin/udevadm") "settle") pid)))) (stop #~(make-kill-destructor)) ;; When halting the system, 'udev' is actually killed by ;; 'user-processes', i.e., before its own 'stop' method was called. ;; Thus, make sure it is not respawned. (respawn? #f) ;; We need additional modules. (modules `((gnu build linux-boot) ;'make-static-device-nodes' ,@%default-modules)))))) (define udev.conf (computed-file "udev.conf" #~(call-with-output-file #$output (lambda (port) (format port "udev_rules=\"/etc/udev/rules.d\"~%"))))) (define (udev-etc config) (match-record config <udev-configuration> (udev rules hardware) (let* ((hardware (udev-configurations-union "hwdb.d" (cons* udev hardware))) (hwdb.bin (computed-file "hwdb.bin" (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils)) (setenv "UDEV_HWDB_PATH" #$hardware) (invoke #+(file-append udev "/bin/udevadm") "hwdb" "--update" "-o" #$output)))))) `(("udev" ,(file-union "udev" `(("udev.conf" ,udev.conf) ("rules.d" ,(udev-rules-union (cons* udev kvm-udev-rule rules))) ("hwdb.bin" ,hwdb.bin)))))))) (define udev-service-type (service-type (name 'udev) (extensions (list (service-extension shepherd-root-service-type udev-shepherd-service) (service-extension etc-service-type udev-etc))) (compose concatenate) ;concatenate the list of rules (extend (lambda (config extensions) (let ((initial-rules (udev-configuration-rules config)) (initial-hardware (udev-configuration-hardware config))) (udev-configuration (inherit config) (rules (append initial-rules extensions)) (hardware (append initial-hardware extensions)))))) (default-value (udev-configuration)) (description "Run @command{udev}, which populates the @file{/dev} directory dynamically. Get extra rules from the packages listed in the @code{rules} field of its value, @code{udev-configuration} object."))) (define-deprecated (udev-service #:key (udev eudev) (rules '())) udev-service-type "Run @var{udev}, which populates the @file{/dev} directory dynamically. Get extra rules from the packages listed in @var{rules}." (service udev-service-type (udev-configuration (udev udev) (rules rules)))) (define* (udev-rules-service name rules #:key (groups '())) "Return a service that extends udev-service-type with RULES and account-service-type with GROUPS as system groups. This works by creating a singleton service type NAME-udev-rules, of which the returned service is an instance." (let* ((name (symbol-append name '-udev-rules)) (account-extension (const (map (lambda (group) (user-group (name group) (system? #t))) groups))) (udev-extension (const (list rules))) (type (service-type (name name) (extensions (list (service-extension account-service-type account-extension) (service-extension udev-service-type udev-extension))) (description "This service adds udev rules.")))) (service type #f))) (define (udev-hardware-service name hardware-files) "Return a service that extends udev-service-type with HARDWARE-FILES, named NAME-udev-hardware." (let* ((name (symbol-append name '-udev-hardware)) (udev-extension (const (list hardware-files))) (type (service-type (name name) (extensions (list (service-extension udev-service-type udev-extension))) (description "This service adds udev hardware files.")))) (service type #f))) (define (swap-space->shepherd-service-name space) (let ((target (swap-space-target space))) (symbol-append 'swap- (string->symbol (cond ((uuid? target) (uuid->string target)) ((file-system-label? target) (file-system-label->string target)) (else target)))))) ; TODO Remove after deprecation (define (swap-deprecated->shepherd-service-name sdep) (symbol-append 'swap- (string->symbol (cond ((uuid? sdep) (string-take (uuid->string sdep) 6)) ((file-system-label? sdep) (file-system-label->string sdep)) (else sdep))))) (define swap->shepherd-service-name (match-lambda ((? swap-space? space) (swap-space->shepherd-service-name space)) (sdep (swap-deprecated->shepherd-service-name sdep)))) (define swap-service-type (shepherd-service-type 'swap (lambda (swap) (define requirements (cond ((swap-space? swap) (map dependency->shepherd-service-name (swap-space-dependencies swap))) ; TODO Remove after deprecation ((and (string? swap) (string-prefix? "/dev/mapper/" swap)) (list (symbol-append 'device-mapping- (string->symbol (basename swap))))) (else '()))) (define device-lookup ;; The generic 'find-partition' procedures could return a partition ;; that's not swap space, but that's unlikely. (cond ((swap-space? swap) (let ((target (swap-space-target swap))) (cond ((uuid? target) #~(find-partition-by-uuid #$(uuid-bytevector target))) ((file-system-label? target) #~(find-partition-by-label #$(file-system-label->string target))) (else target)))) ; TODO Remove after deprecation ((uuid? swap) #~(find-partition-by-uuid #$(uuid-bytevector swap))) ((file-system-label? swap) #~(find-partition-by-label #$(file-system-label->string swap))) (else swap))) (with-imported-modules (source-module-closure '((gnu build file-systems))) (shepherd-service (provision (list (swap->shepherd-service-name swap))) (requirement `(udev ,@requirements)) (documentation "Enable the given swap space.") (modules `((gnu build file-systems) ,@%default-modules)) (start #~(lambda () (let ((device #$device-lookup)) (and device (begin (restart-on-EINTR (swapon device #$(if (swap-space? swap) (swap-space->flags-bit-mask swap) 0))) #t))))) (stop #~(lambda _ (let ((device #$device-lookup)) (when device (restart-on-EINTR (swapoff device))) #f))) (respawn? #f)))) (description "Turn on the virtual memory swap area."))) (define (swap-service swap) "Return a service that uses @var{swap} as a swap space." (service swap-service-type swap)) (define %default-gpm-options ;; Default options for GPM. '("-m" "/dev/input/mice" "-t" "ps2")) (define-record-type* <gpm-configuration> gpm-configuration make-gpm-configuration gpm-configuration? (gpm gpm-configuration-gpm ;file-like (default gpm)) (options gpm-configuration-options ;list of strings (default %default-gpm-options))) (define (gpm-shepherd-service config) (match-record config <gpm-configuration> (gpm options) (list (shepherd-service (requirement '(udev)) (provision '(gpm)) ;; 'gpm' runs in the background and sets a PID file. ;; Note that it requires running as "root". (start #~(make-forkexec-constructor (list #$(file-append gpm "/sbin/gpm") #$@options) #:pid-file "/var/run/gpm.pid" #:pid-file-timeout 3)) (stop #~(lambda (_) ;; Return #f if successfully stopped. (not (zero? (system* #$(file-append gpm "/sbin/gpm") "-k"))))))))) (define gpm-service-type (service-type (name 'gpm) (extensions (list (service-extension shepherd-root-service-type gpm-shepherd-service))) (default-value (gpm-configuration)) (description "Run GPM, the general-purpose mouse daemon, with the given command-line options. GPM allows users to use the mouse in the console, notably to select, copy, and paste text. The default options use the @code{ps2} protocol, which works for both USB and PS/2 mice."))) (define-record-type* <kmscon-configuration> kmscon-configuration make-kmscon-configuration kmscon-configuration? (kmscon kmscon-configuration-kmscon (default kmscon)) (virtual-terminal kmscon-configuration-virtual-terminal) (login-program kmscon-configuration-login-program (default (file-append shadow "/bin/login"))) (login-arguments kmscon-configuration-login-arguments (default '("-p"))) (auto-login kmscon-configuration-auto-login (default #f)) (hardware-acceleration? kmscon-configuration-hardware-acceleration? (default #f)) ; #t causes failure (font-engine kmscon-configuration-font-engine (default "pango")) (font-size kmscon-configuration-font-size (default 12)) (keyboard-layout kmscon-configuration-keyboard-layout (default #f))) ; #f | <keyboard-layout> (define kmscon-service-type (shepherd-service-type 'kmscon (lambda (config) (let ((kmscon (kmscon-configuration-kmscon config)) (virtual-terminal (kmscon-configuration-virtual-terminal config)) (login-program (kmscon-configuration-login-program config)) (login-arguments (kmscon-configuration-login-arguments config)) (auto-login (kmscon-configuration-auto-login config)) (hardware-acceleration? (kmscon-configuration-hardware-acceleration? config)) (font-engine (kmscon-configuration-font-engine config)) (font-size (kmscon-configuration-font-size config)) (keyboard-layout (kmscon-configuration-keyboard-layout config))) (define kmscon-command #~(list #$(file-append kmscon "/bin/kmscon") "--login" "--vt" #$virtual-terminal "--no-switchvt" ;Prevent a switch to the virtual terminal. "--font-engine" #$font-engine "--font-size" #$(number->string font-size) #$@(if keyboard-layout (let* ((layout (keyboard-layout-name keyboard-layout)) (variant (keyboard-layout-variant keyboard-layout)) (model (keyboard-layout-model keyboard-layout)) (options (keyboard-layout-options keyboard-layout))) `("--xkb-layout" ,layout ,@(if variant `("--xkb-variant" ,variant) '()) ,@(if model `("--xkb-model" ,model) '()) ,@(if (null? options) '() `("--xkb-options" ,(string-join options ","))))) '()) #$@(if hardware-acceleration? '("--hwaccel") '()) "--login" "--" #$login-program #$@login-arguments #$@(if auto-login #~(#$auto-login) #~()))) (shepherd-service (documentation "kmscon virtual terminal") (requirement '(user-processes udev dbus-system)) (provision (list (symbol-append 'term- (string->symbol virtual-terminal)))) (start #~(make-forkexec-constructor #$kmscon-command ;; The installer needs to be able to display glyphs from ;; various scripts, so give it access to unifont. ;; TODO: Make this configurable. #:environment-variables (list (string-append "XDG_DATA_DIRS=" #+font-gnu-unifont "/share")))) (stop #~(make-kill-destructor))))) (description "Start the @command{kmscon} virtual terminal emulator for the Linux @dfn{kernel mode setting} (KMS)."))) ;;; ;;; Static networking. ;;; (define (ipv6-address? str) "Return true if STR denotes an IPv6 address." (false-if-exception (->bool (inet-pton AF_INET6 str)))) (define-compile-time-procedure (assert-valid-address (address string?)) "Ensure ADDRESS has a valid netmask." (unless (cidr->netmask address) (raise (make-compound-condition (formatted-message (G_ "address '~a' lacks a network mask") address) (condition (&error-location (location (source-properties->location procedure-call-location)))) (condition (&fix-hint (hint (format #f (G_ "\ Write, say, @samp{\"~a/24\"} for a 24-bit network mask.") address))))))) address) (define (mac-address? str) "Return true if STR is a valid MAC address." (let ((pattern (make-regexp "^([0-9A-Fa-f]{2}:?){6}$"))) (false-if-exception (vector? (regexp-exec pattern str))))) (define-compile-time-procedure (assert-network-link-mac-address (value identity)) (cond ((eq? value #f) value) ((and (string? value) (mac-address? value)) value) (else (raise (make-compound-condition (formatted-message (G_ "Value (~S) is not a valid mac address.~%") value) (condition (&error-location (location (source-properties->location procedure-call-location))))))))) (define-compile-time-procedure (assert-network-link-type (value identity)) (match value (#f value) (('quote _) (datum->syntax #'value value)) (else (raise (make-compound-condition (formatted-message (G_ "Value (~S) is not a symbol.~%") value) (condition (&error-location (location (source-properties->location procedure-call-location))))))))) (define-record-type* <static-networking> static-networking make-static-networking static-networking? (addresses static-networking-addresses) ;list of <network-address> (links static-networking-links (default '())) ;list of <network-link> (routes static-networking-routes (default '())) ;list of <network-routes> (provision static-networking-provision (default '(networking))) (requirement static-networking-requirement (default '(udev))) (name-servers static-networking-name-servers ;FIXME: doesn't belong here (default '()))) (define-record-type* <network-address> network-address make-network-address network-address? (device network-address-device) ;string--e.g., "en01" (value network-address-value ;string--CIDR notation (sanitize assert-valid-address)) (ipv6? network-address-ipv6? ;Boolean (thunked) (default (ipv6-address? (cidr->ip (network-address-value this-record)))))) (define-record-type* <network-link> network-link make-network-link network-link? (name network-link-name (default #f)) ;string or #f --e.g, "v0p0" (type network-link-type (sanitize assert-network-link-type) (default #f)) ;symbol or #f--e.g.,'veth, 'bond (mac-address network-link-mac-address (sanitize assert-network-link-mac-address) (default #f)) (arguments network-link-arguments)) ;list (define-record-type* <network-route> network-route make-network-route network-route? (destination network-route-destination) (source network-route-source (default #f)) (device network-route-device (default #f)) (ipv6? network-route-ipv6? (thunked) (default (or (ipv6-address? (network-route-destination this-record)) (and=> (network-route-gateway this-record) ipv6-address?)))) (gateway network-route-gateway (default #f))) (eval-when (expand load eval) (define* (cidr->netmask str #:optional (family AF_INET)) "Given @var{str}, a string in CIDR notation (e.g., \"1.2.3.4/24\"), return the netmask as a string like \"255.255.255.0\"." (match (string-split str #\/) ((ip (= string->number bits)) (let ((mask (ash (- (expt 2 bits) 1) (- (if (= family AF_INET6) 128 32) bits)))) (inet-ntop family mask))) (_ #f)))) (define (cidr->ip str) "Strip the netmask bit of @var{str}, a CIDR-notation IP/netmask address." (match (string-split str #\/) ((or (ip _) (ip)) ip))) (define* (ip+netmask->cidr ip netmask #:optional (family AF_INET)) "Return the CIDR notation (a string) for @var{ip} and @var{netmask}, two @var{family} address strings, where @var{family} is @code{AF_INET} or @code{AF_INET6}." (let* ((netmask (inet-pton family netmask)) (bits (logcount netmask))) (string-append ip "/" (number->string bits)))) (define (static-networking->hurd-pfinet-options config) "Return command-line options for the Hurd's pfinet translator corresponding to CONFIG." (unless (null? (static-networking-links config)) ;; XXX: Presumably this is not supported, or perhaps could be approximated ;; by running separate pfinet instances in some cases? (warning (G_ "network links are currently ignored on GNU/Hurd~%"))) (match (static-networking-addresses config) ((and addresses (first _ ...)) `("--ipv6" "/servers/socket/26" "--interface" ,(string-append "/dev/" (network-address-device first)) ,@(append-map (lambda (address) `(,(if (network-address-ipv6? address) "--address6" "--address") ,(cidr->ip (network-address-value address)) ,@(match (cidr->netmask (network-address-value address) (if (network-address-ipv6? address) AF_INET6 AF_INET)) (#f '()) (mask (list "--netmask" mask))))) addresses) ,@(append-map (lambda (route) (match route (($ <network-route> "default" #f device _ gateway) (if (network-route-ipv6? route) `("--gateway6" ,gateway) `("--gateway" ,gateway))) (($ <network-route> destination) (warning (G_ "ignoring network route for '~a'~%") destination) '()))) (static-networking-routes config)))))) (define (network-set-up/hurd config) "Set up networking for the Hurd." ;; The Hurd implements SIOCGIFADDR and other old-style ioctls, but the only ;; way to set up IPv6 is by starting pfinet with the right options. (if (equal? (static-networking-provision config) '(loopback)) (scheme-file "set-up-pflocal" #~(begin 'nothing-to-do! #t)) (scheme-file "set-up-pfinet" (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils) (ice-9 format)) ;; TODO: Do that without forking. (let ((options '#$(static-networking->hurd-pfinet-options config))) (format #t "starting '~a~{ ~s~}'~%" #$(file-append hurd "/hurd/pfinet") options) (apply invoke #$(file-append hurd "/bin/settrans") "--active" "--create" "--keep-active" "/servers/socket/2" #$(file-append hurd "/hurd/pfinet") options))))))) (define (network-tear-down/hurd config) (scheme-file "tear-down-pfinet" (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils)) ;; Forcefully terminate pfinet. XXX: In theory this ;; should just undo the addresses and routes of CONFIG; ;; this could be done using ioctls like SIOCDELRT, but ;; these are IPv4-only; another option would be to use ;; fsysopts but that seems to crash pfinet. (invoke #$(file-append hurd "/bin/settrans") "-fg" "/servers/socket/2") #f)))) (define (network-set-up/linux config) (match-record config <static-networking> (addresses links routes) (scheme-file "set-up-network" (with-extensions (list guile-netlink) #~(begin (use-modules (ip addr) (ip link) (ip route) (srfi srfi-1) (ice-9 format) (ice-9 match)) (define (match-link-by field-accessor value) (fold (lambda (link result) (if (equal? (field-accessor link) value) link result)) #f (get-links))) (define (alist->keyword+value alist) (fold (match-lambda* (((k . v) r) (cons* (symbol->keyword k) v r))) '() alist)) ;; FIXME: It is interesting that "modprobe bonding" creates an ;; interface bond0 straigt away. If we won't have bonding ;; module, and execute `ip link add name bond0 type bond' we ;; will get ;; ;; RTNETLINK answers: File exists ;; ;; This breaks our configuration if we want to ;; use `bond0' name. Create (force modprobe ;; bonding) and delete the interface to free up ;; bond0 name. #$(let lp ((links links)) (cond ((null? links) #f) ((and (network-link? (car links)) ;; Type is not mandatory (false-if-exception (eq? (network-link-type (car links)) 'bond))) #~(begin (false-if-exception (link-add "bond0" "bond")) (link-del "bond0"))) (else (lp (cdr links))))) #$@(map (match-lambda (($ <network-link> name type mac-address arguments) (cond ;; Create a new interface ((and (string? name) (symbol? type)) #~(begin (link-add #$name (symbol->string '#$type) #:type-args '#$arguments) ;; XXX: If we add routes, addresses must be ;; already assigned, and interfaces must be ;; up. It doesn't matter if they won't have ;; carrier or anything. (link-set #$name #:up #t))) ;; Amend an existing interface ((and (string? name) (eq? type #f)) #~(let ((link (match-link-by link-name #$name))) (if link (apply link-set (link-id link) (alist->keyword+value '#$arguments)) (format #t (G_ "Interface with name '~a' not found~%") #$name)))) ((string? mac-address) #~(let ((link (match-link-by link-addr #$mac-address))) (if link (apply link-set (link-id link) (alist->keyword+value '#$arguments)) (format #t (G_ "Interface with mac-address '~a' not found~%") #$mac-address))))))) links) #$@(map (lambda (address) #~(begin ;; Before going any further, wait for the ;; device to show up. (wait-for-link #$(network-address-device address) #:blocking? #f) (addr-add #$(network-address-device address) #$(network-address-value address) #:ipv6? #$(network-address-ipv6? address)) ;; FIXME: loopback? (link-set #$(network-address-device address) #:multicast-on #t #:up #t))) addresses) #$@(map (lambda (route) #~(route-add #$(network-route-destination route) #:device #$(network-route-device route) #:ipv6? #$(network-route-ipv6? route) #:via #$(network-route-gateway route) #:src #$(network-route-source route))) routes) #t))))) (define (network-tear-down/linux config) (match-record config <static-networking> (addresses links routes) (scheme-file "tear-down-network" (with-extensions (list guile-netlink) #~(begin (use-modules (ip addr) (ip link) (ip route) (netlink error) (srfi srfi-34)) (define-syntax-rule (false-if-netlink-error exp) (guard (c ((netlink-error? c) #f)) exp)) ;; Wrap calls in 'false-if-netlink-error' so this ;; script goes as far as possible undoing the effects ;; of "set-up-network". #$@(map (lambda (route) #~(false-if-netlink-error (route-del #$(network-route-destination route) #:device #$(network-route-device route) #:ipv6? #$(network-route-ipv6? route) #:via #$(network-route-gateway route) #:src #$(network-route-source route)))) routes) ;; Cleanup addresses first, they might be assigned to ;; created bonds, vlans or bridges. #$@(map (lambda (address) #~(false-if-netlink-error (addr-del #$(network-address-device address) #$(network-address-value address) #:ipv6? #$(network-address-ipv6? address)))) addresses) ;; It is now safe to delete some links #$@(map (match-lambda (($ <network-link> name type mac-address arguments) (cond ;; We delete interfaces that were created ((and (string? name) (symbol? type)) #~(false-if-netlink-error (link-del #$name))) (else #t)))) links) #f))))) (define (static-networking-shepherd-service config) (match-record config <static-networking> (addresses links routes provision requirement name-servers) (let ((loopback? (and provision (memq 'loopback provision)))) (shepherd-service (documentation "Bring up the networking interface using a static IP address.") (requirement requirement) (provision provision) (start #~(lambda _ ;; Return #t if successfully started. (load #$(let-system (system target) (if (string-contains (or target system) "-linux") (network-set-up/linux config) (network-set-up/hurd config)))))) (stop #~(lambda _ ;; Return #f is successfully stopped. (load #$(let-system (system target) (if (string-contains (or target system) "-linux") (network-tear-down/linux config) (network-tear-down/hurd config)))))) (respawn? #f))))) (define (static-networking-shepherd-services networks) (map static-networking-shepherd-service networks)) (define (static-networking-etc-files interfaces) "Return a /etc/resolv.conf entry for INTERFACES or the empty list." (match (delete-duplicates (append-map static-networking-name-servers interfaces)) (() '()) ((name-servers ...) (let ((content (string-join (map (cut string-append "nameserver " <>) name-servers) "\n" 'suffix))) `(("resolv.conf" ,(plain-file "resolv.conf" (string-append "\ # Generated by 'static-networking-service'.\n" content)))))))) (define static-networking-service-type ;; The service type for statically-defined network interfaces. (service-type (name 'static-networking) (extensions (list (service-extension shepherd-root-service-type static-networking-shepherd-services) (service-extension etc-service-type static-networking-etc-files))) (compose concatenate) (extend append) (description "Turn up the specified network interfaces upon startup, with the given IP address, gateway, netmask, and so on. The value for services of this type is a list of @code{static-networking} objects, one per network interface."))) (define-deprecated (static-networking-service interface ip #:key netmask gateway provision ;; Most interfaces require udev to be usable. (requirement '(udev)) (name-servers '())) static-networking-service-type "Return a service that starts @var{interface} with address @var{ip}. If @var{netmask} is true, use it as the network mask. If @var{gateway} is true, it must be a string specifying the default network gateway. This procedure can be called several times, one for each network interface of interest. Behind the scenes what it does is extend @code{static-networking-service-type} with additional network interfaces to handle." (simple-service 'static-network-interface static-networking-service-type (list (static-networking (addresses (list (network-address (device interface) (value (if netmask (ip+netmask->cidr ip netmask) ip)) (ipv6? #f)))) (routes (if gateway (list (network-route (destination "default") (gateway gateway) (ipv6? #f))) '())) (requirement requirement) (provision (or provision '(networking))) (name-servers name-servers))))) (define %loopback-static-networking ;; The loopback device. (static-networking (addresses (list (network-address (device "lo") (value "127.0.0.1/8")))) (requirement '()) (provision '(loopback)))) (define %qemu-static-networking ;; Networking configuration for QEMU's user-mode network stack (info "(QEMU) ;; Using the user mode network stack"). (static-networking (addresses (list (network-address (device "eth0") (value "10.0.2.15/24")))) (routes (list (network-route (destination "default") (gateway "10.0.2.2")))) (requirement '()) (provision '(networking)) (name-servers '("10.0.2.3")))) ;;; ;;; greetd-service-type -- minimal and flexible login manager daemon ;;; (define-record-type* <greetd-agreety-session> greetd-agreety-session make-greetd-agreety-session greetd-agreety-session? (agreety greetd-agreety (default greetd)) (command greetd-agreety-command (default (file-append bash "/bin/bash"))) (command-args greetd-agreety-command-args (default '("-l"))) (extra-env greetd-agreety-extra-env (default '())) (xdg-env? greetd-agreety-xdg-env? (default #t))) (define (greetd-agreety-tty-session-command config) (match-record config <greetd-agreety-session> (command command-args extra-env) (program-file "agreety-tty-session-command" #~(begin (use-modules (ice-9 match)) (for-each (match-lambda ((var . val) (setenv var val))) (quote (#$@extra-env))) (apply execl #$command #$command (list #$@command-args)))))) (define (greetd-agreety-tty-xdg-session-command config) (match-record config <greetd-agreety-session> (command command-args extra-env) (program-file "agreety-tty-xdg-session-command" #~(begin (use-modules (ice-9 match)) (let* ((username (getenv "USER")) (useruid (passwd:uid (getpwuid username))) (useruid (number->string useruid))) (setenv "XDG_SESSION_TYPE" "tty") (setenv "XDG_RUNTIME_DIR" (string-append "/run/user/" useruid))) (for-each (match-lambda ((var . val) (setenv var val))) (quote (#$@extra-env))) (apply execl #$command #$command (list #$@command-args)))))) (define-gexp-compiler (greetd-agreety-session-compiler (session <greetd-agreety-session>) system target) (let ((agreety (file-append (greetd-agreety session) "/bin/agreety")) (command ((if (greetd-agreety-xdg-env? session) greetd-agreety-tty-xdg-session-command greetd-agreety-tty-session-command) session))) (lower-object (program-file "agreety-command" #~(execl #$agreety #$agreety "-c" #$command))))) (define-record-type* <greetd-wlgreet-session> greetd-wlgreet-session make-greetd-wlgreet-session greetd-wlgreet-session? (wlgreet greetd-wlgreet (default wlgreet)) (command greetd-wlgreet-command (default (file-append sway "/bin/sway"))) (command-args greetd-wlgreet-command-args (default '())) (output-mode greetd-wlgreet-output-mode (default "all")) (scale greetd-wlgreet-scale (default 1)) (background greetd-wlgreet-background (default '(0 0 0 0.9))) (headline greetd-wlgreet-headline (default '(1 1 1 1))) (prompt greetd-wlgreet-prompt (default '(1 1 1 1))) (prompt-error greetd-wlgreet-prompt-error (default '(1 1 1 1))) (border greetd-wlgreet-border (default '(1 1 1 1))) (extra-env greetd-wlgreet-extra-env (default '()))) (define (greetd-wlgreet-wayland-session-command session) (program-file "wlgreet-session-command" #~(let* ((username (getenv "USER")) (useruid (number->string (passwd:uid (getpwuid username)))) (command #$(greetd-wlgreet-command session))) (use-modules (ice-9 match)) (setenv "XDG_SESSION_TYPE" "wayland") (setenv "XDG_RUNTIME_DIR" (string-append "/run/user/" useruid)) (for-each (lambda (env) (setenv (car env) (cdr env))) '(#$@(greetd-wlgreet-extra-env session))) (apply execl command command (list #$@(greetd-wlgreet-command-args session)))))) (define (make-wlgreet-config-color section-name color) (match color ((red green blue opacity) (string-append "[" section-name "]\n" "red = " (number->string red) "\n" "green = " (number->string green) "\n" "blue = " (number->string blue) "\n" "opacity = " (number->string opacity) "\n")))) (define (make-wlgreet-configuration-file session) (let ((command (greetd-wlgreet-wayland-session-command session)) (output-mode (greetd-wlgreet-output-mode session)) (scale (greetd-wlgreet-scale session)) (background (greetd-wlgreet-background session)) (headline (greetd-wlgreet-headline session)) (prompt (greetd-wlgreet-prompt session)) (prompt-error (greetd-wlgreet-prompt-error session)) (border (greetd-wlgreet-border session))) (mixed-text-file "wlgreet.toml" "command = \"" command "\"\n" "outputMode = \"" output-mode "\"\n" "scale = " (number->string scale) "\n" (apply string-append (map (match-lambda ((section-name . color) (make-wlgreet-config-color section-name color))) `(("background" . ,background) ("headline" . ,headline) ("prompt" . ,prompt) ("prompt-error" . ,prompt-error) ("border" . ,border))))))) (define-record-type* <greetd-wlgreet-sway-session> greetd-wlgreet-sway-session make-greetd-wlgreet-sway-session greetd-wlgreet-sway-session? (wlgreet-session greetd-wlgreet-sway-session-wlgreet-session ;<greetd-wlgreet-session> (default (greetd-wlgreet-session))) (sway greetd-wlgreet-sway-session-sway (default sway)) ;<package> (sway-configuration greetd-wlgreet-sway-session-sway-configuration ;file-like (default (plain-file "wlgreet-sway-config" "")))) (define (make-wlgreet-sway-configuration-file session) (let* ((wlgreet-session (greetd-wlgreet-sway-session-wlgreet-session session)) (wlgreet-config (make-wlgreet-configuration-file wlgreet-session)) (wlgreet (file-append (greetd-wlgreet wlgreet-session) "/bin/wlgreet")) (sway-config (greetd-wlgreet-sway-session-sway-configuration session)) (swaymsg (file-append (greetd-wlgreet-sway-session-sway session) "/bin/swaymsg"))) (mixed-text-file "wlgreet-sway.conf" "include " sway-config "\n" "xwayland disable\n" "exec \"" wlgreet " --config " wlgreet-config "; " swaymsg " exit\"\n"))) (define-gexp-compiler (greetd-wlgreet-sway-session-compiler (session <greetd-wlgreet-sway-session>) system target) (let ((sway (file-append (greetd-wlgreet-sway-session-sway session) "/bin/sway")) (config (make-wlgreet-sway-configuration-file session))) (lower-object (program-file "wlgreet-sway-session-command" #~(let* ((log-file (open-output-file (string-append "/tmp/sway-greeter." (number->string (getpid)) ".log"))) (username (getenv "USER")) (useruid (number->string (passwd:uid (getpwuid username))))) ;; redirect stdout/err to log-file (dup2 (fileno log-file) 1) (dup2 1 2) (sleep 1) ;give seatd/logind some time to start up (setenv "XDG_RUNTIME_DIR" (string-append "/run/user/" useruid)) (execl #$sway #$sway "-d" "-c" #$config)))))) (define-record-type* <greetd-terminal-configuration> greetd-terminal-configuration make-greetd-terminal-configuration greetd-terminal-configuration? (greetd greetd-package (default greetd)) (config-file-name greetd-config-file-name (thunked) (default (default-config-file-name this-record))) (log-file-name greetd-log-file-name (thunked) (default (default-log-file-name this-record))) (terminal-vt greetd-terminal-vt (default "7")) (terminal-switch greetd-terminal-switch (default #f)) (source-profile? greetd-source-profile? (default #t)) (default-session-user greetd-default-session-user (default "greeter")) (default-session-command greetd-default-session-command (default (greetd-agreety-session)))) (define (default-config-file-name config) (string-join (list "config-" (greetd-terminal-vt config) ".toml") "")) (define (default-log-file-name config) (string-join (list "/var/log/greetd-" (greetd-terminal-vt config) ".log") "")) (define (make-greetd-terminal-configuration-file config) (let* ((config-file-name (greetd-config-file-name config)) (source-profile? (greetd-source-profile? config)) (terminal-vt (greetd-terminal-vt config)) (terminal-switch (greetd-terminal-switch config)) (default-session-user (greetd-default-session-user config)) (default-session-command (greetd-default-session-command config))) (mixed-text-file config-file-name "[general]\n" "source_profile = " (if source-profile? "true" "false") "\n" "[terminal]\n" "vt = " terminal-vt "\n" "switch = " (if terminal-switch "true" "false") "\n" "[default_session]\n" "user = " default-session-user "\n" "command = " default-session-command "\n"))) (define %greetd-file-systems (list (file-system (device "none") (mount-point "/run/greetd/pam_mount") (type "tmpfs") (check? #f) (flags '(no-suid no-dev no-exec)) (options "mode=0755") (create-mount-point? #t)))) (define %greetd-pam-mount-rules `((debug (@ (enable "0"))) (volume (@ (sgrp "users") (fstype "tmpfs") (mountpoint "/run/user/%(USERUID)") (options "noexec,nosuid,nodev,size=1g,mode=0700,uid=%(USERUID),gid=%(USERGID)"))) (logout (@ (wait "0") (hup "0") (term "yes") (kill "no"))) (mkmountpoint (@ (enable "1") (remove "true"))))) (define-record-type* <greetd-configuration> greetd-configuration make-greetd-configuration greetd-configuration? (motd greetd-motd (default %default-motd)) (allow-empty-passwords? greetd-allow-empty-passwords? (default #t)) (terminals greetd-terminals (default '())) (greeter-supplementary-groups greetd-greeter-supplementary-groups (default '()))) (define (greetd-accounts config) (list (user-group (name "greeter") (system? #t)) (user-account (name "greeter") (group "greeter") (supplementary-groups (greetd-greeter-supplementary-groups config)) (system? #t)))) (define (make-greetd-pam-mount-conf-file config) (computed-file "greetd_pam_mount.conf.xml" #~(begin (use-modules (sxml simple)) (call-with-output-file #$output (lambda (port) (sxml->xml '(*TOP* (*PI* xml "version='1.0' encoding='utf-8'") (pam_mount #$@%greetd-pam-mount-rules (pmvarrun #$(file-append greetd-pam-mount "/sbin/pmvarrun -u '%(USER)' -o '%(OPERATION)'")))) port)))))) (define (greetd-etc-service config) `(("security/greetd_pam_mount.conf.xml" ,(make-greetd-pam-mount-conf-file config)))) (define (greetd-pam-service config) (define optional-pam-mount (pam-entry (control "optional") (module (file-append greetd-pam-mount "/lib/security/pam_mount.so")) (arguments '("disable_interactive")))) (list (unix-pam-service "greetd" #:login-uid? #t #:allow-empty-passwords? (greetd-allow-empty-passwords? config) #:motd (greetd-motd config)) (pam-extension (transformer (lambda (pam) (if (member (pam-service-name pam) '("login" "greetd" "su" "slim" "gdm-password")) (pam-service (inherit pam) (auth (append (pam-service-auth pam) (list optional-pam-mount))) (session (append (pam-service-session pam) (list optional-pam-mount)))) pam)))))) (define (greetd-shepherd-services config) (map (lambda (tc) (let* ((greetd-bin (file-append (greetd-package tc) "/sbin/greetd")) (greetd-conf (make-greetd-terminal-configuration-file tc)) (greetd-log (greetd-log-file-name tc)) (greetd-vt (greetd-terminal-vt tc))) (shepherd-service (documentation "Minimal and flexible login manager daemon") (requirement '(pam user-processes host-name udev virtual-terminal)) (provision (list (symbol-append 'term-tty (string->symbol (greetd-terminal-vt tc))))) (start #~(make-forkexec-constructor (list #$greetd-bin "-c" #$greetd-conf) #:log-file #$greetd-log)) (stop #~(make-kill-destructor))))) (greetd-terminals config))) (define greetd-service-type (service-type (name 'greetd) (description "Provides necessary infrastructure for logging into the system including @code{greetd} PAM service, @code{pam-mount} module to mount/unmount /run/user/<uid> directory for user and @code{greetd} login manager daemon.") (extensions (list (service-extension account-service-type greetd-accounts) (service-extension file-system-service-type (const %greetd-file-systems)) (service-extension etc-service-type greetd-etc-service) (service-extension pam-root-service-type greetd-pam-service) (service-extension shepherd-root-service-type greetd-shepherd-services))) (default-value (greetd-configuration)))) (define %base-services ;; Convenience variable holding the basic services. (list (service login-service-type) (service virtual-terminal-service-type) (service console-font-service-type (map (lambda (tty) (cons tty %default-console-font)) '("tty1" "tty2" "tty3" "tty4" "tty5" "tty6"))) (service syslog-service-type) (service agetty-service-type (agetty-configuration (extra-options '("-L")) ; no carrier detect (term "vt100") (tty #f) ; automatic (shepherd-requirement '(syslogd)))) (service mingetty-service-type (mingetty-configuration (tty "tty1"))) (service mingetty-service-type (mingetty-configuration (tty "tty2"))) (service mingetty-service-type (mingetty-configuration (tty "tty3"))) (service mingetty-service-type (mingetty-configuration (tty "tty4"))) (service mingetty-service-type (mingetty-configuration (tty "tty5"))) (service mingetty-service-type (mingetty-configuration (tty "tty6"))) (service static-networking-service-type (list %loopback-static-networking)) (service urandom-seed-service-type) (service guix-service-type) (service nscd-service-type) (service rottlog-service-type) ;; Periodically delete old build logs. (service log-cleanup-service-type (log-cleanup-configuration (directory "/var/log/guix/drvs"))) ;; The LVM2 rules are needed as soon as LVM2 or the device-mapper is ;; used, so enable them by default. The FUSE and ALSA rules are ;; less critical, but handy. (service udev-service-type (udev-configuration (rules (list lvm2 fuse alsa-utils crda)))) (service sysctl-service-type) (service special-files-service-type `(("/bin/sh" ,(file-append bash "/bin/sh")) ("/usr/bin/env" ,(file-append coreutils "/bin/env")))))) ;;; base.scm ends here
generated by cgit