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
|
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
/**
* @fileoverview Common page for reading and writing preferences from
* the background context (background page or options page).
*
*/
goog.provide('cvox.ChromeVoxPrefs');
goog.require('cvox.ChromeVox');
goog.require('cvox.ExtensionBridge');
goog.require('cvox.KeyMap');
/**
* This object has default values of preferences and contains the common
* code for working with preferences shared by the Options and Background
* pages.
* @constructor
*/
cvox.ChromeVoxPrefs = function() {
var lastRunVersion = localStorage['lastRunVersion'];
if (!lastRunVersion) {
lastRunVersion = '1.16.0';
}
var loadExistingSettings = true;
// TODO(dtseng): Logic below needs clarification. Perhaps needs a
// 'lastIncompatibleVersion' member.
if (lastRunVersion == '1.16.0') {
loadExistingSettings = false;
}
localStorage['lastRunVersion'] = chrome.app.getDetails().version;
/**
* The current mapping from keys to command.
* @type {!cvox.KeyMap}
* @private
*/
this.keyMap_ = cvox.KeyMap.fromLocalStorage() || cvox.KeyMap.fromDefaults();
this.keyMap_.merge(cvox.KeyMap.fromDefaults());
// Clear per session preferences.
// This is to keep the position dictionary from growing excessively large.
localStorage['position'] = '{}';
// Default per session sticky to off.
localStorage['sticky'] = false;
this.init(loadExistingSettings);
};
/**
* The default value of all preferences except the key map.
* @const
* @type {Object.<string, Object>}
*/
cvox.ChromeVoxPrefs.DEFAULT_PREFS = {
'active': true,
'brailleCaptions': false,
// TODO(dtseng): Leaking state about multiple key maps here until we have a
// class to manage multiple key maps. Also, this doesn't belong as a pref;
// should just store in local storage.
'currentKeyMap' : cvox.KeyMap.DEFAULT_KEYMAP,
'cvoxKey': '',
'earcons': true,
'focusFollowsMouse': false,
'granularity': undefined,
'position': '{}',
'siteSpecificScriptBase':
'https://ssl.gstatic.com/accessibility/javascript/ext/',
'siteSpecificScriptLoader':
'https://ssl.gstatic.com/accessibility/javascript/ext/loader.js',
'sticky': false,
'typingEcho': 0,
'useIBeamCursor': cvox.ChromeVox.isMac,
'useVerboseMode': true,
'siteSpecificEnhancements': true
};
/**
* Merge the default values of all known prefs with what's found in
* localStorage.
* @param {boolean} pullFromLocalStorage or not to pull prefs from local
* storage. True if we want to respect changes the user has already made
* to prefs, false if we want to overwrite them. Set false if we've made
* changes to keyboard shortcuts and need to make sure they aren't
* overridden by the old keymap in local storage.
*/
cvox.ChromeVoxPrefs.prototype.init = function(pullFromLocalStorage) {
// Set the default value of any pref that isn't already in localStorage.
for (var pref in cvox.ChromeVoxPrefs.DEFAULT_PREFS) {
if (localStorage[pref] === undefined) {
localStorage[pref] = cvox.ChromeVoxPrefs.DEFAULT_PREFS[pref];
}
}
};
/**
* Switches to another key map.
* @param {string} selectedKeyMap The id of the keymap in
* cvox.KeyMap.AVAIABLE_KEYMAP_INFO.
*/
cvox.ChromeVoxPrefs.prototype.switchToKeyMap = function(selectedKeyMap) {
// TODO(dtseng): Leaking state about multiple key maps here until we have a
// class to manage multiple key maps.
localStorage['currentKeyMap'] = selectedKeyMap;
this.keyMap_ = cvox.KeyMap.fromCurrentKeyMap();
this.keyMap_.toLocalStorage();
this.keyMap_.resetModifier();
this.sendPrefsToAllTabs(false, true);
};
/**
* Get the prefs (not including keys).
* @return {Object} A map of all prefs except the key map from localStorage.
*/
cvox.ChromeVoxPrefs.prototype.getPrefs = function() {
var prefs = {};
for (var pref in cvox.ChromeVoxPrefs.DEFAULT_PREFS) {
prefs[pref] = localStorage[pref];
}
prefs['version'] = chrome.app.getDetails().version;
return prefs;
};
/**
* Reloads the key map from local storage.
*/
cvox.ChromeVoxPrefs.prototype.reloadKeyMap = function() {
// Get the current key map from localStorage.
// TODO(dtseng): We currently don't support merges since we write the entire
// map back to local storage.
var currentKeyMap = cvox.KeyMap.fromLocalStorage();
if (!currentKeyMap) {
currentKeyMap = cvox.KeyMap.fromCurrentKeyMap();
currentKeyMap.toLocalStorage();
}
this.keyMap_ = currentKeyMap;
};
/**
* Get the key map, from key binding to an array of [command, description].
* @return {cvox.KeyMap} The key map.
*/
cvox.ChromeVoxPrefs.prototype.getKeyMap = function() {
return this.keyMap_;
};
/**
* Reset to the default key bindings.
*/
cvox.ChromeVoxPrefs.prototype.resetKeys = function() {
this.keyMap_ = cvox.KeyMap.fromDefaults();
this.keyMap_.toLocalStorage();
this.sendPrefsToAllTabs(false, true);
};
/**
* Send all of the settings to all tabs.
* @param {boolean} sendPrefs Whether to send the prefs.
* @param {boolean} sendKeyBindings Whether to send the key bindings.
*/
cvox.ChromeVoxPrefs.prototype.sendPrefsToAllTabs =
function(sendPrefs, sendKeyBindings) {
var context = this;
var message = {};
if (sendPrefs) {
message['prefs'] = context.getPrefs();
}
if (sendKeyBindings) {
// Note that cvox.KeyMap stringifies to a minimal object when message gets
// passed to the content script.
message['keyBindings'] = this.keyMap_.toJSON();
}
chrome.windows.getAll({populate: true}, function(windows) {
for (var i = 0; i < windows.length; i++) {
var tabs = windows[i].tabs;
for (var j = 0; j < tabs.length; j++) {
chrome.tabs.sendMessage(tabs[j].id, message);
}
}
});
};
/**
* Send all of the settings over the specified port.
* @param {Port} port The port representing the connection to a content script.
*/
cvox.ChromeVoxPrefs.prototype.sendPrefsToPort = function(port) {
port.postMessage({
'keyBindings': this.keyMap_.toJSON(),
'prefs': this.getPrefs()});
};
/**
* Set the value of a pref and update all active tabs if it's changed.
* @param {string} key The pref key.
* @param {Object|string} value The new value of the pref.
*/
cvox.ChromeVoxPrefs.prototype.setPref = function(key, value) {
if (localStorage[key] != value) {
localStorage[key] = value;
this.sendPrefsToAllTabs(true, false);
}
};
/**
* Delegates to cvox.KeyMap.
* @param {string} command The command to set.
* @param {cvox.KeySequence} newKey The new key to assign it to.
* @return {boolean} True if the key was bound to the command.
*/
cvox.ChromeVoxPrefs.prototype.setKey = function(command, newKey) {
if (this.keyMap_.rebind(command, newKey)) {
this.keyMap_.toLocalStorage();
this.sendPrefsToAllTabs(false, true);
return true;
}
return false;
};
|
