mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-14 15:05:56 +00:00
4f65cfbd5f
Fix bug reported on user list: the path variable here was undefined,
causing a failure when running outside the user tree. This was my
fault: when I refactored this routine, I failed to note that this
variable was now undefined.
(cherry picked from commit 72c2a72afd)
329 lines
10 KiB
Python
Executable File
329 lines
10 KiB
Python
Executable File
#! /usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# file lyxpak.py
|
|
# This file is part of LyX, the document processor.
|
|
# Licence details can be found in the file COPYING.
|
|
|
|
# author Enrico Forestieri
|
|
# author Richard Heck
|
|
|
|
# Full author contact details are available in file CREDITS
|
|
|
|
# This script creates a tar or zip archive with a lyx file and all included
|
|
# files (graphics and so on). By default, the created archive is the standard
|
|
# type on a given platform, such that a zip archive is created on Windows and
|
|
# a gzip compressed tar archive on *nix. This can be controlled by command
|
|
# line options, however.
|
|
|
|
import os, re, string, sys
|
|
if sys.version_info < (2, 4, 0):
|
|
from sets import Set as set
|
|
from getopt import getopt
|
|
|
|
# Pre-compiled regular expressions.
|
|
re_lyxfile = re.compile("\.lyx$")
|
|
re_input = re.compile(r'^(.*)\\(input|include){(\s*)(.+)(\s*)}.*$')
|
|
re_ertinput = re.compile(r'^(input|include)({)(\s*)(.+)(\s*)}.*$')
|
|
re_package = re.compile(r'^(.*)\\(usepackage){(\s*)(.+)(\s*)}.*$')
|
|
re_class = re.compile(r'^(\\)(textclass)(\s+)(.+)\s*$')
|
|
re_norecur = re.compile(r'^(.*)\\(verbatiminput|lstinputlisting|includegraphics\[*.*\]*){(\s*)(.+)(\s*)}.*$')
|
|
re_ertnorecur = re.compile(r'^(verbatiminput|lstinputlisting|includegraphics\[*.*\]*)({)(\s*)(.+)(\s*)}.*$')
|
|
re_filename = re.compile(r'^(\s*)(filename)(\s+)(.+)\s*$')
|
|
re_options = re.compile(r'^(\s*)options(\s+)(.+)\s*$')
|
|
re_bibfiles = re.compile(r'^(\s*)bibfiles(\s+)(.+)\s*$')
|
|
|
|
|
|
def usage(prog_name):
|
|
msg = '''
|
|
Usage: %s [-t] [-z] [-l path] [-o output_dir] file.lyx
|
|
Options:
|
|
-l: Path to lyx2lyx script
|
|
-o: Directory for output
|
|
-t: Create gzipped tar file
|
|
-z: Create zip file
|
|
By default, we create file.zip on Windows and file.tar.gz on *nix,
|
|
with the file output to where file.lyx is, and we look for lyx2lyx
|
|
in the known locations, querying LyX itself if necessary.
|
|
'''
|
|
return msg % prog_name
|
|
|
|
|
|
def error(message):
|
|
sys.stderr.write(message + '\n')
|
|
sys.exit(1)
|
|
|
|
|
|
def run_cmd(cmd):
|
|
handle = os.popen(cmd, 'r')
|
|
cmd_stdout = handle.read()
|
|
cmd_status = handle.close()
|
|
return cmd_status, cmd_stdout
|
|
|
|
|
|
def find_exe(candidates, extlist, path):
|
|
for prog in candidates:
|
|
for directory in path:
|
|
for ext in extlist:
|
|
full_path = os.path.join(directory, prog + ext)
|
|
if os.access(full_path, os.X_OK):
|
|
return prog, full_path
|
|
return None, None
|
|
|
|
|
|
def abspath(name):
|
|
" Resolve symlinks and returns the absolute normalized name."
|
|
newname = os.path.normpath(os.path.abspath(name))
|
|
if os.name != 'nt':
|
|
newname = os.path.realpath(newname)
|
|
return newname
|
|
|
|
|
|
def gather_files(curfile, incfiles, lyx2lyx):
|
|
" Recursively gather files."
|
|
curdir = os.path.dirname(abspath(curfile))
|
|
is_lyxfile = re_lyxfile.search(curfile)
|
|
if is_lyxfile:
|
|
lyx2lyx_cmd = 'python "%s" "%s"' % (lyx2lyx, curfile)
|
|
l2l_status, l2l_stdout = run_cmd(lyx2lyx_cmd)
|
|
if l2l_status != None:
|
|
error('%s failed to convert "%s"' % (lyx2lyx, curfile))
|
|
lines = l2l_stdout.splitlines()
|
|
else:
|
|
input = open(curfile, 'rU')
|
|
lines = input.readlines()
|
|
input.close()
|
|
|
|
maybe_in_ert = False
|
|
i = 0
|
|
while i < len(lines):
|
|
# Gather used files.
|
|
recursive = True
|
|
extlist = ['']
|
|
match = re_filename.match(lines[i])
|
|
if not match:
|
|
if maybe_in_ert:
|
|
match = re_ertinput.match(lines[i])
|
|
else:
|
|
match = re_input.match(lines[i])
|
|
if not match:
|
|
match = re_package.match(lines[i])
|
|
extlist = ['.sty']
|
|
if not match:
|
|
match = re_class.match(lines[i])
|
|
extlist = ['.cls']
|
|
if not match:
|
|
if maybe_in_ert:
|
|
match = re_ertnorecur.match(lines[i])
|
|
else:
|
|
match = re_norecur.match(lines[i])
|
|
extlist = ['', '.eps', '.pdf', '.png', '.jpg']
|
|
recursive = False
|
|
maybe_in_ert = is_lyxfile and lines[i] == "\\backslash"
|
|
if match:
|
|
file = match.group(4).strip('"')
|
|
if not os.path.isabs(file):
|
|
file = os.path.join(curdir, file)
|
|
file_exists = False
|
|
if not os.path.isdir(file):
|
|
for ext in extlist:
|
|
if os.path.exists(file + ext):
|
|
file = file + ext
|
|
file_exists = True
|
|
break
|
|
if file_exists and not abspath(file) in incfiles:
|
|
incfiles.append(abspath(file))
|
|
if recursive:
|
|
gather_files(file, incfiles, lyx2lyx)
|
|
i += 1
|
|
continue
|
|
|
|
if not is_lyxfile:
|
|
i += 1
|
|
continue
|
|
|
|
# Gather bibtex *.bst files.
|
|
match = re_options.match(lines[i])
|
|
if match:
|
|
file = match.group(3).strip('"')
|
|
if not os.path.isabs(file):
|
|
file = os.path.join(curdir, file + '.bst')
|
|
if os.path.exists(file):
|
|
incfiles.append(abspath(file))
|
|
i += 1
|
|
continue
|
|
|
|
# Gather bibtex *.bib files.
|
|
match = re_bibfiles.match(lines[i])
|
|
if match:
|
|
bibfiles = match.group(3).strip('"').split(',')
|
|
j = 0
|
|
while j < len(bibfiles):
|
|
if os.path.isabs(bibfiles[j]):
|
|
file = bibfiles[j] + '.bib'
|
|
else:
|
|
file = os.path.join(curdir, bibfiles[j] + '.bib')
|
|
if os.path.exists(file):
|
|
incfiles.append(abspath(file))
|
|
j += 1
|
|
i += 1
|
|
continue
|
|
|
|
i += 1
|
|
|
|
return 0
|
|
|
|
|
|
def find_lyx2lyx(progloc, path):
|
|
" Find a usable version of the lyx2lyx script. "
|
|
# first we will see if the script is roughly where we are
|
|
# i.e., we will assume we are in $SOMEDIR/scripts and look
|
|
# for $SOMEDIR/lyx2lyx/lyx2lyx.
|
|
ourpath = os.path.dirname(abspath(progloc))
|
|
(upone, discard) = os.path.split(ourpath)
|
|
tryit = os.path.join(upone, "lyx2lyx", "lyx2lyx")
|
|
if os.access(tryit, os.X_OK):
|
|
return tryit
|
|
|
|
# now we will try to query LyX itself to find the path.
|
|
extlist = ['']
|
|
if "PATHEXT" in os.environ:
|
|
extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
|
|
lyx_exe, full_path = find_exe(["lyxc", "lyx"], extlist, path)
|
|
if lyx_exe == None:
|
|
error('Cannot find the LyX executable in the path.')
|
|
cmd_status, cmd_stdout = run_cmd("%s -version 2>&1" % lyx_exe)
|
|
if cmd_status != None:
|
|
error('Cannot query LyX about the lyx2lyx script.')
|
|
re_msvc = re.compile(r'^(\s*)(Host type:)(\s+)(win32)$')
|
|
re_sysdir = re.compile(r'^(\s*)(LyX files dir:)(\s+)(\S+)$')
|
|
lines = cmd_stdout.splitlines()
|
|
for line in lines:
|
|
match = re_msvc.match(line)
|
|
if match:
|
|
# The LyX executable was built with MSVC, so the
|
|
# "LyX files dir:" line is unusable
|
|
basedir = os.path.dirname(os.path.dirname(full_path))
|
|
tryit = os.path.join(basedir, 'Resources', 'lyx2lyx', 'lyx2lyx')
|
|
break
|
|
match = re_sysdir.match(line)
|
|
if match:
|
|
tryit = os.path.join(match.group(4), 'lyx2lyx', 'lyx2lyx')
|
|
break
|
|
|
|
if not os.access(tryit, os.X_OK):
|
|
error('Unable to find the lyx2lyx script.')
|
|
return tryit
|
|
|
|
|
|
def main(args):
|
|
|
|
ourprog = args[0]
|
|
|
|
try:
|
|
(options, argv) = getopt(args[1:], "htzl:o:")
|
|
except:
|
|
error(usage(ourprog))
|
|
|
|
# we expect the filename to be left
|
|
if len(argv) != 1:
|
|
error(usage(ourprog))
|
|
|
|
makezip = (os.name == 'nt')
|
|
outdir = ""
|
|
lyx2lyx = None
|
|
|
|
for (opt, param) in options:
|
|
if opt == "-h":
|
|
print usage(ourprog)
|
|
sys.exit(0)
|
|
elif opt == "-t":
|
|
makezip = False
|
|
elif opt == "-z":
|
|
makezip = True
|
|
elif opt == "-l":
|
|
lyx2lyx = param
|
|
elif opt == "-o":
|
|
outdir = param
|
|
if not os.path.isdir(outdir):
|
|
error('Error: "%s" is not a directory.' % outdir)
|
|
|
|
lyxfile = argv[0]
|
|
if not os.path.exists(lyxfile):
|
|
error('File "%s" not found.' % lyxfile)
|
|
|
|
# Check that it actually is a LyX document
|
|
input = open(lyxfile, 'rU')
|
|
line = input.readline()
|
|
input.close()
|
|
if not (line and line.startswith('#LyX')):
|
|
error('File "%s" is not a LyX document.' % lyxfile)
|
|
|
|
if makezip:
|
|
import zipfile
|
|
else:
|
|
import tarfile
|
|
|
|
ar_ext = ".tar.gz"
|
|
if makezip:
|
|
ar_ext = ".zip"
|
|
|
|
ar_name = re_lyxfile.sub(ar_ext, abspath(lyxfile))
|
|
if outdir:
|
|
ar_name = os.path.join(abspath(outdir), os.path.basename(ar_name))
|
|
|
|
path = string.split(os.environ["PATH"], os.pathsep)
|
|
|
|
if lyx2lyx == None:
|
|
lyx2lyx = find_lyx2lyx(ourprog, path)
|
|
|
|
# Initialize the list with the specified LyX file and recursively
|
|
# gather all required files (also from child documents).
|
|
incfiles = [abspath(lyxfile)]
|
|
gather_files(lyxfile, incfiles, lyx2lyx)
|
|
|
|
# Find the topmost dir common to all files
|
|
if len(incfiles) > 1:
|
|
topdir = os.path.commonprefix(incfiles)
|
|
# Check whether topdir is valid, as os.path.commonprefix() works on
|
|
# a character by character basis, rather than on path elements.
|
|
if not os.path.exists(topdir):
|
|
topdir = os.path.dirname(topdir) + os.path.sep
|
|
else:
|
|
topdir = os.path.dirname(incfiles[0]) + os.path.sep
|
|
|
|
# Remove the prefix common to all paths in the list
|
|
i = 0
|
|
while i < len(incfiles):
|
|
incfiles[i] = string.replace(incfiles[i], topdir, '', 1)
|
|
i += 1
|
|
|
|
# Remove duplicates and sort the list
|
|
incfiles = list(set(incfiles))
|
|
incfiles.sort()
|
|
|
|
if topdir != '':
|
|
os.chdir(topdir)
|
|
|
|
# Create the archive
|
|
try:
|
|
if makezip:
|
|
zip = zipfile.ZipFile(ar_name, "w", zipfile.ZIP_DEFLATED)
|
|
for file in incfiles:
|
|
zip.write(file)
|
|
zip.close()
|
|
else:
|
|
tar = tarfile.open(ar_name, "w:gz")
|
|
for file in incfiles:
|
|
tar.add(file)
|
|
tar.close()
|
|
except:
|
|
error('Failed to create LyX archive "%s"' % ar_name)
|
|
|
|
print 'LyX archive "%s" created successfully.' % ar_name
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main(sys.argv)
|