zeroinstall/0launch-gui/bugs.py

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