summaryrefslogtreecommitdiff
path: root/gnu/services/upnp.scm
blob: 16c32463534e4b48de14976e9e9799f716b510cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2024 Fabio Natali <me@fabionatali.com>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu services upnp)
  #:use-module (gnu build linux-container)
  #:use-module (gnu packages admin)
  #:use-module (gnu packages upnp)
  #:use-module (gnu services admin)
  #:use-module (gnu services base)
  #:use-module (gnu services shepherd)
  #:use-module (gnu services)
  #:use-module (gnu system file-systems)
  #:use-module (gnu system shadow)
  #:use-module (guix gexp)
  #:use-module (guix least-authority)
  #:use-module (guix modules)
  #:use-module (guix records)
  #:use-module (ice-9 match)
  #:export (%readymedia-default-cache-directory
            %readymedia-default-log-file
            %readymedia-default-pid-directory
            %readymedia-pid-file
            %readymedia-user-account
            %readymedia-user-group
            readymedia-configuration
            readymedia-configuration?
            readymedia-configuration-readymedia
            readymedia-configuration-port
            readymedia-configuration-cache-directory
            readymedia-configuration-extra-config
            readymedia-configuration-friendly-name
            readymedia-configuration-log-directory
            readymedia-configuration-media-directories
            readymedia-media-directory
            readymedia-media-directory-path
            readymedia-media-directory-types
            readymedia-media-directory?
            readymedia-service-type
            readymedia-activation
            readymedia-shepherd-service))

;;; Commentary:
;;;
;;; UPnP services.
;;;
;;; Code:

