opencode/packages/opencode/src/tool/shell.ts at dev · argszero/opencode · GitHub

History

645 lines (586 loc) · 20 KB

Raw

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

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

import { Effect, Stream } from "effect"

import os from "os"

import { createWriteStream } from "node:fs"

import * as Tool from "./tool"

import path from "path"

import { containsPath, type InstanceContext } from "../project/instance-context"

import { InstanceState } from "@/effect/instance-state"

import { lazy } from "@/util/lazy"

import { Language, type Node } from "web-tree-sitter"

import { FSUtil } from "@opencode-ai/core/fs-util"

import { fileURLToPath } from "url"

import { Config } from "@/config/config"

import { RuntimeFlags } from "@/effect/runtime-flags"

import { Shell } from "@opencode-ai/core/shell"

import { ShellID } from "./shell/id"

import * as Truncate from "./truncate"

import { Plugin } from "@/plugin"

import { ChildProcess } from "effect/unstable/process"

import { ChildProcessSpawner } from "effect/unstable/process/ChildProcessSpawner"

import { ShellPrompt, type Parameters } from "./shell/prompt"

import { BashArity } from "@/permission/arity"

export { Parameters } from "./shell/prompt"

const MAX_METADATA_LENGTH = 30_000

const CWD = new Set(["cd", "chdir", "popd", "pushd", "push-location", "set-location"])

const FILES = new Set([

...CWD,

"rm",

"cp",

"mv",

"mkdir",

"touch",

"chmod",

"chown",

"cat",

// Leave PowerShell aliases out for now. Common ones like cat/cp/mv/rm/mkdir

// already hit the entries above, and alias normalization should happen in one

// place later so we do not risk double-prompting.

"get-content",

"set-content",

"add-content",

"copy-item",

"move-item",

"remove-item",

"new-item",

"rename-item",

])

const CMD_FILES = new Set([

"copy",

"del",

"dir",

"erase",

"md",

"mkdir",

"move",

"rd",

"ren",

"rename",

"rmdir",

"type",

])

const FLAGS = new Set(["-destination", "-literalpath", "-path"])

const SWITCHES = new Set(["-confirm", "-debug", "-force", "-nonewline", "-recurse", "-verbose", "-whatif"])

type Part = {

type: string

text: string

}

type Scan = {

dirs: Set<string>

patterns: Set<string>

always: Set<string>

}

type Chunk = {

text: string

size: number

}

const resolveWasm = (asset: string) => {

if (asset.startsWith("file://")) return fileURLToPath(asset)

if (asset.startsWith("/") || /^[a-z]:/i.test(asset)) return asset

const url = new URL(asset, import.meta.url)

return fileURLToPath(url)

}

function parts(node: Node) {

const out: Part[] = []

for (let i = 0; i < node.childCount; i++) {

const child = node.child(i)

if (!child) continue

if (child.type === "command_elements") {

for (let j = 0; j < child.childCount; j++) {

const item = child.child(j)

if (!item || item.type === "command_argument_sep" || item.type === "redirection") continue

out.push({ type: item.type, text: item.text })

}

continue

}

if (

child.type !== "command_name" &&

child.type !== "command_name_expr" &&

child.type !== "word" &&

child.type !== "string" &&

child.type !== "raw_string" &&

child.type !== "concatenation"

) {

continue

}

out.push({ type: child.type, text: child.text })

}

return out

}

function source(node: Node) {

return (node.parent?.type === "redirected_statement" ? node.parent.text : node.text).trim()

}

function commands(node: Node) {

return node.descendantsOfType("command").filter((child): child is Node => Boolean(child))

}

function unquote(text: string) {

if (text.length < 2) return text

const first = text[0]

const last = text[text.length - 1]

if ((first === '"' || first === "'") && first === last) return text.slice(1, -1)

return text

}

