home · contact · privacy
Server: Don't continue turn after player has died.
[plomrogue] / src / server / run.c
1 /* src/server/run.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 200809L /* strdup() */
9 #include "run.h"
10 #include <stddef.h> /* NULL */
11 #include <stdint.h> /* uint8_t, uint16_t, uint32_t, int16_t */
12 #include <stdio.h> /* FILE, printf(), fflush() */
13 #include <stdlib.h> /* free() */
14 #include <string.h> /* strlen(), strcmp(), strncmp(), strdup() */
15 #include <time.h> /* time_t, time() */
16 #include <unistd.h> /* access() */
17 #include "../common/parse_file.h" /* set_err_line_options(), token_from_line(),
18                                    * err_line(), err_line_inc(), parse_val()
19                                    */
20 #include "../common/readwrite.h" /* try_fopen(), try_fcose(), try_fwrite(),
21                                   * try_fgets(), textfile_width(), try_fputc(),
22                                   * atomic_write_finish(), build_temp_path()
23                                   */
24 #include "../common/rexit.h" /* exit_trouble(), exit_err() */
25 #include "../common/try_malloc.h" /* try_malloc() */
26 #include "ai.h" /* ai() */
27 #include "cleanup.h" /* unset_cleanup_flag() */
28 #include "god_commands.h" /* parse_god_command_(1|2|3)arg() */
29 #include "hardcoded_strings.h" /* s */
30 #include "io.h" /* io_round(), save_world() */
31 #include "things.h" /* Thing, ThingType, get_thing_action_id_by_name(),
32                      * get_player(), try_thing_proliferation()
33                      */
34 #include "world.h" /* world */
35
36
37
38 /* If "string" and "comparand" match in string, set "c_to_set" to value."  */
39 static uint8_t set_char_by_string_comparison(char * string, char * comparand,
40                                              char * c_to_set, char value);
41
42 /* Return 1 on world.exists, else 0 and err_line() appropriate error message. */
43 static uint8_t player_commands_allowed();
44
45 /* Parse player command "tok0" with no argument to player action. */
46 static uint8_t parse_player_command_0arg(char * tok0);
47
48 /* Parse player command "tok0" with one argument "tok1" to player action. */
49 static uint8_t parse_player_command_1arg(char * tok0, char * tok1);
50
51 /* Parse/apply command "tok0" (read further tokens as necessary). */
52 static uint8_t parse_command(char * tok0);
53
54 /* Compares first line of server out file to world.server_test, aborts if they
55  * don't match, but not before unsetting the flags deleting files in the server
56  * directory, for in that case those must be assumed to belong to another server
57  * process.
58  */
59 static void server_test();
60
61 /* Return array of IDs of non-owned things in game world, ended by non-ID -1. */
62 static int16_t * build_whitelist();
63
64 /* Return 1 if value of "id" appears in "whitelist", else 0. */
65 static uint8_t thing_in_whitelist(uint8_t id, int16_t * whitelist);
66
67 /* Run the game world and its inhabitants (and their actions) until the player
68  * avatar is free to receive new commands (or is dead). Only actions and
69  * proliferations for non-owned things are performed that exist at the start of
70  * the turn jumped into, or started anew by the cycle.
71  */
72 static void turn_over();
73
74 /* Append "answer" to server output file, with instant fflush(). */
75 static void answer_query(char * answer);
76
77 /* Try to read "msg" as meta command, act accordingly; on success, free it. */
78 static uint8_t meta_commands(char * msg);
79
80
81
82 static uint8_t set_char_by_string_comparison(char * string, char * comparand,
83                                              char * c_to_set, char value)
84 {
85     if (!strcmp(string, comparand))
86     {
87         * c_to_set = value;
88         return 1;
89     }
90     return 0;
91 }
92
93
94
95 static uint8_t player_commands_allowed()
96 {
97     if (!world.exists)
98     {
99         return !err_line(1, "No world exists in which to run player commands.");
100     }
101     return 1;
102 }
103
104
105
106 static uint8_t parse_player_command_0arg(char * tok0)
107 {
108     struct Thing * player = get_player();
109     if (   !strcmp(tok0, s[S_CMD_WAIT]) || !strcmp(tok0, s[S_CMD_PICKUP])
110         || !strcmp(tok0, s[S_CMD_AI]))
111     {
112         if (player_commands_allowed())
113         {
114             if (!strcmp(tok0, s[S_CMD_AI]))
115             {
116                 ai(player);
117             }
118             else
119             {
120                 player->command = get_thing_action_id_by_name(tok0);
121                 player->arg = 0;
122             }
123             turn_over();
124         }
125         return 1;
126     }
127     return 0;
128 }
129
130
131
132 static uint8_t parse_player_command_1arg(char * tok0, char * tok1)
133 {
134     struct Thing * player = get_player();
135     if (   (   parse_val(tok0, tok1, s[S_CMD_DROP], '8', (char *) &player->arg)
136             || parse_val(tok0, tok1, s[S_CMD_USE], '8', (char *) &player->arg))
137         && player_commands_allowed())
138     {
139         player->command = get_thing_action_id_by_name(tok0);
140         turn_over();
141     }
142     else if (!strcmp(tok0, s[S_CMD_MOVE]) && player_commands_allowed())
143     {
144         char dir = '\0';
145         if (!(   set_char_by_string_comparison(tok1, "east",       &dir, 'd')
146               || set_char_by_string_comparison(tok1, "south-east", &dir, 'c')
147               || set_char_by_string_comparison(tok1, "south-west", &dir, 'x')
148               || set_char_by_string_comparison(tok1, "west",       &dir, 's')
149               || set_char_by_string_comparison(tok1, "north-west", &dir, 'w')
150               || set_char_by_string_comparison(tok1, "north-east", &dir, 'e')))
151         {
152             return 0;
153         }
154         player->arg = dir;
155         player->command = get_thing_action_id_by_name(tok0);
156         turn_over();
157     }
158     else
159     {
160         return 0;
161     }
162     return 1;
163 }
164
165
166
167 static uint8_t parse_command(char * tok0)
168 {
169     if (parse_player_command_0arg(tok0))
170     {
171         return 1;
172     }
173     else
174     {
175         char * tok1 = token_from_line(NULL);
176         if (tok1 && (   parse_player_command_1arg(tok0, tok1)
177                      || parse_god_command_1arg(tok0, tok1)))
178         {
179             return 1;
180         }
181         else
182         {
183             char * tok2 = token_from_line(NULL);
184             if (tok2 && parse_god_command_2arg(tok0, tok1, tok2))
185             {
186                 return 1;
187             }
188             else
189             {
190                 char * tok3 = token_from_line(NULL);
191                 if (tok2 && parse_god_command_3arg(tok0, tok1, tok2, tok3))
192                 {
193                     return 1;
194                 }
195             }
196         }
197     }
198     return 0;
199 }
200
201
202
203 static void server_test()
204 {
205     char test[10 + 1 + 10 + 1 + 1];
206     FILE * file = try_fopen(s[S_PATH_OUT], "r", __func__);
207     try_fgets(test, 10 + 10 + 1 + 1, file, __func__);
208     try_fclose(file, __func__);
209     if (strcmp(test, world.server_test))
210     {
211         unset_cleanup_flag(CLEANUP_WORLDSTATE);
212         unset_cleanup_flag(CLEANUP_OUT);
213         unset_cleanup_flag(CLEANUP_IN);
214         char * msg = "Server test string in server output file does not match. "
215                      "This indicates that the current server process has been "
216                      "superseded by another one.";
217         exit_err(1, msg);
218     }
219 }
220
221
222
223 static int16_t * build_whitelist()
224 {
225     uint16_t i_things = NULL != world.things;
226     struct Thing * t = world.things;
227     for (; t; t = t->next, i_things++);
228     int16_t * whitelist = try_malloc(i_things * sizeof(int16_t), __func__);
229     for (i_things = 0, t = world.things; t;
230          whitelist[i_things] = t->id, t = t->next, i_things++);
231     whitelist[i_things] = -1;
232     return whitelist;
233 }
234
235
236
237 static uint8_t thing_in_whitelist(uint8_t id, int16_t * whitelist)
238 {
239     uint16_t i;
240     for (i = 0; -1 < whitelist[i]; i++)
241     {
242         if ((int16_t) id == whitelist[i])
243         {
244             return 1;
245         }
246     }
247     return 0;
248 }
249
250
251
252 static void turn_over()
253 {
254     struct Thing * player = get_player();
255     struct Thing * thing = player;
256     int16_t * whitelist = build_whitelist();
257     while (0 < player->lifepoints)
258     {
259         if (!thing)
260         {
261             world.turn++;
262             thing = world.things;
263             free(whitelist);
264             whitelist = build_whitelist();/* The whitelist excludes things    */
265         }                                 /* that appear only during the turn.*/
266         if (thing_in_whitelist(thing->id, whitelist))
267         {
268             if (0 < thing->lifepoints)
269             {
270                 if (0 == thing->command)
271                 {
272                     if (thing == player)
273                     {
274                         break;
275                     }
276                     ai(thing);
277                 }
278                 thing->progress++;
279                 struct ThingAction * ta = get_thing_action(thing->command);
280                 if (thing->progress == ta->effort)
281                 {
282                     ta->func(thing);
283                     thing->command = 0;
284                     thing->progress = 0;
285                 }
286             }
287             try_thing_proliferation(thing);
288         }
289         thing = thing->next;
290     }
291     free(whitelist);
292 }
293
294
295
296 static void answer_query(char * answer)
297 {
298     try_fwrite(answer, strlen(answer), 1, world.file_out, __func__);
299     fflush(world.file_out);
300 }
301
302
303
304 static uint8_t meta_commands(char * msg)
305 {
306     if (!strcmp("QUIT", msg))
307     {
308         free(msg);
309         return 2;
310     }
311     if (!strcmp("PING", msg))
312     {
313         free(msg);
314         answer_query("PONG\n");
315         return 1;
316     }
317     if (!strcmp("STACK", msg))
318     {
319         free(msg);
320         answer_query("THINGS_BELOW_PLAYER START\n");
321         struct Thing * player = get_player();
322         struct Thing * t;
323         for (t = world.things; t; t = t->next)
324         {
325             if (   t->pos.y == player->pos.y && t->pos.x == player->pos.x
326                 && t != player)
327             {
328                 struct ThingType * tt = get_thing_type(t->type);
329                 answer_query(tt->name);
330                 answer_query("\n");
331             }
332         }
333         answer_query("THINGS_BELOW_PLAYER END\n");
334         return 1;
335     }
336     return 0;
337 }
338
339
340
341 extern void record(char * msg, uint8_t force)
342 {
343     static FILE * file_tmp = NULL;
344     static time_t save_wait = 0;
345     static char * path_tmp;
346     if (!file_tmp)
347     {
348         path_tmp = build_temp_path(s[S_PATH_RECORD]);
349         file_tmp = try_fopen(path_tmp, "w", __func__);
350         if (!access(s[S_PATH_RECORD], F_OK))
351         {
352             FILE * file_read = try_fopen(s[S_PATH_RECORD], "r", __func__);
353             uint32_t linemax = textfile_width(file_read);
354             char * line = try_malloc(linemax + 1, __func__);
355             while (try_fgets(line, linemax + 1, file_read, __func__))
356             {
357                 try_fwrite(line, strlen(line), 1, file_tmp, __func__);
358             }
359             free(line);
360             try_fclose(file_read, __func__);
361         }
362     }
363     if (msg)
364     {
365         try_fwrite(msg, strlen(msg), 1, file_tmp, __func__);
366         try_fputc('\n', file_tmp, __func__);
367     }
368     if (force || time(NULL) > save_wait + 15)
369     {
370         save_wait = time(NULL);
371         save_world();
372         atomic_write_finish(file_tmp, s[S_PATH_RECORD], path_tmp);
373         file_tmp = NULL;
374     }
375 }
376
377
378
379 extern void obey_msg(char * msg, uint8_t do_record, uint8_t do_verbose)
380 {
381     if (world.is_verbose && do_verbose)
382     {
383         exit_trouble(-1 == printf("Input: %s\n", msg), __func__, "printf");
384     }
385     set_err_line_options("Trouble with message: ", msg, 0);
386     char * msg_copy = strdup(msg);
387     char * tok0 = token_from_line(msg_copy);
388     if (tok0)
389     {
390
391         if (parse_command(tok0))
392         {
393             if (world.exists)
394             {
395                 world.do_update = 1;
396             }
397             if (do_record)
398             {
399                 record(msg, 0);
400             }
401             char * tokplus = token_from_line(NULL);
402             err_line(!(!tokplus), "Too many arguments, ignoring overflow.");
403             free(msg_copy);
404             return;
405         }
406     }
407     err_line(1, "Unknown command/argument or bad number of tokens.");
408     free(msg_copy);
409 }
410
411
412
413 extern uint8_t io_loop()
414 {
415     while (1)
416     {
417         char * msg = io_round();
418         server_test();
419         if (!msg)
420         {
421             continue;
422         }
423         if (world.is_verbose)
424         {
425             exit_trouble(-1 == printf("Input: %s\n", msg), __func__, "printf");
426         }
427         uint8_t test = meta_commands(msg);
428         if (test)
429         {
430             if (2 == test)
431             {
432                 return 1;
433             }
434             continue;
435         }
436         if (world.replay)
437         {
438             free(msg);
439             return 0;
440         }
441         obey_msg(msg, 1, 0);
442         free(msg);
443     }
444 }