Merge branch 'experimental' into event-messages

9 files changed, 584 insertions, 23 deletions

diff --git a/examples/config/uzbl/config b/examples/config/uzbl/config
index ab2cf7f..efc4780 100644
--- a/examples/config/uzbl/config
+++ b/examples/config/uzbl/config
@@ -4,14 +4,14 @@
 # keyboard behavior in this sample config is sort of vimstyle
 
 # Handlers
-set history_handler  = spawn $XDG_DATA_HOME/uzbl/scripts/history.sh
 set download_handler = spawn $XDG_DATA_HOME/uzbl/scripts/download.sh
 set cookie_handler   = spawn $XDG_DATA_HOME/uzbl/scripts/cookies.py
 #set new_window      = sh 'echo uri "$8" > $4' # open in same window
 set new_window       = sh 'uzbl -u $8' # equivalent to the default behaviour
-set load_start_handler = set status_message = <span foreground="khaki">wait</span>
+set scheme_handler   = spawn $XDG_DATA_HOME/uzbl/scripts/scheme.py
+set load_start_handler = chain 'set keycmd = ' 'set status_message = <span foreground="khaki">wait</span>'
 set load_commit_handler = set status_message = <span foreground="green">recv</span>
-set load_finish_handler = set status_message = <span foreground="gold">done</span>
+set load_finish_handler = chain 'set status_message = <span foreground="gold">done</span>' 'spawn $XDG_DATA_HOME/uzbl/scripts/history.sh'
 
 
 
