Crossfire Server, Trunk  R20513
Macros | Functions | Variables
server.c File Reference

Main server functions. More...

#include "global.h"
#include <assert.h>
#include <ctype.h>
#include <fcntl.h>
#include <math.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include "object.h"
#include "path.h"
#include "random_maps/random_map.h"
#include "random_maps/rproto.h"
#include "sproto.h"
#include "tod.h"
#include "version.h"
Include dependency graph for server.c:

Go to the source code of this file.

Macros

#define PORTAL_DESTINATION_NAME   "Town portal destination" /* this one should really be in a header file */
 
#define SPEED_DEBUG
 

Functions

bool check_password (const char *typed, const char *crypted)
 Hash a password and compare it to the stored version. More...
 
static char * clean_path (const char *file, char *newpath, int size)
 Takes a path and replaces all / with _ We do a strcpy so that we do not change the original string. More...
 
void clean_tmp_files (void)
 Remove temporary map files. More...
 
void cleanup (void)
 Clean up everything and exit. More...
 
static char const * crypt_string (char const str[static 1], char const *salt)
 Encrypt a string. More...
 
static void do_specials (void)
 Collection of functions to call from time to time. More...
 
void enter_exit (object *op, object *exit_ob)
 Tries to move 'op' to exit_ob. More...
 
static void enter_fixed_template_map (object *pl, object *exit_ob)
 The player is trying to enter a non-randomly generated template map. More...
 
static void enter_map (object *op, mapstruct *newmap, int x, int y)
 Moves the player and pets from current map (if any) to new map. More...
 
void enter_player_maplevel (object *op)
 Move a player to its stored map level. More...
 
void enter_player_savebed (object *op)
 This is a basic little function to put the player back to his savebed. More...
 
static void enter_random_map (object *pl, object *exit_ob)
 The player is trying to enter a randomly generated map. More...
 
static void enter_random_template_map (object *pl, object *exit_ob)
 The player is trying to enter a randomly generated template map. More...
 
static void enter_unique_map (object *op, object *exit_ob)
 Player is entering a unique map. More...
 
int forbid_play (void)
 Checks if server should be started. More...
 
void leave (player *pl, int draw_exit)
 Player logs out, or was disconnected. More...
 
char const * newhash (char const password[static 1])
 
void process_events (void)
 Process all active objects. More...
 
static void process_players1 (void)
 Do all player-related stuff before objects have been updated. More...
 
static void process_players2 (void)
 Do all player-related stuff after objects have been updated. More...
 
static void server_check_shutdown (void)
 Periodically check if we're ready to shut the server down. More...
 
void server_main (int argc, char *argv[])
 Server main function. More...
 
void set_map_timeout (mapstruct *oldmap)
 Applies the map timeout. More...
 
static char * unclean_path (const char *src, char *newpath, int size)
 Takes a path and replaces all _ with / This basically undoes clean_path(). More...
 

Variables

static const char * days [] = {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}
 Ingame days. More...
 
unsigned long todtick
 Ingame time. More...
 

Detailed Description

Main server functions.

Definition in file server.c.

Macro Definition Documentation

#define PORTAL_DESTINATION_NAME   "Town portal destination" /* this one should really be in a header file */

Referenced by enter_exit().

#define SPEED_DEBUG

Definition at line 962 of file server.c.

Function Documentation

bool check_password ( const char *  typed,
const char *  crypted 
)

Hash a password and compare it to the stored version.

Parameters
typedPassword entered by the user (not hashed).
cryptedStored password to check against (hashed).
Returns
True if the passwords match, false otherwise.

Definition at line 100 of file server.c.

References crypt_string().

Referenced by account_change_password(), account_login(), check_login(), receive_player_password(), and verify_player().

Here is the call graph for this function:

Here is the caller graph for this function:

static char* clean_path ( const char *  file,
char *  newpath,
int  size 
)
static

Takes a path and replaces all / with _ We do a strcpy so that we do not change the original string.

Parameters
filepath to clean.
newpathbuffer that will contain the cleaned path. Should be at least as long as file.
sizelength of newpath.
Returns
newpath.

Definition at line 304 of file server.c.

References snprintf.

Referenced by enter_unique_map().

Here is the caller graph for this function:

void clean_tmp_files ( void  )

Remove temporary map files.

Todo:
check logic, why is file only removed if map is in memory?

Definition at line 1105 of file server.c.

References clean_tmp_map(), first_map, mapdef::in_memory, llevInfo, LOG(), MAP_IN_MEMORY, quest_definition::next, mapdef::next, Settings::recycle_tmp_maps, save_map(), SAVE_MODE_NORMAL, settings, swap_map(), TRUE, and write_todclock().

Referenced by cleanup().

Here is the call graph for this function:

Here is the caller graph for this function:

void cleanup ( void  )
static char const* crypt_string ( char const  str[static 1],
char const *  salt 
)
static

Encrypt a string.

Used for password storage on disk.

Really, there is no reason to crypt the passwords any system. But easier to just leave this enabled for backward compatibility. Put the simple case at top - no encryption - makes it easier to read.

