tor-browser

Input.ts (16721B)

---

/**
* @license
* Copyright 2017 Google Inc.
* SPDX-License-Identifier: Apache-2.0
*/

import type {Protocol} from 'devtools-protocol';

import type {CDPSession} from '../api/CDPSession.js';
import type {Point} from '../api/ElementHandle.js';
import {
 Keyboard,
 Mouse,
 MouseButton,
 Touchscreen,
 type TouchHandle,
 type KeyDownOptions,
 type KeyPressOptions,
 type KeyboardTypeOptions,
 type MouseClickOptions,
 type MouseMoveOptions,
 type MouseOptions,
 type MouseWheelOptions,
} from '../api/Input.js';
import {TouchError} from '../common/Errors.js';
import {
 _keyDefinitions,
 type KeyDefinition,
 type KeyInput,
} from '../common/USKeyboardLayout.js';
import {assert} from '../util/assert.js';

type KeyDescription = Required<
 Pick<KeyDefinition, 'keyCode' | 'key' | 'text' | 'code' | 'location'>
>;

/**
* @internal
*/
export class CdpKeyboard extends Keyboard {
 #client: CDPSession;
 #pressedKeys = new Set<string>();

 _modifiers = 0;

 constructor(client: CDPSession) {
   super();
   this.#client = client;
 }

 updateClient(client: CDPSession): void {
   this.#client = client;
 }

 override async down(
   key: KeyInput,
   options: Readonly<KeyDownOptions> = {
     text: undefined,
     commands: [],
   },
 ): Promise<void> {
   const description = this.#keyDescriptionForString(key);

   const autoRepeat = this.#pressedKeys.has(description.code);
   this.#pressedKeys.add(description.code);
   this._modifiers |= this.#modifierBit(description.key);

   const text = options.text === undefined ? description.text : options.text;
   await this.#client.send('Input.dispatchKeyEvent', {
     type: text ? 'keyDown' : 'rawKeyDown',
     modifiers: this._modifiers,
     windowsVirtualKeyCode: description.keyCode,
     code: description.code,
     key: description.key,
     text: text,
     unmodifiedText: text,
     autoRepeat,
     location: description.location,
     isKeypad: description.location === 3,
     commands: options.commands,
   });
 }

 #modifierBit(key: string): number {
   if (key === 'Alt') {
     return 1;
   }
   if (key === 'Control') {
     return 2;
   }
   if (key === 'Meta') {
     return 4;
   }
   if (key === 'Shift') {
     return 8;
   }
   return 0;
 }

 #keyDescriptionForString(keyString: KeyInput): KeyDescription {
   const shift = this._modifiers & 8;
   const description = {
     key: '',
     keyCode: 0,
     code: '',
     text: '',
     location: 0,
   };

   const definition = _keyDefinitions[keyString];
   assert(definition, `Unknown key: "${keyString}"`);

   if (definition.key) {
     description.key = definition.key;
   }
   if (shift && definition.shiftKey) {
     description.key = definition.shiftKey;
   }

   if (definition.keyCode) {
     description.keyCode = definition.keyCode;
   }
   if (shift && definition.shiftKeyCode) {
     description.keyCode = definition.shiftKeyCode;
   }

   if (definition.code) {
     description.code = definition.code;
   }

   if (definition.location) {
     description.location = definition.location;
   }

   if (description.key.length === 1) {
     description.text = description.key;
   }

   if (definition.text) {
     description.text = definition.text;
   }
   if (shift && definition.shiftText) {
     description.text = definition.shiftText;
   }

   // if any modifiers besides shift are pressed, no text should be sent
   if (this._modifiers & ~8) {
     description.text = '';
   }

   return description;
 }

 override async up(key: KeyInput): Promise<void> {
   const description = this.#keyDescriptionForString(key);

   this._modifiers &= ~this.#modifierBit(description.key);
   this.#pressedKeys.delete(description.code);
   await this.#client.send('Input.dispatchKeyEvent', {
     type: 'keyUp',
     modifiers: this._modifiers,
     key: description.key,
     windowsVirtualKeyCode: description.keyCode,
     code: description.code,
     location: description.location,
   });
 }

 override async sendCharacter(char: string): Promise<void> {
   await this.#client.send('Input.insertText', {text: char});
 }

 private charIsKey(char: string): char is KeyInput {
   return !!_keyDefinitions[char as KeyInput];
 }

 override async type(
   text: string,
   options: Readonly<KeyboardTypeOptions> = {},
 ): Promise<void> {
   const delay = options.delay || undefined;
   for (const char of text) {
     if (this.charIsKey(char)) {
       await this.press(char, {delay});
     } else {
       if (delay) {
         await new Promise(f => {
           return setTimeout(f, delay);
         });
       }
       await this.sendCharacter(char);
     }
   }
 }

 override async press(
   key: KeyInput,
   options: Readonly<KeyPressOptions> = {},
 ): Promise<void> {
   const {delay = null} = options;
   await this.down(key, options);
   if (delay) {
     await new Promise(f => {
       return setTimeout(f, options.delay);
     });
   }
   await this.up(key);
 }
}

