1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
| | ;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2017 Clément Lassieur <clement@lassieur.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 services messaging)
#:use-module (gnu packages messaging)
#:use-module (gnu packages admin)
#:use-module (gnu services)
#:use-module (gnu services shepherd)
#:use-module (gnu services configuration)
#:use-module (gnu system shadow)
#:use-module (guix gexp)
#:use-module (guix records)
#:use-module (guix packages)
#:use-module (srfi srfi-1)
#:use-module (srfi srfi-35)
#:use-module (ice-9 match)
#:export (prosody-service-type
prosody-configuration
opaque-prosody-configuration
virtualhost-configuration
int-component-configuration
ext-component-configuration
mod-muc-configuration
ssl-configuration
%default-modules-enabled))
;;; Commentary:
;;;
;;; Messaging services.
;;;
;;; Code:
(define (id ctx . parts)
(datum->syntax ctx (apply symbol-append (map syntax->datum parts))))
(define-syntax define-maybe
(lambda (x)
(syntax-case x ()
((_ stem)
(with-syntax
((stem? (id #'stem #'stem #'?))
(maybe-stem? (id #'stem #'maybe- #'stem #'?))
(serialize-stem (id #'stem #'serialize- #'stem))
(serialize-maybe-stem (id #'stem #'serialize-maybe- #'stem)))
#'(begin
(define (maybe-stem? val)
(or (eq? val 'disabled) (stem? val)))
(define (serialize-maybe-stem field-name val)
(when (stem? val) (serialize-stem field-name val)))))))))
(define-syntax define-all-configurations
(lambda (stx)
(define (make-pred arg)
(lambda (field target)
(and (memq (syntax->datum target) `(common ,arg)) field)))
(syntax-case stx ()
((_ stem (field (field-type def) doc target) ...)
(with-syntax (((new-field-type ...)
(map (lambda (field-type target)
(if (and (eq? 'common (syntax->datum target))
(not (string-prefix?
"maybe-"
(symbol->string
(syntax->datum field-type)))))
(id #'stem #'maybe- field-type) field-type))
#'(field-type ...) #'(target ...)))
((new-def ...)
(map (lambda (def target)
(if (eq? 'common (syntax->datum target))
#''disabled def))
#'(def ...) #'(target ...)))
((new-doc ...)
(map (lambda (doc target)
(if (eq? 'common (syntax->datum target))
"" doc))
#'(doc ...) #'(target ...))))
#`(begin
(define common-fields
'(#,@(filter-map (make-pred #f) #'(field ...) #'(target ...))))
(define-configuration prosody-configuration
#,@(filter-map (make-pred 'global)
#'((field (field-type def) doc) ...)
#'(target ...)))
(define-configuration virtualhost-configuration
#,@(filter-map (make-pred 'virtualhost)
#'((field (new-field-type new-def) new-doc) ...)
#'(target ...)))
(define-configuration int-component-configuration
#,@(filter-map (make-pred 'int-component)
#'((field (new-field-type new-def) new-doc) ...)
#'(target ...)))
(define-configuration ext-component-configuration
#,@(filter-map (make-pred 'ext-component)
#'((field (new-field-type new-def) new-doc) ...)
#'(target ...)))))))))
(define (uglify-field-name field-name)
(let ((str (symbol->string field-name)))
(string-join (string-split (if (string-suffix? "?" str)
(substring str 0 (1- (string-length str)))
str)
#\-)
"_")))
(define (serialize-field field-name val)
(format #t "~a = ~a;\n" (uglify-field-name field-name) val))
(define (serialize-field-list field-name val)
(serialize-field field-name
(with-output-to-string
(lambda ()
(format #t "{\n")
(for-each (lambda (x)
(format #t "~a;\n" x))
val)
(format #t "}")))))
(define (serialize-boolean field-name val)
(serialize-field field-name (if val "true" "false")))
(define-maybe boolean)
(define (string-or-boolean? val)
(or (string? val) (boolean? val)))
(define (serialize-string-or-boolean field-name val)
(if (string? val)
(serialize-string field-name val)
(serialize-boolean field-name val)))
(define (non-negative-integer? val)
(and (exact-integer? val) (not (negative? val))))
(define (serialize-non-negative-integer field-name val)
(serialize-field field-name val))
(define-maybe non-negative-integer)
(define (non-negative-integer-list? val)
(and (list? val) (and-map non-negative-integer? val)))
(define (serialize-non-negative-integer-list field-name val)
(serialize-field-list field-name val))
(define-maybe non-negative-integer-list)
(define (enclose-quotes s)
(format #f "\"~a\"" s))
(define (serialize-string field-name val)
(serialize-field field-name (enclose-quotes val)))
(define-maybe string)
(define (string-list? val)
(and (list? val)
(and-map (lambda (x)
(and (string? x) (not (string-index x #\,))))
val)))
(define (serialize-string-list field-name val)
(serialize-field-list field-name (map enclose-quotes val)))
(define-maybe string-list)
(define (module-list? val)
(string-list? val))
(define (serialize-module-list field-name val)
(serialize-string-list field-name (cons "posix" val)))
(define-maybe module-list)
(define (file-name? val)
(and (string? val)
(string-prefix? "/" val)))
(define (serialize-file-name field-name val)
(serialize-string field-name val))
(define-maybe file-name)
(define (file-name-list? val)
(and (list? val) (and-map file-name? val)))
(define (serialize-file-name-list field-name val)
(serialize-string-list field-name val))
(define-maybe file-name)
(define-configuration mod-muc-configuration
(name
(string "Prosody Chatrooms")
"The name to return in service discovery responses.")
(restrict-room-creation
(string-or-boolean #f)
"If @samp{#t}, this will only allow admins to create new chatrooms.
Otherwise anyone can create a room. The value @samp{\"local\"} restricts room
creation to users on the service's parent domain. E.g. @samp{user@@example.com}
can create rooms on @samp{rooms.example.com}. The value @samp{\"admin\"}
restricts to service administrators only.")
(max-history-messages
(non-negative-integer 20)
"Maximum number of history messages that will be sent to the member that has
just joined the room."))
(define (serialize-mod-muc-configuration field-name val)
(serialize-configuration val mod-muc-configuration-fields))
(define-maybe mod-muc-configuration)
(define-configuration ssl-configuration
(protocol
(maybe-string 'disabled)
"This determines what handshake to use.")
(key
(file-name "/etc/prosody/certs/key.pem")
"Path to your private key file, relative to @code{/etc/prosody}.")
(certificate
(file-name "/etc/prosody/certs/cert.pem")
"Path to your certificate file, relative to @code{/etc/prosody}.")
(capath
(file-name "/etc/ssl/certs")
"Path to directory containing root certificates that you wish Prosody to
trust when verifying the certificates of remote servers.")
(cafile
(maybe-file-name 'disabled)
"Path to a file containing root certificates that you wish Prosody to trust.
Similar to @code{capath} but with all certificates concatenated together.")
(verify
(maybe-string-list 'disabled)
"A list of verification options (these mostly map to OpenSSL's
@code{set_verify()} flags).")
(options
(maybe-string-list 'disabled)
"A list of general options relating to SSL/TLS. These map to OpenSSL's
@code{set_options()}. For a full list of options available in LuaSec, see the
LuaSec source.")
(depth
(maybe-non-negative-integer 'disabled)
"How long a chain of certificate authorities to check when looking for a
trusted root certificate.")
(ciphers
(maybe-string 'disabled)
"An OpenSSL cipher string. This selects what ciphers Prosody will offer to
clients, and in what order.")
(dhparam
(maybe-file-name 'disabled)
"A path to a file containing parameters for Diffie-Hellman key exchange. You
can create such a file with:
@code{openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048}")
(curve
(maybe-string 'disabled)
"Curve for Elliptic curve Diffie-Hellman. Prosody's default is
@samp{\"secp384r1\"}.")
(verifyext
(maybe-string-list 'disabled)
"A list of \"extra\" verification options.")
(password
(maybe-string 'disabled)
"Password for encrypted private keys."))
(define (serialize-ssl-configuration field-name val)
(format #t "ssl = {\n")
(serialize-configuration val ssl-configuration-fields)
(format #t "};\n"))
(define-maybe ssl-configuration)
(define %default-modules-enabled
'("roster"
"saslauth"
"tls"
"dialback"
"disco"
"private"
"vcard"
"version"
"uptime"
"time"
"ping"
"pep"
"register"
"admin_adhoc"))
;; Guile bug. Use begin wrapper, because otherwise virtualhost-configuration
;; is assumed to be a function. See
;; https://www.gnu.org/software/guile/manual/html_node/R6RS-Incompatibilities.html
(begin
(define (virtualhost-configuration-list? val)
(and (list? val) (and-map virtualhost-configuration? val)))
(define (serialize-virtualhost-configuration-list l)
(for-each
(lambda (val) (serialize-virtualhost-configuration val)) l))
(define (int-component-configuration-list? val)
(and (list? val) (and-map int-component-configuration? val)))
(define (serialize-int-component-configuration-list l)
(for-each
(lambda (val) (serialize-int-component-configuration val)) l))
(define (ext-component-configuration-list? val)
(and (list? val) (and-map ext-component-configuration? val)))
(define (serialize-ext-component-configuration-list l)
(for-each
(lambda (val) (serialize-ext-component-configuration val)) l))
(define-all-configurations prosody-configuration
(prosody
(package prosody)
"The Prosody package."
global)
(data-path
(file-name "/var/lib/prosody")
"Location of the Prosody data storage directory. See
@url{http://prosody.im/doc/configure}."
global)
(plugin-paths
(file-name-list '())
"Additional plugin directories. They are searched in all the specified
paths in order. See @url{http://prosody.im/doc/plugins_directory}."
global)
(admins
(string-list '())
"This is a list of accounts that are admins for the server. Note that you
must create the accounts separately. See @url{http://prosody.im/doc/admins} and
@url{http://prosody.im/doc/creating_accounts}.
Example: @code{(admins '(\"user1@@example.com\" \"user2@@example.net\"))}"
common)
(use-libevent?
(boolean #f)
"Enable use of libevent for better performance under high load. See
@url{http://prosody.im/doc/libevent}."
common)
(modules-enabled
(module-list %default-modules-enabled)
"This is the list of modules Prosody will load on startup. It looks for
@code{mod_modulename.lua} in the plugins folder, so make sure that exists too.
Documentation on modules can be found at: @url{http://prosody.im/doc/modules}.
Defaults to @samp{%default-modules-enabled}."
common)
(modules-disabled
(string-list '())
"@samp{\"offline\"}, @samp{\"c2s\"} and @samp{\"s2s\"} are auto-loaded, but
should you want to disable them then add them to this list."
common)
(groups-file
(file-name "/var/lib/prosody/sharedgroups.txt")
"Path to a text file where the shared groups are defined. If this path is
empty then @samp{mod_groups} does nothing. See
@url{http://prosody.im/doc/modules/mod_groups}."
common)
(allow-registration?
(boolean #f)
"Disable account creation by default, for security. See
@url{http://prosody.im/doc/creating_accounts}."
common)
(ssl
(maybe-ssl-configuration (ssl-configuration))
"These are the SSL/TLS-related settings. Most of them are disabled so to
use Prosody's defaults. If you do not completely understand these options, do
not add them to your config, it is easy to lower the security of your server
using them. See @url{http://prosody.im/doc/advanced_ssl_config}."
common)
(c2s-require-encryption?
(boolean #f)
"Whether to force all client-to-server connections to be encrypted or not.
See @url{http://prosody.im/doc/modules/mod_tls}."
common)
(s2s-require-encryption?
(boolean #f)
"Whether to force all server-to-server connections to be encrypted or not.
See @url{http://prosody.im/doc/modules/mod_tls}."
common)
(s2s-secure-auth?
(boolean #f)
"Whether to require encryption and certificate authentication. This
provides ideal security, but requires servers you communicate with to support
encryption AND present valid, trusted certificates. See
@url{http://prosody.im/doc/s2s#security}."
common)
(s2s-insecure-domains
(string-list '())
"Many servers don't support encryption or have invalid or self-signed
certificates. You can list domains here that will not be required to
authenticate using certificates. They will be authenticated using DNS. See
@url{http://prosody.im/doc/s2s#security}."
common)
(s2s-secure-domains
(string-list '())
"Even if you leave @code{s2s-secure-auth?} disabled, you can still require
valid certificates for some domains by specifying a list here. See
@url{http://prosody.im/doc/s2s#security}."
common)
(authentication
(string "internal_plain")
"Select the authentication backend to use. The default provider stores
passwords in plaintext and uses Prosody's configured data storage to store the
authentication data. If you do not trust your server please see
@url{http://prosody.im/doc/modules/mod_auth_internal_hashed} for information
about using the hashed backend. See also
@url{http://prosody.im/doc/authentication}"
common)
;; TODO: Handle more complicated log structures.
(log
(maybe-string "*syslog")
"Set logging options. Advanced logging configuration is not yet supported
by the GuixSD Prosody Service. See @url{http://prosody.im/doc/logging}."
common)
(pidfile
(file-name "/var/run/prosody/prosody.pid")
"File to write pid in. See @url{http://prosody.im/doc/modules/mod_posix}."
global)
(virtualhosts
(virtualhost-configuration-list
(list (virtualhost-configuration
(domain "localhost"))))
"A host in Prosody is a domain on which user accounts can be created. For
example if you want your users to have addresses like
@samp{\"john.smith@@example.com\"} then you need to add a host
@samp{\"example.com\"}. All options in this list will apply only to this host.
Note: the name \"virtual\" host is used in configuration to avoid confusion with
the actual physical host that Prosody is installed on. A single Prosody
instance can serve many domains, each one defined as a VirtualHost entry in
Prosody's configuration. Conversely a server that hosts a single domain would
have just one VirtualHost entry.
See @url{http://prosody.im/doc/configure#virtual_host_settings}."
global)
(int-components
(int-component-configuration-list '())
"Components are extra services on a server which are available to clients,
usually on a subdomain of the main server (such as
@samp{\"mycomponent.example.com\"}). Example components might be chatroom
servers, user directories, or gateways to other protocols.
Internal components are implemented with Prosody-specific plugins. To add an
internal component, you simply fill the hostname field, and the plugin you wish
to use for the component.
See @url{http://prosody.im/doc/components}."
global)
(ext-components
(ext-component-configuration-list '())
"External components use XEP-0114, which most standalone components
support. To add an external component, you simply fill the hostname field. See
@url{http://prosody.im/doc/components}."
global)
(component-secret
(string (configuration-missing-field 'ext-component 'component-secret))
"Password which the component will use to log in."
ext-component)
(component-ports
(non-negative-integer-list '(5347))
"Port(s) Prosody listens on for component connections."
global)
(component-interface
(string "127.0.0.1")
"Interface Prosody listens on for component connections."
global)
(domain
(string (configuration-missing-field 'virtualhost 'domain))
"Domain you wish Prosody to serve."
virtualhost)
(hostname
(string (configuration-missing-field 'int-component 'hostname))
"Hostname of the component."
int-component)
(plugin
(string (configuration-missing-field 'int-component 'plugin))
"Plugin you wish to use for the component."
int-component)
(mod-muc
(maybe-mod-muc-configuration 'disabled)
"Multi-user chat (MUC) is Prosody's module for allowing you to create
hosted chatrooms/conferences for XMPP users.
General information on setting up and using MUC chatrooms can be found in our
\"Chatrooms\" documentation (@url{http://prosody.im/doc/chatrooms}), which you
should read if you are new to XMPP chatrooms.
See also @url{http://prosody.im/doc/modules/mod_muc}."
int-component)
(hostname
(string (configuration-missing-field 'ext-component 'hostname))
"Hostname of the component."
ext-component)))
;; Serialize Virtualhost line first.
(define (serialize-virtualhost-configuration config)
(define (rest? field)
(not (memq (configuration-field-name field)
'(domain))))
(let ((domain (virtualhost-configuration-domain config))
(rest (filter rest? virtualhost-configuration-fields)))
(format #t "VirtualHost \"~a\"\n" domain)
(serialize-configuration config rest)))
;; Serialize Component line first.
(define (serialize-int-component-configuration config)
(define (rest? field)
(not (memq (configuration-field-name field)
'(hostname plugin))))
(let ((hostname (int-component-configuration-hostname config))
(plugin (int-component-configuration-plugin config))
(rest (filter rest? int-component-configuration-fields)))
(format #t "Component \"~a\" \"~a\"\n" hostname plugin)
(serialize-configuration config rest)))
;; Serialize Component line first.
(define (serialize-ext-component-configuration config)
(define (rest? field)
(not (memq (configuration-field-name field)
'(hostname))))
(let ((hostname (ext-component-configuration-hostname config))
(rest (filter rest? ext-component-configuration-fields)))
(format #t "Component \"~a\"\n" hostname)
(serialize-configuration config rest)))
;; Serialize virtualhosts and components last.
(define (serialize-prosody-configuration config)
(define (rest? field)
(not (memq (configuration-field-name field)
'(virtualhosts int-components ext-components))))
(let ((rest (filter rest? prosody-configuration-fields)))
(serialize-configuration config rest))
(serialize-virtualhost-configuration-list
(prosody-configuration-virtualhosts config))
(serialize-int-component-configuration-list
(prosody-configuration-int-components config))
(serialize-ext-component-configuration-list
(prosody-configuration-ext-components config)))
(define-configuration opaque-prosody-configuration
(prosody
(package prosody)
"The prosody package.")
(prosody.cfg.lua
(string (configuration-missing-field 'opaque-prosody-configuration
'prosody.cfg.lua))
"The contents of the @code{prosody.cfg.lua} to use."))
(define (prosody-shepherd-service config)
"Return a <shepherd-service> for Prosody with CONFIG."
(let* ((prosody (if (opaque-prosody-configuration? config)
(opaque-prosody-configuration-prosody config)
(prosody-configuration-prosody config)))
(prosodyctl-bin (file-append prosody "/bin/prosodyctl"))
(prosodyctl-action (lambda args
#~(lambda _
(zero? (system* #$prosodyctl-bin #$@args))))))
(list (shepherd-service
(documentation "Run the Prosody XMPP server")
(provision '(prosody))
(requirement '(networking syslogd user-processes))
(start (prosodyctl-action "start"))
(stop (prosodyctl-action "stop"))))))
(define %prosody-accounts
(list (user-group (name "prosody") (system? #t))
(user-account
(name "prosody")
(group "prosody")
(system? #t)
(comment "Prosody daemon user")
(home-directory "/var/empty")
(shell (file-append shadow "/sbin/nologin")))))
(define (prosody-activation config)
"Return the activation gexp for CONFIG."
(let* ((config-dir "/etc/prosody")
(default-certs-dir "/etc/prosody/certs")
(data-path (prosody-configuration-data-path config))
(pidfile-dir (dirname (prosody-configuration-pidfile config)))
(config-str
(if (opaque-prosody-configuration? config)
(opaque-prosody-configuration-prosody.cfg.lua config)
(with-output-to-string
(lambda ()
(serialize-prosody-configuration config)))))
(config-file (plain-file "prosody.cfg.lua" config-str)))
#~(begin
(define %user (getpw "prosody"))
(mkdir-p #$config-dir)
(chown #$config-dir (passwd:uid %user) (passwd:gid %user))
(copy-file #$config-file (string-append #$config-dir
"/prosody.cfg.lua"))
(mkdir-p #$default-certs-dir)
(chown #$default-certs-dir (passwd:uid %user) (passwd:gid %user))
(chmod #$default-certs-dir #o750)
(mkdir-p #$data-path)
(chown #$data-path (passwd:uid %user) (passwd:gid %user))
(chmod #$data-path #o750)
(mkdir-p #$pidfile-dir)
(chown #$pidfile-dir (passwd:uid %user) (passwd:gid %user)))))
(define prosody-service-type
(service-type (name 'prosody)
(extensions
(list (service-extension shepherd-root-service-type
prosody-shepherd-service)
(service-extension account-service-type
(const %prosody-accounts))
(service-extension activation-service-type
prosody-activation)))))
;; A little helper to make it easier to document all those fields.
(define (generate-documentation)
(define documentation
`((prosody-configuration
,prosody-configuration-fields
(ssl ssl-configuration)
(virtualhosts virtualhost-configuration)
(int-components int-component-configuration)
(ext-components ext-component-configuration))
(ssl-configuration ,ssl-configuration-fields)
(int-component-configuration ,int-component-configuration-fields
(mod-muc mod-muc-configuration))
(ext-component-configuration ,ext-component-configuration-fields)
(mod-muc-configuration ,mod-muc-configuration-fields)
(virtualhost-configuration ,virtualhost-configuration-fields)
(opaque-prosody-configuration ,opaque-prosody-configuration-fields)))
(define (generate configuration-name)
(match (assq-ref documentation configuration-name)
((fields . sub-documentation)
(format #t "\nAvailable @code{~a} fields are:\n\n" configuration-name)
(when (memq configuration-name
'(virtualhost-configuration
int-component-configuration
ext-component-configuration))
(format #t "all these @code{prosody-configuration} fields: ~a, plus:\n"
(string-join (map (lambda (s)
(format #f "@code{~a}" s)) common-fields)
", ")))
(for-each
(lambda (f)
(let ((field-name (configuration-field-name f))
(field-type (configuration-field-type f))
(field-docs (string-trim-both
(configuration-field-documentation f)))
(default (catch #t
(configuration-field-default-value-thunk f)
(lambda _ 'nope))))
(define (escape-chars str chars escape)
(with-output-to-string
(lambda ()
(string-for-each (lambda (c)
(when (char-set-contains? chars c)
(display escape))
(display c))
str))))
(define (show-default? val)
(or (string? default) (number? default) (boolean? default)
(and (list? val) (and-map show-default? val))))
(format #t "@deftypevr {@code{~a} parameter} ~a ~a\n~a\n"
configuration-name field-type field-name field-docs)
(when (show-default? default)
(format #t "Defaults to @samp{~a}.\n"
(escape-chars (format #f "~s" default)
(char-set #\@ #\{ #\})
#\@)))
(for-each generate (or (assq-ref sub-documentation field-name) '()))
(format #t "@end deftypevr\n\n")))
(filter (lambda (f)
(not (string=? "" (configuration-field-documentation f))))
fields)))))
(generate 'prosody-configuration)
(format #t "It could be that you just want to get a @code{prosody.cfg.lua}
up and running. In that case, you can pass an
@code{opaque-prosody-configuration} record as the value of
@code{prosody-service-type}. As its name indicates, an opaque configuration
does not have easy reflective capabilities.")
(generate 'opaque-prosody-configuration)
(format #t "For example, if your @code{prosody.cfg.lua} is just the empty
string, you could instantiate a prosody service like this:
@example
(service prosody-service-type
(opaque-prosody-configuration
(prosody.cfg.lua \"\")))
@end example"))
;;; messaging.scm ends here
|