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