Fix handling of filenames

Your Name · Your Name · commit cce365a583c9 · 2024-11-29T14:35:34.000Z
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "frida-cshell",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "description": "Frida's CShell",
   "scripts": {
     "prepare": "npm run version && npm run build && npm run package && npm run copy",
diff --git a/src/breakpoints/bp.ts b/src/breakpoints/bp.ts
@@ -37,10 +37,6 @@ export abstract class Bp {
   public conditions: string[] = [];
   public commands: string[] = [];
 
-  public static idToVar(id: number): Var {
-    return new Var(uint64(id.toString()), `#${id}`);
-  }
-
   protected constructor(
     index: number,
     address: Var | null,
diff --git a/src/breakpoints/regs.ts b/src/breakpoints/regs.ts
@@ -1,5 +1,4 @@
 import { Var } from '../vars/var.js';
-import { Bp } from './bp.js';
 
 enum PseudoRegNames {
   TID = 'tid',
@@ -58,7 +57,7 @@ export class Regs {
   }
 
   public static setBreakpointId(breakpointId: number) {
-    this.pseudoRegs[PseudoRegNames.BP] = Bp.idToVar(breakpointId);
+    this.pseudoRegs[PseudoRegNames.BP] = Var.fromId(breakpointId);
   }
 
   public static get(name: string): Var {
diff --git a/src/cmdlets/breakpoints/bp.ts b/src/cmdlets/breakpoints/bp.ts
@@ -78,15 +78,12 @@ export abstract class TypedBpCmdLet
   }
 
   public usage(): Var {
+    const show = this.usageShow();
     const create = this.usageCreate();
     const modify = this.usageModify();
     const usage: string = `Usage: ${this.name}
 ${Output.bold('show:')}
-
-${this.name} - show all ${this.bpType} breakpoints
-
-${this.name} ${CmdLetBase.NUM_CHAR}n - show a ${this.bpType} breakpoint
-   ${CmdLetBase.NUM_CHAR}n      the number of the breakpoint to show
+${show}
 
 ${Output.bold('create:')}
 ${create}
@@ -105,6 +102,15 @@ ${Output.bold('NOTE:')} Set hits to '*' for unlimited breakpoint.`;
     return Var.ZERO;
   }
 
+  protected usageShow(): string {
+    const usage: string = `    
+${this.name} - show all ${this.bpType} breakpoints
+
+${this.name} ${CmdLetBase.NUM_CHAR}n - show a ${this.bpType} breakpoint
+   ${CmdLetBase.NUM_CHAR}n      the number of the breakpoint to show`;
+    return usage;
+  }
+
   protected parseConditional(token: Token): string | null {
     const literal = token.getLiteral();
     if (literal !== TypedBpCmdLet.CONDITIONAL_CHAR) return null;
diff --git a/src/cmdlets/breakpoints/code.ts b/src/cmdlets/breakpoints/code.ts
@@ -1,4 +1,4 @@
-import { Bp, BpType } from '../../breakpoints/bp.js';
+import { BpType } from '../../breakpoints/bp.js';
 import { Bps } from '../../breakpoints/bps.js';
 import {
   BpCodeInstruction,
@@ -60,7 +60,7 @@ abstract class CodeBpCmdLet extends TypedBpCmdLet {
         throw new Error(`unexpected breakpoint type: ${this.bpType}`);
     }
 
-    return Bp.idToVar(idx);
+    return Var.fromId(idx);
   }
 
   protected runModify(tokens: Token[]): Var | null {
@@ -89,7 +89,7 @@ abstract class CodeBpCmdLet extends TypedBpCmdLet {
     Output.writeln(`Modified ${bp.toString()}`);
     this.editBreakpoint(bp, conditional);
 
-    return Bp.idToVar(index);
+    return Var.fromId(index);
   }
 
   protected override usageCreate(): string {
diff --git a/src/cmdlets/breakpoints/mem.ts b/src/cmdlets/breakpoints/mem.ts
@@ -1,4 +1,4 @@
-import { Bp, BpType } from '../../breakpoints/bp.js';
+import { BpType } from '../../breakpoints/bp.js';
 import { Bps } from '../../breakpoints/bps.js';
 import { BpReadMemory, BpWriteMemory } from '../../breakpoints/memory.js';
 import { CmdLetBase } from '../../commands/cmdlet.js';
@@ -46,7 +46,7 @@ abstract class MemoryBpCmdLet extends TypedBpCmdLet {
         throw new Error(`unexpected breakpoint type: ${this.bpType}`);
     }
 
-    return Bp.idToVar(idx);
+    return Var.fromId(idx);
   }
 
   protected runModify(tokens: Token[]): Var | null {
@@ -75,7 +75,7 @@ abstract class MemoryBpCmdLet extends TypedBpCmdLet {
     Output.writeln(`Modified ${bp.toString()}`);
     this.editBreakpoint(bp, conditional);
 
-    return Bp.idToVar(index);
+    return Var.fromId(index);
   }
 
   protected override usageCreate(): string {
diff --git a/src/cmdlets/breakpoints/replace.ts b/src/cmdlets/breakpoints/replace.ts
@@ -1,15 +1,16 @@
 import { Token } from '../../io/token.js';
 import { Var } from '../../vars/var.js';
 import { TypedBpCmdLet } from './bp.js';
-import { Bp, BpType } from '../../breakpoints/bp.js';
+import { BpType } from '../../breakpoints/bp.js';
 import { Bps } from '../../breakpoints/bps.js';
 import { BpReplacement } from '../../breakpoints/replace.js';
 import { Output } from '../../io/output.js';
+import { CmdLetBase } from '../../commands/cmdlet.js';
 
 export class ReplaceCmdLet extends TypedBpCmdLet {
   name = 'replace';
   bpType = BpType.Replacement;
-  help = `replace a function with another implementation (returns the address of the trampoline)`;
+  help = `replace a function with another implementation`;
 
   public runCreate(tokens: Token[]): Var | null {
     const vars = this.transform(tokens, [this.parseVar, this.parseVar]);
@@ -22,7 +23,7 @@ export class ReplaceCmdLet extends TypedBpCmdLet {
       Bps.add(bp);
       bp.enable();
       Output.writeln(`Created ${bp.toString()}`);
-      return Bp.idToVar(index);
+      return Var.fromId(index);
     } catch (error) {
       throw new Error(`failed to replace ${address} with ${target}, ${error}`);
     }
@@ -44,6 +45,15 @@ export class ReplaceCmdLet extends TypedBpCmdLet {
     return bp.trampoline;
   }
 
+  protected override usageShow(): string {
+    const usage: string = `    
+${this.name} - show all ${this.bpType} breakpoints
+
+${this.name} ${CmdLetBase.NUM_CHAR}n - show a ${this.bpType} breakpoint (returns the address of the trampoline)
+   ${CmdLetBase.NUM_CHAR}n      the number of the breakpoint to show`;
+    return usage;
+  }
+
   protected override usageCreate(): string {
     const usage: string = `
 replace dest src - replace function
diff --git a/src/cmdlets/breakpoints/trace.ts b/src/cmdlets/breakpoints/trace.ts
@@ -1,4 +1,4 @@
-import { Bp, BpType } from '../../breakpoints/bp.js';
+import { BpType } from '../../breakpoints/bp.js';
 import { Bps } from '../../breakpoints/bps.js';
 import {
   BpBlockTrace,
@@ -60,7 +60,7 @@ abstract class TraceBpCmdLet extends TypedBpCmdLet {
         throw new Error(`unexpected breakpoint type: ${this.bpType}`);
     }
 
-    return Bp.idToVar(idx);
+    return Var.fromId(idx);
   }
 
   protected runModify(tokens: Token[]): Var | null {
@@ -92,7 +92,7 @@ abstract class TraceBpCmdLet extends TypedBpCmdLet {
     Output.writeln(`Modified ${bp.toString()}`);
     this.editBreakpoint(bp, conditional);
 
-    return Bp.idToVar(index);
+    return Var.fromId(index);
   }
 
   protected override usageCreate(): string {
diff --git a/src/cmdlets/development/js.ts b/src/cmdlets/development/js.ts
@@ -96,13 +96,9 @@ js path - load commandlet JS script
   path      the absolute path of the commandlet script to load (note that paths with spaces must be quoted)`;
 
   public runSync(tokens: Token[]): Var {
-    const vars = this.transform(tokens, [this.parseLiteral]);
+    const vars = this.transform(tokens, [this.parseString]);
     if (vars === null) return this.usage();
-    let [name] = vars as [string];
-
-    if (name.length > 1 && name.startsWith('"') && name.endsWith('"')) {
-      name = name.slice(1, name.length - 1);
-    }
+    const [name] = vars as [string];
 
     Output.writeln(`Loading: ${name}`);
 
@@ -212,7 +208,7 @@ js path - load commandlet JS script
       CmdLets.registerCmdlet(cmdlet);
     }
 
-    return Var.ZERO;
+    return new Var(name);
   }
 
   private checkMandatoryMembers(cmdlet: CmdLet) {
diff --git a/src/cmdlets/files/cat.ts b/src/cmdlets/files/cat.ts
@@ -14,7 +14,7 @@ cat file - dump file
   file      the file to dump`;
 
   public runSync(tokens: Token[]): Var {
-    const vars = this.transform(tokens, [this.parseLiteral]);
+    const vars = this.transform(tokens, [this.parseString]);
     if (vars === null) return this.usage();
 
     const [file] = vars as [string];
@@ -28,7 +28,7 @@ cat file - dump file
       Output.writeln(`failed to read file: ${Output.green(file)}`);
     }
 
-    return Var.ZERO;
+    return new Var(file);
   }
 
   public usage(): Var {
diff --git a/src/cmdlets/files/src.ts b/src/cmdlets/files/src.ts
@@ -30,24 +30,19 @@ src path - run commands from file
   }
 
   public override async run(tokens: Token[]): Promise<Var> {
-    const vars = this.transformOptional(tokens, [], [this.parseLiteral]);
+    const vars = this.transformOptional(tokens, [], [this.parseString]);
     if (vars === null) return this.usage();
     // eslint-disable-next-line prefer-const
     let [_, [name]] = vars as [[], [string | null]];
     if (name === null) {
       if (SrcCmdLet.lastPath === null) throw new Error('path not initialized');
 
       await this.runScript(SrcCmdLet.lastPath);
-      return Var.ZERO;
+      return new Var(SrcCmdLet.lastPath);
     } else {
-      if (name.length > 1 && name.startsWith('"') && name.endsWith('"')) {
-        name = name.slice(1, name.length - 1);
-      }
-
       SrcCmdLet.lastPath = name;
       await this.runScript(name);
-
-      return Var.ZERO;
+      return new Var(name);
     }
   }
 
diff --git a/src/cmdlets/files/sz.ts b/src/cmdlets/files/sz.ts
@@ -25,7 +25,7 @@ cat file - send file
   }
 
   public override async run(tokens: Token[]): Promise<Var> {
-    const vars = this.transform(tokens, [this.parseLiteral]);
+    const vars = this.transform(tokens, [this.parseString]);
     if (vars === null) return this.usage();
 
     const [filePath] = vars as [string];
@@ -67,7 +67,7 @@ cat file - send file
       Input.setInterceptRaw(null);
       this.checkDebugFile(debugFileName);
     }
-    return Var.ZERO;
+    return new Var(filePath);
   }
 
   private checkDebugFile(debugFileName: string) {
diff --git a/src/cmdlets/misc/corpse/corpse.ts b/src/cmdlets/misc/corpse/corpse.ts
@@ -68,16 +68,16 @@ corpse - create a corpse file`;
           this.runChild(debug);
         },
       );
-      this.debug(
-        `Checking for corpse - core pattern: '${corePattern}', pid: ${childPid}`,
-      );
-      this.checkCorpse(corePattern, childPid);
+      const corePath = CorePattern.appendPid()
+        ? `${corePattern}.${childPid}`
+        : corePattern;
+      this.status(`Checking for corpse at '${corePath}'`);
+      this.checkCorpse(corePath);
+      return new Var(corePath);
     } finally {
       this.debug(`Checking debug file: '${debugFileName}'`);
       this.checkDebugFile(debugFileName);
     }
-
-    return Var.ZERO;
   }
 
   private runParent(childPid: number) {
@@ -226,12 +226,7 @@ corpse - create a corpse file`;
     cursor.writeUtf8String(data);
   }
 
-  private checkCorpse(corePattern: string, pid: number) {
-    const corePath = CorePattern.appendPid()
-      ? `${corePattern}.${pid}`
-      : corePattern;
-    this.status(`Checking for corpse at '${corePath}'`);
-
+  private checkCorpse(corePath: string) {
     const corpse = new File(corePath, 'rb');
     corpse.seek(0, File.SEEK_END);
     const length = corpse.tell();
diff --git a/src/cmdlets/misc/log.ts b/src/cmdlets/misc/log.ts
@@ -16,12 +16,17 @@ log file - set log file
   file      the file to log to`;
 
   public runSync(tokens: Token[]): Var {
-    const vars = this.transformOptional(tokens, [], [this.parseLiteral]);
+    const vars = this.transformOptional(tokens, [], [this.parseString]);
     if (vars === null) return this.usage();
     const [_, [file]] = vars as [[], [string | null]];
     if (file === null) {
-      Output.clearLog();
+      const logName = Output.clearLog();
       Output.writeln('log file cleared');
+      if (logName === null) {
+        return Var.ZERO;
+      } else {
+        return new Var(logName);
+      }
     } else {
       try {
         Output.writeln(
@@ -36,8 +41,8 @@ log file - set log file
       } catch {
         Output.writeln(`invalid log file: ${file}`);
       }
+      return new Var(file);
     }
-    return Var.ZERO;
   }
 
   public usage(): Var {
diff --git a/src/cmdlets/modules/ld.ts b/src/cmdlets/modules/ld.ts
@@ -16,7 +16,7 @@ ld path - load a module
   path      the absolute path of the module to load (note that paths with spaces must be quoted)`;
 
   public runSync(tokens: Token[]): Var {
-    const vars = this.transform(tokens, [this.parseLiteral]);
+    const vars = this.transform(tokens, [this.parseString]);
     if (vars === null) return this.usage();
     let [name] = vars as [string];
 
diff --git a/src/cmdlets/trace/trace.ts b/src/cmdlets/trace/trace.ts
diff --git a/src/commands/cmdlet.ts b/src/commands/cmdlet.ts
diff --git a/src/io/output.ts b/src/io/output.ts
diff --git a/src/io/token.ts b/src/io/token.ts
diff --git a/src/vars/var.ts b/src/vars/var.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "frida-cshell",`
`3`		`- "version": "1.8.0",`
	`3`	`+ "version": "1.8.1",`
`4`	`4`	`"description": "Frida's CShell",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"prepare": "npm run version && npm run build && npm run package && npm run copy",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`import { Var } from '../vars/var.js';`
`2`		`-import { Bp } from './bp.js';`
`3`	`2`
`4`	`3`	`enum PseudoRegNames {`
`5`	`4`	`TID = 'tid',`
`@@ -58,7 +57,7 @@ export class Regs {`
`58`	`57`	`}`
`59`	`58`
`60`	`59`	`public static setBreakpointId(breakpointId: number) {`
`61`		`- this.pseudoRegs[PseudoRegNames.BP] = Bp.idToVar(breakpointId);`
	`60`	`+ this.pseudoRegs[PseudoRegNames.BP] = Var.fromId(breakpointId);`
`62`	`61`	`}`
`63`	`62`
`64`	`63`	`public static get(name: string): Var {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Bp, BpType } from '../../breakpoints/bp.js';`
	`1`	`+import { BpType } from '../../breakpoints/bp.js';`
`2`	`2`	`import { Bps } from '../../breakpoints/bps.js';`
`3`	`3`	`import {`
`4`	`4`	`BpCodeInstruction,`
`@@ -60,7 +60,7 @@ abstract class CodeBpCmdLet extends TypedBpCmdLet {`
`60`	`60`	throw new Error(`unexpected breakpoint type: ${this.bpType}`);
`61`	`61`	`}`
`62`	`62`
`63`		`- return Bp.idToVar(idx);`
	`63`	`+ return Var.fromId(idx);`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`protected runModify(tokens: Token[]): Var \| null {`
`@@ -89,7 +89,7 @@ abstract class CodeBpCmdLet extends TypedBpCmdLet {`
`89`	`89`	Output.writeln(`Modified ${bp.toString()}`);
`90`	`90`	`this.editBreakpoint(bp, conditional);`
`91`	`91`
`92`		`- return Bp.idToVar(index);`
	`92`	`+ return Var.fromId(index);`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`protected override usageCreate(): string {`