|
1
|
/**
|
|
2
|
* Hachette display panel logic
|
|
3
|
*
|
|
4
|
* Copyright (C) 2021 Wojtek Kosior
|
|
5
|
* Redistribution terms are gathered in the `copyright' file.
|
|
6
|
*/
|
|
7
|
|
|
8
|
/*
|
|
9
|
* IMPORTS_START
|
|
10
|
* IMPORT browser
|
|
11
|
* IMPORT is_chrome
|
|
12
|
* IMPORT is_mozilla
|
|
13
|
*** Using remote storage here seems inefficient, we only resort to that
|
|
14
|
*** temporarily, before all storage access gets reworked.
|
|
15
|
* IMPORT get_remote_storage
|
|
16
|
* IMPORT get_import_frame
|
|
17
|
* IMPORT query_all
|
|
18
|
* IMPORT CONNECTION_TYPE
|
|
19
|
* IMPORT is_privileged_url
|
|
20
|
* IMPORT TYPE_PREFIX
|
|
21
|
* IMPORT nice_name
|
|
22
|
* IMPORT open_in_settings
|
|
23
|
* IMPORT url_matches
|
|
24
|
* IMPORT each_url_pattern
|
|
25
|
* IMPORT by_id
|
|
26
|
* IMPORT get_template
|
|
27
|
* IMPORT clone_template
|
|
28
|
* IMPORTS_END
|
|
29
|
*/
|
|
30
|
|
|
31
|
let storage;
|
|
32
|
let tab_url;
|
|
33
|
|
|
34
|
/* Force popup <html>'s reflow on stupid Firefox. */
|
|
35
|
if (is_mozilla) {
|
|
36
|
const reflow_forcer =
|
|
37
|
() => document.documentElement.style.width = "-moz-fit-content";
|
|
38
|
for (const radio of document.querySelectorAll('[name="current_view"]'))
|
|
39
|
radio.addEventListener("change", reflow_forcer);
|
|
40
|
}
|
|
41
|
|
|
42
|
const show_queried_view_radio = by_id("show_queried_view_radio");
|
|
43
|
|
|
44
|
const tab_query = {currentWindow: true, active: true};
|
|
45
|
|
|
46
|
async function get_current_tab()
|
|
47
|
{
|
|
48
|
/* Fix for fact that Chrome does not use promises here */
|
|
49
|
const promise = is_chrome ?
|
|
50
|
new Promise((resolve, reject) =>
|
|
51
|
browser.tabs.query(tab_query, tab => resolve(tab))) :
|
|
52
|
browser.tabs.query(tab_query);
|
|
53
|
|
|
54
|
try {
|
|
55
|
return (await promise)[0];
|
|
56
|
} catch(e) {
|
|
57
|
console.log(e);
|
|
58
|
}
|
|
59
|
}
|
|
60
|
|
|
61
|
const page_url_heading = by_id("page_url_heading");
|
|
62
|
const privileged_notice = by_id("privileged_notice");
|
|
63
|
const page_state = by_id("page_state");
|
|
64
|
|
|
65
|
/* Helper functions to convert string into a list of one-letter <span>'s. */
|
|
66
|
function char_to_span(char, doc)
|
|
67
|
{
|
|
68
|
const span = document.createElement("span");
|
|
69
|
span.textContent = char;
|
|
70
|
return span;
|
|
71
|
}
|
|
72
|
|
|
73
|
function to_spans(string, doc=document)
|
|
74
|
{
|
|
75
|
return string.split("").map(c => char_to_span(c, doc));
|
|
76
|
}
|
|
77
|
|
|
78
|
async function show_page_activity_info()
|
|
79
|
{
|
|
80
|
const tab = await get_current_tab();
|
|
81
|
|
|
82
|
if (tab === undefined) {
|
|
83
|
page_url_heading.textContent = "unknown page";
|
|
84
|
return;
|
|
85
|
}
|
|
86
|
|
|
87
|
tab_url = /^([^?#]*)/.exec(tab.url)[1];
|
|
88
|
to_spans(tab_url).forEach(s => page_url_heading.append(s));
|
|
89
|
if (is_privileged_url(tab_url)) {
|
|
90
|
privileged_notice.classList.remove("hide");
|
|
91
|
return;
|
|
92
|
}
|
|
93
|
|
|
94
|
populate_possible_patterns_list(tab_url);
|
|
95
|
page_state.classList.remove("hide");
|
|
96
|
|
|
97
|
try_to_connect(tab.id);
|
|
98
|
}
|
|
99
|
|
|
100
|
const possible_patterns_list = by_id("possible_patterns");
|
|
101
|
const known_patterns = new Map();
|
|
102
|
|
|
103
|
function add_pattern_to_list(pattern)
|
|
104
|
{
|
|
105
|
const template = clone_template("pattern_entry");
|
|
106
|
template.name.textContent = pattern;
|
|
107
|
|
|
108
|
const settings_opener = () => open_in_settings(TYPE_PREFIX.PAGE, pattern);
|
|
109
|
template.button.addEventListener("click", settings_opener);
|
|
110
|
|
|
111
|
known_patterns.set(pattern, template);
|
|
112
|
possible_patterns_list.append(template.entry);
|
|
113
|
|
|
114
|
return template;
|
|
115
|
}
|
|
116
|
|
|
117
|
function ensure_pattern_exists(pattern)
|
|
118
|
{
|
|
119
|
let entry_object = known_patterns.get(pattern);
|
|
120
|
/*
|
|
121
|
* As long as pattern computation works well, we should never get into this
|
|
122
|
* conditional block. This is just a safety measure. To be removed as part
|
|
123
|
* of a bigger rework when we start taking iframes into account.
|
|
124
|
*/
|
|
125
|
if (entry_object === undefined) {
|
|
126
|
console.log(`unknown pattern: ${pattern}`);
|
|
127
|
entry_object = add_pattern_to_list(pattern);
|
|
128
|
}
|
|
129
|
|
|
130
|
return entry_object;
|
|
131
|
}
|
|
132
|
|
|
133
|
function style_possible_pattern_entry(pattern, exists_in_settings)
|
|
134
|
{
|
|
135
|
const [text, class_action] = exists_in_settings ?
|
|
136
|
["Edit", "add"] : ["Add", "remove"];
|
|
137
|
const entry_object = ensure_pattern_exists(pattern);
|
|
138
|
|
|
139
|
entry_object.button.textContent = `${text} setting`;
|
|
140
|
entry_object.entry.classList[class_action]("matched_pattern");
|
|
141
|
}
|
|
142
|
|
|
143
|
function handle_page_change(change)
|
|
144
|
{
|
|
145
|
if (url_matches(tab_url, change.item))
|
|
146
|
style_possible_pattern_entry(change.item, change.new_val !== undefined);
|
|
147
|
}
|
|
148
|
|
|
149
|
function populate_possible_patterns_list(url)
|
|
150
|
{
|
|
151
|
for (const pattern of each_url_pattern(url))
|
|
152
|
add_pattern_to_list(pattern);
|
|
153
|
|
|
154
|
for (const [pattern, settings] of query_all(storage, url))
|
|
155
|
style_possible_pattern_entry(pattern, true);
|
|
156
|
|
|
157
|
storage.add_change_listener(handle_page_change, [TYPE_PREFIX.PAGE]);
|
|
158
|
}
|
|
159
|
|
|
160
|
const connected_chbx = by_id("connected_chbx");
|
|
161
|
const query_pattern_but = by_id("query_pattern");
|
|
162
|
|
|
163
|
var content_script_port;
|
|
164
|
|
|
165
|
function try_to_connect(tab_id)
|
|
166
|
{
|
|
167
|
/* This won't connect to iframes. We'll add support for them later */
|
|
168
|
const connect_info = {name: CONNECTION_TYPE.ACTIVITY_INFO, frameId: 0};
|
|
169
|
content_script_port = browser.tabs.connect(tab_id, connect_info);
|
|
170
|
|
|
171
|
const disconnect_cb = () => handle_disconnect(tab_id, start_querying_repos);
|
|
172
|
content_script_port.onDisconnect.addListener(disconnect_cb);
|
|
173
|
content_script_port.onMessage.addListener(handle_activity_report);
|
|
174
|
|
|
175
|
query_pattern_but.addEventListener("click", start_querying_repos);
|
|
176
|
|
|
177
|
if (is_mozilla)
|
|
178
|
setTimeout(() => monitor_connecting(tab_id), 1000);
|
|
179
|
}
|
|
180
|
|
|
181
|
function start_querying_repos()
|
|
182
|
{
|
|
183
|
query_pattern_but.removeEventListener("click", start_querying_repos);
|
|
184
|
const repo_urls = storage.get_all_names(TYPE_PREFIX.REPO);
|
|
185
|
if (content_script_port)
|
|
186
|
content_script_port.postMessage([TYPE_PREFIX.URL, tab_url, repo_urls]);
|
|
187
|
}
|
|
188
|
|
|
189
|
const loading_point = by_id("loading_point");
|
|
190
|
const reload_notice = by_id("reload_notice");
|
|
191
|
|
|
192
|
function handle_disconnect(tab_id, button_cb)
|
|
193
|
{
|
|
194
|
query_pattern_but.removeEventListener("click", button_cb);
|
|
195
|
content_script_port = null;
|
|
196
|
|
|
197
|
if (is_chrome && !browser.runtime.lastError)
|
|
198
|
return;
|
|
199
|
|
|
200
|
/* return if error was not during connection initialization */
|
|
201
|
if (connected_chbx.checked)
|
|
202
|
return;
|
|
203
|
|
|
204
|
loading_point.classList.toggle("camouflage");
|
|
205
|
reload_notice.classList.remove("hide");
|
|
206
|
|
|
207
|
setTimeout(() => try_to_connect(tab_id), 1000);
|
|
208
|
}
|
|
209
|
|
|
210
|
function monitor_connecting(tab_id)
|
|
211
|
{
|
|
212
|
if (connected_chbx.checked)
|
|
213
|
return;
|
|
214
|
|
|
215
|
if (content_script_port)
|
|
216
|
content_script_port.disconnect();
|
|
217
|
else
|
|
218
|
return;
|
|
219
|
|
|
220
|
loading_point.classList.toggle("camouflage");
|
|
221
|
reload_notice.classList.remove("hide");
|
|
222
|
try_to_connect(tab_id);
|
|
223
|
}
|
|
224
|
|
|
225
|
const pattern_span = by_id("pattern");
|
|
226
|
const view_pattern_but = by_id("view_pattern");
|
|
227
|
const blocked_span = by_id("blocked");
|
|
228
|
const payload_span = by_id("payload");
|
|
229
|
const payload_buttons_div = by_id("payload_buttons");
|
|
230
|
const view_payload_but = by_id("view_payload");
|
|
231
|
const view_injected_but = by_id("view_injected");
|
|
232
|
const container_for_injected = by_id("container_for_injected");
|
|
233
|
|
|
234
|
const queried_items = new Map();
|
|
235
|
|
|
236
|
let max_injected_script_id = 0;
|
|
237
|
|
|
238
|
function handle_activity_report(message)
|
|
239
|
{
|
|
240
|
connected_chbx.checked = true;
|
|
241
|
|
|
242
|
const [type, data] = message;
|
|
243
|
|
|
244
|
if (type === "settings") {
|
|
245
|
let [pattern, settings] = data;
|
|
246
|
|
|
247
|
settings = settings || {};
|
|
248
|
blocked_span.textContent = settings.allow ? "no" : "yes";
|
|
249
|
|
|
250
|
if (pattern) {
|
|
251
|
pattern_span.textContent = pattern;
|
|
252
|
const settings_opener =
|
|
253
|
() => open_in_settings(TYPE_PREFIX.PAGE, pattern);
|
|
254
|
view_pattern_but.classList.remove("hide");
|
|
255
|
view_pattern_but.addEventListener("click", settings_opener);
|
|
256
|
} else {
|
|
257
|
pattern_span.textContent = "none";
|
|
258
|
}
|
|
259
|
|
|
260
|
const components = settings.components;
|
|
261
|
if (components) {
|
|
262
|
payload_span.textContent = nice_name(...components);
|
|
263
|
payload_buttons_div.classList.remove("hide");
|
|
264
|
const settings_opener = () => open_in_settings(...components);
|
|
265
|
view_payload_but.addEventListener("click", settings_opener);
|
|
266
|
} else {
|
|
267
|
payload_span.textContent = "none";
|
|
268
|
}
|
|
269
|
}
|
|
270
|
if (type === "script") {
|
|
271
|
const template = clone_template("injected_script");
|
|
272
|
const chbx_id = `injected_script_${max_injected_script_id++}`;
|
|
273
|
template.chbx.id = chbx_id;
|
|
274
|
template.lbl.setAttribute("for", chbx_id);
|
|
275
|
template.script_contents.textContent = data;
|
|
276
|
container_for_injected.appendChild(template.div);
|
|
277
|
}
|
|
278
|
if (type === "repo_query_action") {
|
|
279
|
const key = data.prefix + data.item;
|
|
280
|
const results = queried_items.get(key) || {};
|
|
281
|
Object.assign(results, data.results);
|
|
282
|
queried_items.set(key, results);
|
|
283
|
|
|
284
|
const action = data.prefix === TYPE_PREFIX.URL ?
|
|
285
|
show_query_result : record_fetched_install_dep;
|
|
286
|
|
|
287
|
for (const [repo_url, result] of Object.entries(data.results))
|
|
288
|
action(data.prefix, data.item, repo_url, result);
|
|
289
|
}
|
|
290
|
}
|
|
291
|
|
|
292
|
const container_for_repo_responses = by_id("container_for_repo_responses");
|
|
293
|
|
|
294
|
const results_lists = new Map();
|
|
295
|
|
|
296
|
function create_results_list(url)
|
|
297
|
{
|
|
298
|
const cloned_template = clone_template("multi_repos_query_result");
|
|
299
|
cloned_template.url_span.textContent = url;
|
|
300
|
container_for_repo_responses.appendChild(cloned_template.div);
|
|
301
|
|
|
302
|
cloned_template.by_repo = new Map();
|
|
303
|
results_lists.set(url, cloned_template);
|
|
304
|
|
|
305
|
return cloned_template;
|
|
306
|
}
|
|
307
|
|
|
308
|
function create_result_item(list_object, repo_url, result)
|
|
309
|
{
|
|
310
|
const cloned_template = clone_template("single_repo_query_result");
|
|
311
|
cloned_template.repo_url.textContent = repo_url;
|
|
312
|
cloned_template.appended = null;
|
|
313
|
|
|
314
|
list_object.ul.appendChild(cloned_template.li);
|
|
315
|
list_object.by_repo.set(repo_url, cloned_template);
|
|
316
|
|
|
317
|
return cloned_template;
|
|
318
|
}
|
|
319
|
|
|
320
|
function set_appended(result_item, element)
|
|
321
|
{
|
|
322
|
if (result_item.appended)
|
|
323
|
result_item.appended.remove();
|
|
324
|
result_item.appended = element;
|
|
325
|
result_item.li.appendChild(element);
|
|
326
|
}
|
|
327
|
|
|
328
|
function show_message(result_item, text)
|
|
329
|
{
|
|
330
|
const div = document.createElement("div");
|
|
331
|
div.textContent = text;
|
|
332
|
set_appended(result_item, div);
|
|
333
|
}
|
|
334
|
|
|
335
|
function showcb(text)
|
|
336
|
{
|
|
337
|
return item => show_message(item, text);
|
|
338
|
}
|
|
339
|
|
|
340
|
function unroll_chbx_first_checked(entry_object)
|
|
341
|
{
|
|
342
|
if (!entry_object.chbx.checked)
|
|
343
|
return;
|
|
344
|
|
|
345
|
entry_object.chbx.removeEventListener("change", entry_object.unroll_cb);
|
|
346
|
delete entry_object.unroll_cb;
|
|
347
|
|
|
348
|
entry_object.unroll.innerHTML = "preview not implemented...<br />(consider contributing)";
|
|
349
|
}
|
|
350
|
|
|
351
|
let import_frame;
|
|
352
|
let install_target = null;
|
|
353
|
|
|
354
|
function install_abort(error_state)
|
|
355
|
{
|
|
356
|
import_frame.show_error(`Error: ${error_state}`);
|
|
357
|
install_target = null;
|
|
358
|
}
|
|
359
|
|
|
360
|
/*
|
|
361
|
* Translate objects from the format in which they are sent by Hydrilla to the
|
|
362
|
* format in which they are stored in settings.
|
|
363
|
*/
|
|
364
|
|
|
365
|
function translate_script(script_object, repo_url)
|
|
366
|
{
|
|
367
|
return {
|
|
368
|
[TYPE_PREFIX.SCRIPT + script_object.name]: {
|
|
369
|
hash: script_object.sha256,
|
|
370
|
url: `${repo_url}/content/${script_object.location}`
|
|
371
|
}
|
|
372
|
};
|
|
373
|
}
|
|
374
|
|
|
375
|
function translate_bag(bag_object)
|
|
376
|
{
|
|
377
|
return {
|
|
378
|
[TYPE_PREFIX.BAG + bag_object.name]: bag_object.components
|
|
379
|
};
|
|
380
|
}
|
|
381
|
|
|
382
|
const format_translators = {
|
|
383
|
[TYPE_PREFIX.BAG]: translate_bag,
|
|
384
|
[TYPE_PREFIX.SCRIPT]: translate_script
|
|
385
|
};
|
|
386
|
|
|
387
|
function install_check_ready()
|
|
388
|
{
|
|
389
|
if (install_target.to_fetch.size > 0)
|
|
390
|
return;
|
|
391
|
|
|
392
|
const page_key = [TYPE_PREFIX.PAGE + install_target.pattern];
|
|
393
|
const to_install = [{[page_key]: {components: install_target.payload}}];
|
|
394
|
|
|
395
|
for (const key of install_target.fetched) {
|
|
396
|
const old_object =
|
|
397
|
queried_items.get(key)[install_target.repo_url].response;
|
|
398
|
const new_object =
|
|
399
|
format_translators[key[0]](old_object, install_target.repo_url);
|
|
400
|
to_install.push(new_object);
|
|
401
|
}
|
|
402
|
|
|
403
|
import_frame.show_selection(to_install);
|
|
404
|
}
|
|
405
|
|
|
406
|
const possible_errors = ["connection_error", "parse_error"];
|
|
407
|
|
|
408
|
function fetch_install_deps(components)
|
|
409
|
{
|
|
410
|
const needed = [...components];
|
|
411
|
const processed = new Set();
|
|
412
|
|
|
413
|
while (needed.length > 0) {
|
|
414
|
const [prefix, item] = needed.pop();
|
|
415
|
const key = prefix + item;
|
|
416
|
processed.add(key);
|
|
417
|
const results = queried_items.get(key);
|
|
418
|
let relevant_result = null;
|
|
419
|
|
|
420
|
if (results)
|
|
421
|
relevant_result = results[install_target.repo_url];
|
|
422
|
|
|
423
|
if (!relevant_result) {
|
|
424
|
content_script_port.postMessage([prefix, item,
|
|
425
|
[install_target.repo_url]]);
|
|
426
|
install_target.to_fetch.add(key);
|
|
427
|
continue;
|
|
428
|
}
|
|
429
|
|
|
430
|
if (possible_errors.includes(relevant_result.state)) {
|
|
431
|
install_abort(relevant_result.state);
|
|
432
|
return false;
|
|
433
|
}
|
|
434
|
|
|
435
|
install_target.fetched.add(key);
|
|
436
|
|
|
437
|
if (prefix !== TYPE_PREFIX.BAG)
|
|
438
|
continue;
|
|
439
|
|
|
440
|
for (const dependency of relevant_result.response.components) {
|
|
441
|
if (processed.has(dependency.join('')))
|
|
442
|
continue;
|
|
443
|
needed.push(dependency);
|
|
444
|
}
|
|
445
|
}
|
|
446
|
}
|
|
447
|
|
|
448
|
function record_fetched_install_dep(prefix, item, repo_url, result)
|
|
449
|
{
|
|
450
|
const key = prefix + item;
|
|
451
|
|
|
452
|
if (!install_target || repo_url !== install_target.repo_url ||
|
|
453
|
!install_target.to_fetch.has(key))
|
|
454
|
return;
|
|
455
|
|
|
456
|
if (possible_errors.includes(result.state)) {
|
|
457
|
install_abort(result.state);
|
|
458
|
return;
|
|
459
|
}
|
|
460
|
|
|
461
|
if (result.state !== "completed")
|
|
462
|
return;
|
|
463
|
|
|
464
|
install_target.to_fetch.delete(key);
|
|
465
|
install_target.fetched.add(key);
|
|
466
|
|
|
467
|
if (prefix === TYPE_PREFIX.BAG &&
|
|
468
|
fetch_install_deps(result.response.components) === false)
|
|
469
|
return;
|
|
470
|
|
|
471
|
install_check_ready();
|
|
472
|
}
|
|
473
|
|
|
474
|
function install_clicked(entry_object)
|
|
475
|
{
|
|
476
|
import_frame.show_loading();
|
|
477
|
|
|
478
|
install_target = {
|
|
479
|
repo_url: entry_object.repo_url,
|
|
480
|
pattern: entry_object.match_object.pattern,
|
|
481
|
payload: entry_object.match_object.payload,
|
|
482
|
fetched: new Set(),
|
|
483
|
to_fetch: new Set()
|
|
484
|
};
|
|
485
|
|
|
486
|
fetch_install_deps([install_target.payload]);
|
|
487
|
|
|
488
|
install_check_ready();
|
|
489
|
}
|
|
490
|
|
|
491
|
var max_query_result_id = 0;
|
|
492
|
|
|
493
|
function show_query_successful_result(result_item, repo_url, result)
|
|
494
|
{
|
|
495
|
const cloned_ul_template = clone_template("result_patterns_list");
|
|
496
|
set_appended(result_item, cloned_ul_template.ul);
|
|
497
|
|
|
498
|
for (const match of result) {
|
|
499
|
const entry_object = clone_template("query_match_li");
|
|
500
|
|
|
501
|
entry_object.pattern.textContent = match.pattern;
|
|
502
|
|
|
503
|
cloned_ul_template.ul.appendChild(entry_object.li);
|
|
504
|
|
|
505
|
if (!match.payload) {
|
|
506
|
entry_object.payload.textContent = "(none)";
|
|
507
|
for (const key of ["chbx", "triangle", "unroll"])
|
|
508
|
entry_object[key].remove();
|
|
509
|
continue;
|
|
510
|
}
|
|
511
|
|
|
512
|
entry_object.payload.textContent = nice_name(...match.payload);
|
|
513
|
|
|
514
|
const install_cb = () => install_clicked(entry_object);
|
|
515
|
entry_object.btn.addEventListener("click", install_cb);
|
|
516
|
|
|
517
|
const chbx_id = `query_result_${max_query_result_id++}`;
|
|
518
|
entry_object.chbx.id = chbx_id;
|
|
519
|
entry_object.lbl.setAttribute("for", chbx_id);
|
|
520
|
|
|
521
|
entry_object.unroll_cb = () => unroll_chbx_first_checked(entry_object);
|
|
522
|
entry_object.chbx.addEventListener("change", entry_object.unroll_cb);
|
|
523
|
|
|
524
|
entry_object.component_object = match.payload;
|
|
525
|
entry_object.match_object = match;
|
|
526
|
entry_object.repo_url = repo_url;
|
|
527
|
}
|
|
528
|
}
|
|
529
|
|
|
530
|
function show_query_result(url_prefix, url, repo_url, result)
|
|
531
|
{
|
|
532
|
const results_list_object = results_lists.get(url) ||
|
|
533
|
create_results_list(url);
|
|
534
|
const result_item = results_list_object.by_repo.get(repo_url) ||
|
|
535
|
create_result_item(results_list_object, repo_url, result);
|
|
536
|
|
|
537
|
const completed_cb =
|
|
538
|
item => show_query_successful_result(item, repo_url, result.response);
|
|
539
|
const possible_actions = {
|
|
540
|
completed: completed_cb,
|
|
541
|
started: showcb("loading..."),
|
|
542
|
connection_error: showcb("Error when querying repository."),
|
|
543
|
parse_error: showcb("Bad data format received.")
|
|
544
|
};
|
|
545
|
possible_actions[result.state](result_item, repo_url);
|
|
546
|
}
|
|
547
|
|
|
548
|
by_id("settings_but")
|
|
549
|
.addEventListener("click", (e) => browser.runtime.openOptionsPage());
|
|
550
|
|
|
551
|
async function main()
|
|
552
|
{
|
|
553
|
storage = await get_remote_storage();
|
|
554
|
import_frame = await get_import_frame();
|
|
555
|
import_frame.onclose = () => show_queried_view_radio.checked = true;
|
|
556
|
show_page_activity_info();
|
|
557
|
}
|
|
558
|
|
|
559
|
main();
|