Crossfire Server, Trunk
server.c File Reference
#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 "server.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)
 
static bool check_shutdown (void)
 
static char * clean_path (const char *file, char *newpath, int size)
 
void clean_tmp_files (void)
 
void cleanup (void)
 
static char const * crypt_string (char const str[static 1], char const *salt)
 
static void do_follow (player *pl)
 
static void do_shutdown (void)
 
static void do_specials (void)
 
void enter_exit (object *op, object *exit_ob)
 
static void enter_fixed_template_map (object *pl, object *exit_ob)
 
static void enter_map (object *op, mapstruct *newmap, int x, int y)
 
void enter_player_maplevel (object *op)
 
void enter_player_savebed (object *op)
 
static void enter_random_map (object *pl, object *exit_ob)
 
static void enter_random_template_map (object *pl, object *exit_ob)
 
static void enter_unique_map (object *op, object *exit_ob)
 
int forbid_play (void)
 
void leave (player *pl, int draw_exit)
 
void login_check_shutdown (object *const op)
 
static int move_towards (object *ob, object *towards, unsigned int mindist)
 
char const * newhash (char const password[static 1])
 
static bool object_in_icecube (object *op)
 
static bool object_on_exit (object *ob, object *exit)
 
void player_map_change_common (object *op, mapstruct *const oldmap, mapstruct *const newmap)
 
void process_events (void)
 
static void process_players1 (void)
 
static void process_players2 (void)
 
void server_main (int argc, char *argv[])
 
void set_map_timeout (mapstruct *oldmap)
 
static char * unclean_path (const char *src, char *newpath, int size)
 

Variables

static const char * days [] = {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}
 
volatile sig_atomic_t shutdown_flag
 
static const int shutdown_warn_times [] = {120, 90, 60, 45, 30, 15, 10, 5, 4, 3, 2, 1}
 
unsigned long todtick
 

Detailed Description

Main server functions.

Definition in file server.c.

Macro Definition Documentation

◆ PORTAL_DESTINATION_NAME

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

◆ SPEED_DEBUG

#define SPEED_DEBUG

Definition at line 1047 of file server.c.

Function Documentation

◆ check_password()

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 114 of file server.c.

References crypt_string(), llevError, and LOG().

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:

◆ check_shutdown()

static bool check_shutdown ( void  )
static

Check if we're ready to shut the server down.

Definition at line 1392 of file server.c.

References cmd_shutdown_time, draw_ext_info_format(), llevInfo, LOG(), MSG_TYPE_ADMIN, MSG_TYPE_ADMIN_DM, NDI_ALL, NDI_UNIQUE, shutdown_flag, and shutdown_warn_times.

Referenced by do_specials().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ clean_path()

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 325 of file server.c.

References mad_mage_user::file, and strlcpy().

Referenced by enter_unique_map().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ clean_tmp_files()

void clean_tmp_files ( void  )

Save unique maps and clean up temporary map files unless recycling temporary maps. The function name is somewhat misleading.

Definition at line 1204 of file server.c.

References clean_tmp_map(), first_map, m, MAP_IN_MEMORY, give::next, Settings::recycle_tmp_maps, save_map(), SAVE_MODE_NORMAL, settings, swap_map(), and write_todclock().

Referenced by cleanup().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cleanup()

◆ crypt_string()

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 70 of file server.c.

References c, Settings::crypt_mode, make_face_from_files::int, RANDOM, settings, and make_face_from_files::str.

Referenced by check_password(), and newhash().

+ Here is the caller graph for this function:

◆ do_follow()

static void do_follow ( player pl)
static

Called from process_players1() to move a player who is following someone.

This is a DM, just teleport on the top of player.

Definition at line 888 of file server.c.

References can_follow(), rv_vector::distance, draw_ext_info_format(), enter_exit(), find_player_partial_name(), FLAG_WIZ, pl::followed_player, FREE_AND_CLEAR_STR, freearr_x, freearr_y, get_rangevector(), map_newmap_cmd(), move_towards(), MSG_TYPE_COMMAND, MSG_TYPE_COMMAND_FAILURE, NDI_UNIQUE, pl::ob, object_find_free_spot(), object_insert_in_map_at(), object_on_exit(), object_remove(), player_update_bg_music(), and pl::socket.

Referenced by process_players1().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ do_shutdown()

static void do_shutdown ( void  )
static

Definition at line 1381 of file server.c.

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

Referenced by do_specials().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ do_specials()

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 1456 of file server.c.

References accounts_save(), check_shutdown(), clean_friendly_list(), CS_LOGTIME, cst_lst, do_shutdown(), fix_luck(), fix_weight(), flush_old_maps(), knowledge_process_incremental(), metaserver_update(), party_obsolete_parties(), pticks, PTICKS_PER_CLOCK, tick_the_clock(), CS_Stats::time_start, watchdog(), write_book_archive(), and write_cs_stats().

