├── .gitattributes
├── .gitignore
├── .npmignore
├── README.md
├── package.json
└── sourcequery.js


/.gitattributes:
--------------------------------------------------------------------------------
 1 | # Auto detect text files and perform LF normalization
 2 | * text=auto
 3 | 
 4 | # Custom for Visual Studio
 5 | *.cs     diff=csharp
 6 | *.sln    merge=union
 7 | *.csproj merge=union
 8 | *.vbproj merge=union
 9 | *.fsproj merge=union
10 | *.dbproj merge=union
11 | 
12 | # Standard to msysgit
13 | *.doc	 diff=astextplain
14 | *.DOC	 diff=astextplain
15 | *.docx diff=astextplain
16 | *.DOCX diff=astextplain
17 | *.dot  diff=astextplain
18 | *.DOT  diff=astextplain
19 | *.pdf  diff=astextplain
20 | *.PDF	 diff=astextplain
21 | *.rtf	 diff=astextplain
22 | *.RTF	 diff=astextplain
23 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | node_modules/
  2 | 
  3 | #################
  4 | ## Eclipse
  5 | #################
  6 | 
  7 | *.pydevproject
  8 | .project
  9 | .metadata
 10 | bin/
 11 | tmp/
 12 | *.tmp
 13 | *.bak
 14 | *.swp
 15 | *~.nib
 16 | local.properties
 17 | .classpath
 18 | .settings/
 19 | .loadpath
 20 | 
 21 | # External tool builders
 22 | .externalToolBuilders/
 23 | 
 24 | # Locally stored "Eclipse launch configurations"
 25 | *.launch
 26 | 
 27 | # CDT-specific
 28 | .cproject
 29 | 
 30 | # PDT-specific
 31 | .buildpath
 32 | 
 33 | 
 34 | #################
 35 | ## Visual Studio
 36 | #################
 37 | 
 38 | ## Ignore Visual Studio temporary files, build results, and
 39 | ## files generated by popular Visual Studio add-ons.
 40 | 
 41 | # User-specific files
 42 | *.suo
 43 | *.user
 44 | *.sln.docstates
 45 | 
 46 | # Build results
 47 | [Dd]ebug/
 48 | [Rr]elease/
 49 | *_i.c
 50 | *_p.c
 51 | *.ilk
 52 | *.meta
 53 | *.obj
 54 | *.pch
 55 | *.pdb
 56 | *.pgc
 57 | *.pgd
 58 | *.rsp
 59 | *.sbr
 60 | *.tlb
 61 | *.tli
 62 | *.tlh
 63 | *.tmp
 64 | *.vspscc
 65 | .builds
 66 | *.dotCover
 67 | 
 68 | ## TODO: If you have NuGet Package Restore enabled, uncomment this
 69 | #packages/
 70 | 
 71 | # Visual C++ cache files
 72 | ipch/
 73 | *.aps
 74 | *.ncb
 75 | *.opensdf
 76 | *.sdf
 77 | 
 78 | # Visual Studio profiler
 79 | *.psess
 80 | *.vsp
 81 | 
 82 | # ReSharper is a .NET coding add-in
 83 | _ReSharper*
 84 | 
 85 | # Installshield output folder
 86 | [Ee]xpress
 87 | 
 88 | # DocProject is a documentation generator add-in
 89 | DocProject/buildhelp/
 90 | DocProject/Help/*.HxT
 91 | DocProject/Help/*.HxC
 92 | DocProject/Help/*.hhc
 93 | DocProject/Help/*.hhk
 94 | DocProject/Help/*.hhp
 95 | DocProject/Help/Html2
 96 | DocProject/Help/html
 97 | 
 98 | # Click-Once directory
 99 | publish
100 | 
101 | # Others
102 | [Bb]in
103 | [Oo]bj
104 | sql
105 | TestResults
106 | *.Cache
107 | ClientBin
108 | stylecop.*
109 | ~$*
110 | *.dbmdl
111 | Generated_Code #added for RIA/Silverlight projects
112 | 
113 | # Backup & report files from converting an old project file to a newer
114 | # Visual Studio version. Backup files are not needed, because we have git ;-)
115 | _UpgradeReport_Files/
116 | Backup*/
117 | UpgradeLog*.XML
118 | 
119 | 
120 | 
121 | ############
122 | ## Windows
123 | ############
124 | 
125 | # Windows image file caches
126 | Thumbs.db
127 | 
128 | # Folder config file
129 | Desktop.ini
130 | 
131 | 
132 | #############
133 | ## Python
134 | #############
135 | 
136 | *.py[co]
137 | 
138 | # Packages
139 | *.egg
140 | *.egg-info
141 | dist
142 | build
143 | eggs
144 | parts
145 | bin
146 | var
147 | sdist
148 | develop-eggs
149 | .installed.cfg
150 | 
151 | # Installer logs
152 | pip-log.txt
153 | 
154 | # Unit test / coverage reports
155 | .coverage
156 | .tox
157 | 
158 | #Translations
159 | *.mo
160 | 
161 | #Mr Developer
162 | .mr.developer.cfg
163 | 
164 | # Mac crap
165 | .DS_Store
166 | 


