Crossfire Server, Trunk  R21226
swap.c
Go to the documentation of this file.
1 /*
2  * Crossfire -- cooperative multi-player graphical RPG and adventure game
3  *
4  * Copyright (c) 1999-2014 Mark Wedel and the Crossfire Development Team
5  * Copyright (c) 1992 Frank Tore Johansen
6  *
7  * Crossfire is free software and comes with ABSOLUTELY NO WARRANTY. You are
8  * welcome to redistribute it under certain conditions. For details, please
9  * see COPYING and LICENSE.
10  *
11  * The authors can be reached via e-mail at <crossfire@metalforge.org>.
12  */
13 
19 #include "global.h"
20 
21 #include <string.h>
22 
23 #include "object.h"
24 #include "output_file.h"
25 #include "sproto.h"
26 
33 static void write_map_log(void) {
34  FILE *fp;
35  OutputFile of;
36  mapstruct *map;
37  char buf[MAX_BUF];
38  long current_time = time(NULL);
39 
40  snprintf(buf, sizeof(buf), "%s/temp.maps", settings.localdir);
41  fp = of_open(&of, buf);
42  if (fp == NULL)
43  return;
44  for (map = first_map; map != NULL; map = map->next) {
45  /* If tmpname is null, it is probably a unique player map,
46  * so don't save information on it.
47  */
48  if (map->in_memory != MAP_IN_MEMORY
49  && (map->tmpname != NULL)
50  && (strncmp(map->path, "/random", 7))) {
51  /* the 0 written out is a leftover from the lock number for
52  * unique items and second one is from encounter maps.
53  * Keep using it so that old temp files continue
54  * to work.
55  */
56  fprintf(fp, "%s:%s:%ld:0:0:%d:0:%d\n", map->path, map->tmpname,
57  (map->reset_time == (uint32_t)-1 ? -1 : map->reset_time-current_time),
58  map->difficulty,
59  map->darkness);
60  }
61  }
62  of_close(&of);
63 }
64 
70 void read_map_log(void) {
71  FILE *fp;
72  mapstruct *map;
73  char buf[MAX_BUF];
74  int do_los, darkness, lock;
75  long sec = seconds();
76 
77  snprintf(buf, sizeof(buf), "%s/temp.maps", settings.localdir);
78  if (!(fp = fopen(buf, "r"))) {
79  LOG(llevDebug, "Could not open %s for reading\n", buf);
80  return;
81  }
82  while (fgets(buf, MAX_BUF, fp) != NULL) {
83  char *tmp[3];
84 
85  map = get_linked_map();
86  /* scanf doesn't work all that great on strings, so we break
87  * out that manually. strdup is used for tmpname, since other
88  * routines will try to free that pointer.
89  */
90  if (split_string(buf, tmp, sizeof(tmp)/sizeof(*tmp), ':') != 3) {
91  LOG(llevDebug, "%s/temp.maps: ignoring invalid line: %s\n", settings.localdir, buf);
92  continue;
93  }
94 
95  safe_strncpy(map->path, tmp[0], sizeof(map->path));
96  map->tmpname = strdup_local(tmp[1]);
97 
98  /* Lock is left over from the lock items - we just toss it now.
99  * We use it twice - second one is from encounter, but as we
100  * don't care about the value, this works fine
101  */
102  sscanf(tmp[2], "%u:%d:%d:%hu:%d:%d\n", &map->reset_time, &lock, &lock, &map->difficulty, &do_los, &darkness);
103 
104  map->in_memory = MAP_SWAPPED;
105  map->darkness = darkness;
106  map->timeout = 0;
107 
108  /* When the reset time is saved out, it is adjusted so that
109  * the current time is subtracted (thus, it is saved as number
110  * of seconds from current time that it should reset). We need
111  * to add in the current seconds for this to work right.
112  * On metalforge, strange behavior was observed with really high
113  * reset times - I don't know how they got to that state,
114  * but easy enough to do some sanity checking here.
115  */
116  map->reset_time += sec;
117  if (map->reset_time > (sec+MAP_MAXRESET))
118  map->reset_time = 0;
119  }
120  fclose(fp);
121 }
122 
135 int swap_map(mapstruct *map) {
136  player *pl;
137  int res;
138 
139  if (map->in_memory != MAP_IN_MEMORY) {
140  LOG(llevError, "Tried to swap out map which was not in memory.\n");
142  }
143  for (pl = first_player; pl != NULL; pl = pl->next)
144  if (pl->ob == NULL || (!(QUERY_FLAG(pl->ob, FLAG_REMOVED)) && pl->ob->map == map))
145  break;
146 
147  if (pl != NULL) {
148  LOG(llevDebug, "Wanted to swap out map with player.\n");
149  map->timeout = 0;
150  return SAVE_ERROR_PLAYER;
151  }
152  pets_remove_all(); /* Give them a chance to follow */
153 
154  /* Update the reset time. Only do this is STAND_STILL is not set */
155  if (!map->fixed_resettime)
156  set_map_reset_time(map);
157 
158  /* If it is immediate reset time, don't bother saving it - just get
159  * rid of it right away.
160  */
161  if (map->reset_time <= seconds()) {
162  mapstruct *oldmap = map;
163 
164  LOG(llevDebug, "Resetting map %s.\n", map->path);
165  /* Lauwenmark : Here we handle the MAPRESET global event */
167  map = map->next;
168  delete_map(oldmap);
169  return SAVE_ERROR_OK;
170  }
171 
172  if ((res = save_map(map, SAVE_MODE_NORMAL)) < 0) {
173  LOG(llevError, "Failed to swap map %s.\n", map->path);
174  /* This is sufficiently critical to mandate to warn all DMs. */
176  "Failed to swap map %s!", map->path);
177  /* Map is *not *swapped. */
178  map->in_memory = MAP_IN_MEMORY;
179  return res;
180  }
181 
182  map->timeout = 0;
183  free_map(map);
184 
186  write_map_log();
187 
188  return SAVE_ERROR_OK;
189 }
190 
194 void check_active_maps(void) {
195  /* Swapping can take many tens of milliseconds. Swapping too many maps in
196  * one tick can cause enough latency for the server to skip time. */
197  int num_to_swap = 1;
198 
199  mapstruct *map, *next;
200  for (map = first_map; map != NULL; map = next) {
201  next = map->next;
202  if (map->in_memory == MAP_IN_MEMORY) {
203  // map->timeout == 0 means to never swap
204  if (map->timeout > 1) {
205  map->timeout -= 1;
206  } else if (num_to_swap > 0 && map->timeout == 1) {
207  swap_map(map);
208  num_to_swap -= 1;
209  }
210  }
211  }
212 }
213 
227 int players_on_map(mapstruct *m, int show_all) {
228  player *pl;
229  int nr = 0;
230 
231  for (pl = first_player; pl != NULL; pl = pl->next)
232  if (pl->ob != NULL
233  && !QUERY_FLAG(pl->ob, FLAG_REMOVED)
234  && pl->ob->map == m
235  && (show_all || !pl->hidden))
236  nr++;
237  return nr;
238 }
239 
245 void flush_old_maps(void) {
246  mapstruct *m, *oldmap;
247  long sec;
248  sec = seconds();
249 
250  m = first_map;
251  while (m) {
252  /* There can be cases (ie death) where a player leaves a map and the timeout
253  * is not set so it isn't swapped out.
254  */
255  if ((m->in_memory == MAP_IN_MEMORY)
256  && (m->timeout == 0)
257  && !players_on_map(m, TRUE)) {
258  set_map_timeout(m);
259  }
260 
261  /* per player unique maps are never really reset. However, we do want
262  * to perdiocially remove the entries in the list of active maps - this
263  * generates a cleaner listing if a player issues the map commands, and
264  * keeping all those swapped out per player unique maps also has some
265  * memory and cpu consumption.
266  * We do the cleanup here because there are lots of places that call
267  * swap map, and doing it within swap map may cause problems as
268  * the functions calling it may not expect the map list to change
269  * underneath them.
270  */
271  if ((m->unique || m->is_template) && m->in_memory == MAP_SWAPPED) {
272  LOG(llevDebug, "Resetting map %s.\n", m->path);
273  oldmap = m;
274  m = m->next;
275  delete_map(oldmap);
276  } else if (m->in_memory != MAP_SWAPPED
277  || m->tmpname == NULL
278  || sec < m->reset_time) {
279  m = m->next;
280  } else {
281  LOG(llevDebug, "Resetting map %s.\n", m->path);
282  /* Lauwenmark : Here we handle the MAPRESET global event */
284  clean_tmp_map(m);
285  oldmap = m;
286  m = m->next;
287  delete_map(oldmap);
288  }
289  }
290 }
void draw_ext_info_format(int flags, int pri, const object *pl, uint8_t type, uint8_t subtype, const char *format,...)
Definition: main.c:315
char path[HUGE_BUF]
Definition: map.h:365
void set_map_timeout(mapstruct *oldmap)
Definition: main.c:307
Definition: player.h:92
mapstruct * get_linked_map(void)
Definition: map.c:782
#define SAVE_ERROR_OK
Definition: map.h:143
#define strdup_local
Definition: compat.h:25
uint32_t in_memory
Definition: map.h:345
#define MAP_MAXRESET
Definition: config.h:424
uint32_t is_template
Definition: map.h:338
uint32_t reset_time
Definition: map.h:332
static void write_map_log(void)
Definition: swap.c:33
#define MSG_TYPE_ADMIN_LOADSAVE
Definition: newclient.h:477
void check_active_maps(void)
Definition: swap.c:194
#define TRUE
Definition: compat.h:10
#define SAVE_MODE_NORMAL
Definition: map.h:120
void free_map(mapstruct *m)
Definition: map.c:1706
#define safe_strncpy
Definition: compat.h:23
uint32_t hidden
Definition: player.h:132
int players_on_map(mapstruct *m, int show_all)
Definition: swap.c:227
uint8_t recycle_tmp_maps
Definition: global.h:268
#define FLAG_REMOVED
Definition: define.h:232
#define MAP_IN_MEMORY
Definition: map.h:130
#define NDI_RED
Definition: newclient.h:224
#define MAP_SWAPPED
Definition: map.h:131
uint32_t unique
Definition: map.h:337
#define NDI_ALL_DMS
Definition: newclient.h:247
struct mapdef * map
Definition: object.h:297
#define snprintf
Definition: win32.h:46
int of_close(OutputFile *of)
Definition: output_file.c:61
long seconds(void)
Definition: time.c:344
void read_map_log(void)
Definition: swap.c:70
int execute_global_event(int eventcode,...)
Definition: main.c:369
uint32_t fixed_resettime
Definition: map.h:335
void pets_remove_all(void)
Definition: pets.c:257
uint8_t darkness
Definition: map.h:346
#define QUERY_FLAG(xyz, p)
Definition: define.h:225
#define MAX_BUF
Definition: define.h:35
#define MSG_TYPE_ADMIN
Definition: newclient.h:377
#define EVENT_MAPRESET
Definition: plugin.h:92
uint16_t difficulty
Definition: map.h:343
char * tmpname
Definition: map.h:327
int save_map(mapstruct *m, int flag)
Definition: map.c:1436
object * ob
Definition: player.h:158
int32_t timeout
Definition: map.h:341
unsigned int uint32_t
Definition: win32.h:162
void set_map_reset_time(mapstruct *map)
Definition: map.c:2245
void flush_old_maps(void)
Definition: swap.c:245
const char * localdir
Definition: global.h:243
struct Settings settings
Definition: init.c:40
FILE * of_open(OutputFile *of, const char *fname)
Definition: output_file.c:30
int swap_map(mapstruct *map)
Definition: swap.c:135
void delete_map(mapstruct *m)
Definition: map.c:1753
EXTERN player * first_player
Definition: global.h:117
struct pl * next
Definition: player.h:93
size_t split_string(char *str, char *array[], size_t array_size, char sep)
Definition: utils.c:500
#define NDI_UNIQUE
Definition: newclient.h:245
void LOG(LogLevel logLevel, const char *format,...)
Definition: logger.c:51
struct mapdef * next
Definition: map.h:326
Definition: map.h:325
#define SAVE_ERROR_PLAYER
Definition: map.h:152
void clean_tmp_map(mapstruct *m)
Definition: map.c:1966
EXTERN mapstruct * first_map
Definition: global.h:118
#define SAVE_ERROR_NOT_IN_MEMORY
Definition: map.h:151