Merge branch 'dev/in-webkit-downloads' into experimental

Conflicts:
	examples/data/scripts/download.sh

3 files changed, 90 insertions, 18 deletions

diff --git a/examples/config/config b/examples/config/config
index e282bb9..5d7073f 100644
--- a/examples/config/config
+++ b/examples/config/config
@@ -45,6 +45,7 @@ set scripts_dir      = @data_home/uzbl:@prefix/share/uzbl/examples/data:scripts
 set cookie_handler      = talk_to_socket @cache_home/uzbl/cookie_daemon_socket
 set scheme_handler      = sync_spawn @scripts_dir/scheme.py
 set authentication_handler = sync_spawn @scripts_dir/auth.py
+set download_handler    = sync_spawn @scripts_dir/download.sh
 
 # === Dynamic event handlers =================================================
 
@@ -106,7 +107,9 @@ set name_section      = <span foreground="khaki">\@[\@NAME]\@</span>
 set status_section    = <span foreground="orange">\@status_message</span>
 set selected_section  = <span foreground="#606060">\@[\@SELECTED_URI]\@</span>
 
-set status_format     = <span font_family="monospace">@mode_section @keycmd_section @progress_section @uri_section @name_section @status_section @scroll_section @selected_section</span>
+set download_section  = <span foreground="white">\@downloads</span>
+
+set status_format     = <span font_family="monospace">@mode_section @keycmd_section @progress_section @uri_section @name_section @status_section @scroll_section @selected_section @download_section</span>
 
 set title_format_long = \@keycmd_prompt \@raw_modcmd \@raw_keycmd \@TITLE - Uzbl browser <\@NAME> \@SELECTED_URI
 
diff --git a/examples/data/plugins/downloads.py b/examples/data/plugins/downloads.py
new file mode 100644
index 0000000..7bf32d7
--- /dev/null
+++ b/examples/data/plugins/downloads.py
@@ -0,0 +1,69 @@
+# this plugin does a very simple display of download progress. to use it, add
+# @downloads to your status_format.
+
+import os
+ACTIVE_DOWNLOADS = {}
+
+# after a download's status has changed this is called to update the status bar
+def update_download_section(uzbl):
+    global ACTIVE_DOWNLOADS
+
+    if len(ACTIVE_DOWNLOADS):
+        # add a newline before we list downloads
+        result = '&#10;downloads:'
+        for path in ACTIVE_DOWNLOADS:
+            # add each download
+            fn = os.path.basename(path)
+            progress, = ACTIVE_DOWNLOADS[path]
+
+            dl = " %s (%d%%)" % (fn, progress * 100)
+
+            # replace entities to make sure we don't break our markup
+            # (this could be done with an @[]@ expansion in uzbl, but then we
+            # can't use the &#10; above to make a new line)
+            dl = dl.replace("&", "&amp;").replace("<", "&lt;")
+            result += dl
+    else:
+        result = ''
+
+    # and the result gets saved to an uzbl variable that can be used in
+    # status_format
+    if uzbl.config.get('downloads', '') != result:
+          uzbl.config['downloads'] = result
+
+def download_started(uzbl, destination_path):
+    # add to the list of active downloads
+    global ACTIVE_DOWNLOADS
+    ACTIVE_DOWNLOADS[destination_path] = (0.0,)
+
+    # update the progress
+    update_download_section(uzbl)
+
+def download_progress(uzbl, args):
+    # parse the arguments
+    s = args.rindex(' ')
+    destination_path = args[:s]
+    progress = float(args[s+1:])
+
+    # update the progress
+    global ACTIVE_DOWNLOADS
+    ACTIVE_DOWNLOADS[destination_path] = (progress,)
+
+    # update the status bar variable
+    update_download_section(uzbl)
+
+def download_complete(uzbl, destination_path):
+    # remove from the list of active downloads
+    global ACTIVE_DOWNLOADS
+    del ACTIVE_DOWNLOADS[destination_path]
+
+    # update the status bar variable
+    update_download_section(uzbl)
+
+# plugin init hook
+def init(uzbl):
+    connect_dict(uzbl, {
+        'DOWNLOAD_STARTED':     download_started,
+        'DOWNLOAD_PROGRESS':    download_progress,
+        'DOWNLOAD_COMPLETE':    download_complete,
+    })
diff --git a/examples/data/scripts/download.sh b/examples/data/scripts/download.sh
index b378a85..df7a571 100755
--- a/examples/data/scripts/download.sh
+++ b/examples/data/scripts/download.sh
@@ -1,26 +1,26 @@
 #!/bin/sh
-# just an example of how you could handle your downloads
-# try some pattern matching on the uri to determine what we should do
+#
+# uzbl's example configuration sets this script up as its download_handler.
+# when uzbl starts a download it runs this script.
+# if the script prints a file path to stdout, uzbl will save the download to
+# that path.
+# if nothing is printed to stdout, the download will be cancelled.
 
 shift 7
 . $UZBL_UTIL_DIR/uzbl-dir.sh
 
-# Some sites block the default wget --user-agent..
-GET="wget --user-agent=Firefox --content-disposition --load-cookies=$UZBL_COOKIE_FILE"
+# the URL that is being downloaded
+uri=$1
 
-url="$1"
+# a filename suggested by the server or based on the URL
+suggested_filename=${2:-$(echo "$uri" | sed 's/\W/-/g')}
 
-http_proxy="$2"
-export http_proxy
+# the mimetype of the file being downloaded
+content_type=$3
 
-if [ -z "$url" ]; then
-    echo "you must supply a url! ($url)"
-    exit 1
-fi
+# the size of the downloaded file in bytes. this is not always accurate, since
+# the server might not have sent a size with its response headers.
+total_size=$4
 
-# only changes the dir for the $get sub process
-if echo "$url" | grep -E '.*\.torrent' >/dev/null; then
-    ( cd "$UZBL_DOWNLOAD_DIR"; $GET "$url")
-else
-    ( cd "$UZBL_DOWNLOAD_DIR"; $GET "$url")
-fi
+# just save the file to the default directory with the suggested name
+echo $UZBL_DOWNLOAD_DIR/$suggested_filename