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