zeroinstall/helpers.py

   1 """
   2 Convenience routines for performing common operations.
   3 @since: 0.28
   4 """
   5
   6 # Copyright (C) 2009, Thomas Leonard
   7 # See the README file for details, or visit http://0install.net.
   8
   9 import os, sys, logging
  10 from zeroinstall import support
  11 from zeroinstall.support import tasks
  12
  13 def get_selections_gui(iface_uri, gui_args, test_callback = None):
  14         """Run the GUI to choose and download a set of implementations.
  15         The user may ask the GUI to submit a bug report about the program. In that case,
  16         the GUI may ask us to test it. test_callback is called in that case with the implementations
  17         to be tested; the callback will typically call L{zeroinstall.injector.run.test_selections} and return the result of that.
  18         @param iface_uri: the required program, or None to show just the preferences dialog
  19         @type iface_uri: str
  20         @param gui_args: any additional arguments for the GUI itself
  21         @type gui_args: [str]
  22         @param test_callback: function to use to try running the program
  23         @type test_callback: L{zeroinstall.injector.selections.Selections} -> str
  24         @return: the selected implementations
  25         @rtype: L{zeroinstall.injector.selections.Selections}
  26         @since: 0.28
  27         """
  28         from zeroinstall.injector import selections, qdom
  29         from io import BytesIO
  30
  31         from os.path import join, dirname
  32         gui_exe = join(dirname(__file__), '0launch-gui', '0launch-gui')
  33
  34         import socket
  35         cli, gui = socket.socketpair()
  36
  37         try:
  38                 child = os.fork()
  39                 if child == 0:
  40                         # We are the child (GUI)
  41                         try:
  42                                 try:
  43                                         cli.close()
  44                                         # We used to use pipes to support Python2.3...
  45                                         os.dup2(gui.fileno(), 1)
  46                                         os.dup2(gui.fileno(), 0)
  47                                         if iface_uri is not None:
  48                                                 gui_args = gui_args + ['--', iface_uri]
  49                                         os.execvp(sys.executable, [sys.executable, gui_exe] + gui_args)
  50                                 except:
  51                                         import traceback
  52                                         traceback.print_exc(file = sys.stderr)
  53                         finally:
  54                                 sys.stderr.flush()
  55                                 os._exit(1)
  56                 # We are the parent (CLI)
  57                 gui.close()
  58                 gui = None
  59
  60                 while True:
  61                         logging.info("Waiting for selections from GUI...")
  62
  63                         reply = support.read_bytes(cli.fileno(), len('Length:') + 9, null_ok = True)
  64                         if reply:
  65                                 if not reply.startswith(b'Length:'):
  66                                         raise Exception("Expected Length:, but got %s" % repr(reply))
  67                                 reply = reply.decode('ascii')
  68                                 xml = support.read_bytes(cli.fileno(), int(reply.split(':', 1)[1], 16))
  69
  70                                 dom = qdom.parse(BytesIO(xml))
  71                                 sels = selections.Selections(dom)
  72
  73                                 if dom.getAttribute('run-test'):
  74                                         logging.info("Testing program, as requested by GUI...")
  75                                         if test_callback is None:
  76                                                 output = "Can't test: no test_callback was passed to get_selections_gui()\n"
  77                                         else:
  78                                                 output = test_callback(sels)
  79                                         logging.info("Sending results to GUI...")
  80                                         output = ('Length:%8x\n' % len(output)) + output
  81                                         logging.debug("Sending: %s", repr(output))
  82                                         while output:
  83                                                 sent = cli.send(output)
  84                                                 output = output[sent:]
  85                                         continue
  86                         else:
  87                                 sels = None
  88
  89                         pid, status = os.waitpid(child, 0)
  90                         assert pid == child
  91                         if status == 1 << 8:
  92                                 logging.info("User cancelled the GUI; aborting")
  93                                 return None             # Aborted
  94                         if status != 0:
  95                                 raise Exception("Error from GUI: code = %d" % status)
  96                         break
  97         finally:
  98                 for sock in [cli, gui]:
  99                         if sock is not None: sock.close()
 100
 101         return sels
 102
 103 def ensure_cached(uri, command = 'run', config = None):
 104         """Ensure that an implementation of uri is cached.
 105         If not, it downloads one. It uses the GUI if a display is
 106         available, or the console otherwise.
 107         @param uri: the required interface
 108         @type uri: str
 109         @return: the selected implementations, or None if the user cancelled
 110         @rtype: L{zeroinstall.injector.selections.Selections}
 111         """
 112         from zeroinstall.injector.driver import Driver
 113
 114         if config is None:
 115                 from zeroinstall.injector.config import load_config
 116                 config = load_config()
 117
 118         from zeroinstall.injector.requirements import Requirements
 119         requirements = Requirements(uri)
 120         requirements.command = command
 121
 122         d = Driver(config, requirements)
 123
 124         if d.need_download() or not d.solver.ready:
 125                 if os.environ.get('DISPLAY', None):
 126                         return get_selections_gui(uri, ['--command', command])
 127                 else:
 128                         done = d.solve_and_download_impls()
 129                         tasks.wait_for_blocker(done)
 130
 131         return d.solver.selections