Mirrors/whitebophir
2
0
Fork 0
mirror of https://github.com/lovasoa/whitebophir synced 2024-11-10 14:34:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

add option to block tools (#66)

Browse source 
* add option to block tools

* use tool name instead of computing an id

Co-authored-by: Ophir LOJKINE <ophir.lojkine@auto-grid.com>

* require comma separated list as input of blocked tools environment variable

Co-authored-by: Ophir LOJKINE <ophir.lojkine@auto-grid.com>

* Log attempts to use blocked tools

Co-authored-by: Ophir LOJKINE <ophir.lojkine@auto-grid.com>

* fix syntax

* require tool names to not have a comma in them

* Update server/configuration.js

Co-authored-by: Ophir LOJKINE <pere.jobs@gmail.com>
This commit is contained in:
finnboeger 2020-05-08 12:19:52 +02:00 committed by GitHub
parent e6811518dc
commit edace1c293
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 21 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
client-data/js/board.js
View file

@ -156,10 +156,17 @@ Tools.HTML = {
Tools.list = {}; // An array of all known tools. {"toolName" : {toolObject}} Tools.list = {}; // An array of all known tools. {"toolName" : {toolObject}}
Tools.isBlocked = function toolIsBanned(tool) {
if (tool.name.includes(",")) throw new Error("Tool Names must not contain a comma");
return Tools.server_config.BLOCKED_TOOLS.includes(tool.name);
};
/** /**
* Register a new tool, without touching the User Interface * Register a new tool, without touching the User Interface
*/ */
Tools.register = function registerTool(newTool) { Tools.register = function registerTool(newTool) {
if (Tools.isBlocked(newTool)) return;
if (newTool.name in Tools.list) { if (newTool.name in Tools.list) {
console.log("Tools.add: The tool '" + newTool.name + "' is already" + console.log("Tools.add: The tool '" + newTool.name + "' is already" +
"in the list. Updating it..."); "in the list. Updating it...");
@ -184,12 +191,14 @@ Tools.register = function registerTool(newTool) {
newTool.draw(msg, false); newTool.draw(msg, false);
} }
} }
} };
/** /**
* Add a new tool to the user interface * Add a new tool to the user interface
*/ */
Tools.add = function (newTool) { Tools.add = function (newTool) {
if (Tools.isBlocked(newTool)) return;
Tools.register(newTool); Tools.register(newTool);
if (newTool.stylesheet) { if (newTool.stylesheet) {
@ -246,7 +255,7 @@ Tools.addToolListeners = function addToolListeners(tool) {
var target = listener.target || Tools.board; var target = listener.target || Tools.board;
target.addEventListener(event, listener, { 'passive': false }); target.addEventListener(event, listener, { 'passive': false });
} }
} };
Tools.removeToolListeners = function removeToolListeners(tool) { Tools.removeToolListeners = function removeToolListeners(tool) {
for (var event in tool.compiledListeners) { for (var event in tool.compiledListeners) {
@ -256,7 +265,7 @@ Tools.removeToolListeners = function removeToolListeners(tool) {
// also attempt to remove with capture = true in IE // also attempt to remove with capture = true in IE
if (Tools.isIE) target.removeEventListener(event, listener, true); if (Tools.isIE) target.removeEventListener(event, listener, true);
} }
} };
Tools.send = function (data, toolName) { Tools.send = function (data, toolName) {
toolName = toolName || Tools.curTool.name; toolName = toolName || Tools.curTool.name;

1
server/client_configuration.js
View file

@ -5,4 +5,5 @@ module.exports = {
"MAX_BOARD_SIZE": config.MAX_BOARD_SIZE, "MAX_BOARD_SIZE": config.MAX_BOARD_SIZE,
"MAX_EMIT_COUNT": config.MAX_EMIT_COUNT, "MAX_EMIT_COUNT": config.MAX_EMIT_COUNT,
"MAX_EMIT_COUNT_PERIOD": config.MAX_EMIT_COUNT_PERIOD, "MAX_EMIT_COUNT_PERIOD": config.MAX_EMIT_COUNT_PERIOD,
"BLOCKED_TOOLS": config.BLOCKED_TOOLS,
}; };

5
server/configuration.js
View file

@ -31,4 +31,7 @@ module.exports = {
/** Duration after which the emit count is reset in miliseconds */ /** Duration after which the emit count is reset in miliseconds */
MAX_EMIT_COUNT_PERIOD: parseInt(process.env['WBO_MAX_EMIT_COUNT_PERIOD']) || 4096, MAX_EMIT_COUNT_PERIOD: parseInt(process.env['WBO_MAX_EMIT_COUNT_PERIOD']) || 4096,
};
/** Blocked Tools. A comma-separated list of tools that should not appear on boards. */
BLOCKED_TOOLS: (process.env['WBO_BLOCKED_TOOLS'] || "").split(','),
};

4
server/sockets.js
View file

@ -96,6 +96,10 @@ function socketConnection(socket) {
return; return;
} }
if (!message.data.tool || config.BLOCKED_TOOLS.includes(message.data.tool)) {
log('BLOCKED MESSAGE', message.data);
return;
}
// Save the message in the board // Save the message in the board
handleMessage(boardName, data, socket); handleMessage(boardName, data, socket);