plomlompom.com Git - plomrogue/blob - plomrogue-server.py

   1 import argparse
   2 import errno
   3 import os
   4 import shlex
   5 import shutil
   6 import time
   7
   8
   9 def strong_write(file, string):
  10     """Apply write(string), flush(), and os.fsync() to file."""
  11     file.write(string)
  12     file.flush()
  13     os.fsync(file)
  14
  15
  16 def setup_server_io():
  17     """Fill IO files DB with proper file( path)s. Write process IO test string.
  18
  19     Ensure IO files directory at server/. Remove any old input file if found.
  20     Set up new input file for reading, and new output file for writing. Start
  21     output file with process hash line of format PID + " " + floated UNIX time
  22     (io_db["teststring"]). Raise SystemExit if file is found at path of either
  23     record or save file plus io_db["tmp_suffix"].
  24     """
  25     def detect_atomic_leftover(path, tmp_suffix):
  26         path_tmp = path + tmp_suffix
  27         msg = "Found file '" + path_tmp + "' that may be a leftover from an " \
  28               "aborted previous attempt to write '" + path + "'. Aborting " \
  29              "until matter is resolved by removing it from its current path."
  30         if os.access(path_tmp, os.F_OK):
  31             raise SystemExit(msg)
  32     io_db["teststring"] = str(os.getpid()) + " " + str(time.time())
  33     os.makedirs(io_db["path_server"], exist_ok=True)
  34     io_db["file_out"] = open(io_db["path_out"], "w")
  35     strong_write(io_db["file_out"], io_db["teststring"] + "\n")
  36     if os.access(io_db["path_in"], os.F_OK):
  37         os.remove(io_db["path_in"])
  38     io_db["file_in"] = open(io_db["path_in"], "w")
  39     io_db["file_in"].close()
  40     io_db["file_in"] = open(io_db["path_in"], "r")
  41     detect_atomic_leftover(io_db["path_save"], io_db["tmp_suffix"])
  42     detect_atomic_leftover(io_db["path_record"], io_db["tmp_suffix"])
  43
  44
  45 def cleanup_server_io():
  46     """Close and (if io_db["kicked_by_rival"] false) remove files in io_db."""
  47     def helper(file_key, path_key):
  48         if file_key in io_db:
  49             io_db[file_key].close()
  50             if not io_db["kicked_by_rival"] \
  51                and os.access(io_db[path_key], os.F_OK):
  52                 os.remove(io_db[path_key])
  53     helper("file_out", "path_out")
  54     helper("file_in", "path_in")
  55     helper("file_worldstate", "path_worldstate")
  56     if "file_record" in io_db:
  57         io_db["file_record"].close()
  58
  59
  60 def obey(command, prefix, replay=False, do_record=False):
  61     """Call function from commands_db mapped to command's first token.
  62
  63     Tokenize command string with shlex.split(comments=True). If replay is set,
  64     a non-meta command from the commands_db merely triggers obey() on the next
  65     command from the records file. If not, non-meta commands set
  66     io_db["worldstate_updateable"] to world_db["WORLD_EXISTS"], and, if
  67     do_record is set, are recorded via record(), and save_world() is called.
  68     The prefix string is inserted into the server's input message between its
  69     beginning 'input ' & ':'. All activity is preceded by a server_test() call.
  70     """
  71     server_test()
  72     print("input " + prefix + ": " + command)
  73     try:
  74         tokens = shlex.split(command, comments=True)
  75     except ValueError as err:
  76         print("Can't tokenize command string: " + str(err) + ".")
  77         return
  78     if len(tokens) > 0 and tokens[0] in commands_db \
  79        and len(tokens) == commands_db[tokens[0]][0] + 1:
  80         if commands_db[tokens[0]][1]:
  81             commands_db[tokens[0]][2](*tokens[1:])
  82         elif replay:
  83             print("Due to replay mode, reading command as 'go on in record'.")
  84             line = io_db["file_record"].readline()
  85             if len(line) > 0:
  86                 obey(line.rstrip(), io_db["file_record"].prefix
  87                      + str(io_db["file_record"].line_n))
  88                 io_db["file_record"].line_n = io_db["file_record"].line_n + 1
  89             else:
  90                 print("Reached end of record file.")
  91         else:
  92             commands_db[tokens[0]][2](*tokens[1:])
  93             if do_record:
  94                 record(command)
  95                 save_world()
  96             io_db["worldstate_updateable"] = world_db["WORLD_ACTIVE"]
  97     elif 0 != len(tokens):
  98         print("Invalid command/argument, or bad number of tokens.")
  99
 100
 101 def atomic_write(path, text, do_append=False):
 102     """Atomic write of text to file at path, appended if do_append is set."""
 103     path_tmp = path + io_db["tmp_suffix"]
 104     mode = "w"
 105     if do_append:
 106         mode = "a"
 107         if os.access(path, os.F_OK):
 108             shutil.copyfile(path, path_tmp)
 109     file = open(path_tmp, mode)
 110     strong_write(file, text)
 111     file.close()
 112     if os.access(path, os.F_OK):
 113         os.remove(path)
 114     os.rename(path_tmp, path)
 115
 116
 117 def record(command):
 118     """Append command string plus newline to record file. (Atomic.)"""
 119     # This misses some optimizations from the original record(), namely only
 120     # finishing the atomic write with expensive flush() and fsync() every 15
 121     # seconds unless explicitely forced. Implement as needed.
 122     atomic_write(io_db["path_record"], command + "\n", do_append=True)
 123
 124
 125 def save_world():
 126     """Save all commands needed to reconstruct current world state."""
 127     # TODO: Misses same optimizations as record() from the original record().
 128
 129     def quote(string):
 130         string = string.replace("\u005C", '\u005C\u005C')
 131         return '"' + string.replace('"', '\u005C"') + '"'
 132
 133     def mapsetter(key):
 134         def helper(id):
 135             string = ""
 136             if world_db["Things"][id][key]:
 137                 map = world_db["Things"][id][key]
 138                 length = world_db["MAP_LENGTH"]
 139                 for i in range(length):
 140                     line = map[i * length:(i * length) + length].decode()
 141                     string = string + key + " " + str(i) + " " + quote(line) \
 142                              + "\n"
 143             return string
 144         return helper
 145
 146     def memthing(id):
 147         string = ""
 148         for memthing in world_db["Things"][id]["T_MEMTHING"]:
 149             string = string + "T_MEMTHING " + str(memthing[0]) + " " + \
 150                      str(memthing[1]) + " " + str(memthing[2]) + "\n"
 151         return string
 152
 153     def helper(category, id_string, special_keys={}):
 154         string = ""
 155         for id in world_db[category]:
 156             string = string + id_string + " " + str(id) + "\n"
 157             for key in world_db[category][id]:
 158                 if not key in special_keys:
 159                     x = world_db[category][id][key]
 160                     argument = quote(x) if str == type(x) else str(x)
 161                     string = string + key + " " + argument + "\n"
 162                 elif special_keys[key]:
 163                     string = string + special_keys[key](id)
 164         return string
 165
 166     string = ""
 167     for key in world_db:
 168         if dict != type(world_db[key]) and key != "MAP":
 169             string = string + key + " " + str(world_db[key]) + "\n"
 170     string = string + helper("ThingActions", "TA_ID")
 171     string = string + helper("ThingTypes", "TT_ID", {"TT_CORPSE_ID": False})
 172     for id in world_db["ThingTypes"]:
 173         string = string + "TT_ID " + str(id) + "\n" + "TT_CORPSE_ID " + \
 174                  str(world_db["ThingTypes"][id]["TT_CORPSE_ID"]) + "\n"
 175     string = string + helper("Things", "T_ID",
 176                              {"T_CARRIES": False, "carried": False,
 177                               "T_MEMMAP": mapsetter("T_MEMMAP"),
 178                               "T_MEMTHING": memthing, "fovmap": False,
 179                               "T_MEMDEPTHMAP": mapsetter("T_MEMDEPTHMAP")})
 180     for id in world_db["Things"]:
 181         if [] != world_db["Things"][id]["T_CARRIES"]:
 182             string = string + "T_ID " + str(id) + "\n"
 183             for carried_id in world_db["Things"][id]["T_CARRIES"]:
 184                 string = string + "T_CARRIES " + str(carried_id) + "\n"
 185     string = string + "WORLD_ACTIVE " + str(world_db["WORLD_ACTIVE"])
 186     atomic_write(io_db["path_save"], string)
 187
 188
 189 def obey_lines_in_file(path, name, do_record=False):
 190     """Call obey() on each line of path's file, use name in input prefix."""
 191     file = open(path, "r")
 192     line_n = 1
 193     for line in file.readlines():
 194         obey(line.rstrip(), name + "file line " + str(line_n),
 195              do_record=do_record)
 196         line_n = line_n + 1
 197     file.close()
 198
 199
 200 def parse_command_line_arguments():
 201     """Return settings values read from command line arguments."""
 202     parser = argparse.ArgumentParser()
 203     parser.add_argument('-s', nargs='?', type=int, dest='replay', const=1,
 204                         action='store')
 205     opts, unknown = parser.parse_known_args()
 206     return opts
 207
 208
 209 def server_test():
 210     """Ensure valid server out file belonging to current process.
 211
 212     This is done by comparing io_db["teststring"] to what's found at the start
 213     of the current file at io_db["path_out"]. On failure, set
 214     io_db["kicked_by_rival"] and raise SystemExit.
 215     """
 216     if not os.access(io_db["path_out"], os.F_OK):
 217         raise SystemExit("Server output file has disappeared.")
 218     file = open(io_db["path_out"], "r")
 219     test = file.readline().rstrip("\n")
 220     file.close()
 221     if test != io_db["teststring"]:
 222         io_db["kicked_by_rival"] = True
 223         msg = "Server test string in server output file does not match. This" \
 224               " indicates that the current server process has been " \
 225               "superseded by another one."
 226         raise SystemExit(msg)
 227
 228
 229 def read_command():
 230     """Return next newline-delimited command from server in file.
 231
 232     Keep building return string until a newline is encountered. Pause between
 233     unsuccessful reads, and after too much waiting, run server_test().
 234     """
 235     wait_on_fail = 1
 236     max_wait = 5
 237     now = time.time()
 238     command = ""
 239     while True:
 240         add = io_db["file_in"].readline()
 241         if len(add) > 0:
 242             command = command + add
 243             if len(command) > 0 and "\n" == command[-1]:
 244                 command = command[:-1]
 245                 break
 246         else:
 247             time.sleep(wait_on_fail)
 248             if now + max_wait < time.time():
 249                 server_test()
 250                 now = time.time()
 251     return command
 252
 253
 254 def try_worldstate_update():
 255     """Write worldstate file if io_db["worldstate_updateable"] is set."""
 256     if io_db["worldstate_updateable"]:
 257
 258         def draw_visible_Things(map, run):
 259             for id in world_db["Things"]:
 260                 type = world_db["Things"][id]["T_TYPE"]
 261                 consumable = world_db["ThingTypes"][type]["TT_CONSUMABLE"]
 262                 alive = world_db["ThingTypes"][type]["TT_LIFEPOINTS"]
 263                 if (0 == run and not consumable and not alive) \
 264                    or (1 == run and consumable and not alive) \
 265                    or (2 == run and alive):
 266                     y = world_db["Things"][id]["T_POSY"]
 267                     x = world_db["Things"][id]["T_POSX"]
 268                     fovflag = world_db["Things"][0]["fovmap"][(y * length) + x]
 269                     if 'v' == chr(fovflag):
 270                         c = world_db["ThingTypes"][type]["TT_SYMBOL"]
 271                         map[(y * length) + x] = ord(c)
 272
 273         def write_map(string, map):
 274             for i in range(length):
 275                 line = map[i * length:(i * length) + length].decode()
 276                 string = string + line + "\n"
 277             return string
 278
 279         inventory = ""
 280         if [] == world_db["Things"][0]["T_CARRIES"]:
 281             inventory = "(none)\n"
 282         else:
 283             for id in world_db["Things"][0]["T_CARRIES"]:
 284                 type_id = world_db["Things"][id]["T_TYPE"]
 285                 name = world_db["ThingTypes"][type_id]["TT_NAME"]
 286                 inventory = inventory + name + "\n"
 287         string = str(world_db["TURN"]) + "\n" + \
 288                  str(world_db["Things"][0]["T_LIFEPOINTS"]) + "\n" + \
 289                  str(world_db["Things"][0]["T_SATIATION"]) + "\n" + \
 290                  inventory + "%\n" + \
 291                  str(world_db["Things"][0]["T_POSY"]) + "\n" + \
 292                  str(world_db["Things"][0]["T_POSX"]) + "\n" + \
 293                  str(world_db["MAP_LENGTH"]) + "\n"
 294         length = world_db["MAP_LENGTH"]
 295         fov = bytearray(b' ' * (length ** 2))
 296         for pos in range(length ** 2):
 297             if 'v' == chr(world_db["Things"][0]["fovmap"][pos]):
 298                 fov[pos] = world_db["MAP"][pos]
 299         for i in range(3):
 300             draw_visible_Things(fov, i)
 301         string = write_map(string, fov)
 302         mem = world_db["Things"][0]["T_MEMMAP"][:]
 303         for i in range(2):
 304             for memthing in world_db["Things"][0]["T_MEMTHING"]:
 305                 type = world_db["Things"][memthing[0]]["T_TYPE"]
 306                 consumable = world_db["ThingTypes"][type]["TT_CONSUMABLE"]
 307                 if (i == 0 and not consumable) or (i == 1 and consumable):
 308                     c = world_db["ThingTypes"][type]["TT_SYMBOL"]
 309                     mem[(memthing[1] * length) + memthing[2]] = ord(c)
 310         string = write_map(string, mem)
 311         atomic_write(io_db["path_worldstate"], string)
 312         strong_write(io_db["file_out"], "WORLD_UPDATED\n")
 313         io_db["worldstate_updateable"] = False
 314
 315
 316 def replay_game():
 317     """Replay game from record file.
 318
 319     Use opts.replay as breakpoint turn to which to replay automatically before
 320     switching to manual input by non-meta commands in server input file
 321     triggering further reads of record file. Ensure opts.replay is at least 1.
 322     Run try_worldstate_update() before each interactive obey()/read_command().
 323     """
 324     if opts.replay < 1:
 325         opts.replay = 1
 326     print("Replay mode. Auto-replaying up to turn " + str(opts.replay) +
 327           " (if so late a turn is to be found).")
 328     if not os.access(io_db["path_record"], os.F_OK):
 329         raise SystemExit("No record file found to replay.")
 330     io_db["file_record"] = open(io_db["path_record"], "r")
 331     io_db["file_record"].prefix = "record file line "
 332     io_db["file_record"].line_n = 1
 333     while world_db["TURN"] < opts.replay:
 334         line = io_db["file_record"].readline()
 335         if "" == line:
 336             break
 337         obey(line.rstrip(), io_db["file_record"].prefix
 338              + str(io_db["file_record"].line_n))
 339         io_db["file_record"].line_n = io_db["file_record"].line_n + 1
 340     while True:
 341         try_worldstate_update()
 342         obey(read_command(), "in file", replay=True)
 343
 344
 345 def play_game():
 346     """Play game by server input file commands. Before, load save file found.
 347
 348     If no save file is found, a new world is generated from the commands in the
 349     world config plus a 'MAKE WORLD [current Unix timestamp]'. Record this
 350     command and all that follow via the server input file. Run
 351     try_worldstate_update() before each interactive obey()/read_command().
 352     """
 353     if os.access(io_db["path_save"], os.F_OK):
 354         obey_lines_in_file(io_db["path_save"], "save")
 355     else:
 356         if not os.access(io_db["path_worldconf"], os.F_OK):
 357             msg = "No world config file from which to start a new world."
 358             raise SystemExit(msg)
 359         obey_lines_in_file(io_db["path_worldconf"], "world config ",
 360                            do_record=True)
 361         obey("MAKE_WORLD " + str(int(time.time())), "in file", do_record=True)
 362     while True:
 363         try_worldstate_update()
 364         obey(read_command(), "in file", do_record=True)
 365
 366
 367 def remake_map():
 368     # DUMMY map creator.
 369     world_db["MAP"] = bytearray(b'.' * (world_db["MAP_LENGTH"] ** 2))
 370
 371
 372 def update_map_memory(t):
 373     """Update t's T_MEMMAP with what's in its FOV now,age its T_MEMMEPTHMAP."""
 374     if not t["T_MEMMAP"]:
 375         t["T_MEMMAP"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
 376     if not t["T_MEMDEPTHMAP"]:
 377         t["T_MEMDEPTHMAP"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
 378     for pos in range(world_db["MAP_LENGTH"] ** 2):
 379         if "v" == chr(t["fovmap"][pos]):
 380             t["T_MEMDEPTHMAP"][pos] = ord("0")
 381             if " " == chr(t["T_MEMMAP"][pos]):
 382                 t["T_MEMMAP"][pos] = world_db["MAP"][pos]
 383             continue
 384         # TODO: Aging of MEMDEPTHMAP.
 385     for id in t["T_MEMTHING"]:
 386         y = world_db["Things"][id]["T_POSY"]
 387         x = world_db["Things"][id]["T_POSY"]
 388         if "v" == chr(t["fovmap"][(y * world_db["MAP_LENGTH"]) + x]):
 389             t["T_MEMTHING"].remove(id)
 390     for id in world_db["Things"]:
 391         type = world_db["Things"][id]["T_TYPE"]
 392         if not world_db["ThingTypes"][type]["TT_LIFEPOINTS"]:
 393             y = world_db["Things"][id]["T_POSY"]
 394             x = world_db["Things"][id]["T_POSY"]
 395             if "v" == chr(t["fovmap"][(y * world_db["MAP_LENGTH"]) + x]):
 396                 t["T_MEMTHING"].append((type, y, x))
 397
 398
 399 def set_world_inactive():
 400     """Set world_db["WORLD_ACTIVE"] to 0 and remove worldstate file."""
 401     server_test()
 402     if os.access(io_db["path_worldstate"], os.F_OK):
 403         os.remove(io_db["path_worldstate"])
 404     world_db["WORLD_ACTIVE"] = 0
 405
 406
 407 def integer_test(val_string, min, max):
 408     """Return val_string if possible integer >= min and <= max, else None."""
 409     try:
 410         val = int(val_string)
 411         if val < min or val > max:
 412             raise ValueError
 413         return val
 414     except ValueError:
 415         print("Ignoring: Please use integer >= " + str(min) + " and <= " +
 416               str(max) + ".")
 417         return None
 418
 419
 420 def setter(category, key, min, max):
 421     """Build setter for world_db([category + "s"][id])[key] to >=min/<=max."""
 422     if category is None:
 423         def f(val_string):
 424             val = integer_test(val_string, min, max)
 425             if None != val:
 426                 world_db[key] = val
 427     else:
 428         if category == "Thing":
 429             id_store = command_tid
 430             decorator = test_Thing_id
 431         elif category == "ThingType":
 432             id_store = command_ttid
 433             decorator = test_ThingType_id
 434         elif category == "ThingAction":
 435             id_store = command_taid
 436             decorator = test_ThingAction_id
 437
 438         @decorator
 439         def f(val_string):
 440             val = integer_test(val_string, min, max)
 441             if None != val:
 442                 world_db[category + "s"][id_store.id][key] = val
 443     return f
 444
 445
 446 def build_fov_map(t):
 447     """Build Thing's FOV map."""
 448     t["fovmap"] = bytearray(b'v' * (world_db["MAP_LENGTH"] ** 2))
 449     # DUMMY so far. Just builds an all-visible map.
 450
 451
 452 def new_Thing(type):
 453     """Return Thing of type T_TYPE, with fovmap if alive and world active."""
 454     thing = {
 455         "T_LIFEPOINTS": world_db["ThingTypes"][type]["TT_LIFEPOINTS"],
 456         "T_ARGUMENT": 0,
 457         "T_PROGRESS": 0,
 458         "T_SATIATION": 0,
 459         "T_COMMAND": 0,
 460         "T_TYPE": type,
 461         "T_POSY": 0,
 462         "T_POSX": 0,
 463         "T_CARRIES": [],
 464         "carried": False,
 465         "T_MEMTHING": [],
 466         "T_MEMMAP": False,
 467         "T_MEMDEPTHMAP": False,
 468         "fovmap": False
 469     }
 470     if world_db["WORLD_ACTIVE"] and thing["T_LIFEPOINTS"]:
 471         build_fov_map(thing)
 472     return thing
 473
 474
 475 def id_setter(id, category, id_store=False, start_at_1=False):
 476     """Set ID of object of category to manipulate ID unused? Create new one.
 477
 478     The ID is stored as id_store.id (if id_store is set). If the integer of the
 479     input is valid (if start_at_1, >= 0 and <= 255, else >= -32768 and <=
 480     32767), but <0 or (if start_at_1) <1, calculate new ID: lowest unused ID
 481     >=0 or (if start_at_1) >= 1, and <= 255. None is always returned when no
 482     new object is created, otherwise the new object's ID.
 483     """
 484     min = 0 if start_at_1 else -32768
 485     max = 255 if start_at_1 else 32767
 486     if str == type(id):
 487         id = integer_test(id, min, max)
 488     if None != id:
 489         if id in world_db[category]:
 490             if id_store:
 491                 id_store.id = id
 492             return None
 493         else:
 494             if (start_at_1 and 0 == id) \
 495                or ((not start_at_1) and (id < 0 or id > 255)):
 496                 id = -1
 497                 while 1:
 498                     id = id + 1
 499                     if id not in world_db[category]:
 500                         break
 501                 if id > 255:
 502                     print("Ignoring: "
 503                           "No unused ID available to add to ID list.")
 504                     return None
 505             if id_store:
 506                 id_store.id = id
 507     return id
 508
 509
 510 def command_ping():
 511     """Send PONG line to server output file."""
 512     strong_write(io_db["file_out"], "PONG\n")
 513
 514
 515 def command_quit():
 516     """Abort server process."""
 517     raise SystemExit("received QUIT command")
 518
 519
 520 def command_thingshere(str_y, str_x):
 521     """Write to out file list of Things known to player at coordinate y, x."""
 522     def write_thing_if_here():
 523         if y == world_db["Things"][id]["T_POSY"] \
 524            and x == world_db["Things"][id]["T_POSX"]:
 525             type = world_db["Things"][id]["T_TYPE"]
 526             name = world_db["ThingTypes"][type]["TT_NAME"]
 527             strong_write(io_db["file_out"], name + "\n")
 528     if world_db["WORLD_ACTIVE"]:
 529         y = integer_test(str_y, 0, 255)
 530         x = integer_test(str_x, 0, 255)
 531         length = world_db["MAP_LENGTH"]
 532         if None != y and None != x and y < length and x < length:
 533             pos = (y * world_db["MAP_LENGTH"]) + x
 534             strong_write(io_db["file_out"], "THINGS_HERE START\n")
 535             if "v" == chr(world_db["Things"][0]["fovmap"][pos]):
 536                 for id in world_db["Things"]:
 537                     write_thing_if_here()
 538             else:
 539                 for id in world_db["Things"]["T_MEMTHING"]:
 540                     write_thing_if_here()
 541             strong_write(io_db["file_out"], "THINGS_HERE END\n")
 542         else:
 543             print("Ignoring: Invalid map coordinates.")
 544     else:
 545         print("Ignoring: Command only works on existing worlds.")
 546
 547
 548 def command_seedmap(seed_string):
 549     """Set world_db["SEED_MAP"] to int(seed_string), then (re-)make map."""
 550     setter(None, "SEED_MAP", 0, 4294967295)(seed_string)
 551     remake_map()
 552
 553
 554 def command_makeworld(seed_string):
 555     """(Re-)build game world, i.e. map, things, to a new turn 1 from seed.
 556
 557     Make seed world_db["SEED_RANDOMNESS"] and world_db["SEED_MAP"]. Do more
 558     only with a "wait" ThingAction and world["PLAYER_TYPE"] matching ThingType
 559     of TT_START_NUMBER > 0. Then, world_db["Things"] emptied, call remake_map()
 560     and set world_db["WORLD_ACTIVE"], world_db["TURN"] to 1. Build new Things
 561     according to ThingTypes' TT_START_NUMBERS, with Thing of ID 0 to ThingType
 562     of ID = world["PLAYER_TYPE"]. Place Things randomly, and actors not on each
 563     other. Init player's memory map. Write "NEW_WORLD" line to out file.
 564     """
 565     setter(None, "SEED_RANDOMNESS", 0, 4294967295)(seed_string)
 566     setter(None, "SEED_MAP", 0, 4294967295)(seed_string)
 567     player_will_be_generated = False
 568     playertype = world_db["PLAYER_TYPE"]
 569     for ThingType in world_db["ThingTypes"]:
 570         if playertype == ThingType:
 571             if 0 < world_db["ThingTypes"][ThingType]["TT_START_NUMBER"]:
 572                 player_will_be_generated = True
 573             break
 574     if not player_will_be_generated:
 575         print("Ignoring beyond SEED_MAP: " +
 576               "No player type with start number >0 defined.")
 577         return
 578     wait_action = False
 579     for ThingAction in world_db["ThingActions"]:
 580         if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
 581             wait_action = True
 582     if not wait_action:
 583         print("Ignoring beyond SEED_MAP: " +
 584               "No thing action with name 'wait' defined.")
 585         return
 586     world_db["Things"] = {}
 587     remake_map()
 588     world_db["WORLD_ACTIVE"] = 1
 589     world_db["TURN"] = 1
 590     for i in range(world_db["ThingTypes"][playertype]["TT_START_NUMBER"]):
 591         id = id_setter(-1, "Things")
 592         world_db["Things"][id] = new_Thing(playertype)
 593     # TODO: Positioning.
 594     update_map_memory(world_db["Things"][0])
 595     for type in world_db["ThingTypes"]:
 596         for i in range(world_db["ThingTypes"][type]["TT_START_NUMBER"]):
 597             if type != playertype:
 598                 id = id_setter(-1, "Things")
 599                 world_db["Things"][id] = new_Thing(type)
 600     # TODO: Positioning.
 601     strong_write(io_db["file_out"], "NEW_WORLD\n")
 602
 603
 604 def command_maplength(maplength_string):
 605     """Redefine map length. Invalidate map, therefore lose all things on it."""
 606     set_world_inactive()
 607     world_db["Things"] = {}
 608     setter(None, "MAP_LENGTH", 1, 256)(maplength_string)
 609
 610
 611 def command_worldactive(worldactive_string):
 612     """Toggle world_db["WORLD_ACTIVE"] if possible.
 613
 614     An active world can always be set inactive. An inactive world can only be
 615     set active with a "wait" ThingAction, and a player Thing (of ID 0). On
 616     activation, rebuild all Things' FOVs, and the player's map memory.
 617     """
 618     # In original version, map existence was also tested (unnecessarily?).
 619     val = integer_test(worldactive_string, 0, 1)
 620     if val:
 621         if 0 != world_db["WORLD_ACTIVE"]:
 622             if 0 == val:
 623                 set_world_inactive()
 624             else:
 625                 print("World already active.")
 626         elif 0 == world_db["WORLD_ACTIVE"]:
 627             wait_exists = False
 628             for ThingAction in world_db["ThingActions"]:
 629                 if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
 630                     wait_exists = True
 631                     break
 632             player_exists = False
 633             for Thing in world_db["Things"]:
 634                 if 0 == Thing:
 635                     player_exists = True
 636                     break
 637             if wait_exists and player_exists:
 638                 for id in world_db["Things"]:
 639                     if world_db["Things"][id]["T_LIFEPOINTS"]:
 640                         build_fov_map(world_db["Things"][id])
 641                         if 0 == id:
 642                             update_map_memory(world_db["Things"][id])
 643                 world_db["WORLD_ACTIVE"] = 1
 644
 645
 646 def test_for_id_maker(object, category):
 647     """Return decorator testing for object having "id" attribute."""
 648     def decorator(f):
 649         def helper(*args):
 650             if hasattr(object, "id"):
 651                 f(*args)
 652             else:
 653                 print("Ignoring: No " + category +
 654                       " defined to manipulate yet.")
 655         return helper
 656     return decorator
 657
 658
 659 def command_tid(id_string):
 660     """Set ID of Thing to manipulate. ID unused? Create new one.
 661
 662     Default new Thing's type to the first available ThingType, others: zero.
 663     """
 664     id = id_setter(id_string, "Things", command_tid)
 665     if None != id:
 666         if world_db["ThingTypes"] == {}:
 667             print("Ignoring: No ThingType to settle new Thing in.")
 668             return
 669         type = list(world_db["ThingTypes"].keys())[0]
 670         world_db["Things"][id] = new_Thing(type)
 671
 672
 673 test_Thing_id = test_for_id_maker(command_tid, "Thing")
 674
 675
 676 @test_Thing_id
 677 def command_tcommand(str_int):
 678     """Set T_COMMAND of selected Thing."""
 679     val = integer_test(str_int, 0, 255)
 680     if None != val:
 681         if 0 == val or val in world_db["ThingActions"]:
 682             world_db["Things"][command_tid.id]["T_COMMAND"] = val
 683         else:
 684             print("Ignoring: ThingAction ID belongs to no known ThingAction.")
 685
 686
 687 @test_Thing_id
 688 def command_ttype(str_int):
 689     """Set T_TYPE of selected Thing."""
 690     val = integer_test(str_int, 0, 255)
 691     if None != val:
 692         if val in world_db["ThingTypes"]:
 693             world_db["Things"][command_tid.id]["T_TYPE"] = val
 694         else:
 695             print("Ignoring: ThingType ID belongs to no known ThingType.")
 696
 697
 698 @test_Thing_id
 699 def command_tcarries(str_int):
 700     """Append int(str_int) to T_CARRIES of selected Thing.
 701
 702     The ID int(str_int) must not be of the selected Thing, and must belong to a
 703     Thing with unset "carried" flag. Its "carried" flag will be set on owning.
 704     """
 705     val = integer_test(str_int, 0, 255)
 706     if None != val:
 707         if val == command_tid.id:
 708             print("Ignoring: Thing cannot carry itself.")
 709         elif val in world_db["Things"] \
 710              and not world_db["Things"][val]["carried"]:
 711             world_db["Things"][command_tid.id]["T_CARRIES"].append(val)
 712             world_db["Things"][val]["carried"] = True
 713         else:
 714             print("Ignoring: Thing not available for carrying.")
 715     # Note that the whole carrying structure is different from the C version:
 716     # Carried-ness is marked by a "carried" flag, not by Things containing
 717     # Things internally.
 718
 719
 720 @test_Thing_id
 721 def command_tmemthing(str_t, str_y, str_x):
 722     """Add (int(str_t), int(str_y), int(str_x)) to selected Thing's T_MEMTHING.
 723
 724     The type must fit to an existing ThingType, and the position into the map.
 725     """
 726     type = integer_test(str_t, 0, 255)
 727     posy = integer_test(str_y, 0, 255)
 728     posx = integer_test(str_x, 0, 255)
 729     if None != type and None != posy and None != posx:
 730         if type not in world_db["ThingTypes"] \
 731            or posy >= world_db["MAP_LENGTH"] or posx >= world_db["MAP_LENGTH"]:
 732             print("Ignoring: Illegal value for thing type or position.")
 733         else:
 734             memthing = (type, posy, posx)
 735             world_db["Things"][command_tid.id]["T_MEMTHING"].append(memthing)
 736
 737
 738 def setter_map(maptype):
 739     """Set selected Thing's map of maptype's int(str_int)-th line to mapline.
 740
 741     If Thing has no map of maptype yet, initialize it with ' ' bytes first.
 742     """
 743     @test_Thing_id
 744     def helper(str_int, mapline):
 745         val = integer_test(str_int, 0, 255)
 746         if None != val:
 747             if val >= world_db["MAP_LENGTH"]:
 748                 print("Illegal value for map line number.")
 749             elif len(mapline) != world_db["MAP_LENGTH"]:
 750                 print("Map line length is unequal map width.")
 751             else:
 752                 length = world_db["MAP_LENGTH"]
 753                 map = None
 754                 if not world_db["Things"][command_tid.id][maptype]:
 755                     map = bytearray(b' ' * (length ** 2))
 756                 else:
 757                     map = world_db["Things"][command_tid.id][maptype]
 758                 map[val * length:(val * length) + length] = mapline.encode()
 759                 world_db["Things"][command_tid.id][maptype] = map
 760     return helper
 761
 762
 763 def setter_tpos(axis):
 764     """Generate setter for T_POSX or  T_POSY of selected Thing.
 765
 766     If world is active, rebuilds animate things' fovmap, player's memory map.
 767     """
 768     @test_Thing_id
 769     def helper(str_int):
 770         val = integer_test(str_int, 0, 255)
 771         if None != val:
 772             if val < world_db["MAP_LENGTH"]:
 773                 world_db["Things"][command_tid.id]["T_POS" + axis] = val
 774                 if world_db["WORLD_ACTIVE"] \
 775                    and world_db["Things"][command_tid.id]["T_LIFEPOINTS"]:
 776                     build_fov_map(world_db["Things"][command_tid.id])
 777                     if 0 == command_tid.id:
 778                         update_map_memory(world_db["Things"][command_tid.id])
 779             else:
 780                 print("Ignoring: Position is outside of map.")
 781     return helper
 782
 783
 784 def command_ttid(id_string):
 785     """Set ID of ThingType to manipulate. ID unused? Create new one.
 786
 787     Default new ThingType's TT_SYMBOL to "?", TT_CORPSE_ID to self, others: 0.
 788     """
 789     id = id_setter(id_string, "ThingTypes", command_ttid)
 790     if None != id:
 791         world_db["ThingTypes"][id] = {
 792             "TT_NAME": "(none)",
 793             "TT_CONSUMABLE": 0,
 794             "TT_LIFEPOINTS": 0,
 795             "TT_PROLIFERATE": 0,
 796             "TT_START_NUMBER": 0,
 797             "TT_SYMBOL": "?",
 798             "TT_CORPSE_ID": id
 799         }
 800
 801
 802 test_ThingType_id = test_for_id_maker(command_ttid, "ThingType")
 803
 804
 805 @test_ThingType_id
 806 def command_ttname(name):
 807     """Set TT_NAME of selected ThingType."""
 808     world_db["ThingTypes"][command_ttid.id]["TT_NAME"] = name
 809
 810
 811 @test_ThingType_id
 812 def command_ttsymbol(char):
 813     """Set TT_SYMBOL of selected ThingType. """
 814     if 1 == len(char):
 815         world_db["ThingTypes"][command_ttid.id]["TT_SYMBOL"] = char
 816     else:
 817         print("Ignoring: Argument must be single character.")
 818
 819
 820 @test_ThingType_id
 821 def command_ttcorpseid(str_int):
 822     """Set TT_CORPSE_ID of selected ThingType."""
 823     val = integer_test(str_int, 0, 255)
 824     if None != val:
 825         if val in world_db["ThingTypes"]:
 826             world_db["ThingTypes"][command_ttid.id]["TT_CORPSE_ID"] = val
 827         else:
 828             print("Ignoring: Corpse ID belongs to no known ThignType.")
 829
 830
 831 def command_taid(id_string):
 832     """Set ID of ThingAction to manipulate. ID unused? Create new one.
 833
 834     Default new ThingAction's TA_EFFORT to 1, its TA_NAME to "wait".
 835     """
 836     id = id_setter(id_string, "ThingActions", command_taid, True)
 837     if None != id:
 838         world_db["ThingActions"][id] = {
 839             "TA_EFFORT": 1,
 840             "TA_NAME": "wait"
 841         }
 842
 843
 844 test_ThingAction_id = test_for_id_maker(command_taid, "ThingAction")
 845
 846
 847 @test_ThingAction_id
 848 def command_taname(name):
 849     """Set TA_NAME of selected ThingAction.
 850
 851     The name must match a valid thing action function. If after the name
 852     setting no ThingAction with name "wait" remains, call set_world_inactive().
 853     """
 854     if name == "wait" or name == "move" or name == "use" or name == "drop" \
 855        or name == "pick_up":
 856         world_db["ThingActions"][command_taid.id]["TA_NAME"] = name
 857         if 1 == world_db["WORLD_ACTIVE"]:
 858             wait_defined = False
 859             for id in world_db["ThingActions"]:
 860                 if "wait" == world_db["ThingActions"][id]["TA_NAME"]:
 861                     wait_defined = True
 862                     break
 863             if not wait_defined:
 864                 set_world_inactive()
 865     else:
 866         print("Ignoring: Invalid action name.")
 867     # In contrast to the original,naming won't map a function to a ThingAction.
 868
 869
 870 """Commands database.
 871
 872 Map command start tokens to ([0]) number of expected command arguments, ([1])
 873 the command's meta-ness (i.e. is it to be written to the record file, is it to
 874 be ignored in replay mode if read from server input file), and ([2]) a function
 875 to be called on it.
 876 """
 877 commands_db = {
 878     "QUIT": (0, True, command_quit),
 879     "PING": (0, True, command_ping),
 880     "THINGS_HERE": (2, True, command_thingshere),
 881     "MAKE_WORLD": (1, False, command_makeworld),
 882     "SEED_MAP": (1, False, command_seedmap),
 883     "SEED_RANDOMNESS": (1, False, setter(None, "SEED_RANDOMNESS",
 884                                          0, 4294967295)),
 885     "TURN": (1, False, setter(None, "TURN", 0, 65535)),
 886     "PLAYER_TYPE": (1, False, setter(None, "PLAYER_TYPE", 0, 255)),
 887     "MAP_LENGTH": (1, False, command_maplength),
 888     "WORLD_ACTIVE": (1, False, command_worldactive),
 889     "TA_ID": (1, False, command_taid),
 890     "TA_EFFORT": (1, False, setter("ThingAction", "TA_EFFORT", 0, 255)),
 891     "TA_NAME": (1, False, command_taname),
 892     "TT_ID": (1, False, command_ttid),
 893     "TT_NAME": (1, False, command_ttname),
 894     "TT_SYMBOL": (1, False, command_ttsymbol),
 895     "TT_CORPSE_ID": (1, False, command_ttcorpseid),
 896     "TT_CONSUMABLE": (1, False, setter("ThingType", "TT_CONSUMABLE",
 897                                        0, 65535)),
 898     "TT_START_NUMBER": (1, False, setter("ThingType", "TT_START_NUMBER",
 899                                          0, 255)),
 900     "TT_PROLIFERATE": (1, False, setter("ThingType", "TT_PROLIFERATE",
 901                                         0, 255)),
 902     "TT_LIFEPOINTS": (1, False, setter("ThingType", "TT_LIFEPOINTS", 0, 255)),
 903     "T_ID": (1, False, command_tid),
 904     "T_ARGUMENT": (1, False, setter("Thing", "T_ARGUMENT", 0, 255)),
 905     "T_PROGRESS": (1, False, setter("Thing", "T_PROGRESS", 0, 255)),
 906     "T_LIFEPOINTS": (1, False, setter("Thing", "T_LIFEPOINTS", 0, 255)),
 907     "T_SATIATION": (1, False, setter("Thing", "T_SATIATION", -32768, 32767)),
 908     "T_COMMAND": (1, False, command_tcommand),
 909     "T_TYPE": (1, False, command_ttype),
 910     "T_CARRIES": (1, False, command_tcarries),
 911     "T_MEMMAP": (2, False, setter_map("T_MEMMAP")),
 912     "T_MEMDEPTHMAP": (2, False, setter_map("T_MEMDEPTHMAP")),
 913     "T_MEMTHING": (3, False, command_tmemthing),
 914     "T_POSY": (1, False, setter_tpos("Y")),
 915     "T_POSX": (1, False, setter_tpos("X")),
 916 }
 917
 918
 919 """World state database. With sane default values."""
 920 world_db = {
 921     "TURN": 0,
 922     "SEED_MAP": 0,
 923     "SEED_RANDOMNESS": 0,
 924     "PLAYER_TYPE": 0,
 925     "MAP_LENGTH": 64,
 926     "WORLD_ACTIVE": 0,
 927     "ThingActions": {},
 928     "ThingTypes": {},
 929     "Things": {}
 930 }
 931
 932
 933 """File IO database."""
 934 io_db = {
 935     "path_save": "save",
 936     "path_record": "record",
 937     "path_worldconf": "confserver/world",
 938     "path_server": "server/",
 939     "path_in": "server/in",
 940     "path_out": "server/out",
 941     "path_worldstate": "server/worldstate",
 942     "tmp_suffix": "_tmp",
 943     "kicked_by_rival": False,
 944     "worldstate_updateable": False
 945 }
 946
 947
 948 try:
 949     opts = parse_command_line_arguments()
 950     setup_server_io()
 951     if None != opts.replay:
 952         replay_game()
 953     else:
 954         play_game()
 955 except SystemExit as exit:
 956     print("ABORTING: " + exit.args[0])
 957 except:
 958     print("SOMETHING WENT WRONG IN UNEXPECTED WAYS")
 959     raise
 960 finally:
 961     cleanup_server_io()