diff --git a/examples/data/uzbl/scripts/cookie_daemon.py b/examples/data/uzbl/scripts/cookie_daemon.py
new file mode 100755
index 0000000..af53e73
--- /dev/null
+++ b/examples/data/uzbl/scripts/cookie_daemon.py
@@ -0,0 +1,542 @@
+#!/usr/bin/env python
+
+# Uzbl tabbing wrapper using a fifo socket interface
+# Copyright (c) 2009, Tom Adams <tom@holizz.com>
+# Copyright (c) 2009, Dieter Plaetinck <dieter AT plaetinck.be>
+# Copyright (c) 2009, Mason Larobina <mason.larobina@gmail.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+'''
+The Python Cookie Daemon
+========================
+
+This daemon is a re-write of the original cookies.py script found in uzbl's
+master branch. This script provides more functionality than the original
+cookies.py by adding numerous command line options to specify different cookie
+jar locations, socket locations, verbose output, etc. This functionality is
+very useful as it allows you to run multiple daemons at once serving cookies
+to different groups of uzbl instances as required.
+
+Keeping up to date
+==================
+
+Check the cookie daemon uzbl-wiki page for more information on where to
+find the latest version of the cookie_daemon.py
+
+    http://www.uzbl.org/wiki/cookie_daemon.py
+
+Command line options
+====================
+
+Usage: cookie_daemon.py [options]
+
+Options:
+  -h, --help            show this help message and exit
+  -n, --no-daemon       don't daemonise the process.
+  -v, --verbose         print verbose output.
+  -t SECONDS, --daemon-timeout=SECONDS
+                        shutdown the daemon after x seconds inactivity.
+                        WARNING: Do not use this when launching the cookie
+                        daemon manually.
+  -s SOCKET, --cookie-socket=SOCKET
+                        manually specify the socket location.
+  -j FILE, --cookie-jar=FILE
+                        manually specify the cookie jar location.
+  -m, --memory          store cookies in memory only - do not write to disk
+
+Talking with uzbl
+=================
+
+In order to get uzbl to talk to a running cookie daemon you add the following
+to your uzbl config:
+
+  set cookie_handler = talk_to_socket $XDG_CACHE_HOME/uzbl/cookie_daemon_socket
+
+Or if you prefer using the $HOME variable:
+
+  set cookie_handler = talk_to_socket $HOME/.cache/uzbl/cookie_daemon_socket
+
+Issues
+======
+
+ - There is no easy way of stopping a running daemon.
+
+Todo list
+=========
+
+ - Use a pid file to make stopping a running daemon easy.
+ - add {start|stop|restart} command line arguments to make the cookie_daemon
+   functionally similar to the daemons found in /etc/init.d/ (in gentoo)
+   or /etc/rc.d/ (in arch).
+
+Reporting bugs / getting help
+=============================
+
+The best way to report bugs and or get help with the cookie daemon is to
+contact the maintainers it the #uzbl irc channel found on the Freenode IRC
+network (irc.freenode.org).
+'''
+
+import cookielib
+import os
+import sys
+import urllib2
+import select
+import socket
+import time
+import atexit
+from traceback import print_exc
+from signal import signal, SIGTERM
+from optparse import OptionParser
+
+try:
+    import cStringIO as StringIO
+
+except ImportError:
+    import StringIO
+
+
+# ============================================================================
+# ::: Default configuration section ::::::::::::::::::::::::::::::::::::::::::
+# ============================================================================
+
+
+# Location of the uzbl cache directory.
+if 'XDG_CACHE_HOME' in os.environ.keys() and os.environ['XDG_CACHE_HOME']:
+    CACHE_DIR = os.path.join(os.environ['XDG_CACHE_HOME'], 'uzbl/')
+
+else:
+    CACHE_DIR = os.path.join(os.environ['HOME'], '.cache/uzbl/')
+
+# Location of the uzbl data directory.
+if 'XDG_DATA_HOME' in os.environ.keys() and os.environ['XDG_DATA_HOME']:
+    DATA_DIR = os.path.join(os.environ['XDG_DATA_HOME'], 'uzbl/')
+
+else:
+    DATA_DIR = os.path.join(os.environ['HOME'], '.local/share/uzbl/')
+
+# Default config
+config = {
+
+  # Default cookie jar and daemon socket locations.
+  'cookie_socket': os.path.join(CACHE_DIR, 'cookie_daemon_socket'),
+  'cookie_jar': os.path.join(DATA_DIR, 'cookies.txt'),
+
+  # Time out after x seconds of inactivity (set to 0 for never time out).
+  # WARNING: Do not use this option if you are manually launching the daemon.
+  'daemon_timeout': 0,
+
+  # Daemonise by default.
+  'daemon_mode': True,
+
+  # Optionally print helpful debugging messages to the terminal.
+  'verbose': False,
+
+} # End of config dictionary.
+
+
+# ============================================================================
+# ::: End of configuration section :::::::::::::::::::::::::::::::::::::::::::
+# ============================================================================
+
+
+_SCRIPTNAME = os.path.basename(sys.argv[0])
+def echo(msg):
+    '''Prints only if the verbose flag has been set.'''
+
+    if config['verbose']:
+        sys.stderr.write("%s: %s\n" % (_SCRIPTNAME, msg))
+
+
+def error(msg):
+    '''Prints error message and exits.'''
+
+    sys.stderr.write("%s: error: %s\n" % (_SCRIPTNAME, msg))
+    sys.exit(1)
+
+
+def mkbasedir(filepath):
+    '''Create the base directories of the file in the file-path if the dirs
+    don't exist.'''
+
+    dirname = os.path.dirname(filepath)
+    if not os.path.exists(dirname):
+        echo("creating dirs: %r" % dirname)
+        os.makedirs(dirname)
+
+
+def check_socket_health(cookie_socket):
+    '''Check if another process (hopefully a cookie_daemon.py) is listening
+    on the cookie daemon socket. If another process is found to be
+    listening on the socket exit the daemon immediately and leave the
+    socket alone. If the connect fails assume the socket has been abandoned
+    and delete it (to be re-created in the create socket function).'''
+
+    if not os.path.exists(cookie_socket):
+        # What once was is now no more.
+        return None
+
+    if os.path.isfile(cookie_socket):
+        error("regular file at %r is not a socket" % cookie_socket)
+
+    if os.path.isdir(cookie_socket):
+        error("directory at %r is not a socket" % cookie_socket)
+
+    try:
+        sock = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET)
+        sock.connect(cookie_socket)
+        sock.close()
+        error("detected another process listening on %r" % cookie_socket)
+
+    except socket.error:
+        # Failed to connect to cookie_socket so assume it has been
+        # abandoned by another cookie daemon process.
+        if os.path.exists(cookie_socket):
+            echo("deleting abandoned socket %r" % cookie_socket)
+            os.remove(cookie_socket)
+
+
+def daemonize():
+    '''Daemonize the process using the Stevens' double-fork magic.'''
+
+    try:
+        if os.fork():
+            os._exit(0)
+
+    except OSError:
+        print_exc()
+        sys.stderr.write("fork #1 failed")
+        sys.exit(1)
+
+    os.chdir('/')
+    os.setsid()
+    os.umask(0)
+
+    try:
+        if os.fork():
+            os._exit(0)
+
+    except OSError:
+        print_exc()
+        sys.stderr.write("fork #2 failed")
+        sys.exit(1)
+
+    sys.stdout.flush()
+    sys.stderr.flush()
+
+    devnull = '/dev/null'
+    stdin = file(devnull, 'r')
+    stdout = file(devnull, 'a+')
+    stderr = file(devnull, 'a+', 0)
+
+    os.dup2(stdin.fileno(), sys.stdin.fileno())
+    os.dup2(stdout.fileno(), sys.stdout.fileno())
+    os.dup2(stderr.fileno(), sys.stderr.fileno())
+
+
+class CookieMonster:
+    '''The uzbl cookie daemon class.'''
+
+    def __init__(self):
+        '''Initialise class variables.'''
+
+        self.server_socket = None
+        self.jar = None
+        self.last_request = time.time()
+        self._running = False
+
+
+    def run(self):
+        '''Start the daemon.'''
+
+        # The check healthy function will exit if another daemon is detected
+        # listening on the cookie socket and remove the abandoned socket if
+        # there isnt.
+        if os.path.exists(config['cookie_socket']):
+            check_socket_health(config['cookie_socket'])
+
+        # Daemonize process.
+        if config['daemon_mode']:
+            echo("entering daemon mode")
+            daemonize()
+
+        # Register a function to cleanup on exit.
+        atexit.register(self.quit)
+
+        # Make SIGTERM act orderly.
+        signal(SIGTERM, lambda signum, stack_frame: sys.exit(1))
+
+        # Create cookie jar object from file.
+        self.open_cookie_jar()
+
+        # Create a way to exit nested loops by setting a running flag.
+        self._running = True
+
+        while self._running:
+            # Create cookie daemon socket.
+            self.create_socket()
+
+            try:
+                # Enter main listen loop.
+                self.listen()
+
+            except KeyboardInterrupt:
+                self._running = False
+                print
+
+            except socket.error:
+                print_exc()
+
+            except:
+                # Clean up
+                self.del_socket()
+
+                # Raise exception
+                raise
+
+            # Always delete the socket before calling create again.
+            self.del_socket()
+
+
+    def open_cookie_jar(self):
+        '''Open the cookie jar.'''
+
+        cookie_jar = config['cookie_jar']
+        if cookie_jar:
+            mkbasedir(cookie_jar)
+
+        # Create cookie jar object from file.
+        self.jar = cookielib.MozillaCookieJar(cookie_jar)
+
+        if cookie_jar:
+            try:
+                # Attempt to load cookies from the cookie jar.
+                self.jar.load(ignore_discard=True)
+
+                # Ensure restrictive permissions are set on the cookie jar
+                # to prevent other users on the system from hi-jacking your
+                # authenticated sessions simply by copying your cookie jar.
+                os.chmod(cookie_jar, 0600)
+
+            except:
+                pass
+
+
+    def create_socket(self):
+        '''Create AF_UNIX socket for communication with uzbl instances.'''
+
+        cookie_socket = config['cookie_socket']
+        mkbasedir(cookie_socket)
+
+        self.server_socket = socket.socket(socket.AF_UNIX,
+          socket.SOCK_SEQPACKET)
+
+        if os.path.exists(cookie_socket):
+            # Accounting for super-rare super-fast racetrack condition.
+            check_socket_health(cookie_socket)
+
+        self.server_socket.bind(cookie_socket)
+
+        # Set restrictive permissions on the cookie socket to prevent other
+        # users on the system from data-mining your cookies.
+        os.chmod(cookie_socket, 0600)
+
+
+    def listen(self):
+        '''Listen for incoming cookie PUT and GET requests.'''
+
+        echo("listening on %r" % config['cookie_socket'])
+
+        while self._running:
+            # This line tells the socket how many pending incoming connections
+            # to enqueue at once. Raising this number may or may not increase
+            # performance.
+            self.server_socket.listen(1)
+
+            if bool(select.select([self.server_socket], [], [], 1)[0]):
+                client_socket, _ = self.server_socket.accept()
+                self.handle_request(client_socket)
+                self.last_request = time.time()
+                client_socket.close()
+
+            if config['daemon_timeout']:
+                # Checks if the daemon has been idling for too long.
+                idle = time.time() - self.last_request
+                if idle > config['daemon_timeout']:
+                    self._running = False
+
+
+    def handle_request(self, client_socket):
+        '''Connection made, now to serve a cookie PUT or GET request.'''
+
+        # Receive cookie request from client.
+        data = client_socket.recv(8192)
+        if not data:
+            return
+
+        # Cookie argument list in packet is null separated.
+        argv = data.split("\0")
+
+        # Catch the EXIT command sent to kill running daemons.
+        if len(argv) == 1 and argv[0].strip() == "EXIT":
+            self._running = False
+            return
+
+        # Determine whether or not to print cookie data to terminal.
+        print_cookie = (config['verbose'] and not config['daemon_mode'])
+        if print_cookie:
+            print ' '.join(argv[:4])
+
+        action = argv[0]
+
+        uri = urllib2.urlparse.ParseResult(
+          scheme=argv[1],
+          netloc=argv[2],
+          path=argv[3],
+          params='',
+          query='',
+          fragment='').geturl()
+
+        req = urllib2.Request(uri)
+
+        if action == "GET":
+            self.jar.add_cookie_header(req)
+            if req.has_header('Cookie'):
+                cookie = req.get_header('Cookie')
+                client_socket.send(cookie)
+                if print_cookie:
+                    print cookie
+
+            else:
+                client_socket.send("\0")
+
+        elif action == "PUT":
+            cookie = argv[4] if len(argv) > 3 else None
+            if print_cookie:
+                print cookie
+
+            self.put_cookie(req, cookie)
+
+        if print_cookie:
+            print
+
+
+    def put_cookie(self, req, cookie=None):
+        '''Put a cookie in the cookie jar.'''
+
+        hdr = urllib2.httplib.HTTPMessage(\
+          StringIO.StringIO('Set-Cookie: %s' % cookie))
+        res = urllib2.addinfourl(StringIO.StringIO(), hdr,
+          req.get_full_url())
+        self.jar.extract_cookies(res, req)
+        if config['cookie_jar']:
+            self.jar.save(ignore_discard=True)
+
+
+    def del_socket(self):
+        '''Remove the cookie_socket file on exit. In a way the cookie_socket
+        is the daemons pid file equivalent.'''
+
+        if self.server_socket:
+            try:
+                self.server_socket.close()
+
+            except:
+                pass
+
+        self.server_socket = None
+
+        cookie_socket = config['cookie_socket']
+        if os.path.exists(cookie_socket):
+            echo("deleting socket %r" % cookie_socket)
+            os.remove(cookie_socket)
+
+
+    def quit(self):
+        '''Called on exit to make sure all loose ends are tied up.'''
+
+        self.del_socket()
+        sys.exit(0)
+
+
+def main():
+    '''Main function.'''
+
+    # Define command line parameters.
+    parser = OptionParser()
+    parser.add_option('-n', '--no-daemon', dest='no_daemon',
+      action='store_true', help="don't daemonise the process.")
+
+    parser.add_option('-v', '--verbose', dest="verbose",
+      action='store_true', help="print verbose output.")
+
+    parser.add_option('-t', '--daemon-timeout', dest='daemon_timeout',
+      action="store", metavar="SECONDS", help="shutdown the daemon after x "\
+      "seconds inactivity. WARNING: Do not use this when launching the "\
+      "cookie daemon manually.")
+
+    parser.add_option('-s', '--cookie-socket', dest="cookie_socket",
+      metavar="SOCKET", help="manually specify the socket location.")
+
+    parser.add_option('-j', '--cookie-jar', dest='cookie_jar',
+      metavar="FILE", help="manually specify the cookie jar location.")
+
+    parser.add_option('-m', '--memory', dest='memory', action='store_true',
+      help="store cookies in memory only - do not write to disk")
+
+    # Parse the command line arguments.
+    (options, args) = parser.parse_args()
+
+    if len(args):
+        error("unknown argument %r" % args[0])
+
+    if options.verbose:
+        config['verbose'] = True
+        echo("verbose mode on")
+
+    if options.no_daemon:
+        echo("daemon mode off")
+        config['daemon_mode'] = False
+
+    if options.cookie_socket:
+        echo("using cookie_socket %r" % options.cookie_socket)
+        config['cookie_socket'] = options.cookie_socket
+
+    if options.cookie_jar:
+        echo("using cookie_jar %r" % options.cookie_jar)
+        config['cookie_jar'] = options.cookie_jar
+
+    if options.memory:
+        echo("using memory %r" % options.memory)
+        config['cookie_jar'] = None
+
+    if options.daemon_timeout:
+        try:
+            config['daemon_timeout'] = int(options.daemon_timeout)
+            echo("set timeout to %d seconds" % config['daemon_timeout'])
+
+        except ValueError:
+            error("expected int argument for -t, --daemon-timeout")
+
+    # Expand $VAR's in config keys that relate to paths.
+    for key in ['cookie_socket', 'cookie_jar']:
+        if config[key]:
+            config[key] = os.path.expandvars(config[key])
+
+    CookieMonster().run()
+
+
+if __name__ == "__main__":
+    main()
diff --git a/examples/data/uzbl/scripts/download.sh b/examples/data/uzbl/scripts/download.sh
index aa1ca09..c8eb6ba 100755
--- a/examples/data/uzbl/scripts/download.sh
+++ b/examples/data/uzbl/scripts/download.sh
@@ -8,6 +8,9 @@ GET="wget --user-agent=Firefox"
 dest="$HOME"
 url="$8"
 
