From 3dc6363a88cb991ada3aaeb21902b8c32776d6f5 Mon Sep 17 00:00:00 2001
From: Skylar Sadlier <skylord123@gmail.com>
Date: Thu, 17 Mar 2022 16:01:27 -0600
Subject: [PATCH] Closes #56 - can now specify message in node's configuration
 for matrix-send-message - can now specify reaction in node's configuration
 for matrix-react - reason can now be configured on both matrix-room-kick and
 matrix-room-ban - icons updated for various nodes

---
 src/matrix-create-room.html              |  2 +-
 src/matrix-crypt-file.html               |  2 +-
 src/matrix-delete-event.html             |  2 +-
 src/matrix-invite-room.html              |  4 +--
 src/matrix-join-room.html                |  2 +-
 src/matrix-react.html                    | 13 ++++++---
 src/matrix-react.js                      |  8 +++---
 src/matrix-receive.html                  |  2 +-
 src/matrix-room-ban.html                 | 13 ++++++---
 src/matrix-room-ban.js                   |  3 ++-
 src/matrix-room-kick.html                | 13 ++++++---
 src/matrix-room-kick.js                  |  3 ++-
 src/matrix-room-users.html               |  2 +-
 src/matrix-send-file.html                |  4 +--
 src/matrix-send-image.html               |  4 +--
 src/matrix-send-message.html             | 34 ++++++++++++++----------
 src/matrix-send-message.js               | 12 +++++----
 src/matrix-synapse-create-edit-user.html |  2 +-
 src/matrix-synapse-deactivate-user.html  |  2 +-
 src/matrix-synapse-join-room.html        |  4 +--
 src/matrix-synapse-register.html         |  2 +-
 src/matrix-synapse-users.html            |  2 +-
 src/matrix-whois-user.html               |  2 +-
 23 files changed, 82 insertions(+), 55 deletions(-)

diff --git a/src/matrix-create-room.html b/src/matrix-create-room.html
index 0188200..6b6b850 100644
--- a/src/matrix-create-room.html
+++ b/src/matrix-create-room.html
@@ -19,7 +19,7 @@
 
 <script type="text/html" data-template-name="matrix-create-room">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 
diff --git a/src/matrix-crypt-file.html b/src/matrix-crypt-file.html
index 93c0a6f..571c73b 100644
--- a/src/matrix-crypt-file.html
+++ b/src/matrix-crypt-file.html
@@ -18,7 +18,7 @@
 
 <script type="text/html" data-template-name="matrix-decrypt-file">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 </script>
diff --git a/src/matrix-delete-event.html b/src/matrix-delete-event.html
index 5393373..920402d 100644
--- a/src/matrix-delete-event.html
+++ b/src/matrix-delete-event.html
@@ -29,7 +29,7 @@
         <input type="text" id="node-input-server">
     </div>
     <div class="form-row">
-        <label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
+        <label for="node-input-roomId"><i class="fa fa-comments"></i> Room ID</label>
         <input type="text" id="node-input-roomId" placeholder="msg.topic">
     </div>
     <div class="form-row">
diff --git a/src/matrix-invite-room.html b/src/matrix-invite-room.html
index e1a5f75..2541382 100644
--- a/src/matrix-invite-room.html
+++ b/src/matrix-invite-room.html
@@ -20,7 +20,7 @@
 
 <script type="text/html" data-template-name="matrix-invite-room">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 
@@ -30,7 +30,7 @@
     </div>
 
     <div class="form-row">
-        <label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
+        <label for="node-input-roomId"><i class="fa fa-comments"></i> Room ID</label>
         <input type="text" id="node-input-roomId" placeholder="msg.topic">
     </div>
 </script>
diff --git a/src/matrix-join-room.html b/src/matrix-join-room.html
index 4b2e8ce..cc04770 100644
--- a/src/matrix-join-room.html
+++ b/src/matrix-join-room.html
@@ -19,7 +19,7 @@
 
 <script type="text/html" data-template-name="matrix-join-room">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
  	 <div class="form-row">