/**
* This must follow {@link Protocol.Input.DispatchMouseEventRequest.buttons}.
*/
const enum MouseButtonFlag {
 None = 0,
 Left = 1,
 Right = 1 << 1,
 Middle = 1 << 2,
 Back = 1 << 3,
 Forward = 1 << 4,
}

const getFlag = (button: MouseButton): MouseButtonFlag => {
 switch (button) {
   case MouseButton.Left:
     return MouseButtonFlag.Left;
   case MouseButton.Right:
     return MouseButtonFlag.Right;
   case MouseButton.Middle:
     return MouseButtonFlag.Middle;
   case MouseButton.Back:
     return MouseButtonFlag.Back;
   case MouseButton.Forward:
     return MouseButtonFlag.Forward;
 }
};

/**
* This should match
* https://source.chromium.org/chromium/chromium/src/+/refs/heads/main:content/browser/renderer_host/input/web_input_event_builders_mac.mm;drc=a61b95c63b0b75c1cfe872d9c8cdf927c226046e;bpv=1;bpt=1;l=221.
*/
const getButtonFromPressedButtons = (
 buttons: number,
): Protocol.Input.MouseButton => {
 if (buttons & MouseButtonFlag.Left) {
   return MouseButton.Left;
 } else if (buttons & MouseButtonFlag.Right) {
   return MouseButton.Right;
 } else if (buttons & MouseButtonFlag.Middle) {
   return MouseButton.Middle;
 } else if (buttons & MouseButtonFlag.Back) {
   return MouseButton.Back;
 } else if (buttons & MouseButtonFlag.Forward) {
   return MouseButton.Forward;
 }
 return 'none';
};

interface MouseState {
 /**
  * The current position of the mouse.
  */
 position: Point;
 /**
  * The buttons that are currently being pressed.
  */
 buttons: number;
}

/**
* @internal
*/
export class CdpMouse extends Mouse {
 #client: CDPSession;
 #keyboard: CdpKeyboard;

 constructor(client: CDPSession, keyboard: CdpKeyboard) {
   super();
   this.#client = client;
   this.#keyboard = keyboard;
 }

 updateClient(client: CDPSession): void {
   this.#client = client;
 }

