├── Procfile ├── sample.env ├── Gruntfile.js ├── utils ├── connection.js ├── bot.js ├── newrelic.js ├── socket.js ├── slack.js └── client.js ├── README.md ├── .jscsrc ├── models └── app.js ├── .gitignore ├── package.json ├── app.js └── LICENSE /Procfile: -------------------------------------------------------------------------------- 1 | web: node app.js -------------------------------------------------------------------------------- /sample.env: -------------------------------------------------------------------------------- 1 | # Rename this to .env 2 | SERVER=LOCAL 3 | NODE_ENV=development 4 | MONGOLAB_URI=mongodb://localhost:27017/prudio 5 | PORT=5000 6 | -------------------------------------------------------------------------------- /Gruntfile.js: -------------------------------------------------------------------------------- 1 | module.exports = function(grunt) { 2 | 3 | grunt.loadNpmTasks('grunt-foreman'); 4 | 5 | // Default task(s). 6 | grunt.registerTask('server', ['foreman']); 7 | grunt.registerTask('default', ['server']); 8 | 9 | }; 10 | -------------------------------------------------------------------------------- /utils/connection.js: -------------------------------------------------------------------------------- 1 | var mongoose = require('mongoose'); 2 | 3 | mongoose.connect(process.env.MONGOLAB_URI); 4 | 5 | var db = mongoose.connection; 6 | 7 | db.on('error', console.error.bind(console, 'connection error:')); 8 | 9 | db.once('open', function(callback) { 10 | console.log('Connected to MONGO!'); 11 | }); 12 | 13 | module.exports = db; 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Prudio Socket [![Codacy Badge](https://www.codacy.com/project/badge/e51054f54cd24e7596d916b816c95b9f)](https://www.codacy.com/app/cossou/prudio-socket) Codeship 2 | 3 | Prudio Socket implementation. 4 | 5 | # License 6 | 7 | [AGPL v3](https://github.com/asm-products/prudio-chat/blob/master/LICENSE). 8 | -------------------------------------------------------------------------------- /.jscsrc: -------------------------------------------------------------------------------- 1 | { 2 | "preset": "google", 3 | "fileExtensions": [ ".js", "jscs" ], 4 | 5 | "requireParenthesesAroundIIFE": true, 6 | "maximumLineLength": 320, 7 | "validateLineBreaks": "LF", 8 | "validateIndentation": 4, 9 | 10 | "disallowKeywords": ["with"], 11 | "disallowSpacesInsideObjectBrackets": null, 12 | "disallowImplicitTypeConversion": ["string"], 13 | 14 | "safeContextKeyword": "_this", 15 | 16 | "excludeFiles": [ 17 | "build/**", 18 | "utils/newrelic.js" 19 | ] 20 | } 21 | -------------------------------------------------------------------------------- /utils/bot.js: -------------------------------------------------------------------------------- 1 | // Connect all the bots to the Slack accounts. 2 | 3 | module.exports = function(app, slack, App) { 4 | App.find({ active: true, server: app.get('server') }, function(err, applications) { 5 | if (err) { 6 | console.error(err); 7 | } 8 | 9 | for (var i in applications) { 10 | if (applications.hasOwnProperty(i)) { 11 | var application = applications[i]; 12 | slack.connect(application); 13 | } 14 | } 15 | }); 16 | }; 17 | -------------------------------------------------------------------------------- /models/app.js: -------------------------------------------------------------------------------- 1 | var mongoose = require('mongoose'); 2 | 3 | module.exports = mongoose.model('App', 4 | mongoose.Schema({ 5 | appId: String, 6 | name: String, 7 | active: Boolean, 8 | online: Boolean, 9 | join: Boolean, 10 | slackApiToken: String, 11 | slackBotToken: String, 12 | slackInviteUser: String, 13 | slackInviteBot: String, 14 | notifyChannel: String, 15 | roomPrefix: String, 16 | roomCount: Number, 17 | socketURL: String, 18 | server: String 19 | }, 20 | { 21 | collection: 'App' // to match with prudio-app 22 | }) 23 | ); 24 | -------------------------------------------------------------------------------- /utils/newrelic.js: -------------------------------------------------------------------------------- 1 | /** 2 | * New Relic agent configuration. 3 | * 4 | * See lib/config.defaults.js in the agent distribution for a more complete 5 | * description of configuration variables and their potential values. 6 | */ 7 | exports.config = { 8 | /** 9 | * Array of application names. 10 | */ 11 | app_name : ['Oghma'], 12 | /** 13 | * Your New Relic license key. 14 | */ 15 | license_key : '9697fb5257d8d6c3174b6c91d943629d2221fa52', 16 | logging : { 17 | /** 18 | * Level at which to log. 'trace' is most useful to New Relic when diagnosing 19 | * issues with the agent, 'info' and higher will impose the least overhead on 20 | * production applications. 21 | */ 22 | level : 'info' 23 | } 24 | }; 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # Compiled binary addons (http://nodejs.org/api/addons.html) 20 | build/Release 21 | 22 | # Dependency directory 23 | # Deployed apps should consider commenting this line out: 24 | # see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git 25 | node_modules 26 | 27 | # Photoshop files 28 | *.psd 29 | 30 | express-angularjs-seed 31 | bower_components 32 | .npmignore 33 | 34 | # Environment 35 | .env 36 | 37 | # Webstorm 38 | .idea 39 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "prudio-socket", 3 | "version": "0.0.5", 4 | "exportName": "client", 5 | "description": "Slack Instant Messaging Widget", 6 | "engines": { 7 | "node": "0.10.x", 8 | "npm": "2.x" 9 | }, 10 | "dependencies": { 11 | "async": "0.9.0", 12 | "bcrypt": "0.8.0", 13 | "body-parser": "1.9.0", 14 | "cors": "2.4.2", 15 | "errorhandler": "1.2.0", 16 | "express": "4.9.4", 17 | "formidable": "1.0.*", 18 | "grunt": "latest", 19 | "grunt-cli": "latest", 20 | "lokijs": "1.1.*", 21 | "moment": "^2.8.3", 22 | "mongoose": "^3.8.23", 23 | "newrelic": "^1.12.1", 24 | "request": "latest", 25 | "socket.io": "1.1", 26 | "ws": "0.4.x" 27 | }, 28 | "author": "Hélder Duarte", 29 | "main": "app.js", 30 | "devDependencies": { 31 | "grunt-foreman": "0.0.5", 32 | "jscs": "^1.8.1", 33 | "pre-commit": "0.0.9" 34 | }, 35 | "pre-commit": [ 36 | "jshint", 37 | "jscs" 38 | ], 39 | "scripts": { 40 | "test": "echo \"Error: no test specified\" && exit 1", 41 | "jscs": "jscs *.js utils/*.js models/*.js" 42 | }, 43 | "repository": { 44 | "type": "git", 45 | "url": "git@github.com:asm-products/prudio-socket.git" 46 | }, 47 | "keywords": [ 48 | "slack", 49 | "chat", 50 | "software", 51 | "livechat", 52 | "communication" 53 | ], 54 | "license": "MIT", 55 | "bugs": { 56 | "url": "https://github.com/asm-products/prudio-socket" 57 | }, 58 | "homepage": "http://prud.io/" 59 | } 60 | -------------------------------------------------------------------------------- /app.js: -------------------------------------------------------------------------------- 1 | // New Relic Monitor 2 | require('./utils/newrelic'); 3 | 4 | // Express and SocketIO 5 | var express = require('express'); 6 | var app = express(); 7 | var server = require('http').Server(app); 8 | var io = require('socket.io')(server); 9 | var db = require('./utils/connection'); 10 | 11 | // Body parser & CORS 12 | var bodyParser = require('body-parser'); 13 | var cors = require('cors'); 14 | 15 | // Debug 16 | // var DEBUG = app.get('DEBUG'); 17 | 18 | // Models 19 | var App = require('./models/app'); 20 | 21 | // Slack logic 22 | var slack = require('./utils/slack'); 23 | 24 | // App settings 25 | app.set('port', process.env.PORT || Number(5000)); 26 | app.set('env', process.env.NODE_ENV || 'development'); 27 | app.set('server', process.env.SERVER); 28 | 29 | // Constants 30 | app.set('slack_api_url', 'https://slack.com/api'); 31 | 32 | // Development only 33 | if ('development' === app.get('env')) { 34 | var errorhandler = require('errorhandler'); 35 | app.use(errorhandler()); 36 | } 37 | 38 | db.once('open', function(callback) { 39 | var listening = server.listen(app.get('port'), function() { 40 | 41 | console.log(app.get('server') + ' server listening on port ' + listening.address().port); 42 | 43 | // Hide the console.log() function in production 44 | if ('production' === app.get('env')) { 45 | console = console || {}; 46 | console.log = function() {}; 47 | } 48 | }); 49 | }); 50 | 51 | app.enable('trust proxy'); 52 | app.use(bodyParser.urlencoded({ extended: false })); 53 | app.use(cors()); 54 | 55 | app.get('/', function(req, res, next) { 56 | return res.status(200).json({ success: true, message: 'Welcome, nothing here!', server: app.get('server') }); 57 | }); 58 | 59 | // linking 60 | require('./utils/socket')(app, io, slack, App); // socketIO logic 61 | require('./utils/bot')(app, slack, App); // Sets bots up 62 | require('./utils/client')(app, io, slack, App); // sets up endpoints 63 | 64 | // Catch errors 65 | app.use(function(err, req, res, next) { 66 | console.error(err.stack); 67 | res.status(500).send('Something broke!'); 68 | }); 69 | 70 | // On SIGTERM app 71 | process.on('SIGTERM', function() { 72 | console.log('Got a SIGTERM'); 73 | slack.disconnectAll(); 74 | server.close.bind(server); 75 | process.exit(0); 76 | }); 77 | 78 | // On SIGINT app 79 | process.on('SIGINT', function() { 80 | console.log('Got a SIGINT'); 81 | slack.disconnectAll(); 82 | server.close.bind(server); 83 | process.exit(0); 84 | }); 85 | -------------------------------------------------------------------------------- /utils/socket.js: -------------------------------------------------------------------------------- 1 | module.exports = function(app, io, slack, App) { 2 | 3 | io.of('/chat').on('connection', function(clientSocket) { 4 | // each client is put into a chat room restricted to max 2 clients 5 | clientSocket.on('joinRoom', function(appId, channel, clientSignature) { 6 | App.findOne({ appId: appId, active: true }, function(err, application) { 7 | if (err) { 8 | console.error(err); 9 | } 10 | 11 | if (application === null) { 12 | console.error('Wrong appId.'); 13 | 14 | clientSocket.emit('serverMessage', { 15 | message: 'Wrong appId.' 16 | }); 17 | 18 | // force client to disconnect 19 | clientSocket.disconnect(); 20 | return; 21 | } 22 | 23 | var crypto = require('crypto'); 24 | var appId = application.appId; 25 | var signature = crypto.createHmac('sha1', application.slackApiToken).update(channel.concat(appId)).digest('hex'); 26 | 27 | if (signature !== clientSignature) { 28 | console.log('Wrong signature.'); 29 | 30 | clientSocket.emit('serverMessage', { 31 | message: 'Wrong signature.' 32 | }); 33 | 34 | // force client to disconnect 35 | clientSocket.disconnect(); 36 | return; 37 | } 38 | 39 | var bot = slack.connect(application); 40 | 41 | // client joins room specified in URL 42 | clientSocket.join(channel); 43 | 44 | // welcome client on succesful connection 45 | clientSocket.emit('serverMessage', { 46 | message: 'Welcome to the chat.' 47 | }); 48 | 49 | // Socket connected, notify Slack that user joined the chat 50 | slack.say(appId, channel, '_User connected!_'); 51 | 52 | /** sendMessage **/ 53 | clientSocket.on('sendMessage', function(text) { 54 | 55 | if (slack.isConnected(appId) === false) { 56 | // Let the user know about the error? 57 | clientSocket.emit('serverMessage', { 58 | message: 'Could not deliver the message: ' + text.message 59 | }); 60 | 61 | return; 62 | } 63 | 64 | // all data sent by client is sent to room 65 | // clientSocket.broadcast.to(channel).emit('message', { 66 | // message: text.message, 67 | // sender: 'Other' 68 | // }); 69 | 70 | // and then shown to client 71 | clientSocket.emit('message', { 72 | message: text.message, 73 | sender: 'Self' 74 | }); 75 | 76 | // send response to slack 77 | slack.say(appId, channel, text.message); 78 | }); 79 | 80 | console.log('Type: ' + typeof bot); 81 | if (typeof bot === 'undefined') { 82 | console.error('Bot is undefined!'); 83 | 84 | clientSocket.emit('serverMessage', { 85 | message: 'Still connecting' 86 | }); 87 | 88 | return; 89 | } 90 | 91 | // On Slack message, redirect to socket 92 | bot.on('message', function(message) { 93 | console.log('Message from the socket: %j', message); 94 | 95 | if (message.channel === channel) { 96 | clientSocket.emit('message', { 97 | message: message.text, 98 | sender: 'Other' 99 | }); 100 | } 101 | }); 102 | 103 | bot.on('user_typing', function(message) { 104 | console.log('User typing from the socket: %j', message); 105 | 106 | if (message.channel === channel) { 107 | clientSocket.emit('typingMessage'); 108 | } 109 | }); 110 | 111 | // Error handler 112 | bot.on('error', function(err) { 113 | console.error('Error message: %j', err); 114 | console.log('Channel: %j', channel); 115 | // Let the user know about the error? 116 | clientSocket.emit('serverMessage', { 117 | message: 'Message could not be delivered.' 118 | }); 119 | }); 120 | 121 | // Slack disconnect handler (should not happen often). 122 | bot.on('disconnect', function(e) { 123 | // Let the user know about the error? 124 | clientSocket.emit('serverMessage', { 125 | message: 'Support is offline.' 126 | }); 127 | 128 | }); 129 | 130 | // Socket disconnect listener, notify Slack that user left the chat 131 | clientSocket.on('disconnect', function() { 132 | slack.say(appId, channel, '_User disconnected!_'); 133 | }); 134 | }); 135 | }); 136 | }); 137 | }; 138 | -------------------------------------------------------------------------------- /utils/slack.js: -------------------------------------------------------------------------------- 1 | var WebSocket = require('ws'); 2 | var events = require('events'); 3 | var moment = require('moment'); 4 | var fs = require('fs'); 5 | var request = require('request'); // github.com/mikeal/request 6 | var loki = require('lokijs'); 7 | 8 | var db = new loki(); 9 | 10 | // Private 11 | var Bots = {}; 12 | //var Apps = db.addCollection('Apps'); 13 | var Users = db.addCollection('Users'); 14 | var Channels = db.addCollection('Channels'); 15 | 16 | // Size of an object 17 | Object.size = function(obj) { 18 | var size = 0; 19 | var key; 20 | for (key in obj) { 21 | if (obj.hasOwnProperty(key)) { 22 | size++; 23 | } 24 | } 25 | return size; 26 | }; 27 | 28 | // Public 29 | var self = module.exports = { 30 | 31 | size: function size() { 32 | return Object.size(Bots); 33 | }, 34 | 35 | onlineUsers: function onlineUsers(appid) { 36 | 37 | //jscs:disable 38 | // is_bot var is comming from Slack like this. 39 | var users = Users.where(function(obj) { 40 | return obj.appid === appid && 41 | obj.user.presence === 'active' && 42 | obj.user.id !== 'USLACKBOT' && 43 | obj.user.is_bot === false && 44 | obj.user.deleted === false; 45 | }); 46 | //jscs:enable 47 | 48 | return users; 49 | }, 50 | 51 | addChannels: function addChannels(appid, channels) { 52 | 53 | for (var channel in channels) { 54 | if (channels.hasOwnProperty(channel)) { 55 | Channels.insert({ appid: appid, channel: channels[channel]}); 56 | } 57 | } 58 | 59 | return Channels; 60 | }, 61 | 62 | addUsers: function addUsers(appid, users) { 63 | 64 | for (var user in users) { 65 | if (users.hasOwnProperty(user)) { 66 | Users.insert({ appid: appid, user: users[user]}); 67 | } 68 | } 69 | 70 | return Users; 71 | }, 72 | 73 | getChannelCode: function getChannelCode(appid, name) { 74 | 75 | var channel = Channels.where(function(obj) { 76 | return obj.appid === appid && obj.channel.name === name; 77 | }); 78 | 79 | if (channel !== null && channel.length === 1) { 80 | return channel[0].channel.id; 81 | } else { 82 | return false; 83 | } 84 | }, 85 | 86 | isConnected: function isConnected(appid) { 87 | if (typeof Bots[appid] === 'undefined') { 88 | return false; 89 | } 90 | 91 | return Bots[appid].isConnected; 92 | }, 93 | 94 | connect: function connect(application) { 95 | 96 | var appid = application.appId; 97 | 98 | console.log('Connecting to ' + appid); 99 | 100 | if (typeof Bots[appid] === 'undefined' || Bots[appid].isConnected === false) { 101 | 102 | request.post('https://slack.com/api/rtm.start', 103 | { 104 | json: true, 105 | form: { 106 | token: application.slackBotToken, 107 | t: Date.now() 108 | } 109 | }, 110 | function(error, response, connection) { 111 | 112 | if (!error && response.statusCode === 200 && typeof connection.ok !== 'undefined' && connection.ok === true) { 113 | 114 | Bots[appid] = new events.EventEmitter(); 115 | Bots[appid].websocket = new WebSocket(connection.url); 116 | Bots[appid].application = application; 117 | Bots[appid].isConnected = false; 118 | Bots[appid].msgCount = 0; 119 | Bots[appid].nick = connection.self.id; 120 | Bots[appid].team = connection.team.id; 121 | Bots[appid].teamDomain = connection.team.domain; 122 | Bots[appid].bootedAt = moment().utc().unix(); 123 | Bots[appid].channels = []; 124 | Bots[appid].errors = []; 125 | 126 | console.log('T: ' + Object.size(Bots)); 127 | 128 | // Read Channels 129 | self.addChannels(appid, connection.channels); 130 | 131 | // Add Users to DB 132 | self.addUsers(appid, connection.users); 133 | 134 | // Socket Listner 135 | Bots[appid].websocket.addListener('open', function() { 136 | console.log(appid + ' is now open'); 137 | }); 138 | 139 | Bots[appid].addListener('hello', function() { 140 | console.log(appid + ' said hello'); 141 | Bots[appid].isConnected = true; 142 | //self.say(appid, self.getChannelCode(appid, 'general'), 'I\'m online!'); 143 | }); 144 | 145 | Bots[appid].websocket.addListener('close', function() { 146 | Bots[appid].isConnected = false; 147 | Bots[appid].removeAllListeners(); 148 | delete Bots[appid]; 149 | console.log('Connection closed ' + appid); 150 | }); 151 | 152 | // Websocket Events 153 | Bots[appid].websocket.addListener('message', function(data) { 154 | var message = JSON.parse(data); 155 | 156 | // Gambiarra 157 | Bots[appid].msgCount++; 158 | // Ignore the 2 message (last message) 159 | if (Bots[appid].msgCount === 2) { 160 | return; 161 | } 162 | 163 | if (message.type === 'message' && message.channel.indexOf('C') === 0 && typeof message.subtype === 'undefined') { 164 | 165 | console.log('Channel message %j', message); 166 | Bots[appid].emit('message', message); 167 | 168 | } else if (message.type === 'message' && message.channel.indexOf('C') === 0 && message.subtype === 'file_share') { 169 | 170 | console.log('File shared %j', message); 171 | var sharedMessage = { text: 'Shared a file: ' + message.file.name + '', channel: message.channel }; 172 | Bots[appid].emit('message', sharedMessage); 173 | 174 | } else if (message.type === 'message' && message.channel.indexOf('D') === 0) { 175 | 176 | console.log('Direct message %j', message); 177 | Bots[appid].emit('direct_message', message); 178 | 179 | } else if (message.type === 'file_public') { 180 | 181 | console.log('File public shared %j', message); 182 | //Bots[appid].emit('message', message); 183 | 184 | } else if (message.type === 'file_shared') { 185 | 186 | console.log('File shared %j', message); 187 | //Bots[appid].emit('message', message); 188 | 189 | } else if (message.type === 'presence_change') { 190 | 191 | console.log('Presence changed %s %j', message.type, message); 192 | 193 | var usr = Users.where(function(usr) { return usr.appid === appid && usr.user.id === message.user; }); 194 | 195 | if (usr !== null && usr.length === 1) { 196 | usr = usr[0]; 197 | usr.user.presence = message.presence; 198 | Users.update(usr); 199 | } 200 | 201 | } else if (typeof message.type !== 'undefined' && message.type !== 'message') { 202 | 203 | console.log('Other message %s %j', message.type, message); 204 | Bots[appid].emit(message.type, message); 205 | 206 | } else { 207 | console.log('Undefined message %j', message); 208 | } 209 | }); 210 | 211 | Bots[appid].addListener('error', function(e) { 212 | console.error(appid + ' had an error'); 213 | }); 214 | 215 | // Direct message 216 | Bots[appid].addListener('direct_message', function(message) { 217 | 218 | // If command 219 | if (message.text.indexOf('!') === 0 && message.text.length > 1) { 220 | var command = message.text.substring(1, message.text.length); 221 | 222 | console.log('It\'s a command: ' + command); 223 | 224 | if (command === 'time') { 225 | self.say(appid, message.channel, '_It\'s now: *' + moment().utc().format() + '*._'); 226 | } else if (command === 'uptime') { 227 | var time = moment(Bots[appid].bootedAt, 'X').utc(); 228 | self.say(appid, message.channel, '_Uptime: *' + time.fromNow() + '* @ *' + time.format() + '*._'); 229 | } else { 230 | // Command not valid! 231 | self.say(appid, message.channel, '_Sorry! Couldn\'t reconize the command: *' + command + '*._'); 232 | } 233 | 234 | } else { 235 | // Reply 236 | self.say(appid, message.channel, 'You said: _' + message.text + '_'); 237 | } 238 | 239 | }); 240 | 241 | return Bots[appid]; 242 | } 243 | }); 244 | } else { 245 | console.log('Already connected!'); 246 | console.log('T: ' + Object.size(Bots)); 247 | 248 | return Bots[appid]; 249 | } 250 | }, 251 | 252 | say: function say(appid, channel, message) { 253 | 254 | if (typeof Bots[appid] === 'undefined') { 255 | return true; 256 | } 257 | 258 | var data = { 259 | 'type': 'message', 260 | 'channel': channel, //D... or C.... 261 | 'user': Bots[appid].nick, 262 | 'text': message, 263 | 'ts': Date.now() + '.000000', 264 | 'team': Bots[appid].team 265 | }; 266 | 267 | Bots[appid].websocket.send(JSON.stringify(data), function(error) { 268 | if (error) { 269 | console.error('Error sending data to socket!', error); 270 | console.log(data); 271 | } 272 | }); 273 | }, 274 | 275 | // Recover History 276 | history: function history(application, channel, callback) { 277 | 278 | var formData = { 279 | // Pass Slack token 280 | token: application.slackApiToken, 281 | // Pass Slack channel 282 | channel: channel, 283 | // Number of messages to return (max: 100) 284 | count: 50 285 | }; 286 | 287 | // Sending the request 288 | request.post( 289 | 'https://slack.com/api/channels.history', 290 | { 291 | json: true, 292 | formData: formData 293 | }, 294 | 295 | function(error, response, body) { 296 | if (!error && response.statusCode === 200 && typeof body.ok !== 'undefined' && body.ok === true) { 297 | return callback(null, body, application); 298 | } else { 299 | return callback('Error fetching history'); 300 | } 301 | }); 302 | }, 303 | 304 | // Upload a file 305 | uploadFile: function uploadFile(applicationToken, channel, stream) { 306 | 307 | var formData = { 308 | // Pass Slack token 309 | token: applicationToken, 310 | // Pass Slack channel 311 | channels: channel, 312 | // Pass data via file stream 313 | file: { 314 | value: fs.createReadStream(stream.file.path), 315 | options: { 316 | filename: stream.file.name, 317 | contentType: stream.file.type 318 | } 319 | } 320 | }; 321 | 322 | // Sending the request 323 | request.post( 324 | 'https://slack.com/api/files.upload', 325 | { 326 | 'content-type': 'multipart\/form-data', 327 | formData: formData 328 | }, function(error, response, body) { 329 | 330 | if (!error && response.statusCode === 200 && typeof body.ok !== 'undefined' && body.ok === true) { 331 | console.log('File (' + stream.file.name + ') Uploaded'); 332 | } else { 333 | console.log('File (' + stream.file.name + ') Not Uploaded'); 334 | } 335 | }); 336 | }, 337 | 338 | // Disconect one websocket 339 | disconnect: function disconnect(appid) { 340 | 341 | if (typeof Bots[appid] !== 'undefined') { 342 | // self.say(appid, self.getChannelCode(appid, 'general'), 'I\'m going offline!'); 343 | Bots[appid].websocket.close(); 344 | } 345 | 346 | return true; 347 | }, 348 | 349 | // Disconect all webockets 350 | disconnectAll: function disconnectAll() { 351 | 352 | for (var appid in Bots) { 353 | if (Bots.hasOwnProperty(appid)) { 354 | this.disconnect(appid); 355 | } 356 | } 357 | 358 | return true; 359 | } 360 | }; 361 | -------------------------------------------------------------------------------- /utils/client.js: -------------------------------------------------------------------------------- 1 | var async = require('async'); 2 | var request = require('request'); // github.com/mikeal/request 3 | var formidable = require('formidable'); 4 | var crypto = require('crypto'); 5 | 6 | module.exports = function(app, io, slack, App) { 7 | 8 | var application = null; 9 | 10 | function isAuthorized(req, res, next) { 11 | 12 | var appid = req.param('appid'); 13 | 14 | if (appid === null) { 15 | return res.status(401).json({ success: false, message: 'Unauthorized' }); 16 | } 17 | 18 | App.findOne({ appId: appid }, function(err, app) { 19 | if (err) { 20 | console.error(err); 21 | return res.status(500).json({ success: false, message: 'Error' }); 22 | } 23 | 24 | if (app === null) { 25 | return res.status(401).json({ success: false, message: 'Unauthorized' }); 26 | } 27 | 28 | if (app.online === false) { 29 | return res.status(503).json({ success: false, message: 'Support offline' }); 30 | } 31 | 32 | if (app.active === false) { 33 | return res.status(404).json({ success: false, message: 'Application offline' }); 34 | } 35 | 36 | application = app; 37 | 38 | return next(); 39 | }); 40 | } 41 | 42 | function isAdmin(req, res, next) { 43 | 44 | var appid = req.param('appid'); 45 | var token = req.param('token'); // Private token 46 | 47 | if (appid === null || token === null) { 48 | return res.status(401).json({ success: false, message: 'Unauthorized' }); 49 | } 50 | 51 | // TODO: use the real token 52 | App.findOne({ appId: appid, slackApiToken: token }, function(err, app) { 53 | if (err) { 54 | console.error(err); 55 | return res.status(500).json({ success: false, message: 'Error' }); 56 | } 57 | 58 | if (app === null) { 59 | return res.status(401).json({ success: false, message: 'Unauthorized' }); 60 | } 61 | 62 | if (app.online === false) { 63 | return res.status(503).json({ success: false, message: 'Support offline' }); 64 | } 65 | 66 | if (app.active === false) { 67 | return res.status(404).json({ success: false, message: 'Application offline' }); 68 | } 69 | 70 | application = app; 71 | 72 | return next(); 73 | }); 74 | } 75 | 76 | app.post('/app/file-upload', isAuthorized, function(req, res, next) { 77 | 78 | // Retrieve Prudio appid 79 | var appid = req.param('appid'); 80 | 81 | // Retrieve Slack channel 82 | var channel = req.param('channel'); 83 | 84 | // Create the POST parser object 85 | var form = new formidable.IncomingForm(); 86 | 87 | // Parse data from POST 88 | form.parse(req, function(err, fields, files) { 89 | App.findOne({ appId: appid, active: true }, function(err, application) { 90 | if (err) { 91 | console.error(err); 92 | return res.status(500).json({ success: false, message: 'Error' }); 93 | } 94 | 95 | slack.uploadFile(application.slackApiToken, channel, files); 96 | 97 | return res.status(200).json({ success: true, message: 'Uploading' }); 98 | }); 99 | }); 100 | 101 | }); 102 | 103 | // TODO: Use diferent method for authorization 104 | app.post('/app/connect', isAdmin, function(req, res, next) { 105 | var appid = req.param('appid'); 106 | 107 | App.findOne({ appId: appid, active: true }, function(err, application) { 108 | if (err) { 109 | console.error(err); 110 | return res.status(500).json({ success: false, message: 'Error' }); 111 | } 112 | 113 | slack.connect(application); 114 | 115 | return res.status(200).json({ success: true, message: 'Initializing' }); 116 | }); 117 | }); 118 | 119 | // TODO: Use diferent method for authorization 120 | app.post('/app/disconnect', isAdmin, function(req, res, next) { 121 | var appid = req.param('appid'); 122 | App.findOne({ appId: appid, active: true }, function(err, application) { 123 | if (err) { 124 | console.error(err); 125 | return res.status(500).json({ success: false, message: 'Error' }); 126 | } 127 | 128 | slack.disconnect(appid); 129 | 130 | return res.status(200).json({ success: true, message: 'Disconnecting' }); 131 | }); 132 | }); 133 | 134 | app.post('/app/ping', isAuthorized, function(req, res, next) { 135 | var appid = req.param('appid'); 136 | App.findOne({ appId: appid, active: true }, function(err, application) { 137 | if (err) { 138 | console.error(err); 139 | return res.status(500).json({ success: false, message: 'Error' }); 140 | } 141 | 142 | var onlineUsers = slack.onlineUsers(application.appId); 143 | 144 | return res.status(200).json({ success: true, onlineUsers: onlineUsers.length, message: onlineUsers.length + ' users online.' }); 145 | }); 146 | }); 147 | 148 | app.post('/chat/history', isAuthorized, function(req, res, next) { 149 | 150 | var appid = req.param('appid'); 151 | var channel = req.param('channel'); 152 | var channelSignature = req.param('signature'); 153 | 154 | async.waterfall( 155 | [ 156 | function(callback) { 157 | App.findOne({ appId: appid, active: true }, function(err, application) { 158 | if (err) { 159 | return callback(err); 160 | } 161 | 162 | return callback(null, application); 163 | }); 164 | }, 165 | 166 | function(application, callback) { 167 | // Verify if the user already has previous support (from cookies) 168 | if (channel !== null && channelSignature !== null) { 169 | // Returning user with cookie 170 | var verify = crypto.createHmac('sha1', application.slackApiToken).update(channel.concat(appid)).digest('hex'); 171 | 172 | // Verify signature else it will create a new one! 173 | if (verify === channelSignature) { 174 | return callback(null, application); 175 | } else { 176 | return callback('Could not verify signature'); 177 | } 178 | } 179 | }, 180 | 181 | function(application, callback) { 182 | return slack.history(application, channel, callback); 183 | } 184 | ], 185 | 186 | function(err, body, application) { 187 | if (err) { 188 | return res.status(200).json({ success: false, result: err }); 189 | } 190 | 191 | body.messages.reverse(); 192 | 193 | var messages = []; 194 | 195 | for (var i in body.messages) { 196 | if (body.messages.hasOwnProperty(i)) { 197 | var message = body.messages[i]; 198 | if (message.type === 'message' && typeof message.subtype === 'undefined' && message.text !== '_User disconnected!_' && message.text !== '_User connected!_') { 199 | console.log('Channel message: %j', message); 200 | 201 | if (message.user === application.slackInviteBot) { 202 | message.sender = 'self'; 203 | } else { 204 | message.sender = 'other'; 205 | } 206 | 207 | message.user = undefined; 208 | message.type = undefined; 209 | 210 | messages.push(message); 211 | } 212 | } 213 | } 214 | 215 | return res.status(200).json({ success: true, messages: messages, messagesCount: messages.length }); 216 | } 217 | ); 218 | 219 | }); 220 | 221 | app.post('/chat/continue', isAuthorized, function(req, res, next) { 222 | 223 | var appid = req.param('appid'); 224 | var channelId = req.param('channel'); 225 | var channelName = req.param('channelName'); 226 | var channelSignature = req.param('signature'); 227 | 228 | App.findOne({ appId: appid, active: true }, function(err, application) { 229 | if (err) { 230 | console.error(err); 231 | return res.status(500).json({ success: false, message: 'Error' }); 232 | } 233 | 234 | if (application === null) { 235 | return res.status(404).json({ success: false, message: 'Not found' }); 236 | } 237 | 238 | async.waterfall( 239 | [ 240 | function(callback) { 241 | 242 | // Verify if the user already has previous support (from cookies) 243 | if (channelId !== null && channelSignature !== null) { 244 | // Returning user with cookie 245 | var verify = crypto.createHmac('sha1', application.slackApiToken).update(channelId.concat(appid)).digest('hex'); 246 | 247 | // Verify signature else it will create a new one! 248 | if (verify === channelSignature) { 249 | return callback(null, channelName, channelId); 250 | } 251 | } 252 | 253 | return callback('Wrong signature.'); 254 | }, 255 | 256 | // Send notification 257 | function(channelName, channelId, callback) { 258 | 259 | var text = 'User came back at <#' + channelId + '|' + channelName + '>.'; 260 | 261 | request.post(app.get('slack_api_url') + '/chat.postMessage', 262 | { 263 | json: true, 264 | form: { 265 | token: application.slackApiToken, 266 | channel: application.notifyChannel, 267 | text: text, username: 'Prud.io', 268 | //jscs:disable 269 | icon_url: 'https://chat.prud.io/prudio-notification-icon.png' 270 | //jscs:enable 271 | } 272 | }, function(error, response, body) { 273 | if (!error && response.statusCode === 200) { 274 | return callback(null, channelName, channelId); 275 | } 276 | return callback('Notification message'); 277 | }); 278 | }, 279 | 280 | ], 281 | function(err, channelName, channelId) { 282 | if (err) { 283 | console.error(err); 284 | return res.status(404).json({ error: 'Error: ' + err }); 285 | } 286 | 287 | var signature = crypto.createHmac('sha1', application.slackApiToken).update(channelId.concat(appid)).digest('hex'); 288 | 289 | return res.status(200).json({ success: true, channel: channelId, channelName: channelName, signature: signature }); 290 | } 291 | ); 292 | }); 293 | 294 | }); 295 | 296 | app.post('/chat/create', isAuthorized, function(req, res, next) { 297 | 298 | var appid = req.param('appid'); 299 | var channelId = req.param('channel'); 300 | var channelName = req.param('channelName'); 301 | var channelSignature = req.param('signature'); 302 | var userInfo = req.param('userInfo'); 303 | var settings = req.param('settings'); 304 | 305 | App.findOne({ appId: appid, active: true }, function(err, application) { 306 | if (err) { 307 | console.error(err); 308 | return res.status(500).json({ success: false, message: 'Error' }); 309 | } 310 | 311 | if (application === null) { 312 | return res.status(404).json({ success: false, message: 'Not found' }); 313 | } 314 | 315 | async.waterfall( 316 | [ 317 | function(callback) { 318 | 319 | // Verify if the user already has previous support (from cookies) 320 | if (channelId !== null && channelSignature !== null) { 321 | // Returning user with cookie 322 | var verify = crypto.createHmac('sha1', application.slackApiToken).update(channelId.concat(appid)).digest('hex'); 323 | 324 | // Verify signature else it will create a new one! 325 | if (verify === channelSignature) { 326 | return callback(null, channelName, channelId); 327 | } 328 | } 329 | 330 | // No channel or signature, or invalid signature/channel, get the next channel 331 | application.update({ $inc: { roomCount: 1 }}, function(err, affected) { 332 | if (err) { 333 | return callback(err); 334 | } 335 | 336 | var channelName = application.roomPrefix + application.roomCount; 337 | return callback(null, channelName, null); 338 | 339 | }); 340 | }, 341 | 342 | // Create channel 343 | function(channelName, channelId, callback) { 344 | 345 | if (channelId !== null) { 346 | return callback(null, channelName, channelId, true); 347 | } else { 348 | 349 | request.post(app.get('slack_api_url') + '/channels.join', 350 | { 351 | json: true, 352 | form: { 353 | token: application.slackApiToken, 354 | name: channelName 355 | } 356 | }, function(error, response, body) { 357 | if (!error && response.statusCode === 200 && typeof body.channel !== 'undefined') { 358 | return callback(null, channelName, body.channel.id, false); 359 | } 360 | 361 | return callback('Create Channel'); 362 | }); 363 | } 364 | }, 365 | 366 | // Invite user to channel 367 | function(channelName, channelId, returning, callback) { 368 | request.post(app.get('slack_api_url') + '/channels.invite', 369 | { 370 | json: true, 371 | form: { 372 | token: application.slackApiToken, 373 | channel: channelId, 374 | user: application.slackInviteBot 375 | } 376 | }, function(error, response, body) { 377 | if (!error && response.statusCode === 200) { 378 | return callback(null, channelName, channelId, returning); 379 | } 380 | return callback('Invite user to channel'); 381 | }); 382 | }, 383 | 384 | // Set topic of channel 385 | function(channelName, channelId, returning, callback) { 386 | 387 | if (returning) { 388 | return callback(null, channelName, channelId, returning); 389 | } 390 | 391 | var personal = JSON.parse(settings); 392 | 393 | var topic = personal.name + ' (' + personal.email + ')'; 394 | 395 | request.post(app.get('slack_api_url') + '/channels.setTopic', 396 | { 397 | json: true, 398 | form: { 399 | token: application.slackApiToken, 400 | channel: channelId, 401 | topic: topic 402 | } 403 | }, 404 | function(error, response, body) { 405 | if (!error && response.statusCode === 200) { 406 | return callback(null, channelName, channelId, returning); 407 | } 408 | 409 | return callback('Set topic of channel'); 410 | }); 411 | }, 412 | 413 | // Set purpose of channel 414 | function(channelName, channelId, returning, callback) { 415 | 416 | if (returning) { 417 | return callback(null, channelName, channelId); 418 | } 419 | 420 | var info = JSON.parse(userInfo); 421 | 422 | var purpose = 'Help!' + 423 | '\nURL: ' + info.url + ' (' + req.ip + ')' + 424 | '\nBrowser: ' + info.browser + ' - ' + info.browserVersion + 425 | '\nOS: ' + info.os + ' - ' + info.osVersion + 426 | '\nMobile: ' + info.mobile + ' - Screen resolution: ' + info.screen; 427 | 428 | request.post(app.get('slack_api_url') + '/channels.setPurpose', 429 | { 430 | json: true, 431 | form: { 432 | token: application.slackApiToken, 433 | channel: channelId, 434 | purpose: purpose 435 | } 436 | }, function(error, response, body) { 437 | if (!error && response.statusCode === 200) { 438 | return callback(null, channelName, channelId); 439 | } 440 | 441 | return callback('Set purpose of channel'); 442 | }); 443 | }, 444 | 445 | // Leave the channel 446 | function(channelName, channelId, callback) { 447 | 448 | if (!application.join) { 449 | request.post(app.get('slack_api_url') + '/channels.leave', 450 | { 451 | json: true, 452 | form: { 453 | token: application.slackApiToken, 454 | channel: channelId 455 | } 456 | }, function(error, response, body) { 457 | if (!error && response.statusCode === 200) { 458 | return callback(null, channelName, channelId); 459 | } 460 | 461 | return callback('Leave the channel'); 462 | }); 463 | } else { 464 | return callback(null, channelName, channelId); 465 | } 466 | }, 467 | 468 | // Send notification 469 | function(channelName, channelId, callback) { 470 | 471 | var text = 'New help request at channel <#' + channelId + '|' + channelName + '>. Join now!'; 472 | 473 | request.post(app.get('slack_api_url') + '/chat.postMessage', 474 | { 475 | json: true, 476 | form: { 477 | token: application.slackApiToken, 478 | channel: application.notifyChannel, 479 | text: text, 480 | username: 'Prud.io', 481 | //jscs:disable 482 | icon_url: 'https://chat.prud.io/prudio-notification-icon.png' 483 | //jscs:enable 484 | } 485 | }, function(error, response, body) { 486 | if (!error && response.statusCode === 200) { 487 | return callback(null, channelName, channelId); 488 | } 489 | return callback('Notification message'); 490 | }); 491 | }, 492 | 493 | ], 494 | function(err, channelName, channelId) { 495 | if (err) { 496 | console.error(err); 497 | return res.status(404).json({ error: 'Error: ' + err }); 498 | } 499 | 500 | var signature = crypto.createHmac('sha1', application.slackApiToken).update(channelId.concat(appid)).digest('hex'); 501 | 502 | return res.status(200).json({ success: true, channel: channelId, channelName: channelName, signature: signature }); 503 | } 504 | ); 505 | }); 506 | 507 | }); 508 | 509 | }; 510 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | --------------------------------------------------------------------------------