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
|
// -*- indent-tabs-mode: nil; js-indent-level: 2 -*-
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
this.EXPORTED_SYMBOLS = ["SharedPreferences"];
const { classes: Cc, interfaces: Ci, utils: Cu } = Components;
// For adding observers.
Cu.import("resource://gre/modules/Services.jsm");
Cu.import("resource://gre/modules/Messaging.jsm");
var Scope = Object.freeze({
APP: "app",
PROFILE: "profile",
GLOBAL: "global"
});
/**
* Public API to getting a SharedPreferencesImpl instance. These scopes mirror GeckoSharedPrefs.
*/
var SharedPreferences = {
forApp: function() {
return new SharedPreferencesImpl({ scope: Scope.APP });
},
forProfile: function() {
return new SharedPreferencesImpl({ scope: Scope.PROFILE });
},
/**
* Get SharedPreferences for the named profile; if the profile name is null,
* returns the preferences for the current profile (just like |forProfile|).
*/
forProfileName: function(profileName) {
return new SharedPreferencesImpl({ scope: Scope.PROFILE, profileName: profileName });
},
/**
* Get SharedPreferences for the given Android branch; if the branch is null,
* returns the default preferences branch for the application, which is the
* output of |PreferenceManager.getDefaultSharedPreferences|.
*/
forAndroid: function(branch) {
return new SharedPreferencesImpl({ scope: Scope.GLOBAL, branch: branch });
}
};
/**
* Create an interface to an Android SharedPreferences branch.
*
* options {Object} with the following valid keys:
* - scope {String} (required) specifies the scope of preferences that should be accessed.
* - branch {String} (only when using Scope.GLOBAL) should be a string describing a preferences branch,
* like "UpdateService" or "background.data", or null to access the
* default preferences branch for the application.
* - profileName {String} (optional, only valid when using Scope.PROFILE)
*/
function SharedPreferencesImpl(options = {}) {
if (!(this instanceof SharedPreferencesImpl)) {
return new SharedPreferencesImpl(options);
}
if (options.scope == null || options.scope == undefined) {
throw "Shared Preferences must specifiy a scope.";
}
this._scope = options.scope;
this._profileName = options.profileName;
this._branch = options.branch;
this._observers = {};
}
SharedPreferencesImpl.prototype = Object.freeze({
_set: function _set(prefs) {
Messaging.sendRequest({
type: "SharedPreferences:Set",
preferences: prefs,
scope: this._scope,
profileName: this._profileName,
branch: this._branch,
});
},
_setOne: function _setOne(prefName, value, type) {
let prefs = [];
prefs.push({
name: prefName,
value: value,
type: type,
});
this._set(prefs);
},
setBoolPref: function setBoolPref(prefName, value) {
this._setOne(prefName, value, "bool");
},
setCharPref: function setCharPref(prefName, value) {
this._setOne(prefName, value, "string");
},
setIntPref: function setIntPref(prefName, value) {
this._setOne(prefName, value, "int");
},
_get: function _get(prefs, callback) {
let result = null;
Messaging.sendRequestForResult({
type: "SharedPreferences:Get",
preferences: prefs,
scope: this._scope,
profileName: this._profileName,
branch: this._branch,
}).then((data) => {
result = data.values;
});
let thread = Services.tm.currentThread;
while (result == null)
thread.processNextEvent(true);
return result;
},
_getOne: function _getOne(prefName, type) {
let prefs = [];
prefs.push({
name: prefName,
type: type,
});
let values = this._get(prefs);
if (values.length != 1) {
throw new Error("Got too many values: " + values.length);
}
return values[0].value;
},
getBoolPref: function getBoolPref(prefName) {
return this._getOne(prefName, "bool");
},
getCharPref: function getCharPref(prefName) {
return this._getOne(prefName, "string");
},
getIntPref: function getIntPref(prefName) {
return this._getOne(prefName, "int");
},
/**
* Invoke `observer` after a change to the preference `domain` in
* the current branch.
*
* `observer` should implement the nsIObserver.observe interface.
*/
addObserver: function addObserver(domain, observer, holdWeak) {
if (!domain)
throw new Error("domain must not be null");
if (!observer)
throw new Error("observer must not be null");
if (holdWeak)
throw new Error("Weak references not yet implemented.");
if (!this._observers.hasOwnProperty(domain))
this._observers[domain] = [];
if (this._observers[domain].indexOf(observer) > -1)
return;
this._observers[domain].push(observer);
this._updateAndroidListener();
},
/**
* Do not invoke `observer` after a change to the preference
* `domain` in the current branch.
*/
removeObserver: function removeObserver(domain, observer) {
if (!this._observers.hasOwnProperty(domain))
return;
let index = this._observers[domain].indexOf(observer);
if (index < 0)
return;
this._observers[domain].splice(index, 1);
if (this._observers[domain].length < 1)
delete this._observers[domain];
this._updateAndroidListener();
},
_updateAndroidListener: function _updateAndroidListener() {
if (this._listening && Object.keys(this._observers).length < 1)
this._uninstallAndroidListener();
if (!this._listening && Object.keys(this._observers).length > 0)
this._installAndroidListener();
},
_installAndroidListener: function _installAndroidListener() {
if (this._listening)
return;
this._listening = true;
Services.obs.addObserver(this, "SharedPreferences:Changed", false);
Messaging.sendRequest({
type: "SharedPreferences:Observe",
enable: true,
scope: this._scope,
profileName: this._profileName,
branch: this._branch,
});
},
observe: function observe(subject, topic, data) {
if (topic != "SharedPreferences:Changed") {
return;
}
let msg = JSON.parse(data);
if (msg.scope !== this._scope ||
((this._scope === Scope.PROFILE) && (msg.profileName !== this._profileName)) ||
((this._scope === Scope.GLOBAL) && (msg.branch !== this._branch))) {
return;
}
if (!this._observers.hasOwnProperty(msg.key)) {
return;
}
let observers = this._observers[msg.key];
for (let obs of observers) {
obs.observe(obs, msg.key, msg.value);
}
},
_uninstallAndroidListener: function _uninstallAndroidListener() {
if (!this._listening)
return;
this._listening = false;
Services.obs.removeObserver(this, "SharedPreferences:Changed");
Messaging.sendRequest({
type: "SharedPreferences:Observe",
enable: false,
scope: this._scope,
profileName: this._profileName,
branch: this._branch,
});
},
});
|
