[bug#75063] [PATCH 0/2] Easy configuration of FreeDict into dicod-service-type

[bug#75063] [PATCH 0/2] Easy configuration of FreeDict into dicod-service-type

[Runciter via Guix-patches via]

A few weeks my patch for FreeDict multilingual dictionaries for Guix was
integrated to the master branch (bug #74411).

These patches are simple updates to the (gnu services dict) module and to the
Guix info manual to help users configure FreeDict dictionaries into their
local dicod server.

Regards,
Runciter

Runciter (2):
  gnu: dict: Add symbols to help users configure FreeDict with dicod.
  doc: add FreeDict dictionaries to dicod configuration example.

 doc/guix.texi         |   8 ++--
 gnu/services/dict.scm | 107 +++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 111 insertions(+), 4 deletions(-)


base-commit: 9dc91360fd2e41fb783ab4af341ac60aee2f5d31
-- 
2.46.0

[bug#75063] [PATCH 1/2] gnu: dict: Add symbols to help users configure FreeDict with dicod.

[Runciter via Guix-patches via]

* gnu/services/dict.scm: (%dictorg-handler): New variable;
(freedict-dictorg-database): new procedure;
(%freedict-dictorg-databases): new variable.

Signed-off-by: Runciter <runciter@whispers-vpn.org>
---
 gnu/services/dict.scm | 107 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 106 insertions(+), 1 deletion(-)

diff --git a/gnu/services/dict.scm b/gnu/services/dict.scm
index a4e25f5302..39fb38c9c3 100644
--- a/gnu/services/dict.scm
+++ b/gnu/services/dict.scm
@@ -2,6 +2,7 @@
 ;;; Copyright © 2016 Sou Bunnbu <iyzsong@gmail.com>
 ;;; Copyright © 2016, 2017, 2018, 2020, 2022, 2023 Ludovic Courtès <ludo@gnu.org>
 ;;; Copyright © 2017 Huang Ying <huang.ying.caritas@gmail.com>
+;;; Copyright © 2024 Runciter <runciter@whispers-vpn.org>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -40,7 +41,10 @@ (define-module (gnu services dict)
             dicod-configuration
             dicod-handler
             dicod-database
-            %dicod-database:gcide))
+            %dicod-database:gcide
+            %dictorg-handler
+            freedict-dictorg-database
+            %freedict-dictorg-databases))
 
 \f
 ;;;
@@ -94,6 +98,107 @@ (define %dicod-database:gcide
    (options (list #~(string-append "dbdir=" #$gcide "/share/gcide")
                   #~(string-append "idxdir=" #$%dicod-gcide-index)))))
 
+(define %dictorg-handler
+  (dicod-handler (name "dictorg")
+                 (module "dictorg")
+                 (options (list #~(string-append "dbdir=/")))))
+
+(define (freedict-dictorg-database dict-name)
+  "Return a record of type @code{<dicod-database>} that configures a
+database for the freedict multilingual dictionary named by the string
+DICT-NAME."
+  (dicod-database (name (string-append "freedict-"
+                                       dict-name))
+                  (complex? #t)
+                  (handler "dictorg")
+                  (options (list #~(string-append "database="
+                                                  #$freedict-dictionaries
+                                                  "/share/dictd/"
+                                                  #$dict-name)))))
+
+(define %freedict-dictorg-databases
+  (map freedict-dictorg-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")
-- 
2.46.0

[bug#75063] [PATCH 1/2] gnu: dict: Add symbols to help users configure FreeDict with dicod.

[Ludovic Courtès]

Hi,

Nice!  I recently added FreeDict dictionaries to my own config and was
contemplating the idea of having it properly integrated.  Perfect.  :-)

FWIW, I have:

--8<---------------cut here---------------start------------->8---
(define %freedict-databases
  (map (lambda (dictionary-name)
         (dicod-database
          (name "freedict")
          (handler "dictorg")
          (options
           (list #~(string-append "database="
                                  #$freedict-dictionaries
                                  "/share/dictd/" #$dictionary-name)))))
       '("fra-eng" "eng-fra" "eng-spa" "spa-eng")))
--8<---------------cut here---------------end--------------->8---

and then:

--8<---------------cut here---------------start------------->8---
     (service dicod-service-type
              (dicod-configuration
               (databases (cons %dicod-database:gcide
                                %freedict-databases))))
--8<---------------cut here---------------end--------------->8---

Runciter <runciter@whispers-vpn.org> skribis:

> * gnu/services/dict.scm: (%dictorg-handler): New variable;
> (freedict-dictorg-database): new procedure;
> (%freedict-dictorg-databases): new variable.
>
> Signed-off-by: Runciter <runciter@whispers-vpn.org>

[...]

> +(define %dictorg-handler
> +  (dicod-handler (name "dictorg")
> +                 (module "dictorg")
> +                 (options (list #~(string-append "dbdir=/")))))

I believe we don’t even need that; it’s built-in.

> +(define (freedict-dictorg-database dict-name)
> +  "Return a record of type @code{<dicod-database>} that configures a
> +database for the freedict multilingual dictionary named by the string
> +DICT-NAME."
> +  (dicod-database (name (string-append "freedict-"
> +                                       dict-name))
> +                  (complex? #t)

What does ‘complex?’ do actually?  (Seems to work without it.)

> * doc/guix.texi: (Dictionary Service): Update configuration example.

Could you squash both commits?  In general documentation goes to the
same commit as the change it documents.

> diff --git a/doc/guix.texi b/doc/guix.texi
> index 08ffbc36d7..1a394b91b2 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -41158,13 +41158,15 @@ Miscellaneous Services
>                        (name "wordnet")
>                        (module "wordnet")
>                        (options
> -                       (list #~(string-append "wnhome=" #$wordnet))))))
> -          (databases (list
> +                       (list #~(string-append "wnhome=" #$wordnet))))
> +                       %dictorg-handler))
> +          (databases (cons*
>                        (dicod-database
>                         (name "wordnet")
>                         (complex? #t)
>                         (handler "wordnet"))
> -                      %dicod-database:gcide))))
> +                      %dicod-database:gcide
> +                      %freedict-dictorg-databases))))

Could you also document ‘freedict-dictorg-databases’ and
‘%freedict-dictorg-databases’, similar to how ‘%dicod-database:gcide’ is
documented?

For consistency, perhaps the these should be renamed to
‘dicod-freedict-databases’ and ‘%dicod-database:freedict’.

Thanks in advance,
Ludo’.

[bug#75063] [PATCH 2/2] doc: add FreeDict dictionaries to dicod configuration example.

[Runciter via Guix-patches via]

* doc/guix.texi: (Dictionary Service): Update configuration example.

Signed-off-by: Runciter <runciter@whispers-vpn.org>
---
 doc/guix.texi | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 08ffbc36d7..1a394b91b2 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -41158,13 +41158,15 @@ Miscellaneous Services
                       (name "wordnet")
                       (module "wordnet")
                       (options
-                       (list #~(string-append "wnhome=" #$wordnet))))))
-          (databases (list
+                       (list #~(string-append "wnhome=" #$wordnet))))
+                       %dictorg-handler))
+          (databases (cons*
                       (dicod-database
                        (name "wordnet")
                        (complex? #t)
                        (handler "wordnet"))
-                      %dicod-database:gcide))))
+                      %dicod-database:gcide
+                      %freedict-dictorg-databases))))
 @end lisp
 
 @cindex Docker
-- 
2.46.0

[bug#75063] [PATCH 1/2] gnu: dict: Add symbols to help users configure FreeDict with dicod.

[Runciter via Guix-patches via]

Hello,

I'll squash both commits, simplify the configuration if appropriate,
update symbol names and improve the documentation in the beginning of
next week.

Meanwhile I have not tested much yet but by reviewing code I found
something which is possibly interesting.


>> +(define %dictorg-handler
>> +  (dicod-handler (name "dictorg")
>> +                 (module "dictorg")
>> +                 (options (list #~(string-append "dbdir=/")))))
>
> I believe we don’t even need that; it’s built-in.

You found something simpler but I'll need to dive into the dicod.conf
file in the store. See below.

And sorry for the call to string-append with just one argument, I also
seem to have included a useless G-exp... Probably a leftover from a
previous version of mine.

>> +(define (freedict-dictorg-database dict-name)
>> +  "Return a record of type @code{<dicod-database>} that configures a
>> +database for the freedict multilingual dictionary named by the string
>> +DICT-NAME."
>> +  (dicod-database (name (string-append "freedict-"
>> +                                       dict-name))
>> +                  (complex? #t)
>
> What does ‘complex?’ do actually?  (Seems to work without it.)

Reviewing the code in the (gnu services dict) module, the relevant
symbol is `database->text` defined inside the `dicod-configuration-file`
procedure.

`database->text` recurses into itself one time maximally, so that dicod
gets one auto-generated handler with default handler options from the
service module for each configured database which has `complex?`
evaluating to #f, independently (TBC) from what the system
configuration's explicit handlers and other non-complex databases are
configuring.

dicod has modules, handlers referencing a module, and databases
referencing a handler. The latter two are user-configurable. dicod has
hard-coded modules and I suppose it has no hard-coded handlers. In any
case, as far as the Guix service module design goes, dicod is always
supposed to get all of its handlers from Guix, either flexible handlers
from the system configuration, or default handlers from the service
module.

This being the inferred design intent, 3 things are possibly not ideal
in the way Guix handles dicod, by increasing order of importance:

1. In the Guix manual, the documentation of the `complex?` field may be
   slightly misleading. Strictly speaking it's the handler configuration
   which is complex when `complex?` is true, not the database
   configuration. Within dicod, those 2 levels of configuration are at
   least partially substitutable to each other, but they're not
   occupying the same position along an inheritance chain.

2. Here's one thing that I must experiment with before finishing this
   patch: some interactions between the service module and the system
   configuration might result in a "dirty" dicod configuration file
   defining the same handler multiple times. There are 2 cases which can
   result in this situation, and I don't think this is caught by the
   service module (TBC):
       a. same handler name defined explicitly by the system configuration,
          and by the service module when the system configuration also
          defines a non-complex database naming the same handler;
       b. System configuration containing multiple non-complex databases
          naming the same handler. If I have to bet right now, this is
          what happens with the simple system configuration you found.
          There's reason to think the dicod configuration file is "dirty"
          but non-failing, and in any case non-risky at run-time in this
          case, because the multiply-defined handler(s) should be all
          configured exactly to an identical default.

3. Are we possibly configuring dicod to load some of its modules
   multiple times, or possibly misleading users into doing it? This
   could be also non-failing but a most undesirable thing to do.

Regards,
Runciter