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