commit 873c833950f3e7adff44b4563d35cb91f5ef0235
parent ee0553c8ad5f461f8061844161e995f23d836506
Author: Marcel Radzio <marcel@radzio-sh.de>
Date: Tue, 29 Dec 2015 23:18:44 +0100
Add more Docu
Diffstat:
| M | handlers/irc.js | | | 371 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--- |
| M | handlers/pushbullet.js | | | 32 | ++++++++++++++++++++++++++++++++ |
| M | main.js | | | 55 | ++++++++++++++++++++++++++++++++++--------------------- |
3 files changed, 426 insertions(+), 32 deletions(-)
diff --git a/handlers/irc.js b/handlers/irc.js
@@ -1,10 +1,360 @@
-// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -//
-// @Class irc.js //
-// @Aurhor Marcel Radzio //
-// @URL https://github.com/MTRNord/nordlab-hackerspace-door //
-// //
-// @Description IRC-ChatBot Module //
-// //
-// @Created 29.12.2015-19:39 //
-// @LastModified 29.12.2015-19:36 //
-// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -//
-\ No newline at end of file
+/**
+ * IRC-ChatBot Module
+ *
+ * @module Main
+ * @class irc
+ * @submodule irc
+ * @author Marcel Radzio
+ */
+//Load needed Features
+var irc = require('irc');
+var request = require('request');
+var command_config = require("../configs/commands.json");
+var params_config = require("../configs/params.json");
+
+//Set Params
+/**
+ * Param Botname
+ *
+ * @property botname
+ * @type String
+ */
+var botname = params_config["botname"];
+/**
+ * Param autoupdate
+ *
+ * @property autoupdate
+ * @type String
+ */
+var autoupdate = params_config["autoupdate"];
+/**
+ * Param disconnect_meassage
+ *
+ * @property disconnect_meassage
+ * @type String
+ */
+var disconnect_meassage = params_config["disconnect_meassage"];
+
+
+/* // TEMPLATE //
+for (var key in params_config["servers"]) {
+ if (params_config["servers"].hasOwnProperty(key)) {
+ var servername = params_config["servers"][key]["servername"];
+ var serveraddress = params_config["servers"][key]["serveraddress"];
+ var main_channel = params_config["servers"][key]["main_channel"];
+ var nickserv_pass = params_config["servers"][key]["nickserv_pass"];
+ var active = params_config["servers"][key]["active"];
+ var debug = params_config["servers"][key]["debug"];
+ if (debug == 1) {
+ var debug = true;
+ }else{
+ var debug = false;
+ }
+ }
+}
+*/
+
+for (var key in params_config["servers"]) {
+ if (params_config["servers"].hasOwnProperty(key)) {
+ var serveraddress = params_config["servers"][key]["serveraddress"];
+ var main_channel = params_config["servers"][key]["main_channel"];
+ var active = params_config["servers"][key]["active"];
+ var debug = params_config["servers"][key]["debug"];
+ if (debug == 1) {
+ var debug = true;
+ }else{
+ var debug = false;
+ }
+ if (debug == false) {
+ console = console || {};
+ console.log = function(){};
+ }
+ if (active == 1) {
+ var bot = new irc.Client(serveraddress, botname, {
+ debug: debug,
+ channels: [main_channel, "#freifunk-flensburg"],
+ autoRejoin: true,
+ autoConnect: false,
+ messageSplit: 1000000
+ });
+ }
+ }
+}
+
+module.exports = {
+ /**
+ * Stops Bot with custom meassage
+ *
+ * @method ircEndCustom
+ * @constructor
+ */
+ ircEndCustom: function (meassage) {
+ bot.disconnect(meassage);
+ },
+ /**
+ * Connects to Server, logs in to NickServ, sets Name
+ *
+ * @method ircPreload
+ */
+ ircPreload: function () {
+ bot.addListener('error', function(message) {
+ setTimeout(function() {
+ console.log("wait 7sek");
+ }, 7000);
+
+ bot.send('nick', botname);
+ for (var key in params_config["servers"]) {
+ if (params_config["servers"].hasOwnProperty(key)) {
+ /**
+ * Password for the NickServ
+ *
+ * @property nickserv_pass
+ * @type String
+ */
+ var nickserv_pass = params_config["servers"][key]["nickserv_pass"];
+ bot.say('NickServ', 'identify ' + nickserv_pass);
+ }
+ }
+ });
+ setTimeout(function() {
+ console.log("wait 7sek");
+ }, 7000);
+ bot.connect(10, function() {
+ bot.send('nick', botname);
+ for (var key in params_config["servers"]) {
+ if (params_config["servers"].hasOwnProperty(key)) {
+ /**
+ * Password for the NickServ
+ *
+ * @property nickserv_pass
+ * @type String
+ */
+ var nickserv_pass = params_config["servers"][key]["nickserv_pass"];
+ /**
+ * Main Channel of the Bot
+ *
+ * @property main_channel
+ * @type String
+ */
+ var main_channel = params_config["servers"][key]["main_channel"];
+ bot.say('NickServ', 'identify ' + nickserv_pass);
+ bot.join(main_channel);
+ }
+ }
+ bot.say(main_channel, 'Door Bot is starting to watch on the Door Status');
+ })
+ },
+ /**
+ * Send DoorStatus to selected Channels
+ *
+ * @method ircSend
+ * @constructor
+ */
+ ircSend: function (door_status) {
+ for (var key in params_config["servers"]) {
+ if (params_config["servers"].hasOwnProperty(key)) {
+ /**
+ * Main Channel of the Bot
+ *
+ * @property main_channel
+ * @type String
+ */
+ var main_channel = params_config["servers"][key]["main_channel"];
+ bot.say(main_channel, 'Door Status changed to: ' + door_status);
+ bot.say("#freifunk-flensburg", 'Door Status changed to: ' + door_status);
+ }
+ }
+ bot.send('topic','#hackerspace "Hackerspace Flensburg - Treffen jeden Montag 18:00 Uhr im Offenen Kanal Flensburg! - Tür Status"' + door_status);
+ console.log("IRC Door Status Chnaged");
+ },
+ /**
+ * Stops Bot with Stop measseagew freom config file
+ *
+ * @method ircStopp
+ */
+ ircStopp: function() {
+ bot.disconnect(disconnect_meassage);
+ },
+ /**
+ * Handels Commands from the Bot
+ *
+ * @method ircBotCommands
+ */
+ ircBotCommands: function() {
+ // Will remove all false values: undefined, null, 0, false, NaN and "" (empty string)
+ function cleanArray(actual) {
+ var newArray = new Array();
+ for (var i = 0; i < actual.length; i++) {
+ if (actual[i]) {
+ newArray.push(actual[i]);
+ }
+ }
+ return newArray;
+ }
+
+ bot.addListener('message', function (from, to, message) {
+ /**
+ * Recived meassage
+ *
+ * @property message
+ * @type String
+ */
+ message = message.toLowerCase();
+ for (var key in command_config["commands"]) {
+ if (command_config["commands"].hasOwnProperty(key)) {
+ console.log("!" + JSON.stringify(command_config["commands"][key]["keyword"]));
+ if (message == ("!" + command_config["commands"][key]["keyword"])) {
+ if (command_config["commands"][key]["before"] == "from") {
+ if (command_config["commands"][key]["target"] == "from") {
+ bot.say(from, from + command_config["commands"][key]["message"]);
+ } else {
+ bot.say(to, from + command_config["commands"][key]["message"]);
+ }
+ } else {
+ if (!command_config["commands"][key]["before"]) {
+ if (command_config["commands"][key]["target"] == "from") {
+ bot.say(from, command_config["commands"][key]["message"]);
+ } else {
+ bot.say(to, command_config["commands"][key]["message"]);
+ }
+ } else {
+ if (command_config["commands"][key]["target"] == "from") {
+ bot.say(from, to + command_config["commands"][key]["message"]);
+ } else {
+ bot.say(to, to + command_config["commands"][key]["message"]);
+ }
+ }
+ }
+ }
+ }
+ }
+ /**
+ * List of Channels on Server
+ *
+ * @property channel
+ * @type Array
+ *
+ * @beta
+ */
+ var channel = message.split(" ");
+ channel = cleanArray(channel);
+ if (channel[0] + " " + channel[1] == "!source this") {
+ console.log("!source " + channel[1]);
+ if (channel[1] == "this") {
+ bot.join(to);
+ bot.say(to, "You can find the Source of this bot at https://github.com/MTRNord/nordlab-hackerspace-door");
+ }
+ }
+ if (message == "!doorstatus") {
+ request.get('http://www.nordlab-ev.de/doorstate/status.txt', function (error, response, body) {
+ if (!error && response.statusCode == 200) {
+ /**
+ * Content of status_page
+ *
+ * @property body
+ * @type String
+ */
+ door_status = body;
+ console.log(body);
+ } else {
+ /**
+ * Fired when an error occurs...
+ *
+ * @property error
+ * @type String
+ */
+ door_status = error;
+ console.log(error);
+ }
+ if (!error && response.statusCode == 200) {
+ if (door_status == "geschlossen") {
+ door_status = "closed";
+ } else {
+ door_status = "open";
+ }
+ console.log(from + ' => ' + to + ': ' + message);
+ bot.say(from, "DoorStatus is: " + door_status);
+ }else{
+ bot.say(from, "DoorStatus is not availible at this time");
+ }
+ }).setMaxListeners(0);
+ }
+ if (channel[0] + " " + channel[1] == "!doorstatus this") {
+ request.get('http://www.nordlab-ev.de/doorstate/status.txt', function (error, response, body) {
+ if (!error && response.statusCode == 200) {
+ /**
+ * Content of status_page
+ *
+ * @property body
+ * @type String
+ */
+ door_status = body;
+ console.log(body);
+ } else {
+ /**
+ * Fired when an error occurs...
+ *
+ * @property error
+ * @type String
+ */
+ door_status = error;
+ console.log(error);
+ }
+ if (!error && response.statusCode == 200) {
+ if (door_status == "geschlossen") {
+ door_status = "closed";
+ } else {
+ door_status = "open";
+ }
+ console.log(message);
+ bot.list();
+ console.log(channel[(channel.length-(channel.length-1))+1]);
+ console.log(channel.length);
+ if (channel[1] !== "this") {
+ if (channel[1] !== " ") {
+ bot.addListener('channellist', function (channel_list) {
+ for (var key in channel_list) {
+ if (channel_list.hasOwnProperty(key)) {
+ if (channel_list[key]["name"] == channel[1]) {
+ bot.join(channel[1]);
+ bot.say(channel[1], "DoorStatus is: " + door_status);
+ }
+ }
+ }
+ });
+ } else {
+ bot.say(from, "DoorStatus is: " + door_status);
+ }
+ } else {
+ bot.join(to);
+ bot.say(to, "DoorStatus is: " + door_status);
+ }
+ }else{
+ bot.say(from, "DoorStatus is not availible at this time");
+ }
+ }).setMaxListeners(0);
+ }
+ if (message == "!kill") {
+ if ((from == "DasNordlicht") || (from == "MTRNord")) {
+ console.log(from + ' => ' + to + ': ' + message);
+ if (process.platform === "win32") {
+ var rl = require("readline").createInterface({
+ input: process.stdin,
+ output: process.stdout
+ });
+ bot.disconnect(disconnect_meassage);
+ process.exit();
+ }
+ }
+ }
+ })
+ },
+ /**
+ * Updates the NickName
+ *
+ * @method ircNick
+ */
+ ircNick: function() {
+ bot.send('nick', botname);
+ }
+};
diff --git a/handlers/pushbullet.js b/handlers/pushbullet.js
@@ -0,0 +1,31 @@
+/**
+ * Pushbullet Module
+ *
+ * @module Main
+ * @submodule pushbullet
+ * @author Marcel Radzio
+ */
+
+//Load needed Features
+var curl = require('curlrequest');
+
+module.exports = {
+ /**
+ * Send Status on change to Pushbullet Channel
+ * @class pushbullet
+ * @constructor
+ */
+ pushbulletSend: function (door_status){
+ curl.request({ url: 'https://api.pushbullet.com/v2/pushes', method: 'POST', headers: { "Access-Token": 'z02rQPOZVBlSkW9pfHgKvaQvBTuXbaTt', "Content-Type": 'application/json' }, data: '{"channel_tag": "space-door", "body":"'+ door_status + '","title":"Door Status","type":"note"}'}, function (err, stdout, meta) {
+ if (err){
+ /**
+ * Fired when an error occurs...
+ *
+ * @property err
+ * @type String
+ */
+ console.log(err);
+ }
+ });
+ }
+};
+\ No newline at end of file
diff --git a/main.js b/main.js
@@ -1,7 +1,7 @@
/**
* Main-functionality for handling the Modules :)
*
- * @main GetData
+ * @main Main
* @module Main
* @author Marcel Radzio
*/
@@ -86,6 +86,7 @@ function GetData(){
}else{
//Save Last Status
door_status2 = door_status;
+ return door_status;
}
}
}
@@ -111,28 +112,40 @@ process.on(SIGINT, function () {
//Activate IRC-Bot Command Handler
irc.ircBotCommands();
-//Handle Updates
-if (!argv.noupdate && autoupdate == 1) {
- //Run update at 3am and 59min
- var j = schedule.scheduleJob('59 3 * * *', function(){
- git.pull("origin", "master", function(err, update) {
- if(update && update.summary.changes) {
- console.log('Start Update!');
-
- console.log('Daily restart!');
- irc.ircEndCustom('Start update! Coming back in a few Seconds!');
- require('child_process').exec('npm restart');
- }
- });
+
+/**
+ * Update - Pull last master from Github
+ *
+ * @method update
+ */
+function update(){
+ git.pull("origin", "master", function(err, update) {
+ if(update && update.summary.changes) {
+ console.log('Start Update!');
+ restart();
+ }
});
}
-if ((argv.noupdate) || (autoupdate == 0)) {
- //Run restart at 3am and 59min if update is disabled on Start
- var k = schedule.scheduleJob('59 3 * * *', function(){
- console.log('Daily restart!');
- irc.ircEndCustom('Daily restart! Coming back in a few Seconds!');
- require('child_process').exec('npm restart');
- });
+
+/**
+ * Restart - Restart the Bot completly
+ *
+ * @method restart
+ */
+function restart(){
+ console.log('Daily restart!');
+ irc.ircEndCustom('Restart! Coming back in a few Seconds!');
+ require('child_process').exec('npm restart');
}
+
+var j = schedule.scheduleJob('59 3 * * *', function(){
+ if (!argv.noupdate && autoupdate == 1) {
+ //Run update at 3am and 59min
+ update();
+ }else{
+ restart();
+ }
+});
+
//Run Mainfunction 20seconds after script start
setTimeout(function() { GetData(); }, 20000);
