[PATCH] Add 'guix locate' command

> Example of an indexation (fast method by default):

>

> $ guix index

> Registering 133 packages ??????? ?

>

>

> Example of a search:

>

> $ guix index search sqlite3

> sqlite@3.37.0 /gnu/store/jd6nn2c8ln5flv4vwl7pp1w804w2i9wj-sqlite-3.37.0/bin/sqlite3

> sqlite@3.36.0 /gnu/store/xmzx5mzv4863yw9kmr2ykndgp37p8if0-sqlite-3.36.0/bin/sqlite3

> I squashed the ‘guix index’ patches you posted, followed up with

> individual changes on top of that (those will have to be squashed

> eventually), and pushed the result in the ‘wip-guix-index’ branch.

> Lemme know what you think!

> - [ ] 'guix index' renamed to 'guix locate'

> - [ ] 'search' action removed; option added to force reindexing

> - [ ] warning printed when database is too old

> - [ ] start anew when database is very old

> - [ ] documentation written

> - [ ] '--help' output made more concise

> On dim., 21 mai 2023 at 23:45, Ludovic Courtès <ludo@gnu.org> wrote:

>

>> - [ ] 'guix index' renamed to 'guix locate'

>

> Well, I have some patches that rename to “guix file”. :-)

>

> Well, ’guix locale’ appears to me also fine.

>> - [ ] 'search' action removed; option added to force reindexing

>

> I have an unpolished stuff that do:

>

> guix file --index=TYPE

> guix file foo bar

>

> Somehow, “guix file <terms>” the default action (= search). And then

> some action with --action (as index or else).

>

>> - [ ] warning printed when database is too old

>> - [ ] start anew when database is very old

>> - [ ] documentation written

>

> I have started… but I am not very far. :-)

>> - [ ] '--help' output made more concise

>

> Maybe also remove some “debug” code, no?

>> Well, I have some patches that rename to “guix file”. :-)

>>

>> Well, ’guix locale’ appears to me also fine.

> “locate” sounds better to me, notably because it’s a verb.

>>> - [ ] 'search' action removed; option added to force reindexing

>>

>> I have an unpolished stuff that do:

>>

>> guix file --index=TYPE

>> guix file foo bar

>>

>> Somehow, “guix file <terms>” the default action (= search). And then

>> some action with --action (as index or else).

>>

>>> - [ ] warning printed when database is too old

>>> - [ ] start anew when database is very old

>>> - [ ] documentation written

>>

>> I have started… but I am not very far. :-)

>

> Could you share what you have?

> (I didn’t expect feedback so I thought I’d end up hack on the stuff

> head-down. Now we need to synchronize. :-))

> I will. Do you prefer a patch? Or that I push to the branch?

> My concerns were:

>

> 1. about the name “guix index” and now it’s fixed by “guix locate” ;-)

>

> and 2. about the CLI; the default “guix locate <term>” should be the

> search action. The update action should be triggered with an option as

> “-i/--index=”.

> I’ve pushed additional changes. There are a few more things I’d like to

> do before we can merge it:

>

> - [ ] 'guix index' renamed to 'guix locate'

> - [ ] 'search' action removed; option added to force reindexing

> - [ ] warning printed when database is too old

> - [ ] start anew when database is very old

> - [ ] documentation written

> - [ ] '--help' output made more concise

> * guix/scripts/locate.scm, tests/guix-locate.sh: New files.

> * Makefile.am (MODULES): Add 'guix/scripts/locate.scm'.

> (SH_TESTS): Add 'tests/guix-locate.sh'.

> * po/guix/POTFILES.in: Add it.

>

> Co-authored-by: Antoine R. Dumont <antoine.romain.dumont@gmail.com>

> ---

> Makefile.am | 2 +

> doc/guix.texi | 118 ++++++++

> guix/scripts/locate.scm | 657 ++++++++++++++++++++++++++++++++++++++++

> po/guix/POTFILES.in | 1 +

> tests/guix-locate.sh | 72 +++++

> 5 files changed, 850 insertions(+)

> create mode 100644 guix/scripts/locate.scm

