Skip to content

Commit

Permalink
added better comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Matt Scandalis committed Feb 11, 2013
1 parent 07b7f2e commit b739ea3
Show file tree
Hide file tree
Showing 2 changed files with 164 additions and 155 deletions.
136 changes: 70 additions & 66 deletions kyoshi-client.js
View file
@@ -1,67 +1,71 @@
/*
* Copyright (c) 2013 Matthew Scandalis
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/

//Kyoshi-client.js

var kyoshi = function () {
var socket = io.connect(location.protocol+'//'+location.hostname);
var id = 0;
return function (file, callback) {
socket.once('__init', function(err, options, connId) {
if(err) {
console.log(err);
return;
}
var exports = {};
exports.id = connId;
exports.on = function(name, callback) {
socket.on(name, callback);
}
options.forEach(function (i) {
exports[i] = function () {
var params = {};
Array.prototype.slice.call(arguments).forEach(function (argument, j) {
if(typeof argument === 'function') {
params[j] = {
type: 'function',
id: id
};
socket.on(id, function(data) {
argument.apply(null, data);
});
id++;
}
else {
params[j] = {
type: 'param',
value: argument
}
}
});
socket.emit(file+i, params);
};
});
callback(exports);
})
socket.emit('__init', file);
}
/*
* Copyright (c) 2013 Matthew Scandalis
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/

//Kyoshi-client.js

var kyoshi = function () {
//connect to the host
var socket = io.connect(location.protocol+'//'+location.hostname);
var id = 0;
return function (file, callback) {
socket.once('__init', function(err, options, connId) {
if(err) {
console.log(err);
return;
}
var exports = {};
exports.id = connId;
exports.on = function(name, callback) {
socket.on(name, callback);
}
//Build dummy functions from list of functions exposed in the user's js file
options.forEach(function (i) {
exports[i] = function () {
var params = {};
Array.prototype.slice.call(arguments).forEach(function (argument, j) {
if(typeof argument === 'function') {
//build a function with a unique id to be used by the server as a callback
params[j] = {
type: 'function',
id: id
};
socket.on(id, function(data) {
argument.apply(null, data);
});
id++;
}
else {
params[j] = {
type: 'param',
value: argument
}
}
});
//emit the function name and arguments back to the server
socket.emit(file+i, params);
};
});
callback(exports);
})
socket.emit('__init', file);
}
}();
183 changes: 94 additions & 89 deletions kyoshi-node.js
View file
@@ -1,90 +1,95 @@
/*
* Copyright (c) 2013 Matthew Scandalis
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/

//Kyoshi-node.js
var path = require('path');
var listen = function (app, contentPath) {
var listeners = app.listeners('request').splice(0);
app.removeAllListeners('request');
app.on('request', function (req, res) {
if (req.url == '/kyoshi.js') {
var stream = require('fs').createReadStream(path.join(path.dirname(module.filename),'kyoshi-client.js'));
stream.on('data', function (chunk) {
res.write(chunk);
});
stream.on('end', function () {
res.end();
});
return;
}
listeners.forEach(function (listener) {
listener.call(app, req, res);
});
});
var io = require('socket.io').listen(app, {log: false});
io.sockets.on('connection', function (socket) {
socket.on('__init', function (filename) {
socket.join(filename);
if(filename.match(/^.+\.js$/)) {
try {
console.log(path.join(process.cwd(),contentPath,filename));
var module = require(path.join(process.cwd(),contentPath,filename));
var exports = Object.getOwnPropertyNames(module);
module.sockets = function () {
return io.sockets.in(filename);
};
exports.forEach(function (value) {
socket.on(filename+value, function (args) {
var params = [];
for (i in args) {
params.push(args[i]);
}
params.forEach(function (arg, index) {
if (arg.type == 'function') {
params[index] = function () {
socket.emit(arg.id, Array.prototype.slice.call(arguments));
}
}
else {
params[index] = arg.value;
}
});
module[value].apply(module, params);
});
});
if (module.connect) module.connect(socket.id);
if (module.disconnect) socket.on('disconnect', function () {
module.disconnect(socket.id);
});
socket.emit('__init', null, exports, socket.id);
}
catch (e) {
socket.emit('__init', e, null);
}
}
else {
socket.emit('__init', 'You can only use Kyoshi.js on .js files!', null);
}
});
});
}
/*
* Copyright (c) 2013 Matthew Scandalis
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/

//Kyoshi-node.js
var path = require('path');
var listen = function (app, contentPath) {
//Adds a listener at the begining of the listener list to intercept the request to '/kyoshi.js' and serve up its version.
var listeners = app.listeners('request').splice(0);
app.removeAllListeners('request');
app.on('request', function (req, res) {
if (req.url == '/kyoshi.js') {
var stream = require('fs').createReadStream(path.join(path.dirname(module.filename),'kyoshi-client.js'));
stream.on('data', function (chunk) {
res.write(chunk);
});
stream.on('end', function () {
res.end();
});
}
});
listeners.forEach(function (listener) {
app.on('request', listener);
});
//Start the websocket listener
var io = require('socket.io').listen(app, {log: false});
io.sockets.on('connection', function (socket) {
//wait for the initial connection
socket.on('__init', function (filename) {
//join a room corresponding to the file
socket.join(filename);
if(filename.match(/^.+\.js$/)) {
try {
//load the user's js file as a module so its preserved in the cache
var module = require(path.join(process.cwd(),contentPath,filename));
var exports = Object.getOwnPropertyNames(module);
//give it access to sockets accessing the file
module.sockets = function () {
return io.sockets.in(filename);
};
//build the function to catch the messages from the client and handle the function calls
exports.forEach(function (value) {
socket.on(filename+value, function (args) {
var params = [];
for (i in args) {
params.push(args[i]);
}
params.forEach(function (arg, index) {
if (arg.type == 'function') {
params[index] = function () {
socket.emit(arg.id, Array.prototype.slice.call(arguments));
}
}
else {
params[index] = arg.value;
}
});
module[value].apply(module, params);
});
});
if (module.connect) module.connect(socket.id);
if (module.disconnect) socket.on('disconnect', function () {
module.disconnect(socket.id);
});
socket.emit('__init', null, exports, socket.id);
}
catch (e) {
socket.emit('__init', e, null);
}
}
else {
socket.emit('__init', 'You can only use Kyoshi.js on .js files!', null);
}
});
});
}
exports.listen = listen;

0 comments on commit b739ea3

Please sign in to comment.