-
Notifications
You must be signed in to change notification settings - Fork 0
/
texfindpkg.lua
631 lines (560 loc) · 15.7 KB
/
texfindpkg.lua
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
#!/usr/bin/env texlua
-- Description: Install TeX packages and their dependencies
-- Copyright: 2023 (c) Jianrui Lyu <[email protected]>
-- Repository: https://github.com/lvjr/texfindpkg
-- License: GNU General Public License v3.0
local tfp = tfp or {}
tfp.version = "2023E"
tfp.date = "2023-05-05"
local building = tfp.building
local tfpresult = ""
------------------------------------------------------------
--> \section{Some variables and functions}
------------------------------------------------------------
local lfs = require("lfs")
local insert = table.insert
local remove = table.remove
local concat = table.concat
local gmatch = string.gmatch
local match = string.match
local find = string.find
local gsub = string.gsub
local sub = string.sub
local rep = string.rep
local lookup = kpse.lookup
kpse.set_program_name("kpsewhich")
require(lookup("lualibs.lua"))
local json = utilities.json -- for json.tostring and json.tolua
local gzip = gzip -- for gzip.compress and gzip.decompress
local function tfpPrint(msg)
msg = "[tfp] " .. msg
if building then
tfpresult = tfpresult .. msg .. "\n"
else
print(msg)
end
end
local function tfpRealPrint(msg)
if not building then
print("[tfp] " .. msg)
end
end
local showdbg = false
local function dbgPrint(msg)
if showdbg then print("[debug] " .. msg) end
end
local function valueExists(tab, val)
for _, v in ipairs(tab) do
if v == val then return true end
end
return false
end
local function getFiles(path, pattern)
local files = { }
for entry in lfs.dir(path) do
if match(entry, pattern) then
insert(files, entry)
end
end
return files
end
local function fileRead(input)
local f = io.open(input, "rb")
local text
if f then -- file exists and is readable
text = f:read("*all")
f:close()
--print(#text)
return text
end
-- return nil if file doesn't exists or isn't readable
end
local function fileWrite(text, output)
-- using "wb" keeps unix eol characters
f = io.open(output, "wb")
f:write(text)
f:close()
end
local function testDistribution()
-- texlive returns "texmf-dist/web2c/updmap.cfg"
-- miktex returns nil although there is "texmfs/install/miktex/config/updmap.cfg"
local d = lookup("updmap.cfg")
if d then
return "texlive"
else
return "miktex"
end
end
------------------------------------------------------------
--> \section{Handle TeX Live package database}
------------------------------------------------------------
local tlpkgtext
local tlinspkgtext
local function tlReadPackageDB()
local tlroot = kpse.var_value("TEXMFROOT")
if tlroot then
tlroot = tlroot .. "/tlpkg"
else
tfpPrint("error in finding texmf root!")
end
local list = getFiles(tlroot, "^texlive%.tlpdb%.main")
if #list > 0 then
tlpkgtext = fileRead(tlroot .. "/" .. list[1])
if not tlpkgtext then
tfpPrint("error in reading texlive.tlpdb.main file!")
end
else
-- no texlive.tlpdb.main file in a fresh TeX live
tfpPrint("error in finding texlive package database!")
tfpPrint("please run 'tlmgr update --self' first.")
end
tlinspkgtext = fileRead(tlroot .. "/texlive.tlpdb")
if not tlinspkgtext then
tfpPrint("error in reading texlive.tlpdb file!")
end
end
local tlpkgdata = {}
local tlinspkgdata = {}
local function tlExtractFiles(name, desc)
-- ignore binary packages
-- also ignore latex-dev packages
if find(name, "%.") or find(name, "^latex%-[%a]-%-dev") then
--print(name)
return
end
-- ignore package files in doc folder
desc = match(desc, "\nrunfiles .+") or ""
for base, ext in gmatch(desc, "/([%a%d%-%.]+)%.([%a%d]+)\n") do
if ext == "sty" or ext == "cls" or ext == "tex" or ext == "ltx" then
dbgPrint(name, base .. "." .. ext)
tlpkgdata[base .. "." .. ext] = name
end
end
end
local function tlExtractPackages(name, desc)
tlinspkgdata[name] = true
end
local function tlParsePackageDB(tlpkgtext)
gsub(tlpkgtext, "name (.-)\n(.-)\n\n", tlExtractFiles)
return tlpkgdata
end
local function tlParseTwoPackageDB()
gsub(tlpkgtext, "name (.-)\n(.-)\n\n", tlExtractFiles)
-- texlive.tlpdb might use different eol characters
gsub(tlinspkgtext, "name (.-)\r?\n(.-)\r?\n\r?\n", tlExtractPackages)
end
------------------------------------------------------------
--> \section{Handle MiKTeX package database}
------------------------------------------------------------
local mtpkgtext
local mtinspkgtext
local function mtReadPackageDB()
local mtvar = kpse.var_value("TEXMFDIST")
if mtvar then
mtpkgtext = fileRead(mtvar .. "/miktex/config/package-manifests.ini")
if not mtpkgtext then
tfpPrint("error in reading package-manifests.ini file!")
end
mtinspkgtext = fileRead(mtvar .. "/miktex/config/packages.ini")
if not mtinspkgtext then
tfpPrint("error in reading packages.ini file!")
end
else
tfpPrint("error in finding texmf root!")
end
end
local mtpkgdata = {}
local mtinspkgdata = {}
local function mtExtractFiles(name, desc)
-- ignore package files in source or doc folders
-- also ignore latex-dev packages
if find(name, "_") or find(name, "^latex%-[%a]-%-dev") then
--print(name)
return
end
for base, ext in gmatch(desc, "/([%a%d%-%.]+)%.([%a%d]+)\r?\n") do
if ext == "sty" or ext == "cls" or ext == "tex" or ext == "ltx" then
dbgPrint(name, base .. "." .. ext)
mtpkgdata[base .. "." .. ext] = name
end
end
end
local function mtExtractPackages(name, desc)
mtinspkgdata[name] = true
end
local function mtParsePackageDB(mtpkgtext)
-- package-manifests.ini might use different eol characters
gsub(mtpkgtext, "%[(.-)%]\r?\n(.-)\r?\n\r?\n", mtExtractFiles)
return mtpkgdata
end
local function mtParseTwoPackageDB()
-- package-manifests.ini and packages.ini might use different eol characters
gsub(mtpkgtext, "%[(.-)%]\r?\n(.-)\r?\n\r?\n", mtExtractFiles)
gsub(mtinspkgtext, "%[(.-)%]\r?\n(.-)\r?\n\r?\n", mtExtractPackages)
end
------------------------------------------------------------
--> \section{Install packages in current TeX distribution}
------------------------------------------------------------
local dist -- name of current tex distribution
local totalinslist = {} -- list of all missing packages
local filecount = 0 -- total number of files found
local function initPackageDB()
dist = testDistribution()
tfpPrint("you are using " .. dist)
if dist == "texlive" then
tlReadPackageDB()
tlParseTwoPackageDB()
else
mtReadPackageDB()
mtParseTwoPackageDB()
end
end
local function findOnePackage(fname)
if dist == "texlive" then
return tlpkgdata[fname]
else
return mtpkgdata[fname]
end
end
local function checkInsPakage(pkg)
if dist == "texlive" then
return tlinspkgdata[pkg]
else
return mtinspkgdata[pkg]
end
end
local function tfpExecute(c)
if not building then
if os.type == "windows" then
os.execute(c)
else
os.execute('sudo env "PATH=$PATH" ' .. c)
end
end
end
local function installSomePackages(list)
if not list then return end
if dist == "texlive" then
local pkgs = concat(list, " ")
if #list > 1 then
tfpRealPrint("installing texlive packages: " .. pkgs)
else
tfpRealPrint("installing texlive package: " .. pkgs)
end
tfpExecute("tlmgr install " .. pkgs)
else
for _, p in ipairs(list) do
tfpRealPrint("installing miktex package: " .. p)
tfpExecute("miktex packages install " .. p)
end
end
end
local function updateTotalInsList(inslist)
if #totalinslist == 0 then
totalinslist = inslist
else
for _, pkg in ipairs(inslist) do
if not valueExists(totalinslist, pkg) then
insert(totalinslist, pkg)
end
end
end
end
local function listSomePackages(list)
if not list then return {} end
if #list > 0 then
filecount = filecount + 1
end
local pkgs = concat(list, " ")
if #list == 1 then
tfpPrint(dist .. " package needed: " .. pkgs)
else
tfpPrint(dist .. " packages needed: " .. pkgs)
end
local inslist = {}
for _, p in ipairs(list) do
if not checkInsPakage(p) then
insert(inslist, p)
end
end
if #inslist == 0 then
if #list == 1 then
tfpRealPrint("this package is already installed")
else
tfpRealPrint("these packages are already installed")
end
else
local pkgs = concat(inslist, " ")
if #inslist == 1 then
tfpRealPrint(dist .. " package not yet installed: " .. pkgs)
else
tfpRealPrint(dist .. " packages not yet installed: " .. pkgs)
end
end
updateTotalInsList(inslist)
end
------------------------------------------------------------
--> \section{Find dependencies of package files}
------------------------------------------------------------
local tfptext = "" -- the json text
local tfpdata = {} -- the lua object
local fnlist = {} -- file name list
local pkglist = {} -- package name list
local function initDependencyDB()
local ziptext = fileRead(lookup("texfindpkg.json.gz"))
tfptext = gzip.decompress(ziptext)
if tfptext then
--print(tfptext)
tfpdata = json.tolua(tfptext)
else
tfpPrint("error in reading texfindpkg.json.gz!")
end
end
local function printDependency(fname, level)
local msg = fname
local pkg = findOnePackage(fname)
if pkg then
msg = msg .. " (from " .. pkg .. ")"
if not valueExists(pkglist, pkg) then
insert(pkglist, pkg)
end
else
msg = msg .. " (not found)"
end
if level == 0 then
tfpPrint(msg)
else
tfpPrint(rep(" ", level - 1) .. "|- " .. msg)
end
end
local function findDependencies(fname, level)
--print(fname)
if valueExists(fnlist, fname) then return end
local item = tfpdata[fname]
if not item then
-- no dependency info for fname
printDependency(fname, level)
return
end
-- finding dependencies for fname
printDependency(fname, level)
insert(fnlist, fname)
local deps = item.deps
if deps then
for _, dname in ipairs(deps) do
findDependencies(dname, level + 1)
end
end
end
local function queryByFileName(fname)
fnlist, pkglist = {}, {} -- reset the list
tfpPrint("building dependency tree for " .. fname .. ":")
tfpPrint(rep("-", 24))
findDependencies(fname, 0)
tfpPrint(rep("-", 24))
if #fnlist == 0 then
tfpPrint("could not find any package with file " .. fname)
return
end
if #pkglist == 0 then
tfpPrint("error in finding package in " .. dist)
return
end
listSomePackages(pkglist)
end
local function getFileNameFromCmdEnvName(cmdenv, name)
--print(name)
local flist = {}
for line in gmatch(tfptext, "(.-)\n[,}]") do
if find(line, '"' .. name .. '"') then
--print(line)
local fname, fspec = match(line, '"(.-)":(.+)')
--print(fname, fspec)
local item = json.tolua(fspec)
if item[cmdenv] and valueExists(item[cmdenv], name) then
insert(flist, fname)
end
end
end
return flist
end
local function queryByCommandName(cname)
--print(cname)
local flist = getFileNameFromCmdEnvName("cmds", cname)
if #flist > 0 then
for _, fname in ipairs(flist) do
tfpPrint(rep("=", 48))
tfpPrint("found package file " .. fname .. " with command \\" .. cname)
queryByFileName(fname)
end
else
tfpPrint("could not find any package with command \\" .. cname)
end
end
local function queryByEnvironmentName(ename)
--print(ename)
local flist = getFileNameFromCmdEnvName("envs", ename)
if #flist > 0 then
for _, fname in ipairs(flist) do
tfpPrint(rep("=", 48))
tfpPrint("found package file " .. fname .. " with environment {" .. ename .. "}")
queryByFileName(fname)
end
else
tfpPrint("could not find any package with environment {" .. ename .. "}")
end
end
local function queryOne(t, name)
if t == "cmd" then
queryByCommandName(name)
elseif t == "env" then
queryByEnvironmentName(name)
elseif t == "file" then
tfpPrint(rep("=", 48))
queryByFileName(name)
else
-- do something for t == "pkg"
end
end
local function query(namelist)
for _, v in ipairs(namelist) do
queryOne(v[1], v[2])
end
if filecount > 1 then
tfpRealPrint(rep("=", 48))
local pkgs = concat(totalinslist, " ")
if #totalinslist == 1 then
tfpRealPrint(dist .. " package not yet installed in total: " .. pkgs)
else
tfpRealPrint(dist .. " packages not yet installed in total: " .. pkgs)
end
end
end
local function install(namelist)
query(namelist)
if #totalinslist > 0 then
installSomePackages(totalinslist)
end
end
------------------------------------------------------------
--> \section{Parse query or install arguments}
------------------------------------------------------------
local function parseName(name)
local h = sub(name, 1, 1)
if h == "\\" then
local b = sub(name, 2)
return({"cmd", b})
elseif h == "{" then
if sub(name, -1) == "}" then
local b = sub(name, 2, -2)
return({"env", b})
else
error("invalid name '" .. name .. "'")
end
elseif find(name, "%.") then
return({"file", name})
else
return({"pkg", name})
end
end
local function parseArgList(arglist)
local namelist = {}
local nametype = nil
for _, v in ipairs(arglist) do
if v == "-f" then
nametype = "file"
elseif v == "-c" then
nametype = "cmd"
elseif v == "-e" then
nametype = "env"
else
if nametype then
insert(namelist, {nametype, v})
else
insert(namelist, parseName(v))
end
end
end
if #namelist == 0 then
error("missing the name of file/cmd/env!")
else
return namelist
end
end
local function doQuery(arglist)
local namelist = parseArgList(arglist)
initPackageDB()
initDependencyDB()
query(namelist)
end
local function doInstall(arglist)
local namelist = parseArgList(arglist)
initPackageDB()
initDependencyDB()
install(namelist)
end
------------------------------------------------------------
--> \section{Print help or version text}
------------------------------------------------------------
local helptext = [[
usage: texfindpkg <action> [<options>] [<name>]
valid actions are:
install Install some package and its dependencies
query Query dependencies for some package
help Print this message and exit
version Print version information and exit
valid options are:
-f Query or install by file name
-c Query or install by command name
-e Query or install by environment name
please report bug at https://github.com/lvjr/texfindpkg
]]
local function help()
print(helptext)
end
local function version()
print("TeXFindPkg Version " .. tfp.version .. " (" .. tfp.date .. ")\n")
end
------------------------------------------------------------
--> \section{Respond to user input}
------------------------------------------------------------
local function tfpMain(tfparg)
tfpresult = ""
if tfparg[1] == nil then return help() end
local action = remove(tfparg, 1)
action = match(action, "^%-*(.*)$") -- remove leading dashes
--print(action)
if action == "query" then
doQuery(tfparg)
elseif action == "install" then
doInstall(tfparg)
elseif action == "help" then
help()
elseif action == "version" then
version()
else
tfpPrint("unknown action '" .. action .. "'")
help()
end
return tfpresult
end
local function main()
tfpMain(arg)
end
if building then
tfp.tfpMain = tfpMain
tfp.showdbg = showdbg
tfp.dbgPrint = dbgPrint
tfp.tfpPrint = tfpPrint
tfp.fileRead = fileRead
tfp.fileWrite = fileWrite
tfp.getFiles = getFiles
tfp.valueExists = valueExists
tfp.json = json
tfp.gzip = gzip
tfp.tlParsePackageDB = tlParsePackageDB
tfp.mtParsePackageDB = mtParsePackageDB
return tfp
else
main()
end