services: science.scm: Add missing copyright headers.
[jackhill/guix/guix.git] / gnu / services / avahi.scm
index 807cc05..5465670 100644 (file)
@@ -1,5 +1,5 @@
 ;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2014, 2015, 2016 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
   #:use-module (gnu system shadow)
   #:use-module (gnu packages avahi)
   #:use-module (gnu packages admin)
+  #:use-module (guix deprecation)
   #:use-module (guix records)
   #:use-module (guix gexp)
   #:export (avahi-configuration
+            avahi-configuration?
+
+            avahi-configuration-avahi
+            avahi-configuration-debug?
+            avahi-configuration-host-name
+            avahi-configuration-publish?
+            avahi-configuration-publish-workstation?
+            avahi-configuration-ipv4?
+            avahi-configuration-ipv6?
+            avahi-configuration-wide-area?
+            avahi-configuration-domains-to-browse
+
             avahi-service
             avahi-service-type))
 
@@ -37,7 +50,6 @@
 ;;;
 ;;; Code:
 
-  ;; TODO: Export.
 (define-record-type* <avahi-configuration>
   avahi-configuration make-avahi-configuration
   avahi-configuration?
                      (default avahi))
   (debug?            avahi-configuration-debug?   ;Boolean
                      (default #f))
-  (host-name         avahi-configuration-host-name) ;string
-  (publish?          avahi-configuration-publish?)  ;Boolean
-  (ipv4?             avahi-configuration-ipv4?)     ;Boolean
-  (ipv6?             avahi-configuration-ipv6?)     ;Boolean
-  (wide-area?        avahi-configuration-wide-area?) ;Boolean
-  (domains-to-browse avahi-configuration-domains-to-browse)) ;list of strings
+  (host-name         avahi-configuration-host-name ;string | #f
+                     (default #f))
+  (publish?          avahi-configuration-publish? ;boolean
+                     (default #t))
+
+  ;; The default for this was #t in Avahi 0.6.31 and became #f in 0.7.  For
+  ;; now we stick to the old default.
+  (publish-workstation? avahi-configuration-publish-workstation? ;Boolean
+                        (default #t))
+
+  (ipv4?             avahi-configuration-ipv4?    ;Boolean
+                     (default #t))
+  (ipv6?             avahi-configuration-ipv6?    ;Boolean
+                     (default #t))
+  (wide-area?        avahi-configuration-wide-area? ;Boolean
+                     (default #f))
+  (domains-to-browse avahi-configuration-domains-to-browse ;list of strings
+                     (default '())))
 
 (define* (configuration-file config)
   "Return an avahi-daemon configuration file based on CONFIG, an
                "enable-wide-area=" (bool (avahi-configuration-wide-area? config))
                "[publish]\n"
                "disable-publishing="
-               (bool (not (avahi-configuration-publish? config))))))
+               (bool (not (avahi-configuration-publish? config)))
+               "publish-workstation="
+               (bool (avahi-configuration-publish-workstation? config)))))
 
 (define %avahi-accounts
   ;; Account and group for the Avahi daemon.
          (system? #t)
          (comment "Avahi daemon user")
          (home-directory "/var/empty")
-         (shell #~(string-append #$shadow "/sbin/nologin")))))
+         (shell (file-append shadow "/sbin/nologin")))))
 
 (define %avahi-activation
   ;; Activation gexp.
   #~(begin
       (use-modules (guix build utils))
-      (mkdir-p "/var/run/avahi-daemon")))
+      (mkdir-p "/run/avahi-daemon")))
 
 (define (avahi-shepherd-service config)
   "Return a list of <shepherd-service> for CONFIG."
            (requirement '(dbus-system networking))
 
            (start #~(make-forkexec-constructor
-                     (list (string-append #$avahi "/sbin/avahi-daemon")
+                     (list #$(file-append avahi "/sbin/avahi-daemon")
                            "--daemonize"
                            #$@(if debug? #~("--debug") #~())
                            "-f" #$config)
-                     #:pid-file "/var/run/avahi-daemon/pid"))
+                     #:pid-file "/run/avahi-daemon/pid"))
            (stop #~(make-kill-destructor))))))
 
 (define avahi-service-type
   (let ((avahi-package (compose list avahi-configuration-avahi)))
     (service-type (name 'avahi)
+                  (description
+                   "Run @command{avahi-daemon}, a host and service discovery
+daemon that implements the multicast DNS (mDNS) and DNS service
+discovery (DNS-SD) protocols.  Additionally, extend the C library's name
+service switch (NSS) with support for @code{.local} host name resolution.")
                   (extensions
                    (list (service-extension shepherd-root-service-type
                                             avahi-shepherd-service)
                          ;; Provide 'avahi-browse', 'avahi-resolve', etc. in
                          ;; the system profile.
                          (service-extension profile-service-type
-                                            avahi-package))))))
-
-(define* (avahi-service #:key (avahi avahi) debug?
-                        host-name
-                        (publish? #t)
-                        (ipv4? #t) (ipv6? #t)
-                        wide-area?
-                        (domains-to-browse '()))
+                                            avahi-package)))
+                  (default-value (avahi-configuration)))))
+
+(define-deprecated (avahi-service #:key (avahi avahi) debug?
+                                  host-name
+                                  (publish? #t)
+                                  (ipv4? #t) (ipv6? #t)
+                                  wide-area?
+                                  (domains-to-browse '()))
+  avahi-service-type
   "Return a service that runs @command{avahi-daemon}, a system-wide
 mDNS/DNS-SD responder that allows for service discovery and
-\"zero-configuration\" host name lookups (see @uref{http://avahi.org/}), and
+\"zero-configuration\" host name lookups (see @uref{https://avahi.org/}), and
 extends the name service cache daemon (nscd) so that it can resolve
 @code{.local} host names using
 @uref{http://0pointer.de/lennart/projects/nss-mdns/, nss-mdns}.  Additionally,