Merge pull request #52 from aikitori/feature/delete-message

Add Delete Message Node

package.json

@@ -17,6 +17,7 @@
       "matrix-server-config": "src/matrix-server-config.js",
       "matrix-receive": "src/matrix-receive.js",
       "matrix-send-message": "src/matrix-send-message.js",
+      "matrix-delete-event": "src/matrix-delete-event.js",
       "matrix-send-file": "src/matrix-send-file.js",
       "matrix-send-image": "src/matrix-send-image.js",
       "matrix-react": "src/matrix-react.js",

src/matrix-delete-event.html

@@ -0,0 +1,84 @@
+<script type="text/javascript">
+    RED.nodes.registerType('matrix-delete-event',{
+        category: 'matrix',
+        color: '#00b7ca',
+        icon: "matrix.png",
+        outputLabels: ["success", "error"],
+        inputs:1,
+        outputs:2,
+        defaults: {
+            name: {value:""},
+            server: { value: "", type: "matrix-server-config" },
+            roomId: { value: null },
+            reason: {value:""},
+        },
+        label: function() {
+            return this.name||"Delete Event";
+        },
+        paletteLabel: 'Delete Event'
+    });
+</script>
+
+<script type="text/html" data-template-name="matrix-delete-event">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-server"><i class="fa fa-user"></i> Matrix Server Config</label>
+        <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>
+        <input type="text" id="node-input-roomId" placeholder="msg.topic">
+    </div>
+    <div class="form-row">
+        <label for="node-input-reason"><i class="fa fa-sticky-note"></i> Reason</label>
+        <input type="text" id="node-input-reason" placeholder="msg.reason">
+    </div>
+
+</script>
+
+<script type="text/html" data-help-name="matrix-delete-event">
+    <h3>Details</h3>
+    <p>Delete an event in a room</p>
+
+    <dl class="message-properties">
+        <dt>msg.topic
+            <span class="property-type">string</span>
+        </dt>
+        <dd> Room ID from where the event should be deleted from. Optional if configured on the node. If configured on the node this input will be overridden.</dd>
+        <dt>msg.eventId
+            <span class="property-type">string</span>
+        </dt>
+        <dd>Event ID of the Event which should be deleted.</dd>
+        <dt>msg.reason
+            <span class="property-type">string</span>
+        </dt>
+        <dd>Reason why the event is deleted. Default an empty string</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <ol class="node-ports">
+        <li>Success
+            <dl class="message-properties">
+                <dt>msg.eventId <span class="property-type">string</span></dt>
+                <dd>the eventId from the deleted event.</dd>
+            </dl>
+            <dl class="message-properties">
+                <dt>msg.deleted <span class="property-type">boolean</span></dt>
+                <dd>True, if the event is deleted</dd>
+            </dl>
+        </li>
+        <li>Error
+            <dl class="message-properties">
+                <dt>msg.error <span class="property-type">string</span></dt>
+                <dd>the error that occurred.</dd>
+                <dl class="message-properties">
+                    <dt>msg.deleted <span class="property-type">boolean</span></dt>
+                    <dd>False, if the event is not deleted</dd>
+                </dl>
+            </dl>
+        </li>
+    </ol>
+</script>

src/matrix-delete-event.js

@@ -0,0 +1,75 @@
+module.exports = function(RED) {
+    function MatrixDeleteEvent(n) {
+        RED.nodes.createNode(this,n);
+
+        var node = this;
+
+        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");
+            return;
+        }
+
+        node.status({ fill: "red", shape: "ring", text: "disconnected" });
+
+        node.server.on("disconnected", function(){
+            node.status({ fill: "red", shape: "ring", text: "disconnected" });
+        });
+
+        node.server.on("connected", function() {
+            node.status({ fill: "green", shape: "ring", text: "connected" });
+        });
+
+        node.on('input', function(msg) {
+
+            if(!msg.eventId) {
+                node.error("eventId is missing");
+                node.send([null, msg])
+                return;
+            }
+
+            if (!node.server || !node.server.matrixClient) {
+                node.warn("No matrix server selected");
+                return;
+            }
+
+            if(!node.server.isConnected()) {
+                node.error("Matrix server connection is currently closed");
+                node.send([null, msg]);
+                return;
+            }
+
+            msg.topic = node.roomId || msg.topic;
+            if(!msg.topic) {
+                node.warn("Room must be specified in msg.topic or in configuration");
+                return;
+            }
+
+            msg.reason = node.reason || msg.reason;
+
+            if(!msg.reason) {
+                msg.reason = '';
+            }
+
+            node.server.matrixClient.redactEvent(msg.topic,msg.eventId,undefined ,{
+                reason: msg.reason
+            })
+
+            .then(function(e) {
+                msg.deleted = true
+                node.send([msg, null]);
+            })
+            .catch(function(e){
+                node.warn("Error deleting event " + e);
+                msg.error = e;
+                msg.deleted = false
+                node.send([null, msg]);
+            });
+        });
+    }
+    RED.nodes.registerType("matrix-delete-event",MatrixDeleteEvent);
+}