mirror of
https://github.com/Skylar-Tech/node-red-contrib-matrix-chat.git
synced 2026-05-18 21:23:14 -06:00
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 skylord123
|
db14bd96a7 | ||
|
skylord123
|
512b7320d5 | ||
|
skylord123
|
487241e097 | ||
|
skylord123
|
3b161f1ad9 |
+205
-210
@@ -22,59 +22,47 @@ To try out any of the examples:
|
||||
|
||||
## Index
|
||||
|
||||
**Click the ▶ example to ▼ expand**
|
||||
|
||||
### User Management
|
||||
|
||||
- [Get or set current user display name](#get-or-set-current-user-display-name)
|
||||
- [Set user avatar using URL](#set-user-avatar-using-url)
|
||||
- [Fetch user info by userId](#fetch-user-info-by-userid)
|
||||
- [Create User with Shared Secret Registration](#create-user-with-shared-secret-registration)
|
||||
- [Create/Edit Synapse User](#createedit-synapse-user)
|
||||
- [Deactivate User](#deactivate-user)
|
||||
- [Force User to Join Room](#force-user-to-join-room)
|
||||
<details>
|
||||
<summary>Get or set current user display name</summary>
|
||||
|
||||
### Message Handling
|
||||
[View JSON](get-set-displayname.json)
|
||||
|
||||
- [Respond to "ping" with "pong"](#respond-to-ping-with-pong)
|
||||
- [Respond to "html" with an HTML message](#respond-to-html-with-an-html-message)
|
||||
- [Respond to "image" with an uploaded image](#respond-to-image-with-an-uploaded-image)
|
||||
- [Respond to "file" with an uploaded file](#respond-to-file-with-an-uploaded-file)
|
||||
- [Respond to "react" with a reaction](#respond-to-react-with-a-reaction)
|
||||
- [Remove Messages Containing "delete"](#remove-messages-containing-delete)
|
||||
This flow lets you get or set the displayname for the current user.
|
||||
|
||||
### Event Handling
|
||||
|
||||
|
||||
- [Sending Typing Events to a Room](#sending-typing-events-to-a-room)
|
||||
- [Mark all received events as read](#mark-all-received-events-as-read)
|
||||
- [Fetch event by eventId and roomId](#fetch-event-by-eventid-and-roomid)
|
||||
- [Paginate the entire history of a given room](#paginate-the-entire-history-of-a-given-room)
|
||||
- [Paginate related events to a given eventId](#paginate-related-events-to-a-given-eventid)
|
||||
</details>
|
||||
|
||||
### Room Management
|
||||
<details>
|
||||
<summary>Set user avatar using URL</summary>
|
||||
|
||||
- [Set room name and topic](#set-room-name-and-topic)
|
||||
- [Accept Room Invites from Specific User](#accept-room-invites-from-specific-user)
|
||||
- [Leave Room When Someone Says "bye"](#leave-room-when-someone-says-bye)
|
||||
- [Respond to "newroom" by Creating a New Room and Inviting User](#respond-to-newroom-by-creating-a-new-room-and-inviting-user)
|
||||
- [Respond to "joinroom \<room_id_or_alias\>" by Joining Mentioned Room](#respond-to-joinroom-room_id_or_alias-by-joining-mentioned-room)
|
||||
- [Kick/Ban User from Room](#kickban-user-from-room)
|
||||
[View JSON](set-avatar-from-url.json)
|
||||
|
||||
### User Information
|
||||
Inject a URL to an image and Node-RED will fetch the contents, upload to matrix, then set the user avatar to the new mxc_url.
|
||||
|
||||
- [Respond to "users" with Full List of Server Users](#respond-to-users-with-full-list-of-server-users)
|
||||
- [Respond to "whois \<user_id\>" with Information about the User's Session](#respond-to-whois-user_id-with-information-about-the-users-session)
|
||||
- [Respond to "rooms \<user_id\>" with User's Rooms](#respond-to-rooms-user_id-with-users-rooms)
|
||||
- [Respond to "room_users" with Current Room's Users](#respond-to-room_users-with-current-rooms-users)
|
||||
This is a good example of how to use the upload file node.
|
||||
|
||||
### Advanced Features
|
||||
|
||||
|
||||
- [Use Function Node to Run Any Command](#use-function-node-to-run-any-command)
|
||||
- [Download & Store All Received Files/Images](#download--store-all-received-filesimages)
|
||||
</details>
|
||||
|
||||
---
|
||||
<details>
|
||||
<summary>Fetch user info by userId</summary>
|
||||
|
||||
## User Management
|
||||
[View JSON](get-user.json)
|
||||
|
||||
### Create User with Shared Secret Registration
|
||||
Note this only works for users that the bot shares a room with. It will attempt to fetch the user from local storage first and if not found will query the server for the data.
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Create User with Shared Secret Registration</summary>
|
||||
|
||||
[View JSON](shared-secret-registration.json)
|
||||
|
||||
@@ -89,9 +77,10 @@ Use this flow to create users on servers with closed registration. You can also
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Create/Edit Synapse User
|
||||
<details>
|
||||
<summary>Create/Edit Synapse User</summary>
|
||||
|
||||
[View JSON](add-user-with-admin-user.json)
|
||||
|
||||
@@ -99,9 +88,10 @@ Allows an administrator to create or modify a user account with a specified `msg
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Deactivate User
|
||||
<details>
|
||||
<summary>Deactivate User</summary>
|
||||
|
||||
[View JSON](deactivate-user.json)
|
||||
|
||||
@@ -114,9 +104,10 @@ If you send "deactivate_user @test:example.com", the bot will deactivate the `@t
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Force User to Join Room
|
||||
<details>
|
||||
<summary>Force User to Join Room</summary>
|
||||
|
||||
[View JSON](force-join-room.json)
|
||||
|
||||
@@ -129,11 +120,25 @@ If you send "force_join @test:example.com !320j90mf0394f:example.com", the bot w
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
## Message Handling
|
||||
### Message Handling
|
||||
|
||||
### Respond to "ping" with "pong"
|
||||
<details>
|
||||
<summary>Upload file and send to room</summary>
|
||||
|
||||
[View JSON](send-image-to-room.json)
|
||||
|
||||
This flow will download an image from a given URL and upload it to the matrix server then send it to a room.
|
||||
|
||||
This isn't just for images and supports any sort of file format. Videos, images, and audio files will have metadata detected automatically and appended to the message (duration, dimensions, thumbnail, etc)
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Respond to "ping" with "pong"</summary>
|
||||
|
||||
[View JSON](respond-ping-pong.json)
|
||||
|
||||
@@ -141,9 +146,10 @@ Use this flow to respond to anyone who says "ping" with "pong" in the same room.
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Respond to "html" with an HTML Message
|
||||
<details>
|
||||
<summary>Respond to "html" with an HTML Message</summary>
|
||||
|
||||
[View JSON](respond-to-html-with-html.json)
|
||||
|
||||
@@ -151,39 +157,10 @@ Use this flow to respond to anyone who says "html" with an example HTML message.
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Respond to "image" with an Uploaded Image
|
||||
|
||||
[View JSON](respond-image-with-image.json)
|
||||
|
||||
You will need an image on the machine running Node-RED. In this example, `example.png` exists inside the Node-RED directory.
|
||||
|
||||
**Instructions:**
|
||||
|
||||
1. Place the image file (`example.png`) in the appropriate directory.
|
||||
2. Import the flow and deploy it.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Respond to "file" with an Uploaded File
|
||||
|
||||
[View JSON](respond-file-with-file.json)
|
||||
|
||||
You will need a file on the machine running Node-RED. In this example, `sample.pdf` exists inside the Node-RED directory.
|
||||
|
||||
**Instructions:**
|
||||
|
||||
1. Place the file (`sample.pdf`) in the appropriate directory.
|
||||
2. Import the flow and deploy it.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Respond to "react" with a Reaction
|
||||
<details>
|
||||
<summary>Respond to "react" with a Reaction</summary>
|
||||
|
||||
[View JSON](respond-react-with-reaction.json)
|
||||
|
||||
@@ -191,9 +168,10 @@ Gives a 👍 reaction when someone says "react".
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Remove Messages Containing "delete"
|
||||
<details>
|
||||
<summary>Remove Messages Containing "delete"</summary>
|
||||
|
||||
[View JSON](delete-event.json)
|
||||
|
||||
@@ -203,11 +181,99 @@ Any messages containing "delete" will be removed by the client.
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
## Room Management
|
||||
### Event Handling
|
||||
|
||||
### Accept Room Invites from Specific User
|
||||
<details>
|
||||
<summary>Sending Typing Events to a Room</summary>
|
||||
|
||||
[View JSON](send-typing-events.json)
|
||||
|
||||
You can indicate to a room that the bot is typing and also cancel the typing event. This can be useful for making bots feel more interactive (e.g., show typing while requesting an API endpoint).
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Mark all received events as read</summary>
|
||||
|
||||
[View JSON](mark-all-read.json)
|
||||
|
||||
With this flow anytime an event is received by the bot it will mark it as read.
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Fetch event by eventId and roomId</summary>
|
||||
|
||||
[View JSON](get-event.json)
|
||||
|
||||
Fetch an event from Matrix by eventId and roomId
|
||||
|
||||
**Instructions:**
|
||||
|
||||
- Change the inject node to contain a proper eventId and roomId (topic)
|
||||
- Inject the payload and you should see the result contain the event data
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Paginate the entire history of a given room</summary>
|
||||
|
||||
[View JSON](paginate-room-history.json)
|
||||
|
||||
This flow iterates the entire history of a room (outputting for every page we hit).
|
||||
|
||||
There is a configurable delay (currently set at 1000ms) in this flow. This is recommended, so you are not bogging down the server.
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Paginate related events to a given eventId</summary>
|
||||
|
||||
[View JSON](fetch-event-relations.json)
|
||||
|
||||
Paginate through the related events to a given eventId. Related events being reactions, thread messages, message modifications, message removals, etc. This outputs once per iterated page.
|
||||
|
||||
If you would rather have it output one massive list at the end of pagination use this flow:
|
||||
[View Aggregated Flow JSON](fetch-event-relations-aggregated.json)
|
||||
|
||||
**Instructions:**
|
||||
|
||||
- Change the inject node to contain a proper eventId and roomId (topic)
|
||||
- Inject the payload and you should see the result contain a list of related events for the given eventId
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
### Room Management
|
||||
|
||||
<details>
|
||||
<summary>Set room name and topic</summary>
|
||||
|
||||
[View JSON](set-room-name-and-topic.json)
|
||||
|
||||
Changes the specified room's name and topic to the injected values.
|
||||
|
||||
There are a bunch of different settings you can change, this is just an example for these two fields to show how it's done.
|
||||
|
||||
This node can also be used to read these values.
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Accept Room Invites from Specific User</summary>
|
||||
|
||||
[View JSON](accept-room-invites.json)
|
||||
|
||||
@@ -215,9 +281,10 @@ Automatically accept room invites from a specific user.
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Leave Room When Someone Says "bye"
|
||||
<details>
|
||||
<summary>Leave Room When Someone Says "bye"</summary>
|
||||
|
||||
[View JSON](leave-room-bye.json)
|
||||
|
||||
@@ -225,9 +292,10 @@ Leaves the room when someone says "bye".
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Respond to "newroom" by Creating a New Room and Inviting User
|
||||
<details>
|
||||
<summary>Respond to "newroom" by Creating a New Room and Inviting User</summary>
|
||||
|
||||
[View JSON](respond-newroom-invite.json)
|
||||
|
||||
@@ -235,19 +303,21 @@ When someone sends "newroom", a new room will be created, and the user who sent
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Respond to "joinroom \<room_id_or_alias\>" by Joining Mentioned Room
|
||||
<details>
|
||||
<summary>Respond to "joinroom <room_id_or_alias>" by Joining Mentioned Room</summary>
|
||||
|
||||
[View JSON](respond-joinroom.json)
|
||||
|
||||
When someone sends "joinroom \<room_id_or_alias\>", the bot will join the mentioned room.
|
||||
When someone sends "joinroom <room_id_or_alias>", the bot will join the mentioned room.
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Kick/Ban User from Room
|
||||
<details>
|
||||
<summary>Kick/Ban User from Room</summary>
|
||||
|
||||
[View JSON](room-kick-ban.json)
|
||||
|
||||
@@ -258,11 +328,12 @@ When someone sends "joinroom \<room_id_or_alias\>", the bot will join the mentio
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
## User Information
|
||||
### User Information
|
||||
|
||||
### Respond to "users" with Full List of Server Users
|
||||
<details>
|
||||
<summary>Respond to "users" with Full List of Server Users</summary>
|
||||
|
||||
[View JSON](respond-users-list.json)
|
||||
|
||||
@@ -275,9 +346,10 @@ When someone sends the text "users", they receive an HTML message containing all
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Respond to "whois \<user_id\>" with Information about the User's Session
|
||||
<details>
|
||||
<summary>Respond to "whois <user_id>" with Information about the User's Session</summary>
|
||||
|
||||
[View JSON](respond-whois.json)
|
||||
|
||||
@@ -290,13 +362,14 @@ Lists out the user's session info, including IP address, last seen time, and use
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Respond to "rooms \<user_id\>" with User's Rooms
|
||||
<details>
|
||||
<summary>Respond to "rooms <user_id>" with User's Rooms</summary>
|
||||
|
||||
[View JSON](respond-rooms.json)
|
||||
|
||||
Responds to "rooms \<user_id\>" with that user's rooms. If the message is just "rooms", it responds with a list of all rooms the server is participating in.
|
||||
Responds to "rooms <user_id>" with that user's rooms. If the message is just "rooms", it responds with a list of all rooms the server is participating in.
|
||||
|
||||
**Notes:**
|
||||
|
||||
@@ -306,9 +379,10 @@ Responds to "rooms \<user_id\>" with that user's rooms. If the message is just "
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Respond to "room_users" with Current Room's Users
|
||||
<details>
|
||||
<summary>Respond to "room_users" with Current Room's Users</summary>
|
||||
|
||||
[View JSON](respond-room-users.json)
|
||||
|
||||
@@ -318,11 +392,12 @@ Lists the users participating in the current room.
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
## Advanced Features
|
||||
### Advanced Features
|
||||
|
||||
### Use Function Node to Run Any Command
|
||||
<details>
|
||||
<summary>Use Function Node to Run Any Command</summary>
|
||||
|
||||
[View JSON](custom-redact-function-node.json)
|
||||
|
||||
@@ -337,19 +412,10 @@ To view the available functions, check out the [`client.ts` file from `matrix-js
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Sending Typing Events to a Room
|
||||
|
||||
[View JSON](send-typing-events.json)
|
||||
|
||||
You can indicate to a room that the bot is typing and also cancel the typing event. This can be useful for making bots feel more interactive (e.g., show typing while requesting an API endpoint).
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Download & Store All Received Files/Images
|
||||
<details>
|
||||
<summary>Download & Store All Received Files/Images</summary>
|
||||
|
||||
[View JSON](store-received-files.json)
|
||||
|
||||
@@ -363,109 +429,38 @@ Downloads received files/images. If the file is encrypted, it will decrypt it fo
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Fetch event by eventId and roomId
|
||||
### Deprecated
|
||||
|
||||
[View JSON](get-event.json)
|
||||
<details>
|
||||
<summary>Respond to "image" with an uploaded image</summary>
|
||||
|
||||
Fetch an event from Matrix by eventId and roomId
|
||||
[View JSON](respond-image-with-image.json)
|
||||
|
||||
You will need an image on the machine running Node-RED. In this example, `example.png` exists inside the Node-RED directory.
|
||||
|
||||
**Instructions:**
|
||||
|
||||
- Change the inject node to contain a proper eventId and roomId (topic)
|
||||
- Inject the payload and you should see the result contain the event data
|
||||
1. Place the image file (`example.png`) in the appropriate directory.
|
||||
2. Import the flow and deploy it.
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
</details>
|
||||
|
||||
### Paginate related events to a given eventId
|
||||
<details>
|
||||
<summary>Respond to "file" with an uploaded file</summary>
|
||||
|
||||
[View JSON](fetch-event-relations.json)
|
||||
|
||||
Paginate through the related events to a given eventId. Related events being reactions, thread messages, message modifications, message removals, etc. This outputs once per iterated page.
|
||||
|
||||
If you would rather have it output one massive list at the end of pagination use this flow:
|
||||
[View Aggregated Flow JSON](fetch-event-relations-aggregated.json)
|
||||
[View JSON](respond-file-with-file.json)
|
||||
|
||||
You will need a file on the machine running Node-RED. In this example, `sample.pdf` exists inside the Node-RED directory.
|
||||
|
||||
**Instructions:**
|
||||
|
||||
- Change the inject node to contain a proper eventId and roomId (topic)
|
||||
- Inject the payload and you should see the result contain a list of related events for the given eventId
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Mark all received events as read
|
||||
|
||||
[View JSON](mark-all-read.json)
|
||||
|
||||
With this flow anytime an event is received by the bot it will mark it as read.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Paginate the entire history of a given room
|
||||
|
||||
[View JSON](paginate-room-history.json)
|
||||
|
||||
This flow iterates the entire history of a room (outputting for every page we hit).
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Fetch user info by userId
|
||||
|
||||
[View JSON](get-user.json)
|
||||
|
||||
Note this only works for users that the bot shares a room with. It will attempt to fetch the user from local storage first and if not found will query the server for the data.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Get or set current user display name
|
||||
|
||||
[View JSON](get-set-displayname.json)
|
||||
|
||||
This flow lets you get or set the displayname for the current user.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Set user avatar using URL
|
||||
|
||||
[View JSON](set-avatar-from-url.json)
|
||||
|
||||
Inject a URL to an image and Node-RED will fetch the contents, upload to matrix, then set the user avatar to the new mxc_url.
|
||||
|
||||
This is a good example of how to use the upload file node.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Set room name and topic
|
||||
|
||||
[View JSON](set-room-name-and-topic.json)
|
||||
|
||||
Changes the specified room's name and topic to the injected values.
|
||||
|
||||
There are a bunch of different settings you can change, this is just an example for these two fields to show how it's done.
|
||||
|
||||
This node can also be used to read these values.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
1. Place the file (`sample.pdf`) in the appropriate directory.
|
||||
2. Import the flow and deploy it.
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
@@ -15,9 +15,9 @@
|
||||
"973dd418b00172c8",
|
||||
"3edbea9403d7c347"
|
||||
],
|
||||
"x": 754,
|
||||
"x": 854,
|
||||
"y": 1339,
|
||||
"w": 932,
|
||||
"w": 832,
|
||||
"h": 182
|
||||
},
|
||||
{
|
||||
@@ -113,7 +113,7 @@
|
||||
"once": false,
|
||||
"onceDelay": 0.1,
|
||||
"topic": "!example:skylar.tech",
|
||||
"x": 900,
|
||||
"x": 1000,
|
||||
"y": 1480,
|
||||
"wires": [
|
||||
[
|
||||
|
||||
@@ -0,0 +1,142 @@
|
||||
[
|
||||
{
|
||||
"id": "f4a0c2a9d7eed027",
|
||||
"type": "group",
|
||||
"z": "8fd89a0b44c61e76",
|
||||
"name": "Send an uploaded file to a room",
|
||||
"style": {
|
||||
"label": true
|
||||
},
|
||||
"nodes": [
|
||||
"8d475ab136d1ee7e",
|
||||
"2524f5a9a7ea2444",
|
||||
"9a149a36d6ab6470",
|
||||
"9da1ed1dc33930bb",
|
||||
"f93782c346d0e6ef"
|
||||
],
|
||||
"x": 754,
|
||||
"y": 2719,
|
||||
"w": 992,
|
||||
"h": 82
|
||||
},
|
||||
{
|
||||
"id": "8d475ab136d1ee7e",
|
||||
"type": "matrix-upload-file",
|
||||
"z": "8fd89a0b44c61e76",
|
||||
"g": "f4a0c2a9d7eed027",
|
||||
"name": "",
|
||||
"server": null,
|
||||
"inputType": "msg",
|
||||
"inputValue": "payload",
|
||||
"fileNameType": "msg",
|
||||
"fileNameValue": "filename",
|
||||
"contentType": "",
|
||||
"generateThumbnails": true,
|
||||
"x": 1270,
|
||||
"y": 2760,
|
||||
"wires": [
|
||||
[
|
||||
"2524f5a9a7ea2444"
|
||||
],
|
||||
[]
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "2524f5a9a7ea2444",
|
||||
"type": "matrix-send-message",
|
||||
"z": "8fd89a0b44c61e76",
|
||||
"g": "f4a0c2a9d7eed027",
|
||||
"name": "",
|
||||
"server": null,
|
||||
"roomId": "",
|
||||
"message": "",
|
||||
"messageType": "m.text",
|
||||
"messageFormat": "",
|
||||
"replaceMessage": false,
|
||||
"threadReplyType": "msg",
|
||||
"threadReplyValue": "isThread",
|
||||
"x": 1440,
|
||||
"y": 2760,
|
||||
"wires": [
|
||||
[
|
||||
"f93782c346d0e6ef"
|
||||
],
|
||||
[]
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "9a149a36d6ab6470",
|
||||
"type": "http request",
|
||||
"z": "8fd89a0b44c61e76",
|
||||
"g": "f4a0c2a9d7eed027",
|
||||
"name": "",
|
||||
"method": "GET",
|
||||
"ret": "bin",
|
||||
"paytoqs": "ignore",
|
||||
"url": "",
|
||||
"tls": "",
|
||||
"persist": false,
|
||||
"proxy": "",
|
||||
"insecureHTTPParser": false,
|
||||
"authType": "",
|
||||
"senderr": false,
|
||||
"headers": [],
|
||||
"x": 1110,
|
||||
"y": 2760,
|
||||
"wires": [
|
||||
[
|
||||
"8d475ab136d1ee7e"
|
||||
]
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "9da1ed1dc33930bb",
|
||||
"type": "inject",
|
||||
"z": "8fd89a0b44c61e76",
|
||||
"g": "f4a0c2a9d7eed027",
|
||||
"name": "",
|
||||
"props": [
|
||||
{
|
||||
"p": "url",
|
||||
"v": "https://nodered.org/about/resources/media/node-red-icon.png",
|
||||
"vt": "str"
|
||||
},
|
||||
{
|
||||
"p": "filename",
|
||||
"v": "avatar.jpg",
|
||||
"vt": "str"
|
||||
},
|
||||
{
|
||||
"p": "topic",
|
||||
"vt": "str"
|
||||
}
|
||||
],
|
||||
"repeat": "",
|
||||
"crontab": "",
|
||||
"once": false,
|
||||
"onceDelay": 0.1,
|
||||
"topic": "!example:skylar.tech",
|
||||
"x": 900,
|
||||
"y": 2760,
|
||||
"wires": [
|
||||
[
|
||||
"9a149a36d6ab6470"
|
||||
]
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "f93782c346d0e6ef",
|
||||
"type": "debug",
|
||||
"z": "8fd89a0b44c61e76",
|
||||
"g": "f4a0c2a9d7eed027",
|
||||
"name": "Debug Output",
|
||||
"active": true,
|
||||
"tosidebar": true,
|
||||
"console": false,
|
||||
"tostatus": false,
|
||||
"complete": "true",
|
||||
"x": 1620,
|
||||
"y": 2760,
|
||||
"wires": []
|
||||
}
|
||||
]
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Generated
+5029
-16689
File diff suppressed because it is too large
Load Diff
+2
-2
@@ -3,18 +3,18 @@
|
||||
"version": "0.8.0",
|
||||
"description": "Matrix chat server client for Node-RED",
|
||||
"dependencies": {
|
||||
"@matrix-org/matrix-sdk-crypto-nodejs": "^0.2.0-beta.1",
|
||||
"abort-controller": "^3.0.0",
|
||||
"fluent-ffmpeg": "^2.1.2",
|
||||
"fs-extra": "^11.1.0",
|
||||
"got": "^12.0.2",
|
||||
"image-size": "^1.0.2",
|
||||
"isomorphic-webcrypto": "^2.3.8",
|
||||
"matrix-js-sdk": "^28.0.0",
|
||||
"matrix-js-sdk": "^34.5.0",
|
||||
"mime": "^3.0.0",
|
||||
"node-fetch": "^3.3.0",
|
||||
"node-localstorage": "^2.2.1",
|
||||
"olm": "https://gitlab.matrix.org/matrix-org/olm/-/package_files/2572/download",
|
||||
"request": "^2.88.2",
|
||||
"sharp": "^0.33.4",
|
||||
"tmp": "^0.2.1",
|
||||
"utf8": "^3.0.0"
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
const {RelationType, EventType, Direction} = require("matrix-js-sdk");
|
||||
|
||||
module.exports = function(RED) {
|
||||
function MatrixFetchRelations(n) {
|
||||
RED.nodes.createNode(this, n);
|
||||
@@ -43,6 +41,8 @@ module.exports = function(RED) {
|
||||
});
|
||||
|
||||
node.on("input", async function(msg) {
|
||||
const {Direction} = await import("matrix-js-sdk");
|
||||
|
||||
if (!node.server || !node.server.matrixClient) {
|
||||
node.error("No matrix server selected", msg);
|
||||
return;
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
const {TimelineWindow, RelationType, Filter} = require("matrix-js-sdk");
|
||||
const crypto = require('crypto');
|
||||
module.exports = function(RED) {
|
||||
function MatrixReceiveMessage(n) {
|
||||
RED.nodes.createNode(this, n);
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
const {TimelineWindow, RelationType, Filter} = require("matrix-js-sdk");
|
||||
const crypto = require('crypto');
|
||||
module.exports = function(RED) {
|
||||
function MatrixReceiveMessage(n) {
|
||||
RED.nodes.createNode(this, n);
|
||||
@@ -34,6 +32,9 @@ module.exports = function(RED) {
|
||||
});
|
||||
|
||||
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) {
|
||||
node.error("No matrix server selected", msg);
|
||||
return;
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
const {RelationType} = require("matrix-js-sdk");
|
||||
module.exports = function(RED) {
|
||||
function MatrixReceiveMessage(n) {
|
||||
RED.nodes.createNode(this, n);
|
||||
|
||||
@@ -89,6 +89,9 @@
|
||||
<label for="node-input-threadReply"><i class="fa fa-commenting-o"></i> Thread Reply</label>
|
||||
<input type="text" id="node-input-threadReply">
|
||||
</div>
|
||||
<div class="form-row form-tips">
|
||||
If true and <code>msg.content.['m.relates_to'].event_id</code> or <code>msg.eventId</code> (parsed in that order) is provided the message will be a thread reply to the original event.
|
||||
</div>
|
||||
|
||||
<div class="form-row">
|
||||
<label for="node-input-messageFormat">
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
const {RelationType} = require("matrix-js-sdk");
|
||||
|
||||
module.exports = function(RED) {
|
||||
function MatrixSendImage(n) {
|
||||
RED.nodes.createNode(this, n);
|
||||
@@ -68,7 +66,8 @@ module.exports = function(RED) {
|
||||
node.status({ fill: "green", shape: "ring", text: "connected" });
|
||||
});
|
||||
|
||||
node.on("input", function (msg) {
|
||||
node.on("input", async function (msg) {
|
||||
const {RelationType} = await import("matrix-js-sdk");
|
||||
function getToValue(msg, type, property) {
|
||||
let value = property;
|
||||
if (type === "msg") {
|
||||
|
||||
+335
-345
@@ -1,14 +1,10 @@
|
||||
const {RelationType, TimelineWindow} = require("matrix-js-sdk");
|
||||
|
||||
global.Olm = require('olm');
|
||||
const fs = require("fs-extra");
|
||||
const sdk = require("matrix-js-sdk");
|
||||
const { resolve } = require('path');
|
||||
const { LocalStorage } = require('node-localstorage');
|
||||
const { LocalStorageCryptoStore } = require('matrix-js-sdk/lib/crypto/store/localStorage-crypto-store');
|
||||
const {RoomEvent, RoomMemberEvent, HttpApiEvent, ClientEvent, MemoryStore} = require("matrix-js-sdk");
|
||||
const request = require("request");
|
||||
globalThis.crypto = require('crypto');
|
||||
require("abort-controller/polyfill"); // polyfill abort-controller if we don't have it
|
||||
|
||||
if (!globalThis.fetch) {
|
||||
// polyfill fetch if we don't have it
|
||||
if (!globalThis.fetch) {
|
||||
@@ -19,16 +15,22 @@ if (!globalThis.fetch) {
|
||||
}
|
||||
|
||||
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"
|
||||
let loggingSettings = RED.settings.get('logging');
|
||||
if(
|
||||
typeof loggingSettings.console !== 'undefined' &&
|
||||
typeof loggingSettings.console.level !== 'undefined' &&
|
||||
['info','debug','trace'].indexOf(loggingSettings.console.level.toLowerCase()) >= 0
|
||||
) {
|
||||
const { logger } = require('matrix-js-sdk/lib/logger');
|
||||
logger.disableAll();
|
||||
}
|
||||
// let loggingSettings = RED.settings.get('logging');
|
||||
// if(
|
||||
// typeof loggingSettings.console !== 'undefined' &&
|
||||
// typeof loggingSettings.console.level !== 'undefined' &&
|
||||
// ['info','debug','trace'].indexOf(loggingSettings.console.level.toLowerCase()) >= 0
|
||||
// ) {
|
||||
// loggerPromise.then(({ logger }) => {
|
||||
// logger.disableAll();
|
||||
// });
|
||||
// }
|
||||
|
||||
function MatrixFolderNameFromUserId(name) {
|
||||
return name.replace(/[^a-z0-9]/gi, '_').toLowerCase();
|
||||
@@ -66,7 +68,7 @@ module.exports = function(RED) {
|
||||
node.deregister = function(consumerNode) {
|
||||
delete node.users[consumerNode.id];
|
||||
};
|
||||
|
||||
|
||||
if(!this.userId) {
|
||||
node.log("Matrix connection failed: missing user ID in configuration.");
|
||||
return;
|
||||
@@ -83,7 +85,7 @@ module.exports = function(RED) {
|
||||
} else if(!this.url) {
|
||||
node.error("Matrix connection failed: missing server URL in configuration.", {});
|
||||
} else {
|
||||
node.setConnected = async function(connected, cb) {
|
||||
node.setConnected = function(connected, cb) {
|
||||
if (node.connected !== connected) {
|
||||
node.connected = connected;
|
||||
if(typeof cb === 'function') {
|
||||
@@ -145,313 +147,294 @@ module.exports = function(RED) {
|
||||
|
||||
fs.ensureDirSync(storageDir); // create storage directory if it doesn't exist
|
||||
upgradeDirectoryIfNecessary(node, storageDir);
|
||||
node.matrixClient = sdk.createClient({
|
||||
baseUrl: this.url,
|
||||
accessToken: this.credentials.accessToken,
|
||||
cryptoStore: new LocalStorageCryptoStore(localStorage),
|
||||
store: new MemoryStore({
|
||||
localStorage: localStorage,
|
||||
}),
|
||||
userId: this.userId,
|
||||
deviceId: (this.deviceId || getStoredDeviceId(localStorage)) || undefined,
|
||||
request
|
||||
// verificationMethods: ["m.sas.v1"]
|
||||
});
|
||||
|
||||
node.debug(`hasLazyLoadMembersEnabled=${node.matrixClient.hasLazyLoadMembersEnabled()}`);
|
||||
// Wait for the dynamic imports to resolve
|
||||
Promise.all([sdkPromise, LocalStorageCryptoStorePromise]).then(([sdkModule, LocalStorageCryptoStoreModule]) => {
|
||||
const sdk = sdkModule.default || sdkModule;
|
||||
const { LocalStorageCryptoStore } = LocalStorageCryptoStoreModule;
|
||||
|
||||
// set globally if configured to do so
|
||||
if(this.globalAccess) {
|
||||
this.context().global.set('matrixClient["'+this.userId+'"]', node.matrixClient);
|
||||
}
|
||||
|
||||
function stopClient() {
|
||||
if(node.matrixClient && node.matrixClient.clientRunning) {
|
||||
node.matrixClient.stopClient();
|
||||
node.setConnected(false);
|
||||
}
|
||||
|
||||
if(retryStartTimeout) {
|
||||
clearTimeout(retryStartTimeout);
|
||||
}
|
||||
}
|
||||
|
||||
node.on('close', function(done) {
|
||||
stopClient();
|
||||
if(node.globalAccess) {
|
||||
try {
|
||||
node.context().global.set('matrixClient["'+node.userId+'"]', undefined);
|
||||
} catch(e){
|
||||
node.error(e.message, {});
|
||||
}
|
||||
}
|
||||
done();
|
||||
});
|
||||
|
||||
node.isConnected = function() {
|
||||
return node.connected;
|
||||
};
|
||||
|
||||
node.matrixClient.on(RoomEvent.Timeline, async function(event, room, toStartOfTimeline, removed, data) {
|
||||
if (toStartOfTimeline) {
|
||||
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
|
||||
}
|
||||
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");
|
||||
return; // ignore old message (we only want live events)
|
||||
}
|
||||
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");
|
||||
return; // skip events that occurred before our client initialized
|
||||
}
|
||||
|
||||
try {
|
||||
await node.matrixClient.decryptEventIfNeeded(event);
|
||||
} catch (error) {
|
||||
node.error(error, {});
|
||||
return;
|
||||
}
|
||||
|
||||
const isDmRoom = (room) => {
|
||||
// Find out if this is a direct message room.
|
||||
let isDM = !!room.getDMInviter();
|
||||
const allMembers = room.currentState.getMembers();
|
||||
if (!isDM && allMembers.length <= 2) {
|
||||
// if not a DM, but there are 2 users only
|
||||
// double check DM (needed because getDMInviter works only if you were invited, not if you invite)
|
||||
// hence why we check for each member
|
||||
if (allMembers.some((m) => m.getDMInviter())) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return allMembers.length <= 2 && isDM;
|
||||
};
|
||||
|
||||
let msg = {
|
||||
encrypted : event.isEncrypted(),
|
||||
redacted : event.isRedacted(),
|
||||
content : event.getContent(),
|
||||
type : (event.getContent()['msgtype'] || event.getType()) || null,
|
||||
payload : (event.getContent()['body'] || event.getContent()) || null,
|
||||
isDM : isDmRoom(room),
|
||||
isThread : event.getContent()?.['m.relates_to']?.rel_type === RelationType.Thread,
|
||||
mentions : event.getContent()["m.mentions"] || null,
|
||||
userId : event.getSender(),
|
||||
user : node.matrixClient.getUser(event.getSender()),
|
||||
topic : event.getRoomId(),
|
||||
eventId : event.getId(),
|
||||
event : event,
|
||||
};
|
||||
|
||||
// remove keys from user property that start with an underscore
|
||||
Object.keys(msg.user).forEach(function (key) {
|
||||
if (/^_/.test(key)) {
|
||||
delete msg.user[key];
|
||||
}
|
||||
node.matrixClient = sdk.createClient({
|
||||
baseUrl: this.url,
|
||||
accessToken: this.credentials.accessToken,
|
||||
cryptoStore: new LocalStorageCryptoStore(localStorage),
|
||||
store: new sdk.MemoryStore({
|
||||
localStorage: localStorage,
|
||||
}),
|
||||
userId: this.userId,
|
||||
deviceId: (this.deviceId || getStoredDeviceId(localStorage)) || undefined
|
||||
// verificationMethods: ["m.sas.v1"]
|
||||
});
|
||||
|
||||
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.debug(`hasLazyLoadMembersEnabled=${node.matrixClient.hasLazyLoadMembersEnabled()}`);
|
||||
|
||||
/**
|
||||
* 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
|
||||
|
||||
node.matrixClient.on(RoomMemberEvent.Membership, async function(event, member) {
|
||||
if(node.initializedAt > event.getDate()) {
|
||||
return; // skip events that occurred before our client initialized
|
||||
// set globally if configured to do so
|
||||
if(this.globalAccess) {
|
||||
this.context().global.set('matrixClient["'+this.userId+'"]', node.matrixClient);
|
||||
}
|
||||
|
||||
if (member.membership === "invite" && member.userId === node.userId) {
|
||||
node.log("Got invite to join room " + member.roomId);
|
||||
if(node.autoAcceptRoomInvites) {
|
||||
node.matrixClient.joinRoom(member.roomId).then(function() {
|
||||
node.log("Automatically accepted invitation to join room " + member.roomId);
|
||||
}).catch(function(e) {
|
||||
node.warn("Cannot join room (could be from being kicked/banned) " + member.roomId + ": " + e);
|
||||
function stopClient() {
|
||||
if(node.matrixClient && node.matrixClient.clientRunning) {
|
||||
node.matrixClient.stopClient();
|
||||
node.setConnected(false);
|
||||
}
|
||||
|
||||
if(retryStartTimeout) {
|
||||
clearTimeout(retryStartTimeout);
|
||||
}
|
||||
}
|
||||
|
||||
node.on('close', function(done) {
|
||||
stopClient();
|
||||
if(node.globalAccess) {
|
||||
try {
|
||||
node.context().global.set('matrixClient["'+node.userId+'"]', undefined);
|
||||
} catch(e){
|
||||
node.error(e.message, {});
|
||||
}
|
||||
}
|
||||
done();
|
||||
});
|
||||
|
||||
node.isConnected = function() {
|
||||
return node.connected;
|
||||
};
|
||||
|
||||
const { RelationType, RoomEvent, RoomMemberEvent, HttpApiEvent, ClientEvent } = sdk;
|
||||
|
||||
node.matrixClient.on(RoomEvent.Timeline, async function(event, room, toStartOfTimeline, removed, data) {
|
||||
if (toStartOfTimeline) {
|
||||
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
|
||||
}
|
||||
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");
|
||||
return; // ignore old message (we only want live events)
|
||||
}
|
||||
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");
|
||||
return; // skip events that occurred before our client initialized
|
||||
}
|
||||
|
||||
try {
|
||||
await node.matrixClient.decryptEventIfNeeded(event);
|
||||
} catch (error) {
|
||||
node.error(error, {});
|
||||
return;
|
||||
}
|
||||
|
||||
const isDmRoom = (room) => {
|
||||
// Find out if this is a direct message room.
|
||||
let isDM = !!room.getDMInviter();
|
||||
const allMembers = room.currentState.getMembers();
|
||||
if (!isDM && allMembers.length <= 2) {
|
||||
// if not a DM, but there are 2 users only
|
||||
// double check DM (needed because getDMInviter works only if you were invited, not if you invite)
|
||||
// hence why we check for each member
|
||||
if (allMembers.some((m) => m.getDMInviter())) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return allMembers.length <= 2 && isDM;
|
||||
};
|
||||
|
||||
let msg = {
|
||||
encrypted : event.isEncrypted(),
|
||||
redacted : event.isRedacted(),
|
||||
content : event.getContent(),
|
||||
type : (event.getContent()['msgtype'] || event.getType()) || null,
|
||||
payload : (event.getContent()['body'] || event.getContent()) || null,
|
||||
isDM : isDmRoom(room),
|
||||
isThread : event.getContent()?.['m.relates_to']?.rel_type === RelationType.Thread,
|
||||
mentions : event.getContent()["m.mentions"] || null,
|
||||
userId : event.getSender(),
|
||||
user : node.matrixClient.getUser(event.getSender()),
|
||||
topic : event.getRoomId(),
|
||||
eventId : event.getId(),
|
||||
event : event,
|
||||
};
|
||||
|
||||
// remove keys from user property that start with an underscore
|
||||
if (msg.user) {
|
||||
Object.keys(msg.user).forEach(function (key) {
|
||||
if (/^_/.test(key)) {
|
||||
delete msg.user[key];
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
let room = node.matrixClient.getRoom(event.getRoomId());
|
||||
node.emit("Room.invite", {
|
||||
type : 'm.room.member',
|
||||
userId : event.getSender(),
|
||||
topic : event.getRoomId(),
|
||||
topicName : (room ? room.name : null) || null,
|
||||
event : event,
|
||||
eventId : event.getId(),
|
||||
});
|
||||
}
|
||||
});
|
||||
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.matrixClient.on(ClientEvent.Sync, async function(state, prevState, data) {
|
||||
node.debug("SYNC [STATE=" + state + "] [PREVSTATE=" + prevState + "]");
|
||||
if(prevState === null && state === "PREPARED" ) {
|
||||
// Occurs when the initial sync is completed first time.
|
||||
// This involves setting up filters and obtaining push rules.
|
||||
node.setConnected(true, function(){
|
||||
node.log("Matrix client connected");
|
||||
});
|
||||
} else if(prevState === null && state === "ERROR") {
|
||||
// Occurs when the initial sync failed first time.
|
||||
node.setConnected(false, function(){
|
||||
node.error("Failed to connect to Matrix server", {});
|
||||
});
|
||||
} else if(prevState === "ERROR" && state === "PREPARED") {
|
||||
// Occurs when the initial sync succeeds
|
||||
// after previously failing.
|
||||
node.setConnected(true, function(){
|
||||
node.log("Matrix client connected");
|
||||
});
|
||||
} else if(prevState === "PREPARED" && state === "SYNCING") {
|
||||
// Occurs immediately after transitioning to PREPARED.
|
||||
// Starts listening for live updates rather than catching up.
|
||||
node.setConnected(true, function(){
|
||||
node.log("Matrix client connected");
|
||||
});
|
||||
} else if(prevState === "SYNCING" && state === "RECONNECTING") {
|
||||
// Occurs when the live update fails.
|
||||
node.setConnected(false, function(){
|
||||
node.error("Connection to Matrix server lost", {});
|
||||
});
|
||||
} else if(prevState === "RECONNECTING" && state === "RECONNECTING") {
|
||||
// Can occur if the update calls continue to fail,
|
||||
// but the keepalive calls (to /versions) succeed.
|
||||
node.setConnected(false, function(){
|
||||
node.error("Connection to Matrix server lost", {});
|
||||
});
|
||||
} else if(prevState === "RECONNECTING" && state === "ERROR") {
|
||||
// Occurs when the keepalive call also fails
|
||||
node.setConnected(false, function(){
|
||||
node.error("Connection to Matrix server lost", {});
|
||||
});
|
||||
} else if(prevState === "ERROR" && state === "SYNCING") {
|
||||
// Occurs when the client has performed a
|
||||
// live update after having previously failed.
|
||||
node.setConnected(true, function(){
|
||||
node.log("Matrix client connected");
|
||||
});
|
||||
} else if(prevState === "ERROR" && state === "ERROR") {
|
||||
// Occurs when the client has failed to
|
||||
// keepalive for a second time or more.
|
||||
node.setConnected(false, function(){
|
||||
node.error("Connection to Matrix server lost", {});
|
||||
});
|
||||
} else if(prevState === "SYNCING" && state === "SYNCING") {
|
||||
// Occurs when the client has performed a live update.
|
||||
// This is called <i>after</i> processing.
|
||||
node.setConnected(true, function(){
|
||||
node.log("Matrix client connected");
|
||||
});
|
||||
} else if(state === "STOPPED") {
|
||||
// Occurs once the client has stopped syncing or
|
||||
// trying to sync after stopClient has been called.
|
||||
node.setConnected(false, function(){
|
||||
node.error("Connection to Matrix server lost", {});
|
||||
});
|
||||
}
|
||||
});
|
||||
// handle auto-joining rooms
|
||||
|
||||
|
||||
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, {});
|
||||
stopClient();
|
||||
});
|
||||
|
||||
async function run() {
|
||||
try {
|
||||
if(node.e2ee){
|
||||
node.log("Initializing crypto...");
|
||||
await node.matrixClient.initCrypto();
|
||||
node.matrixClient.getCrypto().globalBlacklistUnverifiedDevices = false; // prevent errors from unverified devices
|
||||
node.matrixClient.on(RoomMemberEvent.Membership, async function(event, member) {
|
||||
if(node.initializedAt > event.getDate()) {
|
||||
return; // skip events that occurred before our client initialized
|
||||
}
|
||||
node.log("Connecting to Matrix server...");
|
||||
await node.matrixClient.startClient({
|
||||
initialSyncLimit: node.initialSyncLimit
|
||||
});
|
||||
} catch(error) {
|
||||
node.error(error, {});
|
||||
}
|
||||
}
|
||||
|
||||
// do an authed request and only continue if we don't get an error
|
||||
// this prevent the matrix client from crashing Node-RED on invalid auth token
|
||||
(function checkAuthTokenThenStart() {
|
||||
if(node.matrixClient.clientRunning) {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* We do a /whoami request before starting for a few reasons:
|
||||
* - validate our auth token
|
||||
* - make sure auth token belongs to provided node.userId
|
||||
* - fetch device_id if possible (only available on Synapse >= v1.40.0 under MSC2033)
|
||||
*/
|
||||
node.matrixClient.whoami()
|
||||
.then(
|
||||
function(data) {
|
||||
if((typeof data['device_id'] === undefined || !data['device_id']) && !node.deviceId && !getStoredDeviceId(localStorage)) {
|
||||
node.error("/whoami request did not return device_id. You will need to manually set one in your configuration because this cannot be automatically fetched.", {});
|
||||
}
|
||||
if('device_id' in data && data['device_id'] && !node.deviceId) {
|
||||
// if we have no device_id configured lets use the one
|
||||
// returned by /whoami for this access_token
|
||||
node.matrixClient.deviceId = data['device_id'];
|
||||
}
|
||||
|
||||
// make sure our userId matches the access token's
|
||||
if(data['user_id'].toLowerCase() !== node.userId.toLowerCase()) {
|
||||
node.error(`User ID provided is ${node.userId} but token belongs to ${data['user_id']}`, {});
|
||||
return;
|
||||
}
|
||||
run().catch((error) => node.error(error));
|
||||
},
|
||||
function(err) {
|
||||
// if the error isn't authentication related retry in a little bit
|
||||
if(err.code !== "M_UNKNOWN_TOKEN") {
|
||||
retryStartTimeout = setTimeout(checkAuthTokenThenStart, 15000);
|
||||
node.error("Auth check failed: " + err, {});
|
||||
}
|
||||
if (member.membership === "invite" && member.userId === node.userId) {
|
||||
node.log("Got invite to join room " + member.roomId);
|
||||
if(node.autoAcceptRoomInvites) {
|
||||
node.matrixClient.joinRoom(member.roomId).then(function() {
|
||||
node.log("Automatically accepted invitation to join room " + member.roomId);
|
||||
}).catch(function(e) {
|
||||
node.warn("Cannot join room (could be from being kicked/banned) " + member.roomId + ": " + e);
|
||||
});
|
||||
}
|
||||
)
|
||||
})();
|
||||
|
||||
let room = node.matrixClient.getRoom(event.getRoomId());
|
||||
node.emit("Room.invite", {
|
||||
type : 'm.room.member',
|
||||
userId : event.getSender(),
|
||||
topic : event.getRoomId(),
|
||||
topicName : (room ? room.name : null) || null,
|
||||
event : event,
|
||||
eventId : event.getId(),
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
node.matrixClient.on(ClientEvent.Sync, async function(state, prevState, data) {
|
||||
node.debug("SYNC [STATE=" + state + "] [PREVSTATE=" + prevState + "]");
|
||||
if(prevState === null && state === "PREPARED" ) {
|
||||
// Occurs when the initial sync is completed first time.
|
||||
// This involves setting up filters and obtaining push rules.
|
||||
node.setConnected(true, function(){
|
||||
node.log("Matrix client connected");
|
||||
});
|
||||
} else if(prevState === null && state === "ERROR") {
|
||||
// Occurs when the initial sync failed first time.
|
||||
node.setConnected(false, function(){
|
||||
node.error("Failed to connect to Matrix server", {});
|
||||
});
|
||||
} else if(prevState === "ERROR" && state === "PREPARED") {
|
||||
// Occurs when the initial sync succeeds
|
||||
// after previously failing.
|
||||
node.setConnected(true, function(){
|
||||
node.log("Matrix client connected");
|
||||
});
|
||||
} else if(prevState === "PREPARED" && state === "SYNCING") {
|
||||
// Occurs immediately after transitioning to PREPARED.
|
||||
// Starts listening for live updates rather than catching up.
|
||||
node.setConnected(true, function(){
|
||||
node.log("Matrix client connected");
|
||||
});
|
||||
} else if(prevState === "SYNCING" && state === "RECONNECTING") {
|
||||
// Occurs when the live update fails.
|
||||
node.setConnected(false, function(){
|
||||
node.error("Connection to Matrix server lost", {});
|
||||
});
|
||||
} else if(prevState === "RECONNECTING" && state === "RECONNECTING") {
|
||||
// Can occur if the update calls continue to fail,
|
||||
// but the keepalive calls (to /versions) succeed.
|
||||
node.setConnected(false, function(){
|
||||
node.error("Connection to Matrix server lost", {});
|
||||
});
|
||||
} else if(prevState === "RECONNECTING" && state === "ERROR") {
|
||||
// Occurs when the keepalive call also fails
|
||||
node.setConnected(false, function(){
|
||||
node.error("Connection to Matrix server lost", {});
|
||||
});
|
||||
} else if(prevState === "ERROR" && state === "SYNCING") {
|
||||
// Occurs when the client has performed a
|
||||
// live update after having previously failed.
|
||||
node.setConnected(true, function(){
|
||||
node.log("Matrix client connected");
|
||||
});
|
||||
} else if(prevState === "ERROR" && state === "ERROR") {
|
||||
// Occurs when the client has failed to
|
||||
// keepalive for a second time or more.
|
||||
node.setConnected(false, function(){
|
||||
node.error("Connection to Matrix server lost", {});
|
||||
});
|
||||
} else if(prevState === "SYNCING" && state === "SYNCING") {
|
||||
// Occurs when the client has performed a live update.
|
||||
// This is called <i>after</i> processing.
|
||||
node.setConnected(true, function(){
|
||||
node.log("Matrix client connected");
|
||||
});
|
||||
} else if(state === "STOPPED") {
|
||||
// Occurs once the client has stopped syncing or
|
||||
// trying to sync after stopClient has been called.
|
||||
node.setConnected(false, function(){
|
||||
node.error("Connection to Matrix server lost", {});
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
node.matrixClient.on(HttpApiEvent.SessionLoggedOut, async function(errorObj){
|
||||
node.error("Authentication failure: " + errorObj, {});
|
||||
stopClient();
|
||||
});
|
||||
|
||||
async function run() {
|
||||
try {
|
||||
if(node.e2ee){
|
||||
node.matrixClient.on("crypto.legacyCryptoStoreMigrationProgress", function(progress, total){
|
||||
node.log(`Migrating from legacy crypto to rust crypto. ${progress}/${total}`);
|
||||
});
|
||||
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.log("Connecting to Matrix server...");
|
||||
await node.matrixClient.startClient({
|
||||
initialSyncLimit: node.initialSyncLimit
|
||||
});
|
||||
} catch(error) {
|
||||
node.error(error);
|
||||
node.error(error, {});
|
||||
}
|
||||
}
|
||||
|
||||
// do an authed request and only continue if we don't get an error
|
||||
// this prevent the matrix client from crashing Node-RED on invalid auth token
|
||||
(function checkAuthTokenThenStart() {
|
||||
if(node.matrixClient.clientRunning) {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* We do a /whoami request before starting for a few reasons:
|
||||
* - validate our auth token
|
||||
* - make sure auth token belongs to provided node.userId
|
||||
* - fetch device_id if possible (only available on Synapse >= v1.40.0 under MSC2033)
|
||||
*/
|
||||
node.matrixClient.whoami()
|
||||
.then(
|
||||
function(data) {
|
||||
if((typeof data['device_id'] === undefined || !data['device_id']) && !node.deviceId && !getStoredDeviceId(localStorage)) {
|
||||
node.error("/whoami request did not return device_id. You will need to manually set one in your configuration because this cannot be automatically fetched.", {});
|
||||
}
|
||||
if('device_id' in data && data['device_id'] && !node.deviceId) {
|
||||
// if we have no device_id configured lets use the one
|
||||
// returned by /whoami for this access_token
|
||||
node.matrixClient.deviceId = data['device_id'];
|
||||
}
|
||||
|
||||
// make sure our userId matches the access token's
|
||||
if(data['user_id'].toLowerCase() !== node.userId.toLowerCase()) {
|
||||
node.error(`User ID provided is ${node.userId} but token belongs to ${data['user_id']}`, {});
|
||||
return;
|
||||
}
|
||||
run().catch((error) => node.error(error));
|
||||
},
|
||||
function(err) {
|
||||
// if the error isn't authentication related retry in a little bit
|
||||
if(err.code !== "M_UNKNOWN_TOKEN") {
|
||||
retryStartTimeout = setTimeout(checkAuthTokenThenStart, 15000);
|
||||
node.error("Auth check failed: " + err, {});
|
||||
}
|
||||
}
|
||||
)
|
||||
})();
|
||||
}).catch((error) => {
|
||||
node.error("Failed to load Matrix SDK modules: " + error, {});
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -475,43 +458,50 @@ module.exports = function(RED) {
|
||||
deviceId = req.body.deviceId || undefined,
|
||||
displayName = req.body.displayName || undefined;
|
||||
|
||||
const matrixClient = sdk.createClient({
|
||||
baseUrl: baseUrl,
|
||||
deviceId: deviceId,
|
||||
timelineSupport: true,
|
||||
localTimeoutMs: '30000',
|
||||
request
|
||||
sdkPromise.then((sdkModule) => {
|
||||
const sdk = sdkModule.default || sdk;
|
||||
|
||||
const matrixClient = sdk.createClient({
|
||||
baseUrl: baseUrl,
|
||||
deviceId: deviceId,
|
||||
timelineSupport: true,
|
||||
localTimeoutMs: '30000',
|
||||
request
|
||||
});
|
||||
|
||||
matrixClient.timelineSupport = true;
|
||||
|
||||
matrixClient.login(
|
||||
'm.login.password', {
|
||||
identifier: {
|
||||
type: 'm.id.user',
|
||||
user: userId,
|
||||
},
|
||||
password: password,
|
||||
initial_device_display_name: displayName
|
||||
})
|
||||
.then(
|
||||
function(response) {
|
||||
res.json({
|
||||
'result': 'ok',
|
||||
'token': response.access_token,
|
||||
'device_id': response.device_id,
|
||||
'user_id': response.user_id,
|
||||
});
|
||||
},
|
||||
function(err) {
|
||||
res.json({
|
||||
'result': 'error',
|
||||
'message': err
|
||||
});
|
||||
}
|
||||
);
|
||||
}).catch((error) => {
|
||||
res.json({
|
||||
'result': 'error',
|
||||
'message': "Failed to load Matrix SDK: " + error
|
||||
});
|
||||
});
|
||||
|
||||
new TimelineWindow()
|
||||
|
||||
matrixClient.timelineSupport = true;
|
||||
|
||||
matrixClient.login(
|
||||
'm.login.password', {
|
||||
identifier: {
|
||||
type: 'm.id.user',
|
||||
user: userId,
|
||||
},
|
||||
password: password,
|
||||
initial_device_display_name: displayName
|
||||
})
|
||||
.then(
|
||||
function(response) {
|
||||
res.json({
|
||||
'result': 'ok',
|
||||
'token': response.access_token,
|
||||
'device_id': response.device_id,
|
||||
'user_id': response.user_id,
|
||||
});
|
||||
},
|
||||
function(err) {
|
||||
res.json({
|
||||
'result': 'error',
|
||||
'message': err
|
||||
});
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
function upgradeDirectoryIfNecessary(node, storageDir) {
|
||||
|
||||
Reference in New Issue
Block a user