mirror of
https://github.com/webui-dev/webui
synced 2025-03-28 21:13:17 +00:00
Bridge MultiPakcet
This commit is contained in:
Hassan DRAGA
parent
a59c1fe1db
commit
8d0b43de00
File diff suppressed because it is too large
Load Diff
@ -1,4 +1,4 @@
|
||||
'use-strict'; // Force strict mode for transpiled
|
||||
'use-strict' // Force strict mode for transpiled
|
||||
|
||||
/*
|
||||
WebUI Bridge
|
||||
@ -15,50 +15,54 @@
|
||||
*/
|
||||
|
||||
//@ts-ignore use *.ts import real extension
|
||||
import { AsyncFunction, addRefreshableEventListener } from './utils.ts';
|
||||
import { AsyncFunction, addRefreshableEventListener } from './utils.ts'
|
||||
|
||||
type DataTypes = string | number | boolean | Uint8Array;
|
||||
type DataTypes = string | number | boolean | Uint8Array
|
||||
|
||||
class WebuiBridge {
|
||||
// WebUI settings
|
||||
#secure: boolean;
|
||||
#token: number;
|
||||
#port: number;
|
||||
#winNum: number;
|
||||
#bindList: unknown[] = [];
|
||||
#log: boolean;
|
||||
#winX: number;
|
||||
#winY: number;
|
||||
#winW: number;
|
||||
#winH: number;
|
||||
#secure: boolean
|
||||
#token: number
|
||||
#port: number
|
||||
#winNum: number
|
||||
#bindList: unknown[] = []
|
||||
#log: boolean
|
||||
#winX: number
|
||||
#winY: number
|
||||
#winW: number
|
||||
#winH: number
|
||||
// Internals
|
||||
#ws: WebSocket;
|
||||
#wsStatus = false;
|
||||
#wsStatusOnce = false;
|
||||
#closeReason = 0;
|
||||
#closeValue: string;
|
||||
#hasEvents = false;
|
||||
#callPromiseID = new Uint16Array(1);
|
||||
#callPromiseResolve: (((data: string) => unknown) | undefined)[] = [];
|
||||
#allowNavigation = false;
|
||||
#ws: WebSocket
|
||||
#wsStatus = false
|
||||
#wsStatusOnce = false
|
||||
#closeReason = 0
|
||||
#closeValue: string
|
||||
#hasEvents = false
|
||||
#callPromiseID = new Uint16Array(1)
|
||||
#callPromiseResolve: (((data: string) => unknown) | undefined)[] = []
|
||||
#allowNavigation = false
|
||||
#sendQueue: Uint8Array[] = []
|
||||
#isSending = false
|
||||
// WebUI const
|
||||
#WEBUI_SIGNATURE = 221;
|
||||
#CMD_JS = 254;
|
||||
#CMD_JS_QUICK = 253;
|
||||
#CMD_CLICK = 252;
|
||||
#CMD_NAVIGATION = 251;
|
||||
#CMD_CLOSE = 250;
|
||||
#CMD_CALL_FUNC = 249;
|
||||
#CMD_SEND_RAW = 248;
|
||||
#CMD_NEW_ID = 247;
|
||||
#PROTOCOL_SIZE = 8; // Protocol header size in bytes
|
||||
#PROTOCOL_SIGN = 0; // Protocol byte position: Signature (1 Byte)
|
||||
#PROTOCOL_TOKEN = 1; // Protocol byte position: Token (4 Bytes)
|
||||
#PROTOCOL_ID = 5; // Protocol byte position: ID (2 Bytes)
|
||||
#PROTOCOL_CMD = 7; // Protocol byte position: Command (1 Byte)
|
||||
#PROTOCOL_DATA = 8; // Protocol byte position: Data (n Byte)
|
||||
#Token = new Uint32Array(1);
|
||||
#Ping: Boolean = true;
|
||||
#WEBUI_SIGNATURE = 221
|
||||
#CMD_JS = 254
|
||||
#CMD_JS_QUICK = 253
|
||||
#CMD_CLICK = 252
|
||||
#CMD_NAVIGATION = 251
|
||||
#CMD_CLOSE = 250
|
||||
#CMD_CALL_FUNC = 249
|
||||
#CMD_SEND_RAW = 248
|
||||
#CMD_NEW_ID = 247
|
||||
#CMD_MULTI = 246
|
||||
#MULTI_CHUNK_SIZE = 65500
|
||||
#PROTOCOL_SIZE = 8 // Protocol header size in bytes
|
||||
#PROTOCOL_SIGN = 0 // Protocol byte position: Signature (1 Byte)
|
||||
#PROTOCOL_TOKEN = 1 // Protocol byte position: Token (4 Bytes)
|
||||
#PROTOCOL_ID = 5 // Protocol byte position: ID (2 Bytes)
|
||||
#PROTOCOL_CMD = 7 // Protocol byte position: Command (1 Byte)
|
||||
#PROTOCOL_DATA = 8 // Protocol byte position: Data (n Byte)
|
||||
#Token = new Uint32Array(1)
|
||||
#Ping: Boolean = true
|
||||
constructor({
|
||||
secure,
|
||||
token,
|
||||
@ -71,206 +75,206 @@ class WebuiBridge {
|
||||
winW,
|
||||
winH,
|
||||
}: {
|
||||
secure: boolean;
|
||||
token: number;
|
||||
port: number;
|
||||
winNum: number;
|
||||
bindList: unknown[];
|
||||
log?: boolean;
|
||||
winX: number;
|
||||
winY: number;
|
||||
winW: number;
|
||||
winH: number;
|
||||
secure: boolean
|
||||
token: number
|
||||
port: number
|
||||
winNum: number
|
||||
bindList: unknown[]
|
||||
log?: boolean
|
||||
winX: number
|
||||
winY: number
|
||||
winW: number
|
||||
winH: number
|
||||
}) {
|
||||
// Constructor arguments are injected by webui.c
|
||||
this.#secure = secure;
|
||||
this.#token = token;
|
||||
this.#port = port;
|
||||
this.#winNum = winNum;
|
||||
this.#bindList = bindList;
|
||||
this.#log = log;
|
||||
this.#winX = winX;
|
||||
this.#winY = winY;
|
||||
this.#winW = winW;
|
||||
this.#winH = winH;
|
||||
this.#secure = secure
|
||||
this.#token = token
|
||||
this.#port = port
|
||||
this.#winNum = winNum
|
||||
this.#bindList = bindList
|
||||
this.#log = log
|
||||
this.#winX = winX
|
||||
this.#winY = winY
|
||||
this.#winW = winW
|
||||
this.#winH = winH
|
||||
// Token
|
||||
this.#Token[0] = this.#token;
|
||||
this.#Token[0] = this.#token
|
||||
// Instance
|
||||
if ('webui' in globalThis) {
|
||||
throw new Error('Sorry. WebUI is already defined, only one instance is allowed.');
|
||||
throw new Error('Sorry. WebUI is already defined, only one instance is allowed.')
|
||||
}
|
||||
// Positioning the current window
|
||||
if (this.#winX !== undefined && this.#winY !== undefined) {
|
||||
window.moveTo(this.#winX, this.#winY);
|
||||
window.moveTo(this.#winX, this.#winY)
|
||||
}
|
||||
// Resize the current window
|
||||
if (this.#winW !== undefined && this.#winH !== undefined) {
|
||||
window.resizeTo(this.#winW, this.#winH);
|
||||
window.resizeTo(this.#winW, this.#winH)
|
||||
}
|
||||
// WebSocket
|
||||
if (!('WebSocket' in window)) {
|
||||
alert('Sorry. WebSocket is not supported by your web browser.');
|
||||
if (!this.#log) globalThis.close();
|
||||
alert('Sorry. WebSocket is not supported by your web browser.')
|
||||
if (!this.#log) globalThis.close()
|
||||
}
|
||||
// Connect to the backend application
|
||||
this.#start();
|
||||
this.#start()
|
||||
// Handle navigation server side
|
||||
if ('navigation' in globalThis) {
|
||||
globalThis.navigation.addEventListener('navigate', (event) => {
|
||||
if (!this.#allowNavigation) {
|
||||
event.preventDefault();
|
||||
const url = new URL(event.destination.url);
|
||||
event.preventDefault()
|
||||
const url = new URL(event.destination.url)
|
||||
if (this.#hasEvents) {
|
||||
if (this.#log) console.log(`WebUI -> DOM -> Navigation Event [${url.href}]`);
|
||||
this.#sendEventNavigation(url.href);
|
||||
if (this.#log) console.log(`WebUI -> DOM -> Navigation Event [${url.href}]`)
|
||||
this.#sendEventNavigation(url.href)
|
||||
} else {
|
||||
this.#close(this.#CMD_NAVIGATION, url.href);
|
||||
this.#close(this.#CMD_NAVIGATION, url.href)
|
||||
}
|
||||
}
|
||||
});
|
||||
})
|
||||
} else {
|
||||
// Handle all link click to prevent natural navigation
|
||||
// Rebind listener if user inject new html
|
||||
addRefreshableEventListener(document.body, 'a', 'click', (event) => {
|
||||
if (!this.#allowNavigation) {
|
||||
event.preventDefault();
|
||||
const { href } = event.target as HTMLAnchorElement;
|
||||
event.preventDefault()
|
||||
const { href } = event.target as HTMLAnchorElement
|
||||
if (this.#hasEvents) {
|
||||
if (this.#log) console.log(`WebUI -> DOM -> Navigation Click Event [${href}]`);
|
||||
this.#sendEventNavigation(href);
|
||||
if (this.#log) console.log(`WebUI -> DOM -> Navigation Click Event [${href}]`)
|
||||
this.#sendEventNavigation(href)
|
||||
} else {
|
||||
this.#close(this.#CMD_NAVIGATION, href);
|
||||
this.#close(this.#CMD_NAVIGATION, href)
|
||||
}
|
||||
}
|
||||
});
|
||||
})
|
||||
}
|
||||
// Prevent F5 refresh
|
||||
document.addEventListener('keydown', (event) => {
|
||||
if (this.#log) return; // Allowed in debug mode
|
||||
if (event.key === 'F5') event.preventDefault();
|
||||
});
|
||||
if (this.#log) return // Allowed in debug mode
|
||||
if (event.key === 'F5') event.preventDefault()
|
||||
})
|
||||
onbeforeunload = () => {
|
||||
this.#close();
|
||||
};
|
||||
this.#close()
|
||||
}
|
||||
setTimeout(() => {
|
||||
if (!this.#wsStatusOnce) {
|
||||
this.#freezeUi();
|
||||
alert('Sorry. WebUI failed to connect to the backend application. Please try again.');
|
||||
if (!this.#log) globalThis.close();
|
||||
this.#freezeUi()
|
||||
alert('Sorry. WebUI failed to connect to the backend application. Please try again.')
|
||||
if (!this.#log) globalThis.close()
|
||||
}
|
||||
}, 1500);
|
||||
}, 1500)
|
||||
}
|
||||
#close(reason = 0, value = '') {
|
||||
this.#wsStatus = false;
|
||||
this.#closeReason = reason;
|
||||
this.#closeValue = value;
|
||||
this.#ws.close();
|
||||
this.#wsStatus = false
|
||||
this.#closeReason = reason
|
||||
this.#closeValue = value
|
||||
this.#ws.close()
|
||||
if (reason === this.#CMD_NAVIGATION) {
|
||||
if (this.#log) {
|
||||
console.log(`WebUI -> Close -> Navigation to [${value}]`);
|
||||
console.log(`WebUI -> Close -> Navigation to [${value}]`)
|
||||
}
|
||||
this.#allowNavigation = true;
|
||||
globalThis.location.replace(this.#closeValue);
|
||||
this.#allowNavigation = true
|
||||
globalThis.location.replace(this.#closeValue)
|
||||
} else {
|
||||
if (this.#log) {
|
||||
console.log(`WebUI -> Close.`);
|
||||
console.log(`WebUI -> Close.`)
|
||||
}
|
||||
}
|
||||
}
|
||||
#freezeUi() {
|
||||
document.body.style.filter = 'contrast(1%)';
|
||||
document.body.style.filter = 'contrast(1%)'
|
||||
}
|
||||
#isTextBasedCommand(cmd: number): Boolean {
|
||||
if (cmd !== this.#CMD_SEND_RAW) return true;
|
||||
return false;
|
||||
if (cmd !== this.#CMD_SEND_RAW) return true
|
||||
return false
|
||||
}
|
||||
#getDataStrFromPacket(buffer: Uint8Array, startIndex: number): string {
|
||||
let stringBytes: number[] = [];
|
||||
let stringBytes: number[] = []
|
||||
for (let i = startIndex; i < buffer.length; i++) {
|
||||
if (buffer[i] === 0) {
|
||||
// Check for null byte
|
||||
break;
|
||||
break
|
||||
}
|
||||
stringBytes.push(buffer[i]);
|
||||
stringBytes.push(buffer[i])
|
||||
}
|
||||
// Convert the array of bytes to a string
|
||||
const stringText = new TextDecoder().decode(new Uint8Array(stringBytes));
|
||||
return stringText;
|
||||
const stringText = new TextDecoder().decode(new Uint8Array(stringBytes))
|
||||
return stringText
|
||||
}
|
||||
#getID(buffer: Uint8Array, index: number): number {
|
||||
if (index < 0 || index >= buffer.length - 1) {
|
||||
throw new Error('Index out of bounds or insufficient data.');
|
||||
throw new Error('Index out of bounds or insufficient data.')
|
||||
}
|
||||
const firstByte = buffer[index];
|
||||
const secondByte = buffer[index + 1];
|
||||
const combined = (secondByte << 8) | firstByte; // Works only for little-endian
|
||||
return combined;
|
||||
const firstByte = buffer[index]
|
||||
const secondByte = buffer[index + 1]
|
||||
const combined = (secondByte << 8) | firstByte // Works only for little-endian
|
||||
return combined
|
||||
}
|
||||
#addToken(buffer: Uint8Array, value: number, index: number): void {
|
||||
if (value < 0 || value > 0xffffffff) {
|
||||
throw new Error('Number is out of the range for 4 bytes representation.');
|
||||
throw new Error('Number is out of the range for 4 bytes representation.')
|
||||
}
|
||||
if (index < 0 || index > buffer.length - 4) {
|
||||
throw new Error('Index out of bounds or insufficient space in buffer.');
|
||||
throw new Error('Index out of bounds or insufficient space in buffer.')
|
||||
}
|
||||
// WebUI expect Little-endian (Work for Little/Big endian platforms)
|
||||
buffer[index] = value & 0xff; // Least significant byte
|
||||
buffer[index + 1] = (value >>> 8) & 0xff;
|
||||
buffer[index + 2] = (value >>> 16) & 0xff;
|
||||
buffer[index + 3] = (value >>> 24) & 0xff; // Most significant byte
|
||||
buffer[index] = value & 0xff // Least significant byte
|
||||
buffer[index + 1] = (value >>> 8) & 0xff
|
||||
buffer[index + 2] = (value >>> 16) & 0xff
|
||||
buffer[index + 3] = (value >>> 24) & 0xff // Most significant byte
|
||||
}
|
||||
#addID(buffer: Uint8Array, value: number, index: number): void {
|
||||
if (value < 0 || value > 0xffff) {
|
||||
throw new Error('Number is out of the range for 2 bytes representation.');
|
||||
throw new Error('Number is out of the range for 2 bytes representation.')
|
||||
}
|
||||
if (index < 0 || index > buffer.length - 2) {
|
||||
throw new Error('Index out of bounds or insufficient space in buffer.');
|
||||
throw new Error('Index out of bounds or insufficient space in buffer.')
|
||||
}
|
||||
// WebUI expect Little-endian (Work for Little/Big endian platforms)
|
||||
buffer[index] = value & 0xff; // Least significant byte
|
||||
buffer[index + 1] = (value >>> 8) & 0xff; // Most significant byte
|
||||
buffer[index] = value & 0xff // Least significant byte
|
||||
buffer[index + 1] = (value >>> 8) & 0xff // Most significant byte
|
||||
}
|
||||
#start() {
|
||||
this.#keepAlive();
|
||||
this.#callPromiseID[0] = 0;
|
||||
this.#keepAlive()
|
||||
this.#callPromiseID[0] = 0
|
||||
if (this.#bindList.includes(this.#winNum + '/')) {
|
||||
this.#hasEvents = true;
|
||||
this.#hasEvents = true
|
||||
}
|
||||
const url = (this.#secure ? "wss://localhost" : "ws://localhost")
|
||||
this.#ws = new WebSocket(`${url}:${this.#port}/_webui_ws_connect`);
|
||||
this.#ws.binaryType = 'arraybuffer';
|
||||
this.#ws = new WebSocket(`${url}:${this.#port}/_webui_ws_connect`)
|
||||
this.#ws.binaryType = 'arraybuffer'
|
||||
this.#ws.onopen = () => {
|
||||
this.#wsStatus = true;
|
||||
this.#wsStatusOnce = true;
|
||||
if (this.#log) console.log('WebUI -> Connected');
|
||||
this.#clicksListener();
|
||||
};
|
||||
this.#wsStatus = true
|
||||
this.#wsStatusOnce = true
|
||||
if (this.#log) console.log('WebUI -> Connected')
|
||||
this.#clicksListener()
|
||||
}
|
||||
this.#ws.onerror = () => {
|
||||
if (this.#log) console.log('WebUI -> Connection Failed');
|
||||
this.#freezeUi();
|
||||
};
|
||||
if (this.#log) console.log('WebUI -> Connection Failed')
|
||||
this.#freezeUi()
|
||||
}
|
||||
this.#ws.onclose = (event) => {
|
||||
this.#wsStatus = false;
|
||||
this.#wsStatus = false
|
||||
if (this.#closeReason === this.#CMD_NAVIGATION) {
|
||||
if (this.#log) {
|
||||
console.log(`WebUI -> Connection closed du to Navigation to [${this.#closeValue}]`);
|
||||
console.log(`WebUI -> Connection closed du to Navigation to [${this.#closeValue}]`)
|
||||
}
|
||||
} else {
|
||||
if (this.#log) {
|
||||
console.log(`WebUI -> Connection lost (${event.code})`);
|
||||
this.#freezeUi();
|
||||
console.log(`WebUI -> Connection lost (${event.code})`)
|
||||
this.#freezeUi()
|
||||
} else {
|
||||
this.#closeWindowTimer();
|
||||
this.#closeWindowTimer()
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
this.#ws.onmessage = async (event) => {
|
||||
const buffer8 = new Uint8Array(event.data);
|
||||
if (buffer8.length < this.#PROTOCOL_SIZE) return;
|
||||
if (buffer8[this.#PROTOCOL_SIGN] !== this.#WEBUI_SIGNATURE) return;
|
||||
const buffer8 = new Uint8Array(event.data)
|
||||
if (buffer8.length < this.#PROTOCOL_SIZE) return
|
||||
if (buffer8[this.#PROTOCOL_SIGN] !== this.#WEBUI_SIGNATURE) return
|
||||
if (this.#isTextBasedCommand(buffer8[this.#PROTOCOL_CMD])) {
|
||||
// UTF8 Text based commands
|
||||
const callId = this.#getID(buffer8, this.#PROTOCOL_ID);
|
||||
const callId = this.#getID(buffer8, this.#PROTOCOL_ID)
|
||||
// Process Command
|
||||
switch (buffer8[this.#PROTOCOL_CMD]) {
|
||||
case this.#CMD_JS_QUICK:
|
||||
@ -282,27 +286,27 @@ class WebuiBridge {
|
||||
// 2: [ID]
|
||||
// 3: [CMD]
|
||||
// 4: [Script]
|
||||
const script = this.#getDataStrFromPacket(buffer8, this.#PROTOCOL_DATA);
|
||||
const scriptSanitize = script.replace(/(?:\r\n|\r|\n)/g, '\n');
|
||||
if (this.#log) console.log(`WebUI -> CMD -> JS [${scriptSanitize}]`);
|
||||
const script = this.#getDataStrFromPacket(buffer8, this.#PROTOCOL_DATA)
|
||||
const scriptSanitize = script.replace(/(?:\r\n|\r|\n)/g, '\n')
|
||||
if (this.#log) console.log(`WebUI -> CMD -> JS [${scriptSanitize}]`)
|
||||
// Get callback result
|
||||
let FunReturn = 'undefined';
|
||||
let FunError = false;
|
||||
let FunReturn = 'undefined'
|
||||
let FunError = false
|
||||
try {
|
||||
FunReturn = await AsyncFunction(scriptSanitize)();
|
||||
FunReturn = await AsyncFunction(scriptSanitize)()
|
||||
} catch (e) {
|
||||
FunError = true;
|
||||
FunReturn = e.message;
|
||||
FunError = true
|
||||
FunReturn = e.message
|
||||
}
|
||||
// Stop if this is a quick call
|
||||
if (buffer8[this.#PROTOCOL_CMD] === this.#CMD_JS_QUICK) return;
|
||||
if (buffer8[this.#PROTOCOL_CMD] === this.#CMD_JS_QUICK) return
|
||||
// Get the call return
|
||||
if (FunReturn === undefined) {
|
||||
FunReturn = 'undefined';
|
||||
FunReturn = 'undefined'
|
||||
}
|
||||
// Logging
|
||||
if (this.#log && !FunError) console.log(`WebUI -> CMD -> JS -> Return Success [${FunReturn}]`);
|
||||
if (this.#log && FunError) console.log(`WebUI -> CMD -> JS -> Return Error [${FunReturn}]`);
|
||||
if (this.#log && !FunError) console.log(`WebUI -> CMD -> JS -> Return Success [${FunReturn}]`)
|
||||
if (this.#log && FunError) console.log(`WebUI -> CMD -> JS -> Return Error [${FunReturn}]`)
|
||||
// Protocol
|
||||
// 0: [SIGNATURE]
|
||||
// 1: [TOKEN]
|
||||
@ -311,22 +315,17 @@ class WebuiBridge {
|
||||
// 4: [Error, Script Response]
|
||||
const Return8 = Uint8Array.of(
|
||||
this.#WEBUI_SIGNATURE,
|
||||
0,
|
||||
0,
|
||||
0,
|
||||
0, // Token (4 Bytes)
|
||||
0,
|
||||
0, // ID (2 Bytes)
|
||||
0, 0, 0, 0, // Token (4 Bytes)
|
||||
0, 0, // ID (2 Bytes)
|
||||
this.#CMD_JS,
|
||||
FunError ? 1 : 0,
|
||||
...new TextEncoder().encode(FunReturn),
|
||||
);
|
||||
this.#addToken(Return8, this.#token, this.#PROTOCOL_TOKEN);
|
||||
this.#addID(Return8, callId, this.#PROTOCOL_ID);
|
||||
this.#Ping = false;
|
||||
if (this.#wsStatus) this.#ws.send(Return8.buffer);
|
||||
)
|
||||
this.#addToken(Return8, this.#token, this.#PROTOCOL_TOKEN)
|
||||
this.#addID(Return8, callId, this.#PROTOCOL_ID)
|
||||
this.#sendData(Return8)
|
||||
}
|
||||
break;
|
||||
break
|
||||
case this.#CMD_CALL_FUNC:
|
||||
{
|
||||
// Protocol
|
||||
@ -335,19 +334,19 @@ class WebuiBridge {
|
||||
// 2: [ID]
|
||||
// 3: [CMD]
|
||||
// 4: [Call Response]
|
||||
const callResponse = this.#getDataStrFromPacket(buffer8, this.#PROTOCOL_DATA);
|
||||
const callResponse = this.#getDataStrFromPacket(buffer8, this.#PROTOCOL_DATA)
|
||||
if (this.#log) {
|
||||
console.log(`WebUI -> CMD -> Call Response [${callResponse}]`);
|
||||
console.log(`WebUI -> CMD -> Call Response [${callResponse}]`)
|
||||
}
|
||||
if (this.#callPromiseResolve[callId]) {
|
||||
if (this.#log) {
|
||||
console.log(`WebUI -> CMD -> Resolving Response #${callId}...`);
|
||||
console.log(`WebUI -> CMD -> Resolving Response #${callId}...`)
|
||||
}
|
||||
this.#callPromiseResolve[callId]?.(callResponse);
|
||||
this.#callPromiseResolve[callId] = undefined;
|
||||
this.#callPromiseResolve[callId]?.(callResponse)
|
||||
this.#callPromiseResolve[callId] = undefined
|
||||
}
|
||||
}
|
||||
break;
|
||||
break
|
||||
|
||||
case this.#CMD_NAVIGATION:
|
||||
// Protocol
|
||||
@ -356,10 +355,10 @@ class WebuiBridge {
|
||||
// 2: [ID]
|
||||
// 3: [CMD]
|
||||
// 4: [URL]
|
||||
const url = this.#getDataStrFromPacket(buffer8, this.#PROTOCOL_DATA);
|
||||
console.log(`WebUI -> CMD -> Navigation [${url}]`);
|
||||
this.#close(this.#CMD_NAVIGATION, url);
|
||||
break;
|
||||
const url = this.#getDataStrFromPacket(buffer8, this.#PROTOCOL_DATA)
|
||||
console.log(`WebUI -> CMD -> Navigation [${url}]`)
|
||||
this.#close(this.#CMD_NAVIGATION, url)
|
||||
break
|
||||
case this.#CMD_NEW_ID:
|
||||
// Protocol
|
||||
// 0: [SIGNATURE]
|
||||
@ -367,22 +366,22 @@ class WebuiBridge {
|
||||
// 2: [ID]
|
||||
// 3: [CMD]
|
||||
// 4: [New Element]
|
||||
const newElement = this.#getDataStrFromPacket(buffer8, this.#PROTOCOL_DATA);
|
||||
console.log(`WebUI -> CMD -> New Bind ID [${newElement}]`);
|
||||
if (!this.#bindList.includes(newElement)) this.#bindList.push(newElement);
|
||||
break;
|
||||
const newElement = this.#getDataStrFromPacket(buffer8, this.#PROTOCOL_DATA)
|
||||
console.log(`WebUI -> CMD -> New Bind ID [${newElement}]`)
|
||||
if (!this.#bindList.includes(newElement)) this.#bindList.push(newElement)
|
||||
break
|
||||
case this.#CMD_CLOSE:
|
||||
// Protocol
|
||||
// 0: [SIGNATURE]
|
||||
// 1: [TOKEN]
|
||||
// 2: [ID]
|
||||
// 3: [CMD]
|
||||
if (!this.#log) globalThis.close();
|
||||
if (!this.#log) globalThis.close()
|
||||
else {
|
||||
console.log(`WebUI -> CMD -> Close`);
|
||||
this.#ws.close();
|
||||
console.log(`WebUI -> CMD -> Close`)
|
||||
this.#ws.close()
|
||||
}
|
||||
break;
|
||||
break
|
||||
}
|
||||
} else {
|
||||
// Raw-binary based commands
|
||||
@ -395,47 +394,87 @@ class WebuiBridge {
|
||||
// 3: [CMD]
|
||||
// 4: [Function,Null,Raw Data]
|
||||
// Get function name
|
||||
const functionName: string = this.#getDataStrFromPacket(buffer8, this.#PROTOCOL_DATA);
|
||||
const functionName: string = this.#getDataStrFromPacket(buffer8, this.#PROTOCOL_DATA)
|
||||
// Get the raw data
|
||||
const rawDataIndex: number = 2 + functionName.length + 1;
|
||||
const userRawData = buffer8.subarray(rawDataIndex);
|
||||
if (this.#log) console.log(`WebUI -> CMD -> Send Raw ${buffer8.length} bytes to [${functionName}()]`);
|
||||
const rawDataIndex: number = 2 + functionName.length + 1
|
||||
const userRawData = buffer8.subarray(rawDataIndex)
|
||||
if (this.#log) console.log(`WebUI -> CMD -> Send Raw ${buffer8.length} bytes to [${functionName}()]`)
|
||||
// Call the user function, and pass the raw data
|
||||
if (typeof window[functionName] === 'function') window[functionName](userRawData);
|
||||
else await AsyncFunction(functionName + '(userRawData)')();
|
||||
break;
|
||||
if (typeof window[functionName] === 'function') window[functionName](userRawData)
|
||||
else await AsyncFunction(functionName + '(userRawData)')()
|
||||
break
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
#keepAlive = async () => {
|
||||
while (true) {
|
||||
if (this.#Ping) {
|
||||
// Some web browsers may close the connection
|
||||
// let's send a void message to keep WS open
|
||||
if (this.#wsStatus) this.#ws.send('ping');
|
||||
this.#sendData(new TextEncoder().encode('ping'))
|
||||
} else {
|
||||
// There is an active communication
|
||||
this.#Ping = true;
|
||||
this.#Ping = true
|
||||
}
|
||||
await new Promise((resolve) => setTimeout(resolve, 20000));
|
||||
await new Promise((resolve) => setTimeout(resolve, 20000))
|
||||
}
|
||||
};
|
||||
}
|
||||
#clicksListener() {
|
||||
Object.keys(window).forEach((key) => {
|
||||
if (/^on(click)/.test(key)) {
|
||||
globalThis.addEventListener(key.slice(2), (event) => {
|
||||
if (!(event.target instanceof HTMLElement)) return;
|
||||
if (!(event.target instanceof HTMLElement)) return
|
||||
if (
|
||||
this.#hasEvents ||
|
||||
(event.target.id !== '' && this.#bindList.includes(this.#winNum + '/' + event.target?.id))
|
||||
) {
|
||||
this.#sendClick(event.target.id);
|
||||
this.#sendClick(event.target.id)
|
||||
}
|
||||
});
|
||||
})
|
||||
}
|
||||
});
|
||||
})
|
||||
}
|
||||
async #sendData(packet: Uint8Array) {
|
||||
this.#Ping = false
|
||||
if (!this.#wsStatus || packet === undefined)
|
||||
return
|
||||
// Enqueue the packet
|
||||
this.#sendQueue.push(packet)
|
||||
if (this.#isSending)
|
||||
return
|
||||
this.#isSending = true
|
||||
while (this.#sendQueue.length > 0) {
|
||||
const currentPacket = this.#sendQueue.shift()!
|
||||
if (currentPacket.length < this.#MULTI_CHUNK_SIZE) {
|
||||
this.#ws.send(currentPacket.buffer)
|
||||
} else {
|
||||
// Pre-packet to let WebUI be ready for multi packet
|
||||
const pre_packet = Uint8Array.of(
|
||||
this.#WEBUI_SIGNATURE,
|
||||
0, 0, 0, 0, // Token (4 Bytes)
|
||||
0, 0, // ID (2 Bytes)
|
||||
this.#CMD_MULTI,
|
||||
...new TextEncoder().encode(currentPacket.length.toString()),
|
||||
0,
|
||||
)
|
||||
this.#ws.send(pre_packet.buffer)
|
||||
// Send chunks
|
||||
let offset = 0
|
||||
const sendChunk = async () => {
|
||||
if (offset < currentPacket.length) {
|
||||
const chunkSize = Math.min(this.#MULTI_CHUNK_SIZE, currentPacket.length - offset)
|
||||
const chunk = currentPacket.subarray(offset, offset + chunkSize)
|
||||
this.#ws.send(chunk)
|
||||
offset += chunkSize
|
||||
await sendChunk()
|
||||
}
|
||||
}
|
||||
await sendChunk()
|
||||
}
|
||||
}
|
||||
this.#isSending = false
|
||||
}
|
||||
#sendClick(elem: string) {
|
||||
if (this.#wsStatus) {
|
||||
// Protocol
|
||||
@ -468,18 +507,17 @@ class WebuiBridge {
|
||||
0, // ID (2 Bytes)
|
||||
this.#CMD_CLICK,
|
||||
0,
|
||||
);
|
||||
this.#addToken(packet, this.#token, this.#PROTOCOL_TOKEN);
|
||||
)
|
||||
this.#addToken(packet, this.#token, this.#PROTOCOL_TOKEN)
|
||||
// this.#addID(packet, 0, this.#PROTOCOL_ID)
|
||||
this.#Ping = false;
|
||||
this.#ws.send(packet.buffer);
|
||||
if (this.#log) console.log(`WebUI -> Send Click [${elem}]`);
|
||||
this.#sendData(packet)
|
||||
if (this.#log) console.log(`WebUI -> Send Click [${elem}]`)
|
||||
}
|
||||
}
|
||||
#sendEventNavigation(url: string) {
|
||||
if (url !== '') {
|
||||
if (this.#hasEvents) {
|
||||
if (this.#log) console.log(`WebUI -> Send Navigation Event [${url}]`);
|
||||
if (this.#log) console.log(`WebUI -> Send Navigation Event [${url}]`)
|
||||
if (this.#wsStatus && this.#hasEvents) {
|
||||
const packet = Uint8Array.of(
|
||||
// Protocol
|
||||
@ -489,94 +527,84 @@ class WebuiBridge {
|
||||
// 3: [CMD]
|
||||
// 4: [URL]
|
||||
this.#WEBUI_SIGNATURE,
|
||||
0,
|
||||
0,
|
||||
0,
|
||||
0, // Token (4 Bytes)
|
||||
0,
|
||||
0, // ID (2 Bytes)
|
||||
0, 0, 0, 0, // Token (4 Bytes)
|
||||
0, 0, // ID (2 Bytes)
|
||||
this.#CMD_NAVIGATION,
|
||||
...new TextEncoder().encode(url),
|
||||
);
|
||||
this.#addToken(packet, this.#token, this.#PROTOCOL_TOKEN);
|
||||
)
|
||||
this.#addToken(packet, this.#token, this.#PROTOCOL_TOKEN)
|
||||
// this.#addID(packet, 0, this.#PROTOCOL_ID)
|
||||
this.#Ping = false;
|
||||
this.#ws.send(packet.buffer);
|
||||
this.#sendData(packet)
|
||||
}
|
||||
} else {
|
||||
if (this.#log) console.log(`WebUI -> Navigation To [${url}]`);
|
||||
this.#allowNavigation = true;
|
||||
globalThis.location.replace(url);
|
||||
if (this.#log) console.log(`WebUI -> Navigation To [${url}]`)
|
||||
this.#allowNavigation = true
|
||||
globalThis.location.replace(url)
|
||||
}
|
||||
}
|
||||
}
|
||||
#closeWindowTimer() {
|
||||
setTimeout(function () {
|
||||
globalThis.close();
|
||||
}, 1000);
|
||||
globalThis.close()
|
||||
}, 1000)
|
||||
}
|
||||
#toUint16(value: number): number {
|
||||
return value & 0xffff;
|
||||
return value & 0xffff
|
||||
}
|
||||
#callPromise(fn: string, ...args: DataTypes[]) {
|
||||
--this.#callPromiseID[0];
|
||||
const callId = this.#toUint16(this.#callPromiseID[0]);
|
||||
--this.#callPromiseID[0]
|
||||
const callId = this.#toUint16(this.#callPromiseID[0])
|
||||
// Combine lengths
|
||||
let argsLengths = args
|
||||
.map((arg) => {
|
||||
if (typeof arg === 'object') {
|
||||
// Uint8Array
|
||||
return arg.length;
|
||||
return arg.length
|
||||
} else {
|
||||
// string, number, boolean
|
||||
return new TextEncoder().encode(arg.toString()).length;
|
||||
return new TextEncoder().encode(arg.toString()).length
|
||||
}
|
||||
})
|
||||
.join(';');
|
||||
// Combine values
|
||||
let argsValues: Uint8Array = new Uint8Array();
|
||||
let argsValues: Uint8Array = new Uint8Array()
|
||||
for (const arg of args) {
|
||||
let buffer: Uint8Array;
|
||||
let buffer: Uint8Array
|
||||
if (typeof arg === 'object') {
|
||||
buffer = arg; // Uint8Array
|
||||
buffer = arg // Uint8Array
|
||||
} else {
|
||||
// string, number, boolean
|
||||
buffer = new TextEncoder().encode(arg.toString());
|
||||
buffer = new TextEncoder().encode(arg.toString())
|
||||
}
|
||||
const temp = new Uint8Array(argsValues.length + buffer.length + 1);
|
||||
temp.set(argsValues, 0);
|
||||
temp.set(buffer, argsValues.length);
|
||||
temp[argsValues.length + buffer.length] = 0x00;
|
||||
argsValues = temp;
|
||||
const temp = new Uint8Array(argsValues.length + buffer.length + 1)
|
||||
temp.set(argsValues, 0)
|
||||
temp.set(buffer, argsValues.length)
|
||||
temp[argsValues.length + buffer.length] = 0x00
|
||||
argsValues = temp
|
||||
}
|
||||
// Protocol
|
||||
// 0: [SIGNATURE]
|
||||
// 1: [TOKEN]
|
||||
// 2: [ID]
|
||||
// 3: [CMD]
|
||||
// 4: [Fn, Null, {Len;Len;...}, Null, {Data,Null,Data,Null...}]
|
||||
// 4: [Fn, Null, {LenLen...}, Null, {Data,Null,Data,Null...}]
|
||||
const packet = Uint8Array.of(
|
||||
this.#WEBUI_SIGNATURE,
|
||||
0,
|
||||
0,
|
||||
0,
|
||||
0, // Token (4 Bytes)
|
||||
0,
|
||||
0, // ID (2 Bytes)
|
||||
0, 0, 0, 0, // Token (4 Bytes)
|
||||
0, 0, // ID (2 Bytes)
|
||||
this.#CMD_CALL_FUNC,
|
||||
...new TextEncoder().encode(fn),
|
||||
0,
|
||||
...new TextEncoder().encode(argsLengths),
|
||||
0,
|
||||
...argsValues,
|
||||
);
|
||||
this.#addToken(packet, this.#token, this.#PROTOCOL_TOKEN);
|
||||
this.#addID(packet, callId, this.#PROTOCOL_ID);
|
||||
)
|
||||
this.#addToken(packet, this.#token, this.#PROTOCOL_TOKEN)
|
||||
this.#addID(packet, callId, this.#PROTOCOL_ID)
|
||||
return new Promise((resolve) => {
|
||||
this.#callPromiseResolve[callId] = resolve;
|
||||
this.#Ping = false;
|
||||
this.#ws.send(packet.buffer);
|
||||
});
|
||||
this.#callPromiseResolve[callId] = resolve
|
||||
this.#sendData(packet)
|
||||
})
|
||||
}
|
||||
// -- APIs --------------------------
|
||||
/**
|
||||
@ -588,22 +616,22 @@ class WebuiBridge {
|
||||
* @example - const res = await webui.call("myID", 123, true, "Hi", new Uint8Array([0x42, 0x43, 0x44]))
|
||||
*/
|
||||
async call(fn: string, ...args: DataTypes[]): Promise<DataTypes> {
|
||||
if (!fn) return Promise.reject(new SyntaxError('No binding name is provided'));
|
||||
if (!fn) return Promise.reject(new SyntaxError('No binding name is provided'))
|
||||
|
||||
if (!this.#wsStatus) return Promise.reject(new Error('WebSocket is not connected'));
|
||||
if (!this.#wsStatus) return Promise.reject(new Error('WebSocket is not connected'))
|
||||
|
||||
// Check binding list
|
||||
if (!this.#hasEvents && !this.#bindList.includes(`${this.#winNum}/${fn}`))
|
||||
return Promise.reject(new ReferenceError(`No binding was found for "${fn}"`));
|
||||
return Promise.reject(new ReferenceError(`No binding was found for "${fn}"`))
|
||||
|
||||
// Call backend and wait for response
|
||||
if (this.#log) console.log(`WebUI -> Calling [${fn}(...)]`);
|
||||
const response = (await this.#callPromise(fn, ...args)) as string;
|
||||
if (this.#log) console.log(`WebUI -> Calling [${fn}(...)]`)
|
||||
const response = (await this.#callPromise(fn, ...args)) as string
|
||||
|
||||
// WebUI lib accept `DataTypes` but return only string
|
||||
if (typeof response !== 'string') return '';
|
||||
if (typeof response !== 'string') return ''
|
||||
|
||||
return response;
|
||||
return response
|
||||
}
|
||||
/**
|
||||
* Active or deactivate webui debug logging
|
||||
@ -612,11 +640,11 @@ class WebuiBridge {
|
||||
*/
|
||||
setLogging(status: boolean) {
|
||||
if (status) {
|
||||
console.log('WebUI -> Log Enabled.');
|
||||
this.#log = true;
|
||||
console.log('WebUI -> Log Enabled.')
|
||||
this.#log = true
|
||||
} else {
|
||||
console.log('WebUI -> Log Disabled.');
|
||||
this.#log = false;
|
||||
console.log('WebUI -> Log Disabled.')
|
||||
this.#log = false
|
||||
}
|
||||
}
|
||||
/**
|
||||
@ -625,7 +653,7 @@ class WebuiBridge {
|
||||
* @param data - text string
|
||||
*/
|
||||
encode(data: string): string {
|
||||
return btoa(data);
|
||||
return btoa(data)
|
||||
}
|
||||
/**
|
||||
* Decode base64 string into text
|
||||
@ -633,15 +661,15 @@ class WebuiBridge {
|
||||
* @param data - base64 string
|
||||
*/
|
||||
decode(data: string): string {
|
||||
return atob(data);
|
||||
return atob(data)
|
||||
}
|
||||
}
|
||||
// Export
|
||||
type webui = WebuiBridge;
|
||||
export default webui;
|
||||
export type { WebuiBridge };
|
||||
type webui = WebuiBridge
|
||||
export default webui
|
||||
export type { WebuiBridge }
|
||||
// Wait for the html to be parsed
|
||||
addEventListener('load', () => {
|
||||
document.body.addEventListener('contextmenu', (event) => event.preventDefault());
|
||||
addRefreshableEventListener(document.body, 'input', 'contextmenu', (event) => event.stopPropagation());
|
||||
});
|
||||
document.body.addEventListener('contextmenu', (event) => event.preventDefault())
|
||||
addRefreshableEventListener(document.body, 'input', 'contextmenu', (event) => event.stopPropagation())
|
||||
})
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user