function home(text: string) {

if (text === "~") return os.homedir()

if (text.startsWith("~/") || text.startsWith("~\\")) return path.join(os.homedir(), text.slice(2))

return text

}

function envValue(key: string) {

if (process.platform !== "win32") return process.env[key]

const name = Object.keys(process.env).find((item) => item.toLowerCase() === key.toLowerCase())

return name ? process.env[name] : undefined

}

function auto(key: string, cwd: string, shell: string) {

const name = key.toUpperCase()

if (name === "HOME") return os.homedir()

if (name === "PWD") return cwd

if (name === "PSHOME") return path.dirname(shell)

}

function expand(text: string, cwd: string, shell: string) {

const out = unquote(text)

.replace(/\$\{env:([^}]+)\}/gi, (_, key: string) => envValue(key) || "")

.replace(/\$env:([A-Za-z_][A-Za-z0-9_]*)/gi, (_, key: string) => envValue(key) || "")

.replace(/\$(HOME|PWD|PSHOME)(?=$|[\\/])/gi, (_, key: string) => auto(key, cwd, shell) || "")

return home(out)

}

function provider(text: string) {

const match = text.match(/^([A-Za-z]+)::(.*)$/)

if (match) {

if (match[1].toLowerCase() !== "filesystem") return

return match[2]

}

const prefix = text.match(/^([A-Za-z]+):(.*)$/)

if (!prefix) return text

if (prefix[1].length === 1) return text

return

}

function dynamic(text: string, ps: boolean) {

if (text.startsWith("(") || text.startsWith("@(")) return true

if (text.includes("$(") || text.includes("${") || text.includes("`")) return true

if (ps) return /\$(?!env:)/i.test(text)

return text.includes("$")

}