diff --git a/src/matrix-react.html b/src/matrix-react.html
index cc35aaa..fb0d9b5 100644
--- a/src/matrix-react.html
+++ b/src/matrix-react.html
@@ -9,7 +9,8 @@
         defaults: {
             name: { value: null },
             server: { value: "", type: "matrix-server-config" },
-            roomId: { value: null }
+            roomId: { value: null },
+            reaction: { value: null }
         },
         label: function() {
             return this.name || "React";
@@ -20,7 +21,7 @@
 
 <script type="text/html" data-template-name="matrix-react">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
  	 <div class="form-row">
@@ -28,9 +29,13 @@
      	<input type="text" id="node-input-server">
  	</div>
     <div class="form-row">
-        <label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
+        <label for="node-input-roomId"><i class="fa fa-comments"></i> Room ID</label>
         <input type="text" id="node-input-roomId" placeholder="msg.topic">
     </div>
+    <div class="form-row">
+        <label for="node-input-reaction"><i class="fa fa-thumbs-up"></i> Reaction</label>
+        <input type="text" id="node-input-reaction" placeholder="msg.payload">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="matrix-react">
@@ -42,7 +47,7 @@
         <dt>msg.payload
             <span class="property-type">string</span>
         </dt>
-        <dd> Usually an emoji but can also be text. </dd>
+        <dd> Usually an emoji but can also be text. If configured on the node this is ignored otherwise it required. </dd>
 
         <dt>msg.topic
             <span class="property-type">string | null</span>
diff --git a/src/matrix-react.js b/src/matrix-react.js
index e75f23f..8da269e 100644
--- a/src/matrix-react.js
+++ b/src/matrix-react.js
@@ -7,6 +7,7 @@ module.exports = function(RED) {
         this.name = n.name;
         this.server = RED.nodes.getNode(n.server);
         this.roomId = n.roomId;
+        this.reaction = n.reaction;
 
         if (!node.server) {
             node.warn("No configuration node");
@@ -40,8 +41,9 @@ module.exports = function(RED) {
                 return;
             }
 
-            if(!msg.payload) {
-                node.error('msg.payload is required');
+            let payload = n.reaction || msg.payload;
+            if(!payload) {
+                node.error('msg.payload must be defined or the reaction configured on the node.');
                 return;
             }
 
@@ -59,7 +61,7 @@ module.exports = function(RED) {
                 {
                     "m.relates_to": {
                         event_id: eventId,
-                        key: msg.payload,
+                        key: payload,
                         rel_type: "m.annotation"
                     }
                 }
diff --git a/src/matrix-receive.html b/src/matrix-receive.html
index 9eaaf24..aba500e 100644
--- a/src/matrix-receive.html
+++ b/src/matrix-receive.html
@@ -34,7 +34,7 @@
      	<input type="text" id="node-input-server">
  	</div>
     <div class="form-row">
-        <label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
+        <label for="node-input-roomId"><i class="fa fa-comments"></i> Room ID</label>
         <input type="text" id="node-input-roomId">
     </div>
     <div class="form-tips">Enter a single room, comma separated list of rooms, or leave blank to get from all</div>
diff --git a/src/matrix-room-ban.html b/src/matrix-room-ban.html
index 92b9252..192ee1e 100644
--- a/src/matrix-room-ban.html
+++ b/src/matrix-room-ban.html
@@ -9,7 +9,8 @@
         defaults: {
             name: { value: null },
             server: { value: "", type: "matrix-server-config" },
-            roomId: { value: null }
+            roomId: { value: null },
+            reason: { value: null }
         },
         label: function() {
             return this.name || "Room Ban";
@@ -20,7 +21,7 @@
 
 <script type="text/html" data-template-name="matrix-room-ban">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
  	 <div class="form-row">
@@ -28,9 +29,13 @@
      	<input type="text" id="node-input-server">
  	</div>
     <div class="form-row">
-        <label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
+        <label for="node-input-roomId"><i class="fa fa-comments"></i> Room ID</label>
         <input type="text" id="node-input-roomId" placeholder="msg.topic">
     </div>
+    <div class="form-row">
+        <label for="node-input-reason"><i class="fa fa-comment"></i> Reason</label>
+        <input type="text" id="node-input-reason" placeholder="msg.topic">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="matrix-room-ban">
@@ -52,7 +57,7 @@
         <dt class="optional">msg.reason
             <span class="property-type">string</span>
         </dt>
-        <dd> Reason for banning the user.</dd>
+        <dd> Reason for banning the user. If configured on the node it will overwrite this input</dd>
     </dl>
 
     <h3>Outputs</h3>
diff --git a/src/matrix-room-ban.js b/src/matrix-room-ban.js
index 3259e7a..0a26b74 100644
--- a/src/matrix-room-ban.js
+++ b/src/matrix-room-ban.js
@@ -7,6 +7,7 @@ module.exports = function(RED) {
         this.name = n.name;
         this.server = RED.nodes.getNode(n.server);
         this.roomId = n.roomId;
+        this.reason = n.reason;
 
         if (!node.server) {
             node.warn("No configuration node");
@@ -45,7 +46,7 @@ module.exports = function(RED) {
                 return;
             }
 
-            node.server.matrixClient.ban(msg.topic, msg.userId, msg.reason || undefined)
+            node.server.matrixClient.ban(msg.topic, msg.userId, n.reason || msg.reason || undefined)
                 .then(function(e) {
                     node.log("Successfully banned " + msg.userId + " from " + msg.topic);
                     msg.eventId = e.event_id;
diff --git a/src/matrix-room-kick.html b/src/matrix-room-kick.html
index ebbb403..b1b3210 100644
--- a/src/matrix-room-kick.html
+++ b/src/matrix-room-kick.html
@@ -9,7 +9,8 @@
         defaults: {
             name: { value: null },
             server: { value: "", type: "matrix-server-config" },
-            roomId: { value: null }
+            roomId: { value: null },
+            reason: { value: null }
         },
         label: function() {
             return this.name || "Room Kick";
@@ -20,7 +21,7 @@
 
 <script type="text/html" data-template-name="matrix-room-kick">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
  	 <div class="form-row">
@@ -28,9 +29,13 @@
      	<input type="text" id="node-input-server">
  	</div>
     <div class="form-row">
-        <label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
+        <label for="node-input-roomId"><i class="fa fa-comments"></i> Room ID</label>
         <input type="text" id="node-input-roomId" placeholder="msg.topic">
     </div>
+    <div class="form-row">
+        <label for="node-input-reason"><i class="fa fa-comment"></i> Reason</label>
+        <input type="text" id="node-input-reason" placeholder="msg.topic">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="matrix-room-kick">
@@ -52,7 +57,7 @@
         <dt class="optional">msg.reason
             <span class="property-type">string</span>
         </dt>
-        <dd> Reason for kicking the user.</dd>
+        <dd> Reason for kicking the user. If configured on the node it will overwrite this input</dd>
     </dl>
 
     <h3>Outputs</h3>
diff --git a/src/matrix-room-kick.js b/src/matrix-room-kick.js
index 5f30001..5fb9d6f 100644
--- a/src/matrix-room-kick.js
+++ b/src/matrix-room-kick.js
@@ -7,6 +7,7 @@ module.exports = function(RED) {
         this.name = n.name;
         this.server = RED.nodes.getNode(n.server);
         this.roomId = n.roomId;
+        this.reason = n.reason;
 
         if (!node.server) {
             node.warn("No configuration node");
@@ -45,7 +46,7 @@ module.exports = function(RED) {
                 return;
             }
 
-            node.server.matrixClient.kick(msg.topic, msg.userId, msg.reason || undefined)
+            node.server.matrixClient.kick(msg.topic, msg.userId, n.reason || msg.reason || undefined)
                 .then(function(e) {
                     node.log("Successfully kicked " + msg.userId + " from " + msg.topic);
                     msg.eventId = e.event_id;
diff --git a/src/matrix-room-users.html b/src/matrix-room-users.html
index c94e8fe..df1813d 100644
--- a/src/matrix-room-users.html
+++ b/src/matrix-room-users.html
@@ -20,7 +20,7 @@
 
 <script type="text/html" data-template-name="matrix-room-users">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
  	 <div class="form-row">
diff --git a/src/matrix-send-file.html b/src/matrix-send-file.html
index dfc4b1d..83006f5 100644
--- a/src/matrix-send-file.html
+++ b/src/matrix-send-file.html
@@ -21,7 +21,7 @@
 
 <script type="text/html" data-template-name="matrix-send-file">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
  	 <div class="form-row">
@@ -29,7 +29,7 @@
      	<input type="text" id="node-input-server">
  	</div>
     <div class="form-row">
-        <label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
+        <label for="node-input-roomId"><i class="fa fa-comments"></i> Room ID</label>
         <input type="text" id="node-input-roomId" placeholder="msg.topic">
     </div>
     <div class="form-row">
diff --git a/src/matrix-send-image.html b/src/matrix-send-image.html
index 5669b23..21c1d11 100644
--- a/src/matrix-send-image.html
+++ b/src/matrix-send-image.html
@@ -21,7 +21,7 @@
 
 <script type="text/html" data-template-name="matrix-send-image">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
  	 <div class="form-row">
@@ -29,7 +29,7 @@
      	<input type="text" id="node-input-server">
  	</div>
     <div class="form-row">
-        <label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
+        <label for="node-input-roomId"><i class="fa fa-comments"></i> Room ID</label>
         <input type="text" id="node-input-roomId" placeholder="msg.topic">
     </div>
     <div class="form-row">
diff --git a/src/matrix-send-message.html b/src/matrix-send-message.html
index 678d424..9cd5af1 100644
--- a/src/matrix-send-message.html
+++ b/src/matrix-send-message.html
@@ -10,6 +10,7 @@
             name: { value: null },
             server: { value: "", type: "matrix-server-config" },
             roomId: { value: null },
+            message: { value: null },
             messageType: { value: 'm.text' },
             messageFormat: { value: '' },
             replaceMessage : { value: false }
@@ -23,7 +24,7 @@
 
 <script type="text/html" data-template-name="matrix-send-message">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 
@@ -33,10 +34,26 @@
  	</div>
 
     <div class="form-row">
-        <label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
+        <label for="node-input-roomId"><i class="fa fa-comments"></i> Room ID</label>
         <input type="text" id="node-input-roomId" placeholder="msg.topic">
     </div>
 
+    <div class="form-row">
+        <label for="node-input-message"><i class="fa fa-comment"></i> Message</label>
+        <textarea id="node-input-message" placeholder="msg.payload" style="width: 70%;"></textarea>
+    </div>
+
+    <div class="form-row">
+        <input
+                type="checkbox"
+                id="node-input-replaceMessage"
+                style="width: auto; margin-left: 105px; vertical-align: top"
+        />
+        <label for="node-input-replaceMessage" style="width: auto;max-width:50%;">
+            Update existing message if <code>msg.eventId</code> is set
+        </label>
+    </div>
+
     <div class="form-row">
         <label for="node-input-messageType">
             Message Type
@@ -61,17 +78,6 @@
             <option value="msg.format">msg.format input</option>
         </select>
     </div>
-
-    <div class="form-row">
-        <input
-                type="checkbox"
-                id="node-input-replaceMessage"
-                style="width: auto; margin-left: 105px; vertical-align: top"
-        />
-        <label for="node-input-replaceMessage" style="width: auto;max-width:50%;">
-            Update existing message if <code>msg.eventId</code> is set
-        </label>
-    </div>
 </script>
 
 <script type="text/html" data-help-name="matrix-send-message">
@@ -88,7 +94,7 @@
         <dt>msg.payload
             <span class="property-type">string</span>
         </dt>
-        <dd> the message text. </dd>
+        <dd> the message text. If configured on the node this is ignored otherwise it required. </dd>
 
         <dt>msg.replace
             <span class="property-type">bool</span>
diff --git a/src/matrix-send-message.js b/src/matrix-send-message.js
index 92a0422..30607f1 100644
--- a/src/matrix-send-message.js
+++ b/src/matrix-send-message.js
@@ -12,6 +12,7 @@ module.exports = function(RED) {
         this.messageType = n.messageType;
         this.messageFormat = n.messageFormat;
         this.replaceMessage = n.replaceMessage;
+        this.message = n.message;
 
         // taken from https://github.com/matrix-org/synapse/blob/master/synapse/push/mailer.py
         this.allowedTags = [
@@ -101,14 +102,15 @@ module.exports = function(RED) {
                 return;
             }
 
-            if(!msg.payload) {
-                node.error('msg.payload is required');
+            let payload = n.message || msg.payload;
+            if(!payload) {
+                node.error('msg.payload must be defined or the message configured on the node.');
                 return;
             }
 
             let content = {
                 msgtype: msgType,
-                body: msg.payload.toString()
+                body: payload.toString()
             };
 
             if(msgFormat === 'html') {
@@ -116,7 +118,7 @@ module.exports = function(RED) {
                 content.formatted_body =
                     (typeof msg.formatted_payload !== 'undefined' && msg.formatted_payload)
                         ? msg.formatted_payload.toString()
-                        : msg.payload.toString();
+                        : payload.toString();
             }
 
             if((node.replaceMessage || msg.replace) && msg.eventId) {
@@ -140,7 +142,7 @@ module.exports = function(RED) {
 
             node.server.matrixClient.sendMessage(msg.topic, content)
                 .then(function(e) {
-                    node.log("Message sent: " + msg.payload);
+                    node.log("Message sent: " + payload);
                     msg.eventId = e.event_id;
                     node.send([msg, null]);
                 })
diff --git a/src/matrix-synapse-create-edit-user.html b/src/matrix-synapse-create-edit-user.html
index d9a33ad..d2fffcd 100644
--- a/src/matrix-synapse-create-edit-user.html
+++ b/src/matrix-synapse-create-edit-user.html
@@ -19,7 +19,7 @@
 
 <script type="text/html" data-template-name="matrix-synapse-create-edit-user">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 
diff --git a/src/matrix-synapse-deactivate-user.html b/src/matrix-synapse-deactivate-user.html
index 3aa3c62..edca457 100644
--- a/src/matrix-synapse-deactivate-user.html
+++ b/src/matrix-synapse-deactivate-user.html
@@ -19,7 +19,7 @@
 
 <script type="text/html" data-template-name="matrix-synapse-deactivate-user">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 
diff --git a/src/matrix-synapse-join-room.html b/src/matrix-synapse-join-room.html
index ad905b0..154688c 100644
--- a/src/matrix-synapse-join-room.html
+++ b/src/matrix-synapse-join-room.html
@@ -20,7 +20,7 @@
 
 <script type="text/html" data-template-name="matrix-synapse-join-room">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 
@@ -30,7 +30,7 @@
     </div>
 
     <div class="form-row">
-        <label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
+        <label for="node-input-roomId"><i class="fa fa-comments"></i> Room ID</label>
         <input type="text" id="node-input-roomId" placeholder="msg.topic">
     </div>
 
diff --git a/src/matrix-synapse-register.html b/src/matrix-synapse-register.html
index 5c99b61..6191399 100644
--- a/src/matrix-synapse-register.html
+++ b/src/matrix-synapse-register.html
@@ -22,7 +22,7 @@
 
 <script type="text/html" data-template-name="matrix-synapse-register">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 
diff --git a/src/matrix-synapse-users.html b/src/matrix-synapse-users.html
index b6ff5cc..42fec3a 100644
--- a/src/matrix-synapse-users.html
+++ b/src/matrix-synapse-users.html
@@ -19,7 +19,7 @@
 
 <script type="text/html" data-template-name="matrix-synapse-users">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
  	 <div class="form-row">
diff --git a/src/matrix-whois-user.html b/src/matrix-whois-user.html
index 81f1386..57bc54e 100644
--- a/src/matrix-whois-user.html
+++ b/src/matrix-whois-user.html
@@ -19,7 +19,7 @@
 
 <script type="text/html" data-template-name="matrix-whois-user">
     <div class="form-row">
-        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <label for="node-input-name"><i class="fa icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>