aboutsummaryrefslogtreecommitdiff
path: root/background/storage.js
blob: a4e626acc15fe557095f1abf5d1b5b5f063e0746 (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
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
/**
 * This file is part of Haketilo.
 *
 * Function: Storage manager.
 *
 * Copyright (C) 2021 Wojtek Kosior
 * Redistribution terms are gathered in the `copyright' file.
 */

/*
 * IMPORTS_START
 * IMPORT raw_storage
 * IMPORT TYPE_NAME
 * IMPORT list_prefixes
 * IMPORT make_lock
 * IMPORT lock
 * IMPORT unlock
 * IMPORT make_once
 * IMPORT browser
 * IMPORT observables
 * IMPORTS_END
 */

var exports = {};

/* A special case of persisted variable is one that contains list of items. */

async function get_list_var(name)
{
    let list = await raw_storage.get_var(name);

    return list === undefined ? [] : list;
}

/* We maintain in-memory copies of some stored lists. */

async function list(prefix)
{
    let name = TYPE_NAME[prefix] + "s"; /* Make plural. */
    let map = new Map();

    for (let item of await get_list_var(name))
	map.set(item, await raw_storage.get(prefix + item));

    return {map, prefix, name, observable: observables.make(),
	    lock: make_lock()};
}

var list_by_prefix = {};

async function init()
{
    for (let prefix of list_prefixes)
	list_by_prefix[prefix] = await list(prefix);

    return exports;
}

/*
 * Facilitate listening to changes
 */

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

    for (let prefix of prefixes)
	observables.subscribe(list_by_prefix[prefix].observable, cb);
}

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

    for (let prefix of prefixes)
	observables.unsubscribe(list_by_prefix[prefix].observable, 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);
}

/*
 * Below we make additional effort to update map of given kind of items
 * every time an item is added/removed to keep everything coherent.
 */
async function set_item(item, value, list)
{
    await lock(list.lock);
    let result = await _set_item(...arguments);
    unlock(list.lock)
    return result;
}
async function _set_item(item, value, list)
{
    const key = list.prefix + item;
    const old_val = list.map.get(item);
    const set_obj = {[key]: value};
    if (old_val === undefined) {
	const items = list_items(list);
	items.push(item);
	set_obj["_" + list.name] = items;
    }

    await raw_storage.set(set_obj);
    list.map.set(item, value);

    const change = {
	prefix : list.prefix,
	item,
	old_val,
	new_val : value
    };

    observables.broadcast(list.observable, change);

    return old_val;
}

// TODO: The actual idea to set value to undefined is good - this way we can
//       also set a new list of items in the same API call. But such key
//       is still stored in the storage. We need to somehow remove it later.
//       For that, we're going to have to store 1 more list of each kind.
async function remove_item(item, list)
{
    await lock(list.lock);
    let result = await _remove_item(...arguments);
    unlock(list.lock)
    return result;
}
async function _remove_item(item, list)
{
    const old_val = list.map.get(item);
    if (old_val === undefined)
	return;

    const items = list_items(list);
    const index = items.indexOf(item);
    items.splice(index, 1);

    await raw_storage.set({
	[list.prefix + item]: undefined,
	["_" + list.name]: items
    });
    list.map.delete(item);

    const change = {
	prefix : list.prefix,
	item,
	old_val,
	new_val : undefined
    };

    observables.broadcast(list.observable, change);

    return old_val;
}

// TODO: same as above applies here
async function replace_item(old_item, new_item, list, new_val=undefined)
{
    await lock(list.lock);
    let result = await _replace_item(...arguments);
    unlock(list.lock)
    return result;
}
async function _replace_item(old_item, new_item, list, new_val=undefined)
{
    const old_val = list.map.get(old_item);
    if (new_val === undefined) {
	if (old_val === undefined)
	    return;
	new_val = old_val;
    } else if (new_val === old_val && new_item === old_item) {
	return old_val;
    }

    if (old_item === new_item || old_val === undefined) {
	await _set_item(new_item, new_val, list);
	return old_val;
    }

    const items = list_items(list);
    const index = items.indexOf(old_item);
    items[index] = new_item;

    await raw_storage.set({
	[list.prefix + old_item]: undefined,
	[list.prefix + new_item]: new_val,
	["_" + list.name]: items
    });
    list.map.delete(old_item);

    const change = {
	prefix : list.prefix,
	item : old_item,
	old_val,
	new_val : undefined
    };

    observables.broadcast(list.observable, change);

    list.map.set(new_item, new_val);

    change.item = new_item;
    change.old_val = undefined;
    change.new_val = new_val;

    observables.broadcast(list.observable, change);

    return old_val;
}

/*
 * For scripts, item name is chosen by user, data should be
 * an object containing:
 * - script's url and hash or
 * - script's text or
 * - all three
 */

/*
 * For bags, item name is chosen by user, data is an array of 2-element
 * arrays with type prefix and script/bag names.
 */

/*
 * For pages data argument is an object with properties `allow'
 * and `components'. Item name is url.
 */

exports.set = async function (prefix, item, data)
{
    return set_item(item, data, list_by_prefix[prefix]);
}

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

exports.remove = async function (prefix, item)
{
    return remove_item(item, list_by_prefix[prefix]);
}

exports.replace = async function (prefix, old_item, new_item,
				  new_data=undefined)
{
    return replace_item(old_item, new_item, list_by_prefix[prefix],
			new_data);
}

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]);
}

/* Finally, a quick way to wipe all the data. */
// TODO: maybe delete items in such order that none of them ever references
// an already-deleted one?
exports.clear = async function ()
{
    let lists = list_prefixes.map((p) => list_by_prefix[p]);

    for (let list of lists)
	await lock(list.lock);

    for (let list of lists) {

	let change = {
	    prefix : list.prefix,
	    new_val : undefined
	};

	for (let [item, val] of list_entries_it(list)) {
	    change.item = item;
	    change.old_val = val;
	    observables.broadcast(list.observable, change);
	}

	list.map = new Map();
    }

    await browser.storage.local.clear();

    for (let list of lists)
	unlock(list.lock);
}

const get_storage = make_once(init);

/*
 * EXPORTS_START
 * EXPORT get_storage
 * EXPORTS_END
 */