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