> create mode 100755 tests/guix-locate.sh

> +@example

> +$ guix locate -g '*.service'

> +man-db@@2.11.1 @dots{}/lib/systemd/system/man-db.service

> +wpa-supplicant@@2.10 @dots{}/system-services/fi.w1.wpa_supplicant1.service

> +@end example

> +

> +The @command{guix locate} command relies on a database that maps file

> +names to package names. By default, it automatically creates that

> +database if it does not exist yet by traversing packages available

> +@emph{locally}, which can take a few minutes (depending on the size of

> +your store and the speed of your storage device).

> +

> +@quotation Warning

> diff --git a/guix/scripts/locate.scm b/guix/scripts/locate.scm

> new file mode 100644

> index 0000000000..b5d8671d9c

> --- /dev/null

> +++ b/guix/scripts/locate.scm

> @@ -0,0 +1,657 @@

> +;;; GNU Guix --- Functional package management for GNU

> +;;; Copyright © 2022, 2023 Ludovic Courtès <ludo@gnu.org>

> +;;; Copyright © 2023 Antoine R. Dumont <antoine.romain.dumont@gmail.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 (guix scripts locate)

> + #:use-module ((guix config) #:select (%localstatedir))

> + #:use-module (guix i18n)

> + #:use-module ((guix ui)

> + #:select (show-version-and-exit

> + show-bug-report-information

> + with-error-handling

> + string->number*

> + display-hint

> + leave-on-EPIPE))

> + #:use-module (guix diagnostics)

> + #:use-module (guix scripts)

> + #:use-module (sqlite3)

> + #:use-module (ice-9 match)

> + #:use-module (ice-9 format)

> + #:use-module (guix store)

> + #:use-module (guix monads)

> + #:autoload (guix combinators) (fold2)

> + #:autoload (guix grafts) (%graft?)

> + #:autoload (guix store roots) (gc-roots)

> + #:use-module (guix derivations)

> + #:use-module (guix packages)

> + #:use-module (guix profiles)

> + #:autoload (guix progress) (progress-reporter/bar

> + call-with-progress-reporter)

> + #:use-module (guix sets)

> + #:use-module ((guix utils) #:select (cache-directory))

> + #:autoload (guix build utils) (find-files mkdir-p)

> + #:autoload (gnu packages) (fold-packages)

> + #:use-module (srfi srfi-1)

> + #:use-module (srfi srfi-9)

> + #:use-module (srfi srfi-37) ;; option

> + #:use-module (srfi srfi-71)

> + #:export (guix-locate))

> +

> +(define application-version 3)

> +

> +;; The following schema is the full schema at the `application-version`. It

> +;; should be modified according to the development required and

> +;; `application-version` should be bumped. If the schema needs modification

> +;; across time, those should be changed directly in the full-schema and the

> +;; incremental changes should be referenced as migration step below for the

> +;; new `application-version` (for the existing dbs to know what to migrate).

> +(define schema-full

> + "

> +create table if not exists SchemaVersion (

> + version integer primary key not null,

> + date date,

> * guix/scripts/locate.scm, tests/guix-locate.sh: New files.

> * Makefile.am (MODULES): Add 'guix/scripts/locate.scm'.

> (SH_TESTS): Add 'tests/guix-locate.sh'.

> * po/guix/POTFILES.in: Add it.

> diff --git a/doc/guix.texi b/doc/guix.texi

> …

> +@item --datebase=@var{file}

> +@table @code

> +@item manifests

> +This is the default method: it works by traversing profiles on the

> +machine and recording packages it encounters---packages you or other

> +users of the machine installed, directly or indirectly. It is fast but

> +it can miss other packages available in the store but not referred to by

> +any profile

> +Run @command{info \"Invoking guix locate\"} for more info.")))

> +Currently the command relies on purely local information. It is thus unable

> +to find packages that have not been directly or indirectly reached your store.

> + (title

> + (en "New @command{guix locate} command"))

