lib/scripts/lyxpak.py

   1 #! /usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 # file lyxpak.py
   5 # This file is part of LyX, the document processor.
   6 # Licence details can be found in the file COPYING.
   7
   8 # author Enrico Forestieri
   9 # author Richard Heck
  10
  11 # Full author contact details are available in file CREDITS
  12
  13 # This script creates a tar or zip archive with a lyx file and all included
  14 # files (graphics and so on). By default, the created archive is the standard
  15 # type on a given platform, such that a zip archive is created on Windows and
  16 # a gzip compressed tar archive on *nix. This can be controlled by command
  17 # line options, however.
  18
  19 import os, re, string, sys
  20 if sys.version_info < (2, 4, 0):
  21     from sets import Set as set
  22 from getopt import getopt
  23
  24 # Pre-compiled regular expressions.
  25 re_lyxfile = re.compile("\.lyx$")
  26 re_input = re.compile(r'^(.*)\\(input|include){(\s*)(\S+)(\s*)}.*$')
  27 re_package = re.compile(r'^(.*)\\(usepackage){(\s*)(\S+)(\s*)}.*$')
  28 re_class = re.compile(r'^(\\)(textclass)(\s+)(\S+)$')
  29 re_norecur = re.compile(r'^(.*)\\(verbatiminput|lstinputlisting|includegraphics\[*.*\]*){(\s*)(\S+)(\s*)}.*$')
  30 re_filename = re.compile(r'^(\s*)(filename)(\s+)(\S+)$')
  31 re_options = re.compile(r'^(\s*)options(\s+)(\S+)$')
  32 re_bibfiles = re.compile(r'^(\s*)bibfiles(\s+)(\S+)$')
  33
  34
  35 def usage(prog_name):
  36     msg = '''
  37 Usage: %s [-t] [-z] [-l path] [-o output_dir] file.lyx
  38 Options:
  39 -l: Path to lyx2lyx script
  40 -o: Directory for output
  41 -t: Create gzipped tar file
  42 -z: Create zip file
  43 By default, we create file.zip on Windows and file.tar.gz on *nix,
  44 with the file output to where file.lyx is, and we look for lyx2lyx
  45 in the known locations, querying LyX itself if necessary.
  46 '''
  47     return msg % prog_name
  48
  49
  50 def error(message):
  51     sys.stderr.write(message + '\n')
  52     sys.exit(1)
  53
  54
  55 def run_cmd(cmd):
  56     handle = os.popen(cmd, 'r')
  57     cmd_stdout = handle.read()
  58     cmd_status = handle.close()
  59     return cmd_status, cmd_stdout
  60
  61
  62 def find_exe(candidates, extlist, path):
  63     for prog in candidates:
  64         for directory in path:
  65             for ext in extlist:
  66                 full_path = os.path.join(directory, prog + ext)
  67                 if os.access(full_path, os.X_OK):
  68                     return prog, full_path
  69     return None, None
  70
  71
  72 def abspath(name):
  73     " Resolve symlinks and returns the absolute normalized name."
  74     newname = os.path.normpath(os.path.abspath(name))
  75     if os.name != 'nt':
  76         newname = os.path.realpath(newname)
  77     return newname
  78
  79
  80 def gather_files(curfile, incfiles, lyx2lyx):
  81     " Recursively gather files."
  82     curdir = os.path.dirname(abspath(curfile))
  83     is_lyxfile = re_lyxfile.search(curfile)
  84     if is_lyxfile:
  85         lyx2lyx_cmd = 'python "%s" "%s"' % (lyx2lyx, curfile)
  86         l2l_status, l2l_stdout = run_cmd(lyx2lyx_cmd)
  87         if l2l_status != None:
  88             error('%s failed to convert "%s"' % (lyx2lyx, curfile))
  89         lines = l2l_stdout.splitlines()
  90     else:
  91         input = open(curfile, 'rU')
  92         lines = input.readlines()
  93         input.close()
  94
  95     i = 0
  96     while i < len(lines):
  97         # Gather used files.
  98         recursive = True
  99         extlist = ['']
 100         match = re_filename.match(lines[i])
 101         if not match:
 102             match = re_input.match(lines[i])
 103             if not match:
 104                 match = re_package.match(lines[i])
 105                 extlist = ['.sty']
 106                 if not match:
 107                     match = re_class.match(lines[i])
 108                     extlist = ['.cls']
 109                     if not match:
 110                         match = re_norecur.match(lines[i])
 111                         extlist = ['', '.eps', '.pdf', '.png', '.jpg']
 112                         recursive = False
 113         if match:
 114             file = match.group(4).strip('"')
 115             if not os.path.isabs(file):
 116                 file = os.path.join(curdir, file)
 117             file_exists = False
 118             for ext in extlist:
 119                 if os.path.exists(file + ext):
 120                     file = file + ext
 121                     file_exists = True
 122                     break
 123             if file_exists:
 124                 incfiles.append(abspath(file))
 125                 if recursive:
 126                     gather_files(file, incfiles, lyx2lyx)
 127             i += 1
 128             continue
 129
 130         if not is_lyxfile:
 131             i += 1
 132             continue
 133
 134         # Gather bibtex *.bst files.
 135         match = re_options.match(lines[i])
 136         if match:
 137             file = match.group(3).strip('"')
 138             if not os.path.isabs(file):
 139                 file = os.path.join(curdir, file + '.bst')
 140             if os.path.exists(file):
 141                 incfiles.append(abspath(file))
 142             i += 1
 143             continue
 144
 145         # Gather bibtex *.bib files.
 146         match = re_bibfiles.match(lines[i])
 147         if match:
 148             bibfiles = match.group(3).strip('"').split(',')
 149             j = 0
 150             while j < len(bibfiles):
 151                 if os.path.isabs(bibfiles[j]):
 152                     file = bibfiles[j]
 153                 else:
 154                     file = os.path.join(curdir, bibfiles[j] + '.bib')
 155                 if os.path.exists(file):
 156                     incfiles.append(abspath(file))
 157                 j += 1
 158             i += 1
 159             continue
 160
 161         i += 1
 162
 163     return 0
 164
 165
 166 def find_lyx2lyx(progloc):
 167     " Find a usable version of the lyx2lyx script. "
 168     # first we will see if the script is roughly where we are
 169     # i.e., we will assume we are in $SOMEDIR/scripts and look
 170     # for $SOMEDIR/lyx2lyx/lyx2lyx.
 171     ourpath = os.path.dirname(abspath(progloc))
 172     (upone, discard) = os.path.split(ourpath)
 173     tryit = os.path.join(upone, "lyx2lyx", "lyx2lyx")
 174     if os.access(tryit, os.X_OK):
 175         return tryit
 176
 177     # now we will try to query LyX itself to find the path.
 178     extlist = ['']
 179     if "PATHEXT" in os.environ:
 180         extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
 181     lyx_exe, full_path = find_exe(["lyxc", "lyx"], extlist, path)
 182     if lyx_exe == None:
 183         error('Cannot find the LyX executable in the path.')
 184     cmd_status, cmd_stdout = run_cmd("%s -version 2>&1" % lyx_exe)
 185     if cmd_status != None:
 186         error('Cannot query LyX about the lyx2lyx script.')
 187     re_msvc = re.compile(r'^(\s*)(Host type:)(\s+)(win32)$')
 188     re_sysdir = re.compile(r'^(\s*)(LyX files dir:)(\s+)(\S+)$')
 189     lines = cmd_stdout.splitlines()
 190     for line in lines:
 191         match = re_msvc.match(line)
 192         if match:
 193             # The LyX executable was built with MSVC, so the
 194             # "LyX files dir:" line is unusable
 195             basedir = os.path.dirname(os.path.dirname(full_path))
 196             tryit = os.path.join(basedir, 'Resources', 'lyx2lyx', 'lyx2lyx')
 197             break
 198         match = re_sysdir.match(line)
 199         if match:
 200             tryit = os.path.join(match.group(4), 'lyx2lyx', 'lyx2lyx')
 201             break
 202
 203     if not os.access(tryit, os.X_OK):
 204         error('Unable to find the lyx2lyx script.')
 205     return tryit
 206
 207
 208 def main(args):
 209
 210     ourprog = args[0]
 211
 212     try:
 213       (options, argv) = getopt(args[1:], "htzl:o:")
 214     except:
 215       error(usage(ourprog))
 216
 217     # we expect the filename to be left
 218     if len(argv) != 1:
 219         error(usage(ourprog))
 220
 221     makezip = (os.name == 'nt')
 222     outdir = ""
 223     lyx2lyx = None
 224
 225     for (opt, param) in options:
 226       if opt == "-h":
 227         print usage(ourprog)
 228         sys.exit(0)
 229       elif opt == "-t":
 230         makezip = False
 231       elif opt == "-z":
 232         makezip = True
 233       elif opt == "-l":
 234         lyx2lyx = param
 235       elif opt == "-o":
 236         outdir = param
 237         if not os.path.isdir(outdir):
 238           error('Error: "%s" is not a directory.' % outdir)
 239
 240     lyxfile = argv[0]
 241     if not os.path.exists(lyxfile):
 242         error('File "%s" not found.' % lyxfile)
 243
 244     # Check that it actually is a LyX document
 245     input = open(lyxfile, 'rU')
 246     line = input.readline()
 247     input.close()
 248     if not (line and line.startswith('#LyX')):
 249         error('File "%s" is not a LyX document.' % lyxfile)
 250
 251     if makezip:
 252         import zipfile
 253     else:
 254         import tarfile
 255
 256     ar_ext = ".tar.gz"
 257     if makezip:
 258         ar_ext = ".zip"
 259
 260     ar_name = re_lyxfile.sub(ar_ext, abspath(lyxfile))
 261     if outdir:
 262         ar_name = os.path.join(abspath(outdir), os.path.basename(ar_name))
 263
 264     path = string.split(os.environ["PATH"], os.pathsep)
 265
 266     if lyx2lyx == None:
 267         lyx2lyx = find_lyx2lyx(ourprog)
 268
 269     # Initialize the list with the specified LyX file and recursively
 270     # gather all required files (also from child documents).
 271     incfiles = [abspath(lyxfile)]
 272     gather_files(lyxfile, incfiles, lyx2lyx)
 273
 274     # Find the topmost dir common to all files
 275     if len(incfiles) > 1:
 276         topdir = os.path.commonprefix(incfiles)
 277     else:
 278         topdir = os.path.dirname(incfiles[0]) + os.path.sep
 279
 280     # Remove the prefix common to all paths in the list
 281     i = 0
 282     while i < len(incfiles):
 283         incfiles[i] = string.replace(incfiles[i], topdir, '', 1)
 284         i += 1
 285
 286     # Remove duplicates and sort the list
 287     incfiles = list(set(incfiles))
 288     incfiles.sort()
 289
 290     if topdir != '':
 291         os.chdir(topdir)
 292
 293     # Create the archive
 294     try:
 295         if os.name == 'nt':
 296             zip = zipfile.ZipFile(ar_name, "w", zipfile.ZIP_DEFLATED)
 297             for file in incfiles:
 298                 zip.write(file)
 299             zip.close()
 300         else:
 301             tar = tarfile.open(ar_name, "w:gz")
 302             for file in incfiles:
 303                 tar.add(file)
 304             tar.close()
 305     except:
 306         error('Failed to create LyX archive "%s"' % ar_name)
 307
 308     print 'LyX archive "%s" created successfully.' % ar_name
 309     return 0
 310
 311
 312 if __name__ == "__main__":
 313     main(sys.argv)