home · contact · privacy
Add log_help(), short usage info set to log on server start.
[plomrogue] / roguelike-server
1 #!/usr/bin/python3
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 import argparse
9 import errno
10 import os
11 import shlex
12 import shutil
13 import time
14 import ctypes
15
16
17 class RandomnessIO:
18     """"Interface to libplomrogue's pseudo-randomness generator."""
19
20     def set_seed(self, seed):
21         libpr.seed_rrand(1, seed)
22
23     def get_seed(self):
24         return libpr.seed_rrand(0, 0)
25
26     def next(self):
27         return libpr.rrand()
28
29     seed = property(get_seed, set_seed)
30
31
32 def prep_library():
33     """Prepare ctypes library at ./libplomrogue.so"""
34     libpath = ("./libplomrogue.so")
35     if not os.access(libpath, os.F_OK):
36         raise SystemExit("No library " + libpath + ", run ./redo first?")
37     libpr = ctypes.cdll.LoadLibrary(libpath)
38     libpr.seed_rrand.restype = ctypes.c_uint32
39     return libpr
40
41
42 def c_pointer_to_bytearray(ba):
43     """Return C char * pointer to ba."""
44     type = ctypes.c_char * len(ba)
45     return type.from_buffer(ba)
46
47
48 def strong_write(file, string):
49     """Apply write(string), then flush()."""
50     file.write(string)
51     file.flush()
52
53
54 def setup_server_io():
55     """Fill IO files DB with proper file( path)s. Write process IO test string.
56
57     Ensure IO files directory at server/. Remove any old input file if found.
58     Set up new input file for reading, and new output file for writing. Start
59     output file with process hash line of format PID + " " + floated UNIX time
60     (io_db["teststring"]). Raise SystemExit if file is found at path of either
61     record or save file plus io_db["tmp_suffix"].
62     """
63     def detect_atomic_leftover(path, tmp_suffix):
64         path_tmp = path + tmp_suffix
65         msg = "Found file '" + path_tmp + "' that may be a leftover from an " \
66               "aborted previous attempt to write '" + path + "'. Aborting " \
67               "until matter is resolved by removing it from its current path."
68         if os.access(path_tmp, os.F_OK):
69             raise SystemExit(msg)
70     io_db["teststring"] = str(os.getpid()) + " " + str(time.time())
71     io_db["save_wait"] = 0
72     io_db["verbose"] = False
73     io_db["record_chunk"] = ""
74     os.makedirs(io_db["path_server"], exist_ok=True)
75     io_db["file_out"] = open(io_db["path_out"], "w")
76     strong_write(io_db["file_out"], io_db["teststring"] + "\n")
77     if os.access(io_db["path_in"], os.F_OK):
78         os.remove(io_db["path_in"])
79     io_db["file_in"] = open(io_db["path_in"], "w")
80     io_db["file_in"].close()
81     io_db["file_in"] = open(io_db["path_in"], "r")
82     detect_atomic_leftover(io_db["path_save"], io_db["tmp_suffix"])
83     detect_atomic_leftover(io_db["path_record"], io_db["tmp_suffix"])
84
85
86 def cleanup_server_io():
87     """Close and (if io_db["kicked_by_rival"] false) remove files in io_db."""
88     def helper(file_key, path_key):
89         if file_key in io_db:
90             io_db[file_key].close()
91         if not io_db["kicked_by_rival"] \
92            and os.access(io_db[path_key], os.F_OK):
93             os.remove(io_db[path_key])
94     helper("file_in", "path_in")
95     helper("file_out", "path_out")
96     helper("file_worldstate", "path_worldstate")
97     if "file_record" in io_db:
98         io_db["file_record"].close()
99
100
101 def obey(command, prefix, replay=False, do_record=False):
102     """Call function from commands_db mapped to command's first token.
103
104     Tokenize command string with shlex.split(comments=True). If replay is set,
105     a non-meta command from the commands_db merely triggers obey() on the next
106     command from the records file. If not, non-meta commands set
107     io_db["worldstate_updateable"] to world_db["WORLD_ACTIVE"], and, if
108     do_record is set, are recorded to io_db["record_chunk"], and save_world()
109     is called (and io_db["record_chunk"] written) if 15 seconds have passed
110     since the last time it was called. The prefix string is inserted into the
111     server's input message between its beginning 'input ' and ':'. All activity
112     is preceded by a server_test() call. Commands that start with a lowercase
113     letter are ignored when world_db["WORLD_ACTIVE"] is False/0.
114     """
115     server_test()
116     if io_db["verbose"]:
117         print("input " + prefix + ": " + command)
118     try:
119         tokens = shlex.split(command, comments=True)
120     except ValueError as err:
121         print("Can't tokenize command string: " + str(err) + ".")
122         return
123     if len(tokens) > 0 and tokens[0] in commands_db \
124        and len(tokens) == commands_db[tokens[0]][0] + 1:
125         if commands_db[tokens[0]][1]:
126             commands_db[tokens[0]][2](*tokens[1:])
127         elif tokens[0][0].islower() and not world_db["WORLD_ACTIVE"]:
128             print("Ignoring lowercase-starting commands when world inactive.")
129         elif replay:
130             print("Due to replay mode, reading command as 'go on in record'.")
131             line = io_db["file_record"].readline()
132             if len(line) > 0:
133                 obey(line.rstrip(), io_db["file_record"].prefix
134                      + str(io_db["file_record"].line_n))
135                 io_db["file_record"].line_n = io_db["file_record"].line_n + 1
136             else:
137                 print("Reached end of record file.")
138         else:
139             commands_db[tokens[0]][2](*tokens[1:])
140             if do_record:
141                 io_db["record_chunk"] += command + "\n"
142                 if time.time() > io_db["save_wait"] + 15:
143                     atomic_write(io_db["path_record"], io_db["record_chunk"],
144                                  do_append=True)
145                     if world_db["WORLD_ACTIVE"]:
146                         save_world()
147                     io_db["record_chunk"] = ""
148                     io_db["save_wait"] = time.time()
149             io_db["worldstate_updateable"] = world_db["WORLD_ACTIVE"]
150     elif 0 != len(tokens):
151         print("Invalid command/argument, or bad number of tokens.")
152
153
154 def atomic_write(path, text, do_append=False, delete=True):
155     """Atomic write of text to file at path, appended if do_append is set."""
156     path_tmp = path + io_db["tmp_suffix"]
157     mode = "w"
158     if do_append:
159         mode = "a"
160         if os.access(path, os.F_OK):
161             shutil.copyfile(path, path_tmp)
162     file = open(path_tmp, mode)
163     strong_write(file, text)
164     file.close()
165     if delete and os.access(path, os.F_OK):
166         os.remove(path)
167     os.rename(path_tmp, path)
168
169
170 def save_world():
171     """Save all commands needed to reconstruct current world state."""
172
173     def quote(string):
174         string = string.replace("\u005C", '\u005C\u005C')
175         return '"' + string.replace('"', '\u005C"') + '"'
176
177     def mapsetter(key):
178         def helper(id=None):
179             string = ""
180             if key == "MAP" or world_db["Things"][id][key]:
181                 map = world_db["MAP"] if key == "MAP" \
182                                       else world_db["Things"][id][key]
183                 length = world_db["MAP_LENGTH"]
184                 for i in range(length):
185                     line = map[i * length:(i * length) + length].decode()
186                     string = string + key + " " + str(i) + " " + quote(line) \
187                         + "\n"
188             return string
189         return helper
190
191     def memthing(id):
192         string = ""
193         for memthing in world_db["Things"][id]["T_MEMTHING"]:
194             string = string + "T_MEMTHING " + str(memthing[0]) + " " + \
195                 str(memthing[1]) + " " + str(memthing[2]) + "\n"
196         return string
197
198     def helper(category, id_string, special_keys={}):
199         string = ""
200         for id in sorted(world_db[category].keys()):
201             string = string + id_string + " " + str(id) + "\n"
202             for key in sorted(world_db[category][id].keys()):
203                 if not key in special_keys:
204                     x = world_db[category][id][key]
205                     argument = quote(x) if str == type(x) else str(x)
206                     string = string + key + " " + argument + "\n"
207                 elif special_keys[key]:
208                     string = string + special_keys[key](id)
209         return string
210
211     string = ""
212     for key in sorted(world_db.keys()):
213         if (not isinstance(world_db[key], dict)) and key != "MAP" and \
214            key != "WORLD_ACTIVE":
215             string = string + key + " " + str(world_db[key]) + "\n"
216     string = string + mapsetter("MAP")()
217     string = string + helper("ThingActions", "TA_ID")
218     string = string + helper("ThingTypes", "TT_ID", {"TT_CORPSE_ID": False})
219     for id in sorted(world_db["ThingTypes"].keys()):
220         string = string + "TT_ID " + str(id) + "\n" + "TT_CORPSE_ID " + \
221             str(world_db["ThingTypes"][id]["TT_CORPSE_ID"]) + "\n"
222     string = string + helper("Things", "T_ID",
223                              {"T_CARRIES": False, "carried": False,
224                               "T_MEMMAP": mapsetter("T_MEMMAP"),
225                               "T_MEMTHING": memthing, "fovmap": False,
226                               "T_MEMDEPTHMAP": mapsetter("T_MEMDEPTHMAP")})
227     for id in sorted(world_db["Things"].keys()):
228         if [] != world_db["Things"][id]["T_CARRIES"]:
229             string = string + "T_ID " + str(id) + "\n"
230             for carried in sorted(world_db["Things"][id]["T_CARRIES"]):
231                 string = string + "T_CARRIES " + str(carried) + "\n"
232     string = string + "SEED_RANDOMNESS " + str(rand.seed) + "\n" + \
233         "WORLD_ACTIVE " + str(world_db["WORLD_ACTIVE"])
234     atomic_write(io_db["path_save"], string)
235
236
237 def obey_lines_in_file(path, name, do_record=False):
238     """Call obey() on each line of path's file, use name in input prefix."""
239     file = open(path, "r")
240     line_n = 1
241     for line in file.readlines():
242         obey(line.rstrip(), name + "file line " + str(line_n),
243              do_record=do_record)
244         line_n = line_n + 1
245     file.close()
246
247
248 def parse_command_line_arguments():
249     """Return settings values read from command line arguments."""
250     parser = argparse.ArgumentParser()
251     parser.add_argument('-s', nargs='?', type=int, dest='replay', const=1,
252                         action='store')
253     parser.add_argument('-l', nargs="?", const="save", dest='savefile',
254                         action="store")
255     parser.add_argument('-v', dest='verbose', action='store_true')
256     opts, unknown = parser.parse_known_args()
257     return opts
258
259
260 def server_test():
261     """Ensure valid server out file belonging to current process.
262
263     This is done by comparing io_db["teststring"] to what's found at the start
264     of the current file at io_db["path_out"]. On failure, set
265     io_db["kicked_by_rival"] and raise SystemExit.
266     """
267     if not os.access(io_db["path_out"], os.F_OK):
268         raise SystemExit("Server output file has disappeared.")
269     file = open(io_db["path_out"], "r")
270     test = file.readline().rstrip("\n")
271     file.close()
272     if test != io_db["teststring"]:
273         io_db["kicked_by_rival"] = True
274         msg = "Server test string in server output file does not match. This" \
275               " indicates that the current server process has been " \
276               "superseded by another one."
277         raise SystemExit(msg)
278
279
280 def read_command():
281     """Return next newline-delimited command from server in file.
282
283     Keep building return string until a newline is encountered. Pause between
284     unsuccessful reads, and after too much waiting, run server_test().
285     """
286     wait_on_fail = 0.03333
287     max_wait = 5
288     now = time.time()
289     command = ""
290     while True:
291         add = io_db["file_in"].readline()
292         if len(add) > 0:
293             command = command + add
294             if len(command) > 0 and "\n" == command[-1]:
295                 command = command[:-1]
296                 break
297         else:
298             time.sleep(wait_on_fail)
299             if now + max_wait < time.time():
300                 server_test()
301                 now = time.time()
302     return command
303
304
305 def try_worldstate_update():
306     """Write worldstate file if io_db["worldstate_updateable"] is set."""
307     if io_db["worldstate_updateable"]:
308
309         def draw_visible_Things(map, run):
310             for id in world_db["Things"]:
311                 type = world_db["Things"][id]["T_TYPE"]
312                 consumable = world_db["ThingTypes"][type]["TT_CONSUMABLE"]
313                 alive = world_db["ThingTypes"][type]["TT_LIFEPOINTS"]
314                 if (0 == run and not consumable and not alive) \
315                    or (1 == run and consumable and not alive) \
316                    or (2 == run and alive):
317                     y = world_db["Things"][id]["T_POSY"]
318                     x = world_db["Things"][id]["T_POSX"]
319                     fovflag = world_db["Things"][0]["fovmap"][(y * length) + x]
320                     if 'v' == chr(fovflag):
321                         c = world_db["ThingTypes"][type]["TT_SYMBOL"]
322                         map[(y * length) + x] = ord(c)
323
324         def write_map(string, map):
325             for i in range(length):
326                 line = map[i * length:(i * length) + length].decode()
327                 string = string + line + "\n"
328             return string
329
330         inventory = ""
331         if [] == world_db["Things"][0]["T_CARRIES"]:
332             inventory = "(none)\n"
333         else:
334             for id in world_db["Things"][0]["T_CARRIES"]:
335                 type_id = world_db["Things"][id]["T_TYPE"]
336                 name = world_db["ThingTypes"][type_id]["TT_NAME"]
337                 inventory = inventory + name + "\n"
338         string = str(world_db["TURN"]) + "\n" + \
339             str(world_db["Things"][0]["T_LIFEPOINTS"]) + "\n" + \
340             str(world_db["Things"][0]["T_SATIATION"]) + "\n" + \
341             inventory + "%\n" + \
342             str(world_db["Things"][0]["T_POSY"]) + "\n" + \
343             str(world_db["Things"][0]["T_POSX"]) + "\n" + \
344             str(world_db["MAP_LENGTH"]) + "\n"
345         length = world_db["MAP_LENGTH"]
346         fov = bytearray(b' ' * (length ** 2))
347         for pos in range(length ** 2):
348             if 'v' == chr(world_db["Things"][0]["fovmap"][pos]):
349                 fov[pos] = world_db["MAP"][pos]
350         for i in range(3):
351             draw_visible_Things(fov, i)
352         string = write_map(string, fov)
353         mem = world_db["Things"][0]["T_MEMMAP"][:]
354         for i in range(2):
355             for mt in world_db["Things"][0]["T_MEMTHING"]:
356                 consumable = world_db["ThingTypes"][mt[0]]["TT_CONSUMABLE"]
357                 if (i == 0 and not consumable) or (i == 1 and consumable):
358                     c = world_db["ThingTypes"][mt[0]]["TT_SYMBOL"]
359                     mem[(mt[1] * length) + mt[2]] = ord(c)
360         string = write_map(string, mem)
361         atomic_write(io_db["path_worldstate"], string, delete=False)
362         strong_write(io_db["file_out"], "WORLD_UPDATED\n")
363         io_db["worldstate_updateable"] = False
364
365
366 def replay_game():
367     """Replay game from record file.
368
369     Use opts.replay as breakpoint turn to which to replay automatically before
370     switching to manual input by non-meta commands in server input file
371     triggering further reads of record file. Ensure opts.replay is at least 1.
372     Run try_worldstate_update() before each interactive obey()/read_command().
373     """
374     if opts.replay < 1:
375         opts.replay = 1
376     print("Replay mode. Auto-replaying up to turn " + str(opts.replay) +
377           " (if so late a turn is to be found).")
378     if not os.access(io_db["path_record"], os.F_OK):
379         raise SystemExit("No record file found to replay.")
380     io_db["file_record"] = open(io_db["path_record"], "r")
381     io_db["file_record"].prefix = "record file line "
382     io_db["file_record"].line_n = 1
383     while world_db["TURN"] < opts.replay:
384         line = io_db["file_record"].readline()
385         if "" == line:
386             break
387         obey(line.rstrip(), io_db["file_record"].prefix
388              + str(io_db["file_record"].line_n))
389         io_db["file_record"].line_n = io_db["file_record"].line_n + 1
390     while True:
391         try_worldstate_update()
392         obey(read_command(), "in file", replay=True)
393
394
395 def play_game():
396     """Play game by server input file commands. Before, load save file found.
397
398     If no save file is found, a new world is generated from the commands in the
399     world config plus a 'MAKE WORLD [current Unix timestamp]'. Record this
400     command and all that follow via the server input file. Run
401     try_worldstate_update() before each interactive obey()/read_command().
402     """
403     if os.access(io_db["path_save"], os.F_OK):
404         obey_lines_in_file(io_db["path_save"], "save")
405     else:
406         if not os.access(io_db["path_worldconf"], os.F_OK):
407             msg = "No world config file from which to start a new world."
408             raise SystemExit(msg)
409         obey_lines_in_file(io_db["path_worldconf"], "world config ",
410                            do_record=True)
411         obey("MAKE_WORLD " + str(int(time.time())), "in file", do_record=True)
412     while True:
413         try_worldstate_update()
414         obey(read_command(), "in file", do_record=True)
415
416
417 def make_map():
418     """(Re-)make island map.
419
420     Let "~" represent water, "." land, "X" trees: Build island shape randomly,
421     start with one land cell in the middle, then go into cycle of repeatedly
422     selecting a random sea cell and transforming it into land if it is neighbor
423     to land. The cycle ends when a land cell is due to be created at the map's
424     border. Then put some trees on the map (TODO: more precise algorithm desc).
425     """
426
427     def is_neighbor(coordinates, type):
428         y = coordinates[0]
429         x = coordinates[1]
430         length = world_db["MAP_LENGTH"]
431         ind = y % 2
432         diag_west = x + (ind > 0)
433         diag_east = x + (ind < (length - 1))
434         pos = (y * length) + x
435         if (y > 0 and diag_east
436             and type == chr(world_db["MAP"][pos - length + ind])) \
437            or (x < (length - 1)
438                and type == chr(world_db["MAP"][pos + 1])) \
439            or (y < (length - 1) and diag_east
440                and type == chr(world_db["MAP"][pos + length + ind])) \
441            or (y > 0 and diag_west
442                and type == chr(world_db["MAP"][pos - length - (not ind)])) \
443            or (x > 0
444                and type == chr(world_db["MAP"][pos - 1])) \
445            or (y < (length - 1) and diag_west
446                and type == chr(world_db["MAP"][pos + length - (not ind)])):
447             return True
448         return False
449
450     world_db["MAP"] = bytearray(b'~' * (world_db["MAP_LENGTH"] ** 2))
451     length = world_db["MAP_LENGTH"]
452     add_half_width = (not (length % 2)) * int(length / 2)
453     world_db["MAP"][int((length ** 2) / 2) + add_half_width] = ord(".")
454     while (1):
455         y = rand.next() % length
456         x = rand.next() % length
457         pos = (y * length) + x
458         if "~" == chr(world_db["MAP"][pos]) and is_neighbor((y, x), "."):
459             if y == 0 or y == (length - 1) or x == 0 or x == (length - 1):
460                 break
461             world_db["MAP"][pos] = ord(".")
462     n_trees = int((length ** 2) / 16)
463     i_trees = 0
464     while (i_trees <= n_trees):
465         single_allowed = rand.next() % 32
466         y = rand.next() % length
467         x = rand.next() % length
468         pos = (y * length) + x
469         if "." == chr(world_db["MAP"][pos]) \
470                 and ((not single_allowed) or is_neighbor((y, x), "X")):
471             world_db["MAP"][pos] = ord("X")
472             i_trees += 1
473     # This all-too-precise replica of the original C code misses iter_limit().
474
475
476 def update_map_memory(t, age_map=True):
477     """Update t's T_MEMMAP with what's in its FOV now,age its T_MEMMEPTHMAP."""
478
479     def age_some_memdepthmap_on_nonfov_cells():
480         # OUTSOURCED FOR PERFORMANCE REASONS TO libplomrogue.so:
481         # ord_v = ord("v")
482         # ord_0 = ord("0")
483         # ord_9 = ord("9")
484         # for pos in [pos for pos in range(world_db["MAP_LENGTH"] ** 2)
485         #             if not ord_v == t["fovmap"][pos]
486         #             if ord_0 <= t["T_MEMDEPTHMAP"][pos]
487         #             if ord_9 > t["T_MEMDEPTHMAP"][pos]
488         #             if not rand.next() % (2 **
489         #                                   (t["T_MEMDEPTHMAP"][pos] - 48))]:
490         #     t["T_MEMDEPTHMAP"][pos] += 1
491         memdepthmap = c_pointer_to_bytearray(t["T_MEMDEPTHMAP"])
492         fovmap = c_pointer_to_bytearray(t["fovmap"])
493         libpr.age_some_memdepthmap_on_nonfov_cells(memdepthmap, fovmap)
494
495     if not t["T_MEMMAP"]:
496         t["T_MEMMAP"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
497     if not t["T_MEMDEPTHMAP"]:
498         t["T_MEMDEPTHMAP"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
499     ord_v = ord("v")
500     ord_0 = ord("0")
501     ord_space = ord(" ")
502     for pos in [pos for pos in range(world_db["MAP_LENGTH"] ** 2)
503                 if ord_v == t["fovmap"][pos]]:
504         t["T_MEMDEPTHMAP"][pos] = ord_0
505         if ord_space == t["T_MEMMAP"][pos]:
506             t["T_MEMMAP"][pos] = world_db["MAP"][pos]
507     if age_map:
508         age_some_memdepthmap_on_nonfov_cells()
509     t["T_MEMTHING"] = [mt for mt in t["T_MEMTHING"]
510                        if ord_v != t["fovmap"][(mt[1] * world_db["MAP_LENGTH"])
511                                                + mt[2]]]
512     for id in [id for id in world_db["Things"]
513                if not world_db["Things"][id]["carried"]]:
514         type = world_db["Things"][id]["T_TYPE"]
515         if not world_db["ThingTypes"][type]["TT_LIFEPOINTS"]:
516             y = world_db["Things"][id]["T_POSY"]
517             x = world_db["Things"][id]["T_POSX"]
518             if ord_v == t["fovmap"][(y * world_db["MAP_LENGTH"]) + x]:
519                 t["T_MEMTHING"].append((type, y, x))
520
521
522 def set_world_inactive():
523     """Set world_db["WORLD_ACTIVE"] to 0 and remove worldstate file."""
524     server_test()
525     if os.access(io_db["path_worldstate"], os.F_OK):
526         os.remove(io_db["path_worldstate"])
527     world_db["WORLD_ACTIVE"] = 0
528
529
530 def integer_test(val_string, min, max=None):
531     """Return val_string if integer >= min & (if max set) <= max, else None."""
532     try:
533         val = int(val_string)
534         if val < min or (max is not None and val > max):
535             raise ValueError
536         return val
537     except ValueError:
538         msg = "Ignoring: Please use integer >= " + str(min)
539         if max is not None:
540             msg += " and <= " + str(max)
541         msg += "."
542         print(msg)
543         return None
544
545
546 def setter(category, key, min, max=None):
547     """Build setter for world_db([category + "s"][id])[key] to >=min/<=max."""
548     if category is None:
549         def f(val_string):
550             val = integer_test(val_string, min, max)
551             if None != val:
552                 world_db[key] = val
553     else:
554         if category == "Thing":
555             id_store = command_tid
556             decorator = test_Thing_id
557         elif category == "ThingType":
558             id_store = command_ttid
559             decorator = test_ThingType_id
560         elif category == "ThingAction":
561             id_store = command_taid
562             decorator = test_ThingAction_id
563
564         @decorator
565         def f(val_string):
566             val = integer_test(val_string, min, max)
567             if None != val:
568                 world_db[category + "s"][id_store.id][key] = val
569     return f
570
571
572 def build_fov_map(t):
573     """Build Thing's FOV map."""
574     t["fovmap"] = bytearray(b'v' * (world_db["MAP_LENGTH"] ** 2))
575     fovmap = c_pointer_to_bytearray(t["fovmap"])
576     map = c_pointer_to_bytearray(world_db["MAP"])
577     if libpr.build_fov_map(t["T_POSY"], t["T_POSX"], fovmap, map):
578         raise RuntimeError("Malloc error in build_fov_Map().")
579
580
581 def log_help():
582     """Send quick usage info to log."""
583     strong_write(io_db["file_out"], "LOG See README file for help.\n")
584
585
586 def decrement_lifepoints(t):
587     """Decrement t's lifepoints by 1, and if to zero, corpse it.
588
589     If t is the player avatar, only blank its fovmap, so that the client may
590     still display memory data. On non-player things, erase fovmap and memory.
591     Dying actors drop all their things.
592     """
593     t["T_LIFEPOINTS"] -= 1
594     if 0 == t["T_LIFEPOINTS"]:
595         for id in t["T_CARRIES"]:
596             t["T_CARRIES"].remove(id)
597             world_db["Things"][id]["T_POSY"] = t["T_POSY"]
598             world_db["Things"][id]["T_POSX"] = t["T_POSX"]
599             world_db["Things"][id]["carried"] = False
600         t["T_TYPE"] = world_db["ThingTypes"][t["T_TYPE"]]["TT_CORPSE_ID"]
601         if world_db["Things"][0] == t:
602             t["fovmap"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
603             strong_write(io_db["file_out"], "LOG You die.\n")
604         else:
605             t["fovmap"] = False
606             t["T_MEMMAP"] = False
607             t["T_MEMDEPTHMAP"] = False
608             t["T_MEMTHING"] = []
609
610
611 def mv_yx_in_dir_legal(dir, y, x):
612     """Wrapper around libpr.mv_yx_in_dir_legal to simplify its use."""
613     dir_c = dir.encode("ascii")[0]
614     test = libpr.mv_yx_in_dir_legal_wrap(dir_c, y, x)
615     if -1 == test:
616         raise RuntimeError("Too much wrapping in mv_yx_in_dir_legal_wrap()!")
617     return (test, libpr.result_y(), libpr.result_x())
618
619
620 def actor_wait(t):
621     """Make t do nothing (but loudly, if player avatar)."""
622     if t == world_db["Things"][0]:
623         strong_write(io_db["file_out"], "LOG You wait.\n")
624
625
626 def actor_move(t):
627     """If passable, move/collide(=attack) thing into T_ARGUMENT's direction."""
628     passable = False
629     move_result = mv_yx_in_dir_legal(chr(t["T_ARGUMENT"]),
630                                      t["T_POSY"], t["T_POSX"])
631     if 1 == move_result[0]:
632         pos = (move_result[1] * world_db["MAP_LENGTH"]) + move_result[2]
633         passable = "." == chr(world_db["MAP"][pos])
634         hitted = [id for id in world_db["Things"]
635                   if world_db["Things"][id] != t
636                   if world_db["Things"][id]["T_LIFEPOINTS"]
637                   if world_db["Things"][id]["T_POSY"] == move_result[1]
638                   if world_db["Things"][id]["T_POSX"] == move_result[2]]
639         if len(hitted):
640             hit_id = hitted[0]
641             if t == world_db["Things"][0]:
642                 hitted_type = world_db["Things"][hit_id]["T_TYPE"]
643                 hitted_name = world_db["ThingTypes"][hitted_type]["TT_NAME"]
644                 strong_write(io_db["file_out"], "LOG You wound "
645                                                 + hitted_name + ".\n")
646             elif 0 == hit_id:
647                 hitter_name = world_db["ThingTypes"][t["T_TYPE"]]["TT_NAME"]
648                 strong_write(io_db["file_out"], "LOG " + hitter_name +
649                                                 " wounds you.\n")
650             decrement_lifepoints(world_db["Things"][hit_id])
651             return
652     dir = [dir for dir in directions_db
653            if directions_db[dir] == chr(t["T_ARGUMENT"])][0]
654     if passable:
655         t["T_POSY"] = move_result[1]
656         t["T_POSX"] = move_result[2]
657         for id in t["T_CARRIES"]:
658             world_db["Things"][id]["T_POSY"] = move_result[1]
659             world_db["Things"][id]["T_POSX"] = move_result[2]
660         build_fov_map(t)
661         if t == world_db["Things"][0]:
662             strong_write(io_db["file_out"], "LOG You move " + dir + ".\n")
663     elif t == world_db["Things"][0]:
664         strong_write(io_db["file_out"], "LOG You fail to move " + dir + ".\n")
665
666
667 def actor_pick_up(t):
668     """Make t pick up (topmost?) Thing from ground into inventory."""
669     # Topmostness is actually not defined so far. Picks most nutritious Thing.
670     ids = [id for id in world_db["Things"] if world_db["Things"][id] != t
671            if not world_db["Things"][id]["carried"]
672            if world_db["Things"][id]["T_POSY"] == t["T_POSY"]
673            if world_db["Things"][id]["T_POSX"] == t["T_POSX"]]
674     if len(ids):
675         highest_id = ids[0]
676         nutritious = 0
677         for id in ids:
678             type = world_db["Things"][id]["T_TYPE"]
679             if world_db["ThingTypes"][type]["TT_CONSUMABLE"] > nutritious:
680                 nutritious = world_db["ThingTypes"][type]["TT_CONSUMABLE"]
681                 highest_id = id
682         world_db["Things"][highest_id]["carried"] = True
683         t["T_CARRIES"].append(highest_id)
684         if t == world_db["Things"][0]:
685             strong_write(io_db["file_out"], "LOG You pick up an object.\n")
686     elif t == world_db["Things"][0]:
687         err = "You try to pick up an object, but there is none."
688         strong_write(io_db["file_out"], "LOG " + err + "\n")
689
690
691 def actor_drop(t):
692     """Make t rop Thing from inventory to ground indexed by T_ARGUMENT."""
693     # TODO: Handle case where T_ARGUMENT matches nothing.
694     if len(t["T_CARRIES"]):
695         id = t["T_CARRIES"][t["T_ARGUMENT"]]
696         t["T_CARRIES"].remove(id)
697         world_db["Things"][id]["carried"] = False
698         if t == world_db["Things"][0]:
699             strong_write(io_db["file_out"], "LOG You drop an object.\n")
700     elif t == world_db["Things"][0]:
701         err = "You try to drop an object, but you own none."
702         strong_write(io_db["file_out"], "LOG " + err + "\n")
703
704
705 def actor_use(t):
706     """Make t use (for now: consume) T_ARGUMENT-indexed Thing in inventory."""
707     # TODO: Handle case where T_ARGUMENT matches nothing.
708     if len(t["T_CARRIES"]):
709         id = t["T_CARRIES"][t["T_ARGUMENT"]]
710         type = world_db["Things"][id]["T_TYPE"]
711         if world_db["ThingTypes"][type]["TT_CONSUMABLE"]:
712             t["T_CARRIES"].remove(id)
713             del world_db["Things"][id]
714             t["T_SATIATION"] += world_db["ThingTypes"][type]["TT_CONSUMABLE"]
715             if t == world_db["Things"][0]:
716                 strong_write(io_db["file_out"],
717                              "LOG You consume this object.\n")
718         elif t == world_db["Things"][0]:
719             strong_write(io_db["file_out"],
720                          "LOG You try to use this object, but fail.\n")
721     elif t == world_db["Things"][0]:
722         strong_write(io_db["file_out"],
723                      "LOG You try to use an object, but you own none.\n")
724
725
726 def thingproliferation(t, prol_map):
727     """To chance of 1/TT_PROLIFERATE, create t offspring in open neighbor cell.
728
729     Naturally only works with TT_PROLIFERATE > 0. The neighbor cell must be be
730     marked '.' in prol_map. If there are several map cell candidates, one is
731     selected randomly.
732     """
733     prolscore = world_db["ThingTypes"][t["T_TYPE"]]["TT_PROLIFERATE"]
734     if prolscore and (1 == prolscore or 1 == (rand.next() % prolscore)):
735         candidates = []
736         for dir in [directions_db[key] for key in directions_db]:
737             mv_result = mv_yx_in_dir_legal(dir, t["T_POSY"], t["T_POSX"])
738             if mv_result[0] and  ord('.') == prol_map[mv_result[1]
739                                                       * world_db["MAP_LENGTH"]
740                                                       + mv_result[2]]:
741                 candidates.append((mv_result[1], mv_result[2]))
742         if len(candidates):
743             i = rand.next() % len(candidates)
744             id = id_setter(-1, "Things")
745             newT = new_Thing(t["T_TYPE"], (candidates[i][0], candidates[i][1]))
746             world_db["Things"][id] = newT
747
748
749 def try_healing(t):
750     """Grow t's HP to a 1/32 chance if < HP max, satiation > 0, and waiting.
751
752     On success, decrease satiation score by 32.
753     """
754     if t["T_SATIATION"] > 0 \
755        and t["T_LIFEPOINTS"] < \
756         world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"] \
757        and 0 == (rand.next() % 31) \
758        and t["T_COMMAND"] == [id for id in world_db["ThingActions"]
759                               if world_db["ThingActions"][id]["TA_NAME"] ==
760                               "wait"][0]:
761         t["T_LIFEPOINTS"] += 1
762         t["T_SATIATION"] -= 32
763         if t == world_db["Things"][0]:
764             strong_write(io_db["file_out"], "LOG You heal.\n")
765
766
767 def hunger(t):
768     """Decrement t's satiation,dependent on it trigger lifepoint dec chance."""
769     if t["T_SATIATION"] > -32768:
770         t["T_SATIATION"] -= 1
771     testbase = t["T_SATIATION"] if t["T_SATIATION"] >= 0 else -t["T_SATIATION"]
772     if not world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"]:
773         raise RuntimeError("A thing that should not hunger is hungering.")
774     stomach = int(32767 / world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"])
775     if int(int(testbase / stomach) / ((rand.next() % stomach) + 1)):
776         if t == world_db["Things"][0]:
777             strong_write(io_db["file_out"], "LOG You suffer from hunger.\n")
778         decrement_lifepoints(t)
779
780
781 def get_dir_to_target(t, filter):
782     """Try to set T_COMMAND/T_ARGUMENT for move to "filter"-determined target.
783
784     The path-wise nearest target is chosen, via the shortest available path.
785     Target must not be t. On succcess, return positive value, else False.
786     Filters:
787     "a": Thing in FOV is below a certain distance, animate, but of ThingType
788          that is not t's, and starts out weaker than t is; build path as
789          avoiding things of t's ThingType
790     "f": neighbor cell (not inhabited by any animate Thing) further away from
791          animate Thing not further than x steps away and in FOV and of a
792          ThingType that is not t's, and starts out stronger or as strong as t
793          is currently; or (cornered), if no such flight cell, but Thing of
794          above criteria is too near,1 a cell closer to it, or, if less near,
795          just wait
796     "c": Thing in memorized map is consumable
797     "s": memory map cell with greatest-reachable degree of unexploredness
798     """
799
800     def zero_score_map_where_char_on_memdepthmap(c):
801         # OUTSOURCED FOR PERFORMANCE REASONS TO libplomrogue.so:
802         # for i in [i for i in range(world_db["MAP_LENGTH"] ** 2)
803         #           if t["T_MEMDEPTHMAP"][i] == mem_depth_c[0]]:
804         #     set_map_score(i, 0)
805         map = c_pointer_to_bytearray(t["T_MEMDEPTHMAP"])
806         if libpr.zero_score_map_where_char_on_memdepthmap(c, map):
807             raise RuntimeError("No score map allocated for "
808                                "zero_score_map_where_char_on_memdepthmap().")
809
810     def set_map_score(pos, score):
811         test = libpr.set_map_score(pos, score)
812         if test:
813             raise RuntimeError("No score map allocated for set_map_score().")
814
815     def get_map_score(pos):
816         result = libpr.get_map_score(pos)
817         if result < 0:
818             raise RuntimeError("No score map allocated for get_map_score().")
819         return result
820
821     def seeing_thing():
822         if t["fovmap"] and ("a" == filter or "f" == filter):
823             for id in world_db["Things"]:
824                 Thing = world_db["Things"][id]
825                 if Thing != t and Thing["T_LIFEPOINTS"] and \
826                    t["T_TYPE"] != Thing["T_TYPE"] and \
827                    'v' == chr(t["fovmap"][(Thing["T_POSY"]
828                                           * world_db["MAP_LENGTH"])
829                                           + Thing["T_POSX"]]):
830                     ThingType = world_db["ThingTypes"][Thing["T_TYPE"]]
831                     if ("f" == filter and ThingType["TT_LIFEPOINTS"] >=
832                         t["T_LIFEPOINTS"]) \
833                        or ("a" == filter and ThingType["TT_LIFEPOINTS"] <
834                             t["T_LIFEPOINTS"]):
835                         return True
836         elif t["T_MEMMAP"] and "c" == filter:
837             for mt in t["T_MEMTHING"]:
838                 if ' ' != chr(t["T_MEMMAP"][(mt[1] * world_db["MAP_LENGTH"])
839                                             + mt[2]]) \
840                    and world_db["ThingTypes"][mt[0]]["TT_CONSUMABLE"]:
841                     return True
842         return False
843
844     def set_cells_passable_on_memmap_to_65534_on_scoremap():
845         # OUTSOURCED FOR PERFORMANCE REASONS TO libplomrogue.so:
846         # ord_dot = ord(".")
847         # memmap = t["T_MEMMAP"]
848         # for i in [i for i in range(world_db["MAP_LENGTH"] ** 2)
849         #            if ord_dot == memmap[i]]:
850         #     set_map_score(i, 65534) # i.e. 65535-1
851         map = c_pointer_to_bytearray(t["T_MEMMAP"])
852         if libpr.set_cells_passable_on_memmap_to_65534_on_scoremap(map):
853             raise RuntimeError("No score map allocated for set_cells_passable"
854                                "_on_memmap_to_65534_on_scoremap().")
855
856     def init_score_map():
857         test = libpr.init_score_map()
858         if test:
859             raise RuntimeError("Malloc error in init_score_map().")
860         ord_v = ord("v")
861         ord_blank = ord(" ")
862         set_cells_passable_on_memmap_to_65534_on_scoremap()
863         if "a" == filter:
864             for id in world_db["Things"]:
865                 Thing = world_db["Things"][id]
866                 pos = Thing["T_POSY"] * world_db["MAP_LENGTH"] \
867                     + Thing["T_POSX"]
868                 if t != Thing and Thing["T_LIFEPOINTS"] and \
869                    t["T_TYPE"] != Thing["T_TYPE"] and \
870                    ord_v == t["fovmap"][pos] and \
871                    t["T_LIFEPOINTS"] > \
872                    world_db["ThingTypes"][Thing["T_TYPE"]]["TT_LIFEPOINTS"]:
873                     set_map_score(pos, 0)
874                 elif t["T_TYPE"] == Thing["T_TYPE"]:
875                     set_map_score(pos, 65535)
876         elif "f" == filter:
877             for id in [id for id in world_db["Things"]
878                        if world_db["Things"][id]["T_LIFEPOINTS"]]:
879                 Thing = world_db["Things"][id]
880                 pos = Thing["T_POSY"] * world_db["MAP_LENGTH"] \
881                     + Thing["T_POSX"]
882                 if t["T_TYPE"] != Thing["T_TYPE"] and \
883                    ord_v == t["fovmap"][pos] and \
884                    t["T_LIFEPOINTS"] <= \
885                    world_db["ThingTypes"][Thing["T_TYPE"]]["TT_LIFEPOINTS"]:
886                     set_map_score(pos, 0)
887         elif "c" == filter:
888             for mt in [mt for mt in t["T_MEMTHING"]
889                        if ord_blank != t["T_MEMMAP"][mt[1]
890                                                      * world_db["MAP_LENGTH"]
891                                                      + mt[2]]
892                        if world_db["ThingTypes"][mt[0]]["TT_CONSUMABLE"]]:
893                 set_map_score(mt[1] * world_db["MAP_LENGTH"] + mt[2], 0)
894         elif "s" == filter:
895             zero_score_map_where_char_on_memdepthmap(mem_depth_c[0])
896
897     def rand_target_dir(neighbors, cmp, dirs):
898         candidates = []
899         n_candidates = 0
900         for i in range(len(dirs)):
901             if cmp == neighbors[i]:
902                 candidates.append(dirs[i])
903                 n_candidates += 1
904         return candidates[rand.next() % n_candidates] if n_candidates else 0
905
906     def get_neighbor_scores(dirs, eye_pos):
907         scores = []
908         if libpr.ready_neighbor_scores(eye_pos):
909             raise RuntimeError("No score map allocated for " +
910                                "ready_neighbor_scores.()")
911         for i in range(len(dirs)):
912             scores.append(libpr.get_neighbor_score(i))
913         return scores
914
915     def get_dir_from_neighbors():
916         dir_to_target = False
917         dirs = "edcxsw"
918         eye_pos = t["T_POSY"] * world_db["MAP_LENGTH"] + t["T_POSX"]
919         neighbors = get_neighbor_scores(dirs, eye_pos)
920         if "f" == filter:
921             inhabited = [world_db["Things"][id]["T_POSY"]
922                          * world_db["MAP_LENGTH"]
923                          + world_db["Things"][id]["T_POSX"]
924                          for id in world_db["Things"]
925                          if world_db["Things"][id]["T_LIFEPOINTS"]]
926             for i in range(len(dirs)):
927                 mv_yx_in_dir_legal(dirs[i], t["T_POSY"], t["T_POSX"])
928                 pos_cmp = libpr.result_y() * world_db["MAP_LENGTH"] \
929                     + libpr.result_x()
930                 for pos in [pos for pos in inhabited if pos == pos_cmp]:
931                     neighbors[i] = 65535
932                     break
933         minmax_start = 0 if "f" == filter else 65535 - 1
934         minmax_neighbor = minmax_start
935         for i in range(len(dirs)):
936             if ("f" == filter and get_map_score(eye_pos) < neighbors[i] and
937                 minmax_neighbor < neighbors[i] and 65535 != neighbors[i]) \
938                or ("f" != filter and minmax_neighbor > neighbors[i]):
939                 minmax_neighbor = neighbors[i]
940         if minmax_neighbor != minmax_start:
941             dir_to_target = rand_target_dir(neighbors, minmax_neighbor, dirs)
942         if "f" == filter:
943             if not dir_to_target:
944                 if 1 == get_map_score(eye_pos):
945                     dir_to_target = rand_target_dir(neighbors, 0, dirs)
946                 elif 3 >= get_map_score(eye_pos):
947                     t["T_COMMAND"] = [id for id in world_db["ThingActions"]
948                                       if
949                                       world_db["ThingActions"][id]["TA_NAME"]
950                                       == "wait"][0]
951                     return 1
952             elif dir_to_target and 3 < get_map_score(eye_pos):
953                 dir_to_target = 0
954         elif "a" == filter and 10 <= get_map_score(eye_pos):
955             dir_to_target = 0
956         return dir_to_target
957
958     dir_to_target = False
959     mem_depth_c = b' '
960     run_i = 9 + 1 if "s" == filter else 1
961     while run_i and not dir_to_target and ("s" == filter or seeing_thing()):
962         run_i -= 1
963         init_score_map()
964         mem_depth_c = b'9' if b' ' == mem_depth_c \
965             else bytes([mem_depth_c[0] - 1])
966         if libpr.dijkstra_map():
967             raise RuntimeError("No score map allocated for dijkstra_map().")
968         dir_to_target = get_dir_from_neighbors()
969         libpr.free_score_map()
970         if dir_to_target and str == type(dir_to_target):
971             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
972                               if world_db["ThingActions"][id]["TA_NAME"]
973                               == "move"][0]
974             t["T_ARGUMENT"] = ord(dir_to_target)
975     return dir_to_target
976
977
978 def standing_on_consumable(t):
979     """Return True/False whether t is standing on a consumable."""
980     for id in [id for id in world_db["Things"] if world_db["Things"][id] != t
981                if world_db["Things"][id]["T_POSY"] == t["T_POSY"]
982                if world_db["Things"][id]["T_POSX"] == t["T_POSX"]
983                if world_db["ThingTypes"][world_db["Things"][id]["T_TYPE"]]
984                           ["TT_CONSUMABLE"]]:
985         return True
986     return False
987
988
989 def get_inventory_slot_to_consume(t):
990     """Return slot Id of strongest consumable in t's inventory, else -1."""
991     cmp_consumability = 0
992     selection = -1
993     i = 0
994     for id in t["T_CARRIES"]:
995         type = world_db["Things"][id]["T_TYPE"]
996         if world_db["ThingTypes"][type]["TT_CONSUMABLE"] > cmp_consumability:
997             cmp_consumability = world_db["ThingTypes"][type]["TT_CONSUMABLE"]
998             selection = i
999         i += 1
1000     return selection
1001
1002
1003 def ai(t):
1004     """Determine next command/argment for actor t via AI algorithms.
1005
1006     AI will look for, and move towards, enemies (animate Things not of their
1007     own ThingType); if they see none, they will consume consumables in their
1008     inventory; if there are none, they will pick up what they stand on if they
1009     stand on consumables; if they stand on none, they will move towards the
1010     next consumable they see or remember on the map; if they see or remember
1011     none, they will explore parts of the map unseen since ever or for at least
1012     one turn; if there is nothing to explore, they will simply wait.
1013     """
1014     t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1015                       if world_db["ThingActions"][id]["TA_NAME"] == "wait"][0]
1016     if not get_dir_to_target(t, "f"):
1017         sel = get_inventory_slot_to_consume(t)
1018         if -1 != sel:
1019             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1020                               if world_db["ThingActions"][id]["TA_NAME"]
1021                               == "use"][0]
1022             t["T_ARGUMENT"] = sel
1023         elif standing_on_consumable(t):
1024             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1025                               if world_db["ThingActions"][id]["TA_NAME"]
1026                               == "pick_up"][0]
1027         elif (not get_dir_to_target(t, "c")) and \
1028              (not get_dir_to_target(t, "a")):
1029             get_dir_to_target(t, "s")
1030
1031
1032 def turn_over():
1033     """Run game world and its inhabitants until new player input expected."""
1034     id = 0
1035     whilebreaker = False
1036     while world_db["Things"][0]["T_LIFEPOINTS"]:
1037         proliferable_map = world_db["MAP"][:]
1038         for id in [id for id in world_db["Things"]
1039                    if not world_db["Things"][id]["carried"]]:
1040             y = world_db["Things"][id]["T_POSY"]
1041             x = world_db["Things"][id]["T_POSX"]
1042             proliferable_map[y * world_db["MAP_LENGTH"] + x] = ord('X')
1043         for id in [id for id in world_db["Things"]]:  # Only what's from start!
1044             if not id in world_db["Things"] or \
1045                world_db["Things"][id]["carried"]:   # May have been consumed or
1046                 continue                            # picked up during turn …
1047             Thing = world_db["Things"][id]
1048             if Thing["T_LIFEPOINTS"]:
1049                 if not Thing["T_COMMAND"]:
1050                     update_map_memory(Thing)
1051                     if 0 == id:
1052                         whilebreaker = True
1053                         break
1054                     ai(Thing)
1055                 try_healing(Thing)
1056                 hunger(Thing)
1057                 if Thing["T_LIFEPOINTS"]:
1058                     Thing["T_PROGRESS"] += 1
1059                     taid = [a for a in world_db["ThingActions"]
1060                               if a == Thing["T_COMMAND"]][0]
1061                     ThingAction = world_db["ThingActions"][taid]
1062                     if Thing["T_PROGRESS"] == ThingAction["TA_EFFORT"]:
1063                         eval("actor_" + ThingAction["TA_NAME"])(Thing)
1064                         Thing["T_COMMAND"] = 0
1065                         Thing["T_PROGRESS"] = 0
1066             thingproliferation(Thing, proliferable_map)
1067         if whilebreaker:
1068             break
1069         world_db["TURN"] += 1
1070
1071
1072 def new_Thing(type, pos=(0, 0)):
1073     """Return Thing of type T_TYPE, with fovmap if alive and world active."""
1074     thing = {
1075         "T_LIFEPOINTS": world_db["ThingTypes"][type]["TT_LIFEPOINTS"],
1076         "T_ARGUMENT": 0,
1077         "T_PROGRESS": 0,
1078         "T_SATIATION": 0,
1079         "T_COMMAND": 0,
1080         "T_TYPE": type,
1081         "T_POSY": pos[0],
1082         "T_POSX": pos[1],
1083         "T_CARRIES": [],
1084         "carried": False,
1085         "T_MEMTHING": [],
1086         "T_MEMMAP": False,
1087         "T_MEMDEPTHMAP": False,
1088         "fovmap": False
1089     }
1090     if world_db["WORLD_ACTIVE"] and thing["T_LIFEPOINTS"]:
1091         build_fov_map(thing)
1092     return thing
1093
1094
1095 def id_setter(id, category, id_store=False, start_at_1=False):
1096     """Set ID of object of category to manipulate ID unused? Create new one.
1097     The ID is stored as id_store.id (if id_store is set). If the integer of the
1098     input is valid (if start_at_1, >= 0, else >= -1), but <0 or (if start_at_1)
1099     <1, calculate new ID: lowest unused ID >=0 or (if start_at_1) >= 1. None is
1100     always returned when no new object is created, else the new object's ID.
1101     """
1102     min = 0 if start_at_1 else -1
1103     if str == type(id):
1104         id = integer_test(id, min)
1105     if None != id:
1106         if id in world_db[category]:
1107             if id_store:
1108                 id_store.id = id
1109             return None
1110         else:
1111             if (start_at_1 and 0 == id) \
1112                or ((not start_at_1) and (id < 0)):
1113                 id = 0 if start_at_1 else -1
1114                 while 1:
1115                     id = id + 1
1116                     if id not in world_db[category]:
1117                         break
1118             if id_store:
1119                 id_store.id = id
1120     return id
1121
1122
1123 def command_ping():
1124     """Send PONG line to server output file."""
1125     strong_write(io_db["file_out"], "PONG\n")
1126
1127
1128 def command_quit():
1129     """Abort server process."""
1130     if None == opts.replay:
1131         if world_db["WORLD_ACTIVE"]:
1132             save_world()
1133         atomic_write(io_db["path_record"], io_db["record_chunk"], do_append=True)
1134     raise SystemExit("received QUIT command")
1135
1136
1137 def command_thingshere(str_y, str_x):
1138     """Write to out file list of Things known to player at coordinate y, x."""
1139     if world_db["WORLD_ACTIVE"]:
1140         y = integer_test(str_y, 0, 255)
1141         x = integer_test(str_x, 0, 255)
1142         length = world_db["MAP_LENGTH"]
1143         if None != y and None != x and y < length and x < length:
1144             pos = (y * world_db["MAP_LENGTH"]) + x
1145             strong_write(io_db["file_out"], "THINGS_HERE START\n")
1146             if "v" == chr(world_db["Things"][0]["fovmap"][pos]):
1147                 for id in world_db["Things"]:
1148                     if y == world_db["Things"][id]["T_POSY"] \
1149                        and x == world_db["Things"][id]["T_POSX"] \
1150                        and not world_db["Things"][id]["carried"]:
1151                         type = world_db["Things"][id]["T_TYPE"]
1152                         name = world_db["ThingTypes"][type]["TT_NAME"]
1153                         strong_write(io_db["file_out"], name + "\n")
1154             else:
1155                 for mt in world_db["Things"][0]["T_MEMTHING"]:
1156                     if y == mt[1] and x == mt[2]:
1157                         name = world_db["ThingTypes"][mt[0]]["TT_NAME"]
1158                         strong_write(io_db["file_out"], name + "\n")
1159             strong_write(io_db["file_out"], "THINGS_HERE END\n")
1160         else:
1161             print("Ignoring: Invalid map coordinates.")
1162     else:
1163         print("Ignoring: Command only works on existing worlds.")
1164
1165
1166 def play_commander(action, args=False):
1167     """Setter for player's T_COMMAND and T_ARGUMENT, then calling turn_over().
1168
1169     T_ARGUMENT is set to direction char if action=="wait",or 8-bit int if args.
1170     """
1171
1172     def set_command():
1173         id = [x for x in world_db["ThingActions"]
1174               if world_db["ThingActions"][x]["TA_NAME"] == action][0]
1175         world_db["Things"][0]["T_COMMAND"] = id
1176         turn_over()
1177
1178     def set_command_and_argument_int(str_arg):
1179         val = integer_test(str_arg, 0, 255)
1180         if None != val:
1181             world_db["Things"][0]["T_ARGUMENT"] = val
1182             set_command()
1183
1184     def set_command_and_argument_movestring(str_arg):
1185         if str_arg in directions_db:
1186             world_db["Things"][0]["T_ARGUMENT"] = ord(directions_db[str_arg])
1187             set_command()
1188         else:
1189             print("Ignoring: Argument must be valid direction string.")
1190
1191     if action == "move":
1192         return set_command_and_argument_movestring
1193     elif args:
1194         return set_command_and_argument_int
1195     else:
1196         return set_command
1197
1198
1199 def command_seedrandomness(seed_string):
1200     """Set rand seed to int(seed_string)."""
1201     val = integer_test(seed_string, 0, 4294967295)
1202     if None != val:
1203         rand.seed = val
1204
1205
1206 def command_makeworld(seed_string):
1207     """(Re-)build game world, i.e. map, things, to a new turn 1 from seed.
1208
1209     Seed rand with seed. Do more only with a "wait" ThingAction and
1210     world["PLAYER_TYPE"] matching ThingType of TT_START_NUMBER > 0. Then,
1211     world_db["Things"] emptied, call make_map() and set
1212     world_db["WORLD_ACTIVE"], world_db["TURN"] to 1. Build new Things
1213     according to ThingTypes' TT_START_NUMBERS, with Thing of ID 0 to ThingType
1214     of ID = world["PLAYER_TYPE"]. Place Things randomly, and actors not on each
1215     other. Init player's memory map. Write "NEW_WORLD" line to out file.
1216     Call log_help().
1217     """
1218
1219     def free_pos():
1220         i = 0
1221         while 1:
1222             err = "Space to put thing on too hard to find. Map too small?"
1223             while 1:
1224                 y = rand.next() % world_db["MAP_LENGTH"]
1225                 x = rand.next() % world_db["MAP_LENGTH"]
1226                 if "." == chr(world_db["MAP"][y * world_db["MAP_LENGTH"] + x]):
1227                     break
1228                 i += 1
1229                 if i == 65535:
1230                     raise SystemExit(err)
1231             # Replica of C code, wrongly ignores animatedness of new Thing.
1232             pos_clear = (0 == len([id for id in world_db["Things"]
1233                                    if world_db["Things"][id]["T_LIFEPOINTS"]
1234                                    if world_db["Things"][id]["T_POSY"] == y
1235                                    if world_db["Things"][id]["T_POSX"] == x]))
1236             if pos_clear:
1237                 break
1238         return (y, x)
1239
1240     val = integer_test(seed_string, 0, 4294967295)
1241     if None == val:
1242         return
1243     rand.seed = val
1244     player_will_be_generated = False
1245     playertype = world_db["PLAYER_TYPE"]
1246     for ThingType in world_db["ThingTypes"]:
1247         if playertype == ThingType:
1248             if 0 < world_db["ThingTypes"][ThingType]["TT_START_NUMBER"]:
1249                 player_will_be_generated = True
1250             break
1251     if not player_will_be_generated:
1252         print("Ignoring: No player type with start number >0 defined.")
1253         return
1254     wait_action = False
1255     for ThingAction in world_db["ThingActions"]:
1256         if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
1257             wait_action = True
1258     if not wait_action:
1259         print("Ignoring beyond SEED_MAP: " +
1260               "No thing action with name 'wait' defined.")
1261         return
1262     world_db["Things"] = {}
1263     make_map()
1264     world_db["WORLD_ACTIVE"] = 1
1265     world_db["TURN"] = 1
1266     for i in range(world_db["ThingTypes"][playertype]["TT_START_NUMBER"]):
1267         id = id_setter(-1, "Things")
1268         world_db["Things"][id] = new_Thing(playertype, free_pos())
1269     if not world_db["Things"][0]["fovmap"]:
1270         empty_fovmap = bytearray(b" " * world_db["MAP_LENGTH"] ** 2)
1271         world_db["Things"][0]["fovmap"] = empty_fovmap
1272     update_map_memory(world_db["Things"][0])
1273     for type in world_db["ThingTypes"]:
1274         for i in range(world_db["ThingTypes"][type]["TT_START_NUMBER"]):
1275             if type != playertype:
1276                 id = id_setter(-1, "Things")
1277                 world_db["Things"][id] = new_Thing(type, free_pos())
1278     strong_write(io_db["file_out"], "NEW_WORLD\n")
1279     log_help()
1280
1281
1282 def command_maplength(maplength_string):
1283     """Redefine map length. Invalidate map, therefore lose all things on it."""
1284     val = integer_test(maplength_string, 1, 256)
1285     if None != val:
1286         world_db["MAP_LENGTH"] = val
1287         world_db["MAP"] = False
1288         set_world_inactive()
1289         world_db["Things"] = {}
1290         libpr.set_maplength(val)
1291
1292
1293 def command_worldactive(worldactive_string):
1294     """Toggle world_db["WORLD_ACTIVE"] if possible.
1295
1296     An active world can always be set inactive. An inactive world can only be
1297     set active with a "wait" ThingAction, and a player Thing (of ID 0), and a
1298     map. On activation, rebuild all Things' FOVs, and the player's map memory.
1299     Also call log_help().
1300     """
1301     val = integer_test(worldactive_string, 0, 1)
1302     if None != val:
1303         if 0 != world_db["WORLD_ACTIVE"]:
1304             if 0 == val:
1305                 set_world_inactive()
1306             else:
1307                 print("World already active.")
1308         elif 0 == world_db["WORLD_ACTIVE"]:
1309             wait_exists = False
1310             for ThingAction in world_db["ThingActions"]:
1311                 if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
1312                     wait_exists = True
1313                     break
1314             player_exists = False
1315             for Thing in world_db["Things"]:
1316                 if 0 == Thing:
1317                     player_exists = True
1318                     break
1319             if wait_exists and player_exists and world_db["MAP"]:
1320                 for id in world_db["Things"]:
1321                     if world_db["Things"][id]["T_LIFEPOINTS"]:
1322                         build_fov_map(world_db["Things"][id])
1323                         if 0 == id:
1324                             update_map_memory(world_db["Things"][id], False)
1325                 if not world_db["Things"][0]["T_LIFEPOINTS"]:
1326                     empty_fovmap = bytearray(b" " * world_db["MAP_LENGTH"] ** 2)
1327                     world_db["Things"][0]["fovmap"] = empty_fovmap
1328                 world_db["WORLD_ACTIVE"] = 1
1329                 log_help()
1330             else:
1331                 print("Ignoring: Not all conditions for world activation met.")
1332
1333
1334 def test_for_id_maker(object, category):
1335     """Return decorator testing for object having "id" attribute."""
1336     def decorator(f):
1337         def helper(*args):
1338             if hasattr(object, "id"):
1339                 f(*args)
1340             else:
1341                 print("Ignoring: No " + category +
1342                       " defined to manipulate yet.")
1343         return helper
1344     return decorator
1345
1346
1347 def command_tid(id_string):
1348     """Set ID of Thing to manipulate. ID unused? Create new one.
1349
1350     Default new Thing's type to the first available ThingType, others: zero.
1351     """
1352     id = id_setter(id_string, "Things", command_tid)
1353     if None != id:
1354         if world_db["ThingTypes"] == {}:
1355             print("Ignoring: No ThingType to settle new Thing in.")
1356             return
1357         type = list(world_db["ThingTypes"].keys())[0]
1358         world_db["Things"][id] = new_Thing(type)
1359
1360
1361 test_Thing_id = test_for_id_maker(command_tid, "Thing")
1362
1363
1364 @test_Thing_id
1365 def command_tcommand(str_int):
1366     """Set T_COMMAND of selected Thing."""
1367     val = integer_test(str_int, 0)
1368     if None != val:
1369         if 0 == val or val in world_db["ThingActions"]:
1370             world_db["Things"][command_tid.id]["T_COMMAND"] = val
1371         else:
1372             print("Ignoring: ThingAction ID belongs to no known ThingAction.")
1373
1374
1375 @test_Thing_id
1376 def command_ttype(str_int):
1377     """Set T_TYPE of selected Thing."""
1378     val = integer_test(str_int, 0)
1379     if None != val:
1380         if val in world_db["ThingTypes"]:
1381             world_db["Things"][command_tid.id]["T_TYPE"] = val
1382         else:
1383             print("Ignoring: ThingType ID belongs to no known ThingType.")
1384
1385
1386 @test_Thing_id
1387 def command_tcarries(str_int):
1388     """Append int(str_int) to T_CARRIES of selected Thing.
1389
1390     The ID int(str_int) must not be of the selected Thing, and must belong to a
1391     Thing with unset "carried" flag. Its "carried" flag will be set on owning.
1392     """
1393     val = integer_test(str_int, 0)
1394     if None != val:
1395         if val == command_tid.id:
1396             print("Ignoring: Thing cannot carry itself.")
1397         elif val in world_db["Things"] \
1398                 and not world_db["Things"][val]["carried"]:
1399             world_db["Things"][command_tid.id]["T_CARRIES"].append(val)
1400             world_db["Things"][val]["carried"] = True
1401         else:
1402             print("Ignoring: Thing not available for carrying.")
1403     # Note that the whole carrying structure is different from the C version:
1404     # Carried-ness is marked by a "carried" flag, not by Things containing
1405     # Things internally.
1406
1407
1408 @test_Thing_id
1409 def command_tmemthing(str_t, str_y, str_x):
1410     """Add (int(str_t), int(str_y), int(str_x)) to selected Thing's T_MEMTHING.
1411
1412     The type must fit to an existing ThingType, and the position into the map.
1413     """
1414     type = integer_test(str_t, 0)
1415     posy = integer_test(str_y, 0, 255)
1416     posx = integer_test(str_x, 0, 255)
1417     if None != type and None != posy and None != posx:
1418         if type not in world_db["ThingTypes"] \
1419            or posy >= world_db["MAP_LENGTH"] or posx >= world_db["MAP_LENGTH"]:
1420             print("Ignoring: Illegal value for thing type or position.")
1421         else:
1422             memthing = (type, posy, posx)
1423             world_db["Things"][command_tid.id]["T_MEMTHING"].append(memthing)
1424
1425
1426 def setter_map(maptype):
1427     """Set (world or Thing's) map of maptype's int(str_int)-th line to mapline.
1428
1429     If no map of maptype exists yet, initialize it with ' ' bytes first.
1430     """
1431
1432     def valid_map_line(str_int, mapline):
1433         val = integer_test(str_int, 0, 255)
1434         if None != val:
1435             if val >= world_db["MAP_LENGTH"]:
1436                 print("Illegal value for map line number.")
1437             elif len(mapline) != world_db["MAP_LENGTH"]:
1438                 print("Map line length is unequal map width.")
1439             else:
1440                 return val
1441         return None
1442
1443     def nonThingMap_helper(str_int, mapline):
1444         val = valid_map_line(str_int, mapline)
1445         if None != val:
1446             length = world_db["MAP_LENGTH"]
1447             if not world_db["MAP"]:
1448                 map = bytearray(b' ' * (length ** 2))
1449             else:
1450                 map = world_db["MAP"]
1451             map[val * length:(val * length) + length] = mapline.encode()
1452             if not world_db["MAP"]:
1453                 world_db["MAP"] = map
1454
1455     @test_Thing_id
1456     def ThingMap_helper(str_int, mapline):
1457         val = valid_map_line(str_int, mapline)
1458         if None != val:
1459             length = world_db["MAP_LENGTH"]
1460             if not world_db["Things"][command_tid.id][maptype]:
1461                 map = bytearray(b' ' * (length ** 2))
1462             else:
1463                 map = world_db["Things"][command_tid.id][maptype]
1464             map[val * length:(val * length) + length] = mapline.encode()
1465             if not world_db["Things"][command_tid.id][maptype]:
1466                 world_db["Things"][command_tid.id][maptype] = map
1467
1468     return nonThingMap_helper if maptype == "MAP" else ThingMap_helper
1469
1470
1471
1472 def setter_tpos(axis):
1473     """Generate setter for T_POSX or  T_POSY of selected Thing.
1474
1475     If world is active, rebuilds animate things' fovmap, player's memory map.
1476     """
1477     @test_Thing_id
1478     def helper(str_int):
1479         val = integer_test(str_int, 0, 255)
1480         if None != val:
1481             if val < world_db["MAP_LENGTH"]:
1482                 world_db["Things"][command_tid.id]["T_POS" + axis] = val
1483                 if world_db["WORLD_ACTIVE"] \
1484                    and world_db["Things"][command_tid.id]["T_LIFEPOINTS"]:
1485                     build_fov_map(world_db["Things"][command_tid.id])
1486                     if 0 == command_tid.id:
1487                         update_map_memory(world_db["Things"][command_tid.id])
1488             else:
1489                 print("Ignoring: Position is outside of map.")
1490     return helper
1491
1492
1493 def command_ttid(id_string):
1494     """Set ID of ThingType to manipulate. ID unused? Create new one.
1495
1496     Default new ThingType's TT_SYMBOL to "?", TT_CORPSE_ID to self, others: 0.
1497     """
1498     id = id_setter(id_string, "ThingTypes", command_ttid)
1499     if None != id:
1500         world_db["ThingTypes"][id] = {
1501             "TT_NAME": "(none)",
1502             "TT_CONSUMABLE": 0,
1503             "TT_LIFEPOINTS": 0,
1504             "TT_PROLIFERATE": 0,
1505             "TT_START_NUMBER": 0,
1506             "TT_SYMBOL": "?",
1507             "TT_CORPSE_ID": id
1508         }
1509
1510
1511 test_ThingType_id = test_for_id_maker(command_ttid, "ThingType")
1512
1513
1514 @test_ThingType_id
1515 def command_ttname(name):
1516     """Set TT_NAME of selected ThingType."""
1517     world_db["ThingTypes"][command_ttid.id]["TT_NAME"] = name
1518
1519
1520 @test_ThingType_id
1521 def command_ttsymbol(char):
1522     """Set TT_SYMBOL of selected ThingType. """
1523     if 1 == len(char):
1524         world_db["ThingTypes"][command_ttid.id]["TT_SYMBOL"] = char
1525     else:
1526         print("Ignoring: Argument must be single character.")
1527
1528
1529 @test_ThingType_id
1530 def command_ttcorpseid(str_int):
1531     """Set TT_CORPSE_ID of selected ThingType."""
1532     val = integer_test(str_int, 0)
1533     if None != val:
1534         if val in world_db["ThingTypes"]:
1535             world_db["ThingTypes"][command_ttid.id]["TT_CORPSE_ID"] = val
1536         else:
1537             print("Ignoring: Corpse ID belongs to no known ThignType.")
1538
1539
1540 def command_taid(id_string):
1541     """Set ID of ThingAction to manipulate. ID unused? Create new one.
1542
1543     Default new ThingAction's TA_EFFORT to 1, its TA_NAME to "wait".
1544     """
1545     id = id_setter(id_string, "ThingActions", command_taid, True)
1546     if None != id:
1547         world_db["ThingActions"][id] = {
1548             "TA_EFFORT": 1,
1549             "TA_NAME": "wait"
1550         }
1551
1552
1553 test_ThingAction_id = test_for_id_maker(command_taid, "ThingAction")
1554
1555
1556 @test_ThingAction_id
1557 def command_taname(name):
1558     """Set TA_NAME of selected ThingAction.
1559
1560     The name must match a valid thing action function. If after the name
1561     setting no ThingAction with name "wait" remains, call set_world_inactive().
1562     """
1563     if name == "wait" or name == "move" or name == "use" or name == "drop" \
1564        or name == "pick_up":
1565         world_db["ThingActions"][command_taid.id]["TA_NAME"] = name
1566         if 1 == world_db["WORLD_ACTIVE"]:
1567             wait_defined = False
1568             for id in world_db["ThingActions"]:
1569                 if "wait" == world_db["ThingActions"][id]["TA_NAME"]:
1570                     wait_defined = True
1571                     break
1572             if not wait_defined:
1573                 set_world_inactive()
1574     else:
1575         print("Ignoring: Invalid action name.")
1576     # In contrast to the original,naming won't map a function to a ThingAction.
1577
1578
1579 def command_ai():
1580     """Call ai() on player Thing, then turn_over()."""
1581     ai(world_db["Things"][0])
1582     turn_over()
1583
1584
1585 """Commands database.
1586
1587 Map command start tokens to ([0]) number of expected command arguments, ([1])
1588 the command's meta-ness (i.e. is it to be written to the record file, is it to
1589 be ignored in replay mode if read from server input file), and ([2]) a function
1590 to be called on it.
1591 """
1592 commands_db = {
1593     "QUIT": (0, True, command_quit),
1594     "PING": (0, True, command_ping),
1595     "THINGS_HERE": (2, True, command_thingshere),
1596     "MAKE_WORLD": (1, False, command_makeworld),
1597     "SEED_RANDOMNESS": (1, False, command_seedrandomness),
1598     "TURN": (1, False, setter(None, "TURN", 0, 65535)),
1599     "PLAYER_TYPE": (1, False, setter(None, "PLAYER_TYPE", 0)),
1600     "MAP_LENGTH": (1, False, command_maplength),
1601     "WORLD_ACTIVE": (1, False, command_worldactive),
1602     "MAP": (2, False, setter_map("MAP")),
1603     "TA_ID": (1, False, command_taid),
1604     "TA_EFFORT": (1, False, setter("ThingAction", "TA_EFFORT", 0, 255)),
1605     "TA_NAME": (1, False, command_taname),
1606     "TT_ID": (1, False, command_ttid),
1607     "TT_NAME": (1, False, command_ttname),
1608     "TT_SYMBOL": (1, False, command_ttsymbol),
1609     "TT_CORPSE_ID": (1, False, command_ttcorpseid),
1610     "TT_CONSUMABLE": (1, False, setter("ThingType", "TT_CONSUMABLE",
1611                                        0, 65535)),
1612     "TT_START_NUMBER": (1, False, setter("ThingType", "TT_START_NUMBER",
1613                                          0, 255)),
1614     "TT_PROLIFERATE": (1, False, setter("ThingType", "TT_PROLIFERATE",
1615                                         0, 255)),
1616     "TT_LIFEPOINTS": (1, False, setter("ThingType", "TT_LIFEPOINTS", 0, 255)),
1617     "T_ID": (1, False, command_tid),
1618     "T_ARGUMENT": (1, False, setter("Thing", "T_ARGUMENT", 0, 255)),
1619     "T_PROGRESS": (1, False, setter("Thing", "T_PROGRESS", 0, 255)),
1620     "T_LIFEPOINTS": (1, False, setter("Thing", "T_LIFEPOINTS", 0, 255)),
1621     "T_SATIATION": (1, False, setter("Thing", "T_SATIATION", -32768, 32767)),
1622     "T_COMMAND": (1, False, command_tcommand),
1623     "T_TYPE": (1, False, command_ttype),
1624     "T_CARRIES": (1, False, command_tcarries),
1625     "T_MEMMAP": (2, False, setter_map("T_MEMMAP")),
1626     "T_MEMDEPTHMAP": (2, False, setter_map("T_MEMDEPTHMAP")),
1627     "T_MEMTHING": (3, False, command_tmemthing),
1628     "T_POSY": (1, False, setter_tpos("Y")),
1629     "T_POSX": (1, False, setter_tpos("X")),
1630     "wait": (0, False, play_commander("wait")),
1631     "move": (1, False, play_commander("move")),
1632     "pick_up": (0, False, play_commander("pick_up")),
1633     "drop": (1, False, play_commander("drop", True)),
1634     "use": (1, False, play_commander("use", True)),
1635     "ai": (0, False, command_ai)
1636 }
1637 # TODO: Unhandled cases: (Un-)killing animates (esp. player!) with T_LIFEPOINTS.
1638
1639
1640 """World state database. With sane default values. (Randomness is in rand.)"""
1641 world_db = {
1642     "TURN": 0,
1643     "MAP_LENGTH": 64,
1644     "PLAYER_TYPE": 0,
1645     "WORLD_ACTIVE": 0,
1646     "MAP": False,
1647     "ThingActions": {},
1648     "ThingTypes": {},
1649     "Things": {}
1650 }
1651
1652 """Mapping of direction names to internal direction chars."""
1653 directions_db = {"east": "d", "south-east": "c", "south-west": "x",
1654                  "west": "s", "north-west": "w", "north-east": "e"}
1655
1656 """File IO database."""
1657 io_db = {
1658     "path_save": "save",
1659     "path_record": "record_save",
1660     "path_worldconf": "confserver/world",
1661     "path_server": "server/",
1662     "path_in": "server/in",
1663     "path_out": "server/out",
1664     "path_worldstate": "server/worldstate",
1665     "tmp_suffix": "_tmp",
1666     "kicked_by_rival": False,
1667     "worldstate_updateable": False
1668 }
1669
1670
1671 try:
1672     libpr = prep_library()
1673     rand = RandomnessIO()
1674     opts = parse_command_line_arguments()
1675     if opts.savefile:
1676         io_db["path_save"] = opts.savefile
1677         io_db["path_record"] = "record_" + opts.savefile
1678     setup_server_io()
1679     if opts.verbose:
1680         io_db["verbose"] = True
1681     if None != opts.replay:
1682         replay_game()
1683     else:
1684         play_game()
1685 except SystemExit as exit:
1686     print("ABORTING: " + exit.args[0])
1687 except:
1688     print("SOMETHING WENT WRONG IN UNEXPECTED WAYS")
1689     raise
1690 finally:
1691     cleanup_server_io()