3 # Uzbl tabbing wrapper using a fifo socket interface
4 # Copywrite (c) 2009, Tom Adams <tom@holizz.com>
5 # Copywrite (c) 2009, quigybo <?>
6 # Copywrite (c) 2009, Mason Larobina <mason.larobina@gmail.com>
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
23 # Tom Adams <tom@holizz.com>
24 # Wrote the original uzbl_tabbed.py as a proof of concept.
27 # Made signifigant headway on the uzbl_tabbing.py script on the
28 # uzbl wiki <http://www.uzbl.org/wiki/uzbl_tabbed>
30 # Mason Larobina <mason.larobina@gmail.com>
31 # Rewrite of the uzbl_tabbing.py script to use a fifo socket interface
32 # and inherit configuration options from the user's uzbl config.
39 # - status_background colour is not honoured (reverts to gtk default).
40 # - new windows are not caught and opened in a new tab.
41 # - need an easier way to read a uzbl instances window title instead of
42 # spawning a shell to spawn uzblctrl to communicate to the uzbl
43 # instance via socket to dump the window title to then pipe it to
44 # the tabbing managers fifo socket.
45 # - probably missing some os.path.expandvars somewhere.
49 # - add command line options to use a different session file, not use a
50 # session file and or open a uri on starup.
51 # - ellipsize individual tab titles when the tab-list becomes over-crowded
52 # - add "<" & ">" arrows to tablist to indicate that only a subset of the
53 # currently open tabs are being displayed on the tablist.
54 # - probably missing some os.path.expandvars somewhere and other
55 # user-friendly.. things, this is still a very early version.
56 # - fix status_background issues & style tablist.
57 # - add the small tab-list display when both gtk tabs and text vim-like
58 # tablist are hidden (I.e. [ 1 2 3 4 5 ])
77 sys.stderr.write("%s\n"%msg)
79 if 'XDG_DATA_HOME' in os.environ.keys() and os.environ['XDG_DATA_HOME']:
80 data_dir = os.path.join(os.environ['XDG_DATA_HOME'], 'uzbl/')
83 data_dir = os.path.join(os.environ['HOME'], '.local/share/uzbl/')
85 # === Default Configuration ====================================================
87 # Location of your uzbl configuration file.
88 uzbl_config = os.path.join(os.environ['HOME'],'.config/uzbl/config')
90 # All of these settings can be inherited from your uzbl config file.
91 config = {'show_tabs': True,
92 'show_gtk_tabs': False,
93 'switch_to_new_tabs': True,
96 'icon_path': os.path.join(data_dir, 'uzbl.png'),
97 'session_file': os.path.join(data_dir, 'session'),
98 'tab_colours': 'foreground = "#999"',
99 'tab_text_colours': 'foreground = "#444"',
100 'selected_tab': 'foreground = "#aaa" background="#303030"',
101 'selected_tab_text': 'foreground = "green"',
102 'window_size': "800,800",
103 'monospace_size': 10,
104 'bind_new_tab': 'gn',
105 'bind_tab_from_clipboard': 'gY',
106 'bind_close_tab': 'gC',
107 'bind_next_tab': 'gt',
108 'bind_prev_tab': 'gT',
109 'bind_goto_tab': 'gi_',
110 'bind_goto_first': 'g<',
111 'bind_goto_last':'g>'}
113 # === End Configuration =======================================================
115 def readconfig(uzbl_config, config):
116 '''Loads relevant config from the users uzbl config file into the global
117 config dictionary.'''
119 if not os.path.exists(uzbl_config):
120 error("Unable to load config %r" % uzbl_config)
123 # Define parsing regular expressions
124 isint = re.compile("^[0-9]+$").match
125 findsets = re.compile("^set\s+([^\=]+)\s*\=\s*(.+)$",\
126 re.MULTILINE).findall
128 h = open(os.path.expandvars(uzbl_config), 'r')
132 for (key, value) in findsets(rawconfig):
134 if key not in config.keys(): continue
135 if isint(value): value = int(value)
140 '''Recursively make directories.
141 I.e. `mkdir -p /some/nonexistant/path/`'''
143 path, sep = os.path.realpath(path), os.path.sep
144 dirs = path.split(sep)
145 for i in range(2,len(dirs)+1):
146 dir = os.path.join(sep,sep.join(dirs[:i]))
147 if not os.path.exists(dir):
152 '''To infinity and beyond!'''
161 '''A tabbed version of uzbl using gtk.Notebook'''
164 '''Uzbl instance meta-data/meta-action object.'''
166 def __init__(self, parent, socket, fifo, pid, url='', switch=True):
168 self.socket = socket # the gtk socket
171 self.title = "New tab"
175 self._switch_on_config = switch
177 self._configured = False
179 # When notebook tab deleted the kill switch is raised.
182 # Queue binds for uzbl child
183 self.parent.config_uzbl(self)
186 def flush(self, timer_call=False):
187 '''Flush messages from the queue.'''
190 error("Flush called on dead page.")
193 if os.path.exists(self.fifo):
194 h = open(self.fifo, 'w')
195 while len(self._outgoing):
196 msg = self._outgoing.pop(0)
197 h.write("%s\n" % msg)
200 elif not timer_call and self._configured:
201 # TODO: I dont know what to do here. A previously thought
202 # alright uzbl client fifo socket has now gone missing.
203 # I think this should be fatal (at least for the page in
204 # question). I'll wait until this error appears in the wild.
205 error("Error: fifo %r lost in action." % self.fifo)
207 if not len(self._outgoing) and timer_call:
208 self._configured = True
210 if timer_call in self.timers.keys():
211 gobject.source_remove(self.timers[timer_call])
212 del self.timers[timer_call]
214 if self._switch_on_config:
215 notebook = list(self.parent.notebook)
217 tabid = notebook.index(self.socket)
218 self.parent.goto_tab(tabid)
223 return len(self._outgoing)
227 '''Probes the client for information about its self.'''
229 # Ugly way of getting the socket path. Screwed if fifo is in any
230 # other part of the fifo socket path.
232 socket = 'socket'.join(self.fifo.split('fifo'))
235 subcmd = 'print title %s @<document.title>@' % self.pid
236 cmd = 'uzblctrl -s "%s" -c "%s" > "%s" &' % (socket, subcmd, \
237 self.parent.fifo_socket)
239 subprocess.Popen([cmd], shell=True)
241 self._lastprobe = time.time()
245 '''Child fifo write function.'''
247 self._outgoing.append(msg)
248 # Flush messages from the queue if able.
253 '''Create tablist, window and notebook.'''
256 self._pidcounter = counter()
257 self.next_pid = self._pidcounter.next
263 self.window = gtk.Window()
265 window_size = map(int, config['window_size'].split(','))
266 self.window.set_default_size(*window_size)
269 error("Invalid value for default_size in config file.")
271 self.window.set_title("Uzbl Browser")
272 self.window.set_border_width(0)
274 # Set main window icon
275 icon_path = config['icon_path']
276 if os.path.exists(icon_path):
277 self.window.set_icon(gtk.gdk.pixbuf_new_from_file(icon_path))
280 icon_path = '/usr/share/uzbl/examples/data/uzbl/uzbl.png'
281 if os.path.exists(icon_path):
282 self.window.set_icon(gtk.gdk.pixbuf_new_from_file(icon_path))
284 # Attach main window event handlers
285 self.window.connect("delete-event", self.quit)
288 if config['show_tabs']:
290 self.window.add(vbox)
292 self.tablist = gtk.Label()
293 self.tablist.set_use_markup(True)
294 self.tablist.set_justify(gtk.JUSTIFY_LEFT)
295 self.tablist.set_line_wrap(False)
296 self.tablist.set_selectable(False)
297 self.tablist.set_padding(0,2)
298 self.tablist.set_alignment(0,0)
299 self.tablist.set_ellipsize(pango.ELLIPSIZE_END)
300 self.tablist.set_text(" ")
302 vbox.pack_start(self.tablist, False, False, 0)
305 self.notebook = gtk.Notebook()
306 self.notebook.set_show_tabs(config['show_gtk_tabs'])
307 self.notebook.set_show_border(False)
308 self.notebook.connect("page-removed", self.tab_closed)
309 self.notebook.connect("switch-page", self.tab_changed)
311 if config['show_tabs']:
312 vbox.pack_end(self.notebook, True, True, 0)
315 self.window.add(self.notebook)
318 self.wid = self.notebook.window.xid
319 # Fifo socket definition
320 self._refindfifos = re.compile('^uzbl_fifo_%s_[0-9]+$' % self.wid)
321 fifo_filename = 'uzbltabbed_%d' % os.getpid()
322 self.fifo_socket = os.path.join(config['fifo_dir'], fifo_filename)
326 self._create_fifo_socket(self.fifo_socket)
327 self._setup_fifo_watcher(self.fifo_socket)
332 # Update tablist timer
333 timer = "update-tablist"
334 timerid = gobject.timeout_add(500, self.update_tablist,timer)
335 self._timers[timer] = timerid
337 # Due to the hackish way in which the window titles are read
338 # too many window will cause the application to slow down insanely
339 timer = "probe-clients"
340 timerid = gobject.timeout_add(1000, self.probe_clients, timer)
341 self._timers[timer] = timerid
346 def _find_fifos(self, fifo_dir):
347 '''Find all child fifo sockets in fifo_dir.'''
349 dirlist = '\n'.join(os.listdir(fifo_dir))
350 allfifos = self._refindfifos.findall(dirlist)
351 return sorted(allfifos)
354 def _create_fifo_socket(self, fifo_socket):
355 '''Create interprocess communication fifo socket.'''
357 if os.path.exists(fifo_socket):
358 if not os.access(fifo_socket, os.F_OK | os.R_OK | os.W_OK):
359 os.mkfifo(fifo_socket)
362 basedir = os.path.dirname(self.fifo_socket)
363 if not os.path.exists(basedir):
365 os.mkfifo(self.fifo_socket)
367 print "Listening on %s" % self.fifo_socket
370 def _setup_fifo_watcher(self, fifo_socket, fd=None):
371 '''Open fifo socket fd and setup gobject IO_IN & IO_HUP watchers.
372 Also log the creation of a fd and store the the internal
373 self._watchers dictionary along with the filename of the fd.'''
375 #TODO: Convert current self._watcher dict manipulation to the better
376 # IMHO self._timers handling by using "timer-keys" as the keys instead
377 # of the fifo fd's as keys.
381 if fd in self._watchers.keys():
382 d = self._watchers[fd]
383 watchers = d['watchers']
384 for watcher in list(watchers):
385 gobject.source_remove(watcher)
386 watchers.remove(watcher)
387 del self._watchers[fd]
389 fd = os.open(fifo_socket, os.O_RDONLY | os.O_NONBLOCK)
390 self._watchers[fd] = {'watchers': [], 'filename': fifo_socket}
392 watcher = self._watchers[fd]['watchers'].append
393 watcher(gobject.io_add_watch(fd, gobject.IO_IN, self.read_fifo))
394 watcher(gobject.io_add_watch(fd, gobject.IO_HUP, self.fifo_hangup))
397 def probe_clients(self, timer_call):
398 '''Load balance probe all uzbl clients for up-to-date window titles
402 probetimes = [(s, p[s]._lastprobe) for s in p.keys()]
403 socket, lasttime = sorted(probetimes, key=lambda t: t[1])[0]
405 if (time.time()-lasttime) > 5:
406 # Probe a uzbl instance at most once every 10 seconds
407 self.pages[socket].probe()
412 def fifo_hangup(self, fd, cb_condition):
413 '''Handle fifo socket hangups.'''
415 # Close fd, re-open fifo_socket and watch.
416 self._setup_fifo_watcher(self.fifo_socket, fd)
418 # And to kill any gobject event handlers calling this function:
422 def read_fifo(self, fd, cb_condition):
423 '''Read from fifo socket and handle fifo socket hangups.'''
425 self._buffer = os.read(fd, 1024)
426 temp = self._buffer.split("\n")
427 self._buffer = temp.pop()
429 for cmd in [s.strip().split() for s in temp if len(s.strip())]:
432 self.parse_command(cmd)
436 error("Invalid command: %s" % ' '.join(cmd))
440 def parse_command(self, cmd):
441 '''Parse instructions from uzbl child processes.'''
443 # Commands ( [] = optional, {} = required )
445 # open new tab and head to optional uri.
447 # close current tab or close via tab id.
449 # open next tab or n tabs down. Supports negative indexing.
451 # open prev tab or n tabs down. Supports negative indexing.
458 # title {pid} {document-title}
459 # updates tablist title.
460 # url {pid} {document-location}
462 # WARNING SOME OF THESE COMMANDS MIGHT NOT BE WORKING YET OR FAIL.
471 elif cmd[0] == "newfromclip":
472 url = subprocess.Popen(['xclip','-selection','clipboard','-o'],\
473 stdout=subprocess.PIPE).communicate()[0]
477 elif cmd[0] == "close":
479 self.close_tab(int(cmd[1]))
484 elif cmd[0] == "next":
486 self.next_tab(int(cmd[1]))
491 elif cmd[0] == "prev":
493 self.prev_tab(int(cmd[1]))
498 elif cmd[0] == "goto":
499 self.goto_tab(int(cmd[1]))
501 elif cmd[0] == "first":
504 elif cmd[0] == "last":
507 elif cmd[0] in ["title", "url"]:
509 uzbl = self.get_uzbl_by_pid(int(cmd[1]))
511 setattr(uzbl, cmd[0], ' '.join(cmd[2:]))
513 error("Cannot find uzbl instance with pid %r" % int(cmd[1]))
515 error("Unknown command: %s" % ' '.join(cmd))
518 def get_uzbl_by_pid(self, pid):
519 '''Return uzbl instance by pid.'''
521 for socket in self.pages.keys():
522 if self.pages[socket].pid == pid:
523 return self.pages[socket]
527 def new_tab(self,url='', switch=True):
528 '''Add a new tab to the notebook and start a new instance of uzbl.
529 Use the switch option to negate config['switch_to_new_tabs'] option
530 when you need to load multiple tabs at a time (I.e. like when
531 restoring a session from a file).'''
533 pid = self.next_pid()
534 socket = gtk.Socket()
536 self.notebook.append_page(socket)
537 sid = socket.get_id()
540 url = '--uri %s' % url
542 fifo_filename = 'uzbl_fifo_%s_%0.2d' % (self.wid, pid)
543 fifo_socket = os.path.join(config['fifo_dir'], fifo_filename)
544 uzbl = self.UzblInstance(self, socket, fifo_socket, pid,\
545 url=url, switch=switch)
546 self.pages[socket] = uzbl
547 cmd = 'uzbl -s %s -n %s_%0.2d %s &' % (sid, self.wid, pid, url)
548 subprocess.Popen([cmd], shell=True)
550 # Add gobject timer to make sure the config is pushed when fifo socket
552 timerid = gobject.timeout_add(100, uzbl.flush, "flush-initial-config")
553 uzbl.timers['flush-initial-config'] = timerid
555 self.update_tablist()
558 def config_uzbl(self, uzbl):
559 '''Send bind commands for tab new/close/next/prev to a uzbl
563 bind_format = 'bind %s = sh "echo \\\"%s\\\" > \\\"%s\\\""'
564 bind = lambda key, action: binds.append(bind_format % (key, action, \
567 # Keys are defined in the config section
568 # bind ( key , command back to fifo )
569 bind(config['bind_new_tab'], 'new')
570 bind(config['bind_tab_from_clipboard'], 'newfromclip')
571 bind(config['bind_close_tab'], 'close')
572 bind(config['bind_next_tab'], 'next')
573 bind(config['bind_prev_tab'], 'prev')
574 bind(config['bind_goto_tab'], 'goto %s')
575 bind(config['bind_goto_first'], 'goto 0')
576 bind(config['bind_goto_last'], 'goto -1')
578 uzbl.send("\n".join(binds))
581 def goto_tab(self, n):
582 '''Goto tab n (supports negative indexing).'''
584 notebook = list(self.notebook)
588 i = notebook.index(page)
589 self.notebook.set_current_page(i)
594 self.update_tablist()
597 def next_tab(self, n=1):
598 '''Switch to next tab or n tabs right.'''
601 numofpages = self.notebook.get_n_pages()
602 pagen = self.notebook.get_current_page() + n
603 self.notebook.set_current_page( pagen % numofpages )
605 self.update_tablist()
608 def prev_tab(self, n=1):
609 '''Switch to prev tab or n tabs left.'''
612 numofpages = self.notebook.get_n_pages()
613 pagen = self.notebook.get_current_page() - n
616 self.notebook.set_current_page(pagen)
618 self.update_tablist()
621 def close_tab(self, tabid=None):
622 '''Closes current tab. Supports negative indexing.'''
625 tabid = self.notebook.get_current_page()
628 socket = list(self.notebook)[tabid]
631 error("Invalid index. Cannot close tab.")
634 uzbl = self.pages[socket]
636 for timer in uzbl.timers.keys():
637 error("Removing timer %r %r" % (timer, uzbl.timers[timer]))
638 gobject.source_remove(uzbl.timers[timer])
642 del self.pages[socket]
643 self.notebook.remove_page(tabid)
645 self.update_tablist()
648 def tab_closed(self, notebook, socket, page_num):
649 '''Close the window if no tabs are left. Called by page-removed
652 if socket in self.pages.keys():
653 uzbl = self.pages[socket]
654 for timer in uzbl.timers.keys():
655 error("Removing timer %r %r" % (timer, uzbl.timers[timer]))
656 gobject.source_remove(uzbl.timers[timer])
660 del self.pages[socket]
662 if self.notebook.get_n_pages() == 0:
665 self.update_tablist()
668 def tab_changed(self, notebook, page, page_num):
669 '''Refresh tab list. Called by switch-page signal.'''
671 self.update_tablist()
674 def update_tablist(self, timer_call=None):
675 '''Upate tablist status bar.'''
679 normal = (config['tab_colours'], config['tab_text_colours'])
680 selected = (config['selected_tab'], config['selected_tab_text'])
682 tab_format = "<span %s> [ %d <span %s> %s</span> ] </span>"
684 title_format = "%s - Uzbl Browser"
686 uzblkeys = self.pages.keys()
687 curpage = self.notebook.get_current_page()
689 for index, socket in enumerate(self.notebook):
690 if socket not in uzblkeys:
691 #error("Theres a socket in the notebook that I have no uzbl "\
694 uzbl = self.pages[socket]
698 self.window.set_title(title_format % uzbl.title)
703 pango += tab_format % (colours[0], index, colours[1], uzbl.title)
705 self.tablist.set_markup(pango)
710 #def quit(self, window, event):
711 def quit(self, *args):
712 '''Cleanup the application and quit. Called by delete-event signal.'''
714 for fd in self._watchers.keys():
715 d = self._watchers[fd]
716 watchers = d['watchers']
717 for watcher in list(watchers):
718 gobject.source_remove(watcher)
720 for timer in self._timers.keys():
721 gobject.source_remove(self._timers[timer])
723 if os.path.exists(self.fifo_socket):
724 os.unlink(self.fifo_socket)
725 print "Unlinked %s" % self.fifo_socket
727 if config['save_session']:
728 session_file = os.path.expandvars(config['session_file'])
729 if self.notebook.get_n_pages():
730 if not os.path.isfile(session_file):
731 dirname = os.path.dirname(session_file)
732 if not os.path.isdir(dirname):
735 h = open(session_file, 'w')
736 h.write('current = %s\n' % self.notebook.get_current_page())
738 for socket in list(self.notebook):
739 if socket not in self.pages.keys(): continue
740 uzbl = self.pages[socket]
741 uzbl.send('sh "echo $6 >> %s"' % session_file)
745 # Notebook has no pages so delete session file if it exists.
746 # Its better to not exist than be blank IMO.
747 if os.path.isfile(session_file):
748 os.remove(session_file)
753 if __name__ == "__main__":
755 # Read from the uzbl config into the global config dictionary.
756 readconfig(uzbl_config, config)
760 if os.path.isfile(os.path.expandvars(config['session_file'])):
761 h = open(os.path.expandvars(config['session_file']),'r')
762 urls = [s.strip() for s in h.readlines()]
766 if url.startswith("current"):
767 current = int(url.split()[-1])
769 uzbl.new_tab(url, False)