From d21f0a146ce9ce0249c46751cdb849738768e38c Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 22 Nov 2020 22:19:22 +0000 Subject: hyperxmp (22nov20) git-svn-id: svn://tug.org/texlive/trunk@56984 c570f23f-e606-0410-a88d-b1316a301751 --- .../source/texk/texlive/linked_scripts/Makefile.am | 1 + .../source/texk/texlive/linked_scripts/Makefile.in | 189 +++++++++--------- .../hyperxmp/hyperxmp-add-bytecount.pl | 219 +++++++++++++++++++++ .../source/texk/texlive/linked_scripts/scripts.lst | 95 +-------- 4 files changed, 316 insertions(+), 188 deletions(-) create mode 100755 Build/source/texk/texlive/linked_scripts/hyperxmp/hyperxmp-add-bytecount.pl (limited to 'Build/source/texk/texlive/linked_scripts') diff --git a/Build/source/texk/texlive/linked_scripts/Makefile.am b/Build/source/texk/texlive/linked_scripts/Makefile.am index 195c309d3f8..685291e13bb 100644 --- a/Build/source/texk/texlive/linked_scripts/Makefile.am +++ b/Build/source/texk/texlive/linked_scripts/Makefile.am @@ -142,6 +142,7 @@ texmf_other_scripts = \ getmap/getmapdl.lua \ glossaries/makeglossaries \ glossaries/makeglossaries-lite.lua \ + hyperxmp/hyperxmp-add-bytecount.pl jfmutil/jfmutil.pl \ ketcindy/ketcindy.pl \ kotex-utils/jamo-normalize.pl \ diff --git a/Build/source/texk/texlive/linked_scripts/Makefile.in b/Build/source/texk/texlive/linked_scripts/Makefile.in index ee6a86741a9..bc21ac22d23 100644 --- a/Build/source/texk/texlive/linked_scripts/Makefile.in +++ b/Build/source/texk/texlive/linked_scripts/Makefile.in @@ -355,100 +355,7 @@ texmf_other_scripts = \ getmap/getmapdl.lua \ glossaries/makeglossaries \ glossaries/makeglossaries-lite.lua \ - jfmutil/jfmutil.pl \ - ketcindy/ketcindy.pl \ - kotex-utils/jamo-normalize.pl \ - kotex-utils/komkindex.pl \ - kotex-utils/ttf2kotexfont.pl \ - l3build/l3build.lua \ - latex-git-log/latex-git-log \ - latex-papersize/latex-papersize.py \ - latex2man/latex2man \ - latex2nemeth/latex2nemeth \ - latexdiff/latexdiff-vc.pl \ - latexdiff/latexdiff.pl \ - latexdiff/latexrevise.pl \ - latexindent/latexindent.pl \ - latexmk/latexmk.pl \ - latexpand/latexpand \ - light-latex-make/llmk.lua \ - lilyglyphs/lily-glyph-commands.py \ - lilyglyphs/lily-image-commands.py \ - lilyglyphs/lily-rebuild-pdfs.py \ - ltximg/ltximg.pl \ - luaotfload/luaotfload-tool.lua \ - lwarp/lwarpmk.lua \ - m-tx/m-tx.lua \ - makedtx/makedtx.pl \ - make4ht/make4ht \ - match_parens/match_parens \ - mathspic/mathspic.pl \ - mf2pt1/mf2pt1.pl \ - mkgrkindex/mkgrkindex \ - mkjobtexmf/mkjobtexmf.pl \ - mkpic/mkpic \ - multibibliography/multibibliography.pl \ - musixtex/musixflx.lua \ - musixtex/musixtex.lua \ - pax/pdfannotextractor.pl \ - pdfcrop/pdfcrop.pl \ - pdflatexpicscale/pdflatexpicscale.pl \ - pedigree-perl/pedigree.pl \ - perltex/perltex.pl \ - petri-nets/pn2pdf \ - pfarrei/a5toa4.tlu \ - pfarrei/pfarrei.tlu \ - pkfix-helper/pkfix-helper \ - pkfix/pkfix.pl \ - pmxchords/pmxchords.lua \ - pst2pdf/pst2pdf.pl \ - ptex-fontmaps/kanji-config-updmap-sys.sh \ - ptex-fontmaps/kanji-config-updmap-user.sh \ - ptex-fontmaps/kanji-config-updmap.pl \ - ptex-fontmaps/kanji-fontmap-creator.pl \ - ptex2pdf/ptex2pdf.lua \ - purifyeps/purifyeps \ - pygmentex/pygmentex.py \ - pythontex/depythontex.py \ - pythontex/pythontex.py \ - rubik/rubikrotation.pl \ - spix/spix.py \ - splitindex/splitindex.pl \ - srcredact/srcredact.pl \ - sty2dtx/sty2dtx.pl \ - svn-multi/svn-multi.pl \ - tex4ebook/tex4ebook \ - texcount/texcount.pl \ - texdef/texdef.pl \ - texdiff/texdiff \ - texdirflatten/texdirflatten \ - texdoc/texdoc.tlu \ - texfot/texfot.pl \ - texlive/fmtutil-sys.sh \ - texlive/fmtutil-user.sh \ - texlive/fmtutil.pl \ - texlive/mktexlsr \ - texlive/mktexmf \ - texlive/mktexpk \ - texlive/mktextfm \ - texlive/rungs.tlu \ - texlive/tlmgr.pl \ - texlive/updmap-sys.sh \ - texlive/updmap-user.sh \ - texlive/updmap.pl \ - texlive-extra/e2pall.pl \ - texliveonfly/texliveonfly.py \ - texloganalyser/texloganalyser \ - texplate/texplate.sh \ - thumbpdf/thumbpdf.pl \ - tlcockpit/tlcockpit.sh \ - tlshell/tlshell.tcl \ - ulqda/ulqda.pl \ - urlbst/urlbst \ - vpe/vpe.pl \ - webquiz/webquiz.py \ - xindex/xindex.lua \ - yplan/yplan + hyperxmp/hyperxmp-add-bytecount.pl texmf_context_scripts = \ context/stubs/unix/context \ @@ -732,6 +639,100 @@ scripts-list: Makefile installdirs-local: $(MKDIR_P) $(DESTDIR)$(bindir) + jfmutil/jfmutil.pl \ + ketcindy/ketcindy.pl \ + kotex-utils/jamo-normalize.pl \ + kotex-utils/komkindex.pl \ + kotex-utils/ttf2kotexfont.pl \ + l3build/l3build.lua \ + latex-git-log/latex-git-log \ + latex-papersize/latex-papersize.py \ + latex2man/latex2man \ + latex2nemeth/latex2nemeth \ + latexdiff/latexdiff-vc.pl \ + latexdiff/latexdiff.pl \ + latexdiff/latexrevise.pl \ + latexindent/latexindent.pl \ + latexmk/latexmk.pl \ + latexpand/latexpand \ + light-latex-make/llmk.lua \ + lilyglyphs/lily-glyph-commands.py \ + lilyglyphs/lily-image-commands.py \ + lilyglyphs/lily-rebuild-pdfs.py \ + ltximg/ltximg.pl \ + luaotfload/luaotfload-tool.lua \ + lwarp/lwarpmk.lua \ + m-tx/m-tx.lua \ + makedtx/makedtx.pl \ + make4ht/make4ht \ + match_parens/match_parens \ + mathspic/mathspic.pl \ + mf2pt1/mf2pt1.pl \ + mkgrkindex/mkgrkindex \ + mkjobtexmf/mkjobtexmf.pl \ + mkpic/mkpic \ + multibibliography/multibibliography.pl \ + musixtex/musixflx.lua \ + musixtex/musixtex.lua \ + pax/pdfannotextractor.pl \ + pdfcrop/pdfcrop.pl \ + pdflatexpicscale/pdflatexpicscale.pl \ + pedigree-perl/pedigree.pl \ + perltex/perltex.pl \ + petri-nets/pn2pdf \ + pfarrei/a5toa4.tlu \ + pfarrei/pfarrei.tlu \ + pkfix-helper/pkfix-helper \ + pkfix/pkfix.pl \ + pmxchords/pmxchords.lua \ + pst2pdf/pst2pdf.pl \ + ptex-fontmaps/kanji-config-updmap-sys.sh \ + ptex-fontmaps/kanji-config-updmap-user.sh \ + ptex-fontmaps/kanji-config-updmap.pl \ + ptex-fontmaps/kanji-fontmap-creator.pl \ + ptex2pdf/ptex2pdf.lua \ + purifyeps/purifyeps \ + pygmentex/pygmentex.py \ + pythontex/depythontex.py \ + pythontex/pythontex.py \ + rubik/rubikrotation.pl \ + spix/spix.py \ + splitindex/splitindex.pl \ + srcredact/srcredact.pl \ + sty2dtx/sty2dtx.pl \ + svn-multi/svn-multi.pl \ + tex4ebook/tex4ebook \ + texcount/texcount.pl \ + texdef/texdef.pl \ + texdiff/texdiff \ + texdirflatten/texdirflatten \ + texdoc/texdoc.tlu \ + texfot/texfot.pl \ + texlive/fmtutil-sys.sh \ + texlive/fmtutil-user.sh \ + texlive/fmtutil.pl \ + texlive/mktexlsr \ + texlive/mktexmf \ + texlive/mktexpk \ + texlive/mktextfm \ + texlive/rungs.tlu \ + texlive/tlmgr.pl \ + texlive/updmap-sys.sh \ + texlive/updmap-user.sh \ + texlive/updmap.pl \ + texlive-extra/e2pall.pl \ + texliveonfly/texliveonfly.py \ + texloganalyser/texloganalyser \ + texplate/texplate.sh \ + thumbpdf/thumbpdf.pl \ + tlcockpit/tlcockpit.sh \ + tlshell/tlshell.tcl \ + ulqda/ulqda.pl \ + urlbst/urlbst \ + vpe/vpe.pl \ + webquiz/webquiz.py \ + xindex/xindex.lua \ + yplan/yplan install-data-hook: installdirs-local @WIN32_TRUE@ @for s in $(texmf_other_scripts); do \ @WIN32_TRUE@ t=`basename $$s | sed 's,\.[^/]*$$,,' | tr '[A-Z]' '[a-z]'`; \ diff --git a/Build/source/texk/texlive/linked_scripts/hyperxmp/hyperxmp-add-bytecount.pl b/Build/source/texk/texlive/linked_scripts/hyperxmp/hyperxmp-add-bytecount.pl new file mode 100755 index 00000000000..8d965a63f5f --- /dev/null +++ b/Build/source/texk/texlive/linked_scripts/hyperxmp/hyperxmp-add-bytecount.pl @@ -0,0 +1,219 @@ +#!/usr/bin/env perl +use warnings; + +############################################################# +############################################################# + +######################################################################## +# hyperxmp-add-bytecount # +# Adds/updates byteCount specification in XMP packet in pdf file(s) # +# made by hyperxmp, with byteCount = file size. # +# Copyright (C) 2020 John Collins # +# and Scott Pakin, # +# # +# This program may be distributed and/or modified under the conditions # +# of the LaTeX Project Public License, either version 1.3c of this # +# license or (at your option) any later version. # +# # +# The latest version of this license is in: # +# # +# http://www.latex-project.org/lppl.txt # +# # +# and version 1.3c or later is part of all distributions of LaTeX # +# version 2008/05/04 or later. # +######################################################################## + +$name = 'hyperref-add-bytecount'; +$version = '1.1-2020-11-20'; +$maintainer + = 'John Collins, jcc8@psu.edu; Scott Pakin, scott+hyxmp@pakin.org'; + +my $exit_code = 0; + +if ( (! @ARGV) || ($ARGV[0] =~ /^(-|--)(h|help)$/) ) { + print "$name $version.\n", + "Usage: $name [options] pdf_filename(s)\n", + " Adds/updates byteCount specification in XMP packet in pdf file(s) from\n", + " hyperxmp, with byteCount = file size.\n", + " No change if there's no XMP packet of the form produced by hyperxmp.\n", + "Options:\n", + " -help or -h Output usage information.\n", + " -version or -v Output version information.\n", + "Bug reports to:\n $maintainer.\n"; + exit; +} elsif ( $ARGV[0] =~ /^(-|--)(v|version)$/ ) { + print "$name $version.\n", + "Bug reports to:\n $maintainer.\n"; + exit; +} + +foreach (@ARGV) { + if ( ! fix_pdf($_) ) { $exit_code = 1; } +} + +exit $exit_code; + +#====================================================== + +sub fix_pdf { + # Change/insert byteCount field with correct file length, while preserving + # the file size and the length of the stream containing xmp metadata. + # Return 1 on success, else 0. + + local $pdf_name = shift; + local $tmp_name = "$pdf_name.new.pdf"; + local $pdf_size = (stat($pdf_name))[7]; + warn "Inserting/correcting byteCount field in '$pdf_name' ...\n"; + + # Strings surrounding (and identifying) the byteCount field, and other + # parts of the xmp packet: + local $xmp_start = ''; + local $decl_bC = 'byteCount'; + local $pre_bC = ''; + local $post_bC = ''; + local $pC = ''; + local $rd_end = ''; + local $xmp_end = ''; + + local *PDF; + local *TMP; + + if (! open PDF, "<", $pdf_name ) { + warn " Cannot read '$pdf_name'\n"; + return 0; + } + if ( ! open TMP, ">", $tmp_name ) { + warn " Cannot write temporary file '$tmp_name'\n"; + close PDF; + return 0; + } + local $status = 0; # 0 = no XMP packet, 1 = success, >= errors + while ( ) { + # Only examine first XMP packet: + if ( ($status == 0) && /^\s*\Q$xmp_start\E/ ) { + local @xmp = $_; + local $len_padding = 0; + local $xmp_after_line = ''; + &xmp_get_mod; + print TMP @xmp; + # Insert correct padding to leave file size unchanged: + while ( $len_padding > 0 ) { + my $len_line = 64; + if ( $len_line > $len_padding ) { $len_line = $len_padding; } + $len_padding -= $len_line; + print TMP (' ' x ($len_line - 1) ), "\n"; + } + print TMP $xmp_after_line; + $xmp_after_line = ''; + } + else { + print TMP "$_"; + } + } + close PDF; + close TMP; + + if ($status == 0) { + warn " Could not insert/modify byteCount, since no XMP packet was found.\n"; + warn " So '$pdf_name' is unchanged,\n", + " and I will delete temporary file '$tmp_name'.\n"; + unlink $tmp_name; + } elsif ($status == 1) { + rename $tmp_name, $pdf_name + or die " Cannot move temporary file '$tmp_name' to '$pdf_name'.\n", + " Error is '$!'\n"; + } else { + warn " Could not insert correct byteCount. See above for reason.\n"; + warn " So '$pdf_name' is unchanged,\n", + " and I will delete temporary file '$tmp_name'.\n"; + unlink $tmp_name; + } + return ($status == 1); +} + +#====================================================== + +sub xmp_get_mod { + # Get xmp packet, given that @xmp contains its first line. + # Get amount of trailing padding, and line after that. + # If possible, insert a byteCount field: + # Either replace existing specification, if it exists, + # or insert one in expected place for hyperxmp, if the XMP packet + # matches what hyperxmp would produce. + # Return xmp packet in @xmp, amount of padding needed in $len_padding, + # line after that in $xmp_after_line, and error code in $error. + # Set $status appropriately: 1 for success; >=1 for failure. + + $len_padding = 0; + $xmp_after_line = ''; + + my $bC_index = -1; + my $xmp_end_found = 0; + my $decl_bC_found = 0; + while ( ) { + push @xmp, $_; + if ( /^\s*\Q$xmp_end\E/ ) { + $xmp_end_found = 1; + # Get amount of padding; + while () { + if ( /^\s*$/ ) { + $len_padding += length($_); + } else { + $xmp_after_line = $_; + last; + } + } + last; + } + elsif ( $bC_index >= 0 ){ + next; + } + # Rest of conditions only apply if no place yet found for byteCount + # specification. + elsif ( /^(\s*)\Q$pre_bC\E.*?\Q$post_bC\E\s*$/ ) { + $bC_index = $#xmp; + } + elsif ( /^\s*\Q$decl_bC\E/ ) { + $decl_bC_found = 1; + } + elsif ( /^(\s*)\Q$rd_end\E/ ){ + # End of rdf:Description block. + # So having previous declaration of byteCount is irrelevant. + $decl_bC_found = 0; + } + elsif ( $decl_bC_found && /^(\s*)\Q$pC\E/ ){ + $bC_index = $#xmp; + pop @xmp; + push @xmp, '', $_; + } + + } # End reading of XMP + + if ($bC_index < 0) { + if ( ! $xmp_end_found ) { + warn " End of XMP packet not found.\n"; + $status = 2; + } + elsif ( ! $decl_bC_found ) { + warn " XMP packet not in appropriate hyperxmp-compatible format.\n"; + $status = 3; + } + return; + } + my $new_line = ' ' . $pre_bC . $pdf_size . $post_bC . "\n"; + my $old_line = $xmp[$bC_index]; + my $delta_len = length($new_line) - length($old_line); + if ($delta_len > $len_padding) { + warn " Cannot get padding correct for '$pdf_name'.\n", + " Length change of bC line = $delta_len; ", + " Padding bytes available = $len_padding.\n"; + $status = 4; + return; + } else { + $len_padding -= $delta_len; + $xmp[$bC_index] = $new_line; + $status = 1; + } +} + +#====================================================== diff --git a/Build/source/texk/texlive/linked_scripts/scripts.lst b/Build/source/texk/texlive/linked_scripts/scripts.lst index 9d9308af690..f0ea334e3db 100644 --- a/Build/source/texk/texlive/linked_scripts/scripts.lst +++ b/Build/source/texk/texlive/linked_scripts/scripts.lst @@ -84,100 +84,7 @@ fragmaster/fragmaster.pl getmap/getmapdl.lua glossaries/makeglossaries glossaries/makeglossaries-lite.lua -jfmutil/jfmutil.pl -ketcindy/ketcindy.pl -kotex-utils/jamo-normalize.pl -kotex-utils/komkindex.pl -kotex-utils/ttf2kotexfont.pl -l3build/l3build.lua -latex-git-log/latex-git-log -latex-papersize/latex-papersize.py -latex2man/latex2man -latex2nemeth/latex2nemeth -latexdiff/latexdiff-vc.pl -latexdiff/latexdiff.pl -latexdiff/latexrevise.pl -latexindent/latexindent.pl -latexmk/latexmk.pl -latexpand/latexpand -light-latex-make/llmk.lua -lilyglyphs/lily-glyph-commands.py -lilyglyphs/lily-image-commands.py -lilyglyphs/lily-rebuild-pdfs.py -ltximg/ltximg.pl -luaotfload/luaotfload-tool.lua -lwarp/lwarpmk.lua -m-tx/m-tx.lua -makedtx/makedtx.pl -make4ht/make4ht -match_parens/match_parens -mathspic/mathspic.pl -mf2pt1/mf2pt1.pl -mkgrkindex/mkgrkindex -mkjobtexmf/mkjobtexmf.pl -mkpic/mkpic -multibibliography/multibibliography.pl -musixtex/musixflx.lua -musixtex/musixtex.lua -pax/pdfannotextractor.pl -pdfcrop/pdfcrop.pl -pdflatexpicscale/pdflatexpicscale.pl -pedigree-perl/pedigree.pl -perltex/perltex.pl -petri-nets/pn2pdf -pfarrei/a5toa4.tlu -pfarrei/pfarrei.tlu -pkfix-helper/pkfix-helper -pkfix/pkfix.pl -pmxchords/pmxchords.lua -pst2pdf/pst2pdf.pl -ptex-fontmaps/kanji-config-updmap-sys.sh -ptex-fontmaps/kanji-config-updmap-user.sh -ptex-fontmaps/kanji-config-updmap.pl -ptex-fontmaps/kanji-fontmap-creator.pl -ptex2pdf/ptex2pdf.lua -purifyeps/purifyeps -pygmentex/pygmentex.py -pythontex/depythontex.py -pythontex/pythontex.py -rubik/rubikrotation.pl -spix/spix.py -splitindex/splitindex.pl -srcredact/srcredact.pl -sty2dtx/sty2dtx.pl -svn-multi/svn-multi.pl -tex4ebook/tex4ebook -texcount/texcount.pl -texdef/texdef.pl -texdiff/texdiff -texdirflatten/texdirflatten -texdoc/texdoc.tlu -texfot/texfot.pl -texlive/fmtutil-sys.sh -texlive/fmtutil-user.sh -texlive/fmtutil.pl -texlive/mktexlsr -texlive/mktexmf -texlive/mktexpk -texlive/mktextfm -texlive/rungs.tlu -texlive/tlmgr.pl -texlive/updmap-sys.sh -texlive/updmap-user.sh -texlive/updmap.pl -texlive-extra/e2pall.pl -texliveonfly/texliveonfly.py -texloganalyser/texloganalyser -texplate/texplate.sh -thumbpdf/thumbpdf.pl -tlcockpit/tlcockpit.sh -tlshell/tlshell.tcl -ulqda/ulqda.pl -urlbst/urlbst -vpe/vpe.pl -webquiz/webquiz.py -xindex/xindex.lua -yplan/yplan +hyperxmp/hyperxmp-add-bytecount.pl context/stubs/unix/context context/stubs/unix/contextjit context/stubs/unix/luatools -- cgit v1.2.3