> + (body

> + (en "The new @command{guix locate} command lets you search for

>

>

> Hello!

>

> Here is the “camera-ready” version of the new ‘guix locate’ command

> (formerly ‘guix index’) that Antoine and myself have worked on.

> I think it’s ready to go.

> Also, “guix locate” crashed for me on a machine where I was using the

> It would be helpful to provide a link to any documentation that's part of this work, as neither "guix locate" nor "guix index" have been discussed on guix-devel previously. I look forward to learning more about this feature!

> Ludovic Courtès <ludo@gnu.org> writes:

>> +create table if not exists SchemaVersion (

>> + version integer primary key not null,

>> + date date,

> ^ nit: sqlite does not have a native date type.

>

> We seem to be using it like a timestamp rather than a date.

>> +Currently the command relies on purely local information. It is thus unable

>> +to find packages that have not been directly or indirectly reached your store.

>

> The word “been” is wrong. It is not clear to me: What does directly or

> indirectly mean?

> Then, could you add this German translation?

> I went on to test some things. They are not very important, but still

> there are bugs:

>

> After deleting ~/.cache/guix/locate and cd’ing out of my home directory,

> then inside “guix shell -CW coreutils”, “guix locate ls” does not find

> ls.

> When I use “guix locate icecat”, it legitimately also locates a file

> lib/icecat/icecat in addition to the desired bin/icecat. I try to

> filter by “guix locate bin/icecat” or “guix locate -g bin/icecat”, but

> it seems locate does not support file names with slashes.

> +Run @command{info \"(guix) Invoking guix locate\"} for more info.")

> …

> +Führen Sie @command{info \"Invoking guix locate\"} aus, um mehr zu

> +erfahren.")

>> After deleting ~/.cache/guix/locate and cd’ing out of my home directory,

>> then inside “guix shell -CW coreutils”, “guix locate ls” does not find

>> ls.

>

> Works for me:

>

> $ guix shell -CW -D guix

> […]

> Note that ‘-W’ has the effect of sharing ~/.cache with the container.

> That means that the database is already there.

>> When I use “guix locate icecat”, it legitimately also locates a file

>> lib/icecat/icecat in addition to the desired bin/icecat. I try to

>> filter by “guix locate bin/icecat” or “guix locate -g bin/icecat”, but

>> it seems locate does not support file names with slashes.

> Right: ‘guix locate’ only checks the “basename”; it does not let you

> search on the absolute file name. We could add an option to do that

> later (say ‘-f’) but I thought it’s less frequently useful.

> Ludovic Courtès <ludo@gnu.org> writes:

>>> After deleting ~/.cache/guix/locate and cd’ing out of my home directory,

>>> then inside “guix shell -CW coreutils”, “guix locate ls” does not find

>>> ls.

>>

>> Works for me:

>>

>> $ guix shell -CW -D guix

>> […]

>> Note that ‘-W’ has the effect of sharing ~/.cache with the container.

>> That means that the database is already there.

>

> Ah of course that is why it works for you. I had deleted the locate

> directory of the cache, so after `guix shell -CW -D guix` the `guix

> locate ls` did not work, and did not work either once I had left the

> container, because an empty database had been created in the cache from

> within the container. Without -CW it works fine. It is a minor bug.

>>> When I use “guix locate icecat”, it legitimately also locates a file

>>> lib/icecat/icecat in addition to the desired bin/icecat. I try to

>>> filter by “guix locate bin/icecat” or “guix locate -g bin/icecat”, but

>>> it seems locate does not support file names with slashes.

>> Right: ‘guix locate’ only checks the “basename”; it does not let you

>> search on the absolute file name. We could add an option to do that

>> later (say ‘-f’) but I thought it’s less frequently useful.

>

> I’m nitpicking, but if relative file names are not meant to be

> supported, could you change the doc/guix.texi at

>

> +@example

> +guix locate [@var{options}@dots{}] @var{file}@dots{}

> +@end example

> +

> +@noindent

> +... where @var{file} is the name of a file to search for.

>

> to reflect that FILE must be the basename? Because in other parts of

> the doc, the term path is avoided and the term filename is used. Now a

> filename is only a basename all of a sudden.