+http_proxy="$9"
+export http_proxy
+
 test "x$url" = "x" && { echo "you must supply a url! ($url)"; exit 1; }
 
 # only changes the dir for the $get sub process
diff --git a/examples/data/uzbl/scripts/history.sh b/examples/data/uzbl/scripts/history.sh
index d726f9c..7c83aa6 100755
--- a/examples/data/uzbl/scripts/history.sh
+++ b/examples/data/uzbl/scripts/history.sh
@@ -1,6 +1,5 @@
 #!/bin/sh
-#TODO: strip 'http://' part
 
 file=${XDG_DATA_HOME:-$HOME/.local/share}/uzbl/history
 [ -d `dirname $file` ] || exit 1
-echo "$8 $6 $7" >> $file
+echo `date +'%Y-%m-%d %H:%M:%S'`" $6 $7" >> $file
diff --git a/examples/data/uzbl/scripts/load_url_from_bookmarks.sh b/examples/data/uzbl/scripts/load_url_from_bookmarks.sh
index f57d7b3..1e9f9e7 100755
--- a/examples/data/uzbl/scripts/load_url_from_bookmarks.sh
+++ b/examples/data/uzbl/scripts/load_url_from_bookmarks.sh
@@ -17,4 +17,4 @@ else
 fi
 
 #[ -n "$goto" ] && echo "uri $goto" > $4
