;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu system accounts)
  #:use-module (guix records)
  #:use-module (ice-9 match)
  #:export (user-account
            user-account?
            user-account-name
            user-account-password
            user-account-uid
            user-account-group
            user-account-supplementary-groups
            user-account-comment
            user-account-home-directory
            user-account-create-home-directory?
            user-account-shell
            user-account-system?

            user-group
            user-group?
            user-group-name
            user-group-password
            user-group-id
            user-group-system?

            sexp->user-account
            sexp->user-group

            default-shell))


;;; Commentary:
;;;
;;; Data structures representing user accounts and user groups.  This is meant
;;; to be used both on the host side and at run time--e.g., in activation
;;; snippets.
;;;
;;; Code:

(define default-shell
  ;; Default shell for user accounts (a string or string-valued gexp).
  (make-parameter "/bin/sh"))

(define-record-type* <user-account>
  user-account make-user-account
  user-account?
  (name           user-account-name)
  (password       user-account-password (default #f))
  (uid            user-account-uid (default #f))
  (group          user-account-group)             ; number | string
  (supplementary-groups user-account-supplementary-groups
                        (default '()))            ; list of strings
  (comment        user-account-comment (default ""))
  (home-directory user-account-home-directory (thunked)
                  (default (default-home-directory this-record)))
  (create-home-directory? user-account-create-home-directory? ;Boolean
                          (default #t))
  (shell          user-account-shell              ; gexp
                  (default (default-shell)))
  (system?        user-account-system?            ; Boolean
                  (default #f)))

(define-record-type* <user-group>
  user-group make-user-group
  user-group?
  (name           user-group-name)
  (password       user-group-password (default #f))
  (id             user-group-id (default #f))
  (system?        user-group-system?              ; Boolean
                  (default #f)))

(define (default-home-directory account)
  "Return the default home directory for ACCOUNT."
  (string-append "/home/" (user-account-name account)))

(define (sexp->user-group sexp)
  "Take SEXP, a tuple as returned by 'user-group->gexp', and turn it into a
user-group record."
  (match sexp
    ((name password id system?)
     (user-group (name name)
                 (password password)
                 (id id)
                 (system? system?)))))

(define (sexp->user-account sexp)
  "Take SEXP, a tuple as returned by 'user-account->gexp', and turn it into a
user-account record."
  (match sexp
    ((name uid group supplementary-groups comment home-directory
           create-home-directory? shell password system?)
     (user-account (name name) (uid uid) (group group)
                   (supplementary-groups supplementary-groups)
                   (comment comment)
                   (home-directory home-directory)
                   (create-home-directory? create-home-directory?)
                   (shell shell) (password password)
                   (system? system?)))))
c.
* gnu/packages/irods.scm (irods, irods-client-icommands): Likewise for
libcxx, catch2, and nlohmann-json-cpp.
* gnu/packages/julia.scm (julia): Use 'search-input-file' for libuv's
errno.h.
* gnu/packages/kde-pim.scm (kdepim-runtime): Use
'search-input-directory' for "include/KF5".
(kmessagelib): Likewise.
* gnu/packages/kde.scm (kdeconnect): Likewise.
* gnu/packages/llvm.scm (clang-runtime-3.5): Likewise for libtirpc.
* gnu/packages/mpi.scm (openmpi): Likewise for "include/infiniband".
* gnu/packages/pumpio.scm (pumpa): Use 'search-input-file' for "tidy.h"
and "aspell.h".
* gnu/packages/radio.scm (dream): Use 'search-input-file' and
'search-input-directory' for pulseaudio, sndfile, etc.
* gnu/packages/selinux.scm (policycoreutils): Likewise for PAM and
libaudit.
* gnu/packages/serialization.scm (avro-cpp-1.9-for-irods): Likewise for
libcxx.
* gnu/packages/sync.scm (nextcloud-client): Likewise for "include/KF5".
* gnu/packages/video.scm (mkvtoolnix): Likewise for "include/gtest".
(libopenshot): Likewise for "include/UnitTest++".
* gnu/packages/virtualization.scm (criu): Likewise for libnl3 and for
protobuf file.
</span></span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2020-04-02 20:55:14 +0200'>2020-04-02</span></td><td><a href='/guix/commit/gnu/packages/cedille.scm?id=be41d7d91df123a454e871190f1bb2711409bfa8'>gnu: cedille: Install the info pages.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/cedille.scm (cedille)[arguments]: Rename phase
'patch-cedille-path-el' to 'patch-cedille-paths' and add substitution for the
info page location.   In the 'copy-cedille-mode' phase, install the info page.

Signed-off-by: Marius Bakke &lt;mbakke@fastmail.com&gt;
</span></span></td><td>John Soo</td></tr>
<tr><td><span title='2020-04-02 20:55:14 +0200'>2020-04-02</span></td><td><a href='/guix/commit/gnu/packages/cedille.scm?id=a8f1b52017820c87b9bb38abb42b48d8059688d3'>gnu: cedille: Fix emacs outputs.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/cedille.scm (cedille):[arguments] Add slashes to output paths.

Signed-off-by: Marius Bakke &lt;mbakke@fastmail.com&gt;
</span></span></td><td>John Soo</td></tr>
<tr><td><span title='2020-03-19 12:07:10 -0400'>2020-03-19</span></td><td><a href='/guix/commit/gnu/packages/cedille.scm?id=0a3ce07784c74ff27b864884499deca41c3d4d0e'>gnu: cedille: Remove guix.d from the Elisp installation directory.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/cedille.scm (cedille)[phases]{patch-cedille-path-el}: Update
the Elisp installation prefix used.
{copy-cedille-mode}: Likewise.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2020-02-23 19:01:22 +0100'>2020-02-23</span></td><td><a href='/guix/commit/gnu/packages/cedille.scm?id=1063dea4ff8a5106b51de8d6de7e23753403c81e'>gnu: cedille: Update to 1.1.2.</a><span class='msg-avail'>...<span class='msg-tooltip'>* gnu/packages/cedille.scm (cedille): Update to 1.1.2.

Signed-off-by: Tobias Geerinckx-Rice &lt;me@tobias.gr&gt;
</span></span></td><td>John Soo</td></tr>