// @effect-diagnostics nodeBuiltinImport:off -- Reads portal-owned screenshot files at the native boundary.
import * as NodeFSP from "node:fs/promises";
import * as NodeURL from "node:url";
import type { SnapShotKeyChord } from "@t3tools/contracts";
import * as Schema from "effect/Schema";
import { nativeImage } from "electron";
// Keep dbus-next out of desktop detection and PNG reads in the main process.
export const HYPRLAND_CAPTURE_ACTION = "capture-window";
export class CaptureSetupRequiredError extends Schema.TaggedError<CaptureSetupRequiredError>()(
"CaptureSetupRequiredError",
{ state: Schema.String, cause: Schema.optional(Schema.Defect()) },
) {
override get message(): string {
return `${this.state} Open Settings → SnapShots to continue setup.`;
}
}
export const NIRI_CAPTURE_PATH = "/com/t3tools/SnapShot";
export const NIRI_CAPTURE_INTERFACE = "com.t3tools.SnapShot";
function isDesktopSession(env: NodeJS.ProcessEnv, desktop: string): boolean {
return (
!env.FLATPAK_ID &&
!env.SNAP &&
Boolean(env.XDG_CURRENT_DESKTOP?.split(":").some((name) => name.toLowerCase() === desktop))
);
}
export function isGnomeCaptureSession(env: NodeJS.ProcessEnv): boolean {
return isDesktopSession(env, "gnome");
}
export function isKdeCaptureSession(env = process.env): boolean {
return isDesktopSession(env, "kde");
}
export function isHyprlandCaptureSession(env = process.env): boolean {
return isDesktopSession(env, "hyprland");
}
export function niriCaptureBinding(appId: string): string {
return `Ctrl+Shift+2 repeat=false { spawn "gdbus" "call" "--session" "--dest" "${appId}.SnapShot" "--object-path" "${NIRI_CAPTURE_PATH}" "--method" "${NIRI_CAPTURE_INTERFACE}.Capture"; }`;
}
const KEY_NAMES: Readonly<Record<string, string>> = {
" ": "space",
escape: "Escape",
esc: "Escape",
enter: "Return",
tab: "Tab",
backspace: "BackSpace",
delete: "Delete",
insert: "Insert",
home: "Home",
end: "End",
pageup: "Page_Up",
pagedown: "Page_Down",
arrowup: "Up",
arrowdown: "Down",
arrowleft: "Left",
arrowright: "Right",
up: "Up",
down: "Down",
left: "Left",
right: "Right",
"+": "plus",
"-": "minus",
"=": "equal",
",": "comma",
".": "period",
"/": "slash",
";": "semicolon",
"'": "apostrophe",
"[": "bracketleft",
"]": "bracketright",
"\\": "backslash",
"`": "grave",
"!": "exclam",
"@": "at",
"#": "numbersign",
$: "dollar",
"%": "percent",
"^": "asciicircum",
"&": "ampersand",
"*": "asterisk",
"(": "parenleft",
")": "parenright",
_: "underscore",
":": "colon",
'"': "quotedbl",
"{": "braceleft",
"}": "braceright",
"|": "bar",
"<": "less",
">": "greater",
"?": "question",
"~": "asciitilde",
};
export function portalShortcutTrigger(shortcut: SnapShotKeyChord): string {
const key = shortcut.key.toLowerCase();
const keysym =
KEY_NAMES[key] ??
(/^[a-z0-9]$/.test(key) || /^f([1-9]|1\d|2[0-4])$/.test(key) ? key.toUpperCase() : undefined);
if (!keysym)
throw new Error("This key isn't supported as a Wayland capture shortcut. Choose another key.");
return [
shortcut.ctrlKey || shortcut.modKey ? "CTRL" : null,
shortcut.altKey ? "ALT" : null,
shortcut.shiftKey ? "SHIFT" : null,
shortcut.metaKey ? "LOGO" : null,
keysym,
]
.filter(Boolean)
.join("+");
}
const PNG_HEADER = Buffer.from([137, 80, 78, 71, 13, 10, 26, 10]);
const MAX_PNG_BYTES = 32 * 1024 * 1024;
export function resizeLinuxCapture(png: Buffer): Buffer {
if (png.length > MAX_PNG_BYTES || !png.subarray(0, 8).equals(PNG_HEADER)) {
throw new Error("Invalid or oversized window screenshot.");
}
const image = nativeImage.createFromBuffer(png);
if (image.isEmpty()) throw new Error("The window screenshot is empty.");
const { width, height } = image.getSize();
const scale = Math.min(2_560 / width, 1_600 / height, 1);
return scale < 1
? image
.resize({
width: Math.max(1, Math.round(width * scale)),
height: Math.max(1, Math.round(height * scale)),
quality: "best",
})
.toPNG()
: png;
}
export async function readPortalPng(uri: string): Promise<Buffer> {
// fileURLToPath rejects network schemes/hosts. Never delete a portal-owned file.
const file = await NodeFSP.open(NodeURL.fileURLToPath(uri), "r");
try {
const stat = await file.stat();
if (!stat.isFile() || stat.size > MAX_PNG_BYTES) throw new Error("Invalid screenshot file.");
const buffer = Buffer.alloc(stat.size);
let offset = 0;
while (offset < buffer.length) {
const { bytesRead } = await file.read(buffer, offset, buffer.length - offset, offset);
if (!bytesRead) throw new Error("Incomplete screenshot file.");
offset += bytesRead;
}
return resizeLinuxCapture(buffer);
} finally {
await file.close();
}
}