aboutsummaryrefslogtreecommitdiffstats
path: root/server/src
diff options
context:
space:
mode:
Diffstat (limited to 'server/src')
-rw-r--r--server/src/commands/admin/reload.js5
-rw-r--r--server/src/commands/core/changenick.js4
-rw-r--r--server/src/commands/core/chat.js36
-rw-r--r--server/src/commands/core/emote.js96
-rw-r--r--server/src/commands/core/help.js4
-rw-r--r--server/src/commands/core/morestats.js2
-rw-r--r--server/src/commands/core/whisper.js2
-rw-r--r--server/src/commands/internal/legacylayer.js20
-rw-r--r--server/src/commands/mod/dumb.js4
-rw-r--r--server/src/core/server.js68
-rw-r--r--server/src/managers/config.js5
11 files changed, 196 insertions, 50 deletions
diff --git a/server/src/commands/admin/reload.js b/server/src/commands/admin/reload.js
index f40d0b2..947f9d9 100644
--- a/server/src/commands/admin/reload.js
+++ b/server/src/commands/admin/reload.js
@@ -9,13 +9,12 @@ exports.run = async (core, server, socket, data) => {
return server._police.frisk(socket.remoteAddress, 20);
}
- // do command reloads and store results
+ // do command reload and store results
let loadResult = core.managers.dynamicImports.reloadDirCache('src/commands');
loadResult += core.commands.loadCommands();
// clear and rebuild all module hooks
- server.clearHooks();
- core.commands.initCommandHooks(server);
+ server.loadHooks();
// build reply based on reload results
if (loadResult == '') {
diff --git a/server/src/commands/core/changenick.js b/server/src/commands/core/changenick.js
index 28d8de3..ae057b3 100644
--- a/server/src/commands/core/changenick.js
+++ b/server/src/commands/core/changenick.js
@@ -85,10 +85,10 @@ exports.run = async (core, server, socket, data) => {
// module hook functions
exports.initHooks = (server) => {
- server.registerHook('in', 'chat', this.nickCheck);
+ server.registerHook('in', 'chat', this.nickCheck, 29);
};
-// hooks chat commands checking for /whisper
+// hooks chat commands checking for /nick
exports.nickCheck = (core, server, socket, payload) => {
if (typeof payload.text !== 'string') {
return false;
diff --git a/server/src/commands/core/chat.js b/server/src/commands/core/chat.js
index 6f5c6a0..3455453 100644
--- a/server/src/commands/core/chat.js
+++ b/server/src/commands/core/chat.js
@@ -62,8 +62,8 @@ exports.run = async (core, server, socket, data) => {
// module hook functions
exports.initHooks = (server) => {
- server.registerHook('in', 'chat', this.commandCheckIn);
- server.registerHook('out', 'chat', this.commandCheckOut);
+ server.registerHook('in', 'chat', this.commandCheckIn, 20);
+ server.registerHook('in', 'chat', this.finalCmdCheck, 254);
};
// checks for miscellaneous '/' based commands
@@ -84,31 +84,26 @@ exports.commandCheckIn = (core, server, socket, payload) => {
return payload;
};
-// checks for miscellaneous '/' based commands
-exports.commandCheckOut = (core, server, socket, payload) => {
+exports.finalCmdCheck = (core, server, socket, payload) => {
+ if (typeof payload.text !== 'string') {
+ return false;
+ }
+
if (!payload.text.startsWith('/')) {
return payload;
}
- // TODO: make emotes their own module/event #lazydev
- if (payload.text.startsWith('//me ')) {
- payload.text = payload.text.substr(1, payload.text.length);
+ if (payload.text.startsWith('//')) {
+ payload.text = payload.text.substr(1);
return payload;
- } else if (payload.text.startsWith('/me ')) {
- let emote = payload.text.substr(4);
- if (emote.trim() === '') {
- emote = 'fails at life';
- }
-
- let newPayload = {
- cmd: 'info',
- type: 'emote',
- nick: payload.nick,
- text: `@${payload.nick} ${emote}`
- };
+ } else {
+ server.reply({
+ cmd: 'warn',
+ text: `Unknown command: ${payload.text}`
+ }, socket);
- return newPayload;
+ return false;
}
return payload;
@@ -123,6 +118,5 @@ exports.info = {
API: { cmd: 'chat', text: '<text to send>' }
Text: Uuuuhm. Just kind type in that little box at the bottom and hit enter.\n
Bonus super secret hidden commands:
- /me <emote>
/myhash`
};
diff --git a/server/src/commands/core/emote.js b/server/src/commands/core/emote.js
new file mode 100644
index 0000000..40fcff2
--- /dev/null
+++ b/server/src/commands/core/emote.js
@@ -0,0 +1,96 @@
+/*
+ Description: Broadcasts an emote to the current channel
+*/
+
+// module support functions
+const parseText = (text) => {
+ // verifies user input is text
+ if (typeof text !== 'string') {
+ return false;
+ }
+
+ // strip newlines from beginning and end
+ text = text.replace(/^\s*\n|^\s+$|\n\s*$/g, '');
+ // replace 3+ newlines with just 2 newlines
+ text = text.replace(/\n{3,}/g, "\n\n");
+
+ return text;
+};
+
+// module main
+exports.run = async (core, server, socket, payload) => {
+ // check user input
+ let text = parseText(payload.text);
+
+ if (!text) {
+ // lets not send objects or empty text, yea?
+ return server._police.frisk(socket.remoteAddress, 8);
+ }
+
+ // check for spam
+ let score = text.length / 83 / 4;
+ if (server._police.frisk(socket.remoteAddress, score)) {
+ return server.reply({
+ cmd: 'warn',
+ text: 'You are sending too much text. Wait a moment and try again.\nPress the up arrow key to restore your last message.'
+ }, socket);
+ }
+
+ let newPayload = {
+ cmd: 'info',
+ type: 'emote',
+ nick: socket.nick,
+ text: `@${socket.nick} ${text}`
+ };
+
+ // broadcast to channel peers
+ server.broadcast( newPayload, { channel: socket.channel});
+};
+
+// module hook functions
+exports.initHooks = (server) => {
+ server.registerHook('in', 'chat', this.emoteCheck, 30);
+};
+
+// hooks chat commands checking for /me
+exports.emoteCheck = (core, server, socket, payload) => {
+ if (typeof payload.text !== 'string') {
+ return false;
+ }
+
+ if (payload.text.startsWith('/me ')) {
+ let input = payload.text.split(' ');
+
+ // If there is no emote target parameter
+ if (input[1] === undefined) {
+ server.reply({
+ cmd: 'warn',
+ text: 'Refer to `/help emote` for instructions on how to use this command.'
+ }, socket);
+
+ return false;
+ }
+
+ input.splice(0, 1);
+ let actionText = input.join(' ');
+
+ this.run(core, server, socket, {
+ cmd: 'emote',
+ text: actionText
+ });
+
+ return false;
+ }
+
+ return payload;
+};
+
+// module meta
+exports.requiredData = ['text'];
+exports.info = {
+ name: 'emote',
+ description: 'Typical emote / action text',
+ usage: `
+ API: { cmd: 'emote', text: '<emote/action text>' }
+ Text: /me <emote/action text>`
+};
diff --git a/server/src/commands/core/help.js b/server/src/commands/core/help.js
index 60a7280..51f6d87 100644
--- a/server/src/commands/core/help.js
+++ b/server/src/commands/core/help.js
@@ -57,7 +57,7 @@ exports.run = async (core, server, socket, payload) => {
// module hook functions
exports.initHooks = (server) => {
- server.registerHook('in', 'chat', this.helpCheck);
+ server.registerHook('in', 'chat', this.helpCheck, 28);
};
// hooks chat commands checking for /whisper
@@ -67,7 +67,7 @@ exports.helpCheck = (core, server, socket, payload) => {
}
if (payload.text.startsWith('/help')) {
- let input = payload.text.substr(1, payload.text.length).split(' ', 2);
+ let input = payload.text.substr(1).split(' ', 2);
this.run(core, server, socket, {
cmd: input[0],
diff --git a/server/src/commands/core/morestats.js b/server/src/commands/core/morestats.js
index e8eed05..69740a9 100644
--- a/server/src/commands/core/morestats.js
+++ b/server/src/commands/core/morestats.js
@@ -58,7 +58,7 @@ exports.run = async (core, server, socket, data) => {
// module hook functions
exports.initHooks = (server) => {
- server.registerHook('in', 'chat', this.statsCheck);
+ server.registerHook('in', 'chat', this.statsCheck, 26);
};
// hooks chat commands checking for /stats
diff --git a/server/src/commands/core/whisper.js b/server/src/commands/core/whisper.js
index 672db93..c515d43 100644
--- a/server/src/commands/core/whisper.js
+++ b/server/src/commands/core/whisper.js
@@ -74,7 +74,7 @@ exports.run = async (core, server, socket, payload) => {
// module hook functions
exports.initHooks = (server) => {
- server.registerHook('in', 'chat', this.whisperCheck);
+ server.registerHook('in', 'chat', this.whisperCheck, 20);
};
// hooks chat commands checking for /whisper
diff --git a/server/src/commands/internal/legacylayer.js b/server/src/commands/internal/legacylayer.js
new file mode 100644
index 0000000..50f5fd7
--- /dev/null
+++ b/server/src/commands/internal/legacylayer.js
@@ -0,0 +1,20 @@
+/*
+ Description: This module adjusts outgoing data, making it compatible with legacy clients
+*/
+
+// module main
+exports.run = async (core, server, socket, data) => {
+ return;
+};
+
+// module hook functions
+exports.initHooks = (server) => {
+ // module is only a placeholder
+ //server.registerHook('out', '', this.);
+};
+
+// module meta
+exports.info = {
+ name: 'legacylayer',
+ description: 'This module adjusts outgoing data, making it compatible with legacy clients'
+};
diff --git a/server/src/commands/mod/dumb.js b/server/src/commands/mod/dumb.js
index ecb4e0d..d64c746 100644
--- a/server/src/commands/mod/dumb.js
+++ b/server/src/commands/mod/dumb.js
@@ -61,8 +61,8 @@ exports.run = async (core, server, socket, data) => {
// module hook functions
exports.initHooks = (server) => {
- server.registerHook('in', 'chat', this.chatCheck);
- server.registerHook('in', 'invite', this.inviteCheck);
+ server.registerHook('in', 'chat', this.chatCheck, 25);
+ server.registerHook('in', 'invite', this.inviteCheck, 25);
// TODO: add whisper hook, need hook priorities todo finished first
};
diff --git a/server/src/core/server.js b/server/src/core/server.js
index 08ddad7..4132b55 100644
--- a/server/src/core/server.js
+++ b/server/src/core/server.js
@@ -30,9 +30,7 @@ class server extends wsServer {
this._cmdBlacklist = {};
this._cmdKey = internalCmdKey;
- this._heartBeat = setInterval(((data) => {
- this.beatHeart();
- }).bind(this), pulseSpeed);
+ this._heartBeat = setInterval(() => this.beatHeart(), pulseSpeed);
this.on('error', (err) => {
this.handleError('server', err);
@@ -42,7 +40,7 @@ class server extends wsServer {
this.newConnection(socket, request);
});
- this._core.commands.initCommandHooks(this);
+ this.loadHooks();
}
/**
@@ -74,17 +72,17 @@ class server extends wsServer {
newConnection (socket, request) {
socket.remoteAddress = request.headers['x-forwarded-for'] || request.connection.remoteAddress;
- socket.on('message', ((data) => {
+ socket.on('message', (data) => {
this.handleData(socket, data);
- }).bind(this));
+ });
- socket.on('close', (() => {
+ socket.on('close', () => {
this.handleClose(socket);
- }).bind(this));
+ });
- socket.on('error', ((err) => {
+ socket.on('error', (err) => {
this.handleError(socket, err);
- }).bind(this));
+ });
}
/**
@@ -326,6 +324,39 @@ class server extends wsServer {
}
/**
+ * (Re)loads all command module hooks, then sorts their order of operation by
+ * priority, ascending (0 being highest priority)
+ *
+ */
+ loadHooks () {
+ // clear current hooks (if any)
+ this.clearHooks();
+ // notify each module to register their hooks (if any)
+ this._core.commands.initCommandHooks(this);
+
+ if (typeof this._hooks['in'] !== 'undefined') {
+ // start sorting, with incoming first
+ let curHooks = [ ...this._hooks['in'].keys() ];
+ let hookObj = [];
+ for (let i = 0, j = curHooks.length; i < j; i++) {
+ hookObj = this._hooks['in'].get(curHooks[i]);
+ hookObj.sort( (h1, h2) => h1.priority - h2.priority );
+ this._hooks['in'].set(hookObj);
+ }
+ }
+
+ if (typeof this._hooks['out'] !== 'undefined') {
+ // then outgoing
+ curHooks = [ ...this._hooks['out'].keys() ];
+ for (let i = 0, j = curHooks.length; i < j; i++) {
+ hookObj = this._hooks['out'].get(curHooks[i]);
+ hookObj.sort( (h1, h2) => h1.priority - h2.priority );
+ this._hooks['out'].set(hookObj);
+ }
+ }
+ }
+
+ /**
* Adds a target function to an array of hooks. Hooks are executed either before
* processing user input (`in`) or before sending data back to the client (`out`)
* and allows a module to modify each payload before moving forward
@@ -333,9 +364,13 @@ class server extends wsServer {
* @param {String} type The type of event, typically `in` (incoming) or `out` (outgoing)
* @param {String} command Should match the desired `cmd` attrib of the payload
* @param {Function} hookFunction Target function to execute, should accept `server`, `socket` and `payload` as parameters
+ * @param {Number} priority Execution priority, hooks with priority 1 will be executed before hooks with priority 200 for example
*/
- // TODO: add hook priority levels
- registerHook (type, command, hookFunction) {
+ registerHook (type, command, hookFunction, priority) {
+ if (typeof priority === 'undefined') {
+ priority = 25;
+ }
+
if (typeof this._hooks[type] === 'undefined') {
this._hooks[type] = new Map();
}
@@ -344,7 +379,10 @@ class server extends wsServer {
this._hooks[type].set(command, []);
}
- this._hooks[type].get(command).push(hookFunction);
+ this._hooks[type].get(command).push({
+ run: hookFunction,
+ priority: priority
+ });
}
/**
@@ -367,14 +405,14 @@ class server extends wsServer {
for (let i = 0, j = hooks.length; i < j; i++) {
try {
- payload = hooks[i](this._core, this, socket, payload);
+ payload = hooks[i].run(this._core, this, socket, payload);
} catch (err) {
let errText = `Hook failure, '${type}', '${command}': ${err}`;
console.log(errText);
return errText;
}
- // A payload may choose to return false to prevent all further processing
+ // A hook function may choose to return false to prevent all further processing
if (payload === false) {
return false;
}
diff --git a/server/src/managers/config.js b/server/src/managers/config.js
index 97961ce..7b49aa8 100644
--- a/server/src/managers/config.js
+++ b/server/src/managers/config.js
@@ -116,7 +116,6 @@ class ConfigManager {
conf = this.load();
// websocketport is the last core config question, wait until it's been populated
- // TODO: update this to work with new plugin support
while(conf === null || typeof conf.websocketPort === 'undefined') {
deSync.sleep(100);
}
@@ -138,8 +137,8 @@ class ConfigManager {
${chalk.gray('--------------(') + chalk.white(' HackChat Setup Wizard v1.0 ') + chalk.gray(')--------------')}
${chalk.magenta('°º¤ø,¸¸,ø¤º°`°º¤ø,¸,ø¤°º¤ø,¸¸,ø¤º°`°º¤ø,¸°º¤ø,¸¸,ø¤º°`°º¤ø')}
- For advanced setup, see the HackChat wiki at:
- ${chalk.green('https://github.com/')}
+ For advanced setup, see the documentation at:
+ ${chalk.green('https://github.com/hack-chat/main/tree/master/documentation')}
${chalk.white('Note:')} ${chalk.green('npm/yarn run config')} will re-run this utility.
generated by cgit v1.2.1 (git 2.18.0) at 2024-11-22 06:36:36 +0100