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