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
|
if not modules then modules = { } end modules ['lpdf-epa'] = {
version = 1.001,
comment = "companion to lpdf-epa.mkiv",
author = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
copyright = "PRAGMA ADE / ConTeXt Development Team",
license = "see context related readme files"
}
-- This is a rather experimental feature and the code will probably change.
local type, tonumber = type, tonumber
local format, gsub, lower = string.format, string.gsub, string.lower
local formatters = string.formatters
local abs = math.abs
local expandname = file.expandname
local allocate = utilities.storage.allocate
local isfile = lfs.isfile
----- lpegmatch, lpegpatterns = lpeg.match, lpeg.patterns
local trace_links = false trackers.register("figures.links", function(v) trace_links = v end)
local trace_outlines = false trackers.register("figures.outliness", function(v) trace_outlines = v end)
local report_link = logs.reporter("backend","link")
local report_comment = logs.reporter("backend","comment")
local report_field = logs.reporter("backend","field")
local report_outline = logs.reporter("backend","outline")
local epdf = epdf
local backends = backends
local lpdf = lpdf
local context = context
local loadpdffile = lpdf.epdf.load
local nameonly = file.nameonly
local variables = interfaces.variables
local codeinjections = backends.pdf.codeinjections
----- urlescaper = lpegpatterns.urlescaper
----- utftohigh = lpegpatterns.utftohigh
local escapetex = characters.filters.utf.private.escape
local bookmarks = structures.bookmarks
local maxdimen = 0x3FFFFFFF -- 2^30-1
local layerspec = { -- predefining saves time
"epdflinks"
}
local collected = allocate()
local tobesaved = allocate()
local jobembedded = {
collected = collected,
tobesaved = tobesaved,
}
job.embedded = jobembedded
local function initializer()
tobesaved = jobembedded.tobesaved
collected = jobembedded.collected
end
job.register('job.embedded.collected',tobesaved,initializer)
local f_namespace = formatters["lpdf-epa-%s-"]
local function makenamespace(filename)
filename = gsub(lower(nameonly(filename)),"[^%a%d]+","-")
return f_namespace(filename)
end
local function add_link(x,y,w,h,destination,what)
x = x .. "bp"
y = y .. "bp"
w = w .. "bp"
h = h .. "bp"
if trace_links then
report_link("destination %a, type %a, dx %s, dy %s, wd %s, ht %s",destination,what,x,y,w,h)
end
local locationspec = { -- predefining saves time
x = x,
y = y,
preset = "leftbottom",
}
local buttonspec = {
width = w,
height = h,
offset = variables.overlay,
frame = trace_links and variables.on or variables.off,
}
context.setlayer (
layerspec,
locationspec,
function() context.button ( buttonspec, "", { destination } ) end
-- context.nested.button(buttonspec, "", { destination }) -- time this
)
end
local function link_goto(x,y,w,h,document,annotation,pagedata,namespace)
local a = annotation.A
if a then
local destination = a.D -- [ 18 0 R /Fit ]
local what = "page"
if type(destination) == "string" then
local destinations = document.destinations
local wanted = destinations[destination]
destination = wanted and wanted.D -- is this ok? isn't it destination already a string?
if destination then what = "named" end
end
local pagedata = destination and destination[1]
if pagedata then
local destinationpage = pagedata.number
if destinationpage then
add_link(x,y,w,h,namespace .. destinationpage,what)
end
end
end
end
local function link_uri(x,y,w,h,document,annotation)
local url = annotation.A.URI
if url then
-- url = lpegmatch(urlescaper,url)
-- url = lpegmatch(utftohigh,url)
url = escapetex(url)
add_link(x,y,w,h,formatters["url(%s)"](url),"url")
end
end
-- The rules in PDF on what a 'file specification' is, is in fact quite elaborate
-- (see section 3.10 in the 1.7 reference) so we need to test for string as well
-- as a table. TH/20140916
-- When embedded is set then files need to have page references which is seldom the
-- case but you can generate them with context:
--
-- \setupinteraction[state=start,page={page,page}]
--
-- see tests/mkiv/interaction/cross[1|2|3].tex for an example
local embedded = false directives.register("figures.embedded", function(v) embedded = v end)
local reported = { }
local function link_file(x,y,w,h,document,annotation)
local a = annotation.A
if a then
local filename = a.F
if type(filename) == "table" then
filename = filename.F
end
if filename then
filename = escapetex(filename)
local destination = a.D
if not destination then
add_link(x,y,w,h,formatters["file(%s)"](filename),"file")
elseif type(destination) == "string" then
add_link(x,y,w,h,formatters["%s::%s"](filename,destination),"file (named)")
else
-- hm, zero offset so maybe: destination + 1
destination = tonumber(destination[1]) -- array
if destination then
destination = destination + 1
local loaded = collected[lower(expandname(filename))]
if embedded and loaded then
add_link(x,y,w,h,makenamespace(filename) .. destination,what)
else
if loaded and not reported[filename] then
report_link("reference to an also loaded file %a, consider using directive: figures.embedded",filename)
reported[filename] = true
end
add_link(x,y,w,h,formatters["%s::page(%s)"](filename,destination),"file (page)")
end
else
add_link(x,y,w,h,formatters["file(%s)"](filename),"file")
end
end
end
end
end
function codeinjections.mergereferences(specification)
if figures and not specification then
specification = figures and figures.current()
specification = specification and specification.status
end
if not specification then
return ""
end
local fullname = specification.fullname
local expanded = lower(expandname(fullname))
-- we could add a check for duplicate page insertion
tobesaved[expanded] = true
--- but that is messy anyway so we forget about it
local document = loadpdffile(fullname) -- costs time
if not document then
return ""
end
local pagenumber = specification.page or 1
local xscale = specification.yscale or 1
local yscale = specification.yscale or 1
local size = specification.size or "crop" -- todo
local pagedata = document.pages[pagenumber]
local annotations = pagedata and pagedata.Annots
local namespace = makenamespace(fullname)
local reference = namespace .. pagenumber
if annotations and annotations.n > 0 then
local mediabox = pagedata.MediaBox
local llx = mediabox[1]
local lly = mediabox[2]
local urx = mediabox[3]
local ury = mediabox[4]
local width = xscale * (urx - llx) -- \\overlaywidth, \\overlayheight
local height = yscale * (ury - lly) -- \\overlaywidth, \\overlayheight
context.definelayer( { "epdflinks" }, { height = height.."bp" , width = width.."bp" })
for i=1,annotations.n do
local annotation = annotations[i]
if annotation then
local subtype = annotation.Subtype
local rectangle = annotation.Rect
local a_llx = rectangle[1]
local a_lly = rectangle[2]
local a_urx = rectangle[3]
local a_ury = rectangle[4]
local x = xscale * (a_llx - llx)
local y = yscale * (a_lly - lly)
local w = xscale * (a_urx - a_llx)
local h = yscale * (a_ury - a_lly)
if subtype == "Link" then
local a = annotation.A
if not a then
report_link("missing link annotation")
elseif w > width or h > height or w < 0 or h < 0 or abs(x) > (maxdimen/2) or abs(y) > (maxdimen/2) then
report_link("broken link rectangle [%.6F %.6F %.6F %.6F] (max: %.6F)",a_llx,a_lly,a_urx,a_ury,maxdimen/2)
else
local linktype = a.S
if linktype == "GoTo" then
link_goto(x,y,w,h,document,annotation,pagedata,namespace)
elseif linktype == "GoToR" then
link_file(x,y,w,h,document,annotation)
elseif linktype == "URI" then
link_uri(x,y,w,h,document,annotation)
elseif trace_links then
report_link("unsupported link annotation %a",linktype)
end
end
elseif trace_links then
report_link("unsupported annotation %a",subtype)
end
elseif trace_links then
report_link("broken annotation, index %a",i)
end
end
context.flushlayer { "epdflinks" }
end
-- moved outside previous test
context.setgvalue("figurereference",reference) -- global
if trace_links then
report_link("setting figure reference to %a",reference)
end
specification.reference = reference
return namespace
end
function codeinjections.mergeviewerlayers(specification)
-- todo: parse included page for layers .. or only for whole document inclusion
if true then
return
end
if not specification then
specification = figures and figures.current()
specification = specification and specification.status
end
if specification then
local fullname = specification.fullname
local document = loadpdffile(fullname)
if document then
local namespace = makenamespace(fullname)
local layers = document.layers
if layers then
for i=1,layers.n do
local layer = layers[i]
if layer then
local tag = namespace .. gsub(layer," ",":")
local title = tag
if trace_links then
report_link("using layer %a",tag)
end
attributes.viewerlayers.define { -- also does some cleaning
tag = tag, -- todo: #3A or so
title = title,
visible = variables.start,
editable = variables.yes,
printable = variables.yes,
}
codeinjections.useviewerlayer(tag)
elseif trace_links then
report_link("broken layer, index %a",i)
end
end
end
end
end
end
-- new: for taco
-- Beware, bookmarks can be in pdfdoc encoding or in unicode. However, in mkiv we
-- write out the strings in unicode (hex). When we read them in, we check for a bom
-- and convert to utf.
function codeinjections.getbookmarks(filename)
-- The first version built a nested tree and flattened that afterwards ... but I decided
-- to keep it simple and flat.
local list = bookmarks.extras.get(filename)
if list then
return list
else
list = { }
end
local document = nil
if isfile(filename) then
document = loadpdffile(filename)
else
report_outline("unknown file %a",filename)
bookmarks.extras.register(filename,list)
return list
end
local outlines = document.Catalog.Outlines
local pages = document.pages
local nofpages = pages.n -- we need to access once in order to initialize
local destinations = document.destinations
-- I need to check this destination analyzer with the one in annotations .. best share
-- code (and not it's inconsistent). On the todo list ...
local function setdestination(current,entry)
local destination = nil
local action = current.A
if action then
local subtype = action.S
if subtype == "GoTo" then
destination = action.D
local kind = type(destination)
if kind == "string" then
entry.destination = destination
destination = destinations[destination]
local pagedata = destination and destination[1]
if pagedata then
entry.realpage = pagedata.number
end
elseif kind == "table" then
local pageref = destination.n
if pageref then
local pagedata = pages[pageref]
if pagedata then
entry.realpage = pagedata.number
end
end
end
else
-- maybe
end
else
local destination = current.Dest
if destination then
if type(destination) == "string" then
local wanted = destinations[destination]
destination = wanted and wanted.D
if destination then
entry.destination = destination
end
else
local pagedata = destination and destination[1]
if pagedata and pagedata.Type == "Page" then
entry.realpage = pagedata.number
end
end
end
end
end
local function traverse(current,depth)
while current do
-- local title = current.Title
local title = current("Title") -- can be pdfdoc or unicode
if title then
local entry = {
level = depth,
title = title,
}
list[#list+1] = entry
setdestination(current,entry)
if trace_outlines then
report_outline("%w%s",2*depth,title)
end
end
local first = current.First
if first then
local current = first
while current do
local title = current.Title
if title and trace_outlines then
report_outline("%w%s",2*depth,title)
end
local entry = {
level = depth,
title = title,
}
setdestination(current,entry)
list[#list+1] = entry
traverse(current.First,depth+1)
current = current.Next
end
end
current = current.Next
end
end
if outlines then
if trace_outlines then
report_outline("outline of %a:",document.filename)
report_outline()
end
traverse(outlines,0)
if trace_outlines then
report_outline()
end
elseif trace_outlines then
report_outline("no outline in %a",document.filename)
end
bookmarks.extras.register(filename,list)
return list
end
function codeinjections.mergebookmarks(specification)
-- codeinjections.getbookmarks(document)
if not specification then
specification = figures and figures.current()
specification = specification and specification.status
end
if specification then
local fullname = specification.fullname
local bookmarks = backends.codeinjections.getbookmarks(fullname)
local realpage = tonumber(specification.page) or 1
for i=1,#bookmarks do
local b = bookmarks[i]
if not b.usedpage then
if b.realpage == realpage then
if trace_options then
report_outline("using %a at page %a of file %a",b.title,realpage,fullname)
end
b.usedpage = true
b.section = structures.sections.currentsectionindex()
b.pageindex = specification.pageindex
end
end
end
end
end
-- placeholders:
function codeinjections.mergecomments(specification)
report_comment("unfinished experimental code, not used yet")
end
function codeinjections.mergefields(specification)
report_field("unfinished experimental code, not used yet")
end
-- A bit more than a placeholder but in the same perspective as
-- inclusion of comments and fields:
--
-- getinfo{ filename = "tt.pdf", metadata = true }
-- getinfo{ filename = "tt.pdf", page = 1, metadata = "xml" }
-- getinfo("tt.pdf")
function codeinjections.getinfo(specification)
if type(specification) == "string" then
specification = { filename = specification }
end
local filename = specification.filename
if type(filename) == "string" and isfile(filename) then
local pdffile = loadpdffile(filename)
if pdffile then
local pagenumber = specification.page or 1
local metadata = specification.metadata
local catalog = pdffile.Catalog
local info = pdffile.Info
local pages = pdffile.pages
local nofpages = pages.n
if metadata then
local m = catalog.Metadata
if m then
m = m()
if metadata == "xml" then
metadata = xml.convert(m)
else
metadata = m
end
else
metadata = nil
end
else
metadata = nil
end
if pagenumber > nofpages then
pagenumber = nofpages
end
local nobox = { 0, 0, 0, 0 }
local crop = nobox
local media = nobox
local page = pages[pagenumber]
if page then
crop = page.CropBox or nobox
media = page.MediaBox or crop or nobox
crop.n = nil -- nicer
media.n = nil -- nicer
end
local bbox = crop or media or nobox
return {
filename = filename,
pdfversion = tonumber(catalog.Version),
nofpages = nofpages,
title = info.Title,
creator = info.Creator,
producer = info.Producer,
creationdate = info.CreationDate,
modification = info.ModDate,
metadata = metadata,
width = bbox[4] - bbox[2],
height = bbox[3] - bbox[1],
cropbox = { crop[1], crop[2], crop[3], crop[4] }, -- we need access
mediabox = { media[1], media[2], media[3], media[4] } , -- we need access
}
end
end
end
|