Add socket.io for challenge notifications

-  using static localhost:3001
(see juice-shop#206)

Author: bkimminich

Dockerfile

@@ -7,5 +7,5 @@ RUN cd /juice-shop; npm install; ./node_modules/.bin/bower install; ./node_modul
 
 WORKDIR /juice-shop
 
-EXPOSE  3000
+EXPOSE  3000 3001
 CMD npm start

app/index.html

@@ -45,6 +45,7 @@
     <script src="bower_components/angular-bootstrap/ui-bootstrap-tpls.min.js"></script>
     <script src="bower_components/ng-file-upload/ng-file-upload-shim.min.js"></script> <!-- for no html5 browsers support -->
     <script src="bower_components/ng-file-upload/ng-file-upload.min.js"></script>
+    <script src="bower_components/socket.io-client/socket.io.js"></script>
 
     <!--  application specific source files -->
     <script src="dist/juice-shop.min.js"></script>
@@ -117,6 +118,14 @@
     </div>
 </nav>
 
+<script>
+    var socket = io('localhost:3001') // TODO Exchange with URL retrieved through SocketController
+    socket.on('solved', function (data) {
+        console.log(data)
+    })
+</script>
+
+
 <h1 class="hidden">OWASP Juice Shop</h1><!-- for SEO -->
 
 <!-- CONTENT -->

app/js/controllers/SocketController.js

@@ -0,0 +1,16 @@
+angular.module('juiceShop').controller('SocketController', [
+  '$scope',
+  'AdministrationService',
+  function ($scope, administrationService) {
+    'use strict'
+
+    $scope.url = ''
+
+    administrationService.getSocketUrl().success(function (data) {
+      if (data && data.url) {
+        $scope.url = data.url
+      }
+    }).error(function (err) {
+      console.log(err)
+    })
+  }])

app/js/services/AdministrationService.js

@@ -7,7 +7,12 @@ angular.module('juiceShop').factory('AdministrationService', ['$http', function
     return $http.get(host + '/application-version')
   }
 
+  function getSocketUrl () {
+    return $http.get(host + '/socket.io')
+  }
+
   return {
-    getApplicationVersion: getApplicationVersion
+    getApplicationVersion: getApplicationVersion,
+    getSocketUrl: getSocketUrl
   }
 }])

bower.json

@@ -23,7 +23,8 @@
     "fontawesome": "~4.6",
     "angular-translate": "^2.12.1",
     "angular-translate-loader-static-files": "^2.12.1",
-    "flag-icon-css": "^2.5.0"
+    "flag-icon-css": "^2.5.0",
+    "socket.io-client": "^1.4.8"
   },
   "resolutions": {
     "angular": "~1.5"

karma.conf-ci.js

@@ -57,6 +57,7 @@ module.exports = function (config) {
       'app/bower_components/underscore/underscore.js',
       'app/bower_components/jquery/dist/jquery.js',
       'app/bower_components/ng-file-upload/ng-file-upload.js',
+      'app/bower_components/socket.io-client/socket.io.js',
       'app/js/app.js',
       'app/js/**/*.js',
       'test/client/**/*.js'

karma.conf.js

@@ -18,6 +18,7 @@ module.exports = function (config) {
       'app/bower_components/underscore/underscore.js',
       'app/bower_components/jquery/dist/jquery.js',
       'app/bower_components/ng-file-upload/ng-file-upload.js',
+      'app/bower_components/socket.io-client/socket.io.js',
       'app/js/**/*.js',
       'test/client/**/*.js'
     ],

lib/utils.js

@@ -4,7 +4,10 @@
 var colors = require('colors/safe')
 var packageJson = require('../package.json')
 
-var months = ['JAN', 'FEB', 'MAR', 'APR', 'MAY', 'JUN', 'JUL', 'AUG', 'SEP', 'OCT', 'NOV', 'DEC']
+exports.ioPort = process.env.IO_PORT || 3001
+var io = require('socket.io')(this.ioPort, { origins: '*:*' })
+
+var months = [ 'JAN', 'FEB', 'MAR', 'APR', 'MAY', 'JUN', 'JUL', 'AUG', 'SEP', 'OCT', 'NOV', 'DEC' ]
 
 exports.queryResultToJson = function (data, status) {
   var wrappedData = {}
@@ -14,7 +17,7 @@ exports.queryResultToJson = function (data, status) {
     } else if (data.length > 0) {
       wrappedData = []
       for (var i = 0; i < data.length; i++) {
-        wrappedData.push(data[i].dataValues ? data[i].dataValues : data[i])
+        wrappedData.push(data[ i ].dataValues ? data[ i ].dataValues : data[ i ])
       }
     } else {
       wrappedData = data
@@ -48,7 +51,7 @@ exports.unquote = function (str) {
 
 exports.version = function (module) {
   if (module) {
-    return packageJson.dependencies[module]
+    return packageJson.dependencies[ module ]
   } else {
     return packageJson.version
   }
@@ -58,6 +61,7 @@ exports.solve = function (challenge) {
   challenge.solved = true
   challenge.save().success(function () {
     console.log(colors.green('Solved') + ' challenge ' + colors.cyan(challenge.name) + ' (' + challenge.description + ')')
+    io.emit('solved', { challenge: challenge })
   })
 }
 
@@ -68,5 +72,5 @@ exports.notSolved = function (challenge) {
 exports.toMMMYY = function (date) {
   var month = date.getMonth()
   var year = date.getFullYear()
-  return months[month] + year.toString().substring(2, 4)
+  return months[ month ] + year.toString().substring(2, 4)
 }

package.json

@@ -41,6 +41,7 @@
     "sequelize-restful": "~0.4",
     "serve-favicon": "~2.3",
     "serve-index": "~1.8",
+    "socket.io": "^1.4.8",
     "sqlite3": "3.1",
     "z85": "~0.0"
   },

routes/socketUrl.js

@@ -0,0 +1,9 @@
+'use strict'
+
+var utils = require('../lib/utils')
+
+exports = module.exports = function socketUrl () {
+  return function (req, res) {
+    res.json({url: req.protocol + '://' + req.hostname + ':' + utils.ioPort})
+  }
+}