Server Side Documentation for #41

Author: prashker

docs/Extensions.md

@@ -11,4 +11,5 @@ In the future we would like to expand quite a few sections in PrashFour IRC Clie
  6. Username typeahead: Currently we are using Bootstrap's typeahead() which always displays the results BELOW the input field (atleast in our CSS where we have absolute positioning), and to work around this we position it relatively a fixed position above, which never makes it look just "right". We could have implemented javascript to make it look right however we'd like to have more adaptive typeahead solution than Bootstrap provides (multiple words, not just the first word, command support, etc)
  7. Easter Eggs: I mean, who doesn't love easter eggs?
  8. A more advanced /list. Currently we're relying on a "message" view to display the list of things. This restricts the way we can display the data visually. We could have created a new view hoever we did not want to clutter how our views work at the moment.
- 9. ROUTER Support: We did not have enough time to implement a router, that is, a #hash based url for each location on the app. Even though there is only one REAL page ("/"), there are other dynamically generated pages, that should be /#/channel/name /#/pm/user, etc. An individual URL for each different window on the navbar (chat window either public or private, or LIST or STATUS)
+ 9. ROUTER Support: We did not have enough time to implement a router, that is, a #hash based url for each location on the app. Even though there is only one REAL page ("/"), there are other dynamically generated pages, that should be /#/channel/name /#/pm/user, etc. An individual URL for each different window on the navbar (chat window either public or private, or LIST or STATUS)
+ 10. SSL support that isn't broken: We have the options to select SSL and "self-signed certificates", unfortunately when we tested it with irc.tawx.net +6697, we couldn't connect...even though this is just as simple as passing the SSL parameters to node-irc, we couldn't diagnose why this didn't work...so it'd be good to fix this, as non-SSL IRC makes us sad.

docs/Files.md

@@ -11,7 +11,7 @@ Files
 
 /views/
 ======
-* index.jade: Loads the javascript files used to manipulate the DOM (Backbone) and access to the templates
+* index.jade: Loads the javascript files used to manipulate the DOM (Backbone) and access to the templates (mainly client.js, which has the others via connect-assets)
 * template.jade: Contains all the templates used to populate the visuals on the client side
 
 /

lib/ircsocketconnect.js

@@ -2,7 +2,7 @@ var irc = require('irc');
 var mongoose = require('mongoose');
 var config = require('../config').config;
 
-// establish models
+// establish models from mongoose model
 var User = mongoose.model('User');
 var Message = mongoose.model('Message');
 
@@ -29,8 +29,8 @@ var IRCSocketConnect = function (hostname, port, ssl, selfSigned, nick, realName
         autoRejoin: rejoin,
         autoConnect: true, //Setting autoConnect to false prevents the Client from connecting on instantiation. You will need to call connect() on the client instance:
         channels: channels, //Starting channels, for this will be null usually (no client fields yet)
-        secure: ssl,
-        selfSigned: selfSigned,
+        secure: ssl, //SORT OF BROKEN
+        selfSigned: selfSigned, //SORT OF BROKEN
         certExpired: false,
         floodProtection: true,
         floodProtectionDelay: 1000,
@@ -45,7 +45,7 @@ var IRCSocketConnect = function (hostname, port, ssl, selfSigned, nick, realName
     }
 
     this.nodeircInstance = new irc.Client(hostname, nick, connectOptions);
-    this.keepAlive = keepAlive;
+    this.keepAlive = keepAlive; //Used when logged in user wants to restore active connection
 
     //All the events that need to be handled and forwarded to socket.io
     //from http://node-irc.readthedocs.org/en/latest/
@@ -85,20 +85,19 @@ var IRCSocketConnect = function (hostname, port, ssl, selfSigned, nick, realName
                 args[arg] = callbackArgs[index]; //taking them, and formatting them the exact way node-irc does, but in an object that can be sent via sockets
             });
 
-            // emit the event (may be more than 1 socket per person)
+            // emit the event
             for (var i = 0; i < that.sockets.length; i++) {
                 that.sockets[i].emit(event, args);
             }
-
-            //Besides sending to client, do server side stuff
 
