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
|
class NormalMode extends KeyHandlerMode {
init(options) {
if (options == null) {
options = {};
}
const defaults = {
name: "normal",
indicator: false, // There is normally no mode indicator in normal mode.
commandHandler: this.commandHandler.bind(this),
};
super.init(Object.assign(defaults, options));
chrome.storage.session.get(
"normalModeKeyStateMapping",
(items) => this.setKeyMapping(items.normalModeKeyStateMapping),
);
chrome.storage.onChanged.addListener((changes, area) => {
if (area === "session" && changes.normalModeKeyStateMapping?.newValue) {
this.setKeyMapping(changes.normalModeKeyStateMapping.newValue);
}
});
}
commandHandler({ command: registryEntry, count }) {
if (registryEntry.options.count) {
count = (count ?? 1) * registryEntry.options.count;
}
// closeTabsOnLeft and closeTabsOnRight interpret a null count as "close all tabs in
// {direction}", so don't default the count to 1 for those commands. See #4296.
const allowNullCount = ["closeTabsOnLeft", "closeTabsOnRight"].includes(registryEntry.command);
if (!allowNullCount && count == null) {
count = 1;
}
if (registryEntry.noRepeat && count) {
count = 1;
}
if ((registryEntry.repeatLimit != null) && (registryEntry.repeatLimit < count)) {
const result = confirm(
`You have asked Vimium to perform ${count} repetitions of the ` +
`command: ${registryEntry.description}.\n Are you sure you want to continue?`,
);
if (!result) return;
}
if (registryEntry.topFrame) {
// We never return to a UI-component frame (e.g. the help dialog), it might have lost the
// focus.
const sourceFrameId = window.isVimiumUIComponent ? 0 : frameId;
chrome.runtime.sendMessage({
handler: "sendMessageToFrames",
message: { handler: "runInTopFrame", sourceFrameId, registryEntry },
});
} else if (registryEntry.background) {
chrome.runtime.sendMessage({ handler: "runBackgroundCommand", registryEntry, count });
} else {
NormalModeCommands[registryEntry.command](count, { registryEntry });
}
}
}
const enterNormalMode = function (count) {
const mode = new NormalMode();
mode.init({
indicator: "Normal mode (pass keys disabled)",
exitOnEscape: true,
singleton: "enterNormalMode",
count,
});
return mode;
};
const NormalModeCommands = {
// Scrolling.
scrollToBottom() {
Marks.setPreviousPosition();
Scroller.scrollTo("y", "max");
},
scrollToTop(count) {
Marks.setPreviousPosition();
Scroller.scrollTo("y", (count - 1) * Settings.get("scrollStepSize"));
},
scrollToLeft() {
Scroller.scrollTo("x", 0);
},
scrollToRight() {
Scroller.scrollTo("x", "max");
},
scrollUp(count) {
Scroller.scrollBy("y", -1 * Settings.get("scrollStepSize") * count);
},
scrollDown(count) {
Scroller.scrollBy("y", Settings.get("scrollStepSize") * count);
},
scrollPageUp(count) {
Scroller.scrollBy("y", "viewSize", (-1 / 2) * count);
},
scrollPageDown(count) {
Scroller.scrollBy("y", "viewSize", (1 / 2) * count);
},
scrollFullPageUp(count) {
Scroller.scrollBy("y", "viewSize", -1 * count);
},
scrollFullPageDown(count) {
Scroller.scrollBy("y", "viewSize", 1 * count);
},
scrollLeft(count) {
Scroller.scrollBy("x", -1 * Settings.get("scrollStepSize") * count);
},
scrollRight(count) {
Scroller.scrollBy("x", Settings.get("scrollStepSize") * count);
},
// Tab navigation: back, forward.
goBack(count) {
history.go(-count);
},
goForward(count) {
history.go(count);
},
// Url manipulation.
goUp(count) {
let url = window.location.href;
if (url.endsWith("/")) {
url = url.substring(0, url.length - 1);
}
let urlsplit = url.split("/");
// make sure we haven't hit the base domain yet
if (urlsplit.length > 3) {
urlsplit = urlsplit.slice(0, Math.max(3, urlsplit.length - count));
window.location.href = urlsplit.join("/");
}
},
goToRoot() {
window.location.href = window.location.origin;
},
toggleViewSource() {
chrome.runtime.sendMessage({ handler: "getCurrentTabUrl" }, function (url) {
if (url.substr(0, 12) === "view-source:") {
url = url.substr(12, url.length - 12);
} else {
url = "view-source:" + url;
}
chrome.runtime.sendMessage({ handler: "openUrlInNewTab", url });
});
},
copyCurrentUrl() {
chrome.runtime.sendMessage({ handler: "getCurrentTabUrl" }, function (url) {
HUD.copyToClipboard(url);
if (28 < url.length) {
url = url.slice(0, 26) + "....";
}
HUD.show(`Yanked ${url}`, 2000);
});
},
openCopiedUrlInNewTab(count) {
HUD.pasteFromClipboard((url) =>
chrome.runtime.sendMessage({ handler: "openUrlInNewTab", url, count })
);
},
openCopiedUrlInCurrentTab() {
HUD.pasteFromClipboard((url) =>
chrome.runtime.sendMessage({ handler: "openUrlInCurrentTab", url })
);
},
// Mode changes.
enterInsertMode() {
// If a focusable element receives the focus, then we exit and leave the permanently-installed
// insert-mode instance to take over.
return new InsertMode({ global: true, exitOnFocus: true });
},
enterVisualMode() {
const mode = new VisualMode();
mode.init({ userLaunchedMode: true });
return mode;
},
enterVisualLineMode() {
const mode = new VisualLineMode();
mode.init({ userLaunchedMode: true });
return mode;
},
enterFindMode() {
Marks.setPreviousPosition();
return new FindMode();
},
// Find.
performFind(count) {
for (let i = 0, end = count; i < end; i++) {
FindMode.findNext(false);
}
},
performBackwardsFind(count) {
for (let i = 0, end = count; i < end; i++) {
FindMode.findNext(true);
}
},
// Misc.
mainFrame() {
return focusThisFrame({ highlight: true, forceFocusThisFrame: true });
},
showHelp(sourceFrameId) {
return HelpDialog.toggle({ sourceFrameId, showAllCommandDetails: false });
},
passNextKey(count, options) {
// TODO(philc): OK to remove return statement?
if (options.registryEntry.options.normal) {
return enterNormalMode(count);
} else {
return new PassNextKeyMode(count);
}
},
goPrevious() {
const previousPatterns = Settings.get("previousPatterns") || "";
const previousStrings = previousPatterns.split(",").filter((s) => s.trim().length);
return findAndFollowRel("prev") || findAndFollowLink(previousStrings);
},
goNext() {
const nextPatterns = Settings.get("nextPatterns") || "";
const nextStrings = nextPatterns.split(",").filter((s) => s.trim().length);
return findAndFollowRel("next") || findAndFollowLink(nextStrings);
},
focusInput(count) {
// Focus the first input element on the page, and create overlays to highlight all the input
// elements, with the currently-focused element highlighted specially. Tabbing will shift focus
// to the next input element. Pressing any other key will remove the overlays and the special
// tab behavior.
let element, selectedInputIndex;
const resultSet = DomUtils.evaluateXPath(
textInputXPath,
XPathResult.ORDERED_NODE_SNAPSHOT_TYPE,
);
const visibleInputs = [];
for (let i = 0, end = resultSet.snapshotLength; i < end; i++) {
element = resultSet.snapshotItem(i);
if (!DomUtils.getVisibleClientRect(element, true)) {
continue;
}
visibleInputs.push({ element, index: i, rect: Rect.copy(element.getBoundingClientRect()) });
}
visibleInputs.sort(
function ({ element: element1, index: i1 }, { element: element2, index: i2 }) {
// Put elements with a lower positive tabIndex first, keeping elements in DOM order.
if (element1.tabIndex > 0) {
if (element2.tabIndex > 0) {
const tabDifference = element1.tabIndex - element2.tabIndex;
if (tabDifference !== 0) {
return tabDifference;
} else {
return i1 - i2;
}
} else {
return -1;
}
} else if (element2.tabIndex > 0) {
return 1;
} else {
return i1 - i2;
}
},
);
if (visibleInputs.length === 0) {
HUD.show("There are no inputs to focus.", 1000);
return;
}
// This is a hack to improve usability on the Vimium options page. We prime the recently-focused
// input to be the key-mappings input. Arguably, this is the input that the user is most likely
// to use.
const recentlyFocusedElement = lastFocusedInput();
if (count === 1) {
// As the starting index, we pick that of the most recently focused input element (or 0).
const elements = visibleInputs.map((visibleInput) => visibleInput.element);
selectedInputIndex = Math.max(0, elements.indexOf(recentlyFocusedElement));
} else {
selectedInputIndex = Math.min(count, visibleInputs.length) - 1;
}
const hints = visibleInputs.map((tuple) => {
const hint = DomUtils.createElement("div");
hint.className = "vimiumReset internalVimiumInputHint vimiumInputHint";
// minus 1 for the border
hint.style.left = (tuple.rect.left - 1) + window.scrollX + "px";
hint.style.top = (tuple.rect.top - 1) + window.scrollY + "px";
hint.style.width = tuple.rect.width + "px";
hint.style.height = tuple.rect.height + "px";
return hint;
});
return new FocusSelector(hints, visibleInputs, selectedInputIndex);
},
};
if (typeof LinkHints !== "undefined") {
Object.assign(NormalModeCommands, {
"LinkHints.activateMode": LinkHints.activateMode.bind(LinkHints),
"LinkHints.activateModeToOpenInNewTab": LinkHints.activateModeToOpenInNewTab.bind(LinkHints),
"LinkHints.activateModeToOpenInNewForegroundTab": LinkHints.activateModeToOpenInNewForegroundTab
.bind(LinkHints),
"LinkHints.activateModeWithQueue": LinkHints.activateModeWithQueue.bind(LinkHints),
"LinkHints.activateModeToOpenIncognito": LinkHints.activateModeToOpenIncognito.bind(LinkHints),
"LinkHints.activateModeToDownloadLink": LinkHints.activateModeToDownloadLink.bind(LinkHints),
"LinkHints.activateModeToCopyLinkUrl": LinkHints.activateModeToCopyLinkUrl.bind(LinkHints),
});
}
if (typeof Vomnibar !== "undefined") {
Object.assign(NormalModeCommands, {
"Vomnibar.activate": Vomnibar.activate.bind(Vomnibar),
"Vomnibar.activateInNewTab": Vomnibar.activateInNewTab.bind(Vomnibar),
"Vomnibar.activateTabSelection": Vomnibar.activateTabSelection.bind(Vomnibar),
"Vomnibar.activateBookmarks": Vomnibar.activateBookmarks.bind(Vomnibar),
"Vomnibar.activateBookmarksInNewTab": Vomnibar.activateBookmarksInNewTab.bind(Vomnibar),
"Vomnibar.activateEditUrl": Vomnibar.activateEditUrl.bind(Vomnibar),
"Vomnibar.activateEditUrlInNewTab": Vomnibar.activateEditUrlInNewTab.bind(Vomnibar),
});
}
if (typeof Marks !== "undefined") {
Object.assign(NormalModeCommands, {
"Marks.activateCreateMode": Marks.activateCreateMode.bind(Marks),
"Marks.activateGotoMode": Marks.activateGotoMode.bind(Marks),
});
}
// The types in <input type="..."> that we consider for focusInput command. Right now this is
// recalculated in each content script. Alternatively we could calculate it once in the background
// page and use a request to fetch it each time.
// Should we include the HTML5 date pickers here?
// The corresponding XPath for such elements.
const textInputXPath = (function () {
const textInputTypes = ["text", "search", "email", "url", "number", "password", "date", "tel"];
const inputElements = [
"input[" +
"(" + textInputTypes.map((type) => '@type="' + type + '"').join(" or ") + "or not(@type))" +
" and not(@disabled or @readonly)]",
"textarea",
"*[@contenteditable='' or translate(@contenteditable, 'TRUE', 'true')='true']",
];
if (typeof DomUtils !== "undefined" && DomUtils !== null) {
return DomUtils.makeXPath(inputElements);
}
})();
// used by the findAndFollow* functions.
const followLink = function (linkElement) {
if (linkElement.nodeName.toLowerCase() === "link") {
window.location.href = linkElement.href;
} else {
// if we can click on it, don't simply set location.href: some next/prev links are meant to
// trigger AJAX calls, like the 'more' button on GitHub's newsfeed.
linkElement.scrollIntoView();
DomUtils.simulateClick(linkElement);
}
};
//
// Find and follow a link which matches any one of a list of strings. If there are multiple such
// links, they are prioritized for shortness, by their position in `linkStrings`, how far down the
// page they are located, and finally by whether the match is exact. Practically speaking, this
// means we favor 'next page' over 'the next big thing', and 'more' over 'nextcompany', even if
// 'next' occurs before 'more' in `linkStrings`.
//
const findAndFollowLink = function (linkStrings) {
const linksXPath = DomUtils.makeXPath([
"a",
"*[@onclick or @role='link' or contains(@class, 'button')]",
]);
const links = DomUtils.evaluateXPath(linksXPath, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE);
let candidateLinks = [];
// at the end of this loop, candidateLinks will contain all visible links that match our patterns
// links lower in the page are more likely to be the ones we want, so we loop through the snapshot
// backwards
for (let i = links.snapshotLength - 1; i >= 0; i--) {
const link = links.snapshotItem(i);
// ensure link is visible (we don't mind if it is scrolled offscreen)
const boundingClientRect = link.getBoundingClientRect();
if ((boundingClientRect.width === 0) || (boundingClientRect.height === 0)) {
continue;
}
const computedStyle = window.getComputedStyle(link, null);
const isHidden = computedStyle.getPropertyValue("visibility") != "visible" ||
computedStyle.getPropertyValue("display") == "none";
if (isHidden) continue;
let linkMatches = false;
for (const linkString of linkStrings) {
// SVG elements can have a null innerText.
const matches = link.innerText?.toLowerCase().includes(linkString) ||
link.value?.includes?.(linkString) ||
link.getAttribute("title")?.toLowerCase().includes(linkString) ||
link.getAttribute("aria-label")?.toLowerCase().includes(linkString);
if (matches) {
linkMatches = true;
break;
}
}
if (!linkMatches) continue;
candidateLinks.push(link);
}
if (candidateLinks.length == 0) return;
for (const link of candidateLinks) {
link.wordCount = link.innerText.trim().split(/\s+/).length;
}
// We can use this trick to ensure that Array.sort is stable. We need this property to retain the
// reverse in-page order of the links.
candidateLinks.forEach((a, i) => a.originalIndex = i);
// favor shorter links, and ignore those that are more than one word longer than the shortest link
candidateLinks = candidateLinks
.sort(function (a, b) {
if (a.wordCount === b.wordCount) {
return a.originalIndex - b.originalIndex;
} else {
return a.wordCount - b.wordCount;
}
})
.filter((a) => a.wordCount <= (candidateLinks[0].wordCount + 1));
for (const linkString of linkStrings) {
const exactWordRegex = /\b/.test(linkString[0]) || /\b/.test(linkString[linkString.length - 1])
? new RegExp("\\b" + linkString + "\\b", "i")
: new RegExp(linkString, "i");
for (const candidateLink of candidateLinks) {
if (
candidateLink.innerText.match(exactWordRegex) ||
candidateLink.value?.match(exactWordRegex) ||
candidateLink.getAttribute("title")?.match(exactWordRegex) ||
candidateLink.getAttribute("aria-label")?.match(exactWordRegex)
) {
followLink(candidateLink);
return true;
}
}
}
return false;
};
const findAndFollowRel = function (value) {
const relTags = ["link", "a", "area"];
for (const tag of relTags) {
const elements = document.getElementsByTagName(tag);
for (const element of Array.from(elements)) {
if (element.hasAttribute("rel") && (element.rel.toLowerCase() === value)) {
followLink(element);
return true;
}
}
}
};
class FocusSelector extends Mode {
constructor(hints, visibleInputs, selectedInputIndex) {
super(...arguments);
super.init({
name: "focus-selector",
exitOnClick: true,
keydown: (event) => {
if (event.key === "Tab") {
hints[selectedInputIndex].classList.remove("internalVimiumSelectedInputHint");
selectedInputIndex += hints.length + (event.shiftKey ? -1 : 1);
selectedInputIndex %= hints.length;
hints[selectedInputIndex].classList.add("internalVimiumSelectedInputHint");
DomUtils.simulateSelect(visibleInputs[selectedInputIndex].element);
return this.suppressEvent;
} else if (event.key !== "Shift") {
this.exit();
// Give the new mode the opportunity to handle the event.
return this.restartBubbling;
}
},
});
this.hintContainingDiv = DomUtils.addElementsToPage(hints, {
id: "vimiumInputMarkerContainer",
className: "vimiumReset",
});
DomUtils.simulateSelect(visibleInputs[selectedInputIndex].element);
if (visibleInputs.length === 1) {
this.exit();
return;
} else {
hints[selectedInputIndex].classList.add("internalVimiumSelectedInputHint");
}
}
exit() {
super.exit();
DomUtils.removeElement(this.hintContainingDiv);
if (document.activeElement && DomUtils.isEditable(document.activeElement)) {
return new InsertMode({
singleton: "post-find-mode/focus-input",
targetElement: document.activeElement,
indicator: false,
});
}
}
}
window.NormalMode = NormalMode;
window.NormalModeCommands = NormalModeCommands;
|