lib/scripts/lyxpreview_tools.py

   1 #! /usr/bin/env python
   2
   3 # file lyxpreview_tools.py
   4 # This file is part of LyX, the document processor.
   5 # Licence details can be found in the file COPYING.
   6
   7 # author Angus Leeming
   8 # Full author contact details are available in file CREDITS
   9
  10 # and with much help testing the code under Windows from
  11 #   Paul A. Rubin, rubin@msu.edu.
  12
  13 # A repository of the following functions, used by the lyxpreview2xyz scripts.
  14 # copyfileobj, error, find_exe, find_exe_or_terminate, mkstemp,
  15 # run_command, warning
  16
  17 import os, re, string, sys, tempfile
  18
  19 use_win32_modules = 0
  20 if os.name == "nt":
  21     use_win32_modules = 1
  22     try:
  23         import pywintypes
  24         import win32con
  25         import win32event
  26         import win32file
  27         import win32pipe
  28         import win32process
  29         import win32security
  30         import winerror
  31     except:
  32         sys.stderr.write("Consider installing the PyWin extension modules "\
  33                          "if you're irritated by windows appearing briefly.\n")
  34         use_win32_modules = 0
  35
  36
  37 def warning(message):
  38     sys.stderr.write(message + '\n')
  39
  40
  41 def error(message):
  42     sys.stderr.write(message + '\n')
  43     sys.exit(1)
  44
  45
  46 def find_exe(candidates, path):
  47     for prog in candidates:
  48         for directory in path:
  49             if os.name == "nt":
  50                 full_path = os.path.join(directory, prog + ".exe")
  51             else:
  52                 full_path = os.path.join(directory, prog)
  53
  54             if os.access(full_path, os.X_OK):
  55                 return full_path
  56
  57     return None
  58
  59
  60 def find_exe_or_terminate(candidates, path):
  61     exe = find_exe(candidates, path)
  62     if exe == None:
  63         error("Unable to find executable from '%s'" % string.join(candidates))
  64
  65     return exe
  66
  67
  68 def run_command_popen(cmd):
  69     handle = os.popen(cmd, 'r')
  70     cmd_stdout = handle.read()
  71     cmd_status = handle.close()
  72
  73     return cmd_status, cmd_stdout
  74
  75
  76 def run_command_win32(cmd):
  77     sa = win32security.SECURITY_ATTRIBUTES()
  78     sa.bInheritHandle = True
  79     stdout_r, stdout_w = win32pipe.CreatePipe(sa, 0)
  80
  81     si = win32process.STARTUPINFO()
  82     si.dwFlags = (win32process.STARTF_USESTDHANDLES
  83                   | win32process.STARTF_USESHOWWINDOW)
  84     si.wShowWindow = win32con.SW_HIDE
  85     si.hStdOutput = stdout_w
  86
  87     process, thread, pid, tid = \
  88              win32process.CreateProcess(None, cmd, None, None, True,
  89                                         0, None, None, si)
  90     if process == None:
  91         return -1, ""
  92
  93     # Must close the write handle in this process, or ReadFile will hang.
  94     stdout_w.Close()
  95
  96     # Read the pipe until we get an error (including ERROR_BROKEN_PIPE,
  97     # which is okay because it happens when child process ends).
  98     data = ""
  99     error = 0
 100     while 1:
 101         try:
 102             hr, buffer = win32file.ReadFile(stdout_r, 4096)
 103             if hr != winerror.ERROR_IO_PENDING:
 104                 data = data + buffer
 105
 106         except pywintypes.error, e:
 107             if e.args[0] != winerror.ERROR_BROKEN_PIPE:
 108                 error = 1
 109             break
 110
 111     if error:
 112         return -2, ""
 113
 114     # Everything is okay --- the called process has closed the pipe.
 115     # For safety, check that the process ended, then pick up its exit code.
 116     win32event.WaitForSingleObject(process, win32event.INFINITE)
 117     if win32process.GetExitCodeProcess(process):
 118         return -3, ""
 119
 120     return None, data
 121
 122
 123 def run_command(cmd):
 124     if use_win32_modules:
 125         return run_command_win32(cmd)
 126     else:
 127         return run_command_popen(cmd)
 128
 129
 130 def get_version_info():
 131     version_re = re.compile("([0-9])\.([0-9])")
 132
 133     match = version_re.match(sys.version)
 134     if match == None:
 135         error("Unable to extract version info from 'sys.version'")
 136
 137     return string.atoi(match.group(1)), string.atoi(match.group(2))
 138
 139
 140 def copyfileobj(fsrc, fdst, rewind=0, length=16*1024):
 141     """copy data from file-like object fsrc to file-like object fdst"""
 142     if rewind:
 143         fsrc.flush()
 144         fsrc.seek(0)
 145
 146     while 1:
 147         buf = fsrc.read(length)
 148         if not buf:
 149             break
 150         fdst.write(buf)
 151
 152
 153 class TempFile:
 154     """clone of tempfile.TemporaryFile to use with python < 2.0."""
 155     # Cache the unlinker so we don't get spurious errors at shutdown
 156     # when the module-level "os" is None'd out.  Note that this must
 157     # be referenced as self.unlink, because the name TempFile
 158     # may also get None'd out before __del__ is called.
 159     unlink = os.unlink
 160
 161     def __init__(self):
 162         self.filename = tempfile.mktemp()
 163         self.file = open(self.filename,"w+b")
 164         self.close_called = 0
 165
 166     def close(self):
 167         if not self.close_called:
 168             self.close_called = 1
 169             self.file.close()
 170             self.unlink(self.filename)
 171
 172     def __del__(self):
 173         self.close()
 174
 175     def read(self, size = -1):
 176         return self.file.read(size)
 177
 178     def write(self, line):
 179         return self.file.write(line)
 180
 181     def seek(self, offset):
 182         return self.file.seek(offset)
 183
 184     def flush(self):
 185         return self.file.flush()
 186
 187
 188 def mkstemp():
 189     """create a secure temporary file and return its object-like file"""
 190     major, minor = get_version_info()
 191
 192     if major >= 2 and minor >= 0:
 193         return tempfile.TemporaryFile()
 194     else:
 195         return TempFile()