# 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). A zip archive is created only if tar is not
-# found in the path. The tar archive is then compressed with gzip or bzip2.
+# 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
-
-# Replace with the actual path to the 1.5.x or 1.6.x lyx2lyx.
-# If left undefined and the LyX executable is in the path, the script will
-# try to locate lyx2lyx by querying LyX about the system dir.
-# Example for *nix:
-# lyx2lyx = /usr/share/lyx/lyx2lyx/lyx2lyx
-lyx2lyx = None
+from getopt import getopt
# Pre-compiled regular expressions.
re_lyxfile = re.compile("\.lyx$")
re_input = re.compile(r'^(.*)\\(input|include){(\s*)(\S+)(\s*)}.*$')
+re_ertinput = re.compile(r'^(input|include)({)(\s*)(\S+)(\s*)}.*$')
re_package = re.compile(r'^(.*)\\(usepackage){(\s*)(\S+)(\s*)}.*$')
re_class = re.compile(r'^(\\)(textclass)(\s+)(\S+)$')
re_norecur = re.compile(r'^(.*)\\(verbatiminput|lstinputlisting|includegraphics\[*.*\]*){(\s*)(\S+)(\s*)}.*$')
+re_ertnorecur = re.compile(r'^(verbatiminput|lstinputlisting|includegraphics\[*.*\]*)({)(\s*)(\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):
- return "Usage: %s file.lyx [output_dir]\n" % 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):
return newname
-def gather_files(curfile, incfiles):
+def gather_files(curfile, incfiles, lyx2lyx):
" Recursively gather files."
curdir = os.path.dirname(abspath(curfile))
is_lyxfile = re_lyxfile.search(curfile)
lines = input.readlines()
input.close()
+ maybe_in_ert = False
i = 0
while i < len(lines):
# Gather used files.
extlist = ['']
match = re_filename.match(lines[i])
if not match:
- match = re_input.match(lines[i])
+ 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']
match = re_class.match(lines[i])
extlist = ['.cls']
if not match:
- match = re_norecur.match(lines[i])
+ 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
- for ext in extlist:
- if os.path.exists(file + ext):
- file = file + ext
- file_exists = True
- break
- if file_exists:
+ 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)
+ gather_files(file, incfiles, lyx2lyx)
i += 1
continue
return 0
-def main(argv):
+def find_lyx2lyx(progloc):
+ " 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
- if len(argv) < 2 and len(argv) > 3:
- error(usage(argv[0]))
+ # 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
- lyxfile = argv[1]
- if not os.path.exists(lyxfile):
- error('File "%s" not found.' % lyxfile)
+ 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 = ""
- if len(argv) == 3:
- outdir = argv[2]
+ 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)
+ 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')
if not (line and line.startswith('#LyX')):
error('File "%s" is not a LyX document.' % lyxfile)
- # Either tar or zip must be available
- extlist = ['']
- if os.environ.has_key("PATHEXT"):
- extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
- path = string.split(os.environ["PATH"], os.pathsep)
- archiver, full_path = find_exe(["tar", "zip"], extlist, path)
-
- if archiver == "tar":
- ar_cmd = "tar cf"
- ar_name = re_lyxfile.sub(".tar", abspath(lyxfile))
- # Archive will be compressed if either gzip or bzip2 are available
- compress, full_path = find_exe(["gzip", "bzip2"], extlist, path)
- if compress == "gzip":
- ext = ".gz"
- elif compress == "bzip2":
- ext = ".bz2"
- elif archiver == "zip":
- ar_cmd = "zip"
- ar_name = re_lyxfile.sub(".zip", abspath(lyxfile))
- compress = None
+ if makezip:
+ import zipfile
else:
- error("Unable to find either tar or zip.")
+ 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))
- # Try to find the location of the lyx2lyx script
- global lyx2lyx
+ path = string.split(os.environ["PATH"], os.pathsep)
+
if lyx2lyx == None:
- # 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(argv[0]))
- (upone, discard) = os.path.split(ourpath)
- tryit = os.path.join(upone, "lyx2lyx", "lyx2lyx")
- if os.path.exists(tryit):
- lyx2lyx = tryit
- else:
- 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))
- lyx2lyx = os.path.join(basedir, 'Resources', 'lyx2lyx', 'lyx2lyx')
- break
- match = re_sysdir.match(line)
- if match:
- lyx2lyx = os.path.join(match.group(4), 'lyx2lyx', 'lyx2lyx')
- break
- if not os.access(lyx2lyx, os.X_OK):
- error('Unable to find the lyx2lyx script.')
+ lyx2lyx = find_lyx2lyx(ourprog)
# 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)
+ gather_files(lyxfile, incfiles, lyx2lyx)
# Find the topmost dir common to all files
if len(incfiles) > 1:
incfiles = list(set(incfiles))
incfiles.sort()
- # Build the archive command
- ar_cmd = '%s "%s"' % (ar_cmd, ar_name)
- for file in incfiles:
- #print file
- ar_cmd = ar_cmd + ' "' + file + '"'
-
- # Create the archive
if topdir != '':
os.chdir(topdir)
- cmd_status, cmd_stdout = run_cmd(ar_cmd)
- if cmd_status != None:
- error('Failed to create LyX archive "%s"' % ar_name)
- # If possible, compress the archive
- if compress != None:
- compress_cmd = '%s "%s"' % (compress, ar_name)
- cmd_status, cmd_stdout = run_cmd(compress_cmd)
- if cmd_status != None:
- error('Failed to compress LyX archive "%s"' % ar_name)
- ar_name = ar_name + ext
+ # 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
projects / lyx.git / blobdiff