Package Gnumed :: Package pycommon :: Module gmShellAPI
[frames] | no frames]

Source Code for Module Gnumed.pycommon.gmShellAPI

  1  __doc__ = """GNUmed general tools.""" 
  2   
  3  #=========================================================================== 
  4  __version__ = "$Revision: 1.13 $" 
  5  __author__ = "K. Hilbert <Karsten.Hilbert@gmx.net>" 
  6  __license__ = "GPL v2 or later (details at http://www.gnu.org)" 
  7   
  8   
  9  # stdlib 
 10  import os 
 11  import sys 
 12  import logging 
 13  import subprocess 
 14  import shlex 
 15   
 16   
 17  _log = logging.getLogger('gm.shell') 
 18  _log.info(__version__) 
 19   
 20  #=========================================================================== 
21 -def is_cmd_in_path(cmd=None):
22 23 _log.debug('cmd: [%s]', cmd) 24 dirname = os.path.dirname(cmd) 25 _log.debug('dir: [%s]', dirname) 26 if dirname != u'': 27 _log.info('command with full or relative path, not searching in PATH for binary') 28 return (None, None) 29 30 env_paths = os.environ['PATH'] 31 _log.debug('${PATH}: %s', env_paths) 32 for path in env_paths.split(os.pathsep): 33 candidate = os.path.join(path, cmd).encode(sys.getfilesystemencoding()) 34 if os.access(candidate, os.X_OK): 35 _log.debug('found [%s]', candidate) 36 return (True, candidate.decode(sys.getfilesystemencoding())) 37 else: 38 _log.debug('not found: %s', candidate) 39 40 _log.debug('command not found in PATH') 41 42 return (False, None)
43 #===========================================================================
44 -def is_executable_by_wine(cmd=None):
45 46 if not cmd.startswith('wine'): 47 _log.debug('not a WINE call: %s', cmd) 48 return (False, None) 49 50 exe_path = cmd.encode(sys.getfilesystemencoding()) 51 52 exe_path = exe_path[4:].strip().strip('"').strip() 53 # [wine "/standard/unix/path/to/binary.exe"] ? 54 if os.access(exe_path, os.R_OK): 55 _log.debug('WINE call with UNIX path: %s', exe_path) 56 return (True, cmd) 57 58 # detect [winepath] 59 found, full_winepath_path = is_cmd_in_path(cmd = r'winepath') 60 if not found: 61 _log.error('[winepath] not found, cannot check WINE call for Windows path conformance: %s', exe_path) 62 return (False, None) 63 64 # [wine "drive:\a\windows\path\to\binary.exe"] ? 65 cmd_line = r'%s -u "%s"' % ( 66 full_winepath_path.encode(sys.getfilesystemencoding()), 67 exe_path 68 ) 69 _log.debug('converting Windows path to UNIX path: %s' % cmd_line) 70 cmd_line = shlex.split(cmd_line) 71 try: 72 winepath = subprocess.Popen ( 73 cmd_line, 74 stdout = subprocess.PIPE, 75 stderr = subprocess.PIPE, 76 universal_newlines = True 77 ) 78 except OSError: 79 _log.exception('cannot run <winepath>') 80 return (False, None) 81 82 stdout, stderr = winepath.communicate() 83 full_path = stdout.strip('\r\n') 84 _log.debug('UNIX path: %s', full_path) 85 86 if winepath.returncode != 0: 87 _log.error('<winepath -u> returned [%s], failed to convert path', winepath.returncode) 88 return (False, None) 89 90 if os.access(full_path, os.R_OK): 91 _log.debug('WINE call with Windows path') 92 return (True, cmd) 93 94 _log.warning('Windows path [%s] not verifiable under UNIX: %s', exe_path, full_path) 95 return (False, None)
96 #===========================================================================
97 -def detect_external_binary(binary=None):
98 _log.debug('searching for [%s]', binary) 99 100 binary = binary.lstrip() 101 102 # is it a sufficiently qualified, directly usable, explicit path ? 103 if os.access(binary, os.X_OK): 104 _log.debug('found: executable explicit path') 105 return (True, binary) 106 107 # can it be found in PATH ? 108 found, full_path = is_cmd_in_path(cmd = binary) 109 if found: 110 if os.access(full_path, os.X_OK): 111 _log.debug('found: executable in ${PATH}') 112 return (True, full_path) 113 114 # does it seem to be a call via WINE ? 115 is_wine_call, full_path = is_executable_by_wine(cmd = binary) 116 if is_wine_call: 117 _log.debug('found: is valid WINE call') 118 return (True, full_path) 119 120 # maybe we can be a bit smart about Windows ? 121 if os.name == 'nt': 122 # try .exe (but not if already .bat or .exe) 123 if not (binary.endswith('.exe') or binary.endswith('.bat')): 124 _log.debug('re-testing with [.exe] appended') 125 exe_binary = binary + r'.exe' 126 found_dot_exe_binary, full_path = detect_external_binary(binary = exe_binary) 127 if found_dot_exe_binary: 128 return (True, full_path) 129 # not found with .exe, so try .bat: 130 _log.debug('re-testing with [.bat] appended') 131 bat_binary = binary + r'.bat' 132 found_bat_binary, full_path = detect_external_binary(binary = bat_binary) 133 if found_bat_binary: 134 return (True, full_path) 135 136 return (False, None)
137 #===========================================================================
138 -def find_first_binary(binaries=None):
139 found = False 140 binary = None 141 142 for cmd in binaries: 143 _log.debug('looking for [%s]', cmd) 144 if cmd is None: 145 continue 146 found, binary = detect_external_binary(binary = cmd) 147 if found: 148 break 149 150 return (found, binary)
151 #===========================================================================
152 -def run_command_in_shell(command=None, blocking=False, acceptable_return_codes=None):
153 """Runs a command in a subshell via standard-C system(). 154 155 <command> 156 The shell command to run including command line options. 157 <blocking> 158 This will make the code *block* until the shell command exits. 159 It will likely only work on UNIX shells where "cmd &" makes sense. 160 """ 161 if acceptable_return_codes is None: 162 acceptable_return_codes = [0] 163 164 _log.debug('shell command >>>%s<<<', command) 165 _log.debug('blocking: %s', blocking) 166 _log.debug('acceptable return codes: %s', str(acceptable_return_codes)) 167 168 # FIXME: command should be checked for shell exploits 169 command = command.strip() 170 171 # what the following hack does is this: the user indicated 172 # whether she wants non-blocking external display of files 173 # - the real way to go about this is to have a non-blocking command 174 # in the line in the mailcap file for the relevant mime types 175 # - as non-blocking may not be desirable when *not* displaying 176 # files from within GNUmed the really right way would be to 177 # add a "test" clause to the non-blocking mailcap entry which 178 # yields true if and only if GNUmed is running 179 # - however, this is cumbersome at best and not supported in 180 # some mailcap implementations 181 # - so we allow the user to attempt some control over the process 182 # from within GNUmed by setting a configuration option 183 # - leaving it None means to use the mailcap default or whatever 184 # was specified in the command itself 185 # - True means: tack " &" onto the shell command if necessary 186 # - False means: remove " &" from the shell command if its there 187 # - all this, of course, only works in shells which support 188 # detaching jobs with " &" (so, most POSIX shells) 189 if blocking is True: 190 if command[-2:] == ' &': 191 command = command[:-2] 192 elif blocking is False: 193 if command[-2:] != ' &': 194 command += ' &' 195 196 _log.info('running shell command >>>%s<<<', command) 197 # FIXME: use subprocess.Popen() 198 ret_val = os.system(command.encode(sys.getfilesystemencoding())) 199 _log.debug('os.system() returned: [%s]', ret_val) 200 201 exited_normally = False 202 203 if not hasattr(os, 'WIFEXITED'): 204 _log.error('platform does not support exit status differentiation') 205 if ret_val in acceptable_return_codes: 206 _log.info('os.system() return value contained in acceptable return codes') 207 _log.info('continuing and hoping for the best') 208 return True 209 return exited_normally 210 211 _log.debug('exited via exit(): %s', os.WIFEXITED(ret_val)) 212 if os.WIFEXITED(ret_val): 213 _log.debug('exit code: [%s]', os.WEXITSTATUS(ret_val)) 214 exited_normally = (os.WEXITSTATUS(ret_val) in acceptable_return_codes) 215 _log.debug('normal exit: %s', exited_normally) 216 _log.debug('dumped core: %s', os.WCOREDUMP(ret_val)) 217 _log.debug('stopped by signal: %s', os.WIFSIGNALED(ret_val)) 218 if os.WIFSIGNALED(ret_val): 219 _log.debug('STOP signal was: [%s]', os.STOPSIG(ret_val)) 220 _log.debug('TERM signal was: [%s]', os.TERMSIG(ret_val)) 221 222 return exited_normally
223 #===========================================================================
224 -def run_first_available_in_shell(binaries=None, args=None, blocking=False, run_last_one_anyway=False, acceptable_return_codes=None):
225 226 found, binary = find_first_binary(binaries = binaries) 227 228 if not found: 229 _log.warning('cannot find any of: %s', binaries) 230 if run_last_one_anyway: 231 binary = binaries[-1] 232 _log.debug('falling back to trying to run [%s] anyway', binary) 233 else: 234 return False 235 236 return run_command_in_shell(command = '%s %s' % (binary, args), blocking = blocking, acceptable_return_codes = acceptable_return_codes)
237 #=========================================================================== 238 # main 239 #--------------------------------------------------------------------------- 240 if __name__ == '__main__': 241 242 if len(sys.argv) < 2: 243 sys.exit() 244 245 if sys.argv[1] != u'test': 246 sys.exit() 247 248 logging.basicConfig(level = logging.DEBUG) 249 #---------------------------------------------------------
250 - def test_detect_external_binary():
251 found, path = detect_external_binary(binary = sys.argv[2]) 252 if found: 253 print "found as:", path 254 else: 255 print sys.argv[2], "not found"
256 #---------------------------------------------------------
257 - def test_run_command_in_shell():
258 print "-------------------------------------" 259 print "running:", sys.argv[2] 260 if run_command_in_shell(command=sys.argv[2], blocking=True): 261 print "-------------------------------------" 262 print "success" 263 else: 264 print "-------------------------------------" 265 print "failure, consult log"
266 #---------------------------------------------------------
267 - def test_is_cmd_in_path():
268 print is_cmd_in_path(cmd = sys.argv[2])
269 #---------------------------------------------------------
270 - def test_is_executable_by_wine():
271 print is_executable_by_wine(cmd = sys.argv[2])
272 #--------------------------------------------------------- 273 #test_run_command_in_shell() 274 test_detect_external_binary() 275 #test_is_cmd_in_path() 276 #test_is_executable_by_wine() 277 278 #=========================================================================== 279