From dbc2635498240504a780e84ed4281ef1b171ed32 Mon Sep 17 00:00:00 2001 From: Gergely Lekli Date: Sat, 2 Jan 2016 09:25:19 -0800 Subject: [PATCH] Issue #1261066: Remove node.js code. Make compatibility updates for new server app. --- nodejs.config.js.example | 114 ---- nodejs.module | 55 +- nodejs.server.extension.js.example | 32 - package.json | 14 - server.js | 1248 ------------------------------------ 5 files changed, 38 insertions(+), 1425 deletions(-) delete mode 100644 nodejs.config.js.example delete mode 100644 nodejs.server.extension.js.example delete mode 100644 package.json delete mode 100644 server.js diff --git a/nodejs.config.js.example b/nodejs.config.js.example deleted file mode 100644 index 7ba268f..0000000 --- a/nodejs.config.js.example +++ /dev/null @@ -1,114 +0,0 @@ -/** - * The settings hash defines configuration settings for server.js, the server - * code executed by node. - * - * The following properties should be defined for the settings variable: - * - * scheme: 'http' or 'https'. This defines whether the node server should - * contact the Drupal site using http or https. If https is used, the key and - * cert must be set to valid files. - * - * port: Specify the TCP port that the node server should listen on. - * - * host: Specify the host name or IP address that the node server should listen - * on. Leave blank to listen for any host name. Otherwise, the server will only - * respond to names that match the IP address given (or resolved from the given - * name). - * - * resource: http path that the node server should respond to. This value needs - * to match the Drupal node.js configuration. - * - * serviceKey: An arbitrary string used as a secret between the node.js server - * and the Drupal site. - * - * debug: Whether to write a bunch of debug information to the console. false - * by default. - * - * baseAuthPath: base path for all requests from the backend. This is used to - * set the authentication call for all requests from the backend. - * - * sslKeyPath: File system path to a key used for https communication with the server - * and clients. - * - * sslCertPath: File system path to a certificate used for https communication with the - * server and clients. - * - * sslCAPath: File system path to a file containing trusted certificates. - * - * sslPassPhrase: SSL passphrase, will be passed in the passphrase key to the https - * server if set. - * - * publishUrl: http path on which the node server should accept messages from - * the Drupal site. - * - * backend: An object with the following properties: - * - * -- port: TCP port of the server running the Drupal site. Usually 80. - * - * -- host: Host name of the Drupal site. - * - * -- messagePath: http path on which the Drupal node.js module listens for - * messages from the Node.js server process. - * - * -- basePath: the base path of your backend site, defaults to '/'. - * - * -- scheme: either 'http' or 'https', defaults to 'http'. - * - * -- httpAuth: a username and password in the form 'username:password' - * - * -- strictSSL: boolean, whether to be strict with SSL cert, default false. - * - * extensions: An array of names of node.js modules that should be loaded as - * extensions to the node.js server. - * - * clientsCanWriteToClients: global flag that allows all clients to be written - * to by client sockets without going via the backend. defaults to false. - * - * transports: a list of transports to be used by Socket.Io. - * - * jsMinification: whether to call io.enable('browser client minification'). - * - * jsEtag: whether to call io.enable('browser client etag'). - * - * logLevel: the log level to be used by Socket.Io. - */ -settings = { - scheme: 'http', - port: 8080, - host: 'localhost', - resource: '/socket.io', - serviceKey: '', - backend: { - port: 80, - host: 'drupalhost', - scheme: 'http', - basePath: '', - messagePath: '/nodejs/message' - }, - debug: false, - sslKeyPath: '', - sslCertPath: '', - sslCAPath: '', - baseAuthPath: '/nodejs/', - publishUrl: 'publish', - kickUserUrl: 'user/kick/:uid', - logoutUserUrl: 'user/logout/:authtoken', - addUserToChannelUrl: 'user/channel/add/:channel/:uid', - removeUserFromChannelUrl: 'user/channel/remove/:channel/:uid', - addChannelUrl: 'channel/add/:channel', - removeChannelUrl: 'channel/remove/:channel', - setUserPresenceListUrl: 'user/presence-list/:uid/:uidList', - addAuthTokenToChannelUrl: 'authtoken/channel/add/:channel/:uid', - removeAuthTokenFromChannelUrl: 'authtoken/channel/remove/:channel/:uid', - toggleDebugUrl: 'debug/toggle', - contentTokenUrl: 'content/token', - publishMessageToContentChannelUrl: 'content/token/message', - extensions: [], - clientsCanWriteToChannels: false, - clientsCanWriteToClients: false, - transports: ['websocket', 'polling'], - jsMinification: true, - jsEtag: true, - logLevel: 1 -}; - diff --git a/nodejs.module b/nodejs.module index 153e5ab..d62b54e 100644 --- a/nodejs.module +++ b/nodejs.module @@ -42,7 +42,7 @@ function nodejs_send_content_channel_token($channel, $notify_on_disconnect = FAL // Http request went ok, process Node.js server response. if ($node_response = Nodejs::sendContentToken($message)) { - if ($node_response->status == 'ok') { + if ($node_response->status == 'success') { // We always set this in drupal.settings, even though Ajax requests will not // see it. It's a bit ugly, but it means that setting the tokens for full // page requests will just work. @@ -779,12 +779,9 @@ class Nodejs { public static $baseUrl = NULL; - public static $headers = NULL; - public static function initConfig() { if (!isset(self::$config)) { self::$config = nodejs_get_config(); - self::$headers = array('NodejsServiceKey' => self::$config['serviceKey']); self::$baseUrl = nodejs_get_url(self::$config); } } @@ -810,7 +807,6 @@ class Nodejs { $options = array( 'method' => 'POST', 'data' => drupal_json_encode($message), - 'headers' => self::$headers, // This is server to server, so start with a low default timeout. 'timeout' => !empty(self::$config['timeout']) ? self::$config['timeout'] : 5, ); @@ -819,12 +815,15 @@ class Nodejs { public static function setUserPresenceList($uid, array $uids) { self::initConfig(); - return self::httpRequest("nodejs/user/presence-list/$uid/" . implode(',', $uids), array('headers' => self::$headers)); + return self::httpRequest("nodejs/user/presence-list/$uid/" . implode(',', $uids)); } public static function logoutUser($token) { self::initConfig(); - return self::httpRequest("nodejs/user/logout/$token", array('headers' => self::$headers)); + $options = array( + 'method' => 'POST', + ); + return self::httpRequest("nodejs/user/logout/$token", $options); } public static function sendContentTokenMessage($message) { @@ -834,7 +833,6 @@ class Nodejs { $options = array( 'method' => 'POST', 'data' => drupal_json_encode($message), - 'headers' => self::$headers, 'options' => array('timeout' => 5.0), ); return self::httpRequest('nodejs/content/token/message', $options); @@ -845,7 +843,6 @@ class Nodejs { $options = array( 'method' => 'POST', 'data' => drupal_json_encode($message), - 'headers' => self::$headers, ); return self::httpRequest('nodejs/content/token', $options); } @@ -855,43 +852,67 @@ class Nodejs { $options = array( 'method' => 'POST', 'data' => drupal_json_encode($message), - 'headers' => self::$headers, ); return self::httpRequest('nodejs/content/token/users', $options); } public static function kickUser($uid) { self::initConfig(); - return self::httpRequest("nodejs/user/kick/$uid", array('headers' => self::$headers)); + $options = array( + 'method' => 'POST', + ); + return self::httpRequest("nodejs/user/kick/$uid", $options); } public static function addUserToChannel($uid, $channel) { self::initConfig(); - return self::httpRequest("nodejs/user/channel/add/$channel/$uid", array('headers' => self::$headers)); + $options = array( + 'method' => 'POST', + ); + return self::httpRequest("nodejs/user/channel/add/$channel/$uid", $options); } public static function removeUserFromChannel($uid, $channel) { self::initConfig(); - return self::httpRequest("nodejs/user/channel/remove/$channel/$uid", array('headers' => self::$headers)); + $options = array( + 'method' => 'POST', + ); + return self::httpRequest("nodejs/user/channel/remove/$channel/$uid", $options); } public static function addChannel($channel) { self::initConfig(); - return self::httpRequest("nodejs/channel/add/$channel", array('headers' => self::$headers)); + $options = array( + 'method' => 'POST', + ); + return self::httpRequest("nodejs/channel/add/$channel", $options); } public static function checkChannel($channel) { self::initConfig(); - return self::httpRequest("nodejs/channel/check/$channel", array('headers' => self::$headers)); + return self::httpRequest("nodejs/channel/check/$channel"); } public static function removeChannel($channel) { self::initConfig(); - return self::httpRequest("nodejs/channel/remove/$channel", array('headers' => self::$headers)); + $options = array( + 'method' => 'POST', + ); + return self::httpRequest("nodejs/channel/remove/$channel", $options); } - public static function httpRequest($url, $options) { + public static function httpRequest($url, $options = array()) { self::initConfig(); + + $options += array( + 'method' => 'GET', + 'headers' => array(), + ); + $options['headers'] += array( + 'NodejsServiceKey' => self::$config['serviceKey'], + 'Content-type' => 'application/json', + ); + $response = drupal_http_request(self::$baseUrl . $url, $options); // If a http error occurred, and logging of http errors is enabled, log it. if (isset($response->error)) { diff --git a/nodejs.server.extension.js.example b/nodejs.server.extension.js.example deleted file mode 100644 index be9b989..0000000 --- a/nodejs.server.extension.js.example +++ /dev/null @@ -1,32 +0,0 @@ -/** - * Example server extension for nodejs - * - * With this extension loaded, a message is written to the console when a client - * connects, is authenticated, sends a message, or disconnects. - * - * If you have the nodejs_notify module enabled, users are also shown a message - * when they connect, are authenticated, or send a message. - */ - -var publishMessageToClient; - -exports.setup = function (config) { - publishMessageToClient = config.publishMessageToClient; - - process.on('client-connection', function (sessionId) { - console.log('Example extension got connection event for session ' + sessionId); - publishMessageToClient(sessionId, {data: {subject: 'Example extension', body: 'Hello, you just connected.'}}); - }) - .on('client-authenticated', function (sessionId, authData) { - console.log('Example extension got authenticated event for session ' + sessionId + ' (user ' + authData.uid + ')'); - publishMessageToClient(sessionId, {data: {subject: 'Example extension', body: 'Welcome, you are authenticated.'}}); - }) - .on('client-message', function (sessionId, message) { - console.log('Example extension got message event for session ' + sessionId); - publishMessageToClient(sessionId, {data: {subject: 'Example extension', body: 'You sent the message: ' + require('util').inspect(message)}}); - }) - .on('client-disconnect', function (sessionId) { - console.log('Example extension got disconnect event for session ' + sessionId); - }); -}; - diff --git a/package.json b/package.json deleted file mode 100644 index cdf2b81..0000000 --- a/package.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "name": "Drupal-Node.js", - "description": "Push notifications from Drupal.", - "version": "1.0.2", - "homepage": "https://drupal.org/project/nodejs", - "engines": { - "node": "0.10.x" - }, - "dependencies": { - "express": "3.x", - "request": "2.36", - "socket.io": "1.x" - } -} diff --git a/server.js b/server.js deleted file mode 100644 index 472b473..0000000 --- a/server.js +++ /dev/null @@ -1,1248 +0,0 @@ -/** - * Provides Node.js - Drupal integration. - */ - -var request = require('request'), - url = require('url'), - fs = require('fs'), - http = require('http'), - https = require('https'), - express = require('express'), - util = require('util'), - querystring = require('querystring'), - vm = require('vm'); - -var channels = {}, - authenticatedClients = {}, - sockets = {}, - onlineUsers = {}, - presenceTimeoutIds = {}, - contentChannelTimeoutIds = {}, - tokenChannels = {}, - settingsDefaults = { - scheme: 'http', - port: 8080, - host: 'localhost', - resource: '/socket.io', - serviceKey: '', - debug: false, - baseAuthPath: '/nodejs/', - publishUrl: 'publish', - kickUserUrl: 'user/kick/:uid', - logoutUserUrl: 'user/logout/:authtoken', - addUserToChannelUrl: 'user/channel/add/:channel/:uid', - removeUserFromChannelUrl: 'user/channel/remove/:channel/:uid', - addChannelUrl: 'channel/add/:channel', - checkChannelUrl: 'channel/check/:channel', - removeChannelUrl: 'channel/remove/:channel', - setUserPresenceListUrl: 'user/presence-list/:uid/:uidList', - addAuthTokenToChannelUrl: 'authtoken/channel/add/:channel/:uid', - removeAuthTokenFromChannelUrl: 'authtoken/channel/remove/:channel/:uid', - toggleDebugUrl: 'debug/toggle', - contentTokenUrl: 'content/token', - publishMessageToContentChannelUrl: 'content/token/message', - getContentTokenUsersUrl: 'content/token/users', - extensions: [], - clientsCanWriteToChannels: false, - clientsCanWriteToClients: false, - transports: ['websocket', 'polling'], - jsMinification: true, - jsEtag: true, - backend: { - host: 'localhost', - scheme: 'http', - port: 80, - basePath: '/', - strictSSL: false, - messagePath: 'nodejs/message', - httpAuth: '' - }, - logLevel: 1 - }, - extensions = []; - -var configFile = process.cwd() + '/nodejs.config.js'; -if (process.argv[2]) { - configFile = process.argv[2]; -} -try { - var settings = vm.runInThisContext(fs.readFileSync(configFile)); -} -catch (exception) { - console.log("Failed to read config file, exiting: " + exception); - process.exit(1); -} - -for (var key in settingsDefaults) { - if (key != 'backend' && !settings.hasOwnProperty(key)) { - settings[key] = settingsDefaults[key]; - } -} - -if (!settings.hasOwnProperty('backend')) { - settings.backend = settingsDefaults.backend; -} -else { - for (var key2 in settingsDefaults.backend) { - if (!settings.backend.hasOwnProperty(key2)) { - settings.backend[key2] = settingsDefaults.backend[key2]; - } - } -} - -// Load server extensions -for (var i in settings.extensions) { - try { - // Load JS files for extensions as modules, and collect the returned - // object for each extension. - extensions.push(require(__dirname + '/' + settings.extensions[i])); - console.log("Extension loaded: " + settings.extensions[i]); - } - catch (exception) { - console.log("Failed to load extension " + settings.extensions[i] + " [" + exception + "]"); - process.exit(1); - } -} - -/** - * Invokes the specified function on all registered server extensions. - */ -var invokeExtensions = function (hook) { - var args = arguments.length ? Array.prototype.slice.call(arguments, 1) : []; - var returnValues = {}; - for (var i in extensions) { - if (extensions[i].hasOwnProperty(hook) && extensions[i][hook].apply) { - returnValues[i] = extensions[i][hook].apply(this, args); - } - } - return returnValues; -} - -/** - * Allow extensions to alter the settings. - */ -invokeExtensions('settingsAlter', settings); - -/** - * Check if the given channel is client-writable. - */ -var channelIsClientWritable = function (channel) { - if (channels.hasOwnProperty(channel)) { - return channels[channel].isClientWritable; - } - return false; -} - -/** - * Check if the given socket is in the given channel. - */ -var clientIsInChannel = function (socket, channel) { - if (!channels.hasOwnProperty(channel)) { - return false; - } - return channels[channel].sessionIds[socket.id]; -} - -/** - * Returns the backend url. - */ -var getBackendUrl = function () { - return settings.backend.scheme + '://' + settings.backend.host + ':' + - settings.backend.port + settings.backend.basePath + settings.backend.messagePath; -} - -var getAuthHeader = function() { - if (settings.backend.httpAuth.length > 0) { - return 'Basic ' + new Buffer(settings.backend.httpAuth).toString('base64'); - } - return false; -} - -/** - * Send a message to the backend. - */ -var sendMessageToBackend = function (message, callback) { - var requestBody = querystring.stringify({ - messageJson: JSON.stringify(message), - serviceKey: settings.serviceKey - }); - - var options = { - uri: getBackendUrl(), - body: requestBody, - headers: { - 'Content-Length': Buffer.byteLength(requestBody), - 'Content-Type': 'application/x-www-form-urlencoded' - } - } - - if (settings.backend.scheme == 'https') { - options.strictSSL = settings.backend.strictSSL; - } - - var httpAuthHeader = getAuthHeader(); - if (httpAuthHeader !== false) { - options.headers.Authorization = httpAuthHeader; - } - - if (settings.debug) { - console.log("Sending message to backend", message, options); - } - request.post(options, callback); -} - -/** - * Authenticate a client connection based on the message it sent. - */ -var authenticateClient = function (client, message) { - // If the authToken is verified, initiate a connection with the client. - if (authenticatedClients[message.authToken]) { - if (settings.debug) { - console.log('Reusing existing authentication data for key:', message.authToken, ', client id:', client.id); - } - setupClientConnection(client.id, authenticatedClients[message.authToken], message.contentTokens); - } - else { - message.messageType = 'authenticate'; - message.clientId = client.id; - sendMessageToBackend(message, authenticateClientCallback); - } -} - -/** - * Handle authentication call response. - */ -var authenticateClientCallback = function (error, response, body) { - if (error) { - console.log("Error with authenticate client request:", error); - return; - } - if (response.statusCode == 404) { - if (settings.debug) { - console.log('Backend authentication url not found, full response info:', response); - } - else { - console.log('Backend authentication url not found.'); - } - return; - } - - var authData = false; - try { - authData = JSON.parse(body); - } - catch (exception) { - console.log('Failed to parse authentication message:', exception); - if (settings.debug) { - console.log('Failed message string: ' + body); - } - return; - } - if (!checkServiceKey(authData.serviceKey)) { - console.log('Invalid service key "', authData.serviceKey, '"'); - return; - } - if (authData.nodejsValidAuthToken) { - if (settings.debug) { - console.log('Valid login for uid "', authData.uid, '"'); - } - setupClientConnection(authData.clientId, authData, authData.contentTokens); - authenticatedClients[authData.authToken] = authData; - } - else { - console.log('Invalid login for uid "', authData.uid, '"'); - delete authenticatedClients[authData.authToken]; - } -} - -/** - * Send a presence notifcation for uid. - */ -var sendPresenceChangeNotification = function (uid, presenceEvent) { - if (onlineUsers[uid]) { - for (var i in onlineUsers[uid]) { - var sessionIds = getNodejsSessionIdsFromUid(onlineUsers[uid][i]); - if (sessionIds.length > 0 && settings.debug) { - console.log('Sending presence notification for', uid, 'to', onlineUsers[uid][i]); - } - for (var j in sessionIds) { - sockets[sessionIds[j]].json.send({'presenceNotification': {'uid': uid, 'event': presenceEvent}}); - } - } - } - if (settings.debug) { - console.log('sendPresenceChangeNotification', uid, presenceEvent, onlineUsers); - } -} - -/** - * Callback that wraps all requests and checks for a valid service key. - */ -var checkServiceKeyCallback = function (request, response, next) { - if (checkServiceKey(request.header('NodejsServiceKey', ''))) { - next(); - } - else { - response.send({'error': 'Invalid service key.'}); - } -} - -/** - * Check a service key against the configured service key. - */ -var checkServiceKey = function (serviceKey) { - if (settings.serviceKey && serviceKey != settings.serviceKey) { - console.log('Invalid service key "' + serviceKey + '", expecting "' + settings.serviceKey + '"'); - return false; - } - return true; -} - -/** - * Http callback - return the list of content channel users. - */ -var getContentTokenUsers = function (request, response) { - var requestBody = ''; - request.setEncoding('utf8'); - request.on('data', function (chunk) { - requestBody += chunk; - }); - request.on('end', function () { - try { - var channel = JSON.parse(requestBody); - } - catch (exception) { - console.log('getContentTokensUsers: Invalid JSON "' + requestBody + '"', exception); - response.send({error: 'Invalid JSON, error: ' + exception.toString()}); - } - try { - response.send({users: getContentTokenChannelUsers(channel.channel)}); - } - catch (exception) { - console.log('getContentTokensUsers:', exception); - response.send({error: 'Error calling getContentTokenChannelUsers() for channel "' + channel.channel + '", error: ' + exception.toString()}); - } - }); -} - -/** - * Http callback - set the debug flag. - */ -var toggleDebug = function (request, response) { - var requestBody = ''; - request.setEncoding('utf8'); - request.on('data', function (chunk) { - requestBody += chunk; - }); - request.on('end', function () { - try { - var toggle = JSON.parse(requestBody); - settings.debug = toggle.debug; - response.send({debug: toggle.debug}); - } - catch (exception) { - console.log('toggleDebug: Invalid JSON "' + requestBody + '"', exception); - response.send({error: 'Invalid JSON, error: ' + e.toString()}); - } - }); -} - -/** - * Http callback - read in a JSON message and publish it to interested clients. - */ -var publishMessage = function (request, response) { - var sentCount = 0, requestBody = ''; - request.setEncoding('utf8'); - request.on('data', function (chunk) { - requestBody += chunk; - }); - request.on('end', function () { - try { - var message = JSON.parse(requestBody); - if (settings.debug) { - console.log('publishMessage: message', message); - } - } - catch (exception) { - console.log('publishMessage: Invalid JSON "' + requestBody + '"', exception); - response.send({error: 'Invalid JSON, error: ' + exception.toString()}); - return; - } - if (message.broadcast) { - if (settings.debug) { - console.log('Broadcasting message'); - } - io.sockets.json.send(message); - sentCount = io.sockets.sockets.length; - } - else { - sentCount = publishMessageToChannel(message); - } - process.emit('message-published', message, sentCount); - response.send({sent: sentCount}); - }); -} - -/** - * Publish a message to clients subscribed to a channel. - */ -var publishMessageToChannel = function (message) { - if (!message.hasOwnProperty('channel')) { - console.log('publishMessageToChannel: An invalid message object was provided.'); - return 0; - } - if (!channels.hasOwnProperty(message.channel)) { - console.log('publishMessageToChannel: The channel "' + message.channel + '" doesn\'t exist.'); - return 0; - } - - var clientCount = 0; - for (var sessionId in channels[message.channel].sessionIds) { - if (publishMessageToClient(sessionId, message)) { - clientCount++; - } - } - if (settings.debug) { - console.log('Sent message to ' + clientCount + ' clients in channel "' + message.channel + '"'); - } - return clientCount; -} - -/** - * Publish a message to clients subscribed to a channel. - */ -var publishMessageToContentChannel = function (request, response) { - var sentCount = 0, requestBody = ''; - request.setEncoding('utf8'); - request.on('data', function (chunk) { - requestBody += chunk; - }); - request.on('end', function () { - try { - var message = JSON.parse(requestBody); - if (settings.debug) { - console.log('publishMessageToContentChannel: message', message); - } - } - catch (exception) { - console.log('publishMessageToContentChannel: Invalid JSON "' + requestBody + '"', exception); - response.send({error: 'Invalid JSON, error: ' + exception.toString()}); - return; - } - if (!message.hasOwnProperty('channel')) { - console.log('publishMessageToContentChannel: An invalid message object was provided.'); - response.send({error: 'Invalid message'}); - return; - } - if (!tokenChannels.hasOwnProperty(message.channel)) { - console.log('publishMessageToContentChannel: The channel "' + message.channel + '" doesn\'t exist.'); - response.send({error: 'Invalid message'}); - return; - } - - for (var socketId in tokenChannels[message.channel].sockets) { - publishMessageToClient(socketId, message); - } - response.send({sent: 'sent'}); - }); -} - -/** - * Publish a message to a specific client. - */ -var publishMessageToClient = function (sessionId, message) { - if (sockets[sessionId]) { - sockets[sessionId].json.send(message); - if (settings.debug) { - console.log('Sent message to client ' + sessionId); - } - return true; - } - else { - console.log('publishMessageToClient: Failed to find client ' + sessionId); - } -}; - -/** - * Sends a 404 message. - */ -var send404 = function (request, response) { - response.send('Not Found.', 404); -}; - -/** - * Kicks the given logged in user from the server. - */ -var kickUser = function (request, response) { - if (request.params.uid) { - // Delete the user from the authenticatedClients hash. - for (var authToken in authenticatedClients) { - if (authenticatedClients[authToken].uid == request.params.uid) { - delete authenticatedClients[authToken]; - } - } - // Destroy any socket connections associated with this uid. - for (var clientId in sockets) { - if (sockets[clientId].uid == request.params.uid) { - delete sockets[clientId]; - if (settings.debug) { - console.log('kickUser: deleted socket "' + clientId + '" for uid "' + request.params.uid + '"'); - } - // Delete any channel entries for this clientId. - for (var channel in channels) { - delete channels[channel].sessionIds[clientId]; - } - } - } - response.send({'status': 'success'}); - return; - } - console.log('Failed to kick user, no uid supplied'); - response.send({'status': 'failed', 'error': 'missing uid'}); -}; - -/** - * Logout the given user from the server. - */ -var logoutUser = function (request, response) { - var authToken = request.params.authtoken || ''; - if (authToken) { - console.log('Logging out http session', authToken); - // Delete the user from the authenticatedClients hash. - delete authenticatedClients[authToken]; - - // Destroy any socket connections associated with this authToken. - for (var clientId in sockets) { - if (sockets[clientId].authToken == authToken) { - cleanupSocket(sockets[clientId]); - } - } - response.send({'status': 'success'}); - return; - } - console.log('Failed to logout user, no authToken supplied'); - response.send({'status': 'failed', 'error': 'missing authToken'}); -}; - -/** - * Get the list of backend uids and authTokens connected to a content token channel. - */ -var getContentTokenChannelUsers = function (channel) { - var users = {uids: [], authTokens: []}; - for (var sessionId in tokenChannels[channel].sockets) { - if (sockets[sessionId].uid) { - users.uids.push(sockets[sessionId].uid); - } - else { - users.authTokens.push(sockets[sessionId].authToken); - } - } - return users; -} - -/** - * Get the list of Node.js sessionIds for a given uid. - */ -var getNodejsSessionIdsFromUid = function (uid) { - var sessionIds = []; - for (var sessionId in sockets) { - if (sockets[sessionId].uid == uid) { - sessionIds.push(sessionId); - } - } - if (settings.debug) { - console.log('getNodejsSessionIdsFromUid', {uid: uid, sessionIds: sessionIds}); - } - return sessionIds; -} - -/** - * Get the list of Node.js sessionIds for a given authToken. - */ -var getNodejsSessionIdsFromAuthToken = function (authToken) { - var sessionIds = []; - for (var sessionId in sockets) { - if (sockets[sessionId].authToken == authToken) { - sessionIds.push(sessionId); - } - } - if (settings.debug) { - console.log('getNodejsSessionIdsFromAuthToken', {authToken: authToken, sessionIds: sessionIds}); - } - return sessionIds; -} - -/** - * Add a user to a channel. - */ -var addUserToChannel = function (request, response) { - var uid = request.params.uid || ''; - var channel = request.params.channel || ''; - if (uid && channel) { - if (!/^\d+$/.test(uid)) { - console.log("Invalid uid: " + uid); - response.send({'status': 'failed', 'error': 'Invalid uid.'}); - return; - } - if (!/^[a-z0-9_]+$/i.test(channel)) { - console.log("Invalid channel: " + channel); - response.send({'status': 'failed', 'error': 'Invalid channel name.'}); - return; - } - channels[channel] = channels[channel] || {'sessionIds': {}}; - var sessionIds = getNodejsSessionIdsFromUid(uid); - if (sessionIds.length > 0) { - for (var i in sessionIds) { - channels[channel].sessionIds[sessionIds[i]] = sessionIds[i]; - } - if (settings.debug) { - console.log("Added channel '" + channel + "' to sessionIds " + sessionIds.join()); - } - response.send({'status': 'success'}); - } - else { - console.log("No active sessions for uid: " + uid); - response.send({'status': 'failed', 'error': 'No active sessions for uid.'}); - } - for (var authToken in authenticatedClients) { - if (authenticatedClients[authToken].uid == uid) { - if (authenticatedClients[authToken].channels.indexOf(channel) == -1) { - authenticatedClients[authToken].channels.push(channel); - if (settings.debug) { - console.log("Added channel '" + channel + "' authenticatedClients"); - } - } - } - } - } - else { - console.log("Missing uid or channel"); - response.send({'status': 'failed', 'error': 'Missing uid or channel'}); - } -}; - -/** - * Add an authToken to a channel. - */ -var addAuthTokenToChannel = function (request, response) { - var authToken = request.params.authToken || ''; - var channel = request.params.channel || ''; - if (!authToken || !channel) { - console.log("Missing authToken or channel"); - response.send({'status': 'failed', 'error': 'Missing authToken or channel'}); - return; - } - - if (!/^[a-z0-9_]+$/i.test(channel)) { - console.log("Invalid channel: " + channel); - response.send({'status': 'failed', 'error': 'Invalid channel name.'}); - return; - } - if (!authenticatedClients[authToken]) { - console.log("Unknown authToken : " + authToken); - response.send({'status': 'failed', 'error': 'Invalid authToken.'}); - return; - } - channels[channel] = channels[channel] || {'sessionIds': {}}; - var sessionIds = getNodejsSessionIdsFromAuthtoken(authToken); - if (sessionIds.length > 0) { - for (var i in sessionIds) { - channels[channel].sessionIds[sessionIds[i]] = sessionIds[i]; - } - if (settings.debug) { - console.log("Added sessionIds '" + sessionIds.join() + "' to channel '" + channel + "'"); - } - response.send({'status': 'success'}); - } - else { - console.log("No active sessions for authToken: " + authToken); - response.send({'status': 'failed', 'error': 'No active sessions for uid.'}); - } - if (authenticatedClients[authToken].channels.indexOf(channel) == -1) { - authenticatedClients[authToken].channels.push(channel); - if (settings.debug) { - console.log("Added channel '" + channel + "' to authenticatedClients"); - } - } -}; - -/** - * Add a client (specified by session ID) to a channel. - */ -var addClientToChannel = function (sessionId, channel) { - if (sessionId && channel) { - if (!/^[0-9a-z_-]+$/i.test(sessionId) || !sockets.hasOwnProperty(sessionId)) { - console.log("addClientToChannel: Invalid sessionId: " + sessionId); - } - else if (!/^[a-z0-9_]+$/i.test(channel)) { - console.log("addClientToChannel: Invalid channel: " + channel); - } - else { - channels[channel] = channels[channel] || {'sessionIds': {}}; - channels[channel].sessionIds[sessionId] = sessionId; - if (settings.debug) { - console.log("Added channel '" + channel + "' to sessionId " + sessionId); - } - return true; - } - } - else { - console.log("addClientToChannel: Missing sessionId or channel name"); - } - return false; -}; - -/** - * Remove a channel. - */ -var removeChannel = function (request, response) { - var channel = request.params.channel || ''; - if (channel) { - if (!/^[a-z0-9_]+$/i.test(channel)) { - console.log('Invalid channel: ' + channel); - response.send({'status': 'failed', 'error': 'Invalid channel name.'}); - return; - } - if (channels[channel]) { - delete channels[channel]; - if (settings.debug) { - console.log("Successfully removed channel '" + channel + "'"); - } - response.send({'status': 'success'}); - } - else { - console.log("Non-existent channel name '" + channel + "'"); - response.send({'status': 'failed', 'error': 'Non-existent channel name.'}); - return; - } - } - else { - console.log("Missing channel"); - response.send({'status': 'failed', 'error': 'Invalid data: missing channel'}); - } -} - -/** - * Add a channel. - */ -var addChannel = function (request, response) { - var channel = request.params.channel || ''; - if (channel) { - if (!/^[a-z0-9_]+$/i.test(channel)) { - console.log('Invalid channel: ' + channel); - response.send({'status': 'failed', 'error': 'Invalid channel name.'}); - return; - } - if (channels[channel]) { - console.log("Channel name '" + channel + "' already exists."); - response.send({'status': 'failed', 'error': "Channel name '" + channel + "' already exists."}); - return; - } - channels[channel] = {'sessionIds': {}}; - if (settings.debug) { - console.log("Successfully added channel '" + channel + "'"); - } - response.send({'status': 'success'}); - } - else { - console.log("Missing channel"); - response.send({'status': 'failed', 'error': 'Invalid data: missing channel'}); - } -} - -/** - * Checks whether a channel exists. - */ -var checkChannel = function (request, response) { - var channel = request.params.channel || ''; - if (channel) { - if (!/^[a-z0-9_]+$/i.test(channel)) { - console.log('Invalid channel: ' + channel); - response.send({'status': 'failed', 'error': 'Invalid channel name.'}); - return; - } - if (channels[channel]) { - console.log("Channel name '" + channel + "' is active on the server."); - response.send({'status': 'success', 'result': true}); - return; - } - else { - console.log("Channel name '" + channel + "' is not active on the server."); - response.send({'status': 'success', 'result': false}); - } - } - else { - console.log("Missing channel"); - response.send({'status': 'failed', 'error': 'Invalid data: missing channel'}); - } -} - -/** - * Remove a user from a channel. - */ -var removeUserFromChannel = function (request, response) { - var uid = request.params.uid || ''; - var channel = request.params.channel || ''; - if (uid && channel) { - if (!/^\d+$/.test(uid)) { - console.log('Invalid uid: ' + uid); - response.send({'status': 'failed', 'error': 'Invalid uid.'}); - return; - } - if (!/^[a-z0-9_]+$/i.test(channel)) { - console.log('Invalid channel: ' + channel); - response.send({'status': 'failed', 'error': 'Invalid channel name.'}); - return; - } - if (channels[channel]) { - var sessionIds = getNodejsSessionIdsFromUid(uid); - for (var i in sessionIds) { - if (channels[channel].sessionIds[sessionIds[i]]) { - delete channels[channel].sessionIds[sessionIds[i]]; - } - } - for (var authToken in authenticatedClients) { - if (authenticatedClients[authToken].uid == uid) { - var index = authenticatedClients[authToken].channels.indexOf(channel); - if (index != -1) { - delete authenticatedClients[authToken].channels[index]; - } - } - } - if (settings.debug) { - console.log("Successfully removed uid '" + uid + "' from channel '" + channel + "'"); - } - response.send({'status': 'success'}); - } - else { - console.log("Non-existent channel name '" + channel + "'"); - response.send({'status': 'failed', 'error': 'Non-existent channel name.'}); - return; - } - } - else { - console.log("Missing uid or channel"); - response.send({'status': 'failed', 'error': 'Invalid data'}); - } -} - -/** - * Remove an authToken from a channel. - */ -var removeAuthTokenFromChannel = function (request, response) { - var authToken = request.params.authToken || ''; - var channel = request.params.channel || ''; - if (authToken && channel) { - if (!authenticatedClients[authToken]) { - console.log('Invalid authToken: ' + uid); - response.send({'status': 'failed', 'error': 'Invalid authToken.'}); - return; - } - if (!/^[a-z0-9_]+$/i.test(channel)) { - console.log('Invalid channel: ' + channel); - response.send({'status': 'failed', 'error': 'Invalid channel name.'}); - return; - } - if (channels[channel]) { - var sessionIds = getNodejsSessionIdsFromAuthToken(authToken); - for (var i in sessionIds) { - if (channels[channel].sessionIds[sessionIds[i]]) { - delete channels[channel].sessionIds[sessionIds[i]]; - } - } - if (authenticatedClients[authToken]) { - var index = authenticatedClients[authToken].channels.indexOf(channel); - if (index != -1) { - delete authenticatedClients[authToken].channels[index]; - } - } - if (settings.debug) { - console.log("Successfully removed authToken '" + authToken + "' from channel '" + channel + "'."); - } - response.send({'status': 'success'}); - } - else { - console.log("Non-existent channel name '" + channel + "'"); - response.send({'status': 'failed', 'error': 'Non-existent channel name.'}); - return; - } - } - else { - console.log("Missing authToken or channel"); - response.send({'status': 'failed', 'error': 'Invalid data'}); - } -} - -/** - * Remove a client (specified by session ID) from a channel. - */ -var removeClientFromChannel = function (sessionId, channel) { - if (sessionId && channel) { - if (!/^[0-9a-z_-]+$/i.test(sessionId) || !sockets.hasOwnProperty(sessionId)) { - console.log("removeClientFromChannel: Invalid sessionId: " + sessionId); - } - else if (!/^[a-z0-9_]+$/i.test(channel) || !channels.hasOwnProperty(channel)) { - console.log("removeClientFromChannel: Invalid channel: " + channel); - } - else if (channels[channel].sessionIds[sessionId]) { - delete channels[channels].sessionIds[sessionId]; - if (settings.debug) { - console.log("Removed sessionId '" + sessionId + "' from channel '" + channel + "'"); - } - return true; - } - } - else { - console.log("removeClientFromChannel: Missing sessionId or channel name"); - } - return false; -}; - -/** - * Set the list of users a uid can see presence info about. - */ -var setUserPresenceList = function (uid, uids) { - var uid = request.params.uid || ''; - var uidlist = request.params.uidlist.split(',') || []; - if (uid && uidlist) { - if (!/^\d+$/.test(uid)) { - console.log("Invalid uid: " + uid); - response.send({'status': 'failed', 'error': 'Invalid uid.'}); - return; - } - if (uidlist.length == 0) { - console.log("Empty uidlist"); - response.send({'status': 'failed', 'error': 'Empty uid list.'}); - return; - } - for (var i in uidlist) { - if (!/^\d+$/.test(uidlist[i])) { - console.log("Invalid uid: " + uid); - response.send({'status': 'failed', 'error': 'Invalid uid.'}); - return; - } - } - onlineUsers[uid] = uidlist; - response.send({'status': 'success'}); - } - else { - response.send({'status': 'failed', 'error': 'Invalid parameters.'}); - } -} - -/** - * Cleanup after a socket has disconnected. - */ -var cleanupSocket = function (socket) { - if (settings.debug) { - console.log("Cleaning up after socket id", socket.id, 'uid', socket.uid); - } - for (var channel in channels) { - delete channels[channel].sessionIds[socket.id]; - } - var uid = socket.uid; - if (uid != 0) { - if (presenceTimeoutIds[uid]) { - clearTimeout(presenceTimeoutIds[uid]); - } - presenceTimeoutIds[uid] = setTimeout(checkOnlineStatus, 2000, uid); - } - - for (var tokenChannel in tokenChannels) { - console.log("cleanupSocket: checking tokenChannel", tokenChannel, socket.id); - if (tokenChannels[tokenChannel].sockets[socket.id]) { - console.log("cleanupSocket: found socket.id for tokenChannel", tokenChannel, tokenChannels[tokenChannel].sockets[socket.id]); - if (tokenChannels[tokenChannel].sockets[socket.id].notifyOnDisconnect) { - if (contentChannelTimeoutIds[tokenChannel + '_' + uid]) { - clearTimeout(contentChannelTimeoutIds[tokenChannel + '_' + uid]); - } - contentChannelTimeoutIds[tokenChannel + '_' + uid] = setTimeout(checkTokenChannelStatus, 2000, tokenChannel, socket); - } - delete tokenChannels[tokenChannel].sockets[socket.id]; - } - } - - delete sockets[socket.id]; -} - -/** - * Check for any open sockets associated with the channel and socket pair. - */ -var checkTokenChannelStatus = function (tokenChannel, socket) { - // If the tokenChannel no longer exists, just bail. - if (!tokenChannels[tokenChannel]) { - console.log("checkTokenChannelStatus: no tokenChannel", tokenChannel, socket.uid); - return; - } - - // If we find a socket for this user in the given tokenChannel, we can just - // return, as there's nothing we need to do. - var sessionIds = getNodejsSessionIdsFromUid(socket.uid); - for (var i = 0; i < sessionIds.length; i++) { - if (tokenChannels[tokenChannel].sockets[sessionIds[i]]) { - console.log("checkTokenChannelStatus: found socket for tokenChannel", tokenChannel, socket.uid); - return; - } - } - - // We didn't find a socket for this uid, and we have other sockets in this, - // channel, so send disconnect notification message. - var message = { - 'channel': tokenChannel, - 'contentChannelNotification': true, - 'data': { - 'uid': socket.uid, - 'type': 'disconnect', - } - }; - for (var socketId in tokenChannels[tokenChannel].sockets) { - publishMessageToClient(socketId, message); - } -} - -/** - * Check for any open sockets for uid. - */ -var checkOnlineStatus = function (uid) { - if (getNodejsSessionIdsFromUid(uid).length == 0) { - if (settings.debug) { - console.log("Sending offline notification for", uid); - } - setUserOffline(uid); - } -} - -/** - * Sends offline notification to sockets, the backend and cleans up our list. - */ -var setUserOffline = function (uid) { - sendPresenceChangeNotification(uid, 'offline'); - delete onlineUsers[uid]; - sendMessageToBackend({uid: uid, messageType: 'userOffline'}, function (response) { }); -} - -/** - * Set a content token. - */ -var setContentToken = function (request, response) { - var requestBody = ''; - request.setEncoding('utf8'); - request.on('data', function (chunk) { - requestBody += chunk; - }); - request.on('end', function () { - try { - var message = JSON.parse(requestBody); - if (settings.debug) { - console.log('setContentToken: message', message); - } - } - catch (exception) { - console.log('setContentToken: Invalid JSON "' + requestBody + '"', exception); - response.send({error: 'Invalid JSON, error: ' + exception.toString()}); - return; - } - tokenChannels[message.channel] = tokenChannels[message.channel] || {'tokens': {}, 'sockets': {}}; - tokenChannels[message.channel].tokens[message.token] = message; - if (settings.debug) { - console.log('setContentToken', message.token, 'for channel', message.channel); - } - response.send({status: 'ok'}); - }); -} - -/** - * Setup a sockets{}.connection with uid, channels etc. - */ -var setupClientConnection = function (sessionId, authData, contentTokens) { - if (!sockets[sessionId]) { - console.log("Client socket '" + sessionId + "' went away."); - return; - } - sockets[sessionId].authToken = authData.authToken; - sockets[sessionId].uid = authData.uid; - for (var i in authData.channels) { - channels[authData.channels[i]] = channels[authData.channels[i]] || {'sessionIds': {}}; - channels[authData.channels[i]].sessionIds[sessionId] = sessionId; - } - if (authData.uid != 0) { - var sendPresenceChange = !onlineUsers[authData.uid]; - onlineUsers[authData.uid] = authData.presenceUids || []; - if (sendPresenceChange) { - sendPresenceChangeNotification(authData.uid, 'online'); - } - } - - var clientToken = ''; - for (var tokenChannel in contentTokens) { - tokenChannels[tokenChannel] = tokenChannels[tokenChannel] || {'tokens': {}, 'sockets': {}}; - - clientToken = contentTokens[tokenChannel]; - if (tokenChannels[tokenChannel].tokens[clientToken]) { - tokenChannels[tokenChannel].sockets[sessionId] = tokenChannels[tokenChannel].tokens[clientToken]; - if (settings.debug) { - console.log('Added token', clientToken, 'for channel', tokenChannel, 'for socket', sessionId); - } - delete tokenChannels[tokenChannel].tokens[clientToken]; - } - } - - process.emit('client-authenticated', sessionId, authData); - - if (settings.debug) { - console.log("Added channels for uid " + authData.uid + ': ' + authData.channels.toString()); - console.log('setupClientConnection', onlineUsers); - } -}; - -var app = express(); -app.all(settings.baseAuthPath + '*', checkServiceKeyCallback); -app.post(settings.baseAuthPath + settings.publishUrl, publishMessage); -app.get(settings.baseAuthPath + settings.kickUserUrl, kickUser); -app.get(settings.baseAuthPath + settings.logoutUserUrl, logoutUser); -app.get(settings.baseAuthPath + settings.addUserToChannelUrl, addUserToChannel); -app.get(settings.baseAuthPath + settings.removeUserFromChannelUrl, removeUserFromChannel); -app.get(settings.baseAuthPath + settings.addChannelUrl, addChannel); -app.get(settings.baseAuthPath + settings.checkChannelUrl, checkChannel); -app.get(settings.baseAuthPath + settings.removeChannelUrl, removeChannel); -app.get(settings.baseAuthPath + settings.setUserPresenceListUrl, setUserPresenceList); -app.post(settings.baseAuthPath + settings.toggleDebugUrl, toggleDebug); -app.post(settings.baseAuthPath + settings.getContentTokenUsersUrl, getContentTokenUsers); -app.post(settings.baseAuthPath + settings.contentTokenUrl, setContentToken); -app.post(settings.baseAuthPath + settings.publishMessageToContentChannelUrl, publishMessageToContentChannel); -app.get('*', send404); - -var server; -if (settings.scheme == 'https') { - var sslOptions = { - key: fs.readFileSync(settings.sslKeyPath), - cert: fs.readFileSync(settings.sslCertPath) - }; - if (settings.sslCAPath) { - sslOptions.ca = fs.readFileSync(settings.sslCAPath); - } - if (settings.sslPassPhrase) { - sslOptions.passphrase = settings.sslPassPhrase; - } - server = https.createServer(sslOptions, app); -} -else { - server = http.createServer(app); -} - -// Allow extensions to add routes. -var path = ''; -for (var i in extensions) { - if (extensions[i].hasOwnProperty('routes')) { - console.log('Adding route handlers from extension', extensions[i].routes); - for (var j = 0; j < extensions[i].routes.length; j++) { - if (extensions[i].routes[j].auth) { - path = settings.baseAuthPath + extensions[i].routes[j].path; - } - else { - path = extensions[i].routes[j].path; - } - if (extensions[i].routes[j].type == 'post') { - server.post(path, extensions[i].routes[j].handler); - } - else { - server.get(path, extensions[i].routes[j].handler); - } - } - } -} - -server.listen(settings.port, settings.host); -console.log('Started ' + settings.scheme + ' server.'); - -var io_options = {}; -io_options['transports'] = settings.transports; -io_options['log level'] = settings.logLevel; -io_options['port'] = settings.port; -if (settings.jsEtag) { - io_options['browser client etag'] = true; -} -if (settings.jsMinification) { - io_options['browser client minification'] = true; -} - -var io = require('socket.io')(server, io_options); -io.set('resource', settings.resource); -io.set('transports', settings.transports); -io.on('connection', function(socket) { - sockets[socket.id] = socket; - process.emit('client-connection', socket.id); - - socket.on('authenticate', function(message) { - if (settings.debug) { - console.log('Authenticating client with key "' + message.authToken + '"'); - } - authenticateClient(socket, message); - }); - - socket.on('message', function(message) { - // If the message is from an active client, then process it. - if (sockets[socket.id] && message.hasOwnProperty('type')) { - if (settings.debug) { - console.log('Received message from client ' + socket.id); - } - - // If this message is destined for a channel, check two things: - // - that this channel is allowed to get messages directly from clients - // - that the sending socket is already in this channel (that is, the - // backend has sent this channel in this user's allowed list). - // Do not let extensions using this feature accidentally allow sending - // of messages to any socket on any channel. - if (message.hasOwnProperty('channel')) { - if (channelIsClientWritable(message.channel) && clientIsInChannel(socket, message.channel)) { - process.emit('client-to-channel-message', socket.id, message); - } - else if (settings.debug) { - console.log('Received unauthorised message from client: cannot write to channel ' + socket.id); - } - } - - // No channel, so this message is destined for one or more clients. Check - // that this is allowed in the server configuration. - else if (settings.clientsCanWriteToClients) { - process.emit('client-to-client-message', socket.id, message); - } - else if (settings.debug) { - console.log('Received unauthorised message from client: cannot write to client ' + socket.id); - } - return; - } - }); - - socket.on('disconnect', function () { - process.emit('client-disconnect', socket.id); - cleanupSocket(socket); - }); -}) -.on('error', function(exception) { - console.log('Socket error [' + exception + ']'); -}); - -/** - * Define a configuration object to pass to all server extensions at - * initialization. The extensions do not have access to this namespace, - * so we provide them with references. - */ -var extensionsConfig = { - 'publishMessageToChannel': publishMessageToChannel, - 'publishMessageToClient': publishMessageToClient, - 'publishMessageToContentChannel': publishMessageToContentChannel, - 'addClientToChannel': addClientToChannel, - 'settings': settings, - 'channels': channels, - 'io': io, - 'tokenChannels': tokenChannels, - 'authenticatedClients': authenticatedClients, - 'request': request, - 'server': server, - 'sendMessageToBackend': sendMessageToBackend -}; -invokeExtensions('setup', extensionsConfig); - -// vi:ai:expandtab:sw=2 ts=2 - -- 2.3.8 (Apple Git-58)