Compare commits

..

20 Commits

Author SHA1 Message Date
skylord123 aadd82d820 Set version to 0.9.2 2026-01-17 15:00:35 -07:00
skylord123 4e6fa50a67 Merge pull request #138 from Skylar-Tech/dev
Release v0.9.2
2026-01-17 14:57:45 -07:00
skylord123 c15893bab5 Merge pull request #135 from fprotopapa/master
Remove unused TimelineWindow in server-config. Closes #134
2026-01-17 14:54:45 -07:00
Fabbio Protopapa f0af0e92fe Remove unused TimelineWindow in server-config 2025-12-23 09:45:57 +01:00
skylord123 04de0b4eb3 Merge pull request #132 from Skylar-Tech/dev
Release v0.9.1
2025-02-09 22:41:41 -07:00
skylord123 8cb52112c1 Fix module compatibility with Node.js < 22 2025-02-09 22:36:52 -07:00
skylord123 54a9972bbc Merge pull request #121 from Skylar-Tech/dev
Release v0.9.0
2025-02-07 20:56:40 -07:00
skylord123 ad34f018ab Merge pull request #127 from koosc/allow-unknown
Add option for allowing unknown devices in rooms
2025-02-07 20:52:10 -07:00
skylord123 20345787d2 README.md change 2025-02-07 20:50:25 -07:00
skylord123 99c19923c6 Release v0.9.0 2025-02-07 20:27:36 -07:00
skylord123 093d59893e Fix roomId and eventId inputs not saving field type correctly for get-event node 2025-02-07 20:27:19 -07:00
skylord123 913f5dfcb9 - Upgrade to matrix-js-sdk 34.11.1 to fix CVE-2024-50336
- Remove request package (no longer needed)
2025-02-05 11:59:39 -07:00
skylord123 e0947dd3bc Merge pull request #128 from wuast94/master
Add m.notice to the receive node
2025-02-03 20:54:40 -07:00
skylord123 8287f3c08a Merge pull request #130 from LokiMidgard/patch-1
Support default plaintext in msg.format
2025-02-03 20:51:43 -07:00
Patrick Kranz 2a78524a90 use hasOwn instead of keys 2025-01-09 15:28:28 +01:00
Patrick Kranz d01838ac84 Fix error 2025-01-09 15:14:50 +01:00
Patrick Kranz 2059f8455d Update matrix-send-message.js 2025-01-09 15:12:09 +01:00
skylord123 0cb8ecf8aa Updated README with a link to a guide that explains how to register users via web browser 2025-01-04 12:58:08 -07:00
Marc 77f2c4be46 Add m.notice to the receive node 2025-01-01 05:17:12 +00:00
Chris Koos cf82daf5da Add option for allowing unknown devices
Allows workaround for sending messages until verification is implemented
2024-11-10 10:57:43 -08:00
12 changed files with 16547 additions and 5426 deletions
+5 -1
View File
@@ -5,6 +5,8 @@
Join our public Matrix room for help: [#node-red-contrib-matrix-chat:skylar.tech](https://app.element.io/#/room/#node-red-contrib-matrix-chat:skylar.tech) Join our public Matrix room for help: [#node-red-contrib-matrix-chat:skylar.tech](https://app.element.io/#/room/#node-red-contrib-matrix-chat:skylar.tech)
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B51BM7C)
### Features ### Features
Supported functionality in this package includes: Supported functionality in this package includes:
@@ -59,7 +61,9 @@ Interested in helping? Contributions to finalize E2EE support are welcome!
This module includes a node to register users using the Synapse secret registration endpoint. It returns both an `access_token` and a `device_id`, perfect for setting up the bot. This module includes a node to register users using the Synapse secret registration endpoint. It returns both an `access_token` and a `device_id`, perfect for setting up the bot.
[See how to register a user here](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme). [Guide on registering a user via the web browser](https://skylar.tech/matrix-chat-bot-module-for-node-red/)
[Guide on registering using shared secret registration](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme) (for server owners)
### Other Packages ### Other Packages
+16087 -5029
View File
File diff suppressed because it is too large Load Diff
+2 -3
View File
@@ -1,16 +1,15 @@
{ {
"name": "node-red-contrib-matrix-chat", "name": "node-red-contrib-matrix-chat",
"version": "0.8.0", "version": "0.9.2",
"description": "Matrix chat server client for Node-RED", "description": "Matrix chat server client for Node-RED",
"dependencies": { "dependencies": {
"@matrix-org/matrix-sdk-crypto-nodejs": "^0.2.0-beta.1",
"abort-controller": "^3.0.0", "abort-controller": "^3.0.0",
"fluent-ffmpeg": "^2.1.2", "fluent-ffmpeg": "^2.1.2",
"fs-extra": "^11.1.0", "fs-extra": "^11.1.0",
"got": "^12.0.2", "got": "^12.0.2",
"image-size": "^1.0.2", "image-size": "^1.0.2",
"isomorphic-webcrypto": "^2.3.8", "isomorphic-webcrypto": "^2.3.8",
"matrix-js-sdk": "^34.5.0", "matrix-js-sdk": "34.11.1",
"mime": "^3.0.0", "mime": "^3.0.0",
"node-fetch": "^3.3.0", "node-fetch": "^3.3.0",
"node-localstorage": "^2.2.1", "node-localstorage": "^2.2.1",
+7 -4
View File
@@ -1,3 +1,5 @@
const sdkPromise = import("matrix-js-sdk");
module.exports = function(RED) { module.exports = function(RED) {
function MatrixFetchRelations(n) { function MatrixFetchRelations(n) {
RED.nodes.createNode(this, n); RED.nodes.createNode(this, n);
@@ -41,22 +43,23 @@ module.exports = function(RED) {
}); });
node.on("input", async function(msg) { node.on("input", async function(msg) {
const {Direction} = await import("matrix-js-sdk");
if (!node.server || !node.server.matrixClient) { if (!node.server || !node.server.matrixClient) {
node.error("No matrix server selected", msg); node.error("No matrix server selected", msg);
return; return;
} }
try { try {
const sdk = await sdkPromise;
const Direction = sdk.Direction;
function evaluateNodePropertySafe(value, type, node, msg) { function evaluateNodePropertySafe(value, type, node, msg) {
try { try {
return RED.util.evaluateNodeProperty(value, type, node, msg); return RED.util.evaluateNodeProperty(value, type, node, msg);
} catch (e) { } catch (e) {
if (e instanceof TypeError) { if (e instanceof TypeError) {
return undefined; // Handle TypeError and return undefined return undefined;
} }
throw e; // Re-throw other errors to prevent masking issues throw e;
} }
} }
+8 -16
View File
@@ -19,14 +19,18 @@
}, },
oneditprepare: function() { oneditprepare: function() {
$("#node-input-roomId").typedInput({ $("#node-input-roomId").typedInput({
type: this.roomIdType,
types: ['msg','flow','global','str'], types: ['msg','flow','global','str'],
}).typedInput('value', this.roomIdValue); typeField: "#node-input-roomId"
});
$("#node-input-roomId").typedInput("type", this.roomIdType || "msg");
$("#node-input-roomId").typedInput("value", this.roomIdValue || "topic");
$("#node-input-eventId").typedInput({ $("#node-input-eventId").typedInput({
type: this.eventIdType,
types: ['msg','flow','global','str'], types: ['msg','flow','global','str'],
}).typedInput('value', this.eventIdValue); typeField: "#node-input-eventId"
});
$("#node-input-eventId").typedInput("type", this.eventIdType || "msg");
$("#node-input-eventId").typedInput("value", this.eventIdValue || "eventId");
}, },
oneditsave: function() { oneditsave: function() {
this.roomIdType = $("#node-input-roomId").typedInput('type'); this.roomIdType = $("#node-input-roomId").typedInput('type');
@@ -58,18 +62,6 @@
<label for="node-input-eventId"><i class="fa fa-file"></i> Event ID</label> <label for="node-input-eventId"><i class="fa fa-file"></i> Event ID</label>
<input type="text" id="node-input-eventId"> <input type="text" id="node-input-eventId">
</div> </div>
<script type="text/javascript">
$(function(){
$("#node-input-roomId").on("keyup", function() {
if($(this).val() && !$(this).val().startsWith("!")) {
$("#node-input-roomId-error").html(`Room IDs start with exclamation point "!"<br />Example: !OGEhHVWSdvArJzumhm:matrix.org`).show();
} else {
$("#node-input-roomId-error").hide();
}
}).trigger('keyup');
});
</script>
</script> </script>
<script type="text/html" data-help-name="matrix-get-event"> <script type="text/html" data-help-name="matrix-get-event">
+7 -6
View File
@@ -1,7 +1,8 @@
module.exports = function(RED) { const crypto = require('crypto');
function MatrixReceiveMessage(n) {
RED.nodes.createNode(this, n);
module.exports = function(RED) {
function MatrixMarkRead(n) {
RED.nodes.createNode(this, n);
let node = this; let node = this;
this.name = n.name; this.name = n.name;
this.server = RED.nodes.getNode(n.server); this.server = RED.nodes.getNode(n.server);
@@ -36,7 +37,7 @@ module.exports = function(RED) {
let value = property; let value = property;
if (type === "msg") { if (type === "msg") {
value = RED.util.getMessageProperty(msg, property); value = RED.util.getMessageProperty(msg, property);
} else if ((type === 'flow') || (type === 'global')) { } else if (type === 'flow' || type === 'global') {
try { try {
value = RED.util.evaluateNodeProperty(property, type, node, msg); value = RED.util.evaluateNodeProperty(property, type, node, msg);
} catch (e2) { } catch (e2) {
@@ -64,7 +65,7 @@ module.exports = function(RED) {
throw new Error(`Event ${eventId} not found in room ${roomId}.`); throw new Error(`Event ${eventId} not found in room ${roomId}.`);
} }
await node.server.matrixClient.sendReceipt(event, "m.read") await node.server.matrixClient.sendReceipt(event, "m.read");
node.send([msg, null]); node.send([msg, null]);
} catch (e) { } catch (e) {
msg.error = `Room pagination error: ${e}`; msg.error = `Room pagination error: ${e}`;
@@ -77,5 +78,5 @@ module.exports = function(RED) {
node.server.deregister(node); node.server.deregister(node);
}); });
} }
RED.nodes.registerType("matrix-mark-read", MatrixReceiveMessage); RED.nodes.registerType("matrix-mark-read", MatrixMarkRead);
} }
+20 -21
View File
@@ -1,5 +1,8 @@
const sdkPromise = import("matrix-js-sdk");
const crypto = require('crypto');
module.exports = function(RED) { module.exports = function(RED) {
function MatrixReceiveMessage(n) { function MatrixPaginateRoom(n) {
RED.nodes.createNode(this, n); RED.nodes.createNode(this, n);
let node = this; let node = this;
@@ -32,9 +35,6 @@ module.exports = function(RED) {
}); });
node.on("input", async function (msg) { node.on("input", async function (msg) {
const {TimelineWindow, RelationType, Filter} = await import("matrix-js-sdk");
const crypto = await import('crypto');
if (!node.server || !node.server.matrixClient) { if (!node.server || !node.server.matrixClient) {
node.error("No matrix server selected", msg); node.error("No matrix server selected", msg);
return; return;
@@ -44,7 +44,7 @@ module.exports = function(RED) {
let value = property; let value = property;
if (type === "msg") { if (type === "msg") {
value = RED.util.getMessageProperty(msg, property); value = RED.util.getMessageProperty(msg, property);
} else if ((type === 'flow') || (type === 'global')) { } else if (type === 'flow' || type === 'global') {
try { try {
value = RED.util.evaluateNodeProperty(property, type, node, msg); value = RED.util.evaluateNodeProperty(property, type, node, msg);
} catch(e2) { } catch(e2) {
@@ -62,17 +62,15 @@ module.exports = function(RED) {
if (type === 'global' || type === 'flow') { if (type === 'global' || type === 'flow') {
var contextKey = RED.util.parseContextStore(property); var contextKey = RED.util.parseContextStore(property);
if (/\[msg/.test(contextKey.key)) { if (/\[msg/.test(contextKey.key)) {
// The key has a nest msg. reference to evaluate first // The key has a nested msg. reference that must be evaluated first
contextKey.key = RED.util.normalisePropertyExpression(contextKey.key, msg, true) contextKey.key = RED.util.normalisePropertyExpression(contextKey.key, msg, true);
} }
var target = node.context()[type]; var target = node.context()[type];
var callback = err => { target.set(contextKey.key, value, contextKey.store, err => {
if (err) { if (err) {
node.error(err, msg); node.error(err, msg);
getterErrors[rule.p] = err.message;
} }
} });
target.set(contextKey.key, value, contextKey.store, callback);
} else if (type === 'msg') { } else if (type === 'msg') {
if (!RED.util.setMessageProperty(msg, property, value)) { if (!RED.util.setMessageProperty(msg, property, value)) {
node.warn(RED._("change.errors.no-override", { property: property })); node.warn(RED._("change.errors.no-override", { property: property }));
@@ -81,6 +79,12 @@ module.exports = function(RED) {
} }
try { try {
// Dynamically load the SDK
const sdk = await sdkPromise;
const TimelineWindow = sdk.TimelineWindow;
const RelationType = sdk.RelationType;
// (Filter was imported originally but is not used, so we omit it.)
let roomId = getToValue(msg, node.roomType, node.roomValue), let roomId = getToValue(msg, node.roomType, node.roomValue),
paginateBackwards = getToValue(msg, node.paginateBackwardsType, node.paginateBackwardsValue), paginateBackwards = getToValue(msg, node.paginateBackwardsType, node.paginateBackwardsValue),
pageSize = getToValue(msg, node.pageSizeType, node.pageSizeValue), pageSize = getToValue(msg, node.pageSizeType, node.pageSizeValue),
@@ -102,24 +106,19 @@ module.exports = function(RED) {
moreMessages = true; moreMessages = true;
if (!timelineWindow) { if (!timelineWindow) {
let timelineSet = room.getUnfilteredTimelineSet(); let timelineSet = room.getUnfilteredTimelineSet();
// node.debug(JSON.stringify(timelineSet.getFilter())); // MatrixClient's option initialSyncLimit gets set to the filter we are using,
// so override that value with our pageSize.
// MatrixClient's option initialSyncLimit gets set to the filter we are using
// so override that value with our pageSize
timelineWindow = new TimelineWindow(node.server.matrixClient, timelineSet); timelineWindow = new TimelineWindow(node.server.matrixClient, timelineSet);
await timelineWindow.load(msg.eventId || null, pageSize); await timelineWindow.load(msg.eventId || null, pageSize);
node.timelineWindows.set(pageKey, timelineWindow); node.timelineWindows.set(pageKey, timelineWindow);
} else { } else {
moreMessages = await timelineWindow.paginate(paginateBackwards ? 'b' : 'f', pageSize); // b for backwards f for forwards moreMessages = await timelineWindow.paginate(paginateBackwards ? 'b' : 'f', pageSize); // 'b' for backwards, 'f' for forwards
if (moreMessages) { if (moreMessages) {
await timelineWindow.unpaginate(pageSize, !paginateBackwards); await timelineWindow.unpaginate(pageSize, !paginateBackwards);
} }
} }
// MatrixEvent objects are massive so this throws an encode error for the string being too long // To avoid errors converting massive MatrixEvent objects to JSON, we omit them.
// since msg objects convert to JSON
// msg.payload = moreMessages ? timelineWindow.getEvents() : false;
msg.payload = false; msg.payload = false;
msg.start = timelineWindow.getTimelineIndex('b')?.index; msg.start = timelineWindow.getTimelineIndex('b')?.index;
msg.end = timelineWindow.getTimelineIndex('f')?.index; msg.end = timelineWindow.getTimelineIndex('f')?.index;
@@ -153,5 +152,5 @@ module.exports = function(RED) {
node.server.deregister(node); node.server.deregister(node);
}); });
} }
RED.nodes.registerType("matrix-paginate-room", MatrixReceiveMessage); RED.nodes.registerType("matrix-paginate-room", MatrixPaginateRoom);
} }
+11
View File
@@ -13,6 +13,7 @@
acceptOwnEvents: {"value": false}, acceptOwnEvents: {"value": false},
acceptText: {"value": true}, acceptText: {"value": true},
acceptEmotes: {"value": true}, acceptEmotes: {"value": true},
acceptNotices: {"value": true},
acceptStickers: {"value": true}, acceptStickers: {"value": true},
acceptReactions: {"value": true}, acceptReactions: {"value": true},
acceptFiles: {"value": true}, acceptFiles: {"value": true},
@@ -66,6 +67,16 @@
Accept text <code style="text-transform: none;">m.text</code> Accept text <code style="text-transform: none;">m.text</code>
</label> </label>
</div> </div>
<div class="form-row" style="margin-bottom:0;">
<input
type="checkbox"
id="node-input-acceptNotices"
style="width: auto; margin-left: 125px; vertical-align: top"
/>
<label for="node-input-acceptNotices" style="width: auto">
Accept notices <code style="text-transform: none;">m.notice</code>
</label>
</div>
<div class="form-row" style="margin-bottom:0;"> <div class="form-row" style="margin-bottom:0;">
<input <input
type="checkbox" type="checkbox"
+5
View File
@@ -9,6 +9,7 @@ module.exports = function(RED) {
this.acceptOwnEvents = n.acceptOwnEvents; this.acceptOwnEvents = n.acceptOwnEvents;
this.acceptText = n.acceptText; this.acceptText = n.acceptText;
this.acceptEmotes = n.acceptEmotes; this.acceptEmotes = n.acceptEmotes;
this.acceptNotices = n.acceptNotices;
this.acceptStickers = n.acceptStickers; this.acceptStickers = n.acceptStickers;
this.acceptReactions = n.acceptReactions; this.acceptReactions = n.acceptReactions;
this.acceptFiles = n.acceptFiles; this.acceptFiles = n.acceptFiles;
@@ -68,6 +69,10 @@ module.exports = function(RED) {
if (!node.acceptEmotes) return; if (!node.acceptEmotes) return;
break; break;
case 'm.notice':
if (!node.acceptNotices) return;
break;
case 'm.text': case 'm.text':
if (!node.acceptText) return; if (!node.acceptText) return;
break; break;
+16 -9
View File
@@ -1,7 +1,8 @@
const sdkPromise = import("matrix-js-sdk");
module.exports = function(RED) { module.exports = function(RED) {
function MatrixSendImage(n) { function MatrixSendImage(n) {
RED.nodes.createNode(this, n); RED.nodes.createNode(this, n);
var node = this; var node = this;
this.name = n.name; this.name = n.name;
@@ -66,13 +67,17 @@ module.exports = function(RED) {
node.status({ fill: "green", shape: "ring", text: "connected" }); node.status({ fill: "green", shape: "ring", text: "connected" });
}); });
// Make the input handler async so we can await the dynamic import.
node.on("input", async function (msg) { node.on("input", async function (msg) {
const {RelationType} = await import("matrix-js-sdk"); // Await the SDK import and get the RelationType constant.
const sdk = await sdkPromise;
const RelationType = sdk.RelationType;
function getToValue(msg, type, property) { function getToValue(msg, type, property) {
let value = property; let value = property;
if (type === "msg") { if (type === "msg") {
value = RED.util.getMessageProperty(msg, property); value = RED.util.getMessageProperty(msg, property);
} else if ((type === 'flow') || (type === 'global')) { } else if (type === 'flow' || type === 'global') {
try { try {
value = RED.util.evaluateNodeProperty(property, type, node, msg); value = RED.util.evaluateNodeProperty(property, type, node, msg);
} catch(e2) { } catch(e2) {
@@ -119,14 +124,14 @@ module.exports = function(RED) {
} else { } else {
if (msgType === 'msg.type') { if (msgType === 'msg.type') {
if (!msg.type) { if (!msg.type) {
node.error("msg.type type is set to be passed in via msg.type but was not defined", msg); node.error("msg.type is set to be passed in via msg.type but was not defined", msg);
return; return;
} }
msgType = msg.type; msgType = msg.type;
} }
if (msgFormat === 'msg.format') { if (msgFormat === 'msg.format') {
if(!msg.format) { if (!Object.hasOwn(msg, 'format')) {
node.error("Message format is set to be passed in via msg.format but was not defined", msg); node.error("Message format is set to be passed in via msg.format but was not defined", msg);
return; return;
} }
@@ -164,9 +169,11 @@ module.exports = function(RED) {
}; };
content['body'] = ' * ' + content['body']; content['body'] = ' * ' + content['body'];
} else if (threadReply) { } else if (threadReply) {
// if incoming message is a reply to a thread we fetch the thread parent from the m.relates_to property // If incoming message is a reply to a thread we fetch the thread parent from m.relates_to,
// otherwise fallback to msg.eventId // otherwise fallback to msg.eventId.
let threadParent = (msg?.content?.['m.relates_to']?.rel_type === RelationType.Thread ? msg?.content?.['m.relates_to']?.event_id : null) || msg.eventId; let threadParent = (msg?.content?.['m.relates_to']?.rel_type === RelationType.Thread
? msg?.content?.['m.relates_to']?.event_id
: null) || msg.eventId;
if (threadParent) { if (threadParent) {
content["m.relates_to"] = { content["m.relates_to"] = {
"rel_type": RelationType.Thread, "rel_type": RelationType.Thread,
@@ -201,4 +208,4 @@ module.exports = function(RED) {
}); });
} }
RED.nodes.registerType("matrix-send-message", MatrixSendImage); RED.nodes.registerType("matrix-send-message", MatrixSendImage);
} };
+16 -1
View File
@@ -36,7 +36,8 @@
name: { value: null }, name: { value: null },
autoAcceptRoomInvites: { value: true }, autoAcceptRoomInvites: { value: true },
enableE2ee: { type: "checkbox", value: true }, enableE2ee: { type: "checkbox", value: true },
global: { type: "checkbox", value: true } global: { type: "checkbox", value: true },
allowUnknownDevices: { type: "checkbox", value: false }
}, },
icon: "matrix.png", icon: "matrix.png",
label: function() { label: function() {
@@ -130,6 +131,20 @@
<code style="white-space: normal;">let client = global.get("matrixClient['@bot:example.com']");</code> <code style="white-space: normal;">let client = global.get("matrixClient['@bot:example.com']");</code>
</div> </div>
</div> </div>
<div class="form-row">
<input
type="checkbox"
id="node-config-input-allowUnknownDevices"
style="width: auto; margin-left: 125px; vertical-align: top"
/>
<label for="node-config-input-allowUnknownDevices" style="width: auto">
Allow unverified devices in rooms
</label>
<div class="form-tips" style="margin-bottom: 12px;">
Allow sending messages to a room with unknown devices which have not been verified.
</div>
</div>
<script type="text/javascript"> <script type="text/javascript">
$("#matrix-login-btn").on("click", function() { $("#matrix-login-btn").on("click", function() {
function prettyPrintJson(json) { function prettyPrintJson(json) {
+96 -69
View File
@@ -1,36 +1,52 @@
global.Olm = require('olm'); global.Olm = require('olm');
const fs = require("fs-extra"); const fs = require("fs-extra");
let RelationType, sdk, LocalStorageCryptoStore, RoomEvent, RoomMemberEvent, HttpApiEvent, ClientEvent, MemoryStore;
(async () => {
const mod = await import("matrix-js-sdk");
RelationType = mod.RelationType;
// matrix-js-sdk doesn't export a default the top-level export is the same object:
sdk = mod;
RoomEvent = mod.RoomEvent;
RoomMemberEvent = mod.RoomMemberEvent;
HttpApiEvent = mod.HttpApiEvent;
ClientEvent = mod.ClientEvent;
MemoryStore = mod.MemoryStore;
// For LocalStorageCryptoStore, specify the file extension for Node 20+:
const cmod = await import("matrix-js-sdk/lib/crypto/store/localStorage-crypto-store.js");
LocalStorageCryptoStore = cmod.LocalStorageCryptoStore;
})();
const { resolve } = require('path'); const { resolve } = require('path');
const { LocalStorage } = require('node-localstorage'); const { LocalStorage } = require('node-localstorage');
globalThis.crypto = require('crypto');
require("abort-controller/polyfill"); // polyfill abort-controller if we don't have it require("abort-controller/polyfill"); // polyfill abort-controller if we don't have it
if (!globalThis.fetch) { if (!globalThis.fetch) {
// polyfill fetch if we don't have it // polyfill fetch if we don't have it
if (!globalThis.fetch) { if (!globalThis.fetch) {
import('node-fetch').then(({ default: fetch, Headers, Request, Response }) => { import('node-fetch').then(({ default: fetch, Headers, Request, Response }) => {
Object.assign(globalThis, { fetch, Headers, Request, Response }) Object.assign(globalThis, { fetch, Headers, Request, Response });
}) });
} }
} }
module.exports = function(RED) { module.exports = function(RED) {
// Prepare dynamic imports
const sdkPromise = import("matrix-js-sdk");
const LocalStorageCryptoStorePromise = import('matrix-js-sdk/lib/crypto/store/localStorage-crypto-store.js');
const loggerPromise = import('matrix-js-sdk/lib/logger.js');
// disable logging if set to "off" // disable logging if set to "off"
// let loggingSettings = RED.settings.get('logging'); let loggingSettings = RED.settings.get('logging');
// if( if (
// typeof loggingSettings.console !== 'undefined' && typeof loggingSettings.console !== 'undefined' &&
// typeof loggingSettings.console.level !== 'undefined' && typeof loggingSettings.console.level !== 'undefined' &&
// ['info','debug','trace'].indexOf(loggingSettings.console.level.toLowerCase()) >= 0 ['info','debug','trace'].indexOf(loggingSettings.console.level.toLowerCase()) >= 0
// ) { ) {
// loggerPromise.then(({ logger }) => { import('matrix-js-sdk/lib/logger.js')
// logger.disableAll(); .then(({ logger }) => {
// }); logger.disableAll();
// } })
.catch((err) => {
console.error("Error loading logger module:", err);
});
}
function MatrixFolderNameFromUserId(name) { function MatrixFolderNameFromUserId(name) {
return name.replace(/[^a-z0-9]/gi, '_').toLowerCase(); return name.replace(/[^a-z0-9]/gi, '_').toLowerCase();
@@ -58,10 +74,11 @@ module.exports = function(RED) {
this.autoAcceptRoomInvites = n.autoAcceptRoomInvites; this.autoAcceptRoomInvites = n.autoAcceptRoomInvites;
this.e2ee = n.enableE2ee || false; this.e2ee = n.enableE2ee || false;
this.globalAccess = n.global; this.globalAccess = n.global;
this.allowUnknownDevices = n.allowUnknownDevices || false;
this.initializedAt = new Date(); this.initializedAt = new Date();
node.initialSyncLimit = 25; node.initialSyncLimit = 25;
// Keep track of all consumers of this node to be able to catch errors // Keep track of all consumers of this node to catch errors
node.register = function(consumerNode) { node.register = function(consumerNode) {
node.users[consumerNode.id] = consumerNode; node.users[consumerNode.id] = consumerNode;
}; };
@@ -85,7 +102,7 @@ module.exports = function(RED) {
} else if(!this.url) { } else if(!this.url) {
node.error("Matrix connection failed: missing server URL in configuration.", {}); node.error("Matrix connection failed: missing server URL in configuration.", {});
} else { } else {
node.setConnected = function(connected, cb) { node.setConnected = async function(connected, cb) {
if (node.connected !== connected) { if (node.connected !== connected) {
node.connected = connected; node.connected = connected;
if(typeof cb === 'function') { if(typeof cb === 'function') {
@@ -101,7 +118,7 @@ module.exports = function(RED) {
device_id = this.matrixClient.getDeviceId(); device_id = this.matrixClient.getDeviceId();
if(!device_id && node.enableE2ee) { if(!device_id && node.enableE2ee) {
node.error("Failed to auto detect deviceId for this auth token. You will need to manually specify one. You may need to login to create a new deviceId.", {}) node.error("Failed to auto detect deviceId for this auth token. You will need to manually specify one. You may need to login to create a new deviceId.", {});
} else { } else {
if(!stored_device_id || stored_device_id !== device_id) { if(!stored_device_id || stored_device_id !== device_id) {
node.log(`Saving Device ID (old:${stored_device_id} new:${device_id})`); node.log(`Saving Device ID (old:${stored_device_id} new:${device_id})`);
@@ -118,7 +135,7 @@ module.exports = function(RED) {
node.matrixClient.setDeviceDetails(device_id, { node.matrixClient.setDeviceDetails(device_id, {
display_name: node.deviceLabel display_name: node.deviceLabel
}).then( }).then(
function(response) {}, function() {},
function(error) { function(error) {
node.error("Failed to set device label: " + error, {}); node.error("Failed to set device label: " + error, {});
} }
@@ -147,22 +164,15 @@ module.exports = function(RED) {
fs.ensureDirSync(storageDir); // create storage directory if it doesn't exist fs.ensureDirSync(storageDir); // create storage directory if it doesn't exist
upgradeDirectoryIfNecessary(node, storageDir); upgradeDirectoryIfNecessary(node, storageDir);
// Wait for the dynamic imports to resolve
Promise.all([sdkPromise, LocalStorageCryptoStorePromise]).then(([sdkModule, LocalStorageCryptoStoreModule]) => {
const sdk = sdkModule.default || sdkModule;
const { LocalStorageCryptoStore } = LocalStorageCryptoStoreModule;
node.matrixClient = sdk.createClient({ node.matrixClient = sdk.createClient({
baseUrl: this.url, baseUrl: this.url,
accessToken: this.credentials.accessToken, accessToken: this.credentials.accessToken,
cryptoStore: new LocalStorageCryptoStore(localStorage), cryptoStore: new LocalStorageCryptoStore(localStorage),
store: new sdk.MemoryStore({ store: new MemoryStore({
localStorage: localStorage, localStorage: localStorage,
}), }),
userId: this.userId, userId: this.userId,
deviceId: (this.deviceId || getStoredDeviceId(localStorage)) || undefined deviceId: (this.deviceId || getStoredDeviceId(localStorage)) || undefined
// verificationMethods: ["m.sas.v1"]
}); });
node.debug(`hasLazyLoadMembersEnabled=${node.matrixClient.hasLazyLoadMembersEnabled()}`); node.debug(`hasLazyLoadMembersEnabled=${node.matrixClient.hasLazyLoadMembersEnabled()}`);
@@ -199,20 +209,18 @@ module.exports = function(RED) {
return node.connected; return node.connected;
}; };
const { RelationType, RoomEvent, RoomMemberEvent, HttpApiEvent, ClientEvent } = sdk;
node.matrixClient.on(RoomEvent.Timeline, async function(event, room, toStartOfTimeline, removed, data) { node.matrixClient.on(RoomEvent.Timeline, async function(event, room, toStartOfTimeline, removed, data) {
if (toStartOfTimeline) { if (toStartOfTimeline) {
node.log("Ignoring" + (event.isEncrypted() ? ' encrypted' : '') +" timeline event [" + (event.getContent()['msgtype'] || event.getType()) + "]: (" + room.name + ") " + event.getId() + " for reason: paginated result"); node.log("Ignoring" + (event.isEncrypted() ? ' encrypted' : '') +" timeline event [" + (event.getContent()['msgtype'] || event.getType()) + "]: (" + room.name + ") " + event.getId() + " for reason: paginated result");
return; // ignore paginated results return;
} }
if (!data || !data.liveEvent) { if (!data || !data.liveEvent) {
node.log("Ignoring" + (event.isEncrypted() ? ' encrypted' : '') +" timeline event [" + (event.getContent()['msgtype'] || event.getType()) + "]: (" + room.name + ") " + event.getId() + " for reason: old message"); node.log("Ignoring" + (event.isEncrypted() ? ' encrypted' : '') +" timeline event [" + (event.getContent()['msgtype'] || event.getType()) + "]: (" + room.name + ") " + event.getId() + " for reason: old message");
return; // ignore old message (we only want live events) return;
} }
if(node.initializedAt > event.getDate()) { if(node.initializedAt > event.getDate()) {
node.log("Ignoring" + (event.isEncrypted() ? ' encrypted' : '') +" timeline event [" + (event.getContent()['msgtype'] || event.getType()) + "]: (" + room.name + ") " + event.getId() + " for reason: old message before init"); node.log("Ignoring" + (event.isEncrypted() ? ' encrypted' : '') +" timeline event [" + (event.getContent()['msgtype'] || event.getType()) + "]: (" + room.name + ") " + event.getId() + " for reason: old message before init");
return; // skip events that occurred before our client initialized return;
} }
try { try {
@@ -254,18 +262,42 @@ module.exports = function(RED) {
}; };
// remove keys from user property that start with an underscore // remove keys from user property that start with an underscore
if (msg.user) {
Object.keys(msg.user).forEach(function (key) { Object.keys(msg.user).forEach(function (key) {
if (/^_/.test(key)) { if (/^_/.test(key)) {
delete msg.user[key]; delete msg.user[key];
} }
}); });
}
node.log(`Received ${msg.encrypted ? 'encrypted ' : ''}timeline event [${msg.type}]: (${room.name}) ${event.getSender()} :: ${msg.content.body} ${toStartOfTimeline ? ' [PAGINATED]' : ''}`); node.log(`Received ${msg.encrypted ? 'encrypted ' : ''}timeline event [${msg.type}]: (${room.name}) ${event.getSender()} :: ${msg.content.body} ${toStartOfTimeline ? ' [PAGINATED]' : ''}`);
node.emit("Room.timeline", event, room, toStartOfTimeline, removed, data, msg); node.emit("Room.timeline", event, room, toStartOfTimeline, removed, data, msg);
}); });
/**
* Fires when we want to suggest to the user that they restore their megolm keys
* from backup or by cross-signing the device.
*
* @event module:client~MatrixClient#"crypto.suggestKeyRestore"
*/
// node.matrixClient.on("crypto.suggestKeyRestore", function(){
//
// });
// node.matrixClient.on("RoomMember.typing", async function(event, member) {
// let isTyping = member.typing;
// let roomId = member.roomId;
// });
// node.matrixClient.on("RoomMember.powerLevel", async function(event, member) {
// let newPowerLevel = member.powerLevel;
// let newNormPowerLevel = member.powerLevelNorm;
// let roomId = member.roomId;
// });
// node.matrixClient.on("RoomMember.name", async function(event, member) {
// let newName = member.name;
// let roomId = member.roomId;
// });
// handle auto-joining rooms // handle auto-joining rooms
node.matrixClient.on(RoomMemberEvent.Membership, async function(event, member) { node.matrixClient.on(RoomMemberEvent.Membership, async function(event, member) {
@@ -363,8 +395,18 @@ module.exports = function(RED) {
} }
}); });
node.matrixClient.on(HttpApiEvent.SessionLoggedOut, async function(errorObj){ node.matrixClient.on(HttpApiEvent.SessionLoggedOut, async function(errorObj){
// Example if user auth token incorrect:
// {
// errcode: 'M_UNKNOWN_TOKEN',
// data: {
// errcode: 'M_UNKNOWN_TOKEN',
// error: 'Invalid macaroon passed.',
// soft_logout: false
// },
// httpStatus: 401
// }
node.error("Authentication failure: " + errorObj, {}); node.error("Authentication failure: " + errorObj, {});
stopClient(); stopClient();
}); });
@@ -372,21 +414,16 @@ module.exports = function(RED) {
async function run() { async function run() {
try { try {
if(node.e2ee){ if(node.e2ee){
node.matrixClient.on("crypto.legacyCryptoStoreMigrationProgress", function(progress, total){ node.log("Initializing crypto...");
node.log(`Migrating from legacy crypto to rust crypto. ${progress}/${total}`); await node.matrixClient.initCrypto();
});
await node.matrixClient.initRustCrypto({
useIndexedDB: false
});
console.log(`CRYPTO VERSION: ${node.matrixClient.getCrypto()?.getVersion()}`);
node.matrixClient.getCrypto().globalBlacklistUnverifiedDevices = false; // prevent errors from unverified devices node.matrixClient.getCrypto().globalBlacklistUnverifiedDevices = false; // prevent errors from unverified devices
node.matrixClient.getCrypto().globalErrorOnUnknownDevices = !node.allowUnknownDevices;
} }
node.log("Connecting to Matrix server..."); node.log("Connecting to Matrix server...");
await node.matrixClient.startClient({ await node.matrixClient.startClient({
initialSyncLimit: node.initialSyncLimit initialSyncLimit: node.initialSyncLimit
}); });
} catch(error) { } catch(error) {
node.error(error);
node.error(error, {}); node.error(error, {});
} }
} }
@@ -430,11 +467,8 @@ module.exports = function(RED) {
node.error("Auth check failed: " + err, {}); node.error("Auth check failed: " + err, {});
} }
} }
) );
})(); })();
}).catch((error) => {
node.error("Failed to load Matrix SDK modules: " + error, {});
});
} }
} }
@@ -458,21 +492,19 @@ module.exports = function(RED) {
deviceId = req.body.deviceId || undefined, deviceId = req.body.deviceId || undefined,
displayName = req.body.displayName || undefined; displayName = req.body.displayName || undefined;
sdkPromise.then((sdkModule) => { (async () => {
const sdk = sdkModule.default || sdk; const mod = await import("matrix-js-sdk");
const matrixClient = mod.createClient({
const matrixClient = sdk.createClient({
baseUrl: baseUrl, baseUrl: baseUrl,
deviceId: deviceId, deviceId: deviceId,
timelineSupport: true, timelineSupport: true,
localTimeoutMs: '30000', localTimeoutMs: '30000'
request
}); });
matrixClient.timelineSupport = true; matrixClient.timelineSupport = true;
matrixClient.login( matrixClient.login('m.login.password', {
'm.login.password', {
identifier: { identifier: {
type: 'm.id.user', type: 'm.id.user',
user: userId, user: userId,
@@ -496,13 +528,11 @@ module.exports = function(RED) {
}); });
} }
); );
}).catch((error) => { })().catch(err => {
res.json({ res.json({ result: 'error', message: err.toString() });
'result': 'error',
'message': "Failed to load Matrix SDK: " + error
});
});
}); });
}
);
function upgradeDirectoryIfNecessary(node, storageDir) { function upgradeDirectoryIfNecessary(node, storageDir) {
let oldStorageDir = './matrix-local-storage', let oldStorageDir = './matrix-local-storage',
@@ -543,9 +573,6 @@ module.exports = function(RED) {
} }
} }
/**
* If a device ID is stored we will use that for the client
*/
function getStoredDeviceId(localStorage) { function getStoredDeviceId(localStorage) {
let deviceId = localStorage.getItem('my_device_id'); let deviceId = localStorage.getItem('my_device_id');
if(deviceId === "null" || !deviceId) { if(deviceId === "null" || !deviceId) {
@@ -561,4 +588,4 @@ module.exports = function(RED) {
localStorage.setItem('my_device_id', deviceId); localStorage.setItem('my_device_id', deviceId);
return true; return true;
} }
} };