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