Repository navigation
Expand file tree
/
Copy pathtool-provider.ts
More file actions
315 lines (281 loc) · 9.87 KB
/
Copy pathtool-provider.ts
File metadata and controls
315 lines (281 loc) · 9.87 KB
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
import type { ClickButton } from '@agent-device/contracts/click-button';
import type { ScrollDirection } from '@agent-device/contracts/scroll-gesture';
import { AppError } from '@agent-device/kernel/errors';
import {
runCmd,
whichCmd,
type ExecOptions,
type ExecResult,
commandHostEnvironment,
} from '@agent-device/host-kit/command';
import { emitDiagnostic } from '@agent-device/host-kit/diagnostics';
import { sleep } from '@agent-device/host-kit/retry';
import { createScopedProvider } from '@agent-device/kernel/scoped-provider';
import type {
LinuxAccessibilityTree,
LinuxSnapshotSurface,
LinuxTraversalOptions,
} from './accessibility-types.ts';
export type LinuxToolCommandExecutor = (
cmd: string,
args: string[],
options?: ExecOptions,
) => Promise<ExecResult>;
export type LinuxToolAvailabilityChecker = (cmd: string) => Promise<boolean>;
export type LinuxDesktopProvider = {
openTarget(target: string): Promise<void>;
closeApp(app: string): Promise<void>;
};
export type LinuxClipboardProvider = {
readText(): Promise<string>;
writeText(text: string): Promise<void>;
};
export type LinuxScreenshotOptions = {
fullscreen?: boolean;
stabilize?: boolean;
surface?: string;
};
export type LinuxScreenshotProvider = {
capture(outPath: string, options?: LinuxScreenshotOptions): Promise<void>;
};
export type LinuxAccessibilityProvider = {
captureTree(
surface: LinuxSnapshotSurface,
options?: LinuxTraversalOptions,
): Promise<LinuxAccessibilityTree>;
};
export type LinuxPointerButton = ClickButton;
export type LinuxInputProvider = {
click(x: number, y: number, button: LinuxPointerButton): Promise<void>;
doubleClick(x: number, y: number): Promise<void>;
longPress(x: number, y: number, durationMs: number): Promise<void>;
drag(x1: number, y1: number, x2: number, y2: number, durationMs: number): Promise<void>;
scroll(
direction: ScrollDirection,
options?: { amount?: number; pixels?: number; durationMs?: number },
): Promise<void>;
typeText(text: string, options?: { delayMs?: number }): Promise<void>;
key(combo: string, scancodes: string[]): Promise<void>;
};
export type LinuxToolProvider = {
runCommand: LinuxToolCommandExecutor;
whichCommand: LinuxToolAvailabilityChecker;
desktop: LinuxDesktopProvider;
clipboard?: LinuxClipboardProvider;
screenshot?: LinuxScreenshotProvider;
accessibility?: LinuxAccessibilityProvider;
input?: LinuxInputProvider;
};
const whichOnPath = async (cmd: string): Promise<boolean> =>
await whichCmd(cmd, commandHostEnvironment().env);
const localLinuxToolProvider: LinuxToolProvider = {
runCommand: runCmd,
whichCommand: whichOnPath,
desktop: createLocalLinuxDesktopProvider(runCmd, whichOnPath),
clipboard: createLocalLinuxClipboardProvider(runCmd, whichOnPath),
screenshot: createLocalLinuxScreenshotProvider(runCmd, whichOnPath),
};
const linuxToolProviderScope = createScopedProvider(
localLinuxToolProvider,
createLocalLinuxToolProvider,
);
export function createLocalLinuxToolProvider(
provider: Partial<LinuxToolProvider> = {},
): LinuxToolProvider {
const merged = {
...localLinuxToolProvider,
...provider,
};
return {
...merged,
desktop:
provider.desktop ?? createLocalLinuxDesktopProvider(merged.runCommand, merged.whichCommand),
clipboard:
provider.clipboard ??
createLocalLinuxClipboardProvider(merged.runCommand, merged.whichCommand),
screenshot:
provider.screenshot ??
createLocalLinuxScreenshotProvider(merged.runCommand, merged.whichCommand),
};
}
export function resolveLinuxToolProvider(provider?: LinuxToolProvider): LinuxToolProvider {
return linuxToolProviderScope.resolve(provider);
}
export async function withLinuxToolProvider<T>(
provider: LinuxToolProvider | undefined,
fn: () => Promise<T>,
): Promise<T> {
return await linuxToolProviderScope.run(provider, fn);
}
export async function runLinuxToolCommand(
cmd: string,
args: string[],
options?: ExecOptions,
): Promise<ExecResult> {
return await resolveLinuxToolProvider().runCommand(cmd, args, options);
}
function createLocalLinuxDesktopProvider(
runCommand: LinuxToolCommandExecutor,
whichCommand: LinuxToolAvailabilityChecker,
): LinuxDesktopProvider {
return {
async openTarget(target) {
if (target.includes('://') || target.startsWith('/')) {
await runCommand('xdg-open', [target]);
return;
}
if (await whichCommand(target)) {
runCommand(target, [], { allowFailure: true }).catch((error) => {
emitDiagnostic({
level: 'warn',
phase: 'linux_app_launch',
data: { app: target, error: String(error) },
});
});
await sleep(500);
return;
}
await runCommand('xdg-open', [target], { allowFailure: true });
},
async closeApp(app) {
if (await whichCommand('wmctrl')) {
await runCommand('wmctrl', ['-c', app], { allowFailure: true });
return;
}
await runCommand('pkill', ['-x', app], { allowFailure: true });
},
};
}
function createLocalLinuxClipboardProvider(
runCommand: LinuxToolCommandExecutor,
whichCommand: LinuxToolAvailabilityChecker,
): LinuxClipboardProvider {
return {
async readText() {
const tool = await resolveLocalLinuxTool(whichCommand, LOCAL_CLIPBOARD_TOOLS);
const command = LOCAL_CLIPBOARD_READ_COMMANDS[tool];
return (await runCommand(command.cmd, command.args, command.options)).stdout;
},
async writeText(text) {
const tool = await resolveLocalLinuxTool(whichCommand, LOCAL_CLIPBOARD_TOOLS);
const command = LOCAL_CLIPBOARD_WRITE_COMMANDS[tool](text);
await runCommand(command.cmd, command.args, command.options);
},
};
}
function createLocalLinuxScreenshotProvider(
runCommand: LinuxToolCommandExecutor,
whichCommand: LinuxToolAvailabilityChecker,
): LinuxScreenshotProvider {
return {
async capture(outPath) {
const tool = await resolveLocalLinuxTool(whichCommand, LOCAL_SCREENSHOT_TOOLS);
const command = LOCAL_SCREENSHOT_COMMANDS[tool](outPath);
await runCommand(command.cmd, command.args, command.options);
},
};
}
type LocalLinuxClipboardTool = 'wl-clipboard' | 'xclip' | 'xsel';
type LocalLinuxScreenshotTool = 'grim' | 'gnome-screenshot' | 'scrot' | 'import';
type LocalLinuxToolCommand = {
cmd: string;
args: string[];
options?: ExecOptions;
};
type LocalLinuxToolCandidate<T extends string> = {
tool: T;
command: string;
};
type LocalLinuxToolConfig<T extends string> = {
wayland: readonly LocalLinuxToolCandidate<T>[];
x11: readonly LocalLinuxToolCandidate<T>[];
waylandError: string;
x11Error: string;
};
const LOCAL_TOOL_TIMEOUT_MS = 5000;
const LOCAL_CLIPBOARD_TOOLS = {
wayland: [{ tool: 'wl-clipboard', command: 'wl-paste' }],
x11: [
{ tool: 'xclip', command: 'xclip' },
{ tool: 'xsel', command: 'xsel' },
],
waylandError:
'wl-paste (wl-clipboard) is required for clipboard access on Wayland. Install via your package manager.',
x11Error:
'xclip or xsel is required for clipboard access on X11. Install via your package manager.',
} satisfies LocalLinuxToolConfig<LocalLinuxClipboardTool>;
const LOCAL_SCREENSHOT_TOOLS = {
wayland: [
{ tool: 'grim', command: 'grim' },
{ tool: 'gnome-screenshot', command: 'gnome-screenshot' },
],
x11: [
{ tool: 'scrot', command: 'scrot' },
{ tool: 'import', command: 'import' },
{ tool: 'gnome-screenshot', command: 'gnome-screenshot' },
],
waylandError:
'grim or gnome-screenshot is required for screenshots on Wayland. Install via your package manager.',
x11Error:
'scrot, import (ImageMagick), or gnome-screenshot is required for screenshots on X11. Install via your package manager.',
} satisfies LocalLinuxToolConfig<LocalLinuxScreenshotTool>;
const LOCAL_CLIPBOARD_READ_COMMANDS: Record<LocalLinuxClipboardTool, LocalLinuxToolCommand> = {
'wl-clipboard': {
cmd: 'wl-paste',
args: ['--no-newline'],
options: { allowFailure: true, timeoutMs: LOCAL_TOOL_TIMEOUT_MS },
},
xclip: {
cmd: 'xclip',
args: ['-selection', 'clipboard', '-o'],
options: { allowFailure: true, timeoutMs: LOCAL_TOOL_TIMEOUT_MS },
},
xsel: {
cmd: 'xsel',
args: ['--clipboard', '--output'],
options: { allowFailure: true, timeoutMs: LOCAL_TOOL_TIMEOUT_MS },
},
};
const LOCAL_CLIPBOARD_WRITE_COMMANDS: Record<
LocalLinuxClipboardTool,
(text: string) => LocalLinuxToolCommand
> = {
'wl-clipboard': (text) => ({
cmd: 'wl-copy',
args: ['--', text],
options: { allowFailure: false, timeoutMs: LOCAL_TOOL_TIMEOUT_MS },
}),
xclip: (text) => ({
cmd: 'xclip',
args: ['-selection', 'clipboard'],
options: { allowFailure: false, timeoutMs: LOCAL_TOOL_TIMEOUT_MS, stdin: text },
}),
xsel: (text) => ({
cmd: 'xsel',
args: ['--clipboard', '--input'],
options: { allowFailure: false, timeoutMs: LOCAL_TOOL_TIMEOUT_MS, stdin: text },
}),
};
const LOCAL_SCREENSHOT_COMMANDS: Record<
LocalLinuxScreenshotTool,
(outPath: string) => LocalLinuxToolCommand
> = {
grim: (outPath) => ({ cmd: 'grim', args: [outPath] }),
scrot: (outPath) => ({ cmd: 'scrot', args: [outPath] }),
import: (outPath) => ({ cmd: 'import', args: ['-window', 'root', outPath] }),
'gnome-screenshot': (outPath) => ({ cmd: 'gnome-screenshot', args: ['-f', outPath] }),
};
async function resolveLocalLinuxTool<T extends string>(
whichCommand: LinuxToolAvailabilityChecker,
config: LocalLinuxToolConfig<T>,
): Promise<T> {
const display = isLinuxWayland() ? 'wayland' : 'x11';
for (const candidate of config[display]) {
if (await whichCommand(candidate.command)) return candidate.tool;
}
throw new AppError('TOOL_MISSING', display === 'wayland' ? config.waylandError : config.x11Error);
}
function isLinuxWayland(): boolean {
const environment = commandHostEnvironment().env;
return Boolean(environment['WAYLAND_DISPLAY']) || environment['XDG_SESSION_TYPE'] === 'wayland';
}