diff options
Diffstat (limited to 'dgbuilder/core_nodes/social/91-irc.html')
| -rw-r--r-- | dgbuilder/core_nodes/social/91-irc.html | 206 |
1 files changed, 206 insertions, 0 deletions
diff --git a/dgbuilder/core_nodes/social/91-irc.html b/dgbuilder/core_nodes/social/91-irc.html new file mode 100644 index 00000000..11112374 --- /dev/null +++ b/dgbuilder/core_nodes/social/91-irc.html @@ -0,0 +1,206 @@ +<!-- + Copyright 2013 IBM Corp. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<script type="text/x-red" data-template-name="irc in"> + <div class="form-row"> + <label for="node-input-ircserver"><i class="fa fa-globe"></i> IRC Server</label> + <input type="text" id="node-input-ircserver"> + </div> + <div class="form-row"> + <label for="node-input-channel"><i class="fa fa-random"></i> Channel</label> + <input type="text" id="node-input-channel" placeholder="#nodered"> + </div> + <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-tips">The channel to join must start with a # (as per normal irc rules...)<br/> + You may join multiple channels by comma separating a list - #chan1,#chan2,etc.</div> +</script> + +<script type="text/x-red" data-help-name="irc in"> + <p>Connects to a channel on an IRC server.</p> + <p>You may join multiple channels by comma separating a list - #chan1,#chan2,#etc.</p> + <p>Any messages on that channel will appear on the <code>msg.payload</code> at the output, + while <code>msg.topic</code> will contain who it is from. + <code>msg.to</code> contains either the name of the channel or PRIV in the case of a pm.</p> + <p>The second output provides a <code>msg.payload</code> that has any status messages such as joins, parts, kicks etc.</p> + <p>The type of the status message is set as <code>msg.payload.type</code>.</p> + <p>The possible status types are: <br /> + <table border="1" cellpadding="1" cellspacing="1"> + <thead> + <tr> + <th scope="col">Type</th> + <th scope="col">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>message</td> + <td>message is sent into the channel</td> + </tr> + <tr> + <td>pm</td> + <td>private message to the bot</td> + </tr> + <tr> + <td>join</td> + <td>a user joined the channel (also triggered when the bot joins a channel)</td> + </tr> + <tr> + <td>invite</td> + <td>the bot is being invited to a channel</td> + </tr> + <tr> + <td>part</td> + <td>a user leaves a channel</td> + </tr> + <tr> + <td>quit</td> + <td>a user quits a channel</td> + </tr> + <tr> + <td>kick</td> + <td>a user is kicked from a channel</td> + </tr> + <tr> + <td>names</td> + <td>retrieves the list of users when the bot joins a channel</td> + </tr> + </tbody> +</table> +</p> +</script> + +<script type="text/javascript"> + RED.nodes.registerType('irc in',{ + category: 'social-input', + defaults: { + name: {value:""}, + ircserver: {type:"irc-server", required:true}, + channel: {value:"",required:true,validate:RED.validators.regex(/^#/)} + }, + color:"Silver", + inputs:0, + outputs:2, + icon: "hash.png", + label: function() { + var ircNode = RED.nodes.node(this.ircserver); + return this.name || (ircNode ? ircNode.label() : "irc"); + }, + labelStyle: function() { + return this.name?"node_label_italic":""; + }, + oneditprepare: function() { + if ((this.ircserver !== undefined) && (this.ircserver !== "")) { + this.channel = this.channel || RED.nodes.node(this.ircserver).channel; + $("#node-input-channel").val(this.channel); + } + else { this.channel = this.channel; } + $("#node-input-channel").val(this.channel); + } + }); +</script> + + +<script type="text/x-red" data-template-name="irc out"> + <div class="form-row"> + <label for="node-input-ircserver"><i class="fa fa-globe"></i> IRC Server</label> + <input type="text" id="node-input-ircserver"> + </div> + <div class="form-row"> + <label for="node-input-channel"><i class="fa fa-random"></i> Channel</label> + <input type="text" id="node-input-channel" placeholder="#nodered"> + </div> + <div class="form-row"> + <label for="node-input-sendObject"><i class="fa fa-arrows"></i> Action</label> + <select type="text" id="node-input-sendObject" style="display: inline-block; vertical-align: middle; width:70%;"> + <option value="pay">Send payload to channel(s)</option> + <option value="true">Use msg.topic to set nickname or channel(s)</option> + <option value="false">Send complete msg object to channel(s)</option> + </select> + </div> + <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-tips">The channel to join must start with a # (as per normal irc rules...)<br/> + Sending the complete object will stringify the whole msg object before sending.</div> +</script> + +<script type="text/x-red" data-help-name="irc out"> + <p>Sends messages to a channel on an IRC server</p> + <p>You can send just the <code>msg.payload</code>, or the complete <code>msg</code> object to the selected channel, + or you can select to use <code>msg.topic</code> to send the <code>msg.payload</code> to a specific user (private message) or channel.</p> + <p>If multiple output channels are listed (eg. #chan1,#chan2), then the message will be sent to all of them.</p> + <p><b>Note:</b> you can only send to channels you have previously joined so they MUST be specified in the node - even if you then decide to use a subset in msg.topic</p> + <p>You may send RAW commands using <code>msg.raw</code> - This must contain an array of parameters - eg. <pre>["privmsg","#nodered","Hello world"]</pre></p> +</script> + +<script type="text/javascript"> + RED.nodes.registerType('irc out',{ + category: 'social-output', + defaults: { + name: {value:""}, + sendObject: {value:"pay", required:true}, + ircserver: {type:"irc-server", required:true}, + channel: {value:"",required:true,validate:RED.validators.regex(/^#/)} + }, + color:"Silver", + inputs:1, + outputs:0, + icon: "hash.png", + align: "right", + label: function() { + return this.name || (this.ircserver ? RED.nodes.node(this.ircserver).label() : "irc"); + }, + labelStyle: function() { + return this.name?"node_label_italic":""; + }, + oneditprepare: function() { + if ((this.ircserver !== undefined) && (this.ircserver !== "")) { + this.channel = this.channel || RED.nodes.node(this.ircserver).channel; + $("#node-input-channel").val(this.channel); + } + else { this.channel = this.channel; } + } + }); +</script> + + +<script type="text/x-red" data-template-name="irc-server"> + <div class="form-row"> + <label for="node-config-input-server"><i class="fa fa-globe"></i> IRC Server</label> + <input type="text" id="node-config-input-server" placeholder="irc.freenode.net"> + </div> + <div class="form-row"> + <label for="node-config-input-nickname"><i class="fa fa-user"></i> Nickname</label> + <input type="text" id="node-config-input-nickname" placeholder="joe123"> + </div> +</script> + +<script type="text/javascript"> + RED.nodes.registerType('irc-server',{ + category: 'config', + defaults: { + server: {value:"",required:true}, + nickname: {value:"",required:true} + }, + label: function() { + return this.server; + } + }); +</script> |