make cookies.py default sample cookie script
[uzbl-mobile] / examples / scripts / cookies.sh
index 02fb471..a875482 100755 (executable)
@@ -1,7 +1,14 @@
 #!/bin/bash
-# this is an example script of how you could manage your cookies..
-# you probably want your cookies config file in your $XDG_CONFIG_HOME ( eg $HOME/.config/uzbl/cookies)
 
+# THIS IS EXPERIMENTAL AND COULD BE INSECURE !!!!!!
+
+# this is an example bash script of how you could manage your cookies. it is very raw and basic and not as good as cookies.py
+# we use the cookies.txt format (See http://kb.mozillazine.org/Cookies.txt)
+# This is one textfile with entries like this:
+# kb.mozillazine.org   FALSE   /       FALSE   1146030396      wikiUserID      16993
+# domain alow-read-other-subdomains path http-required expiration name value  
+# you probably want your cookies config file in your $XDG_CONFIG_HOME ( eg $HOME/.config/uzbl/cookies)
+# Note. in uzbl there is no strict definition on what a session is.  it's YOUR job to clear cookies marked as end_session if you want to keep cookies only valid during a "session"
 # MAYBE TODO: allow user to edit cookie before saving. this cannot be done with zenity :(
 # TODO: different cookie paths per config (eg per group of uzbl instances)
 
 # implement secure attribute.
 # support blocking or not for 3rd parties
 # http://kb.mozillazine.org/Cookies.txt
+# don't always append cookies, sometimes we need to overwrite
 
-if [ -f /usr/share/uzbl/examples/configs/cookies ]
-then
-       file=/usr/share/uzbl/examples/configs/cookies
-else
-       file=./examples/configs/cookies #useful when developing
-fi
+[ -f /usr/share/uzbl/examples/configs/cookies ] && cookie_config=/usr/share/uzbl/examples/configs/cookies
+[ -f $XDG_CONFIG_HOME/uzbl/cookies            ] && cookie_config=$XDG_CONFIG_HOME/uzbl/cookies
+[ -f ./examples/configs/cookies               ] && cookie_config=./examples/configs/cookies #useful when developing
+[ -z "$cookie_config" ] && exit 1
 
-if [ -d $XDG_DATA_HOME/uzbl/cookies ]
-then
-       cookie_dir=$XDG_DATA_HOME/uzbl/cookies
-else
-       cookie_dir=./examples/data
-fi
+[ -d /usr/share/uzbl/examples/data ] && cookie_data=/usr/share/uzbl/examples/data/cookies.txt
+[ -d $XDG_DATA_HOME/uzbl/          ] && cookie_data=$XDG_DATA_HOME/uzbl/cookies.txt
+[ -d ./examples/data/              ] && cookie_data=./examples/data/cookies.txt #useful when developing
+[ -z "$cookie_data" ] && exit 1
+
+
+notifier=
+#notifier=notify-send
+#notify_wrapper () {
+#      echo "$@" >> $HOME/cookielog
+#}
+#notifier=notifier_wrapper
 
+# if this variable is set, we will use it to inform you when and which cookies we store, and when/which we send.
+# it's primarily used for debugging
+notifier=
 which zenity &>/dev/null || exit 2
 
-uri=$6
-uri=${uri/http:\/\/} # strip 'http://' part
+# Example cookie:
+# test_cookie=CheckForPermission; expires=Thu, 07-May-2009 19:17:55 GMT; path=/; domain=.doubleclick.net
+
+# uri=$6
+# uri=${uri/http:\/\/} # strip 'http://' part
+# host=${uri/\/*/}
 action=$8 # GET/PUT
+host=$9
+shift
+path=$9
+shift
 cookie=$9
-host=${uri/\/*/}
 
+field_domain=$host
+field_path=$path
+field_name=
+field_value=
+field_exp='end_session'
+
+function notify () {
+       [ -n "$notifier" ] && $notifier "$@"
+}
+
+
+# FOR NOW LETS KEEP IT SIMPLE AND JUST ALWAYS PUT AND ALWAYS GET
+function parse_cookie () {
+       IFS=$';'
+       first_pair=1
+       for pair in $cookie
+       do
+               if [ "$first_pair" == 1 ]
+               then
+                       field_name=${pair%%=*}
+                       field_value=${pair#*=}
+                       first_pair=0
+               else
+                       read -r pair <<< "$pair" #strip leading/trailing wite space
+                       key=${pair%%=*}
+                       val=${pair#*=}
+                       [ "$key" == expires ] && field_exp=`date -u -d "$val" +'%s'`
+                       # TODO: domain
+                       [ "$key" == path ] && field_path=$val
+               fi
+       done
+       unset IFS
+}
+
+# match cookies in cookies.txt against hostname and path
+function get_cookie () {
+       path_esc=${path//\//\\/}
+       search="^[^\t]*$host\t[^\t]*\t$path_esc"
+       cookie=`awk "/$search/" $cookie_data 2>/dev/null | tail -n 1`
+       if [ -z "$cookie" ]
+       then
+               notify "Get_cookie: search: $search in $cookie_data -> no result"
+               false
+       else
+               notify "Get_cookie: search: $search in $cookie_data -> result: $cookie"
+               read domain alow_read_other_subdomains path http_required expiration name value <<< "$cookie"
+               cookie="$name=$value" 
+               true
+       fi
+}
+
+function save_cookie () {
+       if parse_cookie
+       then
+               data="$field_domain\tFALSE\t$field_path\tFALSE\t$field_exp\t$field_name\t$field_value"
+               notify "save_cookie: adding $data to $cookie_data"
+               echo -e "$data" >> $cookie_data
+       else
+               notify "not saving a cookie. since we don't have policies yet, parse_cookie must have returned false. this is a bug"
+       fi
+}
+
+[ $action == PUT ] && save_cookie
+[ $action == GET ] && get_cookie && echo "$cookie"
+
+exit
 
 
+# TODO: implement this later.
 # $1 = section (TRUSTED or DENY)
 # $2 =url
 function match () {
-       sed -n "/$1/,/^\$/p" $file 2>/dev/null | grep -q "^$host"
+       sed -n "/$1/,/^\$/p" $cookie_config 2>/dev/null | grep -q "^$host"
 }
 
 function fetch_cookie () {
-       cookie=`cat $cookie_dir/$host.cookie`
+       cookie=`cat $cookie_data`
 }
 
 function store_cookie () {
-       echo $cookie > $cookie_dir/$host.cookie
+       echo $cookie > $cookie_data
 }
 
 if match TRUSTED $host