-[ -n "$goto" ] && uzblctrl -s $5 -c "uri $goto"
+[ -n "$goto" ] && echo "uri $goto" | socat - unix-connect:$5
diff --git a/examples/data/uzbl/scripts/load_url_from_history.sh b/examples/data/uzbl/scripts/load_url_from_history.sh
index 1eaf0f2..62e02ac 100755
--- a/examples/data/uzbl/scripts/load_url_from_history.sh
+++ b/examples/data/uzbl/scripts/load_url_from_history.sh
@@ -21,4 +21,4 @@ else
 fi
 
 [ -n "$goto" ] && echo "uri $goto" > $4
-#[ -n "$goto" ] && uzblctrl -s $5 -c "uri $goto"
+#[ -n "$goto" ] && echo "uri $goto" | socat - unix-connect:$5
diff --git a/examples/data/uzbl/scripts/scheme.py b/examples/data/uzbl/scripts/scheme.py
new file mode 100755
index 0000000..7286703
--- /dev/null
+++ b/examples/data/uzbl/scripts/scheme.py
@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+
+import os, subprocess, sys, urlparse
+
+def detach_open(cmd):
+    # Thanks to the vast knowledge of Laurence Withers (lwithers) and this message:
+    # http://mail.python.org/pipermail/python-list/2006-November/587523.html
+    if not os.fork():
+        null = os.open(os.devnull,os.O_WRONLY)
+        for i in range(3): os.dup2(null,i)
+        os.close(null)
+        subprocess.Popen(cmd)
+    print 'USED'
+
+if __name__ == '__main__':
+    uri = sys.argv[8]
+    u = urlparse.urlparse(uri)
+    if u.scheme == 'mailto':
+        detach_open(['xterm', '-e', 'mail %s' % u.path])
+    elif u.scheme == 'xmpp':
+        detach_open(['gajim-remote', 'open_chat', uri])
+    elif u.scheme == 'git':
+        detach_open(['git', 'clone', uri], cwd=os.path.expanduser('~/src'))
diff --git a/examples/data/uzbl/scripts/uzbl_tabbed.py b/examples/data/uzbl/scripts/uzbl_tabbed.py
index b7612e6..9ffa97d 100755
--- a/examples/data/uzbl/scripts/uzbl_tabbed.py
+++ b/examples/data/uzbl/scripts/uzbl_tabbed.py
@@ -1317,7 +1317,9 @@ class UzblTabbed:
         for (tab, uzbl) in self.tabs.items():
             uzbl.send("exit")
 
