forked from philc/vimium
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathbackground_page.html
605 lines (519 loc) · 21.1 KB
/
background_page.html
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
<html>
<head>
<script type="text/javascript" src="commands.js"/>
<script type="text/javascript" charset="utf-8">
// Chromium #15242 will make this XHR request unnecessary.
var manifestRequest = new XMLHttpRequest();
manifestRequest.open("GET", chrome.extension.getURL("manifest.json"), false);
manifestRequest.send(null);
var currentVersion = JSON.parse(manifestRequest.responseText).version;
var tabQueue = {}; // windowId -> Array
var openTabs = {}; // tabId -> object with various tab properties
var keyQueue = ""; // Queue of keys typed
var validFirstKeys = {};
var singleKeyCommands = [];
var hasModifierRegex = /^<[amc]-.>/;
var defaultSettings = {
scrollStepSize: 60,
defaultZoomLevel: 100,
linkHintCharacters: "sadfjklewcmpgh",
userDefinedLinkHintCss:
".vimiumHintMarker {\n\n}\n" +
".vimiumHintMarker > .matchingCharacter {\n\n}"
};
// This is the base internal link hints CSS. It's combined with the userDefinedLinkHintCss before
// being sent to the frontend.
var linkHintCss =
'.internalVimiumHintMarker {' +
'position:absolute;' +
'background-color:yellow;' +
'color:black;' +
'font-weight:bold;' +
'font-size:12px;' +
'padding:0 1px;' +
'line-height:100%;' +
'width:auto;' +
'display:block;' +
'border:1px solid #E3BE23;' +
'z-index:99999999;' +
'font-family:"Helvetica Neue", "Helvetica", "Arial", "Sans";' +
'top:-1px;' +
'left:-1px;' +
'}' +
'.internalVimiumHintMarker > .matchingCharacter {' +
'color:#C79F0B;' +
'}';
// Port handler mapping
var portHandlers = {
keyDown: handleKeyDown,
returnScrollPosition: handleReturnScrollPosition,
isEnabledForUrl: isEnabledForUrl,
getCurrentTabUrl: getCurrentTabUrl,
getZoomLevel: getZoomLevel,
saveZoomLevel: saveZoomLevel,
getSetting: getSetting
};
var sendRequestHandlers = {
getCompletionKeys: getCompletionKeys,
getLinkHintCss: getLinkHintCss,
upgradeNotificationClosed: upgradeNotificationClosed,
updateScrollPosition: handleUpdateScrollPosition
};
// Event handlers
var selectionChangedHandlers = [];
var getScrollPositionHandlers = {}; // tabId -> function(tab, scrollX, scrollY);
var tabLoadedHandlers = {}; // tabId -> function()
chrome.extension.onConnect.addListener(function(port, name) {
var senderTabId = port.sender.tab ? port.sender.tab.id : null;
// If this is a tab we've been waiting to open, execute any "tab loaded" handlers, e.g. to restore
// the tab's scroll position. Wait until domReady before doing this; otherwise operations like restoring
// the scroll position will not be possible.
if (port.name == "domReady" && senderTabId != null) {
if (tabLoadedHandlers[senderTabId]) {
var toCall = tabLoadedHandlers[senderTabId];
// Delete first to be sure there's no circular events.
delete tabLoadedHandlers[senderTabId];
toCall.call();
}
// domReady is the appropriate time to show the "vimium has been upgraded" message.
if (shouldShowUpgradeMessage())
chrome.tabs.sendRequest(senderTabId, { name: "showUpgradeNotification", version: currentVersion });
}
if (portHandlers[port.name])
port.onMessage.addListener(portHandlers[port.name]);
});
chrome.extension.onRequest.addListener(function (request, sender, sendResponse) {
var senderTabId = sender.tab ? sender.tab.id : null;
if (sendRequestHandlers[request.handler])
sendResponse(sendRequestHandlers[request.handler](request, sender));
});
function handleReturnScrollPosition(args) {
if (getScrollPositionHandlers[args.currentTab.id]) {
// Delete first to be sure there's no circular events.
var toCall = getScrollPositionHandlers[args.currentTab.id];
delete getScrollPositionHandlers[args.currentTab.id];
toCall(args.currentTab, args.scrollX, args.scrollY);
}
}
/*
* Used by the content scripts to get their full URL. This is needed for URLs like "view-source:http:// .."
* because window.location doesn't know anything about the Chrome-specific "view-source:".
*/
function getCurrentTabUrl(args, port) {
var returnPort = chrome.tabs.connect(port.tab.id, { name: "returnCurrentTabUrl" });
returnPort.postMessage({ url: port.tab.url });
}
/*
* Checks the user's preferences in local storage to determine if Vimium is enabled for the given URL.
*/
function isEnabledForUrl(args, port) {
var returnPort = chrome.tabs.connect(port.tab.id, { name: "returnIsEnabledForUrl" });
// excludedUrls are stored as a series of URL expressions separated by newlines.
var excludedUrls = (localStorage["excludedUrls"] || "").split("\n");
var isEnabled = true;
for (var i = 0; i < excludedUrls.length; i++) {
// The user can add "*" to the URL which means ".*"
var regexp = new RegExp("^" + excludedUrls[i].replace(/\*/g, ".*") + "$");
if (args.url.match(regexp))
isEnabled = false;
}
returnPort.postMessage({ isEnabledForUrl: isEnabled });
}
/*
* Returns the previously saved zoom level for the current tab, or the default zoom level
*/
function getZoomLevel(args, port) {
var returnPort = chrome.tabs.connect(port.tab.id, { name: "returnZoomLevel" });
var localStorageKey = "zoom" + args.domain;
var zoomLevelForDomain = (localStorage[localStorageKey] || "").split(",")[1];
var zoomLevel = parseInt(zoomLevelForDomain || localStorage["defaultZoomLevel"] ||
defaultSettings.defaultZoomLevel);
returnPort.postMessage({ zoomLevel: zoomLevel });
}
function showHelp() {
chrome.tabs.getSelected(null, function(tab) {
chrome.tabs.sendRequest(tab.id, { name: "showHelpDialog", dialogHtml: helpDialogHtml() });
});
}
/*
* Retrieves the help dialog HTML template from a file, and populates it with the latest keybindings.
*/
function helpDialogHtml(showUnboundCommands, showCommandNames, customTitle) {
var commandsToKey = {};
for (var key in keyToCommandRegistry) {
var command = keyToCommandRegistry[key].command;
commandsToKey[command] = (commandsToKey[command] || []).concat(key);
}
var dialogHtml = fetchFileContents("helpDialog.html");
for (var group in commandGroups)
dialogHtml = dialogHtml.replace("{{" + group + "}}",
helpDialogHtmlForCommandGroup(group, commandsToKey, availableCommands,
showUnboundCommands, showCommandNames));
dialogHtml = dialogHtml.replace("{{version}}", currentVersion);
dialogHtml = dialogHtml.replace("{{title}}", customTitle || "Help");
return dialogHtml;
}
/*
* Generates HTML for a given set of commands. commandGroups are defined in commands.js
*/
function helpDialogHtmlForCommandGroup(group, commandsToKey, availableCommands,
showUnboundCommands, showCommandNames) {
var html = [];
for (var i = 0; i < commandGroups[group].length; i++) {
var command = commandGroups[group][i];
bindings = (commandsToKey[command] || [""]).join(", ")
if (showUnboundCommands || commandsToKey[command])
{
html.push("<tr><td>", escapeHtml(bindings),
"</td><td>:</td><td>", availableCommands[command].description);
if (showCommandNames)
html.push("<span class='commandName'>(" + command + ")</span>");
html.push("</td></tr>");
}
}
return html.join("\n");
}
function escapeHtml(string) { return string.replace(/</g, "<").replace(/>/g, ">"); }
/*
* Fetches the contents of a file bundled with this extension.
*/
function fetchFileContents(extensionFileName) {
var req = new XMLHttpRequest();
req.open("GET", chrome.extension.getURL(extensionFileName), false); // false => synchronous
req.send();
return req.responseText;
}
/**
* Returns the keys that can complete a valid command given the current key queue.
*/
function getCompletionKeys(request) {
return {completionKeys: generateCompletionKeys()};
}
/*
* Returns the core CSS used for link hints, along with any user-provided overrides.
*/
function getLinkHintCss(request) {
return { linkHintCss: linkHintCss + (localStorage['userDefinedLinkHintCss'] || "") };
}
/*
* Called when the user has clicked the close icon on the "Vimium has been updated" message.
* We should now dismiss that message in all tabs.
*/
function upgradeNotificationClosed(request) {
localStorage.previousVersion = currentVersion;
sendRequestToAllTabs({ name: "hideUpgradeNotification" });
}
/*
* Used by the content scripts to get settings from the local storage.
*/
function getSetting(args, port) {
var value = localStorage[args.key] ? localStorage[args.key] : defaultSettings[args.key];
var returnPort = chrome.tabs.connect(port.tab.id, { name: "returnSetting" });
returnPort.postMessage({ key: args.key, value: value });
}
/*
* Persists the current zoom level for a given domain
*/
function saveZoomLevel(args) {
var localStorageKey = "zoom" + args.domain;
// TODO(philc): We might want to consider expiring these entries after X months as NoSquint does.
// Note(philc): We might also want to jsonify this hash instead of polluting our local storage keyspace.
localStorage[localStorageKey] = [getCurrentTimeInSeconds(), args.zoomLevel].join(",");
}
function getCurrentTimeInSeconds() { Math.floor((new Date()).getTime() / 1000); }
chrome.tabs.onSelectionChanged.addListener(function(tabId, selectionInfo) {
if (selectionChangedHandlers.length > 0) { selectionChangedHandlers.pop().call(); }
});
function repeatFunction(func, totalCount, currentCount) {
if (currentCount < totalCount)
func(function() { repeatFunction(func, totalCount, currentCount + 1); });
}
// Returns the scroll coordinates of the given tab. Pass in a callback of the form:
// function(tab, scrollX, scrollY) { .. }
function getScrollPosition(tab, callback) {
getScrollPositionHandlers[tab.id] = callback;
var scrollPort = chrome.tabs.connect(tab.id, { name: "getScrollPosition" });
scrollPort.postMessage({currentTab: tab});
}
// Start action functions
function createTab(callback) {
chrome.tabs.create({}, function(tab) { callback(); });
}
function nextTab(callback) { selectTab(callback, "next"); }
function previousTab(callback) { selectTab(callback, "previous"); }
/*
* Selects a tab before or after the currently selected tab. Direction is either "next" or "previous".
*/
function selectTab(callback, direction) {
chrome.tabs.getAllInWindow(null, function(tabs) {
if (tabs.length <= 1)
return;
for (var i = 0; i < tabs.length; i++) {
if (tabs[i].selected) {
var delta = (direction == "next") ? 1 : -1;
var toSelect = tabs[(i + delta + tabs.length) % tabs.length];
selectionChangedHandlers.push(callback);
chrome.tabs.update(toSelect.id, { selected: true });
break;
}
}
});
}
function removeTab(callback) {
chrome.tabs.getSelected(null, function(tab) {
chrome.tabs.remove(tab.id);
// We can't just call the callback here because we actually need to wait
// for the selection to change to consider this action done.
selectionChangedHandlers.push(callback);
});
}
function updateOpenTabs(tab) {
openTabs[tab.id] = { url: tab.url, positionIndex: tab.index, windowId: tab.windowId };
}
function handleUpdateScrollPosition(request, sender) {
updateScrollPosition(sender.tab, request.scrollX, request.scrollY);
}
function updateScrollPosition(tab, scrollX, scrollY) {
openTabs[tab.id].scrollX = scrollX;
openTabs[tab.id].scrollY = scrollY;
}
chrome.tabs.onUpdated.addListener(function(tabId, changeInfo, tab) {
if (changeInfo.status != "loading") { return; } // only do this once per URL change
updateOpenTabs(tab);
});
chrome.tabs.onAttached.addListener(function(tabId, attachedInfo) {
// We should update all the tabs in the old window and the new window.
if (openTabs[tabId]) {
updatePositionsAndWindowsForAllTabsInWindow(openTabs[tabId].windowId);
}
updatePositionsAndWindowsForAllTabsInWindow(attachedInfo.newWindowId);
});
chrome.tabs.onMoved.addListener(function(tabId, moveInfo) {
updatePositionsAndWindowsForAllTabsInWindow(moveInfo.windowId);
});
chrome.tabs.onRemoved.addListener(function(tabId) {
var openTabInfo = openTabs[tabId];
updatePositionsAndWindowsForAllTabsInWindow(openTabInfo.windowId);
// If we restore chrome:// pages, they'll ignore Vimium keystrokes when they reappear.
// Pretend they never existed and adjust tab indices accordingly.
// Could possibly expand this into a blacklist in the future
if (/^chrome[^:]*:\/\/.*/.test(openTabInfo.url)) {
for (var i in tabQueue[openTabInfo.windowId]) {
if (tabQueue[openTabInfo.windowId][i].positionIndex > openTabInfo.positionIndex)
tabQueue[openTabInfo.windowId][i].positionIndex--;
}
return;
}
if (tabQueue[openTabInfo.windowId])
tabQueue[openTabInfo.windowId].push(openTabInfo);
else
tabQueue[openTabInfo.windowId] = [openTabInfo];
delete openTabs[tabId];
});
chrome.windows.onRemoved.addListener(function(windowId) {
delete tabQueue[windowId];
});
function restoreTab(callback) {
// TODO(ilya): Should this be getLastFocused instead?
chrome.windows.getCurrent(function(window) {
if (tabQueue[window.id] && tabQueue[window.id].length > 0)
{
var tabQueueEntry = tabQueue[window.id].pop();
// Clean out the tabQueue so we don't have unused windows laying about.
if (tabQueue[window.id].length == 0)
delete tabQueue[window.id];
// We have to chain a few callbacks to set the appropriate scroll position. We can't just wait until the
// tab is created because the content script is not available during the "loading" state. We need to
// wait until that's over before we can call setScrollPosition.
chrome.tabs.create({ url: tabQueueEntry.url, index: tabQueueEntry.positionIndex }, function(tab) {
tabLoadedHandlers[tab.id] = function() {
var scrollPort = chrome.tabs.connect(tab.id, {name: "setScrollPosition"});
scrollPort.postMessage({ scrollX: tabQueueEntry.scrollX, scrollY: tabQueueEntry.scrollY });
};
callback();
});
}
});
}
// End action functions
function updatePositionsAndWindowsForAllTabsInWindow(windowId) {
chrome.tabs.getAllInWindow(windowId, function (tabs) {
for (var i = 0; i < tabs.length; i++) {
var tab = tabs[i];
var openTabInfo = openTabs[tab.id];
if (openTabInfo) {
openTabInfo.positionIndex = tab.index;
openTabInfo.windowId = tab.windowId;
}
}
});
}
function splitKeyIntoFirstAndSecond(key) {
if (key.search(hasModifierRegex) == 0)
return { first: key.slice(0, 5), second: key.slice(5) };
else
return { first: key[0], second: key.slice(1) };
}
function getActualKeyStrokeLength(key) {
if (key.search(hasModifierRegex) == 0)
return 1 + getActualKeyStrokeLength(key.slice(5));
else
return key.length;
}
function populateValidFirstKeys() {
for (var key in keyToCommandRegistry)
{
if (getActualKeyStrokeLength(key) == 2)
validFirstKeys[splitKeyIntoFirstAndSecond(key).first] = true;
}
}
function populateSingleKeyCommands() {
for (var key in keyToCommandRegistry)
{
if (getActualKeyStrokeLength(key) == 1)
singleKeyCommands.push(key);
}
}
function refreshCompletionKeysAfterMappingSave() {
validFirstKeys = {};
singleKeyCommands = [];
populateValidFirstKeys();
populateSingleKeyCommands();
sendRequestToAllTabs({ name: "refreshCompletionKeys", completionKeys: generateCompletionKeys() });
}
/*
* Generates a list of keys that can complete a valid command given the current key queue or the one passed
* in.
*/
function generateCompletionKeys(keysToCheck) {
var splitHash = splitKeyQueue(keysToCheck || keyQueue);
command = splitHash.command;
count = splitHash.count;
var completionKeys = singleKeyCommands.slice(0);
if (getActualKeyStrokeLength(command) == 1)
{
for (var key in keyToCommandRegistry)
{
var splitKey = splitKeyIntoFirstAndSecond(key);
if (splitKey.first == command)
completionKeys.push(splitKey.second);
}
}
return completionKeys;
}
function splitKeyQueue(queue) {
var match = /([0-9]*)(.*)/.exec(queue);
var count = parseInt(match[1]);
var command = match[2];
return {count: count, command: command};
}
function handleKeyDown(key, port) {
if (key == "<ESC>") {
console.log("clearing keyQueue");
keyQueue = ""
}
else {
console.log("checking keyQueue: [", keyQueue + key, "]");
keyQueue = checkKeyQueue(keyQueue + key, port.tab.id);
console.log("new KeyQueue: " + keyQueue);
}
}
function checkKeyQueue(keysToCheck, tabId) {
var refreshedCompletionKeys = false;
var splitHash = splitKeyQueue(keysToCheck);
command = splitHash.command;
count = splitHash.count;
if (command.length == 0) { return keysToCheck; }
if (isNaN(count)) { count = 1; }
if (keyToCommandRegistry[command]) {
registryEntry = keyToCommandRegistry[command];
console.log("command found for [", keysToCheck, "],", registryEntry.command);
if (!registryEntry.isBackgroundCommand) {
var port = chrome.tabs.connect(tabId, { name: "executePageCommand" });
port.postMessage({ command: registryEntry.command, count: count,
completionKeys: generateCompletionKeys("") });
refreshedCompletionKeys = true;
} else {
repeatFunction(this[registryEntry.command], count, 0);
}
newKeyQueue = "";
} else if (getActualKeyStrokeLength(command) > 1) {
var splitKey = splitKeyIntoFirstAndSecond(command);
// The second key might be a valid command by its self.
if (keyToCommandRegistry[splitKey.second])
newKeyQueue = checkKeyQueue(splitKey.second);
else
newKeyQueue = (validFirstKeys[splitKey.second] ? splitKey.second : "");
} else {
newKeyQueue = (validFirstKeys[command] ? count.toString() + command : "");
}
// If we haven't sent the completion keys piggybacked on executePageCommand,
// send them by themselves.
if (!refreshedCompletionKeys)
{
var port = chrome.tabs.connect(tabId, { name: "refreshCompletionKeys" });
port.postMessage({ completionKeys: generateCompletionKeys(newKeyQueue) });
}
return newKeyQueue;
}
/*
* Message all tabs. Args should be the arguments hash used by the Chrome sendRequest API.
*/
function sendRequestToAllTabs(args) {
chrome.windows.getAll({ populate: true }, function(windows) {
for (var i = 0; i < windows.length; i++)
for (var j = 0; j < windows[i].tabs.length; j++)
chrome.tabs.sendRequest(windows[i].tabs[j].id, args, null);
});
}
// Compares two version strings (e.g. "1.1" and "1.5") and returns
// -1 if versionA is < versionB, 0 if they're equal, and 1 if versionA is > versionB.
function compareVersions(versionA, versionB) {
versionA = versionA.split(".");
versionB = versionB.split(".");
for (var i = 0; i < Math.max(versionA.length, versionB.length); i++) {
var a = parseInt(versionA[i] || 0);
var b = parseInt(versionB[i] || 0);
if (a < b) return -1;
else if (a > b) return 1;
}
return 0;
}
/*
* Returns true if the current extension version is greater than the previously recorded version in
* localStorage, and false otherwise.
*/
function shouldShowUpgradeMessage() {
// Avoid showing the upgrade notification when localStorage.previousVersion is undefined, which is the
// case for new installs.
if (!localStorage.previousVersion)
localStorage.previousVersion = currentVersion;
return compareVersions(currentVersion, localStorage.previousVersion) == 1;
}
function init() {
clearKeyMappingsAndSetDefaults();
if (localStorage["keyMappings"])
parseCustomKeyMappings(localStorage["keyMappings"]);
populateValidFirstKeys();
populateSingleKeyCommands();
if (shouldShowUpgradeMessage())
sendRequestToAllTabs({ name: "showUpgradeNotification", version: currentVersion });
// Ensure that openTabs is populated when Vimium is installed.
chrome.windows.getAll({ populate: true }, function(windows) {
for (var i in windows) {
for (var j in windows[i].tabs) {
var tab = windows[i].tabs[j];
updateOpenTabs(tab);
getScrollPosition(tab, function(tab, scrollX, scrollY) {
// Not using the tab defined in the for loop because
// it might have changed by the time this callback is activated.
updateScrollPosition(tab, scrollX, scrollY);
});
}
}
});
}
init();
</script>
</head>
</html>