aboutsummaryrefslogtreecommitdiff
path: root/gnu/services/audio.scm
diff options
context:
space:
mode:
authorBruno Victal <mirai@makinata.eu>2023-03-26 19:41:32 +0100
committerLiliana Marie Prikler <liliana.prikler@gmail.com>2023-04-02 12:35:30 +0200
commit7fdadeac11a997583305cb867b4a8828808ae953 (patch)
tree7b2ad36fb2580dcb85cf2f0f70722d14dfea3ccb /gnu/services/audio.scm
parent2c4df1a41af70ebbae4422878ce6a4c8600c6811 (diff)
downloadguix-7fdadeac11a997583305cb867b4a8828808ae953.tar
guix-7fdadeac11a997583305cb867b4a8828808ae953.tar.gz
services: mpd: Use proper records for user and group fields.
Deprecate using strings for these fields and prefer user-account (resp. user-group) instead to avoid duplication within account-service-type. Fixes #61570 <https://issues.guix.gnu.org/61570>. * gnu/services/audio.scm (%mpd-user, %mpd-group) (mpd-serialize-user-account, mpd-serialize-user-group) (mpd-user-sanitizer, mpd-group-sanitizer): New variables. (mpd-configuration)[user]: Use user-account as value type. Sanitize via mpd-user-sanitizer. [group]: Use user-group as value type. Sanitize via mpd-group-sanitizer. (mpd-shepherd-service): Adjust accordingly. (mpd-accounts): Likewise. * doc/guix.texi (Audio Services)[Music Player Daemon]: Likewise. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
Diffstat (limited to 'gnu/services/audio.scm')
-rw-r--r--gnu/services/audio.scm87
1 files changed, 70 insertions, 17 deletions
diff --git a/gnu/services/audio.scm b/gnu/services/audio.scm
index bc4aed71dc..854efd744a 100644
--- a/gnu/services/audio.scm
+++ b/gnu/services/audio.scm
@@ -140,6 +140,14 @@
(define list-of-symbol?
(list-of symbol?))
+;; Helpers for deprecated field types, to be removed later.
+(define %lazy-group (make-symbol "%lazy-group"))
+
+(define (%set-user-group user group)
+ (user-account
+ (inherit user)
+ (group (user-group-name group))))
+
;;;
;;; MPD
@@ -164,10 +172,31 @@
(define (mpd-serialize-list-of-strings field-name value)
#~(string-append #$@(map (cut mpd-serialize-string field-name <>) value)))
+(define (mpd-serialize-user-account field-name value)
+ (mpd-serialize-string field-name (user-account-name value)))
+
+(define (mpd-serialize-user-group field-name value)
+ (mpd-serialize-string field-name (user-group-name value)))
+
(define-maybe string (prefix mpd-))
(define-maybe list-of-strings (prefix mpd-))
(define-maybe boolean (prefix mpd-))
+(define %mpd-user
+ (user-account
+ (name "mpd")
+ (group %lazy-group)
+ (system? #t)
+ (comment "Music Player Daemon (MPD) user")
+ ;; MPD can use $HOME (or $XDG_CONFIG_HOME) to place its data
+ (home-directory "/var/lib/mpd")
+ (shell (file-append shadow "/sbin/nologin"))))
+
+(define %mpd-group
+ (user-group
+ (name "mpd")
+ (system? #t)))
+
;;; TODO: Procedures for deprecated fields, to be removed.
(define mpd-deprecated-fields '((music-dir . music-directory)
@@ -197,6 +226,33 @@
(define-maybe port (prefix mpd-))
+;;; Procedures for unsupported value types, to be removed.
+
+(define (mpd-user-sanitizer value)
+ (cond ((user-account? value) value)
+ ((string? value)
+ (warning (G_ "string value for 'user' is deprecated, use \
+user-account instead~%"))
+ (user-account
+ (inherit %mpd-user)
+ (name value)
+ ;; XXX: This is to be lazily substituted in (…-accounts)
+ ;; with the value from 'group'.
+ (group %lazy-group)))
+ (else
+ (configuration-field-error #f 'user value))))
+
+(define (mpd-group-sanitizer value)
+ (cond ((user-group? value) value)
+ ((string? value)
+ (warning (G_ "string value for 'group' is deprecated, use \
+user-group instead~%"))
+ (user-group
+ (inherit %mpd-group)
+ (name value)))
+ (else
+ (configuration-field-error #f 'group value))))
+
;;;
;; Generic MPD plugin record, lists only the most prevalent fields.
@@ -347,12 +403,14 @@ to be appended to the audio output configuration.")
empty-serializer)
(user
- (string "mpd")
- "The user to run mpd as.")
+ (user-account %mpd-user)
+ "The user to run mpd as."
+ (sanitizer mpd-user-sanitizer))
(group
- (string "mpd")
- "The group to run mpd as.")
+ (user-group %mpd-group)
+ "The group to run mpd as."
+ (sanitizer mpd-group-sanitizer))
(shepherd-requirement
(list-of-symbol '())
@@ -517,7 +575,8 @@ appended to the configuration.")
log-file playlist-directory
db-file state-file sticker-file
environment-variables)
- (let* ((config-file (mpd-serialize-configuration config)))
+ (let ((config-file (mpd-serialize-configuration config))
+ (username (user-account-name user)))
(shepherd-service
(documentation "Run the MPD (Music Player Daemon)")
(requirement `(user-processes loopback ,@shepherd-requirement))
@@ -526,7 +585,7 @@ appended to the configuration.")
(and=> #$(maybe-value log-file)
(compose mkdir-p dirname))
- (let ((user (getpw #$user)))
+ (let ((user (getpw #$username)))
(for-each
(lambda (x)
(when (and x (not (file-exists? x)))
@@ -560,17 +619,11 @@ appended to the configuration.")
(define (mpd-accounts config)
(match-record config <mpd-configuration> (user group)
- (list (user-group
- (name group)
- (system? #t))
- (user-account
- (name user)
- (group group)
- (system? #t)
- (comment "Music Player Daemon (MPD) user")
- ;; MPD can use $HOME (or $XDG_CONFIG_HOME) to place its data
- (home-directory "/var/lib/mpd")
- (shell (file-append shadow "/sbin/nologin"))))))
+ ;; TODO: Deprecation code, to be removed.
+ (let ((user (if (eq? (user-account-group user) %lazy-group)
+ (%set-user-group user group)
+ user)))
+ (list user group))))
(define mpd-service-type
(service-type