function prefix(text: string) {

const match = /[?*[]/.exec(text)

if (!match) return text

if (match.index === 0) return

return text.slice(0, match.index)

}

function pathArgs(list: Part[], ps: boolean, cmd = false) {

if (!ps) {

return list

.slice(1)

.filter(

(item) =>

!item.text.startsWith("-") &&

!(cmd && item.text.startsWith("/")) &&

!(list[0]?.text === "chmod" && item.text.startsWith("+")),

)

.map((item) => item.text)

}

const out: string[] = []

let want = false

for (const item of list.slice(1)) {

if (want) {

out.push(item.text)

want = false

continue

}

if (item.type === "command_parameter") {

const flag = item.text.toLowerCase()

if (SWITCHES.has(flag)) continue

want = FLAGS.has(flag)

continue

}

out.push(item.text)

}

return out

}

function preview(text: string) {

if (text.length <= MAX_METADATA_LENGTH) return text

return "...\n\n" + text.slice(-MAX_METADATA_LENGTH)

}

function tail(text: string, maxLines: number, maxBytes: number) {

const lines = text.split("\n")

if (lines.length <= maxLines && Buffer.byteLength(text, "utf-8") <= maxBytes) {

return {

text,

cut: false,

}

const out: string[] = []

let bytes = 0

for (let i = lines.length - 1; i >= 0 && out.length < maxLines; i--) {

const size = Buffer.byteLength(lines[i], "utf-8") + (out.length > 0 ? 1 : 0)

if (bytes + size > maxBytes) {

if (out.length === 0) {

const buf = Buffer.from(lines[i], "utf-8")

let start = buf.length - maxBytes

if (start < 0) start = 0

while (start < buf.length && (buf[start] & 0xc0) === 0x80) start++

out.unshift(buf.subarray(start).toString("utf-8"))

}

break

}

out.unshift(lines[i])

bytes += size

}

return {

text: out.join("\n"),

cut: true,

}

const parse = Effect.fn("ShellTool.parse")(function* (command: string, ps: boolean) {

const tree = yield* Effect.promise(() => parser().then((p) => (ps ? p.ps : p.bash).parse(command)))

if (!tree) throw new Error("Failed to parse command")

return tree

})

const ask = Effect.fn("ShellTool.ask")(function* (ctx: Tool.Context, scan: Scan, input: { command: string }) {

if (scan.dirs.size > 0) {

const directories = Array.from(scan.dirs)

const globs = directories.map((dir) => {

if (process.platform === "win32") return FSUtil.normalizePathPattern(path.join(dir, "*"))

return path.join(dir, "*")

})

yield* ctx.ask({

permission: "external_directory",

patterns: globs,

always: globs,

metadata: {

command: input.command,

directories,

patterns: globs,

})

}

if (scan.patterns.size === 0) return

yield* ctx.ask({

permission: ShellID.ToolID,

patterns: Array.from(scan.patterns),

always: Array.from(scan.always),

metadata: {

command: input.command,

})

function cmd(shell: string, command: string, cwd: string, env: NodeJS.ProcessEnv) {

if (process.platform === "win32" && Shell.ps(shell)) {

return ChildProcess.make(shell, ["-NoLogo", "-NoProfile", "-NonInteractive", "-Command", command], {

cwd,

env,

stdin: "ignore",

detached: false,

})

}

return ChildProcess.make(command, [], {

shell,

cwd,

env,

stdin: "ignore",

detached: process.platform !== "win32",

})

}

const parser = lazy(async () => {

const { Parser } = await import("web-tree-sitter")

const { default: treeWasm } = await import("web-tree-sitter/tree-sitter.wasm" as string, {

with: { type: "wasm" },

})

const treePath = resolveWasm(treeWasm)

await Parser.init({

locateFile() {

return treePath

})

const { default: bashWasm } = await import("tree-sitter-bash/tree-sitter-bash.wasm" as string, {

with: { type: "wasm" },

})

const { default: psWasm } = await import("tree-sitter-powershell/tree-sitter-powershell.wasm" as string, {

with: { type: "wasm" },

})

const bashPath = resolveWasm(bashWasm)

const psPath = resolveWasm(psWasm)

const [bashLanguage, psLanguage] = await Promise.all([Language.load(bashPath), Language.load(psPath)])

const bash = new Parser()

bash.setLanguage(bashLanguage)

const ps = new Parser()

ps.setLanguage(psLanguage)

return { bash, ps }

})

export const ShellTool = Tool.define(

ShellID.ToolID,

Effect.gen(function* () {

const config = yield* Config.Service

const spawner = yield* ChildProcessSpawner

const fs = yield* FSUtil.Service

const trunc = yield* Truncate.Service

const plugin = yield* Plugin.Service

const flags = yield* RuntimeFlags.Service

const defaultTimeoutMs = flags.bashDefaultTimeoutMs ?? 2 * 60 * 1000

const cygpath = Effect.fn("ShellTool.cygpath")(function* (shell: string, text: string) {

const lines = yield* spawner

.lines(ChildProcess.make(shell, ["-lc", 'cygpath -w -- "$1"', "_", text]))

.pipe(Effect.catch(() => Effect.succeed([] as string[])))

const file = lines[0]?.trim()

if (!file) return

return FSUtil.normalizePath(file)

})

const resolvePath = Effect.fn("ShellTool.resolvePath")(function* (text: string, root: string, shell: string) {

if (process.platform === "win32") {

if (Shell.posix(shell) && text.startsWith("/") && FSUtil.windowsPath(text) === text) {

const file = yield* cygpath(shell, text)

if (file) return file

}

return FSUtil.normalizePath(path.resolve(root, FSUtil.windowsPath(text)))

}

return path.resolve(root, text)

})

const argPath = Effect.fn("ShellTool.argPath")(function* (arg: string, cwd: string, ps: boolean, shell: string) {

const text = ps ? expand(arg, cwd, shell) : home(unquote(arg))

const file = text && prefix(text)

if (!file || dynamic(file, ps)) return

const next = ps ? provider(file) : file

if (!next) return

return yield* resolvePath(next, cwd, shell)

})

const collect = Effect.fn("ShellTool.collect")(function* (

root: Node,

cwd: string,

ps: boolean,

shell: string,

instance: InstanceContext,

) {

const scan: Scan = {

dirs: new Set<string>(),

patterns: new Set<string>(),

always: new Set<string>(),

}

const shellKind = ShellID.toKind(Shell.name(shell))

for (const node of commands(root)) {

const command = parts(node)

const tokens = command.map((item) => item.text)

const cmd = ps || shellKind === "cmd" ? tokens[0]?.toLowerCase() : tokens[0]

if (cmd && (FILES.has(cmd) || (shellKind === "cmd" && CMD_FILES.has(cmd)))) {

for (const arg of pathArgs(command, ps, shellKind === "cmd")) {

const resolved = yield* argPath(arg, cwd, ps, shell)

yield* Effect.logInfo("resolved path", { arg, resolved })

if (!resolved || containsPath(resolved, instance)) continue

const dir = (yield* fs.isDir(resolved)) ? resolved : path.dirname(resolved)

scan.dirs.add(dir)

}

if (tokens.length && (!cmd || !CWD.has(cmd))) {

scan.patterns.add(source(node))

scan.always.add(BashArity.prefix(tokens).join(" ") + " *")

}

return scan

})

const shellEnv = Effect.fn("ShellTool.shellEnv")(function* (ctx: Tool.Context, cwd: string) {

const extra = yield* plugin.trigger(

"shell.env",

{ cwd, sessionID: ctx.sessionID, callID: ctx.callID },

{ env: {} },

)

return {

...process.env,

...extra.env,

}

})

const run = Effect.fn("ShellTool.run")(function* (

input: {

shell: string

command: string

cwd: string

env: NodeJS.ProcessEnv

timeout: number

ctx: Tool.Context,

) {

const limits = yield* trunc.limits()

const keep = limits.maxBytes * 2

let full = ""

let last = ""

const list: Chunk[] = []

let used = 0

let file = ""

let sink: ReturnType<typeof createWriteStream> | undefined

let cut = false

let expired = false

let aborted = false

const closeSink = Effect.fnUntraced(function* () {

const stream = sink

if (!stream) return

sink = undefined

if (stream.destroyed || stream.closed) return

yield* Effect.promise(

() =>

new Promise<void>((resolve) => {

let settled = false

const done = () => {

if (settled) return

settled = true

stream.off("close", done)

stream.off("error", done)

stream.off("finish", done)

resolve()

}

stream.once("close", done)

stream.once("error", done)

stream.once("finish", done)

stream.end(done)

}),

).pipe(Effect.catch(() => Effect.void))

})

yield* ctx.metadata({

metadata: {

output: "",

})

const code: number | null = yield* Effect.scoped(

Effect.gen(function* () {

yield* Effect.addFinalizer(closeSink)

const handle = yield* spawner.spawn(cmd(input.shell, input.command, input.cwd, input.env))

yield* Effect.forkScoped(

Stream.runForEach(Stream.decodeText(handle.all), (chunk) => {

const size = Buffer.byteLength(chunk, "utf-8")

list.push({ text: chunk, size })

used += size

while (used > keep && list.length > 1) {

const item = list.shift()

if (!item) break

used -= item.size

cut = true

}

last = preview(last + chunk)

if (file) {

sink?.write(chunk)

} else {

full += chunk

if (Buffer.byteLength(full, "utf-8") > limits.maxBytes) {

return trunc.write(full).pipe(

Effect.andThen((next) =>

Effect.sync(() => {

file = next

cut = true

sink = createWriteStream(next, { flags: "a" })

full = ""

}),

Effect.andThen(

ctx.metadata({

metadata: {

output: last,

}),

)

}

return ctx.metadata({

metadata: {

output: last,

})

}),

)

const abort = Effect.callback<void>((resume) => {

if (ctx.abort.aborted) return resume(Effect.void)

const handler = () => resume(Effect.void)

ctx.abort.addEventListener("abort", handler, { once: true })

return Effect.sync(() => ctx.abort.removeEventListener("abort", handler))

})

const timeout = Effect.sleep(`${input.timeout + 100} millis`)

const exit = yield* Effect.raceAll([

handle.exitCode.pipe(Effect.map((code) => ({ kind: "exit" as const, code }))),

abort.pipe(Effect.map(() => ({ kind: "abort" as const, code: null }))),

timeout.pipe(Effect.map(() => ({ kind: "timeout" as const, code: null }))),

])

if (exit.kind === "abort") {

aborted = true

yield* handle.kill({ forceKillAfter: "3 seconds" }).pipe(Effect.orDie)

}

if (exit.kind === "timeout") {

expired = true

yield* handle.kill({ forceKillAfter: "3 seconds" }).pipe(Effect.orDie)

}

return exit.kind === "exit" ? exit.code : null

}),

).pipe(Effect.orDie)

const meta: string[] = []

if (expired) {

meta.push(

`shell tool terminated command after exceeding timeout ${input.timeout} ms. If this command is expected to take longer and is not waiting for interactive input, retry with a larger timeout value in milliseconds.`,

)

}

if (aborted) meta.push("User aborted the command")

const raw = list.map((item) => item.text).join("")

const end = tail(raw, limits.maxLines, limits.maxBytes)

if (end.cut) cut = true

if (!file && end.cut) {

file = yield* trunc.write(raw)

}

let output = end.text

if (!output) output = "(no output)"

if (cut && file) {

output = `...output truncated...\n\nFull output saved to: ${file}\n\n` + output

}

if (meta.length > 0) {

output += "\n\n<shell_metadata>\n" + meta.join("\n") + "\n</shell_metadata>"

}

return {

title: input.command,

metadata: {

output: last || preview(output),

exit: code,

truncated: cut,

...(cut && file ? { outputPath: file } : {}),

output,

}

})

return () =>

Effect.gen(function* () {

const cfg = yield* config.get()

const shell = Shell.acceptable(cfg.shell)

const name = Shell.name(shell)

const limits = yield* trunc.limits()

const prompt = ShellPrompt.render(name, process.platform, limits, defaultTimeoutMs)

yield* Effect.logInfo("shell tool using shell", { shell })

return {

description: prompt.description,

parameters: prompt.parameters,

execute: (params: Parameters, ctx: Tool.Context) =>

Effect.gen(function* () {

const instanceCtx = yield* InstanceState.context

const cwd = params.workdir

? yield* resolvePath(params.workdir, instanceCtx.directory, shell)

: instanceCtx.directory

if (params.timeout !== undefined && params.timeout < 0) {

throw new Error(`Invalid timeout value: ${params.timeout}. Timeout must be a positive number.`)

}

const timeout = params.timeout ?? defaultTimeoutMs

const ps = Shell.ps(shell)

yield* Effect.scoped(

Effect.gen(function* () {

const tree = yield* Effect.acquireRelease(parse(params.command, ps), (tree) =>

Effect.sync(() => tree.delete()),

)

const scan = yield* collect(tree.rootNode, cwd, ps, shell, instanceCtx)

if (!containsPath(cwd, instanceCtx)) scan.dirs.add(cwd)

yield* ask(ctx, scan, params)

}),

)

return yield* run(

{

shell,

command: params.command,

cwd,

env: yield* shellEnv(ctx, cwd),

timeout,

ctx,

)

}),

}

})

}),

)

opencode/packages/opencode/src/tool/shell.ts at dev · argszero/opencode · GitHub

Expand file tree

Breadcrumbs

shell.ts

Latest commit

History

Breadcrumbs

shell.ts

File metadata and controls