make cookies.py default sample cookie script
[uzbl-mobile] / examples / scripts / cookies.sh
1 #!/bin/bash
2
3 # THIS IS EXPERIMENTAL AND COULD BE INSECURE !!!!!!
4
5 # 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
6 # we use the cookies.txt format (See http://kb.mozillazine.org/Cookies.txt)
7 # This is one textfile with entries like this:
8 # kb.mozillazine.org    FALSE   /       FALSE   1146030396      wikiUserID      16993
9 # domain alow-read-other-subdomains path http-required expiration name value  
10 # you probably want your cookies config file in your $XDG_CONFIG_HOME ( eg $HOME/.config/uzbl/cookies)
11 # 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"
12 # MAYBE TODO: allow user to edit cookie before saving. this cannot be done with zenity :(
13 # TODO: different cookie paths per config (eg per group of uzbl instances)
14
15 # TODO: correct implementation.
16 # see http://curl.haxx.se/rfc/cookie_spec.html
17 # http://en.wikipedia.org/wiki/HTTP_cookie
18
19 # TODO : check expires= before sending.
20 # write sample script that cleans up cookies dir based on expires attribute.
21 # TODO: check uri against domain attribute. and path also.
22 # implement secure attribute.
23 # support blocking or not for 3rd parties
24 # http://kb.mozillazine.org/Cookies.txt
25 # don't always append cookies, sometimes we need to overwrite
26
27 [ -f /usr/share/uzbl/examples/configs/cookies ] && cookie_config=/usr/share/uzbl/examples/configs/cookies
28 [ -f $XDG_CONFIG_HOME/uzbl/cookies            ] && cookie_config=$XDG_CONFIG_HOME/uzbl/cookies
29 [ -f ./examples/configs/cookies               ] && cookie_config=./examples/configs/cookies #useful when developing
30 [ -z "$cookie_config" ] && exit 1
31
32 [ -d /usr/share/uzbl/examples/data ] && cookie_data=/usr/share/uzbl/examples/data/cookies.txt
33 [ -d $XDG_DATA_HOME/uzbl/          ] && cookie_data=$XDG_DATA_HOME/uzbl/cookies.txt
34 [ -d ./examples/data/              ] && cookie_data=./examples/data/cookies.txt #useful when developing
35 [ -z "$cookie_data" ] && exit 1
36
37
38 notifier=
39 #notifier=notify-send
40 #notify_wrapper () {
41 #       echo "$@" >> $HOME/cookielog
42 #}
43 #notifier=notifier_wrapper
44
45 # if this variable is set, we will use it to inform you when and which cookies we store, and when/which we send.
46 # it's primarily used for debugging
47 notifier=
48 which zenity &>/dev/null || exit 2
49
50 # Example cookie:
51 # test_cookie=CheckForPermission; expires=Thu, 07-May-2009 19:17:55 GMT; path=/; domain=.doubleclick.net
52
53 # uri=$6
54 # uri=${uri/http:\/\/} # strip 'http://' part
55 # host=${uri/\/*/}
56 action=$8 # GET/PUT
57 host=$9
58 shift
59 path=$9
60 shift
61 cookie=$9
62
63 field_domain=$host
64 field_path=$path
65 field_name=
66 field_value=
67 field_exp='end_session'
68
69 function notify () {
70         [ -n "$notifier" ] && $notifier "$@"
71 }
72
73
74 # FOR NOW LETS KEEP IT SIMPLE AND JUST ALWAYS PUT AND ALWAYS GET
75 function parse_cookie () {
76         IFS=$';'
77         first_pair=1
78         for pair in $cookie
79         do
80                 if [ "$first_pair" == 1 ]
81                 then
82                         field_name=${pair%%=*}
83                         field_value=${pair#*=}
84                         first_pair=0
85                 else
86                         read -r pair <<< "$pair" #strip leading/trailing wite space
87                         key=${pair%%=*}
88                         val=${pair#*=}
89                         [ "$key" == expires ] && field_exp=`date -u -d "$val" +'%s'`
90                         # TODO: domain
91                         [ "$key" == path ] && field_path=$val
92                 fi
93         done
94         unset IFS
95 }
96
97 # match cookies in cookies.txt against hostname and path
98 function get_cookie () {
99         path_esc=${path//\//\\/}
100         search="^[^\t]*$host\t[^\t]*\t$path_esc"
101         cookie=`awk "/$search/" $cookie_data 2>/dev/null | tail -n 1`
102         if [ -z "$cookie" ]
103         then
104                 notify "Get_cookie: search: $search in $cookie_data -> no result"
105                 false
106         else
107                 notify "Get_cookie: search: $search in $cookie_data -> result: $cookie"
108                 read domain alow_read_other_subdomains path http_required expiration name value <<< "$cookie"
109                 cookie="$name=$value" 
110                 true
111         fi
112 }
113
114 function save_cookie () {
115         if parse_cookie
116         then
117                 data="$field_domain\tFALSE\t$field_path\tFALSE\t$field_exp\t$field_name\t$field_value"
118                 notify "save_cookie: adding $data to $cookie_data"
119                 echo -e "$data" >> $cookie_data
120         else
121                 notify "not saving a cookie. since we don't have policies yet, parse_cookie must have returned false. this is a bug"
122         fi
123 }
124
125 [ $action == PUT ] && save_cookie
126 [ $action == GET ] && get_cookie && echo "$cookie"
127
128 exit
129
130
131 # TODO: implement this later.
132 # $1 = section (TRUSTED or DENY)
133 # $2 =url
134 function match () {
135         sed -n "/$1/,/^\$/p" $cookie_config 2>/dev/null | grep -q "^$host"
136 }
137
138 function fetch_cookie () {
139         cookie=`cat $cookie_data`
140 }
141
142 function store_cookie () {
143         echo $cookie > $cookie_data
144 }
145
146 if match TRUSTED $host
147 then
148         [ $action == PUT ] && store_cookie $host
149         [ $action == GET ] && fetch_cookie && echo "$cookie"
150 elif ! match DENY $host
151 then
152         [ $action == PUT ] &&                 cookie=`zenity --entry --title 'Uzbl Cookie handler' --text "Accept this cookie from $host ?" --entry-text="$cookie"` && store_cookie $host
153         [ $action == GET ] && fetch_cookie && cookie=`zenity --entry --title 'Uzbl Cookie handler' --text "Submit this cookie to $host ?"   --entry-text="$cookie"` && echo $cookie
154 fi
155 exit 0