From 320b143687a642aa2b71e9c51ea379bd807a0f5f Mon Sep 17 00:00:00 2001
From: David Cormier <david.cormier@savoirfairelinux.com>
Date: Sun, 4 Aug 2013 22:25:59 -0400
Subject: [PATCH] Removes console.log calls and adds amazing comments

---
 js/protocol.js   | 19 -------------------
 js/websockets.js | 35 +++++++++++++++++------------------
 2 files changed, 17 insertions(+), 37 deletions(-)

diff --git a/js/protocol.js b/js/protocol.js
index ba4e8a7..ea6dda8 100644
--- a/js/protocol.js
+++ b/js/protocol.js
@@ -1,23 +1,6 @@
 var Protocol = function() {
         var self = this;
 
-        self.isEvent = function(receivedMessage) {
-            /* 
-             * Determines whether or not the received message
-             * is an event.
-             *
-             * Right now, only the presence of an id is checked,
-             * as messages from the client don't specify the ID
-             *
-             * FIXME: check content of the id to dermine if message is an event
-             */  
-            if (receivedMessage['id']) {
-                return true;
-            } else {
-                return false;
-            }
-        }
-
         var getInfo = function() {
             var info = {};
             info.key = getString();
@@ -144,8 +127,6 @@ var Protocol = function() {
                 objects.push(object);
                 object = getObject();
             }
-	    console.log("Received message");
-	    console.log(header, id, objects);
             return {
                 header: header,
                 id: id,
diff --git a/js/websockets.js b/js/websockets.js
index 66f9e0f..782efc8 100644
--- a/js/websockets.js
+++ b/js/websockets.js
@@ -105,7 +105,6 @@ weechat.factory('colors', [function($scope) {
 weechat.factory('handlers', ['$rootScope', 'colors', function($rootScope, colors) {
 
     var handleBufferLineAdded = function(message) {
-
         var buffer_line = {}
         var prefix = colors.parse(message['objects'][0]['content'][0]['prefix']);
         var text = colors.parse(message['objects'][0]['content'][0]['message']);
@@ -113,19 +112,21 @@ weechat.factory('handlers', ['$rootScope', 'colors', function($rootScope, colors
         var message = _.union(prefix, text);
         buffer_line['message'] = message;
         buffer_line['metadata'] = findMetaData(text[0]['text']);
-
-
         $rootScope.buffers[buffer]['lines'].push(buffer_line);
     }
 
     var handleBufferOpened = function(message) {
-        console.log('buffer opened');
         var fullName = message['objects'][0]['content'][0]['full_name']
         var buffer = message['objects'][0]['content'][0]['pointers'][0]
         $rootScope.buffers[buffer] = { 'lines':[], 'full_name':fullName }
-        console.log($rootScope.buffers);
     }
 
+    /*
+     * Handle answers to (bufinfo) messages
+     *
+     * (bufinfo) messages are specified by this client. It is the first
+     * message that is sent to the relay after connection.
+     */
     var handleBufferInfo = function(message) {
         // buffer info from message
         var bufferInfos = message['objects'][0]['content'];
@@ -143,7 +144,6 @@ weechat.factory('handlers', ['$rootScope', 'colors', function($rootScope, colors
 
 
     var handleEvent = function(message) {
-        console.log(message);
         types[message['id']](message);
     }
 
@@ -170,24 +170,28 @@ weechat.factory('handlers', ['$rootScope', 'colors', function($rootScope, colors
 
 }]);
 
-weechat.factory('connection', ['$rootScope', '$http', 'handlers', 'colors', function($rootScope, $http, handlers, colors) {
+weechat.factory('connection', ['$rootScope', '$log', 'handlers', 'colors', function($rootScope, $log, handlers, colors) {
     protocol = new Protocol();
     var websocket = null;
 
-    var doSend = function(message) {
 
+    // Sanitizes messages to be sent to the weechat relay    
+    var doSend = function(message) {
         msgs = message.replace(/[\r\n]+$/g, "").split("\n");
         for (var i = 0; i < msgs.length; i++) {
-            console.log('=' + msgs[i] + '=');
+            $log.log('=' + msgs[i] + '=');
             $rootScope.commands.push("SENT: " + msgs[i]);
         }
         websocket.send(message);
     }
+    
+    // Takes care of the connection and websocket hooks
     var connect = function (hostport, proto, password) {
         websocket = new WebSocket("ws://" + hostport + "/weechat");
         websocket.binaryType = "arraybuffer"
 
         websocket.onopen = function (evt) {
+            // FIXME: does password need to be sent only if protocol is not weechat?
             if (proto == "weechat") {
                 doSend("init compression=off\nversion\n");
                 doSend("(bufinfo) hdata buffer:gui_buffers(*) full_name\n");
@@ -195,27 +199,26 @@ weechat.factory('connection', ['$rootScope', '$http', 'handlers', 'colors', func
             } else {
                 doSend("PASS " + password + "\r\nNICK test\r\nUSER test 0 * :test\r\n");
             }
+            $log.info("Connected to relay");
             $rootScope.connected = true;
             $rootScope.$apply();
         }
 
         websocket.onclose = function (evt) {
-            console.log("disconnected", "Disconnected");
+            $log.info("Disconnected from relay");
             $rootScope.connected = false;
+            $rootScope.$apply();
         }
 
         websocket.onmessage = function (evt) {
-
 	    message = protocol.parse(evt.data)
             handlers.handleEvent(message);
-
             $rootScope.commands.push("RECV: " + evt.data + " TYPE:" + evt.type) ;
             $rootScope.$apply();
         }
 
-
         websocket.onerror = function (evt) {
-            console.log("error", "ERROR: " + evt.data);
+            $log.error("Relay error " + evt.data);
         }
 
         this.websocket = websocket;
@@ -223,12 +226,9 @@ weechat.factory('connection', ['$rootScope', '$http', 'handlers', 'colors', func
 
     var sendMessage = function(message) {
         message = "input " + $rootScope.activeBuffer['full_name'] + " " + message + "\n"
-        console.log($rootScope.activeBuffer);
         doSend(message);
     }
 
-
-
     return {
         connect: connect,
         sendMessage: sendMessage
@@ -246,7 +246,6 @@ weechat.controller('WeechatCtrl', ['$rootScope', '$scope', 'connection', functio
     $scope.password = ""
 
     $scope.setActiveBuffer = function(key) {
-        console.log('change buffer');
         $rootScope.activeBuffer = $rootScope.buffers[key];
     };