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 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
|
/*
* Crossfire -- cooperative multi-player graphical RPG and adventure game
*
* Copyright (c) 1999-2014 Mark Wedel and the Crossfire Development Team
* Copyright (c) 1992 Frank Tore Johansen
*
* Crossfire is free software and comes with ABSOLUTELY NO WARRANTY. You are
* welcome to redistribute it under certain conditions. For details, please
* see COPYING and LICENSE.
*
* The authors can be reached via e-mail at <crossfire@metalforge.org>.
*/
/**
* \file
* Meta-server related functions.
* \date 2003-12-02
*/
#include "global.h"
#include <ctype.h>
#include <pthread.h>
#include <stdlib.h>
#include <string.h>
#ifndef WIN32 /* ---win32 exclude unix header files */
#include <sys/types.h>
#include <netinet/in.h>
#include <netdb.h>
#include <arpa/inet.h>
#endif /* end win32 */
#include "metaserver2.h"
#include "version.h"
#ifdef HAVE_LIBCURL
#include <curl/curl.h>
#include <curl/easy.h>
#endif
/**
* Updates our info in the metaserver
* Note that this is used for both metaserver1 and metaserver2 -
* for metaserver2, it just copies dynamic data into private
* data structure, doing locking in the process.
*/
void metaserver_update(void) {
char num_players = 0;
player *pl;
#ifdef HAVE_LIBCURL
/* We could use socket_info.nconns, but that is not quite as accurate,
* as connections in the progress of being established, are listening
* but don't have a player, etc. The checks below are basically the
* same as for the who commands with the addition that WIZ, AFK, and BOT
* players are not counted.
*/
for (pl = first_player; pl != NULL; pl = pl->next) {
if (pl->ob->map == NULL)
continue;
if (pl->hidden)
continue;
if (QUERY_FLAG(pl->ob, FLAG_WIZ))
continue;
if (QUERY_FLAG(pl->ob, FLAG_AFK))
continue;
if (pl->state != ST_PLAYING && pl->state != ST_GET_PARTY_PASSWORD)
continue;
if (pl->socket.is_bot)
continue;
num_players++;
}
/* Everything inside the pthread lock/unlock is related
* to metaserver2 synchronization.
*/
pthread_mutex_lock(&ms2_info_mutex);
metaserver2_updateinfo.num_players = num_players;
metaserver2_updateinfo.in_bytes = cst_tot.ibytes;
metaserver2_updateinfo.out_bytes = cst_tot.obytes;
metaserver2_updateinfo.uptime = (long)time(NULL)-cst_tot.time_start;
pthread_mutex_unlock(&ms2_info_mutex);
#endif
}
/*
* Start of metaserver2 logic
* Note: All static structures in this file should be treated as strictly
* private. The metaserver2 update logic runs in its own thread,
* so if something needs to modify these structures, proper locking
* is needed.
*/
/**
* This is a linked list of all the metaservers -
* never really know how many we have.
*/
typedef struct _MetaServer2 {
char *hostname; /**< Hostname to contact. */
struct _MetaServer2 *next; /**< Next element in the list. */
} MetaServer2;
/** Metaservers to send information to. */
static MetaServer2 *metaserver2;
/**
* LocalMeta2Info basically holds all the non server metaserver2 information
* that we read from the metaserver2 file. Could just have
* individual variables, but doing it as a structure is cleaner
* I think, and might be more flexible if in the future, we
* want to pass this information to other functions (like plugin
* or something)
*/
typedef struct _LocalMeta2Info {
int notification; /**< If true, do updates to metaservers. */
char *hostname; /**< Hostname of this server. */
int portnumber; /**< Portnumber of this server. */
char *html_comment; /**< html comment to send to metaservers. */
char *text_comment; /**< text comment to send to metaservers. */
char *archbase; /**< Different sources for arches, maps */
char *mapbase; /**< and server. */
char *codebase;
char *flags; /**< Short flags to send to metaserver. */
} LocalMeta2Info;
/** Non volatile information on the server. */
static LocalMeta2Info local_info;
/** Mutex to protect access to ::metaserver2_updateinfo. */
pthread_mutex_t ms2_info_mutex;
/** Statistics on players and such sent to the metaserver2. */
MetaServer2_UpdateInfo metaserver2_updateinfo;
/**
* This frees any data associated with the MetaServer2 info,
* including the pointer itself. Caller is responsible for updating
* pointers (ms->next) - really only used when wanting to free
* all data.
* @param ms data to free, pointer becomes invalid.
*/
static void free_metaserver2(MetaServer2 *ms) {
free(ms->hostname);
free(ms);
}
/**
* This initializes the metaserver2 logic - it reads
* the metaserver2 file, storing the values
* away. Note that it may be possible/desirable for the
* server to re-read the values and restart connections (for example,
* a new metaserver has been added and you want to start updates to
* it immediately and not restart the server). Because of that,
* there is some extra logic (has_init) to try to take that
* into account.
*
* @return
* 1 if we will be updating the metaserver, 0 if no
* metaserver updates
*/
int metaserver2_init(void) {
static int has_init = 0;
FILE *fp;
char buf[MAX_BUF], *cp, dummy[1];
MetaServer2 *ms2, *msnext;
pthread_t thread_id;
dummy[0] = '\0';
#ifdef HAVE_LIBCURL
if (!has_init) {
memset(&local_info, 0, sizeof(LocalMeta2Info));
memset(&metaserver2_updateinfo, 0, sizeof(MetaServer2_UpdateInfo));
local_info.portnumber = settings.csport;
metaserver2 = NULL;
pthread_mutex_init(&ms2_info_mutex, NULL);
curl_global_init(CURL_GLOBAL_ALL);
} else {
local_info.notification = 0;
if (local_info.hostname)
FREE_AND_CLEAR(local_info.hostname);
if (local_info.html_comment)
FREE_AND_CLEAR(local_info.html_comment);
if (local_info.text_comment)
FREE_AND_CLEAR(local_info.text_comment);
if (local_info.archbase)
FREE_AND_CLEAR(local_info.archbase);
if (local_info.mapbase)
FREE_AND_CLEAR(local_info.mapbase);
if (local_info.codebase)
FREE_AND_CLEAR(local_info.codebase);
if (local_info.flags)
FREE_AND_CLEAR(local_info.flags);
for (ms2 = metaserver2; ms2; ms2 = msnext) {
msnext = ms2->next;
free_metaserver2(ms2);
}
metaserver2 = NULL;
}
#endif
/* Now load up the values from the file */
snprintf(buf, sizeof(buf), "%s/metaserver2", settings.confdir);
if ((fp = fopen(buf, "r")) == NULL) {
LOG(llevError, "Warning: No metaserver2 file found\n");
return 0;
}
while (fgets(buf, sizeof(buf), fp) != NULL) {
if (buf[0] == '#')
continue;
/* eliminate newline */
if ((cp = strrchr(buf, '\n')) != NULL)
*cp = '\0';
/* Skip over empty lines */
if (buf[0] == 0)
continue;
/* Find variable pairs */
if ((cp = strpbrk(buf, " \t")) != NULL) {
while (isspace(*cp))
*cp++ = 0;
} else {
/* This makes it so we don't have to do NULL checks against
* cp everyplace
*/
cp = dummy;
}
if (!strcasecmp(buf, "metaserver2_notification")) {
if (!strcasecmp(cp, "on") || !strcasecmp(cp, "true")) {
local_info.notification = TRUE;
} else if (!strcasecmp(cp, "off") || !strcasecmp(cp, "false")) {
local_info.notification = FALSE;
} else {
LOG(llevError, "metaserver2: Unknown value for metaserver2_notification: %s\n", cp);
}
} else if (!strcasecmp(buf, "metaserver2_server")) {
if (*cp != 0) {
ms2 = calloc(1, sizeof(MetaServer2));
ms2->hostname = strdup(cp);
ms2->next = metaserver2;
metaserver2 = ms2;
} else {
LOG(llevError, "metaserver2: metaserver2_server must have a value.\n");
}
} else if (!strcasecmp(buf, "localhostname")) {
if (*cp != 0) {
local_info.hostname = strdup_local(cp);
} else {
LOG(llevError, "metaserver2: localhostname must have a value.\n");
}
} else if (!strcasecmp(buf, "portnumber")) {
if (*cp != 0) {
local_info.portnumber = atoi(cp);
} else {
LOG(llevError, "metaserver2: portnumber must have a value.\n");
}
/* For the following values, it is easier to make sure
* the pointers are set to something, even if it is a blank
* string, so don't care if there is data in the string or not.
*/
} else if (!strcasecmp(buf, "html_comment")) {
local_info.html_comment = strdup(cp);
} else if (!strcasecmp(buf, "text_comment")) {
local_info.text_comment = strdup(cp);
} else if (!strcasecmp(buf, "archbase")) {
local_info.archbase = strdup(cp);
} else if (!strcasecmp(buf, "mapbase")) {
local_info.mapbase = strdup(cp);
} else if (!strcasecmp(buf, "codebase")) {
local_info.codebase = strdup(cp);
} else if (!strcasecmp(buf, "flags")) {
local_info.flags = strdup(cp);
} else {
LOG(llevError, "Unknown value in metaserver2 file: %s\n", buf);
}
}
fclose(fp);
/* If no hostname is set, can't do updates */
if (!local_info.hostname)
local_info.notification = 0;
#ifndef HAVE_LIBCURL
if (local_info.notification) {
LOG(llevError, "metaserver2 file is set to do notification, but libcurl is not found.\n");
LOG(llevError, "Either fix your compilation, or turn off metaserver2 notification in \n");
LOG(llevError, "the %s/metaserver2 file.\n", settings.confdir);
LOG(llevError, "Exiting program.\n");
exit(1);
}
#endif
if (local_info.notification) {
int ret;
/* As noted above, it is much easier for the rest of the code
* to not have to check for null pointers. So we do that
* here, and anything that is null, we just allocate
* an empty string.
*/
if (!local_info.html_comment)
local_info.html_comment = strdup("");
if (!local_info.text_comment)
local_info.text_comment = strdup("");
if (!local_info.archbase)
local_info.archbase = strdup("");
if (!local_info.mapbase)
local_info.mapbase = strdup("");
if (!local_info.codebase)
local_info.codebase = strdup("");
if (!local_info.flags)
local_info.flags = strdup("");
ret = pthread_create(&thread_id, NULL, metaserver2_thread, NULL);
if (ret) {
LOG(llevError, "metaserver2_init: return code from pthread_create() is %d\n", ret);
/* Effectively true - we're not going to update the metaserver */
local_info.notification = 0;
}
}
return local_info.notification;
}
/**
* Handles writing of HTTP request data from the metaserver2.
* We treat the data as a string. We should really pay attention to the
* header data, and do something clever if we get 404 codes
* or the like.
* @param ptr actual data.
* @param size size of the data.
* @param nmemb number of elements.
* @param data user-provided data, unused.
* @return number of bytes processed, always the full size.
*/
static size_t metaserver2_writer(void *ptr, size_t size, size_t nmemb, void *data) {
size_t realsize = size*nmemb;
LOG(llevError, "Message from metaserver:\n%s\n", (const char*)ptr);
return realsize;
}
#ifdef HAVE_LIBCURL
static void metaserver2_build_form(struct curl_httppost **formpost) {
struct curl_httppost *lastptr = NULL;
char buf[MAX_BUF];
/* First, fill in the form - note that everything has to be a string,
* so we convert as needed with snprintf.
* The order of fields here really isn't important.
* The string after CURLFORM_COPYNAME is the name of the POST variable
* as the
*/
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "hostname",
CURLFORM_COPYCONTENTS, local_info.hostname,
CURLFORM_END);
snprintf(buf, sizeof(buf), "%d", local_info.portnumber);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "port",
CURLFORM_COPYCONTENTS, buf,
CURLFORM_END);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "html_comment",
CURLFORM_COPYCONTENTS, local_info.html_comment,
CURLFORM_END);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "text_comment",
CURLFORM_COPYCONTENTS, local_info.text_comment,
CURLFORM_END);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "archbase",
CURLFORM_COPYCONTENTS, local_info.archbase,
CURLFORM_END);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "mapbase",
CURLFORM_COPYCONTENTS, local_info.mapbase,
CURLFORM_END);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "codebase",
CURLFORM_COPYCONTENTS, local_info.codebase,
CURLFORM_END);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "flags",
CURLFORM_COPYCONTENTS, local_info.flags,
CURLFORM_END);
pthread_mutex_lock(&ms2_info_mutex);
snprintf(buf, sizeof(buf), "%d", metaserver2_updateinfo.num_players);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "num_players",
CURLFORM_COPYCONTENTS, buf,
CURLFORM_END);
snprintf(buf, sizeof(buf), "%d", metaserver2_updateinfo.in_bytes);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "in_bytes",
CURLFORM_COPYCONTENTS, buf,
CURLFORM_END);
snprintf(buf, sizeof(buf), "%d", metaserver2_updateinfo.out_bytes);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "out_bytes",
CURLFORM_COPYCONTENTS, buf,
CURLFORM_END);
snprintf(buf, sizeof(buf), "%ld", (long)metaserver2_updateinfo.uptime);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "uptime",
CURLFORM_COPYCONTENTS, buf,
CURLFORM_END);
pthread_mutex_unlock(&ms2_info_mutex);
/* Following few fields are global variables,
* but are really defines, so won't ever change.
*/
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "version",
CURLFORM_COPYCONTENTS, FULL_VERSION,
CURLFORM_END);
snprintf(buf, sizeof(buf), "%d", VERSION_SC);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "sc_version",
CURLFORM_COPYCONTENTS, buf,
CURLFORM_END);
snprintf(buf, sizeof(buf), "%d", VERSION_CS);
curl_formadd(formpost, &lastptr,
CURLFORM_COPYNAME, "cs_version",
CURLFORM_COPYCONTENTS, buf,
CURLFORM_END);
}
#endif
/**
* This sends an update to the various metaservers.
* It generates the form, and then sends it to the
* server
*/
static void metaserver2_updates(void) {
#ifdef HAVE_LIBCURL
struct curl_httppost *formpost = NULL;
metaserver2_build_form(&formpost);
for (MetaServer2 *ms2 = metaserver2; ms2; ms2 = ms2->next) {
CURL *curl = curl_easy_init();
if (curl) {
/* what URL that receives this POST */
curl_easy_setopt(curl, CURLOPT_URL, ms2->hostname);
curl_easy_setopt(curl, CURLOPT_HTTPPOST, formpost);
/* Almost always, we will get HTTP data returned
* to us - instead of it going to stderr,
* we want to take care of it ourselves.
*/
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, metaserver2_writer);
char errbuf[CURL_ERROR_SIZE];
curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, errbuf);
CURLcode res = curl_easy_perform(curl);
if (res) {
LOG(llevError, "metaserver update failed: %s\n", errbuf);
}
/* always cleanup */
curl_easy_cleanup(curl);
} else {
LOG(llevError, "metaserver: could not initialize curl\n");
}
}
/* then cleanup the formpost chain */
curl_formfree(formpost);
#endif
}
/**
* metserver2_thread is the function called from pthread_create.
* it is a trivial function - it just sleeps and calls
* the update function. The sleep time here is really
* quite arbitrary, but once a minute is probably often
* enough. A better approach might be to
* do a time() call and see how long the update takes,
* and sleep according to that.
*
* @param junk unused.
* @return
* This function should never return/exit.
*/
void *metaserver2_thread(void *junk) {
while (1) {
metaserver2_updates();
sleep(60);
}
return NULL;
}
|