Referenced by server_main().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ enter_exit()

void enter_exit ( object *  op,
object *  exit_ob 
)

◆ enter_fixed_template_map()

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 446 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, llevError, LOG(), MAP_PLAYER_UNIQUE, mapfile_load(), MAX_BUF, MSG_TYPE_COMMAND, MSG_TYPE_COMMAND_FAILURE, NDI_UNIQUE, python_event::path, mapdef::path, path_combine_and_normalize(), ready_map_name(), replace(), and strlcpy().

Referenced by enter_exit().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ enter_map()

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

Moves the player and pets from current map (if any) to new map.

Parameters
opplayer to move.
newmap
x
ynew location. If (x, y) point to an out of map point, will use default map coordinates.

Definition at line 179 of file server.c.

References draw_ext_info(), find_dir_2(), FLAG_REMOVED, freearr_x, freearr_y, llevError, llevInfo, LOG(), MAP_ENTER_X, MAP_ENTER_Y, MAP_HEIGHT, map_newmap_cmd(), MAP_WIDTH, MSG_TYPE_COMMAND, MSG_TYPE_COMMAND_FAILURE, NDI_UNIQUE, ob_blocked(), object_find_free_spot(), object_free_drop_inventory(), object_insert_in_map_at(), object_remove(), object_set_enemy(), give::op, out_of_map(), mapdef::path, pets_remove_all(), player_map_change_common(), QUERY_FLAG, range_golem, remove_friendly_object(), safe_strncpy, SIZEOFFREE, SIZEOFFREE1, SIZEOFFREE2, diamondslots::x, and diamondslots::y.

Referenced by enter_exit(), enter_fixed_template_map(), enter_player_maplevel(), enter_random_map(), enter_random_template_map(), and enter_unique_map().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ enter_player_maplevel()

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 676 of file server.c.

References draw_ext_info_format(), Settings::emergency_mapname, Settings::emergency_x, Settings::emergency_y, enter_map(), flags, llevError, LOG(), MAP_ENTER_X, MAP_ENTER_Y, MSG_TYPE_MISC, NDI_UNIQUE, give::op, ready_map_name(), settings, diamondslots::x, and diamondslots::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:

◆ enter_player_savebed()

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 138 of file server.c.

References add_string(), Settings::emergency_mapname, Settings::emergency_x, Settings::emergency_y, enter_exit(), EXIT_PATH, EXIT_X, EXIT_Y, free_string(), llevDebug, LOG(), MAX_BUF, object_free(), object_new(), give::op, mapdef::path, safe_strncpy, settings, and Ice::tmp.

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:

◆ enter_random_map()

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 379 of file server.c.

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

Referenced by enter_exit().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ enter_random_template_map()

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 537 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, MAP_ENTER_X, MAP_ENTER_Y, MAP_PLAYER_UNIQUE, MAX_BUF, RMParms::origin_map, RMParms::origin_x, RMParms::origin_y, path_combine_and_normalize(), ready_map_name(), RMParms::region, replace(), safe_strncpy, set_random_map_variable(), strlcpy(), diamondslots::x, RMParms::Xsize, diamondslots::y, and RMParms::Ysize.

Referenced by enter_exit().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ enter_unique_map()

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 605 of file server.c.

References apply_auto_fix(), clean_path(), draw_ext_info_format(), enter_map(), EXIT_PATH, EXIT_X, EXIT_Y, HUGE_BUF, llevDebug, LOG(), MAP_PLAYER_UNIQUE, mapfile_load(), MAX_BUF, MSG_TYPE_COMMAND, MSG_TYPE_COMMAND_FAILURE, NDI_UNIQUE, give::op, python_event::path, mapdef::path, path_combine_and_normalize(), ready_map_name(), strlcpy(), unclean_path(), and mapdef::unique.

Referenced by enter_exit().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ forbid_play()

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 1336 of file server.c.

References buf, Settings::confdir, days, llevDebug, LOG(), logfile, MAX_BUF, PERM_FILE, settings, and roll-o-matic::stop().

Referenced by init_startup().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ leave()

void leave ( player pl,
int  draw_exit 
)

Player logs out, or was disconnected.

Parameters
plplayer.
draw_exitif set, display leaving message to other players.

Definition at line 1275 of file server.c.

References draw_ext_info_format(), FLAG_REMOVED, FLAG_WIZ, hiscore_check(), socket_struct::host, llevInfo, LOG(), MAP_IN_MEMORY, MAP_TIMEOUT, MAX_BUF, MSG_TYPE_ADMIN, MSG_TYPE_ADMIN_PLAYER, give::name, NDI_ALL, NDI_DK_ORANGE, NDI_UNIQUE, Ns_Dead, pl::ob, object_remove(), party_leave(), pets_terminate_all(), QUERY_FLAG, query_name(), pl::socket, ST_CONFIRM_PASSWORD, ST_GET_NAME, ST_GET_PASSWORD, pl::state, socket_struct::status, and pl::transport.

