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             if not os.path.isdir(file):
 119                 for ext in extlist:
 120                     if os.path.exists(file + ext):
 121                         file = file + ext
 122                         file_exists = True
 123                         break
 124             if file_exists and not abspath(file) in incfiles:
 125                 incfiles.append(abspath(file))
 126                 if recursive:
 127                     gather_files(file, incfiles, lyx2lyx)
 128             i += 1
 129             continue
 130
 131         if not is_lyxfile:
 132             i += 1
 133             continue
 134
 135         # Gather bibtex *.bst files.
 136         match = re_options.match(lines[i])
 137         if match:
 138             file = match.group(3).strip('"')
 139             if not os.path.isabs(file):
 140                 file = os.path.join(curdir, file + '.bst')
 141             if os.path.exists(file):
 142                 incfiles.append(abspath(file))
 143             i += 1
 144             continue
 145
 146         # Gather bibtex *.bib files.
 147         match = re_bibfiles.match(lines[i])
 148         if match:
 149             bibfiles = match.group(3).strip('"').split(',')
 150             j = 0
 151             while j < len(bibfiles):
 152                 if os.path.isabs(bibfiles[j]):
 153                     file = bibfiles[j]
 154                 else:
 155                     file = os.path.join(curdir, bibfiles[j] + '.bib')
 156                 if os.path.exists(file):
 157                     incfiles.append(abspath(file))
 158                 j += 1
 159             i += 1
 160             continue
 161
 162         i += 1
 163
 164     return 0
 165
 166
 167 def find_lyx2lyx(progloc):
 168     " Find a usable version of the lyx2lyx script. "
 169     # first we will see if the script is roughly where we are
 170     # i.e., we will assume we are in $SOMEDIR/scripts and look
 171     # for $SOMEDIR/lyx2lyx/lyx2lyx.
 172     ourpath = os.path.dirname(abspath(progloc))
 173     (upone, discard) = os.path.split(ourpath)
 174     tryit = os.path.join(upone, "lyx2lyx", "lyx2lyx")
 175     if os.access(tryit, os.X_OK):
 176         return tryit
 177
 178     # now we will try to query LyX itself to find the path.
 179     extlist = ['']
 180     if "PATHEXT" in os.environ:
 181         extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
 182     lyx_exe, full_path = find_exe(["lyxc", "lyx"], extlist, path)
 183     if lyx_exe == None:
 184         error('Cannot find the LyX executable in the path.')
 185     cmd_status, cmd_stdout = run_cmd("%s -version 2>&1" % lyx_exe)
 186     if cmd_status != None:
 187         error('Cannot query LyX about the lyx2lyx script.')
 188     re_msvc = re.compile(r'^(\s*)(Host type:)(\s+)(win32)$')
 189     re_sysdir = re.compile(r'^(\s*)(LyX files dir:)(\s+)(\S+)$')
 190     lines = cmd_stdout.splitlines()
 191     for line in lines:
 192         match = re_msvc.match(line)
 193         if match:
 194             # The LyX executable was built with MSVC, so the
 195             # "LyX files dir:" line is unusable
 196             basedir = os.path.dirname(os.path.dirname(full_path))
 197             tryit = os.path.join(basedir, 'Resources', 'lyx2lyx', 'lyx2lyx')
 198             break
 199         match = re_sysdir.match(line)
 200         if match:
 201             tryit = os.path.join(match.group(4), 'lyx2lyx', 'lyx2lyx')
 202             break
 203
 204     if not os.access(tryit, os.X_OK):
 205         error('Unable to find the lyx2lyx script.')
 206     return tryit
 207
 208
 209 def main(args):
 210
 211     ourprog = args[0]
 212
 213     try:
 214       (options, argv) = getopt(args[1:], "htzl:o:")
 215     except:
 216       error(usage(ourprog))
 217
 218     # we expect the filename to be left
 219     if len(argv) != 1:
 220         error(usage(ourprog))
 221
 222     makezip = (os.name == 'nt')
 223     outdir = ""
 224     lyx2lyx = None
 225
 226     for (opt, param) in options:
 227       if opt == "-h":
 228         print usage(ourprog)
 229         sys.exit(0)
 230       elif opt == "-t":
 231         makezip = False
 232       elif opt == "-z":
 233         makezip = True
 234       elif opt == "-l":
 235         lyx2lyx = param
 236       elif opt == "-o":
 237         outdir = param
 238         if not os.path.isdir(outdir):
 239           error('Error: "%s" is not a directory.' % outdir)
 240
 241     lyxfile = argv[0]
 242     if not os.path.exists(lyxfile):
 243         error('File "%s" not found.' % lyxfile)
 244
 245     # Check that it actually is a LyX document
 246     input = open(lyxfile, 'rU')
 247     line = input.readline()
 248     input.close()
 249     if not (line and line.startswith('#LyX')):
 250         error('File "%s" is not a LyX document.' % lyxfile)
 251
 252     if makezip:
 253         import zipfile
 254     else:
 255         import tarfile
 256
 257     ar_ext = ".tar.gz"
 258     if makezip:
 259         ar_ext = ".zip"
 260
 261     ar_name = re_lyxfile.sub(ar_ext, abspath(lyxfile))
 262     if outdir:
 263         ar_name = os.path.join(abspath(outdir), os.path.basename(ar_name))
 264
 265     path = string.split(os.environ["PATH"], os.pathsep)
 266
 267     if lyx2lyx == None:
 268         lyx2lyx = find_lyx2lyx(ourprog)
 269
 270     # Initialize the list with the specified LyX file and recursively
 271     # gather all required files (also from child documents).
 272     incfiles = [abspath(lyxfile)]
 273     gather_files(lyxfile, incfiles, lyx2lyx)
 274
 275     # Find the topmost dir common to all files
 276     if len(incfiles) > 1:
 277         topdir = os.path.commonprefix(incfiles)
 278     else:
 279         topdir = os.path.dirname(incfiles[0]) + os.path.sep
 280
 281     # Remove the prefix common to all paths in the list
 282     i = 0
 283     while i < len(incfiles):
 284         incfiles[i] = string.replace(incfiles[i], topdir, '', 1)
 285         i += 1
 286
 287     # Remove duplicates and sort the list
 288     incfiles = list(set(incfiles))
 289     incfiles.sort()
 290
 291     if topdir != '':
 292         os.chdir(topdir)
 293
 294     # Create the archive
 295     try:
 296         if makezip:
 297             zip = zipfile.ZipFile(ar_name, "w", zipfile.ZIP_DEFLATED)
 298             for file in incfiles:
 299                 zip.write(file)
 300             zip.close()
 301         else:
 302             tar = tarfile.open(ar_name, "w:gz")
 303             for file in incfiles:
 304                 tar.add(file)
 305             tar.close()
 306     except:
 307         error('Failed to create LyX archive "%s"' % ar_name)
 308
 309     print 'LyX archive "%s" created successfully.' % ar_name
 310     return 0
 311
 312
 313 if __name__ == "__main__":
 314     main(sys.argv)