]> git.lizzy.rs Git - torbrowser-launcher.git/blob - torbrowser-launcher
use Twisted's web.client.Agent to download browser bundle
[torbrowser-launcher.git] / torbrowser-launcher
1 #!/usr/bin/env python
2
3 from twisted.internet import gtk2reactor
4 gtk2reactor.install()
5 from twisted.internet import reactor
6
7 import pygtk
8 pygtk.require('2.0')
9 import gtk
10
11 import os, sys, subprocess, locale, urllib2, gobject, time
12
13 from twisted.web.client import Agent, ResponseDone
14 from twisted.web.http_headers import Headers
15 from twisted.internet.protocol import Protocol
16
17
18 class TorBrowserLauncher:
19   def __init__(self, current_tbb_version):
20     # initialize the app
21     self.current_tbb_version = current_tbb_version
22     self.discover_arch_lang()
23     self.build_paths()
24     self.mkdirs()
25
26     launch_gui = True
27
28     # is TBB already installed?
29     if os.path.isfile(self.paths['file']['start']) and os.access(self.paths['file']['start'], os.X_OK):
30       # does the version file exist?
31       if os.path.isfile(self.paths['file']['version']):
32         installed_tbb_version = open(self.paths['file']['version']).read().strip()
33
34         if installed_tbb_version == current_tbb_version:
35           # current version is tbb is installed, launch it
36           self.run(False)
37           launch_gui = False
38         elif installed_tbb_version < self.current_tbb_version:
39           # there is a tbb upgrade available
40           self.set_gui('task', "Your Tor Browser is out of date.", 
41             ['download_tarball', 
42              'download_tarball_sig', 
43              'verify', 
44              'extract', 
45              'run'])
46         else:
47           # for some reason the installed tbb is newer than the current version?
48           self.set_gui('error', "Something is wrong. The version of Tor Browser Bundle you have installed is newer than the current version?", [])
49
50       else:
51         # if tbb is installed but the version file doesn't exist, something is wrong
52         self.set_gui('error', "Something is wrong. You have the Tor Browser Bundle installed, but the version file is missing.", [])
53
54     # not installed
55     else:
56       # save the current version to the file
57       open(self.paths['file']['version'], 'w').write(self.current_tbb_version)
58
59       # are the tarball and sig already downloaded?
60       if os.path.isfile(self.paths['file']['tarball']) and os.path.isfile(self.paths['file']['tarball_sig']):
61         # start the gui with verify
62         self.set_gui('task', "Installing Tor Browser.", 
63           ['verify', 
64            'extract', 
65            'run'])
66
67       # first run
68       else:
69         self.set_gui('task', "Downloading and installing Tor Browser.", 
70           ['download_tarball', 
71            'download_tarball_sig', 
72            'verify', 
73            'extract', 
74            'run'])
75
76     if launch_gui:
77       self.build_ui()
78       #gtk.main()
79       reactor.run()
80   
81   # discover the architecture and language
82   def discover_arch_lang(self):
83     # figure out the architecture
84     (sysname, nodename, release, version, machine) = os.uname()
85     self.architecture = machine
86
87     # figure out the language
88     available_languages = ['en-US', 'ar', 'de', 'es-ES', 'fa', 'fr', 'it', 'ko', 'nl', 'pl', 'pt-PT', 'ru', 'vi', 'zh-CN']
89     default_locale = locale.getdefaultlocale()[0]
90     if default_locale == None:
91       self.language = 'en-US'
92     else:
93       self.language = default_locale.replace('_', '-')
94       if self.language not in available_languages:
95         self.language = self.language.split('-')[0]
96         if self.language not in available_languages:
97           for l in available_languages:
98             if l[0:2] == self.language:
99               self.language = l
100       # if language isn't available, default to english
101       if self.language not in available_languages:
102         self.language = 'en-US'
103
104   # build all relevant paths
105   def build_paths(self):
106     tbb_data = os.getenv('HOME')+'/.torbrowser'
107     tarball_filename = 'tor-browser-gnu-linux-'+self.architecture+'-'+self.current_tbb_version+'-dev-'+self.language+'.tar.gz'
108
109     self.paths = {
110       'dir': {
111         'data': tbb_data,
112         'download': tbb_data+'/download',
113         'tbb': tbb_data+'/tbb/'+self.architecture,
114         'gpg': tbb_data+'/gpgtmp'
115       },
116       'file': {
117         'version': tbb_data+'/version',
118         'start': tbb_data+'/tbb/'+self.architecture+'/tor-browser_'+self.language+'/start-tor-browser',
119         'tarball': tbb_data+'/download/'+tarball_filename,
120         'tarball_sig': tbb_data+'/download/'+tarball_filename+'.asc',
121         'verify': '/usr/share/torbrowser-launcher/verify.sh'
122       },
123       'url': {
124         'tarball': 'https://www.torproject.org/dist/torbrowser/linux/'+tarball_filename,
125         'tarball_sig': 'https://www.torproject.org/dist/torbrowser/linux/'+tarball_filename+'.asc'
126       },
127       'filename': {
128         'tarball': tarball_filename,
129         'tarball_sig': tarball_filename+'.asc'
130       }
131     }
132
133   # create directories that don't exist
134   def mkdirs(self):
135     if os.path.exists(self.paths['dir']['download']) == False:
136       os.makedirs(self.paths['dir']['download'])
137     if os.path.exists(self.paths['dir']['tbb']) == False:
138       os.makedirs(self.paths['dir']['tbb'])
139
140   # there are different GUIs that might appear, this sets which one we want
141   def set_gui(self, gui, message, tasks, autostart=True):
142     self.gui = gui
143     self.gui_message = message
144     self.gui_tasks = tasks
145     self.gui_autostart = autostart
146
147   # build the application's UI
148   def build_ui(self):
149     self.timer = False
150
151     # allow buttons to have icons
152     try:
153       settings = gtk.settings_get_default()
154       settings.props.gtk_button_images = True
155     except:
156       pass
157
158     # set up the window
159     self.window = gtk.Window(gtk.WINDOW_TOPLEVEL)
160     self.window.set_title("Tor Browser")
161     self.window.set_position(gtk.WIN_POS_CENTER)
162     self.window.set_border_width(10)
163     self.window.connect("delete_event", self.delete_event)
164     self.window.connect("destroy", self.destroy)
165
166     self.box = gtk.VBox(False, 20)
167     self.window.add(self.box)
168
169     if self.gui == 'error':
170       # labels
171       self.label1 = gtk.Label( self.gui_message ) 
172       self.label1.set_line_wrap(True)
173       self.box.pack_start(self.label1, True, True, 0)
174       self.label1.show()
175
176       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.") 
177       self.label2.set_line_wrap(True)
178       self.box.pack_start(self.label2, True, True, 0)
179       self.label2.show()
180
181       # exit button
182       exit_image = gtk.Image()
183       exit_image.set_from_stock(gtk.STOCK_CANCEL, gtk.ICON_SIZE_BUTTON)
184       self.exit_button = gtk.Button("Exit")
185       self.exit_button.set_image(exit_image)
186       self.exit_button.connect("clicked", self.destroy, None)
187       self.box.add(self.exit_button)
188       self.exit_button.show()
189
190     elif self.gui == 'task':
191       # label
192       self.label = gtk.Label( self.gui_message ) 
193       self.label.set_line_wrap(True)
194       self.box.pack_start(self.label, True, True, 0)
195       self.label.show()
196       
197       # progress bar
198       self.progressbar = gtk.ProgressBar(adjustment=None)
199       self.progressbar.set_orientation(gtk.PROGRESS_LEFT_TO_RIGHT)
200       self.progressbar.set_pulse_step(0.01)
201       self.box.pack_start(self.progressbar, True, True, 0)
202
203       # button box
204       self.button_box = gtk.HButtonBox()
205       self.button_box.set_layout(gtk.BUTTONBOX_SPREAD)
206       self.box.pack_start(self.button_box, True, True, 0)
207       self.button_box.show()
208
209       # start button
210       start_image = gtk.Image()
211       start_image.set_from_stock(gtk.STOCK_APPLY, gtk.ICON_SIZE_BUTTON)
212       self.start_button = gtk.Button("Start")
213       self.start_button.set_image(start_image)
214       self.start_button.connect("clicked", self.start, None)
215       self.button_box.add(self.start_button)
216       if not self.gui_autostart:
217         self.start_button.show()
218
219       # exit button
220       exit_image = gtk.Image()
221       exit_image.set_from_stock(gtk.STOCK_CANCEL, gtk.ICON_SIZE_BUTTON)
222       self.exit_button = gtk.Button("Exit")
223       self.exit_button.set_image(exit_image)
224       self.exit_button.connect("clicked", self.destroy, None)
225       self.button_box.add(self.exit_button)
226       self.exit_button.show()
227
228     self.box.show()
229     self.window.show()
230
231     if self.gui_autostart:
232       self.start(None)
233
234   # start button clicked, begin tasks
235   def start(self, widget, data=None):
236     # disable the start button
237     self.start_button.set_sensitive(False)
238
239     # start running tasks
240     self.gui_task_i = 0
241     self.run_task()
242     
243   # run the next task in the task list
244   def run_task(self):
245     self.refresh_gtk()
246
247     if self.gui_task_i >= len(self.gui_tasks):
248       self.destroy(False)
249       return
250
251     task = self.gui_tasks[self.gui_task_i]
252     
253     # get ready for the next task
254     self.gui_task_i += 1
255
256     if task == 'download_tarball':
257       print 'Downloading '+self.paths['url']['tarball']
258       self.download('tarball', self.paths['url']['tarball'], self.paths['file']['tarball'])
259
260     elif task == 'download_tarball_sig':
261       print 'Downloading '+self.paths['url']['tarball_sig']
262       self.download('signature', self.paths['url']['tarball_sig'], self.paths['file']['tarball_sig'])
263
264     elif task == 'verify':
265       print 'Verifying signature'
266       self.verify()
267
268     elif task == 'extract':
269       print 'Extracting '+self.paths['filename']['tarball']
270       self.extract()
271
272     elif task == 'run':
273       print 'Running '+self.paths['file']['start']
274       self.run()
275     
276     elif task == 'start_over':
277       print 'Starting download over again'
278       self.start_over()
279
280   def response_received(self, response):
281     class FileDownloader(Protocol):
282       def __init__(self, file, total, progress, done_cb):
283         self.file = file
284         self.total = total
285         self.so_far = 0
286         self.progress = progress
287         self.all_done = done_cb
288
289       def dataReceived(self, bytes):
290         self.file.write(bytes)
291         self.so_far += len(bytes)
292         percent = float(self.so_far) / float(self.total)
293         self.progress.set_fraction(percent)
294         self.progress.set_text('Downloaded %2.1f%%' % (percent * 100.0))
295
296       def connectionLost(self, reason):
297         print 'Finished receiving body:', reason.getErrorMessage()
298         self.all_done(reason)
299
300     dl = FileDownloader(self.file_download, response.length, self.progressbar, self.response_finished)
301     response.deliverBody(dl)
302
303
304   def response_finished(self, msg):
305     print dir(msg)
306     if msg.check(ResponseDone):
307       self.file_download.close()
308       # next task!
309       self.run_task()
310
311     else:
312       print "FINISHED", msg
313       ## FIXME handle errors
314
315
316   def download(self, name, url, path):
317     # initialize the progress bar
318     self.progressbar.set_fraction(0) 
319     self.progressbar.set_text('Downloading '+name)
320     self.progressbar.show()
321     self.refresh_gtk()
322
323     agent = Agent(reactor)
324     d = agent.request('GET', url,
325                       Headers({'User-Agent': ['torbrowser-launcher']}),
326                       None)
327
328     self.file_download = open(path, 'w')
329     d.addCallback(self.response_received)
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 verify(self):
357     # initialize the progress bar
358     self.progressbar.set_fraction(0) 
359     self.progressbar.set_text('Verifying Signature')
360     self.progressbar.show()
361
362     p = subprocess.Popen([self.paths['file']['verify'], self.paths['dir']['gpg'], self.paths['file']['tarball_sig']], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
363     self.pulse_until_process_exits(p)
364
365     output = p.stdout.read()
366     
367     if 'Good signature' in output:
368       self.run_task()
369     else:
370       self.progressbar.hide()
371       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.")
372       self.gui_tasks = ['start_over']
373       self.gui_task_i = 0
374       self.start_button.show()
375       self.start_button.set_sensitive(True)
376
377   def extract(self):
378     # initialize the progress bar
379     self.progressbar.set_fraction(0) 
380     self.progressbar.set_text('Installing')
381     self.progressbar.show()
382
383     p = subprocess.Popen(['tar', '-xf', self.paths['file']['tarball'], '-C', self.paths['dir']['tbb']], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
384     self.pulse_until_process_exits(p)
385
386     self.run_task()
387
388   def run(self, run_next_task = True):
389     subprocess.Popen([self.paths['file']['start']])
390     if run_next_task:
391       self.run_task()
392
393   # make the progress bar pulse until process p (a Popen object) finishes
394   def pulse_until_process_exits(self, p):
395     while p.poll() == None:
396       time.sleep(0.01)
397       self.progressbar.pulse()
398       self.refresh_gtk()
399
400   # start over and download TBB again
401   def start_over(self):
402     self.label.set_text("Downloading Tor Browser Bundle over again.")
403     self.gui_tasks = ['download_tarball', 'download_tarball_sig', 'verify', 'extract', 'run']
404     self.gui_task_i = 0
405     self.start(None)
406   
407   # refresh gtk
408   def refresh_gtk(self):
409     while gtk.events_pending():
410        gtk.main_iteration(False)
411
412   # exit
413   def delete_event(self, widget, event, data=None):
414     return False
415   def destroy(self, widget, data=None):
416     if self.timer:
417       gobject.source_remove(self.timer)
418     self.timer = False
419
420     gtk.main_quit()
421
422 if __name__ == "__main__":
423   current_tbl_version = '0.1'
424   current_tbb_version = '2.3.25-2'
425
426   print 'Tor Browser Launcher'
427   print 'version %s' % (current_tbl_version)
428   print 'https://github.com/micahflee/torbrowser-launcher'
429
430   app = TorBrowserLauncher(current_tbb_version)
431