torbrowser-launcher

   1 #!/usr/bin/env python
   2
   3 import os, sys, subprocess, locale, urllib2, gobject, time, pickle, json
   4
   5 import pygtk
   6 pygtk.require('2.0')
   7 import gtk
   8
   9 class TorBrowserLauncher:
  10   def __init__(self):
  11     # initialize the app
  12     self.discover_arch_lang()
  13     self.build_paths()
  14     self.mkdirs()
  15     self.clear_ui()
  16
  17     # allow buttons to have icons
  18     try:
  19       settings = gtk.settings_get_default()
  20       settings.props.gtk_button_images = True
  21     except:
  22       pass
  23
  24     launch_gui = True
  25
  26     # load settings
  27     if self.load_settings():
  28       self.build_paths(self.settings['latest_version'])
  29
  30       # how long was it since the last update check?
  31       # 86400 seconds = 24 hours
  32       current_timestamp = int(time.time())
  33       if current_timestamp - self.settings['last_update_check_timestamp'] >= 86400:
  34         # check for update
  35         self.set_gui('task', "Checking for Tor Browser update.",
  36           ['download_update_check',
  37            'attempt_update'])
  38
  39       else:
  40         # no need to check for update
  41         self.start_launcher()
  42
  43     else:
  44       self.set_gui('error', "Error loading settings. Delete ~/.torbrowser and try again.", [])
  45
  46     if launch_gui:
  47       self.build_ui()
  48       gtk.main()
  49
  50   # download or run TBB
  51   def start_launcher(self):
  52     # is TBB already installed?
  53     if os.path.isfile(self.paths['file']['start']) and os.access(self.paths['file']['start'], os.X_OK):
  54       if self.settings.installed_version == self.settings.latest_version:
  55         # current version of tbb is installed, launch it
  56         self.run(False)
  57         launch_gui = False
  58       elif self.settings.installed_version < self.settings.latest_version:
  59         # there is a tbb upgrade available
  60         self.set_gui('task', "Your Tor Browser is out of date.",
  61           ['download_tarball',
  62            'download_tarball_sig',
  63            'verify',
  64            'extract',
  65            'run'])
  66       else:
  67         # for some reason the installed tbb is newer than the current version?
  68         self.set_gui('error', "Something is wrong. The version of Tor Browser Bundle you have installed is newer than the current version?", [])
  69
  70     # not installed
  71     else:
  72       # are the tarball and sig already downloaded?
  73       if os.path.isfile(self.paths['file']['tarball']) and os.path.isfile(self.paths['file']['tarball_sig']):
  74         # start the gui with verify
  75         self.set_gui('task', "Installing Tor Browser.",
  76           ['verify',
  77            'extract',
  78            'run'])
  79
  80       # first run
  81       else:
  82         self.set_gui('task', "Downloading and installing Tor Browser.",
  83           ['download_tarball',
  84            'download_tarball_sig',
  85            'verify',
  86            'extract',
  87            'run'])
  88
  89   # discover the architecture and language
  90   def discover_arch_lang(self):
  91     # figure out the architecture
  92     (sysname, nodename, release, version, machine) = os.uname()
  93     self.architecture = machine
  94
  95     # figure out the language
  96     available_languages = ['en-US', 'ar', 'de', 'es-ES', 'fa', 'fr', 'it', 'ko', 'nl', 'pl', 'pt-PT', 'ru', 'vi', 'zh-CN']
  97     default_locale = locale.getdefaultlocale()[0]
  98     if default_locale == None:
  99       self.language = 'en-US'
 100     else:
 101       self.language = default_locale.replace('_', '-')
 102       if self.language not in available_languages:
 103         self.language = self.language.split('-')[0]
 104         if self.language not in available_languages:
 105           for l in available_languages:
 106             if l[0:2] == self.language:
 107               self.language = l
 108       # if language isn't available, default to english
 109       if self.language not in available_languages:
 110         self.language = 'en-US'
 111
 112   # build all relevant paths
 113   def build_paths(self, tbb_version = None):
 114     tbb_data = os.getenv('HOME')+'/.torbrowser'
 115
 116     if tbb_version:
 117       tarball_filename = 'tor-browser-gnu-linux-'+self.architecture+'-'+tbb_version+'-dev-'+self.language+'.tar.gz'
 118       self.paths['file']['tarball'] = tbb_data+'/download/'+tarball_filename
 119       self.paths['file']['tarball_sig'] = tbb_data+'/download/'+tarball_filename+'.asc'
 120       self.paths['url']['tarball'] = 'https://www.torproject.org/dist/torbrowser/linux/'+tarball_filename
 121       self.paths['url']['tarball_sig'] = 'https://www.torproject.org/dist/torbrowser/linux/'+tarball_filename+'.asc'
 122       self.paths['filename']['tarball'] = tarball_filename
 123       self.paths['filename']['tarball_sig'] = tarball_filename+'.asc'
 124
 125     else:
 126       self.paths = {
 127         'dir': {
 128           'data': tbb_data,
 129           'download': tbb_data+'/download',
 130           'tbb': tbb_data+'/tbb/'+self.architecture,
 131           'gpg': tbb_data+'/gpgtmp'
 132         },
 133         'file': {
 134           'settings': tbb_data+'/settings',
 135           'version': tbb_data+'/version',
 136           'start': tbb_data+'/tbb/'+self.architecture+'/tor-browser_'+self.language+'/start-tor-browser',
 137           'update_check': tbb_data+'/download/RecommendedTBBVersions',
 138           'verify': '/usr/share/torbrowser-launcher/verify.sh'
 139         },
 140         'url': {
 141           'update_check': 'https://check.torproject.org/RecommendedTBBVersions'
 142         },
 143         'filename': {}
 144       }
 145
 146   # create directories that don't exist
 147   def mkdirs(self):
 148     if os.path.exists(self.paths['dir']['download']) == False:
 149       os.makedirs(self.paths['dir']['download'])
 150     if os.path.exists(self.paths['dir']['tbb']) == False:
 151       os.makedirs(self.paths['dir']['tbb'])
 152
 153   # there are different GUIs that might appear, this sets which one we want
 154   def set_gui(self, gui, message, tasks, autostart=True):
 155     self.gui = gui
 156     self.gui_message = message
 157     self.gui_tasks = tasks
 158     self.gui_autostart = autostart
 159
 160   # set all gtk variables to False
 161   def clear_ui(self):
 162     self.timer = False
 163     self.window = False
 164     self.box = False
 165     self.label1 = False
 166     self.label2 = False
 167     self.label = False
 168     self.progressbar = False
 169     self.button_box = False
 170     self.start_button = False
 171     self.exit_button = False
 172
 173   # build the application's UI
 174   def build_ui(self):
 175     # set up the window
 176     self.window = gtk.Window(gtk.WINDOW_TOPLEVEL)
 177     self.window.set_title("Tor Browser")
 178     self.window.set_position(gtk.WIN_POS_CENTER)
 179     self.window.set_border_width(10)
 180     self.window.connect("delete_event", self.delete_event)
 181     self.window.connect("destroy", self.destroy)
 182
 183     self.box = gtk.VBox(False, 20)
 184     self.window.add(self.box)
 185
 186     if self.gui == 'error':
 187       # labels
 188       self.label1 = gtk.Label( self.gui_message )
 189       self.label1.set_line_wrap(True)
 190       self.box.pack_start(self.label1, True, True, 0)
 191       self.label1.show()
 192
 193       self.label2 = gtk.Label("You can fix the problem by deleting:\n"+self.paths['dir']['data']+"\n\nHowever, you will lose all your bookmarks and other Tor Browser preferences.")
 194       self.label2.set_line_wrap(True)
 195       self.box.pack_start(self.label2, True, True, 0)
 196       self.label2.show()
 197
 198       # exit button
 199       exit_image = gtk.Image()
 200       exit_image.set_from_stock(gtk.STOCK_CANCEL, gtk.ICON_SIZE_BUTTON)
 201       self.exit_button = gtk.Button("Exit")
 202       self.exit_button.set_image(exit_image)
 203       self.exit_button.connect("clicked", self.destroy, None)
 204       self.box.add(self.exit_button)
 205       self.exit_button.show()
 206
 207     elif self.gui == 'task':
 208       # label
 209       self.label = gtk.Label( self.gui_message )
 210       self.label.set_line_wrap(True)
 211       self.box.pack_start(self.label, True, True, 0)
 212       self.label.show()
 213
 214       # progress bar
 215       self.progressbar = gtk.ProgressBar(adjustment=None)
 216       self.progressbar.set_orientation(gtk.PROGRESS_LEFT_TO_RIGHT)
 217       self.progressbar.set_pulse_step(0.01)
 218       self.box.pack_start(self.progressbar, True, True, 0)
 219
 220       # button box
 221       self.button_box = gtk.HButtonBox()
 222       self.button_box.set_layout(gtk.BUTTONBOX_SPREAD)
 223       self.box.pack_start(self.button_box, True, True, 0)
 224       self.button_box.show()
 225
 226       # start button
 227       start_image = gtk.Image()
 228       start_image.set_from_stock(gtk.STOCK_APPLY, gtk.ICON_SIZE_BUTTON)
 229       self.start_button = gtk.Button("Start")
 230       self.start_button.set_image(start_image)
 231       self.start_button.connect("clicked", self.start, None)
 232       self.button_box.add(self.start_button)
 233       if not self.gui_autostart:
 234         self.start_button.show()
 235
 236       # exit button
 237       exit_image = gtk.Image()
 238       exit_image.set_from_stock(gtk.STOCK_CANCEL, gtk.ICON_SIZE_BUTTON)
 239       self.exit_button = gtk.Button("Exit")
 240       self.exit_button.set_image(exit_image)
 241       self.exit_button.connect("clicked", self.destroy, None)
 242       self.button_box.add(self.exit_button)
 243       self.exit_button.show()
 244
 245     self.box.show()
 246     self.window.show()
 247
 248     if self.gui_autostart:
 249       self.start(None)
 250
 251   # start button clicked, begin tasks
 252   def start(self, widget, data=None):
 253     # disable the start button
 254     self.start_button.set_sensitive(False)
 255
 256     # start running tasks
 257     self.gui_task_i = 0
 258     self.run_task()
 259
 260   # run the next task in the task list
 261   def run_task(self):
 262     self.refresh_gtk()
 263
 264     if self.gui_task_i >= len(self.gui_tasks):
 265       self.destroy(False)
 266       return
 267
 268     task = self.gui_tasks[self.gui_task_i]
 269
 270     # get ready for the next task
 271     self.gui_task_i += 1
 272
 273     if task == 'download_update_check':
 274       print 'Downloading '+self.paths['url']['update_check']
 275       self.download('update check', self.paths['url']['update_check'], self.paths['file']['update_check'])
 276
 277     if task == 'attempt_update':
 278       print 'Attempting to update'
 279       self.attempt_update()
 280
 281     elif task == 'download_tarball':
 282       print 'Downloading '+self.paths['url']['tarball']
 283       self.download('tarball', self.paths['url']['tarball'], self.paths['file']['tarball'])
 284
 285     elif task == 'download_tarball_sig':
 286       print 'Downloading '+self.paths['url']['tarball_sig']
 287       self.download('signature', self.paths['url']['tarball_sig'], self.paths['file']['tarball_sig'])
 288
 289     elif task == 'verify':
 290       print 'Verifying signature'
 291       self.verify()
 292
 293     elif task == 'extract':
 294       print 'Extracting '+self.paths['filename']['tarball']
 295       self.extract()
 296
 297     elif task == 'run':
 298       print 'Running '+self.paths['file']['start']
 299       self.run()
 300
 301     elif task == 'start_over':
 302       print 'Starting download over again'
 303       self.start_over()
 304
 305
 306   def download(self, name, url, path):
 307     # initialize the progress bar
 308     self.progressbar.set_fraction(0)
 309     self.progressbar.set_text('Downloading '+name)
 310     self.progressbar.show()
 311     self.refresh_gtk()
 312
 313     # start the download
 314     self.dl_response = urllib2.urlopen(url)
 315     self.dl_total_size = self.dl_response.info().getheader('Content-Length').strip()
 316     self.dl_total_size = int(self.dl_total_size)
 317     self.dl_bytes_so_far = 0
 318
 319     # set a timer to download more chunks
 320     self.timer = gobject.timeout_add(1, self.download_chunk, name)
 321
 322     # open a file to write to
 323     self.file_download = open(path, 'w')
 324
 325   def download_chunk(self, name):
 326     # download 10kb a time
 327     chunk = self.dl_response.read(10240)
 328     self.dl_bytes_so_far += len(chunk)
 329     self.file_download.write(chunk)
 330
 331     if not chunk:
 332       self.file_download.close()
 333       # next task!
 334       self.run_task()
 335       return False
 336
 337     percent = float(self.dl_bytes_so_far) / self.dl_total_size
 338     self.progressbar.set_fraction(percent)
 339     percent = round(percent*100, 2)
 340     self.progressbar.set_text("Downloaded %d%% of %s" % (percent, name))
 341     self.refresh_gtk()
 342
 343     sys.stdout.write("Downloaded %d of %d bytes (%0.2f%%)\r" % (self.dl_bytes_so_far, self.dl_total_size, percent))
 344
 345     if self.dl_bytes_so_far >= self.dl_total_size:
 346       sys.stdout.write('\n')
 347
 348     return True
 349
 350   def attempt_update(self):
 351     # load the update check file
 352     try:
 353       versions = json.load(open(self.paths['file']['update_check']))
 354       latest_version = None
 355
 356       end = '-Linux-%s' % self.architecture
 357       for version in versions:
 358         if str(version).find(end) != -1:
 359           latest_version = version
 360
 361       if latest_version:
 362         self.settings.latest_version = latest_version[:-len(end)]
 363         self.settings.last_update_check_timestamp = int(time.time())
 364         self.save_settings()
 365         self.build_paths(self.settings['latest_version'])
 366         self.start_launcher()
 367
 368       else:
 369         # failed to find the latest version
 370         self.set_gui('error', "Error checking for updates.", [])
 371
 372     except:
 373       # not a valid JSON object
 374       self.set_gui('error', "Error checking for updates.", [])
 375
 376     # now start over
 377     self.window.destroy()
 378     self.clear_ui()
 379     self.build_ui()
 380
 381   def verify(self):
 382     # initialize the progress bar
 383     self.progressbar.set_fraction(0)
 384     self.progressbar.set_text('Verifying Signature')
 385     self.progressbar.show()
 386
 387     p = subprocess.Popen([self.paths['file']['verify'], self.paths['dir']['gpg'], self.paths['file']['tarball_sig']], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
 388     self.pulse_until_process_exits(p)
 389
 390     output = p.stdout.read()
 391
 392     if 'Good signature' in output:
 393       self.run_task()
 394     else:
 395       self.progressbar.hide()
 396       self.label.set_text("SIGNATURE VERIFICATION FAILED!\n\nYou might be under attack, or there might just be a networking problem. Click Start try the download again.")
 397       self.gui_tasks = ['start_over']
 398       self.gui_task_i = 0
 399       self.start_button.show()
 400       self.start_button.set_sensitive(True)
 401
 402   def extract(self):
 403     # initialize the progress bar
 404     self.progressbar.set_fraction(0)
 405     self.progressbar.set_text('Installing')
 406     self.progressbar.show()
 407
 408     p = subprocess.Popen(['tar', '-xf', self.paths['file']['tarball'], '-C', self.paths['dir']['tbb']], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
 409     self.pulse_until_process_exits(p)
 410
 411     self.run_task()
 412
 413   def run(self, run_next_task = True):
 414     subprocess.Popen([self.paths['file']['start']])
 415     if run_next_task:
 416       self.run_task()
 417
 418   # make the progress bar pulse until process p (a Popen object) finishes
 419   def pulse_until_process_exits(self, p):
 420     while p.poll() == None:
 421       time.sleep(0.01)
 422       self.progressbar.pulse()
 423       self.refresh_gtk()
 424
 425   # start over and download TBB again
 426   def start_over(self):
 427     self.label.set_text("Downloading Tor Browser Bundle over again.")
 428     self.gui_tasks = ['download_tarball', 'download_tarball_sig', 'verify', 'extract', 'run']
 429     self.gui_task_i = 0
 430     self.start(None)
 431
 432   # load settings
 433   def load_settings(self):
 434     if os.path.isfile(self.paths['file']['settings']):
 435       self.settings = pickle.load(open(self.paths['file']['settings']))
 436       # sanity checks
 437       if not 'installed_version' in self.settings:
 438         return False
 439       if not 'latest_version' in self.settings:
 440         return False
 441       if not 'last_update_check_timestamp' in self.settings:
 442         return False
 443     else:
 444       self.settings = {
 445         'installed_version': False,
 446         'latest_version': '0',
 447         'last_update_check_timestamp': 0
 448       }
 449       self.save_settings()
 450     return True
 451
 452   # save settings
 453   def save_settings(self):
 454     pickle.dump(self.settings, open(self.paths['file']['settings'], 'w'))
 455     return True
 456
 457   # refresh gtk
 458   def refresh_gtk(self):
 459     while gtk.events_pending():
 460        gtk.main_iteration(False)
 461
 462   # exit
 463   def delete_event(self, widget, event, data=None):
 464     return False
 465   def destroy(self, widget, data=None):
 466     if self.timer:
 467       gobject.source_remove(self.timer)
 468     self.timer = False
 469
 470     gtk.main_quit()
 471
 472 if __name__ == "__main__":
 473   tor_browser_launcher_version = '0.1'
 474
 475   print 'Tor Browser Launcher'
 476   print 'version %s' % (tor_browser_launcher_version)
 477   print 'https://github.com/micahflee/torbrowser-launcher'
 478
 479   app = TorBrowserLauncher()
 480