thelounge/server/server.ts

1056 lines
27 KiB
TypeScript
Raw Normal View History

import _ from "lodash";
import {Server as wsServer} from "ws";
import express, {NextFunction, Request, Response} from "express";
import fs from "fs";
import path from "path";
import {Server, Socket} from "socket.io";
import dns from "dns";
import colors from "chalk";
import net from "net";
import log from "./log";
import Client from "./client";
import ClientManager from "./clientManager";
import Uploader from "./plugins/uploader";
import Helper from "./helper";
import Config, {ConfigType, Defaults} from "./config";
import Identification from "./identification";
import changelog from "./plugins/changelog";
import inputs from "./plugins/inputs";
import Auth from "./plugins/auth";
import themes, {ThemeForClient} from "./plugins/packages/themes";
2018-01-05 17:40:34 +00:00
themes.loadLocalThemes();
import packages from "./plugins/packages/index";
import {NetworkWithIrcFramework} from "./models/network";
import Utils from "./command-line/utils";
import type {
ClientToServerEvents,
ServerToClientEvents,
InterServerEvents,
SocketData,
2024-02-15 22:01:22 +00:00
} from "../shared/types/socket-events";
2024-02-24 10:13:11 +00:00
import {ChanType} from "../shared/types/chan";
2024-02-29 06:53:23 +00:00
import {
LockedSharedConfiguration,
SharedConfiguration,
ConfigNetDefaults,
LockedConfigNetDefaults,
} from "../shared/types/config";
type ServerOptions = {
dev: boolean;
};
type ServerConfiguration = ConfigType & {
stylesheets: string[];
};
type IndexTemplateConfiguration = ServerConfiguration & {
cacheBust: string;
};
// A random number that will force clients to reload the page if it differs
const serverHash = Math.floor(Date.now() * Math.random());
let manager: ClientManager | null = null;
export default async function (
options: ServerOptions = {
dev: false,
}
) {
log.info(`The Lounge ${colors.green(Helper.getVersion())} \
2019-07-17 09:33:59 +00:00
(Node.js ${colors.green(process.versions.node)} on ${colors.green(process.platform)} ${
process.arch
})`);
log.info(`Configuration file: ${colors.green(Config.getConfigPath())}`);
2018-06-06 09:19:51 +00:00
const staticOptions = {
redirect: false,
maxAge: 86400 * 1000,
};
const app = express();
if (options.dev) {
(await import("./plugins/dev-server")).default(app);
}
app.set("env", "production")
.disable("x-powered-by")
.use(allRequests)
.use(addSecurityHeaders)
.get("/", indexRequest)
.get("/service-worker.js", forceNoCacheRequest)
.get("/js/bundle.js.map", forceNoCacheRequest)
.get("/css/style.css.map", forceNoCacheRequest)
.use(express.static(Utils.getFileFromRelativeToRoot("public"), staticOptions))
.use("/storage/", express.static(Config.getStoragePath(), staticOptions));
if (Config.values.fileUpload.enable) {
Uploader.router(app);
}
// This route serves *installed themes only*. Local themes are served directly
// from the `public/themes/` folder as static assets, without entering this
// handler. Remember this if you make changes to this function, serving of
// local themes will not get those changes.
2017-06-22 21:09:55 +00:00
app.get("/themes/:theme.css", (req, res) => {
const themeName = req.params.theme;
2019-07-22 16:50:04 +00:00
const theme = themes.getByName(themeName);
if (theme === undefined || theme.filename === undefined) {
2017-06-22 21:09:55 +00:00
return res.status(404).send("Not found");
}
2019-07-22 16:50:04 +00:00
return res.sendFile(theme.filename);
2017-06-22 21:09:55 +00:00
});
2018-01-05 17:40:34 +00:00
app.get("/packages/:package/:filename", (req, res) => {
const packageName = req.params.package;
const fileName = req.params.filename;
const packageFile = packages.getPackage(packageName);
2019-10-02 09:28:08 +00:00
if (!packageFile || !packages.getFiles().includes(`${packageName}/${fileName}`)) {
2018-01-05 17:40:34 +00:00
return res.status(404).send("Not found");
}
const packagePath = Config.getPackageModulePath(packageName);
2018-01-05 17:40:34 +00:00
return res.sendFile(path.join(packagePath, fileName));
});
if (Config.values.public && (Config.values.ldap || {}).enable) {
2019-07-17 09:33:59 +00:00
log.warn(
"Server is public and set to use LDAP. Set to private mode if trying to use LDAP authentication."
);
2016-07-30 01:20:38 +00:00
}
let server: import("http").Server | import("https").Server;
if (!Config.values.https.enable) {
const createServer = (await import("http")).createServer;
server = createServer(app);
2014-09-26 23:26:21 +00:00
} else {
const keyPath = Helper.expandHome(Config.values.https.key);
const certPath = Helper.expandHome(Config.values.https.certificate);
const caPath = Helper.expandHome(Config.values.https.ca);
2017-04-13 21:05:28 +00:00
if (!keyPath.length || !fs.existsSync(keyPath)) {
log.error("Path to SSL key is invalid. Stopping server...");
process.exit(1);
}
2017-04-13 21:05:28 +00:00
if (!certPath.length || !fs.existsSync(certPath)) {
log.error("Path to SSL certificate is invalid. Stopping server...");
process.exit(1);
}
2017-04-13 21:05:28 +00:00
2017-04-10 18:49:58 +00:00
if (caPath.length && !fs.existsSync(caPath)) {
log.error("Path to SSL ca bundle is invalid. Stopping server...");
process.exit(1);
2017-04-10 18:49:58 +00:00
}
const createServer = (await import("https")).createServer;
server = createServer(
2019-07-17 09:33:59 +00:00
{
key: fs.readFileSync(keyPath),
cert: fs.readFileSync(certPath),
ca: caPath ? fs.readFileSync(caPath) : undefined,
},
app
);
2014-09-26 23:26:21 +00:00
}
let listenParams:
| string
| {
port: number;
host: string | undefined;
};
if (typeof Config.values.host === "string" && Config.values.host.startsWith("unix:")) {
listenParams = Config.values.host.replace(/^unix:/, "");
} else {
listenParams = {
port: Config.values.port,
host: Config.values.host,
};
}
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
2017-09-03 12:13:56 +00:00
server.on("error", (err) => log.error(`${err}`));
server.listen(listenParams, () => {
if (typeof listenParams === "string") {
log.info("Available on socket " + colors.green(listenParams));
} else {
const protocol = Config.values.https.enable ? "https" : "http";
const address = server?.address();
if (address && typeof address !== "string") {
// TODO: Node may revert the Node 18 family string --> number change
// @ts-expect-error This condition will always return 'false' since the types 'string' and 'number' have no overlap.
if (address.family === "IPv6" || address.family === 6) {
address.address = "[" + address.address + "]";
}
log.info(
"Available at " +
colors.green(`${protocol}://${address.address}:${address.port}/`) +
` in ${colors.bold(Config.values.public ? "public" : "private")} mode`
);
2019-12-16 17:24:30 +00:00
}
}
2019-12-16 17:24:30 +00:00
// This should never happen
if (!server) {
return;
}
const sockets = new Server<
ClientToServerEvents,
ServerToClientEvents,
InterServerEvents,
SocketData
>(server, {
wsEngine: wsServer,
cookie: false,
serveClient: false,
// TODO: type as Server.Transport[]
transports: Config.values.transports as any,
pingTimeout: 60000,
});
sockets.on("connect", (socket) => {
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
2019-06-10 10:13:27 +00:00
socket.on("error", (err) => log.error(`io socket error: ${err}`));
if (Config.values.public) {
performAuthentication.call(socket, {});
} else {
2019-11-05 19:29:51 +00:00
socket.on("auth:perform", performAuthentication);
socket.emit("auth:start", serverHash);
}
});
manager = new ClientManager();
packages.loadPackages();
const defaultTheme = themes.getByName(Config.values.theme);
2019-07-22 16:50:04 +00:00
if (defaultTheme === undefined) {
log.warn(
`The specified default theme "${colors.red(
Config.values.theme
2019-07-22 16:50:04 +00:00
)}" does not exist, verify your config.`
);
Config.values.theme = "default";
2019-07-22 16:50:04 +00:00
} else if (defaultTheme.themeColor) {
Config.values.themeColor = defaultTheme.themeColor;
2019-07-22 16:50:04 +00:00
}
new Identification((identHandler, err) => {
if (err) {
log.error(`Could not start identd server, ${err.message}`);
process.exit(1);
} else if (!manager) {
log.error("Could not start identd server, ClientManager is undefined");
process.exit(1);
}
manager.init(identHandler, sockets);
});
2017-08-30 17:26:45 +00:00
// Handle ctrl+c and kill gracefully
let suicideTimeout: NodeJS.Timeout | null = null;
const exitGracefully = async function () {
2017-08-30 17:26:45 +00:00
if (suicideTimeout !== null) {
return;
}
log.info("Exiting...");
// Close all client and IRC connections
if (manager) {
manager.clients.forEach((client) => client.quit());
}
if (Config.values.prefetchStorage) {
log.info("Clearing prefetch storage folder, this might take a while...");
(await import("./plugins/storage")).default.emptyDir();
}
2017-08-30 17:26:45 +00:00
// Forcefully exit after 3 seconds
suicideTimeout = setTimeout(() => process.exit(1), 3000);
// Close http server
server?.close(() => {
if (suicideTimeout !== null) {
clearTimeout(suicideTimeout);
}
2017-08-30 17:26:45 +00:00
process.exit(0);
});
};
/* eslint-disable @typescript-eslint/no-misused-promises */
2017-08-30 17:26:45 +00:00
process.on("SIGINT", exitGracefully);
process.on("SIGTERM", exitGracefully);
/* eslint-enable @typescript-eslint/no-misused-promises */
// Clear storage folder after server starts successfully
if (Config.values.prefetchStorage) {
import("./plugins/storage")
.then(({default: storage}) => {
storage.emptyDir();
})
.catch((err: Error) => {
log.error(`Could not clear storage folder, ${err.message}`);
});
}
2017-10-06 09:53:08 +00:00
changelog.checkForUpdates(manager);
});
2017-10-06 09:53:08 +00:00
return server;
}
function getClientLanguage(socket: Socket): string | null {
const acceptLanguage = socket.handshake.headers["accept-language"];
if (typeof acceptLanguage === "string" && /^[\x00-\x7F]{1,50}$/.test(acceptLanguage)) {
// only allow ASCII strings between 1-50 characters in length
return acceptLanguage;
}
return null;
}
function getClientIp(socket: Socket) {
let ip = socket.handshake.address || "127.0.0.1";
2016-07-31 00:54:09 +00:00
if (Config.values.reverseProxy) {
const forwarded = String(socket.handshake.headers["x-forwarded-for"])
2019-07-17 09:33:59 +00:00
.split(/\s*,\s*/)
.filter(Boolean);
2017-06-11 19:33:04 +00:00
if (forwarded.length && net.isIP(forwarded[0])) {
ip = forwarded[0];
}
2016-04-03 05:12:49 +00:00
}
2016-07-31 00:54:09 +00:00
return ip.replace(/^::ffff:/, "");
2016-04-03 05:12:49 +00:00
}
function getClientSecure(socket: Socket) {
let secure = socket.handshake.secure;
if (Config.values.reverseProxy && socket.handshake.headers["x-forwarded-proto"] === "https") {
secure = true;
}
return secure;
}
function allRequests(req: Request, res: Response, next: NextFunction) {
res.setHeader("X-Content-Type-Options", "nosniff");
return next();
}
function addSecurityHeaders(req: Request, res: Response, next: NextFunction) {
const policies = [
"default-src 'none'", // default to nothing
"base-uri 'none'", // disallow <base>, has no fallback to default-src
"form-action 'self'", // 'self' to fix saving passwords in Firefox, even though login is handled in javascript
"connect-src 'self' ws: wss:", // allow self for polling; websockets
2018-01-30 09:23:34 +00:00
"style-src 'self' https: 'unsafe-inline'", // allow inline due to use in irc hex colors
"script-src 'self'", // javascript
"worker-src 'self'", // service worker
"manifest-src 'self'", // manifest.json
"font-src 'self' https:", // allow loading fonts from secure sites (e.g. google fonts)
"media-src 'self' https:", // self for notification sound; allow https media (audio previews)
];
// If prefetch is enabled, but storage is not, we have to allow mixed content
// - https://user-images.githubusercontent.com is where we currently push our changelog screenshots
// - data: is required for the HTML5 video player
if (Config.values.prefetchStorage || !Config.values.prefetch) {
policies.push("img-src 'self' data: https://user-images.githubusercontent.com");
policies.unshift("block-all-mixed-content");
} else {
policies.push("img-src http: https: data:");
}
res.setHeader("Content-Security-Policy", policies.join("; "));
res.setHeader("Referrer-Policy", "no-referrer");
return next();
}
function forceNoCacheRequest(req: Request, res: Response, next: NextFunction) {
// Intermittent proxies must not cache the following requests,
// browsers must fetch the latest version of these files (service worker, source maps)
res.setHeader("Cache-Control", "no-cache, no-transform");
return next();
}
function indexRequest(req: Request, res: Response) {
res.setHeader("Content-Type", "text/html");
2019-07-17 09:33:59 +00:00
return fs.readFile(
Utils.getFileFromRelativeToRoot("client/index.html.tpl"),
2019-07-17 09:33:59 +00:00
"utf-8",
(err, file) => {
if (err) {
throw err;
}
const config: IndexTemplateConfiguration = {
...getServerConfiguration(),
...{cacheBust: Helper.getVersionCacheBust()},
};
2019-07-17 09:33:59 +00:00
res.send(_.template(file)(config));
}
);
}
function initializeClient(
socket: Socket,
client: Client,
token: string,
lastMessage: number,
openChannel: number
) {
2019-11-05 19:29:51 +00:00
socket.off("auth:perform", performAuthentication);
socket.emit("auth:success");
2016-09-25 06:52:16 +00:00
client.clientAttach(socket.id, token);
// Client sends currently active channel on reconnect,
// pass it into `open` directly so it is verified and updated if necessary
if (openChannel) {
client.open(socket.id, openChannel);
// If client provided channel passes checks, use it. if client has invalid
// channel open (or windows like settings) then use last known server active channel
openChannel = client.attachedClients[socket.id].openChannel || client.lastActiveChannel;
} else {
openChannel = client.lastActiveChannel;
}
if (Config.values.fileUpload.enable) {
new Uploader(socket);
}
socket.on("disconnect", function () {
process.nextTick(() => client.clientDetach(socket.id));
2017-08-13 18:37:12 +00:00
});
socket.on("input", (data) => {
2020-08-07 16:52:50 +00:00
if (_.isPlainObject(data)) {
2017-08-13 18:37:12 +00:00
client.input(data);
}
});
socket.on("more", (data) => {
2020-08-07 16:52:50 +00:00
if (_.isPlainObject(data)) {
const history = client.more(data);
if (history !== null) {
socket.emit("more", history);
}
2017-08-13 18:37:12 +00:00
}
});
2017-08-13 18:37:12 +00:00
socket.on("network:new", (data) => {
2020-08-07 16:52:50 +00:00
if (_.isPlainObject(data)) {
2017-08-13 18:37:12 +00:00
// prevent people from overriding webirc settings
2017-11-28 17:25:15 +00:00
data.uuid = null;
data.commands = null;
data.ignoreList = null;
2017-08-13 18:37:12 +00:00
client.connectToNetwork(data);
2017-08-13 18:37:12 +00:00
}
});
2017-08-13 18:37:12 +00:00
socket.on("network:get", (data) => {
if (typeof data !== "string") {
return;
}
const network = _.find(client.networks, {uuid: data});
if (!network) {
return;
}
2019-11-02 18:45:00 +00:00
socket.emit("network:info", network.exportForEdit());
});
socket.on("network:edit", (data) => {
2020-08-07 16:52:50 +00:00
if (!_.isPlainObject(data)) {
return;
}
const network = _.find(client.networks, {uuid: data.uuid});
if (!network) {
return;
}
(network as NetworkWithIrcFramework).edit(client, data);
});
socket.on("history:clear", (data) => {
2020-08-07 16:52:50 +00:00
if (_.isPlainObject(data)) {
client.clearHistory(data);
}
});
if (!Config.values.public && !Config.values.ldap.enable) {
socket.on("change-password", (data) => {
2020-08-07 16:52:50 +00:00
if (_.isPlainObject(data)) {
2018-01-11 11:33:36 +00:00
const old = data.old_password;
const p1 = data.new_password;
const p2 = data.verify_password;
if (typeof p1 === "undefined" || p1 === "" || p1 !== p2) {
2017-08-13 18:37:12 +00:00
socket.emit("change-password", {
error: "",
success: false,
2017-08-13 18:37:12 +00:00
});
return;
}
2016-05-31 21:28:31 +00:00
2017-08-13 18:37:12 +00:00
Helper.password
.compare(old || "", client.config.password)
.then((matching) => {
if (!matching) {
socket.emit("change-password", {
error: "password_incorrect",
success: false,
2017-08-13 18:37:12 +00:00
});
return;
}
2017-08-13 18:37:12 +00:00
const hash = Helper.password.hash(p1);
client.setPassword(hash, (success: boolean) => {
const obj = {success: false, error: undefined} as {
success: boolean;
error: string | undefined;
};
2017-08-13 18:37:12 +00:00
if (success) {
obj.success = true;
2017-08-13 18:37:12 +00:00
} else {
obj.error = "update_failed";
2017-08-13 18:37:12 +00:00
}
2017-08-13 18:37:12 +00:00
socket.emit("change-password", obj);
});
2019-07-17 09:33:59 +00:00
})
.catch((error: Error) => {
log.error(`Error while checking users password. Error: ${error.message}`);
2017-08-13 18:37:12 +00:00
});
}
});
2017-08-13 18:37:12 +00:00
}
socket.on("open", (data) => {
client.open(socket.id, data);
});
socket.on("sort", (data) => {
2020-08-07 16:52:50 +00:00
if (_.isPlainObject(data)) {
2017-08-13 18:37:12 +00:00
client.sort(data);
}
});
socket.on("names", (data) => {
2020-08-07 16:52:50 +00:00
if (_.isPlainObject(data)) {
2017-08-13 18:37:12 +00:00
client.names(data);
}
});
2017-08-13 18:37:12 +00:00
socket.on("changelog", () => {
Promise.all([changelog.fetch(), packages.outdated()])
.then(([changelogData, packageUpdate]) => {
changelogData.packages = packageUpdate;
socket.emit("changelog", changelogData);
})
.catch((error: Error) => {
log.error(`Error while fetching changelog. Error: ${error.message}`);
});
Improve UI of the About section and changelog viewer - Keep consistent width between the Help page and Changelog (which is already different from other windows 😠) - Add icons to the About links - Make sure `li` elements (i.e. all the lists in changelogs) are consistent in size with rest of the client - Display version and release notes link on the "About The Lounge" header line, smaller, pushed to the right - Check new releases when opening the Help window in order to display it without having to open the release notes. Release notes are being fed to the Changelog page at that moment to avoid fetching twice. - Re-check version/fetch release notes after 24h. Since The Lounge can now run 24/7, reconnect when losing the network, we have to assume an "always-on" usage. - Change icon, animate background color when getting response from GitHub to avoid flashing. - Combine click handlers with our wonderful window management. These were the same handler, even with similar checks (`target` exists, etc.), just in 2 different places. This is necessary for the next item. - Combine "Open release notes" and "Go back to Help" button behaviors with window management handlers. The window management code is gross as ever, and is in desperate need of a refactor, but at least there is no duplicated code for the same behavior + history management. This fixes the "Next" history behavior (however reloading the app while viewing the notes does not load on the notes, but this is a bug for a different PR!). - Added a rule in the history management thingy: if a link we want to add history handling to has an `id`, store that in the state - Added a button to go back to the Help window - Fixed links to releases - Send user to the GitHub issues *list* instead of *new issue form* because if they do not have a GitHub account, they will be redirected to the login page, which is a rather unpleasant experience when you are already confused... - Fixed a bug that would return data about a new release in `latest` even though it is already the `current`. It was showing the current version as "The Lounge v... is now available". - Added https://user-images.githubusercontent.com to the CSP rule when prefetch storage is enabled, because that is where we have stored screenshots in the changelog so far. Meh (we can improve that later if we decide to have a dedicated place for screenshots). - Fetch changelog info even in public mode because users in public mode can access the release notes. They do not see the result of the version checker however.
2017-12-23 03:40:41 +00:00
});
// In public mode only one client can be connected,
// so there's no need to handle msg:preview:toggle
if (!Config.values.public) {
socket.on("msg:preview:toggle", (data) => {
if (_.isPlainObject(data)) {
return;
}
const networkAndChan = client.find(data.target);
const newState = Boolean(data.shown);
if (!networkAndChan) {
return;
}
2017-08-13 18:37:12 +00:00
// Process multiple message at once for /collapse and /expand commands
if (Array.isArray(data.messageIds)) {
for (const msgId of data.messageIds) {
const message = networkAndChan.chan.findMessage(msgId);
if (message) {
for (const preview of message.previews) {
preview.shown = newState;
}
}
}
return;
}
const message = networkAndChan.chan.findMessage(data.msgId);
2017-08-13 18:37:12 +00:00
if (!message) {
return;
}
2017-08-13 18:37:12 +00:00
const preview = message.findPreview(data.link);
2017-08-13 18:37:12 +00:00
if (preview) {
preview.shown = newState;
}
});
}
socket.on("mentions:get", () => {
socket.emit("mentions:list", client.mentions);
});
socket.on("mentions:dismiss", (msgId) => {
if (typeof msgId !== "number") {
return;
}
client.mentions.splice(
client.mentions.findIndex((m) => m.msgId === msgId),
1
);
});
socket.on("mentions:dismiss_all", () => {
client.mentions = [];
});
if (!Config.values.public) {
2018-02-20 11:24:46 +00:00
socket.on("push:register", (subscription) => {
if (!Object.prototype.hasOwnProperty.call(client.config.sessions, token)) {
2018-02-20 11:24:46 +00:00
return;
}
2017-07-10 19:47:03 +00:00
2019-07-17 09:33:59 +00:00
const registration = client.registerPushSubscription(
client.config.sessions[token],
subscription
);
2017-07-10 19:47:03 +00:00
2018-02-20 11:24:46 +00:00
if (registration) {
client.manager.webPush.pushSingle(client, registration, {
type: "notification",
timestamp: Date.now(),
title: "The Lounge",
body: "🚀 Push notifications have been enabled",
});
}
});
2017-07-10 19:47:03 +00:00
2018-02-20 11:24:46 +00:00
socket.on("push:unregister", () => client.unregisterPushSubscription(token));
}
2017-07-10 19:47:03 +00:00
2017-08-15 09:44:29 +00:00
const sendSessionList = () => {
// TODO: this should use the ClientSession type currently in client
const sessions = _.map(client.config.sessions, (session, sessionToken) => {
return {
current: sessionToken === token,
active: _.reduce(
client.attachedClients,
(count, attachedClient) =>
count + (attachedClient.token === sessionToken ? 1 : 0),
0
),
lastUse: session.lastUse,
ip: session.ip,
agent: session.agent,
token: sessionToken, // TODO: Ideally don't expose actual tokens to the client
};
});
2017-08-15 09:44:29 +00:00
socket.emit("sessions:list", sessions);
};
socket.on("sessions:get", sendSessionList);
if (!Config.values.public) {
Offer optional syncing of client settings Write synced settings to localstorage. move settings and webpush init to init.js stub for server sending clientsettings get very basic setting sync working Also update client.config.clientSettings on settings:set Full setting sync with mandatory and excluded sync options Actually check client preferences. Further settings restructuring. Refactor options.js make storage act in a sane manner. Add new parameter to applySetting Do not sync if the setting is stored as a result of syncing General clean up, commenting and restructing. sync from server on checking "sync" offer initial sync Better deal with DOM being ready and instances of inital sync showing Don't try to disable autocompletion when not enabled. Restructure option.js to seperate functions from settings. More consistency in naming options vs settings Switch processSetting and applySetting names reflecting their functionality better. move options init back to configuration. simplify how settings are synced around. move options init after template building. Remove unneeded hasOwnProperty Use global for #theme and only apply theme in applySetting Return when no server side clientsettings excist. Autocompletion options to options.settings Make nocss param in url work again. Actually filter out empty highlight values. Clarify alwaysSync comment. Remove manual step for initial sync change attr to prop in options.js replace unbind with off in autocompletion.js Do not sync settings when the lounge is set to public. fix eslint error Fix merge error Do not show sync warning after page refresh when sync is enabled Move setting sync label in actual label. Improve server setting sync handling performance and failure potential. Don't give impression that the desktop notificiation is off when the browser permission is denied. Refine showing and hiding of notification warnings. rename all setting socket events to singular setting. add experimental note and icon to settingsync. fix css linting error
2017-12-11 19:01:15 +00:00
socket.on("setting:set", (newSetting) => {
2020-08-07 16:52:50 +00:00
if (!_.isPlainObject(newSetting)) {
Offer optional syncing of client settings Write synced settings to localstorage. move settings and webpush init to init.js stub for server sending clientsettings get very basic setting sync working Also update client.config.clientSettings on settings:set Full setting sync with mandatory and excluded sync options Actually check client preferences. Further settings restructuring. Refactor options.js make storage act in a sane manner. Add new parameter to applySetting Do not sync if the setting is stored as a result of syncing General clean up, commenting and restructing. sync from server on checking "sync" offer initial sync Better deal with DOM being ready and instances of inital sync showing Don't try to disable autocompletion when not enabled. Restructure option.js to seperate functions from settings. More consistency in naming options vs settings Switch processSetting and applySetting names reflecting their functionality better. move options init back to configuration. simplify how settings are synced around. move options init after template building. Remove unneeded hasOwnProperty Use global for #theme and only apply theme in applySetting Return when no server side clientsettings excist. Autocompletion options to options.settings Make nocss param in url work again. Actually filter out empty highlight values. Clarify alwaysSync comment. Remove manual step for initial sync change attr to prop in options.js replace unbind with off in autocompletion.js Do not sync settings when the lounge is set to public. fix eslint error Fix merge error Do not show sync warning after page refresh when sync is enabled Move setting sync label in actual label. Improve server setting sync handling performance and failure potential. Don't give impression that the desktop notificiation is off when the browser permission is denied. Refine showing and hiding of notification warnings. rename all setting socket events to singular setting. add experimental note and icon to settingsync. fix css linting error
2017-12-11 19:01:15 +00:00
return;
}
2019-07-17 09:33:59 +00:00
if (
typeof newSetting.value === "object" ||
typeof newSetting.name !== "string" ||
newSetting.name[0] === "_"
) {
2019-01-16 08:52:09 +00:00
return;
}
Offer optional syncing of client settings Write synced settings to localstorage. move settings and webpush init to init.js stub for server sending clientsettings get very basic setting sync working Also update client.config.clientSettings on settings:set Full setting sync with mandatory and excluded sync options Actually check client preferences. Further settings restructuring. Refactor options.js make storage act in a sane manner. Add new parameter to applySetting Do not sync if the setting is stored as a result of syncing General clean up, commenting and restructing. sync from server on checking "sync" offer initial sync Better deal with DOM being ready and instances of inital sync showing Don't try to disable autocompletion when not enabled. Restructure option.js to seperate functions from settings. More consistency in naming options vs settings Switch processSetting and applySetting names reflecting their functionality better. move options init back to configuration. simplify how settings are synced around. move options init after template building. Remove unneeded hasOwnProperty Use global for #theme and only apply theme in applySetting Return when no server side clientsettings excist. Autocompletion options to options.settings Make nocss param in url work again. Actually filter out empty highlight values. Clarify alwaysSync comment. Remove manual step for initial sync change attr to prop in options.js replace unbind with off in autocompletion.js Do not sync settings when the lounge is set to public. fix eslint error Fix merge error Do not show sync warning after page refresh when sync is enabled Move setting sync label in actual label. Improve server setting sync handling performance and failure potential. Don't give impression that the desktop notificiation is off when the browser permission is denied. Refine showing and hiding of notification warnings. rename all setting socket events to singular setting. add experimental note and icon to settingsync. fix css linting error
2017-12-11 19:01:15 +00:00
// We do not need to do write operations and emit events if nothing changed.
if (client.config.clientSettings[newSetting.name] !== newSetting.value) {
client.config.clientSettings[newSetting.name] = newSetting.value;
// Pass the setting to all clients.
client.emit("setting:new", {
name: newSetting.name,
value: newSetting.value,
});
client.save();
2019-01-16 09:23:12 +00:00
2020-07-22 15:28:12 +00:00
if (newSetting.name === "highlights" || newSetting.name === "highlightExceptions") {
2019-01-16 09:23:12 +00:00
client.compileCustomHighlights();
} else if (newSetting.name === "awayMessage") {
if (typeof newSetting.value !== "string") {
newSetting.value = "";
}
client.awayMessage = newSetting.value;
2019-01-16 09:23:12 +00:00
}
Offer optional syncing of client settings Write synced settings to localstorage. move settings and webpush init to init.js stub for server sending clientsettings get very basic setting sync working Also update client.config.clientSettings on settings:set Full setting sync with mandatory and excluded sync options Actually check client preferences. Further settings restructuring. Refactor options.js make storage act in a sane manner. Add new parameter to applySetting Do not sync if the setting is stored as a result of syncing General clean up, commenting and restructing. sync from server on checking "sync" offer initial sync Better deal with DOM being ready and instances of inital sync showing Don't try to disable autocompletion when not enabled. Restructure option.js to seperate functions from settings. More consistency in naming options vs settings Switch processSetting and applySetting names reflecting their functionality better. move options init back to configuration. simplify how settings are synced around. move options init after template building. Remove unneeded hasOwnProperty Use global for #theme and only apply theme in applySetting Return when no server side clientsettings excist. Autocompletion options to options.settings Make nocss param in url work again. Actually filter out empty highlight values. Clarify alwaysSync comment. Remove manual step for initial sync change attr to prop in options.js replace unbind with off in autocompletion.js Do not sync settings when the lounge is set to public. fix eslint error Fix merge error Do not show sync warning after page refresh when sync is enabled Move setting sync label in actual label. Improve server setting sync handling performance and failure potential. Don't give impression that the desktop notificiation is off when the browser permission is denied. Refine showing and hiding of notification warnings. rename all setting socket events to singular setting. add experimental note and icon to settingsync. fix css linting error
2017-12-11 19:01:15 +00:00
}
});
socket.on("setting:get", () => {
if (!Object.prototype.hasOwnProperty.call(client.config, "clientSettings")) {
Offer optional syncing of client settings Write synced settings to localstorage. move settings and webpush init to init.js stub for server sending clientsettings get very basic setting sync working Also update client.config.clientSettings on settings:set Full setting sync with mandatory and excluded sync options Actually check client preferences. Further settings restructuring. Refactor options.js make storage act in a sane manner. Add new parameter to applySetting Do not sync if the setting is stored as a result of syncing General clean up, commenting and restructing. sync from server on checking "sync" offer initial sync Better deal with DOM being ready and instances of inital sync showing Don't try to disable autocompletion when not enabled. Restructure option.js to seperate functions from settings. More consistency in naming options vs settings Switch processSetting and applySetting names reflecting their functionality better. move options init back to configuration. simplify how settings are synced around. move options init after template building. Remove unneeded hasOwnProperty Use global for #theme and only apply theme in applySetting Return when no server side clientsettings excist. Autocompletion options to options.settings Make nocss param in url work again. Actually filter out empty highlight values. Clarify alwaysSync comment. Remove manual step for initial sync change attr to prop in options.js replace unbind with off in autocompletion.js Do not sync settings when the lounge is set to public. fix eslint error Fix merge error Do not show sync warning after page refresh when sync is enabled Move setting sync label in actual label. Improve server setting sync handling performance and failure potential. Don't give impression that the desktop notificiation is off when the browser permission is denied. Refine showing and hiding of notification warnings. rename all setting socket events to singular setting. add experimental note and icon to settingsync. fix css linting error
2017-12-11 19:01:15 +00:00
socket.emit("setting:all", {});
return;
}
const clientSettings = client.config.clientSettings;
socket.emit("setting:all", clientSettings);
});
2020-03-07 12:56:50 +00:00
socket.on("search", async (query) => {
const results = await client.search(query);
socket.emit("search:results", results);
2020-03-07 12:56:50 +00:00
});
socket.on("mute:change", ({target, setMutedTo}) => {
const networkAndChan = client.find(target);
if (!networkAndChan) {
return;
}
const {chan, network} = networkAndChan;
// If the user mutes the lobby, we mute the entire network.
if (chan.type === ChanType.LOBBY) {
for (const channel of network.channels) {
if (channel.type !== ChanType.SPECIAL) {
channel.setMuteStatus(setMutedTo);
}
}
} else {
if (chan.type !== ChanType.SPECIAL) {
chan.setMuteStatus(setMutedTo);
}
}
for (const attachedClient of Object.keys(client.attachedClients)) {
manager!.sockets.in(attachedClient).emit("mute:changed", {
target,
status: setMutedTo,
});
}
client.save();
});
Offer optional syncing of client settings Write synced settings to localstorage. move settings and webpush init to init.js stub for server sending clientsettings get very basic setting sync working Also update client.config.clientSettings on settings:set Full setting sync with mandatory and excluded sync options Actually check client preferences. Further settings restructuring. Refactor options.js make storage act in a sane manner. Add new parameter to applySetting Do not sync if the setting is stored as a result of syncing General clean up, commenting and restructing. sync from server on checking "sync" offer initial sync Better deal with DOM being ready and instances of inital sync showing Don't try to disable autocompletion when not enabled. Restructure option.js to seperate functions from settings. More consistency in naming options vs settings Switch processSetting and applySetting names reflecting their functionality better. move options init back to configuration. simplify how settings are synced around. move options init after template building. Remove unneeded hasOwnProperty Use global for #theme and only apply theme in applySetting Return when no server side clientsettings excist. Autocompletion options to options.settings Make nocss param in url work again. Actually filter out empty highlight values. Clarify alwaysSync comment. Remove manual step for initial sync change attr to prop in options.js replace unbind with off in autocompletion.js Do not sync settings when the lounge is set to public. fix eslint error Fix merge error Do not show sync warning after page refresh when sync is enabled Move setting sync label in actual label. Improve server setting sync handling performance and failure potential. Don't give impression that the desktop notificiation is off when the browser permission is denied. Refine showing and hiding of notification warnings. rename all setting socket events to singular setting. add experimental note and icon to settingsync. fix css linting error
2017-12-11 19:01:15 +00:00
}
2017-08-15 09:44:29 +00:00
socket.on("sign-out", (tokenToSignOut) => {
// If no token provided, sign same client out
2020-08-07 16:52:50 +00:00
if (!tokenToSignOut || typeof tokenToSignOut !== "string") {
2017-08-15 09:44:29 +00:00
tokenToSignOut = token;
}
if (!Object.prototype.hasOwnProperty.call(client.config.sessions, tokenToSignOut)) {
2017-08-15 09:44:29 +00:00
return;
}
delete client.config.sessions[tokenToSignOut];
client.save();
2017-08-15 09:44:29 +00:00
_.map(client.attachedClients, (attachedClient, socketId) => {
if (attachedClient.token !== tokenToSignOut) {
return;
}
const socketToRemove = manager!.sockets.of("/").sockets.get(socketId);
2017-08-15 09:44:29 +00:00
socketToRemove!.emit("sign-out");
socketToRemove!.disconnect();
2017-08-15 09:44:29 +00:00
});
// Do not send updated session list if user simply logs out
if (tokenToSignOut !== token) {
sendSessionList();
}
2017-08-13 18:37:12 +00:00
});
// socket.join is a promise depending on the adapter.
void socket.join(client.id);
2017-08-13 18:37:12 +00:00
const sendInitEvent = (tokenToSend: string | null) => {
2017-08-13 18:37:12 +00:00
socket.emit("init", {
active: openChannel,
2019-07-17 09:33:59 +00:00
networks: client.networks.map((network) =>
network.getFilteredClone(openChannel, lastMessage)
2019-07-17 09:33:59 +00:00
),
token: tokenToSend,
2017-08-13 18:37:12 +00:00
});
2019-07-02 16:02:02 +00:00
socket.emit("commands", inputs.getCommands());
2017-08-13 18:37:12 +00:00
};
if (Config.values.public) {
2019-12-15 15:07:17 +00:00
sendInitEvent(null);
} else if (!token) {
2017-08-13 18:37:12 +00:00
client.generateToken((newToken) => {
2019-12-15 15:07:17 +00:00
token = client.calculateTokenHash(newToken);
client.attachedClients[socket.id].token = token;
2017-08-13 18:37:12 +00:00
2017-10-12 07:57:25 +00:00
client.updateSession(token, getClientIp(socket), socket.request);
sendInitEvent(newToken);
});
2017-08-13 18:37:12 +00:00
} else {
2019-12-15 15:07:17 +00:00
client.updateSession(token, getClientIp(socket), socket.request);
2017-08-13 18:37:12 +00:00
sendInitEvent(null);
}
}
2024-02-29 06:53:23 +00:00
function getClientConfiguration(): SharedConfiguration | LockedSharedConfiguration {
const common = {
fileUpload: Config.values.fileUpload.enable,
ldapEnabled: Config.values.ldap.enable,
isUpdateAvailable: changelog.isUpdateAvailable,
applicationServerKey: manager!.webPush.vapidKeys!.publicKey,
version: Helper.getVersionNumber(),
gitCommit: Helper.getGitCommit(),
themes: themes.getAll(),
defaultTheme: Config.values.theme,
public: Config.values.public,
useHexIp: Config.values.useHexIp,
prefetch: Config.values.prefetch,
fileUploadMaxFileSize: Uploader ? Uploader.getMaxFileSize() : undefined, // TODO can't be undefined?
};
2024-02-29 06:53:23 +00:00
const defaultsOverride = {
nick: Config.getDefaultNick(), // expand the number part
2024-02-29 06:53:23 +00:00
// TODO: this doesn't seem right, if the client needs this as a buffer
// the client ought to add it on its own
sasl: "",
saslAccount: "",
saslPassword: "",
};
2024-02-29 06:53:23 +00:00
if (!Config.values.lockNetwork) {
const defaults: ConfigNetDefaults = {
..._.clone(Config.values.defaults),
...defaultsOverride,
};
const result: SharedConfiguration = {
...common,
defaults: defaults,
lockNetwork: Config.values.lockNetwork,
};
return result;
}
2024-02-29 06:53:23 +00:00
// Only send defaults that are visible on the client
const defaults: LockedConfigNetDefaults = {
..._.pick(Config.values.defaults, ["name", "username", "password", "realname", "join"]),
...defaultsOverride,
};
const result: LockedSharedConfiguration = {
...common,
lockNetwork: Config.values.lockNetwork,
defaults: defaults,
};
return result;
}
function getServerConfiguration(): ServerConfiguration {
return {...Config.values, ...{stylesheets: packages.getStylesheets()}};
2018-01-05 17:40:34 +00:00
}
function performAuthentication(this: Socket, data) {
2020-08-07 16:52:50 +00:00
if (!_.isPlainObject(data)) {
2018-08-29 10:55:30 +00:00
return;
}
const socket = this;
let client;
let token: string;
2019-12-15 15:07:17 +00:00
const finalInit = () =>
initializeClient(socket, client, token, data.lastMessage || -1, data.openChannel);
const initClient = () => {
// Configuration does not change during runtime of TL,
// and the client listens to this event only once
if (!data.hasConfig) {
socket.emit("configuration", getClientConfiguration());
2019-11-12 20:03:59 +00:00
socket.emit(
"push:issubscribed",
token && client.config.sessions[token].pushSubscription ? true : false
);
}
client.config.browser = {
ip: getClientIp(socket),
isSecure: getClientSecure(socket),
language: getClientLanguage(socket),
};
2017-08-13 18:37:12 +00:00
// If webirc is enabled perform reverse dns lookup
if (Config.values.webirc === null) {
2017-08-13 18:37:12 +00:00
return finalInit();
}
2017-08-13 18:37:12 +00:00
reverseDnsLookup(client.config.browser?.ip, (hostname) => {
client.config.browser!.hostname = hostname;
2017-08-13 18:37:12 +00:00
finalInit();
});
};
if (Config.values.public) {
client = new Client(manager!);
client.connect();
manager!.clients.push(client);
socket.on("disconnect", function () {
manager!.clients = _.without(manager!.clients, client);
client.quit();
});
initClient();
return;
}
if (typeof data.user !== "string") {
return;
}
const authCallback = (success) => {
// Authorization failed
if (!success) {
2018-03-17 08:09:59 +00:00
if (!client) {
2019-07-17 09:33:59 +00:00
log.warn(
`Authentication for non existing user attempted from ${colors.bold(
getClientIp(socket)
)}`
);
2018-03-17 08:09:59 +00:00
} else {
2019-07-17 09:33:59 +00:00
log.warn(
`Authentication failed for user ${colors.bold(data.user)} from ${colors.bold(
getClientIp(socket)
)}`
);
2018-03-17 08:09:59 +00:00
}
2019-11-05 19:29:51 +00:00
socket.emit("auth:failed");
return;
2016-04-03 05:12:49 +00:00
}
2016-07-30 01:20:38 +00:00
// If authorization succeeded but there is no loaded user,
// load it and find the user again (this happens with LDAP)
if (!client) {
client = manager!.loadUser(data.user);
2016-07-30 01:20:38 +00:00
}
initClient();
};
2016-07-30 01:20:38 +00:00
client = manager!.findClient(data.user);
// We have found an existing user and client has provided a token
if (client && data.token) {
const providedToken = client.calculateTokenHash(data.token);
if (Object.prototype.hasOwnProperty.call(client.config.sessions, providedToken)) {
token = providedToken;
return authCallback(true);
}
}
Auth.initialize().then(() => {
// Perform password checking
Auth.auth(manager, client, data.user, data.password, authCallback);
});
}
2017-08-13 18:37:12 +00:00
function reverseDnsLookup(ip: string, callback: (hostname: string) => void) {
// node can throw, even if we provide valid input based on the DNS server
// returning SERVFAIL it seems: https://github.com/thelounge/thelounge/issues/4768
// so we manually resolve with the ip as a fallback in case something fails
try {
dns.reverse(ip, (reverseErr, hostnames) => {
if (reverseErr || hostnames.length < 1) {
return callback(ip);
}
dns.resolve(
hostnames[0],
net.isIP(ip) === 6 ? "AAAA" : "A",
(resolveErr, resolvedIps) => {
// TODO: investigate SoaRecord class
if (!Array.isArray(resolvedIps)) {
return callback(ip);
}
if (resolveErr || resolvedIps.length < 1) {
return callback(ip);
}
for (const resolvedIp of resolvedIps) {
if (ip === resolvedIp) {
return callback(hostnames[0]);
}
}
return callback(ip);
}
);
});
} catch (err) {
log.error(`failed to resolve rDNS for ${ip}, using ip instead`, (err as any).toString());
setImmediate(callback, ip); // makes sure we always behave asynchronously
}
2017-08-13 18:37:12 +00:00
}