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