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