home · contact · privacy
d8190c6038ec0f8588e688d988074af5dbc0853f
[plomrogue] / src / server / io.c
1 /* src/server/io.c */
2
3 #define _POSIX_C_SOURCE 200112L /* snrpintf() */
4 #include "io.h"
5 #include <errno.h> /* global errno */
6 #include <limits.h> /* PIPE_BUF */
7 #include <stddef.h> /* size_t, NULL */
8 #include <stdint.h> /* uint8_t, uint16_t, uint32_t, UINT8_MAX */
9 #include <stdio.h> /* defines EOF, FILE, sprintf(), fprintf() */
10 #include <stdlib.h> /* free() */
11 #include <string.h> /* strlen(), snprintf(), memcpy(), memset(), strchr() */
12 #include <sys/types.h> /* time_t */
13 #include <time.h> /* time(), nanosleep() */
14 #include "../common/readwrite.h" /* atomic_write_start(), atomic_write_finish(),
15                                   * try_fwrite(), try_fputc(), try_fgetc()
16                                   */
17 #include "../common/rexit.h" /* exit_trouble() */
18 #include "../common/try_malloc.h" /* try_malloc() */
19 #include "cleanup.h" /* set_cleanup_flag() */
20 #include "hardcoded_strings.h" /* s */
21 #include "things.h" /* Thing, ThingType, ThingInMemory, ThingAction,
22                      * get_thing_type(), get_player()
23                      */
24 #include "world.h" /* global world  */
25
26
27
28 /* Helpers to write lines of god commands to recreate thing "t". */
29 static void write_key_space(FILE * file, char * key);
30 static void write_value(FILE * file, uint32_t value);
31 static void write_string(FILE * file, char * string);
32 static void write_key_space_value(FILE * file, char * key, uint32_t value);
33 static void write_key_space_string(FILE * file, char * key, char * string);
34
35 /* Write to "file" \n-delimited line of "key" + space + "value" as string. */
36 static void write_thing(FILE * file, struct Thing * t);
37
38 /* Cut out and return first \0-terminated string from world.queue and
39  * appropriately reduce world.queue_size. Return NULL if queue is empty.
40  * Superfluous \0 bytes after the string are also cut out. Should the queue
41  * start with \0 bytes, those are cut out, but NULL is returned instead of "".
42 */
43 static char * get_message_from_queue();
44
45 /* Poll input file for world.queue input. Wait a few seconds until giving up;
46  * poll only every 0.03 seconds.. Translate '\n' chars in input file into '\0'.
47  */
48 static void read_file_into_queue();
49
50 /* Write world state as visible to clients to its file. Write single dot line to
51  * server output file to satisfy client ping mechanisms.
52  */
53 static void update_worldstate_file();
54
55 /* Write "value" to new \n-delimited line of "file". */
56 static void write_value_as_line(uint32_t value, FILE * file);
57
58 /* Write to "file" player's inventory, one item name per line. End in "%\n". */
59 static void write_inventory(struct Thing * player, FILE * file);
60
61 /* Return map cells sequence as visible to the "player", with invisible cells as
62  * whitespace. Super-impose over visible map cells things positioned there,
63  * with animate things overwriting inanimate things, and inanimate consumable
64  * things overwriting inanimate non-consumable things.
65  */
66 static char * build_visible_map(struct Thing * player);
67
68 /* Write to "file" game map as visible to "player" right now, as drawn by
69  * build_visible_map(), and thereafter game map as memorized by player in its
70  * .mem_map and .t_mem. Write one row per \n-delimited line.
71  */
72 static void write_map(struct Thing * player, FILE * file);
73
74
75
76 static void write_key_space(FILE * file, char * key)
77 {
78     try_fwrite(key, strlen(key), 1, file, __func__);
79     try_fputc(' ', file, __func__);
80 }
81
82
83
84 static void write_value(FILE * file, uint32_t value)
85 {
86     char * line = try_malloc(11, __func__);
87     exit_trouble(-1 == sprintf(line, "%u", value), __func__, s[S_FCN_SPRINTF]);
88     try_fwrite(line, strlen(line), 1, file, __func__);
89     free(line);
90 }
91
92
93
94 static void write_string(FILE * file, char * string)
95 {
96     uint8_t contains_space = NULL != strchr(string, ' ');
97     if (contains_space)
98     {
99         try_fputc('\'', file, __func__);
100     }
101     try_fwrite(string, strlen(string), 1, file, __func__);
102     if (contains_space)
103     {
104         try_fputc('\'', file, __func__);
105     }
106 }
107
108
109
110 static void write_key_space_value(FILE * file, char * key, uint32_t value)
111 {
112     write_key_space(file, key);
113     write_value(file, value);
114     try_fputc('\n', file, __func__);
115 }
116
117
118
119 static void write_key_space_string(FILE * file, char * key, char * string)
120 {
121     write_key_space(file, key);
122     write_string(file, string);
123     try_fputc('\n', file, __func__);
124 }
125
126
127
128 static void write_thing(FILE * file, struct Thing * t)
129 {
130     struct Thing * o;
131     for (o = t->owns; o; o = o->next)
132     {
133         write_thing(file, o);
134     }
135     write_key_space_value(file, s[S_CMD_T_ID], t->id);
136     write_key_space_value(file, s[S_CMD_T_TYPE], t->type);
137     write_key_space_value(file, s[S_CMD_T_POSY], t->pos.y);
138     write_key_space_value(file, s[S_CMD_T_POSX], t->pos.x);
139     write_key_space_value(file, s[S_CMD_T_COMMAND], t->command);
140     write_key_space_value(file, s[S_CMD_T_ARGUMENT], t->arg);
141     write_key_space_value(file, s[S_CMD_T_PROGRESS], t->progress);
142     write_key_space_value(file, s[S_CMD_T_HP], t->lifepoints);
143     for (o = t->owns; o; o = o->next)
144     {
145         write_key_space_value(file, s[S_CMD_T_CARRIES], o->id);
146     }
147     if (t->mem_map)
148     {
149         uint32_t map_size = world.map.length * world.map.length;/* snprintf() */
150         char * mem_map_copy = try_malloc(map_size + 1, __func__);/* reads one */
151         memcpy(mem_map_copy, t->mem_map, map_size);   /* byte beyond map_size */
152         mem_map_copy[map_size] = '\0';     /* if string is not \0-terminated. */
153         uint16_t y;
154         char string[UINT8_MAX + 1 + 1];
155         for (y = 0; y < world.map.length; y++)
156         {
157
158             int test = snprintf(string, world.map.length + 1, "%s",
159                                 mem_map_copy + (y * world.map.length));
160             exit_trouble(test < 0, __func__, "snprintf()");
161             write_key_space(file, s[S_CMD_T_MEMMAP]);
162             write_value(file, y);
163             try_fputc(' ', file, __func__);
164             write_string(file, string);
165             try_fputc('\n', file, __func__);
166         }
167         free(mem_map_copy);
168         struct ThingInMemory * tm = t->t_mem;
169         for (; tm; tm = tm->next)
170         {
171             write_key_space(file, s[S_CMD_T_MEMTHING]);
172             write_value(file, tm->type);
173             try_fputc(' ', file, __func__);
174             write_value(file, tm->pos.y);
175             try_fputc(' ', file, __func__);
176             write_value(file, tm->pos.x);
177             try_fputc('\n', file, __func__);
178         }
179     }
180     try_fputc('\n', file, __func__);
181 }
182
183
184
185 static char * get_message_from_queue()
186 {
187     char * message = NULL;
188     if (world.queue_size)
189     {
190         size_t cutout_len = strlen(world.queue);
191         if (0 < cutout_len)
192         {
193             cutout_len++;
194             message = try_malloc(cutout_len, __func__);
195             memcpy(message, world.queue, cutout_len);
196         }
197         for (;
198              cutout_len != world.queue_size && '\0' == world.queue[cutout_len];
199              cutout_len++);
200         world.queue_size = world.queue_size - cutout_len;
201         if (0 == world.queue_size)
202         {
203             free(world.queue);   /* NULL so read_file_into_queue() may free() */
204             world.queue = NULL;  /* this every time, even when it's           */
205         }                        /* un-allocated first. */
206         else
207         {
208             char * new_queue = try_malloc(world.queue_size, __func__);
209             memcpy(new_queue, &(world.queue[cutout_len]), world.queue_size);
210             free(world.queue);
211             world.queue = new_queue;
212         }
213     }
214     return message;
215 }
216
217
218
219 static void read_file_into_queue()
220 {
221     uint8_t wait_seconds = 5;
222     time_t now = time(0);
223     struct timespec dur;
224     dur.tv_sec = 0;
225     dur.tv_nsec = 33333333;
226     int test;
227     while (EOF == (test = try_fgetc(world.file_in, __func__)))
228     {
229         nanosleep(&dur, NULL);
230         if (time(0) > now + wait_seconds)
231         {
232             return;
233         }
234     }
235     do
236     {
237         char c = (char) test;
238         if ('\n' == c)
239         {
240             c = '\0';
241         }
242         char * new_queue = try_malloc(world.queue_size + 1, __func__);
243         memcpy(new_queue, world.queue, world.queue_size);
244         char * new_pos = new_queue + world.queue_size;
245         * new_pos = c;
246         world.queue_size++;
247         free(world.queue);
248         world.queue = new_queue;
249     }
250     while (EOF != (test = try_fgetc(world.file_in, __func__)));
251 }
252
253
254
255 static void update_worldstate_file()
256 {
257     char * path_tmp;
258     FILE * file = atomic_write_start(s[S_PATH_WORLDSTATE], &path_tmp);
259     struct Thing * player = get_player();
260     write_value_as_line(world.turn, file);
261     write_value_as_line(player->lifepoints, file);
262     write_inventory(player, file);
263     write_value_as_line(player->pos.y, file);
264     write_value_as_line(player->pos.x, file);
265     write_value_as_line(world.map.length, file);
266     write_map(player, file);
267     if (world.log)
268     {
269         try_fwrite(world.log, strlen(world.log), 1, file, __func__);
270     }
271     atomic_write_finish(file, s[S_PATH_WORLDSTATE], path_tmp);
272     set_cleanup_flag(CLEANUP_WORLDSTATE);
273     char * dot = ".\n";
274     try_fwrite(dot, strlen(dot), 1, world.file_out, __func__);
275     fflush(world.file_out);
276 }
277
278
279
280 static void write_value_as_line(uint32_t value, FILE * file)
281 {
282     char write_buf[12];     /* Holds 10 digits of uint32_t maximum + \n + \0. */
283     exit_trouble(sprintf(write_buf,"%u\n",value) < 0,__func__,s[S_FCN_SPRINTF]);
284     try_fwrite(write_buf, strlen(write_buf), 1, file, __func__);
285 }
286
287
288
289 static void write_inventory(struct Thing * player, FILE * file)
290 {
291     struct Thing * owned = player->owns;
292     if (!owned)
293     {
294         char * empty = "(none)\n";
295         try_fwrite(empty, strlen(empty), 1, file, __func__);
296     }
297     else
298     {
299         uint8_t q;
300         for (q = 0; owned; q++)
301         {
302             struct ThingType * tt = get_thing_type(owned->type);
303             try_fwrite(tt->name, strlen(tt->name), 1, file, __func__);
304             try_fputc('\n', file, __func__);
305             owned = owned->next;
306         }
307     }
308     try_fputc('%', file, __func__);
309     try_fputc('\n', file, __func__);
310 }
311
312
313
314 static char * build_visible_map(struct Thing * player)
315 {
316     uint32_t map_size = world.map.length * world.map.length;
317     char * visible_map = try_malloc(map_size, __func__);
318     memset(visible_map, ' ', map_size);
319     if (player->fov_map) /* May fail if player thing was created / positioned */
320     {                    /* by god command after turning off FOV building.    */
321         uint32_t pos_i;
322         for (pos_i = 0; pos_i < map_size; pos_i++)
323         {
324             if (player->fov_map[pos_i] == 'v')
325             {
326                 visible_map[pos_i] = world.map.cells[pos_i];
327             }
328         }
329         struct Thing * t;
330         char c;
331         uint8_t i;
332         for (i = 0; i < 3; i++)
333         {
334             for (t = world.things; t != 0; t = t->next)
335             {
336                 if ('v' == player->fov_map[t->pos.y*world.map.length+t->pos.x])
337                 {
338                     struct ThingType * tt = get_thing_type(t->type);
339                     if (   (0 == i && !t->lifepoints && !tt->consumable)
340                         || (1 == i && !t->lifepoints &&  tt->consumable)
341                         || (2 == i &&  t->lifepoints))
342                     {
343                         c = tt->char_on_map;
344                         visible_map[t->pos.y * world.map.length + t->pos.x] = c;
345                     }
346                 }
347             }
348         }
349     }
350     return visible_map;
351 }
352
353
354
355 static void write_map(struct Thing * player, FILE * file)
356 {
357     char * visible_map = build_visible_map(player);
358     uint16_t x, y;
359     for (y = 0; y < world.map.length; y++)
360     {
361         for (x = 0; x < world.map.length; x++)
362         {
363             try_fputc(visible_map[y * world.map.length + x], file, __func__);
364         }
365         try_fputc('\n', file, __func__);
366     }
367     free(visible_map);
368     uint32_t map_size = world.map.length * world.map.length;
369     char * mem_map = try_malloc(map_size, __func__);
370     memcpy(mem_map, player->mem_map, map_size);
371     uint8_t i;
372     struct ThingInMemory * tm;
373     for (i = 0; i < 2; i++)
374     {
375         for (tm = player->t_mem; tm; tm = tm->next)
376         {
377             if (' ' != player->mem_map[tm->pos.y*world.map.length+tm->pos.x])
378             {
379                 struct ThingType * tt = get_thing_type(tm->type);
380                 if (   (0 == i && !tt->consumable)
381                     || (1 == i &&  tt->consumable))
382                 {
383                     char c = tt->char_on_map;
384                     mem_map[tm->pos.y * world.map.length + tm->pos.x] = c;
385                 }
386             }
387         }
388     }
389     for (y = 0; y < world.map.length; y++)
390     {
391         for (x = 0; x < world.map.length; x++)
392         {
393             try_fputc(mem_map[y * world.map.length + x], file, __func__);
394         }
395         try_fputc('\n', file, __func__);
396     }
397     free(mem_map);
398 }
399
400
401
402 extern char * io_round()
403 {
404     if (0 < world.queue_size)
405     {
406         return get_message_from_queue();
407     }
408     if (world.do_update)
409     {
410         update_worldstate_file();
411         world.do_update = 0;
412     }
413     read_file_into_queue();
414     if (world.queue_size && '\0' != world.queue[world.queue_size - 1])
415     {
416         char * new_queue = try_malloc(world.queue_size + 1, __func__);
417         memcpy(new_queue, world.queue, world.queue_size);
418         new_queue[world.queue_size] = '\0';
419         world.queue_size++;
420         free(world.queue);
421         world.queue = new_queue;
422     }
423     return get_message_from_queue();
424 }
425
426
427
428 extern void save_world()
429 {
430     char * path_tmp;
431     FILE * file = atomic_write_start(s[S_PATH_SAVE], &path_tmp);
432     write_key_space_value(file, s[S_CMD_MAPLENGTH], world.map.length);
433     write_key_space_value(file, s[S_CMD_PLAYTYPE], world.player_type);
434     try_fputc('\n', file, __func__);
435     struct ThingAction * ta;
436     for (ta = world.thing_actions; ta; ta = ta->next)
437     {
438         write_key_space_value(file, s[S_CMD_TA_ID], ta->id);
439         write_key_space_value(file, s[S_CMD_TA_EFFORT], ta->effort);
440         write_key_space_string(file, s[S_CMD_TA_NAME], ta->name);
441         try_fputc('\n', file, __func__);
442     }
443     struct ThingType * tt;
444     for (tt = world.thing_types; tt; tt = tt->next)
445     {
446         write_key_space_value(file, s[S_CMD_TT_ID], tt->id);
447         write_key_space_value(file, s[S_CMD_TT_STARTN], tt->start_n);
448         write_key_space_value(file, s[S_CMD_TT_HP], tt->lifepoints);
449         int test = fprintf(file, "%s %c\n", s[S_CMD_TT_SYMB], tt->char_on_map);
450         exit_trouble(test < 0, __func__, "fprintf");
451         write_key_space_string(file, s[S_CMD_TT_NAME], tt->name);
452         write_key_space_value(file, s[S_CMD_TT_CONSUM], tt->consumable);
453         try_fputc('\n', file, __func__);
454     }
455     for (tt = world.thing_types; tt; tt = tt->next)
456     {
457         write_key_space_value(file, s[S_CMD_TT_ID], tt->id);
458         write_key_space_value(file, s[S_CMD_TT_CORPS], tt->corpse_id);
459     }
460     try_fputc('\n', file, __func__);
461     write_key_space_value(file, s[S_CMD_SEED_MAP], world.seed_map);
462     write_key_space_value(file, s[S_CMD_SEED_RAND], world.seed);
463     write_key_space_value(file, s[S_CMD_TURN], world.turn);
464     try_fputc('\n', file, __func__);
465     struct Thing * t;
466     for (t = world.things; t; t = t->next)
467     {
468         write_thing(file, t);
469     }
470     write_key_space_value(file, s[S_CMD_WORLD_ACTIVE], 1);
471     atomic_write_finish(file, s[S_PATH_SAVE], path_tmp);
472 }