 #_state: Readonly<MouseState> = {
   position: {x: 0, y: 0},
   buttons: MouseButtonFlag.None,
 };
 get #state(): MouseState {
   return Object.assign({...this.#_state}, ...this.#transactions);
 }

 // Transactions can run in parallel, so we store each of thme in this array.
 #transactions: Array<Partial<MouseState>> = [];
 #createTransaction(): {
   update: (updates: Partial<MouseState>) => void;
   commit: () => void;
   rollback: () => void;
 } {
   const transaction: Partial<MouseState> = {};
   this.#transactions.push(transaction);
   const popTransaction = () => {
     this.#transactions.splice(this.#transactions.indexOf(transaction), 1);
   };
   return {
     update: (updates: Partial<MouseState>) => {
       Object.assign(transaction, updates);
     },
     commit: () => {
       this.#_state = {...this.#_state, ...transaction};
       popTransaction();
     },
     rollback: popTransaction,
   };
 }

 /**
  * This is a shortcut for a typical update, commit/rollback lifecycle based on
  * the error of the action.
  */
 async #withTransaction(
   action: (
     update: (updates: Partial<MouseState>) => void,
   ) => Promise<unknown>,
 ): Promise<void> {
   const {update, commit, rollback} = this.#createTransaction();
   try {
     await action(update);
     commit();
   } catch (error) {
     rollback();
     throw error;
   }
 }

 override async reset(): Promise<void> {
   const actions = [];
   for (const [flag, button] of [
     [MouseButtonFlag.Left, MouseButton.Left],
     [MouseButtonFlag.Middle, MouseButton.Middle],
     [MouseButtonFlag.Right, MouseButton.Right],
     [MouseButtonFlag.Forward, MouseButton.Forward],
     [MouseButtonFlag.Back, MouseButton.Back],
   ] as const) {
     if (this.#state.buttons & flag) {
       actions.push(this.up({button: button}));
     }
   }
   if (this.#state.position.x !== 0 || this.#state.position.y !== 0) {
     actions.push(this.move(0, 0));
   }
   await Promise.all(actions);
 }

 override async move(
   x: number,
   y: number,
   options: Readonly<MouseMoveOptions> = {},
 ): Promise<void> {
   const {steps = 1} = options;
   const from = this.#state.position;
   const to = {x, y};
   for (let i = 1; i <= steps; i++) {
     await this.#withTransaction(updateState => {
       updateState({
         position: {
           x: from.x + (to.x - from.x) * (i / steps),
           y: from.y + (to.y - from.y) * (i / steps),
         },
       });
       const {buttons, position} = this.#state;
       return this.#client.send('Input.dispatchMouseEvent', {
         type: 'mouseMoved',
         modifiers: this.#keyboard._modifiers,
         buttons,
         button: getButtonFromPressedButtons(buttons),
         ...position,
       });
     });
   }
 }

 override async down(options: Readonly<MouseOptions> = {}): Promise<void> {
   const {button = MouseButton.Left, clickCount = 1} = options;
   const flag = getFlag(button);
   if (!flag) {
     throw new Error(`Unsupported mouse button: ${button}`);
   }
   if (this.#state.buttons & flag) {
     throw new Error(`'${button}' is already pressed.`);
   }
   await this.#withTransaction(updateState => {
     updateState({
       buttons: this.#state.buttons | flag,
     });
     const {buttons, position} = this.#state;
     return this.#client.send('Input.dispatchMouseEvent', {
       type: 'mousePressed',
       modifiers: this.#keyboard._modifiers,
       clickCount,
       buttons,
       button,
       ...position,
     });
   });
 }

 override async up(options: Readonly<MouseOptions> = {}): Promise<void> {
   const {button = MouseButton.Left, clickCount = 1} = options;
   const flag = getFlag(button);
   if (!flag) {
     throw new Error(`Unsupported mouse button: ${button}`);
   }
   if (!(this.#state.buttons & flag)) {
     throw new Error(`'${button}' is not pressed.`);
   }
   await this.#withTransaction(updateState => {
     updateState({
       buttons: this.#state.buttons & ~flag,
     });
     const {buttons, position} = this.#state;
     return this.#client.send('Input.dispatchMouseEvent', {
       type: 'mouseReleased',
       modifiers: this.#keyboard._modifiers,
       clickCount,
       buttons,
       button,
       ...position,
     });
   });
 }

 override async click(
   x: number,
   y: number,
   options: Readonly<MouseClickOptions> = {},
 ): Promise<void> {
   const {delay, count = 1, clickCount = count} = options;
   if (count < 1) {
     throw new Error('Click must occur a positive number of times.');
   }
   const actions: Array<Promise<void>> = [this.move(x, y)];
   if (clickCount === count) {
     for (let i = 1; i < count; ++i) {
       actions.push(
         this.down({...options, clickCount: i}),
         this.up({...options, clickCount: i}),
       );
     }
   }
   actions.push(this.down({...options, clickCount}));
   if (typeof delay === 'number') {
     await Promise.all(actions);
     actions.length = 0;
     await new Promise(resolve => {
       setTimeout(resolve, delay);
     });
   }
   actions.push(this.up({...options, clickCount}));
   await Promise.all(actions);
 }

 override async wheel(
   options: Readonly<MouseWheelOptions> = {},
 ): Promise<void> {
   const {deltaX = 0, deltaY = 0} = options;
   const {position, buttons} = this.#state;
   await this.#client.send('Input.dispatchMouseEvent', {
     type: 'mouseWheel',
     pointerType: 'mouse',
     modifiers: this.#keyboard._modifiers,
     deltaY,
     deltaX,
     buttons,
     ...position,
   });
 }

 override async drag(
   start: Point,
   target: Point,
 ): Promise<Protocol.Input.DragData> {
   const promise = new Promise<Protocol.Input.DragData>(resolve => {
     this.#client.once('Input.dragIntercepted', event => {
       return resolve(event.data);
     });
   });
   await this.move(start.x, start.y);
   await this.down();
   await this.move(target.x, target.y);
   return await promise;
 }

 override async dragEnter(
   target: Point,
   data: Protocol.Input.DragData,
 ): Promise<void> {
   await this.#client.send('Input.dispatchDragEvent', {
     type: 'dragEnter',
     x: target.x,
     y: target.y,
     modifiers: this.#keyboard._modifiers,
     data,
   });
 }

 override async dragOver(
   target: Point,
   data: Protocol.Input.DragData,
 ): Promise<void> {
   await this.#client.send('Input.dispatchDragEvent', {
     type: 'dragOver',
     x: target.x,
     y: target.y,
     modifiers: this.#keyboard._modifiers,
     data,
   });
 }

 override async drop(
   target: Point,
   data: Protocol.Input.DragData,
 ): Promise<void> {
   await this.#client.send('Input.dispatchDragEvent', {
     type: 'drop',
     x: target.x,
     y: target.y,
     modifiers: this.#keyboard._modifiers,
     data,
   });
 }

 override async dragAndDrop(
   start: Point,
   target: Point,
   options: {delay?: number} = {},
 ): Promise<void> {
   const {delay = null} = options;
   const data = await this.drag(start, target);
   await this.dragEnter(target, data);
   await this.dragOver(target, data);
   if (delay) {
     await new Promise(resolve => {
       return setTimeout(resolve, delay);
     });
   }
   await this.drop(target, data);
   await this.up();
 }
}