-        # Add a gobject timer to make sure the application force-quits after a period.
+        # Add a gobject timer to make sure the application force-quits after a
+        # reasonable period. Calling quit when all the tabs haven't had time to
+        # close should be a last resort.
         timer = "force-quit"
         timerid = timeout_add(5000, self.quit, timer)
         self._timers[timer] = timerid
diff --git a/examples/data/uzbl/scripts/uzblcat b/examples/data/uzbl/scripts/uzblcat
index 5c3063e..e955608 100755
--- a/examples/data/uzbl/scripts/uzblcat
+++ b/examples/data/uzbl/scripts/uzblcat
@@ -1,20 +1,12 @@
-#!/usr/bin/env perl
+#!/usr/bin/env python
 # uzblcat - safely push html to uzbl
 # See http://www.uzbl.org/wiki/html-mode
-use strict; use warnings;
 
-my $html;
-local $/;      # slurp files
-# automagically choose to read from stdin/files/...
-$html .= $_ for <>;
+from sys import stdin, stdout
 
-my $endmarker = rand;
-$endmarker .= rand() while $html =~ /^\Q$endmarker\E$/m;
+stdout.write("uri data:text/html,")
+for line in stdin:
+    stdout.write(line[0:-1])
+
+# vim: set noet ff=unix
 
-print "set base_url = $ENV{BASE_URL}\n" if $ENV{BASE_URL};
-print << "EOS";
-set html_endmarker = $endmarker
-set mode = 1
-$html
-$endmarker
-EOS