autocompile.py

   1 # Copyright (C) 2009, Thomas Leonard
   2 # See http://0install.net/0compile.html
   3
   4 import sys, os, __main__, tempfile, subprocess, signal
   5 from xml.dom import minidom
   6 from optparse import OptionParser
   7
   8 from zeroinstall import SafeException
   9 from zeroinstall.injector import arch, handler, policy, model, iface_cache, selections, namespaces, writer, reader
  10 from zeroinstall.zerostore import manifest, NotStored
  11 from zeroinstall.support import tasks, basedir, ro_rmtree
  12
  13 from support import BuildEnv
  14
  15 # This is a bit hacky...
  16 #
  17 # We invent a new CPU type which is compatible with the host but worse than
  18 # every existing type, and we use * for the OS type so that we don't beat 'Any'
  19 # binaries either. This means that we always prefer an existing binary of the
  20 # desired version to compiling a new one, but we'll compile a new version from source
  21 # rather than use an older binary.
  22 arch.machine_groups['newbuild'] = arch.machine_groups.get(arch._uname[-1], 0)
  23 arch.machine_ranks['newbuild'] = max(arch.machine_ranks.values()) + 1
  24 host_arch = '*-newbuild'
  25
  26 class DummyDownloadSource(model.RetrievalMethod):
  27         """0launch >= 0.46 won't select implementations without a download source."""
  28         pass
  29
  30 class AutocompileCache(iface_cache.IfaceCache):
  31         def __init__(self):
  32                 iface_cache.IfaceCache.__init__(self)
  33                 self.done = set()
  34
  35         def get_feed(self, url, force = False):
  36                 feed = iface_cache.IfaceCache.get_feed(self, url, force)
  37                 if not feed: return None
  38
  39                 if feed not in self.done:
  40                         self.done.add(feed)
  41
  42                         # For each source impl, add a corresponding binary
  43                         # (the binary has no dependencies as we can't predict them here,
  44                         # but they're not the same as the source's dependencies)
  45
  46                         srcs = [x for x in feed.implementations.itervalues() if x.arch and x.arch.endswith('-src')]
  47                         for x in srcs:
  48                                 new_id = '0compile=' + x.id
  49                                 if not new_id in feed.implementations:
  50                                         new = model.ZeroInstallImplementation(feed, new_id, None)
  51                                         new.download_sources.append(DummyDownloadSource())
  52                                         feed.implementations[new_id] = new
  53                                         new.digests.append(new_id)
  54                                         new.set_arch(host_arch)
  55                                         new.version = x.version
  56
  57                 return feed
  58
  59 policy.iface_cache = AutocompileCache()
  60
  61 class AutoCompiler:
  62         def __init__(self, iface_uri, options, handler):
  63                 self.iface_uri = iface_uri
  64                 self.options = options
  65                 self.handler = handler
  66
  67         def pretty_print_plan(self, solver, root, indent = '- '):
  68                 """Display a tree showing the selected implementations."""
  69                 iface = solver.iface_cache.get_interface(root)
  70                 impl = solver.selections[iface]
  71                 if impl is None:
  72                         msg = 'Failed to select any suitable version (source or binary)'
  73                 elif impl.id.startswith('0compile='):
  74                         real_impl_id = impl.id.split('=', 1)[1]
  75                         real_impl = impl.feed.implementations[real_impl_id]
  76                         msg = 'Compile %s (%s)' % (real_impl.get_version(), real_impl.id)
  77                 elif impl.arch and impl.arch.endswith('-src'):
  78                         msg = 'Compile %s (%s)' % (impl.get_version(), impl.id)
  79                 else:
  80                         if impl.arch:
  81                                 msg = 'Use existing binary %s (%s)' % (impl.get_version(), impl.arch)
  82                         else:
  83                                 msg = 'Use existing architecture-independent package %s' % impl.get_version()
  84                 self.note("%s%s: %s" % (indent, iface.get_name(), msg))
  85
  86                 if impl:
  87                         indent = '  ' + indent
  88                         for x in impl.requires:
  89                                 self.pretty_print_plan(solver, x.interface, indent)
  90
  91         def print_details(self, solver):
  92                 """Dump debugging details."""
  93                 self.note("\nFailed. Details of all components and versions considered:")
  94                 for iface in solver.details:
  95                         self.note('\n%s\n' % iface.get_name())
  96                         for impl, note in solver.details[iface]:
  97                                 self.note('%s (%s) : %s' % (impl.get_version(), impl.arch or '*-*', note or 'OK'))
  98                 self.note("\nEnd details\n")
  99
 100         @tasks.async
 101         def compile_and_register(self, policy):
 102                 def valid_autocompile_feed(binary_feed):
 103                         cache = policy.solver.iface_cache
 104                         local_feed_impls = cache.get_feed(local_feed).implementations
 105                         if len(local_feed_impls) != 1:
 106                                 self.note("Invalid autocompile feed '%s'; expected exactly one implementation!" % binary_feed)
 107                                 return False
 108                         impl, = local_feed_impls.values()
 109                         try:
 110                                 cache.stores.lookup_any(impl.digests)
 111                                 return True
 112                         except NotStored, ex:
 113                                 self.note("Build metadata file '%s' exists but implementation is missing: %s" % (local_feed, ex))
 114                                 return False
 115
 116                 local_feed_dir = basedir.save_config_path('0install.net', '0compile', 'builds', model._pretty_escape(policy.root))
 117                 s = selections.Selections(policy)
 118
 119                 buildenv = BuildEnv(need_config = False)
 120                 buildenv.config.set('compile', 'interface', policy.root)
 121                 buildenv.config.set('compile', 'selections', 'selections.xml')
 122
 123                 version = s.selections[policy.root].version
 124                 local_feed = os.path.join(local_feed_dir, '%s-%s-%s.xml' % (buildenv.iface_name, version, arch._uname[-1]))
 125                 if os.path.exists(local_feed):
 126                         if not valid_autocompile_feed(local_feed):
 127                                 os.unlink(local_feed)
 128                         else:
 129                                 raise SafeException("Build metadata file '%s' already exists!" % local_feed)
 130
 131                 tmpdir = tempfile.mkdtemp(prefix = '0compile-')
 132                 try:
 133                         os.chdir(tmpdir)
 134
 135                         # Write configuration for build...
 136
 137                         buildenv.save()
 138
 139                         sel_file = open('selections.xml', 'w')
 140                         try:
 141                                 doc = s.toDOM()
 142                                 doc.writexml(sel_file)
 143                                 sel_file.write('\n')
 144                         finally:
 145                                 sel_file.close()
 146
 147                         # Do the build...
 148
 149                         build = self.spawn_build(buildenv.iface_name)
 150                         if build:
 151                                 yield build
 152                                 tasks.check(build)
 153
 154                         # Register the result...
 155
 156                         alg = manifest.get_algorithm('sha1new')
 157                         digest = alg.new_digest()
 158                         lines = []
 159                         for line in alg.generate_manifest(buildenv.distdir):
 160                                 line += '\n'
 161                                 digest.update(line)
 162                                 lines.append(line)
 163                         actual_digest = alg.getID(digest)
 164
 165                         local_feed_file = file(local_feed, 'w')
 166                         try:
 167                                 dom = minidom.parse(buildenv.local_iface_file)
 168                                 impl, = dom.getElementsByTagNameNS(namespaces.XMLNS_IFACE, 'implementation')
 169                                 impl.setAttribute('id', actual_digest)
 170                                 dom.writexml(local_feed_file)
 171                                 local_feed_file.write('\n')
 172                         finally:
 173                                 local_feed_file.close()
 174
 175                         feed_for_elem, = dom.getElementsByTagNameNS(namespaces.XMLNS_IFACE, 'feed-for')
 176
 177                         self.note("Implementation metadata written to %s" % local_feed)
 178
 179                         # No point adding it to the system store when only the user has the feed...
 180                         store = policy.solver.iface_cache.stores.stores[0]
 181                         self.note("Storing build in user cache %s..." % store.dir)
 182                         policy.solver.iface_cache.stores.add_dir_to_cache(actual_digest, buildenv.distdir)
 183
 184                         iface = policy.solver.iface_cache.get_interface(feed_for_elem.getAttribute('interface'))
 185                         self.note("Registering as feed for %s" % iface.uri)
 186                         feed = iface.get_feed(local_feed)
 187                         if feed:
 188                                 self.note("WARNING: feed %s already registered!" % local_feed)
 189                         else:
 190                                 iface.extra_feeds.append(model.Feed(local_feed, impl.getAttribute('arch'), user_override = True))
 191                         writer.save_interface(iface)
 192
 193                         # We might have cached an old version
 194                         new_feed = policy.solver.iface_cache.get_interface(local_feed)
 195                         reader.update_from_cache(new_feed)
 196                 except:
 197                         self.note("\nBuild failed: leaving build directory %s for inspection...\n" % tmpdir)
 198                         raise
 199                 else:
 200                         ro_rmtree(tmpdir)
 201
 202         @tasks.async
 203         def recursive_build(self, iface_uri, version = None):
 204                 p = policy.Policy(iface_uri, handler = self.handler, src = True)
 205                 iface = p.solver.iface_cache.get_interface(iface_uri)
 206                 p.solver.record_details = True
 207                 if version:
 208                         p.solver.extra_restrictions[iface] = [model.VersionRestriction(model.parse_version(version))]
 209
 210                 # For testing...
 211                 #p.target_arch = arch.Architecture(os_ranks = {'FreeBSD': 0, None: 1}, machine_ranks = {'i386': 0, None: 1, 'newbuild': 2})
 212
 213                 while True:
 214                         self.heading(iface_uri)
 215                         self.note("\nSelecting versions for %s..." % iface.get_name())
 216                         solved = p.solve_with_downloads()
 217                         if solved:
 218                                 yield solved
 219                                 tasks.check(solved)
 220
 221                         if not p.solver.ready:
 222                                 self.print_details(p.solver)
 223                                 raise SafeException("Can't find all required implementations (source or binary):\n" +
 224                                         '\n'.join(["- %s -> %s" % (iface, p.solver.selections[iface])
 225                                                    for iface in p.solver.selections]))
 226                         self.note("Selection done.")
 227
 228                         self.note("\nPlan:\n")
 229                         self.pretty_print_plan(p.solver, p.root)
 230                         self.note('')
 231
 232                         for dep_iface, dep_impl in p.solver.selections.iteritems():
 233                                 if dep_impl.id.startswith('0compile='):
 234                                         build = self.recursive_build(dep_iface.uri, dep_impl.get_version())
 235                                         yield build
 236                                         tasks.check(build)
 237                                         break   # Try again with that dependency built...
 238                         else:
 239                                 self.note("No dependencies need compiling... compile %s itself..." % iface.get_name())
 240                                 build = self.compile_and_register(p)
 241                                 yield build
 242                                 tasks.check(build)
 243                                 return
 244
 245         def spawn_build(self, iface_name):
 246                 subprocess.check_call([sys.executable, sys.argv[0], 'build'])
 247
 248         def build(self):
 249                 self.handler.wait_for_blocker(self.recursive_build(self.iface_uri))
 250
 251         def heading(self, msg):
 252                 self.note((' %s ' % msg).center(76, '='))
 253
 254         def note(self, msg):
 255                 print msg
 256
 257         def note_error(self, msg):
 258                 self.overall.insert_at_cursor(msg + '\n')
 259
 260 class GUIHandler(handler.Handler):
 261         def downloads_changed(self):
 262                 self.compiler.downloads_changed()
 263
 264         def confirm_import_feed(self, pending, valid_sigs):
 265                 return handler.Handler.confirm_import_feed(self, pending, valid_sigs)
 266
 267 class GTKAutoCompiler(AutoCompiler):
 268         def __init__(self, iface_uri, options):
 269                 handler = GUIHandler()
 270                 handler.compiler = self
 271
 272                 AutoCompiler.__init__(self, iface_uri, options, handler)
 273                 self.child = None
 274
 275                 import pygtk; pygtk.require('2.0')
 276                 import gtk
 277
 278                 w = gtk.Dialog('Autocompile %s' % iface_uri, None, 0,
 279                                                  (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
 280                                                   gtk.STOCK_OK, gtk.RESPONSE_OK))
 281                 self.dialog = w
 282
 283                 w.set_default_size(int(gtk.gdk.screen_width() * 0.8),
 284                                    int(gtk.gdk.screen_height() * 0.8))
 285
 286                 vpaned = gtk.VPaned()
 287                 w.vbox.add(vpaned)
 288                 w.set_response_sensitive(gtk.RESPONSE_OK, False)
 289
 290                 class AutoScroller:
 291                         def __init__(self):
 292                                 tv = gtk.TextView()
 293                                 tv.set_property('left-margin', 8)
 294                                 tv.set_wrap_mode(gtk.WRAP_WORD_CHAR)
 295                                 tv.set_editable(False)
 296                                 swin = gtk.ScrolledWindow()
 297                                 swin.add(tv)
 298                                 swin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
 299                                 buffer = tv.get_buffer()
 300
 301                                 heading = buffer.create_tag('heading')
 302                                 heading.set_property('scale', 1.5)
 303
 304                                 error = buffer.create_tag('error')
 305                                 error.set_property('background', 'white')
 306                                 error.set_property('foreground', 'red')
 307
 308                                 self.tv = tv
 309                                 self.widget = swin
 310                                 self.buffer = buffer
 311
 312                         def insert_at_end_and_scroll(self, data, *tags):
 313                                 vscroll = self.widget.get_vadjustment()
 314                                 if not vscroll:
 315                                         # Widget has been destroyed
 316                                         print data,
 317                                         return
 318                                 near_end = vscroll.upper - vscroll.page_size * 1.5 < vscroll.value
 319                                 end = self.buffer.get_end_iter()
 320                                 self.buffer.insert_with_tags_by_name(end, data, *tags)
 321                                 if near_end:
 322                                         cursor = self.buffer.get_insert()
 323                                         self.buffer.move_mark(cursor, end)
 324                                         self.tv.scroll_to_mark(cursor, 0, False, 0, 0)
 325
 326                 self.overall = AutoScroller()
 327                 self.details = AutoScroller()
 328
 329                 vpaned.pack1(self.overall.widget, True, False)
 330                 vpaned.pack2(self.details.widget, True, False)
 331
 332                 self.closed = tasks.Blocker('Window closed')
 333
 334                 w.show_all()
 335                 w.connect('destroy', lambda wd: self.closed.trigger())
 336
 337                 def response(wd, resp):
 338                         if self.child is not None:
 339                                 self.note_error('Sending TERM signal to build process group %d...' % self.child.pid)
 340                                 os.kill(-self.child.pid, signal.SIGTERM)
 341                         else:
 342                                 self.closed.trigger()
 343                 w.connect('response', response)
 344
 345         def downloads_changed(self):
 346                 if self.handler.monitored_downloads:
 347                         self.note('Downloads in progress:')
 348                         for x in self.handler.monitored_downloads:
 349                                 self.note('- %s' % x)
 350                 else:
 351                         self.note('No downloads remaining.')
 352
 353         def heading(self, msg):
 354                 self.overall.insert_at_end_and_scroll(msg + '\n', 'heading')
 355
 356         def note(self, msg):
 357                 self.overall.insert_at_end_and_scroll(msg + '\n')
 358
 359         def note_error(self, msg):
 360                 self.overall.insert_at_end_and_scroll(msg + '\n', 'error')
 361
 362         def build(self):
 363                 import gtk
 364                 try:
 365                         self.handler.wait_for_blocker(self.recursive_build(self.iface_uri))
 366                 except SafeException, ex:
 367                         self.note_error(str(ex))
 368                 else:
 369                         self.heading('All builds completed successfully!')
 370                         self.dialog.set_response_sensitive(gtk.RESPONSE_CANCEL, False)
 371                         self.dialog.set_response_sensitive(gtk.RESPONSE_OK, True)
 372
 373                 self.handler.wait_for_blocker(self.closed)
 374
 375         @tasks.async
 376         def spawn_build(self, iface_name):
 377                 assert self.child is None
 378
 379                 self.details.insert_at_end_and_scroll('Building %s\n' % iface_name, 'heading')
 380
 381                 # Group all the child processes so we can kill them easily
 382                 def become_group_leader():
 383                         os.setpgid(0, 0)
 384                 self.child = subprocess.Popen([sys.executable, '-u', sys.argv[0], 'build'],
 385                                                 stdout = subprocess.PIPE, stderr = subprocess.STDOUT,
 386                                                 preexec_fn = become_group_leader)
 387
 388                 import codecs
 389                 decoder = codecs.getincrementaldecoder('utf-8')(errors = 'replace')
 390
 391                 while True:
 392                         yield tasks.InputBlocker(self.child.stdout, 'output from child')
 393                         got = os.read(self.child.stdout.fileno(), 100)
 394                         chars = decoder.decode(got, final = not got)
 395                         self.details.insert_at_end_and_scroll(chars)
 396                         if not got: break
 397
 398                 self.child.wait()
 399                 code = self.child.returncode
 400                 self.child = None
 401                 if code:
 402                         self.details.insert_at_end_and_scroll('Build process exited with error status %d\n' % code, 'error')
 403                         raise SafeException('Build process exited with error status %d' % code)
 404                 self.details.insert_at_end_and_scroll('Build completed successfully\n', 'heading')
 405
 406         @tasks.async
 407         def confirm_import_feed(self, pending, valid_sigs):
 408                 from zeroinstall.gtkui import trust_box
 409                 box = trust_box.TrustBox(pending, valid_sigs, parent = self.dialog)
 410                 box.show()
 411                 yield box.closed
 412
 413 def do_autocompile(args):
 414         """autocompile [--gui] URI"""
 415
 416         parser = OptionParser(usage="usage: %prog autocompile [options]")
 417
 418         parser.add_option('', "--gui", help="graphical interface", action='store_true')
 419         (options, args2) = parser.parse_args(args)
 420         if len(args2) != 1:
 421                 raise __main__.UsageError()
 422
 423         iface_uri = model.canonical_iface_uri(args2[0])
 424         if options.gui:
 425                 compiler = GTKAutoCompiler(iface_uri, options)
 426         else:
 427                 h = handler.ConsoleHandler()
 428                 compiler = AutoCompiler(iface_uri, options, h)
 429
 430         compiler.build()
 431
 432 __main__.commands += [do_autocompile]