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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
/*******************************************************************************
µBlock - a Chromium browser extension to block requests.
Copyright (C) 2014 Raymond Hill
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/}.
Home: https://github.com/gorhill/uBlock
*/
// So there might be memory leaks related to the direct use of sendMessage(),
// as per https://code.google.com/p/chromium/issues/detail?id=320723. The issue
// is not marked as resolved, and the last message from chromium dev is:
//
// "You can construct Port objects (runtime.connect) and emulate sendMessage
// "behaviour. The bug is that sendMessage doesn't clean up its Ports."
//
// So the point here is to have an infrastructure which allows relying more on
// direct use of Port objects rather than going through sendMessage().
/******************************************************************************/
/*******************************************************************************
// Here this is the "server"-side implementation.
//
// Reference client-side implementation is found in:
//
// messaging-client.js
//
// For instance, it needs to be cut & pasted for content scripts since
// I can not include in a simple way js file content from another js file.
*******************************************************************************/
/******************************************************************************/
µBlock.messaging = (function() {
/******************************************************************************/
var nameToPortMap = {};
var nameToListenerMap = {};
var nullFunc = function(){};
/******************************************************************************/
var listenerNameFromPortName = function(portName) {
var pos = portName.indexOf('/');
if ( pos <= 0 ) {
return '';
}
return portName.slice(0, pos);
};
var listenerFromPortName = function(portName) {
return nameToListenerMap[listenerNameFromPortName(portName)];
};
/******************************************************************************/
var listen = function(portName, callback) {
var listener = nameToListenerMap[portName];
if ( listener && listener !== callback ) {
throw 'Only one listener allowed';
}
nameToListenerMap[portName] = callback;
};
/******************************************************************************/
var tell = function(target, msg) {
target += '/';
for ( var portName in nameToPortMap ) {
if ( nameToPortMap.hasOwnProperty(portName) === false ) {
continue;
}
if ( portName.indexOf(target) === 0 ) {
nameToPortMap[portName].postMessage({ id: -1, msg: msg });
}
}
};
/******************************************************************************/
var announce = function(msg) {
// Background page handler
defaultHandler(msg, null, nullFunc);
// Extension pages & content scripts handlers
var port;
for ( var portName in nameToPortMap ) {
if ( nameToPortMap.hasOwnProperty(portName) === false ) {
continue;
}
nameToPortMap[portName].postMessage({ id: -1, msg: msg });
}
};
/******************************************************************************/
var onMessage = function(request, port) {
// Annoucement: dispatch everywhere.
if ( request.id < 0 ) {
announce(request.msg);
return;
}
var listener = listenerFromPortName(port.name) || defaultHandler;
var reqId = request.id;
// Being told
if ( reqId <= 0 ) {
listener(request.msg, port.sender, nullFunc);
return;
}
// Being asked
listener(request.msg, port.sender, function(response) {
port.postMessage({
id: reqId,
msg: response !== undefined ? response : null
});
});
};
/******************************************************************************/
// Default is for commonly used message.
function defaultHandler(request, sender, callback) {
// Async
switch ( request.what ) {
case 'getAssetContent':
if ( /^https?:\/\//.test(request.url) ) {
return µBlock.assets.getExternal(request.url, callback);
}
return µBlock.assets.get(request.url, callback);
case 'loadUbiquitousAllowRules':
return µBlock.loadUbiquitousWhitelists();
default:
break;
}
// Sync
var response;
switch ( request.what ) {
case 'forceReloadTab':
µBlock.forceReload(request.pageURL);
break;
case 'getUserSettings':
response = µBlock.userSettings;
break;
case 'gotoExtensionURL':
µBlock.utils.gotoExtensionURL(request.url);
break;
case 'gotoURL':
µBlock.utils.gotoURL(request);
break;
case 'reloadAllFilters':
µBlock.reloadPresetBlacklists(request.switches);
break;
case 'userSettings':
response = µBlock.changeUserSettings(request.name, request.value);
break;
default:
// console.error('µBlock> messaging.js / defaultHandler > unknown request: %o', request);
break;
}
callback(response);
}
/******************************************************************************/
// Port disconnected, relay this information to apropriate listener.
var onDisconnect = function(port) {
// Notify listener of the disconnection -- using a reserved message id.
var listener = listenerFromPortName(port.name) || defaultHandler;
var msg = {
'what': 'disconnected',
'which': listenerNameFromPortName(port.name)
};
listener(msg, port.sender, nullFunc);
// Cleanup port if no longer in use.
var port = nameToPortMap[port.name];
if ( port ) {
delete nameToPortMap[port.name];
port.onMessage.removeListener(onMessage);
port.onDisconnect.removeListener(onDisconnect);
}
};
/******************************************************************************/
var onConnect = function(port) {
// We must have a port name.
if ( !port.name ) {
throw 'µBlock> messaging.js / onConnectHandler(): no port name!';
}
// Port should not already exist.
if ( nameToPortMap[port.name] ) {
throw 'µBlock> messaging.js / onConnectHandler(): port already exists!';
}
nameToPortMap[port.name] = port;
port.onMessage.addListener(onMessage);
port.onDisconnect.addListener(onDisconnect);
};
/******************************************************************************/
chrome.runtime.onConnect.addListener(onConnect);
/******************************************************************************/
return {
listen: listen,
tell: tell,
announce: announce,
defaultHandler: defaultHandler
};
/******************************************************************************/
})();
/******************************************************************************/
|