Referenced by check_login(), do_server(), receive_play_again(), and shop_mat_type_move_on().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ login_check_shutdown()

void login_check_shutdown ( object *const  op)

Warn op if a server shutdown is scheduled. Used to inform players about scheduled shutdowns when they log in.

Definition at line 1427 of file server.c.

References cmd_shutdown_time, draw_ext_info_format(), MSG_TYPE_ADMIN, MSG_TYPE_ADMIN_DM, NDI_ALL, NDI_UNIQUE, give::op, and shutdown_warn_times.

Referenced by check_login().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ move_towards()

static int move_towards ( object *  ob,
object *  towards,
unsigned int  mindist 
)
static

Move 'ob' in the direction of 'towards' (without any pathfinding) if the two objects are farther than 'mindist' apart. Used to implement do_follow().

Returns
Direction to move in, or zero if cannot move.

Definition at line 864 of file server.c.

References rv_vector::direction, rv_vector::distance, get_rangevector(), move_player(), and guildjoin::ob.

Referenced by do_follow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ newhash()

char const* newhash ( char const  password[static 1])

Definition at line 101 of file server.c.

References crypt_string().

+ Here is the call graph for this function:

◆ object_in_icecube()

static bool object_in_icecube ( object *  op)
static

Definition at line 1049 of file server.c.

References give::op.

Referenced by process_events().

+ Here is the caller graph for this function:

◆ object_on_exit()

static bool object_on_exit ( object *  ob,
object *  exit 
)
static

Return true if the player object is on the given exit. This is required because some multi-tile exits are unpassable from a certain direction.

Definition at line 877 of file server.c.

References guildjoin::ob, object_get_multi_size(), diamondslots::x, and diamondslots::y.

Referenced by do_follow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ player_map_change_common()

void player_map_change_common ( object *  op,
mapstruct *const  oldmap,
mapstruct *const  newmap 
)

Definition at line 270 of file server.c.

References EVENT_MAPENTER, EVENT_MAPLEAVE, events_execute_global_event(), give::op, player_update_bg_music(), mapdef::players, set_map_timeout(), and mapdef::timeout.

Referenced by enter_map(), and move_player_attack().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ process_events()

void process_events ( void  )

◆ process_players1()

static void process_players1 ( void  )
static

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

See also
process_players2().

Definition at line 934 of file server.c.

References AUTOSAVE, Settings::casting_time, do_follow(), do_some_living(), first_player, FLAG_REMOVED, pl::followed_player, get_map_flags(), handle_newcs_player(), hiscore_check(), pl::next, pl::ob, P_NO_CLERIC, altar_valkyrie::pl, pticks, QUERY_FLAG, save_player(), settings, pl::socket, socket_struct::sounds_this_tick, ST_PLAYING, pl::state, pl::ticks_played, and TRUE.

Referenced by process_events().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ process_players2()

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 1026 of file server.c.

References first_player, pl::has_hit, pl::next, pl::ob, and altar_valkyrie::pl.

Referenced by process_events().

+ Here is the caller graph for this function:

◆ server_main()

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

Server main function.

Parameters
argclength of argv.
argvcommand-line options.

Definition at line 1510 of file server.c.

References bRunning, cftimer_process_timers(), check_active_maps(), do_server(), do_specials(), EVENT_CLOCK, events_execute_global_event(), init(), initPlugins(), llevInfo, LOG(), nroferrors, process_events(), tick_game_time(), TRUE, and update_players().

Referenced by main().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ set_map_timeout()

void set_map_timeout ( mapstruct oldmap)

Applies the map timeout.

Parameters
oldmapmap to process.

Definition at line 292 of file server.c.

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ unclean_path()

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 353 of file server.c.

References strlcpy().

Referenced by enter_unique_map().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ days

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

Ingame days.

Definition at line 51 of file server.c.

Referenced by forbid_play().

◆ shutdown_flag

volatile sig_atomic_t shutdown_flag

Definition at line 53 of file server.c.

Referenced by check_shutdown(), and signal_shutdown().

◆ shutdown_warn_times

const int shutdown_warn_times[] = {120, 90, 60, 45, 30, 15, 10, 5, 4, 3, 2, 1}
static

How many minutes before a shutdown to warn players, in reverse order.

Definition at line 48 of file server.c.

Referenced by check_shutdown(), and login_check_shutdown().

◆ todtick

unsigned long todtick

Ingame time

Definition at line 397 of file init.c.