summaryrefslogtreecommitdiff
path: root/extensions/perdomainsettings
blob: c72958ca7775a16c89f213ee4a3c445367525782 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
//
//  Copyright (c) 2012 Stefan Bolte <portix@gmx.net>
//
//  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, write to the Free Software Foundation, Inc.,
//  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//


/*
 * Per domain settings extension
 *
 * This extensions can be used for per-domain-settings. Valid settings are
 * the properties of WebKitWebSettings but in camelcase, see 
 * http://webkitgtk.org/reference/webkitgtk/unstable/WebKitWebSettings.html
 * for details. 
 *
 * To use this extension load it with a userscript in 
 * $HOME/.config/dwb/userscripts/, e.g. 
 *
 * ------------------------------------------------------------------------------
 * |#!javascript                                                                | 
 * |                                                                            | 
 * |extensions.load("perdomainsettings");                                       | 
 * ------------------------------------------------------------------------------
 *
 * The config can consist of four objects, 
 *
 * domains:   Settings applied based on the second level domain
 *
 * hosts:     Settings applied based on the hostname
 *
 * uris:      Settings applied based on the uri
 *
 * defaults:  Default settings, for each setting in domains, hosts and uris a
 *              default-value should be specified
 *
 * Example extensionrc: 
 *
 * ------------------------------------------------------------------------------
 * |return {                                                                    |
 * |   foo : { ... },                                                           |
 * |                                                                            |
 * |   perdomainsettings : {                                                    |
 * |     domains : {                                                            |
 * |        "example.com" : {                                                   |
 * |             "enablePlugins"  : true                                        |
 * |        },                                                                  |
 * |        "example.uk.com" :  {                                               |
 * |             "enablePlugins"  : true,                                       |
 * |             "enableScripts"  : false                                       |
 * |        }                                                                   |
 * |     },                                                                     |
 * |     hosts : {                                                              |
 * |        "www.example1.com" :  {                                             |
 * |             "autoLoadImages" : true                                        |
 * |        }                                                                   |
 * |     },                                                                     |
 * |     uris : {                                                               |
 * |        "http://www.example2.com/login.php" :  {                            |
 * |             "autoLoadImages" : false                                       |
 * |        }                                                                   |
 * |     },                                                                     |
 * |     defaults : {                                                           |
 * |        "enablePlugins"   : false,                                          |
 * |        "autoLoadImages"  : false,                                          |
 * |        "enableScripts"   :  true                                           |
 * |     }                                                                      |
 * |   },                                                                       |
 * |                                                                            |
 * |   bar : { ... }                                                            |
 * |}                                                                           |
 * ------------------------------------------------------------------------------
 *
 * Example using extensions.load: 
 *
 * ------------------------------------------------------------------------------
 * |extensions.load("perdomainsettings", {                                      |
 * |  domains : { "example.com" : { "enablePlugins" : true }  },                |
 * |  defaults : { "enablePlugins" : false }                                    |
 * |});                                                                         |
 * ------------------------------------------------------------------------------
 *
 * */ 

var me = "perdomainsettings";
var domains = null;
var hosts = null;
var uris = null;
var defaults = null;
var webviews = [];
var sigNavigation = -1;
var sigCloseTab = -1;

var defaultConfig = {
//<DEFAULT_CONFIG
  // Settings applied based on the second level domain, e.g.
  // domains : { "example.com" : { autoLoadImages : true } }, 
  domains : {},

  //Settings applied based on the hostname
  // hosts : { "www.example.com" : { autoLoadImages : true } }, 
  hosts : {},

  // Settings applied based on the uri
  // uris : { "http://www.example.com/foo/" : { autoLoadImages : true } }, 
  uris : {},

  // Default settings, for each setting in domains, hosts and uris a
  // default-value should be specified, e.g.
  // defaults : { autoLoadImages : false }, 
  defaults : {}

//>DEFAULT_CONFIG
};

function apply(o, settings) {
  var key;
  var defaults = true;
  var websettings = o.settings;
  for (key in settings) {
    if (!o.set[key]) {
      websettings[key] = settings[key];
      o.set[key] = true;
    }
    else {
      defaults = false;
    }
  }
  return defaults;
}

function onNavigation(wv, frame, request, action) {
  var length = webviews.length; 
  var i, host, domain;
  var found = false;
  var o = null;
  for (i=0; i<length && o === null; i++) {
    if (webviews[i].webview === wv) {
      o = webviews[i];
    }
  }
  if (o === null) {
    o = { webview : wv, defaults : false, settings : wv.settings };
    webviews.push(o);
  }
  o.set = {};
  if (frame === wv.mainFrame) {
    try {
      var uri = request.uri;
      host = request.message.uri.host;
      domain = util.domainFromHost(host);
      if (domains[domain]) {
        apply(o, domains[domain]);
        o.defaults = false;
      }
      if (hosts[host]) {
        apply(o, hosts[host]);
        o.defaults = false;
      }
      if (uris[uri]) {
        apply(o, uris[uri]);
        o.defaults = false;
      }
      if (o.defaults === false && apply(o, defaults)) {
        o.defaults = true;
      }
    }
    catch (e) {
      extensions.error(me, e);
    }
  }
}
function onCloseTab(wv) {
  var i;
  for (i=0; i<webviews.length; i++) {
    if (webviews[i].webview === wv) {
      webviews.splice(i, 1);
      return;
    }
  }
}

return {
  init : function (config) {
    if (!config) {
      extensions.error(me, "Missing config");
      return false;
    }
    domains = config.domains || defaultConfig.domains;
    hosts = config.hosts || defaultConfig.hosts;
    uris = config.uris || defaultConfig.uris;
    defaults = config.defaults || defaultConfig.defaults;
    sigNavigation = signals.connect("navigation", onNavigation);
    sigCloseTab = signals.connect("closeTab", onCloseTab);
    return true;
  },
  end : function () {
    if (sigNavigation >= 0) {
      signals.disconnect(sigNavigation);
      sigNavigation = -1;
    }
    if (sigCloseTab >= 0) {
      signals.disconnect(sigCloseTab);
      sigCloseTab = -1;
    }
  }
};

// vim: set ft=javascript: