home · contact · privacy
69a0865276e0636799da579518e0145728caba30
[plomrogue] / src / client / io.c
1 /* src/client/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 1 /* PIPE_BUF */
9 #include "io.h"
10 #include <limits.h> /* PIPE_BUF */
11 #include <ncurses.h> /* halfdelay(), getch() */
12 #include <stddef.h> /* NULL */
13 #include <stdint.h> /* uint8_t, uint16_t, uint32_t */
14 #include <stdio.h> /* FILE, sprintf(), fseek(), fflush() */
15 #include <string.h> /* strcmp(), strlen(), memcpy() */
16 #include <stdlib.h> /* free(), atoi() */
17 #include <sys/stat.h> /* stat() */
18 #include <sys/types.h> /* time_t */
19 #include <time.h> /* time() */
20 #include <unistd.h> /* access() */
21 #include "../common/try_malloc.h" /* try_malloc() */
22 #include "../common/rexit.h" /* exit_trouble(), exit_err() */
23 #include "../common/readwrite.h" /* try_fopen(), try_fclose(), try_fgets(),
24                                   * try_fgetc(), textfile_width(), try_fputc(),
25                                   * read_file_into_queue(),
26                                   * get_message_from_queue(),
27                                   */
28 #include "control.h" /* try_key() */
29 #include "map.h" /* map_center() */
30 #include "windows.h" /* reset_windows_on_winch(), draw_all_wins() */
31 #include "world.h" /* world global */
32
33
34
35 /* Read next lines of "file" up to (and excluding) a line "%\n" into the
36  * world.player_inventory string.
37  */
38 static void read_inventory(char * read_buf, uint32_t linemax, FILE * file);
39
40 /* Read the next characters in "file" into "map". In detail: Read
41  * world.map.length times world.map.length characters, followed by one ignored
42  * character (that we assume is a newline).
43  */
44 static void read_map_cells(FILE * file, char ** map);
45
46 /* Return value seen by atoi() in next line of "file" when passed to try_fgets()
47  * with the given arguments.
48  */
49 static uint16_t read_value_from_line(char * read_buf, uint32_t linemax,
50                                      FILE * file);
51
52 /* If the server's worldstate file has changed since the last read_worldstate(),
53  * return a pointer to its file descriptor; else, return NULL.
54  *
55  * Two tests are performed to check for a file change. The file's last data
56  * modification time in seconds via stat() is compared against world.last_update
57  * (and if it is changed, world.last_update is re-set to it). If this does not
58  * verify a change, the first bytes of the file are read to compare the game
59  * turn number described therein to the last read turn number in world.turn.
60  *
61  * The stat() check is mostly useless, for it only detects file updates once a
62  * second. But the turn check fails if a new world is generated from turn 1 on:
63  * the new world also starts in turn 1, not signifying any world change to the
64  * turn check. The stat() check detects this change with at most 1 second delay.
65  */
66 static FILE * changed_worldstate_file(char * path);
67
68 /* Attempt to read the server's worldstate file as representation of the game
69  * world in a hard-coded serialization format. Returns 1 on success, or 0 if the
70  * out file wasn't read for supposedly not having changed since a last
71  * read_worldstate() call.
72  *
73  * map_center() is triggered by either, the first successful read_worldstate()
74  * (thus on client start), or on turn 1 (thus on world start).
75  */
76 static uint8_t read_worldstate();
77
78 /* If "last_server_answer_time" is too old, send a PING to the server; or, if a
79  * previous PING has not sparked any answer after a while, abort the client.
80  */
81 static void ping_pong_test(time_t last_server_answer_time);
82
83 /* Read server's out file into queue, update "last_server_answer_time" if new
84  * stuff is found there.
85  */
86 static void try_growing_queue(time_t * last_server_answer_time);
87
88 /* Read server out file for messages, act on them (i.e. derive log messages). */
89 static uint8_t read_outfile();
90
91
92
93 static void read_inventory(char * read_buf, uint32_t linemax, FILE * file)
94 {
95     char * delimiter = "%\n";
96     free(world.player_inventory);
97     world.player_inventory = NULL;          /* Avoids illegal strlen() below. */
98     while (1)
99     {
100         try_fgets(read_buf, linemax + 1, file, __func__);
101         if (!(strcmp(read_buf, delimiter)))
102         {
103             break;
104         }
105         int old_size = 0;
106         if (world.player_inventory)
107         {
108             old_size = strlen(world.player_inventory);
109         }
110         int new_size = strlen(read_buf);
111         char * new_inventory = try_malloc(old_size + new_size + 1, __func__);
112         memcpy(new_inventory, world.player_inventory, old_size);
113         int test = sprintf(new_inventory + old_size, "%s", read_buf);
114         exit_trouble(test < 0, __func__, "sprintf");
115         free(world.player_inventory);
116         world.player_inventory = new_inventory;
117     }
118     world.player_inventory[strlen(world.player_inventory) - 1] = '\0';
119     world.player_inventory_select = 0;
120 }
121
122
123
124 static void read_map_cells(FILE * file, char ** map)
125 {
126     if (*map)
127     {
128         free(*map);
129         *map = NULL;
130     }
131     *map = try_malloc(world.map.length * world.map.length, __func__);
132     char * map_cells = *map;
133     uint16_t y, x;
134     for (y = 0; y < world.map.length; y++)
135     {
136         for (x = 0; x < world.map.length; x++)
137         {
138             char c = try_fgetc(file, __func__);
139             map_cells[y * world.map.length + x] = c;
140         }
141         try_fgetc(file, __func__);
142     }
143 }
144
145
146
147 static uint16_t read_value_from_line(char * read_buf, uint32_t linemax,
148                                      FILE * file)
149 {
150     try_fgets(read_buf, linemax + 1, file, __func__);
151     return atoi(read_buf);
152 }
153
154
155
156 static FILE * changed_worldstate_file(char * path)
157 {
158     struct stat stat_buf;
159     exit_trouble(stat(path, &stat_buf), __func__, "stat");
160     if (stat_buf.st_mtime != world.last_update)
161     {
162         world.last_update = stat_buf.st_mtime;
163         return try_fopen(path, "r", __func__);
164     }
165     FILE * file = try_fopen(path, "r", __func__);
166     char turn_string[6];
167     try_fgets(turn_string, 6, file, __func__);
168     if (world.turn == atoi(turn_string))
169     {
170         try_fclose(file, __func__);
171         return NULL;
172     }
173     exit_trouble(fseek(file, 0, SEEK_SET), __func__, "fseek");
174     return file;
175 }
176
177
178
179 static uint8_t read_worldstate()
180 {
181     char * path = "server/worldstate";
182     char * quit_msg = "No worldstate file found to read. Server may be down.";
183     static uint8_t first_read = 1;
184     exit_err(access(path, F_OK), quit_msg);
185     FILE * file = changed_worldstate_file(path);
186     if (!file)
187     {
188         return 0;
189     }
190     uint32_t linemax = textfile_width(file);
191     char * read_buf = try_malloc(linemax + 1, __func__);
192     world.turn = read_value_from_line(read_buf, linemax, file);
193     world.player_lifepoints = read_value_from_line(read_buf, linemax, file);
194     read_inventory(read_buf, linemax, file);
195     world.player_pos.y = read_value_from_line(read_buf, linemax, file);
196     world.player_pos.x = read_value_from_line(read_buf, linemax, file);
197     if (1 == world.turn || first_read)
198     {
199         map_center();
200         first_read = 0;
201     }
202     world.map.length = read_value_from_line(read_buf, linemax, file);
203     read_map_cells(file, &world.map.cells);
204     read_map_cells(file, &world.mem_map);
205     free(read_buf);
206     try_fclose(file, __func__);
207     return 1;
208 }
209
210
211
212 static void ping_pong_test(time_t last_server_answer_time)
213 {
214     static uint8_t ping_sent = 0;
215     time_t now = time(0);
216     if (ping_sent && last_server_answer_time > now - 3)  /* Re-set if last    */
217     {                                                    /* ping was answered */
218         ping_sent = 0;                                   /* with server       */
219         return;                                          /* activity.         */
220     }
221     if (!ping_sent && last_server_answer_time < now - 3)
222     {
223         send("PING");
224         ping_sent = 1;
225         return;
226     }
227     exit_err(last_server_answer_time < now - 6, "Server not answering.");
228 }
229
230
231
232 static void try_growing_queue(time_t * last_server_answer_time)
233 {
234     if (read_file_into_queue(world.file_server_out, &world.queue))
235     {
236         * last_server_answer_time = time(0);
237     }
238 }
239
240
241
242 static uint8_t read_outfile()
243 {
244     uint8_t ret = 0;
245     char * msg;
246     while (NULL != (msg = get_message_from_queue(&world.queue)))
247     {
248         char * log_prefix = "LOG ";
249         if (!strncmp(msg, log_prefix, strlen(log_prefix)))
250         {
251             ret = 1;
252             char * log_msg = msg + strlen(log_prefix);
253             int old_size = 0;
254             if (world.log)
255             {
256                 old_size = strlen(world.log);
257             }
258             int new_size = strlen(log_msg);
259             char * new_log = try_malloc(old_size + 1 + new_size + 1, __func__);
260             memcpy(new_log, world.log, old_size);
261             int test = sprintf(new_log + old_size, "\n%s", log_msg);
262             exit_trouble(test < 0, __func__, "sprintf");
263             free(world.log);
264             world.log = new_log;
265         }
266         free(msg);
267     }
268     return ret;
269 }
270
271
272
273 extern void send(char * msg)
274 {
275     uint32_t msg_size = strlen(msg) + 1;
276     char * err = "send() tried to send message larger than PIPE_BUF bytes.";
277     exit_err(msg_size > PIPE_BUF, err);
278     try_fwrite(msg, strlen(msg), 1, world.file_server_in, __func__);
279     try_fputc('\n', world.file_server_in, __func__);
280     fflush(world.file_server_in);
281 }
282
283
284
285 extern char * io_loop()
286 {
287     world.halfdelay = 1;         /* Ensures read_worldstate() is only called  */
288     halfdelay(world.halfdelay);  /* 10 times a second during user inactivity. */
289     uint8_t change_in_client = 0;
290     uint16_t last_focused_turn = world.turn;
291     time_t last_server_answer_time = time(0);
292     while (1)
293     {
294         try_growing_queue(&last_server_answer_time);
295         ping_pong_test(last_server_answer_time);
296         if (world.winch)
297         {
298             reset_windows_on_winch();
299             world.winch = 0;
300             change_in_client++;
301         }
302         if (change_in_client || read_worldstate() || read_outfile())
303         {
304             if (world.turn != last_focused_turn && world.focus_each_turn)
305             {
306                 last_focused_turn = world.turn;
307                 map_center();
308             }
309             draw_all_wins();
310         }
311         change_in_client = 0;
312         int key = getch();
313         if (ERR != key)
314         {
315             change_in_client = try_key((uint16_t) key);
316             if (2 == change_in_client)
317             {
318                 break;
319             }
320         }
321     }
322     send("QUIT");
323     return "Sent QUIT to server.";
324 }