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 memthing in t["T_MEMTHING"]:
 386         y = world_db["Things"][memthing[0]]["T_POSY"]
 387         x = world_db["Things"][memthing[1]]["T_POSY"]
 388         if "v" == chr(t["fovmap"][(y * world_db["MAP_LENGTH"]) + x]):
 389             t["T_MEMTHING"].remove(memthing)
 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 actor_wait(t):
 453     """Make t do nothing (but loudly, if player avatar)."""
 454     if t == world_db["Things"][0]:
 455         strong_write(io_db["file_out"], "LOG You wait.\n")
 456
 457
 458 def actor_move(Thing):
 459     pass
 460
 461
 462 def actor_pick_up(t):
 463     """Make t pick up (topmost?) Thing from ground into inventory."""
 464     # Topmostness is actually not defined so far.
 465     ids = [id for id in world_db["Things"] if world_db["Things"][id] != t
 466            if not world_db["Things"][id]["carried"]
 467            if world_db["Things"][id]["T_POSY"] == t["T_POSY"]
 468            if world_db["Things"][id]["T_POSX"] == t["T_POSX"]]
 469     if len(ids):
 470         world_db["Things"][ids[0]]["carried"] = True
 471         t["T_CARRIES"].append(ids[0])
 472         if t == world_db["Things"][0]:
 473             strong_write(io_db["file_out"], "LOG You pick up an object.\n")
 474     elif t == world_db["Things"][0]:
 475         err = "You try to pick up an object, but there is none."
 476         strong_write(io_db["file_out"], "LOG " + err + "\n")
 477
 478
 479 def actor_drop(t):
 480     """Make t rop Thing from inventory to ground indexed by T_ARGUMENT."""
 481     # TODO: Handle case where T_ARGUMENT matches nothing.
 482     if len(t["T_CARRIES"]):
 483         id = t["T_CARRIES"][t["T_ARGUMENT"]]
 484         t["T_CARRIES"].remove(id)
 485         world_db["Things"][id]["carried"] = False
 486         if t == world_db["Things"][0]:
 487             print("You drop an object.")
 488     elif t == world_db["Things"][0]:
 489         print("You try to drop an object, but you own none.")
 490
 491
 492 def actor_use(Thing):
 493     pass
 494
 495
 496 def turn_over():
 497     """Run game world and its inhabitants until new player input expected."""
 498     id = 0
 499     whilebreaker = False
 500     while world_db["Things"][0]["T_LIFEPOINTS"]:
 501         for id in [id for id in world_db["Things"]
 502                    if world_db["Things"][id]["T_LIFEPOINTS"]]:
 503             Thing = world_db["Things"][id]
 504             if Thing["T_LIFEPOINTS"]:
 505                 if not Thing["T_COMMAND"]:
 506                     update_map_memory(Thing)
 507                     if 0 == id:
 508                         whilebreaker = True
 509                         break
 510                     # DUMMY: ai(thing)
 511                     Thing["T_COMMAND"] = 1
 512                 # DUMMY: try_healing
 513                 Thing["T_PROGRESS"] += 1
 514                 taid = [a for a in world_db["ThingActions"]
 515                           if a == Thing["T_COMMAND"]][0]
 516                 ThingAction = world_db["ThingActions"][taid]
 517                 if Thing["T_PROGRESS"] == ThingAction["TA_EFFORT"]:
 518                     eval("actor_" + ThingAction["TA_NAME"])(Thing)
 519                     Thing["T_COMMAND"] = 0
 520                     Thing["T_PROGRESS"] = 0
 521                 # DUMMY: hunger
 522             # DUMMY: thingproliferation
 523         if whilebreaker:
 524             break
 525         world_db["TURN"] += 1
 526
 527
 528 def new_Thing(type):
 529     """Return Thing of type T_TYPE, with fovmap if alive and world active."""
 530     thing = {
 531         "T_LIFEPOINTS": world_db["ThingTypes"][type]["TT_LIFEPOINTS"],
 532         "T_ARGUMENT": 0,
 533         "T_PROGRESS": 0,
 534         "T_SATIATION": 0,
 535         "T_COMMAND": 0,
 536         "T_TYPE": type,
 537         "T_POSY": 0,
 538         "T_POSX": 0,
 539         "T_CARRIES": [],
 540         "carried": False,
 541         "T_MEMTHING": [],
 542         "T_MEMMAP": False,
 543         "T_MEMDEPTHMAP": False,
 544         "fovmap": False
 545     }
 546     if world_db["WORLD_ACTIVE"] and thing["T_LIFEPOINTS"]:
 547         build_fov_map(thing)
 548     return thing
 549
 550
 551 def id_setter(id, category, id_store=False, start_at_1=False):
 552     """Set ID of object of category to manipulate ID unused? Create new one.
 553
 554     The ID is stored as id_store.id (if id_store is set). If the integer of the
 555     input is valid (if start_at_1, >= 0 and <= 255, else >= -32768 and <=
 556     32767), but <0 or (if start_at_1) <1, calculate new ID: lowest unused ID
 557     >=0 or (if start_at_1) >= 1, and <= 255. None is always returned when no
 558     new object is created, otherwise the new object's ID.
 559     """
 560     min = 0 if start_at_1 else -32768
 561     max = 255 if start_at_1 else 32767
 562     if str == type(id):
 563         id = integer_test(id, min, max)
 564     if None != id:
 565         if id in world_db[category]:
 566             if id_store:
 567                 id_store.id = id
 568             return None
 569         else:
 570             if (start_at_1 and 0 == id) \
 571                or ((not start_at_1) and (id < 0 or id > 255)):
 572                 id = -1
 573                 while 1:
 574                     id = id + 1
 575                     if id not in world_db[category]:
 576                         break
 577                 if id > 255:
 578                     print("Ignoring: "
 579                           "No unused ID available to add to ID list.")
 580                     return None
 581             if id_store:
 582                 id_store.id = id
 583     return id
 584
 585
 586 def command_ping():
 587     """Send PONG line to server output file."""
 588     strong_write(io_db["file_out"], "PONG\n")
 589
 590
 591 def command_quit():
 592     """Abort server process."""
 593     raise SystemExit("received QUIT command")
 594
 595
 596 def command_thingshere(str_y, str_x):
 597     """Write to out file list of Things known to player at coordinate y, x."""
 598     def write_thing_if_here():
 599         if y == world_db["Things"][id]["T_POSY"] \
 600            and x == world_db["Things"][id]["T_POSX"] \
 601            and not world_db["Things"][id]["carried"]:
 602             type = world_db["Things"][id]["T_TYPE"]
 603             name = world_db["ThingTypes"][type]["TT_NAME"]
 604             strong_write(io_db["file_out"], name + "\n")
 605     if world_db["WORLD_ACTIVE"]:
 606         y = integer_test(str_y, 0, 255)
 607         x = integer_test(str_x, 0, 255)
 608         length = world_db["MAP_LENGTH"]
 609         if None != y and None != x and y < length and x < length:
 610             pos = (y * world_db["MAP_LENGTH"]) + x
 611             strong_write(io_db["file_out"], "THINGS_HERE START\n")
 612             if "v" == chr(world_db["Things"][0]["fovmap"][pos]):
 613                 for id in world_db["Things"]:
 614                     write_thing_if_here()
 615             else:
 616                 for id in world_db["Things"]["T_MEMTHING"]:
 617                     write_thing_if_here()
 618             strong_write(io_db["file_out"], "THINGS_HERE END\n")
 619         else:
 620             print("Ignoring: Invalid map coordinates.")
 621     else:
 622         print("Ignoring: Command only works on existing worlds.")
 623
 624
 625 def play_commander(action, args=False):
 626     """Setter for player's T_COMMAND and T_ARGUMENT, then calling turn_over().
 627
 628     T_ARGUMENT is set to direction char if action=="wait",or 8-bit int if args.
 629     """
 630
 631     def set_command():
 632         id = [x for x in world_db["ThingActions"]
 633                 if world_db["ThingActions"][x]["TA_NAME"] == action][0]
 634         world_db["Things"][0]["T_COMMAND"] = id
 635         turn_over()
 636         # TODO: call turn_over()
 637
 638     def set_command_and_argument_int(str_arg):
 639         val = integer_test(str_arg, 0, 255)
 640         if None != val:
 641             world_db["Things"][0]["T_ARGUMENT"] = val
 642             set_command()
 643         else:
 644             print("Ignoring: Argument must be integer >= 0 <=255.")
 645
 646     def set_command_and_argument_movestring(str_arg):
 647         dirs = {"east": "d", "south-east": "c", "south-west": "x",
 648                 "west": "s", "north-west": "w", "north-east": "e"}
 649         if str_arg in dirs:
 650             world_db["Things"][0]["T_ARGUMENT"] = dirs[str_arg]
 651             set_command()
 652         else:
 653             print("Ignoring: Argument must be valid direction string.")
 654
 655     if action == "move":
 656         return set_command_and_argument_movestring
 657     elif args:
 658         return set_command_and_argument_int
 659     else:
 660         return set_command
 661
 662
 663 def command_seedmap(seed_string):
 664     """Set world_db["SEED_MAP"] to int(seed_string), then (re-)make map."""
 665     setter(None, "SEED_MAP", 0, 4294967295)(seed_string)
 666     remake_map()
 667
 668
 669 def command_makeworld(seed_string):
 670     """(Re-)build game world, i.e. map, things, to a new turn 1 from seed.
 671
 672     Make seed world_db["SEED_RANDOMNESS"] and world_db["SEED_MAP"]. Do more
 673     only with a "wait" ThingAction and world["PLAYER_TYPE"] matching ThingType
 674     of TT_START_NUMBER > 0. Then, world_db["Things"] emptied, call remake_map()
 675     and set world_db["WORLD_ACTIVE"], world_db["TURN"] to 1. Build new Things
 676     according to ThingTypes' TT_START_NUMBERS, with Thing of ID 0 to ThingType
 677     of ID = world["PLAYER_TYPE"]. Place Things randomly, and actors not on each
 678     other. Init player's memory map. Write "NEW_WORLD" line to out file.
 679     """
 680     setter(None, "SEED_RANDOMNESS", 0, 4294967295)(seed_string)
 681     setter(None, "SEED_MAP", 0, 4294967295)(seed_string)
 682     player_will_be_generated = False
 683     playertype = world_db["PLAYER_TYPE"]
 684     for ThingType in world_db["ThingTypes"]:
 685         if playertype == ThingType:
 686             if 0 < world_db["ThingTypes"][ThingType]["TT_START_NUMBER"]:
 687                 player_will_be_generated = True
 688             break
 689     if not player_will_be_generated:
 690         print("Ignoring beyond SEED_MAP: " +
 691               "No player type with start number >0 defined.")
 692         return
 693     wait_action = False
 694     for ThingAction in world_db["ThingActions"]:
 695         if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
 696             wait_action = True
 697     if not wait_action:
 698         print("Ignoring beyond SEED_MAP: " +
 699               "No thing action with name 'wait' defined.")
 700         return
 701     world_db["Things"] = {}
 702     remake_map()
 703     world_db["WORLD_ACTIVE"] = 1
 704     world_db["TURN"] = 1
 705     for i in range(world_db["ThingTypes"][playertype]["TT_START_NUMBER"]):
 706         id = id_setter(-1, "Things")
 707         world_db["Things"][id] = new_Thing(playertype)
 708     # TODO: Positioning.
 709     update_map_memory(world_db["Things"][0])
 710     for type in world_db["ThingTypes"]:
 711         for i in range(world_db["ThingTypes"][type]["TT_START_NUMBER"]):
 712             if type != playertype:
 713                 id = id_setter(-1, "Things")
 714                 world_db["Things"][id] = new_Thing(type)
 715     # TODO: Positioning.
 716     strong_write(io_db["file_out"], "NEW_WORLD\n")
 717
 718
 719 def command_maplength(maplength_string):
 720     """Redefine map length. Invalidate map, therefore lose all things on it."""
 721     set_world_inactive()
 722     world_db["Things"] = {}
 723     setter(None, "MAP_LENGTH", 1, 256)(maplength_string)
 724
 725
 726 def command_worldactive(worldactive_string):
 727     """Toggle world_db["WORLD_ACTIVE"] if possible.
 728
 729     An active world can always be set inactive. An inactive world can only be
 730     set active with a "wait" ThingAction, and a player Thing (of ID 0). On
 731     activation, rebuild all Things' FOVs, and the player's map memory.
 732     """
 733     # In original version, map existence was also tested (unnecessarily?).
 734     val = integer_test(worldactive_string, 0, 1)
 735     if val:
 736         if 0 != world_db["WORLD_ACTIVE"]:
 737             if 0 == val:
 738                 set_world_inactive()
 739             else:
 740                 print("World already active.")
 741         elif 0 == world_db["WORLD_ACTIVE"]:
 742             wait_exists = False
 743             for ThingAction in world_db["ThingActions"]:
 744                 if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
 745                     wait_exists = True
 746                     break
 747             player_exists = False
 748             for Thing in world_db["Things"]:
 749                 if 0 == Thing:
 750                     player_exists = True
 751                     break
 752             if wait_exists and player_exists:
 753                 for id in world_db["Things"]:
 754                     if world_db["Things"][id]["T_LIFEPOINTS"]:
 755                         build_fov_map(world_db["Things"][id])
 756                         if 0 == id:
 757                             update_map_memory(world_db["Things"][id])
 758                 world_db["WORLD_ACTIVE"] = 1
 759
 760
 761 def test_for_id_maker(object, category):
 762     """Return decorator testing for object having "id" attribute."""
 763     def decorator(f):
 764         def helper(*args):
 765             if hasattr(object, "id"):
 766                 f(*args)
 767             else:
 768                 print("Ignoring: No " + category +
 769                       " defined to manipulate yet.")
 770         return helper
 771     return decorator
 772
 773
 774 def command_tid(id_string):
 775     """Set ID of Thing to manipulate. ID unused? Create new one.
 776
 777     Default new Thing's type to the first available ThingType, others: zero.
 778     """
 779     id = id_setter(id_string, "Things", command_tid)
 780     if None != id:
 781         if world_db["ThingTypes"] == {}:
 782             print("Ignoring: No ThingType to settle new Thing in.")
 783             return
 784         type = list(world_db["ThingTypes"].keys())[0]
 785         world_db["Things"][id] = new_Thing(type)
 786
 787
 788 test_Thing_id = test_for_id_maker(command_tid, "Thing")
 789
 790
 791 @test_Thing_id
 792 def command_tcommand(str_int):
 793     """Set T_COMMAND of selected Thing."""
 794     val = integer_test(str_int, 0, 255)
 795     if None != val:
 796         if 0 == val or val in world_db["ThingActions"]:
 797             world_db["Things"][command_tid.id]["T_COMMAND"] = val
 798         else:
 799             print("Ignoring: ThingAction ID belongs to no known ThingAction.")
 800
 801
 802 @test_Thing_id
 803 def command_ttype(str_int):
 804     """Set T_TYPE of selected Thing."""
 805     val = integer_test(str_int, 0, 255)
 806     if None != val:
 807         if val in world_db["ThingTypes"]:
 808             world_db["Things"][command_tid.id]["T_TYPE"] = val
 809         else:
 810             print("Ignoring: ThingType ID belongs to no known ThingType.")
 811
 812
 813 @test_Thing_id
 814 def command_tcarries(str_int):
 815     """Append int(str_int) to T_CARRIES of selected Thing.
 816
 817     The ID int(str_int) must not be of the selected Thing, and must belong to a
 818     Thing with unset "carried" flag. Its "carried" flag will be set on owning.
 819     """
 820     val = integer_test(str_int, 0, 255)
 821     if None != val:
 822         if val == command_tid.id:
 823             print("Ignoring: Thing cannot carry itself.")
 824         elif val in world_db["Things"] \
 825              and not world_db["Things"][val]["carried"]:
 826             world_db["Things"][command_tid.id]["T_CARRIES"].append(val)
 827             world_db["Things"][val]["carried"] = True
 828         else:
 829             print("Ignoring: Thing not available for carrying.")
 830     # Note that the whole carrying structure is different from the C version:
 831     # Carried-ness is marked by a "carried" flag, not by Things containing
 832     # Things internally.
 833
 834
 835 @test_Thing_id
 836 def command_tmemthing(str_t, str_y, str_x):
 837     """Add (int(str_t), int(str_y), int(str_x)) to selected Thing's T_MEMTHING.
 838
 839     The type must fit to an existing ThingType, and the position into the map.
 840     """
 841     type = integer_test(str_t, 0, 255)
 842     posy = integer_test(str_y, 0, 255)
 843     posx = integer_test(str_x, 0, 255)
 844     if None != type and None != posy and None != posx:
 845         if type not in world_db["ThingTypes"] \
 846            or posy >= world_db["MAP_LENGTH"] or posx >= world_db["MAP_LENGTH"]:
 847             print("Ignoring: Illegal value for thing type or position.")
 848         else:
 849             memthing = (type, posy, posx)
 850             world_db["Things"][command_tid.id]["T_MEMTHING"].append(memthing)
 851
 852
 853 def setter_map(maptype):
 854     """Set selected Thing's map of maptype's int(str_int)-th line to mapline.
 855
 856     If Thing has no map of maptype yet, initialize it with ' ' bytes first.
 857     """
 858     @test_Thing_id
 859     def helper(str_int, mapline):
 860         val = integer_test(str_int, 0, 255)
 861         if None != val:
 862             if val >= world_db["MAP_LENGTH"]:
 863                 print("Illegal value for map line number.")
 864             elif len(mapline) != world_db["MAP_LENGTH"]:
 865                 print("Map line length is unequal map width.")
 866             else:
 867                 length = world_db["MAP_LENGTH"]
 868                 map = None
 869                 if not world_db["Things"][command_tid.id][maptype]:
 870                     map = bytearray(b' ' * (length ** 2))
 871                 else:
 872                     map = world_db["Things"][command_tid.id][maptype]
 873                 map[val * length:(val * length) + length] = mapline.encode()
 874                 world_db["Things"][command_tid.id][maptype] = map
 875     return helper
 876
 877
 878 def setter_tpos(axis):
 879     """Generate setter for T_POSX or  T_POSY of selected Thing.
 880
 881     If world is active, rebuilds animate things' fovmap, player's memory map.
 882     """
 883     @test_Thing_id
 884     def helper(str_int):
 885         val = integer_test(str_int, 0, 255)
 886         if None != val:
 887             if val < world_db["MAP_LENGTH"]:
 888                 world_db["Things"][command_tid.id]["T_POS" + axis] = val
 889                 if world_db["WORLD_ACTIVE"] \
 890                    and world_db["Things"][command_tid.id]["T_LIFEPOINTS"]:
 891                     build_fov_map(world_db["Things"][command_tid.id])
 892                     if 0 == command_tid.id:
 893                         update_map_memory(world_db["Things"][command_tid.id])
 894             else:
 895                 print("Ignoring: Position is outside of map.")
 896     return helper
 897
 898
 899 def command_ttid(id_string):
 900     """Set ID of ThingType to manipulate. ID unused? Create new one.
 901
 902     Default new ThingType's TT_SYMBOL to "?", TT_CORPSE_ID to self, others: 0.
 903     """
 904     id = id_setter(id_string, "ThingTypes", command_ttid)
 905     if None != id:
 906         world_db["ThingTypes"][id] = {
 907             "TT_NAME": "(none)",
 908             "TT_CONSUMABLE": 0,
 909             "TT_LIFEPOINTS": 0,
 910             "TT_PROLIFERATE": 0,
 911             "TT_START_NUMBER": 0,
 912             "TT_SYMBOL": "?",
 913             "TT_CORPSE_ID": id
 914         }
 915
 916
 917 test_ThingType_id = test_for_id_maker(command_ttid, "ThingType")
 918
 919
 920 @test_ThingType_id
 921 def command_ttname(name):
 922     """Set TT_NAME of selected ThingType."""
 923     world_db["ThingTypes"][command_ttid.id]["TT_NAME"] = name
 924
 925
 926 @test_ThingType_id
 927 def command_ttsymbol(char):
 928     """Set TT_SYMBOL of selected ThingType. """
 929     if 1 == len(char):
 930         world_db["ThingTypes"][command_ttid.id]["TT_SYMBOL"] = char
 931     else:
 932         print("Ignoring: Argument must be single character.")
 933
 934
 935 @test_ThingType_id
 936 def command_ttcorpseid(str_int):
 937     """Set TT_CORPSE_ID of selected ThingType."""
 938     val = integer_test(str_int, 0, 255)
 939     if None != val:
 940         if val in world_db["ThingTypes"]:
 941             world_db["ThingTypes"][command_ttid.id]["TT_CORPSE_ID"] = val
 942         else:
 943             print("Ignoring: Corpse ID belongs to no known ThignType.")
 944
 945
 946 def command_taid(id_string):
 947     """Set ID of ThingAction to manipulate. ID unused? Create new one.
 948
 949     Default new ThingAction's TA_EFFORT to 1, its TA_NAME to "wait".
 950     """
 951     id = id_setter(id_string, "ThingActions", command_taid, True)
 952     if None != id:
 953         world_db["ThingActions"][id] = {
 954             "TA_EFFORT": 1,
 955             "TA_NAME": "wait"
 956         }
 957
 958
 959 test_ThingAction_id = test_for_id_maker(command_taid, "ThingAction")
 960
 961
 962 @test_ThingAction_id
 963 def command_taname(name):
 964     """Set TA_NAME of selected ThingAction.
 965
 966     The name must match a valid thing action function. If after the name
 967     setting no ThingAction with name "wait" remains, call set_world_inactive().
 968     """
 969     if name == "wait" or name == "move" or name == "use" or name == "drop" \
 970        or name == "pick_up":
 971         world_db["ThingActions"][command_taid.id]["TA_NAME"] = name
 972         if 1 == world_db["WORLD_ACTIVE"]:
 973             wait_defined = False
 974             for id in world_db["ThingActions"]:
 975                 if "wait" == world_db["ThingActions"][id]["TA_NAME"]:
 976                     wait_defined = True
 977                     break
 978             if not wait_defined:
 979                 set_world_inactive()
 980     else:
 981         print("Ignoring: Invalid action name.")
 982     # In contrast to the original,naming won't map a function to a ThingAction.
 983
 984
 985 """Commands database.
 986
 987 Map command start tokens to ([0]) number of expected command arguments, ([1])
 988 the command's meta-ness (i.e. is it to be written to the record file, is it to
 989 be ignored in replay mode if read from server input file), and ([2]) a function
 990 to be called on it.
 991 """
 992 commands_db = {
 993     "QUIT": (0, True, command_quit),
 994     "PING": (0, True, command_ping),
 995     "THINGS_HERE": (2, True, command_thingshere),
 996     "MAKE_WORLD": (1, False, command_makeworld),
 997     "SEED_MAP": (1, False, command_seedmap),
 998     "SEED_RANDOMNESS": (1, False, setter(None, "SEED_RANDOMNESS",
 999                                          0, 4294967295)),
1000     "TURN": (1, False, setter(None, "TURN", 0, 65535)),
1001     "PLAYER_TYPE": (1, False, setter(None, "PLAYER_TYPE", 0, 255)),
1002     "MAP_LENGTH": (1, False, command_maplength),
1003     "WORLD_ACTIVE": (1, False, command_worldactive),
1004     "TA_ID": (1, False, command_taid),
1005     "TA_EFFORT": (1, False, setter("ThingAction", "TA_EFFORT", 0, 255)),
1006     "TA_NAME": (1, False, command_taname),
1007     "TT_ID": (1, False, command_ttid),
1008     "TT_NAME": (1, False, command_ttname),
1009     "TT_SYMBOL": (1, False, command_ttsymbol),
1010     "TT_CORPSE_ID": (1, False, command_ttcorpseid),
1011     "TT_CONSUMABLE": (1, False, setter("ThingType", "TT_CONSUMABLE",
1012                                        0, 65535)),
1013     "TT_START_NUMBER": (1, False, setter("ThingType", "TT_START_NUMBER",
1014                                          0, 255)),
1015     "TT_PROLIFERATE": (1, False, setter("ThingType", "TT_PROLIFERATE",
1016                                         0, 255)),
1017     "TT_LIFEPOINTS": (1, False, setter("ThingType", "TT_LIFEPOINTS", 0, 255)),
1018     "T_ID": (1, False, command_tid),
1019     "T_ARGUMENT": (1, False, setter("Thing", "T_ARGUMENT", 0, 255)),
1020     "T_PROGRESS": (1, False, setter("Thing", "T_PROGRESS", 0, 255)),
1021     "T_LIFEPOINTS": (1, False, setter("Thing", "T_LIFEPOINTS", 0, 255)),
1022     "T_SATIATION": (1, False, setter("Thing", "T_SATIATION", -32768, 32767)),
1023     "T_COMMAND": (1, False, command_tcommand),
1024     "T_TYPE": (1, False, command_ttype),
1025     "T_CARRIES": (1, False, command_tcarries),
1026     "T_MEMMAP": (2, False, setter_map("T_MEMMAP")),
1027     "T_MEMDEPTHMAP": (2, False, setter_map("T_MEMDEPTHMAP")),
1028     "T_MEMTHING": (3, False, command_tmemthing),
1029     "T_POSY": (1, False, setter_tpos("Y")),
1030     "T_POSX": (1, False, setter_tpos("X")),
1031     "wait": (0, False, play_commander("wait")),
1032     "move": (1, False, play_commander("move")),
1033     "pick_up": (0, False, play_commander("pick_up")),
1034     "drop": (1, False, play_commander("drop", True)),
1035     "use": (1, False, play_commander("use", True)),
1036 }
1037
1038
1039 """World state database. With sane default values."""
1040 world_db = {
1041     "TURN": 0,
1042     "SEED_MAP": 0,
1043     "SEED_RANDOMNESS": 0,
1044     "PLAYER_TYPE": 0,
1045     "MAP_LENGTH": 64,
1046     "WORLD_ACTIVE": 0,
1047     "ThingActions": {},
1048     "ThingTypes": {},
1049     "Things": {}
1050 }
1051
1052
1053 """File IO database."""
1054 io_db = {
1055     "path_save": "save",
1056     "path_record": "record",
1057     "path_worldconf": "confserver/world",
1058     "path_server": "server/",
1059     "path_in": "server/in",
1060     "path_out": "server/out",
1061     "path_worldstate": "server/worldstate",
1062     "tmp_suffix": "_tmp",
1063     "kicked_by_rival": False,
1064     "worldstate_updateable": False
1065 }
1066
1067
1068 try:
1069     opts = parse_command_line_arguments()
1070     setup_server_io()
1071     if None != opts.replay:
1072         replay_game()
1073     else:
1074         play_game()
1075 except SystemExit as exit:
1076     print("ABORTING: " + exit.args[0])
1077 except:
1078     print("SOMETHING WENT WRONG IN UNEXPECTED WAYS")
1079     raise
1080 finally:
1081     cleanup_server_io()