/**
* @internal
*/
class CdpTouchHandle implements TouchHandle {
 #started = false;
 #touchScreen: CdpTouchscreen;
 #touchPoint: Protocol.Input.TouchPoint;
 #client: CDPSession;
 #keyboard: CdpKeyboard;

 constructor(
   client: CDPSession,
   touchScreen: CdpTouchscreen,
   keyboard: CdpKeyboard,
   touchPoint: Protocol.Input.TouchPoint,
 ) {
   this.#client = client;
   this.#touchScreen = touchScreen;
   this.#keyboard = keyboard;
   this.#touchPoint = touchPoint;
 }

 updateClient(client: CDPSession): void {
   this.#client = client;
 }

 async start(): Promise<void> {
   if (this.#started) {
     throw new TouchError('Touch has already started');
   }
   await this.#client.send('Input.dispatchTouchEvent', {
     type: 'touchStart',
     touchPoints: [this.#touchPoint],
     modifiers: this.#keyboard._modifiers,
   });
   this.#started = true;
 }

 move(x: number, y: number): Promise<void> {
   this.#touchPoint.x = Math.round(x);
   this.#touchPoint.y = Math.round(y);
   return this.#client.send('Input.dispatchTouchEvent', {
     type: 'touchMove',
     touchPoints: [this.#touchPoint],
     modifiers: this.#keyboard._modifiers,
   });
 }

 async end(): Promise<void> {
   await this.#client.send('Input.dispatchTouchEvent', {
     type: 'touchEnd',
     touchPoints: [this.#touchPoint],
     modifiers: this.#keyboard._modifiers,
   });
   this.#touchScreen.removeHandle(this);
 }
}

/**
* @internal
*/
export class CdpTouchscreen extends Touchscreen {
 #client: CDPSession;
 #keyboard: CdpKeyboard;
 declare touches: CdpTouchHandle[];

 constructor(client: CDPSession, keyboard: CdpKeyboard) {
   super();
   this.#client = client;
   this.#keyboard = keyboard;
 }

 updateClient(client: CDPSession): void {
   this.#client = client;
   this.touches.forEach(t => {
     t.updateClient(client);
   });
 }

 override async touchStart(x: number, y: number): Promise<TouchHandle> {
   const id = this.idGenerator();
   const touchPoint: Protocol.Input.TouchPoint = {
     x: Math.round(x),
     y: Math.round(y),
     radiusX: 0.5,
     radiusY: 0.5,
     force: 0.5,
     id,
   };
   const touch = new CdpTouchHandle(
     this.#client,
     this,
     this.#keyboard,
     touchPoint,
   );
   await touch.start();
   this.touches.push(touch);
   return touch;
 }
}