aboutsummaryrefslogtreecommitdiff
GNU Guix consists of Scheme code that implements the deployment model
of the Nix package management tool.  In fact, it currently talks to a
build daemon whose code comes from Nix (see the manual for details.)

Nix was initially written by Eelco Dolstra; other people have been
contributing to it.  See `nix/AUTHORS' for details.

The list of GNU Guix contributors is now generated from the output of
'git log' and written to this file, as can be seen in release tarballs.
AR 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 dict) #:use-module (guix deprecation) #:use-module (guix gexp) #:use-module (guix records) #:use-module (guix modules) #:use-module (guix least-authority) #:use-module (gnu services) #:use-module (gnu services shepherd) #:use-module (gnu system shadow) #:use-module ((gnu packages admin) #:select (shadow)) #:use-module (gnu packages dico) #:use-module (gnu packages dictionaries) #:autoload (gnu build linux-container) (%namespaces) #:autoload (gnu system file-systems) (file-system-mapping) #:use-module (srfi srfi-1) #:use-module (srfi srfi-26) #:use-module (ice-9 match) #:export (dicod-service ; deprecated dicod-service-type dicod-configuration dicod-handler dicod-database %dicod-database:gcide dicod-freedict-database %dicod-databases:freedict)) ;;; ;;; GNU Dico. ;;; (define-record-type* <dicod-configuration> dicod-configuration make-dicod-configuration dicod-configuration? (dico dicod-configuration-dico (default dico)) (interfaces dicod-configuration-interfaces ;list of strings (default '("localhost"))) (handlers dicod-configuration-handlers ;list of <dicod-handler> (default '())) (databases dicod-configuration-databases ;list of <dicod-database> (default (list %dicod-database:gcide))) (home-service? dicod-configuration-home-service? ;boolean (default for-home?) (innate))) (define-record-type* <dicod-handler> dicod-handler make-dicod-handler dicod-handler? (name dicod-handler-name) (module dicod-handler-module (default #f)) (options dicod-handler-options (default '()))) (define-record-type* <dicod-database> dicod-database make-dicod-database dicod-database? (name dicod-database-name) (handler dicod-database-handler) (complex? dicod-database-complex? (default #f)) (options dicod-database-options (default '()))) (define %dicod-gcide-index ;; The GCIDE pre-built index. The Dico 'gcide' module can build it lazily; ;; do it upfront so there's no need for a writable directory at run-time. (computed-file "dicod-gcide-index" (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils)) (mkdir #$output) (invoke #+(file-append dico "/libexec/idxgcide") #+(file-append gcide "/share/gcide") #$output))))) (define %dicod-database:gcide (dicod-database (name "gcide") (handler "gcide") (options (list #~(string-append "dbdir=" #$gcide "/share/gcide") #~(string-append "idxdir=" #$%dicod-gcide-index))))) (define (dicod-freedict-database dictionary-name) "Returns a record of type @code{dicod-database} for purpose of configuring a database for the FreeDict multilingual dictionary named by the string @var{dictionary-name} into a service of type @code{dicod-service-type}." (dicod-database (name (string-append "freedict-" dictionary-name)) (handler "dictorg") (options (list #~(string-append "database=" #$freedict-dictionaries "/share/dictd/" #$dictionary-name))))) (define %dicod-databases:freedict (map dicod-freedict-database (list "afr-deu" "afr-eng" "ara-eng" "bre-fra" "ces-eng" "ckb-kmr" "cym-eng" "dan-eng" "deu-ita" "deu-kur" "deu-nld" "deu-por" "deu-tur" "eng-afr" "eng-ara" "eng-ces" "eng-cym" "eng-dan" "eng-ell" "eng-fra" "eng-gle" "eng-hin" "eng-hrv" "eng-hun" "eng-ita" "eng-lat" "eng-lit" "eng-nld" "eng-pol" "eng-por" "eng-rom" "eng-rus" "eng-spa" "eng-srp" "eng-swh" "eng-tur" "fra-bre" "fra-eng" "fra-nld" "gla-deu" "gle-eng" "gle-pol" "hrv-eng" "hun-eng" "isl-eng" "ita-deu" "ita-eng" "jpn-deu" "jpn-eng" "jpn-fra" "jpn-rus" "kha-deu" "kha-eng" "kur-deu" "kur-eng" "kur-tur" "lat-deu" "lat-eng" "lit-eng" "mkd-bul" "nld-deu" "nld-eng" "nld-fra" "nno-nob" "oci-cat" "pol-gle" "por-deu" "por-eng" "san-deu" "slk-eng" "slv-eng" "spa-ast" "spa-eng" "spa-por" "srp-eng" "swe-eng" "swh-eng" "swh-pol" "tur-deu" "tur-eng" "wol-fra"))) (define %dicod-accounts (list (user-group (name "dicod") (system? #t)) (user-account (name "dicod") (group "dicod") (system? #t) (home-directory "/var/empty") (shell (file-append shadow "/sbin/nologin"))))) (define (dicod-configuration-file config) (define handler->text (match-lambda (($ <dicod-handler> name #f '()) `(" load-module " ,name ";")) (($ <dicod-handler> name #f options) (handler->text (dicod-handler (name name) (module name) (options options)))) (($ <dicod-handler> name module options) `(" load-module " ,name " { command \"" ,module (string-join (list ,@options) " " 'prefix) "\"; }\n")))) (define database->text (match-lambda (($ <dicod-database> name handler #f options) (append (handler->text (dicod-handler (name handler))) (database->text (dicod-database (name name) (handler handler) (complex? #t) (options options))))) (($ <dicod-database> name handler complex? options) `(" database { name \"" ,name "\"; handler \"" ,handler (string-join (list ,@options) " " 'prefix) "\"; }\n")))) (define configuration->text (match-lambda (($ <dicod-configuration> dico (interfaces ...) handlers databases) (append `("listen (" ,(string-join interfaces ", ") ");\n") (append-map handler->text handlers) (append-map database->text databases))))) (apply mixed-text-file "dicod.conf" (configuration->text config))) (define (dicod-shepherd-service config) (let* ((dicod.conf (dicod-configuration-file config)) (interfaces (dicod-configuration-interfaces config)) (home-service? (dicod-configuration-home-service? config)) (mappings `(,@(if home-service? '() (list (file-system-mapping (source "/dev/log") (target source)))) ,(file-system-mapping (source dicod.conf) (target source)))) (dicod (least-authority-wrapper (file-append (dicod-configuration-dico config) "/bin/dicod") #:name "dicod" #:mappings mappings #:namespaces (delq 'net %namespaces)))) (list (shepherd-service (provision '(dicod)) (requirement (if home-service? '() '(user-processes))) (documentation "Run the dicod daemon.") (start #~(make-inetd-constructor (list #$dicod "--inetd" "--foreground" (string-append "--config=" #$dicod.conf)) (map (lambda (interface) (endpoint (addrinfo:addr (car (getaddrinfo interface "dict"))))) '#$interfaces) #:requirements '#$requirement #:user #$(and (not home-service?) "dicod") #:group #$(and (not home-service?) "dicod") #:service-name-stem "dicod")) (stop #~(make-inetd-destructor)) (actions (list (shepherd-configuration-action dicod.conf))))))) (define dicod-service-type (service-type (name 'dict) (extensions (list (service-extension account-service-type (const %dicod-accounts)) (service-extension shepherd-root-service-type dicod-shepherd-service))) (default-value (dicod-configuration)) (description "Run @command{dicod}, the dictionary server of @uref{https://www.gnu.org/software/dico, GNU Dico}. @command{dicod} implements the standard DICT protocol supported by clients such as @command{dico} and GNOME Dictionary."))) (define-deprecated (dicod-service #:key (config (dicod-configuration))) dicod-service-type "Return a service that runs the @command{dicod} daemon, an implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual}). The optional @var{config} argument specifies the configuration for @command{dicod}, which should be a @code{<dicod-configuration>} object, by default it serves the GNU Collaborative International Dictionary of English. You can add @command{open localhost} to your @file{~/.dico} file to make @code{localhost} the default server for @command{dico} client (@pxref{Initialization File,,, dico, GNU Dico Manual})." (service dicod-service-type config))