home · contact · privacy
Make curses client PING.
[plomrogue2-experiments] / new2 / rogue_chat_curses.py
1 #!/usr/bin/env python3
2 import curses
3 import queue
4 import threading
5 from plomrogue.game import GameBase
6 from plomrogue.parser import Parser
7 from plomrogue.mapping import YX, MapGeometrySquare, MapGeometryHex
8 from plomrogue.things import ThingBase
9 from plomrogue.misc import quote
10 from plomrogue.errors import BrokenSocketConnection
11
12 from ws4py.client import WebSocketBaseClient
13 class WebSocketClient(WebSocketBaseClient):
14
15     def __init__(self, recv_handler, *args, **kwargs):
16         super().__init__(*args, **kwargs)
17         self.recv_handler = recv_handler
18         self.connect()
19
20     def received_message(self, message):
21         if message.is_text:
22             message = str(message)
23             self.recv_handler(message)
24
25     @property
26     def plom_closed(self):
27         return self.client_terminated
28
29 from plomrogue.io_tcp import PlomSocket
30 class PlomSocketClient(PlomSocket):
31
32     def __init__(self, recv_handler, url):
33         import socket
34         self.recv_handler = recv_handler
35         host, port = url.split(':')
36         super().__init__(socket.create_connection((host, port)))
37
38     def close(self):
39         self.socket.close()
40
41     def run(self):
42         try:
43             for msg in self.recv():
44                 self.recv_handler(msg)
45         except BrokenSocketConnection:
46             pass  # we assume socket will be known as dead by now
47
48 def cmd_TURN(game, n):
49     game.turn = n
50     game.things = []
51     game.portals = {}
52     game.turn_complete = False
53 cmd_TURN.argtypes = 'int:nonneg'
54
55 def cmd_LOGIN_OK(game):
56     game.tui.switch_mode('post_login_wait')
57     game.tui.send('GET_GAMESTATE')
58     game.tui.log_msg('@ welcome')
59 cmd_LOGIN_OK.argtypes = ''
60
61 def cmd_CHAT(game, msg):
62     game.tui.log_msg('# ' + msg)
63     game.tui.do_refresh = True
64 cmd_CHAT.argtypes = 'string'
65
66 def cmd_PLAYER_ID(game, player_id):
67     game.player_id = player_id
68 cmd_PLAYER_ID.argtypes = 'int:nonneg'
69
70 def cmd_THING_POS(game, thing_id, position):
71     t = game.get_thing(thing_id, True)
72     t.position = position
73 cmd_THING_POS.argtypes = 'int:nonneg yx_tuple:nonneg'
74
75 def cmd_THING_NAME(game, thing_id, name):
76     t = game.get_thing(thing_id, True)
77     t.name = name
78 cmd_THING_NAME.argtypes = 'int:nonneg string'
79
80 def cmd_MAP(game, geometry, size, content):
81     map_geometry_class = globals()['MapGeometry' + geometry]
82     game.map_geometry = map_geometry_class(size)
83     game.map_content = content
84     if type(game.map_geometry) == MapGeometrySquare:
85         game.tui.movement_keys = {
86             game.tui.keys['square_move_up']: 'UP',
87             game.tui.keys['square_move_left']: 'LEFT',
88             game.tui.keys['square_move_down']: 'DOWN',
89             game.tui.keys['square_move_right']: 'RIGHT',
90         }
91     elif type(game.map_geometry) == MapGeometryHex:
92         game.tui.movement_keys = {
93             game.tui.keys['hex_move_upleft']: 'UPLEFT',
94             game.tui.keys['hex_move_upright']: 'UPRIGHT',
95             game.tui.keys['hex_move_right']: 'RIGHT',
96             game.tui.keys['hex_move_downright']: 'DOWNRIGHT',
97             game.tui.keys['hex_move_downleft']: 'DOWNLEFT',
98             game.tui.keys['hex_move_left']: 'LEFT',
99         }
100 cmd_MAP.argtypes = 'string:map_geometry yx_tuple:pos string'
101
102 def cmd_GAME_STATE_COMPLETE(game):
103     game.info_db = {}
104     if game.tui.mode.name == 'post_login_wait':
105         game.tui.switch_mode('play')
106         game.tui.help()
107     if game.tui.mode.shows_info:
108         game.tui.query_info()
109     player = game.get_thing(game.player_id, False)
110     if player.position in game.portals:
111         game.tui.teleport_target_host = game.portals[player.position]
112         game.tui.switch_mode('teleport')
113     game.turn_complete = True
114     game.tui.do_refresh = True
115 cmd_GAME_STATE_COMPLETE.argtypes = ''
116
117 def cmd_PORTAL(game, position, msg):
118     game.portals[position] = msg
119 cmd_PORTAL.argtypes = 'yx_tuple:nonneg string'
120
121 def cmd_PLAY_ERROR(game, msg):
122     game.tui.flash()
123     game.tui.do_refresh = True
124 cmd_PLAY_ERROR.argtypes = 'string'
125
126 def cmd_GAME_ERROR(game, msg):
127     game.tui.log_msg('? game error: ' + msg)
128     game.tui.do_refresh = True
129 cmd_GAME_ERROR.argtypes = 'string'
130
131 def cmd_ARGUMENT_ERROR(game, msg):
132     game.tui.log_msg('? syntax error: ' + msg)
133     game.tui.do_refresh = True
134 cmd_ARGUMENT_ERROR.argtypes = 'string'
135
136 def cmd_ANNOTATION(game, position, msg):
137     game.info_db[position] = msg
138     if game.tui.mode.shows_info:
139         game.tui.do_refresh = True
140 cmd_ANNOTATION.argtypes = 'yx_tuple:nonneg string'
141
142 def cmd_PONG(game):
143     pass
144 cmd_PONG.argtypes = ''
145
146 class Game(GameBase):
147     commands = {'LOGIN_OK': cmd_LOGIN_OK,
148                 'PONG': cmd_PONG,
149                 'CHAT': cmd_CHAT,
150                 'PLAYER_ID': cmd_PLAYER_ID,
151                 'TURN': cmd_TURN,
152                 'THING_POS': cmd_THING_POS,
153                 'THING_NAME': cmd_THING_NAME,
154                 'MAP': cmd_MAP,
155                 'PORTAL': cmd_PORTAL,
156                 'ANNOTATION': cmd_ANNOTATION,
157                 'GAME_STATE_COMPLETE': cmd_GAME_STATE_COMPLETE,
158                 'ARGUMENT_ERROR': cmd_ARGUMENT_ERROR,
159                 'GAME_ERROR': cmd_GAME_ERROR,
160                 'PLAY_ERROR': cmd_PLAY_ERROR}
161     thing_type = ThingBase
162     turn_complete = False
163
164     def __init__(self, *args, **kwargs):
165         super().__init__(*args, **kwargs)
166         self.map_content = ''
167         self.player_id = -1
168         self.info_db = {}
169         self.portals = {}
170
171     def get_string_options(self, string_option_type):
172         if string_option_type == 'map_geometry':
173             return ['Hex', 'Square']
174         return None
175
176     def get_command(self, command_name):
177         from functools import partial
178         f = partial(self.commands[command_name], self)
179         f.argtypes = self.commands[command_name].argtypes
180         return f
181
182 class TUI:
183
184     class Mode:
185
186         def __init__(self, name, has_input_prompt=False, shows_info=False,
187                      is_intro = False):
188             self.name = name
189             self.has_input_prompt = has_input_prompt
190             self.shows_info = shows_info
191             self.is_intro = is_intro
192
193     def __init__(self, host):
194         import os
195         import json
196         self.host = host
197         self.mode_play = self.Mode('play')
198         self.mode_study = self.Mode('study', shows_info=True)
199         self.mode_edit = self.Mode('edit')
200         self.mode_annotate = self.Mode('annotate', has_input_prompt=True, shows_info=True)
201         self.mode_portal = self.Mode('portal', has_input_prompt=True, shows_info=True)
202         self.mode_chat = self.Mode('chat', has_input_prompt=True)
203         self.mode_waiting_for_server = self.Mode('waiting_for_server', is_intro=True)
204         self.mode_login = self.Mode('login', has_input_prompt=True, is_intro=True)
205         self.mode_post_login_wait = self.Mode('post_login_wait', is_intro=True)
206         self.mode_teleport = self.Mode('teleport', has_input_prompt=True)
207         self.game = Game()
208         self.game.tui = self
209         self.parser = Parser(self.game)
210         self.log = []
211         self.do_refresh = True
212         self.queue = queue.Queue()
213         self.login_name = None
214         self.switch_mode('waiting_for_server')
215         self.keys = {
216             'switch_to_chat': 't',
217             'switch_to_play': 'p',
218             'switch_to_annotate': 'm',
219             'switch_to_portal': 'P',
220             'switch_to_study': '?',
221             'switch_to_edit': 'm',
222             'flatten': 'F',
223             'hex_move_upleft': 'w',
224             'hex_move_upright': 'e',
225             'hex_move_right': 'd',
226             'hex_move_downright': 'x',
227             'hex_move_downleft': 'y',
228             'hex_move_left': 'a',
229             'square_move_up': 'w',
230             'square_move_left': 'a',
231             'square_move_down': 's',
232             'square_move_right': 'd',
233         }
234         if os.path.isfile('config.json'):
235             with open('config.json', 'r') as f:
236                 keys_conf = json.loads(f.read())
237             for k in keys_conf:
238                 self.keys[k] = keys_conf[k]
239         curses.wrapper(self.loop)
240
241     def flash(self):
242         curses.flash()
243
244     def send(self, msg):
245         try:
246             if hasattr(self.socket, 'plom_closed') and self.socket.plom_closed:
247                 raise BrokenSocketConnection
248             self.socket.send(msg)
249         except (BrokenPipeError, BrokenSocketConnection):
250             self.log_msg('@ server disconnected :(')
251             self.do_refresh = True
252
253     def log_msg(self, msg):
254         self.log += [msg]
255         if len(self.log) > 100:
256             self.log = self.log[-100:]
257
258     def query_info(self):
259         self.send('GET_ANNOTATION ' + str(self.explorer))
260
261     def switch_mode(self, mode_name, keep_position = False):
262         self.mode = getattr(self, 'mode_' + mode_name)
263         if self.mode.shows_info and not keep_position:
264             player = self.game.get_thing(self.game.player_id, False)
265             self.explorer = YX(player.position.y, player.position.x)
266         if self.mode.name == 'waiting_for_server':
267             self.log_msg('@ waiting for server …')
268         elif self.mode.name == 'login':
269             if self.login_name:
270                 self.send('LOGIN ' + quote(self.login_name))
271             else:
272                 self.log_msg('@ enter username')
273         elif self.mode.name == 'teleport':
274             self.log_msg("@ May teleport to %s" % (self.teleport_target_host)),
275             self.log_msg("@ Enter 'YES!' to enthusiastically affirm.");
276         elif self.mode.name == 'annotate' and self.explorer in self.game.info_db:
277             info = self.game.info_db[self.explorer]
278             if info != '(none)':
279                 self.input_ = info
280         elif self.mode.name == 'portal' and self.explorer in self.game.portals:
281             self.input_ = self.game.portals[self.explorer]
282
283     def help(self):
284         self.log_msg("HELP:");
285         self.log_msg("chat mode commands:");
286         self.log_msg("  /nick NAME - re-name yourself to NAME");
287         self.log_msg("  /msg USER TEXT - send TEXT to USER");
288         self.log_msg("  /help - show this help");
289         self.log_msg("  /%s or /play - switch to play mode" % self.keys['switch_to_play']);
290         self.log_msg("  /%s or /study - switch to study mode" % self.keys['switch_to_study']);
291         self.log_msg("commands common to study and play mode:");
292         self.log_msg("  %s - move" % ','.join(self.movement_keys));
293         self.log_msg("  %s - switch to chat mode" % self.keys['switch_to_chat']);
294         self.log_msg("commands specific to play mode:");
295         self.log_msg("  %s - write following ASCII character" % self.keys['switch_to_edit']);
296         self.log_msg("  %s - flatten surroundings" % self.keys['flatten']);
297         self.log_msg("  %s - switch to study mode" % self.keys['switch_to_study']);
298         self.log_msg("commands specific to study mode:");
299         self.log_msg("  %s - annotate terrain" % self.keys['switch_to_annotate']);
300         self.log_msg("  %s - switch to play mode" % self.keys['switch_to_play']);
301
302     def loop(self, stdscr):
303         import time
304         import datetime
305
306         def safe_addstr(y, x, line):
307             if y < self.size.y - 1 or x + len(line) < self.size.x:
308                 stdscr.addstr(y, x, line)
309             else:  # workaround to <https://stackoverflow.com/q/7063128>
310                 cut_i = self.size.x - x - 1
311                 cut = line[:cut_i]
312                 last_char = line[cut_i]
313                 stdscr.addstr(y, self.size.x - 2, last_char)
314                 stdscr.insstr(y, self.size.x - 2, ' ')
315                 stdscr.addstr(y, x, cut)
316
317         def connect():
318
319             def handle_recv(msg):
320                 if msg == 'BYE':
321                     self.socket.close()
322                 else:
323                     self.queue.put(msg)
324
325             socket_client_class = PlomSocketClient
326             if self.host.startswith('ws://') or self.host.startswith('wss://'):
327                 socket_client_class = WebSocketClient
328             while True:
329                 try:
330                     self.socket = socket_client_class(handle_recv, self.host)
331                     self.socket_thread = threading.Thread(target=self.socket.run)
332                     self.socket_thread.start()
333                     self.switch_mode('login')
334                     return
335                 except ConnectionRefusedError:
336                     self.log_msg('@ server connect failure, trying again …')
337                     draw_screen()
338                     stdscr.refresh()
339                     time.sleep(1)
340
341         def reconnect():
342             self.send('QUIT')
343             time.sleep(0.1)  # FIXME necessitated by some some strange SSL race
344                              # conditions with ws4py, find out what exactly
345             self.switch_mode('waiting_for_server')
346             connect()
347
348         def handle_input(msg):
349             command, args = self.parser.parse(msg)
350             command(*args)
351
352         def msg_into_lines_of_width(msg, width):
353             chunk = ''
354             lines = []
355             x = 0
356             for i in range(len(msg)):
357                 if x >= width or msg[i] == "\n":
358                     lines += [chunk]
359                     chunk = ''
360                     x = 0
361                 if msg[i] != "\n":
362                     chunk += msg[i]
363                 x += 1
364             lines += [chunk]
365             return lines
366
367         def reset_screen_size():
368             self.size = YX(*stdscr.getmaxyx())
369             self.size = self.size - YX(self.size.y % 4, 0)
370             self.size = self.size - YX(0, self.size.x % 4)
371             self.window_width = int(self.size.x / 2)
372
373         def recalc_input_lines():
374             if not self.mode.has_input_prompt:
375                 self.input_lines = []
376             else:
377                 self.input_lines = msg_into_lines_of_width(input_prompt + self.input_,
378                                                            self.window_width)
379
380         def move_explorer(direction):
381             target = self.game.map_geometry.move(self.explorer, direction)
382             if target:
383                 self.explorer = target
384                 self.query_info()
385             else:
386                 self.flash()
387
388         def draw_history():
389             lines = []
390             for line in self.log:
391                 lines += msg_into_lines_of_width(line, self.window_width)
392             lines.reverse()
393             height_header = 2
394             max_y = self.size.y - len(self.input_lines)
395             for i in range(len(lines)):
396                 if (i >= max_y - height_header):
397                     break
398                 safe_addstr(max_y - i - 1, self.window_width, lines[i])
399
400         def draw_info():
401             if not self.game.turn_complete:
402                 return
403             pos_i = self.explorer.y * self.game.map_geometry.size.x + self.explorer.x
404             info = 'TERRAIN: %s\n' % self.game.map_content[pos_i]
405             for t in self.game.things:
406                 if t.position == self.explorer:
407                     info += 'PLAYER @: %s\n' % t.name
408             if self.explorer in self.game.portals:
409                 info += 'PORTAL: ' + self.game.portals[self.explorer] + '\n'
410             else:
411                 info += 'PORTAL: (none)\n'
412             if self.explorer in self.game.info_db:
413                 info += 'ANNOTATION: ' + self.game.info_db[self.explorer]
414             else:
415                 info += 'ANNOTATION: waiting …'
416             lines = msg_into_lines_of_width(info, self.window_width)
417             height_header = 2
418             for i in range(len(lines)):
419                 y = height_header + i
420                 if y >= self.size.y - len(self.input_lines):
421                     break
422                 safe_addstr(y, self.window_width, lines[i])
423
424         def draw_input():
425             y = self.size.y - len(self.input_lines)
426             for i in range(len(self.input_lines)):
427                 safe_addstr(y, self.window_width, self.input_lines[i])
428                 y += 1
429
430         def draw_turn():
431             if not self.game.turn_complete:
432                 return
433             safe_addstr(0, self.window_width, 'TURN: ' + str(self.game.turn))
434
435         def draw_mode():
436             safe_addstr(1, self.window_width, 'MODE: ' + self.mode.name)
437
438         def draw_map():
439             if not self.game.turn_complete:
440                 return
441             map_lines_split = []
442             for y in range(self.game.map_geometry.size.y):
443                 start = self.game.map_geometry.size.x * y
444                 end = start + self.game.map_geometry.size.x
445                 map_lines_split += [list(self.game.map_content[start:end])]
446             for t in self.game.things:
447                 map_lines_split[t.position.y][t.position.x] = '@'
448             if self.mode.shows_info:
449                 map_lines_split[self.explorer.y][self.explorer.x] = '?'
450             map_lines = []
451             if type(self.game.map_geometry) == MapGeometryHex:
452                 indent = 0
453                 for line in map_lines_split:
454                     map_lines += [indent*' ' + ' '.join(line)]
455                     indent = 0 if indent else 1
456             else:
457                 for line in map_lines_split:
458                     map_lines += [' '.join(line)]
459             window_center = YX(int(self.size.y / 2),
460                                int(self.window_width / 2))
461             player = self.game.get_thing(self.game.player_id, False)
462             center = player.position
463             if self.mode.shows_info:
464                 center = self.explorer
465             center = YX(center.y, center.x * 2)
466             offset = center - window_center
467             if type(self.game.map_geometry) == MapGeometryHex and offset.y % 2:
468                 offset += YX(0, 1)
469             term_y = max(0, -offset.y)
470             term_x = max(0, -offset.x)
471             map_y = max(0, offset.y)
472             map_x = max(0, offset.x)
473             while (term_y < self.size.y and map_y < self.game.map_geometry.size.y):
474                 to_draw = map_lines[map_y][map_x:self.window_width + offset.x]
475                 safe_addstr(term_y, term_x, to_draw)
476                 term_y += 1
477                 map_y += 1
478
479         def draw_screen():
480             stdscr.clear()
481             recalc_input_lines()
482             if self.mode.has_input_prompt:
483                 draw_input()
484             if self.mode.shows_info:
485                 draw_info()
486             else:
487                 draw_history()
488             draw_mode()
489             if not self.mode.is_intro:
490                 draw_turn()
491                 draw_map()
492
493         curses.curs_set(False)  # hide cursor
494         curses.use_default_colors();
495         stdscr.timeout(10)
496         reset_screen_size()
497         self.explorer = YX(0, 0)
498         self.input_ = ''
499         input_prompt = '> '
500         connect()
501         last_ping = datetime.datetime.now()
502         interval = datetime.timedelta(seconds=30)
503         while True:
504             now = datetime.datetime.now()
505             if now - last_ping > interval:
506                 self.send('PING')
507                 last_ping = now
508             if self.do_refresh:
509                 draw_screen()
510                 self.do_refresh = False
511             while True:
512                 try:
513                     msg = self.queue.get(block=False)
514                     handle_input(msg)
515                 except queue.Empty:
516                     break
517             try:
518                 key = stdscr.getkey()
519                 self.do_refresh = True
520             except curses.error:
521                 continue
522             if key == 'KEY_RESIZE':
523                 reset_screen_size()
524             elif self.mode.has_input_prompt and key == 'KEY_BACKSPACE':
525                 self.input_ = self.input_[:-1]
526             elif self.mode.has_input_prompt and key != '\n':  # Return key
527                 self.input_ += key
528                 max_length = self.window_width * self.size.y - len(input_prompt) - 1
529                 if len(self.input_) > max_length:
530                     self.input_ = self.input_[:max_length]
531             elif self.mode == self.mode_login and key == '\n':
532                 self.login_name = self.input_
533                 self.send('LOGIN ' + quote(self.input_))
534                 self.input_ = ""
535             elif self.mode == self.mode_chat and key == '\n':
536                 if self.input_[0] == '/':
537                     if self.input_ in {'/' + self.keys['switch_to_play'], '/play'}:
538                         self.switch_mode('play')
539                     elif self.input_ in {'/' + self.keys['switch_to_study'], '/study'}:
540                         self.switch_mode('study')
541                     elif self.input_ == '/help':
542                         self.help()
543                     elif self.input_ == '/reconnect':
544                         reconnect()
545                     elif self.input_.startswith('/nick'):
546                         tokens = self.input_.split(maxsplit=1)
547                         if len(tokens) == 2:
548                             self.send('LOGIN ' + quote(tokens[1]))
549                         else:
550                             self.log_msg('? need login name')
551                     elif self.input_.startswith('/msg'):
552                         tokens = self.input_.split(maxsplit=2)
553                         if len(tokens) == 3:
554                             self.send('QUERY %s %s' % (quote(tokens[1]),
555                                                               quote(tokens[2])))
556                         else:
557                             self.log_msg('? need message target and message')
558                     else:
559                         self.log_msg('? unknown command')
560                 else:
561                     self.send('ALL ' + quote(self.input_))
562                 self.input_ = ""
563             elif self.mode == self.mode_annotate and key == '\n':
564                 if self.input_ == '':
565                     self.input_ = ' '
566                 self.send('ANNOTATE %s %s' % (self.explorer, quote(self.input_)))
567                 self.input_ = ""
568                 self.switch_mode('study', keep_position=True)
569             elif self.mode == self.mode_portal and key == '\n':
570                 if self.input_ == '':
571                     self.input_ = ' '
572                 self.send('PORTAL %s %s' % (self.explorer, quote(self.input_)))
573                 self.input_ = ""
574                 self.switch_mode('study', keep_position=True)
575             elif self.mode == self.mode_teleport and key == '\n':
576                 if self.input_ == 'YES!':
577                     self.host = self.teleport_target_host
578                     reconnect()
579                 else:
580                     self.log_msg('@ teleport aborted')
581                     self.switch_mode('play')
582                 self.input_ = ''
583             elif self.mode == self.mode_study:
584                 if key == self.keys['switch_to_chat']:
585                     self.switch_mode('chat')
586                 elif key == self.keys['switch_to_play']:
587                     self.switch_mode('play')
588                 elif key == self.keys['switch_to_annotate']:
589                     self.switch_mode('annotate', keep_position=True)
590                 elif key == self.keys['switch_to_portal']:
591                     self.switch_mode('portal', keep_position=True)
592                 elif key in self.movement_keys:
593                     move_explorer(self.movement_keys[key])
594             elif self.mode == self.mode_play:
595                 if key == self.keys['switch_to_chat']:
596                     self.switch_mode('chat')
597                 elif key == self.keys['switch_to_study']:
598                     self.switch_mode('study')
599                 if key == self.keys['switch_to_edit']:
600                     self.switch_mode('edit')
601                 elif key == self.keys['flatten']:
602                     self.send('TASK:FLATTEN_SURROUNDINGS')
603                 elif key in self.movement_keys:
604                     self.send('TASK:MOVE ' + self.movement_keys[key])
605             elif self.mode == self.mode_edit:
606                 self.send('TASK:WRITE ' + key)
607                 self.switch_mode('play')
608
609 TUI('127.0.0.1:5000')