Parameters
strstring to crypt.
saltsalt to crypt with.
Returns
crypted str.
Todo:
make thread-safe?

Definition at line 64 of file server.c.

References RANDOM.

Referenced by check_password(), and newhash().

Here is the caller graph for this function:

static void do_specials ( void  )
static

Collection of functions to call from time to time.

Modified 2000-1-14 MSW to use the global pticks count to determine how often to do things. This will allow us to spred them out more often. I use prime numbers for the factor count - in that way, it is less likely these actions will fall on the same tick (compared to say using 500/2500/15000 which would mean on that 15,000 tick count a whole bunch of stuff gets done). Of course, there can still be times where multiple specials are done on the same tick, but that will happen very infrequently

I also think this code makes it easier to see how often we really are doing the various things.

Definition at line 1341 of file server.c.

References accounts_save(), clean_friendly_list(), fix_luck(), fix_weight(), flush_old_maps(), knowledge_process_incremental(), metaserver_update(), party_obsolete_parties(), pticks, PTICKS_PER_CLOCK, server_check_shutdown(), tick_the_clock(), watchdog(), and write_book_archive().

Referenced by server_main().

Here is the call graph for this function:

Here is the caller graph for this function:

void enter_exit ( object op,
object exit_ob 
)
static void enter_fixed_template_map ( object pl,
object exit_ob 
)
static

The player is trying to enter a non-randomly generated template map.

In this case, use a map file for a template.

Parameters
plplayer.
exit_obexit containing template map parameters.

Definition at line 425 of file server.c.

References create_pathname(), create_template_pathname(), draw_ext_info_format(), enter_map(), EXIT_PATH, EXIT_X, EXIT_Y, HUGE_BUF, mapdef::is_template, llevDebug, llevError, LOG(), obj::map, MAP_PLAYER_UNIQUE, mapfile_load(), MAX_BUF, MSG_TYPE_COMMAND, MSG_TYPE_COMMAND_FAILURE, obj::name, mapdef::name, NDI_UNIQUE, mapdef::path, path_combine_and_normalize(), ready_map_name(), replace(), snprintf, obj::x, and obj::y.

Referenced by enter_exit().

Here is the call graph for this function:

Here is the caller graph for this function:

static void enter_map ( object op,
mapstruct newmap,
int  x,
int  y 
)
static
void enter_player_maplevel ( object op)

Move a player to its stored map level.

This function is used to place the player just after logging in. Since the map may no longer exist, dump the player to an alternative 'emergency' location if that's the case.

Definition at line 651 of file server.c.

References obj::contr, draw_ext_info_format(), Settings::emergency_mapname, Settings::emergency_x, Settings::emergency_y, enter_map(), flags, llevError, Settings::localdir, LOG(), MAP_ENTER_X, MAP_ENTER_Y, MAP_PLAYER_UNIQUE, pl::maplevel, MSG_TYPE_MISC, NDI_UNIQUE, PLAYER, ready_map_name(), settings, obj::type, obj::x, and obj::y.

Referenced by check_login(), and set_first_map().

Here is the call graph for this function:

Here is the caller graph for this function:

void enter_player_savebed ( object op)

This is a basic little function to put the player back to his savebed.

We do some error checking - its possible that the savebed map may no longer exist, so we make sure the player goes someplace.

Parameters
opplayer.

Definition at line 118 of file server.c.

References add_string(), pl::bed_x, pl::bed_y, obj::contr, Settings::emergency_mapname, Settings::emergency_x, Settings::emergency_y, enter_exit(), EXIT_PATH, EXIT_X, EXIT_Y, FREE_OBJ_NO_DESTROY_CALLBACK, free_string(), llevDebug, LOG(), obj::map, MAX_BUF, obj::name, object_free2(), object_new(), mapdef::path, safe_strncpy, pl::savebed_map, and settings.

Referenced by kill_player_not_permadeath(), and save_life().

Here is the call graph for this function:

Here is the caller graph for this function:

static void enter_random_map ( object pl,
object exit_ob 
)
static

The player is trying to enter a randomly generated map.

In this case, generate the random map as needed.

Parameters
plplayer.
exit_obexit containing random map parameters.

Definition at line 358 of file server.c.

References add_string(), enter_map(), EXIT_PATH, EXIT_X, EXIT_Y, RMParms::final_map, generate_random_map(), get_region_by_map(), HUGE_BUF, obj::map, MAP_ENTER_X, MAP_ENTER_Y, obj::msg, RMParms::origin_map, RMParms::origin_x, RMParms::origin_y, mapdef::path, RMParms::region, safe_strncpy, set_random_map_variable(), snprintf, obj::x, RMParms::Xsize, obj::y, and RMParms::Ysize.

Referenced by enter_exit().

Here is the call graph for this function:

Here is the caller graph for this function:

static void enter_random_template_map ( object pl,
object exit_ob 
)
static

The player is trying to enter a randomly generated template map.

In this case, generate the map as needed.

