all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
blob ab7661dbacb6eb9405c4fae84044ea01bf48c676 12059 bytes (raw)
name: guix/extensions/index.scm 	 # note: path name is non-authoritative(*)

  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
 
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2022 Ludovic Courtès <ludo@gnu.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 (guix extensions index)
  #:use-module (guix config)  ;; %guix-package-name, ...
  #:use-module (guix ui)      ;; display G_
  #:use-module (guix scripts)
  #:use-module (sqlite3)
  #:use-module (ice-9 match)
  #:use-module (guix describe)
  #:use-module (guix store)
  #:use-module (guix monads)
  #:autoload   (guix grafts) (%graft?)
  #:use-module (guix derivations)
  #:use-module (guix packages)
  #:autoload   (guix build utils) (find-files)
  #:autoload   (gnu packages) (fold-packages)
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-9)
  #:export     (guix-index))

(define debug #f)

(define schema
  "
create table if not exists Packages (
  id        integer primary key autoincrement not null,
  name      text not null,
  version   text not null,
  unique    (name, version) -- add uniqueness constraint
);

create table if not exists Directories (
  id        integer primary key autoincrement not null,
  name      text not null,
  package   integer not null,
  foreign key (package) references Packages(id) on delete cascade,
  unique (name, package) -- add uniqueness constraint
);

create table if not exists Files (
  name      text not null,
  basename  text not null,
  directory integer not null,
  foreign key (directory) references Directories(id) on delete cascade
  unique (name, basename, directory) -- add uniqueness constraint
);

create index if not exists IndexFiles on Files(basename);")

(define (call-with-database file proc)
  (let ((db (sqlite-open file)))
    (dynamic-wind
      (lambda () #t)
      (lambda ()
        (sqlite-exec db schema)
        (proc db))
      (lambda ()
        (sqlite-close db)))))

(define (insert-files db package version directories)
  "Insert files from DIRECTORIES as belonging to PACKAGE at VERSION."
  (define stmt-select-package
    (sqlite-prepare db "\
SELECT id FROM Packages WHERE name = :name AND version = :version;"
                    #:cache? #t))

  (define stmt-insert-package
    (sqlite-prepare db "\
INSERT OR IGNORE INTO Packages(name, version) -- to avoid spurious writes
VALUES (:name, :version);"
                    #:cache? #t))

  (define stmt-select-directory
    (sqlite-prepare db "\
SELECT id FROM Directories WHERE name = :name AND package = :package;"
                    #:cache? #t))

  (define stmt-insert-directory
    (sqlite-prepare db "\
INSERT OR IGNORE INTO Directories(name, package) -- to avoid spurious writes
VALUES (:name, :package);"
                    #:cache? #t))

  (define stmt-insert-file
    (sqlite-prepare db "\
INSERT OR IGNORE INTO Files(name, basename, directory)
VALUES (:name, :basename, :directory);"
                    #:cache? #t))

  (sqlite-exec db "begin immediate;")
  (sqlite-bind-arguments stmt-insert-package
                         #:name package
                         #:version version)
  (sqlite-fold (const #t) #t stmt-insert-package)

  (sqlite-bind-arguments stmt-select-package
                         #:name package
                         #:version version)
  (match (sqlite-fold cons '() stmt-select-package)
    ((#(package-id))
     (when debug
       (format #t "(pkg, version, pkg-id): (~a, ~a, ~a)"
               package version package-id))
     (pk 'package package-id package)
     (for-each (lambda (directory)
                 (define (strip file)
                   (string-drop file (+ (string-length directory) 1)))

                 (sqlite-reset stmt-insert-directory)
                 (sqlite-bind-arguments stmt-insert-directory
                                        #:name directory
                                        #:package package-id)
                 (sqlite-fold (const #t) #t stmt-insert-directory)

                 (sqlite-reset stmt-select-directory)
                 (sqlite-bind-arguments stmt-select-directory
                                        #:name directory
                                        #:package package-id)
                 (match (sqlite-fold cons '() stmt-select-directory)
                   ((#(directory-id))
                    (when debug
                      (format #t "(name, package, dir-id): (~a, ~a, ~a)\n"
                              directory package-id directory-id))
                    (for-each (lambda (file)
                                ;; If DIRECTORY is a symlink, (find-files
                                ;; DIRECTORY) returns the DIRECTORY singleton.
                                (unless (string=? file directory)
                                  (sqlite-reset stmt-insert-file)
                                  (sqlite-bind-arguments stmt-insert-file
                                                         #:name (strip file)
                                                         #:basename
                                                         (basename file)
                                                         #:directory
                                                         directory-id)
                                  (sqlite-fold (const #t) #t stmt-insert-file)))
                              (find-files directory)))))
               directories)))
  (sqlite-exec db "commit;"))

(define (insert-package db package)
  "Insert all the files of PACKAGE into DB."
  (mlet %store-monad ((drv (package->derivation package #:graft? #f)))
    (match (derivation->output-paths drv)
      (((labels . directories) ...)
       (when (every file-exists? directories)
         (insert-files db (package-name package) (package-version package)
                       directories))
       (return #t)))))

(define (filter-public-current-supported package)
  "Filter supported, not hidden (public) and not superseded (current) package."
  (and (not (hidden-package? package))
       (not (package-superseded package))
       (supported-package? package)))

(define (filter-supported-package package)
  "Filter supported package (package might be hidden or superseded)."
  (and (supported-package? package)))

(define (no-filter package) "No filtering on package" #t)

(define* (insert-packages db #:optional (filter-policy filter-public-current-supported))
  "Insert all current packages matching `filter-package-policy` into DB."
  (with-store store
    (parameterize ((%graft? #f))
      (fold-packages (lambda (package _)
                       (run-with-store store
                         (insert-package db package)))
                     #t
                     #:select? filter-policy))))

(define-record-type <package-match>
  (package-match name version file)
  package-match?
  (name      package-match-name)
  (version   package-match-version)
  (file      package-match-file))

(define (matching-packages db file)
  "Return unique <package-match> corresponding to packages containing FILE."
  (define lookup-stmt
    (sqlite-prepare db "\
SELECT Packages.name, Packages.version, Directories.name, Files.name
FROM Packages
INNER JOIN Files, Directories
ON files.basename = :file
  AND directories.id = files.directory
  AND packages.id = directories.package;"))

  (sqlite-bind-arguments lookup-stmt #:file file)
  (sqlite-fold (lambda (result lst)
                 (match result
                   (#(package version directory file)
                    (cons (package-match package version
                                         (string-append directory "/" file))
                          lst))))
               '() lookup-stmt))

\f

(define (index-packages-with-db db-pathname)
  "Index packages using db at location DB-PATHNAME."
  (call-with-database db-pathname
    (lambda (db)
      (insert-packages db no-filter))))

(define (matching-packages-with-db db-pathname file)
  "Compute list of packages referencing FILE using db at DB-PATHNAME."
  (call-with-database db-pathname
    (lambda (db)
      (matching-packages db file))))

(define (print-matching-results matches)
  "Print the MATCHES matching results."
  (for-each (lambda (result)
              (format #t "~20a ~a~%"
                      (string-append (package-match-name result)
                                     "@" (package-match-version result))
                      (package-match-file result)))
            matches))

(define default-db-path
  (let ((local-config-path
         (and=> (getenv "HOME")
                (lambda (home)
                  (string-append home "/.config/guix/")))))
    (string-append local-config-path "locate-db.sqlite")))

(define (show-bug-report-information)
  ;; TRANSLATORS: The placeholder indicates the bug-reporting address for this
  ;; package.  Please add another line saying "Report translation bugs to
  ;; ...\n" with the address for translation bugs (typically your translation
  ;; team's web or email address).
  (format #t (G_ "
Report bugs to: ~a.") %guix-bug-report-address)
  (format #t (G_ "
~a home page: <~a>") %guix-package-name %guix-home-page-url)
  (format #t (G_ "
General help using Guix and GNU software: <~a>")
          ;; TRANSLATORS: Change the "/en" bit of this URL appropriately if
          ;; the web site is translated in your language.
          (G_ "https://guix.gnu.org/en/help/"))
  (newline))

(define (show-help)
  (display (G_ "Usage: guix index [OPTIONS...] [search FILE...]
Without FILE, index (package, file) relationships in the local store.
With 'search FILE', search for packages installing FILEx;x.\n
Note: The internal cache is located at ~/.config/guix/locate-db.sqlite.
See --db-path for customization.\n"))
  (newline)
  (display (G_ "The valid values for OPTIONS are:"))
  (newline)
  (display (G_ "
  -h, --help      Display this help and exit"))
  (display (G_ "
  -V, --version   Display version information and exit"))
  (display (G_ "
  --db-path=DIR   Change default location of the cache db"))
  (newline)
  (newline)
  (display (G_ "The valid values for ARGS are:"))
  (newline)
  (display (G_ "
  search FILE     Search for packages installing the FILE (from cache db)"))
  (newline)
  (show-bug-report-information))

(define-command (guix-index . args)
  (category extension)
  (synopsis "Index packages to allow searching package for a given filename")

  (define (parse-db-args args)
    "Parsing of string key=value where we are only interested in  'value'"
    (match (string-split args #\=)
      ((unused db-path)
       db-path)
      (_ #f)))

  (define (display-help-and-exit)
    (show-help)
    (exit 0))

  (match args
    ((or ("-h") ("--help"))
     (display-help-and-exit))
    ((or ("-V") ("--version"))
     (show-version-and-exit "guix locate"))
    ((db-path-args)
     (let ((db-path (parse-db-args db-path-args)))
       (if db-path
           (index-packages-with-db db-path)
           (display-help-and-exit))))
    (("search" file)
     (let ((matches (matching-packages-with-db default-db-path file)))
       (print-matching-results matches)
       (exit (pair? matches))))
    ((db-path-args "search" file)
     (let ((db-path (parse-db-args db-path-args)))
       (if db-path
           (let ((matches (matching-packages-with-db db-path file)))
             (print-matching-results matches)
             (exit (pair? matches)))
           (display-help-and-exit))))
    (_  ;; index by default
     (index-packages-with-db default-db-path))))

debug log:

solving ab7661dbac ...
found ab7661dbac in https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/ ||
	https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/
found 630560b231 in https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/ ||
	https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/
found 7d19e64a07 in https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/ ||
	https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/
found 9679d643a6 in https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/ ||
	https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/
found 3b43ea887e in https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/ ||
	https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/
found ce8306531f in https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/ ||
	https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/
found ab0a0403ec in https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/ ||
	https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/
found 830dfc49fb in https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/ ||
	https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/
found 1e42f5bad8 in https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/ ||
	https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/
found 83aafbc554 in https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/ ||
	https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/

applying [1/10] https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/
diff --git a/guix/extensions/file-database.scm b/guix/extensions/file-database.scm
new file mode 100644
index 0000000000..83aafbc554

Checking patch guix/extensions/file-database.scm...
Applied patch guix/extensions/file-database.scm cleanly.

skipping https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/ for 83aafbc554
index at:
100644 83aafbc55447753c0331e35009d5e8b462d47395	guix/extensions/file-database.scm

applying [2/10] https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/
diff --git a/guix/extensions/file-database.scm b/guix/extensions/locate.scm
similarity index 82%
rename from guix/extensions/file-database.scm
rename to guix/extensions/locate.scm
index 83aafbc554..1e42f5bad8 100644

Checking patch guix/extensions/file-database.scm => guix/extensions/locate.scm...
Applied patch guix/extensions/file-database.scm => guix/extensions/locate.scm cleanly.

skipping https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/ for 1e42f5bad8
index at:
100644 1e42f5bad809dc397ecfd8ba31c6f8b0dc1bf20f	guix/extensions/locate.scm

applying [3/10] https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/
diff --git a/guix/extensions/locate.scm b/guix/extensions/locate.scm
index 1e42f5bad8..830dfc49fb 100644

Checking patch guix/extensions/locate.scm...
Applied patch guix/extensions/locate.scm cleanly.

skipping https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/ for 830dfc49fb
index at:
100644 830dfc49fb3760068804450689515e656035b2e9	guix/extensions/locate.scm

applying [4/10] https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/
diff --git a/guix/extensions/locate.scm b/guix/extensions/locate.scm
index 830dfc49fb..ab0a0403ec 100644

Checking patch guix/extensions/locate.scm...
Applied patch guix/extensions/locate.scm cleanly.

skipping https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/ for ab0a0403ec
index at:
100644 ab0a0403ecfc23f93249aacb687c448df503285d	guix/extensions/locate.scm

applying [5/10] https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/
diff --git a/guix/extensions/locate.scm b/guix/extensions/locate.scm
index ab0a0403ec..ce8306531f 100644

Checking patch guix/extensions/locate.scm...
Applied patch guix/extensions/locate.scm cleanly.

skipping https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/ for ce8306531f
index at:
100644 ce8306531fc238a233f5f81ab8a3135f99912a23	guix/extensions/locate.scm

applying [6/10] https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/
diff --git a/guix/extensions/locate.scm b/guix/extensions/locate.scm
index ce8306531f..3b43ea887e 100644

Checking patch guix/extensions/locate.scm...
Applied patch guix/extensions/locate.scm cleanly.

skipping https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/ for 3b43ea887e
index at:
100644 3b43ea887e99815d477bf059f35a900b73526b58	guix/extensions/locate.scm

applying [7/10] https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/
diff --git a/guix/extensions/locate.scm b/guix/extensions/locate.scm
index 3b43ea887e..9679d643a6 100644

Checking patch guix/extensions/locate.scm...
Applied patch guix/extensions/locate.scm cleanly.

skipping https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/ for 9679d643a6
index at:
100644 9679d643a6a5d92feef005f65aac815d135a486f	guix/extensions/locate.scm

applying [8/10] https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/
diff --git a/guix/extensions/locate.scm b/guix/extensions/locate.scm
index 9679d643a6..7d19e64a07 100644

Checking patch guix/extensions/locate.scm...
Applied patch guix/extensions/locate.scm cleanly.

skipping https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/ for 7d19e64a07
index at:
100644 7d19e64a07f51a51e08b1dbc880922b70daa2acc	guix/extensions/locate.scm

applying [9/10] https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/
diff --git a/guix/extensions/locate.scm b/guix/extensions/locate.scm
index 7d19e64a07..630560b231 100644

Checking patch guix/extensions/locate.scm...
Applied patch guix/extensions/locate.scm cleanly.

skipping https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/ for 630560b231
index at:
100644 630560b231a29096397203cf08b553e52f8e0b43	guix/extensions/locate.scm

applying [10/10] https://yhetil.org/guix/877cz7qg80.fsf@gmail.com/
diff --git a/guix/extensions/locate.scm b/guix/extensions/index.scm
similarity index 93%
rename from guix/extensions/locate.scm
rename to guix/extensions/index.scm
index 630560b231..ab7661dbac 100644

Checking patch guix/extensions/locate.scm => guix/extensions/index.scm...
Applied patch guix/extensions/locate.scm => guix/extensions/index.scm cleanly.

skipping https://yhetil.org/guix/87pmck7g6y.fsf@gmail.com/ for ab7661dbac
index at:
100644 ab7661dbacb6eb9405c4fae84044ea01bf48c676	guix/extensions/index.scm

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/guix.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.