--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | 
2 | .gitignore
3 | .gitattributes
4 | node_modules/


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | SourceQuery
 2 | ===========
 3 | 
 4 | A Source Server Query protocol implementation for node.js
 5 | 
 6 | Protocol specification can be found here: https://developer.valvesoftware.com/wiki/Server_queries
 7 | 
 8 | Usage
 9 | -----
10 | 
11 | Install with npm:
12 | 
13 |     npm install sourcequery
14 | 
15 | Example usage:
16 | 
17 | ```js
18 | var SourceQuery = require('sourcequery');
19 | 
20 | var sq = new SourceQuery(1000); // 1000ms timeout
21 | sq.open('87.106.131.249', 27015);
22 | 
23 | sq.getInfo(function(err, info){
24 |     console.log('Server Info:', info);
25 | });
26 | 
27 | sq.getPlayers(function(err, players){
28 |     console.log('Online Players:', players);
29 | });
30 | 
31 | sq.getRules(function(err, rules){
32 |     console.log('Server Rules:', rules);
33 | });
34 | 
35 | sq.close(function(){
36 | 	// socket closes when all pending queries have returned or timed out
37 | 	console.log('Socket closed.');
38 | });
39 | ```
40 | 
41 | Licence
42 | -------
43 | > Copyright (c) 2013, Gareth Hughes
44 | > All rights reserved.
45 | > 
46 | > Redistribution and use in source and binary forms, with or without
47 | > modification, are permitted provided that the following conditions are met: 
48 | > 
49 | > 1. Redistributions of source code must retain the above copyright notice, this
50 | >    list of conditions and the following disclaimer. 
51 | > 2. Redistributions in binary form must reproduce the above copyright notice,
52 | >    this list of conditions and the following disclaimer in the documentation
53 | >    and/or other materials provided with the distribution. 
54 | > 
55 | > THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
56 | > ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
57 | > WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
58 | > DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
59 | > ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
60 | > (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
61 | > LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
62 | > ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
63 | > (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
64 | > SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
65 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "sourcequery",
 3 |     "version": "0.0.1",
 4 |     "description": "A Source Server Query protocol implementation for node.js",
 5 |     "keywords": ["srcds","source","query"],
 6 |     "homepage": "https://github.com/flamescape/SourceQuery/",
 7 |     "bugs": {"url":"https://github.com/flamescape/SourceQuery/issues"},
 8 |     "author": {
 9 |         "name": "Gareth Hughes",
10 |         "url": "http://flamescape.com"
11 |     },
12 |     "main": "sourcequery",
13 |     "repository": {
14 |         "type": "git",
15 |         "url": "https://github.com/flamescape/SourceQuery.git"
16 |     },
17 |     "dependencies": {
18 |         "bufferpack": "0.0.6"
19 |     }
20 | }
21 | 


--------------------------------------------------------------------------------
/sourcequery.js:
--------------------------------------------------------------------------------
  1 | var dgram = require('dgram')
  2 |   , bp = require('bufferpack')
  3 |   ;
  4 | 
  5 | var Answer = function() {
  6 |     this.compressed = false;
  7 | 	this.parts = [];
  8 |     this.partsfound = 0;
  9 | };
 10 | 
 11 | Answer.prototype.add = function(id, buffer) {
 12 | 	var head = bp.unpack('<ibbh', buffer);
 13 | 	if ((head[0] & 0x80000000) !== 0) {
 14 | 		this.compressed = true;
 15 | 	}
 16 | 	this.totalpackets = head[1];
 17 |     this.partsfound++;
 18 | 	this.parts[head[2]] = buffer;
 19 | };
 20 | Answer.prototype.isComplete = function() {
 21 | 	return (this.partsfound == this.totalpackets);
 22 | };
 23 | Answer.prototype.assemble = function() {
 24 | 	var combined = [];
 25 | 	for (var i = 0; i < this.parts.length; i++) {
 26 | 		var head = bp.unpack('<ibb', this.parts[i]);
 27 |         combined.push(this.parts[i].slice(head[2] == 1 ? 16 : 8));
 28 | 	}
 29 |     var payload = Buffer.concat(combined).slice(4);
 30 |     if (this.compressed) {
 31 |         console.warn('COMPRESSION NOT SUPPORTED. PAYLOAD:', payload);
 32 |     }
 33 |     return payload;
 34 | };
 35 | 
 36 | var SQUnpacker = function(messageEmitter, timeout) {
 37 |     this.timeout = timeout || 1000;
 38 | 	this.answers = {};
 39 | 	this.messageEmitter = messageEmitter;
 40 | 	this.messageEmitter.on('message', this.readMessage.bind(this));
 41 | }
 42 | 
 43 | SQUnpacker.prototype = Object.create(require('events').EventEmitter.prototype);
 44 | 
 45 | SQUnpacker.prototype.readMessage = function(buffer, remote){
 46 |     var that = this;
 47 |     
 48 | 	var header = bp.unpack('<i', buffer)[0];
 49 | 	buffer = buffer.slice(4);
 50 | 
 51 | 	if (header == -1) {
 52 | 		this.emit('message', buffer, remote);
 53 | 		return;
 54 | 	}
 55 | 	
 56 | 	if (header == -2) {
 57 | 		var ansID = bp.unpack('<i', buffer)[0];
 58 | 		var ans = this.answers[ansID];
 59 | 		if (!ans) {
 60 | 			ans = this.answers[ansID] = new Answer();
 61 |             setTimeout(function(){
 62 |                 // ensure that answers are not stored forever - discard after a timeout period
 63 |                 // this simply cleans up partial-responses
 64 |                 delete that.answers[ansID];
 65 |             }, this.timeout);
 66 | 		}
 67 | 		ans.add(ansID, buffer);
 68 | 		
 69 | 		if (ans.isComplete()) {
 70 | 			this.emit('message', ans.assemble(), remote);
 71 | 			delete this.answers[ansID];
 72 | 		}
 73 | 	}
 74 | };
 75 | 
 76 | var SourceQuery = function(timeout){
 77 |     timeout = timeout || 1000;
 78 | 
 79 |     var sq = this;
 80 | 	
 81 | 	var openQueries = 0;
 82 | 	var closingSocketCb;
 83 | 	var queryEnded = function(){
 84 | 		openQueries--;
 85 | 		if (!openQueries && !!closingSocketCb) {
 86 | 			sq.client.close();
 87 | 			closingSocketCb();
 88 | 		}
 89 | 	};
 90 |     
 91 |     var ids = {
 92 |         A2S_INFO: 'T',
 93 |         S2A_INFO: 'I',
 94 |         
 95 |         A2S_SERVERQUERY_GETCHALLENGE: 'W',
 96 |         S2A_SERVERQUERY_GETCHALLENGE: 'A',
 97 |         
 98 |         A2S_PLAYER: 'U',
 99 |         S2A_PLAYER: 'D',
100 |         
101 |         A2S_RULES: 'V',
102 |         S2A_RULES: 'E'
103 |     };
104 |     
105 |     var send = function(buffer, responseCode, cb) {
106 | 		cb = cb || function(){};
107 | 		openQueries++;
108 |         sq.client.send(buffer, 0, buffer.length, sq.port, sq.address, function(err, bytes){
109 |             var giveUpTimer;
110 |         
111 |             if (err) {
112 |                 cb(err, null);
113 | 				queryEnded();
114 |                 return;
115 |             }
116 |             
117 |             var relayResponse = function(buffer, remote){
118 |                 if (buffer.length < 1)
119 |                     return;
120 |                 
121 |                 if (bp.unpack('<s', buffer)[0] !== responseCode)
122 |                     return;
123 |                 
124 |                 sq.squnpacker.removeListener('message', relayResponse);
125 |                 clearTimeout(giveUpTimer);
126 |                 cb(null, buffer.slice(1));
127 | 				queryEnded();
128 |             };
129 |             
130 |             giveUpTimer = setTimeout(function(){
131 |                 sq.squnpacker.removeListener('message', relayResponse);
132 |                 cb('timeout', null);
133 | 				queryEnded();
134 |             }, timeout);
135 |             
136 |             sq.squnpacker.on('message', relayResponse);
137 |         });
138 |     };
139 |     
140 |     var combine = function(keys, values) {
141 |         var pairs = {};
142 |         for (var i = 0; i < values.length; i++) {
143 |             pairs[keys[i]] = values[i];
144 |         }
145 |         return pairs;
146 |     };
147 | 
148 |     sq.open = function(address, port, errorHandler) {
149 |         sq.address = address;
150 |         sq.port = port;
151 |         sq.client = dgram.createSocket('udp4');
152 |         sq.client.on('error', errorHandler || function(){});
153 |         sq.squnpacker = new SQUnpacker(sq.client);
154 |     };
155 |     
156 |     sq.getChallengeKey = function(reqType, cb) {
157 | 		cb = cb || function(){};
158 |         send(bp.pack('<isi', [-1, reqType, -1]), ids.S2A_SERVERQUERY_GETCHALLENGE, function(err, buffer){
159 |             if (err) {
160 |                 cb(err, buffer);
161 |                 return;
162 |             }
163 |             
164 |             cb(null, bp.unpack('<i', buffer)[0]);
165 |         });
166 |     };
167 |     
168 |     sq.getInfo = function(cb) {
169 | 		cb = cb || function(){};
170 |         send(bp.pack('<isS', [-1, ids.A2S_INFO, 'Source Engine Query']), ids.S2A_INFO, function(err, buffer){
171 |             if (err) {
172 |                 cb(err, buffer);
173 |                 return;
174 |             }
175 |             
176 |             var infoArray = bp.unpack('<bSSSShBBBssBB', buffer);
177 |             var info = combine(
178 |                 ['protocol', 'name', 'map', 'folder', 'game', 'appid', 'players', 'maxplayers', 'bots', 'servertype', 'environment', 'password', 'vac'],
179 |                 infoArray
180 |             );
181 |             
182 |             var offset = bp.calcLength('<bSSSShBBBssBB', infoArray);
183 |             buffer = buffer.slice(offset);
184 |             
185 |             // if "The Ship"
186 |             if (info.appid == 2400) {
187 |                 var shipInfo = combine(
188 |                     ['ship-mode','ship-witnesses','ship-duration'],
189 |                     bp.unpack('<bbb', buffer)
190 |                 );
191 |                 for (var i in shipInfo) {
192 |                     info[i] = shipInfo[i];
193 |                 }
194 |                 buffer = buffer.slice(3);
195 |             }
196 |             
197 |             info.version = bp.unpack('<S', buffer)[0];
198 |             offset = bp.calcLength('<S', [info.version]);
199 |             buffer = buffer.slice(offset);
200 |             
201 |             if (buffer.length > 1) {
202 |                 offset = 0;
203 |                 var EDF = bp.unpack('<b', buffer)[0];
204 |                 offset += 1;
205 |                 
206 |                 if ((EDF & 0x80) !== 0) {
207 |                     info.port = bp.unpack('<h', buffer, offset)[0];
208 |                     offset += 2;
209 |                 }
210 |                 
211 |                 if ((EDF & 0x10) !== 0) {
212 |                     info.steamID = bp.unpack('<ii', buffer, offset)[0];
213 |                     offset += 8;
214 |                 }
215 |                 
216 |                 if ((EDF & 0x40) !== 0) {
217 |                     var tvinfo = bp.unpack('<hS', buffer, offset);
218 |                     info['tv-port'] = tvinfo[0];
219 |                     info['tv-name'] = tvinfo[1];
220 |                     offset += bp.calcLength('<hS', tvinfo);
221 |                 }
222 |                 
223 |                 if ((EDF & 0x20) !== 0) {
224 |                     info.keywords = bp.unpack('<S', buffer, offset)[0];
225 |                     offset += bp.calcLength('<S', info.keywords);
226 |                 }
227 |                 
228 |                 if ((EDF & 0x01) !== 0) {
229 |                     info.gameID = bp.unpack('<i', buffer, offset)[0];
230 |                     offset += 4;
231 |                 }
232 |             }
233 |             
234 |             cb(null, info);
235 |         });
236 |     };
237 |     
238 |     sq.getPlayers = function(cb) {
239 | 		cb = cb || function(){};
240 |         sq.getChallengeKey(ids.A2S_PLAYER, function(err, key){
241 |             if (err) {
242 |                 cb(err, key);
243 |                 return;
244 |             }
245 |         
246 |             send(bp.pack('<isi', [-1, ids.A2S_PLAYER, key]), ids.S2A_PLAYER, function(err, buffer){
247 |                 if (err) {
248 |                     cb(err, buffer);
249 |                     return;
250 |                 }
251 |             
252 |                 var playerCount = bp.unpack('<b', buffer)[0];
253 |                 var players = [];
254 |                 var offset = 1;
255 |                 for (var i = 0; i < playerCount; i++) {
256 |                     var p = bp.unpack('<bSif', buffer, offset);
257 |                     players.push(combine(
258 |                         ['index', 'name', 'score', 'online'],
259 |                         p
260 |                     ));
261 |                     offset += bp.calcLength('<bSif', p);
262 |                 }
263 |                 cb(null, players);
264 |             });
265 |         });
266 |     };
267 |     
268 |     sq.getRules = function(cb) {
269 | 		cb = cb || function(){};
270 |         sq.getChallengeKey(ids.A2S_RULES, function(err, key){
271 |             if (err) {
272 |                 cb(err, key);
273 |                 return;
274 |             }
275 |         
276 |             send(bp.pack('<isi', [-1, ids.A2S_RULES, key]), ids.S2A_RULES, function(err, buffer){
277 |                 if (err) {
278 |                     cb(err, buffer);
279 |                     return;
280 |                 }
281 |             
282 |                 var ruleCount = bp.unpack('<h', buffer)[0];
283 |                 var rules = [];
284 |                 var offset = 2;
285 |                 for (var i = 0; i < ruleCount; i++) {
286 |                     var r = bp.unpack('<SS', buffer, offset);
287 |                     rules.push(combine(['name', 'value'], r));
288 |                     offset += bp.calcLength('<SS', r);
289 |                 }
290 |                 cb(null, rules);
291 |             });
292 |         });
293 |     };
294 |     
295 |     sq.close = function(cb) {
296 | 		cb = cb || function(){};
297 | 		if (openQueries > 0) {
298 | 			closingSocketCb = cb;
299 | 		} else {
300 | 			sq.client.close();
301 | 			cb();
302 | 		}
303 |     };
304 | };
305 | 
306 | module.exports = SourceQuery;
307 | 


--------------------------------------------------------------------------------