home · contact · privacy
Server: Refactor command_taname.
[plomrogue] / server / commands.py
1 # This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
2 # or any later version. For details on its copyright, license, and warranties,
3 # see the file NOTICE in the root directory of the PlomRogue source package.
4
5
6 from server.config.world_data import world_db
7 from server.config.io import io_db
8 from server.io import log, strong_write 
9 from server.utils import integer_test, id_setter
10 from server.world import set_world_inactive, turn_over
11 from server.update_map_memory import update_map_memory
12 from server.build_fov_map import build_fov_map
13
14
15 def command_plugin(str_plugin):
16     """Run code in plugins/[str_plugin]."""
17     import os
18     if (str_plugin.replace("_", "").isalnum()
19         and os.access("plugins/server/" + str_plugin + ".py", os.F_OK)):
20         exec(open("plugins/server/" + str_plugin + ".py").read())
21         world_db["PLUGIN"] += [str_plugin]
22         return
23     print("Bad plugin name:", str_plugin)
24
25
26 def command_ping():
27     """Send PONG line to server output file."""
28     strong_write(io_db["file_out"], "PONG\n")
29
30
31 def command_quit():
32     """Abort server process."""
33     from server.io import save_world, atomic_write
34     from server.utils import opts
35     if None == opts.replay:
36         if world_db["WORLD_ACTIVE"]:
37             save_world()
38         atomic_write(io_db["path_record"], io_db["record_chunk"],
39             do_append=True)
40     raise SystemExit("received QUIT command")
41
42
43 def command_thingshere(str_y, str_x):
44     """Write to out file list of Things known to player at coordinate y, x."""
45     if world_db["WORLD_ACTIVE"]:
46         y = integer_test(str_y, 0, 255)
47         x = integer_test(str_x, 0, 255)
48         length = world_db["MAP_LENGTH"]
49         if None != y and None != x and y < length and x < length:
50             pos = (y * world_db["MAP_LENGTH"]) + x
51             strong_write(io_db["file_out"], "THINGS_HERE START\n")
52             terrain = chr(world_db["Things"][0]["T_MEMMAP"][pos])
53             terrain_name = world_db["terrain_names"][terrain]
54             strong_write(io_db["file_out"], "terrain: " + terrain_name + "\n")
55             if "v" == chr(world_db["Things"][0]["fovmap"][pos]):
56                 for id in [id for tid in sorted(list(world_db["ThingTypes"]))
57                               for id in world_db["Things"]
58                               if not world_db["Things"][id]["carried"]
59                               if world_db["Things"][id]["T_TYPE"] == tid
60                               if y == world_db["Things"][id]["T_POSY"]
61                               if x == world_db["Things"][id]["T_POSX"]]:
62                     type = world_db["Things"][id]["T_TYPE"]
63                     name = world_db["ThingTypes"][type]["TT_NAME"]
64                     strong_write(io_db["file_out"], name + "\n")
65             else:
66                 for mt in [mt for tid in sorted(list(world_db["ThingTypes"]))
67                               for mt in world_db["Things"][0]["T_MEMTHING"]
68                               if mt[0] == tid if y == mt[1] if x == mt[2]]:
69                     name = world_db["ThingTypes"][mt[0]]["TT_NAME"]
70                     strong_write(io_db["file_out"], name + "\n")
71             strong_write(io_db["file_out"], "THINGS_HERE END\n")
72         else:
73             print("Ignoring: Invalid map coordinates.")
74     else:
75         print("Ignoring: Command only works on existing worlds.")
76
77
78 def command_seedrandomness(seed_string):
79     """Set rand seed to int(seed_string)."""
80     from server.utils import rand
81     val = integer_test(seed_string, 0, 4294967295)
82     if None != val:
83         rand.seed = val
84
85
86 def command_makeworld(seed_string):
87     """Call make_world()."""
88     val = integer_test(seed_string, 0, 4294967295)
89     if None != val:
90         from server.config.misc import make_world_func
91         make_world_func(val)
92
93
94 def command_maplength(maplength_string):
95     """Redefine map length. Invalidate map, therefore lose all things on it."""
96     val = integer_test(maplength_string, 1, 256)
97     if None != val:
98         from server.utils import libpr
99         world_db["MAP_LENGTH"] = val
100         world_db["MAP"] = False
101         set_world_inactive()
102         world_db["Things"] = {}
103         libpr.set_maplength(val)
104
105
106 def command_worldactive(worldactive_string):
107     """Toggle world_db["WORLD_ACTIVE"] if possible.
108
109     An active world can always be set inactive. An inactive world can only be
110     set active with a "wait" ThingAction, and a player Thing (of ID 0), and a
111     map. On activation, rebuild all Things' FOVs, and the player's map memory.
112     """
113     val = integer_test(worldactive_string, 0, 1)
114     if None != val:
115         if 0 != world_db["WORLD_ACTIVE"]:
116             if 0 == val:
117                 set_world_inactive()
118             else:
119                 print("World already active.")
120         elif 0 == world_db["WORLD_ACTIVE"]:
121             for ThingAction in world_db["ThingActions"]:
122                 if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
123                     break
124             else:
125                 print("Ignored: No wait action defined for world to activate.")
126                 return
127             for Thing in world_db["Things"]:
128                 if 0 == Thing:
129                     break
130             else:
131                 print("Ignored: No player defined for world to activate.")
132                 return
133             if world_db["MAP"]:
134                 for id in world_db["Things"]:
135                     if world_db["Things"][id]["T_LIFEPOINTS"]:
136                         build_fov_map(world_db["Things"][id])
137                         if 0 == id:
138                             update_map_memory(world_db["Things"][id], False)
139                 if not world_db["Things"][0]["T_LIFEPOINTS"]:
140                     empty_fovmap = bytearray(b" " * world_db["MAP_LENGTH"] ** 2)
141                     world_db["Things"][0]["fovmap"] = empty_fovmap
142                 world_db["WORLD_ACTIVE"] = 1
143             else:
144                 print("Ignoring: No map defined for world to activate.")
145
146
147 def command_tid(id_string):
148     """Set ID of Thing to manipulate. ID unused? Create new one.
149
150     Default new Thing's type to the first available ThingType, others: zero.
151     """
152     id = id_setter(id_string, "Things", command_tid)
153     if None != id:
154         if world_db["ThingTypes"] == {}:
155             print("Ignoring: No ThingType to settle new Thing in.")
156             return
157         type = list(world_db["ThingTypes"].keys())[0]
158         from server.new_thing import new_Thing
159         world_db["Things"][id] = new_Thing(type)
160
161
162 def command_ttid(id_string):
163     """Set ID of ThingType to manipulate. ID unused? Create new one.
164
165     Default new ThingType's TT_SYMBOL to "?", TT_CORPSE_ID to self, TT_TOOL to
166     "", others: 0. 
167     """
168     id = id_setter(id_string, "ThingTypes", command_ttid)
169     if None != id:
170         world_db["ThingTypes"][id] = {
171             "TT_NAME": "(none)",
172             "TT_TOOLPOWER": 0,
173             "TT_LIFEPOINTS": 0,
174             "TT_PROLIFERATE": 0,
175             "TT_START_NUMBER": 0,
176             "TT_SYMBOL": "?",
177             "TT_CORPSE_ID": id,
178             "TT_TOOL": ""
179         }
180
181
182 def command_taid(id_string):
183     """Set ID of ThingAction to manipulate. ID unused? Create new one.
184
185     Default new ThingAction's TA_EFFORT to 1, its TA_NAME to "wait".
186     """
187     id = id_setter(id_string, "ThingActions", command_taid, True)
188     if None != id:
189         world_db["ThingActions"][id] = {
190             "TA_EFFORT": 1,
191             "TA_NAME": "wait"
192         }
193
194
195 def test_for_id_maker(object, category):
196     """Return decorator testing for object having "id" attribute."""
197     def decorator(f):
198         def helper(*args):
199             if hasattr(object, "id"):
200                 f(*args)
201             else:
202                 print("Ignoring: No " + category +
203                       " defined to manipulate yet.")
204         return helper
205     return decorator
206
207
208 test_Thing_id = test_for_id_maker(command_tid, "Thing")
209 test_ThingType_id = test_for_id_maker(command_ttid, "ThingType")
210 test_ThingAction_id = test_for_id_maker(command_taid, "ThingAction")
211
212
213 @test_Thing_id
214 def command_tcommand(str_int):
215     """Set T_COMMAND of selected Thing."""
216     val = integer_test(str_int, 0)
217     if None != val:
218         if 0 == val or val in world_db["ThingActions"]:
219             world_db["Things"][command_tid.id]["T_COMMAND"] = val
220         else:
221             print("Ignoring: ThingAction ID belongs to no known ThingAction.")
222
223
224 @test_Thing_id
225 def command_ttype(str_int):
226     """Set T_TYPE of selected Thing."""
227     val = integer_test(str_int, 0)
228     if None != val:
229         if val in world_db["ThingTypes"]:
230             world_db["Things"][command_tid.id]["T_TYPE"] = val
231         else:
232             print("Ignoring: ThingType ID belongs to no known ThingType.")
233
234
235 @test_Thing_id
236 def command_tcarries(str_int):
237     """Append int(str_int) to T_CARRIES of selected Thing.
238
239     The ID int(str_int) must not be of the selected Thing, and must belong to a
240     Thing with unset "carried" flag. Its "carried" flag will be set on owning.
241     """
242     val = integer_test(str_int, 0)
243     if None != val:
244         if val == command_tid.id:
245             print("Ignoring: Thing cannot carry itself.")
246         elif val in world_db["Things"] \
247                 and not world_db["Things"][val]["carried"]:
248             world_db["Things"][command_tid.id]["T_CARRIES"].append(val)
249             world_db["Things"][val]["carried"] = True
250         else:
251             print("Ignoring: Thing not available for carrying.")
252     # Note that the whole carrying structure is different from the C version:
253     # Carried-ness is marked by a "carried" flag, not by Things containing
254     # Things internally.
255
256
257 @test_Thing_id
258 def command_tmemthing(str_t, str_y, str_x):
259     """Add (int(str_t), int(str_y), int(str_x)) to selected Thing's T_MEMTHING.
260
261     The type must fit to an existing ThingType, and the position into the map.
262     """
263     type = integer_test(str_t, 0)
264     posy = integer_test(str_y, 0, 255)
265     posx = integer_test(str_x, 0, 255)
266     if None != type and None != posy and None != posx:
267         if type not in world_db["ThingTypes"] \
268            or posy >= world_db["MAP_LENGTH"] or posx >= world_db["MAP_LENGTH"]:
269             print("Ignoring: Illegal value for thing type or position.")
270         else:
271             memthing = (type, posy, posx)
272             world_db["Things"][command_tid.id]["T_MEMTHING"].append(memthing)
273
274
275 @test_ThingType_id
276 def command_ttname(name):
277     """Set TT_NAME of selected ThingType."""
278     world_db["ThingTypes"][command_ttid.id]["TT_NAME"] = name
279
280
281 @test_ThingType_id
282 def command_tttool(name):
283     """Set TT_TOOL of selected ThingType."""
284     world_db["ThingTypes"][command_ttid.id]["TT_TOOL"] = name
285
286
287 @test_ThingType_id
288 def command_ttsymbol(char):
289     """Set TT_SYMBOL of selected ThingType. """
290     if 1 == len(char):
291         world_db["ThingTypes"][command_ttid.id]["TT_SYMBOL"] = char
292     else:
293         print("Ignoring: Argument must be single character.")
294
295
296 @test_ThingType_id
297 def command_ttcorpseid(str_int):
298     """Set TT_CORPSE_ID of selected ThingType."""
299     val = integer_test(str_int, 0)
300     if None != val:
301         if val in world_db["ThingTypes"]:
302             world_db["ThingTypes"][command_ttid.id]["TT_CORPSE_ID"] = val
303         else:
304             print("Ignoring: Corpse ID belongs to no known ThignType.")
305
306
307 @test_ThingAction_id
308 def command_taname(name):
309     """Set TA_NAME of selected ThingAction.
310
311     The name must match a valid thing action function. If after the name
312     setting no ThingAction with name "wait" remains, call set_world_inactive().
313     """
314     if name == "wait" or name == "move" or name == "use" or name == "drop" \
315        or name == "pickup":
316         world_db["ThingActions"][command_taid.id]["TA_NAME"] = name
317         if 1 == world_db["WORLD_ACTIVE"]:
318             for id in world_db["ThingActions"]:
319                 if "wait" == world_db["ThingActions"][id]["TA_NAME"]:
320                     break
321             else:
322                 set_world_inactive()
323     else:
324         print("Ignoring: Invalid action name.")
325
326
327 def setter(category, key, min, max=None):
328     """Build setter for world_db([category + "s"][id])[key] to >=min/<=max."""
329     if category is None:
330         def f(val_string):
331             val = integer_test(val_string, min, max)
332             if None != val:
333                 world_db[key] = val
334     else:
335         if category == "Thing":
336             id_store = command_tid
337             decorator = test_Thing_id
338         elif category == "ThingType":
339             id_store = command_ttid
340             decorator = test_ThingType_id
341         elif category == "ThingAction":
342             id_store = command_taid
343             decorator = test_ThingAction_id
344
345         @decorator
346         def f(val_string):
347             val = integer_test(val_string, min, max)
348             if None != val:
349                 world_db[category + "s"][id_store.id][key] = val
350     return f
351
352
353 def setter_map(maptype):
354     """Set (world or Thing's) map of maptype's int(str_int)-th line to mapline.
355
356     If no map of maptype exists yet, initialize it with ' ' bytes first.
357     """
358
359     def valid_map_line(str_int, mapline):
360         val = integer_test(str_int, 0, 255)
361         if None != val:
362             if val >= world_db["MAP_LENGTH"]:
363                 print("Illegal value for map line number.")
364             elif len(mapline) != world_db["MAP_LENGTH"]:
365                 print("Map line length is unequal map width.")
366             else:
367                 return val
368         return None
369
370     def nonThingMap_helper(str_int, mapline):
371         val = valid_map_line(str_int, mapline)
372         if None != val:
373             length = world_db["MAP_LENGTH"]
374             if not world_db["MAP"]:
375                 map = bytearray(b' ' * (length ** 2))
376             else:
377                 map = world_db["MAP"]
378             map[val * length:(val * length) + length] = mapline.encode()
379             if not world_db["MAP"]:
380                 world_db["MAP"] = map
381
382     @test_Thing_id
383     def ThingMap_helper(str_int, mapline):
384         val = valid_map_line(str_int, mapline)
385         if None != val:
386             length = world_db["MAP_LENGTH"]
387             if not world_db["Things"][command_tid.id][maptype]:
388                 map = bytearray(b' ' * (length ** 2))
389             else:
390                 map = world_db["Things"][command_tid.id][maptype]
391             map[val * length:(val * length) + length] = mapline.encode()
392             if not world_db["Things"][command_tid.id][maptype]:
393                 world_db["Things"][command_tid.id][maptype] = map
394
395     return nonThingMap_helper if maptype == "MAP" else ThingMap_helper
396
397
398
399 def setter_tpos(axis):
400     """Generate setter for T_POSX or  T_POSY of selected Thing.
401
402     If world is active, rebuilds animate things' fovmap, player's memory map.
403     """
404     @test_Thing_id
405     def helper(str_int):
406         val = integer_test(str_int, 0, 255)
407         if None != val:
408             if val < world_db["MAP_LENGTH"]:
409                 world_db["Things"][command_tid.id]["T_POS" + axis] = val
410                 if world_db["WORLD_ACTIVE"] \
411                    and world_db["Things"][command_tid.id]["T_LIFEPOINTS"]:
412                     build_fov_map(world_db["Things"][command_tid.id])
413                     if 0 == command_tid.id:
414                         update_map_memory(world_db["Things"][command_tid.id])
415             else:
416                 print("Ignoring: Position is outside of map.")
417     return helper
418
419
420 def set_command(action):
421     """Set player's T_COMMAND, then call turn_over()."""
422     id = [x for x in world_db["ThingActions"]
423           if world_db["ThingActions"][x]["TA_NAME"] == action][0]
424     world_db["Things"][0]["T_COMMAND"] = id
425     turn_over()
426
427
428 def play_wait():
429     """Try "wait" as player's T_COMMAND."""
430     set_command("wait")
431
432
433 def action_exists(action):
434     matching_actions = [x for x in world_db["ThingActions"]
435                         if world_db["ThingActions"][x]["TA_NAME"] == action]
436     if len(matching_actions) >= 1:
437         return True
438     print("No appropriate ThingAction defined.")
439     return False
440
441
442 def play_pickup():
443     """Try "pickup" as player's T_COMMAND"."""
444     if action_exists("pickup"):
445         t = world_db["Things"][0]
446         ids = [id for id in world_db["Things"] if id
447                if not world_db["Things"][id]["carried"]
448                if world_db["Things"][id]["T_POSY"] == t["T_POSY"]
449                if world_db["Things"][id]["T_POSX"] == t["T_POSX"]]
450         if not len(ids):
451              log("NOTHING to pick up.")
452         else:
453             set_command("pickup")
454
455
456 def play_drop(str_arg):
457     """Try "drop" as player's T_COMMAND, int(str_arg) as T_ARGUMENT / slot."""
458     if action_exists("drop"):
459         t = world_db["Things"][0]
460         if 0 == len(t["T_CARRIES"]):
461             log("You have NOTHING to drop in your inventory.")
462         else:
463             val = integer_test(str_arg, 0, 255)
464             if None != val and val < len(t["T_CARRIES"]):
465                 world_db["Things"][0]["T_ARGUMENT"] = val
466                 set_command("drop")
467             else:
468                 print("Illegal inventory index.")
469
470
471 def play_use(str_arg):
472     """Try "use" as player's T_COMMAND, int(str_arg) as T_ARGUMENT / slot."""
473     if action_exists("use"):
474         t = world_db["Things"][0]
475         if 0 == len(t["T_CARRIES"]):
476             log("You have NOTHING to use in your inventory.")
477         else:
478             val = integer_test(str_arg, 0, 255)
479             if None != val and val < len(t["T_CARRIES"]):
480                 id = t["T_CARRIES"][val]
481                 type = world_db["Things"][id]["T_TYPE"]
482                 if not world_db["ThingTypes"][type]["TT_TOOL"] == "food":
483                     log("You CAN'T consume this thing.")
484                     return
485                 world_db["Things"][0]["T_ARGUMENT"] = val
486                 set_command("use")
487             else:
488                 print("Illegal inventory index.")
489
490
491 def play_move(str_arg):
492     """Try "move" as player's T_COMMAND, str_arg as T_ARGUMENT / direction."""
493     if action_exists("move"):
494         from server.config.world_data import directions_db, symbols_passable
495         t = world_db["Things"][0]
496         if not str_arg in directions_db:
497             print("Illegal move direction string.")
498             return
499         dir = ord(directions_db[str_arg])
500         from server.utils import mv_yx_in_dir_legal
501         move_result = mv_yx_in_dir_legal(chr(dir), t["T_POSY"], t["T_POSX"])
502         if 1 == move_result[0]:
503             pos = (move_result[1] * world_db["MAP_LENGTH"]) + move_result[2]
504             if ord("~") == world_db["MAP"][pos]:
505                 log("You can't SWIM.")
506                 return
507             if chr(world_db["MAP"][pos]) in symbols_passable:
508                 world_db["Things"][0]["T_ARGUMENT"] = dir
509                 set_command("move")
510                 return
511         log("You CAN'T move there.")
512
513
514 def command_ai():
515     """Call ai() on player Thing, then turn_over()."""
516     from server.config.actions import ai_func
517     ai_func(world_db["Things"][0])
518     turn_over()