(define* (%readymedia-default-cache-directory #:key (home-service? #f))
  (if home-service?
      ".cache/readymedia"
      "/var/cache/readymedia"))
(define* (%readymedia-default-log-file #:key (home-service? #f))
  (if home-service?
      #~(begin
          (use-modules (shepherd support)) ;for %user-log-dir
          (string-append %user-log-dir "/readymedia.log"))
      "/var/log/readymedia.log"))
(define %readymedia-default-pid-directory "/var/run/readymedia")
(define* (%readymedia-pid-file #:key (home-service? #f) (name "minidlna.pid"))
  (if home-service?
      #~(begin
          (use-modules (shepherd support)) ;for %user-runtime-dir
          (string-append %user-runtime-dir "/readymedia/" #$name))
      (string-append %readymedia-default-pid-directory "/" name)))
(define %readymedia-user-group "readymedia")
(define %readymedia-user-account "readymedia")

(define-record-type* <readymedia-configuration>
  readymedia-configuration make-readymedia-configuration
  readymedia-configuration?
  (readymedia readymedia-configuration-readymedia
              (default readymedia))
  (port readymedia-configuration-port
        (default #f))
  (cache-directory readymedia-configuration-cache-directory
                   (default (%readymedia-default-cache-directory
                             #:home-service? for-home?)))
  (log-file readymedia-configuration-log-directory
            (default (%readymedia-default-log-file
                      #:home-service? for-home?)))
  (friendly-name readymedia-configuration-friendly-name
                 (default #f))
  (media-directories readymedia-configuration-media-directories)
  (extra-config readymedia-configuration-extra-config
                (default '()))
  (home-service? readymedia-configuration-home-service?
                 (default for-home?) (innate)))

;; READYMEDIA-MEDIA-DIR is a record that indicates the path of a media folder
;; and the types of media included within it. Allowed individual types are the
;; symbols 'A' for audio, 'V' for video, and 'P' for pictures. The types field
;; can contain any combination of individual types; an empty list means that
;; no type is specified.
(define-record-type* <readymedia-media-directory>
  readymedia-media-directory make-readymedia-media-directory
  readymedia-media-directory?
  (path readymedia-media-directory-path)
  (types readymedia-media-directory-types
         (default '())))

(define (readymedia-configuration->config-file config)
  "Return the ReadyMedia/MiniDLNA configuration file corresponding to CONFIG."
  (match-record config <readymedia-configuration>
    (port friendly-name cache-directory media-directories extra-config
     home-service?)
    (apply mixed-text-file
           "minidlna.conf"
           "db_dir=" cache-directory "\n"
           (if friendly-name
               (string-append "friendly_name=" friendly-name "\n")
               "")
           (if port
               (string-append "port=" (number->string port) "\n")
               "")
           (append (map (match-record-lambda <readymedia-media-directory>
                            (path types)
                          (apply string-append
                                 "media_dir="
                                 (append (map symbol->string types)
                                         (match types
                                           (() (list))
                                           (_ (list ",")))
                                         (list path "\n"))))
                        media-directories)
                   (map (match-lambda
                          ((key . value)
                           (string-append key "=" value "\n")))
                        extra-config)))))

(define (readymedia-shepherd-service config)
  "Return a least-authority ReadyMedia/MiniDLNA Shepherd service."
  (match-record config <readymedia-configuration>
    (cache-directory log-file media-directories home-service?)
    (let ((minidlna-conf (readymedia-configuration->config-file config)))
      (shepherd-service
       (documentation "Run the ReadyMedia/MiniDLNA daemon.")
       (provision '(readymedia))
       (requirement (if home-service? '() '(networking user-processes)))
       (modules '((shepherd support))) ;for %user-log-dir
       (start
        (if (not home-service?)
            #~(make-forkexec-constructor
               (list #$(least-authority-wrapper
                        (file-append (readymedia-configuration-readymedia
                                      config)
                                     "/sbin/minidlnad")
                        #:name "minidlna"
                        #:mappings
                        (cons* (file-system-mapping
                                (source cache-directory)
                                (target source)
                                (writable? #t))
                               (file-system-mapping
                                (source %readymedia-default-pid-directory)
                                (target source)
                                (writable? #t))
                               (file-system-mapping
                                (source minidlna-conf)
                                (target source))
                               (map (lambda (directory)
                                      (file-system-mapping
                                       (source (readymedia-media-directory-path
                                                directory))
                                       (target source)))
                                    media-directories))
                        #:namespaces (delq 'net %namespaces))
                     "-f"
                     #$minidlna-conf
                     "-P"
                     #$(%readymedia-pid-file)
                     "-S")
               #:log-file #$log-file
               #:user #$(if home-service? #f %readymedia-user-account)
               #:group #$(if home-service? #f %readymedia-user-group))

            ;; Relative paths to home directories are not being able to be
            ;; mapped within the least-authority-wrapper.  So, for home we use
            ;; the program without wrapping it.
            #~(make-forkexec-constructor
               (list #$(file-append (readymedia-configuration-readymedia
                                     config)
                                    "/sbin/minidlnad")
                     "-f"
                     #$minidlna-conf
                     "-P"
                     #$(%readymedia-pid-file #:home-service? home-service?)
                     "-S")
               #:log-file #$log-file)))
       (stop #~(make-kill-destructor))))))

(define readymedia-accounts
  (list (user-account
         (name "readymedia")
         (group "readymedia")
         (system? #t)
         (comment "ReadyMedia/MiniDLNA daemon user")
         (home-directory "/var/empty")
         (shell (file-append shadow "/sbin/nologin")))
        (user-group
         (name "readymedia")
         (system? #t))))

(define (readymedia-activation config)
  "Set up directories for ReadyMedia/MiniDLNA."
  (match-record config <readymedia-configuration>
    (cache-directory media-directories home-service?)
    (with-imported-modules (source-module-closure '((gnu build activation)))
      #~(begin
          (use-modules (gnu build activation))

          (for-each (lambda (directory)
                      (let ((directory
                             (if #$home-service?
                                 (if (absolute-file-name? directory)
                                     directory
                                     (string-append (or (getenv "HOME")
                                                        (passwd:dir
                                                         (getpwuid (getuid))))
                                                    "/" directory))
                                 directory)))
                        (unless (file-exists? directory)
                          (mkdir-p/perms directory
                                         (getpw #$(if home-service?
                                                      #~(getuid)
                                                      %readymedia-user-account))
                                         #$(if home-service? #o755 #o775)))))
                    (list #$@(map readymedia-media-directory-path
                                  media-directories)))
          (for-each (lambda (directory)
                      (unless (file-exists? directory)
                        (mkdir-p/perms directory
                                       (getpw #$(if home-service?
                                                    #~(getuid)
                                                    %readymedia-user-account))
                                       #o755)))
                    (list (if #$home-service?
                              (if (absolute-file-name? #$cache-directory)
                                  #$cache-directory
                                  (string-append (or (getenv "HOME")
                                                     (passwd:dir
                                                      (getpwuid (getuid))))
                                                 "/" #$cache-directory))
                               #$cache-directory)
                          (dirname #$(%readymedia-pid-file
                                      #:home-service? home-service?))))))))

(define readymedia-service-type
  (service-type
   (name 'readymedia)
   (extensions
    (list (service-extension shepherd-root-service-type
                             (compose list readymedia-shepherd-service))
          (service-extension account-service-type
                             (const readymedia-accounts))
          (service-extension activation-service-type
                             readymedia-activation)))
   (description
    "Run @command{minidlnad}, the ReadyMedia/MiniDLNA media server.")))