Parameters
plplayer.
exit_obexit containing random template map parameters.

Definition at line 518 of file server.c.

References create_template_pathname(), enter_map(), EXIT_PATH, EXIT_X, EXIT_Y, generate_random_map(), get_region_by_map(), HUGE_BUF, mapdef::is_template, obj::map, MAP_ENTER_X, MAP_ENTER_Y, MAP_PLAYER_UNIQUE, MAX_BUF, obj::msg, mapdef::name, RMParms::origin_map, RMParms::origin_x, RMParms::origin_y, mapdef::path, path_combine_and_normalize(), ready_map_name(), RMParms::region, replace(), safe_strncpy, set_random_map_variable(), snprintf, obj::x, RMParms::Xsize, obj::y, and RMParms::Ysize.

Referenced by enter_exit().

Here is the call graph for this function:

Here is the caller graph for this function:

static void enter_unique_map ( object op,
object exit_ob 
)
static

Player is entering a unique map.

Parameters
opplayer.
exit_obexit containing unique map information.

Definition at line 586 of file server.c.

References apply_auto_fix(), clean_path(), create_pathname(), draw_ext_info_format(), enter_map(), EXIT_PATH, EXIT_X, EXIT_Y, HUGE_BUF, llevDebug, Settings::localdir, LOG(), obj::map, MAP_PLAYER_UNIQUE, mapfile_load(), MAX_BUF, MSG_TYPE_COMMAND, MSG_TYPE_COMMAND_FAILURE, obj::name, NDI_UNIQUE, mapdef::path, path_combine_and_normalize(), Settings::playerdir, ready_map_name(), settings, snprintf, unclean_path(), mapdef::unique, obj::x, and obj::y.

Referenced by enter_exit().

Here is the call graph for this function:

Here is the caller graph for this function:

int forbid_play ( void  )

Checks if server should be started.

Returns
1 if play is forbidden, 0 if ok.
Todo:
document forbidden stuff.

Definition at line 1241 of file server.c.

References Settings::confdir, days, llevDebug, LOG(), logfile, MAX_BUF, PERM_FILE, settings, and snprintf.

Referenced by init_startup().

Here is the call graph for this function:

Here is the caller graph for this function:

void leave ( player pl,
int  draw_exit 
)
char const* newhash ( char const  password[static 1])

Definition at line 87 of file server.c.

References crypt_string().

Referenced by account_change_password(), account_new(), create_player_cmd(), and receive_player_password().

Here is the call graph for this function:

Here is the caller graph for this function:

void process_events ( void  )
static void process_players1 ( void  )
static
static void process_players2 ( void  )
static

Do all player-related stuff after objects have been updated.

See also
process_players1().
Todo:
explain why 2 passes for players.

Definition at line 941 of file server.c.

References first_player, pl::has_hit, pl::next, pl::ob, obj::speed, and obj::speed_left.

Referenced by process_events().

Here is the caller graph for this function:

static void server_check_shutdown ( void  )
static

Periodically check if we're ready to shut the server down.

Definition at line 1289 of file server.c.

References cleanup(), cmd_shutdown_time, draw_ext_info(), draw_ext_info_format(), MSG_TYPE_ADMIN, MSG_TYPE_ADMIN_DM, NDI_ALL, NDI_UNIQUE, and todtick.

Referenced by do_specials().

Here is the call graph for this function:

Here is the caller graph for this function:

void server_main ( int  argc,
char *  argv[] 
)

Server main function.

Parameters
argclength of argv.
argvcommand-line options.

Definition at line 1390 of file server.c.

References bRunning, cftimer_process_timers(), check_active_maps(), do_server(), do_specials(), EVENT_CLOCK, execute_global_event(), init(), initPlugins(), nroferrors, process_events(), sleep_delta(), and TRUE.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

void set_map_timeout ( mapstruct oldmap)

Applies the map timeout.

Parameters
oldmapmap to process.

Definition at line 271 of file server.c.

References MAP_MAXTIMEOUT, MAP_MINTIMEOUT, MAP_TIMEOUT, swap_map(), and mapdef::timeout.

Referenced by enter_map(), flush_old_maps(), and place_exits().

Here is the call graph for this function:

Here is the caller graph for this function:

static char* unclean_path ( const char *  src,
char *  newpath,
int  size 
)
static

Takes a path and replaces all _ with / This basically undoes clean_path().

We do a strcpy so that we do not change the original string. We are smart enough to start after the last / in case we are getting passed a string that points to a unique map path.

Parameters
srcpath to unclean.
newpathbuffer that will contain the uncleaned path. Should be at least as long as file.
sizelength of newpath.
Returns
newpath.

Definition at line 332 of file server.c.

References snprintf.

Referenced by enter_unique_map().

Here is the caller graph for this function:

Variable Documentation

const char* days[] = {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}
static

Ingame days.

Definition at line 47 of file server.c.

Referenced by forbid_play().

unsigned long todtick

Ingame time.

Definition at line 440 of file init.c.

Referenced by server_check_shutdown().