aboutsummaryrefslogtreecommitdiff
path: root/common/storage_client.js
blob: 4849a656f66ac6dd0a00433a5df07618973d42ab (about) (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
/**
 * Hachette storage through connection (client side)
 *
 * Copyright (C) 2021 Wojtek Kosior
 * Redistribution terms are gathered in the `copyright' file.
 */

/*
 * IMPORTS_START
 * IMPORT CONNECTION_TYPE
 * IMPORT TYPE_PREFIX
 * IMPORT list_prefixes
 * IMPORT make_once
 * IMPORT browser
 * IMPORTS_END
 */

var call_id = 0;
var port;
var calls_waiting = new Map();

function set_call_callback(resolve, reject, func, args)
{
    port.postMessage([call_id, func, args]);
    calls_waiting.set(call_id++, [resolve, reject]);
}

async function remote_call(func, args)
{
    return new Promise((resolve, reject) =>
		       set_call_callback(resolve, reject, func, args));
}

function handle_message(message)
{
    let callbacks = calls_waiting.get(message.call_id);
    if (callbacks === undefined) {
	handle_change(message);
	return;
    }

    let [resolve, reject] = callbacks;
    calls_waiting.delete(message.call_id);
    if (message.error !== undefined)
	setTimeout(reject, 0, message.error);
    else
	setTimeout(resolve, 0, message.result);
}

function list(name, prefix)
{
    return {prefix, name, listeners : new Set()};
}

var scripts = list("scripts", TYPE_PREFIX.SCRIPT);
var bags = list("bags", TYPE_PREFIX.BAG);
var pages = list("pages", TYPE_PREFIX.PAGE);

const list_by_prefix = {
    [TYPE_PREFIX.SCRIPT] : scripts,
    [TYPE_PREFIX.BAG] : bags,
    [TYPE_PREFIX.PAGE] : pages
};

var resolve_init;

function handle_first_message(message)
{
    for (let prefix of Object.keys(message))
	list_by_prefix[prefix].map = new Map(message[prefix]);

    port.onMessage.removeListener(handle_first_message);
    port.onMessage.addListener(handle_message);

    resolve_init();
}

function handle_change(change)
{
    let list = list_by_prefix[change.prefix];

    if (change.new_val === undefined)
	list.map.delete(change.item);
    else
	list.map.set(change.item, change.new_val);

    for (let listener_callback of list.listeners)
	listener_callback(change);
}

var exports = {};

function start_connection(resolve)
{
    resolve_init = resolve;
    port = browser.runtime.connect({name : CONNECTION_TYPE.REMOTE_STORAGE});
    port.onMessage.addListener(handle_first_message);
}

async function init() {
    await new Promise((resolve, reject) => start_connection(resolve));
    return exports;
}

for (let call_name of ["set", "remove", "replace", "clear"])
    exports [call_name] = (...args) => remote_call(call_name, args);

// TODO: Much of the code below is copy-pasted from /background/storage.mjs.
//       This should later be refactored into a separate module
//       to avoid duplication.

/*
 * Facilitate listening to changes
 */

exports.add_change_listener = function (cb, prefixes=list_prefixes)
{
    if (typeof(prefixes) === "string")
	prefixes = [prefixes];

    for (let prefix of prefixes)
	list_by_prefix[prefix].listeners.add(cb);
}

exports.remove_change_listener = function (cb, prefixes=list_prefixes)
{
    if (typeof(prefixes) === "string")
	prefixes = [prefixes];

    for (let prefix of prefixes)
	list_by_prefix[prefix].listeners.delete(cb);
}

/* Prepare some hepler functions to get elements of a list */

function list_items_it(list, with_values=false)
{
    return with_values ? list.map.entries() : list.map.keys();
}

function list_entries_it(list)
{
    return list_items_it(list, true);
}

function list_items(list, with_values=false)
{
    let array = [];

    for (let item of list_items_it(list, with_values))
	array.push(item);

    return array;
}

function list_entries(list)
{
    return list_items(list, true);
}

exports.get = function (prefix, item)
{
    return list_by_prefix[prefix].map.get(item);
}

exports.get_all_names = function (prefix)
{
    return list_items(list_by_prefix[prefix]);
}

exports.get_all_names_it = function (prefix)
{
    return list_items_it(list_by_prefix[prefix]);
}

exports.get_all = function (prefix)
{
    return list_entries(list_by_prefix[prefix]);
}

exports.get_all_it = function (prefix)
{
    return list_entries_it(list_by_prefix[prefix]);
}

const get_remote_storage = make_once(init);

/*
 * EXPORTS_START
 * EXPORT get_remote_storage
 * EXPORTS_END
 */