gamja-old/lib/client.js

426 lines
10 KiB
JavaScript
Raw Normal View History

2020-06-14 08:50:59 -04:00
import * as irc from "./irc.js";
2020-06-12 13:12:17 -04:00
// Static list of capabilities that are always requested when supported by the
// server
2020-06-29 03:06:47 -04:00
const permanentCaps = [
"away-notify",
"batch",
"draft/chathistory",
"echo-message",
"message-tags",
"multi-prefix",
"server-time",
];
2020-06-12 13:12:17 -04:00
2021-01-22 12:44:06 -05:00
const RECONNECT_DELAY_SEC = 10;
2021-01-23 06:16:57 -05:00
const CHATHISTORY_PAGE_SIZE = 100;
2021-01-22 12:44:06 -05:00
2020-06-23 14:00:49 -04:00
export default class Client extends EventTarget {
2021-01-22 12:29:22 -05:00
static Status = {
DISCONNECTED: "disconnected",
CONNECTING: "connecting",
REGISTERING: "registering",
REGISTERED: "registered",
};
status = Client.Status.DISCONNECTED;
2020-06-23 14:00:49 -04:00
nick = null;
2021-01-22 12:44:06 -05:00
availableCaps = {};
enabledCaps = {};
ws = null;
2020-06-23 14:00:49 -04:00
params = {
url: null,
2020-06-23 14:00:49 -04:00
username: null,
realname: null,
nick: null,
pass: null,
saslPlain: null,
2020-04-24 13:01:02 -04:00
};
2020-06-29 03:06:47 -04:00
batches = new Map();
2021-01-22 12:44:06 -05:00
autoReconnect = true;
reconnectTimeoutID = null;
pendingHistory = Promise.resolve(null);
2020-04-24 13:01:02 -04:00
2020-06-23 14:00:49 -04:00
constructor(params) {
super();
2020-04-24 13:01:02 -04:00
2021-01-22 14:58:57 -05:00
this.params = { ...this.params, ...params };
2020-04-24 13:01:02 -04:00
2021-01-22 12:29:22 -05:00
this.reconnect();
}
reconnect() {
2021-01-22 12:44:06 -05:00
var autoReconnect = this.autoReconnect;
2021-01-22 12:29:22 -05:00
this.disconnect();
2021-01-22 12:44:06 -05:00
this.autoReconnect = autoReconnect;
2021-01-22 12:29:22 -05:00
this.setStatus(Client.Status.CONNECTING);
2020-06-23 14:00:49 -04:00
try {
2021-01-22 12:29:22 -05:00
this.ws = new WebSocket(this.params.url);
2020-06-23 14:00:49 -04:00
} catch (err) {
console.error("Failed to create connection:", err);
setTimeout(() => {
this.dispatchEvent(new CustomEvent("error", { detail: "Failed to create connection: " + err }));
2021-01-22 12:29:22 -05:00
this.setStatus(Client.Status.DISCONNECTED);
}, 0);
2020-06-23 14:00:49 -04:00
return;
}
2020-06-23 14:00:49 -04:00
this.ws.addEventListener("open", this.handleOpen.bind(this));
this.ws.addEventListener("message", this.handleMessage.bind(this));
2020-06-12 12:17:49 -04:00
2020-06-23 14:00:49 -04:00
this.ws.addEventListener("close", () => {
console.log("Connection closed");
2021-01-22 12:29:22 -05:00
this.ws = null;
this.setStatus(Client.Status.DISCONNECTED);
2021-01-22 12:44:06 -05:00
if (this.autoReconnect) {
console.info("Reconnecting to server in " + RECONNECT_DELAY_SEC + " seconds");
clearTimeout(this.reconnectTimeoutID);
this.reconnectTimeoutID = setTimeout(() => {
this.reconnect();
}, RECONNECT_DELAY_SEC * 1000);
}
});
2020-06-12 12:17:49 -04:00
2020-06-23 14:00:49 -04:00
this.ws.addEventListener("error", () => {
2020-08-10 09:01:48 -04:00
this.dispatchEvent(new CustomEvent("error", { detail: "Connection error" }));
2020-06-12 12:17:49 -04:00
});
}
2021-01-22 12:29:22 -05:00
disconnect() {
2021-01-22 12:44:06 -05:00
this.autoReconnect = false;
clearTimeout(this.reconnectTimeoutID);
this.reconnectTimeoutID = null;
2021-01-22 12:29:22 -05:00
if (this.ws) {
this.ws.close(1000);
}
}
setStatus(status) {
if (this.status === status) {
return;
}
this.status = status;
this.dispatchEvent(new CustomEvent("status"));
}
2020-06-23 14:00:49 -04:00
handleOpen() {
2020-06-05 17:35:33 -04:00
console.log("Connection opened");
2021-01-22 12:29:22 -05:00
this.setStatus(Client.Status.REGISTERING);
2020-04-24 13:01:02 -04:00
2020-06-23 14:00:49 -04:00
this.nick = this.params.nick;
this.send({ command: "CAP", params: ["LS", "302"] });
if (this.params.pass) {
this.send({ command: "PASS", params: [this.params.pass] });
2020-04-25 08:59:20 -04:00
}
2020-06-23 14:00:49 -04:00
this.send({ command: "NICK", params: [this.nick] });
this.send({
2020-06-05 17:35:33 -04:00
command: "USER",
2020-06-23 14:00:49 -04:00
params: [this.params.username, "0", "*", this.params.realname],
2020-06-07 06:46:38 -04:00
});
2020-06-23 14:00:49 -04:00
}
2020-06-05 17:35:33 -04:00
2020-06-23 14:00:49 -04:00
handleMessage(event) {
2020-06-14 08:50:59 -04:00
var msg = irc.parseMessage(event.data);
2020-06-07 06:48:48 -04:00
console.log("Received:", msg);
2020-06-05 17:35:33 -04:00
2020-06-29 03:06:47 -04:00
var msgBatch = null;
if (msg.tags["batch"]) {
msgBatch = this.batches.get(msg.tags["batch"]);
if (msgBatch) {
msgBatch.messages.push(msg);
}
}
var deleteBatch = null;
2020-06-05 17:35:33 -04:00
switch (msg.command) {
2020-06-14 08:50:59 -04:00
case irc.RPL_WELCOME:
2020-06-23 14:00:49 -04:00
if (this.params.saslPlain && this.availableCaps["sasl"] === undefined) {
2020-06-12 12:17:49 -04:00
console.error("Server doesn't support SASL PLAIN");
2021-01-22 12:29:22 -05:00
this.disconnect();
2020-06-12 12:17:49 -04:00
return;
}
2020-06-06 04:06:07 -04:00
console.log("Registration complete");
2021-01-22 12:29:22 -05:00
this.setStatus(Client.Status.REGISTERED);
break;
case "CAP":
2020-06-23 14:00:49 -04:00
this.handleCap(msg);
break;
2020-06-12 12:17:49 -04:00
case "AUTHENTICATE":
2020-06-23 14:00:49 -04:00
this.handleAuthenticate(msg);
2020-06-12 12:17:49 -04:00
break;
2020-06-14 08:50:59 -04:00
case irc.RPL_LOGGEDIN:
2020-06-12 12:17:49 -04:00
console.log("Logged in");
break;
2020-06-14 08:50:59 -04:00
case irc.RPL_LOGGEDOUT:
2020-06-12 12:17:49 -04:00
console.log("Logged out");
break;
2020-06-14 08:50:59 -04:00
case irc.RPL_SASLSUCCESS:
2020-06-12 12:17:49 -04:00
console.log("SASL authentication success");
2021-01-22 12:29:22 -05:00
if (this.status != Client.Status.REGISTERED) {
2020-06-23 14:00:49 -04:00
this.send({ command: "CAP", params: ["END"] });
2020-06-12 12:17:49 -04:00
}
break;
2020-06-14 08:50:59 -04:00
case irc.ERR_NICKLOCKED:
case irc.ERR_SASLFAIL:
case irc.ERR_SASLTOOLONG:
case irc.ERR_SASLABORTED:
case irc.ERR_SASLALREADY:
2020-08-10 09:01:48 -04:00
this.dispatchEvent(new CustomEvent("error", { detail: "SASL error (" + msg.command + "): " + msg.params[1] }));
2021-01-22 12:29:22 -05:00
this.disconnect();
2020-06-05 17:35:33 -04:00
break;
2020-07-01 06:12:56 -04:00
case "PING":
this.send({ command: "PONG", params: [msg.params[0]] });
break;
2020-06-06 04:02:22 -04:00
case "NICK":
var newNick = msg.params[0];
2020-06-23 14:00:49 -04:00
if (msg.prefix.name == this.nick) {
this.nick = newNick;
2020-06-10 13:24:03 -04:00
}
break;
2020-06-29 03:06:47 -04:00
case "BATCH":
var enter = msg.params[0].startsWith("+");
var name = msg.params[0].slice(1);
if (enter) {
var batch = {
name,
type: msg.params[1],
params: msg.params.slice(2),
parent: msgBatch,
messages: [],
};
this.batches.set(name, batch);
} else {
deleteBatch = name;
}
break;
2020-08-25 05:42:40 -04:00
case "ERROR":
this.dispatchEvent(new CustomEvent("error", { detail: "Fatal IRC error: " + msg.params[0] }));
2021-01-22 12:29:22 -05:00
this.disconnect();
2020-08-25 05:42:40 -04:00
break;
case irc.ERR_PASSWDMISMATCH:
case irc.ERR_ERRONEUSNICKNAME:
case irc.ERR_NICKNAMEINUSE:
case irc.ERR_NICKCOLLISION:
case irc.ERR_UNAVAILRESOURCE:
case irc.ERR_NOPERMFORHOST:
case irc.ERR_YOUREBANNEDCREEP:
this.dispatchEvent(new CustomEvent("error", { detail: "Error (" + msg.command + "): " + msg.params[msg.params.length - 1] }));
2021-01-22 12:29:22 -05:00
if (this.status != Client.Status.REGISTERED) {
this.disconnect();
2020-08-25 05:42:40 -04:00
}
break;
2020-06-06 04:58:32 -04:00
}
2020-06-05 17:35:33 -04:00
2020-06-23 14:00:49 -04:00
this.dispatchEvent(new CustomEvent("message", {
2020-06-29 03:06:47 -04:00
detail: { message: msg, batch: msgBatch },
2020-06-23 14:00:49 -04:00
}));
2020-06-29 03:06:47 -04:00
// Delete after firing the message event so that handlers can access
// the batch
if (deleteBatch) {
this.batches.delete(name);
}
2020-04-25 04:33:52 -04:00
}
2020-06-05 17:35:33 -04:00
2020-06-23 14:00:49 -04:00
addAvailableCaps(s) {
var l = s.split(" ");
l.forEach((s) => {
var parts = s.split("=");
2021-01-22 06:27:32 -05:00
var k = parts[0].toLowerCase();
2020-06-23 14:00:49 -04:00
var v = "";
if (parts.length > 1) {
v = parts[1];
}
this.availableCaps[k] = v;
});
2020-06-05 17:35:33 -04:00
}
2020-06-26 06:37:45 -04:00
supportsSASL(mech) {
var saslCap = this.availableCaps["sasl"];
if (saslCap === undefined) {
return false;
}
return saslCap.split(",").includes(mech);
}
requestCaps(extra) {
var reqCaps = extra || [];
permanentCaps.forEach((cap) => {
if (this.availableCaps[cap] !== undefined && !this.enabledCaps[cap]) {
reqCaps.push(cap);
}
});
if (reqCaps.length > 0) {
this.send({ command: "CAP", params: ["REQ", reqCaps.join(" ")] });
}
}
2020-06-23 14:00:49 -04:00
handleCap(msg) {
var subCmd = msg.params[1];
var args = msg.params.slice(2);
switch (subCmd) {
case "LS":
this.addAvailableCaps(args[args.length - 1]);
if (args[0] != "*") {
console.log("Available server caps:", this.availableCaps);
2020-06-05 17:35:33 -04:00
2020-06-23 14:00:49 -04:00
var reqCaps = [];
var capEnd = true;
2020-06-26 06:37:45 -04:00
if (this.params.saslPlain && this.supportsSASL("PLAIN")) {
2020-06-23 14:00:49 -04:00
// CAP END is deferred after authentication finishes
reqCaps.push("sasl");
capEnd = false;
}
2020-06-05 17:35:33 -04:00
2020-06-26 06:37:45 -04:00
this.requestCaps(reqCaps);
2020-06-12 12:17:49 -04:00
2021-01-22 12:29:22 -05:00
if (this.status != Client.Status.REGISTERED && capEnd) {
2020-06-23 14:00:49 -04:00
this.send({ command: "CAP", params: ["END"] });
}
}
break;
case "NEW":
this.addAvailableCaps(args[0]);
console.log("Server added available caps:", args[0]);
2020-06-26 06:37:45 -04:00
this.requestCaps();
2020-06-23 14:00:49 -04:00
break;
case "DEL":
args[0].split(" ").forEach((cap) => {
2021-01-22 06:27:32 -05:00
cap = cap.toLowerCase();
2020-06-23 14:00:49 -04:00
delete this.availableCaps[cap];
delete this.enabledCaps[cap];
});
console.log("Server removed available caps:", args[0]);
break;
case "ACK":
console.log("Server ack'ed caps:", args[0]);
args[0].split(" ").forEach((cap) => {
2021-01-22 06:27:32 -05:00
cap = cap.toLowerCase();
2020-06-23 14:00:49 -04:00
this.enabledCaps[cap] = true;
2020-06-07 06:46:38 -04:00
2020-06-23 14:00:49 -04:00
if (cap == "sasl" && this.params.saslPlain) {
console.log("Starting SASL PLAIN authentication");
this.send({ command: "AUTHENTICATE", params: ["PLAIN"] });
}
});
break;
case "NAK":
console.log("Server nak'ed caps:", args[0]);
2021-01-22 12:29:22 -05:00
if (this.status != Client.Status.REGISTERED) {
2020-06-23 14:00:49 -04:00
this.send({ command: "CAP", params: ["END"] });
}
break;
}
}
2020-06-23 14:00:49 -04:00
handleAuthenticate(msg) {
var challengeStr = msg.params[0];
2020-06-05 17:35:33 -04:00
2020-06-23 14:00:49 -04:00
// For now only PLAIN is supported
if (challengeStr != "+") {
this.dispatchEvent(new CustomEvent("error", { detail: "Expected an empty challenge, got: " + challengeStr }));
2020-06-23 14:00:49 -04:00
this.send({ command: "AUTHENTICATE", params: ["*"] });
return;
}
2020-06-23 14:00:49 -04:00
var respStr = btoa("\0" + this.params.saslPlain.username + "\0" + this.params.saslPlain.password);
this.send({ command: "AUTHENTICATE", params: [respStr] });
}
2020-06-07 07:46:46 -04:00
2020-06-23 14:00:49 -04:00
send(msg) {
this.ws.send(irc.formatMessage(msg));
console.log("Sent:", msg);
2020-06-07 06:31:01 -04:00
}
2020-06-07 07:46:46 -04:00
2020-07-15 12:21:09 -04:00
/* Execute a command that expects a response. `done` is called with message
* events until it returns a truthy value. */
roundtrip(msg, done) {
return new Promise((resolve, reject) => {
var handleMessage = (event) => {
try {
var result = done(event);
if (result) {
this.removeEventListener("message", handleMessage);
resolve(result);
}
} catch (err) {
this.removeEventListener("message", handleMessage);
reject(err);
}
};
this.addEventListener("message", handleMessage);
this.send(msg);
});
}
roundtripChatHistory(params) {
// Don't send multiple CHATHISTORY commands in parallel, we can't
// properly handle batches and errors.
this.pendingHistory = this.pendingHistory.catch(() => {}).then(() => {
var msg = {
command: "CHATHISTORY",
params,
};
return this.roundtrip(msg, (event) => {
var msg = event.detail.message;
switch (msg.command) {
case "BATCH":
var enter = msg.params[0].startsWith("+");
var name = msg.params[0].slice(1);
if (enter) {
break;
}
var batch = this.batches.get(name);
if (batch.type == "chathistory") {
return batch;
}
break;
case "FAIL":
if (msg.params[0] == "CHATHISTORY") {
throw msg;
}
break;
}
});
});
return this.pendingHistory;
}
2021-01-23 06:16:57 -05:00
/* Fetch one page of history before the given date. */
fetchHistoryBefore(target, before) {
var params = ["BEFORE", target, "timestamp=" + before, CHATHISTORY_PAGE_SIZE];
return this.roundtripChatHistory(params).then((batch) => {
return { more: batch.messages.length < CHATHISTORY_PAGE_SIZE };
});
}
/* Fetch history in ascending order. */
fetchHistoryBetween(target, after, before, limit) {
var max = Math.min(limit, CHATHISTORY_PAGE_SIZE);
var params = ["AFTER", target, "timestamp=" + after.time, max];
return this.roundtripChatHistory(params).then((batch) => {
limit -= batch.messages.length;
if (limit <= 0) {
throw new Error("Cannot fetch all chat history: too many messages");
}
if (batch.messages.length == max) {
// There are still more messages to fetch
after.time = batch.messages[batch.messages.length - 1].tags.time;
return this.fetchHistoryBetween(target, after, before, limit);
}
2021-01-23 06:16:57 -05:00
return null;
});
}
}