zeroinstall/0launch-gui/bugs.py

   1 # Copyright (C) 2007, Thomas Leonard
   2 # See http://0install.net/0compile.html
   3
   4 import sys, os
   5 import gtk, pango
   6 import dialog
   7
   8 import zeroinstall
   9 from zeroinstall import support
  10
  11 def report_bug(policy, iface):
  12         assert iface
  13
  14         # TODO: Check the interface to decide where to send bug reports
  15
  16         issue_file = '/etc/issue'
  17         if os.path.exists(issue_file):
  18                 issue = file(issue_file).read().strip()
  19         else:
  20                 issue = "(file '%s' not found)" % issue
  21
  22         text = 'Problem with %s\n' % iface.uri
  23         if iface.uri != policy.root:
  24                 text = '  (while attempting to run %s)\n' % policy.root
  25         text += '\n'
  26
  27         text += 'Zero Install: Version %s, with Python %s\n' % (zeroinstall.version, sys.version)
  28
  29         text += '\nChosen implementations:\n'
  30
  31         if not policy.ready:
  32                 text += '  Failed to select all required implementations\n'
  33
  34         for chosen_iface in policy.implementation:
  35                 text += '\n  Interface: %s\n' % chosen_iface.uri
  36                 impl = policy.implementation[chosen_iface]
  37                 if impl:
  38                         text += '    Version: %s\n' % impl.get_version()
  39                         if impl.feed.url != chosen_iface.uri:
  40                                 text += '  From feed: %s\n' % impl.feed.url
  41                         text += '         ID: %s\n' % impl.id
  42                 else:
  43                         text += '    No implementation selected\n'
  44
  45         if hasattr(os, 'uname'):
  46                 text += '\nSystem:\n  %s\n\nIssue:\n  %s\n' % ('\n  '.join(os.uname()), issue)
  47         else:
  48                 text += '\nSystem without uname()\n'
  49
  50         reporter = BugReporter(policy, iface, text)
  51         reporter.show()
  52
  53 class BugReporter(dialog.Dialog):
  54         def __init__(self, policy, iface, env):
  55                 dialog.Dialog.__init__(self)
  56
  57                 self.sf_group_id = 76468
  58                 self.sf_artifact_id = 929902
  59
  60                 self.set_title('Report a Bug')
  61                 self.set_modal(True)
  62                 self.set_has_separator(False)
  63                 self.policy = policy
  64                 self.frames = []
  65
  66                 vbox = gtk.VBox(False, 4)
  67                 vbox.set_border_width(10)
  68                 self.vbox.pack_start(vbox, True, True, 0)
  69
  70                 self.set_default_size(gtk.gdk.screen_width() / 2, -1)
  71
  72                 def frame(title, contents, buffer):
  73                         fr = gtk.Frame()
  74                         label = gtk.Label('')
  75                         label.set_markup('<b>%s</b>' % title)
  76                         fr.set_label_widget(label)
  77                         fr.set_shadow_type(gtk.SHADOW_NONE)
  78                         vbox.pack_start(fr, True, True, 0)
  79
  80                         align = gtk.Alignment(0, 0, 1, 1)
  81                         align.set_padding(0, 0, 16, 0)
  82                         fr.add(align)
  83                         align.add(contents)
  84
  85                         self.frames.append((title, buffer))
  86
  87                 def text_area(text = None, mono = False):
  88                         swin = gtk.ScrolledWindow()
  89                         swin.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_ALWAYS)
  90                         swin.set_shadow_type(gtk.SHADOW_IN)
  91
  92                         tv = gtk.TextView()
  93                         tv.set_wrap_mode(gtk.WRAP_WORD)
  94                         swin.add(tv)
  95                         if text:
  96                                 tv.get_buffer().insert_at_cursor(text)
  97
  98                         if mono:
  99                                 tv.modify_font(pango.FontDescription('mono'))
 100
 101                         tv.set_accepts_tab(False)
 102
 103                         return swin, tv.get_buffer()
 104
 105                 actual = text_area()
 106                 frame("What doesn't work?", *actual)
 107
 108                 expected = text_area()
 109                 frame('What did you expect to happen?', *expected)
 110
 111                 errors_box = gtk.VBox(False, 0)
 112                 errors_swin, errors_buffer = text_area(mono = True)
 113                 errors_box.pack_start(errors_swin, True, True, 0)
 114                 buttons = gtk.HButtonBox()
 115                 buttons.set_layout(gtk.BUTTONBOX_START)
 116                 errors_box.pack_start(buttons, False, True, 4)
 117                 get_errors = gtk.Button('Run it now and record the output')
 118                 get_errors.connect('clicked', lambda button: self.collect_output(errors_buffer))
 119                 buttons.add(get_errors)
 120
 121                 frame('Are any errors or warnings displayed?', errors_box, errors_buffer)
 122
 123                 if dialog.last_error:
 124                         errors_buffer.insert_at_cursor(str(dialog.last_error))
 125
 126                 environ = text_area(env, mono = True)
 127                 frame('Information about your setup', *environ)
 128
 129                 browse_url = 'http://sourceforge.net/tracker/?group_id=%d&atid=%d' % (self.sf_group_id, self.sf_artifact_id)
 130                 location_hbox = gtk.HBox(False, 4)
 131                 location_hbox.pack_start(gtk.Label(_('Bugs reports will be sent to:')), False, True, 0)
 132                 if hasattr(gtk, 'LinkButton'):
 133                         import browser
 134                         url_box = gtk.LinkButton(browse_url)
 135                         url_box.connect('clicked', lambda button: browser.open_in_browser(browse_url))
 136                 else:
 137                         url_box = gtk.Label(browse_url)
 138                         url_box.set_selectable(True)
 139                 location_hbox.pack_start(url_box, False, True, 0)
 140                 vbox.pack_start(location_hbox, False, True, 0)
 141
 142                 self.add_button(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL)
 143                 self.add_button(gtk.STOCK_OK, gtk.RESPONSE_OK)
 144                 self.set_default_response(gtk.RESPONSE_OK)
 145
 146                 def resp(box, r):
 147                         if r == gtk.RESPONSE_OK:
 148                                 text = ''
 149                                 for title, buffer in self.frames:
 150                                         start = buffer.get_start_iter()
 151                                         end = buffer.get_end_iter()
 152                                         text += '%s\n\n%s\n\n' % (title, buffer.get_text(start, end).strip())
 153                                 title = 'Bug for %s' % iface.get_name()
 154                                 self.report_bug(title, text)
 155                                 self.destroy()
 156                                 dialog.alert(self, "Your bug report has been sent. Thank you.",
 157                                              type = gtk.MESSAGE_INFO)
 158                         else:
 159                                 self.destroy()
 160                 self.connect('response', resp)
 161
 162                 self.show_all()
 163
 164         def collect_output(self, buffer):
 165                 iter = buffer.get_end_iter()
 166                 buffer.place_cursor(iter)
 167
 168                 if not self.policy.ready:
 169                         missing = [iface.uri for iface in self.policy.implementation if self.policy.implementation[iface] is None]
 170                         buffer.insert_at_cursor("Can't run: no version has been selected for:\n- " +
 171                                         "\n- ".join(missing))
 172                         return
 173                 uncached = self.policy.get_uncached_implementations()
 174                 if uncached:
 175                         buffer.insert_at_cursor("Can't run: the chosen versions have not been downloaded yet. I need:\n\n- " +
 176                                 "\n\n- " . join(['%s version %s\n  (%s)' %(x[0].uri, x[1].get_version(), x[1].id) for x in uncached]))
 177                         return
 178
 179                 from zeroinstall.injector import selections
 180                 sels = selections.Selections(self.policy)
 181                 doc = sels.toDOM()
 182
 183                 self.hide()
 184                 try:
 185                         gtk.gdk.flush()
 186                         iter = buffer.get_end_iter()
 187                         buffer.place_cursor(iter)
 188
 189                         # Tell 0launch to run the program
 190                         doc.documentElement.setAttribute('run-test', 'true')
 191                         payload = doc.toxml('utf-8')
 192                         sys.stdout.write(('Length:%8x\n' % len(payload)) + payload)
 193                         sys.stdout.flush()
 194
 195                         reply = support.read_bytes(0, len('Length:') + 9)
 196                         assert reply.startswith('Length:')
 197                         test_output = support.read_bytes(0, int(reply.split(':', 1)[1], 16))
 198
 199                         # Cope with invalid UTF-8
 200                         import codecs
 201                         decoder = codecs.getdecoder('utf-8')
 202                         data = decoder(test_output, 'replace')[0]
 203
 204                         buffer.insert_at_cursor(data)
 205                 finally:
 206                         self.show()
 207
 208         def report_bug(self, title, text):
 209                 try:
 210                         import urllib
 211                         from urllib2 import urlopen
 212
 213                         stream = urlopen('http://sourceforge.net/tracker/index.php',
 214                                 urllib.urlencode({
 215                                 'group_id': str(self.sf_group_id),
 216                                 'atid': str(self.sf_artifact_id),
 217                                 'func': 'postadd',
 218                                 'is_private': '0',
 219                                 'summary': title,
 220                                 'details': text}))
 221                         stream.read()
 222                         stream.close()
 223                 except:
 224                         # Write to stderr in the hope that it doesn't get lost
 225                         print >>sys.stderr, "Error sending bug report: %s\n\n%s" % (title, text)
 226                         raise