+            //If it is a message, we want to log that
             if (event == 'message') {
                 if (that.username) {
                     var channelOrUser;
                     if (args.to[0] != '#') //PM workaround
-                        channelOrUser = args.from.toLowerCase();
+                        channelOrUser = args.from.toLowerCase(); //PM, which means to is ME, so we want them
                     else
-                        channelOrUser = args.to.toLowerCase();
+                        channelOrUser = args.to.toLowerCase(); //Normal message, should be #channel
 
                     // log this message
                     that.logMessage(channelOrUser, args.from, args.text);
@@ -108,7 +107,7 @@ var IRCSocketConnect = function (hostname, port, ssl, selfSigned, nick, realName
         });
     };
 
-    //Attach the handlers to node-irc
+    //Attach event handlers for the stuff node-irc spews out
     for (var event in this.events) {
         this.callbackCreator(event, this.events[event]);
     }
@@ -117,12 +116,15 @@ var IRCSocketConnect = function (hostname, port, ssl, selfSigned, nick, realName
 // properties and methods
 IRCSocketConnect.prototype = {
     associateUser: function(username) {
+        //Attach the users username to this instance
         this.username = username;
     },
     connect: function() {
+        //Calls node-irc's connect
         this.nodeircInstance.connect();
     },
     disconnect: function() {
+        //Calls node-irc's disconnect
         this.nodeircInstance.disconnect();
     },
     addSocket: function(socket) {
@@ -136,18 +138,19 @@ IRCSocketConnect.prototype = {
         }
     },
     logMessage: function(channel, fromUser, theMessage) {
+        //If we're logged in
         if (this.username) {
+            //Save the message
             var message = new Message({channel: channel.toLowerCase(), server: this.server.toLowerCase(), ofuser: this.username, user: fromUser, message: theMessage});
             message.save();
 
             // keep log size in check (only need so much backlog for each user
+            //Remove the excess messages (can increase pretty big for a zillion users so we limit it via config.js)
             Message.count({}, function(err, count) {
                 if (count > config.max_log) {
                     //Get the oldest messages
-                    var query = Message.find({}).limit(count - config.max).sort({date: 1});
-
-                    //Remove them                    
-                    query.exec(function (err, records) {
+                    
+                    Message.find({}, null, {sort: {date: 1}, limit: count - config.max}, function (err, records) {
                         records.forEach(function(record){
                             record.remove();
                         });

lib/mongooseschema.js

@@ -23,10 +23,11 @@ module.exports = function() {
     //Users (Logging In System)
     //Messages (backlog for the associated ofuser)
 
+    //lastSession is sesseionKey+IP
     var Users = new Schema({
         username: { type: String , index: {unique: true}},
         password: String,
-        lastSession: {type: String, default: ""}
+        lastSession: {type: String, default: "TECHNICALLYTHISSHOULDNEVERSTAYLIKETHISHOWEVERWHOKNOWSSOIWILLJUSTPUMPITWITHLETTERS"}
     });
 
     var Messages = new Schema({

lib/prashfour.js

@@ -64,6 +64,7 @@ app.configure(function(){
     app.set('mongoose_auth', config.mongoose_auth);
 });
 
+//Single page app, all we need is '/'
 app.get('/', function(req, res){
     res.render('index.jade', {port: app.get('port')});
 });

lib/sockethandler.js

@@ -14,22 +14,27 @@ module.exports = function(socket, allConnections) {
         socket.emit("latencyPONG", {});
     });
 
+    //Checks the state of the database
+    //http://mongoosejs.com/docs/api.html#connection_Connection-readyState
     socket.on('isDatabaseConnected', function(){
         socket.emit('isDatabaseConnected', {state: mongoose.connection.readyState});
     });
 
     socket.on('register', function(data) {
         //Duplicate Username Check
         User.findOne({username: data.username}, function(err, userAlreadyExists) {
+            //No need to check any other details, if it matches username, it is a duplicate
             if (userAlreadyExists) {
                 socket.emit('register_error', {message: 'Username already exists'});
             }
             else {
+                //Generate a session ID
                 var sessID = Math.random().toString(36);
+                //Store it in the DB concatenated with the IP
                 var user = new User({username: data.username, password: passwordHash.generate(data.password), lastSession: sessID + socket.handshake.address.address});
                 user.save(); //Save user in database
                 loggedInUser = user;
-                socket.emit('register_success', {session: sessID});
+                socket.emit('register_success', {session: sessID}); //Pass sessID to client
             }
         });
     });
@@ -68,6 +73,7 @@ module.exports = function(socket, allConnections) {
         });
     });
 
+    //Called when the client has a sessID and calls loginBySession
     socket.on('loginBySession', function (data) {
         User.findOne({lastSession: data.session + socket.handshake.address.address}, function(err, matchingUser) {
             //Found a user
@@ -89,52 +95,62 @@ module.exports = function(socket, allConnections) {
         });    
     });
 
+    //When the client calls connect
     socket.on('connect', function(data) {  
         var connection;
+        
+        //If loggedIn, return the connection that exists
         if (loggedInUser) {
             connection = allConnections[loggedInUser.username];
         }
+        
+        //Create a new connection with the data specified if it wasn't
         if (connection === undefined) {
             connection = new IRCSocketConnect(data.server, data.port, data.secure, data.selfSigned, data.nick, data.realName, data.password, data.rejoin, data.encoding, data.keepAlive);
 
             // save this connection
+            // associate if they are logged in
             if (loggedInUser) {
                 // bind this socket to the proper IRC instance
                 connection.associateUser(loggedInUser.username);
                 allConnections[loggedInUser.username] = connection;
             }
         } 
         else {
-            if (!connection.keepAlive) {
-                connection.connect();
-            }
+            //Notify the client of the previous connection, with the channel, server, and nick associated with the connection
             socket.emit('previous_connection', {
                 nick: connection.nodeircInstance.nick,
                 server: connection.nodeircInstance.opt.server, 
                 channels: connection.nodeircInstance.chans
             });
         }
 
-        // register this socket with our user's IRC connection (multiple sockets means multiple windows!)
+        // register this socket with our user's IRC connection
         connection.addSocket(socket);
 
         // Socket events sent FROM the front-end
+        //Join #chan or "chan" -> #chan        
         socket.removeAllListeners('join');
         socket.on('join', function(name) {
             if (name[0] != '#') {
                 name = '#' + name;
             }
+            //Calls join
             connection.nodeircInstance.join(name);
         });
 
+        //Part channel
+        //Part #chan or "chan" -> #chan
         socket.removeAllListeners('part');
         socket.on('part', function(name) {
             if (name[0] != '#') {
                 name = '#' + name;
             }
+            //Calls part
             connection.nodeircInstance.part(name);
         });
 
+        //Clients sends a message
         socket.removeAllListeners('say');
         socket.on('say', function(data) {
             //send it
@@ -146,6 +162,7 @@ module.exports = function(socket, allConnections) {
             }
         });
 
+        //ACTION command
         socket.removeAllListeners('action');
         socket.on('action', function(data) {
             connection.nodeircInstance.action(data.target, data.message);
@@ -156,8 +173,10 @@ module.exports = function(socket, allConnections) {
             );
         });
 
+        //CHANGE of TOPIC via Client
         socket.removeAllListeners('topic');
         socket.on('topic', function(data) {
+            //No handling if they have the permissions, assumes they are OP (will error if not, but won't report to client)
             connection.nodeircInstance.send('TOPIC ', data.name, data.topic);
         });
 
@@ -172,6 +191,7 @@ module.exports = function(socket, allConnections) {
             connection.nodeircInstance.opt.nick = data.newNick;
         });
 
+        //WHOIS call
         socket.removeAllListeners('whois');
         socket.on('whois', function(data) {
             //Do a WHOIS on NICK
@@ -207,13 +227,15 @@ module.exports = function(socket, allConnections) {
                 allConnections[loggedInUser.username] = undefined;
                 loggedInUser = null;
             }
-
+            
+            //Manually disconnected via client end, tell client to go back to main menu via reset
             socket.emit('reset');
         });
 
         socket.removeAllListeners('getOldMessages');
         socket.on('getOldMessages', function(data) {
             if (loggedInUser) {
+                //Query to get messages in a channel on a certain network of a certain username
                 Message.find({channel: data.channelName.toLowerCase(), server: connection.server.toLowerCase(), ofuser: loggedInUser.username}, null, {skip: data.skip, sort: {date: -1}, limit: data.amount}, function (err, docs) {
                     if (docs && docs.length > 0) {
                         var returnData = {
@@ -226,12 +248,12 @@ module.exports = function(socket, allConnections) {
             }
         });
 
+        //List for the server
         socket.removeAllListeners('list');
         socket.on('list', function (data) {
-            connection.nodeircInstance.list(); //takes an array of arguments
+            //LONG RUNNING
+            connection.nodeircInstance.list(); //takes an array of arguments, but we don't pass it (not needed)
         });
 
-        
-        
     });
 }