-
Notifications
You must be signed in to change notification settings - Fork 2
/
gameservers.module
446 lines (395 loc) · 12.4 KB
/
gameservers.module
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
<?php
// $Id$
/**
* @file
* Acquire and display information from a variety of game servers.
*/
// ------------------------------------------------------------------
// Drupal hooks
// ------------------------------------------------------------------
/**
* Implementation of hook_help().
*/
function gameservers_help($path, $arg) {
$output = '';
switch ($path) {
case 'admin/help#gameservers':
$output = '<p>'. t('Acquire and display information from a variety of game servers.') .'</p>';
break;
case 'admin/build/gameservers':
$output = '<p>'. t('Add one or more game server for monitoring. You can view the list from the !server page.', array('!server' => l(t('Game servers'), 'gameservers'))) .'</p>';
break;
case 'admin/build/gameservers/add':
$output = '<p>'. t('Enter the information for your new game server. Remember to enable the newly created block in the <a href="@blocks">blocks administration page</a>.', array('@blocks' => url('admin/build/block'))) .'</p>';
break;
}
return $output;
}
/**
* Implementation of hook_perm().
*/
function gameservers_perm() {
return array(
'access game servers',
'administer game servers',
);
}
/**
* Implementation of hook_theme()
*/
function gameservers_theme() {
$theme = array();
$theme['gameservers_block'] = array(
'arguments' => array('server' => NULL, 'response' => NULL, 'style' => NULL),
'path' => gameservers_get_path('templates'),
);
// Register layout and style themes on behalf of all of these items.
$blocks = gameservers_get_blocks();
foreach ($blocks as $name => $data) {
if (!empty($data['theme'])) {
$theme[$data['theme']] = array(
'arguments' => array('server' => NULL, 'response' => NULL),
'path' => $data['path'],
);
// if no theme function exists, assume template.
if (!function_exists("theme_$data[theme]")) {
$theme[$data['theme']]['template'] = str_replace('_', '-', $data['theme']);
$theme[$data['theme']]['file'] = $data['file']; // for preprocess.
}
}
}
return $theme;
}
/**
* Implementation of hook_menu().
*/
function gameservers_menu() {
// -- Pages
$items['gameservers'] = array(
'title' => 'Game servers',
'page callback' => 'gameservers_browse',
'access arguments' => array('access game servers'),
'type' => MENU_NORMAL_ITEM,
'file' => 'gameservers.pages.inc',
);
$items['gameservers/%'] = array(
'title' => 'Game server details',
'page callback' => 'gameservers_details_page',
'page arguments' => array(1),
'access arguments' => array('access game servers'),
'type' => MENU_LOCAL_TASK,
'file' => 'gameservers.pages.inc',
);
// -- Admin pages
$items['admin/build/gameservers'] = array(
'title' => 'Game servers',
'description' => 'Configure game servers.',
'page callback' => 'gameservers_admin_overview',
'access arguments' => array('administer game servers'),
'file' => 'gameservers.admin.inc',
);
$items['admin/build/gameservers/list'] = array(
'title' => 'List',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
$items['admin/build/gameservers/add'] = array(
'title' => 'Add game server',
'page callback' => 'drupal_get_form',
'page arguments' => array('gameservers_admin_add_form'),
'access arguments' => array('administer game servers'),
'type' => MENU_LOCAL_TASK,
'file' => 'gameservers.admin.inc',
);
$items['admin/build/gameservers/edit/%'] = array(
'title' => 'Edit game server',
'page callback' => 'gameservers_admin_edit_page',
'page arguments' => array(4),
'access arguments' => array('administer game servers'),
'type' => MENU_CALLBACK,
'file' => 'gameservers.admin.inc',
);
$items['admin/build/gameservers/delete/%'] = array(
'title' => 'Delete game server',
'page callback' => 'drupal_get_form',
'page arguments' => array('gameservers_admin_delete_form', 4),
'access arguments' => array('administer game servers'),
'type' => MENU_CALLBACK,
'file' => 'gameservers.admin.inc',
);
$items['admin/build/gameservers/settings'] = array(
'title' => 'Configure',
'page callback' => 'drupal_get_form',
'page arguments' => array('gameservers_admin_configure'),
'access arguments' => array('administer game servers'),
'type' => MENU_LOCAL_TASK,
'file' => 'gameservers.admin.inc',
);
return $items;
}
/**
* Implementation of hook_block().
*/
function gameservers_block($op = 'list', $delta = 0, $edit = array()) {
gameservers_include('block');
switch ($op) {
case 'list':
return gameservers_block_list();
case 'configure':
return gameservers_block_configure($delta);
case 'save':
return gameservers_block_save($delta, $edit);
case 'view':
return gameservers_block_view($delta);
}
}
/**
* Implementation of hook_flush_caches().
*/
function gameservers_flush_caches() {
return array('gameservers_cache');
}
// ------------------------------------------------------------------
// CTools plugins integration (plugins.inc standalone support)
// ------------------------------------------------------------------
/**
* Wrapper for ctools_include('plugins').
*/
function gameservers_include_plugins() {
if (module_exists('ctools')) {
ctools_include('plugins');
}
elseif (!function_exists('ctools_get_plugins')) {
gameservers_include('plugins');
}
}
/**
* Implementation of hook_ctools_plugin_directory().
*/
function gameservers_ctools_plugin_directory($module, $plugin) {
if ($module == 'gameservers' && $plugin == 'query') {
return 'plugins';
}
if ($module == 'gameservers' && $plugin == 'blocks') {
return 'styles';
}
}
/**
* Fetch metadata on a specific query_library plugin.
*/
function gameservers_get_query_library($query_library) {
gameservers_include_plugins();
return ctools_get_plugins('gameservers', 'query', $query_library);
}
/**
* Fetch metadata for all query_library plugins.
*/
function gameservers_get_query_libraries() {
gameservers_include_plugins();
return ctools_get_plugins('gameservers', 'query');
}
/**
* Fetch metadata on a specific block plugin.
*/
function gameservers_get_block($block) {
gameservers_include_plugins();
return ctools_get_plugins('gameservers', 'blocks', $block);
}
/**
* Fetch metadata for all block plugins.
*/
function gameservers_get_blocks() {
gameservers_include_plugins();
return ctools_get_plugins('gameservers', 'blocks');
}
/**
* Get an instance of a class for a given plugin and id.
*
* @param $plugin
* A string that is the key of the plugin to load.
* @param $id
* A string that is the id of the object.
*
* @return GameServers_Query
* A GameServers_Query object.
*
* @throws Exception
* If plugin can't be instantiated.
*/
function gameservers_get_query_instance($id) {
static $instances = array();
if (!isset($instances[$id])) {
gameservers_include_plugins();
if ($class = ctools_plugin_load_class('gameservers', 'query', $id, 'handler')) {
$instances[$id] = new $class();
}
else {
gameservers_fatal_error(t('Missing gameservers query plugin. Check whether all required libraries are installed properly.'));
exit();
}
}
return $instances[$id];
}
// ------------------------------------------------------------------
// Game servers API functions
// ------------------------------------------------------------------
/**
* Load a game server object from the database.
*/
function gameservers_server_load($id, $reset = FALSE) {
static $servers = array();
if ($reset) {
$servers = array();
}
if (isset($servers[$id])) {
return drupal_clone($servers[$id]);
}
$server = db_fetch_object(db_query('SELECT * FROM {gameservers_server} WHERE id = %d', $id));
if ($server && $server->id) {
$server->config = unserialize($server->config);
$servers[$server->id] = drupal_clone($server);
}
return $server;
}
/**
* Save game server object to the database.
*/
function gameservers_server_save($server) {
if (empty($server->id)) {
return drupal_write_record('gameservers_server', $server);
}
return drupal_write_record('gameservers_server', $server, 'id');
}
/**
* Delete a game server.
*/
function gameservers_server_delete($id) {
if ($server = gameservers_server_load($id)) {
db_query("DELETE FROM {blocks} WHERE module = 'gameservers' AND delta = %d", $server->id);
db_query('DELETE FROM {gameservers_server} WHERE id = %d', $server->id);
// Clear the page and block caches.
cache_clear_all();
//drupal_set_message(t('Game server %name has been deleted.', array('%name' => $server->name)));
}
}
/**
* Generate a display of the query response to given game server.
*
* @param $server
* A game server object.
* @param $block
* Whether the game server is being displayed in a block.
* @param $page
* Whether the game server is being displayed by itself as a page.
*
* @return
* An HTML representation of the themed game server.
*/
function gameservers_server_view($server, $block = FALSE, $page = FALSE) {
$response = gameservers_server_query($server);
if ($block) {
$style = gameservers_get_block($server->config['blocks']['plugin']);
$output = theme('gameservers_block', $server, $response, $style);
}
else {
$output = theme('gameservers_page_details', $server, $response);
}
return $output;
}
/**
* Query a game server and return the response.
*/
function gameservers_server_query($server) {
static $responses = array();
if (!isset($responses[$server->id])) {
$query = gameservers_get_query_instance($server->config['query']['plugin']);
module_invoke_all('gameservers_pre_query', $server);
$response = $query->getResponse($server);
module_invoke_all('gameservers_reponse_query', $server, $response);
$responses[$server->id] = $response;
}
return isset($responses[$server->id]) ? (object) $responses[$server->id] : FALSE;
}
/**
*
*/
function gameservers_server_query_multiple($servers) {
// @todo
}
// ------------------------------------------------------------------
// Helper functions
// ------------------------------------------------------------------
/**
* Load a gameservers include file.
*
* @see module_load_include()
*/
function gameservers_include($include, $path = 'includes/') {
static $loaded = array();
if (empty($loaded["$path$include.inc"])) {
require_once './' . gameservers_get_path("$path$include.inc");
$loaded["$path$include.inc"] = TRUE;
}
}
/**
* Returns the path to a gameservers module file.
*
* @see drupal_get_path()
*/
function gameservers_get_path($file, $base_path = FALSE, $module = 'gameservers') {
$output = $base_path ? base_path() : '';
return $output . drupal_get_path('module', $module) . '/' . $file;
}
/**
* Returns the path to library.
*
* @see libraries_get_path().
*/
function gameservers_get_path_library($library) {
// Try first whether libraries module is present and load the file from
// there. If this fails, require the library from the local path.
if (module_exists('libraries') && file_exists(libraries_get_path($library))) {
return libraries_get_path($library);
}
elseif (file_exists(gameservers_get_path("libraries/$library"))) {
return gameservers_get_path("libraries/$library");
}
else {
return gameservers_get_path('libraries');
}
}
/**
* Includes a library file.
*
* @param $file
* The filename to load from.
* @param $library
* The name of the library. If libraries module is installed,
* gameservers_include_library() will look for libraries with this name
* managed by libraries module.
*/
function gameservers_include_library($file, $library) {
static $included = array();
if (!isset($included[$library][$file])) {
require gameservers_get_path_library($library) ."/$file";
}
$included[$library][$file] = TRUE;
}
/**
* Generates a 500 internal server error.
*/
function gameservers_fatal_error($error_msg = NULL) {
drupal_set_header('HTTP/1.1 500 Internal Server Error');
drupal_set_title(t('Fatal error'));
if ($error_msg) {
drupal_set_message($error_msg, 'error');
}
print theme('page', t('The website encountered an unexpected error. Please try again later.'));
}
function theme_gameservers_block($server, $response, $style = NULL) {
if (isset($style['css'])) {
drupal_add_css($style['path'] . '/'. $style['css'], 'module');
}
$theme = isset($style['theme']) ? $style['theme'] : 'gameservers_default';
return theme($theme, $server, $response);
}